Cache system

.gitignore

@@ -11,6 +11,4 @@ Thumbs.db
 .phpunit.result.cache
 .php-cs-fixer.cache
 build
-tests/fixtures/application/storage/framework/logs/*.log
-tests/fixtures/application/storage/framework/views/*.php
 .env

src/App.php

@@ -59,6 +59,8 @@ public function setup(): void
 
         $this->host = $this->getHost();
 
+        self::$container->add(Phenix::class)->addMethodCall('registerCommands');
+
         /** @var array $providers */
         $providers = Config::get('app.providers', []);
 
@@ -71,8 +73,6 @@ public function setup(): void
 
         $this->logger = LoggerFactory::make($channel);
 
-        self::$container->add(Phenix::class)->addMethodCall('registerCommands');
-
         $this->register(Log::class, new Log($this->logger));
     }
 

src/Cache/CacheManager.php

@@ -0,0 +1,120 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Phenix\Cache;
+
+use Amp\Cache\LocalCache;
+use Closure;
+use Phenix\Cache\Constants\Store;
+use Phenix\Cache\Contracts\CacheStore;
+use Phenix\Cache\Stores\FileStore;
+use Phenix\Cache\Stores\LocalStore;
+use Phenix\Cache\Stores\RedisStore;
+use Phenix\Facades\Redis;
+use Phenix\Util\Date;
+
+class CacheManager
+{
+    protected array $stores = [];
+
+    protected Config $config;
+
+    public function __construct(Config|null $config = null)
+    {
+        $this->config = $config ?? new Config();
+    }
+
+    public function store(Store|null $storeName = null): CacheStore
+    {
+        $storeName ??= $this->resolveStoreName($storeName);
+
+        return $this->stores[$storeName->value] ??= $this->resolveStore($storeName);
+    }
+
+    public function get(string $key, Closure|null $callback = null): mixed
+    {
+        return $this->store()->get($key, $callback);
+    }
+
+    public function set(string $key, mixed $value, Date|null $ttl = null): void
+    {
+        $this->store()->set($key, $value, $ttl);
+    }
+
+    public function forever(string $key, mixed $value): void
+    {
+        $this->store()->forever($key, $value);
+    }
+
+    public function remember(string $key, Date $ttl, Closure $callback): mixed
+    {
+        return $this->store()->remember($key, $ttl, $callback);
+    }
+
+    public function rememberForever(string $key, Closure $callback): mixed
+    {
+        return $this->store()->rememberForever($key, $callback);
+    }
+
+    public function has(string $key): bool
+    {
+        return $this->store()->has($key);
+    }
+
+    public function delete(string $key): void
+    {
+        $this->store()->delete($key);
+    }
+
+    public function clear(): void
+    {
+        $this->store()->clear();
+    }
+
+    protected function resolveStoreName(Store|null $storeName = null): Store
+    {
+        return $storeName ?? Store::from($this->config->default());
+    }
+
+    protected function resolveStore(Store $storeName): CacheStore
+    {
+        return match ($storeName) {
+            Store::LOCAL => $this->createLocalStore(),
+            Store::FILE => $this->createFileStore(),
+            Store::REDIS => $this->createRedisStore(),
+        };
+    }
+
+    protected function createLocalStore(): CacheStore
+    {
+        $storeConfig = $this->config->getStore(Store::LOCAL->value);
+
+        $cache = new LocalCache($storeConfig['size_limit'] ?? null, $storeConfig['gc_interval'] ?? 5);
+
+        $defaultTtl = (int) ($storeConfig['ttl'] ?? $this->config->defaultTtlMinutes());
+
+        return new LocalStore($cache, $defaultTtl);
+    }
+
+    protected function createFileStore(): CacheStore
+    {
+        $storeConfig = $this->config->getStore(Store::FILE->value);
+
+        $path = $storeConfig['path'] ?? base_path('storage' . DIRECTORY_SEPARATOR . 'cache');
+
+        $defaultTtl = (int) ($storeConfig['ttl'] ?? $this->config->defaultTtlMinutes());
+
+        return new FileStore($path, $this->config->prefix(), $defaultTtl);
+    }
+
+    protected function createRedisStore(): CacheStore
+    {
+        $storeConfig = $this->config->getStore(Store::REDIS->value);
+        $defaultTtl = $storeConfig['ttl'] ?? $this->config->defaultTtlMinutes();
+
+        $client = Redis::connection($this->config->getConnection())->client();
+
+        return new RedisStore($client, $this->config->prefix(), (int) $defaultTtl);
+    }
+}

