Add UseAnalyzer test + use returned variables (#1148)

rectorphp · Nov 5, 2021 · 502cc04 · 502cc04
1 parent f9f4b93
commit 502cc04
Show file tree

Hide file tree

Showing 13 changed files with 198 additions and 186 deletions.
diff --git a/ecs.php b/ecs.php
@@ -71,6 +71,7 @@
             __DIR__ . '/packages-tests/BetterPhpDocParser/PhpDocInfo/PhpDocInfo/PhpDocInfoTest.php',
             __DIR__ . '/tests/PhpParser/Node/NodeFactoryTest.php',
             __DIR__ . '/packages-tests/BetterPhpDocParser/PhpDocParser/StaticDoctrineAnnotationParser/StaticDoctrineAnnotationParserTest.php',
+            __DIR__ . '/packages-tests/NameImporting/NodeAnalyzer/UseAnalyzer/UseAnalyzerTest.php',
             '*TypeResolverTest.php',
             __DIR__ . '/rules-tests/CodingStyle/Node/UseManipulator/UseManipulatorTest.php',
         ],

diff --git a/packages-tests/NameImporting/NodeAnalyzer/UseAnalyzer/Fixture/some_uses.php.inc b/packages-tests/NameImporting/NodeAnalyzer/UseAnalyzer/Fixture/some_uses.php.inc
@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Tests\NameImporting\NodeAnalyzer\UseAnalyzer\Fixture;
+
+use Rector\Tests\NameImporting\NodeAnalyzer\UseAnalyzer\Source\FirstUsage;
+
+final class SomeUses
+{
+    public function run()
+    {
+        return new FirstUsage();
+    }
+}
diff --git a/packages-tests/NameImporting/NodeAnalyzer/UseAnalyzer/Source/FirstUsage.php b/packages-tests/NameImporting/NodeAnalyzer/UseAnalyzer/Source/FirstUsage.php
@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Tests\NameImporting\NodeAnalyzer\UseAnalyzer\Source;
+
+final class FirstUsage
+{
+
+}
diff --git a/...ode/UseManipulator/UseManipulatorTest.php → ...eAnalyzer/UseAnalyzer/UseAnalyzerTest.php b/...ode/UseManipulator/UseManipulatorTest.php → ...eAnalyzer/UseAnalyzer/UseAnalyzerTest.php
@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Rector\Tests\CodingStyle\Node\UseManipulator;
+namespace Rector\Tests\NameImporting\NodeAnalyzer\UseAnalyzer;
 
 use Iterator;
 use PhpParser\Node;
@@ -11,23 +11,23 @@
 use PhpParser\Node\Name;
 use PhpParser\Node\Name\FullyQualified;
 use PhpParser\Node\Stmt\Class_;
-use Rector\CodingStyle\Node\UseManipulator;
-use Rector\CodingStyle\ValueObject\NameAndParent;
+use Rector\NameImporting\NodeAnalyzer\UseAnalyzer;
+use Rector\NameImporting\ValueObject\NameAndParent;
 use Rector\Testing\PHPUnit\AbstractTestCase;
 use Rector\Testing\TestingParser\TestingParser;
-use Rector\Tests\CodingStyle\Node\UseManipulator\Source\FirstUsage;
+use Rector\Tests\NameImporting\NodeAnalyzer\UseAnalyzer\Source\FirstUsage;
 
