Remove :examples error placeholder

Author: axlon

CHANGELOG.md

@@ -14,3 +14,4 @@ All notable changes to this project will be documented in this file.
 - Lumen is no longer supported
 - Validation overrides are no longer supported
 - Manual validation is no longer supported
+- Error message placeholder `:examples` is no longer provided

README.md

@@ -118,9 +118,8 @@ The following placeholders will be automatically filled for you:
 |-------------|------------------------------------------------------------|
 | :attribute  | The name of the field that was under validation            |
 | :countries  | The countries that were validated against (e.g. `NL, BE`)* |
-| :examples   | Examples of allowed postal codes (e.g. `1234 AB, 4000`)*   |
 
-*The `:countries` and `:examples` placeholders may be empty if no valid countries are passed.
+*The `:countries` placeholder may be empty if no valid countries are passed.
 
 **Important**: If you believe there is a bug in one of the patterns that this package ships with, please create an
 [issue](https://github.com/axlon/laravel-postal-code-validation/issues/new) in the issue tracker.

phpstan-baseline.neon

@@ -6,30 +6,6 @@ parameters:
 			count: 1
 			path: src/Extensions/PostalCodeFor.php
 
-		-
-			message: '#^Parameter \#1 \$countryCode of method Axlon\\PostalCodeValidation\\Support\\PostalCodeExamples\:\:get\(\) expects string, mixed given\.$#'
-			identifier: argument.type
-			count: 1
-			path: src/Extensions/PostalCodeFor.php
-
-		-
-			message: '#^Cannot access offset string on mixed\.$#'
-			identifier: offsetAccess.nonOffsetAccessible
-			count: 1
-			path: src/Support/PostalCodeExamples.php
-
-		-
-			message: '#^Method Axlon\\PostalCodeValidation\\Support\\PostalCodeExamples\:\:get\(\) should return string\|null but returns mixed\.$#'
-			identifier: return.type
-			count: 1
-			path: src/Support/PostalCodeExamples.php
-
-		-
-			message: '#^Property Axlon\\PostalCodeValidation\\Support\\PostalCodeExamples\:\:\$examples \(array\<string, string\>\|null\) does not accept mixed\.$#'
-			identifier: assign.propertyType
-			count: 1
-			path: src/Support/PostalCodeExamples.php
-
 		-
 			message: '#^Parameter \#1 \$patterns of class Axlon\\PostalCodeValidation\\PostalCodeValidator constructor expects array\<string, string\|null\>, mixed given\.$#'
 			identifier: argument.type

src/Extensions/PostalCode.php

@@ -5,18 +5,10 @@
 namespace Axlon\PostalCodeValidation\Extensions;
 
 use Axlon\PostalCodeValidation\PostalCodeValidator;
-use Axlon\PostalCodeValidation\Support\PostalCodeExamples;
 use InvalidArgumentException;
 
 final class PostalCode
 {
-    /**
-     * The postal code examples.
-     *
-     * @var \Axlon\PostalCodeValidation\Support\PostalCodeExamples
-     */
-    protected $examples;
-
     /**
      * The pattern matcher.
      *
@@ -28,12 +20,10 @@ final class PostalCode
      * Create a new PostalCode validator extension.
      *
      * @param \Axlon\PostalCodeValidation\PostalCodeValidator $validator
-     * @param \Axlon\PostalCodeValidation\Support\PostalCodeExamples $examples
      * @return void
      */
-    public function __construct(PostalCodeValidator $validator, PostalCodeExamples $examples)
+    public function __construct(PostalCodeValidator $validator)
     {
-        $this->examples = $examples;
         $this->validator = $validator;
     }
 
@@ -49,24 +39,17 @@ public function __construct(PostalCodeValidator $validator, PostalCodeExamples $
     public function replace(string $message, string $attribute, string $rule, array $parameters): string
     {
         $countries = [];
-        $examples = [];
 
         foreach ($parameters as $parameter) {
-            if (($example = $this->examples->get($parameter)) === null) {
-                continue;
-            }
-
             $countries[] = $parameter;
-            $examples[] = $example;
         }
 
         $replacements = [
             $attribute,
             implode(', ', array_unique($countries)),
-            implode(', ', array_unique($examples)),
         ];
 
-        return str_replace([':attribute', ':countries', ':examples'], $replacements, $message);
+        return str_replace([':attribute', ':countries'], $replacements, $message);
     }
 
     /**

src/Extensions/PostalCodeFor.php

@@ -5,20 +5,12 @@
 namespace Axlon\PostalCodeValidation\Extensions;
 
 use Axlon\PostalCodeValidation\PostalCodeValidator;
-use Axlon\PostalCodeValidation\Support\PostalCodeExamples;
 use Illuminate\Support\Arr;
 use Illuminate\Validation\Validator;
 use InvalidArgumentException;
 
 final class PostalCodeFor
 {
-    /**
-     * The postal code examples.
-     *
-     * @var \Axlon\PostalCodeValidation\Support\PostalCodeExamples
-     */
-    protected $examples;
-
     /**
      * The pattern matcher.
      *
@@ -30,12 +22,10 @@ final class PostalCodeFor
      * Create a new PostalCodeFor validator extension.
      *
      * @param \Axlon\PostalCodeValidation\PostalCodeValidator $validator
-     * @param \Axlon\PostalCodeValidation\Support\PostalCodeExamples $examples
      * @return void
      */
-    public function __construct(PostalCodeValidator $validator, PostalCodeExamples $examples)
+    public function __construct(PostalCodeValidator $validator)
     {
-        $this->examples = $examples;
         $this->validator = $validator;
     }
 
@@ -57,28 +47,21 @@ public function replace(
         Validator $validator,
     ): string {
         $countries = [];
-        $examples = [];
 
         foreach ($parameters as $parameter) {
             if (($input = Arr::get($validator->getData(), $parameter)) === null) {
                 continue;
             }
 
-            if (($example = $this->examples->get($input)) === null) {
-                continue;
-            }
-
             $countries[] = $input;
-            $examples[] = $example;
         }
 
         $replacements = [
             $attribute,
             implode(', ', array_unique($countries)),
-            implode(', ', array_unique($examples)),
         ];
 
-        return str_replace([':attribute', ':countries', ':examples'], $replacements, $message);
+        return str_replace([':attribute', ':countries'], $replacements, $message);
     }
 
     /**

src/Support/PostalCodeExamples.php

@@ -22,11 +22,11 @@ public function testPostalCodeReplacer(): void
         );
 
         Lang::addLines([
-            'validation.postal_code' => ':attribute invalid, should be a :countries postal code (e.g. :examples)',
+            'validation.postal_code' => ':attribute invalid, should be a :countries postal code',
         ], 'en');
 
         self::assertContains(
-            'postal code invalid, should be a NL postal code (e.g. 1234 AB)',
+            'postal code invalid, should be a NL postal code',
             $validator->errors()->all(),
         );
     }
@@ -44,11 +44,11 @@ public function testPostalCodeForReplacer(): void
         );
 
         Lang::addLines([
-            'validation.postal_code_for' => ':attribute invalid, should be a :countries postal code (e.g. :examples)',
+            'validation.postal_code_for' => ':attribute invalid, should be a :countries postal code',
         ], 'en');
 
         self::assertContains(
-            'postal code invalid, should be a NL postal code (e.g. 1234 AB)',
+            'postal code invalid, should be a NL postal code',
             $validator->errors()->all(),
         );
     }