Merge pull request #12 from faissaloux/fix-pick-count

Fix `pick($count)`
valorin · Jan 3, 2024 · 0d446cd · 0d446cd
2 parents 280b869 + c4b6f51
commit 0d446cd
Show file tree

Hide file tree

Showing 2 changed files with 106 additions and 5 deletions.
diff --git a/src/Generator.php b/src/Generator.php
@@ -229,16 +229,24 @@ public function shuffle($values, bool $preserveKeys = false)
      */
     public function pick($values, int $count)
     {
+        if ($count < 1) {
+            throw new \InvalidArgumentException('Can not pick less than one item.');
+        }
+
+        if (! is_string($values) && ! is_array($values) && ! $values instanceof Collection) {
+            throw new \InvalidArgumentException('$value must be a string, array, or \Illuminate\Support\Collection.');
+        }
+
+        if ((is_string($values) && $count > strlen($values)) || (! is_string($values) && $count > count($values))) {
+            throw new \InvalidArgumentException('Can not pick more than existing elements.');
+        }
+
         $values = $this->shuffle($values);
 
         if ($count === 1) {
             return $values[0];
         }
 
-        if (is_array($values)) {
-            return array_slice($values, 0, $count);
-        }
-
         if (is_string($values)) {
             return substr($values, 0, $count);
         }
@@ -247,7 +255,7 @@ public function pick($values, int $count)
             return $values->slice(0, $count);
         }
 
-        throw new \InvalidArgumentException('$value must be a string, array, or \Illuminate\Support\Collection.');
+        return array_slice($values, 0, $count);
     }
 
     /**

diff --git a/tests/PickTest.php b/tests/PickTest.php
@@ -10,6 +10,99 @@ class PickTest extends TestCase
 {
     use Assertions;
 
+    public function testCantPickZeroElementFromArray()
+    {
+        for ($i = 0; $i < 10; $i++) {
+            $this->expectException(\InvalidArgumentException::class);
+            $this->expectExceptionMessage('Can not pick less than one item.');
+
+            Random::pick(range('a', 'z'), 0);
+        }
+    }
+
+    public function testCantPickLessThanZeroElementFromArray()
+    {
+        for ($i = 0; $i < 10; $i++) {
+            $this->expectException(\InvalidArgumentException::class);
+            $this->expectExceptionMessage('Can not pick less than one item.');
+
+            Random::pick(range('a', 'z'), -1);
+        }
+    }
+
+    public function testCantPickMoreThanArrayElements()
+    {
+        for ($i = 0; $i < 10; $i++) {
+            $this->expectException(\InvalidArgumentException::class);
+            $this->expectExceptionMessage('Can not pick more than existing elements.');
+
+            Random::pick(range('a', 'z'), 27);
+        }
+    }
+
+    public function testCantPickZeroElementFromString()
+    {
+        for ($i = 0; $i < 10; $i++) {
+            $this->expectException(\InvalidArgumentException::class);
+            $this->expectExceptionMessage('Can not pick less than one item.');
+
+            Random::pick('abcdefghijklmnopqrstuvwxyz', 0);
+        }
+    }
+
+    public function testCantPickLessThanZeroElementFromString()
+    {
+        for ($i = 0; $i < 10; $i++) {
+            $this->expectException(\InvalidArgumentException::class);
+            $this->expectExceptionMessage('Can not pick less than one item.');
+
+            Random::pick('abcdefghijklmnopqrstuvwxyz', -1);
+        }
+    }
+
+    public function testCantPickMoreThanStringElements()
+    {
+        for ($i = 0; $i < 10; $i++) {
+            $this->expectException(\InvalidArgumentException::class);
+            $this->expectExceptionMessage('Can not pick more than existing elements.');
+
+            Random::pick('abcdefghijklmnopqrstuvwxyz', 27);
+        }
+    }
+
+    public function testCantPickZeroElementFromCollection()
+    {
+        for ($i = 0; $i < 10; $i++) {
+            $this->expectException(\InvalidArgumentException::class);
+            $this->expectExceptionMessage('Can not pick less than one item.');
+
+            $collection = new Collection(['a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i']);
+            Random::pick($collection, 0);
+        }
+    }
+
+    public function testCantPickLessThanZeroElementFromCollection()
+    {
+        for ($i = 0; $i < 10; $i++) {
+            $this->expectException(\InvalidArgumentException::class);
+            $this->expectExceptionMessage('Can not pick less than one item.');
+
+            $collection = new Collection(['a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i']);
+            Random::pick($collection, -1);
+        }
+    }
+
+    public function testCantPickMoreThanCollectionElements()
+    {
+        for ($i = 0; $i < 10; $i++) {
+            $this->expectException(\InvalidArgumentException::class);
+            $this->expectExceptionMessage('Can not pick more than existing elements.');
+
+            $collection = new Collection(['a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i']);
+            Random::pick($collection, 10);
+        }
+    }
+
     public function testPickSingleFromArray()
     {
         $differentPick = false;