Merge pull request #389 from DannyBen/fix/private-commands-in-completion

Fix completions library to not show private commands and flags

Author: DannyBen

.rubocop.yml

@@ -19,6 +19,9 @@ Metrics/PerceivedComplexity:  { Exclude: [lib/bashly/config_validator.rb] }
 Metrics/MethodLength:         { Exclude: [lib/bashly/config_validator.rb] }
 Style/GuardClause:            { Exclude: [lib/bashly/config_validator.rb] }
 
+# FIXME: The `Command` class is too long
+Metrics/ClassLength: { Exclude: [lib/bashly/script/command.rb] }
+
 # Allow irregular filenames in some cases
 RSpec/FilePath:
   Exclude:

lib/bashly/concerns/completions.rb

@@ -29,7 +29,7 @@ def completion_data(with_version: true)
           end
         end
 
-        commands.each do |command|
+        public_commands.each do |command|
           result.merge! command.completion_data(with_version: false)
         end
 
@@ -62,7 +62,7 @@ def completion_generator
       end
 
       def completion_flag_names
-        flags.map(&:name) + flags.map(&:short)
+        public_flags.map(&:name) + public_flags.map(&:short)
       end
 
       def completion_allowed_args
@@ -73,7 +73,7 @@ def completion_words(with_version: false)
         trivial_flags = %w[--help -h]
         trivial_flags += %w[--version -v] if with_version
         all = (
-          command_aliases + trivial_flags +
+          public_command_aliases + trivial_flags +
           completion_flag_names + completion_allowed_args
         )
 

lib/bashly/script/command.rb

@@ -223,6 +223,11 @@ def public_commands
         commands.reject(&:private)
       end
 
+      # Returns a full list of the public Command names and aliases combined
+      def public_command_aliases
+        public_commands.map(&:aliases).flatten
+      end
+
       # Returns only environment variables that are not private
       def public_environment_variables
         environment_variables.reject(&:private)

spec/approvals/fixtures/completions-private

@@ -0,0 +1,24 @@
++ bundle exec bashly add completions_yaml --force
+created ./completions.yml
+
+This file can be converted to a completions script using the completely gem.
+
++ cat completions.yml
+---
+private:
+- "--help"
+- "--version"
+- "-h"
+- "-v"
+- c
+- connect
+private connect:
+- "--force"
+- "--help"
+- "-f"
+- "-h"
+private c:
+- "--force"
+- "--help"
+- "-f"
+- "-h"

spec/bashly/script/command_spec.rb

@@ -339,6 +339,23 @@
     end
   end
 
+  describe '#public_commands' do
+    let(:fixture) { :private_commands }
+
+    it 'returns an array of Command objects excluding private commands' do
+      expect(subject.public_commands.count).to eq 1
+      expect(subject.public_commands.first.name).to eq 'connect'
+    end
+  end
+
+  describe '#public_commands_aliases' do
+    let(:fixture) { :private_commands }
+
+    it 'returns an array of command aliases of public subcommands' do
+      expect(subject.public_command_aliases).to eq %w[connect c]
+    end
+  end
+
   describe '#user_file_path' do
     it 'returns the path to the user file' do
       expect(subject.user_file_path 'test.sh').to eq 'spec/tmp/src/test.sh'

spec/fixtures/script/commands.yml

@@ -378,6 +378,19 @@
             short: -c
             allowed: [green, red]
 
+:private_commands:
+  name: private
+  help: Test private commands
+  commands:
+  - name: connect
+    alias: c
+  - name: connect-ftp
+    alias: cf
+    private: true
+  - name: connect-ssh
+    alias: cf
+    private: true
+
 :repeatable_arg:
   name: get
   args:

spec/fixtures/workspaces/completions-private/.gitignore

@@ -0,0 +1 @@
+completions.yml

spec/fixtures/workspaces/completions-private/README.md

@@ -0,0 +1,4 @@
+This fixture tests that private commands and flags are not added to the
+generated completions scripts.
+
+Reference issue: https://github.com/DannyBen/bashly/issues/388

spec/fixtures/workspaces/completions-private/src/bashly.yml

@@ -0,0 +1,24 @@
+name: private
+help: Test private commands
+
+commands:
+- name: connect
+  alias: c
+  help: Connect to the metaverse
+  flags:
+    - long: --force
+      short: -f
+    # Private flag below - should not be present in completions
+    - long: --hidden-flag
+      short: -d
+      private: true
+
+# Private commands below - should not be present in completions
+- name: connect-ftp
+  help: Connect via FTP
+  alias: cf
+  private: true
+- name: connect-ssh
+  help: Connect via SSH
+  alias: cs
+  private: true

spec/fixtures/workspaces/completions-private/test.sh

@@ -0,0 +1,5 @@
+#!/usr/bin/env bash
+
+set -x
+bundle exec bashly add completions_yaml --force
+cat completions.yml