Allow installing doctrine/cache 2.0 (#2226)

* Allow installing doctrine/cache 2.0
* Make doctrine/cache a dev dependency

Author: alcaeus

composer.json

@@ -36,8 +36,7 @@
     "require": {
         "php": "^7.2 || ^8.0",
         "behat/transliterator": "~1.2",
-        "doctrine/annotations": "^1.2",
-        "doctrine/cache": "^1.0",
+        "doctrine/annotations": "^1.13",
         "doctrine/collections": "^1.0",
         "doctrine/common": "^2.13 || ^3.0",
         "doctrine/event-manager": "^1.0"
@@ -47,11 +46,13 @@
     },
     "require-dev": {
         "alcaeus/mongo-php-adapter": "^1.1",
+        "doctrine/cache": "^1.11 || ^2.0",
         "doctrine/doctrine-bundle": "^2.3",
         "doctrine/mongodb-odm": "^2.0",
         "doctrine/orm": "^2.6.3",
         "friendsofphp/php-cs-fixer": "^2.16",
         "phpunit/phpunit": "^8.5",
+        "symfony/cache": "^4.4 || ^5.0",
         "symfony/yaml": "^4.1"
     },
     "conflict": {
@@ -61,7 +62,8 @@
     },
     "suggest": {
         "doctrine/mongodb-odm": "to use the extensions with the MongoDB ODM",
-        "doctrine/orm": "to use the extensions with the ORM"
+        "doctrine/orm": "to use the extensions with the ORM",
+        "symfony/cache": "to cache parsed annotations"
     },
     "config": {
         "bin-dir": "bin",

src/DoctrineExtensions.php

@@ -4,12 +4,15 @@
 
 use Doctrine\Common\Annotations\AnnotationReader;
 use Doctrine\Common\Annotations\AnnotationRegistry;
-use Doctrine\Common\Annotations\CachedReader;
+use Doctrine\Common\Annotations\PsrCachedReader;
 use Doctrine\Common\Annotations\Reader;
 use Doctrine\Common\Cache\ArrayCache;
+use Doctrine\Common\Cache\Psr6\CacheAdapter;
 use Doctrine\ODM\MongoDB\Mapping\Driver as DriverMongodbODM;
 use Doctrine\ORM\Mapping\Driver as DriverORM;
 use Doctrine\Persistence\Mapping\Driver\MappingDriverChain;
+use Symfony\Component\Cache\Adapter\ArrayAdapter;
+use function class_exists;
 
 /**
  * Version class allows to checking the dependencies required
@@ -33,7 +36,7 @@ public static function registerMappingIntoDriverChainORM(MappingDriverChain $dri
     {
         self::registerAnnotations();
         if (!$reader) {
-            $reader = new CachedReader(new AnnotationReader(), new ArrayCache());
+            $reader = self::createAnnotationReader();
         }
         $annotationDriver = new DriverORM\AnnotationDriver($reader, [
             __DIR__.'/Translatable/Entity',
@@ -51,7 +54,7 @@ public static function registerAbstractMappingIntoDriverChainORM(MappingDriverCh
     {
         self::registerAnnotations();
         if (!$reader) {
-            $reader = new CachedReader(new AnnotationReader(), new ArrayCache());
+            $reader = self::createAnnotationReader();
         }
         $annotationDriver = new DriverORM\AnnotationDriver($reader, [
             __DIR__.'/Translatable/Entity/MappedSuperclass',
@@ -69,7 +72,7 @@ public static function registerMappingIntoDriverChainMongodbODM(MappingDriverCha
     {
         self::registerAnnotations();
         if (!$reader) {
-            $reader = new CachedReader(new AnnotationReader(), new ArrayCache());
+            $reader = self::createAnnotationReader();
         }
         $annotationDriver = new DriverMongodbODM\AnnotationDriver($reader, [
             __DIR__.'/Translatable/Document',
@@ -86,7 +89,7 @@ public static function registerAbstractMappingIntoDriverChainMongodbODM(MappingD
     {
         self::registerAnnotations();
         if (!$reader) {
-            $reader = new CachedReader(new AnnotationReader(), new ArrayCache());
+            $reader = self::createAnnotationReader();
         }
         $annotationDriver = new DriverMongodbODM\AnnotationDriver($reader, [
             __DIR__.'/Translatable/Document/MappedSuperclass',
@@ -102,4 +105,17 @@ public static function registerAnnotations()
     {
         AnnotationRegistry::registerFile(__DIR__.'/Mapping/Annotation/All.php');
     }
+
+    private static function createAnnotationReader()
+    {
+        $reader = new AnnotationReader();
+
+        if (class_exists(ArrayAdapter::class)) {
+            $reader = new PsrCachedReader($reader, new ArrayAdapter());
+        } elseif (class_exists(ArrayCache::class)) {
+            $reader = new PsrCachedReader($reader, CacheAdapter::wrap(new ArrayCache()));
+        }
+
+        return $reader;
+    }
 }

src/Mapping/MappedEventSubscriber.php

@@ -4,13 +4,16 @@
 
 use Doctrine\Common\Annotations\AnnotationReader;
 use Doctrine\Common\Annotations\AnnotationRegistry;
-use Doctrine\Common\Annotations\CachedReader;
+use Doctrine\Common\Annotations\PsrCachedReader;
 use Doctrine\Common\Annotations\Reader;
 use Doctrine\Common\Cache\ArrayCache;
+use Doctrine\Common\Cache\Psr6\CacheAdapter;
 use Doctrine\Common\EventArgs;
 use Doctrine\Common\EventSubscriber;
 use Doctrine\Persistence\ObjectManager;
 use Gedmo\Mapping\Event\AdapterInterface;
+use Symfony\Component\Cache\Adapter\ArrayAdapter;
+use function class_exists;
 
 /**
  * This is extension of event subscriber class and is
@@ -224,7 +227,13 @@ private function getDefaultAnnotationReader()
         if (null === self::$defaultAnnotationReader) {
             AnnotationRegistry::registerAutoloadNamespace('Gedmo\\Mapping\\Annotation', __DIR__.'/../../');
 
-            $reader = new CachedReader(new AnnotationReader(), new ArrayCache());
+            $reader = new AnnotationReader();
+
+            if (class_exists(ArrayAdapter::class)) {
+                $reader = new PsrCachedReader($reader, new ArrayAdapter());
+            } else if (class_exists(ArrayCache::class)) {
+                $reader = new PsrCachedReader($reader, CacheAdapter::wrap(new ArrayCache()));
+            }
 
             self::$defaultAnnotationReader = $reader;
         }

tests/Gedmo/SoftDeleteable/SoftDeleteableEntityTest.php

@@ -14,6 +14,7 @@
 use SoftDeleteable\Fixture\Entity\User;
 use SoftDeleteable\Fixture\Entity\UserNoHardDelete;
 use Tool\BaseTestCaseORM;
+use function class_exists;
 
 /**
  * These are tests for SoftDeleteable behavior
@@ -483,6 +484,10 @@ public function testSoftDeleteableFilter()
      */
     public function shouldFilterBeQueryCachedCorrectlyWhenToggledForEntity()
     {
+        if (!class_exists(ArrayCache::class)) {
+            $this->markTestSkipped('Test only applies when doctrine/cache 1.x is installed');
+        }
+
         $cache = new ArrayCache();
         $this->em->getConfiguration()->setQueryCacheImpl($cache);
 

tests/bootstrap.php

@@ -3,8 +3,8 @@
 use Composer\Autoload\ClassLoader;
 use Doctrine\Common\Annotations\AnnotationReader;
 use Doctrine\Common\Annotations\AnnotationRegistry;
-use Doctrine\Common\Annotations\CachedReader;
-use Doctrine\Common\Cache\ArrayCache;
+use Doctrine\Common\Annotations\PsrCachedReader;
+use Symfony\Component\Cache\Adapter\ArrayAdapter;
 
 /*
  * This is bootstrap for phpUnit unit tests,
@@ -48,5 +48,5 @@
 Gedmo\DoctrineExtensions::registerAnnotations();
 
 $reader = new AnnotationReader();
-$reader = new CachedReader($reader, new ArrayCache());
+$reader = new PsrCachedReader($reader, new ArrayAdapter());
 $_ENV['annotation_reader'] = $reader;