hammer_cli 2.2.0 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d903c3dbbe33a2411dfd2e23b781609a40b39b4ed29066cabe35af22335042d5
-  data.tar.gz: 25acdf29e7a071a945a4c7c2c4745083e0e11e7d12ce098c662054a7d87caeb1
+  metadata.gz: 8a632fb8b3ddc1914f0110af4371d152d31e0efe042453512c55dd1384b8bafc
+  data.tar.gz: 76029ef771f18e0096ffdc18f897b1758d09c58277065dce55907f625f13d77e
 SHA512:
-  metadata.gz: 8a117c635359bc261f70cb67bf33fc2080f15b909981a98f87d7c64235a2ecf686bf1530b5293e60565e5e52cab2ed9bbf17f604816099ada8e11b11a5b7f064
-  data.tar.gz: 3e296e36f46d6374fc1878a51447cd2fe820104fa5ba191c6bde91a62aff2fd7b76e12743d152ca0eb9457b541e38dd39351da138020501d286c3af071e33b39
+  metadata.gz: 6777ff43f35fb9b29332e3f02ed68320a5a0f526da5c1a0256f714223ceed72c6d09f3982d0df252be82e2e7ea754fd6105d202f68eebac030d9e6fc6a3db6b6
+  data.tar.gz: 0e7ddb3ea2aaf2080ab8b796c9eb0f68d747a0d290a57bb84e53386de86e17cb51dfbf266fccce3bee71c38123ce0aa67773aaca963fa8001840a56a8a03d467

data/bin/hammer-complete

@@ -5,9 +5,7 @@ require 'English'
 $LOAD_PATH.unshift(File.join(@project_root, 'lib'))
 HAMMER = ENV['HAMMER'] || File.join(@project_root, 'bin/hammer')
 
-require 'yaml'
-
-completion_cache_file = ENV['HAMMER_COMPLETION_CACHE'] || '~/.cache/hammer_completion.yml'
+completion_cache_file = ENV['HAMMER_COMPLETION_CACHE'] || '~/.cache/hammer_completion.json'
 completion_cache_file = File.expand_path(completion_cache_file)
 
 # build the cache if it does not exist

data/config/cli_config.template.yml

@@ -45,7 +45,7 @@
 #:log_pattern: '[%5l %d %c] %m'
 
 # Location of cache for bash completion
-:completion_cache_file: '~/.cache/hammer_completion.yml'
+:completion_cache_file: '~/.cache/hammer_completion.json'
 
 # SSL auth options
 #:ssl:

data/doc/installation.md

@@ -144,7 +144,7 @@ executable specified in `/etc/bash_completion.d/hammer`.
 
 Bash completion for hammer needs pre-built cache that holds description of
 all subcommands and its parameters. The cache is located by default in
-`~/.cache/hammer_completion.yml`. The location can be changed in hammer's
+`~/.cache/hammer_completion.json`. The location can be changed in hammer's
 config file. The cache can be built manually with
 `hammer prebuild-bash-completion` or is built automatically when completion is
 used and the cache is missing (this may cause slight delay). The cache expires

data/doc/installation_source.md

@@ -8,6 +8,7 @@ Clone and install CLI core
 ```bash
 $ git clone https://github.com/theforeman/hammer-cli.git
 $ cd hammer-cli
+$ bundle install
 $ rake install
 $ cd ..
 ```
@@ -17,6 +18,7 @@ clone plugin with foreman commands
 ```bash
 $ git clone https://github.com/theforeman/hammer-cli-foreman.git
 $ cd hammer-cli-foreman
+$ bundle install
 $ rake install
 $ cd ..
 ```
@@ -25,7 +27,8 @@ and optionally other plugins.
 
 
 #### Step 2: enable and configure the plugins
