hammer_cli_foreman_remote_execution 0.2.3 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 13936d223c0f18debaf8eed7bcfa01637714b7025f8aaccfeb2bad7f6ad84656
-  data.tar.gz: 4b8e059bae3fb93cbb03909713835cfd92f92b2d9ffbe7f4c67e0d2ff74338d0
+  metadata.gz: 90e3a16f1acf556e56d0e4302d47a1dc408c110d002b012b674abc2c8ae79251
+  data.tar.gz: 8a8eb33d582b2cd246fe51b458fc0829cb4ea3d553c3a320c6d84e20b5a7cce2
 SHA512:
-  metadata.gz: 609a5acec0ad01711cc30432b523669058324398f87906f3699ce31e3f12106bba332c168abd36969161abce1f5500e0130aef7678fb0bd61c678995c1381dbe
-  data.tar.gz: 968ac27ee182a511f9720fe0e6b46aa2dd36db68714e1be4c84235c064242bf939e44eb9f4a536de285ee1b5a03df3c61adbc959884a6ccc54887fe6765dc969
+  metadata.gz: 18e67331e046360e779fc47d0df68e3e4e14accf8bf5c9a7095b2cad813e72f375e3264b15604763866b4c06d4b75bb8990e54316c0e3632e0cf044fe55ed10c
+  data.tar.gz: 343b148c08a660e02366e6098918514db6c6e5eacd0297ff665417b06b6785d100228b70826b686d6faaea296ca828ae003f99ffe333d8ba31520087f2fe0ec6

data/.github/workflows/ci_test.yml

@@ -0,0 +1,22 @@
+name: CI
+on:
+  pull_request:
+  push:
+    branches:
+      - "master"
+concurrency:
+  group: ${{ github.ref_name }}-${{ github.workflow }}
+  cancel-in-progress: true
+jobs:
+  rubocop:
+    name: Rubocop
+    uses: theforeman/actions/.github/workflows/rubocop.yml@v0
+    with:
+        command: bundle exec rubocop --parallel --format github
+
+  test:
+    name: Tests
+    needs: rubocop
+    uses: theforeman/actions/.github/workflows/test-gem.yml@v0
+    with:
+      command: bundle exec rake test

data/.rubocop.yml

@@ -1,8 +1,11 @@
-Metrics/LineLength:
-  Max: 100
+inherit_from: .rubocop_todo.yml
 
-Style/Documentation:
-  Enabled: false
+inherit_gem:
+  theforeman-rubocop:
+    - lenient.yml
+
+AllCops:
+  TargetRubyVersion: 2.7
 
 Style/HashSyntax:
   EnforcedStyle: hash_rockets

data/.rubocop_todo.yml

@@ -0,0 +1,81 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2024-08-02 06:59:11 UTC using RuboCop version 1.64.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: EnforcedStyle, IndentationWidth.
+# SupportedStyles: with_first_element, with_fixed_indentation
+Layout/ArrayAlignment:
+  Exclude:
+    - 'test/unit/job_invocation_test.rb'
+
+# Offense count: 1
+# Configuration parameters: MaximumRangeSize.
+Lint/MissingCopEnableDirective:
+  Exclude:
+    - 'test/unit/template_input_test.rb'
+
+# Offense count: 3
+# Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes.
+Metrics/AbcSize:
+  Max: 21
+
+# Offense count: 3
+# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
+# AllowedMethods: refine
+Metrics/BlockLength:
+  Max: 82
+
+# Offense count: 1
+# Configuration parameters: AllowedMethods, AllowedPatterns.
+Metrics/CyclomaticComplexity:
+  Max: 8
+
+# Offense count: 3
+# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
+Metrics/MethodLength:
+  Max: 13
+
+# Offense count: 4
+# This cop supports unsafe autocorrection (--autocorrect-all).
+# Configuration parameters: Include.
+# Include: app/**/*.rb, config/**/*.rb, db/**/*.rb, lib/**/*.rb
+Rails/Output:
+  Exclude:
+    - 'lib/hammer_cli_foreman_remote_execution/job_invocation.rb'
+    - 'lib/hammer_cli_foreman_remote_execution/job_template.rb'
+
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: EnforcedStyle, Include.
+# SupportedStyles: assert_not, refute
+# Include: **/test/**/*
+Rails/RefuteMethods:
+  Exclude:
+    - 'test/unit/job_invocation_test.rb'
+
+# Offense count: 4
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: MaxUnannotatedPlaceholdersAllowed, AllowedMethods, AllowedPatterns.
+# SupportedStyles: annotated, template, unannotated
+# AllowedMethods: redirect
+Style/FormatStringToken:
+  EnforcedStyle: template
+
+# Offense count: 1
+# This cop supports unsafe autocorrection (--autocorrect-all).
+Style/HashTransformValues:
+  Exclude:
+    - 'lib/hammer_cli_foreman_remote_execution/options/normalizers.rb'
+
+# Offense count: 5
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, AllowedPatterns.
+# URISchemes: http, https
+Layout/LineLength:
+  Max: 208

