Merge branch 'get-session-type-specifying' of git://github.com/plotek/phpstan-symfony into plotek-get-session-type-specifying

Author: lookyman

composer.json

@@ -42,7 +42,8 @@
     "squizlabs/php_codesniffer": "^3.3.2",
     "symfony/serializer": "^3.0 || ^4.0",
     "symfony/messenger": "^4.2",
-    "symfony/console": "^3.0 || ^4.0"
+    "symfony/console": "^3.0 || ^4.0",
+    "symfony/http-foundation": "^3.0 || ^4.0"
   },
   "conflict": {
     "symfony/framework-bundle": "<3.0"

extension.neon

@@ -59,6 +59,11 @@ services:
 		factory: PHPStan\Type\Symfony\RequestDynamicReturnTypeExtension
 		tags: [phpstan.broker.dynamicMethodReturnTypeExtension]
 
+	# Request::getSession() type specification
+	-
+		factory: PHPStan\Type\Symfony\RequestTypeSpecifyingExtension
+		tags: [phpstan.typeSpecifier.methodTypeSpecifyingExtension]
+
 	# HeaderBag::get() return type
 	-
 		factory: PHPStan\Type\Symfony\HeaderBagDynamicReturnTypeExtension

phpstan.neon

@@ -14,4 +14,7 @@ parameters:
 		- tests/*/header_bag_get.php
 		- tests/*/kernel_interface.php
 		- tests/*/request_get_content.php
+		- tests/*/request_get_session.php
 		- tests/*/serializer.php
+	ignoreErrors:
+		- '~^Parameter \#1 \$node \(.*\) of method .*Rule::processNode\(\) should be contravariant with parameter \$node \(PhpParser\\Node\) of method PHPStan\\Rules\\Rule::processNode\(\)$~'

src/Type/Symfony/RequestTypeSpecifyingExtension.php

@@ -0,0 +1,62 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Type\Symfony;
+
+use PhpParser\Node\Expr\MethodCall;
+use PHPStan\Analyser\Scope;
+use PHPStan\Analyser\SpecifiedTypes;
+use PHPStan\Analyser\TypeSpecifier;
+use PHPStan\Analyser\TypeSpecifierAwareExtension;
+use PHPStan\Analyser\TypeSpecifierContext;
+use PHPStan\Broker\Broker;
+use PHPStan\Reflection\MethodReflection;
+use PHPStan\Reflection\ParametersAcceptorSelector;
+use PHPStan\Type\MethodTypeSpecifyingExtension;
+use PHPStan\Type\TypeCombinator;
+
+final class RequestTypeSpecifyingExtension implements MethodTypeSpecifyingExtension, TypeSpecifierAwareExtension
+{
+
+	private const REQUEST_CLASS = 'Symfony\Component\HttpFoundation\Request';
+	private const HAS_METHOD_NAME = 'hasSession';
+	private const GET_METHOD_NAME = 'getSession';
+
+	/** @var Broker */
+	private $broker;
+
+	/** @var TypeSpecifier */
+	private $typeSpecifier;
+
+	public function __construct(Broker $broker)
+	{
+		$this->broker = $broker;
+	}
+
+	public function getClass(): string
+	{
+		return self::REQUEST_CLASS;
+	}
+
+	public function isMethodSupported(MethodReflection $methodReflection, MethodCall $node, TypeSpecifierContext $context): bool
+	{
+		return $methodReflection->getName() === self::HAS_METHOD_NAME && !$context->null();
+	}
+
+	public function specifyTypes(MethodReflection $methodReflection, MethodCall $node, Scope $scope, TypeSpecifierContext $context): SpecifiedTypes
+	{
+		$classReflection = $this->broker->getClass(self::REQUEST_CLASS);
+		$methodVariants = $classReflection->getNativeMethod(self::GET_METHOD_NAME)->getVariants();
+
+		return $this->typeSpecifier->create(
+			new MethodCall($node->var, self::GET_METHOD_NAME),
+			TypeCombinator::removeNull(ParametersAcceptorSelector::selectSingle($methodVariants)->getReturnType()),
+			$context
+		);
+	}
+
+	public function setTypeSpecifier(TypeSpecifier $typeSpecifier): void
+	{
+		$this->typeSpecifier = $typeSpecifier;
+	}
+
+}

