cookstyle 7.7.2 → 7.8.0

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)

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

@@ -24,7 +24,7 @@ module RuboCop
         #
         # @example
         #
-        #   # bad in metadata.rb:
+        #   #### incorrect in metadata.rb:
         #
         #    attribute 'zookeeper_bridge/server',
         #              display_name: 'zookeeper server',

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

@@ -24,7 +24,7 @@ module RuboCop
         #
         # @example
         #
-        #   # bad in metadata.rb:
+        #   #### incorrect in metadata.rb:
         #
         #   conflicts "another_cookbook"
         #

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

@@ -24,7 +24,7 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   allowed_actions [:create, :remove]
         #
         #   # also bad

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

@@ -21,13 +21,15 @@ module RuboCop
       module RedundantCode
         # If a resource includes the `compile_time` property there's no need to also use `.run_action(:some_action)` on the resource block
         #
-        #   # bad
+        # @example
+        #
+        #   #### incorrect
         #   chef_gem 'deep_merge' do
         #     action :nothing
         #     compile_time true
         #   end.run_action(:install)
         #
-        #   # good
+        #   #### correct
         #   chef_gem 'deep_merge' do
         #     action :install
         #     compile_time true

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

@@ -24,7 +24,7 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   grouping 'windows_log_rotate', title: 'Demonstration cookbook with code to switch loggers'
         #
         class GroupingMetadata < Base

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

@@ -24,7 +24,7 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   long_description 'this is my cookbook and this description will never be seen'
         #
         class LongDescriptionMetadata < Base

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

@@ -24,11 +24,11 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   platform?('redhat') || platform?('ubuntu')
         #   platform_family?('debian') || platform_family?('rhel')
         #
-        #   # good
+        #   #### correct
         #   platform?('redhat', 'ubuntu')
         #   platform_family?('debian', 'rhel')
         #

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

@@ -51,12 +51,11 @@ module RuboCop
         #
         # @example
         #
-        #
-        #   # bad
+        #   #### incorrect
         #   property :config_file, String, required: true, name_property: true
         #   attribute :config_file, String, required: true, name_attribute: true
         #
-        #   # good
+        #   #### correct
         #   property :config_file, String, required: true
         #
         class NamePropertyIsRequired < Base

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

@@ -24,7 +24,7 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   node['platform'].to_s
         #   node['platform_family'].to_s
         #   node['platform_version'].to_s
@@ -33,7 +33,7 @@ module RuboCop
         #   node['os'].to_s
         #   node['name'].to_s
         #
-        #   # good
+        #   #### correct
         #   node['platform']
         #   node['platform_family']
         #   node['platform_version']

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

@@ -23,11 +23,11 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   property :config_file, String, regex: /.*/
         #   attribute :config_file, String, regex: /.*/
         #
-        #   # good
+        #   #### correct
         #   property :config_file, String
         #   attribute :config_file, String
         #

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

@@ -26,10 +26,10 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   property :bob, String, required: true, default: 'foo'
         #
-        #   # good
+        #   #### correct
         #   property :bob, String, required: true
         #
         class PropertyWithRequiredAndDefault < Base

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

@@ -24,7 +24,7 @@ module RuboCop
         #
         # @example
         #
-        #   # bad in metadata.rb:
+        #   #### incorrect in metadata.rb:
         #
         #   provides "some_thing"
         #

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

@@ -24,7 +24,7 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   recipe 'openldap::default', 'Install and configure OpenLDAP'
         #
         #

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

@@ -24,7 +24,7 @@ module RuboCop
         #
         # @example
         #
-        #   # bad in metadata.rb:
+        #   #### incorrect in metadata.rb:
         #
         #   replaces "another_cookbook"
         #

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

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   action :nothing
         #     # let's do nothing
         #   end

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

@@ -21,7 +21,9 @@ module RuboCop
       module RedundantCode
         # Every Chef Infra resource already includes a sensitive property with a default value of false.
         #
-        # # bad
+        # @example
+        #
+        # #### incorrect
         # property :sensitive, [true, false], default: false
         #
         class SensitivePropertyInResource < Base

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

@@ -23,11 +23,11 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   property :config_file, String, default: nil
         #   property :config_file, [String, NilClass], default: nil
         #
-        #   # good
+        #   #### correct
         #   property :config_file, String
         #   property :config_file, [String, NilClass]
         #

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

@@ -24,7 +24,7 @@ module RuboCop
         #
         # @example
         #
-        #   # bad in metadata.rb:
+        #   #### incorrect in metadata.rb:
         #
         #   suggests "another_cookbook"
         #

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

@@ -23,11 +23,11 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   property :foo, String, desired_state: true
         #   attribute :foo, String, desired_state: true
         #
-        #   # good
+        #   #### correct
         #   property :foo, String
         #   attribute :foo, String
         #

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

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   property :name, String
         #   property :name, String, name_property: true
         #   attribute :name, kind_of: String