Refactor postal code validation rule

Author: axlon

.gitattributes

@@ -2,6 +2,7 @@
 
 bin/ export-ignore
 .github/ export-ignore
+phpstan-stubs/ export-ignore
 tests/ export-ignore
 .editorconfig export-ignore
 .gitattributes export-ignore

CHANGELOG.md

@@ -4,14 +4,20 @@ All notable changes to this project will be documented in this file.
 
 ## 4.0.0
 
+### Fixed
+
+- Type error when field under validation is not a string has been fixed
+
 ### Changed
 
 - Minimum Laravel version is now 10.0
 - Minimum PHP version is now 8.1
+- Using another request field as the country for validation no longer requires a separate rule
 
 ### Removed
 
 - Lumen is no longer supported
 - Manual validation outside of Laravel validation has been removed
 - Overriding validation patterns has been removed
 - PostalCodes facade has been removed
+- Support for lowercase country codes has been removed

README.md

@@ -21,7 +21,6 @@ Worldwide postal code validation for Laravel, based on Google's Address Data Ser
 - [Installation](#installation)
 - [Usage](#usage)
     - [Available rules](#available-rules)
-    - [Fluent API](#fluent-api)
     - [Adding an error message](#adding-an-error-message)
 - [Changelog](#changelog)
 - [Contributing](#contributing)
@@ -47,7 +46,7 @@ package manually, you can do this by adding the following line to your `config/a
 ```php
 'providers' => [
    ...
-   Axlon\PostalCodeValidation\ValidationServiceProvider::class,
+   Axlon\PostalCodeValidation\Support\ValidationServiceProvider::class,
    ...
 ],
 ```
@@ -61,55 +60,45 @@ framework validation rule.
 
 This package adds the following validation rules:
 
-#### postal_code:foo,bar,...
+#### PostalCode
 
 The field under validation must be a valid postal code in at least one of the given countries. Arguments must be
-countries in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
+countries in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format:
 
 ```php
-'postal_code' => 'postal_code:NL,DE,FR,BE'
-```
-
-#### postal_code_with:foo,bar,...
-
-The field under validation must be a postal code in at least one of the countries in the given fields _only if_ at least
-one of the specified fields is present.
+use Axlon\PostalCodeValidation\Rules\PostalCode;
 
-```php
-'billing.country' => 'required|string|max:2',
-...
-'shipping.country' => 'nullable|string|max:2',
-'shipping.postal_code' => 'postal_code_with:billing.country,shipping.country'
+$request->validate([
+    'postal_code' => [
+        PostalCode::of(['NL', 'BE']),
+    ],
+]);
 ```
 
-### Fluent API
-
-If you prefer using a fluent object style over string based rules, that's also available:
+It is also possible to use another field in the request as the country code, for example:
 
 ```php
-'postal_code' => [
-    PostalCode::for('NL')->or('BE'),
-],
+use Axlon\PostalCodeValidation\Rules\PostalCode;
+
+$request->validate([
+    'shipping.country' => ['...'],
+    'shipping.postal_code' => [
+        'required_with:shipping.country',
+        PostalCode::of('shipping.country'),
+    ],
+]);
 ```
 
-The same goes for the `postal_code_with` rule:
-
-```php
-'billing.country' => 'required|string|max:2',
-...
-'shipping.country' => 'nullable|string|max:2',
-'shipping.postal_code' => [
-    PostalCode::with('billing.country')->or('shipping.country')
-],
-```
+> Note that postal code validation will pass if the referenced field is empty or missing, as long as the value under
+> validation is a string. It is recommended that you use some additional validation rules to ensure both fields are
+> present when they should be.
 
 ### Adding an error message
 
-To add a meaningful error message, add the following lines to `resources/lang/{your language}/validation.php`:
+To add a meaningful error message, add the following line to `resources/lang/{your language}/validation.php`:
 
 ```php
 'postal_code' => 'Your message here',
-'postal_code_with' => 'Your message here',
 ```
 
 The following placeholders will be automatically filled for you:

composer.json

@@ -27,6 +27,7 @@
         "phpstan/extension-installer": "^1.4",
         "phpstan/phpstan": "^2.1",
         "phpstan/phpstan-deprecation-rules": "^2.0",
+        "phpstan/phpstan-mockery": "^2.0",
         "phpstan/phpstan-strict-rules": "^2.0",
         "phpunit/phpunit": "^10.5 || ^11.5",
         "slevomat/coding-standard": "^8.16",
@@ -54,7 +55,7 @@
     "extra": {
         "laravel": {
             "providers": [
-                "\\Axlon\\PostalCodeValidation\\ValidationServiceProvider"
+                "\\Axlon\\PostalCodeValidation\\Support\\ValidationServiceProvider"
             ]
         }
     }

phpstan-stubs/laravel/framework/InteractsWithContainer.stub

@@ -0,0 +1,15 @@
+<?php
+
+namespace Illuminate\Foundation\Testing\Concerns;
+
+use Closure;
+
+trait InteractsWithContainer
+{
+    /**
+     * @template T of object
+     * @param class-string<T>|string $abstract
+     * @return ($abstract is class-string<T> ? \Mockery\MockInterface&T : \Mockery\MockInterface)
+     */
+    protected function mock($abstract, Closure $mock = null);
+}

phpstan.neon.dist

@@ -8,3 +8,5 @@ parameters:
     paths:
         - src
         - tests
+    stubFiles:
+        - phpstan-stubs/laravel/framework/InteractsWithContainer.stub