[depre] Deprecate RemoveDataProviderParamKeysRector as the keys can be useful to improve test readability (#584)

#469 (comment)

Author: MacDada

config/sets/phpunit-code-quality.php

@@ -8,7 +8,6 @@
 use Rector\PHPUnit\CodeQuality\Rector\Class_\ConstructClassMethodToSetUpTestCaseRector;
 use Rector\PHPUnit\CodeQuality\Rector\Class_\NarrowUnusedSetUpDefinedPropertyRector;
 use Rector\PHPUnit\CodeQuality\Rector\Class_\PreferPHPUnitThisCallRector;
-use Rector\PHPUnit\CodeQuality\Rector\Class_\RemoveDataProviderParamKeysRector;
 use Rector\PHPUnit\CodeQuality\Rector\Class_\SingleMockPropertyTypeRector;
 use Rector\PHPUnit\CodeQuality\Rector\Class_\TestWithToDataProviderRector;
 use Rector\PHPUnit\CodeQuality\Rector\Class_\TypeWillReturnCallableArrowFunctionRector;
@@ -69,9 +68,6 @@
         AssertEqualsOrAssertSameFloatParameterToSpecificMethodsTypeRector::class,
         DataProviderArrayItemsNewLinedRector::class,
 
-        // PHPUnit 11 reports warnings on typos + keys are rather noise than useful, fake system-keys for values
-        RemoveDataProviderParamKeysRector::class,
-
         FlipAssertRector::class,
 
         // narrow with consecutive

rules-tests/CodeQuality/Rector/Class_/RemoveDataProviderParamKeysRector/Fixture/keep_dataset_description.php.inc

@@ -5,29 +5,20 @@
 namespace Rector\PHPUnit\CodeQuality\Rector\Class_;
 
 use PhpParser\Node;
-use PhpParser\Node\Expr;
-use PhpParser\Node\Expr\Array_;
-use PhpParser\Node\Expr\Yield_;
 use PhpParser\Node\Stmt\Class_;
-use PhpParser\Node\Stmt\Expression;
-use PhpParser\Node\Stmt\Return_;
-use Rector\PHPUnit\NodeAnalyzer\TestsNodeAnalyzer;
-use Rector\PHPUnit\NodeFinder\DataProviderClassMethodFinder;
+use Rector\Configuration\Deprecation\Contract\DeprecatedInterface;
+use Rector\Exception\ShouldNotHappenException;
 use Rector\Rector\AbstractRector;
 use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
 use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
 
 /**
- * @see \Rector\PHPUnit\Tests\CodeQuality\Rector\Class_\RemoveDataProviderParamKeysRector\RemoveDataProviderParamKeysRectorTest
+ * @deprecated as the keys can be useful to improve test readability
+ *
+ * @see https://github.com/rectorphp/rector-phpunit/pull/469#issuecomment-3533161836
  */
-final class RemoveDataProviderParamKeysRector extends AbstractRector
+final class RemoveDataProviderParamKeysRector extends AbstractRector implements DeprecatedInterface
 {
-    public function __construct(
-        private readonly TestsNodeAnalyzer $testsNodeAnalyzer,
-        private readonly DataProviderClassMethodFinder $dataProviderClassMethodFinder,
-    ) {
-    }
-
     public function getRuleDefinition(): RuleDefinition
     {
         return new RuleDefinition('Remove data provider keys, that should match param names, as order is good enough', [
@@ -89,77 +80,9 @@ public function getNodeTypes(): array
      */
     public function refactor(Node $node): ?Node
     {
-        if (! $this->testsNodeAnalyzer->isInTestClass($node)) {
-            return null;
-        }
-
-        $dataProviderClassMethods = $this->dataProviderClassMethodFinder->find($node);
-        $hasChanged = false;
-
-        foreach ($dataProviderClassMethods as $dataProviderClassMethod) {
-            // 1. remove array keys
-            foreach ((array) $dataProviderClassMethod->stmts as $classMethodStmt) {
-                if (! $classMethodStmt instanceof Return_) {
-                    continue;
-                }
-
-                if (! $classMethodStmt->expr instanceof Array_) {
-                    continue;
-                }
-
-                $returnedArray = $classMethodStmt->expr;
-                foreach ($returnedArray->items as $arrayItem) {
-                    if (! $arrayItem->value instanceof Array_) {
-                        continue;
-                    }
-
-                    $nestedArray = $arrayItem->value;
-                    foreach ($nestedArray->items as $nestedArrayItem) {
-                        if (! $nestedArrayItem->key instanceof Expr) {
-                            continue;
-                        }
-
-                        // remove key
-                        $nestedArrayItem->key = null;
-                        $hasChanged = true;
-                    }
-
-                }
-            }
-
-            // 2. remove yield keys
-            foreach ((array) $dataProviderClassMethod->stmts as $classMethodStmt) {
-                if (! $classMethodStmt instanceof Expression) {
-                    continue;
-                }
-
-                if (! $classMethodStmt->expr instanceof Yield_) {
-                    continue;
-                }
-
-                $yield = $classMethodStmt->expr;
-                if (! $yield->value instanceof Array_) {
-                    continue;
-                }
-
-                $yieldArray = $yield->value;
-
-                foreach ($yieldArray->items as $yieldArrayItem) {
-                    if (! $yieldArrayItem->key instanceof Expr) {
-                        continue;
-                    }
-
-                    // remove key
-                    $yieldArrayItem->key = null;
-                    $hasChanged = true;
-                }
-            }
-        }
-
-        if ($hasChanged === false) {
-            return null;
-        }
-
-        return $node;
+        throw new ShouldNotHappenException(sprintf(
+            '"%s" is deprecated and should not be used anymore. Remove it from your config files.',
+            self::class,
+        ));
     }
 }