Merge pull request #8 from worksome/feature/coding-style-3.x

owenvoke · web-flow · commit 9b6d446d4a23 · 2025-02-19T12:21:49.000Z
chore(deps-dev): JIRA-14428 update Coding Style to 3.x
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -10,12 +10,10 @@ jobs:
     strategy:
       matrix:
         os: [ ubuntu-latest ]
-        php: [ 8.2, 8.3 ]
-        laravel: [ 10.*, 11.* ]
+        php: [ 8.2, 8.3, 8.4 ]
+        laravel: [ 11.* ]
         stability: [ prefer-lowest, prefer-stable ]
         include:
-          - laravel: 10.*
-            testbench: 8.*
           - laravel: 11.*
             testbench: 9.*
 
diff --git a/composer.json b/composer.json
@@ -11,13 +11,13 @@
     ],
     "require": {
         "php": "^8.2",
-        "thecodingmachine/safe": "^2.5",
-        "illuminate/contracts": "^10.0 || ^11.0",
-        "illuminate/pipeline": "^10.0 || ^11.0"
+        "thecodingmachine/safe": "^2.5 || ^3.0",
+        "illuminate/contracts": "^11.0",
+        "illuminate/pipeline": "^11.0"
     },
     "require-dev": {
-        "pestphp/pest": "^2.33",
-        "worksome/coding-style": "^2.8"
+        "pestphp/pest": "^3.7",
+        "worksome/coding-style": "^3.1"
     },
     "autoload": {
         "psr-4": {
diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon
@@ -0,0 +1,10 @@
+parameters:
+	ignoreErrors:
+		-
+			message: '''
+				#^Class Worksome\\UkTaxCodeValidator\\UkTaxCode implements deprecated interface Illuminate\\Contracts\\Validation\\Rule\:
+				see ValidationRule$#
+			'''
+			identifier: class.implementsDeprecatedInterface
+			count: 1
+			path: src/UkTaxCode.php
diff --git a/phpstan.neon b/phpstan.neon
@@ -1,6 +1,13 @@
+includes:
+    - ./vendor/worksome/coding-style/phpstan.neon
+    - phpstan-baseline.neon
+
 parameters:
     paths:
         - src
 
     # The level 8 is the highest level
     level: 5
+
+    worksome:
+        declareStrictTypes: false
diff --git a/src/Engine.php b/src/Engine.php
@@ -17,7 +17,7 @@ public function validate(string|TaxCode $taxCode): Response
 
         return $this->validationPipeline($taxCode)
             ->then(
-                fn(TaxCode $taxCode) => $taxCode->getTaxCode() !== ''
+                fn (TaxCode $taxCode) => $taxCode->getTaxCode() !== ''
                 ? Response::error('Invalid tax code.')
                 : Response::success('Tax code is valid.')
             );
@@ -30,7 +30,7 @@ public function getModifiers(string $taxCode): array
     {
         return $this->validationPipeline(
             new TaxCode($taxCode)
-        )->then(fn(TaxCode $taxCode) => $taxCode->getModifiers());
+        )->then(fn (TaxCode $taxCode) => $taxCode->getModifiers());
     }
 
     private function validationPipeline(TaxCode $taxCode): Pipeline
diff --git a/src/Middlewares/EmergencyCodeModifier.php b/src/Middlewares/EmergencyCodeModifier.php
@@ -3,7 +3,6 @@
 namespace Worksome\UkTaxCodeValidator\Middlewares;
 
 use Closure;
-use JetBrains\PhpStorm\Pure;
 use Worksome\UkTaxCodeValidator\Response;
 use Worksome\UkTaxCodeValidator\Rules\MonthOneEmergencyRule;
 use Worksome\UkTaxCodeValidator\Rules\RuleInterface;
@@ -16,7 +15,6 @@ class EmergencyCodeModifier implements ModifierInterface
     /** @var RuleInterface[] */
     private array $emergencyCodeRules;
 
-    #[Pure]
     public function __construct()
     {
         $this->emergencyCodeRules = [
@@ -29,7 +27,7 @@ public function __construct()
     public function handle(TaxCode $taxCode, Closure $next)
     {
         $validEmergencyCodeRules = collect($this->emergencyCodeRules)
-            ->filter(fn(RuleInterface $rule) => $rule->validate($taxCode));
+            ->filter(fn (RuleInterface $rule) => $rule->validate($taxCode));
 
         if ($validEmergencyCodeRules->count() > 1) {
             return Response::error('Only one emergency tax code is allowed.');
diff --git a/src/Middlewares/RegimeModifier.php b/src/Middlewares/RegimeModifier.php
@@ -3,7 +3,6 @@
 namespace Worksome\UkTaxCodeValidator\Middlewares;
 
 use Closure;
-use JetBrains\PhpStorm\Pure;
 use Worksome\UkTaxCodeValidator\Response;
 use Worksome\UkTaxCodeValidator\Rules\RuleInterface;
 use Worksome\UkTaxCodeValidator\Rules\ScottishIncomeRule;
@@ -15,7 +14,6 @@ class RegimeModifier implements ModifierInterface
     /** @var RuleInterface[]  */
     private array $countryModifierRules;
 
-    #[Pure]
     public function __construct()
     {
         $this->countryModifierRules = [
@@ -27,14 +25,15 @@ public function __construct()
     public function handle(TaxCode $taxCode, Closure $next)
     {
         $validCountryRules = collect($this->countryModifierRules)
-            ->filter(fn(RuleInterface $rule) => $rule->validate($taxCode));
+            ->filter(fn (RuleInterface $rule) => $rule->validate($taxCode));
 
         if ($validCountryRules->count() > 1) {
             return Response::error('Only one regime modifier is allowed.');
         }
 
         // Consume the country modifier.
         $taxCode = $validCountryRules->first()?->consume($taxCode) ?? $taxCode;
+
         return $next($taxCode);
     }
 }
diff --git a/src/Middlewares/RemoveSpaces.php b/src/Middlewares/RemoveSpaces.php
@@ -15,6 +15,7 @@ public function handle(TaxCode $taxCode, Closure $next)
             $cleaned,
             $taxCode->getOriginalTaxCode()
         );
+
         return $next($newTaxCode);
     }
 }
diff --git a/src/Middlewares/TaxCodeModifier.php b/src/Middlewares/TaxCodeModifier.php
@@ -3,9 +3,9 @@
 namespace Worksome\UkTaxCodeValidator\Middlewares;
 
 use Closure;
-use JetBrains\PhpStorm\Pure;
 use Worksome\UkTaxCodeValidator\Response;
 use Worksome\UkTaxCodeValidator\Rules\AdditionalRateRule;
+use Worksome\UkTaxCodeValidator\Rules\AdvancedScottishRateRule;
 use Worksome\UkTaxCodeValidator\Rules\BasicPersonalAllowanceRule;
 use Worksome\UkTaxCodeValidator\Rules\BasicRateRule;
 use Worksome\UkTaxCodeValidator\Rules\HigherRateRule;
@@ -15,7 +15,6 @@
 use Worksome\UkTaxCodeValidator\Rules\NoTaxesRule;
 use Worksome\UkTaxCodeValidator\Rules\RuleInterface;
 use Worksome\UkTaxCodeValidator\Rules\TemporaryTaxCodeRule;
-use Worksome\UkTaxCodeValidator\Rules\AdvancedScottishRateRule;
 use Worksome\UkTaxCodeValidator\Rules\TopScottishRateRule;
 use Worksome\UkTaxCodeValidator\TaxCode;
 
@@ -24,7 +23,6 @@ class TaxCodeModifier implements ModifierInterface
     /** @var RuleInterface[] */
     private array $taxCodeRules;
 
-    #[Pure]
     public function __construct()
     {
         $this->taxCodeRules = [
@@ -45,7 +43,7 @@ public function __construct()
     public function handle(TaxCode $taxCode, Closure $next)
     {
         $validTaxCodeRules = collect($this->taxCodeRules)
-            ->filter(fn(RuleInterface $rule) => $rule->validate($taxCode));
+            ->filter(fn (RuleInterface $rule) => $rule->validate($taxCode));
 
         if ($validTaxCodeRules->count() !== 1) {
             return Response::error("There should only be one tax code, found {$validTaxCodeRules->count()}.");
diff --git a/src/Response.php b/src/Response.php
@@ -2,8 +2,6 @@
 
 namespace Worksome\UkTaxCodeValidator;
 
-use JetBrains\PhpStorm\Pure;
-
 /**
  * @internal
  */
@@ -15,13 +13,11 @@ public function __construct(
     ) {
     }
 
-    #[Pure]
     public static function error(string ... $errors): self
     {
         return new self(errors: $errors);
     }
 
-    #[Pure]
     public static function success(string ... $successes): self
     {
         return new self(successes: $successes);
diff --git a/src/TaxCode.php b/src/TaxCode.php
@@ -2,7 +2,6 @@
 
 namespace Worksome\UkTaxCodeValidator;
 
-use JetBrains\PhpStorm\Pure;
 use Stringable;
 use Worksome\UkTaxCodeValidator\Middlewares\ModifierInterface;
 
@@ -21,7 +20,6 @@ public function __construct(
         $this->originalTaxCode = $originalTaxCode ?? $this->taxCode;
     }
 
-    #[Pure]
     public function getTaxCode(): string
     {
         return $this->taxCode;
@@ -32,13 +30,11 @@ public function getOriginalTaxCode(): string
         return $this->originalTaxCode;
     }
 
-    #[Pure]
     public function __toString()
     {
         return $this->getTaxCode();
     }
 
-    #[Pure]
     public function consume(string $consume, ModifierInterface $modifier): TaxCode
     {
         $modifiers = $this->modifiers;
diff --git a/src/UkTaxCode.php b/src/UkTaxCode.php
@@ -16,6 +16,6 @@ public function passes($attribute, $value)
 
     public function message(): string
     {
-        return "The :attribute must be a valid UK tax code.";
+        return 'The :attribute must be a valid UK tax code.';
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,6 @@`
`3`	`3`	`namespace Worksome\UkTaxCodeValidator\Middlewares;`
`4`	`4`
`5`	`5`	`use Closure;`
`6`		`-use JetBrains\PhpStorm\Pure;`
`7`	`6`	`use Worksome\UkTaxCodeValidator\Response;`
`8`	`7`	`use Worksome\UkTaxCodeValidator\Rules\RuleInterface;`
`9`	`8`	`use Worksome\UkTaxCodeValidator\Rules\ScottishIncomeRule;`
`@@ -15,7 +14,6 @@ class RegimeModifier implements ModifierInterface`
`15`	`14`	`/** @var RuleInterface[] */`
`16`	`15`	`private array $countryModifierRules;`
`17`	`16`
`18`		`- #[Pure]`
`19`	`17`	`public function __construct()`
`20`	`18`	`{`
`21`	`19`	`$this->countryModifierRules = [`
`@@ -27,14 +25,15 @@ public function __construct()`
`27`	`25`	`public function handle(TaxCode $taxCode, Closure $next)`
`28`	`26`	`{`
`29`	`27`	`$validCountryRules = collect($this->countryModifierRules)`
`30`		`- ->filter(fn(RuleInterface $rule) => $rule->validate($taxCode));`
	`28`	`+ ->filter(fn (RuleInterface $rule) => $rule->validate($taxCode));`
`31`	`29`
`32`	`30`	`if ($validCountryRules->count() > 1) {`
`33`	`31`	`return Response::error('Only one regime modifier is allowed.');`
`34`	`32`	`}`
`35`	`33`
`36`	`34`	`// Consume the country modifier.`
`37`	`35`	`$taxCode = $validCountryRules->first()?->consume($taxCode) ?? $taxCode;`
	`36`	`+`
`38`	`37`	`return $next($taxCode);`
`39`	`38`	`}`
`40`	`39`	`}`
Original file line number	Diff line number	Diff line change
`@@ -15,6 +15,7 @@ public function handle(TaxCode $taxCode, Closure $next)`
`15`	`15`	`$cleaned,`
`16`	`16`	`$taxCode->getOriginalTaxCode()`
`17`	`17`	`);`
	`18`	`+`
`18`	`19`	`return $next($newTaxCode);`
`19`	`20`	`}`
`20`	`21`	`}`
Original file line number	Diff line number	Diff line change
`@@ -2,8 +2,6 @@`
`2`	`2`
`3`	`3`	`namespace Worksome\UkTaxCodeValidator;`
`4`	`4`
`5`		`-use JetBrains\PhpStorm\Pure;`
`6`		`-`
`7`	`5`	`/**`
`8`	`6`	`* @internal`
`9`	`7`	`*/`
`@@ -15,13 +13,11 @@ public function __construct(`
`15`	`13`	`) {`
`16`	`14`	`}`
`17`	`15`
`18`		`- #[Pure]`
`19`	`16`	`public static function error(string ... $errors): self`
`20`	`17`	`{`
`21`	`18`	`return new self(errors: $errors);`
`22`	`19`	`}`
`23`	`20`
`24`		`- #[Pure]`
`25`	`21`	`public static function success(string ... $successes): self`
`26`	`22`	`{`
`27`	`23`	`return new self(successes: $successes);`