Merge pull request #66 from programmatordev/YAPV-68-simplify-message-parameters-tests

andrepimpao · web-flow · commit 52ce0e7b09b4 · 2024-04-30T16:43:27.000+01:00
Improve error message parameter tests
diff --git a/tests/ChoiceTest.php b/tests/ChoiceTest.php
@@ -66,39 +66,39 @@ public static function provideRuleMessageOptionData(): \Generator
         yield 'message' => [
             new Choice(
                 constraints: $constraints,
-                message: 'The {{ name }} value {{ value }} is not a valid choice.'
+                message: '{{ name }} | {{ value }} | {{ constraints }}'
             ),
             10,
-            'The test value 10 is not a valid choice.'
+            'test | 10 | [1, 2, 3, 4, 5]'
         ];
         yield 'multiple message' => [
             new Choice(
                 constraints: $constraints,
                 multiple: true,
-                multipleMessage: 'The {{ name }} value {{ value }} is not a valid choice.'
+                multipleMessage: '{{ name }} | {{ value }} | {{ constraints }}'
             ),
             [10],
-            'The test value [10] is not a valid choice.'
+            'test | [10] | [1, 2, 3, 4, 5]'
         ];
         yield 'min message' => [
             new Choice(
                 constraints: $constraints,
                 multiple: true,
                 min: 2,
-                minMessage: 'The {{ name }} value should have at least {{ min }} choices.'
+                minMessage: '{{ name }} | {{ value }} | {{ constraints }} | {{ min }} | {{ max }} | {{ numElements }}'
             ),
             [1],
-            'The test value should have at least 2 choices.'
+            'test | [1] | [1, 2, 3, 4, 5] | 2 | null | 1'
         ];
         yield 'max message' => [
             new Choice(
                 constraints: $constraints,
                 multiple: true,
                 max: 2,
-                maxMessage: 'The {{ name }} value should have at most {{ max }} choices.'
+                maxMessage: '{{ name }} | {{ value }} | {{ constraints }} | {{ min }} | {{ max }} | {{ numElements }}'
             ),
             [1, 2, 3],
-            'The test value should have at most 2 choices.'
+            'test | [1, 2, 3] | [1, 2, 3, 4, 5] | null | 2 | 3'
         ];
     }
 
diff --git a/tests/CollectionTest.php b/tests/CollectionTest.php
@@ -117,26 +117,26 @@ public static function provideRuleMessageOptionData(): \Generator
         yield 'message' => [
             new Collection(
                 fields: ['field' => Validator::notBlank()],
-                message: 'There was an error: {{ message }}'
+                message: '{{ name }} | {{ field }} | {{ message }}'
             ),
             ['field' => ''],
-            'There was an error: The "field" value should not be blank, "" given.'
+            'test | "field" | The "field" value should not be blank, "" given.'
         ];
         yield 'extra fields message' => [
             new Collection(
                 fields: ['field' => Validator::notBlank()],
-                extraFieldsMessage: 'The {{ field }} was not expected.'
+                extraFieldsMessage: '{{ name }} | {{ field }}'
             ),
             ['field' => 'value', 'extrafield' => 'extravalue'],
-            'The "extrafield" was not expected.'
+            'test | "extrafield"'
         ];
         yield 'missing fields message' => [
             new Collection(
                 fields: ['field' => Validator::notBlank()],
-                missingFieldsMessage: 'Missing field: {{ field }}.'
+                missingFieldsMessage: '{{ name }} | {{ field }}'
             ),
             [],
-            'Missing field: "field".'
+            'test | "field"'
         ];
     }
 }
