cookstyle 7.9.0 → 7.12.2

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

@@ -19,9 +19,7 @@ module RuboCop
   module Cop
     module Chef
       module Correctness
-        # Don't use node.save to save partial node data to the Chef Infra Server mid-run unless it's
-        # absolutely necessary. Node.save can result in failed Chef Infra runs appearing in search and
-        # increases load on the Chef Infra Server."
+        # Don't use node.save to save partial node data to the Chef Infra Server mid-run unless it's a requirement of cookbook design that can't be avoided. Node.save can result in failed Chef Infra runs appearing in search and increases load on the Chef Infra Server."
         #
         # @example
         #

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

@@ -15,12 +15,11 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-
 module RuboCop
   module Cop
     module Chef
       module Correctness
-        # When notifying or subscribing an action within a resource the action should always be a symbol. In Chef Infra Client releases before 14.0 this may result in double notification.
+        # When notifying or subscribing actions within a resource the action should always be a symbol. In Chef Infra Client releases before 14.0, this may result in double notification.
         #
         # @example
         #

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

@@ -19,7 +19,7 @@ module RuboCop
   module Cop
     module Chef
       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.
+        # The OpenSSL cookbook provides a deprecated `secure_password` helper in the `Opscode::OpenSSL::Password` class, which should no 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.
         #
         #   #### incorrect
         #   ::Chef::Recipe.send(:include, Opscode::OpenSSL::Password)

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

@@ -19,9 +19,7 @@ module RuboCop
   module Cop
     module Chef
       module Correctness
-        # Chef Infra Client uses properties in several resources to track state. These
-        # should not be set in recipes as they break the internal workings of the Chef
-        # Infra Client
+        # Chef Infra Client uses properties in several resources to track state. These should not be set in recipes as they break the internal workings of the Chef Infra Client
         #
         # @example
         #

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

@@ -15,7 +15,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-
 module RuboCop
   module Cop
     module Chef

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

@@ -15,7 +15,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-
 module RuboCop
   module Cop
     module Chef

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

@@ -19,7 +19,7 @@ module RuboCop
   module Cop
     module Chef
       module Correctness
-        # Scope file exist to access the correct File class by using ::File.exist? not File.exist?.
+        # Scope file exist to access the correct `File` class by using `::File.exist?` not `File.exist?`.
         #
         # @example
         #

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

@@ -14,7 +14,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-
 module RuboCop
   module Cop
     module Chef

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

@@ -15,7 +15,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-
 module RuboCop
   module Cop
     module Chef

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

@@ -14,12 +14,11 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-
 module RuboCop
   module Cop
     module Chef
       module Correctness
-        # Use file_cache_path rather than hard-coding tmp paths
+        # Use file_cache_path rather than hard-coding system temp paths
         #
         # @example downloading a large file into /tmp/
         #

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

@@ -15,22 +15,21 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-
 module RuboCop
   module Cop
     module Chef
-      # Make sure a cookbook doesn't depend on itself. This will fail on Chef Infra Client 13+
-      #
-      # @example
-      #
-      #   #### incorrect
-      #   name 'foo'
-      #   depends 'foo'
-      #
-      #   #### correct
-      #   name 'foo'
-      #
       module Deprecations
+        # Make sure a cookbook doesn't depend on itself. This will fail on Chef Infra Client 13+
+        #
+        # @example
+        #
+        #   #### incorrect
+        #   name 'foo'
+        #   depends 'foo'
+        #
+        #   #### correct
+        #   name 'foo'
+        #
         class CookbooksDependsOnSelf < Base
           extend AutoCorrector
           include RangeHelp

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

@@ -15,12 +15,11 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-
 module RuboCop
   module Cop
     module Chef
       module Deprecations
-        # There is no need to include the empty and deprecated chef_handler::default recipe in order to use the chef_handler resource
+        # There is no need to include the empty and deprecated chef_handler::default recipe to use the chef_handler resource
         #
         # @example
         #
@@ -32,7 +31,7 @@ module RuboCop
           include RangeHelp
           extend AutoCorrector
 
-          MSG = 'There is no need to include the empty and deprecated chef_handler::default recipe in order to use the chef_handler resource'
+          MSG = 'There is no need to include the empty and deprecated chef_handler::default recipe to use the chef_handler resource'
           RESTRICT_ON_SEND = [:include_recipe].freeze
 
           def_node_matcher :chef_handler_recipe?, <<-PATTERN

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

@@ -15,12 +15,11 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-
 module RuboCop
   module Cop
     module Chef
       module Deprecations
-        # Use the type property instead of the deprecated supports property in the chef_handler resource. The supports property was removed in chef_handler cookbook version 3.0 (June 2017) and Chef Infra Client 14.0.
+        # Use the type `property` instead of the deprecated `supports` property in the `chef_handler` resource. The `supports` property was removed in `chef_handler` cookbook version 3.0 (June 2017) and Chef Infra Client 14.0.
         #
         # @example
         #

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

