cookstyle 7.32.8 → 8.1.1

data/lib/rubocop/cop/chef/modernize/respond_to_metadata.rb

@@ -1,77 +1,77 @@
-# 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 Modernize
-        # It is not longer necessary respond_to?(:foo) or defined?(foo) in metadata. This was used to support new metadata methods in Chef 11 and early versions of Chef 12.
-        #
-        # @example
-        #
-        #   ### incorrect
-        #   chef_version '>= 13' if respond_to?(:chef_version)
-        #   chef_version '>= 13' if defined?(chef_version)
-        #   chef_version '>= 13' unless defined?(Ridley::Chef::Cookbook::Metadata)
-        #   if defined(chef_version)
-        #     chef_version '>= 13'
-        #   end
-        #
-        #   ### correct
-        #   chef_version '>= 13'
-        #
-        class RespondToInMetadata < Base
-          extend AutoCorrector
-          extend TargetChefVersion
-
-          minimum_target_chef_version '12.15'
-
-          MSG = 'It is no longer necessary to use respond_to? or defined? in metadata.rb in Chef Infra Client 12.15 and later'
-
-          def on_if(node)
-            if_respond_to?(node) do
-              add_offense(node, severity: :refactor) do |corrector|
-                # When the if statement is if modifier like `foo if respond_to?(:foo)` then
-                # node.if_branch is the actual method call we want to extract.
-                # If a series of metadata methods are wrapped in an if statement then the content we want
-                # is a block under the if statement and node.parent.if_branch can get us that block
-                node = node.parent unless node.if_type?
-
-                corrector.replace(node, node.if_branch.source)
-              end
-            end
-          end
-
-          def on_defined?(node)
-            # When the if statement is if modifier like `foo if respond_to?(:foo)` then
-            # node.if_branch is the actual method call we want to extract.
-            # If a series of metadata methods are wrapped in an if statement then the content we want
-            # is a block under the if statement and node.parent.if_branch can get us that block
-            node = node.parent if node.parent.conditional? # we want the whole conditional statement
-            add_offense(node, severity: :refactor) do |corrector|
-              corrector.replace(node, node.if_branch.source)
-            end
-          end
-
-          def_node_matcher :if_respond_to?, <<~PATTERN
-            (if (send nil? :respond_to? _ ) ... )
-          PATTERN
-        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 Modernize
+        # It is not longer necessary respond_to?(:foo) or defined?(foo) in metadata. This was used to support new metadata methods in Chef 11 and early versions of Chef 12.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   chef_version '>= 13' if respond_to?(:chef_version)
+        #   chef_version '>= 13' if defined?(chef_version)
+        #   chef_version '>= 13' unless defined?(Ridley::Chef::Cookbook::Metadata)
+        #   if defined(chef_version)
+        #     chef_version '>= 13'
+        #   end
+        #
+        #   ### correct
+        #   chef_version '>= 13'
+        #
+        class RespondToInMetadata < Base
+          extend AutoCorrector
+          extend TargetChefVersion
+
+          minimum_target_chef_version '12.15'
+
+          MSG = 'It is no longer necessary to use respond_to? or defined? in metadata.rb in Chef Infra Client 12.15 and later'
+
+          def on_if(node)
+            if_respond_to?(node) do
+              add_offense(node, severity: :refactor) do |corrector|
+                # When the if statement is if modifier like `foo if respond_to?(:foo)` then
+                # node.if_branch is the actual method call we want to extract.
+                # If a series of metadata methods are wrapped in an if statement then the content we want
+                # is a block under the if statement and node.parent.if_branch can get us that block
+                node = node.parent unless node.if_type?
+
+                corrector.replace(node, node.if_branch.source)
+              end
+            end
+          end
+
+          def on_defined?(node)
+            # When the if statement is if modifier like `foo if respond_to?(:foo)` then
+            # node.if_branch is the actual method call we want to extract.
+            # If a series of metadata methods are wrapped in an if statement then the content we want
+            # is a block under the if statement and node.parent.if_branch can get us that block
+            node = node.parent if node.parent.conditional? # we want the whole conditional statement
+            add_offense(node, severity: :refactor) do |corrector|
+              corrector.replace(node, node.if_branch.source)
+            end
+          end
+
+          def_node_matcher :if_respond_to?, <<~PATTERN
+            (if (send nil? :respond_to? _ ) ... )
+          PATTERN
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/modernize/respond_to_provides.rb

