cookstyle 7.7.2 → 7.8.0

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

@@ -23,12 +23,12 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   def action_create
         #    # :create action code here
         #   end
         #
-        #   # good
+        #   #### correct
         #   action :create do
         #    # :create action code here
         #   end

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

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   def initialize(*args)
         #     super
         #     @actions = [ :create, :add ]
@@ -35,7 +35,7 @@ module RuboCop
         #     @allowed_actions = [ :create, :add ]
         #   end
         #
-        #   # good
+        #   #### correct
         #   allowed_actions [ :create, :add ]
         #
         class AllowedActionsFromInitialize < Base

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

@@ -23,11 +23,11 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   include_recipe 'apt::default'
         #   include_recipe 'apt'
         #
-        #   # good
+        #   #### correct
         #   apt_update
         #
         class IncludingAptDefaultRecipe < Base

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

@@ -19,19 +19,17 @@ module RuboCop
   module Cop
     module Chef
       module Modernize
-        # Over the course of years there have been many different valid community site / Supermarket
-        # URLs to use in a cookbook's Berksfile. These old URLs continue to function via redirects,
-        # but should be updated to point to the latest Supermarket URL.
+        # There have been many different valid community site / Supermarket URLs to use in a cookbook's Berksfile. These old URLs continue to function via redirects, but should be updated to point to the latest Supermarket URL.
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   source 'http://community.opscode.com/api/v3'
         #   source 'https://supermarket.getchef.com'
         #   source 'https://api.berkshelf.com'
         #   site :opscode
         #
-        #   # good
+        #   #### correct
         #   source 'https://supermarket.chef.io'
         #
         class LegacyBerksfileSource < Base

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

@@ -23,12 +23,12 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   depends 'build-essential'
         #   include_recipe 'build-essential::default'
         #   include_recipe 'build-essential'
         #
-        #   # good
+        #   #### correct
         #   build_essential 'install compilation tools'
         #
         class UseBuildEssentialResource < Base

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

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   depends 'build-essential'
         #   depends 'chef_handler'
         #   depends 'chef_hostname'

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

@@ -24,7 +24,7 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   chef_gem 'nokogiri'
         #
         class ChefGemNokogiri < Base

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

@@ -23,12 +23,12 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   build_essential 'install build tools' do
         #    action :nothing
         #   end.run_action(:install)
         #
-        #   # good
+        #   #### correct
         #   build_essential 'install build tools' do
         #    compile_time true
         #   end

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

@@ -23,10 +23,10 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   only_if 'test -f /bin/foo'
         #
-        #   # good
+        #   #### correct
         #   only_if { ::File.exist?('bin/foo') }
         #
         class ConditionalUsingTest < Base

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

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   template '/etc/cron.d/backup' do
         #     source 'cron_backup_job.erb'
         #     owner 'root'
@@ -48,7 +48,7 @@ module RuboCop
         #     action :delete
         #   end
         #
-        #   # good
+        #   #### correct
         #   cron_d 'backup' do
         #     minute '1'
         #     hour '1'

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

@@ -19,14 +19,14 @@ module RuboCop
   module Cop
     module Chef
       module Modernize
-        # The cron_manage resource was renamed to cron_access in the 6.1 release of the cron
-        # cookbook, and later shipped in Chef Infra Client 14.4. The new resource name should
-        # be used.
+        # The cron_manage resource was renamed to cron_access in the 6.1 release of the cron cookbook, and later shipped in Chef Infra Client 14.4. The new resource name should be used.
         #
-        #   # bad
+        # @example
+        #
+        #   #### incorrect
         #   cron_manage 'mike'
         #
-        #   # good
+        #   #### correct
         #   cron_access 'mike'
         #
         class CronManageResource < Base

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

@@ -23,11 +23,11 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   plain_text_data = Chef::DataBagItem.load('foo', 'bar')
         #   encrypted_data = Chef::EncryptedDataBagItem.load('foo2', 'bar2')
         #
-        #   # good
+        #   #### correct
         #   plain_text_data = data_bag_item('foo', 'bar')
         #   encrypted_data = data_bag_item('foo2', 'bar2')
         #

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

