リファクタリングのサンプル実装

src/Parse/VariableParser.php

@@ -5,125 +5,52 @@
 namespace Smeghead\PhpVariableHardUsage\Parse;
 
 use PhpParser\Node\Expr\Variable;
-use PhpParser\Node\Stmt;
-use PhpParser\Node\Stmt\ClassMethod;
-use PhpParser\Node\Stmt\Class_;
-use PhpParser\Node\Stmt\Function_;
-use PhpParser\NodeDumper;
-use PhpParser\NodeVisitor\FindingVisitor;
+use PhpParser\Node\FunctionLike;
+use PhpParser\NodeFinder;
 use PhpParser\Parser;
 use Smeghead\PhpVariableHardUsage\Parse\Exception\ParseFailedException;
-
 final class VariableParser
 {
     private Parser $parser;
 
+    private NodeFinder $nodeFinder;
+
     public function __construct()
     {
         $this->parser = (new \PhpParser\ParserFactory())->createForNewestSupportedVersion();
+        $this->nodeFinder = new NodeFinder();
     }
 
-    /**
-     * @param list<Stmt> $stmt
-     * @return list<Function_>
-     */
-    private function getFunctions(array $stmt): array
+    public function parse(string $content): ParseResult
     {
-        $functionVisitor = new FindingVisitor(function ($node) {
-            return $node instanceof Function_;
-        });
-        $traverser = new \PhpParser\NodeTraverser();
-        $traverser->addVisitor($functionVisitor);
-        $traverser->traverse($stmt);
+        $stmts = $this->parser->parse($content);
+        if ($stmts === null) {
+            throw new ParseFailedException();
+        }
 
-        return $functionVisitor->getFoundNodes(); // @phpstan-ignore-line
-    }
+        $functionLikes = $this->nodeFinder->findInstanceOf($stmts, FunctionLike::class);
 
-    /**
-     * @param Function_|ClassMethod $function
-     * @return list<Variable>
-     */
-    private function getVariables(Function_|ClassMethod $function): array
-    {
-        $variableVisitor = new FindingVisitor(function ($node) {
-            return $node instanceof Variable;
-        });
-        $traverser = new \PhpParser\NodeTraverser();
-        $traverser->addVisitor($variableVisitor);
-        $traverser->traverse([$function]);
+        $functions = $this->collectParseResultPerFunctionLike($functionLikes);
 
-        return $variableVisitor->getFoundNodes(); // @phpstan-ignore-line
+        return new ParseResult($functions);
     }
 
     /**
-     * @param list<Stmt> $stmts
+     * @param list<FunctionLike> $functionLikes
      * @return list<Func>
      */
-    private function parseFunctions(array $stmts): array
+    private function collectParseResultPerFunctionLike(array $functionLikes): array
     {
-        $foundFunctions = $this->getFunctions($stmts);
+        return array_map(function (FunctionLike $function) {
+            $functionIdentifier = $function->name->name ?? $function->getType() . '@' . $function->getStartLine();
 
-        $functions = [];
-        foreach ($foundFunctions as $foundFunction) {
-            $variables = $this->getVariables($foundFunction);
-            $func = new Func($foundFunction->name->name);
+            $func = new Func($functionIdentifier);
+
+            $variables = $this->nodeFinder->findInstanceOf($function, Variable::class);
             foreach ($variables as $variable) {
                 $func->addVariable(new VarReference($variable->name, $variable->getLine())); // @phpstan-ignore-line
             }
-            $functions[] = $func;
-        }
-        return $functions;
-    }
-
-    /**
-     * @param list<Stmt> $stmt
-     * @return list<Class_>
-     */
-    private function getClasses(array $stmt): array
-    {
-        $classVisitor = new FindingVisitor(function ($node) {
-            return $node instanceof \PhpParser\Node\Stmt\Class_;
-        });
-        $traverser = new \PhpParser\NodeTraverser();
-        $traverser->addVisitor($classVisitor);
-        $traverser->traverse($stmt);
-
-        return $classVisitor->getFoundNodes(); // @phpstan-ignore-line
-    }
-
-    /**
-     * @param list<Stmt> $stmts
-     * @return list<Func>
-     */
-    private function parseClasses(array $stmts): array
-    {
-        $foundClasses = $this->getClasses($stmts);
-
-        $methods = [];
-        foreach ($foundClasses as $foundClass) {
-            foreach ($foundClass->getMethods() as $method) {
-                $variables = $this->getVariables($method);
-                $func = new Func(sprintf('%s::%s', $foundClass->name, $method->name->name));
-                foreach ($variables as $variable) {
-                    $func->addVariable(new VarReference($variable->name, $variable->getLine())); // @phpstan-ignore-line
-                }
-                $methods[] = $func;
-            }
-        }
-        return $methods;
-    }
-
-    public function parse(string $content): ParseResult
-    {
-        $stmts = $this->parser->parse($content);
-        if ($stmts === null) {
-            throw new ParseFailedException();
-        }
-        $dumper = new NodeDumper();
-        // echo $dumper->dump($stmts) . PHP_EOL;
-
-        $functions = $this->parseFunctions($stmts) + $this->parseClasses($stmts);
-
-        return new ParseResult($functions);
+            return $func;
+        }, $functionLikes);
     }
 }

test/VariableParserTest.php

@@ -38,7 +38,8 @@ public function testParseClass(): void
         $this->assertInstanceOf(ParseResult::class, $result);
         $functions = $result->functions;
         $this->assertCount(1, $functions);
-        $this->assertEquals('Clazz::bigFunction', $functions[0]->name);
+        // $this->assertEquals('Clazz::bigFunction', $functions[0]->name);
+        $this->assertEquals('bigFunction', $functions[0]->name);
         $this->assertCount(4, $functions[0]->getVariables());
 
         $vars = $functions[0]->getVariables();