Merge pull request #22 from DannyBen/fix/zsh

Remove support for arbitrary script test to fix zsh incompatibilities

Author: DannyBen

README.md

@@ -217,8 +217,7 @@ these (whichever exists):
 
 You can use the built in completions script tester by running `completely test`.
 
-This command lets you test any completions script, whether it was generated by
-completely or not.
+This command lets you test completions for your completions script.
 
 In addition, you can set the `COMPLETELY_DEBUG` environment variable to any value
 in order to generate scripts with some additional debugging functionality. Run

lib/completely/commands/base.rb

@@ -36,8 +36,8 @@ def config_path
         @config_path ||= args['CONFIG_PATH'] || ENV['COMPLETELY_CONFIG_PATH'] || 'completely.yaml'
       end
 
-      def script_path
-        @script_path ||= args['SCRIPT_PATH'] || ENV['COMPLETELY_SCRIPT_PATH'] || "#{config_basename}.bash"
+      def output_path
+        @output_path ||= args['OUTPUT_PATH'] || ENV['COMPLETELY_OUTPUT_PATH'] || "#{config_basename}.bash"
       end
 
       def config_basename

lib/completely/commands/generate.rb

@@ -5,24 +5,24 @@ module Commands
     class Generate < Base
       help "Generate the bash completion script to a file"
 
-      usage "completely generate [CONFIG_PATH SCRIPT_PATH --function NAME --wrap NAME]"
+      usage "completely generate [CONFIG_PATH OUTPUT_PATH --function NAME --wrap NAME]"
       usage "completely generate (-h|--help)"
 
       option_function
       option "-w --wrap NAME", "Wrap the completion script inside a function that echos the script. This is useful if you wish to embed it directly in your script"
 
       param_config_path
-      param "SCRIPT_PATH", "Path to the output bash script. When not provided, the name of the input file will be used with a .bash extension\nCan also be set by an environment variable"
+      param "OUTPUT_PATH", "Path to the output bash script. When not provided, the name of the input file will be used with a .bash extension\nCan also be set by an environment variable"
 
       environment_config_path
-      environment "COMPLETELY_SCRIPT_PATH", "Path to the output bash script"
+      environment "COMPLETELY_OUTPUT_PATH", "Path to the output bash script"
       environment_debug
 
       def run
         wrap = args['--wrap']
         output = wrap ? wrapper_function(wrap) : script
-        File.write script_path, output
-        say "Saved !txtpur!#{script_path}"
+        File.write output_path, output
+        say "Saved !txtpur!#{output_path}"
         syntax_warning unless completions.valid?
       end
 

lib/completely/commands/test.rb

@@ -9,8 +9,6 @@ class Test < Base
         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.
-
-        In order to test on an arbitrary completions script, set the COMPLETELY_SCRIPT_PATH and optionally the COMPLETELY_SCRIPT_FUNCTION environment variables.
       EOF
 
       usage "completely test COMPLINE"
@@ -19,21 +17,12 @@ class Test < Base
       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
-      environment "COMPLETELY_SCRIPT_PATH", "Path to a completions script. When set, this script will be tested instead of the completely configuration file"
-      environment "COMPLETELY_SCRIPT_FUNCTION", "The main completion function to call when using a custom script. If not set, the basename of the script path will be used, prefixed by an underscore"
       environment_debug
 
       example %q[completely test "mygit pu"]
       example %q[completely test "mygit pull "]
-      example <<~EOF
-        COMPLETELY_SCRIPT_PATH=/usr/share/bash-completion/completions/chown \\
-          completely test "chown --"
-        EOF
-
-      attr_reader :config, :script_path, :script_function
 
       def run
-        set_vars
         puts tester.test(compline).join "\n"
       end
 
@@ -44,26 +33,10 @@ def compline
       end
 
       def tester
-        if config
-          completions = Completions.load config
-          completions.tester
-        else
-          Tester.new script_path: script_path, function_name: script_function
-        end
+        completions = Completions.load config_path
+        completions.tester
       end
 
