Deprecate DataProviderReturnTypeFixer (#912)

Author: kubawerlos

CHANGELOG.md

@@ -1,5 +1,9 @@
 # CHANGELOG for PHP CS Fixer: custom fixers
 
+## v3.16.0
+- Deprecate DataProviderReturnTypeFixer - use "php_unit_data_provider_return_type"
+- Update minimum PHP CS Fixer version to 3.22.0
+
 ## v3.15.0
 - Deprecate DataProviderNameFixer - use "php_unit_data_provider_name"
 - Deprecate PhpdocParamOrderFixer - use "phpdoc_param_order"

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-3446-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)
@@ -95,7 +95,8 @@ Configuration options:
 ```
 
 #### DataProviderReturnTypeFixer
-The types returned by data providers must be `iterable`.
+The return type of PHPUnit data provider must be `iterable`.
+  DEPRECATED: use `php_unit_data_provider_return_type` instead.
   *Risky: when relying on signature of data provider.*
 ```diff
  <?php

composer.json

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

src/Fixer/DataProviderReturnTypeFixer.php

@@ -11,22 +11,29 @@
 
 namespace PhpCsFixerCustomFixers\Fixer;
 
+use PhpCsFixer\Fixer\DeprecatedFixerInterface;
+use PhpCsFixer\Fixer\PhpUnit\PhpUnitDataProviderReturnTypeFixer;
 use PhpCsFixer\FixerDefinition\CodeSample;
 use PhpCsFixer\FixerDefinition\FixerDefinition;
 use PhpCsFixer\FixerDefinition\FixerDefinitionInterface;
-use PhpCsFixer\Indicator\PhpUnitTestCaseIndicator;
-use PhpCsFixer\Tokenizer\Analyzer\FunctionsAnalyzer;
-use PhpCsFixer\Tokenizer\CT;
-use PhpCsFixer\Tokenizer\Token;
 use PhpCsFixer\Tokenizer\Tokens;
-use PhpCsFixerCustomFixers\Analyzer\DataProviderAnalyzer;
 
