Add Collection.reject function

pierredup · pierredup · commit 847c716f24e0 · 2018-04-09T09:30:11.000+02:00
diff --git a/src/Collection/reject.php b/src/Collection/reject.php
@@ -0,0 +1,41 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the SolidWorx Lodash-PHP project.
+ *
+ * @author     Pierre du Plessis <open-source@solidworx.co>
+ * @copyright  Copyright (c) 2017
+ */
+
+namespace _;
+
+use function _\internal\baseIteratee;
+
+/**
+ * The opposite of `filter` this method returns the elements of `collection`
+ * that `predicate` does **not** return truthy for.
+ *
+ * @category Collection
+ *
+ * @param iterable $collection The collection to iterate over.
+ * @param callable $predicate  The function invoked per iteration.
+ *
+ * @return array the new filtered array.
+ *
+ * @example
+ * <code>
+ * $users = [
+ *   ['user' => 'barney', 'active' => true],
+ *   ['user' => 'fred',   'active' => false]
+ * ]
+ *
+ * reject($users, 'active')
+ * // => objects for ['fred']
+ * </code>
+ */
+function reject(iterable $collection, $predicate = null): array
+{
+    return filter($collection, negate(baseIteratee($predicate)));
+}
diff --git a/tests/Collection/RejectTest.php b/tests/Collection/RejectTest.php
@@ -0,0 +1,26 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the SolidWorx Lodash-PHP project.
+ *
+ * @author     Pierre du Plessis <open-source@solidworx.co>
+ * @copyright  Copyright (c) 2017
+ */
+
+use PHPUnit\Framework\TestCase;
+use function _\reject;
+
+class RejectTest extends TestCase
+{
+    public function testReject()
+    {
+        $users = [
+            ['user' => 'barney', 'active' => true],
+            ['user' => 'fred', 'active' => false],
+        ];
+
+        $this->assertSame([['user' => 'fred', 'active' => false]], reject($users, 'active'));
+    }
+}
