test-org-element.el 51 KB

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