cookstyle 6.15.3 → 6.16.9

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

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

@@ -31,8 +31,9 @@ module RuboCop
         #   property :config_file, String
         #   attribute :config_file, String
         #
-        class PropertySplatRegex < Cop
+        class PropertySplatRegex < Base
           include RangeHelp
+          extend AutoCorrector
 
           MSG = 'There is no need to validate the input of properties in resources using a regex value that will always pass.'
 
@@ -42,14 +43,12 @@ module RuboCop
 
           def on_send(node)
             property_with_regex_splat?(node) do |splat|
-              add_offense(splat, location: :expression, message: MSG, severity: :refactor)
-            end
-          end
-
-          def autocorrect(node)
-            lambda do |corrector|
-              range = range_with_surrounding_comma(range_with_surrounding_space(range: node.loc.expression, side: :left), :left)
-              corrector.remove(range)
+              add_offense(splat, message: MSG, severity: :refactor) do |corrector|
+                range = range_with_surrounding_comma(
+                  range_with_surrounding_space(
+                    range: splat.loc.expression, side: :left), :left)
+                corrector.remove(range)
+              end
             end
           end
         end

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

@@ -32,10 +32,12 @@ module RuboCop
         #   # good
         #   property :bob, String, required: true
         #
-        class PropertyWithRequiredAndDefault < Cop
+        class PropertyWithRequiredAndDefault < Base
           include RangeHelp
+          extend AutoCorrector
 
           MSG = 'Resource properties should not be both required and have a default value. This will fail on Chef Infra Client 13+'
+          RESTRICT_ON_SEND = [:property, :attribute].freeze
 
           # match on a property or attribute that has any name and any type and a hash that
           # contains default: true and required: true. These are wrapped in <> which means
@@ -45,14 +47,8 @@ module RuboCop
           PATTERN
 
           def on_send(node)
-            required_and_default?(node) do
-              add_offense(node, location: :expression, message: MSG, severity: :refactor)
-            end
-          end
-
-          def autocorrect(node)
-            lambda do |corrector|
-              required_and_default?(node) do |default|
+            required_and_default?(node) do |default|
+              add_offense(node, message: MSG, severity: :refactor) 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/redundant/provides_metadata.rb

@@ -28,17 +28,15 @@ module RuboCop
         #
         #   provides "some_thing"
         #
-        class ProvidesMetadata < Cop
+        class ProvidesMetadata < Base
           include RangeHelp
+          extend AutoCorrector
 
           MSG = 'The provides metadata.rb method is not used and is unnecessary in cookbooks.'
+          RESTRICT_ON_SEND = [:provides].freeze
 
           def on_send(node)
-            add_offense(node, location: :expression, message: MSG, severity: :refactor) if node.method_name == :provides
-          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: :left))
             end
           end

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

@@ -28,18 +28,16 @@ module RuboCop
         #   recipe 'openldap::default', 'Install and configure OpenLDAP'
         #
         #
-        class RecipeMetadata < Cop
+        class RecipeMetadata < Base
           include RangeHelp
           include RuboCop::Chef::AutocorrectHelpers
+          extend AutoCorrector
 
           MSG = "The recipe metadata.rb method is not used and is unnecessary in cookbooks. Recipes should be documented in the cookbook's README.md file instead."
+          RESTRICT_ON_SEND = [:recipe].freeze
 
           def on_send(node)
-            add_offense(node, location: :expression, message: MSG, severity: :refactor) if node.method_name == :recipe
-          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/replaces_metadata.rb

@@ -28,17 +28,15 @@ module RuboCop
         #
         #   replaces "another_cookbook"
         #
-        class ReplacesMetadata < Cop
+        class ReplacesMetadata < Base
           include RangeHelp
+          extend AutoCorrector
 
           MSG = 'The replaces metadata.rb method is not used and is unnecessary in cookbooks.'
+          RESTRICT_ON_SEND = [:replaces].freeze
 
           def on_send(node)
-            add_offense(node, location: :expression, message: MSG, severity: :refactor) if node.method_name == :replaces
-          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: :left))
             end
           end

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

@@ -28,8 +28,9 @@ module RuboCop
         #     # let's do nothing
         #   end
         #
-        class ResourceWithNothingAction < Cop
+        class ResourceWithNothingAction < Base
           include RangeHelp
+          extend AutoCorrector
 
           MSG = 'There is no need to define a :nothing action in your resource as Chef Infra Client provides the :nothing action by default for every resource.'
 
