cookstyle 8.5.2 → 8.6.4

data/lib/rubocop/cop/chef/deprecation/legacy_notify_syntax.rb

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

data/lib/rubocop/cop/chef/deprecation/legacy_yum_cookbook_recipes.rb

@@ -25,7 +25,7 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   include_recipe 'yum::elrepo'
         #   include_recipe 'yum::epel'
         #   include_recipe 'yum::ius'

data/lib/rubocop/cop/chef/deprecation/librarian_chefspec.rb

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   require 'chefspec/librarian'
         #
         class LibrarianChefSpec < Base

data/lib/rubocop/cop/chef/deprecation/locale_lc_all_property.rb

@@ -19,11 +19,11 @@ module RuboCop
   module Cop
     module Chef
       module Deprecations
-        # The local resource's lc_all property has been deprecated and will be removed in Chef Infra Client 17
+        # The locale resource's lc_all property has been deprecated and will be removed in Chef Infra Client 17
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   locale 'set locale' do
         #     lang 'en_gb.utf-8'
         #     lc_all 'en_gb.utf-8'
@@ -32,7 +32,7 @@ module RuboCop
         class LocaleDeprecatedLcAllProperty < Base
           include RuboCop::Chef::CookbookHelpers
 
-          MSG = "The local resource's lc_all property has been deprecated and will be removed in Chef Infra Client 17"
+          MSG = "The locale resource's lc_all property has been deprecated and will be removed in Chef Infra Client 17"
 
           def on_block(node)
             match_property_in_resource?(:locale, 'lc_all', node) do |property|

data/lib/rubocop/cop/chef/deprecation/log_resource_notifications.rb

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   template '/etc/foo' do
         #     source 'bar.erb'
         #     notifies :write, 'log[Aggregate notifications using a single log resource]', :immediately
@@ -33,7 +33,7 @@ module RuboCop
         #     notifies :restart, 'service[foo]', :delayed
         #   end
         #
-        #   ### correct
+        #   # good
         #   template '/etc/foo' do
         #     source 'bar.erb'
         #     notifies :run, 'notify_group[Aggregate notifications using a single notify_group resource]', :immediately

data/lib/rubocop/cop/chef/deprecation/macos_userdefaults_global_property.rb

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

data/lib/rubocop/cop/chef/deprecation/name_property_and_default.rb

@@ -23,11 +23,11 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   property :config_file, String, default: 'foo', name_property: true
         #   attribute :config_file, String, default: 'foo', name_attribute: true
         #
-        #   ### correct
+        #   # good
         #   property :config_file, String, name_property: true
         #   attribute :config_file, String, name_attribute: true
         #

data/lib/rubocop/cop/chef/deprecation/node_deep_fetch.rb

@@ -22,16 +22,16 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   node.deep_fetch("foo")
         #
-        #   ### correct
+        #   # good
         #   node.read("foo")
         #
-        #   ### incorrect
+        #   # bad
         #   node.deep_fetch!("foo")
         #
-        #   ### correct
+        #   # good
         #   node.read!("foo")
         #
         class NodeDeepFetch < Base

data/lib/rubocop/cop/chef/deprecation/node_methods_not_attributes.rb

@@ -23,14 +23,14 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   node.fqdn
         #   node.platform
         #   node.platform_family
         #   node.platform_version
         #   node.hostname
         #
-        #   ### correct
+        #   # good
         #   node['fqdn']
         #   node['platform']
         #   node['platform_family']

data/lib/rubocop/cop/chef/deprecation/node_set.rb

@@ -24,10 +24,10 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   node.set['foo'] = true
         #
-        #   ### correct
+        #   # good
         #   node.normal['foo'] = true
         #
         class NodeSet < Base

data/lib/rubocop/cop/chef/deprecation/node_set_unless.rb

@@ -24,10 +24,10 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   node.set_unless['foo'] = true
         #
-        #   ### correct
+        #   # good
         #   node.normal_unless['foo'] = true
         #
         class NodeSetUnless < Base

data/lib/rubocop/cop/chef/deprecation/node_set_without_level.rb

@@ -22,13 +22,13 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   node['foo']['bar'] = 1
         #   node['foo']['bar'] << 1
         #   node['foo']['bar'] += 1
         #   node['foo']['bar'] -= 1
         #
-        #   ### correct
+        #   # good
         #   node.default['foo']['bar'] = 1
         #   node.default['foo']['bar'] << 1
         #   node.default['foo']['bar'] += 1

