cookstyle 7.7.2 → 7.10.1

data/lib/rubocop/cop/chef/correctness/invalid_platform_values_in_case.rb

@@ -19,11 +19,11 @@ module RuboCop
   module Cop
     module Chef
       module Correctness
-        # Use valid platform values in case statements.
+        # Use valid platform values in case statements. See [Infra Language: Platform](https://docs.chef.io/infra_language/checking_platforms/#platform-values) for a list of many common platform values.
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   case node['platform']
         #   when 'rhel'
         #     puts "I'm on a Red Hat system!"

data/lib/rubocop/cop/chef/correctness/invalid_value_for_platform_family_helper.rb

@@ -19,17 +19,17 @@ module RuboCop
   module Cop
     module Chef
       module Correctness
-        # Pass valid platforms families to the value_for_platform_family helper.
+        # Pass valid platforms families to the value_for_platform_family helper. See [Infra Language: Platform Family](https://docs.chef.io/infra_language/checking_platforms/#platform_family-values) for a complete list of platform families.
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   value_for_platform_family(
         #     %w(rhel sles) => 'foo',
         #     %w(mac) => 'foo'
         #   )
         #
-        #   # good
+        #   #### correct
         #   value_for_platform_family(
         #     %w(rhel suse) => 'foo',
         #     %w(mac_os_x) => 'foo'

data/lib/rubocop/cop/chef/correctness/invalid_value_for_platform_helper.rb

@@ -19,16 +19,16 @@ module RuboCop
   module Cop
     module Chef
       module Correctness
-        # Pass valid platforms to the value_for_platform helper.
+        # Pass valid platforms to the value_for_platform helper. See [Infra Language: Platform](https://docs.chef.io/infra_language/checking_platforms/#platform-values) for a list of many common platform values.
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   value_for_platform(
         #     %w(rhel mac_os_x_server) => { 'default' => 'foo' },
         #     %w(sles) => { 'default' => 'bar' }
         #   )
-        #   # good
+        #   #### correct
         #   value_for_platform(
         #     %w(redhat mac_os_x) => { 'default' => 'foo' },
         #     %w(opensuseleap) => { 'default' => 'bar' }

data/lib/rubocop/cop/chef/correctness/invalid_version_metadata.rb

@@ -24,10 +24,10 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   version '1.2.3.4'
         #
-        #   # good
+        #   #### correct
         #   version '1.2.3'
         #
         class InvalidVersionMetadata < Base

data/lib/rubocop/cop/chef/correctness/lazy_eval_node_attribute_defaults.rb

@@ -24,10 +24,10 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   property :Something, String, default: node['hostname']
         #
-        #   # good
+        #   #### correct
         #   property :Something, String, default: lazy { node['hostname'] }
         #
         class LazyEvalNodeAttributeDefaults < Base

data/lib/rubocop/cop/chef/correctness/lazy_in_resource_guard.rb

@@ -23,14 +23,14 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   template '/etc/foo' do
         #     mode '0644'
         #     source 'foo.erb'
         #     only_if { lazy { ::File.exist?('/etc/foo')} }
         #   end
         #
-        #   # good
+        #   #### correct
         #   template '/etc/foo' do
         #     mode '0644'
         #     source 'foo.erb'

data/lib/rubocop/cop/chef/correctness/macos_userdefaults_invalid_type.rb

@@ -23,14 +23,14 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   macos_userdefaults 'set a value' do
         #     global true
         #     key 'key'
         #     type 'boolean'
         #   end
         #
-        #   # good
+        #   #### correct
         #   macos_userdefaults 'set a value' do
         #     global true
         #     key 'key'

data/lib/rubocop/cop/chef/correctness/malformed_value_for_platform.rb

@@ -23,12 +23,12 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   value_for_platform(
         #     %w(redhat oracle) => 'baz'
         #   )
         #
-        #   # good
+        #   #### correct
         #   value_for_platform(
         #     %w(redhat oracle) => {
         #       '5' => 'foo',

data/lib/rubocop/cop/chef/correctness/metadata_missing_name.rb

@@ -23,7 +23,7 @@ module RuboCop
       #
       # @example
       #
-      #   # good
+      #   #### correct
       #   name 'foo'
       #
       module Correctness

data/lib/rubocop/cop/chef/correctness/node_normal.rb

@@ -28,10 +28,10 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   node.normal['foo'] = true
         #
-        #   # good
+        #   #### correct
         #   node.default['foo'] = true
         #   node.override['foo'] = true
         #   node.force_default['foo'] = true

data/lib/rubocop/cop/chef/correctness/node_normal_unless.rb

@@ -28,10 +28,10 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   node.normal_unless['foo'] = true
         #
-        #   # good
+        #   #### correct
         #   node.default_unless['foo'] = true
         #   node.override_unless['foo'] = true
         #   node.force_default_unless['foo'] = true

data/lib/rubocop/cop/chef/correctness/node_save.rb

@@ -25,7 +25,7 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   node.save
         #
         class CookbookUsesNodeSave < Base

data/lib/rubocop/cop/chef/correctness/notifies_action_not_symbol.rb

@@ -24,7 +24,7 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   execute 'some command' do
         #     notifies 'restart', 'service[httpd]', 'delayed'
         #   end
@@ -33,7 +33,7 @@ module RuboCop
         #     subscribes 'restart', 'service[httpd]', 'delayed'
         #   end
         #
-        #   # good
+        #   #### correct
         #   execute 'some command' do
         #     notifies :restart, 'service[httpd]', 'delayed'
         #   end

data/lib/rubocop/cop/chef/correctness/octal_mode_as_string.rb

@@ -23,12 +23,12 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   file '/etc/some_file' do
         #     mode '0o755'
         #   end
         #
-        #   # good
+        #   #### correct
         #   file '/etc/some_file' do
         #     mode '0755'
         #   end

data/lib/rubocop/cop/chef/correctness/openssl_password_helpers.rb

@@ -21,7 +21,7 @@ module RuboCop
       module Correctness
         # The openSSL cookbook provides a deprecated `secure_password` helper in the `Opscode::OpenSSL::Password` class, which should not longer be used. This helper would generate a random password that would be used when a data bag or attribute was no present. The practice of generating passwords to be stored on the node is bad security as it exposes the password to anyone that can view the nodes, and deleting a node deletes the password. Passwords should be retrieved from a secure source for use in cookbooks.
         #
-        #   # bad
+        #   #### incorrect
         #   ::Chef::Recipe.send(:include, Opscode::OpenSSL::Password)
         #   basic_auth_password = secure_password
         #

data/lib/rubocop/cop/chef/correctness/powershell_delete_file.rb

@@ -23,13 +23,13 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   powershell_script 'Cleanup old files' do
         #     code 'Remove-Item C:\Windows\foo\bar.txt'
         #     only_if { ::File.exist?('C:\\Windows\\foo\\bar.txt') }
         #   end
         #
-        #  # good
+        #  #### correct
         #  file 'C:\Windows\foo\bar.txt' do
         #    action :delete
         #  end

data/lib/rubocop/cop/chef/correctness/property_without_type.rb

@@ -23,11 +23,11 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   property :size, regex: /^\d+[KMGTP]$/
         #   attribute :size, regex: /^\d+[KMGTP]$/
         #
-        #   # good
+        #   #### correct
         #   property :size, String, regex: /^\d+[KMGTP]$/
         #   attribute :size, kind_of: String, regex: /^\d+[KMGTP]$/
         #

data/lib/rubocop/cop/chef/correctness/resource_sets_internal_properties.rb

@@ -25,13 +25,13 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   service 'foo' do
         #     running true
         #     action [:start, :enable]
         #   end
         #
-        #   # good
+        #   #### correct
         #   service 'foo' do
         #     action [:start, :enable]
         #   end

data/lib/rubocop/cop/chef/correctness/resource_sets_name_property.rb

@@ -20,17 +20,16 @@ module RuboCop
   module Cop
     module Chef
       module Correctness
-        # Use name properties instead of setting the name property in a resource. Setting the name property
-        # directly causes notification and reporting issues.
+        # Use name properties instead of setting the name property in a resource. Setting the name property directly causes notification and reporting issues.
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   service 'foo' do
         #    name 'bar'
         #   end
         #
-        #   # good
+        #   #### correct
         #   service 'foo' do
         #    service_name 'bar'
         #   end

data/lib/rubocop/cop/chef/correctness/resource_with_none_action.rb

@@ -24,12 +24,12 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   service 'foo' do
         #    action :none
         #   end
         #
-        #   # good
+        #   #### correct
         #   service 'foo' do
         #    action :nothing
         #   end

data/lib/rubocop/cop/chef/correctness/scoped_file_exist.rb

@@ -23,10 +23,10 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   not_if { File.exist?('/etc/foo/bar') }
         #
-        #   # good
+        #   #### correct
         #   not_if { ::File.exist?('/etc/foo/bar') }
         #
         class ScopedFileExist < Base

data/lib/rubocop/cop/chef/correctness/service_resource.rb

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example when command starts a service
         #
-        #   # bad
+        #   #### incorrect
         #   command "/etc/init.d/mysql start"
         #   command "/sbin/service/memcached start"
         #

data/lib/rubocop/cop/chef/correctness/supports_must_be_float.rb

@@ -24,10 +24,10 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   supports 'redhat', '> 8'
         #
-        #   # good
+        #   #### correct
         #   supports 'redhat', '> 8.0'
         #
         class SupportsMustBeFloat < Base

data/lib/rubocop/cop/chef/correctness/tmp_path.rb

@@ -23,13 +23,12 @@ module RuboCop
         #
         # @example downloading a large file into /tmp/
         #
-        #   # bad
+        #   #### incorrect
         #   remote_file '/tmp/large-file.tar.gz' do
         #
-        #   # good
+        #   #### correct
         #   remote_file "#{Chef::Config[:file_cache_path]}/large-file.tar.gz" do
         #
-        #
         class TmpPath < Base
           MSG = 'Use file_cache_path rather than hard-coding tmp paths'
           RESTRICT_ON_SEND = [:remote_file].freeze

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

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   module MyCookbook
         #     class MyCookbookService < Chef::Resource
         #       use_automatic_resource_name

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

@@ -23,11 +23,11 @@ module RuboCop
       #
       # @example
       #
-      #   # bad
+      #   #### incorrect
       #   name 'foo'
       #   depends 'foo'
       #
-      #   # good
+      #   #### correct
       #   name 'foo'
       #
       module Deprecations

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

@@ -24,7 +24,7 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   include_recipe 'chef_handler'
         #   include_recipe 'chef_handler::default'
         #

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

@@ -24,12 +24,12 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   chef_handler 'whatever' do
         #     supports start: true, report: true, exception: true
         #   end0
         #
-        #   # good
+        #   #### correct
         #   chef_handler 'whatever' do
         #     type start: true, report: true, exception: true
         #   end

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

@@ -24,7 +24,7 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   require 'chef/rest'
         #   Chef::REST::RESTRequest.new(:GET, FOO, nil).call
         #

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

@@ -26,12 +26,12 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   include Chef::ShellOut
         #   require 'chef/shellout'
         #   Chef::ShellOut.new('some_command')
         #
-        #   # good
+        #   #### correct
         #   include Mixlib::ShellOut
         #   require 'mixlib/shellout'
         #   Mixlib::ShellOut.new('some_command')