Add integration tests for ODM features

.travis.yml

@@ -3,6 +3,7 @@ php:
   - 7.1
   - 7.2
 before_script:
+  - pecl install -f mongodb-stable
   - composer self-update
   - composer install
 script:

composer.json

@@ -25,12 +25,15 @@
 		"slevomat/coding-standard": "^4.5.2",
 		"doctrine/common": "^2.7",
 		"doctrine/orm": "^2.5",
-		"doctrine/collections": "^1.0"
+		"doctrine/collections": "^1.0",
+		"doctrine/mongodb-odm": "^1.2",
+		"alcaeus/mongo-php-adapter": "^1.1"
 	},
 	"conflict": {
 		"doctrine/common": "<2.7",
 		"doctrine/orm": "<2.5",
-		"doctrine/collections": "<1.0"
+		"doctrine/collections": "<1.0",
+		"doctrine/mongodb-odm": "<1.2"
 	},
 	"autoload": {
 		"psr-4": {
@@ -39,5 +42,10 @@
 	},
 	"autoload-dev": {
 		"classmap": ["tests/"]
+	},
+	"config": {
+		"platform": {
+			"ext-mongo": "1.6.16"
+		}
 	}
 }

extension.neon

@@ -12,11 +12,11 @@ services:
 		tags:
 			- phpstan.broker.dynamicMethodReturnTypeExtension
 	-
-		class: PHPStan\Type\Doctrine\EntityManagerFindDynamicReturnTypeExtension
+		class: PHPStan\Type\Doctrine\ObjectManagerFindDynamicReturnTypeExtension
 		tags:
 			- phpstan.broker.dynamicMethodReturnTypeExtension
 	-
-		class: PHPStan\Type\Doctrine\EntityManagerGetRepositoryDynamicReturnTypeExtension
+		class: PHPStan\Type\Doctrine\ObjectManagerGetRepositoryDynamicReturnTypeExtension
 		arguments:
 			repositoryClass: %doctrine.repositoryClass%
 		tags:
@@ -26,6 +26,6 @@ services:
 		tags:
 			- phpstan.broker.dynamicMethodReturnTypeExtension
 	-
-		class: PHPStan\Type\Doctrine\EntityRepositoryDynamicReturnTypeExtension
+		class: PHPStan\Type\Doctrine\ObjectRepositoryDynamicReturnTypeExtension
 		tags:
 			- phpstan.broker.dynamicMethodReturnTypeExtension

phpstan.neon

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

src/Type/Doctrine/EntityManagerFindDynamicReturnTypeExtension.php → src/Type/Doctrine/ObjectManagerFindDynamicReturnTypeExtension.php

@@ -11,7 +11,7 @@
 use PHPStan\Type\Type;
 use PHPStan\Type\TypeCombinator;
 
-class EntityManagerFindDynamicReturnTypeExtension implements \PHPStan\Type\DynamicMethodReturnTypeExtension
+class ObjectManagerFindDynamicReturnTypeExtension implements \PHPStan\Type\DynamicMethodReturnTypeExtension
 {
 
 	public function getClass(): string
@@ -43,12 +43,7 @@ public function getTypeFromMethodCall(
 			return $mixedType;
 		}
 
-		$type = new ObjectType($argType->getValue());
-		if ($methodReflection->getName() === 'find') {
-			$type = TypeCombinator::addNull($type);
-		}
-
-		return $type;
+		return TypeCombinator::addNull(new ObjectType($argType->getValue()));
 	}
 
 }

src/Type/Doctrine/EntityManagerGetRepositoryDynamicReturnTypeExtension.php → src/Type/Doctrine/ObjectManagerGetRepositoryDynamicReturnTypeExtension.php

@@ -10,7 +10,7 @@
 use PHPStan\Type\MixedType;
 use PHPStan\Type\Type;
 
