cookstyle 7.5.2 → 7.8.3

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

@@ -19,17 +19,16 @@ module RuboCop
   module Cop
     module Chef
       module Modernize
-        # Use the windows_feature resource built into Chef Infra Client 14+ instead of the powershell_script resource
-        # to run Install-WindowsFeature or Add-WindowsFeature
+        # Use the windows_feature resource built into Chef Infra Client 14+ instead of the powershell_script resource to run Install-WindowsFeature or Add-WindowsFeature
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   powershell_script 'Install Feature' do
         #     code 'Install-WindowsFeature -Name "Net-framework-Core"'
         #   end
         #
-        #  # good
+        #  #### correct
         #  windows_feature 'Net-framework-Core' do
         #    action :install
         #    install_method :windows_feature_powershell

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

@@ -23,10 +23,10 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   property :bob, String, name_attribute: true
         #
-        #   # good
+        #   #### correct
         #   property :bob, String, name_property: true
         #
         class PropertyWithNameAttribute < Base

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

@@ -23,13 +23,13 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   def initialize(*args)
         #     super
         #     @provides = :foo
         #   end
         #
-        #   # good
+        #   #### correct
         #   provides :foo
         #
         class ProvidesFromInitialize < Base

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

@@ -23,13 +23,13 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   def initialize(*args)
         #     super
         #     @resource_name = :foo
         #   end
         #
-        #  # good
+        #  #### correct
         #  resource_name :create
 
         class ResourceNameFromInitialize < Base

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

@@ -20,13 +20,11 @@ module RuboCop
   module Cop
     module Chef
       module Modernize
-        # set_or_return within a method should not be used to define property in a resource. Instead use
-        # the property method which properly validates and defines properties in a way that works with
-        # reporting and documentation functionality in Chef Infra Client
+        # set_or_return within a method should not be used to define property in a resource. Instead use the property method which properly validates and defines properties in a way that works with reporting and documentation functionality in Chef Infra Client
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #    def severity(arg = nil)
         #      set_or_return(
         #        :severity, arg,
@@ -35,7 +33,7 @@ module RuboCop
         #      )
         #    end
         #
-        #   # good
+        #   #### correct
         #   property :severity, String
         #
         class SetOrReturnInResources < Base

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

@@ -20,20 +20,18 @@ module RuboCop
   module Cop
     module Chef
       module Modernize
-        # In HWRPs and LWRPs you defined attributes, but custom resources changed the name to
-        # be properties to avoid confusion with chef recipe attributes. When writing a custom resource
-        # they should be called properties even though the two are aliased.
+        # In HWRPs and LWRPs you defined attributes, but custom resources changed the name to be properties to avoid confusion with chef recipe attributes. When writing a custom resource they should be called properties even though the two are aliased.
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   attribute :something, String
         #
         #   action :create do
         #     # some action code because we're in a custom resource
         #   end
         #
-        #   # good
+        #   #### correct
         #   property :something, String
         #
         #   action :create do

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

@@ -21,7 +21,9 @@ module RuboCop
       module Modernize
         # There is no need to check if the chef_gem resource supports compile_time as Chef Infra Client 12.1 and later support the compile_time property.
         #
-        #   # bad
+        # @example
+        #
+        #   #### incorrect
         #   chef_gem 'ultradns-sdk' do
         #     compile_time true if Chef::Resource::ChefGem.method_defined?(:compile_time)
         #     action :nothing
@@ -37,7 +39,7 @@ module RuboCop
         #     action :nothing
         #   end
         #
-        #   # good
+        #   #### correct
         #   chef_gem 'ultradns-sdk' do
         #     compile_time true
         #     action :nothing

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

@@ -19,12 +19,11 @@ module RuboCop
   module Cop
     module Chef
       module Modernize
