Merge pull request #40 from programmatordev/YAPV-52-set-assert-name-parameter-as-optional

Set assert name parameter as optional

Author: andrepimpao

docs/01-get-started.md

@@ -41,5 +41,5 @@ $validator = new Validator(
 
 // Validate with these:
 $validator->validate(16); // returns bool: false
-$validator->assert(16, 'Age'); // throws exception: The "Age" value should be greater than or equal to "18", "16" given.
+$validator->assert(16, 'age'); // throws exception: The age value should be greater than or equal to 18, 16 given.
 ```

docs/02-usage.md

@@ -30,9 +30,9 @@ use ProgrammatorDev\YetAnotherPhpValidator\Validator;
  */
 function getWeatherTemperature(float $latitude, float $longitude, string $unitSystem): float
 {
-    Validator::range(-90, 90)->assert($latitude, 'Latitude');
-    Validator::range(-180, 180)->assert($longitude, 'Longitude');
-    Validator::notBlank()->choice(['METRIC', 'IMPERIAL'])->assert($unitSystem, 'Unit System');
+    Validator::range(-90, 90)->assert($latitude, 'latitude');
+    Validator::range(-180, 180)->assert($longitude, 'longitude');
+    Validator::notBlank()->choice(['METRIC', 'IMPERIAL'])->assert($unitSystem, 'unit system');
 
     // ...
 }
@@ -50,9 +50,9 @@ use ProgrammatorDev\YetAnotherPhpValidator\Validator;
  */
 function getWeatherTemperature(float $latitude, float $longitude, string $unitSystem): float
 {
-    (new Validator(new Rule\Range(-90, 90)))->assert($latitude, 'Latitude');
-    (new Validator(new Rule\Range(-180, 180)))->assert($longitude, 'Longitude');
-    (new Validator(new Rule\NotBlank(), new Rule\Choice(['METRIC', 'IMPERIAL'])))->assert($unitSystem, 'Unit System');
+    (new Validator(new Rule\Range(-90, 90)))->assert($latitude, 'latitude');
+    (new Validator(new Rule\Range(-180, 180)))->assert($longitude, 'longitude');
+    (new Validator(new Rule\NotBlank(), new Rule\Choice(['METRIC', 'IMPERIAL'])))->assert($unitSystem, 'unit system');
 
     // ...
 }
@@ -68,7 +68,7 @@ This method throws a `ValidationException` when a rule fails, otherwise nothing
 /**
  * @throws ValidationException
  */
-assert(mixed $value, string $name): void;
+assert(mixed $value, ?string $name = null): void;
 ```
 
 An example on how to handle an error:
@@ -79,9 +79,9 @@ use ProgrammatorDev\YetAnotherPhpValidator\Validator;
 
 function getWeatherTemperature(float $latitude, float $longitude, string $unitSystem): float
 {
-    Validator::range(-90, 90)->assert($latitude, 'Latitude');
-    Validator::range(-180, 180)->assert($longitude, 'Longitude');
-    Validator::notBlank()->choice(['METRIC', 'IMPERIAL'])->assert($unitSystem, 'Unit System');
+    Validator::range(-90, 90)->assert($latitude, 'latitude');
+    Validator::range(-180, 180)->assert($longitude, 'longitude');
+    Validator::notBlank()->choice(['METRIC', 'IMPERIAL'])->assert($unitSystem, 'unit system');
 
     // ...
 }
@@ -90,7 +90,7 @@ try {
     getWeatherTemperature(latitude: 100, longitude: 50, unitSystem: 'METRIC');
 }
 catch (ValidationException $exception) {
-    echo $exception->getMessage(); // The "Latitude" value should be between "-90" and "90", "100" given.
+    echo $exception->getMessage(); // The latitude value should be between -90 and 90, 100 given.
 }
 ```
 > **Note**
@@ -175,7 +175,7 @@ function calculateDiscount(float $price, float $discount, string $type): float
         $discountValidator->addRule(new Rule\LessThanOrEqual(100));
     }
 
-    $discountValidator->assert($discount, 'Discount');
+    $discountValidator->assert($discount, 'discount');
 
     // ...
 }
@@ -197,9 +197,9 @@ use ProgrammatorDev\YetAnotherPhpValidator\Exception;
 use ProgrammatorDev\YetAnotherPhpValidator\Validator;
 
 try {
-    Validator::range(-90, 90)->assert($latitude, 'Latitude');
-    Validator::range(-180, 180)->assert($longitude, 'Longitude');
-    Validator::notBlank()->choice(['METRIC', 'IMPERIAL'])->assert($unitSystem, 'Unit System');
+    Validator::range(-90, 90)->assert($latitude, 'latitude');
+    Validator::range(-180, 180)->assert($longitude, 'longitude');
+    Validator::notBlank()->choice(['METRIC', 'IMPERIAL'])->assert($unitSystem, 'unit system');
 }
 catch (Exception\RangeException $exception) {
     // Do something when Range fails
@@ -219,9 +219,9 @@ use ProgrammatorDev\YetAnotherPhpValidator\Exception\ValidationException;
 use ProgrammatorDev\YetAnotherPhpValidator\Validator;
 
 try {
-    Validator::range(-90, 90)->assert($latitude, 'Latitude');
-    Validator::range(-180, 180)->assert($longitude, 'Longitude');
-    Validator::notBlank()->choice(['METRIC', 'IMPERIAL'])->assert($unitSystem, 'Unit System');
+    Validator::range(-90, 90)->assert($latitude, 'latitude');
+    Validator::range(-180, 180)->assert($longitude, 'longitude');
+    Validator::notBlank()->choice(['METRIC', 'IMPERIAL'])->assert($unitSystem, 'unit system');
 }
 catch (ValidationException $exception) {
     // Do something when a rule fails
@@ -261,8 +261,8 @@ use ProgrammatorDev\YetAnotherPhpValidator\Validator;
 
 Validator::choice(
     constraints: ['red', 'green', 'blue'],
-    message: '"{{ value }}" is not a valid {{ name }}! You must select one of {{ constraints }}.'
+    message: '{{ value }} is not a valid {{ name }}! You must select one of {{ constraints }}.'
 )->assert('yellow', 'color');
 
-// Throws: "yellow" is not a valid color! You must select one of [red, green, blue].
+// Throws: "yellow" is not a valid color! You must select one of ["red", "green", "blue"].
 ```

docs/03x-rules-choice.md

@@ -8,10 +8,10 @@ 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.'
 );
 ```
 
@@ -78,7 +78,7 @@ For example, if `maxConstraint` is 2, the input array must have at most 2 values
 
 ### `message`
 
-type `string` default: `The "{{ name }}" value is not a valid choice, "{{ value }}" given. Accepted values are: "{{ constraints }}".`
+type `string` default: `The {{ name }} value is not a valid choice, {{ value }} given. Accepted values are: {{ constraints }}.`
 
 Message that will be shown if input value is not a valid choice.
 
@@ -92,7 +92,7 @@ The following parameters are available:
 
 ### `multipleMessage`
 
-type `string` default: `The "{{ name }}" value has one or more invalid choices, "{{ value }}" given. Accepted values are: "{{ constraints }}".`
+type `string` default: `The {{ name }} value has one or more invalid choices, {{ value }} given. Accepted values are: {{ constraints }}.`
 
 Message that will be shown when `multiple` is `true` and at least one of the input array values is not a valid choice.
 
@@ -106,7 +106,7 @@ The following parameters are available:
 
 ### `minMessage`
 
-type `string` default: `The "{{ name }}" value must have at least {{ minConstraint }} choices, {{ numValues }} choices given.`
+type `string` default: `The {{ name }} value must have at least {{ minConstraint }} choices, {{ numValues }} choices given.`
 
 Message that will be shown when `multiple` is `true` and input array has fewer values than the defined in `minConstraint`.
 
@@ -123,7 +123,7 @@ The following parameters are available:
 
 ### `maxMessage`
 
-type `string` default: `The "{{ name }}" value must have at most {{ maxConstraint }} choices, {{ numValues }} choices given.`
+type `string` default: `The {{ name }} value must have at most {{ maxConstraint }} choices, {{ numValues }} choices given.`
 
 Message that will be shown when `multiple` is `true` and input array has more values than the defined in `maxConstraint`.
 

docs/03x-rules-country.md

@@ -5,7 +5,7 @@ Validates that a value is a valid country code.
 ```php
 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.'
 );
 ```
 
@@ -42,7 +42,7 @@ Available options:
 
 ### `message`
 
-type: `string` default: `The "{{ name }}" value is not a valid "{{ code }}" country code, "{{ value }}" given.`
+type: `string` default: `The {{ name }} value is not a valid {{ code }} country code, {{ value }} given.`
 
 Message that will be shown if the input value is not a valid country code.
 

docs/03x-rules-each-key.md

@@ -34,8 +34,8 @@ type: `string` default: `Invalid key: {{ message }}`
 Message that will be shown if at least one input value key is invalid according to the given `validator`.
 
 ```php
