cookstyle 7.7.2 → 7.8.0

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

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   partial_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' ],

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

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

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

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

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

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

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

@@ -23,12 +23,12 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   def provides?
         #    true
         #   end
         #
-        #   # good
+        #   #### correct
         #   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
         #
-        #   # bad
+        #   #### incorrect
         #   my_resource = MyResource.dsl_name
         #
-        #   # good
+        #   #### correct
         #   my_resource = MyResource.resource_name
         #
         class ResourceUsesDslNameMethod < Base

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

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

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

@@ -19,16 +19,16 @@ module RuboCop
   module Cop
     module Chef
       module Deprecations
-        # Don't call the deprecated updated= method in a resource to set the resource to updated. This method was removed from Chef Infra Client 13 and this will now cause an error. Instead wrap code that updated the state of the node in a converge_by block. Documentation on using the converge_by block can be found at https://docs.chef.io/custom_resources.html.
+        # Don't call the deprecated `updated=` method in a resource to set the resource to updated. This method was removed from Chef Infra Client 13 and this will now cause an error. Instead wrap code that updated the state of the node in a `converge_by` block. Documentation on using the `converge_by` block can be found at https://docs.chef.io/custom_resources/.
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   action :foo do
         #     updated = true
         #   end
         #
-        #   # good
+        #   #### correct
         #   action :foo do
         #     converge_by('resource did something) do
         #       # code that causes the resource to converge

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

@@ -24,11 +24,11 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   shell_out!('hostnamectl status', { returns: [0, 1] })
         #   shell_out('hostnamectl status', { returns: [0, 1] })
         #
-        #   # good
+        #   #### correct
         #   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

@@ -24,7 +24,7 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   ruby_block 'my special ruby block' do
         #     block do
         #       puts 'running'
@@ -32,7 +32,7 @@ module RuboCop
         #     action :create
         #   end
         #
-        #   # good
+        #   #### correct
         #   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
         #
-        #   # bad
+        #   #### incorrect
         #   require 'chef/mixin/command'
         #   include Chef::Mixin::Command
         #
         #   run_command('/bin/foo')
         #   run_command_with_systems_locale('/bin/foo')
         #
-        #   # good
+        #   #### correct
         #   shell_out!('/bin/foo')
         #
         class UsesRunCommandHelper < Base

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

@@ -23,12 +23,12 @@ module RuboCop
         #
         # @example
         #
-        # bad:
+        #### incorrect:
         #  search(:node, '*:*', 0, 1000, { :ip_address => ["ipaddress"] })
         #  search(:node, '*:*', 0, 1000)
         #  search(:node, '*:*', 0)
 
-        # good
+        #### correct
         #
         # query(:node, '*:*')
         #  search(:node, '*:*', start: 0, rows: 1000, filter_result: { :ip_address => ["ipaddress"] })

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

@@ -24,7 +24,7 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   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
         #
-        #   # bad
+        #   #### incorrect
         #   {"foo" => "bar"}.to_yaml
         #
-        #   # good
+        #   #### correct
         #   YAML.dump({"foo" => "bar"})
         #
         class UseYamlDump < Base

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

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   user "betty" do
         #     supports({
         #       manage_home: true,
@@ -35,7 +35,7 @@ module RuboCop
         #     supports :manage_home => true
         #   end
         #
-        #   # good
+        #   #### correct
         #   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
         #
-        #   # bad
+        #   #### incorrect
         #   file '/etc/nginx.conf' do
         #     verify 'nginx -t -c %{file}'
         #   end
         #
-        #   # good
+        #   #### correct
         #   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
         #
-        #   # bad
+        #   #### incorrect
         #   windows_feature 'DHCP' do
         #     install_method :servermanagercmd
         #   end
         #
-        #   # good
+        #   #### correct
         #   windows_feature 'DHCP' do
         #     install_method :windows_feature_dism
         #   end

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

@@ -24,14 +24,14 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   windows_package 'AppveyorDeploymentAgent' do
         #     source 'https://www.example.com/appveyor.msi'
         #     installer_type 'msi'
         #     options "/quiet /qn /norestart /log install.log"
         #   end
         #
-        #   # good
+        #   #### correct
         #   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

@@ -24,7 +24,7 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   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
         #
-        #   # good
+        #   #### correct
         #   windows_task 'chef ad-join leave start time' do
         #     task_name 'chef ad-join leave'
         #     start_day '06/09/2016'

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

@@ -23,13 +23,13 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   Windows::VersionHelper.nt_version
         #   Windows::VersionHelper.server_version?
         #   Windows::VersionHelper.core_version?
         #   Windows::VersionHelper.workstation_version?
         #
-        #   # good
+        #   #### correct
         #   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
         #
-        #   # bad
+        #   #### incorrect
         #   include_recipe 'xml::ruby'
         #
         class IncludingXMLRubyRecipe < Base

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

@@ -24,7 +24,7 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   include_recipe 'yum::dnf_yum_compat'
         #
         class IncludingYumDNFCompatRecipe < Base

data/lib/rubocop/cop/chef/effortless/chef_vault_used.rb

@@ -24,22 +24,22 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   require 'chef-vault'
         #
-        #   # bad
+        #   #### incorrect
         #   ChefVault::Item
         #
-        #   # bad
+        #   #### incorrect
         #   include_recipe 'chef-vault'
         #
-        #   # bad
+        #   #### incorrect
         #   chef_gem 'chef-vault'
         #
-        #   # bad
+        #   #### incorrect
         #   chef_vault_item_for_environment(arg, arg1)
         #
-        #   # bad
+        #   #### incorrect
         #   chef_vault_item(arg, arg1)
         #
 

data/lib/rubocop/cop/chef/effortless/data_bags.rb

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   data_bag_item('admins', login)
         #   data_bag(data_bag_name)
         class CookbookUsesDatabags < Base

data/lib/rubocop/cop/chef/effortless/depends_chef_vault.rb

@@ -24,7 +24,7 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   depends 'chef-vault'
         #
 

data/lib/rubocop/cop/chef/effortless/node_environment.rb

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   node.environment == "production"
         #   node.chef_environment == "production"
         #

data/lib/rubocop/cop/chef/effortless/node_policygroup.rb

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   node.policy_group == "foo"
         #
         class CookbookUsesPolicygroups < Base

data/lib/rubocop/cop/chef/effortless/node_roles.rb

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   node.role?('web_server')
         #   node.roles.include?('web_server')
         #

data/lib/rubocop/cop/chef/effortless/search_for_environments_or_roles.rb

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   search(:node, 'chef_environment:foo')
         #   search(:node, 'role:bar')
         #

data/lib/rubocop/cop/chef/effortless/search_used.rb

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   search(:node, 'run_list:recipe\[bacula\:\:server\]')
         #
         class CookbookUsesSearch < Base