cookstyle 6.15.9 → 6.17.5

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

@@ -32,7 +32,8 @@ module RuboCop
         #  # good
         #  resource_name :create
 
-        class ResourceNameFromInitialize < Cop
+        class ResourceNameFromInitialize < Base
+          extend AutoCorrector
           include RangeHelp
 
           MSG = 'The name of a resource can be set with the "resource_name" helper instead of using the initialize method.'
@@ -42,24 +43,19 @@ module RuboCop
             return if node.body.nil? # nil body is an empty initialize method
 
             node.body.each_node do |x|
-              if x.assignment? && !x.node_parts.empty? && x.node_parts.first == :@resource_name
-                add_offense(x, location: :expression, message: MSG, severity: :refactor)
+              next unless x.assignment? && !x.node_parts.empty? && x.node_parts.first == :@resource_name
+
+              add_offense(x, message: MSG, severity: :refactor) do |corrector|
+                # insert the new resource_name call above the initialize method
+                initialize_node = initialize_method(processed_source.ast).first
+                corrector.insert_before(initialize_node.source_range, "resource_name #{x.descendants.first.source}\n\n")
+                # remove the variable from the initialize method
+                corrector.remove(range_with_surrounding_space(range: x.loc.expression, side: :left))
               end
             end
           end
 
           def_node_search :initialize_method, '(def :initialize ... )'
-
-          def autocorrect(node)
-            lambda do |corrector|
-              # insert the new resource_name call above the initialize method
-              initialize_node = initialize_method(processed_source.ast).first
-              corrector.insert_before(initialize_node.source_range, "resource_name #{node.descendants.first.source}\n\n")
-
-              # remove the variable from the initialize method
-              corrector.remove(range_with_surrounding_space(range: node.loc.expression, side: :left))
-            end
-          end
         end
       end
     end

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

@@ -38,13 +38,12 @@ module RuboCop
         #   # good
         #   property :severity, String
         #
-        class SetOrReturnInResources < Cop
+        class SetOrReturnInResources < Base
           MSG = 'Do not use set_or_return within a method to define a property for a resource. Use the property method instead, which supports validation, reporting, and documentation functionality'
+          RESTRICT_ON_SEND = [:set_or_return].freeze
 
           def on_send(node)
-            if node.method_name == :set_or_return
-              add_offense(node, location: :expression, message: MSG, severity: :refactor)
-            end
+            add_offense(node, message: MSG, severity: :refactor)
           end
         end
       end

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

@@ -40,8 +40,11 @@ module RuboCop
         #     # some action code because we're in a custom resource
         #   end
         #
-        class CustomResourceWithAttributes < Cop
+        class CustomResourceWithAttributes < Base
+          extend AutoCorrector
+
           MSG = 'Custom Resources should contain properties not attributes'
+          RESTRICT_ON_SEND = [:attribute].freeze
 
           def_node_matcher :attribute?, <<-PATTERN
             (send nil? $:attribute ... )
@@ -52,14 +55,11 @@ module RuboCop
           PATTERN
 
           def on_send(node)
+            return unless resource_actions?(processed_source.ast)
             attribute?(node) do
-              add_offense(node, location: :selector, message: MSG, severity: :refactor) if resource_actions?(processed_source.ast)
-            end
-          end
-
-          def autocorrect(node)
-            lambda do |corrector|
-              corrector.replace(node.loc.selector, 'property')
+              add_offense(node.loc.selector, message: MSG, severity: :refactor) do |corrector|
+                corrector.replace(node.loc.selector, 'property')
+              end
             end
           end
         end

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

@@ -43,8 +43,9 @@ module RuboCop
         #     action :nothing
         #   end
         #
-        class RespondToCompileTime < Cop
+        class RespondToCompileTime < Base
           extend TargetChefVersion
+          extend AutoCorrector
 
           minimum_target_chef_version '12.1'
 
@@ -75,14 +76,8 @@ module RuboCop
           PATTERN
 
           def on_if(node)
-            compile_time_method_defined?(node) do
-              add_offense(node, location: :expression, message: MSG, severity: :refactor)
-            end
-          end
-
-          def autocorrect(node)
-            lambda do |corrector|
-              compile_time_method_defined?(node) do |val|
+            compile_time_method_defined?(node) do |val|
+              add_offense(node, message: MSG, severity: :refactor) do |corrector|
                 corrector.replace(node.loc.expression, "compile_time #{val.source}")
               end
             end

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

@@ -34,7 +34,8 @@ module RuboCop
         #   # good
         #   chef_version '>= 13'
         #
-        class RespondToInMetadata < Cop
+        class RespondToInMetadata < Base
+          extend AutoCorrector
           extend TargetChefVersion
 
           minimum_target_chef_version '12.15'
@@ -43,30 +44,33 @@ module RuboCop
 
           def on_if(node)
             if_respond_to?(node) do
-              add_offense(node, location: :expression, message: MSG, severity: :refactor)
+              add_offense(node, message: MSG, severity: :refactor) do |corrector|
+                # When the if statement is if modifier like `foo if respond_to?(:foo)` then
+                # node.if_branch is the actual method call we want to extract.
+                # If a series of metadata methods are wrapped in an if statement then the content we want
+                # is a block under the if statement and node.parent.if_branch can get us that block
+                node = node.parent unless node.if_type?
+
+                corrector.replace(node.loc.expression, node.if_branch.source)
+              end
             end
           end
 
           def on_defined?(node)