diff --git a/tests/CountTest.php b/tests/CountTest.php
@@ -59,27 +59,27 @@ public static function provideRuleMessageOptionData(): \Generator
         yield 'min message' => [
             new Count(
                 min: 10,
-                minMessage: 'The {{ name }} value should have at least {{ min }} elements.'
+                minMessage: '{{ name }} | {{ value }} | {{ min }} | {{ max }} | {{ numElements }}'
             ),
             $value,
-            'The test value should have at least 10 elements.'
+            'test | [1, 2, 3, 4, 5] | 10 | null | 5'
         ];
         yield 'max message' => [
             new Count(
                 max: 2,
-                maxMessage: 'The {{ name }} value should have at most {{ max }} elements.'
+                maxMessage: '{{ name }} | {{ value }} | {{ min }} | {{ max }} | {{ numElements }}'
             ),
             $value,
-            'The test value should have at most 2 elements.'
+            'test | [1, 2, 3, 4, 5] | null | 2 | 5'
         ];
         yield 'exact message' => [
             new Count(
                 min: 2,
                 max: 2,
-                exactMessage: 'The {{ name }} value should have exactly {{ min }} elements.'
+                exactMessage: '{{ name }} | {{ value }} | {{ min }} | {{ max }} | {{ numElements }}'
             ),
             $value,
-            'The test value should have exactly 2 elements.'
+            'test | [1, 2, 3, 4, 5] | 2 | 2 | 5'
         ];
     }
 }
diff --git a/tests/CountryTest.php b/tests/CountryTest.php
@@ -46,10 +46,10 @@ public static function provideRuleMessageOptionData(): \Generator
     {
         yield 'message' => [
             new Country(
-                message: 'The {{ name }} value {{ value }} is not a valid {{ code }} country code.'
+                message: '{{ name }} | {{ value }} | {{ code }}'
             ),
             'invalid',
-            'The test value "invalid" is not a valid "alpha-2" country code.'
+            'test | "invalid" | "alpha-2"'
         ];
     }
 }
diff --git a/tests/DateTimeTest.php b/tests/DateTimeTest.php
@@ -45,10 +45,10 @@ public static function provideRuleMessageOptionData(): \Generator
     {
         yield 'message' => [
             new DateTime(
-                message: 'The {{ name }} datetime does not match the format {{ format }}.'
+                message: '{{ name }} | {{ value }} | {{ format }}'
             ),
             '2024-01-01',
-            'The test datetime does not match the format "Y-m-d H:i:s".'
+            'test | "2024-01-01" | "Y-m-d H:i:s"'
         ];
     }
 }
diff --git a/tests/EachKeyTest.php b/tests/EachKeyTest.php
@@ -72,10 +72,10 @@ public static function provideRuleMessageOptionData(): \Generator
         yield 'message' => [
             new EachKey(
                 validator: new Validator(new Type('string')),
-                message: 'The {{ name }} key {{ key }} is invalid.'
+                message: '{{ name }} | {{ value }} | {{ key }} | {{ element }} | {{ message }}'
             ),
             ['key1' => 1, 'key2' => 2, 1 => 3],
-            'The test key 1 is invalid.'
+            'test | [1, 2, 3] | 1 | 3 | The test key value should be of type "string", 1 given.'
         ];
     }
 }
diff --git a/tests/EachValueTest.php b/tests/EachValueTest.php
@@ -72,10 +72,10 @@ public static function provideRuleMessageOptionData(): \Generator
         yield 'message' => [
             new EachValue(
                 validator: new Validator(new NotBlank()),
-                message: 'The {{ name }} value {{ value }} failed at key {{ key }}.'
+                message: '{{ name }} | {{ value }} | {{ key }} | {{ element }} | {{ message }}'
             ),
             [1, 2, ''],
-            'The test value [1, 2, ""] failed at key 2.'
+            'test | [1, 2, ""] | 2 | "" | The test value should not be blank, "" given.'
         ];
     }
 }
diff --git a/tests/EmailTest.php b/tests/EmailTest.php
@@ -49,10 +49,10 @@ public static function provideRuleMessageOptionData(): \Generator
     {
         yield 'message' => [
             new Email(
-                message: 'The {{ name }} value {{ value }} in {{ mode }} mode is not a valid email address.'
+                message: '{{ name }} | {{ value }} | {{ mode }}'
             ),
             'invalid',
-            'The test value "invalid" in "html5" mode is not a valid email address.'
+            'test | "invalid" | "html5"'
         ];
     }
 }
diff --git a/tests/GreaterThanOrEqualTest.php b/tests/GreaterThanOrEqualTest.php
@@ -60,10 +60,10 @@ public static function provideRuleMessageOptionData(): \Generator
         yield 'message' => [
             new GreaterThanOrEqual(
                 constraint: 10,
-                message: 'The {{ name }} value {{ value }} is not greater than or equal to {{ constraint }}.'
+                message: '{{ name }} | {{ value }} | {{ constraint }}'
             ),
             1,
-            'The test value 1 is not greater than or equal to 10.'
+            'test | 1 | 10'
         ];
     }
 }
