Add randomized()

#151, #150
aedart · Mar 14, 2024 · 27864de · 27864de
1 parent 731dff5
commit 27864de
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 0 deletions.
diff --git a/packages/Utils/src/Arr.php b/packages/Utils/src/Arr.php
@@ -3,8 +3,11 @@
 
 namespace Aedart\Utils;
 
+use Aedart\Contracts\Utils\Random\ArrayRandomizer;
+use Aedart\Utils\Random\Factory;
 use Illuminate\Support\Arr as ArrBase;
 use InvalidArgumentException;
+use Random\Engine;
 
 /**
  * Array Utility
@@ -14,6 +17,18 @@
  */
 class Arr extends ArrBase
 {
+    /**
+     * Returns a new Array Randomizer instance
+     *
+     * @param Engine|null $engine [optional]
+     *
+     * @return ArrayRandomizer
+     */
+    public static function randomized(Engine|null $engine = null): ArrayRandomizer
+    {
+        return Factory::make($engine);
+    }
+
     /**
      * Returns a single random element from given list
      *

diff --git a/tests/Unit/Utils/ArrTest.php b/tests/Unit/Utils/ArrTest.php
@@ -3,6 +3,7 @@
 
 namespace Aedart\Tests\Unit\Utils;
 
+use Aedart\Contracts\Utils\Random\ArrayRandomizer;
 use Aedart\Testing\Helpers\ConsoleDebugger;
 use Aedart\Testing\TestCases\UnitTestCase;
 use Aedart\Utils\Arr;
@@ -18,6 +19,18 @@
  */
 class ArrTest extends UnitTestCase
 {
+    /**
+     * @test
+     *
+     * @return void
+     */
+    public function returnsRandomizer(): void
+    {
+        $randomizer = Arr::randomized();
+
+        $this->assertInstanceOf(ArrayRandomizer::class, $randomizer);
+    }
+
     /**
      * @test
      */