cookstyle 7.9.0 → 7.12.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f14be569aa75ce6cbc63f43ef13e5c5d3d0e51e3f2b26abb27cf6b41b4d569bb
-  data.tar.gz: 87a712993bfe562d10584493186d2f9380eec2eb33ed7b52d5706254da4b08fb
+  metadata.gz: 68835852d8021cee74896aa171d78ca5b540fca9fdee42632719d867910c107e
+  data.tar.gz: f71d3a8f4bc874dd86f81b0b01d4caa929ba62c2bf2222ca66a3e726eb398611
 SHA512:
-  metadata.gz: 86b7f37b93c00abd3653020f87aa245328d013835a1902a2f47dac4a32cb6cc651fbb36abfa667ef85798f1bddb4a4d2350b461fd41eb89368df3dc5e815e58d
-  data.tar.gz: 0fa5eb548ea0780d28b121e9ab83e3cd1548f7d75d2cc39d7e9e2d6e3f30427d98aa9ff6ac1a13ac8f7d43131cbcf74c032ebc3b0e6bef7fc9e8f449a3193dcd
+  metadata.gz: a8ce79400b3866f0ac4b5b94ed0eb39da7a7b19dcd6dcf5fb0e6347affc31a70c0d56d8e2d671b776cea74465b6c715a20d9d88b3941291655ed01833c38796b
+  data.tar.gz: 1d324b44b1ce454718685eb5339e14d4063072b2d66dec6707091a871aa1fbef6f8eb4a13aeee683552b4b6d54f0821b5fa82493b4bde31d62aac48e9577a396

data/config/cookstyle.yml

@@ -1,6 +1,6 @@
 AllCops:
   SuggestExtensions: false
-  TargetRubyVersion: 2.4
+  TargetRubyVersion: 2.5
   TargetChefVersion: ~
   Exclude:
     - '/**/files/**/*'
@@ -221,7 +221,7 @@ Chef/Correctness/MetadataMissingName:
     - '**/metadata.rb'
 
 Chef/Correctness/BlockGuardWithOnlyString:
-  Description: A resource guard (not_if/only_if) that is a string should not be wrapped in {}. Wrapping a guard string in {} causes it to be executed as Ruby code which will always returns true instead of a shell command that will actually run.
+  Description: A resource guard (not_if/only_if) that is a string should not be wrapped in {}. Wrapping a guard string in {} causes it to be executed as Ruby code which will always return true instead of a shell command that will actually run.
   StyleGuide: 'chef_correctness_blockguardwithonlystring'
   Enabled: true
   VersionAdded: '5.2.0'
@@ -584,7 +584,7 @@ Chef/Deprecations/NodeSetUnless:
     - '**/Berksfile'
 
 Chef/Deprecations/EpicFail:
-  Description: Use ignore_failure method instead of the deprecated epic_fail method
+  Description: Use `ignore_failure` in resources to continue when failures occur instead of the deprecated `epic_fail` property
   StyleGuide: 'chef_deprecations_epicfail'
   Enabled: true
   VersionAdded: '5.1.0'
@@ -843,7 +843,7 @@ Chef/Deprecations/DeprecatedYumRepositoryProperties:
     - '**/Berksfile'
 
 Chef/Deprecations/EOLAuditModeUsage:
-  Description: The beta Audit Mode feature in Chef Infra Client was removed in Chef Infra Client 15.0. Users should instead use InSpec and the audit cookbook. See https://www.inspec.io/ for more information.
+  Description: The beta Audit Mode feature in Chef Infra Client was removed in Chef Infra Client 15.0.
   StyleGuide: 'chef_deprecations_eolauditmodeusage'
   Enabled: true
   VersionAdded: '5.10.0'
@@ -1071,7 +1071,7 @@ Chef/Deprecations/ChefDKGenerators:
     - '**/Berksfile'
 
 Chef/Deprecations/ChefHandlerRecipe:
-  Description: There is no need to include the empty and deprecated chef_handler::default recipe in order to use the chef_handler resource.
+  Description: There is no need to include the empty and deprecated chef_handler::default recipe to use the chef_handler resource.
   StyleGuide: 'chef_deprecations_chefhandlerrecipe'
   Enabled: true
   VersionAdded: '6.12.0'
@@ -1107,7 +1107,7 @@ Chef/Deprecations/CookbooksDependsOnSelf:
     - '**/metadata.rb'
 
 Chef/Deprecations/ChefShellout:
-  Description: Don't use deprecated Chef::ShellOut which was removed in Chef Infra Client 13. Use Mixlib::ShellOut instead, which behaves identically.
+  Description: Don't use the deprecated `Chef::ShellOut` class which was removed in Chef Infra Client 13. Use the `Mixlib::ShellOut` class instead, which behaves identically.
   StyleGuide: 'chef_deprecations_chefshellout'
   Enabled: true
   VersionAdded: '6.17.0'
@@ -1190,6 +1190,22 @@ Chef/Deprecations/ChefSugarHelpers:
     - '**/Berksfile'
     - '**/Rakefile'
 
+Chef/Deprecations/HWRPWithoutUnifiedTrue:
+  Description: Set `unified_mode true` in Chef Infra Client 15.3+ HWRP style custom resources to ensure they work correctly in Chef Infra Client 18 (April 2022) when Unified Mode becomes the default.
+  StyleGuide: 'chef_deprecations_hwrpwithoutunifiedtrue'
+  Enabled: true
+  VersionAdded: '7.12.0'
+  Include:
+    - '**/libraries/*.rb'
+
+Chef/Deprecations/ResourceWithoutUnifiedTrue:
+  Description: Set `unified_mode true` in Chef Infra Client 15.3+ custom resources to ensure they work correctly in Chef Infra Client 18 (April 2022) when Unified Mode becomes the default.
+  StyleGuide: 'chef_deprecations_resourcewithoutunifiedtrue'
+  Enabled: true
+  VersionAdded: '7.12.0'
+  Include:
+    - '**/resources/*.rb'
+
 ###############################
 # Chef/Modernize: Cleaning up legacy code and using new built-in resources
 ###############################
@@ -2247,8 +2263,9 @@ Style/Proc:
   Enabled: true
 Style/RaiseArgs:
   Enabled: true
+# disabled for now as this breaks ruby_block resources
 Style/RedundantBegin:
-  Enabled: true
+  Enabled: false
 Style/RedundantException:
   Enabled: true
 Style/RedundantFreeze:

data/config/disable_all.yml

@@ -5,6 +5,8 @@ Bundler/DuplicatedGem:
   Enabled: false
 Bundler/GemComment:
   Enabled: false
+Bundler/GemVersion:
+  Enabled: false
 Bundler/InsecureProtocolSource:
   Enabled: false
 Bundler/OrderedGems:
@@ -147,8 +149,12 @@ Layout/MultilineOperationIndentation:
   Enabled: false
 Layout/ParameterAlignment:
   Enabled: false
+Layout/RedundantLineBreak:
+  Enabled: false
 Layout/RescueEnsureAlignment:
   Enabled: false
+Layout/SingleLineBlockChain:
+  Enabled: false
 Layout/SpaceAfterColon:
   Enabled: false
 Layout/SpaceAfterComma:
@@ -851,6 +857,8 @@ Style/StabbyLambdaParentheses:
   Enabled: false
 Style/StderrPuts:
   Enabled: false
+Style/StringChars:
+  Enabled: false
 Style/StringConcatenation:
   Enabled: false
 Style/StringHashKeys:

data/config/upstream.yml

@@ -130,7 +130,7 @@ AllCops:
   # What MRI version of the Ruby interpreter is the inspected code intended to
   # run on? (If there is more than one, set this to the lowest version.)
   # If a value is specified for TargetRubyVersion then it is used. Acceptable
