Traverse phpdoc with use of PhpDocNodeVisitor (#6045)

* make use of new simple-php-doc-parser

* add ParamPhpDocNodeVisitor

* remove uneeded contracts

* skip bool instanceof

* [ci-review] Rector Rectify

* [ci-review] Rector Rectify

Co-authored-by: kaizen-ci <info@kaizen-ci.org>

.phpstorm.meta.php

@@ -6,8 +6,35 @@
 namespace PHPSTORM_META;
 
 // $container->get(Type::class) → instance of "Type"
+use Rector\BetterPhpDocParser\ValueObject\PhpDocAttributeKey;
+
 override(\Psr\Container\ContainerInterface::get(0), type(0));
 
+expectedArguments(
+    \PHPStan\PhpDocParser\Ast\Node::getAttribute(),
+    0,
+    PhpDocAttributeKey::START_AND_END,
+    PhpDocAttributeKey::LAST_TOKEN_POSITION,
+    PhpDocAttributeKey::PARENT,
+);
+
+expectedArguments(
+    \PHPStan\PhpDocParser\Ast\Node::setAttribute(),
+    0,
+    PhpDocAttributeKey::START_AND_END,
+    PhpDocAttributeKey::LAST_TOKEN_POSITION,
+    PhpDocAttributeKey::PARENT,
+);
+
+expectedArguments(
+    \PHPStan\PhpDocParser\Ast\Node::hasAttribute(),
+    0,
+    PhpDocAttributeKey::START_AND_END,
+    PhpDocAttributeKey::LAST_TOKEN_POSITION,
+    PhpDocAttributeKey::PARENT,
+);
+
+
 // PhpStorm 2019.1 - add argument autocomplete
 // https://blog.jetbrains.com/phpstorm/2019/02/new-phpstorm-meta-php-features/
 expectedArguments(

composer.json

@@ -59,7 +59,7 @@
         "symplify/package-builder": "^9.2.12",
         "symplify/rule-doc-generator-contracts": "^9.2.12",
         "symplify/set-config-resolver": "^9.2.12",
-        "symplify/simple-php-doc-parser": "^9.2.12",
+        "symplify/simple-php-doc-parser": "^9.3",
         "symplify/skipper": "^9.2.12",
         "symplify/smart-file-system": "^9.2.12",
         "symplify/symfony-php-config": "^9.2.12",
@@ -154,5 +154,7 @@
     "config": {
         "sort-packages": true,
         "platform-check": false
-    }
+    },
+    "minimum-stability": "dev",
+    "prefer-stable": true
 }

config/services-packages.php

