feature: initial PSR-6 cache implementation

.gitignore

@@ -2,7 +2,10 @@ build
 composer.lock
 vendor
 .idea
+.vscode
 .php-cs-fixer.cache
 .phpunit.result.cache
-cache
+.phpspellcheck.cache
+composer/
+.DS_Store
 .aider*

.php-cs-fixer.php

@@ -25,7 +25,7 @@
         'method_chaining_indentation' => true,
         'native_function_casing' => true,
         'native_function_invocation' => ['include' => ['@compiler_optimized']],
-        'new_with_braces' => true,
+        'new_with_parentheses' => true,
         'modernize_types_casting' => true,
         'method_argument_space' => ['on_multiline' => 'ensure_fully_multiline'],
         'no_empty_statement' => true,

composer.json

@@ -25,6 +25,7 @@
         "nyholm/psr7": "^1.3",
         "psr/http-client": "^1.0",
         "symfony/process": "^4.4.30 | ^5.0 |^6.0 | ^7.0",
+        "symfony/cache": "^4.4.30 | ^5.0 |^6.0 | ^7.0",
         "thecodingmachine/safe": "^1.0 | ^2.0",
         "webmozart/assert": "^1.11"
     },
@@ -51,7 +52,9 @@
         "psr-4": {
             "PhpSpellcheck\\": "src"
         },
