add contains method

Author: modethirteen

NOTICE

@@ -1,4 +1,4 @@
-modethirteen.php
+TypeEx
 Copyright 2020 James Andrew Vaughn <[email protected]> (https://modethirteen.com)
 
 This project includes software developed at MindTouch, Inc. <[email protected]> (https://mindtouch.com)

_bootstrap.php

@@ -1,6 +1,6 @@
 <?php declare(strict_types=1);
 /**
- * modethirteen.php
+ * TypeEx
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

src/StringEx.php

@@ -1,6 +1,6 @@
 <?php declare(strict_types=1);
 /**
- * modethirteen.php
+ * TypeEx
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -93,6 +93,24 @@ public function __construct(string $string) {
         $this->string = $string;
     }
 
+    /**
+     * @note when comparing a string array, returns true if one or more values match
+     * @param string|string[] $needle
+     * @return bool
+     */
+    public function contains($needle) : bool {
+        if(is_array($needle)) {
+            foreach($needle as $n) {
+                $pos = strpos($this->string, self::stringify($n));
+                if($pos !== false) {
+                    return true;
+                }
+            }
+            return false;
+        }
+        return strpos($this->string, self::stringify($needle)) !== false;
+    }
+
     /**
      * @param string $needle
      * @return bool

tests/StringEx/contains_Test.php

@@ -0,0 +1,62 @@
+<?php declare(strict_types=1);
+/**
+ * TypeEx
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+namespace modethirteen\TypeEx\Tests\StringEx;
+
+use modethirteen\TypeEx\StringEx;
+use PHPUnit\Framework\TestCase;
+
+class contains_Test extends TestCase  {
+
+    /**
+     * @return array
+     */
+    public static function string_value_expected_Provider() : array {
+        return [
+            ['foo', 'foo', true],
+            ['foo', 'f', true],
+            ['foo', 'o', true],
+            ['foo', 'oo', true],
+            ['foo bar', 'bar', true],
+            ['foo bar', ' ', true],
+            ['foo bar', 'foo', true],
+            ['foo', 'bar', false],
+            ['foo', 'boo', false],
+            ['foo', ['foo', 'f', 'o', 'oo'], true],
+            ['foo bar', ['foo', 'bar'], true],
+            ['foo bar', ['foo', ' '], true],
+            ['foo bar', ['foo'], true],
+            ['foo', ['foo', 'bar'], true],
+            ['foo', ['boo'], false]
+        ];
+    }
+
+    /**
+     * @dataProvider string_value_expected_Provider
+     * @test
+     * @param string $string
+     * @param mixed $value
+     * @param bool $expected
+     */
+    public function String_contains(string $string, $value, bool $expected) : void {
+
+        // act
+        $result = (new StringEx($string))->contains($value);
+
+        // assert
+        static::assertEquals($expected, $result);
+    }
+}

tests/StringEx/endsWithInvariantCase_Test.php

@@ -1,6 +1,6 @@
 <?php declare(strict_types=1);
 /**
- * modethirteen.php
+ * TypeEx
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

tests/StringEx/endsWith_Test.php

@@ -1,6 +1,6 @@
 <?php declare(strict_types=1);
 /**
- * modethirteen.php
+ * TypeEx
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

tests/StringEx/isNullOrEmpty_Test.php

@@ -1,6 +1,6 @@
 <?php declare(strict_types=1);
 /**
- * modethirteen.php
+ * TypeEx
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

tests/StringEx/startsWithInvariantCase_Test.php

@@ -1,6 +1,6 @@
 <?php declare(strict_types=1);
 /**
- * modethirteen.php
+ * TypeEx
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

tests/StringEx/startsWith_Test.php

@@ -1,6 +1,6 @@
 <?php declare(strict_types=1);
 /**
- * modethirteen.php
+ * TypeEx
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

tests/StringEx/stringify_Test.php

@@ -1,6 +1,6 @@
 <?php declare(strict_types=1);
 /**
- * modethirteen.php
+ * TypeEx
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.