cookstyle 6.17.5 → 6.19.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 76d0f2a3917c4ff1035541386d4edaa98f4cb782bd2f43a839d938b66aada708
-  data.tar.gz: ca7aff409b3d786fd71ac630c1d23b36f51a51ba495f7c2c4761c753c5e40624
+  metadata.gz: f26b00de7e92bb6cd6e16e2c323c66504b95a098512d78929dda659128c0f828
+  data.tar.gz: ae852bc01e5b7d9e2bab25ef88778650c46a0c0fb463286bc68dc8400892c215
 SHA512:
-  metadata.gz: 94bd535e28382dfd08776a053b8c6c9bb46e054a4dc3f10876b470de3755b3d6a78da9c71982ae3a7e0aee3856230e027ffe25457c77b8fd703df839acffeed4
-  data.tar.gz: f80c75e882aa27d4d4d81628c996acd2c2f5b1fc0226fafcd37b2ff86b2f9dddc9aa8f84c0b5cf4c8f71b1333757e2e239699966ac612902b426cae881ca91c1
+  metadata.gz: 69f6664c011cd99a25a1a2695c156190eea02c952e3dfcef41de670de003d3ccfb3a927c9967c3f1ea887294a0acdbd11280b61b410382dc20231fa408abf6a8
+  data.tar.gz: 1a0a759425be48591153c51e14d06324a3edc240eae193e99110870f62785405043f5847c5ee112157288c11c529614ed920fa17d3b281392d8798d8679723c2

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/bin/cookstyle

@@ -1,5 +1,4 @@
 #!/usr/bin/env ruby
-# -*- encoding: utf-8 -*-
 # frozen_string_literal: true
 
 $LOAD_PATH.unshift File.join(__dir__, %w(.. lib))

data/config/cookstyle.yml

@@ -451,6 +451,24 @@ ChefCorrectness/MacosUserdefaultsInvalidType:
     - '**/metadata.rb'
     - '**/Berksfile'
 
+ChefCorrectness/LazyInResourceGuard:
+  Description: Using `lazy {}` within a resource guard (not_if/only_if) will cause failures and is unnecessary as resource guards are always lazily evaluated.
+  StyleGuide: '#chefcorrectnesslazyinresourceguard'
+  Enabled: true
+  VersionAdded: '6.18.0'
+  Exclude:
+    - '**/metadata.rb'
+    - '**/Berksfile'
+
+ChefCorrectness/PropertyWithoutType:
+  Description: Custom resource properties or attributes should always define a type to help users understand the correct allowed values.
+  StyleGuide: '#chefcorrectnesspropertywithouttype'
+  Enabled: true
+  VersionAdded: '6.18.0'
+  Include:
+    - '**/libraries/*.rb'
+    - '**/resources/*.rb'
+
 ###############################
 # ChefSharing: Issues that prevent sharing code with other teams or with the Chef community in general
 ###############################
@@ -1911,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
@@ -2343,21 +2380,6 @@ Lint/UselessSetterCall:
 Lint/Void:
   Enabled: true
 
-##### Additional rules we enable/disable over the rubocop 0.37 rules ago #####
-
-Layout/AlignParameters:
-  Enabled: false
-Style/Encoding:
-  Enabled: false
-Style/Alias:
-  Enabled: false
-Layout/SpaceBeforeFirstArg:
-  Enabled: false
-Style/ClassAndModuleChildren:
-  Enabled: false
-Style/DoubleNegation:
-  Enabled: false
-
 # file names don't matter in cookbooks
 Naming/FileName:
   Enabled: false
@@ -2658,3 +2680,51 @@ Style/RedundantAssignment:
 # alert on invalid ruby
 Lint/Syntax:
   Enabled: true
+
+# remove extra requires like 'thread'
+Lint/RedundantRequireStatement:
+  Enabled: true
+
+# simplify stripping strings
+Style/Strip:
+  Enabled: true
+
+# simplify how you warn
+Style/StderrPuts:
+  Enabled: true
+
+# more code simplification
+Style/Sample:
+  Enabled: true
+
+# simpler returns
+Style/ReturnNil:
+  Enabled: true
+
+# use .sort when .sort_by isn't needed
+Style/RedundantSortBy:
+  Enabled: true
+
+# simplify getting min/max
+Style/RedundantSort:
+  Enabled: true
+
+# no need for .rb in requires
+Style/RedundantFileExtensionInRequire:
+  Enabled: true
+
+# more code you don't need
+Style/RedundantCondition:
+  Enabled: true
+
+# Ruby 2 makes these pointless
+Style/Encoding:
+  Enabled: true
+
+# Use  __dir__ to simplify things
+Style/Dir:
+  Enabled: true
+
+# Use __FILE__ or __dir__ to simplify expand_paths
+Style/ExpandPathArguments:
+  Enabled: true

data/config/disable_all.yml

@@ -25,6 +25,8 @@ Layout/ArrayAlignment:
   Enabled: false
 Layout/AssignmentIndentation:
   Enabled: false
+Layout/BeginEndAlignment:
+  Enabled: false
 Layout/BlockAlignment:
   Enabled: false
 Layout/BlockEndNewline:
@@ -215,6 +217,8 @@ Lint/BooleanSymbol:
   Enabled: false
 Lint/CircularArgumentReference:
   Enabled: false
+Lint/ConstantDefinitionInBlock:
+  Enabled: false
 Lint/ConstantResolution:
   Enabled: false
 Lint/Debugger:
@@ -267,6 +271,8 @@ Lint/FormatParameterMismatch:
   Enabled: false
 Lint/HeredocMethodCallPosition:
   Enabled: false
+Lint/IdentityComparison:
+  Enabled: false
 Lint/ImplicitStringConcatenation:
   Enabled: false
 Lint/InheritException:
@@ -395,6 +401,8 @@ Lint/UselessMethodDefinition:
   Enabled: false
 Lint/UselessSetterCall:
   Enabled: false
+Lint/UselessTimes:
+  Enabled: false
 Lint/Void:
   Enabled: false
 Metrics/CyclomaticComplexity:

data/config/upstream.yml

@@ -117,6 +117,8 @@ AllCops:
   # CacheRootDirectory is ~ (nil), which it is by default, the root will be
   # taken from the environment variable `$XDG_CACHE_HOME` if it is set, or if
   # `$XDG_CACHE_HOME` is not set, it will be `$HOME/.cache/`.
+  # The CacheRootDirectory can be overwritten by passing the `--cache-root` command
+  # line option or by setting `$RUBOCOP_CACHE_ROOT` environment variable.
   CacheRootDirectory: ~
   # It is possible for a malicious user to know the location of RuboCop's cache
   # directory by looking at CacheRootDirectory, and create a symlink in its
@@ -309,6 +311,19 @@ Layout/AssignmentIndentation:
   # But it can be overridden by setting this parameter
   IndentationWidth: ~
 
+Layout/BeginEndAlignment:
+  Description: 'Align ends corresponding to begins correctly.'
+  Enabled: pending
+  VersionAdded: '0.91'
+  # The value `start_of_line` means that `end` should be aligned the start of the line
+  # where the `begin` keyword is.
+  # The value `begin` means that `end` should be aligned with the `begin` keyword.
+  EnforcedStyleAlignWith: start_of_line
+  SupportedStylesAlignWith:
+    - start_of_line
+    - begin
+  Severity: warning
+
 Layout/BlockAlignment:
   Description: 'Align block ends correctly.'
   Enabled: true
@@ -1380,6 +1395,12 @@ Lint/CircularArgumentReference:
   Enabled: true
   VersionAdded: '0.33'
 
+Lint/ConstantDefinitionInBlock:
+  Description: 'Do not define constants within a block.'
+  StyleGuide: '#no-constant-definition-in-block'
+  Enabled: pending
+  VersionAdded: '0.91'
+
 Lint/ConstantResolution:
   Description: 'Check that constants are fully qualified with `::`.'
   Enabled: false
@@ -1533,6 +1554,12 @@ Lint/HeredocMethodCallPosition:
   StyleGuide: '#heredoc-method-calls'
   VersionAdded: '0.68'
 
+Lint/IdentityComparison:
+  Description: 'Prefer `equal?` over `==` when comparing `object_id`.'
+  Enabled: pending
+  StyleGuide: '#identity-comparison'
+  VersionAdded: '0.91'
+
 Lint/ImplicitStringConcatenation:
   Description: >-
                  Checks for adjacent string literals on the same line, which
@@ -1784,6 +1811,7 @@ Lint/SafeNavigationChain:
     - presence
     - try
     - try!
