feat: cache:clear command (tempestphp#487)

Author: brendt

src/Tempest/Cache/src/CacheClearCommand.php

@@ -0,0 +1,47 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tempest\Cache;
+
+use Tempest\Console\Console;
+use Tempest\Console\ConsoleCommand;
+use Tempest\Console\HasConsole;
+use Tempest\Container\Container;
+
+final readonly class CacheClearCommand
+{
+    use HasConsole;
+
+    public function __construct(
+        private Console $console,
+        private CacheConfig $cacheConfig,
+        private Container $container,
+    ) {
+    }
+
+    #[ConsoleCommand(name: 'cache:clear', aliases: ['cc'])]
+    public function __invoke(bool $all = false): void
+    {
+        $caches = $this->cacheConfig->caches;
+
+        if ($all === false) {
+            $caches = $this->ask(
+                question: "Which caches do you want to clear?",
+                options: $this->cacheConfig->caches,
+                multiple: true,
+            );
+        }
+
+        foreach ($caches as $cacheClass) {
+            /** @var Cache $cache */
+            $cache = $this->container->get($cacheClass);
+
+            $cache->clear();
+
+            $this->writeln("<em>{$cacheClass}</em> cleared successfully");
+        }
+
+        $this->success('Done');
+    }
+}

src/Tempest/Cache/src/CacheConfig.php

@@ -7,8 +7,11 @@
 use Psr\Cache\CacheItemPoolInterface;
 use Symfony\Component\Cache\Adapter\FilesystemAdapter;
 
-final readonly class CacheConfig
+final class CacheConfig
 {
+    /** @var class-string<\Tempest\Cache\Cache>[] */
+    public array $caches = [];
+
     public function __construct(
         public CacheItemPoolInterface $pool = new FilesystemAdapter(
             namespace: '',
@@ -17,4 +20,10 @@ public function __construct(
         ),
     ) {
     }
+
+    /** @param class-string<\Tempest\Cache\Cache> $className */
+    public function addCache(string $className): void
+    {
+        $this->caches[] = $className;
+    }
 }

src/Tempest/Cache/src/CacheDiscovery.php

@@ -0,0 +1,37 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tempest\Cache;
+
+use Tempest\Container\Container;
+use Tempest\Core\Discovery;
+use Tempest\Core\HandlesDiscoveryCache;
+use Tempest\Reflection\ClassReflector;
+
+final readonly class CacheDiscovery implements Discovery
+{
+    use HandlesDiscoveryCache;
+
+    public function __construct(
+        private CacheConfig $cacheConfig,
+    ) {
+    }
+
+    public function discover(ClassReflector $class): void
+    {
+        if ($class->implements(Cache::class)) {
+            $this->cacheConfig->addCache($class->getName());
+        }
+    }
+
+    public function createCachePayload(): string
+    {
+        return serialize($this->cacheConfig->caches);
+    }
+
+    public function restoreCachePayload(Container $container, string $payload): void
+    {
+        $this->cacheConfig->caches = unserialize($payload);
+    }
+}

src/Tempest/Cache/src/CacheInitializer.php

@@ -11,7 +11,7 @@
 final readonly class CacheInitializer implements Initializer
 {
     #[Singleton]
-    public function initialize(Container $container): Cache
+    public function initialize(Container $container): Cache|GenericCache
     {
         return new GenericCache($container->get(CacheConfig::class)->pool);
     }

src/Tempest/Console/src/Commands/DiscoveryClearCommand.php

@@ -34,10 +34,10 @@ public function __invoke(): void
 
             $this->console->writeln(implode('', [
                 "<em>{$discoveryClass}</em>",
-                ' cleared successful',
+                ' cleared successfully',
             ]));
         }
 
-        $this->console->writeln('Done');
+        $this->console->success('Done');
     }
 }

tests/Fixtures/Cache/DummyCache.php

@@ -0,0 +1,34 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tests\Tempest\Fixtures\Cache;
+
+use Psr\Cache\CacheItemPoolInterface;
+use Symfony\Component\Cache\Adapter\NullAdapter;
+use Tempest\Cache\Cache;
+use Tempest\Cache\IsCache;
+
+final class DummyCache implements Cache
+{
+    use IsCache;
+
+    private CacheItemPoolInterface $pool;
+
+    public bool $cleared = false;
+
+    public function __construct()
+    {
+        $this->pool = new NullAdapter();
+    }
+
+    protected function getCachePool(): CacheItemPoolInterface
+    {
+        return $this->pool;
+    }
+
+    public function clear(): void
+    {
+        $this->cleared = true;
+    }
+}

tests/Integration/Cache/CacheClearCommandTest.php

@@ -0,0 +1,48 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tests\Tempest\Integration\Cache;
+
+use Tempest\Cache\GenericCache;
+use Tests\Tempest\Fixtures\Cache\DummyCache;
+use Tests\Tempest\Integration\FrameworkIntegrationTestCase;
+
+/**
+ * @internal
+ */
+final class CacheClearCommandTest extends FrameworkIntegrationTestCase
+{
+    public function test_cache_clear(): void
+    {
+        $this->console
+            ->call('cache:clear')
+            ->assertSee(GenericCache::class)
+            ->assertSee(DummyCache::class)
+            ->submit('0,1')
+            ->submit('yes')
+            ->assertSee('Tests\Tempest\Fixtures\Cache\DummyCache cleared successfully')
+            ->assertSee('Tempest\Cache\GenericCache cleared successfully')
+            ->assertSee('Done');
+    }
+
+    public function test_cache_clear_one_option(): void
+    {
+        $this->console
+            ->call('cache:clear')
+            ->submit('0')
+            ->submit('yes')
+            ->assertSee('Tests\Tempest\Fixtures\Cache\DummyCache cleared successfully')
+            ->assertNotSee('Tempest\Cache\GenericCache cleared successfully')
+            ->assertSee('Done');
+    }
+
+    public function test_cache_clear_all(): void
+    {
+        $this->console
+            ->call('cache:clear --all')
+            ->assertSee('Tests\Tempest\Fixtures\Cache\DummyCache cleared successfully')
+            ->assertSee('Tempest\Cache\GenericCache cleared successfully')
+            ->assertSee('Done');
+    }
+}