Implement log helper

Author: jbboehr

Diff for: compat/Options.php

@@ -61,6 +61,11 @@ class Options implements ArrayAccess
     public $contexts;
     public $args;
     public $partial;
+
+    /**
+     * @var Runtime
+     */
+    public $runtime;
 
     /**
      * Constructor

Diff for: composer.json

@@ -27,7 +27,8 @@
     "require" : {
         "php" : ">=5.3.0",
         "ext-handlebars": "0.6.*",
-        "ext-spl" : "*"
+        "ext-spl" : "*",
+        "psr/log": "~1.0.0"
     },
     "require-dev": {
         "jbboehr/coding-standard": "1.0.*@dev",
@@ -40,6 +41,9 @@
         "scrutinizer/ocular": "~1.1",
         "squizlabs/php_codesniffer": "~2.3.2"
     },
+    "suggest": {
+        "ext-psr": "*"
+    },
     "scripts": {
         "test": "phpunit"
     },

Diff for: composer.lock

@@ -122,6 +122,9 @@ private function setupBuiltins()
         if( !isset($this->helpers['helperMissing']) ) {
             $this->helpers['helperMissing'] = new \Handlebars\Helper\HelperMissing();
         }
+        if( !isset($this->helpers['log']) ) {
+            $this->helpers['log'] = new \Handlebars\Helper\Log();
+        }
         if( !isset($this->helpers['lookup']) ) {
             $this->helpers['lookup'] = new \Handlebars\Helper\Lookup();
         }

Diff for: src/Compiler/CompilerImpl.php

@@ -0,0 +1,36 @@
+<?php
+
+namespace Handlebars\Helper;
+
+use Psr\Log\LoggerInterface;
+use Handlebars\Impl;
+use Handlebars\Runtime;
+
+class Log
+{
+    /**
+     * Log builtin
+     *
+     * @return mixed
+     */
+    public function __invoke()
+    {
+        $args = func_get_args();
+        $options = array_pop($args);
+
+        $str = '';
+        foreach( $args as $arg ) {
+            $str .= (is_scalar($arg) ? $arg : print_r($arg, true));
+        }
+
+        $level = isset($options->hash['level']) ? $options->hash['level'] : 'info';
+
+        if( $options->runtime instanceof Runtime &&
+                ($impl = $options->runtime->getImpl()) &&
+                ($logger = $impl->getLogger()) instanceof LoggerInterface ) {
+            $logger->log($level, $str, array());
+        } else {
+            error_log('[handlebars] [' . $level . '] ' . $str);
+        }
+    }
+}

Diff for: src/Helper/Log.php

@@ -54,9 +54,9 @@ class Runtime extends Utils
     protected $options;
 
     /**
-     * @var \Handlebars\Handlebars
+     * @var Impl
      */
-    protected $handlebars;
+    protected $impl;
 
     /**
      * Constructor
@@ -65,7 +65,7 @@ class Runtime extends Utils
      */
     public function __construct(Impl $handlebars)
     {
-        $this->handlebars = $handlebars;
+        $this->impl = $handlebars;
         $this->helpers = $handlebars->getHelpers();
         $this->partials = $handlebars->getPartials();
         $this->decorators = $handlebars->getDecorators();
@@ -138,6 +138,14 @@ public function getPartials()
         return $this->partials;
     }
 
+    /**
+     * @return Impl
+     */
+    public function getImpl()
+    {
+        return $this->impl;
+    }
+
     /**
      * Invoke partial runtime helper
      *
@@ -160,7 +168,7 @@ public function invokePartial($partial, $context, $options)
             if( !$partial ) {
                 $options['partials'][$options['name']] = $this->noop();
             } else if( is_string($partial) ) {
-                $options['partials'][$options['name']] = $this->handlebars->compile($partial, $this->options);
+                $options['partials'][$options['name']] = $this->impl->compile($partial, $this->options);
             }
             $result = call_user_func($options['partials'][$options['name']], $context, $options);
         }
@@ -289,7 +297,9 @@ public function setPartials($partials)
      */
     public function setupOptions(array $options)
     {
-        return new Options($options);
+        $obj = new Options($options);
+        $obj->runtime = $this;
+        return $obj;
     }
 
     private function resolvePartial($partial, &$options)

Diff for: src/Runtime.php

@@ -80,6 +80,9 @@ private function setupBuiltins()
         if( !isset($this->helpers['helperMissing']) ) {
             $this->helpers['helperMissing'] = new \Handlebars\Helper\HelperMissing();
         }
+        if( !isset($this->helpers['log']) ) {
+            $this->helpers['log'] = new \Handlebars\Helper\Log();
+        }
         if( !isset($this->helpers['lookup']) ) {
             $this->helpers['lookup'] = new \Handlebars\Helper\Lookup();
         }

Diff for: src/VM/VMImpl.php

@@ -99,4 +99,26 @@ public function testConsecutiveMultilineComments()
         $actual = trim($handlebars->render($tmpl));
         $this->assertEquals('foo', $actual);
     }
+
+    public function testLog()
+    {
+        $tmpl = '{{log "test"}}';
+        $logger = new MockLogger();
+        $handlebars = new Handlebars();
+        $handlebars->setLogger($logger);
+        $handlebars->render($tmpl);
+        $this->assertEquals('info', $logger->logs[0][0]);
+        $this->assertEquals('test', $logger->logs[0][1]);
+    }
+
+    public function testLogWithNewVM()
+    {
+        $tmpl = '{{log "test"}}';
+        $logger = new MockLogger();
+        $handlebars = new \Handlebars\VM();
+        $handlebars->setLogger($logger);
+        $handlebars->render($tmpl);
+        $this->assertEquals('info', $logger->logs[0][0]);
+        $this->assertEquals('string(test)', $logger->logs[0][1]);
+    }
 }

Diff for: tests/HandlebarsTest.php

@@ -0,0 +1,15 @@
+<?php
+
+namespace Handlebars\Tests;
+
+use Psr\Log\AbstractLogger;
+
+class MockLogger extends AbstractLogger
+{
+    public $logs = array();
+
+    public function log($level, $message, array $context = array())
+    {
+        $this->logs[] = array($level, $message, $context);
+    }
+}