cookstyle 7.7.2 → 7.10.1

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

@@ -21,7 +21,9 @@ module RuboCop
       module Modernize
         # Chef Infra Client 14.0 and later includes a sysctl resource that should be used to idempotently load sysctl values instead of templating files and using execute to load them.
         #
-        #   # bad
+        # @example
+        #
+        #   #### incorrect
         #   file '/etc/sysctl.d/ipv4.conf' do
         #     notifies :run, 'execute[sysctl -p /etc/sysctl.d/ipv4.conf]', :immediately
         #     content '9000 65500'
@@ -31,7 +33,7 @@ module RuboCop
         #     action :nothing
         #   end
         #
-        #   # good
+        #   #### correct
         #   sysctl 'net.ipv4.ip_local_port_range' do
         #     value '9000 65500'
         #   end

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

@@ -19,10 +19,11 @@ module RuboCop
   module Cop
     module Chef
       module Modernize
-        # Instead of using the execute or powershell_script resources to to run the `tzutil` command, use
-        # Chef Infra Client's built-in timezone resource which is available in Chef Infra Client 14.6 and later.
+        # Instead of using the execute or powershell_script resources to run the `tzutil` command, use Chef Infra Client's built-in timezone resource which is available in Chef Infra Client 14.6 and later.
         #
-        #   # bad
+        # @example
+        #
+        #   #### incorrect
         #   execute 'set tz' do
         #     command 'tzutil.exe /s UTC'
         #   end
@@ -34,7 +35,7 @@ module RuboCop
         #     not_if { shell_out('tzutil.exe /g').stdout.include?('UTC') }
         #   end
         #
-        #   # good
+        #   #### correct
         #   timezone 'UTC'
         #
         class ExecuteTzUtil < Base

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

@@ -24,7 +24,7 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   # ~FC013
         #
         class FoodcriticComments < Base

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

@@ -23,10 +23,10 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   default_action :foo if defined?(default_action)
         #
-        #   # good
+        #   #### correct
         #   default_action :foo
         #
         class IfProvidesDefaultAction < Base

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

@@ -24,7 +24,7 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   require 'chef/mixin/shell_out'
         #   include Chef::Mixin::ShellOut
         #   require 'chef/mixin/powershell_out'

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

@@ -24,12 +24,12 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   libarchive_file "C:\file.zip" do
         #     path 'C:\expand_here'
         #   end
         #
-        #   # good
+        #   #### correct
         #   archive_file "C:\file.zip" do
         #     path 'C:\expand_here'
         #   end

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

@@ -19,17 +19,18 @@ module RuboCop
   module Cop
     module Chef
       module Modernize
-        # The mac_os_x_userdefaults resource was renamed to macos_userdefaults when it was added to Chef Infra Client
-        # 14.0. The new resource name should be used.
+        # The mac_os_x_userdefaults resource was renamed to macos_userdefaults when it was added to Chef Infra Client 14.0. The new resource name should be used.
         #
-        #   # bad
+        # @example
+        #
+        #   #### incorrect
         #   mac_os_x_userdefaults 'full keyboard access to all controls' do
         #     domain 'AppleKeyboardUIMode'
         #     global true
         #     value '2'
         #   end
         #
-        #   # good
+        #   #### correct
         #   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
         #
-        #   # 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