hammer_cli 3.7.0 → 3.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5c8ba63d251f23a5e6005d7adcab02b5045639060c1bd5a3a02741e6d5561945
-  data.tar.gz: b94fd6c3342e7c8b06efeb7dfe754f449cd0ce76b62cc7cafadf13031fbf2f94
+  metadata.gz: 9c1d1eca37ea41bee11e7826fbfc491b99bce78026eee0f3ae72acaa2b472503
+  data.tar.gz: f327b7901efa9824e5118ac7e20daa42835e8d01813be55e2db4001697249a39
 SHA512:
-  metadata.gz: 26dc0d7d6b439aa97d1e5a01f003cc8c817ad522baa874b6cb8fc145e03246fce952ef96e0def406c614b3b4246fb85b69d3a6c7e10090cf7f7c152c53657715
-  data.tar.gz: 8f64e1a44462aa152f2f5aeb5af69f05160978651eaa9a2ba327ea1ceb6f77fffdcef3a436d113a5877edb05a2d0781bb3bce1329b8bb559856ba3ef6e159a75
+  metadata.gz: e945cf3fb8671ec5089e45e4a75f47cd906c99b47124b5887b8b8ed627fb6a41145218fd07638b78208ac8e845342e9e4f7a2418b4c5b5f091eeaafc6a74d4a6
+  data.tar.gz: c56001b49b27c10ba388e84791b1b0794a5a7873a0320877cd0a73e393b1bd1da1b64b6e745d54bf618f0fda71f56c174cc4d74fa1128963b6a4895a97b70aa4

data/bin/hammer

@@ -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

data/doc/release_notes.md

@@ -1,5 +1,20 @@
 Release notes
 =============
+### 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)

data/lib/hammer_cli/help/builder.rb

@@ -1,4 +1,3 @@
-require 'unicode'
 module HammerCLI
   module Help
     class Builder < Clamp::Help::Builder
@@ -46,7 +45,7 @@ module HammerCLI
                                else
                                  item.help
                                end
-          description.gsub(/^(.)/) { Unicode.capitalize(Regexp.last_match(1)) }.wrap.each_line do |line|
+          description.gsub(/^(.)/) { Regexp.last_match(1).capitalize }.wrap.each_line do |line|
             line " %-#{label_width}s %s" % [label, line]
             label = ''
           end

data/lib/hammer_cli/i18n/find_task.rb

@@ -1,10 +1,13 @@
 require 'rake'
+require_relative '../task_helper'
 
 module HammerCLI
   module I18n
     class FindTask
       include Rake::DSL
 
+      MIN_TRANSLATION_PERC = 50
+
       def initialize(domain, version)
         @domain = domain
         @version = version
@@ -30,6 +33,91 @@ module HammerCLI
           task :find => [:setup] do
             Rake::Task["gettext:po:update"].invoke
           end