-        "files": [ "src/Text/functions.php" ]
+        "files": [
+            "src/Text/functions.php"
+        ]
     },
     "autoload-dev": {
         "psr-4": {

docker-compose.yml

@@ -7,7 +7,7 @@ services:
         PHP_VERSION: ${PHP_VERSION:-8.1}
     volumes:
       - .:/usr/src/myapp
-      - ./cache:/root/composer/cache
+      - ./composer/cache:/root/composer/cache
     environment:
       - LANG=en_US.UTF-8
       - COMPOSER_CACHE_DIR=/root/composer/cache

src/Cache/Cache.php

@@ -0,0 +1,47 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PhpSpellcheck\Cache;
+
+use PhpSpellcheck\Cache\Stores\StoreInterface;
+use PhpSpellcheck\Exception\InvalidArgumentException;
+
+class Cache implements CacheFactoryInterface
+{
+    /**
+     * Get a cache store instance by driver.
+     *
+     * @param array<string, mixed> $config
+     */
+    public static function create(?string $driver = null, array $config = []): StoreInterface
+    {
+        $driver ??= self::getDefaultDriver();
+
+        $class = self::resolveStoreClass($driver);
+
+        return $class::create(...$config);
+    }
+
+    /**
+     * Resolve the cache store class.
+     */
+    public static function resolveStoreClass(string $driver): string
+    {
+        $class = \sprintf('%s\%s\%s%s', __NAMESPACE__, 'Stores', ucfirst($driver), 'Store');
+
+        if (!class_exists($class)) {
+            throw new InvalidArgumentException("Cache store [{$driver}] is not defined.");
+        }
+
+        return $class;
+    }
+
+    /**
+     * Get the default cache driver name.
+     */
+    private static function getDefaultDriver(): string
+    {
+        return 'file';
+    }
+}

src/Cache/CacheFactoryInterface.php

@@ -0,0 +1,17 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PhpSpellcheck\Cache;
+
+use PhpSpellcheck\Cache\Stores\StoreInterface;
+
+interface CacheFactoryInterface
+{
+    /**
+     * Get a cache store instance by name.
+     *
+     * @param array<string, mixed> $config
+     */
+    public static function create(?string $name = null, array $config = []): StoreInterface;
+}

src/Cache/Stores/FileStore.php

@@ -0,0 +1,85 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PhpSpellcheck\Cache\Stores;
+
+use Composer\Autoload\ClassLoader;
+use Symfony\Contracts\Cache\ItemInterface;
+use Symfony\Component\Cache\Adapter\FilesystemAdapter;
+
+class FileStore implements StoreInterface
+{
+    /**
+     * The filesystem adapter instance.
+     */
+    public function __construct(private FilesystemAdapter $filesystemAdapter)
+    {
+        //
+    }
+
+    /**
+     * Create a new file cache store instance.
+     */
+    public static function create(string $namespace = '', int $defaultLifetime = 3600, ?string $cacheDirectory = null): self
+    {
+        return new self(new FilesystemAdapter($namespace, $defaultLifetime, $cacheDirectory ?? self::getDefaultCachePath()));
+    }
+
+    /**
+     * Get the default cache directory for the file store.
+     */
+    public static function getDefaultCachePath(): string
+    {
+        return \dirname(array_keys(ClassLoader::getRegisteredLoaders())[0]).'/.phpspellcheck.cache';
+    }
+
+    /**
+     * Fetches an item from the cache.
+     *
+     * @param array<mixed> $metadata
+     */
+    public function get(string $key, callable $callback, float $beta = null, ?array &$metadata = null): mixed
+    {
+        return $this->filesystemAdapter->get($key, $callback, $beta, $metadata);
+    }
+
+    /**
+     * Set the value of the given key in the cache.
+     */
+    public function set(string $key, mixed $value, ?int $lifetime = null): void
+    {
+        $item = $this->filesystemAdapter->getItem($key);
+        $item->set($value);
+
+        if ($lifetime !== null) {
+            $item->expiresAfter($lifetime);
+        }
+
+        $this->filesystemAdapter->save($item);
+    }
+
+    /**
+     * Removed an item from the pool.
+     */
+    public function delete(string $key): bool
+    {
+        return $this->filesystemAdapter->delete($key);
+    }
+
+    /**
+     * Fetches an item from the cache.
+     */
+    public function getItem(string $key): ItemInterface
+    {
+        return $this->filesystemAdapter->getItem($key);
+    }
+
+    /**
+     * Clear data from cache.
+     */
+    public function clear(string $prefix = ''): bool
+    {
+        return $this->filesystemAdapter->clear($prefix);
+    }
+}

src/Cache/Stores/StoreInterface.php

@@ -0,0 +1,26 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PhpSpellcheck\Cache\Stores;
+
+use Symfony\Contracts\Cache\ItemInterface;
+use Symfony\Contracts\Cache\CacheInterface;
+
+interface StoreInterface extends CacheInterface
+{
+    /**
+     * Clear data from cache.
+     */
+    public function clear(string $prefix = ''): bool;
+
+    /**
+     * Fetches an item from the cache.
+     */
+    public function getItem(string $key): ItemInterface;
+
+    /**
+     * Create a new cache store instance.
+     */
+    public static function create(string $namespace = '', int $defaultLifetime = 3600, ?string $cacheDirectory = null): self;
+}

src/MisspellingHandler/EchoHandler.php

@@ -14,7 +14,7 @@ class EchoHandler implements MisspellingHandlerInterface
     public function handle(iterable $misspellings): void
     {
         foreach ($misspellings as $misspelling) {
-            $output = sprintf(
+            $output = \sprintf(
                 'word: %s | line: %d | offset: %d | suggestions: %s | context: %s' . PHP_EOL,
                 $misspelling->getWord(),
                 $misspelling->getLineNumber(),

src/Spellchecker/Aspell.php

@@ -5,6 +5,7 @@
 namespace PhpSpellcheck\Spellchecker;
 
 use PhpSpellcheck\Exception\ProcessHasErrorOutputException;
+use PhpSpellcheck\Traits\SpellcheckerCacheTrait;
 use PhpSpellcheck\Utils\CommandLine;
 use PhpSpellcheck\Utils\IspellParser;
 use PhpSpellcheck\Utils\ProcessRunner;
@@ -13,37 +14,19 @@
 
 class Aspell implements SpellcheckerInterface
 {
-    /**
-     * @var CommandLine
-     */
-    private $binaryPath;
+    use SpellcheckerCacheTrait;
 
-    public function __construct(CommandLine $binaryPath)
+    public function __construct(private CommandLine $binaryPath)
     {
-        $this->binaryPath = $binaryPath;
+        $this->initCache();
     }
 
+    /**
+     * {@inheritdoc}
+     */
     public function check(string $text, array $languages = [], array $context = []): iterable
     {
-        Assert::maxCount($languages, 1, 'Aspell spellchecker doesn\'t support multiple languages check');
-
-        $cmd = $this->binaryPath->addArgs(['--encoding', 'utf-8']);
-        $cmd = $cmd->addArg('-a');
-
-        if (!empty($languages)) {
-            $cmd = $cmd->addArg('--lang=' . implode(',', $languages));
-        }
-
-        $process = new Process($cmd->getArgs());
-        // Add prefix characters putting Ispell's type of spellcheckers in terse-mode,
-        // ignoring correct words and thus speeding up the execution
-        $process->setInput('!' . PHP_EOL . IspellParser::adaptInputForTerseModeProcessing($text) . PHP_EOL . '%');
-
-        $output = ProcessRunner::run($process)->getOutput();
-
-        if ($process->getErrorOutput() !== '') {
-            throw new ProcessHasErrorOutputException($process->getErrorOutput(), $text, $process->getCommandLine());
-        }
+        $output = $this->processText($text, $languages);
 
         return IspellParser::parseMisspellingsFromOutput($output, $context);
     }
@@ -78,4 +61,38 @@ public static function create(?string $binaryPathAsString = null): self
     {
         return new self(new CommandLine($binaryPathAsString ?? 'aspell'));
     }
+
+    /**
+     * Process the text with Aspell spellchecker.
+     *
+     * @param array<int, string> $languages
+     */
+    protected function processText(string $text, array $languages): string
+    {
+        Assert::maxCount($languages, 1, 'Aspell spellchecker doesn\'t support multiple languages check');
+
+        $cmd = $this->binaryPath->addArgs(['--encoding', 'utf-8']);
+        $cmd = $cmd->addArg('-a');
+
+        if (!empty($languages)) {
+            $cmd = $cmd->addArg('--lang='.implode(',', $languages));
+        }
+
+        $process = new Process($cmd->getArgs());
+        // Add prefix characters putting Ispell's type of spellcheckers in terse-mode,
+        // ignoring correct words and thus speeding up the execution
+        $process->setInput('!'.PHP_EOL.IspellParser::adaptInputForTerseModeProcessing($text).PHP_EOL.'%');
+
+        $cacheKey = $this->getCacheKey($text, $languages);
+
+        return $this->cache->get($cacheKey, function () use (&$process, $text) {
+            $process = ProcessRunner::run($process);
+
+            if ($process->getErrorOutput() !== '') {
+                throw new ProcessHasErrorOutputException($process->getErrorOutput(), $text, $process->getCommandLine());
+            }
+
+            return $process->getOutput();
+        });
+    }
 }

src/Traits/SpellcheckerCacheTrait.php

@@ -0,0 +1,48 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PhpSpellcheck\Traits;
+
+use PhpSpellcheck\Cache\Cache;
+use PhpSpellcheck\Cache\Stores\StoreInterface;
+
+trait SpellcheckerCacheTrait
+{
+    /**
+     * The cache store instance.
+     */
+    private StoreInterface $cache;
+
+    /**
+     * The cache store instance.
+     *
+     * @param array<string, mixed> $config
+     */
+    private function initCache(array $config = []): void
+    {
+        $config['namespace'] ??= $this->getCacheNamespace();
+
+        $this->cache = Cache::create(config: $config);
+    }
+
+    /**
+     * Get the cache key for the given text and languages.
+     *
+     * @param array<int, string> $languages
+     */
+    private function getCacheKey(string $text, array $languages): string
+    {
+        return md5(\sprintf('%s_%s', $text, implode('_', $languages)));
+    }
+
+    /**
+     * Get the cache namespace.
+     */
+    private function getCacheNamespace(): string
+    {
+        $parts = explode('\\', \get_class($this));
+
+        return end($parts);
+    }
+}