completely 0.1.2 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c09f951fc28b18f24c2c28fd7c80a15b3731aa07456145ab905c63c2b0dc9634
-  data.tar.gz: a9a25173ab3358e7eea42fe38552cbced8c6602bf5a0e9e6c414555420ae7af6
+  metadata.gz: 6f19143967a28107018c600c7f302bfccd2cf34d70a88be661f68e340e515c07
+  data.tar.gz: 6037bb0f6944627f97abf37c51f76d1db213b42402db092fa6c36fb257892c22
 SHA512:
-  metadata.gz: b6edd13c5a0084485b7cb7114c45cf30d8c144075a3791aa51a8f5e7fc71df825cb03cb4786bc8fb3832f7bc1a46f06876614493184c4602d7e2e0dfbd3d4854
-  data.tar.gz: f8eb6cb08636c4281b50d7542d3c92fc8c6914e10597605f48e29ae342b6fb8cd31fff84de9e81dc0a7011bd5e963469c11fe025719e537238883d0a5812b5d9
+  metadata.gz: c46ac169ab59595c67d3d8a8c320ea7fb56e78715fbc2dd55e4e20534c8543c66f0b62dda01a6802bbaf9f071a5ebd7ffa55a17c70443e05bba8ab8c3bedce71
+  data.tar.gz: ac9a7a7934e115957271ec1e5cc736c0df29368f18da6f9eb409069f9690cb2594d6b9bdbf6d4fd18388ce79f7285e66a357d4bb241083ca083fd57102c95746

data/README.md

@@ -13,7 +13,10 @@ This tool is for you if:
 
 1. You develop your own command line tools.
 2. Your life feels empty without bash completions.
-3. Bash completion scripts scare you.
+3. Bash completion scripts seem overly complex to you.
+
+Note that if you are building bash command line scripts with [bashly][bashly],
+then this functionality is already integrated with it.
 
 ---
 
@@ -29,15 +32,18 @@ $ gem install completely
 The `completely` command line works with a simple YAML configuration file as
 input, and generates a bash completions script as output.
 
-The configuration file is built like this:
+The configuration file is built of blocks that look like this:
 
 ```yaml
 pattern:
-  - --argument
-  - --param
-  - command
+- --argument
+- --param
+- command
 ```
 
+Each pattern contains an array of words (or functions) that will be suggested
+for the auto complete process.
+
 You can save a sample YAML file by running:
 
 ```
@@ -58,6 +64,7 @@ mygit status:
 - --help
 - --verbose
 - --branch
+- $(git branch 2> /dev/null)
 
 mygit init:
 - --bare
@@ -92,21 +99,66 @@ For more options (like setting input/output path), run
 $ completely --help
 ```
 
-### Suggesting files and directories
+### Suggesting files, directories and other bash built-ins
 
-You may have noticed that the sample file contains two special entries:
+In addition to specifying a simple array of completion words, you may use
+the special syntax `<..>` to suggest more advanced functions.
 
-- `<file>`
-- `<directory>`
+```yaml
+pattern:
+- <file>
+- <directory>
+```
 
-These patterns will add the list of files and directories
+These suggestions will add the list of files and directories
 (when `<file>` is used) or just directories (when `<directory>` is used) to
 the list of suggestions.
 
+You may use any of the below keywords to add additional suggestions:
+
+| Keyword       | Meaning
+|---------------|---------------------
+| `<alias>`     | Alias names
+| `<arrayvar>`  | Array variable names
+| `<binding>`   | Readline key binding names
+| `<builtin>`   | Names of shell builtin commands
+| `<command>`   | Command names
+| `<directory>` | Directory names
+| `<disabled>`  | Names of disabled shell builtins
+| `<enabled>`   | Names of enabled shell builtins
+| `<export>`    | Names of exported shell variables
+| `<file>`      | File names
+| `<function>`  | Names of shell functions
+| `<group>`     | Group names
+| `<helptopic>` | Help topics as accepted by the help builtin
+| `<hostname>`  | Hostnames, as taken from the file specified by the HOSTFILE shell variable
+| `<job>`       | Job names
+| `<keyword>`   | Shell reserved words
+| `<running>`   | Names of running jobs
+| `<service>`   | Service names
+| `<signal>`    | Signal names
+| `<stopped>`   | Names of stopped jobs
+| `<user>`      | User names
+| `<variable>`  | Names of all shell variables
+
 For those interested in the technical details, any word between `<...>` will
 simply be added using the [`compgen -A action`][compgen] function, so you can 
 in fact use any of its supported arguments.
 
+### Suggesting custom dynamic suggestions
+
+You can also use any command that outputs a whitespace-delimited list as a
+suggestions list, by wrapping it in `$(..)`. For example, in order to add git
+branches to your suggestions, use the following:
+
+```yaml
+mygit:
+- $(git branch 2> /dev/null)
+```
+
+The `2> /dev/null` is used so that if the command is executed in a directory
+without a git repository, it will still behave as expected.
+
 
 ## Using the generated completion scripts
 
@@ -152,3 +204,4 @@ to contribute, feel free to [open an issue][issues].
 
 [issues]: https://github.com/DannyBen/completely/issues
 [compgen]: https://www.gnu.org/software/bash/manual/html_node/Programmable-Completion-Builtins.html
+[bashly]: https://bashly.dannyb.co/

data/lib/completely/command.rb

@@ -37,6 +37,7 @@ module Completely
 
     def preview_command
       puts script