data/lib/rubocop/cop/chef/deprecation/partial_search_class_usage.rb

@@ -23,8 +23,8 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
-        #   ::Chef::PartialSearch.new.search((:node, 'role:web',
+        #   # bad
+        #   ::Chef::PartialSearch.new.search(:node, 'role:web',
         #     keys: { 'name' => [ 'name' ],
         #             'ip' => [ 'ipaddress' ],
         #             'kernel_version' => %w(kernel version),
@@ -35,7 +35,7 @@ module RuboCop
         #     puts result['kernel_version']
         #   end
         #
-        #   ### correct
+        #   # good
         #   search(:node, 'role:web',
         #     filter_result: { 'name' => [ 'name' ],
         #                      'ip' => [ 'ipaddress' ],

data/lib/rubocop/cop/chef/deprecation/partial_search_helper_usage.rb

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   partial_search(:node, 'role:web',
         #     keys: { 'name' => [ 'name' ],
         #             'ip' => [ 'ipaddress' ],
@@ -35,7 +35,7 @@ module RuboCop
         #     puts result['kernel_version']
         #   end
         #
-        #   ### correct
+        #   # good
         #   search(:node, 'role:web',
         #     filter_result: { 'name' => [ 'name' ],
         #                      'ip' => [ 'ipaddress' ],

data/lib/rubocop/cop/chef/deprecation/poise_archive.rb

@@ -23,12 +23,12 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   poise_archive 'https://example.com/myapp.tgz' do
         #     destination '/opt/my_app'
         #   end
         #
-        #   ### correct
+        #   # good
         #   archive_file 'https://example.com/myapp.tgz' do
         #     destination '/opt/my_app'
         #   end

data/lib/rubocop/cop/chef/deprecation/policyfile_community_source.rb

@@ -23,10 +23,10 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   default_source :community
         #
-        #   ### correct
+        #   # good
         #   default_source :supermarket
         #
         class PolicyfileCommunitySource < Base

data/lib/rubocop/cop/chef/deprecation/powershell_cookbook_helpers.rb

@@ -23,10 +23,10 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   Powershell::VersionHelper.powershell_version?('4.0')
         #
-        #   ### correct
+        #   # good
         #   node['powershell']['version'].to_f == 4.0
         #
         #   # better (Chef Infra Client 15.8+)

data/lib/rubocop/cop/chef/deprecation/require_recipe.rb

@@ -23,10 +23,10 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   require_recipe 'foo'
         #
-        #   ### correct
+        #   # good
         #   include_recipe 'foo'
         #
         class RequireRecipe < Base

data/lib/rubocop/cop/chef/deprecation/resource_overrides_provides_method.rb

@@ -23,12 +23,12 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   def provides?
         #    true
         #   end
         #
-        #   ### correct
+        #   # good
         #   provides :SOME_PROVIDER_NAME
         #
         class ResourceOverridesProvidesMethod < Base

data/lib/rubocop/cop/chef/deprecation/resource_uses_dsl_name_method.rb

@@ -23,10 +23,10 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   my_resource = MyResource.dsl_name
         #
-        #   ### correct
+        #   # good
         #   my_resource = MyResource.resource_name
         #
         class ResourceUsesDslNameMethod < Base
@@ -37,8 +37,8 @@ module RuboCop
             add_offense(node, severity: :warning)
           end
 
-          # potential autocorrect is new_resource.updated_by_last_action true, but we need to actually see what class we were called from
-          # this might not be worth it yet based on the number of these we'd run into and the false auto correct potential
+          # potential autocorrect is to replace .dsl_name with .resource_name, but we need to actually verify the context
+          # this might not be worth it yet based on the false auto correct potential
         end
       end
     end

data/lib/rubocop/cop/chef/deprecation/resource_uses_only_resource_name.rb

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   mycookbook/resources/myresource.rb:
         #   resource_name :mycookbook_myresource
         #

data/lib/rubocop/cop/chef/deprecation/resource_uses_provider_base_method.rb

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   provider_base ::Chef::Provider::SomethingSomething
         #
         class ResourceUsesProviderBaseMethod < Base

data/lib/rubocop/cop/chef/deprecation/resource_uses_updated_method.rb

@@ -23,16 +23,17 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   action :foo do
         #     updated = true
         #   end
         #
-        #   ### correct
+        #   # good
         #   action :foo do
         #     converge_by('resource did something') do
         #       # code that causes the resource to converge
         #     end
+        #   end
         #
         class ResourceUsesUpdatedMethod < Base
           MSG = "Don't use updated = true/false to update resource state. This will cause failures in Chef Infra Client 13 and later."

data/lib/rubocop/cop/chef/deprecation/resource_without_unified_mode_true.rb

@@ -19,11 +19,11 @@ module RuboCop
   module Cop
     module Chef
       module Deprecations
-        # Chef Infra Client 15.3 and later include a new Unified Mode that simplifies the execution of resources by replace the traditional compile and converge phases with a single phase. Unified mode simplifies writing advanced resources and avoids confusing errors that often occur when mixing ruby and Chef Infra resources. Chef Infra Client 17.0 and later will begin warning that `unified_mode true` should be set in all resources to validate that they will continue to function in Chef Infra Client 18.0 (April 2022) when Unified Mode becomes the default.
+        # Chef Infra Client 15.3 and later include a new Unified Mode that simplifies the execution of resources by replacing the traditional compile and converge phases with a single phase. Unified mode simplifies writing advanced resources and avoids confusing errors that often occur when mixing ruby and Chef Infra resources. Chef Infra Client 17.0 and later will begin warning that `unified_mode true` should be set in all resources to validate that they will continue to function in Chef Infra Client 18.0 (April 2022) when Unified Mode becomes the default.
         #
         # @example
         #
-        #  ### incorrect
+        #   # bad
         #   resource_name :foo
         #   provides :foo
         #
@@ -31,7 +31,7 @@ module RuboCop
         #     # some action code
         #   end
         #
-        #  ### correct
+        #   # good
         #   resource_name :foo
         #   provides :foo
         #   unified_mode true

data/lib/rubocop/cop/chef/deprecation/ruby_27_keyword_argument_warnings.rb

@@ -23,11 +23,11 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   shell_out!('hostnamectl status', { returns: [0, 1] })
         #   shell_out('hostnamectl status', { returns: [0, 1] })
         #
-        #   ### correct
+        #   # good
         #   shell_out!('hostnamectl status', returns: [0, 1])
         #   shell_out('hostnamectl status', returns: [0, 1])
         #

data/lib/rubocop/cop/chef/deprecation/ruby_block_create_action.rb

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   ruby_block 'my special ruby block' do
         #     block do
         #       puts 'running'
@@ -31,7 +31,7 @@ module RuboCop
         #     action :create
         #   end
         #
-        #   ### correct
+        #   # good
         #   ruby_block 'my special ruby block' do
         #     block do
         #       puts 'running'

data/lib/rubocop/cop/chef/deprecation/run_command_helper.rb

@@ -23,14 +23,14 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   require 'chef/mixin/command'
         #   include Chef::Mixin::Command
         #
         #   run_command('/bin/foo')
         #   run_command_with_systems_locale('/bin/foo')
         #
-        #   ### correct
+        #   # good
         #   shell_out!('/bin/foo')
         #
         class UsesRunCommandHelper < Base

data/lib/rubocop/cop/chef/deprecation/search_uses_positional_parameters.rb

@@ -23,17 +23,15 @@ module RuboCop
         #
         # @example
         #
-        ### incorrect:
-        #  search(:node, '*:*', 0, 1000, { :ip_address => ["ipaddress"] })
-        #  search(:node, '*:*', 0, 1000)
-        #  search(:node, '*:*', 0)
-
-        ### correct
+        #   # bad
+        #   search(:node, '*:*', 0, 1000, { :ip_address => ["ipaddress"] })
+        #   search(:node, '*:*', 0, 1000)
+        #   search(:node, '*:*', 0)
         #
-        # query(:node, '*:*')
-        #  search(:node, '*:*', start: 0, rows: 1000, filter_result: { :ip_address => ["ipaddress"] })
-        #  search(:node, '*:*', start: 0, rows: 1000)
-        #  search(:node, '*:*', start: 0)
+        #   # good
+        #   search(:node, '*:*', start: 0, rows: 1000, filter_result: { :ip_address => ["ipaddress"] })
+        #   search(:node, '*:*', start: 0, rows: 1000)
+        #   search(:node, '*:*', start: 0)
         #
         class SearchUsesPositionalParameters < Base
           extend AutoCorrector

data/lib/rubocop/cop/chef/deprecation/use_automatic_resource_name.rb

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   module MyCookbook
         #     class MyCookbookService < Chef::Resource
         #       use_automatic_resource_name

data/lib/rubocop/cop/chef/deprecation/use_inline_resources.rb

@@ -24,7 +24,7 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   use_inline_resources
         #   use_inline_resources if defined?(use_inline_resources)
         #   use_inline_resources if respond_to?(:use_inline_resources)

data/lib/rubocop/cop/chef/deprecation/use_yaml_dump.rb

@@ -23,10 +23,10 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   {"foo" => "bar"}.to_yaml
         #
-        #   ### correct
+        #   # good
         #   YAML.dump({"foo" => "bar"})
         #
         class UseYamlDump < Base

data/lib/rubocop/cop/chef/deprecation/user_supports_property.rb

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   user "betty" do
         #     supports({
         #       manage_home: true,
@@ -35,7 +35,7 @@ module RuboCop
         #     supports :manage_home => true
         #   end
         #
-        #   ### correct
+        #   # good
         #   user "betty" do
         #     manage_home true
         #     non_unique true

data/lib/rubocop/cop/chef/deprecation/verify_property_file_expansion.rb

@@ -23,12 +23,12 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   file '/etc/nginx.conf' do
         #     verify 'nginx -t -c %{file}'
         #   end
         #
-        #   ### correct
+        #   # good
         #   file '/etc/nginx.conf' do
         #     verify 'nginx -t -c %{path}'
         #   end

data/lib/rubocop/cop/chef/deprecation/windows_feature_servermanagercmd.rb

@@ -23,12 +23,12 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   windows_feature 'DHCP' do
         #     install_method :servermanagercmd
         #   end
         #
-        #   ### correct
+        #   # good
         #   windows_feature 'DHCP' do
         #     install_method :windows_feature_dism
         #   end

data/lib/rubocop/cop/chef/deprecation/windows_package_installer_type_string.rb

@@ -23,14 +23,14 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   windows_package 'AppveyorDeploymentAgent' do
         #     source 'https://www.example.com/appveyor.msi'
         #     installer_type 'msi'
         #     options "/quiet /qn /norestart /log install.log"
         #   end
         #
-        #   ### correct
+        #   # good
         #   windows_package 'AppveyorDeploymentAgent' do
         #     source 'https://www.example.com/appveyor.msi'
         #     installer_type :msi

data/lib/rubocop/cop/chef/deprecation/windows_task_change_action.rb

@@ -20,11 +20,11 @@ module RuboCop
     module Chef
       module Deprecations
         # The :change action in the windows_task resource was removed when windows_task was added to Chef Infra Client 13+
-        # The default action of :create should can now be used to create an update tasks.
+        # The default action of :create can now be used to create and update tasks.
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   windows_task 'chef ad-join leave start time' do
         #     task_name 'chef ad-join leave'
         #     start_day '06/09/2016'
@@ -32,7 +32,7 @@ module RuboCop
         #     action [:change, :create]
         #   end
         #
-        #   ### correct
+        #   # good
         #   windows_task 'chef ad-join leave start time' do
         #     task_name 'chef ad-join leave'
         #     start_day '06/09/2016'
@@ -47,7 +47,7 @@ module RuboCop
 
           minimum_target_chef_version '13.0'
 
-          MSG = 'The :change action in the windows_task resource was removed when windows_task was added to Chef Infra Client 13+. The default action of :create should can now be used to create an update tasks.'
+          MSG = 'The :change action in the windows_task resource was removed when windows_task was added to Chef Infra Client 13+. The default action of :create can now be used to create and update tasks.'
 
           def on_block(node)
             match_property_in_resource?(:windows_task, 'action', node) do |action_node|

data/lib/rubocop/cop/chef/deprecation/windows_version_helpers.rb

@@ -23,13 +23,13 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   Windows::VersionHelper.nt_version
         #   Windows::VersionHelper.server_version?
         #   Windows::VersionHelper.core_version?
         #   Windows::VersionHelper.workstation_version?
         #
-        #   ### correct
+        #   # good
         #   node['platform_version'].to_f
         #   node['kernel']['product_type'] == 'Server'
         #   node['kernel']['server_core']

data/lib/rubocop/cop/chef/deprecation/xml_ruby_recipe.rb

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   include_recipe 'xml::ruby'
         #
         class IncludingXMLRubyRecipe < Base