cookstyle 8.5.2 → 8.6.4

data/cookstyle.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |spec|
   spec.name          = 'cookstyle'
   spec.version       = Cookstyle::VERSION
   spec.authors       = ['Thom May', 'Tim Smith']
-  spec.email         = ['thom@chef.io', 'tsmith84@gmail.com']
+  spec.email         = ['thom@chef.io', 'tsmith84@proton.me']
   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/'

data/lib/cookstyle/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 module Cookstyle
-  VERSION = "8.5.2" # rubocop: disable Style/StringLiterals
-  RUBOCOP_VERSION = '1.81.6'
+  VERSION = "8.6.4" # rubocop: disable Style/StringLiterals
+  RUBOCOP_VERSION = '1.84.2'
 end

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

@@ -23,14 +23,14 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   template '/etc/foo' do
         #     mode '0644'
         #     source 'foo.erb'
         #     only_if { 'test -f /etc/foo' }
         #   end
         #
-        #   ### correct
+        #   # good
         #   template '/etc/foo' do
         #     mode '0644'
         #     source 'foo.erb'

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

@@ -23,10 +23,10 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   Chef::Application.fatal!('Something horrible happened!')
         #
-        #   ### correct
+        #   # good
         #   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. 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.
+        # Don't use Ruby to shellout in an `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
         #
-        #   ### incorrect
+        #   # bad
         #   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
         #
-        #   ### correct
+        #   # good
         #   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
         #
-        #   ### incorrect
+        #   # bad
         #   dnf_package 'nginx' do
         #     version '1.2.3'
         #     allow_downgrades true
         #   end
         #
-        #   ### correct
+        #   # good
         #   dnf_package 'nginx' do
         #     version '1.2.3'
         #   end

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

@@ -31,7 +31,7 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   template '/etc/foo' do
         #     mode '0644'
         #     source 'foo.erb'
@@ -48,7 +48,7 @@ module RuboCop
         #     only_if { '' }  # Block form also problematic
         #   end
         #
-        #   ### correct
+        #   # good
         #   template '/etc/foo' do
         #     mode '0644'
         #     source 'foo.erb'

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

@@ -23,13 +23,13 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   ::Chef::Recipe.send(:include, Filebeat::Helpers)
         #   ::Chef::Provider.send(:include, Filebeat::Helpers)
         #   ::Chef::Recipe.include Filebeat::Helpers
         #   ::Chef::Provider.include Filebeat::Helpers
         #
-        #   ### correct
+        #   # good
         #   ::Chef::DSL::Recipe.send(:include, Filebeat::Helpers) # covers previous Recipe & Provider classes
         #
         class IncorrectLibraryInjection < Base

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

@@ -23,10 +23,10 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   name 'foo.bar'
         #
-        #   ### correct
+        #   # good
         #   name 'foo_bar'
         #
         class InvalidCookbookName < Base

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

@@ -23,10 +23,10 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   default_action 'create'
         #
-        #   ### correct
+        #   # good
         #   default_action :create
         #
         class InvalidDefaultAction < Base

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

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #
         #   template '/etc/www/configures-apache.conf' do
         #     notifies :restart, service['apache'], :immediately
@@ -33,7 +33,7 @@ module RuboCop
         #     notifies :restart, service[apache], :immediately
         #   end
         #
-        #   ### correct
+        #   # good
         #
         #   template '/etc/www/configures-apache.conf' do
         #     notifies :restart, 'service[apache]', :immediately

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

@@ -23,13 +23,13 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #
         #   template '/etc/www/configures-apache.conf' do
         #     notifies :restart, 'service[apache]', :nope
         #   end
         #
-        #   ### correct
+        #   # good
         #
         #   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
         #
-        #   ### incorrect
+        #   # bad
         #   platform_family?('redhat')
         #   platform_family?('sles')
         #
-        #   ### incorrect
+        #   # bad
         #   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
         #
-        #   ### incorrect
+        #   # bad
         #   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
         #
-        #   ### incorrect
+        #   # bad
         #   platform?('darwin')
         #   platform?('rhel')
         #   platform?('sles')
         #
-        #   ### correct
+        #   # good
         #   platform?('mac_os_x')
         #   platform?('redhat')
         #   platform?('suse')

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

@@ -23,11 +23,11 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   supports 'darwin'
         #   supports 'mswin'
         #
-        #   ### correct
+        #   # good
         #   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
         #
-        #   ### incorrect
+        #   # bad
         #   case node['platform']
         #   when 'rhel'
         #     puts "I'm on a Red Hat system!"
@@ -47,7 +47,7 @@ module RuboCop
                 when_node.each_condition do |con|
                   next unless con.str_type? # if the condition isn't a string we can't check so skip
                   new_value = INVALID_PLATFORMS[con.str_content]
-                  # some invalid platform have no direct correction value and return nil instead
+                  # some invalid platforms have no direct correction value and return nil instead
                   next unless new_value
 
                   add_offense(con, severity: :refactor) do |corrector|

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

@@ -23,13 +23,13 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   value_for_platform_family(
         #     %w(rhel sles) => 'foo',
         #     %w(mac) => 'foo'
         #   )
         #
-        #   ### correct
+        #   # good
         #   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
         #
-        #   ### incorrect
+        #   # bad
         #   value_for_platform(
         #     %w(rhel mac_os_x_server) => { 'default' => 'foo' },
         #     %w(sles) => { 'default' => 'bar' }
         #   )
-        #   ### correct
+        #   # good
         #   value_for_platform(
         #     %w(redhat mac_os_x) => { 'default' => 'foo' },
         #     %w(opensuseleap) => { 'default' => 'bar' }

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

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

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

@@ -23,10 +23,10 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   property :Something, String, default: node['hostname']
         #
-        #   ### correct
+        #   # good
         #   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
         #
-        #   ### incorrect
+        #   # bad
         #   template '/etc/foo' do
         #     mode '0644'
         #     source 'foo.erb'
         #     only_if { lazy { ::File.exist?('/etc/foo')} }
         #   end
         #
-        #   ### correct
+        #   # good
         #   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
         #
-        #   ### incorrect
+        #   # bad
         #   macos_userdefaults 'set a value' do
         #     global true
         #     key 'key'
         #     type 'boolean'
         #   end
         #
-        #   ### correct
+        #   # good
         #   macos_userdefaults 'set a value' do
         #     global true
         #     key 'key'

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

@@ -23,17 +23,17 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   value_for_platform(
         #     %w(redhat oracle) => 'baz'
         #   )
         #
-        #   ### correct
+        #   # good
         #   value_for_platform(
         #     %w(redhat oracle) => {
         #       '5' => 'foo',
         #       '6' => 'bar',
-        #       'default'd => 'baz',
+        #       'default' => 'baz',
         #     }
         #   )
         #

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

@@ -23,11 +23,11 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   depends 'some_awesome_cookbook' '= 4.5.5'
         #   depends 'some_other_cool_cookbook' '< 8.0'
         #
-        #   ### correct
+        #   # good
         #   depends 'some_awesome_cookbook', '= 4.5.5'
         #   depends 'some_other_cool_cookbook', '< 8.0'
         #

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

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   ### correct
+        #   # good
         #   name 'foo'
         #
         class MetadataMissingName < Base
@@ -35,7 +35,7 @@ module RuboCop
           def_node_search :cb_name?, '(send nil? :name str ...)'
 
           def on_new_investigation
-            # handle an empty metdata.rb file
+            # handle an empty metadata.rb file
             return if processed_source.ast.nil?
 
             # Using range similar to RuboCop::Cop::Naming::Filename (file_name.rb)

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

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   ### correct
+        #   # good
         #   name 'foo'
         #   version '1.0.0'
         #
@@ -36,7 +36,7 @@ module RuboCop
           def_node_search :cb_version?, '(send nil? :version str ...)'
 
           def on_new_investigation
-            # handle an empty metdata.rb file
+            # handle an empty metadata.rb file
             return if processed_source.ast.nil?
 
             # Using range similar to RuboCop::Cop::Naming::Filename (file_name.rb)

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

@@ -24,10 +24,10 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   node.normal['foo'] = true
         #
-        #   ### correct
+        #   # good
         #   node.default['foo'] = true
         #   node.override['foo'] = true
         #   node.force_default['foo'] = true

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

@@ -24,10 +24,10 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   node.normal_unless['foo'] = true
         #
-        #   ### correct
+        #   # good
         #   node.default_unless['foo'] = true
         #   node.override_unless['foo'] = true
         #   node.force_default_unless['foo'] = true

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

@@ -19,11 +19,11 @@ module RuboCop
   module Cop
     module Chef
       module Correctness
-        # Don't use node.save to save partial node data to the Chef Infra Server mid-run unless it's a requirement of cookbook design that can't be avoided. Node.save can result in failed Chef Infra runs appearing in search and increases load on the Chef Infra Server."
+        # Don't use node.save to save partial node data to the Chef Infra Server mid-run unless it's a requirement of cookbook design that can't be avoided. Node.save can result in failed Chef Infra runs appearing in search and increases load on the Chef Infra Server.
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   node.save
         #
         class CookbookUsesNodeSave < Base

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

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   execute 'some command' do
         #     notifies 'restart', 'service[httpd]', 'delayed'
         #   end
@@ -32,7 +32,7 @@ module RuboCop
         #     subscribes 'restart', 'service[httpd]', 'delayed'
         #   end
         #
-        #   ### correct
+        #   # good
         #   execute 'some command' do
         #     notifies :restart, 'service[httpd]', 'delayed'
         #   end

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

@@ -23,12 +23,12 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   file '/etc/some_file' do
         #     mode '0o755'
         #   end
         #
-        #   ### correct
+        #   # good
         #   file '/etc/some_file' do
         #     mode '0755'
         #   end

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

@@ -19,9 +19,9 @@ module RuboCop
   module Cop
     module Chef
       module Correctness
-        # The OpenSSL cookbook provides a deprecated `secure_password` helper in the `Opscode::OpenSSL::Password` class, which should no longer be used. This helper would generate a random password that would be used when a data bag or attribute was no present. The practice of generating passwords to be stored on the node is bad security as it exposes the password to anyone that can view the nodes, and deleting a node deletes the password. Passwords should be retrieved from a secure source for use in cookbooks.
+        # The OpenSSL cookbook provides a deprecated `secure_password` helper in the `Opscode::OpenSSL::Password` class, which should no longer be used. This helper would generate a random password that would be used when a data bag or attribute was not present. The practice of generating passwords to be stored on the node is bad security as it exposes the password to anyone that can view the nodes, and deleting a node deletes the password. Passwords should be retrieved from a secure source for use in cookbooks.
         #
-        #   ### incorrect
+        #   # bad
         #   ::Chef::Recipe.send(:include, Opscode::OpenSSL::Password)
         #   basic_auth_password = secure_password
         #

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

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   powershell_script 'Cleanup old files' do
         #     code 'Remove-Item C:\Windows\foo\bar.txt'
         #     only_if { ::File.exist?('C:\\Windows\\foo\\bar.txt') }

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

@@ -23,11 +23,11 @@ module RuboCop
         #
         # @example
         #
-        #  ### incorrect
-        #  powershell_out('Test-Path "C:\\Program Files\\LAPS\\CSE\\AdmPwd.dll"').stdout.strip == 'True'
+        #   # bad
+        #   powershell_out('Test-Path "C:\\Program Files\\LAPS\\CSE\\AdmPwd.dll"').stdout.strip == 'True'
         #
-        #  ### correct
-        #  ::File.exist?('C:\Program Files\LAPS\CSE\AdmPwd.dll')
+        #   # good
+        #   ::File.exist?('C:\Program Files\LAPS\CSE\AdmPwd.dll')
         #
         class PowershellFileExists < Base
           RESTRICT_ON_SEND = [:powershell_out, :powershell_out!].freeze

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

@@ -23,11 +23,11 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   property :size, regex: /^\d+[KMGTP]$/
         #   attribute :size, regex: /^\d+[KMGTP]$/
         #
-        #   ### correct
+        #   # good
         #   property :size, String, regex: /^\d+[KMGTP]$/
         #   attribute :size, kind_of: String, regex: /^\d+[KMGTP]$/
         #

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

@@ -23,13 +23,13 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   service 'foo' do
         #     running true
         #     action [:start, :enable]
         #   end
         #
-        #   ### correct
+        #   # good
         #   service 'foo' do
         #     action [:start, :enable]
         #   end

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

@@ -23,12 +23,12 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   service 'foo' do
         #    name 'bar'
         #   end
         #
-        #   ### correct
+        #   # good
         #   service 'foo' do
         #    service_name 'bar'
         #   end

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

@@ -23,12 +23,12 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   service 'foo' do
         #    action :none
         #   end
         #
-        #   ### correct
+        #   # good
         #   service 'foo' do
         #    action :nothing
         #   end

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

@@ -23,10 +23,10 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   not_if { File.exist?('/etc/foo/bar') }
         #
-        #   ### correct
+        #   # good
         #   not_if { ::File.exist?('/etc/foo/bar') }
         #
         class ScopedFileExist < Base

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

@@ -22,7 +22,7 @@ module RuboCop
         #
         # @example when command starts a service
         #
-        #   ### incorrect
+        #   # bad
         #   command "/etc/init.d/mysql start"
         #   command "/sbin/service/memcached start"
         #