cookstyle 7.32.8 → 8.1.1

data/lib/rubocop/cop/chef/deprecation/inherits_compat_resource.rb

@@ -1,59 +1,59 @@
-# 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 Deprecations
-        # Resources written in the class based HWRP style should inherit from the 'Chef::Resource' class and not the 'ChefCompat::Resource' class from the deprecated compat_resource cookbook.
-        #
-        # @example
-        #
-        #  ### incorrect
-        #  class AptUpdate < ChefCompat::Resource
-        #    # some resource code
-        #  end
-        #
-        #  ### correct
-        #  class AptUpdate < Chef::Resource
-        #    # some resource code
-        #  end
-        #
-        #  # better
-        #  Write a custom resource using the custom resource DSL and avoid class based HWRPs entirely
-        #
-        class ResourceInheritsFromCompatResource < Base
-          extend AutoCorrector
-
-          MSG = "HWRP style resource should inherit from the 'Chef::Resource' class and not the 'ChefCompat::Resource' class from the deprecated compat_resource cookbook."
-
-          def_node_matcher :inherits_from_compat_resource?, <<-PATTERN
-          (class (const nil? _ ) (const (const nil? :ChefCompat) :Resource) ... )
-          PATTERN
-
-          def on_class(node)
-            inherits_from_compat_resource?(node) do
-              add_offense(node, severity: :warning) do |corrector|
-                corrector.replace(node, node.source.gsub('ChefCompat', 'Chef'))
-              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 Deprecations
+        # Resources written in the class based HWRP style should inherit from the 'Chef::Resource' class and not the 'ChefCompat::Resource' class from the deprecated compat_resource cookbook.
+        #
+        # @example
+        #
+        #  ### incorrect
+        #  class AptUpdate < ChefCompat::Resource
+        #    # some resource code
+        #  end
+        #
+        #  ### correct
+        #  class AptUpdate < Chef::Resource
+        #    # some resource code
+        #  end
+        #
+        #  # better
+        #  Write a custom resource using the custom resource DSL and avoid class based HWRPs entirely
+        #
+        class ResourceInheritsFromCompatResource < Base
+          extend AutoCorrector
+
+          MSG = "HWRP style resource should inherit from the 'Chef::Resource' class and not the 'ChefCompat::Resource' class from the deprecated compat_resource cookbook."
+
+          def_node_matcher :inherits_from_compat_resource?, <<-PATTERN
+          (class (const nil? _ ) (const (const nil? :ChefCompat) :Resource) ... )
+          PATTERN
+
+          def on_class(node)
+            inherits_from_compat_resource?(node) do
+              add_offense(node, severity: :warning) do |corrector|
+                corrector.replace(node, node.source.gsub('ChefCompat', 'Chef'))
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/deprecation/launchd_deprecated_hash_property.rb

@@ -1,56 +1,56 @@
-# 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 Deprecations
-        # The launchd resource's hash property was renamed to plist_hash in Chef Infra Client 13+ to avoid conflicts with Ruby's hash class.
-        #
-        # @example
-        #
-        #   ### incorrect
-        #   launchd 'foo' do
-        #     hash foo: 'bar'
-        #   end
-        #
-        #   ### correct
-        #   launchd 'foo' do
-        #     plist_hash foo: 'bar'
-        #   end
-        #
-        class LaunchdDeprecatedHashProperty < Base
-          include RuboCop::Chef::CookbookHelpers
-          extend TargetChefVersion
-          extend AutoCorrector
-
-          minimum_target_chef_version '12.19'
-
-          MSG = "The launchd resource's hash property was renamed to plist_hash in Chef Infra Client 13+ to avoid conflicts with Ruby's hash class."
-
-          def on_block(node)
-            match_property_in_resource?(:launchd, 'hash', node) do |offense|
-              add_offense(offense.loc.expression, severity: :warning) do |corrector|
-                corrector.replace(offense.loc.expression, offense.loc.expression.source.gsub(/^hash/, 'plist_hash'))
-              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 Deprecations
+        # The launchd resource's hash property was renamed to plist_hash in Chef Infra Client 13+ to avoid conflicts with Ruby's hash class.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   launchd 'foo' do
+        #     hash foo: 'bar'
+        #   end
+        #
+        #   ### correct
+        #   launchd 'foo' do
+        #     plist_hash foo: 'bar'
+        #   end
+        #
+        class LaunchdDeprecatedHashProperty < Base
+          include RuboCop::Chef::CookbookHelpers
+          extend TargetChefVersion
+          extend AutoCorrector
+
+          minimum_target_chef_version '12.19'
+
+          MSG = "The launchd resource's hash property was renamed to plist_hash in Chef Infra Client 13+ to avoid conflicts with Ruby's hash class."
+
+          def on_block(node)
+            match_property_in_resource?(:launchd, 'hash', node) do |offense|
+              add_offense(offense.loc.expression, severity: :warning) do |corrector|
+                corrector.replace(offense.loc.expression, offense.loc.expression.source.gsub(/^hash/, 'plist_hash'))
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/deprecation/legacy_notify_syntax.rb

