cookstyle 7.32.8 → 8.0.0

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

@@ -1,87 +1,87 @@
-# frozen_string_literal: true
-#
-# Copyright:: Copyright (c) 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
-        # Chef Infra Client 15.3 and later include a new Unified Mode that simplifies the execution of resources by replace the traditional compile and converge phases with a single phase. Unified mode simplifies writing advanced resources and avoids confusing errors that often occur when mixing ruby and Chef Infra resources. Chef Infra Client 17.0 and later will begin warning that `unified_mode true` should be set in all resources to validate that they will continue to function in Chef Infra Client 18.0 (April 2022) when Unified Mode becomes the default.
-        #
-        # @example
-        #
-        #  ### incorrect
-        #   resource_name :foo
-        #   provides :foo
-        #
-        #   action :create do
-        #     # some action code
-        #   end
-        #
-        #  ### correct
-        #   resource_name :foo
-        #   provides :foo
-        #   unified_mode true
-        #
-        #   action :create do
-        #     # some action code
-        #   end
-        #
-        class ResourceWithoutUnifiedTrue < Base
-          include RangeHelp
-          extend AutoCorrector
-          extend TargetChefVersion
-
-          minimum_target_chef_version '15.3'
-
-          MSG = 'Set `unified_mode true` in Chef Infra Client 15.3+ custom resources to ensure they work correctly in Chef Infra Client 18 (April 2022) when Unified Mode becomes the default.'
-
-          def_node_search :unified_mode?, '(send nil? :unified_mode ...)'
-          def_node_search :resource_name, '(send nil? :resource_name ...)'
-          def_node_search :provides, '(send nil? :provides ...)'
-
-          def on_new_investigation
-            # gracefully fail if the resource is empty
-            return if processed_source.ast.nil?
-
-            # Using range similar to RuboCop::Cop::Naming::Filename (file_name.rb)
-            return if unified_mode?(processed_source.ast)
-            range = source_range(processed_source.buffer, 1, 0)
-            add_offense(range, severity: :refactor) do |corrector|
-              insert_below_provides(corrector) || insert_below_resource_name(corrector)
-            end
-          end
-
-          def insert_below_provides(corrector)
-            provides_ast = provides(processed_source.ast).first
-            if provides_ast
-              corrector.insert_after(provides_ast, "\nunified_mode true")
-              true
-            end
-          end
-
-          def insert_below_resource_name(corrector)
-            resource_name_ast = resource_name(processed_source.ast).first
-            if resource_name_ast
-              corrector.insert_after(resource_name_ast, "\nunified_mode true")
-              true
-            end
-          end
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+#
+# Copyright:: Copyright (c) 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
+        # Chef Infra Client 15.3 and later include a new Unified Mode that simplifies the execution of resources by replace the traditional compile and converge phases with a single phase. Unified mode simplifies writing advanced resources and avoids confusing errors that often occur when mixing ruby and Chef Infra resources. Chef Infra Client 17.0 and later will begin warning that `unified_mode true` should be set in all resources to validate that they will continue to function in Chef Infra Client 18.0 (April 2022) when Unified Mode becomes the default.
+        #
+        # @example
+        #
+        #  ### incorrect
+        #   resource_name :foo
+        #   provides :foo
+        #
+        #   action :create do
+        #     # some action code
+        #   end
+        #
+        #  ### correct
+        #   resource_name :foo
+        #   provides :foo
+        #   unified_mode true
+        #
+        #   action :create do
+        #     # some action code
+        #   end
+        #
+        class ResourceWithoutUnifiedTrue < Base
+          include RangeHelp
+          extend AutoCorrector
+          extend TargetChefVersion
+
+          minimum_target_chef_version '15.3'
+
+          MSG = 'Set `unified_mode true` in Chef Infra Client 15.3+ custom resources to ensure they work correctly in Chef Infra Client 18 (April 2022) when Unified Mode becomes the default.'
+
+          def_node_search :unified_mode?, '(send nil? :unified_mode ...)'
+          def_node_search :resource_name, '(send nil? :resource_name ...)'
+          def_node_search :provides, '(send nil? :provides ...)'
+
+          def on_new_investigation
+            # gracefully fail if the resource is empty
+            return if processed_source.ast.nil?
+
+            # Using range similar to RuboCop::Cop::Naming::Filename (file_name.rb)
+            return if unified_mode?(processed_source.ast)
+            range = source_range(processed_source.buffer, 1, 0)
+            add_offense(range, severity: :refactor) do |corrector|
+              insert_below_provides(corrector) || insert_below_resource_name(corrector)
+            end
+          end
+
+          def insert_below_provides(corrector)
+            provides_ast = provides(processed_source.ast).first
+            if provides_ast
+              corrector.insert_after(provides_ast, "\nunified_mode true")
+              true
+            end
+          end
+
+          def insert_below_resource_name(corrector)
+            resource_name_ast = resource_name(processed_source.ast).first
+            if resource_name_ast
+              corrector.insert_after(resource_name_ast, "\nunified_mode true")
+              true
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,56 +1,56 @@
-# 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
-        # Pass options to shell_out helpers without the brackets to avoid Ruby 2.7 deprecation warnings.
-        #
-        # @example
-        #
-        #   ### incorrect
-        #   shell_out!('hostnamectl status', { returns: [0, 1] })
-        #   shell_out('hostnamectl status', { returns: [0, 1] })
-        #
-        #   ### correct
-        #   shell_out!('hostnamectl status', returns: [0, 1])
-        #   shell_out('hostnamectl status', returns: [0, 1])
-        #
-        class Ruby27KeywordArgumentWarnings < Base
-          extend RuboCop::Cop::AutoCorrector
-
-          MSG = 'Pass options to shell_out helpers without the brackets to avoid Ruby 2.7 deprecation warnings.'
-          RESTRICT_ON_SEND = [:shell_out!, :shell_out].freeze
-
-          def_node_matcher :positional_shellout?, <<-PATTERN
-            (send nil? {:shell_out :shell_out!} ... $(hash ... ))
-          PATTERN
-
-          def on_send(node)
-            positional_shellout?(node) do |h|
-              next unless h.braces?
-              add_offense(h, severity: :refactor) do |corrector|
-                corrector.replace(h, h.source[1..-2])
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+#
+# Copyright:: 2020, Chef Software, Inc.
+# Author:: Tim Smith (<tsmith84@gmail.com>)
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+module RuboCop
+  module Cop
+    module Chef
+      module Deprecations
+        # Pass options to shell_out helpers without the brackets to avoid Ruby 2.7 deprecation warnings.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   shell_out!('hostnamectl status', { returns: [0, 1] })
+        #   shell_out('hostnamectl status', { returns: [0, 1] })
+        #
+        #   ### correct
+        #   shell_out!('hostnamectl status', returns: [0, 1])
+        #   shell_out('hostnamectl status', returns: [0, 1])
+        #
+        class Ruby27KeywordArgumentWarnings < Base
+          extend RuboCop::Cop::AutoCorrector
+
+          MSG = 'Pass options to shell_out helpers without the brackets to avoid Ruby 2.7 deprecation warnings.'
+          RESTRICT_ON_SEND = [:shell_out!, :shell_out].freeze
+
+          def_node_matcher :positional_shellout?, <<-PATTERN
+            (send nil? {:shell_out :shell_out!} ... $(hash ... ))
+          PATTERN
+
+          def on_send(node)
+            positional_shellout?(node) do |h|
+              next unless h.braces?
+              add_offense(h, severity: :refactor) do |corrector|
+                corrector.replace(h, h.source[1..-2])
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,62 +1,62 @@
-# 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 :run action in the ruby_block resource instead of the deprecated :create action
-        #
-        # @example
-        #
-        #   ### incorrect
-        #   ruby_block 'my special ruby block' do
-        #     block do
-        #       puts 'running'
-        #     end
-        #     action :create
-        #   end
-        #
-        #   ### correct
-        #   ruby_block 'my special ruby block' do
-        #     block do
-        #       puts 'running'
-        #     end
-        #     action :run
-        #   end
-        #
-        class RubyBlockCreateAction < Base
-          include RuboCop::Chef::CookbookHelpers
-          extend AutoCorrector
-
-          MSG = 'Use the :run action in the ruby_block resource instead of the deprecated :create action'
-
-          def on_block(node)
-            match_property_in_resource?(:ruby_block, 'action', node) do |ruby_action|
-              ruby_action.arguments.each do |action|
-                next unless action.source == ':create'
-                add_offense(action, severity: :warning) do |corrector|
-                  corrector.replace(action, ':run')
-                end
-              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 :run action in the ruby_block resource instead of the deprecated :create action
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   ruby_block 'my special ruby block' do
+        #     block do
+        #       puts 'running'
+        #     end
+        #     action :create
+        #   end
+        #
+        #   ### correct
+        #   ruby_block 'my special ruby block' do
+        #     block do
+        #       puts 'running'
+        #     end
+        #     action :run
+        #   end
+        #
+        class RubyBlockCreateAction < Base
+          include RuboCop::Chef::CookbookHelpers
+          extend AutoCorrector
+
+          MSG = 'Use the :run action in the ruby_block resource instead of the deprecated :create action'
+
+          def on_block(node)
+            match_property_in_resource?(:ruby_block, 'action', node) do |ruby_action|
+              ruby_action.arguments.each do |action|
+                next unless action.source == ':create'
+                add_offense(action, severity: :warning) do |corrector|
+                  corrector.replace(action, ':run')
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,63 +1,63 @@
-# 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 'shell_out!' instead of the legacy 'run_command' or 'run_command_with_systems_locale' helpers for shelling out. The run_command helper was removed in Chef Infra Client 13.
-        #
-        # @example
-        #
-        #   ### incorrect
-        #   require 'chef/mixin/command'
-        #   include Chef::Mixin::Command
-        #
-        #   run_command('/bin/foo')
-        #   run_command_with_systems_locale('/bin/foo')
-        #
-        #   ### correct
-        #   shell_out!('/bin/foo')
-        #
-        class UsesRunCommandHelper < Base
-          MSG = "Use 'shell_out!' instead of the legacy 'run_command' or 'run_command_with_systems_locale' helpers for shelling out. The run_command helper was removed in Chef Infra Client 13."
-          RESTRICT_ON_SEND = [:require, :run_command, :run_command_with_systems_locale, :include].freeze
-
-          def_node_matcher :calls_run_command?, '(send nil? {:run_command :run_command_with_systems_locale} ...)'
-          def_node_matcher :require_mixin_command?, '(send nil? :require (str "chef/mixin/command"))'
-          def_node_matcher :include_mixin_command?, '(send nil? :include (const (const (const nil? :Chef) :Mixin) :Command))'
-
-          def_node_search :defines_run_command?, '(def {:run_command :run_command_with_systems_locale} ...)'
-
-          def on_send(node)
-            calls_run_command?(node) do
-              add_offense(node, severity: :warning) unless defines_run_command?(processed_source.ast)
-            end
-
-            require_mixin_command?(node) do
-              add_offense(node, severity: :warning)
-            end
-
-            include_mixin_command?(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
+        # Use 'shell_out!' instead of the legacy 'run_command' or 'run_command_with_systems_locale' helpers for shelling out. The run_command helper was removed in Chef Infra Client 13.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   require 'chef/mixin/command'
+        #   include Chef::Mixin::Command
+        #
+        #   run_command('/bin/foo')
+        #   run_command_with_systems_locale('/bin/foo')
+        #
+        #   ### correct
+        #   shell_out!('/bin/foo')
+        #
+        class UsesRunCommandHelper < Base
+          MSG = "Use 'shell_out!' instead of the legacy 'run_command' or 'run_command_with_systems_locale' helpers for shelling out. The run_command helper was removed in Chef Infra Client 13."
+          RESTRICT_ON_SEND = [:require, :run_command, :run_command_with_systems_locale, :include].freeze
+
+          def_node_matcher :calls_run_command?, '(send nil? {:run_command :run_command_with_systems_locale} ...)'
+          def_node_matcher :require_mixin_command?, '(send nil? :require (str "chef/mixin/command"))'
+          def_node_matcher :include_mixin_command?, '(send nil? :include (const (const (const nil? :Chef) :Mixin) :Command))'
+
+          def_node_search :defines_run_command?, '(def {:run_command :run_command_with_systems_locale} ...)'
+
+          def on_send(node)
+            calls_run_command?(node) do
+              add_offense(node, severity: :warning) unless defines_run_command?(processed_source.ast)
+            end
+
+            require_mixin_command?(node) do
+              add_offense(node, severity: :warning)
+            end
+
+            include_mixin_command?(node) do
+              add_offense(node, severity: :warning)
+            end
+          end
+        end
+      end
+    end
+  end
+end