Merge pull request #3 from moufmouf/classBoundMemoryAdapter

Adding a ClassBoundMemoryAdapter

Author: moufmouf

README.md

@@ -37,13 +37,13 @@ $fileBoundCache->set('cache_key', $myDataToCache,
 $myDataToCache = $fileBoundCache->get('cache_key');
 ```
 
-You can also use the `MemoryAdapter` to store the cache in memory for even faster access in the same query.
+You can also use the `FileBoundMemoryAdapter` to store the cache in memory for even faster access in the same query.
 
 ```php
 use TheCodingMachine\CacheUtils\FileBoundCache;
-use TheCodingMachine\CacheUtils\MemoryAdapter;
+use TheCodingMachine\CacheUtils\FileBoundMemoryAdapter;
 
-$fileBoundCache = new MemoryAdapter(new FileBoundCache($psr16Cache));
+$fileBoundCache = new FileBoundMemoryAdapter(new FileBoundCache($psr16Cache));
 ```
 
 ### Class bound cache
@@ -79,3 +79,12 @@ class ClassBoundCache implements ClassBoundCacheInterface
 - `$analyzeParentClasses`: if set to true, the cache will be invalidated if one of the parent classes is modified
 - `$analyzeTraits`: if set to true, the cache will be invalidated if one of the traits is modified
 - `$analyzeInterfaces`: if set to true, the cache will be invalidated if one of the interfaces implemented is modified
+
+You can also use the `ClassBoundMemoryAdapter` to store the cache in memory for even faster access in the same query.
+
+```php
+use TheCodingMachine\CacheUtils\ClassBoundCache;
+use TheCodingMachine\CacheUtils\ClassBoundMemoryAdapter;
+
+$classBoundCache = new ClassBoundMemoryAdapter(new ClassBoundCache($psr16Cache));
+```

src/ClassBoundMemoryAdapter.php

@@ -0,0 +1,49 @@
+<?php
+
+declare(strict_types=1);
+
+namespace TheCodingMachine\CacheUtils;
+
+use ReflectionClass;
+
+/**
+ * An adapter around a FileBoundCacheInterface that stores values in memory for the current request (for maximum performance)
+ */
+class ClassBoundMemoryAdapter implements ClassBoundCacheInterface
+{
+    /** @var array<string, mixed> */
+    private $items;
+    /** @var ClassBoundCacheInterface */
+    private $classBoundCache;
+
+    public function __construct(ClassBoundCacheInterface $classBoundCache)
+    {
+        $this->classBoundCache = $classBoundCache;
+    }
+
+    /**
+     * Fetches an element from the cache by key.
+     *
+     * @return mixed
+     */
+    public function get(string $key)
+    {
+        if (isset($this->items[$key])) {
+            return $this->items[$key];
+        }
+
+        return $this->items[$key] = $this->classBoundCache->get($key);
+    }
+
+    /**
+     * Stores an item in the cache.
+     *
+     * @param mixed $item The item must be serializable.
+     * @param ReflectionClass $refClass If the class is modified, the cache item is invalidated.
+     */
+    public function set(string $key, $item, ReflectionClass $refClass, ?int $ttl = null): void
+    {
+        $this->items[$key] = $item;
+        $this->classBoundCache->set($key, $item, $refClass, $ttl);
+    }
+}

src/MemoryAdapter.php src/FileBoundMemoryAdapter.phpsrc/MemoryAdapter.php renamed to src/FileBoundMemoryAdapter.php

@@ -7,7 +7,7 @@
 /**
  * An adapter around a FileBoundCacheInterface that stores values in memory for the current request (for maximum performance)
  */
-class MemoryAdapter implements FileBoundCacheInterface
+class FileBoundMemoryAdapter implements FileBoundCacheInterface
 {
     /** @var array<string, mixed> */
     private $items;

tests/ClassBoundMemoryAdapterTest.php

@@ -0,0 +1,44 @@
+<?php
+
+namespace TheCodingMachine\CacheUtils;
+
+use function clearstatcache;
+use function file_get_contents;
+use function file_put_contents;
+use ReflectionClass;
+use function sleep;
+use function str_replace;
+use Symfony\Component\Cache\Simple\ArrayCache;
+use function sys_get_temp_dir;
+use PHPUnit\Framework\TestCase;
+use TheCodingMachine\CacheUtils\Fixtures\A;
+use function touch;
+
+class ClassBoundMemoryAdapterTest extends TestCase
+{
+    public function testMemory()
+    {
+        $cache = new ArrayCache();
+        $fileBoundCache = new FileBoundCache($cache, 'prefix');
+        $classBoundCache = new ClassBoundCache($fileBoundCache);
+        $adapter = new ClassBoundMemoryAdapter($classBoundCache);
+
+        $classToTouch = new ReflectionClass(A::class);
+        sleep(1);
+        clearstatcache($classToTouch->getFileName());
+        touch($classToTouch->getFileName());
+
+        $adapter->set('foo', 'bar', $classToTouch);
+
+        $this->assertSame('bar', $adapter->get('foo'));
+
+        $adapter2 = new ClassBoundMemoryAdapter($classBoundCache);
+        $this->assertSame('bar', $adapter2->get('foo'));
+
+        sleep(1);
+        clearstatcache($classToTouch->getFileName());
+        touch($classToTouch->getFileName());
+
+        $this->assertSame('bar', $adapter->get('foo'));
+    }
+}

tests/MemoryAdapterTest.php tests/FileBoundMemoryAdapterTest.phptests/MemoryAdapterTest.php renamed to tests/FileBoundMemoryAdapterTest.php

@@ -12,13 +12,13 @@
 use PHPUnit\Framework\TestCase;
 use function touch;
 
-class MemoryAdapterTest extends TestCase
+class FileBoundMemoryAdapterTest extends TestCase
 {
     public function testMemory()
     {
         $cache = new ArrayCache();
         $fileBoundCache = new FileBoundCache($cache, 'prefix');
-        $adapter = new MemoryAdapter($fileBoundCache);
+        $adapter = new FileBoundMemoryAdapter($fileBoundCache);
 
         $tmpPath = sys_get_temp_dir().'/tmpCacheTest';
         touch($tmpPath);
@@ -29,7 +29,7 @@ public function testMemory()
 
         $this->assertSame('bar', $adapter->get('foo'));
 
-        $adapter2 = new MemoryAdapter($fileBoundCache);
+        $adapter2 = new FileBoundMemoryAdapter($fileBoundCache);
         $this->assertSame('bar', $adapter2->get('foo'));
 
         sleep(1);