ofedoren · ofedoren · May 8, 2021 · May 8, 2021 · May 24, 2021 · May 26, 2021
diff --git a/.github/workflows/unit_tests.yaml b/.github/workflows/unit_tests.yaml
@@ -0,0 +1,34 @@
+name: Run tests GA
+
+on:
+  - push
+  - pull_request
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: hammer-cli
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby:
+          - '2.7'
+          - '3.0'
+          - '3.1'
+
+    steps:
+      - name: Get hammer-cli
+        uses: actions/checkout@v2
+        with:
+          path: hammer-cli
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+          working-directory: hammer-cli
+      - name: Run tests
+        run: |
+          bundle exec rake test
diff --git a/.packit.yaml b/.packit.yaml
@@ -0,0 +1,44 @@
+# See the documentation for more information:
+# https://packit.dev/docs/configuration/
+
+specfile_path: rubygem-hammer_cli.spec
+
+# add or remove files that should be synced
+files_to_sync:
+    - rubygem-hammer_cli.spec
+    - .packit.yaml
+
+# name in upstream package repository or registry (e.g. in PyPI)
+upstream_package_name: hammer_cli
+# downstream (Fedora) RPM package name
+downstream_package_name: rubygem-hammer_cli
+
+actions:
+  post-upstream-clone:
+    - "wget https://raw.githubusercontent.com/theforeman/foreman-packaging/rpm/develop/packages/foreman/rubygem-hammer_cli/rubygem-hammer_cli.spec -O rubygem-hammer_cli.spec"
+    - "a2x -d manpage -f manpage -D man/ man/hammer.1.asciidoc"
+    - "gzip -f9 man/hammer.1"
+    - "sed -i '/^%global prereleasesource pre.develop$/d' rubygem-hammer_cli.spec"
+    - "sed -i '/^%global prerelease %{?prereleasesource:.}%{?prereleasesource}$/d' rubygem-hammer_cli.spec"
+  get-current-version:
+    - ruby -rrubygems -e 'puts Gem::Specification::load(Dir.glob("*.gemspec").first).version'
+  create-archive:
+    - gem build hammer_cli.gemspec
+    - bash -c "ls -1t ./hammer_cli-*.gem | head -n 1"
+
+jobs:
+  - job: copr_build
+    trigger: pull_request
+    targets:
+      centos-stream-8:
+        additional_modules: "foreman-devel:el8"
+        additional_repos:
+          - https://yum.theforeman.org/releases/nightly/el8/x86_64/
+          - https://yum.theforeman.org/plugins/nightly/el8/x86_64/
+    module_hotfixes: true
+
+srpm_build_deps:
+  - wget
+  - asciidoc
+  - gzip
+  - rubygems
diff --git a/.tx/config b/.tx/config
@@ -1,8 +1,9 @@
 [main]
-host = https://www.transifex.com
+host = https://app.transifex.com
 
-[foreman.hammer-cli]
+[o:foreman:p:foreman:r:hammer-cli]
 file_filter = locale/<lang>/hammer-cli.edit.po
 source_file = locale/hammer-cli.pot
 source_lang = en
 type = PO
+resource_name = hammer-cli
diff --git a/Gemfile b/Gemfile
@@ -5,13 +5,13 @@ gemspec
 gem 'gettext', '>= 3.1.3', '< 4.0.0'
 
 group :test do
-  gem 'rake', '~> 10.1.0'
+  gem 'rake'
   gem 'thor'
-  gem 'minitest', '4.7.4'
+  gem 'minitest', '~> 5.18'
   gem 'minitest-spec-context'
   gem 'simplecov'
   gem 'mocha'
-  gem 'ci_reporter', '>= 1.6.3', "< 2.0.0", :require => false
+  gem 'ci_reporter_minitest', '~> 1.0', :require => false
 end
 
 # load local gemfile

diff --git a/Rakefile b/Rakefile
@@ -11,6 +11,7 @@ Rake::TestTask.new do |t|
   t.libs.push "lib"
   t.test_files = Dir.glob('test/**/*_test.rb')
   t.verbose = true
+  t.warning = ENV.key?('RUBY_WARNINGS')
 end
 
 file "man/hammer.1.gz" => "man/hammer.1.asciidoc" do |t|

diff --git a/bin/hammer b/bin/hammer
@@ -1,4 +1,4 @@
-#! /usr/bin/env ruby
+#!/usr/bin/env ruby
 
 require 'rubygems'
 require 'clamp'
