Merge pull request #52 from programmatordev/YAPV-20-create-length-rule

Create Length rule

Author: andrepimpao

composer.json

@@ -15,7 +15,8 @@
         "php": ">=8.1",
         "egulias/email-validator": "^4.0",
         "symfony/intl": "^6.3",
-        "symfony/polyfill-ctype": "^1.27"
+        "symfony/polyfill-ctype": "^1.27",
+        "symfony/polyfill-intl-grapheme": "^1.29"
     },
     "require-dev": {
         "phpunit/phpunit": "^10.0",

docs/03-rules.md

@@ -16,6 +16,7 @@
 ## String Rules
 
 - [Email](03-rules_email.md)
+- [Length](03-rules_length.md)
 - [URL](03-rules_url.md)
 
 ## Comparison Rules

docs/03-rules_choice.md

@@ -78,7 +78,7 @@ For example, if `max` 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 {{ min }} choices, {{ numElements }} choices given.`
+type: `?string` default: `The {{ name }} value must have at least {{ min }} choices, {{ numElements }} choices given.`
 
 Message that will be shown when `multiple` is `true` and input array has fewer values than the defined in `min`.
 
@@ -123,7 +123,7 @@ The following parameters are available:
 
 ### `maxMessage`
 
-type: `string` default: `The {{ name }} value must have at most {{ max }} choices, {{ numElements }} choices given.`
+type: `?string` default: `The {{ name }} value must have at most {{ max }} choices, {{ numElements }} choices given.`
 
 Message that will be shown when `multiple` is `true` and input array has more values than the defined in `max`.
 

docs/03-rules_count.md

@@ -25,7 +25,6 @@ Validator::count(max: 1)->validate(['a', 'b', 'c']); // false
 
 // min and max value
 Validator::count(min: 2, max: 4)->validate(['a', 'b', 'c']); // true
-
 // exact value
 Validator::count(min: 3, max: 3)->validate(['a', 'b', 'c']); // true
 ```
@@ -34,10 +33,10 @@ Validator::count(min: 3, max: 3)->validate(['a', 'b', 'c']); // true
 > An `UnexpectedValueException` will be thrown when either `min` or `max` options are not given.
 
 > [!NOTE]
-> An `UnexpectedValueException` will be thrown when the input value is not an `array` or an object implementing `\Countable`.
+> An `UnexpectedValueException` will be thrown when the `min` value is greater than the `max` value.
 
 > [!NOTE]
-> An `UnexpectedValueException` will be thrown when the `min` value is greater than the `max` value.
+> An `UnexpectedValueException` will be thrown when the input value is not an `array` or an object implementing `\Countable`.
 
 ## Options
 
@@ -47,16 +46,12 @@ type: `?int` default: `null`
 
 It defines the minimum number of elements required.
 
-For example, if `min` is 2, the input value must have at least 2 elements.
-
 ### `max`
 
 type: `?int` default: `null`
 
 It defines the maximum number of elements required.
 
-For example, if `max` is 2, the input value must have at most 2 elements.
-
 ### `minMessage`
 
 type: `?string` default: `The {{ name }} value should contain {{ min }} elements or more, {{ numElements }} elements given.`

docs/03-rules_country.md

@@ -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/03-rules_each-key.md

@@ -1,6 +1,6 @@
 ## EachKey
 
-Validates every key of an `array` or object implementing `\Traversable` with a given set of rules.
+Validates every key of an `array`, or object implementing `\Traversable`, with a given set of rules.
 
 ```php
 EachKey(
@@ -12,8 +12,13 @@ EachKey(
 ## Basic Usage
 
 ```php
-Validator::eachKey(Validator::notBlank()->type('string'))->validate(['red' => '#f00', 'green' => '#0f0']); // true
-Validator::eachKey(Validator::notBlank()->type('string'))->validate(['red' => '#f00', 1 => '#0f0']); // false
+Validator::eachKey(
+    Validator::notBlank()->type('string')
+)->validate(['red' => '#f00', 'green' => '#0f0']); // true
+
+Validator::eachKey(
+    Validator::notBlank()->type('string')
+)->validate(['red' => '#f00', 1 => '#0f0']); // false
 ```
 
 > [!NOTE]
@@ -29,13 +34,15 @@ Validator that will validate each key of an `array` or object implementing `\Tra
 
 ### `message`
 
-type: `string` default: `Invalid key: {{ message }}`
+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'], 'color'); 
 // Throws: Invalid key: The color key value should be of type "string", 1 given.
+Validator::eachKey(
+    Validator::type('string')
+)->assert(['red' => '#f00', 1 => '#0f0'], 'color');
 ```
 
 The following parameters are available:

docs/03-rules_each-value.md

@@ -12,8 +12,13 @@ EachValue(
 ## Basic Usage
 
 ```php
-Validator::eachValue(Validator::notBlank()->greaterThan(1)->lessThan(10))->validate([4, 5, 6]); // true
-Validator::eachValue(Validator::notBlank()->greaterThan(1)->lessThan(10))->validate([4, 5, 20]); // false
+Validator::eachValue(
+    Validator::notBlank()->greaterThan(1)->lessThan(10)
+)->validate([4, 5, 6]); // true
+
+Validator::eachValue(
+    Validator::notBlank()->greaterThan(1)->lessThan(10)
+)->validate([4, 5, 20]); // false
 ```
 
 > [!NOTE]
@@ -29,13 +34,15 @@ Validator that will validate each element of an `array` or object implementing `
 
 ### `message`
 
-type: `string` default: `At key "{{ key }}": {{ message }}`
+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', ''], 'color'); 
 // Throws: At key 2: The color value should not be blank, "" given.
+Validator::eachValue(
+    Validator::notBlank()
+)->assert(['red', 'green', ''], 'color');
 ```
 
 The following parameters are available:

docs/03-rules_email.md

@@ -56,7 +56,7 @@ Validator::email(normalizer: fn($value) => trim($value))->validate('test@example
 
 ### `message`
 
-type `string` default: `The {{ name }} value is not a valid email address, {{ value }} given.`
+type: `?string` default: `The {{ name }} value is not a valid email address, {{ value }} given.`
 
 Message that will be shown if the input value is not a valid email address.
 

docs/03-rules_greater-than-or-equal.md

@@ -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/03-rules_greater-than.md

@@ -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.