data/.tx/config

@@ -1,8 +1,9 @@
 [main]
-host = https://www.transifex.com
+host = https://app.transifex.com
 
-[foreman.hammer-cli-foreman-remote-execution]
-file_filter = locale/<lang>/hammer-cli-foreman-remote-execution.edit.po
-source_file = locale/hammer-cli-foreman-remote-exectution.pot
+[o:foreman:p:foreman:r:hammer_cli_foreman_remote_execution]
+file_filter = locale/<lang>/hammer_cli_foreman_remote_execution.edit.po
+source_file = locale/hammer_cli_foreman_remote_execution.pot
 source_lang = en
 type = PO
+resource_name = hammer_cli_foreman_remote_execution

data/Gemfile

@@ -1,24 +1,25 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 gemspec
 
+gem 'fast_gettext', '< 1.2.0' if RUBY_VERSION < '2.1.0'
 gem 'gettext', '>= 3.1.3', '< 4.0.0'
-if RUBY_VERSION < '2.1.0'
-  gem 'fast_gettext', '< 1.2.0'
-end
 
 group :test do
-  gem 'rake', '~> 10.1.0'
-  gem 'thor'
-  gem 'minitest', '< 4.7.4'
+  gem 'ci_reporter', '>= 1.6.3', '< 2.0.0', :require => false
+  gem 'minitest', '>= 5.1'
   gem 'minitest-spec-context'
-  gem 'simplecov'
   gem 'mocha'
-  gem 'ci_reporter', '>= 1.6.3', "< 2.0.0", :require => false
+  gem 'rake', '~> 13.1.0'
+  gem 'simplecov'
+  gem 'theforeman-rubocop', '~> 0.1.0'
+  gem 'thor'
 end
 
 # load local gemfile
 ['Gemfile.local.rb', 'Gemfile.local'].map do |file_name|
   local_gemfile = File.join(File.dirname(__FILE__), file_name)
-  self.instance_eval(Bundler.read_file(local_gemfile)) if File.exist?(local_gemfile)
+  instance_eval(Bundler.read_file(local_gemfile)) if File.exist?(local_gemfile)
 end

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rake/testtask'
 require 'ci/reporter/rake/minitest'
@@ -6,31 +8,7 @@ Rake::TestTask.new :test do |t|
   t.libs.push "lib"
   t.test_files = Dir.glob('test/**/*_test.rb')
   t.verbose = true
-end
-
-namespace :gettext do
-
-  task :setup do
-    require "hammer_cli_foreman_remote_execution/version"
-    require "hammer_cli_foreman_remote_execution/i18n"
-    require 'gettext/tools/task'
-
-    domain = HammerCLIForemanRemoteExecution::I18n::LocaleDomain.new
-    GetText::Tools::Task.define do |task|
-      task.package_name = domain.domain_name
-      task.package_version = HammerCLIForemanRemoteExecution.version.to_s
-      task.domain = domain.domain_name
-      task.mo_base_directory = domain.locale_dir
-      task.po_base_directory = domain.locale_dir
-      task.files = domain.translated_files
-    end
-  end
-
-  desc "Update pot file"
-  task :find => [:setup] do
-    Rake::Task["gettext:po:update"].invoke
-  end
-
+  t.warning = ENV.key?('RUBY_WARNINGS')
 end
 
 namespace :pkg do
