Refactor cache management

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

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/Converter/Cache/Cache.php

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

src/CacheManagement/CacheKeyFactory.php → src/Converter/Cache/CacheKeyFactory.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/InMemoryCache.php

@@ -0,0 +1,42 @@
+<?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 contains(object $source): bool
+    {
+        return isset($this->targets[$this->keyFactory->createFor($source)]);
+    }
+
+    public function fetch(object $source): object
+    {
+        return $this->targets[$this->keyFactory->createFor($source)];
+    }
+
+    public function save(object $source, object $target): void
+    {
+        $this->targets[$this->keyFactory->createFor($source)] = $target;
+    }
+}

src/Converter/CachedConverter.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 ($this->cache->contains($source)) {
+            return $this->cache->fetch($source);
         }
 
         $target = $this->inner->convert($source, $ctx);
 
-        $this->cacheManagement->writeInCache($target, $source);
+        $this->cache->save($source, $target);
 
         return $target;
     }

src/DependencyInjection/Configuration.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/DependencyInjection/NeustaConverterExtension.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,11 +56,11 @@ private function registerConverterConfiguration(string $id, array $config, Conta
             ]);
 
         if (isset($config['cached'])) {
-            $cacheManagementId = "{$id}.cache_management";
+            $cacheId = "{$id}.cache";
             if ($config['cached']['service']) {
-                $container->setAlias($cacheManagementId, $config['cached']['service']);
+                $container->setAlias($cacheId, $config['cached']['service']);
             } else {
-                $container->register($cacheManagementId, DefaultCacheManagement::class)
+                $container->register($cacheId, InMemoryCache::class)
                     ->setArguments([
                         '$keyFactory' => new Reference($config['cached']['key_factory']),
                     ]);
@@ -70,7 +70,7 @@ private function registerConverterConfiguration(string $id, array $config, Conta
                 ->setDecoratedService($id)
                 ->setArguments([
                     '$inner' => new Reference('.inner'),
-                    '$cacheManagement' => new Reference($cacheManagementId),
+                    '$cache' => new Reference($cacheId),
                 ]);
         }
     }

tests/Converter/CachedConverterTest.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())
         );
     }
 

tests/DependencyInjection/NeustaConverterExtensionTest.php

@@ -4,14 +4,14 @@
 
 namespace Neusta\ConverterBundle\Tests\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\Converter\DefaultConverter;
 use Neusta\ConverterBundle\DependencyInjection\NeustaConverterExtension;
 use Neusta\ConverterBundle\NeustaConverterBundle;
 use Neusta\ConverterBundle\Populator\MappedPropertyPopulator;
-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\Populator\PersonNamePopulator;
 use PHPUnit\Framework\TestCase;
@@ -117,12 +117,12 @@ public function test_with_default_cached_converter(): void
         self::assertSame(CachedConverter::class, $cachedConverter->getClass());
         self::assertSame('foobar', $cachedConverter->getDecoratedService()[0]);
         self::assertIsReference('.inner', $cachedConverter->getArgument('$inner'));
-        self::assertIsReference('foobar.cache_management', $cachedConverter->getArgument('$cacheManagement'));
+        self::assertIsReference('foobar.cache', $cachedConverter->getArgument('$cache'));
 
-        // cache management
-        $cacheManagement = $container->getDefinition('foobar.cache_management');
-        self::assertSame(DefaultCacheManagement::class, $cacheManagement->getClass());
-        self::assertIsReference(UserKeyFactory::class, $cacheManagement->getArgument('$keyFactory'));
+        // cache
+        $cache = $container->getDefinition('foobar.cache');
+        self::assertSame(InMemoryCache::class, $cache->getClass());
+        self::assertIsReference(UserKeyFactory::class, $cache->getArgument('$keyFactory'));
     }
 
     public function test_with_cache_with_service_and_key_factory_defined(): void
@@ -138,7 +138,7 @@ public function test_with_cache_with_service_and_key_factory_defined(): void
                         PersonNamePopulator::class,
                     ],
                     'cached' => [
-                        'service' => DefaultCacheManagement::class,
+                        'service' => InMemoryCache::class,
                         'key_factory' => UserKeyFactory::class,
                     ],
                 ],

tests/Fixtures/CacheManagement/UserKeyFactory.php → tests/Fixtures/Converter/Cache/UserKeyFactory.php

@@ -2,17 +2,17 @@
 
 declare(strict_types=1);
 
-namespace Neusta\ConverterBundle\Tests\Fixtures\CacheManagement;
+namespace Neusta\ConverterBundle\Tests\Fixtures\Converter\Cache;
 
-use Neusta\ConverterBundle\CacheManagement\CacheKeyFactory;
+use Neusta\ConverterBundle\Converter\Cache\CacheKeyFactory;
 use Neusta\ConverterBundle\Tests\Fixtures\Model\User;
 
 /**
  * @implements CacheKeyFactory<User>
  */
 class UserKeyFactory implements CacheKeyFactory
 {
-    public function createCacheKey(object $source): string
+    public function createFor(object $source): string
     {
         return (string) $source->getUuid();
     }

tests/app/config/packages/neusta_converter.yaml

@@ -15,5 +15,5 @@ neusta_converter:
       populators:
         - Neusta\ConverterBundle\Tests\Fixtures\Populator\PersonNamePopulator
       cached:
-#        service: user.cache_management
-        key_factory: Neusta\ConverterBundle\Tests\Fixtures\CacheManagement\UserKeyFactory
+#        service: user.cache
+        key_factory: Neusta\ConverterBundle\Tests\Fixtures\Converter\Cache\UserKeyFactory

tests/app/config/services.yaml

@@ -51,9 +51,9 @@ services:
     Neusta\ConverterBundle\Tests\Fixtures\Factory\PersonFactory: ~
     Neusta\ConverterBundle\Tests\Fixtures\Factory\AddressFactory: ~
 
-    Neusta\ConverterBundle\Tests\Fixtures\CacheManagement\UserKeyFactory: ~
+    Neusta\ConverterBundle\Tests\Fixtures\Converter\Cache\UserKeyFactory: ~
 
-    user.cache_management:
-        class: Neusta\ConverterBundle\CacheManagement\DefaultCacheManagement
+    user.cache:
+        class: Neusta\ConverterBundle\Converter\Cache\InMemoryCache
         arguments:
-            $keyFactory: '@Neusta\ConverterBundle\Tests\Fixtures\CacheManagement\UserKeyFactory'
+            $keyFactory: '@Neusta\ConverterBundle\Tests\Fixtures\Converter\Cache\UserKeyFactory'