cookstyle 7.11.1 → 7.12.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cfa1f90dbcd8306cfac33378dc6b1307538dc6284e3f6dc97c531d8c500bebb6
-  data.tar.gz: f8906785afaf49726de9e324f85057dd2540b05361a6a8b654873152b8313cb2
+  metadata.gz: 7958b406a903a1393062af1fea9eb412dea315a39ba72f0614be9e50a61f48f5
+  data.tar.gz: 65f9399991eb1969d32675ea92baf7515d8631a34f775599354e222a6e67539d
 SHA512:
-  metadata.gz: f9524392df8ec6b820d81a9568928eb6ef5c27c4f75c5b9faca728b59b20923bf3e25084121df974dc72bcfc03c6063fe9e3d5f7957f57dc0719efa50fafeba8
-  data.tar.gz: 5659fd48d73fee64ab4301681e0aacbe0fda1698f8084650fa20d60835416b3b64799098a7b022ab49f403502b2cac5a8802db1e924ea25b638da037d1a1a313
+  metadata.gz: f11395e2998b9527c94071305e61abd63301a8f283ab5b032eb26fb842166c81ecaff34372fcaadf51e9467b56e10d14bb53f4fefdf6925e192277e9087f6068
+  data.tar.gz: dbea35f94ed1240fab1e755d993906811e34420dcefa0f4d707ed5de3220519471547a8ccfcb690d99819c29fd4d53c12ae3b4f00a18d4e3448e5b5d21e7fca0

data/config/cookstyle.yml

@@ -3,8 +3,8 @@ AllCops:
   TargetRubyVersion: 2.5
   TargetChefVersion: ~
   Exclude:
-    - '/**/files/**/*'
-    - '/**/vendor/**/*'
+    - '**/files/**/*'
+    - '**/vendor/**/*'
     - Guardfile
 
 ###############################
@@ -221,7 +221,7 @@ Chef/Correctness/MetadataMissingName:
     - '**/metadata.rb'
 
 Chef/Correctness/BlockGuardWithOnlyString:
-  Description: A resource guard (not_if/only_if) that is a string should not be wrapped in {}. Wrapping a guard string in {} causes it to be executed as Ruby code which will always returns true instead of a shell command that will actually run.
+  Description: A resource guard (not_if/only_if) that is a string should not be wrapped in {}. Wrapping a guard string in {} causes it to be executed as Ruby code which will always return true instead of a shell command that will actually run.
   StyleGuide: 'chef_correctness_blockguardwithonlystring'
   Enabled: true
   VersionAdded: '5.2.0'
@@ -584,7 +584,7 @@ Chef/Deprecations/NodeSetUnless:
     - '**/Berksfile'
 
 Chef/Deprecations/EpicFail:
-  Description: Use ignore_failure method instead of the deprecated epic_fail method
+  Description: Use `ignore_failure` in resources to continue when failures occur instead of the deprecated `epic_fail` property
   StyleGuide: 'chef_deprecations_epicfail'
   Enabled: true
   VersionAdded: '5.1.0'
@@ -843,7 +843,7 @@ Chef/Deprecations/DeprecatedYumRepositoryProperties:
     - '**/Berksfile'
 
 Chef/Deprecations/EOLAuditModeUsage:
-  Description: The beta Audit Mode feature in Chef Infra Client was removed in Chef Infra Client 15.0. Users should instead use InSpec and the audit cookbook. See https://www.inspec.io/ for more information.
+  Description: The beta Audit Mode feature in Chef Infra Client was removed in Chef Infra Client 15.0.
   StyleGuide: 'chef_deprecations_eolauditmodeusage'
   Enabled: true
   VersionAdded: '5.10.0'
@@ -1071,7 +1071,7 @@ Chef/Deprecations/ChefDKGenerators:
     - '**/Berksfile'
 
 Chef/Deprecations/ChefHandlerRecipe:
-  Description: There is no need to include the empty and deprecated chef_handler::default recipe in order to use the chef_handler resource.
+  Description: There is no need to include the empty and deprecated chef_handler::default recipe to use the chef_handler resource.
   StyleGuide: 'chef_deprecations_chefhandlerrecipe'
   Enabled: true
   VersionAdded: '6.12.0'
