- Fix dynamic completions (regression)

Author: DannyBen

AGENTS.md

@@ -0,0 +1,69 @@
+# AGENTS.md
+
+Guidance for coding agents working in this repository.
+
+## Repo Snapshot
+
+- Project: `completely` (Ruby gem that generates Bash completion scripts from YAML).
+- Key generation code:
+  - `lib/completely/pattern.rb`
+  - `lib/completely/templates/template.erb`
+- Core behavior tests:
+  - `spec/completely/integration_spec.rb`
+  - `spec/completely/commands/generate_spec.rb`
+
+## Working Rules
+
+- Keep changes minimal and localized, especially in:
+  - completion-word serialization (`Pattern`)
+  - generated script runtime behavior (`template.erb`)
+- Do not change generated approvals.
+- Do not run approval prompts interactively on behalf of the developer.
+- If an approval spec changes, stop and ask the developer to review/approve manually.
+- Prefer adding regression coverage in integration fixtures for completion behavior changes.
+
+## Fast Validation Loop
+
+Run these first after edits:
+
+```bash
+respec tagged script_quality
+respec only integration
+```
+
+If touching quoting/escaping or dynamic completions, also run:
+
+```bash
+respec only pattern
+respec only completions
+```
+
+## Formatting and Linting Notes
+
+- `shellcheck` and `shfmt` requirements are enforced by specs tagged `:script_quality` in `spec/completely/commands/generate_spec.rb`.
+- `shfmt` uses flags:
+  - `shfmt -d -i 2 -ci completely.bash`
+- Small whitespace differences in heredoc/redirect forms (like `<<<"$x"` vs `<<< "$x"`) can fail shfmt.
+
+## Approval Specs
+
+- Some specs use `rspec_approvals` and may prompt interactively if output changes.
+- In non-interactive runs this can fail with `Errno::ENOTTY`.
+- Approval decisions are always developer-owned. Agents should not approve/update snapshots.
+
+## Completion Semantics to Preserve
+
+- Literal YAML words with spaces/quotes must complete correctly.
+- Dynamic `$(...)` entries must produce multiple completion candidates when command output contains multiple words.
+- `<file>`, `<directory>`, and other `<...>` entries map to `compgen -A ...` actions and should remain unaffected by `-W` serialization changes.
+
+## Manual Repro Pattern
+
+Useful local sanity check:
+
+```bash
+cd dev
+ruby -I../lib ../bin/completely test "cli "
+```
+
+Expected: sensible mixed output for dynamic values and quoted/spaced literals.

lib/completely/pattern.rb

@@ -1,5 +1,7 @@
 module Completely
   class Pattern
+    DYNAMIC_WORD_PREFIX = '__completely_dynamic__'
+
     attr_reader :text, :completions, :function_name
 
     def initialize(text, completions, function_name)
@@ -54,12 +56,24 @@ def compgen
     def compgen!
       result = []
       result << actions.join(' ').to_s if actions.any?
-      result << %[-W "$(#{function_name} #{quoted_words.join ' '})"] if words.any?
+      result << %[-W "$(#{function_name} #{serialized_words.join ' '})"] if words.any?
       result.any? ? result.join(' ') : nil
     end
 
-    def quoted_words
-      @quoted_words ||= words.map { |word| %("#{escape_for_double_quotes word}") }
+    def serialized_words
+      @serialized_words ||= words.map { |word| serialize_word(word) }
+    end
+
+    def serialize_word(word)
+      if dynamic_word?(word)
+        return %("#{DYNAMIC_WORD_PREFIX}#{escape_for_double_quotes word}")
+      end
+
+      %("#{escape_for_double_quotes word}")
+    end
+
+    def dynamic_word?(word)
+      word.match?(/\A\$\(.+\)\z/)
     end
 
     def escape_for_double_quotes(word)

lib/completely/templates/template.erb

@@ -9,6 +9,7 @@
   local cur=${COMP_WORDS[COMP_CWORD]}
   local result=()
   local want_options=0
