L-electron-Rare/moodle
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

MDL-50150 Mustache: Add "BLOCKS" feature to javascript mustache engine.

Browse Source 
Pull request: https://github.com/janl/mustache.js/pull/473
This commit is contained in:
Damyon Wiese
2015-08-20 11:44:49 +08:00
committed by David Monllao
parent 3ac1350598
commit 841e689a1c
3 changed files with 260 additions and 138 deletions
Download Patch File Download Diff File Expand all files Collapse all files
lib/amd/build/mustache.min.js
Vendored
+1 -1
View File
File diff suppressed because one or more lines are too long
lib/amd/src/mustache.js
+258 -136
View File
@@ -24,62 +24,83 @@
//
// Description of import into Moodle:
// Download from https://github.com/janl/mustache.js/releases
// Checkout from https://github.com/moodle/custom-mustache.js
// Rebase onto latest release tag from https://github.com/janl/mustache.js
// Copy mustache.js into lib/amd/src/ in Moodle folder.
// Add the license as a comment to the file and these instructions.
// Add jshint tags so this file is not linted.
// Remove the "global define:" comment (hint for linter)
/*!
* mustache.js - Logic-less {{mustache}} templates with JavaScript
* http://github.com/janl/mustache.js
*/
/* jshint ignore:start */
(function (global, factory) {
if (typeof exports === "object" && exports) {
(function defineMustache (global, factory) {
if (typeof exports === 'object' && exports && typeof exports.nodeName !== 'string') {
factory(exports); // CommonJS
} else if (typeof define === "function" && define.amd) {
} else if (typeof define === 'function' && define.amd) {
define(['exports'], factory); // AMD
} else {
factory(global.Mustache = {}); // <script>
global.Mustache = {};
factory(Mustache); // script, wsh, asp
}
}(this, function (mustache) {
}(this, function mustacheFactory (mustache) {
var Object_toString = Object.prototype.toString;
var isArray = Array.isArray || function (object) {
return Object_toString.call(object) === '[object Array]';
var objectToString = Object.prototype.toString;
var isArray = Array.isArray || function isArrayPolyfill (object) {
return objectToString.call(object) === '[object Array]';
};
function isFunction(object) {
function isFunction (object) {
return typeof object === 'function';
}
function escapeRegExp(string) {
return string.replace(/[\-\[\]{}()*+?.,\\\^$|#\s]/g, "\\$&");
/**
* More correct typeof string handling array
* which normally returns typeof 'object'
*/
function typeStr (obj) {
return isArray(obj) ? 'array' : typeof obj;
}
function escapeRegExp (string) {
return string.replace(/[\-\[\]{}()*+?.,\\\^$|#\s]/g, '\\$&');
}
/**
* Null safe way of checking whether or not an object,
* including its prototype, has a given property
*/
function hasProperty (obj, propName) {
return obj != null && typeof obj === 'object' && (propName in obj);
}
// Workaround for https://issues.apache.org/jira/browse/COUCHDB-577
// See https://github.com/janl/mustache.js/issues/189
var RegExp_test = RegExp.prototype.test;
function testRegExp(re, string) {
return RegExp_test.call(re, string);
var regExpTest = RegExp.prototype.test;
function testRegExp (re, string) {
return regExpTest.call(re, string);
}
var nonSpaceRe = /\S/;
function isWhitespace(string) {
function isWhitespace (string) {
return !testRegExp(nonSpaceRe, string);
}
var entityMap = {
"&": "&amp;",
"<": "&lt;",
">": "&gt;",
'&': '&amp;',
'<': '&lt;',
'>': '&gt;',
'"': '&quot;',
"'": '&#39;',
"/": '&#x2F;'
'/': '&#x2F;'
};
function escapeHtml(string) {
return String(string).replace(/[&<>"'\/]/g, function (s) {
function escapeHtml (string) {
return String(string).replace(/[&<>"'\/]/g, function fromEntityMap (s) {
return entityMap[s];
});
}
@@ -88,7 +109,7 @@
var spaceRe = /\s+/;
var equalsRe = /\s*=/;
var curlyRe = /\s*\}/;
var tagRe = /#|\^|\/|>|\{|&|=|!/;
var tagRe = /#|\^|\/|>|\{|&|=|!|\$|</;
/**
* Breaks up the given `template` string into a tree of tokens. If the `tags`
@@ -112,7 +133,7 @@
* array of tokens in the subtree and 2) the index in the original template at
* which the closing tag for that section begins.
*/
function parseTemplate(template, tags) {
function parseTemplate (template, tags) {
if (!template)
return [];
@@ -124,7 +145,7 @@
// Strips all whitespace tokens array for the current line
// if there was a {{#tag}} on it and otherwise only space.
function stripSpace() {
function stripSpace () {
if (hasTag && !nonSpace) {
while (spaces.length)
delete tokens[spaces.pop()];
@@ -137,16 +158,16 @@
}
var openingTagRe, closingTagRe, closingCurlyRe;
function compileTags(tags) {
if (typeof tags === 'string')
tags = tags.split(spaceRe, 2);
function compileTags (tagsToCompile) {
if (typeof tagsToCompile === 'string')
tagsToCompile = tagsToCompile.split(spaceRe, 2);
if (!isArray(tags) || tags.length !== 2)
throw new Error('Invalid tags: ' + tags);
if (!isArray(tagsToCompile) || tagsToCompile.length !== 2)
throw new Error('Invalid tags: ' + tagsToCompile);
openingTagRe = new RegExp(escapeRegExp(tags[0]) + '\\s*');
closingTagRe = new RegExp('\\s*' + escapeRegExp(tags[1]));
closingCurlyRe = new RegExp('\\s*' + escapeRegExp('}' + tags[1]));
openingTagRe = new RegExp(escapeRegExp(tagsToCompile[0]) + '\\s*');
closingTagRe = new RegExp('\\s*' + escapeRegExp(tagsToCompile[1]));
closingCurlyRe = new RegExp('\\s*' + escapeRegExp('}' + tagsToCompile[1]));
}
compileTags(tags || mustache.tags);
@@ -210,7 +231,7 @@
token = [ type, value, start, scanner.pos ];
tokens.push(token);
if (type === '#' || type === '^') {
if (type === '#' || type === '^' || type === '$' || type === '<') {
sections.push(token);
} else if (type === '/') {
// Check section nesting.
@@ -242,7 +263,7 @@
* Combines the values of consecutive text tokens in the given `tokens` array
* to a single token.
*/
function squashTokens(tokens) {
function squashTokens (tokens) {
var squashedTokens = [];
var token, lastToken;
@@ -269,7 +290,7 @@
* all tokens that appear in that section and 2) the index in the original
* template that represents the end of that section.
*/
function nestTokens(tokens) {
function nestTokens (tokens) {
var nestedTokens = [];
var collector = nestedTokens;
var sections = [];
@@ -279,6 +300,8 @@
token = tokens[i];
switch (token[0]) {
case '$':
case '<':
case '#':
case '^':
collector.push(token);
@@ -302,7 +325,7 @@
* A simple string scanner that is used by the template parser to find
* tokens in template strings.
*/
function Scanner(string) {
function Scanner (string) {
this.string = string;
this.tail = string;
this.pos = 0;
@@ -311,15 +334,15 @@
/**
* Returns `true` if the tail is empty (end of string).
*/
Scanner.prototype.eos = function () {
return this.tail === "";
Scanner.prototype.eos = function eos () {
return this.tail === '';
};
/**
* Tries to match the given regular expression at the current position.
* Returns the matched text if it can match, the empty string otherwise.
*/
Scanner.prototype.scan = function (re) {
Scanner.prototype.scan = function scan (re) {
var match = this.tail.match(re);
if (!match || match.index !== 0)
@@ -337,16 +360,16 @@
* Skips all text until the given regular expression can be matched. Returns
* the skipped string, which is the entire tail if no match can be made.
*/
Scanner.prototype.scanUntil = function (re) {
Scanner.prototype.scanUntil = function scanUntil (re) {
var index = this.tail.search(re), match;
switch (index) {
case -1:
match = this.tail;
this.tail = "";
this.tail = '';
break;
case 0:
match = "";
match = '';
break;
default:
match = this.tail.substring(0, index);
@@ -362,8 +385,9 @@
* Represents a rendering context by wrapping a view object and
* maintaining a reference to the parent context.
*/
function Context(view, parentContext) {
this.view = view == null ? {} : view;
function Context (view, parentContext) {
this.view = view;
this.blocks = {};
this.cache = { '.': this.view };
this.parent = parentContext;
}
@@ -372,22 +396,58 @@
* Creates a new context using the given view with this context
* as the parent.
*/
Context.prototype.push = function (view) {
Context.prototype.push = function push (view) {
return new Context(view, this);
};
/**
* Set a value in the current block context.
*/
Context.prototype.setBlockVar = function set (name, value) {
var blocks = this.blocks;
blocks[name] = value;
return value;
};
/**
* Clear all current block vars.
*/
Context.prototype.clearBlockVars = function clearBlockVars () {
this.blocks = {};
};
/**
* Get a value only from the current block context.
*/
Context.prototype.getBlockVar = function getBlockVar (name) {
var blocks = this.blocks;
var value;
if (blocks.hasOwnProperty(name)) {
value = blocks[name];
} else {
if (this.parent) {
value = this.parent.getBlockVar(name);
}
}
// Can return undefined.
return value;
};
/**
* Returns the value of the given name in this context, traversing
* up the context hierarchy if the value is absent in this context's view.
*/
Context.prototype.lookup = function (name) {
Context.prototype.lookup = function lookup (name) {
var cache = this.cache;
var value;
if (name in cache) {
if (cache.hasOwnProperty(name)) {
value = cache[name];
} else {
var context = this, names, index;
var context = this, names, index, lookupHit = false;
while (context) {
if (name.indexOf('.') > 0) {
@@ -395,13 +455,29 @@
names = name.split('.');
index = 0;
while (value != null && index < names.length)
/**
* Using the dot notion path in `name`, we descend through the
* nested objects.
*
* To be certain that the lookup has been successful, we have to
* check if the last object in the path actually has the property
* we are looking for. We store the result in `lookupHit`.
*
* This is specially necessary for when the value has been set to
* `undefined` and we want to avoid looking up parent contexts.
**/
while (value != null && index < names.length) {
if (index === names.length - 1)
lookupHit = hasProperty(value, names[index]);
value = value[names[index++]];
} else if (typeof context.view == 'object') {
}
} else {
value = context.view[name];
lookupHit = hasProperty(context.view, name);
}
if (value != null)
if (lookupHit)
break;
context = context.parent;
@@ -421,14 +497,14 @@
* string, given a context. It also maintains a cache of templates to
* avoid the need to parse the same template twice.
*/
function Writer() {
function Writer () {
this.cache = {};
}
/**
* Clears all cached templates in this writer.
*/
Writer.prototype.clearCache = function () {
Writer.prototype.clearCache = function clearCache () {
this.cache = {};
};
@@ -436,7 +512,7 @@
* Parses and caches the given `template` and returns the array of tokens
* that is generated from the parse.
*/
Writer.prototype.parse = function (template, tags) {
Writer.prototype.parse = function parse (template, tags) {
var cache = this.cache;
var tokens = cache[template];
@@ -455,7 +531,7 @@
* also be a function that is used to load partial templates on the fly
* that takes a single argument: the name of the partial.
*/
Writer.prototype.render = function (template, view, partials) {
Writer.prototype.render = function render (template, view, partials) {
var tokens = this.parse(template);
var context = (view instanceof Context) ? view : new Context(view);
return this.renderTokens(tokens, context, partials, template);
@@ -470,92 +546,129 @@
* If the template doesn't use higher-order sections, this argument may
* be omitted.
*/
Writer.prototype.renderTokens = function (tokens, context, partials, originalTemplate) {
Writer.prototype.renderTokens = function renderTokens (tokens, context, partials, originalTemplate) {
var buffer = '';
// This function is used to render an arbitrary template
// in the current context by higher-order sections.
var self = this;
function subRender(template) {
return self.render(template, context, partials);
}
var token, value;
var token, symbol, value;
for (var i = 0, numTokens = tokens.length; i < numTokens; ++i) {
value = undefined;
token = tokens[i];
symbol = token[0];
switch (token[0]) {
case '#':
value = context.lookup(token[1]);
if (symbol === '#') value = this.renderSection(token, context, partials, originalTemplate);
else if (symbol === '^') value = this.renderInverted(token, context, partials, originalTemplate);
else if (symbol === '>') value = this.renderPartial(token, context, partials, originalTemplate);
else if (symbol === '<') value = this.renderBlock(token, context, partials, originalTemplate);
else if (symbol === '$') value = this.renderBlockVariable(token, context, partials, originalTemplate);
else if (symbol === '&') value = this.unescapedValue(token, context);
else if (symbol === 'name') value = this.escapedValue(token, context);
else if (symbol === 'text') value = this.rawValue(token);
if (!value)
continue;
if (isArray(value)) {
for (var j = 0, valueLength = value.length; j < valueLength; ++j) {
buffer += this.renderTokens(token[4], context.push(value[j]), partials, originalTemplate);
}
} else if (typeof value === 'object' || typeof value === 'string') {
buffer += this.renderTokens(token[4], context.push(value), partials, originalTemplate);
} else if (isFunction(value)) {
if (typeof originalTemplate !== 'string')
throw new Error('Cannot use higher-order sections without the original template');
// Extract the portion of the original template that the section contains.
value = value.call(context.view, originalTemplate.slice(token[3], token[5]), subRender);
if (value != null)
buffer += value;
} else {
buffer += this.renderTokens(token[4], context, partials, originalTemplate);
}
break;
case '^':
value = context.lookup(token[1]);
// Use JavaScript's definition of falsy. Include empty arrays.
// See https://github.com/janl/mustache.js/issues/186
if (!value || (isArray(value) && value.length === 0))
buffer += this.renderTokens(token[4], context, partials, originalTemplate);
break;
case '>':
if (!partials)
continue;
value = isFunction(partials) ? partials(token[1]) : partials[token[1]];
if (value != null)
buffer += this.renderTokens(this.parse(value), context, partials, value);
break;
case '&':
value = context.lookup(token[1]);
if (value != null)
buffer += value;
break;
case 'name':
value = context.lookup(token[1]);
if (value != null)
buffer += mustache.escape(value);
break;
case 'text':
buffer += token[1];
break;
}
if (value !== undefined)
buffer += value;
}
return buffer;
};
mustache.name = "mustache.js";
mustache.version = "1.0.0";
mustache.tags = [ "{{", "}}" ];
Writer.prototype.renderSection = function renderSection (token, context, partials, originalTemplate) {
var self = this;
var buffer = '';
var value = context.lookup(token[1]);
// This function is used to render an arbitrary template
// in the current context by higher-order sections.
function subRender (template) {
return self.render(template, context, partials);
}
if (!value) return;
if (isArray(value)) {
for (var j = 0, valueLength = value.length; j < valueLength; ++j) {
buffer += this.renderTokens(token[4], context.push(value[j]), partials, originalTemplate);
}
} else if (typeof value === 'object' || typeof value === 'string' || typeof value === 'number') {
buffer += this.renderTokens(token[4], context.push(value), partials, originalTemplate);
} else if (isFunction(value)) {
if (typeof originalTemplate !== 'string')
throw new Error('Cannot use higher-order sections without the original template');
// Extract the portion of the original template that the section contains.
value = value.call(context.view, originalTemplate.slice(token[3], token[5]), subRender);
if (value != null)
buffer += value;
} else {
buffer += this.renderTokens(token[4], context, partials, originalTemplate);
}
return buffer;
};
Writer.prototype.renderInverted = function renderInverted (token, context, partials, originalTemplate) {
var value = context.lookup(token[1]);
// Use JavaScript's definition of falsy. Include empty arrays.
// See https://github.com/janl/mustache.js/issues/186
if (!value || (isArray(value) && value.length === 0))
return this.renderTokens(token[4], context, partials, originalTemplate);
};
Writer.prototype.renderPartial = function renderPartial (token, context, partials) {
if (!partials) return;
var value = isFunction(partials) ? partials(token[1]) : partials[token[1]];
if (value != null)
return this.renderTokens(this.parse(value), context, partials, value);
};
Writer.prototype.renderBlock = function renderBlock (token, context, partials, originalTemplate) {
if (!partials) return;
var value = isFunction(partials) ? partials(token[1]) : partials[token[1]];
if (value != null)
// Ignore any wrongly set block vars before we started.
context.clearBlockVars();
// We are only rendering to record the default block variables.
this.renderTokens(token[4], context, partials, originalTemplate);
// Now we render and return the result.
var result = this.renderTokens(this.parse(value), context, partials, value);
// Don't leak the block variables outside this include.
context.clearBlockVars();
return result;
};
Writer.prototype.renderBlockVariable = function renderBlockVariable (token, context, partials, originalTemplate) {
var value = token[1];
var exists = context.getBlockVar(value);
if (!exists) {
context.setBlockVar(value, originalTemplate.slice(token[3], token[5]));
return this.renderTokens(token[4], context, partials, originalTemplate);
} else {
return this.renderTokens(this.parse(exists), context, partials, exists);
}
};
Writer.prototype.unescapedValue = function unescapedValue (token, context) {
var value = context.lookup(token[1]);
if (value != null)
return value;
};
Writer.prototype.escapedValue = function escapedValue (token, context) {
var value = context.lookup(token[1]);
if (value != null)
return mustache.escape(value);
};
Writer.prototype.rawValue = function rawValue (token) {
return token[1];
};
mustache.name = 'mustache.js';
mustache.version = '2.1.3';
mustache.tags = [ '{{', '}}' ];
// All high-level mustache.* functions use this writer.
var defaultWriter = new Writer();
@@ -563,7 +676,7 @@
/**
* Clears all cached templates in the default writer.
*/
mustache.clearCache = function () {
mustache.clearCache = function clearCache () {
return defaultWriter.clearCache();
};
@@ -572,7 +685,7 @@
* array of tokens it contains. Doing this ahead of time avoids the need to
* parse templates on the fly as they are rendered.
*/
mustache.parse = function (template, tags) {
mustache.parse = function parse (template, tags) {
return defaultWriter.parse(template, tags);
};
@@ -580,12 +693,21 @@
* Renders the `template` with the given `view` and `partials` using the
* default writer.
*/
mustache.render = function (template, view, partials) {
mustache.render = function render (template, view, partials) {
if (typeof template !== 'string') {
throw new TypeError('Invalid template! Template should be a "string" ' +
'but "' + typeStr(template) + '" was given as the first ' +
'argument for mustache#render(template, view, partials)');
}
return defaultWriter.render(template, view, partials);
};
// This is here for backwards compatibility with 0.4.x.
mustache.to_html = function (template, view, partials, send) {
// This is here for backwards compatibility with 0.4.x.,
/*eslint-disable */ // eslint wants camel cased function name
mustache.to_html = function to_html (template, view, partials, send) {
/*eslint-enable*/
var result = mustache.render(template, view, partials);
if (isFunction(send)) {
lib/thirdpartylibs.xml
+1 -1
View File
@@ -268,6 +268,6 @@
<location>amd/src/mustache.js</location>
<name>Mustache.js</name>
<license>MIT</license>
<version>1.0.0</version>
<version>2.1.3</version>
</library>
</libraries>