hammer_cli 2.3.1 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dae98160a2f04eb29858cd97cc219ebc440dbe8db359cd4c5c742ef164fb3c7d
-  data.tar.gz: 3c062268d65695c331953183322e23e373ac1359bc3110a1f48aed8d93f818f9
+  metadata.gz: 18c588190de60119f107f523180928f0cff86e22f32330c37d22bd064ede6c36
+  data.tar.gz: aa66a052a8c90061366a64264eebe89bb28bf932e67307a455148115834c2615
 SHA512:
-  metadata.gz: d12884641c2450d7b9893f5b8db2d13ad27958aabfbd06e9d763d8f35eb86ba813290c73933c6a4cdbf456c32f38d82ff96247f048ad6db4fe4bbd4feb0f0ad1
-  data.tar.gz: 05c7c44cbc98c2e3a4e4e3419120e7bacdc9131f8b0ec086762afe655179ccb7985764042d53e03839358447d5d87bcf20025a5635e0804ac45ec5fc694c0c27
+  metadata.gz: 59e1fb24c0996dcd6c01621a93ca0ffeb99adc2cb46a56c43f8ee5ed2baa0f9d63b25cb5626f7016d2016e3267ea6614be216cd93990dfac034d5440119e5c0c
+  data.tar.gz: 24dcde8e10be473f115f3954ac203e035fb69a5dc847086d6ad64a8f125ae38dbeb44a8332ef73a61225d046c4ac3fba09b8a1ffb63d5c4bb04ab69c5de55366

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/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/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/release_notes.md

@@ -1,14 +1,25 @@
 Release notes
 =============
-### 2.3.1 (2021-05-04)
+### 3.0.0 (2021-08-04)
+* Update rel-eng notebook ([PR #347](https://github.com/theforeman/hammer-cli/pull/347))
+* Bump version to 3.0-develop
+* Revert "change from superficial copy to deep copy of fields", [#29093](http://projects.theforeman.org/issues/29093)
+* Change from superficial copy to deep copy of fields, [#29093](http://projects.theforeman.org/issues/29093)
+* 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)
+* Bump to 2.6.0-develop
+
+### 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.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.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)

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/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/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/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/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, fuzzy: false)
+      subcommand = parent_command.find_subcommand(bit)
       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.3.1"
+    @version ||= Gem::Version.new "3.0.0"
   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.3.1
+  version: 3.0.0
 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-08-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_modification.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/installation_gem.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/creating_commands.md
 - doc/release_notes.md
+- doc/commands_extension.md
+- doc/commands_modification.md
+- doc/developer_docs.md
+- doc/help_modification.md
+- doc/installation.md
+- doc/installation_rpm.md
+- doc/output.md
+- doc/review_checklist.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,18 +404,16 @@ test_files:
 - 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/apipie/test_helper.rb
+- test/unit/apipie/api_connection_test.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/exception_handler_test.rb
 - test/unit/fixtures/apipie/architectures.json
 - test/unit/fixtures/apipie/documented.json
 - test/unit/fixtures/certs/ca_cert.pem
@@ -425,9 +423,9 @@ test_files:
 - 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/section_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/text_builder_test.rb
@@ -440,13 +438,13 @@ test_files:
 - 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/normalizers_test.rb
 - test/unit/options/option_family_test.rb
 - test/unit/output/adapter/abstract_test.rb
 - test/unit/output/adapter/base_test.rb
@@ -455,14 +453,16 @@ test_files:
 - 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/output/field_filter_test.rb
+- test/unit/output/formatters_test.rb
+- test/unit/output/output_test.rb
 - test/unit/settings_test.rb
 - test/unit/test_helper.rb
 - test/unit/utils_test.rb
 - test/unit/abstract_test.rb
+- test/unit/bash_test.rb
+- test/unit/exception_handler_test.rb
 - test/unit/command_extensions_test.rb