org-mode/testing/lisp/test-org-colview.el
Ihor Radchenko fc80d052db
Re-implement org-element-cache and add headline support
* lisp/org-element.el (org-element-with-disabled-cache): New macro.

(org-element-greater-elements): Add new org-data element.  It
functions like a virtual headline containing the whole buffer.  The
org-data properties are like headlie properties, but according to the
top-level drawer.  org-data's category is the buffer's category as
defined by top-level property drawer, #+CATEGORY keyworsd, and the
buffer file name.

(org-element--cache-element-properties, org-element-set-element): New
variable containing properties to be transferred when updating changed
element in cache in `org-element-set-element'.

(org-element--get-node-properties): Allow parsing node propreties in
top-level drawer when new optional argument is passed.  Respect
PROPERTY+ syntax.

(org-element--get-global-node-properties): New function.  It returns
node properties for top-level property drawer.

(org-element-org-data-parser, org-element-org-data-interpreter):
Implement the new org-data element.

(org-element-headline-parser, org-element-section-parser): Add new
:robust-begin and :robust-end
properties delimiting safe changes that do not modify headline
element.

(org-element--list-struct): Fix cache update when adding a headline
inside list.

(org-element--current-element): Implement cache support.  Record
parsing mode (:mode) and parsing granularity (:granularity) in the
element properties.

(org-element-parse-buffer, org-element--next-mode): Support new
org-data element.

(org-element--parse-elements): Record parsing granularity in the
returned tree

(org-element-use-cache): Enable cache by default.

(org-element-cache-persistent): New variable controlling cache
persistance across sessions.  Enabled by default.

(org-element--cache-self-verify,
org-element--cache-self-verify-frequency,
org-element--cache-diagnostics, org-element--cache-map-statistics,
org-element--cache-map-statistics-threshold,
org-element--cache-diagnostics-level,
org-element--cache-diagnostics-ring,
org-element--cache-diagnostics-ring-size): New variables controlling
cache diagnostics and self-diagnostics.  Greatly simplifies cache
debugging.

(org-element--cache, org-element--cache-sync-requests,
org-element--cache-sync-timer): Make cache buffer-local by default.

(org-element--headline-cache): Implement separate cache storing only
headlines and inlinetasks.

(org-element--cache-size, org-element--headline-cache-size): New
variables containing cache sizes.  This is much faster than
`avl-tree-size'.

(org-element--cache-sync-requests): Update docstring explaning the
request list structure.

(org-element--cache-sync-keys-value): New variable replacing
`org-element--cache-sync-keys' hash table.  The hash table was not
reliable because it was using elements as keys.  Upon any cached
element update/shift, the keys were invalidated making cache ordering
incorrect and breaking the cache badly.  Now, the cache keys are
stored as :org-element--cache-sync-key element property and the new
variable stores marker value indicating the current sync request
cycle.  See `org-element--cache-key' for more details.

(org-element--cache-change-tic): New variable controlling buffer
modification count that is registered in cache.  This variable allows
catching "stealth" edits.

(org-element--cache-non-modifying-commands): New variable listing
commands that will not be slown down if we fill cache on the fly.

(org-element--request-key, org-element--request-beg,
org-element--request-end, org-element--request-offset,
org-element--request-parent, org-element--request-phase): New macros.
They improve code readability (especially when using nameless-mode).

(org-element--format-element, org-element--cache-log-message,
org-element--cache-warn): New macros implementing generic logging
functionality.

(org-element--cache-key): Add section and org-data element support.
Change cache key storage from hash map to :org-element--cache-sync-key
element property + `org-element--cache-sync-keys-value'.  We use the
latter to group all the cache keys during a single cache request
sequence.  Once sync request is fully complete, the
`org-element--cache-sync-keys-value' is updated making all the old
sync keys obsolete (they will still be store as element properties).

(org-element--headline-cache-root): New function returning headline
cache root.

(org-element--cache-active-p): Prevent cache updates when
`inhibit-modification-hooks' is non-nil, unless non-nil optional
argument is provided.

(org-element--cache-find): Share cache between indirect buffers and
the base buffer.  We have to do it because after-change hooks for
indirect buffer are not called in the base buffer and vice versa.  Add
support for section and org-data elements.

(org-element--cache-put): Implement new approach for cache key
storage.  Add diagnostics.  Indicate cached elements using :cached
element property.  Support cache size calculation.

(org-element--cache-remove): Invalidate parent contents when removing
element.  Support cache size calculation.  Detect cache corruption due
to misordered elements.

(org-element--cache-shift-positions): Support :robust-begin and
:robust-end element properties.

(org-element--cache-sync): Add diagnostics.  Add detailed comments.
Prevent slowdown when large cache chunks need to be deleted forcing
O(N) complexity cutoff.  In phase 2, fix cases when next request
contains deleted cache key.  In phase 2, fix scenario when newly
inserted element intersects with existing elements in cache.  In phase
2, detect obsolete parents removed from cache.

(org-element--open-end-p): New function checking if an element can
have blank lines right after its :contents-end.

(org-element--parse-to): Do not alter match data.  Process complex
parsing mode changes correctly.  Support headlines in cache.  Support
org-data parsing.  Add detailed comments.  Add diagnostics.

(org-element--cache-sensitive-re): Make list lines sensitive.

(org-element--cache-change-warning): Update docstring.  Now, the
variable can have t, nil, and number values.  Numbers are used to
provide more details about changed headlines.

(org-element--cache-before-change, org-element--cache-after-change):
Handle headline hierarchy.  Properly handle cache in indirect
buffers.

(org-element--cache-after-change): Update docstring clarifying the
return values.  Add special handling for headline and org-data
elements updating them in-place instead of removing together with the
whole contents when possible.  Use :robust-begin/:robust-end element
properties to detect robust changes.

(org-element--cache-submit-request): Add detailed comments.  Correctly
handle cache in indirect buffers.  Delegate element modifications to
`org-element--cache-for-removal'.

(org-element--cache-verify-element): New function for cache
self-verification.

(org-element--cache-persist-before-write,
org-element--cache-persist-before-read,
org-element--cache-persist-after-read): Implement cache persistance.

(org-element-cache-reset): Correctly handle cache in indirect
buffers.  Support cache persistance.  Support new cache size
calculation and new cache key schema.

(org-element-cache-map): New function analagous to `org-element-map',
but much faster.  The function overperforms org-ql written by Adam
Porter aka alphapapa [1] and reuses some ideas from there (namely,
fast element skipping via regexps).

[1] https://github.com/alphapapa/org-ql/

(org-element-at-point): The returned elements are now guaranteed to
have correct parents up to org-data.  New optional argument
CACHED-ONLY limits element search to current cache---if element is not
in cache and current command is not in cache
`org-element--cache-non-modifying-commands', the cache is not updated
and the function returns nil.  Also, support cache verification.