-final class DataProviderReturnTypeFixer extends AbstractFixer
+/**
+ * @deprecated
+ */
+final class DataProviderReturnTypeFixer extends AbstractFixer implements DeprecatedFixerInterface
 {
+    private PhpUnitDataProviderReturnTypeFixer $phpUnitDataProviderReturnTypeFixer;
+
+    public function __construct()
+    {
+        $this->phpUnitDataProviderReturnTypeFixer = new PhpUnitDataProviderReturnTypeFixer();
+    }
+
     public function getDefinition(): FixerDefinitionInterface
     {
         return new FixerDefinition(
-            'The types returned by data providers must be `iterable`.',
+            $this->phpUnitDataProviderReturnTypeFixer->getDefinition()->getSummary(),
             [
                 new CodeSample(
                     '<?php
@@ -50,57 +57,29 @@ public function provideSomethingCases(): array {}
      */
     public function getPriority(): int
     {
-        return 0;
+        return $this->phpUnitDataProviderReturnTypeFixer->getPriority();
     }
 
     public function isCandidate(Tokens $tokens): bool
     {
-        return $tokens->isAllTokenKindsFound([\T_CLASS, \T_DOC_COMMENT, \T_EXTENDS, \T_FUNCTION, \T_STRING]);
+        return $this->phpUnitDataProviderReturnTypeFixer->isCandidate($tokens);
     }
 
     public function isRisky(): bool
     {
-        return true;
+        return $this->phpUnitDataProviderReturnTypeFixer->isRisky();
     }
 
     public function fix(\SplFileInfo $file, Tokens $tokens): void
     {
-        $phpUnitTestCaseIndicator = new PhpUnitTestCaseIndicator();
-
-        /** @var array<int> $indices */
-        foreach ($phpUnitTestCaseIndicator->findPhpUnitClasses($tokens) as $indices) {
-            $this->fixReturnTypes($tokens, $indices[0], $indices[1]);
-        }
+        $this->phpUnitDataProviderReturnTypeFixer->fix($file, $tokens);
     }
 
-    private function fixReturnTypes(Tokens $tokens, int $startIndex, int $endIndex): void
+    /**
+     * @return array<string>
+     */
+    public function getSuccessorsNames(): array
     {
-        $dataProviderAnalyzer = new DataProviderAnalyzer();
-        $functionsAnalyzer = new FunctionsAnalyzer();
-
-        foreach (\array_reverse($dataProviderAnalyzer->getDataProviders($tokens, $startIndex, $endIndex)) as $dataProviderAnalysis) {
-            $typeAnalysis = $functionsAnalyzer->getFunctionReturnType($tokens, $dataProviderAnalysis->getNameIndex());
-
-            if ($typeAnalysis === null) {
-                $argumentsStart = $tokens->getNextTokenOfKind($dataProviderAnalysis->getNameIndex(), ['(']);
-                \assert(\is_int($argumentsStart));
-                $argumentsEnd = $tokens->findBlockEnd(Tokens::BLOCK_TYPE_PARENTHESIS_BRACE, $argumentsStart);
-                $tokens->insertAt(
-                    $argumentsEnd + 1,
-                    [
-                        new Token([CT::T_TYPE_COLON, ':']),
-                        new Token([\T_WHITESPACE, ' ']),
-                        new Token([\T_STRING, 'iterable']),
-                    ],
-                );
-                continue;
-            }
-
-            if ($typeAnalysis->getName() !== 'iterable') {
-                $startIndex = $tokens->getNextMeaningfulToken($typeAnalysis->getStartIndex() - 1);
-                \assert(\is_int($startIndex));
-                $tokens->overrideRange($startIndex, $typeAnalysis->getEndIndex(), [new Token([\T_STRING, 'iterable'])]);
-            }
-        }
+        return [$this->phpUnitDataProviderReturnTypeFixer->getName()];
     }
 }

tests/Fixer/DataProviderReturnTypeFixerTest.php

@@ -11,9 +11,14 @@
 
 namespace Tests\Fixer;
 
+use PhpCsFixer\Fixer\ConfigurableFixerInterface;
+use PhpCsFixer\Fixer\DeprecatedFixerInterface;
+
 /**
  * @internal
  *
+ * @property ConfigurableFixerInterface&DeprecatedFixerInterface $fixer
+ *
  * @covers \PhpCsFixerCustomFixers\Fixer\DataProviderReturnTypeFixer
  */
 final class DataProviderReturnTypeFixerTest extends AbstractFixerTestCase
@@ -38,6 +43,11 @@ public function testIsRisky(): void
         self::assertTrue($this->fixer->isRisky());
     }
 
+    public function testSuccessorName(): void
+    {
+        self::assertContains('php_unit_data_provider_return_type', $this->fixer->getSuccessorsNames());
+    }
+
     /**
      * @dataProvider provideFixCases
      */
@@ -207,32 +217,6 @@ public function provideFooCases() {}
         }
     }
 
-    /**
-     * @requires PHP ^7.4
-     *
-     * @dataProvider provideFix7Cases
-     */
-    public function testFix7(string $expected, ?string $input = null): void
-    {
-        $this->doTest($expected, $input);
-    }
-
-    /**
-     * @return iterable<array{string, string}>
-     */
-    public static function provideFix7Cases(): iterable
-    {
-        yield 'data provider with return type namespaced class starting with iterable' => self::mapToTemplate(
-            ': iterable',
-            ': iterable \ Foo',
-        );
-
-        yield 'data provider with return type namespaced class and comments' => self::mapToTemplate(
-            ': iterable',
-            ': Foo/* Some info */\/* More info */Bar',
-        );
-    }
-
     /**
      * @return array{string, string}
      */