src/Cache/CacheServiceProvider.php

@@ -0,0 +1,33 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Phenix\Cache;
+
+use Phenix\Cache\Console\CacheClear;
+use Phenix\Providers\ServiceProvider;
+
+class CacheServiceProvider extends ServiceProvider
+{
+    public function provides(string $id): bool
+    {
+        $this->provided = [
+            CacheManager::class,
+        ];
+
+        return $this->isProvided($id);
+    }
+
+    public function register(): void
+    {
+        $this->bind(CacheManager::class)
+            ->setShared(true);
+    }
+
+    public function boot(): void
+    {
+        $this->commands([
+            CacheClear::class,
+        ]);
+    }
+}

src/Cache/CacheStore.php

@@ -0,0 +1,42 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Phenix\Cache;
+
+use Closure;
+use Phenix\Cache\Contracts\CacheStore as CacheStoreContract;
+use Phenix\Util\Date;
+
+abstract class CacheStore implements CacheStoreContract
+{
+    public function remember(string $key, Date $ttl, Closure $callback): mixed
+    {
+        $value = $this->get($key);
+
+        if ($value !== null) {
+            return $value;
+        }
+
+        $value = $callback();
+
+        $this->set($key, $value, $ttl);
+
+        return $value;
+    }
+
+    public function rememberForever(string $key, Closure $callback): mixed
+    {
+        $value = $this->get($key);
+
+        if ($value !== null) {
+            return $value;
+        }
+
+        $value = $callback();
+
+        $this->forever($key, $value);
+
+        return $value;
+    }
+}

src/Cache/Config.php

@@ -0,0 +1,45 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Phenix\Cache;
+
+use Phenix\Cache\Constants\Store;
+use Phenix\Facades\Config as Configuration;
+
+class Config
+{
+    private array $config;
+
+    public function __construct()
+    {
+        $this->config = Configuration::get('cache', []);
+    }
+
+    public function default(): string
+    {
+        return $this->config['default'] ?? Store::LOCAL->value;
+    }
+
+    public function getStore(string|null $storeName = null): array
+    {
+        $storeName ??= $this->default();
+
+        return $this->config['stores'][$storeName] ?? [];
+    }
+
+    public function getConnection(): string
+    {
+        return $this->getStore()['connection'] ?? 'default';
+    }
+
+    public function prefix(): string
+    {
+        return $this->config['prefix'] ?? '';
+    }
+
+    public function defaultTtlMinutes(): int
+    {
+        return (int) ($this->config['ttl'] ?? 60);
+    }
+}

src/Cache/Console/CacheClear.php

@@ -0,0 +1,41 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Phenix\Cache\Console;
+
+use Phenix\Facades\Cache;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+
+class CacheClear extends Command
+{
+    /**
+     * @var string
+     *
+     * @phpcsSuppress SlevomatCodingStandard.TypeHints.PropertyTypeHint
+     */
+    protected static $defaultName = 'cache:clear';
+
+    /**
+     * @var string
+     *
+     * @phpcsSuppress SlevomatCodingStandard.TypeHints.PropertyTypeHint
+     */
+    protected static $defaultDescription = 'Clear cached data in default cache store';
+
+    protected function configure(): void
+    {
+        $this->setHelp('This command allows you to clear cached data in the default cache store.');
+    }
+
+    protected function execute(InputInterface $input, OutputInterface $output): int
+    {
+        Cache::clear();
+
+        $output->writeln('<info>Cached data cleared successfully!</info>');
+
+        return Command::SUCCESS;
+    }
+}

src/Cache/Constants/Store.php

@@ -0,0 +1,14 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Phenix\Cache\Constants;
+
+enum Store: string
+{
+    case LOCAL = 'local';
+
+    case FILE = 'file';
+
+    case REDIS = 'redis';
+}

src/Cache/Contracts/CacheStore.php

@@ -0,0 +1,27 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Phenix\Cache\Contracts;
+
+use Closure;
+use Phenix\Util\Date;
+
+interface CacheStore
+{
+    public function get(string $key, Closure|null $callback = null): mixed;
+
+    public function set(string $key, mixed $value, Date|null $ttl = null): void;
+
+    public function forever(string $key, mixed $value): void;
+
+    public function remember(string $key, Date $ttl, Closure $callback): mixed;
+
+    public function rememberForever(string $key, Closure $callback): mixed;
+
+    public function has(string $key): bool;
+
+    public function delete(string $key): void;
+
+    public function clear(): void;
+}