Move template definitions to the rules

It's easier to identify the reason for choosing a specific message in the rule than in the exception. The same goes for the key we use to determine the templates. This change will simplify the `ValidationException` because it will already receive the template it needs to use. As a consequence, the `Factory` also becomes more straightforward. Signed-off-by: Henrique Moody <[email protected]>
Respect · Jan 29, 2024 · dd896bb · dd896bb
1 parent 3334529
commit dd896bb
Show file tree

Hide file tree

Showing 181 changed files with 1,042 additions and 680 deletions.
diff --git a/library/Exceptions/AllOfException.php b/library/Exceptions/AllOfException.php
@@ -24,9 +24,4 @@ class AllOfException extends GroupedValidationException
             self::SOME => 'These rules must not pass for {{name}}',
         ],
     ];
-
-    protected function chooseTemplate(): string
-    {
-        return self::SOME;
-    }
 }
diff --git a/library/Exceptions/AlnumException.php b/library/Exceptions/AlnumException.php
@@ -9,19 +9,22 @@
 
 namespace Respect\Validation\Exceptions;
 
+use Respect\Validation\Rules\AbstractFilterRule as Filter;
+use Respect\Validation\Validatable;
+
 final class AlnumException extends FilteredValidationException
 {
     /**
      * @var array<string, array<string, string>>
      */
     protected array $defaultTemplates = [
         self::MODE_DEFAULT => [
-            self::STANDARD => '{{name}} must contain only letters (a-z) and digits (0-9)',
-            self::EXTRA => '{{name}} must contain only letters (a-z), digits (0-9) and {{additionalChars}}',
+            Validatable::TEMPLATE_STANDARD => '{{name}} must contain only letters (a-z) and digits (0-9)',
+            Filter::TEMPLATE_EXTRA => '{{name}} must contain only letters (a-z), digits (0-9) and {{additionalChars}}',
         ],
         self::MODE_NEGATIVE => [
-            self::STANDARD => '{{name}} must not contain letters (a-z) or digits (0-9)',
-            self::EXTRA => '{{name}} must not contain letters (a-z), digits (0-9) or {{additionalChars}}',
+            Validatable::TEMPLATE_STANDARD => '{{name}} must not contain letters (a-z) or digits (0-9)',
+            Filter::TEMPLATE_EXTRA => '{{name}} must not contain letters (a-z), digits (0-9) or {{additionalChars}}',
         ],
     ];
 }
diff --git a/library/Exceptions/AlphaException.php b/library/Exceptions/AlphaException.php
@@ -9,19 +9,22 @@
 
 namespace Respect\Validation\Exceptions;
 
+use Respect\Validation\Rules\AbstractFilterRule;
+use Respect\Validation\Validatable;
+
 final class AlphaException extends FilteredValidationException
 {
     /**
      * @var array<string, array<string, string>>
      */
     protected array $defaultTemplates = [
         self::MODE_DEFAULT => [
-            self::STANDARD => '{{name}} must contain only letters (a-z)',
-            self::EXTRA => '{{name}} must contain only letters (a-z) and {{additionalChars}}',
+            Validatable::TEMPLATE_STANDARD => '{{name}} must contain only letters (a-z)',
+            AbstractFilterRule::TEMPLATE_EXTRA => '{{name}} must contain only letters (a-z) and {{additionalChars}}',
         ],
         self::MODE_NEGATIVE => [
-            self::STANDARD => '{{name}} must not contain letters (a-z)',
-            self::EXTRA => '{{name}} must not contain letters (a-z) or {{additionalChars}}',
+            Validatable::TEMPLATE_STANDARD => '{{name}} must not contain letters (a-z)',
+            AbstractFilterRule::TEMPLATE_EXTRA => '{{name}} must not contain letters (a-z) or {{additionalChars}}',
         ],
     ];
 }
diff --git a/library/Exceptions/AlwaysInvalidException.php b/library/Exceptions/AlwaysInvalidException.php
@@ -9,6 +9,8 @@
 
 namespace Respect\Validation\Exceptions;
 
