test-org-element.el 44 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177
  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 ()
  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 ()
  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. ;;;; Verse blocks
  255. (ert-deftest test-org-element/verse-block ()
  256. "Test verse block parsing."
  257. ;; Standard test.
  258. (org-test-with-temp-text "#+BEGIN_VERSE\nVerse block\n#+END_VERSE"
  259. (should
  260. (equal
  261. (org-element-map (org-element-parse-buffer) 'verse-block 'identity nil t)
  262. '(verse-block
  263. (:begin 1 :end 38 :contents-begin 15 :contents-end 27 :hiddenp nil
  264. :post-blank 0)
  265. "Verse block\n"))))
  266. ;; Ignore case.
  267. (org-test-with-temp-text "#+begin_verse\nVerse block\n#+end_verse"
  268. (should
  269. (equal
  270. (org-element-map (org-element-parse-buffer) 'verse-block 'identity nil t)
  271. '(verse-block
  272. (:begin 1 :end 38 :contents-begin 15 :contents-end 27 :hiddenp nil
  273. :post-blank 0)
  274. "Verse block\n"))))
  275. ;; Parse folding.
  276. (org-test-with-temp-text "#+BEGIN_VERSE\nVerse block\n#+END_VERSE"
  277. (org-hide-block-all)
  278. (should
  279. (equal
  280. (org-element-map (org-element-parse-buffer) 'verse-block 'identity nil t)
  281. '(verse-block
  282. (:begin 1 :end 38 :contents-begin 15 :contents-end 27
  283. :hiddenp org-hide-block :post-blank 0)
  284. "Verse block\n"))))
  285. ;; Parse objects in verse blocks.
  286. (org-test-with-temp-text "#+BEGIN_VERSE\nVerse \\alpha\n#+END_VERSE"
  287. (should (org-element-map (org-element-parse-buffer) 'entity 'identity))))
  288. ;;; Test Interpreters.
  289. (ert-deftest test-org-element/interpret-affiliated-keywords ()
  290. "Test if affiliated keywords are correctly interpreted."
  291. ;; Interpret simple keywords.
  292. (should
  293. (equal
  294. (org-element-interpret-data
  295. '(org-data nil (paragraph (:name "para") "Paragraph")))
  296. "#+NAME: para\nParagraph\n"))
  297. ;; Interpret multiple keywords.
  298. (should
  299. (equal
  300. (org-element-interpret-data
  301. '(org-data nil (paragraph (:attr_ascii ("line1" "line2")) "Paragraph")))
  302. "#+ATTR_ASCII: line1\n#+ATTR_ASCII: line2\nParagraph\n"))
  303. ;; Interpret parsed keywords.
  304. (should
  305. (equal
  306. (org-element-interpret-data
  307. '(org-data nil (paragraph (:caption ("caption")) "Paragraph")))
  308. "#+CAPTION: caption\nParagraph\n"))
  309. ;; Interpret dual keywords.
  310. (should
  311. (equal
  312. (org-element-interpret-data
  313. '(org-data nil (paragraph (:caption (("long") "short")) "Paragraph")))
  314. "#+CAPTION[short]: long\nParagraph\n")))
  315. (ert-deftest test-org-element/center-block-interpreter ()
  316. "Test center block interpreter."
  317. (should
  318. (equal (org-test-parse-and-interpret "#+BEGIN_CENTER\nTest\n#+END_CENTER")
  319. "#+BEGIN_CENTER\nTest\n#+END_CENTER\n")))
  320. (ert-deftest test-org-element/drawer-interpreter ()
  321. "Test drawer interpreter."
  322. (should
  323. (equal (let ((org-drawers '("TEST")))
  324. (org-test-parse-and-interpret ":TEST:\nTest\n:END:"))
  325. ":TEST:\nTest\n:END:\n")))
  326. (ert-deftest test-org-element/dynamic-block-interpreter ()
  327. "Test dynamic block interpreter."
  328. (should
  329. (equal (org-test-parse-and-interpret
  330. "#+BEGIN: myblock :parameter value1\nTest\n#+END:")
  331. "#+BEGIN: myblock :parameter value1\nTest\n#+END:\n")))
  332. (ert-deftest test-org-element/footnote-definition-interpreter ()
  333. "Test footnote definition interpreter."
  334. (should (equal (org-test-parse-and-interpret "[fn:1] Test") "[fn:1] Test\n")))
  335. (ert-deftest test-org-element/headline-interpreter ()
  336. "Test headline and section interpreters."
  337. ;; 1. Standard test.
  338. (should (equal (org-test-parse-and-interpret "* Headline") "* Headline\n"))
  339. ;; 2. With TODO keywords.
  340. (should
  341. (equal (let ((org-todo-keywords '((sequence "TODO" "DONE"))))
  342. (org-test-parse-and-interpret "* TODO Headline"))
  343. "* TODO Headline\n"))
  344. ;; 3. With tags...
  345. ;;
  346. ;; 3.1. ... and a positive `org-tags-column' value.
  347. (should
  348. (equal (let ((org-tags-column 20))
  349. (org-test-parse-and-interpret "* Headline :tag:"))
  350. "* Headline :tag:\n"))
  351. ;; 3.2. ... and a negative `org-tags-column' value.
  352. (should
  353. (equal (let ((org-tags-column -20))
  354. (org-test-parse-and-interpret "* Headline :tag:"))
  355. "* Headline :tag:\n"))
  356. ;; 3.3. ... and a null `org-tags-column' value.
  357. (should
  358. (equal (let ((org-tags-column 0))
  359. (org-test-parse-and-interpret "* Headline :tag:"))
  360. "* Headline :tag:\n"))
  361. ;; 4. With priority cookie.
  362. (should
  363. (equal (org-test-parse-and-interpret "* [#B] Headline")
  364. "* [#B] Headline\n"))
  365. ;; 5. With comment keyword.
  366. (should
  367. (equal (let ((org-comment-string "COMMENT"))
  368. (org-test-parse-and-interpret "* COMMENT Headline"))
  369. "* COMMENT Headline\n"))
  370. ;; 6. With quote section.
  371. (should
  372. (equal (let ((org-quote-string "QUOTE"))
  373. (org-test-parse-and-interpret "* QUOTE Headline"))
  374. "* QUOTE Headline\n"))
  375. ;; 7. Keep same number of blank lines before body.
  376. (should
  377. (equal (org-test-parse-and-interpret
  378. "* Headline\n\n\nText after two blank lines.")
  379. "* Headline\n\n\nText after two blank lines.\n")))
  380. (ert-deftest test-org-element/inlinetask-interpreter ()
  381. "Test inlinetask interpretation."
  382. (when (featurep 'org-inlinetask)
  383. (let ((org-inlinetask-min-level 15))
  384. ;; 1. Regular inlinetask.
  385. (should (equal (org-test-parse-and-interpret
  386. "*************** Task\nTest\n*************** END")
  387. "*************** Task\nTest\n*************** END\n"))
  388. ;; 2. Degenerate inlinetask.
  389. (should (equal (org-test-parse-and-interpret "*************** Task")
  390. "*************** Task\n"))
  391. ;; 3. Prefer degenerate form when there are no contents.
  392. (should (equal (org-test-parse-and-interpret
  393. "*************** Task\n*************** END")
  394. "*************** Task\n"))
  395. ;; 4. With TODO keywords.
  396. (should
  397. (equal (let ((org-todo-keywords '((sequence "TODO" "DONE"))))
  398. (org-test-parse-and-interpret "*************** TODO Task"))
  399. "*************** TODO Task\n"))
  400. ;; 5. With tags...
  401. ;;
  402. ;; 5.1. ... and a positive `org-tags-column' value.
  403. (should
  404. (equal (let ((org-tags-column 30))
  405. (org-test-parse-and-interpret "*************** Task :tag:"))
  406. "*************** Task :tag:\n"))
  407. ;; 5.2. ... and a negative `org-tags-column' value.
  408. (should
  409. (equal (let ((org-tags-column -30))
  410. (org-test-parse-and-interpret "*************** Task :tag:"))
  411. "*************** Task :tag:\n"))
  412. ;; 5.3. ... and a null `org-tags-column' value.
  413. (should
  414. (equal (let ((org-tags-column 0))
  415. (org-test-parse-and-interpret "*************** Task :tag:"))
  416. "*************** Task :tag:\n"))
  417. ;; 6. With priority cookie.
  418. (should
  419. (equal (org-test-parse-and-interpret "*************** [#B] Task")
  420. "*************** [#B] Task\n")))))
  421. (ert-deftest test-org-element/plain-list-interpreter ()
  422. "Test plain-list and item interpreters."
  423. ;; 1. Unordered list.
  424. (should (equal (org-test-parse-and-interpret "- item 1") "- item 1\n"))
  425. ;; 2. Description list.
  426. (should
  427. (equal (org-test-parse-and-interpret "- tag :: desc") "- tag :: desc\n"))
  428. ;; 3. Ordered list.
  429. (should
  430. (equal (let ((org-plain-list-ordered-item-terminator t))
  431. (org-test-parse-and-interpret "1. Item"))
  432. "1. Item\n"))
  433. ;; 4. Ordered list with counter.
  434. (should
  435. (equal (let ((org-plain-list-ordered-item-terminator t))
  436. (org-test-parse-and-interpret "1. [@5] Item"))
  437. "5. [@5] Item\n"))
  438. ;; 5. List with check-boxes.
  439. (should
  440. (equal (org-test-parse-and-interpret
  441. "- [-] Item 1\n - [X] Item 2\n - [ ] Item 3")
  442. "- [-] Item 1\n - [X] Item 2\n - [ ] Item 3\n")))
  443. (ert-deftest test-org-element/quote-block-interpreter ()
  444. "Test quote block interpreter."
  445. (should (equal (org-test-parse-and-interpret
  446. "#+BEGIN_QUOTE\nTest\n#+END_QUOTE")
  447. "#+BEGIN_QUOTE\nTest\n#+END_QUOTE\n")))
  448. (ert-deftest test-org-element/special-block-interpreter ()
  449. "Test special block interpreter."
  450. (should (equal (org-test-parse-and-interpret
  451. "#+BEGIN_SPECIAL\nTest\n#+END_SPECIAL")
  452. "#+BEGIN_SPECIAL\nTest\n#+END_SPECIAL\n")))
  453. (ert-deftest test-org-element/babel-call-interpreter ()
  454. "Test babel call interpreter."
  455. ;; 1. Without argument.
  456. (should (equal (org-test-parse-and-interpret "#+CALL: test()")
  457. "#+CALL: test()\n"))
  458. ;; 2. With argument.
  459. (should (equal (org-test-parse-and-interpret "#+CALL: test(x=2)")
  460. "#+CALL: test(x=2)\n"))
  461. ;; 3. With header arguments.
  462. (should (equal (org-test-parse-and-interpret
  463. "#+CALL: test[:results output]()[:results html]")
  464. "#+CALL: test[:results output]()[:results html]\n")))
  465. (ert-deftest test-org-element/clock-interpreter ()
  466. "Test clock interpreter."
  467. ;; Running clock.
  468. (should
  469. (equal (let ((org-clock-string "CLOCK:"))
  470. (org-test-parse-and-interpret "CLOCK: [2012-01-01 sun. 00:01]"))
  471. "CLOCK: [2012-01-01 sun. 00:01]\n"))
  472. ;; Closed clock.
  473. (should
  474. (equal
  475. (let ((org-clock-string "CLOCK:"))
  476. (org-test-parse-and-interpret "
  477. CLOCK: [2012-01-01 sun. 00:01]--[2012-01-01 sun. 00:02] => 0:01"))
  478. "CLOCK: [2012-01-01 sun. 00:01]--[2012-01-01 sun. 00:02] => 0:01\n")))
  479. (ert-deftest test-org-element/comment-interpreter ()
  480. "Test comment interpreter."
  481. ;; Regular comment.
  482. (should (equal (org-test-parse-and-interpret "#Comment") "#Comment\n"))
  483. ;; Inline comment.
  484. (should (equal (org-test-parse-and-interpret " #+ Comment")
  485. " #+ Comment\n")))
  486. (ert-deftest test-org-element/comment-block-interpreter ()
  487. "Test comment block interpreter."
  488. (should (equal (org-test-parse-and-interpret
  489. "#+BEGIN_COMMENT\nTest\n#+END_COMMENT")
  490. "#+BEGIN_COMMENT\nTest\n#+END_COMMENT\n")))
  491. (ert-deftest test-org-element/example-block-interpreter ()
  492. "Test example block interpreter."
  493. (should (equal (org-test-parse-and-interpret
  494. "#+BEGIN_EXAMPLE\nTest\n#+END_EXAMPLE")
  495. "#+BEGIN_EXAMPLE\nTest\n#+END_EXAMPLE\n")))
  496. (ert-deftest test-org-element/export-block-interpreter ()
  497. "Test export block interpreter."
  498. (should (equal (org-test-parse-and-interpret
  499. "#+BEGIN_HTML\nTest\n#+END_HTML")
  500. "#+BEGIN_HTML\nTest\n#+END_HTML\n")))
  501. (ert-deftest test-org-element/fixed-width-interpreter ()
  502. "Test fixed width interpreter."
  503. (should (equal (org-test-parse-and-interpret ": Test") ": Test\n")))
  504. (ert-deftest test-org-element/horizontal-rule-interpreter ()
  505. "Test horizontal rule interpreter."
  506. (should (equal (org-test-parse-and-interpret "-------") "-----\n")))
  507. (ert-deftest test-org-element/keyword-interpreter ()
  508. "Test keyword interpreter."
  509. (should (equal (org-test-parse-and-interpret "#+KEYWORD: value")
  510. "#+KEYWORD: value\n")))
  511. (ert-deftest test-org-element/latex-environment-interpreter ()
  512. "Test latex environment interpreter."
  513. (should (equal (org-test-parse-and-interpret
  514. "\\begin{equation}\n1+1=2\n\\end{equation}")
  515. "\\begin{equation}\n1+1=2\n\\end{equation}\n")))
  516. (ert-deftest test-org-element/planning-interpreter ()
  517. "Test planning interpreter."
  518. (let ((org-closed-string "CLOSED:")
  519. (org-deadline-string "DEADLINE:")
  520. (org-scheduled-string "SCHEDULED:"))
  521. (should
  522. (equal
  523. (org-test-parse-and-interpret
  524. "* Headline
  525. CLOSED: <2012-01-01> DEADLINE: <2012-01-01> SCHEDULED: <2012-01-01>")
  526. "* Headline
  527. CLOSED: <2012-01-01> DEADLINE: <2012-01-01> SCHEDULED: <2012-01-01>\n"))))
  528. (ert-deftest test-org-element/property-drawer-interpreter ()
  529. "Test property drawer interpreter."
  530. (should (equal (let ((org-property-format "%-10s %s"))
  531. (org-test-parse-and-interpret
  532. ":PROPERTIES:\n:prop: value\n:END:"))
  533. ":PROPERTIES:\n:prop: value\n:END:\n")))
  534. (ert-deftest test-org-element/src-block-interpreter ()
  535. "Test src block interpreter."
  536. (should
  537. (equal (org-test-parse-and-interpret
  538. "#+BEGIN_SRC emacs-lisp :results silent\n(+ 1 1)\n#+END_SRC")
  539. "#+BEGIN_SRC emacs-lisp :results silent\n(+ 1 1)\n#+END_SRC\n")))
  540. (ert-deftest test-org-element/table-interpreter ()
  541. "Test table, table-row and table-cell interpreters."
  542. ;; 1. Simple table.
  543. (should (equal (org-test-parse-and-interpret "| a | b |\n| c | d |")
  544. "| a | b |\n| c | d |\n"))
  545. ;; 2. Table with horizontal rules.
  546. (should (equal (org-test-parse-and-interpret
  547. "| a | b |\n|---+---|\n| c | d |")
  548. "| a | b |\n|---+---|\n| c | d |\n"))
  549. ;; 3. Table with meta-data.
  550. (should (equal (org-test-parse-and-interpret "| / | < | > |\n| * | 1 | 2 |")
  551. "| / | < | > |\n| * | 1 | 2 |\n")))
  552. (ert-deftest test-org-element/verse-block-interpreter ()
  553. "Test verse block interpretation."
  554. (should
  555. (equal (org-test-parse-and-interpret "#+BEGIN_VERSE\nTest\n#+END_VERSE")
  556. "#+BEGIN_VERSE\nTest\n#+END_VERSE\n")))
  557. (ert-deftest test-org-element/bold-interpreter ()
  558. "Test bold interpreter."
  559. (should (equal (org-test-parse-and-interpret "*text*") "*text*\n")))
  560. (ert-deftest test-org-element/code-interpreter ()
  561. "Test code interpreter."
  562. (should (equal (org-test-parse-and-interpret "~text~") "~text~\n")))
  563. (ert-deftest test-org-element/entity-interpreter ()
  564. "Test entity interpreter."
  565. ;; 1. Without brackets.
  566. (should
  567. (equal (org-test-parse-and-interpret "\\alpha text") "\\alpha text\n"))
  568. ;; 2. With brackets.
  569. (should
  570. (equal (org-test-parse-and-interpret "\\alpha{}text") "\\alpha{}text\n")))
  571. (ert-deftest test-org-element/export-snippet-interpreter ()
  572. "Test export snippet interpreter."
  573. (should (equal (org-test-parse-and-interpret "<back-end@contents>")
  574. "<back-end@contents>\n")))
  575. (ert-deftest test-org-element/footnote-reference-interpreter ()
  576. "Test footnote reference interpreter."
  577. ;; 1. Regular reference.
  578. (should (equal (org-test-parse-and-interpret "Text[fn:1]") "Text[fn:1]\n"))
  579. ;; 2. Normalized reference.
  580. (should (equal (org-test-parse-and-interpret "Text[1]") "Text[1]\n"))
  581. ;; 3. Named reference.
  582. (should (equal (org-test-parse-and-interpret "Text[fn:label]")
  583. "Text[fn:label]\n"))
  584. ;; 4. Inline reference.
  585. (should (equal (org-test-parse-and-interpret "Text[fn:label:def]")
  586. "Text[fn:label:def]\n"))
  587. ;; 5. Anonymous reference.
  588. (should (equal (org-test-parse-and-interpret "Text[fn::def]")
  589. "Text[fn::def]\n")))
  590. (ert-deftest test-org-element/inline-babel-call-interpreter ()
  591. "Test inline babel call interpreter."
  592. ;; 1. Without arguments.
  593. (should (equal (org-test-parse-and-interpret "call_test()") "call_test()\n"))
  594. ;; 2. With arguments.
  595. (should (equal (org-test-parse-and-interpret "call_test(x=2)")
  596. "call_test(x=2)\n"))
  597. ;; 3. With header arguments.
  598. (should (equal (org-test-parse-and-interpret
  599. "call_test[:results output]()[:results html]")
  600. "call_test[:results output]()[:results html]\n")))
  601. (ert-deftest test-org-element/inline-src-block-interpreter ()
  602. "Test inline src block interpreter."
  603. ;; 1. Without header argument.
  604. (should (equal (org-test-parse-and-interpret "src_emacs-lisp{(+ 1 1)}")
  605. "src_emacs-lisp{(+ 1 1)}\n"))
  606. ;; 2. With header arguments.
  607. (should (equal (org-test-parse-and-interpret
  608. "src_emacs-lisp[:results silent]{(+ 1 1)}")
  609. "src_emacs-lisp[:results silent]{(+ 1 1)}\n")))
  610. (ert-deftest test-org-element/italic-interpreter ()
  611. "Test italic interpreter."
  612. (should (equal (org-test-parse-and-interpret "/text/") "/text/\n")))
  613. (ert-deftest test-org-element/latex-fragment-interpreter ()
  614. "Test latex fragment interpreter."
  615. (let ((org-latex-regexps
  616. '(("begin" "^[ ]*\\(\\\\begin{\\([a-zA-Z0-9\\*]+\\)[^�]+?\\\\end{\\2}\\)" 1 t)
  617. ("$1" "\\([^$]\\|^\\)\\(\\$[^ \n,;.$]\\$\\)\\([- .,?;:'\")�]\\|$\\)" 2 nil)
  618. ("$" "\\([^$]\\|^\\)\\(\\(\\$\\([^ \n,;.$][^$\n ]*?\\(\n[^$\n ]*?\\)\\{0,2\\}[^ \n,.$]\\)\\$\\)\\)\\([- .,?;:'\")�]\\|$\\)" 2 nil)
  619. ("\\(" "\\\\([^�]*?\\\\)" 0 nil)
  620. ("\\[" "\\\\\\[[^�]*?\\\\\\]" 0 nil)
  621. ("$$" "\\$\\$[^�]*?\\$\\$" 0 nil))))
  622. (should (equal (org-test-parse-and-interpret "\\command{}")
  623. "\\command{}\n"))
  624. (should (equal (org-test-parse-and-interpret "$x$") "$x$\n"))
  625. (should (equal (org-test-parse-and-interpret "$x+y$") "$x+y$\n"))
  626. (should (equal (org-test-parse-and-interpret "$$x+y$$") "$$x+y$$\n"))
  627. (should (equal (org-test-parse-and-interpret "\\(x+y\\)") "\\(x+y\\)\n"))
  628. (should (equal (org-test-parse-and-interpret "\\[x+y\\]") "\\[x+y\\]\n"))))
  629. (ert-deftest test-org-element/line-break-interpreter ()
  630. "Test line break interpreter."
  631. (should (equal (org-test-parse-and-interpret "First line \\\\ \nSecond line")
  632. "First line \\\\\nSecond line\n")))
  633. (ert-deftest test-org-element/link-interpreter ()
  634. "Test link interpreter."
  635. ;; 1. Links targeted from a radio target.
  636. (should (equal (let ((org-target-link-regexp "radio-target"))
  637. (org-test-parse-and-interpret "a radio-target"))
  638. "a radio-target\n"))
  639. ;; 2. Regular links.
  640. ;;
  641. ;; 2.1. Without description.
  642. (should (equal (org-test-parse-and-interpret "[[http://orgmode.org]]")
  643. "[[http://orgmode.org]]\n"))
  644. ;; 2.2. With a description.
  645. (should (equal (org-test-parse-and-interpret
  646. "[[http://orgmode.org][Org mode]]")
  647. "[[http://orgmode.org][Org mode]]\n"))
  648. ;; 2.3. Id links.
  649. (should (equal (org-test-parse-and-interpret "[[id:aaaa]]") "[[id:aaaa]]\n"))
  650. ;; 2.4. Custom-id links.
  651. (should (equal (org-test-parse-and-interpret "[[#id]]") "[[#id]]\n"))
  652. ;; 2.5 Code-ref links.
  653. (should (equal (org-test-parse-and-interpret "[[(ref)]]") "[[(ref)]]\n"))
  654. ;; 3. Normalize plain links.
  655. (should (equal (org-test-parse-and-interpret "http://orgmode.org")
  656. "[[http://orgmode.org]]\n"))
  657. ;; 4. Normalize angular links.
  658. (should (equal (org-test-parse-and-interpret "<http://orgmode.org>")
  659. "[[http://orgmode.org]]\n")))
  660. (ert-deftest test-org-element/macro-interpreter ()
  661. "Test macro interpreter."
  662. ;; 1. Without argument.
  663. (should (equal (org-test-parse-and-interpret "{{{test}}}") "{{{test}}}\n"))
  664. ;; 2. With arguments.
  665. (should (equal (org-test-parse-and-interpret "{{{test(arg1,arg2)}}}")
  666. "{{{test(arg1,arg2)}}}\n")))
  667. (ert-deftest test-org-element/radio-target-interpreter ()
  668. "Test radio target interpreter."
  669. (should (equal (org-test-parse-and-interpret "<<<some text>>>")
  670. "<<<some text>>>\n")))
  671. (ert-deftest test-org-element/statistics-cookie-interpreter ()
  672. "Test statistics cookie interpreter."
  673. ;; 1. Without percent
  674. (should (equal (org-test-parse-and-interpret "[0/1]") "[0/1]\n"))
  675. ;; 2. With percent.
  676. (should (equal (org-test-parse-and-interpret "[66%]") "[66%]\n")))
  677. (ert-deftest test-org-element/strike-through-interpreter ()
  678. "Test strike through interpreter."
  679. (should (equal (org-test-parse-and-interpret "+target+") "+target+\n")))
  680. (ert-deftest test-org-element/subscript-interpreter ()
  681. "Test subscript interpreter."
  682. ;; 1. Without brackets.
  683. (should (equal (org-test-parse-and-interpret "a_b") "a_b\n"))
  684. ;; 2. With brackets.
  685. (should (equal (org-test-parse-and-interpret "a_{b}") "a_{b}\n")))
  686. (ert-deftest test-org-element/superscript-interpreter ()
  687. "Test superscript interpreter."
  688. ;; 1. Without brackets.
  689. (should (equal (org-test-parse-and-interpret "a^b") "a^b\n"))
  690. ;; 2. With brackets.
  691. (should (equal (org-test-parse-and-interpret "a^{b}") "a^{b}\n")))
  692. (ert-deftest test-org-element/target-interpreter ()
  693. "Test target interpreter."
  694. (should (equal (org-test-parse-and-interpret "<<target>>") "<<target>>\n")))
  695. (ert-deftest test-org-element/underline-interpreter ()
  696. "Test underline interpreter."
  697. (should (equal (org-test-parse-and-interpret "_text_") "_text_\n")))
  698. (ert-deftest test-org-element/verbatim-interpreter ()
  699. "Test verbatim interpreter."
  700. (should (equal (org-test-parse-and-interpret "=text=") "=text=\n")))
  701. ;;; Test Granularity
  702. (ert-deftest test-org-element/granularity ()
  703. "Test granularity impact on buffer parsing."
  704. (org-test-with-temp-text "
  705. * Head 1
  706. ** Head 2
  707. #+BEGIN_CENTER
  708. Centered paragraph.
  709. #+END_CENTER
  710. Paragraph \\alpha."
  711. ;; 1.1. Granularity set to `headline' should parse every headline
  712. ;; in buffer, and only them.
  713. (let ((tree (org-element-parse-buffer 'headline)))
  714. (should (= 2 (length (org-element-map tree 'headline 'identity))))
  715. (should-not (org-element-map tree 'paragraph 'identity)))
  716. ;; 1.2. Granularity set to `greater-element' should not enter
  717. ;; greater elements excepted headlines and sections.
  718. (let ((tree (org-element-parse-buffer 'greater-element)))
  719. (should (= 1 (length (org-element-map tree 'center-block 'identity))))
  720. (should (= 1 (length (org-element-map tree 'paragraph 'identity))))
  721. (should-not (org-element-map tree 'entity 'identity)))
  722. ;; 1.3. Granularity set to `element' should enter every
  723. ;; greater-element.
  724. (let ((tree (org-element-parse-buffer 'element)))
  725. (should (= 2 (length (org-element-map tree 'paragraph 'identity))))
  726. (should-not (org-element-map tree 'entity 'identity)))
  727. ;; 1.4. Granularity set to `object' can see everything.
  728. (let ((tree (org-element-parse-buffer 'object)))
  729. (should (= 1 (length (org-element-map tree 'entity 'identity)))))))
  730. (ert-deftest test-org-element/secondary-string-parsing ()
  731. "Test if granularity correctly toggles secondary strings parsing."
  732. ;; 1. With a granularity bigger than `object', no secondary string
  733. ;; should be parsed.
  734. ;;
  735. ;; 1.1. Test with `headline' type.
  736. (org-test-with-temp-text "* Headline"
  737. (let ((headline
  738. (org-element-map (org-element-parse-buffer 'headline) 'headline
  739. 'identity
  740. nil
  741. 'first-match)))
  742. (should (stringp (org-element-property :title headline)))))
  743. ;; 1.2. Test with `item' type.
  744. (org-test-with-temp-text "* Headline\n- tag :: item"
  745. (let ((item (org-element-map (org-element-parse-buffer 'element)
  746. 'item
  747. 'identity
  748. nil
  749. 'first-match)))
  750. (should (stringp (org-element-property :tag item)))))
  751. ;; 1.3. Test with `inlinetask' type, if avalaible.
  752. (when (featurep 'org-inlinetask)
  753. (let ((org-inlinetask-min-level 15))
  754. (org-test-with-temp-text "*************** Inlinetask"
  755. (let ((inlinetask (org-element-map (org-element-parse-buffer 'element)
  756. 'inlinetask
  757. 'identity
  758. nil
  759. 'first-match)))
  760. (should (stringp (org-element-property :title inlinetask)))))))
  761. ;; 2. With a default granularity, secondary strings should be
  762. ;; parsed.
  763. (org-test-with-temp-text "* Headline"
  764. (let ((headline
  765. (org-element-map (org-element-parse-buffer) 'headline
  766. 'identity
  767. nil
  768. 'first-match)))
  769. (should (listp (org-element-property :title headline)))))
  770. ;; 3. `org-element-at-point' should never parse a secondary string.
  771. (org-test-with-temp-text "* Headline"
  772. (should (stringp (org-element-property :title (org-element-at-point))))))
  773. ;;; Test Normalize Contents
  774. (ert-deftest test-org-element/normalize-contents ()
  775. "Test `org-element-normalize-contents' specifications."
  776. ;; 1. Remove maximum common indentation from element's contents.
  777. (should
  778. (equal
  779. (org-element-normalize-contents
  780. '(paragraph nil " Two spaces\n Three spaces"))
  781. '(paragraph nil "Two spaces\n Three spaces")))
  782. ;; 2. Ignore objects within contents when computing maximum common
  783. ;; indentation.
  784. (should
  785. (equal
  786. (org-element-normalize-contents
  787. '(paragraph nil " One " (emphasis nil "space") "\n Two spaces"))
  788. '(paragraph nil "One " (emphasis nil "space") "\n Two spaces")))
  789. ;; 3. Ignore blank lines.
  790. (should
  791. (equal
  792. (org-element-normalize-contents
  793. '(paragraph nil " Two spaces\n\n \n Two spaces"))
  794. '(paragraph nil "Two spaces\n\n \nTwo spaces")))
  795. ;; 4. Recursively enter objects in order to compute common
  796. ;; indentation.
  797. (should
  798. (equal
  799. (org-element-normalize-contents
  800. '(paragraph nil " Two spaces " (bold nil " and\n One space")))
  801. '(paragraph nil " Two spaces " (bold nil " and\nOne space"))))
  802. ;; 5. When optional argument is provided, ignore first line
  803. ;; indentation.
  804. (should
  805. (equal
  806. (org-element-normalize-contents
  807. '(paragraph nil "No space\n Two spaces\n Three spaces") t)
  808. '(paragraph nil "No space\nTwo spaces\n Three spaces"))))
  809. ;;; Test Navigation Tools.
  810. (ert-deftest test-org-element/forward-element ()
  811. "Test `org-element-forward' specifications."
  812. ;; 1. At EOB: should error.
  813. (org-test-with-temp-text "Some text\n"
  814. (goto-char (point-max))
  815. (should-error (org-element-forward)))
  816. ;; 2. Standard move: expected to ignore blank lines.
  817. (org-test-with-temp-text "First paragraph.\n\n\nSecond paragraph."
  818. (org-element-forward)
  819. (should (looking-at "Second paragraph.")))
  820. ;; 3. Headline tests.
  821. (org-test-with-temp-text "
  822. * Head 1
  823. ** Head 1.1
  824. *** Head 1.1.1
  825. ** Head 1.2"
  826. ;; 3.1. At an headline beginning: move to next headline at the
  827. ;; same level.
  828. (goto-line 3)
  829. (org-element-forward)
  830. (should (looking-at "** Head 1.2"))
  831. ;; 3.2. At an headline beginning: move to parent headline if no
  832. ;; headline at the same level.
  833. (goto-line 3)
  834. (org-element-forward)
  835. (should (looking-at "** Head 1.2")))
  836. ;; 4. Greater element tests.
  837. (org-test-with-temp-text
  838. "#+BEGIN_CENTER\nInside.\n#+END_CENTER\n\nOutside."
  839. ;; 4.1. At a greater element: expected to skip contents.
  840. (org-element-forward)
  841. (should (looking-at "Outside."))
  842. ;; 4.2. At the end of greater element contents: expected to skip
  843. ;; to the end of the greater element.
  844. (goto-line 2)
  845. (org-element-forward)
  846. (should (looking-at "Outside.")))
  847. ;; 5. List tests.
  848. (org-test-with-temp-text "
  849. - item1
  850. - sub1
  851. - sub2
  852. - sub3
  853. Inner paragraph.
  854. - item2
  855. Outside."
  856. ;; 5.1. At list top point: expected to move to the element after
  857. ;; the list.
  858. (goto-line 2)
  859. (org-element-forward)
  860. (should (looking-at "Outside."))
  861. ;; 5.2. Special case: at the first line of a sub-list, but not at
  862. ;; beginning of line, move to next item.
  863. (goto-line 2)
  864. (forward-char)
  865. (org-element-forward)
  866. (should (looking-at "- item2"))
  867. (goto-line 4)
  868. (forward-char)
  869. (org-element-forward)
  870. (should (looking-at " - sub2"))
  871. ;; 5.3 At sub-list beginning: expected to move after the sub-list.
  872. (goto-line 4)
  873. (org-element-forward)
  874. (should (looking-at " Inner paragraph."))
  875. ;; 5.4. At sub-list end: expected to move outside the sub-list.
  876. (goto-line 8)
  877. (org-element-forward)
  878. (should (looking-at " Inner paragraph."))
  879. ;; 5.5. At an item: expected to move to next item, if any.
  880. (goto-line 6)
  881. (org-element-forward)
  882. (should (looking-at " - sub3"))))
  883. (ert-deftest test-org-element/backward-element ()
  884. "Test `org-element-backward' specifications."
  885. ;; 1. At BOB (modulo some white spaces): should error.
  886. (org-test-with-temp-text " \nParagraph."
  887. (org-skip-whitespace)
  888. (should-error (org-element-backward)))
  889. ;; 2. Not at the beginning of an element: move at its beginning.
  890. (org-test-with-temp-text "Paragraph1.\n\nParagraph2."
  891. (goto-line 3)
  892. (end-of-line)
  893. (org-element-backward)
  894. (should (looking-at "Paragraph2.")))
  895. ;; 3. Headline tests.
  896. (org-test-with-temp-text "
  897. * Head 1
  898. ** Head 1.1
  899. *** Head 1.1.1
  900. ** Head 1.2"
  901. ;; 3.1. At an headline beginning: move to previous headline at the
  902. ;; same level.
  903. (goto-line 5)
  904. (org-element-backward)
  905. (should (looking-at "** Head 1.1"))
  906. ;; 3.2. At an headline beginning: move to parent headline if no
  907. ;; headline at the same level.
  908. (goto-line 3)
  909. (org-element-backward)
  910. (should (looking-at "* Head 1"))
  911. ;; 3.3. At the first top-level headline: should error.
  912. (goto-line 2)
  913. (should-error (org-element-backward)))
  914. ;; 4. At beginning of first element inside a greater element:
  915. ;; expected to move to greater element's beginning.
  916. (org-test-with-temp-text "Before.\n#+BEGIN_CENTER\nInside.\n#+END_CENTER."
  917. (goto-line 3)
  918. (org-element-backward)
  919. (should (looking-at "#\\+BEGIN_CENTER")))
  920. ;; 5. List tests.
  921. (org-test-with-temp-text "
  922. - item1
  923. - sub1
  924. - sub2
  925. - sub3
  926. Inner paragraph.
  927. - item2
  928. Outside."
  929. ;; 5.1. At beginning of sub-list: expected to move to the
  930. ;; paragraph before it.
  931. (goto-line 4)
  932. (org-element-backward)
  933. (should (looking-at "item1"))
  934. ;; 5.2. At an item in a list: expected to move at previous item.
  935. (goto-line 8)
  936. (org-element-backward)
  937. (should (looking-at " - sub2"))
  938. (goto-line 12)
  939. (org-element-backward)
  940. (should (looking-at "- item1"))
  941. ;; 5.3. At end of list/sub-list: expected to move to list/sub-list
  942. ;; beginning.
  943. (goto-line 10)
  944. (org-element-backward)
  945. (should (looking-at " - sub1"))
  946. (goto-line 15)
  947. (org-element-backward)
  948. (should (looking-at "- item1"))
  949. ;; 5.4. At blank-lines before list end: expected to move to top
  950. ;; item.
  951. (goto-line 14)
  952. (org-element-backward)
  953. (should (looking-at "- item1"))))
  954. (ert-deftest test-org-element/up-element ()
  955. "Test `org-element-up' specifications."
  956. ;; 1. At BOB or with no surrounding element: should error.
  957. (org-test-with-temp-text "Paragraph."
  958. (should-error (org-element-up)))
  959. (org-test-with-temp-text "* Head1\n* Head2"
  960. (goto-line 2)
  961. (should-error (org-element-up)))
  962. (org-test-with-temp-text "Paragraph1.\n\nParagraph2."
  963. (goto-line 3)
  964. (should-error (org-element-up)))
  965. ;; 2. At an headline: move to parent headline.
  966. (org-test-with-temp-text "* Head1\n** Sub-Head1\n** Sub-Head2"
  967. (goto-line 3)
  968. (org-element-up)
  969. (should (looking-at "\\* Head1")))
  970. ;; 3. Inside a greater element: move to greater element beginning.
  971. (org-test-with-temp-text
  972. "Before.\n#+BEGIN_CENTER\nParagraph1\nParagraph2\n#+END_CENTER\n"
  973. (goto-line 3)
  974. (org-element-up)
  975. (should (looking-at "#\\+BEGIN_CENTER")))
  976. ;; 4. List tests.
  977. (org-test-with-temp-text "* Top
  978. - item1
  979. - sub1
  980. - sub2
  981. Paragraph within sub2.
  982. - item2"
  983. ;; 4.1. Within an item: move to the item beginning.
  984. (goto-line 8)
  985. (org-element-up)
  986. (should (looking-at " - sub2"))
  987. ;; 4.2. At an item in a sub-list: move to parent item.
  988. (goto-line 4)
  989. (org-element-up)
  990. (should (looking-at "- item1"))
  991. ;; 4.3. At an item in top list: move to beginning of whole list.
  992. (goto-line 10)
  993. (org-element-up)
  994. (should (looking-at "- item1"))
  995. ;; 4.4. Special case. At very top point: should move to parent of
  996. ;; list.
  997. (goto-line 2)
  998. (org-element-up)
  999. (should (looking-at "\\* Top"))))
  1000. (ert-deftest test-org-element/down-element ()
  1001. "Test `org-element-down' specifications."
  1002. ;; 1. Error when the element hasn't got a recursive type.
  1003. (org-test-with-temp-text "Paragraph."
  1004. (should-error (org-element-down)))
  1005. ;; 2. When at a plain-list, move to first item.
  1006. (org-test-with-temp-text "- Item 1\n - Item 1.1\n - Item 2.2"
  1007. (goto-line 2)
  1008. (org-element-down)
  1009. (should (looking-at " - Item 1.1")))
  1010. (org-test-with-temp-text "#+NAME: list\n- Item 1"
  1011. (org-element-down)
  1012. (should (looking-at " Item 1")))
  1013. ;; 3. When at a table, move to first row
  1014. (org-test-with-temp-text "#+NAME: table\n| a | b |"
  1015. (org-element-down)
  1016. (should (looking-at " a | b |")))
  1017. ;; 4. Otherwise, move inside the greater element.
  1018. (org-test-with-temp-text "#+BEGIN_CENTER\nParagraph.\n#+END_CENTER"
  1019. (org-element-down)
  1020. (should (looking-at "Paragraph"))))
  1021. (ert-deftest test-org-element/drag-backward ()
  1022. "Test `org-element-drag-backward' specifications."
  1023. ;; 1. Error when trying to move first element of buffer.
  1024. (org-test-with-temp-text "Paragraph 1.\n\nParagraph 2."
  1025. (should-error (org-element-drag-backward)))
  1026. ;; 2. Error when trying to swap nested elements.
  1027. (org-test-with-temp-text "#+BEGIN_CENTER\nTest.\n#+END_CENTER"
  1028. (forward-line)
  1029. (should-error (org-element-drag-backward)))
  1030. ;; 3. Error when trying to swap an headline element and
  1031. ;; a non-headline element.
  1032. (org-test-with-temp-text "Test.\n* Head 1"
  1033. (forward-line)
  1034. (should-error (org-element-drag-backward)))
  1035. ;; 4. Otherwise, swap elements, preserving column and blank lines
  1036. ;; between elements.
  1037. (org-test-with-temp-text "Para1\n\n\nParagraph 2\n\nPara3"
  1038. (search-forward "graph")
  1039. (org-element-drag-backward)
  1040. (should (equal (buffer-string) "Paragraph 2\n\n\nPara1\n\nPara3"))
  1041. (should (looking-at " 2"))))
  1042. (ert-deftest test-org-element/drag-forward ()
  1043. "Test `org-element-drag-forward' specifications."
  1044. ;; 1. Error when trying to move first element of buffer.
  1045. (org-test-with-temp-text "Paragraph 1.\n\nParagraph 2."
  1046. (goto-line 3)
  1047. (should-error (org-element-drag-forward)))
  1048. ;; 2. Error when trying to swap nested elements.
  1049. (org-test-with-temp-text "#+BEGIN_CENTER\nTest.\n#+END_CENTER"
  1050. (forward-line)
  1051. (should-error (org-element-drag-forward)))
  1052. ;; 3. Error when trying to swap a non-headline element and an
  1053. ;; headline.
  1054. (org-test-with-temp-text "Test.\n* Head 1"
  1055. (should-error (org-element-drag-forward)))
  1056. ;; 4. Otherwise, swap elements, preserving column and blank lines
  1057. ;; between elements.
  1058. (org-test-with-temp-text "Paragraph 1\n\n\nPara2\n\nPara3"
  1059. (search-forward "graph")
  1060. (org-element-drag-forward)
  1061. (should (equal (buffer-string) "Para2\n\n\nParagraph 1\n\nPara3"))
  1062. (should (looking-at " 1"))))
  1063. (provide 'test-org-element)
  1064. ;;; test-org-element.el ends here