+
+          desc 'Check languages with 50% or more coverage and create needed files'
+          task :find_new do
+            client = HammerCLI::TaskHelper::I18n::TxApiClient.new(domain: @domain)
+            stats = client.language_stats_collection
+            lang_percentages = stats['data'].each_with_object({}) do |lang, res|
+              res[lang['id'].split(':').last] = (lang['attributes']['translated_strings'] * 100.0 / lang['attributes']['total_strings']).round
+            end
+            lang_percentages.select { |_, v| v >= MIN_TRANSLATION_PERC }.each_key do |lang|
+              lang_dir = File.join(@domain.locale_dir, lang)
+              FileUtils.mkpath(lang_dir)
+              FileUtils.cp(File.join(@domain.locale_dir, "#{@domain.domain_name}.pot"), File.join(lang_dir, "#{@domain.domain_name}.po"))
+            end
+          end
+        end
+
+        namespace :tx do
+          desc 'Pull translations from transifex'
+          task :pull do
+            raise 'Command tx not found. Make sure you have transifex-client installed and configured.' unless system("command -v tx >/dev/null 2>&1")
+
+            sh "tx pull -f"
+            edit_files = Dir.glob(File.join(@domain.locale_dir, '**', '*.edit.po'))
+            edit_files.each do |edit_file|
+              `sed -i 's/^\\("Project-Id-Version: \\).*$/\\1#{@domain.domain_name} #{@version}\\\\n"/' #{edit_file};`
+            end
+          end
+
+          desc 'Merge .edit.po into .po'
+          task :update_po do
+            edit_files = Dir.glob(File.join(@domain.locale_dir, '**', '*.edit.po'))
+            edit_files.each do |edit_file|
+              po_file = edit_file.gsub('.edit.po', '.po')
+              sh "msgcat --use-first --no-location #{edit_file} #{po_file} --output-file #{po_file}"
+            end
+          end
+
+          desc 'Generate MO files from PO files'
+          task :all_mo do
+            po_files = Dir.glob(File.join(@domain.locale_dir, '**', "#{@domain.domain_name}.po"))
+            po_files.each do |po_file|
+              dir = File.dirname(po_file) + '/LC_MESSAGES'
+              FileUtils.mkdir_p(dir)
+              sh "msgfmt -o #{dir}/#{@domain.domain_name}.mo #{po_file}"
+            end
+          end
+
+          desc 'Download and merge translations from Transifex'
+          task :update do
+            Rake::Task['gettext:find_new'].invoke
+            Rake::Task['gettext:find'].invoke
+            Rake::Task['tx:pull'].invoke
+            Rake::Task['tx:update_po'].invoke
+            Rake::Task['tx:all_mo'].invoke
+            locale_dir = File.expand_path(@domain.locale_dir, __dir__)
+            sh "git add #{locale_dir}"
+            sh 'git commit -m "i18n - extracting new, pulling from tx"'
+            puts 'Changes commited!'
+          end
+
+          desc 'Check for malformed strings'
+          task :check do
+            raise 'Command pofilter not found. Make sure you have translate-toolkit installed.' unless system("command -v pofilter >/dev/null 2>&1")
+
+            po_files = Dir.glob(File.join(@domain.locale_dir, '**',"#{@domain.domain_name}.po"))
+            po_files.each do |po_file|
+              pox_file = po_file.gsub('.po', '.pox')
+              sh "msgfmt -c #{po_file}"
+              sh "pofilter --nofuzzy -t variables -t blank -t urls -t emails -t long -t newlines -t endwhitespace -t endpunc \
+                -t puncspacing -t options -t printf -t validchars --gnome #{po_file} > #{pox_file};"
+              sh("! grep -q msgid #{pox_file}") do |ok, _|
+                sh "cat #{pox_file}" unless ok
+                abort "See errors above for #{pox_file}."
+              end
+            end
+          end
+
+          desc 'Clean everything, removes *.edit.po, *.po.timestamp and *.pox files'
+          task :clean do
+            edit_files = Dir.glob(File.join(@domain.locale_dir, '**', '*.edit.po'))
+            timestamp_files = Dir.glob(File.join(@domain.locale_dir, '**', '*.po.time_stamp'))
+            pox_files = Dir.glob(File.join(@domain.locale_dir, '**', '*.pox'))
+            messages_file = Dir.glob(File.join(@domain.locale_dir, '..', 'messages.mo'))
+            FileUtils.rm_f(edit_files + timestamp_files + pox_files + messages_file)
+          end
         end
       end
 

data/lib/hammer_cli/i18n.rb

@@ -137,6 +137,10 @@ module HammerCLI
       File.expand_path(File.join(File.dirname(__FILE__), '../../locale/Makefile.def'))
     end
 
+    def self.find_by_name(name)
+      domains.find { |domain| domain.class.to_s.split('::').first.underscore == name }
+    end
+
     init
   end
 end

data/lib/hammer_cli/options/normalizers.rb

@@ -50,9 +50,7 @@ module HammerCLI
       end
 
       class KeyValueList < AbstractNormalizer
-
-        PAIR_RE = '([^,=]+)=([^,\{\[]+|[\{\[][^\{\}\[\]]*[\}\]])'
-        FULL_RE = "^((%s)[,]?)+$" % PAIR_RE
+        FULL_RE = '([^=,]+)=([\{\[][^\{\}\[\]]*[\}\]]|[^\0]+?)(?=,[^,]+=|$)'
 
         class << self
           def completion_type
@@ -68,7 +66,6 @@ module HammerCLI
         def format(val)
           return {} unless val.is_a?(String)
           return {} if val.empty?
-
           if valid_key_value?(val)
             parse_key_value(val)
           else
