cookstyle 6.14.7 → 6.16.7

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

@@ -30,7 +30,9 @@ module RuboCop
         #   # good
         #   node.normal['foo'] = true
         #
-        class NodeSet < Cop
+        class NodeSet < Base
+          extend AutoCorrector
+
           MSG = 'Do not use node.set. Replace with node.normal to keep identical behavior.'
 
           def_node_matcher :node_set?, <<-PATTERN
@@ -39,13 +41,9 @@ module RuboCop
 
           def on_send(node)
             node_set?(node) do
-              add_offense(node, location: :selector, message: MSG, severity: :warning)
-            end
-          end
-
-          def autocorrect(node)
-            lambda do |corrector|
-              corrector.replace(node.loc.selector, 'normal')
+              add_offense(node.loc.selector, message: MSG, severity: :warning) do |corrector|
+                corrector.replace(node.loc.selector, 'normal')
+              end
             end
           end
         end

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

@@ -30,7 +30,9 @@ module RuboCop
         #   # good
         #   node.normal_unless['foo'] = true
         #
-        class NodeSetUnless < Cop
+        class NodeSetUnless < Base
+          extend AutoCorrector
+
           MSG = 'Do not use node.set_unless. Replace with node.normal_unless to keep identical behavior.'
 
           def_node_matcher :node_set_unless?, <<-PATTERN
@@ -39,13 +41,9 @@ module RuboCop
 
           def on_send(node)
             node_set_unless?(node) do
-              add_offense(node, location: :selector, message: MSG, severity: :warning)
-            end
-          end
-
-          def autocorrect(node)
-            lambda do |corrector|
-              corrector.replace(node.loc.selector, 'normal_unless')
+              add_offense(node.loc.selector, message: MSG, severity: :warning) do |corrector|
+                corrector.replace(node.loc.selector, 'normal_unless')
+              end
             end
           end
         end

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

@@ -34,7 +34,7 @@ module RuboCop
         #   node.default['foo']['bar'] += 1
         #   node.default['foo']['bar'] -= 1
         #
-        class NodeSetWithoutLevel < Cop
+        class NodeSetWithoutLevel < Base
           MSG = 'When setting a node attribute in Chef Infra Client 11 and later you must specify the precedence level.'
 
           def on_op_asgn(node)
@@ -55,9 +55,11 @@ module RuboCop
 
           def add_offense_for_bare_assignment(sub_node)
             if sub_node.receiver == s(:send, nil, :node) # node['foo'] scenario
-              add_offense(sub_node.receiver, location: :selector, message: MSG, severity: :warning)
-            elsif sub_node.receiver && sub_node.receiver&.node_parts[0] == s(:send, nil, :node) && sub_node.receiver&.node_parts[1] == :[] # node['foo']['bar'] scenario
-              add_offense(sub_node.receiver.node_parts.first, location: :selector, message: MSG, severity: :warning)
+              add_offense(sub_node.receiver.loc.selector, message: MSG, severity: :warning)
+            elsif sub_node.receiver &&
+                  sub_node.receiver&.node_parts[0] == s(:send, nil, :node) &&
+                  sub_node.receiver&.node_parts[1] == :[] # node['foo']['bar'] scenario
+              add_offense(sub_node.receiver.node_parts.first.loc.selector, message: MSG, severity: :warning)
             end
           end
         end

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

@@ -47,7 +47,7 @@ module RuboCop
         #     puts result['kernel_version']
         #   end
         #
-        class PartialSearchClassUsage < Cop
+        class PartialSearchClassUsage < Base
           MSG = 'Legacy Chef::PartialSearch class usage should be updated to use the search helper instead with the filter_result key.'
 
           def_node_matcher :partial_search_class?, <<-PATTERN
@@ -56,7 +56,7 @@ module RuboCop
 
           def on_send(node)
             partial_search_class?(node) do
-              add_offense(node, location: :expression, message: MSG, severity: :warning)
+              add_offense(node, message: MSG, severity: :warning)
             end
           end
         end

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