diff --git a/tests/GreaterThanTest.php b/tests/GreaterThanTest.php
@@ -60,10 +60,10 @@ public static function provideRuleMessageOptionData(): \Generator
         yield 'message' => [
             new GreaterThan(
                 constraint: 10,
-                message: 'The {{ name }} value {{ value }} is not greater than {{ constraint }}.'
+                message: '{{ name }} | {{ value }} | {{ constraint }}'
             ),
             1,
-            'The test value 1 is not greater than 10.'
+            'test | 1 | 10'
         ];
     }
 }
diff --git a/tests/LanguageTest.php b/tests/LanguageTest.php
@@ -46,10 +46,10 @@ public static function provideRuleMessageOptionData(): \Generator
     {
         yield 'message' => [
             new Language(
-                message: 'The {{ name }} value {{ value }} is not a valid {{ code }} language code.'
+                message: '{{ name }} | {{ value }} | {{ code }}'
             ),
             'invalid',
-            'The test value "invalid" is not a valid "alpha-2" language code.'
+            'test | "invalid" | "alpha-2"'
         ];
     }
 }
diff --git a/tests/LengthTest.php b/tests/LengthTest.php
@@ -71,36 +71,36 @@ public static function provideRuleMessageOptionData(): \Generator
         yield 'min message' => [
             new Length(
                 min: 10,
-                minMessage: 'The {{ name }} value with count unit {{ countUnit }} should have at least {{ min }} characters.'
+                minMessage: '{{ name }} | {{ value }} | {{ min }} | {{ max }} | {{ numChars }} | {{ charset }} | {{ countUnit }}'
             ),
             $value,
-            'The test value with count unit "codepoints" should have at least 10 characters.'
+            'test | "abcde" | 10 | null | 5 | "UTF-8" | "codepoints"'
         ];
         yield 'max message' => [
             new Length(
                 max: 2,
-                maxMessage: 'The {{ name }} value with count unit {{ countUnit }} should have at most {{ max }} characters.'
+                maxMessage: '{{ name }} | {{ value }} | {{ min }} | {{ max }} | {{ numChars }} | {{ charset }} | {{ countUnit }}'
             ),
             $value,
-            'The test value with count unit "codepoints" should have at most 2 characters.'
+            'test | "abcde" | null | 2 | 5 | "UTF-8" | "codepoints"'
         ];
         yield 'exact message' => [
             new Length(
                 min: 2,
                 max: 2,
-                exactMessage: 'The {{ name }} value with count unit {{ countUnit }} should have exactly {{ min }} characters.'
+                exactMessage: '{{ name }} | {{ value }} | {{ min }} | {{ max }} | {{ numChars }} | {{ charset }} | {{ countUnit }}'
             ),
             $value,
-            'The test value with count unit "codepoints" should have exactly 2 characters.'
+            'test | "abcde" | 2 | 2 | 5 | "UTF-8" | "codepoints"'
         ];
         yield 'charset message' => [
             new Length(
                 min: 2,
                 charset: 'ASCII',
-                charsetMessage: 'The {{ name }} value is not a {{ charset }} charset.'
+                charsetMessage: '{{ name }} | {{ value }} | {{ charset }}'
             ),
             'テスト',
-            'The test value is not a "ASCII" charset.'
+            'test | "テスト" | "ASCII"'
         ];
     }
 }
diff --git a/tests/LessThanOrEqualTest.php b/tests/LessThanOrEqualTest.php
@@ -60,10 +60,10 @@ public static function provideRuleMessageOptionData(): \Generator
         yield 'message' => [
             new LessThanOrEqual(
                 constraint: 10,
-                message: 'The {{ name }} value {{ value }} is not less than or equal to {{ constraint }}.'
+                message: '{{ name }} | {{ value }} | {{ constraint }}'
             ),
             20,
-            'The test value 20 is not less than or equal to 10.'
+            'test | 20 | 10'
         ];
     }
 }
