test-org-colview.el 25 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018
  1. ;;; test-org-colview.el --- Tests for org-colview.el -*- lexical-binding: t; -*-
  2. ;; Copyright (C) 2016 Nicolas Goaziou
  3. ;; Author: Nicolas Goaziou <mail@nicolasgoaziou.fr>
  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. ;;; Column view
  16. (require 'cl-lib)
  17. (ert-deftest test-org-colview/columns-scope ()
  18. "Test `org-columns' scope."
  19. ;; Before the first headline, view all document.
  20. (should
  21. (equal
  22. '("H1" "H2" "H3")
  23. (org-test-with-temp-text "Top\n* H1\n** H2\n* H3"
  24. (let ((org-columns-default-format "%ITEM")) (org-columns))
  25. (org-map-entries
  26. (lambda () (get-char-property (point) 'org-columns-value))))))
  27. ;; When :COLUMNS: is set up in the hierarchy, view tree starting
  28. ;; there.
  29. (should
  30. (equal
  31. '(nil "H2" "H3" nil)
  32. (org-test-with-temp-text
  33. "* H1\n** H2\n:PROPERTIES:\n:COLUMNS: %ITEM\n:END:\n*** <point>H3\n* H4"
  34. (let ((org-columns-default-format "%ITEM")) (org-columns))
  35. (org-map-entries
  36. (lambda () (get-char-property (point) 'org-columns-value))))))
  37. ;; Otherwise, view tree starting at the current headline.
  38. (should
  39. (equal
  40. '(nil "H2" "H3" nil)
  41. (org-test-with-temp-text "Top\n* H1\n** <point>H2\n*** H3\n* H4"
  42. (let ((org-columns-default-format "%ITEM")) (org-columns))
  43. (org-map-entries
  44. (lambda () (get-char-property (point) 'org-columns-value))))))
  45. ;; With a non-nil prefix argument, always view all document.
  46. (should
  47. (equal
  48. '("H1" "H2" "H3" "H4")
  49. (org-test-with-temp-text
  50. "* H1\n** H2\n:PROPERTIES:\n:COLUMNS: %ITEM\n:END:\n*** <point>H3\n* H4"
  51. (let ((org-columns-default-format "%ITEM")) (org-columns t))
  52. (org-map-entries
  53. (lambda () (get-char-property (point) 'org-columns-value))))))
  54. (should
  55. (equal
  56. '("H1" "H2" "H3" "H4")
  57. (org-test-with-temp-text "Top\n* H1\n** <point>H2\n*** H3\n* H4"
  58. (let ((org-columns-default-format "%ITEM")) (org-columns t))
  59. (org-map-entries
  60. (lambda () (get-char-property (point) 'org-columns-value)))))))
  61. (ert-deftest test-org-colview/columns-width ()
  62. "Test `org-columns' column widths."
  63. ;; When a width is specified in the format, use it.
  64. (should
  65. (= 9
  66. (org-test-with-temp-text "* H"
  67. (let ((org-columns-default-format "%9ITEM")) (org-columns))
  68. (aref org-columns-current-maxwidths 0))))
  69. ;; Otherwise, use the width of the largest value in the column.
  70. (should
  71. (= 2
  72. (org-test-with-temp-text
  73. "* H\n:PROPERTIES:\n:P: X\n:END:\n** H2\n:PROPERTIES:\n:P: XX\n:END:"
  74. (let ((org-columns-default-format "%P")) (org-columns))
  75. (aref org-columns-current-maxwidths 0))))
  76. ;; If the title is wider than the widest value, use title width
  77. ;; instead.
  78. (should
  79. (= 4
  80. (org-test-with-temp-text "* H"
  81. (let ((org-columns-default-format "%ITEM")) (org-columns))
  82. (aref org-columns-current-maxwidths 0))))
  83. ;; Special case: stars do count for ITEM.
  84. (should
  85. (= 6
  86. (org-test-with-temp-text "* Head"
  87. (let ((org-columns-default-format "%ITEM")) (org-columns))
  88. (aref org-columns-current-maxwidths 0))))
  89. ;; Special case: width takes into account link narrowing in ITEM.
  90. (should
  91. (equal
  92. '("* [123]" . 7)
  93. (org-test-with-temp-text "* [[http://orgmode.org][123]]"
  94. (let ((org-columns-default-format "%ITEM")) (org-columns))
  95. (cons (get-char-property (point) 'org-columns-value-modified)
  96. (aref org-columns-current-maxwidths 0)))))
  97. ;; When a value is too wide for the current column, add ellipses.
  98. ;; Take into consideration length of `org-columns-ellipses'.
  99. (should
  100. (equal "123.. |"
  101. (org-test-with-temp-text "* H\n:PROPERTIES:\n:P: 123456\n:END:"
  102. (let ((org-columns-default-format "%5P")
  103. (org-columns-ellipses ".."))
  104. (org-columns))
  105. (org-trim (get-char-property (point) 'display)))))
  106. (should
  107. (equal "1234… |"
  108. (org-test-with-temp-text "* H\n:PROPERTIES:\n:P: 123456\n:END:"
  109. (let ((org-columns-default-format "%5P")
  110. (org-columns-ellipses "…"))
  111. (org-columns))
  112. (org-trim (get-char-property (point) 'display))))))
  113. (ert-deftest test-org-colview/columns-summary ()
  114. "Test `org-columns' summary types."
  115. ;; {+} and {+;format} add numbers.
  116. (should
  117. (equal
  118. "3"
  119. (org-test-with-temp-text
  120. "* H
  121. ** S1
  122. :PROPERTIES:
  123. :A: 1
  124. :END:
  125. ** S1
  126. :PROPERTIES:
  127. :A: 2
  128. :END:"
  129. (let ((org-columns-default-format "%A{+}")) (org-columns))
  130. (get-char-property (point) 'org-columns-value-modified))))
  131. (should
  132. (equal
  133. "3.0"
  134. (org-test-with-temp-text
  135. "* H
  136. ** S1
  137. :PROPERTIES:
  138. :A: 1
  139. :END:
  140. ** S1
  141. :PROPERTIES:
  142. :A: 2
  143. :END:"
  144. (let ((org-columns-default-format "%A{+;%.1f}")) (org-columns))
  145. (get-char-property (point) 'org-columns-value-modified))))
  146. ;; {$} is a shortcut for {+;%.2f}.
  147. (should
  148. (equal
  149. "3.60"
  150. (org-test-with-temp-text
  151. "* H
  152. ** S1
  153. :PROPERTIES:
  154. :A: 1.50
  155. :END:
  156. ** S1
  157. :PROPERTIES:
  158. :A: 2.10
  159. :END:"
  160. (let ((org-columns-default-format "%A{$}")) (org-columns))
  161. (get-char-property (point) 'org-columns-value-modified))))
  162. ;; {:} sums times. Plain numbers are hours.
  163. (should
  164. (equal
  165. "4:10"
  166. (org-test-with-temp-text
  167. "* H
  168. ** S1
  169. :PROPERTIES:
  170. :A: 1:30
  171. :END:
  172. ** S1
  173. :PROPERTIES:
  174. :A: 2:40
  175. :END:"
  176. (let ((org-columns-default-format "%A{:}")) (org-columns))
  177. (get-char-property (point) 'org-columns-value-modified))))
  178. (should
  179. (equal
  180. "3:30"
  181. (org-test-with-temp-text
  182. "* H
  183. ** S1
  184. :PROPERTIES:
  185. :A: 1:30
  186. :END:
  187. ** S1
  188. :PROPERTIES:
  189. :A: 2
  190. :END:"
  191. (let ((org-columns-default-format "%A{:}")) (org-columns))
  192. (get-char-property (point) 'org-columns-value-modified))))
  193. ;; {X}, {X/} and {X%} indicate checkbox status.
  194. (should
  195. (equal
  196. "[ ]"
  197. (org-test-with-temp-text
  198. "* H
  199. ** S1
  200. :PROPERTIES:
  201. :A: [ ]
  202. :END:
  203. ** S1
  204. :PROPERTIES:
  205. :A: [ ]
  206. :END:"
  207. (let ((org-columns-default-format "%A{X}")) (org-columns))
  208. (get-char-property (point) 'org-columns-value-modified))))
  209. (should
  210. (equal
  211. "[-]"
  212. (org-test-with-temp-text
  213. "* H
  214. ** S1
  215. :PROPERTIES:
  216. :A: [ ]
  217. :END:
  218. ** S1
  219. :PROPERTIES:
  220. :A: [X]
  221. :END:"
  222. (let ((org-columns-default-format "%A{X}")) (org-columns))
  223. (get-char-property (point) 'org-columns-value-modified))))
  224. (should
  225. (equal
  226. "[X]"
  227. (org-test-with-temp-text
  228. "* H
  229. ** S1
  230. :PROPERTIES:
  231. :A: [X]
  232. :END:
  233. ** S1
  234. :PROPERTIES:
  235. :A: [X]
  236. :END:"
  237. (let ((org-columns-default-format "%A{X}")) (org-columns))
  238. (get-char-property (point) 'org-columns-value-modified))))
  239. (should
  240. (equal
  241. "[1/2]"
  242. (org-test-with-temp-text
  243. "* H
  244. ** S1
  245. :PROPERTIES:
  246. :A: [ ]
  247. :END:
  248. ** S1
  249. :PROPERTIES:
  250. :A: [X]
  251. :END:"
  252. (let ((org-columns-default-format "%A{X/}")) (org-columns))
  253. (get-char-property (point) 'org-columns-value-modified))))
  254. (should
  255. (equal
  256. "[50%]"
  257. (org-test-with-temp-text
  258. "* H
  259. ** S1
  260. :PROPERTIES:
  261. :A: [ ]
  262. :END:
  263. ** S1
  264. :PROPERTIES:
  265. :A: [X]
  266. :END:"
  267. (let ((org-columns-default-format "%A{X%}")) (org-columns))
  268. (get-char-property (point) 'org-columns-value-modified))))
  269. ;; {min} is the smallest number in column, {max} the largest one.
  270. ;; {mean} is the arithmetic mean of numbers in column.
  271. (should
  272. (equal
  273. "42"
  274. (org-test-with-temp-text
  275. "* H
  276. ** S1
  277. :PROPERTIES:
  278. :A: 99
  279. :END:
  280. ** S1
  281. :PROPERTIES:
  282. :A: 42
  283. :END:"
  284. (let ((org-columns-default-format "%A{min}")) (org-columns))
  285. (get-char-property (point) 'org-columns-value-modified))))
  286. (should
  287. (equal
  288. "99"
  289. (org-test-with-temp-text
  290. "* H
  291. ** S1
  292. :PROPERTIES:
  293. :A: 99
  294. :END:
  295. ** S1
  296. :PROPERTIES:
  297. :A: 42
  298. :END:"
  299. (let ((org-columns-default-format "%A{max}")) (org-columns))
  300. (get-char-property (point) 'org-columns-value-modified))))
  301. (should
  302. (equal
  303. "51.0"
  304. (org-test-with-temp-text
  305. "* H
  306. ** S1
  307. :PROPERTIES:
  308. :A: 60
  309. :END:
  310. ** S1
  311. :PROPERTIES:
  312. :A: 42
  313. :END:"
  314. (let ((org-columns-default-format "%A{mean}")) (org-columns))
  315. (get-char-property (point) 'org-columns-value-modified))))
  316. ;; {:min}, {:max} and {:mean} apply to time values.
  317. (should
  318. (equal
  319. "1:20"
  320. (org-test-with-temp-text
  321. "* H
  322. ** S1
  323. :PROPERTIES:
  324. :A: 4:40
  325. :END:
  326. ** S1
  327. :PROPERTIES:
  328. :A: 1:20
  329. :END:"
  330. (let ((org-columns-default-format "%A{:min}")) (org-columns))
  331. (get-char-property (point) 'org-columns-value-modified))))
  332. (should
  333. (equal
  334. "4:40"
  335. (org-test-with-temp-text
  336. "* H
  337. ** S1
  338. :PROPERTIES:
  339. :A: 4:40
  340. :END:
  341. ** S1
  342. :PROPERTIES:
  343. :A: 1:20
  344. :END:"
  345. (let ((org-columns-default-format "%A{:max}")) (org-columns))
  346. (get-char-property (point) 'org-columns-value-modified))))
  347. (should
  348. (equal
  349. "3:00"
  350. (org-test-with-temp-text
  351. "* H
  352. ** S1
  353. :PROPERTIES:
  354. :A: 4:40
  355. :END:
  356. ** S1
  357. :PROPERTIES:
  358. :A: 1:20
  359. :END:"
  360. (let ((org-columns-default-format "%A{:mean}")) (org-columns))
  361. (get-char-property (point) 'org-columns-value-modified))))
  362. ;; {@min}, {@max} and {@mean} apply to ages.
  363. (should
  364. (equal
  365. (let ((org-columns--time (float-time (current-time))))
  366. (org-columns--summary-min-age (list "<2014-03-04 Tue>") nil))
  367. (org-test-with-temp-text
  368. "* H
  369. ** S1
  370. :PROPERTIES:
  371. :A: <2012-03-29 Thu>
  372. :END:
  373. ** S1
  374. :PROPERTIES:
  375. :A: <2014-03-04 Tue>
  376. :END:"
  377. (let ((org-columns-default-format "%A{@min}")) (org-columns))
  378. (get-char-property (point) 'org-columns-value-modified))))
  379. (should
  380. (equal
  381. (let ((org-columns--time (float-time (current-time))))
  382. (org-columns--summary-max-age (list "<2012-03-29 Thu>") nil))
  383. (org-test-with-temp-text
  384. "* H
  385. ** S1
  386. :PROPERTIES:
  387. :A: <2012-03-29 Thu>
  388. :END:
  389. ** S1
  390. :PROPERTIES:
  391. :A: <2014-03-04 Tue>
  392. :END:"
  393. (let ((org-columns-default-format "%A{@max}")) (org-columns))
  394. (get-char-property (point) 'org-columns-value-modified))))
  395. (should
  396. (equal
  397. (let ((org-columns--time (float-time (current-time))))
  398. (org-columns--summary-mean-age
  399. (list "<2012-03-29 Thu>" "<2014-03-04 Tue>") nil))
  400. (org-test-with-temp-text
  401. "* H
  402. ** S1
  403. :PROPERTIES:
  404. :A: <2012-03-29 Thu>
  405. :END:
  406. ** S1
  407. :PROPERTIES:
  408. :A: <2014-03-04 Tue>
  409. :END:"
  410. (let ((org-columns-default-format "%A{@mean}")) (org-columns))
  411. (get-char-property (point) 'org-columns-value-modified))))
  412. ;; If a time value is expressed as a duration, return a duration.
  413. ;; If any of them follows H:MM:SS pattern, use it too.
  414. (should
  415. (equal
  416. "1d 4:20"
  417. (org-test-with-temp-text
  418. "* H
  419. ** S1
  420. :PROPERTIES:
  421. :A: 3d 3h
  422. :END:
  423. ** S1
  424. :PROPERTIES:
  425. :A: 1:20
  426. :END:"
  427. (let ((org-columns-default-format "%A{:}")
  428. (org-time-clocksum-use-fractional nil)
  429. (org-time-clocksum-format
  430. '(:days "%dd " :hours "%d" :minutes ":%02d")))
  431. (org-columns))
  432. (get-char-property (point) 'org-columns-value-modified))))
  433. (should
  434. (equal
  435. "6:00:10"
  436. (org-test-with-temp-text
  437. "* H
  438. ** S1
  439. :PROPERTIES:
  440. :A: 4:40:10
  441. :END:
  442. ** S1
  443. :PROPERTIES:
  444. :A: 1:20
  445. :END:"
  446. (let ((org-columns-default-format "%A{:}")) (org-columns))
  447. (get-char-property (point) 'org-columns-value-modified))))
  448. ;; @min, @max and @mean also accept regular duration in
  449. ;; a "?d ?h ?m ?s" format.
  450. (should
  451. (equal
  452. "1d 10h 0m 0s"
  453. (org-test-with-temp-text
  454. "* H
  455. ** S1
  456. :PROPERTIES:
  457. :A: 1d 10h 0m 0s
  458. :END:
  459. ** S1
  460. :PROPERTIES:
  461. :A: 5d 3h 0m 0s
  462. :END:"
  463. (let ((org-columns-default-format "%A{@min}")) (org-columns))
  464. (get-char-property (point) 'org-columns-value-modified))))
  465. ;; {est+} gives a low-high estimate using mean and standard
  466. ;; deviation.
  467. (should
  468. (equal
  469. "3-17"
  470. (org-test-with-temp-text
  471. "* H
  472. ** S1
  473. :PROPERTIES:
  474. :A: 0-10
  475. :END:
  476. ** S1
  477. :PROPERTIES:
  478. :A: 0-10
  479. :END:"
  480. (let ((org-columns-default-format "%A{est+}")) (org-columns))
  481. (get-char-property (point) 'org-columns-value-modified))))
  482. ;; When using {est+} summary, a single number is understood as
  483. ;; a degenerate range.
  484. (should
  485. (equal
  486. "4-4"
  487. (org-test-with-temp-text
  488. "* H
  489. ** S1
  490. :PROPERTIES:
  491. :A: 4
  492. :END:
  493. "
  494. (let ((org-columns-default-format "%A{est+}")) (org-columns))
  495. (get-char-property (point) 'org-columns-value-modified))))
  496. ;; Allow custom summary types.
  497. (should
  498. (equal
  499. "1|2"
  500. (org-test-with-temp-text
  501. "* H
  502. ** S1
  503. :PROPERTIES:
  504. :A: 1
  505. :END:
  506. ** S1
  507. :PROPERTIES:
  508. :A: 2
  509. :END:"
  510. (let ((org-columns-summary-types
  511. '(("custom" . (lambda (s _) (mapconcat #'identity s "|")))))
  512. (org-columns-default-format "%A{custom}")) (org-columns))
  513. (get-char-property (point) 'org-columns-value-modified))))
  514. ;; Allow multiple summary types applied to the same property.
  515. (should
  516. (equal
  517. '("42" "99")
  518. (org-test-with-temp-text
  519. "* H
  520. ** S1
  521. :PROPERTIES:
  522. :A: 99
  523. :END:
  524. ** S1
  525. :PROPERTIES:
  526. :A: 42
  527. :END:"
  528. (let ((org-columns-default-format "%A{min} %A{max}")) (org-columns))
  529. (list (get-char-property (point) 'org-columns-value-modified)
  530. (get-char-property (1+ (point)) 'org-columns-value-modified)))))
  531. ;; Allow mixing both summarized and non-summarized columns for
  532. ;; a property. However, the first column takes precedence and
  533. ;; updates the value.
  534. (should
  535. (equal
  536. '("1000" "42")
  537. (org-test-with-temp-text
  538. "* H
  539. :PROPERTIES:
  540. :A: 1000
  541. :END:
  542. ** S1
  543. :PROPERTIES:
  544. :A: 99
  545. :END:
  546. ** S1
  547. :PROPERTIES:
  548. :A: 42
  549. :END:"
  550. (let ((org-columns-default-format "%A %A{min}")) (org-columns))
  551. (list (get-char-property (point) 'org-columns-value-modified)
  552. (get-char-property (1+ (point)) 'org-columns-value-modified)))))
  553. (should
  554. (equal
  555. '("42" "42")
  556. (org-test-with-temp-text
  557. "* H
  558. :PROPERTIES:
  559. :A: 1000
  560. :END:
  561. ** S1
  562. :PROPERTIES:
  563. :A: 99
  564. :END:
  565. ** S1
  566. :PROPERTIES:
  567. :A: 42
  568. :END:"
  569. (let ((org-columns-default-format "%A{min} %A")) (org-columns))
  570. (list (get-char-property (point) 'org-columns-value-modified)
  571. (get-char-property (1+ (point)) 'org-columns-value-modified))))))
  572. (ert-deftest test-org-colview/columns-new ()
  573. "Test `org-columns-new' specifications."
  574. ;; Insert new column at the left of the current one.
  575. (should
  576. (equal '("FOO" "ITEM")
  577. (org-test-with-temp-text "* H"
  578. (let ((org-columns-default-format "%ITEM")) (org-columns))
  579. (org-columns-new "FOO")
  580. (list (get-char-property (point) 'org-columns-key)
  581. (get-char-property (1+ (point)) 'org-columns-key)))))
  582. (should
  583. (equal '("ITEM" "FOO" "BAR")
  584. (org-test-with-temp-text "* H"
  585. (let ((org-columns-default-format "%ITEM %BAR")) (org-columns))
  586. (forward-char)
  587. (org-columns-new "FOO")
  588. (list (get-char-property (1- (point)) 'org-columns-key)
  589. (get-char-property (point) 'org-columns-key)
  590. (get-char-property (1+ (point)) 'org-columns-key)))))
  591. ;; Update #+COLUMNS keyword if needed.
  592. (should
  593. (equal "#+COLUMNS: %FOO %ITEM"
  594. (org-test-with-temp-text "#+COLUMNS: %ITEM\n<point>* H"
  595. (let ((org-columns-default-format "%ITEM")) (org-columns))
  596. (org-columns-new "FOO")
  597. (goto-char (point-min))
  598. (buffer-substring-no-properties (point) (line-end-position)))))
  599. (should
  600. (equal "#+COLUMNS: %ITEM %FOO %BAR"
  601. (org-test-with-temp-text "#+COLUMNS: %ITEM %BAR\n<point>* H"
  602. (let ((org-columns-default-format "%ITEM %BAR")) (org-columns))
  603. (forward-char)
  604. (org-columns-new "FOO")
  605. (goto-char (point-min))
  606. (buffer-substring-no-properties (point) (line-end-position)))))
  607. ;; Mind case when updating #+COLUMNS.
  608. (should
  609. (equal "#+COLUMNS: %ITEM %Foo %BAR"
  610. (org-test-with-temp-text "#+COLUMNS: %ITEM %BAR\n<point>* H"
  611. (let ((org-columns-default-format "%ITEM %BAR")) (org-columns))
  612. (forward-char)
  613. (org-columns-new "Foo")
  614. (goto-char (point-min))
  615. (buffer-substring-no-properties (point) (line-end-position))))))
  616. (ert-deftest test-org-colview/columns-update ()
  617. "Test `org-columns-update' specifications."
  618. ;; Update display.
  619. (should
  620. (equal
  621. "12 |"
  622. (org-test-with-temp-text
  623. "* H
  624. :PROPERTIES:
  625. :A: 1
  626. :END:
  627. "
  628. (let ((org-columns-default-format "%5A")) (org-columns))
  629. (search-forward "1")
  630. (insert "2")
  631. (org-columns-update "A")
  632. (get-char-property (point-min) 'display))))
  633. ;; Update is case-insensitive.
  634. (should
  635. (equal
  636. "12 |"
  637. (org-test-with-temp-text
  638. "* H
  639. :PROPERTIES:
  640. :A: 1
  641. :END:
  642. "
  643. (let ((org-columns-default-format "%5A")) (org-columns))
  644. (search-forward "1")
  645. (insert "2")
  646. (org-columns-update "a")
  647. (get-char-property (point-min) 'display))))
  648. ;; Update stored values.
  649. (should
  650. (equal
  651. '("12" "12")
  652. (org-test-with-temp-text
  653. "* H
  654. :PROPERTIES:
  655. :A: 1
  656. :END:
  657. "
  658. (let ((org-columns-default-format "%5A")) (org-columns))
  659. (search-forward "1")
  660. (insert "2")
  661. (org-columns-update "A")
  662. (list (get-char-property (point-min) 'org-columns-value)
  663. (get-char-property (point-min) 'org-columns-value-modified)))))
  664. ;; When multiple columns are using the same property, value is
  665. ;; updated according to the specifications of the first one.
  666. (should
  667. (equal
  668. "2"
  669. (org-test-with-temp-text
  670. "* H
  671. :PROPERTIES:
  672. :A: 1
  673. :END:
  674. ** S
  675. :PROPERTIES:
  676. :A: 2
  677. :END:"
  678. (let ((org-columns-default-format "%A{min} %A")) (org-columns))
  679. (org-columns-update "A")
  680. (org-entry-get nil "A"))))
  681. (should
  682. (equal
  683. "1"
  684. (org-test-with-temp-text
  685. "* H
  686. :PROPERTIES:
  687. :A: 1
  688. :END:
  689. ** S
  690. :PROPERTIES:
  691. :A: 2
  692. :END:"
  693. (let ((org-columns-default-format "%A %A{min}")) (org-columns))
  694. (org-columns-update "A")
  695. (org-entry-get nil "A"))))
  696. ;; Ensure modifications propagate in upper levels even when multiple
  697. ;; summary types apply to the same property.
  698. (should
  699. (equal
  700. '("1" "22")
  701. (org-test-with-temp-text
  702. "* H
  703. ** S1
  704. :PROPERTIES:
  705. :A: 1
  706. :END:
  707. ** S2
  708. :PROPERTIES:
  709. :A: <point>2
  710. :END:"
  711. (save-excursion
  712. (goto-char (point-min))
  713. (let ((org-columns-default-format "%A{min} %A{max}")) (org-columns)))
  714. (insert "2")
  715. (org-columns-update "A")
  716. (list (get-char-property 1 'org-columns-value)
  717. (get-char-property 2 'org-columns-value-modified)))))
  718. ;; Ensure additional processing is done (e.g., ellipses, special
  719. ;; keywords fontification...).
  720. (should
  721. (equal
  722. "ve.. |"
  723. (org-test-with-temp-text
  724. "* H
  725. :PROPERTIES:
  726. :A: text
  727. :END:
  728. "
  729. (let ((org-columns-default-format "%4A")
  730. (org-columns-ellipses ".."))
  731. (org-columns))
  732. (search-forward ":A: ")
  733. (insert "very long ")
  734. (org-columns-update "A")
  735. (get-char-property (point-min) 'display))))
  736. ;; Values obtained from inline tasks are at the same level as those
  737. ;; obtained from children of the current node.
  738. (when (featurep 'org-inlinetask)
  739. (should
  740. (equal
  741. "2"
  742. (org-test-with-temp-text
  743. "* H
  744. *************** Inline task
  745. :PROPERTIES:
  746. :A: 2
  747. :END:
  748. *************** END
  749. ** Children
  750. :PROPERTIES:
  751. :A: 3
  752. :END:
  753. "
  754. (let ((org-columns-default-format "%A{min}")
  755. (org-columns-ellipses "..")
  756. (org-inlinetask-min-level 15))
  757. (org-columns))
  758. (get-char-property (point-min) 'org-columns-value)))))
  759. ;; Handle `org-columns-modify-value-for-display-function', even with
  760. ;; multiple titles for the same property.
  761. (should
  762. (equal '("foo" "bar")
  763. (org-test-with-temp-text "* H"
  764. (let ((org-columns-default-format "%ITEM %ITEM(Name)")
  765. (org-columns-modify-value-for-display-function
  766. (lambda (title value)
  767. (pcase title ("ITEM" "foo") ("Name" "bar") (_ "baz")))))
  768. (org-columns))
  769. (list (get-char-property 1 'org-columns-value-modified)
  770. (get-char-property 2 'org-columns-value-modified))))))
  771. ;;; Dynamic block
  772. (ert-deftest test-org-colview/dblock ()
  773. "Test the column view table."
  774. (should
  775. (equal
  776. "#+BEGIN: columnview
  777. | ITEM |
  778. |------|
  779. | H |
  780. #+END:"
  781. (org-test-with-temp-text
  782. "* H\n<point>#+BEGIN: columnview\n#+END:"
  783. (let ((org-columns-default-format "%ITEM")) (org-update-dblock))
  784. (buffer-substring-no-properties (point) (point-max)))))
  785. (should
  786. (equal
  787. "#+BEGIN: columnview
  788. | ITEM | A |
  789. |------+---|
  790. | H | 1 |
  791. #+END:"
  792. (org-test-with-temp-text
  793. "* H\n:PROPERTIES:\n:A: 1\n:END:\n<point>#+BEGIN: columnview\n#+END:"
  794. (let ((org-columns-default-format "%ITEM %A")) (org-update-dblock))
  795. (buffer-substring-no-properties (point) (point-max)))))
  796. ;; Properties are case insensitive.
  797. (should
  798. (equal
  799. "#+BEGIN: columnview
  800. | a |
  801. |---|
  802. | 1 |
  803. #+END:"
  804. (org-test-with-temp-text
  805. "* H\n:PROPERTIES:\n:A: 1\n:END:\n<point>#+BEGIN: columnview\n#+END:"
  806. (let ((org-columns-default-format "%a")) (org-update-dblock))
  807. (buffer-substring-no-properties (point) (point-max)))))
  808. ;; Test titles given to columns.
  809. (should
  810. (equal
  811. "#+BEGIN: columnview
  812. | Name | Prop |
  813. |------+------|
  814. | H | 1 |
  815. #+END:"
  816. (org-test-with-temp-text
  817. "* H\n:PROPERTIES:\n:A: 1\n:END:\n<point>#+BEGIN: columnview\n#+END:"
  818. (let ((org-columns-default-format "%ITEM(Name) %A(Prop)"))
  819. (org-update-dblock))
  820. (buffer-substring-no-properties (point) (point-max)))))
  821. ;; Test `:id' parameter
  822. (should
  823. (equal
  824. "#+BEGIN: columnview :id local
  825. | ITEM |
  826. |------|
  827. | H1 |
  828. | H1.1 |
  829. #+END:
  830. "
  831. (org-test-with-temp-text
  832. "* H1\n<point>#+BEGIN: columnview :id local\n#+END:\n** H1.1\n* H2"
  833. (let ((org-columns-default-format "%ITEM")) (org-update-dblock))
  834. (buffer-substring-no-properties (point) (outline-next-heading)))))
  835. (should
  836. (equal
  837. "#+BEGIN: columnview :id global
  838. | ITEM |
  839. |------|
  840. | H1 |
  841. | H1.1 |
  842. | H2 |
  843. #+END:
  844. "
  845. (org-test-with-temp-text
  846. "\n* H1\n<point>#+BEGIN: columnview :id global\n#+END:\n** H1.1\n* H2"
  847. (let ((org-columns-default-format "%ITEM")) (org-update-dblock))
  848. (buffer-substring-no-properties (point) (outline-next-heading)))))
  849. ;; Test `:hlines' parameter.
  850. (should
  851. (equal
  852. "#+BEGIN: columnview :hlines t :id global
  853. | ITEM |
  854. |------|
  855. | H |
  856. |------|
  857. | H2 |
  858. |------|
  859. | H2.1 |
  860. #+END:\n"
  861. (org-test-with-temp-text
  862. "
  863. * H
  864. <point>#+BEGIN: columnview :hlines t :id global
  865. #+END:
  866. * H2
  867. ** H2.1"
  868. (let ((org-columns-default-format "%ITEM")) (org-update-dblock))
  869. (buffer-substring-no-properties (point) (outline-next-heading)))))
  870. (should
  871. (equal
  872. "#+BEGIN: columnview :hlines 1 :id global
  873. | ITEM |
  874. |------|
  875. | H |
  876. |------|
  877. | H2 |
  878. | H2.1 |
  879. #+END:\n"
  880. (org-test-with-temp-text
  881. "
  882. * H
  883. <point>#+BEGIN: columnview :hlines 1 :id global
  884. #+END:
  885. * H2
  886. ** H2.1"
  887. (let ((org-columns-default-format "%ITEM")) (org-update-dblock))
  888. (buffer-substring-no-properties (point) (outline-next-heading)))))
  889. ;; Test `:indent' parameter.
  890. (should
  891. (equal
  892. "#+BEGIN: columnview :indent t
  893. | ITEM |
  894. |----------|
  895. | H1 |
  896. | \\_ H1.1 |
  897. #+END:
  898. "
  899. (org-test-with-temp-text
  900. "* H1\n<point>#+BEGIN: columnview :indent t\n#+END:\n** H1.1"
  901. (let ((org-columns-default-format "%ITEM")) (org-update-dblock))
  902. (buffer-substring-no-properties (point) (outline-next-heading)))))
  903. (should
  904. (equal
  905. "#+BEGIN: columnview :indent t
  906. | Prop | Name |
  907. |------+----------|
  908. | | H1 |
  909. | | \\_ H1.1 |
  910. #+END:
  911. "
  912. (org-test-with-temp-text
  913. "* H1\n<point>#+BEGIN: columnview :indent t\n#+END:\n** H1.1"
  914. (let ((org-columns-default-format "%A(Prop) %ITEM(Name)"))
  915. (org-update-dblock))
  916. (buffer-substring-no-properties (point) (outline-next-heading)))))
  917. ;; Test `:vlines' parameter.
  918. (should
  919. (equal
  920. "#+BEGIN: columnview :vlines t
  921. | | ITEM | A |
  922. |---+------+----|
  923. | | H | 1 |
  924. | / | <> | <> |
  925. #+END:"
  926. (org-test-with-temp-text
  927. "* H\n:PROPERTIES:\n:A: 1\n:END:\n<point>#+BEGIN: columnview :vlines t\n#+END:"
  928. (let ((org-columns-default-format "%ITEM %A")) (org-update-dblock))
  929. (buffer-substring-no-properties (point) (point-max)))))
  930. ;; Test `:skip-empty-rows' parameter.
  931. (should
  932. (equal
  933. "#+BEGIN: columnview :skip-empty-rows t
  934. | ITEM | A |
  935. |------+---|
  936. | H1.1 | 1 |
  937. #+END:
  938. "
  939. (org-test-with-temp-text
  940. "
  941. * H1
  942. <point>#+BEGIN: columnview :skip-empty-rows t
  943. #+END:
  944. ** H1.1
  945. :PROPERTIES:
  946. :A: 1
  947. :END:"
  948. (let ((org-columns-default-format "%ITEM %A")) (org-update-dblock))
  949. (buffer-substring-no-properties (point) (outline-next-heading)))))
  950. ;; Test `:format' parameter.
  951. (should
  952. (equal
  953. "#+BEGIN: columnview :format \"%ITEM(Name)\"
  954. | Name |
  955. |------|
  956. | H |
  957. #+END:"
  958. (org-test-with-temp-text
  959. "* H\n<point>#+BEGIN: columnview :format \"%ITEM(Name)\"\n#+END:"
  960. (let ((org-columns-default-format "%ITEM")) (org-update-dblock))
  961. (buffer-substring-no-properties (point) (point-max)))))
  962. ;; Test `:width' parameter
  963. (should
  964. (equal
  965. "#+BEGIN: columnview :width t
  966. | ITEM | A |
  967. |------------+---|
  968. | H | |
  969. | <10> | |
  970. #+END:"
  971. (org-test-with-temp-text
  972. "* H\n<point>#+BEGIN: columnview :width t\n#+END:"
  973. (let ((org-columns-default-format "%10ITEM %A")) (org-update-dblock))
  974. (buffer-substring-no-properties (point) (point-max)))))
  975. ;; When inserting ITEM values, make sure to clean sensitive
  976. ;; contents, like unique targets or forbidden inline src-blocks.
  977. (should
  978. (equal
  979. "#+BEGIN: columnview
  980. | ITEM |
  981. |------|
  982. | H 1 |
  983. #+END:"
  984. (org-test-with-temp-text
  985. "* H <<target>> 1\n<point>#+BEGIN: columnview\n#+END:"
  986. (let ((org-columns-default-format "%ITEM")) (org-update-dblock))
  987. (buffer-substring-no-properties (point) (point-max)))))
  988. (should
  989. (equal
  990. "#+BEGIN: columnview
  991. | ITEM |
  992. |------|
  993. | H 1 |
  994. #+END:"
  995. (org-test-with-temp-text
  996. "* H src_emacs-lisp{(+ 1 1)} 1\n<point>#+BEGIN: columnview\n#+END:"
  997. (let ((org-columns-default-format "%ITEM")) (org-update-dblock))
  998. (buffer-substring-no-properties (point) (point-max))))))
  999. (provide 'test-org-colview)
  1000. ;;; test-org-colview.el ends here