summaryrefslogtreecommitdiffstats
path: root/lib/template.js
diff options
context:
space:
mode:
authorSamy Pessé <samypesse@gmail.com>2015-09-15 13:36:02 +0200
committerSamy Pessé <samypesse@gmail.com>2015-09-15 13:36:02 +0200
commite1930046599d430a6bb378af62bce78fb9d24ff7 (patch)
tree8e3abd0c5fc3aee6ba81403cb8b1e4b7b0918006 /lib/template.js
parentfe3a9c33d0395ea9747ab8ef2fec24e81fc92715 (diff)
downloadgitbook-e1930046599d430a6bb378af62bce78fb9d24ff7.zip
gitbook-e1930046599d430a6bb378af62bce78fb9d24ff7.tar.gz
gitbook-e1930046599d430a6bb378af62bce78fb9d24ff7.tar.bz2
Fix passing context to block functions
Add test for it
Diffstat (limited to 'lib/template.js')
-rw-r--r--lib/template.js61
1 files changed, 30 insertions, 31 deletions
diff --git a/lib/template.js b/lib/template.js
index 41362c8..d9d3a2f 100644
--- a/lib/template.js
+++ b/lib/template.js
@@ -1,13 +1,12 @@
var _ = require("lodash");
var Q = require("q");
-var path = require("path");
var nunjucks = require("nunjucks");
var escapeStringRegexp = require("escape-string-regexp");
var batch = require("./utils/batch");
var pkg = require("../package.json");
var defaultBlocks = require("./blocks");
-var BookLoader = require("./conrefs_loader")
+var BookLoader = require("./conrefs_loader");
// Normalize result from a block
function normBlockResult(blk) {
@@ -29,12 +28,12 @@ var TemplateEngine = function(book) {
// Tags
tags: {
- blockStart: '{%',
- blockEnd: '%}',
- variableStart: '{{',
- variableEnd: '}}',
- commentStart: '{###',
- commentEnd: '###}'
+ blockStart: "{%",
+ blockEnd: "%}",
+ variableStart: "{{",
+ variableEnd: "}}",
+ commentStart: "{###",
+ commentEnd: "###}"
}
}
);
@@ -63,7 +62,7 @@ TemplateEngine.prototype.processBlock = function(blk) {
});
blk.id = _.uniqueId("blk");
- var toAdd = (!blk.parse) || (blk.post != undefined);
+ var toAdd = (!blk.parse) || (blk.post !== undefined);
// Add to global map
if (toAdd) this.blockBodies[blk.id] = blk;
@@ -111,11 +110,11 @@ TemplateEngine.prototype.bindContext = function(func) {
TemplateEngine.prototype.addFilter = function(filterName, func) {
try {
this.env.getFilter(filterName);
- this.log.warn.ln("conflict in filters, '"+filterName+"' is already set");
+ this.log.warn.ln("conflict in filters, \""+filterName+"\" is already set");
return false;
} catch(e) {}
- this.log.debug.ln("add filter '"+filterName+"'");
+ this.log.debug.ln("add filter \""+filterName+"\"");
this.env.addFilter(filterName, this.bindContext(function() {
var ctx = this;
var args = Array.prototype.slice.apply(arguments);
@@ -139,7 +138,7 @@ TemplateEngine.prototype.addFilters = function(filters) {
// Return nunjucks extension name of a block
TemplateEngine.prototype.blockExtName = function(name) {
- return 'Block'+name+'Extension';
+ return "Block"+name+"Extension";
};
// Test if a block is defined
@@ -173,22 +172,22 @@ TemplateEngine.prototype.addBlock = function(name, block) {
blocks: []
});
- var extName = this.blockExtName(name);
+ extName = this.blockExtName(name);
if (this.hasBlock(name) && !defaultBlocks[name]) {
- this.log.warn.ln("conflict in blocks, '"+name+"' is already defined");
+ this.log.warn.ln("conflict in blocks, \""+name+"\" is already defined");
}
// Cleanup previous block
this.removeBlock(name);
- this.log.debug.ln("add block '"+name+"'");
+ this.log.debug.ln("add block \""+name+"\"");
this.blocks[name] = block;
- var Ext = function () {
+ Ext = function () {
this.tags = [name];
- this.parse = function(parser, nodes, lexer) {
+ this.parse = function(parser, nodes) {
var body = null;
var lastBlockName = null;
var lastBlockArgs = null;
@@ -229,7 +228,7 @@ TemplateEngine.prototype.addBlock = function(name, block) {
var bodies = [body];
_.each(block.blocks, function(blockName) {
subbodies[blockName] = subbodies[blockName] || [];
- if (subbodies[blockName].length == 0) {
+ if (subbodies[blockName].length === 0) {
subbodies[blockName].push({
args: new nodes.NodeList(),
body: new nodes.NodeList()
@@ -239,7 +238,7 @@ TemplateEngine.prototype.addBlock = function(name, block) {
bodies.push(subbodies[blockName][0].body);
});
- return new nodes.CallExtensionAsync(this, 'run', args, bodies);
+ return new nodes.CallExtensionAsync(this, "run", args, bodies);
};
this.run = function(context) {
@@ -273,12 +272,12 @@ TemplateEngine.prototype.addBlock = function(name, block) {
args: args,
kwargs: kwargs,
blocks: _blocks
- });
+ }, context);
})
// process the block returned
.then(that.processBlock)
- .nodeify(callback)
+ .nodeify(callback);
};
};
@@ -288,7 +287,7 @@ TemplateEngine.prototype.addBlock = function(name, block) {
// Add shortcuts
if (!_.isArray(block.shortcuts)) block.shortcuts = [block.shortcuts];
_.each(block.shortcuts, function(shortcut) {
- this.log.debug.ln("add template shortcut from '"+shortcut.start+"' to block '"+name+"' for parsers ", shortcut.parsers);
+ this.log.debug.ln("add template shortcut from \""+shortcut.start+"\" to block \""+name+"\" for parsers ", shortcut.parsers);
this.shortcuts.push({
block: name,
parsers: shortcut.parsers,
@@ -311,11 +310,11 @@ TemplateEngine.prototype.addBlocks = function(blocks) {
// Apply a block to some content
// This method result depends on the type of block (async or sync)
-TemplateEngine.prototype.applyBlock = function(name, blk) {
- var func, block, func, r;
+TemplateEngine.prototype.applyBlock = function(name, blk, ctx) {
+ var func, block, r;
block = this.blocks[name];
- if (!block) throw new Error('Block not found "'+name+'"');
+ if (!block) throw new Error("Block not found \""+name+"\"");
if (_.isString(blk)) {
blk = {
body: blk
@@ -330,7 +329,7 @@ TemplateEngine.prototype.applyBlock = function(name, blk) {
// Bind and call block processor
func = this.bindContext(block.process);
- r = func(blk);
+ r = func.call(ctx || {}, blk);
if (Q.isPromise(r)) return r.then(normBlockResult);
else return normBlockResult(r);
@@ -341,7 +340,7 @@ TemplateEngine.prototype._applyShortcut = function(parser, content, shortcut) {
if (!_.contains(shortcut.parsers, parser)) return content;
var regex = new RegExp(
escapeStringRegexp(shortcut.start) + "([\\s\\S]*?[^\\$])" + escapeStringRegexp(shortcut.end),
- 'g'
+ "g"
);
return content.replace(regex, function(all, match) {
return "{% "+shortcut.tag.start+" %}"+ match + "{% "+shortcut.tag.end+" %}";
@@ -350,7 +349,7 @@ TemplateEngine.prototype._applyShortcut = function(parser, content, shortcut) {
// Render a string from the book
TemplateEngine.prototype.renderString = function(content, context, options) {
- var context = _.extend({}, context, {
+ context = _.extend({}, context, {
// Variables from book.json
book: this.book.options.variables,
@@ -382,8 +381,8 @@ TemplateEngine.prototype.renderString = function(content, context, options) {
};
// Render a file from the book
-TemplateEngine.prototype.renderFile = function(filename, options) {
- var that = this, context;
+TemplateEngine.prototype.renderFile = function(filename) {
+ var that = this;
return that.book.readFile(filename)
.then(function(content) {
@@ -395,7 +394,7 @@ TemplateEngine.prototype.renderFile = function(filename, options) {
// Render a page from the book
TemplateEngine.prototype.renderPage = function(page) {
- var that = this, context;
+ var that = this;
return that.book.statFile(page.path)
.then(function(stat) {