completely 0.6.3 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a1725a40745985999197a9e3aa59c2b4d2ff7a5669657e1f4425a5537ae3c888
-  data.tar.gz: 67547ef69659b1751cf17f1c71ede5ad7176e7d3816367ed0bdacccb474b75df
+  metadata.gz: 1ab14df9d4065650b0e776ea29552ef7cc01670bcac03e1ff180bb97412c2099
+  data.tar.gz: 3b0ba408058696ccf0b8d01c5ec230057900d1e9af246144a829229cce098705
 SHA512:
-  metadata.gz: 3aa99c40ee76e3488702a8c6b59f8ba3789ec12995dbf9655f0600d7d81787d2cd2bc820c465247966cc695e84be3aa43cb6ccf08854b85d4422f2f0fe8b4bba
-  data.tar.gz: eb44a7eee738f7810491913b4a9873a528804991669a506d63fa54dc610bef025daf2603fd9c3db6c5c21b3d119580e12e224d54e75880f87cd4b4aa71ec08df
+  metadata.gz: b94ccf5f12af3764620cb90b0da5bee7a3306f7dd9f39b0b47e0715d7198cc96ca147c64a8eff243d555abb9ee52398a437f053499837df1563eef3d655f86d9
+  data.tar.gz: a5d7ea400c07344a899a33c55a84263cc5cf146f7039e8ed11e02e7ee728f326a19aa20c999c975f7d75046d998095a6a25e84815319fd06d5bc11d5fdb12ebf

data/README.md

@@ -40,10 +40,10 @@ or with Docker:
 $ alias completely='docker run --rm -it --user $(id -u):$(id -g) --volume "$PWD:/app" dannyben/completely'
 ```
 
-## Using the `completely` command line
+## Configuration syntax
 
-The `completely` command line works with a simple YAML configuration file as
-input, and generates a bash completions script as output.
+Completely works with a simple YAML configuration file as input, and generates
+a bash completions script as output.
 
 The configuration file is built of blocks that look like this:
 
@@ -59,7 +59,7 @@ for the auto complete process.
 
 You can save a sample YAML file by running:
 
-```
+```bash
 $ completely init
 ```
 
@@ -67,37 +67,34 @@ This will generate a file named `completely.yaml` with this content:
 
 ```yaml
 mygit:
+- -h
+- -v
 - --help
 - --version
-- status
 - init
-- commit
+- status
+
+mygit init:
+- --bare
+- <directory>
 
 mygit status:
 - --help
 - --verbose
 - --branch
-- $(git branch 2>/dev/null)
+- -b
 
-mygit init:
-- --bare
-- <directory>
+mygit status*--branch: &branches
+- $(git branch --format='%(refname:short)' 2>/dev/null)
 
-mygit commit:
-- <file>
-- --help
-- --message
-- --all
-- -a
-- --quiet
-- -q
+mygit status*-b: *branches
 ```
 
 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.
+input, and if the input matches the pattern, the list that follows it will be
+suggested as completions.
 
