cookstyle 8.6.4 → 8.7.6

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

@@ -1,66 +1,66 @@
-# frozen_string_literal: true
-#
-# Copyright:: 2020, 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
-        # In Chef Infra Client 13 and later you must either specify an absolute path when using the `execute` resource's `creates` property or also use the `cwd` property.
-        #
-        # @example
-        #
-        #   # bad
-        #   execute 'some_cmd' do
-        #     creates 'something'
-        #   end
-        #
-        #   # good
-        #   execute 'some_cmd' do
-        #     creates '/tmp/something'
-        #   end
-        #
-        #   execute 'some_cmd' do
-        #     creates 'something'
-        #     cwd '/tmp/'
-        #   end
-        #
-        class ExecuteRelativeCreatesWithoutCwd < Base
-          include RuboCop::Chef::CookbookHelpers
-
-          MSG = "In Chef Infra Client 13 and later you must either specify an absolute path when using the `execute` resource's `creates` property or also use the `cwd` property."
-
-          def on_block(node)
-            match_property_in_resource?(:execute, 'creates', node) do |offense|
-              return unless offense.arguments.one? # we can only analyze simple string args
-              return unless offense.arguments.first.str_type? # we can only analyze simple string args
-
-              # skip any creates that are abs paths https://rubular.com/r/3TbDsgcAa1EaIF
-              return if offense.arguments.first.value.match?(%r{^(/|[a-zA-Z]:)})
-
-              # return if we have a cwd property
-              match_property_in_resource?(:execute, 'cwd', node) do
-                return
-              end
-
-              add_offense(offense, 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
+        # In Chef Infra Client 13 and later you must either specify an absolute path when using the `execute` resource's `creates` property or also use the `cwd` property.
+        #
+        # @example
+        #
+        #   # bad
+        #   execute 'some_cmd' do
+        #     creates 'something'
+        #   end
+        #
+        #   # good
+        #   execute 'some_cmd' do
+        #     creates '/tmp/something'
+        #   end
+        #
+        #   execute 'some_cmd' do
+        #     creates 'something'
+        #     cwd '/tmp/'
+        #   end
+        #
+        class ExecuteRelativeCreatesWithoutCwd < Base
+          include RuboCop::Chef::CookbookHelpers
+
+          MSG = "In Chef Infra Client 13 and later you must either specify an absolute path when using the `execute` resource's `creates` property or also use the `cwd` property."
+
+          def on_block(node)
+            match_property_in_resource?(:execute, 'creates', node) do |offense|
+              return unless offense.arguments.one? # we can only analyze simple string args
+              return unless offense.arguments.first.str_type? # we can only analyze simple string args
+
+              # skip any creates that are abs paths https://rubular.com/r/3TbDsgcAa1EaIF
+              return if offense.arguments.first.value.match?(%r{^(/|[a-zA-Z]:)})
+
+              # return if we have a cwd property
+              match_property_in_resource?(:execute, 'cwd', node) do
+                return
+              end
+
+              add_offense(offense, severity: :warning)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,41 +1,41 @@
-# frozen_string_literal: true
-#
-# Copyright:: 2022, 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 Foodcritic cookbook linter has been deprecated and should no longer be used for validating cookbooks. Do not include the `.foodcritic` config file used by Foodcritic in your cookbooks.
-        #
-        class FoodcriticFile < Base
-          include RangeHelp
-
-          MSG = 'Do not include the `.foodcritic` config file for the deprecated Foodcritic cookbook linter.'
-
-          def on_new_investigation
-            return unless processed_source.path.end_with?('.foodcritic')
-
-            # Using range similar to RuboCop::Cop::Naming::Filename (file_name.rb)
-            range = source_range(processed_source.buffer, 1, 0)
-
-            add_offense(range, severity: :warning)
-          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 Foodcritic cookbook linter has been deprecated and should no longer be used for validating cookbooks. Do not include the `.foodcritic` config file used by Foodcritic in your cookbooks.
+        #
+        class FoodcriticFile < Base
+          include RangeHelp
+
+          MSG = 'Do not include the `.foodcritic` config file for the deprecated Foodcritic cookbook linter.'
+
+          def on_new_investigation
+            return unless processed_source.path.end_with?('.foodcritic')
+
+            # Using range similar to RuboCop::Cop::Naming::Filename (file_name.rb)
+            range = source_range(processed_source.buffer, 1, 0)
+
+            add_offense(range, severity: :warning)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,43 +1,43 @@
-# frozen_string_literal: true
-#
-# Copyright:: 2020, 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 Foodcritic cookbook linter has been deprecated and should no longer be used for validating cookbooks.
-        #
-        # @example
-        #
-        #   # bad
-        #   gem 'foodcritic'
-        #   require 'foodcritic'
-        #
-        class FoodcriticTesting < Base
-          MSG = 'The Foodcritic cookbook linter has been deprecated and should no longer be used for validating cookbooks.'
-          RESTRICT_ON_SEND = [:require, :gem].freeze
-
-          def on_send(node)
-            return unless node.arguments.first == s(:str, 'foodcritic')
-
-            add_offense(node, severity: :warning)
-          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 Foodcritic cookbook linter has been deprecated and should no longer be used for validating cookbooks.
+        #
+        # @example
+        #
+        #   # bad
+        #   gem 'foodcritic'
+        #   require 'foodcritic'
+        #
+        class FoodcriticTesting < Base
+          MSG = 'The Foodcritic cookbook linter has been deprecated and should no longer be used for validating cookbooks.'
+          RESTRICT_ON_SEND = [:require, :gem].freeze
+
+          def on_send(node)
+            return unless node.arguments.first == s(:str, 'foodcritic')
+
+            add_offense(node, severity: :warning)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,136 +1,136 @@
-# 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 16 and later a legacy HWRP resource must use `provides` to define how the resource is called in recipes or other resources. To maintain compatibility with Chef Infra Client < 16 use both `resource_name` and `provides`.
-        #
-        # @example
-        #
-        #   # bad
-        #   class Chef
-        #     class Resource
-        #       class UlimitRule < Chef::Resource
-        #         property :type, [Symbol, String], required: true
-        #         property :item, [Symbol, String], required: true
-        #
-        #         # additional resource code
-        #       end
-        #     end
-        #   end
-        #
-        #   # bad
-        #   class Chef
-        #     class Resource
-        #       class UlimitRule < Chef::Resource
-        #         resource_name :ulimit_rule
-        #
-        #         property :type, [Symbol, String], required: true
-        #         property :item, [Symbol, String], required: true
-        #
-        #         # additional resource code
-        #       end
-        #     end
-        #   end
-        #
-        #   # good when Chef Infra Client < 15 (but compatible with 16+ as well)
-        #   class Chef
-        #     class Resource
-        #       class UlimitRule < Chef::Resource
-        #         resource_name :ulimit_rule
-        #         provides :ulimit_rule
-        #
-        #         property :type, [Symbol, String], required: true
-        #         property :item, [Symbol, String], required: true
-        #
-        #         # additional resource code
-        #       end
-        #     end
-        #   end
-        #
-        #   # good when Chef Infra Client 16+
-        #   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
-        #
-        #  # better
-        #  Convert your legacy HWRPs to custom resources
-        #
-        class HWRPWithoutProvides < Base
-          extend AutoCorrector
-
-          MSG = 'In Chef Infra Client 16 and later a legacy HWRP resource must use `provides` to define how the resource is called in recipes or other resources. To maintain compatibility with Chef Infra Client < 16 use both `resource_name` and `provides`.'
-
-          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 :provides, '(send nil? :provides (sym $_) ...)'
-          def_node_search :resource_name_ast, '$(send nil? :resource_name ...)'
-          def_node_search :resource_name, '(send nil? :resource_name (sym $_))'
-
-          def on_class(node)
-            return if has_provides?
-            HWRP?(node) do |inherit|
-              add_offense(inherit, severity: :warning) do |corrector|
-                resource_name_ast(node) do |ast_match|
-                  # build a new string to add after that includes the new line and the proper indentation
-                  new_string = "\n" + ast_match.source.dup.gsub('resource_name', 'provides').prepend(' ' * indentation(ast_match))
-                  corrector.insert_after(ast_match.source_range, new_string)
-                end
-              end
-            end
-          end
-
-          def has_provides?
-            provides_ast = provides(processed_source.ast)
-            return false if provides_ast.none?
-
-            resource_ast = resource_name(processed_source.ast)
-
-            # if no resource ast then resource_name, but not provides
-            # else make sure the provides matches the resource name
-            resource_ast.none? || provides_ast.include?(resource_ast.first)
-          end
-
-          def indentation(node)
-            node.source_range.source_line =~ /\S/
-          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 16 and later a legacy HWRP resource must use `provides` to define how the resource is called in recipes or other resources. To maintain compatibility with Chef Infra Client < 16 use both `resource_name` and `provides`.
+        #
+        # @example
+        #
+        #   # bad
+        #   class Chef
+        #     class Resource
+        #       class UlimitRule < Chef::Resource
+        #         property :type, [Symbol, String], required: true
+        #         property :item, [Symbol, String], required: true
+        #
+        #         # additional resource code
+        #       end
+        #     end
+        #   end
+        #
+        #   # bad
+        #   class Chef
+        #     class Resource
+        #       class UlimitRule < Chef::Resource
+        #         resource_name :ulimit_rule
+        #
+        #         property :type, [Symbol, String], required: true
+        #         property :item, [Symbol, String], required: true
+        #
+        #         # additional resource code
+        #       end
+        #     end
+        #   end
+        #
+        #   # good when Chef Infra Client < 15 (but compatible with 16+ as well)
+        #   class Chef
+        #     class Resource
+        #       class UlimitRule < Chef::Resource
+        #         resource_name :ulimit_rule
+        #         provides :ulimit_rule
+        #
+        #         property :type, [Symbol, String], required: true
+        #         property :item, [Symbol, String], required: true
+        #
+        #         # additional resource code
+        #       end
+        #     end
+        #   end
+        #
+        #   # good when Chef Infra Client 16+
+        #   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
+        #
+        #  # better
+        #  Convert your legacy HWRPs to custom resources
+        #
+        class HWRPWithoutProvides < Base
+          extend AutoCorrector
+
+          MSG = 'In Chef Infra Client 16 and later a legacy HWRP resource must use `provides` to define how the resource is called in recipes or other resources. To maintain compatibility with Chef Infra Client < 16 use both `resource_name` and `provides`.'
+
+          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 :provides, '(send nil? :provides (sym $_) ...)'
+          def_node_search :resource_name_ast, '$(send nil? :resource_name ...)'
+          def_node_search :resource_name, '(send nil? :resource_name (sym $_))'
+
+          def on_class(node)
+            return if has_provides?
+            HWRP?(node) do |inherit|
+              add_offense(inherit, severity: :warning) do |corrector|
+                resource_name_ast(node) do |ast_match|
+                  # build a new string to add after that includes the new line and the proper indentation
+                  new_string = "\n" + ast_match.source.dup.gsub('resource_name', 'provides').prepend(' ' * indentation(ast_match))
+                  corrector.insert_after(ast_match.source_range, new_string)
+                end
+              end
+            end
+          end
+
+          def has_provides?
+            provides_ast = provides(processed_source.ast)
+            return false if provides_ast.none?
+
+            resource_ast = resource_name(processed_source.ast)
+
+            # if no resource ast then resource_name, but not provides
+            # else make sure the provides matches the resource name
+            resource_ast.none? || provides_ast.include?(resource_ast.first)
+          end
+
+          def indentation(node)
+            node.source_range.source_line =~ /\S/
+          end
+        end
+      end
+    end
+  end
+end