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
|
{-# LANGUAGE OverloadedStrings #-}
{- |
Module : Tests.Readers.Org.Directive
Copyright : © 2014-2023 Albert Krewinkel
License : GNU GPL, version 2 or above
Maintainer : Albert Krewinkel <albert@zeitkraut.de>
Stability : alpha
Portability : portable
Tests parsing of org directives (like @#+OPTIONS@).
-}
module Tests.Readers.Org.Directive (tests) where
import Data.Time (UTCTime (UTCTime), secondsToDiffTime)
import Data.Time.Calendar (Day (ModifiedJulianDay))
import Test.Tasty (TestTree, testGroup)
import Tests.Helpers ((=?>), ToString, purely, test)
import Tests.Readers.Org.Shared ((=:), tagSpan)
import Text.Pandoc
import Text.Pandoc.Builder
import qualified Data.ByteString as BS
import qualified Data.Text as T
testWithFiles :: (ToString c)
=> [(FilePath, BS.ByteString)]
-> String -- ^ name of test case
-> (T.Text, c) -- ^ (input, expected value)
-> TestTree
testWithFiles fileDefs = test (orgWithFiles fileDefs)
orgWithFiles :: [(FilePath, BS.ByteString)] -> T.Text -> Pandoc
orgWithFiles fileDefs input =
let readOrg' = readOrg def{ readerExtensions = getDefaultExtensions "org" }
in flip purely input $ \inp -> do
modifyPureState (\st -> st { stFiles = files fileDefs })
readOrg' inp
files :: [(FilePath, BS.ByteString)] -> FileTree
files fileDefs =
let dummyTime = UTCTime (ModifiedJulianDay 125) (secondsToDiffTime 0)
in foldr (\(fp, bs) -> insertInFileTree fp (FileInfo dummyTime bs))
mempty fileDefs
tests :: [TestTree]
tests =
[ testGroup "export options"
[ "disable simple sub/superscript syntax" =:
T.unlines [ "#+OPTIONS: ^:nil"
, "a^b"
] =?>
para "a^b"
, "directly select drawers to be exported" =:
T.unlines [ "#+OPTIONS: d:(\"IMPORTANT\")"
, ":IMPORTANT:"
, "23"
, ":END:"
, ":BORING:"
, "very boring"
, ":END:"
] =?>
divWith (mempty, ["IMPORTANT", "drawer"], mempty) (para "23")
, "exclude drawers from being exported" =:
T.unlines [ "#+OPTIONS: d:(not \"BORING\")"
, ":IMPORTANT:"
, "5"
, ":END:"
, ":BORING:"
, "very boring"
, ":END:"
] =?>
divWith (mempty, ["IMPORTANT", "drawer"], mempty) (para "5")
, "don't include archive trees" =:
T.unlines [ "#+OPTIONS: arch:nil"
, "* old :ARCHIVE:"
] =?>
(mempty ::Blocks)
, "include complete archive trees" =:
T.unlines [ "#+OPTIONS: arch:t"
, "* old :ARCHIVE:"
, " boring"
] =?>
mconcat [ headerWith ("old", [], mempty) 1
("old" <> space <> tagSpan "ARCHIVE")
, para "boring"
]
, "include archive tree header only" =:
T.unlines [ "#+OPTIONS: arch:headline"
, "* old :ARCHIVE:"
, " boring"
] =?>
headerWith ("old", [], mempty) 1 ("old" <> space <> tagSpan "ARCHIVE")
, "limit headline depth" =:
T.unlines [ "#+OPTIONS: H:2"
, "* top-level section"
, "** subsection"
, "*** list item 1"
, "*** list item 2"
] =?>
mconcat [ headerWith ("top-level-section", [], []) 1 "top-level section"
, headerWith ("subsection", [], []) 2 "subsection"
, orderedList [ para "list item 1", para "list item 2" ]
]
, "turn all headlines into lists" =:
T.unlines [ "#+OPTIONS: H:0"
, "first block"
, "* top-level section 1"
, "** subsection"
, "* top-level section 2"
] =?>
mconcat [ para "first block"
, orderedList
[ para "top-level section 1" <>
orderedList [ para "subsection" ]
, para "top-level section 2" ]
]
, "preserve linebreaks as hard breaks" =:
T.unlines [ "#+OPTIONS: \\n:t"
, "first"
, "second"
] =?>
para ("first" <> linebreak <> "second")
, "disable author export" =:
T.unlines [ "#+OPTIONS: author:nil"
, "#+AUTHOR: ShyGuy"
] =?>
Pandoc nullMeta mempty
, "disable creator export" =:
T.unlines [ "#+OPTIONS: creator:nil"
, "#+creator: The Architect"
] =?>
Pandoc nullMeta mempty
, "disable email export" =:
T.unlines [ "#+OPTIONS: email:nil"
, "#+email: no-mail-please@example.com"
] =?>
Pandoc nullMeta mempty
, "disable MathML-like entities" =:
T.unlines [ "#+OPTIONS: e:nil"
, "Icelandic letter: \\thorn"
] =?>
para "Icelandic letter: \\thorn"
, testGroup "Option f"
[ "disable inline footnotes" =:
T.unlines [ "#+OPTIONS: f:nil"
, "Funny![fn:funny:or not]"
] =?>
para "Funny!"
, "disable reference footnotes" =:
T.unlines [ "#+OPTIONS: f:nil"
, "Burn everything[fn:1] down!"
, ""
, "[fn:2] Not quite everything."
] =?>
para "Burn everything down!"
]
, "disable inclusion of todo keywords" =:
T.unlines [ "#+OPTIONS: todo:nil"
, "** DONE todo export"
] =?>
headerWith ("todo-export", [], []) 2 "todo export"
, "remove tags from headlines" =:
T.unlines [ "#+OPTIONS: tags:nil"
, "* Headline :hello:world:"
] =?>
headerWith ("headline", [], mempty) 1 "Headline"
, testGroup "LaTeX"
[ testGroup "Include LaTeX fragments"
[ "Inline command" =:
T.unlines [ "#+OPTIONS: tex:t"
, "Hello \\emph{Name}"
] =?>
para ("Hello" <> space <> emph "Name")
, "Alpha" =:
T.unlines [ "#+OPTIONS: tex:t"
, "\\alpha"
] =?>
para "α"
, "equation environment" =:
T.unlines [ "#+OPTIONS: tex:t"
, "\\begin{equation}"
, "f(x) = x^2"
, "\\end{equation}"
] =?>
rawBlock "latex" (T.unlines [ "\\begin{equation}"
, "f(x) = x^2"
, "\\end{equation}"
])
]
, testGroup "Ignore LaTeX fragments"
[ "Inline command" =:
T.unlines [ "#+OPTIONS: tex:nil"
, "Hello \\emph{Emphasised}"
] =?>
para "Hello"
, "MathML symbol (alpha)" =:
T.unlines [ "#+OPTIONS: tex:nil"
, "\\alpha"
] =?>
para "α"
, "equation environment" =:
T.unlines [ "#+OPTIONS: tex:nil"
, "\\begin{equation}"
, "f(x) = x^2"
, "\\end{equation}"
] =?>
(mempty :: Blocks)
]
, testGroup "Verbatim LaTeX"
[ "Inline command" =:
T.unlines [ "#+OPTIONS: tex:verbatim"
, "Hello \\emph{Emphasised}"
] =?>
para "Hello \\emph{Emphasised}"
, "MathML symbol (alpha)" =:
T.unlines [ "#+OPTIONS: tex:verbatim"
, "\\alpha"
] =?>
para "α"
, "equation environment" =:
T.unlines [ "#+OPTIONS: tex:verbatim"
, "\\begin{equation}"
, "f(x) = x^2"
, "\\end{equation}"
] =?>
para (str "\\begin{equation}" <> softbreak <>
text "f(x) = x^2" <> softbreak <>
str "\\end{equation}")
]
]
, testGroup "planning information"
[ "include planning info after headlines" =:
T.unlines [ "#+OPTIONS: p:t"
, "* important"
, " DEADLINE: <2018-10-01 Mon> SCHEDULED: <2018-09-15 Sat>"
] =?>
mconcat [ headerWith ("important", mempty, mempty) 1 "important"
, plain $ strong "DEADLINE:"
<> space
<> emph (str "<2018-10-01 Mon>")
<> space
<> strong "SCHEDULED:"
<> space
<> emph (str "<2018-09-15 Sat>")
]
, "empty planning info is not included" =:
T.unlines [ "#+OPTIONS: p:t"
, "* Wichtig"
] =?>
headerWith ("wichtig", mempty, mempty) 1 "Wichtig"
]
, testGroup "Option |"
[ "disable export of tables" =:
T.unlines [ "#+OPTIONS: |:nil"
, "| chair |"
] =?>
(mempty :: Blocks)
]
, testGroup "unknown options"
[ "unknown options are ignored" =:
T.unlines [ "#+OPTIONS: does-not-exist:t "] =?>
(mempty :: Pandoc)
, "highlighting after unknown option" =:
T.unlines [ "#+OPTIONS: nope"
, "/yup/"
] =?>
para (emph "yup")
, "unknown option interleaved with known" =:
T.unlines [ "#+OPTIONS: tags:nil foo:bar todo:nil"
, "* DONE ignore things :easy:"
] =?>
headerWith ("ignore-things", [], mempty) 1 "ignore things"
]
]
, testGroup "Include"
[ testWithFiles [("./other.org", "content of other file\n")]
"file inclusion"
(T.unlines [ "#+include: \"other.org\"" ] =?>
plain "content of other file")
, testWithFiles [("./world.org", "World\n\n")]
"Included file belongs to item"
(T.unlines [ "- Hello,\n #+include: \"world.org\"" ] =?>
bulletList [para "Hello," <> para "World"])
, testWithFiles [("./level3.org", "*** Level3\n\n")]
"Default include preserves level"
(T.unlines [ "#+include: \"level3.org\"" ] =?>
headerWith ("level3", [], []) 3 "Level3")
, testWithFiles [("./level3.org", "*** Level3\n\n")]
"Minlevel shifts level leftward"
(T.unlines [ "#+include: \"level3.org\" :minlevel 1" ] =?>
headerWith ("level3", [], []) 1 "Level3")
, testWithFiles [("./level1.org", "* Level1\n\n")]
"Minlevel shifts level rightward"
(T.unlines [ "#+include: \"level1.org\" :minlevel 3" ] =?>
headerWith ("level1", [], []) 3 "Level1")
, testWithFiles [("./src.hs", "putStrLn outString\n")]
"Include file as source code snippet"
(T.unlines [ "#+include: \"src.hs\" src haskell" ] =?>
codeBlockWith ("", ["haskell"], []) "putStrLn outString\n")
, testWithFiles [("./export-latex.org", "\\emph{Hello}\n")]
"Include file as export snippet"
(T.unlines [ "#+include: \"export-latex.org\" export latex" ] =?>
rawBlock "latex" "\\emph{Hello}\n")
, testWithFiles [("./subdir/foo-bar.latex", "foo\n"),
("./hello.lisp", "(print \"Hello!\")\n")
]
"include directive is limited to one line"
(T.unlines [ "#+INCLUDE: \"hello.lisp\" src lisp"
, "#+include: \"subdir/foo-bar.latex\" export latex"
, "bar"
] =?>
mconcat
[ codeBlockWith ("", ["lisp"], []) "(print \"Hello!\")\n"
, rawBlock "latex" "foo\n"
, para "bar"
]
)
]
]
|
