First version

ondrejmirtes · ondrejmirtes · commit 825a1a1e8cc0 · 2017-01-30T23:34:46.000+01:00
diff --git a/.coveralls.yml b/.coveralls.yml
@@ -0,0 +1,3 @@
+service_name: travis-ci
+coverage_clover: tests/tmp/clover.xml
+json_path: tests/tmp/coveralls.json
diff --git a/.gitattributes b/.gitattributes
@@ -0,0 +1 @@
+/tests export-ignore
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,2 @@
+/composer.lock
+/vendor
diff --git a/.travis.yml b/.travis.yml
@@ -0,0 +1,11 @@
+language: php
+php:
+  - 7.0
+  - 7.1
+before_script:
+  - composer self-update
+  - composer install
+script:
+  - vendor/bin/phing
+after_script:
+  - php vendor/bin/coveralls -v
diff --git a/README.md b/README.md
@@ -0,0 +1,28 @@
+# Doctrine extensions for PHPStan
+
+[![Build Status](https://travis-ci.org/phpstan/phpstan-doctrine.svg)](https://travis-ci.org/phpstan/phpstan-doctrine)
+[![Latest Stable Version](https://poser.pugx.org/phpstan/phpstan-doctrine/v/stable)](https://packagist.org/packages/phpstan/phpstan-doctrine)
+[![License](https://poser.pugx.org/phpstan/phpstan-doctrine/license)](https://packagist.org/packages/phpstan/phpstan-doctrine)
+
+* [PHPStan](https://github.com/phpstan/phpstan)
+* [Doctrine](http://www.doctrine-project.org/)
+
+This extension provides following features:
+
+* Provides correct return type for `Doctrine\ORM\EntityManager::find`, `getReference` and `getPartialReference` when `Foo::class` entity class name is provided as the first argument
+* Adds missing `matching` method on `Doctrine\Common\Collections\Collection`
+
+## Usage
+
+To use this extension, require it in [Composer](https://getcomposer.org/):
+
+```
+composer require --dev phpstan/phpstan-doctrine
+```
+
+And include extension.neon in your project's PHPStan config:
+
+```
+includes:
+	- vendor/phpstan/phpstan-doctrine/extension.neon
+```
diff --git a/build.xml b/build.xml
@@ -0,0 +1,103 @@
+<?xml version="1.0" encoding="utf-8"?>
+<project name="PHPStan Doctrine extensions" default="check">
+
+	<target name="check" depends="
+		composer,
+		lint,
+		cs,
+		tests,
+		phpstan
+	"/>
+
+	<target name="composer">
+		<exec
+				executable="composer"
+				logoutput="true"
+				passthru="true"
+				checkreturn="true"
+		>
+			<arg value="install"/>
+		</exec>
+	</target>
+
+	<target name="lint">
+		<exec
+				executable="vendor/bin/parallel-lint"
+				logoutput="true"
+				passthru="true"
+				checkreturn="true"
+		>
+			<arg value="--exclude"/>
+			<arg path="tests/PHPStan/Analyser/data"/>
+			<arg path="src" />
+			<arg path="tests" />
+		</exec>
+	</target>
+
+	<target name="cs">
+		<exec
+				executable="vendor/bin/phpcs"
+				logoutput="true"
+				passthru="true"
+				checkreturn="true"
+		>
+			<arg value="--standard=ruleset.xml"/>
+			<arg value="--extensions=php"/>
+			<arg value="--encoding=utf-8"/>
+			<arg value="--tab-width=4"/>
+			<arg value="--ignore=tests/*/data"/>
+			<arg value="-sp"/>
+			<arg path="src"/>
+			<arg path="tests"/>
+		</exec>
+	</target>
+
+	<target name="cs-fix">
+		<exec
+				executable="vendor/bin/phpcbf"
+				logoutput="true"
+				passthru="true"
+				checkreturn="true"
+		>
+			<arg value="--standard=ruleset.xml"/>
+			<arg value="--extensions=php"/>
+			<arg value="--encoding=utf-8"/>
+			<arg value="--tab-width=4"/>
+			<arg value="--ignore=tests/*/data"/>
+			<arg value="-sp"/>
+			<arg path="src"/>
+			<arg path="tests"/>
+		</exec>
+	</target>
+
+	<target name="tests">
+		<exec
+				executable="vendor/bin/phpunit"
+				logoutput="true"
+				passthru="true"
+				checkreturn="true"
+		>
+			<arg value="-c"/>
+			<arg value="tests/phpunit.xml"/>
+			<arg path="tests"/>
+		</exec>
+	</target>
+
+	<target name="phpstan">
+		<exec
+				executable="vendor/bin/phpstan"
+				logoutput="true"
+				passthru="true"
+				checkreturn="true"
+		>
+			<arg value="analyse"/>
+			<arg value="-l"/>
+			<arg value="4"/>
+			<arg value="-c"/>
+			<arg path="phpstan.neon"/>
+			<arg path="src"/>
+			<arg path="tests"/>
+		</exec>
+	</target>
+
+</project>
diff --git a/composer.json b/composer.json
@@ -0,0 +1,27 @@
+{
+	"name": "phpstan/phpstan-doctrine",
+	"description": "Doctrine extensions for PHPStan",
+	"license": ["MIT"],
+	"minimum-stability": "dev",
+	"prefer-stable": true,
+	"require": {
+		"php": "~7.0",
+		"phpstan/phpstan": "^0.6",
+		"doctrine/common": "^2.7",
+		"doctrine/orm": "^2.5"
+	},
+	"require-dev": {
+		"consistence/coding-standard": "~0.12.0",
+		"phing/phing": "^2.16.0",
+		"phpunit/phpunit": "^5.7",
+		"slevomat/coding-standard": "dev-php7#d4a1a9c"
+	},
+	"autoload": {
+		"psr-4": {
+			"PHPStan\\": "src/"
+		}
+	},
+	"autoload-dev": {
+		"classmap": ["tests/"]
+	}
+}
diff --git a/extension.neon b/extension.neon
@@ -0,0 +1,9 @@
+services:
+	-
+		class: PHPStan\Reflection\Doctrine\DoctrineSelectableClassReflectionExtension
+		tags:
+			- phpstan.broker.methodsClassReflectionExtension
+	-
+		class: PHPStan\Type\Doctrine\EntityManagerFindDynamicReturnTypeExtension
+		tags:
+			- phpstan.broker.dynamicMethodReturnTypeExtension
diff --git a/phpstan.neon b/phpstan.neon
@@ -0,0 +1,2 @@
+parameters:
+	ignoreErrors: []
diff --git a/ruleset.xml b/ruleset.xml
@@ -0,0 +1,17 @@
+<?xml version="1.0"?>
+<ruleset name="PHPStan Doctrine extensions">
+	<rule ref="vendor/consistence/coding-standard/Consistence/ruleset.xml"/>
+	<rule ref="vendor/slevomat/coding-standard/SlevomatCodingStandard/ruleset.xml">
+		<exclude name="SlevomatCodingStandard.Files.TypeNameMatchesFileName"/>
+		<exclude name="SlevomatCodingStandard.Namespaces.FullyQualifiedClassNameAfterKeyword"/>
+		<exclude name="SlevomatCodingStandard.Namespaces.UseOnlyWhitelistedNamespaces"/>
+		<exclude name="SlevomatCodingStandard.Namespaces.ReferenceUsedNamesOnly"/>
+	</rule>
+	<rule ref="SlevomatCodingStandard.Typehints.TypeHintDeclaration">
+		<properties>
+			<property name="usefulAnnotations" type="array" value="
+				@dataProvider
+			"/>
+		</properties>
+	</rule>
+</ruleset>
diff --git a/src/Reflection/Doctrine/DoctrineSelectableClassReflectionExtension.php b/src/Reflection/Doctrine/DoctrineSelectableClassReflectionExtension.php
@@ -0,0 +1,28 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Reflection\Doctrine;
+
+class DoctrineSelectableClassReflectionExtension implements \PHPStan\Reflection\MethodsClassReflectionExtension, \PHPStan\Reflection\BrokerAwareClassReflectionExtension
+{
+
+	/** @var \PHPStan\Broker\Broker */
+	private $broker;
+
+	public function setBroker(\PHPStan\Broker\Broker $broker)
+	{
+		$this->broker = $broker;
+	}
+
+	public function hasMethod(\PHPStan\Reflection\ClassReflection $classReflection, string $methodName): bool
+	{
+		return $classReflection->getName() === \Doctrine\Common\Collections\Collection::class
+			&& $methodName === 'matching';
+	}
+
+	public function getMethod(\PHPStan\Reflection\ClassReflection $classReflection, string $methodName): \PHPStan\Reflection\MethodReflection
+	{
+		$selectableReflection = $this->broker->getClass(\Doctrine\Common\Collections\Selectable::class);
+		return $selectableReflection->getMethod($methodName);
+	}
+
+}
diff --git a/src/Type/Doctrine/EntityManagerFindDynamicReturnTypeExtension.php b/src/Type/Doctrine/EntityManagerFindDynamicReturnTypeExtension.php
@@ -0,0 +1,60 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Type\Doctrine;
+
+use PhpParser\Node\Expr\MethodCall;
+use PHPStan\Analyser\Scope;
+use PHPStan\Reflection\MethodReflection;
+use PHPStan\Type\ObjectType;
+use PHPStan\Type\Type;
+
+class EntityManagerFindDynamicReturnTypeExtension implements \PHPStan\Type\DynamicMethodReturnTypeExtension
+{
+
+	public static function getClass(): string
+	{
+		return \Doctrine\ORM\EntityManager::class;
+	}
+
+	public function isMethodSupported(MethodReflection $methodReflection): bool
+	{
+		return in_array($methodReflection->getName(), [
+			'find',
+			'getReference',
+			'getPartialReference',
+		], true);
+	}
+
+	public function getTypeFromMethodCall(
+		MethodReflection $methodReflection,
+		MethodCall $methodCall,
+		Scope $scope
+	): Type
+	{
+		if (count($methodCall->args) === 0) {
+			return $methodReflection->getReturnType();
+		}
+		$arg = $methodCall->args[0]->value;
+		if (!($arg instanceof \PhpParser\Node\Expr\ClassConstFetch)) {
+			return $methodReflection->getReturnType();
+		}
+
+		$class = $arg->class;
+		if (!($class instanceof \PhpParser\Node\Name)) {
+			return $methodReflection->getReturnType();
+		}
+
+		$class = (string) $class;
+
+		if ($class === 'static') {
+			return $methodReflection->getReturnType();
+		}
+
+		if ($class === 'self') {
+			$class = $scope->getClass();
+		}
+
+		return new ObjectType($class, $methodReflection->getName() === 'find');
+	}
+
+}
diff --git a/tests/bootstrap.php b/tests/bootstrap.php
@@ -0,0 +1,3 @@
+<?php declare(strict_types = 1);
+
+require_once __DIR__ . '/../vendor/autoload.php';
diff --git a/tests/phpunit.xml b/tests/phpunit.xml
@@ -0,0 +1,26 @@
+<phpunit
+		bootstrap="bootstrap.php"
+		colors="true"
+		backupGlobals="false"
+		backupStaticAttributes="false"
+		beStrictAboutChangesToGlobalState="true"
+		beStrictAboutOutputDuringTests="true"
+		beStrictAboutTestsThatDoNotTestAnything="true"
+		beStrictAboutTodoAnnotatedTests="true"
+		failOnRisky="true"
+		failOnWarning="true"
+>
+	<filter>
+		<whitelist>
+			<directory suffix=".php">../src</directory>
+		</whitelist>
+	</filter>
+	<logging>
+		<log
+				type="coverage-text"
+				target="php://stdout"
+				showUncoveredFiles="true"
+				showOnlySummary="true"
+		/>
+	</logging>
+</phpunit>

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+service_name: travis-ci`
	`2`	`+coverage_clover: tests/tmp/clover.xml`
	`3`	`+json_path: tests/tmp/coveralls.json`