-You'll have to copy configuration files to proper locations manually.
-Please check our [configuration instructions](installation.md#configuration)
+- Add the plugin as a gem to `Gemfile.local.rb`
+- Copy the configuration files to proper locations manually,
+please check our [configuration instructions](installation.md#configuration)
 and see how to proceed.
 

data/doc/release_notes.md

@@ -1,5 +1,22 @@
 Release notes
 =============
+### 2.5.0 (2021-05-04)
+* Better family assignment for options, [#30996](http://projects.theforeman.org/issues/30996)
+* Bump to 2.5.0-develop
+* Right usage in help output for aliases, [#31563](http://projects.theforeman.org/issues/31563)
+
+### 2.4.0 (2021-02-01)
+* Expand path for bash completion file, [#30639](http://projects.theforeman.org/issues/30639)
+* Remove release notes written twice
+* Bump to 2.4.0-develop
+
+### 2.3.0 (2020-11-03)
+* Stop sending empty compute attrs param, [#30815](http://projects.theforeman.org/issues/30815)
+* Make fuzzy search work in hammer shell ([PR #335](https://github.com/theforeman/hammer-cli/pull/335)), [#30747](http://projects.theforeman.org/issues/30747)
+* Add details to installation from source doc ([PR #334](https://github.com/theforeman/hammer-cli/pull/334)), [#30666](http://projects.theforeman.org/issues/30666)
+* Bump to 2.3.0-develop
+* Bump to 2.2.0
+
 ### 2.2.0 (2020-08-11)
 * Update installation_rpm.md ([PR #333](https://github.com/theforeman/hammer-cli/pull/333))
 * Clean gem_release.ipynb up

data/lib/hammer_cli/abstract.rb

@@ -190,18 +190,9 @@ module HammerCLI
 
       option_builder.build(builder_params).each do |option|
         # skip switches that are already defined
-        next if option.nil? or option.switches.any? {|s| find_option(s) }
-
-        if option.respond_to?(:referenced_resource)
-          # Collect options that don't have family, but related to this parent.
-          children = find_options(
-            referenced_resource: option.referenced_resource.to_s,
-            aliased_resource: option.aliased_resource.to_s
-          ).select { |o| o.family.nil? || o.family.head.nil? }
-          children.each do |child|
-            option.family.adopt(child) if option.family
-          end
-        end
+        next if option.nil? || option.switches.any? { |s| find_option(s) }
+
+        adjust_family(option) if option.respond_to?(:family)
         declared_options << option
         block ||= option.default_conversion_block
         define_accessors_for(option, &block)
@@ -411,6 +402,32 @@ module HammerCLI
 
     private
 
+    def self.adjust_family(option)
+      # Collect options that should share the same family
+      # If those options have family, adopt the current one
+      # Else adopt those options to the family of the current option
+      # NOTE: this shouldn't rewrite any options,
+      # although options from similar family could be adopted (appended)
+      options = find_options(
+        aliased_resource: option.aliased_resource.to_s
+      ).select { |o| o.family.nil? || o.family.formats.include?(option.value_formatter.class) }.group_by do |o|
+        next :to_skip if option.family.children.include?(o)
+        next :to_adopt if o.family.nil? || o.family.head.nil?
+        next :to_skip if o.family.children.include?(option)
+        # If both family heads handle the same switch
+        # then `option` is probably from similar family and can be adopted
+        next :adopt_by if option.family.head.nil? || o.family.head.handles?(option.family.head.long_switch)
+
+        :to_skip
+      end
+      options[:to_adopt]&.each do |child|
+        option.family&.adopt(child)
+      end
+      options[:adopt_by]&.map(&:family)&.uniq&.each do |family|
+        family.adopt(option)
+      end
+    end
+
     def self.inherited_output_definition
       od = nil
       if superclass.respond_to? :output_definition

data/lib/hammer_cli/apipie/options.rb

@@ -10,11 +10,11 @@ module HammerCLI::Apipie
       opts = {}
 
       params.each do |p|
-        if p.expected_type == :hash
+        if p.expected_type == :hash && !p.params.empty?
           opts[p.name] = method_options_for_params(p.params, options)
         else
           p_name = HammerCLI.option_accessor_name(p.name)
-          if options.has_key?(p_name)
+          if options.key?(p_name)
             opts[p.name] = options[p_name]
           elsif respond_to?(p_name, true)
             opt = send(p_name)

data/lib/hammer_cli/bash/prebuild_command.rb

@@ -3,10 +3,12 @@ module HammerCLI
     class PrebuildCompletionCommand < HammerCLI::AbstractCommand
       def execute
         map = HammerCLI::MainCommand.completion_map
-        cache_file = HammerCLI::Settings.get(:completion_cache_file)
+        cache_file = File.expand_path(
+          HammerCLI::Settings.get(:completion_cache_file)
+        )
         cache_dir = File.dirname(cache_file)
         FileUtils.mkdir_p(cache_dir) unless File.directory?(cache_dir)
-        File.write(File.expand_path(cache_file), map.to_json)
+        File.write(cache_file, map.to_json)
 
         HammerCLI::EX_OK
       end

data/lib/hammer_cli/help/builder.rb

@@ -61,25 +61,6 @@ module HammerCLI
         label = HighLine.color(label, :bold) if @richtext
         puts label
       end
-
-      private
-
-      def expand_invocation_path(path)
-        bits = path.split(' ')
-        parent_command = HammerCLI::MainCommand
-        new_path = (bits[1..-1] || []).each_with_object([]) do |bit, names|
-          subcommand = parent_command.find_subcommand(bit)
-          next if subcommand.nil?
-
-          names << if subcommand.names.size > 1
-                     "<#{subcommand.names.join('|')}>"
-                   else
-                     subcommand.names.first
-                   end
-          parent_command = subcommand.subcommand_class
-        end
-        new_path.unshift(bits.first).join(' ')
-      end
     end
   end
 end

data/lib/hammer_cli/options/option_family.rb

@@ -5,7 +5,7 @@ module HammerCLI
     class OptionFamily
       attr_reader :children
 
-      IDS_REGEX = /\s?([Ii][Dd][s]?)\W|([Ii][Dd][s]?\Z)/
+      IDS_REGEX = /(\A[Ii][Dd][s]?)|\s([Ii][Dd][s]?)\W|([Ii][Dd][s]?\Z)/
 
       def initialize(options = {})
         @all = []
@@ -13,26 +13,32 @@ module HammerCLI
         @options = options
         @creator = options[:creator] || Class.new(HammerCLI::Apipie::Command)
         @prefix = options[:prefix]
-        @description = options[:description]
         @root = options[:root] || options[:aliased_resource] || options[:referenced_resource]
       end
 
       def description
         types = all.map(&:type).map { |s| s.split('_').last.to_s }
-                   .map(&:capitalize).join('/')
-        @description ||= @parent.help[1].gsub(IDS_REGEX) { |w| w.gsub(/\w+/, types) }
+                   .map(&:downcase).join('/')
+        parent_desc = @parent.help[1].gsub(IDS_REGEX) { |w| w.gsub(/\w+/, types) }
+        desc = parent_desc.strip.empty? ? @options[:description] : parent_desc
         if @options[:deprecation].class <= String
-          format_deprecation_msg(@description, _('Deprecated: %{deprecated_msg}') % { deprecated_msg: @options[:deprecation] })
+          format_deprecation_msg(desc, _('Deprecated: %{deprecated_msg}') % { deprecated_msg: @options[:deprecation] })
         elsif @options[:deprecation].class <= Hash
           full_msg = @options[:deprecation].map do |flag, msg|
             _('%{flag} is deprecated: %{deprecated_msg}') % { flag: flag, deprecated_msg: msg }
           end.join(', ')
-          format_deprecation_msg(@description, full_msg)
+          format_deprecation_msg(desc, full_msg)
         else
-          @description
+          desc
         end
       end
 
+      def formats
+        return [@options[:format].class] if @options[:format]
+
+        all.map(&:value_formatter).map(&:class).uniq
+      end
+
       def switch
         return if @parent.nil? && @children.empty?
         return @parent.help_lhs.strip if @children.empty?
@@ -67,6 +73,9 @@ module HammerCLI
       end
 
       def adopt(child)
+        raise ArgumentError, 'Parent cannot be a child within the same family' if child == @parent
+        raise ArgumentError, 'Child is already in the family' if @children.include?(child)
+
         child.family = self
         @children << child
       end
@@ -103,9 +112,7 @@ module HammerCLI
         max_len.downto(0) do |curr_len|
           0.upto(max_len - curr_len) do |start|
             root = shortest[start, curr_len]
-            if switches.all? { |switch| switch.include?(root) }
-              return root[2..-1].chomp('-')
-            end
+            return root[2..-1].chomp('-') if switches.all? { |switch| switch.include?(root) }
           end
         end
       end

data/lib/hammer_cli/settings.rb

@@ -67,7 +67,7 @@ module HammerCLI
     def self.default_settings
       {
         :use_defaults => true,
-        :completion_cache_file => '~/.cache/hammer_completion.yml'
+        :completion_cache_file => '~/.cache/hammer_completion.json'
       }
     end
 

data/lib/hammer_cli/shell.rb

@@ -97,7 +97,7 @@ module HammerCLI
           history.push(line)
 
           line = HammerCLI::CompleterLine.new(line)
-          ShellMainCommand.run('', line, context) unless line.empty?
+          ShellMainCommand.run('hammer', line, context) unless line.empty?
         end
       rescue Interrupt; end
 

data/lib/hammer_cli/version.rb

@@ -1,5 +1,5 @@
 module HammerCLI
   def self.version
-    @version ||= Gem::Version.new "2.2.0"
+    @version ||= Gem::Version.new "2.5.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hammer_cli
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.5.0
 platform: ruby
 authors:
 - Martin Bačovský
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-11 00:00:00.000000000 Z
+date: 2021-05-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: clamp
@@ -145,37 +145,37 @@ dependencies:
         version: 0.2.0
 description: 'Hammer cli provides universal extendable CLI interface for ruby apps
 
-  '
+'
 email: mbacovsk@redhat.com
 executables:
 - hammer
 - hammer-complete
 extensions: []
 extra_rdoc_files:
-- doc/commands_extension.md
-- doc/release_notes.md
-- doc/design.png
 - doc/commands_modification.md
-- doc/installation.md
-- doc/development_tips.md
-- doc/writing_a_plugin.md
-- doc/output.md
+- doc/creating_apipie_commands.md
+- doc/design.png
+- doc/design.uml
 - doc/developer_docs.md
+- doc/development_tips.md
+- doc/help_modification.md
+- doc/i18n.md
 - doc/installation_deb.md
-- doc/option_normalizers.md
-- doc/installation_rpm.md
 - doc/installation_gem.md
-- doc/help_modification.md
-- doc/creating_commands.md
-- doc/installation_source.md
 - doc/option_builders.md
-- doc/i18n.md
+- doc/option_normalizers.md
+- doc/output.md
 - doc/review_checklist.md
-- doc/creating_apipie_commands.md
-- doc/design.uml
+- doc/writing_a_plugin.md
+- doc/commands_extension.md
+- doc/creating_commands.md
+- doc/installation_rpm.md
+- doc/installation_source.md
+- doc/installation.md
+- doc/release_notes.md
 - config/cli.modules.d/module_config_template.yml
-- config/cli_config.template.yml
 - config/hammer.completion
+- config/cli_config.template.yml
 - README.md
 files:
 - LICENSE
@@ -399,70 +399,70 @@ signing_key:
 specification_version: 4
 summary: Universal command-line interface
 test_files:
-- test/unit/messages_test.rb
-- test/unit/exception_handler_test.rb
-- test/unit/modules_test.rb
-- test/unit/connection_test.rb
-- test/unit/completer_test.rb
-- test/unit/csv_parser_test.rb
-- test/unit/option_builder_test.rb
-- test/unit/test_helper.rb
-- test/unit/utils_test.rb
-- test/unit/apipie/command_test.rb
-- test/unit/apipie/option_builder_test.rb
-- test/unit/apipie/test_helper.rb
+- test/functional/defaults_test.rb
+- test/functional/help_test.rb
+- test/functional/nil_values_test.rb
+- test/functional/test_helper.rb
+- test/test_helper.rb
 - test/unit/apipie/api_connection_test.rb
+- test/unit/apipie/command_test.rb
 - test/unit/apipie/option_definition_test.rb
-- test/unit/command_extensions_test.rb
-- test/unit/main_test.rb
-- test/unit/options/processor_list_test.rb
-- test/unit/options/option_family_test.rb
-- test/unit/options/validators/dsl_test.rb
-- test/unit/options/sources/command_line_test.rb
-- test/unit/options/sources/saved_defaults_test.rb
-- test/unit/options/matcher_test.rb
-- test/unit/options/option_collector_test.rb
-- test/unit/options/normalizers_test.rb
-- test/unit/options/option_definition_test.rb
-- test/unit/settings_test.rb
-- test/unit/history_test.rb
+- test/unit/apipie/test_helper.rb
+- test/unit/apipie/option_builder_test.rb
+- test/unit/bash_test.rb
+- test/unit/ca_cert_manager_test.rb
+- test/unit/completer_test.rb
+- test/unit/connection_test.rb
+- test/unit/csv_parser_test.rb
 - test/unit/defaults_test.rb
-- test/unit/logger_test.rb
-- test/unit/output/formatters_test.rb
-- test/unit/output/record_collection_test.rb
-- test/unit/output/dsl_test.rb
-- test/unit/output/definition_test.rb
-- test/unit/output/output_test.rb
-- test/unit/output/field_filter_test.rb
-- test/unit/output/fields_test.rb
-- test/unit/output/adapter/table_test.rb
-- test/unit/output/adapter/json_test.rb
-- test/unit/output/adapter/abstract_test.rb
-- test/unit/output/adapter/yaml_test.rb
-- test/unit/output/adapter/csv_test.rb
-- test/unit/output/adapter/base_test.rb
-- test/unit/abstract_test.rb
-- test/unit/i18n_test.rb
+- test/unit/exception_handler_test.rb
 - test/unit/fixtures/apipie/architectures.json
 - test/unit/fixtures/apipie/documented.json
-- test/unit/fixtures/defaults/defaults_dashed.yml
-- test/unit/fixtures/defaults/defaults.yml
-- test/unit/fixtures/json_input/valid.json
-- test/unit/fixtures/json_input/invalid.json
 - test/unit/fixtures/certs/ca_cert.pem
 - test/unit/fixtures/certs/non_ca_cert.pem
-- test/unit/bash_test.rb
-- test/unit/help/definition/section_test.rb
-- test/unit/help/definition/list_test.rb
-- test/unit/help/definition/text_test.rb
+- test/unit/fixtures/defaults/defaults.yml
+- test/unit/fixtures/defaults/defaults_dashed.yml
+- test/unit/fixtures/json_input/invalid.json
+- test/unit/fixtures/json_input/valid.json
 - test/unit/help/definition/abstract_item_test.rb
+- test/unit/help/definition/list_test.rb
 - test/unit/help/definition/note_test.rb
+- test/unit/help/definition/section_test.rb
+- test/unit/help/definition/text_test.rb
 - test/unit/help/definition_test.rb
-- test/unit/help/builder_test.rb
 - test/unit/help/text_builder_test.rb
-- test/unit/ca_cert_manager_test.rb
-- test/functional/help_test.rb
-- test/functional/test_helper.rb
-- test/functional/nil_values_test.rb
-- test/functional/defaults_test.rb
-- test/test_helper.rb
+- test/unit/help/builder_test.rb
+- test/unit/history_test.rb
+- test/unit/i18n_test.rb
+- test/unit/logger_test.rb
+- test/unit/main_test.rb
+- test/unit/messages_test.rb
+- test/unit/modules_test.rb
+- test/unit/option_builder_test.rb
+- test/unit/options/matcher_test.rb
+- test/unit/options/normalizers_test.rb
+- test/unit/options/option_collector_test.rb
+- test/unit/options/option_definition_test.rb
+- test/unit/options/processor_list_test.rb
+- test/unit/options/sources/command_line_test.rb
+- test/unit/options/sources/saved_defaults_test.rb
+- test/unit/options/validators/dsl_test.rb
+- test/unit/options/option_family_test.rb
+- test/unit/output/adapter/abstract_test.rb
+- test/unit/output/adapter/base_test.rb
+- test/unit/output/adapter/csv_test.rb
+- test/unit/output/adapter/json_test.rb
+- test/unit/output/adapter/table_test.rb
+- test/unit/output/adapter/yaml_test.rb
+- test/unit/output/dsl_test.rb
+- test/unit/output/field_filter_test.rb
+- test/unit/output/fields_test.rb
+- test/unit/output/formatters_test.rb
+- test/unit/output/output_test.rb
+- test/unit/output/record_collection_test.rb
+- test/unit/output/definition_test.rb
+- test/unit/settings_test.rb
+- test/unit/test_helper.rb
+- test/unit/utils_test.rb
+- test/unit/abstract_test.rb
+- test/unit/command_extensions_test.rb