hammer_cli 3.13.0 → 3.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a2103a3d5f699dc9f9cf3b64eb5c3260cc2e957541c4398b37575ac7477a2e09
-  data.tar.gz: dc19532200b475062bf5b6d4350fc4156f27280fa43bdefb34cce314388c0280
+  metadata.gz: e59588fd8f86b76aee78fc150ea938650b2f5df37c6dba8e53be5d44a1117f8f
+  data.tar.gz: f5d84d4062dc8c9a8db3856b1e6569980c86597ae4b7d96a439c0128b832365a
 SHA512:
-  metadata.gz: de4a2168586c87cd4526b36ee39f3cd7a4d634457f96f9c5643c76dc512784a3b9c7f2bce7a343ae16fac74597c68969ea6aa2d1f536dce11ba89f6943d4bf2b
-  data.tar.gz: a2bd15bcf78b0304fa12f8d0667d5389bc8752071681e593480eeab96c7fd4e7442d29386ae1884129944cd770bc34c1f7ea138d95e2a78e066b087a86a5c699
+  metadata.gz: 332b4e7295ee014cbf01f7abf00f41a11a67291955ac118814a832c1cd169a9e53b60cb618385a50399488311837c8c3bce78234986d3a3487107e6d9f14af0b
+  data.tar.gz: 7aceb50f62e7ede2ab787e89af97cf49375175c054fa301a74602506529ea7d9f4f311df4a60513fd47894c3b9e03768de04e0ba49220020cf59c9bb20c0900f

data/doc/creating_commands.md