@@ -23,19 +23,19 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   def initialize(*args)
         #     super
         #     @action = :create
         #   end
         #
-        #   # bad
+        #   #### incorrect
         #   def initialize(*args)
         #     super
         #     @default_action = :create
         #   end
         #
-        #  # good
+        #  #### correct
         #  default_action :create
 
         class DefaultActionFromInitialize < Base

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

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   if defined?(ChefSpec)
         #     def create_yum_repository(resource_name)
         #       ChefSpec::Matchers::ResourceMatcher.new(:yum_repository, :create, resource_name)

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

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

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

@@ -21,7 +21,9 @@ module RuboCop
       module Modernize
         # Chef Infra Client 12.4+ includes the Chef::DSL::Recipe in the resource and provider classed by default so there is no need to include this DSL in your resources or providers.
         #
-        #   # bad
+        # @example
+        #
+        #   #### incorrect
         #   include Chef::DSL::Recipe
         #   include Chef::DSL::IncludeRecipe
         #

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

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   def initialize(*args)
         #     super
         #   end

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

@@ -19,10 +19,11 @@ module RuboCop
   module Cop
     module Chef
       module Modernize
-        # Instead of using the execute resource to to run the `apt-get update` use Chef Infra Client's built-n
-        # apt_update resource which is available in Chef Infra Client 12.7 and later.
+        # Instead of using the execute resource to run the `apt-get update` use Chef Infra Client's built-n apt_update resource which is available in Chef Infra Client 12.7 and later.
         #
-        #   # bad
+        # @example
+        #
+        #   #### incorrect
         #   execute 'apt-get update'
         #
         #   execute 'Apt all the apt cache' do
@@ -33,7 +34,7 @@ module RuboCop
         #     notifies :run, 'execute[apt-get update]', :immediately
         #   end
         #
-        #   # good
+        #   #### correct
         #   apt_update
         #
         #   apt_update 'update apt cache'

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

@@ -19,15 +19,17 @@ module RuboCop
   module Cop
     module Chef
       module Modernize
-        # Chef Infra Client 14.0 and later includes :create, :delete, and :configure actions with the full idempotency of the windows_service resource. See the windows_service documentation at https://docs.chef.io/resource_windows_service.html for additional details on creating services with the windows_service resource.
+        # Chef Infra Client 14.0 and later includes :create, :delete, and :configure actions with the full idempotency of the windows_service resource. See the windows_service documentation at https://docs.chef.io/resources/windows_service for additional details on creating services with the windows_service resource.
         #
-        #   # bad
+        # @example
+        #
+        #   #### incorrect
         #   execute "Delete chef-client service" do
         #     command "sc.exe delete chef-client"
         #     action :run
         #   end
         #
-        #   # good
+        #   #### correct
         #   windows_service 'chef-client' do
         #     action :delete
         #   end
@@ -38,7 +40,7 @@ module RuboCop
 
           minimum_target_chef_version '14.0'
 
-          MSG = 'Chef Infra Client 14.0 and later includes :create, :delete, and :configure actions with the full idempotency of the windows_service resource. See the windows_service documentation at https://docs.chef.io/resource_windows_service.html for additional details on creating services with the windows_service resource'
+          MSG = 'Chef Infra Client 14.0 and later includes :create, :delete, and :configure actions with the full idempotency of the windows_service resource. See the windows_service documentation at https://docs.chef.io/resources/windows_service for additional details on creating services with the windows_service resource'
           RESTRICT_ON_SEND = [:execute].freeze
 
           # non block execute resources

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

@@ -21,7 +21,9 @@ module RuboCop
       module Modernize
         # Chef Infra Client 15.5 and later include a chef_sleep resource that should be used to sleep between executing resources if necessary instead of using the bash or execute resources to run the sleep command.
         #
-        #   # bad
+        # @example
+        #
+        #   #### incorrect
         #   execute "sleep 60" do
         #     command "sleep 60"
         #     action :run
@@ -33,7 +35,7 @@ module RuboCop
         #     code 'sleep 60'
         #   end
         #
-        #   # good
+        #   #### correct
         #   chef_sleep '60'
         #
         class ExecuteSleep < Cop

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