Rubocop

- Use Foreman action
- Fix Rubocop auto corrections
- Add .rubocop_todo.yml

.github/workflows/main.yml

@@ -12,8 +12,13 @@ concurrency:
   cancel-in-progress: true
 
 jobs:
-  test:
+  rubocop:
+    name: Rubocop
+    uses: theforeman/actions/.github/workflows/rubocop.yml@v0
+
+  test_ruby:
     name: Ruby
+    needs: rubocop
     uses: theforeman/actions/.github/workflows/foreman_plugin.yml@v0
     with:
       plugin: foreman_azure_rm

.rubocop.yml

@@ -0,0 +1,25 @@
+inherit_from: .rubocop_todo.yml
+
+AllCops:
+  NewCops: enable
+
+Layout/LineLength:
+  Enabled: false
+
+Metrics:
+  Enabled: false
+
+Style/HashSyntax:
+  EnforcedStyle: no_mixed_keys
+
+Style/SymbolArray:
+  EnforcedStyle: brackets
+
+Style/Documentation:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false

.rubocop_todo.yml

@@ -0,0 +1,129 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2024-03-14 09:55:55 UTC using RuboCop version 1.50.2.
+# 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: Severity, Include.
+# Include: **/*.gemspec
+Gemspec/DeprecatedAttributeAssignment:
+  Exclude:
+    - 'foreman_azure_rm.gemspec'
+
+# Offense count: 1
+# Configuration parameters: EnforcedStyle, AllowedGems, Include.
+# SupportedStyles: Gemfile, gems.rb, gemspec
+# Include: **/*.gemspec, **/Gemfile, **/gems.rb
+Gemspec/DevelopmentDependencies:
+  Exclude:
+    - 'foreman_azure_rm.gemspec'
+
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: Severity, Include.
+# Include: **/*.gemspec
+Gemspec/RequireMFA:
+  Exclude:
+    - 'foreman_azure_rm.gemspec'
+
+# Offense count: 1
+# Configuration parameters: Severity, Include.
+# Include: **/*.gemspec
+Gemspec/RequiredRubyVersion:
+  Exclude:
+    - 'foreman_azure_rm.gemspec'
+
+# Offense count: 1
+# Configuration parameters: IgnoreLiteralBranches, IgnoreConstantBranches.
+Lint/DuplicateBranch:
+  Exclude:
+    - 'app/models/foreman_azure_rm/azure_rm.rb'
+
+# Offense count: 4
+Lint/DuplicateMethods:
+  Exclude:
+    - 'app/models/foreman_azure_rm/azure_rm_compute.rb'
+
+# Offense count: 2
+Lint/NoReturnInBeginEndBlocks:
+  Exclude:
+    - 'app/models/foreman_azure_rm/azure_rm_compute.rb'
+
+# Offense count: 1
+Lint/RescueException:
+  Exclude:
+    - 'app/helpers/azure_compute_resource_helper.rb'
+
+# Offense count: 1
+Lint/ShadowingOuterLocalVariable:
+  Exclude:
+    - 'app/models/foreman_azure_rm/azure_rm.rb'
+
+# Offense count: 1
+# Configuration parameters: AllowedPatterns.
+# AllowedPatterns: (?-mix:(exactly|at_least|at_most)\(\d+\)\.times)
+Lint/UnreachableLoop:
+  Exclude:
+    - 'lib/foreman_azure_rm/azure_sdk_adapter.rb'
+
+# Offense count: 8
+Lint/UselessAssignment:
+  Exclude:
+    - 'app/helpers/azure_compute_resource_helper.rb'
+    - 'app/models/concerns/foreman_azure_rm/vm_extensions/managed_vm.rb'
+    - 'app/models/foreman_azure_rm/azure_rm.rb'
+    - 'app/models/foreman_azure_rm/azure_rm_compute.rb'
+    - 'lib/foreman_azure_rm/azure_sdk_adapter.rb'
+
+# Offense count: 1
+# Configuration parameters: CheckForMethodsWithNoSideEffects.
+Lint/Void:
+  Exclude:
+    - 'test/azure_rm_test_helper.rb'
+
+# Offense count: 1
+Naming/AccessorMethodName:
+  Exclude:
+    - 'lib/foreman_azure_rm/azure_sdk_adapter.rb'
+
+# Offense count: 4
+# Configuration parameters: MinNameLength, AllowNamesEndingInNumbers, AllowedNames, ForbiddenNames.
+# AllowedNames: as, at, by, cc, db, id, if, in, io, ip, of, on, os, pp, to
+Naming/MethodParameterName:
+  Exclude:
+    - 'app/helpers/azure_compute_resource_helper.rb'
+    - 'app/models/foreman_azure_rm/azure_rm.rb'
+
+# Offense count: 1
+# This cop supports unsafe autocorrection (--autocorrect-all).
+Style/CollectionCompact:
+  Exclude:
+    - 'app/models/foreman_azure_rm/azure_rm.rb'
+
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+Style/IfUnlessModifier:
+  Exclude:
+    - 'app/models/foreman_azure_rm/azure_rm.rb'
+
+# Offense count: 1
+Style/MultilineBlockChain:
+  Exclude:
+    - 'app/models/foreman_azure_rm/azure_rm.rb'
+
+# Offense count: 3
+Style/OpenStructUse:
+  Exclude:
+    - 'app/models/foreman_azure_rm/azure_rm.rb'
+    - 'app/models/foreman_azure_rm/azure_rm_compute.rb'
+
+# Offense count: 3
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: MinSize.
+# SupportedStyles: percent, brackets
+Style/SymbolArray:
+  EnforcedStyle: percent

