Update the validation engine of filter-based rules

While I migrate them, I also renamed "AbstractFilterRule" to "Filter" because that's a much simpler name, and I would like to stop having "Abstract" and "Interfaces" as part of the name of the classes. Signed-off-by: Henrique Moody <[email protected]>
Respect · Feb 22, 2024 · 692d317 · 692d317
1 parent df378bf
commit 692d317
Show file tree

Hide file tree

Showing 24 changed files with 34 additions and 53 deletions.
diff --git a/library/Rules/Alnum.php b/library/Rules/Alnum.php
@@ -23,9 +23,9 @@
     '{{name}} must not contain letters (a-z), digits (0-9) or {{additionalChars}}',
     self::TEMPLATE_EXTRA,
 )]
-final class Alnum extends AbstractFilterRule
+final class Alnum extends Filter
 {
-    protected function validateFilteredInput(string $input): bool
+    protected function isValid(string $input): bool
     {
         return ctype_alnum($input);
     }

diff --git a/library/Rules/Alpha.php b/library/Rules/Alpha.php
@@ -23,9 +23,9 @@
     '{{name}} must not contain letters (a-z) or {{additionalChars}}',
     self::TEMPLATE_EXTRA,
 )]
-final class Alpha extends AbstractFilterRule
+final class Alpha extends Filter
 {
-    protected function validateFilteredInput(string $input): bool
+    protected function isValid(string $input): bool
     {
         return ctype_alpha($input);
     }

diff --git a/library/Rules/Consonant.php b/library/Rules/Consonant.php
@@ -23,9 +23,9 @@
     '{{name}} must not contain consonants or {{additionalChars}}',
     self::TEMPLATE_EXTRA,
 )]
-final class Consonant extends AbstractFilterRule
+final class Consonant extends Filter
 {
-    protected function validateFilteredInput(string $input): bool
+    protected function isValid(string $input): bool
     {
         return preg_match('/^(\s|[b-df-hj-np-tv-zB-DF-HJ-NP-TV-Z])*$/', $input) > 0;
     }

diff --git a/library/Rules/Control.php b/library/Rules/Control.php
@@ -23,9 +23,9 @@
     '{{name}} must not contain control characters or {{additionalChars}}',
     self::TEMPLATE_EXTRA,
 )]
-final class Control extends AbstractFilterRule
+final class Control extends Filter
 {
-    protected function validateFilteredInput(string $input): bool
+    protected function isValid(string $input): bool
     {
         return ctype_cntrl($input);
     }

diff --git a/library/Rules/Digit.php b/library/Rules/Digit.php
@@ -23,9 +23,9 @@
     '{{name}} must not contain digits (0-9) and {{additionalChars}}',
     self::TEMPLATE_EXTRA,
 )]
-final class Digit extends AbstractFilterRule
+final class Digit extends Filter
 {
-    protected function validateFilteredInput(string $input): bool
+    protected function isValid(string $input): bool
     {
         return ctype_digit($input);
     }

diff --git a/library/Rules/AbstractFilterRule.php → library/Rules/Filter.php b/library/Rules/AbstractFilterRule.php → library/Rules/Filter.php
@@ -9,51 +9,43 @@
 
 namespace Respect\Validation\Rules;
 
+use Respect\Validation\Result;
+
 use function implode;
 use function is_scalar;
 use function str_replace;
 use function str_split;
 
-abstract class AbstractFilterRule extends AbstractRule
+abstract class Filter extends Standard
 {
     public const TEMPLATE_EXTRA = '__extra__';
 
     private readonly string $additionalChars;
 
-    abstract protected function validateFilteredInput(string $input): bool;
+    abstract protected function isValid(string $input): bool;
 
     public function __construct(string ...$additionalChars)
     {
         $this->additionalChars = implode($additionalChars);
     }
 
-    public function validate(mixed $input): bool
+    public function evaluate(mixed $input): Result
     {
+        $template = $this->additionalChars ? self::TEMPLATE_EXTRA : self::TEMPLATE_STANDARD;
+        $parameters = $this->additionalChars ? ['additionalChars' => $this->additionalChars] : [];
         if (!is_scalar($input)) {
-            return false;
+            return Result::failed($input, $this, $template)->withParameters($parameters);
         }
 
         $stringInput = (string) $input;
         if ($stringInput === '') {
-            return false;
+            return Result::failed($input, $this, $template)->withParameters($parameters);
         }
 
         $filteredInput = $this->filter($stringInput);
+        $isValid = $filteredInput === '' || $this->isValid($filteredInput);
 
-        return $filteredInput === '' || $this->validateFilteredInput($filteredInput);
-    }
-
-    /**
-     * @return array<string, mixed>
-     */
-    public function getParams(): array
-    {
-        return ['additionalChars' => $this->additionalChars];
-    }
-
-    protected function getStandardTemplate(mixed $input): string
-    {
-        return $this->additionalChars ? self::TEMPLATE_EXTRA : self::TEMPLATE_STANDARD;
+        return new Result($isValid, $input, $this, $template, $parameters);
     }
 
     private function filter(string $input): string

diff --git a/library/Rules/Graph.php b/library/Rules/Graph.php
@@ -23,9 +23,9 @@
     '{{name}} must not contain graphical characters or {{additionalChars}}',
     self::TEMPLATE_EXTRA,
 )]
-final class Graph extends AbstractFilterRule
+final class Graph extends Filter
 {
-    protected function validateFilteredInput(string $input): bool
+    protected function isValid(string $input): bool
     {
         return ctype_graph($input);
     }

diff --git a/library/Rules/Luhn.php b/library/Rules/Luhn.php
@@ -26,7 +26,7 @@ final class Luhn extends Simple
 {
     public function validate(mixed $input): bool
     {
-        if (!(new Digit())->validate($input)) {
+        if (!(new Digit())->evaluate($input)->isValid) {
             return false;
         }
 

diff --git a/library/Rules/Printable.php b/library/Rules/Printable.php
@@ -23,9 +23,9 @@
     '{{name}} must not contain printable characters or {{additionalChars}}',
     self::TEMPLATE_EXTRA,
 )]
-final class Printable extends AbstractFilterRule
+final class Printable extends Filter
 {
-    protected function validateFilteredInput(string $input): bool
+    protected function isValid(string $input): bool
     {
         return ctype_print($input);
     }

diff --git a/library/Rules/Punct.php b/library/Rules/Punct.php
@@ -23,9 +23,9 @@
     '{{name}} must not contain punctuation characters or {{additionalChars}}',
     self::TEMPLATE_EXTRA,
 )]
-final class Punct extends AbstractFilterRule
+final class Punct extends Filter
 {
-    protected function validateFilteredInput(string $input): bool
+    protected function isValid(string $input): bool
     {
         return ctype_punct($input);
     }

diff --git a/library/Rules/Space.php b/library/Rules/Space.php
@@ -23,9 +23,9 @@
     '{{name}} must not contain space characters or {{additionalChars}}',
     self::TEMPLATE_EXTRA,
 )]
-final class Space extends AbstractFilterRule
+final class Space extends Filter
 {
-    protected function validateFilteredInput(string $input): bool
+    protected function isValid(string $input): bool
     {
         return ctype_space($input);
     }

diff --git a/library/Rules/Vowel.php b/library/Rules/Vowel.php
@@ -23,9 +23,9 @@
     '{{name}} must not contain vowels or {{additionalChars}}',
     self::TEMPLATE_EXTRA,
 )]
-final class Vowel extends AbstractFilterRule
+final class Vowel extends Filter
 {
-    protected function validateFilteredInput(string $input): bool
+    protected function isValid(string $input): bool
     {
         return preg_match('/^[aeiouAEIOU]+$/', $input) > 0;
     }

diff --git a/library/Rules/Xdigit.php b/library/Rules/Xdigit.php
@@ -23,9 +23,9 @@
     '{{name}} must not contain hexadecimal digits or {{additionalChars}}',
     self::TEMPLATE_EXTRA,
 )]
