bashly 0.8.0 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d3d0126229189987753e653a635054113961b1e9e0244d4cdb956beb1d5aff94
-  data.tar.gz: 886987a65edc65d16d2134589cbb4ee9f3fcb9e0b1819c8a87211bcd2d164d0c
+  metadata.gz: 4be359964fc41fae59f83eae85c594a4e0edec41e0cc5752fec25850b7b7ca43
+  data.tar.gz: 62023932e59ae5b9856a9617f9148a7e28bfab5bca5cebca98d3fefbf401ae21
 SHA512:
-  metadata.gz: 880579e8bb650c8835cc7992054f3f4dd3e765ddc1b7072f83ed6fc9049d4b56b38c4a64220c3dd154f8fdbf199462cca1ef955d36d465a0d57ecc00715bd85e
-  data.tar.gz: efa2f73f9eed6d5ba1ebb432e37ef639e618bc1556ba83059ccad4804b6568b407d86f91fe11faa3335b69103e368fdb9bf1339f90af1fd15cb742b91163b911
+  metadata.gz: a0e222c6ead53cfef4597653d9ce51b6e9fffd1a3556acd72eff5447b9a203371a0097cd42f4058405cd473e7f0c55f4f9a448d45d3b1af73898b74a79706df4
+  data.tar.gz: 8362eff89fccaad8c9a1f370270e33426d0089bbe131eec4fc55f586413afaa556caa81e62389daefb400941122db96fa1f8b4e04d3780a4d45ea88060dfdc1e

data/lib/bashly/concerns/command_scopes.rb

@@ -1,6 +1,21 @@
 module Bashly
   # This is a `Command` concern responsible for providing additional scopes.
   module CommandScopes
+    # Returns an array of all full names (including aliases and aliases of
+    # parents)
+    def all_full_names
+      if parent_command
+        parent_command.all_full_names.product(aliases).map { |a| a.join ' ' }
+      else
+        aliases
+      end
+    end
+
+    # Returns a full list of the Command names and aliases combined
+    def command_aliases
+      commands.map(&:aliases).flatten
+    end
+
     # Returns only the names of the Commands
     def command_names
       commands.map &:name

data/lib/bashly/concerns/completions.rb

@@ -1,51 +1,76 @@
 require 'completely'
 
 module Bashly
-  # This is a `Command` concern responsible for providing bash completion data
+  # This is a `Command` and `Flag` concern responsible for providing bash
+  # completion data
   module Completions
-    def completion_data(with_version: true)
-      result = { full_name => completion_words(with_version: with_version) }
-      
-      commands.each do |command|
-        result.merge! command.completion_data(with_version: false)
-      end
+    module Flag
+      def completion_data(command_full_name)
+        result = {}
+        comps = allowed || completions
 
-      result
-    end
+        if comps
+          aliases.each do |name|
+            result["#{command_full_name}*#{name}"] = comps
+          end
+        end
 
-    def completion_script
-      completion_generator.script
+        result
+      end
     end
 
-    def completion_function(name = nil)
-      completion_generator.wrapper_function(name)
-    end
+    module Command
+      def completion_data(with_version: true)
+        result = {}
 
-  private
+        all_full_names.each do |name|
+          result[name] = completion_words(with_version: with_version)
+          flags.each do |flag|
+            result.merge! flag.completion_data(name)
+          end
+        end
+        
+        commands.each do |command|
+          result.merge! command.completion_data(with_version: false)
+        end
 
-    def completion_generator
-      Completely::Completions.new(completion_data)
-    end
+        result
+      end
 
-    def completion_flag_names
-      flags.map(&:name) + flags.map(&:short)
-    end
+      def completion_script
+        completion_generator.script
+      end
 
-    def completion_allowed_args
-      flags.map(&:allowed).flatten + args.map(&:allowed).flatten
-    end
+      def completion_function(name = nil)
+        completion_generator.wrapper_function(name)
+      end
 
-    def completion_words(with_version: false)
-      trivial_flags = %w[--help -h]
-      trivial_flags += %w[--version -v] if with_version
-      all = (
-        command_names + trivial_flags +
-        completion_flag_names + completion_allowed_args
-      )
+    private
 
-      all += completions if completions
-      all.compact.uniq.sort
-    end
+      def completion_generator
+        Completely::Completions.new(completion_data)
+      end
+
+      def completion_flag_names
+        flags.map(&:name) + flags.map(&:short)
+      end
+
+      def completion_allowed_args
+        args.map(&:allowed).flatten
+      end
+
+      def completion_words(with_version: false)
+        trivial_flags = %w[--help -h]
+        trivial_flags += %w[--version -v] if with_version
+        all = (
+          command_aliases + trivial_flags + 
+          completion_flag_names + completion_allowed_args
+        )
 
+        all += completions if completions
+        all.compact.uniq.sort
+      end
+
+    end
   end
-end
+end

data/lib/bashly/concerns/validation_helpers.rb