-  # values are specificed as a float (i.e. 2.5); the teeny version of Ruby
+  # values are specificed as a float (i.e. 3.0); the teeny version of Ruby
   # should not be included. If the project specifies a Ruby version in the
   # .tool-versions or .ruby-version files, Gemfile or gems.rb file, RuboCop will
   # try to determine the desired version of Ruby by inspecting the
@@ -138,7 +138,7 @@ AllCops:
   # or gems.locked file. (Although the Ruby version is specified in the Gemfile
   # or gems.rb file, RuboCop reads the final value from the lock file.) If the
   # Ruby version is still unresolved, RuboCop will use the oldest officially
-  # supported Ruby version (currently Ruby 2.4).
+  # supported Ruby version (currently Ruby 2.5).
   TargetRubyVersion: ~
   # Determines if a notification for extension libraries should be shown when
   # rubocop is run. Keys are the name of the extension, and values are an array
@@ -174,6 +174,20 @@ Bundler/GemComment:
   IgnoredGems: []
   OnlyFor: []
 
+Bundler/GemVersion:
+  Description: 'Requires or forbids specifying gem versions.'
+  Enabled: false
+  VersionAdded: '1.14'
+  EnforcedStyle: 'required'
+  SupportedStyles:
+    - 'required'
+    - 'forbidden'
+  Include:
+    - '**/*.gemfile'
+    - '**/Gemfile'
+    - '**/gems.rb'
+  AllowedGems: []
+
 Bundler/InsecureProtocolSource:
   Description: >-
                  The source `:gemcutter`, `:rubygems` and `:rubyforge` are deprecated
@@ -1101,11 +1115,24 @@ Layout/ParameterAlignment:
   # But it can be overridden by setting this parameter
   IndentationWidth: ~
 
+Layout/RedundantLineBreak:
+  Description: >-
+                 Do not break up an expression into multiple lines when it fits
+                 on a single line.
+  Enabled: false
+  InspectBlocks: false
+  VersionAdded: '1.13'
+
 Layout/RescueEnsureAlignment:
   Description: 'Align rescues and ensures correctly.'
   Enabled: true
   VersionAdded: '0.49'
 
+Layout/SingleLineBlockChain:
+  Description: 'Put method call on a separate line if chained to a single line block.'
+  Enabled: false
+  VersionAdded: '1.14'
+
 Layout/SpaceAfterColon:
   Description: 'Use spaces after colons.'
   StyleGuide: '#spaces-operators'
@@ -1380,6 +1407,8 @@ Lint/AmbiguousBlockAssociation:
   StyleGuide: '#syntax'
   Enabled: true
   VersionAdded: '0.48'
+  VersionChanged: '1.13'
+  IgnoredMethods: []
 
 Lint/AmbiguousOperator:
   Description: >-
@@ -2055,13 +2084,18 @@ Lint/SuppressedException:
   StyleGuide: '#dont-hide-exceptions'
   Enabled: true
   AllowComments: true
+  AllowNil: true
   VersionAdded: '0.9'
-  VersionChanged: '0.81'
+  VersionChanged: '1.12'
 
 Lint/SymbolConversion:
   Description: 'Checks for unnecessary symbol conversions.'
   Enabled: pending
   VersionAdded: '1.9'
+  EnforcedStyle: strict
+  SupportedStyles:
+    - strict
+    - consistent
 
 Lint/Syntax:
   Description: 'Checks for syntax errors.'
@@ -2489,6 +2523,7 @@ Naming/MemoizedInstanceVariableName:
     - disallowed
     - required
     - optional
+  Safe: false
 
 Naming/MethodName:
   Description: 'Use the configured style when naming methods.'
@@ -3174,6 +3209,7 @@ Style/Documentation:
   Description: 'Document classes and non-namespace modules.'
   Enabled: true
   VersionAdded: '0.9'
+  AllowedConstants: []
   Exclude:
     - 'spec/**/*'
     - 'test/**/*'
@@ -3672,6 +3708,7 @@ Style/MethodCallWithArgsParentheses:
   AllowParenthesesInMultilineCall: false
   AllowParenthesesInChaining: false
   AllowParenthesesInCamelCaseMethod: false