(org-element-at-point-no-context): New function.  It is analogous of
older `org-element-at-point' with no guarantee that :parent properties
are correct beyond direct parent heading.  This function does not
update cache and can be useful when cache updates should be avoided
for performance reasons.

* lisp/ob-core.el (org-babel-where-is-src-block-result): Support
section and org-data elements in cache.

* lisp/org-macro.el (org-macro-replace-all,
org-macro--find-keyword-value): Support org-element-cache.

* lisp/org-table.el (orgtbl-to-generic): Support org-element-cache.

* lisp/org.el (org-mode): Add cache persistance.

(org-up-element): Preserve old behaviour when error is returned for
section and org-data element.

*
testing/lisp/test-org-archive.el (test-org-archive/update-status-cookie):
Fix test when cache is active.

* testing/lisp/test-org-colview.el (test-org-colview/columns-update):
Fix test.

* testing/lisp/test-org-element.el (test-org-element/extract-element):
Add suport for new org-data element.

* testing/lisp/test-org-element.el (test-org-element/parent-property):
Fix equality check.  Parents returned by cache and `org-element-map'
may not be `eq' now.  Just `equal'.

* testing/lisp/test-org-element.el (test-org-element/context): Support
section and headline parents.
2021-10-16 23:22:18 +08:00

1544 lines
40 KiB
EmacsLisp
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

