cookstyle 6.17.6 → 6.20.1

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

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

@@ -47,8 +47,8 @@ module RuboCop
 
           def on_send(node)
             immediate_notify?(node) do |timing|
-              add_offense(timing.loc.expression, message: MSG, severity: :refactor) do |corrector|
-                corrector.replace(timing.loc.expression, ':immediately')
+              add_offense(timing, message: MSG, severity: :refactor) do |corrector|
+                corrector.replace(timing, ':immediately')
               end
             end
           end

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

@@ -47,8 +47,8 @@ module RuboCop
               # avoid chefspec: expect(chef_run).to include_recipe('foo')
               return if node.parent&.send_type?
 
-              add_offense(node.loc.expression, message: MSG, severity: :refactor) do |corrector|
-                corrector.replace(node.loc.expression, "include_recipe #{recipe.source}")
+              add_offense(node, message: MSG, severity: :refactor) do |corrector|
+                corrector.replace(node, "include_recipe #{recipe.source}")
               end
             end
           end

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

@@ -56,8 +56,8 @@ module RuboCop
               return if code.descendants.first.send_type? &&
                         code.descendants.first.negation_method?
 
-              add_offense(node.loc.expression, message: MSG, severity: :refactor) do |corrector|
-                corrector.replace(code.loc.expression, code.source.gsub(/^!/, ''))
+              add_offense(node, message: MSG, severity: :refactor) do |corrector|
+                corrector.replace(code, code.source.gsub(/^!/, ''))
                 corrector.replace(only_if.source_range, 'not_if')
               end
             end

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

@@ -57,9 +57,9 @@ module RuboCop
           def on_block(node)
             supports_depends_array?(node) do |array, type|
               return unless array.values.count < 3
-              add_offense(node.loc.expression, message: MSG, severity: :refactor) do |corrector|
+              add_offense(node, message: MSG, severity: :refactor) do |corrector|
                 corrected_value = array.values.map { |x| "#{type} '#{x.source}'" }
-                corrector.replace(node.loc.expression, corrected_value.join("\n"))
+                corrector.replace(node, corrected_value.join("\n"))
               end
             end
           end

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

@@ -38,6 +38,7 @@ module RuboCop
           extend AutoCorrector
 
           MSG = "Use node['platform_version'].to_i instead of node['platform_version'].split('.').first or node['platform_version'].split('.')[0]"
+          RESTRICT_ON_SEND = [:split].freeze
 
           def_node_matcher :platform_version_check?, <<-PATTERN
             (send (send (send nil? :node) :[] (str "platform_version") ) :split (str ".") )
@@ -65,7 +66,7 @@ module RuboCop
           def add_offense_to_i_if_present(node)
             node = node.parent if parent_method_equals?(node, :to_i)
             add_offense(node, message: MSG, severity: :refactor) do |corrector|
-              corrector.replace(node.loc.expression, "node['platform_version'].to_i")
+              corrector.replace(node, "node['platform_version'].to_i")
             end
           end
 

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

@@ -41,8 +41,8 @@ module RuboCop
 
           def on_send(node)
             trueclass_falseclass_property?(node) do |types|
-              add_offense(node.loc.expression, message: MSG, severity: :refactor) do |corrector|
-                corrector.replace(types.loc.expression, '[true, false]')
+              add_offense(node, message: MSG, severity: :refactor) do |corrector|
+                corrector.replace(types, '[true, false]')
               end
             end
           end

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

@@ -39,6 +39,7 @@ module RuboCop
           extend AutoCorrector
 
           MSG = "Use the platform_family?() helpers instead of node['os] == 'foo' for platform_families that match 1:1 with OS values."
+          RESTRICT_ON_SEND = [:==, :!=, :eql?, :include?].freeze
 
           # sorted list of all the os values that match 1:1 with a platform_family
           UNNECESSARY_OS_VALUES = %w(aix darwin dragonflybsd freebsd netbsd openbsd solaris2 windows).freeze
@@ -58,9 +59,9 @@ module RuboCop
           def on_send(node)
             os_equals?(node) do |operator, val|
               return unless UNNECESSARY_OS_VALUES.include?(val.value)
-              add_offense(node.loc.expression, message: MSG, severity: :refactor) do |corrector|
+              add_offense(node, message: MSG, severity: :refactor) do |corrector|
                 corrected_string = (operator == :!= ? '!' : '') + "platform_family?('#{sanitized_platform(val.value)}')"
-                corrector.replace(node.loc.expression, corrected_string)
+                corrector.replace(node, corrected_string)
               end
             end
 
@@ -68,7 +69,7 @@ module RuboCop
               return unless UNNECESSARY_OS_VALUES.include?(val.value)
               add_offense(node, message: MSG, severity: :refactor) do |corrector|
                 corrected_string = "platform_family?('#{sanitized_platform(val.value)}')"
-                corrector.replace(node.loc.expression, corrected_string)
+                corrector.replace(node, corrected_string)
               end
             end
 
@@ -79,7 +80,7 @@ module RuboCop
               add_offense(node, message: MSG, severity: :refactor) do |corrector|
                 platforms = val.values.map { |x| x.str_type? ? "'#{sanitized_platform(x.value)}'" : x.source }
                 corrected_string = "platform_family?(#{platforms.join(', ')})"
-                corrector.replace(node.loc.expression, corrected_string)
+                corrector.replace(node, corrected_string)
               end
             end
           end

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

@@ -56,7 +56,7 @@ module RuboCop
           def on_case(node)
             platform_case?(node) do |node_, type|
               return unless node&.when_branches&.count == 1