@@ -39,3 +17,9 @@ namespace :pkg do
 end
 
 task :default => :test
+
+require "hammer_cli_foreman_remote_execution/version"
+require "hammer_cli_foreman_remote_execution/i18n"
+require "hammer_cli/i18n/find_task"
+HammerCLI::I18n::FindTask.define(HammerCLIForemanRemoteExecution::I18n::LocaleDomain.new,
+  HammerCLIForemanRemoteExecution.version.to_s)

data/hammer_cli_foreman_remote_execution.gemspec

@@ -1,4 +1,6 @@
-require File.expand_path('../lib/hammer_cli_foreman_remote_execution/version', __FILE__)
+# frozen_string_literal: true
+
+require File.expand_path('lib/hammer_cli_foreman_remote_execution/version', __dir__)
 
 Gem::Specification.new do |s|
   s.name          = 'hammer_cli_foreman_remote_execution'
@@ -10,7 +12,7 @@ Gem::Specification.new do |s|
   s.license       = 'GPL-3.0-or-later'
 
   s.summary       = 'CLI for the Foreman remote execution plugin'
-  s.description   = 'CLI for the Foreman remote execution plugin'
+  s.description   = 'This gem provides CLI support for the Foreman remote execution plugin'
 
   s.files =            `git ls-files`.split("\n")
   s.test_files =       `git ls-files test`.split("\n")
@@ -18,4 +20,6 @@ Gem::Specification.new do |s|
 
   s.add_dependency 'hammer_cli_foreman', '>= 0.1.3', '< 4.0.0'
   s.add_dependency 'hammer_cli_foreman_tasks', '~> 0.0.3'
+
+  s.required_ruby_version = '>= 2.7', '< 4'
 end

data/lib/hammer_cli_foreman_remote_execution/foreign_input_set.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module HammerCLIForemanRemoteExecution
   class ForeignInputSet < HammerCLIForeman::Command
     resource :foreign_input_sets

data/lib/hammer_cli_foreman_remote_execution/i18n.rb

@@ -1,10 +1,10 @@
+# frozen_string_literal: true
+
 require 'hammer_cli/i18n'
 
 module HammerCLIForemanRemoteExecution
   module I18n
-
     class LocaleDomain < HammerCLI::I18n::LocaleDomain
-
       def translated_files
         Dir.glob(File.join(File.dirname(__FILE__), '../**/*.rb'))
       end
@@ -14,20 +14,18 @@ module HammerCLIForemanRemoteExecution
       end
 
       def domain_name
-        'hammer-cli-foreman-remote-execution'
+        'hammer_cli_foreman_remote_execution'
       end
     end
 
     class SystemLocaleDomain < LocaleDomain
-
       def locale_dir
         '/usr/share/locale'
       end
-
     end
-
   end
 end
 
-domain = [HammerCLIForemanRemoteExecution::I18n::LocaleDomain.new, HammerCLIForemanRemoteExecution::I18n::SystemLocaleDomain.new].find { |d| d.available? }
+domain = [HammerCLIForemanRemoteExecution::I18n::LocaleDomain.new,
+          HammerCLIForemanRemoteExecution::I18n::SystemLocaleDomain.new].find(&:available?)
 HammerCLI::I18n.add_domain(domain) if domain

data/lib/hammer_cli_foreman_remote_execution/interface_extensions.rb

@@ -16,9 +16,9 @@ module HammerCLIForemanRemoteExecution
       type = super(nic)
       if nic['execution']
         if nic['primary'] || nic['provision']
