[WIP] Add timestamp selector. #154

Alexander-Miller · 2020-05-17T16:41:16Z

Draft for a selector that AFAICS is unavailable so far. It lets you match for timestamps in headlines like

*** Some Appointment
<2020-05-17 So 14:00>

I am using this selector to show me a focused list of all upcoming appointments in my agenda since my timeline is usually only 2 weeks long and choke-full with habits. So far it only matches future timestamps, but that can be easily expanded.

If you give your blessing for the feature (and I haven't just missed it) I'll finish this PR with all the necessary cleanup/options/documentation.

alphapapa · 2020-05-29T11:28:23Z

Hi,

Thanks for your patience. I've been taking a little break from working on my Emacs packages.

This seems like a good idea. It seems to mirror the ts predicate from org-ql.

You may already plan this optimization, but in case you haven't: rather than gathering all of the timestamps into a list (which does a lot of consing), the comparison could be done in the loop, and it could return as soon as a matching one is found. I'm guessing that would improve performance noticeably, at least in cases with hundreds or thousands of results.

Alexander-Miller · 2020-06-04T23:18:23Z

I haven't quite thought so far ahead, I had only starting groking how it works when I had the working version you see here. I'll take it into account for the next iteration.

Alexander-Miller · 2020-06-14T12:28:20Z

Updated what I think should be a working implementation.

I am not quite happy with having to use a catch, but cannot think of a better option - doing a (cl-loop ... thereis (test it)) doesn't work because without an exit condition it infinitely loops ove the nils returned by re-search-forward. Maybe you have a better idea?

Documentation is up next.

alphapapa · 2020-06-15T05:30:01Z

I am not quite happy with having to use a catch, but cannot think of a better option - doing a (cl-loop ... thereis (test it)) doesn't work because without an exit condition it infinitely loops ove the nils returned by re-search-forward. Maybe you have a better idea?

I would suggest copying the relevant code from org-ql, i.e. https://github.com/alphapapa/org-ql/blob/c847afe0b538a1a44c73e40b067831cbea132ba7/org-ql.el#L1556

Alexander-Miller · 2020-07-11T16:21:27Z

Got things clean up and documented now.

There's quite a few changes to the .info file, probably due to the version difference, so I think you should regenerate the file on your end, or the changes will just be reverted on your next commit anyway.

alphapapa · 2020-07-12T06:43:14Z

Why did you only support any and future? Other time/date-related group selectors in this package support a wider variety of options, like:

:deadline
Group items that have a deadline. Argument can be t (to match items with any deadline), nil (to match items that have no deadline), past (to match items with a deadline in the past), today (to match items whose deadline is today), or future (to match items with a deadline in the future). Argument may also be given like before DATE or after DATE where DATE is a date string that org-time-string-to-absolute can process.

Alexander-Miller · 2020-07-12T11:50:14Z

Because I don't know the feature list all that well and was only looking at whatever what be useful with my own use-case 🤷‍♂️.

I've added the same options as DEADLINE now, hope that's sufficient. (Also included some docstring highlighting). The nil case has gotten a bit ugly due to the while next-ts in the loop, but I don't know all that much about cl-loop either.

alphapapa · 2020-07-12T12:40:15Z

:) Thanks.

I think we can probably omit the nil case, because I don't imagine that would be very useful. If someone requests it, we can consider adding it.

What do you think about also supporting inactive timestamps? I guess they should probably also be supported.

The binding of the lambda forms and use of funcall is probably acceptably fast, but I think those bindings should be done with the :let* argument to org-super-agenda--defgroup so they aren't done for every tested item.

Would you be willing to also add tests for this feature? The test harness is somewhat bespoke and unintuitive (and mostly undocumented), so if you don't want to bother with that, I can't complain. But it will have to be done before the branch can be merged.

Thanks for your work on this.

Alexander-Miller · 2020-07-12T20:08:00Z

What do you think about also supporting inactive timestamps?

