Add postal_code validator extension

Author: axlon

README.md

@@ -22,6 +22,7 @@ Worldwide postal code validation for Laravel, based on Google's Address Data Ser
 - [Usage](#usage)
     - [Available rules](#available-rules)
     - [Adding an error message](#adding-an-error-message)
+    - [String rules](#string-rules)
 - [Changelog](#changelog)
 - [Contributing](#contributing)
 - [Credits](#credits)
@@ -111,6 +112,19 @@ The following placeholders will be automatically filled for you:
 
 *The `:countries` and `:examples` placeholders may be empty if no valid countries are passed.
 
+### String rules
+
+All rules provided by this package can also be used as strings. This is especially useful when validating arrays, for
+example:
+
+```php
+$request->validate([
+    'addresses' => '...',
+    'addresses.*.country' => '...',
+    'addresses.*.postal_code' => 'postal_code:addresses.*.country',
+]);
+```
+
 ## Changelog
 
 Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.

src/Support/ValidationServiceProvider.php

@@ -6,7 +6,12 @@
 
 use Axlon\PostalCodeValidation\Contracts\RegexFactory;
 use Axlon\PostalCodeValidation\Regex\RegexRepository;
+use Axlon\PostalCodeValidation\Rules\PostalCode;
+use Closure;
 use Illuminate\Support\ServiceProvider;
+use Illuminate\Validation\Factory;
+use Illuminate\Validation\InvokableValidationRule;
+use Illuminate\Validation\Validator;
 
 final class ValidationServiceProvider extends ServiceProvider
 {
@@ -18,5 +23,31 @@ final class ValidationServiceProvider extends ServiceProvider
     public function register(): void
     {
         $this->app->singleton(RegexFactory::class, RegexRepository::class);
+
+        $this->callAfterResolving('validator', static function (Factory $validator) {
+            $validator->extendDependent('postal_code', self::createExtension(PostalCode::of(...)));
+        });
+    }
+
+    /**
+     * Create a validator extension.
+     *
+     * @param \Closure(array<string>): \Illuminate\Contracts\Validation\ValidationRule $callback
+     * @return \Closure(string, mixed, array<string>, \Illuminate\Validation\Validator): bool
+     */
+    private static function createExtension(Closure $callback): Closure
+    {
+        return static function (
+            string $attribute,
+            mixed $value,
+            array $parameters,
+            Validator $validator,
+        ) use ($callback): bool {
+            /** @var array<string> $parameters */
+            $invokable = InvokableValidationRule::make($callback($parameters));
+            $invokable->setValidator($validator);
+
+            return $invokable->passes($attribute, $value);
+        };
     }
 }

tests/Support/ValidationServiceProviderTest.php

@@ -4,12 +4,17 @@
 
 namespace Tests\Support;
 
+use Axlon\PostalCodeValidation\Contracts\Regex;
 use Axlon\PostalCodeValidation\Contracts\RegexFactory;
+use Axlon\PostalCodeValidation\Rules\PostalCode;
 use Axlon\PostalCodeValidation\Support\ValidationServiceProvider;
+use Illuminate\Support\Facades\Validator;
 use Orchestra\Testbench\TestCase;
 use PHPUnit\Framework\Attributes\CoversClass;
+use PHPUnit\Framework\Attributes\UsesClass;
 
 #[CoversClass(ValidationServiceProvider::class)]
+#[UsesClass(PostalCode::class)]
 final class ValidationServiceProviderTest extends TestCase
 {
     protected function getPackageProviders($app): array
@@ -26,4 +31,35 @@ public function testItBindsRegexFactory(): void
         self::assertInstanceOf(RegexFactory::class, $regexes);
         self::assertSame($regexes, $this->app?->make(RegexFactory::class));
     }
+
+    public function testItCreatesPostalCodeExtensionThatFailsWhenRegexDoesNotMatch(): void
+    {
+        $regex = self::createMock(Regex::class);
+        $regex->method('test')->with('1234 AB')->willReturn(false);
+
+        $this->mock(RegexFactory::class)
+            ->expects('get')
+            ->with('NL')
+            ->andReturns($regex);
+
+        $validator = Validator::make(['value' => '1234 AB'], ['value' => 'postal_code:NL']);
+
+        self::assertFalse($validator->passes());
+        self::assertSame(['validation.postal_code'], $validator->errors()->get('value'));
+    }
+
+    public function testItCreatesPostalCodeExtensionThatPassesWhenRegexMatches(): void
+    {
+        $regex = self::createMock(Regex::class);
+        $regex->method('test')->with('1234 AB')->willReturn(true);
+
+        $this->mock(RegexFactory::class)
+            ->expects('get')
+            ->with('NL')
+            ->andReturns($regex);
+
+        $validator = Validator::make(['value' => '1234 AB'], ['value' => 'postal_code:NL']);
+
+        self::assertTrue($validator->passes());
+    }
 }