-          type[-1] = ', '+_('execution') +')'
+          type[-1] = ', ' + _('execution') + ')'
         else
-          type += ' ('+_('execution') +')'
+          type += ' (' + _('execution') + ')'
         end
       end
       type

data/lib/hammer_cli_foreman_remote_execution/job_invocation.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module HammerCLIForemanRemoteExecution
   class JobInvocation < HammerCLIForeman::Command
     resource :job_invocations
@@ -112,13 +114,13 @@ module HammerCLIForemanRemoteExecution
       def execute
         data = get_output
         if data['delayed']
-          puts _('The job is scheduled to start at %{timestamp}') % { :timestamp => data['start_at'] }
+          puts format(_('The job is scheduled to start at %{timestamp}'), :timestamp => data['start_at'])
           return HammerCLI::EX_OK if option_async?
         end
         since = print_data(data)
 
         output_loop(data, since)
-        return HammerCLI::EX_OK
+        HammerCLI::EX_OK
       end
 
       build_options do |o|
@@ -129,7 +131,7 @@ module HammerCLIForemanRemoteExecution
       private
 
       def output_loop(data, since = nil)
-        while data['refresh'] && !option_async? do
+        while data['refresh'] && !option_async?
           sleep 1
           data = get_output(since)
           since = print_data(data)
@@ -186,7 +188,7 @@ module HammerCLIForemanRemoteExecution
         super(task)
       end
 
-      alias original_option_async? option_async?
+      alias_method :original_option_async?, :option_async?
 
       def option_async?
         if immediate?

data/lib/hammer_cli_foreman_remote_execution/job_template.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module HammerCLIForemanRemoteExecution
   class JobTemplate < HammerCLIForeman::Command
     resource :job_templates
@@ -45,8 +47,8 @@ module HammerCLIForemanRemoteExecution
 
     class CreateCommand < HammerCLIForeman::CreateCommand
       option '--file', 'TEMPLATE', N_('Path to a file that contains the template'),
-             :attribute_name => :option_template, :required => true,
-             :format => HammerCLI::Options::Normalizers::File.new
+        :attribute_name => :option_template, :required => true,
+        :format => HammerCLI::Options::Normalizers::File.new
 
       success_message _('Job template created')
       failure_message _('Could not create the job template')
@@ -61,8 +63,8 @@ module HammerCLIForemanRemoteExecution
       action :import
 
       option '--file', 'TEMPLATE', N_('Path to a file that contains the template - must include ERB metadata'),
-             :attribute_name => :option_template, :required => true,
-             :format => HammerCLI::Options::Normalizers::File.new
+        :attribute_name => :option_template, :required => true,
+        :format => HammerCLI::Options::Normalizers::File.new
 
       success_message _('Job template imported')
       failure_message _('Could not import the job template')
@@ -87,8 +89,8 @@ module HammerCLIForemanRemoteExecution
 
     class UpdateCommand < HammerCLIForeman::UpdateCommand
       option '--file', 'TEMPLATE', N_('Path to a file that contains the template'),
-             :attribute_name => :option_template,
-             :format => HammerCLI::Options::Normalizers::File.new
+        :attribute_name => :option_template,
+        :format => HammerCLI::Options::Normalizers::File.new
 
       success_message _('Job template updated')
       failure_message _('Could not update the job template')

data/lib/hammer_cli_foreman_remote_execution/options/normalizers.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module HammerCLIForemanRemoteExecution
   module Options
     module Normalizers
@@ -11,11 +13,11 @@ module HammerCLIForemanRemoteExecution
         end
 
         def complete(value)
-          Dir[value.to_s+'*'].collect do |file|
+          Dir[value.to_s + '*'].collect do |file|
             if ::File.directory?(file)
-              file+'/'
+              file + '/'
             else
-              file+' '
+              file + ' '
             end
           end
         end

data/lib/hammer_cli_foreman_remote_execution/remote_execution_feature.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module HammerCLIForemanRemoteExecution
   class RemoteExecutionFeature < HammerCLIForeman::Command
     resource :remote_execution_features