@@ -14,10 +14,7 @@
 
     $services->load('Rector\\', __DIR__ . '/../packages')
         ->exclude([
-            // @todo move to value object
             __DIR__ . '/../packages/*/{ValueObject,Contract,Exception}',
-            __DIR__ . '/../packages/BetterPhpDocParser/Attributes/Ast/PhpDoc',
-            __DIR__ . '/../packages/BetterPhpDocParser/Attributes/Attribute',
             __DIR__ . '/../packages/BetterPhpDocParser/PhpDocInfo/PhpDocInfo.php',
             __DIR__ . '/../packages/Testing/PHPUnit',
             __DIR__ . '/../packages/BetterPhpDocParser/PhpDoc',

packages-tests/BetterPhpDocParser/PhpDocInfo/PhpDocInfoPrinter/MultilineTest.php

@@ -55,7 +55,6 @@ public function provideData(): Iterator
     public function provideDataClass(): Iterator
     {
         yield [__DIR__ . '/Source/Class_/some_entity_class.txt', new Class_(SomeEntityClass::class)];
-
         yield [__DIR__ . '/Source/Multiline/table.txt', new Class_(TableClass::class)];
     }
 

packages-tests/BetterPhpDocParser/PhpDocNodeMapperTest.php

@@ -10,6 +10,7 @@
 use PHPStan\PhpDocParser\Ast\Type\IdentifierTypeNode;
 use PHPStan\PhpDocParser\Ast\Type\NullableTypeNode;
 use Rector\BetterPhpDocParser\PhpDocNodeMapper;
+use Rector\BetterPhpDocParser\ValueObject\Parser\BetterTokenIterator;
 use Rector\BetterPhpDocParser\ValueObject\PhpDoc\VariadicAwareParamTagValueNode;
 use Rector\Core\HttpKernel\RectorKernel;
 use Symplify\PackageBuilder\Testing\AbstractKernelTestCase;
@@ -27,13 +28,13 @@ protected function setUp(): void
         $this->phpDocNodeMapper = $this->getService(PhpDocNodeMapper::class);
     }
 
-    public function testPropertyTag(): void
+    public function testParamTag(): void
     {
         $phpDocNode = $this->createParamDocNode();
 
-        $reprintedPhpDocNode = $this->phpDocNodeMapper->transform($phpDocNode, '');
+        $this->phpDocNodeMapper->transform($phpDocNode, new BetterTokenIterator([]));
 
-        $childNode = $reprintedPhpDocNode->children[0];
+        $childNode = $phpDocNode->children[0];
         $this->assertInstanceOf(PhpDocTagNode::class, $childNode);
 
         // test param tag

packages-tests/BetterPhpDocParser/PhpDocParser/TagValueNodeReprint/TagValueNodeReprintTest.php

@@ -153,8 +153,6 @@ private function parseFileAndGetFirstNodeOfType(SmartFileInfo $smartFileInfo, st
     private function printNodePhpDocInfoToString(Node $node): string
     {
         $phpDocInfo = $this->phpDocInfoFactory->createFromNodeOrEmpty($node);
-        $phpDocInfo->markAsChanged();
-
         return $this->phpDocInfoPrinter->printFormatPreserving($phpDocInfo);
     }
 

packages/BetterPhpDocParser/Attributes/AttributeMirrorer.php

@@ -0,0 +1,32 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\BetterPhpDocParser\Attributes;
+
+use PHPStan\PhpDocParser\Ast\Node;
+use Rector\BetterPhpDocParser\ValueObject\PhpDocAttributeKey;
+
+final class AttributeMirrorer
+{
+    /**
+     * @var string[]
+     */
+    private const ATTRIBUTES_TO_MIRROR = [
+        PhpDocAttributeKey::PARENT,
+        PhpDocAttributeKey::START_AND_END,
+        PhpDocAttributeKey::ORIG_NODE,
+    ];
+
+    public function mirror(Node $oldNode, Node $newNode): void
+    {
+        foreach (self::ATTRIBUTES_TO_MIRROR as $attributeToMirror) {
+            if (! $oldNode->hasAttribute($attributeToMirror)) {
+                continue;
+            }
+
+            $attributeValue = $oldNode->getAttribute($attributeToMirror);
+            $newNode->setAttribute($attributeToMirror, $attributeValue);
+        }
+    }
+}

packages/BetterPhpDocParser/Contract/BasePhpDocNodeVisitorInterface.php

@@ -0,0 +1,11 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\BetterPhpDocParser\Contract;
+
+use Symplify\SimplePhpDocParser\Contract\PhpDocNodeVisitorInterface;
+
+interface BasePhpDocNodeVisitorInterface extends PhpDocNodeVisitorInterface
+{
+}

packages/BetterPhpDocParser/DataProvider/CurrentTokenIteratorProvider.php

@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\BetterPhpDocParser\DataProvider;
+
+use Rector\BetterPhpDocParser\ValueObject\Parser\BetterTokenIterator;
+
+final class CurrentTokenIteratorProvider
+{
+    /**
+     * @var BetterTokenIterator
+     */
+    private $betterTokenIterator;
+
+    public function setBetterTokenIterator(BetterTokenIterator $betterTokenIterator): void
+    {
+        $this->betterTokenIterator = $betterTokenIterator;
+    }
+
+    public function provide(): BetterTokenIterator
+    {
+        return $this->betterTokenIterator;
+    }
+}

packages/BetterPhpDocParser/Attributes/Ast/PhpDoc/SpacelessPhpDocTagNode.php → packages/BetterPhpDocParser/PhpDoc/SpacelessPhpDocTagNode.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Rector\BetterPhpDocParser\Attributes\Ast\PhpDoc;
+namespace Rector\BetterPhpDocParser\PhpDoc;
 
 use PHPStan\PhpDocParser\Ast\PhpDoc\PhpDocTagNode;
 

packages/BetterPhpDocParser/PhpDocInfo/PhpDocInfo.php

@@ -19,13 +19,14 @@
 use PHPStan\Type\MixedType;
 use PHPStan\Type\Type;
 use Rector\BetterPhpDocParser\Annotation\AnnotationNaming;
-use Rector\BetterPhpDocParser\Attributes\Ast\PhpDoc\SpacelessPhpDocTagNode;
-use Rector\BetterPhpDocParser\Contract\PhpDocNode\ShortNameAwareTagInterface;
 use Rector\BetterPhpDocParser\PhpDoc\DoctrineAnnotationTagValueNode;
+use Rector\BetterPhpDocParser\PhpDoc\SpacelessPhpDocTagNode;
+use Rector\BetterPhpDocParser\PhpDocNodeVisitor\ChangedPhpDocNodeVisitor;
 use Rector\ChangesReporting\Collector\RectorChangeCollector;
 use Rector\Core\Configuration\CurrentNodeProvider;
 use Rector\Core\Exception\NotImplementedYetException;
 use Rector\StaticTypeMapper\StaticTypeMapper;
+use Symplify\SimplePhpDocParser\PhpDocNodeTraverser;
 
 /**
  * @template TNode as \PHPStan\PhpDocParser\Ast\Node
@@ -138,13 +139,6 @@ public function addPhpDocTagNode(PhpDocChildNode $phpDocChildNode): void
         $this->phpDocNode->children[] = $phpDocChildNode;
         // to give node more space
         $this->makeMultiLined();
-        $this->markAsChanged();
-    }
-
-    public function addTagValueNodeWithShortName(ShortNameAwareTagInterface $shortNameAwareTag): void
-    {
-        $spacelessPhpDocTagNode = new SpacelessPhpDocTagNode($shortNameAwareTag->getShortName(), $shortNameAwareTag);
-        $this->addPhpDocTagNode($spacelessPhpDocTagNode);
     }
 
     public function getPhpDocNode(): PhpDocNode
@@ -470,6 +464,11 @@ public function hasInheritDoc(): bool
         return $this->hasByNames(['inheritdoc', 'inheritDoc']);
     }
 
+    /**
+     * @deprecated
+     * Should be handled by attributes of phpdoc node - if stard_and_end is missing in one of nodes, it has been changed
+     * Similar to missing original node in php-aprser
+     */
     public function markAsChanged(): void
     {
         $this->hasChanged = true;
@@ -486,7 +485,17 @@ public function hasChanged(): bool
             return true;
         }
 
-        return $this->hasChanged;
+        if ($this->hasChanged) {
+            return true;
+        }
+
+        // has a single node with missing start_end
+        $phpDocNodeTraverser = new PhpDocNodeTraverser();
+        $changedPhpDocNodeVisitor = new ChangedPhpDocNodeVisitor();
+        $phpDocNodeTraverser->addPhpDocNodeVisitor($changedPhpDocNodeVisitor);
+        $phpDocNodeTraverser->traverse($this->phpDocNode);
+
+        return $changedPhpDocNodeVisitor->hasChanged();
     }
 
     /**

packages/BetterPhpDocParser/PhpDocInfo/PhpDocInfoFactory.php

@@ -10,11 +10,11 @@
 use PHPStan\PhpDocParser\Lexer\Lexer;
 use PHPStan\PhpDocParser\Parser\PhpDocParser;
 use Rector\BetterPhpDocParser\Annotation\AnnotationNaming;
-use Rector\BetterPhpDocParser\Attributes\Attribute\Attribute;
 use Rector\BetterPhpDocParser\Contract\PhpDocNodeFactoryInterface;
 use Rector\BetterPhpDocParser\PhpDocNodeMapper;
 use Rector\BetterPhpDocParser\PhpDocParser\BetterPhpDocParser;
 use Rector\BetterPhpDocParser\ValueObject\Parser\BetterTokenIterator;
+use Rector\BetterPhpDocParser\ValueObject\PhpDocAttributeKey;
 use Rector\BetterPhpDocParser\ValueObject\StartAndEnd;
 use Rector\ChangesReporting\Collector\RectorChangeCollector;
 use Rector\Core\Configuration\CurrentNodeProvider;
@@ -141,6 +141,7 @@ public function createEmpty(Node $node): PhpDocInfo
 
         // multiline by default
         $phpDocInfo->makeMultiLined();
+
         return $phpDocInfo;
     }
 
@@ -166,10 +167,10 @@ private function setPositionOfLastToken(PhpDocNode $phpDocNode): void
         $lastChildNode = array_pop($phpDocChildNodes);
 
         /** @var StartAndEnd $startAndEnd */
-        $startAndEnd = $lastChildNode->getAttribute(Attribute::START_END);
+        $startAndEnd = $lastChildNode->getAttribute(PhpDocAttributeKey::START_AND_END);
 
         if ($startAndEnd !== null) {
-            $phpDocNode->setAttribute(Attribute::LAST_TOKEN_POSITION, $startAndEnd->getEnd());
+            $phpDocNode->setAttribute(PhpDocAttributeKey::LAST_TOKEN_POSITION, $startAndEnd->getEnd());
         }
     }
 
@@ -182,8 +183,7 @@ private function createFromPhpDocNode(
         array $tokens,
         Node $node
     ): PhpDocInfo {
-        /** @var PhpDocNode $phpDocNode */
-        $phpDocNode = $this->phpDocNodeMapper->transform($phpDocNode, $content);
+        $this->phpDocNodeMapper->transform($phpDocNode, new BetterTokenIterator($tokens));
 
         $phpDocInfo = new PhpDocInfo(
             $phpDocNode,

packages/BetterPhpDocParser/PhpDocInfo/TokenIteratorFactory.php

@@ -11,6 +11,11 @@
 
 final class TokenIteratorFactory
 {
+    /**
+     * @var string
+     */
+    private const INDEX = 'index';
+
     /**
      * @var Lexer
      */
@@ -44,7 +49,7 @@ public function createFromTokenIterator(TokenIterator $tokenIterator): BetterTok
 
         // keep original position
         $currentIndex = $this->privatesAccessor->getPrivateProperty($tokenIterator, 'index');
-        $this->privatesAccessor->setPrivateProperty($betterTokenIterator, 'index', $currentIndex);
+        $this->privatesAccessor->setPrivateProperty($betterTokenIterator, self::INDEX, $currentIndex);
 
         return $betterTokenIterator;
     }