test at_least

Author: brenoroosevelt

composer.json

@@ -31,6 +31,7 @@
             "src/IndexOf.php",
             "src/Contains.php",
             "src/All.php",
+            "src/AtLeast.php",
             "src/Add.php",
             "src/Set.php",
             "src/Pipe.php",

src/AtLeast.php

@@ -0,0 +1,42 @@
+<?php
+declare(strict_types=1);
+
+namespace BrenoRoosevelt;
+
+/**
+ * Evaluates whether <b>at least n</b> elements match the specification
+ *
+ * @param int $n The number to check
+ * @param iterable $items The collection
+ * @param callable $callback Callable must return a boolean
+ * @param int $mode [optional] <p>
+ * Flag determining what arguments are sent to <i>callback</i>:
+ * </p><ul>
+ * <li>
+ * <b>CALLBACK_USE_VALUE</b> - <b>default</b> pass value as the only argument
+ * </li>
+ * <li>
+ * <b>CALLBACK_USE_KEY</b> - pass key as the only argument
+ * to <i>callback</i> instead of the value</span>
+ * </li>
+ * <li>
+ * <b>CALLBACK_USE_BOTH</b> - pass both value and key as
+ * arguments to <i>callback</i></span>
+ * </li>
+ * </ul>
+ * @return bool
+ */
+function at_least(int $n, iterable $items, callable $callback, int $mode = CALLBACK_USE_VALUE): bool
+{
+    $count = 0;
+    foreach ($items as $key => $value) {
+        if (true === call_user_func_array($callback, __args($mode, $key, $value))) {
+            $count++;
+            if ($count >= $n) {
+                return true;
+            }
+        }
+    }
+
+    return $count >= $n;
+}

src/array_functions.php

@@ -13,21 +13,6 @@ function none(iterable $items, callable $callback, int $mode = 0): bool
     return ! some($items, $callback, $mode);
 }
 
-function at_least(int $n, iterable $items, callable $callback, int $mode = CALLBACK_USE_VALUE): bool
-{
-    $count = 0;
-    foreach ($items as $key => $value) {
-        if (true === call_user_func_array($callback, __args($mode, $key, $value))) {
-            $count++;
-            if ($count >= $n) {
-                return true;
-            }
-        }
-    }
-
-    return $count >= $n;
-}
-
 function at_most(int $n, iterable $items, callable $callback, int $mode = CALLBACK_USE_VALUE): bool
 {
     $count = 0;

tests/AllTest.php

@@ -75,7 +75,7 @@ public function allProvider(): array
      * @return void
      * @dataProvider allProvider
      */
-    public function testAdd(iterable $items, callable $callback, bool $emptyIsValid, int $mode, bool $expected): void
+    public function testAll(iterable $items, callable $callback, bool $emptyIsValid, int $mode, bool $expected): void
     {
         $actual = all($items, $callback, $emptyIsValid, $mode);
         $this->assertEquals($expected, $actual);

tests/AtLeastTest.php

@@ -0,0 +1,97 @@
+<?php
+declare(strict_types=1);
+
+namespace BrenoRoosevelt\Tests;
+
+use PHPUnit\Framework\TestCase;
+use function BrenoRoosevelt\at_least;
+use const BrenoRoosevelt\CALLBACK_USE_BOTH;
+use const BrenoRoosevelt\CALLBACK_USE_KEY;
+use const BrenoRoosevelt\CALLBACK_USE_VALUE;
+
+class AtLeastTest extends TestCase
+{
+    public function atLeastProvider(): array
+    {
+        return [
+            'case_1' => [
+                0,
+                ['a', 'b', 'c'], // collection
+                fn($el) => false, // callback
+                CALLBACK_USE_VALUE, // mode
+                true, // expected
+            ],
+            'case_2' => [
+                4,
+                ['a', 'b', 'c'],
+                fn($el) => true,
+                CALLBACK_USE_VALUE,
+                false,
+            ],
+            'case_3' => [
+                1,
+                [],
+                fn($el) => true,
+                CALLBACK_USE_VALUE,
+                false,
+            ],
+            'case_3_1' => [
+                0,
+                [],
+                fn($el) => true,
+                CALLBACK_USE_VALUE,
+                true,
+            ],
+            'case_3_2' => [
+                -1,
+                [],
+                fn($el) => true,
+                CALLBACK_USE_VALUE,
+                true,
+            ],
+            'case_4' => [
+                2,
+                [1, 2, 3, 4],
+                fn($el) => $el % 2 === 0,
+                CALLBACK_USE_VALUE,
+                true,
+            ],
+            'case_5' => [
+                2,
+                [1, 2, 3, 4],
+                fn($el) => $el % 2 === 0,
+                CALLBACK_USE_VALUE,
+                true,
+            ],
+            'case_6' => [
+                4,
+                [1, 2, 3, 4],
+                fn($key) => is_integer($key),
+                CALLBACK_USE_KEY,
+                true,
+            ],
+            'case_7' => [
+                1,
+                ['a' => 1, 'b' => 2, 'c' => 3, 4],
+                fn($v, $key) => is_integer($key) && is_integer($v),
+                CALLBACK_USE_BOTH,
+                true,
+            ]
+        ];
+    }
+
+    /**
+     * @param int $n
+     * @param iterable $items
+     * @param callable $callback
+     * @param int $mode
+     * @param bool $expected
+     * @return void
+     * @dataProvider atLeastProvider
+     */
+    public function testAtLeast(int $n, iterable $items, callable $callback, int $mode, bool $expected): void
+    {
+        $actual = at_least($n, $items, $callback, $mode);
+        $this->assertEquals($expected, $actual);
+    }
+}