completely 0.4.0 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c23c2c1184a5c69443fdd5dad73e60ba0820bf9b5f9f6eac75b111497688e16d
-  data.tar.gz: baa8d260f6837fd8594ab868fe5eadf503df0b8dedc53b29abb6d89bbb09bf4c
+  metadata.gz: 207f7cf5e1b259c6cb7e9006f59cbf22b2096456707ef8d42edddbc6b0dc4e4e
+  data.tar.gz: 51e59317f307d3da3e09f7a30092970607000be5c7a11e4276e378dd0a41bb78
 SHA512:
-  metadata.gz: ec8447973b868405cbe625496331664adfd3caf70b64bffb53cc3c6bbfd923081c9a27f561addb6e2260974664e8dfbf01ba1776cc996793933f944a2384867c
-  data.tar.gz: 718ba798f5c82c7c80a69afde32f66f610f45a874fb48ed2614f4672c359a34ba65436a30c8dc32754fa678bf324e9db67f45eac88b9277c70dd6bbe0f15b3af
+  metadata.gz: 4eaaacc3785c367510802ad2945057d1ecc50fbfd8ddbcba08234a80b73c12adbe6157c0fd9726e9eb2a9f043470bccac9fdd45bea767edce94b4b47e0dc6912
+  data.tar.gz: fc79892cbbe2647aa5647ea68d6fe29ef3b91b0686565e16ce9e6c784157539ab728dce24c4991234c1a1756facca1b0aa019c9654a1fa90b91a7d8476ea3de8

data/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
@@ -251,6 +250,17 @@ puts completions.wrapper_function "custom_function_name"
 p completions.tester.test "mygit status "
 ```
 
+## Completions in ZSH
+
+If you are using Oh-My-Zsh, bash completions should already be enabled,
+otherwise, you should enable completion by adding this to your `~/.zshrc`
+(if is it not already there):
+
+```bash
+# Load completion functions
+autoload -Uz +X compinit && compinit
+autoload -Uz +X bashcompinit && bashcompinit
+```
 
 ## Contributing / Support
 

data/lib/completely/commands/base.rb

@@ -36,8 +36,8 @@ module Completely
         @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

data/lib/completely/commands/generate.rb

@@ -5,24 +5,24 @@ module Completely
     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
 

data/lib/completely/commands/test.rb

@@ -5,36 +5,27 @@ module Completely
     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.
-
-        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"
+      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
-      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"
+        if args['--keep']
+          File.write 'completely-tester.sh', tester_script
+          puts 'saved completely-tester.sh'
+        end
       end
 
     private
@@ -43,27 +34,18 @@ module Completely
         args['COMPLINE']
       end
 
+      def completions
+        @completions ||= Completions.load config_path
+      end
+
       def tester
-        if config
-          completions = Completions.load config
-          completions.tester
-        else
-          Tester.new script_path: script_path, function_name: script_function
-        end
+        @tester ||= 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
+      def tester_script
+        @tester_script ||= tester.tester_script compline
       end
+
     end
   end
 end

data/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
@@ -22,7 +19,7 @@
 % patterns.each do |pattern|
 % next if pattern.empty?
     <%= pattern.case_string %>)
-      COMPREPLY=($(compgen <%= pattern.compgen %> -- "$cur"))
+      while read; do COMPREPLY+=( "$REPLY" ); done < <( compgen <%= pattern.compgen %> -- "$cur" )
       ;;
 
 % end

data/lib/completely/templates/tester-template.erb

@@ -1,13 +1,22 @@
 #!/usr/bin/env bash
+if [[ -n $ZSH_VERSION ]]; then
+  autoload -U +X bashcompinit && bashcompinit
+  autoload -U +X compinit && compinit
+fi
+
+# === COMPLETION SCRIPT START ===
+
 <%= script || %Q[source "#{absolute_script_path}"] %>
 
-# END OF COMPLETION SCRIPT
+# === COMPLETION SCRIPT END ===
 
-source /usr/share/bash-completion/bash_completion
 COMP_WORDS=( <%= compline %> )
 COMP_LINE="<%= compline %>"
 COMP_POINT=${#COMP_LINE}
 COMP_CWORD=<%= cword %>
 
 <%= function_name %>
-echo "${COMPREPLY[*]}"
+for suggestion in "${COMPREPLY[@]}"; do
+  echo "$suggestion"
+done
+

data/lib/completely/tester.rb

@@ -14,7 +14,7 @@ module Completely
         f << tester_script(compline)
         f.flush
         `bash #{f.path}`
-      end.split " "
+      end.split "\n"
     end
 
     def tester_script(compline)

data/lib/completely/version.rb

@@ -1,3 +1,3 @@
 module Completely
-  VERSION = "0.4.0"
+  VERSION = "0.4.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: completely
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.3
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-05-21 00:00:00.000000000 Z
+date: 2022-07-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colsole
@@ -80,7 +80,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.3.14
 signing_key: 
 specification_version: 4
 summary: Bash Completions Generator