Deprecate DataProviderStaticFixer (#885)

Author: kubawerlos

.github/workflows/ci.yaml

@@ -88,9 +88,7 @@ jobs:
             jq -r --indent 4 'del(.autoload."psr-4")' composer.json > composer.tmp
             jq -r --indent 4 '.autoload += {"files": ["bootstrap.php"]}' composer.tmp > composer.json
       - if: ${{ matrix.use-shim-package }}
-        run: |
-          composer remove friendsofphp/php-cs-fixer --no-update
-          composer require php-cs-fixer/shim:* --no-update
+        run: sed -i 's#friendsofphp/php-cs-fixer#php-cs-fixer/shim#g' composer.json
       - if: ${{ matrix.with-php-cs-fixer-from-master }}
         run: composer require friendsofphp/php-cs-fixer:dev-master --no-update
       - run: composer update --no-progress ${{ matrix.composer-flags }}

CHANGELOG.md

@@ -2,6 +2,8 @@
 
 ## v3.14.0
 - Add EmptyFunctionBodyFixer
+- Deprecate DataProviderStaticFixer - use "php_unit_data_provider_static"
+- Update minimum PHP CS Fixer version to 3.16.0
 
 ## v3.13.0
 - MultilinePromotedPropertiesFixer - add option "keep_blank_lines"

README.md

@@ -110,6 +110,7 @@ The types returned by data providers must be `iterable`.
 
 #### DataProviderStaticFixer
 Data providers must be static.
+  DEPRECATED: use `php_unit_data_provider_static` instead.
   *Risky: when `force` is set to `true`.*
 Configuration options:
 - `force` (`bool`): whether to make static data providers having dynamic class calls; defaults to `false`

composer.json

@@ -13,7 +13,7 @@
         "php": "^7.4 || ^8.0",
         "ext-filter": "*",
         "ext-tokenizer": "*",
-        "friendsofphp/php-cs-fixer": "^3.6.0"
+        "friendsofphp/php-cs-fixer": "^3.16.0"
     },
     "require-dev": {
         "phpunit/phpunit": "^9.6.4 || ^10.0.14"

src/Fixer/DataProviderStaticFixer.php

@@ -12,27 +12,33 @@
 namespace PhpCsFixerCustomFixers\Fixer;
 
 use PhpCsFixer\Fixer\ConfigurableFixerInterface;
+use PhpCsFixer\Fixer\DeprecatedFixerInterface;
+use PhpCsFixer\Fixer\PhpUnit\PhpUnitDataProviderStaticFixer;
 use PhpCsFixer\FixerConfiguration\FixerConfigurationResolver;
 use PhpCsFixer\FixerConfiguration\FixerConfigurationResolverInterface;
 use PhpCsFixer\FixerConfiguration\FixerOptionBuilder;
 use PhpCsFixer\FixerDefinition\CodeSample;
 use PhpCsFixer\FixerDefinition\FixerDefinition;
 use PhpCsFixer\FixerDefinition\FixerDefinitionInterface;
-use PhpCsFixer\Indicator\PhpUnitTestCaseIndicator;
-use PhpCsFixer\Tokenizer\Token;
 use PhpCsFixer\Tokenizer\Tokens;
-use PhpCsFixer\Tokenizer\TokensAnalyzer;
-use PhpCsFixerCustomFixers\Analyzer\DataProviderAnalyzer;
 
-final class DataProviderStaticFixer extends AbstractFixer implements ConfigurableFixerInterface
+/**
+ * @deprecated
+ */
+final class DataProviderStaticFixer extends AbstractFixer implements ConfigurableFixerInterface, DeprecatedFixerInterface
 {
-    /** @var bool */
-    private $force = false;
+    private bool $force = false;
+    private PhpUnitDataProviderStaticFixer $phpUnitDataProviderStaticFixer;
+
+    public function __construct()
+    {
+        $this->phpUnitDataProviderStaticFixer = new PhpUnitDataProviderStaticFixer();
+    }
 
     public function getDefinition(): FixerDefinitionInterface
     {
         return new FixerDefinition(
-            'Data providers must be static.',
+            $this->phpUnitDataProviderStaticFixer->getDefinition()->getSummary(),
             [
                 new CodeSample(
                     '<?php
@@ -69,16 +75,17 @@ public function configure(array $configuration): void
         if (\array_key_exists('force', $configuration)) {
             $this->force = $configuration['force'];
         }
+        $this->phpUnitDataProviderStaticFixer->configure(['force' => $this->force]);
     }
 
     public function getPriority(): int
     {
-        return 0;
+        return $this->phpUnitDataProviderStaticFixer->getPriority();
     }
 
     public function isCandidate(Tokens $tokens): bool
     {
-        return $tokens->isAllTokenKindsFound([\T_CLASS, \T_DOC_COMMENT, \T_EXTENDS, \T_FUNCTION, \T_STRING]);
+        return $this->phpUnitDataProviderStaticFixer->isCandidate($tokens);
     }
 
     public function isRisky(): bool
@@ -88,40 +95,14 @@ public function isRisky(): bool
 
     public function fix(\SplFileInfo $file, Tokens $tokens): void
     {
-        $phpUnitTestCaseIndicator = new PhpUnitTestCaseIndicator();
-
-        /** @var array<int> $indices */
-        foreach ($phpUnitTestCaseIndicator->findPhpUnitClasses($tokens) as $indices) {
-            $this->fixStatic($tokens, $indices[0], $indices[1]);
-        }
+        $this->phpUnitDataProviderStaticFixer->fix($file, $tokens);
     }
 
-    private function fixStatic(Tokens $tokens, int $startIndex, int $endIndex): void
+    /**
+     * @return array<string>
+     */
+    public function getSuccessorsNames(): array
     {
-        $dataProviderAnalyzer = new DataProviderAnalyzer();
-        $tokensAnalyzer = new TokensAnalyzer($tokens);
-
-        foreach (\array_reverse($dataProviderAnalyzer->getDataProviders($tokens, $startIndex, $endIndex)) as $dataProviderAnalysis) {
-            $methodStartIndex = $tokens->getNextTokenOfKind($dataProviderAnalysis->getNameIndex(), ['{']);
-            if ($methodStartIndex !== null) {
-                $methodEndIndex = $tokens->findBlockEnd(Tokens::BLOCK_TYPE_CURLY_BRACE, $methodStartIndex);
-
-                if (!$this->force && $tokens->findSequence([[\T_VARIABLE, '$this']], $methodStartIndex, $methodEndIndex) !== null) {
-                    continue;
-                }
-            }
-            $functionIndex = $tokens->getPrevTokenOfKind($dataProviderAnalysis->getNameIndex(), [[\T_FUNCTION]]);
-            \assert(\is_int($functionIndex));
-
-            $methodAttributes = $tokensAnalyzer->getMethodAttributes($functionIndex);
-            if ($methodAttributes['static'] !== false) {
-                continue;
-            }
-
-            $tokens->insertAt(
-                $functionIndex,
-                [new Token([\T_STATIC, 'static']), new Token([\T_WHITESPACE, ' '])],
-            );
-        }
+        return [$this->phpUnitDataProviderStaticFixer->getName()];
     }
 }