@@ -56,12 +56,7 @@ end
 # load user's settings
 require 'hammer_cli/settings'
 
-CFG_PATH = ['~/.hammer/', '/etc/hammer/', "#{::RbConfig::CONFIG['sysconfdir']}/hammer/"].uniq
-HammerCLI::Settings.load_from_paths CFG_PATH
-
-CFG_PATH_LOCAL = ['./config/']
-
-HammerCLI::Settings.load_from_paths CFG_PATH_LOCAL
+HammerCLI::Settings.load_from_defaults
 
 if preparser.config
   if File.file? preparser.config

diff --git a/config/cli_config.template.yml b/config/cli_config.template.yml
@@ -7,7 +7,7 @@
   # Location of shell history file
   :history_file: '~/.hammer/history'
   # Mark translated strings with X characters (for developers)
-  #:mark_translated: false
+  # :mark_translated: false
   # Hide headers from output of list actions
   # :no_headers: true
   # Choose capitalization for JSON/YAML output.
@@ -17,7 +17,7 @@
 # Enable/disable color output of logger in Clamp commands
 :watch_plain: false
 
-# Forece relaod of Apipie cache with every Hammer invocation
+# Force reload of Apipie cache with every Hammer invocation
 :reload_cache: false
 
 # Directory where the logs are stored. The default is /var/log/hammer/ and the log file is named hammer.log
@@ -75,5 +75,5 @@
   # Certs from the local storage are used only when neither :ssl_ca_file: nor :ssl_ca_path: is cofigured.
   #:local_ca_store_path: '~/.hammer/certs'
 
- # Allows setting the SSL version to use when making API calls
+  # Allows setting the SSL version to use when making API calls
   #:ssl_version: 'TLSv1_2'
diff --git a/doc/commands_extension.md b/doc/commands_extension.md
@@ -16,31 +16,31 @@ 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
     help do |h|
       # 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

diff --git a/doc/creating_commands.md b/doc/creating_commands.md
@@ -190,6 +190,23 @@ To define an option family, use the following DSL:
   end
 ```
 
+You can also add additional options for automatically built ones:
+```ruby
+  # ...
+  build_options
+  # If --resource-id option comes from the API params and you want to add options
+  # with searchables such as --resource-name, --resource-label
+  option_family(associate: 'resource') do
+    child '--resource-name', 'RESOURCE', _('Resource desc'), attribute_name: :option_resource_name
+    child '--resource-label', 'RESOURCE', _('Resource desc'), attribute_name: :option_resource_label
+  end
+  # $ hammer command --help:
+  # ...
+  #  Options:
+  #    --resource[-id|-name|-label]               Resource desc
+  # ...
+```
+
 ##### Example
 
 ```ruby

diff --git a/doc/release_notes.md b/doc/release_notes.md
@@ -1,5 +1,80 @@
 Release notes
 =============
