cookstyle 6.13.3 → 6.16.4

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

@@ -33,14 +33,14 @@ 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.'
 
           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
-          MSG = 'Cookbook metadata.rb contains an field with an empty string.'
+        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

@@ -19,7 +19,7 @@ module RuboCop
   module Cop
     module Chef
       module ChefSharing
-        # Resource properties should include description fields to allow automated documention. Requires Chef Infra Client 13.9 or later.
+        # Resource properties should include description fields to allow automated documentation. Requires Chef Infra Client 13.9 or later.
         #
         # @example
         #
@@ -29,22 +29,22 @@ module RuboCop
         #   # good
         #   property :foo, String, description: "Set the important thing to..."
         #
-        class IncludePropertyDescriptions < Cop
+        class IncludePropertyDescriptions < Base
           extend TargetChefVersion
 
           minimum_target_chef_version '13.9'
 
-          MSG = 'Resource properties should include description fields to allow automated documention. Requires Chef Infra Client 13.9 or later.'
+          MSG = 'Resource properties should include description fields to allow automated documentation. Requires Chef Infra Client 13.9 or later.'
 
           # any method named property being called with a symbol argument and anything else
           def_node_matcher :property?, '(send nil? :property (sym _) ...)'
 
           # hash that contains description in any order (that's the <> bit)
-          def_node_search :description_hash, '(hash <(pair (sym :description) ...) ...>)'
+          def_node_search :description_hash?, '(hash <(pair (sym :description) ...) ...>)'
 
           def on_send(node)
             property?(node) do
-              add_offense(node, location: :expression, message: MSG, severity: :refactor) unless description_hash(processed_source.ast).any?
+              add_offense(node.loc.expression, message: MSG, severity: :refactor) unless description_hash?(node)
             end
           end
         end

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

@@ -19,7 +19,7 @@ module RuboCop
   module Cop
     module Chef
       module ChefSharing
-        # Resources should include description fields to allow automated documention. Requires Chef Infra Client 13.9 or later.
+        # Resources should include description fields to allow automated documentation. Requires Chef Infra Client 13.9 or later.
         #
         # @example
         #
@@ -27,24 +27,24 @@ module RuboCop
         #   resource_name :foo
         #   description "The foo resource is used to do..."
         #
-        class IncludeResourceDescriptions < Cop
+        class IncludeResourceDescriptions < Base
           include RangeHelp
           extend TargetChefVersion
 
           minimum_target_chef_version '13.9'
 
-          MSG = 'Resources should include description fields to allow automated documention. Requires Chef Infra Client 13.9 or later.'
+          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 str ...)'
+          def_node_search :resource_description, '(send nil? :description ...)'
         end
       end
     end

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

@@ -19,7 +19,7 @@ module RuboCop
   module Cop
     module Chef
       module ChefSharing
-        # Resources should include examples field to allow automated documention. Requires Chef Infra Client 13.9 or later.
+        # Resources should include examples field to allow automated documentation. Requires Chef Infra Client 13.9 or later.
         #
         # @example
         #
@@ -35,21 +35,21 @@ module RuboCop
         #     ```
         #   DOC
         #
-        class IncludeResourceExamples < Cop
+        class IncludeResourceExamples < Base
           include RangeHelp
           extend TargetChefVersion
 
           minimum_target_chef_version '13.9'
 
-          MSG = 'Resources should include examples field to allow automated documention. Requires Chef Infra Client 13.9 or later.'
+          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,7 +33,9 @@ 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'
 
           def_node_matcher :insecure_cb_url?, <<-PATTERN
@@ -47,13 +49,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

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

@@ -37,7 +37,9 @@ module RuboCop
         # json_data = JSON.parse(Net::HTTP.get(URI('https://raw.githubusercontent.com/spdx/license-list-data/master/json/licenses.json')))
         # licenses = json_data['licenses'].map {|l| l['licenseId'] }.sort
         #