-final class UseManipulatorTest extends AbstractTestCase
+final class UseAnalyzerTest extends AbstractTestCase
 {
-    private UseManipulator $useManipulator;
+    private UseAnalyzer $useAnalyzer;
 
     private TestingParser $testingParser;
 
     protected function setUp(): void
     {
         $this->boot();
 
-        $this->useManipulator = $this->getService(UseManipulator::class);
+        $this->useAnalyzer = $this->getService(UseAnalyzer::class);
         $this->testingParser = $this->getService(TestingParser::class);
     }
 
@@ -45,10 +45,9 @@ public function test(
         string $parentNodeType
     ): void {
         $file = $this->testingParser->parseFilePathToFile($filePath);
-
         $firstStmt = $file->getOldStmts()[1];
 
-        $namesAndParentsByShortName = $this->useManipulator->resolveUsedNameNodes($firstStmt);
+        $namesAndParentsByShortName = $this->useAnalyzer->resolveUsedNameNodes($firstStmt);
         $this->assertArrayHasKey($expectedShortName, $namesAndParentsByShortName);
 
         $namesAndParents = $namesAndParentsByShortName[$expectedShortName];

diff --git a/packages/NameImporting/NodeAnalyzer/UseAnalyzer.php b/packages/NameImporting/NodeAnalyzer/UseAnalyzer.php
@@ -0,0 +1,119 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\NameImporting\NodeAnalyzer;
+
+use PhpParser\Node;
+use PhpParser\Node\Identifier;
+use PhpParser\Node\Name;
+use PhpParser\Node\Stmt\ClassLike;
+use PhpParser\Node\Stmt\UseUse;
+use Rector\Core\Exception\ShouldNotHappenException;
+use Rector\Core\PhpParser\Node\BetterNodeFinder;
+use Rector\NameImporting\ValueObject\NameAndParent;
+use Rector\NodeNameResolver\NodeNameResolver;
+use Rector\NodeTypeResolver\Node\AttributeKey;
+
+/**
+ * @see \Rector\Tests\NameImporting\NodeAnalyzer\UseAnalyzer\UseAnalyzerTest
+ */
+final class UseAnalyzer
+{
+    public function __construct(
+        private BetterNodeFinder $betterNodeFinder,
+        private NodeNameResolver $nodeNameResolver
+    ) {
+    }
+
+    /**
+     * @return array<string, NameAndParent[]>
+     */
+    public function resolveUsedNameNodes(Node $node): array
+    {
+        $usedNamesByShortName = $this->resolveUsedNames($node);
+        $usedClassNamesByShortName = $this->resolveUsedClassNames($node);
+        $usedTraitNamesByShortName = $this->resolveTraitUseNames($node);
+
+        return array_merge($usedNamesByShortName, $usedClassNamesByShortName, $usedTraitNamesByShortName);
+    }
+
+    /**
+     * @return array<string, NameAndParent[]>
+     */
+    private function resolveUsedNames(Node $node): array
+    {
+        $namesAndParentsByShortName = [];
+
+        /** @var Name[] $names */
+        $names = $this->betterNodeFinder->findInstanceOf($node, Name::class);
+
+        foreach ($names as $name) {
+            /** node name before becoming FQN - attribute from @see NameResolver */
+            $originalName = $name->getAttribute(AttributeKey::ORIGINAL_NAME);
+            if (! $originalName instanceof Name) {
+                continue;
+            }
+
+            $parentNode = $name->getAttribute(AttributeKey::PARENT_NODE);
+            if (! $parentNode instanceof Node) {
+                throw new ShouldNotHappenException();
+            }
+
+            $shortName = $originalName->toString();
+            $namesAndParentsByShortName[$shortName][] = new NameAndParent($name, $parentNode);
+        }
+
+        return $namesAndParentsByShortName;
+    }
+
+    /**
+     * @return array<string, NameAndParent[]>
+     */
+    private function resolveUsedClassNames(Node $node): array
+    {
+        $namesAndParentsByShortName = [];
+
+        /** @var ClassLike[] $classLikes */
+        $classLikes = $this->betterNodeFinder->findClassLikes($node);
+
+        foreach ($classLikes as $classLike) {
+            $classLikeName = $classLike->name;
+            if (! $classLikeName instanceof Identifier) {
+                continue;
+            }
+
+            $name = $this->nodeNameResolver->getName($classLikeName);
+            if ($name === null) {
+                continue;
+            }
+
+            $namesAndParentsByShortName[$name][] = new NameAndParent($classLikeName, $classLike);
+        }
+
+        return $namesAndParentsByShortName;
+    }
+
+    /**
+     * @return array<string, NameAndParent[]>
+     */
+    private function resolveTraitUseNames(Node $node): array
+    {
+        $namesAndParentsByShortName = [];
+
+        /** @var Identifier[] $identifiers */
+        $identifiers = $this->betterNodeFinder->findInstanceOf($node, Identifier::class);
+
+        foreach ($identifiers as $identifier) {
+            $parentNode = $identifier->getAttribute(AttributeKey::PARENT_NODE);
+            if (! $parentNode instanceof UseUse) {
+                continue;
+            }
+
+            $shortName = $identifier->name;
+            $namesAndParentsByShortName[$shortName][] = new NameAndParent($identifier, $parentNode);
+        }
+
+        return $namesAndParentsByShortName;
+    }
+}
diff --git a/...CodingStyle/ValueObject/NameAndParent.php → ...meImporting/ValueObject/NameAndParent.php b/...CodingStyle/ValueObject/NameAndParent.php → ...meImporting/ValueObject/NameAndParent.php
@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Rector\CodingStyle\ValueObject;
+namespace Rector\NameImporting\ValueObject;
 
 use PhpParser\Node;
 use PhpParser\Node\Identifier;

diff --git a/packages/Testing/TestingParser/TestingParser.php b/packages/Testing/TestingParser/TestingParser.php
@@ -24,6 +24,17 @@ public function __construct(
     ) {
     }
 
+    public function parseFilePathToFile(string $filePath): File
+    {
+        $smartFileInfo = new SmartFileInfo($filePath);
+        $file = new File($smartFileInfo, $smartFileInfo->getContents());
+
+        $stmts = $this->rectorParser->parseFile($smartFileInfo);
+        $file->hydrateStmtsAndTokens($stmts, $stmts, []);
+
+        return $file;
+    }
+
     /**
      * @return Node[]
      */
@@ -40,15 +51,4 @@ public function parseFileToDecoratedNodes(string $file): array
         $file = new File($smartFileInfo, $smartFileInfo->getContents());
         return $this->nodeScopeAndMetadataDecorator->decorateNodesFromFile($file, $nodes);
     }
-
-    public function parseFilePathToFile(string $filePath): File
-    {
-        $smartFileInfo = new SmartFileInfo($filePath);
-        $file = new File($smartFileInfo, $smartFileInfo->getContents());
-
-        $stmts = $this->rectorParser->parseFile($smartFileInfo);
-        $file->hydrateStmtsAndTokens($stmts, $stmts, []);
-
-        return $file;
-    }
 }
