test-org-element.el 44 KB

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