test-org-export.el 53 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648
  1. ;;; test-org-export.el --- Tests for org-export.el
  2. ;; Copyright (C) 2012 Nicolas Goaziou
  3. ;; Author: Nicolas Goaziou <n.goaziou at gmail dot com>
  4. ;; Released under the GNU General Public License version 3
  5. ;; see: http://www.gnu.org/licenses/gpl-3.0.html
  6. ;;;; Comments
  7. ;;; Code:
  8. (unless (featurep 'org-export)
  9. (signal 'missing-test-dependency "org-export"))
  10. (defmacro org-test-with-backend (backend &rest body)
  11. "Execute body with an export back-end defined.
  12. BACKEND is the name of the back-end. BODY is the body to
  13. execute. The defined back-end simply returns parsed data as Org
  14. syntax."
  15. (declare (debug (form body)) (indent 1))
  16. `(let ((,(intern (format "org-%s-translate-alist" backend))
  17. ',(let (transcode-table)
  18. (dolist (type (append org-element-all-elements
  19. org-element-all-objects)
  20. transcode-table)
  21. (push
  22. (cons type
  23. (lambda (obj contents info)
  24. (funcall
  25. (intern (format "org-element-%s-interpreter" type))
  26. obj contents)))
  27. transcode-table)))))
  28. (progn ,@body)))
  29. (defmacro org-test-with-parsed-data (data &rest body)
  30. "Execute body with parsed data available.
  31. DATA is a string containing the data to be parsed. BODY is the
  32. body to execute. Parse tree is available under the `tree'
  33. variable, and communication channel under `info'.
  34. This function calls `org-export-collect-tree-properties'. As
  35. such, `:ignore-list' (for `org-element-map') and
  36. `:parse-tree' (for `org-export-get-genealogy') properties are
  37. already filled in `info'."
  38. (declare (debug (form body)) (indent 1))
  39. `(org-test-with-temp-text ,data
  40. (let* ((tree (org-element-parse-buffer))
  41. (info (org-export-collect-tree-properties
  42. tree (org-export-get-environment))))
  43. ,@body)))
  44. ;;; Internal Tests
  45. (ert-deftest test-org-export/bind-keyword ()
  46. "Test reading #+BIND: keywords."
  47. ;; Test with `org-export-all-BIND' set to t.
  48. (should
  49. (org-test-with-temp-text "#+BIND: variable value"
  50. (let ((org-export-allow-BIND t))
  51. (org-export--install-letbind-maybe)
  52. (eq variable 'value))))
  53. ;; Test with `org-export-all-BIND' set to nil.
  54. (should-not
  55. (org-test-with-temp-text "#+BIND: variable value"
  56. (let ((org-export-allow-BIND nil))
  57. (org-export--install-letbind-maybe)
  58. (boundp 'variable))))
  59. ;; Test with `org-export-all-BIND' set to 'confirm and
  60. ;; `org-export--allow-BIND-local' to t .
  61. (should
  62. (org-test-with-temp-text "#+BIND: variable value"
  63. (let ((org-export-allow-BIND 'confirm))
  64. (org-set-local 'org-export--allow-BIND-local t)
  65. (org-export--install-letbind-maybe)
  66. (eq variable 'value))))
  67. ;; Test with `org-export-all-BIND' set to 'confirm and
  68. ;; `org-export--allow-BIND-local' to nil.
  69. (should-not
  70. (org-test-with-temp-text "#+BIND: variable value"
  71. (let ((org-export-allow-BIND 'confirm))
  72. (org-set-local 'org-export--allow-BIND-local nil)
  73. (org-export--install-letbind-maybe)
  74. (boundp 'variable))))
  75. ;; BIND keywords are case-insensitive.
  76. (should
  77. (org-test-with-temp-text "#+bind: variable value"
  78. (let ((org-export-allow-BIND t))
  79. (org-export--install-letbind-maybe)
  80. (eq variable 'value)))))
  81. (ert-deftest test-org-export/parse-option-keyword ()
  82. "Test reading all standard #+OPTIONS: items."
  83. (should
  84. (equal
  85. (org-export--parse-option-keyword
  86. "H:1 num:t \\n:t timestamp:t arch:t author:t creator:t d:t email:t
  87. *:t e:t ::t f:t pri:t -:t ^:t toc:t |:t tags:t tasks:t <:t todo:t inline:nil
  88. stat:t")
  89. '(:headline-levels
  90. 1 :preserve-breaks t :section-numbers t :time-stamp-file t
  91. :with-archived-trees t :with-author t :with-creator t :with-drawers t
  92. :with-email t :with-emphasize t :with-entities t :with-fixed-width t
  93. :with-footnotes t :with-inlinetasks nil :with-priority t
  94. :with-special-strings t :with-statistics-cookies t :with-sub-superscript t
  95. :with-toc t :with-tables t :with-tags t :with-tasks t :with-timestamps t
  96. :with-todo-keywords t)))
  97. ;; Test some special values.
  98. (should
  99. (equal
  100. (org-export--parse-option-keyword
  101. "arch:headline creator:comment d:(\"TEST\")
  102. ^:{} toc:1 tags:not-in-toc tasks:todo num:2 <:active")
  103. '( :section-numbers
  104. 2
  105. :with-archived-trees headline :with-creator comment
  106. :with-drawers ("TEST") :with-sub-superscript {} :with-toc 1
  107. :with-tags not-in-toc :with-tasks todo :with-timestamps active))))
  108. (ert-deftest test-org-export/get-inbuffer-options ()
  109. "Test reading all standard export keywords."
  110. (should
  111. (equal
  112. (org-test-with-temp-text "#+AUTHOR: Me, Myself and I
  113. #+CREATOR: Idem
  114. #+DATE: Today
  115. #+DESCRIPTION: Testing
  116. #+DESCRIPTION: with two lines
  117. #+EMAIL: some@email.org
  118. #+EXCLUDE_TAGS: noexport invisible
  119. #+KEYWORDS: test
  120. #+LANGUAGE: en
  121. #+SELECT_TAGS: export
  122. #+TITLE: Some title
  123. #+TITLE: with spaces"
  124. (org-export--get-inbuffer-options))
  125. '(:author
  126. ("Me, Myself and I") :creator "Idem" :date ("Today")
  127. :description "Testing\nwith two lines" :email "some@email.org"
  128. :exclude-tags ("noexport" "invisible") :keywords "test" :language "en"
  129. :select-tags ("export") :title ("Some title with spaces")))))
  130. (ert-deftest test-org-export/get-subtree-options ()
  131. "Test setting options from headline's properties."
  132. ;; EXPORT_TITLE.
  133. (org-test-with-temp-text "#+TITLE: Title
  134. * Headline
  135. :PROPERTIES:
  136. :EXPORT_TITLE: Subtree Title
  137. :END:
  138. Paragraph"
  139. (forward-line)
  140. (should (equal (plist-get (org-export-get-environment nil t) :title)
  141. '("Subtree Title"))))
  142. :title
  143. '("subtree-title")
  144. ;; EXPORT_OPTIONS.
  145. (org-test-with-temp-text "#+OPTIONS: H:1
  146. * Headline
  147. :PROPERTIES:
  148. :EXPORT_OPTIONS: H:2
  149. :END:
  150. Paragraph"
  151. (forward-line)
  152. (should
  153. (= 2 (plist-get (org-export-get-environment nil t) :headline-levels))))
  154. ;; EXPORT_DATE.
  155. (org-test-with-temp-text "#+DATE: today
  156. * Headline
  157. :PROPERTIES:
  158. :EXPORT_DATE: 29-03-2012
  159. :END:
  160. Paragraph"
  161. (forward-line)
  162. (should (equal (plist-get (org-export-get-environment nil t) :date)
  163. '("29-03-2012"))))
  164. ;; Export properties are case-insensitive.
  165. (org-test-with-temp-text "* Headline
  166. :PROPERTIES:
  167. :EXPORT_Date: 29-03-2012
  168. :END:
  169. Paragraph"
  170. (should (equal (plist-get (org-export-get-environment nil t) :date)
  171. '("29-03-2012")))))
  172. (ert-deftest test-org-export/handle-options ()
  173. "Test if export options have an impact on output."
  174. ;; Test exclude tags.
  175. (org-test-with-temp-text "* Head1 :noexport:"
  176. (org-test-with-backend test
  177. (should
  178. (equal (org-export-as 'test nil nil nil '(:exclude-tags ("noexport")))
  179. ""))))
  180. ;; Test include tags.
  181. (org-test-with-temp-text "
  182. * Head1
  183. * Head2
  184. ** Sub-Head2.1 :export:
  185. *** Sub-Head2.1.1
  186. * Head2"
  187. (org-test-with-backend test
  188. (should
  189. (equal
  190. "* Head2\n** Sub-Head2.1 :export:\n*** Sub-Head2.1.1\n"
  191. (let ((org-tags-column 0))
  192. (org-export-as 'test nil nil nil '(:select-tags ("export"))))))))
  193. ;; Test mixing include tags and exclude tags.
  194. (org-test-with-temp-text "
  195. * Head1 :export:
  196. ** Sub-Head1 :noexport:
  197. ** Sub-Head2
  198. * Head2 :noexport:
  199. ** Sub-Head1 :export:"
  200. (org-test-with-backend test
  201. (should
  202. (string-match
  203. "\\* Head1[ \t]+:export:\n\\*\\* Sub-Head2\n"
  204. (org-export-as
  205. 'test nil nil nil
  206. '(:select-tags ("export") :exclude-tags ("noexport")))))))
  207. ;; Ignore tasks.
  208. (let ((org-todo-keywords '((sequence "TODO" "DONE"))))
  209. (org-test-with-temp-text "* TODO Head1"
  210. (org-test-with-backend test
  211. (should (equal (org-export-as 'test nil nil nil '(:with-tasks nil))
  212. "")))))
  213. (let ((org-todo-keywords '((sequence "TODO" "DONE"))))
  214. (org-test-with-temp-text "* TODO Head1"
  215. (org-test-with-backend test
  216. (should (equal (org-export-as 'test nil nil nil '(:with-tasks t))
  217. "* TODO Head1\n")))))
  218. ;; Archived tree.
  219. (org-test-with-temp-text "* Head1 :archive:"
  220. (let ((org-archive-tag "archive"))
  221. (org-test-with-backend test
  222. (should
  223. (equal (org-export-as 'test nil nil nil '(:with-archived-trees nil))
  224. "")))))
  225. (org-test-with-temp-text "* Head1 :archive:\nbody\n** Sub-head 2"
  226. (let ((org-archive-tag "archive"))
  227. (org-test-with-backend test
  228. (should
  229. (string-match
  230. "\\* Head1[ \t]+:archive:"
  231. (org-export-as 'test nil nil nil
  232. '(:with-archived-trees headline)))))))
  233. (org-test-with-temp-text "* Head1 :archive:"
  234. (let ((org-archive-tag "archive"))
  235. (org-test-with-backend test
  236. (should
  237. (string-match
  238. "\\`\\* Head1[ \t]+:archive:\n\\'"
  239. (org-export-as 'test nil nil nil '(:with-archived-trees t)))))))
  240. ;; Drawers.
  241. (let ((org-drawers '("TEST")))
  242. (org-test-with-temp-text ":TEST:\ncontents\n:END:"
  243. (org-test-with-backend test
  244. (should (equal (org-export-as 'test nil nil nil '(:with-drawers nil))
  245. ""))
  246. (should (equal (org-export-as 'test nil nil nil '(:with-drawers t))
  247. ":TEST:\ncontents\n:END:\n")))))
  248. (let ((org-drawers '("FOO" "BAR")))
  249. (org-test-with-temp-text ":FOO:\nkeep\n:END:\n:BAR:\nremove\n:END:"
  250. (org-test-with-backend test
  251. (should
  252. (equal (org-export-as 'test nil nil nil '(:with-drawers ("FOO")))
  253. ":FOO:\nkeep\n:END:\n")))))
  254. ;; Timestamps.
  255. (org-test-with-temp-text "[2012-04-29 sun. 10:45]<2012-04-29 sun. 10:45>"
  256. (org-test-with-backend test
  257. (should
  258. (equal (org-export-as 'test nil nil nil '(:with-timestamps t))
  259. "[2012-04-29 sun. 10:45]<2012-04-29 sun. 10:45>\n"))
  260. (should
  261. (equal (org-export-as 'test nil nil nil '(:with-timestamps nil)) ""))
  262. (should
  263. (equal (org-export-as 'test nil nil nil '(:with-timestamps active))
  264. "<2012-04-29 sun. 10:45>\n"))
  265. (should
  266. (equal (org-export-as 'test nil nil nil '(:with-timestamps inactive))
  267. "[2012-04-29 sun. 10:45]\n"))))
  268. ;; Clocks.
  269. (let ((org-clock-string "CLOCK:"))
  270. (org-test-with-temp-text "CLOCK: [2012-04-29 sun. 10:45]"
  271. (org-test-with-backend test
  272. (should
  273. (equal (org-export-as 'test nil nil nil '(:with-clocks t))
  274. "CLOCK: [2012-04-29 sun. 10:45]\n"))
  275. (should
  276. (equal (org-export-as 'test nil nil nil '(:with-clocks nil)) "")))))
  277. ;; Plannings.
  278. (let ((org-closed-string "CLOSED:"))
  279. (org-test-with-temp-text "CLOSED: [2012-04-29 sun. 10:45]"
  280. (org-test-with-backend test
  281. (should
  282. (equal (org-export-as 'test nil nil nil '(:with-plannings t))
  283. "CLOSED: [2012-04-29 sun. 10:45]\n"))
  284. (should
  285. (equal (org-export-as 'test nil nil nil '(:with-plannings nil))
  286. "")))))
  287. ;; Inlinetasks.
  288. (when (featurep 'org-inlinetask)
  289. (should
  290. (equal
  291. (let ((org-inlinetask-min-level 15))
  292. (org-test-with-temp-text "*************** Task"
  293. (org-test-with-backend test
  294. (org-export-as 'test nil nil nil '(:with-inlinetasks nil)))))
  295. ""))
  296. (should
  297. (equal
  298. (let ((org-inlinetask-min-level 15))
  299. (org-test-with-temp-text
  300. "*************** Task\nContents\n*************** END"
  301. (org-test-with-backend test
  302. (org-export-as 'test nil nil nil '(:with-inlinetasks nil)))))
  303. "")))
  304. ;; Statistics cookies.
  305. (should
  306. (equal ""
  307. (org-test-with-temp-text "[0/0]"
  308. (org-test-with-backend test
  309. (org-export-as
  310. 'test nil nil nil '(:with-statistics-cookies nil)))))))
  311. (ert-deftest test-org-export/comment-tree ()
  312. "Test if export process ignores commented trees."
  313. (let ((org-comment-string "COMMENT"))
  314. (org-test-with-temp-text "* COMMENT Head1"
  315. (org-test-with-backend test
  316. (should (equal (org-export-as 'test) ""))))))
  317. (ert-deftest test-org-export/export-scope ()
  318. "Test all export scopes."
  319. (org-test-with-temp-text "
  320. * Head1
  321. ** Head2
  322. text
  323. *** Head3"
  324. (org-test-with-backend test
  325. ;; Subtree.
  326. (forward-line 3)
  327. (should (equal (org-export-as 'test 'subtree) "text\n*** Head3\n"))
  328. ;; Visible.
  329. (goto-char (point-min))
  330. (forward-line)
  331. (org-cycle)
  332. (should (equal (org-export-as 'test nil 'visible) "* Head1\n"))
  333. ;; Body only.
  334. (flet ((org-test-template (body info) (format "BEGIN\n%sEND" body)))
  335. (push '(template . org-test-template) org-test-translate-alist)
  336. (should (equal (org-export-as 'test nil nil 'body-only)
  337. "* Head1\n** Head2\ntext\n*** Head3\n"))
  338. (should (equal (org-export-as 'test)
  339. "BEGIN\n* Head1\n** Head2\ntext\n*** Head3\nEND")))
  340. ;; Region.
  341. (goto-char (point-min))
  342. (forward-line 3)
  343. (transient-mark-mode 1)
  344. (push-mark (point) t t)
  345. (goto-char (point-at-eol))
  346. (should (equal (org-export-as 'test) "text\n"))))
  347. ;; Subtree with a code block calling another block outside.
  348. (org-test-with-temp-text "
  349. * Head1
  350. #+BEGIN_SRC emacs-lisp :noweb yes :exports results
  351. <<test>>
  352. #+END_SRC
  353. * Head2
  354. #+NAME: test
  355. #+BEGIN_SRC emacs-lisp
  356. \(+ 1 2)
  357. #+END_SRC"
  358. (org-test-with-backend test
  359. (forward-line 1)
  360. (should (equal (org-export-as 'test 'subtree) ": 3\n")))))
  361. (ert-deftest test-org-export/expand-include ()
  362. "Test file inclusion in an Org buffer."
  363. ;; Full insertion with recursive inclusion.
  364. (org-test-with-temp-text
  365. (format "#+INCLUDE: \"%s/examples/include.org\"" org-test-dir)
  366. (org-export-expand-include-keyword)
  367. (should (equal (buffer-string)
  368. "Small Org file with an include keyword.
  369. #+BEGIN_SRC emacs-lisp :exports results\n(+ 2 1)\n#+END_SRC
  370. Success!
  371. * Heading
  372. body\n")))
  373. ;; Localized insertion.
  374. (org-test-with-temp-text
  375. (format "#+INCLUDE: \"%s/examples/include.org\" :lines \"1-2\""
  376. org-test-dir)
  377. (org-export-expand-include-keyword)
  378. (should (equal (buffer-string)
  379. "Small Org file with an include keyword.\n")))
  380. ;; Insertion with constraints on headlines level.
  381. (org-test-with-temp-text
  382. (format
  383. "* Top heading\n#+INCLUDE: \"%s/examples/include.org\" :lines \"9-\""
  384. org-test-dir)
  385. (org-export-expand-include-keyword)
  386. (should (equal (buffer-string) "* Top heading\n** Heading\nbody\n")))
  387. ;; Inclusion within an example block.
  388. (org-test-with-temp-text
  389. (format "#+INCLUDE: \"%s/examples/include.org\" :lines \"1-2\" example"
  390. org-test-dir)
  391. (org-export-expand-include-keyword)
  392. (should
  393. (equal
  394. (buffer-string)
  395. "#+BEGIN_EXAMPLE\nSmall Org file with an include keyword.\n#+END_EXAMPLE\n")))
  396. ;; Inclusion within a src-block.
  397. (org-test-with-temp-text
  398. (format
  399. "#+INCLUDE: \"%s/examples/include.org\" :lines \"4-5\" src emacs-lisp"
  400. org-test-dir)
  401. (org-export-expand-include-keyword)
  402. (should (equal (buffer-string)
  403. "#+BEGIN_SRC emacs-lisp\n(+ 2 1)\n#+END_SRC\n"))))
  404. (ert-deftest test-org-export/user-ignore-list ()
  405. "Test if `:ignore-list' accepts user input."
  406. (org-test-with-backend test
  407. (flet ((skip-note-head
  408. (data backend info)
  409. ;; Ignore headlines with the word "note" in their title.
  410. (org-element-map
  411. data 'headline
  412. (lambda (headline)
  413. (when (string-match "\\<note\\>"
  414. (org-element-property :raw-value headline))
  415. (org-export-ignore-element headline info)))
  416. info)
  417. data))
  418. ;; Install function in parse tree filters.
  419. (let ((org-export-filter-parse-tree-functions '(skip-note-head)))
  420. (org-test-with-temp-text "* Head1\n* Head2 (note)\n"
  421. (should (equal (org-export-as 'test) "* Head1\n")))))))
  422. (ert-deftest test-org-export/before-parsing-hook ()
  423. "Test `org-export-before-parsing-hook'."
  424. (org-test-with-backend test
  425. (org-test-with-temp-text "* Headline 1\nBody 1\n* Headline 2\nBody 2"
  426. (let ((org-export-before-parsing-hook
  427. '((lambda (backend)
  428. (org-map-entries
  429. (lambda ()
  430. (delete-region (point) (progn (forward-line) (point)))))))))
  431. (should (equal (org-export-as 'test) "Body 1\nBody 2\n"))))))
  432. ;;; Affiliated Keywords
  433. (ert-deftest test-org-export/read-attribute ()
  434. "Test `org-export-read-attribute' specifications."
  435. ;; Standard test.
  436. (should
  437. (equal
  438. (org-export-read-attribute
  439. :attr_html
  440. (org-test-with-temp-text "#+ATTR_HTML: :a 1 :b 2\nParagraph"
  441. (org-element-at-point)))
  442. '(:a 1 :b 2)))
  443. ;; Return nil on empty attribute.
  444. (should-not
  445. (org-export-read-attribute
  446. :attr_html
  447. (org-test-with-temp-text "Paragraph" (org-element-at-point)))))
  448. ;;; Export Snippets
  449. (ert-deftest test-org-export/export-snippet ()
  450. "Test export snippets transcoding."
  451. (org-test-with-temp-text "@@test:A@@@@t:B@@"
  452. (org-test-with-backend test
  453. (let ((org-test-translate-alist
  454. (cons (cons 'export-snippet
  455. (lambda (snippet contents info)
  456. (when (eq (org-export-snippet-backend snippet) 'test)
  457. (org-element-property :value snippet))))
  458. org-test-translate-alist)))
  459. (let ((org-export-snippet-translation-alist nil))
  460. (should (equal (org-export-as 'test) "A\n")))
  461. (let ((org-export-snippet-translation-alist '(("t" . "test"))))
  462. (should (equal (org-export-as 'test) "AB\n")))))))
  463. ;;; Footnotes
  464. (ert-deftest test-org-export/footnotes ()
  465. "Test footnotes specifications."
  466. (let ((org-footnote-section nil)
  467. (org-export-with-footnotes t))
  468. ;; 1. Read every type of footnote.
  469. (should
  470. (equal
  471. '((1 . "A\n") (2 . "B") (3 . "C") (4 . "D"))
  472. (org-test-with-parsed-data
  473. "Text[fn:1] [1] [fn:label:C] [fn::D]\n\n[fn:1] A\n\n[1] B"
  474. (org-element-map
  475. tree 'footnote-reference
  476. (lambda (ref)
  477. (let ((def (org-export-get-footnote-definition ref info)))
  478. (cons (org-export-get-footnote-number ref info)
  479. (if (eq (org-element-property :type ref) 'inline) (car def)
  480. (car (org-element-contents
  481. (car (org-element-contents def))))))))
  482. info))))
  483. ;; 2. Test nested footnotes order.
  484. (org-test-with-parsed-data
  485. "Text[fn:1:A[fn:2]] [fn:3].\n\n[fn:2] B [fn:3] [fn::D].\n\n[fn:3] C."
  486. (should
  487. (equal
  488. '((1 . "fn:1") (2 . "fn:2") (3 . "fn:3") (4))
  489. (org-element-map
  490. tree 'footnote-reference
  491. (lambda (ref)
  492. (when (org-export-footnote-first-reference-p ref info)
  493. (cons (org-export-get-footnote-number ref info)
  494. (org-element-property :label ref))))
  495. info))))
  496. ;; 3. Test nested footnote in invisible definitions.
  497. (org-test-with-temp-text "Text[1]\n\n[1] B [2]\n\n[2] C."
  498. ;; Hide definitions.
  499. (narrow-to-region (point) (point-at-eol))
  500. (let* ((tree (org-element-parse-buffer))
  501. (info (org-combine-plists
  502. `(:parse-tree ,tree)
  503. (org-export-collect-tree-properties
  504. tree (org-export-get-environment)))))
  505. ;; Both footnotes should be seen.
  506. (should
  507. (= (length (org-export-collect-footnote-definitions tree info)) 2))))
  508. ;; 4. Test footnotes definitions collection.
  509. (org-test-with-parsed-data "Text[fn:1:A[fn:2]] [fn:3].
  510. \[fn:2] B [fn:3] [fn::D].
  511. \[fn:3] C."
  512. (should (= (length (org-export-collect-footnote-definitions tree info))
  513. 4)))
  514. ;; 5. Test export of footnotes defined outside parsing scope.
  515. (org-test-with-temp-text "[fn:1] Out of scope
  516. * Title
  517. Paragraph[fn:1]"
  518. (org-test-with-backend test
  519. (let ((org-test-translate-alist
  520. (cons (cons 'footnote-reference
  521. (lambda (fn contents info)
  522. (org-element-interpret-data
  523. (org-export-get-footnote-definition fn info))))
  524. org-test-translate-alist)))
  525. (forward-line)
  526. (should (equal "ParagraphOut of scope\n"
  527. (org-export-as 'test 'subtree))))))))
  528. ;;; Headlines and Inlinetasks
  529. (ert-deftest test-org-export/get-relative-level ()
  530. "Test `org-export-get-relative-level' specifications."
  531. ;; Standard test.
  532. (should
  533. (equal '(1 2)
  534. (let ((org-odd-levels-only nil))
  535. (org-test-with-parsed-data "* Headline 1\n** Headline 2"
  536. (org-element-map
  537. tree 'headline
  538. (lambda (h) (org-export-get-relative-level h info))
  539. info)))))
  540. ;; Missing levels
  541. (should
  542. (equal '(1 3)
  543. (let ((org-odd-levels-only nil))
  544. (org-test-with-parsed-data "** Headline 1\n**** Headline 2"
  545. (org-element-map
  546. tree 'headline
  547. (lambda (h) (org-export-get-relative-level h info))
  548. info))))))
  549. (ert-deftest test-org-export/low-level-p ()
  550. "Test `org-export-low-level-p' specifications."
  551. (should
  552. (equal
  553. '(no yes)
  554. (let ((org-odd-levels-only nil))
  555. (org-test-with-parsed-data "* Headline 1\n** Headline 2"
  556. (org-element-map
  557. tree 'headline
  558. (lambda (h) (if (org-export-low-level-p h info) 'yes 'no))
  559. (plist-put info :headline-levels 1)))))))
  560. (ert-deftest test-org-export/get-headline-number ()
  561. "Test `org-export-get-headline-number' specifications."
  562. ;; Standard test.
  563. (should
  564. (equal
  565. '((1) (1 1))
  566. (let ((org-odd-levels-only nil))
  567. (org-test-with-parsed-data "* Headline 1\n** Headline 2"
  568. (org-element-map
  569. tree 'headline
  570. (lambda (h) (org-export-get-headline-number h info))
  571. info)))))
  572. ;; Missing levels are replaced with 0.
  573. (should
  574. (equal
  575. '((1) (1 0 1))
  576. (let ((org-odd-levels-only nil))
  577. (org-test-with-parsed-data "* Headline 1\n*** Headline 2"
  578. (org-element-map
  579. tree 'headline
  580. (lambda (h) (org-export-get-headline-number h info))
  581. info))))))
  582. (ert-deftest test-org-export/numbered-headline-p ()
  583. "Test `org-export-numbered-headline-p' specifications."
  584. ;; If `:section-numbers' is nil, never number headlines.
  585. (should-not
  586. (org-test-with-parsed-data "* Headline"
  587. (org-element-map
  588. tree 'headline
  589. (lambda (h) (org-export-numbered-headline-p h info))
  590. (plist-put info :section-numbers nil))))
  591. ;; If `:section-numbers' is a number, only number headlines with
  592. ;; a level greater that it.
  593. (should
  594. (equal
  595. '(yes no)
  596. (org-test-with-parsed-data "* Headline 1\n** Headline 2"
  597. (org-element-map
  598. tree 'headline
  599. (lambda (h) (if (org-export-numbered-headline-p h info) 'yes 'no))
  600. (plist-put info :section-numbers 1)))))
  601. ;; Otherwise, headlines are always numbered.
  602. (should
  603. (org-test-with-parsed-data "* Headline"
  604. (org-element-map
  605. tree 'headline
  606. (lambda (h) (org-export-numbered-headline-p h info))
  607. (plist-put info :section-numbers t)))))
  608. (ert-deftest test-org-export/number-to-roman ()
  609. "Test `org-export-number-to-roman' specifications."
  610. ;; If number is negative, return it as a string.
  611. (should (equal (org-export-number-to-roman -1) "-1"))
  612. ;; Otherwise, return it as a roman number.
  613. (should (equal (org-export-number-to-roman 1449) "MCDXLIX")))
  614. (ert-deftest test-org-export/get-tags ()
  615. "Test `org-export-get-tags' specifications."
  616. (let ((org-export-exclude-tags '("noexport"))
  617. (org-export-select-tags '("export")))
  618. ;; Standard test: tags which are not a select tag, an exclude tag,
  619. ;; or specified as optional argument shouldn't be ignored.
  620. (should
  621. (org-test-with-parsed-data "* Headline :tag:"
  622. (org-export-get-tags (org-element-map tree 'headline 'identity info t)
  623. info)))
  624. ;; Exclude tags are removed.
  625. (should-not
  626. (org-test-with-parsed-data "* Headline :noexport:"
  627. (org-export-get-tags (org-element-map tree 'headline 'identity info t)
  628. info)))
  629. ;; Select tags are removed.
  630. (should-not
  631. (org-test-with-parsed-data "* Headline :export:"
  632. (org-export-get-tags (org-element-map tree 'headline 'identity info t)
  633. info)))
  634. (should
  635. (equal
  636. '("tag")
  637. (org-test-with-parsed-data "* Headline :tag:export:"
  638. (org-export-get-tags (org-element-map tree 'headline 'identity info t)
  639. info))))
  640. ;; Tags provided in the optional argument are also ignored.
  641. (should-not
  642. (org-test-with-parsed-data "* Headline :ignore:"
  643. (org-export-get-tags (org-element-map tree 'headline 'identity info t)
  644. info '("ignore"))))))
  645. (ert-deftest test-org-export/first-sibling-p ()
  646. "Test `org-export-first-sibling-p' specifications."
  647. ;; Standard test.
  648. (should
  649. (equal
  650. '(yes yes no)
  651. (org-test-with-parsed-data "* Headline\n** Headline 2\n** Headline 3"
  652. (org-element-map
  653. tree 'headline
  654. (lambda (h) (if (org-export-first-sibling-p h info) 'yes 'no))
  655. info))))
  656. ;; Ignore headlines not exported.
  657. (should
  658. (equal
  659. '(yes)
  660. (let ((org-export-exclude-tags '("ignore")))
  661. (org-test-with-parsed-data "* Headline :ignore:\n* Headline 2"
  662. (org-element-map
  663. tree 'headline
  664. (lambda (h) (if (org-export-first-sibling-p h info) 'yes 'no))
  665. info))))))
  666. (ert-deftest test-org-export/last-sibling-p ()
  667. "Test `org-export-last-sibling-p' specifications."
  668. ;; Standard test.
  669. (should
  670. (equal
  671. '(yes no yes)
  672. (org-test-with-parsed-data "* Headline\n** Headline 2\n** Headline 3"
  673. (org-element-map
  674. tree 'headline
  675. (lambda (h) (if (org-export-last-sibling-p h info) 'yes 'no))
  676. info))))
  677. ;; Ignore headlines not exported.
  678. (should
  679. (equal
  680. '(yes)
  681. (let ((org-export-exclude-tags '("ignore")))
  682. (org-test-with-parsed-data "* Headline\n* Headline 2 :ignore:"
  683. (org-element-map
  684. tree 'headline
  685. (lambda (h) (if (org-export-last-sibling-p h info) 'yes 'no))
  686. info))))))
  687. ;;; Links
  688. (ert-deftest test-org-export/get-coderef-format ()
  689. "Test `org-export-get-coderef-format' specifications."
  690. ;; A link without description returns "%s"
  691. (should (equal (org-export-get-coderef-format "(ref:line)" nil)
  692. "%s"))
  693. ;; Return "%s" when path is matched within description.
  694. (should (equal (org-export-get-coderef-format "path" "desc (path)")
  695. "desc %s"))
  696. ;; Otherwise return description.
  697. (should (equal (org-export-get-coderef-format "path" "desc")
  698. "desc")))
  699. (ert-deftest test-org-export/inline-image-p ()
  700. "Test `org-export-inline-image-p' specifications."
  701. (should
  702. (org-export-inline-image-p
  703. (org-test-with-temp-text "[[#id]]"
  704. (org-element-map
  705. (org-element-parse-buffer) 'link 'identity nil t))
  706. '(("custom-id" . "id")))))
  707. (ert-deftest test-org-export/fuzzy-link ()
  708. "Test fuzzy links specifications."
  709. ;; 1. Links to invisible (keyword) targets should be ignored.
  710. (org-test-with-parsed-data
  711. "Paragraph.\n#+TARGET: Test\n[[Test]]"
  712. (should-not
  713. (org-element-map
  714. tree 'link
  715. (lambda (link)
  716. (org-export-get-ordinal
  717. (org-export-resolve-fuzzy-link link info) info)) info)))
  718. ;; 2. Link to an headline should return headline's number.
  719. (org-test-with-parsed-data
  720. "Paragraph.\n* Head1\n* Head2\n* Head3\n[[Head2]]"
  721. (should
  722. ;; Note: Headline's number is in fact a list of numbers.
  723. (equal '(2)
  724. (org-element-map
  725. tree 'link
  726. (lambda (link)
  727. (org-export-get-ordinal
  728. (org-export-resolve-fuzzy-link link info) info)) info t))))
  729. ;; 3. Link to a target in an item should return item's number.
  730. (org-test-with-parsed-data
  731. "- Item1\n - Item11\n - <<test>>Item12\n- Item2\n\n\n[[test]]"
  732. (should
  733. ;; Note: Item's number is in fact a list of numbers.
  734. (equal '(1 2)
  735. (org-element-map
  736. tree 'link
  737. (lambda (link)
  738. (org-export-get-ordinal
  739. (org-export-resolve-fuzzy-link link info) info)) info t))))
  740. ;; 4. Link to a target in a footnote should return footnote's
  741. ;; number.
  742. (org-test-with-parsed-data "
  743. Paragraph[1][2][fn:lbl3:C<<target>>][[test]][[target]]\n[1] A\n\n[2] <<test>>B"
  744. (should
  745. (equal '(2 3)
  746. (org-element-map
  747. tree 'link
  748. (lambda (link)
  749. (org-export-get-ordinal
  750. (org-export-resolve-fuzzy-link link info) info)) info))))
  751. ;; 5. Link to a named element should return sequence number of that
  752. ;; element.
  753. (org-test-with-parsed-data
  754. "#+NAME: tbl1\n|1|2|\n#+NAME: tbl2\n|3|4|\n#+NAME: tbl3\n|5|6|\n[[tbl2]]"
  755. (should
  756. (= 2
  757. (org-element-map
  758. tree 'link
  759. (lambda (link)
  760. (org-export-get-ordinal
  761. (org-export-resolve-fuzzy-link link info) info)) info t))))
  762. ;; 6. Link to a target not within an item, a table, a footnote
  763. ;; reference or definition should return section number.
  764. (org-test-with-parsed-data
  765. "* Head1\n* Head2\nParagraph<<target>>\n* Head3\n[[target]]"
  766. (should
  767. (equal '(2)
  768. (org-element-map
  769. tree 'link
  770. (lambda (link)
  771. (org-export-get-ordinal
  772. (org-export-resolve-fuzzy-link link info) info)) info t)))))
  773. (ert-deftest test-org-export/resolve-coderef ()
  774. "Test `org-export-resolve-coderef' specifications."
  775. (let ((org-coderef-label-format "(ref:%s)"))
  776. ;; 1. A link to a "-n -k -r" block returns line number.
  777. (org-test-with-parsed-data
  778. "#+BEGIN_EXAMPLE -n -k -r\nText (ref:coderef)\n#+END_EXAMPLE"
  779. (should (= (org-export-resolve-coderef "coderef" info) 1)))
  780. (org-test-with-parsed-data
  781. "#+BEGIN_SRC emacs-lisp -n -k -r\n(+ 1 1) (ref:coderef)\n#+END_SRC"
  782. (should (= (org-export-resolve-coderef "coderef" info) 1)))
  783. ;; 2. A link to a "-n -r" block returns line number.
  784. (org-test-with-parsed-data
  785. "#+BEGIN_EXAMPLE -n -r\nText (ref:coderef)\n#+END_EXAMPLE"
  786. (should (= (org-export-resolve-coderef "coderef" info) 1)))
  787. (org-test-with-parsed-data
  788. "#+BEGIN_SRC emacs-lisp -n -r\n(+ 1 1) (ref:coderef)\n#+END_SRC"
  789. (should (= (org-export-resolve-coderef "coderef" info) 1)))
  790. ;; 3. A link to a "-n" block returns coderef.
  791. (org-test-with-parsed-data
  792. "#+BEGIN_SRC emacs-lisp -n\n(+ 1 1) (ref:coderef)\n#+END_SRC"
  793. (should (equal (org-export-resolve-coderef "coderef" info) "coderef")))
  794. (org-test-with-parsed-data
  795. "#+BEGIN_EXAMPLE -n\nText (ref:coderef)\n#+END_EXAMPLE"
  796. (should (equal (org-export-resolve-coderef "coderef" info) "coderef")))
  797. ;; 4. A link to a "-r" block returns line number.
  798. (org-test-with-parsed-data
  799. "#+BEGIN_SRC emacs-lisp -r\n(+ 1 1) (ref:coderef)\n#+END_SRC"
  800. (should (= (org-export-resolve-coderef "coderef" info) 1)))
  801. (org-test-with-parsed-data
  802. "#+BEGIN_EXAMPLE -r\nText (ref:coderef)\n#+END_EXAMPLE"
  803. (should (= (org-export-resolve-coderef "coderef" info) 1)))
  804. ;; 5. A link to a block without a switch returns coderef.
  805. (org-test-with-parsed-data
  806. "#+BEGIN_SRC emacs-lisp\n(+ 1 1) (ref:coderef)\n#+END_SRC"
  807. (should (equal (org-export-resolve-coderef "coderef" info) "coderef")))
  808. (org-test-with-parsed-data
  809. "#+BEGIN_EXAMPLE\nText (ref:coderef)\n#+END_EXAMPLE"
  810. (should (equal (org-export-resolve-coderef "coderef" info) "coderef")))
  811. ;; 6. Correctly handle continued line numbers. A "+n" switch
  812. ;; should resume numbering from previous block with numbered
  813. ;; lines, ignoring blocks not numbering lines in the process.
  814. ;; A "-n" switch resets count.
  815. (org-test-with-parsed-data "
  816. #+BEGIN_EXAMPLE -n
  817. Text.
  818. #+END_EXAMPLE
  819. #+BEGIN_SRC emacs-lisp
  820. \(- 1 1)
  821. #+END_SRC
  822. #+BEGIN_SRC emacs-lisp +n -r
  823. \(+ 1 1) (ref:addition)
  824. #+END_SRC
  825. #+BEGIN_EXAMPLE -n -r
  826. Another text. (ref:text)
  827. #+END_EXAMPLE"
  828. (should (= (org-export-resolve-coderef "addition" info) 2))
  829. (should (= (org-export-resolve-coderef "text" info) 1)))
  830. ;; 7. Recognize coderef with user-specified syntax.
  831. (org-test-with-parsed-data
  832. "#+BEGIN_EXAMPLE -l \"[ref:%s]\"\nText. [ref:text]\n#+END_EXAMPLE"
  833. (should (equal (org-export-resolve-coderef "text" info) "text")))))
  834. (ert-deftest test-org-export/resolve-fuzzy-link ()
  835. "Test `org-export-resolve-fuzzy-link' specifications."
  836. ;; 1. Match target objects.
  837. (org-test-with-parsed-data "<<target>> [[target]]"
  838. (should
  839. (org-export-resolve-fuzzy-link
  840. (org-element-map tree 'link 'identity info t) info)))
  841. ;; 2. Match target elements.
  842. (org-test-with-parsed-data "#+TARGET: target\n[[target]]"
  843. (should
  844. (org-export-resolve-fuzzy-link
  845. (org-element-map tree 'link 'identity info t) info)))
  846. ;; 3. Match named elements.
  847. (org-test-with-parsed-data "#+NAME: target\nParagraph\n\n[[target]]"
  848. (should
  849. (org-export-resolve-fuzzy-link
  850. (org-element-map tree 'link 'identity info t) info)))
  851. ;; 4. Match exact headline's name.
  852. (org-test-with-parsed-data "* My headline\n[[My headline]]"
  853. (should
  854. (org-export-resolve-fuzzy-link
  855. (org-element-map tree 'link 'identity info t) info)))
  856. ;; 5. Targets objects have priority over named elements and headline
  857. ;; titles.
  858. (org-test-with-parsed-data
  859. "* target\n#+NAME: target\n<<target>>\n\n[[target]]"
  860. (should
  861. (eq 'target
  862. (org-element-type
  863. (org-export-resolve-fuzzy-link
  864. (org-element-map tree 'link 'identity info t) info)))))
  865. ;; 6. Named elements have priority over headline titles.
  866. (org-test-with-parsed-data
  867. "* target\n#+NAME: target\nParagraph\n\n[[target]]"
  868. (should
  869. (eq 'paragraph
  870. (org-element-type
  871. (org-export-resolve-fuzzy-link
  872. (org-element-map tree 'link 'identity info t) info)))))
  873. ;; 7. If link's path starts with a "*", only match headline titles,
  874. ;; though.
  875. (org-test-with-parsed-data
  876. "* target\n#+NAME: target\n<<target>>\n\n[[*target]]"
  877. (should
  878. (eq 'headline
  879. (org-element-type
  880. (org-export-resolve-fuzzy-link
  881. (org-element-map tree 'link 'identity info t) info)))))
  882. ;; 8. Return nil if no match.
  883. (org-test-with-parsed-data "[[target]]"
  884. (should-not
  885. (org-export-resolve-fuzzy-link
  886. (org-element-map tree 'link 'identity info t) info))))
  887. (ert-deftest test-org-export/resolve-id-link ()
  888. "Test `org-export-resolve-id-link' specifications."
  889. ;; 1. Regular test for custom-id link.
  890. (org-test-with-parsed-data "* Headline1
  891. :PROPERTIES:
  892. :CUSTOM-ID: test
  893. :END:
  894. * Headline 2
  895. \[[#test]]"
  896. (should
  897. (org-export-resolve-id-link
  898. (org-element-map tree 'link 'identity info t) info)))
  899. ;; 2. Failing test for custom-id link.
  900. (org-test-with-parsed-data "* Headline1
  901. :PROPERTIES:
  902. :CUSTOM-ID: test
  903. :END:
  904. * Headline 2
  905. \[[#no-match]]"
  906. (should-not
  907. (org-export-resolve-id-link
  908. (org-element-map tree 'link 'identity info t) info)))
  909. ;; 3. Test for internal id target.
  910. (org-test-with-parsed-data "* Headline1
  911. :PROPERTIES:
  912. :ID: aaaa
  913. :END:
  914. * Headline 2
  915. \[[id:aaaa]]"
  916. (should
  917. (org-export-resolve-id-link
  918. (org-element-map tree 'link 'identity info t) info)))
  919. ;; 4. Test for external id target.
  920. (org-test-with-parsed-data "[[id:aaaa]]"
  921. (should
  922. (org-export-resolve-id-link
  923. (org-element-map tree 'link 'identity info t)
  924. (org-combine-plists info '(:id-alist (("aaaa" . "external-file"))))))))
  925. (ert-deftest test-org-export/resolve-radio-link ()
  926. "Test `org-export-resolve-radio-link' specifications."
  927. ;; Standard test.
  928. (org-test-with-temp-text "<<<radio>>> radio"
  929. (org-update-radio-target-regexp)
  930. (should
  931. (let* ((tree (org-element-parse-buffer))
  932. (info `(:parse-tree ,tree)))
  933. (org-export-resolve-radio-link
  934. (org-element-map tree 'link 'identity info t)
  935. info))))
  936. ;; Radio target with objects.
  937. (org-test-with-temp-text "<<<radio \\alpha>>> radio \\alpha"
  938. (org-update-radio-target-regexp)
  939. (should
  940. (let* ((tree (org-element-parse-buffer))
  941. (info `(:parse-tree ,tree)))
  942. (org-export-resolve-radio-link
  943. (org-element-map tree 'link 'identity info t)
  944. info)))))
  945. ;;; Src-block and example-block
  946. (ert-deftest test-org-export/unravel-code ()
  947. "Test `org-export-unravel-code' function."
  948. (let ((org-coderef-label-format "(ref:%s)"))
  949. ;; 1. Code without reference.
  950. (org-test-with-temp-text "#+BEGIN_EXAMPLE\n(+ 1 1)\n#+END_EXAMPLE"
  951. (should (equal (org-export-unravel-code (org-element-at-point))
  952. '("(+ 1 1)\n"))))
  953. ;; 2. Code with reference.
  954. (org-test-with-temp-text
  955. "#+BEGIN_EXAMPLE\n(+ 1 1) (ref:test)\n#+END_EXAMPLE"
  956. (should (equal (org-export-unravel-code (org-element-at-point))
  957. '("(+ 1 1)\n" (1 . "test")))))
  958. ;; 3. Code with user-defined reference.
  959. (org-test-with-temp-text
  960. "#+BEGIN_EXAMPLE -l \"[ref:%s]\"\n(+ 1 1) [ref:test]\n#+END_EXAMPLE"
  961. (should (equal (org-export-unravel-code (org-element-at-point))
  962. '("(+ 1 1)\n" (1 . "test")))))
  963. ;; 4. Code references keys are relative to the current block.
  964. (org-test-with-temp-text "
  965. #+BEGIN_EXAMPLE -n
  966. \(+ 1 1)
  967. #+END_EXAMPLE
  968. #+BEGIN_EXAMPLE +n
  969. \(+ 2 2)
  970. \(+ 3 3) (ref:one)
  971. #+END_EXAMPLE"
  972. (goto-line 5)
  973. (should (equal (org-export-unravel-code (org-element-at-point))
  974. '("(+ 2 2)\n(+ 3 3)\n" (2 . "one")))))
  975. ;; 5. Free up comma-protected lines.
  976. ;;
  977. ;; 5.1. In an Org source block, every line is protected.
  978. (org-test-with-temp-text
  979. "#+BEGIN_SRC org\n,* Test\n,# comment\n,Text\n#+END_SRC"
  980. (should (equal (org-export-unravel-code (org-element-at-point))
  981. '("* Test\n# comment\nText\n"))))
  982. ;; 5.2. In other blocks, only headlines, comments and keywords are
  983. ;; protected.
  984. (org-test-with-temp-text
  985. "#+BEGIN_EXAMPLE\n,* Headline\n, * Not headline\n,Keep\n#+END_EXAMPLE"
  986. (should (equal (org-export-unravel-code (org-element-at-point))
  987. '("* Headline\n, * Not headline\n,Keep\n"))))))
  988. ;;; Tables
  989. (ert-deftest test-org-export/special-column ()
  990. "Test if the table's special column is properly recognized."
  991. ;; 1. First column is special if it contains only a special marking
  992. ;; characters or empty cells.
  993. (org-test-with-temp-text "
  994. | ! | 1 |
  995. | | 2 |"
  996. (should
  997. (org-export-table-has-special-column-p
  998. (org-element-map
  999. (org-element-parse-buffer) 'table 'identity nil 'first-match))))
  1000. ;; 2. If the column contains anything else, it isn't special.
  1001. (org-test-with-temp-text "
  1002. | ! | 1 |
  1003. | b | 2 |"
  1004. (should-not
  1005. (org-export-table-has-special-column-p
  1006. (org-element-map
  1007. (org-element-parse-buffer) 'table 'identity nil 'first-match))))
  1008. ;; 3. Special marking characters are "#", "^", "*", "_", "/", "$"
  1009. ;; and "!".
  1010. (org-test-with-temp-text "
  1011. | # | 1 |
  1012. | ^ | 2 |
  1013. | * | 3 |
  1014. | _ | 4 |
  1015. | / | 5 |
  1016. | $ | 6 |
  1017. | ! | 7 |"
  1018. (should
  1019. (org-export-table-has-special-column-p
  1020. (org-element-map
  1021. (org-element-parse-buffer) 'table 'identity nil 'first-match))))
  1022. ;; 4. A first column with only empty cells isn't considered as
  1023. ;; special.
  1024. (org-test-with-temp-text "
  1025. | | 1 |
  1026. | | 2 |"
  1027. (should-not
  1028. (org-export-table-has-special-column-p
  1029. (org-element-map
  1030. (org-element-parse-buffer) 'table 'identity nil 'first-match)))))
  1031. (ert-deftest test-org-export/table-row-is-special-p ()
  1032. "Test `org-export-table-row-is-special-p' specifications."
  1033. ;; 1. A row is special if it has a special marking character in the
  1034. ;; special column.
  1035. (org-test-with-parsed-data "| ! | 1 |"
  1036. (should
  1037. (org-export-table-row-is-special-p
  1038. (org-element-map tree 'table-row 'identity nil 'first-match) info)))
  1039. ;; 2. A row is special when its first field is "/"
  1040. (org-test-with-parsed-data "
  1041. | / | 1 |
  1042. | a | b |"
  1043. (should
  1044. (org-export-table-row-is-special-p
  1045. (org-element-map tree 'table-row 'identity nil 'first-match) info)))
  1046. ;; 3. A row only containing alignment cookies is also considered as
  1047. ;; special.
  1048. (org-test-with-parsed-data "| <5> | | <l> | <l22> |"
  1049. (should
  1050. (org-export-table-row-is-special-p
  1051. (org-element-map tree 'table-row 'identity nil 'first-match) info)))
  1052. ;; 4. Everything else isn't considered as special.
  1053. (org-test-with-parsed-data "| \alpha | | c |"
  1054. (should-not
  1055. (org-export-table-row-is-special-p
  1056. (org-element-map tree 'table-row 'identity nil 'first-match) info)))
  1057. ;; 5. Table's rules are never considered as special rows.
  1058. (org-test-with-parsed-data "|---+---|"
  1059. (should-not
  1060. (org-export-table-row-is-special-p
  1061. (org-element-map tree 'table-row 'identity nil 'first-match) info))))
  1062. (ert-deftest test-org-export/has-header-p ()
  1063. "Test `org-export-table-has-header-p' specifications."
  1064. ;; 1. With an header.
  1065. (org-test-with-parsed-data "
  1066. | a | b |
  1067. |---+---|
  1068. | c | d |"
  1069. (should
  1070. (org-export-table-has-header-p
  1071. (org-element-map tree 'table 'identity info 'first-match)
  1072. info)))
  1073. ;; 2. Without an header.
  1074. (org-test-with-parsed-data "
  1075. | a | b |
  1076. | c | d |"
  1077. (should-not
  1078. (org-export-table-has-header-p
  1079. (org-element-map tree 'table 'identity info 'first-match)
  1080. info)))
  1081. ;; 3. Don't get fooled with starting and ending rules.
  1082. (org-test-with-parsed-data "
  1083. |---+---|
  1084. | a | b |
  1085. | c | d |
  1086. |---+---|"
  1087. (should-not
  1088. (org-export-table-has-header-p
  1089. (org-element-map tree 'table 'identity info 'first-match)
  1090. info))))
  1091. (ert-deftest test-org-export/table-row-group ()
  1092. "Test `org-export-table-row-group' specifications."
  1093. ;; 1. A rule creates a new group.
  1094. (org-test-with-parsed-data "
  1095. | a | b |
  1096. |---+---|
  1097. | 1 | 2 |"
  1098. (should
  1099. (equal
  1100. '(1 nil 2)
  1101. (mapcar (lambda (row) (org-export-table-row-group row info))
  1102. (org-element-map tree 'table-row 'identity)))))
  1103. ;; 2. Special rows are ignored in count.
  1104. (org-test-with-parsed-data "
  1105. | / | < | > |
  1106. |---|---+---|
  1107. | | 1 | 2 |"
  1108. (should
  1109. (equal
  1110. '(nil nil 1)
  1111. (mapcar (lambda (row) (org-export-table-row-group row info))
  1112. (org-element-map tree 'table-row 'identity)))))
  1113. ;; 3. Double rules also are ignored in count.
  1114. (org-test-with-parsed-data "
  1115. | a | b |
  1116. |---+---|
  1117. |---+---|
  1118. | 1 | 2 |"
  1119. (should
  1120. (equal
  1121. '(1 nil nil 2)
  1122. (mapcar (lambda (row) (org-export-table-row-group row info))
  1123. (org-element-map tree 'table-row 'identity))))))
  1124. (ert-deftest test-org-export/table-cell-width ()
  1125. "Test `org-export-table-cell-width' specifications."
  1126. ;; 1. Width is primarily determined by width cookies. If no cookie
  1127. ;; is found, cell's width is nil.
  1128. (org-test-with-parsed-data "
  1129. | / | <l> | <6> | <l7> |
  1130. | | a | b | c |"
  1131. (should
  1132. (equal
  1133. '(nil 6 7)
  1134. (mapcar (lambda (cell) (org-export-table-cell-width cell info))
  1135. (org-element-map tree 'table-cell 'identity info)))))
  1136. ;; 2. The last width cookie has precedence.
  1137. (org-test-with-parsed-data "
  1138. | <6> |
  1139. | <7> |
  1140. | a |"
  1141. (should
  1142. (equal
  1143. '(7)
  1144. (mapcar (lambda (cell) (org-export-table-cell-width cell info))
  1145. (org-element-map tree 'table-cell 'identity info)))))
  1146. ;; 3. Valid width cookies must have a specific row.
  1147. (org-test-with-parsed-data "| <6> | cell |"
  1148. (should
  1149. (equal
  1150. '(nil nil)
  1151. (mapcar (lambda (cell) (org-export-table-cell-width cell info))
  1152. (org-element-map tree 'table-cell 'identity))))))
  1153. (ert-deftest test-org-export/table-cell-alignment ()
  1154. "Test `org-export-table-cell-alignment' specifications."
  1155. (let ((org-table-number-fraction 0.5)
  1156. (org-table-number-regexp "^[0-9]+$"))
  1157. ;; 1. Alignment is primarily determined by alignment cookies.
  1158. (org-test-with-temp-text "| <l> | <c> | <r> |"
  1159. (let* ((tree (org-element-parse-buffer))
  1160. (info `(:parse-tree ,tree)))
  1161. (should
  1162. (equal
  1163. '(left center right)
  1164. (mapcar (lambda (cell) (org-export-table-cell-alignment cell info))
  1165. (org-element-map tree 'table-cell 'identity))))))
  1166. ;; 2. The last alignment cookie has precedence.
  1167. (org-test-with-parsed-data "
  1168. | <l8> |
  1169. | cell |
  1170. | <r9> |"
  1171. (should
  1172. (equal
  1173. '(right right right)
  1174. (mapcar (lambda (cell) (org-export-table-cell-alignment cell info))
  1175. (org-element-map tree 'table-cell 'identity)))))
  1176. ;; 3. If there's no cookie, cell's contents determine alignment.
  1177. ;; A column mostly made of cells containing numbers will align
  1178. ;; its cells to the right.
  1179. (org-test-with-parsed-data "
  1180. | 123 |
  1181. | some text |
  1182. | 12345 |"
  1183. (should
  1184. (equal
  1185. '(right right right)
  1186. (mapcar (lambda (cell)
  1187. (org-export-table-cell-alignment cell info))
  1188. (org-element-map tree 'table-cell 'identity)))))
  1189. ;; 4. Otherwise, they will be aligned to the left.
  1190. (org-test-with-parsed-data "
  1191. | text |
  1192. | some text |
  1193. | \alpha |"
  1194. (should
  1195. (equal
  1196. '(left left left)
  1197. (mapcar (lambda (cell)
  1198. (org-export-table-cell-alignment cell info))
  1199. (org-element-map tree 'table-cell 'identity)))))))
  1200. (ert-deftest test-org-export/table-cell-borders ()
  1201. "Test `org-export-table-cell-borders' specifications."
  1202. ;; 1. Recognize various column groups indicators.
  1203. (org-test-with-parsed-data "| / | < | > | <> |"
  1204. (should
  1205. (equal
  1206. '((right bottom top) (left bottom top) (right bottom top)
  1207. (right left bottom top))
  1208. (mapcar (lambda (cell)
  1209. (org-export-table-cell-borders cell info))
  1210. (org-element-map tree 'table-cell 'identity)))))
  1211. ;; 2. Accept shortcuts to define column groups.
  1212. (org-test-with-parsed-data "| / | < | < |"
  1213. (should
  1214. (equal
  1215. '((right bottom top) (right left bottom top) (left bottom top))
  1216. (mapcar (lambda (cell)
  1217. (org-export-table-cell-borders cell info))
  1218. (org-element-map tree 'table-cell 'identity)))))
  1219. ;; 3. A valid column groups row must start with a "/".
  1220. (org-test-with-parsed-data "
  1221. | | < |
  1222. | a | b |"
  1223. (should
  1224. (equal '((top) (top) (bottom) (bottom))
  1225. (mapcar (lambda (cell)
  1226. (org-export-table-cell-borders cell info))
  1227. (org-element-map tree 'table-cell 'identity)))))
  1228. ;; 4. Take table rules into consideration.
  1229. (org-test-with-parsed-data "
  1230. | 1 |
  1231. |---|
  1232. | 2 |"
  1233. (should
  1234. (equal '((below top) (bottom above))
  1235. (mapcar (lambda (cell)
  1236. (org-export-table-cell-borders cell info))
  1237. (org-element-map tree 'table-cell 'identity)))))
  1238. ;; 5. Top and (resp. bottom) rules induce both `top' and `above'
  1239. ;; (resp. `bottom' and `below') borders. Any special row is
  1240. ;; ignored.
  1241. (org-test-with-parsed-data "
  1242. |---+----|
  1243. | / | |
  1244. | | 1 |
  1245. |---+----|"
  1246. (should
  1247. (equal '((bottom below top above))
  1248. (last
  1249. (mapcar (lambda (cell)
  1250. (org-export-table-cell-borders cell info))
  1251. (org-element-map tree 'table-cell 'identity)))))))
  1252. (ert-deftest test-org-export/table-dimensions ()
  1253. "Test `org-export-table-dimensions' specifications."
  1254. ;; 1. Standard test.
  1255. (org-test-with-parsed-data "
  1256. | 1 | 2 | 3 |
  1257. | 4 | 5 | 6 |"
  1258. (should
  1259. (equal '(2 . 3)
  1260. (org-export-table-dimensions
  1261. (org-element-map tree 'table 'identity info 'first-match) info))))
  1262. ;; 2. Ignore horizontal rules and special columns.
  1263. (org-test-with-parsed-data "
  1264. | / | < | > |
  1265. | 1 | 2 | 3 |
  1266. |---+---+---|
  1267. | 4 | 5 | 6 |"
  1268. (should
  1269. (equal '(2 . 3)
  1270. (org-export-table-dimensions
  1271. (org-element-map tree 'table 'identity info 'first-match) info)))))
  1272. (ert-deftest test-org-export/table-cell-address ()
  1273. "Test `org-export-table-cell-address' specifications."
  1274. ;; 1. Standard test: index is 0-based.
  1275. (org-test-with-parsed-data "| a | b |"
  1276. (should
  1277. (equal '((0 . 0) (0 . 1))
  1278. (org-element-map
  1279. tree 'table-cell
  1280. (lambda (cell) (org-export-table-cell-address cell info))
  1281. info))))
  1282. ;; 2. Special column isn't counted, nor are special rows.
  1283. (org-test-with-parsed-data "
  1284. | / | <> |
  1285. | | c |"
  1286. (should
  1287. (equal '(0 . 0)
  1288. (org-export-table-cell-address
  1289. (car (last (org-element-map tree 'table-cell 'identity info)))
  1290. info))))
  1291. ;; 3. Tables rules do not count either.
  1292. (org-test-with-parsed-data "
  1293. | a |
  1294. |---|
  1295. | b |
  1296. |---|
  1297. | c |"
  1298. (should
  1299. (equal '(2 . 0)
  1300. (org-export-table-cell-address
  1301. (car (last (org-element-map tree 'table-cell 'identity info)))
  1302. info))))
  1303. ;; 4. Return nil for special cells.
  1304. (org-test-with-parsed-data "| / | a |"
  1305. (should-not
  1306. (org-export-table-cell-address
  1307. (org-element-map tree 'table-cell 'identity nil 'first-match)
  1308. info))))
  1309. (ert-deftest test-org-export/get-table-cell-at ()
  1310. "Test `org-export-get-table-cell-at' specifications."
  1311. ;; 1. Address ignores special columns, special rows and rules.
  1312. (org-test-with-parsed-data "
  1313. | / | <> |
  1314. | | a |
  1315. |---+----|
  1316. | | b |"
  1317. (should
  1318. (equal '("b")
  1319. (org-element-contents
  1320. (org-export-get-table-cell-at
  1321. '(1 . 0)
  1322. (org-element-map tree 'table 'identity info 'first-match)
  1323. info)))))
  1324. ;; 2. Return value for a non-existent address is nil.
  1325. (org-test-with-parsed-data "| a |"
  1326. (should-not
  1327. (org-export-get-table-cell-at
  1328. '(2 . 2)
  1329. (org-element-map tree 'table 'identity info 'first-match)
  1330. info)))
  1331. (org-test-with-parsed-data "| / |"
  1332. (should-not
  1333. (org-export-get-table-cell-at
  1334. '(0 . 0)
  1335. (org-element-map tree 'table 'identity info 'first-match)
  1336. info))))
  1337. (ert-deftest test-org-export/table-cell-starts-colgroup-p ()
  1338. "Test `org-export-table-cell-starts-colgroup-p' specifications."
  1339. ;; 1. A cell at a beginning of a row always starts a column group.
  1340. (org-test-with-parsed-data "| a |"
  1341. (should
  1342. (org-export-table-cell-starts-colgroup-p
  1343. (org-element-map tree 'table-cell 'identity info 'first-match)
  1344. info)))
  1345. ;; 2. Special column should be ignored when determining the
  1346. ;; beginning of the row.
  1347. (org-test-with-parsed-data "
  1348. | / | |
  1349. | | a |"
  1350. (should
  1351. (org-export-table-cell-starts-colgroup-p
  1352. (org-element-map tree 'table-cell 'identity info 'first-match)
  1353. info)))
  1354. ;; 2. Explicit column groups.
  1355. (org-test-with-parsed-data "
  1356. | / | | < |
  1357. | a | b | c |"
  1358. (should
  1359. (equal
  1360. '(yes no yes)
  1361. (org-element-map
  1362. tree 'table-cell
  1363. (lambda (cell)
  1364. (if (org-export-table-cell-starts-colgroup-p cell info) 'yes 'no))
  1365. info)))))
  1366. (ert-deftest test-org-export/table-cell-ends-colgroup-p ()
  1367. "Test `org-export-table-cell-ends-colgroup-p' specifications."
  1368. ;; 1. A cell at the end of a row always ends a column group.
  1369. (org-test-with-parsed-data "| a |"
  1370. (should
  1371. (org-export-table-cell-ends-colgroup-p
  1372. (org-element-map tree 'table-cell 'identity info 'first-match)
  1373. info)))
  1374. ;; 2. Special column should be ignored when determining the
  1375. ;; beginning of the row.
  1376. (org-test-with-parsed-data "
  1377. | / | |
  1378. | | a |"
  1379. (should
  1380. (org-export-table-cell-ends-colgroup-p
  1381. (org-element-map tree 'table-cell 'identity info 'first-match)
  1382. info)))
  1383. ;; 3. Explicit column groups.
  1384. (org-test-with-parsed-data "
  1385. | / | < | |
  1386. | a | b | c |"
  1387. (should
  1388. (equal
  1389. '(yes no yes)
  1390. (org-element-map
  1391. tree 'table-cell
  1392. (lambda (cell)
  1393. (if (org-export-table-cell-ends-colgroup-p cell info) 'yes 'no))
  1394. info)))))
  1395. (ert-deftest test-org-export/table-row-starts-rowgroup-p ()
  1396. "Test `org-export-table-row-starts-rowgroup-p' specifications."
  1397. ;; 1. A row at the beginning of a table always starts a row group.
  1398. ;; So does a row following a table rule.
  1399. (org-test-with-parsed-data "
  1400. | a |
  1401. |---|
  1402. | b |"
  1403. (should
  1404. (equal
  1405. '(yes no yes)
  1406. (org-element-map
  1407. tree 'table-row
  1408. (lambda (row)
  1409. (if (org-export-table-row-starts-rowgroup-p row info) 'yes 'no))
  1410. info))))
  1411. ;; 2. Special rows should be ignored when determining the beginning
  1412. ;; of the row.
  1413. (org-test-with-parsed-data "
  1414. | / | < |
  1415. | | a |
  1416. |---+---|
  1417. | / | < |
  1418. | | b |"
  1419. (should
  1420. (equal
  1421. '(yes no yes)
  1422. (org-element-map
  1423. tree 'table-row
  1424. (lambda (row)
  1425. (if (org-export-table-row-starts-rowgroup-p row info) 'yes 'no))
  1426. info)))))
  1427. (ert-deftest test-org-export/table-row-ends-rowgroup-p ()
  1428. "Test `org-export-table-row-ends-rowgroup-p' specifications."
  1429. ;; 1. A row at the end of a table always ends a row group. So does
  1430. ;; a row preceding a table rule.
  1431. (org-test-with-parsed-data "
  1432. | a |
  1433. |---|
  1434. | b |"
  1435. (should
  1436. (equal
  1437. '(yes no yes)
  1438. (org-element-map
  1439. tree 'table-row
  1440. (lambda (row)
  1441. (if (org-export-table-row-ends-rowgroup-p row info) 'yes 'no))
  1442. info))))
  1443. ;; 2. Special rows should be ignored when determining the beginning
  1444. ;; of the row.
  1445. (org-test-with-parsed-data "
  1446. | | a |
  1447. | / | < |
  1448. |---+---|
  1449. | | b |
  1450. | / | < |"
  1451. (should
  1452. (equal
  1453. '(yes no yes)
  1454. (org-element-map
  1455. tree 'table-row
  1456. (lambda (row)
  1457. (if (org-export-table-row-ends-rowgroup-p row info) 'yes 'no))
  1458. info)))))
  1459. (ert-deftest test-org-export/table-row-starts-header-p ()
  1460. "Test `org-export-table-row-starts-header-p' specifications."
  1461. ;; 1. Only the row starting the first row group starts the table
  1462. ;; header.
  1463. (org-test-with-parsed-data "
  1464. | a |
  1465. | b |
  1466. |---|
  1467. | c |"
  1468. (should
  1469. (equal
  1470. '(yes no no no)
  1471. (org-element-map
  1472. tree 'table-row
  1473. (lambda (row)
  1474. (if (org-export-table-row-starts-header-p row info) 'yes 'no))
  1475. info))))
  1476. ;; 2. A row cannot start an header if there's no header in the
  1477. ;; table.
  1478. (org-test-with-parsed-data "
  1479. | a |
  1480. |---|"
  1481. (should-not
  1482. (org-export-table-row-starts-header-p
  1483. (org-element-map tree 'table-row 'identity info 'first-match)
  1484. info))))
  1485. (ert-deftest test-org-export/table-row-ends-header-p ()
  1486. "Test `org-export-table-row-ends-header-p' specifications."
  1487. ;; 1. Only the row starting the first row group starts the table
  1488. ;; header.
  1489. (org-test-with-parsed-data "
  1490. | a |
  1491. | b |
  1492. |---|
  1493. | c |"
  1494. (should
  1495. (equal
  1496. '(no yes no no)
  1497. (org-element-map
  1498. tree 'table-row
  1499. (lambda (row)
  1500. (if (org-export-table-row-ends-header-p row info) 'yes 'no))
  1501. info))))
  1502. ;; 2. A row cannot start an header if there's no header in the
  1503. ;; table.
  1504. (org-test-with-parsed-data "
  1505. | a |
  1506. |---|"
  1507. (should-not
  1508. (org-export-table-row-ends-header-p
  1509. (org-element-map tree 'table-row 'identity info 'first-match)
  1510. info))))
  1511. ;;; Topology
  1512. (ert-deftest test-org-export/get-next-element ()
  1513. "Test `org-export-get-next-element' specifications."
  1514. ;; Standard test.
  1515. (should
  1516. (equal "b"
  1517. (org-test-with-parsed-data "* Headline\n*a* b"
  1518. (org-export-get-next-element
  1519. (org-element-map tree 'bold 'identity info t) info))))
  1520. ;; Return nil when no previous element.
  1521. (should-not
  1522. (org-test-with-parsed-data "* Headline\na *b*"
  1523. (org-export-get-next-element
  1524. (org-element-map tree 'bold 'identity info t) info)))
  1525. ;; Non-exportable elements are ignored.
  1526. (should-not
  1527. (let ((org-export-with-timestamps nil))
  1528. (org-test-with-parsed-data "\alpha <2012-03-29 Thu>"
  1529. (org-export-get-next-element
  1530. (org-element-map tree 'entity 'identity info t) info)))))
  1531. (ert-deftest test-org-export/get-previous-element ()
  1532. "Test `org-export-get-previous-element' specifications."
  1533. ;; Standard test.
  1534. (should
  1535. (equal "a "
  1536. (org-test-with-parsed-data "* Headline\na *b*"
  1537. (org-export-get-previous-element
  1538. (org-element-map tree 'bold 'identity info t) info))))
  1539. ;; Return nil when no previous element.
  1540. (should-not
  1541. (org-test-with-parsed-data "* Headline\n*a* b"
  1542. (org-export-get-previous-element
  1543. (org-element-map tree 'bold 'identity info t) info)))
  1544. ;; Non-exportable elements are ignored.
  1545. (should-not
  1546. (let ((org-export-with-timestamps nil))
  1547. (org-test-with-parsed-data "<2012-03-29 Thu> \alpha"
  1548. (org-export-get-previous-element
  1549. (org-element-map tree 'entity 'identity info t) info)))))
  1550. (provide 'test-org-export)
  1551. ;;; test-org-export.el end here