Implement anyMatch allMatch and noneMatch for collections (#93)

Author: akondas

src/Collection/Traversable.php

@@ -117,6 +117,62 @@ public function filterNot(callable $predicate)
         });
     }
 
+    /**
+     * Returns true if any element of this collection match the provided predicate.
+     * May not evaluate the predicate on all elements if not necessary for determining the result.
+     *
+     * @param callable(T):bool $predicate
+     */
+    public function anyMatch(callable $predicate): bool
+    {
+        $iterator = $this->getIterator();
+        while ($iterator->hasNext()) {
+            if ($predicate($iterator->next())) {
+                return true;
+            }
+        }
+
+        return false;
+    }
+
+    /**
+     * Returns true if all elements of this collection match the provided predicate.
+     * May not evaluate the predicate on all elements if not necessary for determining the result.
+     * If collection is empty true is returned.
+     *
+     * @param callable(T):bool $predicate
+     */
+    public function allMatch(callable $predicate): bool
+    {
+        $iterator = $this->getIterator();
+        while ($iterator->hasNext()) {
+            if (!$predicate($iterator->next())) {
+                return false;
+            }
+        }
+
+        return true;
+    }
+
+    /**
+     * Returns true if no elements of this collection match the provided predicate.
+     * May not evaluate the predicate on all elements if not necessary for determining the result.
+     * If collection is empty true is returned.
+     *
+     * @param callable(T):bool $predicate
+     */
+    public function noneMatch(callable $predicate): bool
+    {
+        $iterator = $this->getIterator();
+        while ($iterator->hasNext()) {
+            if ($predicate($iterator->next())) {
+                return false;
+            }
+        }
+
+        return true;
+    }
+
     /**
      * Returns true if the two specified collections have no elements in common.
      *

tests/Collection/TraversableTest.php

@@ -115,4 +115,34 @@ public function testCount(): void
 
         self::assertEquals(1, Set::of('munus', 'is', 'awesome')->count(function (string $value) {return strpos($value, 'some') !== false; }));
     }
+
+    public function testAnyMatch(): void
+    {
+        self::assertTrue(GenericList::of(1, 2, 3, 4, 5)->anyMatch(fn (int $v) => $v === 1));
+        self::assertTrue(GenericList::of(1, 2, 3, 4, 5)->anyMatch(fn (int $v) => $v === 3));
+        self::assertTrue(GenericList::of(1, 2, 3, 4, 5)->anyMatch(fn (int $v) => $v === 5));
+
+        self::assertFalse(GenericList::of(1, 2, 3, 4, 5)->anyMatch(fn (int $v) => $v === 0));
+        self::assertFalse(GenericList::empty()->anyMatch(fn (int $v) => $v === 0));
+    }
+
+    public function testAllMatch(): void
+    {
+        self::assertTrue(GenericList::of(2, 4, 6, 8)->allMatch(fn (int $v) => $v % 2 === 0));
+        self::assertTrue(GenericList::of(10, 12, 14, 16)->allMatch(fn (int $v) => $v % 2 === 0));
+        self::assertTrue(GenericList::empty()->allMatch(fn (int $v) => $v % 2 === 1));
+
+        self::assertFalse(GenericList::of(2, 4, 6, 8)->allMatch(fn (int $v) => $v % 2 === 1));
+        self::assertFalse(GenericList::of(0)->allMatch(fn (int $v) => $v % 2 === 1));
+    }
+
+    public function testNoneMatch(): void
+    {
+        self::assertTrue(GenericList::of(2, 4, 6, 8)->noneMatch(fn (int $v) => $v % 2 === 1));
+        self::assertTrue(GenericList::empty()->noneMatch(fn (int $v) => $v % 2 === 1));
+
+        self::assertFalse(GenericList::of(2, 4, 6, 8)->noneMatch(fn (int $v) => $v % 2 === 0));
+        self::assertFalse(GenericList::of(1, 2, 3)->noneMatch(fn (int $v) => $v % 2 === 0));
+        self::assertFalse(GenericList::of(1)->noneMatch(fn (int $v) => $v % 2 === 1));
+    }
 }