Add new validation engine

Author: axlon

CHANGELOG.md

@@ -12,4 +12,6 @@ All notable changes to this project will be documented in this file.
 ### 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

README.md

@@ -23,8 +23,6 @@ Worldwide postal code validation for Laravel, based on Google's Address Data Ser
     - [Available rules](#available-rules)
     - [Fluent API](#fluent-api)
     - [Adding an error message](#adding-an-error-message)
-    - [Manually validating](#manually-validating)
-    - [Overriding rules](#overriding-rules)
 - [Changelog](#changelog)
 - [Contributing](#contributing)
 - [Credits](#credits)
@@ -124,34 +122,6 @@ The following placeholders will be automatically filled for you:
 
 *The `:countries` and `:examples` placeholders may be empty if no valid countries are passed.
 
-### Manually validating
-
-If you want to validate postal codes manually outside of Laravel's validation system, you can call the validator
-directly, like so:
-
-```php
-PostalCodes::passes($country, $postalCode); // returns a boolean
-```
-
-### Overriding rules
-
-Depending on your use case you may want to override the patterns used to validate postal codes for a country. You can do
-this by adding the code below in a central place in your application (e.g. a service provider):
-
-```php
-PostalCodes::override('country', '/your pattern/');
-
-// You can also pass overrides as an array
-
-PostalCodes::override([
-    'country 1' => '/pattern 1/',
-    'country 2' => '/pattern 2/',
-]);
-```
-
-**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.
-
 ## Changelog
 
 Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.

phpstan-baseline.neon

@@ -1,9 +1,10 @@
 includes:
     - phar://phpstan.phar/conf/bleedingEdge.neon
-    - phpstan-baseline.neon
 
 parameters:
     level: 10
+    featureToggles:
+        internalTag: false
     paths:
         - src
         - tests

phpstan.neon.dist

@@ -0,0 +1,23 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Axlon\PostalCodeValidation\Contracts;
+
+interface Regex
+{
+    /**
+     * Get an example value that matches the regex.
+     *
+     * @return non-empty-string
+     */
+    public function example(): string;
+
+    /**
+     * Determine if the given value matches the regex.
+     *
+     * @param string $value
+     * @return bool
+     */
+    public function test(string $value): bool;
+}

src/Contracts/Regex.php

@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Axlon\PostalCodeValidation\Contracts;
+
+interface RegexFactory
+{
+    /**
+     * Get the regular expression for the specified territory.
+     *
+     * @param string $key
+     * @return \Axlon\PostalCodeValidation\Contracts\Regex|null
+     */
+    public function get(string $key): ?Regex;
+}

src/Contracts/RegexFactory.php

@@ -4,37 +4,20 @@
 
 namespace Axlon\PostalCodeValidation\Extensions;
 
-use Axlon\PostalCodeValidation\PostalCodeValidator;
-use Axlon\PostalCodeValidation\Support\PostalCodeExamples;
+use Axlon\PostalCodeValidation\Contracts\RegexFactory;
 use InvalidArgumentException;
 
 final class PostalCode
 {
-    /**
-     * The postal code examples.
-     *
-     * @var \Axlon\PostalCodeValidation\Support\PostalCodeExamples
-     */
-    protected $examples;
-
-    /**
-     * The pattern matcher.
-     *
-     * @var \Axlon\PostalCodeValidation\PostalCodeValidator
-     */
-    protected $validator;
-
     /**
      * Create a new PostalCode validator extension.
      *
-     * @param \Axlon\PostalCodeValidation\PostalCodeValidator $validator
-     * @param \Axlon\PostalCodeValidation\Support\PostalCodeExamples $examples
+     * @param \Axlon\PostalCodeValidation\Contracts\RegexFactory $regexes
      * @return void
      */
-    public function __construct(PostalCodeValidator $validator, PostalCodeExamples $examples)
-    {
-        $this->examples = $examples;
-        $this->validator = $validator;
+    public function __construct(
+        private readonly RegexFactory $regexes,
+    ) {
     }
 
     /**
@@ -52,7 +35,7 @@ public function replace(string $message, string $attribute, string $rule, array
         $examples = [];
 
         foreach ($parameters as $parameter) {
-            if (($example = $this->examples->get($parameter)) === null) {
+            if (($example = $this->regexes->get($parameter)?->example()) === null) {
                 continue;
             }
 
@@ -83,8 +66,12 @@ public function validate(string $attribute, ?string $value, array $parameters):
             throw new InvalidArgumentException('Validation rule postal_code requires at least 1 parameter.');
         }
 
+        if (!is_string($value)) {
+            return false;
+        }
+
         foreach ($parameters as $parameter) {
-            if ($this->validator->passes($parameter, $value)) {
+            if ($this->regexes->get($parameter)?->test($value) === true) {
                 return true;
             }
         }

src/Extensions/PostalCode.php

@@ -4,39 +4,22 @@
 
 namespace Axlon\PostalCodeValidation\Extensions;
 
-use Axlon\PostalCodeValidation\PostalCodeValidator;
-use Axlon\PostalCodeValidation\Support\PostalCodeExamples;
+use Axlon\PostalCodeValidation\Contracts\RegexFactory;
 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.
-     *
-     * @var \Axlon\PostalCodeValidation\PostalCodeValidator
-     */
-    protected $validator;
-
     /**
      * Create a new PostalCodeFor validator extension.
      *
-     * @param \Axlon\PostalCodeValidation\PostalCodeValidator $validator
-     * @param \Axlon\PostalCodeValidation\Support\PostalCodeExamples $examples
+     * @param \Axlon\PostalCodeValidation\Contracts\RegexFactory $regexes
      * @return void
      */
-    public function __construct(PostalCodeValidator $validator, PostalCodeExamples $examples)
-    {
-        $this->examples = $examples;
-        $this->validator = $validator;
+    public function __construct(
+        private readonly RegexFactory $regexes,
+    ) {
     }
 
     /**
@@ -60,11 +43,13 @@ public function replace(
         $examples = [];
 
         foreach ($parameters as $parameter) {
-            if (($input = Arr::get($validator->getData(), $parameter)) === null) {
+            $input = Arr::get($validator->getData(), $parameter);
+
+            if (!is_string($input)) {
                 continue;
             }
 
-            if (($example = $this->examples->get($input)) === null) {
+            if (($example = $this->regexes->get($input)?->example()) === null) {
                 continue;
             }
 
@@ -102,12 +87,16 @@ public function validate(string $attribute, ?string $value, array $parameters, V
             return true;
         }
 
+        if (!is_string($value)) {
+            return false;
+        }
+
         foreach ($parameters as $parameter) {
             if ($parameter === null) {
                 continue;
             }
 
-            if ($this->validator->passes($parameter, $value)) {
+            if (is_string($parameter) && $this->regexes->get($parameter)?->test($value) === true) {
                 return true;
             }
         }