Making a DebugRuntime instead of a Debugger

Author: mtdowling

bin/jp.php

@@ -2,6 +2,9 @@
 <?php
 require __DIR__ . '/../vendor/autoload.php';
 
+use JmesPath\Env;
+use JmesPath\DebugRuntime;
+
 $description = <<<EOT
 Runs a JMESPath expression on the provided input or a test case.
 
@@ -58,4 +61,5 @@
     die($description);
 }
 
-(new \JmesPath\Debugger())->debugFromEnv(STDOUT, $expression, $data);
+$runtime = new DebugRuntime(Env::createRuntime());
+$runtime($expression, $data);

src/DebugRuntime.php

@@ -0,0 +1,109 @@
+<?php
+namespace JmesPath;
+
+/**
+ * Provides CLI debugging information for the AST and Compiler runtimes.
+ */
+class DebugRuntime
+{
+    private $runtime;
+    private $out;
+    private $lexer;
+    private $parser;
+
+    public function __construct(callable $runtime, $output = null)
+    {
+        $this->runtime = $runtime;
+        $this->out = $output ?: STDOUT;
+        $this->lexer = new Lexer();
+        $this->parser = new Parser($this->lexer);
+    }
+
+    public function __invoke($expression, $data)
+    {
+        if ($this->runtime instanceof CompilerRuntime) {
+            return $this->debugCompiled($expression, $data);
+        }
+
+        return $this->debugInterpreted($expression, $data);
+    }
+
+    private function debugInterpreted($expression, $data)
+    {
+        return $this->debugCallback(
+            function () use ($expression, $data) {
+                $runtime = $this->runtime;
+                return $runtime($expression, $data);
+            },
+            $expression,
+            $data
+        );
+    }
+
+    public function debugCompiled($expression, $data)
+    {
+        $result = $this->debugCallback(
+            function () use ($expression, $data) {
+                $runtime = $this->runtime;
+                return $runtime($expression, $data);
+            },
+            $expression,
+            $data
+        );
+        $this->dumpCompiledCode($expression);
+
+        return $result;
+    }
+
+    public function dumpTokens($expression)
+    {
+        $lexer = new Lexer();
+        fwrite($this->out, "Tokens\n======\n\n");
+        $tokens = $lexer->tokenize($expression);
+
+        foreach ($tokens as $t) {
+            fprintf(
+                $this->out,
+                "%3d  %-13s  %s\n", $t['pos'], $t['type'],
+                json_encode($t['value'])
+            );
+        }
+
+        fwrite($this->out, "\n");
+    }
+
+    public function dumpAst($expression)
+    {
+        $parser = new Parser();
+        $ast = $parser->parse($expression);
+        fwrite($this->out, "AST\n========\n\n");
+        fwrite($this->out, json_encode($ast, JSON_PRETTY_PRINT) . "\n");
+    }
+
+    public function dumpCompiledCode($expression)
+    {
+        fwrite($this->out, "Code\n========\n\n");
+        $dir = sys_get_temp_dir();
+        $hash = md5($expression);
+        $functionName = "jmespath_{$hash}";
+        $filename = "{$dir}/{$functionName}.php";
+        fwrite($this->out, "File: {$filename}\n\n");
+        fprintf($this->out, file_get_contents($filename));
+    }
+
+    private function debugCallback(callable $debugFn, $expression, $data)
+    {
+        fprintf($this->out, "Expression\n==========\n\n%s\n\n", $expression);
+        $this->dumpTokens($expression);
+        $this->dumpAst($expression);
+        fprintf($this->out, "\nData\n====\n\n%s\n\n", json_encode($data, JSON_PRETTY_PRINT));
+        $startTime = microtime(true);
+        $result = $debugFn();
+        $total = microtime(true) - $startTime;
+        fprintf($this->out, "\nResult\n======\n\n%s\n\n", json_encode($result, JSON_PRETTY_PRINT));
+        fwrite($this->out, "Time\n====\n\n");
+        fprintf($this->out, "Total time:     %f ms\n\n", $total);
+
+        return $result;
+    }
+}

src/Debugger.php

@@ -38,7 +38,7 @@ public static function search($expression, $data)
      * Creates a JMESPath runtime based on environment variables and extensions
      * available on a system.
      *
-     * @return AstRuntime|CompilerRuntime
+     * @return callable
      */
     public static function createRuntime()
     {