+    - in?
 
 Lint/SafeNavigationConsistency:
   Description: >-
@@ -1861,6 +1889,7 @@ Lint/Syntax:
   Enabled: true
   VersionAdded: '0.9'
 
+
 Lint/ToJSON:
   Description: 'Ensure #to_json includes an optional argument.'
   Enabled: true
@@ -1965,6 +1994,12 @@ Lint/UselessSetterCall:
   VersionChanged: '0.80'
   Safe: false
 
+Lint/UselessTimes:
+  Description: 'Checks for useless `Integer#times` calls.'
+  Enabled: pending
+  VersionAdded: '0.91'
+  Safe: false
+
 Lint/Void:
   Description: 'Possible use of operator/literal/variable in void context.'
   Enabled: true
@@ -2428,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:
@@ -2828,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:
@@ -3073,6 +3109,7 @@ Style/GlobalStdStream:
   StyleGuide: '#global-stdout'
   Enabled: pending
   VersionAdded: '0.89'
+  SafeAutoCorrect: false
 
 Style/GlobalVars:
   Description: 'Do not introduce global variables.'
@@ -3247,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.'
@@ -3684,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.'
@@ -3952,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'
@@ -3964,6 +4010,7 @@ Style/SafeNavigation:
     - presence
     - try
     - try!
+  SafeAutoCorrect: false
 
 Style/Sample:
   Description: >-

data/cookstyle.gemspec

@@ -1,6 +1,5 @@
-# coding: utf-8
 # frozen_string_literal: true
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'cookstyle/version'
 

data/lib/cookstyle.rb

@@ -7,13 +7,13 @@ require 'yaml' unless defined?(YAML)
 # ensure the desired target version of RuboCop is gem activated
 gem 'rubocop', "= #{Cookstyle::RUBOCOP_VERSION}"
 require 'rubocop'
-require_relative 'rubocop/monkey_patches/comment_config.rb'
+require_relative 'rubocop/monkey_patches/comment_config'
 
 # monkey patches needed for the TargetChefVersion config option
-require_relative 'rubocop/monkey_patches/config.rb'
-require_relative 'rubocop/monkey_patches/base.rb'
-require_relative 'rubocop/monkey_patches/team.rb'
-require_relative 'rubocop/monkey_patches/registry_cop.rb'
+require_relative 'rubocop/monkey_patches/config'
+require_relative 'rubocop/monkey_patches/base'
+require_relative 'rubocop/monkey_patches/team'
+require_relative 'rubocop/monkey_patches/registry_cop'
 
 module RuboCop
   class ConfigLoader

data/lib/cookstyle/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 module Cookstyle
-  VERSION = "6.17.5" # rubocop: disable Style/StringLiterals
-  RUBOCOP_VERSION = '0.90.0'
+  VERSION = "6.19.11" # 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

@@ -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

@@ -33,30 +33,40 @@ module RuboCop
         #   ::Chef::DSL::Recipe.send(:include, Filebeat::Helpers) # covers previous Recipe & Provider classes
         #
         class IncorrectLibraryInjection < Base
+          include RangeHelp
           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_matcher :legacy_class_sends?, <<-PATTERN
-            (send (const (const (cbase) :Chef) {:Recipe :Provider}) :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_matcher :legacy_class_includes?, <<-PATTERN
-            (send (const (const (cbase) :Chef) {:Recipe :Provider}) :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 on_send(node)
-            legacy_class_sends?(node) do
+            legacy_injection?(node) do
               add_offense(node, message: MSG, severity: :refactor) do |corrector|
-                corrector.replace(node.loc.expression,
-                  node.source.gsub(/Chef::(Provider|Recipe)/, 'Chef::DSL::Recipe'))
-              end
-            end
-
-            legacy_class_includes?(node) do
-              add_offense(node, message: MSG, severity: :refactor) do |corrector|
-                corrector.replace(node.loc.expression,
-                  node.source.gsub(/Chef::(Provider|Recipe)/, 'Chef::DSL::Recipe'))
+                if node.parent && correct_injection?(node.parent)
+                  corrector.remove(range_with_surrounding_space(range: node.loc.expression, side: :left))
+                else
+                  corrector.replace(node,
+                    node.source.gsub(/Chef::(Provider|Recipe)/, 'Chef::DSL::Recipe'))
+                end
               end
             end
           end