cookstyle 6.15.9 → 6.17.5

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

@@ -28,10 +28,12 @@ module RuboCop
         #   include_recipe 'chef_handler'
         #   include_recipe 'chef_handler::default'
         #
-        class ChefHandlerRecipe < Cop
+        class ChefHandlerRecipe < Base
           include RangeHelp
+          extend AutoCorrector
 
           MSG = 'There is no need to include the empty and deprecated chef_handler::default recipe in order to use the chef_handler resource'
+          RESTRICT_ON_SEND = [:include_recipe].freeze
 
           def_node_matcher :chef_handler_recipe?, <<-PATTERN
             (send nil? :include_recipe (str {"chef_handler" "chef_handler::default"}))
@@ -39,13 +41,9 @@ module RuboCop
 
           def on_send(node)
             chef_handler_recipe?(node) do
-              add_offense(node, location: :expression, message: MSG, severity: :refactor)
-            end
-          end
-
-          def autocorrect(node)
-            lambda do |corrector|
-              corrector.remove(range_with_surrounding_space(range: node.loc.expression, side: :left))
+              add_offense(node, message: MSG, severity: :refactor) do |corrector|
+                corrector.remove(range_with_surrounding_space(range: node.loc.expression, side: :left))
+              end
             end
           end
         end

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

@@ -34,22 +34,19 @@ module RuboCop
         #     type start: true, report: true, exception: true
         #   end
         #
-        class ChefHandlerUsesSupports < Cop
+        class ChefHandlerUsesSupports < Base
           include RuboCop::Chef::CookbookHelpers
+          extend AutoCorrector
 
           MSG = 'Use the type property instead of the deprecated supports property in the chef_handler resource. The supports property was removed in chef_handler cookbook version 3.0 (June 2017) and Chef Infra Client 14.0.'
 
           def on_block(node)
             match_property_in_resource?(:chef_handler, 'supports', node) do |prop_node|
-              add_offense(prop_node, location: :expression, message: MSG, severity: :warning)
-            end
-          end
-
-          def autocorrect(node)
-            lambda do |corrector|
-              # make sure to delete leading and trailing {}s that would create invalid ruby syntax
-              extracted_val = node.arguments.first.source.gsub(/{|}/, '')
-              corrector.replace(node.loc.expression, "type #{extracted_val}")
+              add_offense(prop_node, message: MSG, severity: :warning) do |corrector|
+                # make sure to delete leading and trailing {}s that would create invalid ruby syntax
+                extracted_val = prop_node.arguments.first.source.gsub(/{|}/, '')
+                corrector.replace(prop_node.loc.expression, "type #{extracted_val}")
+              end
             end
           end
         end

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

@@ -28,8 +28,9 @@ module RuboCop
         #   require 'chef/rest'
         #   Chef::REST::RESTRequest.new(:GET, FOO, nil).call
         #
-        class UsesChefRESTHelpers < Cop
+        class UsesChefRESTHelpers < Base
           MSG = "Don't use the helpers in Chef::REST which were removed in Chef Infra Client 13"
+          RESTRICT_ON_SEND = [:require].freeze
 
           def_node_matcher :require_rest?, <<-PATTERN
           (send nil? :require ( str "chef/rest"))
@@ -41,13 +42,13 @@ module RuboCop
 
           def on_send(node)
             require_rest?(node) do
-              add_offense(node, location: :expression, message: MSG, severity: :warning)
+              add_offense(node, message: MSG, severity: :warning)
             end
           end
 
           def on_const(node)
             rest_const?(node) do
-              add_offense(node, location: :expression, message: MSG, severity: :warning)
+              add_offense(node, message: MSG, severity: :warning)
             end
           end
         end

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

@@ -35,10 +35,11 @@ module RuboCop
         #
         #   unwind "user[postgres]"
         #
-        class ChefRewind < Cop
+        class ChefRewind < Base
           include RuboCop::Chef::CookbookHelpers
           include RangeHelp
           extend TargetChefVersion
+          extend AutoCorrector
 
           minimum_target_chef_version '12.10'
 
@@ -48,6 +49,7 @@ module RuboCop
           }.freeze
 
           MSG = 'Use delete_resource / edit_resource 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"))
@@ -63,44 +65,30 @@ module RuboCop
 
           def on_send(node)
             rewind_gem_install?(node) do
-              add_offense(node, location: :expression, message: MSG, severity: :warning)
+              add_offense(node, message: MSG, 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, location: :expression, message: MSG, severity: :warning)
+              add_offense(node, message: MSG, severity: :warning) do |corrector|
+                corrector.remove(range_with_surrounding_space(range: node.loc.expression, side: :left))
+              end
             end
 