.ruby-version

@@ -0,0 +1 @@
+3.0.6

Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
-gemspec
+gemspec

Rakefile

@@ -1,4 +1,6 @@
 #!/usr/bin/env rake
+# frozen_string_literal: true
+
 begin
   require 'bundler/setup'
 rescue LoadError
@@ -20,7 +22,7 @@ RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
-APP_RAKEFILE = File.expand_path('../test/dummy/Rakefile', __FILE__)
+APP_RAKEFILE = File.expand_path('test/dummy/Rakefile', __dir__)
 
 Bundler::GemHelper.install_tasks
 
@@ -38,10 +40,10 @@ task default: :test
 begin
   require 'rubocop/rake_task'
   RuboCop::RakeTask.new
-rescue => _
+rescue StandardError => _e
   puts 'Rubocop not loaded.'
 end
 
 task :default do
   Rake::Task['rubocop'].execute
-end
+end

app/controllers/foreman_azure_rm/concerns/compute_resources_controller_extensions.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ForemanAzureRm
   module Concerns
     module ComputeResourcesControllerExtensions
@@ -7,45 +9,45 @@ module ComputeResourcesControllerExtensions
       update_api(:create, :update) do
         param :compute_resource, Hash do
           # Not adding :tenant as already specified in core.
-          param :app_ident, String, :desc => N_("Client ID for AzureRm")
-          param :secret_key, String, :desc => N_("Client Secret for AzureRm")
-          param :sub_id, String, :desc => N_("Subscription ID for AzureRm")
-          param :cloud, String, :desc => N_("Cloud")
+          param :app_ident, String, desc: N_('Client ID for AzureRm')
+          param :secret_key, String, desc: N_('Client Secret for AzureRm')
+          param :sub_id, String, desc: N_('Subscription ID for AzureRm')
+          param :cloud, String, desc: N_('Cloud')
         end
       end
 
       def available_resource_groups
         compute_resource = ComputeResource.find_by_id(params[:id])
         @available_resource_groups = compute_resource.available_resource_groups
