├── .gitignore
├── .coveralls.yml
├── tests
    ├── TestCase.php
    └── Unit
    │   └── RuleTest.php
├── assets
    └── images
    │   └── laravel-offensive-validation-rule-usage.png
├── .travis.yml
├── composer.json
├── phpunit.xml
├── src
    └── Offensive.php
├── README.md
└── LICENSE


/.gitignore:
--------------------------------------------------------------------------------
1 | vendor/
2 | composer.lock


--------------------------------------------------------------------------------
/.coveralls.yml:
--------------------------------------------------------------------------------
1 | coverage_clover: tests/Logs/clover.xml
2 | json_path: tests/Logs/coveralls-upload.json
3 | service_name: travis-ci


--------------------------------------------------------------------------------
/tests/TestCase.php:
--------------------------------------------------------------------------------
1 | <?php
2 | 
3 | namespace DivineOmega\LaravelOffensiveValidationRule\Tests;
4 | 
5 | class TestCase extends \Orchestra\Testbench\TestCase
6 | {
7 | }
8 | 


--------------------------------------------------------------------------------
/assets/images/laravel-offensive-validation-rule-usage.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/DivineOmega/laravel-offensive-validation-rule/HEAD/assets/images/laravel-offensive-validation-rule-usage.png


--------------------------------------------------------------------------------
/.travis.yml:
--------------------------------------------------------------------------------
 1 | language: php
 2 | dist: trusty
 3 | php:
 4 |   - '7.0'
 5 |   - '7.1'
 6 |   - '7.2'
 7 | install:
 8 |   - composer update
 9 | script:
10 |  - ./vendor/bin/phpunit --coverage-clover ./tests/Logs/clover.xml
11 | after_script:
12 |  - php vendor/bin/php-coveralls -v
13 | 


--------------------------------------------------------------------------------
/composer.json:
--------------------------------------------------------------------------------
 1 | {
 2 |     "name": "divineomega/laravel-offensive-validation-rule",
 3 |     "description": "Laravel validation rule that checks if a string is offensive.",
 4 |     "type": "library",
 5 |     "require": {
 6 |         "laravel/framework": "^5.5||^6.0||^7.0",
 7 |         "divineomega/is_offensive": "^1.4.0"
 8 |     },
 9 |     "require-dev": {
10 |         "orchestra/testbench": "^3.5",
11 |         "phpunit/phpunit": "^6.0",
12 |         "satooshi/php-coveralls": "^2.0"
13 |     },
14 |     "license": "LGPL-3.0-only",
15 |     "authors": [
16 |         {
17 |             "name": "Jordan Hall",
18 |             "email": "jordan@hall05.co.uk"
19 |         }
20 |     ],
21 |     "autoload": {
22 |         "psr-4": {
23 |             "DivineOmega\\LaravelOffensiveValidationRule\\": "./src/"
24 |         }
25 |     },
26 |     "autoload-dev": {
27 |         "psr-4": {
28 |             "DivineOmega\\LaravelOffensiveValidationRule\\Tests\\": "./tests/"
29 |         }
30 |     }
31 | }
32 | 


--------------------------------------------------------------------------------
/phpunit.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="UTF-8"?>
 2 | <phpunit backupGlobals="false"
 3 |          backupStaticAttributes="false"
 4 |          bootstrap="vendor/autoload.php"
 5 |          colors="true"
 6 |          convertErrorsToExceptions="true"
 7 |          convertNoticesToExceptions="true"
 8 |          convertWarningsToExceptions="true"
 9 |          processIsolation="false"
10 |          stopOnFailure="false">
11 |     <testsuites>
12 |         <testsuite name="Unit Tests">
13 |             <directory suffix="Test.php">./tests/Unit</directory>
14 |             <directory suffix="Test.php">./tests/Integration</directory>
15 |         </testsuite>
16 |     </testsuites>
17 |     <filter>
18 |         <whitelist>
19 |             <directory suffix=".php">src</directory>
20 |             <exclude>
21 |                 <directory suffix=".php">src/Examples</directory>
22 |             </exclude>
23 |         </whitelist>
24 |     </filter>
25 |     <php>
26 |         
27 |     </php>
28 | </phpunit>


