Improve completion with '~/...' arguments.

Author: floitsch

src/completion-scripts_.toit

@@ -72,8 +72,16 @@ bash-completion-script_ --program-path/string -> string:
         local IFS=\$'\\n'
         shopt -s extglob 2>/dev/null
 
+        # Expand tildes (e.g. ~/foo -> /home/user/foo) so the program
+        # receives real filesystem paths it can open.
+        local -a expanded_words
+        local _w
+        for _w in "\${COMP_WORDS[@]:1:\$COMP_CWORD}"; do
+            expanded_words+=("\${_w/#\\~/\$HOME}")
+        done
+
         local completions
-        completions=\$("$program-path" __complete -- "\${COMP_WORDS[@]:1:\$COMP_CWORD}")
+        completions=\$("$program-path" __complete -- "\${expanded_words[@]}")
         if [ \$? -ne 0 ]; then
             return
         fi
@@ -149,8 +157,16 @@ zsh-completion-script_ --program-path/string -> string:
         local -a completions
         local directive_line directive extensions=""
 
+        # Expand tildes (e.g. ~/foo -> /home/user/foo) so the program
+        # receives real filesystem paths it can open.
+        local -a expanded_words
+        local _w
+        for _w in "\${words[@]:1:\$((CURRENT-1))}"; do
+            expanded_words+=("\${_w/#\\~/\$HOME}")
+        done
+
         local output
-        output=\$("$program-path" __complete -- "\${words[@]:1:\$((CURRENT-1))}" 2>/dev/null)
+        output=\$("$program-path" __complete -- "\${expanded_words[@]}" 2>/dev/null)
         if [ \$? -ne 0 ]; then
             return
         fi

tests/completion_shell_bash_test.toit

@@ -99,6 +99,33 @@ test-bash binary/string tmpdir/string:
     expect (content.contains "beta")
     tmux.cancel
 
+    // Tilde expansion: the "lookup" command opens the file given as the
+    //   first rest arg and offers fixed candidates for the second arg.
+    //   When the file path uses ~, the shell must expand the tilde so
+    //   the program can open the file.
+    // Find an existing file in $HOME to avoid creating test artifacts.
+    tmux.send-line "for f in .profile .bashrc .zshrc .zshenv .bash_profile .config; do test -e ~/\$f && echo tilde-found:\$f && break; done"
+    tmux.wait-for "tilde-found:"
+    tilde-file := ""
+    lines := (tmux.capture).split "\n"
+    lines.do: | line/string |
+      if line.contains "tilde-found:" and tilde-file == "":
+        tilde-file = ((line.trim).split ":").last
+
+    expect (tilde-file != "")
+
+    // Re-source with absolute path.
+    tmux.send-line "source <($binary completion bash) && echo re-sourced2"
+    tmux.wait-for "re-sourced2"
+
+    // Complete the entry arg using a tilde path for the file.
+    tmux.send-keys ["$binary lookup ~/$(tilde-file) ", "Tab", "Tab"]
+    tmux.wait-for "tilde-ok-alpha"
+    content = tmux.capture
+    expect (content.contains "tilde-ok-bravo")
+    expect (content.contains "tilde-ok-charlie")
+    tmux.cancel
+
     print "  All bash tests passed."
   finally:
     tmux.close

tests/completion_shell_test_app.toit

@@ -6,6 +6,7 @@
 // shell completion end-to-end via tmux.
 
 import cli show *
+import host.file
 
 KNOWN-DEVICES ::= {
   "d3b07384-d113-4ec6-a7d2-8c6b2ab3e8f5": "Living Room Sensor",
@@ -51,4 +52,36 @@ main arguments:
           ]
           --run=:: null
 
+  // "lookup" command: opens a file (first rest arg) and, if successful,
+  //   offers fixed completion candidates for the second rest arg. This
+  //   exercises tilde expansion: the shell must expand ~/... before the
+  //   program tries to open the file.
+  root.add
+      Command "lookup"
+          --help="Look up an entry in a file."
+          --rest=[
+            OptionPath "file" --help="Input file." --required,
+            Option "entry"
+                --help="Entry to look up."
+                --completion=:: | ctx/CompletionContext |
+                  file-values := ctx.seen-options.get "file"
+                  if not file-values or file-values.is-empty:
+                    []
+                  else:
+                    opened := false
+                    catch:
+                      file.read-contents file-values.first
+                      opened = true
+                    if not opened:
+                      []
+                    else:
+                      result := []
+                      candidates := ["tilde-ok-alpha", "tilde-ok-bravo", "tilde-ok-charlie"]
+                      candidates.do: | c/string |
+                        if c.starts-with ctx.prefix:
+                          result.add (CompletionCandidate c)
+                      result,
+          ]
+          --run=:: null
+
   root.run arguments

tests/completion_shell_zsh_test.toit

@@ -89,6 +89,33 @@ test-zsh binary/string tmpdir/string:
     expect (content.contains "beta")
     tmux.cancel
 
+    // Tilde expansion: the "lookup" command opens the file given as the
+    //   first rest arg and offers fixed candidates for the second arg.
+    //   When the file path uses ~, the shell must expand the tilde so
+    //   the program can open the file.
+    // Find an existing file in $HOME to avoid creating test artifacts.
+    tmux.send-line "for f in .profile .bashrc .zshrc .zshenv .bash_profile .config; do test -e ~/\$f && echo tilde-found:\$f && break; done"
+    tmux.wait-for "tilde-found:"
+    tilde-file := ""
+    lines := (tmux.capture).split "\n"
+    lines.do: | line/string |
+      if line.contains "tilde-found:" and tilde-file == "":
+        tilde-file = ((line.trim).split ":").last
+
+    expect (tilde-file != "")
+
+    // Re-source with absolute path (original binary).
+    tmux.send-line "source <($binary completion zsh) && echo re-sourced2"
+    tmux.wait-for "re-sourced2"
+
+    // Complete the entry arg using a tilde path for the file.
+    tmux.send-keys ["$binary lookup ~/$(tilde-file) ", "Tab"]
+    tmux.wait-for "tilde-ok-alpha"
+    content = tmux.capture
+    expect (content.contains "tilde-ok-bravo")
+    expect (content.contains "tilde-ok-charlie")
+    tmux.cancel
+
     print "  All zsh tests passed."
   finally:
     tmux.close