keep merge comments decoupled from abstract rector, remove unnecessary key to trigger comment merge

Author: TomasVotruba

composer.json

@@ -56,7 +56,7 @@
         "rector/type-perfect": "^2.1",
         "shipmonk/composer-dependency-analyser": "^1.8",
         "symplify/phpstan-extensions": "^12.0.2",
-        "symplify/phpstan-rules": "dev-main",
+        "symplify/phpstan-rules": "^14.9.4",
         "symplify/vendor-patches": "^11.5",
         "tomasvotruba/class-leak": "^2.1",
         "tomasvotruba/unused-public": "^2.1",

rules-tests/DeadCode/Rector/Expression/RemoveDeadStmtRector/FixtureRemovedComments/array_dim_fetch.php.inc

@@ -2,19 +2,19 @@
 
 namespace Rector\Tests\CodeQuality\Rector\Stmt\DeadCodeRemovingRector\Fixture\ArrayDimFetch;
 
-function wrapToPreventPhpStanCallingMethods ()
+function wrapToPreventPhpStanCallingMethods()
 {
     $var[0] = 1;
 
     $var[0];
 
-    //comment
+    //comment 1
     $var[methodCall()];
 
-    //comment
+    //comment 2
     ${methodCall()}[0];
 
-    //comment
+    //comment 3
     ${methodCall1()}[methodCall2()];
 }
 ?>
@@ -23,19 +23,18 @@ function wrapToPreventPhpStanCallingMethods ()
 
 namespace Rector\Tests\CodeQuality\Rector\Stmt\DeadCodeRemovingRector\Fixture\ArrayDimFetch;
 
-function wrapToPreventPhpStanCallingMethods ()
+function wrapToPreventPhpStanCallingMethods()
 {
     $var[0] = 1;
 
-    //comment
+    //comment 1
     methodCall();
 
-    //comment
+    //comment 2
     methodCall();
-    //comment
     methodCall2();
 
-    //comment
+    //comment 3
     methodCall1();
 }
 ?>

rules/DeadCode/Rector/If_/RemoveAlwaysTrueIfConditionRector.php

@@ -127,11 +127,13 @@ public function refactor(Node $node): int|null|array|If_
             return NodeVisitor::REMOVE_NODE;
         }
 
-        $node->stmts[0]->setAttribute(AttributeKey::COMMENTS, array_merge(
-            $node->getComments(),
-            $node->stmts[0]->getComments(),
-        ));
-        $node->stmts[0]->setAttribute(AttributeKey::HAS_MERGED_COMMENTS, true);
+        // keep original comments
+        if ($node->getComments() !== []) {
+            $node->stmts[0]->setAttribute(AttributeKey::COMMENTS, array_merge(
+                $node->getComments(),
+                $node->stmts[0]->getComments(),
+            ));
+        }
 
         return $node->stmts;
     }

rules/DeadCode/Rector/If_/UnwrapFutureCompatibleIfPhpVersionRector.php

@@ -12,6 +12,7 @@
 use Rector\DeadCode\ConditionEvaluator;
 use Rector\DeadCode\ConditionResolver;
 use Rector\DeadCode\Contract\ConditionInterface;
+use Rector\NodeTypeResolver\Node\AttributeKey;
 use Rector\Rector\AbstractRector;
 use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
 use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
@@ -100,7 +101,7 @@ private function refactorIsMatch(If_ $if): ?array
             return null;
         }
 
-        return $if->stmts;
+        return $this->keepIfLevelComments($if, $if->stmts);
     }
 
     /**
@@ -113,7 +114,22 @@ private function refactorIsNotMatch(If_ $if): array|int
             return NodeVisitor::REMOVE_NODE;
         }
 
-        // else is always used
-        return $if->else->stmts;
+        return $this->keepIfLevelComments($if, $if->else->stmts);
+    }
+
+    /**
+     * @param Stmt[] $stmts
+     * @return Stmt[]
+     */
+    private function keepIfLevelComments(If_ $if, array $stmts): array
+    {
+        if ($stmts !== []) {
+            $stmts[0]->setAttribute(
+                AttributeKey::COMMENTS,
+                array_merge($if->getComments(), $stmts[0]->getComments())
+            );
+        }
+
+        return $stmts;
     }
 }

src/NodeTypeResolver/Node/AttributeKey.php

@@ -257,11 +257,6 @@ final class AttributeKey
      */
     public const IS_FIRST_LEVEL_STATEMENT = 'first_level_stmt';
 
-    /**
-     * @var string
-     */
-    public const HAS_MERGED_COMMENTS = 'has_merged_comments';
-
     public const IS_DEFAULT_PROPERTY_VALUE = 'is_default_property_value';
 
     public const IS_CLASS_CONST_VALUE = 'is_default_class_const_value';

src/Rector/AbstractRector.php

@@ -291,12 +291,6 @@ private function postRefactorProcess(
         $currentScope = $node->getAttribute(AttributeKey::SCOPE);
 
         if (is_array($refactoredNode)) {
-            $firstNode = current($refactoredNode);
-
-            if ($firstNode->getAttribute(AttributeKey::HAS_MERGED_COMMENTS, false) === false) {
-                $this->mirrorComments($firstNode, $originalNode);
-            }
-
             $this->refreshScopeNodes($refactoredNode, $filePath, $currentScope);
 
             // search "infinite recursion" in https://github.com/nikic/PHP-Parser/blob/master/doc/component/Walking_the_AST.markdown