fix: implement new configurable fixer api (#213)

* refactor: apply new coding standards * fix compatibility with 3.59.3 * fix compatibility with 3.59.3 (#210) Co-authored-by: Joris Mak <[email protected]> * refactor: apply new coding standards --------- Co-authored-by: Joris Mak <[email protected]> Co-authored-by: Joris Mak <[email protected]>
PedroTroller · Aug 2, 2024 · 68613e1 · 68613e1
1 parent a0c9d6d
commit 68613e1
Show file tree

Hide file tree

Showing 24 changed files with 96 additions and 65 deletions.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -106,19 +106,29 @@ workflows:
       - documentation:
           matrix:
             parameters:
-              php-version: ["8.2"]
+              php-version:
+                - "8.3"
       - tests:
           matrix:
             parameters:
-              php-version: ["8.0", "8.1", "8.2"]
+              php-version:
+                - "8.1"
+                - "8.2"
+                - "8.3"
       - tests-with-future-mode:
           matrix:
             parameters:
-              php-version: ["8.0", "8.1", "8.2"]
+              php-version:
+                - "8.1"
+                - "8.2"
+                - "8.3"
       - tests-with-lowest-dependencies:
           matrix:
             parameters:
-              php-version: ["8.0", "8.1", "8.2"]
+              php-version:
+                - "8.1"
+                - "8.2"
+                - "8.3"
       - release-test
       - release:
           requires:

diff --git a/.php-cs-fixer.dist.php b/.php-cs-fixer.dist.php
@@ -4,14 +4,16 @@
 
 use PedroTroller\CS\Fixer\Fixers;
 use PedroTroller\CS\Fixer\RuleSetFactory;
+use PhpCsFixer\Config;
+use PhpCsFixer\Finder;
 
-return (new PhpCsFixer\Config())
+return (new Config())
     ->setRiskyAllowed(true)
     ->setRules(
         RuleSetFactory::create()
             ->per(2, true)
             ->phpCsFixer(true)
-            ->php(8.0, true)
+            ->php(8.1, true)
             ->pedrotroller(true)
             ->enable('align_multiline_comment')
             ->enable('array_indentation')
@@ -34,7 +36,7 @@
     ->setUsingCache(false)
     ->registerCustomFixers(new Fixers())
     ->setFinder(
-        PhpCsFixer\Finder::create()
+        Finder::create()
             ->in(__DIR__)
             ->append([__FILE__, __DIR__.'/bin/doc'])
     )

diff --git a/README.md b/README.md
@@ -384,12 +384,12 @@ Prohibited functions MUST BE commented on as prohibited
 
 ### Available options
 
- - `functions` (*optional*): The function names to be marked how prohibited
-    - default: `var_dump`, `dump`, `die`
-
  - `comment` (*optional*): The prohibition message to put in the comment
     - default: `@TODO remove this line`
 
+ - `functions` (*optional*): The function names to be marked how prohibited
+    - default: `var_dump`, `dump`, `die`
+
 ### Configuration examples
 
 ```php
@@ -511,18 +511,18 @@ If the declaration of a method is too long, the arguments of this method MUST BE
 
 ### Available options
 
- - `max-args` (*optional*): The maximum number of arguments allowed with splitting the arguments into several lines (use `false` to disable this feature)
-    - default: `3`
-
- - `max-length` (*optional*): The maximum number of characters allowed with splitting the arguments into several lines
-    - default: `120`
-
  - `automatic-argument-merge` (*optional*): If both conditions are met (the line is not too long and there are not too many arguments), then the arguments are put back inline
     - default: `true`
 
  - `inline-attributes` (*optional*): In the case of a split, the declaration of the attributes of the arguments of the method will be on the same line as the arguments themselves
     - default: `false`
 
+ - `max-args` (*optional*): The maximum number of arguments allowed with splitting the arguments into several lines (use `false` to disable this feature)
+    - default: `3`
+
+ - `max-length` (*optional*): The maximum number of characters allowed with splitting the arguments into several lines
+    - default: `120`
+
 ### Configuration examples
 
 ```php

diff --git a/bin/Utils.php b/bin/Utils.php
@@ -4,7 +4,7 @@
 
 final class Utils
 {
-    public static function arrayToString(array $array = null)
+    public static function arrayToString(?array $array = null)
     {
         if (null === $array) {
             return;

diff --git a/bin/doc b/bin/doc
@@ -1,7 +1,10 @@
 #!/usr/bin/env php
 <?php
 
+declare(strict_types=1);
+
 use PedroTroller\CS\Fixer\AbstractFixer;
+use PedroTroller\CS\Fixer\Fixers;
 use PhpCsFixer\Fixer\ConfigurableFixerInterface;
 use PhpCsFixer\FixerConfiguration\FixerOptionInterface;
 use PhpCsFixer\FixerDefinition\CodeSample;
@@ -80,7 +83,7 @@ $fixers = array_map(static function (AbstractFixer $fixer) {
             ];
         }, $samples),
     ];
-}, iterator_to_array(new PedroTroller\CS\Fixer\Fixers()));
+}, [...(new Fixers())]);
 
 $loader = new FilesystemLoader([__DIR__]);
 $twig   = new Environment($loader);

