Lots more cleanup

- Registering a function can typehint on callable
- No need for a special prettyPrint function when debugging
- Simplified validation by removing default types and variadics.
- Using short array syntax in functions.
- Removing the ability to inject a parser or interpreter from runtimes.
- TreeInterpreter now requires a RuntimeInterface in the constructor.

Author: mtdowling

src/Runtime/AbstractRuntime.php

@@ -13,30 +13,13 @@ class AstRuntime extends AbstractRuntime
 {
     /** @var TreeVisitorInterface */
     private $interpreter;
-
-    /** @var array */
-    private $visitorOptions;
-
-    /** @var array Internal AST cache */
     private $cache = [];
-
-    /** @var int Number of cached entries */
     private $cachedCount = 0;
 
-    /**
-     * @param array $config Configuration options for the runtime.
-     *                      - parser: Parser to use (optional)
-     *                      - interpreter: Interprets the AST (optional)
-     */
-    public function __construct(array $config = [])
+    public function __construct()
     {
-        $this->visitorOptions = ['runtime' => $this];
-        $this->parser = isset($config['parser'])
-            ? $config['parser']
-            : new Parser();
-        $this->interpreter = isset($config['interpreter'])
-            ? $config['interpreter']
-            : new TreeInterpreter($this);
+        $this->parser = new Parser();
+        $this->interpreter = new TreeInterpreter($this);
     }
 
     public function search($expression, $data)
@@ -49,25 +32,21 @@ public function search($expression, $data)
             $this->cache[$expression] = $this->parser->parse($expression);
         }
 
