cookstyle 6.15.9 → 6.16.4

data/lib/rubocop/cop/chef/effortless/search_for_environments_or_roles.rb

@@ -27,12 +27,13 @@ module RuboCop
         #   search(:node, 'chef_environment:foo')
         #   search(:node, 'role:bar')
         #
-        class SearchForEnvironmentsOrRoles < Cop
+        class SearchForEnvironmentsOrRoles < Base
           MSG = 'Cookbook uses search with a node query that looks for a role or environment'
 
           def on_send(node)
-            if node.method_name == :search && node.arguments[1]&.value&.match?(/chef_environment|role/)
-              add_offense(node, location: :expression, message: MSG, severity: :refactor)
+            if node.method_name == :search &&
+               node.arguments[1]&.value&.match?(/chef_environment|role/)
+              add_offense(node, message: MSG, severity: :refactor)
             end
           end
         end

data/lib/rubocop/cop/chef/effortless/search_used.rb

@@ -26,11 +26,11 @@ module RuboCop
         #   # bad
         #   search(:node, 'run_list:recipe\[bacula\:\:server\]')
         #
-        class CookbookUsesSearch < Cop
+        class CookbookUsesSearch < Base
           MSG = 'Cookbook uses search, which cannot be used in the Effortless Infra pattern'
 
           def on_send(node)
-            add_offense(node, location: :expression, message: MSG, severity: :refactor) if node.method_name == :search
+            add_offense(node, message: MSG, severity: :refactor) if node.method_name == :search
           end
         end
       end

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

@@ -38,8 +38,9 @@ module RuboCop
         #   # good
         #   allowed_actions [ :create, :add ]
         #
-        class AllowedActionsFromInitialize < Cop
+        class AllowedActionsFromInitialize < Base
           include RangeHelp
+          extend AutoCorrector
 
           MSG = 'The allowed actions of a resource can be set with the "allowed_actions" helper instead of using the initialize method.'
 
@@ -48,8 +49,20 @@ module RuboCop
             return if node.body.nil? # nil body is an empty initialize method
 
             node.body.each_node do |x|
-              if x.assignment? && !x.parent.op_asgn_type? && !x.node_parts.empty? && %i(@actions @allowed_actions).include?(x.node_parts.first)
-                add_offense(x, location: :expression, message: MSG, severity: :refactor)
+              next unless x.assignment? &&
+                          !x.parent.op_asgn_type? &&
+                          !x.node_parts.empty? &&
+                          %i(@actions @allowed_actions).include?(x.node_parts.first)
+
+              add_offense(x, message: MSG, severity: :refactor) do |corrector|
+                # insert the new allowed_actions call above the initialize method, but not if one already exists (this is sadly common)
+                unless action_methods?(processed_source.ast)
+                  initialize_node = initialize_method(processed_source.ast).first
+                  corrector.insert_before(initialize_node.source_range, "allowed_actions #{x.descendants.first.source}\n\n")
+                end
+
+                # remove the variable from the initialize method
+                corrector.remove(range_with_surrounding_space(range: x.loc.expression, side: :left))
               end
             end
           end
@@ -57,19 +70,6 @@ module RuboCop
           def_node_search :action_methods?, '(send nil? {:actions :allowed_actions} ... )'
 
           def_node_search :initialize_method, '(def :initialize ... )'
