cookstyle 6.16.10 → 6.19.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1e15b2148d2b58205dc5b6653e3824b59dda2a927c1e0753f42d522105682021
-  data.tar.gz: e2c9f7bb6727c8f97b7de581e29b4f18db002b17f10732e115652e728f844ded
+  metadata.gz: 47388999a2aa49c2d130f1a553e2d17efec6090b4207e39557fc78acb8c4e5a8
+  data.tar.gz: c622b97ecf8c86b337c7bc63ff444c4b305a6a249cc40c598ea800a1ba9cae67
 SHA512:
-  metadata.gz: f9d1c969323e34fc6c58c987a9b339c625f2cfeb7b6ceeea83e7e7a0b5292dfe8d54e1f05dca2773ec582aaa6ad5b12914715d77b140906f14b8911406396d5e
-  data.tar.gz: e343548e500f20767be5ce478d47969677e31d9ebd1f8661cab493e9777eadd0e8ed09921a22690ef61a5ade718b8ae954bc1fa3464c01abbcd12cd6843e1273
+  metadata.gz: 4b1f192f83d65beb1360ff7df9648176bbc54398b39eb7e8791f0342f5152e5361bae374514fcb60134cb6348101c78047ab53d57efcfad3cccfa60e03de2234
+  data.tar.gz: db704725caa2dbfa226e6693bee8ced4adeaaf45d531c5665ff3c602cb7d9b3392676917d814f44b5bb4e7fb015c3c52ce94e812b6ef017fd117210d0ff35252

data/bin/cookstyle

@@ -1,8 +1,7 @@
 #!/usr/bin/env ruby
-# -*- encoding: utf-8 -*-
 # frozen_string_literal: true
 
-$LOAD_PATH.unshift File.join(File.dirname(__FILE__), %w(.. lib))
+$LOAD_PATH.unshift File.join(__dir__, %w(.. lib))
 
 require 'cookstyle'
 

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
 ###############################
@@ -908,10 +926,11 @@ ChefDeprecations/RubyBlockCreateAction:
     - '**/Berksfile'
 
 ChefDeprecations/DeprecatedPlatformMethods:
-  Description: Use provider_for_action instead of the deprecated Chef::Platform methods in resources.
+  Description: Use provider_for_action or provides instead of the deprecated Chef::Platform methods in resources.
   StyleGuide: '#chefdeprecationsdeprecatedplatformmethods'
   Enabled: true
   VersionAdded: '5.16.0'
+  VersionChanged: '6.17.0'
   Include:
     - '**/libraries/*.rb'
     - '**/resources/*.rb'
@@ -1062,6 +1081,46 @@ ChefDeprecations/CookbooksDependsOnSelf:
   Include:
     - '**/metadata.rb'
 
+ChefDeprecations/ChefShellout:
+  Description: Don't use deprecated Chef::ShellOut which was removed in Chef Infra Client 13. Use Mixlib::ShellOut instead, which behaves identically.
+  StyleGuide: '#chefdeprecationschefshellout'
+  Enabled: true
+  VersionAdded: '6.17.0'
+  Exclude:
+    - '**/metadata.rb'
+    - '**/attributes/*.rb'
+    - '**/Berksfile'
+
+ChefDeprecations/ExecutePathProperty:
+  Description: In Chef Infra Client 13 and later you must set path env vars in `execute` resources using the `environment` property not the legacy `path` property.
+  StyleGuide: '#chefdeprecationsexecutepathproperty'
+  Enabled: true
+  VersionAdded: '6.17.0'
+  Exclude:
+    - '**/metadata.rb'
+    - '**/attributes/*.rb'
+    - '**/Berksfile'
+
+ChefDeprecations/ExecuteRelativeCreatesWithoutCwd:
+  Description: In Chef Infra Client 13 and later you must either specify an absolute path when using the `execute` resource's `creates` property or also use the `cwd` property.
+  StyleGuide: '#chefdeprecationsexecuterelativecreateswithoutcwd'
+  Enabled: true
+  VersionAdded: '6.17.0'
+  Exclude:
+    - '**/metadata.rb'
+    - '**/attributes/*.rb'
+    - '**/Berksfile'
+
+ChefDeprecations/WindowsPackageInstallerTypeString:
+  Description: In Chef Infra Client 13 and later the `windows_package` resource's `installer_type` property must be a symbol.
+  StyleGuide: '#chefdeprecationswindowspackageinstallertypestring'
+  Enabled: true
+  VersionAdded: '6.17.0'
+  Exclude:
+    - '**/metadata.rb'
+    - '**/attributes/*.rb'
+    - '**/Berksfile'
+
 ###############################
 # ChefModernize: Cleaning up legacy code and using new built-in resources
 ###############################
@@ -1870,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
@@ -2302,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
@@ -2616,4 +2679,52 @@ 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,19 +7,19 @@ 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
     RUBOCOP_HOME.gsub!(
       /^.*$/,
-      File.realpath(File.join(File.dirname(__FILE__), '..'))
+      File.realpath(File.join(__dir__, '..'))
     )
 
     DEFAULT_FILE.gsub!(
@@ -46,7 +46,7 @@ require_relative 'rubocop/chef/cookbook_only'
 require_relative 'rubocop/cop/target_chef_version'
 
 # Chef Infra specific cops
-Dir.glob(File.dirname(__FILE__) + '/rubocop/cop/chef/**/*.rb') do |file|
+Dir.glob(__dir__ + '/rubocop/cop/chef/**/*.rb') do |file|
   next if File.directory?(file)
 
   require_relative file # not actually relative but require_relative is faster

data/lib/cookstyle/version.rb

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