-            rewind_resources?(node) do
-              add_offense(node, location: :expression, message: MSG, severity: :warning)
+            rewind_resources?(node) do |string|
+              add_offense(node, message: MSG, severity: :warning) do |corrector|
+                corrector.replace(node.loc.expression, 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|
-              add_offense(node, location: :expression, message: MSG, severity: :warning) if pkg_name.arguments&.first&.str_content == 'chef-rewind'
-            end
-          end
-
-          def autocorrect(node)
-            lambda do |corrector|
-              rewind_gem_install?(node) do
-                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))
-                return
-              end
-
-              require_rewind?(node) do
-                corrector.remove(range_with_surrounding_space(range: node.loc.expression, side: :left))
-                return
-              end
-
-              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, message: MSG, severity: :warning) do |corrector|
                 corrector.remove(node.loc.expression) if pkg_name.arguments&.first&.str_content == 'chef-rewind'
-                return
-              end
-
-              rewind_resources?(node) do |string|
-                corrector.replace(node.loc.expression, node.source.gsub(string.to_s, MAPPING[string]))
               end
             end
           end

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

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+#
+# Copyright:: 2020, Chef Software Inc.
+# Author:: Tim Smith (<tsmith@chef.io>)
+#
+# 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 ChefDeprecations
+        # Don't use deprecated Chef::ShellOut which was removed in Chef Infra Client 13.
+        # Use Mixlib::ShellOut instead, which behaves identically or convert to the shell_out
+        # helper provided in chef-utils.
+        #
+        # @example
+        #
+        #   # bad
+        #   include Chef::ShellOut
+        #   require 'chef/shellout'
+        #   Chef::ShellOut.new('some_command')
+        #
+        #   # good
+        #   include Mixlib::ShellOut
+        #   require 'mixlib/shellout'
+        #   Mixlib::ShellOut.new('some_command')
+        #
+        class ChefShellout < Base
+          include RangeHelp
+          extend AutoCorrector
+
+          MSG = "Don't use deprecated Chef::ShellOut which was removed in Chef Infra Client 13. Use Mixlib::ShellOut 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, message: MSG, 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, message: MSG, 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, message: MSG, severity: :warning) do |corrector|
+                corrector.replace(node.loc.expression, node.source.gsub('Chef::ShellOut', 'Mixlib::ShellOut'))
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -30,7 +30,8 @@ module RuboCop
         #   platform?('windows')
         #   platform_family?('windows')
         #
-        class ChefWindowsPlatformHelper < Cop
+        class ChefWindowsPlatformHelper < Base
+          extend AutoCorrector
           MSG = "Use `platform?('windows')` instead of the legacy `Chef::Platform.windows?` helper."
 
           def_node_matcher :chef_platform_windows?, <<-PATTERN
@@ -41,13 +42,9 @@ module RuboCop
 
           def on_send(node)
             chef_platform_windows?(node) do
-              add_offense(node, location: :expression, message: MSG, severity: :warning)
-            end
-          end
-
-          def autocorrect(node)
-            lambda do |corrector|
-              corrector.replace(node.loc.expression, "platform?('windows')")
+              add_offense(node, message: MSG, severity: :warning) do |corrector|
+                corrector.replace(node.loc.expression, "platform?('windows')")
+              end
             end
           end
         end

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

@@ -38,18 +38,15 @@ module RuboCop
         #     ...
         #   end
         #
-        class ChefDKGenerators < Cop
+        class ChefDKGenerators < Base
+          extend AutoCorrector
           MSG = 'When writing cookbook generators use the ChefCLI module instead of the ChefDK module which was removed in Chef Workstation 0.8 and later.'
 
           def on_const(node)
             # We want to catch calls like ChefCLI::CLI.whatever or places where classes are defined in the ChefDK module
             return unless node.const_name == 'ChefDK' && (node.parent&.module_type? || node.parent&.const_type?)
 
-            add_offense(node, location: :expression, message: MSG, severity: :warning)
-          end
-
-          def autocorrect(node)
-            lambda do |corrector|
+            add_offense(node, message: MSG, severity: :warning) do |corrector|
               corrector.replace(node.loc.expression, node.source.gsub('ChefDK', 'ChefCLI'))
             end
           end

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

@@ -22,18 +22,16 @@ module RuboCop
       # The Librarian-Chef depsolving project is no longer maintained and a Cheffile should not be used for cookbook depsolving. Consider using Policyfiles instead. If the Policyfiles model is not compatible with your workflow you may find Berkshelf offers a more similar, and still supported, experience to Librarian-Chef.
       #
       module ChefDeprecations
-        class Cheffile < Cop
+        class Cheffile < Base
           include RangeHelp
 
           MSG = 'The Librarian-Chef depsolving project is no longer maintained and a Cheffile should not be used for cookbook depsolving. Consider using Policyfiles instead.'
 
-          def investigate(processed_source)
-            return if processed_source.blank?
-
+          def on_new_investigation
             # Using range similar to RuboCop::Cop::Naming::Filename (file_name.rb)
             range = source_range(processed_source.buffer, 1, 0)
 
-            add_offense(nil, location: range, message: MSG, severity: :warning)
+            add_offense(range, message: MSG, severity: :warning)
           end
         end
       end

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