+      syntax_warning unless completions.valid?
     end
     
     def generate_command
@@ -44,6 +45,7 @@ module Completely
       output = wrap ? wrapper_function(wrap) : script
       File.write output_path, output
       say "Saved !txtpur!#{output_path}"
+      syntax_warning unless completions.valid?
     end
 
   private
@@ -76,5 +78,10 @@ module Completely
       @completions ||= Completions.load(config_path, function_name: args['--function'])
     end
 
+    def syntax_warning
+      say! "\n!txtred!WARNING:\nYour configuration is invalid."
+      say! "!txtred!All patterns must start with the same word."
+    end
+
   end
 end

data/lib/completely/completions.rb

@@ -7,7 +7,13 @@ module Completely
 
     class << self
       def load(config_path, function_name: nil)
-        new YAML.load_file(config_path), function_name: function_name
+        begin
+          data = YAML.load_file config_path, aliases: true
+        rescue ArgumentError
+          data = YAML.load_file config_path
+        end
+        
+        new data, function_name: function_name
       end
     end
 
@@ -15,6 +21,14 @@ module Completely
       @config, @function_name = config, function_name
     end
 
+    def patterns
+      @patterns ||= patterns!
+    end
+
+    def valid?
+      pattern_prefixes.uniq.count == 1
+    end
+
     def script
       ERB.new(template, trim_mode: '%-').result(binding)
     end
@@ -32,6 +46,12 @@ module Completely
 
   private
 
+    def patterns!
+      config.map do |text, completions|
+        Pattern.new text, completions
+      end.sort_by { |pattern| -pattern.length }
+    end
+
     def template_path
       @template_path ||= File.expand_path("template.erb", __dir__)
     end
@@ -41,16 +61,16 @@ module Completely
     end
 
     def command
-      @command ||= config.keys.first
-    end
-
-    def patterns
-      @patterns ||= config.to_a.sort_by { |k, v| -k.size }.to_h
+      @command ||= config.keys.first.split(' ').first
     end
 
     def function_name
       @function_name ||= "_#{command}_completions"
     end
 
+    def pattern_prefixes
+      patterns.map &:prefix
+    end
+
   end
 end

data/lib/completely/pattern.rb

@@ -0,0 +1,50 @@
+module Completely
+  class Pattern
+    attr_reader :text, :completions
+
+    def initialize(text, completions)
+      @text = text
+      @completions = completions || []
+    end
+
+    def length
+      @length ||= text.size
+    end
+
+    def empty?
+      completions.empty?
+    end
+
+    def words
+      @words ||= completions.reject { |w| w =~ /^<.*>$/ }
+    end
+
+    def actions
+      @actions ||= completions.filter_map do |word|
+        action = word[/^<(.+)>$/, 1]
+        "-A #{action}" if action
+      end
+    end
+
+    def prefix
+      text.split(' ')[0]
+    end
+
+    def text_without_prefix
+      text.split(' ')[1..-1].join ' '
+    end
+
+    def compgen
+      @compgen ||= compgen!
+    end
+
+  private
+
+    def compgen!
+      result = []
+      result << %Q[#{actions.join ' '}] if actions.any?
+      result << %Q[-W "#{words.join ' '}"] if words.any?
+      result.any? ? result.join(' ') : nil
+    end
+  end
+end

data/lib/completely/sample.yaml

@@ -9,6 +9,7 @@ mygit status:
 - --help
 - --verbose
 - --branch
+- $(git branch 2> /dev/null)
 
 mygit init:
 - --bare

data/lib/completely/template.erb

@@ -5,14 +5,12 @@
 # Modifying it manually is not recommended
 <%= function_name %>() {
   local cur=${COMP_WORDS[COMP_CWORD]}
+  local comp_line="${COMP_WORDS[@]:1}"
 
-  case "$COMP_LINE" in
-% patterns.each do |pattern, words|
-% next unless words
-% clean_words = words.reject { |w| w =~ /^<.*>$/ }.join " "
-% functions = words.filter_map { |w| func = w[/^<(.+)>$/, 1] ; "-A #{func}" if func }
-% flags = functions.any? ? "#{functions.join ' '} -W" : "-W"
-    '<%= pattern %>'*) COMPREPLY=($(compgen <%= flags %> "<%= clean_words %>" -- "$cur")) ;;
+  case "$comp_line" in
+% patterns.each do |pattern|
+% next if pattern.empty?
+    '<%= pattern.text_without_prefix %>'*) COMPREPLY=($(compgen <%= pattern.compgen %> -- "$cur")) ;;
 % end
   esac
 }

data/lib/completely/version.rb

@@ -1,3 +1,3 @@
 module Completely
-  VERSION = "0.1.2"
+  VERSION = "0.3.1"
 end

data/lib/completely.rb

@@ -3,5 +3,5 @@ if ENV['BYEBUG']
   require 'lp'
 end
 
-# requires 'completely'
+require 'completely/pattern'
 require 'completely/completions'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: completely
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.3.1
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-20 00:00:00.000000000 Z
+date: 2022-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colsole
@@ -51,6 +51,7 @@ files:
 - lib/completely/cli.rb
 - lib/completely/command.rb
 - lib/completely/completions.rb
+- lib/completely/pattern.rb
 - lib/completely/sample.yaml
 - lib/completely/template.erb
 - lib/completely/version.rb
@@ -73,7 +74,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.16
+rubygems_version: 3.2.15
 signing_key: 
 specification_version: 4
 summary: Bash Completions Generator