;;; test-org-colview.el --- Tests for org-colview.el -*- lexical-binding: t; -*-
;; Copyright (C) 2016, 2019 Nicolas Goaziou
;; Author: Nicolas Goaziou <mail@nicolasgoaziou.fr>
;; This program is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
;; This program is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
;; GNU General Public License for more details.
;; You should have received a copy of the GNU General Public License
;; along with this program. If not, see <https://www.gnu.org/licenses/>.
;;; Code:
;;; Column view
(require 'cl-lib)
(ert-deftest test-org-colview/get-format ()
"Test `org-columns-get-format' specifications."
;; Without any clue, use `org-columns-default-format'.
(should
(equal "%A"
(org-test-with-temp-text "* H"
(let ((org-columns-default-format "%A"))
(org-columns-get-format)))))
;; If COLUMNS keyword is set, use it.
(should
(equal "%B"
(org-test-with-temp-text "#+COLUMNS: %B\n* H"
(let ((org-columns-default-format "%A"))
(org-columns-get-format)))))
(should
(equal "%B"
(org-test-with-temp-text "#+columns: %B\n* H"
(let ((org-columns-default-format "%A"))
(org-columns-get-format)))))
(should
(equal "%B"
(org-test-with-temp-text "* H\n#+COLUMNS: %B"
(let ((org-columns-default-format "%A"))
(org-columns-get-format)))))
;; When :COLUMNS: property is set somewhere in the tree, use it over
;; the previous ways.
(should
(equal
"%C"
(org-test-with-temp-text
"#+COLUMNS: %B\n* H\n:PROPERTIES:\n:COLUMNS: %C\n:END:\n** S\n<point>"
(let ((org-columns-default-format "%A"))
(org-columns-get-format)))))
;; When optional argument is provided, prefer it.
(should
(equal
"%D"
(org-test-with-temp-text
"#+COLUMNS: %B\n* H\n:PROPERTIES:\n:COLUMNS: %C\n:END:\n** S\n<point>"
(let ((org-columns-default-format "%A"))
(org-columns-get-format "%D"))))))
(ert-deftest test-org-colview/columns-scope ()
"Test `org-columns' scope."
;; Before the first headline, view all document.
(should
(equal
'("H1" "H2" "H3")
(org-test-with-temp-text "Top\n* H1\n** H2\n* H3"
(let ((org-columns-default-format "%ITEM")) (org-columns))
(org-map-entries
(lambda () (get-char-property (point) 'org-columns-value))))))
;; When :COLUMNS: is set up in the hierarchy, view tree starting
;; there.
(should
(equal
'(nil "H2" "H3" nil)
(org-test-with-temp-text
"* H1\n** H2\n:PROPERTIES:\n:COLUMNS: %ITEM\n:END:\n*** <point>H3\n* H4"
(let ((org-columns-default-format "%ITEM")) (org-columns))
(org-map-entries
(lambda () (get-char-property (point) 'org-columns-value))))))
;; Otherwise, view tree starting at the current headline.
(should
(equal
'(nil "H2" "H3" nil)
(org-test-with-temp-text "Top\n* H1\n** <point>H2\n*** H3\n* H4"
(let ((org-columns-default-format "%ITEM")) (org-columns))
(org-map-entries
(lambda () (get-char-property (point) 'org-columns-value))))))
;; With a non-nil prefix argument, always view all document.
(should
(equal
'("H1" "H2" "H3" "H4")
(org-test-with-temp-text
"* H1\n** H2\n:PROPERTIES:\n:COLUMNS: %ITEM\n:END:\n*** <point>H3\n* H4"
(let ((org-columns-default-format "%ITEM")) (org-columns t))
(org-map-entries
(lambda () (get-char-property (point) 'org-columns-value))))))
(should
(equal
'("1" "1")
(org-test-with-temp-text
"Top\n* H1\n** <point>H2\n:PROPERTIES:\n:A: 1\n:END:"
(let ((org-columns-default-format "%A{+}")) (org-columns t))
(org-map-entries
(lambda () (get-char-property (point) 'org-columns-value)))))))
(ert-deftest test-org-colview/columns-width ()
"Test `org-columns' column widths."
;; When a width is specified in the format, use it.
(should
(= 9
(org-test-with-temp-text "* H"
(let ((org-columns-default-format "%9ITEM")) (org-columns))
(aref org-columns-current-maxwidths 0))))
;; Otherwise, use the width of the largest value in the column.
(should
(= 2
(org-test-with-temp-text
"* H\n:PROPERTIES:\n:P: X\n:END:\n** H2\n:PROPERTIES:\n:P: XX\n:END:"
(let ((org-columns-default-format "%P")) (org-columns))
(aref org-columns-current-maxwidths 0))))
;; If the title is wider than the widest value, use title width
;; instead.
(should
(= 4
(org-test-with-temp-text "* H"
(let ((org-columns-default-format "%ITEM")) (org-columns))
(aref org-columns-current-maxwidths 0))))
;; Special case: stars do count for ITEM.
(should
(= 6
(org-test-with-temp-text "* Head"
(let ((org-columns-default-format "%ITEM")) (org-columns))
(aref org-columns-current-maxwidths 0))))
;; Special case: width takes into account link narrowing in ITEM.
(should
(equal
'("* 123" . 5)
(org-test-with-temp-text "* [[https://orgmode.org][123]]"
(let ((org-columns-default-format "%ITEM")) (org-columns))
(cons (get-char-property (point) 'org-columns-value-modified)
(aref org-columns-current-maxwidths 0)))))
;; When a value is too wide for the current column, add ellipses.
;; Take into consideration length of `org-columns-ellipses'.
(should
(equal "123.. |"
(org-test-with-temp-text "* H\n:PROPERTIES:\n:P: 123456\n:END:"
(let ((org-columns-default-format "%5P")
(org-columns-ellipses ".."))
(org-columns))
(org-trim (get-char-property (point) 'display)))))
(should
(equal "1234… |"
(org-test-with-temp-text "* H\n:PROPERTIES:\n:P: 123456\n:END:"
(let ((org-columns-default-format "%5P")
(org-columns-ellipses ""))
(org-columns))
(org-trim (get-char-property (point) 'display))))))
(ert-deftest test-org-colview/columns-summary ()
"Test `org-columns' summary types."
;; {+} and {+;format} add numbers.
(should
(equal
"3"
(org-test-with-temp-text
"* H
** S1
:PROPERTIES:
:A: 1
:END:
** S1
:PROPERTIES:
:A: 2
:END:"
(let ((org-columns-default-format "%A{+}")) (org-columns))
(get-char-property (point) 'org-columns-value-modified))))
(should
(equal
"3.0"
(org-test-with-temp-text
"* H
** S1
:PROPERTIES:
:A: 1
:END:
** S1
:PROPERTIES:
:A: 2
:END:"
(let ((org-columns-default-format "%A{+;%.1f}")) (org-columns))
(get-char-property (point) 'org-columns-value-modified))))
;; {$} is a shortcut for {+;%.2f}.
(should
(equal
"3.60"
(org-test-with-temp-text
"* H
** S1
:PROPERTIES:
:A: 1.50
:END:
** S1
:PROPERTIES:
:A: 2.10
:END:"
(let ((org-columns-default-format "%A{$}")) (org-columns))
(get-char-property (point) 'org-columns-value-modified))))
;; Obey to format string even in leaf values.
(should
(equal
"1.0"
(org-test-with-temp-text
"* H
:PROPERTIES:
:A: 1
:END:"
(let ((org-columns-default-format "%A{+;%.1f}")) (org-columns))
(get-char-property (point) 'org-columns-value-modified))))
;; {:} sums times. Plain numbers are minutes.
(should
(equal
"4:10"
(org-test-with-temp-text
"* H
** S1
:PROPERTIES:
:A: 1:30
:END:
** S1
:PROPERTIES:
:A: 2:40
:END:"
(let ((org-columns-default-format "%A{:}")) (org-columns))
(get-char-property (point) 'org-columns-value-modified))))
(should
(equal
"1:32"
(org-test-with-temp-text
"* H
** S1
:PROPERTIES:
:A: 1:30
:END:
** S1
:PROPERTIES:
:A: 2
:END:"
(let ((org-columns-default-format "%A{:}")) (org-columns))
(get-char-property (point) 'org-columns-value-modified))))
;; {X}, {X/} and {X%} indicate checkbox status.
(should
(equal
"[ ]"
(org-test-with-temp-text
"* H
** S1
:PROPERTIES:
:A: [ ]
:END:
** S1
:PROPERTIES:
:A: [ ]
:END:"
(let ((org-columns-default-format "%A{X}")) (org-columns))
(get-char-property (point) 'org-columns-value-modified))))
(should
(equal
"[-]"
(org-test-with-temp-text
"* H
** S1
:PROPERTIES:
:A: [ ]
:END:
** S1
:PROPERTIES:
:A: [X]
:END:"
(let ((org-columns-default-format "%A{X}")) (org-columns))
(get-char-property (point) 'org-columns-value-modified))))
(should
(equal
"[X]"
(org-test-with-temp-text
"* H
** S1
:PROPERTIES:
:A: [X]
:END:
** S1
:PROPERTIES:
:A: [X]
:END:"
(let ((org-columns-default-format "%A{X}")) (org-columns))
(get-char-property (point) 'org-columns-value-modified))))
(should
(equal
"[1/2]"
(org-test-with-temp-text
"* H
** S1
:PROPERTIES:
:A: [ ]
:END:
** S1
:PROPERTIES:
:A: [X]
:END:"
(let ((org-columns-default-format "%A{X/}")) (org-columns))
(get-char-property (point) 'org-columns-value-modified))))
(should
(equal
"[50%]"
(org-test-with-temp-text
"* H
** S1
:PROPERTIES:
:A: [ ]
:END:
** S1
:PROPERTIES:
:A: [X]
:END:"
(let ((org-columns-default-format "%A{X%}")) (org-columns))
(get-char-property (point) 'org-columns-value-modified))))
;; {X/} handles recursive summaries.
(should
(equal
"[1/2]"
(org-test-with-temp-text
"* H
** S1
:PROPERTIES:
:A: [ ]
:END:
** S2
*** S21
:PROPERTIES:
:A: [X]
:END:
*** S22
:PROPERTIES:
:A: [X]
:END:"
(let ((org-columns-default-format "%A{X/}")) (org-columns))
(get-char-property (point) 'org-columns-value-modified))))
(should
(equal
"[1/2]"
(org-test-with-temp-text
"* H
** S1
:PROPERTIES:
:A: [X]
:END:
** S2
*** S21
:PROPERTIES:
:A: [ ]
:END:
*** S22
:PROPERTIES:
:A: [ ]
:END:"
(let ((org-columns-default-format "%A{X/}")) (org-columns))
(get-char-property (point) 'org-columns-value-modified))))
;; {X%} handles recursive summaries.
(should
(equal
"[50%]"
(org-test-with-temp-text
"* H
** S1
:PROPERTIES:
:A: [ ]
:END:
** S2
*** S21
:PROPERTIES:
:A: [X]
:END:
*** S22
:PROPERTIES:
:A: [X]
:END:"
(let ((org-columns-default-format "%A{X%}")) (org-columns))
(get-char-property (point) 'org-columns-value-modified))))
(should
(equal
"[50%]"
(org-test-with-temp-text
"* H
** S1
:PROPERTIES:
:A: [X]
:END:
** S2
*** S21
:PROPERTIES:
:A: [ ]
:END:
*** S22
:PROPERTIES:
:A: [ ]
:END:"
(let ((org-columns-default-format "%A{X%}")) (org-columns))
(get-char-property (point) 'org-columns-value-modified))))
;; {min} is the smallest number in column, {max} the largest one.
;; {mean} is the arithmetic mean of numbers in column.
(should
(equal
"42"
(org-test-with-temp-text
"* H
** S1
:PROPERTIES:
:A: 99
:END:
** S1
:PROPERTIES:
:A: 42
:END:"
(let ((org-columns-default-format "%A{min}")) (org-columns))
(get-char-property (point) 'org-columns-value-modified))))
(should
(equal
"99"
(org-test-with-temp-text
"* H
** S1
:PROPERTIES:
:A: 99
:END:
** S1
:PROPERTIES:
:A: 42
:END:"
(let ((org-columns-default-format "%A{max}")) (org-columns))
(get-char-property (point) 'org-columns-value-modified))))
(should
(equal
"51.0"
(org-test-with-temp-text
"* H
** S1
:PROPERTIES:
:A: 60
:END:
** S1
:PROPERTIES:
:A: 42
:END:"
(let ((org-columns-default-format "%A{mean}")) (org-columns))
(get-char-property (point) 'org-columns-value-modified))))
;; {:min}, {:max} and {:mean} apply to time values.
(should
(equal
"1:20"
(org-test-with-temp-text
"* H
** S1
:PROPERTIES:
:A: 4:40
:END:
** S1
:PROPERTIES:
:A: 1:20
:END:"
(let ((org-columns-default-format "%A{:min}")) (org-columns))
(get-char-property (point) 'org-columns-value-modified))))
(should
(equal
"4:40"
(org-test-with-temp-text
"* H
** S1
:PROPERTIES:
:A: 4:40
:END:
** S1
:PROPERTIES:
:A: 1:20
:END:"
(let ((org-columns-default-format "%A{:max}")) (org-columns))
(get-char-property (point) 'org-columns-value-modified))))
(should
(equal
"3:00"
(org-test-with-temp-text
"* H
** S1
:PROPERTIES:
:A: 4:40
:END:
** S1
:PROPERTIES:
:A: 1:20
:END:"
(let ((org-columns-default-format "%A{:mean}")) (org-columns))
(get-char-property (point) 'org-columns-value-modified))))
;; {@min}, {@max} and {@mean} apply to ages.
(should
(equal
"0min"
(org-test-at-time "<2014-03-04 Tue>"
(org-test-with-temp-text
"* H
** S1
:PROPERTIES:
:A: <2012-03-29 Thu>
:END:
** S1
:PROPERTIES:
:A: <2014-03-04 Tue>
:END:"
(let ((org-columns-default-format "%A{@min}")) (org-columns))
(get-char-property (point) 'org-columns-value-modified)))))
(should
(equal
"2d"
(org-test-at-time "<2014-03-04 Tue>"
(org-test-with-temp-text
"* H
** S1
:PROPERTIES:
:A: <2014-03-03 Mon>
:END:
** S1
:PROPERTIES:
:A: <2014-03-02 Sun>
:END:"
(let ((org-columns-default-format "%A{@max}")) (org-columns))
(get-char-property (point) 'org-columns-value-modified)))))
(should
(equal
"1d 12h"
(org-test-at-time "<2014-03-04 Tue>"
(org-test-with-temp-text
"* H
** S1
:PROPERTIES:
:A: <2014-03-03 Mon>
:END:
** S1
:PROPERTIES:
:A: <2014-03-02 Sun>
:END:"
(let ((org-columns-default-format "%A{@mean}")) (org-columns))
(get-char-property (point) 'org-columns-value-modified)))))
;; If a time value is expressed as a duration, return a duration.
;; If any of them follows H:MM:SS pattern, use it too. Also handle
;; combinations of duration and H:MM:SS patterns.
(should
(equal
"3d 4:20"
(org-test-with-temp-text
"* H
** S1
:PROPERTIES:
:A: 3d 3h
:END:
** S1
:PROPERTIES:
:A: 1:20
:END:"
(let ((org-columns-default-format "%A{:}")
(org-duration-units '(("d" . 1440) ("h" . 60)))
(org-duration-format '(("d" . nil) (special . h:mm))))
(org-columns))
(get-char-property (point) 'org-columns-value-modified))))
(should
(equal
"6:00:10"
(org-test-with-temp-text
"* H
** S1
:PROPERTIES:
:A: 4:40:10
:END:
** S1
:PROPERTIES:
:A: 1:20
:END:"
(let ((org-columns-default-format "%A{:}")) (org-columns))
(get-char-property (point) 'org-columns-value-modified))))
(should
(equal
"3d 4:20"
(org-test-with-temp-text
"* H
** S1
:PROPERTIES:
:A: 3d 3h
:END:
** S1
:PROPERTIES:
:A: 0d 1:20
:END:"
(let ((org-columns-default-format "%A{:}")
(org-duration-units '(("d" . 1440) ("h" . 60)))
(org-duration-format '(("d" . nil) (special . h:mm))))
(org-columns))
(get-char-property (point) 'org-columns-value-modified))))
;; @min, @max and @mean also accept regular duration.
(should
(equal
"1d 10h"
(org-test-with-temp-text
"* H
** S1
:PROPERTIES:
:A: 1d 10h 0min
:END:
** S1
:PROPERTIES:
:A: 5d 3h
:END:"
(let ((org-columns-default-format "%A{@min}")) (org-columns))
(get-char-property (point) 'org-columns-value-modified))))
;; {est+} gives a low-high estimate using mean and standard
;; deviation.
(should
(equal
"3-17"
(org-test-with-temp-text
"* H
** S1
:PROPERTIES:
:A: 0-10
:END:
** S1
:PROPERTIES:
:A: 0-10
:END:"
(let ((org-columns-default-format "%A{est+}")) (org-columns))
(get-char-property (point) 'org-columns-value-modified))))
;; When using {est+} summary, a single number is understood as
;; a degenerate range.
(should
(equal
"4-4"
(org-test-with-temp-text
"* H
** S1
:PROPERTIES:
:A: 4
:END:
"
(let ((org-columns-default-format "%A{est+}")) (org-columns))
(get-char-property (point) 'org-columns-value-modified))))
;; Allow custom summary types.
(should
(equal
"1|2"
(org-test-with-temp-text
"* H
** S1
:PROPERTIES:
:A: 1
:END:
** S1
:PROPERTIES:
:A: 2
:END:"
(let ((org-columns-summary-types
'(("custom" . (lambda (s _) (mapconcat #'identity s "|")))))
(org-columns-default-format "%A{custom}")) (org-columns))
(get-char-property (point) 'org-columns-value-modified))))
;; Allow custom _collect_ for summary types.
(should
(equal
"2"
(org-test-with-temp-text
"* H
** S1
:PROPERTIES:
:A: 1
:END:
** S1
:PROPERTIES:
:A: 2
:A-OK: 1
:END:"
(let ((org-columns-summary-types
'(("custom" org-columns--summary-sum
(lambda (p)
(if (equal "1" (org-entry-get nil (format "%s-OK" p)))
(org-entry-get nil p)
"")))))
(org-columns-default-format "%A{custom}")) (org-columns))
(get-char-property (point) 'org-columns-value-modified))))
;; Allow custom collect function to be used for different columns
(should
(equal
'("2" "1")
(org-test-with-temp-text
"* H
** S1
:PROPERTIES:
:A: 1
:B: 1
:B-OK: 1
:END:
** S1
:PROPERTIES:
:A: 2
:B: 2
:A-OK: 1
:END:"
(let ((org-columns-summary-types
'(("custom" org-columns--summary-sum
(lambda (p)
(if (equal "1" (org-entry-get nil (format "%s-OK" p)))
(org-entry-get nil p)
"")))))
(org-columns-default-format "%A{custom} %B{custom}")) (org-columns))
(list (get-char-property (point) 'org-columns-value-modified)
(get-char-property (1+ (point)) 'org-columns-value-modified)))))
;; Allow multiple summary types applied to the same property.
(should
(equal
'("42" "99")
(org-test-with-temp-text
"* H
** S1
:PROPERTIES:
:A: 99
:END:
** S1
:PROPERTIES:
:A: 42
:END:"
(let ((org-columns-default-format "%A{min} %A{max}")) (org-columns))
(list (get-char-property (point) 'org-columns-value-modified)
(get-char-property (1+ (point)) 'org-columns-value-modified)))))
;; Allow mixing both summarized and non-summarized columns for
;; a property. However, the first column takes precedence and
;; updates the value.
(should
(equal
'("1000" "42")
(org-test-with-temp-text
"* H
:PROPERTIES:
:A: 1000
:END:
** S1
:PROPERTIES:
:A: 99
:END:
** S1
:PROPERTIES:
:A: 42
:END:"
(let ((org-columns-default-format "%A %A{min}")) (org-columns))
(list (get-char-property (point) 'org-columns-value-modified)
(get-char-property (1+ (point)) 'org-columns-value-modified)))))
(should
(equal
'("42" "42")
(org-test-with-temp-text
"* H
:PROPERTIES:
:A: 1000
:END:
** S1
:PROPERTIES:
:A: 99
:END:
** S1
:PROPERTIES:
:A: 42
:END:"
(let ((org-columns-default-format "%A{min} %A")) (org-columns))
(list (get-char-property (point) 'org-columns-value-modified)
(get-char-property (1+ (point)) 'org-columns-value-modified))))))
(ert-deftest test-org-colview/columns-new ()
"Test `org-columns-new' specifications."
;; Insert new column at the left of the current one.
(should
(equal '("FOO" "ITEM")
(org-test-with-temp-text "* H"
(let ((org-columns-default-format "%ITEM")) (org-columns))
(org-columns-new nil "FOO" "FOO" nil nil nil)
(list (get-char-property (point) 'org-columns-key)
(get-char-property (1+ (point)) 'org-columns-key)))))
(should
(equal '("ITEM" "FOO" "BAR")
(org-test-with-temp-text "* H"
(let ((org-columns-default-format "%ITEM %BAR")) (org-columns))
(forward-char)
(org-columns-new nil "FOO" "FOO" nil nil nil)
(list (get-char-property (1- (point)) 'org-columns-key)
(get-char-property (point) 'org-columns-key)
(get-char-property (1+ (point)) 'org-columns-key)))))
;; Update #+COLUMNS keyword if needed.
(should
(equal "#+COLUMNS: %FOO %ITEM"
(org-test-with-temp-text "#+COLUMNS: %ITEM\n<point>* H"
(let ((org-columns-default-format "%ITEM")) (org-columns))
(org-columns-new nil "FOO" "FOO" nil nil nil)
(goto-char (point-min))
(buffer-substring-no-properties (point) (line-end-position)))))
(should
(equal "#+COLUMNS: %ITEM %FOO %BAR"
(org-test-with-temp-text "#+COLUMNS: %ITEM %BAR\n<point>* H"
(let ((org-columns-default-format "%ITEM %BAR")) (org-columns))
(forward-char)
(org-columns-new nil "FOO" "FOO" nil nil nil)
(goto-char (point-min))
(buffer-substring-no-properties (point) (line-end-position)))))
;; Mind case when updating #+COLUMNS.
(should
(equal "#+COLUMNS: %ITEM %Foo %BAR"
(org-test-with-temp-text "#+COLUMNS: %ITEM %BAR\n<point>* H"
(let ((org-columns-default-format "%ITEM %BAR")) (org-columns))
(forward-char)
(org-columns-new nil "Foo" "Foo" nil nil nil)
(goto-char (point-min))
(buffer-substring-no-properties (point) (line-end-position)))))
(should
(equal "#+columns: %ITEM %Foo %BAR"
(org-test-with-temp-text "#+columns: %ITEM %BAR\n<point>* H"
(let ((org-columns-default-format "%ITEM %BAR")) (org-columns))
(forward-char)
(org-columns-new nil "Foo" "Foo" nil nil nil)
(goto-char (point-min))
(buffer-substring-no-properties (point) (line-end-position)))))
;; Also update :COLUMNS: properties.
(should
(equal "%FOO %ITEM"
(org-test-with-temp-text "* H\n:PROPERTIES:\n:COLUMNS: %ITEM\n:END:"
(let ((org-columns-default-format "%ITEM")) (org-columns))
(org-columns-new nil "FOO" "FOO" nil nil nil)
(org-entry-get nil "COLUMNS"))))
;; If no keyword nor any property is available, insert one.
(should
(string-match-p (regexp-quote "#+COLUMNS: %FOO %ITEM")
(org-test-with-temp-text "* H"
(let ((org-columns-default-format "%ITEM")) (org-columns))
(org-columns-new nil "FOO" "FOO" nil nil nil)
(buffer-string)))))
(ert-deftest test-org-colview/columns-update ()
"Test `org-columns-update' specifications."
;; Update display.
(should
(equal
"12 |"
(org-test-with-temp-text
"* H
:PROPERTIES:
:A: 1
:END:
"
(let ((org-columns-default-format "%5A")) (org-columns))
(search-forward "1")
(insert "2")
(org-columns-update "A")
(get-char-property (point-min) 'display))))
;; Update is case-insensitive.
(should
(equal
"12 |"
(org-test-with-temp-text
"* H
:PROPERTIES:
:A: 1
:END:
"
(let ((org-columns-default-format "%5A")) (org-columns))
(search-forward "1")
(insert "2")
(org-columns-update "a")
(get-char-property (point-min) 'display))))
;; Update stored values.
(should
(equal
'("12" "12")
(org-test-with-temp-text
"* H
:PROPERTIES:
:A: 1
:END:
"
(let ((org-columns-default-format "%5A")) (org-columns))
(search-forward "1")
(insert "2")
(org-columns-update "A")
(list (get-char-property (point-min) 'org-columns-value)
(get-char-property (point-min) 'org-columns-value-modified)))))
;; When multiple columns are using the same property, value is
;; updated according to the specifications of the first one.
(should
(equal
"2"
(org-test-with-temp-text
"* H
:PROPERTIES:
:A: 1
:END:
** S
:PROPERTIES:
:A: 2
:END:"
(let ((org-columns-default-format "%A{min} %A")) (org-columns))
(org-columns-update "A")
(org-entry-get nil "A"))))
(should
(equal
"1"
(org-test-with-temp-text
"* H
:PROPERTIES:
:A: 1
:END:
** S
:PROPERTIES:
:A: 2
:END:"
(let ((org-columns-default-format "%A %A{min}")) (org-columns))
(org-columns-update "A")
(org-entry-get nil "A"))))
;; Ensure modifications propagate in upper levels even when multiple
;; summary types apply to the same property.
(should
(equal
'("1" "22")
(org-test-with-temp-text
"* H
** S1
:PROPERTIES:
:A: 1
:END:
** S2
:PROPERTIES:
:A: <point>2
:END:"
(save-excursion
(goto-char (point-min))
(let ((org-columns-default-format "%A{min} %A{max}")) (org-columns)))
(insert "2")
(org-columns-update "A")
(list (get-char-property 1 'org-columns-value)
(get-char-property 2 'org-columns-value-modified)))))
;; Ensure additional processing is done (e.g., ellipses, special
;; keywords fontification...).
(should
(equal
"ve.. |"
(org-test-with-temp-text
"* H
:PROPERTIES:
:A: text
:END:
"
(let ((org-columns-default-format "%4A")
(org-columns-ellipses ".."))
(org-columns))
(search-forward ":A: ")
(insert "very long ")
(org-columns-update "A")
(get-char-property (point-min) 'display))))
;; Values obtained from inline tasks are at the same level as those
;; obtained from children of the current node.
(when (featurep 'org-inlinetask)
(should
(equal
"2"
(org-test-with-temp-text
"* H
*************** Inline task
:PROPERTIES:
:A: 2
:END:
*************** END
** Children
:PROPERTIES:
:A: 3
:END:
"
(let ((org-columns-default-format "%A{min}")
(org-columns-ellipses "..")
(org-inlinetask-min-level 15))
(org-element-update-syntax)
(org-columns))
(get-char-property (point-min) 'org-columns-value)))))
;; Handle `org-columns-modify-value-for-display-function', even with
;; multiple titles for the same property.
(should
(equal '("foo" "bar")
(org-test-with-temp-text "* H"
(let ((org-columns-default-format "%ITEM %ITEM(Name)")
(org-columns-modify-value-for-display-function
(lambda (title value)
(pcase title ("ITEM" "foo") ("Name" "bar") (_ "baz")))))
(org-columns))
(list (get-char-property 1 'org-columns-value-modified)
(get-char-property 2 'org-columns-value-modified))))))
(ert-deftest test-org-colview/columns-move-left ()
"Test `org-columns-move-left' specifications."
;; Error when trying to move the left-most column.
(should-error
(org-test-with-temp-text "* H"
(let ((org-columns-default-format "%ITEM")) (org-columns))
(org-columns-move-left)))
;; Otherwise, move column to left and update display.
(should
(equal '("2" "1")
(org-test-with-temp-text "* H\n:PROPERTIES:\n:A: 1\n:B: 2\n:END:"
(let ((org-columns-default-format "%A %B")) (org-columns))
(forward-char)
(org-columns-move-left)
(list (get-char-property (point) 'org-columns-value)
(get-char-property (1+ (point)) 'org-columns-value)))))
;; Handle multiple columns with the same property.
(should
(equal '("2" "1")
(org-test-with-temp-text
"* H
** S1
:PROPERTIES:
:A: 1
:END:
** S1
:PROPERTIES:
:A: 2
:END:"
(let ((org-columns-default-format "%ITEM %A{min} %A{max}"))
(org-columns))
(forward-char 2)
(org-columns-move-left)
(list (get-char-property (point) 'org-columns-value)
(get-char-property (1+ (point)) 'org-columns-value)))))
;; Special case: do not update values even if move entails changing
;; them.
(should
(equal "1"
(org-test-with-temp-text
"* H
:PROPERTIES:
:A: 1
:END:
** S1
:PROPERTIES:
:A: 99
:END:"
(let ((org-columns-default-format "%A %A{max}"))
(org-columns))
(forward-char)
(org-columns-move-left)
;; Since the first column matching a given property
;; determines how a value is computed, the following
;; should return "99" instead. However, this behavior is
;; in practice surprising so we just ignore the value
;; change. It can be computed later.
(org-entry-get (point) "A")))))
(ert-deftest test-org-colview/columns-move-right ()
"Test `org-columns-move-right' specifications."
;; Error when trying to move the right-most column.
(should-error
(org-test-with-temp-text "* H"
(let ((org-columns-default-format "%ITEM")) (org-columns))
(org-columns-move-right)))
;; Otherwise, move column to left and update display.
(should
(equal '("2" "1")
(org-test-with-temp-text "* H\n:PROPERTIES:\n:A: 1\n:B: 2\n:END:"
(let ((org-columns-default-format "%A %B")) (org-columns))
(org-columns-move-right)
(list (get-char-property (1- (point)) 'org-columns-value)
(get-char-property (point) 'org-columns-value)))))
;; Handle multiple columns with the same property.
(should
(equal '("2" "1")
(org-test-with-temp-text
"* H
** S1
:PROPERTIES:
:A: 1
:END:
** S1
:PROPERTIES:
:A: 2
:END:"
(let ((org-columns-default-format "%ITEM %A{min} %A{max}"))
(org-columns))
(forward-char)
(org-columns-move-right)
(list (get-char-property (1- (point)) 'org-columns-value)
(get-char-property (point) 'org-columns-value)))))
;; Special case: do not update values even if move entails changing
;; them.
(should
(equal "1"
(org-test-with-temp-text
"* H
:PROPERTIES:
:A: 1
:END:
** S1
:PROPERTIES:
:A: 99
:END:"
(let ((org-columns-default-format "%A %A{max}"))
(org-columns))
(org-columns-move-right)
;; See `test-org-colview/columns-move-left' for an
;; explanation.
(org-entry-get (point) "A")))))
(ert-deftest test-org-colview/columns-next-allowed-value ()
"Test `org-columns-next-allowed-value' specifications."
;; Cannot shift "ITEM" property.
(should-error
(org-test-with-temp-text "* H"
(let ((org-columns-default-format "%ITEM")) (org-columns))
(org-columns-next-allowed-value)))
;; Throw an error when allowed values are not defined.
(should-error
(org-test-with-temp-text "* H\n:PROPERTIES:\n:A: 1\n:END:"
(let ((org-columns-default-format "%A")) (org-columns))
(org-columns-next-allowed-value)))
;; Throw an error when there's only one value to select.
(should-error
(org-test-with-temp-text "* H\n:PROPERTIES:\n:A: 1\n:A_ALL: 1\n:END:"
(let ((org-columns-default-format "%A")) (org-columns))
(org-columns-next-allowed-value)))
;; By default select the next allowed value. Where there is no more
;; value, start again from first possible one.
(should
(equal "2"
(org-test-with-temp-text
"* H\n:PROPERTIES:\n:A: 1\n:A_ALL: 1 2 3\n:END:"
(let ((org-columns-default-format "%A")) (org-columns))
(org-columns-next-allowed-value)
(org-entry-get (point) "A"))))
(should
(equal "3"
(org-test-with-temp-text
"* H\n:PROPERTIES:\n:A: 2\n:A_ALL: 1 2 3\n:END:"
(let ((org-columns-default-format "%A")) (org-columns))
(org-columns-next-allowed-value)
(org-entry-get (point) "A"))))
(should
(equal "1"
(org-test-with-temp-text
"* H\n:PROPERTIES:\n:A: 3\n:A_ALL: 1 2 3\n:END:"
(let ((org-columns-default-format "%A")) (org-columns))
(org-columns-next-allowed-value)
(org-entry-get (point) "A"))))
;; PREVIOUS argument moves backward.
(should
(equal "1"
(org-test-with-temp-text
"* H\n:PROPERTIES:\n:A: 2\n:A_ALL: 1 2 3\n:END:"
(let ((org-columns-default-format "%A")) (org-columns))
(org-columns-next-allowed-value 'previous)
(org-entry-get (point) "A"))))
(should
(equal "2"
(org-test-with-temp-text
"* H\n:PROPERTIES:\n:A: 3\n:A_ALL: 1 2 3\n:END:"
(let ((org-columns-default-format "%A")) (org-columns))
(org-columns-next-allowed-value 'previous)
(org-entry-get (point) "A"))))
(should
(equal "3"
(org-test-with-temp-text
"* H\n:PROPERTIES:\n:A: 1\n:A_ALL: 1 2 3\n:END:"
(let ((org-columns-default-format "%A")) (org-columns))
(org-columns-next-allowed-value 'previous)
(org-entry-get (point) "A"))))
;; Select Nth element with optional argument NTH.
(should
(equal "1"
(org-test-with-temp-text
"* H\n:PROPERTIES:\n:A: 2\n:A_ALL: 1 2 3\n:END:"
(let ((org-columns-default-format "%A")) (org-columns))
(org-columns-next-allowed-value nil 1)
(org-entry-get (point) "A"))))
;; If NTH is negative, go backwards, 0 being the last one and -1 the
;; penultimate.
(should
(equal "3"
(org-test-with-temp-text
"* H\n:PROPERTIES:\n:A: 2\n:A_ALL: 1 2 3\n:END:"
(let ((org-columns-default-format "%A")) (org-columns))
(org-columns-next-allowed-value nil 0)
(org-entry-get (point) "A"))))
(should
(equal "2"
(org-test-with-temp-text
"* H\n:PROPERTIES:\n:A: 2\n:A_ALL: 1 2 3\n:END:"
(let ((org-columns-default-format "%A")) (org-columns))
(org-columns-next-allowed-value nil -1)
(org-entry-get (point) "A"))))
;; Throw an error if NTH is greater than the number of allowed
;; values.
(should-error
(org-test-with-temp-text
"* H\n:PROPERTIES:\n:A: 2\n:A_ALL: 1 2 3\n:END:"
(let ((org-columns-default-format "%A")) (org-columns))
(org-columns-next-allowed-value nil 4)
(org-entry-get (point) "A")))
;; Pathological case: when shifting the value alters the current
;; heading, make sure all columns are still at their correct
;; location.
(should
(equal '("H" "" "" "" "TODO")
(let ((org-todo-keywords '((sequence "TODO" "DONE"))))
(org-test-with-temp-text "* H"
(let ((org-columns-default-format "%ITEM %A %B %C %TODO"))
(org-columns)
(forward-char 4)
(org-columns-next-allowed-value)
(list (get-char-property (- (point) 4) 'org-columns-value)
(get-char-property (- (point) 3) 'org-columns-value)
(get-char-property (- (point) 2) 'org-columns-value)
(get-char-property (- (point) 1) 'org-columns-value)
(get-char-property (point) 'org-columns-value)))))))
(should
(equal '("H" "VERYLONGTODO")
(let ((org-todo-keywords '((sequence "TODO" "VERYLONGTODO"))))
(org-test-with-temp-text "* TODO H"
(let ((org-columns-default-format "%ITEM %TODO"))
(org-columns)
(forward-char)
(org-columns-next-allowed-value)
(list (get-char-property (- (point) 1) 'org-columns-value)
(get-char-property (point) 'org-columns-value))))))))
;;; Dynamic block
(ert-deftest test-org-colview/dblock ()
"Test the column view table."
(should
(equal
"#+BEGIN: columnview
| ITEM |
|------|
| H |
#+END:"
(org-test-with-temp-text
"* H\n<point>#+BEGIN: columnview\n#+END:"
(let ((org-columns-default-format "%ITEM")) (org-update-dblock))
(buffer-substring-no-properties (point) (point-max)))))
(should
(equal
"#+BEGIN: columnview
| ITEM | A |
|------+---|
| H | 1 |
#+END:"
(org-test-with-temp-text
"* H\n:PROPERTIES:\n:A: 1\n:END:\n<point>#+BEGIN: columnview\n#+END:"
(let ((org-columns-default-format "%ITEM %A")) (org-update-dblock))
(buffer-substring-no-properties (point) (point-max)))))
;; Properties are case insensitive.
(should
(equal
"#+BEGIN: columnview
| a |
|---|
| 1 |
#+END:"
(org-test-with-temp-text
"* H\n:PROPERTIES:\n:A: 1\n:END:\n<point>#+BEGIN: columnview\n#+END:"
(let ((org-columns-default-format "%a")) (org-update-dblock))
(buffer-substring-no-properties (point) (point-max)))))
;; Test titles given to columns.
(should
(equal
"#+BEGIN: columnview
| Name | Prop |
|------+------|
| H | 1 |
#+END:"
(org-test-with-temp-text
"* H\n:PROPERTIES:\n:A: 1\n:END:\n<point>#+BEGIN: columnview\n#+END:"
(let ((org-columns-default-format "%ITEM(Name) %A(Prop)"))
(org-update-dblock))
(buffer-substring-no-properties (point) (point-max)))))
;; Test `:id' parameter
(should
(equal
"#+BEGIN: columnview :id local
| ITEM |
|------|
| H1 |
| H1.1 |
#+END:
"
(org-test-with-temp-text
"* H1\n<point>#+BEGIN: columnview :id local\n#+END:\n** H1.1\n* H2"
(let ((org-columns-default-format "%ITEM")) (org-update-dblock))
(buffer-substring-no-properties (point) (outline-next-heading)))))
(should
(equal
"#+BEGIN: columnview :id global
| ITEM |
|------|
| H1 |
| H1.1 |
| H2 |
#+END:
"
(org-test-with-temp-text
"\n* H1\n<point>#+BEGIN: columnview :id global\n#+END:\n** H1.1\n* H2"
(let ((org-columns-default-format "%ITEM")) (org-update-dblock))
(buffer-substring-no-properties (point) (outline-next-heading)))))
;; Test `:hlines' parameter.
(should
(equal
"#+BEGIN: columnview :hlines t :id global
| ITEM |
|------|
| H |
|------|
| H2 |
|------|
| H2.1 |
#+END:\n"
(org-test-with-temp-text
"
* H
<point>#+BEGIN: columnview :hlines t :id global
#+END:
* H2
** H2.1"
(let ((org-columns-default-format "%ITEM")) (org-update-dblock))
(buffer-substring-no-properties (point) (outline-next-heading)))))
(should
(equal
"#+BEGIN: columnview :hlines 1 :id global
| ITEM |
|------|
| H |
|------|
| H2 |
| H2.1 |
#+END:\n"
(org-test-with-temp-text
"
* H
<point>#+BEGIN: columnview :hlines 1 :id global
#+END:
* H2
** H2.1"
(let ((org-columns-default-format "%ITEM")) (org-update-dblock))
(buffer-substring-no-properties (point) (outline-next-heading)))))
(should
(equal
"#+BEGIN: columnview :hlines 1 :id \"id\"
| ITEM |
|------|
| H2 |
| H2.1 |
#+END:
"
(org-test-with-temp-text
"
* H
<point>#+BEGIN: columnview :hlines 1 :id \"id\"
#+END:
* H2
:PROPERTIES:
:ID: id
:END:
** H2.1"
(let ((org-columns-default-format "%ITEM")) (org-update-dblock))
(buffer-substring-no-properties (point) (outline-next-heading)))))
(should
(equal
"#+BEGIN: columnview :hlines 1 :id id
| ITEM |
|------|
| H2 |
| H2.1 |
#+END:
"
(org-test-with-temp-text
"
* H
<point>#+BEGIN: columnview :hlines 1 :id id
#+END:
* H2
:PROPERTIES:
:ID: id
:END:
** H2.1"
(let ((org-columns-default-format "%ITEM")) (org-update-dblock))
(buffer-substring-no-properties (point) (outline-next-heading)))))
;; Test `:indent' parameter.
(should
(equal
"#+BEGIN: columnview :indent t
| ITEM |
|----------|
| H1 |
| \\_ H1.1 |
#+END:
"
(org-test-with-temp-text
"* H1\n<point>#+BEGIN: columnview :indent t\n#+END:\n** H1.1"
(let ((org-columns-default-format "%ITEM")) (org-update-dblock))
(buffer-substring-no-properties (point) (outline-next-heading)))))
(should
(equal
"#+BEGIN: columnview :indent t
| Prop | Name |
|------+----------|
| | H1 |
| | \\_ H1.1 |
#+END:
"
(org-test-with-temp-text
"* H1\n<point>#+BEGIN: columnview :indent t\n#+END:\n** H1.1"
(let ((org-columns-default-format "%A(Prop) %ITEM(Name)"))
(org-update-dblock))
(buffer-substring-no-properties (point) (outline-next-heading)))))
;; Test `:vlines' parameter.
(should
(equal
"#+BEGIN: columnview :vlines t
| | ITEM | A |
|---+------+----|
| | H | 1 |
| / | <> | <> |
#+END:"
(org-test-with-temp-text
"* H\n:PROPERTIES:\n:A: 1\n:END:\n<point>#+BEGIN: columnview :vlines t\n#+END:"
(let ((org-columns-default-format "%ITEM %A")) (org-update-dblock))
(buffer-substring-no-properties (point) (point-max)))))
;; Test `:skip-empty-rows' parameter.
(should
(equal
"#+BEGIN: columnview :skip-empty-rows t
| ITEM | A |
|------+---|
| H1.1 | 1 |
#+END:
"
(org-test-with-temp-text
"
* H1
<point>#+BEGIN: columnview :skip-empty-rows t
#+END:
** H1.1
:PROPERTIES:
:A: 1
:END:"
(let ((org-columns-default-format "%ITEM %A")) (org-update-dblock))
(buffer-substring-no-properties (point) (outline-next-heading)))))
;; Test `:exclude-tags' parameter.
(should
(equal
"#+BEGIN: columnview :exclude-tags (\"excludeme\")
| ITEM | A |
|------+---|
| H1 | |
#+END:
"
(org-test-with-temp-text
"
* H1
<point>#+BEGIN: columnview :exclude-tags (\"excludeme\")
#+END:
** H1.1 :excludeme:
:PROPERTIES:
:A: 1
:END:"
(let ((org-columns-default-format "%ITEM %A")) (org-update-dblock))
(buffer-substring-no-properties (point) (outline-next-heading)))))
;; Test `:format' parameter.
(should
(equal
"#+BEGIN: columnview :format \"%ITEM(Name)\"
| Name |
|------|
| H |
#+END:"
(org-test-with-temp-text
"* H\n<point>#+BEGIN: columnview :format \"%ITEM(Name)\"\n#+END:"
(let ((org-columns-default-format "%ITEM")) (org-update-dblock))
(buffer-substring-no-properties (point) (point-max)))))
;; When inserting ITEM values, make sure to clean sensitive
;; contents, like unique targets or forbidden inline src-blocks.
(should
(equal
"#+BEGIN: columnview
| ITEM |
|------|
| H 1 |
#+END:"
(org-test-with-temp-text
"* H <<target>> 1\n<point>#+BEGIN: columnview\n#+END:"
(let ((org-columns-default-format "%ITEM")) (org-update-dblock))
(buffer-substring-no-properties (point) (point-max)))))
(should
(equal
"#+BEGIN: columnview
| ITEM |
|------|
| H 1 |
#+END:"
(org-test-with-temp-text
"* H src_emacs-lisp{(+ 1 1)} 1\n<point>#+BEGIN: columnview\n#+END:"
(let ((org-columns-default-format "%ITEM")) (org-update-dblock))
(buffer-substring-no-properties (point) (point-max)))))
;; Active time stamps are displayed as inactive.
(should
(equal
"#+BEGIN: columnview
| ITEM | d | s | t |
|------+------------------+------------------+------------------|
| H | [2020-05-14 Thu] | [2020-05-11 Mon] | [2020-06-10 Wed] |
#+END:"
(org-test-with-temp-text
"* H
SCHEDULED: <2020-05-11 Mon> DEADLINE: <2020-05-14 Thu>
<2020-06-10 Wed>
<point>#+BEGIN: columnview\n#+END:"
(let ((org-columns-default-format
"%ITEM %DEADLINE(d) %SCHEDULED(s) %TIMESTAMP(t)"))
(org-update-dblock))
(buffer-substring-no-properties (point) (point-max))))))
(provide 'test-org-colview)
;;; test-org-colview.el ends here