-
-          def autocorrect(node)
-            lambda do |corrector|
-              # insert the new allowed_actions call above the initialize method, but not if one already exists (this is sadly common)
-              unless action_methods?(processed_source.ast)
-                initialize_node = initialize_method(processed_source.ast).first
-                corrector.insert_before(initialize_node.source_range, "allowed_actions #{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
       end
     end

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

@@ -30,7 +30,7 @@ module RuboCop
         #   # good
         #   apt_update
         #
-        class IncludingAptDefaultRecipe < Cop
+        class IncludingAptDefaultRecipe < Base
           extend TargetChefVersion
 
           minimum_target_chef_version '12.7'
@@ -43,7 +43,7 @@ module RuboCop
 
           def on_send(node)
             apt_recipe_usage?(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/berksfile_source.rb

@@ -34,7 +34,9 @@ module RuboCop
         #   # good
         #   source 'https://supermarket.chef.io'
         #
-        class LegacyBerksfileSource < Cop
+        class LegacyBerksfileSource < Base
+          extend AutoCorrector
+
           MSG = 'Do not use legacy Berksfile community sources. Use Chef Supermarket instead.'
 
           def_node_matcher :berksfile_site?, <<-PATTERN
@@ -51,17 +53,15 @@ module RuboCop
 
           def on_send(node)
             berksfile_source?(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, "source 'https://supermarket.chef.io'")
+              end
             end
 
             berksfile_site?(node) do
-              add_offense(node, location: :expression, message: MSG, severity: :refactor)
-            end
-          end
-
-          def autocorrect(node)
-            lambda do |corrector|
-              corrector.replace(node.loc.expression, "source 'https://supermarket.chef.io'")
+              add_offense(node, message: MSG, severity: :refactor) do |corrector|
+                corrector.replace(node.loc.expression, "source 'https://supermarket.chef.io'")
+              end
             end
           end
         end

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

@@ -31,7 +31,9 @@ module RuboCop
         #   # good
         #   build_essential 'install compilation tools'
         #
-        class UseBuildEssentialResource < Cop
+        class UseBuildEssentialResource < Base
+          extend AutoCorrector
+
           MSG = 'Use the build_essential resource instead of the legacy build-essential recipe. This resource ships in the build-essential cookbook v5.0+ and is built into Chef Infra Client 14+'
 
           def_node_matcher :build_essential_recipe_usage?, <<-PATTERN
@@ -40,13 +42,9 @@ module RuboCop
 
           def on_send(node)
             build_essential_recipe_usage?(node) do
-              add_offense(node, location: :expression, message: MSG, severity: :refactor)
-            end
-          end
-
-          def autocorrect(node)
-            lambda do |corrector|
-              corrector.replace(node.loc.expression, "build_essential 'install compilation tools'")
+              add_offense(node, message: MSG, severity: :refactor) do |corrector|
+                corrector.replace(node.loc.expression, "build_essential 'install compilation tools'")
+              end
             end
           end
         end

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

@@ -32,7 +32,8 @@ module RuboCop
         #   depends 'swap'
         #   depends 'sysctl'
         #
-        class UnnecessaryDependsChef14 < Cop
+        class UnnecessaryDependsChef14 < Base
+          extend AutoCorrector
           extend TargetChefVersion
           include RangeHelp
 
@@ -46,13 +47,9 @@ module RuboCop
 
           def on_send(node)
             legacy_depends?(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/chef_gem_nokogiri.rb

@@ -27,7 +27,8 @@ module RuboCop
         #   # bad
         #   chef_gem 'nokogiri'
         #
-        class ChefGemNokogiri < Cop
+        class ChefGemNokogiri < Base
+          extend AutoCorrector
           include RangeHelp
           include RuboCop::Chef::CookbookHelpers
 
@@ -39,20 +40,20 @@ module RuboCop
 
           def on_block(node)
             match_property_in_resource?(:chef_gem, 'package_name', node) do |pkg_name|
-              add_offense(node, location: :expression, message: MSG, severity: :refactor) if pkg_name.arguments&.first&.str_content == 'nokogiri'
+              return unless pkg_name.arguments&.first&.str_content == 'nokogiri'
+              add_offense(node, message: MSG, severity: :refactor) do |corrector|
+                node = node.parent if node.parent&.block_type? # make sure we get the whole block not just the method in the block
+                corrector.remove(range_with_surrounding_space(range: node.loc.expression, side: :left))
+              end
             end
           end
 
           def on_send(node)
             nokogiri_install?(node) do
-              add_offense(node, location: :expression, message: MSG, severity: :refactor)
-            end
-          end
-
-          def autocorrect(node)
-            lambda do |corrector|
-              node = node.parent if node.parent&.block_type? # make sure we get the whole block not just the method in the block
-              corrector.remove(range_with_surrounding_space(range: node.loc.expression, side: :left))
+              add_offense(node, message: MSG, severity: :refactor) do |corrector|
+                node = node.parent if node.parent&.block_type? # make sure we get the whole block not just the method in the block
+                corrector.remove(range_with_surrounding_space(range: node.loc.expression, side: :left))
+              end
             end
           end
         end

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

@@ -33,7 +33,7 @@ module RuboCop
         #    compile_time true
         #   end
         #
-        class ResourceForcingCompileTime < Cop
+        class ResourceForcingCompileTime < Base
           MSG = "Set 'compile_time true' in resources when available instead of forcing resources to run at compile time by setting an action on the block."
 
           def_node_matcher :compile_time_resource?, <<-PATTERN
@@ -42,7 +42,7 @@ module RuboCop
 
           def on_send(node)
             compile_time_resource?(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/conditional_using_test.rb

@@ -29,7 +29,9 @@ module RuboCop
         #   # good
         #   only_if { ::File.exist?('bin/foo') }
         #
-        class ConditionalUsingTest < Cop
+        class ConditionalUsingTest < Base
+          extend AutoCorrector
+
           MSG = "Use ::File.exist?('/foo/bar') instead of the slower 'test -f /foo/bar' which requires shelling out"
 
           def_node_matcher :resource_conditional?, <<~PATTERN
@@ -38,13 +40,8 @@ module RuboCop
 
           def on_send(node)
             resource_conditional?(node) do |conditional|
-              add_offense(node, location: :expression, message: MSG, severity: :refactor) if conditional.value.match?(/^test -[ef] \S*$/)
-            end
-          end
-
-          def autocorrect(node)
-            lambda do |corrector|
-              resource_conditional?(node) do |conditional|
+              return unless conditional.value.match?(/^test -[ef] \S*$/)
+              add_offense(node, message: MSG, severity: :refactor) do |corrector|
                 new_string = "{ ::File.exist?('#{conditional.value.match(/^test -[ef] (\S*)$/)[1]}') }"
                 corrector.replace(conditional.loc.expression, new_string)
               end

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

@@ -60,7 +60,7 @@ module RuboCop
         #     action :delete
         #   end
         #
-        class CronDFileOrTemplate < Cop
+        class CronDFileOrTemplate < Base
           extend TargetChefVersion
 
           minimum_target_chef_version '14.4'
@@ -78,7 +78,7 @@ module RuboCop
           def on_block(node)
             file_or_template?(node) do |file_name|
               return unless file_name.start_with?('/etc/cron.d/')
-              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/cron_manage_resource.rb

@@ -29,19 +29,17 @@ module RuboCop
         #   # good
         #   cron_access 'mike'
         #
-        class CronManageResource < Cop
+        class CronManageResource < Base
           extend TargetChefVersion
+          extend AutoCorrector
 
           minimum_target_chef_version '14.4'
 
           MSG = 'The cron_manage resource was renamed to cron_access in the 6.1 release of the cron cookbook and later shipped in Chef Infra Client 14.4. The new resource name should be used.'
 
           def on_send(node)
-            add_offense(node, location: :expression, message: MSG, severity: :refactor) if node.method_name == :cron_manage
-          end
-
-          def autocorrect(node)
-            lambda do |corrector|
+            add_offense(node, message: MSG, severity: :refactor) do |corrector|
+              return unless node.method_name == :cron_manage
               corrector.replace(node.loc.expression, node.source.gsub(/^cron_manage/, 'cron_access'))
             end
           end

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

@@ -31,7 +31,9 @@ module RuboCop
         #   plain_text_data = data_bag_item('foo', 'bar')
         #   encrypted_data = data_bag_item('foo2', 'bar2')
         #
-        class DatabagHelpers < Cop
+        class DatabagHelpers < Base
+          extend AutoCorrector
+
           MSG = 'Use the `data_bag_item` helper instead of `Chef::DataBagItem.load` or `Chef::EncryptedDataBagItem.load`.'
 
           def_node_matcher :data_bag_class_load?, <<-PATTERN
@@ -43,13 +45,10 @@ module RuboCop
 
           def on_send(node)
             data_bag_class_load?(node) do
-              add_offense(node, location: :expression, message: MSG, severity: :refactor)
-            end
-          end
-
-          def autocorrect(node)
-            lambda do |corrector|
-              corrector.replace(node.loc.expression, node.source.gsub(/Chef::(EncryptedDataBagItem|DataBagItem).load/, 'data_bag_item'))
+              add_offense(node, message: MSG, severity: :refactor) do |corrector|
+                corrector.replace(node.loc.expression,
+                   node.source.gsub(/Chef::(EncryptedDataBagItem|DataBagItem).load/, 'data_bag_item'))
+              end
             end
           end
         end

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

@@ -38,7 +38,8 @@ module RuboCop
         #  # good
         #  default_action :create
 
-        class DefaultActionFromInitialize < Cop
+        class DefaultActionFromInitialize < Base
+          extend AutoCorrector
           include RangeHelp
 
           MSG = 'The default action of a resource can be set with the "default_action" helper instead of using the initialize method.'
@@ -53,20 +54,17 @@ module RuboCop
 
           def on_ivasgn(node)
             action_variable_assignment?(node) do
-              add_offense(node, location: :expression, message: MSG, severity: :refactor) if initialize_method(node.parent.parent)
-            end
-          end
+              return unless initialize_method(node.parent.parent)
+              add_offense(node, message: MSG, severity: :refactor) do |corrector|
+                # insert the new default_action call above the initialize method, but not if one already exists (this is sadly common)
+                unless default_action_method?(processed_source.ast)
+                  initialize_node = initialize_method(processed_source.ast).first
+                  corrector.insert_before(initialize_node.source_range, "default_action #{node.descendants.first.source}\n\n")
+                end
 
-          def autocorrect(node)
-            lambda do |corrector|
-              # insert the new default_action call above the initialize method, but not if one already exists (this is sadly common)
-              unless default_action_method?(processed_source.ast)
-                initialize_node = initialize_method(processed_source.ast).first
-                corrector.insert_before(initialize_node.source_range, "default_action #{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
-
-              # remove the variable from the initialize method
-              corrector.remove(range_with_surrounding_space(range: node.loc.expression, side: :left))
             end
           end
         end

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

@@ -30,7 +30,8 @@ module RuboCop
         #     end
         #   end
         #
-        class DefinesChefSpecMatchers < Cop
+        class DefinesChefSpecMatchers < Base
+          extend AutoCorrector
           include RangeHelp
 
           MSG = 'ChefSpec matchers are now auto generated by ChefSpec 7.1+ and do not need to be defined in a cookbook'
@@ -41,13 +42,9 @@ module RuboCop
 
           def on_if(node)
             chefspec_matcher?(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/definitions.rb

@@ -21,13 +21,13 @@ module RuboCop
       module ChefModernize
         # In 2016 with Chef Infra Client 12.5 Custom Resources were introduced as a way of writing reusable resource code that could be shipped in cookbooks. Custom Resources offer many advantages of legacy Definitions including unit testing with ChefSpec, input validation, actions, common properties like not_if/only_if, and resource reporting.
         #
-        class Definitions < Cop
+        class Definitions < Base
           include RuboCop::Chef::CookbookHelpers
 
           MSG = 'Legacy Chef Infra definitions should be rewritten as custom resources to take full advantage of the Chef Infra feature set.'
 
           def on_block(node)
-            add_offense(node, location: :expression, message: MSG, severity: :refactor) if node.respond_to?(:method_name) && node.method_name == :define
+            add_offense(node, message: MSG, severity: :refactor) if node.respond_to?(:method_name) && node.method_name == :define
           end
         end
       end

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

@@ -26,7 +26,8 @@ module RuboCop
         #   # bad
         #   depends 'zypper'
         #
-        class DependsOnZypperCookbook < Cop
+        class DependsOnZypperCookbook < Base
+          extend AutoCorrector
           extend TargetChefVersion
           include RangeHelp
 
@@ -40,13 +41,9 @@ module RuboCop
 
           def on_send(node)
             zypper_depends?(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