cookstyle 8.6.4 → 8.7.6

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
-        #
-        #   # bad
-        #   execute "sleep 60" do
-        #     command "sleep 60"
-        #     action :run
-        #   end
-        #
-        #   bash 'sleep' do
-        #     user 'root'
-        #     cwd '/tmp'
-        #     code 'sleep 60'
-        #   end
-        #
-        #   # good
-        #   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
+# 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
+        # 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
+        #
+        #   # bad
+        #   execute "sleep 60" do
+        #     command "sleep 60"
+        #     action :run
+        #   end
+        #
+        #   bash 'sleep' do
+        #     user 'root'
+        #     cwd '/tmp'
+        #     code 'sleep 60'
+        #   end
+        #
+        #   # good
+        #   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

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

@@ -1,70 +1,70 @@
-# 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 Modernize
-        # Chef Infra Client 14.0 and later includes a sysctl resource that should be used to idempotently load sysctl values instead of templating files and using execute to load them.
-        #
-        # @example
-        #
-        #   # bad
-        #   file '/etc/sysctl.d/ipv4.conf' do
-        #     notifies :run, 'execute[sysctl -p /etc/sysctl.d/ipv4.conf]', :immediately
-        #     content '9000 65500'
-        #   end
-        #
-        #   execute 'sysctl -p /etc/sysctl.d/ipv4.conf' do
-        #     action :nothing
-        #   end
-        #
-        #   # good
-        #   sysctl 'net.ipv4.ip_local_port_range' do
-        #     value '9000 65500'
-        #   end
-        #
-        class ExecuteSysctl < Base
-          include RuboCop::Chef::CookbookHelpers
-          extend TargetChefVersion
-
-          minimum_target_chef_version '14.0'
-
-          MSG = 'Chef Infra Client 14.0 and later includes a sysctl resource that should be used to idempotently load sysctl values instead of templating files and using execute to load them.'
-          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?(/^("|')sysctl -p/)
-            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?(%r{^(/sbin/)?sysctl -p}i)
-              add_offense(node, severity: :refactor)
-            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
+        # Chef Infra Client 14.0 and later includes a sysctl resource that should be used to idempotently load sysctl values instead of templating files and using execute to load them.
+        #
+        # @example
+        #
+        #   # bad
+        #   file '/etc/sysctl.d/ipv4.conf' do
+        #     notifies :run, 'execute[sysctl -p /etc/sysctl.d/ipv4.conf]', :immediately
+        #     content '9000 65500'
+        #   end
+        #
+        #   execute 'sysctl -p /etc/sysctl.d/ipv4.conf' do
+        #     action :nothing
+        #   end
+        #
+        #   # good
+        #   sysctl 'net.ipv4.ip_local_port_range' do
+        #     value '9000 65500'
+        #   end
+        #
+        class ExecuteSysctl < Base
+          include RuboCop::Chef::CookbookHelpers
+          extend TargetChefVersion
+
+          minimum_target_chef_version '14.0'
+
+          MSG = 'Chef Infra Client 14.0 and later includes a sysctl resource that should be used to idempotently load sysctl values instead of templating files and using execute to load them.'
+          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?(/^("|')sysctl -p/)
+            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?(%r{^(/sbin/)?sysctl -p}i)
+              add_offense(node, severity: :refactor)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,83 +1,83 @@
-# 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
-        # Instead of using the execute or powershell_script resources to run the `tzutil` command, use Chef Infra Client's built-in timezone resource which is available in Chef Infra Client 14.6 and later.
-        #
-        # @example
-        #
-        #   # bad
-        #   execute 'set tz' do
-        #     command 'tzutil.exe /s UTC'
-        #   end
-        #
-        #   execute 'tzutil /s UTC'
-        #
-        #   powershell_script 'set windows timezone' do
-        #     code "tzutil.exe /s UTC"
-        #     not_if { shell_out('tzutil.exe /g').stdout.include?('UTC') }
-        #   end
-        #
-        #   # good
-        #   timezone 'UTC'
-        #
-        class ExecuteTzUtil < Base
-          include RuboCop::Chef::CookbookHelpers
-          extend TargetChefVersion
-
-          minimum_target_chef_version '14.6'
-
-          MSG = 'Use the timezone resource included in Chef Infra Client 14.6+ instead of shelling out to tzutil'
-          RESTRICT_ON_SEND = [:execute].freeze
-
-          def_node_matcher :execute_resource?, <<-PATTERN
-            (send nil? :execute $str)
-          PATTERN
-
-          def on_send(node)
-            execute_resource?(node) do
-              return unless node.arguments.first.value.match?(/^tzutil/i)
-              add_offense(node, severity: :refactor)
-            end
-          end
-
-          def on_block(node)
-            match_property_in_resource?(:execute, 'command', node) do |code_property|
-              next unless calls_tzutil?(code_property)
-              add_offense(node, severity: :refactor)
-            end
-
-            match_property_in_resource?(:powershell_script, 'code', node) do |code_property|
-              next unless calls_tzutil?(code_property)
-              add_offense(node, severity: :refactor)
-            end
-          end
-
-          private
-
-          def calls_tzutil?(ast_obj)
-            property_data = method_arg_ast_to_string(ast_obj)
-            true if property_data && property_data.match?(/^tzutil/i)
-          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
+        # Instead of using the execute or powershell_script resources to run the `tzutil` command, use Chef Infra Client's built-in timezone resource which is available in Chef Infra Client 14.6 and later.
+        #
+        # @example
+        #
+        #   # bad
+        #   execute 'set tz' do
+        #     command 'tzutil.exe /s UTC'
+        #   end
+        #
+        #   execute 'tzutil /s UTC'
+        #
+        #   powershell_script 'set windows timezone' do
+        #     code "tzutil.exe /s UTC"
+        #     not_if { shell_out('tzutil.exe /g').stdout.include?('UTC') }
+        #   end
+        #
+        #   # good
+        #   timezone 'UTC'
+        #
+        class ExecuteTzUtil < Base
+          include RuboCop::Chef::CookbookHelpers
+          extend TargetChefVersion
+
+          minimum_target_chef_version '14.6'
+
+          MSG = 'Use the timezone resource included in Chef Infra Client 14.6+ instead of shelling out to tzutil'
+          RESTRICT_ON_SEND = [:execute].freeze
+
+          def_node_matcher :execute_resource?, <<-PATTERN
+            (send nil? :execute $str)
+          PATTERN
+
+          def on_send(node)
+            execute_resource?(node) do
+              return unless node.arguments.first.value.match?(/^tzutil/i)
+              add_offense(node, severity: :refactor)
+            end
+          end
+
+          def on_block(node)
+            match_property_in_resource?(:execute, 'command', node) do |code_property|
+              next unless calls_tzutil?(code_property)
+              add_offense(node, severity: :refactor)
+            end
+
+            match_property_in_resource?(:powershell_script, 'code', node) do |code_property|
+              next unless calls_tzutil?(code_property)
+              add_offense(node, severity: :refactor)
+            end
+          end
+
+          private
+
+          def calls_tzutil?(ast_obj)
+            property_data = method_arg_ast_to_string(ast_obj)
+            true if property_data && property_data.match?(/^tzutil/i)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,46 +1,46 @@
-# frozen_string_literal: true
-#
-# Copyright:: 2016-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
-        # Remove legacy code comments that disable Foodcritic rules. These comments are no longer necessary if you've migrated from Foodcritic to Cookstyle for cookbook linting.
-        #
-        # @example
-        #
-        #   # bad
-        #   # ~FC013
-        #
-        class FoodcriticComments < Base
-          extend AutoCorrector
-
-          MSG = 'Remove legacy code comments that disable Foodcritic rules'
-
-          def on_new_investigation
-            processed_source.comments.each do |comment|
-              next unless comment.text.match?(/#\s*~FC\d{3}.*/)
-              add_offense(comment, severity: :refactor) do |corrector|
-                corrector.remove(comment)
-              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
+        # Remove legacy code comments that disable Foodcritic rules. These comments are no longer necessary if you've migrated from Foodcritic to Cookstyle for cookbook linting.
+        #
+        # @example
+        #
+        #   # bad
+        #   # ~FC013
+        #
+        class FoodcriticComments < Base
+          extend AutoCorrector
+
+          MSG = 'Remove legacy code comments that disable Foodcritic rules'
+
+          def on_new_investigation
+            processed_source.comments.each do |comment|
+              next unless comment.text.match?(/#\s*~FC\d{3}.*/)
+              add_offense(comment, severity: :refactor) do |corrector|
+                corrector.remove(comment)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,48 +1,48 @@
-# 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
-        # if defined?(default_action) is no longer necessary in Chef Resources as default_action shipped in Chef 10.8.
-        #
-        # @example
-        #
-        #   # bad
-        #   default_action :foo if defined?(default_action)
-        #
-        #   # good
-        #   default_action :foo
-        #
-        class IfProvidesDefaultAction < Base
-          extend AutoCorrector
-
-          MSG = 'if defined?(default_action) is no longer necessary in Chef Resources as default_action shipped in Chef 10.8.'
-
-          def on_defined?(node)
-            return unless node.arguments.first == s(:send, nil, :default_action)
-            node = node.parent if node.parent.respond_to?(:if?) && node.parent.if? # we want the whole if statement
-            add_offense(node, severity: :refactor) do |corrector|
-              corrector.replace(node, node.children[1].source)
-            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
+        # if defined?(default_action) is no longer necessary in Chef Resources as default_action shipped in Chef 10.8.
+        #
+        # @example
+        #
+        #   # bad
+        #   default_action :foo if defined?(default_action)
+        #
+        #   # good
+        #   default_action :foo
+        #
+        class IfProvidesDefaultAction < Base
+          extend AutoCorrector
+
+          MSG = 'if defined?(default_action) is no longer necessary in Chef Resources as default_action shipped in Chef 10.8.'
+
+          def on_defined?(node)
+            return unless node.arguments.first == s(:send, nil, :default_action)
+            node = node.parent if node.parent.respond_to?(:if?) && node.parent.if? # we want the whole if statement
+            add_offense(node, severity: :refactor) do |corrector|
+              corrector.replace(node, node.children[1].source)
+            end
+          end
+        end
+      end
+    end
+  end
+end