-      def set_vars
-        if ENV['COMPLETELY_CONFIG_PATH']
-          @config = ENV['COMPLETELY_CONFIG_PATH']
-        elsif ENV['COMPLETELY_SCRIPT_PATH']
-          @script_path = ENV['COMPLETELY_SCRIPT_PATH']
-          @script_function = ENV['COMPLETELY_SCRIPT_FUNCTION'] || "_#{File.basename(script_path)}"
-        elsif File.exist? 'completely.yaml'
-          @config = 'completely.yaml'
-        else
-          raise "Please set the proper environment variables or run in a folder with completely.yaml"
-        end
-      end
     end
   end
 end

lib/completely/templates/template.erb

@@ -5,11 +5,8 @@
 # Modifying it manually is not recommended
 
 <%= function_name %>() {
-  local cur compline
-  _init_completion -s || return
-
-  cur=${COMP_WORDS[COMP_CWORD]}
-  compline="${COMP_WORDS[@]:1:$COMP_CWORD-1}"
+  local cur=${COMP_WORDS[COMP_CWORD]}
+  local compline="${COMP_WORDS[@]:1:$COMP_CWORD-1}"
 
 % if ENV['COMPLETELY_DEBUG']
   if [[ -n "$COMPLETELY_DEBUG" ]]; then

lib/completely/templates/tester-template.erb

@@ -3,7 +3,6 @@
 
 # END OF COMPLETION SCRIPT
 
-source /usr/share/bash-completion/bash_completion
 COMP_WORDS=( <%= compline %> )
 COMP_LINE="<%= compline %>"
 COMP_POINT=${#COMP_LINE}

spec/approvals/cli/generate/help

@@ -1,7 +1,7 @@
 Generate the bash completion script to a file
 
 Usage:
-  completely generate [CONFIG_PATH SCRIPT_PATH --function NAME --wrap NAME]
+  completely generate [CONFIG_PATH OUTPUT_PATH --function NAME --wrap NAME]
   completely generate (-h|--help)
 
 Options:
@@ -20,7 +20,7 @@ Parameters:
     Path to the YAML configuration file [default: completely.yaml]
     Can also be set by an environment variable
 
-  SCRIPT_PATH
+  OUTPUT_PATH
     Path to the output bash script. When not provided, the name of the input
     file will be used with a .bash extension
     Can also be set by an environment variable
@@ -29,7 +29,7 @@ Environment Variables:
   COMPLETELY_CONFIG_PATH
     Path to a completely configuration file [default: completely.yaml]
 
-  COMPLETELY_SCRIPT_PATH
+  COMPLETELY_OUTPUT_PATH
     Path to the output bash script
 
   COMPLETELY_DEBUG

spec/approvals/cli/generated-script

@@ -5,11 +5,8 @@
 # Modifying it manually is not recommended
 
 _mygit_completions() {
-  local cur compline
-  _init_completion -s || return
-
-  cur=${COMP_WORDS[COMP_CWORD]}
-  compline="${COMP_WORDS[@]:1:$COMP_CWORD-1}"
+  local cur=${COMP_WORDS[COMP_CWORD]}
+  local compline="${COMP_WORDS[@]:1:$COMP_CWORD-1}"
 
   case "$compline" in
     'status'*)

spec/approvals/cli/generated-script-alt

@@ -5,11 +5,8 @@
 # Modifying it manually is not recommended
 
 _mycomps() {
-  local cur compline
-  _init_completion -s || return
-
-  cur=${COMP_WORDS[COMP_CWORD]}
-  compline="${COMP_WORDS[@]:1:$COMP_CWORD-1}"
+  local cur=${COMP_WORDS[COMP_CWORD]}
+  local compline="${COMP_WORDS[@]:1:$COMP_CWORD-1}"
 
   case "$compline" in
     'status'*)

spec/approvals/cli/generated-wrapped-script

@@ -6,11 +6,8 @@ give_comps() {
   echo $'# Modifying it manually is not recommended'
   echo $''
   echo $'_mygit_completions() {'
-  echo $'  local cur compline'
-  echo $'  _init_completion -s || return'
-  echo $''
-  echo $'  cur=${COMP_WORDS[COMP_CWORD]}'
-  echo $'  compline="${COMP_WORDS[@]:1:$COMP_CWORD-1}"'
+  echo $'  local cur=${COMP_WORDS[COMP_CWORD]}'
+  echo $'  local compline="${COMP_WORDS[@]:1:$COMP_CWORD-1}"'
   echo $''
   echo $'  case "$compline" in'
   echo $'    \'status\'*)'