@@ -39,13 +40,9 @@ module RuboCop
 
           def on_block(node)
             nothing_action?(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/redundant/sensitive_property_in_resource.rb

@@ -24,21 +24,20 @@ module RuboCop
         # # bad
         # property :sensitive, [true, false], default: false
         #
-        class SensitivePropertyInResource < Cop
+        class SensitivePropertyInResource < Base
+          extend AutoCorrector
+
           MSG = 'Every Chef Infra resource already includes a sensitive property with a default value of false.'
+          RESTRICT_ON_SEND = [:property, :attribute].freeze
 
           def_node_matcher :sensitive_property?, <<-PATTERN
             (send nil? {:property :attribute} (sym :sensitive) ... (hash (pair (sym :default) (false))))
           PATTERN
 
           def on_send(node)
-            if sensitive_property?(node)
-              add_offense(node, location: :expression, message: MSG, severity: :refactor)
-            end
-          end
+            return unless sensitive_property?(node)
 
-          def autocorrect(node)
-            lambda do |corrector|
+            add_offense(node, message: MSG, severity: :refactor) do |corrector|
               corrector.remove(node.source_range)
             end
           end

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

@@ -31,10 +31,12 @@ module RuboCop
         #   property :config_file, String
         #   property :config_file, [String, NilClass]
         #
-        class StringPropertyWithNilDefault < Cop
+        class StringPropertyWithNilDefault < Base
           include RangeHelp
+          extend AutoCorrector
 
           MSG = 'Properties have a nil value by default so there is no need to set the default value to nil.'
+          RESTRICT_ON_SEND = [:property].freeze
 
           def_node_matcher :string_property_with_nil_default?, <<-PATTERN
             (send nil? :property (sym _)
@@ -49,14 +51,10 @@ module RuboCop
 
           def on_send(node)
             string_property_with_nil_default?(node) do |nil_default|
-              add_offense(nil_default, location: :expression, message: MSG, severity: :refactor)
-            end
-          end
-
-          def autocorrect(node)
-            lambda do |corrector|
-              range = range_with_surrounding_comma(range_with_surrounding_space(range: node.loc.expression, side: :left), :left)
-              corrector.remove(range)
+              add_offense(nil_default, message: MSG, severity: :refactor) do |corrector|
+                range = range_with_surrounding_comma(range_with_surrounding_space(range: nil_default.loc.expression, side: :left), :left)
+                corrector.remove(range)
+              end
             end
           end
         end

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

@@ -28,17 +28,15 @@ module RuboCop
         #
         #   suggests "another_cookbook"
         #
-        class SuggestsMetadata < Cop
+        class SuggestsMetadata < Base
           include RangeHelp
+          extend AutoCorrector
 
           MSG = 'The suggests metadata.rb method is not used and is unnecessary in cookbooks.'
+          RESTRICT_ON_SEND = [:suggests].freeze
 
           def on_send(node)
-            add_offense(node, location: :expression, message: MSG, severity: :refactor) if node.method_name == :suggests
-          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: :left))
             end
           end

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

@@ -30,6 +30,7 @@ module RuboCop
           include RangeHelp
 
           MSG = 'There is no need to set a property to desired_state: true as all properties have a desired_state of true by default.'
+          RESTRICT_ON_SEND = [:property, :attribute].freeze
 
           def_node_matcher :property?, <<-PATTERN
             (send nil? {:property :attribute} (sym _) ... $(hash ...))

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

@@ -29,8 +29,11 @@ module RuboCop
         #   attribute :name, kind_of: String
         #   attribute :name, kind_of: String, name_attribute: true
         #
-        class UnnecessaryNameProperty < Cop
+        class UnnecessaryNameProperty < Base
+          extend AutoCorrector
+
           MSG = 'There is no need to define a property or attribute named :name in a resource as Chef Infra defines this on all resources by default.'
+          RESTRICT_ON_SEND = [:property, :attribute].freeze
 
           def_node_matcher :name_attribute?, <<-PATTERN
           (send nil? :attribute
@@ -56,17 +59,15 @@ module RuboCop
 
           def on_send(node)
             name_property?(node) do
-              add_offense(node, location: :expression, message: MSG, severity: :refactor)
+              add_offense(node, message: MSG, severity: :refactor) do |corrector|
+                corrector.remove(node.source_range)
+              end
             end
 
             name_attribute?(node) do
-              add_offense(node, location: :expression, message: MSG, severity: :refactor)
-            end
-          end
-
-          def autocorrect(node)
-            lambda do |corrector|
-              corrector.remove(node.source_range)
+              add_offense(node, message: MSG, severity: :refactor) do |corrector|
+                corrector.remove(node.source_range)
+              end
             end
           end
         end