cookstyle 8.6.4 → 8.7.6

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

@@ -1,86 +1,86 @@
-# frozen_string_literal: true
-#
-# Copyright:: Copyright (c) Chef Software Inc.
-# Author:: Tim Smith (<tsmith84@gmail.com>)
-#
-# 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 Deprecations
-        # Chef Infra Client 15.3 and later include a new Unified Mode that simplifies the execution of resources by replacing the traditional compile and converge phases with a single phase. Unified mode simplifies writing advanced resources and avoids confusing errors that often occur when mixing ruby and Chef Infra resources. Chef Infra Client 17.0 and later will begin warning that `unified_mode true` should be set in all resources to validate that they will continue to function in Chef Infra Client 18.0 (April 2022) when Unified Mode becomes the default.
-        #
-        # @example
-        #
-        #   # bad
-        #   class Chef
-        #     class Resource
-        #       class UlimitRule < Chef::Resource
-        #         provides :ulimit_rule
-        #
-        #         property :type, [Symbol, String], required: true
-        #         property :item, [Symbol, String], required: true
-        #
-        #         # additional resource code
-        #       end
-        #     end
-        #   end
-        #
-        #   # good
-        #   class Chef
-        #     class Resource
-        #       class UlimitRule < Chef::Resource
-        #         provides :ulimit_rule
-        #         unified_mode true
-        #
-        #         property :type, [Symbol, String], required: true
-        #         property :item, [Symbol, String], required: true
-        #
-        #         # additional resource code
-        #       end
-        #     end
-        #   end
-        #
-        class HWRPWithoutUnifiedTrue < Base
-          extend TargetChefVersion
-
-          minimum_target_chef_version '15.3'
-
-          MSG = '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.'
-
-          def_node_matcher :HWRP?, <<-PATTERN
-          (class
-            (const nil? :Chef) nil?
-            (class
-              (const nil? :Resource) nil?
-              $(class
-                (const nil? ... )
-                (const
-                  (const nil? :Chef) :Resource)
-                  (begin ... ))))
-          PATTERN
-
-          def_node_search :unified_mode?, '(send nil? :unified_mode ...)'
-
-          def on_class(node)
-            return if unified_mode?(processed_source.ast)
-            HWRP?(node) do |inherit|
-              add_offense(inherit, severity: :warning)
-            end
-          end
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+#
+# Copyright:: Copyright (c) 2016-2025 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
+# Author:: Tim Smith (<tsmith84@gmail.com>)
+#
+# 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 Deprecations
+        # Chef Infra Client 15.3 and later include a new Unified Mode that simplifies the execution of resources by replacing the traditional compile and converge phases with a single phase. Unified mode simplifies writing advanced resources and avoids confusing errors that often occur when mixing ruby and Chef Infra resources. Chef Infra Client 17.0 and later will begin warning that `unified_mode true` should be set in all resources to validate that they will continue to function in Chef Infra Client 18.0 (April 2022) when Unified Mode becomes the default.
+        #
+        # @example
+        #
+        #   # bad
+        #   class Chef
+        #     class Resource
+        #       class UlimitRule < Chef::Resource
+        #         provides :ulimit_rule
+        #
+        #         property :type, [Symbol, String], required: true
+        #         property :item, [Symbol, String], required: true
+        #
+        #         # additional resource code
+        #       end
+        #     end
+        #   end
+        #
+        #   # good
+        #   class Chef
+        #     class Resource
+        #       class UlimitRule < Chef::Resource
+        #         provides :ulimit_rule
+        #         unified_mode true
+        #
+        #         property :type, [Symbol, String], required: true
+        #         property :item, [Symbol, String], required: true
+        #
+        #         # additional resource code
+        #       end
+        #     end
+        #   end
+        #
+        class HWRPWithoutUnifiedTrue < Base
+          extend TargetChefVersion
+
+          minimum_target_chef_version '15.3'
+
+          MSG = '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.'
+
+          def_node_matcher :HWRP?, <<-PATTERN
+          (class
+            (const nil? :Chef) nil?
+            (class
+              (const nil? :Resource) nil?
+              $(class
+                (const nil? ... )
+                (const
+                  (const nil? :Chef) :Resource)
+                  (begin ... ))))
+          PATTERN
+
+          def_node_search :unified_mode?, '(send nil? :unified_mode ...)'
+
+          def on_class(node)
+            return if unified_mode?(processed_source.ast)
+            HWRP?(node) do |inherit|
+              add_offense(inherit, severity: :warning)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,59 +1,59 @@
-# frozen_string_literal: true
-#
-# Copyright:: 2019, Chef Software Inc.
-# Author:: Tim Smith (<tsmith84@gmail.com>)
-#
-# 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 Deprecations
-        # Resources written in the class based HWRP style should inherit from the 'Chef::Resource' class and not the 'ChefCompat::Resource' class from the deprecated compat_resource cookbook.
-        #
-        # @example
-        #
-        #   # bad
-        #   class AptUpdate < ChefCompat::Resource
-        #     # some resource code
-        #   end
-        #
-        #   # good
-        #   class AptUpdate < Chef::Resource
-        #     # some resource code
-        #   end
-        #
-        #  # better
-        #  Write a custom resource using the custom resource DSL and avoid class based HWRPs entirely
-        #
-        class ResourceInheritsFromCompatResource < Base
-          extend AutoCorrector
-
-          MSG = "HWRP style resource should inherit from the 'Chef::Resource' class and not the 'ChefCompat::Resource' class from the deprecated compat_resource cookbook."
-
-          def_node_matcher :inherits_from_compat_resource?, <<-PATTERN
-          (class (const nil? _ ) (const (const nil? :ChefCompat) :Resource) ... )
-          PATTERN
-
-          def on_class(node)
-            inherits_from_compat_resource?(node) do
-              add_offense(node, severity: :warning) do |corrector|
-                corrector.replace(node, node.source.gsub('ChefCompat', 'Chef'))
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+#
+# Copyright:: Copyright (c) 2016-2025 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
+# Author:: Tim Smith (<tsmith84@gmail.com>)
+#
+# 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 Deprecations
+        # Resources written in the class based HWRP style should inherit from the 'Chef::Resource' class and not the 'ChefCompat::Resource' class from the deprecated compat_resource cookbook.
+        #
+        # @example
+        #
+        #   # bad
+        #   class AptUpdate < ChefCompat::Resource
+        #     # some resource code
+        #   end
+        #
+        #   # good
+        #   class AptUpdate < Chef::Resource
+        #     # some resource code
+        #   end
+        #
+        #  # better
+        #  Write a custom resource using the custom resource DSL and avoid class based HWRPs entirely
+        #
+        class ResourceInheritsFromCompatResource < Base
+          extend AutoCorrector
+
+          MSG = "HWRP style resource should inherit from the 'Chef::Resource' class and not the 'ChefCompat::Resource' class from the deprecated compat_resource cookbook."
+
+          def_node_matcher :inherits_from_compat_resource?, <<-PATTERN
+          (class (const nil? _ ) (const (const nil? :ChefCompat) :Resource) ... )
+          PATTERN
+
+          def on_class(node)
+            inherits_from_compat_resource?(node) do
+              add_offense(node, severity: :warning) do |corrector|
+                corrector.replace(node, node.source.gsub('ChefCompat', 'Chef'))
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,56 +1,56 @@
-# frozen_string_literal: true
-#
-# Copyright:: 2019, Chef Software, Inc.
-# Author:: Tim Smith (<tsmith84@gmail.com>)
-#
-# 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 Deprecations
-        # The launchd resource's hash property was renamed to plist_hash in Chef Infra Client 13+ to avoid conflicts with Ruby's hash class.
-        #
-        # @example
-        #
-        #   # bad
-        #   launchd 'foo' do
-        #     hash foo: 'bar'
-        #   end
-        #
-        #   # good
-        #   launchd 'foo' do
-        #     plist_hash foo: 'bar'
-        #   end
-        #
-        class LaunchdDeprecatedHashProperty < Base
-          include RuboCop::Chef::CookbookHelpers
-          extend TargetChefVersion
-          extend AutoCorrector
-
-          minimum_target_chef_version '12.19'
-
-          MSG = "The launchd resource's hash property was renamed to plist_hash in Chef Infra Client 13+ to avoid conflicts with Ruby's hash class."
-
-          def on_block(node)
-            match_property_in_resource?(:launchd, 'hash', node) do |offense|
-              add_offense(offense.loc.expression, severity: :warning) do |corrector|
-                corrector.replace(offense.loc.expression, offense.loc.expression.source.gsub(/^hash/, 'plist_hash'))
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+#
+# Copyright:: Copyright (c) 2016-2025 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
+# Author:: Tim Smith (<tsmith84@gmail.com>)
+#
+# 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 Deprecations
+        # The launchd resource's hash property was renamed to plist_hash in Chef Infra Client 13+ to avoid conflicts with Ruby's hash class.
+        #
+        # @example
+        #
+        #   # bad
+        #   launchd 'foo' do
+        #     hash foo: 'bar'
+        #   end
+        #
+        #   # good
+        #   launchd 'foo' do
+        #     plist_hash foo: 'bar'
+        #   end
+        #
+        class LaunchdDeprecatedHashProperty < Base
+          include RuboCop::Chef::CookbookHelpers
+          extend TargetChefVersion
+          extend AutoCorrector
+
+          minimum_target_chef_version '12.19'
+
+          MSG = "The launchd resource's hash property was renamed to plist_hash in Chef Infra Client 13+ to avoid conflicts with Ruby's hash class."
+
+          def on_block(node)
+            match_property_in_resource?(:launchd, 'hash', node) do |offense|
+              add_offense(offense.loc.expression, severity: :warning) do |corrector|
+                corrector.replace(offense.loc.expression, offense.loc.expression.source.gsub(/^hash/, 'plist_hash'))
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,91 +1,91 @@
-# frozen_string_literal: true
-#
-# Copyright:: 2019, Chef Software, Inc.
-# Author:: Tim Smith (<tsmith84@gmail.com>)
-#
-# 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 Deprecations
-        # Use the new-style notification syntax which allows you to notify resources defined later in a recipe or resource.
-        #
-        # @example
-        #
-        #   # bad
-        #   template '/etc/www/configures-apache.conf' do
-        #     notifies :restart, resources(service: 'apache')
-        #   end
-        #
-        #   template '/etc/www/configures-apache.conf' do
-        #     notifies :restart, resources(service: 'apache'), :immediately
-        #   end
-        #
-        #   template '/etc/www/configures-apache.conf' do
-        #     notifies :restart, resources(service: service_name_variable), :immediately
-        #   end
-        #
-        #   template '/etc/www/configures-apache.conf' do
-        #     subscribes :restart, resources(service: service_name_variable), :immediately
-        #   end
-        #
-        #   # good
-        #   template '/etc/www/configures-apache.conf' do
-        #     notifies :restart, 'service[apache]'
-        #   end
-        #
-        #   template '/etc/www/configures-apache.conf' do
-        #     notifies :restart, 'service[apache]', :immediately
-        #   end
-        #
-        #   template '/etc/www/configures-apache.conf' do
-        #     notifies :restart, "service[#{service_name_variable}]", :immediately
-        #   end
-        #
-        #   template '/etc/www/configures-apache.conf' do
-        #     subscribes :restart, "service[#{service_name_variable}]", :immediately
-        #   end
-        #
-        class LegacyNotifySyntax < Base
-          extend AutoCorrector
-
-          MSG = 'Use the new-style notification syntax which allows you to notify resources defined later in a recipe or resource.'
-          RESTRICT_ON_SEND = [:notifies, :subscribes].freeze
-
-          def_node_matcher :legacy_notify?, <<-PATTERN
-            (send nil? ${:notifies :subscribes} $(sym _) (send nil? :resources (hash (pair $(sym _) $(...) ) ) ) $... )
-          PATTERN
-
-          def on_send(node)
-            legacy_notify?(node) do |notify_type, action, type, name, timing|
-              add_offense(node, severity: :warning) do |corrector|
-                service_value = case name.type
-                                when :str
-                                  "'#{type.source}[#{name.value}]'"
-                                when :dstr
-                                  "\"#{type.source}[#{name.value}]\""
-                                else
-                                  "\"#{type.source}[\#{#{name.source}}]\""
-                                end
-                new_val = +"#{notify_type} #{action.source}, #{service_value}"
-                new_val << ", #{timing.first.source}" unless timing.empty?
-                corrector.replace(node, new_val)
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+#
+# Copyright:: Copyright (c) 2016-2025 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
+# Author:: Tim Smith (<tsmith84@gmail.com>)
+#
+# 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 Deprecations
+        # Use the new-style notification syntax which allows you to notify resources defined later in a recipe or resource.
+        #
+        # @example
+        #
+        #   # bad
+        #   template '/etc/www/configures-apache.conf' do
+        #     notifies :restart, resources(service: 'apache')
+        #   end
+        #
+        #   template '/etc/www/configures-apache.conf' do
+        #     notifies :restart, resources(service: 'apache'), :immediately
+        #   end
+        #
+        #   template '/etc/www/configures-apache.conf' do
+        #     notifies :restart, resources(service: service_name_variable), :immediately
+        #   end
+        #
+        #   template '/etc/www/configures-apache.conf' do
+        #     subscribes :restart, resources(service: service_name_variable), :immediately
+        #   end
+        #
+        #   # good
+        #   template '/etc/www/configures-apache.conf' do
+        #     notifies :restart, 'service[apache]'
+        #   end
+        #
+        #   template '/etc/www/configures-apache.conf' do
+        #     notifies :restart, 'service[apache]', :immediately
+        #   end
+        #
+        #   template '/etc/www/configures-apache.conf' do
+        #     notifies :restart, "service[#{service_name_variable}]", :immediately
+        #   end
+        #
+        #   template '/etc/www/configures-apache.conf' do
+        #     subscribes :restart, "service[#{service_name_variable}]", :immediately
+        #   end
+        #
+        class LegacyNotifySyntax < Base
+          extend AutoCorrector
+
+          MSG = 'Use the new-style notification syntax which allows you to notify resources defined later in a recipe or resource.'
+          RESTRICT_ON_SEND = [:notifies, :subscribes].freeze
+
+          def_node_matcher :legacy_notify?, <<-PATTERN
+            (send nil? ${:notifies :subscribes} $(sym _) (send nil? :resources (hash (pair $(sym _) $(...) ) ) ) $... )
+          PATTERN
+
+          def on_send(node)
+            legacy_notify?(node) do |notify_type, action, type, name, timing|
+              add_offense(node, severity: :warning) do |corrector|
+                service_value = case name.type
+                                when :str
+                                  "'#{type.source}[#{name.value}]'"
+                                when :dstr
+                                  "\"#{type.source}[#{name.value}]\""
+                                else
+                                  "\"#{type.source}[\#{#{name.source}}]\""
+                                end
+                new_val = +"#{notify_type} #{action.source}, #{service_value}"
+                new_val << ", #{timing.first.source}" unless timing.empty?
+                corrector.replace(node, new_val)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end