feature symfony#19013 [ExpressionLanguage] Added a way to dump the AST (lyrixx)

This PR was merged into the 3.2-dev branch.

Discussion
----------

[ExpressionLanguage] Added a way to dump the AST

| Q             | A
| ------------- | ---
| Branch?       | master
| Bug fix?      | no
| New feature?  | yes
| BC breaks?    | no
| Deprecations? | no
| Tests pass?   | yes
| Fixed tickets |
| License       | MIT
| Doc PR        |

Because it's convenient and it makes easier to inline results of sub/smaller part of the main expression.

Commits
-------

87af6e5 [ExpressionLanguage] Added a way to dump AST

Author: fabpot

src/Symfony/Component/ExpressionLanguage/Node/ArgumentsNode.php

@@ -24,4 +24,15 @@ public function compile(Compiler $compiler)
     {
         $this->compileArguments($compiler, false);
     }
+
+    public function dump()
+    {
+        $str = '';
+
+        foreach ($this->getKeyValuePairs() as $pair) {
+            $str .= sprintf('%s, ', $pair['value']->dump());
+        }
+
+        return rtrim($str, ', ');
+    }
 }

src/Symfony/Component/ExpressionLanguage/Node/ArrayNode.php

@@ -58,6 +58,36 @@ public function evaluate($functions, $values)
         return $result;
     }
 
+    public function dump()
+    {
+        $array = array();
+        foreach ($this->getKeyValuePairs() as $pair) {
+            $array[$pair['key']->attributes['value']] = $pair['value']->dump();
+        }
+
+        if ($this->isHash($array)) {
+            $str = '{';
+
+            foreach ($array as $key => $value) {
+                if (is_int($key)) {
+                    $str .= sprintf('%s: %s, ', $key, $value);
+                } else {
+                    $str .= sprintf('"%s": %s, ', $this->dumpEscaped($key), $value);
+                }
+            }
+
+            return rtrim($str, ', ').'}';
+        }
+
+        $str = '[';
+
+        foreach ($array as $key => $value) {
+            $str .= sprintf('%s, ', $value);
+        }
+
+        return rtrim($str, ', ').']';
+    }
+
     protected function getKeyValuePairs()
     {
         $pairs = array();

src/Symfony/Component/ExpressionLanguage/Node/BinaryNode.php

@@ -154,4 +154,9 @@ public function evaluate($functions, $values)
                 return preg_match($right, $left);
         }
     }
+
+    public function dump()
+    {
+        return sprintf('(%s %s %s)', $this->nodes['left']->dump(), $this->attributes['operator'], $this->nodes['right']->dump());
+    }
 }

src/Symfony/Component/ExpressionLanguage/Node/ConditionalNode.php

@@ -48,4 +48,9 @@ public function evaluate($functions, $values)
 
         return $this->nodes['expr3']->evaluate($functions, $values);
     }
+
+    public function dump()
+    {
+        return sprintf('(%s ? %s : %s)', $this->nodes['expr1']->dump(), $this->nodes['expr2']->dump(), $this->nodes['expr3']->dump());
+    }
 }

src/Symfony/Component/ExpressionLanguage/Node/ConstantNode.php

@@ -37,4 +37,52 @@ public function evaluate($functions, $values)
     {
         return $this->attributes['value'];
     }
+
+    public function dump()
+    {
+        return $this->dumpValue($this->attributes['value']);
+    }
+
+    private function dumpValue($value)
+    {
+        switch (true) {
+            case true === $value:
+                return 'true';
+
+            case false === $value:
+                return 'false';
+
+            case null === $value:
+                return 'null';
+
+            case is_numeric($value):
+                return $value;
+
+            case is_array($value):
+                if ($this->isHash($value)) {
+                    $str = '{';
+
+                    foreach ($value as $key => $v) {
+                        if (is_int($key)) {
+                            $str .= sprintf('%s: %s, ', $key, $this->dumpValue($v));
+                        } else {
+                            $str .= sprintf('"%s": %s, ', $this->dumpEscaped($key), $this->dumpValue($v));
+                        }
+                    }
+
+                    return rtrim($str, ', ').'}';
+                }
+
+                $str = '[';
+
+                foreach ($value as $key => $v) {
+                    $str .= sprintf('%s, ', $this->dumpValue($v));
+                }
+
+                return rtrim($str, ', ').']';
+
+            default:
+                return sprintf('"%s"', $this->dumpEscaped($value));
+        }
+    }
 }

src/Symfony/Component/ExpressionLanguage/Node/FunctionNode.php

@@ -49,4 +49,17 @@ public function evaluate($functions, $values)
 
         return call_user_func_array($functions[$this->attributes['name']]['evaluator'], $arguments);
     }
+
+    public function dump()
+    {
+        $str = $this->attributes['name'];
+
+        $str .= '(';
+
+        foreach ($this->nodes['arguments']->nodes as $node) {
+            $str .= $node->dump().', ';
+        }
+
+        return rtrim($str, ', ').')';
+    }
 }

src/Symfony/Component/ExpressionLanguage/Node/GetAttrNode.php

@@ -94,4 +94,18 @@ public function evaluate($functions, $values)
                 return $array[$this->nodes['attribute']->evaluate($functions, $values)];
         }
     }
+
+    public function dump()
+    {
+        switch ($this->attributes['type']) {
+            case self::PROPERTY_CALL:
+                return sprintf('%s.%s', $this->nodes['node']->dump(), trim($this->nodes['attribute']->dump(), '"'));
+
+            case self::METHOD_CALL:
+                return sprintf('%s.%s(%s)', $this->nodes['node']->dump(), trim($this->nodes['attribute']->dump(), '"'), $this->nodes['arguments']->dump());
+
+            case self::ARRAY_CALL:
+                return sprintf('%s[%s]', $this->nodes['node']->dump(), $this->nodes['attribute']->dump());
+        }
+    }
 }

src/Symfony/Component/ExpressionLanguage/Node/NameNode.php

@@ -37,4 +37,9 @@ public function evaluate($functions, $values)
     {
         return $values[$this->attributes['name']];
     }
+
+    public function dump()
+    {
+        return $this->attributes['name'];
+    }
 }

src/Symfony/Component/ExpressionLanguage/Node/Node.php

@@ -75,4 +75,27 @@ public function evaluate($functions, $values)
 
         return $results;
     }
+
+    public function dump()
+    {
+        throw new \BadMethodCallException(sprintf('Dumping a "%s" instance is not supported yet.', get_class($this)));
+    }
+
+    protected function dumpEscaped($value)
+    {
+        return str_replace(array('\\', '"'), array('\\\\', '\"'), $value);
+    }
+
+    protected function isHash(array $value)
+    {
+        $expectedKey = 0;
+
+        foreach ($value as $key => $val) {
+            if ($key !== $expectedKey++) {
+                return true;
+            }
+        }
+
+        return false;
+    }
 }

src/Symfony/Component/ExpressionLanguage/Node/UnaryNode.php

@@ -58,4 +58,9 @@ public function evaluate($functions, $values)
 
         return $value;
     }
+
+    public function dump()
+    {
+        return sprintf('(%s %s)', $this->attributes['operator'], $this->nodes['node']->dump());
+    }
 }