@@ -89,7 +86,7 @@ module HammerCLI
 
         def parse_key_value(val)
           result = {}
-          val.scan(Regexp.new(PAIR_RE)) do |key, value|
+          val.scan(Regexp.new(FULL_RE)) do |key, value|
             value = value.strip
             if value.start_with?('[')
               value = value.scan(/[^,\[\]]+/)

data/lib/hammer_cli/settings.rb

@@ -4,6 +4,8 @@ require 'logging'
 module HammerCLI
 
   class Settings
+    CFG_PATH = ['~/.hammer/', '/etc/hammer/', "#{::RbConfig::CONFIG['sysconfdir']}/hammer/"].uniq
+    CFG_PATH_LOCAL = ['./config/']
 
     def self.get(*keys)
       keys.inject(settings) do |value, key|
@@ -41,6 +43,11 @@ module HammerCLI
       end
     end
 
+    def self.load_from_defaults
+      load_from_paths CFG_PATH
+      load_from_paths CFG_PATH_LOCAL
+    end
+
     def self.load(settings_hash)
       deep_merge!(settings, settings_hash)
     end

data/lib/hammer_cli/task_helper.rb

@@ -0,0 +1,84 @@
+require 'uri'
+require 'net/http'
+require 'openssl'
+require 'json'
+
+module HammerCLI
+  module TaskHelper
+    module I18n
+      class TxApiClient
+        class GeneralError < StandardError
+          def initialize(error)
+            msg = case error
+            when Hash
+              "#{error['title']}: #{error['detail']}"
+            when Array
+              error.join("\n")
+            else
+              error.to_s
+            end
+            super(msg)
+          end
+        end
+
+        TX_CONFIG_RC_FILE = '~/.transifexrc'
+        TX_BASE_API_URL = 'https://rest.api.transifex.com'
+
+        def initialize(domain:)
+          @domain = domain
+        end
+
+        def language_stats_collection
+          make_call(
+            path: '/resource_language_stats',
+            params: {
+              'filter[project]' => 'o:foreman:p:foreman',
+              'filter[resource]' => "o:foreman:p:foreman:r:#{@domain.domain_name}"
+            }
+          )
+        end
+
+        private
+
+        def make_call(path:, params: {}, http_method: :GET, content_type: 'application/vnd.api+json', body: nil)
+          url = URI(TX_BASE_API_URL + path)
+          url.query = URI.encode_www_form(params)
+
+          body = Net::HTTP.start(url.host, url.port, use_ssl: true) do |https|
+            request = Object.const_get("Net::HTTP::#{http_method.to_s.capitalize}").new(url)
+            request["accept"] = 'application/vnd.api+json'
+            request["content-type"] = content_type
+            request["authorization"] = "Bearer #{api_token}"
+            request.body = body
+
+            response = https.request(request).read_body
+            JSON.parse(response) rescue { 'errors' => ['Could not parse response']}
+          end
+          return body unless body['errors']
+
+          raise GeneralError.new(body['errors']&.first)
+        end
+
+        def api_token
+          return ENV['TX_TOKEN'] if ENV['TX_TOKEN']
+
+          token = nil
+          config_file = File.expand_path(TX_CONFIG_RC_FILE)
+          if File.exist?(config_file)
+            File.open(config_file) do |file|
+              file.find do |line|
+                match = line.match(/^(?<type>token|password)\s*=\s*(?<token>\S+)$/)
+                next unless match
+
+                token = match[:token]
+              end
+            end
+          end
+          raise GeneralError.new("Could not find API token. Set it in #{config_file} or TX_TOKEN.") unless token
+
+          token
+        end
+      end
+    end
+  end
+end

data/lib/hammer_cli/testing/output_matchers.rb

@@ -2,7 +2,7 @@ module HammerCLI
   module Testing
     module OutputMatchers
       class MatcherBase
-        include MiniTest::Assertions
+        include Minitest::Assertions
 
         def initialize(expected="")
           @expected = expected

data/lib/hammer_cli/utils.rb

@@ -6,7 +6,7 @@ class String
     if params.is_a? Hash
       array_params = self.scan(/%[<{]([^>}]*)[>}]/).collect do |name|
         name = name[0]