diff --git a/rules-tests/CodingStyle/ClassNameImport/ShortNameResolver/ShortNameResolverTest.php b/rules-tests/CodingStyle/ClassNameImport/ShortNameResolver/ShortNameResolverTest.php
@@ -6,22 +6,20 @@
 
 use Iterator;
 use Rector\CodingStyle\ClassNameImport\ShortNameResolver;
-use Rector\Core\PhpParser\Parser\RectorParser;
-use Rector\Core\ValueObject\Application\File;
 use Rector\Testing\PHPUnit\AbstractTestCase;
-use Symplify\SmartFileSystem\SmartFileInfo;
+use Rector\Testing\TestingParser\TestingParser;
 
 final class ShortNameResolverTest extends AbstractTestCase
 {
     private ShortNameResolver $shortNameResolver;
 
-    private RectorParser $rectorParser;
+    private TestingParser $testingParser;
 
     protected function setUp(): void
     {
         $this->boot();
         $this->shortNameResolver = $this->getService(ShortNameResolver::class);
-        $this->rectorParser = $this->getService(RectorParser::class);
+        $this->testingParser = $this->getService(TestingParser::class);
     }
 
     /**
@@ -30,7 +28,7 @@ protected function setUp(): void
      */
     public function test(string $filePath, array $expectedShortNames): void
     {
-        $file = $this->createFileFromFilePath($filePath);
+        $file = $this->testingParser->parseFilePathToFile($filePath);
         $shortNames = $this->shortNameResolver->resolveFromFile($file);
 
         $this->assertSame($expectedShortNames, $shortNames);
@@ -62,15 +60,4 @@ public function provideData(): Iterator
             'SecondLog' => 'Rector\Tests\CodingStyle\ClassNameImport\ShortNameResolver\Source\SecondLog',
         ]];
     }
-
-    private function createFileFromFilePath(string $filePath): File
-    {
-        $smartFileInfo = new SmartFileInfo($filePath);
-        $file = new File($smartFileInfo, $smartFileInfo->getContents());
-
-        $stmts = $this->rectorParser->parseFile($smartFileInfo);
-        $file->hydrateStmtsAndTokens($stmts, $stmts, []);
-
-        return $file;
-    }
 }
diff --git a/rules-tests/CodingStyle/Node/UseManipulator/Fixture/some_uses.php.inc b/rules-tests/CodingStyle/Node/UseManipulator/Fixture/some_uses.php.inc
diff --git a/rules-tests/CodingStyle/Node/UseManipulator/Source/FirstUsage.php b/rules-tests/CodingStyle/Node/UseManipulator/Source/FirstUsage.php
diff --git a/rules/CodingStyle/Naming/NameRenamer.php b/rules/CodingStyle/Naming/NameRenamer.php
@@ -17,7 +17,7 @@
 use PhpParser\Node\Stmt\Interface_;
 use PhpParser\Node\Stmt\TraitUse;
 use PhpParser\Node\UnionType;
-use Rector\CodingStyle\ValueObject\NameAndParent;
+use Rector\NameImporting\ValueObject\NameAndParent;
 use Rector\NodeNameResolver\NodeNameResolver;
 
 final class NameRenamer