-class EntityManagerGetRepositoryDynamicReturnTypeExtension implements \PHPStan\Type\DynamicMethodReturnTypeExtension
+class ObjectManagerGetRepositoryDynamicReturnTypeExtension implements \PHPStan\Type\DynamicMethodReturnTypeExtension
 {
 
 	/** @var string */
@@ -47,7 +47,7 @@ public function getTypeFromMethodCall(
 			return new MixedType();
 		}
 
-		return new EntityRepositoryType($argType->getValue(), $this->repositoryClass);
+		return new ObjectRepositoryType($argType->getValue(), $this->repositoryClass);
 	}
 
 }

src/Type/Doctrine/EntityRepositoryDynamicReturnTypeExtension.php → src/Type/Doctrine/ObjectRepositoryDynamicReturnTypeExtension.php

@@ -12,12 +12,12 @@
 use PHPStan\Type\Type;
 use PHPStan\Type\TypeCombinator;
 
-class EntityRepositoryDynamicReturnTypeExtension implements \PHPStan\Type\DynamicMethodReturnTypeExtension
+class ObjectRepositoryDynamicReturnTypeExtension implements \PHPStan\Type\DynamicMethodReturnTypeExtension
 {
 
 	public function getClass(): string
 	{
-		return 'Doctrine\ORM\EntityRepository';
+		return 'Doctrine\Common\Persistence\ObjectRepository';
 	}
 
 	public function isMethodSupported(MethodReflection $methodReflection): bool
@@ -36,7 +36,7 @@ public function getTypeFromMethodCall(
 	): Type
 	{
 		$calledOnType = $scope->getType($methodCall->var);
-		if (!$calledOnType instanceof EntityRepositoryType) {
+		if (!$calledOnType instanceof ObjectRepositoryType) {
 			return new MixedType();
 		}
 		$methodName = $methodReflection->getName();

src/Type/Doctrine/EntityRepositoryType.php → src/Type/Doctrine/ObjectRepositoryType.php

@@ -5,7 +5,7 @@
 use PHPStan\Type\ObjectType;
 use PHPStan\Type\VerbosityLevel;
 
-class EntityRepositoryType extends ObjectType
+class ObjectRepositoryType extends ObjectType
 {
 
 	/** @var string */

tests/DoctrineIntegration/ODM/DocumentManagerIntegrationTest.php

@@ -0,0 +1,37 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\DoctrineIntegration\ODM;
+
+use PHPStan\Testing\LevelsTestCase;
+
+final class DocumentManagerIntegrationTest extends LevelsTestCase
+{
+
+	/**
+	 * @return string[][]
+	 */
+	public function dataTopics(): array
+	{
+		return [
+			['documentManagerDynamicReturn'],
+			['documentRepositoryDynamicReturn'],
+			['documentManagerMergeReturn'],
+		];
+	}
+
+	public function getDataPath(): string
+	{
+		return __DIR__ . '/data';
+	}
+
+	public function getPhpStanExecutablePath(): string
+	{
+		return __DIR__ . '/../../../vendor/bin/phpstan';
+	}
+
+	public function getPhpStanConfigPath(): ?string
+	{
+		return __DIR__ . '/phpstan.neon';
+	}
+
+}

tests/DoctrineIntegration/ODM/data/documentManagerDynamicReturn.php

@@ -0,0 +1,71 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\DoctrineIntegration\ODM\DocumentManagerDynamicReturn;
+
+use Doctrine\ODM\MongoDB\DocumentManager;
+use Doctrine\ODM\MongoDB\Mapping\Annotations\Document;
+use Doctrine\ODM\MongoDB\Mapping\Annotations\Id;
+use RuntimeException;
+
+class Example
+{
+	/**
+	 * @var DocumentManager
+	 */
+	private $documentManager;
+
+	public function __construct(DocumentManager $documentManager)
+	{
+		$this->documentManager = $documentManager;
+	}
+
+	public function findDynamicType(): void
+	{
+		$test = $this->documentManager->find(MyDocument::class, 'blah-123');
+
+		if ($test === null) {
+			throw new RuntimeException('Sorry, but no...');
+		}
+
+		$test->doSomething();
+	}
+
+	public function getReferenceDynamicType(): void
+	{
+		$test = $this->documentManager->getReference(MyDocument::class, 'blah-123');
+
+		if ($test === null) {
+			throw new RuntimeException('Sorry, but no...');
+		}
+
+		$test->doSomething();
+	}
+
+	public function getPartialReferenceDynamicType(): void
+	{
+		$test = $this->documentManager->getPartialReference(MyDocument::class, 'blah-123');
+
+		if ($test === null) {
+			throw new RuntimeException('Sorry, but no...');
+		}
+
+		$test->doSomething();
+	}
+}
+
+/**
+ * @Document()
+ */
+class MyDocument
+{
+	/**
+	 * @Id(strategy="NONE", type="string")
+	 *
+	 * @var string
+	 */
+	private $id;
+
+	public function doSomething(): void
+	{
+	}
+}

tests/DoctrineIntegration/ODM/data/documentManagerMergeReturn.php

@@ -0,0 +1,43 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\DoctrineIntegration\ODM\DocumentManagerMergeReturn;
+
+use Doctrine\ODM\MongoDB\DocumentManager;
+use Doctrine\ODM\MongoDB\Mapping\Annotations\Document;
+use Doctrine\ODM\MongoDB\Mapping\Annotations\Id;
+
+class Example
+{
+	/**
+	 * @var DocumentManager
+	 */
+	private $documentManager;
+
+	public function __construct(DocumentManager $documentManager)
+	{
+		$this->documentManager = $documentManager;
+	}
+
+	public function merge(): void
+	{
+		$test = $this->documentManager->merge(new MyDocument());
+		$test->doSomething();
+	}
+}
+
+/**
+ * @Document()
+ */
+class MyDocument
+{
+	/**
+	 * @Id(strategy="NONE", type="string")
+	 *
+	 * @var string
+	 */
+	private $id;
+
+	public function doSomething(): void
+	{
+	}
+}

tests/DoctrineIntegration/ODM/data/documentRepositoryDynamicReturn.php

@@ -0,0 +1,79 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\DoctrineIntegration\ODM\DocumentRepositoryDynamicReturn;
+
+use Doctrine\ODM\MongoDB\DocumentManager;
+use Doctrine\ODM\MongoDB\DocumentRepository;
+use Doctrine\ODM\MongoDB\Mapping\Annotations\Document;
+use Doctrine\ODM\MongoDB\Mapping\Annotations\Id;
+use RuntimeException;
+
+class Example
+{
+	/**
+	 * @var DocumentRepository
+	 */
+	private $repository;
+
+	public function __construct(DocumentManager $documentManager)
+	{
+		$this->repository = $documentManager->getRepository(MyDocument::class);
+	}
+
+	public function findDynamicType(): void
+	{
+		$test = $this->repository->find(1);
+
+		if ($test === null) {
+			throw new RuntimeException('Sorry, but no...');
+		}
+
+		$test->doSomething();
+	}
+
+	public function findOneByDynamicType(): void
+	{
+		$test = $this->repository->findOneBy(['blah' => 'testing']);
+
+		if ($test === null) {
+			throw new RuntimeException('Sorry, but no...');
+		}
+
+		$test->doSomething();
+	}
+
+	public function findAllDynamicType(): void
+	{
+		$items = $this->repository->findAll();
+
+		foreach ($items as $test) {
+			$test->doSomething();
+		}
+	}
+
+	public function findByDynamicType(): void
+	{
+		$items = $this->repository->findBy(['blah' => 'testing']);
+
+		foreach ($items as $test) {
+			$test->doSomething();
+		}
+	}
+}
+
+/**
+ * @Document()
+ */
+class MyDocument
+{
+	/**
+	 * @Id(strategy="NONE", type="string")
+	 *
+	 * @var string
+	 */
+	private $id;
+
+	public function doSomething(): void
+	{
+	}
+}

tests/DoctrineIntegration/ODM/phpstan.neon

@@ -0,0 +1,6 @@
+includes:
+	- ../../../extension.neon
+
+parameters:
+	doctrine:
+		repositoryClass: Doctrine\ODM\MongoDB\DocumentRepository