tests/test_inheritance.py

# -*- coding: utf-8 -*-
"""
    unit test for the inheritance
    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

    :copyright: (c) 2009 by the Jinja Team.
    :license: BSD, see LICENSE for more details.
"""

from jinja2 import Environment, DictLoader
from jinja2.exceptions import TemplateSyntaxError


LAYOUTTEMPLATE = '''\
|{% block block1 %}block 1 from layout{% endblock %}
|{% block block2 %}block 2 from layout{% endblock %}
|{% block block3 %}
{% block block4 %}nested block 4 from layout{% endblock %}
{% endblock %}|'''

LEVEL1TEMPLATE = '''\
{% extends "layout" %}
{% block block1 %}block 1 from level1{% endblock %}'''

LEVEL2TEMPLATE = '''\
{% extends "level1" %}
{% block block2 %}{% block block5 %}nested block 5 from level2{%
endblock %}{% endblock %}'''

LEVEL3TEMPLATE = '''\
{% extends "level2" %}
{% block block5 %}block 5 from level3{% endblock %}
{% block block4 %}block 4 from level3{% endblock %}
'''

LEVEL4TEMPLATE = '''\
{% extends "level3" %}
{% block block3 %}block 3 from level4{% endblock %}
'''

WORKINGTEMPLATE = '''\
{% extends "layout" %}
{% block block1 %}
  {% if false %}
    {% block block2 %}
      this should workd
    {% endblock %}
  {% endif %}
{% endblock %}
'''

env = Environment(loader=DictLoader({
    'layout':       LAYOUTTEMPLATE,
    'level1':       LEVEL1TEMPLATE,
    'level2':       LEVEL2TEMPLATE,
    'level3':       LEVEL3TEMPLATE,
    'level4':       LEVEL4TEMPLATE,
    'working':      WORKINGTEMPLATE
}), trim_blocks=True)

def test_layout():
    tmpl = env.get_template('layout')
    assert tmpl.render() == ('|block 1 from layout|block 2 from '
                             'layout|nested block 4 from layout|')


def test_level1():
    tmpl = env.get_template('level1')
    assert tmpl.render() == ('|block 1 from level1|block 2 from '
                             'layout|nested block 4 from layout|')


def test_level2():
    tmpl = env.get_template('level2')
    assert tmpl.render() == ('|block 1 from level1|nested block 5 from '
                             'level2|nested block 4 from layout|')


def test_level3():
    tmpl = env.get_template('level3')
    assert tmpl.render() == ('|block 1 from level1|block 5 from level3|'
                             'block 4 from level3|')


def test_level4():
    tmpl = env.get_template('level4')
    assert tmpl.render() == ('|block 1 from level1|block 5 from '
                             'level3|block 3 from level4|')


def test_super():
    env = Environment(loader=DictLoader({
        'a': '{% block intro %}INTRO{% endblock %}|'
             'BEFORE|{% block data %}INNER{% endblock %}|AFTER',
        'b': '{% extends "a" %}{% block data %}({{ '
             'super() }}){% endblock %}',
        'c': '{% extends "b" %}{% block intro %}--{{ '
             'super() }}--{% endblock %}\n{% block data '
             '%}[{{ super() }}]{% endblock %}'
    }))
    tmpl = env.get_template('c')
    assert tmpl.render() == '--INTRO--|BEFORE|[(INNER)]|AFTER'


def test_working():
    tmpl = env.get_template('working')


def test_reuse_blocks():
    tmpl = env.from_string('{{ self.foo() }}|{% block foo %}42{% endblock %}|{{ self.foo() }}')
    assert tmpl.render() == '42|42|42'


def test_preserve_blocks():
    env = Environment(loader=DictLoader({
        'a': '{% if false %}{% block x %}A{% endblock %}{% endif %}{{ self.x() }}',
        'b': '{% extends "a" %}{% block x %}B{{ super() }}{% endblock %}'
    }))
    tmpl = env.get_template('b')
    assert tmpl.render() == 'BA'


def test_dynamic_inheritance():
    env = Environment(loader=DictLoader({
        'master1': 'MASTER1{% block x %}{% endblock %}',
        'master2': 'MASTER2{% block x %}{% endblock %}',
        'child': '{% extends master %}{% block x %}CHILD{% endblock %}'
    }))
    tmpl = env.get_template('child')
    for m in range(1, 3):
        assert tmpl.render(master='master%d' % m) == 'MASTER%dCHILD' % m


def test_multi_inheritance():
    env = Environment(loader=DictLoader({
        'master1': 'MASTER1{% block x %}{% endblock %}',
        'master2': 'MASTER2{% block x %}{% endblock %}',
        'child': '''{% if master %}{% extends master %}{% else %}{% extends
                    'master1' %}{% endif %}{% block x %}CHILD{% endblock %}'''
    }))
    tmpl = env.get_template('child')
    assert tmpl.render(master='master2') == 'MASTER2CHILD'
    assert tmpl.render(master='master1') == 'MASTER1CHILD'
    assert tmpl.render() == 'MASTER1CHILD'


def test_fixed_macro_scoping_bug():
    assert Environment(loader=DictLoader({
        'test.html': '''\
    {% extends 'details.html' %}

    {% macro my_macro() %}
    my_macro
    {% endmacro %}

    {% block inner_box %}
        {{ my_macro() }}
    {% endblock %}
        ''',
        'details.html': '''\
    {% extends 'standard.html' %}

    {% macro my_macro() %}
    my_macro
    {% endmacro %}

    {% block content %}
        {% block outer_box %}
            outer_box
            {% block inner_box %}
                inner_box
            {% endblock %}
        {% endblock %}
    {% endblock %}
    ''',
        'standard.html': '''
    {% block content %} {% endblock %}
    '''
    })).get_template("test.html").render().split() == [u'outer_box', u'my_macro']


def test_scoped_block():
    env = Environment(loader=DictLoader({
        'master.html': '{% for item in seq %}[{% block item scoped %}'
                       '{% endblock %}]{% endfor %}'
    }))
    t = env.from_string('{% extends "master.html" %}{% block item %}{{ item }}{% endblock %}')
    assert t.render(seq=range(5)) == '[0][1][2][3][4]'


def test_super_in_scoped_block():
    env = Environment(loader=DictLoader({
        'master.html': '{% for item in seq %}[{% block item scoped %}'
                       '{{ item }}{% endblock %}]{% endfor %}'
    }))
    t = env.from_string('{% extends "master.html" %}{% block item %}{{ super() }}|{{ item * 2 }}{% endblock %}')
    assert t.render(seq=range(5)) == '[0|0][1|2][2|4][3|6][4|8]'