cookstyle 7.32.8 → 8.1.1

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

@@ -1,70 +1,70 @@
-# 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
-        # Use valid platform values in case statements. See [Infra Language: Platform](https://docs.chef.io/infra_language/checking_platforms/#platform-values) for a list of many common platform values.
-        #
-        # @example
-        #
-        #   ### incorrect
-        #   case node['platform']
-        #   when 'rhel'
-        #     puts "I'm on a Red Hat system!"
-        #   end
-        #
-        class InvalidPlatformInCase < Base
-          extend AutoCorrector
-          include RangeHelp
-          include ::RuboCop::Chef::PlatformHelpers
-
-          MSG = 'Use valid platform values in case statements.'
-          RESTRICT_ON_SEND = [:[]].freeze
-
-          def_node_matcher :node_platform?, <<-PATTERN
-            (send (send nil? :node) :[] (str "platform") )
-          PATTERN
-
-          def on_case(node)
-            node_platform?(node.condition) do
-              node.each_when do |when_node|
-                when_node.each_condition do |con|
-                  next unless con.str_type? # if the condition isn't a string we can't check so skip
-                  new_value = INVALID_PLATFORMS[con.str_content]
-                  # some invalid platform have no direct correction value and return nil instead
-                  next unless new_value
-
-                  add_offense(con, severity: :refactor) do |corrector|
-                    # if the correct value already exists in the when statement then we just want to delete this node
-                    if con.parent.conditions.any? { |x| x.str_content == new_value }
-                      range = range_with_surrounding_comma(range_with_surrounding_space(range: con.loc.expression, side: :left), :both)
-                      corrector.remove(range)
-                    else
-                      corrector.replace(con, "'#{new_value}'")
-                    end
-                  end
-                end
-              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
+        # Use valid platform values in case statements. See [Infra Language: Platform](https://docs.chef.io/infra_language/checking_platforms/#platform-values) for a list of many common platform values.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   case node['platform']
+        #   when 'rhel'
+        #     puts "I'm on a Red Hat system!"
+        #   end
+        #
+        class InvalidPlatformInCase < Base
+          extend AutoCorrector
+          include RangeHelp
+          include ::RuboCop::Chef::PlatformHelpers
+
+          MSG = 'Use valid platform values in case statements.'
+          RESTRICT_ON_SEND = [:[]].freeze
+
+          def_node_matcher :node_platform?, <<-PATTERN
+            (send (send nil? :node) :[] (str "platform") )
+          PATTERN
+
+          def on_case(node)
+            node_platform?(node.condition) do
+              node.each_when do |when_node|
+                when_node.each_condition do |con|
+                  next unless con.str_type? # if the condition isn't a string we can't check so skip
+                  new_value = INVALID_PLATFORMS[con.str_content]
+                  # some invalid platform have no direct correction value and return nil instead
+                  next unless new_value
+
+                  add_offense(con, severity: :refactor) do |corrector|
+                    # if the correct value already exists in the when statement then we just want to delete this node
+                    if con.parent.conditions.any? { |x| x.str_content == new_value }
+                      range = range_with_surrounding_comma(range_with_surrounding_space(range: con.loc.expression, side: :left), :both)
+                      corrector.remove(range)
+                    else
+                      corrector.replace(con, "'#{new_value}'")
+                    end
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,70 +1,70 @@
-# 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
-        # Pass valid platform families to the value_for_platform_family helper. See [Infra Language: Platform Family](https://docs.chef.io/infra_language/checking_platforms/#platform_family-values) for a complete list of platform families.
-        #
-        # @example
-        #
-        #   ### incorrect
-        #   value_for_platform_family(
-        #     %w(rhel sles) => 'foo',
-        #     %w(mac) => 'foo'
-        #   )
-        #
-        #   ### correct
-        #   value_for_platform_family(
-        #     %w(rhel suse) => 'foo',
-        #     %w(mac_os_x) => 'foo'
-        #   )
-        #
-        class InvalidPlatformValueForPlatformFamilyHelper < Base
-          include ::RuboCop::Chef::PlatformHelpers
-
-          MSG = 'Pass valid platform families to the value_for_platform_family helper.'
-          RESTRICT_ON_SEND = [:value_for_platform_family].freeze
-
-          def_node_matcher :value_for_platform_family?, <<-PATTERN
-          (send nil? :value_for_platform_family
-            (hash
-              $...
-            )
-          )
-          PATTERN
-
-          def on_send(node)
-            value_for_platform_family?(node) do |plats|
-              plats.each do |p_hash|
-                if p_hash.key.array_type?
-                  p_hash.key.values.each do |plat|
-                    next unless INVALID_PLATFORM_FAMILIES.key?(plat.value)
-                    add_offense(plat, severity: :refactor)
-                  end
-                elsif INVALID_PLATFORM_FAMILIES.key?(p_hash.key.value)
-                  add_offense(p_hash.key, severity: :refactor)
-                end
-              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
+        # Pass valid platform families to the value_for_platform_family helper. See [Infra Language: Platform Family](https://docs.chef.io/infra_language/checking_platforms/#platform_family-values) for a complete list of platform families.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   value_for_platform_family(
+        #     %w(rhel sles) => 'foo',
+        #     %w(mac) => 'foo'
+        #   )
+        #
+        #   ### correct
+        #   value_for_platform_family(
+        #     %w(rhel suse) => 'foo',
+        #     %w(mac_os_x) => 'foo'
+        #   )
+        #
+        class InvalidPlatformValueForPlatformFamilyHelper < Base
+          include ::RuboCop::Chef::PlatformHelpers
+
+          MSG = 'Pass valid platform families to the value_for_platform_family helper.'
+          RESTRICT_ON_SEND = [:value_for_platform_family].freeze
+
+          def_node_matcher :value_for_platform_family?, <<-PATTERN
+          (send nil? :value_for_platform_family
+            (hash
+              $...
+            )
+          )
+          PATTERN
+
+          def on_send(node)
+            value_for_platform_family?(node) do |plats|
+              plats.each do |p_hash|
+                if p_hash.key.array_type?
+                  p_hash.key.each_value do |plat|
+                    next unless INVALID_PLATFORM_FAMILIES.key?(plat.value)
+                    add_offense(plat, severity: :refactor)
+                  end
+                elsif INVALID_PLATFORM_FAMILIES.key?(p_hash.key.value)
+                  add_offense(p_hash.key, severity: :refactor)
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,69 +1,69 @@
-# 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
-        # Pass valid platforms to the value_for_platform helper. See [Infra Language: Platform](https://docs.chef.io/infra_language/checking_platforms/#platform-values) for a list of many common platform values.
-        #
-        # @example
-        #
-        #   ### incorrect
-        #   value_for_platform(
-        #     %w(rhel mac_os_x_server) => { 'default' => 'foo' },
-        #     %w(sles) => { 'default' => 'bar' }
-        #   )
-        #   ### correct
-        #   value_for_platform(
-        #     %w(redhat mac_os_x) => { 'default' => 'foo' },
-        #     %w(opensuseleap) => { 'default' => 'bar' }
-        #   )
-        #
-        class InvalidPlatformValueForPlatformHelper < Base
-          include ::RuboCop::Chef::PlatformHelpers
-
-          MSG = 'Pass valid platforms to the value_for_platform helper.'
-          RESTRICT_ON_SEND = [:value_for_platform].freeze
-
-          def_node_matcher :value_for_platform?, <<-PATTERN
-          (send nil? :value_for_platform
-            (hash
-              $...
-            )
-          )
-          PATTERN
-
-          def on_send(node)
-            value_for_platform?(node) do |plats|
-              plats.each do |p_hash|
-                if p_hash.key.array_type?
-                  p_hash.key.values.each do |plat|
-                    next unless INVALID_PLATFORMS.key?(plat.value)
-                    add_offense(plat, severity: :refactor)
-                  end
-                elsif INVALID_PLATFORMS.key?(p_hash.key.value)
-                  add_offense(p_hash.key, severity: :refactor)
-                end
-              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
+        # Pass valid platforms to the value_for_platform helper. See [Infra Language: Platform](https://docs.chef.io/infra_language/checking_platforms/#platform-values) for a list of many common platform values.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   value_for_platform(
+        #     %w(rhel mac_os_x_server) => { 'default' => 'foo' },
+        #     %w(sles) => { 'default' => 'bar' }
+        #   )
+        #   ### correct
+        #   value_for_platform(
+        #     %w(redhat mac_os_x) => { 'default' => 'foo' },
+        #     %w(opensuseleap) => { 'default' => 'bar' }
+        #   )
+        #
+        class InvalidPlatformValueForPlatformHelper < Base
+          include ::RuboCop::Chef::PlatformHelpers
+
+          MSG = 'Pass valid platforms to the value_for_platform helper.'
+          RESTRICT_ON_SEND = [:value_for_platform].freeze
+
+          def_node_matcher :value_for_platform?, <<-PATTERN
+          (send nil? :value_for_platform
+            (hash
+              $...
+            )
+          )
+          PATTERN
+
+          def on_send(node)
+            value_for_platform?(node) do |plats|
+              plats.each do |p_hash|
+                if p_hash.key.array_type?
+                  p_hash.key.each_value do |plat|
+                    next unless INVALID_PLATFORMS.key?(plat.value)
+                    add_offense(plat, severity: :refactor)
+                  end
+                elsif INVALID_PLATFORMS.key?(p_hash.key.value)
+                  add_offense(p_hash.key, severity: :refactor)
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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