hammer_cli 2.5.0 → 2.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8a632fb8b3ddc1914f0110af4371d152d31e0efe042453512c55dd1384b8bafc
-  data.tar.gz: 76029ef771f18e0096ffdc18f897b1758d09c58277065dce55907f625f13d77e
+  metadata.gz: a39815aa1d748fda7475b583f55c801a8391e21a6418aad7e479a3a8754f1412
+  data.tar.gz: ffce03a8a4057f28dd21fde44100a7867f7efe2ce2f2f7e2a18dd0b037ce5983
 SHA512:
-  metadata.gz: 6777ff43f35fb9b29332e3f02ed68320a5a0f526da5c1a0256f714223ceed72c6d09f3982d0df252be82e2e7ea754fd6105d202f68eebac030d9e6fc6a3db6b6
-  data.tar.gz: 0e7ddb3ea2aaf2080ab8b796c9eb0f68d747a0d290a57bb84e53386de86e17cb51dfbf266fccce3bee71c38123ce0aa67773aaca963fa8001840a56a8a03d467
+  metadata.gz: fdfe7222cc2b1dc5059a62b8cdef4effd09af391d5880fb2f2315d9ca8d20124ffa2aa07aaebc56be6dd01cf988c69490b8a98da86e29fd166949d9d67e257c3
+  data.tar.gz: 34ee4d3731a3a4d4e883acb11dd7dcae4b7cdc9ff45cc513642ebef428a67fd33e7072cc37ba4a8d791c0425afbdfbc8506bc032041e0d86b62387f736aeb32e

data/doc/commands_extension.md

@@ -16,11 +16,11 @@ Each command can be easily extended with one ore more `HammerCLI::CommandExtensi
       child option_params
     end
     # Extend hash with data returned from server before it is printed
-    before_print do |data|
+    before_print do |data, command_object, command_class|
       # data modifications
     end
     # Extend command's output definition
-    output do |definition|
+    output do |definition, command_object, command_class|
       # output definition modifications
     end
     # Extend command's help definition
@@ -28,19 +28,19 @@ Each command can be easily extended with one ore more `HammerCLI::CommandExtensi
       # help modifications
     end
     # Extend hash with headers before request is sent
-    request_headers do |headers|
+    request_headers do |headers, command_object, command_class|
       # headers modifications
     end
     # Extend hash with options before request is sent
-    request_options do |options|
+    request_options do |options, command_object, command_class|
       # options modifications
     end
     # Extend hash with params before request is sent
-    request_params do |params|
+    request_params do |params, command_object, command_class|
       # params modifications
     end
     # Extend option sources
-    option_sources do |sources, command|
+    option_sources do |sources, command_object, command_class|
       # no need to call super method
       # simply add your sources to sources variable
     end
@@ -63,6 +63,8 @@ __NOTE:__
   - `request_*` extensions are applied before sending a request to the server
   - `option`, `output`, `help` extensions are applied right away after the command is extended with `extend_with`
   - `before_print` extensions are applied right away after the server returns the data
