summaryrefslogtreecommitdiff
path: root/tests/test_directive_code.py
blob: f2f64970bccc2ac96e54fdc46dfc632165932194 (plain)
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
# -*- coding: utf-8 -*-
"""
    test_directive_code
    ~~~~~~~~~~~~~~~~~~~

    Test the code-block directive.

    :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS.
    :license: BSD, see LICENSE for details.
"""

import re
from xml.etree import ElementTree

from util import with_app, test_roots


def teardown_module():
    (test_roots / 'test-directive-code' / '_build').rmtree(True)


@with_app(buildername='xml',
          srcdir=(test_roots / 'test-directive-code'),
          _copy_to_temp=True)
def test_code_block(app):
    app.builder.build('index')
    et = ElementTree.parse(app.outdir / 'index.xml')
    secs = et.findall('./section/section')
    code_block = secs[0].findall('literal_block')
    assert len(code_block) > 0
    actual = code_block[0].text
    expect = (
        "    def ruby?\n" +
        "        false\n" +
        "    end"
    )
    assert actual == expect


@with_app(buildername='xml',
          srcdir=(test_roots / 'test-directive-code'),
          _copy_to_temp=True)
def test_code_block_dedent(app):
    outdir = app.outdir

    def get_dedent_actual(dedent):
        dedent_text = (app.srcdir / 'dedent.rst').text(encoding='utf-8')
        dedent_text = re.sub(
            r':dedent: \d', ':dedent: %d' % dedent, dedent_text)
        (app.srcdir / 'dedent.rst').write_text(dedent_text, encoding='utf-8')

        # use another output dir to force rebuild
        app.outdir = outdir / str(dedent)
        app._init_env(freshenv=True)
        app._init_builder(app.builder.name)
        app.builder.build(['dedent'], method='specific')

        et = ElementTree.parse(app.outdir / 'dedent.xml')
        secs = et.findall('./section/section')
        code_block = secs[0].findall('literal_block')

        assert len(code_block) > 0
        actual = code_block[0].text
        return actual

    for i in range(5):  # 0-4
        actual = get_dedent_actual(i)
        indent = " " * (4 - i)
        expect = (
            indent + "def ruby?\n" +
            indent + "    false\n" +
            indent + "end"
        )
        assert (i, actual) == (i, expect)

    actual = get_dedent_actual(1000)
    assert actual == '\n\n'


@with_app(buildername='html',
          srcdir=(test_roots / 'test-directive-code'),
          _copy_to_temp=True)
def test_code_block_caption_html(app):
    app.builder.build('index')
    html = (app.outdir / 'caption.html').text()
    caption = '<div class="code-block-caption"><code>caption-test.rb</code></div>'
    assert caption in html


@with_app(buildername='latex',
          srcdir=(test_roots / 'test-directive-code'),
          _copy_to_temp=True)
def test_code_block_caption_latex(app):
    app.builder.build('index')
    latex = (app.outdir / 'Python.tex').text()
    caption = '\\caption{caption-test.rb}'
    assert caption in latex


@with_app(buildername='xml',
          srcdir=(test_roots / 'test-directive-code'),
          _copy_to_temp=True)
def test_literal_include(app):
    app.builder.build('index')
    et = ElementTree.parse(app.outdir / 'index.xml')
    secs = et.findall('./section/section')
    literal_include = secs[1].findall('literal_block')
    literal_src = (app.srcdir / 'literal.inc').text(encoding='utf-8')
    assert len(literal_include) > 0
    actual = literal_include[0].text
    assert actual == literal_src


@with_app(buildername='xml',
          srcdir=(test_roots / 'test-directive-code'),
          _copy_to_temp=True)
def test_literal_include_dedent(app):
    outdir = app.outdir
    literal_src = (app.srcdir / 'literal.inc').text(encoding='utf-8')
    literal_lines = [l[4:] for l in literal_src.split('\n')[9:11]]

    def get_dedent_actual(dedent):
        dedent_text = (app.srcdir / 'dedent.rst').text(encoding='utf-8')
        dedent_text = re.sub(
            r':dedent: \d', ':dedent: %d' % dedent, dedent_text)
        (app.srcdir / 'dedent.rst').write_text(dedent_text, encoding='utf-8')

        # use another output dir to force rebuild
        app.outdir = outdir / str(dedent)
        app._init_env(freshenv=True)
        app._init_builder(app.builder.name)
        app.builder.build(['dedent'])

        et = ElementTree.parse(app.outdir / 'dedent.xml')
        secs = et.findall('./section/section')
        literal_include = secs[1].findall('literal_block')

        assert len(literal_include) > 0
        actual = literal_include[0].text
        return actual


    for i in range(5):  # 0-4
        actual = get_dedent_actual(i)
        indent = " " * (4 - i)
        expect = '\n'.join(indent + l for l in literal_lines) + '\n'
        assert (i, actual) == (i, expect)


    actual = get_dedent_actual(1000)
    assert actual == '\n\n'


@with_app(buildername='html',
          srcdir=(test_roots / 'test-directive-code'),
          _copy_to_temp=True)
def test_literalinclude_caption_html(app):
    app.builder.build('index')
    html = (app.outdir / 'caption.html').text()
    caption = '<div class="code-block-caption"><code>caption-test.py</code></div>'
    assert caption in html


@with_app(buildername='latex',
          srcdir=(test_roots / 'test-directive-code'),
          _copy_to_temp=True)
def test_literalinclude_caption_latex(app):
    app.builder.build('index')
    latex = (app.outdir / 'Python.tex').text()
    caption = '\\caption{caption-test.py}'
    assert caption in latex