Merge pull request #8 from permafrost-dev/add-statement-support

patinthehat · web-flow · commit bc0eafefa06b · 2021-07-28T17:46:48.000-04:00
Add function definition support
diff --git a/README.md b/README.md
@@ -76,13 +76,14 @@ foreach($results->results as $result) {
 }
 ```
 
-### Function calls
+### Functions
 
-To search for function calls, use the `functions` method before calling `search`.
+To search for function calls or definitions, use the `functions` method.  Regular expressions can be used by surrounding the name with slashes `/`, i.e. `/test\d+/`.
 
 ```php
+// this will search for references AND definitions for 'strtolower' and 'myfunc'
 $results = $searcher
-    ->functions(['strtolower', 'strtoupper'])
+    ->functions(['strtolower', 'myfunc'])
     ->search('./file1.php');
     
 foreach($results->results as $result) {
diff --git a/composer.json b/composer.json
@@ -30,7 +30,10 @@
     "autoload": {
         "psr-4": {
             "Permafrost\\PhpCodeSearch\\": "src/"
-        }
+        },
+        "files": [
+            "src/Support/helpers.php"
+        ]
     },
     "autoload-dev": {
         "psr-4": {
diff --git a/src/Results/Nodes/ArrayItemNode.php b/src/Results/Nodes/ArrayItemNode.php
@@ -4,7 +4,7 @@
 
 use Permafrost\PhpCodeSearch\Code\GenericCodeLocation;
 use Permafrost\PhpCodeSearch\Results\Nodes\Traits\HasLocation;
-use Permafrost\PhpCodeSearch\Support\Transformer;
+use Permafrost\PhpCodeSearch\Support\ExpressionTransformer;
 use PhpParser\Node;
 
 class ArrayItemNode implements ValueNode, ResultNode
@@ -19,8 +19,8 @@ class ArrayItemNode implements ValueNode, ResultNode
 
     public function __construct(Node $node)
     {
-        $this->key = Transformer::parserNodeToResultNode($node->key);
-        $this->value = Transformer::parserNodeToResultNode($node->value);
+        $this->key = ExpressionTransformer::parserNodeToResultNode($node->key);
+        $this->value = ExpressionTransformer::parserNodeToResultNode($node->value);
         $this->location = GenericCodeLocation::createFromNode($node);
     }
 
diff --git a/src/Results/Nodes/AssignmentNode.php b/src/Results/Nodes/AssignmentNode.php
@@ -4,7 +4,7 @@
 
 use Permafrost\PhpCodeSearch\Code\GenericCodeLocation;
 use Permafrost\PhpCodeSearch\Results\Nodes\Traits\HasLocation;
-use Permafrost\PhpCodeSearch\Support\Transformer;
+use Permafrost\PhpCodeSearch\Support\ExpressionTransformer;
 use PhpParser\Node;
 
 class AssignmentNode implements ResultNode, ValueNode
@@ -23,7 +23,7 @@ class AssignmentNode implements ResultNode, ValueNode
     public function __construct(Node\Expr\Assign $node)
     {
         $this->variableName = $node->var->name;
-        $this->value = Transformer::parserNodeToResultNode($node->expr);
+        $this->value = ExpressionTransformer::parserNodeToResultNode($node->expr);
         $this->location = GenericCodeLocation::createFromNode($node);
         $this->name = $this->name();
     }
diff --git a/src/Results/Nodes/AssignmentOperationNode.php b/src/Results/Nodes/AssignmentOperationNode.php
@@ -4,7 +4,7 @@
 
 use Permafrost\PhpCodeSearch\Code\GenericCodeLocation;
 use Permafrost\PhpCodeSearch\Results\Nodes\Traits\HasLocation;
-use Permafrost\PhpCodeSearch\Support\Transformer;
+use Permafrost\PhpCodeSearch\Support\ExpressionTransformer;
 use PhpParser\Node\Expr\AssignOp;
 
 class AssignmentOperationNode implements ResultNode, ValueNode
@@ -20,7 +20,7 @@ class AssignmentOperationNode implements ResultNode, ValueNode
     public function __construct(AssignOp $node)
     {
         $this->name = $node->var->name;
-        $this->value = Transformer::parserNodeToResultNode($node->expr);
+        $this->value = ExpressionTransformer::parserNodeToResultNode($node->expr);
         $this->location = GenericCodeLocation::createFromNode($node);
     }
 
diff --git a/src/Results/Nodes/BinaryOperationNode.php b/src/Results/Nodes/BinaryOperationNode.php
@@ -4,7 +4,7 @@
 
 use Permafrost\PhpCodeSearch\Code\GenericCodeLocation;
 use Permafrost\PhpCodeSearch\Results\Nodes\Traits\HasLocation;
-use Permafrost\PhpCodeSearch\Support\Transformer;
+use Permafrost\PhpCodeSearch\Support\ExpressionTransformer;
 use PhpParser\Node\Expr\BinaryOp;
 
 class BinaryOperationNode implements OperationNode, ValueNode
@@ -26,15 +26,15 @@ class BinaryOperationNode implements OperationNode, ValueNode
     public function __construct(BinaryOp $node)
     {
         $this->symbol = $node->getOperatorSigil();
-        $this->left = Transformer::parserNodeToResultNode($node->left);
-        $this->right = Transformer::parserNodeToResultNode($node->right);
+        $this->left = ExpressionTransformer::parserNodeToResultNode($node->left);
+        $this->right = ExpressionTransformer::parserNodeToResultNode($node->right);
 
 //        $this->value = '';
 //        if (property_exists($this->left, 'value') && property_exists($this->right, 'value')) {
         $leftValue = '';
         $rightValue = '';
 
-        $this->value = Transformer::binaryOperationNodeToValue($this);
+        $this->value = ExpressionTransformer::binaryOperationNodeToValue($this);
 
         $this->location = GenericCodeLocation::createFromNode($node);
     }
diff --git a/src/Results/Nodes/FunctionDefinitionNode.php b/src/Results/Nodes/FunctionDefinitionNode.php
@@ -0,0 +1,38 @@
+<?php
+
+namespace Permafrost\PhpCodeSearch\Results\Nodes;
+
+use Permafrost\PhpCodeSearch\Code\GenericCodeLocation;
+use Permafrost\PhpCodeSearch\Results\Nodes\Traits\HasLocation;
+use Permafrost\PhpCodeSearch\Results\Nodes\Traits\TransformsArguments;
+use Permafrost\PhpCodeSearch\Support\StatementTransformer;
+use PhpParser\Node;
+
+class FunctionDefinitionNode implements ResultNode
+{
+    use HasLocation;
+    use TransformsArguments;
+
+    /** @var string */
+    public $name;
+
+    /** @var array|ResultNode[]|ValueNode[] */
+    public $args;
+
+    public function __construct(Node\Stmt\Function_ $node)
+    {
+        $this->name = $node->name->toString();
+        $this->args = (new StatementTransformer())->parserNodesToResultNode($node->getParams());
+        $this->location = GenericCodeLocation::createFromNode($node);
+    }
+
+    public static function create(Node\Stmt\Function_ $node): self
+    {
+        return new static(...func_get_args());
+    }
+
+    public function name(): string
+    {
+        return $this->name;
+    }
+}
diff --git a/src/Results/Nodes/ParameterNode.php b/src/Results/Nodes/ParameterNode.php
@@ -0,0 +1,39 @@
+<?php
+
+namespace Permafrost\PhpCodeSearch\Results\Nodes;
+
+use Permafrost\PhpCodeSearch\Code\GenericCodeLocation;
+use Permafrost\PhpCodeSearch\Results\Nodes\Traits\HasLocation;
+use Permafrost\PhpCodeSearch\Results\Nodes\Traits\HasName;
+use Permafrost\PhpCodeSearch\Support\ExpressionTransformer;
+use PhpParser\Node;
+
+class ParameterNode implements ResultNode
+{
+    use HasLocation;
+    use HasName;
+
+    /** @var string|null */
+    public $type;
+
+    /** @var array|mixed|ArrayItemNode|ArrayNode|AssignmentNode|BinaryOperationNode|FunctionCallNode|MethodCallNode|PropertyAccessNode|Scalar\NumberNode|Scalar\StringNode|StaticMethodCallNode|StaticPropertyAccessNode|VariableNode|Node\Arg|null  */
+    public $default;
+
+    public function __construct(Node\Param $node)
+    {
+        $this->name = $node->var->name;
+        $this->type = optional($node->type)->toString();
+        $this->default = $node->default ? ExpressionTransformer::parserNodeToResultNode($node->default) : null;
+        $this->location = GenericCodeLocation::createFromNode($node);
+    }
+
+    public static function create(Node\Param $node): self
+    {
+        return new static(...func_get_args());
+    }
+
+    public function defaultValue()
+    {
+        return $this->default;
+    }
+}
diff --git a/src/Results/Nodes/Traits/HasName.php b/src/Results/Nodes/Traits/HasName.php
@@ -0,0 +1,14 @@
+<?php
+
+namespace Permafrost\PhpCodeSearch\Results\Nodes\Traits;
+
+trait HasName
+{
+    /** @var string */
+    public $name;
+
+    public function name(): string
+    {
+        return $this->name;
+    }
+}
diff --git a/src/Results/Nodes/Traits/TransformsArguments.php b/src/Results/Nodes/Traits/TransformsArguments.php
@@ -2,12 +2,12 @@
 
 namespace Permafrost\PhpCodeSearch\Results\Nodes\Traits;
 
-use Permafrost\PhpCodeSearch\Support\Transformer;
+use Permafrost\PhpCodeSearch\Support\ExpressionTransformer;
 
 trait TransformsArguments
 {
     public function transformArgumentsToNodes(array $args): array
     {
-        return Transformer::parserNodesToResultNodes($args);
+        return ExpressionTransformer::parserNodesToResultNodes($args);
     }
 }
diff --git a/src/Searcher.php b/src/Searcher.php
@@ -9,6 +9,7 @@
 use Permafrost\PhpCodeSearch\Support\VirtualFile;
 use Permafrost\PhpCodeSearch\Visitors\AssignmentVisitor;
 use Permafrost\PhpCodeSearch\Visitors\FunctionCallVisitor;
+use Permafrost\PhpCodeSearch\Visitors\FunctionDefinitionVisitor;
 use Permafrost\PhpCodeSearch\Visitors\MethodCallVisitor;
 use Permafrost\PhpCodeSearch\Visitors\NewClassVisitor;
 use Permafrost\PhpCodeSearch\Visitors\StaticCallVisitor;
@@ -167,14 +168,16 @@ protected function findAllReferences(array $ast): array
         $classes = $this->findReferences($ast, Node\Expr\New_::class, 'class', $this->classes);
         $methods = $this->findReferences($ast, Node\Expr\MethodCall::class, 'name', $this->methods);
         $variables = $this->findReferences($ast, Node\Expr\Variable::class, 'name', $this->variables);
+        $functionDefs = $this->findReferences($ast, Node\Stmt\Function_::class, 'name', $this->functions);
 
         return $this->sortNodesByLineNumber(
-            $functionCalls,
+            $assignments,
             $classes,
+            $functionCalls,
+            $functionDefs,
+            $methods,
             $staticMethodCalls,
             $staticProperties,
-            $assignments,
-            $methods,
             $variables
         );
     }
@@ -239,6 +242,12 @@ protected function findReferences(array $ast, string $class, ?string $nodeNamePr
                 return Arr::matches($name, $names, true);
             }
 
+            if ($node instanceof Node\Stmt\Function_) {
+                $name = $node->name->name;
+
+                return Arr::matches($name, $names, true);
+            }
+
             if ($node instanceof Node\Expr\Array_) {
                 return false;
             }
@@ -292,6 +301,7 @@ protected function traverseNodes(FileSearchResults $results, array $nodes): void
         $traverser->addVisitor(new NewClassVisitor($results, $this->classes));
         $traverser->addVisitor(new AssignmentVisitor($results, $this->assignments));
         $traverser->addVisitor(new StaticPropertyVisitor($results, $this->static));
+        $traverser->addVisitor(new FunctionDefinitionVisitor($results, $this->functions));
 
         $traverser->traverse($nodes);
     }
