Merge pull request #27 from DannyBen/fix/spaced-filenames

Fix file/folder completion when they contain spaces
DannyBen · Jul 14, 2022 · 022a061 · 022a061
2 parents 42cc38c + 2f2c63b
commit 022a061
Show file tree

Hide file tree

Showing 17 changed files with 51 additions and 37 deletions.
diff --git a/lib/completely/templates/template.erb b/lib/completely/templates/template.erb
@@ -19,7 +19,7 @@
 % patterns.each do |pattern|
 % next if pattern.empty?
     <%= pattern.case_string %>)
-      COMPREPLY=($(compgen <%= pattern.compgen %> -- "$cur"))
+      while read; do COMPREPLY+=( "$REPLY" ); done < <( compgen <%= pattern.compgen %> -- "$cur" )
       ;;
 
 % end

diff --git a/lib/completely/templates/tester-template.erb b/lib/completely/templates/tester-template.erb
@@ -16,4 +16,7 @@ COMP_POINT=${#COMP_LINE}
 COMP_CWORD=<%= cword %>
 
 <%= function_name %>
-echo "${COMPREPLY[*]}"
+for suggestion in "${COMPREPLY[@]}"; do
+  echo "$suggestion"
+done
+
diff --git a/lib/completely/tester.rb b/lib/completely/tester.rb
@@ -14,7 +14,7 @@ def test(compline)
         f << tester_script(compline)
         f.flush
         `bash #{f.path}`
-      end.split " "
+      end.split "\n"
     end
 
     def tester_script(compline)

diff --git a/spec/approvals/cli/generated-script b/spec/approvals/cli/generated-script
@@ -10,19 +10,19 @@ _mygit_completions() {
 
   case "$compline" in
     'status'*)
-      COMPREPLY=($(compgen -W "--help --verbose --branch $(git branch 2> /dev/null)" -- "$cur"))
+      while read; do COMPREPLY+=( "$REPLY" ); done < <( compgen -W "--help --verbose --branch $(git branch 2> /dev/null)" -- "$cur" )
       ;;
 
     'commit'*)
-      COMPREPLY=($(compgen -A file -W "--help --message --all -a --quiet -q" -- "$cur"))
+      while read; do COMPREPLY+=( "$REPLY" ); done < <( compgen -A file -W "--help --message --all -a --quiet -q" -- "$cur" )
       ;;
 
     'init'*)
-      COMPREPLY=($(compgen -A directory -W "--bare" -- "$cur"))
+      while read; do COMPREPLY+=( "$REPLY" ); done < <( compgen -A directory -W "--bare" -- "$cur" )
       ;;
 
     *)
-      COMPREPLY=($(compgen -W "--help --version status init commit" -- "$cur"))
+      while read; do COMPREPLY+=( "$REPLY" ); done < <( compgen -W "--help --version status init commit" -- "$cur" )
       ;;
 
   esac

diff --git a/spec/approvals/cli/generated-script-alt b/spec/approvals/cli/generated-script-alt
@@ -10,19 +10,19 @@ _mycomps() {
 
   case "$compline" in
     'status'*)
-      COMPREPLY=($(compgen -W "--help --verbose --branch $(git branch 2> /dev/null)" -- "$cur"))
+      while read; do COMPREPLY+=( "$REPLY" ); done < <( compgen -W "--help --verbose --branch $(git branch 2> /dev/null)" -- "$cur" )
       ;;
 
     'commit'*)
-      COMPREPLY=($(compgen -A file -W "--help --message --all -a --quiet -q" -- "$cur"))
+      while read; do COMPREPLY+=( "$REPLY" ); done < <( compgen -A file -W "--help --message --all -a --quiet -q" -- "$cur" )
       ;;
 
     'init'*)
-      COMPREPLY=($(compgen -A directory -W "--bare" -- "$cur"))
+      while read; do COMPREPLY+=( "$REPLY" ); done < <( compgen -A directory -W "--bare" -- "$cur" )
       ;;
 
     *)
-      COMPREPLY=($(compgen -W "--help --version status init commit" -- "$cur"))
+      while read; do COMPREPLY+=( "$REPLY" ); done < <( compgen -W "--help --version status init commit" -- "$cur" )
       ;;
 
   esac

