Merge pull request #753 from snapshotpl/laminas-cache-v3

Support for Laminas Cache v3

Author: driehle

.github/workflows/continuous-integration.yml

@@ -24,13 +24,18 @@ jobs:
         laminas-form-version:
           - "3.0.0"
           - "2.17.0"
+        laminas-cache-version:
+          - "3.1.2"
+          - "2.13.0"
         include:
           - php-version: "7.3"
             dependencies: "lowest"
             laminas-form-version: "2.17.0"
+            laminas-cache-version: "2.13.0"
           - php-version: "7.3"
             dependencies: "lowest"
             laminas-form-version: "3.0.0"
+            laminas-cache-version: "3.1.2"
 
     steps:
       - name: "Checkout"
@@ -53,6 +58,9 @@ jobs:
         if: "startsWith(matrix.php-version, '8')"
         run: "composer require laminas/laminas-form ^${{ matrix.laminas-form-version }} --no-update --ignore-platform-req=php"
 
+      - name: "Require specific laminas-cache version"
+        run: "composer require laminas/laminas-cache ^${{ matrix.laminas-cache-version }} --no-update"
+
       - name: "Install dependencies with Composer"
         uses: "ramsey/composer-install@v1"
         if: "! startsWith(matrix.php-version, '8')"

composer.json

@@ -43,6 +43,7 @@
     },
     "require": {
         "php": "^7.3 || ~8.0.0 || ~8.1.0",
+        "container-interop/container-interop": "^1.2.0",
         "doctrine/annotations": "^1.13.2",
         "doctrine/cache": "^1.12.1",
         "doctrine/collections": "^1.6.8",
@@ -51,7 +52,7 @@
         "doctrine/inflector": "^2.0.3",
         "doctrine/persistence": "^2.2.2",
         "laminas/laminas-authentication": "^2.8.0",
-        "laminas/laminas-cache": "^2.13.0",
+        "laminas/laminas-cache": "^2.13.0 || ^3.1.2",
         "laminas/laminas-eventmanager": "^3.4.0",
         "laminas/laminas-form": "^2.17.0 || ^3.0.1",
         "laminas/laminas-modulemanager": "^2.11.0",
@@ -60,13 +61,14 @@
         "laminas/laminas-servicemanager": "^3.7.0",
         "laminas/laminas-stdlib": "^3.6.0",
         "laminas/laminas-validator": "^2.15.0",
-        "container-interop/container-interop": "^1.2.0",
         "symfony/console": "^5.3.7"
     },
     "require-dev": {
         "doctrine/coding-standard": "^9.0.0",
         "doctrine/orm": "^2.10.2",
         "jangregor/phpstan-prophecy": "^1.0.0",
+        "laminas/laminas-cache-storage-adapter-blackhole": "^1.2.1 || ^2.0.0",
+        "laminas/laminas-cache-storage-adapter-memory": "^1.0.1 || ^2.0.0",
         "laminas/laminas-i18n": "^2.11.3",
         "laminas/laminas-log": "^2.13.1",
         "laminas/laminas-mvc-console": "^1.3.0",

tests/Service/CacheFactoryTest.php

@@ -6,11 +6,17 @@
 
 use Doctrine\Common\Cache\ArrayCache;
 use Doctrine\Common\Cache\ChainCache;
+use DoctrineModule\Cache\LaminasStorageCache;
 use DoctrineModule\Service\CacheFactory;
+use Laminas\Cache\ConfigProvider;
+use Laminas\Cache\Storage\Adapter\BlackHole;
+use Laminas\Cache\Storage\AdapterPluginManager;
+use Laminas\ServiceManager\Factory\InvokableFactory;
 use Laminas\ServiceManager\ServiceManager;
 use PHPUnit\Framework\TestCase as BaseTestCase;
 
 use function assert;
+use function class_exists;
 
 /**
  * Test for {@see \DoctrineModule\Service\CacheFactory}
@@ -49,31 +55,45 @@ public function testWillSetNamespace(): void
     public function testCreateLaminasCache(): void
     {
         $factory        = new CacheFactory('phpunit');
-        $serviceManager = new ServiceManager();
-        $serviceManager->setService(
-            'config',
-            [
-                'doctrine' => [
-                    'cache' => [
-                        'phpunit' => [
-                            'class' => 'DoctrineModule\Cache\LaminasStorageCache',
-                            'instance' => 'my-laminas-cache',
-                            'namespace' => 'DoctrineModule',
-                        ],
+        $serviceManager = new ServiceManager((new ConfigProvider())->getDependencyConfig());
+        $config         = [
+            'doctrine' => [
+                'cache' => [
+                    'phpunit' => [
+                        'class' => 'DoctrineModule\Cache\LaminasStorageCache',
+                        'instance' => 'my-laminas-cache',
+                        'namespace' => 'DoctrineModule',
                     ],
                 ],
-                'caches' => [
-                    'my-laminas-cache' => [
-                        'adapter' => ['name' => 'blackhole'],
-                    ],
+            ],
+            'caches' => [
+                'my-laminas-cache' => ['adapter' => 'blackhole'],
+            ],
+        ];
+
+        if (class_exists(BlackHole\ConfigProvider::class)) {
+            // setup for laminas-cache 3 with blackhole adapter 2
+            $serviceManager->configure((new BlackHole\ConfigProvider())->getServiceDependencies());
+            $serviceManager->setService('config', $config);
+        } else {
+            // setup for laminas-cache 2 and 3 with blackhole adapter 1
+            $config['caches']['my-laminas-cache']['name'] = 'blackhole';
+            $pluginManager                                = $serviceManager->get(AdapterPluginManager::class);
+            assert($pluginManager instanceof AdapterPluginManager);
+            $pluginManager->configure([
+                'factories' => [
+                    BlackHole::class => InvokableFactory::class,
                 ],
-            ]
-        );
-        $serviceManager->addAbstractFactory('Laminas\Cache\Service\StorageCacheAbstractServiceFactory');
+                'aliases'   => [
+                    'blackhole'  => BlackHole::class,
+                ],
+            ]);
+            $serviceManager->setService('config', $config);
+        }
 
-        $cache = $factory->createService($serviceManager);
+        $cache = $factory->__invoke($serviceManager, LaminasStorageCache::class);
 
-        $this->assertInstanceOf('DoctrineModule\Cache\LaminasStorageCache', $cache);
+        $this->assertInstanceOf(LaminasStorageCache::class, $cache);
     }
 
     public function testCreatePredisCache(): void