diff --git a/src/Support/ExpressionTransformer.php b/src/Support/ExpressionTransformer.php
@@ -32,7 +32,7 @@
 use PhpParser\Node\Scalar\LNumber;
 use PhpParser\Node\Scalar\String_;
 
-class Transformer
+class ExpressionTransformer
 {
     public static function parserNodesToResultNodes(array $nodes): array
     {
diff --git a/src/Support/StatementTransformer.php b/src/Support/StatementTransformer.php
@@ -0,0 +1,29 @@
+<?php
+
+namespace Permafrost\PhpCodeSearch\Support;
+
+use Permafrost\PhpCodeSearch\Results\Nodes\ParameterNode;
+use PhpParser\Node;
+
+class StatementTransformer
+{
+    public function parserNodeToResultNode(Node $node)
+    {
+        if ($node instanceof Node\Param) {
+            return new ParameterNode($node);
+        }
+
+        return $node;
+    }
+
+    public function parserNodesToResultNode(array $nodes)
+    {
+        $result = [];
+
+        foreach($nodes as $node) {
+            $result[] = $this->parserNodeToResultNode($node);
+        }
+
+        return $result;
+    }
+}
diff --git a/src/Support/helpers.php b/src/Support/helpers.php
@@ -0,0 +1,19 @@
+<?php
+
+if (! function_exists('optional')) {
+    function optional($value) {
+        if (! $value) {
+            return new class {
+                public function __get($name) {
+                    return null;
+                }
+                public function __call($name, $arguments)
+                {
+                    return null;
+                }
+            };
+        }
+
+        return $value;
+    }
+}
diff --git a/src/Visitors/FunctionDefinitionVisitor.php b/src/Visitors/FunctionDefinitionVisitor.php
@@ -0,0 +1,35 @@
+<?php
+
+
+namespace Permafrost\PhpCodeSearch\Visitors;
+
+use Permafrost\PhpCodeSearch\Results\FileSearchResults;
+use Permafrost\PhpCodeSearch\Results\Nodes\FunctionDefinitionNode;
+use Permafrost\PhpCodeSearch\Support\Arr;
+use PhpParser\Node;
+use PhpParser\NodeVisitorAbstract;
+
+class FunctionDefinitionVisitor extends NodeVisitorAbstract
+{
+    /** @var FileSearchResults */
+    protected $results;
+
+    protected $names = [];
+
+    public function __construct(FileSearchResults $results, array $names)
+    {
+        $this->results = $results;
+        $this->names = $names;
+    }
+
+    public function enterNode(Node $node)
+    {
+        if ($node instanceof Node\Stmt\Function_) {
+            if (Arr::matches($node->name->toString(), $this->names, true)) {
+                $resultNode = FunctionDefinitionNode::create($node);
+
+                $this->results->add($resultNode, $resultNode->location());
+            }
+        }
+    }
+}
diff --git a/tests/SearcherTest.php b/tests/SearcherTest.php
@@ -245,4 +245,25 @@ public function it_finds_variables_using_regex()
         $this->assertEquals('objA', $results->results[0]->node->name());
         $this->assertEquals('objB', $results->results[1]->node->name());
     }
+
+    /** @test */
+    public function it_searches_for_function_definitions()
+    {
+        $searcher = new Searcher();
+        $file = new File(tests_path('data/file2.php'));
+
+        $results = $searcher
+            ->functions(['test2'])
+            ->withoutSnippets()
+            ->search($file);
+
+        $this->assertMatchesSnapshot($results->results);
+
+        $results = $searcher
+            ->functions(['/test\d+/'])
+            ->withoutSnippets()
+            ->search($file);
+
+        $this->assertMatchesSnapshot($results->results);
+    }
 }