+  local dynamic_prefix="<%= Completely::Pattern::DYNAMIC_WORD_PREFIX %>"
 
   # words the user already typed (excluding the command itself)
   local used=()
@@ -20,19 +21,29 @@
   # Completing a non-option: drop options and already-used words.
   [[ "${cur:0:1}" == "-" ]] && want_options=1
   for word in "${words[@]}"; do
-    if ((!want_options)); then
-      [[ "${word:0:1}" == "-" ]] && continue
-
-      for u in "${used[@]}"; do
-        if [[ "$u" == "$word" ]]; then
-          continue 2
-        fi
-      done
+    local candidates=("$word")
+    if [[ "$word" == "$dynamic_prefix"* ]]; then
+      word="${word#"$dynamic_prefix"}"
+      word="${word//$'\r'/ }"
+      word="${word//$'\n'/ }"
+      read -r -a candidates <<<"$word"
     fi
 
-    # compgen -W expects shell-escaped words in one space-delimited string.
-    printf -v word '%q' "$word"
-    result+=("$word")
+    for candidate in "${candidates[@]}"; do
+      if ((!want_options)); then
+        [[ "${candidate:0:1}" == "-" ]] && continue
+
+        for u in "${used[@]}"; do
+          if [[ "$u" == "$candidate" ]]; then
+            continue 2
+          fi
+        done
+      fi
+
+      # compgen -W expects shell-escaped words in one space-delimited string.
+      printf -v candidate '%q' "$candidate"
+      result+=("$candidate")
+    done
   done
 
   echo "${result[*]}"

spec/README.md

@@ -2,19 +2,29 @@
 
 ## Running tests
 
+You can run specs with `rspec` as usual.
+
+We recommend using [`respec`][2], which wraps common spec workflows:
+
 ```bash
-$ rspec
+rspec
 # or
-$ run spec
-# or, to run just tests in a given file
-$ run spec zsh
-# or, to run just specs tagged with :focus
-$ run spec :focus
+respec
 ```
 
 You might need to prefix the commands with `bundle exec`, depending on the way
 Ruby is installed.
 
+Useful helper shortcuts:
+
+```bash
+# script quality checks (shellcheck + shfmt generated script tests)
+respec tagged script_quality
+
+# integration behavior suite
+respec only integration
+```
+
 ## Interactive Approvals
 
 Some tests may prompt you for an interactive approval of changes. This
@@ -29,4 +39,5 @@ ZSH compatibility test is done by running the completely tester script inside a
 zsh container. This is all done automatically by `spec/completely/zsh_spec.rb`.
 
 
-[1]: https://github.com/dannyben/rspec_approvals
+[1]: https://github.com/dannyben/rspec_approvals
+[2]: https://github.com/DannyBen/respec

spec/approvals/cli/generated-script

