Services and tests refactoring

Author: lookyman

README.md

@@ -29,9 +29,9 @@ includes:
 	- vendor/phpstan/phpstan-symfony/extension.neon
 parameters:
 	symfony:
-		container_xml_path: %rootDir%/../../../var/cache/dev/appDevDebugProjectContainer.xml # or srcDevDebugProjectContainer.xml for Symfony 4+
+		container_xml_path: %rootDir%/../../../var/cache/dev/srcDevDebugProjectContainer.xml
 ```
 
 ## Limitations
 
-You have to provide a path to `appDevDebugProjectContainer.xml` or similar xml file describing your container.
+You have to provide a path to `srcDevDebugProjectContainer.xml` or similar xml file describing your container.

extension.neon

@@ -1,33 +1,38 @@
+rules:
+	- PHPStan\Rules\Symfony\ContainerInterfacePrivateServiceRule
+	- PHPStan\Rules\Symfony\ContainerInterfaceUnknownServiceRule
+
 services:
+	# service map
+	symfony.serviceMapFactory:
+		class: PHPStan\Symfony\ServiceMapFactory
+		factory: PHPStan\Symfony\XmlServiceMapFactory(%symfony.container_xml_path%)
 	-
-		class: PHPStan\Type\Symfony\ContainerInterfaceDynamicReturnTypeExtension
-		tags:
-			- phpstan.broker.dynamicMethodReturnTypeExtension
+		class: PHPStan\Symfony\ServiceMap(@symfony.serviceMapFactory::create())
+
+	# ControllerTrait::get()/has() return type
 	-
-		class: PHPStan\Type\Symfony\ControllerDynamicReturnTypeExtension
-		tags:
-			- phpstan.broker.dynamicMethodReturnTypeExtension
+		class: PHPStan\Type\Symfony\ServiceDynamicReturnTypeExtension(Symfony\Component\DependencyInjection\ContainerInterface)
+		tags: [phpstan.broker.dynamicMethodReturnTypeExtension]
 	-
-		class: PHPStan\Type\Symfony\RequestDynamicReturnTypeExtension
-		tags:
-			- phpstan.broker.dynamicMethodReturnTypeExtension
+		class: PHPStan\Type\Symfony\ServiceDynamicReturnTypeExtension(Symfony\Bundle\FrameworkBundle\Controller\Controller)
+		tags: [phpstan.broker.dynamicMethodReturnTypeExtension]
 	-
-		class: PHPStan\Rules\Symfony\ContainerInterfacePrivateServiceRule
-		tags:
-			- phpstan.rules.rule
+		class: PHPStan\Type\Symfony\ServiceDynamicReturnTypeExtension(Symfony\Bundle\FrameworkBundle\Controller\AbstractController)
+		tags: [phpstan.broker.dynamicMethodReturnTypeExtension]
+
+	# ControllerTrait::has() type specification
 	-
-		class: PHPStan\Rules\Symfony\ContainerInterfaceUnknownServiceRule
-		tags:
-			- phpstan.rules.rule
+		class: PHPStan\Type\Symfony\ServiceTypeSpecifyingExtension(Symfony\Component\DependencyInjection\ContainerInterface)
+		tags: [phpstan.typeSpecifier.methodTypeSpecifyingExtension]
 	-
-		class: PHPStan\Type\Symfony\ContainerInterfaceMethodTypeSpecifyingExtension
-		tags:
-			- phpstan.typeSpecifier.methodTypeSpecifyingExtension
+		class: PHPStan\Type\Symfony\ServiceTypeSpecifyingExtension(Symfony\Bundle\FrameworkBundle\Controller\Controller)
+		tags: [phpstan.typeSpecifier.methodTypeSpecifyingExtension]
 	-
-		class: PHPStan\Type\Symfony\ControllerMethodTypeSpecifyingExtension
-		tags:
-			- phpstan.typeSpecifier.methodTypeSpecifyingExtension
+		class: PHPStan\Type\Symfony\ServiceTypeSpecifyingExtension(Symfony\Bundle\FrameworkBundle\Controller\AbstractController)
+		tags: [phpstan.typeSpecifier.methodTypeSpecifyingExtension]
+
+	# Request::getContent() return type
 	-
-		class: PHPStan\Symfony\ServiceMap
-		arguments:
-			containerXml: %symfony.container_xml_path%
+		class: PHPStan\Type\Symfony\RequestDynamicReturnTypeExtension
+		tags: [phpstan.broker.dynamicMethodReturnTypeExtension]

phpcs.xml

@@ -7,6 +7,7 @@
         <exclude name="SlevomatCodingStandard.Namespaces.FullyQualifiedExceptions"/>
         <exclude name="SlevomatCodingStandard.Namespaces.ReferenceUsedNamesOnly"/>
         <exclude name="Consistence.Exceptions.ExceptionDeclaration"/>
+        <exclude name="Squiz.Commenting.FunctionComment.MissingParamTag"/>
     </rule>
     <rule ref="SlevomatCodingStandard.Namespaces.AlphabeticallySortedUses">
         <properties>
@@ -39,5 +40,6 @@
             <property name="rootNamespaces" type="array" value="src=>PHPStan,tests=>PHPStan"/>
         </properties>
     </rule>
-    <exclude-pattern>tests/*/data</exclude-pattern>
+    <exclude-pattern>tests/tmp</exclude-pattern>
+    <exclude-pattern>tests/Symfony/ExampleContainer.php</exclude-pattern>
 </ruleset>

phpstan.neon

@@ -5,4 +5,7 @@ includes:
 
 parameters:
 	excludes_analyse:
-		- */tests/*/data/*
+		- */tests/tmp/*
+		- */tests/*/ExampleContainer.php
+		- */tests/*/ExampleController.php
+		- */tests/*/request_get_content.php

src/Rules/Symfony/ContainerInterfacePrivateServiceRule.php

@@ -8,6 +8,7 @@
 use PHPStan\Rules\Rule;
 use PHPStan\Symfony\ServiceMap;
 use PHPStan\Type\ObjectType;
+use function sprintf;
 
 final class ContainerInterfacePrivateServiceRule implements Rule
 {
@@ -42,9 +43,10 @@ public function processNode(Node $node, Scope $scope): array
 
 		$argType = $scope->getType($node->var);
 		$isControllerType = (new ObjectType('Symfony\Bundle\FrameworkBundle\Controller\Controller'))->isSuperTypeOf($argType);
+		$isAbstractControllerType = (new ObjectType('Symfony\Bundle\FrameworkBundle\Controller\AbstractController'))->isSuperTypeOf($argType);
 		$isContainerType = (new ObjectType('Symfony\Component\DependencyInjection\ContainerInterface'))->isSuperTypeOf($argType);
 		$isTestContainerType = (new ObjectType('Symfony\Bundle\FrameworkBundle\Test\TestContainer'))->isSuperTypeOf($argType);
-		if ($isTestContainerType->yes() || (!$isControllerType->yes() && !$isContainerType->yes())) {
+		if ($isTestContainerType->yes() || (!$isControllerType->yes() && !$isAbstractControllerType->yes() && !$isContainerType->yes())) {
 			return [];
 		}
 

src/Rules/Symfony/ContainerInterfaceUnknownServiceRule.php

@@ -48,8 +48,9 @@ public function processNode(Node $node, Scope $scope): array
 
 		$argType = $scope->getType($node->var);
 		$isControllerType = (new ObjectType('Symfony\Bundle\FrameworkBundle\Controller\Controller'))->isSuperTypeOf($argType);
+		$isAbstractControllerType = (new ObjectType('Symfony\Bundle\FrameworkBundle\Controller\AbstractController'))->isSuperTypeOf($argType);
 		$isContainerType = (new ObjectType('Symfony\Component\DependencyInjection\ContainerInterface'))->isSuperTypeOf($argType);
-		if (!$isControllerType->yes() && !$isContainerType->yes()) {
+		if (!$isControllerType->yes() && !$isAbstractControllerType->yes() && !$isContainerType->yes()) {
 			return [];
 		}
 

src/Symfony/Service.php

@@ -2,7 +2,7 @@
 
 namespace PHPStan\Symfony;
 
-final class Service
+final class Service implements ServiceDefinition
 {
 
 	/** @var string */
@@ -20,24 +20,19 @@ final class Service
 	/** @var string|null */
 	private $alias;
 
-	/** @var bool */
-	private $hidden;
-
 	public function __construct(
 		string $id,
 		?string $class,
 		bool $public,
 		bool $synthetic,
-		?string $alias,
-		bool $hidden
+		?string $alias
 	)
 	{
 		$this->id = $id;
 		$this->class = $class;
 		$this->public = $public;
 		$this->synthetic = $synthetic;
 		$this->alias = $alias;
-		$this->hidden = $hidden;
 	}
 
 	public function getId(): string
@@ -65,9 +60,4 @@ public function getAlias(): ?string
 		return $this->alias;
 	}
 
-	public function isHidden(): bool
-	{
-		return $this->hidden;
-	}
-
 }

src/Symfony/ServiceDefinition.php

@@ -0,0 +1,18 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Symfony;
+
+interface ServiceDefinition
+{
+
+	public function getId(): string;
+
+	public function getClass(): ?string;
+
+	public function isPublic(): bool;
+
+	public function isSynthetic(): bool;
+
+	public function getAlias(): ?string;
+
+}

src/Symfony/ServiceMap.php

@@ -5,57 +5,31 @@
 use PhpParser\Node\Expr;
 use PHPStan\Analyser\Scope;
 use PHPStan\Type\TypeUtils;
+use function count;
 
 final class ServiceMap
 {
 
-	/** @var Service[] */
-	private $services = [];
+	/** @var \PHPStan\Symfony\ServiceDefinition[] */
+	private $services;
 
-	public function __construct(string $containerXml)
+	/**
+	 * @param \PHPStan\Symfony\ServiceDefinition[] $services
+	 */
+	public function __construct(array $services)
 	{
-		/** @var Service[] $aliases */
-		$aliases = [];
-		/** @var \SimpleXMLElement|false $xml */
-		$xml = @simplexml_load_file($containerXml);
-		if ($xml === false) {
-			throw new \PHPStan\Symfony\XmlContainerNotExistsException(sprintf('Container %s not exists', $containerXml));
-		}
-		foreach ($xml->services->service as $def) {
-			$attrs = $def->attributes();
-			if (!isset($attrs->id)) {
-				continue;
-			}
-			$service = new Service(
-				strpos((string) $attrs->id, '.') === 0 ? substr((string) $attrs->id, 1) : (string) $attrs->id,
-				isset($attrs->class) ? (string) $attrs->class : null,
-				!isset($attrs->public) || (string) $attrs->public !== 'false',
-				isset($attrs->synthetic) && (string) $attrs->synthetic === 'true',
-				isset($attrs->alias) ? (string) $attrs->alias : null,
-				strpos((string) $attrs->id, '.') === 0
-			);
-			if ($service->getAlias() !== null) {
-				$aliases[] = $service;
-			} else {
-				$this->services[$service->getId()] = $service;
-			}
-		}
-		foreach ($aliases as $service) {
-			if ($service->getAlias() !== null && !array_key_exists($service->getAlias(), $this->services)) {
-				continue;
-			}
-			$this->services[$service->getId()] = new Service(
-				$service->getId(),
-				$this->services[$service->getAlias()]->getClass(),
-				$service->isPublic(),
-				$service->isSynthetic(),
-				$service->getAlias(),
-				$service->isHidden()
-			);
-		}
+		$this->services = $services;
 	}
 
-	public function getService(string $id): ?Service
+	/**
+	 * @return \PHPStan\Symfony\ServiceDefinition[]
+	 */
+	public function getServices(): array
+	{
+		return $this->services;
+	}
+
+	public function getService(string $id): ?ServiceDefinition
 	{
 		return $this->services[$id] ?? null;
 	}

src/Symfony/ServiceMapFactory.php

@@ -0,0 +1,10 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Symfony;
+
+interface ServiceMapFactory
+{
+
+	public function create(): ServiceMap;
+
+}

src/Symfony/XmlServiceMapFactory.php

@@ -0,0 +1,71 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Symfony;
+
+use function simplexml_load_file;
+use function sprintf;
+use function strpos;
+use function substr;
+
+final class XmlServiceMapFactory implements ServiceMapFactory
+{
+
+	/** @var string */
+	private $containerXml;
+
+	public function __construct(string $containerXml)
+	{
+		$this->containerXml = $containerXml;
+	}
+
+	public function create(): ServiceMap
+	{
+		$xml = @simplexml_load_file($this->containerXml);
+		if ($xml === false) {
+			throw new XmlContainerNotExistsException(sprintf('Container %s not exists', $this->containerXml));
+		}
+
+		/** @var \PHPStan\Symfony\Service[] $services */
+		$services = [];
+		/** @var \PHPStan\Symfony\Service[] $aliases */
+		$aliases = [];
+		foreach ($xml->services->service as $def) {
+			/** @var \SimpleXMLElement $attrs */
+			$attrs = $def->attributes();
+			if (!isset($attrs->id)) {
+				continue;
+			}
+
+			$service = new Service(
+				strpos((string) $attrs->id, '.') === 0 ? substr((string) $attrs->id, 1) : (string) $attrs->id,
+				isset($attrs->class) ? (string) $attrs->class : null,
+				!isset($attrs->public) || (string) $attrs->public !== 'false',
+				isset($attrs->synthetic) && (string) $attrs->synthetic === 'true',
+				isset($attrs->alias) ? (string) $attrs->alias : null
+			);
+
+			if ($service->getAlias() !== null) {
+				$aliases[] = $service;
+			} else {
+				$services[$service->getId()] = $service;
+			}
+		}
+		foreach ($aliases as $service) {
+			$alias = $service->getAlias();
+			if ($alias !== null && !isset($services[$alias])) {
+				continue;
+			}
+			$id = $service->getId();
+			$services[$id] = new Service(
+				$id,
+				$services[$alias]->getClass(),
+				$service->isPublic(),
+				$service->isSynthetic(),
+				$alias
+			);
+		}
+
+		return new ServiceMap($services);
+	}
+
+}