test-org-element.el 87 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503
  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. (unless (featurep 'org-element)
  15. (signal 'missing-test-dependency "org-element"))
  16. (defun org-test-parse-and-interpret (text)
  17. "Parse TEXT as Org syntax and interpret it.
  18. Return interpreted string."
  19. (with-temp-buffer
  20. (org-mode)
  21. (insert text)
  22. (org-element-interpret-data (org-element-parse-buffer))))
  23. ;;; Test `org-element-map'
  24. (ert-deftest test-org-element/map ()
  25. "Test `org-element-map'."
  26. ;; Can map to `plain-text' objects.
  27. (should
  28. (= 2
  29. (org-test-with-temp-text "Some text \alpha
  30. #+BEGIN_CENTER
  31. Some other text
  32. #+END_CENTER"
  33. (let ((count 0))
  34. (org-element-map
  35. (org-element-parse-buffer) 'plain-text
  36. (lambda (s) (when (string-match "text" s) (incf count))))
  37. count))))
  38. ;; Applies to secondary strings
  39. (should
  40. (org-element-map '("some " (bold nil "bold") "text") 'bold 'identity))
  41. ;; Enter secondary strings before entering contents.
  42. (should
  43. (equal
  44. "alpha"
  45. (org-element-property
  46. :name
  47. (org-test-with-temp-text "* Some \\alpha headline\n\\beta entity."
  48. (org-element-map (org-element-parse-buffer) 'entity 'identity nil t)))))
  49. ;; Apply NO-RECURSION argument.
  50. (should-not
  51. (org-test-with-temp-text "#+BEGIN_CENTER\n\\alpha\n#+END_CENTER"
  52. (org-element-map
  53. (org-element-parse-buffer) 'entity 'identity nil nil 'center-block)))
  54. ;; Use WITH-AFFILIATED argument.
  55. (should
  56. (equal
  57. '("a" "1" "b" "2")
  58. (org-test-with-temp-text "#+CAPTION[a]: 1\n#+CAPTION[b]: 2\nParagraph"
  59. (org-element-map
  60. (org-element-at-point) 'plain-text 'identity nil nil nil t)))))
  61. ;;; Test Setters
  62. (ert-deftest test-org-element/put-property ()
  63. "Test `org-element-put-property' specifications."
  64. (org-test-with-temp-text "* Headline\n *a*"
  65. (let ((tree (org-element-parse-buffer)))
  66. (org-element-put-property
  67. (org-element-map tree 'bold 'identity nil t) :test 1)
  68. (should (org-element-property
  69. :test (org-element-map tree 'bold 'identity nil t))))))
  70. (ert-deftest test-org-element/set-contents ()
  71. "Test `org-element-set-contents' specifications."
  72. ;; Accept multiple entries.
  73. (should
  74. (equal '("b" (italic nil "a"))
  75. (org-test-with-temp-text "* Headline\n *a*"
  76. (let ((tree (org-element-parse-buffer)))
  77. (org-element-set-contents
  78. (org-element-map tree 'bold 'identity nil t) "b" '(italic nil "a"))
  79. (org-element-contents
  80. (org-element-map tree 'bold 'identity nil t))))))
  81. ;; Accept atoms and elements.
  82. (should
  83. (equal '("b")
  84. (org-test-with-temp-text "* Headline\n *a*"
  85. (let ((tree (org-element-parse-buffer)))
  86. (org-element-set-contents
  87. (org-element-map tree 'bold 'identity nil t) "b")
  88. (org-element-contents
  89. (org-element-map tree 'bold 'identity nil t))))))
  90. (should
  91. (equal '((italic nil "b"))
  92. (org-test-with-temp-text "* Headline\n *a*"
  93. (let ((tree (org-element-parse-buffer)))
  94. (org-element-set-contents
  95. (org-element-map tree 'bold 'identity nil t) '(italic nil "b"))
  96. (org-element-contents
  97. (org-element-map tree 'bold 'identity nil t))))))
  98. ;; Allow nil contents.
  99. (should-not
  100. (org-test-with-temp-text "* Headline\n *a*"
  101. (let ((tree (org-element-parse-buffer)))
  102. (org-element-set-contents (org-element-map tree 'bold 'identity nil t))
  103. (org-element-contents (org-element-map tree 'bold 'identity nil t))))))
  104. (ert-deftest test-org-element/set-element ()
  105. "Test `org-element-set-element' specifications."
  106. (org-test-with-temp-text "* Headline\n*a*"
  107. (let ((tree (org-element-parse-buffer)))
  108. (org-element-set-element
  109. (org-element-map tree 'bold 'identity nil t)
  110. '(italic nil "b"))
  111. ;; Check if object is correctly replaced.
  112. (should (org-element-map tree 'italic 'identity))
  113. (should-not (org-element-map tree 'bold 'identity))
  114. ;; Check if new object's parent is correctly set.
  115. (should
  116. (eq
  117. (org-element-property :parent
  118. (org-element-map tree 'italic 'identity nil t))
  119. (org-element-map tree 'paragraph 'identity nil t))))))
  120. (ert-deftest test-org-element/adopt-elements ()
  121. "Test `org-element-adopt-elements' specifications."
  122. ;; Adopt an element.
  123. (should
  124. (equal '(plain-text italic)
  125. (org-test-with-temp-text "* Headline\n *a*"
  126. (let ((tree (org-element-parse-buffer)))
  127. (org-element-adopt-elements
  128. (org-element-map tree 'bold 'identity nil t) '(italic nil "a"))
  129. (mapcar (lambda (blob) (org-element-type blob))
  130. (org-element-contents
  131. (org-element-map tree 'bold 'identity nil t)))))))
  132. ;; Adopt a string.
  133. (should
  134. (equal '("a" "b")
  135. (org-test-with-temp-text "* Headline\n *a*"
  136. (let ((tree (org-element-parse-buffer)))
  137. (org-element-adopt-elements
  138. (org-element-map tree 'bold 'identity nil t) "b")
  139. (org-element-contents
  140. (org-element-map tree 'bold 'identity nil t)))))))
  141. ;;; Test Parsers
  142. ;;;; Affiliated Keywords
  143. (ert-deftest test-org-element/affiliated-keywords-parser ()
  144. "Test affiliated keywords parsing."
  145. ;; Read simple keywords.
  146. (should
  147. (equal "para"
  148. (org-element-property
  149. :name
  150. (org-test-with-temp-text "#+NAME: para\nParagraph"
  151. (org-element-at-point)))))
  152. (should
  153. (= 1
  154. (org-element-property
  155. :begin
  156. (org-test-with-temp-text "#+NAME: para\nParagraph"
  157. (org-element-at-point)))))
  158. ;; Parse multiple keywords.
  159. (should
  160. (equal
  161. '("line2" "line1")
  162. (org-element-property
  163. :attr_ascii
  164. (org-test-with-temp-text
  165. "#+ATTR_ASCII: line1\n#+ATTR_ASCII: line2\nParagraph"
  166. (org-element-at-point)))))
  167. ;; Parse "parsed" keywords.
  168. (should
  169. (equal
  170. '(("caption"))
  171. (org-test-with-temp-text "#+CAPTION: caption\nParagraph"
  172. (car (org-element-property :caption (org-element-at-point))))))
  173. ;; Parse dual keywords.
  174. (should
  175. (equal
  176. '((("long") "short"))
  177. (org-test-with-temp-text "#+CAPTION[short]: long\nParagraph"
  178. (org-element-property :caption (org-element-at-point)))))
  179. ;; Allow multiple caption keywords.
  180. (should
  181. (equal
  182. '((("l2") "s2") (("l1") "s1"))
  183. (org-test-with-temp-text "#+CAPTION[s1]: l1\n#+CAPTION[s2]: l2\nParagraph"
  184. (org-element-property :caption (org-element-at-point))))))
  185. ;;;; Babel Call
  186. (ert-deftest test-org-element/babel-call-parser ()
  187. "Test `babel-call' parsing."
  188. ;; Standard test.
  189. (should
  190. (org-test-with-temp-text "#+CALL: test()"
  191. (org-element-map (org-element-parse-buffer) 'babel-call 'identity)))
  192. ;; Ignore case.
  193. (should
  194. (org-test-with-temp-text "#+call: test()"
  195. (org-element-map (org-element-parse-buffer) 'babel-call 'identity))))
  196. ;;;; Bold
  197. (ert-deftest test-org-element/bold-parser ()
  198. "Test `bold' parser."
  199. ;; Standard test.
  200. (should
  201. (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^ \n,\"']\\|[^ \n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^ \n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
  202. (org-test-with-temp-text "*bold*"
  203. (org-element-map (org-element-parse-buffer) 'bold 'identity nil t))))
  204. ;; Multi-line markup.
  205. (should
  206. (equal
  207. (org-element-contents
  208. (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^ \n,\"']\\|[^ \n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^ \n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
  209. (org-test-with-temp-text "*first line\nsecond line*"
  210. (org-element-map (org-element-parse-buffer) 'bold 'identity nil t))))
  211. '("first line\nsecond line"))))
  212. ;;;; Center Block
  213. (ert-deftest test-org-element/center-block-parser ()
  214. "Test `center-block' parser."
  215. ;; Standard test.
  216. (should
  217. (org-test-with-temp-text "#+BEGIN_CENTER\nText\n#+END_CENTER"
  218. (org-element-map (org-element-parse-buffer) 'center-block 'identity)))
  219. ;; Ignore case.
  220. (should
  221. (org-test-with-temp-text "#+begin_center\nText\n#+end_center"
  222. (org-element-map (org-element-parse-buffer) 'center-block 'identity)))
  223. ;; Test folded block.
  224. (org-test-with-temp-text "#+BEGIN_CENTER\nText\n#+END_CENTER"
  225. (org-cycle)
  226. (should
  227. (org-element-property
  228. :hiddenp
  229. (org-element-map
  230. (org-element-parse-buffer) 'center-block 'identity nil t))))
  231. ;; Ignore incomplete block.
  232. (should-not
  233. (org-test-with-temp-text "#+BEGIN_CENTER"
  234. (org-element-map
  235. (org-element-parse-buffer) 'center-block 'identity nil t))))
  236. ;;;; Clock
  237. (ert-deftest test-org-element/clock-parser ()
  238. "Test `clock' parser."
  239. ;; Running clock.
  240. (let* ((org-clock-string "CLOCK:")
  241. (clock (org-test-with-temp-text "CLOCK: [2012-01-01 sun. 00:01]"
  242. (org-element-map
  243. (org-element-parse-buffer) 'clock 'identity nil t))))
  244. (should (eq (org-element-property :status clock) 'running))
  245. (should (equal (org-element-property :value clock)
  246. "[2012-01-01 sun. 00:01]"))
  247. (should-not (org-element-property :time clock)))
  248. ;; Closed clock.
  249. (let* ((org-clock-string "CLOCK:")
  250. (clock (org-test-with-temp-text "
  251. CLOCK: [2012-01-01 sun. 00:01]--[2012-01-01 sun. 00:02] => 0:01"
  252. (org-element-map
  253. (org-element-parse-buffer) 'clock 'identity nil t))))
  254. (should (eq (org-element-property :status clock) 'closed))
  255. (should (equal (org-element-property :value clock)
  256. "[2012-01-01 sun. 00:01]--[2012-01-01 sun. 00:02]"))
  257. (should (equal (org-element-property :time clock) "0:01"))))
  258. ;;;; Code
  259. (ert-deftest test-org-element/code-parser ()
  260. "Test `code' parser."
  261. ;; Regular test.
  262. (should
  263. (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^ \n,\"']\\|[^ \n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^ \n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
  264. (org-test-with-temp-text "~code~"
  265. (org-element-map (org-element-parse-buffer) 'code 'identity))))
  266. ;; Multi-line markup.
  267. (should
  268. (equal
  269. (org-element-property
  270. :value
  271. (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^ \n,\"']\\|[^ \n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^ \n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
  272. (org-test-with-temp-text "~first line\nsecond line~"
  273. (org-element-map
  274. (org-element-parse-buffer) 'code 'identity nil t))))
  275. "first line\nsecond line")))
  276. ;;;; Comment
  277. (ert-deftest test-org-element/comment-parser ()
  278. "Test `comment' parser."
  279. ;; Regular comment.
  280. (should
  281. (org-test-with-temp-text "# Comment"
  282. (org-element-map (org-element-parse-buffer) 'comment 'identity)))
  283. ;; Inline comment.
  284. (should
  285. (org-test-with-temp-text " # Comment"
  286. (org-element-map (org-element-parse-buffer) 'comment 'identity)))
  287. ;; Preserve indentation.
  288. (should
  289. (equal
  290. (org-element-property
  291. :value
  292. (org-test-with-temp-text "# No blank\n# One blank"
  293. (org-element-map (org-element-parse-buffer) 'comment 'identity nil t)))
  294. "No blank\n One blank"))
  295. ;; Comment with blank lines.
  296. (should
  297. (equal
  298. (org-element-property
  299. :value
  300. (org-test-with-temp-text "# First part\n# \n#\n# Second part"
  301. (org-element-map (org-element-parse-buffer) 'comment 'identity nil t)))
  302. "First part\n\n\nSecond part"))
  303. ;; Do not mix comments and keywords.
  304. (should
  305. (eq 1
  306. (org-test-with-temp-text "#+keyword: value\n# comment\n#+keyword: value"
  307. (length (org-element-map
  308. (org-element-parse-buffer) 'comment 'identity)))))
  309. (should
  310. (equal "comment"
  311. (org-test-with-temp-text "#+keyword: value\n# comment\n#+keyword: value"
  312. (org-element-property
  313. :value
  314. (org-element-map
  315. (org-element-parse-buffer) 'comment 'identity nil t))))))
  316. ;;;; Comment Block
  317. (ert-deftest test-org-element/comment-block-parser ()
  318. "Test `comment-block' parser."
  319. ;; Standard test.
  320. (should
  321. (org-test-with-temp-text "#+BEGIN_COMMENT\nText\n#+END_COMMENT"
  322. (org-element-map
  323. (org-element-parse-buffer) 'comment-block 'identity)))
  324. ;; Ignore case.
  325. (should
  326. (org-test-with-temp-text "#+begin_comment\nText\n#+end_comment"
  327. (org-element-map
  328. (org-element-parse-buffer) 'comment-block 'identity)))
  329. ;; Test folded block.
  330. (org-test-with-temp-text "#+BEGIN_COMMENT\nText\n#+END_COMMENT"
  331. (org-cycle)
  332. (should
  333. (org-element-property
  334. :hiddenp
  335. (org-element-map
  336. (org-element-parse-buffer) 'comment-block 'identity nil t))))
  337. ;; Ignore incomplete block.
  338. (should-not
  339. (org-test-with-temp-text "#+BEGIN_COMMENT"
  340. (org-element-map
  341. (org-element-parse-buffer) 'comment-block 'identity nil t))))
  342. ;;;; Drawer
  343. (ert-deftest test-org-element/drawer-parser ()
  344. "Test `drawer' parser."
  345. ;; Standard test.
  346. (should
  347. (let ((org-drawers '("TEST")))
  348. (org-test-with-temp-text ":TEST:\nText\n:END:"
  349. (org-element-map (org-element-parse-buffer) 'drawer 'identity))))
  350. ;; Do not mix regular drawers and property drawers.
  351. (should-not
  352. (let ((org-drawers '("PROPERTIES")))
  353. (org-test-with-temp-text ":PROPERTIES:\n:prop: value\n:END:"
  354. (org-element-map
  355. (org-element-parse-buffer) 'drawer 'identity nil t))))
  356. ;; Ignore incomplete drawer.
  357. (should-not
  358. (let ((org-drawers '("TEST")))
  359. (org-test-with-temp-text ":TEST:"
  360. (org-element-map
  361. (org-element-parse-buffer) 'drawer 'identity nil t)))))
  362. ;;;; Dynamic Block
  363. (ert-deftest test-org-element/dynamic-block-parser ()
  364. "Test `dynamic-block' parser."
  365. ;; Standard test.
  366. (should
  367. (org-test-with-temp-text
  368. "#+BEGIN: myblock :param1 val1 :param2 val2\nText\n#+END:"
  369. (org-element-map (org-element-parse-buffer) 'dynamic-block 'identity)))
  370. ;; Folded view
  371. (org-test-with-temp-text
  372. "#+BEGIN: myblock :param1 val1 :param2 val2\nText\n#+END:"
  373. (org-cycle)
  374. (should
  375. (org-element-property
  376. :hiddenp
  377. (org-element-map
  378. (org-element-parse-buffer) 'dynamic-block 'identity nil t))))
  379. ;; Ignore case.
  380. (should
  381. (org-test-with-temp-text
  382. "#+begin: myblock :param1 val1 :param2 val2\nText\n#+end:"
  383. (org-element-map (org-element-parse-buffer) 'dynamic-block 'identity)))
  384. ;; Ignore incomplete block.
  385. (should-not
  386. (org-test-with-temp-text "#+BEGIN: myblock :param1 val1 :param2 val2"
  387. (org-element-map
  388. (org-element-parse-buffer) 'dynamic-block 'identity nil t))))
  389. ;;;; Entity
  390. (ert-deftest test-org-element/entity-parser ()
  391. "Test `entity' parser."
  392. ;; Without brackets.
  393. (should
  394. (org-test-with-temp-text "\\sin"
  395. (org-element-map (org-element-parse-buffer) 'entity 'identity)))
  396. ;; With brackets.
  397. (should
  398. (org-element-property
  399. :use-brackets-p
  400. (org-test-with-temp-text "\\alpha{}text"
  401. (org-element-map (org-element-parse-buffer) 'entity 'identity nil t))))
  402. ;; User-defined entity.
  403. (should
  404. (equal
  405. (org-element-property
  406. :name
  407. (let ((org-entities-user
  408. '(("test" "test" nil "test" "test" "test" "test"))))
  409. (org-test-with-temp-text "\\test"
  410. (org-element-map (org-element-parse-buffer) 'entity 'identity nil t))))
  411. "test")))
  412. ;;;; Example Block
  413. (ert-deftest test-org-element/example-block-parser ()
  414. "Test `example-block' parser."
  415. ;; Standard test.
  416. (should
  417. (org-test-with-temp-text "#+BEGIN_EXAMPLE\nText\n#+END_EXAMPLE"
  418. (org-element-map (org-element-parse-buffer) 'example-block 'identity)))
  419. ;; Test folded block.
  420. (org-test-with-temp-text "#+BEGIN_EXAMPLE\nText\n#+END_EXAMPLE"
  421. (org-cycle)
  422. (should
  423. (org-element-property
  424. :hiddenp
  425. (org-element-map
  426. (org-element-parse-buffer) 'example-block 'identity nil t))))
  427. ;; Ignore incomplete block.
  428. (should-not
  429. (org-test-with-temp-text "#+BEGIN_EXAMPLE"
  430. (org-element-map
  431. (org-element-parse-buffer) 'example-block 'identity nil t))))
  432. (ert-deftest test-org-element/block-switches ()
  433. "Test `example-block' and `src-block' switches parsing."
  434. (let ((org-coderef-label-format "(ref:%s)"))
  435. ;; 1. Test "-i" switch.
  436. (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp\n(+ 1 1)\n#+END_SRC"
  437. (should-not
  438. (org-element-property :preserve-indent (org-element-at-point))))
  439. (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp -i\n(+ 1 1)\n#+END_SRC"
  440. (should (org-element-property :preserve-indent (org-element-at-point))))
  441. (org-test-with-temp-text "#+BEGIN_EXAMPLE\nText.\n#+END_EXAMPLE"
  442. (should-not
  443. (org-element-property :preserve-indent (org-element-at-point))))
  444. (org-test-with-temp-text "#+BEGIN_EXAMPLE -i\nText.\n#+END_EXAMPLE"
  445. (should (org-element-property :preserve-indent (org-element-at-point))))
  446. ;; 2. "-n -r -k" combination should number lines, retain labels but
  447. ;; not use them in coderefs.
  448. (org-test-with-temp-text "#+BEGIN_EXAMPLE -n -r -k\nText.\n#+END_EXAMPLE"
  449. (let ((element (org-element-at-point)))
  450. (should (and (org-element-property :number-lines element)
  451. (org-element-property :retain-labels element)
  452. (not (org-element-property :use-labels element))))))
  453. (org-test-with-temp-text
  454. "#+BEGIN_SRC emacs-lisp -n -r -k\n(+ 1 1)\n#+END_SRC"
  455. (let ((element (org-element-at-point)))
  456. (should (and (org-element-property :number-lines element)
  457. (org-element-property :retain-labels element)
  458. (not (org-element-property :use-labels element))))))
  459. ;; 3. "-n -r" combination should number-lines remove labels and not
  460. ;; use them in coderefs.
  461. (org-test-with-temp-text "#+BEGIN_EXAMPLE -n -r\nText.\n#+END_EXAMPLE"
  462. (let ((element (org-element-at-point)))
  463. (should (and (org-element-property :number-lines element)
  464. (not (org-element-property :retain-labels element))
  465. (not (org-element-property :use-labels element))))))
  466. (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp -n -r\n(+ 1 1)\n#+END_SRC"
  467. (let ((element (org-element-at-point)))
  468. (should (and (org-element-property :number-lines element)
  469. (not (org-element-property :retain-labels element))
  470. (not (org-element-property :use-labels element))))))
  471. ;; 4. "-n" or "+n" should number lines, retain labels and use them
  472. ;; in coderefs.
  473. (org-test-with-temp-text "#+BEGIN_EXAMPLE -n\nText.\n#+END_EXAMPLE"
  474. (let ((element (org-element-at-point)))
  475. (should (and (org-element-property :number-lines element)
  476. (org-element-property :retain-labels element)
  477. (org-element-property :use-labels element)))))
  478. (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp -n\n(+ 1 1)\n#+END_SRC"
  479. (let ((element (org-element-at-point)))
  480. (should (and (org-element-property :number-lines element)
  481. (org-element-property :retain-labels element)
  482. (org-element-property :use-labels element)))))
  483. (org-test-with-temp-text "#+BEGIN_EXAMPLE +n\nText.\n#+END_EXAMPLE"
  484. (let ((element (org-element-at-point)))
  485. (should (and (org-element-property :number-lines element)
  486. (org-element-property :retain-labels element)
  487. (org-element-property :use-labels element)))))
  488. (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp +n\n(+ 1 1)\n#+END_SRC"
  489. (let ((element (org-element-at-point)))
  490. (should (and (org-element-property :number-lines element)
  491. (org-element-property :retain-labels element)
  492. (org-element-property :use-labels element)))))
  493. ;; 5. No switch should not number lines, but retain labels and use
  494. ;; them in coderefs.
  495. (org-test-with-temp-text "#+BEGIN_EXAMPLE\nText.\n#+END_EXAMPLE"
  496. (let ((element (org-element-at-point)))
  497. (should (and (not (org-element-property :number-lines element))
  498. (org-element-property :retain-labels element)
  499. (org-element-property :use-labels element)))))
  500. (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp\n(+ 1 1)\n#+END_SRC"
  501. (let ((element (org-element-at-point)))
  502. (should (and (not (org-element-property :number-lines element))
  503. (org-element-property :retain-labels element)
  504. (org-element-property :use-labels element)))))
  505. ;; 6. "-r" switch only: do not number lines, remove labels, and
  506. ;; don't use labels in coderefs.
  507. (org-test-with-temp-text "#+BEGIN_EXAMPLE -r\nText.\n#+END_EXAMPLE"
  508. (let ((element (org-element-at-point)))
  509. (should (and (not (org-element-property :number-lines element))
  510. (not (org-element-property :retain-labels element))
  511. (not (org-element-property :use-labels element))))))
  512. (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp -r\n(+ 1 1)\n#+END_SRC"
  513. (let ((element (org-element-at-point)))
  514. (should (and (not (org-element-property :number-lines element))
  515. (not (org-element-property :retain-labels element))
  516. (not (org-element-property :use-labels element))))))
  517. ;; 7. Recognize coderefs with user-defined syntax.
  518. (org-test-with-temp-text
  519. "#+BEGIN_EXAMPLE -l \"[ref:%s]\"\nText [ref:text]\n#+END_EXAMPLE"
  520. (let ((element (org-element-at-point)))
  521. (should
  522. (equal (org-element-property :label-fmt element) "[ref:%s]"))))
  523. (org-test-with-temp-text
  524. "#+BEGIN_SRC emacs-lisp -l \"[ref:%s]\"\n(+ 1 1) [ref:text]\n#+END_SRC"
  525. (let ((element (org-element-at-point)))
  526. (should
  527. (equal (org-element-property :label-fmt element) "[ref:%s]"))))))
  528. ;;;; Export Block
  529. (ert-deftest test-org-element/export-block-parser ()
  530. "Test `export-block' parser."
  531. ;; Standard test.
  532. (should
  533. (org-test-with-temp-text "#+BEGIN_LATEX\nText\n#+END_LATEX"
  534. (org-element-map
  535. (let ((org-element-block-name-alist
  536. '(("LATEX" . org-element-export-block-parser))))
  537. (org-element-parse-buffer))
  538. 'export-block 'identity)))
  539. ;; Test folded block.
  540. (org-test-with-temp-text "#+BEGIN_LATEX\nText\n#+END_LATEX"
  541. (org-cycle)
  542. (should
  543. (org-element-property
  544. :hiddenp
  545. (org-element-map
  546. (let ((org-element-block-name-alist
  547. '(("LATEX" . org-element-export-block-parser))))
  548. (org-element-parse-buffer))
  549. 'export-block 'identity nil t))))
  550. ;; Ignore case.
  551. (should
  552. (org-test-with-temp-text "#+begin_latex\nText\n#+end_latex"
  553. (org-element-map
  554. (let ((org-element-block-name-alist
  555. '(("LATEX" . org-element-export-block-parser))))
  556. (org-element-parse-buffer))
  557. 'export-block 'identity)))
  558. ;; Ignore incomplete block.
  559. (should-not
  560. (org-test-with-temp-text "#+BEGIN_LATEX"
  561. (org-element-map
  562. (let ((org-element-block-name-alist
  563. '(("LATEX" . org-element-export-block-parser))))
  564. (org-element-parse-buffer))
  565. 'export-block 'identity nil t))))
  566. ;;;; Export Snippet
  567. (ert-deftest test-org-element/export-snippet-parser ()
  568. "Test `export-snippet' parser."
  569. (should
  570. (equal
  571. '("back-end" . "contents")
  572. (org-test-with-temp-text "@@back-end:contents@@"
  573. (org-element-map
  574. (org-element-parse-buffer) 'export-snippet
  575. (lambda (snippet) (cons (org-element-property :back-end snippet)
  576. (org-element-property :value snippet)))
  577. nil t)))))
  578. ;;;; Fixed Width
  579. (ert-deftest test-org-element/fixed-width ()
  580. "Test fixed-width area parsing."
  581. ;; Preserve indentation.
  582. (should
  583. (org-test-with-temp-text ": no blank\n: one blank"
  584. (org-element-map (org-element-parse-buffer) 'fixed-width 'identity)))
  585. ;; Fixed-width with empty lines.
  586. (should
  587. (org-test-with-temp-text ": first part\n:\n: \n: second part"
  588. (org-element-map (org-element-parse-buffer) 'fixed-width 'identity)))
  589. ;; Parse indented fixed-width markers.
  590. (should
  591. (org-test-with-temp-text "Text\n : no blank\n : one blank"
  592. (org-element-map (org-element-parse-buffer) 'fixed-width 'identity)))
  593. ;; Distinguish fixed-width areas within a list and outside of it.
  594. (should
  595. (= 2
  596. (length
  597. (org-test-with-temp-text "
  598. - Item
  599. : fixed-width inside
  600. : fixed-width outside"
  601. (org-element-map
  602. (org-element-parse-buffer) 'fixed-width 'identity))))))
  603. ;;;; Footnote Definition
  604. (ert-deftest test-org-element/footnote-definition-parser ()
  605. "Test `footnote-definition' parser."
  606. (should
  607. (org-test-with-temp-text "[fn:1] Definition"
  608. (org-element-map
  609. (org-element-parse-buffer) 'footnote-definition 'identity nil t)))
  610. ;; Footnote with more contents
  611. (should
  612. (= 28
  613. (org-element-property
  614. :end
  615. (org-test-with-temp-text "[fn:1] Definition\n| a | b |"
  616. (org-element-map
  617. (org-element-parse-buffer)
  618. 'footnote-definition 'identity nil t)))))
  619. ;; Footnote starting with special syntax.
  620. (should-not
  621. (org-test-with-temp-text "[fn:1] - no item"
  622. (org-element-map (org-element-parse-buffer) 'item 'identity))))
  623. ;;;; Footnotes Reference.
  624. (ert-deftest test-org-element/footnote-reference-parser ()
  625. "Test `footnote-reference' parser."
  626. ;; 1. Parse a standard reference.
  627. (org-test-with-temp-text "Text[fn:label]"
  628. (should
  629. (org-element-map
  630. (org-element-parse-buffer) 'footnote-reference 'identity)))
  631. ;; 2. Parse a normalized reference.
  632. (org-test-with-temp-text "Text[1]"
  633. (should
  634. (org-element-map
  635. (org-element-parse-buffer) 'footnote-reference 'identity)))
  636. ;; 3. Parse an inline reference.
  637. (org-test-with-temp-text "Text[fn:test:def]"
  638. (should
  639. (org-element-map
  640. (org-element-parse-buffer) 'footnote-reference 'identity)))
  641. ;; 4. Parse an anonymous reference.
  642. (org-test-with-temp-text "Text[fn::def]"
  643. (should
  644. (org-element-map
  645. (org-element-parse-buffer) 'footnote-reference 'identity)))
  646. ;; 5. Parse nested footnotes.
  647. (org-test-with-temp-text "Text[fn::def [fn:label]]"
  648. (should
  649. (= 2
  650. (length
  651. (org-element-map
  652. (org-element-parse-buffer) 'footnote-reference 'identity)))))
  653. ;; 6. Parse adjacent footnotes.
  654. (org-test-with-temp-text "Text[fn:label1][fn:label2]"
  655. (should
  656. (= 2
  657. (length
  658. (org-element-map
  659. (org-element-parse-buffer) 'footnote-reference 'identity)))))
  660. ;; 7. Only properly closed footnotes are recognized as such.
  661. (org-test-with-temp-text "Text[fn:label"
  662. (should-not
  663. (org-element-map
  664. (org-element-parse-buffer) 'footnote-reference 'identity))))
  665. ;;;; Headline
  666. (ert-deftest test-org-element/headline-quote-keyword ()
  667. "Test QUOTE keyword recognition."
  668. ;; Reference test.
  669. (org-test-with-temp-text "* Headline"
  670. (let ((org-quote-string "QUOTE"))
  671. (should-not (org-element-property :quotedp (org-element-at-point)))))
  672. ;; Standard position.
  673. (org-test-with-temp-text "* QUOTE Headline"
  674. (let* ((org-quote-string "QUOTE")
  675. (headline (org-element-at-point)))
  676. (should (org-element-property :quotedp headline))
  677. ;; Test removal from raw value.
  678. (should (equal (org-element-property :raw-value headline) "Headline"))))
  679. ;; Case sensitivity.
  680. (org-test-with-temp-text "* QUOTE Headline"
  681. (let* ((org-quote-string "Quote")
  682. (headline (org-element-at-point)))
  683. (should-not (org-element-property :quotedp headline))
  684. (should (equal (org-element-property :raw-value headline)
  685. "QUOTE Headline"))))
  686. ;; With another keyword.
  687. (org-test-with-temp-text "* TODO QUOTE Headline"
  688. (let* ((org-quote-string "QUOTE")
  689. (org-todo-keywords '((sequence "TODO" "DONE")))
  690. (headline (org-element-at-point)))
  691. (should (org-element-property :quotedp headline))
  692. (should (equal (org-element-property :raw-value headline) "Headline"))))
  693. ;; With the keyword only.
  694. (org-test-with-temp-text "* QUOTE"
  695. (let* ((org-quote-string "QUOTE")
  696. (headline (org-element-at-point)))
  697. (should (org-element-property :quotedp headline))
  698. (should (equal (org-element-property :raw-value headline) "")))))
  699. (ert-deftest test-org-element/headline-comment-keyword ()
  700. "Test COMMENT keyword recognition."
  701. ;; Reference test.
  702. (org-test-with-temp-text "* Headline"
  703. (let ((org-comment-string "COMMENT"))
  704. (should-not (org-element-property :commentedp (org-element-at-point)))))
  705. ;; Standard position.
  706. (org-test-with-temp-text "* COMMENT Headline"
  707. (let ((org-comment-string "COMMENT")
  708. (headline (org-element-at-point)))
  709. (should (org-element-property :commentedp headline))
  710. (should (equal (org-element-property :raw-value headline) "Headline"))))
  711. ;; Case sensitivity.
  712. (org-test-with-temp-text "* COMMENT Headline"
  713. (let* ((org-comment-string "Comment")
  714. (headline (org-element-at-point)))
  715. (should-not (org-element-property :commentedp headline))
  716. (should (equal (org-element-property :raw-value headline)
  717. "COMMENT Headline"))))
  718. ;; With another keyword.
  719. (org-test-with-temp-text "* TODO COMMENT Headline"
  720. (let* ((org-comment-string "COMMENT")
  721. (org-todo-keywords '((sequence "TODO" "DONE")))
  722. (headline (org-element-at-point)))
  723. (should (org-element-property :commentedp headline))
  724. (should (equal (org-element-property :raw-value headline) "Headline"))))
  725. ;; With the keyword only.
  726. (org-test-with-temp-text "* COMMENT"
  727. (let* ((org-comment-string "COMMENT")
  728. (headline (org-element-at-point)))
  729. (should (org-element-property :commentedp headline))
  730. (should (equal (org-element-property :raw-value headline) "")))))
  731. (ert-deftest test-org-element/headline-archive-tag ()
  732. "Test ARCHIVE tag recognition."
  733. ;; Reference test.
  734. (org-test-with-temp-text "* Headline"
  735. (let ((org-archive-tag "ARCHIVE"))
  736. (should-not (org-element-property :archivedp (org-element-at-point)))))
  737. ;; Single tag.
  738. (org-test-with-temp-text "* Headline :ARCHIVE:"
  739. (let ((org-archive-tag "ARCHIVE"))
  740. (let ((headline (org-element-at-point)))
  741. (should (org-element-property :archivedp headline))
  742. ;; Test tag removal.
  743. (should-not (org-element-property :tags headline))))
  744. (let ((org-archive-tag "Archive"))
  745. (should-not (org-element-property :archivedp (org-element-at-point)))))
  746. ;; Multiple tags.
  747. (org-test-with-temp-text "* Headline :test:ARCHIVE:"
  748. (let ((org-archive-tag "ARCHIVE"))
  749. (let ((headline (org-element-at-point)))
  750. (should (org-element-property :archivedp headline))
  751. ;; Test tag removal.
  752. (should (equal (org-element-property :tags headline) '("test")))))))
  753. ;;;; Horizontal Rule
  754. (ert-deftest test-org-element/horizontal-rule-parser ()
  755. "Test `horizontal-rule' parser."
  756. ;; Standard.
  757. (should
  758. (org-test-with-temp-text "-----"
  759. (org-element-map (org-element-parse-buffer) 'horizontal-rule 'identity)))
  760. ;; Indented.
  761. (should
  762. (org-test-with-temp-text " -----"
  763. (org-element-map (org-element-parse-buffer) 'horizontal-rule 'identity)))
  764. ;; Hyphen must be alone on the line.
  765. (should-not
  766. (org-test-with-temp-text "-----wrong"
  767. (org-element-map (org-element-parse-buffer) 'horizontal-rule 'identity)))
  768. ;; 4 hyphens is too small.
  769. (should-not
  770. (org-test-with-temp-text "----"
  771. (org-element-map (org-element-parse-buffer) 'horizontal-rule 'identity))))
  772. ;;;; Inline Babel Call
  773. (ert-deftest test-org-element/inline-babel-call-parser ()
  774. "Test `inline-babel-call' parser."
  775. (should
  776. (org-test-with-temp-text "call_test()"
  777. (org-element-map
  778. (org-element-parse-buffer) 'inline-babel-call 'identity))))
  779. ;;;; Inline Src Block
  780. (ert-deftest test-org-element/inline-src-block-parser ()
  781. "Test `inline-src-block' parser."
  782. (should
  783. (org-test-with-temp-text "src_emacs-lisp{(+ 1 1)}"
  784. (org-element-map (org-element-parse-buffer) 'inline-src-block 'identity)))
  785. ;; Test parsing at the beginning of an item.
  786. (should
  787. (org-test-with-temp-text "- src_emacs-lisp{(+ 1 1)}"
  788. (org-element-map (org-element-parse-buffer) 'inline-src-block 'identity))))
  789. ;;;; Inlinetask
  790. (ert-deftest test-org-element/inlinetask-parser ()
  791. "Test `inlinetask' parser."
  792. (when (featurep 'org-inlinetask)
  793. (let ((org-inlinetask-min-level 15))
  794. ;; 1. Regular inlinetask.
  795. (should
  796. (org-test-with-temp-text
  797. "*************** Task\nTest\n*************** END"
  798. (org-element-map (org-element-parse-buffer) 'inlinetask 'identity)))
  799. ;; 2. Degenerate inlinetask.
  800. (should
  801. (org-test-with-temp-text "*************** Task"
  802. (org-element-map (org-element-parse-buffer) 'inlinetask 'identity)))
  803. ;; TODO keyword.
  804. (should
  805. (equal
  806. "TODO"
  807. (let ((org-todo-keywords '((sequence "TODO" "DONE"))))
  808. (org-test-with-temp-text "*************** TODO Task"
  809. (org-element-property
  810. :todo-keyword
  811. (org-element-map
  812. (org-element-parse-buffer) 'inlinetask 'identity nil t))))))
  813. ;; Planning info.
  814. (should
  815. (equal
  816. "2012-03-29 thu."
  817. (org-test-with-temp-text "
  818. *************** Task
  819. DEADLINE: <2012-03-29 thu.>"
  820. (org-element-property
  821. :deadline
  822. (org-element-map
  823. (org-element-parse-buffer) 'inlinetask 'identity nil t)))))
  824. ;; Priority.
  825. (should
  826. (equal
  827. ?A
  828. (org-test-with-temp-text "
  829. *************** [#A] Task"
  830. (org-element-property
  831. :priority
  832. (org-element-map
  833. (org-element-parse-buffer) 'inlinetask 'identity nil t)))))
  834. ;; Tags.
  835. (should
  836. (equal
  837. '("test")
  838. (org-test-with-temp-text "
  839. *************** Task :test:"
  840. (org-element-property
  841. :tags
  842. (org-element-map
  843. (org-element-parse-buffer) 'inlinetask 'identity nil t))))))))
  844. ;;;; Italic
  845. (ert-deftest test-org-element/italic-parser ()
  846. "Test `italic' parser."
  847. ;; Regular test.
  848. (should
  849. (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^ \n,\"']\\|[^ \n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^ \n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
  850. (org-test-with-temp-text "/italic/"
  851. (org-element-map (org-element-parse-buffer) 'italic 'identity nil t))))
  852. ;; Multi-line markup.
  853. (should
  854. (equal
  855. (org-element-contents
  856. (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^ \n,\"']\\|[^ \n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^ \n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
  857. (org-test-with-temp-text "/first line\nsecond line/"
  858. (org-element-map (org-element-parse-buffer) 'italic 'identity nil t))))
  859. '("first line\nsecond line"))))
  860. ;;;; Item
  861. (ert-deftest test-org-element/item-parser ()
  862. "Test `item' parser."
  863. ;; Standard test.
  864. (should
  865. (org-test-with-temp-text "- item"
  866. (org-element-map (org-element-parse-buffer) 'item 'identity)))
  867. ;; Counter.
  868. (should
  869. (= 6
  870. (org-element-property
  871. :counter
  872. (org-test-with-temp-text "6. [@6] item"
  873. (org-element-map (org-element-parse-buffer) 'item 'identity nil t)))))
  874. ;; Tag
  875. (should
  876. (equal
  877. '("tag")
  878. (org-element-property
  879. :tag
  880. (org-test-with-temp-text "- tag :: description"
  881. (org-element-map (org-element-parse-buffer) 'item 'identity nil t)))))
  882. ;; No tags in ordered lists.
  883. (should-not
  884. (org-element-property
  885. :tag
  886. (org-test-with-temp-text "1. tag :: description"
  887. (org-element-map (org-element-parse-buffer) 'item 'identity nil t))))
  888. ;; Check-boxes
  889. (should
  890. (equal
  891. '(trans on off)
  892. (org-test-with-temp-text "
  893. - [-] item 1
  894. - [X] item 1.1
  895. - [ ] item 1.2"
  896. (org-element-map
  897. (org-element-parse-buffer) 'item
  898. (lambda (item) (org-element-property :checkbox item))))))
  899. ;; Folded state.
  900. (org-test-with-temp-text "* Headline
  901. - item
  902. paragraph below"
  903. (forward-line)
  904. (let ((org-cycle-include-plain-lists t)) (org-cycle))
  905. (should
  906. (org-element-property
  907. :hiddenp
  908. (org-element-map (org-element-parse-buffer) 'item 'identity nil t))))
  909. ;; Item starting with special syntax.
  910. (should
  911. (equal '(("- item"))
  912. (org-test-with-temp-text "- - item"
  913. (org-element-map
  914. (org-element-parse-buffer) 'paragraph 'org-element-contents)))))
  915. ;;;; Keyword
  916. (ert-deftest test-org-element/keyword-parser ()
  917. "Test `keyword' parser."
  918. ;; Standard test.
  919. (should
  920. (org-test-with-temp-text "#+KEYWORD: value"
  921. (org-element-map (org-element-parse-buffer) 'keyword 'identity)))
  922. ;; Keywords are case-insensitive.
  923. (should
  924. (org-test-with-temp-text "#+keyword: value"
  925. (org-element-map (org-element-parse-buffer) 'keyword 'identity)))
  926. ;; Affiliated keywords are not keywords.
  927. (should-not
  928. (org-test-with-temp-text "#+NAME: value
  929. Paragraph"
  930. (org-element-map (org-element-parse-buffer) 'keyword 'identity)))
  931. ;; Do not mix keywords with Babel calls and dynamic blocks.
  932. (should-not
  933. (org-test-with-temp-text "#+CALL: fun()"
  934. (org-element-map (org-element-parse-buffer) 'keyword 'identity)))
  935. (should-not
  936. (org-test-with-temp-text "#+BEGIN: my-fun\nBody\n#+END:"
  937. (org-element-map (org-element-parse-buffer) 'keyword 'identity))))
  938. ;;;; Latex Environment
  939. (ert-deftest test-org-element/latex-environment-parser ()
  940. "Test `latex-environment' parser."
  941. (should
  942. (org-test-with-temp-text "\\begin{equation}\ne^{i\\pi}+1=0\n\\end{equation}"
  943. (org-element-map
  944. (org-element-parse-buffer) 'latex-environment 'identity)))
  945. ;; Allow nested environments.
  946. (should
  947. (equal
  948. "\\begin{outer}
  949. \\begin{inner}
  950. e^{i\\pi}+1=0
  951. \\end{inner}
  952. \\end{outer}"
  953. (org-test-with-temp-text "
  954. \\begin{outer}
  955. \\begin{inner}
  956. e^{i\\pi}+1=0
  957. \\end{inner}
  958. \\end{outer}"
  959. (org-element-property
  960. :value
  961. (org-element-map
  962. (org-element-parse-buffer) 'latex-environment 'identity nil t))))))
  963. ;;;; Latex Fragment
  964. (ert-deftest test-org-element/latex-fragment-parser ()
  965. "Test `latex-fragment' parser."
  966. (let ((org-latex-regexps
  967. '(("begin" "^[ ]*\\(\\\\begin{\\([a-zA-Z0-9\\*]+\\)[^�]+?\\\\end{\\2}\\)" 1 t)
  968. ("$1" "\\([^$]\\|^\\)\\(\\$[^ \n,;.$]\\$\\)\\([- .,?;:'\")�]\\|$\\)" 2 nil)
  969. ("$" "\\([^$]\\|^\\)\\(\\(\\$\\([^ \n,;.$][^$\n ]*?\\(\n[^$\n ]*?\\)\\{0,2\\}[^ \n,.$]\\)\\$\\)\\)\\([- .,?;:'\")�]\\|$\\)" 2 nil)
  970. ("\\(" "\\\\([^�]*?\\\\)" 0 nil)
  971. ("\\[" "\\\\\\[[^�]*?\\\\\\]" 0 nil)
  972. ("$$" "\\$\\$[^�]*?\\$\\$" 0 nil))))
  973. (should
  974. (org-test-with-temp-text "$a$"
  975. (org-element-map (org-element-parse-buffer) 'latex-fragment 'identity)))
  976. (should
  977. (org-test-with-temp-text "$$a$$"
  978. (org-element-map (org-element-parse-buffer) 'latex-fragment 'identity)))
  979. (should
  980. (org-test-with-temp-text "\\(a\\)"
  981. (org-element-map (org-element-parse-buffer) 'latex-fragment 'identity)))
  982. (should
  983. (org-test-with-temp-text "\\[a\\]"
  984. (org-element-map
  985. (org-element-parse-buffer) 'latex-fragment 'identity)))))
  986. ;;;; Line Break
  987. (ert-deftest test-org-element/line-break-parser ()
  988. "Test `line-break' parser."
  989. ;; Regular test.
  990. (should
  991. (org-test-with-temp-text "Text \\\\"
  992. (org-element-map (org-element-parse-buffer) 'line-break 'identity)))
  993. ;; Line break with trailing white spaces.
  994. (should
  995. (org-test-with-temp-text "Text \\\\ "
  996. (org-element-map (org-element-parse-buffer) 'line-break 'identity)))
  997. ;; Three backslashes are too much.
  998. (should-not
  999. (org-test-with-temp-text "Text \\\\\\"
  1000. (org-element-map (org-element-parse-buffer) 'line-break 'identity))))
  1001. ;;;; Link
  1002. (ert-deftest test-org-element/link-parser ()
  1003. "Test `link' parser."
  1004. ;; 1. Radio target.
  1005. (should
  1006. (equal
  1007. "radio"
  1008. (org-test-with-temp-text "A radio link"
  1009. (org-element-property
  1010. :type
  1011. (org-element-map
  1012. (let ((org-target-link-regexp "radio")) (org-element-parse-buffer))
  1013. 'link 'identity nil t)))))
  1014. ;; 2. Standard link.
  1015. ;;
  1016. ;; 2.1. With description.
  1017. (should
  1018. (equal
  1019. '("Orgmode.org")
  1020. (org-test-with-temp-text "[[http://orgmode.org][Orgmode.org]]"
  1021. (org-element-contents
  1022. (org-element-map (org-element-parse-buffer) 'link 'identity nil t)))))
  1023. ;; 2.2. Without description.
  1024. (should
  1025. (equal
  1026. "http"
  1027. (org-test-with-temp-text "[[http://orgmode.org]]"
  1028. (org-element-property
  1029. :type
  1030. (org-element-map (org-element-parse-buffer) 'link 'identity nil t)))))
  1031. ;; 2.3. With expansion.
  1032. (should
  1033. (equal
  1034. "//orgmode.org/worg"
  1035. (org-test-with-temp-text "[[Org:worg]]"
  1036. (let ((org-link-abbrev-alist '(("Org" . "http://orgmode.org/"))))
  1037. (org-element-property
  1038. :path
  1039. (org-element-map (org-element-parse-buffer) 'link 'identity nil t))))))
  1040. ;; 2.4. With translation.
  1041. (should
  1042. (equal
  1043. "127.0.0.1"
  1044. (org-test-with-temp-text "[[http://orgmode.org]]"
  1045. (flet ((link-translate (type path) (cons type "127.0.0.1")))
  1046. (let ((org-link-translation-function 'link-translate))
  1047. (org-element-property
  1048. :path
  1049. (org-element-map
  1050. (org-element-parse-buffer) 'link 'identity nil t)))))))
  1051. ;; 2.5. Id link.
  1052. (should
  1053. (equal
  1054. "id"
  1055. (org-test-with-temp-text "[[id:aaaa]]"
  1056. (org-element-property
  1057. :type
  1058. (org-element-map (org-element-parse-buffer) 'link 'identity nil t)))))
  1059. ;; 2.6. Custom-id link.
  1060. (should
  1061. (equal
  1062. "custom-id"
  1063. (org-test-with-temp-text "[[#some-id]]"
  1064. (org-element-property
  1065. :type
  1066. (org-element-map (org-element-parse-buffer) 'link 'identity nil t)))))
  1067. ;; 2.7 Coderef link.
  1068. (should
  1069. (equal
  1070. "coderef"
  1071. (org-test-with-temp-text "[[(reference)]]"
  1072. (org-element-property
  1073. :type
  1074. (org-element-map (org-element-parse-buffer) 'link 'identity nil t)))))
  1075. ;; 2.8 Fuzzy link.
  1076. (should
  1077. (equal
  1078. "fuzzy"
  1079. (org-test-with-temp-text "[[target-or-title]]"
  1080. (org-element-property
  1081. :type
  1082. (org-element-map (org-element-parse-buffer) 'link 'identity nil t)))))
  1083. ;; 2.9 File-type link with search option.
  1084. (should
  1085. (equal
  1086. '(("file" "projects.org" "*task title"))
  1087. (org-test-with-temp-text "[[file:projects.org::*task title]]"
  1088. (org-element-map
  1089. (org-element-parse-buffer) 'link
  1090. (lambda (l) (list (org-element-property :type l)
  1091. (org-element-property :path l)
  1092. (org-element-property :search-option l)))))))
  1093. ;; 2.10 File-type link with application.
  1094. (should
  1095. (equal
  1096. '(("file" "projects.org" "docview"))
  1097. (org-test-with-temp-text "[[docview:projects.org]]"
  1098. (org-element-map
  1099. (org-element-parse-buffer) 'link
  1100. (lambda (l) (list (org-element-property :type l)
  1101. (org-element-property :path l)
  1102. (org-element-property :application l)))))))
  1103. ;; 3. Plain link.
  1104. (should
  1105. (org-test-with-temp-text "A link: http://orgmode.org"
  1106. (org-element-map (org-element-parse-buffer) 'link 'identity)))
  1107. ;; 4. Angular link.
  1108. (should
  1109. (org-test-with-temp-text "A link: <http://orgmode.org>"
  1110. (org-element-map (org-element-parse-buffer) 'link 'identity nil t))))
  1111. ;;;; Macro
  1112. (ert-deftest test-org-element/macro-parser ()
  1113. "Test `macro' parser."
  1114. ;; Without arguments.
  1115. (should
  1116. (org-test-with-temp-text "{{{macro}}}"
  1117. (org-element-map (org-element-parse-buffer) 'macro 'identity)))
  1118. ;; With arguments.
  1119. (should
  1120. (org-test-with-temp-text "{{{macro(arg1,arg2)}}}"
  1121. (org-element-map (org-element-parse-buffer) 'macro 'identity))))
  1122. ;;;; Node Property
  1123. (ert-deftest test-org-element/node-property ()
  1124. "Test `node-property' parser."
  1125. ;; Standard test.
  1126. (should
  1127. (equal '("abc" "value")
  1128. (org-test-with-temp-text ":PROPERTIES:\n:abc: value\n:END:"
  1129. (progn (forward-line)
  1130. (let ((element (org-element-at-point)))
  1131. (list (org-element-property :key element)
  1132. (org-element-property :value element)))))))
  1133. ;; Value should be trimmed.
  1134. (should
  1135. (equal "value"
  1136. (org-test-with-temp-text ":PROPERTIES:\n:abc: value \n:END:"
  1137. (progn (forward-line)
  1138. (let ((element (org-element-at-point)))
  1139. (org-element-property :value element))))))
  1140. ;; A node property requires to be wrapped within a property drawer.
  1141. (should-not
  1142. (eq 'node-property
  1143. (org-test-with-temp-text ":abc: value"
  1144. (org-element-type (org-element-at-point))))))
  1145. ;;;; Paragraph
  1146. (ert-deftest test-org-element/paragraph-parser ()
  1147. "Test `paragraph' parser."
  1148. ;; Standard test.
  1149. (should
  1150. (org-test-with-temp-text "Paragraph"
  1151. (org-element-map (org-element-parse-buffer) 'paragraph 'identity nil t)))
  1152. ;; Property find end of a paragraph stuck to another element.
  1153. (should
  1154. (eq ?#
  1155. (org-test-with-temp-text "Paragraph\n# Comment"
  1156. (org-element-map
  1157. (org-element-parse-buffer) 'paragraph
  1158. (lambda (p) (char-after (org-element-property :end p)))
  1159. nil t))))
  1160. ;; Include ill-formed Keywords.
  1161. (should
  1162. (org-test-with-temp-text "#+wrong_keyword something"
  1163. (org-element-map (org-element-parse-buffer) 'paragraph 'identity)))
  1164. ;; Include incomplete-drawers.
  1165. (should
  1166. (let ((org-drawers '("TEST")))
  1167. (org-test-with-temp-text ":TEST:\nParagraph"
  1168. (let ((elem (org-element-at-point)))
  1169. (and (eq (org-element-type elem) 'paragraph)
  1170. (= (point-max) (org-element-property :end elem)))))))
  1171. ;; Include non-existent drawers.
  1172. (should
  1173. (let ((org-drawers '("TEST")))
  1174. (org-test-with-temp-text ":NONAME:"
  1175. (org-element-map (org-element-parse-buffer) 'paragraph 'identity))))
  1176. ;; Include incomplete blocks.
  1177. (should
  1178. (org-test-with-temp-text "#+BEGIN_CENTER\nParagraph"
  1179. (let ((elem (org-element-at-point)))
  1180. (and (eq (org-element-type elem) 'paragraph)
  1181. (= (point-max) (org-element-property :end elem))))))
  1182. ;; Include incomplete dynamic blocks.
  1183. (should
  1184. (org-test-with-temp-text "#+BEGIN: \nParagraph"
  1185. (let ((elem (org-element-at-point)))
  1186. (and (eq (org-element-type elem) 'paragraph)
  1187. (= (point-max) (org-element-property :end elem))))))
  1188. ;; Include incomplete latex environments.
  1189. (should
  1190. (org-test-with-temp-text "\begin{equation}\nParagraph"
  1191. (let ((elem (org-element-at-point)))
  1192. (and (eq (org-element-type elem) 'paragraph)
  1193. (= (point-max) (org-element-property :end elem))))))
  1194. ;; Do not steal affiliated keywords from container.
  1195. (should
  1196. (org-test-with-temp-text "#+ATTR_LATEX: test\n- item 1"
  1197. (let ((elem (progn (search-forward "item") (org-element-at-point))))
  1198. (and (eq (org-element-type elem) 'paragraph)
  1199. (not (org-element-property :attr_latex elem))
  1200. (/= (org-element-property :begin elem) 1))))))
  1201. ;;;; Plain List
  1202. (ert-deftest test-org-element/plain-list-parser ()
  1203. "Test `plain-list' parser."
  1204. (should
  1205. (org-test-with-temp-text "- item"
  1206. (org-element-map (org-element-parse-buffer) 'plain-list 'identity)))
  1207. ;; Blank lines after the list only belong to outer plain list.
  1208. (org-test-with-temp-text "
  1209. - outer
  1210. - inner
  1211. Outside list"
  1212. (let ((endings (org-element-map
  1213. (org-element-parse-buffer) 'plain-list
  1214. (lambda (pl) (org-element-property :end pl)))))
  1215. ;; Move to ending of outer list.
  1216. (goto-char (car endings))
  1217. (should (looking-at "Outside list"))
  1218. ;; Move to ending of inner list.
  1219. (goto-char (nth 1 endings))
  1220. (should (looking-at "^$")))))
  1221. ;;;; Planning
  1222. (ert-deftest test-org-element/planning-parser ()
  1223. "Test `planning' parser."
  1224. (should
  1225. (equal
  1226. (org-element-property
  1227. :closed
  1228. (org-test-with-temp-text "CLOSED: [2012-03-29 thu.]"
  1229. (org-element-map (org-element-parse-buffer) 'planning 'identity nil t)))
  1230. "2012-03-29 thu."))
  1231. (should
  1232. (equal
  1233. (org-element-property
  1234. :deadline
  1235. (org-test-with-temp-text "DEADLINE: <2012-03-29 thu.>"
  1236. (org-element-map (org-element-parse-buffer) 'planning 'identity nil t)))
  1237. "2012-03-29 thu."))
  1238. (should
  1239. (equal
  1240. (org-element-property
  1241. :scheduled
  1242. (org-test-with-temp-text "SCHEDULED: <2012-03-29 thu.>"
  1243. (org-element-map (org-element-parse-buffer) 'planning 'identity nil t)))
  1244. "2012-03-29 thu.")))
  1245. ;;;; Property Drawer
  1246. (ert-deftest test-org-element/property-drawer ()
  1247. "Test `property-drawer' parser."
  1248. ;; Standard test.
  1249. (should
  1250. (let ((org-drawers '("PROPERTIES")))
  1251. (org-test-with-temp-text ":PROPERTIES:\n:prop: value\n:END:"
  1252. (org-element-map
  1253. (org-element-parse-buffer) 'property-drawer 'identity nil t))))
  1254. ;; Do not mix property drawers and regular drawers.
  1255. (should-not
  1256. (let ((org-drawers '("TEST")))
  1257. (org-test-with-temp-text ":TEST:\n:prop: value\n:END:"
  1258. (org-element-map
  1259. (org-element-parse-buffer) 'property-drawer 'identity nil t))))
  1260. ;; Ignore incomplete drawer.
  1261. (should-not
  1262. (let ((org-drawers '("PROPERTIES")))
  1263. (org-test-with-temp-text ":PROPERTIES:\n:prop: value"
  1264. (org-element-map
  1265. (org-element-parse-buffer) 'property-drawer 'identity nil t)))))
  1266. ;;;; Quote Block
  1267. (ert-deftest test-org-element/quote-block-parser ()
  1268. "Test `quote-block' parser."
  1269. ;; Regular test.
  1270. (should
  1271. (org-test-with-temp-text "#+BEGIN_QUOTE\nText\n#+END_QUOTE"
  1272. (org-element-map (org-element-parse-buffer) 'quote-block 'identity)))
  1273. ;; Test folded block.
  1274. (org-test-with-temp-text "#+BEGIN_QUOTE\nText\n#+END_QUOTE"
  1275. (org-cycle)
  1276. (should
  1277. (org-element-property
  1278. :hiddenp
  1279. (org-element-map
  1280. (org-element-parse-buffer) 'quote-block 'identity nil t))))
  1281. ;; Ignore incomplete block.
  1282. (should-not
  1283. (org-test-with-temp-text "#+BEGIN_QUOTE"
  1284. (org-element-map
  1285. (org-element-parse-buffer) 'quote-block 'identity nil t))))
  1286. ;;;; Quote Section
  1287. (ert-deftest test-org-element/quote-section-parser ()
  1288. "Test `quote-section' parser."
  1289. (should
  1290. (let ((org-quote-string "QUOTE"))
  1291. (org-test-with-temp-text "* QUOTE Headline\nBody"
  1292. (org-element-map (org-element-parse-buffer) 'quote-section 'identity))))
  1293. (should-not
  1294. (let ((org-quote-string "TEST"))
  1295. (org-test-with-temp-text "* QUOTE Headline\nBody"
  1296. (org-element-map (org-element-parse-buffer) 'quote-section 'identity)))))
  1297. ;;;; Radio Target
  1298. (ert-deftest test-org-element/radio-target-parser ()
  1299. "Test `radio-target' parser."
  1300. ;; Standard test.
  1301. (should
  1302. (org-test-with-temp-text "<<<radio>>>"
  1303. (org-element-map (org-element-parse-buffer) 'radio-target 'identity)))
  1304. ;; Radio targets with objects.
  1305. (should
  1306. (org-test-with-temp-text "<<<radio \\alpha>>>"
  1307. (org-element-map (org-element-parse-buffer) 'radio-target 'identity))))
  1308. ;;;; Section
  1309. (ert-deftest test-org-element/section-parser ()
  1310. "Test `section' parser."
  1311. ;; Standard test.
  1312. (should
  1313. (org-test-with-temp-text "* Headline\nText"
  1314. (org-element-map (org-element-parse-buffer) 'section 'identity)))
  1315. ;; There's a section before the first headline.
  1316. (should
  1317. (org-test-with-temp-text "Text"
  1318. (org-element-map (org-element-parse-buffer) 'section 'identity)))
  1319. ;; A section cannot be empty.
  1320. (should-not
  1321. (org-test-with-temp-text "* Headline 1\n* Headline 2"
  1322. (org-element-map (org-element-parse-buffer) 'section 'identity)))
  1323. ;; A section doesn't contain sub-trees.
  1324. (should-not
  1325. (org-test-with-temp-text "* Head\nText\n** Sub-Head"
  1326. (org-element-map
  1327. (org-element-map (org-element-parse-buffer) 'section 'identity nil t)
  1328. 'headline 'identity))))
  1329. ;;;; Special Block
  1330. (ert-deftest test-org-element/special-block-parser ()
  1331. "Test `special-block' parser."
  1332. ;; Standard test.
  1333. (let ((special-block
  1334. (org-test-with-temp-text "#+BEGIN_SPECIAL\nText\n#+END_SPECIAL"
  1335. (org-element-map
  1336. (org-element-parse-buffer) 'special-block 'identity nil t))))
  1337. (should (equal (org-element-property :type special-block) "SPECIAL"))
  1338. (should (org-element-map special-block 'paragraph 'identity)))
  1339. ;; Test folded block.
  1340. (org-test-with-temp-text "#+BEGIN_SPECIAL\nText\n#+END_SPECIAL"
  1341. (org-cycle)
  1342. (should
  1343. (org-element-property
  1344. :hiddenp
  1345. (org-element-map
  1346. (org-element-parse-buffer) 'special-block 'identity nil t))))
  1347. ;; Ignore incomplete block.
  1348. (should-not
  1349. (org-test-with-temp-text "#+BEGIN_SPECIAL"
  1350. (org-element-map
  1351. (org-element-parse-buffer) 'special-block 'identity nil t))))
  1352. ;;;; Src Block
  1353. (ert-deftest test-org-element/src-block-parser ()
  1354. "Test `src-block' parser."
  1355. ;; Regular tests.
  1356. (should
  1357. (org-test-with-temp-text "#+BEGIN_SRC\nText\n#+END_SRC"
  1358. (org-element-map (org-element-parse-buffer) 'src-block 'identity)))
  1359. ;; Test folded block.
  1360. (org-test-with-temp-text "#+BEGIN_SRC\nText\n#+END_SRC"
  1361. (org-cycle)
  1362. (should
  1363. (org-element-property
  1364. :hiddenp
  1365. (org-element-map
  1366. (org-element-parse-buffer) 'src-block 'identity nil t))))
  1367. ;; Ignore incomplete block.
  1368. (should-not
  1369. (org-test-with-temp-text "#+BEGIN_SRC"
  1370. (org-element-map (org-element-parse-buffer) 'src-block 'identity))))
  1371. ;;;; Statistics Cookie
  1372. (ert-deftest test-org-element/statistics-cookie ()
  1373. "Test `statistics-cookie' parser."
  1374. ;; With numbers.
  1375. (should
  1376. (org-test-with-temp-text "[1/2]"
  1377. (org-element-map (org-element-parse-buffer) 'statistics-cookie 'identity)))
  1378. ;; With percents.
  1379. (should
  1380. (org-test-with-temp-text "[33%]"
  1381. (org-element-map
  1382. (org-element-parse-buffer) 'statistics-cookie 'identity))))
  1383. ;;;; Strike Through
  1384. (ert-deftest test-org-element/strike-through-parser ()
  1385. "Test `strike-through' parser."
  1386. ;; Regular test.
  1387. (should
  1388. (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^ \n,\"']\\|[^ \n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^ \n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
  1389. (org-test-with-temp-text "+strike-through+"
  1390. (org-element-map (org-element-parse-buffer) 'strike-through 'identity))))
  1391. ;; Multi-line markup.
  1392. (should
  1393. (equal
  1394. (org-element-contents
  1395. (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^ \n,\"']\\|[^ \n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^ \n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
  1396. (org-test-with-temp-text "+first line\nsecond line+"
  1397. (org-element-map
  1398. (org-element-parse-buffer) 'strike-through 'identity nil t))))
  1399. '("first line\nsecond line"))))
  1400. ;;;; Subscript
  1401. (ert-deftest test-org-element/subscript-parser ()
  1402. "Test `subscript' parser."
  1403. ;; Without braces.
  1404. (should
  1405. (org-test-with-temp-text "a_b"
  1406. (org-element-map (org-element-parse-buffer) 'subscript 'identity)))
  1407. ;; With braces.
  1408. (should
  1409. (org-test-with-temp-text "a_{b}"
  1410. (org-element-map (org-element-parse-buffer) 'subscript 'identity))))
  1411. ;;;; Superscript
  1412. (ert-deftest test-org-element/superscript-parser ()
  1413. "Test `superscript' parser."
  1414. ;; Without braces.
  1415. (should
  1416. (org-test-with-temp-text "a^b"
  1417. (org-element-map (org-element-parse-buffer) 'superscript 'identity)))
  1418. ;; With braces.
  1419. (should
  1420. (org-test-with-temp-text "a^{b}"
  1421. (org-element-map (org-element-parse-buffer) 'superscript 'identity))))
  1422. ;;;; Table
  1423. (ert-deftest test-org-element/table-parser ()
  1424. "Test `table' parser."
  1425. (should
  1426. (org-test-with-temp-text "| a |"
  1427. (org-element-map (org-element-parse-buffer) 'table 'identity)))
  1428. ;; TBLFM keyword is case insensitive.
  1429. (should
  1430. (org-test-with-temp-text "| a |\n#+tblfm: test"
  1431. (org-element-property
  1432. :tblfm
  1433. (org-element-map (org-element-parse-buffer) 'table 'identity nil t))))
  1434. ;; Handle multiple TBLFM lines.
  1435. (should
  1436. (= 2
  1437. (org-test-with-temp-text "| a |\n#+TBLFM: test1\n#+TBLFM: test2"
  1438. (length (org-element-property
  1439. :tblfm
  1440. (org-element-map
  1441. (org-element-parse-buffer) 'table 'identity nil t)))))))
  1442. ;;;; Table Cell
  1443. (ert-deftest test-org-element/table-cell-parser ()
  1444. "Test `table-cell' parser."
  1445. (should
  1446. (org-test-with-temp-text "| a |"
  1447. (org-element-map (org-element-parse-buffer) 'table-cell 'identity))))
  1448. ;;;; Table Row
  1449. (ert-deftest test-org-element/table-row-parser ()
  1450. "Test `table-row' parser."
  1451. (should
  1452. (equal '(standard rule)
  1453. (org-test-with-temp-text "| a |\n|---|"
  1454. (org-element-map
  1455. (org-element-parse-buffer) 'table-row
  1456. (lambda (row) (org-element-property :type row)))))))
  1457. ;;;; Target
  1458. (ert-deftest test-org-element/target-parser ()
  1459. "Test `target' parser."
  1460. (should
  1461. (org-test-with-temp-text "<<target>>"
  1462. (org-element-map (org-element-parse-buffer) 'target 'identity))))
  1463. ;;;; Timestamp
  1464. (ert-deftest test-org-element/timestamp ()
  1465. "Test `timestamp' parser."
  1466. ;; Active timestamp.
  1467. (should
  1468. (org-test-with-temp-text "<2012-03-29 16:40>"
  1469. (eq (org-element-property :type
  1470. (org-element-map
  1471. (org-element-parse-buffer)
  1472. 'timestamp 'identity nil t))
  1473. 'active)))
  1474. ;; Inactive timestamp.
  1475. (should
  1476. (org-test-with-temp-text "[2012-03-29 16:40]"
  1477. (eq (org-element-property :type
  1478. (org-element-map
  1479. (org-element-parse-buffer)
  1480. 'timestamp 'identity nil t))
  1481. 'inactive)))
  1482. ;; Date range.
  1483. (should
  1484. (org-test-with-temp-text "[2012-03-29 16:40]--[2012-03-29 16:41]"
  1485. (eq (org-element-property :type
  1486. (org-element-map
  1487. (org-element-parse-buffer)
  1488. 'timestamp 'identity nil t))
  1489. 'inactive-range)))
  1490. ;; Timestamps are not planning elements.
  1491. (should-not
  1492. (org-test-with-temp-text "SCHEDULED: <2012-03-29 16:40>"
  1493. (org-element-map (org-element-parse-buffer) 'timestamp 'identity))))
  1494. ;;;; Underline
  1495. (ert-deftest test-org-element/underline-parser ()
  1496. "Test `underline' parser."
  1497. ;; Regular test.
  1498. (should
  1499. (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^ \n,\"']\\|[^ \n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^ \n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
  1500. (org-test-with-temp-text "_underline_"
  1501. (org-element-map (org-element-parse-buffer) 'underline 'identity))))
  1502. ;; Multi-line markup.
  1503. (should
  1504. (equal
  1505. (org-element-contents
  1506. (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^ \n,\"']\\|[^ \n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^ \n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
  1507. (org-test-with-temp-text "_first line\nsecond line_"
  1508. (org-element-map
  1509. (org-element-parse-buffer) 'underline 'identity nil t))))
  1510. '("first line\nsecond line"))))
  1511. ;;;; Verbatim
  1512. (ert-deftest test-org-element/verbatim-parser ()
  1513. "Test `verbatim' parser."
  1514. ;; Regular test.
  1515. (should
  1516. (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^ \n,\"']\\|[^ \n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^ \n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
  1517. (org-test-with-temp-text "=verbatim="
  1518. (org-element-map (org-element-parse-buffer) 'verbatim 'identity))))
  1519. ;; Multi-line markup.
  1520. (should
  1521. (equal
  1522. (org-element-property
  1523. :value
  1524. (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^ \n,\"']\\|[^ \n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^ \n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
  1525. (org-test-with-temp-text "=first line\nsecond line="
  1526. (org-element-map
  1527. (org-element-parse-buffer) 'verbatim 'identity nil t))))
  1528. "first line\nsecond line")))
  1529. ;;;; Verse Block
  1530. (ert-deftest test-org-element/verse-block-parser ()
  1531. "Test `verse-block' parser."
  1532. ;; Standard test.
  1533. (org-test-with-temp-text "#+BEGIN_VERSE\nVerse block\n#+END_VERSE"
  1534. (should
  1535. (org-element-map (org-element-parse-buffer) 'verse-block 'identity)))
  1536. ;; Ignore case.
  1537. (org-test-with-temp-text "#+begin_verse\nVerse block\n#+end_verse"
  1538. (should
  1539. (org-element-map (org-element-parse-buffer) 'verse-block 'identity)))
  1540. ;; Parse folding.
  1541. (org-test-with-temp-text "#+BEGIN_VERSE\nVerse block\n#+END_VERSE"
  1542. (org-hide-block-all)
  1543. (should
  1544. (org-element-property
  1545. :hiddenp
  1546. (org-element-map
  1547. (org-element-parse-buffer) 'verse-block 'identity nil t))))
  1548. ;; Parse objects in verse blocks.
  1549. (org-test-with-temp-text "#+BEGIN_VERSE\nVerse \\alpha\n#+END_VERSE"
  1550. (should (org-element-map (org-element-parse-buffer) 'entity 'identity)))
  1551. ;; Ignore incomplete verse block.
  1552. (should-not
  1553. (org-test-with-temp-text "#+BEGIN_VERSE"
  1554. (org-element-map
  1555. (org-element-parse-buffer) 'verse-block 'identity nil t))))
  1556. ;;; Test Interpreters.
  1557. (ert-deftest test-org-element/affiliated-keywords-interpreter ()
  1558. "Test if affiliated keywords are correctly interpreted."
  1559. ;; Interpret simple keywords.
  1560. (should
  1561. (equal
  1562. (org-element-interpret-data
  1563. '(org-data nil (paragraph (:name "para") "Paragraph")))
  1564. "#+NAME: para\nParagraph\n"))
  1565. ;; Interpret multiple keywords.
  1566. (should
  1567. (equal
  1568. (org-element-interpret-data
  1569. '(org-data nil (paragraph (:attr_ascii ("line2" "line1")) "Paragraph")))
  1570. "#+ATTR_ASCII: line1\n#+ATTR_ASCII: line2\nParagraph\n"))
  1571. ;; Interpret parsed keywords.
  1572. (should
  1573. (equal
  1574. (org-element-interpret-data
  1575. '(org-data nil (paragraph (:caption (("caption"))) "Paragraph")))
  1576. "#+CAPTION: caption\nParagraph\n"))
  1577. ;; Interpret dual keywords.
  1578. (should
  1579. (equal
  1580. (org-element-interpret-data
  1581. '(org-data nil (paragraph (:caption ((("long") "short"))) "Paragraph")))
  1582. "#+CAPTION[short]: long\nParagraph\n"))
  1583. ;; Interpret multiple parsed dual keywords.
  1584. (should
  1585. (equal
  1586. (org-element-interpret-data
  1587. '(org-data nil (paragraph
  1588. (:caption ((("l2") "s2") (("l1") "s1"))) "Paragraph")))
  1589. "#+CAPTION[s1]: l1\n#+CAPTION[s2]: l2\nParagraph\n")))
  1590. (ert-deftest test-org-element/center-block-interpreter ()
  1591. "Test center block interpreter."
  1592. (should
  1593. (equal (org-test-parse-and-interpret "#+BEGIN_CENTER\nTest\n#+END_CENTER")
  1594. "#+BEGIN_CENTER\nTest\n#+END_CENTER\n")))
  1595. (ert-deftest test-org-element/drawer-interpreter ()
  1596. "Test drawer interpreter."
  1597. (should
  1598. (equal (let ((org-drawers '("TEST")))
  1599. (org-test-parse-and-interpret ":TEST:\nTest\n:END:"))
  1600. ":TEST:\nTest\n:END:\n")))
  1601. (ert-deftest test-org-element/dynamic-block-interpreter ()
  1602. "Test dynamic block interpreter."
  1603. (should
  1604. (equal (org-test-parse-and-interpret
  1605. "#+BEGIN: myblock :parameter value1\nTest\n#+END:")
  1606. "#+BEGIN: myblock :parameter value1\nTest\n#+END:\n")))
  1607. (ert-deftest test-org-element/footnote-definition-interpreter ()
  1608. "Test footnote definition interpreter."
  1609. (should (equal (org-test-parse-and-interpret "[fn:1] Test") "[fn:1] Test\n")))
  1610. (ert-deftest test-org-element/headline-interpreter ()
  1611. "Test headline and section interpreters."
  1612. ;; 1. Standard test.
  1613. (should (equal (org-test-parse-and-interpret "* Headline") "* Headline\n"))
  1614. ;; 2. With TODO keywords.
  1615. (should
  1616. (equal (let ((org-todo-keywords '((sequence "TODO" "DONE"))))
  1617. (org-test-parse-and-interpret "* TODO Headline"))
  1618. "* TODO Headline\n"))
  1619. ;; 3. With tags...
  1620. ;;
  1621. ;; 3.1. ... and a positive `org-tags-column' value.
  1622. (should
  1623. (equal (let ((org-tags-column 20))
  1624. (org-test-parse-and-interpret "* Headline :tag:"))
  1625. "* Headline :tag:\n"))
  1626. ;; 3.2. ... and a negative `org-tags-column' value.
  1627. (should
  1628. (equal (let ((org-tags-column -20))
  1629. (org-test-parse-and-interpret "* Headline :tag:"))
  1630. "* Headline :tag:\n"))
  1631. ;; 3.3. ... and a null `org-tags-column' value.
  1632. (should
  1633. (equal (let ((org-tags-column 0))
  1634. (org-test-parse-and-interpret "* Headline :tag:"))
  1635. "* Headline :tag:\n"))
  1636. ;; 4. With priority cookie.
  1637. (should
  1638. (equal (org-test-parse-and-interpret "* [#B] Headline")
  1639. "* [#B] Headline\n"))
  1640. ;; 5. With comment keyword.
  1641. (should
  1642. (equal (let ((org-comment-string "COMMENT"))
  1643. (org-test-parse-and-interpret "* COMMENT Headline"))
  1644. "* COMMENT Headline\n"))
  1645. ;; 6. With quote section.
  1646. (should
  1647. (equal (let ((org-quote-string "QUOTE"))
  1648. (org-test-parse-and-interpret "* QUOTE Headline"))
  1649. "* QUOTE Headline\n"))
  1650. ;; 7. Keep same number of blank lines before body.
  1651. (should
  1652. (equal (org-test-parse-and-interpret
  1653. "* Headline\n\n\nText after two blank lines.")
  1654. "* Headline\n\n\nText after two blank lines.\n")))
  1655. (ert-deftest test-org-element/inlinetask-interpreter ()
  1656. "Test inlinetask interpretation."
  1657. (when (featurep 'org-inlinetask)
  1658. (let ((org-inlinetask-min-level 15))
  1659. ;; 1. Regular inlinetask.
  1660. (should (equal (org-test-parse-and-interpret
  1661. "*************** Task\nTest\n*************** END")
  1662. "*************** Task\nTest\n*************** END\n"))
  1663. ;; 2. Degenerate inlinetask.
  1664. (should (equal (org-test-parse-and-interpret "*************** Task")
  1665. "*************** Task\n"))
  1666. ;; 3. Prefer degenerate form when there are no contents.
  1667. (should (equal (org-test-parse-and-interpret
  1668. "*************** Task\n*************** END")
  1669. "*************** Task\n"))
  1670. ;; 4. With TODO keywords.
  1671. (should
  1672. (equal (let ((org-todo-keywords '((sequence "TODO" "DONE"))))
  1673. (org-test-parse-and-interpret "*************** TODO Task"))
  1674. "*************** TODO Task\n"))
  1675. ;; 5. With tags...
  1676. ;;
  1677. ;; 5.1. ... and a positive `org-tags-column' value.
  1678. (should
  1679. (equal (let ((org-tags-column 30))
  1680. (org-test-parse-and-interpret "*************** Task :tag:"))
  1681. "*************** Task :tag:\n"))
  1682. ;; 5.2. ... and a negative `org-tags-column' value.
  1683. (should
  1684. (equal (let ((org-tags-column -30))
  1685. (org-test-parse-and-interpret "*************** Task :tag:"))
  1686. "*************** Task :tag:\n"))
  1687. ;; 5.3. ... and a null `org-tags-column' value.
  1688. (should
  1689. (equal (let ((org-tags-column 0))
  1690. (org-test-parse-and-interpret "*************** Task :tag:"))
  1691. "*************** Task :tag:\n"))
  1692. ;; 6. With priority cookie.
  1693. (should
  1694. (equal (org-test-parse-and-interpret "*************** [#B] Task")
  1695. "*************** [#B] Task\n")))))
  1696. (ert-deftest test-org-element/plain-list-interpreter ()
  1697. "Test plain-list and item interpreters."
  1698. (let ((org-list-two-spaces-after-bullet-regexp nil))
  1699. ;; 1. Unordered list.
  1700. (should (equal (org-test-parse-and-interpret "- item 1") "- item 1\n"))
  1701. ;; 2. Description list.
  1702. (should
  1703. (equal (org-test-parse-and-interpret "- tag :: desc") "- tag :: desc\n"))
  1704. ;; 3. Ordered list.
  1705. (should
  1706. (equal (let ((org-plain-list-ordered-item-terminator t))
  1707. (org-test-parse-and-interpret "1. Item"))
  1708. "1. Item\n"))
  1709. ;; 4. Ordered list with counter.
  1710. (should
  1711. (equal (let ((org-plain-list-ordered-item-terminator t))
  1712. (org-test-parse-and-interpret "1. [@5] Item"))
  1713. "5. [@5] Item\n"))
  1714. ;; 5. List with check-boxes.
  1715. (should
  1716. (equal (org-test-parse-and-interpret
  1717. "- [-] Item 1\n - [X] Item 2\n - [ ] Item 3")
  1718. "- [-] Item 1\n - [X] Item 2\n - [ ] Item 3\n"))
  1719. ;; 6. Item not starting with a paragraph.
  1720. (should
  1721. (equal (org-test-parse-and-interpret "-\n | a | b |")
  1722. "- \n | a | b |\n"))))
  1723. (ert-deftest test-org-element/quote-block-interpreter ()
  1724. "Test quote block interpreter."
  1725. (should (equal (org-test-parse-and-interpret
  1726. "#+BEGIN_QUOTE\nTest\n#+END_QUOTE")
  1727. "#+BEGIN_QUOTE\nTest\n#+END_QUOTE\n")))
  1728. (ert-deftest test-org-element/special-block-interpreter ()
  1729. "Test special block interpreter."
  1730. (should (equal (org-test-parse-and-interpret
  1731. "#+BEGIN_SPECIAL\nTest\n#+END_SPECIAL")
  1732. "#+BEGIN_SPECIAL\nTest\n#+END_SPECIAL\n")))
  1733. (ert-deftest test-org-element/babel-call-interpreter ()
  1734. "Test babel call interpreter."
  1735. ;; 1. Without argument.
  1736. (should (equal (org-test-parse-and-interpret "#+CALL: test()")
  1737. "#+CALL: test()\n"))
  1738. ;; 2. With argument.
  1739. (should (equal (org-test-parse-and-interpret "#+CALL: test(x=2)")
  1740. "#+CALL: test(x=2)\n"))
  1741. ;; 3. With header arguments.
  1742. (should (equal (org-test-parse-and-interpret
  1743. "#+CALL: test[:results output]()[:results html]")
  1744. "#+CALL: test[:results output]()[:results html]\n")))
  1745. (ert-deftest test-org-element/clock-interpreter ()
  1746. "Test clock interpreter."
  1747. ;; Running clock.
  1748. (should
  1749. (equal (let ((org-clock-string "CLOCK:"))
  1750. (org-test-parse-and-interpret "CLOCK: [2012-01-01 sun. 00:01]"))
  1751. "CLOCK: [2012-01-01 sun. 00:01]\n"))
  1752. ;; Closed clock.
  1753. (should
  1754. (equal
  1755. (let ((org-clock-string "CLOCK:"))
  1756. (org-test-parse-and-interpret "
  1757. CLOCK: [2012-01-01 sun. 00:01]--[2012-01-01 sun. 00:02] => 0:01"))
  1758. "CLOCK: [2012-01-01 sun. 00:01]--[2012-01-01 sun. 00:02] => 0:01\n")))
  1759. (ert-deftest test-org-element/comment-interpreter ()
  1760. "Test comment interpreter."
  1761. ;; Regular comment.
  1762. (should (equal (org-test-parse-and-interpret "# Comment") "# Comment\n"))
  1763. ;; Inline comment.
  1764. (should (equal (org-test-parse-and-interpret " # Comment")
  1765. "# Comment\n"))
  1766. ;; Preserve indentation.
  1767. (should (equal (org-test-parse-and-interpret " # No blank\n# One blank")
  1768. "# No blank\n# One blank\n")))
  1769. (ert-deftest test-org-element/comment-block-interpreter ()
  1770. "Test comment block interpreter."
  1771. (should (equal (org-test-parse-and-interpret
  1772. "#+BEGIN_COMMENT\nTest\n#+END_COMMENT")
  1773. "#+BEGIN_COMMENT\nTest\n#+END_COMMENT\n")))
  1774. (ert-deftest test-org-element/example-block-interpreter ()
  1775. "Test example block interpreter."
  1776. ;; Without switches.
  1777. (should (equal (org-test-parse-and-interpret
  1778. "#+BEGIN_EXAMPLE\nTest\n#+END_EXAMPLE")
  1779. "#+BEGIN_EXAMPLE\nTest\n#+END_EXAMPLE\n"))
  1780. ;; With switches.
  1781. (should
  1782. (equal (org-test-parse-and-interpret
  1783. "#+BEGIN_EXAMPLE -n -k\n(+ 1 1)\n#+END_EXAMPLE")
  1784. "#+BEGIN_EXAMPLE -n -k\n(+ 1 1)\n#+END_EXAMPLE\n")))
  1785. (ert-deftest test-org-element/export-block-interpreter ()
  1786. "Test export block interpreter."
  1787. (should (equal (org-test-parse-and-interpret
  1788. "#+BEGIN_HTML\nTest\n#+END_HTML")
  1789. "#+BEGIN_HTML\nTest\n#+END_HTML\n")))
  1790. (ert-deftest test-org-element/fixed-width-interpreter ()
  1791. "Test fixed width interpreter."
  1792. ;; Standard test.
  1793. (should (equal (org-test-parse-and-interpret ": Test") ": Test\n"))
  1794. ;; Preserve indentation.
  1795. (should (equal (org-test-parse-and-interpret ": 2 blanks\n: 1 blank")
  1796. ": 2 blanks\n: 1 blank\n")))
  1797. (ert-deftest test-org-element/horizontal-rule-interpreter ()
  1798. "Test horizontal rule interpreter."
  1799. (should (equal (org-test-parse-and-interpret "-------") "-----\n")))
  1800. (ert-deftest test-org-element/keyword-interpreter ()
  1801. "Test keyword interpreter."
  1802. (should (equal (org-test-parse-and-interpret "#+KEYWORD: value")
  1803. "#+KEYWORD: value\n")))
  1804. (ert-deftest test-org-element/latex-environment-interpreter ()
  1805. "Test latex environment interpreter."
  1806. (should (equal (org-test-parse-and-interpret
  1807. "\\begin{equation}\n1+1=2\n\\end{equation}")
  1808. "\\begin{equation}\n1+1=2\n\\end{equation}\n")))
  1809. (ert-deftest test-org-element/planning-interpreter ()
  1810. "Test planning interpreter."
  1811. (let ((org-closed-string "CLOSED:")
  1812. (org-deadline-string "DEADLINE:")
  1813. (org-scheduled-string "SCHEDULED:"))
  1814. (should
  1815. (equal
  1816. (org-test-parse-and-interpret
  1817. "* Headline
  1818. CLOSED: [2012-01-01] DEADLINE: <2012-01-01> SCHEDULED: <2012-01-01>")
  1819. "* Headline
  1820. CLOSED: [2012-01-01] DEADLINE: <2012-01-01> SCHEDULED: <2012-01-01>\n"))))
  1821. (ert-deftest test-org-element/property-drawer-interpreter ()
  1822. "Test property drawer interpreter."
  1823. (should (equal (let ((org-property-format "%-10s %s"))
  1824. (org-test-parse-and-interpret
  1825. ":PROPERTIES:\n:prop: value\n:END:"))
  1826. ":PROPERTIES:\n:prop: value\n:END:\n")))
  1827. (ert-deftest test-org-element/src-block-interpreter ()
  1828. "Test src block interpreter."
  1829. ;; With arguments.
  1830. (should
  1831. (equal (let ((org-edit-src-content-indentation 2))
  1832. (org-test-parse-and-interpret
  1833. "#+BEGIN_SRC emacs-lisp :results silent\n(+ 1 1)\n#+END_SRC"))
  1834. "#+BEGIN_SRC emacs-lisp :results silent\n (+ 1 1)\n#+END_SRC\n"))
  1835. ;; With switches.
  1836. (should
  1837. (equal (let ((org-edit-src-content-indentation 2))
  1838. (org-test-parse-and-interpret
  1839. "#+BEGIN_SRC emacs-lisp -n -k\n(+ 1 1)\n#+END_SRC"))
  1840. "#+BEGIN_SRC emacs-lisp -n -k\n (+ 1 1)\n#+END_SRC\n")))
  1841. (ert-deftest test-org-element/table-interpreter ()
  1842. "Test table, table-row and table-cell interpreters."
  1843. ;; 1. Simple table.
  1844. (should (equal (org-test-parse-and-interpret "| a | b |\n| c | d |")
  1845. "| a | b |\n| c | d |\n"))
  1846. ;; 2. With horizontal rules.
  1847. (should (equal (org-test-parse-and-interpret
  1848. "| a | b |\n|---+---|\n| c | d |")
  1849. "| a | b |\n|---+---|\n| c | d |\n"))
  1850. ;; 3. With meta-data.
  1851. (should (equal (org-test-parse-and-interpret "| / | < | > |\n| * | 1 | 2 |")
  1852. "| / | < | > |\n| * | 1 | 2 |\n"))
  1853. ;; 4. With a formula.
  1854. (should
  1855. (equal (org-test-parse-and-interpret
  1856. "| 2 |\n| 4 |\n| 3 |\n#+TBLFM: @3=vmean(@1..@2)")
  1857. "| 2 |\n| 4 |\n| 3 |\n#+TBLFM: @3=vmean(@1..@2)\n"))
  1858. ;; 5. With multiple formulas.
  1859. (should
  1860. (equal (org-test-parse-and-interpret
  1861. "| 2 |\n| 4 |\n| 3 |\n#+TBLFM: test1\n#+TBLFM: test2")
  1862. "| 2 |\n| 4 |\n| 3 |\n#+TBLFM: test1\n#+TBLFM: test2\n")))
  1863. (ert-deftest test-org-element/timestamp-interpreter ()
  1864. "Test timestamp interpreter."
  1865. ;; Active.
  1866. (should (equal (org-test-parse-and-interpret "<2012-03-29 16:40>")
  1867. "<2012-03-29 16:40>\n"))
  1868. ;; Inactive.
  1869. (should (equal (org-test-parse-and-interpret "[2012-03-29 16:40]")
  1870. "[2012-03-29 16:40]\n"))
  1871. ;; Active range.
  1872. (should (equal (org-test-parse-and-interpret
  1873. "<2012-03-29 16:40>--<2012-03-29 16:41>")
  1874. "<2012-03-29 16:40>--<2012-03-29 16:41>\n"))
  1875. ;; Inactive range.
  1876. (should (equal (org-test-parse-and-interpret
  1877. "[2012-03-29 16:40]--[2012-03-29 16:41]")
  1878. "[2012-03-29 16:40]--[2012-03-29 16:41]\n"))
  1879. ;; Diary.
  1880. (should (equal (org-test-parse-and-interpret "<%%org-float t 4 2>")
  1881. "<%%org-float t 4 2>\n"))
  1882. ;; Timestamp with repeater interval.
  1883. (should (equal (org-test-parse-and-interpret "<2012-03-29 +1y>")
  1884. "<2012-03-29 +1y>\n")))
  1885. (ert-deftest test-org-element/verse-block-interpreter ()
  1886. "Test verse block interpretation."
  1887. (should
  1888. (equal (org-test-parse-and-interpret "#+BEGIN_VERSE\nTest\n#+END_VERSE")
  1889. "#+BEGIN_VERSE\nTest\n#+END_VERSE\n")))
  1890. (ert-deftest test-org-element/bold-interpreter ()
  1891. "Test bold interpreter."
  1892. (should (equal (org-test-parse-and-interpret "*text*") "*text*\n")))
  1893. (ert-deftest test-org-element/code-interpreter ()
  1894. "Test code interpreter."
  1895. (should (equal (org-test-parse-and-interpret "~text~") "~text~\n")))
  1896. (ert-deftest test-org-element/entity-interpreter ()
  1897. "Test entity interpreter."
  1898. ;; 1. Without brackets.
  1899. (should
  1900. (equal (org-test-parse-and-interpret "\\alpha text") "\\alpha text\n"))
  1901. ;; 2. With brackets.
  1902. (should
  1903. (equal (org-test-parse-and-interpret "\\alpha{}text") "\\alpha{}text\n")))
  1904. (ert-deftest test-org-element/export-snippet-interpreter ()
  1905. "Test export snippet interpreter."
  1906. (should (equal (org-test-parse-and-interpret "@@back-end:contents@@")
  1907. "@@back-end:contents@@\n")))
  1908. (ert-deftest test-org-element/footnote-reference-interpreter ()
  1909. "Test footnote reference interpreter."
  1910. ;; 1. Regular reference.
  1911. (should (equal (org-test-parse-and-interpret "Text[fn:1]") "Text[fn:1]\n"))
  1912. ;; 2. Normalized reference.
  1913. (should (equal (org-test-parse-and-interpret "Text[1]") "Text[1]\n"))
  1914. ;; 3. Named reference.
  1915. (should (equal (org-test-parse-and-interpret "Text[fn:label]")
  1916. "Text[fn:label]\n"))
  1917. ;; 4. Inline reference.
  1918. (should (equal (org-test-parse-and-interpret "Text[fn:label:def]")
  1919. "Text[fn:label:def]\n"))
  1920. ;; 5. Anonymous reference.
  1921. (should (equal (org-test-parse-and-interpret "Text[fn::def]")
  1922. "Text[fn::def]\n")))
  1923. (ert-deftest test-org-element/inline-babel-call-interpreter ()
  1924. "Test inline babel call interpreter."
  1925. ;; 1. Without arguments.
  1926. (should (equal (org-test-parse-and-interpret "call_test()") "call_test()\n"))
  1927. ;; 2. With arguments.
  1928. (should (equal (org-test-parse-and-interpret "call_test(x=2)")
  1929. "call_test(x=2)\n"))
  1930. ;; 3. With header arguments.
  1931. (should (equal (org-test-parse-and-interpret
  1932. "call_test[:results output]()[:results html]")
  1933. "call_test[:results output]()[:results html]\n")))
  1934. (ert-deftest test-org-element/inline-src-block-interpreter ()
  1935. "Test inline src block interpreter."
  1936. ;; 1. Without header argument.
  1937. (should (equal (org-test-parse-and-interpret "src_emacs-lisp{(+ 1 1)}")
  1938. "src_emacs-lisp{(+ 1 1)}\n"))
  1939. ;; 2. With header arguments.
  1940. (should (equal (org-test-parse-and-interpret
  1941. "src_emacs-lisp[:results silent]{(+ 1 1)}")
  1942. "src_emacs-lisp[:results silent]{(+ 1 1)}\n")))
  1943. (ert-deftest test-org-element/italic-interpreter ()
  1944. "Test italic interpreter."
  1945. (should (equal (org-test-parse-and-interpret "/text/") "/text/\n")))
  1946. (ert-deftest test-org-element/latex-fragment-interpreter ()
  1947. "Test latex fragment interpreter."
  1948. (let ((org-latex-regexps
  1949. '(("begin" "^[ ]*\\(\\\\begin{\\([a-zA-Z0-9\\*]+\\)[^�]+?\\\\end{\\2}\\)" 1 t)
  1950. ("$1" "\\([^$]\\|^\\)\\(\\$[^ \n,;.$]\\$\\)\\([- .,?;:'\")�]\\|$\\)" 2 nil)
  1951. ("$" "\\([^$]\\|^\\)\\(\\(\\$\\([^ \n,;.$][^$\n ]*?\\(\n[^$\n ]*?\\)\\{0,2\\}[^ \n,.$]\\)\\$\\)\\)\\([- .,?;:'\")�]\\|$\\)" 2 nil)
  1952. ("\\(" "\\\\([^�]*?\\\\)" 0 nil)
  1953. ("\\[" "\\\\\\[[^�]*?\\\\\\]" 0 nil)
  1954. ("$$" "\\$\\$[^�]*?\\$\\$" 0 nil))))
  1955. (should (equal (org-test-parse-and-interpret "\\command{}")
  1956. "\\command{}\n"))
  1957. (should (equal (org-test-parse-and-interpret "$x$") "$x$\n"))
  1958. (should (equal (org-test-parse-and-interpret "$x+y$") "$x+y$\n"))
  1959. (should (equal (org-test-parse-and-interpret "$$x+y$$") "$$x+y$$\n"))
  1960. (should (equal (org-test-parse-and-interpret "\\(x+y\\)") "\\(x+y\\)\n"))
  1961. (should (equal (org-test-parse-and-interpret "\\[x+y\\]") "\\[x+y\\]\n"))))
  1962. (ert-deftest test-org-element/line-break-interpreter ()
  1963. "Test line break interpreter."
  1964. (should (equal (org-test-parse-and-interpret "First line \\\\ \nSecond line")
  1965. "First line \\\\\nSecond line\n")))
  1966. (ert-deftest test-org-element/link-interpreter ()
  1967. "Test link interpreter."
  1968. ;; 1. Links targeted from a radio target.
  1969. (should (equal (let ((org-target-link-regexp "radio-target"))
  1970. (org-test-parse-and-interpret "a radio-target"))
  1971. "a radio-target\n"))
  1972. ;; 2. Regular links.
  1973. ;;
  1974. ;; 2.1. Without description.
  1975. (should (equal (org-test-parse-and-interpret "[[http://orgmode.org]]")
  1976. "[[http://orgmode.org]]\n"))
  1977. ;; 2.2. With a description.
  1978. (should (equal (org-test-parse-and-interpret
  1979. "[[http://orgmode.org][Org mode]]")
  1980. "[[http://orgmode.org][Org mode]]\n"))
  1981. ;; 2.3. Id links.
  1982. (should (equal (org-test-parse-and-interpret "[[id:aaaa]]") "[[id:aaaa]]\n"))
  1983. ;; 2.4. Custom-id links.
  1984. (should (equal (org-test-parse-and-interpret "[[#id]]") "[[#id]]\n"))
  1985. ;; 2.5 Code-ref links.
  1986. (should (equal (org-test-parse-and-interpret "[[(ref)]]") "[[(ref)]]\n"))
  1987. ;; 3. Normalize plain links.
  1988. (should (equal (org-test-parse-and-interpret "http://orgmode.org")
  1989. "[[http://orgmode.org]]\n"))
  1990. ;; 4. Normalize angular links.
  1991. (should (equal (org-test-parse-and-interpret "<http://orgmode.org>")
  1992. "[[http://orgmode.org]]\n")))
  1993. (ert-deftest test-org-element/macro-interpreter ()
  1994. "Test macro interpreter."
  1995. ;; 1. Without argument.
  1996. (should (equal (org-test-parse-and-interpret "{{{test}}}") "{{{test}}}\n"))
  1997. ;; 2. With arguments.
  1998. (should (equal (org-test-parse-and-interpret "{{{test(arg1,arg2)}}}")
  1999. "{{{test(arg1,arg2)}}}\n")))
  2000. (ert-deftest test-org-element/radio-target-interpreter ()
  2001. "Test radio target interpreter."
  2002. (should (equal (org-test-parse-and-interpret "<<<some text>>>")
  2003. "<<<some text>>>\n")))
  2004. (ert-deftest test-org-element/statistics-cookie-interpreter ()
  2005. "Test statistics cookie interpreter."
  2006. ;; 1. Without percent
  2007. (should (equal (org-test-parse-and-interpret "[0/1]") "[0/1]\n"))
  2008. ;; 2. With percent.
  2009. (should (equal (org-test-parse-and-interpret "[66%]") "[66%]\n")))
  2010. (ert-deftest test-org-element/strike-through-interpreter ()
  2011. "Test strike through interpreter."
  2012. (should (equal (org-test-parse-and-interpret "+target+") "+target+\n")))
  2013. (ert-deftest test-org-element/subscript-interpreter ()
  2014. "Test subscript interpreter."
  2015. ;; 1. Without brackets.
  2016. (should (equal (org-test-parse-and-interpret "a_b") "a_b\n"))
  2017. ;; 2. With brackets.
  2018. (should (equal (org-test-parse-and-interpret "a_{b}") "a_{b}\n")))
  2019. (ert-deftest test-org-element/superscript-interpreter ()
  2020. "Test superscript interpreter."
  2021. ;; 1. Without brackets.
  2022. (should (equal (org-test-parse-and-interpret "a^b") "a^b\n"))
  2023. ;; 2. With brackets.
  2024. (should (equal (org-test-parse-and-interpret "a^{b}") "a^{b}\n")))
  2025. (ert-deftest test-org-element/target-interpreter ()
  2026. "Test target interpreter."
  2027. (should (equal (org-test-parse-and-interpret "<<target>>") "<<target>>\n")))
  2028. (ert-deftest test-org-element/underline-interpreter ()
  2029. "Test underline interpreter."
  2030. (should (equal (org-test-parse-and-interpret "_text_") "_text_\n")))
  2031. (ert-deftest test-org-element/verbatim-interpreter ()
  2032. "Test verbatim interpreter."
  2033. (should (equal (org-test-parse-and-interpret "=text=") "=text=\n")))
  2034. ;;; Test Granularity
  2035. (ert-deftest test-org-element/granularity ()
  2036. "Test granularity impact on buffer parsing."
  2037. (org-test-with-temp-text "
  2038. * Head 1
  2039. ** Head 2
  2040. #+BEGIN_CENTER
  2041. Centered paragraph.
  2042. #+END_CENTER
  2043. Paragraph \\alpha."
  2044. ;; 1.1. Granularity set to `headline' should parse every headline
  2045. ;; in buffer, and only them.
  2046. (let ((tree (org-element-parse-buffer 'headline)))
  2047. (should (= 2 (length (org-element-map tree 'headline 'identity))))
  2048. (should-not (org-element-map tree 'paragraph 'identity)))
  2049. ;; 1.2. Granularity set to `greater-element' should not enter
  2050. ;; greater elements excepted headlines and sections.
  2051. (let ((tree (org-element-parse-buffer 'greater-element)))
  2052. (should (= 1 (length (org-element-map tree 'center-block 'identity))))
  2053. (should (= 1 (length (org-element-map tree 'paragraph 'identity))))
  2054. (should-not (org-element-map tree 'entity 'identity)))
  2055. ;; 1.3. Granularity set to `element' should enter every
  2056. ;; greater-element.
  2057. (let ((tree (org-element-parse-buffer 'element)))
  2058. (should (= 2 (length (org-element-map tree 'paragraph 'identity))))
  2059. (should-not (org-element-map tree 'entity 'identity)))
  2060. ;; 1.4. Granularity set to `object' can see everything.
  2061. (let ((tree (org-element-parse-buffer 'object)))
  2062. (should (= 1 (length (org-element-map tree 'entity 'identity)))))))
  2063. (ert-deftest test-org-element/secondary-string-parsing ()
  2064. "Test if granularity correctly toggles secondary strings parsing."
  2065. ;; 1. With a granularity bigger than `object', no secondary string
  2066. ;; should be parsed.
  2067. ;;
  2068. ;; 1.1. Test with `headline' type.
  2069. (org-test-with-temp-text "* Headline"
  2070. (let ((headline
  2071. (org-element-map (org-element-parse-buffer 'headline) 'headline
  2072. 'identity
  2073. nil
  2074. 'first-match)))
  2075. (should (stringp (org-element-property :title headline)))))
  2076. ;; 1.2. Test with `item' type.
  2077. (org-test-with-temp-text "* Headline\n- tag :: item"
  2078. (let ((item (org-element-map (org-element-parse-buffer 'element)
  2079. 'item
  2080. 'identity
  2081. nil
  2082. 'first-match)))
  2083. (should (stringp (org-element-property :tag item)))))
  2084. ;; 1.3. Test with `inlinetask' type, if avalaible.
  2085. (when (featurep 'org-inlinetask)
  2086. (let ((org-inlinetask-min-level 15))
  2087. (org-test-with-temp-text "*************** Inlinetask"
  2088. (let ((inlinetask (org-element-map (org-element-parse-buffer 'element)
  2089. 'inlinetask
  2090. 'identity
  2091. nil
  2092. 'first-match)))
  2093. (should (stringp (org-element-property :title inlinetask)))))))
  2094. ;; 2. With a default granularity, secondary strings should be
  2095. ;; parsed.
  2096. (org-test-with-temp-text "* Headline"
  2097. (let ((headline
  2098. (org-element-map (org-element-parse-buffer) 'headline
  2099. 'identity
  2100. nil
  2101. 'first-match)))
  2102. (should (listp (org-element-property :title headline)))))
  2103. ;; 3. `org-element-at-point' should never parse a secondary string.
  2104. (org-test-with-temp-text "* Headline"
  2105. (should (stringp (org-element-property :title (org-element-at-point))))))
  2106. ;;; Test `:parent' Property
  2107. (ert-deftest test-org-element/parent-property ()
  2108. "Test `:parent' property."
  2109. ;; Elements.
  2110. (org-test-with-temp-text "#+BEGIN_CENTER\nText\n#+END_CENTER"
  2111. (let* ((tree (org-element-parse-buffer))
  2112. (parent (org-element-property
  2113. :parent
  2114. (org-element-map tree 'paragraph 'identity nil t))))
  2115. (should parent)
  2116. (should (eq (org-element-map tree 'center-block 'identity nil t)
  2117. parent))))
  2118. ;; Objects.
  2119. (org-test-with-temp-text "a_{/b/}"
  2120. (let* ((tree (org-element-parse-buffer))
  2121. (parent (org-element-property
  2122. :parent
  2123. (org-element-map tree 'italic 'identity nil t))))
  2124. (should parent)
  2125. (should (eq parent
  2126. (org-element-map tree 'subscript 'identity nil t)))))
  2127. ;; Secondary strings
  2128. (org-test-with-temp-text "* /italic/"
  2129. (let* ((tree (org-element-parse-buffer))
  2130. (parent (org-element-property
  2131. :parent (org-element-map tree 'italic 'identity nil t))))
  2132. (should parent)
  2133. (should (eq parent
  2134. (org-element-map tree 'headline 'identity nil t))))))
  2135. ;;; Test Normalize Contents
  2136. (ert-deftest test-org-element/normalize-contents ()
  2137. "Test `org-element-normalize-contents' specifications."
  2138. ;; 1. Remove maximum common indentation from element's contents.
  2139. (should
  2140. (equal
  2141. (org-element-normalize-contents
  2142. '(paragraph nil " Two spaces\n Three spaces"))
  2143. '(paragraph nil "Two spaces\n Three spaces")))
  2144. ;; 2. Ignore objects within contents when computing maximum common
  2145. ;; indentation.
  2146. (should
  2147. (equal
  2148. (org-element-normalize-contents
  2149. '(paragraph nil " One " (emphasis nil "space") "\n Two spaces"))
  2150. '(paragraph nil "One " (emphasis nil "space") "\n Two spaces")))
  2151. ;; 3. Ignore blank lines.
  2152. (should
  2153. (equal
  2154. (org-element-normalize-contents
  2155. '(paragraph nil " Two spaces\n\n \n Two spaces"))
  2156. '(paragraph nil "Two spaces\n\n \nTwo spaces")))
  2157. ;; 4. Recursively enter objects in order to compute common
  2158. ;; indentation.
  2159. (should
  2160. (equal
  2161. (org-element-normalize-contents
  2162. '(paragraph nil " Two spaces " (bold nil " and\n One space")))
  2163. '(paragraph nil " Two spaces " (bold nil " and\nOne space"))))
  2164. ;; 5. When optional argument is provided, ignore first line
  2165. ;; indentation.
  2166. (should
  2167. (equal
  2168. (org-element-normalize-contents
  2169. '(paragraph nil "No space\n Two spaces\n Three spaces") t)
  2170. '(paragraph nil "No space\nTwo spaces\n Three spaces"))))
  2171. ;;; Test Navigation Tools.
  2172. (ert-deftest test-org-element/at-point ()
  2173. "Test `org-element-at-point' specifications."
  2174. ;; Return closest element containing point.
  2175. (should
  2176. (eq 'paragraph
  2177. (org-test-with-temp-text "#+BEGIN_CENTER\nA\n#+END_CENTER"
  2178. (progn (search-forward "A")
  2179. (org-element-type (org-element-at-point))))))
  2180. ;; Correctly set `:parent' property.
  2181. (should
  2182. (eq 'center-block
  2183. (org-test-with-temp-text "#+BEGIN_CENTER\nA\n#+END_CENTER"
  2184. (progn (search-forward "A")
  2185. (org-element-type
  2186. (org-element-property :parent (org-element-at-point)))))))
  2187. ;; Special case: at the very beginning of a table, return `table'
  2188. ;; object instead of `table-row'.
  2189. (should
  2190. (eq 'table
  2191. (org-test-with-temp-text "| a | b |"
  2192. (org-element-type (org-element-at-point)))))
  2193. ;; Special case: at the very beginning of a list or sub-list, return
  2194. ;; `plain-list' object instead of `item'.
  2195. (should
  2196. (eq 'plain-list
  2197. (org-test-with-temp-text "- item"
  2198. (org-element-type (org-element-at-point)))))
  2199. ;; Special case: at the closing line of a greater element, be sure
  2200. ;; to return it instead of the last element in its contents.
  2201. (should
  2202. (eq 'center-block
  2203. (org-test-with-temp-text "#+BEGIN_CENTER\nParagraph\n#+END_CENTER"
  2204. (progn (forward-line 2)
  2205. (org-element-type (org-element-at-point))))))
  2206. ;; Special case: at a blank line between two items, be sure to
  2207. ;; return item above instead of the last element of its contents.
  2208. (should
  2209. (eq 'item
  2210. (org-test-with-temp-text "- Para1\n\n- Para2"
  2211. (progn (forward-line)
  2212. (org-element-type
  2213. (let ((org-empty-line-terminates-plain-lists nil))
  2214. (org-element-at-point)))))))
  2215. ;; Special case: at the last blank line in a plain list, return it
  2216. ;; instead of the last item.
  2217. (should
  2218. (eq 'plain-list
  2219. (org-test-with-temp-text "- Para1\n- Para2\n\nPara3"
  2220. (progn (forward-line 2)
  2221. (org-element-type (org-element-at-point))))))
  2222. ;; With an optional argument, return trail.
  2223. (should
  2224. (equal '(paragraph center-block)
  2225. (org-test-with-temp-text "#+BEGIN_CENTER\nA\n#+END_CENTER\nZ"
  2226. (progn (search-forward "Z")
  2227. (mapcar 'org-element-type (org-element-at-point t)))))))
  2228. (ert-deftest test-org-element/context ()
  2229. "Test `org-element-context' specifications."
  2230. ;; Return closest object containing point.
  2231. (should
  2232. (eq 'underline
  2233. (org-test-with-temp-text "Some *text with _underline_ text*"
  2234. (progn (search-forward "under")
  2235. (org-element-type (org-element-context))))))
  2236. ;; Find objects in secondary strings.
  2237. (should
  2238. (eq 'underline
  2239. (org-test-with-temp-text "* Headline _with_ underlining"
  2240. (progn (search-forward "w")
  2241. (org-element-type (org-element-context))))))
  2242. ;; Correctly set `:parent' property.
  2243. (should
  2244. (eq 'paragraph
  2245. (org-test-with-temp-text "Some *bold* text"
  2246. (progn (search-forward "bold")
  2247. (org-element-type
  2248. (org-element-property :parent (org-element-context))))))))
  2249. (provide 'test-org-element)
  2250. ;;; test-org-element.el ends here