+use Respect\Validation\Validatable;
+
 final class AlwaysInvalidException extends ValidationException
 {
     public const SIMPLE = 'simple';
@@ -18,11 +20,11 @@ final class AlwaysInvalidException extends ValidationException
      */
     protected array $defaultTemplates = [
         self::MODE_DEFAULT => [
-            self::STANDARD => '{{name}} is always invalid',
+            Validatable::TEMPLATE_STANDARD => '{{name}} is always invalid',
             self::SIMPLE => '{{name}} is not valid',
         ],
         self::MODE_NEGATIVE => [
-            self::STANDARD => '{{name}} is always valid',
+            Validatable::TEMPLATE_STANDARD => '{{name}} is always valid',
             self::SIMPLE => '{{name}} is valid',
         ],
     ];

diff --git a/library/Exceptions/AlwaysValidException.php b/library/Exceptions/AlwaysValidException.php
@@ -9,17 +9,19 @@
 
 namespace Respect\Validation\Exceptions;
 
+use Respect\Validation\Validatable;
+
 final class AlwaysValidException extends ValidationException
 {
     /**
      * @var array<string, array<string, string>>
      */
     protected array $defaultTemplates = [
         self::MODE_DEFAULT => [
-            self::STANDARD => '{{name}} is always valid',
+            Validatable::TEMPLATE_STANDARD => '{{name}} is always valid',
         ],
         self::MODE_NEGATIVE => [
-            self::STANDARD => '{{name}} is always invalid',
+            Validatable::TEMPLATE_STANDARD => '{{name}} is always invalid',
         ],
     ];
 }
diff --git a/library/Exceptions/AnyOfException.php b/library/Exceptions/AnyOfException.php
@@ -9,17 +9,19 @@
 
 namespace Respect\Validation\Exceptions;
 
+use Respect\Validation\Validatable;
+
 final class AnyOfException extends NestedValidationException
 {
     /**
      * @var array<string, array<string, string>>
      */
     protected array $defaultTemplates = [
         self::MODE_DEFAULT => [
-            self::STANDARD => 'At least one of these rules must pass for {{name}}',
+            Validatable::TEMPLATE_STANDARD => 'At least one of these rules must pass for {{name}}',
         ],
         self::MODE_NEGATIVE => [
-            self::STANDARD => 'At least one of these rules must not pass for {{name}}',
+            Validatable::TEMPLATE_STANDARD => 'At least one of these rules must not pass for {{name}}',
         ],
     ];
 }
diff --git a/library/Exceptions/ArrayTypeException.php b/library/Exceptions/ArrayTypeException.php
@@ -9,17 +9,19 @@
 
 namespace Respect\Validation\Exceptions;
 
+use Respect\Validation\Validatable;
+
 final class ArrayTypeException extends ValidationException
 {
     /**
      * @var array<string, array<string, string>>
      */
     protected array $defaultTemplates = [
         self::MODE_DEFAULT => [
-            self::STANDARD => '{{name}} must be of type array',
+            Validatable::TEMPLATE_STANDARD => '{{name}} must be of type array',
         ],
         self::MODE_NEGATIVE => [
-            self::STANDARD => '{{name}} must not be of type array',
+            Validatable::TEMPLATE_STANDARD => '{{name}} must not be of type array',
         ],
     ];
 }
diff --git a/library/Exceptions/ArrayValException.php b/library/Exceptions/ArrayValException.php
@@ -9,17 +9,19 @@
 
 namespace Respect\Validation\Exceptions;
 
+use Respect\Validation\Validatable;
+
 final class ArrayValException extends ValidationException
 {
     /**
      * @var array<string, array<string, string>>
      */
     protected array $defaultTemplates = [
         self::MODE_DEFAULT => [
-            self::STANDARD => '{{name}} must be an array value',
+            Validatable::TEMPLATE_STANDARD => '{{name}} must be an array value',
         ],
         self::MODE_NEGATIVE => [
-            self::STANDARD => '{{name}} must not be an array value',
+            Validatable::TEMPLATE_STANDARD => '{{name}} must not be an array value',
         ],
     ];
 }
diff --git a/library/Exceptions/Base64Exception.php b/library/Exceptions/Base64Exception.php
@@ -9,17 +9,19 @@
 
 namespace Respect\Validation\Exceptions;
 
+use Respect\Validation\Validatable;
+
 final class Base64Exception extends ValidationException
 {
     /**
      * @var array<string, array<string, string>>
      */
     protected array $defaultTemplates = [
         self::MODE_DEFAULT => [
-            self::STANDARD => '{{name}} must be Base64-encoded',
+            Validatable::TEMPLATE_STANDARD => '{{name}} must be Base64-encoded',
         ],
         self::MODE_NEGATIVE => [
-            self::STANDARD => '{{name}} must not be Base64-encoded',
+            Validatable::TEMPLATE_STANDARD => '{{name}} must not be Base64-encoded',
         ],
     ];
 }
diff --git a/library/Exceptions/BaseException.php b/library/Exceptions/BaseException.php
@@ -9,17 +9,19 @@
 
 namespace Respect\Validation\Exceptions;
 
+use Respect\Validation\Validatable;
+
 final class BaseException extends ValidationException
 {
     /**
      * @var array<string, array<string, string>>
      */
     protected array $defaultTemplates = [
         self::MODE_DEFAULT => [
-            self::STANDARD => '{{name}} must be a number in the base {{base}}',
+            Validatable::TEMPLATE_STANDARD => '{{name}} must be a number in the base {{base}}',
         ],
         self::MODE_NEGATIVE => [
-            self::STANDARD => '{{name}} must not be a number in the base {{base}}',
+            Validatable::TEMPLATE_STANDARD => '{{name}} must not be a number in the base {{base}}',
         ],
     ];
 }
diff --git a/library/Exceptions/BetweenException.php b/library/Exceptions/BetweenException.php
@@ -9,17 +9,19 @@
 
 namespace Respect\Validation\Exceptions;
 
+use Respect\Validation\Validatable;
+
 final class BetweenException extends NestedValidationException
 {
     /**
      * @var array<string, array<string, string>>
      */
     protected array $defaultTemplates = [
         self::MODE_DEFAULT => [
-            self::STANDARD => '{{name}} must be between {{minValue}} and {{maxValue}}',
+            Validatable::TEMPLATE_STANDARD => '{{name}} must be between {{minValue}} and {{maxValue}}',
         ],
         self::MODE_NEGATIVE => [
-            self::STANDARD => '{{name}} must not be between {{minValue}} and {{maxValue}}',
+            Validatable::TEMPLATE_STANDARD => '{{name}} must not be between {{minValue}} and {{maxValue}}',
         ],
     ];
 }
diff --git a/library/Exceptions/BoolTypeException.php b/library/Exceptions/BoolTypeException.php
@@ -9,17 +9,19 @@
 
 namespace Respect\Validation\Exceptions;
 
+use Respect\Validation\Validatable;
+
 final class BoolTypeException extends ValidationException
 {
     /**
      * @var array<string, array<string, string>>
      */
     protected array $defaultTemplates = [
         self::MODE_DEFAULT => [
-            self::STANDARD => '{{name}} must be of type boolean',
+            Validatable::TEMPLATE_STANDARD => '{{name}} must be of type boolean',
         ],
         self::MODE_NEGATIVE => [
-            self::STANDARD => '{{name}} must not be of type boolean',
+            Validatable::TEMPLATE_STANDARD => '{{name}} must not be of type boolean',
         ],
     ];
 }
diff --git a/library/Exceptions/BoolValException.php b/library/Exceptions/BoolValException.php
@@ -9,17 +9,19 @@
 
 namespace Respect\Validation\Exceptions;
 
+use Respect\Validation\Validatable;
+
 final class BoolValException extends ValidationException
 {
     /**
      * @var array<string, array<string, string>>
      */
     protected array $defaultTemplates = [
         self::MODE_DEFAULT => [
-            self::STANDARD => '{{name}} must be a boolean value',
+            Validatable::TEMPLATE_STANDARD => '{{name}} must be a boolean value',
         ],
         self::MODE_NEGATIVE => [
-            self::STANDARD => '{{name}} must not be a boolean value',
+            Validatable::TEMPLATE_STANDARD => '{{name}} must not be a boolean value',
         ],
     ];
 }
diff --git a/library/Exceptions/BsnException.php b/library/Exceptions/BsnException.php
@@ -9,17 +9,19 @@
 
 namespace Respect\Validation\Exceptions;
 
+use Respect\Validation\Validatable;
+
 final class BsnException extends ValidationException
 {
     /**
      * @var array<string, array<string, string>>
      */
     protected array $defaultTemplates = [
         self::MODE_DEFAULT => [
-            self::STANDARD => '{{name}} must be a BSN',
+            Validatable::TEMPLATE_STANDARD => '{{name}} must be a BSN',
         ],
         self::MODE_NEGATIVE => [
-            self::STANDARD => '{{name}} must not be a BSN',
+            Validatable::TEMPLATE_STANDARD => '{{name}} must not be a BSN',
         ],
     ];
 }
diff --git a/library/Exceptions/CallException.php b/library/Exceptions/CallException.php
@@ -9,17 +9,19 @@
 
 namespace Respect\Validation\Exceptions;
 
+use Respect\Validation\Validatable;
+
 final class CallException extends NestedValidationException
 {
     /**
      * @var array<string, array<string, string>>
      */
     protected array $defaultTemplates = [
         self::MODE_DEFAULT => [
-            self::STANDARD => '{{input}} must be valid when executed with {{callable}}',
+            Validatable::TEMPLATE_STANDARD => '{{input}} must be valid when executed with {{callable}}',
         ],
         self::MODE_NEGATIVE => [
-            self::STANDARD => '{{input}} must not be valid when executed with {{callable}}',
+            Validatable::TEMPLATE_STANDARD => '{{input}} must not be valid when executed with {{callable}}',
         ],
     ];
 }
diff --git a/library/Exceptions/CallableTypeException.php b/library/Exceptions/CallableTypeException.php
@@ -9,17 +9,19 @@
 
 namespace Respect\Validation\Exceptions;
 
+use Respect\Validation\Validatable;
+
 final class CallableTypeException extends ValidationException
 {
     /**
      * @var array<string, array<string, string>>
      */
     protected array $defaultTemplates = [
         self::MODE_DEFAULT => [
-            self::STANDARD => '{{name}} must be callable',
+            Validatable::TEMPLATE_STANDARD => '{{name}} must be callable',
         ],
         self::MODE_NEGATIVE => [
-            self::STANDARD => '{{name}} must not be callable',
+            Validatable::TEMPLATE_STANDARD => '{{name}} must not be callable',
         ],
     ];
 }
diff --git a/library/Exceptions/CharsetException.php b/library/Exceptions/CharsetException.php
@@ -9,17 +9,19 @@
 
 namespace Respect\Validation\Exceptions;
 
+use Respect\Validation\Validatable;
+
 final class CharsetException extends ValidationException
 {
     /**
      * @var array<string, array<string, string>>
      */
     protected array $defaultTemplates = [
         self::MODE_DEFAULT => [
-            self::STANDARD => '{{name}} must be in the {{charset}} charset',
+            Validatable::TEMPLATE_STANDARD => '{{name}} must be in the {{charset}} charset',
         ],
         self::MODE_NEGATIVE => [
-            self::STANDARD => '{{name}} must not be in the {{charset}} charset',
+            Validatable::TEMPLATE_STANDARD => '{{name}} must not be in the {{charset}} charset',
         ],
     ];
 }
diff --git a/library/Exceptions/CnhException.php b/library/Exceptions/CnhException.php
@@ -9,17 +9,19 @@
 
 namespace Respect\Validation\Exceptions;
 
+use Respect\Validation\Validatable;
+
 final class CnhException extends ValidationException
 {
     /**
      * @var array<string, array<string, string>>
      */
     protected array $defaultTemplates = [
         self::MODE_DEFAULT => [
-            self::STANDARD => '{{name}} must be a valid CNH number',
+            Validatable::TEMPLATE_STANDARD => '{{name}} must be a valid CNH number',
         ],
         self::MODE_NEGATIVE => [
-            self::STANDARD => '{{name}} must not be a valid CNH number',
+            Validatable::TEMPLATE_STANDARD => '{{name}} must not be a valid CNH number',
         ],
     ];
 }