@@ -47,11 +47,12 @@ module RuboCop
         #     puts result['kernel_version']
         #   end
         #
-        class PartialSearchHelperUsage < Cop
+        class PartialSearchHelperUsage < Base
           MSG = 'Legacy partial_search usage should be updated to use :filter_result in the search helper instead'
+          RESTRICT_ON_SEND = [:partial_search].freeze
 
           def on_send(node)
-            add_offense(node, location: :expression, message: MSG, severity: :warning) if node.method_name == :partial_search
+            add_offense(node, message: MSG, severity: :warning)
           end
         end
       end

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

@@ -33,10 +33,13 @@ module RuboCop
         #     destination '/opt/my_app'
         #   end
         #
-        class PoiseArchiveUsage < Cop
+        class PoiseArchiveUsage < Base
           include RuboCop::Chef::CookbookHelpers
+          extend TargetChefVersion
+          minimum_target_chef_version '15.0'
 
           MSG = 'The poise_archive resource in the deprecated poise-archive should be replaced with the archive_file resource found in Chef Infra Client 15+'
+          RESTRICT_ON_SEND = [:depends].freeze
 
           def_node_matcher :depends_poise_archive?, <<-PATTERN
             (send nil? :depends (str "poise-archive"))
@@ -44,13 +47,13 @@ module RuboCop
 
           def on_send(node)
             depends_poise_archive?(node) do
-              add_offense(node, location: :expression, message: MSG, severity: :warning)
+              add_offense(node, message: MSG, severity: :warning)
             end
           end
 
           def on_block(node)
             match_resource_type?(:poise_archive, node) do
-              add_offense(node, location: :expression, message: MSG, severity: :warning)
+              add_offense(node, message: MSG, severity: :warning)
             end
           end
         end

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

@@ -32,7 +32,9 @@ module RuboCop
         #   # better (Chef Infra Client 15.8+)
         #   powershell_version == 4.0
         #
-        class PowershellCookbookHelpers < Cop
+        class PowershellCookbookHelpers < Base
+          extend AutoCorrector
+
           MSG = "Use node['powershell']['version'] or the new powershell_version helper available in Chef Infra Client 15.8+ instead of the deprecated PowerShell cookbook helpers."
 
           def_node_matcher :ps_cb_helper?, <<-PATTERN
@@ -43,14 +45,8 @@ module RuboCop
           PATTERN
 
           def on_send(node)
-            ps_cb_helper?(node) do
-              add_offense(node, location: :expression, message: MSG, severity: :warning)
-            end
-          end
-
-          def autocorrect(node)
-            lambda do |corrector|
-              ps_cb_helper?(node) do |ver|
+            ps_cb_helper?(node) do |ver|
+              add_offense(node, message: MSG, severity: :warning) do |corrector|
                 corrector.replace(node.loc.expression, "node['powershell']['version'].to_f == #{ver.source}")
               end
             end

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

@@ -30,20 +30,21 @@ module RuboCop
         #   # good
         #   include_recipe 'foo'
         #
-        class RequireRecipe < Cop
+        class RequireRecipe < Base
+          extend AutoCorrector
+
           MSG = 'Use include_recipe instead of the require_recipe method'
+          RESTRICT_ON_SEND = [:require_recipe].freeze
 
           def_node_matcher :require_recipe?, <<-PATTERN
             (send nil? :require_recipe $str)
           PATTERN
 
           def on_send(node)
-            require_recipe?(node) { add_offense(node, location: :selector, message: MSG, severity: :warning) }
-          end
-
-          def autocorrect(node)
-            lambda do |corrector|
-              corrector.replace(node.loc.selector, 'include_recipe')
+            require_recipe?(node) do
+              add_offense(node.loc.selector, message: MSG, severity: :warning) do |corrector|
+                corrector.replace(node.loc.selector, 'include_recipe')
+              end
             end
           end
         end

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

@@ -31,15 +31,14 @@ module RuboCop
         #   # good
         #   provides :SOME_PROVIDER_NAME
         #
