completely 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2012c5d2e6bdbdc4105a86bb535bcaacec54623b75ed4a68dfed59d7283b806f
-  data.tar.gz: 35b022231df795d3820c3c22df622351a83c8c5720becde6ce4cde05cccb5643
+  metadata.gz: 6b9ace97a98b6c4feff7f5b755481317583de3330f2fc7be077d161ace8fa5e2
+  data.tar.gz: fabc15cb7f3665327ece094530751506febc080c5158282bfee3ab874da8988a
 SHA512:
-  metadata.gz: cabb44f5d2e22d3fcaf2dba81c8bcca443f3ae06ce2201023cd7babd2f93792c754e97d1816a649b23139cb0b89d1ed4a23cbe875774cfa6f68bd0f055dfeb68
-  data.tar.gz: 9c74a483866d9b1b487f721d8ea19ea8523906986992d7df64b2b96945898ba667641c9d849f23ccdb9453635ecf088f1651b7d8346566eb7fd461fa4e76e170
+  metadata.gz: 69f420158e1cc0cfae093d9fdd05295467d883c02d0648a1a3caab29787da3f9ad15d599328528910a7282a8518df80b64f1821e128365fdb6c3547a526b55a0
+  data.tar.gz: 5e978c0f507474f8a8ae3e5c57111de33098b266ea661f659f1b4b4f7c4838b0e4da448bd55987662ae0e645b5ce542c675198624f638cfeb8999161b2625d42

data/README.md

@@ -32,7 +32,13 @@ or with homebrew:
 ```bash
 $ brew install brew-gem
 $ brew gem install completely
-````
+```
+
+or with Docker:
+
+```bash
+$ alias completely='docker run --rm -it --user $(id -u):$(id -g) --volume "$PWD:/app" dannyben/completely'
+```
 
 ## Using the `completely` command line
 
@@ -91,6 +97,9 @@ Each pattern in this configuration file will be checked against the user's
 input, and if the input **starts with** a matching pattern, the list that 
 follows it will be suggested as completions.
 
+Note that the suggested completions will not show flags (string that start with 
+a hyphen `-`) unless the input ends with a hyphen.
+
 To generate the bash script, simply run:
 
 ```bash
@@ -250,6 +259,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/test.rb

@@ -5,15 +5,13 @@ 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.
-      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 @@ module Completely
 
       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 @@ module Completely
         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

data/lib/completely/completions.rb

@@ -54,7 +54,7 @@ module Completely
 
     def patterns!
       config.map do |text, completions|
-        Pattern.new text, completions
+        Pattern.new text, completions, pattern_function_name
       end.sort_by { |pattern| -pattern.length }
     end
 
@@ -74,6 +74,10 @@ module Completely
       @function_name ||= "_#{command}_completions"
     end
 
+    def pattern_function_name
+      @pattern_function_name ||= "#{function_name}_filter"
+    end
+
     def pattern_prefixes
       patterns.map &:prefix
     end

data/lib/completely/pattern.rb

@@ -1,10 +1,11 @@
 module Completely
   class Pattern
-    attr_reader :text, :completions
+    attr_reader :text, :completions, :function_name
 
-    def initialize(text, completions)
+    def initialize(text, completions, function_name)
       @text = text
       @completions = completions || []
+      @function_name = function_name
     end
 
     def length
@@ -53,7 +54,7 @@ module Completely
     def compgen!
       result = []
       result << %Q[#{actions.join ' '}] if actions.any?
-      result << %Q[-W "#{words.join ' '}"] if words.any?
+      result << %Q[-W "$(#{function_name} "#{words.join ' '}")"] if words.any?
       result.any? ? result.join(' ') : nil
     end
   end

data/lib/completely/templates/template.erb

@@ -4,9 +4,28 @@
 # completely (https://github.com/dannyben/completely)
 # Modifying it manually is not recommended
 
+<%= function_name %>_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
+}
+
 <%= function_name %>() {
   local cur=${COMP_WORDS[COMP_CWORD]}
-  local compline="${COMP_WORDS[@]:1:$COMP_CWORD-1}"
+  local compwords=("${COMP_WORDS[@]:1:$COMP_CWORD-1}")
+  local compline="${compwords[*]}"
 
 % if ENV['COMPLETELY_DEBUG']
   if [[ -n "$COMPLETELY_DEBUG" ]]; then
@@ -19,7 +38,7 @@
 % patterns.each do |pattern|
 % next if pattern.empty?
     <%= pattern.case_string %>)
-      COMPREPLY=($(compgen <%= pattern.compgen %> -- "$cur"))
+      while read -r; do COMPREPLY+=( "$REPLY" ); done < <( compgen <%= pattern.compgen %> -- "$cur" )
       ;;
 
 % end

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

@@ -1,7 +1,14 @@
 #!/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 ===
 
 COMP_WORDS=( <%= compline %> )
 COMP_LINE="<%= compline %>"
@@ -9,4 +16,7 @@ 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.1"
+  VERSION = "0.5.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: completely
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-05-21 00:00:00.000000000 Z
+date: 2022-09-04 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