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
|
"""Tests for scriv/format_md.py."""
import collections
import textwrap
import pytest
from scriv.config import Config
from scriv.format_md import MdTools
@pytest.mark.parametrize(
"text, parsed",
[
# Comments are ignored, and the section headers found.
pytest.param(
"""\
<!--
Comments can be here
and here.
and here.
-->
# Added
- This thing was added.
And we liked it.
<!-- don't worry about this... -->
- Another thing we added.
<!--
More comments can be here
And here.
-->
""",
{
"Added": [
"- This thing was added.\n And we liked it.",
"- Another thing we added.",
]
},
id="comments_ignored",
),
# Multiple section headers.
pytest.param(
"""\
# Added
- This thing was added.
And we liked it.
# Fixed
- This thing was fixed.
- Another thing was fixed.
# Added
- Also added
this thing
that is very important.
""",
{
"Added": [
"- This thing was added.\n And we liked it.",
"- Also added\n this thing\n that is very important.",
],
"Fixed": [
"- This thing was fixed.",
"- Another thing was fixed.",
],
},
id="multiple_headers",
),
# Multiple section headers at a different level.
pytest.param(
"""\
### Added
- This thing was added.
And we liked it.
### Fixed or Something
- This thing was fixed.
- Another thing was fixed.
### Added
- Also added
this thing
that is very important.
""",
{
"Added": [
"- This thing was added.\n And we liked it.",
"- Also added\n this thing\n that is very important.",
],
"Fixed or Something": [
"- This thing was fixed.",
"- Another thing was fixed.",
],
},
id="multiple_headers_2",
),
# It's fine to have no header at all.
pytest.param(
"""\
- No header at all.
""",
{None: ["- No header at all."]},
id="no_header",
),
# It's fine to have comments with no header, and multiple bulllets.
pytest.param(
"""\
<!-- This is a scriv fragment. -->
- No header at all.
- Just plain bullets.
""",
{None: ["- No header at all.", "- Just plain bullets."]},
id="no_header_2",
),
# A file with only comments and blanks will produce nothing.
pytest.param(
"""\
<!-- Nothing to see here.
-->
<!-- Or here. -->
""",
{},
id="empty",
),
# Multiple levels of headings only splits on the top-most one.
pytest.param(
"""\
# The big title
Ignore this stuff
<!-- scriv-insert-here -->
(prelude)
<a id='sect-one.1'></a>
## Section one
### subhead
In the sub
### subhead 2
Also sub
<a id='sect-two.2'></a>
## Section two
In section two.
### subhead 3
s2s3
""",
{
None: ["(prelude)"],
"Section one": [
"### subhead",
"In the sub",
"### subhead 2",
"Also sub",
],
"Section two": [
"In section two.",
"### subhead 3\ns2s3",
],
},
id="multilevel",
),
],
)
def test_parse_text(text, parsed):
actual = MdTools().parse_text(textwrap.dedent(text))
assert actual == parsed
@pytest.mark.parametrize(
"sections, expected",
[
pytest.param(
[
(
"Added",
[
"- This thing was added.\n And we liked it.",
"- Also added\n this thing\n that is very important.",
],
),
(
"Fixed",
["- This thing was fixed.", "- Another thing was fixed."],
),
],
"""\
### Added
- This thing was added.
And we liked it.
- Also added
this thing
that is very important.
### Fixed
- This thing was fixed.
- Another thing was fixed.
""",
id="one",
),
pytest.param(
[
(
None,
[
"- This thing was added.\n And we liked it.",
"- Also added\n this thing\n that is very important.",
],
),
],
"""\
- This thing was added.
And we liked it.
- Also added
this thing
that is very important.
""",
id="two",
),
],
)
def test_format_sections(sections, expected):
sections = collections.OrderedDict(sections)
actual = MdTools(Config(md_header_level="2")).format_sections(sections)
assert actual == textwrap.dedent(expected)
@pytest.mark.parametrize(
"config_kwargs, text, fh_kwargs, result",
[
({}, "2020-07-26", {}, "\n# 2020-07-26\n"),
({"md_header_level": "3"}, "2020-07-26", {}, "\n### 2020-07-26\n"),
(
{},
"2022-04-03",
{"anchor": "here"},
"\n<a id='here'></a>\n# 2022-04-03\n",
),
],
)
def test_format_header(config_kwargs, text, fh_kwargs, result):
actual = MdTools(Config(**config_kwargs)).format_header(text, **fh_kwargs)
assert actual == result
def test_convert_to_markdown():
# Markdown's convert_to_markdown is a no-op.
md = "# Nonsense\ndoesn't matter\n- whatever ``more ** junk---"
converted = MdTools().convert_to_markdown(md)
assert converted == md
|
