Fix compatibility with doctrine/collections v3 and bump phpstan to v2 (#51)

* Bump phpstan version to 2.2
* Fix support for doctrine/collections v3

Author: W0rma

composer.json

@@ -25,9 +25,9 @@
     "require-dev": {
         "codeception/stub": "^4.1.3",
         "doctrine/annotations": "^2.0.1",
-        "doctrine/data-fixtures": "^1.6",
+        "doctrine/data-fixtures": "^1.7",
         "doctrine/orm": "^2.14 || ^3.0",
-        "phpstan/phpstan": "^1.10.58",
+        "phpstan/phpstan": "^2.2",
         "symfony/cache": "^5.4.35 || ^6.4.3 || ^7.0",
         "symfony/doctrine-bridge": "^5.4.35 || ^6.4.3 || ^7.0",
         "symfony/uid": "^5.4.35 || ^6.4.3 || ^7.0"

phpstan.neon

@@ -9,6 +9,7 @@ parameters:
         - tests/data/doctrine_fixtures/TestFixture2.php
         - tests/_support/UnitTester.php
   reportUnmatchedIgnoredErrors: true
+  treatPhpDocTypesAsCertain: false
   ignoreErrors:
       - path: tests/
         message: '#Property \S+ is never read, only written#'
@@ -20,4 +21,6 @@ parameters:
         message: '#Method \S+ has no return type specified#'
       - path: tests/
         message: '#(?:Method|Property) .+ with generic (?:interface|class) \S+ does not specify its types#'
+      - path: tests/
+        identifier: property.unusedType
       - identifier: missingType.iterableValue

src/Codeception/Module/Doctrine.php

@@ -254,15 +254,8 @@ protected function retrieveEntityManager(): void
         }
 
 
-        if (!($this->em instanceof EntityManagerInterface)) {
-            throw new ModuleConfigException(
-                __CLASS__,
-                "Connection object is not an instance of \\Doctrine\\ORM\\EntityManagerInterface.\n"
-                . "Use `connection_callback` or dependent framework modules to specify one"
-            );
-        }
-
         $connection = $this->em->getConnection();
+        // @phpstan-ignore-next-line
         if (method_exists($connection, 'getNativeConnection')) {
             $connection->getNativeConnection();
         } else {
@@ -732,7 +725,7 @@ public function loadFixtures($fixtures, bool $append = true): void
 
                 try {
                     $fixtureInstance = new $fixture();
-                } catch (Exception $exception) { // @phpstan-ignore-line https://github.com/phpstan/phpstan/issues/6574
+                } catch (Exception $exception) {
                     throw new ModuleException(
                         __CLASS__,
                         sprintf(
@@ -991,6 +984,7 @@ protected function _buildAssociationQuery(QueryBuilder $qb, string $assoc, strin
     {
         $data = $this->em->getClassMetadata($assoc);
         foreach ($params as $key => $val) {
+            // @phpstan-ignore-next-line
             if ($data->associationMappings !== null && array_key_exists($key, $data->associationMappings)) {
                 $map = $data->associationMappings[$key];
                 if (is_array($val)) {
@@ -1005,7 +999,9 @@ protected function _buildAssociationQuery(QueryBuilder $qb, string $assoc, strin
             } elseif ($val instanceof Criteria) {
                 $qb->addCriteria($val);
             } elseif ($val instanceof Expression) {
-                $qb->addCriteria(Criteria::create(true)->where($val));
+                // Doctrine Collections 2.x support
+                $criteria = defined(Criteria::class . '::ASC') ? Criteria::create(true) : Criteria::create();
+                $qb->addCriteria($criteria->where($val));
             } else {
                 $qb->andWhere(sprintf('%s.%s = ?%s', $alias, $key, $paramIndex));
                 $qb->setParameter($paramIndex, $val);

src/Codeception/Util/ReflectionPropertyAccessor.php

@@ -72,7 +72,7 @@ private function setPropertiesForClass(?object $obj, string $class, array $data)
      */
     public function setProperties(?object $obj, array $data): void
     {
-        if (!$obj || !is_object($obj)) {
+        if (!is_object($obj)) {
             throw new InvalidArgumentException('Cannot set properties for "' . gettype($obj) . '", expecting object');
         }
         $class = get_class($obj);

tests/unit/Codeception/Module/Doctrine2Test.php

@@ -9,6 +9,7 @@
 use Codeception\Stub;
 use Codeception\Test\Unit;
 use Doctrine\Common\Collections\Criteria;
+use Doctrine\Common\Collections\Order;
 use Doctrine\Common\DataFixtures\Executor\ORMExecutor;
 use Doctrine\Common\DataFixtures\Loader;
 use Doctrine\Common\DataFixtures\Purger\ORMPurger;
@@ -71,14 +72,7 @@ protected function _setUp()
         require_once $dir . "/CircularRelations/C.php";
         require_once $dir . '/EntityWithUlid.php';
 
-        $sqliteDriver = 'sqlite3';
-        // The driver "sqlite3" is only available as-of doctrine/dbal:3.5
-        // Use "pdo_sqlite" for older versions
-        if (version_compare(InstalledVersions::getVersion('doctrine/dbal'), '3.5', '<')) {
-            $sqliteDriver = 'pdo_sqlite';
-        }
-
-        $connection = DriverManager::getConnection(['driver' => $sqliteDriver, 'memory' => true]);
+        $connection = DriverManager::getConnection(['driver' => 'pdo_sqlite', 'memory' => true]);
 
         if (version_compare(InstalledVersions::getVersion('doctrine/orm'), '3', '>=')) {
             $configuration = ORMSetup::createAttributeMetadataConfiguration([$dir], true);
@@ -258,17 +252,17 @@ public function testCriteria()
     {
         $this->module->haveInRepository(PlainEntity::class, ['name' => 'Test 1']);
         $this->module->seeInRepository(PlainEntity::class, [
-            Criteria::create(true)->where(
+            self::createCriteria()->where(
                 Criteria::expr()->eq('name', 'Test 1')
             ),
         ]);
         $this->module->seeInRepository(PlainEntity::class, [
-            Criteria::create(true)->where(
+            self::createCriteria()->where(
                 Criteria::expr()->contains('name', 'est')
             ),
         ]);
         $this->module->seeInRepository(PlainEntity::class, [
-            Criteria::create(true)->where(
+            self::createCriteria()->where(
                 Criteria::expr()->in('name', ['Test 1'])
             ),
         ]);
@@ -296,14 +290,26 @@ public function testOrderBy()
 
         $getName = fn($entity) => $entity->getName();
 
+        $collectionsVersion = InstalledVersions::getVersion('doctrine/collections');
+        if (version_compare($collectionsVersion, '3.0', '<')) {
+            $ascending = 'asc';
+            $descending = 'desc';
+        } elseif (version_compare($collectionsVersion, '3.1', '<')) {
+            $ascending = Order::Ascending;
+            $descending = Order::Descending;
+        } else {
+            $ascending = \SortDirection::Ascending;
+            $descending = \SortDirection::Descending;
+        }
+        
         $this->assertSame(
             [
                 'a',
                 'b',
                 'c',
             ],
             array_map($getName, $this->module->grabEntitiesFromRepository(PlainEntity::class, [
-                Criteria::create(true)->orderBy(['name' => 'asc']),
+                self::createCriteria()->orderBy(['name' => $ascending]),
             ]))
         );
 
@@ -314,7 +320,7 @@ public function testOrderBy()
                 'a',
             ],
             array_map($getName, $this->module->grabEntitiesFromRepository(PlainEntity::class, [
-                Criteria::create(true)->orderBy(['name' => 'desc']),
+                self::createCriteria()->orderBy(['name' => $descending]),
             ]))
         );
     }
@@ -597,4 +603,10 @@ public function testHaveFakeRepository()
         $this->assertContains($e1, $entities);
         $this->assertContains($e2, $entities);
     }
+
+    private static function createCriteria(): Criteria
+    {
+        // Doctrine Collections 2.x support
+        return defined(Criteria::class . '::ASC') ? Criteria::create(true) : Criteria::create();
+    }
 }