hammer_cli 3.13.0 → 3.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a2103a3d5f699dc9f9cf3b64eb5c3260cc2e957541c4398b37575ac7477a2e09
-  data.tar.gz: dc19532200b475062bf5b6d4350fc4156f27280fa43bdefb34cce314388c0280
+  metadata.gz: 682498506056a4d18876c29924250c7050dbc143878fcf03d8bec72140dcfdb4
+  data.tar.gz: 4c135d71447e67d75bf6b763d90fcc5b30e41f360683f4205066862854cc3fe3
 SHA512:
-  metadata.gz: de4a2168586c87cd4526b36ee39f3cd7a4d634457f96f9c5643c76dc512784a3b9c7f2bce7a343ae16fac74597c68969ea6aa2d1f536dce11ba89f6943d4bf2b
-  data.tar.gz: a2bd15bcf78b0304fa12f8d0667d5389bc8752071681e593480eeab96c7fd4e7442d29386ae1884129944cd770bc34c1f7ea138d95e2a78e066b087a86a5c699
+  metadata.gz: 1451af2336736479bd7a630b1717d42a3563ae8e24261a778e705417e060d18c286c2524e696f723b46059e5e4077ac5b5fb5e16f445f6297a2b87db0dcdb0b1
+  data.tar.gz: '0937139414c830add628ce0042ec4575a4972ab9e0d860babac4ef3d3c2976e53f5819464bc8e1e8e781a5cf8c5c93d45d01fde3f810645f5f135c60e9f90a76'

data/doc/release_notes.md

@@ -1,5 +1,15 @@
 Release notes
 =============
+### 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/version.rb

@@ -1,5 +1,5 @@
 module HammerCLI
   def self.version
-    @version ||= Gem::Version.new "3.13.0"
+    @version ||= Gem::Version.new "3.14.0"
   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
                                     }
                                 ]
                             }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hammer_cli
 version: !ruby/object:Gem::Version
-  version: 3.13.0
+  version: 3.14.0
 platform: ruby
 authors:
 - Martin Bačovský
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-08 00:00:00.000000000 Z
+date: 2025-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: clamp
@@ -121,14 +121,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: 0.7.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: 0.7.0
 description: 'Hammer cli provides universal extendable CLI interface for ruby apps
 
   '
@@ -367,7 +367,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: []