Merge pull request #25 from DannyBen/add/tester-keep

Allow keeping the test script with `--keep`

Author: DannyBen

lib/completely/commands/test.rb

@@ -5,15 +5,13 @@ module Commands
     class Test < Base
       summary "Test completions"
 
-      help <<~EOF
-        This command can be used to test that any completion script (either generated by compeltely or not) responds with the right completions.
+      help "This command can be used to test that your completions script responds with the right completions. It works by reading your completely.yaml file, generating a completions script, and generating a temporary testing script."
 
-        In order to test on a completely configuration file other than 'completely.yaml', set the COMPLETELY_CONFIG_PATH environemnt variable.
-      EOF
-
-      usage "completely test COMPLINE"
+      usage "completely test [--keep] COMPLINE"
       usage "completely test (-h|--help)"
 
+      option "-k --keep", "Keep the temporary testing script in the current directory"
+
       param "COMPLINE", "The command to test completions for. This will be handled as if a TAB was pressed immediately at the end of it, so the last word is considered the active cursor. If you wish to complete for the next word instead, end your command with a space."
 
       environment_config_path
@@ -24,6 +22,10 @@ class Test < Base
 
       def run
         puts tester.test(compline).join "\n"
+        if args['--keep']
+          File.write 'completely-tester.sh', tester_script
+          puts 'saved completely-tester.sh'
+        end
       end
 
     private
@@ -32,9 +34,16 @@ def compline
         args['COMPLINE']
       end
 
+      def completions
+        @completions ||= Completions.load config_path
+      end
+
       def tester
-        completions = Completions.load config_path
-        completions.tester
+        @tester ||= completions.tester
+      end
+
+      def tester_script
+        @tester_script ||= tester.tester_script compline
       end
 
     end

spec/approvals/cli/test/completely-tester.sh

@@ -0,0 +1,51 @@
+#!/usr/bin/env bash
+if [[ -n $ZSH_VERSION ]]; then
+  autoload -U +X bashcompinit && bashcompinit
+  autoload -U +X compinit && compinit
+fi
+
+# === COMPLETION SCRIPT START ===
+
+# 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() {
+  local cur=${COMP_WORDS[COMP_CWORD]}
+  local compline="${COMP_WORDS[@]:1:$COMP_CWORD-1}"
+
+  case "$compline" in
+    'status'*)
+      COMPREPLY=($(compgen -W "--help --verbose --branch $(git branch 2> /dev/null)" -- "$cur"))
+      ;;
+
+    'commit'*)
+      COMPREPLY=($(compgen -A file -W "--help --message --all -a --quiet -q" -- "$cur"))
+      ;;
+
+    'init'*)
+      COMPREPLY=($(compgen -A directory -W "--bare" -- "$cur"))
+      ;;
+
+    *)
+      COMPREPLY=($(compgen -W "--help --version status init commit" -- "$cur"))
+      ;;
+
+  esac
+} &&
+complete -F _mygit_completions mygit
+
+# ex: filetype=sh
+
+
+# === COMPLETION SCRIPT END ===
+
+COMP_WORDS=( mygit status -- )
+COMP_LINE="mygit status --"
+COMP_POINT=${#COMP_LINE}
+COMP_CWORD=2
+
+_mygit_completions
+echo "${COMPREPLY[*]}"

spec/approvals/cli/test/comps-default-keep

@@ -0,0 +1,4 @@
+--help
+--verbose
+--branch
+saved completely-tester.sh

spec/approvals/cli/test/help

@@ -1,16 +1,17 @@
 Test completions
 
-This command can be used to test that any completion script (either generated by
-compeltely or not) responds with the right completions.
-
-In order to test on a completely configuration file other than
-'completely.yaml', set the COMPLETELY_CONFIG_PATH environemnt variable.
+This command can be used to test that your completions script responds with the
+right completions. It works by reading your completely.yaml file, generating a
+completions script, and generating a temporary testing script.
 
 Usage:
-  completely test COMPLINE
+  completely test [--keep] COMPLINE
   completely test (-h|--help)
 
 Options:
+  -k --keep
+    Keep the temporary testing script in the current directory
+
   -h --help
     Show this help
 

spec/approvals/cli/test/usage

@@ -1,3 +1,3 @@
 Usage:
-  completely test COMPLINE
+  completely test [--keep] COMPLINE
   completely test (-h|--help)

spec/completely/commands/test_spec.rb

@@ -30,6 +30,20 @@
     end
   end
 
+  context "with --keep COMPLINE" do
+    before { system "rm -f #{filename}" }
+    after { system "rm -f #{filename}" }
+
+    let(:filename) { 'completely-tester.sh' }
+
+    it "copies the test script to the current directory" do
+      expect { subject.run ["test", "--keep", "mygit status --"] }
+        .to output_approval('cli/test/comps-default-keep')
+
+      expect(File.read filename).to match_approval('cli/test/completely-tester.sh')
+    end
+  end
+
   context "when COMPLETELY_CONFIG_PATH is set" do
     before do
       reset_tmp_dir
@@ -43,7 +57,7 @@
     end
   end
 
-  context "when there is no compeltely.yaml or any environment instructions" do
+  context "when there is no compeltely.yaml or COMPLETELY_CONFIG_PATH" do
     before { system "rm -f completely.yaml" }
 
     it "fails gracefully" do