-        render :available_resource_groups, :layout => 'api/v2/layouts/index_layout'
+        render :available_resource_groups, layout: 'api/v2/layouts/index_layout'
       end
 
       def available_sizes
         compute_resource = ComputeResource.find_by_id(params[:id])
         @available_sizes = compute_resource.vm_sizes(params[:region_id])
-        render :available_sizes, :layout => 'api/v2/layouts/index_layout'
+        render :available_sizes, layout: 'api/v2/layouts/index_layout'
       end
 
       def available_subnets
         compute_resource = ComputeResource.find_by_id(params[:id])
         @available_subnets = compute_resource.available_subnets
-        render :available_subnets, :layout => 'api/v2/layouts/index_layout'
+        render :available_subnets, layout: 'api/v2/layouts/index_layout'
       end
 
       def available_vnets
         compute_resource = ComputeResource.find_by_id(params[:id])
         @available_vnets = compute_resource.available_vnets
-        render :available_vnets, :layout => 'api/v2/layouts/index_layout'
+        render :available_vnets, layout: 'api/v2/layouts/index_layout'
       end
 
       def action_permission
         case params[:action]
-          when 'available_resource_groups', 'available_sizes', 'available_subnets', 'available_vnets'
-            :view
-          else
-            super
+        when 'available_resource_groups', 'available_sizes', 'available_subnets', 'available_vnets'
+          :view
+        else
+          super
         end
       end
     end
   end
-end
+end

app/controllers/foreman_azure_rm/concerns/hosts_controller_extensions.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ForemanAzureRm
   module Concerns
     module HostsControllerExtensions
@@ -6,10 +8,10 @@ module HostsControllerExtensions
       def sizes
         azure_rm_resource = ComputeResource.unscoped.find_by_id(params[:compute_resource_id])
         if azure_rm_resource.present?
-          render :json => azure_rm_resource.vm_sizes.map { |size| size.name }
+          render json: azure_rm_resource.vm_sizes.map(&:name)
         else
           no_sizes = _('The region you selected has no sizes associated with it')
-          render :json => "[\"#{no_sizes}\"]"
+          render json: "[\"#{no_sizes}\"]"
         end
       end
 
@@ -18,14 +20,14 @@ def subnets
         if azure_rm_resource.present?
           subnets = azure_rm_resource.subnets
           if subnets.present?
-            render :json => subnets
+            render json: subnets
           else
             no_subnets = _('The selected region has no subnets')
-            render :json => "[\"#{no_subnets}\"]"
+            render json: "[\"#{no_subnets}\"]"
           end
         else
           no_compute = _('The selected image has no associated compute resource')
-          render :json => "[\"#{no_compute}\"]"
+          render json: "[\"#{no_compute}\"]"
         end
       end
     end

app/helpers/azure_compute_resource_helper.rb

@@ -1,16 +1,20 @@
+# frozen_string_literal: true
+
 module AzureComputeResourceHelper
   def regions_list(azurerm_cr, f)
     begin
       regions = azurerm_cr.regions || []
     rescue StandardError
-      #do nothing
+      # do nothing
       regions = []
-    rescue Exception => ex
-      return information_box("Regions could not be loaded due to exception: #{ex}")
+    rescue Exception => e
+      return information_box("Regions could not be loaded due to exception: #{e}")
     end
-    selectable_f(f, :url, regions, {}, {:label => _('Azure Region'), :disabled => regions.empty?, :required => true, :help_inline_permanent => load_button_f(f, regions.present?, _("Load Regions")) })
+    selectable_f(f, :url, regions, {},
+                 { label: _('Azure Region'), disabled: regions.empty?, required: true, help_inline_permanent: load_button_f(f, regions.present?, _('Load Regions')) })
   end
+
   def azure_doc_version
-    doc_version = Foreman::Plugin.find(:foreman_azure_rm).version.scan(/\d+\.\d+/).first + '.x'
+    doc_version = "#{Foreman::Plugin.find(:foreman_azure_rm).version.scan(/\d+\.\d+/).first}.x"
   end
 end