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
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
|
module Tests.Writers.Muse (tests) where
import Data.Text (unpack)
import Test.Tasty
import Tests.Helpers
import Text.Pandoc
import Text.Pandoc.Arbitrary ()
import Text.Pandoc.Builder
muse :: (ToPandoc a) => a -> String
muse = museWithOpts def{ writerWrapText = WrapNone,
writerExtensions = extensionsFromList [Ext_amuse,
Ext_auto_identifiers] }
museWithOpts :: (ToPandoc a) => WriterOptions -> a -> String
museWithOpts opts = unpack . purely (writeMuse opts) . toPandoc
infix 4 =:
(=:) :: (ToString a, ToPandoc a)
=> String -> (a, String) -> TestTree
(=:) = test muse
tests :: [TestTree]
tests = [ testGroup "block elements"
[ "plain" =: plain (text "Foo bar.") =?> "Foo bar."
, testGroup "paragraphs"
[ "single paragraph" =: para (text "Sample paragraph.")
=?> "Sample paragraph."
, "two paragraphs" =: para (text "First paragraph.") <>
para (text "Second paragraph.")
=?> unlines [ "First paragraph."
, ""
, "Second paragraph."
]
]
, "line block" =: lineBlock [text "Foo", text "bar", text "baz"]
=?> unlines [ "> Foo"
, "> bar"
, "> baz"
]
, "code block" =: codeBlock "int main(void) {\n\treturn 0;\n}"
=?> unlines [ "<example>"
, "int main(void) {"
, "\treturn 0;"
, "}"
, "</example>"
]
, "html raw block" =: rawBlock "html" "<hr>"
=?> unlines [ "<literal style=\"html\">"
, "<hr>"
, "</literal>"
]
, "block quote" =: blockQuote (para (text "Foo"))
=?> unlines [ "<quote>"
, "Foo"
, "</quote>"
]
, testGroup "lists"
[ testGroup "simple lists"
[
"ordered list" =: orderedList [ plain $ text "first"
, plain $ text "second"
, plain $ text "third"
]
=?> unlines [ " 1. first"
, " 2. second"
, " 3. third"
]
, "ordered list with Roman numerals"
=: orderedListWith (1, UpperRoman, DefaultDelim)
[ plain $ text "first"
, plain $ text "second"
, plain $ text "third"
]
=?> unlines [ " I. first"
, " II. second"
, " III. third"
]
, "bullet list" =: bulletList [ plain $ text "first"
, plain $ text "second"
, plain $ text "third"
]
=?> unlines [ " - first"
, " - second"
, " - third"
]
, "definition list" =: definitionList [ (text "first definition", [plain $ text "first description"])
, (text "second definition", [plain $ text "second description"])
, (text "third definition", [plain $ text "third description"])
]
=?> unlines [ " first definition :: first description"
, " second definition :: second description"
, " third definition :: third description"
]
, "definition list with multiple descriptions" =:
definitionList [ (text "first definition", [plain $ text "first description"
,plain $ text "second description"])
, (text "second definition", [plain $ text "third description"])
]
=?> unlines [ " first definition :: first description"
, " :: second description"
, " second definition :: third description"
]
, "definition list with empty term" =:
definitionList [ (text "first definition", [plain $ text "first description"])
, (mempty, [plain $ text "second description"])
, (str "", [plain $ text "third description"])
]
=?> unlines [ " first definition :: first description"
, " <verbatim></verbatim> :: second description"
, " <verbatim></verbatim> :: third description"
]
]
-- Test that lists of the same type and style are separated with two blanklines
, testGroup "sequential lists"
[ "bullet lists" =:
bulletList [ para $ text "First"
, para $ text "Second"
, para $ text "Third"
] <>
bulletList [ para $ text "Fourth"
, para $ text "Fifth"
] =?>
unlines [ " - First"
, " - Second"
, " - Third"
, ""
, ""
, " - Fourth"
, " - Fifth"
]
, "ordered lists of the same style" =:
orderedListWith (1, UpperRoman, DefaultDelim) [ para $ text "First"
, para $ text "Second"
] <>
orderedListWith (1, UpperRoman, DefaultDelim) [ para $ text "Third"
, para $ text "Fourth"
] =?>
unlines [ " I. First"
, " II. Second"
, ""
, ""
, " I. Third"
, " II. Fourth"
]
, "ordered lists with equal styles" =:
orderedList [ para $ text "First"
, para $ text "Second"
] <>
orderedListWith (1, Decimal, DefaultDelim) [ para $ text "Third"
, para $ text "Fourth"
] =?>
unlines [ " 1. First"
, " 2. Second"
, ""
, ""
, " 1. Third"
, " 2. Fourth"
]
, "bullet and ordered lists" =:
bulletList [ para $ text "First"
, para $ text "Second"
] <>
orderedListWith (1, UpperRoman, DefaultDelim) [ para $ text "Third"
, para $ text "Fourth"
] =?>
unlines [ " - First"
, " - Second"
, ""
, " I. Third"
, " II. Fourth"
]
, "different style ordered lists" =:
orderedListWith (1, UpperRoman, DefaultDelim) [ para $ text "First"
, para $ text "Second"
] <>
orderedListWith (1, Decimal, DefaultDelim) [ para $ text "Third"
, para $ text "Fourth"
] =?>
unlines [ " I. First"
, " II. Second"
, ""
, " 1. Third"
, " 2. Fourth"
]
]
, testGroup "nested lists"
[ "nested ordered list" =: orderedList [ plain $ text "First outer"
, plain (text "Second outer:") <>
orderedList [ plain $ text "first"
, plain $ text "second"
]
, plain $ text "Third outer"
]
=?> unlines [ " 1. First outer"
, " 2. Second outer:"
, " 1. first"
, " 2. second"
, " 3. Third outer"
]
, "nested bullet lists" =: bulletList [ plain $ text "First outer"
, plain (text "Second outer:") <>
bulletList [ plain $ text "first"
, plain $ text "second"
]
, plain $ text "Third outer"
]
=?> unlines [ " - First outer"
, " - Second outer:"
, " - first"
, " - second"
, " - Third outer"
]
, "nested definition lists" =: definitionList [ (text "first definition", [plain $ text "first description"])
, (text "second definition",
[ plain (text "second description") <>
definitionList [ ( text "first inner definition"
, [plain $ text "first inner description"])
, ( text "second inner definition"
, [plain $ text "second inner description"])
]
]
)
]
=?> unlines [ " first definition :: first description"
, " second definition :: second description"
, " first inner definition :: first inner description"
, " second inner definition :: second inner description"
]
]
-- Check that list is intended with one space even inside a quote
, "List inside block quote" =: blockQuote (orderedList [ plain $ text "first"
, plain $ text "second"
, plain $ text "third"
])
=?> unlines [ "<quote>"
, " 1. first"
, " 2. second"
, " 3. third"
, "</quote>"
]
]
, testGroup "headings"
[ "normal heading" =:
header 1 (text "foo") =?> "* foo"
, "heading levels" =:
header 1 (text "First level") <>
header 3 (text "Third level") =?>
unlines [ "* First level"
, ""
, "*** Third level"
]
, "heading with ID" =:
headerWith ("bar", [], []) 2 (text "Foo") =?>
unlines [ "** Foo"
, "#bar"
]
]
, "horizontal rule" =: horizontalRule =?> "----"
, "escape horizontal rule" =: para (text "----") =?> "<verbatim>----</verbatim>"
, "escape nonbreaking space" =: para (text "~~") =?> "<verbatim>~~</verbatim>"
, testGroup "tables"
[ "table without header" =:
let rows = [[para $ text "Para 1.1", para $ text "Para 1.2"]
,[para $ text "Para 2.1", para $ text "Para 2.2"]]
in simpleTable [] rows
=?>
unlines [ " Para 1.1 | Para 1.2"
, " Para 2.1 | Para 2.2"
]
, "table with header" =:
let headers = [plain $ text "header 1", plain $ text "header 2"]
rows = [[para $ text "Para 1.1", para $ text "Para 1.2"]
,[para $ text "Para 2.1", para $ text "Para 2.2"]]
in simpleTable headers rows
=?>
unlines [ " header 1 || header 2"
, " Para 1.1 | Para 1.2"
, " Para 2.1 | Para 2.2"
]
, "table with header and caption" =:
let caption = text "Table 1"
headers = [plain $ text "header 1", plain $ text "header 2"]
rows = [[para $ text "Para 1.1", para $ text "Para 1.2"]
,[para $ text "Para 2.1", para $ text "Para 2.2"]]
in table caption mempty headers rows
=?> unlines [ " header 1 || header 2"
, " Para 1.1 | Para 1.2"
, " Para 2.1 | Para 2.2"
, " |+ Table 1 +|"
]
]
, "div with bullet list" =:
divWith nullAttr (bulletList [para $ text "foo"]) =?>
unlines [ " - foo" ] -- Making sure bullets are indented
-- Null is trivial
]
, testGroup "inline elements"
[ testGroup "string"
[ "string" =: str "foo" =?> "foo"
, "escape footnote" =: str "[1]" =?> "<verbatim>[1]</verbatim>"
, "escape verbatim close tag" =: str "foo</verbatim>bar"
=?> "<verbatim>foo<</verbatim><verbatim>/verbatim>bar</verbatim>"
, "escape pipe to avoid accidental tables" =: str "foo | bar"
=?> "<verbatim>foo | bar</verbatim>"
, "escape hash to avoid accidental anchors" =: text "#foo bar"
=?> "<verbatim>#foo</verbatim> bar"
, "escape definition list markers" =: str "::" =?> "<verbatim>::</verbatim>"
, "normalize strings before escaping" =: fromList [Str ":", Str ":"] =?> "<verbatim>::</verbatim>"
-- We don't want colons to be escaped if they can't be confused
-- with definition list item markers.
, "do not escape colon" =: str ":" =?> ":"
, "escape - to avoid accidental unordered lists" =: text " - foo" =?> " <verbatim>-</verbatim> foo"
, "escape - inside a list to avoid accidental nested unordered lists" =:
bulletList [ (para $ text "foo") <>
(para $ text "- bar")
] =?>
unlines [ " - foo"
, ""
, " <verbatim>-</verbatim> bar"
]
]
, testGroup "emphasis"
[ "emph" =: emph (text "foo") =?> "<em>foo</em>"
, "strong" =: strong (text "foo") =?> "<strong>foo</strong>"
, "strikeout" =: strikeout (text "foo") =?> "<del>foo</del>"
]
, "superscript" =: superscript (text "foo") =?> "<sup>foo</sup>"
, "subscript" =: subscript (text "foo") =?> "<sub>foo</sub>"
, "smallcaps" =: smallcaps (text "foo") =?> "<em>foo</em>"
, "smallcaps near emphasis" =: emph (str "foo") <> smallcaps (str "bar") =?> "<em>foobar</em>"
, "single quoted" =: singleQuoted (text "foo") =?> "‘foo’"
, "double quoted" =: doubleQuoted (text "foo") =?> "“foo”"
-- Cite is trivial
, testGroup "code"
[ "simple" =: code "foo" =?> "<code>foo</code>"
, "escape tag" =: code "<code>foo = bar</code> baz" =?> "<code><code>foo = bar<</code><code>/code> baz</code>"
, "normalization with attributes" =: codeWith ("",["haskell"],[]) "foo" <> code "bar" =?> "<code>foobar</code>"
, "normalization" =: code "</co" <> code "de>" =?> "<code><</code><code>/code></code>"
, "normalization with empty string" =: code "</co" <> str "" <> code "de>" =?> "<code><</code><code>/code></code>"
]
, testGroup "spaces"
[ "space" =: text "a" <> space <> text "b" =?> "a b"
, "soft break" =: text "a" <> softbreak <> text "b" =?> "a b"
, test (museWithOpts def{ writerWrapText = WrapPreserve })
"preserve soft break" $ text "a" <> softbreak <> text "b"
=?> "a\nb"
, "line break" =: text "a" <> linebreak <> text "b" =?> "a<br>\nb"
]
, testGroup "math"
[ "inline math" =: math "2^3" =?> "2<sup>3</sup>"
, "display math" =: displayMath "2^3" =?> "2<sup>3</sup>"
, "multiple letters in inline math" =: math "abc" =?> "<em>abc</em>"
, "expand math before normalization" =: math "[" <> str "2]" =?> "<verbatim>[2]</verbatim>"
, "multiple math expressions inside one inline list" =: math "5_4" <> text ", " <> displayMath "3^2" =?> "5<sub>4</sub>, 3<sup>2</sup>"
]
, "raw inline"
=: rawInline "html" "<mark>marked text</mark>"
=?> "<literal style=\"html\"><mark>marked text</mark></literal>"
, testGroup "links"
[ "link with description" =: link "https://example.com" "" (str "Link 1")
=?> "[[https://example.com][Link 1]]"
, "link without description" =: link "https://example.com" "" (str "https://example.com")
=?> "[[https://example.com]]"
-- Internal links in Muse include '#'
, "link to anchor" =: link "#intro" "" (str "Introduction")
=?> "[[#intro][Introduction]]"
-- According to Emacs Muse manual, links to images should be prefixed with "URL:"
, "link to image with description" =: link "1.png" "" (str "Link to image")
=?> "[[URL:1.png][Link to image]]"
, "link to image without description" =: link "1.png" "" (str "1.png")
=?> "[[URL:1.png]]"
]
, "image" =: image "image.png" "Image 1" (str "") =?> "[[image.png][Image 1]]"
, "image with width" =:
imageWith ("", [], [("width", "60%")]) "image.png" "Image" (str "") =?>
"[[image.png 60][Image]]"
, "note" =: note (plain (text "Foo"))
=?> unlines [ "[1]"
, ""
, "[1] Foo"
]
, "span" =: spanWith ("",["foobar"],[]) (str "Some text")
=?> "<class name=\"foobar\">Some text</class>"
, testGroup "combined"
[ "emph word before" =:
para (text "foo" <> emph (text "bar")) =?>
"foo<em>bar</em>"
, "emph word after" =:
para (emph (text "foo") <> text "bar") =?>
"<em>foo</em>bar"
, "emph quoted" =:
para (doubleQuoted (emph (text "foo"))) =?>
"“<em>foo</em>”"
, "strong word before" =:
para (text "foo" <> strong (text "bar")) =?>
"foo<strong>bar</strong>"
, "strong word after" =:
para (strong (text "foo") <> text "bar") =?>
"<strong>foo</strong>bar"
, "strong quoted" =:
para (singleQuoted (strong (text "foo"))) =?>
"‘<strong>foo</strong>’"
]
]
]
|
