cookstyle 7.32.8 → 8.0.0

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
-        #
-        #   ### incorrect
-        #   depends 'libarchive'
-        #
-        #   libarchive_file "C:\file.zip" do
-        #     path 'C:\expand_here'
-        #   end
-        #
-        #   ### correct
-        #   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-hq/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:: 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
+        #
+        #   ### incorrect
+        #   depends 'libarchive'
+        #
+        #   libarchive_file "C:\file.zip" do
+        #     path 'C:\expand_here'
+        #   end
+        #
+        #   ### correct
+        #   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-hq/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
-        #
-        #   ### incorrect
-        #   mac_os_x_userdefaults 'full keyboard access to all controls' do
-        #     domain 'AppleKeyboardUIMode'
-        #     global true
-        #     value '2'
-        #   end
-        #
-        #   ### correct
-        #   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:: 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
+        #
+        #   ### incorrect
+        #   mac_os_x_userdefaults 'full keyboard access to all controls' do
+        #     domain 'AppleKeyboardUIMode'
+        #     global true
+        #     value '2'
+        #   end
+        #
+        #   ### correct
+        #   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
-        #
-        #   ### incorrect
-        #   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:: 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
+        #
+        #   ### incorrect
+        #   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

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

@@ -1,89 +1,89 @@
-# 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
-        # Use node['init_package'] to check for systemd instead of reading the contents of '/proc/1/comm'
-        #
-        # @example
-        #
-        #   ### incorrect
-        #   ::File.open('/proc/1/comm').gets.chomp == 'systemd'
-        #   ::File.open('/proc/1/comm').chomp == 'systemd'
-        #   File.open('/proc/1/comm').gets.chomp == 'systemd'
-        #   File.open('/proc/1/comm').chomp == 'systemd'
-        #   IO.read('/proc/1/comm').chomp == 'systemd'
-        #   IO.read('/proc/1/comm').gets.chomp == 'systemd'
-        #   ::IO.read('/proc/1/comm').chomp == 'systemd'
-        #   ::IO.read('/proc/1/comm').gets.chomp == 'systemd'
-        #   File.exist?('/proc/1/comm') && File.open('/proc/1/comm').chomp == 'systemd'
-        #   only_if 'test -f /bin/systemctl && /bin/systemctl'
-        #
-        #   ### correct
-        #   node['init_package'] == 'systemd'
-        #   only_if { node['init_package'] == 'systemd' }
-        #
-        class NodeInitPackage < Base
-          extend RuboCop::Cop::AutoCorrector
-
-          MSG = "Use node['init_package'] to check for systemd instead of reading the contents of '/proc/1/comm'"
-          RESTRICT_ON_SEND = [:open, :read, :exist?, :==, :not_if, :only_if].freeze
-
-          def_node_matcher :file_reads_proc_1_comm?, <<-PATTERN
-            (send (const {(cbase) nil?} {:File :IO}) {:open :read} (str "/proc/1/comm"))
-          PATTERN
-
-          def_node_matcher :proc_1_comm_exists?, <<-PATTERN
-            (send
-              (const
-                {(cbase) nil?} :File) :exist?
-              (str "/proc/1/comm"))
-          PATTERN
-
-          def_node_matcher :compare_init_system?, <<-PATTERN
-            (send
-              (send {#file_reads_proc_1_comm? (send #file_reads_proc_1_comm? :gets) } :chomp)
-                :== (str "systemd"))
-          PATTERN
-
-          def_node_matcher :file_systemd_conditional?, <<~PATTERN
-            (send nil? {:not_if :only_if} $(str "test -f /bin/systemctl && /bin/systemctl"))
-          PATTERN
-
-          def on_send(node)
-            compare_init_system?(node) do
-              # if there's a ::File.exist?('/proc/1/comm') check first we want to match that as well
-              node = node.parent if node.parent&.and_type? && proc_1_comm_exists?(node.parent.conditions.first)
-
-              add_offense(node, severity: :refactor) do |corrector|
-                corrector.replace(node, "node['init_package'] == 'systemd'")
-              end
-            end
-
-            file_systemd_conditional?(node) do |conditional|
-              add_offense(node, severity: :refactor) do |corrector|
-                corrector.replace(conditional, "{ node['init_package'] == 'systemd' }")
-              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 Modernize
+        # Use node['init_package'] to check for systemd instead of reading the contents of '/proc/1/comm'
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   ::File.open('/proc/1/comm').gets.chomp == 'systemd'
+        #   ::File.open('/proc/1/comm').chomp == 'systemd'
+        #   File.open('/proc/1/comm').gets.chomp == 'systemd'
+        #   File.open('/proc/1/comm').chomp == 'systemd'
+        #   IO.read('/proc/1/comm').chomp == 'systemd'
+        #   IO.read('/proc/1/comm').gets.chomp == 'systemd'
+        #   ::IO.read('/proc/1/comm').chomp == 'systemd'
+        #   ::IO.read('/proc/1/comm').gets.chomp == 'systemd'
+        #   File.exist?('/proc/1/comm') && File.open('/proc/1/comm').chomp == 'systemd'
+        #   only_if 'test -f /bin/systemctl && /bin/systemctl'
+        #
+        #   ### correct
+        #   node['init_package'] == 'systemd'
+        #   only_if { node['init_package'] == 'systemd' }
+        #
+        class NodeInitPackage < Base
+          extend RuboCop::Cop::AutoCorrector
+
+          MSG = "Use node['init_package'] to check for systemd instead of reading the contents of '/proc/1/comm'"
+          RESTRICT_ON_SEND = [:open, :read, :exist?, :==, :not_if, :only_if].freeze
+
+          def_node_matcher :file_reads_proc_1_comm?, <<-PATTERN
+            (send (const {(cbase) nil?} {:File :IO}) {:open :read} (str "/proc/1/comm"))
+          PATTERN
+
+          def_node_matcher :proc_1_comm_exists?, <<-PATTERN
+            (send
+              (const
+                {(cbase) nil?} :File) :exist?
+              (str "/proc/1/comm"))
+          PATTERN
+
+          def_node_matcher :compare_init_system?, <<-PATTERN
+            (send
+              (send {#file_reads_proc_1_comm? (send #file_reads_proc_1_comm? :gets) } :chomp)
+                :== (str "systemd"))
+          PATTERN
+
+          def_node_matcher :file_systemd_conditional?, <<~PATTERN
+            (send nil? {:not_if :only_if} $(str "test -f /bin/systemctl && /bin/systemctl"))
+          PATTERN
+
+          def on_send(node)
+            compare_init_system?(node) do
+              # if there's a ::File.exist?('/proc/1/comm') check first we want to match that as well
+              node = node.parent if node.parent&.and_type? && proc_1_comm_exists?(node.parent.conditions.first)
+
+              add_offense(node, severity: :refactor) do |corrector|
+                corrector.replace(node, "node['init_package'] == 'systemd'")
+              end
+            end
+
+            file_systemd_conditional?(node) do |conditional|
+              add_offense(node, severity: :refactor) do |corrector|
+                corrector.replace(conditional, "{ node['init_package'] == 'systemd' }")
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,57 +1,57 @@
-# 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
-        # Use `node.role?('foo')` to check if a node includes a role instead of `node['roles'].include?('foo')`.
-        #
-        # @example
-        #
-        #   ### incorrect
-        #   node['roles'].include?('foo')
-        #
-        #   ### correct
-        #   node.role?('foo')
-        #
-        class NodeRolesInclude < Base
-          extend AutoCorrector
-
-          MSG = "Use `node.role?('foo')` to check if a node includes a role instead of `node['roles'].include?('foo')`."
-          RESTRICT_ON_SEND = [:include?].freeze
-
-          def_node_matcher :node_role_include?, <<-PATTERN
-          (send
-            (send
-              (send nil? :node) :[]
-              (str "roles")) :include?
-            $(...))
-          PATTERN
-
-          def on_send(node)
-            node_role_include?(node) do |val|
-              add_offense(node, severity: :refactor) do |corrector|
-                corrector.replace(node, "node.role?(#{val.source})")
-              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 Modernize
+        # Use `node.role?('foo')` to check if a node includes a role instead of `node['roles'].include?('foo')`.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   node['roles'].include?('foo')
+        #
+        #   ### correct
+        #   node.role?('foo')
+        #
+        class NodeRolesInclude < Base
+          extend AutoCorrector
+
+          MSG = "Use `node.role?('foo')` to check if a node includes a role instead of `node['roles'].include?('foo')`."
+          RESTRICT_ON_SEND = [:include?].freeze
+
+          def_node_matcher :node_role_include?, <<-PATTERN
+          (send
+            (send
+              (send nil? :node) :[]
+              (str "roles")) :include?
+            $(...))
+          PATTERN
+
+          def on_send(node)
+            node_role_include?(node) do |val|
+              add_offense(node, severity: :refactor) do |corrector|
+                corrector.replace(node, "node.role?(#{val.source})")
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end