Fixing up comments and adding source code to debug output

Author: mtdowling

src/AstRuntime.php

@@ -2,8 +2,7 @@
 namespace JmesPath;
 
 /**
- * Default JMESPath runtime environment that uses an external tree visitor to
- * interpret an AST.
+ * Uses an external tree visitor to interpret an AST.
  */
 class AstRuntime
 {

src/CompilerRuntime.php

@@ -2,8 +2,7 @@
 namespace JmesPath;
 
 /**
- * JMESPath runtime environment that compiles JMESPath expressions to PHP
- * source code.
+ * Compiles JMESPath expressions to PHP source code and executes it.
  *
  * JMESPath filenames are stored in the cache directory using the following
  * logic to determine the filename:

src/Debugger.php

@@ -60,10 +60,12 @@ public function dumpAst($out, $expression)
 
     public function dumpCompiledCode($out, $expression)
     {
+        fwrite($out, "Code\n========\n\n");
         $dir = sys_get_temp_dir();
         $hash = md5($expression);
         $functionName = "jmespath_{$hash}";
         $filename = "{$dir}/{$functionName}.php";
+        fwrite($out, "File: {$filename}\n\n");
         fprintf($out, file_get_contents($filename));
     }
 

src/Env.php

@@ -18,7 +18,7 @@ final class Env
     private static $runtime;
 
     /**
-     * Returns data from the input array that matches a given JMESPath expression.
+     * Returns data from the input array that matches a JMESPath expression.
      *
      * @param string $expression JMESPath expression to evaluate
      * @param mixed  $data       JSON-like data to search

src/FnDispatcher.php

@@ -460,7 +460,7 @@ private function validate($args, $types = [])
         return true;
     }
 
-    /** @internal */
+    /** @internal Pass function name validation off to runtime */
     public function __call($name, $args)
     {
         $name = str_replace('fn_', '', $name);

src/Lexer.php

@@ -96,6 +96,7 @@ public function tokenize($input)
 
     private function literal($value, $offset, $input)
     {
+        // Handles true, false, null, numbers, quoted strings, "[", and "{"
         static $valid = '/(true|false|null)|(^[\["{])|(^\-?[0-9]*(\.[0-9]+)?([e|E][+|\-][0-9]+)?$)/';
         $value = str_replace('\\`', '`', ltrim(substr($value, 1, -1)));