Merge pull request #4 from permafrost-dev/call-args

Call arguments, value transformations (v1.6)

Author: patinthehat

CHANGELOG.md

@@ -4,6 +4,15 @@ All notable changes to `php-code-search` will be documented in this file.
 
 ---
 
+## 1.6.0 - 2021-07-07
+
+- all function call, static method call, method call nodes have an `args` property containing the value node(s) of the parsed arguments.
+- assignment nodes now have a `value` property and `value()` method.
+- strings and numbers are converted to `StringNode` and `NumberNode` nodes, respectively.
+- most values converted to Node classes that implement either `ResultNode`, `ValueNode`, or both.
+- operations (addition, concat, etc.) converted to Node classes that implement `OperationNode`.
+- fixed several bugs related to non-matches being returned as matches.
+
 ## 1.5.3 - 2021-07-07
 
 - fix issues with `Assignment` nodes

src/Results/Nodes/ArrayItemNode.php

@@ -0,0 +1,30 @@
+<?php
+
+namespace Permafrost\PhpCodeSearch\Results\Nodes;
+
+use Permafrost\PhpCodeSearch\Support\Transformer;
+
+class ArrayItemNode implements ValueNode, ResultNode
+{
+    /** @var mixed|int|string|null */
+    public $key;
+
+    /** @var array|mixed|ResultNode|ValueNode  */
+    public $value;
+
+    public function __construct($key, $value)
+    {
+        $this->key = Transformer::parserNodeToResultNode($key);
+        $this->value = Transformer::parserNodeToResultNode($value);
+    }
+
+    public function name(): string
+    {
+        return $this->key;
+    }
+
+    public function value()
+    {
+        return $this->value;
+    }
+}

src/Results/Nodes/ArrayNode.php

@@ -0,0 +1,29 @@
+<?php
+
+
+namespace Permafrost\PhpCodeSearch\Results\Nodes;
+
+use Permafrost\PhpCodeSearch\Results\Nodes\Traits\TransformsArguments;
+use PhpParser\Node\Expr\Array_;
+
+class ArrayNode implements ValueNode
+{
+    use TransformsArguments;
+
+    /** @var array|ValueNode[]|ResultNode[] */
+    public $value;
+
+    public function __construct($value)
+    {
+        if ($value instanceof Array_) {
+            $value = $value->items;
+        }
+
+        $this->value = $this->transformArgumentsToNodes($value);
+    }
+
+    public function value()
+    {
+        return $this->value;
+    }
+}

src/Results/Nodes/AssignmentNode.php

@@ -2,7 +2,9 @@
 
 namespace Permafrost\PhpCodeSearch\Results\Nodes;
 
-class AssignmentNode implements ResultNode
+use Permafrost\PhpCodeSearch\Support\Transformer;
+
+class AssignmentNode implements ResultNode, ValueNode
 {
     /** @var string */
     public $variableName;
@@ -16,7 +18,7 @@ class AssignmentNode implements ResultNode
     public function __construct(string $variableName, $value)
     {
         $this->variableName = $variableName;
-        $this->value = $value;
+        $this->value = Transformer::parserNodeToResultNode($value);
         $this->name = $this->name();
     }
 
@@ -29,4 +31,9 @@ public function name(): string
     {
         return $this->variableName;
     }
+
+    public function value()
+    {
+        return $this->value;
+    }
 }

src/Results/Nodes/AssignmentOperationNode.php

@@ -0,0 +1,32 @@
+<?php
+
+namespace Permafrost\PhpCodeSearch\Results\Nodes;
+
+use Permafrost\PhpCodeSearch\Support\Transformer;
+use PhpParser\Node\Expr\AssignOp;
+
+class AssignmentOperationNode implements ResultNode, ValueNode
+{
+    /** @var string */
+    public $name;
+
+    /** @var mixed|ResultNode|ValueNode */
+    public $value;
+
+    public function __construct(AssignOp $node)
+    {
+        $this->name = $node->var->name;
+        $this->value = Transformer::parserNodeToResultNode($node->expr);
+    }
+
+    public function name(): string
+    {
+        return $this->name;
+    }
+
+    public function value()
+    {
+        return $this->value;
+    }
+
+}

src/Results/Nodes/BinaryOperationNode.php

@@ -0,0 +1,41 @@
+<?php
+
+namespace Permafrost\PhpCodeSearch\Results\Nodes;
+
+use Permafrost\PhpCodeSearch\Support\Transformer;
+use PhpParser\Node\Expr\BinaryOp;
+
+class BinaryOperationNode implements OperationNode
+{
+    /** @var string */
+    public $symbol;
+
+    /** @var mixed|ResultNode|ValueNode */
+    public $left;
+
+    /** @var mixed|ResultNode|ValueNode */
+    public $right;
+
+    public function __construct(BinaryOp $node)
+    {
+        $this->symbol = $node->getOperatorSigil();
+        $this->left = Transformer::parserNodeToResultNode($node->left);
+        $this->right = Transformer::parserNodeToResultNode($node->right);
+    }
+
+    public function symbol(): string
+    {
+        return $this->symbol;
+    }
+
+    public function left()
+    {
+        return $this->left;
+    }
+
+    public function right()
+    {
+        return $this->right;
+    }
+
+}

src/Results/Nodes/FunctionCallNode.php

@@ -2,17 +2,25 @@
 
 namespace Permafrost\PhpCodeSearch\Results\Nodes;
 
