cookstyle 7.20.0 → 7.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1beeee72a35f1c32830c7c968ba50d7a277bed019de89697fb54e232d53cfa3d
-  data.tar.gz: 98a912f077a8d14033a03ace34622f1b651dec2b1aea69e3c7c8121f9c487423
+  metadata.gz: 48e9eba9990f29d5ece83efea73a5ceba5c49ed781909b437c40c43da790210a
+  data.tar.gz: 9f177a0a2cadc3cb703ec87337bd4485e872ae748d9af95f53473dec22eebd7d
 SHA512:
-  metadata.gz: b7a79148cf57524f1df2f880fcaea77f82cff8d87f1b2e347c1f0ed39a6629bfd91436caa4c7a6b55d99da6d2429e8bea99d9feeb78bc29585458bddf739f4a1
-  data.tar.gz: 6793431fc22cb1de03923569fcf0d2fb57fe3e0b646df99579752fa999d1898956b799dd2734b1e0459bc156fb48081ba685ad0fbedd45204b3b45a9438a5101
+  metadata.gz: fbeebdde748ba5abca797bf203ab8465c74e1b1714847d27e35576b3801daae3e962b9bfb3516c84f684e69a3088535d8811ea7df74005f6262005bb844295a7
+  data.tar.gz: 4e3c683249684fdae3717f88b9ea92c9eb26147d55eb90e43e024f7c0ce03870d03c66b4f2c7ad6eb9c057cf1eb687ce28ed44efea7b2a61e5a9002b3b143628

data/config/cookstyle.yml

@@ -482,7 +482,7 @@ Chef/Correctness/OctalModeAsString:
     - '**/Berksfile'
 
 Chef/Correctness/MetadataMalformedDepends:
-  Description: Don't represent file modes as strings containing octal values. Use standard base 10 file modes instead.
+  Description: metadata.rb cookbook dependencies and version constraints should be comma separated.
   StyleGuide: 'chef_correctness_metadatamalformeddepends'
   Enabled: true
   VersionAdded: '7.16'
@@ -1263,7 +1263,7 @@ Chef/Deprecations/DependsOnChefReportingCookbook:
     - '**/metadata.rb'
 
 Chef/Deprecations/DependsOnOmnibusUpdaterCookbook:
-  Description: Don't depend on the EOL `omnibus_updater` cookbook. This cookbook no longer works with newer Chef Infra Client releases and has been replaced by with the more reliable `chef_client_updater` cookbook.
+  Description: Don't depend on the EOL `omnibus_updater` cookbook. This cookbook no longer works with newer Chef Infra Client releases and has been replaced with the more reliable `chef_client_updater` cookbook.
   StyleGuide: 'chef_deprecations_dependsonomnibusupdatercookbook'
   Enabled: true
   VersionAdded: '7.20.0'
@@ -1889,13 +1889,23 @@ Chef/Modernize/DependsOnChocolateyCookbooks:
     - '**/metadata.rb'
 
 Chef/Modernize/DependsOnOpensslCookbook:
-  Description: Don't depend on the openssl cookbook which was made obsolete by Chef Infra Client 14.4. All openssl resource are now included directly in Chef Infra Client.
+  Description: Don't depend on the `openssl` cookbook which was made obsolete by Chef Infra Client 14.4. All `openssl_*` resources are now included directly in Chef Infra Client.
   StyleGuide: 'chef_modernize_dependsonopensslcookbook'
   Enabled: true
   VersionAdded: '7.20.0'
   Include:
     - '**/metadata.rb'
 
+Chef/Modernize/UseChefLanguageEnvHelpers:
+  Description: Chef Infra Client 15.5 and later include a large number of new helpers in the Chef Infra Language to simplify checking the system configuration in recipes and resources. These should be used when possible over more complex attribute or ENV var comparisons.
+  StyleGuide: 'chef_modernize_usecheflanguageenvhelpers'
+  Enabled: true
+  VersionAdded: '7.21.0'
+  Include:
+    - '**/resources/*.rb'
+    - '**/providers/*.rb'
+    - '**/recipes/*.rb'
+
 ###############################
 # Chef/RedundantCode: Cleanup unnecessary code in your cookbooks regardless of Chef Infra Client release
 ###############################

data/lib/cookstyle/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 module Cookstyle
-  VERSION = "7.20.0" # rubocop: disable Style/StringLiterals
+  VERSION = "7.21.0" # rubocop: disable Style/StringLiterals
   RUBOCOP_VERSION = '1.19.0'
 end

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

@@ -19,7 +19,7 @@ module RuboCop
   module Cop
     module Chef
       module Correctness
-        # metadata.rb cookbook dependencies and version constraints should be comma separated
+        # metadata.rb cookbook dependencies and version constraints should be comma separated.
         #
         # @example
         #

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

@@ -19,7 +19,7 @@ module RuboCop
   module Cop
     module Chef
       module Deprecations
-        # Don't depend on the EOL `omnibus_updater` cookbook. This cookbook no longer works with newer Chef Infra Client releases and has been replaced by with the more reliable `chef_client_updater` cookbook.
+        # Don't depend on the EOL `omnibus_updater` cookbook. This cookbook no longer works with newer Chef Infra Client releases and has been replaced with the more reliable `chef_client_updater` cookbook.
         #
         # @example
         #
@@ -33,7 +33,7 @@ module RuboCop
           extend AutoCorrector
           include RangeHelp
 
-          MSG = "Don't depend on the EOL `omnibus_updater` cookbook. This cookbook no longer works with newer Chef Infra Client releases and has been replaced by with the more reliable `chef_client_updater` cookbook."
+          MSG = "Don't depend on the EOL `omnibus_updater` cookbook. This cookbook no longer works with newer Chef Infra Client releases and has been replaced with the more reliable `chef_client_updater` cookbook."
           RESTRICT_ON_SEND = [:depends].freeze
 
           def_node_matcher :legacy_depends?, <<-PATTERN

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

@@ -19,7 +19,7 @@ module RuboCop
   module Cop
     module Chef
       module Modernize
-        # Don't depend on the openssl cookbook which was made obsolete by Chef Infra Client 14.4. All openssl resource are now included directly in Chef Infra Client.
+        # Don't depend on the `openssl` cookbook which was made obsolete by Chef Infra Client 14.4. All `openssl_*` resources are now included directly in Chef Infra Client.
         #
         # @example
         #
@@ -33,7 +33,7 @@ module RuboCop
 
           minimum_target_chef_version '14.4'
 
-          MSG = "Don't depend on the openssl cookbook which was made obsolete by Chef Infra Client 14.4. All openssl resource are now included directly in Chef Infra Client."
+          MSG = "Don't depend on the `openssl` cookbook which was made obsolete by Chef Infra Client 14.4. All `openssl_*` resources are now included directly in Chef Infra Client."
           RESTRICT_ON_SEND = [:depends].freeze
 
           def_node_matcher :legacy_depends?, <<-PATTERN

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

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+#
+# Copyright:: 2021, Chef Software, Inc.
+# Author:: Tim Smith (<tsmith@chef.io>)
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+module RuboCop
+  module Cop
+    module Chef
+      module Modernize
+        # Chef Infra Client 15.5 and later include cloud helpers to make detecting instance that run on public and private clouds easier.
+        #
+        # @example
+        #
+        #   #### incorrect
+        #   ENV['CI']
+        #   ENV['TEST_KITCHEN']
+        #
+        #   #### correct
+        #   ci?
+        #   kitchen?
+        #
+        class UseChefLanguageCloudHelpers < Base
+          extend AutoCorrector
+
+          MSG = 'Chef Infra Client 15.5 and later include cloud helpers to make detecting instance that run on public and private clouds easier.'.freeze
+          RESTRICT_ON_SEND = [:==, :[]].freeze
+          VALID_CLOUDS = %w(alibaba ec2 gce rackspace eucalyptus linode openstack azure digital_ocean softlayer).freeze
+
+          def_node_matcher :provider_comparison?, <<-PATTERN
+            (send
+              (send
+                (send
+                  (send nil? :node) :[]
+                  (str "cloud")) :[]
+                (str "provider")) :==
+              (str $_))
+          PATTERN
+
+          def_node_matcher :node_check?, <<-PATTERN
+            (send
+              (send nil? :node) :[]
+              (str ${"ec2"}))
+          PATTERN
+
+          def_node_matcher :node_cloud?, <<-PATTERN
+            (send
+              (send nil? :node) :[]
+              (str "cloud"))
+          PATTERN
+
+          def on_send(node)
+            node_check?(node) do |cloud_name|
+              add_offense(node, message: MSG, severity: :refactor) do |corrector|
+                corrector.replace(node, "#{cloud_name}?")
+              end
+            end
+
+            provider_comparison?(node) do |cloud_name|
+              # skip it if someone was checking for a bogus cloud provider
+              next unless VALID_CLOUDS.include?(cloud_name)
+
+              # if they were checking for node['cloud'] and the provider replace it all
+              node = node.parent if node.parent.and_type? && node_cloud?(node.left_sibling)
+              
+              add_offense(node, message: MSG, severity: :refactor) do |corrector|
+                corrector.replace(node, "#{cloud_name}?")
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+#
+# Copyright:: 2021, Chef Software, Inc.
+# Author:: Tim Smith (<tsmith@chef.io>)
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+module RuboCop
+  module Cop
+    module Chef
+      module Modernize
+        # Chef Infra Client 15.5 and later include a large number of new helpers in the Chef Infra Language to simplify checking the system configuration in recipes and resources. These should be used when possible over more complex attribute or ENV var comparisons.
+        #
+        # @example
+        #
+        #   #### incorrect
+        #   ENV['CI']
+        #   ENV['TEST_KITCHEN']
+        #
+        #   #### correct
+        #   ci?
+        #   kitchen?
+        #
+        class UseChefLanguageEnvHelpers < Base
+          extend AutoCorrector
+
+          RESTRICT_ON_SEND = [:[]].freeze
+
+          def_node_matcher :env?, <<-PATTERN
+            (send
+              (const nil? :ENV) :[]
+              (str ${"TEST_KITCHEN" "CI"}))
+          PATTERN
+
+          def on_send(node)
+            env?(node) do |env_value|
+              # we don't handle .nil? checks yet so just skip them
+              next if node.parent.send_type? && node.parent.method_name == :nil?
+
+              case env_value
+              when 'CI'
+                add_offense(node, message: 'Chef Infra Client 15.5 and later include a helper `ci?` that should be used to see if the `CI` env var is set.', severity: :refactor) do |corrector|
+                  corrector.replace(node, 'ci?')
+                end
+              when 'TEST_KITCHEN'
+                add_offense(node, message: 'Chef Infra Client 15.5 and later include a helper `kitchen?` that should be used to see if the `TEST_KITCHEN` env var is set.', severity: :refactor) do |corrector|
+                  corrector.replace(node, 'kitchen?')
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/style/immediate_notification_timing.rb