diff --git a/tests/LessThanTest.php b/tests/LessThanTest.php
@@ -60,10 +60,10 @@ public static function provideRuleMessageOptionData(): \Generator
         yield 'message' => [
             new LessThan(
                 constraint: 10,
-                message: 'The {{ name }} value {{ value }} is not less than {{ constraint }}.'
+                message: '{{ name }} | {{ value }} | {{ constraint }}'
             ),
             20,
-            'The test value 20 is not less than 10.'
+            'test | 20 | 10'
         ];
     }
 }
diff --git a/tests/LocaleTest.php b/tests/LocaleTest.php
@@ -47,10 +47,10 @@ public static function provideRuleMessageOptionData(): \Generator
     {
         yield 'message' => [
             new Locale(
-                message: '{{ name }} {{ value }}'
+                message: '{{ name }} | {{ value }}'
             ),
             'invalid',
-            'test "invalid"'
+            'test | "invalid"'
         ];
     }
 }
diff --git a/tests/NotBlankTest.php b/tests/NotBlankTest.php
@@ -48,9 +48,11 @@ public static function provideRuleSuccessConditionData(): \Generator
     public static function provideRuleMessageOptionData(): \Generator
     {
         yield 'message' => [
-            new NotBlank(message: 'The {{ name }} value {{ value }} is not blank.'),
+            new NotBlank(
+                message: '{{ name }} | {{ value }}'
+            ),
             '',
-            'The test value "" is not blank.'
+            'test | ""'
         ];
     }
 }
diff --git a/tests/PasswordStrengthTest.php b/tests/PasswordStrengthTest.php
@@ -51,10 +51,10 @@ public static function provideRuleMessageOptionData(): \Generator
     {
         yield 'message' => [
             new PasswordStrength(
-                message: 'The {{ name }} value entropy is not high enough.'
+                message: '{{ name }} | {{ minStrength }}'
             ),
             'password',
-            'The test value entropy is not high enough.'
+            'test | "medium"'
         ];
     }
 }
diff --git a/tests/RangeTest.php b/tests/RangeTest.php
@@ -75,10 +75,10 @@ public static function provideRuleMessageOptionData(): \Generator
             new Range(
                 min: 10,
                 max: 20,
-                message: 'The {{ name }} value {{ value }} should be between {{ min }} and {{ max }}.'
+                message: '{{ name }} | {{ value }} | {{ min }} | {{ max }}'
             ),
             30,
-            'The test value 30 should be between 10 and 20.'
+            'test | 30 | 10 | 20'
         ];
     }
 }
diff --git a/tests/RegexTest.php b/tests/RegexTest.php
@@ -49,10 +49,10 @@ public static function provideRuleMessageOptionData(): \Generator
         yield 'message' => [
             new Regex(
                 pattern: '/[a-z]/',
-                message: 'The {{ name }} value does not match the pattern {{ pattern }}.'
+                message: '{{ name }} | {{ value }} | {{ pattern }}'
             ),
             '123',
-            'The test value does not match the pattern "/[a-z]/".'
+            'test | "123" | "/[a-z]/"'
         ];
     }
 }
diff --git a/tests/TimezoneTest.php b/tests/TimezoneTest.php
@@ -55,10 +55,10 @@ public static function provideRuleMessageOptionData(): \Generator
     {
         yield 'message' => [
             new Timezone(
-                message: 'The {{ name }} value {{ value }} is not a valid timezone.'
+                message: '{{ name }} | {{ value }} | {{ countryCode }}'
             ),
             'Invalid/Timezone',
-            'The test value "Invalid/Timezone" is not a valid timezone.'
+            'test | "Invalid/Timezone" | null'
         ];
     }
 
diff --git a/tests/TypeTest.php b/tests/TypeTest.php
@@ -107,10 +107,10 @@ public static function provideRuleMessageOptionData(): \Generator
         yield 'message' => [
             new Type(
                 constraint: 'int',
-                message: 'The {{ name }} value is not of type {{ constraint }}.'
+                message: '{{ name }} | {{ value }} | {{ constraint }}'
             ),
             'string',
-            'The test value is not of type "int".'
+            'test | "string" | "int"'
         ];
     }
 
