Refactor for less boilerplate and better structure

* chore: add PHPStan

* refactor: complete refactoring of the integration. No API changes

* fix: larastan version vor php 8.1

* fix: phpstan version for larastan 2.x

* fix: replace fluent() with data_get()

---------

Co-authored-by: DDEV User <[email protected]>

Author: pixelpeter

README.md

@@ -9,31 +9,17 @@
 [![PHPStan](https://github.com/pixelpeter/laravel-isocodes-validation/actions/workflows/phpstan.yml/badge.svg)](https://github.com/pixelpeter/laravel-isocodes-validation/actions/workflows/phpstan.yml)
 [![dependabot-auto-merge](https://github.com/pixelpeter/laravel-isocodes-validation/actions/workflows/dependabot-auto-merge.yml/badge.svg)](https://github.com/pixelpeter/laravel-isocodes-validation/actions/workflows/dependabot-auto-merge.yml)
 
-A simple Laravel 8+ wrapper for the [IsoCodes Validation library](https://github.com/ronanguilloux/IsoCodes) from
+A simple Laravel 10+ wrapper for the [IsoCodes Validation library](https://github.com/ronanguilloux/IsoCodes) from
 ronanguilloux.
 
 ## Installation
 
-### Step 1: Install Through Composer
+### Install With Composer
 
 ``` bash
 composer require pixelpeter/laravel-isocodes-validation
 ```
 
-### Step 2: Add the Service Provider
-
-*(not needed starting with v2.x because of auto discovery)*
-
-Add the service provider in `app/config/app.php`
-
-```php
-'provider' => [
-    ...
-    Pixelpeter\IsoCodesValidation\IsoCodesValidationServiceProvider::class,
-    ...
-];
-```
-
 ## Usage
 
 ### Simple examples

composer.json

@@ -33,9 +33,11 @@
     }
   },
   "require-dev": {
+    "larastan/larastan": "^2.11|^3.7",
     "mockery/mockery": "^1.2",
     "orchestra/testbench": "^8.0|^9.5|^10.0",
     "phpstan/extension-installer": "^1.4",
+    "phpstan/phpstan": "^1.12|^2.1",
     "phpunit/phpunit": "^10.5|^11.0|^12.0"
   },
   "extra": {
@@ -49,6 +51,8 @@
     "allow-plugins": {
       "phpstan/extension-installer": true
     },
-    "sort-packages": true
+    "sort-packages": true,
+    "platform": {
+    }
   }
 }

lang/de/validation.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 return [
     'bban' => 'Der Wert ":value" von :attribute ist kein gültiger BBAN Code.',
     'bsn' => 'Der Wert ":value" von :attribute ist kein gültiger BSN.',

lang/en/validation.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 return [
     'bban' => 'The value ":value" of :attribute is not a valid BBAN code.',
     'bsn' => 'The value ":value" of :attribute is not a valid BSN.',

lang/es/validation.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 return [
     'bban' => 'El valor ":value" del campo :attribute no es un código BBAN válido.',
     'bsn' => 'El valor ":value" del campo :attribute no es un BSN válido.',

phpstan.neon.dist

@@ -2,7 +2,7 @@ includes:
     - phpstan-baseline.neon
 
 parameters:
-    level: 5
+    level: 8
     paths:
         - src
     tmpDir: build/phpstan

phpunit.xml

@@ -1,8 +1,15 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" backupGlobals="false" colors="true"
-         processIsolation="false" stopOnFailure="true"
-         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.5/phpunit.xsd" cacheDirectory=".phpunit.cache"
-         backupStaticProperties="false">
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
+    backupGlobals="false" 
+    colors="true"
+    processIsolation="false" 
+    xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.5/phpunit.xsd" 
+    cacheDirectory=".phpunit.cache"
+    backupStaticProperties="false"
+    stopOnFailure="true"
+    stopOnError="true"
+    
+>
     <testsuites>
         <testsuite name="Unit">
             <directory suffix=".php">./tests/Unit</directory>

pint.json

@@ -0,0 +1,7 @@
+{
+    "preset": "laravel",
+    "rules": {
+        "declare_strict_types": true,
+        "final_class": true
+    }
+}

src/IsoCodesValidationServiceProvider.php

@@ -1,82 +1,50 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Pixelpeter\IsoCodesValidation;
 
 use Illuminate\Support\ServiceProvider;
-use Illuminate\Support\Str;
+use Pixelpeter\IsoCodesValidation\Support\ReferenceResolver;
+use Pixelpeter\IsoCodesValidation\Support\Registry;
+use Pixelpeter\IsoCodesValidation\Support\Replacer;
 
-class IsoCodesValidationServiceProvider extends ServiceProvider
+final class IsoCodesValidationServiceProvider extends ServiceProvider
 {
-    /**
-     * Bootstrap the application services.
-     *
-     * @return void
-     */
-    public function boot()
+    public function boot(): void
     {
-        // load translation files
         $this->loadTranslationsFrom(
             __DIR__.'/../lang',
             'validation'
         );
 
-        // registering intervention validator extension
-        $this->app['validator']->resolver(function ($translator, $data, $rules, $messages, $customAttributes) {
-            // set the validation error messages
-            foreach (get_class_methods('Pixelpeter\IsoCodesValidation\IsoCodesValidator') as $method) {
-                $key = $this->getTranslationKeyFromMethodName($method);
+        $validatorService = $this->app->make('validator');
 
-                $messages[$key] = $this->getErrorMessage($translator, $messages, $key);
-            }
+        foreach (Registry::ruleNames() as $rule) {
+            $validatorService->extend(
+                $rule,
+                function ($attribute, $value, $parameters, $validator) use ($rule): bool {
+                    $validatorClass = Registry::validatorClassForRule($rule);
+                    $referenceResolver = new ReferenceResolver;
+                    $isoCodesValdator = new IsoCodesValidator($attribute, $value, $parameters, $validator, $rule, $validatorClass, $referenceResolver);
 
-            return new IsoCodesValidator($translator, $data, $rules, $messages, $customAttributes);
-        });
-    }
+                    return $isoCodesValdator->validate();
+                },
+                $this->errorMessage($rule)
+            );
 
-    /**
-     * Return translation key for correspondent method name
-     *
-     * @param  string  $name
-     * @return string
-     */
-    private function getTranslationKeyFromMethodName($name)
-    {
-        if (stripos($name, 'validate') !== false) {
-            return Str::snake(substr($name, 8));
-        }
+            $validatorService->replacer($rule, function ($message, $attribute, $_, $parameters, $validator) {
+                $referenceResolver = new ReferenceResolver;
+                $replacer = new Replacer($attribute, $parameters, $validator, $referenceResolver);
 
-        return '';
-    }
+                return $replacer->replace($message);
+            });
 
-    /**
-     * Return the matching error message for the key
-     *
-     * @param  string  $key
-     * @return string
-     */
-    private function getErrorMessage($translator, $messages, $key)
-    {
-        // return error messages passed directly to the validator
-        if (isset($messages[$key])) {
-            return $messages[$key];
-        }
-
-        // return error message from validation translation file
-        if ($translator->has("validation.{$key}")) {
-            return $translator->get("validation.{$key}");
         }
-
-        // return packages default message
-        return $translator->get("validation::validation.{$key}");
     }
 
-    /**
-     * Register the application services.
-     *
-     * @return void
-     */
-    public function register()
+    protected function errorMessage(string $rulename): string
     {
-        //
+        return $this->app->make('translator')->get('validation::validation.'.$rulename);
     }
 }