cookstyle 6.13.3 → 6.16.4

data/lib/rubocop/cop/chef/modernize/shellouts_to_chocolatey.rb

@@ -33,7 +33,7 @@ module RuboCop
         #    not_if 'choco source list | findstr artifactory'
         #  end
         #
-        class ShellOutToChocolatey < Cop
+        class ShellOutToChocolatey < Base
           include RuboCop::Chef::CookbookHelpers
 
           MSG = 'Use the Chocolatey resources built into Chef Infra Client instead of shelling out to the choco command'
@@ -41,16 +41,14 @@ module RuboCop
           def on_block(node)
             match_property_in_resource?(:powershell_script, 'code', node) do |code_property|
               property_data = method_arg_ast_to_string(code_property)
-              if property_data && property_data.match?(/^choco /i)
-                add_offense(node, location: :expression, message: MSG, severity: :refactor)
-              end
+              next unless property_data && property_data.match?(/^choco /i)
+              add_offense(node, message: MSG, severity: :refactor)
             end
 
             match_property_in_resource?(:execute, 'command', node) do |code_property|
               property_data = method_arg_ast_to_string(code_property)
-              if property_data && property_data.match?(/^choco /i)
-                add_offense(node, location: :expression, message: MSG, severity: :refactor)
-              end
+              next unless property_data && property_data.match?(/^choco /i)
+              add_offense(node, message: MSG, severity: :refactor)
             end
           end
         end

data/lib/rubocop/cop/chef/modernize/simplify_apt_ppa_setup.rb

@@ -40,7 +40,8 @@ module RuboCop
         #      key 'C2518248EEA14886'
         #    end
         #
-        class SimplifyAptPpaSetup < Cop
+        class SimplifyAptPpaSetup < Base
+          extend AutoCorrector
           include RangeHelp
           include RuboCop::Chef::CookbookHelpers
 