-        # It is not longer necessary respond_to?(:foo) or defined?(foo) in metadata. This was used to support new metadata
-        # methods in Chef 11 and early versions of Chef 12.
+        # It is not longer necessary respond_to?(:foo) or defined?(foo) in metadata. This was used to support new metadata methods in Chef 11 and early versions of Chef 12.
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   chef_version '>= 13' if respond_to?(:chef_version)
         #   chef_version '>= 13' if defined?(chef_version)
         #   chef_version '>= 13' unless defined?(Ridley::Chef::Cookbook::Metadata)
@@ -32,7 +31,7 @@ module RuboCop
         #     chef_version '>= 13'
         #   end
         #
-        #   # good
+        #   #### correct
         #   chef_version '>= 13'
         #
         class RespondToInMetadata < Base

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

@@ -23,12 +23,12 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   provides :foo if respond_to?(:provides)
         #
         #   provides :foo if defined? provides
         #
-        #   # good
+        #   #### correct
         #   provides :foo
         #
         class RespondToProvides < Base

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

@@ -23,10 +23,10 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   resource_name :foo if respond_to?(:resource_name)
         #
-        #   # good
+        #   #### correct
         #   resource_name :foo
         #
         class RespondToResourceName < Base

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

@@ -19,15 +19,17 @@ module RuboCop
   module Cop
     module Chef
       module Modernize
-        # The sc_windows resource from the sc cookbook allowed for the creation of windows services on legacy Chef Infra Client releases. Chef Infra Client 14.0 and later includes :create, :delete, and :configure actions without the need for additional cookbook dependencies. 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.
+        # The sc_windows resource from the sc cookbook allowed for the creation of windows services on legacy Chef Infra Client releases. Chef Infra Client 14.0 and later includes :create, :delete, and :configure actions without the need for additional cookbook dependencies. 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
         #   sc_windows 'chef-client' do
         #     path "C:\\opscode\\chef\\bin"
         #     action :create
         #   end
         #
-        #   # good
+        #   #### correct
         #   windows_service 'chef-client' do
         #     action :create
         #     binary_path_name "C:\\opscode\\chef\\bin"
@@ -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 without the need for the sc cookbook dependency. See the windows_service documentation at https://docs.chef.io/resource_windows_service.html for additional details.'
+          MSG = 'Chef Infra Client 14.0 and later includes :create, :delete, and :configure actions without the need for the sc cookbook dependency. See the windows_service documentation at https://docs.chef.io/resources/windows_service for additional details.'
           RESTRICT_ON_SEND = [:sc_windows].freeze
 
           def on_send(node)

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

@@ -24,7 +24,7 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   seven_zip_archive "C:\file.zip" do
         #     path 'C:\expand_here'
         #   end

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

@@ -24,10 +24,10 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   Mixlib::ShellOut.new('foo').run_command
         #
-        #   # good
+        #   #### correct
         #   shell_out('foo')
         #
         class ShellOutHelper < Base

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

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   execute 'install package foo' do
         #     command "choco install --source=artifactory \"foo\" -y --no-progress --ignore-package-exit-codes"
         #   end

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

@@ -24,7 +24,7 @@ module RuboCop
         #
         # @example
         #
-        #  # bad
+        #  #### incorrect
         #    apt_repository 'atom-ppa' do
         #      uri 'http://ppa.launchpad.net/webupd8team/atom/ubuntu'
         #      components ['main']
@@ -32,7 +32,7 @@ module RuboCop
         #      key 'C2518248EEA14886'
         #    end
         #
-        #  # good
+        #  #### correct
         #    apt_repository 'atom-ppa' do
         #      uri 'ppa:webupd8team/atom'
         #      components ['main']

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

@@ -21,12 +21,14 @@ module RuboCop
       module Modernize
         # The sysctl_param resource was renamed to sysctl when it was added to Chef Infra Client 14.0. The new resource name should be used.
         #
-        #   # bad
+        # @example
+        #
+        #   #### incorrect
         #   sysctl_param 'fs.aio-max-nr' do
         #     value '1048576'
         #   end
         #
