Introduce CacheAwareContext

Author: jdreesen

src/Converter/Cache/Cache.php

@@ -7,7 +7,7 @@
 /**
  * @template TSource of object
  * @template TTarget of object
- * @template TContext of object|null
+ * @template TContext of CacheAwareContext|null
  */
 interface Cache
 {
@@ -17,12 +17,12 @@ interface Cache
      *
      * @return TTarget|null
      */
-    public function get(object $source, ?object $ctx = null): ?object;
+    public function get(object $source, ?CacheAwareContext $ctx = null): ?object;
 
     /**
      * @param TSource $source
      * @param TTarget $target
      * @param TContext $ctx
      */
-    public function set(object $source, object $target, ?object $ctx = null): void;
+    public function set(object $source, object $target, ?CacheAwareContext $ctx = null): void;
 }

src/Converter/Cache/CacheAwareContext.php

@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Neusta\ConverterBundle\Converter\Cache;
+
+interface CacheAwareContext
+{
+    /**
+     * @return non-empty-string
+     */
+    public function getHash(): string;
+}

src/Converter/Cache/CacheKeyFactory.php

@@ -7,15 +7,13 @@
 
 /**
  * @template TSource of object
- * @template TContext of object|null
  */
 interface CacheKeyFactory
 {
     /**
      * @param TSource $source
-     * @param TContext $ctx
      *
      * @return non-empty-string
      */
-    public function createFor(object $source, ?object $ctx = null): string;
+    public function createFor(object $source): string;
 }

src/Converter/Cache/InMemoryCache.php

@@ -7,7 +7,7 @@
 /**
  * @template TSource of object
  * @template TTarget of object
- * @template TContext of object|null
+ * @template TContext of CacheAwareContext|null
  *
  * @implements Cache<TSource, TTarget, TContext>
  */
@@ -19,20 +19,28 @@ final class InMemoryCache implements Cache
     private array $targets = [];
 
     /**
-     * @param CacheKeyFactory<TSource, TContext> $keyFactory
+     * @param CacheKeyFactory<TSource> $keyFactory
      */
     public function __construct(
         private CacheKeyFactory $keyFactory,
     ) {
     }
 
-    public function get(object $source, ?object $ctx = null): ?object
+    public function get(object $source, ?CacheAwareContext $ctx = null): ?object
     {
-        return $this->targets[$this->keyFactory->createFor($source, $ctx)] ?? null;
+        return $this->targets[$this->createKey($source, $ctx)] ?? null;
     }
 
-    public function set(object $source, object $target, ?object $ctx = null): void
+    public function set(object $source, object $target, ?CacheAwareContext $ctx = null): void
     {
-        $this->targets[$this->keyFactory->createFor($source, $ctx)] = $target;
+        $this->targets[$this->createKey($source, $ctx)] = $target;
+    }
+
+    /**
+     * @param TSource $source
+     */
+    private function createKey(object $source, ?CacheAwareContext $ctx = null): string
+    {
+        return $this->keyFactory->createFor($source) . $ctx?->getHash();
     }
 }

src/Converter/CachedConverter.php

@@ -5,12 +5,13 @@
 namespace Neusta\ConverterBundle\Converter;
 
 use Neusta\ConverterBundle\Converter\Cache\Cache;
+use Neusta\ConverterBundle\Converter\Cache\CacheAwareContext;
 use Neusta\ConverterBundle\Converter;
 
 /**
  * @template TSource of object
  * @template TTarget of object
- * @template TContext of object|null
+ * @template TContext of CacheAwareContext|null
  *
  * @implements Converter<TSource, TTarget, TContext>
  */

src/Converter/Context/GenericContext.php

@@ -4,7 +4,9 @@
 
 namespace Neusta\ConverterBundle\Converter\Context;
 
-class GenericContext
+use Neusta\ConverterBundle\Converter\Cache\CacheAwareContext;
+
+class GenericContext implements CacheAwareContext
 {
     /** @var array<string, mixed> */
     protected array $values;

tests/Fixtures/Converter/Cache/UserKeyFactory.php

@@ -5,16 +5,15 @@
 namespace Neusta\ConverterBundle\Tests\Fixtures\Converter\Cache;
 
 use Neusta\ConverterBundle\Converter\Cache\CacheKeyFactory;
-use Neusta\ConverterBundle\Converter\DefaultConverterContext;
 use Neusta\ConverterBundle\Tests\Fixtures\Model\User;
 
 /**
- * @implements CacheKeyFactory<User, DefaultConverterContext>
+ * @implements CacheKeyFactory<User>
  */
 class UserKeyFactory implements CacheKeyFactory
 {
-    public function createFor(object $source, ?object $ctx = null): string
+    public function createFor(object $source): string
     {
-        return $source->getUuid() . $ctx?->getHash();
+        return (string) $source->getUuid();
     }
 }