@@ -49,15 +50,10 @@ module RuboCop
           def on_block(node)
             match_property_in_resource?(:apt_repository, 'uri', node) do |uri|
               if %r{http(s)*://ppa.launchpad.net/(.*)/ubuntu$}.match?(uri.arguments&.first&.str_content)
-                add_offense(uri, location: :expression, message: MSG, severity: :refactor)
-              end
-            end
-          end
-
-          def autocorrect(node)
-            if (replacement_val = %r{http(s)*://ppa.launchpad.net/(.*)/ubuntu}.match(node.source)[2])
-              lambda do |corrector|
-                corrector.replace(node.loc.expression, "uri 'ppa:#{replacement_val}'")
+                add_offense(uri, message: MSG, severity: :refactor) do |corrector|
+                  next unless (replacement_val = %r{http(s)*://ppa.launchpad.net/(.*)/ubuntu}.match(node.source)[2])
+                  corrector.replace(uri.loc.expression, "uri 'ppa:#{replacement_val}'")
+                end
               end
             end
           end

data/lib/rubocop/cop/chef/modernize/systctl_param_resource.rb

@@ -31,20 +31,18 @@ module RuboCop
         #     value '1048576'
         #   end
         #
-        class SysctlParamResource < Cop
+        class SysctlParamResource < Base
           include RuboCop::Chef::CookbookHelpers
           extend TargetChefVersion
+          extend AutoCorrector
 
           minimum_target_chef_version '14.0'
 
           MSG = 'The sysctl_param resource was renamed to sysctl when it was added to Chef Infra Client 14.0. The new resource name should be used.'
 
           def on_send(node)
-            add_offense(node, location: :expression, message: MSG, severity: :refactor) if node.method_name == :sysctl_param
-          end
-
-          def autocorrect(node)
-            lambda do |corrector|
+            return unless node.method_name == :sysctl_param
+            add_offense(node, message: MSG, severity: :refactor) do |corrector|
               corrector.replace(node.loc.expression, node.source.gsub(/^sysctl_param/, 'sysctl'))
             end
           end

data/lib/rubocop/cop/chef/modernize/unnecessary_mixlib_shellout_require.rb

@@ -27,7 +27,8 @@ module RuboCop
         #   # bad
         #   require 'mixlib/shellout'
         #
-        class UnnecessaryMixlibShelloutRequire < Cop
+        class UnnecessaryMixlibShelloutRequire < Base
+          extend AutoCorrector
           include RangeHelp
 
           MSG = 'Chef Infra Client 12.4+ includes mixlib/shellout automatically in resources and providers.'
@@ -38,13 +39,9 @@ module RuboCop
 
           def on_send(node)
             require_mixlibshellout?(node) do
-              add_offense(node, location: :expression, message: MSG, severity: :refactor)
-            end
-          end
-
-          def autocorrect(node)
-            lambda do |corrector|
-              corrector.remove(range_with_surrounding_space(range: node.loc.expression, side: :left))
+              add_offense(node, message: MSG, severity: :refactor) do |corrector|
+                corrector.remove(range_with_surrounding_space(range: node.loc.expression, side: :left))
+              end
             end
           end
         end

data/lib/rubocop/cop/chef/modernize/use_multipackage_installs.rb

@@ -19,7 +19,7 @@ module RuboCop
   module Cop
     module Chef
       module ChefModernize
-        # Pass an array of packages to package resources instead of interating over an array of packages when using multi-package capable package subystem such as apt, yum, chocolatey, dnf, or zypper. Multipackage installs are faster and simplify logs.
+        # Pass an array of packages to package resources instead of iterating over an array of packages when using multi-package capable package subsystem such as apt, yum, chocolatey, dnf, or zypper. Multi-package installs are faster and simplify logs.
         #
         # @example
         #
@@ -33,8 +33,10 @@ module RuboCop
         #   # good
         #   package %w(bmon htop vim curl)
         #
-        class UseMultipackageInstalls < Cop
-          MSG = 'Pass an array of packages to package resources instead of interating over an array of packages when using multi-package capable package subystem such as apt, yum, chocolatey, dnf, or zypper. Multipackage installs are faster and simplify logs.'
+        class UseMultipackageInstalls < Base
+          extend AutoCorrector
+
+          MSG = 'Pass an array of packages to package resources instead of iterating over an array of packages when using multi-package capable package subsystem such as apt, yum, chocolatey, dnf, or zypper. Multi-package installs are faster and simplify logs.'
           MULTIPACKAGE_PLATS = %w(debian redhat suse amazon fedora scientific oracle rhel ubuntu centos redhat).freeze
 
           def_node_matcher :platform_or_platform_family?, <<-PATTERN
@@ -73,7 +75,7 @@ module RuboCop
                   (lvar _))})
           PATTERN
 
-          # see if all platforms in the when condition are multipackage compliant
+          # see if all platforms in the when condition are multi-package compliant
           def multipackage_platforms?(condition_obj)
             condition_obj.all? do |p|
               MULTIPACKAGE_PLATS.include?(p.value)
@@ -81,22 +83,21 @@ module RuboCop
           end
 
           def on_when(node)
-            if platform_or_platform_family?(node.parent.condition) &&
-               package_array_install?(node.body) &&
-               multipackage_platforms?(node.conditions)
-              add_offense(node.body, location: :expression, message: MSG, severity: :refactor)
-            end
+            return unless platform_or_platform_family?(node.parent.condition) &&
+                          package_array_install?(node.body) &&
+                          multipackage_platforms?(node.conditions)
+            check_offense(node.body)
           end
 
           def on_if(node)
             platform_helper?(node) do |plats, blk, _pkgs|
-              add_offense(blk, location: :expression, message: MSG, severity: :refactor) if multipackage_platforms?(plats)
+              check_offense(blk) if multipackage_platforms?(plats)
             end
           end
 
-          def autocorrect(node)
-            package_array_install?(node) do |vals|
-              lambda do |corrector|
+          def check_offense(node)
+            add_offense(node, message: MSG, severity: :refactor) do |corrector|
+              package_array_install?(node) do |vals|
                 corrector.replace(node.loc.expression, "package #{vals.source}")
               end
             end

data/lib/rubocop/cop/chef/modernize/use_require_relative.rb

@@ -29,7 +29,9 @@ module RuboCop
         #   # good
         #   require_relative '../libraries/helpers'
         #
-        class UseRequireRelative < Cop
+        class UseRequireRelative < Base
+          extend AutoCorrector
+
           MSG = 'Instead of using require with a File.expand_path and __FILE__ use the simpler require_relative method.'
 
           def_node_matcher :require_with_expand_path?, <<-PATTERN
@@ -41,14 +43,9 @@ module RuboCop
           PATTERN
 
           def on_send(node)
-            require_with_expand_path?(node) do |_file, path|
-              add_offense(node, location: :expression, message: MSG, severity: :refactor) if path.source == '__FILE__'
-            end
-          end
-
-          def autocorrect(node)
-            lambda do |corrector|
-              require_with_expand_path?(node) do |file, _path|
+            require_with_expand_path?(node) do |file, path|
+              return unless path.source == '__FILE__'
+              add_offense(node, message: MSG, severity: :refactor) do |corrector|
                 corrected_value = file.value
                 corrected_value.slice!(%r{^../}) # take the first ../ off the path
                 corrector.replace(node.loc.expression, "require_relative '#{corrected_value}'")

data/lib/rubocop/cop/chef/modernize/whyrun_supported_true.rb

@@ -28,8 +28,9 @@ module RuboCop
         #    true
         #   end
         #
-        class WhyRunSupportedTrue < Cop
+        class WhyRunSupportedTrue < Base
           extend TargetChefVersion
+          extend AutoCorrector
           include RangeHelp
 
           minimum_target_chef_version '13.0'
@@ -45,13 +46,9 @@ module RuboCop
 
           def on_def(node)
             whyrun_true?(node) do
-              add_offense(node, location: :expression, message: MSG, severity: :refactor)
-            end
-          end
-
-          def autocorrect(node)
-            lambda do |corrector|
-              corrector.remove(range_with_surrounding_space(range: node.loc.expression, side: :left))
+              add_offense(node, message: MSG, severity: :refactor) do |corrector|
+                corrector.remove(range_with_surrounding_space(range: node.loc.expression, side: :left))
+              end
             end
           end
         end

data/lib/rubocop/cop/chef/modernize/windows_default_recipe.rb

@@ -27,8 +27,9 @@ module RuboCop
         #   include_recipe 'windows::default'
         #   include_recipe 'windows'
         #
-        class IncludingWindowsDefaultRecipe < Cop
+        class IncludingWindowsDefaultRecipe < Base
           include RangeHelp
+          extend AutoCorrector
 
           MSG = 'Do not include the Windows default recipe, which only installs win32 gems already included in Chef Infra Client'
 
@@ -38,13 +39,9 @@ module RuboCop
 
           def on_send(node)
             windows_recipe_usage?(node) do
-              add_offense(node, location: :expression, message: MSG, severity: :refactor)
-            end
-          end
-
-          def autocorrect(node)
-            lambda do |corrector|
-              corrector.remove(range_with_surrounding_space(range: node.loc.expression, side: :left))
+              add_offense(node, message: MSG, severity: :refactor) do |corrector|
+                corrector.remove(range_with_surrounding_space(range: node.loc.expression, side: :left))
+              end
             end
           end
         end

data/lib/rubocop/cop/chef/modernize/windows_registry_uac.rb

@@ -47,22 +47,21 @@ module RuboCop
 
           # non block execute resources
           def on_send(node)
-            return unless node.method_name == :registry_key
+            return unless node.method_name == :registry_key &&
+                          node&.arguments.first&.source.match?(/(HKLM|HKEY_LOCAL_MACHINE)\\SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\Policies\\System/i) &&
+                          node.parent&.method_name != :describe
 
             # use source instead of .value in case there's string interpolation which adds a complex dstr type
             # with a nested string and a begin. Source allows us to avoid a lot of defensive programming here
-            if node&.arguments.first&.source.match?(/(HKLM|HKEY_LOCAL_MACHINE)\\SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\Policies\\System/i) && node.parent&.method_name != :describe
-              add_offense(node, location: :expression, message: MSG, severity: :refactor)
-            end
+            add_offense(node, location: :expression, message: MSG, severity: :refactor)
           end
 
           # block execute resources
           def on_block(node)
             match_property_in_resource?(:registry_key, 'key', node) do |key_prop|
               property_data = method_arg_ast_to_string(key_prop)
-              if property_data && property_data.match?(/(HKLM|HKEY_LOCAL_MACHINE)\\SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\Policies\\System/i)
-                add_offense(node, location: :expression, message: MSG, severity: :refactor)
-              end
+              return unless property_data && property_data.match?(/(HKLM|HKEY_LOCAL_MACHINE)\\SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\Policies\\System/i)
+              add_offense(node, location: :expression, message: MSG, severity: :refactor)
             end
           end
         end

data/lib/rubocop/cop/chef/modernize/windows_zipfile.rb

@@ -28,7 +28,7 @@ module RuboCop
         #     source 'C:\\Temp\\file.zip'
         #   end
         #
-        class WindowsZipfileUsage < Cop
+        class WindowsZipfileUsage < Base
           extend TargetChefVersion
 
           minimum_target_chef_version '15.0'
@@ -36,7 +36,7 @@ module RuboCop
           MSG = 'Use the archive_file resource built into Chef Infra Client 15+ instead of the windows_zipfile from the Windows cookbook'
 
           def on_send(node)
-            add_offense(node, location: :expression, message: MSG, severity: :refactor) if node.method_name == :windows_zipfile
+            add_offense(node, message: MSG, severity: :refactor) if node.method_name == :windows_zipfile
           end
         end
       end

data/lib/rubocop/cop/chef/modernize/zipfile_resource.rb

@@ -29,7 +29,7 @@ module RuboCop
         #     path 'C:\expand_here'
         #   end
         #
-        class ZipfileResource < Cop
+        class ZipfileResource < Base
           include RuboCop::Chef::CookbookHelpers
           extend TargetChefVersion
 
@@ -43,13 +43,13 @@ module RuboCop
 
           def on_send(node)
             depends_zipfile?(node) do
-              add_offense(node, location: :expression, message: MSG, severity: :refactor)
+              add_offense(node, message: MSG, severity: :refactor)
             end
           end
 
           def on_block(node)
             match_resource_type?(:zipfile, node) do
-              add_offense(node, location: :expression, message: MSG, severity: :refactor)
+              add_offense(node, message: MSG, severity: :refactor)
             end
           end
         end

data/lib/rubocop/cop/chef/modernize/zypper_repo.rb

@@ -39,19 +39,17 @@ module RuboCop
         #     priority '100'
         #   end
         #
-        class UsesZypperRepo < Cop
+        class UsesZypperRepo < Base
           extend TargetChefVersion
+          extend AutoCorrector
 
           minimum_target_chef_version '13.3'
 
           MSG = 'The zypper_repo resource was renamed zypper_repository when it was added to Chef Infra Client 13.3.'
 
           def on_send(node)
-            add_offense(node, location: :expression, message: MSG, severity: :refactor) if node.method_name == :zypper_repo
-          end
-
-          def autocorrect(node)
-            lambda do |corrector|
+            return unless node.method_name == :zypper_repo
+            add_offense(node, message: MSG, severity: :refactor) do |corrector|
               corrector.replace(node.loc.expression, node.source.gsub(/^zypper_repo/, 'zypper_repository'))
             end
           end

data/lib/rubocop/cop/chef/redundant/apt_repository_distribution_default.rb

@@ -36,9 +36,10 @@ module RuboCop
         #     deb_src false
         #   end
         #
-        class AptRepositoryDistributionDefault < Cop
+        class AptRepositoryDistributionDefault < Base
           include RuboCop::Chef::CookbookHelpers
           include RangeHelp
+          extend AutoCorrector
 
           MSG = "There is no need to pass `distribution node['lsb']['codename']` to an apt_repository resource as this is done automatically by the apt_repository resource."
 
@@ -49,16 +50,12 @@ module RuboCop
           def on_block(node)
             match_property_in_resource?(:apt_repository, 'distribution', node) do |dist|
               default_dist?(dist) do
-                add_offense(dist, location: :expression, message: MSG, severity: :refactor)
+                add_offense(dist, message: MSG, severity: :refactor) do |corrector|
+                  corrector.remove(range_with_surrounding_space(range: dist.loc.expression, side: :left))
+                end
               end
             end
           end
-
-          def autocorrect(node)
-            lambda do |corrector|
-              corrector.remove(range_with_surrounding_space(range: node.loc.expression, side: :left))
-            end
-          end
         end
       end
     end

data/lib/rubocop/cop/chef/redundant/apt_repository_notifies_apt_update.rb

@@ -36,21 +36,19 @@ module RuboCop
         #     deb_src false
         #   end
         #
-        class AptRepositoryNotifiesAptUpdate < Cop
+        class AptRepositoryNotifiesAptUpdate < Base
           include RuboCop::Chef::CookbookHelpers
           include RangeHelp
+          extend AutoCorrector
 
           MSG = 'There is no need to notify an apt-get update when an apt_repository is created as this is done automatically by the apt_repository resource.'
 
           def on_block(node)
             match_property_in_resource?(:apt_repository, 'notifies', node) do |notifies|
-              add_offense(notifies, location: :expression, message: MSG, severity: :refactor) if notifies.arguments[1] == s(:str, 'execute[apt-get update]')
-            end
-          end
-
-          def autocorrect(node)
-            lambda do |corrector|
-              corrector.remove(range_with_surrounding_space(range: node.loc.expression, side: :left))
+              return unless notifies.arguments[1] == s(:str, 'execute[apt-get update]')
+              add_offense(notifies, message: MSG, severity: :refactor) do |corrector|
+                corrector.remove(range_with_surrounding_space(range: notifies.loc.expression, side: :left))
+              end
             end
           end
         end

data/lib/rubocop/cop/chef/redundant/attribute_metadata.rb

@@ -33,18 +33,16 @@ module RuboCop
         #              required: 'optional',
         #              default: '"127.0.0.1:2181"'
         #
-        class AttributeMetadata < Cop
+        class AttributeMetadata < Base
           include RangeHelp
           include RuboCop::Chef::AutocorrectHelpers
+          extend AutoCorrector
 
           MSG = 'The attribute metadata.rb method is not used and is unnecessary in cookbooks.'
 
           def on_send(node)
-            add_offense(node, location: :expression, message: MSG, severity: :refactor) if node.method_name == :attribute
-          end
-
-          def autocorrect(node)
-            lambda do |corrector|
+            return unless node.method_name == :attribute
+            add_offense(node, message: MSG, severity: :refactor) do |corrector|
               corrector.remove(range_with_surrounding_space(range: expression_including_heredocs(node), side: :left))
             end
           end

data/lib/rubocop/cop/chef/redundant/conflicts_metadata.rb

@@ -28,17 +28,15 @@ module RuboCop
         #
         #   conflicts "another_cookbook"
         #
-        class ConflictsMetadata < Cop
+        class ConflictsMetadata < Base
           include RangeHelp
+          extend AutoCorrector
 
           MSG = 'The conflicts metadata.rb method is not used and is unnecessary in cookbooks.'
 
           def on_send(node)
-            add_offense(node, location: :expression, message: MSG, severity: :refactor) if node.method_name == :conflicts
-          end
-
-          def autocorrect(node)
-            lambda do |corrector|
+            return unless node.method_name == :conflicts
+            add_offense(node, message: MSG, severity: :refactor) do |corrector|
               corrector.remove(range_with_surrounding_space(range: node.loc.expression, side: :right))
             end
           end