completely 0.4.3 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 207f7cf5e1b259c6cb7e9006f59cbf22b2096456707ef8d42edddbc6b0dc4e4e
-  data.tar.gz: 51e59317f307d3da3e09f7a30092970607000be5c7a11e4276e378dd0a41bb78
+  metadata.gz: 133a4cb7fec5b868e4c98e594bc6ffc228c25eee4b85a58801f03fc78d9b1cbf
+  data.tar.gz: 5073efb37aba0c9601875d05a9b9acce469d71d182f91c8729f18052bdcfc915
 SHA512:
-  metadata.gz: 4eaaacc3785c367510802ad2945057d1ecc50fbfd8ddbcba08234a80b73c12adbe6157c0fd9726e9eb2a9f043470bccac9fdd45bea767edce94b4b47e0dc6912
-  data.tar.gz: fc79892cbbe2647aa5647ea68d6fe29ef3b91b0686565e16ce9e6c784157539ab728dce24c4991234c1a1756facca1b0aa019c9654a1fa90b91a7d8476ea3de8
+  metadata.gz: 63029b5f2cfd9362a7daa0e0d940e5f296d42962c2d0e9b2bda2297fe0c95b5abd3e6c9029f6c3781932b7fa2d2e122b0672ca6708774c375bcb277db48e5cf3
+  data.tar.gz: 9ec01adf53afe6d2aaa14ca6a369754adb76ef0043a51663183807eee3d0266c74c18bfd2518ff2d5bf1a5ba04216e0ac9fe0af3a3435b3ee2816115570cc568

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

data/bin/completely

@@ -8,9 +8,8 @@ runner = Completely::CLI.runner
 
 begin
   exit runner.run ARGV
-
 rescue => e
   puts e.backtrace.reverse if ENV['DEBUG']
   say! "!undred!#{e.class}!txtrst!\n#{e.message}"
   exit 1
-end
+end

data/lib/completely/cli.rb

@@ -9,8 +9,8 @@ module Completely
   class CLI
     def self.runner
       runner = MisterBin::Runner.new version: Completely::VERSION,
-        header: "Completely - Bash Completions Generator",
-        footer: "Run !txtpur!completely COMMAND --help!txtrst! for more information"
+        header: 'Completely - Bash Completions Generator',
+        footer: 'Run !txtpur!completely COMMAND --help!txtrst! for more information'
 
       runner.route 'init',      to: Commands::Init
       runner.route 'preview',   to: Commands::Preview

data/lib/completely/commands/base.rb

@@ -3,22 +3,21 @@ require 'mister_bin'
 module Completely
   module Commands
     class Base < MisterBin::Command
-
       class << self
         def param_config_path
-          param "CONFIG_PATH", "Path to the YAML configuration file [default: completely.yaml]\nCan also be set by an environment variable"
+          param 'CONFIG_PATH', "Path to the YAML configuration file [default: completely.yaml]\nCan also be set by an environment variable"
         end
 
         def option_function
-          option "-f --function NAME", "Modify the name of the function in the generated script"
+          option '-f --function NAME', 'Modify the name of the function in the generated script'
         end
 
         def environment_config_path
-          environment "COMPLETELY_CONFIG_PATH", "Path to a completely configuration file [default: completely.yaml]"
+          environment 'COMPLETELY_CONFIG_PATH', 'Path to a completely configuration file [default: completely.yaml]'
         end
 
         def environment_debug
-          environment "COMPLETELY_DEBUG", "It not empty, the generated script will include an additional debugging snippet that outputs the compline and current word to a text file when a completion is requested"
+          environment 'COMPLETELY_DEBUG', 'It not empty, the generated script will include an additional debugging snippet that outputs the compline and current word to a text file when a completion is requested'
         end
       end
 
@@ -46,7 +45,7 @@ module Completely
 
       def syntax_warning
         say! "\n!txtred!WARNING:\nYour configuration is invalid."
-        say! "!txtred!All patterns must start with the same word."
+        say! '!txtred!All patterns must start with the same word.'
       end
     end
   end

data/lib/completely/commands/generate.rb

@@ -3,19 +3,19 @@ require 'completely/commands/base'
 module Completely
   module Commands
     class Generate < Base
-      help "Generate the bash completion script to a file"
+      help 'Generate the bash completion script to a file'
 
-      usage "completely generate [CONFIG_PATH OUTPUT_PATH --function NAME --wrap NAME]"
-      usage "completely generate (-h|--help)"
+      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"
+      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 "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"
+      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_OUTPUT_PATH", "Path to the output bash script"
+      environment 'COMPLETELY_OUTPUT_PATH', 'Path to the output bash script'
       environment_debug
 
       def run
