cookstyle 6.15.9 → 6.17.5

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

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

@@ -41,8 +41,10 @@ module RuboCop
         #     action :create_if_missing
         #   end
         #
-        class UseCreateIfMissing < Cop
+        class UseCreateIfMissing < Base
           include RuboCop::Chef::CookbookHelpers
+          extend AutoCorrector
+
           MSG = 'Use the :create_if_missing action instead of not_if with a ::File.exist(FOO) check.'
 
           def_node_matcher :not_if_file_exist?, <<-PATTERN
@@ -59,18 +61,14 @@ module RuboCop
             not_if_file_exist?(node) do |props|
               file_like_resource?(node.parent.parent) do |resource_blk_name|
                 # the not_if file name is the same as the resource name and there's no action defined (it's the default)
-                if props == resource_blk_name && create_action?(node.parent.parent).nil?
-                  add_offense(node, location: :expression, message: MSG, severity: :refactor)
+                return unless props == resource_blk_name && create_action?(node.parent.parent).nil?
+
+                add_offense(node, message: MSG, severity: :refactor) do |corrector|
+                  corrector.replace(node.loc.expression, 'action :create_if_missing')
                 end
               end
             end
           end
-
-          def autocorrect(node)
-            lambda do |corrector|
-              corrector.replace(node.loc.expression, 'action :create_if_missing')
-            end
-          end
         end
       end
     end

data/lib/rubocop/cop/chef/sharing/default_maintainer_metadata.rb

@@ -33,14 +33,15 @@ module RuboCop
         #   maintainer 'Bob Bobberson'
         #   maintainer_email 'bob@bobberson.com'
         #
-        class DefaultMetadataMaintainer < Cop
+        class DefaultMetadataMaintainer < Base
           MSG = 'Metadata contains default maintainer information from the cookbook generator. Add actual cookbook maintainer information to the metadata.rb.'
+          RESTRICT_ON_SEND = [:maintainer, :maintainer_email].freeze
 
           def_node_matcher :default_metadata?, '(send nil? {:maintainer :maintainer_email} (str {"YOUR_COMPANY_NAME" "The Authors" "YOUR_EMAIL" "you@example.com"}))'
 
           def on_send(node)
             default_metadata?(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/sharing/empty_metadata_field.rb

@@ -30,14 +30,15 @@ module RuboCop
         #   # good
         #   license 'Apache-2.0'
         #
-        class EmptyMetadataField < Cop
+        class EmptyMetadataField < Base
           MSG = 'Cookbook metadata.rb contains a field with an empty string.'
 
           def_node_matcher :field?, '(send nil? _ $str ...)'
 
           def on_send(node)
             field?(node) do |str|
-              add_offense(str, location: :expression, message: MSG, severity: :refactor) if str.value.empty?
+              return unless str.value.empty?
+              add_offense(str, message: MSG, severity: :refactor)
             end
           end
         end

data/lib/rubocop/cop/chef/sharing/include_property_descriptions.rb

@@ -35,6 +35,7 @@ module RuboCop
           minimum_target_chef_version '13.9'
 
           MSG = 'Resource properties should include description fields to allow automated documentation. Requires Chef Infra Client 13.9 or later.'
+          RESTRICT_ON_SEND = [:property].freeze
 
           # any method named property being called with a symbol argument and anything else
           def_node_matcher :property?, '(send nil? :property (sym _) ...)'

data/lib/rubocop/cop/chef/sharing/include_resource_descriptions.rb

@@ -27,7 +27,7 @@ module RuboCop
         #   resource_name :foo
         #   description "The foo resource is used to do..."
         #
-        class IncludeResourceDescriptions < Cop
+        class IncludeResourceDescriptions < Base
           include RangeHelp
           extend TargetChefVersion
 
@@ -35,13 +35,13 @@ module RuboCop
 
           MSG = 'Resources should include description fields to allow automated documentation. Requires Chef Infra Client 13.9 or later.'
 
-          def investigate(processed_source)
-            return if processed_source.blank?
+          def on_new_investigation
+            return if processed_source.blank? || resource_description(processed_source.ast).any?
 
             # Using range similar to RuboCop::Cop::Naming::Filename (file_name.rb)
             range = source_range(processed_source.buffer, 1, 0)
 
-            add_offense(nil, location: range, message: MSG, severity: :refactor) unless resource_description(processed_source.ast).any?
+            add_offense(range, message: MSG, severity: :refactor)
           end
 
           def_node_search :resource_description, '(send nil? :description ...)'

data/lib/rubocop/cop/chef/sharing/include_resource_examples.rb

@@ -35,7 +35,7 @@ module RuboCop
         #     ```
         #   DOC
         #
-        class IncludeResourceExamples < Cop
+        class IncludeResourceExamples < Base
           include RangeHelp
           extend TargetChefVersion
 
@@ -43,13 +43,13 @@ module RuboCop
 
           MSG = 'Resources should include examples field to allow automated documentation. Requires Chef Infra Client 13.9 or later.'
 
-          def investigate(processed_source)
-            return if processed_source.blank?
+          def on_new_investigation
+            return if processed_source.blank? || resource_examples(processed_source.ast).any?
 
             # Using range similar to RuboCop::Cop::Naming::Filename (file_name.rb)
             range = source_range(processed_source.buffer, 1, 0)
 
-            add_offense(nil, location: range, message: MSG, severity: :refactor) unless resource_examples(processed_source.ast).any?
+            add_offense(range, message: MSG, severity: :refactor)
           end
 
           def_node_search :resource_examples, '(send nil? :examples dstr ...)'

data/lib/rubocop/cop/chef/sharing/insecure_cookbook_url.rb

@@ -33,8 +33,11 @@ module RuboCop
         #   source_url 'http://github.com/something/something'
         #   source_url 'http://gitlab.com/something/something'
         #
-        class InsecureCookbookURL < Cop
+        class InsecureCookbookURL < Base
+          extend AutoCorrector
+
           MSG = 'Insecure http Github or Gitlab URLs for metadata source_url/issues_url fields'
+          RESTRICT_ON_SEND = [:source_url, :issues_url].freeze
 
           def_node_matcher :insecure_cb_url?, <<-PATTERN
             (send nil? {:source_url :issues_url} (str #insecure_url?))
@@ -47,13 +50,9 @@ module RuboCop
 
           def on_send(node)
             insecure_cb_url?(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(%r{http://(www.)*}, 'https://'))
+              add_offense(node, message: MSG, severity: :refactor) do |corrector|
+                corrector.replace(node.loc.expression, node.source.gsub(%r{http://(www.)*}, 'https://'))
+              end
             end
           end
         end