-final class Xdigit extends AbstractFilterRule
+final class Xdigit extends Filter
 {
-    protected function validateFilteredInput(string $input): bool
+    protected function isValid(string $input): bool
     {
         return ctype_xdigit($input);
     }

diff --git a/tests/unit/Rules/AlnumTest.php b/tests/unit/Rules/AlnumTest.php
@@ -15,7 +15,6 @@
 use stdClass;
 
 #[Group('rule')]
-#[CoversClass(AbstractFilterRule::class)]
 #[CoversClass(Alnum::class)]
 final class AlnumTest extends RuleTestCase
 {

diff --git a/tests/unit/Rules/AlphaTest.php b/tests/unit/Rules/AlphaTest.php
@@ -15,7 +15,6 @@
 use stdClass;
 
 #[Group('rule')]
-#[CoversClass(AbstractFilterRule::class)]
 #[CoversClass(Alpha::class)]
 final class AlphaTest extends RuleTestCase
 {

diff --git a/tests/unit/Rules/ConsonantTest.php b/tests/unit/Rules/ConsonantTest.php
@@ -15,7 +15,6 @@
 use stdClass;
 
 #[Group('rule')]
-#[CoversClass(AbstractFilterRule::class)]
 #[CoversClass(Consonant::class)]
 final class ConsonantTest extends RuleTestCase
 {

diff --git a/tests/unit/Rules/ControlTest.php b/tests/unit/Rules/ControlTest.php
@@ -15,7 +15,6 @@
 use stdClass;
 
 #[Group('rule')]
-#[CoversClass(AbstractFilterRule::class)]
 #[CoversClass(Control::class)]
 final class ControlTest extends RuleTestCase
 {

diff --git a/tests/unit/Rules/DigitTest.php b/tests/unit/Rules/DigitTest.php
@@ -14,7 +14,6 @@
 use Respect\Validation\Test\RuleTestCase;
 
 #[Group('rule')]
-#[CoversClass(AbstractFilterRule::class)]
 #[CoversClass(Digit::class)]
 final class DigitTest extends RuleTestCase
 {

diff --git a/tests/unit/Rules/GraphTest.php b/tests/unit/Rules/GraphTest.php
@@ -14,7 +14,6 @@
 use Respect\Validation\Test\RuleTestCase;
 
 #[Group('rule')]
-#[CoversClass(AbstractFilterRule::class)]
 #[CoversClass(Graph::class)]
 final class GraphTest extends RuleTestCase
 {

diff --git a/tests/unit/Rules/PrintableTest.php b/tests/unit/Rules/PrintableTest.php
@@ -16,7 +16,6 @@
 use function chr;
 
 #[Group('rule')]
-#[CoversClass(AbstractFilterRule::class)]
 #[CoversClass(Printable::class)]
 final class PrintableTest extends RuleTestCase
 {

diff --git a/tests/unit/Rules/PunctTest.php b/tests/unit/Rules/PunctTest.php
@@ -14,7 +14,6 @@
 use Respect\Validation\Test\RuleTestCase;
 
 #[Group('rule')]
-#[CoversClass(AbstractFilterRule::class)]
 #[CoversClass(Punct::class)]
 final class PunctTest extends RuleTestCase
 {

diff --git a/tests/unit/Rules/SpaceTest.php b/tests/unit/Rules/SpaceTest.php
@@ -14,7 +14,6 @@
 use Respect\Validation\Test\RuleTestCase;
 
 #[Group('rule')]
-#[CoversClass(AbstractFilterRule::class)]
 #[CoversClass(Space::class)]
 final class SpaceTest extends RuleTestCase
 {

diff --git a/tests/unit/Rules/VowelTest.php b/tests/unit/Rules/VowelTest.php
@@ -14,7 +14,6 @@
 use Respect\Validation\Test\RuleTestCase;
 
 #[Group('rule')]
-#[CoversClass(AbstractFilterRule::class)]
 #[CoversClass(Vowel::class)]
 final class VowelTest extends RuleTestCase
 {

diff --git a/tests/unit/Rules/XdigitTest.php b/tests/unit/Rules/XdigitTest.php
@@ -14,7 +14,6 @@
 use Respect\Validation\Test\RuleTestCase;
 
 #[Group('rule')]
-#[CoversClass(AbstractFilterRule::class)]
 #[CoversClass(Xdigit::class)]
 final class XdigitTest extends RuleTestCase
 {