@@ -1,63 +1,63 @@
-# frozen_string_literal: true
-#
-# Copyright:: 2019-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 Modernize
-        # In Chef Infra Client 12+ is is no longer necessary to gate the use of the provides methods in resources with `if respond_to?(:provides)` or `if defined? provides`.
-        #
-        # @example
-        #
-        #   ### incorrect
-        #   provides :foo if respond_to?(:provides)
-        #
-        #   provides :foo if defined? provides
-        #
-        #   ### correct
-        #   provides :foo
-        #
-        class RespondToProvides < Base
-          extend AutoCorrector
-
-          MSG = 'Using `respond_to?(:provides)` or `if defined? provides` in resources is no longer necessary in Chef Infra Client 12+.'
-
-          def on_if(node)
-            if_respond_to_provides?(node) do
-              add_offense(node, severity: :refactor) do |corrector|
-                corrector.replace(node, node.children[1].source)
-              end
-            end
-          end
-
-          def_node_matcher :if_respond_to_provides?, <<~PATTERN
-            (if
-              {
-              (send nil? :respond_to?
-                (sym :provides))
-
-              (:defined?
-                (send nil? :provides))
-              }
-              (send nil? :provides
-                (sym _)) ... )
-          PATTERN
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+#
+# Copyright:: 2019-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 Modernize
+        # In Chef Infra Client 12+ is is no longer necessary to gate the use of the provides methods in resources with `if respond_to?(:provides)` or `if defined? provides`.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   provides :foo if respond_to?(:provides)
+        #
+        #   provides :foo if defined? provides
+        #
+        #   ### correct
+        #   provides :foo
+        #
+        class RespondToProvides < Base
+          extend AutoCorrector
+
+          MSG = 'Using `respond_to?(:provides)` or `if defined? provides` in resources is no longer necessary in Chef Infra Client 12+.'
+
+          def on_if(node)
+            if_respond_to_provides?(node) do
+              add_offense(node, severity: :refactor) do |corrector|
+                corrector.replace(node, node.children[1].source)
+              end
+            end
+          end
+
+          def_node_matcher :if_respond_to_provides?, <<~PATTERN
+            (if
+              {
+              (send nil? :respond_to?
+                (sym :provides))
+
+              (:defined?
+                (send nil? :provides))
+              }
+              (send nil? :provides
+                (sym _)) ... )
+          PATTERN
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/modernize/respond_to_resource_name.rb

