hammer_cli 2.1.1 → 2.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8e7d0cc6fea99d3276fb653e462448bddc6b8977e0e5ed9df2a1f257365bee84
-  data.tar.gz: 72123cef1ffaafb8979ff5e6bac55ca0fa9776e88800327ad41b48404a3a6284
+  metadata.gz: dae98160a2f04eb29858cd97cc219ebc440dbe8db359cd4c5c742ef164fb3c7d
+  data.tar.gz: 3c062268d65695c331953183322e23e373ac1359bc3110a1f48aed8d93f818f9
 SHA512:
-  metadata.gz: 1514dfe8e1059a70da7af58887e9763d604eaec59ec438af136b2a430338ba0c4c9222e4e86f275fb12135165dabb1f51281daaba5ba48924e32d206307bd94e
-  data.tar.gz: a17a67150e2bf0fb293f167d72cc5425e0fe0ebc9eb57c30144e5be952dbb45d8e370257408893727cfadcf3ce6d2607e098f90a1eb40955ff0dc98dc1ac39f1
+  metadata.gz: d12884641c2450d7b9893f5b8db2d13ad27958aabfbd06e9d763d8f35eb86ba813290c73933c6a4cdbf456c32f38d82ff96247f048ad6db4fe4bbd4feb0f0ad1
+  data.tar.gz: 05c7c44cbc98c2e3a4e4e3419120e7bacdc9131f8b0ec086762afe655179ccb7985764042d53e03839358447d5d87bcf20025a5635e0804ac45ec5fc694c0c27

data/doc/installation_rpm.md

@@ -1,8 +1,8 @@
 ### Installation from RPMs
 
-#### Step 1: setup yum repositories
+#### Step 1: set up yum repositories
 
-For Foreman 1.3 stable the hammer packages are part of your installation repo and you can skip this step.
+For Foreman 1.3 stable, the hammer packages are part of your installation repo and you can skip this step.
 
 You can choose from stable or nightly repo. Nightly has more recent version of hammer packages, but it was subject to less testing so there is a higher risk of issues.
 Add the Foreman yum repository to your yum repo files. For Fedora installations replace 'el6' with 'f18' or 'f19' as appropriate.

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,9 +1,28 @@
 Release notes
 =============
-### 2.1.1 (2020-05-29)
+### 2.3.1 (2021-05-04)
+* Better family assignment for options, [#30996](http://projects.theforeman.org/issues/30996)
+
+### 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.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
 * Replace awesome_print with amazing_print ([PR #330](https://github.com/theforeman/hammer-cli/pull/330)), [#29846](http://projects.theforeman.org/issues/29846)
 * Fix typo: s/filed/feild/ ([PR #331](https://github.com/theforeman/hammer-cli/pull/331))
+* Bump to 2.2.0-develop
 
 ### 2.1.0 (2020-05-14)
 * Hammer full-help returns correct output, [#29697](http://projects.theforeman.org/issues/29697)

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/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/utils.rb

@@ -121,7 +121,7 @@ module HammerCLI
     bits = path.split(' ')
     parent_command = HammerCLI::MainCommand
     new_path = (bits[1..-1] || []).each_with_object([]) do |bit, names|
-      subcommand = parent_command.find_subcommand(bit)
+      subcommand = parent_command.find_subcommand(bit, fuzzy: false)
       next if subcommand.nil?
 
       names << if subcommand.names.size > 1

data/lib/hammer_cli/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hammer_cli
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 2.3.1
 platform: ruby
 authors:
 - Martin Bačovský
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-29 00:00:00.000000000 Z
+date: 2021-05-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: clamp
@@ -152,30 +152,30 @@ executables:
 - hammer-complete
 extensions: []
 extra_rdoc_files:
-- doc/commands_extension.md
 - doc/commands_modification.md
 - doc/creating_apipie_commands.md
-- doc/creating_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.md
 - doc/installation_deb.md
 - doc/installation_gem.md
-- doc/installation_rpm.md
-- doc/installation_source.md
 - doc/option_builders.md
 - doc/option_normalizers.md
 - doc/output.md
 - doc/review_checklist.md
 - 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
@@ -394,7 +394,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: Universal command-line interface
@@ -404,15 +404,13 @@ test_files:
 - test/functional/nil_values_test.rb
 - test/functional/test_helper.rb
 - test/test_helper.rb
-- test/unit/abstract_test.rb
 - test/unit/apipie/api_connection_test.rb
 - test/unit/apipie/command_test.rb
-- test/unit/apipie/option_builder_test.rb
 - test/unit/apipie/option_definition_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/command_extensions_test.rb
 - test/unit/completer_test.rb
 - test/unit/connection_test.rb
 - test/unit/csv_parser_test.rb
@@ -426,7 +424,6 @@ test_files:
 - test/unit/fixtures/defaults/defaults_dashed.yml
 - test/unit/fixtures/json_input/invalid.json
 - test/unit/fixtures/json_input/valid.json
-- test/unit/help/builder_test.rb
 - test/unit/help/definition/abstract_item_test.rb
 - test/unit/help/definition/list_test.rb
 - test/unit/help/definition/note_test.rb
@@ -434,6 +431,7 @@ test_files:
 - test/unit/help/definition/text_test.rb
 - test/unit/help/definition_test.rb
 - test/unit/help/text_builder_test.rb
+- test/unit/help/builder_test.rb
 - test/unit/history_test.rb
 - test/unit/i18n_test.rb
 - test/unit/logger_test.rb
@@ -445,24 +443,26 @@ test_files:
 - test/unit/options/normalizers_test.rb
 - test/unit/options/option_collector_test.rb
 - test/unit/options/option_definition_test.rb
-- test/unit/options/option_family_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/definition_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