refactor: improve cache component dx

Author: innocenzi

packages/cache/src/Cache.php

@@ -7,19 +7,40 @@
 use Closure;
 use Psr\Cache\CacheItemInterface;
 use Tempest\DateTime\DateTimeInterface;
+use Tempest\DateTime\Duration;
 
 interface Cache
 {
-    public function put(string $key, mixed $value, ?DateTimeInterface $expiresAt = null): CacheItemInterface;
-
+    /**
+     * Whether the cache is enabled.
+     */
+    public bool $enabled {
+        get;
+        set;
+    }
+
+    /**
+     * Sets the specified key to the specified value in the cache. Optionally, specify an expiration.
+     */
+    public function put(string $key, mixed $value, null|Duration|DateTimeInterface $expiration = null): CacheItemInterface;
+
+    /**
+     * Gets the value associated with the specified key from the cache. If the key does not exist, null is returned.
+     */
     public function get(string $key): mixed;
 
-    /** @param Closure(): mixed $cache */
-    public function resolve(string $key, Closure $cache, ?DateTimeInterface $expiresAt = null): mixed;
+    /**
+     * If the specified key already exists in the cache, the value is returned and the `$callback` is not executed. Otherwise, the result of the callback is stored, then returned.
+     */
+    public function resolve(string $key, Closure $callback, null|Duration|DateTimeInterface $expiration = null): mixed;
 
+    /**
+     * Removes the specified key from the cache.
+     */
     public function remove(string $key): void;
 
+    /**
+     * Clears the entire cache.
+     */
     public function clear(): void;
-
-    public function isEnabled(): bool;
 }

packages/cache/src/CacheClearCommand.php

@@ -0,0 +1,7 @@
+<?php
+
+namespace Tempest\Cache;
+
+interface CacheException
+{
+}

packages/cache/src/CacheConfig.php

@@ -4,15 +4,46 @@
 
 namespace Tempest\Cache;
 
+use Tempest\Cache\Config\CacheConfig;
 use Tempest\Container\Container;
-use Tempest\Container\Initializer;
+use Tempest\Container\DynamicInitializer;
 use Tempest\Container\Singleton;
+use Tempest\Reflection\ClassReflector;
 
-final readonly class CacheInitializer implements Initializer
+use function Tempest\env;
+use function Tempest\Support\str;
+
+final readonly class CacheInitializer implements DynamicInitializer
 {
+    public function canInitialize(ClassReflector $class, ?string $tag): bool
+    {
+        return $class->getType()->matches(Cache::class);
+    }
+
     #[Singleton]
-    public function initialize(Container $container): Cache|ProjectCache
+    public function initialize(ClassReflector $class, ?string $tag, Container $container): Cache
+    {
+        return new GenericCache(
+            cacheConfig: $container->get(CacheConfig::class, $tag),
+            enabled: $this->shouldCacheBeEnabled($tag),
+        );
+    }
+
+    private function shouldCacheBeEnabled(?string $tag): bool
     {
-        return new ProjectCache($container->get(CacheConfig::class));
+        $globalCacheEnabled = (bool) env('CACHE_ENABLED', default: true);
+
+        if (! $tag) {
+            return $globalCacheEnabled;
+        }
+
+        $environmentVariableName = str($tag)
+            ->snake()
+            ->upper()
+            ->prepend('CACHE_')
+            ->append('_ENABLED')
+            ->toString();
+
+        return (bool) env($environmentVariableName, default: $globalCacheEnabled);
     }
 }