Add SimpleCache

Author: IngeniozIT

composer.json

@@ -15,7 +15,8 @@
     "require": {
         "php": ">=8.2",
         "ingenioz-it/clock": "^1.0",
-        "psr/cache": "^3.0"
+        "psr/cache": "^3.0",
+        "psr/simple-cache": "^3.0"
     },
     "require-dev": {
         "phpunit/phpunit": "*",

src/CacheException.php

@@ -6,7 +6,8 @@
 
 use Exception;
 use Psr\Cache\CacheException as PsrCacheException;
+use Psr\SimpleCache\CacheException as PsrSimpleCacheException;
 
-class CacheException extends Exception implements PsrCacheException
+class CacheException extends Exception implements PsrCacheException, PsrSimpleCacheException
 {
 }

src/CacheItem.php

@@ -17,8 +17,16 @@ public function __construct(
         private ?DateTimeInterface $expirationDate,
         private readonly ClockInterface $clock,
     ) {
+        self::validateKey($key);
+    }
+
+    public static function validateKey(string $key): void
+    {
+        if (empty($key)) {
+            throw new InvalidArgumentException('Key must not be empty');
+        }
         if (strpbrk($key, '{}()/\\@:') !== false) {
-            throw new InvalidArgumentException("Invalid key: {$key}");
+            throw new InvalidArgumentException("Invalid key: $key");
         }
     }
 

src/FileCacheItemPool.php

@@ -55,11 +55,12 @@ public function getItems(array $keys = []): iterable
         return $items;
     }
 
+    /**
+     * @SuppressWarnings(PHPMD.StaticAccess)
+     */
     public function hasItem(string $key): bool
     {
-        if (empty($key)) {
-            throw new InvalidArgumentException('Key must be a string');
-        }
+        CacheItem::validateKey($key);
         return file_exists($this->getFilePath($key));
     }
 

src/InvalidArgumentException.php

@@ -4,8 +4,9 @@
 
 namespace IngeniozIT\Cache;
 
-use Psr\Cache\InvalidArgumentException as PsrInvalidArgumentException;
+use Psr\Cache\InvalidArgumentException as PsrCacheInvalidArgumentException;
+use Psr\SimpleCache\InvalidArgumentException as PsrSimpleCacheInvalidArgumentException;
 
-final class InvalidArgumentException extends CacheException implements PsrInvalidArgumentException
+final class InvalidArgumentException extends CacheException implements PsrCacheInvalidArgumentException, PsrSimpleCacheInvalidArgumentException
 {
 }

src/MemoryCacheItemPool.php

@@ -40,12 +40,13 @@ public function getItems(array $keys = []): iterable
         return $items;
     }
 
+    /**
+     * @SuppressWarnings(PHPMD.StaticAccess)
+     */
     public function hasItem(string $key): bool
     {
-        if (empty($key)) {
-            throw new InvalidArgumentException('Key must be a string');
-        }
-        return isset($this->items[$key]);
+        CacheItem::validateKey($key);
+        return isset($this->items[$key]) && $this->items[$key]->isHit();
     }
 
     public function clear(): bool
@@ -59,9 +60,10 @@ public function deleteItem(string $key): bool
     {
         if ($this->hasItem($key)) {
             unset($this->items[$key]);
+            return true;
         }
 
-        return true;
+        return false;
     }
 
     /**

src/SimpleCache.php

@@ -0,0 +1,85 @@
+<?php
+
+declare(strict_types=1);
+
+namespace IngeniozIT\Cache;
+
+use Psr\SimpleCache\CacheInterface;
+use Psr\Cache\CacheItemPoolInterface;
+use DateInterval;
+
+final readonly class SimpleCache implements CacheInterface
+{
+    public function __construct(
+        private CacheItemPoolInterface $pool,
+    ) {
+    }
+
+    public function get(string $key, mixed $default = null): mixed
+    {
+        $item = $this->pool->getItem($key);
+        return $item->isHit() ? $item->get() : $default;
+    }
+
+    public function set(string $key, mixed $value, int|DateInterval|null $ttl = null): bool
+    {
+        $item = $this->pool->getItem($key);
+        $item->set($value);
+        $item->expiresAfter($ttl);
+        return $this->pool->save($item);
+    }
+
+    public function delete(string $key): bool
+    {
+        return $this->pool->deleteItem($key);
+    }
+
+    public function clear(): bool
+    {
+        return $this->pool->clear();
+    }
+
+    /**
+     * @param iterable<string> $keys
+     * @return array<string, mixed>
+     */
+    public function getMultiple(iterable $keys, mixed $default = null): iterable
+    {
+        $values = [];
+        foreach ($keys as $key) {
+            $item = $this->pool->getItem($key);
+            $values[$key] = $item->isHit() ? $item->get() : $default;
+        }
+        return $values;
+    }
+
+    /**
+     * @param iterable<string, mixed> $values
+     */
+    public function setMultiple(iterable $values, int|DateInterval|null $ttl = null): bool
+    {
+        foreach ($values as $key => $value) {
+            $item = $this->pool->getItem($key);
+            $item->set($value);
+            $item->expiresAfter($ttl);
+            $this->pool->saveDeferred($item);
+        }
+        return $this->pool->commit();
+    }
+
+    public function deleteMultiple(iterable $keys): bool
+    {
+        $success = true;
+        foreach ($keys as $key) {
+            if (!$this->pool->deleteItem($key)) {
+                $success = false;
+            }
+        }
+        return $success;
+    }
+
+    public function has(string $key): bool
+    {
+        return $this->pool->hasItem($key);
+    }
+}

tests/CacheItemPoolTestAbstract.php

@@ -219,4 +219,49 @@ public function testDoesNotSaveOutdatedItems(): void
         self::assertFalse($saved);
         self::assertFalse($hasItem1);
     }
+
+    /**
+     * @dataProvider invalidKeysScenariosProvider
+     */
+    public function testCannotUseInvalidKeys(callable $scenario): void
+    {
+        $cache = $this->getPool();
+
+        $this->expectException(InvalidArgumentException::class);
+        $scenario($cache);
+    }
+
+    /**
+     * @return array<string, array{0: callable}>
+     */
+    public static function invalidKeysScenariosProvider(): array
+    {
+        return [
+            'getItem' => [
+                function (CacheItemPoolInterface $cache) {
+                    $cache->getItem('{invalidKey}');
+                },
+            ],
+            'getItems' => [
+                function (CacheItemPoolInterface $cache) {
+                    $cache->getItems(['{invalidKey}']);
+                },
+            ],
+            'hasItem' => [
+                function (CacheItemPoolInterface $cache) {
+                    $cache->hasItem('{invalidKey}');
+                },
+            ],
+            'deleteItem' => [
+                function (CacheItemPoolInterface $cache) {
+                    $cache->deleteItem('{invalidKey}');
+                },
+            ],
+            'deleteItems' => [
+                function (CacheItemPoolInterface $cache) {
+                    $cache->deleteItems(['{invalidKey}']);
+                },
+            ],
+        ];
+    }
 }