-              add_offense(node.loc.expression, message: MSG, severity: :refactor) do |corrector|
+              add_offense(node, message: MSG, severity: :refactor) do |corrector|
                 # we have at least one supermarket cookbook with an entirely empty platform case statement
                 # we can't actually fix that so let's do nothing here.
                 unless empty_case_statement?(node)
@@ -66,7 +66,7 @@ module RuboCop
                   # while multi-line statements should just have the case and when bits replace with `if platform?('ubuntu')`
                   if !node.else? && !node.when_branches.first.body.multiline?
                     new_source = "#{node.when_branches.first.body.source} if #{type.value}?(#{condition_string})"
-                    corrector.replace(node.loc.expression, new_source)
+                    corrector.replace(node, new_source)
                   else
                     # find the range from the beginning of the case to the end of the node['platform'] or node['platform_family']
                     case_range = node.loc.keyword.join(node_.loc.expression.end)

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

@@ -42,6 +42,7 @@ module RuboCop
           extend AutoCorrector
 
           MSG = "Use platform? and platform_family? helpers to check a node's platform"
+          RESTRICT_ON_SEND = [:==, :!=, :eql?, :include?].freeze
 
           def_node_matcher :platform_equals?, <<-PATTERN
             (send (send (send nil? :node) :[] $(str {"platform" "platform_family"}) ) ${:== :!=} $str )
@@ -57,24 +58,24 @@ module RuboCop
 
           def on_send(node)
             platform_equals?(node) do |type, operator, plat|
-              add_offense(node.loc.expression, message: MSG, severity: :refactor) do |corrector|
+              add_offense(node, message: MSG, severity: :refactor) do |corrector|
                 corrected_string = (operator == :!= ? '!' : '') + "#{type.value}?('#{plat.value}')"
-                corrector.replace(node.loc.expression, corrected_string)
+                corrector.replace(node, corrected_string)
               end
             end
 
             platform_include?(node) do |plats, type|
-              add_offense(node.loc.expression, message: MSG, severity: :refactor) do |corrector|
+              add_offense(node, message: MSG, severity: :refactor) do |corrector|
                 platforms = plats.values.map { |x| x.str_type? ? "'#{x.value}'" : x.source }
                 corrected_string = "#{type.value}?(#{platforms.join(', ')})"
-                corrector.replace(node.loc.expression, corrected_string)
+                corrector.replace(node, corrected_string)
               end
             end
 
             platform_eql?(node) do |type, plat|
-              add_offense(node.loc.expression, message: MSG, severity: :refactor) do |corrector|
+              add_offense(node, message: MSG, severity: :refactor) do |corrector|
                 corrected_string = "#{type.value}?('#{plat.value}')"
-                corrector.replace(node.loc.expression, corrected_string)
+                corrector.replace(node, corrected_string)
               end
             end
           end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cookstyle
 version: !ruby/object:Gem::Version
-  version: 6.17.6
+  version: 6.20.1
 platform: ruby
 authors:
 - Thom May
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-14 00:00:00.000000000 Z
+date: 2020-10-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -17,14 +17,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.90.0
+        version: 0.93.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.90.0
+        version: 0.93.0
 description: 
 email:
 - thom@chef.io
@@ -66,6 +66,7 @@ files:
 - lib/rubocop/cop/chef/correctness/invalid_value_for_platform_helper.rb
 - lib/rubocop/cop/chef/correctness/invalid_version_metadata.rb
 - lib/rubocop/cop/chef/correctness/lazy_eval_node_attribute_defaults.rb
+- lib/rubocop/cop/chef/correctness/lazy_in_resource_guard.rb
 - lib/rubocop/cop/chef/correctness/macos_userdefaults_invalid_type.rb
 - lib/rubocop/cop/chef/correctness/malformed_value_for_platform.rb
 - lib/rubocop/cop/chef/correctness/metadata_missing_name.rb
@@ -75,6 +76,7 @@ files:
 - lib/rubocop/cop/chef/correctness/notifies_action_not_symbol.rb
 - lib/rubocop/cop/chef/correctness/openssl_password_helpers.rb
 - lib/rubocop/cop/chef/correctness/powershell_delete_file.rb
+- lib/rubocop/cop/chef/correctness/property_without_type.rb
 - lib/rubocop/cop/chef/correctness/resource_sets_internal_properties.rb
 - lib/rubocop/cop/chef/correctness/resource_sets_name_property.rb
 - lib/rubocop/cop/chef/correctness/resource_with_none_action.rb
@@ -148,7 +150,9 @@ files:
 - lib/rubocop/cop/chef/deprecation/xml_ruby_recipe.rb
 - lib/rubocop/cop/chef/deprecation/yum_dnf_compat_recipe.rb
 - lib/rubocop/cop/chef/effortless/berksfile.rb
+- lib/rubocop/cop/chef/effortless/chef_vault_used.rb
 - lib/rubocop/cop/chef/effortless/data_bags.rb
+- lib/rubocop/cop/chef/effortless/depends_chef_vault.rb
 - lib/rubocop/cop/chef/effortless/node_environment.rb
 - lib/rubocop/cop/chef/effortless/node_policygroup.rb
 - lib/rubocop/cop/chef/effortless/node_roles.rb
@@ -276,7 +280,7 @@ metadata:
   homepage_uri: https://github.com/chef/cookstyle
   changelog_uri: https://github.com/chef/cookstyle/blob/master/CHANGELOG.md
   source_code_uri: https://github.com/chef/cookstyle
-  documentation_uri: https://docs.chef.io/cookstyle.html
+  documentation_uri: https://docs.chef.io/workstation/cookstyle/
   bug_tracker_uri: https://github.com/chef/cookstyle/issues
 post_install_message: 
 rdoc_options: []