Make RemoveEmptyClassMethodRector skip deprecated class method, as us…

…ed for BC (#5061)
rectorphp · Sep 21, 2023 · 36f0b4a · 36f0b4a
1 parent 84916ed
commit 36f0b4a
Show file tree

Hide file tree

Showing 5 changed files with 46 additions and 46 deletions.
diff --git a/rector.php b/rector.php
@@ -4,11 +4,7 @@
 
 use Rector\CodingStyle\Rector\String_\UseClassKeywordForClassNameResolutionRector;
 use Rector\Config\RectorConfig;
-use Rector\DeadCode\Rector\ClassMethod\RemoveEmptyClassMethodRector;
 use Rector\DeadCode\Rector\ConstFetch\RemovePhpVersionIdCheckRector;
-use Rector\Naming\Rector\Assign\RenameVariableToMatchMethodCallReturnTypeRector;
-use Rector\Naming\Rector\Class_\RenamePropertyToMatchTypeRector;
-use Rector\Naming\Rector\ClassMethod\RenameParamToMatchTypeRector;
 use Rector\Php55\Rector\String_\StringClassNameToClassConstantRector;
 use Rector\PHPUnit\Set\PHPUnitSetList;
 use Rector\Privatization\Rector\Class_\FinalizeClassesWithoutChildrenCollectorRector;
@@ -57,33 +53,16 @@
 
     $rectorConfig->importNames();
     $rectorConfig->removeUnusedImports();
-    $rectorConfig->parallel();
 
     $rectorConfig->skip([
-        RenamePropertyToMatchTypeRector::class => [
-            __DIR__ . '/src/Console/Command/ListRulesCommand.php',
-            __DIR__ . '/src/Configuration/ConfigInitializer.php',
-        ],
-
-        RemoveEmptyClassMethodRector::class => [
-            __DIR__ . '/packages/BetterPhpDocParser/PhpDocInfo/PhpDocInfo.php',
-        ],
-
-        // resolve later
-        RenameParamToMatchTypeRector::class => [
-            __DIR__ . '/src/Console/Command/ListRulesCommand.php',
-            __DIR__ . '/src/Configuration/ConfigInitializer.php',
-            __DIR__ . '/src/PhpParser/NodeTraverser/RectorNodeTraverser.php',
-        ],
-
-        RenameVariableToMatchMethodCallReturnTypeRector::class => [__DIR__ . '/packages/Config/RectorConfig.php'],
-
         StringClassNameToClassConstantRector::class,
         __DIR__ . '/bin/validate-phpstan-version.php',
         // tests
-        '**/Fixture*',
-        '**/Source*',
-        '**/Expected*',
+        '*/Fixture/*',
+        '*/Fixture*',
+        '*/Source/*',
+        '*/Source*',
+        '*/Expected*',
 
         // keep configs untouched, as the classes are just strings
         UseClassKeywordForClassNameResolutionRector::class => [__DIR__ . '/config', '*/config/*'],

diff --git a/.../DeadCode/Rector/ClassMethod/RemoveEmptyClassMethodRector/Fixture/keep_deprecated.php.inc b/.../DeadCode/Rector/ClassMethod/RemoveEmptyClassMethodRector/Fixture/keep_deprecated.php.inc
@@ -0,0 +1,13 @@
+<?php
+
+namespace Rector\Tests\DeadCode\Rector\ClassMethod\RemoveEmptyClassMethodRector\Fixture;
+
+final class KeepDeprecated
+{
+    /**
+     * @deprecated
+     */
+    public function keep()
+    {
+    }
+}
diff --git a/rules/DeadCode/NodeManipulator/ControllerClassMethodManipulator.php b/rules/DeadCode/NodeManipulator/ControllerClassMethodManipulator.php
@@ -19,23 +19,18 @@ public function __construct(
     ) {
     }
 
-    public function isControllerClassMethodWithBehaviorAnnotation(Class_ $class, ClassMethod $classMethod): bool
+    public function isControllerClassMethod(Class_ $class, ClassMethod $classMethod): bool
     {
-        if (! $this->isControllerClassMethod($class, $classMethod)) {
+        if (! $classMethod->isPublic()) {
             return false;
         }
 
-        $phpDocInfo = $this->phpDocInfoFactory->createFromNodeOrEmpty($classMethod);
-        return $phpDocInfo->hasByType(GenericTagValueNode::class);
-    }
-
-    private function isControllerClassMethod(Class_ $class, ClassMethod $classMethod): bool
-    {
-        if (! $classMethod->isPublic()) {
+        if (! $this->hasParentClassController($class)) {
             return false;
         }
 
-        return $this->hasParentClassController($class);
+        $phpDocInfo = $this->phpDocInfoFactory->createFromNodeOrEmpty($classMethod);
+        return $phpDocInfo->hasByType(GenericTagValueNode::class);
     }
 
     private function hasParentClassController(Class_ $class): bool

diff --git a/rules/DeadCode/Rector/ClassMethod/RemoveEmptyClassMethodRector.php b/rules/DeadCode/Rector/ClassMethod/RemoveEmptyClassMethodRector.php
@@ -8,6 +8,9 @@
 use PhpParser\Node\Name\FullyQualified;
 use PhpParser\Node\Stmt\Class_;
 use PhpParser\Node\Stmt\ClassMethod;
+use PHPStan\PhpDocParser\Ast\PhpDoc\DeprecatedTagValueNode;
+use Rector\BetterPhpDocParser\PhpDocInfo\PhpDocInfo;
+use Rector\BetterPhpDocParser\PhpDocInfo\PhpDocInfoFactory;
 use Rector\Core\NodeAnalyzer\ParamAnalyzer;
 use Rector\Core\NodeManipulator\ClassMethodManipulator;
 use Rector\Core\Rector\AbstractRector;
@@ -24,7 +27,8 @@ final class RemoveEmptyClassMethodRector extends AbstractRector
     public function __construct(
         private readonly ClassMethodManipulator $classMethodManipulator,
         private readonly ControllerClassMethodManipulator $controllerClassMethodManipulator,
-        private readonly ParamAnalyzer $paramAnalyzer
+        private readonly ParamAnalyzer $paramAnalyzer,
+        private readonly PhpDocInfoFactory $phpDocInfoFactory,
     ) {
     }
 
@@ -135,17 +139,29 @@ private function shouldSkipClassMethod(Class_ $class, ClassMethod $classMethod):
             return true;
         }
 
-        if ($this->controllerClassMethodManipulator->isControllerClassMethodWithBehaviorAnnotation(
-            $class,
-            $classMethod
-        )) {
+        if ($this->hasDeprecatedAnnotation($classMethod)) {
+            return true;
+        }
+
+        if ($this->controllerClassMethodManipulator->isControllerClassMethod($class, $classMethod)) {
             return true;
         }
 
         if ($this->nodeNameResolver->isName($classMethod, MethodName::CONSTRUCT)) {
+            // has parent class?
             return $class->extends instanceof FullyQualified;
         }
 
         return $this->nodeNameResolver->isName($classMethod, MethodName::INVOKE);
     }
+
+    private function hasDeprecatedAnnotation(ClassMethod $classMethod): bool
+    {
+        $phpDocInfo = $this->phpDocInfoFactory->createFromNode($classMethod);
+        if (! $phpDocInfo instanceof PhpDocInfo) {
+            return false;
+        }
+
+        return $phpDocInfo->hasByType(DeprecatedTagValueNode::class);
+    }
 }
diff --git a/tests/Issues/InfiniteIfElse/config/configured_rule.php b/tests/Issues/InfiniteIfElse/config/configured_rule.php
@@ -2,13 +2,10 @@
 
 declare(strict_types=1);
 
-use Rector\Config\RectorConfig;
 use Rector\CodingStyle\Rector\Switch_\BinarySwitchToIfElseRector;
+use Rector\Config\RectorConfig;
 use Rector\EarlyReturn\Rector\If_\RemoveAlwaysElseRector;
 
 return static function (RectorConfig $rectorConfig): void {
-    $rectorConfig->rules([
-        BinarySwitchToIfElseRector::class,
-        RemoveAlwaysElseRector::class,
-    ]);
+    $rectorConfig->rules([BinarySwitchToIfElseRector::class, RemoveAlwaysElseRector::class]);
 };