cookstyle 6.15.9 → 6.17.5

data/lib/rubocop/cop/chef/deprecation/yum_dnf_compat_recipe.rb

@@ -27,10 +27,12 @@ module RuboCop
         #   # bad
         #   include_recipe 'yum::dnf_yum_compat'
         #
-        class IncludingYumDNFCompatRecipe < Cop
+        class IncludingYumDNFCompatRecipe < Base
           include RangeHelp
+          extend AutoCorrector
 
           MSG = 'Do not include the deprecated yum::dnf_yum_compat default recipe to install yum on dnf systems. Chef Infra Client now includes built in support for DNF packages.'
+          RESTRICT_ON_SEND = [:include_recipe].freeze
 
           def_node_matcher :yum_dnf_compat_recipe_usage?, <<-PATTERN
             (send nil? :include_recipe (str "yum::dnf_yum_compat"))
@@ -39,13 +41,9 @@ module RuboCop
           def on_send(node)
             yum_dnf_compat_recipe_usage?(node) do
               node = node.parent if node.parent&.conditional? && node.parent&.single_line?
-              add_offense(node, location: :expression, message: MSG, severity: :warning)
-            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: :warning) do |corrector|
+                corrector.remove(range_with_surrounding_space(range: node.loc.expression, side: :left))
+              end
             end
           end
         end

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

@@ -22,18 +22,16 @@ module RuboCop
       module ChefEffortless
         # Policyfiles should be used for cookbook dependency solving instead of a Berkshelf Berksfile.
         #
-        class Berksfile < Cop
+        class Berksfile < Base
           include RangeHelp
 
           MSG = 'Policyfiles should be used for cookbook dependency solving instead of a Berkshelf Berksfile.'
 
-          def investigate(processed_source)
-            return if processed_source.blank?
-
+          def on_new_investigation
             # Using range similar to RuboCop::Cop::Naming::Filename (file_name.rb)
             range = source_range(processed_source.buffer, 1, 0)
 
-            add_offense(nil, location: range, message: MSG, severity: :refactor)
+            add_offense(range, message: MSG, severity: :refactor)
           end
         end
       end

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

@@ -26,11 +26,12 @@ module RuboCop
         #   # bad
         #   data_bag_item('admins', login)
         #   data_bag(data_bag_name)
-        class CookbookUsesDatabags < Cop
+        class CookbookUsesDatabags < Base
           MSG = 'Cookbook uses data bags, which cannot be used in the Effortless Infra pattern'
+          RESTRICT_ON_SEND = [:data_bag, :data_bag_item].freeze
 
           def on_send(node)
-            add_offense(node, location: :expression, message: MSG, severity: :refactor) if %i(data_bag data_bag_item).include?(node.method_name)
+            add_offense(node, message: MSG, severity: :refactor)
           end
         end
       end

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

@@ -27,12 +27,15 @@ module RuboCop
         #   node.environment == "production"
         #   node.chef_environment == "production"
         #
-        class CookbookUsesEnvironments < Cop
+        class CookbookUsesEnvironments < Base
           MSG = 'Cookbook uses environments, which cannot be used in Policyfiles or Effortless Infra'
+          RESTRICT_ON_SEND = [:environment, :chef_environment].freeze
 
           def on_send(node)
-            if %i(environment chef_environment).include?(node.method_name) && node.receiver && node.receiver.send_type? && node.receiver.method_name == :node
-              add_offense(node, location: :expression, message: MSG, severity: :refactor)
+            if node.receiver &&
+               node.receiver.send_type? &&
+               node.receiver.method_name == :node
+              add_offense(node, message: MSG, severity: :refactor)
             end
           end
         end

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

@@ -26,12 +26,15 @@ module RuboCop
         #   # bad
         #   node.policy_group == "foo"
         #
-        class CookbookUsesPolicygroups < Cop
+        class CookbookUsesPolicygroups < Base
           MSG = 'Cookbook uses Policy Groups, which cannot be used with Effortless Infra'
+          RESTRICT_ON_SEND = [:policy_group].freeze
 
           def on_send(node)
