Initial commit

Author: lookyman

.coveralls.yml

@@ -0,0 +1,3 @@
+service_name: travis-ci
+coverage_clover: coverage.xml
+json_path: coverage.json

.gitattributes

@@ -0,0 +1,8 @@
+tests export-ignore
+.coveralls.yml export-ignore
+.gitattributes export-ignore
+.gitignore export-ignore
+.travis.yml export-ignore
+phpstan.neon export-ignore
+phpunit.xml.dist export-ignore
+ruleset.xml export-ignore

.gitignore

@@ -0,0 +1,2 @@
+/vendor
+composer.lock

.travis.yml

@@ -0,0 +1,36 @@
+language: php
+
+sudo: false
+
+cache:
+  directories:
+    - $HOME/.composer/cache
+
+env: # intentionally blank
+
+php:
+  - 7.0
+  - 7.1
+
+matrix:
+  fast_finish: true
+  include:
+    - php: 7.1
+      env: COVERAGE="1"
+  allow_failures:
+    - php: 7.1
+      env: COVERAGE="1"
+
+install:
+  - travis_retry composer install --no-interaction --prefer-dist
+
+script:
+  - if [ "$COVERAGE" != "1" ]; then composer check; fi
+  - if [ "$COVERAGE" == "1" ]; then ./vendor/bin/phpunit --coverage-clover=./coverage.xml; fi
+
+after_success:
+  - >
+    if [ $COVERAGE == "1" ]; then
+    wget https://github.com/satooshi/php-coveralls/releases/download/v1.0.1/coveralls.phar
+    && php ./coveralls.phar --verbose
+    || true; fi

LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Lukáš Unger
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,23 @@
+# Symfony extension for PHPStan
+
+## What does it do?
+
+* Provides correct return type for `ContainerInterface::get()` method,
+* screams at you when you try to get unknown or private service from the container.
+
+## Installation
+
+```sh
+composer require --dev lookyman/phpstan-symfony
+```
+
+## Configuration
+
+Put this into your `phpstan.neon` config:
+
+```neon
+includes:
+	- vendor/lookyman/phpstan-symfony/extension.neon
+services:
+	- Lookyman\PHPStan\Symfony\ServiceMap(/path/to/appDevDebugProjectContainer.xml)
+```

composer.json

@@ -0,0 +1,46 @@
+{
+  "name": "lookyman/phpstan-symfony",
+  "license": "MIT",
+  "description": "Symfony extension for PHPStan",
+  "keywords": ["PHPStan", "Symfony"],
+  "authors": [
+    {
+      "name": "Lukáš Unger",
+      "email": "[email protected]",
+      "homepage": "https://lookyman.net"
+    }
+  ],
+  "require": {
+    "php": "^7.0",
+    "symfony/dependency-injection": "^3.2",
+    "roave/security-advisories": "dev-master"
+  },
+  "require-dev": {
+    "jakub-onderka/php-parallel-lint": "^0.9.2",
+    "phpstan/phpstan": "^0.6.4",
+    "lookyman/coding-standard": "^0.0.4",
+    "phpunit/phpunit": "^6.0"
+  },
+  "autoload": {
+    "psr-4": {
+      "Lookyman\\PHPStan\\Symfony\\": "src/"
+    }
+  },
+  "autoload-dev": {
+    "psr-4": {
+      "Lookyman\\PHPStan\\Symfony\\": "tests/"
+    }
+  },
+  "scripts": {
+    "lint": "parallel-lint ./src ./tests",
+    "cs": "phpcs --colors --extensions=php --encoding=utf-8 --standard=./ruleset.xml -sp ./src ./tests",
+    "tests": "phpunit --coverage-text",
+    "stan": "phpstan analyse -l 5 -c ./phpstan.neon ./src ./tests",
+    "check": [
+      "@lint",
+      "@cs",
+      "@tests",
+      "@stan"
+    ]
+  }
+}

extension.neon