-        class ResourceOverridesProvidesMethod < Cop
+        class ResourceOverridesProvidesMethod < Base
           MSG = "Don't override the provides? method in a resource provider. Use provides :SOME_PROVIDER_NAME instead. This will cause failures in Chef Infra Client 13 and later."
+          RESTRICT_ON_SEND = [:provides?].freeze
 
           def_node_search :provides, '(send nil? :provides ...)'
 
           def on_def(node)
-            if node.method_name == :provides?
-              add_offense(node, location: :expression, message: MSG, severity: :warning) if provides(processed_source.ast).count == 0
-            end
+            add_offense(node, message: MSG, severity: :warning) if provides(processed_source.ast).count == 0
           end
         end
       end

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

@@ -29,11 +29,12 @@ module RuboCop
         #   # good
         #   my_resource = MyResource.resource_name
         #
-        class ResourceUsesDslNameMethod < Cop
+        class ResourceUsesDslNameMethod < Base
           MSG = 'Use resource_name instead of the dsl_name method in resources. This will cause failures in Chef Infra Client 13 and later.'
+          RESTRICT_ON_SEND = [:dsl_name].freeze
 
           def on_send(node)
-            add_offense(node, location: :expression, message: MSG, severity: :warning) if node.method_name == :dsl_name
+            add_offense(node, message: MSG, severity: :warning)
           end
 
           # potential autocorrect is new_resource.updated_by_last_action true, but we need to actually see what class we were called from

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

@@ -27,11 +27,13 @@ module RuboCop
         #   mycookbook/resources/myresource.rb:
         #   resource_name :mycookbook_myresource
         #
-        class ResourceUsesOnlyResourceName < Cop
+        class ResourceUsesOnlyResourceName < Base
           include RuboCop::Chef::CookbookHelpers
           include RangeHelp
+          extend AutoCorrector
 
           MSG = 'Starting with Chef Infra Client 16, using `resource_name` without also using `provides` will result in resource failures. Make sure to use both `resource_name` and `provides` to change the name of the resource. You can also omit `resource_name` entirely if the value set matches the name Chef Infra Client automatically assigns based on COOKBOOKNAME_FILENAME.'
+          RESTRICT_ON_SEND = [:resource_name].freeze
 
           def_node_matcher :resource_name?, '(send nil? :resource_name (sym $_ ))'
 
@@ -41,7 +43,7 @@ module RuboCop
 
           # determine the cookbook name either by parsing metadata.rb or by parsing metadata.json
           #
-          # @returns [String] the cookbook name
+          # @return [String] the cookbook name
           def cookbook_name
             cb_path = File.expand_path(File.join(processed_source.file_path, '../..'))
 
@@ -55,7 +57,7 @@ module RuboCop
 
           # given a resource name make sure there's a provides that matches that name
           #
-          # @returns [TrueClass, FalseClass]
+          # @return [TrueClass, FalseClass]
           def valid_provides?(resource_name)
             provides_ast = provides(processed_source.ast)
             return false unless provides_ast
@@ -64,14 +66,9 @@ module RuboCop
           end
 
           def on_send(node)
-            resource_name?(node) do |r_name|
-              add_offense(node, location: :expression, message: MSG, severity: :warning) unless valid_provides?(r_name)
-            end
-          end
-
-          def autocorrect(node)
-            lambda do |corrector|
-              resource_name?(node) do |name|
+            resource_name?(node) do |name|
+              return if valid_provides?(name)
+              add_offense(node, message: MSG, severity: :warning) do |corrector|
                 if name.to_s == "#{cookbook_name}_#{File.basename(processed_source.path, '.rb')}"
                   corrector.remove(range_with_surrounding_space(range: node.loc.expression, side: :left))
                 else

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

@@ -26,11 +26,12 @@ module RuboCop
         #   # bad
         #   provider_base ::Chef::Provider::SomethingSomething
         #
-        class ResourceUsesProviderBaseMethod < Cop
+        class ResourceUsesProviderBaseMethod < Base
           MSG = "Don't use the deprecated provider_base method in a resource to specify the provider module to use. Instead, the provider should call provides to register itself, or the resource should call provider to specify the provider to use. This will cause failures in Chef Infra Client 13 and later."
