cookstyle 6.15.5 → 6.16.10

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

@@ -33,9 +33,10 @@ module RuboCop
         #     verify 'nginx -t -c %{path}'
         #   end
         #
-        class VerifyPropertyUsesFileExpansion < Cop
+        class VerifyPropertyUsesFileExpansion < Base
           include RuboCop::Chef::CookbookHelpers
           extend TargetChefVersion
+          extend AutoCorrector
 
           minimum_target_chef_version '12.5'
 
@@ -43,13 +44,10 @@ module RuboCop
 
           def on_block(node)
             match_property_in_resource?(nil, 'verify', node) do |verify|
-              add_offense(verify, location: :expression, message: MSG, severity: :warning) if verify.source.match?(/%{file}/)
-            end
-          end
-
-          def autocorrect(node)
-            lambda do |corrector|
-              corrector.replace(node.loc.expression, node.loc.expression.source.gsub('%{file}', '%{path}'))
+              return unless verify.source.match?(/%{file}/)
+              add_offense(verify, message: MSG, severity: :warning) do |corrector|
+                corrector.replace(verify.loc.expression, verify.loc.expression.source.gsub('%{file}', '%{path}'))
+              end
             end
           end
         end

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

@@ -41,14 +41,14 @@ module RuboCop
         #
         #   windows_feature_powershell 'DHCP'
         #
-        class WindowsFeatureServermanagercmd < Cop
+        class WindowsFeatureServermanagercmd < Base
           include RuboCop::Chef::CookbookHelpers
 
           MSG = 'The `windows_feature` resource no longer supports setting the `install_method` to `:servermanagercmd`. `:windows_feature_dism` or `:windows_feature_powershell` should be used instead.'
 
           def on_block(node)
             match_property_in_resource?(:windows_feature, :install_method, node) do |prop_node|
-              add_offense(prop_node, location: :expression, message: MSG, severity: :warning) if prop_node.source.match?(/:servermanagercmd/)
+              add_offense(prop_node, message: MSG, severity: :warning) if prop_node.source.match?(/:servermanagercmd/)
             end
           end
         end

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

@@ -40,9 +40,10 @@ module RuboCop
         #     action :create
         #   end
         #
-        class WindowsTaskChangeAction < Cop
+        class WindowsTaskChangeAction < Base
           include RuboCop::Chef::CookbookHelpers
           extend TargetChefVersion
+          extend AutoCorrector
 
           minimum_target_chef_version '13.0'
 
@@ -60,25 +61,19 @@ module RuboCop
             end
           end
 
-          def autocorrect(node)
-            if node.parent.send_type? # :change was the only action
-              lambda do |corrector|
-                corrector.replace(node.loc.expression, ':create')
-              end
-            # chances are it's [:create, :change] since that's all that makes sense, but double check that theory
-            elsif node.parent.child_nodes.count == 2 &&
-                  node.parent.child_nodes.map(&:value).sort == [:change, :create]
-              lambda do |corrector|
-                corrector.replace(node.parent.loc.expression, ':create')
-              end
-            end
-          end
-
           private
 
           def check_action(ast_obj)
             if ast_obj.respond_to?(:value) && ast_obj.value == :change
-              add_offense(ast_obj, location: :expression, message: MSG, severity: :warning)
+              add_offense(ast_obj, message: MSG, severity: :warning) do |corrector|
+                if ast_obj.parent.send_type? # :change was the only action
+                  corrector.replace(ast_obj.loc.expression, ':create')
+                # chances are it's [:create, :change] since that's all that makes sense, but double check that theory
+                elsif ast_obj.parent.child_nodes.count == 2 &&
+                      ast_obj.parent.child_nodes.map(&:value).sort == [:change, :create]
+                  corrector.replace(ast_obj.parent.loc.expression, ':create')
+                end
+              end
             end
           end
         end

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

@@ -35,8 +35,9 @@ module RuboCop
         #   node['kernel']['server_core']
         #   node['kernel']['product_type'] == 'Workstation'
         #
-        class WindowsVersionHelpers < Cop
+        class WindowsVersionHelpers < Base
           extend TargetChefVersion
+          extend AutoCorrector
 
           minimum_target_chef_version '14.0'
 
@@ -47,14 +48,8 @@ module RuboCop
           PATTERN
 
           def on_send(node)
-            windows_helper?(node) do
-              add_offense(node, location: :expression, message: MSG, severity: :refactor)
-            end
-          end
-
-          def autocorrect(node)
-            lambda do |corrector|
-              windows_helper?(node) do |method|
+            windows_helper?(node) do |method|
+              add_offense(node, message: MSG, severity: :refactor) do |corrector|
                 case method
                 when :nt_version
                   corrector.replace(node.loc.expression, 'node[\'platform_version\'].to_f')

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

@@ -26,8 +26,11 @@ module RuboCop
         #   # bad
         #   include_recipe 'xml::ruby'
         #
-        class IncludingXMLRubyRecipe < Cop
+        class IncludingXMLRubyRecipe < Base
+          extend AutoCorrector
+
           MSG = 'Do not include the deprecated xml::ruby recipe to install the nokogiri gem. Chef Infra Client 12 and later ships with nokogiri included.'
+          RESTRICT_ON_SEND = [:include_recipe].freeze
 
           def_node_matcher :xml_ruby_recipe?, <<-PATTERN
             (send nil? :include_recipe (str "xml::ruby"))
@@ -36,13 +39,9 @@ module RuboCop
           def on_send(node)
             xml_ruby_recipe?(node) do
               node = node.parent if node.parent&.conditional? && node.parent&.single_line_condition? # make sure we catch any inline conditionals
-              add_offense(node, location: :expression, message: MSG, severity: :warning)
-            end
-          end
-
-          def autocorrect(node)
-            lambda do |corrector|
-              corrector.remove(node.loc.expression)
+              add_offense(node, message: MSG, severity: :warning) do |corrector|
+                corrector.remove(node.loc.expression)
+              end
             end
           end
         end

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