cookstyle 7.32.8 → 8.1.1

data/lib/rubocop/cop/chef/modernize/dsl_include_in_resource.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 Modernize
-        # Chef Infra Client 12.4+ includes the Chef::DSL::Recipe in the resource and provider classed by default so there is no need to include this DSL in your resources or providers.
-        #
-        # @example
-        #
-        #   ### incorrect
-        #   include Chef::DSL::Recipe
-        #   include Chef::DSL::IncludeRecipe
-        #
-        class DslIncludeInResource < Base
-          extend AutoCorrector
-          include RangeHelp
-
-          MSG = 'Chef Infra Client 12.4+ includes the Chef::DSL::Recipe in the resource and provider classed by default so there is no need to include this DSL in your resources or providers.'
-          RESTRICT_ON_SEND = [:include].freeze
-
-          def_node_matcher :dsl_include?, <<-PATTERN
-          (send nil? :include
-            (const
-              (const
-                (const nil? :Chef) :DSL) {:Recipe :IncludeRecipe}))
-          PATTERN
-
-          def on_send(node)
-            dsl_include?(node) do
-              add_offense(node, severity: :refactor) do |corrector|
-                corrector.remove(range_with_surrounding_space(range: node.loc.expression, side: :left))
-              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 Modernize
+        # Chef Infra Client 12.4+ includes the Chef::DSL::Recipe in the resource and provider classed by default so there is no need to include this DSL in your resources or providers.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   include Chef::DSL::Recipe
+        #   include Chef::DSL::IncludeRecipe
+        #
+        class DslIncludeInResource < Base
+          extend AutoCorrector
+          include RangeHelp
+
+          MSG = 'Chef Infra Client 12.4+ includes the Chef::DSL::Recipe in the resource and provider classed by default so there is no need to include this DSL in your resources or providers.'
+          RESTRICT_ON_SEND = [:include].freeze
+
+          def_node_matcher :dsl_include?, <<-PATTERN
+          (send nil? :include
+            (const
+              (const
+                (const nil? :Chef) :DSL) {:Recipe :IncludeRecipe}))
+          PATTERN
+
+          def on_send(node)
+            dsl_include?(node) do
+              add_offense(node, severity: :refactor) do |corrector|
+                corrector.remove(range_with_surrounding_space(range: node.loc.expression, side: :left))
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/modernize/empty_resource_initialize.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
-        # There is no need for an empty initialize method in a resource
-        #
-        # @example
-        #
-        #   ### incorrect
-        #   def initialize(*args)
-        #     super
-        #   end
-        #
-        class EmptyResourceInitializeMethod < Base
-          extend AutoCorrector
-          include RangeHelp
-
-          MSG = 'There is no need for an empty initialize method in a resource'
-
-          def_node_matcher :empty_initialize?, <<-PATTERN
-            (def :initialize (args (restarg :args)) (zsuper))
-          PATTERN
-
-          def on_def(node)
-            empty_initialize?(node) do
-              add_offense(node, severity: :refactor) do |corrector|
-                corrector.remove(range_with_surrounding_space(range: node.loc.expression, side: :left))
-              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 Modernize
+        # There is no need for an empty initialize method in a resource
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   def initialize(*args)
+        #     super
+        #   end
+        #
+        class EmptyResourceInitializeMethod < Base
+          extend AutoCorrector
+          include RangeHelp
+
+          MSG = 'There is no need for an empty initialize method in a resource'
+
+          def_node_matcher :empty_initialize?, <<-PATTERN
+            (def :initialize (args (restarg :args)) (zsuper))
+          PATTERN
+
+          def on_def(node)
+            empty_initialize?(node) do
+              add_offense(node, severity: :refactor) do |corrector|
+                corrector.remove(range_with_surrounding_space(range: node.loc.expression, side: :left))
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,81 +1,81 @@
-# 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
-        # Instead of using the execute resource to run the `apt-get update` use Chef Infra Client's built-n apt_update resource which is available in Chef Infra Client 12.7 and later.
-        #
-        # @example
-        #
-        #   ### incorrect
-        #   execute 'apt-get update'
-        #
-        #   execute 'Apt all the apt cache' do
-        #     command 'apt-get update'
-        #   end
-        #
-        #   execute 'some execute resource' do
-        #     notifies :run, 'execute[apt-get update]', :immediately
-        #   end
-        #
-        #   ### correct
-        #   apt_update
-        #
-        #   apt_update 'update apt cache'
-        #
-        #   execute 'some execute resource' do
-        #     notifies :update, 'apt_update[update apt cache]', :immediately
-        #   end
-        #
-        class ExecuteAptUpdate < Base
-          extend AutoCorrector
-
-          MSG = 'Use the apt_update resource instead of the execute resource to run an apt-get update package cache update'
-          RESTRICT_ON_SEND = [:execute, :notifies, :subscribes, :command].freeze
-
-          def_node_matcher :execute_apt_update?, <<-PATTERN
-            (send nil? :execute (str { "apt-get update" "apt-get update -y" "apt-get -y update" }))
-          PATTERN
-
-          def_node_matcher :notification_property?, <<-PATTERN
-            (send nil? {:notifies :subscribes} (sym _) $(...) (sym _))
-          PATTERN
-
-          def_node_matcher :execute_command?, <<-PATTERN
-            (send nil? :command $str)
-          PATTERN
-
-          def on_send(node)
-            execute_apt_update?(node) do
-              add_offense(node, severity: :refactor)
-            end
-
-            notification_property?(node) do |val|
-              add_offense(val, severity: :refactor) if val.str_content&.start_with?('execute[apt-get update]')
-            end
-
-            execute_command?(node) do |val|
-              add_offense(node, severity: :refactor) if val.str_content == 'apt-get update'
-            end
-          end
-        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
+        # Instead of using the execute resource to run the `apt-get update` use Chef Infra Client's built-n apt_update resource which is available in Chef Infra Client 12.7 and later.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   execute 'apt-get update'
+        #
+        #   execute 'Apt all the apt cache' do
+        #     command 'apt-get update'
+        #   end
+        #
+        #   execute 'some execute resource' do
+        #     notifies :run, 'execute[apt-get update]', :immediately
+        #   end
+        #
+        #   ### correct
+        #   apt_update
+        #
+        #   apt_update 'update apt cache'
+        #
+        #   execute 'some execute resource' do
+        #     notifies :update, 'apt_update[update apt cache]', :immediately
+        #   end
+        #
+        class ExecuteAptUpdate < Base
+          extend AutoCorrector
+
+          MSG = 'Use the apt_update resource instead of the execute resource to run an apt-get update package cache update'
+          RESTRICT_ON_SEND = [:execute, :notifies, :subscribes, :command].freeze
+
+          def_node_matcher :execute_apt_update?, <<-PATTERN
+            (send nil? :execute (str { "apt-get update" "apt-get update -y" "apt-get -y update" }))
+          PATTERN
+
+          def_node_matcher :notification_property?, <<-PATTERN
+            (send nil? {:notifies :subscribes} (sym _) $(...) (sym _))
+          PATTERN
+
+          def_node_matcher :execute_command?, <<-PATTERN
+            (send nil? :command $str)
+          PATTERN
+
+          def on_send(node)
+            execute_apt_update?(node) do
+              add_offense(node, severity: :refactor)
+            end
+
+            notification_property?(node) do |val|
+              add_offense(val, severity: :refactor) if val.str_content&.start_with?('execute[apt-get update]')
+            end
+
+            execute_command?(node) do |val|
+              add_offense(node, severity: :refactor) if val.str_content == 'apt-get update'
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,67 +1,67 @@
-# 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 14.0 and later includes :create, :delete, and :configure actions with the full idempotency of the windows_service resource. 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
-        #   execute "Delete chef-client service" do
-        #     command "sc.exe delete chef-client"
-        #     action :run
-        #   end
-        #
-        #   ### correct
-        #   windows_service 'chef-client' do
-        #     action :delete
-        #   end
-        #
-        class ExecuteScExe < Base
-          include RuboCop::Chef::CookbookHelpers
-          extend TargetChefVersion
-
-          minimum_target_chef_version '14.0'
-
-          MSG = 'Chef Infra Client 14.0 and later includes :create, :delete, and :configure actions with the full idempotency of the windows_service resource. See the windows_service documentation at https://docs.chef.io/resources/windows_service for additional details on creating services with the windows_service resource'
-          RESTRICT_ON_SEND = [:execute].freeze
-
-          # non block execute resources
-          def on_send(node)
-            # use a regex on source instead of .value in case there's string interpolation which adds a complex dstr type
-            # with a nested string and a begin. Source allows us to avoid a lot of defensive programming here
-            return unless node&.arguments.first&.source&.match?(/^("|')sc.exe/)
-
-            add_offense(node, severity: :refactor)
-          end
-
-          # block execute resources
-          def on_block(node)
-            match_property_in_resource?(:execute, 'command', node) do |code_property|
-              property_data = method_arg_ast_to_string(code_property)
-              return unless property_data && property_data.match?(/^sc.exe/i)
-              add_offense(node, 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 Modernize
+        # Chef Infra Client 14.0 and later includes :create, :delete, and :configure actions with the full idempotency of the windows_service resource. 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
+        #   execute "Delete chef-client service" do
+        #     command "sc.exe delete chef-client"
+        #     action :run
+        #   end
+        #
+        #   ### correct
+        #   windows_service 'chef-client' do
+        #     action :delete
+        #   end
+        #
+        class ExecuteScExe < Base
+          include RuboCop::Chef::CookbookHelpers
+          extend TargetChefVersion
+
+          minimum_target_chef_version '14.0'
+
+          MSG = 'Chef Infra Client 14.0 and later includes :create, :delete, and :configure actions with the full idempotency of the windows_service resource. See the windows_service documentation at https://docs.chef.io/resources/windows_service for additional details on creating services with the windows_service resource'
+          RESTRICT_ON_SEND = [:execute].freeze
+
+          # non block execute resources
+          def on_send(node)
+            # use a regex on source instead of .value in case there's string interpolation which adds a complex dstr type
+            # with a nested string and a begin. Source allows us to avoid a lot of defensive programming here
+            return unless node&.arguments.first&.source&.match?(/^("|')sc.exe/)
+
+            add_offense(node, severity: :refactor)
+          end
+
+          # block execute resources
+          def on_block(node)
+            match_property_in_resource?(:execute, 'command', node) do |code_property|
+              property_data = method_arg_ast_to_string(code_property)
+              return unless property_data && property_data.match?(/^sc.exe/i)
+              add_offense(node, severity: :refactor)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,76 +1,76 @@
-# 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 15.5 and later include a chef_sleep resource that should be used to sleep between executing resources if necessary instead of using the bash or execute resources to run the sleep command.
-        #
-        # @example
-        #
-        #   ### incorrect
-        #   execute "sleep 60" do
-        #     command "sleep 60"
-        #     action :run
-        #   end
-        #
-        #   bash 'sleep' do
-        #     user 'root'
-        #     cwd '/tmp'
-        #     code 'sleep 60'
-        #   end
-        #
-        #   ### correct
-        #   chef_sleep '60'
-        #
-        class ExecuteSleep < Cop
-          include RuboCop::Chef::CookbookHelpers
-          extend TargetChefVersion
-
-          minimum_target_chef_version '15.5'
-
-          MSG = 'Chef Infra Client 15.5 and later include a chef_sleep resource that should be used to sleep between executing resources if necessary instead of using the bash or execute resources to run the sleep command.'
-          RESTRICT_ON_SEND = [:execute].freeze
-
-          # non block execute resources
-          def on_send(node)
-            # use a regex on source instead of .value in case there's string interpolation which adds a complex dstr type
-            # with a nested string and a begin. Source allows us to avoid a lot of defensive programming here
-            return unless node&.arguments.first&.source&.match?(/^("|')sleep/)
-            add_offense(node, severity: :refactor)
-          end
-
-          # block execute resources
-          def on_block(node)
-            match_property_in_resource?(:execute, 'command', node) do |code_property|
-              property_data = method_arg_ast_to_string(code_property)
-              next unless property_data && property_data.match?(/^sleep/i)
-              add_offense(node, severity: :refactor)
-            end
-
-            match_property_in_resource?(:bash, 'code', node) do |code_property|
-              property_data = method_arg_ast_to_string(code_property)
-              next unless property_data && property_data.match?(/^sleep/i)
-              add_offense(node, 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 Modernize
+        # Chef Infra Client 15.5 and later include a chef_sleep resource that should be used to sleep between executing resources if necessary instead of using the bash or execute resources to run the sleep command.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   execute "sleep 60" do
+        #     command "sleep 60"
+        #     action :run
+        #   end
+        #
+        #   bash 'sleep' do
+        #     user 'root'
+        #     cwd '/tmp'
+        #     code 'sleep 60'
+        #   end
+        #
+        #   ### correct
+        #   chef_sleep '60'
+        #
+        class ExecuteSleep < Base
+          include RuboCop::Chef::CookbookHelpers
+          extend TargetChefVersion
+
+          minimum_target_chef_version '15.5'
+
+          MSG = 'Chef Infra Client 15.5 and later include a chef_sleep resource that should be used to sleep between executing resources if necessary instead of using the bash or execute resources to run the sleep command.'
+          RESTRICT_ON_SEND = [:execute].freeze
+
+          # non block execute resources
+          def on_send(node)
+            # use a regex on source instead of .value in case there's string interpolation which adds a complex dstr type
+            # with a nested string and a begin. Source allows us to avoid a lot of defensive programming here
+            return unless node&.arguments.first&.source&.match?(/^("|')sleep/)
+            add_offense(node, severity: :refactor)
+          end
+
+          # block execute resources
+          def on_block(node)
+            match_property_in_resource?(:execute, 'command', node) do |code_property|
+              property_data = method_arg_ast_to_string(code_property)
+              next unless property_data && property_data.match?(/^sleep/i)
+              add_offense(node, severity: :refactor)
+            end
+
+            match_property_in_resource?(:bash, 'code', node) do |code_property|
+              property_data = method_arg_ast_to_string(code_property)
+              next unless property_data && property_data.match?(/^sleep/i)
+              add_offense(node, severity: :refactor)
+            end
+          end
+        end
+      end
+    end
+  end
+end