jinja-js/tests_nunjucks/compiler.js

JavaScript templating engine based on Jinja2

var should = require('should');
var render = require('./util').render;

describe('compiler', function() {
  it('should compile templates', function() {
    var s = render('Hello world');
    s.should.equal('Hello world');

    s = render('Hello world, {{ name }}',
           { name: 'James' });
    s.should.equal('Hello world, James');

    s = render('Hello world, {{name}}{{suffix}}, how are you',
           { name: 'James',
           suffix: ' Long'});
    s.should.equal('Hello world, James Long, how are you');
  });

  it('should escape newlines', function() {
    render('foo\\nbar').should.equal('foo\\nbar');
  });

  it('should compile references', function() {
    var s = render('{{ foo.bar }}',
             { foo: { bar: 'baz' }});
    s.should.equal('baz');

    s = render('{{ foo["bar"] }}',
           { foo: { bar: 'baz' }});
    s.should.equal('baz');
  });

  it('should fail silently on undefined values', function() {
    var s = render('{{ foo }}');
    s.should.equal('');

    var s = render('{{ foo.bar }}');
    s.should.equal('');

    var s = render('{{ foo.bar.baz }}');
    s.should.equal('');

    var s = render('{{ foo.bar.baz["biz"].mumble }}');
    s.should.equal('');
  });

  it('should not treat falsy values the same as undefined', function() {
    var s = render('{{ foo }}', {foo: 0});
    s.should.equal('0');

    var s = render('{{ foo }}', {foo: false});
    s.should.equal('false');
  });

  it('should compile function calls', function() {
    var s = render('{{ foo("msg") }}',
             { foo: function(str) { return str + 'hi'; }});
    s.should.equal('msghi');
  });

  it('should compile function calls with correct scope', function() {
    var s = render('{{ foo.bar() }}',
      { foo: { bar: function() { return this.baz }, baz: 'hello' }});
    s.should.equal('hello');
  });

  it('should compile if blocks', function() {
    var tmpl = ('Give me some {% if hungry %}pizza' +
          '{% else %}water{% endif %}');

    var s = render(tmpl, { hungry: true });
    s.should.equal('Give me some pizza');

    s = render(tmpl, { hungry: false });
    s.should.equal('Give me some water');

    s = render('{% if not hungry %}good{% endif %}',
           { hungry: false });
    s.should.equal('good');

    s = render('{% if hungry and like_pizza %}good{% endif %}',
      { hungry: true, like_pizza: true });
    s.should.equal('good');

    s = render('{% if hungry or like_pizza %}good{% endif %}',
      { hungry: false, like_pizza: true });
    s.should.equal('good');

    s = render('{% if (hungry or like_pizza) and anchovies %}good{% endif %}',
      { hungry: false, like_pizza: true, anchovies: true });
    s.should.equal('good');

    s = render('{% if food == "pizza" %}pizza{% endif %}' +
           '{% if food =="beer" %}beer{% endif %}', 
          { food: 'beer' });
    s.should.equal('beer');
  });

  it('should compile for blocks', function() {
    var s = render('{% for i in arr %}{{ i }}{% endfor %}',
             { arr: [1, 2, 3, 4, 5] });
    s.should.equal('12345');

    s = render('{% for item in arr | batch(2) %}{{ item[0] }}{% endfor %}',
           { arr: ['a', 'b', 'c', 'd'] });
    s.should.equal('ac');

    s = render('{% for k, v in { one: 1, two: 2 } %}' +
           '-{{ k }}:{{ v }}-{% endfor %}');
    s.should.equal('-one:1--two:2-');

    s = render('{% for i in [7,3,6] %}{{ loop.index }}{% endfor %}');
    s.should.equal('123');

    s = render('{% for i in [7,3,6] %}{{ loop.index0 }}{% endfor %}');
    s.should.equal('012');

    s = render('{% for i in [7,3,6] %}{{ loop.revindex }}{% endfor %}');
    s.should.equal('321');

    s = render('{% for i in [7,3,6] %}{{ loop.revindex0 }}{% endfor %}');
    s.should.equal('210');

    s = render('{% for i in [7,3,6] %}{% if loop.first %}{{ i }}{% endif %}{% endfor %}');
    s.should.equal('7');

    s = render('{% for i in [7,3,6] %}{% if loop.last %}{{ i }}{% endif %}{% endfor %}');
    s.should.equal('6');

    s = render('{% for i in [7,3,6] %}{{ loop.length }}{% endfor %}');
    s.should.equal('333');
  });

  it('should compile operators', function() {
    render('{{ 3 + 4 - 5 * 6 / 10 }}').should.equal('4');
    render('{{ 4**5 }}').should.equal('1024');
    render('{{ 9//5 }}').should.equal('1');
    render('{{ 9%5 }}').should.equal('4');
    render('{{ -5 }}').should.equal('-5');

    render('{% if 3 < 4 %}yes{% endif %}').should.equal('yes');
    render('{% if 3 > 4 %}yes{% endif %}').should.equal('');
    render('{% if 9 >= 10 %}yes{% endif %}').should.equal('');
    render('{% if 10 >= 10 %}yes{% endif %}').should.equal('yes');
    render('{% if 9 <= 10 %}yes{% endif %}').should.equal('yes');
    render('{% if 10 <= 10 %}yes{% endif %}').should.equal('yes');
    render('{% if 11 <= 10 %}yes{% endif %}').should.equal('');

    render('{% if 10 != 10 %}yes{% endif %}').should.equal('');
    render('{% if 10 == 10 %}yes{% endif %}').should.equal('yes');

    render('{% if foo(20) > bar %}yes{% endif %}',
         { foo: function(n) { return n - 1; },
         bar: 15 })
      .should.equal('yes');
  });

  it('should compile macros', function() {
    var s = render('{% macro foo() %}This is a macro{% endmacro %}' +
             '{{ foo() }}');
    s.should.equal('This is a macro');

    s = render('{% macro foo(x, y) %}{{ y }}{% endmacro %}' +
           '{{ foo(1) }}');
    s.should.equal('undefined');

    s = render('{% macro foo(x, y) %}{{ y }}{% endmacro %}' +
           '{{ foo(1, 2) }}');
    s.should.equal('2');

    s = render('{% macro foo(x, y, z=5) %}{{ y }}{% endmacro %}' +
           '{{ foo(1, 2) }}');
    s.should.equal('2');

    s = render('{% macro foo(x, y, z=5) %}{{ z }}{% endmacro %}' +
           '{{ foo(1, 2) }}');
    s.should.equal('5');

    s = render('{% macro foo(x, y, z=5) %}{{ y }}{% endmacro %}' +
           '{{ foo(1, y=2) }}');
    s.should.equal('2');

    s = render('{% macro foo(x, y, z=5) %}{{ x }}{{ y }}{{ z }}' +
           '{% endmacro %}' +
           '{{ foo(x=1, y=2) }}');
    s.should.equal('125');

    s = render('{% macro foo(x, y, z=5) %}{{ x }}{{ y }}{{ z }}' +
           '{% endmacro %}' +
           '{{ foo(x=1, y=2, z=3) }}');
    s.should.equal('123');

    s = render('{% macro foo(x, y=2, z=5) %}{{ x }}{{ y }}{{ z }}' +
           '{% endmacro %}' +
           '{{ foo(1, z=3) }}');
    s.should.equal('123');

    s = render('{% macro foo(x, y=2, z=5) %}{{ x }}{{ y }}{{ z }}' +
           '{% endmacro %}' +
           '{{ foo(1) }}');
    s.should.equal('125');

    s = render('{% macro foo(x, y=2, z=5) %}{{ x }}{{ y }}{{ z }}' +
           '{% endmacro %}' +
           '{{ foo(1, 10, 20) }}');
    s.should.equal('11020');

    s = render('{% extends "base.html" %}' +
           '{% macro foo(x, y=2, z=5) %}{{ x }}{{ y }}{{ z }}' +
           '{% endmacro %}' +
           '{% block block1 %}' +
           '{{ foo(1) }}' +
           '{% endblock %}');
    s.should.equal('Foo125BazFizzle');

    s = render('{% block bar %}' +
           '{% macro foo(x, y=2, z=5) %}{{ x }}{{ y }}{{ z }}' +
           '{% endmacro %}' +
           '{% endblock %}' +
           '{% block baz %}' +
           '{{ foo(1) }}' +
           '{% endblock %}');
    s.should.equal('125');
  });

  it('should import templates', function() {
    var s = render('{% import "import.html" as imp %}' +
             '{{ imp.foo() }} {{ imp.bar }}');
    s.should.equal("Here's a macro baz");

    s = render('{% from "import.html" import foo as baz, bar %}' +
             '{{ bar }} {{ baz() }}');
    s.should.equal("baz Here's a macro");

    s = render('{% for i in [1,2] %}' +
           'start: {{ num }}' +
           '{% from "import.html" import bar as num %}' +
           'end: {{ num }}' +
           '{% endfor %}' +
           'final: {{ num }}');
    // TODO: Should the for loop create a new frame for each
    // iteration? As it is, `num` is set on all iterations after
    // the first one sets it
    s.should.equal('start: end: bazstart: bazend: bazfinal: ');
  });

  it('should inherit templates', function() {
    var s = render('{% extends "base.html" %}');
    s.should.equal('FooBarBazFizzle');

    s = render('hola {% extends "base.html" %} hizzle mumble');
    s.should.equal('FooBarBazFizzle');

    s = render('{% extends "base.html" %}' +
           '{% block block1 %}BAR{% endblock %}');
    s.should.equal('FooBARBazFizzle');

    s = render('{% extends "base.html" %}' +
           '{% block block1 %}BAR{% endblock %}' +
           '{% block block2 %}BAZ{% endblock %}');
    s.should.equal('FooBARBAZFizzle');

    s = render('hola {% extends tmpl %} hizzle mumble',
           { tmpl: 'base.html' });
    s.should.equal('FooBarBazFizzle');
  });

  it('should render parent blocks with super()', function() {
    var s = render('{% extends "base.html" %}' +
             '{% block block1 %}{{ super() }}BAR{% endblock %}');
    s.should.equal('FooBarBARBazFizzle');
  });

  it('should include templates', function() {
    var s = render('hello world {% include "include.html" %}');
    s.should.equal('hello world FooInclude ');

    s = render('hello world {% include "include.html" %}',
          { name: 'james' });
    s.should.equal('hello world FooInclude james');

    s = render('hello world {% include tmpl %}',
          { name: 'thedude', tmpl: "include.html" });
    s.should.equal('hello world FooInclude thedude');

    s = render('hello world {% include data.tmpl %}',
      { name: 'thedude', data: {tmpl: "include.html"} });
    s.should.equal('hello world FooInclude thedude');
  });

  it('should maintain nested scopes', function() {
    var s = render('{% for i in [1,2] %}' +
             '{% for i in [3,4] %}{{ i }}{% endfor %}' +
             '{{ i }}{% endfor %}');
    s.should.equal('341342');
  });

  it('should allow blocks in for loops', function() {
    var s = render('{% extends "base2.html" %}' +
             '{% block item %}hello{{ item }}{% endblock %}');
    s.should.equal('hello1hello2');
  });

  it('should make includes inherit scope', function() {
    var s = render('{% for item in [1,2] %}' +
             '{% include "item.html" %}' +
             '{% endfor %}');
    s.should.equal('showing 1showing 2');
  });

  it('should compile a set block', function() {
    var s = render('{% set username = "foo" %}{{ username }}',
             { username: 'james' });
    s.should.equal('foo');

    s = render('{% set x, y = "foo" %}{{ x }}{{ y }}');
    s.should.equal('foofoo');

    s = render('{% set x = 1 + 2 %}{{ x }}');
    s.should.equal('3');

    s = render('{% for i in [1] %}{% set foo=1 %}{% endfor %}{{ foo }}',
           { foo: 2 });
    s.should.equal('2');

    s = render('{% include "set.html" %}{{ foo }}',
           { foo: 'bar' });
    s.should.equal('bar');
  });

  it('should compile set with frame references', function() {
    var s = render('{% set username = user.name %}{{ username }}',
             { user: { name: 'james' } });
    s.should.equal('james');
  });

  it('should throw errors', function() {
    (function() {
      render('{% from "import.html" import boozle %}');
    }).should.throw(/cannot import 'boozle'/);
  });
});