cookstyle 6.15.9 → 6.17.5

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.'
+          RESTRICT_ON_SEND = [:cron_manage].freeze
 
           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|
               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,13 +26,15 @@ module RuboCop
         #   # bad
         #   depends 'zypper'
         #
-        class DependsOnZypperCookbook < Cop
+        class DependsOnZypperCookbook < Base
+          extend AutoCorrector
           extend TargetChefVersion
           include RangeHelp
 
           minimum_target_chef_version '13.3'
 
           MSG = "Don't depend on the zypper cookbook as the zypper_repository resource is built into Chef Infra Client 13.3+"
+          RESTRICT_ON_SEND = [:depends].freeze
 
           def_node_matcher :zypper_depends?, <<-PATTERN
             (send nil? :depends (str "zypper"))
@@ -40,13 +42,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

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

@@ -25,10 +25,12 @@ module RuboCop
         #   include Chef::DSL::Recipe
         #   include Chef::DSL::IncludeRecipe
         #
-        class DslIncludeInResource < Cop
+        class DslIncludeInResource < Base
+          extend AutoCorrector
           include RangeHelp
 
           MSG = 'Chef Infra Client 12.4+ includes the Chef::DSL::Recipe in the resource and provider classed by default so there is no need to include this DSL in your resources or providers.'
