cookstyle 6.18.8 → 6.19.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5155a9b35b7783b4f93c60355db6c98114c8f337536cd468738d06481b5e8e7e
-  data.tar.gz: 0f7d7fae656539861f7bcdd6b4bda8463896eacd3a82c9ba4964b6ad4d35f193
+  metadata.gz: 47388999a2aa49c2d130f1a553e2d17efec6090b4207e39557fc78acb8c4e5a8
+  data.tar.gz: c622b97ecf8c86b337c7bc63ff444c4b305a6a249cc40c598ea800a1ba9cae67
 SHA512:
-  metadata.gz: de5247580b6f6432ac8d0fff694115b8c8765ec012c3f5686fd56453ea7ebb3b943c60025102d0a8531ecb0c605484786d3fa7c500819fd6d188bc8589e11a56
-  data.tar.gz: 54baddbe1f9419c2387ed4c94d678fdc7d599e903876ed84ccaa9aa99aa7add6443167b003f05a38f7f1b79d574e14507006650152a0bce0ed65d4ba368adf47
+  metadata.gz: 4b1f192f83d65beb1360ff7df9648176bbc54398b39eb7e8791f0342f5152e5361bae374514fcb60134cb6348101c78047ab53d57efcfad3cccfa60e03de2234
+  data.tar.gz: db704725caa2dbfa226e6693bee8ced4adeaaf45d531c5665ff3c602cb7d9b3392676917d814f44b5bb4e7fb015c3c52ce94e812b6ef017fd117210d0ff35252

data/config/cookstyle.yml

@@ -1929,6 +1929,25 @@ ChefEffortless/CookbookUsesDatabags:
   Exclude:
     - '**/metadata.rb'
     - '**/Berksfile'
+  
+# https://github.com/chef/cookstyle/issues/346
+ChefEffortless/ChefVaultUsed:
+  Description: Cookbook uses Chef Vault, which cannot be used in the Effortless Infra pattern
+  StyleGuide: '#chefeffortlesscookbookuseschefvault'
+  Enabled: false
+  VersionAdded: '6.19'
+  Exclude:
+    - '**/metadata.rb'
+    - '**/Berksfile'
+
+# https://github.com/chef/cookstyle/issues/346
+ChefEffortless/DependsChefVault:
+  Description: Cookbook depends on Chef Vault, which cannot be used in the Effortless Infra pattern
+  StyleGuide: '#chefeffortlesscookbookdependschefvault'
+  Enabled: false
+  VersionAdded: '6.19'
+  Include:
+    - '**/metadata.rb'
 
 ChefEffortless/CookbookUsesEnvironments:
   Description: Cookbook uses environments, which cannot be used in the Effortless Infra pattern

data/config/upstream.yml

@@ -2463,7 +2463,7 @@ Style/ArrayCoercion:
                   with a variable you want to treat as an Array, but you're not certain it's an array.
   StyleGuide: '#array-coercion'
   Safe: false
-  Enabled: 'pending'
+  Enabled: false
   VersionAdded: '0.88'
 
 Style/ArrayJoin:
@@ -2863,7 +2863,8 @@ Style/DateTime:
   StyleGuide: '#date--time'
   Enabled: false
   VersionAdded: '0.51'
-  VersionChanged: '0.59'
+  VersionChanged: '0.92'
+  SafeAutoCorrect: false
   AllowCoercion: false
 
 Style/DefWithParentheses:
@@ -3283,11 +3284,16 @@ Style/IpAddresses:
   Description: "Don't include literal IP addresses in code."
   Enabled: false
   VersionAdded: '0.58'
-  VersionChanged: '0.77'
+  VersionChanged: '0.91'
   # Allow addresses to be permitted
   AllowedAddresses:
     - "::"
     # :: is a valid IPv6 address, but could potentially be legitimately in code
+  Exclude:
+    - '**/*.gemfile'
+    - '**/Gemfile'
+    - '**/gems.rb'
+    - '**/*.gemspec'
 
 Style/KeywordParametersOrder:
   Description: 'Enforces that optional keyword parameters are placed at the end of the parameters list.'
@@ -3720,6 +3726,8 @@ Style/OptionalBooleanParameter:
   Enabled: pending
   Safe: false
   VersionAdded: '0.89'
