cookstyle 8.6.4 → 8.7.6

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

@@ -1,56 +1,56 @@
-# frozen_string_literal: true
-#
-# Copyright:: 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 Modernize
-        # When using properties in a custom resource you should use name_property not the legacy name_attribute from the days of attributes
-        #
-        # @example
-        #
-        #   # bad
-        #   property :bob, String, name_attribute: true
-        #
-        #   # good
-        #   property :bob, String, name_property: true
-        #
-        class PropertyWithNameAttribute < Base
-          extend AutoCorrector
-
-          MSG = 'Resource property sets name_attribute instead of name_property'
-          RESTRICT_ON_SEND = [:property].freeze
-
-          # match on a property that has any name and any type and a hash that
-          # contains name_attribute true. The hash pairs are wrapped in
-          # <> which means the order doesn't matter in the hash.
-          def_node_matcher :property_with_name_attribute?, <<-PATTERN
-            (send nil? :property (sym _) ... (hash <$(pair (sym :name_attribute) (true)) ...>))
-          PATTERN
-
-          def on_send(node)
-            property_with_name_attribute?(node) do |name_attribute|
-              add_offense(node, severity: :refactor) do |corrector|
-                corrector.replace(name_attribute, 'name_property: true')
-              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 Modernize
+        # When using properties in a custom resource you should use name_property not the legacy name_attribute from the days of attributes
+        #
+        # @example
+        #
+        #   # bad
+        #   property :bob, String, name_attribute: true
+        #
+        #   # good
+        #   property :bob, String, name_property: true
+        #
+        class PropertyWithNameAttribute < Base
+          extend AutoCorrector
+
+          MSG = 'Resource property sets name_attribute instead of name_property'
+          RESTRICT_ON_SEND = [:property].freeze
+
+          # match on a property that has any name and any type and a hash that
+          # contains name_attribute true. The hash pairs are wrapped in
+          # <> which means the order doesn't matter in the hash.
+          def_node_matcher :property_with_name_attribute?, <<-PATTERN
+            (send nil? :property (sym _) ... (hash <$(pair (sym :name_attribute) (true)) ...>))
+          PATTERN
+
+          def on_send(node)
+            property_with_name_attribute?(node) do |name_attribute|
+              add_offense(node, severity: :refactor) do |corrector|
+                corrector.replace(name_attribute, 'name_property: true')
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,68 +1,68 @@
-# 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 Modernize
-        # Provides should be set using the `provides` resource DSL method instead of setting @provides in the initialize method.
-        #
-        # @example
-        #
-        #   # bad
-        #   def initialize(*args)
-        #     super
-        #     @provides = :foo
-        #   end
-        #
-        #   # good
-        #   provides :foo
-        #
-        class ProvidesFromInitialize < Base
-          include RangeHelp
-          extend AutoCorrector
-
-          MSG = 'Provides should be set using the `provides` resource DSL method instead of setting @provides in the initialize method.'
-
-          def_node_matcher :provides_assignment?, <<-PATTERN
-            (ivasgn :@provides $(sym ...))
-          PATTERN
-
-          def on_ivasgn(node)
-            provides_assignment?(node) do
-              return unless initialize_method(node.parent.parent).any?
-              add_offense(node, severity: :refactor) do |corrector|
-                # insert the new provides call above the initialize method, but not if one already exists (this is sadly common)
-                unless provides_method?(processed_source.ast)
-                  initialize_node = initialize_method(processed_source.ast).first
-                  corrector.insert_before(initialize_node.source_range, "provides #{node.descendants.first.source}\n\n")
-                end
-
-                # remove the variable from the initialize method
-                corrector.remove(range_with_surrounding_space(range: node.loc.expression, side: :left))
-              end
-            end
-          end
-
-          def_node_search :provides_method?, '(send nil? :provides ... )'
-
-          def_node_search :initialize_method, '(def :initialize ... )'
-        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 Modernize
+        # Provides should be set using the `provides` resource DSL method instead of setting @provides in the initialize method.
+        #
+        # @example
+        #
+        #   # bad
+        #   def initialize(*args)
+        #     super
+        #     @provides = :foo
+        #   end
+        #
+        #   # good
+        #   provides :foo
+        #
+        class ProvidesFromInitialize < Base
+          include RangeHelp
+          extend AutoCorrector
+
+          MSG = 'Provides should be set using the `provides` resource DSL method instead of setting @provides in the initialize method.'
+
+          def_node_matcher :provides_assignment?, <<-PATTERN
+            (ivasgn :@provides $(sym ...))
+          PATTERN
+
+          def on_ivasgn(node)
+            provides_assignment?(node) do
+              return unless initialize_method(node.parent.parent).any?
+              add_offense(node, severity: :refactor) do |corrector|
+                # insert the new provides call above the initialize method, but not if one already exists (this is sadly common)
+                unless provides_method?(processed_source.ast)
+                  initialize_node = initialize_method(processed_source.ast).first
+                  corrector.insert_before(initialize_node.source_range, "provides #{node.descendants.first.source}\n\n")
+                end
+
+                # remove the variable from the initialize method
+                corrector.remove(range_with_surrounding_space(range: node.loc.expression, side: :left))
+              end
+            end
+          end
+
+          def_node_search :provides_method?, '(send nil? :provides ... )'
+
+          def_node_search :initialize_method, '(def :initialize ... )'
+        end
+      end
+    end
+  end
+end

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

