cookstyle 7.32.8 → 8.0.0

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

@@ -1,98 +1,98 @@
-# 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 `delete_resource` or `edit_resource` helpers introduced in Chef Infra Client 12.10 instead of functionality in the deprecated `chef-rewind` gem
-        #
-        # @example
-        #
-        #   chef_gem 'chef-rewind'
-        #
-        #   require 'chef/rewind'
-        #
-        #   rewind "user[postgres]" do
-        #     home '/var/lib/pgsql/9.2'
-        #     cookbook 'my-postgresql'
-        #   end
-        #
-        #   unwind "user[postgres]"
-        #
-        class ChefRewind < Base
-          include RuboCop::Chef::CookbookHelpers
-          include RangeHelp
-          extend TargetChefVersion
-          extend AutoCorrector
-
-          minimum_target_chef_version '12.10'
-
-          MAPPING = {
-            rewind: 'edit_resource',
-            unwind: 'delete_resource',
-          }.freeze
-
-          MSG = 'Use delete_resource or edit_resource helpers introduced in Chef Infra Client 12.10 instead of functionality in the deprecated chef-rewind gem'
-          RESTRICT_ON_SEND = [:chef_gem, :require, :rewind, :unwind].freeze
-
-          def_node_matcher :rewind_gem_install?, <<-PATTERN
-            (send nil? :chef_gem (str "chef-rewind"))
-          PATTERN
-
-          def_node_matcher :require_rewind?, <<-PATTERN
-            (send nil? :require (str "chef/rewind"))
-          PATTERN
-
-          def_node_matcher :rewind_resources?, <<-PATTERN
-            (send nil? ${:rewind :unwind} ... )
-          PATTERN
-
-          def on_send(node)
-            rewind_gem_install?(node) do
-              add_offense(node, severity: :warning) do |corrector|
-                node = node.parent if node.parent&.block_type? # make sure we get the whole block not just the method in the block
-                corrector.remove(range_with_surrounding_space(range: node.loc.expression, side: :left))
-              end
-            end
-
-            require_rewind?(node) do
-              add_offense(node, severity: :warning) do |corrector|
-                corrector.remove(range_with_surrounding_space(range: node.loc.expression, side: :left))
-              end
-            end
-
-            rewind_resources?(node) do |string|
-              add_offense(node, severity: :warning) do |corrector|
-                corrector.replace(node, node.source.gsub(string.to_s, MAPPING[string]))
-              end
-            end
-          end
-
-          def on_block(node)
-            match_property_in_resource?(:chef_gem, 'package_name', node) do |pkg_name|
-              next unless pkg_name.arguments&.first&.str_content == 'chef-rewind'
-              add_offense(node, severity: :warning) do |corrector|
-                corrector.remove(node) if pkg_name.arguments&.first&.str_content == 'chef-rewind'
-              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 `delete_resource` or `edit_resource` helpers introduced in Chef Infra Client 12.10 instead of functionality in the deprecated `chef-rewind` gem
+        #
+        # @example
+        #
+        #   chef_gem 'chef-rewind'
+        #
+        #   require 'chef/rewind'
+        #
+        #   rewind "user[postgres]" do
+        #     home '/var/lib/pgsql/9.2'
+        #     cookbook 'my-postgresql'
+        #   end
+        #
+        #   unwind "user[postgres]"
+        #
+        class ChefRewind < Base
+          include RuboCop::Chef::CookbookHelpers
+          include RangeHelp
+          extend TargetChefVersion
+          extend AutoCorrector
+
+          minimum_target_chef_version '12.10'
+
+          MAPPING = {
+            rewind: 'edit_resource',
+            unwind: 'delete_resource',
+          }.freeze
+
+          MSG = 'Use delete_resource or edit_resource helpers introduced in Chef Infra Client 12.10 instead of functionality in the deprecated chef-rewind gem'
+          RESTRICT_ON_SEND = [:chef_gem, :require, :rewind, :unwind].freeze
+
+          def_node_matcher :rewind_gem_install?, <<-PATTERN
+            (send nil? :chef_gem (str "chef-rewind"))
+          PATTERN
+
+          def_node_matcher :require_rewind?, <<-PATTERN
+            (send nil? :require (str "chef/rewind"))
+          PATTERN
+
+          def_node_matcher :rewind_resources?, <<-PATTERN
+            (send nil? ${:rewind :unwind} ... )
+          PATTERN
+
+          def on_send(node)
+            rewind_gem_install?(node) do
+              add_offense(node, severity: :warning) do |corrector|
+                node = node.parent if node.parent&.block_type? # make sure we get the whole block not just the method in the block
+                corrector.remove(range_with_surrounding_space(range: node.loc.expression, side: :left))
+              end
+            end
+
+            require_rewind?(node) do
+              add_offense(node, severity: :warning) do |corrector|
+                corrector.remove(range_with_surrounding_space(range: node.loc.expression, side: :left))
+              end
+            end
+
+            rewind_resources?(node) do |string|
+              add_offense(node, severity: :warning) do |corrector|
+                corrector.replace(node, node.source.gsub(string.to_s, MAPPING[string]))
+              end
+            end
+          end
+
+          def on_block(node)
+            match_property_in_resource?(:chef_gem, 'package_name', node) do |pkg_name|
+              next unless pkg_name.arguments&.first&.str_content == 'chef-rewind'
+              add_offense(node, severity: :warning) do |corrector|
+                corrector.remove(node) if pkg_name.arguments&.first&.str_content == 'chef-rewind'
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,83 +1,83 @@
-# 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
-        # Don't use the deprecated `Chef::ShellOut` class which was removed in Chef Infra Client 13. Use the `Mixlib::ShellOut` class instead, which behaves identically or convert to the simpler `shell_out` helper.
-        #
-        # @example
-        #
-        #   ### incorrect
-        #   include Chef::ShellOut
-        #   require 'chef/shellout'
-        #   Chef::ShellOut.new('some_command')
-        #
-        #   ### correct
-        #   include Mixlib::ShellOut
-        #   require 'mixlib/shellout'
-        #   Mixlib::ShellOut.new('some_command')
-        #
-        class ChefShellout < Base
-          include RangeHelp
-          extend AutoCorrector
-
-          MSG = "Don't use the deprecated `Chef::ShellOut` class which was removed in Chef Infra Client 13. Use the `Mixlib::ShellOut` class instead, which behaves identically."
-          RESTRICT_ON_SEND = [:new, :require, :include].freeze
-
-          def_node_matcher :include_shellout?, <<-PATTERN
-          (send nil? :include
-            (const
-              (const nil? :Chef) :ShellOut))
-          PATTERN
-
-          def_node_matcher :require_shellout?, <<-PATTERN
-          (send nil? :require (str "chef/shellout"))
-          PATTERN
-
-          def_node_matcher :shellout_new?, <<-PATTERN
-          (send
-            (const
-              (const nil? :Chef) :ShellOut) :new
-              ... )
-          PATTERN
-
-          def on_send(node)
-            include_shellout?(node) do
-              add_offense(node, severity: :warning) do |corrector|
-                corrector.remove(range_with_surrounding_space(range: node.loc.expression, side: :left))
-              end
-            end
-
-            require_shellout?(node) do
-              add_offense(node, severity: :warning) do |corrector|
-                corrector.remove(range_with_surrounding_space(range: node.loc.expression, side: :left))
-              end
-            end
-
-            shellout_new?(node) do
-              add_offense(node, severity: :warning) do |corrector|
-                corrector.replace(node, node.source.gsub('Chef::ShellOut', 'Mixlib::ShellOut'))
-              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
+        # Don't use the deprecated `Chef::ShellOut` class which was removed in Chef Infra Client 13. Use the `Mixlib::ShellOut` class instead, which behaves identically or convert to the simpler `shell_out` helper.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   include Chef::ShellOut
+        #   require 'chef/shellout'
+        #   Chef::ShellOut.new('some_command')
+        #
+        #   ### correct
+        #   include Mixlib::ShellOut
+        #   require 'mixlib/shellout'
+        #   Mixlib::ShellOut.new('some_command')
+        #
+        class ChefShellout < Base
+          include RangeHelp
+          extend AutoCorrector
+
+          MSG = "Don't use the deprecated `Chef::ShellOut` class which was removed in Chef Infra Client 13. Use the `Mixlib::ShellOut` class instead, which behaves identically."
+          RESTRICT_ON_SEND = [:new, :require, :include].freeze
+
+          def_node_matcher :include_shellout?, <<-PATTERN
+          (send nil? :include
+            (const
+              (const nil? :Chef) :ShellOut))
+          PATTERN
+
+          def_node_matcher :require_shellout?, <<-PATTERN
+          (send nil? :require (str "chef/shellout"))
+          PATTERN
+
+          def_node_matcher :shellout_new?, <<-PATTERN
+          (send
+            (const
+              (const nil? :Chef) :ShellOut) :new
+              ... )
+          PATTERN
+
+          def on_send(node)
+            include_shellout?(node) do
+              add_offense(node, severity: :warning) do |corrector|
+                corrector.remove(range_with_surrounding_space(range: node.loc.expression, side: :left))
+              end
+            end
+
+            require_shellout?(node) do
+              add_offense(node, severity: :warning) do |corrector|
+                corrector.remove(range_with_surrounding_space(range: node.loc.expression, side: :left))
+              end
+            end
+
+            shellout_new?(node) do
+              add_offense(node, severity: :warning) do |corrector|
+                corrector.replace(node, node.source.gsub('Chef::ShellOut', 'Mixlib::ShellOut'))
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,55 +1,55 @@
-# 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
-        # Do not use legacy chef-sugar helper methods, which will not be moved into Chef Infra Client itself. For a complete set of chef-sugar helpers now shipping in Chef Infra Client itself see https://github.com/chef/chef/tree/main/chef-utils#getting-started
-        #
-        # @example
-        #
-        #   ### incorrect
-        #   vagrant_key?
-        #   vagrant_domain?
-        #   vagrant_user?
-        #   require_chef_gem
-        #   best_ip_for(node)
-        #   nexus?
-        #   ios_xr?
-        #   ruby_20?
-        #   ruby_19?
-        #   includes_recipe?('foo::bar')
-        #   wrlinux?
-        #   dev_null
-        #   nexentacore_platform?
-        #   opensolaris_platform?
-        #   nexentacore?
-        #   opensolaris?
-        #
-        class ChefSugarHelpers < Base
-          MSG = 'Do not use legacy chef-sugar helper methods, which will not be moved into Chef Infra Client itself. For a complete set of chef-sugar helpers now shipping in Chef Infra Client itself see https://github.com/chef/chef/tree/main/chef-utils#getting-started'
-          RESTRICT_ON_SEND = [:vagrant_key?, :vagrant_domain?, :vagrant_user?, :require_chef_gem, :best_ip_for, :nexus?, :ios_xr?, :ruby_20?, :ruby_19?, :includes_recipe?, :wrlinux?, :dev_null, :nexentacore_platform?, :opensolaris_platform?, :nexentacore?, :opensolaris?].freeze
-
-          def on_send(node)
-            add_offense(node, severity: :refactor)
-          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
+        # Do not use legacy chef-sugar helper methods, which will not be moved into Chef Infra Client itself. For a complete set of chef-sugar helpers now shipping in Chef Infra Client itself see https://github.com/chef/chef/tree/main/chef-utils#getting-started
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   vagrant_key?
+        #   vagrant_domain?
+        #   vagrant_user?
+        #   require_chef_gem
+        #   best_ip_for(node)
+        #   nexus?
+        #   ios_xr?
+        #   ruby_20?
+        #   ruby_19?
+        #   includes_recipe?('foo::bar')
+        #   wrlinux?
+        #   dev_null
+        #   nexentacore_platform?
+        #   opensolaris_platform?
+        #   nexentacore?
+        #   opensolaris?
+        #
+        class ChefSugarHelpers < Base
+          MSG = 'Do not use legacy chef-sugar helper methods, which will not be moved into Chef Infra Client itself. For a complete set of chef-sugar helpers now shipping in Chef Infra Client itself see https://github.com/chef/chef/tree/main/chef-utils#getting-started'
+          RESTRICT_ON_SEND = [:vagrant_key?, :vagrant_domain?, :vagrant_user?, :require_chef_gem, :best_ip_for, :nexus?, :ios_xr?, :ruby_20?, :ruby_19?, :includes_recipe?, :wrlinux?, :dev_null, :nexentacore_platform?, :opensolaris_platform?, :nexentacore?, :opensolaris?].freeze
+
+          def on_send(node)
+            add_offense(node, severity: :refactor)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,55 +1,55 @@
-# 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
-        # Use `platform?('windows')` instead of the legacy `Chef::Platform.windows?` helper
-        #
-        # @example
-        #
-        #   ### incorrect
-        #   Chef::Platform.windows?
-        #
-        #   ### correct
-        #   platform?('windows')
-        #   platform_family?('windows')
-        #
-        class ChefWindowsPlatformHelper < Base
-          extend AutoCorrector
-          MSG = "Use `platform?('windows')` instead of the legacy `Chef::Platform.windows?` helper."
-          RESTRICT_ON_SEND = [:windows?].freeze
-
-          def_node_matcher :chef_platform_windows?, <<-PATTERN
-            (send
-              (const
-                (const nil? :Chef) :Platform) :windows?)
-          PATTERN
-
-          def on_send(node)
-            chef_platform_windows?(node) do
-              add_offense(node, severity: :warning) do |corrector|
-                corrector.replace(node, "platform?('windows')")
-              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
+        # Use `platform?('windows')` instead of the legacy `Chef::Platform.windows?` helper
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   Chef::Platform.windows?
+        #
+        #   ### correct
+        #   platform?('windows')
+        #   platform_family?('windows')
+        #
+        class ChefWindowsPlatformHelper < Base
+          extend AutoCorrector
+          MSG = "Use `platform?('windows')` instead of the legacy `Chef::Platform.windows?` helper."
+          RESTRICT_ON_SEND = [:windows?].freeze
+
+          def_node_matcher :chef_platform_windows?, <<-PATTERN
+            (send
+              (const
+                (const nil? :Chef) :Platform) :windows?)
+          PATTERN
+
+          def on_send(node)
+            chef_platform_windows?(node) do
+              add_offense(node, severity: :warning) do |corrector|
+                corrector.replace(node, "platform?('windows')")
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end