Not something I want to get into in this PR (don't personally see much of a use-case either). But easy to do: it'll just be a 99% copy of this commit, once it's done.

Mind you I did just notice that I used the wrong regex, currently both active and inactive timestamps are matched. Will be corrected with the next push.

I think those bindings should be done with the :let* argument to org-super-agenda--defgroup so they aren't done for every tested item.

Done.

Would you be willing to also add tests for this feature?

I had a look at the tests, but they looked all sorts of non-trivial, so I haven't bothered till now. I've got 2 days until a new project starts at work and I'll be busy, so if you tell me how to go about this I'll see how far I can come in that time.

alphapapa · 2021-09-24T01:30:18Z

I plan to merge #149, so this PR should probably implement that as well. @Alexander-Miller Would you mind doing that?

alphapapa

Thanks.

alphapapa · 2021-09-24T01:50:45Z

README.org

@@ -193,6 +193,7 @@ These selectors take one argument alone, or multiple arguments in a list.
 +  =:children= :: Select any item that has child entries.  Argument may be ~t~ to match if it has any children, ~nil~ to match if it has no children, ~todo~ to match if it has children with any to-do keywords, or a string to match if it has children with certain to-do keywords.  You might use this to select items that are project top-level headings.  Be aware that this may be very slow in non-daily/weekly agenda views because of its recursive nature.
 +  =:date= :: Group items that have a date associated. Argument can be =t= to match items with any date, =nil= to match items without a date, or =today= to match items with today’s date. The =ts-date= text-property is matched against.
 +  =:deadline= :: Group items that have a deadline. Argument can be ~t~ (to match items with any deadline), ~nil~ (to match items that have no deadline), ~past~ (to match items with a deadline in the past), ~today~ (to match items whose deadline is today), or ~future~ (to match items with a deadline in the future). Argument may also be given like ~before DATE~ or ~after DATE~ where DATE is a date string that ~org-time-string-to-absolute~ can process.
+  =:timestamp= :: Group items whose bodies contain an active timestamp. Argument can be ~t~ (to match items with any timestamp), ~past~ (to match items with timestamps in the past), ~today~ (to match items with timestamps set to today), or ~future~ (to match items with timestamps in the future).  Argument may also be given like ~before DATE~ or ~after DATE~, where DATE is a date string that ~org-time-string-to-absolute~ can process.


Nitpick: Please ensure two spaces between sentences in docs and docstrings.

alphapapa · 2021-09-24T01:52:47Z

org-super-agenda.el

+  :let* ((now (ts-now))
+         (target-date (pcase (car args)
+                        ((or 'before 'on 'after)
+                         (make-ts :internal (org-time-string-to-absolute (cadr args))))))


In line with #149, we should probably use org-read-date here.

alphapapa · 2021-09-24T01:55:37Z

org-super-agenda.el

+         (test (pcase-exhaustive (car args)
+                 ('t      (lambda (_) t))
+                 ('future (lambda (it) (ts>= it now)))
+                 ('past   (lambda (it) (ts<= it now)))
+                 ('before (lambda (it) (ts<= it target-date)))
+                 ('after  (lambda (it) (ts>= it target-date)))
+                 ('on     (lambda (it) (and (= (ts-year it)  (ts-year target-date))
+                                       (= (ts-month it) (ts-month target-date))
+                                       (= (ts-day it)   (ts-day target-date))))))))


This is nice, but what about using org-super-agenda--compare-dates?

alphapapa · 2021-09-24T01:57:12Z

org-super-agenda.info

@@ -1,4 +1,4 @@
-This is README.info, produced by makeinfo version 5.2 from README.texi.
+This is README.info, produced by makeinfo version 6.7 from README.texi.


I appreciate your being through, but if you don't mind, please omit the updates to the Info manual from the PR, and I can regenerate it myself using the same makeinfo version, to minimize differences.

Alexander-Miller · 2021-10-03T11:29:06Z

@alphapapa Updated changes from your comments for now, next I'll look into #149 and adding tests.

alphapapa self-assigned this May 29, 2020

Alexander-Miller force-pushed the timestamp-group branch from 132dfc1 to d2d5f28 Compare June 14, 2020 12:19

Alexander-Miller force-pushed the timestamp-group branch from d2d5f28 to d68dcfd Compare July 11, 2020 16:16

Alexander-Miller force-pushed the timestamp-group branch 2 times, most recently from 768cd70 to 82e546d Compare July 12, 2020 11:47

Alexander-Miller force-pushed the timestamp-group branch from 82e546d to a23d9cb Compare July 12, 2020 20:08

alphapapa added this to the 1.3 milestone Nov 20, 2020

alphapapa added the enhancement label Sep 24, 2021

alphapapa requested changes Sep 24, 2021

View reviewed changes

Alexander-Miller force-pushed the timestamp-group branch from a23d9cb to afae290 Compare October 3, 2021 11:27

Alexander-Miller force-pushed the timestamp-group branch 2 times, most recently from b84b744 to 3ce439e Compare October 4, 2021 19:26

Add timestamp selector.

3ce439e

alphapapa modified the milestones: 1.3, 1.4 Sep 23, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[WIP] Add timestamp selector. #154

[WIP] Add timestamp selector. #154

Alexander-Miller commented May 17, 2020

alphapapa commented May 29, 2020

Alexander-Miller commented Jun 4, 2020

Alexander-Miller commented Jun 14, 2020

alphapapa commented Jun 15, 2020

Alexander-Miller commented Jul 11, 2020

alphapapa commented Jul 12, 2020

Alexander-Miller commented Jul 12, 2020

alphapapa commented Jul 12, 2020 •

edited

Loading

Alexander-Miller commented Jul 12, 2020

alphapapa commented Sep 24, 2021

alphapapa left a comment

alphapapa Sep 24, 2021

Alexander-Miller Oct 3, 2021

alphapapa Sep 24, 2021

Alexander-Miller Oct 3, 2021

alphapapa Sep 24, 2021

Alexander-Miller Oct 3, 2021

alphapapa Sep 24, 2021

Alexander-Miller Oct 3, 2021

Alexander-Miller commented Oct 3, 2021

		@@ -1,4 +1,4 @@
		This is README.info, produced by makeinfo version 5.2 from README.texi.
		This is README.info, produced by makeinfo version 6.7 from README.texi.

[WIP] Add timestamp selector. #154

Are you sure you want to change the base?

[WIP] Add timestamp selector. #154

Conversation

Alexander-Miller commented May 17, 2020

alphapapa commented May 29, 2020

Alexander-Miller commented Jun 4, 2020

Alexander-Miller commented Jun 14, 2020

alphapapa commented Jun 15, 2020

Alexander-Miller commented Jul 11, 2020

alphapapa commented Jul 12, 2020

Alexander-Miller commented Jul 12, 2020

alphapapa commented Jul 12, 2020 • edited Loading

Alexander-Miller commented Jul 12, 2020

alphapapa commented Sep 24, 2021

alphapapa left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Alexander-Miller commented Oct 3, 2021

alphapapa commented Jul 12, 2020 •

edited

Loading