@@ -1,63 +1,63 @@
-# 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 Modernize
-        # The resource name can now be specified using the `resource_name` helper instead of using the @resource_name variable in the resource provider initialize method. In general we recommend against writing HWRPs, but if HWRPs are necessary you should utilize as much of the resource DSL as possible.
-        #
-        # @example
-        #
-        #   # bad
-        #   def initialize(*args)
-        #     super
-        #     @resource_name = :foo
-        #   end
-        #
-        #   # good
-        #   resource_name :foo
-
-        class ResourceNameFromInitialize < Base
-          extend AutoCorrector
-          include RangeHelp
-
-          MSG = 'The name of a resource can be set with the "resource_name" helper instead of using the initialize method.'
-
-          def on_def(node)
-            return unless node.method?(:initialize)
-            return if node.body.nil? # nil body is an empty initialize method
-
-            node.body.each_node do |x|
-              next unless x.assignment? && !x.node_parts.empty? && x.node_parts.first == :@resource_name
-
-              add_offense(x, severity: :refactor) do |corrector|
-                # insert the new resource_name call above the initialize method
-                initialize_node = initialize_method(processed_source.ast).first
-                corrector.insert_before(initialize_node.source_range, "resource_name #{x.descendants.first.source}\n\n")
-                # remove the variable from the initialize method
-                corrector.remove(range_with_surrounding_space(range: x.loc.expression, side: :left))
-              end
-            end
-          end
-
-          def_node_search :initialize_method, '(def :initialize ... )'
-        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 Modernize
+        # The resource name can now be specified using the `resource_name` helper instead of using the @resource_name variable in the resource provider initialize method. In general we recommend against writing HWRPs, but if HWRPs are necessary you should utilize as much of the resource DSL as possible.
+        #
+        # @example
+        #
+        #   # bad
+        #   def initialize(*args)
+        #     super
+        #     @resource_name = :foo
+        #   end
+        #
+        #   # good
+        #   resource_name :foo
+
+        class ResourceNameFromInitialize < Base
+          extend AutoCorrector
+          include RangeHelp
+
+          MSG = 'The name of a resource can be set with the "resource_name" helper instead of using the initialize method.'
+
+          def on_def(node)
+            return unless node.method?(:initialize)
+            return if node.body.nil? # nil body is an empty initialize method
+
+            node.body.each_node do |x|
+              next unless x.assignment? && !x.node_parts.empty? && x.node_parts.first == :@resource_name
+
+              add_offense(x, severity: :refactor) do |corrector|
+                # insert the new resource_name call above the initialize method
+                initialize_node = initialize_method(processed_source.ast).first
+                corrector.insert_before(initialize_node.source_range, "resource_name #{x.descendants.first.source}\n\n")
+                # remove the variable from the initialize method
+                corrector.remove(range_with_surrounding_space(range: x.loc.expression, side: :left))
+              end
+            end
+          end
+
+          def_node_search :initialize_method, '(def :initialize ... )'
+        end
+      end
+    end
+  end
+end

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

