From: Jay Kamat <jaygkamat@gmail.com>
To: Nicolas Goaziou <mail@nicolasgoaziou.fr>
Cc: emacs-orgmode@gnu.org
Subject: Re: [PATCH] Update statistic cookies when archiving
Date: Sun, 03 Sep 2017 12:28:39 -0400 [thread overview]
Message-ID: <87wp5fzqyw.fsf@gmail.com> (raw)
In-Reply-To: <87inh0mcql.fsf@nicolasgoaziou.fr> (Nicolas Goaziou's message of "Sun, 03 Sep 2017 10:02:10 +0200")
[-- Attachment #1: Type: text/plain, Size: 1593 bytes --]
Hi,
> Be warned that we're in a feature-freeze phase. It will have to wait for
> Org 9.1 before being merged.
Sounds good to me!
>
>> + ;; Go to parent, even if no children exist
>
> Nitpick: Missing final dot.
>
>> + (org-up-heading-safe)
>> + ;; Update cookie of parent
>
> Ditto.
>> + (org-update-statistics-cookies nil)))
>> (message "Subtree archived %s"
>> (if (eq this-buffer buffer)
>> (concat "under heading: " heading)
>> @@ -470,6 +476,9 @@ Archiving time is retained in the ARCHIVE_TIME node property."
>> (outline-hide-subtree)
>> (org-cycle-show-empty-lines 'folded)
>> (goto-char pos)))
>> + (when org-provide-todo-statistics
>> + ;; update todo statistics of parent
>
> Ditto. Missing capital, too.
>
>> + (org-update-parent-todo-statistics))
>> (org-reveal)
>> (if (looking-at "^[ \t]*$")
>> (outline-next-visible-heading 1))))
Fixed.
> Could you provide some tests and an ORG-NEWS entry? For the latter, you
> can start a new "Version 9.2" top heading.
Done.
I'm not sure if I did the tests 'correctly' though. I placed them in
test-org-element.el since there was a little bit of archive based
testing there, is there a better place to put them? I couldn't find any
file for org-archive testing. Maybe I'll write some more archive tests
later...
+ (should (string=
+ (org-element-property :title (org-element-at-point))
+ "Top [0%]")))
Is there a better way to extract the status cookie percentage from the
header? I couldn't find anything in (org-element-property)'s output.
Thanks,
-Jay
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-org-archive.el-Update-statistic-cookies-when-archivi.patch --]
[-- Type: text/x-diff, Size: 4293 bytes --]
From 612d4daac54e12556333fcd2e07771aa8344c86c Mon Sep 17 00:00:00 2001
From: Jay Kamat <jaygkamat@gmail.com>
Date: Sat, 2 Sep 2017 15:57:36 -0400
Subject: [PATCH] org-archive.el: Update statistic cookies when archiving
* lisp/org-archive.el (org-archive-subtree): Update todo statistics
when calling `org-archive-subtree'.
(org-archive-to-archive-sibling): Update cookie statistics when
calling `org-archive-to-archive-sibling'.
This can be disabled by setting `org-provide-todo-statistics' to nil.
---
etc/ORG-NEWS | 22 ++++++++++++++++++++++
lisp/org-archive.el | 9 +++++++++
testing/lisp/test-org-element.el | 33 +++++++++++++++++++++++++++++++++
3 files changed, 64 insertions(+)
diff --git a/etc/ORG-NEWS b/etc/ORG-NEWS
index 9f3e62406..316a75f2f 100644
--- a/etc/ORG-NEWS
+++ b/etc/ORG-NEWS
@@ -8,6 +8,28 @@ See the end of the file for license conditions.
Please send Org bug reports to mailto:emacs-orgmode@gnu.org.
+* Version 9.2
+
+** Incompatible changes
+** New features
+*** ~org-archive~ functions update status cookies
+
+Archiving headers through ~org-archive-subtree~ and
+~org-archive-to-archive-sibling~ such as the ones listed below:
+
+#+BEGIN_SRC org
+ ,* Top [1/2]
+ ,** DONE Completed
+ ,** TODO Working
+#+END_SRC
+
+Will update the status cookie in the top level header.
+
+** Removed functions
+** Removed options
+** New functions
+** Miscellaneous
+
* Version 9.1
** Incompatible changes
diff --git a/lisp/org-archive.el b/lisp/org-archive.el
index adb922e75..9ba73a8de 100644
--- a/lisp/org-archive.el
+++ b/lisp/org-archive.el
@@ -393,6 +393,12 @@ direct children of this heading."
(when (featurep 'org-inlinetask)
(org-inlinetask-remove-END-maybe))
(setq org-markers-to-move nil)
+ (when org-provide-todo-statistics
+ (save-excursion
+ ;; Go to parent, even if no children exist.
+ (org-up-heading-safe)
+ ;; Update cookie of parent.
+ (org-update-statistics-cookies nil)))
(message "Subtree archived %s"
(if (eq this-buffer buffer)
(concat "under heading: " heading)
@@ -470,6 +476,9 @@ Archiving time is retained in the ARCHIVE_TIME node property."
(outline-hide-subtree)
(org-cycle-show-empty-lines 'folded)
(goto-char pos)))
+ (when org-provide-todo-statistics
+ ;; Update todo statistics of parent.
+ (org-update-parent-todo-statistics))
(org-reveal)
(if (looking-at "^[ \t]*$")
(outline-next-visible-heading 1))))
diff --git a/testing/lisp/test-org-element.el b/testing/lisp/test-org-element.el
index 7d1c55f36..e9506d2b0 100644
--- a/testing/lisp/test-org-element.el
+++ b/testing/lisp/test-org-element.el
@@ -1070,6 +1070,39 @@ Some other text
(let ((org-archive-tag "Archive"))
(org-element-property :archivedp (org-element-at-point))))))
+(ert-deftest test-org-element/archive-update-status-cookie ()
+ "Test archiving properly updating status cookies."
+ ;; Test org-archive-subtree with two children.
+ (org-test-with-temp-text-in-file "* Top [%]\n** DONE One\n** TODO Two"
+ (forward-line 1)
+ (org-archive-subtree)
+ (forward-line -1)
+ (should (string=
+ (org-element-property :title (org-element-at-point))
+ "Top [0%]")))
+ ;; Test org-archive-subtree with one child.
+ (org-test-with-temp-text-in-file "* Top [%]\n** TODO Two"
+ (forward-line 1)
+ (org-archive-subtree)
+ (forward-line -1)
+ (should (string=
+ (org-element-property :title (org-element-at-point))
+ "Top [100%]")))
+ ;; Test org-archive-to-archive-sibling with two children.
+ (org-test-with-temp-text "* Top [%]\n<point>** TODO One\n** DONE Two"
+ (org-archive-to-archive-sibling)
+ (forward-line -1)
+ (should (string=
+ (org-element-property :title (org-element-at-point))
+ "Top [100%]")))
+ ;; Test org-archive-to-archive-sibling with two children.
+ (org-test-with-temp-text "* Top [%]\n<point>** DONE Two"
+ (org-archive-to-archive-sibling)
+ (forward-line -1)
+ (should (string=
+ (org-element-property :title (org-element-at-point))
+ "Top [0%]"))))
+
(ert-deftest test-org-element/headline-properties ()
"Test properties from property drawer."
;; All properties from property drawer have their symbol upper
--
2.11.0
next prev parent reply other threads:[~2017-09-03 16:28 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-09-02 20:09 [PATCH] Update statistic cookies when archiving Jay Kamat
2017-09-02 20:11 ` Jay Kamat
2017-09-03 8:02 ` Nicolas Goaziou
2017-09-03 16:28 ` Jay Kamat [this message]
2017-09-06 12:32 ` Nicolas Goaziou
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://www.orgmode.org/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=87wp5fzqyw.fsf@gmail.com \
--to=jaygkamat@gmail.com \
--cc=emacs-orgmode@gnu.org \
--cc=mail@nicolasgoaziou.fr \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).