+          RESTRICT_ON_SEND = [:include].freeze
 
           def_node_matcher :dsl_include?, <<-PATTERN
           (send nil? :include
@@ -39,13 +41,9 @@ module RuboCop
 
           def on_send(node)
             dsl_include?(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/empty_resource_initialize.rb

@@ -28,7 +28,8 @@ module RuboCop
         #     super
         #   end
         #
-        class EmptyResourceInitializeMethod < Cop
+        class EmptyResourceInitializeMethod < Base
+          extend AutoCorrector
           include RangeHelp
 
           MSG = 'There is no need for an empty initialize method in a resource'
@@ -39,13 +40,9 @@ module RuboCop
 
           def on_def(node)
             empty_initialize?(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/execute_apt_update.rb

@@ -42,8 +42,11 @@ module RuboCop
         #     notifies :update, 'apt_update[update apt cache]', :immediately
         #   end
         #
-        class ExecuteAptUpdate < Cop
+        class ExecuteAptUpdate < Base
+          extend AutoCorrector
+
           MSG = 'Use the apt_update resource instead of the execute resource to run an apt-get update package cache update'
+          RESTRICT_ON_SEND = [:execute, :notifies, :subscribes, :command].freeze
 
           def_node_matcher :execute_apt_update?, <<-PATTERN
             (send nil? :execute (str { "apt-get update" "apt-get update -y" "apt-get -y update" }))
@@ -59,15 +62,15 @@ module RuboCop
 
           def on_send(node)
             execute_apt_update?(node) do
-              add_offense(node, location: :expression, message: MSG, severity: :refactor)
+              add_offense(node, message: MSG, severity: :refactor)
             end
 
             notification_property?(node) do |val|
-              add_offense(val, location: :expression, message: MSG, severity: :refactor) if val.str_content&.start_with?('execute[apt-get update]')
+              add_offense(val, message: MSG, severity: :refactor) if val.str_content&.start_with?('execute[apt-get update]')
             end
 
             execute_command?(node) do |val|
-              add_offense(node, location: :expression, message: MSG, severity: :refactor) if val.str_content == 'apt-get update'
+              add_offense(node, message: MSG, severity: :refactor) if val.str_content == 'apt-get update'
             end
           end
         end

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

@@ -32,32 +32,30 @@ module RuboCop
         #     action :delete
         #   end
         #
-        class ExecuteScExe < Cop
+        class ExecuteScExe < Base
           include RuboCop::Chef::CookbookHelpers
           extend TargetChefVersion
 
           minimum_target_chef_version '14.0'
 
           MSG = 'Chef Infra Client 14.0 and later includes :create, :delete, and :configure actions with the full idempotency of the windows_service resource. See the windows_service documentation at https://docs.chef.io/resource_windows_service.html for additional details on creating services with the windows_service resource'
+          RESTRICT_ON_SEND = [:execute].freeze
 
           # non block execute resources
           def on_send(node)
-            return unless node.method_name == :execute
-
             # use a regex on source instead of .value in case there's string interpolation which adds a complex dstr type
             # with a nested string and a begin. Source allows us to avoid a lot of defensive programming here
-            if node&.arguments.first&.source&.match?(/^("|')sc.exe/)
-              add_offense(node, location: :expression, message: MSG, severity: :refactor)
-            end
+            return unless node&.arguments.first&.source&.match?(/^("|')sc.exe/)
+
+            add_offense(node, message: MSG, severity: :refactor)
           end
 
           # block execute resources
           def on_block(node)
             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?(/^sc.exe/i)
-                add_offense(node, location: :expression, message: MSG, severity: :refactor)
-              end
+              return unless property_data && property_data.match?(/^sc.exe/i)
+              add_offense(node, message: MSG, severity: :refactor)
             end
           end
         end

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

@@ -43,32 +43,28 @@ module RuboCop
           minimum_target_chef_version '15.5'
 
           MSG = 'Chef Infra Client 15.5 and later include a chef_sleep resource that should be used to sleep between executing resources if necessary instead of using the bash or execute resources to run the sleep command.'
+          RESTRICT_ON_SEND = [:execute].freeze
 
           # non block execute resources
           def on_send(node)
-            return unless node.method_name == :execute
-
             # use a regex on source instead of .value in case there's string interpolation which adds a complex dstr type
             # with a nested string and a begin. Source allows us to avoid a lot of defensive programming here
-            if node&.arguments.first&.source&.match?(/^("|')sleep/)
-              add_offense(node, location: :expression, message: MSG, severity: :refactor)
-            end
+            return unless node&.arguments.first&.source&.match?(/^("|')sleep/)
+            add_offense(node, message: MSG, severity: :refactor)
           end
 
           # block execute resources
           def on_block(node)
             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?(/^sleep/i)
-                add_offense(node, location: :expression, message: MSG, severity: :refactor)
-              end
+              next unless property_data && property_data.match?(/^sleep/i)
+              add_offense(node, message: MSG, severity: :refactor)
             end
 
             match_property_in_resource?(:bash, 'code', node) do |code_property|
               property_data = method_arg_ast_to_string(code_property)
-              if property_data && property_data.match?(/^sleep/i)
-                add_offense(node, location: :expression, message: MSG, severity: :refactor)
-              end
+              next unless property_data && property_data.match?(/^sleep/i)
+              add_offense(node, message: MSG, severity: :refactor)
             end
           end
         end

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

@@ -36,32 +36,29 @@ module RuboCop
         #     value '9000 65500'
         #   end
         #
-        class ExecuteSysctl < Cop
+        class ExecuteSysctl < Base
           include RuboCop::Chef::CookbookHelpers
           extend TargetChefVersion
 
           minimum_target_chef_version '14.0'
 
           MSG = 'Chef Infra Client 14.0 and later includes a sysctl resource that should be used to idempotently load sysctl values instead of templating files and using execute to load them.'
+          RESTRICT_ON_SEND = [:execute].freeze
 
           # non block execute resources
           def on_send(node)
-            return unless node.method_name == :execute
-
             # use a regex on source instead of .value in case there's string interpolation which adds a complex dstr type
             # with a nested string and a begin. Source allows us to avoid a lot of defensive programming here
-            if node&.arguments.first&.source&.match?(/^("|')sysctl -p/)
-              add_offense(node, location: :expression, message: MSG, severity: :refactor)
-            end
+            return unless node&.arguments.first&.source&.match?(/^("|')sysctl -p/)
+            add_offense(node, message: MSG, severity: :refactor)
           end
 
           # block execute resources
           def on_block(node)
             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?(%r{^(/sbin/)?sysctl -p}i)
-                add_offense(node, location: :expression, message: MSG, severity: :refactor)
-              end
+              return unless property_data && property_data.match?(%r{^(/sbin/)?sysctl -p}i)
+              add_offense(node, message: MSG, severity: :refactor)
             end
           end
         end

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

@@ -37,13 +37,14 @@ module RuboCop
         #   # good
         #   timezone 'UTC'
         #
-        class ExecuteTzUtil < Cop
+        class ExecuteTzUtil < Base
           include RuboCop::Chef::CookbookHelpers
           extend TargetChefVersion
 
           minimum_target_chef_version '14.6'
 
           MSG = 'Use the timezone resource included in Chef Infra Client 14.6+ instead of shelling out to tzutil'
+          RESTRICT_ON_SEND = [:execute].freeze
 
           def_node_matcher :execute_resource?, <<-PATTERN
             (send nil? :execute $str)
@@ -51,17 +52,20 @@ module RuboCop
 
           def on_send(node)
             execute_resource?(node) do
-              add_offense(node, location: :expression, message: MSG, severity: :refactor) if node.arguments.first.value.match?(/^tzutil/i)
+              return unless node.arguments.first.value.match?(/^tzutil/i)
+              add_offense(node, message: MSG, severity: :refactor)
             end
           end
 
           def on_block(node)
             match_property_in_resource?(:execute, 'command', node) do |code_property|
-              add_offense(node, location: :expression, message: MSG, severity: :refactor) if calls_tzutil?(code_property)
+              next unless calls_tzutil?(code_property)
+              add_offense(node, message: MSG, severity: :refactor)
             end
 
             match_property_in_resource?(:powershell_script, 'code', node) do |code_property|
-              add_offense(node, location: :expression, message: MSG, severity: :refactor) if calls_tzutil?(code_property)
+              next unless calls_tzutil?(code_property)
+              add_offense(node, message: MSG, severity: :refactor)
             end
           end
 

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

@@ -27,24 +27,19 @@ module RuboCop
         #   # bad
         #   # ~FC013
         #
-        class FoodcriticComments < Cop
-          MSG = 'Remove legacy code comments that disable Foodcritic rules'
+        class FoodcriticComments < Base
+          extend AutoCorrector
 
-          def investigate(processed_source)
-            return unless processed_source.ast
+          MSG = 'Remove legacy code comments that disable Foodcritic rules'
 
+          def on_new_investigation
             processed_source.comments.each do |comment|
-              if comment.text.match?(/#\s*~FC\d{3}.*/)
-                add_offense(comment, location: :expression, message: MSG, severity: :refactor)
+              next unless comment.text.match?(/#\s*~FC\d{3}.*/)
+              add_offense(comment, message: MSG, severity: :refactor) do |corrector|
+                corrector.remove(comment.loc.expression)
               end
             end
           end
-
-          def autocorrect(node)
-            lambda do |corrector|
-              corrector.remove(node.loc.expression)
-            end
-          end
         end
       end
     end