tests/Symfony/NeonTest.php

@@ -47,7 +47,7 @@ public function testExtensionNeon(): void
 
 		self::assertCount(6, $container->findByTag('phpstan.rules.rule'));
 		self::assertCount(12, $container->findByTag('phpstan.broker.dynamicMethodReturnTypeExtension'));
-		self::assertCount(5, $container->findByTag('phpstan.typeSpecifier.methodTypeSpecifyingExtension'));
+		self::assertCount(6, $container->findByTag('phpstan.typeSpecifier.methodTypeSpecifyingExtension'));
 		self::assertInstanceOf(ServiceMap::class, $container->getByType(ServiceMap::class));
 	}
 

tests/Symfony/config.neon

@@ -4,3 +4,14 @@ parameters:
 
 services:
 	- PhpParser\PrettyPrinter\Standard
+
+	-
+		class: PHPStan\DependencyInjection\Container
+		factory: PHPStan\DependencyInjection\Nette\NetteContainer
+
+	broker:
+		class: PHPStan\Broker\Broker
+		factory: @brokerFactory::create
+
+	brokerFactory:
+		class: PHPStan\Broker\BrokerFactory

tests/Type/Symfony/RequestTypeSpecifyingExtensionTest.php

@@ -0,0 +1,40 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Type\Symfony;
+
+use PHPStan\Rules\Rule;
+use PHPStan\Testing\RuleTestCase;
+use PHPStan\Type\MethodTypeSpecifyingExtension;
+use Symfony\Component\HttpFoundation\Session\SessionInterface;
+
+final class RequestTypeSpecifyingExtensionTest extends RuleTestCase
+{
+
+	protected function getRule(): Rule
+	{
+		return new VariableTypeReportingRule();
+	}
+
+	/** @return MethodTypeSpecifyingExtension[] */
+	protected function getMethodTypeSpecifyingExtensions(): array
+	{
+		return [
+			new RequestTypeSpecifyingExtension($this->createBroker()),
+		];
+	}
+
+	public function testGetSession(): void
+	{
+		$this->analyse([__DIR__ . '/request_get_session.php'], [
+			[
+				'Variable $session1 is: ' . SessionInterface::class . '|null',
+				7,
+			],
+			[
+				'Variable $session2 is: ' . SessionInterface::class,
+				11,
+			],
+		]);
+	}
+
+}

tests/Type/Symfony/VariableTypeReportingRule.php

@@ -0,0 +1,44 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Type\Symfony;
+
+use PhpParser\Node;
+use PhpParser\Node\Expr\Variable;
+use PHPStan\Analyser\Scope;
+use PHPStan\Rules\Rule;
+use PHPStan\Type\VerbosityLevel;
+
+final class VariableTypeReportingRule implements Rule
+{
+
+	public function getNodeType(): string
+	{
+		return Variable::class;
+	}
+
+	/**
+	 * @param \PhpParser\Node\Expr\Variable $node
+	 * @param \PHPStan\Analyser\Scope $scope
+	 * @return string[] errors
+	 */
+	public function processNode(Node $node, Scope $scope): array
+	{
+		if (!is_string($node->name)) {
+			return [];
+		}
+		if (!$scope->isInFirstLevelStatement()) {
+			return [];
+		};
+		if ($scope->isInExpressionAssign($node)) {
+			return [];
+		}
+		return [
+			sprintf(
+				'Variable $%s is: %s',
+				$node->name,
+				$scope->getType($node)->describe(VerbosityLevel::value())
+			),
+		];
+	}
+
+}

tests/Type/Symfony/request_get_session.php

@@ -0,0 +1,12 @@
+<?php declare(strict_types = 1);
+
+/** @var \Symfony\Component\HttpFoundation\Request $request */
+$request = doRequest();
+
+$session1 = $request->getSession();
+$session1;
+
+if ($request->hasSession()) {
+	$session2 = $request->getSession();
+	$session2;
+}