@@ -31,7 +31,6 @@ module Completely
       def wrapper_function(wrapper_name)
         completions.wrapper_function wrapper_name
       end
-
     end
   end
 end

data/lib/completely/commands/init.rb

@@ -3,21 +3,19 @@ require 'completely/commands/base'
 module Completely
   module Commands
     class Init < Base
-      help "Create a new sample YAML configuration file"
+      help 'Create a new sample YAML configuration file'
 
-      usage "completely init [CONFIG_PATH]"
-      usage "completely init (-h|--help)"
+      usage 'completely init [CONFIG_PATH]'
+      usage 'completely init (-h|--help)'
 
       param_config_path
       environment_config_path
 
       def run
-        if File.exist? config_path
-          raise "File already exists: #{config_path}"
-        else
-          File.write config_path, sample
-          say "Saved !txtpur!#{config_path}"
-        end
+        raise "File already exists: #{config_path}" if File.exist? config_path
+
+        File.write config_path, sample
+        say "Saved !txtpur!#{config_path}"
       end
 
     private
@@ -27,9 +25,8 @@ module Completely
       end
 
       def sample_path
-        @sample_path ||= File.expand_path "../templates/sample.yaml", __dir__
+        @sample_path ||= File.expand_path '../templates/sample.yaml', __dir__
       end
-
     end
   end
 end

data/lib/completely/commands/preview.rb

@@ -3,10 +3,10 @@ require 'completely/commands/base'
 module Completely
   module Commands
     class Preview < Base
-      help "Generate the bash completion script to STDOUT"
+      help 'Generate the bash completion script to STDOUT'
 
-      usage "completely preview [CONFIG_PATH --function NAME]"
-      usage "completely preview (-h|--help)"
+      usage 'completely preview [CONFIG_PATH --function NAME]'
+      usage 'completely preview (-h|--help)'
 
       option_function
       param_config_path

data/lib/completely/commands/test.rb

@@ -3,29 +3,32 @@ require 'completely/commands/base'
 module Completely
   module Commands
     class Test < Base
-      summary "Test completions"
+      summary 'Test 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."
+      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.'
 
-      usage "completely test [--keep] COMPLINE"
-      usage "completely test (-h|--help)"
+      usage 'completely test [--keep] COMPLINE'
+      usage 'completely test (-h|--help)'
 
-      option "-k --keep", "Keep the temporary testing script in the current directory"
+      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."
+      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_debug
 
-      example %q[completely test "mygit pu"]
-      example %q[completely test "mygit pull "]
+      example 'completely test "mygit pu"'
+      example 'completely test "mygit pull "'
 
       def run
         puts tester.test(compline).join "\n"
+
         if args['--keep']
           File.write 'completely-tester.sh', tester_script
           puts 'saved completely-tester.sh'
         end
+
+        syntax_warning unless completions.valid?
       end
 
     private
@@ -45,7 +48,6 @@ module Completely
       def tester_script
         @tester_script ||= tester.tester_script compline
       end
-
     end
   end
 end

data/lib/completely/completions.rb

@@ -3,7 +3,7 @@ require 'erb'
 
 module Completely
   class Completions
-    attr_reader :config, :function_name
+    attr_reader :config
 
     class << self
       def load(config_path, function_name: nil)
@@ -14,13 +14,14 @@ module Completely
           data = YAML.load_file config_path
           # :nocov:
         end
-        
+
         new data, function_name: function_name
       end
     end
 
     def initialize(config, function_name: nil)
-      @config, @function_name = config, function_name
+      @config = config
+      @function_name = function_name
     end
 
     def patterns
@@ -36,11 +37,11 @@ module Completely
     end
 
     def wrapper_function(name = nil)
-      name ||= "send_completions"
+      name ||= 'send_completions'
 
       script_lines = script.split("\n").map do |line|
         clean_line = line.gsub("'") { "\\'" }
-        %Q[  echo $'#{clean_line}']
+        "  echo $'#{clean_line}'"
       end.join("\n")
 
       "#{name}() {\n#{script_lines}\n}"
@@ -53,13 +54,15 @@ module Completely
   private
 
     def patterns!
-      config.map do |text, completions|
-        Pattern.new text, completions
-      end.sort_by { |pattern| -pattern.length }
+      result = config.map do |text, completions|
+        Pattern.new text, completions, pattern_function_name
+      end
+
+      result.sort_by { |pattern| -pattern.length }
     end
 
     def template_path
