cookstyle 6.18.8 → 6.21.1

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

@@ -33,6 +33,7 @@ module RuboCop
           extend AutoCorrector
 
           MSG = "Use `node.role?('foo')` to check if a node includes a role instead of `node['roles'].include?('foo')`."
+          RESTRICT_ON_SEND = [:include?].freeze
 
           def_node_matcher :node_role_include?, <<-PATTERN
           (send
@@ -45,7 +46,7 @@ module RuboCop
           def on_send(node)
             node_role_include?(node) do |val|
               add_offense(node, message: MSG, severity: :refactor) do |corrector|
-                corrector.replace(node.loc.expression, "node.role?(#{val.source})")
+                corrector.replace(node, "node.role?(#{val.source})")
               end
             end
           end

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

@@ -43,7 +43,7 @@ module RuboCop
 
           def on_send(node)
             add_offense(node, message: MSG, severity: :refactor) do |corrector|
-              corrector.replace(node.loc.expression, node.source.gsub(/^openssl_rsa_key/, 'openssl_rsa_private_key'))
+              corrector.replace(node, node.source.gsub(/^openssl_rsa_key/, 'openssl_rsa_private_key'))
             end
           end
         end

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

@@ -49,7 +49,7 @@ module RuboCop
 
           def on_send(node)
             add_offense(node, message: MSG, severity: :refactor) do |corrector|
-              corrector.replace(node.loc.expression, node.source.gsub(/^openssl_x509/, 'openssl_x509_certificate'))
+              corrector.replace(node, node.source.gsub(/^openssl_x509/, 'openssl_x509_certificate'))
             end
           end
         end

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

@@ -40,7 +40,7 @@ module RuboCop
 
           def on_send(node)
             add_offense(node, message: MSG, severity: :refactor) do |corrector|
-              corrector.replace(node.loc.expression, node.source.gsub(/^osx_config_profile/, 'osx_profile'))
+              corrector.replace(node, node.source.gsub(/^osx_config_profile/, 'osx_profile'))
             end
           end
         end

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

@@ -45,7 +45,7 @@ module RuboCop
           def on_send(node)
             property_with_name_attribute?(node) do |name_attribute|
               add_offense(node, message: MSG, severity: :refactor) do |corrector|
-                corrector.replace(name_attribute.loc.expression, 'name_property: true')
+                corrector.replace(name_attribute, 'name_property: true')
               end
             end
           end

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

@@ -80,7 +80,7 @@ module RuboCop
             match_property_in_resource?(:chef_gem, 'compile_time', node) do |compile_time_property|
               compile_time_method_defined?(compile_time_property.parent) do |val|
                 add_offense(compile_time_property.parent, message: MSG, severity: :refactor) do |corrector|
-                  corrector.replace(compile_time_property.parent.loc.expression, "compile_time #{val.source}")
+                  corrector.replace(compile_time_property.parent, "compile_time #{val.source}")
                 end
               end
             end

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

@@ -27,6 +27,7 @@ module RuboCop
         #   # bad
         #   chef_version '>= 13' if respond_to?(:chef_version)
         #   chef_version '>= 13' if defined?(chef_version)
+        #   chef_version '>= 13' unless defined?(Ridley::Chef::Cookbook::Metadata)
         #   if defined(chef_version)
         #     chef_version '>= 13'
         #   end
@@ -40,7 +41,7 @@ module RuboCop
 
           minimum_target_chef_version '12.15'
 
-          MSG = 'It is no longer necessary to use respond_to? or if_defined? in metadata.rb in Chef Infra Client 12.15 and later'
+          MSG = 'It is no longer necessary to use respond_to? or defined? in metadata.rb in Chef Infra Client 12.15 and later'
 
           def on_if(node)
             if_respond_to?(node) do
@@ -51,7 +52,7 @@ module RuboCop
                 # is a block under the if statement and node.parent.if_branch can get us that block
                 node = node.parent unless node.if_type?
 
-                corrector.replace(node.loc.expression, node.if_branch.source)
+                corrector.replace(node, node.if_branch.source)
               end
             end
           end
@@ -61,15 +62,14 @@ module RuboCop
             # node.if_branch is the actual method call we want to extract.
             # If a series of metadata methods are wrapped in an if statement then the content we want
             # is a block under the if statement and node.parent.if_branch can get us that block
-
-            node = node.parent if node.parent.if? && !node.if_type? # we want the whole if statement
+            node = node.parent if node.parent.conditional? # we want the whole conditional statement
             add_offense(node, message: MSG, severity: :refactor) do |corrector|
-              corrector.replace(node.loc.expression, node.if_branch.source)
+              corrector.replace(node, node.if_branch.source)
             end
           end
 
           def_node_matcher :if_respond_to?, <<~PATTERN
-          (if (send nil? :respond_to? _ ) ... )
+            (if (send nil? :respond_to? _ ) ... )
           PATTERN
         end
       end

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

@@ -39,22 +39,22 @@ module RuboCop
           def on_if(node)
             if_respond_to_provides?(node) do
               add_offense(node, message: MSG, severity: :refactor) do |corrector|
-                corrector.replace(node.loc.expression, node.children[1].source)
+                corrector.replace(node, node.children[1].source)
               end
             end
           end
 
           def_node_matcher :if_respond_to_provides?, <<~PATTERN
-          (if
-            {
-            (send nil? :respond_to?
-              (sym :provides))
+            (if
+              {
+              (send nil? :respond_to?
+                (sym :provides))
 
-            (:defined?
-              (send nil? :provides))
-            }
-            (send nil? :provides
-              (sym _)) ... )
+              (:defined?
+                (send nil? :provides))
+              }
+              (send nil? :provides
+                (sym _)) ... )
           PATTERN
         end
       end

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

@@ -37,13 +37,13 @@ module RuboCop
           def on_if(node)
             if_respond_to_resource_name?(node) do
               add_offense(node, message: MSG, severity: :refactor) do |corrector|
-                corrector.replace(node.loc.expression, node.children[1].source)
+                corrector.replace(node, node.children[1].source)
               end
             end
           end
 
           def_node_matcher :if_respond_to_resource_name?, <<~PATTERN
-          (if (send nil? :respond_to? ( :sym :resource_name ) ) ... )
+            (if (send nil? :respond_to? ( :sym :resource_name ) ) ... )
           PATTERN
         end
       end

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

@@ -37,6 +37,7 @@ module RuboCop
           minimum_target_chef_version '12.11'
 
           MSG = "Use the built-in `shell_out` helper available in Chef Infra Client 12.11+ instead of calling `Mixlib::ShellOut.new('foo').run_command`."
+          RESTRICT_ON_SEND = [:run_command].freeze
 
           def_node_matcher :mixlib_shellout_run_cmd?, <<-PATTERN
           (send
@@ -49,7 +50,7 @@ module RuboCop
           def on_send(node)
             mixlib_shellout_run_cmd?(node) do |cmd|
               add_offense(node, message: MSG, severity: :refactor) do |corrector|
-                corrector.replace(node.loc.expression, "shell_out(#{cmd.loc.expression.source})")
+                corrector.replace(node, "shell_out(#{cmd.source})")
               end
             end
           end

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

@@ -52,7 +52,7 @@ module RuboCop
               if %r{http(s)*://ppa.launchpad.net/(.*)/ubuntu$}.match?(uri.arguments&.first&.str_content)
                 add_offense(uri, message: MSG, severity: :refactor) do |corrector|
                   next unless (replacement_val = %r{http(s)*://ppa.launchpad.net/(.*)/ubuntu}.match(node.source)[2])
-                  corrector.replace(uri.loc.expression, "uri 'ppa:#{replacement_val}'")
+                  corrector.replace(uri, "uri 'ppa:#{replacement_val}'")
                 end
               end
             end

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

@@ -43,7 +43,7 @@ module RuboCop
 
           def on_send(node)
             add_offense(node, message: MSG, severity: :refactor) do |corrector|
-              corrector.replace(node.loc.expression, node.source.gsub(/^sysctl_param/, 'sysctl'))
+              corrector.replace(node, node.source.gsub(/^sysctl_param/, 'sysctl'))
             end
           end
         end

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

@@ -98,7 +98,7 @@ module RuboCop
           def check_offense(node)
             add_offense(node, message: MSG, severity: :refactor) do |corrector|
               package_array_install?(node) do |vals|
-                corrector.replace(node.loc.expression, "package #{vals.source}")
+                corrector.replace(node, "package #{vals.source}")
               end
             end
           end

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

@@ -49,7 +49,7 @@ module RuboCop
               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}'")
+                corrector.replace(node, "require_relative '#{corrected_value}'")
               end
             end
           end

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

@@ -50,7 +50,7 @@ module RuboCop
 
           def on_send(node)
             add_offense(node, message: MSG, severity: :refactor) do |corrector|
-              corrector.replace(node.loc.expression, node.source.gsub(/^zypper_repo/, 'zypper_repository'))
+              corrector.replace(node, node.source.gsub(/^zypper_repo/, 'zypper_repository'))
             end
           end
         end

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

@@ -37,6 +37,7 @@ module RuboCop
           extend RuboCop::Cop::AutoCorrector
 
           MSG = "If a resource includes the `compile_time` property there's no need to also use `.run_action(:some_action)` on the resource block."
+          RESTRICT_ON_SEND = [:run_action].freeze
 
           def_node_matcher :compile_time_and_run_action?, <<-PATTERN
           (send
@@ -54,7 +55,7 @@ module RuboCop
           def on_send(node)
             compile_time_and_run_action?(node) do |resource, action, run_action|
               add_offense(node.loc.selector, message: MSG, severity: :refactor) do |corrector|
-                corrector.replace(node.loc.expression, resource.source.gsub(action.to_s, run_action.to_s))
+                corrector.replace(node, resource.source.gsub(action.to_s, run_action.to_s))
               end
             end
           end

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

@@ -48,7 +48,7 @@ module RuboCop
 
               add_offense(node, message: MSG, severity: :refactor) do |corrector|
                 new_string = "#{helpers.first}(#{plats.map(&:source).join(', ')})"
-                corrector.replace(node.loc.expression, new_string)
+                corrector.replace(node, new_string)
               end
             end
           end

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

@@ -61,6 +61,7 @@ module RuboCop
         #
         class NamePropertyIsRequired < Base
           MSG = 'Resource properties marked as name properties should not also be required properties'
+          RESTRICT_ON_SEND = [:property, :attribute].freeze
 
           # match on a property or attribute that has any name and any type and a hash that
           # contains name_property: true and required: true. These are wrapped in <> which means

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

@@ -46,6 +46,7 @@ module RuboCop
           extend AutoCorrector
 
           MSG = "This Ohai node attribute is already a string and doesn't need to be converted"
+          RESTRICT_ON_SEND = [:to_s].freeze
 
           def_node_matcher :attribute_to_s?, <<-PATTERN
             (send (send (send nil? :node) :[] $(str {"platform" "platform_family" "platform_version" "fqdn" "hostname" "os" "name"}) ) :to_s )
@@ -54,7 +55,7 @@ module RuboCop
           def on_send(node)
             attribute_to_s?(node) do |method|
               add_offense(node, message: MSG, severity: :refactor) do |corrector|
-                corrector.replace(node.loc.expression, "node['#{method.value}']")
+                corrector.replace(node, "node['#{method.value}']")
               end
             end
           end

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

@@ -36,6 +36,7 @@ module RuboCop
           extend AutoCorrector
 
           MSG = 'There is no need to validate the input of properties in resources using a regex value that will always pass.'
+          RESTRICT_ON_SEND = [:property, :attribute].freeze
 
           def_node_matcher :property_with_regex_splat?, <<-PATTERN
             (send nil? {:property :attribute} (sym _) ... (hash <$(pair (sym :regex) (regexp (str ".*") (regopt))) ...>))

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

@@ -64,7 +64,7 @@ module RuboCop
                 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')
+                  corrector.replace(node, 'action :create_if_missing')
                 end
               end
             end

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

@@ -45,7 +45,7 @@ module RuboCop
 
           def on_send(node)
             property?(node) do
-              add_offense(node.loc.expression, message: MSG, severity: :refactor) unless description_hash?(node)
+              add_offense(node, message: MSG, severity: :refactor) unless description_hash?(node)
             end
           end
         end

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

@@ -51,7 +51,7 @@ module RuboCop
           def on_send(node)
             insecure_cb_url?(node) do
               add_offense(node, message: MSG, severity: :refactor) do |corrector|
-                corrector.replace(node.loc.expression, node.source.gsub(%r{http://(www.)*}, 'https://'))
+                corrector.replace(node, node.source.gsub(%r{http://(www.)*}, 'https://'))
               end
             end
           end

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

@@ -467,7 +467,7 @@ module RuboCop
               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
+                corrector.replace(license, "'#{correct_string}'") if correct_string
               end
             end
           end

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

@@ -45,6 +45,7 @@ module RuboCop
           include RuboCop::Cop::ConfigurableEnforcedStyle
 
           MSG = 'Use %s to access node attributes'
+          RESTRICT_ON_SEND = [:[]].freeze
 
           def_node_matcher :node_attribute_access?, <<-PATTERN
             (send (send _ :node) :[] _)
@@ -85,7 +86,7 @@ module RuboCop
                                 else # strings
                                   key_string.inspect
                                 end
-              corrector.replace(node.loc.expression, key_replacement)
+              corrector.replace(node, key_replacement)
             end
           end
         end

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

@@ -40,7 +40,7 @@ module RuboCop
 
             processed_source.comments.each do |comment|
               next unless comment.text.match?(/Chef [a-z]/) # https://rubular.com/r/0YzfDAbwJrDHix
-              add_offense(comment.loc.expression, message: MSG, severity: :refactor)
+              add_offense(comment, message: MSG, severity: :refactor)
             end
           end
         end

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

@@ -31,8 +31,8 @@ module RuboCop
 
             processed_source.comments.each do |comment|
               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('?  ', '? '))
+              add_offense(comment, location: comment, message: MSG, severity: :refactor) do |corrector|
+                corrector.replace(comment, comment.text.gsub('.  ', '. ').gsub('?  ', '? '))
               end
             end
           end

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

@@ -49,9 +49,9 @@ module RuboCop
             processed_source.comments.each do |comment|
               next unless comment.inline? && invalid_copyright_comment?(comment) # headers aren't in blocks
 
-              add_offense(comment, location: comment.loc.expression, message: MSG, severity: :refactor) do |corrector|
+              add_offense(comment, location: comment, message: MSG, severity: :refactor) do |corrector|
                 correct_comment = "# Copyright:: #{copyright_date_range(comment)}, #{copyright_holder(comment)}"
-                corrector.replace(comment.loc.expression, correct_comment)
+                corrector.replace(comment, correct_comment)
               end
             end
           end

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

@@ -41,7 +41,7 @@ module RuboCop
             processed_source.comments.each do |comment|
               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)
+              add_offense(comment, message: MSG, severity: :refactor)
             end
           end
         end

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

@@ -44,34 +44,27 @@ module RuboCop
           extend AutoCorrector
 
           MSG = 'Properly format header comments'
+          VERBOSE_COMMENT_REGEX = /^#\s*([A-Za-z]+)\s?(?:Name|File)?(?:::)?\s(.*)/.freeze
+          CHEF_LIKE_COMMENT_REGEX = /^#\s*(Author|Cookbook|Library|Attribute|Copyright|Recipe|Resource|Definition|License)\s+/.freeze
 
           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? && invalid_comment?(comment) # headers aren't in blocks
+              next unless comment.inline? && CHEF_LIKE_COMMENT_REGEX.match?(comment.text) # headers aren't in blocks
 
-              add_offense(comment.loc.expression, message: MSG, severity: :refactor) do |corrector|
+              add_offense(comment, 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)
+                match = VERBOSE_COMMENT_REGEX.match(comment.text)
                 comment_type, value = match.captures
                 correct_comment = "# #{comment_type}:: #{value}"
-                corrector.replace(comment.loc.expression, correct_comment)
+                corrector.replace(comment, correct_comment)
               end
             end
           end
-
-          private
-
-          def invalid_comment?(comment)
-            comment_types = %w(Author Cookbook Library Attribute Copyright Recipe Resource Definition License)
-            comment_types.any? do |comment_type|
-              /^#\s*#{comment_type}\s+/.match(comment.text)
-            end
-          end
         end
       end
     end

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

@@ -63,14 +63,14 @@ module RuboCop
 
           def on_send(node)
             resource_mode?(node) do |mode_int|
-              add_offense(mode_int.loc.expression, message: MSG, severity: :refactor) do |corrector|
+              add_offense(mode_int, 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(mode_int.loc.expression, "\'#{replacement_mode}\'")
+                corrector.replace(mode_int, "\'#{replacement_mode}\'")
               end
             end
           end