Remove option to change runtime class

Author: theodorejb

README.md

@@ -3,12 +3,9 @@ LightnCandy
 
 ⚡🍭 An extremely fast PHP implementation of handlebars ( http://handlebarsjs.com/ ) and mustache ( http://mustache.github.io/ ).
 
-Package on packagist: [![Latest Stable Version](https://poser.pugx.org/zordius/lightncandy/v/stable.svg)](https://packagist.org/packages/zordius/lightncandy) [![License](https://poser.pugx.org/zordius/lightncandy/license.svg)](https://github.com/zordius/lightncandy/blob/master/LICENSE.md) [![Total Downloads](https://poser.pugx.org/zordius/lightncandy/downloads)](https://packagist.org/packages/zordius/lightncandy)
-
 Features
 --------
 
-* Logicless template: mustache ( http://mustache.github.com/ ) or handlebars ( http://handlebarsjs.com/ ) .
 * Compile template to **pure PHP** code. Examples:
    * <a href="https://github.com/zordius/HandlebarsTest/blob/master/fixture/001-simple-vars.tmpl">Template A</a> generated <a href="https://github.com/zordius/HandlebarsTest/blob/master/fixture/001-simple-vars.php">PHP A</a>
    * <a href="https://github.com/zordius/HandlebarsTest/blob/master/fixture/016-hb-eachthis.tmpl">Template B</a> generated <a href="https://github.com/zordius/HandlebarsTest/blob/master/fixture/016-hb-eachthis.php">PHP B</a>
@@ -19,11 +16,8 @@ Features
    * Detail performance test reports can be found <a href="https://github.com/zordius/HandlebarsTest">here</a>, go http://zordius.github.io/HandlebarsTest/ to see charts.
 * **SMALL!** all PHP files in 189K
 * **ROBUST!**
-   * 100% supports <a href="https://github.com/mustache/spec">mustache spec v1.1.3</a>. For the optional lambda module, supports 4 of 10 specs.
    * Supports almost all <a href="https://github.com/jbboehr/handlebars-spec">handlebars.js spec</a>
    * Output <a href="https://github.com/zordius/HandlebarsTest/blob/master/FEATURES.md">SAME</a> with <a href="https://github.com/wycats/handlebars.js">handlebars.js</a>
-* **FLEXIBLE!**
-   * Lot of <a href="#compile-options">options</a> to change features and behaviors.
 * Context generation
    * Analyze used features from your template (execute `LightnCandy::getContext()` to get it) .
 * Debug
@@ -332,46 +326,11 @@ function ($in) {
 
 Please make sure the passed in `renderex` is valid PHP, LightnCandy will not check it.
 
-Customize Rendering Runtime Class
----------------------------------
-
-If you want to extend `LightnCandy\Runtime` class and replace the default runtime library, you may use `runtime` when `compile()` . For example, this sample will generate render function based on your extended `MyRunTime`:
-
-```php
-// Customized runtime library to debug {{{foo}}}
-class MyRunTime extends LightnCandy\Runtime {
-    public static function raw($cx, $v) {
-        return '[[DEBUG:raw()=>' . var_export($v, true) . ']]';
-    }
-}
-
-// Use MyRunTime as runtime library
-$php = LightnCandy::compile($template, array(
-    'runtime' => 'MyRunTime'
-));
-```
-
-Please make sure `MyRunTime` exists when compile().
-
 Unsupported Feature
 -------------------
 
 * `{{foo/bar}}` style variable name, it is deprecated in official handlebars.js document, please use this style: `{{foo.bar}}`.
 
-Suggested Handlebars Template Practices
----------------------------------------
-
-* Prevent to use `{{#with}}` . I think `{{path.to.val}}` is more readable then `{{#with path.to}}{{val}}{{/with}}`; when using `{{#with}}` you will confusing on scope changing. `{{#with}}` only save you very little time when you access many variables under same path, but cost you a lot time when you need to understand then maintain a template.
-* use `{{{val}}}` when you do not require HTML escaped output on the value. It is better performance, too.
-* Prevent to use custom helper if you want to reuse your template in different language. Or, you may need to implement different versions of helper in different languages.
-* For best performance, you should only use 'compile on demand' pattern when you are in development stage. Before you go to production, you can `LightnCandy::compile()` on all your templates, save all generated PHP codes, and deploy these generated files (You may need to maintain a build process for this) . **DO NOT COMPILE ON PRODUCTION** , it also a best practice for security. Adding cache for 'compile on demand' is not the best solution. If you want to build some library or framework based on LightnCandy, think about this scenario.
-* Recompile your templates when you upgrade LightnCandy every time.
-* Persistant ESCAPING practice of `{` or `}` for both handlebars and lightncandy:
-  * If you want to display atomic `}}` , you can just use it without any trick.  EX: `{{foo}}   }}`
-  * If you want to display `}` just after any handlebars token, you can use this: `{{#with "}"}}{{.}}{{/with}}` .  EX: `{{foo}}{{#with "}"}}{{.}}{{/with}}`
-  * If you want to display atomic `{` , you can just use it without any trick. EX: `{ and {{foo}}`.
-  * If you want to display `{{` , you can use `{{#with "{{"}}{{.}}{{/with}}`. EX: `{{#with "{{"}}{{.}}{{/with}}{{foo}}`
-
 Detail Feature list
 -------------------
 
@@ -450,22 +409,3 @@ Go http://handlebarsjs.com/ to see more feature description about handlebars.js.
 * `{{#> @partial-block}}` : access partial block content inside a partial
 * `{{#*inline "partial_name"}}...{{/inline}}` : Inline partial, provide a partial and overwrite the original one.
 * `{{log foo}}` : output value to stderr for debug.
-
-Developer Notes
----------------
-
-Please read <a href=".github/CONTRIBUTING.md">CONTRIBUTING.md</a> for development environment setup.
-
-Framework Integration
----------------------
-
-- [Slim 3.0.x](https://github.com/endel/slim-lightncandy-view)
-- [Laravel 4](https://github.com/samwalshnz/lightncandy-l4)
-- [Laravel 5](https://github.com/ProAI/laravel-handlebars)
-- [yii2](https://github.com/kfreiman/yii2-lightncandy)
-- [Symfony3](https://packagist.org/packages/jays-de/handlebars-bundle)
-
-Tools
------
-
-- CLI: https://github.com/PXLbros/LightnCandy-CLI

src/Compiler.php

@@ -79,12 +79,13 @@ public static function composePHPRender($context, $code)
     {
         $flagProp = Expression::boolString($context['flags']['prop']);
         $flagPartNC = Expression::boolString($context['flags']['partnc']);
+        $runtime = Runtime::class;
 
         $constants = Exporter::constants($context);
         $helpers = Exporter::helpers($context);
         $partials = implode(",\n", $context['partialCode']);
         $debug = Runtime::DEBUG_ERROR_LOG;
-        $use = "use {$context['runtime']} as {$context['runtimealias']};";
+        $use = "use {$runtime} as LR;";
         $stringObject = $context['flags']['prop'] ? Exporter::stringobject($context) : '';
         $safeString = ($context['usedFeature']['enc'] > 0) ? "use {$context['safestring']} as SafeString;" : '';
         // Return generated PHP code string.
@@ -105,7 +106,6 @@ public static function composePHPRender($context, $code)
         'sp_vars' => isset(\$options['data']) ? array_merge(array('root' => \$in), \$options['data']) : array('root' => \$in),
         'blparam' => array(),
         'partialid' => 0,
-        'runtime' => '{$context['runtime']}',
     );
     {$context['renderex']}
     {$context['ops']['array_check']}
@@ -124,9 +124,9 @@ public static function composePHPRender($context, $code)
      *
      * @return string compiled Function name
      *
-     * @expect 'LR::test(' when input array('flags' => array('debug' => 0), 'runtime' => 'Runtime', 'runtimealias' => 'LR'), 'test', ''
-     * @expect 'LL::test2(' when input array('flags' => array('debug' => 0), 'runtime' => 'Runtime', 'runtimealias' => 'LL'), 'test2', ''
-     * @expect 'RR::debug(\'abc\', \'test\', ' when input array('flags' => array('debug' => 1), 'runtime' => 'Runtime', 'runtimealias' => 'RR', 'funcprefix' => 'haha456'), 'test', 'abc'
+     * @expect 'LR::test(' when input array('flags' => array('debug' => 0)), 'test', ''
+     * @expect 'LR::test2(' when input array('flags' => array('debug' => 0)), 'test2', ''
+     * @expect 'LR::debug(\'abc\', \'test\', ' when input array('flags' => array('debug' => 1), 'funcprefix' => 'haha456'), 'test', 'abc'
      */
     protected static function getFuncName(&$context, $name, $tag)
     {
@@ -140,7 +140,7 @@ protected static function getFuncName(&$context, $name, $tag)
             $dbg = '';
         }
 
-        return "{$context['runtimealias']}::$name($dbg";
+        return "LR::$name($dbg";
     }
 
     /**
@@ -227,7 +227,7 @@ protected static function getVariableNameOrSubExpression(&$context, $var)
      * @expect array('((isset($cx[\'scopes\'][count($cx[\'scopes\'])-1]) && is_array($cx[\'scopes\'][count($cx[\'scopes\'])-1]) && isset($cx[\'scopes\'][count($cx[\'scopes\'])-1][\'a\'])) ? $cx[\'scopes\'][count($cx[\'scopes\'])-1][\'a\'] : null)', '../[a]') when input array('flags'=>array('debug'=>0,'prop'=>0)), array(1,'a')
      * @expect array('((isset($cx[\'scopes\'][count($cx[\'scopes\'])-3]) && is_array($cx[\'scopes\'][count($cx[\'scopes\'])-3]) && isset($cx[\'scopes\'][count($cx[\'scopes\'])-3][\'a\'])) ? $cx[\'scopes\'][count($cx[\'scopes\'])-3][\'a\'] : null)', '../../../[a]') when input array('flags'=>array('debug'=>0,'prop'=>0)), array(3,'a')
      * @expect array('(($inary && isset($in[\'id\'])) ? $in[\'id\'] : null)', 'this.[id]') when input array('flags'=>array('debug'=>0,'prop'=>0)), array(null, 'id')
-     * @expect array('LR::v($cx, $in, isset($in) ? $in : null, array(\'id\'))', 'this.[id]') when input array('flags'=>array('prop'=>true,'debug'=>0), 'runtime' => 'Runtime', 'runtimealias' => 'LR'), array(null, 'id')
+     * @expect array('LR::v($cx, $in, isset($in) ? $in : null, array(\'id\'))', 'this.[id]') when input array('flags'=>array('prop'=>true,'debug'=>0)), array(null, 'id')
      */
     protected static function getVariableName(&$context, $var, $lookup = null, $args = null)
     {

src/Context.php

@@ -104,8 +104,6 @@ public static function create($options)
             'helpers' => array(),
             'renderex' => isset($options['renderex']) ? $options['renderex'] : '',
             'prepartial' => (isset($options['prepartial']) && is_callable($options['prepartial'])) ? $options['prepartial'] : false,
-            'runtime' => isset($options['runtime']) ? $options['runtime'] : '\\LightnCandy\\Runtime',
-            'runtimealias' => 'LR',
             'safestring' => '\\LightnCandy\\SafeString',
             'safestringalias' => isset($options['safestring']) ? $options['safestring'] : 'LS',
             'rawblock' => false,

src/Exporter.php

@@ -196,7 +196,7 @@ public static function stringobject($context)
      */
     public static function runtime($context)
     {
-        $class = new \ReflectionClass($context['runtime']);
+        $class = new \ReflectionClass(Runtime::class);
         $ret = '';
         $methods = static::getClassMethods($context, $class);
 

src/Runtime.php

@@ -55,8 +55,8 @@ class Runtime extends Encoder
      * @param string $f runtime function name
      * @param array<string,array|string|integer> $cx render time context for lightncandy
      *
-     * @expect '{{123}}' when input '123', 'miss', array('flags' => array('debug' => Runtime::DEBUG_TAGS), 'runtime' => 'LightnCandy\\Runtime'), ''
-     * @expect '<!--MISSED((-->{{#123}}<!--))--><!--SKIPPED--><!--MISSED((-->{{/123}}<!--))-->' when input '123', 'wi', array('flags' => array('debug' => Runtime::DEBUG_TAGS_HTML), 'runtime' => 'LightnCandy\\Runtime'), false, null, false, function () {return 'A';}
+     * @expect '{{123}}' when input '123', 'miss', array('flags' => array('debug' => Runtime::DEBUG_TAGS)), ''
+     * @expect '<!--MISSED((-->{{#123}}<!--))--><!--SKIPPED--><!--MISSED((-->{{/123}}<!--))-->' when input '123', 'wi', array('flags' => array('debug' => Runtime::DEBUG_TAGS_HTML)), false, null, false, function () {return 'A';}
      */
     public static function debug($v, $f, $cx)
     {
@@ -66,7 +66,8 @@ public static function debug($v, $f, $cx)
         for ($i=2;$i<count($P);$i++) {
             $params[] = &$P[$i];
         }
-        $r = call_user_func_array((isset($cx['funcs'][$f]) ? $cx['funcs'][$f] : "{$cx['runtime']}::$f"), $params);
+        $runtime = self::class;
+        $r = call_user_func_array(($cx['funcs'][$f] ?? "{$runtime}::$f"), $params);
 
         if ($cx['flags']['debug'] & static::DEBUG_TAGS) {
             $ansi = $cx['flags']['debug'] & (static::DEBUG_TAGS_ANSI - static::DEBUG_TAGS);

tests/CompilerTest.php

@@ -15,13 +15,13 @@ public function testOn_getFuncName() {
         $method = new \ReflectionMethod('LightnCandy\Compiler', 'getFuncName');
         $method->setAccessible(true);
         $this->assertEquals('LR::test(', $method->invokeArgs(null, array_by_ref(array(
-            array('flags' => array('debug' => 0), 'runtime' => 'Runtime', 'runtimealias' => 'LR'), 'test', ''
+            array('flags' => array('debug' => 0)), 'test', ''
         ))));
-        $this->assertEquals('LL::test2(', $method->invokeArgs(null, array_by_ref(array(
-            array('flags' => array('debug' => 0), 'runtime' => 'Runtime', 'runtimealias' => 'LL'), 'test2', ''
+        $this->assertEquals('LR::test2(', $method->invokeArgs(null, array_by_ref(array(
+            array('flags' => array('debug' => 0)), 'test2', ''
         ))));
-        $this->assertEquals('RR::debug(\'abc\', \'test\', ', $method->invokeArgs(null, array_by_ref(array(
-            array('flags' => array('debug' => 1), 'runtime' => 'Runtime', 'runtimealias' => 'RR', 'funcprefix' => 'haha456'), 'test', 'abc'
+        $this->assertEquals('LR::debug(\'abc\', \'test\', ', $method->invokeArgs(null, array_by_ref(array(
+            array('flags' => array('debug' => 1), 'funcprefix' => 'haha456'), 'test', 'abc'
         ))));
     }
     public function testOn_getVariableNames() {
@@ -92,7 +92,7 @@ public function testOn_getVariableName() {
             array('flags'=>array('debug'=>0,'prop'=>0)), array(null, 'id')
         ))));
         $this->assertEquals(array('LR::v($cx, $in, isset($in) ? $in : null, array(\'id\'))', 'this.[id]'), $method->invokeArgs(null, array_by_ref(array(
-            array('flags'=>array('prop'=>true,'debug'=>0), 'runtime' => 'Runtime', 'runtimealias' => 'LR'), array(null, 'id')
+            array('flags'=>array('prop'=>true,'debug'=>0)), array(null, 'id')
         ))));
     }
     public function testOn_addUsageCount() {

tests/RuntimeTest.php

@@ -14,10 +14,10 @@ class RuntimeTest extends TestCase
     public function testOn_debug() {
         $method = new \ReflectionMethod('LightnCandy\Runtime', 'debug');
         $this->assertEquals('{{123}}', $method->invokeArgs(null, array_by_ref(array(
-            '123', 'miss', array('flags' => array('debug' => Runtime::DEBUG_TAGS), 'runtime' => 'LightnCandy\\Runtime'), ''
+            '123', 'miss', array('flags' => array('debug' => Runtime::DEBUG_TAGS)), ''
         ))));
         $this->assertEquals('<!--MISSED((-->{{#123}}<!--))--><!--SKIPPED--><!--MISSED((-->{{/123}}<!--))-->', $method->invokeArgs(null, array_by_ref(array(
-            '123', 'wi', array('flags' => array('debug' => Runtime::DEBUG_TAGS_HTML), 'runtime' => 'LightnCandy\\Runtime'), false, null, false, function () {return 'A';}
+            '123', 'wi', array('flags' => array('debug' => Runtime::DEBUG_TAGS_HTML)), false, null, false, function () {return 'A';}
         ))));
     }
     public function testOn_v() {

tests/helpers_for_test.php

@@ -1,12 +1,5 @@
 <?php
 
-// Class for customized Runtime
-class MyLCRunClass extends \LightnCandy\Runtime {
-    public static function raw($cx, $v, $ex = 0) {
-        return '[[DEBUG:raw()=>' . var_export($v, true) . ']]';
-    }
-}
-
 // Classes for inputs or helpers
 class myClass {
     function test() {

tests/regressionTest.php

@@ -631,16 +631,6 @@ public static function issueProvider()
                 'expected' => 'OK!, bar'
             ),
 
-            array(
-                'id' => 150,
-                'template' => '{{{.}}}',
-                'data' => array('hello' => 'world'),
-                'options' => array(
-                    'runtime' => 'MyLCRunClass',
-                ),
-                'expected' => "[[DEBUG:raw()=>array (\n  'hello' => 'world',\n)]]",
-            ),
-
             array(
                 'id' => 153,
                 'template' => '{{echo "test[]"}}',