cookstyle 7.32.8 → 8.1.1

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

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

@@ -1,64 +1,64 @@
-# 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 Correctness
-        # When notifying or subscribing actions within a resource the action should always be a symbol. In Chef Infra Client releases before 14.0, this may result in double notification.
-        #
-        # @example
-        #
-        #   ### incorrect
-        #   execute 'some command' do
-        #     notifies 'restart', 'service[httpd]', 'delayed'
-        #   end
-        #
-        #   execute 'some command' do
-        #     subscribes 'restart', 'service[httpd]', 'delayed'
-        #   end
-        #
-        #   ### correct
-        #   execute 'some command' do
-        #     notifies :restart, 'service[httpd]', 'delayed'
-        #   end
-        #
-        #   execute 'some command' do
-        #     subscribes :restart, 'service[httpd]', 'delayed'
-        #   end
-        #
-        class NotifiesActionNotSymbol < Base
-          include RuboCop::Chef::CookbookHelpers
-          extend AutoCorrector
-
-          MSG = 'Resource notification and subscription actions should be symbols not strings.'
-
-          def on_block(node)
-            match_property_in_resource?(nil, %w(notifies subscribes), node) do |notifies_property|
-              return unless notifies_property.node_parts[2].str_type?
-
-              add_offense(notifies_property, severity: :refactor) do |corrector|
-                corrector.replace(notifies_property.first_argument,
-                  ":#{notifies_property.node_parts[2].value}")
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end
+# 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 Correctness
+        # When notifying or subscribing actions within a resource the action should always be a symbol. In Chef Infra Client releases before 14.0, this may result in double notification.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   execute 'some command' do
+        #     notifies 'restart', 'service[httpd]', 'delayed'
+        #   end
+        #
+        #   execute 'some command' do
+        #     subscribes 'restart', 'service[httpd]', 'delayed'
+        #   end
+        #
+        #   ### correct
+        #   execute 'some command' do
+        #     notifies :restart, 'service[httpd]', 'delayed'
+        #   end
+        #
+        #   execute 'some command' do
+        #     subscribes :restart, 'service[httpd]', 'delayed'
+        #   end
+        #
+        class NotifiesActionNotSymbol < Base
+          include RuboCop::Chef::CookbookHelpers
+          extend AutoCorrector
+
+          MSG = 'Resource notification and subscription actions should be symbols not strings.'
+
+          def on_block(node)
+            match_property_in_resource?(nil, %w(notifies subscribes), node) do |notifies_property|
+              return unless notifies_property.node_parts[2].str_type?
+
+              add_offense(notifies_property, severity: :refactor) do |corrector|
+                corrector.replace(notifies_property.first_argument,
+                  ":#{notifies_property.node_parts[2].value}")
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,48 +1,48 @@
-# frozen_string_literal: true
-#
-# Copyright:: 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 Correctness
-        # Don't represent file modes as Strings containing octal values.
-        #
-        # @example
-        #
-        #   ### incorrect
-        #   file '/etc/some_file' do
-        #     mode '0o755'
-        #   end
-        #
-        #   ### correct
-        #   file '/etc/some_file' do
-        #     mode '0755'
-        #   end
-        #
-        class OctalModeAsString < Base
-          MSG = "Don't represent file modes as strings containing octal values. Use standard base 10 file modes instead. For example: '0755'."
-          RESTRICT_ON_SEND = [:mode].freeze
-
-          def on_send(node)
-            return unless node.arguments.first&.str_type? && node.arguments.first.value.match?(/^0o/)
-            add_offense(node, severity: :refactor)
-          end
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+#
+# Copyright:: 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 Correctness
+        # Don't represent file modes as Strings containing octal values.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   file '/etc/some_file' do
+        #     mode '0o755'
+        #   end
+        #
+        #   ### correct
+        #   file '/etc/some_file' do
+        #     mode '0755'
+        #   end
+        #
+        class OctalModeAsString < Base
+          MSG = "Don't represent file modes as strings containing octal values. Use standard base 10 file modes instead. For example: '0755'."
+          RESTRICT_ON_SEND = [:mode].freeze
+
+          def on_send(node)
+            return unless node.arguments.first&.str_type? && node.arguments.first.value.match?(/^0o/)
+            add_offense(node, severity: :refactor)
+          end
+        end
+      end
+    end
+  end
+end