emacs-config/local/lib/org-x/test/org-x-test-buffer-state.el

432 lines
10 KiB
EmacsLisp
Raw Normal View History

2021-04-03 22:59:24 -04:00
;;; org-x-text-buffer-state.el --- Examples for org.el's API -*- lexical-binding: t -*-
;; Copyright (C) 2015 Free Software Foundation, Inc.
;; 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 <http://www.gnu.org/licenses/>.
;;; Commentary:
;;; Code:
(require 's)
(require 'dash)
(require 'org-x)
2021-04-04 23:34:35 -04:00
(defun org-ts-to-unixtime (timestamp-string)
"Convert TIMESTAMP-STRING to unixtime."
(let ((decoded (org-parse-time-string timestamp-string)))
(->> (-snoc decoded (current-time-zone))
(apply #'encode-time)
(float-time)
(round))))
2021-04-11 00:05:49 -04:00
(defun org-x-gen-ts (offset &optional active)
2021-04-04 23:34:35 -04:00
"Generate an org timestamp string.
OFFSET is the length of time from now in seconds (positive is in
2021-04-11 00:05:49 -04:00
the future). Make an active timestamp if ACTIVE is t."
(-> (float-time)
2021-04-04 23:34:35 -04:00
(+ offset)
(org-ml-unixtime-to-time-long)
2021-04-11 00:05:49 -04:00
(org-ml-build-timestamp! :active active)
2021-04-04 23:34:35 -04:00
(org-ml-to-string)))
(defun org-x-test-parse-forms (s)
"Evaluate forms in string S.
Forms are denoted like %(FORM)%."
(--reduce-from (-let (((rep sform) it))
(s-replace rep (format "%s" (eval (read sform))) acc))
s
(s-match-strings-all "%\\((.*?)\\)%" s)))
(defmacro org-ml--with-org-buffer (string &rest body)
"Call `org-ml--with-org-env' with BODY and STRING as the buffer."
(let ((s (->> (if (listp string) (s-join "\n" string) string)
(org-x-test-parse-forms))))
2021-04-06 23:16:51 -04:00
`(org-ml--with-org-env
(insert ,s)
(goto-char (point-min))
,@body)))
2021-04-04 23:34:35 -04:00
(defmacro org-x--test-buffer-strings (name test &rest specs)
"Run TEST form for SPECS called by toplevel NAME."
(declare (indent 2))
(let ((forms (->> (-partition 4 specs)
;; the _op argument is just for looks to make the decl clearer
(--map (-let (((title buffer _op result) it))
`(it ,title
(expect (org-ml--with-org-buffer ,buffer ,test)
:to-equal
,result)))))))
`(describe ,name ,@forms)))
(org-x--test-buffer-strings "Task status"
(org-x-task-status)
"no status"
"* headline"
=> nil
"active"
"* TODO headline"
=> :active
"active (not yet expired date)"
("* TODO headline"
":PROPERTIES:"
":CREATED: %(org-x-gen-ts (- (* 2 24 60 60)))%"
":X-EXPIRE: %(org-x-gen-ts (* 1 24 60 60))%"
":END:")
=> :active
"active (not yet expired dtl)"
("* TODO headline"
":PROPERTIES:"
":CREATED: %(org-x-gen-ts (- (* 2 24 60 60)))%"
":X-DAYS_TO_LIVE: 3"
":END:")
=> :active
"done unclosed"
"* DONE headline"
=> :done-unclosed
"undone closed"
("* TODO headline"
"CLOSED: %(org-x-gen-ts 0)%")
=> :undone-closed
"complete"
("* DONE headline"
"CLOSED: %(org-x-gen-ts 0)%")
=> :complete
"archivable"
("* DONE headline"
"CLOSED: %(org-x-gen-ts (- (* (1+ org-x-archive-delay) 24 60 60)))%")
=> :archivable
"expired (date)"
("* TODO headline"
":PROPERTIES:"
":CREATED: %(org-x-gen-ts (- (* 2 24 60 60)))%"
":X-EXPIRE: %(org-x-gen-ts (- (* 1 24 60 60)))%"
":END:")
=> :expired
"expired (dtl)"
("* TODO headline"
":PROPERTIES:"
":CREATED: %(org-x-gen-ts (- (* 2 24 60 60)))%"
":X-DAYS_TO_LIVE: 1"
":END:")
=> :expired
"inert (created timestamp)"
("* TODO headline"
":PROPERTIES:"
":CREATED: %(org-x-gen-ts (- (* (1+ org-x-inert-delay-days) 24 60 60)))%"
":END:")
=> :inert
"not inert (future deadline)"
("* TODO headline"
"DEADLINE: %(org-x-gen-ts (* 1 24 60 60))%"
":PROPERTIES:"
":CREATED: %(org-x-gen-ts (- (* (1+ org-x-inert-delay-days) 24 60 60)))%"
":END:")
=> :active
"not inert (future schedule)"
("* TODO headline"
"SCHEDULED: %(org-x-gen-ts (* 1 24 60 60))%"
":PROPERTIES:"
":CREATED: %(org-x-gen-ts (- (* (1+ org-x-inert-delay-days) 24 60 60)))%"
":END:")
=> :active)
2021-04-03 22:59:24 -04:00
2021-04-06 23:16:51 -04:00
;; NOTE the silly thing about this function is that headlines need not actually
;; be projects :/
(org-x--test-buffer-strings "Project status"
(org-x-get-project-status)
"scheduled"
("* TODO project"
"SCHEDULED: %(org-x-gen-ts 0)%")
=> :scheduled-project
"held"
("* HOLD project")
=> :held
;; ASSUME the inert code paths are fully tested elsewhere
"inert"
("* HOLD project"
":PROPERTIES:"
":CREATED: %(org-x-gen-ts (- (* (1+ org-x-inert-delay-days) 24 60 60)))%"
":END:")
=> :inert
"invalid todo (NEXT)"
("* NEXT project")
=> :invalid-todostate
"invalid todo (WAIT)"
("* WAIT project")
=> :invalid-todostate
"canceled (complete)"
("* CANC project")
=> :complete
"canceled (archivable)"
("* CANC project"
"CLOSED: %(org-x-gen-ts (- (* (1+ org-x-archive-delay) 24 60 60)))%")
=> :archivable
"complete (subtask complete)"
("* DONE project"
"CLOSED: %(org-x-gen-ts 0)%"
"** DONE task 1"
"CLOSED: %(org-x-gen-ts 0)%")
=> :complete
;; TODO this should be :complete
"complete (subtask archivable)"
("* DONE project"
"CLOSED: %(org-x-gen-ts 0)%"
"** DONE task 1"
"CLOSED: %(org-x-gen-ts (- (* (1+ org-x-archive-delay) 24 60 60)))%")
=> :archivable
"archivable"
("* DONE project"
"CLOSED: %(org-x-gen-ts (- (* (1+ org-x-archive-delay) 24 60 60)))%"
"** DONE task 1"
"CLOSED: %(org-x-gen-ts (- (* (1+ org-x-archive-delay) 24 60 60)))%")
=> :archivable
"done-incomplete (subtask TODO)"
("* DONE project"
"CLOSED: %(org-x-gen-ts (- (* (1+ org-x-archive-delay) 24 60 60)))%"
"** TODO task 1")
=> :done-incomplete
"done-incomplete (subtask TODO)"
("* DONE project"
"CLOSED: %(org-x-gen-ts (- (* (1+ org-x-archive-delay) 24 60 60)))%"
"** TODO task 1")
=> :done-incomplete
;; TODO this should be an error
"done-incomplete (subtask done-unclosed)"
("* DONE project"
"CLOSED: %(org-x-gen-ts (- (* (1+ org-x-archive-delay) 24 60 60)))%"
"** DONE task 1")
=> :complete
;; TODO this should be :complete
"complete (subtask archivable nested)"
("* DONE project"
"CLOSED: %(org-x-gen-ts 0)%"
"** DONE task 1"
"CLOSED: %(org-x-gen-ts (- (* (1+ org-x-archive-delay) 24 60 60)))%"
"*** DONE task 2"
"CLOSED: %(org-x-gen-ts (- (* (1+ org-x-archive-delay) 24 60 60)))%")
=> :archivable
"archivable (nested)"
("* DONE project"
"CLOSED: %(org-x-gen-ts (- (* (1+ org-x-archive-delay) 24 60 60)))%"
"** DONE task 1"
"CLOSED: %(org-x-gen-ts (- (* (1+ org-x-archive-delay) 24 60 60)))%"
"*** DONE task 2"
"CLOSED: %(org-x-gen-ts (- (* (1+ org-x-archive-delay) 24 60 60)))%")
=> :archivable
;; TODO there are many other paths to test for the DONE toplevel keyword
;; TODO this seems error-prone
"active (singleton...???)"
("* TODO project")
=> :stuck
"active (subtask)"
("* TODO project"
"** NEXT task")
=> :active
"wait (subtask)"
("* TODO project"
"** WAIT task")
=> :wait
"held (subtask)"
("* TODO project"
"** HOLD task")
=> :held
"inert (subtask)"
("* TODO project"
"** TODO task"
":PROPERTIES:"
":CREATED: %(org-x-gen-ts (- (* (1+ org-x-inert-delay-days) 24 60 60)))%"
":END:")
=> :inert
"undone-complete (subtask)"
("* TODO project"
"** DONE TASK"
"CLOSED: (org-x-gen-ts 0)")
=> :undone-complete
"stuck (subtask)"
("* TODO project"
"** TODO TASK")
=> :stuck
"active (subtask 2)"
("* TODO project"
"** TODO task 1 "
"*** NEXT task 2")
=> :active
"wait (subtask 2)"
("* TODO project"
"** TODO task 1 "
"*** WAIT task 2")
=> :wait
"held (subtask 2)"
("* TODO project"
"** TODO task 1"
"*** HOLD task 2")
=> :held
"inert (subtask 2)"
("* TODO project"
"** TODO task 1"
"*** TODO task 2"
":PROPERTIES:"
":CREATED: %(org-x-gen-ts (- (* (1+ org-x-inert-delay-days) 24 60 60)))%"
":END:")
=> :inert
"undone-complete (subtask 2)"
("* TODO project"
"** TODO task 1"
"*** DONE task 2"
"CLOSED: (org-x-gen-ts 0)")
=> :undone-complete
"stuck (subtask 2)"
("* TODO project"
"** TODO task 1"
"*** TODO task 2")
=> :stuck)
2021-04-11 00:00:15 -04:00
(org-x--test-buffer-strings "Iterator status"
(org-x-get-iterator-status)
"uninitialized"
("* TODO iterator"
":PROPERTIES:"
":PARENT_TYPE: iterator"
":END:")
=> :uninit
"unscheduled"
("* TODO iterator"
":PROPERTIES:"
":PARENT_TYPE: iterator"
":END:"
"** TODO sub")
=> :unscheduled
"unscheduled (with DONE)"
("* TODO iterator"
":PROPERTIES:"
":PARENT_TYPE: iterator"
":END:"
"** DONE sub"
"CLOSED: %(org-x-gen-ts 0)%"
"** TODO sub")
=> :unscheduled
"empty"
("* TODO iterator"
":PROPERTIES:"
":PARENT_TYPE: iterator"
":END:"
"** DONE sub"
"CLOSED: %(org-x-gen-ts 0)%")
=> :empt
"active"
("* TODO iterator"
":PROPERTIES:"
":PARENT_TYPE: iterator"
":END:"
"** TODO sub"
"SCHEDULED: %(org-x-gen-ts (+ (* 60 60 24) org-clone-iter-future-time))%")
=> :actv
"project error"
("* TODO iterator"
":PROPERTIES:"
":PARENT_TYPE: iterator"
":END:"
"** NEXT sub"
"*** TODO subsub"
"SCHEDULED: %(org-x-gen-ts (1+ org-clone-iter-future-time))%")
=> :project-error)
2021-04-11 00:05:49 -04:00
(org-x--test-buffer-strings "Periodical status"
(org-x-get-periodical-status)
"uninitialized"
("* periodical"
":PROPERTIES:"
":PARENT_TYPE: periodical"
":END:")
=> :uninit
"empty"
("* periodical"
":PROPERTIES:"
":PARENT_TYPE: periodical"
":END:"
"** sub"
"%(org-x-gen-ts 0 t)%")
=> :empt
"active"
("* periodical"
":PROPERTIES:"
":PARENT_TYPE: periodical"
":END:"
"** sub"
"%(org-x-gen-ts (+ (* 60 60 24) org-clone-peri-future-time) t)%")
=> :actv
"unscheduled"
("* periodical"
":PROPERTIES:"
":PARENT_TYPE: periodical"
":END:"
"** sub")
=> :unscheduled)
2021-04-03 22:59:24 -04:00
(provide 'org-x-test-buffer-state)
;;; org-x-test-buffer-state.el ends here