@@ -755,6 +755,35 @@ def adapter
 end
 ```
 
+#### Deprecating fields
+To deprecate a field, add `:deprecated => true` as an option for the field. This will print a warning message to stderr whenever the field is displayed. Consider removing this field from the default set so it is not displayed without a `--fields` param:
+
+```
+field :dep_fld, _("Deprecated field"), Fields::Field, :sets => ['ALL'], :deprecated => true
+```
+
+Example output:
+
+```
+$ hammer foo info --fields "Deprecated field"
+Warning: Field 'Deprecated field' is deprecated and may be removed in future versions.
+Deprecated field: bar
+```
+
+Additionally, a field may be 'replaced by' another field using `:replaced_by => "Path/To/New/Field"`. This will mark the field as deprecated and print a similar warning message to stderr whenever the field is displayed:
+
+```
+field :rep_fld, _("Replaced field"), Fields::Field, :sets => ['ALL'], :replaced_by => "Path/New field"
+```
+
+Example output:
+
+```
+$ hammer foo info --fields "Replaced field"
+Warning: Field 'Replaced field' is deprecated. Consider using 'Path/New field' instead.
+Replaced field: bar
+```
+
 #### Verbosity
 Currently Hammer [defines](https://github.com/theforeman/hammer-cli/blob/master/lib/hammer_cli/verbosity.rb) three basic verbose modes:
   * __QUIET__ - Prints nothing

data/doc/release_notes.md

@@ -1,5 +1,24 @@
 Release notes
 =============
+### 3.15.0 (2025-05-14)
+* Translate warning message ([PR #396](https://github.com/theforeman/hammer-cli/pull/396)), [#38410](http://projects.theforeman.org/issues/38410)
+* Add mechanism for deprecating displayed fields ([PR #395](https://github.com/theforeman/hammer-cli/pull/395)), [#38410](http://projects.theforeman.org/issues/38410)
+* Fix test using #inspect on a hash
+* Add base64 and csv dependencies for ruby 3.4 compatibility
+* Fix gemspec/ordereddependencies cop
+* Use actions/checkout@v4
+* Bump to 3.15.0-develop
+
+### 3.14.0 (2025-02-20)
+* Check better for parent option desc injection, [#38126](http://projects.theforeman.org/issues/38126)
+* Bump apipie-bindings to 0.7.0
+* Don't build hidden params as options ([PR #390](https://github.com/theforeman/hammer-cli/pull/390)), [#38077](http://projects.theforeman.org/issues/38077)
+* Use master branch of apipie-bindings in ci
+* Drop el 8 from packit config
+* Use non-deprecated gpl-3.0-only license tag
+* Pin ffi to < 1.17 for ruby 2.7 ([PR #387](https://github.com/theforeman/hammer-cli/pull/387))
+* Bump to 3.14.0-develop
+
 ### 3.13.0 (2024-11-08)
 * Bump to 3.13.0-develop
 

data/lib/hammer_cli/apipie/option_builder.rb

@@ -30,6 +30,7 @@ module HammerCLI::Apipie
     def options_for_params(params, filter, resource_name_map, opts = {})
       options = []
       params.each do |p|
+        next unless p.show?
         exists = opts[:command].find_option(option_switch(p, resource_name_map))
         next if filter.include?(p.name) || filter.include?(p.name.to_sym) || exists
 
@@ -85,6 +86,7 @@ module HammerCLI::Apipie
       opts[:attribute_name] = HammerCLI.option_accessor_name(param.name)
       opts[:referenced_resource] = resource_name(param)
       opts[:aliased_resource] = aliased_name(resource_name(param), resource_name_map)
+      opts[:show] = param.show?
 
       return opts
     end

data/lib/hammer_cli/options/option_definition.rb

@@ -30,6 +30,8 @@ module HammerCLI
         @context_target = options[:context_target]
         @deprecated_switches = options[:deprecated]
         @family = options[:family]
+        # We expect a value from API param docs, but in case it's not there, we want to show it in help by default
+        @show = options.fetch(:show, true)
         super
       end
 
@@ -153,6 +155,10 @@ module HammerCLI
         @family.children.include?(self)
       end
 
+      def show?
+        @show
+      end
+
       private
 
       def format_deprecation_msg(option_desc, deprecation_msg)

data/lib/hammer_cli/options/option_family.rb

@@ -27,7 +27,7 @@ module HammerCLI
       def description
         types = all.map(&:type).map { |s| s.split('_').last.to_s }
                    .map(&:downcase).join('/')
-        parent_desc = @parent.help[1].gsub(IDS_REGEX) { |w| w.gsub(/\b.+\b/, types) }
+        parent_desc = @parent.help[1].gsub(IDS_REGEX) { |w| types.include?(w.strip.downcase) ? w.gsub(/\b.+\b/, types) : w }
         desc = @options[:description] || parent_desc.strip.empty? ? @options[:description] : parent_desc
         if @options[:deprecation].class <= String
           format_deprecation_msg(desc, _('Deprecated: %{deprecated_msg}') % { deprecated_msg: @options[:deprecation] })

data/lib/hammer_cli/output/adapter/base.rb

@@ -42,6 +42,12 @@ module HammerCLI::Output::Adapter
     end
 
     def render_field(field, data, label_width)
+      if field.replaced_by
+        warn _("Warning: Field '%{field}' is deprecated. Consider using '%{replacement}' instead.") % { field: field.full_label, replacement: field.replaced_by }
+      elsif field.deprecated
+        warn _("Warning: Field '%{field}' is deprecated and may be removed in future versions.") % { field: field.full_label }
+      end
+
       if field.is_a? Fields::ContainerField
         output = ""
 

data/lib/hammer_cli/output/fields.rb

@@ -4,7 +4,7 @@ module Fields
   class Field
     attr_reader :path
     attr_writer :sets
-    attr_accessor :label, :parent
+    attr_accessor :label, :parent, :replaced_by, :deprecated
 
     def initialize(options={})
       @hide_blank = options[:hide_blank].nil? ? false : options[:hide_blank]
@@ -12,6 +12,8 @@ module Fields
       @path = options[:path] || []
       @label = options[:label]
       @sets = options[:sets]
+      @replaced_by = options[:replaced_by]
+      @deprecated = (options[:deprecated].nil?) ? !@replaced_by.nil? : options[:deprecated]
       @options = options
     end
 

data/lib/hammer_cli/version.rb

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

data/test/unit/abstract_test.rb

@@ -185,7 +185,7 @@ describe HammerCLI::AbstractCommand do
       test_command_class.option(['--password'], 'PASSWORD', 'Password')
       test_command = test_command_class.new("")
       test_command.run ['--password=pass']
-      _(@log_output.readline.strip).must_equal "INFO  HammerCLI::AbstractCommand : Called with options: {\"option_password\"=>\"***\"}"
+      _(@log_output.readline.strip).must_match(%r{INFO  HammerCLI::AbstractCommand : Called with options: {\"option_password\"\s*=>\s*\"\*\*\*\"}})
     end
   end
 

data/test/unit/apipie/option_builder_test.rb

@@ -178,4 +178,14 @@ describe HammerCLI::Apipie::OptionBuilder do
     end
   end
 
+  context "hidden parameters" do
+    let(:action) { resource.action(:create) }
+
+    it "should skip options for params with show? false" do
+      option_switches = options.map(&:long_switch)
+      refute_includes(option_switches, "--hidden")
+      refute_includes(option_switches, "--documented-scope")
+    end
+  end
+
 end

data/test/unit/fixtures/apipie/documented.json

@@ -75,6 +75,16 @@
                         "examples": [],
                         "errors": [],
                         "params": [
+                            {
+                                "allow_null": false,
+                                "name": "documented_scope",
+                                "full_name": "documented_scope",
+                                "validator": "Must be String",
+                                "description": "",
+                                "expected_type": "string",
+                                "required": false,
+                                "show": false
+                            },
                             {
                                 "allow_null": false,
                                 "name": "documented",
@@ -110,6 +120,16 @@
                                         "expected_type": "array",
                                         "description": "",
                                         "required": true
+                                    },
+                                    {
+                                        "name": "hidden",
+                                        "allow_null": false,
+                                        "full_name": "documented[hidden]",
+                                        "validator": "Must be number",
+                                        "expected_type": "number",
+                                        "description": "",
+                                        "required": false,
+                                        "show": false
                                     }
                                 ]
                             }

data/test/unit/output/adapter/base_test.rb

@@ -28,6 +28,9 @@ describe HammerCLI::Output::Adapter::Base do
     let(:blank)             { Fields::Field.new(:path => [:blank], :label => "Blank", :hide_blank => true) }
     let(:login)             { Fields::Field.new(:path => [:login], :label => "Login") }
     let(:missing)           { Fields::Field.new(:path => [:login], :label => "Missing", :hide_missing => false) }
+    let (:deprecated_a) { Fields::Field.new(:path => [:deprecated_a], :label => "Deprecated", :deprecated => true) }
+    let (:new_field) { Fields::Field.new(:path => [:new_field], :label => "New field") }
+    let (:deprecated_b) { Fields::Field.new(:path => [:deprecated_b], :label => "Replaced by", :replaced_by => 'New field') }
 
     let(:data) { HammerCLI::Output::RecordCollection.new [{
       :id => 112,
@@ -55,7 +58,10 @@ describe HammerCLI::Output::Adapter::Base do
           :name => 'size',
           :value => '32'
         }
-      ]
+      ],
+      deprecated_a: 'deprecated_a',
+      deprecated_b: 'deprecated_b',
+      new_field: 'new_field'
     }]}
 
     it "should print one field" do
@@ -199,6 +205,31 @@ describe HammerCLI::Output::Adapter::Base do
       _{ adapter.print_collection(fields, data) }.must_output(expected_output)
     end
 
+    it "should warn about deprecated fields" do
+      fields = [deprecated_a]
+
+      expected_stdout= [
+        "Deprecated: deprecated_a",
+        "\n"
+      ].join("\n")
+      expected_stderr = "Warning: Field 'Deprecated' is deprecated and may be removed in future versions.\n"
+
+      _{ adapter.print_collection(fields, data) }.must_output(stdout=expected_stdout, stderr=expected_stderr)
+    end
+
+    it "should warn about replaced fields" do
+      fields = [new_field, deprecated_b]
+
+      expected_stdout= [
+        "New field:   new_field",
+        "Replaced by: deprecated_b",
+        "\n"
+      ].join("\n")
+      expected_stderr = "Warning: Field 'Replaced by' is deprecated. Consider using 'New field' instead.\n"
+
+      _{ adapter.print_collection(fields, data) }.must_output(stdout=expected_stdout, stderr=expected_stderr)
+    end
+
     context 'printing by chunks' do
       let(:context) { { show_ids: true } }
       let(:collection_count) { 30 }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hammer_cli
 version: !ruby/object:Gem::Version
-  version: 3.13.0
+  version: 3.15.0
 platform: ruby
 authors:
 - Martin Bačovský
@@ -9,30 +9,38 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-08 00:00:00.000000000 Z
+date: 2025-05-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: clamp
+  name: amazing_print
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.3.1
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.3.1
-    - - "<"
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: apipie-bindings
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 0.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.7.0
 - !ruby/object:Gem::Dependency
-  name: logging
+  name: base64
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -46,21 +54,27 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: unicode-display_width
+  name: clamp
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.3.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.3.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
-  name: amazing_print
+  name: csv
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -74,7 +88,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: highline
+  name: fast_gettext
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -88,7 +102,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: fast_gettext
+  name: highline
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -116,19 +130,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 2.0.6
 - !ruby/object:Gem::Dependency
-  name: apipie-bindings
+  name: logging
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: unicode-display_width
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 'Hammer cli provides universal extendable CLI interface for ruby apps
 
   '
@@ -367,7 +395,7 @@ files:
 - test/unit/utils_test.rb
 homepage: https://github.com/theforeman/hammer-cli
 licenses:
-- GPL-3.0
+- GPL-3.0-only
 metadata: {}
 post_install_message:
 rdoc_options: []