cookstyle 7.7.2 → 7.8.0

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

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

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

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

@@ -24,7 +24,7 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   shell_out_compact('foo')
         #   shell_out_compact!('foo')
         #   shell_out_with_timeout('foo')
@@ -34,7 +34,7 @@ module RuboCop
         #   shell_out_compact_timeout('foo')
         #   shell_out_compact_timeout!('foo')
         #
-        #   # good
+        #   #### correct
         #   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_windows_version_check.rb

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

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

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

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

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

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

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

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

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

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

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

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

@@ -24,7 +24,7 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   erl_call "foo" do
         #     bar
         #   end

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

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

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

@@ -24,12 +24,12 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   execute 'some_cmd' do
         #     creates 'something'
         #   end
         #
-        #   # good
+        #   #### correct
         #   execute 'some_cmd' do
         #     creates '/tmp/something'
         #   end

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

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

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

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

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

@@ -24,12 +24,12 @@ module RuboCop
         #
         # @example
         #
-        #  # bad
+        #  #### incorrect
         #  class AptUpdate < ChefCompat::Resource
         #    # some resource code
         #  end
         #
-        #  # good
+        #  #### correct
         #  class AptUpdate < Chef::Resource
         #    # some resource code
         #  end

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

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

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

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   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
         #
-        #   # good
+        #   #### correct
         #   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
         #
-        #   # bad
+        #   #### incorrect
         #   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
         #
-        #   # bad
+        #   #### incorrect
         #   require 'chefspec/librarian'
         #
         class LibrarianChefSpec < Base

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

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   locale 'set locale' do
         #     lang 'en_gb.utf-8'
         #     lc_all 'en_gb.utf-8'

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

@@ -24,7 +24,7 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   template '/etc/foo' do
         #     source 'bar.erb'
         #     notifies :write, 'log[Aggregate notifications using a single log resource]', :immediately
@@ -34,7 +34,7 @@ module RuboCop
         #     notifies :restart, 'service[foo]', :delayed
         #   end
         #
-        #   # good
+        #   #### correct
         #   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

@@ -24,14 +24,14 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   macos_userdefaults 'set a value' do
         #     global true
         #     key 'key'
         #     value 'value'
         #   end
         #
-        #   # good
+        #   #### correct
         #   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
         #
-        #   # bad
+        #   #### incorrect
         #   property :config_file, String, default: 'foo', name_property: true
         #   attribute :config_file, String, default: 'foo', name_attribute: true
         #
-        #   # good
+        #   #### correct
         #   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
         #
-        #   # bad
+        #   #### incorrect
         #   node.deep_fetch("foo")
         #
-        #   # good
+        #   #### correct
         #   node.read("foo")
         #
-        #   # bad
+        #   #### incorrect
         #   node.deep_fetch!("foo")
         #
-        #   # good
+        #   #### correct
         #   node.read!("foo")
         #
         class NodeDeepFetch < Base

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

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

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

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

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

@@ -24,10 +24,10 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   node.set_unless['foo'] = true
         #
-        #   # good
+        #   #### correct
         #   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
         #
-        #   # bad
+        #   #### incorrect
         #   node['foo']['bar'] = 1
         #   node['foo']['bar'] << 1
         #   node['foo']['bar'] += 1
         #   node['foo']['bar'] -= 1
         #
-        #   # good
+        #   #### correct
         #   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,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   ::Chef::PartialSearch.new.search((:node, 'role:web',
         #     keys: { 'name' => [ 'name' ],
         #             'ip' => [ 'ipaddress' ],
@@ -35,7 +35,7 @@ module RuboCop
         #     puts result['kernel_version']
         #   end
         #
-        #   # good
+        #   #### correct
         #   search(:node, 'role:web',
         #     filter_result: { 'name' => [ 'name' ],
         #                      'ip' => [ 'ipaddress' ],