cookstyle 7.32.8 → 8.0.0

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

@@ -1,48 +1,48 @@
-# 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
-        # Cookbook metadata.rb version field should follow X.Y.Z version format.
-        #
-        # @example
-        #
-        #   ### incorrect
-        #   version '1.2.3.4'
-        #
-        #   ### correct
-        #   version '1.2.3'
-        #
-        class InvalidVersionMetadata < Base
-          MSG = 'Cookbook metadata.rb version field should follow X.Y.Z version format.'
-          RESTRICT_ON_SEND = [:version].freeze
-
-          def_node_matcher :version?, '(send nil? :version $str ...)'
-
-          def on_send(node)
-            version?(node) do |ver|
-              next if /\A\d+\.\d+(\.\d+)?\z/.match?(ver.value) # entirely borrowed from Foodcritic.
-              add_offense(ver, severity: :refactor)
-            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
+        # Cookbook metadata.rb version field should follow X.Y.Z version format.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   version '1.2.3.4'
+        #
+        #   ### correct
+        #   version '1.2.3'
+        #
+        class InvalidVersionMetadata < Base
+          MSG = 'Cookbook metadata.rb version field should follow X.Y.Z version format.'
+          RESTRICT_ON_SEND = [:version].freeze
+
+          def_node_matcher :version?, '(send nil? :version $str ...)'
+
+          def on_send(node)
+            version?(node) do |ver|
+              next if /\A\d+\.\d+(\.\d+)?\z/.match?(ver.value) # entirely borrowed from Foodcritic.
+              add_offense(ver, severity: :refactor)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,53 +1,53 @@
-# 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 Correctness
-        # When setting a node attribute as the default value for a custom resource property, wrap the node attribute in `lazy {}` so that its value is available when the resource executes.
-        #
-        # @example
-        #
-        #   ### incorrect
-        #   property :Something, String, default: node['hostname']
-        #
-        #   ### correct
-        #   property :Something, String, default: lazy { node['hostname'] }
-        #
-        class LazyEvalNodeAttributeDefaults < Base
-          extend AutoCorrector
-          include RuboCop::Chef::CookbookHelpers
-
-          MSG = 'When setting a node attribute as the default value for a custom resource property, wrap the node attribute in `lazy {}` so that its value is available when the resource executes.'
-
-          def_node_matcher :non_lazy_node_attribute_default?, <<-PATTERN
-            (send nil? :property (sym _) ... (hash <(pair (sym :default) $(send (send _ :node) :[] _) ) ...>))
-          PATTERN
-
-          def on_send(node)
-            non_lazy_node_attribute_default?(node) do |default|
-              add_offense(default, severity: :refactor) do |corrector|
-                corrector.replace(default, "lazy { #{default.source} }")
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end
+# 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 Correctness
+        # When setting a node attribute as the default value for a custom resource property, wrap the node attribute in `lazy {}` so that its value is available when the resource executes.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   property :Something, String, default: node['hostname']
+        #
+        #   ### correct
+        #   property :Something, String, default: lazy { node['hostname'] }
+        #
+        class LazyEvalNodeAttributeDefaults < Base
+          extend AutoCorrector
+          include RuboCop::Chef::CookbookHelpers
+
+          MSG = 'When setting a node attribute as the default value for a custom resource property, wrap the node attribute in `lazy {}` so that its value is available when the resource executes.'
+
+          def_node_matcher :non_lazy_node_attribute_default?, <<-PATTERN
+            (send nil? :property (sym _) ... (hash <(pair (sym :default) $(send (send _ :node) :[] _) ) ...>))
+          PATTERN
+
+          def on_send(node)
+            non_lazy_node_attribute_default?(node) do |default|
+              add_offense(default, severity: :refactor) do |corrector|
+                corrector.replace(default, "lazy { #{default.source} }")
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,67 +1,67 @@
-# 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
-        # Using `lazy {}` within a resource guard (not_if/only_if) will cause failures and is unnecessary as resource guards are always lazily evaluated.
-        #
-        # @example
-        #
-        #   ### incorrect
-        #   template '/etc/foo' do
-        #     mode '0644'
-        #     source 'foo.erb'
-        #     only_if { lazy { ::File.exist?('/etc/foo')} }
-        #   end
-        #
-        #   ### correct
-        #   template '/etc/foo' do
-        #     mode '0644'
-        #     source 'foo.erb'
-        #     only_if { ::File.exist?('/etc/foo') }
-        #   end
-        #
-        class LazyInResourceGuard < Base
-          extend AutoCorrector
-
-          MSG = 'Using `lazy {}` within a resource guard (not_if/only_if) will cause failures and is unnecessary as resource guards are always lazily evaluated.'
-
-          def_node_matcher :lazy_in_guard?, <<-PATTERN
-            (block
-              (send nil? ${:not_if :only_if})
-              (args)
-              (block
-                (send nil? :lazy)
-                (args)
-                $(...)
-             ))
-          PATTERN
-
-          def on_block(node)
-            lazy_in_guard?(node) do |type, code|
-              add_offense(node, severity: :refactor) do |corrector|
-                corrector.replace(node, "#{type} { #{code.source} }")
-              end
-            end
-          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
+        # Using `lazy {}` within a resource guard (not_if/only_if) will cause failures and is unnecessary as resource guards are always lazily evaluated.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   template '/etc/foo' do
+        #     mode '0644'
+        #     source 'foo.erb'
+        #     only_if { lazy { ::File.exist?('/etc/foo')} }
+        #   end
+        #
+        #   ### correct
+        #   template '/etc/foo' do
+        #     mode '0644'
+        #     source 'foo.erb'
+        #     only_if { ::File.exist?('/etc/foo') }
+        #   end
+        #
+        class LazyInResourceGuard < Base
+          extend AutoCorrector
+
+          MSG = 'Using `lazy {}` within a resource guard (not_if/only_if) will cause failures and is unnecessary as resource guards are always lazily evaluated.'
+
+          def_node_matcher :lazy_in_guard?, <<-PATTERN
+            (block
+              (send nil? ${:not_if :only_if})
+              (args)
+              (block
+                (send nil? :lazy)
+                (args)
+                $(...)
+             ))
+          PATTERN
+
+          def on_block(node)
+            lazy_in_guard?(node) do |type, code|
+              add_offense(node, severity: :refactor) do |corrector|
+                corrector.replace(node, "#{type} { #{code.source} }")
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,67 +1,67 @@
-# 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
-        # The macos_userdefaults resource prior to Chef Infra Client 16.3 would silently continue if invalid types were passed resulting in unexpected behavior. Valid values are: "array", "bool", "dict", "float", "int", and "string".
-        #
-        # @example
-        #
-        #   ### incorrect
-        #   macos_userdefaults 'set a value' do
-        #     global true
-        #     key 'key'
-        #     type 'boolean'
-        #   end
-        #
-        #   ### correct
-        #   macos_userdefaults 'set a value' do
-        #     global true
-        #     key 'key'
-        #     type 'bool'
-        #   end
-        #
-        class MacosUserdefaultsInvalidType < Base
-          include RuboCop::Chef::CookbookHelpers
-          extend RuboCop::Cop::AutoCorrector
-
-          VALID_VALUES = %w(array bool dict float int string).freeze
-          INVALID_VALUE_MAP = {
-            'boolean' => 'bool',
-            'str' => 'string',
-            'integer' => 'int',
-          }.freeze
-
-          MSG = 'The macos_userdefaults resource prior to Chef Infra Client 16.3 would silently continue if invalid types were passed resulting in unexpected behavior. Valid values are: "array", "bool", "dict", "float", "int", and "string".'
-
-          def on_block(node)
-            match_property_in_resource?(:macos_userdefaults, 'type', node) do |type|
-              type_val = method_arg_ast_to_string(type)
-              return if VALID_VALUES.include?(type_val)
-              add_offense(type, severity: :refactor) do |corrector|
-                next unless INVALID_VALUE_MAP[type_val]
-                corrector.replace(type, "type '#{INVALID_VALUE_MAP[type_val]}'")
-              end
-            end
-          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
+        # The macos_userdefaults resource prior to Chef Infra Client 16.3 would silently continue if invalid types were passed resulting in unexpected behavior. Valid values are: "array", "bool", "dict", "float", "int", and "string".
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   macos_userdefaults 'set a value' do
+        #     global true
+        #     key 'key'
+        #     type 'boolean'
+        #   end
+        #
+        #   ### correct
+        #   macos_userdefaults 'set a value' do
+        #     global true
+        #     key 'key'
+        #     type 'bool'
+        #   end
+        #
+        class MacosUserdefaultsInvalidType < Base
+          include RuboCop::Chef::CookbookHelpers
+          extend RuboCop::Cop::AutoCorrector
+
+          VALID_VALUES = %w(array bool dict float int string).freeze
+          INVALID_VALUE_MAP = {
+            'boolean' => 'bool',
+            'str' => 'string',
+            'integer' => 'int',
+          }.freeze
+
+          MSG = 'The macos_userdefaults resource prior to Chef Infra Client 16.3 would silently continue if invalid types were passed resulting in unexpected behavior. Valid values are: "array", "bool", "dict", "float", "int", and "string".'
+
+          def on_block(node)
+            match_property_in_resource?(:macos_userdefaults, 'type', node) do |type|
+              type_val = method_arg_ast_to_string(type)
+              return if VALID_VALUES.include?(type_val)
+              add_offense(type, severity: :refactor) do |corrector|
+                next unless INVALID_VALUE_MAP[type_val]
+                corrector.replace(type, "type '#{INVALID_VALUE_MAP[type_val]}'")
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,67 +1,67 @@
-# 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
-        # When using the value_for_platform helper you must include a hash of possible platforms where each platform contains a hash of versions and potential values. If you don't wish to match on a particular version you can instead use the key 'default'.
-        #
-        # @example
-        #
-        #   ### incorrect
-        #   value_for_platform(
-        #     %w(redhat oracle) => 'baz'
-        #   )
-        #
-        #   ### correct
-        #   value_for_platform(
-        #     %w(redhat oracle) => {
-        #       '5' => 'foo',
-        #       '6' => 'bar',
-        #       'default'd => 'baz',
-        #     }
-        #   )
-        #
-        #   value_for_platform(
-        #     %w(redhat oracle) => {
-        #       'default' => 'foo',
-        #     },
-        #     'default' => 'bar'
-        #   )
-        #
-        class MalformedPlatformValueForPlatformHelper < Base
-          RESTRICT_ON_SEND = [:value_for_platform].freeze
-
-          def on_send(node)
-            if node.arguments.count > 1
-              msg = 'Malformed value_for_platform helper argument. The value_for_platform helper takes a single hash of platforms as an argument.'
-              add_offense(node, message: msg, severity: :refactor)
-            elsif node.arguments.first.hash_type? # if it's a variable we can't check what's in that variable so skip
-              msg = "Malformed value_for_platform helper argument. The value for each platform in your hash must be a hash of either platform version strings or a value with a key of 'default'"
-              node.arguments.first.each_pair do |plats, plat_vals|
-                # instead of a platform the hash key can be default with a value of anything. Depending on the hash format this is a string or symbol
-                next if plat_vals.hash_type? || plats == s(:str, 'default') || plats == s(:sym, :default)
-                add_offense(plat_vals, message: msg, severity: :refactor)
-              end
-            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
+        # When using the value_for_platform helper you must include a hash of possible platforms where each platform contains a hash of versions and potential values. If you don't wish to match on a particular version you can instead use the key 'default'.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   value_for_platform(
+        #     %w(redhat oracle) => 'baz'
+        #   )
+        #
+        #   ### correct
+        #   value_for_platform(
+        #     %w(redhat oracle) => {
+        #       '5' => 'foo',
+        #       '6' => 'bar',
+        #       'default'd => 'baz',
+        #     }
+        #   )
+        #
+        #   value_for_platform(
+        #     %w(redhat oracle) => {
+        #       'default' => 'foo',
+        #     },
+        #     'default' => 'bar'
+        #   )
+        #
+        class MalformedPlatformValueForPlatformHelper < Base
+          RESTRICT_ON_SEND = [:value_for_platform].freeze
+
+          def on_send(node)
+            if node.arguments.count > 1
+              msg = 'Malformed value_for_platform helper argument. The value_for_platform helper takes a single hash of platforms as an argument.'
+              add_offense(node, message: msg, severity: :refactor)
+            elsif node.arguments.first.hash_type? # if it's a variable we can't check what's in that variable so skip
+              msg = "Malformed value_for_platform helper argument. The value for each platform in your hash must be a hash of either platform version strings or a value with a key of 'default'"
+              node.arguments.first.each_pair do |plats, plat_vals|
+                # instead of a platform the hash key can be default with a value of anything. Depending on the hash format this is a string or symbol
+                next if plat_vals.hash_type? || plats == s(:str, 'default') || plats == s(:sym, :default)
+                add_offense(plat_vals, message: msg, severity: :refactor)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end