-
-
Notifications
You must be signed in to change notification settings - Fork 1
/
index.js
266 lines (234 loc) · 5.87 KB
/
index.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
'use strict';
var get = require('get-value');
var visit = require('collection-visit');
var define = require('define-property');
var Loader = require('load-helpers');
/**
* Create an instance of `HelperCache` with the given `options.`
*
* ```js
* var App = require('helper-cache');
* var app = new App();
* ```
* @param {Object} `options`
* @api public
*/
function HelperCache(options) {
if (!(this instanceof HelperCache)) {
return new HelperCache(options);
}
options = options || {};
define(this, 'loader', new Loader(options));
this.cache = this.loader.cache;
if (options.async === true) {
this.async = true;
}
}
/**
* Register a helper.
*
* ```js
* app.helper('uppercase', function(str) {
* return str.toUpperCase();
* });
* ```
* @param {String} `name`
* @param {Function} `fn`
* @return {Object} Retuns the instance of `HelperCache` for chaining.
* @api public
*/
HelperCache.prototype.addHelper = function(name, fn, options) {
this.loader.addHelper.apply(this.loader, arguments);
return this;
};
/**
* Get a helper.
*
* ```js
* app.helper('uppercase', function(str) {
* return str.toUpperCase();
* });
* ```
* @param {String} `name`
* @param {Function} `fn`
* @return {Object} Retuns the instance of `HelperCache` for chaining.
* @api public
*/
HelperCache.prototype.getHelper = function(name) {
return get(this.loader.cache, name);
};
/**
* Register a sync template helper `fn` as `name`.
*
* ```js
* app.helper('uppercase', function(str) {
* return str.toUpperCase();
* });
* ```
* @param {String} `name`
* @param {Function} `fn`
* @return {Object} Retuns the instance of `HelperCache` for chaining.
* @api public
*/
HelperCache.prototype.helper = function(name, fn) {
if (arguments.length === 1 && typeof name === 'string') {
return this.getHelper(name);
}
if (isObject(name)) {
return this.helpers.apply(this, arguments);
}
if (isObject(fn) && typeof fn.async !== 'boolean') {
return this.asyncGroup.apply(this, arguments);
}
if (typeof fn !== 'function') {
throw new TypeError('expected a function');
}
this.addHelper(name, fn);
return this;
};
/**
* Register multiple sync helpers at once.
*
* ```js
* app.helpers({
* foo: function() {},
* bar: function() {},
* baz: function() {}
* });
* ```
* @param {Object} `helpers` Array of globs, file paths or key-value pair helper objects.
* @return {Object} Retuns the instance of `HelperCache` for chaining.
* @api public
*/
HelperCache.prototype.helpers = function(helpers) {
this.visit('helper', helpers);
return this;
};
/**
* Register an async template helper `fn` as `name`.
*
* ```js
* app.asyncHelper('uppercase', function(str) {
* return str.toUpperCase();
* });
* ```
* @param {String} `name`
* @param {Function} `fn`
* @return {Object} Retuns the instance of `HelperCache` for chaining.
* @api public
*/
HelperCache.prototype.asyncHelper = function(name, fn) {
if (arguments.length === 1 && typeof name === 'string') {
return this.helper(name);
}
if (isObject(name)) {
return this.asyncHelpers.apply(this, arguments);
}
if (typeof fn !== 'function') {
throw new TypeError('expected a function');
}
this.addHelper(name, toAsync(fn), {async: true});
return this;
};
/**
* Register multiple async helpers at once.
*
* ```js
* app.asyncHelpers({
* foo: function() {},
* bar: function() {},
* baz: function() {}
* });
* ```
* @param {Object} `helpers` Array of globs, file paths or key-value pair helper objects.
* @return {Object} Retuns the instance of `HelperCache` for chaining.
* @api public
*/
HelperCache.prototype.asyncHelpers = function(helpers) {
return this.visit('asyncHelper', helpers);
};
/**
* Namespace a collection of sync helpers on the given `prop`.
*
* ```js
* app.group('mdu', require('markdown-utils'));
* // Usage: '<%= mdu.heading("My heading") %>'
* ```
* @param {Object|Array} `helpers` Object, array of objects, or glob patterns.
* @api public
*/
HelperCache.prototype.group = function(prop, helpers) {
if (!isObject(helpers)) {
throw new TypeError('expected an object');
}
var keys = Object.keys(helpers);
for (var i = 0; i < keys.length; i++) {
var key = keys[i];
this.set([prop, key], helpers[key]);
}
return this;
};
/**
* Namespace a collection of async helpers on the given `prop`.
*
* ```js
* app.asyncGroup('mdu', require('markdown-utils'));
* // Usage: '<%= mdu.heading("My heading") %>'
* ```
* @param {Object|Array} `helpers` Object, array of objects, or glob patterns.
* @api public
*/
HelperCache.prototype.asyncGroup = function(name, helpers) {
if (typeof helpers === 'function') {
return this.asyncGroup(helpers(this.options));
}
if (!isObject(helpers)) {
throw new TypeError('expected an object');
}
var keys = Object.keys(helpers);
for (var i = 0; i < keys.length; i++) {
var key = keys[i];
this.addHelper(name + '.' + key, toAsync(helpers[key]));
}
return this;
};
/**
* Load helpers.
*
* ```js
* app.load({
* foo: function() {},
* bar: function() {},
* baz: function() {}
* });
* ```
* @param {Object} `helpers` Array of globs, file paths or key-value pair helper objects.
* @return {Object} Retuns the instance of `HelperCache` for chaining.
* @api public
*/
HelperCache.prototype.load = function() {
this.loader.load.apply(this.loader, arguments);
return this;
};
HelperCache.prototype.loadGroup = function() {
this.loader.loadGroup.apply(this.loader, arguments);
return this;
};
HelperCache.prototype.visit = function(method, val) {
visit.apply(null, [this].concat([].slice.call(arguments)));
return this;
};
/**
* Expose `helper-cache`
*/
module.exports = HelperCache;
/**
* Return true if a value is an object
*/
function isObject(val) {
return val && typeof val === 'object' && !Array.isArray(val);
}
function toAsync(fn) {
fn.async = true;
return fn;
}