diff --git a/tests/UrlTest.php b/tests/UrlTest.php
diff --git a/tests/ValidatorTest.php b/tests/ValidatorTest.php

Original file line number	Diff line number	Diff line change
`@@ -46,10 +46,10 @@ public static function provideRuleMessageOptionData(): \Generator`
`46`	`46`	`{`
`47`	`47`	`yield 'message' => [`
`48`	`48`	`new Country(`
`49`		`- message: 'The {{ name }} value {{ value }} is not a valid {{ code }} country code.'`
	`49`	`+ message: '{{ name }} \| {{ value }} \| {{ code }}'`
`50`	`50`	`),`
`51`	`51`	`'invalid',`
`52`		`- 'The test value "invalid" is not a valid "alpha-2" country code.'`
	`52`	`+ 'test \| "invalid" \| "alpha-2"'`
`53`	`53`	`];`
`54`	`54`	`}`
`55`	`55`	`}`
Original file line number	Diff line number	Diff line change
`@@ -45,10 +45,10 @@ public static function provideRuleMessageOptionData(): \Generator`
`45`	`45`	`{`
`46`	`46`	`yield 'message' => [`
`47`	`47`	`new DateTime(`
`48`		`- message: 'The {{ name }} datetime does not match the format {{ format }}.'`
	`48`	`+ message: '{{ name }} \| {{ value }} \| {{ format }}'`
`49`	`49`	`),`
`50`	`50`	`'2024-01-01',`
`51`		`- 'The test datetime does not match the format "Y-m-d H:i:s".'`
	`51`	`+ 'test \| "2024-01-01" \| "Y-m-d H:i:s"'`
`52`	`52`	`];`
`53`	`53`	`}`
`54`	`54`	`}`
Original file line number	Diff line number	Diff line change
`@@ -72,10 +72,10 @@ public static function provideRuleMessageOptionData(): \Generator`
`72`	`72`	`yield 'message' => [`
`73`	`73`	`new EachKey(`
`74`	`74`	`validator: new Validator(new Type('string')),`
`75`		`- message: 'The {{ name }} key {{ key }} is invalid.'`
	`75`	`+ message: '{{ name }} \| {{ value }} \| {{ key }} \| {{ element }} \| {{ message }}'`
`76`	`76`	`),`
`77`	`77`	`['key1' => 1, 'key2' => 2, 1 => 3],`
`78`		`- 'The test key 1 is invalid.'`
	`78`	`+ 'test \| [1, 2, 3] \| 1 \| 3 \| The test key value should be of type "string", 1 given.'`
`79`	`79`	`];`
`80`	`80`	`}`
`81`	`81`	`}`
Original file line number	Diff line number	Diff line change
`@@ -49,10 +49,10 @@ public static function provideRuleMessageOptionData(): \Generator`
`49`	`49`	`{`
`50`	`50`	`yield 'message' => [`
`51`	`51`	`new Email(`
`52`		`- message: 'The {{ name }} value {{ value }} in {{ mode }} mode is not a valid email address.'`
	`52`	`+ message: '{{ name }} \| {{ value }} \| {{ mode }}'`
`53`	`53`	`),`
`54`	`54`	`'invalid',`
`55`		`- 'The test value "invalid" in "html5" mode is not a valid email address.'`
	`55`	`+ 'test \| "invalid" \| "html5"'`
`56`	`56`	`];`
`57`	`57`	`}`
`58`	`58`	`}`
Original file line number	Diff line number	Diff line change
`@@ -60,10 +60,10 @@ public static function provideRuleMessageOptionData(): \Generator`
`60`	`60`	`yield 'message' => [`
`61`	`61`	`new GreaterThanOrEqual(`
`62`	`62`	`constraint: 10,`
`63`		`- message: 'The {{ name }} value {{ value }} is not greater than or equal to {{ constraint }}.'`
	`63`	`+ message: '{{ name }} \| {{ value }} \| {{ constraint }}'`
`64`	`64`	`),`
`65`	`65`	`1,`
`66`		`- 'The test value 1 is not greater than or equal to 10.'`
	`66`	`+ 'test \| 1 \| 10'`
`67`	`67`	`];`
`68`	`68`	`}`
`69`	`69`	`}`