cookstyle 7.8.0 → 7.11.1

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:
@@ -897,6 +905,8 @@ Style/TrivialAccessors:
   Enabled: false
 Style/UnlessElse:
   Enabled: false
+Style/UnlessLogicalOperators:
+  Enabled: false
 Style/UnpackFirst:
   Enabled: false
 Style/VariableInterpolation:

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/**/*'
@@ -3446,6 +3482,8 @@ Style/HashConversion:
   Description: 'Avoid Hash[] in favor of ary.to_h or literal hashes.'
   Enabled: pending
   VersionAdded: '1.10'
+  VersionChanged: '1.11'
+  AllowSplatArgument: true
 
 Style/HashEachMethods:
   Description: 'Use Hash#each_key and Hash#each_value.'
@@ -3670,6 +3708,7 @@ Style/MethodCallWithArgsParentheses:
   AllowParenthesesInMultilineCall: false
   AllowParenthesesInChaining: false
   AllowParenthesesInCamelCaseMethod: false
+  AllowParenthesesInStringInterpolation: false
   EnforcedStyle: require_parentheses
   SupportedStyles:
     - require_parentheses
@@ -4489,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'
@@ -4586,6 +4632,7 @@ Style/SymbolProc:
   Safe: false
   VersionAdded: '0.26'
   VersionChanged: '1.5'
+  AllowMethodsWithArguments: false
   # A list of method names to be ignored by the check.
   # The names should be fairly unique, otherwise you'll end up ignoring lots of code.
   IgnoredMethods:
@@ -4738,6 +4785,16 @@ Style/UnlessElse:
   Enabled: true
   VersionAdded: '0.9'
 
+Style/UnlessLogicalOperators:
+  Description: >-
+                 Checks for use of logical operators in an unless condition.
+  Enabled: false
+  VersionAdded: '1.11'
+  EnforcedStyle: forbid_mixed_logical_operators
+  SupportedStyles:
+    - forbid_mixed_logical_operators
+    - forbid_logical_operators
+
 Style/UnpackFirst:
   Description: >-
                  Checks for accessing the first element of `String#unpack`

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.8.0" # rubocop: disable Style/StringLiterals
-  RUBOCOP_VERSION = '1.10.0'
+  VERSION = "7.11.1" # 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 returns true instead of a shell command that will actually run.
         #
         # @example
         #

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

@@ -19,7 +19,7 @@ module RuboCop
   module Cop
     module Chef
       module Correctness
-        # Use raise to force Chef Infra Client to fail instead of using Chef::Application.fatal, which masks the full stack trace of the failure and makes debugging difficult.
+        # Use `raise` to force Chef Infra Client to fail instead of using `Chef::Application.fatal`, which masks the full stack trace of the failure and makes debugging difficult.
         #
         # @example
         #

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

@@ -19,7 +19,7 @@ module RuboCop
   module Cop
     module Chef
       module Correctness
-        # Don't use Ruby to shellout in a only_if / not_if conditional when you can just shellout directly. Any string value used with only_if / not_if is executed in your system's shell and the return code of the command is the result for the not_if / only_if determination.
+        # Don't use Ruby to shellout in a `only_if` / `not_if` conditional. Any string value used in an `only_if` / `not_if` is executed in your system's shell and the return code of the command is the result for the `not_if` / `only_if` determination.
         #
         # @example
         #

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

@@ -19,7 +19,7 @@ module RuboCop
   module Cop
     module Chef
       module Correctness
-        # dnf_package does not support the allow_downgrades property
+        # The `dnf_package` resource does not support the `allow_downgrades` property.
         #
         # @example
         #

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

@@ -19,7 +19,7 @@ module RuboCop
   module Cop
     module Chef
       module Correctness
-        # Libraries should be injected into the Chef::DSL::Recipe class and not Chef::Recipe or Chef::Provider classes directly.
+        # Libraries should be injected into the `Chef::DSL::Recipe` class and not `Chef::Recipe` or `Chef::Provider` classes directly.
         #
         # @example
         #

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

@@ -19,7 +19,7 @@ module RuboCop
   module Cop
     module Chef
       module Correctness
-        # Valid notification timings are :immediately, :immediate (alias for :immediately), :delayed, and :before.
+        # Valid notification timings are `:immediately`, `:immediate` (alias for :immediately), `:delayed`, and `:before`.
         #
         # @example
         #

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

@@ -19,7 +19,7 @@ module RuboCop
   module Cop
     module Chef
       module Correctness
