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
|
/*
* This file is forked from the handlebars project (https://github.com/handlebars-lang/handlebars.js),
* and may include modifications made by Elasticsearch B.V.
* Elasticsearch B.V. licenses this file to you under the MIT License.
* See `packages/kbn-handlebars/LICENSE` for more information.
*/
import Handlebars, { type HelperOptions } from '../..';
import { expectTemplate } from '../__jest__/test_bench';
describe('data', () => {
it('passing in data to a compiled function that expects data - works with helpers', () => {
expectTemplate('{{hello}}')
.withCompileOptions({ data: true })
.withHelper('hello', function (this: any, options) {
return options.data.adjective + ' ' + this.noun;
})
.withRuntimeOptions({ data: { adjective: 'happy' } })
.withInput({ noun: 'cat' })
.toCompileTo('happy cat');
});
it('data can be looked up via @foo', () => {
expectTemplate('{{@hello}}')
.withRuntimeOptions({ data: { hello: 'hello' } })
.toCompileTo('hello');
});
it('deep @foo triggers automatic top-level data', () => {
global.kbnHandlebarsEnv = Handlebars.create();
const helpers = Handlebars.createFrame(kbnHandlebarsEnv!.helpers);
helpers.let = function (options: HelperOptions) {
const frame = Handlebars.createFrame(options.data);
for (const prop in options.hash) {
if (prop in options.hash) {
frame[prop] = options.hash[prop];
}
}
return options.fn(this, { data: frame });
};
expectTemplate(
'{{#let world="world"}}{{#if foo}}{{#if foo}}Hello {{@world}}{{/if}}{{/if}}{{/let}}'
)
.withInput({ foo: true })
.withHelpers(helpers)
.toCompileTo('Hello world');
global.kbnHandlebarsEnv = null;
});
it('parameter data can be looked up via @foo', () => {
expectTemplate('{{hello @world}}')
.withRuntimeOptions({ data: { world: 'world' } })
.withHelper('hello', function (noun) {
return 'Hello ' + noun;
})
.toCompileTo('Hello world');
});
it('hash values can be looked up via @foo', () => {
expectTemplate('{{hello noun=@world}}')
.withRuntimeOptions({ data: { world: 'world' } })
.withHelper('hello', function (options) {
return 'Hello ' + options.hash.noun;
})
.toCompileTo('Hello world');
});
it('nested parameter data can be looked up via @foo.bar', () => {
expectTemplate('{{hello @world.bar}}')
.withRuntimeOptions({ data: { world: { bar: 'world' } } })
.withHelper('hello', function (noun) {
return 'Hello ' + noun;
})
.toCompileTo('Hello world');
});
it('nested parameter data does not fail with @world.bar', () => {
expectTemplate('{{hello @world.bar}}')
.withRuntimeOptions({ data: { foo: { bar: 'world' } } })
.withHelper('hello', function (noun) {
return 'Hello ' + noun;
})
.toCompileTo('Hello undefined');
});
it('parameter data throws when using complex scope references', () => {
expectTemplate('{{#goodbyes}}{{text}} cruel {{@foo/../name}}! {{/goodbyes}}').toThrow(Error);
});
it('data can be functions', () => {
expectTemplate('{{@hello}}')
.withRuntimeOptions({
data: {
hello() {
return 'hello';
},
},
})
.toCompileTo('hello');
});
it('data can be functions with params', () => {
expectTemplate('{{@hello "hello"}}')
.withRuntimeOptions({
data: {
hello(arg: any) {
return arg;
},
},
})
.toCompileTo('hello');
});
it('data is inherited downstream', () => {
expectTemplate(
'{{#let foo=1 bar=2}}{{#let foo=bar.baz}}{{@bar}}{{@foo}}{{/let}}{{@foo}}{{/let}}'
)
.withInput({ bar: { baz: 'hello world' } })
.withCompileOptions({ data: true })
.withHelper('let', function (this: any, options) {
const frame = Handlebars.createFrame(options.data);
for (const prop in options.hash) {
if (prop in options.hash) {
frame[prop] = options.hash[prop];
}
}
return options.fn(this, { data: frame });
})
.withRuntimeOptions({ data: {} })
.toCompileTo('2hello world1');
});
it('passing in data to a compiled function that expects data - works with helpers in partials', () => {
expectTemplate('{{>myPartial}}')
.withCompileOptions({ data: true })
.withPartial('myPartial', '{{hello}}')
.withHelper('hello', function (this: any, options: HelperOptions) {
return options.data.adjective + ' ' + this.noun;
})
.withInput({ noun: 'cat' })
.withRuntimeOptions({ data: { adjective: 'happy' } })
.toCompileTo('happy cat');
});
it('passing in data to a compiled function that expects data - works with helpers and parameters', () => {
expectTemplate('{{hello world}}')
.withCompileOptions({ data: true })
.withHelper('hello', function (this: any, noun, options) {
return options.data.adjective + ' ' + noun + (this.exclaim ? '!' : '');
})
.withInput({ exclaim: true, world: 'world' })
.withRuntimeOptions({ data: { adjective: 'happy' } })
.toCompileTo('happy world!');
});
it('passing in data to a compiled function that expects data - works with block helpers', () => {
expectTemplate('{{#hello}}{{world}}{{/hello}}')
.withCompileOptions({
data: true,
})
.withHelper('hello', function (this: any, options) {
return options.fn(this);
})
.withHelper('world', function (this: any, options) {
return options.data.adjective + ' world' + (this.exclaim ? '!' : '');
})
.withInput({ exclaim: true })
.withRuntimeOptions({ data: { adjective: 'happy' } })
.toCompileTo('happy world!');
});
it('passing in data to a compiled function that expects data - works with block helpers that use ..', () => {
expectTemplate('{{#hello}}{{world ../zomg}}{{/hello}}')
.withCompileOptions({ data: true })
.withHelper('hello', function (options) {
return options.fn({ exclaim: '?' });
})
.withHelper('world', function (this: any, thing, options) {
return options.data.adjective + ' ' + thing + (this.exclaim || '');
})
.withInput({ exclaim: true, zomg: 'world' })
.withRuntimeOptions({ data: { adjective: 'happy' } })
.toCompileTo('happy world?');
});
it('passing in data to a compiled function that expects data - data is passed to with block helpers where children use ..', () => {
expectTemplate('{{#hello}}{{world ../zomg}}{{/hello}}')
.withCompileOptions({ data: true })
.withHelper('hello', function (options) {
return options.data.accessData + ' ' + options.fn({ exclaim: '?' });
})
.withHelper('world', function (this: any, thing, options) {
return options.data.adjective + ' ' + thing + (this.exclaim || '');
})
.withInput({ exclaim: true, zomg: 'world' })
.withRuntimeOptions({ data: { adjective: 'happy', accessData: '#win' } })
.toCompileTo('#win happy world?');
});
it('you can override inherited data when invoking a helper', () => {
expectTemplate('{{#hello}}{{world zomg}}{{/hello}}')
.withCompileOptions({ data: true })
.withHelper('hello', function (options) {
return options.fn({ exclaim: '?', zomg: 'world' }, { data: { adjective: 'sad' } });
})
.withHelper('world', function (this: any, thing, options) {
return options.data.adjective + ' ' + thing + (this.exclaim || '');
})
.withInput({ exclaim: true, zomg: 'planet' })
.withRuntimeOptions({ data: { adjective: 'happy' } })
.toCompileTo('sad world?');
});
it('you can override inherited data when invoking a helper with depth', () => {
expectTemplate('{{#hello}}{{world ../zomg}}{{/hello}}')
.withCompileOptions({ data: true })
.withHelper('hello', function (options) {
return options.fn({ exclaim: '?' }, { data: { adjective: 'sad' } });
})
.withHelper('world', function (this: any, thing, options) {
return options.data.adjective + ' ' + thing + (this.exclaim || '');
})
.withInput({ exclaim: true, zomg: 'world' })
.withRuntimeOptions({ data: { adjective: 'happy' } })
.toCompileTo('sad world?');
});
describe('@root', () => {
it('the root context can be looked up via @root', () => {
expectTemplate('{{@root.foo}}')
.withInput({ foo: 'hello' })
.withRuntimeOptions({ data: {} })
.toCompileTo('hello');
expectTemplate('{{@root.foo}}').withInput({ foo: 'hello' }).toCompileTo('hello');
});
it('passed root values take priority', () => {
expectTemplate('{{@root.foo}}')
.withInput({ foo: 'should not be used' })
.withRuntimeOptions({ data: { root: { foo: 'hello' } } })
.toCompileTo('hello');
});
});
describe('nesting', () => {
it('the root context can be looked up via @root', () => {
expectTemplate(
'{{#helper}}{{#helper}}{{@./depth}} {{@../depth}} {{@../../depth}}{{/helper}}{{/helper}}'
)
.withInput({ foo: 'hello' })
.withHelper('helper', function (this: any, options) {
const frame = Handlebars.createFrame(options.data);
frame.depth = options.data.depth + 1;
return options.fn(this, { data: frame });
})
.withRuntimeOptions({
data: {
depth: 0,
},
})
.toCompileTo('2 1 0');
});
});
});
|