Improve check for changed phpdoc and add new tests

rectorphp · Sep 12, 2024 · 13b8110 · 13b8110
1 parent a34fc3c
commit 13b8110
Show file tree

Hide file tree

Showing 4 changed files with 30 additions and 4 deletions.
diff --git a/...aration/Rector/Expression/InlineVarDocTagToAssertRector/Fixture/preserve_comments.php.inc b/...aration/Rector/Expression/InlineVarDocTagToAssertRector/Fixture/preserve_comments.php.inc
@@ -35,6 +35,14 @@ $bar = getInt();
 /** @var string $foo this is the string */
 $foo = getString();
 
+/* normal comment */
+/** @var string $foo */
+$foo = getString();
+
+/** @var string $foo */
+// normal comment
+$foo = getString();
+
 ?>
 -----
 <?php
@@ -74,4 +82,12 @@ $bar = getInt();
 /** @var string $foo this is the string */
 $foo = getString();
 
+/* normal comment */
+$foo = getString();
+assert(is_string($foo));
+
+// normal comment
+$foo = getString();
+assert(is_string($foo));
+
 ?>
diff --git a/...ctor/Expression/InlineVarDocTagToAssertRector/Fixture/skip_phpstan_and_psalm_tags.php.inc b/...ctor/Expression/InlineVarDocTagToAssertRector/Fixture/skip_phpstan_and_psalm_tags.php.inc
@@ -0,0 +1,8 @@
+<?php
+
+/** @phpstan-var string $foo */
+$foo = getString();
+
+/** @psalm-var string $foo */
+$foo = getString();
+
diff --git a/rules/TypeDeclaration/Rector/Expression/InlineVarDocTagToAssertRector.php b/rules/TypeDeclaration/Rector/Expression/InlineVarDocTagToAssertRector.php
@@ -18,7 +18,6 @@
 use Rector\BetterPhpDocParser\PhpDocInfo\PhpDocInfoFactory;
 use Rector\BetterPhpDocParser\PhpDocManipulator\PhpDocTagRemover;
 use Rector\Comments\NodeDocBlock\DocBlockUpdater;
-use Rector\NodeTypeResolver\Node\AttributeKey;
 use Rector\Rector\AbstractRector;
 use Rector\TypeDeclaration\PhpDocParser\TypeExpressionFromVarTagResolver;
 use Rector\ValueObject\PhpVersionFeature;
@@ -109,7 +108,6 @@ public function refactor(Node $node): ?array
                     if ($typeExpression !== false) {
                         $this->phpDocTagRemover->removeTagValueFromNode($phpDocInfo, $tagValueNode);
                         $this->docBlockUpdater->updateRefactoredNodeWithPhpDocInfo($node);
-                        $node->setAttribute(AttributeKey::DO_NOT_CHANGE, true);
 
                         $arg = new Arg($typeExpression);
                         $funcCall = new FuncCall(new Name('assert'), [$arg]);

diff --git a/src/Rector/AbstractRector.php b/src/Rector/AbstractRector.php
@@ -21,6 +21,7 @@
 use PHPStan\Type\Type;
 use Rector\Application\ChangedNodeScopeRefresher;
 use Rector\Application\Provider\CurrentFileProvider;
+use Rector\BetterPhpDocParser\PhpDocInfo\PhpDocInfo;
 use Rector\ChangesReporting\ValueObject\RectorWithLineChange;
 use Rector\Contract\Rector\RectorInterface;
 use Rector\Exception\ShouldNotHappenException;
@@ -263,11 +264,14 @@ protected function mirrorComments(Node $newNode, Node $oldNode): void
             return;
         }
 
-        if ($newNode->getAttribute(AttributeKey::DO_NOT_CHANGE) === true) {
+        $oldPhpDocInfo = $oldNode->getAttribute(AttributeKey::PHP_DOC_INFO);
+        $newPhpDocInfo = $newNode->getAttribute(AttributeKey::PHP_DOC_INFO);
+
+        if ($newPhpDocInfo instanceof PhpDocInfo && $oldPhpDocInfo !== $newPhpDocInfo) {
             return;
         }
 
-        $newNode->setAttribute(AttributeKey::PHP_DOC_INFO, $oldNode->getAttribute(AttributeKey::PHP_DOC_INFO));
+        $newNode->setAttribute(AttributeKey::PHP_DOC_INFO, $oldPhpDocInfo);
         if (! $newNode instanceof Nop) {
             $newNode->setAttribute(AttributeKey::COMMENTS, $oldNode->getAttribute(AttributeKey::COMMENTS));
         }