@@ -1,91 +1,91 @@
-# 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 Deprecations
-        # Use the new-style notification syntax which allows you to notify resources defined later in a recipe or resource.
-        #
-        # @example
-        #
-        #   ### incorrect
-        #   template '/etc/www/configures-apache.conf' do
-        #     notifies :restart, resources(service: 'apache')
-        #   end
-        #
-        #   template '/etc/www/configures-apache.conf' do
-        #     notifies :restart, resources(service: 'apache'), :immediately
-        #   end
-        #
-        #   template '/etc/www/configures-apache.conf' do
-        #     notifies :restart, resources(service: service_name_variable), :immediately
-        #   end
-        #
-        #   template '/etc/www/configures-apache.conf' do
-        #     subscribes :restart, resources(service: service_name_variable), :immediately
-        #   end
-        #
-        #   ### correct
-        #   template '/etc/www/configures-apache.conf' do
-        #     notifies :restart, 'service[apache]'
-        #   end
-        #
-        #   template '/etc/www/configures-apache.conf' do
-        #     notifies :restart, 'service[apache]', :immediately
-        #   end
-        #
-        #   template '/etc/www/configures-apache.conf' do
-        #     notifies :restart, "service[#{service_name_variable}]", :immediately
-        #   end
-        #
-        #   template '/etc/www/configures-apache.conf' do
-        #     subscribes :restart, "service[#{service_name_variable}]", :immediately
-        #   end
-        #
-        class LegacyNotifySyntax < Base
-          extend AutoCorrector
-
-          MSG = 'Use the new-style notification syntax which allows you to notify resources defined later in a recipe or resource.'
-          RESTRICT_ON_SEND = [:notifies, :subscribes].freeze
-
-          def_node_matcher :legacy_notify?, <<-PATTERN
-            (send nil? ${:notifies :subscribes} $(sym _) (send nil? :resources (hash (pair $(sym _) $(...) ) ) ) $... )
-          PATTERN
-
-          def on_send(node)
-            legacy_notify?(node) do |notify_type, action, type, name, timing|
-              add_offense(node, severity: :warning) do |corrector|
-                service_value = case name.type
-                                when :str
-                                  "'#{type.source}[#{name.value}]'"
-                                when :dstr
-                                  "\"#{type.source}[#{name.value}]\""
-                                else
-                                  "\"#{type.source}[\#{#{name.source}}]\""
-                                end
-                new_val = +"#{notify_type} #{action.source}, #{service_value}"
-                new_val << ", #{timing.first.source}" unless timing.empty?
-                corrector.replace(node, new_val)
-              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 Deprecations
+        # Use the new-style notification syntax which allows you to notify resources defined later in a recipe or resource.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   template '/etc/www/configures-apache.conf' do
+        #     notifies :restart, resources(service: 'apache')
+        #   end
+        #
+        #   template '/etc/www/configures-apache.conf' do
+        #     notifies :restart, resources(service: 'apache'), :immediately
+        #   end
+        #
+        #   template '/etc/www/configures-apache.conf' do
+        #     notifies :restart, resources(service: service_name_variable), :immediately
+        #   end
+        #
+        #   template '/etc/www/configures-apache.conf' do
+        #     subscribes :restart, resources(service: service_name_variable), :immediately
+        #   end
+        #
+        #   ### correct
+        #   template '/etc/www/configures-apache.conf' do
+        #     notifies :restart, 'service[apache]'
+        #   end
+        #
+        #   template '/etc/www/configures-apache.conf' do
+        #     notifies :restart, 'service[apache]', :immediately
+        #   end
+        #
+        #   template '/etc/www/configures-apache.conf' do
+        #     notifies :restart, "service[#{service_name_variable}]", :immediately
+        #   end
+        #
+        #   template '/etc/www/configures-apache.conf' do
+        #     subscribes :restart, "service[#{service_name_variable}]", :immediately
+        #   end
+        #
+        class LegacyNotifySyntax < Base
+          extend AutoCorrector
+
+          MSG = 'Use the new-style notification syntax which allows you to notify resources defined later in a recipe or resource.'
+          RESTRICT_ON_SEND = [:notifies, :subscribes].freeze
+
+          def_node_matcher :legacy_notify?, <<-PATTERN
+            (send nil? ${:notifies :subscribes} $(sym _) (send nil? :resources (hash (pair $(sym _) $(...) ) ) ) $... )
+          PATTERN
+
+          def on_send(node)
+            legacy_notify?(node) do |notify_type, action, type, name, timing|
+              add_offense(node, severity: :warning) do |corrector|
+                service_value = case name.type
+                                when :str
+                                  "'#{type.source}[#{name.value}]'"
+                                when :dstr
+                                  "\"#{type.source}[#{name.value}]\""
+                                else
+                                  "\"#{type.source}[\#{#{name.source}}]\""
+                                end
+                new_val = +"#{notify_type} #{action.source}, #{service_value}"
+                new_val << ", #{timing.first.source}" unless timing.empty?
+                corrector.replace(node, new_val)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/deprecation/legacy_yum_cookbook_recipes.rb

