mustache.js/mustache.js

/*
  mustache.js — Logic-less templates in JavaScript

  See http://mustache.github.com/ for more info.
  
  Rewrite as parser by Nathan Vander Wilt, 2010 May 22
*/

var Mustache = function() {
  // `sender` is a function to buffer or stream parsed chunks
  var Renderer = function(sender) {
    this.send = sender;
  };

  Renderer.prototype = {
    otag: "{{",
    ctag: "}}",
    pragmas_implemented: {
      "IMPLICIT-ITERATOR": true
    },
    
    // state created per-instance to avoid sharing
    pragmas: null,
    
    // the main parser (return value for internal use only)
    render: function(template, context, partials) {
      //console.log("Context", context);
      this.pragmas = {};
      var tokens = this.splitTemplate(template);
      //console.log("Tokens", tokens);
      var tree = this.formTree(tokens);
      //console.log("Tree", tree);
      this.renderTree(tree, context, partials, template);
    },
    
    // returns {tag, start, end} or nothing
    findToken: function(template, startPos) {
      var tokenStart = template.indexOf(this.otag, startPos);
      if (tokenStart == -1) return;
      var tokenEnd = template.indexOf(this.ctag, tokenStart + this.otag.length);
      if (tokenEnd == -1) {
        var context = template.substr(tokenStart, 15);
        throw new Error("Unclosed token '" + context + "...'.");
      }
      
      var tokenInnards = template.slice(tokenStart + this.otag.length, tokenEnd);
      var tokenParts = tokenInnards.match(/([=%!{&>#^\/])?\s*(.+?)\s*\1?$/);
      var token = {
        "operator": tokenParts[1],
        "tag": tokenParts[2],
        "text": this.otag + tokenInnards + this.ctag,
        "start": tokenStart,
        "end": tokenEnd + this.ctag.length
      };
      if (token.operator == "{" && template[token.end] == "}") {
        // adjust for symmetrical unescaped tag with default delimiters
        token.end += 1;
      }
      return token;
    },
    
    splitTemplate: function(template) {
      var tokens = [];
      var token;
      var parsePosition = 0;
      while (token = this.findToken(template, parsePosition)) {
        var text = template.slice(parsePosition, token.start);
        tokens.push({"text": text, "start": parsePosition, "end": token.start});
        tokens.push(token);
        parsePosition = token.end;
        
        if (token.operator == "=") {
          // set new delimiters
          var delimiters = token.tag.split(" ");
          this.otag = delimiters[0];
          this.ctag = delimiters[1];
        } else if (token.operator == "%") {
          // store pragma
          var pragmaInfo = token.tag.match(/([\w_-]+) ?([\w]+=[\w]+)?/);
          var pragma = pragmaInfo[1];
          if (!this.pragmas_implemented[pragma]) {
            throw new Error("This mustache implementation doesn't understand the '" +
                            pragma + "' pragma");
          }
          var options = {}
          var optionStr = pragmaInfo[2];
          if (optionStr) {
            var opts = optionStr.split("=");
            options[opts[0]] = opts[1];
          }
          this.pragmas[pragma] = options;
        }
      }
      var finalText = template.slice(parsePosition, template.length);
      tokens.push({"text": finalText, "start": parsePosition, "end": template.length});
      return tokens;
    },
    
    // NOTE: empties tokens parameter and modifies its former subobjects
    formTree: function(tokens, section) {
      var tree = [];
      var token;
      while (token = tokens.shift()) {
        if (token.start == token.end) {
          // drop empty tokens
          continue;
        } else if (token.tag) {
          if (token.operator == "#" || token.operator == "^") {
            token.section = true;
            token.invert = (token.operator ==  "^");
            token.tree = this.formTree(tokens, token.tag);
          } else if (token.operator == "/") {
            if (token.tag != section) {
              throw new Error("Badly nested section '" + section + "'" +
                              " (left via '" + token.tag +"').");
            }
            break;
          } else if (token.operator == ">") {
            token.partial = true;
          } else if (token.operator == "{" || token.operator == "&") {
            token.noEscape = true;
          }
        }
        tree.push(token);
      }
      return tree;
    },
    
    renderTree: function(tree, context, partials, template) {
      for (var i = 0, len = tree.length; i < len; ++i) {
        var item = tree[i];
        if (item.section) {
          var iterator = this.valueIterator(item.tag, context);
          var value;
          if (item.invert) {
            value = iterator();
            if (!value) {
              this.renderTree(item.tree, context, partials, template);
            }
          } else while (value = iterator()) {
            if (value instanceof Function) {
              var subtree = item.tree;
              var lastSubitem = subtree[subtree.length-1];
              var subtext = template.slice(item.end, lastSubitem && lastSubitem.end);
              var renderer = function(text) {
                return Mustache.to_html(text, context, partials);
              }
              var lambdaResult = value.call(context, subtext, renderer);
              if (lambdaResult) {
                this.send(lambdaResult);
              }
            } else {
              var subContext = this.mergedCopy(context, value);
              this.renderTree(item.tree, subContext, partials, template);
            }
          }
        } else if (item.partial) {
          var subTemplate = partials[item.tag];
          if (!subTemplate) {
            throw new Error("Unknown partial '" + item.tag + "'");
          }
          this.render(subTemplate, context, partials);
          // TODO: below matches @janl's mustache, but not mustache(5)
          /*
          var subContext = context[item.tag];
          if (typeof(subContext) == "object") {
            this.render(subTemplate, subContext, partials);
          } else {
            this.send(subTemplate);
          }
          */
        } else if (item.operator && !item.noEscape) {
          // ignore other operators
        } else if (item.tag) {
          var rawValue = this.lookupValue(item.tag, context);
          if (rawValue) {
            var value = rawValue.toString();
            this.send((item.noEscape) ? value : this.escapeHTML(value));
          }
        } else {
          this.send(item.text);
        }
      }
    },
    
    // find `name` value in current view `context`
    lookupValue: function(name, context) {
      var value = context[name];
      // evaluate plain-function value (only once)
      if (value instanceof Function && !value.iterator) {
        value = value.apply(context);
      }
      // silently ignore unkown variables
      if (!value) {
        value = "";
      }
      return value;
    },
    
    objectValue: function(value, context) {
      if (value instanceof Function) {
        return value;
      }
      
      var obj = (value != null) ? {} : null;
      if (Object.prototype.toString.call(value) == '[object Object]') {
        obj = value;
      } else if(this.pragmas["IMPLICIT-ITERATOR"]) {
        // original credit to @langalex, support for arrays of strings
        var iteratorKey = this.pragmas["IMPLICIT-ITERATOR"].iterator || ".";
        obj[iteratorKey] = value;
      }
      return obj;
    },
    
    // always returns iterator function returning object/null
    valueIterator: function(name, context) {
      var value = this.lookupValue(name, context);
      var me = this;
      if (!value) {
        return function(){};
      } else if (value instanceof Function && value.iterator) {
        return value;
      } else if (value instanceof Array) {
        var i = 0;
        var l = value.length;
        return function() {
          return (i < l) ? me.objectValue(value[i++], context) : null;
        }
      } else {
        return function() {
          var v = value;
          value = null;
          return me.objectValue(v, context);
        };
      }
    },
    
    // copies contents of `b` over copy of `a`
    mergedCopy: function(a, b) {
      var copy = {};
      for (var key in a) if (a.hasOwnProperty(key)) {
        copy[key] = a[key];
      }
      for (var key in b) if (b.hasOwnProperty(key)) {
        copy[key] = b[key];
      }
      return copy;
    },
    
    // converts special HTML characters
    escapeHTML: function(s) {
      var htmlCharsRE = new RegExp("&(?!\\w+;)|[\"<>\\\\]", "g");
      return s.replace(htmlCharsRE, function(c) {
        switch(c) {
          case "&": return "&amp;";
          case "\\": return "\\\\";
          case '"': return '\"';
          case "<": return "&lt;";
          case ">": return "&gt;";
          default: return c;
        }
      });
    }
  };

  return({
    name: "mustache.js",
    version: "0.4.0-dev",
    
    // wrap internal render function
    to_html: function(template, view, partials, sender) {
      var buffer = [];
      var renderSender = sender || function(chunk) {
        if (chunk.length) {
          buffer.push(chunk);
        }
      }
      var renderer = new Renderer(renderSender);
      
      renderer.render(template, view, partials);
      
      if (!sender) {
        return buffer.join("");
      }
    }
  });
}();