-Validator::eachKey(Validator::notBlank())->assert(['red' => '#f00', 1 => '#0f0'], 'Test'); 
-// Throws: Invalid key: The "Test" key should be of type "string", "1" given.
+Validator::eachKey(Validator::notBlank())->assert(['red' => '#f00', 1 => '#0f0'], 'color'); 
+// Throws: Invalid key: The color key value should be of type "string", 1 given.
 ```
 
 The following parameters are available:

docs/03x-rules-each-value.md

@@ -5,7 +5,7 @@ Validates every element of an `array` or object implementing `\Traversable` with
 ```php
 EachValue(
     Validator $validator,
-    string $message = 'At key "{{ key }}": {{ message }}'
+    string $message = 'At key {{ key }}: {{ message }}'
 );
 ```
 
@@ -34,8 +34,8 @@ type: `string` default: `At key "{{ key }}": {{ message }}`
 Message that will be shown if at least one input value element is invalid according to the given `validator`.
 
 ```php
-Validator::eachValue(Validator::notBlank())->assert(['red', 'green', ''], 'Test'); 
-// Throws: At key "2": The "Test" value should not be blank, "" given.
+Validator::eachValue(Validator::notBlank())->assert(['red', 'green', ''], 'color'); 
+// Throws: At key 2: The color value should not be blank, "" given.
 ```
 
 The following parameters are available:

docs/03x-rules-greater-than-or-equal.md

@@ -6,7 +6,7 @@ Can compare between strings, numbers and dates.
 ```php
 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.'
 );
 ```
 
@@ -44,7 +44,7 @@ Can be a `string`, `int`, `float` or `DateTimeInterface` object.
 
 ### `message`
 
-type: `string` default: `The "{{ name }}" value should be greater than or equal to "{{ constraint }}", "{{ value }}" given.`
+type: `string` default: `The {{ name }} value should be greater than or equal to {{ constraint }}, {{ value }} given.`
 
 Message that will be shown if the value is not greater than or equal to the constraint value.
 

docs/03x-rules-greater-than.md

@@ -6,7 +6,7 @@ Can compare between strings, numbers and dates.
 ```php
 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.'
 );
 ```
 
@@ -44,7 +44,7 @@ Can be a `string`, `int`, `float` or `DateTimeInterface` object.
 
 ### `message`
 
-type: `string` default: `The "{{ name }}" value should be greater than "{{ constraint }}", "{{ value }}" given.`
+type: `string` default: `The {{ name }} value should be greater than {{ constraint }}, {{ value }} given.`
 
 Message that will be shown if the value is not greater than the constraint value.
 

docs/03x-rules-less-than-or-equal.md

@@ -6,7 +6,7 @@ Can compare between strings, numbers and dates.
 ```php
 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.'
 );
 ```
 
@@ -44,7 +44,7 @@ Can be a `string`, `int`, `float` or `DateTimeInterface` object.
 
 ### `message`
 
-type: `string` default: `The "{{ name }}" value should be less than or equal to "{{ constraint }}", "{{ value }}" given.`
+type: `string` default: `The {{ name }} value should be less than or equal to {{ constraint }}, {{ value }} given.`
 
 Message that will be shown if the value is not less than or equal to the constraint value.
 

docs/03x-rules-less-than.md

@@ -6,7 +6,7 @@ Can compare between strings, numbers and dates.
 ```php
 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.'
 );
 ```
 
@@ -44,7 +44,7 @@ Can be a `string`, `int`, `float` or `DateTimeInterface` object.
 
 ### `message`
 
-type: `string` default: `The "{{ name }}" value should be less than "{{ constraint }}", "{{ value }}" given.`
+type: `string` default: `The {{ name }} value should be less than {{ constraint }}, {{ value }} given.`
 
 Message that will be shown if the value is not less than the constraint value.