diff --git a/spec/approvals/cli/generated-wrapped-script b/spec/approvals/cli/generated-wrapped-script
@@ -11,19 +11,19 @@ give_comps() {
   echo $''
   echo $'  case "$compline" in'
   echo $'    \'status\'*)'
-  echo $'      COMPREPLY=($(compgen -W "--help --verbose --branch $(git branch 2> /dev/null)" -- "$cur"))'
+  echo $'      while read; do COMPREPLY+=( "$REPLY" ); done < <( compgen -W "--help --verbose --branch $(git branch 2> /dev/null)" -- "$cur" )'
   echo $'      ;;'
   echo $''
   echo $'    \'commit\'*)'
-  echo $'      COMPREPLY=($(compgen -A file -W "--help --message --all -a --quiet -q" -- "$cur"))'
+  echo $'      while read; do COMPREPLY+=( "$REPLY" ); done < <( compgen -A file -W "--help --message --all -a --quiet -q" -- "$cur" )'
   echo $'      ;;'
   echo $''
   echo $'    \'init\'*)'
-  echo $'      COMPREPLY=($(compgen -A directory -W "--bare" -- "$cur"))'
+  echo $'      while read; do COMPREPLY+=( "$REPLY" ); done < <( compgen -A directory -W "--bare" -- "$cur" )'
   echo $'      ;;'
   echo $''
   echo $'    *)'
-  echo $'      COMPREPLY=($(compgen -W "--help --version status init commit" -- "$cur"))'
+  echo $'      while read; do COMPREPLY+=( "$REPLY" ); done < <( compgen -W "--help --version status init commit" -- "$cur" )'
   echo $'      ;;'
   echo $''
   echo $'  esac'

diff --git a/spec/approvals/cli/test/completely-tester.sh b/spec/approvals/cli/test/completely-tester.sh
@@ -18,19 +18,19 @@ _mygit_completions() {
 
   case "$compline" in
     'status'*)
-      COMPREPLY=($(compgen -W "--help --verbose --branch $(git branch 2> /dev/null)" -- "$cur"))
+      while read; do COMPREPLY+=( "$REPLY" ); done < <( compgen -W "--help --verbose --branch $(git branch 2> /dev/null)" -- "$cur" )
       ;;
 
     'commit'*)
-      COMPREPLY=($(compgen -A file -W "--help --message --all -a --quiet -q" -- "$cur"))
+      while read; do COMPREPLY+=( "$REPLY" ); done < <( compgen -A file -W "--help --message --all -a --quiet -q" -- "$cur" )
       ;;
 
     'init'*)
-      COMPREPLY=($(compgen -A directory -W "--bare" -- "$cur"))
+      while read; do COMPREPLY+=( "$REPLY" ); done < <( compgen -A directory -W "--bare" -- "$cur" )
       ;;
 
     *)
-      COMPREPLY=($(compgen -W "--help --version status init commit" -- "$cur"))
+      while read; do COMPREPLY+=( "$REPLY" ); done < <( compgen -W "--help --version status init commit" -- "$cur" )
       ;;
 
   esac
@@ -48,4 +48,7 @@ COMP_POINT=${#COMP_LINE}
 COMP_CWORD=2
 
 _mygit_completions
-echo "${COMPREPLY[*]}"
+for suggestion in "${COMPREPLY[@]}"; do
+  echo "$suggestion"
+done
+
diff --git a/spec/approvals/completions/function b/spec/approvals/completions/function
@@ -11,15 +11,15 @@ send_completions() {
   echo $''
   echo $'  case "$compline" in'
   echo $'    \'generate\'*)'
-  echo $'      COMPREPLY=($(compgen -A directory -W "--help --force" -- "$cur"))'
+  echo $'      while read; do COMPREPLY+=( "$REPLY" ); done < <( compgen -A directory -W "--help --force" -- "$cur" )'
   echo $'      ;;'
   echo $''
   echo $'    \'init\'*)'
-  echo $'      COMPREPLY=($(compgen -W "--help" -- "$cur"))'
+  echo $'      while read; do COMPREPLY+=( "$REPLY" ); done < <( compgen -W "--help" -- "$cur" )'
   echo $'      ;;'
   echo $''
   echo $'    *)'
-  echo $'      COMPREPLY=($(compgen -W "--help --version init generate" -- "$cur"))'
+  echo $'      while read; do COMPREPLY+=( "$REPLY" ); done < <( compgen -W "--help --version init generate" -- "$cur" )'
   echo $'      ;;'
   echo $''
   echo $'  esac'

diff --git a/spec/approvals/completions/script b/spec/approvals/completions/script
@@ -10,15 +10,15 @@ _completely_completions() {
 
   case "$compline" in
     'generate'*)
-      COMPREPLY=($(compgen -A directory -W "--help --force" -- "$cur"))
+      while read; do COMPREPLY+=( "$REPLY" ); done < <( compgen -A directory -W "--help --force" -- "$cur" )
       ;;
 
     'init'*)
-      COMPREPLY=($(compgen -W "--help" -- "$cur"))
+      while read; do COMPREPLY+=( "$REPLY" ); done < <( compgen -W "--help" -- "$cur" )
       ;;
 
     *)
