cookstyle 7.7.2 → 7.8.0

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

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

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

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   ::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'
         #
-        #   # good
+        #   #### correct
         #   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
         #
-        #   # bad
+        #   #### incorrect
         #   node['roles'].include?('foo')
         #
-        #   # good
+        #   #### correct
         #   node.role?('foo')
         #
         class NodeRolesInclude < Base

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

@@ -19,13 +19,11 @@ module RuboCop
   module Cop
     module Chef
       module Modernize
-        # The Ohai default recipe previously allowed a user to ship custom Ohai plugins to a system by including them
-        # in a directory in the Ohai cookbook. This functionality was replaced with the ohai_plugin resource, which
-        # should be used instead as it doesn't require forking the ohai cookbook.
+        # The Ohai default recipe previously allowed a user to ship custom Ohai plugins to a system by including them in a directory in the Ohai cookbook. This functionality was replaced with the ohai_plugin resource, which should be used instead as it doesn't require forking the ohai cookbook.
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   include_recipe 'ohai::default'
         #   include_recipe 'ohai'
         #

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

@@ -19,15 +19,16 @@ module RuboCop
   module Cop
     module Chef
       module Modernize
-        # The openssl_rsa_key resource was renamed to openssl_rsa_private_key in Chef
-        # Infra Client 14.0. The new resource name should be used.
+        # The openssl_rsa_key resource was renamed to openssl_rsa_private_key in Chef Infra Client 14.0. The new resource name should be used.
         #
-        #   # bad
+        # @example
+        #
+        #   #### incorrect
         #   openssl_rsa_key '/etc/httpd/ssl/server.key' do
         #     key_length 2048
         #   end
         #
-        #   # good
+        #   #### correct
         #   openssl_rsa_private_key '/etc/httpd/ssl/server.key' do
         #     key_length 2048
         #   end

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

@@ -19,10 +19,11 @@ module RuboCop
   module Cop
     module Chef
       module Modernize
-        # The openssl_x509 resource was renamed to openssl_x509_certificate in Chef Infra Client 14.4.
-        # The new resource name should be used.
+        # The openssl_x509 resource was renamed to openssl_x509_certificate in Chef Infra Client 14.4. The new resource name should be used.
         #
-        #   # bad
+        # @example
+        #
+        #   #### incorrect
         #   openssl_x509 '/etc/httpd/ssl/mycert.pem' do
         #     common_name 'www.f00bar.com'
         #     org 'Foo Bar'
@@ -30,7 +31,7 @@ module RuboCop
         #     country 'US'
         #   end
         #
-        #   # good
+        #   #### correct
         #   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

@@ -19,15 +19,16 @@ module RuboCop
   module Cop
     module Chef
       module Modernize
-        # The osx_config_profile resource was renamed to osx_profile.
-        # The new resource name should be used.
+        # The osx_config_profile resource was renamed to osx_profile. The new resource name should be used.
         #
-        #   # bad
+        # @example
+        #
+        #   #### incorrect
         #   osx_config_profile 'Install screensaver profile' do
         #     profile 'screensaver/com.company.screensaver.mobileconfig'
         #   end
         #
-        #   # good
+        #   #### correct
         #   osx_profile 'Install screensaver profile' do
         #     profile 'screensaver/com.company.screensaver.mobileconfig'
         #   end

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

@@ -19,12 +19,11 @@ module RuboCop
   module Cop
     module Chef
       module Modernize
-        # Use the archive_file resource built into Chef Infra Client 15+ instead of using the powershell_script
-        # resource to run Expand-Archive
+        # Use the archive_file resource built into Chef Infra Client 15+ instead of using the powershell_script resource to run Expand-Archive
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   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
         #
-        #   # bad
+        #   #### incorrect
         #   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
         #
-        #   # good
+        #   #### correct
         #   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

@@ -19,17 +19,16 @@ module RuboCop
   module Cop
     module Chef
       module Modernize
-        # Use the powershell_package resource built into Chef Infra Client instead of the powershell_script
-        # resource to run Install-Package
+        # Use the powershell_package resource built into Chef Infra Client instead of the powershell_script resource to run Install-Package
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   powershell_script 'Expand website' do
         #     code 'Install-Package -Name docker'
         #   end
         #
-        #  # good
+        #  #### correct
         #  powershell_package 'docker'
         #
         class PowershellInstallPackage < Base

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

@@ -19,17 +19,16 @@ module RuboCop
   module Cop
     module Chef
       module Modernize