@@ -1107,7 +1107,7 @@ Chef/Deprecations/CookbooksDependsOnSelf:
     - '**/metadata.rb'
 
 Chef/Deprecations/ChefShellout:
-  Description: Don't use deprecated Chef::ShellOut which was removed in Chef Infra Client 13. Use Mixlib::ShellOut instead, which behaves identically.
+  Description: 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.
   StyleGuide: 'chef_deprecations_chefshellout'
   Enabled: true
   VersionAdded: '6.17.0'
@@ -1190,6 +1190,24 @@ Chef/Deprecations/ChefSugarHelpers:
     - '**/Berksfile'
     - '**/Rakefile'
 
+Chef/Deprecations/HWRPWithoutUnifiedTrue:
+  Description: Set `unified_mode true` in Chef Infra Client 15.3+ HWRP style custom resources to ensure they work correctly in Chef Infra Client 18 (April 2022) when Unified Mode becomes the default.
+  StyleGuide: 'chef_deprecations_hwrpwithoutunifiedtrue'
+  Enabled: true
+  VersionAdded: '7.12.0'
+  Include:
+    - '**/libraries/*.rb'
+
+Chef/Deprecations/ResourceWithoutUnifiedTrue:
+  Description: Set `unified_mode true` in Chef Infra Client 15.3+ custom resources to ensure they work correctly in Chef Infra Client 18 (April 2022) when Unified Mode becomes the default.
+  StyleGuide: 'chef_deprecations_resourcewithoutunifiedtrue'
+  Enabled: true
+  VersionAdded: '7.12.0'
+  Include:
+    - '**/resources/*.rb'
+  Exclude:
+    - '**/spec/**/*.rb'
+
 ###############################
 # Chef/Modernize: Cleaning up legacy code and using new built-in resources
 ###############################
@@ -2247,8 +2265,9 @@ Style/Proc:
   Enabled: true
 Style/RaiseArgs:
   Enabled: true
+# disabled for now as this breaks ruby_block resources
 Style/RedundantBegin:
-  Enabled: true
+  Enabled: false
 Style/RedundantException:
   Enabled: true
 Style/RedundantFreeze:

data/lib/cookstyle/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 module Cookstyle
-  VERSION = "7.11.1" # rubocop: disable Style/StringLiterals
+  VERSION = "7.12.6" # rubocop: disable Style/StringLiterals
   RUBOCOP_VERSION = '1.14.0'
 end

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

@@ -19,7 +19,7 @@ module RuboCop
   module Cop
     module Chef
       module Correctness
-        # A resource guard (not_if/only_if) that is a string should not be wrapped in `{}`. Wrapping a guard string in {} causes it to be executed as Ruby code which will always returns true instead of a shell command that will actually run.
+        # A resource guard (not_if/only_if) that is a string should not be wrapped in `{}`. Wrapping a guard string in {} causes it to be executed as Ruby code which will always return true instead of a shell command that will actually run.
         #
         # @example
         #
@@ -40,7 +40,7 @@ module RuboCop
         class BlockGuardWithOnlyString < Base
           extend AutoCorrector
 
-          MSG = 'A resource guard (not_if/only_if) that is a string should not be wrapped in {}. Wrapping a guard string in {} causes it to be executed as Ruby code which will always returns true instead of a shell command that will actually run.'
+          MSG = 'A resource guard (not_if/only_if) that is a string should not be wrapped in {}. Wrapping a guard string in {} causes it to be executed as Ruby code which will always return true instead of a shell command that will actually run.'
 
           def_node_matcher :block_guard_with_only_string?, <<-PATTERN
             (block (send nil? ${:not_if :only_if}) (args) (str $_) )

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

@@ -15,21 +15,20 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-
 module RuboCop
   module Cop
     module Chef
-      # Default actions in resources should be symbols or an array of symbols.
-      #
-      # @example
-      #
-      #   #### incorrect
-      #   default_action 'create'
-      #
-      #   #### correct
-      #   default_action :create
-      #
       module Correctness
