cookstyle 7.7.2 → 7.10.1

data/config/disable_all.yml

@@ -9,6 +9,8 @@ Bundler/InsecureProtocolSource:
   Enabled: false
 Bundler/OrderedGems:
   Enabled: false
+Gemspec/DateAssignment:
+  Enabled: false
 Gemspec/DuplicatedAssignment:
   Enabled: false
 Gemspec/OrderedDependencies:
@@ -631,6 +633,8 @@ Style/GuardClause:
   Enabled: false
 Style/HashAsLastArrayItem:
   Enabled: false
+Style/HashConversion:
+  Enabled: false
 Style/HashEachMethods:
   Enabled: false
 Style/HashExcept:
@@ -847,6 +851,8 @@ Style/StabbyLambdaParentheses:
   Enabled: false
 Style/StderrPuts:
   Enabled: false
+Style/StringChars:
+  Enabled: false
 Style/StringConcatenation:
   Enabled: false
 Style/StringHashKeys:
@@ -893,6 +899,8 @@ Style/TrivialAccessors:
   Enabled: false
 Style/UnlessElse:
   Enabled: false
+Style/UnlessLogicalOperators:
+  Enabled: false
 Style/UnpackFirst:
   Enabled: false
 Style/VariableInterpolation:

data/config/upstream.yml

@@ -203,6 +203,13 @@ Bundler/OrderedGems:
 
 #################### Gemspec ###############################
 
+Gemspec/DateAssignment:
+  Description: 'Checks that `date =` is not used in gemspec file, it is set automatically when the gem is packaged.'
+  Enabled: pending
+  VersionAdded: '1.10'
+  Include:
+    - '**/*.gemspec'
+
 Gemspec/DuplicatedAssignment:
   Description: 'An attribute assignment method calls should be listed only once in a gemspec.'
   Enabled: true
@@ -1446,23 +1453,31 @@ Lint/Debugger:
   Description: 'Check for debugger calls.'
   Enabled: true
   VersionAdded: '0.14'
-  VersionChanged: '0.49'
-  DebuggerReceivers:
-    - binding
-    - Kernel
-    - Pry
+  VersionChanged: '1.10'
+  DebuggerReceivers: [] # deprecated
   DebuggerMethods:
-    - debugger
-    - byebug
-    - remote_byebug
-    - pry
-    - remote_pry
-    - pry_remote
-    - console
-    - rescue
-    - save_and_open_page
-    - save_and_open_screenshot
-    - irb
+    # Groups are available so that a specific group can be disabled in
+    # a user's configuration, but are otherwise not significant.
+    Kernel:
+      - binding.irb
+    Byebug:
+      - byebug
+      - remote_byebug
+      - Kernel.byebug
+      - Kernel.remote_byebug
+    Capybara:
+      - save_and_open_page
+      - save_and_open_screenshot
+    Pry:
+      - binding.pry
+      - binding.remote_pry
+      - binding.pry_remote
+      - Pry.rescue
+    Rails:
+      - debugger
+      - Kernel.debugger
+    WebConsole:
+      - binding.console
 
 Lint/DeprecatedClassMethods:
   Description: 'Check for deprecated class method calls.'
@@ -2040,13 +2055,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.'
@@ -2474,6 +2494,7 @@ Naming/MemoizedInstanceVariableName:
     - disallowed
     - required
     - optional
+  Safe: false
 
 Naming/MethodName:
   Description: 'Use the configured style when naming methods.'
@@ -3087,6 +3108,8 @@ Style/ConstantVisibility:
                  visibility declarations.
   Enabled: false
   VersionAdded: '0.66'
+  VersionChanged: '1.10'
+  IgnoreModules: false
 
 # Checks that you have put a copyright in a comment before any code.
 #
@@ -3157,6 +3180,7 @@ Style/Documentation:
   Description: 'Document classes and non-namespace modules.'
   Enabled: true
   VersionAdded: '0.9'
+  AllowedConstants: []
   Exclude:
     - 'spec/**/*'
     - 'test/**/*'
@@ -3425,6 +3449,13 @@ Style/HashAsLastArrayItem:
     - braces
     - no_braces
 
+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.'
   StyleGuide: '#hash-each'
@@ -3648,6 +3679,7 @@ Style/MethodCallWithArgsParentheses:
   AllowParenthesesInMultilineCall: false
   AllowParenthesesInChaining: false
   AllowParenthesesInCamelCaseMethod: false
+  AllowParenthesesInStringInterpolation: false
   EnforcedStyle: require_parentheses
   SupportedStyles:
     - require_parentheses