-        # Use the windows_feature resource built into Chef Infra Client 14+ instead of the powershell_script resource
-        # to run Install-WindowsFeature or Add-WindowsFeature
+        # Use the windows_feature resource built into Chef Infra Client 14+ instead of the powershell_script resource to run Install-WindowsFeature or Add-WindowsFeature
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   powershell_script 'Install Feature' do
         #     code 'Install-WindowsFeature -Name "Net-framework-Core"'
         #   end
         #
-        #  # good
+        #  #### correct
         #  windows_feature 'Net-framework-Core' do
         #    action :install
         #    install_method :windows_feature_powershell

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

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

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

@@ -23,13 +23,13 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   def initialize(*args)
         #     super
         #     @provides = :foo
         #   end
         #
-        #   # good
+        #   #### correct
         #   provides :foo
         #
         class ProvidesFromInitialize < Base

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

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

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

@@ -20,13 +20,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 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
         #
-        #   # bad
+        #   #### incorrect
         #    def severity(arg = nil)
         #      set_or_return(
         #        :severity, arg,
@@ -35,7 +33,7 @@ module RuboCop
         #      )
         #    end
         #
-        #   # good
+        #   #### correct
         #   property :severity, String
         #
         class SetOrReturnInResources < Base

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

@@ -20,20 +20,18 @@ module RuboCop
   module Cop
     module Chef
       module Modernize
-        # In HWRPs and LWRPs you defined attributes, but custom resources changed the name to
-        # be properties to avoid confusion with chef recipe attributes. When writing a custom resource
-        # they should be called properties even though the two are aliased.
+        # In HWRPs and LWRPs you defined attributes, but custom resources changed the name to be properties to avoid confusion with chef recipe attributes. When writing a custom resource they should be called properties even though the two are aliased.
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   attribute :something, String
         #
         #   action :create do
         #     # some action code because we're in a custom resource
         #   end
         #
-        #   # good
+        #   #### correct
         #   property :something, String
         #
         #   action :create do

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

@@ -21,7 +21,9 @@ module RuboCop
       module Modernize
         # There is no need to check if the chef_gem resource supports compile_time as Chef Infra Client 12.1 and later support the compile_time property.
         #
-        #   # bad
+        # @example
+        #
+        #   #### incorrect
         #   chef_gem 'ultradns-sdk' do
         #     compile_time true if Chef::Resource::ChefGem.method_defined?(:compile_time)
         #     action :nothing
@@ -37,7 +39,7 @@ module RuboCop
         #     action :nothing
         #   end
         #
-        #   # good
+        #   #### correct
         #   chef_gem 'ultradns-sdk' do
         #     compile_time true
         #     action :nothing

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

@@ -19,12 +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 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.
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   chef_version '>= 13' if respond_to?(:chef_version)
         #   chef_version '>= 13' if defined?(chef_version)
         #   chef_version '>= 13' unless defined?(Ridley::Chef::Cookbook::Metadata)
@@ -32,7 +31,7 @@ module RuboCop
         #     chef_version '>= 13'
         #   end
         #
-        #   # good
+        #   #### correct
         #   chef_version '>= 13'
         #
         class RespondToInMetadata < Base

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

@@ -23,12 +23,12 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   provides :foo if respond_to?(:provides)
         #
         #   provides :foo if defined? provides
         #
-        #   # good
+        #   #### correct
         #   provides :foo
         #
         class RespondToProvides < Base

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

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

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

@@ -19,15 +19,17 @@ module RuboCop
   module Cop
     module Chef
       module Modernize
-        # The sc_windows resource from the sc cookbook allowed for the creation of windows services on legacy Chef Infra Client releases. Chef Infra Client 14.0 and later includes :create, :delete, and :configure actions without the need for additional cookbook dependencies. 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.
+        # The sc_windows resource from the sc cookbook allowed for the creation of windows services on legacy Chef Infra Client releases. Chef Infra Client 14.0 and later includes :create, :delete, and :configure actions without the need for additional cookbook dependencies. See the windows_service documentation at https://docs.chef.io/resources/windows_service for additional details on creating services with the windows_service resource.
         #
-        #   # bad
+        # @example
+        #
+        #   #### incorrect
         #   sc_windows 'chef-client' do
         #     path "C:\\opscode\\chef\\bin"
         #     action :create
         #   end
         #
-        #   # good
+        #   #### correct
         #   windows_service 'chef-client' do
         #     action :create
         #     binary_path_name "C:\\opscode\\chef\\bin"
@@ -38,7 +40,7 @@ module RuboCop
 
           minimum_target_chef_version '14.0'
 
-          MSG = '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.'
+          MSG = '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.'
           RESTRICT_ON_SEND = [:sc_windows].freeze
 
           def on_send(node)

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

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

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

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

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

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   execute 'install package foo' do
         #     command "choco install --source=artifactory \"foo\" -y --no-progress --ignore-package-exit-codes"
         #   end