/
hbs.js
285 lines (225 loc) · 7.32 KB
/
hbs.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
var fs = require('fs');
var path = require('path');
var walk = require('walk').walk;
var async = require('./async');
function Instance(handlebars) {
if (!(this instanceof Instance)) {
return new Instance(handlebars);
}
// expose handlebars, allows users to use their versions
// by overriding this early in their apps
var self = this;
self.handlebars = handlebars || require('handlebars').create();
// cache for templates, express 3.x doesn't do this for us
self.cache = {};
self.__express = middleware.bind(this);
// DEPRECATED, kept for backwards compatibility
self.SafeString = this.handlebars.SafeString;
self.Utils = this.handlebars.Utils;
};
// express 3.x template engine compliance
function middleware(filename, options, cb) {
var self = this;
var cache = self.cache;
var handlebars = self.handlebars;
self.async = async();
// grab extension from filename
// if we need a layout, we will look for one matching out extension
var extension = path.extname(filename);
// If passing the locals as data, create the handlebars options object now
var handlebarsOpts = (self.__localsAsData) ? { data: options._locals } : undefined;
// render the original file
// cb(err, str)
function render_file(locals, cb) {
// cached?
var template = cache[filename];
if (template) {
try {
var res = template(locals, handlebarsOpts)
self.async.done(function (values) {
Object.keys(values).forEach(function (id) {
res = res.replace(id, values[id])
})
cb(null, res)
})
} catch (err) {
cb(prependFilenameToError(filename, err))
}
return
}
fs.readFile(filename, 'utf8', function(err, str){
if (err) {
return cb(err);
}
var template = handlebars.compile(str);
if (locals.cache) {
cache[filename] = template;
}
try {
var res = template(locals, handlebarsOpts);
self.async.done(function(values) {
Object.keys(values).forEach(function(id) {
res = res.replace(id, values[id]);
});
cb(null, res);
});
} catch (err) {
cb(prependFilenameToError(filename, err))
}
});
}
// render with a layout
function render_with_layout (filename, template, locals, cb) {
render_file(locals, function(err, str) {
if (err) {
return cb(err);
}
locals.body = str;
try {
var res = template(locals, handlebarsOpts)
self.async.done(function (values) {
Object.keys(values).forEach(function (id) {
res = res.replace(id, values[id])
})
cb(null, res)
})
} catch (err) {
cb(prependFilenameToError(filename, err))
}
});
}
var layout = options.layout;
// user did not specify a layout in the locals
// check global layout state
if (layout === undefined && options.settings && options.settings['view options']) {
layout = options.settings['view options'].layout;
}
// user explicitly request no layout
// either by specifying false for layout: false in locals
// or by settings the false view options
if (layout !== undefined && !layout) {
return render_file(options, cb);
}
var view_dirs = options.settings.views;
var layout_filename = [].concat(view_dirs).map(function (view_dir) {
var view_path = path.join(view_dir, layout || 'layout');
if (!path.extname(view_path)) {
view_path += extension;
}
return view_path;
});
for (var i = 0; i < layout_filename.length; i++) {
var layout_template = cache[layout_filename[i]]
if (layout_template) {
return render_with_layout(layout_filename[i], layout_template, options, cb)
}
}
// TODO check if layout path has .hbs extension
function prependFilenameToError (filename, err) {
// prepend to the message
err.message = filename + ': ' + err.message
// restore error message on stack (https://github.com/wycats/handlebars.js/issues/1562)
if (typeof err.stack === 'string' && err.stack.indexOf(err.name + '\n') === 0 && err.stack.indexOf(err.message) === -1) {
Object.defineProperty(err, 'stack', {
configurable: true,
value: err.name + ': ' + err.message,
writable: true
})
}
return err
}
function cacheAndCompile(filename, str) {
var layout_template = handlebars.compile(str);
if (options.cache) {
cache[filename] = layout_template;
}
render_with_layout(filename, layout_template, options, cb)
}
function tryReadFileAndCache(templates) {
var template = templates.shift();
fs.readFile(template, 'utf8', function(err, str) {
if (err) {
if (layout && templates.length === 0) {
// Only return error if user explicitly asked for layout.
return cb(err);
}
if (templates.length > 0) {
return tryReadFileAndCache(templates);
}
return render_file(options, cb);
}
cacheAndCompile(template, str);
});
}
tryReadFileAndCache(layout_filename);
}
// express 2.x template engine compliance
Instance.prototype.compile = function (str) {
if (typeof str !== 'string') {
return str;
}
var template = this.handlebars.compile(str);
return function (locals) {
return template(locals, {
helpers: locals.blockHelpers,
partials: null,
data: null
});
};
};
Instance.prototype.registerHelper = function () {
this.handlebars.registerHelper.apply(this.handlebars, arguments);
};
Instance.prototype.registerPartial = function () {
this.handlebars.registerPartial.apply(this.handlebars, arguments);
};
Instance.prototype.registerPartials = function (directory, done) {
var handlebars = this.handlebars;
var register = function(filepath, done) {
var isValidTemplate = /\.(html|hbs)$/.test(filepath);
if (!isValidTemplate) {
return done(null);
}
fs.readFile(filepath, 'utf8', function(err, data) {
if (!err) {
var ext = path.extname(filepath);
var templateName = path.relative(directory, filepath)
.slice(0, -(ext.length)).replace(/[ -]/g, '_')
.replace(/\\/g, '/')
handlebars.registerPartial(templateName, data);
}
done(err);
});
};
walk(directory).on('file', function(root, stat, next) {
register(path.join(root, stat.name), next);
}).on('end', done || function() {});
};
Instance.prototype.registerAsyncHelper = function(name, fn) {
var self = this;
self.handlebars.registerHelper(name, function() {
return self.async.resolve(fn, arguments);
});
};
Instance.prototype.localsAsTemplateData = function(app) {
// Set a flag to indicate we should pass locals as data
this.__localsAsData = true;
app.render = (function(render) {
return function(view, options, callback) {
if (typeof options === "function") {
callback = options;
options = {};
}
// Mix response.locals (options._locals) with app.locals (this.locals)
options._locals = options._locals || {};
for (var key in this.locals) {
options._locals[key] = this.locals[key];
}
return render.call(this, view, options, callback);
};
})(app.render);
};
module.exports = new Instance();
module.exports.create = function(handlebars) {
return new Instance(handlebars);
};