-        #   # good
+        #   #### correct
         #   sysctl 'fs.aio-max-nr' do
         #     value '1048576'
         #   end

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

@@ -24,7 +24,7 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   require 'mixlib/shellout'
         #
         class UnnecessaryMixlibShelloutRequire < Base

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

@@ -23,14 +23,14 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   %w(bmon htop vim curl).each do |pkg|
         #     package pkg do
         #       action :install
         #     end
         #   end
         #
-        #   # good
+        #   #### correct
         #   package %w(bmon htop vim curl)
         #
         class UseMultipackageInstalls < Base

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

@@ -23,10 +23,10 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   require File.expand_path('../../libraries/helpers', __FILE__)
         #
-        #   # good
+        #   #### correct
         #   require_relative '../libraries/helpers'
         #
         class UseRequireRelative < Base

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

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   def whyrun_supported?
         #    true
         #   end

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

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

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

@@ -21,7 +21,9 @@ module RuboCop
       module Modernize
         # Chef Infra Client 15.0 and later includes a windows_uac resource that should be used to set Windows UAC values instead of setting registry keys directly.
         #
-        #   # bad
+        # @example
+        #
+        #   #### incorrect
         #   registry_key 'HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\Policies\System' do
         #     values [{ name: 'EnableLUA', type: :dword, data: 0 },
         #             { name: 'PromptOnSecureDesktop', type: :dword, data: 0 },
@@ -30,7 +32,7 @@ module RuboCop
         #     action :create
         #   end
         #
-        #  # good
+        #  #### correct
         #  windows_uac 'Set Windows UAC settings' do
         #    enable_uac false
         #    prompt_on_secure_desktop true

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

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   windows_zipfile 'C:\\files\\' do
         #     source 'C:\\Temp\\file.zip'
         #   end

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

@@ -24,7 +24,7 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   zipfile "C:\file.zip" do
         #     path 'C:\expand_here'
         #   end

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

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   zypper_repo 'apache' do
         #     baseurl 'http://download.opensuse.org/repositories/Apache'
         #     path '/openSUSE_Leap_42.2'
@@ -31,7 +31,7 @@ module RuboCop
         #     priority '100'
         #   end
         #
-        #   # good
+        #   #### correct
         #   zypper_repository 'apache' do
         #     baseurl 'http://download.opensuse.org/repositories/Apache'
         #     path '/openSUSE_Leap_42.2'

data/lib/rubocop/cop/chef/redundant/apt_repository_distribution_default.rb

@@ -21,7 +21,9 @@ module RuboCop
       module RedundantCode
         # There is no need to pass `distribution node['lsb']['codename']` to an apt_repository resource as this is done automatically by the apt_repository resource.
         #
-        #   # bad
+        # @example
+        #
+        #   #### incorrect
         #   apt_repository 'my repo' do
         #     uri 'http://packages.example.com/debian'
         #     components %w(stable main)
@@ -29,7 +31,7 @@ module RuboCop
         #     distribution node['lsb']['codename']
         #   end
         #
-        #   # good
+        #   #### correct
         #   apt_repository 'my repo' do
         #     uri 'http://packages.example.com/debian'
         #     components %w(stable main)

data/lib/rubocop/cop/chef/redundant/apt_repository_notifies_apt_update.rb

@@ -21,7 +21,9 @@ module RuboCop
       module RedundantCode
         # There is no need to notify an apt-get update when an apt_repository is created as this is done automatically by the apt_repository resource.
         #
-        #   # bad
+        # @example
+        #
+        #   #### incorrect
         #   apt_repository 'my repo' do
         #     uri 'http://packages.example.com/debian'
         #     components %w(stable main)
@@ -29,7 +31,7 @@ module RuboCop
         #     notifies :run, 'execute[apt-get update]', :immediately
         #   end
         #
-        #   # good
+        #   #### correct
         #   apt_repository 'my repo' do
         #     uri 'http://packages.example.com/debian'
         #     components %w(stable main)