Deprecate DataProviderNameFixer (#907)

Author: kubawerlos

CHANGELOG.md

@@ -1,8 +1,9 @@
 # CHANGELOG for PHP CS Fixer: custom fixers
 
 ## v3.15.0
+- Deprecate DataProviderNameFixer - use "php_unit_data_provider_name"
 - Deprecate PhpdocParamOrderFixer
-- Update minimum PHP CS Fixer version to 3.17.0
+- Update minimum PHP CS Fixer version to 3.19.0
 
 ## v3.14.0
 - Add EmptyFunctionBodyFixer

README.md

@@ -3,7 +3,7 @@
 [![Latest stable version](https://img.shields.io/packagist/v/kubawerlos/php-cs-fixer-custom-fixers.svg?label=current%20version)](https://packagist.org/packages/kubawerlos/php-cs-fixer-custom-fixers)
 [![PHP version](https://img.shields.io/packagist/php-v/kubawerlos/php-cs-fixer-custom-fixers.svg)](https://php.net)
 [![License](https://img.shields.io/github/license/kubawerlos/php-cs-fixer-custom-fixers.svg)](LICENSE)
-![Tests](https://img.shields.io/badge/tests-3444-brightgreen.svg)
+![Tests](https://img.shields.io/badge/tests-3445-brightgreen.svg)
 [![Downloads](https://img.shields.io/packagist/dt/kubawerlos/php-cs-fixer-custom-fixers.svg)](https://packagist.org/packages/kubawerlos/php-cs-fixer-custom-fixers)
 
 [![CI Status](https://github.com/kubawerlos/php-cs-fixer-custom-fixers/workflows/CI/badge.svg?branch=main)](https://github.com/kubawerlos/php-cs-fixer-custom-fixers/actions)
@@ -75,7 +75,8 @@ Constructor's empty braces must be single line.
 ```
 
 #### DataProviderNameFixer
-Data provider names used only once must match the name of the test.
+Data provider names must match the name of the test.
+  DEPRECATED: use `php_unit_data_provider_name` instead.
   *Risky: when relying on name of data provider function.*
 Configuration options:
 - `prefix` (`string`): prefix that replaces "test"; defaults to `'provide'`

composer.json

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

src/Fixer/DataProviderNameFixer.php

@@ -12,20 +12,28 @@
 namespace PhpCsFixerCustomFixers\Fixer;
 
 use PhpCsFixer\Fixer\ConfigurableFixerInterface;
+use PhpCsFixer\Fixer\DeprecatedFixerInterface;
+use PhpCsFixer\Fixer\PhpUnit\PhpUnitDataProviderNameFixer;
 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\Preg;
-use PhpCsFixer\Tokenizer\Token;
 use PhpCsFixer\Tokenizer\Tokens;
-use PhpCsFixerCustomFixers\Analyzer\DataProviderAnalyzer;
 
-final class DataProviderNameFixer extends AbstractFixer implements ConfigurableFixerInterface
+/**
+ * @deprecated
+ */
+final class DataProviderNameFixer extends AbstractFixer implements ConfigurableFixerInterface, DeprecatedFixerInterface
 {
+    private PhpUnitDataProviderNameFixer $phpUnitDataProviderNameFixer;
+
+    public function __construct()
+    {
+        $this->phpUnitDataProviderNameFixer = new PhpUnitDataProviderNameFixer();
+    }
+
     /** @var string */
     private $prefix = 'provide';
 
@@ -35,7 +43,7 @@ final class DataProviderNameFixer extends AbstractFixer implements ConfigurableF
     public function getDefinition(): FixerDefinitionInterface
     {
         return new FixerDefinition(
-            'Data provider names used only once must match the name of the test.',
+            $this->phpUnitDataProviderNameFixer->getDefinition()->getSummary(),
             [
                 new CodeSample(
                     '<?php
@@ -73,80 +81,34 @@ public function getConfigurationDefinition(): FixerConfigurationResolverInterfac
      */
     public function configure(array $configuration): void
     {
-        if (\array_key_exists('prefix', $configuration)) {
-            $this->prefix = $configuration['prefix'];
-        }
-
-        if (\array_key_exists('suffix', $configuration)) {
-            $this->suffix = $configuration['suffix'];
-        }
+        $this->phpUnitDataProviderNameFixer->configure($configuration);
     }
 
     public function getPriority(): int
     {
-        return 0;
+        return $this->phpUnitDataProviderNameFixer->getPriority();
     }
 
     public function isCandidate(Tokens $tokens): bool
     {
-        return $tokens->isAllTokenKindsFound([\T_CLASS, \T_DOC_COMMENT, \T_EXTENDS, \T_FUNCTION, \T_STRING]);
+        return $this->phpUnitDataProviderNameFixer->isCandidate($tokens);
     }
 
     public function isRisky(): bool
     {
-        return true;
+        return $this->phpUnitDataProviderNameFixer->isRisky();
     }
 
     public function fix(\SplFileInfo $file, Tokens $tokens): void
     {
-        $phpUnitTestCaseIndicator = new PhpUnitTestCaseIndicator();
-
-        /** @var array<int> $indices */
-        foreach ($phpUnitTestCaseIndicator->findPhpUnitClasses($tokens) as $indices) {
-            $this->fixNames($tokens, $indices[0], $indices[1]);
-        }
-    }
-
-    private function fixNames(Tokens $tokens, int $startIndex, int $endIndex): void
-    {
-        $dataProviderAnalyzer = new DataProviderAnalyzer();
-        foreach ($dataProviderAnalyzer->getDataProviders($tokens, $startIndex, $endIndex) as $dataProviderAnalysis) {
-            if (\count($dataProviderAnalysis->getUsageIndices()) > 1) {
-                continue;
-            }
-
-            $usageIndex = $dataProviderAnalysis->getUsageIndices()[0];
-
-            $testNameIndex = $tokens->getNextTokenOfKind($usageIndex, [[\T_STRING]]);
-            \assert(\is_int($testNameIndex));
-
-            $dataProviderNewName = $this->getProviderNameForTestName($tokens[$testNameIndex]->getContent());
-            if ($tokens->findSequence([[\T_FUNCTION], [\T_STRING, $dataProviderNewName]], $startIndex, $endIndex) !== null) {
-                continue;
-            }
-
-            $tokens[$dataProviderAnalysis->getNameIndex()] = new Token([\T_STRING, $dataProviderNewName]);
-
-            $newCommentContent = Preg::replace(
-                \sprintf('/(@dataProvider\s+)%s/', $dataProviderAnalysis->getName()),
-                \sprintf('$1%s', $dataProviderNewName),
-                $tokens[$usageIndex]->getContent(),
-            );
-
-            $tokens[$usageIndex] = new Token([\T_DOC_COMMENT, $newCommentContent]);
-        }
+        $this->phpUnitDataProviderNameFixer->fix($file, $tokens);
     }
 
-    private function getProviderNameForTestName(string $name): string
+    /**
+     * @return array<string>
+     */
+    public function getSuccessorsNames(): array
     {
-        $name = Preg::replace('/^test_*/i', '', $name);
-
-        if ($this->prefix === '') {
-            $name = \lcfirst($name);
-        } elseif (\substr($this->prefix, -1) !== '_') {
-            $name = \ucfirst($name);
-        }
-
-        return $this->prefix . $name . $this->suffix;
+        return [$this->phpUnitDataProviderNameFixer->getName()];
     }
 }

tests/Fixer/DataProviderNameFixerTest.php

@@ -12,12 +12,13 @@
 namespace Tests\Fixer;
 
 use PhpCsFixer\Fixer\ConfigurableFixerInterface;
+use PhpCsFixer\Fixer\DeprecatedFixerInterface;
 use PhpCsFixer\FixerConfiguration\FixerOptionInterface;
 
 /**
  * @internal
  *
- * @property ConfigurableFixerInterface $fixer
+ * @property ConfigurableFixerInterface&DeprecatedFixerInterface $fixer
  *
  * @covers \PhpCsFixerCustomFixers\Fixer\DataProviderNameFixer
  */
@@ -40,6 +41,11 @@ public function testIsRisky(): void
         self::assertTrue($this->fixer->isRisky());
     }
 
+    public function testSuccessorName(): void
+    {
+        self::assertContains('php_unit_data_provider_name', $this->fixer->getSuccessorsNames());
+    }
+
     /**
      * @param null|array<string, string> $configuration
      *
@@ -177,16 +183,6 @@ public function notDataProvider() {}
 
         yield 'multiple data providers for test' => [
             '<?php
-class FooTest extends TestCase {
-    /**
-     * @dataProvider provideFooCases
-     * @dataProvider foo2DataProvider
-     */
-    public function testFoo() {}
-    public function provideFooCases() {}
-    public function foo2DataProvider() {}
-}',
-            '<?php
 class FooTest extends TestCase {
     /**
      * @dataProvider foo1DataProvider
@@ -235,13 +231,13 @@ function () { return true; };
 
     /**
      * @dataProvider reusedDataProvider
-     * @dataProvider provideFooCases
+     * @dataProvider dataFooProvider
      */
     public function testFoo() {}
 
     /**
      * @dataProvider reusedDataProvider
-     * @dataProvider provideBarCases
+     * @dataProvider dataBarProvider
      */
     public function testBar() {}
 
@@ -254,8 +250,8 @@ public function provideBazCases() {}
     /** @dataProvider provideSomethingCases */
     public function testSomething() {}
     public function provideSomethingCases() {}
-    public function provideFooCases() {}
-    public function provideBarCases() {}
+    public function dataFooProvider() {}
+    public function dataBarProvider() {}
 }',
             '<?php
 class FooTest extends TestCase {
@@ -270,13 +266,13 @@ function () { return true; };
 
     /**
      * @dataProvider reusedDataProvider
-     * @dataProvider testFooProvider
+     * @dataProvider dataFooProvider
      */
     public function testFoo() {}
 
     /**
      * @dataProvider reusedDataProvider
-     * @dataProvider testBarProvider
+     * @dataProvider dataBarProvider
      */
     public function testBar() {}
 
@@ -289,8 +285,8 @@ public function provideBazCases() {}
     /** @dataProvider someDataProvider */
     public function testSomething() {}
     public function someDataProvider() {}
-    public function testFooProvider() {}
-    public function testBarProvider() {}
+    public function dataFooProvider() {}
+    public function dataBarProvider() {}
 }',
         ];