Added FunctionLikeFindingVisitor to get the class name of a ClassMethod.

Author: smeghead

src/Parse/VariableParser.php

@@ -7,8 +7,11 @@
 use PhpParser\Node\Expr\Variable;
 use PhpParser\Node\FunctionLike;
 use PhpParser\NodeFinder;
+use PhpParser\NodeTraverser;
 use PhpParser\Parser;
 use Smeghead\PhpVariableHardUsage\Parse\Exception\ParseFailedException;
+use Smeghead\PhpVariableHardUsage\Parse\Visitor\FunctionLikeFindingVisitor;
+
 final class VariableParser
 {
     private Parser $parser;
@@ -28,7 +31,11 @@ public function parse(string $content): ParseResult
             throw new ParseFailedException();
         }
 
-        $functionLikes = $this->nodeFinder->findInstanceOf($stmts, FunctionLike::class);
+        $traverser = new NodeTraverser();
+        $visitor = new FunctionLikeFindingVisitor(fn($node) => $node instanceof FunctionLike);
+        $traverser->addVisitor($visitor);
+        $traverser->traverse($stmts);
+        $functionLikes = $visitor->getFoundNodes();
 
         $functions = $this->collectParseResultPerFunctionLike($functionLikes);
 
@@ -42,7 +49,13 @@ public function parse(string $content): ParseResult
     private function collectParseResultPerFunctionLike(array $functionLikes): array
     {
         return array_map(function (FunctionLike $function) {
-            $functionIdentifier = $function->name->name ?? $function->getType() . '@' . $function->getStartLine();
+            $className = $function->getAttribute('className'); // Get the class name set in FunctionLikeFindingVisitor
+            $functionName = $function->name->name ?? $function->getType() . '@' . $function->getStartLine();
+            $functionIdentifier = sprintf(
+                '%s%s',
+                isset($className) ? $className . '::' : '',
+                $functionName
+            );
 
             $func = new Func($functionIdentifier);
 

src/Parse/Visitor/FunctionLikeFindingVisitor.php

@@ -0,0 +1,39 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Smeghead\PhpVariableHardUsage\Parse\Visitor;
+
+use PhpParser\Node;
+use PhpParser\NodeVisitor\FindingVisitor;
+use PhpParser\Node\Stmt\Class_;
+use PhpParser\Node\Stmt\ClassMethod;
+
+/**
+ * FindingVisitor that searches for elements of FunctionLike
+ * 
+ * For ClassMethod, set the class name to ClassName as Attribute.
+ */
+class FunctionLikeFindingVisitor extends FindingVisitor {
+    protected array $foundNodes = [];
+    private ?string $currentClass = null;
+
+    public function enterNode(Node $node) {
+        if ($node instanceof Class_) {
+            // Record class name
+            $this->currentClass = $node->name ? $node->name->name : null;
+        }
+
+        if ($node instanceof ClassMethod) {
+            $node->setAttribute('className', $this->currentClass);
+        }
+        return parent::enterNode($node);
+    }
+
+    public function leaveNode(Node $node) {
+        if ($node instanceof Class_) {
+            // Reset because it leaves the class scope
+            $this->currentClass = null;
+        }
+    }
+}

test/VariableParserTest.php

@@ -38,8 +38,7 @@ 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('bigFunction', $functions[0]->name);
+        $this->assertEquals('Clazz::bigFunction', $functions[0]->name);
         $this->assertCount(4, $functions[0]->getVariables());
 
         $vars = $functions[0]->getVariables();
@@ -52,4 +51,27 @@ public function testParseClass(): void
         $this->assertSame('num', $vars[3]->name);
         $this->assertSame(15, $vars[3]->lineNumber, 'second $num (15)');
     }
+
+    public function testParseAnonymousFunction(): void
+    {
+        $parser = new VariableParser();
+        $content = file_get_contents($this->fixtureDir . '/AnonymousFunction.php');
+        $result = $parser->parse($content);
+
+        $this->assertInstanceOf(ParseResult::class, $result);
+        $functions = $result->functions;
+        $this->assertCount(1, $functions);
+        $this->assertEquals('Expr_Closure@4', $functions[0]->name);
+        $this->assertCount(4, $functions[0]->getVariables());
+
+        $vars = $functions[0]->getVariables();
+        $this->assertSame('a', $vars[0]->name);
+        $this->assertSame(4, $vars[0]->lineNumber, 'first $a (4)');
+        $this->assertSame('b', $vars[1]->name);
+        $this->assertSame(4, $vars[1]->lineNumber, 'second $b (4)');
+        $this->assertSame('a', $vars[2]->name);
+        $this->assertSame(5, $vars[2]->lineNumber, 'second $a (5)');
+        $this->assertSame('b', $vars[3]->name);
+        $this->assertSame(5, $vars[3]->lineNumber, 'second $b (5)');
+    }
 }

test/fixtures/AnonymousFunction.php

@@ -0,0 +1,6 @@
+<?php
+
+$items = ['ca', 'aa', 'bc', 'ab', 'ac'];
+usort($items, function (string $a, string $b): int {
+    return $a <=> $b;
+});

test/fixtures/improved_my_average.php

@@ -0,0 +1,14 @@
+<?php
+
+/**
+ * 最小値と最大値を除いて平均を返却します。
+ */
+function improved_my_avearge(array $items): float {
+    sort($items);
+    $newItems = array_slice($items, 1, count($items) - 2);
+    $sum = array_sum($newItems);
+    return $sum / count($newItems);
+}
+
+$items = [3, 99, 40, 45, 50, 52];
+print_r(improved_my_avearge($items) . PHP_EOL);

test/fixtures/ugly_my_average.php

@@ -0,0 +1,31 @@
+<?php
+
+/**
+ * 最小値と最大値を除いて平均を返却します。
+ */
+function ugly_my_average(array $items): float {
+    $minValue = PHP_INT_MAX;
+    $maxValue = PHP_INT_MIN;
+    
+    for ($i = 0; $i < count($items); $i++) {
+        $v = $items[$i];
+        if ($v < $minValue) {
+            $minValue = $v;
+        }
+        if ($v > $maxValue) {
+            $maxValue = $v;
+        }
+    }
+    $sum = 0;
+    for ($i = 0; $i < count($items); $i++) {
+        $v = $items[$i];
+        if (in_array($v, [$minValue, $maxValue])) {
+            continue;
+        }
+        $sum += $v;
+    }
+    return $sum / (count($items) - 2);
+}
+
+$items = [3, 99, 40, 45, 50, 52];
+print_r(ugly_my_average($items) . PHP_EOL);