-        params[name.to_s] || params[name.to_sym]
+        !params[name.to_s].nil? ? params[name.to_s].to_s : params[name.to_sym].to_s
       end
       self.gsub(/%[<]([^>]*)[>]/, '%')
           .gsub(/%[{]([^}]*)[}]/, '%s')

data/lib/hammer_cli/version.rb

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

data/locale/Makefile.def

@@ -3,7 +3,19 @@
 #
 # Run make help to list available targets
 #
-
+define DOMAIN_CMD
+require "rubygems";
+require "hammer_cli";
+HammerCLI::Settings.load_from_defaults;
+HammerCLI::Modules.load_all;
+spec = Gem::Specification::load(Dir.glob("../*.gemspec").first);
+i18n_domain = spec.respond_to?(:metadata) && spec.metadata["i18n_domain"];
+puts i18n_domain || HammerCLI::I18n.find_by_name(spec.name)&.domain_name || spec.name
+endef
+ifeq ($(origin DOMAIN), undefined)
+DOMAIN := $(shell bundle exec ruby -e '$(DOMAIN_CMD)')
+endif
+VERSION = $(shell ruby -rrubygems -e 'puts Gem::Specification::load(Dir.glob("../*.gemspec").first).version')
 POTFILE = $(DOMAIN).pot
 MOFILE = $(DOMAIN).mo
 POFILES = $(shell find . -name '$(DOMAIN).po')
@@ -12,12 +24,17 @@ POXFILES = $(patsubst %.po,%.pox,$(POFILES))
 EDITFILES = $(patsubst %.po,%.edit.po,$(POFILES))
 TIMESTAMPFILES = $(patsubst %.po,%.po.time_stamp,$(POFILES))
 
-%.mo: %.po
-	mkdir -p $(shell dirname $@)/LC_MESSAGES
-	msgfmt -o $(shell dirname $@)/LC_MESSAGES/$(MOFILE) $<
+.PHONY: vars
+vars:
+	@echo VERSION: $(VERSION)
+	@echo DOMAIN: $(DOMAIN)
 
 .PHONY: all-mo
-all-mo: $(MOFILES) ## Generate MO files from PO files (default)
+all-mo: ## Generate MO files from PO files (default)
+	for po_file in $(POFILES); do \
+		mkdir -p $$(dirname $$po_file)/LC_MESSAGES; \
+		msgfmt -o $$(dirname $$po_file)/LC_MESSAGES/$(MOFILE) $$po_file; \
+	done
 
 # Check for malformed strings
 %.pox: %.po
@@ -44,7 +61,7 @@ uniq-po: ## Unify duplicate translations in .po files
 .PHONY: tx-pull
 tx-pull: $(EDITFILES)
 	@command -v tx >/dev/null 2>&1 || { echo "Command tx not found. Make sure you have transifex-client installed and configured." >&2; exit 1; }
-	tx pull -f
+	cd .. && tx pull -f
 	for f in $(EDITFILES); do \
 		sed -i 's/^\("Project-Id-Version: \).*$$/\1$(DOMAIN) $(VERSION)\\n"/' $$f; \
 	done
@@ -61,8 +78,13 @@ update-po:
 extract-strings:
 	bundle exec rake gettext:find
 
+# Check languages with 50% or more coverage and create needed files
+.PHONY: find-new
+find-new:
+	bundle exec rake gettext:find_new
+
 .PHONY: tx-update
-tx-update: extract-strings tx-pull update-po $(MOFILES) ## Download and merge translations from Transifex
+tx-update: find-new extract-strings tx-pull update-po all-mo ## Download and merge translations from Transifex
 	git add ../locale
 	git commit -m "i18n - extracting new, pulling from tx"
 	@echo Changes commited!

data/test/functional/help_test.rb

@@ -45,7 +45,7 @@ describe 'help' do
 
   it 'prints additional help' do
     result = run_cmd(['-h'], {}, CmdWithHelp)
-    result.out.must_equal [
+    _(result.out).must_equal [
       'Usage:',
       '    hammer [OPTIONS]',
       '',

data/test/test_helper.rb

@@ -9,7 +9,7 @@ end
 SimpleCov.root Pathname.new(File.dirname(__FILE__) + "../../../")
 
 require 'minitest/autorun'
-require 'minitest/spec'
+require 'minitest/unit'
 require "minitest-spec-context"
 require "mocha/minitest"