forked from helpers/handlebars-helpers
-
Notifications
You must be signed in to change notification settings - Fork 4
/
index.js
344 lines (310 loc) · 8.16 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
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
const handlebars = require('handlebars');
const _ = require('lodash');
const utils = {};
// built-in utilities
utils.falsey = value => {
if (!value) return true;
const keywords = [
'0',
'false',
'nada',
'nil',
'nay',
'nah',
'negative',
'no',
'none',
'nope',
'nul',
'null',
'nix',
'nyet',
'uh-uh',
'veto',
'zero'
];
if (typeof value === 'string') {
return keywords.includes(value) || keywords.includes(value.toLowerCase());
}
return false;
};
utils.isOptions = val => _.isObject(val) && _.isObject(val.hash);
utils.isUndefined = val => val == null || (utils.isOptions(val) && val.hash != null);
utils.get = (value, path, defaultValue) => {
return String(path).split('.').reduce((acc, v) => {
try {
acc = acc[v];
} catch (e) {
return defaultValue;
}
return acc;
}, value);
};
utils.has = (value, path) => utils.get(value, path) !== void 0;
utils.isNumber = v => typeof v === 'number';
utils.isPlainObject = v => v !== null && typeof v === 'object' && v.toString() === '[object Object]';
utils.map = (arr, fn) => Array.isArray(arr) ? arr.map(fn) : undefined;
utils.includes = (c, v, i) => Array.isArray(c) || typeof c === 'string' ? c.includes(v, i) : false;
utils.isFunction = value => typeof value === 'function';
utils.sortBy = (arr, key) => [].concat(...arr).sort((a, b) => (a[key] > b[key]) ? 1 : ((b[key] > a[key]) ? -1 : 0));
utils.chunk = (arr, size) => Array(Math.ceil(arr.length / size)).fill().map((_, index) => index * size).map(begin => arr.slice(begin, begin + size));
// handlebars utilities:
utils.extend = handlebars.Utils.extend;
utils.escapeExpression = handlebars.Utils.escapeExpression;
utils.isEmpty = handlebars.Utils.isEmpty;
utils.createFrame = handlebars.Utils.createFrame;
utils.blockParams = handlebars.Utils.blockParams;
/**
* Returns true if a helper is a block helper.
*
* ```js
* Handlebars.registerHelper('example', function(options) {
* if (utils.isBlock(options)) {
* // do something if this is a block helper
* } else {
* // do something else if this is a not block helper
* }
* });
* ```
* @param {Object} `options` Helper options object
* @return {Boolean}
* @api public
*/
utils.isBlock = function(options) {
return utils.isOptions(options)
&& typeof options.fn === 'function'
&& typeof options.inverse === 'function';
};
/**
* Returns the given value or renders the block if it's a block helper.
*
* ```js
* Handlebars.registerHelper('example', function(val, locals, options) {
* return utils.fn(val, locals, options);
* });
* ```
* @param {any} `val`
* @param {Object} `options`
* @param {Object} `context`
* @return {String} Either returns the value, or renders the block.
* @api public
*/
utils.fn = function(val, context, options) {
if (utils.isOptions(val)) {
return utils.fn('', val, options);
}
if (utils.isOptions(context)) {
return utils.fn(val, {}, context);
}
return utils.isBlock(options) ? options.fn(context) : val;
};
/**
* Returns the given value or renders the inverse block if it's a block helper.
*
* ```js
* Handlebars.registerHelper('example', function(val, locals, options) {
* return utils.inverse(val, locals, options);
* });
* ```
* @param {any} `val`
* @param {Object} `options`
* @param {Object} `context`
* @return {String} Either returns the value, or renders the inverse block.
* @api public
*/
utils.inverse = function(val, context, options) {
if (utils.isOptions(val)) {
return utils.identity('', val, options);
}
if (utils.isOptions(context)) {
return utils.inverse(val, {}, context);
}
return utils.isBlock(options) ? options.inverse(context) : val;
};
/**
* Gets the return value for a helper, by either rendering the block
* or inverse block if it's a block helper, or returning the given value
* (when truthy) or an empty string (when falsey) if it's a non-block expression.
*
* ```js
* Handlebars.registerHelper('example', function(val, locals, options) {
* return utils.value(val, locals, options);
* });
* ```
* @param {any} `val`
* @param {Object} `options`
* @param {Object} `context`
* @return {String}
* @api public
*/
utils.value = function(val, context, options) {
if (utils.isOptions(val)) {
return utils.value(null, val, options);
}
if (utils.isOptions(context)) {
return utils.value(val, {}, context);
}
if (utils.isBlock(options)) {
return val ? options.fn(context) : options.inverse(context);
}
return val;
};
/**
* Returns true if the given value is a handlebar `options` object.
*
* ```js
* Handlebars.registerHelper('example', function(val, locals, options) {
* if (utils.isOptions(locals)) {
* options = locals;
* locals = {};
* }
* // do stuff
* });
* ```
* @param {Object} `val`
* @return {Boolean}
* @api public
*/
utils.isOptions = function(val) {
return utils.isObject(val) && utils.isObject(val.hash);
};
/**
* Returns true if the given value is `undefined` or is a handlebars
* options hash (which means that a value was not passed by the user).
*
* ```js
* Handlebars.registerHelper('example', function(val, options) {
* if (utils.isUndefined(val)) {
* return '';
* }
* // do stuff
* });
* ```
* @param {any} `value`
* @return {Boolean}
* @api public
*/
utils.isUndefined = function(val) {
return val == null || (utils.isOptions(val) && val.hash != null);
};
/**
* Creates an options object from the `context`, `locals` and `options.`
* Handlebars' `options.hash` is merged onto the options, and if the context
* is created by [templates][], `this.options` will be merged onto the
* options as well.
*
* @param {Object} `context`
* @param {Object} `locals` Options or locals
* @param {Object} `options`
* @return {Boolean}
* @api public
*/
utils.options = function(thisArg, locals, options) {
if (utils.isOptions(thisArg)) {
return utils.options({}, locals, thisArg);
}
if (utils.isOptions(locals)) {
return utils.options(thisArg, options, locals);
}
options = options || {};
if (!utils.isOptions(options)) {
locals = Object.assign({}, locals, options);
}
let opts = Object.assign({}, locals, options.hash);
if (utils.isObject(thisArg)) {
opts = Object.assign({}, thisArg.options, opts);
}
if (opts[options.name]) {
opts = Object.assign({}, opts[options.name], opts);
}
return opts;
};
/**
* Returns true if the given value is an object.
*
* ```js
* console.log(utils.isObject(null));
* //=> false
* console.log(utils.isObject([]));
* //=> false
* console.log(utils.isObject(function() {}));
* //=> false
* console.log(utils.isObject({}));
* //=> true
* ```
* @param {Object} `val`
* @return {Boolean}
* @api public
*/
utils.isObject = function(val) {
return utils.isPlainObject(val);
};
/**
* Returns the given value. If the value is a function it will be
* called with the current context, otherwise the value is returned.
*
* ```js
* console.log(utils.result('foo'));
* //=> 'foo'
* console.log(utils.result(function() {
* return 'foo';
* }));
* //=> 'foo'
* ```
* @param {any} `val`
* @return {any}
* @api public
*/
utils.result = function(val) {
if (typeof val === 'function') {
return val.apply(this, [].slice.call(arguments, 1));
}
return val;
};
/**
* Returns the given value as-is, unchanged.
*
* ```js
* console.log(utils.result('foo'));
* //=> 'foo'
* console.log(utils.result(function() {
* return 'foo';
* }));
* //=> [function]
* ```
* @param {any} `val`
* @return {any}
* @api public
*/
utils.identity = function(val) {
return val;
};
/**
* Return true if `val` is a non-empty string.
*
* @param {any} `val` The value to check
* @return {Boolean}
* @api public
*/
utils.isString = function(val) {
return typeof val === 'string' && val !== '';
};
/**
* Cast the given `val` to an array.
*
* ```js
* console.log(utils.arrayify(''));
* //=> []
* console.log(utils.arrayify('foo'));
* //=> ['foo']
* console.log(utils.arrayify(['foo']));
* //=> ['foo']
* ```
* @param {any} `val`
* @return {Array}
* @api public
*/
utils.arrayify = function(val) {
return val != null ? (Array.isArray(val) ? val : [val]) : [];
};
module.exports = utils;