completion breaks on spaces in paths

[natling]

completion functions generated using <file> and <directory> syntax dont seem to handle paths containing whitespace correctly. since compgen output is newline-delimited i think this could be fixed by replacing COMPREPLY=( $( compgen ... ) ) with readarray -t COMPREPLY < <( compgen ... ). or am i doing something wrong?

thanks for this library and for bashly! theyre both lovely

[DannyBen]

Hi. Thanks for bringing that up, and I am glad you find these symbiotic tools useful.

I can reproduce the problem easily, however I am a bit reluctant to use readarray since:

1. I never saw it being used in other completion script - please correct me with a reference if I am wrong.
2. I remember reading somewhere that readarray behaves differently in different shells (zsh doesnt seem to support it)

That said, I agree it needs fixing. I will do some digging later today and hopefully find an easy fix.

[DannyBen]

Well - after some investigation and testing, I found out that:

1. The readarray approach does not work in zsh
2. The local IFS=$'\n' approach breaks the tests (see below)
3. The -A file option, when used in the complete command rather than the compgen command, returns properly escaped spaced filenames - but this option is not suitable for completely, since file (and other -A completions) are added per subcommands.

To simply reproduce the failure, run this command

# WORKS
$ compgen -W "commit console pull push" -- "co"
# commit
# console

# FAILS
$ IFS=$'\n'  compgen -W "commit console pull push" -- "co"
# commit console pull push

If there is a way to make this work, maybe it will be the solution, otherwise, at this point, I am not sure how to fix it.

[natling]

how about this?

while read; do COMPREPLY+=( "$REPLY" ); done < <( compgen ... )

[DannyBen]

while read; do COMPREPLY+=( "$REPLY" ); done < <( compgen ... )

I was very skeptical about it, but it seems to be working fine.
One problem still (but I think it is unavoidable) is that filenames with spaces are not presented with escaped spaces.

Can you test your use case with the version in the PR? You will need to create this Gemfile:

# frozen_string_literal: true
source "https://rubygems.org"
gem "completely", git: "https://github.com/dannyben/completely.git", branch: "fix/spaced-filenames"

then run bundle then replace any completely command with bundle exec completely.

In the meantime, I will add some tests for covering this scenario.

[natling]

sorry about the delayed response - it works great. much appreciated

[DannyBen]

Excellent. I will merge and release later.

[DannyBen]

Thanks for reporting this and helping with the fix.
Version 0.4.3 is now released with the fix.