Merge pull request #50 from nreynis/feature/add-includes

Add includes (in_array)

Author: florianeckerstorfer

README.md

@@ -203,6 +203,7 @@ $chain->reduce(function ($current, $value) {
 - `->countValues()`
 - `->every(callable)`
 - `->first()`
+- `->includes(mixed[, array])`
 - `->join([$glue])`
 - `->last()`
 - `->reduce()`

src/Chain.php

@@ -13,6 +13,7 @@
 use Cocur\Chain\Link\Find;
 use Cocur\Chain\Link\FlatMap;
 use Cocur\Chain\Link\Flip;
+use Cocur\Chain\Link\Includes;
 use Cocur\Chain\Link\Intersect;
 use Cocur\Chain\Link\IntersectAssoc;
 use Cocur\Chain\Link\IntersectKey;
@@ -63,6 +64,7 @@ class Chain extends AbstractChain implements Countable
     use First;
     use FlatMap;
     use Flip;
+    use Includes;
     use Intersect;
     use IntersectAssoc;
     use IntersectKey;

src/Link/Includes.php

@@ -0,0 +1,28 @@
+<?php
+
+namespace Cocur\Chain\Link;
+
+/**
+ * Includes.
+ *
+ * @author    Nicolas Reynis
+ */
+trait Includes
+{
+    /**
+     * Returns `true` if the given `needle` is in the array or `false` otherwise.
+     *
+     * @param $needle
+     * @param array $options options, including `strict` to also check the type
+     *
+     * @return bool
+     */
+    public function includes($needle, array $options = []): bool
+    {
+        if (!empty($options['strict'])) {
+            return in_array($needle, $this->array, $options['strict']);
+        } else {
+            return in_array($needle, $this->array);
+        }
+    }
+}

tests/ChainTest.php

@@ -87,6 +87,7 @@ public function chainHasTraits(): void
         $this->assertTrue(method_exists($c, 'first'));
         $this->assertTrue(method_exists($c, 'flatMap'));
         $this->assertTrue(method_exists($c, 'flip'));
+        $this->assertTrue(method_exists($c, 'includes'));
         $this->assertTrue(method_exists($c, 'intersect'));
         $this->assertTrue(method_exists($c, 'intersectAssoc'));
         $this->assertTrue(method_exists($c, 'intersectKey'));

tests/Link/IncludesTest.php

@@ -0,0 +1,38 @@
+<?php
+
+namespace Cocur\Chain\Link;
+
+/**
+ * IncludesTest.
+ *
+ * @author    Nicolas Reynis
+ * @group     unit
+ */
+class IncludesTest extends \PHPUnit\Framework\TestCase
+{
+    /**
+     * @test
+     * @covers \Cocur\Chain\Link\Includes::includes()
+     */
+    public function includesFindElement(): void
+    {
+        /** @var Includes $mock */
+        $mock        = $this->getMockForTrait(Includes::class);
+        $mock->array = ['foobar', 'bar'];
+        $this->assertTrue($mock->includes('bar'));
+        $this->assertFalse($mock->includes('baz'));
+    }
+
+    /**
+     * @test
+     * @covers \Cocur\Chain\Link\Includes::includes()
+     */
+    public function includesFindElementStrictly(): void
+    {
+        /** @var Includes $mock */
+        $mock        = $this->getMockForTrait(Includes::class);
+        $mock->array = ['42', '43'];
+        $this->assertTrue($mock->includes('42', ['strict' => true]));
+        $this->assertFalse($mock->includes(42, ['strict' => true]));
+    }
+}