test-org-element.el 48 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279
  1. ;;; test-org-element.el --- Tests for org-element.el
  2. ;; Copyright (C) 2012 Nicolas Goaziou
  3. ;; Author: Nicolas Goaziou <n.goaziou at gmail dot com>
  4. ;; This program is free software; you can redistribute it and/or modify
  5. ;; it under the terms of the GNU General Public License as published by
  6. ;; the Free Software Foundation, either version 3 of the License, or
  7. ;; (at your option) any later version.
  8. ;; This program is distributed in the hope that it will be useful,
  9. ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  10. ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  11. ;; GNU General Public License for more details.
  12. ;; You should have received a copy of the GNU General Public License
  13. ;; along with this program. If not, see <http://www.gnu.org/licenses/>.
  14. ;;; Commentary:
  15. ;;; Code:
  16. (unless (featurep 'org-element)
  17. (signal 'missing-test-dependency "org-element"))
  18. (defun org-test-parse-and-interpret (text)
  19. "Parse TEXT as Org syntax and interpret it.
  20. Return interpreted string."
  21. (with-temp-buffer
  22. (org-mode)
  23. (insert text)
  24. (org-element-interpret-data (org-element-parse-buffer))))
  25. ;;; Test Parsers
  26. ;;;; Example-blocks and Src-blocks
  27. (ert-deftest test-org-element/block-switches ()
  28. "Test `example-block' and `src-block' switches parsing."
  29. (let ((org-coderef-label-format "(ref:%s)"))
  30. ;; 1. Test "-i" switch.
  31. (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp\n(+ 1 1)\n#+END_SRC"
  32. (let ((element (org-element-current-element)))
  33. (should-not (org-element-property :preserve-indent element))))
  34. (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp -i\n(+ 1 1)\n#+END_SRC"
  35. (let ((element (org-element-current-element)))
  36. (should (org-element-property :preserve-indent element))))
  37. (org-test-with-temp-text "#+BEGIN_EXAMPLE\nText.\n#+END_EXAMPLE"
  38. (let ((element (org-element-current-element)))
  39. (should-not (org-element-property :preserve-indent element))))
  40. (org-test-with-temp-text "#+BEGIN_EXAMPLE -i\nText.\n#+END_EXAMPLE"
  41. (let ((element (org-element-current-element)))
  42. (should (org-element-property :preserve-indent element))))
  43. ;; 2. "-n -r -k" combination should number lines, retain labels but
  44. ;; not use them in coderefs.
  45. (org-test-with-temp-text "#+BEGIN_EXAMPLE -n -r -k\nText.\n#+END_EXAMPLE"
  46. (let ((element (org-element-current-element)))
  47. (should (and (org-element-property :number-lines element)
  48. (org-element-property :retain-labels element)
  49. (not (org-element-property :use-labels element))))))
  50. (org-test-with-temp-text
  51. "#+BEGIN_SRC emacs-lisp -n -r -k\n(+ 1 1)\n#+END_SRC"
  52. (let ((element (org-element-current-element)))
  53. (should (and (org-element-property :number-lines element)
  54. (org-element-property :retain-labels element)
  55. (not (org-element-property :use-labels element))))))
  56. ;; 3. "-n -r" combination should number-lines remove labels and not
  57. ;; use them in coderefs.
  58. (org-test-with-temp-text "#+BEGIN_EXAMPLE -n -r\nText.\n#+END_EXAMPLE"
  59. (let ((element (org-element-current-element)))
  60. (should (and (org-element-property :number-lines element)
  61. (not (org-element-property :retain-labels element))
  62. (not (org-element-property :use-labels element))))))
  63. (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp -n -r\n(+ 1 1)\n#+END_SRC"
  64. (let ((element (org-element-current-element)))
  65. (should (and (org-element-property :number-lines element)
  66. (not (org-element-property :retain-labels element))
  67. (not (org-element-property :use-labels element))))))
  68. ;; 4. "-n" or "+n" should number lines, retain labels and use them
  69. ;; in coderefs.
  70. (org-test-with-temp-text "#+BEGIN_EXAMPLE -n\nText.\n#+END_EXAMPLE"
  71. (let ((element (org-element-current-element)))
  72. (should (and (org-element-property :number-lines element)
  73. (org-element-property :retain-labels element)
  74. (org-element-property :use-labels element)))))
  75. (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp -n\n(+ 1 1)\n#+END_SRC"
  76. (let ((element (org-element-current-element)))
  77. (should (and (org-element-property :number-lines element)
  78. (org-element-property :retain-labels element)
  79. (org-element-property :use-labels element)))))
  80. (org-test-with-temp-text "#+BEGIN_EXAMPLE +n\nText.\n#+END_EXAMPLE"
  81. (let ((element (org-element-current-element)))
  82. (should (and (org-element-property :number-lines element)
  83. (org-element-property :retain-labels element)
  84. (org-element-property :use-labels element)))))
  85. (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp +n\n(+ 1 1)\n#+END_SRC"
  86. (let ((element (org-element-current-element)))
  87. (should (and (org-element-property :number-lines element)
  88. (org-element-property :retain-labels element)
  89. (org-element-property :use-labels element)))))
  90. ;; 5. No switch should not number lines, but retain labels and use
  91. ;; them in coderefs.
  92. (org-test-with-temp-text "#+BEGIN_EXAMPLE\nText.\n#+END_EXAMPLE"
  93. (let ((element (org-element-current-element)))
  94. (should (and (not (org-element-property :number-lines element))
  95. (org-element-property :retain-labels element)
  96. (org-element-property :use-labels element)))))
  97. (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp\n(+ 1 1)\n#+END_SRC"
  98. (let ((element (org-element-current-element)))
  99. (should (and (not (org-element-property :number-lines element))
  100. (org-element-property :retain-labels element)
  101. (org-element-property :use-labels element)))))
  102. ;; 6. "-r" switch only: do not number lines, remove labels, and
  103. ;; don't use labels in coderefs.
  104. (org-test-with-temp-text "#+BEGIN_EXAMPLE -r\nText.\n#+END_EXAMPLE"
  105. (let ((element (org-element-current-element)))
  106. (should (and (not (org-element-property :number-lines element))
  107. (not (org-element-property :retain-labels element))
  108. (not (org-element-property :use-labels element))))))
  109. (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp -r\n(+ 1 1)\n#+END_SRC"
  110. (let ((element (org-element-current-element)))
  111. (should (and (not (org-element-property :number-lines element))
  112. (not (org-element-property :retain-labels element))
  113. (not (org-element-property :use-labels element))))))
  114. ;; 7. Recognize coderefs with user-defined syntax.
  115. (org-test-with-temp-text
  116. "#+BEGIN_EXAMPLE -l \"[ref:%s]\"\nText [ref:text]\n#+END_EXAMPLE"
  117. (let ((element (org-element-current-element)))
  118. (should
  119. (equal (org-element-property :label-fmt element) "[ref:%s]"))))
  120. (org-test-with-temp-text
  121. "#+BEGIN_SRC emacs-lisp -l \"[ref:%s]\"\n(+ 1 1) [ref:text]\n#+END_SRC"
  122. (let ((element (org-element-current-element)))
  123. (should
  124. (equal (org-element-property :label-fmt element) "[ref:%s]"))))))
  125. ;;;; Export snippets
  126. (ert-deftest test-org-element/export-snippet-parser ()
  127. "Test export-snippet parsing."
  128. (should
  129. (equal
  130. (org-test-with-temp-text "<back-end@contents>"
  131. (org-element-map
  132. (org-element-parse-buffer) 'export-snippet 'identity nil t))
  133. '(export-snippet
  134. (:back-end "back-end"
  135. :value "contents" :begin 1 :end 20 :post-blank 0)))))
  136. ;;;; Footnotes references
  137. (ert-deftest test-org-element/footnote-reference-parser ()
  138. "Test footnote-reference parsing."
  139. ;; 1. Parse a standard reference.
  140. (org-test-with-temp-text "[fn:label]"
  141. (should (equal (org-element-footnote-reference-parser)
  142. '(footnote-reference
  143. (:label "fn:label" :type standard :inline-definition nil
  144. :begin 1 :end 11 :post-blank 0)))))
  145. ;; 2. Parse a normalized reference.
  146. (org-test-with-temp-text "[1]"
  147. (should (equal (org-element-footnote-reference-parser)
  148. '(footnote-reference
  149. (:label "1" :type standard :inline-definition nil
  150. :begin 1 :end 4 :post-blank 0)))))
  151. ;; 3. Parse an inline reference.
  152. (org-test-with-temp-text "[fn:test:def]"
  153. (should (equal (org-element-footnote-reference-parser)
  154. '(footnote-reference
  155. (:label "fn:test" :type inline :inline-definition ("def")
  156. :begin 1 :end 14 :post-blank 0)))))
  157. ;; 4. Parse an anonymous reference.
  158. (org-test-with-temp-text "[fn::def]"
  159. (should (equal (org-element-footnote-reference-parser)
  160. '(footnote-reference
  161. (:label nil :type inline :inline-definition ("def")
  162. :begin 1 :end 10 :post-blank 0)))))
  163. ;; 5. Parse nested footnotes.
  164. (org-test-with-temp-text "[fn::def [fn:label]]"
  165. (should
  166. (equal
  167. (org-element-footnote-reference-parser)
  168. '(footnote-reference
  169. (:label nil :type inline
  170. :inline-definition
  171. ("def "
  172. (footnote-reference
  173. (:label "fn:label" :type standard :inline-definition nil
  174. :begin 5 :end 15 :post-blank 0)))
  175. :begin 1 :end 21 :post-blank 0)))))
  176. ;; 6. Parse adjacent footnotes.
  177. (org-test-with-temp-text "[fn:label1][fn:label2]"
  178. (should
  179. (equal
  180. (org-element-footnote-reference-parser)
  181. '(footnote-reference
  182. (:label "fn:label1" :type standard :inline-definition nil :begin 1
  183. :end 12 :post-blank 0)))))
  184. ;; 7. Only properly closed footnotes are recognized as such.
  185. (org-test-with-temp-text "Text [fn:label"
  186. (should-not
  187. (org-element-map
  188. (org-element-parse-buffer) 'footnote-reference 'identity))))
  189. ;;;; Headlines
  190. (ert-deftest test-org-element/headline-quote-keyword ()
  191. "Test QUOTE keyword recognition."
  192. ;; Reference test.
  193. (org-test-with-temp-text "* Headline"
  194. (let ((org-quote-string "QUOTE"))
  195. (should-not (org-element-property :quotedp (org-element-at-point)))))
  196. ;; Standard position.
  197. (org-test-with-temp-text "* QUOTE Headline"
  198. (let ((org-quote-string "QUOTE"))
  199. (let ((headline (org-element-at-point)))
  200. (should (org-element-property :quotedp headline))
  201. ;; Test removal from raw value.
  202. (should (equal (org-element-property :raw-value headline) "Headline"))))
  203. ;; Case sensitivity.
  204. (let ((org-quote-string "Quote"))
  205. (should-not (org-element-property :quotedp (org-element-at-point)))))
  206. ;; With another keyword.
  207. (org-test-with-temp-text "* TODO QUOTE Headline"
  208. (let ((org-quote-string "QUOTE")
  209. (org-todo-keywords '((sequence "TODO" "DONE"))))
  210. (should (org-element-property :quotedp (org-element-at-point))))))
  211. (ert-deftest test-org-element/headline-comment-keyword ()
  212. "Test COMMENT keyword recognition."
  213. ;; Reference test.
  214. (org-test-with-temp-text "* Headline"
  215. (let ((org-comment-string "COMMENT"))
  216. (should-not (org-element-property :commentedp (org-element-at-point)))))
  217. ;; Standard position.
  218. (org-test-with-temp-text "* COMMENT Headline"
  219. (let ((org-comment-string "COMMENT"))
  220. (let ((headline (org-element-at-point)))
  221. (should (org-element-property :commentedp headline))
  222. ;; Test removal from raw value.
  223. (should (equal (org-element-property :raw-value headline) "Headline"))))
  224. ;; Case sensitivity.
  225. (let ((org-comment-string "Comment"))
  226. (should-not (org-element-property :commentedp (org-element-at-point)))))
  227. ;; With another keyword.
  228. (org-test-with-temp-text "* TODO COMMENT Headline"
  229. (let ((org-comment-string "COMMENT")
  230. (org-todo-keywords '((sequence "TODO" "DONE"))))
  231. (should (org-element-property :commentedp (org-element-at-point))))))
  232. (ert-deftest test-org-element/headline-archive-tag ()
  233. "Test ARCHIVE tag recognition."
  234. ;; Reference test.
  235. (org-test-with-temp-text "* Headline"
  236. (let ((org-archive-tag "ARCHIVE"))
  237. (should-not (org-element-property :archivedp (org-element-at-point)))))
  238. ;; Single tag.
  239. (org-test-with-temp-text "* Headline :ARCHIVE:"
  240. (let ((org-archive-tag "ARCHIVE"))
  241. (let ((headline (org-element-at-point)))
  242. (should (org-element-property :archivedp headline))
  243. ;; Test tag removal.
  244. (should-not (org-element-property :tags headline))))
  245. (let ((org-archive-tag "Archive"))
  246. (should-not (org-element-property :archivedp (org-element-at-point)))))
  247. ;; Multiple tags.
  248. (org-test-with-temp-text "* Headline :test:ARCHIVE:"
  249. (let ((org-archive-tag "ARCHIVE"))
  250. (let ((headline (org-element-at-point)))
  251. (should (org-element-property :archivedp headline))
  252. ;; Test tag removal.
  253. (should (equal (org-element-property :tags headline) '("test")))))))
  254. ;;;; Links
  255. (ert-deftest test-org-element/link-parser ()
  256. "Test link parsing."
  257. ;; 1. Radio target.
  258. (should
  259. (equal (org-test-with-temp-text "A radio link"
  260. (org-element-map
  261. (let ((org-target-link-regexp "radio")) (org-element-parse-buffer))
  262. 'link 'identity nil t))
  263. '(link (:type "radio" :path "radio" :raw-link "radio" :begin 3 :end 9
  264. :contents-begin nil :contents-end nil :post-blank 1))))
  265. ;; 2. Standard link.
  266. ;;
  267. ;; 2.1. With description.
  268. (should
  269. (equal (org-test-with-temp-text "[[http://orgmode.org][Orgmode.org]]"
  270. (org-element-map (org-element-parse-buffer) 'link 'identity nil t))
  271. '(link (:type "http" :path "//orgmode.org"
  272. :raw-link "http://orgmode.org" :begin 1 :end 36
  273. :contents-begin 23 :contents-end 34 :post-blank 0)
  274. "Orgmode.org")))
  275. ;; 2.2. Without description.
  276. (should
  277. (equal (org-test-with-temp-text "[[http://orgmode.org]]"
  278. (org-element-map (org-element-parse-buffer) 'link 'identity nil t))
  279. '(link (:type "http" :path "//orgmode.org"
  280. :raw-link "http://orgmode.org" :begin 1 :end 23
  281. :contents-begin nil :contents-end nil :post-blank 0))))
  282. ;; 2.3. With expansion.
  283. (should
  284. (equal (org-test-with-temp-text "[[Org:worg]]"
  285. (let ((org-link-abbrev-alist '(("Org" . "http://orgmode.org/"))))
  286. (org-element-map
  287. (org-element-parse-buffer) 'link 'identity nil t)))
  288. '(link (:type "http" :path "//orgmode.org/worg" :raw-link "Org:worg"
  289. :begin 1 :end 13 :contents-begin nil :contents-end nil
  290. :post-blank 0))))
  291. ;; 2.4. With translation.
  292. (should
  293. (equal (org-test-with-temp-text "[[http://orgmode.org]]"
  294. (flet ((link-translate (type path) (cons type "127.0.0.1")))
  295. (let ((org-link-translation-function 'link-translate))
  296. (org-element-map
  297. (org-element-parse-buffer) 'link 'identity nil t))))
  298. '(link (:type "http" :path "127.0.0.1" :raw-link "http://orgmode.org"
  299. :begin 1 :end 23 :contents-begin nil :contents-end nil
  300. :post-blank 0))))
  301. ;; 2.5. Id link.
  302. (should
  303. (equal (org-test-with-temp-text "[[id:aaaa]]"
  304. (org-element-map (org-element-parse-buffer) 'link 'identity nil t))
  305. '(link (:type "id" :path "aaaa" :raw-link "id:aaaa" :begin 1 :end 12
  306. :contents-begin nil :contents-end nil :post-blank 0))))
  307. ;; 2.6. Custom-id link.
  308. (should
  309. (equal (org-test-with-temp-text "[[#some-id]]"
  310. (org-element-map (org-element-parse-buffer) 'link 'identity nil t))
  311. '(link (:type "custom-id" :path "some-id" :raw-link "#some-id"
  312. :begin 1 :end 13 :contents-begin nil :contents-end nil
  313. :post-blank 0))))
  314. ;; 2.7 Coderef link.
  315. (should
  316. (equal (org-test-with-temp-text "[[(reference)]]"
  317. (org-element-map (org-element-parse-buffer) 'link 'identity nil t))
  318. '(link (:type "coderef" :path "reference" :raw-link "(reference)"
  319. :begin 1 :end 16 :contents-begin nil :contents-end nil
  320. :post-blank 0))))
  321. ;; 2.8 Fuzzy link.
  322. (should
  323. (equal (org-test-with-temp-text "[[target-or-title]]"
  324. (org-element-map (org-element-parse-buffer) 'link 'identity nil t))
  325. '(link (:type "fuzzy" :path "target-or-title"
  326. :raw-link "target-or-title" :begin 1 :end 20
  327. :contents-begin nil :contents-end nil :post-blank 0))))
  328. ;; 3. Plain link.
  329. (should
  330. (equal (org-test-with-temp-text "A link: http://orgmode.org"
  331. (org-element-map (org-element-parse-buffer) 'link 'identity nil t))
  332. '(link (:type "http" :path "//orgmode.org"
  333. :raw-link "http://orgmode.org" :begin 9 :end 27
  334. :contents-begin nil :contents-end nil :post-blank 0))))
  335. ;; 4. Angular link.
  336. (should
  337. (equal (org-test-with-temp-text "A link: <http://orgmode.org>"
  338. (org-element-map (org-element-parse-buffer) 'link 'identity nil t))
  339. '(link (:type "http" :path "//orgmode.org"
  340. :raw-link "http://orgmode.org" :begin 9 :end 29
  341. :contents-begin nil :contents-end nil :post-blank 0)))))
  342. ;;;; Verse blocks
  343. (ert-deftest test-org-element/verse-block-parser ()
  344. "Test verse block parsing."
  345. ;; Standard test.
  346. (org-test-with-temp-text "#+BEGIN_VERSE\nVerse block\n#+END_VERSE"
  347. (should
  348. (equal
  349. (org-element-map (org-element-parse-buffer) 'verse-block 'identity nil t)
  350. '(verse-block
  351. (:begin 1 :end 38 :contents-begin 15 :contents-end 27 :hiddenp nil
  352. :post-blank 0)
  353. "Verse block\n"))))
  354. ;; Ignore case.
  355. (org-test-with-temp-text "#+begin_verse\nVerse block\n#+end_verse"
  356. (should
  357. (equal
  358. (org-element-map (org-element-parse-buffer) 'verse-block 'identity nil t)
  359. '(verse-block
  360. (:begin 1 :end 38 :contents-begin 15 :contents-end 27 :hiddenp nil
  361. :post-blank 0)
  362. "Verse block\n"))))
  363. ;; Parse folding.
  364. (org-test-with-temp-text "#+BEGIN_VERSE\nVerse block\n#+END_VERSE"
  365. (org-hide-block-all)
  366. (should
  367. (equal
  368. (org-element-map (org-element-parse-buffer) 'verse-block 'identity nil t)
  369. '(verse-block
  370. (:begin 1 :end 38 :contents-begin 15 :contents-end 27
  371. :hiddenp org-hide-block :post-blank 0)
  372. "Verse block\n"))))
  373. ;; Parse objects in verse blocks.
  374. (org-test-with-temp-text "#+BEGIN_VERSE\nVerse \\alpha\n#+END_VERSE"
  375. (should (org-element-map (org-element-parse-buffer) 'entity 'identity))))
  376. ;;; Test Interpreters.
  377. (ert-deftest test-org-element/interpret-affiliated-keywords ()
  378. "Test if affiliated keywords are correctly interpreted."
  379. ;; Interpret simple keywords.
  380. (should
  381. (equal
  382. (org-element-interpret-data
  383. '(org-data nil (paragraph (:name "para") "Paragraph")))
  384. "#+NAME: para\nParagraph\n"))
  385. ;; Interpret multiple keywords.
  386. (should
  387. (equal
  388. (org-element-interpret-data
  389. '(org-data nil (paragraph (:attr_ascii ("line1" "line2")) "Paragraph")))
  390. "#+ATTR_ASCII: line1\n#+ATTR_ASCII: line2\nParagraph\n"))
  391. ;; Interpret parsed keywords.
  392. (should
  393. (equal
  394. (org-element-interpret-data
  395. '(org-data nil (paragraph (:caption ("caption")) "Paragraph")))
  396. "#+CAPTION: caption\nParagraph\n"))
  397. ;; Interpret dual keywords.
  398. (should
  399. (equal
  400. (org-element-interpret-data
  401. '(org-data nil (paragraph (:caption (("long") "short")) "Paragraph")))
  402. "#+CAPTION[short]: long\nParagraph\n")))
  403. (ert-deftest test-org-element/center-block-interpreter ()
  404. "Test center block interpreter."
  405. (should
  406. (equal (org-test-parse-and-interpret "#+BEGIN_CENTER\nTest\n#+END_CENTER")
  407. "#+BEGIN_CENTER\nTest\n#+END_CENTER\n")))
  408. (ert-deftest test-org-element/drawer-interpreter ()
  409. "Test drawer interpreter."
  410. (should
  411. (equal (let ((org-drawers '("TEST")))
  412. (org-test-parse-and-interpret ":TEST:\nTest\n:END:"))
  413. ":TEST:\nTest\n:END:\n")))
  414. (ert-deftest test-org-element/dynamic-block-interpreter ()
  415. "Test dynamic block interpreter."
  416. (should
  417. (equal (org-test-parse-and-interpret
  418. "#+BEGIN: myblock :parameter value1\nTest\n#+END:")
  419. "#+BEGIN: myblock :parameter value1\nTest\n#+END:\n")))
  420. (ert-deftest test-org-element/footnote-definition-interpreter ()
  421. "Test footnote definition interpreter."
  422. (should (equal (org-test-parse-and-interpret "[fn:1] Test") "[fn:1] Test\n")))
  423. (ert-deftest test-org-element/headline-interpreter ()
  424. "Test headline and section interpreters."
  425. ;; 1. Standard test.
  426. (should (equal (org-test-parse-and-interpret "* Headline") "* Headline\n"))
  427. ;; 2. With TODO keywords.
  428. (should
  429. (equal (let ((org-todo-keywords '((sequence "TODO" "DONE"))))
  430. (org-test-parse-and-interpret "* TODO Headline"))
  431. "* TODO Headline\n"))
  432. ;; 3. With tags...
  433. ;;
  434. ;; 3.1. ... and a positive `org-tags-column' value.
  435. (should
  436. (equal (let ((org-tags-column 20))
  437. (org-test-parse-and-interpret "* Headline :tag:"))
  438. "* Headline :tag:\n"))
  439. ;; 3.2. ... and a negative `org-tags-column' value.
  440. (should
  441. (equal (let ((org-tags-column -20))
  442. (org-test-parse-and-interpret "* Headline :tag:"))
  443. "* Headline :tag:\n"))
  444. ;; 3.3. ... and a null `org-tags-column' value.
  445. (should
  446. (equal (let ((org-tags-column 0))
  447. (org-test-parse-and-interpret "* Headline :tag:"))
  448. "* Headline :tag:\n"))
  449. ;; 4. With priority cookie.
  450. (should
  451. (equal (org-test-parse-and-interpret "* [#B] Headline")
  452. "* [#B] Headline\n"))
  453. ;; 5. With comment keyword.
  454. (should
  455. (equal (let ((org-comment-string "COMMENT"))
  456. (org-test-parse-and-interpret "* COMMENT Headline"))
  457. "* COMMENT Headline\n"))
  458. ;; 6. With quote section.
  459. (should
  460. (equal (let ((org-quote-string "QUOTE"))
  461. (org-test-parse-and-interpret "* QUOTE Headline"))
  462. "* QUOTE Headline\n"))
  463. ;; 7. Keep same number of blank lines before body.
  464. (should
  465. (equal (org-test-parse-and-interpret
  466. "* Headline\n\n\nText after two blank lines.")
  467. "* Headline\n\n\nText after two blank lines.\n")))
  468. (ert-deftest test-org-element/inlinetask-interpreter ()
  469. "Test inlinetask interpretation."
  470. (when (featurep 'org-inlinetask)
  471. (let ((org-inlinetask-min-level 15))
  472. ;; 1. Regular inlinetask.
  473. (should (equal (org-test-parse-and-interpret
  474. "*************** Task\nTest\n*************** END")
  475. "*************** Task\nTest\n*************** END\n"))
  476. ;; 2. Degenerate inlinetask.
  477. (should (equal (org-test-parse-and-interpret "*************** Task")
  478. "*************** Task\n"))
  479. ;; 3. Prefer degenerate form when there are no contents.
  480. (should (equal (org-test-parse-and-interpret
  481. "*************** Task\n*************** END")
  482. "*************** Task\n"))
  483. ;; 4. With TODO keywords.
  484. (should
  485. (equal (let ((org-todo-keywords '((sequence "TODO" "DONE"))))
  486. (org-test-parse-and-interpret "*************** TODO Task"))
  487. "*************** TODO Task\n"))
  488. ;; 5. With tags...
  489. ;;
  490. ;; 5.1. ... and a positive `org-tags-column' value.
  491. (should
  492. (equal (let ((org-tags-column 30))
  493. (org-test-parse-and-interpret "*************** Task :tag:"))
  494. "*************** Task :tag:\n"))
  495. ;; 5.2. ... and a negative `org-tags-column' value.
  496. (should
  497. (equal (let ((org-tags-column -30))
  498. (org-test-parse-and-interpret "*************** Task :tag:"))
  499. "*************** Task :tag:\n"))
  500. ;; 5.3. ... and a null `org-tags-column' value.
  501. (should
  502. (equal (let ((org-tags-column 0))
  503. (org-test-parse-and-interpret "*************** Task :tag:"))
  504. "*************** Task :tag:\n"))
  505. ;; 6. With priority cookie.
  506. (should
  507. (equal (org-test-parse-and-interpret "*************** [#B] Task")
  508. "*************** [#B] Task\n")))))
  509. (ert-deftest test-org-element/plain-list-interpreter ()
  510. "Test plain-list and item interpreters."
  511. ;; 1. Unordered list.
  512. (should (equal (org-test-parse-and-interpret "- item 1") "- item 1\n"))
  513. ;; 2. Description list.
  514. (should
  515. (equal (org-test-parse-and-interpret "- tag :: desc") "- tag :: desc\n"))
  516. ;; 3. Ordered list.
  517. (should
  518. (equal (let ((org-plain-list-ordered-item-terminator t))
  519. (org-test-parse-and-interpret "1. Item"))
  520. "1. Item\n"))
  521. ;; 4. Ordered list with counter.
  522. (should
  523. (equal (let ((org-plain-list-ordered-item-terminator t))
  524. (org-test-parse-and-interpret "1. [@5] Item"))
  525. "5. [@5] Item\n"))
  526. ;; 5. List with check-boxes.
  527. (should
  528. (equal (org-test-parse-and-interpret
  529. "- [-] Item 1\n - [X] Item 2\n - [ ] Item 3")
  530. "- [-] Item 1\n - [X] Item 2\n - [ ] Item 3\n")))
  531. (ert-deftest test-org-element/quote-block-interpreter ()
  532. "Test quote block interpreter."
  533. (should (equal (org-test-parse-and-interpret
  534. "#+BEGIN_QUOTE\nTest\n#+END_QUOTE")
  535. "#+BEGIN_QUOTE\nTest\n#+END_QUOTE\n")))
  536. (ert-deftest test-org-element/special-block-interpreter ()
  537. "Test special block interpreter."
  538. (should (equal (org-test-parse-and-interpret
  539. "#+BEGIN_SPECIAL\nTest\n#+END_SPECIAL")
  540. "#+BEGIN_SPECIAL\nTest\n#+END_SPECIAL\n")))
  541. (ert-deftest test-org-element/babel-call-interpreter ()
  542. "Test babel call interpreter."
  543. ;; 1. Without argument.
  544. (should (equal (org-test-parse-and-interpret "#+CALL: test()")
  545. "#+CALL: test()\n"))
  546. ;; 2. With argument.
  547. (should (equal (org-test-parse-and-interpret "#+CALL: test(x=2)")
  548. "#+CALL: test(x=2)\n"))
  549. ;; 3. With header arguments.
  550. (should (equal (org-test-parse-and-interpret
  551. "#+CALL: test[:results output]()[:results html]")
  552. "#+CALL: test[:results output]()[:results html]\n")))
  553. (ert-deftest test-org-element/clock-interpreter ()
  554. "Test clock interpreter."
  555. ;; Running clock.
  556. (should
  557. (equal (let ((org-clock-string "CLOCK:"))
  558. (org-test-parse-and-interpret "CLOCK: [2012-01-01 sun. 00:01]"))
  559. "CLOCK: [2012-01-01 sun. 00:01]\n"))
  560. ;; Closed clock.
  561. (should
  562. (equal
  563. (let ((org-clock-string "CLOCK:"))
  564. (org-test-parse-and-interpret "
  565. CLOCK: [2012-01-01 sun. 00:01]--[2012-01-01 sun. 00:02] => 0:01"))
  566. "CLOCK: [2012-01-01 sun. 00:01]--[2012-01-01 sun. 00:02] => 0:01\n")))
  567. (ert-deftest test-org-element/comment-interpreter ()
  568. "Test comment interpreter."
  569. ;; Regular comment.
  570. (should (equal (org-test-parse-and-interpret "#Comment") "#Comment\n"))
  571. ;; Inline comment.
  572. (should (equal (org-test-parse-and-interpret " #+ Comment")
  573. " #+ Comment\n")))
  574. (ert-deftest test-org-element/comment-block-interpreter ()
  575. "Test comment block interpreter."
  576. (should (equal (org-test-parse-and-interpret
  577. "#+BEGIN_COMMENT\nTest\n#+END_COMMENT")
  578. "#+BEGIN_COMMENT\nTest\n#+END_COMMENT\n")))
  579. (ert-deftest test-org-element/example-block-interpreter ()
  580. "Test example block interpreter."
  581. ;; Without switches.
  582. (should (equal (org-test-parse-and-interpret
  583. "#+BEGIN_EXAMPLE\nTest\n#+END_EXAMPLE")
  584. "#+BEGIN_EXAMPLE\nTest\n#+END_EXAMPLE\n"))
  585. ;; With switches.
  586. (should
  587. (equal (org-test-parse-and-interpret
  588. "#+BEGIN_EXAMPLE -n -k\n(+ 1 1)\n#+END_EXAMPLE")
  589. "#+BEGIN_EXAMPLE -n -k\n(+ 1 1)\n#+END_EXAMPLE\n")))
  590. (ert-deftest test-org-element/export-block-interpreter ()
  591. "Test export block interpreter."
  592. (should (equal (org-test-parse-and-interpret
  593. "#+BEGIN_HTML\nTest\n#+END_HTML")
  594. "#+BEGIN_HTML\nTest\n#+END_HTML\n")))
  595. (ert-deftest test-org-element/fixed-width-interpreter ()
  596. "Test fixed width interpreter."
  597. (should (equal (org-test-parse-and-interpret ": Test") ": Test\n")))
  598. (ert-deftest test-org-element/horizontal-rule-interpreter ()
  599. "Test horizontal rule interpreter."
  600. (should (equal (org-test-parse-and-interpret "-------") "-----\n")))
  601. (ert-deftest test-org-element/keyword-interpreter ()
  602. "Test keyword interpreter."
  603. (should (equal (org-test-parse-and-interpret "#+KEYWORD: value")
  604. "#+KEYWORD: value\n")))
  605. (ert-deftest test-org-element/latex-environment-interpreter ()
  606. "Test latex environment interpreter."
  607. (should (equal (org-test-parse-and-interpret
  608. "\\begin{equation}\n1+1=2\n\\end{equation}")
  609. "\\begin{equation}\n1+1=2\n\\end{equation}\n")))
  610. (ert-deftest test-org-element/planning-interpreter ()
  611. "Test planning interpreter."
  612. (let ((org-closed-string "CLOSED:")
  613. (org-deadline-string "DEADLINE:")
  614. (org-scheduled-string "SCHEDULED:"))
  615. (should
  616. (equal
  617. (org-test-parse-and-interpret
  618. "* Headline
  619. CLOSED: <2012-01-01> DEADLINE: <2012-01-01> SCHEDULED: <2012-01-01>")
  620. "* Headline
  621. CLOSED: <2012-01-01> DEADLINE: <2012-01-01> SCHEDULED: <2012-01-01>\n"))))
  622. (ert-deftest test-org-element/property-drawer-interpreter ()
  623. "Test property drawer interpreter."
  624. (should (equal (let ((org-property-format "%-10s %s"))
  625. (org-test-parse-and-interpret
  626. ":PROPERTIES:\n:prop: value\n:END:"))
  627. ":PROPERTIES:\n:prop: value\n:END:\n")))
  628. (ert-deftest test-org-element/src-block-interpreter ()
  629. "Test src block interpreter."
  630. ;; With arguments.
  631. (should
  632. (equal (org-test-parse-and-interpret
  633. "#+BEGIN_SRC emacs-lisp :results silent\n(+ 1 1)\n#+END_SRC")
  634. "#+BEGIN_SRC emacs-lisp :results silent\n(+ 1 1)\n#+END_SRC\n"))
  635. ;; With switches.
  636. (should
  637. (equal (org-test-parse-and-interpret
  638. "#+BEGIN_SRC emacs-lisp -n -k\n(+ 1 1)\n#+END_SRC")
  639. "#+BEGIN_SRC emacs-lisp -n -k\n(+ 1 1)\n#+END_SRC\n")))
  640. (ert-deftest test-org-element/table-interpreter ()
  641. "Test table, table-row and table-cell interpreters."
  642. ;; 1. Simple table.
  643. (should (equal (org-test-parse-and-interpret "| a | b |\n| c | d |")
  644. "| a | b |\n| c | d |\n"))
  645. ;; 2. Table with horizontal rules.
  646. (should (equal (org-test-parse-and-interpret
  647. "| a | b |\n|---+---|\n| c | d |")
  648. "| a | b |\n|---+---|\n| c | d |\n"))
  649. ;; 3. Table with meta-data.
  650. (should (equal (org-test-parse-and-interpret "| / | < | > |\n| * | 1 | 2 |")
  651. "| / | < | > |\n| * | 1 | 2 |\n")))
  652. (ert-deftest test-org-element/verse-block-interpreter ()
  653. "Test verse block interpretation."
  654. (should
  655. (equal (org-test-parse-and-interpret "#+BEGIN_VERSE\nTest\n#+END_VERSE")
  656. "#+BEGIN_VERSE\nTest\n#+END_VERSE\n")))
  657. (ert-deftest test-org-element/bold-interpreter ()
  658. "Test bold interpreter."
  659. (should (equal (org-test-parse-and-interpret "*text*") "*text*\n")))
  660. (ert-deftest test-org-element/code-interpreter ()
  661. "Test code interpreter."
  662. (should (equal (org-test-parse-and-interpret "~text~") "~text~\n")))
  663. (ert-deftest test-org-element/entity-interpreter ()
  664. "Test entity interpreter."
  665. ;; 1. Without brackets.
  666. (should
  667. (equal (org-test-parse-and-interpret "\\alpha text") "\\alpha text\n"))
  668. ;; 2. With brackets.
  669. (should
  670. (equal (org-test-parse-and-interpret "\\alpha{}text") "\\alpha{}text\n")))
  671. (ert-deftest test-org-element/export-snippet-interpreter ()
  672. "Test export snippet interpreter."
  673. (should (equal (org-test-parse-and-interpret "<back-end@contents>")
  674. "<back-end@contents>\n")))
  675. (ert-deftest test-org-element/footnote-reference-interpreter ()
  676. "Test footnote reference interpreter."
  677. ;; 1. Regular reference.
  678. (should (equal (org-test-parse-and-interpret "Text[fn:1]") "Text[fn:1]\n"))
  679. ;; 2. Normalized reference.
  680. (should (equal (org-test-parse-and-interpret "Text[1]") "Text[1]\n"))
  681. ;; 3. Named reference.
  682. (should (equal (org-test-parse-and-interpret "Text[fn:label]")
  683. "Text[fn:label]\n"))
  684. ;; 4. Inline reference.
  685. (should (equal (org-test-parse-and-interpret "Text[fn:label:def]")
  686. "Text[fn:label:def]\n"))
  687. ;; 5. Anonymous reference.
  688. (should (equal (org-test-parse-and-interpret "Text[fn::def]")
  689. "Text[fn::def]\n")))
  690. (ert-deftest test-org-element/inline-babel-call-interpreter ()
  691. "Test inline babel call interpreter."
  692. ;; 1. Without arguments.
  693. (should (equal (org-test-parse-and-interpret "call_test()") "call_test()\n"))
  694. ;; 2. With arguments.
  695. (should (equal (org-test-parse-and-interpret "call_test(x=2)")
  696. "call_test(x=2)\n"))
  697. ;; 3. With header arguments.
  698. (should (equal (org-test-parse-and-interpret
  699. "call_test[:results output]()[:results html]")
  700. "call_test[:results output]()[:results html]\n")))
  701. (ert-deftest test-org-element/inline-src-block-interpreter ()
  702. "Test inline src block interpreter."
  703. ;; 1. Without header argument.
  704. (should (equal (org-test-parse-and-interpret "src_emacs-lisp{(+ 1 1)}")
  705. "src_emacs-lisp{(+ 1 1)}\n"))
  706. ;; 2. With header arguments.
  707. (should (equal (org-test-parse-and-interpret
  708. "src_emacs-lisp[:results silent]{(+ 1 1)}")
  709. "src_emacs-lisp[:results silent]{(+ 1 1)}\n")))
  710. (ert-deftest test-org-element/italic-interpreter ()
  711. "Test italic interpreter."
  712. (should (equal (org-test-parse-and-interpret "/text/") "/text/\n")))
  713. (ert-deftest test-org-element/latex-fragment-interpreter ()
  714. "Test latex fragment interpreter."
  715. (let ((org-latex-regexps
  716. '(("begin" "^[ ]*\\(\\\\begin{\\([a-zA-Z0-9\\*]+\\)[^�]+?\\\\end{\\2}\\)" 1 t)
  717. ("$1" "\\([^$]\\|^\\)\\(\\$[^ \n,;.$]\\$\\)\\([- .,?;:'\")�]\\|$\\)" 2 nil)
  718. ("$" "\\([^$]\\|^\\)\\(\\(\\$\\([^ \n,;.$][^$\n ]*?\\(\n[^$\n ]*?\\)\\{0,2\\}[^ \n,.$]\\)\\$\\)\\)\\([- .,?;:'\")�]\\|$\\)" 2 nil)
  719. ("\\(" "\\\\([^�]*?\\\\)" 0 nil)
  720. ("\\[" "\\\\\\[[^�]*?\\\\\\]" 0 nil)
  721. ("$$" "\\$\\$[^�]*?\\$\\$" 0 nil))))
  722. (should (equal (org-test-parse-and-interpret "\\command{}")
  723. "\\command{}\n"))
  724. (should (equal (org-test-parse-and-interpret "$x$") "$x$\n"))
  725. (should (equal (org-test-parse-and-interpret "$x+y$") "$x+y$\n"))
  726. (should (equal (org-test-parse-and-interpret "$$x+y$$") "$$x+y$$\n"))
  727. (should (equal (org-test-parse-and-interpret "\\(x+y\\)") "\\(x+y\\)\n"))
  728. (should (equal (org-test-parse-and-interpret "\\[x+y\\]") "\\[x+y\\]\n"))))
  729. (ert-deftest test-org-element/line-break-interpreter ()
  730. "Test line break interpreter."
  731. (should (equal (org-test-parse-and-interpret "First line \\\\ \nSecond line")
  732. "First line \\\\\nSecond line\n")))
  733. (ert-deftest test-org-element/link-interpreter ()
  734. "Test link interpreter."
  735. ;; 1. Links targeted from a radio target.
  736. (should (equal (let ((org-target-link-regexp "radio-target"))
  737. (org-test-parse-and-interpret "a radio-target"))
  738. "a radio-target\n"))
  739. ;; 2. Regular links.
  740. ;;
  741. ;; 2.1. Without description.
  742. (should (equal (org-test-parse-and-interpret "[[http://orgmode.org]]")
  743. "[[http://orgmode.org]]\n"))
  744. ;; 2.2. With a description.
  745. (should (equal (org-test-parse-and-interpret
  746. "[[http://orgmode.org][Org mode]]")
  747. "[[http://orgmode.org][Org mode]]\n"))
  748. ;; 2.3. Id links.
  749. (should (equal (org-test-parse-and-interpret "[[id:aaaa]]") "[[id:aaaa]]\n"))
  750. ;; 2.4. Custom-id links.
  751. (should (equal (org-test-parse-and-interpret "[[#id]]") "[[#id]]\n"))
  752. ;; 2.5 Code-ref links.
  753. (should (equal (org-test-parse-and-interpret "[[(ref)]]") "[[(ref)]]\n"))
  754. ;; 3. Normalize plain links.
  755. (should (equal (org-test-parse-and-interpret "http://orgmode.org")
  756. "[[http://orgmode.org]]\n"))
  757. ;; 4. Normalize angular links.
  758. (should (equal (org-test-parse-and-interpret "<http://orgmode.org>")
  759. "[[http://orgmode.org]]\n")))
  760. (ert-deftest test-org-element/macro-interpreter ()
  761. "Test macro interpreter."
  762. ;; 1. Without argument.
  763. (should (equal (org-test-parse-and-interpret "{{{test}}}") "{{{test}}}\n"))
  764. ;; 2. With arguments.
  765. (should (equal (org-test-parse-and-interpret "{{{test(arg1,arg2)}}}")
  766. "{{{test(arg1,arg2)}}}\n")))
  767. (ert-deftest test-org-element/radio-target-interpreter ()
  768. "Test radio target interpreter."
  769. (should (equal (org-test-parse-and-interpret "<<<some text>>>")
  770. "<<<some text>>>\n")))
  771. (ert-deftest test-org-element/statistics-cookie-interpreter ()
  772. "Test statistics cookie interpreter."
  773. ;; 1. Without percent
  774. (should (equal (org-test-parse-and-interpret "[0/1]") "[0/1]\n"))
  775. ;; 2. With percent.
  776. (should (equal (org-test-parse-and-interpret "[66%]") "[66%]\n")))
  777. (ert-deftest test-org-element/strike-through-interpreter ()
  778. "Test strike through interpreter."
  779. (should (equal (org-test-parse-and-interpret "+target+") "+target+\n")))
  780. (ert-deftest test-org-element/subscript-interpreter ()
  781. "Test subscript interpreter."
  782. ;; 1. Without brackets.
  783. (should (equal (org-test-parse-and-interpret "a_b") "a_b\n"))
  784. ;; 2. With brackets.
  785. (should (equal (org-test-parse-and-interpret "a_{b}") "a_{b}\n")))
  786. (ert-deftest test-org-element/superscript-interpreter ()
  787. "Test superscript interpreter."
  788. ;; 1. Without brackets.
  789. (should (equal (org-test-parse-and-interpret "a^b") "a^b\n"))
  790. ;; 2. With brackets.
  791. (should (equal (org-test-parse-and-interpret "a^{b}") "a^{b}\n")))
  792. (ert-deftest test-org-element/target-interpreter ()
  793. "Test target interpreter."
  794. (should (equal (org-test-parse-and-interpret "<<target>>") "<<target>>\n")))
  795. (ert-deftest test-org-element/underline-interpreter ()
  796. "Test underline interpreter."
  797. (should (equal (org-test-parse-and-interpret "_text_") "_text_\n")))
  798. (ert-deftest test-org-element/verbatim-interpreter ()
  799. "Test verbatim interpreter."
  800. (should (equal (org-test-parse-and-interpret "=text=") "=text=\n")))
  801. ;;; Test Granularity
  802. (ert-deftest test-org-element/granularity ()
  803. "Test granularity impact on buffer parsing."
  804. (org-test-with-temp-text "
  805. * Head 1
  806. ** Head 2
  807. #+BEGIN_CENTER
  808. Centered paragraph.
  809. #+END_CENTER
  810. Paragraph \\alpha."
  811. ;; 1.1. Granularity set to `headline' should parse every headline
  812. ;; in buffer, and only them.
  813. (let ((tree (org-element-parse-buffer 'headline)))
  814. (should (= 2 (length (org-element-map tree 'headline 'identity))))
  815. (should-not (org-element-map tree 'paragraph 'identity)))
  816. ;; 1.2. Granularity set to `greater-element' should not enter
  817. ;; greater elements excepted headlines and sections.
  818. (let ((tree (org-element-parse-buffer 'greater-element)))
  819. (should (= 1 (length (org-element-map tree 'center-block 'identity))))
  820. (should (= 1 (length (org-element-map tree 'paragraph 'identity))))
  821. (should-not (org-element-map tree 'entity 'identity)))
  822. ;; 1.3. Granularity set to `element' should enter every
  823. ;; greater-element.
  824. (let ((tree (org-element-parse-buffer 'element)))
  825. (should (= 2 (length (org-element-map tree 'paragraph 'identity))))
  826. (should-not (org-element-map tree 'entity 'identity)))
  827. ;; 1.4. Granularity set to `object' can see everything.
  828. (let ((tree (org-element-parse-buffer 'object)))
  829. (should (= 1 (length (org-element-map tree 'entity 'identity)))))))
  830. (ert-deftest test-org-element/secondary-string-parsing ()
  831. "Test if granularity correctly toggles secondary strings parsing."
  832. ;; 1. With a granularity bigger than `object', no secondary string
  833. ;; should be parsed.
  834. ;;
  835. ;; 1.1. Test with `headline' type.
  836. (org-test-with-temp-text "* Headline"
  837. (let ((headline
  838. (org-element-map (org-element-parse-buffer 'headline) 'headline
  839. 'identity
  840. nil
  841. 'first-match)))
  842. (should (stringp (org-element-property :title headline)))))
  843. ;; 1.2. Test with `item' type.
  844. (org-test-with-temp-text "* Headline\n- tag :: item"
  845. (let ((item (org-element-map (org-element-parse-buffer 'element)
  846. 'item
  847. 'identity
  848. nil
  849. 'first-match)))
  850. (should (stringp (org-element-property :tag item)))))
  851. ;; 1.3. Test with `inlinetask' type, if avalaible.
  852. (when (featurep 'org-inlinetask)
  853. (let ((org-inlinetask-min-level 15))
  854. (org-test-with-temp-text "*************** Inlinetask"
  855. (let ((inlinetask (org-element-map (org-element-parse-buffer 'element)
  856. 'inlinetask
  857. 'identity
  858. nil
  859. 'first-match)))
  860. (should (stringp (org-element-property :title inlinetask)))))))
  861. ;; 2. With a default granularity, secondary strings should be
  862. ;; parsed.
  863. (org-test-with-temp-text "* Headline"
  864. (let ((headline
  865. (org-element-map (org-element-parse-buffer) 'headline
  866. 'identity
  867. nil
  868. 'first-match)))
  869. (should (listp (org-element-property :title headline)))))
  870. ;; 3. `org-element-at-point' should never parse a secondary string.
  871. (org-test-with-temp-text "* Headline"
  872. (should (stringp (org-element-property :title (org-element-at-point))))))
  873. ;;; Test Normalize Contents
  874. (ert-deftest test-org-element/normalize-contents ()
  875. "Test `org-element-normalize-contents' specifications."
  876. ;; 1. Remove maximum common indentation from element's contents.
  877. (should
  878. (equal
  879. (org-element-normalize-contents
  880. '(paragraph nil " Two spaces\n Three spaces"))
  881. '(paragraph nil "Two spaces\n Three spaces")))
  882. ;; 2. Ignore objects within contents when computing maximum common
  883. ;; indentation.
  884. (should
  885. (equal
  886. (org-element-normalize-contents
  887. '(paragraph nil " One " (emphasis nil "space") "\n Two spaces"))
  888. '(paragraph nil "One " (emphasis nil "space") "\n Two spaces")))
  889. ;; 3. Ignore blank lines.
  890. (should
  891. (equal
  892. (org-element-normalize-contents
  893. '(paragraph nil " Two spaces\n\n \n Two spaces"))
  894. '(paragraph nil "Two spaces\n\n \nTwo spaces")))
  895. ;; 4. Recursively enter objects in order to compute common
  896. ;; indentation.
  897. (should
  898. (equal
  899. (org-element-normalize-contents
  900. '(paragraph nil " Two spaces " (bold nil " and\n One space")))
  901. '(paragraph nil " Two spaces " (bold nil " and\nOne space"))))
  902. ;; 5. When optional argument is provided, ignore first line
  903. ;; indentation.
  904. (should
  905. (equal
  906. (org-element-normalize-contents
  907. '(paragraph nil "No space\n Two spaces\n Three spaces") t)
  908. '(paragraph nil "No space\nTwo spaces\n Three spaces"))))
  909. ;;; Test Navigation Tools.
  910. (ert-deftest test-org-element/forward-element ()
  911. "Test `org-element-forward' specifications."
  912. ;; 1. At EOB: should error.
  913. (org-test-with-temp-text "Some text\n"
  914. (goto-char (point-max))
  915. (should-error (org-element-forward)))
  916. ;; 2. Standard move: expected to ignore blank lines.
  917. (org-test-with-temp-text "First paragraph.\n\n\nSecond paragraph."
  918. (org-element-forward)
  919. (should (looking-at "Second paragraph.")))
  920. ;; 3. Headline tests.
  921. (org-test-with-temp-text "
  922. * Head 1
  923. ** Head 1.1
  924. *** Head 1.1.1
  925. ** Head 1.2"
  926. ;; 3.1. At an headline beginning: move to next headline at the
  927. ;; same level.
  928. (goto-line 3)
  929. (org-element-forward)
  930. (should (looking-at "** Head 1.2"))
  931. ;; 3.2. At an headline beginning: move to parent headline if no
  932. ;; headline at the same level.
  933. (goto-line 3)
  934. (org-element-forward)
  935. (should (looking-at "** Head 1.2")))
  936. ;; 4. Greater element tests.
  937. (org-test-with-temp-text
  938. "#+BEGIN_CENTER\nInside.\n#+END_CENTER\n\nOutside."
  939. ;; 4.1. At a greater element: expected to skip contents.
  940. (org-element-forward)
  941. (should (looking-at "Outside."))
  942. ;; 4.2. At the end of greater element contents: expected to skip
  943. ;; to the end of the greater element.
  944. (goto-line 2)
  945. (org-element-forward)
  946. (should (looking-at "Outside.")))
  947. ;; 5. List tests.
  948. (org-test-with-temp-text "
  949. - item1
  950. - sub1
  951. - sub2
  952. - sub3
  953. Inner paragraph.
  954. - item2
  955. Outside."
  956. ;; 5.1. At list top point: expected to move to the element after
  957. ;; the list.
  958. (goto-line 2)
  959. (org-element-forward)
  960. (should (looking-at "Outside."))
  961. ;; 5.2. Special case: at the first line of a sub-list, but not at
  962. ;; beginning of line, move to next item.
  963. (goto-line 2)
  964. (forward-char)
  965. (org-element-forward)
  966. (should (looking-at "- item2"))
  967. (goto-line 4)
  968. (forward-char)
  969. (org-element-forward)
  970. (should (looking-at " - sub2"))
  971. ;; 5.3 At sub-list beginning: expected to move after the sub-list.
  972. (goto-line 4)
  973. (org-element-forward)
  974. (should (looking-at " Inner paragraph."))
  975. ;; 5.4. At sub-list end: expected to move outside the sub-list.
  976. (goto-line 8)
  977. (org-element-forward)
  978. (should (looking-at " Inner paragraph."))
  979. ;; 5.5. At an item: expected to move to next item, if any.
  980. (goto-line 6)
  981. (org-element-forward)
  982. (should (looking-at " - sub3"))))
  983. (ert-deftest test-org-element/backward-element ()
  984. "Test `org-element-backward' specifications."
  985. ;; 1. At BOB (modulo some white spaces): should error.
  986. (org-test-with-temp-text " \nParagraph."
  987. (org-skip-whitespace)
  988. (should-error (org-element-backward)))
  989. ;; 2. Not at the beginning of an element: move at its beginning.
  990. (org-test-with-temp-text "Paragraph1.\n\nParagraph2."
  991. (goto-line 3)
  992. (end-of-line)
  993. (org-element-backward)
  994. (should (looking-at "Paragraph2.")))
  995. ;; 3. Headline tests.
  996. (org-test-with-temp-text "
  997. * Head 1
  998. ** Head 1.1
  999. *** Head 1.1.1
  1000. ** Head 1.2"
  1001. ;; 3.1. At an headline beginning: move to previous headline at the
  1002. ;; same level.
  1003. (goto-line 5)
  1004. (org-element-backward)
  1005. (should (looking-at "** Head 1.1"))
  1006. ;; 3.2. At an headline beginning: move to parent headline if no
  1007. ;; headline at the same level.
  1008. (goto-line 3)
  1009. (org-element-backward)
  1010. (should (looking-at "* Head 1"))
  1011. ;; 3.3. At the first top-level headline: should error.
  1012. (goto-line 2)
  1013. (should-error (org-element-backward)))
  1014. ;; 4. At beginning of first element inside a greater element:
  1015. ;; expected to move to greater element's beginning.
  1016. (org-test-with-temp-text "Before.\n#+BEGIN_CENTER\nInside.\n#+END_CENTER."
  1017. (goto-line 3)
  1018. (org-element-backward)
  1019. (should (looking-at "#\\+BEGIN_CENTER")))
  1020. ;; 5. List tests.
  1021. (org-test-with-temp-text "
  1022. - item1
  1023. - sub1
  1024. - sub2
  1025. - sub3
  1026. Inner paragraph.
  1027. - item2
  1028. Outside."
  1029. ;; 5.1. At beginning of sub-list: expected to move to the
  1030. ;; paragraph before it.
  1031. (goto-line 4)
  1032. (org-element-backward)
  1033. (should (looking-at "item1"))
  1034. ;; 5.2. At an item in a list: expected to move at previous item.
  1035. (goto-line 8)
  1036. (org-element-backward)
  1037. (should (looking-at " - sub2"))
  1038. (goto-line 12)
  1039. (org-element-backward)
  1040. (should (looking-at "- item1"))
  1041. ;; 5.3. At end of list/sub-list: expected to move to list/sub-list
  1042. ;; beginning.
  1043. (goto-line 10)
  1044. (org-element-backward)
  1045. (should (looking-at " - sub1"))
  1046. (goto-line 15)
  1047. (org-element-backward)
  1048. (should (looking-at "- item1"))
  1049. ;; 5.4. At blank-lines before list end: expected to move to top
  1050. ;; item.
  1051. (goto-line 14)
  1052. (org-element-backward)
  1053. (should (looking-at "- item1"))))
  1054. (ert-deftest test-org-element/up-element ()
  1055. "Test `org-element-up' specifications."
  1056. ;; 1. At BOB or with no surrounding element: should error.
  1057. (org-test-with-temp-text "Paragraph."
  1058. (should-error (org-element-up)))
  1059. (org-test-with-temp-text "* Head1\n* Head2"
  1060. (goto-line 2)
  1061. (should-error (org-element-up)))
  1062. (org-test-with-temp-text "Paragraph1.\n\nParagraph2."
  1063. (goto-line 3)
  1064. (should-error (org-element-up)))
  1065. ;; 2. At an headline: move to parent headline.
  1066. (org-test-with-temp-text "* Head1\n** Sub-Head1\n** Sub-Head2"
  1067. (goto-line 3)
  1068. (org-element-up)
  1069. (should (looking-at "\\* Head1")))
  1070. ;; 3. Inside a greater element: move to greater element beginning.
  1071. (org-test-with-temp-text
  1072. "Before.\n#+BEGIN_CENTER\nParagraph1\nParagraph2\n#+END_CENTER\n"
  1073. (goto-line 3)
  1074. (org-element-up)
  1075. (should (looking-at "#\\+BEGIN_CENTER")))
  1076. ;; 4. List tests.
  1077. (org-test-with-temp-text "* Top
  1078. - item1
  1079. - sub1
  1080. - sub2
  1081. Paragraph within sub2.
  1082. - item2"
  1083. ;; 4.1. Within an item: move to the item beginning.
  1084. (goto-line 8)
  1085. (org-element-up)
  1086. (should (looking-at " - sub2"))
  1087. ;; 4.2. At an item in a sub-list: move to parent item.
  1088. (goto-line 4)
  1089. (org-element-up)
  1090. (should (looking-at "- item1"))
  1091. ;; 4.3. At an item in top list: move to beginning of whole list.
  1092. (goto-line 10)
  1093. (org-element-up)
  1094. (should (looking-at "- item1"))
  1095. ;; 4.4. Special case. At very top point: should move to parent of
  1096. ;; list.
  1097. (goto-line 2)
  1098. (org-element-up)
  1099. (should (looking-at "\\* Top"))))
  1100. (ert-deftest test-org-element/down-element ()
  1101. "Test `org-element-down' specifications."
  1102. ;; 1. Error when the element hasn't got a recursive type.
  1103. (org-test-with-temp-text "Paragraph."
  1104. (should-error (org-element-down)))
  1105. ;; 2. When at a plain-list, move to first item.
  1106. (org-test-with-temp-text "- Item 1\n - Item 1.1\n - Item 2.2"
  1107. (goto-line 2)
  1108. (org-element-down)
  1109. (should (looking-at " - Item 1.1")))
  1110. (org-test-with-temp-text "#+NAME: list\n- Item 1"
  1111. (org-element-down)
  1112. (should (looking-at " Item 1")))
  1113. ;; 3. When at a table, move to first row
  1114. (org-test-with-temp-text "#+NAME: table\n| a | b |"
  1115. (org-element-down)
  1116. (should (looking-at " a | b |")))
  1117. ;; 4. Otherwise, move inside the greater element.
  1118. (org-test-with-temp-text "#+BEGIN_CENTER\nParagraph.\n#+END_CENTER"
  1119. (org-element-down)
  1120. (should (looking-at "Paragraph"))))
  1121. (ert-deftest test-org-element/drag-backward ()
  1122. "Test `org-element-drag-backward' specifications."
  1123. ;; 1. Error when trying to move first element of buffer.
  1124. (org-test-with-temp-text "Paragraph 1.\n\nParagraph 2."
  1125. (should-error (org-element-drag-backward)))
  1126. ;; 2. Error when trying to swap nested elements.
  1127. (org-test-with-temp-text "#+BEGIN_CENTER\nTest.\n#+END_CENTER"
  1128. (forward-line)
  1129. (should-error (org-element-drag-backward)))
  1130. ;; 3. Error when trying to swap an headline element and
  1131. ;; a non-headline element.
  1132. (org-test-with-temp-text "Test.\n* Head 1"
  1133. (forward-line)
  1134. (should-error (org-element-drag-backward)))
  1135. ;; 4. Otherwise, swap elements, preserving column and blank lines
  1136. ;; between elements.
  1137. (org-test-with-temp-text "Para1\n\n\nParagraph 2\n\nPara3"
  1138. (search-forward "graph")
  1139. (org-element-drag-backward)
  1140. (should (equal (buffer-string) "Paragraph 2\n\n\nPara1\n\nPara3"))
  1141. (should (looking-at " 2"))))
  1142. (ert-deftest test-org-element/drag-forward ()
  1143. "Test `org-element-drag-forward' specifications."
  1144. ;; 1. Error when trying to move first element of buffer.
  1145. (org-test-with-temp-text "Paragraph 1.\n\nParagraph 2."
  1146. (goto-line 3)
  1147. (should-error (org-element-drag-forward)))
  1148. ;; 2. Error when trying to swap nested elements.
  1149. (org-test-with-temp-text "#+BEGIN_CENTER\nTest.\n#+END_CENTER"
  1150. (forward-line)
  1151. (should-error (org-element-drag-forward)))
  1152. ;; 3. Error when trying to swap a non-headline element and an
  1153. ;; headline.
  1154. (org-test-with-temp-text "Test.\n* Head 1"
  1155. (should-error (org-element-drag-forward)))
  1156. ;; 4. Otherwise, swap elements, preserving column and blank lines
  1157. ;; between elements.
  1158. (org-test-with-temp-text "Paragraph 1\n\n\nPara2\n\nPara3"
  1159. (search-forward "graph")
  1160. (org-element-drag-forward)
  1161. (should (equal (buffer-string) "Para2\n\n\nParagraph 1\n\nPara3"))
  1162. (should (looking-at " 1"))))
  1163. (provide 'test-org-element)
  1164. ;;; test-org-element.el ends here