[PATCH] org-agenda tag completion works with ido

[PATCH] org-agenda tag completion works with ido

[Nathaniel Flath]

[-- Attachment #1: Type: text/plain, Size: 322 bytes --]

After upgrading to the latest org-mode, tag completion when filtering
in the agenda was broken - I had to fully enter the tag, despite using
ido  (eg I would have a tag 'home', and 'ho-enter' would not compete).
Minor patch to fix this behaviour is attached.  Let me know if there
are any issues.

Thanks,
Nathaniel Flath

[-- Attachment #2: 0001-completing-read-in-org-agenda-filter-by-tag-complete.patch --]
[-- Type: application/octet-stream, Size: 1116 bytes --]

From c9e2a82d7db183749715bf19ab35609ec5ae3b14 Mon Sep 17 00:00:00 2001
From: Nathaniel Flath <flat0103@gmail.com>
Date: Wed, 12 Jul 2017 17:15:04 -0700
Subject: [PATCH] completing-read in org-agenda-filter-by-tag completes
 partially-entered input

* org-agenda.el (org-agenda-filter-by-tag):
(org-agenda-filter-by-tag): pass t to require-match argument of completing-read.
This causes ido-mode to complete tags properly when inputting partial matches, rather
that just sending the typed input.
---
 lisp/org-agenda.el | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/lisp/org-agenda.el b/lisp/org-agenda.el
index 9ac4f65..20d128d 100644
--- a/lisp/org-agenda.el
+++ b/lisp/org-agenda.el
@@ -7496,7 +7496,7 @@ also press `-' or `+' to switch between filtering and excluding."
 		    (org-global-tags-completion-table)))
       (let ((completion-ignore-case t))
 	(setq tag (completing-read
-		   "Tag: " org-global-tags-completion-table))))
+		   "Tag: " org-global-tags-completion-table nil t))))
     (cond
      ((eq char ?\r)
       (org-agenda-filter-show-all-tag)
-- 
2.10.1 (Apple Git-78)

Re: [PATCH] org-agenda tag completion works with ido

[Kyle Meyer]

Nathaniel Flath <flat0103@gmail.com> writes:

> After upgrading to the latest org-mode, tag completion when filtering
> in the agenda was broken - I had to fully enter the tag, despite using
> ido  (eg I would have a tag 'home', and 'ho-enter' would not compete).

[...]

> * org-agenda.el (org-agenda-filter-by-tag):
> (org-agenda-filter-by-tag): pass t to require-match argument of completing-read.

  ^ repeated function name

> This causes ido-mode to complete tags properly when inputting partial matches, rather
> that just sending the typed input.

Wouldn't this mean that, in general, ido won't complete partial matches
properly when require-match is nil?  That doesn't sound right.

I'm not an ido user, but testing with

    (require 'ido-ubiquitous)
    (ido-ubiquitous-mode 1)

partial completion seems to work fine when I hit tab after calling
org-agenda-filter-by-tag.  Are you using ido-ubiquitous, or are you
using some other package to get ido completion for non-file/buffer
completion?

In this particular case, your change looks OK because I think all useful
values should be in the collection.  But I don't understand why you're
not able to do partial completion without this change.  Are you running
into the same issue everywhere else that completing-read is called with
a nil value for require-match?

-- 
Kyle

Re: [PATCH] org-agenda tag completion works with ido

[Nathaniel Flath]

[-- Attachment #1: Type: text/plain, Size: 1687 bytes --]

On Wed, Jul 12, 2017 at 9:35 PM, Kyle Meyer <kyle@kyleam.com> wrote:
> Nathaniel Flath <flat0103@gmail.com> writes:
>
>> After upgrading to the latest org-mode, tag completion when filtering
>> in the agenda was broken - I had to fully enter the tag, despite using
>> ido  (eg I would have a tag 'home', and 'ho-enter' would not compete).
>
> [...]
>
>> * org-agenda.el (org-agenda-filter-by-tag):
>> (org-agenda-filter-by-tag): pass t to require-match argument of completing-read.
>
>   ^ repeated function name
>

Removed that in patch attached.

>> This causes ido-mode to complete tags properly when inputting partial matches, rather
>> that just sending the typed input.
>
> Wouldn't this mean that, in general, ido won't complete partial matches
> properly when require-match is nil?  That doesn't sound right.
>
> I'm not an ido user, but testing with
>
>     (require 'ido-ubiquitous)
>     (ido-ubiquitous-mode 1)
>
> partial completion seems to work fine when I hit tab after calling
> org-agenda-filter-by-tag.  Are you using ido-ubiquitous, or are you
> using some other package to get ido completion for non-file/buffer
> completion?

The issue is that that 'tab' is required - in the previous version of
org, this was not required and 'enter' would do the completion for
you.

>
> In this particular case, your change looks OK because I think all useful
> values should be in the collection.  But I don't understand why you're
> not able to do partial completion without this change.  Are you running
> into the same issue everywhere else that completing-read is called with
> a nil value for require-match?

I haven't checked everywhere else - presumably.


>
> --
> Kyle

[-- Attachment #2: 0001-completing-read-in-org-agenda-filter-by-tag-complete.patch --]
[-- Type: application/octet-stream, Size: 1089 bytes --]

From 002c8674ec9db51ed2cc16e73b43d02aa844ea00 Mon Sep 17 00:00:00 2001
From: Nathaniel Flath <flat0103@gmail.com>
Date: Wed, 12 Jul 2017 17:15:04 -0700
Subject: [PATCH] completing-read in org-agenda-filter-by-tag completes
 partially-entered input

* org-agenda.el:
(org-agenda-filter-by-tag): pass t to require-match argument of completing-read.
This causes ido-mode to complete tags properly when inputting partial matches, rather
that just sending the typed input.
---
 lisp/org-agenda.el | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/lisp/org-agenda.el b/lisp/org-agenda.el
index 9ac4f65..20d128d 100644
--- a/lisp/org-agenda.el
+++ b/lisp/org-agenda.el
@@ -7496,7 +7496,7 @@ also press `-' or `+' to switch between filtering and excluding."
 		    (org-global-tags-completion-table)))
       (let ((completion-ignore-case t))
 	(setq tag (completing-read
-		   "Tag: " org-global-tags-completion-table))))
+		   "Tag: " org-global-tags-completion-table nil t))))
     (cond
      ((eq char ?\r)
       (org-agenda-filter-show-all-tag)
-- 
2.10.1 (Apple Git-78)

Re: [PATCH] org-agenda tag completion works with ido

[Kyle Meyer]

Nathaniel Flath <flat0103@gmail.com> writes:

[...]

>> I'm not an ido user, but testing with
>>
>>     (require 'ido-ubiquitous)
>>     (ido-ubiquitous-mode 1)
>>
>> partial completion seems to work fine when I hit tab after calling
>> org-agenda-filter-by-tag.  Are you using ido-ubiquitous, or are you
>> using some other package to get ido completion for non-file/buffer
>> completion?
>
> The issue is that that 'tab' is required - in the previous version of
> org, this was not required and 'enter' would do the completion for
> you.

I'm only using tab right after calling org-agenda-filter-by-tag to get
to the initial tag prompt, following the instructions in the minibuffer.
Isn't that always needed?

Here is how I'm testing (with emacs -Q):

  * list TODOs with the agenda (org-agenda, follow by "t")
  * on an entry, hit "/" for org-agenda-filter-by-tag
  * hit tab to get to the tag prompt

Once in the prompt, I can select a partial completion by just hitting
enter.

I've executed the above steps with two setups:
release_8.3.6/org-completion-use-ido and release_9.0.9/ido-ubiquitous.
I couldn't spot any differences.  Hitting enter for partial completion
worked in both cases.

>> In this particular case, your change looks OK because I think all useful
>> values should be in the collection.  But I don't understand why you're
>> not able to do partial completion without this change.  Are you running
>> into the same issue everywhere else that completing-read is called with
>> a nil value for require-match?
>
> I haven't checked everywhere else - presumably.

It'd be good to figure out why you're seeing different behavior than I
am.  Perhaps the steps I list above aren't the right steps to trigger
it.  Or maybe you have some non-default ido configuration.  Or maybe the
difference comes from an ido version mismatch.  (I'm using the ido from
Emacs 25.2 and ido-ubiquitous checked out at v3.14-4-ga1c2965.)

As it stands, I can't reproduce the problem described in your commit
message.

-- 
Kyle

Re: [PATCH] org-agenda tag completion works with ido

[Kyle Meyer]

Kyle Meyer <kyle@kyleam.com> writes:

[...]

> Or maybe the difference comes from an ido version mismatch.  (I'm
> using the ido from Emacs 25.2 and ido-ubiquitous checked out at
> v3.14-4-ga1c2965.)
>
> As it stands, I can't reproduce the problem described in your commit
> message.

I upgraded to the latest ido-ubiquitous (v3.16-67-g7b71365).  I'm still
unable to reproduce the issue.

-- 
Kyle

Re: [PATCH] org-agenda tag completion works with ido

[Nathaniel Flath]

On Thu, Jul 13, 2017 at 11:02 AM, Kyle Meyer <kyle@kyleam.com> wrote:
> Nathaniel Flath <flat0103@gmail.com> writes:
>
> [...]
>
>>> I'm not an ido user, but testing with
>>>
>>>     (require 'ido-ubiquitous)
>>>     (ido-ubiquitous-mode 1)
>>>
>>> partial completion seems to work fine when I hit tab after calling
>>> org-agenda-filter-by-tag.  Are you using ido-ubiquitous, or are you
>>> using some other package to get ido completion for non-file/buffer
>>> completion?
>>
>> The issue is that that 'tab' is required - in the previous version of
>> org, this was not required and 'enter' would do the completion for
>> you.
>
> I'm only using tab right after calling org-agenda-filter-by-tag to get
> to the initial tag prompt, following the instructions in the minibuffer.
> Isn't that always needed?
>
> Here is how I'm testing (with emacs -Q):
>
>   * list TODOs with the agenda (org-agenda, follow by "t")
>   * on an entry, hit "/" for org-agenda-filter-by-tag
>   * hit tab to get to the tag prompt
>
> Once in the prompt, I can select a partial completion by just hitting
> enter.

I follow the same steps:
 * list TODOs with the agenda (org-agenda, follow by "t")
 * on an entry, hit "/" for org-agenda-filter-by-tag
 * hit tab to get to the tag prompt
 * type 'ho' + enter - this causes everything to disappear, because it
is trying to filter for 'ho' instead of 'home' ('ho' is not a valid
tag)

I've upgraded to the lastest version of ido-ubiquitous and this
behaviour persists.
(This is also my understanding of what the expected behaviour should
be, based on testing of completing-read and reading the function
docs).

>
> I've executed the above steps with two setups:
> release_8.3.6/org-completion-use-ido and release_9.0.9/ido-ubiquitous.
> I couldn't spot any differences.  Hitting enter for partial completion
> worked in both cases.
>
>>> In this particular case, your change looks OK because I think all useful
>>> values should be in the collection.  But I don't understand why you're
>>> not able to do partial completion without this change.  Are you running
>>> into the same issue everywhere else that completing-read is called with
>>> a nil value for require-match?
>>
>> I haven't checked everywhere else - presumably.
>
> It'd be good to figure out why you're seeing different behavior than I
> am.  Perhaps the steps I list above aren't the right steps to trigger
> it.  Or maybe you have some non-default ido configuration.  Or maybe the
> difference comes from an ido version mismatch.  (I'm using the ido from
> Emacs 25.2 and ido-ubiquitous checked out at v3.14-4-ga1c2965.)

I'm on emacs 24.5.1 - I'll try updating, but I suspect the problem will persist.
>
> As it stands, I can't reproduce the problem described in your commit
> message.
>
> --
> Kyle

Re: [PATCH] org-agenda tag completion works with ido

[Nathaniel Flath]

Confirmed it's a difference in ido configuration - I'm using
ido-everywhere, not ido-ubiquitous.

On Thu, Jul 13, 2017 at 11:19 AM, Nathaniel Flath <flat0103@gmail.com> wrote:
> On Thu, Jul 13, 2017 at 11:02 AM, Kyle Meyer <kyle@kyleam.com> wrote:
>> Nathaniel Flath <flat0103@gmail.com> writes:
>>
>> [...]
>>
>>>> I'm not an ido user, but testing with
>>>>
>>>>     (require 'ido-ubiquitous)
>>>>     (ido-ubiquitous-mode 1)
>>>>
>>>> partial completion seems to work fine when I hit tab after calling
>>>> org-agenda-filter-by-tag.  Are you using ido-ubiquitous, or are you
>>>> using some other package to get ido completion for non-file/buffer
>>>> completion?
>>>
>>> The issue is that that 'tab' is required - in the previous version of
>>> org, this was not required and 'enter' would do the completion for
>>> you.
>>
>> I'm only using tab right after calling org-agenda-filter-by-tag to get
>> to the initial tag prompt, following the instructions in the minibuffer.
>> Isn't that always needed?
>>
>> Here is how I'm testing (with emacs -Q):
>>
>>   * list TODOs with the agenda (org-agenda, follow by "t")
>>   * on an entry, hit "/" for org-agenda-filter-by-tag
>>   * hit tab to get to the tag prompt
>>
>> Once in the prompt, I can select a partial completion by just hitting
>> enter.
>
> I follow the same steps:
>  * list TODOs with the agenda (org-agenda, follow by "t")
>  * on an entry, hit "/" for org-agenda-filter-by-tag
>  * hit tab to get to the tag prompt
>  * type 'ho' + enter - this causes everything to disappear, because it
> is trying to filter for 'ho' instead of 'home' ('ho' is not a valid
> tag)
>
> I've upgraded to the lastest version of ido-ubiquitous and this
> behaviour persists.
> (This is also my understanding of what the expected behaviour should
> be, based on testing of completing-read and reading the function
> docs).
>
>>
>> I've executed the above steps with two setups:
>> release_8.3.6/org-completion-use-ido and release_9.0.9/ido-ubiquitous.
>> I couldn't spot any differences.  Hitting enter for partial completion
>> worked in both cases.
>>
>>>> In this particular case, your change looks OK because I think all useful
>>>> values should be in the collection.  But I don't understand why you're
>>>> not able to do partial completion without this change.  Are you running
>>>> into the same issue everywhere else that completing-read is called with
>>>> a nil value for require-match?
>>>
>>> I haven't checked everywhere else - presumably.
>>
>> It'd be good to figure out why you're seeing different behavior than I
>> am.  Perhaps the steps I list above aren't the right steps to trigger
>> it.  Or maybe you have some non-default ido configuration.  Or maybe the
>> difference comes from an ido version mismatch.  (I'm using the ido from
>> Emacs 25.2 and ido-ubiquitous checked out at v3.14-4-ga1c2965.)
>
> I'm on emacs 24.5.1 - I'll try updating, but I suspect the problem will persist.
>>
>> As it stands, I can't reproduce the problem described in your commit
>> message.
>>
>> --
>> Kyle

Re: [PATCH] org-agenda tag completion works with ido

[Kyle Meyer]

Nathaniel Flath <flat0103@gmail.com> writes:

> Confirmed it's a difference in ido configuration - I'm using
> ido-everywhere, not ido-ubiquitous.

OK, thanks.  So you were just seeing the default Emacs completion rather
than ido's.  My understanding is that ido-everywhere only adds ido for
buffer/file prompts, and so you'll need to use ido-ubiquitous to get ido
completion in with Org 9.  (Any package that overrides
completing-read-function should work, so you can also use helm, ivy,
etc).

-- 
Kyle

Re: [PATCH] org-agenda tag completion works with ido

[Nathaniel Flath]

I suppose so.  I still think this is a correct patch, since it doesn't
make sense to filter for non-existent tags.

On Thu, Jul 13, 2017 at 12:19 PM, Kyle Meyer <kyle@kyleam.com> wrote:
> Nathaniel Flath <flat0103@gmail.com> writes:
>
>> Confirmed it's a difference in ido configuration - I'm using
>> ido-everywhere, not ido-ubiquitous.
>
> OK, thanks.  So you were just seeing the default Emacs completion rather
> than ido's.  My understanding is that ido-everywhere only adds ido for
> buffer/file prompts, and so you'll need to use ido-ubiquitous to get ido
> completion in with Org 9.  (Any package that overrides
> completing-read-function should work, so you can also use helm, ivy,
> etc).
>
> --
> Kyle

Re: [PATCH] org-agenda tag completion works with ido

[Kyle Meyer]

Nathaniel Flath <flat0103@gmail.com> writes:

> I suppose so.  I still think this is a correct patch, since it doesn't
> make sense to filter for non-existent tags.

I agreed that require-match should be t earlier in the thread, but it
turns out that that's not the source of your issue.  I took time to
clarify this in order to a) help you solve your ido completion issue
everywhere, not just one specific case in one particular package, and b)
make the description in your commit message accurate, which it currently
isn't.

Feel free to send a new patch with an updated commit message.  Also,
based on the contributor list [*], you should mark it with a TINYCHANGE
cookie.  It looks like you're hitting up against your TINYCHANGE code
limit, so please consider signing FSF copyright papers for future
patches.

[*] http://orgmode.org/worg/org-contribute.html

-- 
Kyle

Re: [PATCH] org-agenda tag completion works with ido

[Nathaniel Flath]

[-- Attachment #1: Type: text/plain, Size: 1114 bytes --]

New patch attached.

I have already signed the FSF copyright papers, so I haven't marked as
TINYCHANGE - let me know if I still should.

On Thu, Jul 13, 2017 at 4:31 PM, Kyle Meyer <kyle@kyleam.com> wrote:
> Nathaniel Flath <flat0103@gmail.com> writes:
>
>> I suppose so.  I still think this is a correct patch, since it doesn't
>> make sense to filter for non-existent tags.
>
> I agreed that require-match should be t earlier in the thread, but it
> turns out that that's not the source of your issue.  I took time to
> clarify this in order to a) help you solve your ido completion issue
> everywhere, not just one specific case in one particular package, and b)
> make the description in your commit message accurate, which it currently
> isn't.
>
> Feel free to send a new patch with an updated commit message.  Also,
> based on the contributor list [*], you should mark it with a TINYCHANGE
> cookie.  It looks like you're hitting up against your TINYCHANGE code
> limit, so please consider signing FSF copyright papers for future
> patches.
>
> [*] http://orgmode.org/worg/org-contribute.html
>
> --
> Kyle

[-- Attachment #2: 0001-completing-read-in-org-agenda-filter-by-tag-only-acc.patch --]
[-- Type: application/octet-stream, Size: 1040 bytes --]

From af4fe22c962aa83e039c4bb8611c0e9b9d7f7e19 Mon Sep 17 00:00:00 2001
From: Nathaniel Flath <flat0103@gmail.com>
Date: Wed, 12 Jul 2017 17:15:04 -0700
Subject: [PATCH] completing-read in org-agenda-filter-by-tag only accepts
 valid tags.

* org-agenda.el:
(org-agenda-filter-by-tag): pass t to require-match argument of completing-read.
This causes emacs to accept the full tag name when entering a prefix of one.
---
 lisp/org-agenda.el | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/lisp/org-agenda.el b/lisp/org-agenda.el
index 9ac4f6583..20d128d0d 100644
--- a/lisp/org-agenda.el
+++ b/lisp/org-agenda.el
@@ -7496,7 +7496,7 @@ also press `-' or `+' to switch between filtering and excluding."
 		    (org-global-tags-completion-table)))
       (let ((completion-ignore-case t))
 	(setq tag (completing-read
-		   "Tag: " org-global-tags-completion-table))))
+		   "Tag: " org-global-tags-completion-table nil t))))
     (cond
      ((eq char ?\r)
       (org-agenda-filter-show-all-tag)
-- 
2.11.0 (Apple Git-81)

Re: [PATCH] org-agenda tag completion works with ido

[Kyle Meyer]

Nathaniel Flath <flat0103@gmail.com> writes:

> New patch attached.

applied (with some tweaks to the commit message)

> I have already signed the FSF copyright papers, so I haven't marked as
> TINYCHANGE - let me know if I still should.

Great, I've updated http://orgmode.org/worg/org-contribute.html

-- 
Kyle