diff --git a/composer.json b/composer.json
@@ -3,15 +3,18 @@
     "description": "PHP-CS-FIXER : my custom fixers",
     "license": "MIT",
     "require": {
-        "php": "^8.0"
+        "php": "^8.1",
+        "friendsofphp/php-cs-fixer": ">=3.59.3"
     },
     "require-dev": {
-        "friendsofphp/php-cs-fixer": "^3.28",
+        "friendsofphp/php-cs-fixer": "^3.60",
         "phpspec/phpspec": "^7.0",
         "sebastian/diff": "^4.0",
         "twig/twig": "^3.3",
         "webmozart/assert": "^1.10"
     },
+    "minimum-stability": "dev",
+    "prefer-stable": true,
     "autoload": {
         "psr-4": {
             "PedroTroller\\CS\\Fixer\\": "src/PedroTroller/CS/Fixer"
@@ -31,19 +34,17 @@
             "dev-master": "3.x-dev"
         }
     },
-    "minimum-stability": "dev",
-    "prefer-stable": true,
     "scripts": {
-        "tests": [
-            "tests\\Runner::run",
-            "tests\\Orchestra::run",
-            "phpspec run -fpretty"
+        "lint": [
+            "@php-cs-fixer"
         ],
         "php-cs-fixer": [
             "php-cs-fixer fix --dry-run -vvv --diff"
         ],
-        "lint": [
-            "@php-cs-fixer"
+        "tests": [
+            "tests\\Runner::run",
+            "tests\\Orchestra::run",
+            "phpspec run -fpretty"
         ]
     }
 }
diff --git a/src/PedroTroller/CS/Fixer/AbstractFixer.php b/src/PedroTroller/CS/Fixer/AbstractFixer.php
@@ -23,7 +23,7 @@ public function isCandidate(Tokens $tokens): bool
 
     public function getName(): string
     {
-        return sprintf('PedroTroller/%s', parent::getName());
+        return \sprintf('PedroTroller/%s', parent::getName());
     }
 
     /**
@@ -45,7 +45,7 @@ public function getDefinition(): FixerDefinitionInterface
         return new FixerDefinition(
             $this->getDocumentation(),
             array_map(
-                fn (array $configutation = null) => new CodeSample($this->getSampleCode(), $configutation),
+                fn (?array $configutation = null) => new CodeSample($this->getSampleCode(), $configutation),
                 $this->getSampleConfigurations()
             )
         );

diff --git a/src/PedroTroller/CS/Fixer/Behat/OrderBehatStepsFixer.php b/src/PedroTroller/CS/Fixer/Behat/OrderBehatStepsFixer.php
@@ -8,13 +8,16 @@
 use PedroTroller\CS\Fixer\Priority;
 use PhpCsFixer\Fixer\ClassNotation\OrderedClassElementsFixer;
 use PhpCsFixer\Fixer\ConfigurableFixerInterface;
+use PhpCsFixer\Fixer\ConfigurableFixerTrait;
 use PhpCsFixer\FixerConfiguration\FixerConfigurationResolver;
 use PhpCsFixer\FixerConfiguration\FixerConfigurationResolverInterface;
 use PhpCsFixer\FixerConfiguration\FixerOptionBuilder;
 use PhpCsFixer\Tokenizer\Tokens;
 
 final class OrderBehatStepsFixer extends AbstractOrderedClassElementsFixer implements ConfigurableFixerInterface
 {
+    use ConfigurableFixerTrait;
+
     public const ANNOTATION_PRIORITIES = [
         '@BeforeSuite',
         '@AfterSuite',
@@ -126,7 +129,7 @@ public function getDocumentation(): string
         return 'Step definition methods in Behat contexts MUST BE ordered by annotation and method name.';
     }
 
-    public function getConfigurationDefinition(): FixerConfigurationResolverInterface
+    public function createConfigurationDefinition(): FixerConfigurationResolverInterface
     {
         return new FixerConfigurationResolver([
             (new FixerOptionBuilder('instanceof', 'Parent class or interface of your behat context classes.'))

diff --git a/src/PedroTroller/CS/Fixer/ClassNotation/OrderedWithGetterAndSetterFirstFixer.php b/src/PedroTroller/CS/Fixer/ClassNotation/OrderedWithGetterAndSetterFirstFixer.php
@@ -152,11 +152,11 @@ private function getMethodsNames(array $elements): array
         $methods = [];
 
         foreach ($this->getPropertiesNames($elements) as $name) {
-            $methods[] = sprintf('get%s', ucfirst($name));
-            $methods[] = sprintf('is%s', ucfirst($name));
-            $methods[] = sprintf('has%s', ucfirst($name));
+            $methods[] = \sprintf('get%s', ucfirst($name));
+            $methods[] = \sprintf('is%s', ucfirst($name));
+            $methods[] = \sprintf('has%s', ucfirst($name));
             $methods[] = lcfirst($name);
-            $methods[] = sprintf('set%s', ucfirst($name));
+            $methods[] = \sprintf('set%s', ucfirst($name));
         }
 
         return $methods;

diff --git a/src/PedroTroller/CS/Fixer/CodingStyle/ExceptionsPunctuationFixer.php b/src/PedroTroller/CS/Fixer/CodingStyle/ExceptionsPunctuationFixer.php
@@ -152,6 +152,6 @@ private function cleanupMessage(Token $token): Token
                 return $token;
         }
 
-        return new Token([T_CONSTANT_ENCAPSED_STRING, sprintf('%s%s.%s', $quotes, implode('', $chars), $quotes)]);
+        return new Token([T_CONSTANT_ENCAPSED_STRING, \sprintf('%s%s.%s', $quotes, implode('', $chars), $quotes)]);
     }
 }
diff --git a/src/PedroTroller/CS/Fixer/CodingStyle/ForbiddenFunctionsFixer.php b/src/PedroTroller/CS/Fixer/CodingStyle/ForbiddenFunctionsFixer.php
@@ -6,6 +6,7 @@
 
 use PedroTroller\CS\Fixer\AbstractFixer;
 use PhpCsFixer\Fixer\ConfigurableFixerInterface;
+use PhpCsFixer\Fixer\ConfigurableFixerTrait;
 use PhpCsFixer\FixerConfiguration\FixerConfigurationResolver;
 use PhpCsFixer\FixerConfiguration\FixerConfigurationResolverInterface;
 use PhpCsFixer\FixerConfiguration\FixerOptionBuilder;
@@ -15,6 +16,8 @@
 
 final class ForbiddenFunctionsFixer extends AbstractFixer implements ConfigurableFixerInterface
 {
+    use ConfigurableFixerTrait;
+
     public function getSampleCode(): string
     {
         return <<<'PHP'
@@ -53,7 +56,7 @@ public function getDocumentation(): string
         return 'Prohibited functions MUST BE commented on as prohibited';
     }
 
-    public function getConfigurationDefinition(): FixerConfigurationResolverInterface
+    public function createConfigurationDefinition(): FixerConfigurationResolverInterface
     {
         return new FixerConfigurationResolver([
             (new FixerOptionBuilder('functions', 'The function names to be marked how prohibited'))
@@ -86,7 +89,7 @@ protected function applyFix(SplFileInfo $file, Tokens $tokens): void
 
             if (\in_array($token->getContent(), $this->configuration['functions'], true)) {
                 $end          = $this->analyze($tokens)->getEndOfTheLine($index);
-                $tokens[$end] = new Token([T_WHITESPACE, sprintf(' // %s%s', $this->configuration['comment'], $tokens[$end]->getContent())]);
+                $tokens[$end] = new Token([T_WHITESPACE, \sprintf(' // %s%s', $this->configuration['comment'], $tokens[$end]->getContent())]);
             }
         }
     }

diff --git a/src/PedroTroller/CS/Fixer/CodingStyle/LineBreakBetweenMethodArgumentsFixer.php b/src/PedroTroller/CS/Fixer/CodingStyle/LineBreakBetweenMethodArgumentsFixer.php
@@ -8,6 +8,7 @@
 use PedroTroller\CS\Fixer\Priority;
 use PhpCsFixer\Fixer\Basic\BracesFixer;
 use PhpCsFixer\Fixer\ConfigurableFixerInterface;
+use PhpCsFixer\Fixer\ConfigurableFixerTrait;
 use PhpCsFixer\Fixer\FunctionNotation\MethodArgumentSpaceFixer;
 use PhpCsFixer\Fixer\WhitespacesAwareFixerInterface;
 use PhpCsFixer\FixerConfiguration\FixerConfigurationResolver;
@@ -19,6 +20,8 @@
 
 final class LineBreakBetweenMethodArgumentsFixer extends AbstractFixer implements ConfigurableFixerInterface, WhitespacesAwareFixerInterface
 {
+    use ConfigurableFixerTrait;
+
     public const T_TYPEHINT_SEMI_COLON = 10025;
 
     public function getPriority(): int
@@ -81,7 +84,7 @@ public function fun3(
             SPEC;
     }
 
-    public function getConfigurationDefinition(): FixerConfigurationResolverInterface
+    public function createConfigurationDefinition(): FixerConfigurationResolverInterface
     {
         return new FixerConfigurationResolver([
             (new FixerOptionBuilder('max-args', 'The maximum number of arguments allowed with splitting the arguments into several lines (use `false` to disable this feature)'))

diff --git a/src/PedroTroller/CS/Fixer/Comment/CommentLineToPhpdocBlockFixer.php b/src/PedroTroller/CS/Fixer/Comment/CommentLineToPhpdocBlockFixer.php
@@ -153,6 +153,6 @@ private function formatComments(array $comments, string $indentation): string
         $comments = implode("\n", $comments);
         $comments = trim($comments, " \n");
 
-        return sprintf("/**\n%s %s\n%s */", $indentation, $comments, $indentation);
+        return \sprintf("/**\n%s %s\n%s */", $indentation, $comments, $indentation);
     }
 }
