Re-organise the node visitors (#761)

Author: theofidry

phpstan.neon.dist

@@ -16,11 +16,11 @@ parameters:
         - message: '#IdentifierResolver::resolveIdentifier\(\) should return#'
           path: 'src/PhpParser/NodeVisitor/Resolver/IdentifierResolver.php'
         - message: '#ParentNodeAppender::getParent\(\) should return#'
-          path: 'src/PhpParser/NodeVisitor/ParentNodeAppender.php'
+          path: 'src/PhpParser/NodeVisitor/AttributeAppender/ParentNodeAppender.php'
         - message: '#ParentNodeAppender::findParent\(\) should return#'
-          path: 'src/PhpParser/NodeVisitor/ParentNodeAppender.php'
+          path: 'src/PhpParser/NodeVisitor/AttributeAppender/ParentNodeAppender.php'
         - message: '#OriginalNameResolver::getOriginalName\(\) should return#'
-          path: 'src/PhpParser/NodeVisitor/OriginalNameResolver.php'
+          path: 'src/PhpParser/NodeVisitor/Resolver/OriginalNameResolver.php'
         - message: '#NamespaceManipulator::getOriginalName\(\) should return#'
           path: 'src/PhpParser/NodeVisitor/NamespaceStmt/NamespaceManipulator.php'
         - message: '#Dead catch#'

src/PhpParser/NodeVisitor/IdentifierNameAppender.php renamed to src/PhpParser/NodeVisitor/AttributeAppender/IdentifierNameAppender.php

@@ -12,7 +12,7 @@
  * file that was distributed with this source code.
  */
 
-namespace Humbug\PhpScoper\PhpParser\NodeVisitor;
+namespace Humbug\PhpScoper\PhpParser\NodeVisitor\AttributeAppender;
 
 use Humbug\PhpScoper\PhpParser\NodeVisitor\Resolver\IdentifierResolver;
 use PhpParser\Node;

src/PhpParser/NodeVisitor/ParentNodeAppender.php renamed to src/PhpParser/NodeVisitor/AttributeAppender/ParentNodeAppender.php

@@ -12,7 +12,7 @@
  * file that was distributed with this source code.
  */
 
-namespace Humbug\PhpScoper\PhpParser\NodeVisitor;
+namespace Humbug\PhpScoper\PhpParser\NodeVisitor\AttributeAppender;
 
 use PhpParser\Node;
 use PhpParser\NodeVisitorAbstract;

src/PhpParser/NodeVisitor/ClassAliasStmtAppender.php

@@ -15,6 +15,7 @@
 namespace Humbug\PhpScoper\PhpParser\NodeVisitor;
 
 use Humbug\PhpScoper\PhpParser\Node\ClassAliasFuncCall;
+use Humbug\PhpScoper\PhpParser\NodeVisitor\AttributeAppender\ParentNodeAppender;
 use Humbug\PhpScoper\PhpParser\NodeVisitor\Resolver\IdentifierResolver;
 use Humbug\PhpScoper\PhpParser\UnexpectedParsingScenario;
 use Humbug\PhpScoper\Symbol\SymbolsRegistry;

src/PhpParser/NodeVisitor/ClassIdentifierRecorder.php

@@ -15,6 +15,7 @@
 namespace Humbug\PhpScoper\PhpParser\NodeVisitor;
 
 use Humbug\PhpScoper\PhpParser\Node\FullyQualifiedFactory;
+use Humbug\PhpScoper\PhpParser\NodeVisitor\AttributeAppender\ParentNodeAppender;
 use Humbug\PhpScoper\PhpParser\NodeVisitor\Resolver\IdentifierResolver;
 use Humbug\PhpScoper\PhpParser\UnexpectedParsingScenario;
 use Humbug\PhpScoper\Symbol\EnrichedReflector;

src/PhpParser/NodeVisitor/ConstStmtReplacer.php

@@ -83,7 +83,7 @@ private function replaceConst(Const_ $const, Node\Const_ $constant): ?Node
         }
 
         if (count($const->consts) > 1) {
-            // TODO
+            // TODO: add support for this case instead of bailing out.
             throw new UnexpectedValueException(
                 'Exposing a constant declared in a grouped constant statement (e.g. `const FOO = \'foo\', BAR = \'bar\'; is not supported. Consider breaking it down in multiple constant declaration statements',
             );

src/PhpParser/NodeVisitor/EvalPrefixer.php

@@ -14,6 +14,7 @@
 
 namespace Humbug\PhpScoper\PhpParser\NodeVisitor;
 
+use Humbug\PhpScoper\PhpParser\NodeVisitor\AttributeAppender\ParentNodeAppender;
 use Humbug\PhpScoper\PhpParser\StringNodePrefixer;
 use PhpParser\Node;
 use PhpParser\Node\Expr\Eval_;

src/PhpParser/NodeVisitor/FunctionIdentifierRecorder.php

@@ -15,6 +15,7 @@
 namespace Humbug\PhpScoper\PhpParser\NodeVisitor;
 
 use Humbug\PhpScoper\PhpParser\Node\FullyQualifiedFactory;
+use Humbug\PhpScoper\PhpParser\NodeVisitor\AttributeAppender\ParentNodeAppender;
 use Humbug\PhpScoper\PhpParser\NodeVisitor\Resolver\IdentifierResolver;
 use Humbug\PhpScoper\PhpParser\UnexpectedParsingScenario;
 use Humbug\PhpScoper\Symbol\EnrichedReflector;

src/PhpParser/NodeVisitor/NameStmtPrefixer.php

@@ -15,7 +15,9 @@
 namespace Humbug\PhpScoper\PhpParser\NodeVisitor;
 
 use Humbug\PhpScoper\PhpParser\Node\FullyQualifiedFactory;
+use Humbug\PhpScoper\PhpParser\NodeVisitor\AttributeAppender\ParentNodeAppender;
 use Humbug\PhpScoper\PhpParser\NodeVisitor\NamespaceStmt\NamespaceStmtCollection;
+use Humbug\PhpScoper\PhpParser\NodeVisitor\Resolver\OriginalNameResolver;
 use Humbug\PhpScoper\PhpParser\NodeVisitor\UseStmt\UseStmtCollection;
 use Humbug\PhpScoper\PhpParser\UseStmtName;
 use Humbug\PhpScoper\Symbol\EnrichedReflector;
@@ -438,7 +440,6 @@ private function prefixFuncCallNode(Name $originalName, Name $resolvedName): ?Na
         }
 
         if ($this->enrichedReflector->isExposedFunction($resolvedNameString)) {
-            // TODO: should be able to find a case for it
             return $this->enrichedReflector->isExposedFunctionFromGlobalNamespace($resolvedNameString)
                 ? $resolvedName
                 : null;

src/PhpParser/NodeVisitor/NamespaceStmt/NamespaceStmtCollection.php

@@ -16,7 +16,7 @@
 
 use ArrayIterator;
 use Countable;
-use Humbug\PhpScoper\PhpParser\NodeVisitor\ParentNodeAppender;
+use Humbug\PhpScoper\PhpParser\NodeVisitor\AttributeAppender\ParentNodeAppender;
 use Humbug\PhpScoper\PhpParser\UnexpectedParsingScenario;
 use IteratorAggregate;
 use PhpParser\Node;

src/PhpParser/NodeVisitor/Resolver/IdentifierResolver.php

@@ -15,7 +15,7 @@
 namespace Humbug\PhpScoper\PhpParser\NodeVisitor\Resolver;
 
 use Humbug\PhpScoper\PhpParser\Node\NamedIdentifier;
-use Humbug\PhpScoper\PhpParser\NodeVisitor\ParentNodeAppender;
+use Humbug\PhpScoper\PhpParser\NodeVisitor\AttributeAppender\ParentNodeAppender;
 use PhpParser\Node\Identifier;
 use PhpParser\Node\Name;
 use PhpParser\Node\Name\FullyQualified;

src/PhpParser/NodeVisitor/OriginalNameResolver.php renamed to src/PhpParser/NodeVisitor/Resolver/OriginalNameResolver.php

@@ -12,11 +12,10 @@
  * file that was distributed with this source code.
  */
 
-namespace Humbug\PhpScoper\PhpParser\NodeVisitor;
+namespace Humbug\PhpScoper\PhpParser\NodeVisitor\Resolver;
 
 use PhpParser\Node\Name;
 
-// TODO: review those classes
 final class OriginalNameResolver
 {
     private const ORIGINAL_NAME_ATTRIBUTE = 'originalName';

src/PhpParser/NodeVisitor/StringScalarPrefixer.php

@@ -14,6 +14,7 @@
 
 namespace Humbug\PhpScoper\PhpParser\NodeVisitor;
 
+use Humbug\PhpScoper\PhpParser\NodeVisitor\AttributeAppender\ParentNodeAppender;
 use Humbug\PhpScoper\PhpParser\UnexpectedParsingScenario;
 use Humbug\PhpScoper\Symbol\EnrichedReflector;
 use PhpParser\Node;

src/PhpParser/NodeVisitor/UseStmt/UseStmtCollection.php

@@ -16,8 +16,8 @@
 
 use ArrayIterator;
 use Humbug\PhpScoper\PhpParser\Node\NamedIdentifier;
-use Humbug\PhpScoper\PhpParser\NodeVisitor\OriginalNameResolver;
-use Humbug\PhpScoper\PhpParser\NodeVisitor\ParentNodeAppender;
+use Humbug\PhpScoper\PhpParser\NodeVisitor\AttributeAppender\ParentNodeAppender;
+use Humbug\PhpScoper\PhpParser\NodeVisitor\Resolver\OriginalNameResolver;
 use Humbug\PhpScoper\PhpParser\UnexpectedParsingScenario;
 use IteratorAggregate;
 use PhpParser\Node;

src/PhpParser/NodeVisitor/UseStmt/UseStmtPrefixer.php

@@ -14,7 +14,7 @@
 
 namespace Humbug\PhpScoper\PhpParser\NodeVisitor\UseStmt;
 
-use Humbug\PhpScoper\PhpParser\NodeVisitor\ParentNodeAppender;
+use Humbug\PhpScoper\PhpParser\NodeVisitor\AttributeAppender\ParentNodeAppender;
 use Humbug\PhpScoper\PhpParser\UnexpectedParsingScenario;
 use Humbug\PhpScoper\Symbol\EnrichedReflector;
 use PhpParser\Node;

src/PhpParser/TraverserFactory.php

@@ -86,8 +86,8 @@ private static function createNodeVisitors(
 
         return [
             $nameResolver,
-            new NodeVisitor\ParentNodeAppender(),
-            new NodeVisitor\IdentifierNameAppender($identifierResolver),
+            new NodeVisitor\AttributeAppender\ParentNodeAppender(),
+            new NodeVisitor\AttributeAppender\IdentifierNameAppender($identifierResolver),
 
             new NodeVisitor\NamespaceStmt\NamespaceStmtPrefixer(
                 $prefix,

src/PhpParser/UseStmtName.php

@@ -14,7 +14,7 @@
 
 namespace Humbug\PhpScoper\PhpParser;
 
-use Humbug\PhpScoper\PhpParser\NodeVisitor\ParentNodeAppender;
+use Humbug\PhpScoper\PhpParser\NodeVisitor\AttributeAppender\ParentNodeAppender;
 use PhpParser\Node\Name;
 use PhpParser\Node\Stmt\Use_;
 use PhpParser\Node\Stmt\UseUse;

tests/PhpParser/UseStmtNameTest.php

@@ -186,7 +186,7 @@ private static function parseUseStmtName(string $php): Name
             new PhpParserNodeTraverser(),
         );
 
-        $traverser->addVisitor(new NodeVisitor\ParentNodeAppender());
+        $traverser->addVisitor(new NodeVisitor\AttributeAppender\ParentNodeAppender());
         $traverser->addVisitor(
             new NodeVisitor\NamespaceStmt\NamespaceStmtPrefixer(
                 'Humbug',