cookstyle 7.32.8 → 8.0.0

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

@@ -1,58 +1,58 @@
-# frozen_string_literal: true
-#
-# Copyright:: 2021, 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 Correctness
-        # metadata.rb cookbook dependencies and version constraints should be comma separated.
-        #
-        # @example
-        #
-        #   ### incorrect
-        #   depends 'some_awesome_cookbook' '= 4.5.5'
-        #   depends 'some_other_cool_cookbook' '< 8.0'
-        #
-        #   ### correct
-        #   depends 'some_awesome_cookbook', '= 4.5.5'
-        #   depends 'some_other_cool_cookbook', '< 8.0'
-        #
-        class MetadataMalformedDepends < Base
-          extend RuboCop::Cop::AutoCorrector
-
-          RESTRICT_ON_SEND = [:depends].freeze
-          MSG = 'metadata.rb cookbook dependencies and version constraints should be comma separated'
-
-          def_node_matcher :depends_without_comma?, <<-PATTERN
-            (send nil? :depends
-              (dstr
-                $(str _ )
-                $(str _ )))
-          PATTERN
-
-          def on_send(node)
-            depends_without_comma?(node) do |cb, ver|
-              add_offense(node, severity: :refactor) do |corrector|
-                corrector.replace(node, "depends '#{cb.value}', '#{ver.value}'")
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+#
+# Copyright:: 2021, 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 Correctness
+        # metadata.rb cookbook dependencies and version constraints should be comma separated.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   depends 'some_awesome_cookbook' '= 4.5.5'
+        #   depends 'some_other_cool_cookbook' '< 8.0'
+        #
+        #   ### correct
+        #   depends 'some_awesome_cookbook', '= 4.5.5'
+        #   depends 'some_other_cool_cookbook', '< 8.0'
+        #
+        class MetadataMalformedDepends < Base
+          extend RuboCop::Cop::AutoCorrector
+
+          RESTRICT_ON_SEND = [:depends].freeze
+          MSG = 'metadata.rb cookbook dependencies and version constraints should be comma separated'
+
+          def_node_matcher :depends_without_comma?, <<-PATTERN
+            (send nil? :depends
+              (dstr
+                $(str _ )
+                $(str _ )))
+          PATTERN
+
+          def on_send(node)
+            depends_without_comma?(node) do |cb, ver|
+              add_offense(node, severity: :refactor) do |corrector|
+                corrector.replace(node, "depends '#{cb.value}', '#{ver.value}'")
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,54 +1,54 @@
-# frozen_string_literal: true
-#
-# Copyright:: 2019-2021, 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 Correctness
-        # metadata.rb needs to include the name method or it will fail on Chef Infra Client 12 and later.
-        #
-        # @example
-        #
-        #   ### correct
-        #   name 'foo'
-        #
-        class MetadataMissingName < Base
-          extend AutoCorrector
-          include RangeHelp
-
-          MSG = 'metadata.rb needs to include the name method or it will fail on Chef Infra Client 12 and later.'
-
-          def_node_search :cb_name?, '(send nil? :name str ...)'
-
-          def on_new_investigation
-            # handle an empty metdata.rb file
-            return if processed_source.ast.nil?
-
-            # Using range similar to RuboCop::Cop::Naming::Filename (file_name.rb)
-            return if cb_name?(processed_source.ast)
-            range = source_range(processed_source.buffer, 1, 0)
-            add_offense(range, severity: :refactor) do |corrector|
-              path = processed_source.path
-              cb_name = File.basename(File.dirname(path))
-              corrector.insert_before(processed_source.ast, "name '#{cb_name}'\n")
-            end
-          end
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+#
+# Copyright:: 2019-2021, 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 Correctness
+        # metadata.rb needs to include the name method or it will fail on Chef Infra Client 12 and later.
+        #
+        # @example
+        #
+        #   ### correct
+        #   name 'foo'
+        #
+        class MetadataMissingName < Base
+          extend AutoCorrector
+          include RangeHelp
+
+          MSG = 'metadata.rb needs to include the name method or it will fail on Chef Infra Client 12 and later.'
+
+          def_node_search :cb_name?, '(send nil? :name str ...)'
+
+          def on_new_investigation
+            # handle an empty metdata.rb file
+            return if processed_source.ast.nil?
+
+            # Using range similar to RuboCop::Cop::Naming::Filename (file_name.rb)
+            return if cb_name?(processed_source.ast)
+            range = source_range(processed_source.buffer, 1, 0)
+            add_offense(range, severity: :refactor) do |corrector|
+              path = processed_source.path
+              cb_name = File.basename(File.dirname(path))
+              corrector.insert_before(processed_source.ast, "name '#{cb_name}'\n")
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,51 +1,51 @@
-# frozen_string_literal: true
-#
-# Copyright:: 2021, 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 Correctness
-        # metadata.rb should define a version for the cookbook.
-        #
-        # @example
-        #
-        #   ### correct
-        #   name 'foo'
-        #   version '1.0.0'
-        #
-        class MetadataMissingVersion < Base
-          extend AutoCorrector
-          include RangeHelp
-
-          MSG = 'metadata.rb should define a version for the cookbook.'
-
-          def_node_search :cb_version?, '(send nil? :version str ...)'
-
-          def on_new_investigation
-            # handle an empty metdata.rb file
-            return if processed_source.ast.nil?
-
-            # Using range similar to RuboCop::Cop::Naming::Filename (file_name.rb)
-            return if cb_version?(processed_source.ast)
-            range = source_range(processed_source.buffer, 1, 0)
-            add_offense(range, severity: :refactor)
-          end
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+#
+# Copyright:: 2021, 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 Correctness
+        # metadata.rb should define a version for the cookbook.
+        #
+        # @example
+        #
+        #   ### correct
+        #   name 'foo'
+        #   version '1.0.0'
+        #
+        class MetadataMissingVersion < Base
+          extend AutoCorrector
+          include RangeHelp
+
+          MSG = 'metadata.rb should define a version for the cookbook.'
+
+          def_node_search :cb_version?, '(send nil? :version str ...)'
+
+          def on_new_investigation
+            # handle an empty metdata.rb file
+            return if processed_source.ast.nil?
+
+            # Using range similar to RuboCop::Cop::Naming::Filename (file_name.rb)
+            return if cb_version?(processed_source.ast)
+            range = source_range(processed_source.buffer, 1, 0)
+            add_offense(range, severity: :refactor)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,53 +1,53 @@
-# frozen_string_literal: true
-#
-# Copyright:: Copyright 2019, Chef Software Inc.
-#
-# 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
-        # Normal attributes are discouraged since their semantics differ importantly from the default and override levels. Their values persist in the node object even after all code referencing them has been deleted, unlike default and override.
-        #
-        # Code should be updated to use default or override levels, but this will change attribute merging behavior so needs to be validated manually and force_default or force_override levels may need to be used in recipe code.
-        #
-        # @example
-        #
-        #   ### incorrect
-        #   node.normal['foo'] = true
-        #
-        #   ### correct
-        #   node.default['foo'] = true
-        #   node.override['foo'] = true
-        #   node.force_default['foo'] = true
-        #   node.force_override['foo'] = true
-        #
-        class NodeNormal < Base
-          MSG = 'Do not use node.normal. Replace with default/override/force_default/force_override attribute levels.'
-          RESTRICT_ON_SEND = [:normal].freeze
-
-          def_node_matcher :node_normal?, <<-PATTERN
-            (send (send _ :node) :normal)
-          PATTERN
-
-          def on_send(node)
-            node_normal?(node) do
-              add_offense(node, severity: :refactor)
-            end
-          end
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+#
+# Copyright:: Copyright 2019, Chef Software Inc.
+#
+# 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
+        # Normal attributes are discouraged since their semantics differ importantly from the default and override levels. Their values persist in the node object even after all code referencing them has been deleted, unlike default and override.
+        #
+        # Code should be updated to use default or override levels, but this will change attribute merging behavior so needs to be validated manually and force_default or force_override levels may need to be used in recipe code.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   node.normal['foo'] = true
+        #
+        #   ### correct
+        #   node.default['foo'] = true
+        #   node.override['foo'] = true
+        #   node.force_default['foo'] = true
+        #   node.force_override['foo'] = true
+        #
+        class NodeNormal < Base
+          MSG = 'Do not use node.normal. Replace with default/override/force_default/force_override attribute levels.'
+          RESTRICT_ON_SEND = [:normal].freeze
+
+          def_node_matcher :node_normal?, <<-PATTERN
+            (send (send _ :node) :normal)
+          PATTERN
+
+          def on_send(node)
+            node_normal?(node) do
+              add_offense(node, severity: :refactor)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,53 +1,53 @@
-# frozen_string_literal: true
-#
-# Copyright:: Copyright 2019, Chef Software Inc.
-#
-# 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
-        # Normal attributes are discouraged since their semantics differ importantly from the default and override levels. Their values persist in the node object even after all code referencing them has been deleted, unlike default and override.
-        #
-        # Code should be updated to use default or override levels, but this will change attribute merging behavior so needs to be validated manually and force_default or force_override levels may need to be used in recipe code.
-        #
-        # @example
-        #
-        #   ### incorrect
-        #   node.normal_unless['foo'] = true
-        #
-        #   ### correct
-        #   node.default_unless['foo'] = true
-        #   node.override_unless['foo'] = true
-        #   node.force_default_unless['foo'] = true
-        #   node.force_override_unless['foo'] = true
-        #
-        class NodeNormalUnless < Base
-          MSG = 'Do not use node.normal_unless. Replace with default/override/force_default/force_override attribute levels.'
-          RESTRICT_ON_SEND = [:normal_unless].freeze
-
-          def_node_matcher :node_normal_unless?, <<-PATTERN
-            (send (send _ :node) :normal_unless)
-          PATTERN
-
-          def on_send(node)
-            node_normal_unless?(node) do
-              add_offense(node, severity: :refactor)
-            end
-          end
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+#
+# Copyright:: Copyright 2019, Chef Software Inc.
+#
+# 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
+        # Normal attributes are discouraged since their semantics differ importantly from the default and override levels. Their values persist in the node object even after all code referencing them has been deleted, unlike default and override.
+        #
+        # Code should be updated to use default or override levels, but this will change attribute merging behavior so needs to be validated manually and force_default or force_override levels may need to be used in recipe code.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   node.normal_unless['foo'] = true
+        #
+        #   ### correct
+        #   node.default_unless['foo'] = true
+        #   node.override_unless['foo'] = true
+        #   node.force_default_unless['foo'] = true
+        #   node.force_override_unless['foo'] = true
+        #
+        class NodeNormalUnless < Base
+          MSG = 'Do not use node.normal_unless. Replace with default/override/force_default/force_override attribute levels.'
+          RESTRICT_ON_SEND = [:normal_unless].freeze
+
+          def_node_matcher :node_normal_unless?, <<-PATTERN
+            (send (send _ :node) :normal_unless)
+          PATTERN
+
+          def on_send(node)
+            node_normal_unless?(node) do
+              add_offense(node, severity: :refactor)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,46 +1,46 @@
-# 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 Correctness
-        # Don't use node.save to save partial node data to the Chef Infra Server mid-run unless it's a requirement of cookbook design that can't be avoided. Node.save can result in failed Chef Infra runs appearing in search and increases load on the Chef Infra Server."
-        #
-        # @example
-        #
-        #   ### incorrect
-        #   node.save
-        #
-        class CookbookUsesNodeSave < Base
-          MSG = "Don't use node.save to save partial node data to the Chef Infra Server mid-run unless it's absolutely necessary. Node.save can result in failed Chef Infra runs appearing in search and increases load on the Chef Infra Server."
-          RESTRICT_ON_SEND = [:save].freeze
-
-          def_node_matcher :node_save?, <<-PATTERN
-            (send (send nil? :node) :save)
-          PATTERN
-
-          def on_send(node)
-            node_save?(node) do
-              add_offense(node, severity: :refactor)
-            end
-          end
-        end
-      end
-    end
-  end
-end
+# 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 Correctness
+        # Don't use node.save to save partial node data to the Chef Infra Server mid-run unless it's a requirement of cookbook design that can't be avoided. Node.save can result in failed Chef Infra runs appearing in search and increases load on the Chef Infra Server."
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   node.save
+        #
+        class CookbookUsesNodeSave < Base
+          MSG = "Don't use node.save to save partial node data to the Chef Infra Server mid-run unless it's absolutely necessary. Node.save can result in failed Chef Infra runs appearing in search and increases load on the Chef Infra Server."
+          RESTRICT_ON_SEND = [:save].freeze
+
+          def_node_matcher :node_save?, <<-PATTERN
+            (send (send nil? :node) :save)
+          PATTERN
+
+          def on_send(node)
+            node_save?(node) do
+              add_offense(node, severity: :refactor)
+            end
+          end
+        end
+      end
+    end
+  end
+end