Merge pull request #13 from Lorti/update

Transition from LightnCandy v0.89 to v0.94

Author: markusjwetzel

composer.json

@@ -13,7 +13,10 @@
     "require": {
         "php": ">=5.4.0",
         "illuminate/view": "5.*",
-        "zordius/lightncandy": "0.89"
+        "zordius/lightncandy": "0.94"
+    },
+    "require-dev": {
+        "orchestra/testbench": "~3.2"
     },
     "autoload": {
         "psr-4": {

config/handlebars.php

@@ -21,11 +21,12 @@
     | File Extensions
     |--------------------------------------------------------------------------
     |
-    | All file extensions that should be compiled with the Handlebars
-    | template engine.
+    | All file extensions that should be compiled with the Handlebars template
+    | engine. Unless you specify your own partial resolver the package will
+    | look for files in Laravel's view storage paths.
     |
     */
-    
+
     'fileext' => [
         '.handlebars',
         '.hbs',
@@ -36,53 +37,24 @@
     | Partials
     |--------------------------------------------------------------------------
     |
-    | LightnCandy supports partial when compile time. You can provide partials
-    | by partials option when compile()
+    | https://github.com/zordius/lightncandy#partial-support
     |
     */
 
     'partials' => [],
+    'partialresolver' => false,
 
     /*
     |--------------------------------------------------------------------------
-    | Custom Helpers
+    | Helpers
     |--------------------------------------------------------------------------
     |
-    | Custom helper can help you deal with common template tasks, for example:
-    | provide URL and text then generate a link. To know more about custom
-    | helper, you can read original handlebars.js document here:
-    | http://handlebarsjs.com/expressions.html . 
+    | https://github.com/zordius/lightncandy#custom-helper
     |
     */
 
     'helpers' => [],
-
-    /*
-    |--------------------------------------------------------------------------
-    | Block Custom Helpers
-    |--------------------------------------------------------------------------
-    |
-    | Block custom helper must be used as a section, the section is started
-    | with {{#helper_name ...}} and ended with {{/helper_name}}.
-    |
-    */
-
-    'blockhelpers' => [],
-
-    /*
-    |--------------------------------------------------------------------------
-    | Handlebars.js' Custom Helpers
-    |--------------------------------------------------------------------------
-    |
-    | You can implement helpers more like Handlebars.js way with hbhelpers
-    | option, all matched single custom helper and block custom helper will be
-    | handled. In Handlebars.js, a block custom helper can rendener child block
-    | by executing options.fn; or change context by send new context as first
-    | parameter.
-    |
-    */
-
-    'hbhelpers' => [],
+    'helperresolver' => false,
 
     /*
     |--------------------------------------------------------------------------

examples/handlebars-example-include.hbs

@@ -0,0 +1,29 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit backupGlobals="false"
+         backupStaticAttributes="false"
+         bootstrap="vendor/autoload.php"
+         colors="true"
+         convertErrorsToExceptions="true"
+         convertNoticesToExceptions="true"
+         convertWarningsToExceptions="true"
+         processIsolation="false"
+         stopOnFailure="false"
+         syntaxCheck="false">
+
+    <testsuites>
+        <testsuite name="Laravel Handlebars">
+            <directory suffix="Test.php">./tests/</directory>
+        </testsuite>
+    </testsuites>
+
+    <php>
+        <env name="APP_ENV" value="testing"/>
+    </php>
+
+    <filter>
+        <whitelist addUncoveredFilesFromWhitelist="false">
+            <directory suffix=".php">src/</directory>
+        </whitelist>
+    </filter>
+
+</phpunit>

examples/handlebars-example.hbs

@@ -3,22 +3,22 @@
 use Illuminate\View\Compilers\BladeCompiler as BaseBladeCompiler;
 use Illuminate\View\Compilers\CompilerInterface;
 
-class BladeCompiler extends BaseBladeCompiler implements CompilerInterface {
+class BladeCompiler extends BaseBladeCompiler implements CompilerInterface
+{
 
     /**
      * Compile the include statements into valid PHP.
      *
-     * @param  string  $expression
+     * @param  string $expression
      * @return string
      */
     protected function compileRaw($expression)
     {
-        if (starts_with($expression, '('))
-        {
+        if (starts_with($expression, '(')) {
             $expression = substr($expression, 1, -1);
         }
 
         return "<?php echo \$__env->make($expression, ['raw' => true], array_except(get_defined_vars(), array('__data', '__path')))->render(); ?>";
     }
 
-}
+}

phpunit.xml

@@ -1,11 +1,13 @@
 <?php namespace ProAI\Handlebars\Compilers;
 
+use Illuminate\Support\Facades\Lang;
 use Illuminate\View\Compilers\Compiler;
 use Illuminate\View\Compilers\CompilerInterface;
 use Illuminate\Filesystem\Filesystem;
 use ProAI\Handlebars\Support\LightnCandy;
 
-class HandlebarsCompiler extends Compiler implements CompilerInterface {
+class HandlebarsCompiler extends Compiler implements CompilerInterface
+{
 
     /**
      * LightnCandy instance.
@@ -38,10 +40,9 @@ class HandlebarsCompiler extends Compiler implements CompilerInterface {
     /**
      * Create a new compiler instance.
      *
-     * @param  \Illuminate\Filesystem\Filesystem  $files
-     * @param  \ProAI\Handlebars\Support\LightnCandy  $lightncandy
-     * @param  string  $cachePath
-     * @return void
+     * @param  \Illuminate\Filesystem\Filesystem     $files
+     * @param  \ProAI\Handlebars\Support\LightnCandy $lightncandy
+     * @param  string                                $cachePath
      */
     public function __construct(Filesystem $files, LightnCandy $lightncandy, $cachePath)
     {
@@ -57,7 +58,9 @@ public function __construct(Filesystem $files, LightnCandy $lightncandy, $cacheP
         $this->options['basedir'] = $app['config']->get('view.paths');
 
         // make sure helpers array is set
-        if ( ! isset($this->options['helpers'])) $this->options['helpers'] = [];
+        if (!isset($this->options['helpers'])) {
+            $this->options['helpers'] = [];
+        }
 
         // set language helpers option
         $this->languageHelpers = (isset($this->options['language_helpers']))
@@ -78,7 +81,7 @@ public function __construct(Filesystem $files, LightnCandy $lightncandy, $cacheP
     /**
      * Compile the view at the given path.
      *
-     * @param  string  $path
+     * @param  string $path
      * @return void
      */
     public function compile($path)
@@ -95,27 +98,24 @@ public function compile($path)
     /**
      * Compile the view at the given path.
      *
-     * @param  string  $path
-     * @param  array  $options
-     * @param  bool  $raw
-     * @return void
+     * @param  string $path
+     * @param  bool   $raw
      */
     public function compileString($path, $raw = false)
     {
         $options = $this->options;
-        
+
         // set partials directory
-        if ( ! $raw) {
+        if (!$raw) {
             $options['basedir'][] = dirname($path);
         }
 
         // set raw option
         array_set($options, 'compile_helpers_only', $raw);
 
         // set language helper functions
-        if($this->languageHelpers)
-        {
-            if ( ! $raw) {
+        if ($this->languageHelpers) {
+            if (!$raw) {
                 $helpers = array_merge($this->getLanguageHelpers(), $options['helpers']);
             } elseif ($this->translateRawOutput) {
                 $helpers = $this->getLanguageHelpers();
@@ -126,26 +126,43 @@ public function compileString($path, $raw = false)
             array_set($options, 'helpers', $helpers);
         }
 
-        // compile with Handlebars compiler
+        // As of LightnCandy v0.91 resolving via `basedir` and `fileext` options has been stripped from LightnCandy.
+        if (!$options['partialresolver']) {
+            $options['partialresolver'] = function ($context, $name) use ($options) {
+                foreach ($options['basedir'] as $dir) {
+                    foreach ($options['fileext'] as $ext) {
+                        $path = sprintf('%s/%s.%s', rtrim($dir, DIRECTORY_SEPARATOR), $name, ltrim($ext, '.'));
+                        if (file_exists($path)) {
+                            return file_get_contents($path);
+                        }
+                    }
+                }
+                return "[Partial $path not found]";
+            };
+        }
+
         $contents = $this->lightncandy->compile($this->files->get($path), $options);
 
-        if ( ! is_null($this->cachePath)) {
-            $this->files->put($this->getCompiledPath($path, $raw), $contents);
+        if (!is_null($this->cachePath)) {
+            // As of LightnCandy v0.90 generated PHP code will not includes `<?php`.
+            $this->files->put($this->getCompiledPath($path, $raw), "<?php $contents");
         }
     }
 
     /**
      * Get the path to the compiled version of a view.
      *
-     * @param  string  $path
-     * @param  bool  $raw
+     * @param  string $path
+     * @param  bool   $raw
      * @return string
      */
     public function getCompiledPath($path, $raw = false)
     {
-        if ($raw) $path .= '-raw';
+        if ($raw) {
+            $path .= '-raw';
+        }
 
-        return $this->cachePath.'/'.md5($path.'-raw');
+        return $this->cachePath . '/' . md5($path . '-raw');
     }
 
     /**
@@ -156,13 +173,13 @@ public function getCompiledPath($path, $raw = false)
     protected function getLanguageHelpers()
     {
         return [
-            'lang' => function($args, $named) {
-                return \Illuminate\Support\Facades\Lang::get($args[0], $named);
+            'lang' => function ($args, $named) {
+                return Lang::get($args[0], $named);
             },
-            'choice' => function($args, $named) {
-                return \Illuminate\Support\Facades\Lang::choice($args[0], $args[1], $named);
+            'choice' => function ($args, $named) {
+                return Lang::choice($args[0], $args[1], $named);
             }
         ];
     }
 
-}
+}

src/Compilers/BladeCompiler.php

@@ -3,13 +3,14 @@
 use Illuminate\View\Engines\EngineInterface;
 use Illuminate\View\Engines\CompilerEngine;
 
-class HandlebarsEngine extends CompilerEngine implements EngineInterface {
+class HandlebarsEngine extends CompilerEngine implements EngineInterface
+{
 
     /**
      * Get the evaluated contents of the view.
      *
-     * @param  string  $path
-     * @param  array   $data
+     * @param  string $path
+     * @param  array  $data
      * @return string
      */
     public function get($path, array $data = array())
@@ -19,8 +20,7 @@ public function get($path, array $data = array())
         // If this given view has expired, which means it has simply been edited since
         // it was last compiled, we will re-compile the views so we can evaluate a
         // fresh copy of the view. We'll pass the compiler the path of the view.
-        if ($this->compiler->isExpired($path))
-        {
+        if ($this->compiler->isExpired($path)) {
             $this->compiler->compile($path);
         }
 
@@ -43,8 +43,8 @@ public function get($path, array $data = array())
     /**
      * Get the evaluated contents of the view at the given path.
      *
-     * @param  string  $__path
-     * @param  array   $__data
+     * @param  string $__path
+     * @param  array  $__data
      * @return string
      */
     protected function evaluatePath($__path, $__data)
@@ -70,4 +70,4 @@ protected function convertObjectToArray($item)
         return $item;
     }
 
-}
+}