feat: set assert name parameter as optional and improved error messages

Author: andrepimpao

src/ChainedValidatorInterface.php

@@ -12,15 +12,15 @@ public function choice(
         bool $multiple = false,
         ?int $minConstraint = null,
         ?int $maxConstraint = null,
-        string $message = 'The "{{ name }}" value is not a valid choice, "{{ value }}" given. Accepted values are: "{{ constraints }}".',
-        string $multipleMessage = 'The "{{ name }}" value has one or more invalid choices, "{{ value }}" given. Accepted values are: "{{ constraints }}".',
-        string $minMessage = 'The "{{ name }}" value must have at least {{ minConstraint }} choices, {{ numValues }} choices given.',
-        string $maxMessage = 'The "{{ name }}" value must have at most {{ maxConstraint }} choices, {{ numValues }} choices given.'
+        string $message = 'The {{ name }} value is not a valid choice, {{ value }} given. Accepted values are: {{ constraints }}.',
+        string $multipleMessage = 'The {{ name }} value has one or more invalid choices, {{ value }} given. Accepted values are: {{ constraints }}.',
+        string $minMessage = 'The {{ name }} value must have at least {{ minConstraint }} choices, {{ numValues }} choices given.',
+        string $maxMessage = 'The {{ name }} value must have at most {{ maxConstraint }} choices, {{ numValues }} choices given.'
     ): ChainedValidatorInterface&Validator;
 
     public function country(
         string $code = 'alpha-2',
-        string $message = 'The "{{ name }}" value is not a valid "{{ code }}" country code, "{{ value }}" given.'
+        string $message = 'The {{ name }} value is not a valid {{ code }} country code, {{ value }} given.'
     ): ChainedValidatorInterface&Validator;
 
     public function eachKey(
@@ -30,38 +30,38 @@ public function eachKey(
 
     public function eachValue(
         Validator $validator,
-        string $message = 'At key "{{ key }}": {{ message }}'
+        string $message = 'At key {{ key }}: {{ message }}'
     ): ChainedValidatorInterface&Validator;
 
     public function greaterThan(
         mixed $constraint,
-        string $message = 'The "{{ name }}" value should be greater than "{{ constraint }}", "{{ value }}" given.'
+        string $message = 'The {{ name }} value should be greater than {{ constraint }}, {{ value }} given.'
     ): ChainedValidatorInterface&Validator;
 
     public function greaterThanOrEqual(
         mixed $constraint,
-        string $message = 'The "{{ name }}" value should be greater than or equal to "{{ constraint }}", "{{ value }}" given.'
+        string $message = 'The {{ name }} value should be greater than or equal to {{ constraint }}, {{ value }} given.'
     ): ChainedValidatorInterface&Validator;
 
     public function lessThan(
         mixed $constraint,
-        string $message = 'The "{{ name }}" value should be less than "{{ constraint }}", "{{ value }}" given.'
+        string $message = 'The {{ name }} value should be less than {{ constraint }}, {{ value }} given.'
     ): ChainedValidatorInterface&Validator;
 
     public function lessThanOrEqual(
         mixed $constraint,
-        string $message = 'The "{{ name }}" value should be less than or equal to "{{ constraint }}", "{{ value }}" given.'
+        string $message = 'The {{ name }} value should be less than or equal to {{ constraint }}, {{ value }} given.'
     ): ChainedValidatorInterface&Validator;
 
     public function notBlank(
         ?callable $normalizer = null,
-        string $message = 'The "{{ name }}" value should not be blank, "{{ value }}" given.'
+        string $message = 'The {{ name }} value should not be blank, {{ value }} given.'
     ): ChainedValidatorInterface&Validator;
 
     public function range(
         mixed $minConstraint,
         mixed $maxConstraint,
-        string $message = 'The "{{ name }}" value should be between "{{ minConstraint }}" and "{{ maxConstraint }}", "{{ value }}" given.'
+        string $message = 'The {{ name }} value should be between {{ minConstraint }} and {{ maxConstraint }}, {{ value }} given.'
     ): ChainedValidatorInterface&Validator;
 
     public function rule(
@@ -71,11 +71,11 @@ public function rule(
     public function timezone(
         int $timezoneGroup = \DateTimeZone::ALL,
         ?string $countryCode = null,
-        string $message = 'The "{{ name }}" value is not a valid timezone, "{{ value }}" given.'
+        string $message = 'The {{ name }} value is not a valid timezone, {{ value }} given.'
     ): ChainedValidatorInterface&Validator;
 
     public function type(
         string|array $constraint,
-        string $message = 'The "{{ name }}" value should be of type "{{ constraint }}", "{{ value }}" given.'
+        string $message = 'The {{ name }} value should be of type {{ constraint }}, {{ value }} given.'
     ): ChainedValidatorInterface&Validator;
 }

src/Exception/ValidationException.php

@@ -7,13 +7,25 @@ class ValidationException extends \Exception
     public function __construct(string $message, array $parameters = [])
     {
         $message = $this->formatMessage($message, $parameters);
+
         parent::__construct($message);
     }
 
     private function formatMessage(string $message, array $parameters = []): string
     {
+        // If a name was not given, remove it from the message template but keep it intuitive
+        if (empty($parameters['name'])) {
+            $message = \str_replace(' {{ name }} ', ' ', $message);
+            unset($parameters['name']);
+        }
+
         foreach ($parameters as $parameter => $value) {
-            $message = str_replace("{{ $parameter }}", $this->formatValue($value), $message);
+            // Format values (with some exceptions [name, message] to avoid adding unnecessary quotation marks)
+            $message = \str_replace(
+                \sprintf('{{ %s }}', $parameter),
+                (\in_array($parameter, ['name', 'message'])) ? $value : $this->formatValue($value),
+                $message
+            );
         }
 
         return $message;
@@ -39,7 +51,9 @@ private function formatValue(mixed $value): string
 
         if (\is_string($value)) {
             // Replace line breaks and tabs with single space
-            return str_replace(["\n", "\r", "\t", "\v", "\x00"], ' ', $value);
+            $value = \str_replace(["\n", "\r", "\t", "\v", "\x00"], ' ', $value);
+
+            return \sprintf('"%s"', $value);
         }
 
         if (\is_resource($value)) {

src/Rule/AbstractComparisonRule.php

@@ -9,7 +9,7 @@ abstract class AbstractComparisonRule extends AbstractRule
 {
     use ComparableTrait;
 
-    public function assert(mixed $value, string $name): void
+    public function assert(mixed $value, ?string $name = null): void
     {
         if (!$this->isComparable($value, $this->constraint)) {
             throw new UnexpectedComparableException(

src/Rule/AbstractRule.php

@@ -9,7 +9,7 @@ abstract class AbstractRule
     public function validate($value): bool
     {
         try {
-            $this->assert($value, 'null');
+            $this->assert($value);
         }
         catch (ValidationException) {
             return false;
@@ -21,5 +21,5 @@ public function validate($value): bool
     /**
      * @throws ValidationException
      */
-    public abstract function assert(mixed $value, string $name): void;
+    public abstract function assert(mixed $value, ?string $name = null): void;
 }

src/Rule/Choice.php

@@ -12,13 +12,13 @@ public function __construct(
         private readonly bool $multiple = false,
         private readonly ?int $minConstraint = null,
         private readonly ?int $maxConstraint = null,
-        private readonly string $message = 'The "{{ name }}" value is not a valid choice, "{{ value }}" given. Accepted values are: "{{ constraints }}".',
-        private readonly string $multipleMessage = 'The "{{ name }}" value has one or more invalid choices, "{{ value }}" given. Accepted values are: "{{ constraints }}".',
-        private readonly string $minMessage = 'The "{{ name }}" value must have at least {{ minConstraint }} choices, {{ numValues }} choices given.',
-        private readonly string $maxMessage = 'The "{{ name }}" value must have at most {{ maxConstraint }} choices, {{ numValues }} choices given.'
+        private readonly string $message = 'The {{ name }} value is not a valid choice, {{ value }} given. Accepted values are: {{ constraints }}.',
+        private readonly string $multipleMessage = 'The {{ name }} value has one or more invalid choices, {{ value }} given. Accepted values are: {{ constraints }}.',
+        private readonly string $minMessage = 'The {{ name }} value must have at least {{ minConstraint }} choices, {{ numValues }} choices given.',
+        private readonly string $maxMessage = 'The {{ name }} value must have at most {{ maxConstraint }} choices, {{ numValues }} choices given.'
     ) {}
 
-    public function assert(mixed $value, string $name): void
+    public function assert(mixed $value, ?string $name = null): void
     {
         if ($this->multiple && !\is_array($value)) {
             throw new UnexpectedValueException(

src/Rule/Country.php

@@ -18,10 +18,10 @@ class Country extends AbstractRule implements RuleInterface
 
     public function __construct(
         private readonly string $code = self::ALPHA_2_CODE,
-        private readonly string $message = 'The "{{ name }}" value is not a valid "{{ code }}" country code, "{{ value }}" given.'
+        private readonly string $message = 'The {{ name }} value is not a valid {{ code }} country code, {{ value }} given.'
     ) {}
 
-    public function assert(mixed $value, string $name): void
+    public function assert(mixed $value, ?string $name = null): void
     {
         if (!\in_array($this->code, self::CODE_OPTIONS)) {
             throw new UnexpectedValueException(

src/Rule/EachKey.php

@@ -14,7 +14,7 @@ public function __construct(
         private readonly string $message = 'Invalid key: {{ message }}'
     ) {}
 
-    public function assert(mixed $value, string $name): void
+    public function assert(mixed $value, ?string $name = null): void
     {
         if (!\is_iterable($value)) {
             throw new UnexpectedValueException(
@@ -35,12 +35,7 @@ public function assert(mixed $value, string $name): void
                     'name' => $name,
                     'key' => $key,
                     'element' => $element,
-                    // Replaces string "value" with string "key" to get a more intuitive error message
-                    'message' => \preg_replace(
-                        \sprintf('/"(%s)" value/', $name),
-                        '"$1" key',
-                        $exception->getMessage()
-                    )
+                    'message' => \str_replace(' value ', ' key value ', $exception->getMessage())
                 ]
             );
         }

src/Rule/EachValue.php

@@ -11,10 +11,10 @@ class EachValue extends AbstractRule implements RuleInterface
 {
     public function __construct(
         private readonly Validator $validator,
-        private readonly string $message = 'At key "{{ key }}": {{ message }}'
+        private readonly string $message = 'At key {{ key }}: {{ message }}'
     ) {}
 
-    public function assert(mixed $value, string $name): void
+    public function assert(mixed $value, ?string $name = null): void
     {
         if (!\is_iterable($value)) {
             throw new UnexpectedValueException(

src/Rule/GreaterThan.php

@@ -8,7 +8,7 @@ class GreaterThan extends AbstractComparisonRule implements RuleInterface
 {
     public function __construct(
         protected readonly mixed $constraint,
-        protected readonly string $message = 'The "{{ name }}" value should be greater than "{{ constraint }}", "{{ value }}" given.'
+        protected readonly string $message = 'The {{ name }} value should be greater than {{ constraint }}, {{ value }} given.'
     ) {}
 
     protected function compareValues(mixed $value1, mixed $value2): bool

src/Rule/GreaterThanOrEqual.php

@@ -8,7 +8,7 @@ class GreaterThanOrEqual extends AbstractComparisonRule implements RuleInterface
 {
     public function __construct(
         protected readonly mixed $constraint,
-        protected readonly string $message = 'The "{{ name }}" value should be greater than or equal to "{{ constraint }}", "{{ value }}" given.'
+        protected readonly string $message = 'The {{ name }} value should be greater than or equal to {{ constraint }}, {{ value }} given.'
     ) {}
 
     protected function compareValues(mixed $value1, mixed $value2): bool