cookstyle 6.18.8 → 6.21.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5155a9b35b7783b4f93c60355db6c98114c8f337536cd468738d06481b5e8e7e
-  data.tar.gz: 0f7d7fae656539861f7bcdd6b4bda8463896eacd3a82c9ba4964b6ad4d35f193
+  metadata.gz: e79caedf06c2358db6d9d303270d2245f46e66eb65119f4c8a1181081fb57994
+  data.tar.gz: b79613983ad7cdfb9715674680c0ac429490ee79cd843892489e3ced7f5f243d
 SHA512:
-  metadata.gz: de5247580b6f6432ac8d0fff694115b8c8765ec012c3f5686fd56453ea7ebb3b943c60025102d0a8531ecb0c605484786d3fa7c500819fd6d188bc8589e11a56
-  data.tar.gz: 54baddbe1f9419c2387ed4c94d678fdc7d599e903876ed84ccaa9aa99aa7add6443167b003f05a38f7f1b79d574e14507006650152a0bce0ed65d4ba368adf47
+  metadata.gz: 2e32c80c8e7b16e49d8cfdc89b0c8adafa122e55ab9aad418c23f0b7becf569c3e725cf58c0853a561916e9522ef42584aa37e78f0e5e906e6e0955e0f0d14ef
+  data.tar.gz: b015d7a4c96c353d37589210a88c9e1e13472d0695a38a630b6bbdfa18049d63287529359e199770d20eb67040f1eb9047e2561e32bdab4c3c18ee4cbc5b6b6b

data/Gemfile

@@ -17,8 +17,12 @@ group :docs do
 end
 
 group :profiling do
-  gem 'stackprof'
   gem 'memory_profiler'
+  gem 'stackprof'
+end
+
+group :rubocop_gems do
+  gem 'rubocop-performance'
 end
 
 group :development do

data/config/cookstyle.yml

@@ -469,6 +469,16 @@ ChefCorrectness/PropertyWithoutType:
     - '**/libraries/*.rb'
     - '**/resources/*.rb'
 
+ChefCorrectness/OctalModeAsString:
+  Description: Don't represent file modes as strings containing octal values. Use standard base 10 file modes instead.
+  StyleGuide: '#chefcorrectnessoctalmodeasstring'
+  Enabled: true
+  VersionAdded: '6.21.0'
+  Exclude:
+    - '**/attributes/*.rb'
+    - '**/metadata.rb'
+    - '**/Berksfile'
+
 ###############################
 # ChefSharing: Issues that prevent sharing code with other teams or with the Chef community in general
 ###############################
@@ -1121,6 +1131,12 @@ ChefDeprecations/WindowsPackageInstallerTypeString:
     - '**/attributes/*.rb'
     - '**/Berksfile'
 
+ChefDeprecations/UseYamlDump:
+  Description: Chef Infra Client 16.5 introduced performance enhancements to Ruby library loading. Due to the underlying implementation of Ruby's `.to_yaml` method, it does not automatically load the `yaml` library and `YAML.dump()` should be used instead to properly load the `yaml` library.
+  StyleGuide: '#chefdeprecationsuseyamldump'
+  Enabled: true
+  VersionAdded: '6.21.0'
+
 ###############################
 # ChefModernize: Cleaning up legacy code and using new built-in resources
 ###############################
@@ -1930,6 +1946,25 @@ ChefEffortless/CookbookUsesDatabags:
     - '**/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
   StyleGuide: '#chefeffortlesscookbookusesenvironments'
@@ -2708,4 +2743,8 @@ Style/Dir:
 
 # Use __FILE__ or __dir__ to simplify expand_paths
 Style/ExpandPathArguments:
+  Enabled: true
+
+# Avoid a safe navigation operator if we don't need it
+Lint/RedundantSafeNavigation:
   Enabled: true

data/config/disable_all.yml

@@ -269,6 +269,8 @@ Lint/FloatOutOfRange:
   Enabled: false
 Lint/FormatParameterMismatch:
   Enabled: false
+Lint/HashCompareByIdentity:
+  Enabled: false
 Lint/HeredocMethodCallPosition:
   Enabled: false
 Lint/IdentityComparison:
@@ -327,6 +329,8 @@ Lint/RedundantCopEnableDirective:
   Enabled: false
 Lint/RedundantRequireStatement:
   Enabled: false
