Merge pull request #12 from mzk/improve

Add support for symfony Controllers

Author: lookyman

phpstan.neon

@@ -1,3 +1,7 @@
 includes:
 	- vendor/phpstan/phpstan-phpunit/extension.neon
 	- vendor/phpstan/phpstan-phpunit/rules.neon
+
+parameters:
+	excludes_analyse:
+		- %rootDir%/../../../tests/*/data/*

src/Rules/ContainerInterfacePrivateServiceRule.php

@@ -8,6 +8,7 @@
 use PHPStan\Analyser\Scope;
 use PHPStan\Rules\Rule;
 use PHPStan\Type\ObjectType;
+use PHPStan\Type\ThisType;
 use PhpParser\Node;
 use PhpParser\Node\Arg;
 use PhpParser\Node\Expr\MethodCall;
@@ -34,8 +35,10 @@ public function processNode(Node $node, Scope $scope): array
 	{
 		if ($node instanceof MethodCall && $node->name === 'get') {
 			$type = $scope->getType($node->var);
-			if ($type instanceof ObjectType
-				&& \in_array($type->getClassName(), ['Symfony\Component\DependencyInjection\ContainerInterface', 'Symfony\Bundle\FrameworkBundle\Controller\Controller'], \true)
+			$baseController = new ObjectType('Symfony\Bundle\FrameworkBundle\Controller\Controller');
+			$isInstanceOfController = $type instanceof ThisType && $baseController->isSuperTypeOf($type)->yes();
+			$isContainerInterface = $type instanceof ObjectType && $type->getClassName() === 'Symfony\Component\DependencyInjection\ContainerInterface';
+			if (($isContainerInterface || $isInstanceOfController)
 				&& isset($node->args[0])
 				&& $node->args[0] instanceof Arg
 			) {

src/Rules/ContainerInterfaceUnknownServiceRule.php

@@ -8,9 +8,11 @@
 use PHPStan\Analyser\Scope;
 use PHPStan\Rules\Rule;
 use PHPStan\Type\ObjectType;
+use PHPStan\Type\ThisType;
 use PhpParser\Node;
 use PhpParser\Node\Arg;
 use PhpParser\Node\Expr\MethodCall;
+use PhpParser\Node\Expr\Variable;
 
 final class ContainerInterfaceUnknownServiceRule implements Rule
 {
@@ -34,10 +36,13 @@ public function processNode(Node $node, Scope $scope): array
 	{
 		if ($node instanceof MethodCall && $node->name === 'get') {
 			$type = $scope->getType($node->var);
-			if ($type instanceof ObjectType
-				&& \in_array($type->getClassName(), ['Symfony\Component\DependencyInjection\ContainerInterface', 'Symfony\Bundle\FrameworkBundle\Controller\Controller'], \true)
+			$baseController = new ObjectType('Symfony\Bundle\FrameworkBundle\Controller\Controller');
+			$isInstanceOfController = $type instanceof ThisType && $baseController->isSuperTypeOf($type)->yes();
+			$isContainerInterface = $type instanceof ObjectType && $type->getClassName() === 'Symfony\Component\DependencyInjection\ContainerInterface';
+			if (($isInstanceOfController || $isContainerInterface)
 				&& isset($node->args[0])
 				&& $node->args[0] instanceof Arg
+				&& !$node->args[0]->value instanceof Variable
 			) {
 				$service = $this->serviceMap->getServiceFromNode($node->args[0]->value);
 				if ($service === \null) {

tests/Rules/ContainerInterfacePrivateServiceRuleTest.php

@@ -0,0 +1,35 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace Lookyman\PHPStan\Symfony\Rules;
+
+use Lookyman\PHPStan\Symfony\ServiceMap;
+use PHPStan\Rules\Rule;
+
+final class ContainerInterfacePrivateServiceRuleTest extends \PHPStan\Testing\RuleTestCase
+{
+
+	protected function setUp()
+	{
+		include_once __DIR__ . '/data/Controller.php';
+	}
+
+	protected function getRule(): Rule
+	{
+		$serviceMap = new ServiceMap(__DIR__ . '/../container.xml');
+
+		return new ContainerInterfacePrivateServiceRule($serviceMap);
+	}
+
+	public function testGetPrivateService()
+	{
+		$this->analyse([__DIR__ . '/data/ExampleController.php'], [
+			[
+				'Service "private" is private.',
+				14,
+			],
+		]);
+	}
+
+}

tests/Rules/ContainerInterfaceUnknownServiceRuleTest.php

@@ -0,0 +1,35 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace Lookyman\PHPStan\Symfony\Rules;
+
+use Lookyman\PHPStan\Symfony\ServiceMap;
+use PHPStan\Rules\Rule;
+
+final class ContainerInterfaceUnknownServiceRuleTest extends \PHPStan\Testing\RuleTestCase
+{
+
+	protected function setUp()
+	{
+		include_once __DIR__ . '/data/Controller.php';
+	}
+
+	protected function getRule(): Rule
+	{
+		$serviceMap = new ServiceMap(__DIR__ . '/../container.xml');
+
+		return new ContainerInterfaceUnknownServiceRule($serviceMap);
+	}
+
+	public function testGetUnknownService()
+	{
+		$this->analyse([__DIR__ . '/data/ExampleController.php'], [
+			[
+				'Service "service.not.found" is not registered in the container.',
+				20,
+			],
+		]);
+	}
+
+}

tests/Rules/data/Controller.php

@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace Symfony\Bundle\FrameworkBundle\Controller;
+
+abstract class Controller
+{
+
+}

tests/Rules/data/ExampleController.php

@@ -0,0 +1,30 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace Lookyman\PHPStan\Symfony\Rules\data;
+
+use Symfony\Bundle\FrameworkBundle\Controller\Controller;
+
+final class ExampleController extends Controller
+{
+
+	public function getPrivateServiceAction()
+	{
+		$service = $this->get('private');
+		$service->noMethod();
+	}
+
+	public function getUnknownService()
+	{
+		$service = $this->get('service.not.found');
+		$service->noMethod();
+	}
+
+	public function getVariableService(string $serviceKey)
+	{
+		$service = $this->get($serviceKey);
+		$service->noMethod();
+	}
+
+}