+  AllowParenthesesInStringInterpolation: false
   EnforcedStyle: require_parentheses
   SupportedStyles:
     - require_parentheses
@@ -4491,6 +4528,13 @@ Style/StderrPuts:
   Enabled: true
   VersionAdded: '0.51'
 
+Style/StringChars:
+  Description: 'Checks for uses of `String#split` with empty string or regexp literal argument.'
+  StyleGuide: '#string-chars'
+  Enabled: pending
+  Safe: false
+  VersionAdded: '1.12'
+
 Style/StringConcatenation:
   Description: 'Checks for places where string concatenation can be replaced with string interpolation.'
   StyleGuide: '#string-interpolation'

data/cookstyle.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
   spec.summary       = 'Cookstyle is a code linting tool that helps you to write better Chef Infra cookbooks by detecting and automatically correcting style, syntax, and logic mistakes in your code.'
   spec.license       = 'Apache-2.0'
   spec.homepage      = 'https://docs.chef.io/workstation/cookstyle/'
-  spec.required_ruby_version = '>= 2.4'
+  spec.required_ruby_version = '>= 2.5'
 
   # the gemspec and Gemfile are necessary for appbundling of the gem
   spec.files = %w(LICENSE cookstyle.gemspec Gemfile) + Dir.glob('{lib,bin,config}/**/*')

data/lib/cookstyle.rb

@@ -7,7 +7,7 @@ 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'
+require_relative 'rubocop/monkey_patches/directive_comment'
 
 # monkey patches needed for the TargetChefVersion config option
 require_relative 'rubocop/monkey_patches/config'

data/lib/cookstyle/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 module Cookstyle
-  VERSION = "7.9.0" # rubocop: disable Style/StringLiterals
-  RUBOCOP_VERSION = '1.11.0'
+  VERSION = "7.12.2" # rubocop: disable Style/StringLiterals
+  RUBOCOP_VERSION = '1.14.0'
 end

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

@@ -19,7 +19,7 @@ module RuboCop
   module Cop
     module Chef
       module Correctness
-        # A resource guard (not_if/only_if) that is a string should not be wrapped in `{}`. Wrapping a guard string in {} causes it to be executed as Ruby code which will always returns true instead of a shell command that will actually run.
+        # A resource guard (not_if/only_if) that is a string should not be wrapped in `{}`. Wrapping a guard string in {} causes it to be executed as Ruby code which will always return true instead of a shell command that will actually run.
         #
         # @example
         #
@@ -40,7 +40,7 @@ module RuboCop
         class BlockGuardWithOnlyString < Base
           extend AutoCorrector
 
-          MSG = 'A resource guard (not_if/only_if) that is a string should not be wrapped in {}. Wrapping a guard string in {} causes it to be executed as Ruby code which will always returns true instead of a shell command that will actually run.'
+          MSG = 'A resource guard (not_if/only_if) that is a string should not be wrapped in {}. Wrapping a guard string in {} causes it to be executed as Ruby code which will always return true instead of a shell command that will actually run.'
 
           def_node_matcher :block_guard_with_only_string?, <<-PATTERN
             (block (send nil? ${:not_if :only_if}) (args) (str $_) )

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

@@ -15,21 +15,20 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-
 module RuboCop
   module Cop
     module Chef
-      # Default actions in resources should be symbols or an array of symbols.
-      #
-      # @example
-      #
-      #   #### incorrect
-      #   default_action 'create'
-      #
-      #   #### correct
-      #   default_action :create
-      #
       module Correctness
+        # Default actions in resources should be symbols or an array of symbols.
+        #
+        # @example
+        #
+        #   #### incorrect
+        #   default_action 'create'
+        #
+        #   #### correct
+        #   default_action :create
+        #
         class InvalidDefaultAction < Base
           MSG = 'Default actions in resources should be symbols or an array of symbols.'
           RESTRICT_ON_SEND = [:default_action].freeze

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