@@ -9,6 +9,7 @@ _mygit_completions_filter() {
   local cur=${COMP_WORDS[COMP_CWORD]}
   local result=()
   local want_options=0
+  local dynamic_prefix="__completely_dynamic__"
 
   # words the user already typed (excluding the command itself)
   local used=()
@@ -20,19 +21,29 @@ _mygit_completions_filter() {
   # Completing a non-option: drop options and already-used words.
   [[ "${cur:0:1}" == "-" ]] && want_options=1
   for word in "${words[@]}"; do
-    if ((!want_options)); then
-      [[ "${word:0:1}" == "-" ]] && continue
-
-      for u in "${used[@]}"; do
-        if [[ "$u" == "$word" ]]; then
-          continue 2
-        fi
-      done
+    local candidates=("$word")
+    if [[ "$word" == "$dynamic_prefix"* ]]; then
+      word="${word#"$dynamic_prefix"}"
+      word="${word//$'\r'/ }"
+      word="${word//$'\n'/ }"
+      read -r -a candidates <<<"$word"
     fi
 
-    # compgen -W expects shell-escaped words in one space-delimited string.
-    printf -v word '%q' "$word"
-    result+=("$word")
+    for candidate in "${candidates[@]}"; do
+      if ((!want_options)); then
+        [[ "${candidate:0:1}" == "-" ]] && continue
+
+        for u in "${used[@]}"; do
+          if [[ "$u" == "$candidate" ]]; then
+            continue 2
+          fi
+        done
+      fi
+
+      # compgen -W expects shell-escaped words in one space-delimited string.
+      printf -v candidate '%q' "$candidate"
+      result+=("$candidate")
+    done
   done
 
   echo "${result[*]}"
@@ -50,11 +61,11 @@ _mygit_completions() {
 
   case "$compline" in
     'status'*'--branch')
-      while read -r; do COMPREPLY+=("$REPLY"); done < <(compgen -W "$(_mygit_completions_filter "$(git branch --format='%(refname:short)' 2>/dev/null)")" -- "$cur")
+      while read -r; do COMPREPLY+=("$REPLY"); done < <(compgen -W "$(_mygit_completions_filter "__completely_dynamic__$(git branch --format='%(refname:short)' 2>/dev/null)")" -- "$cur")
       ;;
 
     'status'*'-b')
-      while read -r; do COMPREPLY+=("$REPLY"); done < <(compgen -W "$(_mygit_completions_filter "$(git branch --format='%(refname:short)' 2>/dev/null)")" -- "$cur")
+      while read -r; do COMPREPLY+=("$REPLY"); done < <(compgen -W "$(_mygit_completions_filter "__completely_dynamic__$(git branch --format='%(refname:short)' 2>/dev/null)")" -- "$cur")
       ;;
 
     'status'*)

spec/approvals/cli/generated-script-alt

@@ -9,6 +9,7 @@ _mycomps_filter() {
   local cur=${COMP_WORDS[COMP_CWORD]}
   local result=()
   local want_options=0
+  local dynamic_prefix="__completely_dynamic__"
 
   # words the user already typed (excluding the command itself)
   local used=()
@@ -20,19 +21,29 @@ _mycomps_filter() {
   # Completing a non-option: drop options and already-used words.
   [[ "${cur:0:1}" == "-" ]] && want_options=1
   for word in "${words[@]}"; do
-    if ((!want_options)); then
-      [[ "${word:0:1}" == "-" ]] && continue
-
-      for u in "${used[@]}"; do
-        if [[ "$u" == "$word" ]]; then
-          continue 2
-        fi
-      done
+    local candidates=("$word")
+    if [[ "$word" == "$dynamic_prefix"* ]]; then
+      word="${word#"$dynamic_prefix"}"
+      word="${word//$'\r'/ }"
+      word="${word//$'\n'/ }"
+      read -r -a candidates <<<"$word"
     fi
 
-    # compgen -W expects shell-escaped words in one space-delimited string.
-    printf -v word '%q' "$word"
-    result+=("$word")
+    for candidate in "${candidates[@]}"; do
+      if ((!want_options)); then
+        [[ "${candidate:0:1}" == "-" ]] && continue
+
+        for u in "${used[@]}"; do
+          if [[ "$u" == "$candidate" ]]; then
+            continue 2
+          fi
+        done
+      fi
+
+      # compgen -W expects shell-escaped words in one space-delimited string.
+      printf -v candidate '%q' "$candidate"
+      result+=("$candidate")
+    done
   done
 
   echo "${result[*]}"
@@ -50,11 +61,11 @@ _mycomps() {
 
   case "$compline" in
     'status'*'--branch')
-      while read -r; do COMPREPLY+=("$REPLY"); done < <(compgen -W "$(_mycomps_filter "$(git branch --format='%(refname:short)' 2>/dev/null)")" -- "$cur")
+      while read -r; do COMPREPLY+=("$REPLY"); done < <(compgen -W "$(_mycomps_filter "__completely_dynamic__$(git branch --format='%(refname:short)' 2>/dev/null)")" -- "$cur")
       ;;
 
     'status'*'-b')
-      while read -r; do COMPREPLY+=("$REPLY"); done < <(compgen -W "$(_mycomps_filter "$(git branch --format='%(refname:short)' 2>/dev/null)")" -- "$cur")
+      while read -r; do COMPREPLY+=("$REPLY"); done < <(compgen -W "$(_mycomps_filter "__completely_dynamic__$(git branch --format='%(refname:short)' 2>/dev/null)")" -- "$cur")
       ;;
 
     'status'*)