@@ -15,12 +15,11 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-
 module RuboCop
   module Cop
     module Chef
       module Deprecations
-        # Chef::REST was removed in Chef Infra Client 13.
+        # The `Chef::REST` class was removed in Chef Infra Client 13.
         #
         # @example
         #

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

@@ -15,12 +15,11 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-
 module RuboCop
   module Cop
     module Chef
       module Deprecations
-        # Use delete_resource / edit_resource introduced in Chef Infra Client 12.10 instead of functionality in the deprecated chef-rewind gem
+        # Use `delete_resource` or `edit_resource` helpers introduced in Chef Infra Client 12.10 instead of functionality in the deprecated `chef-rewind` gem
         #
         # @example
         #
@@ -48,7 +47,7 @@ module RuboCop
             unwind: 'delete_resource',
           }.freeze
 
-          MSG = 'Use delete_resource / edit_resource introduced in Chef Infra Client 12.10 instead of functionality in the deprecated chef-rewind gem'
+          MSG = 'Use delete_resource or edit_resource helpers introduced in Chef Infra Client 12.10 instead of functionality in the deprecated chef-rewind gem'
           RESTRICT_ON_SEND = [:chef_gem, :require, :rewind, :unwind].freeze
 
           def_node_matcher :rewind_gem_install?, <<-PATTERN

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

@@ -15,14 +15,11 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-
 module RuboCop
   module Cop
     module Chef
       module Deprecations
-        # Don't use deprecated Chef::ShellOut which was removed in Chef Infra Client 13.
-        # Use Mixlib::ShellOut instead, which behaves identically or convert to the shell_out
-        # helper provided in chef-utils.
+        # Don't use the deprecated `Chef::ShellOut` class which was removed in Chef Infra Client 13. Use the `Mixlib::ShellOut` class instead, which behaves identically or convert to the simpler `shell_out` helper.
         #
         # @example
         #
@@ -40,7 +37,7 @@ module RuboCop
           include RangeHelp
           extend AutoCorrector
 
-          MSG = "Don't use deprecated Chef::ShellOut which was removed in Chef Infra Client 13. Use Mixlib::ShellOut instead, which behaves identically."
+          MSG = "Don't use the deprecated `Chef::ShellOut` class which was removed in Chef Infra Client 13. Use the `Mixlib::ShellOut` class instead, which behaves identically."
           RESTRICT_ON_SEND = [:new, :require, :include].freeze
 
           def_node_matcher :include_shellout?, <<-PATTERN

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

@@ -15,33 +15,32 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-
 module RuboCop
   module Cop
     module Chef
-      # Do not use legacy chef-sugar helper methods, which will not be moved into Chef Infra Client itself. For a complete set of chef-sugar helpers now shipping in Chef Infra Client itself see https://github.com/chef/chef/tree/master/chef-utils#getting-started
-      #
-      # @example
-      #
-      #   #### incorrect
-      #   vagrant_key?
-      #   vagrant_domain?
-      #   vagrant_user?
-      #   require_chef_gem
-      #   best_ip_for(node)
-      #   nexus?
-      #   ios_xr?
-      #   ruby_20?
-      #   ruby_19?
-      #   includes_recipe?('foo::bar')
-      #   wrlinux?
-      #   dev_null
-      #   nexentacore_platform?
-      #   opensolaris_platform?
-      #   nexentacore?
-      #   opensolaris?
-      #
       module Deprecations
+        # Do not use legacy chef-sugar helper methods, which will not be moved into Chef Infra Client itself. For a complete set of chef-sugar helpers now shipping in Chef Infra Client itself see https://github.com/chef/chef/tree/master/chef-utils#getting-started
+        #
+        # @example
+        #
+        #   #### incorrect
+        #   vagrant_key?
+        #   vagrant_domain?
+        #   vagrant_user?
+        #   require_chef_gem
+        #   best_ip_for(node)
+        #   nexus?
+        #   ios_xr?
+        #   ruby_20?
+        #   ruby_19?
+        #   includes_recipe?('foo::bar')
+        #   wrlinux?
+        #   dev_null
+        #   nexentacore_platform?
+        #   opensolaris_platform?
+        #   nexentacore?
+        #   opensolaris?
+        #
         class ChefSugarHelpers < Base
           MSG = 'Do not use legacy chef-sugar helper methods, which will not be moved into Chef Infra Client itself. For a complete set of chef-sugar helpers now shipping in Chef Infra Client itself see https://github.com/chef/chef/tree/master/chef-utils#getting-started'
           RESTRICT_ON_SEND = [:vagrant_key?, :vagrant_domain?, :vagrant_user?, :require_chef_gem, :best_ip_for, :nexus?, :ios_xr?, :ruby_20?, :ruby_19?, :includes_recipe?, :wrlinux?, :dev_null, :nexentacore_platform?, :opensolaris_platform?, :nexentacore?, :opensolaris?].freeze

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

@@ -15,12 +15,11 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-
 module RuboCop
   module Cop
     module Chef
       module Deprecations
