cookstyle 8.3.0 → 8.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a1a191c90a12bcf6f3d2157fa8d55de1aadb7e698eebb3bb0c98ac1409768177
-  data.tar.gz: 9ffc7f791991d7858ac641d3125b5dbaa31aedfea77d8ba0d0066a922ecbdf57
+  metadata.gz: 388c63af17bc8af6ccee78b056d4fb74972c443a91737363f54d4dc41b1e1042
+  data.tar.gz: 23310602f2fba3002f6d4853881f5a432025473ea8c368b33b23b1798659974b
 SHA512:
-  metadata.gz: 8def20d17d9d31471055c4123739744ed8308dc0bb7d88da6a39a2c9b0f901a83b1529d4ab50b9438b8816f83ff9f384dfdea02bfe93b4f57b4af36d953dc330
-  data.tar.gz: c661f92cd12eb9341afef4e9aef7dca0a23556a1e12850a6c98a854e4bad0e581076adb65fface94c12757727c7e459aa4373c7f4c8e8f805e08570dbfc7c60a
+  metadata.gz: cf74fe8aab73053ef3c723cdecb8a6d5a077bcba200a5986b90e5116fca9c2cd64eebfb3736355642a58df3b2c3960b99b6b23f7bfb2e432b1bdfb62f9b398d0
+  data.tar.gz: aa8ae4575701d1d4dae566277c429402c39f0785b5d36789d7d2740c91feafbaa3a179c3ab940e7caecfb17f4921fa5598985ff8e945b4adbed11e48878ee860

data/config/chefstyle.yml

@@ -868,6 +868,10 @@ Lint/UselessDefaultValueArgument:
 Style/CollectionQuerying:
   Enabled: true
 
+# use `include?(element)` instead of `intersect?([element])`
+Style/ArrayIntersectWithSingleElement:
+  Enabled: true
+
 Chef/Deprecations/Ruby27KeywordArgumentWarnings:
   Description: Pass options to shell_out helpers without the brackets to avoid Ruby 2.7 deprecation warnings.
   Enabled: true

data/config/cookstyle.yml

@@ -391,6 +391,16 @@ Chef/Correctness/DnfPackageAllowDowngrades:
     - '**/metadata.rb'
     - '**/Berksfile'
 
+Chef/Correctness/EmptyResourceGuard:
+  Description: Resource guards (not_if/only_if) should not be empty strings as empty strings will always evaluate to true.
+  StyleGuide: 'chef_correctness_emptyresourceguard'
+  Enabled: true
+  VersionAdded: '8.4.0'
+  Exclude:
+    - '**/attributes/*.rb'
+    - '**/metadata.rb'
+    - '**/Berksfile'
+
 Chef/Correctness/ChefApplicationFatal:
   Description: Use raise to force Chef Infra Client to fail instead of using Chef::Application.fatal
   StyleGuide: 'chef_correctness_chefapplicationfatal'
@@ -3287,3 +3297,7 @@ Lint/UselessDefaultValueArgument:
 # use helpers like .any?, .none?, and .one? instead of using count on collections which is much slower
 Style/CollectionQuerying:
   Enabled: true
+
+# use `include?(element)` instead of `intersect?([element])`
+Style/ArrayIntersectWithSingleElement:
+  Enabled: true

data/lib/cookstyle/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 module Cookstyle
-  VERSION = "8.3.0" # rubocop: disable Style/StringLiterals
-  RUBOCOP_VERSION = '1.79.1'
+  VERSION = "8.5.0" # rubocop: disable Style/StringLiterals
+  RUBOCOP_VERSION = '1.81.0'
 end

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

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+#
+# Copyright:: 2024, Chef Software Inc.
+# Author:: Sumedha (<https://github.com/sumedha-lolur>)
+#
+# 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 Correctness
+        # Resource guards (not_if/only_if) should not be empty strings as empty strings will always evaluate to true.
+        # This will cause confusion in your cookbooks as the guard will always pass.
+        #
+        # Empty strings in Ruby are "truthy", which means:
+        # - `only_if ''` will ALWAYS execute the resource (guard always passes)
+        # - `not_if ''` will NEVER execute the resource (guard always blocks)
+        #
+        # This behavior is usually unintended and can lead to resources running when they shouldn't
+        # or never running when they should.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   template '/etc/foo' do
+        #     mode '0644'
+        #     source 'foo.erb'
+        #     only_if ''  # This will always be true - resource always executes
+        #   end
+        #
+        #   cookbook_file '/logs/foo/error.log' do
+        #     source 'error.log'
+        #     not_if { '' }  # This will always be true - resource never executes
+        #   end
+        #
+        #   service 'apache2' do
+        #     action :restart
+        #     only_if { '' }  # Block form also problematic
+        #   end
+        #
+        #   ### correct
+        #   template '/etc/foo' do
+        #     mode '0644'
+        #     source 'foo.erb'
+        #     only_if 'test -f /etc/foo'  # Actual shell command
+        #   end
+        #
+        #   cookbook_file '/logs/foo/error.log' do
+        #     source 'error.log'
+        #     not_if { ::File.exist?('/logs/foo/error.log') }  # Proper Ruby expression
+        #   end
+        #
+        #   service 'apache2' do
+        #     action :restart
+        #     only_if { node['platform'] == 'ubuntu' }  # Meaningful condition
+        #   end
+        #
+        #   # Or simply remove the guard if no condition is needed
+        #   package 'curl' do
+        #     action :install
+        #   end
+        #
+        class EmptyResourceGuard < Base
+          MSG = 'Resource guards (not_if/only_if) should not be empty strings as empty strings will always evaluate to true.'
+          RESTRICT_ON_SEND = [:not_if, :only_if].freeze
+
+          def_node_matcher :empty_string_guard?, <<-PATTERN
+            (send nil? {:not_if :only_if} (str #empty_string?))
+          PATTERN
+
+          def_node_matcher :empty_string_block_guard?, <<-PATTERN
+            (block (send nil? {:not_if :only_if}) (args) (str #empty_string?))
+          PATTERN
+
+          def empty_string?(str)
+            str.empty?
+          end
+
+          def on_send(node)
+            empty_string_guard?(node) do
+              add_offense(node, severity: :refactor)
+            end
+          end
+
+          def on_block(node)
+            empty_string_block_guard?(node) do
+              add_offense(node, severity: :refactor)
+            end
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: cookstyle
 version: !ruby/object:Gem::Version
-  version: 8.3.0
+  version: 8.5.0
 platform: ruby
 authors:
 - Thom May
 - Tim Smith
+autorequire:
 bindir: bin
 cert_chain: []
-date: 1980-01-02 00:00:00.000000000 Z
+date: 2025-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -16,14 +17,15 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.79.1
+        version: 1.81.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.79.1
+        version: 1.81.0
+description:
 email:
 - thom@chef.io
 - tsmith84@gmail.com
@@ -52,6 +54,7 @@ files:
 - lib/rubocop/cop/chef/correctness/chef_application_fatal.rb
 - lib/rubocop/cop/chef/correctness/conditional_ruby_shellout.rb
 - lib/rubocop/cop/chef/correctness/dnf_package_allow_downgrades.rb
+- lib/rubocop/cop/chef/correctness/empty_resource_guard.rb
 - lib/rubocop/cop/chef/correctness/incorrect_library_injection.rb
 - lib/rubocop/cop/chef/correctness/invalid_cookbook_name.rb
 - lib/rubocop/cop/chef/correctness/invalid_default_action.rb
@@ -322,6 +325,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:
 rdoc_options: []
 require_paths:
 - lib
@@ -336,7 +340,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 3.3.27
+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