-        # Pass valid platform families to the platform_family? helper.
+        # Pass valid platform families to the `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_platform_family_values_in_case.rb

@@ -19,7 +19,7 @@ module RuboCop
   module Cop
     module Chef
       module Correctness
-        # Use valid platform family values in case statements.
+        # Use valid platform family values in case statements. 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_platform_helper.rb

@@ -19,7 +19,7 @@ module RuboCop
   module Cop
     module Chef
       module Correctness
-        # Pass valid platforms to the platform? helper.
+        # Pass valid platforms to the `platform?` helper. See [Infra Language: Platform](https://docs.chef.io/infra_language/checking_platforms/#platform-values) for a list of many common platform values.
         #
         # @example
         #
@@ -32,6 +32,7 @@ module RuboCop
         #   platform?('mac_os_x')
         #   platform?('redhat)
         #   platform?('suse')
+        #
         class InvalidPlatformHelper < Base
           include ::RuboCop::Chef::PlatformHelpers
 

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

@@ -20,7 +20,7 @@ module RuboCop
   module Cop
     module Chef
       module Correctness
-        # metadata.rb supports methods should contain valid platforms.
+        # 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_platform_values_in_case.rb

@@ -19,7 +19,7 @@ module RuboCop
   module Cop
     module Chef
       module Correctness
-        # Use valid platform values in case statements.
+        # Use valid platform values in case statements. 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.
+        # 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.
         #
         # @example
         #

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

@@ -19,7 +19,7 @@ module RuboCop
   module Cop
     module Chef
       module Correctness
-        # Pass valid platforms to the value_for_platform helper.
+        # Pass valid platforms to the value_for_platform helper. 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/style/unnecessary_os_check.rb

@@ -19,7 +19,7 @@ module RuboCop
   module Cop
     module Chef
       module Style
-        # Use the platform_family?() helpers instead of node['os] == 'foo' for platform_families that match one-to-one with OS values. These helpers are easier to read and can accept multiple platform arguments, which greatly simplifies complex platform logic. All values of `os` from Ohai match one-to-one with `platform_family` values except for `linux`, which has no single equivalent `plaform_family`.
+        # Use the platform_family?() helpers instead of node['os] == 'foo' for platform_families that match one-to-one with OS values. These helpers are easier to read and can accept multiple platform arguments, which greatly simplifies complex platform logic. All values of `os` from Ohai match one-to-one with `platform_family` values except for `linux`, which has no single equivalent `platform_family`.
         #
         # @example
         #

data/lib/rubocop/monkey_patches/{comment_config.rb → directive_comment.rb}

@@ -2,10 +2,11 @@
 module RuboCop
   # we're monkey patching the config regex to allow for # cookstyle: disable whatever
   # in addition to the # rubocop: disable whatever that comes with RuboCop
-  class CommentConfig
-    remove_const('COMMENT_DIRECTIVE_REGEXP')
-    COMMENT_DIRECTIVE_REGEXP = Regexp.new(
-      "# (?:rubocop|cookstyle): ((?:disable|enable|todo))\\b #{COPS_PATTERN}".gsub(' ', '\s*')
+  class DirectiveComment
+    remove_const('DIRECTIVE_COMMENT_REGEXP')
+    DIRECTIVE_COMMENT_REGEXP = Regexp.new(
+      "# (?:rubocop|cookstyle) : ((?:disable|enable|todo))\\b #{COPS_PATTERN}"
+        .gsub(' ', '\s*')
     )
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cookstyle
 version: !ruby/object:Gem::Version
-  version: 7.8.0
+  version: 7.11.1
 platform: ruby
 authors:
 - Thom May
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-15 00:00:00.000000000 Z
+date: 2021-05-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -17,14 +17,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.10.0
+        version: 1.14.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.10.0
+        version: 1.14.0
 description: 
 email:
 - thom@chef.io
@@ -275,8 +275,8 @@ files:
 - lib/rubocop/cop/chef/style/use_platform_helpers.rb
 - lib/rubocop/cop/target_chef_version.rb
 - lib/rubocop/monkey_patches/base.rb
-- lib/rubocop/monkey_patches/comment_config.rb
 - lib/rubocop/monkey_patches/config.rb
+- lib/rubocop/monkey_patches/directive_comment.rb
 - lib/rubocop/monkey_patches/registry_cop.rb
 - lib/rubocop/monkey_patches/team.rb
 homepage: https://docs.chef.io/workstation/cookstyle/
@@ -296,7 +296,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="