@@ -0,0 +1,10 @@
+services:
+	-
+		class: Lookyman\PHPStan\Symfony\Type\ContainerInterfaceDynamicReturnTypeExtension
+		tags: [phpstan.broker.dynamicMethodReturnTypeExtension]
+	-
+		class: Lookyman\PHPStan\Symfony\Rules\ContainerInterfacePrivateServiceRule
+		tags: [phpstan.rules.rule]
+	-
+		class: Lookyman\PHPStan\Symfony\Rules\ContainerInterfaceUnknownServiceRule
+		tags: [phpstan.rules.rule]

phpstan.neon

@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit forceCoversAnnotation="true" mapTestClassNameToCoveredClassName="true" verbose="true" colors="true">
+    <testsuites>
+        <testsuite name="Symfony extension for PHPStan">
+            <directory>./tests</directory>
+        </testsuite>
+    </testsuites>
+    <filter>
+        <whitelist processUncoveredFilesFromWhitelist="true">
+            <directory>./src</directory>
+        </whitelist>
+    </filter>
+</phpunit>

phpunit.xml.dist

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<ruleset name="PHPStan Symfony">
+    <rule ref="vendor/lookyman/coding-standard/LookymanCodingStandard/ruleset-7.0.xml"/>
+</ruleset>

ruleset.xml

@@ -0,0 +1,52 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace Lookyman\PHPStan\Symfony\Rules;
+
+use Lookyman\PHPStan\Symfony\ServiceMap;
+use PhpParser\Node;
+use PhpParser\Node\Arg;
+use PhpParser\Node\Expr\MethodCall;
+use PhpParser\Node\Scalar\String_;
+use PHPStan\Analyser\Scope;
+use PHPStan\Rules\Rule;
+use Symfony\Component\DependencyInjection\ContainerInterface;
+
+final class ContainerInterfacePrivateServiceRule implements Rule
+{
+
+	/**
+	 * @var ServiceMap
+	 */
+	private $serviceMap;
+
+	public function __construct(ServiceMap $symfonyServiceMap)
+	{
+		$this->serviceMap = $symfonyServiceMap;
+	}
+
+	public function getNodeType(): string
+	{
+		return MethodCall::class;
+	}
+
+	/**
+	 * @param MethodCall $node
+	 * @param Scope $scope
+	 * @return array
+	 */
+	public function processNode(Node $node, Scope $scope): array
+	{
+		$services = $this->serviceMap->getServices();
+		return $node->name === 'get'
+			&& $scope->getType($node->var)->getClass() === ContainerInterface::class
+			&& isset($node->args[0])
+			&& $node->args[0] instanceof Arg
+			&& $node->args[0]->value instanceof String_
+			&& \array_key_exists($node->args[0]->value->value, $services)
+			&& !$services[$node->args[0]->value->value]['public']
+			? [\sprintf('Service "%s" is private.', $node->args[0]->value->value)]
+			: [];
+	}
+}

src/Rules/ContainerInterfacePrivateServiceRule.php

@@ -0,0 +1,51 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace Lookyman\PHPStan\Symfony\Rules;
+
+use Lookyman\PHPStan\Symfony\ServiceMap;
+use PhpParser\Node;
+use PhpParser\Node\Arg;
+use PhpParser\Node\Expr\MethodCall;
+use PhpParser\Node\Scalar\String_;
+use PHPStan\Analyser\Scope;
+use PHPStan\Rules\Rule;
+use Symfony\Component\DependencyInjection\ContainerInterface;
+
+final class ContainerInterfaceUnknownServiceRule implements Rule
+{
+
+	/**
+	 * @var ServiceMap
+	 */
+	private $serviceMap;
+
+	public function __construct(ServiceMap $symfonyServiceMap)
+	{
+		$this->serviceMap = $symfonyServiceMap;
+	}
+
+	public function getNodeType(): string
+	{
+		return MethodCall::class;
+	}
+
+	/**
+	 * @param MethodCall $node
+	 * @param Scope $scope
+	 * @return array
+	 */
+	public function processNode(Node $node, Scope $scope): array
+	{
+		$services = $this->serviceMap->getServices();
+		return $node->name === 'get'
+			&& $scope->getType($node->var)->getClass() === ContainerInterface::class
+			&& isset($node->args[0])
+			&& $node->args[0] instanceof Arg
+			&& $node->args[0]->value instanceof String_
+			&& !\array_key_exists($node->args[0]->value->value, $services)
+			? [\sprintf('Service "%s" is not registered in the container.', $node->args[0]->value->value)]
+			: [];
+	}
+}