@@ -19,7 +19,7 @@ module RuboCop
   module Cop
     module Chef
       module Style
-        # Use :immediately instead of :immediate for resource notification timing
+        # Use :immediately instead of :immediate for resource notification timing.
         #
         # @example
         #
@@ -39,10 +39,10 @@ module RuboCop
           extend AutoCorrector
 
           MSG = 'Use :immediately instead of :immediate for resource notification timing'
-          RESTRICT_ON_SEND = [:notifies].freeze
+          RESTRICT_ON_SEND = [:notifies, :subscribes].freeze
 
           def_node_matcher :immediate_notify?, <<-PATTERN
-            (send nil? :notifies (sym _) (...) $(sym :immediate))
+            (send nil? {:notifies :subscribes} (sym _) (...) $(sym :immediate))
           PATTERN
 
           def on_send(node)

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: cookstyle
 version: !ruby/object:Gem::Version
-  version: 7.20.0
+  version: 7.21.0
 platform: ruby
 authors:
 - Thom May
 - Tim Smith
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-08-19 00:00:00.000000000 Z
+date: 2021-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -25,7 +25,7 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 1.19.0
-description: 
+description:
 email:
 - thom@chef.io
 - tsmith@chef.io
@@ -236,6 +236,8 @@ files:
 - lib/rubocop/cop/chef/modernize/simplify_apt_ppa_setup.rb
 - lib/rubocop/cop/chef/modernize/sysctl_param_resource.rb
 - lib/rubocop/cop/chef/modernize/unnecessary_mixlib_shellout_require.rb
+- lib/rubocop/cop/chef/modernize/use_chef_language_cloud_helpers.rb
+- lib/rubocop/cop/chef/modernize/use_chef_language_env_helpers.rb
 - lib/rubocop/cop/chef/modernize/use_multipackage_installs.rb
 - lib/rubocop/cop/chef/modernize/use_require_relative.rb
 - lib/rubocop/cop/chef/modernize/whyrun_supported_true.rb
@@ -307,7 +309,7 @@ metadata:
   source_code_uri: https://github.com/chef/cookstyle
   documentation_uri: https://docs.chef.io/workstation/cookstyle/
   bug_tracker_uri: https://github.com/chef/cookstyle/issues
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -322,8 +324,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key: 
+rubygems_version: 3.2.22
+signing_key:
 specification_version: 4
 summary: Cookstyle is a code linting tool that helps you to write better Chef Infra
   cookbooks by detecting and automatically correcting style, syntax, and logic mistakes