Hello!
There are two patches here. The first one is a simple bug fix that
doesn't really have anything to do with the second patch. It just
happens to be in the same spot of the code.
The second patch allows a habit to be considered done if time was logged
to it. Imagine you have an org habit like shaving. Chances are, if you
spend time doing it, it's done. I like to set LOGGING to nil for these
kinds of habits since it's redundant to have all those state changes
that tell me exactly what the logbook already tells me.
Let me know what you guys think. Any discussion about the second patch
though shouldn't stop the first one from being applied.
>From cc16dd6a8c59312a75b8e25669a7e4eb3d9f9ef4 Mon Sep 17 00:00:00 2001
From: Morgan Smith <morgan.j.sm...@outlook.com>
Date: Tue, 11 Oct 2022 11:44:26 -0400
Subject: [PATCH 1/2] lisp/org-habit.el: Use time as a history cutoff point
* lisp/org-habit.el (org-habit-parse-todo): Use time as a cutoff point
instead of using a count.
This allows viewing the full history of habits that are completed
multiple times a day. Previously we would miss some days and show an
incorrect history
---
lisp/org-habit.el | 9 +++++----
1 file changed, 5 insertions(+), 4 deletions(-)
diff --git a/lisp/org-habit.el b/lisp/org-habit.el
index 677b7adb6..fe5f4fe63 100644
--- a/lisp/org-habit.el
+++ b/lisp/org-habit.el
@@ -212,11 +212,11 @@ This list represents a \"habit\" for the rest of this module."
habit-entry scheduled-repeat))
(setq deadline (+ scheduled (- dr-days sr-days))))
(org-back-to-heading t)
- (let* ((maxdays (+ org-habit-preceding-days org-habit-following-days))
+ (let* ((firstday (- (org-today) org-habit-preceding-days))
(reversed org-log-states-order-reversed)
(search (if reversed 're-search-forward 're-search-backward))
(limit (if reversed end (point)))
- (count 0)
+ (done nil)
(re (format
"^[ \t]*-[ \t]+\\(?:State \"%s\".*%s%s\\)"
(regexp-opt org-done-keywords)
@@ -235,13 +235,14 @@ This list represents a \"habit\" for the rest of this module."
("%u" . ".*?")
("%U" . ".*?")))))))))
(unless reversed (goto-char end))
- (while (and (< count maxdays) (funcall search re limit t))
+ (while (and (not done) (funcall search re limit t))
(push (time-to-days
(org-time-string-to-time
(or (match-string-no-properties 1)
(match-string-no-properties 2))))
closed-dates)
- (setq count (1+ count))))
+ (when (< (car closed-dates) firstday)
+ (setq done t))))
(list scheduled sr-days deadline dr-days closed-dates sr-type))))
(defsubst org-habit-scheduled (habit)
--
2.38.0
>From 93929b6722e7171551f8390581593e8ea76f1340 Mon Sep 17 00:00:00 2001
From: Morgan Smith <morgan.j.sm...@outlook.com>
Date: Tue, 11 Oct 2022 11:46:39 -0400
Subject: [PATCH 2/2] lisp/org-habit.el: Allow clocking time to complete a
habit
* lisp/org-habit.el:
(org-habit-clock-completes-habit): Add
(org-habit-parse-todo): Allow clocking time to complete a habit
* etc/ORG-NEWS: Add entry for `org-habit-clock-completes-habit'
* doc/org-manual.org: Add entry for `org-habit-clock-completes-habit'
---
doc/org-manual.org | 6 ++++++
etc/ORG-NEWS | 5 +++++
lisp/org-habit.el | 18 ++++++++++++++----
3 files changed, 25 insertions(+), 4 deletions(-)
diff --git a/doc/org-manual.org b/doc/org-manual.org
index 428c79923..a3dcfb3f9 100644
--- a/doc/org-manual.org
+++ b/doc/org-manual.org
@@ -4423,6 +4423,12 @@ the way habits are displayed in the agenda.
value is ~t~. Pressing {{{kbd(C-u K)}}} in the agenda toggles this
variable.
+- ~org-habit-clock-completes-habit~ ::
+
+ #+vindex: org-habit-clock-completes-habit
+ If non-~nil~, a habit is considered done on days that time has been
+ clocked to it.
+
Lastly, pressing {{{kbd(K)}}} in the agenda buffer causes habits to
temporarily be disabled and do not appear at all. Press {{{kbd(K)}}}
again to bring them back. They are also subject to tag filtering, if
diff --git a/etc/ORG-NEWS b/etc/ORG-NEWS
index c18c03725..1a3861f60 100644
--- a/etc/ORG-NEWS
+++ b/etc/ORG-NEWS
@@ -360,6 +360,11 @@ The new setting, when set to non-nil, makes Org create alarm at the
event time when the alarm time is set to 0. The default value is
nil -- do not create alarms at the event time.
+*** New custom setting ~org-habit-clock-completes-habit~
+
+The new setting, when set to non-nil, makes Org consider a habit done
+on days that time has been clocked to it.
+
** New functions and changes in function arguments
*** ~org-fold-show-entry~ does not fold drawers by default anymore
diff --git a/lisp/org-habit.el b/lisp/org-habit.el
index fe5f4fe63..66aad06c1 100644
--- a/lisp/org-habit.el
+++ b/lisp/org-habit.el
@@ -61,6 +61,11 @@ Note that consistency graphs will overwrite anything else in the buffer."
:group 'org-habit
:type 'boolean)
+(defcustom org-habit-clock-completes-habit nil
+ "If non-nil, a habit is considered done on days that time has been clocked to it."
+ :group 'org-habit
+ :type 'boolean)
+
(defcustom org-habit-show-habits-only-for-today t
"If non-nil, only show habits on today's agenda, and not for future days.
Note that even when shown for future days, the graph is always
@@ -218,7 +223,7 @@ This list represents a \"habit\" for the rest of this module."
(limit (if reversed end (point)))
(done nil)
(re (format
- "^[ \t]*-[ \t]+\\(?:State \"%s\".*%s%s\\)"
+ "^[ \t]*-[ \t]+\\(?:State \"%s\".*%s%s\\)%s"
(regexp-opt org-done-keywords)
org-ts-regexp-inactive
(let ((value (cdr (assq 'done org-log-note-headings))))
@@ -233,15 +238,20 @@ This list represents a \"habit\" for the rest of this module."
("%t" . ,org-ts-regexp-inactive)
("%T" . ,org-ts-regexp)
("%u" . ".*?")
- ("%U" . ".*?")))))))))
+ ("%U" . ".*?"))))))
+ (if org-habit-clock-completes-habit
+ (concat
+ "\\|^" org-clock-string ".*\\]--\\(\\[[^]]+\\]\\)")
+ ""))))
(unless reversed (goto-char end))
(while (and (not done) (funcall search re limit t))
(push (time-to-days
(org-time-string-to-time
(or (match-string-no-properties 1)
- (match-string-no-properties 2))))
+ (match-string-no-properties 2)
+ (match-string-no-properties 3))))
closed-dates)
- (when (< (car closed-dates) firstday)
+ (when (<= (car closed-dates) firstday)
(setq done t))))
(list scheduled sr-days deadline dr-days closed-dates sr-type))))
--
2.38.0
Thanks,
Morgan
