cookstyle 8.6.4 → 8.7.6

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

@@ -1,83 +1,83 @@
-# 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
-        # There is no need to include Chef::Mixin::ShellOut or Chef::Mixin::PowershellOut in resources or providers as this is already done by Chef Infra Client 12.4+.
-        #
-        # @example
-        #
-        #   # bad
-        #   require 'chef/mixin/shell_out'
-        #   include Chef::Mixin::ShellOut
-        #   require 'chef/mixin/powershell_out'
-        #   include Chef::Mixin::PowershellOut
-        #
-        class IncludingMixinShelloutInResources < Base
-          extend AutoCorrector
-          include RangeHelp
-
-          MSG = 'There is no need to include Chef::Mixin::ShellOut or Chef::Mixin::PowershellOut in resources or providers as this is already done by Chef Infra Client 12.4+.'
-          RESTRICT_ON_SEND = [:include, :require].freeze
-
-          def_node_matcher :include_shellout?, <<-PATTERN
-            (send nil? :include (const (const (const nil? :Chef) :Mixin) {:ShellOut :PowershellOut}))
-          PATTERN
-
-          def_node_matcher :require_shellout?, <<-PATTERN
-            (send nil? :require ( str {"chef/mixin/shell_out" "chef/mixin/powershell_out"} ))
-          PATTERN
-
-          def_node_search :hwrp_classes?, <<-PATTERN
-            (class
-              (const ... )
-              {(const
-                (const
-                  (const nil? :Chef) :Provider) :LWRPBase)
-               (const
-                 (const nil? :Chef) :Provider)
-               }
-              ...)
-          PATTERN
-
-          def check_for_offenses(node)
-            containing_dir = File.basename(File.dirname(processed_source.path))
-
-            # only add offenses when we're in a custom resource or HWRP, but not a plain old library
-            if containing_dir == 'resources' || hwrp_classes?(processed_source.ast)
-              add_offense(node, severity: :refactor) do |corrector|
-                corrector.remove(range_with_surrounding_space(range: node.loc.expression, side: :left))
-              end
-            end
-          end
-
-          def on_send(node)
-            require_shellout?(node) do
-              check_for_offenses(node)
-            end
-
-            include_shellout?(node) do
-              check_for_offenses(node)
-            end
-          end
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+#
+# Copyright:: Copyright (c) 2016-2025 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
+# 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 to include Chef::Mixin::ShellOut or Chef::Mixin::PowershellOut in resources or providers as this is already done by Chef Infra Client 12.4+.
+        #
+        # @example
+        #
+        #   # bad
+        #   require 'chef/mixin/shell_out'
+        #   include Chef::Mixin::ShellOut
+        #   require 'chef/mixin/powershell_out'
+        #   include Chef::Mixin::PowershellOut
+        #
+        class IncludingMixinShelloutInResources < Base
+          extend AutoCorrector
+          include RangeHelp
+
+          MSG = 'There is no need to include Chef::Mixin::ShellOut or Chef::Mixin::PowershellOut in resources or providers as this is already done by Chef Infra Client 12.4+.'
+          RESTRICT_ON_SEND = [:include, :require].freeze
+
+          def_node_matcher :include_shellout?, <<-PATTERN
+            (send nil? :include (const (const (const nil? :Chef) :Mixin) {:ShellOut :PowershellOut}))
+          PATTERN
+
+          def_node_matcher :require_shellout?, <<-PATTERN
+            (send nil? :require ( str {"chef/mixin/shell_out" "chef/mixin/powershell_out"} ))
+          PATTERN
+
+          def_node_search :hwrp_classes?, <<-PATTERN
+            (class
+              (const ... )
+              {(const
+                (const
+                  (const nil? :Chef) :Provider) :LWRPBase)
+               (const
+                 (const nil? :Chef) :Provider)
+               }
+              ...)
+          PATTERN
+
+          def check_for_offenses(node)
+            containing_dir = File.basename(File.dirname(processed_source.path))
+
+            # only add offenses when we're in a custom resource or HWRP, but not a plain old library
+            if containing_dir == 'resources' || hwrp_classes?(processed_source.ast)
+              add_offense(node, severity: :refactor) do |corrector|
+                corrector.remove(range_with_surrounding_space(range: node.loc.expression, side: :left))
+              end
+            end
+          end
+
+          def on_send(node)
+            require_shellout?(node) do
+              check_for_offenses(node)
+            end
+
+            include_shellout?(node) do
+              check_for_offenses(node)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,70 +1,70 @@
-# 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
-        # Use the archive_file resource built into Chef Infra Client 15+ instead of the libarchive_file resource from the libarchive cookbook.
-        #
-        # @example
-        #
-        #   # bad
-        #   depends 'libarchive'
-        #
-        #   libarchive_file "C:\file.zip" do
-        #     path 'C:\expand_here'
-        #   end
-        #
-        #   # good
-        #   archive_file "C:\file.zip" do
-        #     path 'C:\expand_here'
-        #   end
-        #
-        class LibarchiveFileResource < Base
-          extend TargetChefVersion
-          extend AutoCorrector
-
-          minimum_target_chef_version '15.0'
-
-          MSG = 'Use the archive_file resource built into Chef Infra Client 15+ instead of the libarchive_file resource from the libarchive cookbook'
-          RESTRICT_ON_SEND = [:libarchive_file, :notifies, :subscribes].freeze
-
-          def_node_matcher :notification_property?, <<-PATTERN
-            (send nil? {:notifies :subscribes} (sym _) $(...) (sym _))
-          PATTERN
-
-          def on_send(node)
-            # The need for this goes away once https://github.com/rubocop/rubocop/pull/8365 is pulled into Cookstyle
-            if node.method?(:libarchive_file)
-              add_offense(node, severity: :refactor) do |corrector|
-                corrector.replace(node, node.source.gsub('libarchive_file', 'archive_file'))
-              end
-            end
-
-            notification_property?(node) do |val|
-              next unless val.str_content&.start_with?('libarchive_file')
-              add_offense(val, severity: :refactor) do |corrector|
-                corrector.replace(node, node.source.gsub('libarchive_file', 'archive_file'))
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+#
+# Copyright:: Copyright (c) 2016-2025 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
+# 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 libarchive_file resource from the libarchive cookbook.
+        #
+        # @example
+        #
+        #   # bad
+        #   depends 'libarchive'
+        #
+        #   libarchive_file "C:\file.zip" do
+        #     path 'C:\expand_here'
+        #   end
+        #
+        #   # good
+        #   archive_file "C:\file.zip" do
+        #     path 'C:\expand_here'
+        #   end
+        #
+        class LibarchiveFileResource < Base
+          extend TargetChefVersion
+          extend AutoCorrector
+
+          minimum_target_chef_version '15.0'
+
+          MSG = 'Use the archive_file resource built into Chef Infra Client 15+ instead of the libarchive_file resource from the libarchive cookbook'
+          RESTRICT_ON_SEND = [:libarchive_file, :notifies, :subscribes].freeze
+
+          def_node_matcher :notification_property?, <<-PATTERN
+            (send nil? {:notifies :subscribes} (sym _) $(...) (sym _))
+          PATTERN
+
+          def on_send(node)
+            # The need for this goes away once https://github.com/rubocop/rubocop/pull/8365 is pulled into Cookstyle
+            if node.method?(:libarchive_file)
+              add_offense(node, severity: :refactor) do |corrector|
+                corrector.replace(node, node.source.gsub('libarchive_file', 'archive_file'))
+              end
+            end
+
+            notification_property?(node) do |val|
+              next unless val.str_content&.start_with?('libarchive_file')
+              add_offense(val, severity: :refactor) do |corrector|
+                corrector.replace(node, node.source.gsub('libarchive_file', 'archive_file'))
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,58 +1,58 @@
-# 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 mac_os_x_userdefaults resource was renamed to macos_userdefaults when it was added to Chef Infra Client 14.0. The new resource name should be used.
-        #
-        # @example
-        #
-        #   # bad
-        #   mac_os_x_userdefaults 'full keyboard access to all controls' do
-        #     domain 'AppleKeyboardUIMode'
-        #     global true
-        #     value '2'
-        #   end
-        #
-        #   # good
-        #   macos_userdefaults 'full keyboard access to all controls' do
-        #     domain 'AppleKeyboardUIMode'
-        #     global true
-        #     value '2'
-        #   end
-        #
-        class MacOsXUserdefaults < Base
-          extend TargetChefVersion
-          extend AutoCorrector
-
-          minimum_target_chef_version '14.0'
-
-          MSG = 'The mac_os_x_userdefaults resource was renamed to macos_userdefaults when it was added to Chef Infra Client 14.0. The new resource name should be used.'
-          RESTRICT_ON_SEND = [:mac_os_x_userdefaults].freeze
-
-          def on_send(node)
-            add_offense(node, severity: :refactor) do |corrector|
-              corrector.replace(node, node.source.gsub(/^mac_os_x_userdefaults/, 'macos_userdefaults'))
-            end
-          end
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+#
+# Copyright:: Copyright (c) 2016-2025 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
+# 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 mac_os_x_userdefaults resource was renamed to macos_userdefaults when it was added to Chef Infra Client 14.0. The new resource name should be used.
+        #
+        # @example
+        #
+        #   # bad
+        #   mac_os_x_userdefaults 'full keyboard access to all controls' do
+        #     domain 'AppleKeyboardUIMode'
+        #     global true
+        #     value '2'
+        #   end
+        #
+        #   # good
+        #   macos_userdefaults 'full keyboard access to all controls' do
+        #     domain 'AppleKeyboardUIMode'
+        #     global true
+        #     value '2'
+        #   end
+        #
+        class MacOsXUserdefaults < Base
+          extend TargetChefVersion
+          extend AutoCorrector
+
+          minimum_target_chef_version '14.0'
+
+          MSG = 'The mac_os_x_userdefaults resource was renamed to macos_userdefaults when it was added to Chef Infra Client 14.0. The new resource name should be used.'
+          RESTRICT_ON_SEND = [:mac_os_x_userdefaults].freeze
+
+          def on_send(node)
+            add_offense(node, severity: :refactor) do |corrector|
+              corrector.replace(node, node.source.gsub(/^mac_os_x_userdefaults/, 'macos_userdefaults'))
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,51 +1,51 @@
-# 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 Chef InSpec for testing instead of the Minitest Handler cookbook pattern.
-        #
-        # @example
-        #
-        #   # bad
-        #   depends 'minitest-handler'
-        #
-        class MinitestHandlerUsage < Base
-          extend AutoCorrector
-          include RangeHelp
-
-          MSG = 'Use Chef InSpec for testing instead of the Minitest Handler cookbook pattern.'
-          RESTRICT_ON_SEND = [:depends].freeze
-
-          def_node_matcher :minitest_depends?, <<-PATTERN
-            (send nil? :depends (str "minitest-handler"))
-          PATTERN
-
-          def on_send(node)
-            minitest_depends?(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:: Copyright (c) 2016-2025 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
+# 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 Chef InSpec for testing instead of the Minitest Handler cookbook pattern.
+        #
+        # @example
+        #
+        #   # bad
+        #   depends 'minitest-handler'
+        #
+        class MinitestHandlerUsage < Base
+          extend AutoCorrector
+          include RangeHelp
+
+          MSG = 'Use Chef InSpec for testing instead of the Minitest Handler cookbook pattern.'
+          RESTRICT_ON_SEND = [:depends].freeze
+
+          def_node_matcher :minitest_depends?, <<-PATTERN
+            (send nil? :depends (str "minitest-handler"))
+          PATTERN
+
+          def on_send(node)
+            minitest_depends?(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