chore: support dbal 4, orm 3, phpcr-odm 2

refugis · Jan 7, 2025 · 3c30a9e · 3c30a9e
1 parent 393d1b8
commit 3c30a9e
Show file tree

Hide file tree

Showing 40 changed files with 748 additions and 259 deletions.
diff --git a/.github/workflows/phpstan.yml b/.github/workflows/phpstan.yml
@@ -18,7 +18,7 @@ jobs:
                 uses: shivammathur/setup-php@v2
                 with:
                     coverage: none
-                    php-version: "8.2"
+                    php-version: "8.3"
                     tools: cs2pr
 
             -   name: Install dependencies with composer

diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -15,8 +15,14 @@ jobs:
                 php_version:
                     - '8.1'
                     - '8.2'
+                    - '8.3'
+                    - '8.4'
 
-        name: PHP ${{ matrix.php_version }}
+                dbal_version:
+                    - 3.0
+                    - 4.0
+
+        name: PHP ${{ matrix.php_version }} - DBAL ${{ matrix.dbal_version }}
         steps:
             - uses: actions/checkout@v2
 
@@ -28,6 +34,7 @@ jobs:
                   extensions: :opcache, mongodb
 
             - run: composer remove --no-update --dev roave/security-advisories solido/php-coding-standards
+            - run: composer require --no-update doctrine/dbal:^${{ matrix.dbal_version }}
             - run: composer update --with-all-dependencies ${{ matrix.composer_flags }}
 
             - run: vendor/bin/phpunit --coverage-clover coverage.xml

