cookstyle 7.32.8 → 8.0.0

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

@@ -1,59 +1,59 @@
-# frozen_string_literal: true
-#
-# Copyright:: 2022, 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 resource to notify when calling `notifies` or `subscribes` must be a string.
-        #
-        # @example
-        #
-        #   ### incorrect
-        #
-        #   template '/etc/www/configures-apache.conf' do
-        #     notifies :restart, service['apache'], :immediately
-        #   end
-        #
-        #   template '/etc/www/configures-apache.conf' do
-        #     notifies :restart, service[apache], :immediately
-        #   end
-        #
-        #   ### correct
-        #
-        #   template '/etc/www/configures-apache.conf' do
-        #     notifies :restart, 'service[apache]', :immediately
-        #   end
-        #
-        class InvalidNotificationResource < Base
-          MSG = 'The resource to notify when calling `notifies` or `subscribes` must be a string.'
-          RESTRICT_ON_SEND = [:notifies, :subscribes].freeze
-
-          def_node_matcher :invalid_notification?, <<-PATTERN
-            (send nil? {:notifies :subscribes} (sym _) $(send (send nil? _) :[] ...) ...)
-          PATTERN
-
-          def on_send(node)
-            invalid_notification?(node) do |resource|
-              add_offense(resource, severity: :refactor)
-            end
-          end
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+#
+# Copyright:: 2022, 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 resource to notify when calling `notifies` or `subscribes` must be a string.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #
+        #   template '/etc/www/configures-apache.conf' do
+        #     notifies :restart, service['apache'], :immediately
+        #   end
+        #
+        #   template '/etc/www/configures-apache.conf' do
+        #     notifies :restart, service[apache], :immediately
+        #   end
+        #
+        #   ### correct
+        #
+        #   template '/etc/www/configures-apache.conf' do
+        #     notifies :restart, 'service[apache]', :immediately
+        #   end
+        #
+        class InvalidNotificationResource < Base
+          MSG = 'The resource to notify when calling `notifies` or `subscribes` must be a string.'
+          RESTRICT_ON_SEND = [:notifies, :subscribes].freeze
+
+          def_node_matcher :invalid_notification?, <<-PATTERN
+            (send nil? {:notifies :subscribes} (sym _) $(send (send nil? _) :[] ...) ...)
+          PATTERN
+
+          def on_send(node)
+            invalid_notification?(node) do |resource|
+              add_offense(resource, severity: :refactor)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,55 +1,55 @@
-# 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
-        # Valid notification timings are `:immediately`, `:immediate` (alias for :immediately), `:delayed`, and `:before`.
-        #
-        # @example
-        #
-        #   ### incorrect
-        #
-        #   template '/etc/www/configures-apache.conf' do
-        #     notifies :restart, 'service[apache]', :nope
-        #   end
-        #
-        #   ### correct
-        #
-        #   template '/etc/www/configures-apache.conf' do
-        #     notifies :restart, 'service[apache]', :immediately
-        #   end
-        #
-        class InvalidNotificationTiming < Base
-          MSG = 'Valid notification timings are :immediately, :immediate (alias for :immediately), :delayed, and :before.'
-          RESTRICT_ON_SEND = [:notifies, :subscribes].freeze
-
-          def_node_matcher :notification_with_timing?, <<-PATTERN
-            (send nil? {:notifies :subscribes} (sym _) (...) $(sym _))
-          PATTERN
-
-          def on_send(node)
-            notification_with_timing?(node) do |timing|
-              add_offense(timing, severity: :refactor) unless %i(immediate immediately delayed before).include?(timing.value)
-            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
+        # Valid notification timings are `:immediately`, `:immediate` (alias for :immediately), `:delayed`, and `:before`.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #
+        #   template '/etc/www/configures-apache.conf' do
+        #     notifies :restart, 'service[apache]', :nope
+        #   end
+        #
+        #   ### correct
+        #
+        #   template '/etc/www/configures-apache.conf' do
+        #     notifies :restart, 'service[apache]', :immediately
+        #   end
+        #
+        class InvalidNotificationTiming < Base
+          MSG = 'Valid notification timings are :immediately, :immediate (alias for :immediately), :delayed, and :before.'
+          RESTRICT_ON_SEND = [:notifies, :subscribes].freeze
+
+          def_node_matcher :notification_with_timing?, <<-PATTERN
+            (send nil? {:notifies :subscribes} (sym _) (...) $(sym _))
+          PATTERN
+
+          def on_send(node)
+            notification_with_timing?(node) do |timing|
+              add_offense(timing, severity: :refactor) unless %i(immediate immediately delayed before).include?(timing.value)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,72 +1,72 @@
-# 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 `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
-        #   platform_family?('redhat')
-        #   platform_family?('sles')
-        #
-        #   ### incorrect
-        #   platform_family?('rhel')
-        #   platform_family?('suse')
-        #
-        class InvalidPlatformFamilyHelper < Base
-          include ::RuboCop::Chef::PlatformHelpers
-          include RangeHelp
-          extend AutoCorrector
-
-          MSG = 'Pass valid platform families to the platform_family? helper.'
-          RESTRICT_ON_SEND = [:platform_family?].freeze
-
-          def_node_matcher :platform_family_helper?, <<-PATTERN
-            (send nil? :platform_family? $str*)
-          PATTERN
-
-          def on_send(node)
-            platform_family_helper?(node) do |plats|
-              plats.to_a.each do |p|
-                next unless INVALID_PLATFORM_FAMILIES.key?(p.value)
-                add_offense(p, severity: :refactor) do |corrector|
-                  replacement_platform = INVALID_PLATFORM_FAMILIES[p.value]
-                  all_passed_platforms = p.parent.arguments.map(&:value)
-
-                  # see if we have a replacement platform in our hash. If not we can't autocorrect
-                  next unless replacement_platform
-                  # if the replacement platform was one of the other platforms passed we can just delete this bad platform
-                  if all_passed_platforms.include?(replacement_platform)
-                    all_passed_platforms.delete(p.value)
-                    arg_range = p.parent.arguments.first.loc.expression.join(p.parent.arguments[-1].loc.expression.end)
-                    corrector.replace(arg_range, all_passed_platforms.map { |x| "'#{x}'" }.join(', '))
-                  else
-                    corrector.replace(p.loc.expression, p.value.gsub(p.value, "'#{replacement_platform}'")) # gsub to retain quotes
-                  end
-                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 `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
+        #   platform_family?('redhat')
+        #   platform_family?('sles')
+        #
+        #   ### incorrect
+        #   platform_family?('rhel')
+        #   platform_family?('suse')
+        #
+        class InvalidPlatformFamilyHelper < Base
+          include ::RuboCop::Chef::PlatformHelpers
+          include RangeHelp
+          extend AutoCorrector
+
+          MSG = 'Pass valid platform families to the platform_family? helper.'
+          RESTRICT_ON_SEND = [:platform_family?].freeze
+
+          def_node_matcher :platform_family_helper?, <<-PATTERN
+            (send nil? :platform_family? $str*)
+          PATTERN
+
+          def on_send(node)
+            platform_family_helper?(node) do |plats|
+              plats.to_a.each do |p|
+                next unless INVALID_PLATFORM_FAMILIES.key?(p.value)
+                add_offense(p, severity: :refactor) do |corrector|
+                  replacement_platform = INVALID_PLATFORM_FAMILIES[p.value]
+                  all_passed_platforms = p.parent.arguments.map(&:value)
+
+                  # see if we have a replacement platform in our hash. If not we can't autocorrect
+                  next unless replacement_platform
+                  # if the replacement platform was one of the other platforms passed we can just delete this bad platform
+                  if all_passed_platforms.include?(replacement_platform)
+                    all_passed_platforms.delete(p.value)
+                    arg_range = p.parent.arguments.first.loc.expression.join(p.parent.arguments.last.loc.expression.end)
+                    corrector.replace(arg_range, all_passed_platforms.map { |x| "'#{x}'" }.join(', '))
+                  else
+                    corrector.replace(p.loc.expression, p.value.gsub(p.value, "'#{replacement_platform}'")) # gsub to retain quotes
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/correctness/invalid_platform_family_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 family values in case statements. 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
-        #   case node['platform_family']
-        #   when 'redhat'
-        #     puts "I'm on a RHEL-like system"
-        #   end
-        #
-        class InvalidPlatformFamilyInCase < Base
-          extend AutoCorrector
-          include RangeHelp
-          include ::RuboCop::Chef::PlatformHelpers
-
-          MSG = 'Use valid platform family values in case statements.'
-
-          def_node_matcher :node_platform_family?, <<-PATTERN
-            (send (send nil? :node) :[] (str "platform_family") )
-          PATTERN
-
-          def on_case(node)
-            node_platform_family?(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
-                  # some invalid platform families have no direct correction value and return nil instead
-                  new_value = INVALID_PLATFORM_FAMILIES[con.str_content]
-                  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 family values in case statements. 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
+        #   case node['platform_family']
+        #   when 'redhat'
+        #     puts "I'm on a RHEL-like system"
+        #   end
+        #
+        class InvalidPlatformFamilyInCase < Base
+          extend AutoCorrector
+          include RangeHelp
+          include ::RuboCop::Chef::PlatformHelpers
+
+          MSG = 'Use valid platform family values in case statements.'
+
+          def_node_matcher :node_platform_family?, <<-PATTERN
+            (send (send nil? :node) :[] (str "platform_family") )
+          PATTERN
+
+          def on_case(node)
+            node_platform_family?(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
+                  # some invalid platform families have no direct correction value and return nil instead
+                  new_value = INVALID_PLATFORM_FAMILIES[con.str_content]
+                  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_platform_helper.rb

@@ -1,57 +1,57 @@
-# 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 `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
-        #   platform?('darwin')
-        #   platform?('rhel')
-        #   platform?('sles')
-        #
-        #   ### correct
-        #   platform?('mac_os_x')
-        #   platform?('redhat')
-        #   platform?('suse')
-        #
-        class InvalidPlatformHelper < Base
-          include ::RuboCop::Chef::PlatformHelpers
-
-          MSG = 'Pass valid platforms to the platform? helper.'
-          RESTRICT_ON_SEND = [:platform?].freeze
-
-          def_node_matcher :platform_helper?, <<-PATTERN
-            (send nil? :platform? $str*)
-          PATTERN
-
-          def on_send(node)
-            platform_helper?(node) do |plat|
-              plat.to_a.each do |p|
-                add_offense(p, severity: :refactor) if INVALID_PLATFORMS.key?(p.value)
-              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 `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
+        #   platform?('darwin')
+        #   platform?('rhel')
+        #   platform?('sles')
+        #
+        #   ### correct
+        #   platform?('mac_os_x')
+        #   platform?('redhat')
+        #   platform?('suse')
+        #
+        class InvalidPlatformHelper < Base
+          include ::RuboCop::Chef::PlatformHelpers
+
+          MSG = 'Pass valid platforms to the platform? helper.'
+          RESTRICT_ON_SEND = [:platform?].freeze
+
+          def_node_matcher :platform_helper?, <<-PATTERN
+            (send nil? :platform? $str*)
+          PATTERN
+
+          def on_send(node)
+            platform_helper?(node) do |plat|
+              plat.to_a.each do |p|
+                add_offense(p, severity: :refactor) if INVALID_PLATFORMS.key?(p.value)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end