cookstyle 8.5.2 → 8.6.4

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

@@ -23,10 +23,10 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   supports 'redhat', '> 8'
         #
-        #   ### correct
+        #   # good
         #   supports 'redhat', '> 8.0'
         #
         class SupportsMustBeFloat < Base

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

@@ -22,10 +22,10 @@ module RuboCop
         #
         # @example downloading a large file into /tmp/
         #
-        #   ### incorrect
+        #   # bad
         #   remote_file '/tmp/large-file.tar.gz' do
         #
-        #   ### correct
+        #   # good
         #   remote_file "#{Chef::Config[:file_cache_path]}/large-file.tar.gz" do
         #
         class TmpPath < Base

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

@@ -23,11 +23,11 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   name 'foo'
         #   depends 'foo'
         #
-        #   ### correct
+        #   # good
         #   name 'foo'
         #
         class CookbooksDependsOnSelf < Base

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

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

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

@@ -19,16 +19,16 @@ module RuboCop
   module Cop
     module Chef
       module Deprecations
-        # Use the type `property` instead of the deprecated `supports` property in the `chef_handler` resource. The `supports` property was removed in `chef_handler` cookbook version 3.0 (June 2017) and Chef Infra Client 14.0.
+        # Use the `type` property instead of the deprecated `supports` property in the `chef_handler` resource. The `supports` property was removed in `chef_handler` cookbook version 3.0 (June 2017) and Chef Infra Client 14.0.
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   chef_handler 'whatever' do
         #     supports start: true, report: true, exception: true
-        #   end0
+        #   end
         #
-        #   ### correct
+        #   # good
         #   chef_handler 'whatever' do
         #     type start: true, report: true, exception: true
         #   end

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

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   require 'chef/rest'
         #   Chef::REST::RESTRequest.new(:GET, FOO, nil).call
         #

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

@@ -23,12 +23,12 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   include Chef::ShellOut
         #   require 'chef/shellout'
         #   Chef::ShellOut.new('some_command')
         #
-        #   ### correct
+        #   # good
         #   include Mixlib::ShellOut
         #   require 'mixlib/shellout'
         #   Mixlib::ShellOut.new('some_command')

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

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   vagrant_key?
         #   vagrant_domain?
         #   vagrant_user?

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

@@ -23,10 +23,10 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   Chef::Platform.windows?
         #
-        #   ### correct
+        #   # good
         #   platform?('windows')
         #   platform_family?('windows')
         #

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

@@ -23,14 +23,14 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   ChefDK::CLI
         #   ChefDK::Generator::TemplateHelper
         #   module ChefDK
         #     # some additional code
         #   end
         #
-        #   ### correct
+        #   # good
         #   ChefCLI::CLI
         #   ChefCLI::Generator::TemplateHelper
         #   module ChefCLI
@@ -42,7 +42,7 @@ module RuboCop
           MSG = 'When writing cookbook generators use the ChefCLI module instead of the ChefDK module which was removed in Chef Workstation 0.8 and later.'
 
           def on_const(node)
-            # We want to catch calls like ChefCLI::CLI.whatever or places where classes are defined in the ChefDK module
+            # We want to catch calls like ChefDK::CLI.whatever or places where classes are defined in the ChefDK module
             return unless node.const_name == 'ChefDK' && (node.parent&.module_type? || node.parent&.const_type?)
 
             add_offense(node, severity: :warning) do |corrector|

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

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #
         #   at_exit { ChefSpec::Coverage.report! }
         #

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

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #
         #   describe 'foo::default' do
         #     subject { ChefSpec::Runner.new.converge(described_recipe) }
@@ -31,7 +31,7 @@ module RuboCop
         #     # some spec code
         #   end
         #
-        #   ### correct
+        #   # good
         #
         #   describe 'foo::default' do
         #     subject { ChefSpec::ServerRunner.new.converge(described_recipe) }

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