+          RESTRICT_ON_SEND = [:provider_base].freeze
 
           def on_send(node)
-            add_offense(node, location: :expression, message: MSG, severity: :warning) if node.method_name == :provider_base
+            add_offense(node, message: MSG, severity: :warning)
           end
         end
       end

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

@@ -34,11 +34,11 @@ module RuboCop
         #       # code that causes the resource to converge
         #     end
         #
-        class ResourceUsesUpdatedMethod < Cop
+        class ResourceUsesUpdatedMethod < Base
           MSG = "Don't use updated = true/false to update resource state. This will cause failures in Chef Infra Client 13 and later."
 
           def on_lvasgn(node)
-            add_offense(node, location: :expression, message: MSG, severity: :warning) if node.node_parts.first == :updated
+            add_offense(node, message: MSG, severity: :warning) if node.node_parts.first == :updated
           end
 
           # potential autocorrect is new_resource.updated_by_last_action true, but we need to actually see what class we were called from

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

@@ -32,10 +32,11 @@ module RuboCop
         #   shell_out!('hostnamectl status', returns: [0, 1])
         #   shell_out('hostnamectl status', returns: [0, 1])
         #
-        class Ruby27KeywordArgumentWarnings < Cop
-          include RuboCop::Chef::CookbookHelpers
+        class Ruby27KeywordArgumentWarnings < Base
+          extend RuboCop::Cop::AutoCorrector
 
           MSG = 'Pass options to shell_out helpers without the brackets to avoid Ruby 2.7 deprecation warnings.'
+          RESTRICT_ON_SEND = [:shell_out!, :shell_out].freeze
 
           def_node_matcher :positional_shellout?, <<-PATTERN
             (send nil? {:shell_out :shell_out!} ... $(hash ... ))
@@ -43,14 +44,10 @@ module RuboCop
 
           def on_send(node)
             positional_shellout?(node) do |h|
-              add_offense(h, location: :expression, message: MSG, severity: :refactor) if h.braces?
-            end
-          end
-
-          def autocorrect(node)
-            lambda do |corrector|
-              # @todo when we drop ruby 2.4 support we can convert this to just delete_prefix delete_suffix
-              corrector.replace(node.loc.expression, node.loc.expression.source.gsub(/^{/, '').gsub(/}$/, ''))
+              next unless h.braces?
+              add_offense(h.loc.expression, message: MSG, severity: :refactor) do |corrector|
+                corrector.replace(h.loc.expression, h.loc.expression.source[1..-2])
+              end
             end
           end
         end

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

@@ -40,24 +40,22 @@ module RuboCop
         #     action :run
         #   end
         #
-        class RubyBlockCreateAction < Cop
+        class RubyBlockCreateAction < Base
           include RuboCop::Chef::CookbookHelpers
+          extend AutoCorrector
 
           MSG = 'Use the :run action in the ruby_block resource instead of the deprecated :create action'
 
           def on_block(node)
             match_property_in_resource?(:ruby_block, 'action', node) do |ruby_action|
               ruby_action.arguments.each do |action|
-                add_offense(action, location: :expression, message: MSG, severity: :warning) if action.source == ':create'
+                next unless action.source == ':create'
+                add_offense(action.loc.expression, message: MSG, severity: :warning) do |corrector|
+                  corrector.replace(action.loc.expression, ':run')
+                end
               end
             end
           end
-
-          def autocorrect(node)
-            lambda do |corrector|
-              corrector.replace(node.loc.expression, ':run')
-            end
-          end
         end
       end
     end

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

@@ -33,8 +33,9 @@ module RuboCop
         #   # good
         #   shell_out!('/bin/foo')
         #
-        class UsesRunCommandHelper < Cop
+        class UsesRunCommandHelper < Base
           MSG = "Use 'shell_out!' instead of the legacy 'run_command' or 'run_command_with_systems_locale' helpers for shelling out. The run_command helper was removed in Chef Infra Client 13."
