Merge pull request #68 from rawilk/hash-key-generator

[Feature]: Hash key generator

Author: rawilk

config/settings.php

@@ -145,6 +145,7 @@
     | Supported:
     | - \Rawilk\Settings\Support\KeyGenerators\ReadableKeyGenerator
     | - \Rawilk\Settings\Support\KeyGenerators\Md5KeyGenerator (default)
+    | - \Rawilk\Settings\Support\KeyGenerators\HashKeyGenerator
     |
     */
     'key_generator' => \Rawilk\Settings\Support\KeyGenerators\Md5KeyGenerator::class,
@@ -194,4 +195,14 @@
         \Carbon\CarbonImmutable::class,
         \Illuminate\Support\Carbon::class,
     ],
+
+    /*
+    |--------------------------------------------------------------------------
+    | Hash Algorithm
+    |--------------------------------------------------------------------------
+    |
+    | The hashing algorithm to use for the HashKeyGenerator.
+    |
+    */
+    'hash_algorithm' => 'xxh128',
 ];

src/Support/KeyGenerators/HashKeyGenerator.php

@@ -0,0 +1,40 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rawilk\Settings\Support\KeyGenerators;
+
+use Rawilk\Settings\Contracts\ContextSerializer;
+use Rawilk\Settings\Contracts\KeyGenerator as KeyGeneratorContract;
+use Rawilk\Settings\Support\Context;
+use RuntimeException;
+
+class HashKeyGenerator implements KeyGeneratorContract
+{
+    protected ContextSerializer $serializer;
+
+    public function generate(string $key, ?Context $context = null): string
+    {
+        return hash(
+            config('settings.hash_algorithm', 'xxh128'),
+            $key . $this->serializer->serialize($context),
+        );
+    }
+
+    public function removeContextFromKey(string $key): string
+    {
+        throw new RuntimeException('HashKeyGenerator does not support removing the context from the key.');
+    }
+
+    public function setContextSerializer(ContextSerializer $serializer): static
+    {
+        $this->serializer = $serializer;
+
+        return $this;
+    }
+
+    public function contextPrefix(): string
+    {
+        throw new RuntimeException('HashKeyGenerator does not support a context prefix.');
+    }
+}

tests/Unit/KeyGenerators/HashKeyGeneratorTest.php

@@ -0,0 +1,43 @@
+<?php
+
+declare(strict_types=1);
+
+use Rawilk\Settings\Support\Context;
+use Rawilk\Settings\Support\ContextSerializers\ContextSerializer;
+use Rawilk\Settings\Support\ContextSerializers\DotNotationContextSerializer;
+use Rawilk\Settings\Support\KeyGenerators\HashKeyGenerator;
+
+beforeEach(function () {
+    $this->keyGenerator = (new HashKeyGenerator)
+        ->setContextSerializer(new ContextSerializer);
+
+    config([
+        'settings.hash_algorithm' => 'xxh128',
+    ]);
+});
+
+it('generates a hash of a key', function () {
+    // N; is for a serialized null context object
+    expect($this->keyGenerator->generate('my-key'))->toBe(hash('xxh128', 'my-keyN;'));
+});
+
+it('generates a hash of a key and context object', function () {
+    $context = new Context([
+        'id' => 123,
+    ]);
+
+    expect($this->keyGenerator->generate('my-key', $context))
+        ->toBe(hash('xxh128', 'my-key' . serialize($context)));
+});
+
+it('works with other context serializers', function () {
+    $this->keyGenerator->setContextSerializer(new DotNotationContextSerializer);
+
+    $context = new Context([
+        'id' => 123,
+        'bool-value' => false,
+    ]);
+
+    expect($this->keyGenerator->generate('my-key', $context))
+        ->toBe(hash('xxh128', 'my-keyid:123::bool-value:0'));
+});