diff --git a/tests/Support/HelpersTest.php b/tests/Support/HelpersTest.php
diff --git a/tests/__snapshots__/SearcherTest__it_searches_for_function_definitions__1.yml b/tests/__snapshots__/SearcherTest__it_searches_for_function_definitions__1.yml
diff --git a/tests/__snapshots__/SearcherTest__it_searches_for_function_definitions__2.yml b/tests/__snapshots__/SearcherTest__it_searches_for_function_definitions__2.yml
diff --git a/tests/data/file2.php b/tests/data/file2.php

Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@`
`4`	`4`
`5`	`5`	`use Permafrost\PhpCodeSearch\Code\GenericCodeLocation;`
`6`	`6`	`use Permafrost\PhpCodeSearch\Results\Nodes\Traits\HasLocation;`
`7`		`-use Permafrost\PhpCodeSearch\Support\Transformer;`
	`7`	`+use Permafrost\PhpCodeSearch\Support\ExpressionTransformer;`
`8`	`8`	`use PhpParser\Node\Expr\AssignOp;`
`9`	`9`
`10`	`10`	`class AssignmentOperationNode implements ResultNode, ValueNode`
`@@ -20,7 +20,7 @@ class AssignmentOperationNode implements ResultNode, ValueNode`
`20`	`20`	`public function __construct(AssignOp $node)`
`21`	`21`	`{`
`22`	`22`	`$this->name = $node->var->name;`
`23`		`- $this->value = Transformer::parserNodeToResultNode($node->expr);`
	`23`	`+ $this->value = ExpressionTransformer::parserNodeToResultNode($node->expr);`
`24`	`24`	`$this->location = GenericCodeLocation::createFromNode($node);`
`25`	`25`	`}`
`26`	`26`
Original file line number	Diff line number	Diff line change
`@@ -2,12 +2,12 @@`
`2`	`2`
`3`	`3`	`namespace Permafrost\PhpCodeSearch\Results\Nodes\Traits;`
`4`	`4`
`5`		`-use Permafrost\PhpCodeSearch\Support\Transformer;`
	`5`	`+use Permafrost\PhpCodeSearch\Support\ExpressionTransformer;`
`6`	`6`
`7`	`7`	`trait TransformsArguments`
`8`	`8`	`{`
`9`	`9`	`public function transformArgumentsToNodes(array $args): array`
`10`	`10`	`{`
`11`		`- return Transformer::parserNodesToResultNodes($args);`
	`11`	`+ return ExpressionTransformer::parserNodesToResultNodes($args);`
`12`	`12`	`}`
`13`	`13`	`}`