cookstyle 6.15.9 → 6.17.5

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

@@ -29,8 +29,11 @@ module RuboCop
         #   # good
         #   require_relative '../libraries/helpers'
         #
-        class UseRequireRelative < Cop
+        class UseRequireRelative < Base
+          extend AutoCorrector
+
           MSG = 'Instead of using require with a File.expand_path and __FILE__ use the simpler require_relative method.'
+          RESTRICT_ON_SEND = [:require].freeze
 
           def_node_matcher :require_with_expand_path?, <<-PATTERN
             (send nil? :require
@@ -41,14 +44,9 @@ module RuboCop
           PATTERN
 
           def on_send(node)
-            require_with_expand_path?(node) do |_file, path|
-              add_offense(node, location: :expression, message: MSG, severity: :refactor) if path.source == '__FILE__'
-            end
-          end
-
-          def autocorrect(node)
-            lambda do |corrector|
-              require_with_expand_path?(node) do |file, _path|
+            require_with_expand_path?(node) do |file, path|
+              return unless path.source == '__FILE__'
+              add_offense(node, message: MSG, severity: :refactor) do |corrector|
                 corrected_value = file.value
                 corrected_value.slice!(%r{^../}) # take the first ../ off the path
                 corrector.replace(node.loc.expression, "require_relative '#{corrected_value}'")

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

@@ -28,8 +28,9 @@ module RuboCop
         #    true
         #   end
         #
-        class WhyRunSupportedTrue < Cop
+        class WhyRunSupportedTrue < Base
           extend TargetChefVersion
+          extend AutoCorrector
           include RangeHelp
 
           minimum_target_chef_version '13.0'
@@ -45,13 +46,9 @@ module RuboCop
 
           def on_def(node)
             whyrun_true?(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/windows_default_recipe.rb

@@ -27,10 +27,12 @@ module RuboCop
         #   include_recipe 'windows::default'
         #   include_recipe 'windows'
         #
-        class IncludingWindowsDefaultRecipe < Cop
+        class IncludingWindowsDefaultRecipe < Base
           include RangeHelp
+          extend AutoCorrector
 
           MSG = 'Do not include the Windows default recipe, which only installs win32 gems already included in Chef Infra Client'
+          RESTRICT_ON_SEND = [:include_recipe].freeze
 
           def_node_matcher :windows_recipe_usage?, <<-PATTERN
             (send nil? :include_recipe (str {"windows" "windows::default"}))
@@ -38,13 +40,9 @@ module RuboCop
 
           def on_send(node)
             windows_recipe_usage?(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/windows_registry_uac.rb

@@ -44,25 +44,24 @@ module RuboCop
           minimum_target_chef_version '15.0'
 
           MSG = 'Chef Infra Client 15.0 and later includes a windows_uac resource that should be used to set Windows UAC values instead of setting registry keys directly.'
+          RESTRICT_ON_SEND = [:registry_key].freeze
 
           # non block execute resources
           def on_send(node)
-            return unless node.method_name == :registry_key
+            return unless node&.arguments.first&.source.match?(/(HKLM|HKEY_LOCAL_MACHINE)\\SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\Policies\\System/i) &&
+                          node.parent&.method_name != :describe
 
             # use 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?(/(HKLM|HKEY_LOCAL_MACHINE)\\SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\Policies\\System/i) && node.parent&.method_name != :describe
-              add_offense(node, location: :expression, message: MSG, severity: :refactor)
-            end
+            add_offense(node, location: :expression, message: MSG, severity: :refactor)
           end
 
           # block execute resources
           def on_block(node)
             match_property_in_resource?(:registry_key, 'key', node) do |key_prop|
               property_data = method_arg_ast_to_string(key_prop)
-              if property_data && property_data.match?(/(HKLM|HKEY_LOCAL_MACHINE)\\SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\Policies\\System/i)
-                add_offense(node, location: :expression, message: MSG, severity: :refactor)
-              end
+              return unless property_data && property_data.match?(/(HKLM|HKEY_LOCAL_MACHINE)\\SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\Policies\\System/i)
+              add_offense(node, location: :expression, message: MSG, severity: :refactor)
             end
           end
         end

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

@@ -28,15 +28,16 @@ module RuboCop
         #     source 'C:\\Temp\\file.zip'
         #   end
         #
-        class WindowsZipfileUsage < Cop
+        class WindowsZipfileUsage < Base
           extend TargetChefVersion
 
           minimum_target_chef_version '15.0'
 
           MSG = 'Use the archive_file resource built into Chef Infra Client 15+ instead of the windows_zipfile from the Windows cookbook'
+          RESTRICT_ON_SEND = [:windows_zipfile].freeze
 
           def on_send(node)
-            add_offense(node, location: :expression, message: MSG, severity: :refactor) if node.method_name == :windows_zipfile
+            add_offense(node, message: MSG, severity: :refactor)
           end
         end
       end

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

@@ -29,13 +29,14 @@ module RuboCop
         #     path 'C:\expand_here'
         #   end
         #
-        class ZipfileResource < Cop
+        class ZipfileResource < Base
           include RuboCop::Chef::CookbookHelpers
           extend TargetChefVersion
 
           minimum_target_chef_version '15.0'
 
           MSG = 'Use the archive_file resource built into Chef Infra Client 15+ instead of the zipfile resource from the zipfile cookbook.'
+          RESTRICT_ON_SEND = [:depends].freeze
 
           def_node_matcher :depends_zipfile?, <<-PATTERN
             (send nil? :depends (str "zipfile"))
@@ -43,13 +44,13 @@ module RuboCop
 
           def on_send(node)
             depends_zipfile?(node) do
-              add_offense(node, location: :expression, message: MSG, severity: :refactor)
+              add_offense(node, message: MSG, severity: :refactor)
             end
           end
 
           def on_block(node)
             match_resource_type?(:zipfile, 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/zypper_repo.rb

@@ -39,19 +39,17 @@ module RuboCop
         #     priority '100'
         #   end
         #
-        class UsesZypperRepo < Cop
+        class UsesZypperRepo < Base
           extend TargetChefVersion
+          extend AutoCorrector
 
           minimum_target_chef_version '13.3'
 
           MSG = 'The zypper_repo resource was renamed zypper_repository when it was added to Chef Infra Client 13.3.'
+          RESTRICT_ON_SEND = [:zypper_repo].freeze
 
           def on_send(node)
-            add_offense(node, location: :expression, message: MSG, severity: :refactor) if node.method_name == :zypper_repo
-          end
-
-          def autocorrect(node)
-            lambda do |corrector|
+            add_offense(node, message: MSG, severity: :refactor) do |corrector|
               corrector.replace(node.loc.expression, node.source.gsub(/^zypper_repo/, 'zypper_repository'))
             end
           end

data/lib/rubocop/cop/chef/redundant/apt_repository_distribution_default.rb

@@ -36,9 +36,10 @@ module RuboCop
         #     deb_src false
         #   end
         #
-        class AptRepositoryDistributionDefault < Cop
+        class AptRepositoryDistributionDefault < Base
           include RuboCop::Chef::CookbookHelpers
           include RangeHelp
+          extend AutoCorrector
 
           MSG = "There is no need to pass `distribution node['lsb']['codename']` to an apt_repository resource as this is done automatically by the apt_repository resource."
 
@@ -49,16 +50,12 @@ module RuboCop
           def on_block(node)
             match_property_in_resource?(:apt_repository, 'distribution', node) do |dist|
               default_dist?(dist) do
-                add_offense(dist, location: :expression, message: MSG, severity: :refactor)
+                add_offense(dist, message: MSG, severity: :refactor) do |corrector|
+                  corrector.remove(range_with_surrounding_space(range: dist.loc.expression, side: :left))
+                end
               end
             end
           end
-
-          def autocorrect(node)
-            lambda do |corrector|
-              corrector.remove(range_with_surrounding_space(range: node.loc.expression, side: :left))
-            end
-          end
         end
       end
     end

data/lib/rubocop/cop/chef/redundant/apt_repository_notifies_apt_update.rb

@@ -36,21 +36,19 @@ module RuboCop
         #     deb_src false
         #   end
         #
-        class AptRepositoryNotifiesAptUpdate < Cop
+        class AptRepositoryNotifiesAptUpdate < Base
           include RuboCop::Chef::CookbookHelpers
           include RangeHelp
+          extend AutoCorrector
 
           MSG = 'There is no need to notify an apt-get update when an apt_repository is created as this is done automatically by the apt_repository resource.'
 
           def on_block(node)
             match_property_in_resource?(:apt_repository, 'notifies', node) do |notifies|
-              add_offense(notifies, location: :expression, message: MSG, severity: :refactor) if notifies.arguments[1] == s(:str, 'execute[apt-get update]')
-            end
-          end
-
-          def autocorrect(node)
-            lambda do |corrector|
-              corrector.remove(range_with_surrounding_space(range: node.loc.expression, side: :left))
+              return unless notifies.arguments[1] == s(:str, 'execute[apt-get update]')
+              add_offense(notifies, message: MSG, severity: :refactor) do |corrector|
+                corrector.remove(range_with_surrounding_space(range: notifies.loc.expression, side: :left))
+              end
             end
           end
         end

data/lib/rubocop/cop/chef/redundant/attribute_metadata.rb

@@ -33,18 +33,16 @@ module RuboCop
         #              required: 'optional',
         #              default: '"127.0.0.1:2181"'
         #
-        class AttributeMetadata < Cop
+        class AttributeMetadata < Base
           include RangeHelp
           include RuboCop::Chef::AutocorrectHelpers
+          extend AutoCorrector
 
           MSG = 'The attribute metadata.rb method is not used and is unnecessary in cookbooks.'
+          RESTRICT_ON_SEND = [:attribute].freeze
 
           def on_send(node)
-            add_offense(node, location: :expression, message: MSG, severity: :refactor) if node.method_name == :attribute
-          end
-
-          def autocorrect(node)
-            lambda do |corrector|
+            add_offense(node, message: MSG, severity: :refactor) do |corrector|
               corrector.remove(range_with_surrounding_space(range: expression_including_heredocs(node), side: :left))
             end
           end

data/lib/rubocop/cop/chef/redundant/conflicts_metadata.rb

@@ -28,17 +28,15 @@ module RuboCop
         #
         #   conflicts "another_cookbook"
         #
-        class ConflictsMetadata < Cop
+        class ConflictsMetadata < Base
           include RangeHelp
+          extend AutoCorrector
 
           MSG = 'The conflicts metadata.rb method is not used and is unnecessary in cookbooks.'
+          RESTRICT_ON_SEND = [:conflicts].freeze
 
           def on_send(node)
-            add_offense(node, location: :expression, message: MSG, severity: :refactor) if node.method_name == :conflicts
-          end
-
-          def autocorrect(node)
-            lambda do |corrector|
+            add_offense(node, message: MSG, severity: :refactor) do |corrector|
               corrector.remove(range_with_surrounding_space(range: node.loc.expression, side: :right))
             end
           end

data/lib/rubocop/cop/chef/redundant/custom_resource_with_allowed_actions.rb

@@ -30,14 +30,12 @@ module RuboCop
         #   # also bad
         #   actions [:create, :remove]
         #
-        class CustomResourceWithAllowedActions < Cop
+        class CustomResourceWithAllowedActions < Base
           include RangeHelp
+          extend AutoCorrector
 
           MSG = 'It is not necessary to set `actions` or `allowed_actions` in custom resources as Chef Infra Client determines these automatically from the set of all actions defined in the resource'
-
-          def_node_matcher :allowed_actions?, <<-PATTERN
-            (send nil? {:allowed_actions :actions} ... )
-          PATTERN
+          RESTRICT_ON_SEND = [:allowed_actions, :actions].freeze
 
           def_node_search :poise_require, '(send nil? :require (str "poise"))'
 
@@ -46,16 +44,13 @@ module RuboCop
           PATTERN
 
           def on_send(node)
-            # if the resource requires poise then bail out since we're in a poise resource where @allowed_actions is legit
-            return if poise_require(processed_source.ast).any?
+            # avoid triggering on things like new_resource.actions
+            return unless node.receiver.nil?
 
-            allowed_actions?(node) do
-              add_offense(node, location: :expression, message: MSG, severity: :refactor) if resource_actions?(processed_source.ast)
-            end
-          end
+            # if the resource requires poise then bail out since we're in a poise resource where @allowed_actions is legit
+            return if poise_require(processed_source.ast).any? || !resource_actions?(processed_source.ast)
 
-          def autocorrect(node)
-            lambda do |corrector|
+            add_offense(node, message: MSG, severity: :refactor) do |corrector|
               corrector.remove(range_with_surrounding_space(range: node.loc.expression, side: :left))
             end
           end

data/lib/rubocop/cop/chef/redundant/grouping_metadata.rb

@@ -27,18 +27,16 @@ module RuboCop
         #   # bad
         #   grouping 'windows_log_rotate', title: 'Demonstration cookbook with code to switch loggers'
         #
-        class GroupingMetadata < Cop
+        class GroupingMetadata < Base
           include RangeHelp
           include RuboCop::Chef::AutocorrectHelpers
+          extend AutoCorrector
 
           MSG = 'The grouping metadata.rb method is not used and is unnecessary in cookbooks.'
+          RESTRICT_ON_SEND = [:grouping].freeze
 
           def on_send(node)
-            add_offense(node, location: :expression, message: MSG, severity: :refactor) if node.method_name == :grouping
-          end
-
-          def autocorrect(node)
-            lambda do |corrector|
+            add_offense(node, message: MSG, severity: :refactor) do |corrector|
               corrector.remove(range_with_surrounding_space(range: expression_including_heredocs(node), side: :left))
             end
           end

data/lib/rubocop/cop/chef/redundant/long_description_metadata.rb

@@ -27,18 +27,16 @@ module RuboCop
         #   # bad
         #   long_description 'this is my cookbook and this description will never be seen'
         #
-        class LongDescriptionMetadata < Cop
+        class LongDescriptionMetadata < Base
           include RangeHelp
           include RuboCop::Chef::AutocorrectHelpers
+          extend AutoCorrector
 
           MSG = 'The long_description metadata.rb method is not used and is unnecessary in cookbooks.'
+          RESTRICT_ON_SEND = [:long_description].freeze
 
           def on_send(node)
-            add_offense(node, location: :expression, message: MSG, severity: :refactor) if node.method_name == :long_description
-          end
-
-          def autocorrect(node)
-            lambda do |corrector|
+            add_offense(node, message: MSG, severity: :refactor) do |corrector|
               corrector.remove(range_with_surrounding_space(range: expression_including_heredocs(node), side: :left))
             end
           end

data/lib/rubocop/cop/chef/redundant/multiple_platform_checks.rb

@@ -32,7 +32,9 @@ module RuboCop
         #   platform?('redhat', 'ubuntu')
         #   platform_family?('debian', 'rhel')
         #
-        class MultiplePlatformChecks < Cop
+        class MultiplePlatformChecks < Base
+          extend AutoCorrector
+
           MSG = 'You can pass multiple values to the platform? and platform_family? helpers instead of calling the helpers multiple times.'
 
           def_node_matcher :or_platform_helpers?, <<-PATTERN
@@ -40,16 +42,12 @@ module RuboCop
           PATTERN
 
           def on_or(node)
-            or_platform_helpers?(node) do |helpers, _plats|
+            or_platform_helpers?(node) do |helpers, plats|
               # if the helper types were the same it's an offense, but platform_family?('rhel') || platform?('ubuntu') is legit
-              add_offense(node, location: :expression, message: MSG, severity: :refactor) if helpers.uniq.size == 1
-            end
-          end
+              return unless helpers.uniq.size == 1
 
-          def autocorrect(node)
-            or_platform_helpers?(node) do |type, plats|
-              lambda do |corrector|
-                new_string = "#{type.first}(#{plats.map(&:source).join(', ')})"
+              add_offense(node, message: MSG, severity: :refactor) do |corrector|
+                new_string = "#{helpers.first}(#{plats.map(&:source).join(', ')})"
                 corrector.replace(node.loc.expression, new_string)
               end
             end

data/lib/rubocop/cop/chef/redundant/name_property_and_required.rb

@@ -59,7 +59,7 @@ module RuboCop
         #   # good
         #   property :config_file, String, required: true
         #
-        class NamePropertyIsRequired < Cop
+        class NamePropertyIsRequired < Base
           MSG = 'Resource properties marked as name properties should not also be required properties'
 
           # match on a property or attribute that has any name and any type and a hash that
@@ -71,7 +71,7 @@ module RuboCop
 
           def on_send(node)
             name_property_and_required?(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/redundant/ohai_attribute_to_string.rb

@@ -42,7 +42,9 @@ module RuboCop
         #   node['os']
         #   node['name']
         #
-        class OhaiAttributeToString < Cop
+        class OhaiAttributeToString < Base
+          extend AutoCorrector
+
           MSG = "This Ohai node attribute is already a string and doesn't need to be converted"
 
           def_node_matcher :attribute_to_s?, <<-PATTERN
@@ -50,14 +52,8 @@ module RuboCop
           PATTERN
 
           def on_send(node)
-            attribute_to_s?(node) do
-              add_offense(node, location: :expression, message: MSG, severity: :refactor)
-            end
-          end
-
-          def autocorrect(node)
             attribute_to_s?(node) do |method|
-              lambda do |corrector|
+              add_offense(node, message: MSG, severity: :refactor) do |corrector|
                 corrector.replace(node.loc.expression, "node['#{method.value}']")
               end
             end