-            node = node.parent if node.parent.if? # we want the whole if statement
-            add_offense(node, location: :expression, message: MSG, severity: :refactor)
+            # When the if statement is if modifier like `foo if respond_to?(:foo)` then
+            # node.if_branch is the actual method call we want to extract.
+            # If a series of metadata methods are wrapped in an if statement then the content we want
+            # is a block under the if statement and node.parent.if_branch can get us that block
+
+            node = node.parent if node.parent.if? && !node.if_type? # we want the whole if statement
+            add_offense(node, message: MSG, severity: :refactor) do |corrector|
+              corrector.replace(node.loc.expression, node.if_branch.source)
+            end
           end
 
           def_node_matcher :if_respond_to?, <<~PATTERN
           (if (send nil? :respond_to? _ ) ... )
           PATTERN
-
-          def autocorrect(node)
-            lambda do |corrector|
-              # When the if statement is if modifier like `foo if respond_to?(:foo)` then
-              # node.if_branch is the actual method call we want to extract.
-              # If a series of metadata methods are wrapped in an if statement then the content we want
-              # is a block under the if statement and node.parent.if_branch can get us that block
-              node = node.parent unless node.if_type?
-
-              corrector.replace(node.loc.expression, node.if_branch.source)
-            end
-          end
         end
       end
     end

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

@@ -31,12 +31,16 @@ module RuboCop
         #   # good
         #   provides :foo
         #
-        class RespondToProvides < Cop
+        class RespondToProvides < Base
+          extend AutoCorrector
+
           MSG = 'Using `respond_to?(:provides)` or `if defined? provides` in resources is no longer necessary in Chef Infra Client 12+.'
 
           def on_if(node)
             if_respond_to_provides?(node) do
-              add_offense(node, location: :expression, message: MSG, severity: :refactor)
+              add_offense(node, message: MSG, severity: :refactor) do |corrector|
+                corrector.replace(node.loc.expression, node.children[1].source)
+              end
             end
           end
 
@@ -52,12 +56,6 @@ module RuboCop
             (send nil? :provides
               (sym _)) ... )
           PATTERN
-
-          def autocorrect(node)
-            lambda do |corrector|
-              corrector.replace(node.loc.expression, node.children[1].source)
-            end
-          end
         end
       end
     end

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

@@ -29,24 +29,22 @@ module RuboCop
         #   # good
         #   resource_name :foo
         #
-        class RespondToResourceName < Cop
+        class RespondToResourceName < Base
+          extend AutoCorrector
+
           MSG = 'respond_to?(:resource_name) in resources is no longer necessary in Chef Infra Client 12.5+'
 
           def on_if(node)
             if_respond_to_resource_name?(node) do
-              add_offense(node, location: :expression, message: MSG, severity: :refactor)
+              add_offense(node, message: MSG, severity: :refactor) do |corrector|
+                corrector.replace(node.loc.expression, node.children[1].source)
+              end
             end
           end
 
           def_node_matcher :if_respond_to_resource_name?, <<~PATTERN
           (if (send nil? :respond_to? ( :sym :resource_name ) ) ... )
           PATTERN
-
-          def autocorrect(node)
-            lambda do |corrector|
-              corrector.replace(node.loc.expression, node.children[1].source)
-            end
-          end
         end
       end
     end

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

@@ -39,9 +39,10 @@ module RuboCop
           minimum_target_chef_version '14.0'
 
           MSG = 'Chef Infra Client 14.0 and later includes :create, :delete, and :configure actions without the need for the sc cookbook dependency. See the windows_service documentation at https://docs.chef.io/resource_windows_service.html for additional details.'
+          RESTRICT_ON_SEND = [:sc_windows].freeze
 
           def on_send(node)
-            add_offense(node, location: :expression, message: MSG, severity: :refactor) if node.method_name == :sc_windows
+            add_offense(node, message: MSG, severity: :refactor)
           end
         end
       end

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

@@ -29,15 +29,16 @@ module RuboCop
         #     path 'C:\expand_here'
         #   end
         #
-        class SevenZipArchiveResource < Cop
+        class SevenZipArchiveResource < Base
           extend TargetChefVersion
 
           minimum_target_chef_version '15.0'
 
           MSG = 'Use the archive_file resource built into Chef Infra Client 15+ instead of the seven_zip_archive'
+          RESTRICT_ON_SEND = [:seven_zip_archive].freeze
 
           def on_send(node)
-            add_offense(node, location: :expression, message: MSG, severity: :refactor) if node.method_name == :seven_zip_archive
+            add_offense(node, message: MSG, severity: :refactor)
           end
         end
       end

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

@@ -30,7 +30,8 @@ module RuboCop
         #   # good
         #   shell_out('foo')
         #
-        class ShellOutHelper < Cop
+        class ShellOutHelper < Base
+          extend AutoCorrector
           extend TargetChefVersion
 
           minimum_target_chef_version '12.11'
@@ -46,14 +47,8 @@ module RuboCop
           PATTERN
 
           def on_send(node)
-            mixlib_shellout_run_cmd?(node) do
-              add_offense(node, location: :expression, message: MSG, severity: :refactor)
-            end
-          end
-
-          def autocorrect(node)
             mixlib_shellout_run_cmd?(node) do |cmd|
-              lambda do |corrector|
+              add_offense(node, message: MSG, severity: :refactor) do |corrector|
                 corrector.replace(node.loc.expression, "shell_out(#{cmd.loc.expression.source})")
               end
             end

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 → sysctl_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.'
+          RESTRICT_ON_SEND = [:sysctl_param].freeze
 
           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|
+            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,10 +27,12 @@ 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.'
+          RESTRICT_ON_SEND = [:require].freeze
 
           def_node_matcher :require_mixlibshellout?, <<-PATTERN
           (send nil? :require ( str "mixlib/shellout"))
@@ -38,13 +40,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

@@ -33,7 +33,9 @@ module RuboCop
         #   # good
         #   package %w(bmon htop vim curl)
         #
-        class UseMultipackageInstalls < Cop
+        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
 
@@ -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