@@ -15,12 +15,11 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-
 module RuboCop
   module Cop
     module Chef
       module Correctness
-        # metadata.rb supports methods should contain valid platforms. See [Infra Language: Platform](https://docs.chef.io/infra_language/checking_platforms/#platform-values) for a list of many common platform values.
+        # metadata.rb `supports` methods should contain valid platforms. See [Infra Language: Platform](https://docs.chef.io/infra_language/checking_platforms/#platform-values) for a list of many common platform values.
         #
         # @example
         #

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

@@ -19,7 +19,7 @@ module RuboCop
   module Cop
     module Chef
       module Correctness
-        # Pass valid platforms families to the value_for_platform_family helper. See [Infra Language: Platform Family](https://docs.chef.io/infra_language/checking_platforms/#platform_family-values) for a complete list of platform families.
+        # Pass valid platform families to the value_for_platform_family helper. See [Infra Language: Platform Family](https://docs.chef.io/infra_language/checking_platforms/#platform_family-values) for a complete list of platform families.
         #
         # @example
         #

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

@@ -15,7 +15,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-
 module RuboCop
   module Cop
     module Chef

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

@@ -15,7 +15,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-
 module RuboCop
   module Cop
     module Chef

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

@@ -15,28 +15,27 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-
 module RuboCop
   module Cop
     module Chef
-      # metadata.rb needs to include the name method or it will fail on Chef Infra Client 12 and later.
-      #
-      # @example
-      #
-      #   #### correct
-      #   name 'foo'
-      #
       module Correctness
+        # metadata.rb needs to include the name method or it will fail on Chef Infra Client 12 and later.
+        #
+        # @example
+        #
+        #   #### correct
+        #   name 'foo'
+        #
         class MetadataMissingName < Base
           include RangeHelp
 
           MSG = 'metadata.rb needs to include the name method or it will fail on Chef Infra Client 12 and later.'
 
-          def_node_search :cb_name, '(send nil? :name str ...)'
+          def_node_search :cb_name?, '(send nil? :name str ...)'
 
           def on_new_investigation
             # Using range similar to RuboCop::Cop::Naming::Filename (file_name.rb)
-            return if cb_name(processed_source.ast).any?
+            return if cb_name?(processed_source.ast)
             range = source_range(processed_source.buffer, 1, 0)
             add_offense(range, message: MSG, severity: :refactor) do |_corrector|
               path = processed_source.path

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

@@ -18,13 +18,9 @@ module RuboCop
   module Cop
     module Chef
       module Correctness
-        # Normal attributes are discouraged since their semantics differ importantly from the
-        # default and override levels. Their values persist in the node object even after
-        # all code referencing them has been deleted, unlike default and override.
+        # Normal attributes are discouraged since their semantics differ importantly from the default and override levels. Their values persist in the node object even after all code referencing them has been deleted, unlike default and override.
         #
-        # Code should be updated to use default or override levels, but this will change
-        # attribute merging behavior so needs to be validated manually and force_default or
-        # force_override levels may need to be used in recipe code.
+        # Code should be updated to use default or override levels, but this will change attribute merging behavior so needs to be validated manually and force_default or force_override levels may need to be used in recipe code.
         #
         # @example
         #

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

@@ -18,13 +18,9 @@ module RuboCop
   module Cop
     module Chef
       module Correctness
-        # Normal attributes are discouraged since their semantics differ importantly from the
-        # default and override levels. Their values persist in the node object even after
-        # all code referencing them has been deleted, unlike default and override.
+        # Normal attributes are discouraged since their semantics differ importantly from the default and override levels. Their values persist in the node object even after all code referencing them has been deleted, unlike default and override.
         #
-        # Code should be updated to use default or override levels, but this will change
-        # attribute merging behavior so needs to be validated manually and force_default or
-        # force_override levels may need to be used in recipe code.
+        # Code should be updated to use default or override levels, but this will change attribute merging behavior so needs to be validated manually and force_default or force_override levels may need to be used in recipe code.
         #
         # @example
         #