@@ -4467,6 +4499,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'
@@ -4564,6 +4603,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:
@@ -4716,6 +4756,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/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.7.2" # rubocop: disable Style/StringLiterals
-  RUBOCOP_VERSION = '1.9.1'
+  VERSION = "7.10.1" # rubocop: disable Style/StringLiterals
+  RUBOCOP_VERSION = '1.12.1'
 end

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

@@ -19,18 +19,18 @@ 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 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
         #
-        #   # bad
+        #   #### incorrect
         #   template '/etc/foo' do
         #     mode '0644'
         #     source 'foo.erb'
         #     only_if { 'test -f /etc/foo' }
         #   end
         #
-        #   # good
+        #   #### correct
         #   template '/etc/foo' do
         #     mode '0644'
         #     source 'foo.erb'
@@ -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 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 returns 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/chef_application_fatal.rb

@@ -19,14 +19,14 @@ 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
         #
-        #   # bad
+        #   #### incorrect
         #   Chef::Application.fatal!('Something horrible happened!')
         #
-        #   # good
+        #   #### correct
         #   raise "Something horrible happened!"
         #
         class ChefApplicationFatal < Base

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

@@ -19,11 +19,11 @@ 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
         #
-        #   # bad
+        #   #### incorrect
         #   cookbook_file '/logs/foo/error.log' do
         #     source 'error.log'
         #     only_if { system('wget https://www.bar.com/foobar.txt -O /dev/null') }
@@ -34,7 +34,7 @@ module RuboCop
         #     only_if { shell_out('wget https://www.bar.com/foobar.txt -O /dev/null').exitstatus == 0 }
         #   end
         #
-        #   # good
+        #   #### correct
         #   cookbook_file '/logs/foo/error.log' do
         #     source 'error.log'
         #     only_if 'wget https://www.bar.com/foobar.txt -O /dev/null'

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

@@ -19,17 +19,17 @@ 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
         #
-        #   # bad
+        #   #### incorrect
         #   dnf_package 'nginx' do
         #     version '1.2.3'
         #     allow_downgrades true
         #   end
         #
-        #   # good
+        #   #### correct
         #   dnf_package 'nginx' do
         #     version '1.2.3'
         #   end

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

@@ -19,17 +19,17 @@ 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
         #
-        #   # bad
+        #   #### incorrect
         #   ::Chef::Recipe.send(:include, Filebeat::Helpers)
         #   ::Chef::Provider.send(:include, Filebeat::Helpers)
         #   ::Chef::Recipe.include Filebeat::Helpers
         #   ::Chef::Provider.include Filebeat::Helpers
         #
-        #   # good
+        #   #### correct
         #   ::Chef::DSL::Recipe.send(:include, Filebeat::Helpers) # covers previous Recipe & Provider classes
         #
         class IncorrectLibraryInjection < Base

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

@@ -23,10 +23,10 @@ module RuboCop
       #
       # @example
       #
-      #   # bad
+      #   #### incorrect
       #   default_action 'create'
       #
-      #   # good
+      #   #### correct
       #   default_action :create
       #
       module Correctness

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

@@ -19,17 +19,17 @@ 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
         #
-        #   # bad
+        #   #### incorrect
         #
         #   template '/etc/www/configures-apache.conf' do
         #     notifies :restart, 'service[apache]', :nope
         #   end
         #
-        #   # good
+        #   #### correct
         #
         #   template '/etc/www/configures-apache.conf' do
         #     notifies :restart, 'service[apache]', :immediately

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

@@ -19,15 +19,15 @@ 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
         #
-        #   # bad
+        #   #### incorrect
         #   platform_family?('redhat')
         #   platform_family?('sles')
         #
-        #   # bad
+        #   #### incorrect
         #   platform_family?('rhel')
         #   platform_family?('suse')
         #

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

@@ -19,11 +19,11 @@ 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
         #
-        #   # bad
+        #   #### incorrect
         #   case node['platform_family']
         #   when 'redhat'
         #     puts "I'm on a RHEL-like system"

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

@@ -19,19 +19,20 @@ 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
         #
-        #   # bad
+        #   #### incorrect
         #   platform?('darwin')
         #   platform?('rhel)
         #   platform?('sles')
         #
-        #   # good
+        #   #### correct
         #   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,15 +20,15 @@ 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
         #
-        #   # bad
+        #   #### incorrect
         #   supports 'darwin'
         #   supports 'mswin'
         #
-        #   # good
+        #   #### correct
         #   supports 'mac_os_x'
         #   supports 'windows'
         #