feat(support): add partition to array functions

Author: innocenzi

src/Tempest/Support/src/Arr/ManipulatesArray.php

@@ -724,6 +724,30 @@ public function slice(int $offset, ?int $length = null): static
         return $this->createOrModify(namespace\slice($this->value, $offset, $length));
     }
 
+    /**
+     * Returns a pair containing lists for which the given predicate returned `true` and `false`, respectively.
+     *
+     * @param (Closure(T): bool) $predicate
+     *
+     * @return static<array<T>, array<T>>
+     */
+    function partition(Closure $predicate): static
+    {
+        $success = [];
+        $failure = [];
+
+        foreach ($this->value as $value) {
+            if ($predicate($value)) {
+                $success[] = $value;
+                continue;
+            }
+
+            $failure[] = $value;
+        }
+
+        return $this->createOrModify([$success, $failure]);
+    }
+
     /**
      * Executes callback with the given `$value` and returns the same `$value`.
      *

src/Tempest/Support/src/Arr/functions.php

@@ -1145,6 +1145,33 @@ function slice(iterable $array, int $offset, ?int $length = null): array
         return array_slice($array, $offset, $length);
     }
 
+    /**
+     * Returns a pair containing lists for which the given predicate returned `true` and `false`, respectively.
+     *
+     * @template T
+     *
+     * @param iterable<T> $iterable
+     * @param (Closure(T): bool) $predicate
+     *
+     * @return array{0: array<T>, 1: array<T>}
+     */
+    function partition(iterable $iterable, Closure $predicate): array
+    {
+        $success = [];
+        $failure = [];
+
+        foreach ($iterable as $value) {
+            if ($predicate($value)) {
+                $success[] = $value;
+                continue;
+            }
+
+            $failure[] = $value;
+        }
+
+        return [$success, $failure];
+    }
+
     /**
      * Wraps the specified `$input` into an array. If the `$input` is already an array, it is returned.
      * As opposed to {@see \Tempest\Support\Arr\to_array}, this function does not convert {@see Traversable} and {@see Countable} instances to arrays.

src/Tempest/Support/tests/Arr/ManipulatesArrayTest.php

@@ -1786,4 +1786,9 @@ public function test_at(array $input, int $index, mixed $expected, mixed $defaul
         $this->assertSame($expected, arr($input)->at($index, $default));
         $this->assertSame($expected, arr($input)->nth($index, $default));
     }
+
+    public function test_partition(): void
+    {
+        $this->assertSame([[true, true], [false]], arr([true, true, false])->partition(fn (bool $value) => $value === true)->toArray());
+    }
 }