@@ -23,12 +23,12 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   chocolatey_package 'nginx' do
         #     action :uninstall
         #   end
         #
-        #   ### correct
+        #   # good
         #   chocolatey_package 'nginx' do
         #     action :remove
         #   end

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

@@ -23,10 +23,10 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   depends 'chef_nginx'
         #
-        #   ### correct
+        #   # good
         #   depends 'nginx'
         #
         class DependsOnChefNginxCookbook < Base
@@ -36,12 +36,12 @@ module RuboCop
           MSG = "Don't depend on the deprecated `chef_nginx` cookbook that was replaced by the `nginx` cookbook."
           RESTRICT_ON_SEND = [:depends].freeze
 
-          def_node_matcher :depends_compat_resource?, <<-PATTERN
+          def_node_matcher :depends_chef_nginx?, <<-PATTERN
             (send nil? :depends (str {"chef_nginx"}))
           PATTERN
 
           def on_send(node)
-            depends_compat_resource?(node) do
+            depends_chef_nginx?(node) do
               add_offense(node, severity: :warning) do |corrector|
                 corrector.remove(range_with_surrounding_space(range: node.loc.expression, side: :left))
               end

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

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   depends 'chef-reporting'
         #
         class DependsOnChefReportingCookbook < Base

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

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   depends 'compat_resource'
         #
         class CookbookDependsOnCompatResource < Base

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

@@ -23,10 +23,10 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   depends 'omnibus_updater'
         #
-        #   ### correct
+        #   # good
         #   depends 'chef_client_updater'
         #
         class DependsOnOmnibusUpdaterCookbook < Base

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

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   depends 'partial_search'
         #
         class CookbookDependsOnPartialSearch < Base

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

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   depends 'poise'
         #   depends 'poise-service'
         #   depends 'poise-hoist'

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

@@ -19,7 +19,7 @@ module RuboCop
   module Cop
     module Chef
       module Deprecations
-        # Use currently supported platforms in ChefSpec listed at https://github.com/chef/fauxhai/blob/main/PLATFORMS.md. Fauxhai / ChefSpec will perform fuzzy matching on platform version values so it's always best to be less specific ie. 10 instead of 10.3
+        # Use currently supported platforms in ChefSpec listed at https://github.com/chef/fauxhai/blob/main/PLATFORMS.md. Fauxhai / ChefSpec will perform fuzzy matching on platform version values so it's always best to be less specific i.e. 10 instead of 10.3
         #
         # @example
         #
@@ -29,7 +29,7 @@ module RuboCop
           include RuboCop::Chef::CookbookHelpers
           extend AutoCorrector
 
