Merge pull request #17 from samsonasik/add-limit

[Finder] Add ability to gather only limited found data on Finder::rows()

Author: samsonasik

README.md

@@ -356,4 +356,14 @@ var_dump(Finder::rows(
     $data,
     static fn($datum, $key): bool => $datum > 6 && $key > 1
 )); // [8, 9]
+
+
+// WITH gather only limited found data
+$data = [1, 2];
+$filter = static fn($datum): bool => $datum >= 0;
+$limit = 1;
+
+var_dump(
+    Finder::rows($data, $filter, limit: $limit)
+); // [1]
 ```

src/Finder.php

@@ -123,10 +123,15 @@ public static function last(
      * @param callable(mixed $datum, int|string|null $key=): bool $filter
      * @return mixed[]
      */
-    public static function rows(iterable $data, callable $filter, bool $preserveKey = false): array
-    {
-        $rows   = [];
-        $newKey = 0;
+    public static function rows(
+        iterable $data,
+        callable $filter,
+        bool $preserveKey = false,
+        ?int $limit = null
+    ): array {
+        $rows       = [];
+        $newKey     = 0;
+        $totalFound = 0;
 
         foreach ($data as $key => $datum) {
             $isFound = $filter($datum, $key);
@@ -146,6 +151,15 @@ public static function rows(iterable $data, callable $filter, bool $preserveKey
             }
 
             $rows[$rowKey] = $datum;
+
+            if ($limit === null) {
+                continue;
+            }
+
+            ++$totalFound;
+            if ($totalFound === $limit) {
+                break;
+            }
         }
 
         return $rows;

tests/FinderTest.php

@@ -323,4 +323,17 @@ public static function rowsDataProviderPreserveKey(): array
             ],
         ];
     }
+
+    public function testRowsWithLimit(): void
+    {
+        $data   = [1, 2];
+        $filter = static fn ($datum): bool => $datum >= 0;
+
+        $this->assertSame(
+            [
+                1,
+            ],
+            Finder::rows($data, $filter, limit: 1)
+        );
+    }
 }