feat: Add Every operation.

docs/pages/api.rst

@@ -532,6 +532,25 @@ Signature: ``Collection::duplicate();``
             ->distinct()
             ->normalize() // [0 => 'a', 1 => 'c']
 
+every
+~~~~~
+
+This operation tests whether all elements in the collection pass the test implemented by the provided callback.
+
+Interface: `Everyable`_
+
+Signature: ``Collection::every(callable $callback);``
+
+.. code-block:: php
+
+    $callback = static function ($value): bool {
+        return $value < 20;
+    };
+
+    Collection::fromIterable(range(0, 10))
+        ->every($callback)
+        ->current(); // true
+
 explode
 ~~~~~~~
 

spec/loophp/collection/CollectionSpec.php

@@ -602,6 +602,37 @@ public function it_can_duplicate(): void
             ->shouldIterateAs($result());
     }
 
+    public function it_can_every(): void
+    {
+        $callback = static function ($value): bool {
+            return 20 > $value;
+        };
+
+        $this::fromIterable(range(0, 10))
+            ->every($callback)
+            ->shouldIterateAs([10 => true]);
+
+        $this::empty()
+            ->every($callback)
+            ->shouldIterateAs([0 => true]);
+
+        $this::fromIterable(range(0, 10))
+            ->every(
+                static function ($value, $key, Iterator $iterator): bool {
+                    return is_numeric($key);
+                }
+            )
+            ->shouldIterateAs([10 => true]);
+
+        $this::fromIterable(range(0, 10))
+            ->every(
+                static function ($value, $key, Iterator $iterator): bool {
+                    return $iterator instanceof Iterator;
+                }
+            )
+            ->shouldIterateAs([10 => true]);
+    }
+
     public function it_can_explode(): void
     {
         $string = 'I am just a random piece of text.';

src/Collection.php

@@ -32,6 +32,7 @@
 use loophp\collection\Operation\Drop;
 use loophp\collection\Operation\DropWhile;
 use loophp\collection\Operation\Duplicate;
+use loophp\collection\Operation\Every;
 use loophp\collection\Operation\Explode;
 use loophp\collection\Operation\Falsy;
 use loophp\collection\Operation\Filter;
@@ -369,6 +370,11 @@ public static function empty(): Collection
         return new self();
     }
 
+    public function every(callable $callback): CollectionInterface
+    {
+        return $this->run(Every::of()($callback));
+    }
+
     public function explode(...$explodes): CollectionInterface
     {
         return $this->run(Explode::of()(...$explodes));

src/Contract/Collection.php

@@ -26,6 +26,7 @@
 use loophp\collection\Contract\Operation\Dropable;
 use loophp\collection\Contract\Operation\DropWhileable;
 use loophp\collection\Contract\Operation\Duplicateable;
+use loophp\collection\Contract\Operation\Everyable;
 use loophp\collection\Contract\Operation\Explodeable;
 use loophp\collection\Contract\Operation\Falsyable;
 use loophp\collection\Contract\Operation\Filterable;
@@ -126,6 +127,7 @@
  * @template-extends Dropable<TKey, T>
  * @template-extends DropWhileable<TKey, T>
  * @template-extends Duplicateable<TKey, T>
+ * @template-extends Everyable<TKey, T>
  * @template-extends Explodeable<TKey, T>
  * @template-extends Filterable<TKey, T>
  * @template-extends Firstable<TKey, T>
@@ -214,6 +216,7 @@ interface Collection extends
     Dropable,
     DropWhileable,
     Duplicateable,
+    Everyable,
     Explodeable,
     Falsyable,
     Filterable,

src/Contract/Operation/Everyable.php

@@ -0,0 +1,20 @@
+<?php
+
+declare(strict_types=1);
+
+namespace loophp\collection\Contract\Operation;
+
+use loophp\collection\Contract\Collection;
+
+/**
+ * @psalm-template TKey
+ * @psalm-template TKey of array-key
+ * @psalm-template T of bool
+ */
+interface Everyable
+{
+    /**
+     * @psalm-return \loophp\collection\Contract\Collection<TKey, bool>
+     */
+    public function every(callable $callback): Collection;
+}

src/Operation/Every.php

@@ -0,0 +1,59 @@
+<?php
+
+declare(strict_types=1);
+
+namespace loophp\collection\Operation;
+
+use Closure;
+use Generator;
+use Iterator;
+
+/**
+ * @psalm-template TKey
+ * @psalm-template TKey of array-key
+ * @psalm-template T
+ *
+ * phpcs:disable Generic.Files.LineLength.TooLong
+ */
+final class Every extends AbstractOperation
+{
+    /**
+     * @psalm-return Closure((callable(T, TKey, Iterator<TKey, T>): bool)): Closure(Iterator<TKey, T>): Generator<TKey, bool>
+     */
+    public function __invoke(): Closure
+    {
+        return
+            /**
+             * @psalm-return Closure(Iterator<TKey, T>): Generator<TKey, bool>
+             */
+            static function (callable $callback): Closure {
+                $callbackBuilder =
+                    /**
+                     * @psalm-param callable(T, TKey, Iterator<TKey, T>): bool $callback
+                     */
+                    static function (callable $callback): Closure {
+                        return
+                            /**
+                             * @param mixed $carry
+                             * @psalm-param T $carry
+                             *
+                             * @param mixed $value
+                             * @psalm-param T $value
+                             *
+                             * @param mixed $key
+                             * @psalm-param TKey $key
+                             * @psalm-param Iterator<TKey, T> $iterator
+                             */
+                            static function ($carry, $value, $key, Iterator $iterator) use ($callback): bool {
+                                return $callback($value, $key, $iterator);
+                            };
+                    };
+
+                /** @psalm-var Closure(Iterator<TKey, T>): Generator<TKey, bool> $foldLeft */
+                $foldLeft = FoldLeft::of()($callbackBuilder($callback))(true);
+
+                // Point free style.
+                return $foldLeft;
+            };
+    }
+}