-          MSG = "Use currently supported platforms in ChefSpec listed at https://github.com/chef/fauxhai/blob/main/PLATFORMS.md. Fauxhai / ChefSpec will perform fuzzy matching on platform version so it's always best to be less specific ie. 10 instead of 10.3"
+          MSG = "Use currently supported platforms in ChefSpec listed at https://github.com/chef/fauxhai/blob/main/PLATFORMS.md. Fauxhai / ChefSpec will perform fuzzy matching on platform version so it's always best to be less specific i.e. 10 instead of 10.3"
 
           DEPRECATED_MAPPING = {
             'amazon' => {
@@ -109,7 +109,7 @@ module RuboCop
                                     replacement != true # true means it's busted, but requires human intervention to fix
             end
 
-            nil # we don't have a replacement os return nil
+            nil # we don't have a replacement so return nil
           end
 
           def on_send(node)

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

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   include Chef::Mixin::LanguageIncludeAttribute
         #   include Chef::Mixin::RecipeDefinitionDSLCore
         #   include Chef::Mixin::LanguageIncludeRecipe

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

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   resource = Chef::Resource::File.new("/tmp/foo.xyz", run_context)
         #   provider = Chef::Platform.provider_for_resource(resource, :create)
         #
@@ -35,7 +35,7 @@ module RuboCop
         #
         #   Chef::Platform.set :platform => :mac_os_x, :resource => :package, :provider => Chef::Provider::Package::Homebrew
         #
-        #   ### correct
+        #   # good
         #   resource = Chef::Resource::File.new("/tmp/foo.xyz", run_context)
         #   provider = resource.provider_for_action(:create)
         #

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

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   shell_out_compact('foo')
         #   shell_out_compact!('foo')
         #   shell_out_with_timeout('foo')
@@ -33,7 +33,7 @@ module RuboCop
         #   shell_out_compact_timeout('foo')
         #   shell_out_compact_timeout!('foo')
         #
-        #   ### correct
+        #   # good
         #   shell_out('foo')
         #   shell_out!('foo')
         #   shell_out!('foo', default_env: false) # replaces shell_out_with_systems_locale

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

@@ -23,14 +23,14 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   sudo 'admins' do
         #     users 'bob'
         #     groups 'sysadmins, superusers'
         #     action :remove
         #   end
         #
-        #   ### correct
+        #   # good
         #   sudo 'admins' do
         #     users 'bob'
         #     groups 'sysadmins, superusers'

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

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   if older_than_win_2012_or_8?
         #     # do some legacy things
         #   end

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

@@ -19,11 +19,11 @@ module RuboCop
   module Cop
     module Chef
       module Deprecations
-        # With the release of Chef Infra Client 12.14 and the yum cookbook 3.0 the actions the `yum_repository` resource actions were renamed. The `add` action became `create` and `delete` became `remove` to better match other resources in Chef Infra Client.
+        # With the release of Chef Infra Client 12.14 and the yum cookbook 3.0 the `yum_repository` resource actions were renamed. The `add` action became `create` and `delete` became `remove` to better match other resources in Chef Infra Client.
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   yum_repository 'OurCo' do
         #     description 'OurCo yum repository'
         #     baseurl 'http://artifacts.ourco.org/foo/bar'
@@ -31,7 +31,7 @@ module RuboCop
         #     action :add
         #   end
         #
-        #   ### correct
+        #   # good
         #   yum_repository 'OurCo' do
         #     description 'OurCo yum repository'
         #     baseurl 'http://artifacts.ourco.org/foo/bar'
@@ -46,7 +46,7 @@ module RuboCop
 
           minimum_target_chef_version '12.14'
 
-          MSG = 'With the release of Chef Infra Client 12.14 and the yum cookbook 3.0 several properties in the yum_repository resource the actions the yum_repository resource actions were renamed. The `add` action became `create` and `delete` became `remove` to better match other resources in Chef Infra Client.'
+          MSG = 'With the release of Chef Infra Client 12.14 and the yum cookbook 3.0 the `yum_repository` resource actions were renamed. The `add` action became `create` and `delete` became `remove` to better match other resources in Chef Infra Client.'
 
           def on_block(node)
             match_property_in_resource?(:yum_repository, 'action', node) do |prop_node|

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

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   yum_repository 'OurCo' do
         #     description 'OurCo yum repository'
         #     url 'http://artifacts.ourco.org/foo/bar'
@@ -32,7 +32,7 @@ module RuboCop
         #     action :create
         #   end
         #
-        #   ### correct
+        #   # good
         #   yum_repository 'OurCo' do
         #     description 'OurCo yum repository'
         #     baseurl 'http://artifacts.ourco.org/foo/bar'

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

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   easy_install "my_thing" do
         #     bar
         #   end

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

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   control_group 'Baseline' do
         #     control 'SSH' do
         #       it 'should be listening on port 22' do

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

@@ -23,12 +23,12 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   package "foo" do
         #     epic_fail true
         #   end
         #
-        #   ### correct
+        #   # good
         #   package "foo" do
         #     ignore_failure true
         #   end

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

@@ -19,11 +19,11 @@ module RuboCop
   module Cop
     module Chef
       module Deprecations
-        # Don't use the deprecated `erl_call` resource removed in Chef Infra Client 13."
+        # Don't use the deprecated `erl_call` resource removed in Chef Infra Client 13.
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   erl_call "foo" do
         #     bar
         #   end

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

@@ -23,12 +23,12 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   execute 'some_cmd' do
         #     path '/foo/bar'
         #   end
         #
-        #   ### correct
+        #   # good
         #   execute 'some_cmd' do
         #     environment {path: '/foo/bar'}
         #   end

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

@@ -19,16 +19,16 @@ module RuboCop
   module Cop
     module Chef
       module Deprecations
-        # In Chef Infra Client 13 and later you must either specific an absolute path when using the `execute` resource's `creates` property or also use the `cwd` property.
+        # In Chef Infra Client 13 and later you must either specify an absolute path when using the `execute` resource's `creates` property or also use the `cwd` property.
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   execute 'some_cmd' do
         #     creates 'something'
         #   end
         #
-        #   ### correct
+        #   # good
         #   execute 'some_cmd' do
         #     creates '/tmp/something'
         #   end
@@ -41,7 +41,7 @@ module RuboCop
         class ExecuteRelativeCreatesWithoutCwd < Base
           include RuboCop::Chef::CookbookHelpers
 
-          MSG = "In Chef Infra Client 13 and later you must either specific an absolute path when using the `execute` resource's `creates` property or also use the `cwd` property."
+          MSG = "In Chef Infra Client 13 and later you must either specify an absolute path when using the `execute` resource's `creates` property or also use the `cwd` property."
 
           def on_block(node)
             match_property_in_resource?(:execute, 'creates', node) do |offense|

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

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   gem 'foodcritic'
         #   require 'foodcritic'
         #

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

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   class Chef
         #     class Resource
         #       class UlimitRule < Chef::Resource
@@ -35,7 +35,7 @@ module RuboCop
         #     end
         #   end
         #
-        #   ### incorrect
+        #   # bad
         #   class Chef
         #     class Resource
         #       class UlimitRule < Chef::Resource
@@ -49,7 +49,7 @@ module RuboCop
         #     end
         #   end
         #
-        #  ### correct when Chef Infra Client < 15 (but compatible with 16+ as well)
+        #   # good when Chef Infra Client < 15 (but compatible with 16+ as well)
         #   class Chef
         #     class Resource
         #       class UlimitRule < Chef::Resource
@@ -64,7 +64,7 @@ module RuboCop
         #     end
         #   end
         #
-        #  ### correct when Chef Infra Client 16+
+        #   # good when Chef Infra Client 16+
         #   class Chef
         #     class Resource
         #       class UlimitRule < Chef::Resource

data/lib/rubocop/cop/chef/deprecation/hwrp_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
         #   class Chef
         #     class Resource
         #       class UlimitRule < Chef::Resource
@@ -37,7 +37,7 @@ module RuboCop
         #     end
         #   end
         #
-        #  ### correct
+        #   # good
         #   class Chef
         #     class Resource
         #       class UlimitRule < Chef::Resource

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

@@ -23,15 +23,15 @@ module RuboCop
         #
         # @example
         #
-        #  ### incorrect
-        #  class AptUpdate < ChefCompat::Resource
-        #    # some resource code
-        #  end
+        #   # bad
+        #   class AptUpdate < ChefCompat::Resource
+        #     # some resource code
+        #   end
         #
-        #  ### correct
-        #  class AptUpdate < Chef::Resource
-        #    # some resource code
-        #  end
+        #   # good
+        #   class AptUpdate < Chef::Resource
+        #     # some resource code
+        #   end
         #
         #  # better
         #  Write a custom resource using the custom resource DSL and avoid class based HWRPs entirely

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

@@ -23,12 +23,12 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   launchd 'foo' do
         #     hash foo: 'bar'
         #   end
         #
-        #   ### correct
+        #   # good
         #   launchd 'foo' do
         #     plist_hash foo: 'bar'
         #   end