refactor: change KeyTransformer to instance object, not static class (

#118)
rekalogika · Jul 9, 2024 · 98e16d7 · 98e16d7
1 parent c7b450f
commit 98e16d7
Show file tree

Hide file tree

Showing 6 changed files with 65 additions and 8 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -16,6 +16,7 @@
 * feat: default items per page
 * feat: different default count strategies for full & minimal classes
 * chore: cleanup typehints
+* refactor: change `KeyTransformer` to instance object, not static class
 
 ## 0.8.0
 

diff --git a/packages/collections-common/src/Configuration.php b/packages/collections-common/src/Configuration.php
@@ -15,7 +15,6 @@
 
 use Doctrine\Common\Collections\Order;
 use Rekalogika\Domain\Collections\Common\Count\CountStrategy;
-use Rekalogika\Domain\Collections\Common\KeyTransformer\DefaultKeyTransformer;
 use Rekalogika\Domain\Collections\Common\KeyTransformer\KeyTransformer;
 
 final class Configuration
@@ -41,15 +40,30 @@ private function __construct()
     public static int $defaultHardLimit = 2000;
 
     /**
+     * If the result of a count exceeds this number, a deprecation notice will
+     * be emitted. Used by `SafeDelegatedCountStrategy`. Not applicable with
+     * other count strategies.
+     *
      * @var int<1,max>
      */
     public static int $defaultCountSoftLimit = 5000;
 
     /**
+     * If the result of a count exceeds this number, an exception will be
+     * thrown. Used by `SafeDelegatedCountStrategy`. Not applicable with other
+     * count strategies.
+     *
      * @var int<1,max>
      */
     public static int $defaultCountHardLimit = 50000;
 
+    /**
+     * If the duration of a count operation exceeds this number of seconds, a
+     * deprecation notice will be emitted. Used by `SafeDelegatedCountStrategy`,
+     * Not applicable with other count strategies.
+     *
+     * @var float
+     */
     public static float $defaultCountDurationThreshold = 2;
 
     /**
@@ -60,23 +74,34 @@ private function __construct()
     public static array $defaultOrderBy = ['id' => Order::Descending];
 
     /**
-     * @var class-string<KeyTransformer>
+     * The default key transformer for the collection.
+     *
+     * @var null|\Closure(): KeyTransformer
      */
-    public static string $defaultKeyTransformer = DefaultKeyTransformer::class;
+    public static ?\Closure $defaultKeyTransformer = null;
 
     /**
+     * Default count strategy for full, non-minimal, classes.
+     *
      * @var null|\Closure(): CountStrategy
      */
     public static ?\Closure $defaultCountStrategyForFullClasses = null;
 
     /**
+     * Default count strategy for minimal classes.
+     *
      * @var null|\Closure(): CountStrategy
      */
     public static ?\Closure $defaultCountStrategyForMinimalClasses = null;
 
+    /**
+     * Default columns used for indexing.
+     */
     public static ?string $defaultIndexBy = null;
 
     /**
+     * Default items per page for pagination.
+     *
      * @var int<1,max>
      */
     public static int $defaultItemsPerPage = 50;

diff --git a/packages/collections-common/src/Internal/ParameterUtil.php b/packages/collections-common/src/Internal/ParameterUtil.php
@@ -19,6 +19,7 @@
 use Rekalogika\Domain\Collections\Common\Count\CountStrategy;
 use Rekalogika\Domain\Collections\Common\Count\DisabledCountStrategy;
 use Rekalogika\Domain\Collections\Common\Count\SafeDelegatedCountStrategy;
+use Rekalogika\Domain\Collections\Common\KeyTransformer\DefaultKeyTransformer;
 use Rekalogika\Domain\Collections\Common\KeyTransformer\KeyTransformer;
 
 /**
@@ -46,13 +47,21 @@ public static function getDefaultCountStrategyForMinimalClasses(): CountStrategy
         return $closure();
     }
 
+    public static function getDefaultKeyTransformer(): KeyTransformer
+    {
+        $closure = Configuration::$defaultKeyTransformer
+            ?? fn (): KeyTransformer => DefaultKeyTransformer::create();
+
+        return $closure();
+    }
+
     public static function transformInputToKey(
         ?KeyTransformer $keyTransformer,
         mixed $input
     ): int|string {
-        $keyTransformer ??= Configuration::$defaultKeyTransformer;
+        $keyTransformer ??= self::getDefaultKeyTransformer();
 
-        return $keyTransformer::transformToKey($input);
+        return $keyTransformer->transformToKey($input);
     }
 
     /**

diff --git a/packages/collections-common/src/KeyTransformer/DefaultKeyTransformer.php b/packages/collections-common/src/KeyTransformer/DefaultKeyTransformer.php
@@ -17,7 +17,18 @@
 
 class DefaultKeyTransformer implements KeyTransformer
 {
-    public static function transformToKey(mixed $key): int|string
+    private static ?self $instance = null;
+
+    public static function create(): self
+    {
+        return self::$instance ??= new self();
+    }
+
+    private function __construct()
+    {
+    }
+
+    public function transformToKey(mixed $key): int|string
     {
         if ($key instanceof \Stringable) {
             return (string) $key;

diff --git a/packages/collections-common/src/KeyTransformer/KeyTransformer.php b/packages/collections-common/src/KeyTransformer/KeyTransformer.php
@@ -15,5 +15,5 @@
 
 interface KeyTransformer
 {
-    public static function transformToKey(mixed $key): int|string;
+    public function transformToKey(mixed $key): int|string;
 }
diff --git a/packages/collections-common/src/KeyTransformer/UuidKeyTransformer.php b/packages/collections-common/src/KeyTransformer/UuidKeyTransformer.php
@@ -19,7 +19,18 @@
 
 class UuidKeyTransformer implements KeyTransformer
 {
-    public static function transformToKey(mixed $key): int|string
+    private static ?self $instance = null;
+
+    public static function create(): self
+    {
+        return self::$instance ??= new self();
+    }
+
+    private function __construct()
+    {
+    }
+
+    public function transformToKey(mixed $key): int|string
     {
         if ($key instanceof AbstractUid) {
             return $key->toRfc4122();