cookstyle 6.13.3 → 6.16.4

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

@@ -43,10 +43,11 @@ module RuboCop
         #     code "mkdir C:\mydir"
         #   end
         #
-        class PowerShellGuardInterpreter < Cop
+        class PowerShellGuardInterpreter < Base
           include RuboCop::Chef::CookbookHelpers
           include RangeHelp
           extend TargetChefVersion
+          extend AutoCorrector
 
           minimum_target_chef_version '13.0'
 
@@ -54,17 +55,12 @@ module RuboCop
 
           def on_block(node)
             match_property_in_resource?(%i(powershell_script batch), 'guard_interpreter', node) do |interpreter|
-              if interpreter.arguments.first.source == ':powershell_script'
-                add_offense(interpreter, location: :expression, message: MSG, severity: :refactor)
+              return unless interpreter.arguments.first.source == ':powershell_script'
+              add_offense(interpreter, message: MSG, severity: :refactor) do |corrector|
+                corrector.remove(range_with_surrounding_space(range: interpreter.loc.expression, side: :left))
               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/modernize/powershell_install_package.rb

@@ -32,7 +32,7 @@ module RuboCop
         #  # good
         #  powershell_package 'docker'
         #
-        class PowershellInstallPackage < Cop
+        class PowershellInstallPackage < Base
           include RuboCop::Chef::CookbookHelpers
           extend TargetChefVersion
 
@@ -43,9 +43,8 @@ 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?(/^install-package\s/i)
-                add_offense(node, location: :expression, message: MSG, severity: :refactor)
-              end
+              return unless property_data && property_data.match?(/^install-package\s/i)
+              add_offense(node, message: MSG, severity: :refactor)
             end
           end
         end

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

@@ -35,7 +35,7 @@ module RuboCop
         #    install_method :windows_feature_powershell
         #  end
         #
-        class PowershellInstallWindowsFeature < Cop
+        class PowershellInstallWindowsFeature < Base
           include RuboCop::Chef::CookbookHelpers
           extend TargetChefVersion
 
@@ -46,9 +46,8 @@ 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?(/^(install|add)-windowsfeature\s/i)
-                add_offense(node, location: :expression, message: MSG, severity: :refactor)
-              end
+              return unless property_data && property_data.match?(/^(install|add)-windowsfeature\s/i)
+              add_offense(node, message: MSG, severity: :refactor)
             end
           end
         end

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

@@ -29,7 +29,9 @@ module RuboCop
         #   # good
         #   property :bob, String, name_property: true
         #
-        class PropertyWithNameAttribute < Cop
+        class PropertyWithNameAttribute < Base
+          extend AutoCorrector
+
           MSG = 'Resource property sets name_attribute instead of name_property'
 
           # match on a property that has any name and any type and a hash that
@@ -40,14 +42,8 @@ module RuboCop
           PATTERN
 
           def on_send(node)
-            property_with_name_attribute?(node) do
-              add_offense(node, location: :expression, message: MSG, severity: :refactor)
-            end
-          end
-
-          def autocorrect(node)
-            lambda do |corrector|
-              property_with_name_attribute?(node) do |name_attribute|
+            property_with_name_attribute?(node) do |name_attribute|
+              add_offense(node, message: MSG, severity: :refactor) do |corrector|
                 corrector.replace(name_attribute.loc.expression, 'name_property: true')
               end
             end

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

@@ -32,8 +32,9 @@ module RuboCop
         #   # good
         #   provides :foo
         #
-        class ProvidesFromInitialize < Cop
+        class ProvidesFromInitialize < Base
           include RangeHelp
+          extend AutoCorrector
 
           MSG = 'Provides should be set using the `provides` resource DSL method instead of instead of setting @provides in the initialize method.'
 
@@ -43,26 +44,23 @@ module RuboCop
 
           def on_ivasgn(node)
             provides_assignment?(node) do
-              add_offense(node, location: :expression, message: MSG, severity: :refactor) if intialize_method(node.parent.parent).any?
+              return unless initialize_method(node.parent.parent).any?
+              add_offense(node, message: MSG, severity: :refactor) do |corrector|
+                # insert the new provides call above the initialize method, but not if one already exists (this is sadly common)
+                unless provides_method?(processed_source.ast)
+                  initialize_node = initialize_method(processed_source.ast).first
+                  corrector.insert_before(initialize_node.source_range, "provides #{node.descendants.first.source}\n\n")
+                end
+
+                # remove the variable from the initialize method
+                corrector.remove(range_with_surrounding_space(range: node.loc.expression, side: :left))
+              end
             end
           end
 
           def_node_search :provides_method?, '(send nil? :provides ... )'
 
-          def_node_search :intialize_method, '(def :initialize ... )'
-
-          def autocorrect(node)
-            lambda do |corrector|
-              # insert the new provides call above the initialize method, but not if one already exists (this is sadly common)
-              unless provides_method?(processed_source.ast)
-                initialize_node = intialize_method(processed_source.ast).first
-                corrector.insert_before(initialize_node.source_range, "provides #{node.descendants.first.source}\n\n")
-              end
-
-              # remove the variable from the initialize method
-              corrector.remove(range_with_surrounding_space(range: node.loc.expression, side: :left))
-            end
-          end
+          def_node_search :initialize_method, '(def :initialize ... )'
         end
       end
     end

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 :intialize_method, '(def :initialize ... )'
-
-          def autocorrect(node)
-            lambda do |corrector|
-              # insert the new resource_name call above the initialize method
-              initialize_node = intialize_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
+          def_node_search :initialize_method, '(def :initialize ... )'
         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'
 
           def on_send(node)
-            if node.method_name == :set_or_return
-              add_offense(node, location: :expression, message: MSG, severity: :refactor)
-            end
+            return unless node.method_name == :set_or_return
+            add_offense(node, message: MSG, severity: :refactor)
           end
         end
       end

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

@@ -40,7 +40,9 @@ 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'
 
           def_node_matcher :attribute?, <<-PATTERN
@@ -52,14 +54,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

@@ -41,7 +41,7 @@ module RuboCop
           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.'
 
           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) if node.method_name == :sc_windows
           end
         end
       end

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

@@ -29,7 +29,7 @@ module RuboCop
         #     path 'C:\expand_here'
         #   end
         #
-        class SevenZipArchiveResource < Cop
+        class SevenZipArchiveResource < Base
           extend TargetChefVersion
 
           minimum_target_chef_version '15.0'
@@ -37,7 +37,7 @@ module RuboCop
           MSG = 'Use the archive_file resource built into Chef Infra Client 15+ instead of the seven_zip_archive'
 
           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) if node.method_name == :seven_zip_archive
           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