-      @template_path ||= File.expand_path("templates/template.erb", __dir__)
+      @template_path ||= File.expand_path('templates/template.erb', __dir__)
     end
 
     def template
@@ -67,16 +70,19 @@ module Completely
     end
 
     def command
-      @command ||= config.keys.first.split(' ').first
+      @command ||= config.keys.first.split.first
     end
 
     def function_name
       @function_name ||= "_#{command}_completions"
     end
 
-    def pattern_prefixes
-      patterns.map &:prefix
+    def pattern_function_name
+      @pattern_function_name ||= "#{function_name}_filter"
     end
 
+    def pattern_prefixes
+      patterns.map(&:prefix)
+    end
   end
-end
+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
@@ -16,7 +17,7 @@ module Completely
     end
 
     def words
-      @words ||= completions.reject { |w| w =~ /^<.*>$/ }
+      @words ||= completions.grep_v(/^<.*>$/)
     end
 
     def actions
@@ -27,21 +28,21 @@ module Completely
     end
 
     def prefix
-      text.split(' ')[0]
+      text.split(/ |\*/).first
     end
 
     def case_string
       if text_without_prefix.empty?
-        "*"
-      elsif text_without_prefix.include? "*" 
-        %Q['#{text_without_prefix.gsub "*", "'*'"}']
+        '*'
+      elsif text_without_prefix.include? '*'
+        text_without_prefix.gsub(/([^*]+)/, "'\\1'")
       else
-        %Q['#{text_without_prefix}'*]
+        "'#{text_without_prefix}'*"
       end
     end
 
     def text_without_prefix
-      @text_without_prefix ||= text.split(' ')[1..-1].join ' '
+      @text_without_prefix ||= text[/^#{prefix}\s*(.*)/, 1]
     end
 
     def compgen
@@ -52,9 +53,9 @@ module Completely
 
     def compgen!
       result = []
-      result << %Q[#{actions.join ' '}] if actions.any?
-      result << %Q[-W "#{words.join ' '}"] if words.any?
+      result << actions.join(' ').to_s if actions.any?
+      result << %[-W "$(#{function_name} "#{words.join ' '}")"] if words.any?
       result.any? ? result.join(' ') : nil
     end
   end
-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 %>)
-      while read; do COMPREPLY+=( "$REPLY" ); done < <( compgen <%= pattern.compgen %> -- "$cur" )
+      while read -r; do COMPREPLY+=( "$REPLY" ); done < <( compgen <%= pattern.compgen %> -- "$cur" )
       ;;
 
 % end

data/lib/completely/tester.rb

@@ -5,12 +5,14 @@ module Completely
   class Tester
     attr_reader :script, :script_path, :function_name, :cword, :compline
 
-    def initialize(script: nil, script_path: nil, function_name: )
-      @script, @script_path, @function_name = script, script_path, function_name
+    def initialize(function_name:, script: nil, script_path: nil)
+      @script = script
+      @script_path = script_path
+      @function_name = function_name
     end
 
     def test(compline)
-      Tempfile.create "completely-tester" do |f|
+      Tempfile.create 'completely-tester' do |f|
         f << tester_script(compline)
         f.flush
         `bash #{f.path}`
@@ -26,23 +28,20 @@ module Completely
 
     def set_compline_vars(compline)
       @compline = compline
-      @cword = compline.split(' ').size - 1
+      @cword = compline.split.size - 1
       @cword += 1 if compline.end_with? ' '
     end
 
     def absolute_script_path
-      @absolute_script_path ||= begin
-        script_path ? File.expand_path(script_path) : nil
-      end
+      @absolute_script_path ||= script_path ? File.expand_path(script_path) : nil
     end
 
     def template_path
-      @template_path ||= File.expand_path "templates/tester-template.erb", __dir__
+      @template_path ||= File.expand_path 'templates/tester-template.erb', __dir__
     end
 
     def template
       @template ||= File.read template_path
     end
-
   end
-end
+end

data/lib/completely/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: completely
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.5.1
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-07-14 00:00:00.000000000 Z
+date: 2022-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colsole
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: 0.7.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: 0.7.2
 description: Generate bash completion scripts using simple YAML configuration
 email: db@dannyben.com
 executables:
@@ -64,7 +64,8 @@ files:
 homepage: https://github.com/dannyben/completely
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -80,7 +81,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.14
+rubygems_version: 3.3.26
 signing_key: 
 specification_version: 4
 summary: Bash Completions Generator