Merge pull request #2465 from greg0ire/evaluate-collections-2

Author: greg0ire

composer.json

@@ -26,7 +26,7 @@
         "ext-mongodb": "^1.5",
         "doctrine/annotations": "^1.12",
         "doctrine/cache": "^1.11 || ^2.0",
-        "doctrine/collections": "^1.5",
+        "doctrine/collections": "^1.5 || ^2.0",
         "doctrine/event-manager": "^1.0",
         "doctrine/instantiator": "^1.1",
         "doctrine/persistence": "^2.4 || ^3.0",

lib/Doctrine/ODM/MongoDB/PersistentCollection/PersistentCollectionTrait.php

@@ -4,6 +4,7 @@
 
 namespace Doctrine\ODM\MongoDB\PersistentCollection;
 
+use BadMethodCallException;
 use Closure;
 use Doctrine\Common\Collections\Collection as BaseCollection;
 use Doctrine\ODM\MongoDB\DocumentManager;
@@ -22,6 +23,7 @@
 use function count;
 use function get_class;
 use function is_object;
+use function method_exists;
 
 /**
  * Trait with methods needed to implement PersistentCollectionInterface.
@@ -742,4 +744,36 @@ private function needsSchedulingForSynchronization(): bool
         return $this->owner && $this->dm && ! empty($this->mapping['isOwningSide'])
             && $this->dm->getClassMetadata(get_class($this->owner))->isChangeTrackingNotify();
     }
+
+    /**
+     * @psalm-param Closure(TKey, T):bool $p
+     *
+     * @psalm-return T|null
+     */
+    public function findFirst(Closure $p)
+    {
+        if (! method_exists($this->coll, 'findFirst')) {
+            throw new BadMethodCallException('findFirst() is only available since doctrine/collections v2');
+        }
+
+        return $this->coll->findFirst($p);
+    }
+
+    /**
+     * @psalm-param Closure(TReturn|TInitial|null, T):(TInitial|TReturn) $func
+     * @psalm-param TInitial|null $initial
+     *
+     * @psalm-return TReturn|TInitial|null
+     *
+     * @psalm-template TReturn
+     * @psalm-template TInitial
+     */
+    public function reduce(Closure $func, $initial = null)
+    {
+        if (! method_exists($this->coll, 'reduce')) {
+            throw new BadMethodCallException('reduce() is only available since doctrine/collections v2');
+        }
+
+        return $this->coll->reduce($func, $initial);
+    }
 }

phpstan-baseline.neon

@@ -63,6 +63,12 @@ parameters:
             count: 1
             path: tests/Doctrine/ODM/MongoDB/Tests/SchemaManagerTest.php
 
+        # Support for doctrine/collections v1
+        -
+            message: '#^Method Doctrine\\ODM\\MongoDB\\PersistentCollection\:\:add\(\) with return type void returns true but should not return anything\.$#'
+            count: 1
+            path: lib/Doctrine/ODM/MongoDB/PersistentCollection.php
+
         # import type in PHPStan does not work, see https://github.com/phpstan/phpstan/issues/5091
         -
             message: "#^Access to offset '.+' on an unknown class Doctrine\\\\ODM\\\\MongoDB\\\\PersistentCollection\\\\FieldMapping\\.$#"

psalm.xml

@@ -40,5 +40,11 @@
                 <referencedClass name="ReturnTypeWillChange" />
             </errorLevel>
         </UndefinedAttributeClass>
+        <InvalidReturnType>
+            <errorLevel type="suppress">
+                <!-- Remove it when dropping support for doctrine/collections v1 -->
+                <file name="lib/Doctrine/ODM/MongoDB/PersistentCollection/PersistentCollectionTrait.php"/>
+            </errorLevel>
+        </InvalidReturnType>
     </issueHandlers>
 </psalm>

tests/Doctrine/ODM/MongoDB/Tests/Functional/Ticket/MODM29Test.php

@@ -9,6 +9,8 @@
 use Doctrine\ODM\MongoDB\Mapping\Annotations as ODM;
 use Doctrine\ODM\MongoDB\Tests\BaseTest;
 
+use function assert;
+
 class MODM29Test extends BaseTest
 {
     public function testTest(): void
@@ -25,6 +27,7 @@ public function testTest(): void
         $this->dm->persist($doc);
         $this->dm->flush();
 
+        assert(isset($collection[0], $collection[1], $collection[2]));
         // place element '0' after '1'
         $collection = new ArrayCollection([
             $collection[1],