+Lint/RedundantSafeNavigation:
+  Enabled: false
 Lint/RedundantSplatExpansion:
   Enabled: false
 Lint/RedundantStringCoercion:
@@ -493,6 +497,8 @@ Style/ClassAndModuleChildren:
   Enabled: false
 Style/ClassCheck:
   Enabled: false
+Style/ClassEqualityComparison:
+  Enabled: false
 Style/ClassMethods:
   Enabled: false
 Style/ClassMethodsDefinitions:

data/config/upstream.yml

@@ -1546,6 +1546,13 @@ Lint/FormatParameterMismatch:
   Enabled: true
   VersionAdded: '0.33'
 
+Lint/HashCompareByIdentity:
+  Description: 'Prefer using `Hash#compare_by_identity` than using `object_id` for keys.'
+  StyleGuide: '#identity-comparison'
+  Enabled: pending
+  Safe: false
+  VersionAdded: '0.93'
+
 Lint/HeredocMethodCallPosition:
   Description: >-
                  Checks for the ordering of a method call where
@@ -1746,6 +1753,19 @@ Lint/RedundantRequireStatement:
   Enabled: true
   VersionAdded: '0.76'
 
+Lint/RedundantSafeNavigation:
+  Description: 'Checks for redundant safe navigation calls.'
+  Enabled: pending
+  VersionAdded: '0.93'
+  AllowedMethods:
+    - instance_of?
+    - kind_of?
+    - is_a?
+    - eql?
+    - respond_to?
+    - equal?
+  Safe: false
+
 Lint/RedundantSplatExpansion:
   Description: 'Checks for splat unnecessarily being called on literals.'
   Enabled: true
@@ -2463,7 +2483,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:
@@ -2702,6 +2722,16 @@ Style/ClassCheck:
     - is_a?
     - kind_of?
 
+Style/ClassEqualityComparison:
+  Description: 'Enforces the use of `Object#instance_of?` instead of class comparison for equality.'
+  StyleGuide: '#instance-of-vs-class-comparison'
+  Enabled: pending
+  VersionAdded: '0.93'
+  IgnoredMethods:
+    - ==
+    - equal?
+    - eql?
+
 Style/ClassMethods:
   Description: 'Use self when defining module/class methods.'
   StyleGuide: '#def-self-class-methods'
@@ -2863,7 +2893,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 +3314,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 +3756,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 +4026,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 +4040,7 @@ Style/SafeNavigation:
     - presence
     - try
     - try!
+  SafeAutoCorrect: false
 
 Style/Sample:
   Description: >-

data/cookstyle.gemspec

@@ -24,7 +24,7 @@ Gem::Specification.new do |spec|
     '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',
   }
 end

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.21.1" # rubocop: disable Style/StringLiterals
+  RUBOCOP_VERSION = '0.93.1'
 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

@@ -33,6 +33,7 @@ module RuboCop
           extend AutoCorrector
 
           MSG = 'Use raise to force Chef Infra Client to fail instead of using Chef::Application.fatal'
+          RESTRICT_ON_SEND = [:fatal!].freeze
 
           def_node_matcher :application_fatal?, <<-PATTERN
             (send
@@ -44,7 +45,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

@@ -37,52 +37,34 @@ module RuboCop
           extend AutoCorrector
 
           MSG = 'Libraries should be injected into the Chef::DSL::Recipe class and not Chef::Recipe or Chef::Provider classes directly.'
+          RESTRICT_ON_SEND = [:send, :include].freeze
 
-          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

@@ -35,6 +35,7 @@ module RuboCop
           include ::RuboCop::Chef::PlatformHelpers
 
           MSG = 'Use valid platform values in case statements.'
+          RESTRICT_ON_SEND = [:[]].freeze
 
           def_node_matcher :node_platform?, <<-PATTERN
             (send (send nil? :node) :[] (str "platform") )
@@ -55,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_version_metadata.rb

@@ -32,6 +32,7 @@ module RuboCop
         #
         class InvalidVersionMetadata < Base
           MSG = 'Cookbook metadata.rb version field should follow X.Y.Z version format.'
+          RESTRICT_ON_SEND = [:version].freeze
 
           def_node_matcher :version?, '(send nil? :version $str ...)'
 

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