cookstyle 6.15.5 → 6.16.10

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_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

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

@@ -27,8 +27,9 @@ module RuboCop
         #   depends 'poise'
         #   depends 'poise-service'
         #
-        class CookbookDependsOnPoise < Cop
+        class CookbookDependsOnPoise < Base
           MSG = 'Cookbooks should not depend on the deprecated Poise framework'
+          RESTRICT_ON_SEND = [:depends].freeze
 
           def_node_matcher :depends_method?, <<-PATTERN
             (send nil? :depends $str)
@@ -36,7 +37,7 @@ module RuboCop
 
           def on_send(node)
             depends_method?(node) do |arg|
-              add_offense(node, location: :expression, message: MSG, severity: :warning) if %w(poise poise-service).include?(arg.value)
+              add_offense(node, message: MSG, severity: :warning) if %w(poise poise-service).include?(arg.value)
             end
           end
         end

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

@@ -26,8 +26,9 @@ module RuboCop
         #
         #   let(:chef_run) { ChefSpec::ServerRunner.new(platform: 'ubuntu', version: '14.04') }
         #
-        class DeprecatedChefSpecPlatform < Cop
+        class DeprecatedChefSpecPlatform < Base
           include RuboCop::Chef::CookbookHelpers
+          extend AutoCorrector
 
           MSG = "Use currently supported platforms in ChefSpec listed at https://github.com/chefspec/fauxhai/blob/master/PLATFORMS.md. Fauxhai / ChefSpec will perform fuzzy matching on platform version so it's always best to be less specific ie. 10 instead of 10.3"
 
@@ -65,25 +66,26 @@ module RuboCop
             'opensuse' => {
               '< 14' => true,
               '~> 42.0' => true,
+              '= 15.0' => '15',
             },
             'debian' => {
               '< 8' => true,
-              '> 8.0, < 8.10' => '8',
-              '> 9.0, < 9.9' => '9',
+              '> 8.0, < 8.11' => '8',
+              '> 9.0, < 9.11' => '9',
             },
             'centos' => {
               '< 6.0' => true,
-              '~> 6.0, < 6.8' => '6',
+              '~> 6.0, < 6.10' => '6',
               '~> 7.0, < 7.6 ' => '7',
             },
             'redhat' => {
               '< 6.0' => true,
-              '~> 6.0, < 6.8' => '6',
+              '~> 6.0, < 6.10' => '6',
               '~> 7.0, < 7.6' => '7',
             },
             'oracle' => {
               '< 6.0' => true,
-              '~> 6.0, < 6.8' => '6',
+              '~> 6.0, < 6.10' => '6',
               '~> 7.0, < 7.6 ' => '7',
             },
           }.freeze
@@ -115,14 +117,9 @@ module RuboCop
 
           def on_send(node)
             chefspec_definition?(node) do |plat, ver|
-              add_offense(node, location: :expression, message: MSG, severity: :warning) if legacy_chefspec_platform(plat.value, ver.value)
-            end
-          end
-
-          def autocorrect(node)
-            chefspec_definition?(node) do |plat, ver|
-              if replacement = replacement_string(plat.value, ver.value) # rubocop: disable Lint/AssignmentInCondition
-                lambda do |corrector|
+              next unless legacy_chefspec_platform(plat.value, ver.value)
+              add_offense(node, message: MSG, severity: :warning) do |corrector|
+                if replacement = replacement_string(plat.value, ver.value) # rubocop: disable Lint/AssignmentInCondition
                   corrector.replace(ver.loc.expression, "'#{replacement}'")
                 end
               end

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

@@ -34,10 +34,12 @@ module RuboCop
         #   require 'chef/mixin/language_include_attribute'
         #   require 'chef/mixin/language_include_recipe'
         #
-        class UsesDeprecatedMixins < Cop
+        class UsesDeprecatedMixins < Base
           include RangeHelp
+          extend AutoCorrector
 
           MSG = "Don't use deprecated Mixins no longer included in Chef Infra Client 14 and later."
+          RESTRICT_ON_SEND = [:include, :require].freeze
 
           def_node_matcher :deprecated_mixin?, <<-PATTERN
             (send nil? :include (const (const (const nil? :Chef) :Mixin) { :Language :LanguageIncludeAttribute :RecipeDefinitionDSLCore :LanguageIncludeRecipe }))
@@ -53,21 +55,21 @@ module RuboCop
 
           def on_send(node)
             deprecated_mixin?(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
 
             deprecated_dsl?(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
 
             dsl_mixin_require?(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