+        # Default actions in resources should be symbols or an array of symbols.
+        #
+        # @example
+        #
+        #   #### incorrect
+        #   default_action 'create'
+        #
+        #   #### correct
+        #   default_action :create
+        #
         class InvalidDefaultAction < Base
           MSG = 'Default actions in resources should be symbols or an array of symbols.'
           RESTRICT_ON_SEND = [:default_action].freeze

data/lib/rubocop/cop/chef/correctness/invalid_platform_metadata.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
-        # metadata.rb supports methods should contain valid platforms. See [Infra Language: Platform](https://docs.chef.io/infra_language/checking_platforms/#platform-values) for a list of many common platform values.
+        # metadata.rb `supports` methods should contain valid platforms. See [Infra Language: Platform](https://docs.chef.io/infra_language/checking_platforms/#platform-values) for a list of many common platform values.
         #
         # @example
         #

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

@@ -19,7 +19,7 @@ module RuboCop
   module Cop
     module Chef
       module Correctness
-        # 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.
+        # Pass valid platform 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
         #

data/lib/rubocop/cop/chef/correctness/invalid_version_metadata.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/lazy_eval_node_attribute_defaults.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/metadata_missing_name.rb

@@ -15,28 +15,27 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-
 module RuboCop
   module Cop
     module Chef
-      # metadata.rb needs to include the name method or it will fail on Chef Infra Client 12 and later.
-      #
-      # @example
-      #
-      #   #### correct
-      #   name 'foo'
-      #
       module Correctness
+        # metadata.rb needs to include the name method or it will fail on Chef Infra Client 12 and later.
+        #
+        # @example
+        #
+        #   #### correct
+        #   name 'foo'
+        #
         class MetadataMissingName < Base
           include RangeHelp
 
           MSG = 'metadata.rb needs to include the name method or it will fail on Chef Infra Client 12 and later.'
 
-          def_node_search :cb_name, '(send nil? :name str ...)'
+          def_node_search :cb_name?, '(send nil? :name str ...)'
 
           def on_new_investigation
             # Using range similar to RuboCop::Cop::Naming::Filename (file_name.rb)
-            return if cb_name(processed_source.ast).any?
+            return if cb_name?(processed_source.ast)
             range = source_range(processed_source.buffer, 1, 0)
             add_offense(range, message: MSG, severity: :refactor) do |_corrector|
               path = processed_source.path

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

@@ -18,13 +18,9 @@ module RuboCop
   module Cop
     module Chef
       module Correctness
-        # Normal attributes are discouraged since their semantics differ importantly from the
-        # default and override levels. Their values persist in the node object even after
-        # all code referencing them has been deleted, unlike default and override.
+        # Normal attributes are discouraged since their semantics differ importantly from the default and override levels. Their values persist in the node object even after all code referencing them has been deleted, unlike default and override.
         #
-        # Code should be updated to use default or override levels, but this will change
-        # attribute merging behavior so needs to be validated manually and force_default or
-        # force_override levels may need to be used in recipe code.
+        # Code should be updated to use default or override levels, but this will change attribute merging behavior so needs to be validated manually and force_default or force_override levels may need to be used in recipe code.
         #
         # @example
         #

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

@@ -18,13 +18,9 @@ module RuboCop
   module Cop
     module Chef
       module Correctness
-        # Normal attributes are discouraged since their semantics differ importantly from the
-        # default and override levels. Their values persist in the node object even after
-        # all code referencing them has been deleted, unlike default and override.
+        # Normal attributes are discouraged since their semantics differ importantly from the default and override levels. Their values persist in the node object even after all code referencing them has been deleted, unlike default and override.
         #
-        # Code should be updated to use default or override levels, but this will change
-        # attribute merging behavior so needs to be validated manually and force_default or
-        # force_override levels may need to be used in recipe code.
+        # Code should be updated to use default or override levels, but this will change attribute merging behavior so needs to be validated manually and force_default or force_override levels may need to be used in recipe code.
         #
         # @example
         #

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