-Note that the suggested completions will not show flags (string that start with 
+Note that the suggested completions will not show flags (strings that start with 
 a hyphen `-`) unless the input ends with a hyphen.
 
 To generate the bash script, simply run:
@@ -169,7 +166,7 @@ branches to your suggestions, use the following:
 
 ```yaml
 mygit:
-- $(git branch 2>/dev/null)
+- $(git branch --format='%(refname:short)' 2>/dev/null)
 ```
 
 The `2> /dev/null` is used so that if the command is executed in a directory
@@ -186,10 +183,10 @@ mygit checkout:
 - -b
 
 mygit checkout*--branch:
-- $(git branch 2>/dev/null)
+- $(git branch --format='%(refname:short)' 2>/dev/null)
 
 mygit checkout*-b:
-- $(git branch 2>/dev/null)
+- $(git branch --format='%(refname:short)' 2>/dev/null)
 ```
 
 The above will suggest git branches for commands that end with `-b` or `--branch`.
@@ -202,11 +199,53 @@ mygit checkout:
 - -b
 
 mygit checkout*--branch: &branches
-- $(git branch 2>/dev/null)
+- $(git branch --format='%(refname:short)' 2>/dev/null)
 
 mygit checkout*-b: *branches
 ```
 
+### Alternative nested syntax
+
+Completely also supports an alternative nested syntax. You can generate this
+example by running:
+
+```bash
+$ completely init --nested
+```
+
+The example configuration below will generate the exact same script as the one
+shown at the beginning of this document.
+
+```yaml
+mygit:
+- -h
+- -v
+- --help
+- --version
+- init:
+  - --bare
+  - <directory>
+- status:
+  - --help
+  - --verbose
+  - +--branch: &branches
+    - $(git branch --format='%(refname:short)' 2>/dev/null)
+  - +-b: *branches
+```
+
+The rules here are as follows:
+
+- Each pattern (e.g., `mygit`) can have a mixed array of strings and hashes.
+- Strings and hash keys (e.e., `--help` and `init` respectively) will be used
+  as completion strings for that pattern.
+- Hashes may contain a nested mixed array of the same structure.
+- When a hash is provided, the hash key will be appended to the parent prefix.
+  In the example above, the `init` hash will create the pattern `mygit init`.
+- In order to provide a wildcard (like `mygit status*--branch` in the standard
+  configuration syntax), you can provide either a `*` or a `+` prefix to the
+  hash key (e.g., `+--branch` or `"*--branch"`). Note that when using a `*`, 
+  the hash key must be quoted since asterisks have special meaning in YAML.
+
 ## Using the generated completion scripts
 
 In order to enable the completions, simply source the generated script:

data/lib/completely/commands/init.rb

@@ -5,9 +5,11 @@ module Completely
     class Init < Base
       help 'Create a new sample YAML configuration file'
 
-      usage 'completely init [CONFIG_PATH]'
+      usage 'completely init [--nested] [CONFIG_PATH]'
       usage 'completely init (-h|--help)'
 
+      option '-n --nested', 'Generate a nested configuration'
+
       param_config_path
       environment_config_path
 
@@ -24,8 +26,15 @@ module Completely
         @sample ||= File.read sample_path
       end
 
+      def nested?
+        args['--nested']
+      end
+
       def sample_path
-        @sample_path ||= File.expand_path '../templates/sample.yaml', __dir__
+        @sample_path ||= begin
+          sample_name = nested? ? 'sample-nested' : 'sample'
+          File.expand_path "../templates/#{sample_name}.yaml", __dir__
+        end
       end
     end
   end

data/lib/completely/completions.rb

@@ -7,23 +7,20 @@ module Completely
 
     class << self
       def load(config_path, function_name: nil)
-        begin
-          data = YAML.load_file config_path, aliases: true
-        rescue ArgumentError
-          # :nocov:
-          data = YAML.load_file config_path
-          # :nocov:
-        end
-
-        new data, function_name: function_name
+        config = Config.load config_path
+        new config, function_name: function_name
       end
     end
 
     def initialize(config, function_name: nil)
-      @config = config
+      @config = config.is_a?(Config) ? config : Config.new(config)
       @function_name = function_name
     end
 
+    def flat_config
+      @flat_config ||= config.flat_config
+    end
+
     def patterns
       @patterns ||= patterns!
     end
@@ -54,7 +51,7 @@ module Completely
   private
 
     def patterns!
-      result = config.map do |text, completions|
+      result = flat_config.map do |text, completions|
         Pattern.new text, completions, pattern_function_name
       end
 
@@ -70,7 +67,7 @@ module Completely
     end
 
     def command
-      @command ||= config.keys.first.split.first
+      @command ||= flat_config.keys.first.split.first
     end
 
     def function_name

data/lib/completely/config.rb

@@ -0,0 +1,69 @@
+module Completely
+  class Config
+    attr_reader :config
+
+    class << self
+      def load(config_path)
+        begin
+          config = YAML.load_file config_path, aliases: true
+        rescue ArgumentError
+          # :nocov:
+          config = YAML.load_file config_path
+          # :nocov:
+        end
+
+        new config
+      end
+    end
+
+    def initialize(config)
+      @config = config
+    end
+
+    def flat_config
+      result = {}
+
+      config.each do |root_key, root_list|
+        result.merge! process_key(root_key, root_list)
+      end
+
+      result
+    end
+
+  private
+
+    def process_key(prefix, list)
+      result = {}
+      result[prefix] = collect_immediate_children list
+      result.merge! process_nested_items(prefix, list)
+      result
+    end
+
+    def collect_immediate_children(list)
+      list.map do |item|
+        x = item.is_a?(Hash) ? item.keys.first : item
+        x.gsub(/^[*+]/, '')
+      end
+    end
+
+    def process_nested_items(prefix, list)
+      result = {}
+
+      list.each do |item|
+        next unless item.is_a? Hash
+
+        nested_prefix = generate_nested_prefix(prefix, item)
+        nested_list = item.values.first
+        result.merge!(process_key(nested_prefix, nested_list))
+      end
+
+      result
+    end
+
+    def generate_nested_prefix(prefix, item)
+      appended_prefix = item.keys.first.gsub(/^\+/, '*')
+      appended_prefix = " #{appended_prefix}" unless appended_prefix.start_with? '*'
+      "#{prefix}#{appended_prefix}"
+    end
+  end
+end

data/lib/completely/templates/sample-nested.yaml

@@ -0,0 +1,14 @@
+mygit:
+- -h
+- -v
+- --help
+- --version
+- init:
+  - --bare
+  - <directory>
+- status:
+  - --help
+  - --verbose
+  - +--branch: &branches
+    - $(git branch --format='%(refname:short)' 2>/dev/null)
+  - +-b: *branches

data/lib/completely/templates/sample.yaml

@@ -1,25 +1,22 @@
 mygit:
+- -h
+- -v
 - --help
 - --version
-- status
 - init
-- commit
+- status
+
+mygit init:
+- --bare
+- <directory>
 
 mygit status:
 - --help
 - --verbose
 - --branch
-- $(git branch 2>/dev/null)
+- -b
 
-mygit init:
-- --bare
-- <directory>
+mygit status*--branch: &branches
+- $(git branch --format='%(refname:short)' 2>/dev/null)
 
-mygit commit:
-- <file>
-- --help
-- --message
-- --all
-- -a
-- --quiet
-- -q
+mygit status*-b: *branches

data/lib/completely/version.rb

@@ -1,3 +1,3 @@
 module Completely
-  VERSION = '0.6.3'
+  VERSION = '0.7.0'
 end

data/lib/completely.rb

@@ -1,4 +1,5 @@
 require 'completely/exceptions'
+require 'completely/config'
 require 'completely/pattern'
 require 'completely/completions'
 require 'completely/tester'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: completely
 version: !ruby/object:Gem::Version
-  version: 0.6.3
+  version: 0.7.0
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-07-05 00:00:00.000000000 Z
+date: 2024-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colsole
@@ -63,9 +63,11 @@ files:
 - lib/completely/commands/test.rb
 - lib/completely/commands/uninstall.rb
 - lib/completely/completions.rb
+- lib/completely/config.rb
 - lib/completely/exceptions.rb
 - lib/completely/installer.rb
 - lib/completely/pattern.rb
+- lib/completely/templates/sample-nested.yaml
 - lib/completely/templates/sample.yaml
 - lib/completely/templates/template.erb
 - lib/completely/templates/tester-template.erb
@@ -94,7 +96,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.14
+rubygems_version: 3.5.23
 signing_key:
 specification_version: 4
 summary: Bash Completions Generator