-        class InvalidLicenseString < Cop
+        class InvalidLicenseString < Base
+          extend AutoCorrector
+
           VALID_LICENSE_STRING = %w(
             0BSD
             AAL
@@ -461,17 +463,10 @@ module RuboCop
 
           def on_send(node)
             license?(node) do |license|
-              unless valid_license?(license.str_content)
-                add_offense(license, location: :expression, message: MSG, severity: :refactor)
-              end
-            end
-          end
-
-          def autocorrect(node)
-            correct_string = autocorrect_license_string(node.str_content)
-            if correct_string
-              lambda do |corrector|
-                corrector.replace(node.loc.expression, "'#{correct_string}'")
+              return if valid_license?(license.str_content)
+              add_offense(license, message: MSG, severity: :refactor) do |corrector|
+                correct_string = autocorrect_license_string(license.str_content)
+                corrector.replace(license.loc.expression, "'#{correct_string}'") if correct_string
               end
             end
           end

data/lib/rubocop/cop/chef/style/chef_whaaat.rb

@@ -35,13 +35,12 @@ module RuboCop
         class ChefWhaaat < Cop
           MSG = 'Do you mean Chef (the company) or a Chef product (e.g. Chef Infra, Chef InSpec, etc)?'
 
-          def investigate(processed_source)
+          def on_new_investigation
             return unless processed_source.ast
 
             processed_source.comments.each do |comment|
-              if comment.text.match?(/Chef [a-z]/) # https://rubular.com/r/0YzfDAbwJrDHix
-                add_offense(comment, location: comment.loc.expression, message: MSG, severity: :refactor)
-              end
+              next unless comment.text.match?(/Chef [a-z]/) # https://rubular.com/r/0YzfDAbwJrDHix
+              add_offense(comment.loc.expression, message: MSG, severity: :refactor)
             end
           end
         end

data/lib/rubocop/cop/chef/style/comment_sentence_spacing.rb

@@ -22,22 +22,20 @@ module RuboCop
       module ChefStyle
         # Replaces double spaces between sentences with a single space.
         # Note: This is DISABLED by default.
-        class CommentSentenceSpacing < Cop
+        class CommentSentenceSpacing < Base
+          extend AutoCorrector
           MSG = 'Use a single space after sentences in comments'
 
           def investigate(processed_source)
             return unless processed_source.ast
 
             processed_source.comments.each do |comment|
-              if comment.text.match?(/(.|\?)\s{2}/) # https://rubular.com/r/8o3SiDrQMJSzuU
-                add_offense(comment, location: comment.loc.expression, message: MSG, severity: :refactor)
+              next unless comment.text.match?(/(.|\?)\s{2}/) # https://rubular.com/r/8o3SiDrQMJSzuU
+              add_offense(comment, location: comment.loc.expression, message: MSG, severity: :refactor) do |corrector|
+                corrector.replace(comment.loc.expression, comment.text.gsub('.  ', '. ').gsub('?  ', '? '))
               end
             end
           end
-
-          def autocorrect(comment)
-            ->(corrector) { corrector.replace(comment.loc.expression, comment.text.gsub('.  ', '. ').gsub('?  ', '? ')) }
-          end
         end
       end
     end

data/lib/rubocop/cop/chef/style/comments_copyright_format.rb

@@ -43,23 +43,19 @@ module RuboCop
 
           MSG = 'Properly format copyrights header comments'
 
-          def investigate(processed_source)
+          def on_new_investigation
             return unless processed_source.ast
 
             processed_source.comments.each do |comment|
-              next unless comment.inline? # headers aren't in blocks
+              next unless comment.inline? && invalid_copyright_comment?(comment) # headers aren't in blocks
 
-              if invalid_copyright_comment?(comment)
-                add_offense(comment, location: comment.loc.expression, message: MSG, severity: :refactor)
+              add_offense(comment, location: comment.loc.expression, message: MSG, severity: :refactor) do |corrector|
+                correct_comment = "# Copyright:: #{copyright_date_range(comment)}, #{copyright_holder(comment)}"
+                corrector.replace(comment.loc.expression, correct_comment)
               end
             end
           end
 
-          def autocorrect(comment)
-            correct_comment = "# Copyright:: #{copyright_date_range(comment)}, #{copyright_holder(comment)}"
-            ->(corrector) { corrector.replace(comment.loc.expression, correct_comment) }
-          end
-
           private
 
           def copyright_date_range(comment)

data/lib/rubocop/cop/chef/style/comments_default_copyright.rb

@@ -32,18 +32,16 @@ module RuboCop
         #   Copyright:: 2019 Tim Smith
         #   Copyright:: 2019 Chef Software, Inc.
         #
-        class DefaultCopyrightComments < Cop
+        class DefaultCopyrightComments < Base
           MSG = 'Cookbook copyright comment headers should be updated for a real person or organization.'
 
-          def investigate(processed_source)
+          def on_new_investigation
             return unless processed_source.ast
 
             processed_source.comments.each do |comment|
-              next unless comment.inline? # headers aren't in blocks
-
-              if /# (?:Copyright\W*).*YOUR_(NAME|COMPANY_NAME)/.match?(comment.text)
-                add_offense(comment, location: comment.loc.expression, message: MSG, severity: :refactor)
-              end
+              next unless comment.inline? &&  # headers aren't in blocks
+                          /# (?:Copyright\W*).*YOUR_(NAME|COMPANY_NAME)/.match?(comment.text)
+              add_offense(comment.loc.expression, message: MSG, severity: :refactor)
             end
           end
         end

data/lib/rubocop/cop/chef/style/comments_format.rb

@@ -40,33 +40,30 @@ module RuboCop
         #   License:: Apache License, Version 2.0
         #   Cookbook:: Tomcat
         #
-        class CommentFormat < Cop
+        class CommentFormat < Base
+          extend AutoCorrector
+
           MSG = 'Properly format header comments'
 
-          def investigate(processed_source)
+          def on_new_investigation
             return unless processed_source.ast
 
             processed_source.comments.each do |comment|
               next if comment.loc.first_line > 10 # avoid false positives when we were checking further down the file
-              next unless comment.inline? # headers aren't in blocks
+              next unless comment.inline? && invalid_comment?(comment) # headers aren't in blocks
 
-              if invalid_comment?(comment)
-                add_offense(comment, location: comment.loc.expression, message: MSG, severity: :refactor)
+              add_offense(comment.loc.expression, message: MSG, severity: :refactor) do |corrector|
+                # Extract the type and the actual value. Strip out "Name" or "File"
+                # 'Cookbook Name' should be 'Cookbook'. Also skip a :: if present
+                # https://rubular.com/r/Do9fpLWXlCmvdJ
+                match = /^#\s*([A-Za-z]+)\s?(?:Name|File)?(?:::)?\s(.*)/.match(comment.text)
+                comment_type, value = match.captures
+                correct_comment = "# #{comment_type}:: #{value}"
+                corrector.replace(comment.loc.expression, correct_comment)
               end
             end
           end
 
-          def autocorrect(comment)
-            # Extract the type and the actual value. Strip out "Name" or "File"
-            # 'Cookbook Name' should be 'Cookbook'. Also skip a :: if present
-            # https://rubular.com/r/Do9fpLWXlCmvdJ
-            match = /^#\s*([A-Za-z]+)\s?(?:Name|File)?(?:::)?\s(.*)/.match(comment.text)
-            comment_type, value = match.captures
-            correct_comment = "# #{comment_type}:: #{value}"
-
-            ->(corrector) { corrector.replace(comment.loc.expression, correct_comment) }
-          end
-
           private
 
           def invalid_comment?(comment)

data/lib/rubocop/cop/chef/style/file_mode.rb

@@ -19,39 +19,58 @@ module RuboCop
   module Cop
     module Chef
       module ChefStyle
-        # Check the file modes are given as strings instead of integers.
+        # Use strings to represent file modes to avoid confusion between octal and base 10 integer formats.
         #
         # @example
         #
         #   # bad
-        #   mode 644
-        #   mode 0644
+        #   remote_directory '/etc/my.conf' do
+        #     content 'some content'
+        #     mode 0600
+        #     action :create
+        #   end
+        #
+        #   remote_directory 'handler' do
+        #     source 'handlers'
+        #     recursive true
+        #     files_mode 644
+        #     action :create
+        #   end
         #
         #   # good
-        #   mode '644'
+        #   remote_directory '/etc/my.conf' do
+        #     content 'some content'
+        #     mode '600'
+        #     action :create
+        #   end
+        #
+        #   remote_directory 'handler' do
+        #     source 'handlers'
+        #     recursive true
+        #     files_mode '644'
+        #     action :create
+        #   end
         #
-        class FileMode < Cop
-          MSG = 'Use strings for file modes'
+        class FileMode < Base
+          extend RuboCop::Cop::AutoCorrector
+
+          MSG = 'Use strings to represent file modes to avoid confusion between octal and base 10 integer formats'
 
           def_node_matcher :resource_mode?, <<-PATTERN
-            (send nil? :mode $int)
+            (send nil? {:mode :files_mode} $int)
           PATTERN
 
           def on_send(node)
             resource_mode?(node) do |mode_int|
-              add_offense(mode_int, location: :expression, message: MSG, severity: :refactor)
-            end
-          end
-
-          def autocorrect(node)
-            lambda do |corrector|
-              # If it was an octal literal, make sure we write out the right number.
-              replacement_base = octal?(node) ? 8 : 10
-              replacement_mode = node.children.first.to_s(replacement_base)
+              add_offense(mode_int.loc.expression, message: MSG, severity: :refactor) do |corrector|
+                # If it was an octal literal, make sure we write out the right number.
+                replacement_base = octal?(mode_int) ? 8 : 10
+                replacement_mode = mode_int.children.first.to_s(replacement_base)
 
-              # we build our own escaped string instead of using .inspect because that way
-              # we can use single quotes instead of the double quotes that .inspect adds
-              corrector.replace(node.loc.expression, "\'#{replacement_mode}\'")
+                # we build our own escaped string instead of using .inspect because that way
+                # we can use single quotes instead of the double quotes that .inspect adds
+                corrector.replace(mode_int.loc.expression, "\'#{replacement_mode}\'")
+              end
             end
           end
 

data/lib/rubocop/cop/chef/style/immediate_notification_timing.rb

@@ -35,7 +35,9 @@ module RuboCop
         #     notifies :restart, 'service[apache]', :immediately
         #   end
         #
-        class ImmediateNotificationTiming < Cop
+        class ImmediateNotificationTiming < Base
+          extend AutoCorrector
+
           MSG = 'Use :immediately instead of :immediate for resource notification timing'
 
           def_node_matcher :immediate_notify?, <<-PATTERN
@@ -44,13 +46,9 @@ module RuboCop
 
           def on_send(node)
             immediate_notify?(node) do |timing|
-              add_offense(timing, location: :expression, message: MSG, severity: :refactor)
-            end
-          end
-
-          def autocorrect(node)
-            lambda do |corrector|
-              corrector.replace(node.loc.expression, ':immediately')
+              add_offense(timing.loc.expression, message: MSG, severity: :refactor) do |corrector|
+                corrector.replace(timing.loc.expression, ':immediately')
+              end
             end
           end
         end