test-org-element.el 82 KB

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