cookstyle 6.15.9 → 6.17.5

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

@@ -37,7 +37,9 @@ module RuboCop
         #  # better
         #  Write a custom resource using the custom resource DSL and avoid class based HWRPs entirely
         #
-        class ResourceInheritsFromCompatResource < Cop
+        class ResourceInheritsFromCompatResource < Base
+          extend AutoCorrector
+
           MSG = "HWRP style resource should inherit from the 'Chef::Resource' class and not the 'ChefCompat::Resource' class from the deprecated compat_resource cookbook."
 
           def_node_matcher :inherits_from_compat_resource?, <<-PATTERN
@@ -46,13 +48,9 @@ module RuboCop
 
           def on_class(node)
             inherits_from_compat_resource?(node) do
-              add_offense(node, location: :expression, message: MSG, severity: :warning)
-            end
-          end
-
-          def autocorrect(node)
-            lambda do |corrector|
-              corrector.replace(node.loc.expression, node.loc.expression.source.gsub('ChefCompat', 'Chef'))
+              add_offense(node, message: MSG, severity: :warning) do |corrector|
+                corrector.replace(node.loc.expression, node.loc.expression.source.gsub('ChefCompat', 'Chef'))
+              end
             end
           end
         end

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

@@ -33,23 +33,20 @@ module RuboCop
         #     plist_hash foo: 'bar'
         #   end
         #
-        class LaunchdDeprecatedHashProperty < Cop
+        class LaunchdDeprecatedHashProperty < Base
           include RuboCop::Chef::CookbookHelpers
           extend TargetChefVersion
+          extend AutoCorrector
 
           minimum_target_chef_version '12.19'
 
           MSG = "The launchd resource's hash property was renamed to plist_hash in Chef Infra Client 13+ to avoid conflicts with Ruby's hash class."
 
           def on_block(node)
-            match_property_in_resource?(:launchd, 'hash', node) do |hash_prop|
-              add_offense(hash_prop, location: :expression, message: MSG, severity: :warning)
-            end
-          end
-
-          def autocorrect(node)
-            lambda do |corrector|
-              corrector.replace(node.loc.expression, node.loc.expression.source.gsub(/^hash/, 'plist_hash'))
+            match_property_in_resource?(:launchd, 'hash', node) do |offense|
+              add_offense(offense.loc.expression, message: MSG, severity: :warning) do |corrector|
+                corrector.replace(offense.loc.expression, offense.loc.expression.source.gsub(/^hash/, 'plist_hash'))
+              end
             end
           end
         end

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

@@ -57,22 +57,19 @@ module RuboCop
         #     subscribes :restart, "service[#{service_name_variable}]", :immediately
         #   end
         #
-        class LegacyNotifySyntax < Cop
+        class LegacyNotifySyntax < Base
+          extend AutoCorrector
+
           MSG = 'Use the new-style notification syntax which allows you to notify resources defined later in a recipe or resource.'
+          RESTRICT_ON_SEND = [:notifies, :subscribes].freeze
 
           def_node_matcher :legacy_notify?, <<-PATTERN
             (send nil? ${:notifies :subscribes} $(sym _) (send nil? :resources (hash (pair $(sym _) $(...) ) ) ) $... )
           PATTERN
 
           def on_send(node)
-            legacy_notify?(node) do
-              add_offense(node, location: :expression, message: MSG, severity: :warning)
-            end
-          end
-
-          def autocorrect(node)
-            lambda do |corrector|
-              legacy_notify?(node) do |notify_type, action, type, name, timing|
+            legacy_notify?(node) do |notify_type, action, type, name, timing|
+              add_offense(node, message: MSG, severity: :warning) do |corrector|
                 service_value = case name.type
                                 when :str
                                   "'#{type.source}[#{name.value}]'"

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

@@ -33,8 +33,9 @@ module RuboCop
         #   include_recipe 'yum::repoforge'
         #   include_recipe 'yum::yum'
         #