-        return $this->interpreter->visit(
-            $this->cache[$expression],
-            $data,
-            $this->visitorOptions
-        );
+        return $this->interpreter->visit($this->cache[$expression], $data);
     }
 
     public function debug($expression, $data, $out = STDOUT)
     {
         fprintf($out, "Expression\n==========\n\n%s\n\n", $expression);
         list($_, $lexTime) = $this->printDebugTokens($out, $expression);
         list($ast, $parseTime) = $this->printDebugAst($out, $expression);
-        fprintf($out, "\nData\n====\n\n%s\n\n", $this->prettyJson($data));
+        fprintf($out, "\nData\n====\n\n%s\n\n", json_encode($data, JSON_PRETTY_PRINT));
 
         $t = microtime(true);
-        $result = $this->interpreter->visit($ast, $data, $this->visitorOptions);
+        $result = $this->interpreter->visit($ast, $data);
         $interpretTime = (microtime(true) - $t) * 1000;
 
-        fprintf($out, "\nResult\n======\n\n%s\n\n", $this->prettyJson($result));
+        fprintf($out, "\nResult\n======\n\n%s\n\n", json_encode($result, JSON_PRETTY_PRINT));
         fwrite($out, "Time\n====\n\n");
         fprintf($out, "Lexer time:     %f ms\n", $lexTime);
         fprintf($out, "Parse time:     %f ms\n", $parseTime);

src/Runtime/AstRuntime.php

@@ -20,16 +20,13 @@ class CompilerRuntime extends AbstractRuntime
 
     /**
      * @param array $config Array of configuration options.
-     *                      - parser: Parses expressions
      *                      - dir: Directory used to store compiled PHP files.
      * @throws \RuntimeException if the cache directory cannot be created
      */
     public function __construct(array $config = [])
     {
         $this->compiler = new TreeCompiler();
-        $this->parser = isset($config['parser'])
-            ? $config['parser']
-            : new Parser();
+        $this->parser = new Parser();
 
         if (!isset($config['dir'])) {
             $config['dir'] = sys_get_temp_dir();
@@ -74,18 +71,16 @@ public function search($expression, $data)
 
     public function clearCache()
     {
-        $files = glob("{$this->cacheDir}/jmespath_*.php");
-        foreach ($files as $file) {
+        foreach (glob("{$this->cacheDir}/jmespath_*.php") as $file) {
             unlink($file);
         }
     }
 
     public function debug($expression, $data, $out = STDOUT)
     {
         fprintf($out, "Expression\n==========\n\n%s\n\n", $expression);
-        list($tokens, $lexTime) = $this->printDebugTokens($out, $expression);
-        list($ast, $parseTime) = $this->printDebugAst($out, $expression);
-
+        list($_, $lexTime) = $this->printDebugTokens($out, $expression);
+        list($_, $parseTime) = $this->printDebugAst($out, $expression);
         $hash = md5($expression);
         $functionName = "jmespath_{$hash}";
         $filename = "{$this->cacheDir}/{$functionName}.php";
@@ -95,8 +90,8 @@ public function debug($expression, $data, $out = STDOUT)
         $interpretTime = (microtime(true) - $t) * 1000;
 
         fprintf($out, "\nSource\n======\n\n%s", file_get_contents($filename));
-        fprintf($out, "\nData\n====\n\n%s\n\n", $this->prettyJson($data));
-        fprintf($out, "\nResult\n======\n\n%s\n\n", $this->prettyJson($result));
+        fprintf($out, "\nData\n====\n\n%s\n\n", json_encode($data, JSON_PRETTY_PRINT));
+        fprintf($out, "\nResult\n======\n\n%s\n\n", json_encode($result, JSON_PRETTY_PRINT));
         fwrite($out, "Time\n====\n\n");
         fprintf($out, "Lexer time:     %f ms\n", $lexTime);
         fprintf($out, "Parse time:     %f ms\n", $parseTime);

src/Runtime/CompilerRuntime.php

@@ -44,7 +44,7 @@ public function debug($expression, $data, $out = STDOUT);
      * @throws \InvalidArgumentException if the function is not callable or is
      *                                   a built-in function.
      */
-    public function registerFunction($name, $fn);
+    public function registerFunction($name, callable $fn);
 
     /**
      * Invokes a named function.

src/Runtime/RuntimeInterface.php

@@ -24,17 +24,19 @@ public function visit(array $node, $data, array $args = null)
         $this->source = '';
         $this->indentation = 0;
         $this->write("<?php\n");
+
         if (isset($args['expression'])) {
             $this->write("// {$args['expression']}");
         }
+
         $this->write("function {$args['function_name']}(JmesPath\\Runtime\\RuntimeInterface \$runtime, \$value) {")
-                ->indent()
+            ->indent()
                 ->write('$current = $value;')
                 ->dispatch($node)
                 ->write('')
                 ->write('return $value;')
-                ->outdent()
-            ->write('}');
+            ->outdent()
+        ->write('}');
 
         return $this->source;
     }
@@ -281,7 +283,7 @@ private function visit_expression(array $node)
         $child = var_export($node['children'][0], true);
 
         return $this->write("\$value = new \\JmesPath\\Tree\\ExprNode("
-            . "new \\JmesPath\\Tree\\TreeInterpreter(), $child);");
+            . "new \\JmesPath\\Tree\\TreeInterpreter(new \\JmesPath\\Runtime\\AstRuntime()), $child);");
     }
 
     private function visit_flatten(array $node)

src/Tree/TreeCompiler.php

@@ -1,7 +1,6 @@
 <?php
 namespace JmesPath\Tree;
 
-use JmesPath\Runtime\AstRuntime;
 use JmesPath\Runtime\RuntimeInterface;
 
 /**
@@ -12,19 +11,13 @@ class TreeInterpreter implements TreeVisitorInterface
     /** @var RuntimeInterface Runtime used to manage function calls */
     private $runtime;
 
-    public function __construct(RuntimeInterface $runtime = null)
+    public function __construct(RuntimeInterface $runtime)
     {
         $this->runtime = $runtime;
     }
 
     public function visit(array $node, $data, array $args = null)
     {
-        if (!$this->runtime) {
-            $this->runtime = isset($args['runtime'])
-                ? $args['runtime']
-                : new AstRuntime();
-        }
-
         return $this->dispatch($node, $data);
     }
 

src/Tree/TreeInterpreter.php

@@ -3,17 +3,6 @@
 
 class AbstractRuntimeTest extends \PHPUnit_Framework_TestCase
 {
-    /**
-     * @expectedException \InvalidArgumentException
-     * @expectedExceptionMessage Function must be callable
-     */
-    public function testEnsuresFunctionsAreCallable()
-    {
-        $r = $this->getMockBuilder('JmesPath\Runtime\AbstractRuntime')
-            ->getMockForAbstractClass();
-        $r->registerFunction('foo', 'bar');
-    }
-
     /**
      * @expectedException \RuntimeException
      * @expectedExceptionMessage Call to undefined function foo

tests/Runtime/AbstractRuntimeTest.php

@@ -1,19 +1,13 @@
 <?php
 namespace JmesPath\Tests\Runtime;
 
-use JmesPath\Parser;
 use JmesPath\Runtime\AstRuntime;
-use JmesPath\Tree\TreeInterpreter;
-use JmesPath\Lexer;
 
 class AstRuntimeTest extends \PHPUnit_Framework_TestCase
 {
     public function testClearsCache()
     {
-        $r = new AstRuntime([
-            'parser'      => new Parser(new Lexer()),
-            'interpreter' => new TreeInterpreter()
-        ]);
+        $r = new AstRuntime();
         $r->search('foo', array());
         $this->assertNotEmpty($this->readAttribute($r, 'cache'));
         $r->clearCache();

tests/Runtime/AstRuntimeTest.php

@@ -11,7 +11,7 @@ class TreeInterpreterTest extends \PHPUnit_Framework_TestCase
 {
     public function testReturnsNullWhenMergingNonArray()
     {
-        $t = new TreeInterpreter();
+        $t = new TreeInterpreter(new AstRuntime());
         $this->assertNull($t->visit(array(
             'type' => 'flatten',
             'children' => array(