Merge pull request #78 from DannyBen/add/complete-options

Add support for modifying the `complete` command options

Author: DannyBen

.rubocop.yml

@@ -1,4 +1,4 @@
-require:
+plugins:
   - rubocop-performance
   - rubocop-rspec
 

Runfile

@@ -6,6 +6,7 @@ summary "Runfile tasks for building the Completely gem"
 
 import_gem 'runfile-tasks/gem'
 import_gem 'runfile-tasks/docker', image: 'dannyben/completely', version: Completely::VERSION
+import 'debug'
 
 help   'Test the completely JSON schema'
 action :schema do

lib/completely/completions.rb

@@ -81,5 +81,12 @@ def pattern_function_name
     def pattern_prefixes
       patterns.map(&:prefix)
     end
+
+    def complete_options_line
+      options = config.options[:complete_options]
+      return nil if options.nil? || options.strip.empty?
+
+      "#{options} "
+    end
   end
 end

lib/completely/config.rb

@@ -1,6 +1,6 @@
 module Completely
   class Config
-    attr_reader :config
+    attr_reader :config, :options
 
     class << self
       def load(config_path)
@@ -17,6 +17,7 @@ def load(config_path)
     end
 
     def initialize(config)
+      @options = config.delete('completely_options')&.transform_keys(&:to_sym) || {}
       @config = config
     end
 

lib/completely/templates/template.erb

@@ -44,6 +44,6 @@
 % end
   esac
 } &&
-  complete -F <%= function_name %> <%= command %>
+  complete <%= complete_options_line %>-F <%= function_name %> <%= command %>
 
 # ex: filetype=sh

spec/approvals/completions/script-complete-options

@@ -0,0 +1,39 @@
+# mygit completion                                         -*- shell-script -*-
+
+# This bash completions script was generated by
+# completely (https://github.com/dannyben/completely)
+# Modifying it manually is not recommended
+
+_mygit_completions_filter() {
+  local words="$1"
+  local cur=${COMP_WORDS[COMP_CWORD]}
+  local result=()
+
+  if [[ "${cur:0:1}" == "-" ]]; then
+    echo "$words"
+
+  else
+    for word in $words; do
+      [[ "${word:0:1}" != "-" ]] && result+=("$word")
+    done
+
+    echo "${result[*]}"
+
+  fi
+}
+
+_mygit_completions() {
+  local cur=${COMP_WORDS[COMP_CWORD]}
+  local compwords=("${COMP_WORDS[@]:1:$COMP_CWORD-1}")
+  local compline="${compwords[*]}"
+
+  case "$compline" in
+    *)
+      while read -r; do COMPREPLY+=("$REPLY"); done < <(compgen -W "$(_mygit_completions_filter "status commit")" -- "$cur")
+      ;;
+
+  esac
+} &&
+  complete -o nosort -F _mygit_completions mygit
+
+# ex: filetype=sh

spec/completely/completions_spec.rb

@@ -49,6 +49,14 @@
           .except(/case.*/m)
       end
     end
+
+    context 'with a configuration file that includes complete_options' do
+      let(:file) { 'complete_options' }
+
+      it 'adds the complete_options to the complete command' do
+        expect(subject.script).to match_approval 'completions/script-complete-options'
+      end
+    end
   end
 
   describe '#wrapper_function' do

spec/completely/config_spec.rb

@@ -9,4 +9,20 @@
       expect(subject.flat_config.to_yaml).to match_approval('config/flat_config')
     end
   end
+
+  context 'when complete_options is defined' do
+    let(:file) { 'complete_options' }
+
+    describe 'config' do
+      it 'ignores the completely_config YAML key' do
+        expect(subject.config.keys).to eq ['mygit']
+      end
+    end
+
+    describe 'options' do
+      it 'returns the completely_options hash from the YAML file' do
+        expect(subject.options[:complete_options]).to eq '-o nosort'
+      end
+    end
+  end
 end

spec/fixtures/complete_options.yaml

@@ -0,0 +1,6 @@
+completely_options:
+  complete_options: -o nosort
+
+mygit:
+- status
+- commit