refactor: Simplify object caching.

rekalogika · Jan 13, 2024 · b0e94d1 · b0e94d1
1 parent 5e32e6a
commit b0e94d1
Show file tree

Hide file tree

Showing 8 changed files with 33 additions and 68 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -9,6 +9,7 @@
 * refactor: Move `MainTransformer` to its own namespace.
 * refactor: Refactor exception.
 * feat: Add attribute matching.
+* refactor: Simplify object caching.
 
 ## 0.5.4
 

diff --git a/config/services.php b/config/services.php
@@ -101,7 +101,6 @@
         ->set('rekalogika.mapper.method_mapper.transformer', ClassMethodTransformer::class)
         ->args([
             service('rekalogika.mapper.method_mapper.sub_mapper'),
-            service('rekalogika.mapper.object_cache_factory'),
         ])
         ->tag('rekalogika.mapper.transformer', ['priority' => -600]);
 
@@ -111,16 +110,10 @@
 
     $services
         ->set('rekalogika.mapper.transformer.traversable_to_arrayaccess', TraversableToArrayAccessTransformer::class)
-        ->args([
-            '$objectCacheFactory' => service('rekalogika.mapper.object_cache_factory'),
-        ])
         ->tag('rekalogika.mapper.transformer', ['priority' => -700]);
 
     $services
         ->set('rekalogika.mapper.transformer.traversable_to_traversable', TraversableToTraversableTransformer::class)
-        ->args([
-            '$objectCacheFactory' => service('rekalogika.mapper.object_cache_factory'),
-        ])
         ->tag('rekalogika.mapper.transformer', ['priority' => -750]);
 
     $services
@@ -142,7 +135,6 @@
             '$propertyAccessExtractor' => service('rekalogika.mapper.property_info'),
             '$propertyAccessor' => service('property_accessor'),
             '$typeResolver' => service('rekalogika.mapper.type_resolver'),
-            '$objectCacheFactory' => service('rekalogika.mapper.object_cache_factory'),
         ])
         ->tag('rekalogika.mapper.transformer', ['priority' => -900]);
 

diff --git a/src/MainTransformer/MainTransformer.php b/src/MainTransformer/MainTransformer.php
@@ -16,6 +16,7 @@
 use Rekalogika\Mapper\Exception\LogicException;
 use Rekalogika\Mapper\MainTransformer\Exception\CannotFindTransformerException;
 use Rekalogika\Mapper\MainTransformer\Exception\TransformerReturnsUnexpectedValueException;
+use Rekalogika\Mapper\ObjectCache\Exception\CachedTargetObjectNotFoundException;
 use Rekalogika\Mapper\ObjectCache\ObjectCache;
 use Rekalogika\Mapper\ObjectCache\ObjectCacheFactoryInterface;
 use Rekalogika\Mapper\Transformer\Contracts\MainTransformerAwareInterface;
