Add theforeman-rubocop gem and Rubocop configuration (#56)

Added theforeman-rubocop gem to v0.1.0 and the rubocop configuration,
followed by default style from the gem.

.rubocop.yml

@@ -0,0 +1,17 @@
+inherit_from: .rubocop_todo.yml
+
+inherit_gem:
+  theforeman-rubocop:
+    - default.yml
+
+Metrics:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/HashSyntax:
+  Enabled: false

.rubocop_todo.yml

@@ -0,0 +1,175 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2024-05-30 08:41:44 UTC using RuboCop version 1.23.0.
+# 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
+# Configuration parameters: Include.
+# Include: **/*.gemspec
+Gemspec/RequiredRubyVersion:
+  Exclude:
+    - 'hammer_cli_foreman_tasks.gemspec'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Layout/EmptyLineAfterMagicComment:
+  Exclude:
+    - 'hammer_cli_foreman_tasks.gemspec'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Layout/EmptyLines:
+  Exclude:
+    - 'lib/hammer_cli_foreman_tasks/task.rb'
+
+# Offense count: 5
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: empty_lines, empty_lines_except_namespace, empty_lines_special, no_empty_lines
+Layout/EmptyLinesAroundModuleBody:
+  Exclude:
+    - 'lib/hammer_cli_foreman_tasks/async_command.rb'
+    - 'lib/hammer_cli_foreman_tasks/i18n.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: AllowForAlignment, AllowBeforeTrailingComments, ForceEqualSignAlignment.
+Layout/ExtraSpacing:
+  Exclude:
+    - 'lib/hammer_cli_foreman_tasks/task_progress.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: AllowForAlignment, EnforcedStyleForExponentOperator.
+# SupportedStylesForExponentOperator: space, no_space
+Layout/SpaceAroundOperators:
+  Exclude:
+    - 'lib/hammer_cli_foreman_tasks/task_progress.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+Performance/CompareWithBlock:
+  Exclude:
+    - 'lib/hammer_cli_foreman_tasks/command_extensions/recurring_logic.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: NilOrEmpty, NotPresent, UnlessPresent.
+Rails/Blank:
+  Exclude:
+    - 'lib/hammer_cli_foreman_tasks/task_progress.rb'
+
+# Offense count: 3
+# Cop supports --auto-correct.
+# Configuration parameters: Include.
+# Include: app/**/*.rb, config/**/*.rb, db/**/*.rb, lib/**/*.rb
+Rails/Output:
+  Exclude:
+    - 'lib/hammer_cli_foreman_tasks/recurring_logic.rb'
+    - 'lib/hammer_cli_foreman_tasks/task_progress.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/Encoding:
+  Exclude:
+    - 'hammer_cli_foreman_tasks.gemspec'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/ExpandPathArguments:
+  Exclude:
+    - 'hammer_cli_foreman_tasks.gemspec'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/GlobalStdStream:
+  Exclude:
+    - 'lib/hammer_cli_foreman_tasks/task_progress.rb'
+
+# Offense count: 2
+# Configuration parameters: MinBodyLength.
+Style/GuardClause:
+  Exclude:
+    - 'lib/hammer_cli_foreman_tasks/task_progress.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/IfUnlessModifier:
+  Exclude:
+    - 'lib/hammer_cli_foreman_tasks/task_progress.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/InfiniteLoop:
+  Exclude:
+    - 'lib/hammer_cli_foreman_tasks/task_progress.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, IgnoredMethods.
+# SupportedStyles: predicate, comparison
+Style/NumericPredicate:
+  Exclude:
+    - 'lib/hammer_cli_foreman_tasks/recurring_logic.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: AllowSafeAssignment, AllowInMultilineConditions.
+Style/ParenthesesAroundCondition:
+  Exclude:
+    - 'lib/hammer_cli_foreman_tasks/recurring_logic.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: PreferredDelimiters.
+Style/PercentLiteralDelimiters:
+  Exclude:
+    - 'lib/hammer_cli_foreman_tasks/task_progress.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/Proc:
+  Exclude:
+    - 'lib/hammer_cli_foreman_tasks/task_progress.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/RedundantBegin:
+  Exclude:
+    - 'lib/hammer_cli_foreman_tasks/task_progress.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: RequireEnglish.
+# SupportedStyles: use_perl_names, use_english_names
+Style/SpecialGlobalVars:
+  EnforcedStyle: use_perl_names
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/StderrPuts:
+  Exclude:
+    - 'lib/hammer_cli_foreman_tasks/task_progress.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: Mode.
+Style/StringConcatenation:
+  Exclude:
+    - 'lib/hammer_cli_foreman_tasks/recurring_logic.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/ZeroLengthPredicate:
+  Exclude:
+    - 'lib/hammer_cli_foreman_tasks/recurring_logic.rb'
+
+# Offense count: 3
+# Cop supports --auto-correct.
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# URISchemes: http, https
+Layout/LineLength:
+  Max: 206

Gemfile

@@ -1,18 +1,18 @@
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
 gemspec
 
 gem 'gettext', '>= 3.1.3', '< 4.0.0'
 gem 'psych' # requiring psych to workaround issues with bundler 1.11.0, see https://github.com/bundler/bundler/issues/4149
 
 group :test do
-  gem 'rake', '~> 13.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'
 end
 
 # load local gemfile

hammer_cli_foreman_tasks.gemspec

@@ -13,13 +13,13 @@ Gem::Specification.new do |s|
   s.email       = ["[email protected]"]
   s.homepage    = "https://github.com/theforeman/hammer-cli-foreman-tasks"
   s.summary     = "Foreman CLI plugin for showing tasks information for resoruces and users"
-  s.description = <<DESC
-Contains the code for showing of the tasks (results and progress) in the Hammer CLI.
-DESC
+  s.description = <<~DESC
+    Contains the code for showing of the tasks (results and progress) in the Hammer CLI.
+  DESC
 
   s.files = Dir["{lib,config,locale}/**/*", "LICENSE", "README.md"]
   s.require_paths = ["lib"]
 
-  s.add_dependency "powerbar", ">= 1.0.11", "< 3.0"
   s.add_dependency "hammer_cli_foreman", "> 0.1.1", "< 4.0.0"
+  s.add_dependency "powerbar", ">= 1.0.11", "< 3.0"
 end

lib/hammer_cli_foreman_tasks/i18n.rb

@@ -4,7 +4,6 @@ module HammerCLIForemanTasks
   module I18n
 
     class LocaleDomain < HammerCLI::I18n::LocaleDomain
-
       def translated_files
         Dir.glob(File.join(File.dirname(__FILE__), '../**/*.rb'))
       end

lib/hammer_cli_foreman_tasks/recurring_logic.rb

@@ -34,7 +34,7 @@ class CancelCommand < HammerCLIForeman::DeleteCommand
       failure_message _('Could not cancel the recurring logic')
       build_options
     end
-    
+
     class DeleteCommand < HammerCLIForeman::DeleteCommand
       action :bulk_destroy
 

lib/hammer_cli_foreman_tasks/task.rb

@@ -1,6 +1,5 @@
 module HammerCLIForemanTasks
   class Task < HammerCLIForeman::Command
-
     resource :foreman_tasks
 
     module WithoutNameOption
@@ -17,7 +16,6 @@ def extend_data(task)
     end
 
     class ProgressCommand < HammerCLIForeman::Command
-
       include HammerCLIForemanTasks::Helper
 
       action :show
@@ -35,7 +33,6 @@ def execute
         success = task_progress(option_id)
         success ? HammerCLI::EX_OK : HammerCLI::EX_SOFTWARE
       end
-
     end
 
     class ListCommand < HammerCLIForeman::ListCommand