cookstyle 7.7.2 → 7.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c26a8975b37722a6d4b7be270e87fc5e9a7ac499755b2401e8d3ec5dd8627c82
-  data.tar.gz: ed69abecf1251fd184ed42b16dcbc0f55bfb06201a98abfd05b6fd69f1812c26
+  metadata.gz: 3076c867c2f21ea4d24687809d309ae3559abcc22a3fc9a8f4f1d25b6936f768
+  data.tar.gz: b24e19979606dc4cb211090a82dcce5b92ea4ac28e02da31859632cad42039c4
 SHA512:
-  metadata.gz: 332eb06789dc7db421b6d38a8234557225e680725ce949a4d8727f1a613c1cd1bdbdd0cfba2ed09b7e60a7091c1296e505cbacef1b0d40f2acd29af1394a611b
-  data.tar.gz: 670702283e8aa31d186156ad809e60d262293b600381a5219c829ca3957a554002888883b74406a6b3f0091fc591265e1780a903fdc7cd353d3115f996c30620
+  metadata.gz: 97fb99952bafccf12e8b04c26411264f0e8fc8a7fce228398db06acb078785c5d4e43dcf6fe07dc392afe038005566ff97492803b5500cb1898093c977e6a79c
+  data.tar.gz: 14b910b44b291117450b2cf9eb8b5d7c6722d8f5e88aef71ca9da8bf89f5aa4ab13bb731bf6ce850fd471ff0cf6586e29c1e6658329c98f86030234d124964a4

data/config/cookstyle.yml

@@ -220,7 +220,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 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 returns true instead of a shell command that will actually run.
   StyleGuide: '#chefcorrectnessblockguardwithonlystring'
   Enabled: true
   VersionAdded: '5.2.0'
@@ -1568,7 +1568,7 @@ Chef/Modernize/FoodcriticComments:
     - '**/Berksfile'
 
 Chef/Modernize/ExecuteScExe:
-  Description: Chef Infra Client 14.0 and later includes :create, :delete, and :configure actions with the full idempotency of the windows_service resource. See the windows_service documentation at https://docs.chef.io/resource_windows_service.html for additional details on creating services with the windows_service resource
+  Description: Chef Infra Client 14.0 and later includes :create, :delete, and :configure actions with the full idempotency of the windows_service resource. See the windows_service documentation at https://docs.chef.io/resources/windows_service for additional details on creating services with the windows_service resource
   StyleGuide: '#chefmodernizeexecutescexe'
   Enabled: true
   VersionAdded: '5.16.0'
@@ -1578,7 +1578,7 @@ Chef/Modernize/ExecuteScExe:
     - '**/Berksfile'
 
 Chef/Modernize/WindowsScResource:
-  Description: Chef Infra Client 14.0 and later includes :create, :delete, and :configure actions without the need for the sc cookbook dependency. See the windows_service documentation at https://docs.chef.io/resource_windows_service.html for additional details.
+  Description: Chef Infra Client 14.0 and later includes :create, :delete, and :configure actions without the need for the sc cookbook dependency. See the windows_service documentation at https://docs.chef.io/resources/windows_service for additional details.
   StyleGuide: '#chefmodernizewindowsscresource'
   Enabled: true
   VersionAdded: '5.16.0'
@@ -2807,3 +2807,7 @@ Style/CollectionCompact:
 # eventually these constants are going to break code so fix them
 Lint/DeprecatedConstants:
   Enabled: true
+
+# always turn on deprecation cops from rubocop
+Lint/ErbNewArguments:
+  Enabled: true

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:

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.'
@@ -3087,6 +3102,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.
 #
@@ -3425,6 +3442,11 @@ Style/HashAsLastArrayItem:
     - braces
     - no_braces
 
+Style/HashConversion:
+  Description: 'Avoid Hash[] in favor of ary.to_h or literal hashes.'
+  Enabled: pending
+  VersionAdded: '1.10'
+
 Style/HashEachMethods:
   Description: 'Use Hash#each_key and Hash#each_value.'
   StyleGuide: '#hash-each'

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.8.0" # rubocop: disable Style/StringLiterals
+  RUBOCOP_VERSION = '1.10.0'
 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

@@ -23,10 +23,10 @@ module RuboCop
         #
         # @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

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @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

@@ -23,13 +23,13 @@ module RuboCop
         #
         # @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

@@ -23,13 +23,13 @@ module RuboCop
         #
         # @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

@@ -23,13 +23,13 @@ module RuboCop
         #
         # @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

@@ -23,11 +23,11 @@ module RuboCop
         #
         # @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

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @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

@@ -23,12 +23,12 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   platform?('darwin')
         #   platform?('rhel)
         #   platform?('sles')
         #
-        #   # good
+        #   #### correct
         #   platform?('mac_os_x')
         #   platform?('redhat)
         #   platform?('suse')

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

@@ -24,11 +24,11 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   supports 'darwin'
         #   supports 'mswin'
         #
-        #   # good
+        #   #### correct
         #   supports 'mac_os_x'
         #   supports 'windows'
         #

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

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   case node['platform']
         #   when 'rhel'
         #     puts "I'm on a Red Hat system!"

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

@@ -23,13 +23,13 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   value_for_platform_family(
         #     %w(rhel sles) => 'foo',
         #     %w(mac) => 'foo'
         #   )
         #
-        #   # good
+        #   #### correct
         #   value_for_platform_family(
         #     %w(rhel suse) => 'foo',
         #     %w(mac_os_x) => 'foo'

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

@@ -23,12 +23,12 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   value_for_platform(
         #     %w(rhel mac_os_x_server) => { 'default' => 'foo' },
         #     %w(sles) => { 'default' => 'bar' }
         #   )
-        #   # good
+        #   #### correct
         #   value_for_platform(
         #     %w(redhat mac_os_x) => { 'default' => 'foo' },
         #     %w(opensuseleap) => { 'default' => 'bar' }

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

@@ -24,10 +24,10 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   version '1.2.3.4'
         #
-        #   # good
+        #   #### correct
         #   version '1.2.3'
         #
         class InvalidVersionMetadata < Base

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

@@ -24,10 +24,10 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   property :Something, String, default: node['hostname']
         #
-        #   # good
+        #   #### correct
         #   property :Something, String, default: lazy { node['hostname'] }
         #
         class LazyEvalNodeAttributeDefaults < Base

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

@@ -23,14 +23,14 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   template '/etc/foo' do
         #     mode '0644'
         #     source 'foo.erb'
         #     only_if { lazy { ::File.exist?('/etc/foo')} }
         #   end
         #
-        #   # good
+        #   #### correct
         #   template '/etc/foo' do
         #     mode '0644'
         #     source 'foo.erb'

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

@@ -23,14 +23,14 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   macos_userdefaults 'set a value' do
         #     global true
         #     key 'key'
         #     type 'boolean'
         #   end
         #
-        #   # good
+        #   #### correct
         #   macos_userdefaults 'set a value' do
         #     global true
         #     key 'key'