Allow to customize helpers

Author: kylekatarnls

src/JsPhpize/Compiler/Compiler.php

@@ -79,8 +79,19 @@ public function compileDependencies($dependencies)
         $varPrefix = $this->varPrefix;
 
         return implode('', array_map(function ($name) use ($varPrefix) {
+            $code = $name;
+            $file = $name;
+
+            if (preg_match('/^[a-z0-9_-]+$/', $file)) {
+                $file = __DIR__ . '/Helpers/' . ucfirst($name) . '.h';
+            }
+
+            if (file_exists($file)) {
+                $code = file_get_contents($file);
+            }
+
             return '$GLOBALS[\'' . $varPrefix . $name . '\'] = ' .
-                trim(file_get_contents(__DIR__ . '/Helpers/' . ucfirst($name) . '.h')) .
+                trim($code) .
                 ";\n";
         }, $dependencies));
     }
@@ -159,7 +170,9 @@ protected function visitDyiade(Dyiade $dyiade, $indent)
                 $arguments[] = $this->visitNode($dyiade->rightHand, $indent);
             }
 
-            return $this->helperWrap('plus', $arguments);
+            $plus = $this->engine->getHelperName('plus');
+
+            return $this->helperWrap($plus, $arguments);
         }
 
         return $leftHand . ' ' . $dyiade->operator . ' ' . $rightHand;
@@ -292,7 +305,8 @@ protected function visitFunctionCall(FunctionCall $functionCall, $indent)
         if (count($functionCall->children)) {
             $arguments = $this->mapNodesArray($functionCall->children, $indent);
             array_unshift($arguments, $dynamicCall);
-            $dynamicCall = $this->helperWrap('dot', $arguments);
+            $dot = $this->engine->getHelperName('dot');
+            $dynamicCall = $this->helperWrap($dot, $arguments);
         }
 
         return $dynamicCall;
@@ -357,7 +371,8 @@ protected function visitVariable(Variable $variable, $indent)
         if (count($variable->children)) {
             $arguments = $this->mapNodesArray($variable->children, $indent);
             array_unshift($arguments, $php);
-            $php = $this->helperWrap('dot', $arguments);
+            $dot = $this->engine->getHelperName('dot');
+            $php = $this->helperWrap($dot, $arguments);
         }
 
         return $php;

src/JsPhpize/Compiler/Helpers/DotObject.h

@@ -0,0 +1,64 @@
+function ($base) {
+    $getFromArray = function ($base, $key) {
+        return isset($base[$key])
+            ? $base[$key]
+            : null;
+    };
+    $getCallable = function ($base, $key) use ($getFromArray) {
+        if (is_callable(array($base, $key))) {
+            return array($base, $key);
+        }
+        if ($base instanceof \ArrayAccess) {
+            return $getFromArray($base, $key);
+        }
+    };
+    $fallbackDot = function ($base, $key) use ($getCallable) {
+        if (is_string($base)) {
+            if ($key === 'substr' || $key === 'slice') {
+                return function ($start, $length = null) use ($base) {
+                    return func_num_args() === 1 ? substr($base, $start) : substr($base, $start, $length);
+                };
+            }
+            if ($key === 'charAt') {
+                return function ($pos) use ($base) {
+                    return substr($base, $pos, 1);
+                };
+            }
+            if ($key === 'indexOf') {
+                return function ($needle) use ($base) {
+                    $pos = strpos($base, $needle);
+
+                    return $pos === false ? -1 : $pos;
+                };
+            }
+            if ($key === 'toUpperCase') {
+                return function () use ($base) {
+                    return strtoupper($base);
+                };
+            }
+            if ($key === 'toLowerCase') {
+                return function () use ($base) {
+                    return strtolower($base);
+                };
+            }
+        }
+
+        return $getCallable($base, $key);
+    };
+    foreach (array_slice(func_get_args(), 1) as $key) {
+        $base = is_array($base)
+            ? $getFromArray($base, $key)
+            : (is_object($base)
+                ? (method_exists($base, $method = "get" . ucfirst($key))
+                    ? $base->$method()
+                    : (method_exists($base, $key)
+                        ? array($base, $key)
+                        : $base->$key
+                    )
+                )
+                : $fallbackDot($base, $key)
+            );
+    }
+
+    return $base;
+}

src/JsPhpize/JsPhpizeOptions.php

@@ -100,6 +100,21 @@ public function getVarPrefix()
         return $this->getOption('varPrefix', static::VAR_PREFIX);
     }
 
+    /**
+     * Retrieve the prefix of specific variables.
+     *
+     * @return string
+     */
+    public function getHelperName($key)
+    {
+        $helpers = $this->getOption('helpers', []);
+
+        return is_array($helpers) && isset($helpers[$key])
+            ? $helpers[$key]
+            : $key;
+    }
+
+
     /**
      * Retrieve the prefix of specific constants.
      *

tests/Plus.h

@@ -0,0 +1,7 @@
+function ($base) {
+    foreach (array_slice(func_get_args(), 1) as $value) {
+        $base = $base * $value;
+    }
+
+    return $base;
+}

tests/dotHelper.php

@@ -163,4 +163,34 @@ public function testArrayAccess()
         $this->assertSame('bar', $dotHelper($object, 'foo'));
         $this->assertSame(null, $dotHelper($object, 'biz'));
     }
+
+    public function testCustomHelper()
+    {
+        $plusHelper = 'function ($base) {
+            foreach (array_slice(func_get_args(), 1) as $value) {
+                $base = $base * $value;
+            }
+        
+            return $base;
+        }';
+        $jsPhpize = new JsPhpize(array(
+            'helpers' => array(
+                'plus' => $plusHelper,
+            ),
+            'returnLastStatement' => true,
+        ));
+
+        $this->assertEquals(18, $jsPhpize->render('3 + 6'));
+
+        $jsPhpize = new JsPhpize(array(
+            'helpers' => array(
+                'dot' => 'plus',
+            ),
+            'returnLastStatement' => true,
+        ));
+
+        $this->assertEquals('xb', $jsPhpize->render('a.b', array(
+            'a' => 'x',
+        )));
+    }
 }