@@ -52,9 +53,13 @@ private function processTransformer(
      */
     public static function getObjectCache(
         array &$context,
-        ObjectCacheFactoryInterface $objectCacheFactory
+        null|ObjectCacheFactoryInterface $objectCacheFactory = null,
     ): ObjectCache {
         if (!isset($context[self::OBJECT_CACHE])) {
+            if ($objectCacheFactory === null) {
+                throw new LogicException('Object cache factory must not be null.');
+            }
+
             $objectCache = $objectCacheFactory->createObjectCache();
             $context[self::OBJECT_CACHE] = $objectCache;
         } else {
@@ -135,14 +140,31 @@ public function transform(
         // loop over the result and transform the source to the target
 
         foreach ($searchResult as $searchEntry) {
+            // inject the main transformer to the transformer if it is
+            // MainTransformerAwareInterface
             $transformer = $this->processTransformer($searchEntry->getTransformer());
 
+            // TransformerInterface doesn't accept MixedType, so we need to
+            // convert it to null
+
             $sourceType = $searchEntry->getSourceType();
             $sourceTypeForTransformer = $sourceType instanceof MixedType ? null : $sourceType;
 
             $targetType = $searchEntry->getTargetType();
             $targetTypeForTransformer = $targetType instanceof MixedType ? null : $targetType;
 
+            // if the target type is cached, return it. otherwise, pre-cache it
+
+            if ($targetTypeForTransformer !== null) {
+                try {
+                    return $objectCache->getTarget($source, $targetTypeForTransformer);
+                } catch (CachedTargetObjectNotFoundException) {
+                    $objectCache->preCache($source, $targetTypeForTransformer);
+                }
+            }
+
+            // transform the source to the target
+
             /** @var mixed */
             $result = $transformer->transform(
                 source: $source,

diff --git a/src/MapperFactory/MapperFactory.php b/src/MapperFactory/MapperFactory.php
@@ -274,7 +274,6 @@ protected function getObjectToObjectTransformer(): TransformerInterface
                 $this->getPropertyAccessExtractor(),
                 $this->getPropertyAccessor(),
                 $this->getTypeResolver(),
-                $this->getObjectCacheFactory(),
             );
         }
 
@@ -343,9 +342,7 @@ protected function getTraversableToArrayAccessTransformer(): TransformerInterfac
     {
         if (null === $this->traversableToArrayAccessTransformer) {
             $this->traversableToArrayAccessTransformer =
-                new TraversableToArrayAccessTransformer(
-                    $this->getObjectCacheFactory()
-                );
+                new TraversableToArrayAccessTransformer();
         }
 
         return $this->traversableToArrayAccessTransformer;
@@ -355,9 +352,7 @@ protected function getTraversableToTraversableTransformer(): TransformerInterfac
     {
         if (null === $this->traversableToTraversableTransformer) {
             $this->traversableToTraversableTransformer =
-                new TraversableToTraversableTransformer(
-                    $this->getObjectCacheFactory()
-                );
+                new TraversableToTraversableTransformer();
         }
 
         return $this->traversableToTraversableTransformer;

diff --git a/src/MethodMapper/ClassMethodTransformer.php b/src/MethodMapper/ClassMethodTransformer.php
@@ -15,7 +15,6 @@
 
 use Rekalogika\Mapper\Exception\InvalidArgumentException;
 use Rekalogika\Mapper\MainTransformer\MainTransformer;
-use Rekalogika\Mapper\ObjectCache\ObjectCacheFactoryInterface;
 use Rekalogika\Mapper\Transformer\Contracts\MainTransformerAwareInterface;
 use Rekalogika\Mapper\Transformer\Contracts\MainTransformerAwareTrait;
 use Rekalogika\Mapper\Transformer\Contracts\TransformerInterface;
@@ -31,7 +30,6 @@ final class ClassMethodTransformer implements
 
     public function __construct(
         private SubMapper $subMapper,
-        private ObjectCacheFactoryInterface $objectCacheFactory,
     ) {
     }
 
@@ -88,7 +86,7 @@ public function transform(
 
         // get object cache
 
-        $objectCache = MainTransformer::getObjectCache($context, $this->objectCacheFactory);
+        $objectCache = MainTransformer::getObjectCache($context);
 
         // save to object cache
 

diff --git a/src/Transformer/ObjectToObjectTransformer.php b/src/Transformer/ObjectToObjectTransformer.php
@@ -15,8 +15,6 @@
 
 use Rekalogika\Mapper\Exception\InvalidArgumentException;
 use Rekalogika\Mapper\MainTransformer\MainTransformer;
-use Rekalogika\Mapper\ObjectCache\Exception\CachedTargetObjectNotFoundException;
-use Rekalogika\Mapper\ObjectCache\ObjectCacheFactoryInterface;
 use Rekalogika\Mapper\Transformer\Contracts\MainTransformerAwareInterface;
 use Rekalogika\Mapper\Transformer\Contracts\MainTransformerAwareTrait;
 use Rekalogika\Mapper\Transformer\Contracts\TransformerInterface;
@@ -47,7 +45,6 @@ public function __construct(
         private PropertyAccessExtractorInterface $propertyAccessExtractor,
         private PropertyAccessorInterface $propertyAccessor,
         private TypeResolverInterface $typeResolver,
-        private ObjectCacheFactoryInterface $objectCacheFactory,
     ) {
     }
 
@@ -62,17 +59,6 @@ public function transform(
             throw new InvalidArgumentException('Target type must not be null.');
         }
 
-        // get object cache
-
-        $objectCache = MainTransformer::getObjectCache($context, $this->objectCacheFactory);
-
-        // return from cache if already exists
-
-        try {
-            return $objectCache->getTarget($source, $targetType);
-        } catch (CachedTargetObjectNotFoundException) {
-        }
-
         // get source object & class
 
         if (!is_object($source)) {
@@ -93,17 +79,19 @@ public function transform(
             return $source;
         }
 
-        // initialize target, add to cache after initialization
+        // initialize target
 
         if (null === $target) {
-            $objectCache->preCache($source, $targetType);
             $target = $this->instantiateTarget($source, $targetType, $context);
         } else {
             if (!is_object($target)) {
                 throw new InvalidArgumentException(sprintf('The target must be an object, "%s" given.', get_debug_type($target)));
             }
         }
 
+        // save object to cache
+
+        $objectCache = MainTransformer::getObjectCache($context);
         $objectCache->saveTarget($source, $targetType, $target);
 
         // list properties

diff --git a/src/Transformer/TraversableToArrayAccessTransformer.php b/src/Transformer/TraversableToArrayAccessTransformer.php
@@ -17,8 +17,6 @@
 use Doctrine\Common\Collections\Collection;
 use Rekalogika\Mapper\Exception\InvalidArgumentException;
 use Rekalogika\Mapper\MainTransformer\MainTransformer;
-use Rekalogika\Mapper\ObjectCache\Exception\CachedTargetObjectNotFoundException;
-use Rekalogika\Mapper\ObjectCache\ObjectCacheFactoryInterface;
 use Rekalogika\Mapper\Transformer\Contracts\MainTransformerAwareInterface;
 use Rekalogika\Mapper\Transformer\Contracts\MainTransformerAwareTrait;
 use Rekalogika\Mapper\Transformer\Contracts\TransformerInterface;
@@ -34,11 +32,6 @@ final class TraversableToArrayAccessTransformer implements TransformerInterface,
 {
     use MainTransformerAwareTrait;
 
-    public function __construct(
-        private ObjectCacheFactoryInterface $objectCacheFactory,
-    ) {
-    }
-
     public function transform(
         mixed $source,
         mixed $target,
@@ -52,14 +45,7 @@ public function transform(
 
         // get object cache
 
-        $objectCache = MainTransformer::getObjectCache($context, $this->objectCacheFactory);
-
-        // return from cache if already exists
-
-        try {
-            return $objectCache->getTarget($source, $targetType);
-        } catch (CachedTargetObjectNotFoundException) {
-        }
+        $objectCache = MainTransformer::getObjectCache($context);
 
         // The source must be a Traversable or an array (a.k.a. iterable).
 
@@ -76,7 +62,6 @@ public function transform(
         // If the target is not provided, instantiate it, and add to cache.
 
         if ($target === null) {
-            $objectCache->preCache($source, $targetType);
             $target = $this->instantiateArrayAccessOrArray($targetType);
         }
 

diff --git a/src/Transformer/TraversableToTraversableTransformer.php b/src/Transformer/TraversableToTraversableTransformer.php
@@ -15,8 +15,6 @@
 
 use Rekalogika\Mapper\Exception\InvalidArgumentException;
 use Rekalogika\Mapper\MainTransformer\MainTransformer;
-use Rekalogika\Mapper\ObjectCache\Exception\CachedTargetObjectNotFoundException;
-use Rekalogika\Mapper\ObjectCache\ObjectCacheFactoryInterface;
 use Rekalogika\Mapper\Transformer\Contracts\MainTransformerAwareInterface;
 use Rekalogika\Mapper\Transformer\Contracts\MainTransformerAwareTrait;
 use Rekalogika\Mapper\Transformer\Contracts\TransformerInterface;
@@ -32,11 +30,6 @@ final class TraversableToTraversableTransformer implements TransformerInterface,
 {
     use MainTransformerAwareTrait;
 
-    public function __construct(
-        private ObjectCacheFactoryInterface $objectCacheFactory,
-    ) {
-    }
-
     public function transform(
         mixed $source,
         mixed $target,
@@ -49,14 +42,7 @@ public function transform(
         }
         // get object cache
 
-        $objectCache = MainTransformer::getObjectCache($context, $this->objectCacheFactory);
-
-        // return from cache if already exists
-
-        try {
-            return $objectCache->getTarget($source, $targetType);
-        } catch (CachedTargetObjectNotFoundException) {
-        }
+        $objectCache = MainTransformer::getObjectCache($context);
 
         // The source must be a Traversable or an array (a.k.a. iterable).
 
@@ -88,8 +74,6 @@ public function transform(
 
         // create generator
 
-        $objectCache->preCache($source, $targetType);
-
         $target = (function () use (
             $source,
             $targetMemberKeyTypeIsInt,