-            if node.method_name == :policy_group && node.receiver && node.receiver.send_type? && node.receiver.method_name == :node
-              add_offense(node, location: :expression, message: MSG, severity: :refactor)
+            if node.receiver &&
+               node.receiver.send_type? &&
+               node.receiver.method_name == :node
+              add_offense(node, message: MSG, severity: :refactor)
             end
           end
         end

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

@@ -27,12 +27,15 @@ module RuboCop
         #   node.role?('web_server')
         #   node.roles.include?('web_server')
         #
-        class CookbookUsesRoles < Cop
+        class CookbookUsesRoles < Base
           MSG = 'Cookbook uses roles, which cannot be used in Policyfiles or Effortless Infra'
+          RESTRICT_ON_SEND = [:role?, :roles].freeze
 
           def on_send(node)
-            if %i(role? roles).include?(node.method_name) && node.receiver && node.receiver.send_type? && node.receiver.method_name == :node
-              add_offense(node, location: :expression, message: MSG, severity: :refactor)
+            if node.receiver &&
+               node.receiver.send_type? &&
+               node.receiver.method_name == :node
+              add_offense(node, message: MSG, severity: :refactor)
             end
           end
         end

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'
+          RESTRICT_ON_SEND = [:search].freeze
 
           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.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,12 @@ 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'
+          RESTRICT_ON_SEND = [:search].freeze
 
           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)
           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,12 +30,13 @@ module RuboCop
         #   # good
         #   apt_update
         #
-        class IncludingAptDefaultRecipe < Cop
+        class IncludingAptDefaultRecipe < Base
           extend TargetChefVersion
 
           minimum_target_chef_version '12.7'
 
           MSG = 'Do not include the Apt default recipe to update package cache. Instead use the apt_update resource, which is built into Chef Infra Client 12.7 and later.'
+          RESTRICT_ON_SEND = [:include_recipe].freeze
 
           def_node_matcher :apt_recipe_usage?, <<-PATTERN
             (send nil? :include_recipe (str {"apt" "apt::default"}))
@@ -43,7 +44,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,8 +34,11 @@ 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.'
+          RESTRICT_ON_SEND = [:source, :site].freeze
 
           def_node_matcher :berksfile_site?, <<-PATTERN
             (send nil? :site (:sym _))
@@ -51,17 +54,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,8 +31,11 @@ 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+'
+          RESTRICT_ON_SEND = [:include_recipe].freeze
 
           def_node_matcher :build_essential_recipe_usage?, <<-PATTERN
             (send nil? :include_recipe (str {"build-essential" "build-essential::default"}))
@@ -40,13 +43,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,13 +32,15 @@ module RuboCop
         #   depends 'swap'
         #   depends 'sysctl'
         #
-        class UnnecessaryDependsChef14 < Cop
+        class UnnecessaryDependsChef14 < Base
+          extend AutoCorrector
           extend TargetChefVersion
           include RangeHelp
 
           minimum_target_chef_version '14.0'
 
           MSG = "Don't depend on cookbooks made obsolete by Chef Infra Client 14+. These community cookbooks contain resources that are now included in Chef Infra Client itself."
+          RESTRICT_ON_SEND = [:depends].freeze
 
           def_node_matcher :legacy_depends?, <<-PATTERN
             (send nil? :depends (str {"build-essential" "chef_handler" "chef_hostname" "dmg" "mac_os_x" "swap" "sysctl"}) ... )
@@ -46,13 +48,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,11 +27,13 @@ module RuboCop
         #   # bad
         #   chef_gem 'nokogiri'
         #
-        class ChefGemNokogiri < Cop
+        class ChefGemNokogiri < Base
+          extend AutoCorrector
           include RangeHelp
           include RuboCop::Chef::CookbookHelpers
 
           MSG = 'The nokogiri gem ships in Chef Infra Client 12+ and does not need to be installed before being used.'
+          RESTRICT_ON_SEND = [:chef_gem].freeze
 
           def_node_matcher :nokogiri_install?, <<-PATTERN
             (send nil? :chef_gem (str "nokogiri"))
@@ -39,20 +41,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,8 +29,11 @@ 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"
+          RESTRICT_ON_SEND = [:not_if, :only_if].freeze
 
           def_node_matcher :resource_conditional?, <<~PATTERN
           (send nil? {:not_if :only_if} $str )
@@ -38,13 +41,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