File: compiler.js

package info (click to toggle)
node-handlebars 3%3A4.7.9-3
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 2,404 kB
  • sloc: javascript: 22,475; yacc: 136; lex: 125; sh: 72; ruby: 10; makefile: 7
file content (328 lines) | stat: -rw-r--r-- 9,484 bytes parent folder | download | duplicates (4)
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
describe('compiler', function() {
  if (!Handlebars.compile) {
    return;
  }

  describe('#equals', function() {
    function compile(string) {
      var ast = Handlebars.parse(string);
      return new Handlebars.Compiler().compile(ast, {});
    }

    it('should treat as equal', function() {
      equal(compile('foo').equals(compile('foo')), true);
      equal(compile('{{foo}}').equals(compile('{{foo}}')), true);
      equal(compile('{{foo.bar}}').equals(compile('{{foo.bar}}')), true);
      equal(
        compile('{{foo.bar baz "foo" true false bat=1}}').equals(
          compile('{{foo.bar baz "foo" true false bat=1}}')
        ),
        true
      );
      equal(
        compile('{{foo.bar (baz bat=1)}}').equals(
          compile('{{foo.bar (baz bat=1)}}')
        ),
        true
      );
      equal(
        compile('{{#foo}} {{/foo}}').equals(compile('{{#foo}} {{/foo}}')),
        true
      );
    });
    it('should treat as not equal', function() {
      equal(compile('foo').equals(compile('bar')), false);
      equal(compile('{{foo}}').equals(compile('{{bar}}')), false);
      equal(compile('{{foo.bar}}').equals(compile('{{bar.bar}}')), false);
      equal(
        compile('{{foo.bar baz bat=1}}').equals(
          compile('{{foo.bar bar bat=1}}')
        ),
        false
      );
      equal(
        compile('{{foo.bar (baz bat=1)}}').equals(
          compile('{{foo.bar (bar bat=1)}}')
        ),
        false
      );
      equal(
        compile('{{#foo}} {{/foo}}').equals(compile('{{#bar}} {{/bar}}')),
        false
      );
      equal(
        compile('{{#foo}} {{/foo}}').equals(
          compile('{{#foo}} {{foo}}{{/foo}}')
        ),
        false
      );
    });
  });

  describe('#compile', function() {
    it('should fail with invalid input', function() {
      shouldThrow(
        function() {
          Handlebars.compile(null);
        },
        Error,
        'You must pass a string or Handlebars AST to Handlebars.compile. You passed null'
      );
      shouldThrow(
        function() {
          Handlebars.compile({});
        },
        Error,
        'You must pass a string or Handlebars AST to Handlebars.compile. You passed [object Object]'
      );
    });

    it('should include the location in the error (row and column)', function() {
      try {
        Handlebars.compile(' \n  {{#if}}\n{{/def}}')();
        equal(
          true,
          false,
          'Statement must throw exception. This line should not be executed.'
        );
      } catch (err) {
        equal(
          err.message,
          "if doesn't match def - 2:5",
          'Checking error message'
        );
        if (Object.getOwnPropertyDescriptor(err, 'column').writable) {
          // In Safari 8, the column-property is read-only. This means that even if it is set with defineProperty,
          // its value won't change (https://github.com/jquery/esprima/issues/1290#issuecomment-132455482)
          // Since this was neither working in Handlebars 3 nor in 4.0.5, we only check the column for other browsers.
          equal(err.column, 5, 'Checking error column');
        }
        equal(err.lineNumber, 2, 'Checking error row');
      }
    });

    it('should include the location as enumerable property', function() {
      try {
        Handlebars.compile(' \n  {{#if}}\n{{/def}}')();
        equal(
          true,
          false,
          'Statement must throw exception. This line should not be executed.'
        );
      } catch (err) {
        equal(
          Object.prototype.propertyIsEnumerable.call(err, 'column'),
          true,
          'Checking error column'
        );
      }
    });

    it('can utilize AST instance', function() {
      equal(
        Handlebars.compile({
          type: 'Program',
          body: [{ type: 'ContentStatement', value: 'Hello' }]
        })(),
        'Hello'
      );
    });

    it('should reject AST with invalid PathExpression depth', function() {
      shouldThrow(
        function() {
          Handlebars.compile({
            type: 'Program',
            body: [
              {
                type: 'MustacheStatement',
                escaped: true,
                strip: { open: false, close: false },
                path: {
                  type: 'PathExpression',
                  data: false,
                  depth: '0',
                  parts: ['this'],
                  original: 'this'
                },
                params: []
              }
            ]
          })();
        },
        Error,
        'Invalid AST: PathExpression.depth must be an integer'
      );
    });

    it('should reject AST with non-array PathExpression parts', function() {
      shouldThrow(
        function() {
          Handlebars.compile({
            type: 'Program',
            body: [
              {
                type: 'MustacheStatement',
                escaped: true,
                strip: { open: false, close: false },
                path: {
                  type: 'PathExpression',
                  data: false,
                  depth: 0,
                  parts: 'this',
                  original: 'this'
                },
                params: []
              }
            ]
          })();
        },
        Error,
        'Invalid AST: PathExpression.parts must be an array'
      );
    });

    it('should reject AST with non-string PathExpression part', function() {
      shouldThrow(
        function() {
          Handlebars.compile({
            type: 'Program',
            body: [
              {
                type: 'MustacheStatement',
                escaped: true,
                strip: { open: false, close: false },
                path: {
                  type: 'PathExpression',
                  data: false,
                  depth: 0,
                  parts: [1],
                  original: 'this'
                },
                params: []
              }
            ]
          })();
        },
        Error,
        'Invalid AST: PathExpression.parts must only contain strings'
      );
    });

    it('should reject AST with invalid BooleanLiteral value type', function() {
      shouldThrow(
        function() {
          Handlebars.compile({
            type: 'Program',
            body: [
              {
                type: 'MustacheStatement',
                escaped: true,
                strip: { open: false, close: false },
                path: {
                  type: 'PathExpression',
                  data: false,
                  depth: 0,
                  parts: ['if'],
                  original: 'if'
                },
                params: [
                  {
                    type: 'BooleanLiteral',
                    value: 'true',
                    original: true
                  }
                ]
              }
            ]
          })();
        },
        Error,
        'Invalid AST: BooleanLiteral.value must be a boolean'
      );
    });

    it('should ignore loc metadata while validating AST nodes', function() {
      equal(
        Handlebars.compile({
          type: 'Program',
          meta: null,
          loc: { source: 'fake', start: { line: 1, column: 0 } },
          body: [{ type: 'ContentStatement', value: 'Hello' }]
        })(),
        'Hello'
      );
    });

    it('should accept AST with valid NumberLiteral values', function() {
      equal(
        Handlebars.compile(Handlebars.parse('{{lookup this 1}}'))(['a', 'b']),
        'b'
      );
    });

    it('should accept AST with valid BooleanLiteral values', function() {
      equal(
        Handlebars.compile(Handlebars.parse('{{#if true}}ok{{/if}}'))({}),
        'ok'
      );
    });

    it('can pass through an empty string', function() {
      equal(Handlebars.compile('')(), '');
    });

    it('should not modify the options.data property(GH-1327)', function() {
      var options = { data: [{ a: 'foo' }, { a: 'bar' }] };
      Handlebars.compile('{{#each data}}{{@index}}:{{a}} {{/each}}', options)();
      equal(
        JSON.stringify(options, 0, 2),
        JSON.stringify({ data: [{ a: 'foo' }, { a: 'bar' }] }, 0, 2)
      );
    });

    it('should not modify the options.knownHelpers property(GH-1327)', function() {
      var options = { knownHelpers: {} };
      Handlebars.compile('{{#each data}}{{@index}}:{{a}} {{/each}}', options)();
      equal(
        JSON.stringify(options, 0, 2),
        JSON.stringify({ knownHelpers: {} }, 0, 2)
      );
    });
  });

  describe('#precompile', function() {
    it('should fail with invalid input', function() {
      shouldThrow(
        function() {
          Handlebars.precompile(null);
        },
        Error,
        'You must pass a string or Handlebars AST to Handlebars.precompile. You passed null'
      );
      shouldThrow(
        function() {
          Handlebars.precompile({});
        },
        Error,
        'You must pass a string or Handlebars AST to Handlebars.precompile. You passed [object Object]'
      );
    });

    it('can utilize AST instance', function() {
      equal(
        /return "Hello"/.test(
          Handlebars.precompile({
            type: 'Program',
            body: [{ type: 'ContentStatement', value: 'Hello' }]
          })
        ),
        true
      );
    });

    it('can pass through an empty string', function() {
      equal(/return ""/.test(Handlebars.precompile('')), true);
    });
  });
});