@@ -1,49 +1,49 @@
-# 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 Modernize
-        # set_or_return within a method should not be used to define a property in a resource. Instead use the property method which properly validates and defines properties in a way that works with reporting and documentation functionality in Chef Infra Client
-        #
-        # @example
-        #
-        #   # bad
-        #    def severity(arg = nil)
-        #      set_or_return(
-        #        :severity, arg,
-        #        :kind_of => String,
-        #        :default => nil
-        #      )
-        #    end
-        #
-        #   # good
-        #   property :severity, String
-        #
-        class SetOrReturnInResources < Base
-          MSG = 'Do not use set_or_return within a method to define a property for a resource. Use the property method instead, which supports validation, reporting, and documentation functionality'
-          RESTRICT_ON_SEND = [:set_or_return].freeze
-
-          def on_send(node)
-            add_offense(node, severity: :refactor)
-          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 Modernize
+        # set_or_return within a method should not be used to define a property in a resource. Instead use the property method which properly validates and defines properties in a way that works with reporting and documentation functionality in Chef Infra Client
+        #
+        # @example
+        #
+        #   # bad
+        #    def severity(arg = nil)
+        #      set_or_return(
+        #        :severity, arg,
+        #        :kind_of => String,
+        #        :default => nil
+        #      )
+        #    end
+        #
+        #   # good
+        #   property :severity, String
+        #
+        class SetOrReturnInResources < Base
+          MSG = 'Do not use set_or_return within a method to define a property for a resource. Use the property method instead, which supports validation, reporting, and documentation functionality'
+          RESTRICT_ON_SEND = [:set_or_return].freeze
+
+          def on_send(node)
+            add_offense(node, severity: :refactor)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,66 +1,66 @@
-# 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 Modernize
-        # In HWRPs and LWRPs you defined attributes, but custom resources changed the name to be properties to avoid confusion with chef recipe attributes. When writing a custom resource they should be called properties even though the two are aliased.
-        #
-        # @example
-        #
-        #   # bad
-        #   attribute :something, String
-        #
-        #   action :create do
-        #     # some action code because we're in a custom resource
-        #   end
-        #
-        #   # good
-        #   property :something, String
-        #
-        #   action :create do
-        #     # some action code because we're in a custom resource
-        #   end
-        #
-        class CustomResourceWithAttributes < Base
-          extend AutoCorrector
-
-          MSG = 'Custom Resources should contain properties not attributes'
-          RESTRICT_ON_SEND = [:attribute].freeze
-
-          def_node_matcher :attribute?, <<-PATTERN
-            (send nil? $:attribute ... )
-          PATTERN
-
-          def_node_search :resource_actions?, <<-PATTERN
-            (block (send nil? :action ... ) ... )
-          PATTERN
-
-          def on_send(node)
-            return unless resource_actions?(processed_source.ast)
-            attribute?(node) do
-              add_offense(node.loc.selector, severity: :refactor) do |corrector|
-                corrector.replace(node.loc.selector, 'property')
-              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 Modernize
+        # In HWRPs and LWRPs you defined attributes, but custom resources changed the name to be properties to avoid confusion with chef recipe attributes. When writing a custom resource they should be called properties even though the two are aliased.
+        #
+        # @example
+        #
+        #   # bad
+        #   attribute :something, String
+        #
+        #   action :create do
+        #     # some action code because we're in a custom resource
+        #   end
+        #
+        #   # good
+        #   property :something, String
+        #
+        #   action :create do
+        #     # some action code because we're in a custom resource
+        #   end
+        #
+        class CustomResourceWithAttributes < Base
+          extend AutoCorrector
+
+          MSG = 'Custom Resources should contain properties not attributes'
+          RESTRICT_ON_SEND = [:attribute].freeze
+
+          def_node_matcher :attribute?, <<-PATTERN
+            (send nil? $:attribute ... )
+          PATTERN
+
+          def_node_search :resource_actions?, <<-PATTERN
+            (block (send nil? :action ... ) ... )
+          PATTERN
+
+          def on_send(node)
+            return unless resource_actions?(processed_source.ast)
+            attribute?(node) do
+              add_offense(node.loc.selector, severity: :refactor) do |corrector|
+                corrector.replace(node.loc.selector, 'property')
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end