cookstyle 6.17.7 → 6.20.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0385aed05c2f7b990958984ace106ea1f8b12d62feae5ba63fc0c382a880f678'
-  data.tar.gz: e7888f5a8f5959069e00a5d3be8ce8a80325b34fe0d943baddb8a414f97947fd
+  metadata.gz: a36b09fd24530545b460de33db7f7239f2f64af587d5ccdf417335b9726be284
+  data.tar.gz: d2e4de150fee0df25842ced5f5b073b684e37922703111ac18e06125c68b0a41
 SHA512:
-  metadata.gz: a89eab0482fd1c1c158b9f5ead6f61b4693a391fd88855bba6b5e46f60ae3ebb28074ef7782e4d249cd097ebd8093461c25baaff2c699ae214bc12d8584b95ef
-  data.tar.gz: b125b09055b3388353ac3374ea1aa5061dc6dfe75f051a538004ed13d064820e40920d2d13fd2a0557cfe3b602237f346b7316adaa2e1174f9b0e4400ff7e71b
+  metadata.gz: 7b5dac93d379ff0a7445e9eb2d5743e1c547ec0c3e8c5bff64e1d6c44b45817131b9f7c24ae94dc02b969fd652cb917529a74305b37827d9c317093223a11949
+  data.tar.gz: f7dc13cb996e1d78e7660e50b3431401e85a64cd54529c99ccee33fd6f273c73e3ffe54f0cbaa6dd5b9bd0c500a40b0a5d0bbe94c7ae87f5b563aeb4e4b669f5

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
 ###############################
@@ -1912,6 +1930,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'
@@ -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,55 @@ 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
+
+# Avoid a safe navigation operator if we don't need it
+Lint/RedundantSafeNavigation:
+  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:
@@ -265,8 +269,12 @@ Lint/FloatOutOfRange:
   Enabled: false
 Lint/FormatParameterMismatch:
   Enabled: false
+Lint/HashCompareByIdentity:
+  Enabled: false
 Lint/HeredocMethodCallPosition:
   Enabled: false
+Lint/IdentityComparison:
+  Enabled: false
 Lint/ImplicitStringConcatenation:
   Enabled: false
 Lint/InheritException:
@@ -321,6 +329,8 @@ Lint/RedundantCopEnableDirective:
   Enabled: false
 Lint/RedundantRequireStatement:
   Enabled: false
+Lint/RedundantSafeNavigation:
+  Enabled: false
 Lint/RedundantSplatExpansion:
   Enabled: false
 Lint/RedundantStringCoercion:
@@ -395,6 +405,8 @@ Lint/UselessMethodDefinition:
   Enabled: false
 Lint/UselessSetterCall:
   Enabled: false
+Lint/UselessTimes:
+  Enabled: false
 Lint/Void:
   Enabled: false
 Metrics/CyclomaticComplexity:
@@ -485,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

@@ -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
@@ -1525,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
@@ -1533,6 +1561,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
@@ -1719,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
@@ -1784,6 +1831,7 @@ Lint/SafeNavigationChain:
     - presence
     - try
     - try!
+    - in?
 
 Lint/SafeNavigationConsistency:
   Description: >-
@@ -1861,6 +1909,7 @@ Lint/Syntax:
   Enabled: true
   VersionAdded: '0.9'
 
+
 Lint/ToJSON:
   Description: 'Ensure #to_json includes an optional argument.'
   Enabled: true
@@ -1965,6 +2014,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 +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:
@@ -2667,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'
@@ -2828,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:
@@ -3073,6 +3139,7 @@ Style/GlobalStdStream:
   StyleGuide: '#global-stdout'
   Enabled: pending
   VersionAdded: '0.89'
+  SafeAutoCorrect: false
 
 Style/GlobalVars:
   Description: 'Do not introduce global variables.'
@@ -3247,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.'
@@ -3684,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.'
@@ -3952,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'
@@ -3964,6 +4040,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'
 
@@ -25,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

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