--------------------------------------------------------------------------------
/src/Offensive.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace DivineOmega\LaravelOffensiveValidationRule;
 4 | 
 5 | use DivineOmega\IsOffensive\OffensiveChecker;
 6 | use Illuminate\Contracts\Validation\Rule;
 7 | 
 8 | class Offensive implements Rule
 9 | {
10 |     private $offensiveChecker;
11 | 
12 |     public function __construct(OffensiveChecker $offensiveChecker = null)
13 |     {
14 |         if (!$offensiveChecker) {
15 |             $offensiveChecker = new OffensiveChecker();
16 |         }
17 | 
18 |         $this->offensiveChecker = $offensiveChecker;
19 |     }
20 | 
21 |     /**
22 |      * Determine if the validation rule passes.
23 |      *
24 |      * @param string $attribute
25 |      * @param mixed  $value
26 |      *
27 |      * @return bool
28 |      */
29 |     public function passes($attribute, $value)
30 |     {
31 |         return !$this->offensiveChecker->isOffensive($value);
32 |     }
33 | 
34 |     /**
35 |      * Get the validation error message.
36 |      *
37 |      * @return string
38 |      */
39 |     public function message()
40 |     {
41 |         return 'This :attribute is not allowed.';
42 |     }
43 | }
44 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # 🤬🤭 Laravel Offensive Validation Rule
 2 | 
 3 | This package provides a Laravel validation rule that checks if a string is offensive. It can be useful
 4 | to check user supplied data that may be publicly displayed, such as usernames or comments. 
 5 | 
 6 | <p align="center"><img src="assets/images/laravel-offensive-validation-rule-usage.png" alt="Laravel Offensive Validation Rule usage"></p>
 7 | 
 8 | <p align="center">
 9 |     <a href="https://travis-ci.org/DivineOmega/laravel-offensive-validation-rule">
10 |         <img src="https://travis-ci.org/DivineOmega/laravel-offensive-validation-rule.svg?branch=master">
11 |     </a>
12 |     <a href='https://coveralls.io/github/DivineOmega/laravel-offensive-validation-rule?branch=master'>
13 |         <img src='https://coveralls.io/repos/github/DivineOmega/laravel-offensive-validation-rule/badge.svg?branch=master' alt='Coverage Status' />
14 |     </a>
15 |     <a href="https://styleci.io/repos/132460621">
16 |         <img src="https://styleci.io/repos/132460621/shield?branch=master" alt="StyleCI">
17 |     </a>
18 | </p>
19 | 
20 | ## Installation
21 | 
22 | To install, just run the following Composer command.
23 | 
24 | ```
25 | composer require divineomega/laravel-offensive-validation-rule
26 | ```
27 | 
28 | Please note that this package requires Laravel 5.5 or above.
29 | 
30 | ## Usage
31 | 
32 | The following code snippet shows an example of how to use the offensive validation rule.
33 | 
34 | ```php
35 | use DivineOmega\LaravelOffensiveValidationRule\Offensive;
36 | 
37 | $request->validate([
38 |     'username' => ['required', new Offensive],
39 | ]);
40 | ```
41 | 
42 | ### Custom word lists
43 | 
44 | If the defaults are too strict (or not strict enough), you can optionally specify a custom list 
45 | of offensive words and custom whitelist. Below is an example of using a custom blacklist and whitelist.
46 | 
47 | ```php
48 | use DivineOmega\LaravelOffensiveValidationRule\Offensive;
49 | use DivineOmega\IsOffensive\OffensiveChecker;
50 | 
51 | $blacklist = ['moist', 'stinky', 'poo'];
52 | $whitelist = ['poop'];
53 | 
54 | $request->validate([
55 |     'username' => ['required', new Offensive(new OffensiveChecker($blacklist, $whitelist))],
56 | ]);
57 | ```
58 | 


--------------------------------------------------------------------------------
/tests/Unit/RuleTest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace DivineOmega\LaravelOffensiveValidationRule\Tests\Unit;
 4 | 
 5 | use DivineOmega\IsOffensive\OffensiveChecker;
 6 | use DivineOmega\LaravelOffensiveValidationRule\Offensive;
 7 | use DivineOmega\LaravelOffensiveValidationRule\Tests\TestCase;
 8 | use Validator;
 9 | 