diff --git a/src/PedroTroller/CS/Fixer/DoctrineMigrationsFixer.php b/src/PedroTroller/CS/Fixer/DoctrineMigrationsFixer.php
@@ -6,6 +6,7 @@
 
 use PhpCsFixer\Fixer\ClassNotation\ClassAttributesSeparationFixer;
 use PhpCsFixer\Fixer\ConfigurableFixerInterface;
+use PhpCsFixer\Fixer\ConfigurableFixerTrait;
 use PhpCsFixer\Fixer\Phpdoc\NoEmptyPhpdocFixer;
 use PhpCsFixer\Fixer\Whitespace\NoExtraBlankLinesFixer;
 use PhpCsFixer\FixerConfiguration\FixerConfigurationResolver;
@@ -17,6 +18,8 @@
 
 final class DoctrineMigrationsFixer extends AbstractFixer implements ConfigurableFixerInterface
 {
+    use ConfigurableFixerTrait;
+
     /**
      * @var string[]
      */
@@ -100,7 +103,7 @@ public function getPriority(): int
         return Priority::before(ClassAttributesSeparationFixer::class, NoEmptyPhpdocFixer::class, NoExtraBlankLinesFixer::class);
     }
 
-    public function getConfigurationDefinition(): FixerConfigurationResolverInterface
+    public function createConfigurationDefinition(): FixerConfigurationResolverInterface
     {
         return new FixerConfigurationResolver([
             (new FixerOptionBuilder('instanceof', 'The parent class of which Doctrine migrations extend'))

diff --git a/src/PedroTroller/CS/Fixer/PhpspecFixer.php b/src/PedroTroller/CS/Fixer/PhpspecFixer.php
@@ -6,6 +6,7 @@
 
 use PhpCsFixer\Fixer\ClassNotation\VisibilityRequiredFixer;
 use PhpCsFixer\Fixer\ConfigurableFixerInterface;
+use PhpCsFixer\Fixer\ConfigurableFixerTrait;
 use PhpCsFixer\Fixer\FunctionNotation\StaticLambdaFixer;
 use PhpCsFixer\Fixer\FunctionNotation\VoidReturnFixer;
 use PhpCsFixer\FixerConfiguration\FixerConfigurationResolver;
@@ -17,6 +18,8 @@
 
 final class PhpspecFixer extends AbstractOrderedClassElementsFixer implements ConfigurableFixerInterface
 {
+    use ConfigurableFixerTrait;
+
     public function getSampleConfigurations(): array
     {
         return [
@@ -101,7 +104,7 @@ public function getPriority(): int
         );
     }
 
-    public function getConfigurationDefinition(): FixerConfigurationResolverInterface
+    public function createConfigurationDefinition(): FixerConfigurationResolverInterface
     {
         return new FixerConfigurationResolver([
             (new FixerOptionBuilder('instanceof', 'Parent classes of your spec classes.'))
@@ -262,7 +265,7 @@ private function filterElementsByMethodName(string $regex, array $elements): arr
         $filter = [];
 
         foreach ($this->filterElementsByType('method', $elements) as $index => $method) {
-            if (0 !== preg_match(sprintf('/^%s$/', $regex), $method['methodName'])) {
+            if (0 !== preg_match(\sprintf('/^%s$/', $regex), $method['methodName'])) {
                 $filter[$index] = $method;
             }
         }

diff --git a/src/PedroTroller/CS/Fixer/RuleSetFactory.php b/src/PedroTroller/CS/Fixer/RuleSetFactory.php
@@ -55,7 +55,7 @@ public static function create(array $rules = []): self
         );
     }
 
-    public function per(int|float $version = null, bool $risky = false): self
+    public function per(null|float|int $version = null, bool $risky = false): self
     {
         $candidates = null !== $version
             ? ['@PER-CS'.number_format($version, 1, '.', '')]
@@ -198,7 +198,7 @@ public function pedrotroller(bool $risky = false): self
         ));
     }
 
-    public function enable(string $name, array $config = null): self
+    public function enable(string $name, ?array $config = null): self
     {
         return self::create(array_merge(
             $this->rules,