-        class LegacyYumCookbookRecipes < Cop
+        class LegacyYumCookbookRecipes < Base
           MSG = 'The elrepo, epel, ius, remi, and repoforge recipes were split into their own cookbooks and the yum recipe was renamed to be default with the release of yum cookbook 3.0 (Dec 2013).'
+          RESTRICT_ON_SEND = [:include_recipe].freeze
 
           def_node_matcher :old_yum_recipe?, <<-PATTERN
             (send nil? :include_recipe (str {"yum::elrepo" "yum::epel" "yum::ius" "yum::remi" "yum::repoforge" "yum::yum"}))
@@ -42,7 +43,7 @@ module RuboCop
 
           def on_send(node)
             old_yum_recipe?(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/locale_lc_all_property.rb

@@ -29,14 +29,14 @@ module RuboCop
         #     lc_all 'en_gb.utf-8'
         #   end
         #
-        class LocaleDeprecatedLcAllProperty < Cop
+        class LocaleDeprecatedLcAllProperty < Base
           include RuboCop::Chef::CookbookHelpers
 
           MSG = "The local resource's lc_all property has been deprecated and will be removed in Chef Infra Client 17"
 
           def on_block(node)
             match_property_in_resource?(:locale, 'lc_all', node) do |property|
-              add_offense(property, location: :expression, message: MSG, severity: :warning)
+              add_offense(property, message: MSG, severity: :warning)
             end
           end
         end

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

@@ -31,10 +31,12 @@ module RuboCop
         #   property :config_file, String, name_property: true
         #   attribute :config_file, String, name_attribute: true
         #
-        class NamePropertyWithDefaultValue < Cop
+        class NamePropertyWithDefaultValue < Base
           include RangeHelp
+          extend AutoCorrector
 
           MSG = "A resource property can't be marked as a name_property and also have a default value. This will fail in Chef Infra Client 13 or later."
+          RESTRICT_ON_SEND = [:attribute, :property].freeze
 
           # match on a property or attribute that has any name and any type and a hash that
           # contains name_property/name_attribute true and any default value. These are wrapped in
@@ -44,14 +46,8 @@ module RuboCop
           PATTERN
 
           def on_send(node)
-            name_property_with_default?(node) do
-              add_offense(node, location: :expression, message: MSG, severity: :warning)
-            end
-          end
-
-          def autocorrect(node)
-            lambda do |corrector|
-              name_property_with_default?(node) do |default|
+            name_property_with_default?(node) do |default|
+              add_offense(node, message: MSG, severity: :warning) do |corrector|
                 range = range_with_surrounding_comma(range_with_surrounding_space(range: default.loc.expression, side: :left), :left)
                 corrector.remove(range)
               end

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

@@ -37,7 +37,9 @@ module RuboCop
         #   node['platform_version']
         #   node['hostname']
         #
-        class NodeMethodsInsteadofAttributes < Cop
+        class NodeMethodsInsteadofAttributes < Base
+          extend AutoCorrector
+
           MSG = 'Use node attributes to access Ohai data instead of node methods, which were deprecated in Chef Infra Client 13.'
 
           def_node_matcher :node_ohai_methods?, <<-PATTERN
@@ -46,13 +48,9 @@ module RuboCop
 
           def on_send(node)
             node_ohai_methods?(node) do
-              add_offense(node, location: :selector, message: MSG, severity: :warning)
-            end
-          end
-
-          def autocorrect(node)
-            lambda do |corrector|
-              corrector.replace(node.loc.expression, "node['#{node.method_name}']")
+              add_offense(node.loc.selector, message: MSG, severity: :warning) do |corrector|
+                corrector.replace(node.loc.expression, "node['#{node.method_name}']")
+              end
             end
           end
 

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,12 +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"))
@@ -46,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,15 @@ 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."
 
           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
+            return unless node.method_name == :provides?
+
+            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 $_ ))'
 
@@ -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