Merge pull request #297 from DannyBen/fix/completions

Fix bash completions for commands with global flags

Author: DannyBen

.github/ISSUE_TEMPLATE/bug_report.md

@@ -11,6 +11,6 @@ assignees: ''
 
 ### Reproduction steps
 
-### Expected behavior
-
 ### Actual behavior
+
+### Expected behavior

lib/bashly/concerns/completions.rb

@@ -6,24 +6,23 @@ module Bashly
   module Completions
     module Flag
       def completion_data(command_full_name)
-        result = {}
         comps = allowed || completions
+        return {} unless comps
 
-        if comps
-          aliases.each do |name|
-            result["#{command_full_name}*#{name}"] = comps
-          end
+        aliases.to_h do |name|
+          prefix = command_full_name
+          prefix = "#{prefix}*" unless prefix.end_with? '*'
+          ["#{prefix}#{name}",  comps]
         end
-
-        result
       end
     end
 
     module Command
       def completion_data(with_version: true)
         result = {}
 
-        all_full_names.each do |name|
+        completion_full_names.each do |name|
+          name = "#{name}*" if name.include? '*'
           result[name] = completion_words with_version: with_version
           flags.each do |flag|
             result.merge! flag.completion_data(name)
@@ -45,6 +44,17 @@ def completion_function(name = nil)
         completion_generator.wrapper_function name
       end
 
+    protected
+
+      def completion_full_names
+        if parent_command
+          glue = parent_command.global_flags? ? '*' : ' '
+          parent_command.completion_full_names.product(aliases).map { |a| a.join glue }
+        else
+          aliases
+        end
+      end
+
     private
 
       def completion_generator

lib/bashly/script/command.rb

@@ -34,16 +34,6 @@ def aliases
         [name] + alt
       end
 
-      # Returns an array of all full names (including aliases and aliases of
-      # parents)
-      def all_full_names
-        if parent_command
-          parent_command.all_full_names.product(aliases).map { |a| a.join ' ' }
-        else
-          aliases
-        end
-      end
-
       # Returns an array of alternative aliases if any
       def alt
         # DEPRECATION 0.8.0

spec/approvals/completions/completion_global_flags

@@ -0,0 +1,20 @@
+---
+cli:
+- "--debug"
+- "--help"
+- "--version"
+- "-h"
+- "-v"
+- images
+cli*images*:
+- "--help"
+- "--verbose"
+- "-h"
+- ls
+cli*images*ls*:
+- "--env"
+- "--help"
+- "-h"
+cli*images*ls*--env:
+- prod
+- dev

spec/approvals/completions/completion_global_flags_nested

@@ -0,0 +1,15 @@
+---
+cli:
+- "--help"
+- "--version"
+- "-h"
+- "-v"
+- images
+cli images:
+- "--help"
+- "--verbose"
+- "-h"
+- ls
+cli images*ls*:
+- "--help"
+- "-h"

spec/approvals/completions/completion_global_flags_root

@@ -0,0 +1,19 @@
+---
+cli:
+- "--debug"
+- "--help"
+- "--version"
+- "-h"
+- "-v"
+- images
+cli*images*:
+- "--help"
+- "-h"
+- ls
+cli*images ls*:
+- "--env"
+- "--help"
+- "-h"
+cli*images ls*--env:
+- prod
+- dev

spec/approvals/script/command/nested_aliases

@@ -59,4 +59,37 @@
       end
     end
   end
+
+  context 'with a command that has global flags on the root command' do
+    let(:fixture) { :completions_global_flags_root }
+
+    describe '#completion_data' do
+      it 'returns a data structure that includes all command full names' do
+        expect(subject.completion_data.to_yaml)
+          .to match_approval('completions/completion_global_flags_root')
+      end
+    end
+  end
+
+  context 'with a command that has global flags on a nested command' do
+    let(:fixture) { :completions_global_flags_nested }
+
+    describe '#completion_data' do
+      it 'returns a data structure that includes all command full names' do
+        expect(subject.completion_data.to_yaml)
+          .to match_approval('completions/completion_global_flags_nested')
+      end
+    end
+  end
+
+  context 'with a command that has global flags on the root and a nested command' do
+    let(:fixture) { :completions_global_flags }
+
+    describe '#completion_data' do
+      it 'returns a data structure that includes all command full names' do
+        expect(subject.completion_data.to_yaml)
+          .to match_approval('completions/completion_global_flags')
+      end
+    end
+  end
 end

spec/bashly/concerns/completions_command_spec.rb

@@ -50,15 +50,6 @@
     end
   end
 
-  describe '#all_full_names' do
-    let(:fixture) { :nested_aliases }
-
-    it 'returns an array of all full names including aliases' do
-      expect(subject.deep_commands.last.all_full_names.to_yaml)
-        .to match_approval('script/command/nested_aliases')
-    end
-  end
-
   describe '#args' do
     it 'returns an array of Argument objects' do
       expect(subject.args).to be_an Array

spec/bashly/script/command_spec.rb

@@ -98,6 +98,43 @@
     arg: name
     allowed: [get, post]
 
+:completions_global_flags:
+  name: cli
+  flags:
+  - long: --debug
+  commands:
+  - name: images
+    flags:
+    - long: --verbose
+    commands:
+    - name: ls
+      flags:
+      - long: --env
+        arg: env
+        allowed: [prod, dev]
+
+:completions_global_flags_nested:
+  name: cli
+  commands:
+  - name: images
+    flags:
+    - long: --verbose
+    commands:
+    - name: ls
+
+:completions_global_flags_root:
+  name: cli
+  flags:
+  - long: --debug
+  commands:
+  - name: images
+    commands:
+    - name: ls
+      flags:
+      - long: --env
+        arg: env
+        allowed: [prod, dev]
+
 :custom_filename:
   name: run
   filename: ops/run_command.sh