@@ -52,10 +52,16 @@ module Bashly
       end
     end
 
-    def assert_uniq(key, value, array_key)
+    def assert_uniq(key, value, array_keys)
       return unless value
-      list = value.map { |c| c[array_key] }.compact.flatten
-      assert list.uniq?, "#{key} cannot have elements with similar #{array_key} values"
+      array_keys = [array_keys] unless array_keys.is_a? Array
+      list = []
+      array_keys.each do |array_key|
+        list += value.map { |c| c[array_key] }.compact.flatten
+      end
+
+      nonuniqs = list.nonuniq
+      assert nonuniqs.empty?, "#{key} contains non-unique elements (#{nonuniqs.join ', '}) in #{array_keys.join ' or '}"
     end
 
     def assert_string_or_array(key, value)

data/lib/bashly/config_validator.rb

@@ -61,6 +61,8 @@ module Bashly
       assert_hash key, value, Script::Flag.option_keys
       assert value['short'] || value['long'], "#{key} must have at least one of long or short name"
 
+      refute value['allowed'] && value['completions'], "#{key} cannot have both allowed and completions"
+
       assert_optional_string "#{key}.long", value['long']
       assert_optional_string "#{key}.short", value['short']
       assert_optional_string "#{key}.help", value['help']
@@ -72,6 +74,7 @@ module Bashly
       assert_boolean "#{key}.required", value['required']
       assert_array "#{key}.allowed", value['allowed'], of: :string
       assert_array "#{key}.conflicts", value['conflicts'], of: :string
+      assert_array "#{key}.completions", value['completions'], of: :string
 
       assert value['long'].match(/^--[a-zA-Z0-9_\-]+$/), "#{key}.long must be in the form of '--name'" if value['long']
       assert value['short'].match(/^-[a-zA-Z0-9]$/), "#{key}.short must be in the form of '-n'" if value['short']
@@ -86,6 +89,10 @@ module Bashly
       if value['allowed']
         assert value['arg'], "#{key}.allowed does not make sense without arg"
       end
+
+      if value['completions']
+        assert value['arg'], "#{key}.completions does not make sense without arg"
+      end
     end
 
     def assert_env_var(key, value)
@@ -124,8 +131,7 @@ module Bashly
       assert_array "#{key}.environment_variables", value['environment_variables'], of: :env_var
       assert_array "#{key}.examples", value['examples'], of: :string
 
-      assert_uniq "#{key}.commands", value['commands'], 'name'
-      assert_uniq "#{key}.commands", value['commands'], 'alias'
+      assert_uniq "#{key}.commands", value['commands'], ['name', 'alias']
       assert_uniq "#{key}.flags", value['flags'], 'long'
       assert_uniq "#{key}.flags", value['flags'], 'short'
       assert_uniq "#{key}.args", value['args'], 'name'

data/lib/bashly/extensions/array.rb

@@ -5,8 +5,8 @@ class Array
     map { |line| "#{indentation}#{line}" }
   end
 
-  def uniq?
-    self == uniq
+  def nonuniq
+    tally.select { |key, count| count > 1 }.keys
   end
 
 end

data/lib/bashly/script/command.rb

@@ -1,7 +1,7 @@
 module Bashly
   module Script
     class Command < Base
-      include Completions
+      include Completions::Command
       include CommandScopes
 
       class << self
@@ -62,6 +62,7 @@ module Bashly
         return [] unless options["commands"]
         options["commands"].map do |options|
           options['parents'] = parents + [name]
+          options['parent_command'] = self
           Command.new options
         end
       end
@@ -116,6 +117,11 @@ module Bashly
         Settings.production? ? content : "#{view_marker path}\n#{content}"
       end
 
+      # Returns the Command instance of the direct parent
+      def parent_command
+        options['parent_command']
+      end
+
       # Returns an array of all parents. For example, the command 
       # "docker container run" will have [docker, container] as its parents
       def parents

data/lib/bashly/script/flag.rb

@@ -1,11 +1,13 @@
 module Bashly
   module Script
     class Flag < Base
+      include Completions::Flag
+
       class << self
         def option_keys
           @option_keys ||= %i[
-            allowed arg conflicts default help long repeatable required
-            short validate
+            allowed arg completions conflicts default help long repeatable
+            required short validate
           ]
         end
       end

data/lib/bashly/version.rb

@@ -1,3 +1,3 @@
 module Bashly
-  VERSION = "0.8.0"
+  VERSION = "0.8.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bashly
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.8.1
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-05-12 00:00:00.000000000 Z
+date: 2022-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colsole
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '0.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '0.7'
 - !ruby/object:Gem::Dependency
   name: completely
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: 0.4.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: 0.4.1
 - !ruby/object:Gem::Dependency
   name: mister_bin
   requirement: !ruby/object:Gem::Requirement
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.2'
 description: Generate bash command line tools using YAML configuration
 email: db@dannyben.com
 executables: