cookstyle 8.5.2 → 8.6.4

data/lib/rubocop/cop/chef/modernize/libarchive_file.rb

@@ -23,14 +23,14 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   depends 'libarchive'
         #
         #   libarchive_file "C:\file.zip" do
         #     path 'C:\expand_here'
         #   end
         #
-        #   ### correct
+        #   # good
         #   archive_file "C:\file.zip" do
         #     path 'C:\expand_here'
         #   end
@@ -41,7 +41,7 @@ module RuboCop
 
           minimum_target_chef_version '15.0'
 
-          MSG = 'Use the archive_file resource built into Chef Infra Client 15+ instead of the libarchive file resource from the libarchive cookbook'
+          MSG = 'Use the archive_file resource built into Chef Infra Client 15+ instead of the libarchive_file resource from the libarchive cookbook'
           RESTRICT_ON_SEND = [:libarchive_file, :notifies, :subscribes].freeze
 
           def_node_matcher :notification_property?, <<-PATTERN

data/lib/rubocop/cop/chef/modernize/macos_user_defaults.rb

@@ -23,14 +23,14 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   mac_os_x_userdefaults 'full keyboard access to all controls' do
         #     domain 'AppleKeyboardUIMode'
         #     global true
         #     value '2'
         #   end
         #
-        #   ### correct
+        #   # good
         #   macos_userdefaults 'full keyboard access to all controls' do
         #     domain 'AppleKeyboardUIMode'
         #     global true

data/lib/rubocop/cop/chef/modernize/minitest_handler_usage.rb

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   depends 'minitest-handler'
         #
         class MinitestHandlerUsage < Base

data/lib/rubocop/cop/chef/modernize/node_init_package.rb

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   ::File.open('/proc/1/comm').gets.chomp == 'systemd'
         #   ::File.open('/proc/1/comm').chomp == 'systemd'
         #   File.open('/proc/1/comm').gets.chomp == 'systemd'
@@ -35,7 +35,7 @@ module RuboCop
         #   File.exist?('/proc/1/comm') && File.open('/proc/1/comm').chomp == 'systemd'
         #   only_if 'test -f /bin/systemctl && /bin/systemctl'
         #
-        #   ### correct
+        #   # good
         #   node['init_package'] == 'systemd'
         #   only_if { node['init_package'] == 'systemd' }
         #

data/lib/rubocop/cop/chef/modernize/node_roles_include.rb

@@ -23,10 +23,10 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   node['roles'].include?('foo')
         #
-        #   ### correct
+        #   # good
         #   node.role?('foo')
         #
         class NodeRolesInclude < Base

data/lib/rubocop/cop/chef/modernize/ohai_default_recipe.rb

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   include_recipe 'ohai::default'
         #   include_recipe 'ohai'
         #

data/lib/rubocop/cop/chef/modernize/openssl_rsa_key_resource.rb

@@ -23,12 +23,12 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   openssl_rsa_key '/etc/httpd/ssl/server.key' do
         #     key_length 2048
         #   end
         #
-        #   ### correct
+        #   # good
         #   openssl_rsa_private_key '/etc/httpd/ssl/server.key' do
         #     key_length 2048
         #   end

data/lib/rubocop/cop/chef/modernize/openssl_x509_resource.rb

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   openssl_x509 '/etc/httpd/ssl/mycert.pem' do
         #     common_name 'www.f00bar.com'
         #     org 'Foo Bar'
@@ -31,7 +31,7 @@ module RuboCop
         #     country 'US'
         #   end
         #
-        #   ### correct
+        #   # good
         #   openssl_x509_certificate '/etc/httpd/ssl/mycert.pem' do
         #     common_name 'www.f00bar.com'
         #     org 'Foo Bar'

data/lib/rubocop/cop/chef/modernize/osx_config_profile_resource.rb

@@ -23,12 +23,12 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   osx_config_profile 'Install screensaver profile' do
         #     profile 'screensaver/com.company.screensaver.mobileconfig'
         #   end
         #
-        #   ### correct
+        #   # good
         #   osx_profile 'Install screensaver profile' do
         #     profile 'screensaver/com.company.screensaver.mobileconfig'
         #   end

data/lib/rubocop/cop/chef/modernize/powershell_expand_archive.rb

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   powershell_script 'Expand website' do
         #     code 'Expand-Archive "C:\\file.zip" -DestinationPath "C:\\inetpub\\wwwroot\\" -Force'
         #   end

data/lib/rubocop/cop/chef/modernize/powershell_guard_interpreter.rb

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   powershell_script 'Create Directory' do
         #     code "New-Item -ItemType Directory -Force -Path C:\mydir"
         #     guard_interpreter :powershell_script
@@ -34,7 +34,7 @@ module RuboCop
         #     guard_interpreter :powershell_script
         #   end
         #
-        #   ### correct
+        #   # good
         #   powershell_script 'Create Directory' do
         #     code "New-Item -ItemType Directory -Force -Path C:\mydir"
         #   end

data/lib/rubocop/cop/chef/modernize/powershell_install_package.rb

@@ -23,13 +23,13 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   powershell_script 'Expand website' do
         #     code 'Install-Package -Name docker'
         #   end
         #
-        #  ### correct
-        #  powershell_package 'docker'
+        #   # good
+        #   powershell_package 'docker'
         #
         class PowershellInstallPackage < Base
           include RuboCop::Chef::CookbookHelpers

data/lib/rubocop/cop/chef/modernize/powershell_install_windowsfeature.rb

@@ -23,16 +23,16 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   powershell_script 'Install Feature' do
         #     code 'Install-WindowsFeature -Name "Net-framework-Core"'
         #   end
         #
-        #  ### correct
-        #  windows_feature 'Net-framework-Core' do
-        #    action :install
-        #    install_method :windows_feature_powershell
-        #  end
+        #   # good
+        #   windows_feature 'Net-framework-Core' do
+        #     action :install
+        #     install_method :windows_feature_powershell
+        #   end
         #
         class PowershellInstallWindowsFeature < Base
           include RuboCop::Chef::CookbookHelpers

data/lib/rubocop/cop/chef/modernize/property_with_name_attribute.rb

@@ -23,10 +23,10 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   property :bob, String, name_attribute: true
         #
-        #   ### correct
+        #   # good
         #   property :bob, String, name_property: true
         #
         class PropertyWithNameAttribute < Base

data/lib/rubocop/cop/chef/modernize/provides_initializer.rb

@@ -19,24 +19,24 @@ module RuboCop
   module Cop
     module Chef
       module Modernize
-        # Provides should be set using the `provides` resource DSL method instead of instead of setting @provides in the initialize method.
+        # Provides should be set using the `provides` resource DSL method instead of setting @provides in the initialize method.
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   def initialize(*args)
         #     super
         #     @provides = :foo
         #   end
         #
-        #   ### correct
+        #   # good
         #   provides :foo
         #
         class ProvidesFromInitialize < Base
           include RangeHelp
           extend AutoCorrector
 
-          MSG = 'Provides should be set using the `provides` resource DSL method instead of instead of setting @provides in the initialize method.'
+          MSG = 'Provides should be set using the `provides` resource DSL method instead of setting @provides in the initialize method.'
 
           def_node_matcher :provides_assignment?, <<-PATTERN
             (ivasgn :@provides $(sym ...))

data/lib/rubocop/cop/chef/modernize/resource_name_initializer.rb

@@ -23,14 +23,14 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   def initialize(*args)
         #     super
         #     @resource_name = :foo
         #   end
         #
-        #  ### correct
-        #  resource_name :create
+        #   # good
+        #   resource_name :foo
 
         class ResourceNameFromInitialize < Base
           extend AutoCorrector

data/lib/rubocop/cop/chef/modernize/resource_set_or_return.rb

@@ -19,11 +19,11 @@ module RuboCop
   module Cop
     module Chef
       module Modernize
-        # set_or_return within a method should not be used to define property in a resource. Instead use the property method which properly validates and defines properties in a way that works with reporting and documentation functionality in Chef Infra Client
+        # set_or_return within a method should not be used to define a property in a resource. Instead use the property method which properly validates and defines properties in a way that works with reporting and documentation functionality in Chef Infra Client
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #    def severity(arg = nil)
         #      set_or_return(
         #        :severity, arg,
@@ -32,7 +32,7 @@ module RuboCop
         #      )
         #    end
         #
-        #   ### correct
+        #   # good
         #   property :severity, String
         #
         class SetOrReturnInResources < Base

data/lib/rubocop/cop/chef/modernize/resource_with_attributes.rb

@@ -23,14 +23,14 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   attribute :something, String
         #
         #   action :create do
         #     # some action code because we're in a custom resource
         #   end
         #
-        #   ### correct
+        #   # good
         #   property :something, String
         #
         #   action :create do

data/lib/rubocop/cop/chef/modernize/respond_to_compile_time.rb

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   chef_gem 'ultradns-sdk' do
         #     compile_time true if Chef::Resource::ChefGem.method_defined?(:compile_time)
         #     action :nothing
@@ -39,7 +39,7 @@ module RuboCop
         #     action :nothing
         #   end
         #
-        #   ### correct
+        #   # good
         #   chef_gem 'ultradns-sdk' do
         #     compile_time true
         #     action :nothing

data/lib/rubocop/cop/chef/modernize/respond_to_metadata.rb

@@ -19,11 +19,11 @@ module RuboCop
   module Cop
     module Chef
       module Modernize
-        # It is not longer necessary respond_to?(:foo) or defined?(foo) in metadata. This was used to support new metadata methods in Chef 11 and early versions of Chef 12.
+        # It is no longer necessary to use respond_to?(:foo) or defined?(foo) in metadata. This was used to support new metadata methods in Chef 11 and early versions of Chef 12.
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   chef_version '>= 13' if respond_to?(:chef_version)
         #   chef_version '>= 13' if defined?(chef_version)
         #   chef_version '>= 13' unless defined?(Ridley::Chef::Cookbook::Metadata)
@@ -31,7 +31,7 @@ module RuboCop
         #     chef_version '>= 13'
         #   end
         #
-        #   ### correct
+        #   # good
         #   chef_version '>= 13'
         #
         class RespondToInMetadata < Base

data/lib/rubocop/cop/chef/modernize/respond_to_provides.rb

@@ -19,16 +19,16 @@ module RuboCop
   module Cop
     module Chef
       module Modernize
-        # In Chef Infra Client 12+ is is no longer necessary to gate the use of the provides methods in resources with `if respond_to?(:provides)` or `if defined? provides`.
+        # In Chef Infra Client 12+ it is no longer necessary to gate the use of the provides methods in resources with `if respond_to?(:provides)` or `if defined? provides`.
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   provides :foo if respond_to?(:provides)
         #
         #   provides :foo if defined? provides
         #
-        #   ### correct
+        #   # good
         #   provides :foo
         #
         class RespondToProvides < Base

data/lib/rubocop/cop/chef/modernize/respond_to_resource_name.rb

@@ -23,10 +23,10 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   resource_name :foo if respond_to?(:resource_name)
         #
-        #   ### correct
+        #   # good
         #   resource_name :foo
         #
         class RespondToResourceName < Base

data/lib/rubocop/cop/chef/modernize/sc_windows_resource.rb

@@ -23,13 +23,13 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   sc_windows 'chef-client' do
         #     path "C:\\opscode\\chef\\bin"
         #     action :create
         #   end
         #
-        #   ### correct
+        #   # good
         #   windows_service 'chef-client' do
         #     action :create
         #     binary_path_name "C:\\opscode\\chef\\bin"

data/lib/rubocop/cop/chef/modernize/seven_zip_archive.rb

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   seven_zip_archive "C:\file.zip" do
         #     path 'C:\expand_here'
         #   end

data/lib/rubocop/cop/chef/modernize/shell_out_helper.rb

@@ -23,10 +23,10 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   Mixlib::ShellOut.new('foo').run_command
         #
-        #   ### correct
+        #   # good
         #   shell_out('foo')
         #
         class ShellOutHelper < Base

data/lib/rubocop/cop/chef/modernize/shellouts_to_chocolatey.rb

@@ -23,13 +23,13 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   execute 'install package foo' do
         #     command "choco install --source=artifactory \"foo\" -y --no-progress --ignore-package-exit-codes"
         #   end
         #
         #  powershell_script 'add artifactory choco source' do
-        #    code "choco source add -n=artifactory -s='https://mycorp.jfrog.io/mycorp/api/nuget/chocolatey-remote' -u foo -p bar"x
+        #    code "choco source add -n=artifactory -s='https://mycorp.jfrog.io/mycorp/api/nuget/chocolatey-remote' -u foo -p bar"
         #    not_if 'choco source list | findstr artifactory'
         #  end
         #

data/lib/rubocop/cop/chef/modernize/simplify_apt_ppa_setup.rb

@@ -23,21 +23,21 @@ module RuboCop
         #
         # @example
         #
-        #  ### incorrect
-        #    apt_repository 'atom-ppa' do
-        #      uri 'http://ppa.launchpad.net/webupd8team/atom/ubuntu'
-        #      components ['main']
-        #      keyserver 'keyserver.ubuntu.com'
-        #      key 'C2518248EEA14886'
-        #    end
+        #   # bad
+        #   apt_repository 'atom-ppa' do
+        #     uri 'http://ppa.launchpad.net/webupd8team/atom/ubuntu'
+        #     components ['main']
+        #     keyserver 'keyserver.ubuntu.com'
+        #     key 'C2518248EEA14886'
+        #   end
         #
-        #  ### correct
-        #    apt_repository 'atom-ppa' do
-        #      uri 'ppa:webupd8team/atom'
-        #      components ['main']
-        #      keyserver 'keyserver.ubuntu.com'
-        #      key 'C2518248EEA14886'
-        #    end
+        #   # good
+        #   apt_repository 'atom-ppa' do
+        #     uri 'ppa:webupd8team/atom'
+        #     components ['main']
+        #     keyserver 'keyserver.ubuntu.com'
+        #     key 'C2518248EEA14886'
+        #   end
         #
         class SimplifyAptPpaSetup < Base
           extend AutoCorrector

data/lib/rubocop/cop/chef/modernize/sysctl_param_resource.rb

@@ -23,12 +23,12 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   sysctl_param 'fs.aio-max-nr' do
         #     value '1048576'
         #   end
         #
-        #   ### correct
+        #   # good
         #   sysctl 'fs.aio-max-nr' do
         #     value '1048576'
         #   end

data/lib/rubocop/cop/chef/modernize/unnecessary_mixlib_shellout_require.rb

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   require 'mixlib/shellout'
         #
         class UnnecessaryMixlibShelloutRequire < Base

data/lib/rubocop/cop/chef/modernize/use_chef_language_cloud_helpers.rb

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   node['cloud']['provider'] == 'alibaba'
         #   node['cloud']['provider'] == 'ec2'
         #   node['cloud']['provider'] == 'gce'
@@ -35,7 +35,7 @@ module RuboCop
         #   node['cloud']['provider'] == 'digital_ocean'
         #   node['cloud']['provider'] == 'softlayer'
         #
-        #   ### correct
+        #   # good
         #   alibaba?
         #   ec2?
         #   gce?

data/lib/rubocop/cop/chef/modernize/use_chef_language_env_helpers.rb

@@ -23,11 +23,11 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   ENV['CI']
         #   ENV['TEST_KITCHEN']
         #
-        #   ### correct
+        #   # good
         #   ci?
         #   kitchen?
         #

data/lib/rubocop/cop/chef/modernize/use_chef_language_systemd_helper.rb

@@ -23,10 +23,10 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   node['init_package'] == 'systemd'
         #
-        #   ### correct
+        #   # good
         #   systemd?
         #
         class UseChefLanguageSystemdHelper < Base

data/lib/rubocop/cop/chef/modernize/use_multipackage_installs.rb

@@ -23,21 +23,21 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   %w(bmon htop vim curl).each do |pkg|
         #     package pkg do
         #       action :install
         #     end
         #   end
         #
-        #   ### correct
+        #   # good
         #   package %w(bmon htop vim curl)
         #
         class UseMultipackageInstalls < Base
           extend AutoCorrector
 
           MSG = 'Pass an array of packages to package resources instead of iterating over an array of packages when using multi-package capable package subsystem such as apt, yum, chocolatey, dnf, or zypper. Multi-package installs are faster and simplify logs.'
-          MULTIPACKAGE_PLATS = %w(debian redhat suse amazon fedora scientific oracle rhel ubuntu centos redhat).freeze
+          MULTIPACKAGE_PLATS = %w(debian redhat suse amazon fedora scientific oracle rhel ubuntu centos).freeze
 
           def_node_matcher :platform_or_platform_family?, <<-PATTERN
             (send (send nil? :node) :[] (str {"platform" "platform_family"}) )

data/lib/rubocop/cop/chef/modernize/use_require_relative.rb

@@ -23,10 +23,10 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   require File.expand_path('../../libraries/helpers', __FILE__)
         #
-        #   ### correct
+        #   # good
         #   require_relative '../libraries/helpers'
         #
         class UseRequireRelative < Base

data/lib/rubocop/cop/chef/modernize/whyrun_supported_true.rb

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   def whyrun_supported?
         #    true
         #   end

data/lib/rubocop/cop/chef/modernize/windows_default_recipe.rb

@@ -19,11 +19,11 @@ module RuboCop
   module Cop
     module Chef
       module Modernize
-        # Don't include the windows default recipe that is either full of gem install that are part of the Chef Infra Client, or empty (depends on version).
+        # Don't include the windows default recipe that is either full of gem installs that are part of the Chef Infra Client, or empty (depends on version).
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   include_recipe 'windows::default'
         #   include_recipe 'windows'
         #