diff --git a/composer.json b/composer.json
@@ -25,10 +25,10 @@
     },
     "require-dev": {
         "composer-runtime-api": "^2",
-        "doctrine/dbal": "^3.2",
-        "doctrine/mongodb-odm": ">=2.0,<2.5",
-        "doctrine/orm": "^2.7",
-        "doctrine/phpcr-odm": "^1.5",
+        "doctrine/dbal": "^2.6 || ^3.0 || ^4.0",
+        "doctrine/mongodb-odm": "^2.7",
+        "doctrine/orm": "^2.7 || ^3.0",
+        "doctrine/phpcr-odm": "^1.5 || ^2.0",
         "giggsey/libphonenumber-for-php": "^8.10",
         "jackalope/jackalope-doctrine-dbal": "*",
         "moneyphp/money": "^3.2",
@@ -53,7 +53,7 @@
         }
     },
     "conflict": {
-        "doctrine/dbal": "<3.0 || >=4.0",
+        "doctrine/dbal": "<3.0 || >=5.0",
         "doctrine/orm": "<2.9"
     },
     "config": {

diff --git a/src/DBAL/DummyResult.php b/src/DBAL/DummyResult.php
@@ -7,60 +7,31 @@
 use Doctrine\DBAL\Driver\FetchUtils;
 use Doctrine\DBAL\Driver\Result;
 
-use function array_values;
+use function array_keys;
 use function count;
-use function reset;
 
 /** @internal The class is internal to the caching layer implementation. */
 final class DummyResult implements Result
 {
+    use DummyResultCompatTrait;
+
     private int $columnCount = 0;
+    /** @var string[] */
+    private array $columnNames = [];
     private int $num = 0;
 
-    /** @param mixed[] $data */
-    public function __construct(private array $data, int|null $columnCount = null)
+    /**
+     * @param mixed[] $data
+     * @param string[]|null $columnNames
+     */
+    public function __construct(private array $data, int|null $columnCount = null, array|null $columnNames = null)
     {
         if (count($data) === 0) {
             return;
         }
 
         $this->columnCount = $columnCount ?? count($data[0]);
-    }
-
-    /**
-     * {@inheritDoc}
-     */
-    public function fetchNumeric()
-    {
-        $row = $this->fetch();
-
-        if ($row === false) {
-            return false;
-        }
-
-        return array_values($row);
-    }
-
-    /**
-     * {@inheritDoc}
-     */
-    public function fetchAssociative()
-    {
-        return $this->fetch();
-    }
-
-    /**
-     * {@inheritDoc}
-     */
-    public function fetchOne()
-    {
-        $row = $this->fetch();
-
-        if ($row === false) {
-            return false;
-        }
-
-        return reset($row);
+        $this->columnNames = $columnNames ?? array_keys($data[0]); /** @phpstan-ignore-line */
     }
 
     /**
@@ -97,12 +68,17 @@ public function columnCount(): int
         return $this->columnCount;
     }
 
+    public function getColumnName(int $index): string
+    {
+        return $this->columnNames[$index] ?? '';
+    }
+
     public function free(): void
     {
         $this->data = [];
     }
 
-    private function fetch(): mixed
+    private function doFetch(): mixed
     {
         if (! isset($this->data[$this->num])) {
             return false;

diff --git a/src/DBAL/DummyResultCompatTrait.php b/src/DBAL/DummyResultCompatTrait.php
@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Refugis\DoctrineExtra\DBAL;
+
+use Composer\InstalledVersions;
+
+use function version_compare;
+
+if (version_compare((string) InstalledVersions::getVersion('doctrine/dbal'), '4.0.0', '>=')) {
+    trait DummyResultCompatTrait
+    {
+        use DummyResultCompatTraitV4;
+    }
+} else {
+    trait DummyResultCompatTrait // phpcs:ignore PSR1.Classes.ClassDeclaration.MultipleClasses
+    {
+        use DummyResultCompatTraitV2;
+    }
+}
diff --git a/src/DBAL/DummyResultCompatTraitV2.php b/src/DBAL/DummyResultCompatTraitV2.php
@@ -0,0 +1,47 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Refugis\DoctrineExtra\DBAL;
+
+use function array_values;
+use function reset;
+
+trait DummyResultCompatTraitV2
+{
+    /**
+     * {@inheritDoc}
+     */
+    public function fetchNumeric()
+    {
+        $row = $this->doFetch();
+
+        if ($row === false) {
+            return false;
+        }
+
+        return array_values($row);
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function fetchAssociative()
+    {
+        return $this->doFetch();
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function fetchOne()
+    {
+        $row = $this->doFetch();
+
+        if ($row === false) {
+            return false;
+        }
+
+        return reset($row);
+    }
+}
diff --git a/src/DBAL/DummyResultCompatTraitV4.php b/src/DBAL/DummyResultCompatTraitV4.php
@@ -0,0 +1,38 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Refugis\DoctrineExtra\DBAL;
+
+use function array_values;
+use function reset;
+
+trait DummyResultCompatTraitV4
+{
+    public function fetchNumeric(): array|false
+    {
+        $row = $this->doFetch();
+
+        if ($row === false) {
+            return false;
+        }
+
+        return array_values($row);
+    }
+
+    public function fetchAssociative(): array|false
+    {
+        return $this->doFetch();
+    }
+
+    public function fetchOne(): mixed
+    {
+        $row = $this->doFetch();
+
+        if ($row === false) {
+            return false;
+        }
+
+        return reset($row);
+    }
+}
diff --git a/src/DBAL/DummyStatement.php b/src/DBAL/DummyStatement.php
@@ -8,12 +8,9 @@
 use Doctrine\DBAL\Driver\FetchUtils;
 use Doctrine\DBAL\Driver\Result;
 use Doctrine\DBAL\Driver\Statement;
-use Doctrine\DBAL\ParameterType;
 use IteratorAggregate;
 
-use function array_values;
 use function count;
-use function reset;
 
 /**
  * Dummy statement serves a static result statement
@@ -23,6 +20,8 @@
  */
 class DummyStatement implements IteratorAggregate, Statement, Result
 {
+    use DummyStatementCompatTrait;
+
     private int $columnCount;
     private int $num;
 
@@ -52,42 +51,6 @@ public function getIterator(): ArrayIterator
         return new ArrayIterator($data);
     }
 
-    /**
-     * {@inheritDoc}
-     */
-    public function fetchNumeric()
-    {
-        $row = $this->doFetch();
-
-        if ($row === false) {
-            return false;
-        }
-
-        return array_values($row);
-    }
-
-    /**
-     * {@inheritDoc}
-     */
-    public function fetchAssociative()
-    {
-        return $this->doFetch();
-    }
-
-    /**
-     * {@inheritDoc}
-     */
-    public function fetchOne()
-    {
-        $row = $this->doFetch();
-
-        if ($row === false) {
-            return false;
-        }
-
-        return reset($row);
-    }
-
     /**
      * {@inheritDoc}
      */
@@ -117,30 +80,7 @@ public function free(): void
         $this->data = [];
     }
 
-    /**
-     * {@inheritDoc}
-     */
-    public function bindValue($param, $value, $type = ParameterType::STRING): bool
-    {
-        // TODO
-
-        return true;
-    }
-
-    /**
-     * {@inheritDoc}
-     */
-    public function bindParam($column, &$variable, $type = ParameterType::STRING, $length = null): bool
-    {
-        // TODO
-
-        return true;
-    }
-
-    /**
-     * {@inheritDoc}
-     */
-    public function execute($params = null): Result
+    public function execute(mixed $params = null): Result
     {
         return new DummyResult($this->data);
     }

diff --git a/src/DBAL/DummyStatementCompatTrait.php b/src/DBAL/DummyStatementCompatTrait.php
@@ -0,0 +1,23 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Refugis\DoctrineExtra\DBAL;
+
+use Composer\InstalledVersions;
+
+use function version_compare;
+
+if (version_compare((string) InstalledVersions::getVersion('doctrine/dbal'), '4.0.0', '>=')) {
+    trait DummyStatementCompatTrait
+    {
+        use DummyResultCompatTraitV4;
+        use DummyStatementCompatTraitV4;
+    }
+} else {
+    trait DummyStatementCompatTrait // phpcs:ignore PSR1.Classes.ClassDeclaration.MultipleClasses
+    {
+        use DummyResultCompatTraitV2;
+        use DummyStatementCompatTraitV2;
+    }
+}