Redesign Randomizer, extract into small self-contained "drivers"

Now each type of randomizer has its own responsibilities and less changes of naming conflicts (e.g. shuffleBytes() vs. shuffleArray() have both been renamed to shuffle()).

#150, #151

packages/Contracts/src/Utils/Random/ArrayRandomizer.php

@@ -10,7 +10,7 @@
  * @author Alin Eugen Deac <[email protected]>
  * @package Aedart\Contracts\Utils\Random
  */
-interface ArrayRandomizer
+interface ArrayRandomizer extends Randomizer
 {
     /**
      * Returns random array keys

packages/Contracts/src/Utils/Random/Factory.php

@@ -0,0 +1,24 @@
+<?php
+
+namespace Aedart\Contracts\Utils\Random;
+
+use Random\Engine;
+
+/**
+ * Randomizer Factory
+ *
+ * @author Alin Eugen Deac <[email protected]>
+ * @package Aedart\Contracts\Utils\Random
+ */
+interface Factory
+{
+    /**
+     * Returns a new randomizer instance of given type
+     *
+     * @param Type $type
+     * @param Engine|null $engine [optional]
+     *
+     * @return Randomizer
+     */
+    public static function make(Type $type, Engine|null $engine = null): Randomizer;
+}

packages/Contracts/src/Utils/Random/NumericRandomizer.php

@@ -10,7 +10,7 @@
  * @author Alin Eugen Deac <[email protected]>
  * @package Aedart\Contracts\Utils\Random
  */
-interface NumericRandomizer
+interface NumericRandomizer extends Randomizer
 {
     /**
      * Returns a uniformly selected integer

packages/Contracts/src/Utils/Random/Randomizer.php

@@ -2,21 +2,14 @@
 
 namespace Aedart\Contracts\Utils\Random;
 
+use Aedart\Contracts\Utils\HasDriver;
+
 /**
  * Randomizer
  *
  * @author Alin Eugen Deac <[email protected]>
  * @package Aedart\Contracts\Utils\Random
  */
-interface Randomizer extends
-    StringRandomizer,
-    NumericRandomizer,
-    ArrayRandomizer
+interface Randomizer extends HasDriver
 {
-    /**
-     * Returns the underlying driver of this randomizer
-     *
-     * @return mixed
-     */
-    public function driver(): mixed;
 }

packages/Contracts/src/Utils/Random/StringRandomizer.php

@@ -5,12 +5,12 @@
 use Throwable;
 
 /**
- * String Randomizer
+ * String (Bytes) Randomizer
  *
  * @author Alin Eugen Deac <[email protected]>
  * @package Aedart\Contracts\Utils\Random
  */
-interface StringRandomizer
+interface StringRandomizer extends Randomizer
 {
     /**
      * Returns random bytes
@@ -32,5 +32,5 @@ public function bytes(int $length): string;
      *
      * @throws Throwable
      */
-    public function shuffleBytes(string $bytes): string;
+    public function shuffle(string $bytes): string;
 }

packages/Contracts/src/Utils/Random/Type.php

@@ -0,0 +1,27 @@
+<?php
+
+namespace Aedart\Contracts\Utils\Random;
+
+/**
+ * Randomizer Type
+ *
+ * @author Alin Eugen Deac <[email protected]>
+ * @package Aedart\Contracts\Utils\Random
+ */
+enum Type
+{
+    /**
+     * Array Randomizer
+     */
+    case Array;
+
+    /**
+     * Numeric Randomizer
+     */
+    case Numeric;
+
+    /**
+     * String (bytes) Randomizer
+     */
+    case String;
+}

packages/Utils/src/Arr.php

@@ -4,6 +4,7 @@
 namespace Aedart\Utils;
 
 use Aedart\Contracts\Utils\Random\ArrayRandomizer;
+use Aedart\Contracts\Utils\Random\Type;
 use Aedart\Utils\Random\Factory;
 use Illuminate\Support\Arr as ArrBase;
 use InvalidArgumentException;
@@ -26,7 +27,7 @@ class Arr extends ArrBase
      */
     public static function randomizer(Engine|null $engine = null): ArrayRandomizer
     {
-        return Factory::make($engine);
+        return Factory::make(Type::Array, $engine);
     }
 
     /**

packages/Utils/src/Math.php

@@ -3,6 +3,7 @@
 namespace Aedart\Utils;
 
 use Aedart\Contracts\Utils\Random\NumericRandomizer;
+use Aedart\Contracts\Utils\Random\Type;
 use Aedart\Utils\Random\Factory;
 use Random\Engine;
 use RuntimeException;
@@ -25,7 +26,7 @@ class Math
      */
     public static function randomizer(Engine|null $engine = null): NumericRandomizer
     {
-        return Factory::make($engine);
+        return Factory::make(Type::Numeric, $engine);
     }
 
     /**

packages/Utils/src/Random/Factory.php

@@ -2,9 +2,14 @@
 
 namespace Aedart\Utils\Random;
 
+use Aedart\Contracts\Utils\Random\Factory as RandomizerFactory;
 use Aedart\Contracts\Utils\Random\Randomizer as RandomizerInterface;
+use Aedart\Contracts\Utils\Random\Type;
+use Aedart\Utils\Random\Types\ArrayRandomizer;
+use Aedart\Utils\Random\Types\NumericRandomizer;
+use Aedart\Utils\Random\Types\StringRandomizer;
 use Random\Engine;
-use Random\Randomizer as NativeRandomizer;
+use Random\Randomizer;
 
 /**
  * Randomizer Factory
@@ -14,21 +19,34 @@
  * @author Alin Eugen Deac <[email protected]>
  * @package Aedart\Utils\Random
  */
-class Factory
+class Factory implements RandomizerFactory
 {
+
+    /**
+     * @inheritDoc
+     */
+    public static function make(Type $type, Engine|null $engine = null): RandomizerInterface
+    {
+        $driver = static::makeDriver($engine);
+
+        return match($type) {
+            Type::Array => new ArrayRandomizer($driver),
+            Type::String => new StringRandomizer($driver),
+            Type::Numeric => new NumericRandomizer($driver)
+        };
+    }
+
     /**
-     * Returns a new Randomizer instance, using given engine
+     * Returns a new driver instance
      *
-     * @see https://www.php.net/manual/en/random-randomizer.construct.php
+     * @see https://www.php.net/manual/en/class.random-randomizer.php
      *
      * @param Engine|null $engine [optional]
      *
-     * @return RandomizerInterface
+     * @return Randomizer
      */
-    public static function make(Engine|null $engine = null): RandomizerInterface
+    protected static function makeDriver(Engine|null $engine = null): Randomizer
     {
-        $driver = new NativeRandomizer($engine);
-
-        return new Randomizer($driver);
+        return new Randomizer($engine);
     }
 }

packages/Utils/src/Random/Types/ArrayRandomizer.php

@@ -0,0 +1,30 @@
+<?php
+
+namespace Aedart\Utils\Random\Types;
+
+use Aedart\Contracts\Utils\Random\ArrayRandomizer as ArrayRandomizerInterface;
+
+/**
+ * Array Randomizer
+ *
+ * @author Alin Eugen Deac <[email protected]>
+ * @package Aedart\Utils\Random\Types
+ */
+class ArrayRandomizer extends BaseRandomizer implements ArrayRandomizerInterface
+{
+    /**
+     * @inheritDoc
+     */
+    public function pickKeys(array $arr, int $amount): array
+    {
+        return $this->driver()->pickArrayKeys($arr, $amount);
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function shuffle(array $arr): array
+    {
+        return $this->driver()->shuffleArray($arr);
+    }
+}