test-org-list.el 42 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447
  1. ;;; test-org-list.el --- Tests for org-list.el
  2. ;; Copyright (C) 2012, 2013, 2014, 2018, 2019 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. ;;; Code:
  15. (ert-deftest test-org-list/list-ending ()
  16. "Test if lists end at the right place."
  17. ;; With two blank lines.
  18. (org-test-with-temp-text "- item\n\n\n Text"
  19. (goto-line 4)
  20. (should-not (org-in-item-p)))
  21. ;; With text less indented than top items.
  22. (org-test-with-temp-text "- item\nText"
  23. (goto-line 2)
  24. (should-not (org-in-item-p)))
  25. ;; Though, blank lines and text indentation is ignored in blocks.
  26. (org-test-with-temp-text
  27. "- item\n #+begin_quote\n\n\nText at column 0\n #+end_quote\n Text"
  28. (goto-line 7)
  29. (should (org-in-item-p))))
  30. (ert-deftest test-org-list/list-navigation ()
  31. "Test list navigation specifications."
  32. (org-test-with-temp-text "
  33. - item A
  34. - item B
  35. - item 1
  36. - item 1.1
  37. - item 1.2
  38. - item 1.3
  39. - item 2
  40. - item X
  41. - item Y"
  42. (let ((org-list-use-circular-motion nil))
  43. ;; 1. Test `org-next-item'.
  44. ;;
  45. ;; 1.1. Should return an error if at last item in
  46. ;; a list/sub-list, unless `org-list-use-circular-motion'
  47. ;; is non-nil.
  48. (goto-line 9)
  49. (should-error (org-next-item))
  50. (let ((org-list-use-circular-motion t))
  51. (should (progn (org-next-item) t)))
  52. (goto-line 14)
  53. (should-error (org-next-item))
  54. (let ((org-list-use-circular-motion t))
  55. (should (progn (org-next-item) t)))
  56. ;; 1.2. Should jump over sub-lists.
  57. (goto-line 6)
  58. (org-next-item)
  59. (should (looking-at "- item 2"))
  60. ;; 1.3. Shouldn't move to another list.
  61. (goto-line 3)
  62. (should-error (org-next-item))
  63. (should-not (looking-at "- item 1"))
  64. ;; 1.4. Should move to the list/sub-list first item when
  65. ;; `org-list-use-circular-motion' is non-nil.
  66. (let ((org-list-use-circular-motion t))
  67. (goto-line 10)
  68. (org-next-item)
  69. (should (looking-at "- item 1"))
  70. (goto-line 9)
  71. (org-next-item)
  72. (should (looking-at " - item 1.1")))
  73. ;; 2. Test `org-previous-item'.
  74. ;;
  75. ;; 2.1. Should return an error if at first item in
  76. ;; a list/sub-list, unless `org-list-use-circular-motion is
  77. ;; non-nil.
  78. (goto-line 7)
  79. (should-error (org-previous-item))
  80. (let ((org-list-use-circular-motion t))
  81. (should (progn (org-previous-item) t)))
  82. (goto-line 13)
  83. (should-error (org-previous-item))
  84. (let ((org-list-use-circular-motion t))
  85. (should (progn (org-previous-item) t)))
  86. ;; 2.2. Should ignore sub-lists.
  87. (goto-line 10)
  88. (org-previous-item)
  89. (should (looking-at "- item 1"))
  90. ;; 2.3. Shouldn't move to another list.
  91. (goto-line 6)
  92. (should-error (org-previous-item))
  93. (should-not (looking-at "- item B"))
  94. ;; 2.4. Should move to the list/sub-list last item when
  95. ;; `org-list-use-circular-motion' is non-nil.
  96. (let ((org-list-use-circular-motion t))
  97. (goto-line 6)
  98. (org-previous-item)
  99. (should (looking-at "- item 2"))
  100. (goto-line 7)
  101. (org-previous-item)
  102. (should (looking-at " - item 1.3"))))))
  103. (ert-deftest test-org-list/cycle-bullet ()
  104. "Test `org-cycle-list-bullet' specifications."
  105. ;; Error when not at an item.
  106. (should-error
  107. (org-test-with-temp-text "Paragraph"
  108. (org-cycle-list-bullet)))
  109. ;; Cycle through "-", "+", "*", "1.", "1)".
  110. (org-test-with-temp-text " - item"
  111. (org-cycle-list-bullet)
  112. (should (looking-at "[ \t]+\\+"))
  113. (org-cycle-list-bullet)
  114. (should (looking-at "[ \t]+\\*"))
  115. (let ((org-plain-list-ordered-item-terminator t))
  116. (org-cycle-list-bullet))
  117. (should (looking-at "[ \t]+1\\."))
  118. (let ((org-plain-list-ordered-item-terminator t))
  119. (org-cycle-list-bullet))
  120. (should (looking-at "[ \t]+1)")))
  121. ;; Argument is a valid bullet: cycle to that bullet directly.
  122. (should
  123. (equal "1. item"
  124. (org-test-with-temp-text "- item"
  125. (let ((org-plain-list-ordered-item-terminator t))
  126. (org-cycle-list-bullet "1.")
  127. (buffer-string)))))
  128. ;; Argument is an integer N: cycle to the Nth allowed bullet.
  129. (should
  130. (equal "+ item"
  131. (org-test-with-temp-text "1. item"
  132. (let ((org-plain-list-ordered-item-terminator t))
  133. (org-cycle-list-bullet 1)
  134. (buffer-string)))))
  135. ;; Argument is `previous': cycle backwards.
  136. (should
  137. (equal "- item"
  138. (org-test-with-temp-text "+ item"
  139. (let ((org-plain-list-ordered-item-terminator t))
  140. (org-cycle-list-bullet 'previous)
  141. (buffer-string)))))
  142. ;; Do not cycle to "*" bullets when item is at column 0.
  143. (should
  144. (equal "1. item"
  145. (org-test-with-temp-text "+ item"
  146. (let ((org-plain-list-ordered-item-terminator t))
  147. (org-cycle-list-bullet)
  148. (buffer-string)))))
  149. ;; Do not cycle to numbered bullets in a description list.
  150. (should-not
  151. (equal "1. tag :: item"
  152. (org-test-with-temp-text "+ tag :: item"
  153. (let ((org-plain-list-ordered-item-terminator t))
  154. (org-cycle-list-bullet)
  155. (buffer-string)))))
  156. ;; Do not cycle to ordered item terminators if they are not allowed
  157. ;; in `org-plain-list-ordered-item-terminator'.
  158. (should
  159. (equal " 1) item"
  160. (org-test-with-temp-text " * item"
  161. (let ((org-plain-list-ordered-item-terminator 41))
  162. (org-cycle-list-bullet)
  163. (buffer-string)))))
  164. ;; When `org-list-allow-alphabetical' is non-nil, cycle to alpha bullets.
  165. (should
  166. (equal "a. item"
  167. (org-test-with-temp-text "1) item"
  168. (let ((org-plain-list-ordered-item-terminator t)
  169. (org-list-allow-alphabetical t))
  170. (org-cycle-list-bullet)
  171. (buffer-string)))))
  172. ;; Do not cycle to alpha bullets when list has more than 26
  173. ;; elements.
  174. (should-not
  175. (equal "a. item 1"
  176. (org-test-with-temp-text "1) item 1
  177. 2) item 2
  178. 3) item 3
  179. 4) item 4
  180. 5) item 5
  181. 6) item 6
  182. 7) item 7
  183. 8) item 8
  184. 9) item 9
  185. 10) item 10
  186. 11) item 11
  187. 12) item 12
  188. 13) item 13
  189. 14) item 14
  190. 15) item 15
  191. 16) item 16
  192. 17) item 17
  193. 18) item 18
  194. 19) item 19
  195. 20) item 20
  196. 21) item 21
  197. 22) item 22
  198. 23) item 23
  199. 24) item 24
  200. 25) item 25
  201. 26) item 26
  202. 27) item 27"
  203. (let ((org-plain-list-ordered-item-terminator t)
  204. (org-list-allow-alphabetical t))
  205. (org-cycle-list-bullet)
  206. (buffer-substring (point) (line-end-position)))))))
  207. (ert-deftest test-org-list/indent-item ()
  208. "Test `org-indent-item' specifications."
  209. ;; Error when not at an item.
  210. (org-test-with-temp-text "Paragraph."
  211. (should-error (org-indent-item)))
  212. ;; Error when trying to move first item of a list.
  213. (should-error
  214. (org-test-with-temp-text "
  215. - Item 1
  216. - Item 2"
  217. (forward-line)
  218. (org-indent-item)))
  219. (should-error
  220. (org-test-with-temp-text "
  221. - Item 1
  222. - Item 2"
  223. (forward-line)
  224. (let ((org-list-automatic-rules nil)) (org-indent-item))))
  225. ;; Indent a single item, not its children.
  226. (should
  227. (equal "
  228. - Item 1
  229. - Item 2
  230. - Item 2.1"
  231. (org-test-with-temp-text "
  232. - Item 1
  233. - Item 2<point>
  234. - Item 2.1"
  235. (let (org-list-demote-modify-bullet) (org-indent-item))
  236. (buffer-string))))
  237. ;; Follow `org-list-demote-modify-bullet' specifications.
  238. (should
  239. (equal "
  240. - Item 1
  241. + Item 2"
  242. (org-test-with-temp-text "
  243. - Item 1
  244. - Item 2<point>"
  245. (let ((org-list-demote-modify-bullet '(("-" . "+"))))
  246. (org-indent-item))
  247. (buffer-string))))
  248. (should
  249. (equal "
  250. 1. Item 1
  251. + Item 2"
  252. (org-test-with-temp-text "
  253. 1. Item 1
  254. 2. Item 2<point>"
  255. (let ((org-plain-list-ordered-item-terminator t)
  256. (org-list-demote-modify-bullet '(("1." . "+"))))
  257. (org-indent-item))
  258. (buffer-string))))
  259. (should
  260. (equal "
  261. a. Item 1
  262. - Item 2"
  263. (org-test-with-temp-text "
  264. a. Item 1
  265. b. Item 2<point>"
  266. (let ((org-plain-list-ordered-item-terminator t)
  267. (org-list-allow-alphabetical t)
  268. (org-list-demote-modify-bullet '(("A." . "a.") ("a." . "-"))))
  269. (org-indent-item))
  270. (buffer-string))))
  271. ;; When a region is selected, indent every item within.
  272. (should
  273. (equal "
  274. - Item 1
  275. - Item 2
  276. - Item 3
  277. "
  278. (org-test-with-temp-text "
  279. - Item 1
  280. <point>- Item 2
  281. - Item 3
  282. "
  283. (transient-mark-mode 1)
  284. (push-mark (point) t t)
  285. (goto-char (point-max))
  286. (let (org-list-demote-modify-bullet) (org-indent-item))
  287. (buffer-string)))))
  288. (ert-deftest test-org-list/indent-item-tree ()
  289. "Test `org-indent-item-tree' specifications."
  290. ;; 1. Error when not at an item.
  291. (org-test-with-temp-text "Paragraph."
  292. (should-error (org-indent-item-tree)))
  293. ;; 2. Indent item along with its children.
  294. (org-test-with-temp-text "
  295. - Item 1
  296. - Item 2
  297. - Item 2.1"
  298. (search-forward "- Item 2")
  299. (let (org-list-demote-modify-bullet) (org-indent-item-tree))
  300. (should (equal (buffer-string)
  301. "
  302. - Item 1
  303. - Item 2
  304. - Item 2.1")))
  305. ;; 3. Special case: When indenting top item, move the whole list.
  306. (org-test-with-temp-text "
  307. - Item 1
  308. - Item 2"
  309. (search-forward "- Item 1")
  310. (let (org-list-demote-modify-bullet org-odd-levels-only)
  311. (org-indent-item-tree))
  312. (should (equal (buffer-string)
  313. "
  314. - Item 1
  315. - Item 2")))
  316. ;; 4. Follow `org-list-demote-modify-bullet' specifications.
  317. ;;
  318. ;; 4.1. With unordered lists.
  319. (org-test-with-temp-text "
  320. - Item 1
  321. - Item 2
  322. + Item 2.1"
  323. (search-forward "- Item 2")
  324. (let ((org-list-demote-modify-bullet '(("-" . "+") ("+" . "-"))))
  325. (org-indent-item-tree))
  326. (should (equal (buffer-string)
  327. "
  328. - Item 1
  329. + Item 2
  330. - Item 2.1")))
  331. ;; 4.2. and ordered lists.
  332. (org-test-with-temp-text "
  333. 1. Item 1
  334. 2. Item 2
  335. + Item 2.1"
  336. (search-forward "2. Item 2")
  337. (let ((org-plain-list-ordered-item-terminator t)
  338. (org-list-demote-modify-bullet '(("1." . "+") ("+" . "1."))))
  339. (org-indent-item-tree))
  340. (should (equal (buffer-string)
  341. "
  342. 1. Item 1
  343. + Item 2
  344. 1. Item 2.1")))
  345. ;; 5. When a region is selected, indent every item within.
  346. (org-test-with-temp-text "
  347. - Item 1
  348. - Item 2
  349. - Item 2.1
  350. - Item 3
  351. - Item 3.1
  352. "
  353. (search-forward "- Item 2")
  354. (beginning-of-line)
  355. (transient-mark-mode 1)
  356. (push-mark (point) t t)
  357. (goto-char (point-max))
  358. (let (org-list-demote-modify-bullet) (org-indent-item-tree))
  359. (should (equal (buffer-string)
  360. "
  361. - Item 1
  362. - Item 2
  363. - Item 2.1
  364. - Item 3
  365. - Item 3.1
  366. "))))
  367. (ert-deftest test-org-list/outdent-item ()
  368. "Test `org-outdent-item' specifications."
  369. ;; 1. Error when not at an item.
  370. (org-test-with-temp-text "Paragraph."
  371. (should-error (org-outdent-item)))
  372. ;; 2. Error when trying to move first item of a list.
  373. (org-test-with-temp-text "
  374. - Item 1
  375. - Item 2"
  376. (forward-line)
  377. (should-error (org-outdent-item)))
  378. ;; 3. Error when trying to outdent an item without its children.
  379. (org-test-with-temp-text "
  380. - Item 1
  381. - Item 1.1
  382. - Item 1.1.1"
  383. (search-forward "- Item 1.1")
  384. (should-error (org-outdent-item)))
  385. ;; 4. Error when trying to outdent before top item.
  386. (org-test-with-temp-text "
  387. - Item 1
  388. - Item 2"
  389. (search-forward "- Item 2")
  390. (should-error (org-outdent-item)))
  391. ;; 5. When a region is selected, outdent every item within.
  392. (org-test-with-temp-text "
  393. - Item 1
  394. - Item 2
  395. - Item 3
  396. "
  397. (search-forward "- Item 2")
  398. (beginning-of-line)
  399. (transient-mark-mode 1)
  400. (push-mark (point) t t)
  401. (goto-char (point-max))
  402. (let (org-list-demote-modify-bullet) (org-outdent-item))
  403. (should (equal (buffer-string)
  404. "
  405. - Item 1
  406. - Item 2
  407. - Item 3
  408. "))))
  409. (ert-deftest test-org-list/outdent-item-tree ()
  410. "Test `org-outdent-item-tree' specifications."
  411. ;; 1. Error when not at an item.
  412. (org-test-with-temp-text "Paragraph."
  413. (should-error (org-outdent-item-tree)))
  414. ;; 2. Error when trying to outdent before top item.
  415. (org-test-with-temp-text "
  416. - Item 1
  417. - Item 2"
  418. (search-forward "- Item 2")
  419. (should-error (org-outdent-item-tree)))
  420. ;; 3. Outdent item along with its children.
  421. (org-test-with-temp-text "
  422. - Item 1
  423. - Item 2
  424. - Item 2.1"
  425. (search-forward "- Item 2")
  426. (org-outdent-item-tree)
  427. (should (equal (buffer-string)
  428. "
  429. - Item 1
  430. - Item 2
  431. - Item 2.1")))
  432. ;; 3. Special case: When outdenting top item, move the whole list.
  433. (org-test-with-temp-text "
  434. - Item 1
  435. - Item 2"
  436. (search-forward "- Item 1")
  437. (let (org-odd-levels-only) (org-outdent-item-tree))
  438. (should (equal (buffer-string)
  439. "
  440. - Item 1
  441. - Item 2")))
  442. ;; 5. When a region is selected, outdent every item within.
  443. (org-test-with-temp-text "
  444. - Item 1
  445. - Item 2
  446. - Item 2.1
  447. - Item 3
  448. - Item 3.1
  449. "
  450. (search-forward "- Item 2")
  451. (beginning-of-line)
  452. (transient-mark-mode 1)
  453. (push-mark (point) t t)
  454. (goto-char (point-max))
  455. (org-outdent-item-tree)
  456. (should (equal (buffer-string)
  457. "
  458. - Item 1
  459. - Item 2
  460. - Item 2.1
  461. - Item 3
  462. - Item 3.1
  463. "))))
  464. (ert-deftest test-org-list/move-item-down ()
  465. "Test `org-move-item-down' specifications."
  466. ;; Standard test.
  467. (org-test-with-temp-text "- item 1\n- item 2"
  468. (org-move-item-down)
  469. (should (equal (buffer-string)
  470. "- item 2\n- item 1")))
  471. ;; Keep same column in item.
  472. (org-test-with-temp-text "- item 1\n- item 2"
  473. (forward-char 4)
  474. (org-move-item-down)
  475. (should (looking-at "em 1")))
  476. ;; Move sub-items.
  477. (org-test-with-temp-text "- item 1\n - sub-item 1\n- item 2"
  478. (org-move-item-down)
  479. (should (equal (buffer-string)
  480. "- item 2\n- item 1\n - sub-item 1")))
  481. ;; Preserve blank lines.
  482. (should
  483. (equal
  484. "- item 2\n\n- item 1"
  485. (org-test-with-temp-text "- item 1\n\n- item 2"
  486. (org-move-item-down)
  487. (buffer-string))))
  488. ;; Error when trying to move the last item...
  489. (org-test-with-temp-text "- item 1\n- item 2"
  490. (forward-line)
  491. (should-error (org-move-item-down)))
  492. ;; ... unless `org-list-use-circular-motion' is non-nil. In this
  493. ;; case, move to the first item.
  494. (org-test-with-temp-text "- item 1\n- item 2\n- item 3"
  495. (forward-line 2)
  496. (let ((org-list-use-circular-motion t)) (org-move-item-down))
  497. (should (equal (buffer-string) "- item 3\n- item 1\n- item 2\n")))
  498. ;; Preserve item visibility.
  499. (org-test-with-temp-text "* Headline\n- item 1\n body 1\n- item 2\n body 2"
  500. (let ((org-cycle-include-plain-lists t))
  501. (search-forward "- item 1")
  502. (org-cycle)
  503. (search-forward "- item 2")
  504. (org-cycle))
  505. (search-backward "- item 1")
  506. (org-move-item-down)
  507. (forward-line)
  508. (should (org-invisible-p2))
  509. (search-backward " body 2")
  510. (should (org-invisible-p2)))
  511. ;; Preserve children visibility.
  512. (org-test-with-temp-text "* Headline
  513. - item 1
  514. - sub-item 1
  515. sub-body 1
  516. - item 2
  517. - sub-item 2
  518. sub-body 2"
  519. (let ((org-cycle-include-plain-lists t))
  520. (search-forward "- sub-item 1")
  521. (org-cycle)
  522. (search-forward "- sub-item 2")
  523. (org-cycle))
  524. (search-backward "- item 1")
  525. (org-move-item-down)
  526. (search-forward "sub-body 1")
  527. (should (org-invisible-p2))
  528. (search-backward "sub-body 2")
  529. (should (org-invisible-p2))))
  530. (ert-deftest test-org-list/move-item-down-contents-visibility ()
  531. "Preserve contents visibility."
  532. (org-test-with-temp-text "
  533. - item 1
  534. #+BEGIN_CENTER
  535. Text1
  536. #+END_CENTER
  537. - item 2
  538. #+BEGIN_CENTER
  539. Text2
  540. #+END_CENTER"
  541. (org-hide-block-all)
  542. (let ((invisible-property-1
  543. (progn
  544. (search-forward "Text1")
  545. (get-char-property (point) 'invisible)))
  546. (invisible-property-2
  547. (progn
  548. (search-forward "Text2")
  549. (get-char-property (point) 'invisible))))
  550. (goto-char (point-min))
  551. (search-forward "- item 1")
  552. (org-move-item-down)
  553. (search-forward "Text1")
  554. (should (eq invisible-property-1 (get-char-property (point) 'invisible)))
  555. (search-backward "Text2")
  556. (should (eq invisible-property-2 (get-char-property (point) 'invisible))))))
  557. (ert-deftest test-org-list/move-item-up ()
  558. "Test `org-move-item-up' specifications."
  559. ;; Standard test.
  560. (org-test-with-temp-text "- item 1\n- item 2"
  561. (forward-line)
  562. (org-move-item-up)
  563. (should (equal (buffer-string)
  564. "- item 2\n- item 1")))
  565. ;; Keep same column in item.
  566. (org-test-with-temp-text "- item 1\n- item 2"
  567. (forward-line)
  568. (forward-char 4)
  569. (org-move-item-up)
  570. (should (looking-at "em 2")))
  571. ;; Move sub-items.
  572. (org-test-with-temp-text "- item 1\n- item 2\n - sub-item 2"
  573. (forward-line)
  574. (org-move-item-up)
  575. (should (equal (buffer-string)
  576. "- item 2\n - sub-item 2\n- item 1")))
  577. ;; Preserve blank lines.
  578. (should
  579. (equal
  580. "- item 2\n\n- item 1"
  581. (org-test-with-temp-text "- item 1\n\n- item 2"
  582. (search-forward "- item 2")
  583. (org-move-item-up)
  584. (buffer-string))))
  585. ;; Error when trying to move the first item...
  586. (org-test-with-temp-text "- item 1\n- item 2"
  587. (should-error (org-move-item-up)))
  588. ;; ... unless `org-list-use-circular-motion' is non-nil. In this
  589. ;; case, move to the first item.
  590. (should
  591. (equal "- item 2\n- item 3\n- item 1"
  592. (org-test-with-temp-text "- item 1\n- item 2\n- item 3"
  593. (let ((org-list-use-circular-motion t)) (org-move-item-up))
  594. (buffer-string))))
  595. ;; Preserve item visibility.
  596. (org-test-with-temp-text "* Headline\n- item 1\n body 1\n- item 2\n body 2"
  597. (let ((org-cycle-include-plain-lists t))
  598. (search-forward "- item 1")
  599. (org-cycle)
  600. (search-forward "- item 2")
  601. (org-cycle))
  602. (org-move-item-up)
  603. (forward-line)
  604. (should (org-invisible-p2))
  605. (search-forward " body 1")
  606. (should (org-invisible-p2)))
  607. ;; Preserve children visibility.
  608. (org-test-with-temp-text "* Headline
  609. - item 1
  610. - sub-item 1
  611. sub-body 1
  612. - item 2
  613. - sub-item 2
  614. sub-body 2"
  615. (let ((org-cycle-include-plain-lists t))
  616. (search-forward "- sub-item 1")
  617. (org-cycle)
  618. (search-forward "- sub-item 2")
  619. (org-cycle))
  620. (search-backward "- item 2")
  621. (org-move-item-up)
  622. (search-forward "sub-body 2")
  623. (should (org-invisible-p2))
  624. (search-forward "sub-body 1")
  625. (should (org-invisible-p2))))
  626. (ert-deftest test-org-list/move-item-up-contents-visibility ()
  627. (org-test-with-temp-text "
  628. - item 1
  629. #+BEGIN_CENTER
  630. Text1
  631. #+END_CENTER
  632. - item 2
  633. #+BEGIN_CENTER
  634. Text2
  635. #+END_CENTER"
  636. (org-hide-block-all)
  637. (let ((invisible-property-1
  638. (progn
  639. (search-forward "Text1")
  640. (get-char-property (point) 'invisible)))
  641. (invisible-property-2
  642. (progn
  643. (search-forward "Text2")
  644. (get-char-property (point) 'invisible))))
  645. (goto-char (point-min))
  646. (search-forward "- item 2")
  647. (org-move-item-up)
  648. (search-forward "Text2")
  649. (should (eq invisible-property-2 (get-char-property (point) 'invisible)))
  650. (search-forward "Text1")
  651. (should (eq invisible-property-1 (get-char-property (point) 'invisible))))))
  652. (ert-deftest test-org-list/insert-item ()
  653. "Test item insertion."
  654. ;; Blank lines specifications.
  655. ;;
  656. ;; Non-nil `org-blank-before-new-entry': insert a blank line.
  657. (should
  658. (org-test-with-temp-text "- a"
  659. (let ((org-blank-before-new-entry '((plain-list-item . t))))
  660. (end-of-line)
  661. (org-insert-item)
  662. (forward-line -1)
  663. (looking-at "$"))))
  664. ;; Nil `org-blank-before-new-entry': do not insert a blank line.
  665. (should-not
  666. (org-test-with-temp-text "- a"
  667. (let ((org-blank-before-new-entry '((plain-list-item . nil))))
  668. (end-of-line)
  669. (org-insert-item)
  670. (forward-line -1)
  671. (looking-at "$"))))
  672. ;; `org-blank-before-new-entry' set to auto: if there's no blank
  673. ;; line already in the sole item, do not insert one.
  674. (should-not
  675. (org-test-with-temp-text "- a"
  676. (let ((org-blank-before-new-entry '((plain-list-item . auto))))
  677. (end-of-line)
  678. (org-insert-item)
  679. (forward-line -1)
  680. (looking-at "$"))))
  681. ;; `org-blank-before-new-entry' set to `auto': if there's a blank
  682. ;; line in the sole item, insert another one.
  683. (should
  684. (org-test-with-temp-text "- a\n\n b<point>"
  685. (let ((org-blank-before-new-entry '((plain-list-item . auto))))
  686. (org-insert-item)
  687. (forward-line -1)
  688. (looking-at "$"))))
  689. ;; `org-blank-before-new-entry' set to `auto': if the user specified
  690. ;; a blank line, preserve it.
  691. (should
  692. (org-test-with-temp-text "- a\n\n<point>"
  693. (let ((org-blank-before-new-entry '((plain-list-item . auto))))
  694. (org-insert-item)
  695. (forward-line -1)
  696. (looking-at "$"))))
  697. ;; `org-blank-before-new-entry' set to `auto': if some items in list
  698. ;; are already separated by blank lines, insert one.
  699. (should
  700. (org-test-with-temp-text "- a\n\n- b<point>"
  701. (let ((org-blank-before-new-entry '((plain-list-item . auto))))
  702. (org-insert-item)
  703. (forward-line -1)
  704. (looking-at "$"))))
  705. (should
  706. (org-test-with-temp-text "- a\n\n- b"
  707. (let ((org-blank-before-new-entry '((plain-list-item . auto))))
  708. (org-insert-item)
  709. (forward-line)
  710. (looking-at "$"))))
  711. (should
  712. (org-test-with-temp-text
  713. "- a\n #+BEGIN_EXAMPLE\n\n x\n #+END_EXAMPLE<point>"
  714. (let ((org-blank-before-new-entry '((plain-list-item . auto))))
  715. (org-insert-item)
  716. (forward-line -1)
  717. (looking-at "$"))))
  718. ;; When called before or on the bullet, insert new item before
  719. ;; current one.
  720. (should
  721. (equal "- \n- item"
  722. (org-test-with-temp-text "- item"
  723. (org-insert-item)
  724. (buffer-string))))
  725. (should
  726. (equal "- \n- item"
  727. (org-test-with-temp-text "- <point>item"
  728. (org-insert-item)
  729. (buffer-string))))
  730. ;; When called on tag in a descriptive list, insert new item before
  731. ;; current one too.
  732. (should
  733. (equal "- :: \n- tag :: item"
  734. (org-test-with-temp-text "- tag <point>:: item"
  735. (org-insert-item)
  736. (buffer-string))))
  737. (should
  738. (equal "- :: \n- tag :: item"
  739. (org-test-with-temp-text "- ta<point>g :: item"
  740. (org-insert-item)
  741. (buffer-string))))
  742. ;; Further, it splits the line or add a blank new item after it,
  743. ;; according to `org-M-RET-may-split-line'.
  744. (should
  745. (equal "- it\n- em"
  746. (org-test-with-temp-text "- it<point>em"
  747. (let ((org-M-RET-may-split-line '((default . t))))
  748. (org-insert-item))
  749. (buffer-string))))
  750. (should
  751. (equal "- item\n- "
  752. (org-test-with-temp-text "- it<point>em"
  753. (let ((org-M-RET-may-split-line '((default . nil))))
  754. (org-insert-item))
  755. (buffer-string))))
  756. ;; Preserve list visibility when inserting an item.
  757. (should
  758. (equal
  759. '(outline outline)
  760. (org-test-with-temp-text "- A\n - B\n- C\n - D"
  761. (let ((org-cycle-include-plain-lists t))
  762. (org-cycle)
  763. (forward-line 2)
  764. (org-cycle)
  765. (org-insert-item)
  766. (list (get-char-property (line-beginning-position 0) 'invisible)
  767. (get-char-property (line-end-position 2) 'invisible))))))
  768. ;; Test insertion in area after a sub-list. In particular, if point
  769. ;; is right at the end of the previous sub-list, still insert
  770. ;; a sub-item in that list.
  771. (should
  772. (= 2
  773. (org-test-with-temp-text "- item\n - sub-list\n<point> resume item"
  774. (org-insert-item)
  775. (current-indentation))))
  776. (should
  777. (= 0
  778. (org-test-with-temp-text "- item\n - sub-list\n resume item<point>"
  779. (org-insert-item)
  780. (current-indentation)))))
  781. (ert-deftest test-org-list/repair ()
  782. "Test `org-list-repair' specifications."
  783. ;; Repair indentation.
  784. (should
  785. (equal "- item\n - child"
  786. (org-test-with-temp-text "- item\n - child"
  787. (let ((org-list-indent-offset 0)) (org-list-repair))
  788. (buffer-string))))
  789. ;; Repair bullets and numbering.
  790. (should
  791. (equal "- a\n- b"
  792. (org-test-with-temp-text "- a\n+ b"
  793. (let ((org-list-indent-offset 0))
  794. (org-list-repair))
  795. (buffer-string))))
  796. (should
  797. (equal "1. a\n2. b"
  798. (org-test-with-temp-text "1. a\n1. b"
  799. (let ((org-list-indent-offset 0)
  800. (org-plain-list-ordered-item-terminator t))
  801. (org-list-repair))
  802. (buffer-string))))
  803. ;; Repair check-boxes.
  804. (should
  805. (equal "- [X] item\n - [X] child"
  806. (org-test-with-temp-text "- [ ] item\n - [X] child"
  807. (let ((org-list-indent-offset 0))
  808. (org-list-repair))
  809. (buffer-string))))
  810. ;; Special case: do not move contents of an item within its child.
  811. ;; Yet, preserve indentation differences within contents.
  812. (should
  813. (equal "- item\n - child\n within item"
  814. (org-test-with-temp-text "- item\n - child\n within item"
  815. (let ((org-list-indent-offset 0)) (org-list-repair))
  816. (buffer-string))))
  817. (should
  818. (equal
  819. "- item\n - child\n within item\n indented"
  820. (org-test-with-temp-text
  821. "- item\n - child\n within item\n indented"
  822. (let ((org-list-indent-offset 0)) (org-list-repair))
  823. (buffer-string)))))
  824. (ert-deftest test-org-list/update-checkbox-count ()
  825. "Test `org-update-checkbox-count' specifications."
  826. ;; From a headline.
  827. (should
  828. (string-match "\\[0/1\\]"
  829. (org-test-with-temp-text "* [/]\n- [ ] item"
  830. (org-update-checkbox-count)
  831. (buffer-string))))
  832. (should
  833. (string-match "\\[1/1\\]"
  834. (org-test-with-temp-text "* [/]\n- [X] item"
  835. (org-update-checkbox-count)
  836. (buffer-string))))
  837. (should
  838. (string-match "\\[100%\\]"
  839. (org-test-with-temp-text "* [%]\n- [X] item"
  840. (org-update-checkbox-count)
  841. (buffer-string))))
  842. ;; From a list or a sub-list.
  843. (should
  844. (string-match "\\[0/1\\]"
  845. (org-test-with-temp-text "- [/]\n - [ ] item"
  846. (org-update-checkbox-count)
  847. (buffer-string))))
  848. (should
  849. (string-match "\\[1/1\\]"
  850. (org-test-with-temp-text "- [/]\n - [X] item"
  851. (org-update-checkbox-count)
  852. (buffer-string))))
  853. (should
  854. (string-match "\\[100%\\]"
  855. (org-test-with-temp-text "- [%]\n - [X] item"
  856. (org-update-checkbox-count)
  857. (buffer-string))))
  858. (should
  859. (string-match
  860. "\\[1/1\\]"
  861. (org-test-with-temp-text "- [ ] item 1\n- [ ] item 2 [/]\n - [X] sub 1"
  862. (org-update-checkbox-count)
  863. (buffer-string))))
  864. ;; Count do not apply to sub-lists unless count is not hierarchical.
  865. ;; This state can be achieved with COOKIE_DATA node property set to
  866. ;; "recursive".
  867. (should
  868. (string-match "\\[1/1\\]"
  869. (org-test-with-temp-text "- [/]\n - item\n - [X] sub-item"
  870. (let ((org-checkbox-hierarchical-statistics nil))
  871. (org-update-checkbox-count))
  872. (buffer-string))))
  873. (should
  874. (string-match "\\[1/1\\]"
  875. (org-test-with-temp-text "
  876. <point>* H
  877. :PROPERTIES:
  878. :COOKIE_DATA: recursive
  879. :END:
  880. - [/]
  881. - item
  882. - [X] sub-item"
  883. (org-update-checkbox-count)
  884. (buffer-string))))
  885. (should
  886. (string-match "\\[0/0\\]"
  887. (org-test-with-temp-text "- [/]\n - item\n - [ ] sub-item"
  888. (org-update-checkbox-count)
  889. (buffer-string))))
  890. ;; With optional argument ALL, update all buffer.
  891. (should
  892. (= 2
  893. (org-test-with-temp-text "* [/]\n- [X] item\n* [/]\n- [X] item"
  894. (org-update-checkbox-count t)
  895. (count-matches "\\[1/1\\]"))))
  896. ;; Ignore boxes in drawers, blocks or inlinetasks when counting from
  897. ;; outside.
  898. (should
  899. (string-match "\\[2/2\\]"
  900. (org-test-with-temp-text "
  901. - [/]
  902. - [X] item1
  903. :DRAWER:
  904. - [X] item
  905. :END:
  906. - [X] item2"
  907. (let ((org-checkbox-hierarchical-statistics nil))
  908. (org-update-checkbox-count))
  909. (buffer-string)))))
  910. ;;; API
  911. (ert-deftest test-org-list/at-radio-list-p ()
  912. "Test `org-at-radio-list-p' specifications."
  913. (should
  914. (org-test-with-temp-text "#+attr_org: :radio t\n<point>- foo"
  915. (org-at-radio-list-p)))
  916. (should
  917. (org-test-with-temp-text "#+attr_org: :radio t\n- foo\n<point>- bar"
  918. (org-at-radio-list-p)))
  919. (should
  920. (org-test-with-temp-text "#+ATTR_ORG: :radio t\n<point>- foo"
  921. (org-at-radio-list-p)))
  922. (should
  923. (org-test-with-temp-text "#+attr_org: :radio bar\n<point>- foo"
  924. (org-at-radio-list-p)))
  925. (should-not
  926. (org-test-with-temp-text "#+attr_org: :radio nil\n<point>- foo"
  927. (org-at-radio-list-p)))
  928. (should-not
  929. (org-test-with-temp-text "<point>- foo"
  930. (org-at-radio-list-p)))
  931. (should-not
  932. (org-test-with-temp-text "#+attr_org: :radio t\n- foo\n <point>bar"
  933. (org-at-radio-list-p)))
  934. (should-not
  935. (org-test-with-temp-text
  936. "#+attr_org: :radio t\n#+begin_example\n<point>- foo\n#+end_example"
  937. (org-at-radio-list-p))))
  938. ;;; Miscellaneous
  939. (ert-deftest test-org-list/toggle-item ()
  940. "Test `org-toggle-item' specifications."
  941. ;; Convert normal lines to items.
  942. (should
  943. (equal "- line"
  944. (org-test-with-temp-text "line"
  945. (org-toggle-item nil)
  946. (buffer-string))))
  947. ;; Convert items to normal lines.
  948. (should
  949. (equal "line"
  950. (org-test-with-temp-text "- line"
  951. (org-toggle-item nil)
  952. (buffer-string))))
  953. ;; Convert headlines to items.
  954. (should
  955. (equal "- line"
  956. (org-test-with-temp-text "* line"
  957. (org-toggle-item nil)
  958. (buffer-string))))
  959. ;; When converting a headline to a list item, TODO keywords become
  960. ;; checkboxes.
  961. (should
  962. (equal "- [X] line"
  963. (org-test-with-temp-text "* DONE line"
  964. (org-toggle-item nil)
  965. (buffer-string))))
  966. (should
  967. (equal "- [ ] line"
  968. (org-test-with-temp-text "* TODO line"
  969. (org-toggle-item nil)
  970. (buffer-string))))
  971. ;; When turning headlines into items, make sure planning info line
  972. ;; and properties drawers are removed. This also includes empty
  973. ;; lines following them.
  974. (should
  975. (equal "- H\n"
  976. (org-test-with-temp-text "* H\nSCHEDULED: <2012-03-29 Thu>"
  977. (org-toggle-item nil)
  978. (buffer-string))))
  979. (should
  980. (equal "- H\n"
  981. (org-test-with-temp-text "* H\n:PROPERTIES:\n:A: 1\n:END:"
  982. (org-toggle-item nil)
  983. (buffer-string))))
  984. (should
  985. (equal "- H\nText"
  986. (org-test-with-temp-text "* H\n:PROPERTIES:\n:A: 1\n:END:\n\n\nText"
  987. (org-toggle-item nil)
  988. (buffer-string))))
  989. ;; When a region is marked and first line is a headline, all
  990. ;; headlines are turned into items.
  991. (should
  992. (equal "- H1\n - H2"
  993. (org-test-with-temp-text "* H1\n** H2"
  994. (transient-mark-mode 1)
  995. (push-mark (point) t t)
  996. (goto-char (point-max))
  997. (org-toggle-item nil)
  998. (buffer-string))))
  999. (should
  1000. (equal "- [ ] H1\n - [ ] H2"
  1001. (org-test-with-temp-text "* TODO H1\n** TODO H2"
  1002. (transient-mark-mode 1)
  1003. (push-mark (point) t t)
  1004. (goto-char (point-max))
  1005. (org-toggle-item nil)
  1006. (buffer-string))))
  1007. ;; When turning headlines into items, make sure headings contents
  1008. ;; are kept within items.
  1009. (should
  1010. (equal "- H1\n Text"
  1011. (org-test-with-temp-text "* H1\nText"
  1012. (transient-mark-mode 1)
  1013. (push-mark (point) t t)
  1014. (goto-char (point-max))
  1015. (org-toggle-item nil)
  1016. (buffer-string))))
  1017. ;; When a region is marked and first line is an item, all items are
  1018. ;; turned into normal lines.
  1019. (should
  1020. (equal "1\n 2"
  1021. (org-test-with-temp-text "- 1\n - 2"
  1022. (transient-mark-mode 1)
  1023. (push-mark (point) t t)
  1024. (goto-char (point-max))
  1025. (org-toggle-item nil)
  1026. (buffer-string))))
  1027. (should
  1028. (equal "1\n2"
  1029. (org-test-with-temp-text "- 1\n2"
  1030. (transient-mark-mode 1)
  1031. (push-mark (point) t t)
  1032. (goto-char (point-max))
  1033. (org-toggle-item nil)
  1034. (buffer-string))))
  1035. ;; When a region is marked and first line is an item, all normal
  1036. ;; lines are turned into items.
  1037. (should
  1038. (equal "- line 1\n- line 2"
  1039. (org-test-with-temp-text "line 1\nline 2"
  1040. (transient-mark-mode 1)
  1041. (push-mark (point) t t)
  1042. (goto-char (point-max))
  1043. (org-toggle-item nil)
  1044. (buffer-string))))
  1045. (should
  1046. (equal "- line 1\n- line 2"
  1047. (org-test-with-temp-text "line 1\n- line 2"
  1048. (transient-mark-mode 1)
  1049. (push-mark (point) t t)
  1050. (goto-char (point-max))
  1051. (org-toggle-item nil)
  1052. (buffer-string))))
  1053. ;; When argument ARG is non-nil, change the whole region into
  1054. ;; a single item.
  1055. (should
  1056. (equal "- line 1\n line 2"
  1057. (org-test-with-temp-text "line 1\nline 2"
  1058. (transient-mark-mode 1)
  1059. (push-mark (point) t t)
  1060. (goto-char (point-max))
  1061. (org-toggle-item t)
  1062. (buffer-string)))))
  1063. (ert-deftest test-org-list/sort ()
  1064. "Test `org-sort-list'."
  1065. ;; Sort alphabetically.
  1066. (let ((original-string-collate-lessp (symbol-function 'string-collate-lessp)))
  1067. (cl-letf (((symbol-function 'string-collate-lessp)
  1068. (lambda (s1 s2 &optional locale ignore-case)
  1069. (funcall original-string-collate-lessp
  1070. s1 s2 "C" ignore-case))))
  1071. (should
  1072. (equal "- abc\n- def\n- XYZ\n"
  1073. (org-test-with-temp-text "- def\n- XYZ\n- abc\n"
  1074. (org-sort-list nil ?a)
  1075. (buffer-string))))
  1076. (should
  1077. (equal "- XYZ\n- def\n- abc\n"
  1078. (org-test-with-temp-text "- def\n- XYZ\n- abc\n"
  1079. (org-sort-list nil ?A)
  1080. (buffer-string))))
  1081. ;; Sort alphabetically (with case).
  1082. (should
  1083. (equal "- C\n- a\n- b\n"
  1084. (org-test-with-temp-text "- b\n- C\n- a\n"
  1085. (org-sort-list t ?a)
  1086. (buffer-string))))
  1087. (should
  1088. (equal "- b\n- a\n- C\n"
  1089. (org-test-with-temp-text "- b\n- C\n- a\n"
  1090. (org-sort-list t ?A)
  1091. (buffer-string))))))
  1092. ;; Sort numerically.
  1093. (should
  1094. (equal "- 1\n- 2\n- 10\n"
  1095. (org-test-with-temp-text "- 10\n- 1\n- 2\n"
  1096. (org-sort-list nil ?n)
  1097. (buffer-string))))
  1098. (should
  1099. (equal "- 10\n- 2\n- 1\n"
  1100. (org-test-with-temp-text "- 10\n- 1\n- 2\n"
  1101. (org-sort-list nil ?N)
  1102. (buffer-string))))
  1103. ;; Sort by checked status.
  1104. (should
  1105. (equal "- [ ] xyz\n- [ ] def\n- [X] abc\n"
  1106. (org-test-with-temp-text "- [X] abc\n- [ ] xyz\n- [ ] def\n"
  1107. (org-sort-list nil ?x)
  1108. (buffer-string))))
  1109. (should
  1110. (equal "- [X] abc\n- [ ] xyz\n- [ ] def\n"
  1111. (org-test-with-temp-text "- [X] abc\n- [ ] xyz\n- [ ] def\n"
  1112. (org-sort-list nil ?X)
  1113. (buffer-string))))
  1114. ;; Sort by time stamp.
  1115. (should
  1116. (equal "- <2017-05-08 Mon>\n- <2017-05-09 Tue>\n- <2018-05-09 Wed>\n"
  1117. (org-test-with-temp-text
  1118. "- <2018-05-09 Wed>\n- <2017-05-09 Tue>\n- <2017-05-08 Mon>\n"
  1119. (org-sort-list nil ?t)
  1120. (buffer-string))))
  1121. (should
  1122. (equal "- <2018-05-09 Wed>\n- <2017-05-09 Tue>\n- <2017-05-08 Mon>\n"
  1123. (org-test-with-temp-text
  1124. "- <2018-05-09 Wed>\n- <2017-05-09 Tue>\n- <2017-05-08 Mon>\n"
  1125. (org-sort-list nil ?T)
  1126. (buffer-string))))
  1127. ;; Sort by custom function.
  1128. (should
  1129. (equal "- b\n- aa\n- ccc\n"
  1130. (org-test-with-temp-text "- ccc\n- b\n- aa\n"
  1131. (org-sort-list nil ?f
  1132. (lambda ()
  1133. (length (buffer-substring (point-at-bol)
  1134. (point-at-eol))))
  1135. #'<)
  1136. (buffer-string))))
  1137. (should
  1138. (equal "- ccc\n- aa\n- b\n"
  1139. (org-test-with-temp-text "- ccc\n- b\n- aa\n"
  1140. (org-sort-list nil ?F
  1141. (lambda ()
  1142. (length (buffer-substring (point-at-bol)
  1143. (point-at-eol))))
  1144. #'<)
  1145. (buffer-string)))))
  1146. ;;; List transformations
  1147. (ert-deftest test-org-list/to-generic ()
  1148. "Test `org-list-to-generic' specifications."
  1149. ;; Test `:ustart' and `:uend' parameters.
  1150. (should
  1151. (equal
  1152. "begin\na"
  1153. (org-test-with-temp-text "- a"
  1154. (org-list-to-generic (org-list-to-lisp) '(:ustart "begin")))))
  1155. (should-not
  1156. (equal
  1157. "begin\na"
  1158. (org-test-with-temp-text "1. a"
  1159. (org-list-to-generic (org-list-to-lisp) '(:ustart "begin")))))
  1160. (should
  1161. (equal
  1162. "a\nend"
  1163. (org-test-with-temp-text "- a"
  1164. (org-list-to-generic (org-list-to-lisp) '(:uend "end")))))
  1165. (should-not
  1166. (equal
  1167. "a\nend"
  1168. (org-test-with-temp-text "1. a"
  1169. (org-list-to-generic (org-list-to-lisp) '(:uend "end")))))
  1170. (should
  1171. (equal
  1172. "begin l1\na\nbegin l2\nb\nend l2\nend l1"
  1173. (org-test-with-temp-text "- a\n - b"
  1174. (org-list-to-generic
  1175. (org-list-to-lisp)
  1176. (list :ustart (lambda (l) (format "begin l%d" l))
  1177. :uend (lambda (l) (format "end l%d" l)))))))
  1178. ;; Test `:ostart' and `:oend' parameters.
  1179. (should
  1180. (equal
  1181. "begin\na"
  1182. (org-test-with-temp-text "1. a"
  1183. (org-list-to-generic (org-list-to-lisp) '(:ostart "begin")))))
  1184. (should-not
  1185. (equal
  1186. "begin\na"
  1187. (org-test-with-temp-text "- a"
  1188. (org-list-to-generic (org-list-to-lisp) '(:ostart "begin")))))
  1189. (should
  1190. (equal
  1191. "a\nend"
  1192. (org-test-with-temp-text "1. a"
  1193. (org-list-to-generic (org-list-to-lisp) '(:oend "end")))))
  1194. (should-not
  1195. (equal
  1196. "a\nend"
  1197. (org-test-with-temp-text "- a"
  1198. (org-list-to-generic (org-list-to-lisp) '(:oend "end")))))
  1199. (should
  1200. (equal
  1201. "begin l1\na\nbegin l2\nb\nend l2\nend l1"
  1202. (org-test-with-temp-text "1. a\n 1. b"
  1203. (org-list-to-generic
  1204. (org-list-to-lisp)
  1205. (list :ostart (lambda (l) (format "begin l%d" l))
  1206. :oend (lambda (l) (format "end l%d" l)))))))
  1207. ;; Test `:dstart' and `:dend' parameters.
  1208. (should
  1209. (equal
  1210. "begin\ntaga"
  1211. (org-test-with-temp-text "- tag :: a"
  1212. (org-list-to-generic (org-list-to-lisp) '(:dstart "begin")))))
  1213. (should-not
  1214. (equal
  1215. "begin\na"
  1216. (org-test-with-temp-text "- a"
  1217. (org-list-to-generic (org-list-to-lisp) '(:dstart "begin")))))
  1218. (should
  1219. (equal
  1220. "taga\nend"
  1221. (org-test-with-temp-text "- tag :: a"
  1222. (org-list-to-generic (org-list-to-lisp) '(:dend "end")))))
  1223. (should-not
  1224. (equal
  1225. "a\nend"
  1226. (org-test-with-temp-text "- a"
  1227. (org-list-to-generic (org-list-to-lisp) '(:dend "end")))))
  1228. (should
  1229. (equal
  1230. "begin l1\ntag1a\nbegin l2\ntag2b\nend l2\nend l1"
  1231. (org-test-with-temp-text "- tag1 :: a\n - tag2 :: b"
  1232. (org-list-to-generic
  1233. (org-list-to-lisp)
  1234. (list :dstart (lambda (l) (format "begin l%d" l))
  1235. :dend (lambda (l) (format "end l%d" l)))))))
  1236. ;; Test `:dtstart', `:dtend', `:ddstart' and `:ddend' parameters.
  1237. (should
  1238. (equal
  1239. ">tag<a"
  1240. (org-test-with-temp-text "- tag :: a"
  1241. (org-list-to-generic (org-list-to-lisp) '(:dtstart ">" :dtend "<")))))
  1242. (should
  1243. (equal
  1244. "tag>a<"
  1245. (org-test-with-temp-text "- tag :: a"
  1246. (org-list-to-generic (org-list-to-lisp) '(:ddstart ">" :ddend "<")))))
  1247. ;; Test `:istart' and `:iend' parameters.
  1248. (should
  1249. (equal
  1250. "starta"
  1251. (org-test-with-temp-text "- a"
  1252. (org-list-to-generic (org-list-to-lisp) '(:istart "start")))))
  1253. (should
  1254. (equal
  1255. "level1 a\nlevel2 b"
  1256. (org-test-with-temp-text "- a\n - b"
  1257. (org-list-to-generic (org-list-to-lisp)
  1258. '(:istart (lambda (type l) (format "level%d "l)))))))
  1259. (should
  1260. (equal
  1261. "a\nblevel2level1"
  1262. (org-test-with-temp-text "- a\n - b"
  1263. (org-list-to-generic (org-list-to-lisp)
  1264. '(:iend (lambda (type l) (format "level%d" l)))))))
  1265. ;; Test `:icount' parameter.
  1266. (should
  1267. (equal
  1268. "counta"
  1269. (org-test-with-temp-text "1. [@3] a"
  1270. (org-list-to-generic (org-list-to-lisp) '(:icount "count")))))
  1271. (should-not
  1272. (equal
  1273. "counta"
  1274. (org-test-with-temp-text "1. a"
  1275. (org-list-to-generic (org-list-to-lisp) '(:icount "count")))))
  1276. (should
  1277. (equal
  1278. "counta"
  1279. (org-test-with-temp-text "1. [@3] a"
  1280. (org-list-to-generic (org-list-to-lisp)
  1281. '(:icount "count" :istart "start")))))
  1282. (should
  1283. (equal
  1284. "level:1, counter:3 a"
  1285. (org-test-with-temp-text "1. [@3] a"
  1286. (org-list-to-generic
  1287. (org-list-to-lisp)
  1288. '(:icount (lambda (type l c) (format "level:%d, counter:%d " l c)))))))
  1289. ;; Test `:isep' parameter.
  1290. (should
  1291. (equal
  1292. "a\n--\nb"
  1293. (org-test-with-temp-text "- a\n- b"
  1294. (org-list-to-generic (org-list-to-lisp) '(:isep "--")))))
  1295. (should-not
  1296. (equal
  1297. "a\n--\nb"
  1298. (org-test-with-temp-text "- a\n - b"
  1299. (org-list-to-generic (org-list-to-lisp) '(:isep "--")))))
  1300. (should
  1301. (equal
  1302. "a\n- 1 -\nb"
  1303. (org-test-with-temp-text "- a\n- b"
  1304. (org-list-to-generic
  1305. (org-list-to-lisp)
  1306. '(:isep (lambda (type depth) (format "- %d -" depth)))))))
  1307. ;; Test `:ifmt' parameter.
  1308. (should
  1309. (equal
  1310. ">> a <<"
  1311. (org-test-with-temp-text "1. [@3] a"
  1312. (org-list-to-generic
  1313. (org-list-to-lisp)
  1314. '(:ifmt (lambda (type c) (format ">> %s <<" c)))))))
  1315. ;; Test `:cbon', `:cboff', `:cbtrans'
  1316. (should
  1317. (equal
  1318. "!a"
  1319. (org-test-with-temp-text "- [X] a"
  1320. (org-list-to-generic (org-list-to-lisp) '(:cbon "!")))))
  1321. (should-not
  1322. (equal
  1323. "!a"
  1324. (org-test-with-temp-text "- [X] a"
  1325. (org-list-to-generic (org-list-to-lisp) '(:cboff "!" :cbtrans "!")))))
  1326. (should
  1327. (equal
  1328. "!a"
  1329. (org-test-with-temp-text "- [ ] a"
  1330. (org-list-to-generic (org-list-to-lisp) '(:cboff "!")))))
  1331. (should-not
  1332. (equal
  1333. "!a"
  1334. (org-test-with-temp-text "- [ ] a"
  1335. (org-list-to-generic (org-list-to-lisp) '(:cbon "!" :cbtrans "!")))))
  1336. (should
  1337. (equal
  1338. "!a"
  1339. (org-test-with-temp-text "- [-] a"
  1340. (org-list-to-generic (org-list-to-lisp) '(:cbtrans "!")))))
  1341. (should-not
  1342. (equal
  1343. "!a"
  1344. (org-test-with-temp-text "- [-] a"
  1345. (org-list-to-generic (org-list-to-lisp) '(:cbon "!" :cboff "!")))))
  1346. ;; Test `:splice' parameter.
  1347. (should
  1348. (equal
  1349. "a"
  1350. (org-test-with-temp-text "- a"
  1351. (org-list-to-generic (org-list-to-lisp)
  1352. '(:ustart "begin" :uend "end" :splice t)))))
  1353. ;; No error on empty lists.
  1354. (should
  1355. (org-test-with-temp-text "-" (org-list-to-generic (org-list-to-lisp) nil))))
  1356. (ert-deftest test-org-list/to-html ()
  1357. "Test `org-list-to-html' specifications."
  1358. (should
  1359. (equal "<ul class=\"org-ul\">\n<li>a</li>\n</ul>"
  1360. (org-test-with-temp-text "- a"
  1361. (org-list-to-html (org-list-to-lisp) nil)))))
  1362. (ert-deftest test-org-list/to-latex ()
  1363. "Test `org-list-to-latex' specifications."
  1364. (should
  1365. (equal "\\begin{itemize}\n\\item a\n\\end{itemize}"
  1366. (org-test-with-temp-text "- a"
  1367. (org-list-to-latex (org-list-to-lisp) nil)))))
  1368. (ert-deftest test-org-list/to-texinfo ()
  1369. "Test `org-list-to-texinfo' specifications."
  1370. (should
  1371. (equal "@itemize\n@item\na\n@end itemize"
  1372. (org-test-with-temp-text "- a"
  1373. (org-list-to-texinfo (org-list-to-lisp) nil)))))
  1374. (ert-deftest test-org-list/to-org ()
  1375. "Test `org-list-to-org' specifications."
  1376. ;; Un-ordered list.
  1377. (should
  1378. (equal "- a"
  1379. (org-test-with-temp-text "- a"
  1380. (org-list-to-org (org-list-to-lisp) nil))))
  1381. ;; Ordered list.
  1382. (should
  1383. (equal "1. a"
  1384. (org-test-with-temp-text "1. a"
  1385. (org-list-to-org (org-list-to-lisp) nil))))
  1386. ;; Descriptive list.
  1387. (should
  1388. (equal "- a :: b"
  1389. (org-test-with-temp-text "- a :: b"
  1390. (org-list-to-org (org-list-to-lisp) nil))))
  1391. ;; Nested list.
  1392. (should
  1393. (equal "- a\n - b"
  1394. (org-test-with-temp-text "- a\n - b"
  1395. (org-list-to-org (org-list-to-lisp) nil))))
  1396. ;; Item spanning over multiple lines.
  1397. (should
  1398. (equal "- a\n b"
  1399. (org-test-with-temp-text "- a\n b"
  1400. (org-list-to-org (org-list-to-lisp) nil))))
  1401. ;; Item with continuation text after a sub-list.
  1402. (should
  1403. (equal "- a\n - b\n c"
  1404. (org-test-with-temp-text "- a\n - b\n c"
  1405. (org-list-to-org (org-list-to-lisp) nil)))))
  1406. (provide 'test-org-list)
  1407. ;;; test-org-list.el ends here