Refactor cache management

- strip the "management" part from the name(space)
- move it into the "Converter" namespace
- refine class/method names

Author: jdreesen

docs/cached-converter.md

@@ -16,7 +16,7 @@ Maybe in our `User` example there will be a unique user ID (uuid) then your `Cac
 should be the following:
 
 ```php
-use Neusta\ConverterBundle\CacheManagement\CacheKeyFactory;
+use Neusta\ConverterBundle\Converter\Cache\CacheKeyFactory;
 
 /**
  * @implements CacheKeyFactory<User>
@@ -53,11 +53,11 @@ neusta_converter:
         key_factory: YourNamespace\UserKeyFactory
 ```
 
-This will use the  `DefaultCacheManagement`, which is offering a simple array-based cache of converted objects
+This will use the  `InMemoryCache`, which is offering a simple array-based cache of converted objects
 using the `key_factory` to determine the cache key. This allows you to implement very domain-specific identifications
 of your object conversions.
 
-> Note: You can also use a custom implementation of the `CacheManagement` interface by using the `service` 
+> Note: You can also use a custom implementation of the `Cache` interface by using the `service`
 > instead of the `key_factory` keyword.
 
 ## Why?!

src/CacheManagement/CacheManagement.php

@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Neusta\ConverterBundle\Converter\Cache;
+
+/**
+ * @template TSource of object
+ * @template TTarget of object
+ */
+interface Cache
+{
+    /**
+     * @param TSource $source
+     *
+     * @return TTarget|null
+     */
+    public function get(object $source): ?object;
+
+    /**
+     * @param TSource $source
+     * @param TTarget $target
+     */
+    public function set(object $source, object $target): void;
+}

src/CacheManagement/DefaultCacheManagement.php

@@ -3,7 +3,7 @@
 declare(strict_types=1);
 
 
-namespace Neusta\ConverterBundle\CacheManagement;
+namespace Neusta\ConverterBundle\Converter\Cache;
 
 /**
  * @template TSource of object
@@ -13,5 +13,5 @@ interface CacheKeyFactory
     /**
      * @param TSource $source
      */
-    public function createCacheKey(object $source): string;
+    public function createFor(object $source): string;
 }

src/Converter/Cache/Cache.php

@@ -0,0 +1,37 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Neusta\ConverterBundle\Converter\Cache;
+
+/**
+ * @template TSource of object
+ * @template TTarget of object
+ *
+ * @implements Cache<TSource, TTarget>
+ */
+final class InMemoryCache implements Cache
+{
+    /**
+     * @var array<string, TTarget>
+     */
+    private array $targets = [];
+
+    /**
+     * @param CacheKeyFactory<TSource> $keyFactory
+     */
+    public function __construct(
+        private CacheKeyFactory $keyFactory,
+    ) {
+    }
+
+    public function get(object $source): ?object
+    {
+        return $this->targets[$this->keyFactory->createFor($source)] ?? null;
+    }
+
+    public function set(object $source, object $target): void
+    {
+        $this->targets[$this->keyFactory->createFor($source)] = $target;
+    }
+}

src/CacheManagement/CacheKeyFactory.php src/Converter/Cache/CacheKeyFactory.phpsrc/CacheManagement/CacheKeyFactory.php renamed to src/Converter/Cache/CacheKeyFactory.php

@@ -4,7 +4,7 @@
 
 namespace Neusta\ConverterBundle\Converter;
 
-use Neusta\ConverterBundle\CacheManagement\CacheManagement;
+use Neusta\ConverterBundle\Converter\Cache\Cache;
 
 /**
  * @template TSource of object
@@ -17,11 +17,11 @@ class CachedConverter implements Converter
 {
     /**
      * @param Converter<TSource, TTarget, TContext> $inner
-     * @param CacheManagement<TSource, TTarget> $cacheManagement
+     * @param Cache<TSource, TTarget> $cache
      */
     public function __construct(
         private Converter $inner,
-        private CacheManagement $cacheManagement,
+        private Cache $cache,
     ) {
     }
 
@@ -33,13 +33,13 @@ public function __construct(
      */
     public function convert(object $source, ?object $ctx = null): object
     {
-        if ($this->cacheManagement->isInCache($source)) {
-            return $this->cacheManagement->get($source);
+        if ($target = $this->cache->get($source)) {
+            return $target;
         }
 
         $target = $this->inner->convert($source, $ctx);
 
-        $this->cacheManagement->writeInCache($target, $source);
+        $this->cache->set($source, $target);
 
         return $target;
     }

src/Converter/Cache/InMemoryCache.php

@@ -56,7 +56,7 @@ private function addConverterSection(ArrayNodeDefinition $rootNode): void
                                 ->info('Whether the result should be cached')
                                 ->children()
                                     ->scalarNode('service')
-                                        ->info('Service id to override the cache management entirely')
+                                        ->info('Service id to override the cache entirely')
                                         ->defaultNull()
                                     ->end()
                                     ->scalarNode('key_factory')

src/Converter/CachedConverter.php

@@ -4,7 +4,7 @@
 
 namespace Neusta\ConverterBundle\DependencyInjection;
 
-use Neusta\ConverterBundle\CacheManagement\DefaultCacheManagement;
+use Neusta\ConverterBundle\Converter\Cache\InMemoryCache;
 use Neusta\ConverterBundle\Converter\CachedConverter;
 use Neusta\ConverterBundle\Converter\Converter;
 use Neusta\ConverterBundle\Populator\MappedPropertyPopulator;
@@ -56,8 +56,8 @@ private function registerConverterConfiguration(string $id, array $config, Conta
             ]);
 
         if (isset($config['cached'])) {
-            if (!$cacheManagementId = $config['cached']['service'] ?? null) {
-                $container->register($cacheManagementId = "{$id}.cache_management", DefaultCacheManagement::class)
+            if (!$cacheId = $config['cached']['service'] ?? null) {
+                $container->register($cacheId = "{$id}.cache", InMemoryCache::class)
                     ->setArguments([
                         '$keyFactory' => new Reference($config['cached']['key_factory']),
                     ]);
@@ -67,7 +67,7 @@ private function registerConverterConfiguration(string $id, array $config, Conta
                 ->setDecoratedService($id)
                 ->setArguments([
                     '$inner' => new Reference('.inner'),
-                    '$cacheManagement' => new Reference($cacheManagementId),
+                    '$cache' => new Reference($cacheId),
                 ]);
         }
     }

src/DependencyInjection/Configuration.php

@@ -4,11 +4,11 @@
 
 namespace Neusta\ConverterBundle\Tests\Converter;
 
-use Neusta\ConverterBundle\CacheManagement\DefaultCacheManagement;
+use Neusta\ConverterBundle\Converter\Cache\InMemoryCache;
 use Neusta\ConverterBundle\Converter\Converter;
 use Neusta\ConverterBundle\Converter\CachedConverter;
 use Neusta\ConverterBundle\Converter\DefaultConverter;
-use Neusta\ConverterBundle\Tests\Fixtures\CacheManagement\UserKeyFactory;
+use Neusta\ConverterBundle\Tests\Fixtures\Converter\Cache\UserKeyFactory;
 use Neusta\ConverterBundle\Tests\Fixtures\Factory\PersonFactory;
 use Neusta\ConverterBundle\Tests\Fixtures\Model\Person;
 use Neusta\ConverterBundle\Tests\Fixtures\Model\User;
@@ -29,7 +29,7 @@ protected function setUp(): void
                     new PersonNamePopulator()
                 ]
             ),
-            new DefaultCacheManagement(new UserKeyFactory())
+            new InMemoryCache(new UserKeyFactory())
         );
     }