+use Permafrost\PhpCodeSearch\Results\Nodes\Traits\TransformsArguments;
+
 class FunctionCallNode implements ResultNode
 {
+    use TransformsArguments;
+
     /** @var string */
     public $name;
 
-    public function __construct(string $name)
+    /** @var array|ResultNode[]|ValueNode[] */
+    public $args;
+
+    public function __construct(string $name, $args)
     {
         $this->name = $name;
+        $this->args = $this->transformArgumentsToNodes($args);
     }
 
-    public static function create(string $name): self
+    public static function create(string $name, $args): self
     {
         return new static(...func_get_args());
     }
@@ -21,4 +29,6 @@ public function name(): string
     {
         return $this->name;
     }
+
+
 }

src/Results/Nodes/MethodCallNode.php

@@ -2,8 +2,12 @@
 
 namespace Permafrost\PhpCodeSearch\Results\Nodes;
 
+use Permafrost\PhpCodeSearch\Results\Nodes\Traits\TransformsArguments;
+
 class MethodCallNode implements ResultNode
 {
+    use TransformsArguments;
+
     /** @var string */
     public $variableName;
 
@@ -13,14 +17,19 @@ class MethodCallNode implements ResultNode
     /** @var string */
     public $name;
 
-    public function __construct(string $variableName, string $methodName)
+    /** @var array|ResultNode[]|ValueNode[] */
+    public $args;
+
+
+    public function __construct(string $variableName, string $methodName, $args)
     {
         $this->variableName = $variableName;
         $this->methodName = $methodName;
+        $this->args = $this->transformArgumentsToNodes($args);
         $this->name = $this->name();
     }
 
-    public static function create(string $variableName, string $methodName): self
+    public static function create(string $variableName, string $methodName, $args): self
     {
         return new static(...func_get_args());
     }

src/Results/Nodes/OperationNode.php

@@ -0,0 +1,16 @@
+<?php
+
+
+namespace Permafrost\PhpCodeSearch\Results\Nodes;
+
+
+interface OperationNode
+{
+    public function symbol(): string;
+
+    /** @var mixed|ResultNode|ValueNode|OperationNode */
+    public function left();
+
+    /** @var mixed|ResultNode|ValueNode|OperationNode */
+    public function right();
+}

src/Results/Nodes/PropertyAccessNode.php

@@ -0,0 +1,28 @@
+<?php
+
+namespace Permafrost\PhpCodeSearch\Results\Nodes;
+
+class PropertyAccessNode implements ValueNode, ResultNode
+{
+    /** @var string */
+    public $objectName;
+
+    /** @var string */
+    public $propertyName;
+
+    public function __construct(string $objectName, string $propertyName)
+    {
+        $this->objectName = $objectName;
+        $this->propertyName = $propertyName;
+    }
+
+    public function name(): string
+    {
+        return $this->objectName;
+    }
+
+    public function value()
+    {
+        return $this->propertyName;
+    }
+}

src/Results/Nodes/Scalar/NumberNode.php

@@ -0,0 +1,27 @@
+<?php
+
+namespace Permafrost\PhpCodeSearch\Results\Nodes\Scalar;
+
+use Permafrost\PhpCodeSearch\Results\Nodes\ValueNode;
+use PhpParser\Node\Scalar\DNumber;
+use PhpParser\Node\Scalar\LNumber;
+
+class NumberNode implements ValueNode
+{
+    /** @var int|float */
+    public $value;
+
+    public function __construct($value)
+    {
+        if ($value instanceof LNumber || $value instanceof DNumber) {
+            $value = $value->value;
+        }
+
+        $this->value = $value;
+    }
+
+    public function value()
+    {
+        return $this->value;
+    }
+}

src/Results/Nodes/Scalar/StringNode.php

@@ -0,0 +1,26 @@
+<?php
+
+namespace Permafrost\PhpCodeSearch\Results\Nodes\Scalar;
+
+use PhpParser\Node\Scalar\String_;
+
+class StringNode implements \Permafrost\PhpCodeSearch\Results\Nodes\ValueNode
+{
+    /** @var string */
+    public $value;
+
+    public function __construct($value)
+    {
+        if ($value instanceof String_) {
+            $value = $value->value;
+        }
+
+        $this->value = $value;
+    }
+
+
+    public function value()
+    {
+        return $this->value;
+    }
+}

src/Results/Nodes/StaticMethodCallNode.php

@@ -2,8 +2,12 @@
 
 namespace Permafrost\PhpCodeSearch\Results\Nodes;
 
+use Permafrost\PhpCodeSearch\Results\Nodes\Traits\TransformsArguments;
+
 class StaticMethodCallNode implements ResultNode
 {
+    use TransformsArguments;
+
     /** @var string */
     public $className;
 
@@ -13,14 +17,18 @@ class StaticMethodCallNode implements ResultNode
     /** @var string */
     public $name;
 
-    public function __construct(string $className, string $methodName)
+    /** @var array|ResultNode[]|ValueNode[] */
+    public $args;
+
+    public function __construct(string $className, string $methodName, $args)
     {
         $this->className = $className;
         $this->methodName = $methodName;
+        $this->args = $this->transformArgumentsToNodes($args);
         $this->name = $this->name();
     }
 
-    public static function create(string $className, string $methodName): self
+    public static function create(string $className, string $methodName, $args): self
     {
         return new static(...func_get_args());
     }