-        # Chef Workstation 0.8 and later renamed the ChefDK module used when writing custom cookbook generators from ChefDK to ChefCLI. For compatibility with the latest Chef Workstation releases you'll need to reference the new class names.
+        # Chef Workstation 0.8 and later renamed the `ChefDK` module used when writing custom cookbook generators from `ChefDK` to `ChefCLI`. For compatibility with the latest Chef Workstation releases you'll need to reference the new class names.
         #
         # @example
         #

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

@@ -15,13 +15,12 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-
 module RuboCop
   module Cop
     module Chef
-      # The Librarian-Chef depsolving project is no longer maintained and a Cheffile should not be used for cookbook depsolving. Consider using Policyfiles instead. If the Policyfiles model is not compatible with your workflow you may find Berkshelf offers a more similar, and still supported, experience to Librarian-Chef.
-      #
       module Deprecations
+        # The Librarian-Chef depsolving project is no longer maintained and a Cheffile should not be used for cookbook depsolving. Consider using Policyfiles instead. If the Policyfiles model is not compatible with your workflow you may find Berkshelf offers a more similar, and still supported, experience to Librarian-Chef.
+        #
         class Cheffile < Base
           include RangeHelp
 

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

@@ -15,7 +15,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-
 module RuboCop
   module Cop
     module Chef

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

@@ -15,12 +15,11 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-
 module RuboCop
   module Cop
     module Chef
       module Deprecations
-        # Use ChefSpec::SoloRunner or ChefSpec::ServerRunner instead of the deprecated ChefSpec::Runner. These new runners were introduced in ChefSpec 4.1 (Oct 2014).
+        # Use `ChefSpec::SoloRunner` or `ChefSpec::ServerRunner` instead of the deprecated `ChefSpec::Runner`. These new runners were introduced in ChefSpec 4.1 (Oct 2014).
         #
         # @example
         #

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

@@ -15,12 +15,11 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-
 module RuboCop
   module Cop
     module Chef
       module Deprecations
-        # Use the :remove action in the chocolatey_package resource instead of :uninstall which was removed in Chef Infra Client 14+
+        # Use the `:remove` action in the `chocolatey_package` resource instead of `:uninstall` which was removed in Chef Infra Client 14+.
         #
         # @example
         #

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

@@ -19,7 +19,7 @@ module RuboCop
   module Cop
     module Chef
       module Deprecations
-        # Don't depend on the deprecated compat_resource cookbook made obsolete by Chef Infra Client 12.19+
+        # Don't depend on the deprecated `compat_resource` cookbook made obsolete by Chef Infra Client 12.19+.
         #
         # @example
         #

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

@@ -19,7 +19,7 @@ module RuboCop
   module Cop
     module Chef
       module Deprecations
-        # Don't depend on the partial_search cookbook made obsolete by Chef Infra Client 13
+        # Don't depend on the `partial_search` cookbook made obsolete by Chef Infra Client 13.
         #
         # @example
         #

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

@@ -15,12 +15,11 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-
 module RuboCop
   module Cop
     module Chef
       module Deprecations
-        # Use currently supported platforms in ChefSpec listed at https://github.com/chefspec/fauxhai/blob/master/PLATFORMS.md. Fauxhai / ChefSpec will perform fuzzy matching on platform version so it's always best to be less specific ie. 10 instead of 10.3
+        # Use currently supported platforms in ChefSpec listed at https://github.com/chefspec/fauxhai/blob/master/PLATFORMS.md. Fauxhai / ChefSpec will perform fuzzy matching on platform version values so it's always best to be less specific ie. 10 instead of 10.3
         #
         # @example
         #

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

@@ -15,12 +15,11 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-
 module RuboCop
   module Cop
     module Chef
       module Deprecations
-        # Don't use deprecated Mixins no longer included in Chef Infra Client 14 and later
+        # Don't use deprecated Mixins no longer included in Chef Infra Client 14 and later.
         #
         # @example
         #

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

@@ -15,12 +15,11 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-
 module RuboCop
   module Cop
     module Chef
       module Deprecations
-        # Use provider_for_action or provides instead of the deprecated Chef::Platform methods in resources, which were removed in Chef Infra Client 13.
+        # Use `provider_for_action` or provides instead of the deprecated `Chef::Platform` methods in resources, which were removed in Chef Infra Client 13.
         #
         # @example
         #

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

@@ -15,12 +15,11 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-
 module RuboCop
   module Cop
     module Chef
       module Deprecations
-        # The large number of shell_out helper methods in Chef Infra Client has been reduced to just shell_out and shell_out! methods. The legacy methods were removed in Chef Infra Client and cookbooks using these legacy helpers will need to be updated.
+        # The large number of `shell_out` helper methods in Chef Infra Client has been reduced to just `shell_out` and `shell_out!` methods. The legacy methods were removed in Chef Infra Client and cookbooks using these legacy helpers will need to be updated.
         #
         # @example
         #