+  AllowedMethods:
+    - respond_to_missing?
 
 Style/OrAssignment:
   Description: 'Recommend usage of double pipe equals (||=) where applicable.'
@@ -3988,6 +3996,8 @@ Style/SafeNavigation:
                   This cop transforms usages of a method call safeguarded by
                   a check for the existence of the object to
                   safe navigation (`&.`).
+                  Auto-correction is unsafe as it assumes the object will
+                  be `nil` or truthy, but never `false`.
   Enabled: true
   VersionAdded: '0.43'
   VersionChanged: '0.77'
@@ -4000,6 +4010,7 @@ Style/SafeNavigation:
     - presence
     - try
     - try!
+  SafeAutoCorrect: false
 
 Style/Sample:
   Description: >-

data/lib/cookstyle.rb

@@ -15,9 +15,6 @@ require_relative 'rubocop/monkey_patches/base'
 require_relative 'rubocop/monkey_patches/team'
 require_relative 'rubocop/monkey_patches/registry_cop'
 
-# @TODO remove this monkeypatch after we upgrade from 0.91.0
-require_relative 'rubocop/monkey_patches/rescue_ensure_alignment'
-
 module RuboCop
   class ConfigLoader
     RUBOCOP_HOME.gsub!(

data/lib/cookstyle/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 module Cookstyle
-  VERSION = "6.18.8" # rubocop: disable Style/StringLiterals
-  RUBOCOP_VERSION = '0.91.0'
+  VERSION = "6.19.5" # rubocop: disable Style/StringLiterals
+  RUBOCOP_VERSION = '0.92.0'
 end

data/lib/rubocop/cop/chef/correctness/block_guard_clause_string_only.rb

@@ -50,7 +50,7 @@ module RuboCop
             block_guard_with_only_string?(node) do
               add_offense(node, message: MSG, severity: :refactor) do |corrector|
                 new_val = "#{node.method_name} #{node.body.source}"
-                corrector.replace(node.loc.expression, new_val)
+                corrector.replace(node, new_val)
               end
             end
           end

data/lib/rubocop/cop/chef/correctness/chef_application_fatal.rb

@@ -44,7 +44,7 @@ module RuboCop
           def on_send(node)
             application_fatal?(node) do |val|
               add_offense(node, message: MSG, severity: :refactor) do |corrector|
-                corrector.replace(node.loc.expression, "raise(#{val.source})")
+                corrector.replace(node, "raise(#{val.source})")
               end
             end
           end

data/lib/rubocop/cop/chef/correctness/conditional_ruby_shellout.rb

@@ -58,7 +58,7 @@ module RuboCop
           def on_block(node)
             conditional_shellout?(node) do |type, val|
               add_offense(node, message: MSG, severity: :refactor) do |corrector|
-                corrector.replace(node.loc.expression, "#{type} #{val.source}")
+                corrector.replace(node, "#{type} #{val.source}")
               end
             end
           end

data/lib/rubocop/cop/chef/correctness/incorrect_library_injection.rb

@@ -38,51 +38,32 @@ module RuboCop
 
           MSG = 'Libraries should be injected into the Chef::DSL::Recipe class and not Chef::Recipe or Chef::Provider classes directly.'
 
-          def_node_search :correct_send?, <<-PATTERN
-            (send
-              (const
-                (const
-                  (const {cbase nil?} :Chef) :DSL) :Recipe) :send
-              (sym :include)
-            ... )
+          def_node_search :correct_injection?, <<-PATTERN
+            {(send
+               (const
+                 (const
+                   (const {cbase nil?} :Chef) :DSL) :Recipe) :send
+               (sym :include)
+             ... )
+             (send
+               (const
+                 (const
+                   (const {cbase nil?} :Chef) :DSL) :Recipe) :include
+             ... )}
           PATTERN
 
-          def_node_search :correct_include?, <<-PATTERN
-          (send
-            (const
-              (const
-                (const {cbase nil?} :Chef) :DSL) :Recipe) :include
-          ... )
+          def_node_matcher :legacy_injection?, <<-PATTERN
+            {(send (const (const {cbase nil?} :Chef) {:Recipe :Provider}) :send (sym :include) ... )
+             (send (const (const {cbase nil?} :Chef) {:Recipe :Provider}) :include ... )}
           PATTERN
 
-          def_node_matcher :legacy_class_sends?, <<-PATTERN
-            (send (const (const {cbase nil?} :Chef) {:Recipe :Provider}) :send (sym :include) ... )
-          PATTERN
-
-          def_node_matcher :legacy_class_include?, <<-PATTERN
-            (send (const (const {cbase nil?} :Chef) {:Recipe :Provider}) :include ... )
-          PATTERN
-
-          # @todo: This is highly repetitive and could be simplified into a single node_matcher
-          # call with some matcher magic that should be figured out
           def on_send(node)
-            legacy_class_sends?(node) do
-              add_offense(node, message: MSG, severity: :refactor) do |corrector|
-                if node.parent && correct_send?(node.parent)
-                  corrector.remove(range_with_surrounding_space(range: node.loc.expression, side: :left))
-                else
-                  corrector.replace(node.loc.expression,
-                    node.source.gsub(/Chef::(Provider|Recipe)/, 'Chef::DSL::Recipe'))
-                end
-              end
-            end
-
-            legacy_class_include?(node) do
+            legacy_injection?(node) do
               add_offense(node, message: MSG, severity: :refactor) do |corrector|
-                if node.parent && correct_include?(node.parent)
+                if node.parent && correct_injection?(node.parent)
                   corrector.remove(range_with_surrounding_space(range: node.loc.expression, side: :left))
                 else
-                  corrector.replace(node.loc.expression,
+                  corrector.replace(node,
                     node.source.gsub(/Chef::(Provider|Recipe)/, 'Chef::DSL::Recipe'))
                 end
               end

data/lib/rubocop/cop/chef/correctness/invalid_platform_family_values_in_case.rb

@@ -56,7 +56,7 @@ module RuboCop
                       range = range_with_surrounding_comma(range_with_surrounding_space(range: con.loc.expression, side: :left), :both)
                       corrector.remove(range)
                     else
-                      corrector.replace(con.loc.expression, "'#{new_value}'")
+                      corrector.replace(con, "'#{new_value}'")
                     end
                   end
                 end

data/lib/rubocop/cop/chef/correctness/invalid_platform_metadata.rb

@@ -56,7 +56,7 @@ module RuboCop
               add_offense(plat, message: MSG, severity: :refactor) do |corrector|
                 correct_string = corrected_platform_source(plat)
                 next unless correct_string
-                corrector.replace(plat.loc.expression, correct_string)
+                corrector.replace(plat, correct_string)
               end
             end
           end
@@ -68,7 +68,7 @@ module RuboCop
                 add_offense(plat, message: MSG, severity: :refactor) do |corrector|
                   correct_string = corrected_platform_source(plat)
                   next unless correct_string
-                  corrector.replace(plat.loc.expression, correct_string)
+                  corrector.replace(plat, correct_string)
                 end
               end
             end

data/lib/rubocop/cop/chef/correctness/invalid_platform_values_in_case.rb

@@ -55,7 +55,7 @@ module RuboCop
                       range = range_with_surrounding_comma(range_with_surrounding_space(range: con.loc.expression, side: :left), :both)
                       corrector.remove(range)
                     else
-                      corrector.replace(con.loc.expression, "'#{new_value}'")
+                      corrector.replace(con, "'#{new_value}'")
                     end
                   end
                 end

data/lib/rubocop/cop/chef/correctness/lazy_eval_node_attribute_defaults.rb

@@ -43,7 +43,7 @@ module RuboCop
           def on_send(node)
             non_lazy_node_attribute_default?(node) do |default|
               add_offense(default, message: MSG, severity: :refactor) do |corrector|
-                corrector.replace(default.loc.expression, "lazy { #{default.loc.expression.source} }")
+                corrector.replace(default, "lazy { #{default.source} }")
               end
             end
           end

data/lib/rubocop/cop/chef/correctness/lazy_in_resource_guard.rb

@@ -56,7 +56,7 @@ module RuboCop
           def on_block(node)
             lazy_in_guard?(node) do |type, code|
               add_offense(node, message: MSG, severity: :refactor) do |corrector|
-                corrector.replace(node.loc.expression, "#{type} { #{code.source} }")
+                corrector.replace(node, "#{type} { #{code.source} }")
               end
             end
           end

data/lib/rubocop/cop/chef/correctness/macos_userdefaults_invalid_type.rb

@@ -54,9 +54,9 @@ module RuboCop
             match_property_in_resource?(:macos_userdefaults, 'type', node) do |type|
               type_val = method_arg_ast_to_string(type)
               return if VALID_VALUES.include?(type_val)
-              add_offense(type.loc.expression, message: MSG, severity: :refactor) do |corrector|
+              add_offense(type, message: MSG, severity: :refactor) do |corrector|
                 next unless INVALID_VALUE_MAP[type_val]
-                corrector.replace(type.loc.expression, "type '#{INVALID_VALUE_MAP[type_val]}'")
+                corrector.replace(type, "type '#{INVALID_VALUE_MAP[type_val]}'")
               end
             end
           end

data/lib/rubocop/cop/chef/correctness/notifies_action_not_symbol.rb

@@ -53,7 +53,7 @@ module RuboCop
               return unless notifies_property.node_parts[2].str_type?
 
               add_offense(notifies_property, message: MSG, severity: :refactor) do |corrector|
-                corrector.replace(notifies_property.first_argument.loc.expression,
+                corrector.replace(notifies_property.first_argument,
                   ":#{notifies_property.node_parts[2].value}")
               end
             end

data/lib/rubocop/cop/chef/correctness/resource_with_none_action.rb

@@ -45,7 +45,7 @@ module RuboCop
               action_node.arguments.each do |action|
                 next unless action.source == ':none'
                 add_offense(action, message: MSG, severity: :refactor) do |corrector|
-                  corrector.replace(action.loc.expression, ':nothing')
+                  corrector.replace(action, ':nothing')
                 end
               end
             end

data/lib/rubocop/cop/chef/correctness/scoped_file_exist.rb

@@ -41,7 +41,7 @@ module RuboCop
           def on_block(node)
             unscoped_file_exist?(node) do |m|
               add_offense(m, message: MSG, severity: :refactor) do |corrector|
-                corrector.replace(m.loc.expression, '::File')
+                corrector.replace(m, '::File')
               end
             end
           end

data/lib/rubocop/cop/chef/correctness/supports_must_be_float.rb

@@ -41,8 +41,8 @@ module RuboCop
           def on_send(node)
             supports_with_constraint?(node) do |ver|
               return if ver.source.include?('.')
-              add_offense(ver.loc.expression, message: MSG, severity: :refactor) do |corrector|
-                corrector.replace(ver.loc.expression, ver.source.gsub(ver.value, (ver.value + '.0')))
+              add_offense(ver, message: MSG, severity: :refactor) do |corrector|
+                corrector.replace(ver, ver.source.gsub(ver.value, (ver.value + '.0')))
               end
             end
           end

data/lib/rubocop/cop/chef/deprecation/chef_handler_supports.rb

@@ -45,7 +45,7 @@ module RuboCop
               add_offense(prop_node, message: MSG, severity: :warning) do |corrector|
                 # make sure to delete leading and trailing {}s that would create invalid ruby syntax
                 extracted_val = prop_node.arguments.first.source.gsub(/{|}/, '')
-                corrector.replace(prop_node.loc.expression, "type #{extracted_val}")
+                corrector.replace(prop_node, "type #{extracted_val}")
               end
             end
           end

data/lib/rubocop/cop/chef/deprecation/chef_rewind.rb

@@ -79,7 +79,7 @@ module RuboCop
 
             rewind_resources?(node) do |string|
               add_offense(node, message: MSG, severity: :warning) do |corrector|
-                corrector.replace(node.loc.expression, node.source.gsub(string.to_s, MAPPING[string]))
+                corrector.replace(node, node.source.gsub(string.to_s, MAPPING[string]))
               end
             end
           end
@@ -88,7 +88,7 @@ module RuboCop
             match_property_in_resource?(:chef_gem, 'package_name', node) do |pkg_name|
               next unless pkg_name.arguments&.first&.str_content == 'chef-rewind'
               add_offense(node, message: MSG, severity: :warning) do |corrector|
-                corrector.remove(node.loc.expression) if pkg_name.arguments&.first&.str_content == 'chef-rewind'
+                corrector.remove(node) if pkg_name.arguments&.first&.str_content == 'chef-rewind'
               end
             end
           end

data/lib/rubocop/cop/chef/deprecation/chef_shellout.rb

@@ -75,7 +75,7 @@ module RuboCop
 
             shellout_new?(node) do
               add_offense(node, message: MSG, severity: :warning) do |corrector|
-                corrector.replace(node.loc.expression, node.source.gsub('Chef::ShellOut', 'Mixlib::ShellOut'))
+                corrector.replace(node, node.source.gsub('Chef::ShellOut', 'Mixlib::ShellOut'))
               end
             end
           end

data/lib/rubocop/cop/chef/deprecation/chef_windows_platform_helper.rb

@@ -43,7 +43,7 @@ module RuboCop
           def on_send(node)
             chef_platform_windows?(node) do
               add_offense(node, message: MSG, severity: :warning) do |corrector|
-                corrector.replace(node.loc.expression, "platform?('windows')")
+                corrector.replace(node, "platform?('windows')")
               end
             end
           end

data/lib/rubocop/cop/chef/deprecation/chefdk_generators.rb

@@ -47,7 +47,7 @@ module RuboCop
             return unless node.const_name == 'ChefDK' && (node.parent&.module_type? || node.parent&.const_type?)
 
             add_offense(node, message: MSG, severity: :warning) do |corrector|
-              corrector.replace(node.loc.expression, node.source.gsub('ChefDK', 'ChefCLI'))
+              corrector.replace(node, node.source.gsub('ChefDK', 'ChefCLI'))
             end
           end
         end

data/lib/rubocop/cop/chef/deprecation/chefspec_coverage_report.rb

@@ -39,7 +39,7 @@ module RuboCop
           def on_block(node)
             coverage_reporter?(node) do
               add_offense(node, message: MSG, severity: :warning) do |corrector|
-                corrector.remove(node.loc.expression)
+                corrector.remove(node)
               end
             end
           end

data/lib/rubocop/cop/chef/deprecation/chefspec_legacy_runner.rb

@@ -51,7 +51,7 @@ module RuboCop
           def on_const(node)
             chefspec_runner?(node) do
               add_offense(node, message: MSG, severity: :warning) do |corrector|
-                corrector.replace(node.loc.expression, 'ChefSpec::ServerRunner')
+                corrector.replace(node, 'ChefSpec::ServerRunner')
               end
             end
           end

data/lib/rubocop/cop/chef/deprecation/deprecated_chefspec_platform.rb

@@ -120,7 +120,7 @@ module RuboCop
               next unless legacy_chefspec_platform(plat.value, ver.value)
               add_offense(node, message: MSG, severity: :warning) do |corrector|
                 if replacement = replacement_string(plat.value, ver.value) # rubocop: disable Lint/AssignmentInCondition
-                  corrector.replace(ver.loc.expression, "'#{replacement}'")
+                  corrector.replace(ver, "'#{replacement}'")
                 end
               end
             end

data/lib/rubocop/cop/chef/deprecation/deprecated_yum_repository_properties.rb

@@ -54,7 +54,7 @@ module RuboCop
             %w(url keyurl mirrorexpire).each do |prop|
               match_property_in_resource?(:yum_repository, prop, node) do |prop_node|
                 add_offense(prop_node, message: MSG, severity: :warning)  do |corrector|
-                  corrector.replace(prop_node.loc.expression, prop_node.loc.expression.source
+                  corrector.replace(prop_node, prop_node.source
                     .gsub(/^url/, 'baseurl')
                     .gsub(/^keyurl/, 'gpgkey')
                     .gsub(/^mirrorexpire/, 'mirror_expire'))

data/lib/rubocop/cop/chef/deprecation/epic_fail.rb

@@ -42,7 +42,7 @@ module RuboCop
 
           def on_send(node)
             add_offense(node, message: MSG, severity: :warning) do |corrector|
-              corrector.replace(node.loc.expression, 'ignore_failure true')
+              corrector.replace(node, 'ignore_failure true')
             end
           end
         end

data/lib/rubocop/cop/chef/deprecation/execute_path_property.rb

@@ -41,7 +41,7 @@ module RuboCop
 
           def on_block(node)
             match_property_in_resource?(:execute, 'path', node) do |offense|
-              add_offense(offense.loc.expression, message: MSG, severity: :warning) # @todo: we could probably autocorrect this with some work
+              add_offense(offense, message: MSG, severity: :warning) # @todo: we could probably autocorrect this with some work
             end
           end
         end