src/Rules/ContainerInterfaceUnknownServiceRule.php

@@ -0,0 +1,50 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace Lookyman\PHPStan\Symfony;
+
+final class ServiceMap
+{
+
+	/**
+	 * @var array
+	 */
+	private $services;
+
+	public function __construct(string $containerXml)
+	{
+		$this->services = $aliases = [];
+		/** @var \SimpleXMLElement $def */
+		foreach (\simplexml_load_file($containerXml)->services->service as $def) {
+			$attrs = $def->attributes();
+			if (!isset($attrs->id)) {
+				continue;
+			}
+			$service = [
+				'class' => isset($attrs->class) ? (string) $attrs->class : \null,
+				'public' => !isset($attrs->public) || (string) $attrs->public !== 'false',
+				'synthetic' => isset($attrs->synthetic) && (string) $attrs->synthetic === 'true',
+			];
+			if (isset($attrs->alias)) {
+				$aliases[(string) $attrs->id] = \array_merge($service, ['alias' => (string) $attrs->alias]);
+			} else {
+				$this->services[(string) $attrs->id] = $service;
+			}
+		}
+		foreach ($aliases as $id => $alias) {
+			if (\array_key_exists($alias['alias'], $this->services)) {
+				$this->services[$id] = [
+					'class' => $this->services[$alias['alias']]['class'],
+					'public' => $alias['public'],
+					'synthetic' => $alias['synthetic'],
+				];
+			}
+		}
+	}
+
+	public function getServices(): array
+	{
+		return $this->services;
+	}
+}

src/ServiceMap.php

@@ -0,0 +1,55 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace Lookyman\PHPStan\Symfony\Type;
+
+use Lookyman\PHPStan\Symfony\ServiceMap;
+use PhpParser\Node\Arg;
+use PhpParser\Node\Expr\MethodCall;
+use PhpParser\Node\Scalar\String_;
+use PHPStan\Analyser\Scope;
+use PHPStan\Reflection\MethodReflection;
+use PHPStan\Type\DynamicMethodReturnTypeExtension;
+use PHPStan\Type\ObjectType;
+use PHPStan\Type\Type;
+use Symfony\Component\DependencyInjection\ContainerInterface;
+
+final class ContainerInterfaceDynamicReturnTypeExtension implements DynamicMethodReturnTypeExtension
+{
+
+	/**
+	 * @var ServiceMap
+	 */
+	private $serviceMap;
+
+	public function __construct(ServiceMap $symfonyServiceMap)
+	{
+		$this->serviceMap = $symfonyServiceMap;
+	}
+
+	public static function getClass(): string
+	{
+		return ContainerInterface::class;
+	}
+
+	public function isMethodSupported(MethodReflection $methodReflection): bool
+	{
+		return $methodReflection->getName() === 'get';
+	}
+
+	public function getTypeFromMethodCall(
+		MethodReflection $methodReflection,
+		MethodCall $methodCall,
+		Scope $scope
+	): Type {
+		$services = $this->serviceMap->getServices();
+		return isset($methodCall->args[0])
+			&& $methodCall->args[0] instanceof Arg
+			&& $methodCall->args[0]->value instanceof String_
+			&& \array_key_exists($methodCall->args[0]->value->value, $services)
+			&& !$services[$methodCall->args[0]->value->value]['synthetic']
+			? new ObjectType($services[$methodCall->args[0]->value->value]['class'], \false)
+			: $methodReflection->getReturnType();
+	}
+}