@@ -1,52 +1,52 @@
-# 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 Modernize
-        # Chef Infra Client 12.5 introduced the resource_name method for resources. Many cookbooks used respond_to?(:resource_name) to provide backwards compatibility with older chef-client releases. This backwards compatibility is no longer necessary.
-        #
-        # @example
-        #
-        #   ### incorrect
-        #   resource_name :foo if respond_to?(:resource_name)
-        #
-        #   ### correct
-        #   resource_name :foo
-        #
-        class RespondToResourceName < Base
-          extend AutoCorrector
-
-          MSG = 'respond_to?(:resource_name) in resources is no longer necessary in Chef Infra Client 12.5+'
-
-          def on_if(node)
-            if_respond_to_resource_name?(node) do
-              add_offense(node, severity: :refactor) do |corrector|
-                corrector.replace(node, node.children[1].source)
-              end
-            end
-          end
-
-          def_node_matcher :if_respond_to_resource_name?, <<~PATTERN
-            (if (send nil? :respond_to? ( :sym :resource_name ) ) ... )
-          PATTERN
-        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 Modernize
+        # Chef Infra Client 12.5 introduced the resource_name method for resources. Many cookbooks used respond_to?(:resource_name) to provide backwards compatibility with older chef-client releases. This backwards compatibility is no longer necessary.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   resource_name :foo if respond_to?(:resource_name)
+        #
+        #   ### correct
+        #   resource_name :foo
+        #
+        class RespondToResourceName < Base
+          extend AutoCorrector
+
+          MSG = 'respond_to?(:resource_name) in resources is no longer necessary in Chef Infra Client 12.5+'
+
+          def on_if(node)
+            if_respond_to_resource_name?(node) do
+              add_offense(node, severity: :refactor) do |corrector|
+                corrector.replace(node, node.children[1].source)
+              end
+            end
+          end
+
+          def_node_matcher :if_respond_to_resource_name?, <<~PATTERN
+            (if (send nil? :respond_to? ( :sym :resource_name ) ) ... )
+          PATTERN
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/modernize/sc_windows_resource.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 Modernize
-        # The sc_windows resource from the sc cookbook allowed for the creation of windows services on legacy Chef Infra Client releases. Chef Infra Client 14.0 and later includes :create, :delete, and :configure actions without the need for additional cookbook dependencies. See the windows_service documentation at https://docs.chef.io/resources/windows_service for additional details on creating services with the windows_service resource.
-        #
-        # @example
-        #
-        #   ### incorrect
-        #   sc_windows 'chef-client' do
-        #     path "C:\\opscode\\chef\\bin"
-        #     action :create
-        #   end
-        #
-        #   ### correct
-        #   windows_service 'chef-client' do
-        #     action :create
-        #     binary_path_name "C:\\opscode\\chef\\bin"
-        #   end
-        #
-        class WindowsScResource < Cop
-          extend TargetChefVersion
-
-          minimum_target_chef_version '14.0'
-
-          MSG = 'Chef Infra Client 14.0 and later includes :create, :delete, and :configure actions without the need for the sc cookbook dependency. See the windows_service documentation at https://docs.chef.io/resources/windows_service for additional details.'
-          RESTRICT_ON_SEND = [:sc_windows].freeze
-
-          def on_send(node)
-            add_offense(node, severity: :refactor)
-          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 Modernize
+        # The sc_windows resource from the sc cookbook allowed for the creation of windows services on legacy Chef Infra Client releases. Chef Infra Client 14.0 and later includes :create, :delete, and :configure actions without the need for additional cookbook dependencies. See the windows_service documentation at https://docs.chef.io/resources/windows_service for additional details on creating services with the windows_service resource.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   sc_windows 'chef-client' do
+        #     path "C:\\opscode\\chef\\bin"
+        #     action :create
+        #   end
+        #
+        #   ### correct
+        #   windows_service 'chef-client' do
+        #     action :create
+        #     binary_path_name "C:\\opscode\\chef\\bin"
+        #   end
+        #
+        class WindowsScResource < Base
+          extend TargetChefVersion
+
+          minimum_target_chef_version '14.0'
+
+          MSG = 'Chef Infra Client 14.0 and later includes :create, :delete, and :configure actions without the need for the sc cookbook dependency. See the windows_service documentation at https://docs.chef.io/resources/windows_service for additional details.'
+          RESTRICT_ON_SEND = [:sc_windows].freeze
+
+          def on_send(node)
+            add_offense(node, severity: :refactor)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/modernize/seven_zip_archive.rb

@@ -1,46 +1,46 @@
-# 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 Modernize
-        # Use the archive_file resource built into Chef Infra Client 15+ instead of the seven_zip_archive
-        #
-        # @example
-        #
-        #   ### incorrect
-        #   seven_zip_archive "C:\file.zip" do
-        #     path 'C:\expand_here'
-        #   end
-        #
-        class SevenZipArchiveResource < Base
-          extend TargetChefVersion
-
-          minimum_target_chef_version '15.0'
-
-          MSG = 'Use the archive_file resource built into Chef Infra Client 15+ instead of the seven_zip_archive'
-          RESTRICT_ON_SEND = [:seven_zip_archive].freeze
-
-          def on_send(node)
-            add_offense(node, severity: :refactor)
-          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 Modernize
+        # Use the archive_file resource built into Chef Infra Client 15+ instead of the seven_zip_archive
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   seven_zip_archive "C:\file.zip" do
+        #     path 'C:\expand_here'
+        #   end
+        #
+        class SevenZipArchiveResource < Base
+          extend TargetChefVersion
+
+          minimum_target_chef_version '15.0'
+
+          MSG = 'Use the archive_file resource built into Chef Infra Client 15+ instead of the seven_zip_archive'
+          RESTRICT_ON_SEND = [:seven_zip_archive].freeze
+
+          def on_send(node)
+            add_offense(node, severity: :refactor)
+          end
+        end
+      end
+    end
+  end
+end