Migrate runtime context to an object

Author: theodorejb

CHANGELOG.md

@@ -1,7 +1,7 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
-## [0.9.0] Modern Cleanup - 2025-03-12
+## [0.9.0] Modern Cleanup - 2025-03-18
 Initial release after forking from LightnCandy 1.2.6.
 
 ### Added

composer.json

@@ -39,7 +39,7 @@
         }
     },
     "scripts": {
-        "analyze": "phpstan analyze src tests --level 1",
+        "analyze": "phpstan analyze",
         "cs-fix": "php-cs-fixer fix -v",
         "test": "vendor/bin/phpunit tests"
     },

phpstan.neon

@@ -0,0 +1,5 @@
+parameters:
+	level: 2
+	paths:
+		- src
+		- tests

src/Compiler.php

@@ -55,6 +55,7 @@ public static function composePHPRender(Context $context, string $code): string
         $runtime = Runtime::class;
         $helperOptions = HelperOptions::class;
         $safeStringClass = SafeString::class;
+        $runtimeContext = RuntimeContext::class;
         $helpers = Exporter::helpers($context);
         $partials = implode(",\n", $context->partialCode);
 
@@ -63,17 +64,18 @@ public static function composePHPRender(Context $context, string $code): string
             use {$runtime} as LR;
             use {$safeStringClass};
             use {$helperOptions};
+            use {$runtimeContext};
             return function (\$in = null, array \$options = []) {
                 \$helpers = $helpers;
                 \$partials = [$partials];
-                \$cx = [
-                    'helpers' => isset(\$options['helpers']) ? array_merge(\$helpers, \$options['helpers']) : \$helpers,
-                    'partials' => isset(\$options['partials']) ? array_merge(\$partials, \$options['partials']) : \$partials,
-                    'scopes' => [],
-                    'sp_vars' => isset(\$options['data']) ? array_merge(['root' => \$in], \$options['data']) : ['root' => \$in],
-                    'blparam' => [],
-                    'partialid' => 0,
-                ];
+                \$cx = new RuntimeContext(
+                    helpers: isset(\$options['helpers']) ? array_merge(\$helpers, \$options['helpers']) : \$helpers,
+                    partials: isset(\$options['partials']) ? array_merge(\$partials, \$options['partials']) : \$partials,
+                    scopes: [],
+                    spVars: isset(\$options['data']) ? array_merge(['root' => \$in], \$options['data']) : ['root' => \$in],
+                    blParam: [],
+                    partialId: 0,
+                );
                 {$context->ops['op_start']}'$code'{$context->ops['op_end']}
             };
             VAREND;
@@ -166,18 +168,18 @@ protected static function getVariableName(Context $context, array $var, ?array $
 
         [$levels, $spvar, $var] = Expression::analyze($var);
         $exp = Expression::toString($levels, $spvar, $var);
-        $base = $spvar ? "\$cx['sp_vars']" : '$in';
+        $base = $spvar ? "\$cx->spVars" : '$in';
 
         // change base when trace to parent
         if ($levels > 0) {
             if ($spvar) {
                 $base .= str_repeat("['_parent']", $levels);
             } else {
-                $base = "\$cx['scopes'][count(\$cx['scopes'])-$levels]";
+                $base = "\$cx->scopes[count(\$cx->scopes)-$levels]";
             }
         }
 
-        if ((empty($var) || (count($var) == 0) || (($var[0] === null) && (count($var) == 1))) && ($lookup === null)) {
+        if ((!$var || ($var[0] === null && count($var) == 1)) && $lookup === null) {
             return [$base, $exp];
         }
 
@@ -295,7 +297,7 @@ public static function inline(Context $context, array $vars): string
     protected static function invertedSection(Context $context, array $vars): string
     {
         $v = static::getVariableName($context, $vars[0]);
-        return "{$context->ops['cnd_start']}(" . static::getFuncName($context, 'isec', '^' . $v[1]) . "\$cx, {$v[0]})){$context->ops['cnd_then']}";
+        return "{$context->ops['cnd_start']}(" . static::getFuncName($context, 'isec', '^' . $v[1]) . "{$v[0]})){$context->ops['cnd_then']}";
     }
 
     /**
@@ -365,11 +367,11 @@ protected static function blockBegin(Context $context, array $vars): string
             case 'if':
                 $includeZero = (isset($vars['includeZero'][1]) && $vars['includeZero'][1]) ? 'true' : 'false';
                 return "{$context->ops['cnd_start']}(" . static::getFuncName($context, 'ifvar', $v[1])
-                    . "\$cx, {$v[0]}, {$includeZero})){$context->ops['cnd_then']}";
+                    . "{$v[0]}, {$includeZero})){$context->ops['cnd_then']}";
             case 'unless':
                 $includeZero = (isset($vars['includeZero'][1]) && $vars['includeZero'][1]) ? 'true' : 'false';
                 return "{$context->ops['cnd_start']}(!" . static::getFuncName($context, 'ifvar', $v[1])
-                    . "\$cx, {$v[0]}, {$includeZero})){$context->ops['cnd_then']}";
+                    . "{$v[0]}, {$includeZero})){$context->ops['cnd_then']}";
             case 'each':
                 return static::section($context, $vars, true);
             case 'with':
@@ -495,7 +497,7 @@ protected static function compileLookup(Context $context, array &$vars, bool $ra
         $sep = $nosep ? '' : $context->ops['separator'];
         $ex = $nosep ? ', 1' : '';
 
-        return $sep . static::getFuncName($context, $raw ? 'raw' : 'encq', $v[1]) . "\$cx, {$v[0]}$ex){$sep}";
+        return $sep . static::getFuncName($context, $raw ? 'raw' : 'encq', $v[1]) . "{$v[0]}$ex){$sep}";
     }
 
     /**
@@ -508,7 +510,7 @@ protected static function compileLookup(Context $context, array &$vars, bool $ra
     protected static function compileOutput(Context $context, string $variable, string $expression, bool $raw): string
     {
         $sep = $context->ops['separator'];
-        return $sep . static::getFuncName($context, $raw ? 'raw' : 'encq', $expression) . "\$cx, $variable)$sep";
+        return $sep . static::getFuncName($context, $raw ? 'raw' : 'encq', $expression) . "$variable)$sep";
     }
 
     /**

src/Encoder.php

@@ -10,24 +10,22 @@ final class Encoder
     /**
      * Get the HTML encoded value of the specified variable.
      *
-     * @param array<string,array|string|int> $cx render time context
      * @param array<array|string|int>|string|int|bool|null $var value to be htmlencoded
      */
-    public static function enc(array $cx, array|string|int|bool|null $var): string
+    public static function enc(array|string|int|bool|null $var): string
     {
-        return htmlspecialchars(Runtime::raw($cx, $var), ENT_QUOTES, 'UTF-8');
+        return htmlspecialchars(Runtime::raw($var), ENT_QUOTES, 'UTF-8');
     }
 
     /**
      * Runtime method for {{var}}, and deal with single quote the same as Handlebars.js.
      *
-     * @param array<string,array|string|int> $cx render time context
      * @param array<array|string|int>|string|int|bool|null $var value to be htmlencoded
      *
      * @return string The htmlencoded value of the specified variable
      */
-    public static function encq(array $cx, array|string|int|bool|null $var)
+    public static function encq(array|string|int|bool|null $var)
     {
-        return str_replace(['=', '`', '&#039;'], ['&#x3D;', '&#x60;', '&#x27;'], self::enc($cx, $var));
+        return str_replace(['=', '`', '&#039;'], ['&#x3D;', '&#x60;', '&#x27;'], self::enc($var));
     }
 }