@@ -28,7 +28,8 @@ module RuboCop
         #
         #   at_exit { ChefSpec::Coverage.report! }
         #
-        class ChefSpecCoverageReport < Cop
+        class ChefSpecCoverageReport < Base
+          extend AutoCorrector
           MSG = "Don't use the deprecated ChefSpec coverage report functionality in your specs."
 
           def_node_matcher :coverage_reporter?, <<-PATTERN
@@ -37,13 +38,9 @@ module RuboCop
 
           def on_block(node)
             coverage_reporter?(node) do
-              add_offense(node, location: :expression, message: MSG, severity: :warning)
-            end
-          end
-
-          def autocorrect(node)
-            lambda do |corrector|
-              corrector.remove(node.loc.expression)
+              add_offense(node, message: MSG, severity: :warning) do |corrector|
+                corrector.remove(node.loc.expression)
+              end
             end
           end
         end

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

@@ -40,7 +40,8 @@ module RuboCop
         #     # some spec code
         #   end
         #
-        class ChefSpecLegacyRunner < Cop
+        class ChefSpecLegacyRunner < Base
+          extend AutoCorrector
           MSG = 'Use ChefSpec::SoloRunner or ChefSpec::ServerRunner instead of the deprecated ChefSpec::Runner.'
 
           def_node_matcher :chefspec_runner?, <<-PATTERN
@@ -49,13 +50,9 @@ module RuboCop
 
           def on_const(node)
             chefspec_runner?(node) do
-              add_offense(node, location: :expression, message: MSG, severity: :warning)
-            end
-          end
-
-          def autocorrect(node)
-            lambda do |corrector|
-              corrector.replace(node.loc.expression, 'ChefSpec::ServerRunner')
+              add_offense(node, message: MSG, severity: :warning) do |corrector|
+                corrector.replace(node.loc.expression, 'ChefSpec::ServerRunner')
+              end
             end
           end
         end

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

@@ -34,24 +34,22 @@ module RuboCop
         #     action :remove
         #   end
         #
-        class ChocolateyPackageUninstallAction < Cop
+        class ChocolateyPackageUninstallAction < Base
           include RuboCop::Chef::CookbookHelpers
+          extend AutoCorrector
 
           MSG = 'Use the :remove action in the chocolatey_package resource instead of :uninstall which was removed in Chef Infra Client 14+'
 
           def on_block(node)
             match_property_in_resource?(:chocolatey_package, 'action', node) do |choco_action|
               choco_action.arguments.each do |action|
-                add_offense(action, location: :expression, message: MSG, severity: :warning) if action.source == ':uninstall'
+                next unless action.source == ':uninstall'
+                add_offense(action, message: MSG, severity: :warning) do |corrector|
+                  corrector.replace(action, ':remove')
+                end
               end
             end
           end
-
-          def autocorrect(node)
-            lambda do |corrector|
-              corrector.replace(node.loc.expression, ':remove')
-            end
-          end
         end
       end
     end

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

@@ -26,13 +26,15 @@ module RuboCop
         #   # bad
         #   depends 'compat_resource'
         #
-        class CookbookDependsOnCompatResource < Cop
+        class CookbookDependsOnCompatResource < Base
           include RangeHelp
           extend TargetChefVersion
+          extend AutoCorrector
 
           minimum_target_chef_version '12.19'
 
           MSG = "Don't depend on the deprecated compat_resource cookbook made obsolete by Chef 12.19+"
+          RESTRICT_ON_SEND = [:depends].freeze
 
           def_node_matcher :depends_compat_resource?, <<-PATTERN
             (send nil? :depends (str {"compat_resource"}))
@@ -40,13 +42,9 @@ module RuboCop
 
           def on_send(node)
             depends_compat_resource?(node) do
-              add_offense(node, location: :expression, message: MSG, severity: :warning)
-            end
-          end
-
-          def autocorrect(node)
-            lambda do |corrector|
-              corrector.remove(range_with_surrounding_space(range: node.loc.expression, side: :left))
+              add_offense(node, message: MSG, severity: :warning) do |corrector|
+                corrector.remove(range_with_surrounding_space(range: node.loc.expression, side: :left))
+              end
             end
           end
         end

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

@@ -26,12 +26,13 @@ module RuboCop
         #   # bad
         #   depends 'partial_search'
         #
-        class CookbookDependsOnPartialSearch < Cop
+        class CookbookDependsOnPartialSearch < Base
           extend TargetChefVersion
 
           minimum_target_chef_version '13.0'
 
           MSG = "Don't depend on the deprecated partial_search cookbook made obsolete by Chef 13"
+          RESTRICT_ON_SEND = [:depends].freeze
 
           def_node_matcher :depends_partial_search?, <<-PATTERN
             (send nil? :depends (str "partial_search"))
@@ -39,7 +40,7 @@ module RuboCop
 
           def on_send(node)
             depends_partial_search?(node) do
-              add_offense(node, location: :expression, message: MSG, severity: :warning)
+              add_offense(node, message: MSG, severity: :warning)
             end
           end
         end