10 | class RuleTest extends TestCase
11 | {
12 |     private function getValidator($value)
13 |     {
14 |         return Validator::make(['value' => $value], ['value' => new Offensive()]);
15 |     }
16 | 
17 |     public function testOffensiveValues()
18 |     {
19 |         $values = [
20 |             'xxxSexyxxx',
21 |             'Big-s-e-x-y',
22 |             'DICK',
23 |             'shitcrapper500',
24 |             'c-u-n-t-asaurus',
25 |             'm0therfuker',
26 |             'firstFaggot',
27 |             'Sh1tface',
28 |             'Twatter9000',
29 |             'Ultim8Cun7',
30 |         ];
31 | 
32 |         foreach ($values as $value) {
33 |             $this->assertFalse($this->getValidator($value)->passes(), 'Failed asserting that \''.$value.'\' is offensive.');
34 |         }
35 |     }
36 | 
37 |     public function testNotOffensiveValues()
38 |     {
39 |         $values = [
40 |             'test',
41 |             'user',
42 |             'Frank',
43 |             'Francis',
44 |             'apple',
45 |             'orange',
46 |             'bananas',
47 |             'middlesex',
48 |             'scunthorpe',
49 |         ];
50 | 
51 |         foreach ($values as $value) {
52 |             $this->assertTrue($this->getValidator($value)->passes(), 'Failed asserting that \''.$value.'\' is not offensive.');
53 |         }
54 |     }
55 | 
56 |     private function getCustomBlacklistAndWhitelistValidator($value)
57 |     {
58 |         $blacklist = ['moist', 'stinky', 'poo'];
59 |         $whitelist = ['poop'];
60 | 
61 |         return Validator::make(['value' => $value], ['value' => new Offensive(new OffensiveChecker($blacklist, $whitelist))]);
62 |     }
63 | 
64 |     public function testCustomBlacklistAndWhitelist()
65 |     {
66 |         $passingValues = ['cheese', 'poop', 'poops'];
67 |         $failingValues = ['moist', 'moistness', 'stinky', 'poo', 'poos'];
68 | 
69 |         foreach ($passingValues as $value) {
70 |             $this->assertTrue($this->getCustomBlacklistAndWhitelistValidator($value)->passes());
71 |         }
72 | 
73 |         foreach ($failingValues as $value) {
74 |             $this->assertFalse($this->getCustomBlacklistAndWhitelistValidator($value)->passes());
75 |         }
76 |     }
77 | }
78 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
  1 |                    GNU LESSER GENERAL PUBLIC LICENSE
  2 |                        Version 3, 29 June 2007
  3 | 
  4 |  Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
  5 |  Everyone is permitted to copy and distribute verbatim copies
  6 |  of this license document, but changing it is not allowed.
  7 | 
  8 | 
  9 |   This version of the GNU Lesser General Public License incorporates
 10 | the terms and conditions of version 3 of the GNU General Public
 11 | License, supplemented by the additional permissions listed below.
 12 | 
 13 |   0. Additional Definitions.
 14 | 
 15 |   As used herein, "this License" refers to version 3 of the GNU Lesser
 16 | General Public License, and the "GNU GPL" refers to version 3 of the GNU
 17 | General Public License.
 18 | 
 19 |   "The Library" refers to a covered work governed by this License,
 20 | other than an Application or a Combined Work as defined below.
 21 | 
 22 |   An "Application" is any work that makes use of an interface provided
 23 | by the Library, but which is not otherwise based on the Library.
 24 | Defining a subclass of a class defined by the Library is deemed a mode
 25 | of using an interface provided by the Library.
 26 | 
 27 |   A "Combined Work" is a work produced by combining or linking an
 28 | Application with the Library.  The particular version of the Library
 29 | with which the Combined Work was made is also called the "Linked
 30 | Version".
 31 | 
 32 |   The "Minimal Corresponding Source" for a Combined Work means the
 33 | Corresponding Source for the Combined Work, excluding any source code
 34 | for portions of the Combined Work that, considered in isolation, are
 35 | based on the Application, and not on the Linked Version.
 36 | 
 37 |   The "Corresponding Application Code" for a Combined Work means the
 38 | object code and/or source code for the Application, including any data
 39 | and utility programs needed for reproducing the Combined Work from the
 40 | Application, but excluding the System Libraries of the Combined Work.
 41 | 
 42 |   1. Exception to Section 3 of the GNU GPL.
 43 | 
 44 |   You may convey a covered work under sections 3 and 4 of this License
 45 | without being bound by section 3 of the GNU GPL.
 46 | 
 47 |   2. Conveying Modified Versions.
 48 | 
 49 |   If you modify a copy of the Library, and, in your modifications, a
 50 | facility refers to a function or data to be supplied by an Application
 51 | that uses the facility (other than as an argument passed when the
 52 | facility is invoked), then you may convey a copy of the modified
 53 | version:
 54 | 
 55 |    a) under this License, provided that you make a good faith effort to
 56 |    ensure that, in the event an Application does not supply the
 57 |    function or data, the facility still operates, and performs
 58 |    whatever part of its purpose remains meaningful, or
 59 | 
 60 |    b) under the GNU GPL, with none of the additional permissions of
 61 |    this License applicable to that copy.
 62 | 
 63 |   3. Object Code Incorporating Material from Library Header Files.
 64 | 
 65 |   The object code form of an Application may incorporate material from
 66 | a header file that is part of the Library.  You may convey such object
 67 | code under terms of your choice, provided that, if the incorporated
 68 | material is not limited to numerical parameters, data structure
 69 | layouts and accessors, or small macros, inline functions and templates
 70 | (ten or fewer lines in length), you do both of the following:
 71 | 
 72 |    a) Give prominent notice with each copy of the object code that the
 73 |    Library is used in it and that the Library and its use are
 74 |    covered by this License.
 75 | 
 76 |    b) Accompany the object code with a copy of the GNU GPL and this license
 77 |    document.
 78 | 
 79 |   4. Combined Works.
 80 | 
 81 |   You may convey a Combined Work under terms of your choice that,
 82 | taken together, effectively do not restrict modification of the
 83 | portions of the Library contained in the Combined Work and reverse
 84 | engineering for debugging such modifications, if you also do each of
 85 | the following:
 86 | 
 87 |    a) Give prominent notice with each copy of the Combined Work that
 88 |    the Library is used in it and that the Library and its use are
 89 |    covered by this License.
 90 | 
 91 |    b) Accompany the Combined Work with a copy of the GNU GPL and this license
 92 |    document.
 93 | 
 94 |    c) For a Combined Work that displays copyright notices during
 95 |    execution, include the copyright notice for the Library among
 96 |    these notices, as well as a reference directing the user to the
 97 |    copies of the GNU GPL and this license document.
 98 | 
 99 |    d) Do one of the following:
100 | 
101 |        0) Convey the Minimal Corresponding Source under the terms of this
102 |        License, and the Corresponding Application Code in a form
103 |        suitable for, and under terms that permit, the user to
104 |        recombine or relink the Application with a modified version of
105 |        the Linked Version to produce a modified Combined Work, in the
106 |        manner specified by section 6 of the GNU GPL for conveying
107 |        Corresponding Source.
108 | 
109 |        1) Use a suitable shared library mechanism for linking with the
110 |        Library.  A suitable mechanism is one that (a) uses at run time
111 |        a copy of the Library already present on the user's computer
112 |        system, and (b) will operate properly with a modified version
113 |        of the Library that is interface-compatible with the Linked
114 |        Version.
115 | 
116 |    e) Provide Installation Information, but only if you would otherwise
117 |    be required to provide such information under section 6 of the
118 |    GNU GPL, and only to the extent that such information is
119 |    necessary to install and execute a modified version of the
120 |    Combined Work produced by recombining or relinking the
121 |    Application with a modified version of the Linked Version. (If
122 |    you use option 4d0, the Installation Information must accompany
123 |    the Minimal Corresponding Source and Corresponding Application
124 |    Code. If you use option 4d1, you must provide the Installation
125 |    Information in the manner specified by section 6 of the GNU GPL
126 |    for conveying Corresponding Source.)
127 | 
128 |   5. Combined Libraries.
129 | 
130 |   You may place library facilities that are a work based on the
131 | Library side by side in a single library together with other library
132 | facilities that are not Applications and are not covered by this
133 | License, and convey such a combined library under terms of your
134 | choice, if you do both of the following:
135 | 
136 |    a) Accompany the combined library with a copy of the same work based
137 |    on the Library, uncombined with any other library facilities,
138 |    conveyed under the terms of this License.
139 | 
140 |    b) Give prominent notice with the combined library that part of it
141 |    is a work based on the Library, and explaining where to find the
142 |    accompanying uncombined form of the same work.
143 | 
144 |   6. Revised Versions of the GNU Lesser General Public License.
145 | 
146 |   The Free Software Foundation may publish revised and/or new versions
147 | of the GNU Lesser General Public License from time to time. Such new
148 | versions will be similar in spirit to the present version, but may
149 | differ in detail to address new problems or concerns.
150 | 
151 |   Each version is given a distinguishing version number. If the
152 | Library as you received it specifies that a certain numbered version
153 | of the GNU Lesser General Public License "or any later version"
154 | applies to it, you have the option of following the terms and
155 | conditions either of that published version or of any later version
156 | published by the Free Software Foundation. If the Library as you
157 | received it does not specify a version number of the GNU Lesser
158 | General Public License, you may choose any version of the GNU Lesser
159 | General Public License ever published by the Free Software Foundation.
160 | 
161 |   If the Library as you received it specifies that a proxy can decide
162 | whether future versions of the GNU Lesser General Public License shall
163 | apply, that proxy's public statement of acceptance of any version is
164 | permanent authorization for you to choose that version for the
165 | Library.
166 | 


--------------------------------------------------------------------------------