spec/approvals/cli/generated-wrapped-script

@@ -10,6 +10,7 @@ give_comps() {
   echo $'  local cur=${COMP_WORDS[COMP_CWORD]}'
   echo $'  local result=()'
   echo $'  local want_options=0'
+  echo $'  local dynamic_prefix="__completely_dynamic__"'
   echo $''
   echo $'  # words the user already typed (excluding the command itself)'
   echo $'  local used=()'
@@ -21,19 +22,29 @@ give_comps() {
   echo $'  # Completing a non-option: drop options and already-used words.'
   echo $'  [[ "${cur:0:1}" == "-" ]] && want_options=1'
   echo $'  for word in "${words[@]}"; do'
-  echo $'    if ((!want_options)); then'
-  echo $'      [[ "${word:0:1}" == "-" ]] && continue'
-  echo $''
-  echo $'      for u in "${used[@]}"; do'
-  echo $'        if [[ "$u" == "$word" ]]; then'
-  echo $'          continue 2'
-  echo $'        fi'
-  echo $'      done'
+  echo $'    local candidates=("$word")'
+  echo $'    if [[ "$word" == "$dynamic_prefix"* ]]; then'
+  echo $'      word="${word#"$dynamic_prefix"}"'
+  echo $'      word="${word//$\'\r\'/ }"'
+  echo $'      word="${word//$\'\n\'/ }"'
+  echo $'      read -r -a candidates <<<"$word"'
   echo $'    fi'
   echo $''
-  echo $'    # compgen -W expects shell-escaped words in one space-delimited string.'
-  echo $'    printf -v word \'%q\' "$word"'
-  echo $'    result+=("$word")'
+  echo $'    for candidate in "${candidates[@]}"; do'
+  echo $'      if ((!want_options)); then'
+  echo $'        [[ "${candidate:0:1}" == "-" ]] && continue'
+  echo $''
+  echo $'        for u in "${used[@]}"; do'
+  echo $'          if [[ "$u" == "$candidate" ]]; then'
+  echo $'            continue 2'
+  echo $'          fi'
+  echo $'        done'
+  echo $'      fi'
+  echo $''
+  echo $'      # compgen -W expects shell-escaped words in one space-delimited string.'
+  echo $'      printf -v candidate \'%q\' "$candidate"'
+  echo $'      result+=("$candidate")'
+  echo $'    done'
   echo $'  done'
   echo $''
   echo $'  echo "${result[*]}"'
@@ -51,11 +62,11 @@ give_comps() {
   echo $''
   echo $'  case "$compline" in'
   echo $'    \'status\'*\'--branch\')'
-  echo $'      while read -r; do COMPREPLY+=("$REPLY"); done < <(compgen -W "$(_mygit_completions_filter "$(git branch --format=\'%(refname:short)\' 2>/dev/null)")" -- "$cur")'
+  echo $'      while read -r; do COMPREPLY+=("$REPLY"); done < <(compgen -W "$(_mygit_completions_filter "__completely_dynamic__$(git branch --format=\'%(refname:short)\' 2>/dev/null)")" -- "$cur")'
   echo $'      ;;'
   echo $''
   echo $'    \'status\'*\'-b\')'
-  echo $'      while read -r; do COMPREPLY+=("$REPLY"); done < <(compgen -W "$(_mygit_completions_filter "$(git branch --format=\'%(refname:short)\' 2>/dev/null)")" -- "$cur")'
+  echo $'      while read -r; do COMPREPLY+=("$REPLY"); done < <(compgen -W "$(_mygit_completions_filter "__completely_dynamic__$(git branch --format=\'%(refname:short)\' 2>/dev/null)")" -- "$cur")'
   echo $'      ;;'
   echo $''
   echo $'    \'status\'*)'