+          RESTRICT_ON_SEND = [:require, :run_command, :run_command_with_systems_locale, :include].freeze
 
           def_node_matcher :calls_run_command?, '(send nil? {:run_command :run_command_with_systems_locale} ...)'
           def_node_matcher :require_mixin_command?, '(send nil? :require (str "chef/mixin/command"))'
@@ -44,15 +45,15 @@ module RuboCop
 
           def on_send(node)
             calls_run_command?(node) do
-              add_offense(node, location: :expression, message: MSG, severity: :warning) unless defines_run_command?(processed_source.ast)
+              add_offense(node, message: MSG, severity: :warning) unless defines_run_command?(processed_source.ast)
             end
 
             require_mixin_command?(node) do
-              add_offense(node, location: :expression, message: MSG, severity: :warning)
+              add_offense(node, message: MSG, severity: :warning)
             end
 
             include_mixin_command?(node) do
-              add_offense(node, location: :expression, message: MSG, severity: :warning)
+              add_offense(node, message: MSG, severity: :warning)
             end
           end
         end

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

@@ -35,8 +35,11 @@ module RuboCop
         #  search(:node, '*:*', start: 0, rows: 1000)
         #  search(:node, '*:*', start: 0)
         #
-        class SearchUsesPositionalParameters < Cop
+        class SearchUsesPositionalParameters < Base
+          extend AutoCorrector
+
           MSG = "Don't use deprecated positional parameters in cookbook search queries."
+          RESTRICT_ON_SEND = [:search].freeze
 
           NAMED_PARAM_LOOKUP_TABLE = [nil, nil, 'start', 'rows', 'filter_result'].freeze
 
@@ -46,13 +49,9 @@ module RuboCop
 
           def on_send(node)
             search_method?(node) do
-              add_offense(node, location: :expression, message: MSG, severity: :warning) if positional_arguments?(node)
-            end
-          end
-
-          def autocorrect(node)
-            lambda do |corrector|
-              corrector.replace(node.loc.expression, corrected_string(node))
+              add_offense(node, message: MSG, severity: :warning) do |corrector|
+                corrector.replace(node.loc.expression, corrected_string(node))
+              end if positional_arguments?(node)
             end
           end
 

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

@@ -29,27 +29,24 @@ module RuboCop
         #   use_inline_resources if defined?(use_inline_resources)
         #   use_inline_resources if respond_to?(:use_inline_resources)
         #
-        class UseInlineResourcesDefined < Cop
+        class UseInlineResourcesDefined < Base
           include RangeHelp
+          extend AutoCorrector
 
           MSG = 'use_inline_resources is now the default for resources in Chef Infra Client 13+ and does not need to be specified.'
+          RESTRICT_ON_SEND = [:use_inline_resources].freeze
 
           def on_send(node)
-            if node.method_name == :use_inline_resources
-              # don't alert on the use_inline_resources within the defined? check
-              # that would result in 2 alerts on the same line and wouldn't be useful
-              return if node.parent && node.parent.defined_type?
+            # don't alert on the use_inline_resources within the defined? check
+            # that would result in 2 alerts on the same line and wouldn't be useful
+            return if node.parent && node.parent.defined_type?
 
-              # catch the full offense if the method is gated like this: use_inline_resources if defined?(use_inline_resources)
-              if node.parent && node.parent.if_type? && %i(defined? respond_to?).include?(node.parent.children.first.method_name)
-                node = node.parent
-              end
-              add_offense(node, location: :expression, message: MSG, severity: :warning)
+            # catch the full offense if the method is gated like this: use_inline_resources if defined?(use_inline_resources)
+            if node.parent && node.parent.if_type? && %i(defined? respond_to?).include?(node.parent.children.first.method_name)
+              node = node.parent
             end
-          end
 
-          def autocorrect(node)
-            lambda do |corrector|
+            add_offense(node, message: MSG, severity: :warning) do |corrector|
               corrector.remove(range_with_surrounding_space(range: node.loc.expression, side: :left))
             end
           end