-      COMPREPLY=($(compgen -W "--help --version init generate" -- "$cur"))
+      while read; do COMPREPLY+=( "$REPLY" ); done < <( compgen -W "--help --version init generate" -- "$cur" )
       ;;
 
   esac

diff --git a/spec/approvals/completions/script-only-spaces b/spec/approvals/completions/script-only-spaces
@@ -10,11 +10,11 @@ _completely_completions() {
 
   case "$compline" in
     'generate'*)
-      COMPREPLY=($(compgen -A directory -W "--help --force" -- "$cur"))
+      while read; do COMPREPLY+=( "$REPLY" ); done < <( compgen -A directory -W "--help --force" -- "$cur" )
       ;;
 
     'init'*)
-      COMPREPLY=($(compgen -W "--help" -- "$cur"))
+      while read; do COMPREPLY+=( "$REPLY" ); done < <( compgen -W "--help" -- "$cur" )
       ;;
 
   esac

diff --git a/spec/approvals/tester/script b/spec/approvals/tester/script
@@ -16,4 +16,7 @@ COMP_POINT=${#COMP_LINE}
 COMP_CWORD=1
 
 _cli_completions
-echo "${COMPREPLY[*]}"
+for suggestion in "${COMPREPLY[@]}"; do
+  echo "$suggestion"
+done
+
diff --git a/spec/approvals/tester/script_path b/spec/approvals/tester/script_path
@@ -16,4 +16,7 @@ COMP_POINT=${#COMP_LINE}
 COMP_CWORD=1
 
 _cli_completions
-echo "${COMPREPLY[*]}"
+for suggestion in "${COMPREPLY[@]}"; do
+  echo "$suggestion"
+done
+
diff --git a/spec/completely/integration.yml b/spec/completely/integration.yml
@@ -7,9 +7,10 @@ ftp:
 
 - compline: "ftp download "
   expected: [--help, --override, another-dir, dummy-dir, ftp.yaml, gradual.yaml]
+  expected: [--help, --override, another-dir, dir with spaces, dummy-dir, file with spaces.txt, ftp.yaml, gradual.yaml]
 
 - compline: "ftp upload "
-  expected: [--confirm, --help, another-dir, dummy-dir]
+  expected: [--confirm, --help, another-dir, dir with spaces, dummy-dir]
 
 - compline: "ftp connect ssh "
   expected: [--keyfile]

diff --git a/spec/completely/zsh_spec.rb b/spec/completely/zsh_spec.rb
@@ -20,14 +20,14 @@
 
   describe "completions script and test script" do
     it "returns completions without erroring" do
-      expect(subject).to eq "somedir --help --force"
+      expect(subject).to eq "somedir\n--help\n--force"
     end
 
     context "on bash" do
       let(:shell) { 'bash' }
 
       it "returns the same output" do
-        expect(subject).to eq "somedir --help --force"
+        expect(subject).to eq "somedir\n--help\n--force"
       end
     end
   end

diff --git a/spec/fixtures/integration/dir with spaces/.keep b/spec/fixtures/integration/dir with spaces/.keep
diff --git a/spec/fixtures/integration/file with spaces.txt b/spec/fixtures/integration/file with spaces.txt
@@ -0,0 +1 @@
+  <-- more spaces
diff --git a/spec/fixtures/tester/default.bash b/spec/fixtures/tester/default.bash
@@ -10,19 +10,19 @@ _cli_completions() {
 
   case "$compline" in
     'command childcommand'*)
-      COMPREPLY=($(compgen -W "--quiet --verbose -q -v" -- "$cur"))
+      while read; do COMPREPLY+=( "$REPLY" ); done < <( compgen -W "--quiet --verbose -q -v" -- "$cur" )
       ;;
 
     'command subcommand'*)
-      COMPREPLY=($(compgen -W "--force --quiet" -- "$cur"))
+      while read; do COMPREPLY+=( "$REPLY" ); done < <( compgen -W "--force --quiet" -- "$cur" )
       ;;
 
     'command'*)
-      COMPREPLY=($(compgen -W "subcommand childcommand" -- "$cur"))
+      while read; do COMPREPLY+=( "$REPLY" ); done < <( compgen -W "subcommand childcommand" -- "$cur" )
       ;;
 
     *)
-      COMPREPLY=($(compgen -W "--help --version command conquer" -- "$cur"))
+      while read; do COMPREPLY+=( "$REPLY" ); done < <( compgen -W "--help --version command conquer" -- "$cur" )
       ;;
 
   esac