Add Type extension for Controller::get

Author: malarzm

extension.neon

@@ -2,6 +2,9 @@ services:
 	-
 		class: Lookyman\PHPStan\Symfony\Type\ContainerInterfaceDynamicReturnTypeExtension
 		tags: [phpstan.broker.dynamicMethodReturnTypeExtension]
+	-
+		class: Lookyman\PHPStan\Symfony\Type\ControllerDynamicReturnTypeExtension
+		tags: [phpstan.broker.dynamicMethodReturnTypeExtension]
 	-
 		class: Lookyman\PHPStan\Symfony\Rules\ContainerInterfacePrivateServiceRule
 		tags: [phpstan.rules.rule]

src/Rules/ContainerInterfacePrivateServiceRule.php

@@ -35,7 +35,7 @@ public function processNode(Node $node, Scope $scope): array
 		if ($node instanceof MethodCall && $node->name === 'get') {
 			$type = $scope->getType($node->var);
 			if ($type instanceof ObjectType
-				&& $type->getClassName() === 'Symfony\Component\DependencyInjection\ContainerInterface'
+				&& \in_array($type->getClassName(), ['Symfony\Component\DependencyInjection\ContainerInterface', 'Symfony\Bundle\FrameworkBundle\Controller\Controller'], \true)
 				&& isset($node->args[0])
 				&& $node->args[0] instanceof Arg
 			) {

src/Rules/ContainerInterfaceUnknownServiceRule.php

@@ -35,7 +35,7 @@ public function processNode(Node $node, Scope $scope): array
 		if ($node instanceof MethodCall && $node->name === 'get') {
 			$type = $scope->getType($node->var);
 			if ($type instanceof ObjectType
-				&& $type->getClassName() === 'Symfony\Component\DependencyInjection\ContainerInterface'
+				&& \in_array($type->getClassName(), ['Symfony\Component\DependencyInjection\ContainerInterface', 'Symfony\Bundle\FrameworkBundle\Controller\Controller'], \true)
 				&& isset($node->args[0])
 				&& $node->args[0] instanceof Arg
 			) {

src/Type/ControllerDynamicReturnTypeExtension.php

@@ -0,0 +1,55 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace Lookyman\PHPStan\Symfony\Type;
+
+use Lookyman\PHPStan\Symfony\ServiceMap;
+use PHPStan\Analyser\Scope;
+use PHPStan\Reflection\MethodReflection;
+use PHPStan\Type\DynamicMethodReturnTypeExtension;
+use PHPStan\Type\ObjectType;
+use PHPStan\Type\Type;
+use PhpParser\Node\Arg;
+use PhpParser\Node\Expr\MethodCall;
+
+final class ControllerDynamicReturnTypeExtension implements DynamicMethodReturnTypeExtension
+{
+
+	/**
+	 * @var ServiceMap
+	 */
+	private $serviceMap;
+
+	public function __construct(ServiceMap $symfonyServiceMap)
+	{
+		$this->serviceMap = $symfonyServiceMap;
+	}
+
+	public function getClass(): string
+	{
+		return 'Symfony\Bundle\FrameworkBundle\Controller\Controller';
+	}
+
+	public function isMethodSupported(MethodReflection $methodReflection): bool
+	{
+		return $methodReflection->getName() === 'get';
+	}
+
+	public function getTypeFromMethodCall(
+		MethodReflection $methodReflection,
+		MethodCall $methodCall,
+		Scope $scope
+	): Type {
+		if (isset($methodCall->args[0])
+			&& $methodCall->args[0] instanceof Arg
+		) {
+			$service = $this->serviceMap->getServiceFromNode($methodCall->args[0]->value);
+			if ($service !== \null && !$service['synthetic']) {
+				return new ObjectType($service['class'] ?? $service['id']);
+			}
+		}
+		return $methodReflection->getReturnType();
+	}
+
+}

tests/Type/ControllerDynamicReturnTypeExtensionTest.php

@@ -0,0 +1,87 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace Lookyman\PHPStan\Symfony\Type;
+
+use Lookyman\PHPStan\Symfony\ServiceMap;
+use PHPStan\Analyser\Scope;
+use PHPStan\Reflection\MethodReflection;
+use PHPStan\Type\DynamicMethodReturnTypeExtension;
+use PHPStan\Type\ObjectType;
+use PHPStan\Type\Type;
+use PHPUnit\Framework\TestCase;
+use PhpParser\Node\Arg;
+use PhpParser\Node\Expr;
+use PhpParser\Node\Expr\MethodCall;
+use PhpParser\Node\Scalar\String_;
+
+/**
+ * @covers \Lookyman\PHPStan\Symfony\Type\ControllerDynamicReturnTypeExtension
+ */
+final class ControllerDynamicReturnTypeExtensionTest extends TestCase
+{
+
+	public function testImplementsDynamicMethodReturnTypeExtension()
+	{
+		self::assertInstanceOf(
+			DynamicMethodReturnTypeExtension::class,
+			new ControllerDynamicReturnTypeExtension(new ServiceMap(__DIR__ . '/../container.xml'))
+		);
+	}
+
+	public function testGetClass()
+	{
+		$extension = new ControllerDynamicReturnTypeExtension(new ServiceMap(__DIR__ . '/../container.xml'));
+		self::assertEquals('Symfony\Bundle\FrameworkBundle\Controller\Controller', $extension->getClass());
+	}
+
+	public function testIsMethodSupported()
+	{
+		$methodGet = $this->createMock(MethodReflection::class);
+		$methodGet->expects(self::once())->method('getName')->willReturn('get');
+
+		$methodFoo = $this->createMock(MethodReflection::class);
+		$methodFoo->expects(self::once())->method('getName')->willReturn('foo');
+
+		$extension = new ControllerDynamicReturnTypeExtension(new ServiceMap(__DIR__ . '/../container.xml'));
+		self::assertTrue($extension->isMethodSupported($methodGet));
+		self::assertFalse($extension->isMethodSupported($methodFoo));
+	}
+
+	/**
+	 * @dataProvider getTypeFromMethodCallProvider
+	 */
+	public function testGetTypeFromMethodCall(MethodReflection $methodReflection, MethodCall $methodCall, Type $expectedType)
+	{
+		$extension = new ControllerDynamicReturnTypeExtension(new ServiceMap(__DIR__ . '/../container.xml'));
+		$type = $extension->getTypeFromMethodCall(
+			$methodReflection,
+			$methodCall,
+			$this->createMock(Scope::class)
+		);
+		self::assertEquals($expectedType, $type);
+	}
+
+	public function getTypeFromMethodCallProvider(): array
+	{
+		$notFoundType = $this->createMock(Type::class);
+
+		$methodReflectionNotFound = $this->createMock(MethodReflection::class);
+		$methodReflectionNotFound->expects(self::once())->method('getReturnType')->willReturn($notFoundType);
+
+		return [
+			'found' => [
+				$this->createMock(MethodReflection::class),
+				new MethodCall($this->createMock(Expr::class), '', [new Arg(new String_('withClass'))]),
+				new ObjectType('Foo'),
+			],
+			'notFound' => [
+				$methodReflectionNotFound,
+				new MethodCall($this->createMock(Expr::class), ''),
+				$notFoundType,
+			],
+		];
+	}
+
+}