@@ -1,53 +1,53 @@
-# 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 Deprecations
-        # The Ohai default recipe previously allowed a user to ship custom Ohai plugins to a system by including them
-        # in a directory in the Ohai cookbook. This functionality was replaced with the ohai_plugin resource, which
-        # should be used instead as it doesn't require forking the ohai cookbook.
-        #
-        # @example
-        #
-        #   ### incorrect
-        #   include_recipe 'yum::elrepo'
-        #   include_recipe 'yum::epel'
-        #   include_recipe 'yum::ius'
-        #   include_recipe 'yum::remi'
-        #   include_recipe 'yum::repoforge'
-        #   include_recipe 'yum::yum'
-        #
-        class LegacyYumCookbookRecipes < Base
-          MSG = 'The elrepo, epel, ius, remi, and repoforge recipes were split into their own cookbooks and the yum recipe was renamed to be default with the release of yum cookbook 3.0 (Dec 2013).'
-          RESTRICT_ON_SEND = [:include_recipe].freeze
-
-          def_node_matcher :old_yum_recipe?, <<-PATTERN
-            (send nil? :include_recipe (str {"yum::elrepo" "yum::epel" "yum::ius" "yum::remi" "yum::repoforge" "yum::yum"}))
-          PATTERN
-
-          def on_send(node)
-            old_yum_recipe?(node) do
-              add_offense(node, severity: :warning)
-            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 Deprecations
+        # The Ohai default recipe previously allowed a user to ship custom Ohai plugins to a system by including them
+        # in a directory in the Ohai cookbook. This functionality was replaced with the ohai_plugin resource, which
+        # should be used instead as it doesn't require forking the ohai cookbook.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   include_recipe 'yum::elrepo'
+        #   include_recipe 'yum::epel'
+        #   include_recipe 'yum::ius'
+        #   include_recipe 'yum::remi'
+        #   include_recipe 'yum::repoforge'
+        #   include_recipe 'yum::yum'
+        #
+        class LegacyYumCookbookRecipes < Base
+          MSG = 'The elrepo, epel, ius, remi, and repoforge recipes were split into their own cookbooks and the yum recipe was renamed to be default with the release of yum cookbook 3.0 (Dec 2013).'
+          RESTRICT_ON_SEND = [:include_recipe].freeze
+
+          def_node_matcher :old_yum_recipe?, <<-PATTERN
+            (send nil? :include_recipe (str {"yum::elrepo" "yum::epel" "yum::ius" "yum::remi" "yum::repoforge" "yum::yum"}))
+          PATTERN
+
+          def on_send(node)
+            old_yum_recipe?(node) do
+              add_offense(node, severity: :warning)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/deprecation/librarian_chefspec.rb

@@ -1,42 +1,42 @@
-# 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 Deprecations
-        # The Librarian-Chef depsolving project is no longer maintained and a Cheffile should not be used for cookbook depsolving. Consider using Policyfiles instead.
-        #
-        # @example
-        #
-        #   ### incorrect
-        #   require 'chefspec/librarian'
-        #
-        class LibrarianChefSpec < Base
-          MSG = 'The Librarian-Chef depsolving project is no longer maintained and ChefSpec should not use Librarian-Chef for cookbook depsolving. Consider using Policyfiles instead.'
-          RESTRICT_ON_SEND = [:require].freeze
-
-          def on_send(node)
-            return unless node.arguments.first == s(:str, 'chefspec/librarian')
-
-            add_offense(node, severity: :warning)
-          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 Deprecations
+        # The Librarian-Chef depsolving project is no longer maintained and a Cheffile should not be used for cookbook depsolving. Consider using Policyfiles instead.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   require 'chefspec/librarian'
+        #
+        class LibrarianChefSpec < Base
+          MSG = 'The Librarian-Chef depsolving project is no longer maintained and ChefSpec should not use Librarian-Chef for cookbook depsolving. Consider using Policyfiles instead.'
+          RESTRICT_ON_SEND = [:require].freeze
+
+          def on_send(node)
+            return unless node.arguments.first == s(:str, 'chefspec/librarian')
+
+            add_offense(node, severity: :warning)
+          end
+        end
+      end
+    end
+  end
+end