Merge pull request #21 from vdhicts/feature/contains-any

Add contains any validation rule

Author: dvdheiden

README.md

@@ -46,6 +46,14 @@ Validates if the value contains a certain phrase.
 'field' => [new Contains($needle)],
 ```
 
+### ContainsAny
+
+Validates if the value contains any of the provided phrases.
+
+```php
+'field' => [new ContainsAny(['foo', 'bar'])],
+```
+
 ### DateAfterOrEqual
 
 Validates if the value is a date after or equals the provided date (Carbon).

resources/lang/en/validationRules.php

@@ -3,6 +3,7 @@
 return [
     'bic_number' => 'The :attribute must be a valid BIC number',
     'contains' => 'The :attribute must contain `%s`',
+    'contains_any' => 'The :attribute must contain one of these values: `%s`',
     'date_after_or_equal' => 'The :attribute must be after or equal to `%s`',
     'date_before_or_equal' => 'The :attribute must be before or equal to `%s`',
     'date_has_specific_minutes' => 'The :attribute must have one of :minutes minutes',

resources/lang/nl/validationRules.php

@@ -2,7 +2,7 @@
 
 return [
     'bic_number' => 'Het veld :attribute moet een geldig BIC nummer bevatten',
-    'contains' => 'Het veld :attribute moet `%s` bevatten',
+    'contains_any' => 'Het veld :attribute moet een van deze waardes bevatten: `%s`',
     'date_after_or_equal' => 'Het veld :attribute moet na of op `%s` zijn',
     'date_before_or_equal' => 'Het veld :attribute moet voor of op `%s` zijn',
     'date_has_specific_minutes' => 'Het veld :attribute moet ingesteld zijn op een van :minutes minuten',

src/Rules/ContainsAny.php

@@ -0,0 +1,41 @@
+<?php
+
+namespace Vdhicts\ValidationRules\Rules;
+
+use Illuminate\Contracts\Validation\Rule;
+use Illuminate\Support\Str;
+
+class ContainsAny implements Rule
+{
+    private array $needles;
+
+    public function __construct(array $needles)
+    {
+        $this->needles = $needles;
+    }
+
+    /**
+     * Determine if the validation rule passes.
+     *
+     * @param string $attribute
+     * @param mixed $value
+     * @return bool
+     */
+    public function passes($attribute, $value): bool
+    {
+        return Str::contains($value, $this->needles);
+    }
+
+    /**
+     * Get the validation error message.
+     *
+     * @return string
+     */
+    public function message(): string
+    {
+        return sprintf(
+            __('validationRules.contains_any'),
+            implode(', ', $this->needles)
+        );
+    }
+}

src/Rules/DateHasSpecificMinutes.php

@@ -2,7 +2,7 @@
 
 namespace Vdhicts\ValidationRules\Rules;
 
-use Carbon\Exceptions\InvalidFormatException;
+use Exception;
 use Illuminate\Contracts\Validation\Rule;
 use Illuminate\Support\Carbon;
 
@@ -28,7 +28,7 @@ public function passes($attribute, $value): bool
     {
         try {
             $date = Carbon::createFromFormat($this->format, $value);
-        } catch (InvalidFormatException $exception) {
+        } catch (Exception $exception) {
             return false;
         }
 

tests/Rules/ContainsAnyTest.php

@@ -0,0 +1,24 @@
+<?php
+
+namespace Vdhicts\ValidationRules\Tests\Rules;
+
+use Vdhicts\ValidationRules\Tests\TestCase;
+use Vdhicts\ValidationRules\Rules\ContainsAny;
+
+class ContainsAnyTest extends TestCase
+{
+    public function testRulePasses()
+    {
+        $rule = new ContainsAny(['foo', 'bar']);
+        $this->assertTrue($rule->passes('', 'this is a test to see if foo or bar is in the text'));
+    }
+
+    public function testRuleFails()
+    {
+        $rule = new ContainsAny(['test']);
+        $this->assertFalse($rule->passes('', 'this is a fail'));
+
+        $rule = new ContainsAny(['']);
+        $this->assertFalse($rule->passes('', 'this is a test'));
+    }
+}