+### 3.9.0 (2023-11-29)
+* Use strings for ruby versions in gha ([PR #380](https://github.com/theforeman/hammer-cli/pull/380))
+* Update packit
+* Update rel-eng
+* Bump to 3.9.0-develop
+
+### 3.8.0 (2023-08-25)
+* Consider false values in string#format, [#36588](http://projects.theforeman.org/issues/36588)
+* Drop unicode gem ([PR #376](https://github.com/theforeman/hammer-cli/pull/376))
+* Improve regex for keyvaluelist normalizer, [#36258](http://projects.theforeman.org/issues/36258)
+* Fix minitest ([PR #375](https://github.com/theforeman/hammer-cli/pull/375))
+* Add ga to run tests on ruby 3+
+* Wrap commands with class.new to clone, [#36592](http://projects.theforeman.org/issues/36592)
+* Try to upgrade ci_reporter, [#36592](http://projects.theforeman.org/issues/36592)
+* Update minitest version, [#36592](http://projects.theforeman.org/issues/36592)
+* Improve rakefile tx commands, [#36283](http://projects.theforeman.org/issues/36283)
+* Move makefile targets to rakefile, [#36283](http://projects.theforeman.org/issues/36283)
+* Update transifex automation, [#36283](http://projects.theforeman.org/issues/36283)
+* Add packit config ([PR #370](https://github.com/theforeman/hammer-cli/pull/370))
+* Bump to 3.8.0-develop
+
+### 3.7.0 (2023-05-23)
+* Honor tz in datetime normalizer ([PR #369](https://github.com/theforeman/hammer-cli/pull/369)), [#36418](http://projects.theforeman.org/issues/36418)
+* Remove unused code, [#36337](http://projects.theforeman.org/issues/36337)
+* Fix ambiguous operator warnings, [#36337](http://projects.theforeman.org/issues/36337)
+* Update rake and clamp deps, [#36337](http://projects.theforeman.org/issues/36337)
+* Fix config template typos ([PR #365](https://github.com/theforeman/hammer-cli/pull/365))
+* Load ssl key using openssl::pkey.read ([PR #364](https://github.com/theforeman/hammer-cli/pull/364)), [#34853](http://projects.theforeman.org/issues/34853)
+* Bump to 3.7.0-develop
+
+### 3.6.0 (2023-02-23)
+* Update apipie-bindings to 0.6.0
+* Include makefile.def in the gem
+* Correct mocha inclusion in tests
+* Bump to 3.6.0-develop
+
+### 3.5.0 (2022-10-31)
+* Bump to 3.5.0-develop
+
+### 3.4.0 (2022-08-09)
+* Bump to 3.4.0-develop
+
+### 3.3.0 (2022-05-10)
+* Fix hammer shell with pipe as stdin ([PR #360](https://github.com/theforeman/hammer-cli/pull/360)), [#34724](http://projects.theforeman.org/issues/34724)
+* Bump to 3.3.0-develop
+
+### 3.2.0 (2022-02-10)
+* Fix fr translation ([PR #358](https://github.com/theforeman/hammer-cli/pull/358)), [#34204](http://projects.theforeman.org/issues/34204)
+* Add missing_args_error_result test helper ([PR #357](https://github.com/theforeman/hammer-cli/pull/357))
+* Allow explicit strings in key=value options ([PR #356](https://github.com/theforeman/hammer-cli/pull/356)), [#34079](http://projects.theforeman.org/issues/34079)
+* Bump to 3.2.0-develop
+
+### 3.1.0 (2021-11-10)
+* Remove a space in hammer's shebang, [#33810](http://projects.theforeman.org/issues/33810)
+* Revert fix rake version
+* Fix rake version
+* Wrap option descriptions to 80 chars, [#33129](http://projects.theforeman.org/issues/33129)
+* Don't store @context in field params, [#33259](http://projects.theforeman.org/issues/33259)
+* Change from superficial copy to deep copy of fields ([PR #348](https://github.com/theforeman/hammer-cli/pull/348)), [#29093](http://projects.theforeman.org/issues/29093)
+* Make api docs params to be the main options, [#33226](http://projects.theforeman.org/issues/33226)
+* Show depr warning only on option usage, [#33225](http://projects.theforeman.org/issues/33225)
+* Extract descs to option details section, [#32783](http://projects.theforeman.org/issues/32783)
+* Bump to 3.1.0-develop
+
+### 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

diff --git a/hammer_cli.gemspec b/hammer_cli.gemspec
@@ -20,21 +20,22 @@ EOF
   locales = Dir['locale/*'].select { |f| File.directory?(f) }
   s.files = Dir['{lib,test,bin,doc,config}/**/*', 'LICENSE', 'README*'] +
     locales.map { |loc| "#{loc}/LC_MESSAGES/hammer-cli.mo" } +
-    ['man/hammer.1.gz']
+    ['locale/Makefile.def', 'man/hammer.1.gz']
 
   s.test_files       = Dir['test/**/*']
   s.extra_rdoc_files = Dir['{doc,config}/**/*', 'README*']
   s.require_paths = ["lib"]
   s.executables = ['hammer', 'hammer-complete']
 
-  s.add_dependency 'clamp', '>= 1.1', '< 1.2.0'
+  s.required_ruby_version = '>= 3.0'
+
+  s.add_dependency 'clamp', '>= 1.3.1', '< 2.0.0'
   s.add_dependency 'logging'
   s.add_dependency 'unicode-display_width'
-  s.add_dependency 'unicode'
   s.add_dependency 'amazing_print'
   s.add_dependency 'highline'
   s.add_dependency 'fast_gettext'
   s.add_dependency 'locale', '>= 2.0.6'
-  s.add_dependency 'apipie-bindings', '>= 0.2.0'
+  s.add_dependency 'apipie-bindings', '>= 0.6.0'
 
 end