Allow customising offensive word blacklist and whitelist - closes #2

Author: DivineOmega

README.md

@@ -38,3 +38,20 @@ $request->validate([
     'username' => ['required', new Offensive],
 ]);
 ```
+
+### Custom word lists
+
+If the defaults are too strict (or not strict enough), you can optionally specify a custom list 
+of offensive words and custom whitelist. Below is an example of using a custom blacklist and whitelist.
+
+```php
+use DivineOmega\LaravelOffensiveValidationRule\Offensive;
+use DivineOmega\IsOffensive\OffensiveChecker;
+
+$blacklist = ['moist', 'stinky', 'poo'];
+$whitelist = ['poop'];
+
+$request->validate([
+    'username' => ['required', new Offensive(new OffensiveChecker($blacklist, $whitelist))],
+]);
+```

composer.json

@@ -4,7 +4,7 @@
     "type": "library",
     "require": {
         "illuminate/contracts": "^5.5",
-        "divineomega/is_offensive": "^1.3.2"
+        "divineomega/is_offensive": "^1.4.0"
     },
     "require-dev": {
         "orchestra/testbench": "^3.5",

tests/Unit/RuleTest.php

@@ -2,6 +2,7 @@
 
 namespace DivineOmega\LaravelOffensiveValidationRule\Tests\Unit;
 
+use DivineOmega\IsOffensive\OffensiveChecker;
 use DivineOmega\LaravelOffensiveValidationRule\Offensive;
 use DivineOmega\LaravelOffensiveValidationRule\Tests\TestCase;
 use Validator;
@@ -51,4 +52,27 @@ public function testNotOffensiveValues()
             $this->assertTrue($this->getValidator($value)->passes(), 'Failed asserting that \''.$value.'\' is not offensive.');
         }
     }
+
+    private function getCustomBlacklistAndWhitelistValidator($value)
+    {
+        $blacklist = ['moist', 'stinky', 'poo'];
+        $whitelist = ['poop'];
+
+        return Validator::make(['value' => $value], ['value' => new Offensive(new OffensiveChecker($blacklist, $whitelist))]);
+    }
+
+    public function testCustomBlacklistAndWhitelist()
+    {
+        $passingValues = ['cheese', 'poop', 'poops'];
+        $failingValues = ['moist', 'moistness', 'stinky', 'poo', 'poos'];
+
+        foreach($passingValues as $value) {
+            $this->assertTrue($this->getCustomBlacklistAndWhitelistValidator($value)->passes());
+        }
+
+        foreach($failingValues as $value) {
+            $this->assertFalse($this->getCustomBlacklistAndWhitelistValidator($value)->passes());
+        }
+
+    }
 }