@@ -37,5 +39,6 @@ module HammerCLIForemanRemoteExecution
     autoload_subcommands
   end
 
-  HammerCLI::MainCommand.subcommand 'remote-execution-feature', _('Manage remote execution features'), RemoteExecutionFeature
+  HammerCLI::MainCommand.subcommand 'remote-execution-feature', _('Manage remote execution features'),
+    RemoteExecutionFeature
 end

data/lib/hammer_cli_foreman_remote_execution/subnet_extensions.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 require 'hammer_cli_foreman/subnet'
 
 module HammerCLIForemanRemoteExecution
   class SubnetExtensions < ::HammerCLI::CommandExtensions
     output do |definition|
-      definition.insert(:after, _("Smart Proxies"))do
+      definition.insert(:after, _("Smart Proxies")) do
         collection :remote_execution_proxies, _('Remote execution proxies'), :numbered => false do
           field :id, _('Id')
           field :name, _('Name')

data/lib/hammer_cli_foreman_remote_execution/template_input.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module HammerCLIForemanRemoteExecution
   class TemplateInput < HammerCLIForeman::Command
     resource :template_inputs

data/lib/hammer_cli_foreman_remote_execution/version.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module HammerCLIForemanRemoteExecution
   def self.version
-    @version ||= Gem::Version.new '0.2.3'
+    @version ||= Gem::Version.new '0.3.1'
   end
 end

data/lib/hammer_cli_foreman_remote_execution.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'hammer_cli'
 require 'hammer_cli_foreman'
 require 'hammer_cli_foreman_tasks'

data/locale/Makefile

@@ -1,57 +1,6 @@
 #
 # Makefile for PO merging and MO generation. More info in the README.
 #
-# make all-mo (default) - generate MO files
-# make check - check translations using translate-tool
-# make tx-update - download and merge translations from Transifex
-# make clean - clean everything
+# Run make help to list available targets
 #
-DOMAIN = hammer-cli-foreman-remote-execution
-VERSION = $(shell ruby -e 'require "rubygems";spec = Gem::Specification::load("../hammer_cli_foreman_remote_execution.gemspec");puts spec.version')
-POTFILE = $(DOMAIN).pot
-MOFILE = $(DOMAIN).mo
-POFILES = $(shell find . -name '$(DOMAIN).po')
-MOFILES = $(patsubst %.po,%.mo,$(POFILES))
-POXFILES = $(patsubst %.po,%.pox,$(POFILES))
-EDITFILES = $(patsubst %.po,%.edit.po,$(POFILES))
-
-%.mo: %.po
-	mkdir -p $(shell dirname $@)/LC_MESSAGES
-	msgfmt -o $(shell dirname $@)/LC_MESSAGES/$(MOFILE) $<
-
-# Generate MO files from PO files
-all-mo: $(MOFILES)
-
-# Check for malformed strings
-%.pox: %.po
-	msgfmt -c $<
-	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 $< > $@
-	cat $@
-	! grep -q msgid $@
-
-check: $(POXFILES)
-
-# Unify duplicate translations
-uniq-po:
-	for f in $(shell find ./ -name "*.po") ; do \
-		msguniq $$f -o $$f ; \
-	done
-
-tx-pull: $(EDITFILES)
-	tx pull -f
-	for f in $(POFILES) ; do \
-		sed -i 's/^\("Project-Id-Version: \).*$$/\1$(DOMAIN) $(VERSION)\\n"/' $$f; \
-	done
-
-# Extract strings and update the .pot, prepare .edit.po files
-extract-strings:
-	bundle exec rake gettext:find
-
-# Merge .edit.po into .po
-update-po:
-	bundle exec rake gettext:find
-
-tx-update: extract-strings tx-pull $(MOFILES)
-	git commit -m "i18n - extracting new, pulling from tx" ../locale
-	-echo Changes commited!
+include $(shell bundle exec ruby -e 'require "hammer_cli"; puts HammerCLI::I18n.main_makefile')