+  - `request_*`, `output`, `before_print` extensions have access to the command object
+    after the command with the extension was initialized
 
 #### Example
 ```ruby

data/doc/release_notes.md

@@ -1,5 +1,11 @@
 Release notes
 =============
+### 2.5.1 (2021-06-08)
+* Add full comparison for fields option, [#31984](http://projects.theforeman.org/issues/31984)
+* Force capitalized field names in help, [#32444](http://projects.theforeman.org/issues/32444)
+* Unescape enum validator description, [#32570](http://projects.theforeman.org/issues/32570)
+* Make cmd object be available in command extensions, [#32568](http://projects.theforeman.org/issues/32568)
+
 ### 2.5.0 (2021-05-04)
 * Better family assignment for options, [#30996](http://projects.theforeman.org/issues/30996)
 * Bump to 2.5.0-develop

data/lib/hammer_cli/abstract.rb

@@ -20,6 +20,8 @@ module HammerCLI
   class AbstractCommand < Clamp::Command
     include HammerCLI::Subcommand
 
+    attr_reader :context
+
     class << self
       attr_accessor :validation_blocks
 
@@ -75,7 +77,7 @@ module HammerCLI
       begin
         begin
           exit_code = super
-          context.delete(:fields)
+          clean_up_context
           raise "exit code must be integer" unless exit_code.is_a? Integer
         rescue => e
           exit_code = handle_exception(e)
@@ -97,6 +99,10 @@ module HammerCLI
       HammerCLI::EX_OK
     end
 
+    def clean_up_context
+      context.delete(:fields)
+    end
+
     def self.validate_options(mode=:append, target_name=nil, validator: nil, &block)
       validator ||= HammerCLI::Options::Validators::DSLBlockValidator.new(&block)
       self.validation_blocks ||= []
@@ -115,6 +121,9 @@ module HammerCLI
       super
       context[:path] ||= []
       context[:path] << self
+      self.class.command_extensions.each do |extension|
+        extension.command_object(self)
+      end
     end
 
     def parent_command
@@ -207,11 +216,12 @@ module HammerCLI
           raise ArgumentError, _('Command extensions should be inherited from %s.') % HammerCLI::CommandExtensions
         end
         extension.delegatee(self)
-        extension.extend_predefined_options(self)
-        extension.extend_options(self)
-        extension.extend_option_family(self)
-        extension.extend_output(self)
-        extension.extend_help(self)
+        extension.command_class(self)
+        extension.extend_predefined_options
+        extension.extend_options
+        extension.extend_option_family
+        extension.extend_output
+        extension.extend_help
         logger('Extensions').info "Applied #{extension.details} on #{self}."
         command_extensions << extension
       end
@@ -359,7 +369,7 @@ module HammerCLI
 
       sources = HammerCLI::Options::ProcessorList.new([sources])
       self.class.command_extensions.each do |extension|
-        extension.extend_option_sources(sources, self)
+        extension.extend_option_sources(sources)
       end
       sources
     end

data/lib/hammer_cli/apipie/option_builder.rb

@@ -72,7 +72,9 @@ module HammerCLI::Apipie
       elsif param.expected_type.to_s == 'boolean' || param.validator.to_s == 'boolean'
         opts[:format] = HammerCLI::Options::Normalizers::Bool.new
       elsif param.expected_type.to_s == 'string' && param.validator =~ /Must be one of: (.*)\./
-        allowed = $1.split(/,\ ?/).map { |val| val.gsub(/<[^>]*>/i,'') }
+        allowed = $1.split(/,\ ?/).map { |val| val.gsub(/<[^>]*>/i, '') }.map do |item|
+          CGI.unescapeHTML(item)
+        end
         opts[:format] = HammerCLI::Options::Normalizers::Enum.new(allowed)
       elsif param.expected_type.to_s == 'numeric'
         opts[:format] = HammerCLI::Options::Normalizers::Number.new

data/lib/hammer_cli/command_extensions.rb

@@ -93,80 +93,88 @@ module HammerCLI
 
     # Object
 
-    def extend_options(command_class)
+    def extend_options
       allowed = @only & %i[command_options option]
       return if allowed.empty? || (allowed & @except).any?
 
-      self.class.extend_options(command_class)
+      self.class.extend_options(@command_class)
     end
 
-    def extend_predefined_options(command_class)
+    def extend_predefined_options
       allowed = @only & %i[predefined_options use_option]
       return if allowed.empty? || (allowed & @except).any?
 
-      self.class.extend_predefined_options(command_class)
+      self.class.extend_predefined_options(@command_class)
     end
 
     def extend_before_print(data)
       allowed = @only & %i[before_print data]
       return if allowed.empty? || (allowed & @except).any?
 
-      self.class.extend_before_print(data)
+      self.class.extend_before_print(data, @command_object, @command_class)
     end
 
-    def extend_output(command_class)
+    def extend_output
       allowed = @only & %i[output]
       return if allowed.empty? || (allowed & @except).any?
 
-      self.class.extend_output(command_class)
+      self.class.extend_output(@command_class, @command_object)
     end
 
-    def extend_help(command_class)
+    def extend_help
       allowed = @only & %i[help]
       return if allowed.empty? || (allowed & @except).any?
 
-      self.class.extend_help(command_class)
+      self.class.extend_help(@command_class)
     end
 
     def extend_request_headers(headers)
       allowed = @only & %i[request_headers headers request]
       return if allowed.empty? || (allowed & @except).any?
 
-      self.class.extend_request_headers(headers)
+      self.class.extend_request_headers(headers, @command_object, @command_class)
     end
 
     def extend_request_options(options)
       allowed = @only & %i[request_options options request]
       return if allowed.empty? || (allowed & @except).any?
 
-      self.class.extend_request_options(options)
+      self.class.extend_request_options(options, @command_object, @command_class)
     end
 
     def extend_request_params(params)
       allowed = @only & %i[request_params params request]
       return if allowed.empty? || (allowed & @except).any?
 
-      self.class.extend_request_params(params)
+      self.class.extend_request_params(params, @command_object, @command_class)
     end
 
-    def extend_option_sources(sources, command = nil)
+    def extend_option_sources(sources)
       allowed = @only & %i[option_sources]
       return if allowed.empty? || (allowed & @except).any?
 
-      self.class.extend_option_sources(sources, command)
+      self.class.extend_option_sources(sources, @command_object, @command_class)
     end
 
-    def extend_option_family(command_class)
+    def extend_option_family
       allowed = @only & %i[option_family]
       return if allowed.empty? || (allowed & @except).any?
 
-      self.class.extend_option_family(command_class)
+      self.class.extend_option_family(@command_class)
     end
 
     def delegatee(command_class)
       self.class.delegatee = command_class
     end
 
+    def command_class(command_class)
+      @command_class = command_class
+    end
+
+    def command_object(command_object)
+      @command_object = command_object
+    end
+
     def details
       except = @except.empty? ? '*nothing*' : @except
       details = if @only == ALLOWED_EXTENSIONS
@@ -198,17 +206,17 @@ module HammerCLI
       logger.debug("Added predefined options for #{command_class}: #{@predefined_option_names}")
     end
 
-    def self.extend_before_print(data)
+    def self.extend_before_print(data, command_object, command_class)
       return if @before_print_block.nil?
 
-      @before_print_block.call(data)
+      @before_print_block.call(data, command_object, command_class)
       logger.debug("Called block for #{@delegatee} data:\n\t#{@before_print_block}")
     end
 
-    def self.extend_output(command_class)
+    def self.extend_output(command_class, command_object)
       return if @output_extension_block.nil?
 
-      @output_extension_block.call(command_class.output_definition)
+      @output_extension_block.call(command_class.output_definition, command_object, command_class)
       logger.debug("Called block for #{@delegatee} output definition:\n\t#{@output_extension_block}")
     end
 
@@ -219,31 +227,31 @@ module HammerCLI
       logger.debug("Saved block for #{@delegatee} help definition:\n\t#{@help_extension_block}")
     end
 
-    def self.extend_request_headers(headers)
+    def self.extend_request_headers(headers, command_object, command_class)
       return if @request_headers_block.nil?
 
-      @request_headers_block.call(headers)
+      @request_headers_block.call(headers, command_object, command_class)
       logger.debug("Called block for #{@delegatee} request headers:\n\t#{@request_headers_block}")
     end
 
-    def self.extend_request_options(options)
+    def self.extend_request_options(options, command_object, command_class)
       return if @request_options_block.nil?
 
-      @request_options_block.call(options)
+      @request_options_block.call(options, command_object, command_class)
       logger.debug("Called block for #{@delegatee} request options:\n\t#{@request_options_block}")
     end
 
-    def self.extend_request_params(params)
+    def self.extend_request_params(params, command_object, command_class)
       return if @request_params_block.nil?
 
-      @request_params_block.call(params)
+      @request_params_block.call(params, command_object, command_class)
       logger.debug("Called block for #{@delegatee} request params:\n\t#{@request_params_block}")
     end
 
-    def self.extend_option_sources(sources, command = nil)
+    def self.extend_option_sources(sources, command_object, command_class)
       return if @option_sources_block.nil?
 
-      @option_sources_block.call(sources, command)
+      @option_sources_block.call(sources, command_object, command_class)
       logger.debug("Called block for #{@delegatee} option sources:\n\t#{@option_sources_block}")
     end
 

data/lib/hammer_cli/output/definition.rb

@@ -73,7 +73,7 @@ module HammerCLI::Output
 
         data << sets.each_with_object({}) do |set, res|
           mark = field.sets.include?(set) ? 'x' : ''
-          value = set == sets.first ? field.full_label : mark
+          value = set == sets.first ? field.full_label.capitalize : mark
           res.update(set => value)
         end
       end

data/lib/hammer_cli/output/field_filter.rb

@@ -66,7 +66,7 @@ module HammerCLI::Output
 
     def include_by_label?(labels, label)
       labels.any? do |l|
-        l.start_with?("#{label}/") || label.match(%r{^#{l.gsub(/\*/, '.*')}(|\/.*)$})
+        l.start_with?("#{label}/") || label.match(%r{^#{l.gsub(/\*/, '.*')}(|\/.*)$}) || l == label
       end
     end
 

data/lib/hammer_cli/version.rb

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

data/test/unit/output/definition_test.rb

@@ -269,9 +269,9 @@ describe HammerCLI::Output::Definition do
       sets_table = "---------|-----|---------|----\n" \
                    "FIELDS   | ALL | DEFAULT | SET\n" \
                    "---------|-----|---------|----\n" \
-                   "newfield | x   | x       |    \n" \
-                   "cf/abc   |     |         | x  \n" \
-                   "cf/bca   |     |         | x  \n" \
+                   "Newfield | x   | x       |    \n" \
+                   "Cf/abc   |     |         | x  \n" \
+                   "Cf/bca   |     |         | x  \n" \
                    "---------|-----|---------|----\n"
 
       definition.sets_table.must_equal sets_table

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hammer_cli
 version: !ruby/object:Gem::Version
-  version: 2.5.0
+  version: 2.5.1
 platform: ruby
 authors:
 - Martin Bačovský
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-04 00:00:00.000000000 Z
+date: 2021-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: clamp
@@ -154,28 +154,28 @@ extensions: []
 extra_rdoc_files:
 - 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/hammer.completion
 - config/cli_config.template.yml
+- config/hammer.completion
 - 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.0.8
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Universal command-line interface
@@ -404,13 +404,15 @@ 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
@@ -424,6 +426,7 @@ 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
@@ -431,7 +434,6 @@ 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
@@ -443,11 +445,11 @@ 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
@@ -464,5 +466,3 @@ test_files:
 - 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