micromustache - npm Package Compare versions

Comparing version 4.0.0 to 4.1.1

bower.json

 {
   "name": "micromustache",
-  "version": "4.0.0",
+  "version": "4.1.1",
   "homepage": "https://github.com/userpixel/micromustache",
@@ -5,0 +5,0 @@ "description": "A faster and smaller subimplementation of the {{mustache}} template engine for JavaScript",

browser/micromustache.js

@@ -1,117 +0,152 @@
-(function(f) {
-  if (typeof exports === "object" && typeof module !== "undefined") {
-    module.exports = f()
-  } else if (typeof define === "function" && define.amd) {
-    define([], f)
-  } else {
-    var g;
-    if (typeof window !== "undefined") {
-      g = window
-    } else if (typeof global !== "undefined") {
-      g = global
-    } else if (typeof self !== "undefined") {
-      g = self
-    } else {
-      g = this
-    }
-    g.micromustache = f()
-  }
-})(function() {
-  var define, module, exports;
-  module = {
-    exports: (exports = {})
-  };
-  /**
-   * Replaces every {{variable}} inside the template with values provided by view
-   * If the value is a function, call it passing the name of the variable as the only argument.
-   *
-   * @param template {string} the template containing one or more {{variableNames}}
-   * @param [view={}] {object} an optional object containing values for every variable names
-   *        that is used in the template
-   * @return {string} template where its variable names replaced with corresponding values.
-   *        If a value is not found or is invalid, it will be assumed empty string ''.
-   *        If the value is an object itself, it'll be stringified by JSON. In case of a JSON error the result will look like "{JSON_ERROR: ... }".
-   */
-  function render(template, view) {
-    //don't touch the template if it is not a string
-    if (typeof template !== 'string') {
-      return template;
-    }
-    //if view is not a valid object, assume it is an empty object
-    //which effectively removes all variable interpolations
-    if (typeof view !== 'object' || view === null) {
-      view = {};
-    }
-    return template.replace(/\{\{\s*(.*?)\s*\}\}/g, function(match, varName) {
-      var path = varName.split('.');
+(function(f){if(typeof exports==="object"&&typeof module!=="undefined"){module.exports=f()}else if(typeof define==="function"&&define.amd){define([],f)}else{var g;if(typeof window!=="undefined"){g=window}else if(typeof global!=="undefined"){g=global}else if(typeof self!=="undefined"){g=self}else{g=this}g.micromustache = f()}})(function(){var define,module,exports;module={exports:(exports={})};
+/**
+ * @callback GeneralValueFn
+ *
+ * @param {string} key - variable name before being parsed.
+ *        For example: {a.b.c} ->  'a.b.c', {  x  } -> 'x'
+ * @returns {string|number|boolean|Object|undefined} the value to be
+ *        interpolated. If the function returns undefined, the value resolution
+ *        algorithm will go ahead with the default behaviour (resolving the
+ *        variable name from the provided object).
+ */
 
-      function resolve(currentScope, pathIndex) {
-        if (currentScope === null) {
-          return '';
-        }
-        var key = path[pathIndex];
-        var value = currentScope[key];
-        var typeofValue = typeof value;
-        if (typeofValue === 'function') {
-          //if the value is a function, call it passing the variable name
-          return valueFnResultToString(value.call(view, key, currentScope,
-            path, pathIndex));
-        } else if (typeofValue === 'object') {
-          pathIndex++;
-          // If it's a leaf and still an object, just stringify it
-          return pathIndex < path.length ? resolve(value, pathIndex) :
-            valueFnResultToString(value);
-        } else {
-          return valueFnResultToString(value);
-        }
-      }
+ /**
+ * @callback ValueFn
+ *
+ * @param {string} key - variable name for the current scope.
+ *        For hierarchical names like {{a.b.c}} the key can be 'a' or 'b' or 'c'
+ * @param {Object} currentScope - the current object that the variable is
+ *        supposed to resolved from
+ * @param {string[]} path - useful for hierarchical objects.
+ *        for example a variable name like {{a.b.c}} sets the
+ *        path to ['a', 'b', 'c']
+ * @param {number} currentPointer - the array index to where in the path we are
+ *        at the moment. This is usually path.length - 1
+ * @returns {string|number|boolean|Object} the value to be interpolated
+ */
 
-      return resolve(view, 0);
-    });
+/**
+ * Replaces every {{variable}} inside the template with values provided by view
+ * If the value is a function, call it passing the name of the variable as the
+ * only argument.
+ *
+ * @param {string} template - the template containing one or
+ *        more {{variableNames}}
+ * @param {Object} [view={}] - an optional object containing values for
+ *        every variable names that is used in the template. If it's omitted,
+ *        it'll be assumed an empty object.
+ * @param {GeneralValueFn} [generalValueFn] - an optional function that will be
+ *        called for every key to generate a value. If the result is undefined
+ *        we'll proceed with the default value resolution algorithm.
+ *        This function runs in the context of view.
+ * @returns {string} - template where its variable names replaced with
+ *        corresponding values. If a value is not found or is invalid, it will
+ *        be assumed empty string ''. If the value is an object itself, it'll
+ *        be stringified by JSON.
+ *        In case of a JSON error the result will look like "{...}".
+ */
+function render (template, view, generalValueFn) {
+  //don't touch the template if it is not a string
+  if (typeof template !== 'string') {
+    return template;
   }
 
-  /**
-   * This function makes repeated calls shorter by returning a compiler function
-   * for a particular template that accepts data and returnes the rendered string.
-   * It doesn't make the code faster since the compiler still uses render internally.
-   *
-   * @param template {string} same as the template parameter to render()
-   * @return compiler(view) {function} a function that accepts a view and returns a rendered template
-   */
-  function compile(template) {
-    //create and return a function that will always apply this template under the hood
-    return function compiler(view) {
-      return render(template, view);
-    };
+  // if view is omitted but generalValueFn is set
+  if (typeof view === 'function' && typeof generalValueFn === 'undefined') {
+    generalValueFn = view;
   }
 
-  function valueFnResultToString(value) {
-    switch (typeof value) {
-      case 'string':
-      case 'number':
-      case 'boolean':
-        return value;
-      case 'object':
-        // null is an object but is falsy. Swallow null
-        return value ? toJsonPolitely(value) : '';
-      default:
-        // Anything else will be replaced with an empty string
-        // For example: undefined, date, regexp, etc).
+  //if view is not a valid object, assume it is an empty object
+  //which effectively removes all variable interpolations
+  if (typeof view !== 'object' || view === null) {
+    view = {};
+  }
+
+  return template.replace(/\{\{\s*(.*?)\s*\}\}/g, function (match, varName) {
+    if (generalValueFn) {
+      var generalValueFnResult = generalValueFn(view, varName);
+      if (typeof generalValueFnResult !== 'undefined') {
+        return valueFnResultToString(generalValueFnResult);
+      }
+    }
+
+    var path = varName.split('.');
+
+    function resolve (currentScope, pathIndex) {
+      if (currentScope === null) {
         return '';
+      }
+
+      var key = path[pathIndex];
+      var value = currentScope[key];
+      var typeofValue = typeof value;
+
+      if (typeofValue === 'function') {
+        //if the value is a function, call it passing the variable name
+        return valueFnResultToString(
+          value.call(view, key, currentScope, path, pathIndex)
+        );
+      } else if (typeofValue === 'object') {
+        pathIndex++;
+        // If it's a leaf and still an object, just stringify it
+        return pathIndex < path.length ?
+          resolve(value, pathIndex) :
+          valueFnResultToString(value);
+      } else {
+        return valueFnResultToString(value);
+      }
     }
-  }
 
-  // Converts an object to json without throwing
-  function toJsonPolitely(obj) {
-    try {
-      return JSON.stringify(obj);
-    } catch (jsonError) {
-      return '{...}';
-    }
+    return resolve(view, 0);
+  });
+}
+
+/**
+ * This function makes repeated calls shorter by returning a compiler function
+ * for a particular template that accepts data and returnes the rendered string.
+ * It doesn't make the code faster since the compiler still uses render
+ * internally.
+ *
+ * @param {string} template - same as the template parameter to .render()
+ * @param {GeneralValueFn} [generalValueFn] - same as the parameter to .render()
+ * @returns {function} - a function that accepts a view object and returns a
+ *        rendered template string template
+ */
+function compile (template, generalValueFn) {
+  // Create and return a function that will always apply this template
+  // and generalValueFn under the hood
+  return function compiler (view) {
+    return render (template, view, generalValueFn);
+  };
+}
+
+function valueFnResultToString (value) {
+  switch (typeof value) {
+    case 'string':
+    case 'number':
+    case 'boolean':
+      return value;
+    case 'object':
+      // null is an object but is falsy. Swallow null
+      if (value === null) {
+        return '';
+      } else {
+        // Convert the object to json without throwing
+        try {
+          return JSON.stringify(value);
+        } catch (jsonError) {
+          return '{...}';
+        }
+      }
+      return value ? toJsonPolitely(value) : '';
+    default:
+      // Anything else will be replaced with an empty string
+      // For example: undefined, Symbol, etc.
+      return '';
   }
+}
 
-  exports.to_html = exports.render = render;
-  exports.compile = compile;
+exports.to_html = exports.render = render;
+exports.compile = compile;
 
-  return module.exports;
-});
+return module.exports;});

browser/micromustache.min.js

@@ -1,1 +0,1 @@
-!function(e){if("object"==typeof exports&&"undefined"!=typeof module)module.exports=e();else if("function"==typeof define&&define.amd)define([],e);else{var n;n="undefined"!=typeof window?window:"undefined"!=typeof global?global:"undefined"!=typeof self?self:this,n.micromustache=e()}}(function(){function e(e,n){return"string"!=typeof e?e:("object"==typeof n&&null!==n||(n={}),e.replace(/\{\{\s*(.*?)\s*\}\}/g,function(e,r){function o(e,r){if(null===e)return"";var u=f[r],i=e[u],c=typeof i;return"function"===c?t(i.call(n,u,e,f,r)):"object"===c?(r++,r<f.length?o(i,r):t(i)):t(i)}var f=r.split(".");return o(n,0)}))}function n(n){return function(t){return e(n,t)}}function t(e){switch(typeof e){case"string":case"number":case"boolean":return e;case"object":return e?r(e):"";default:return""}}function r(e){try{return JSON.stringify(e)}catch(e){return"{...}"}}var o,f;return o={exports:f={}},f.to_html=f.render=e,f.compile=n,o.exports});
+!function(e){if("object"==typeof exports&&"undefined"!=typeof module)module.exports=e();else if("function"==typeof define&&define.amd)define([],e);else{var n;n="undefined"!=typeof window?window:"undefined"!=typeof global?global:"undefined"!=typeof self?self:this,n.micromustache=e()}}(function(){function e(e,n,o){return"string"!=typeof e?e:("function"==typeof n&&"undefined"==typeof o&&(o=n),"object"==typeof n&&null!==n||(n={}),e.replace(/\{\{\s*(.*?)\s*\}\}/g,function(e,r){function f(e,o){if(null===e)return"";var r=i[o],u=e[r],c=typeof u;return"function"===c?t(u.call(n,r,e,i,o)):"object"===c?(o++,o<i.length?f(u,o):t(u)):t(u)}if(o){var u=o(n,r);if("undefined"!=typeof u)return t(u)}var i=r.split(".");return f(n,0)}))}function n(n,t){return function(o){return e(n,o,t)}}function t(e){switch(typeof e){case"string":case"number":case"boolean":return e;case"object":if(null===e)return"";try{return JSON.stringify(e)}catch(e){return"{...}"}return e?toJsonPolitely(e):"";default:return""}}var o,r;return o={exports:r={}},r.to_html=r.render=e,r.compile=n,o.exports});

package.json

 {
   "name": "micromustache",
-  "version": "4.0.0",
+  "version": "4.1.1",
   "description": "A faster and smaller subimplementation of the {{mustache}} template engine for JavaScript",
@@ -5,0 +5,0 @@ "keywords": [

No alert changes

Improved metrics

Total package byte prevSize

80168

increased by2.57%

Number of package files

11

increased by10%

Lines of code

296

increased by10.86%

No dependency changes