cookstyle 6.15.9 → 6.16.4

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,7 +26,7 @@ module RuboCop
         #   # bad
         #   depends 'compat_resource'
         #
-        class CookbookDependsOnCompatResource < Cop
+        class CookbookDependsOnCompatResource < Base
           include RangeHelp
           extend TargetChefVersion
 
@@ -38,15 +38,12 @@ module RuboCop
             (send nil? :depends (str {"compat_resource"}))
           PATTERN
 
+          extend AutoCorrector
           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,7 +26,7 @@ module RuboCop
         #   # bad
         #   depends 'partial_search'
         #
-        class CookbookDependsOnPartialSearch < Cop
+        class CookbookDependsOnPartialSearch < Base
           extend TargetChefVersion
 
           minimum_target_chef_version '13.0'
@@ -39,7 +39,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,7 +27,7 @@ module RuboCop
         #   depends 'poise'
         #   depends 'poise-service'
         #
-        class CookbookDependsOnPoise < Cop
+        class CookbookDependsOnPoise < Base
           MSG = 'Cookbooks should not depend on the deprecated Poise framework'
 
           def_node_matcher :depends_method?, <<-PATTERN
@@ -36,7 +36,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"
 
@@ -116,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,8 +34,9 @@ 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."
 
@@ -53,21 +54,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

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

@@ -38,7 +38,7 @@ module RuboCop
         #   resource = Chef::Resource::File.new("/tmp/foo.xyz", run_context)
         #   provider = resource.provider_for_action(:create)
         #
-        class DeprecatedPlatformMethods < Cop
+        class DeprecatedPlatformMethods < Base
           MSG = 'Use provider_for_action instead of the deprecated Chef::Platform methods in resources, which were removed in Chef Infra Client 13.'
 
           def_node_matcher :platform_method?, <<-PATTERN
@@ -47,7 +47,7 @@ module RuboCop
 
           def on_send(node)
             platform_method?(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/deprecated_shellout_methods.rb

@@ -39,7 +39,7 @@ module RuboCop
         #   shell_out!('foo')
         #   shell_out!('foo', default_env: false) # replaces shell_out_with_systems_locale
         #
-        class DeprecatedShelloutMethods < Cop
+        class DeprecatedShelloutMethods < Base
           extend TargetChefVersion
 
           minimum_target_chef_version '14.3'
@@ -57,7 +57,7 @@ module RuboCop
           MSG = 'Many legacy specialized shell_out methods were replaced in Chef Infra Client 14.3 and removed in Chef Infra Client 15. Use shell_out and any additional options if necessary.'
 
           def on_send(node)
-            add_offense(node, location: :expression, message: MSG, severity: :warning) if DEPRECATED_SHELLOUT_METHODS.include?(node.method_name)
+            add_offense(node, message: MSG, severity: :warning) if DEPRECATED_SHELLOUT_METHODS.include?(node.method_name)
           end
         end
       end

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

@@ -28,11 +28,11 @@ module RuboCop
         #     # do some legacy things
         #   end
         #
-        class DeprecatedWindowsVersionCheck < Cop
+        class DeprecatedWindowsVersionCheck < Base
           MSG = "Don't use the deprecated older_than_win_2012_or_8? helper. Windows versions before 2012 and 8 are now end of life and this helper will always return false."
 
           def on_send(node)
-            add_offense(node, location: :expression, message: MSG, severity: :warning) if node.method_name == :older_than_win_2012_or_8?
+            add_offense(node, message: MSG, severity: :warning) if node.method_name == :older_than_win_2012_or_8?
           end
         end
       end

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

@@ -41,9 +41,10 @@ module RuboCop
         #     action :create
         #   end
         #
-        class DeprecatedYumRepositoryProperties < Cop
+        class DeprecatedYumRepositoryProperties < Base
           include RuboCop::Chef::CookbookHelpers
           extend TargetChefVersion
+          extend AutoCorrector
 
           minimum_target_chef_version '12.14'
 
@@ -52,16 +53,15 @@ module RuboCop
           def on_block(node)
             %w(url keyurl mirrorexpire).each do |prop|
               match_property_in_resource?(:yum_repository, prop, node) do |prop_node|
-                add_offense(prop_node, location: :expression, message: MSG, severity: :warning)
+                add_offense(prop_node, message: MSG, severity: :warning)  do |corrector|
+                  corrector.replace(prop_node.loc.expression, prop_node.loc.expression.source
+                    .gsub(/^url/, 'baseurl')
+                    .gsub(/^keyurl/, 'gpgkey')
+                    .gsub(/^mirrorexpire/, 'mirror_expire'))
+                end
               end
             end
           end
-
-          def autocorrect(node)
-            lambda do |corrector|
-              corrector.replace(node.loc.expression, node.loc.expression.source.gsub(/^url/, 'baseurl').gsub(/^keyurl/, 'gpgkey').gsub(/^mirrorexpire/, 'mirror_expire'))
-            end
-          end
         end
       end
     end

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

@@ -29,11 +29,11 @@ module RuboCop
         #     bar
         #   end
         #
-        class EasyInstallResource < Cop
+        class EasyInstallResource < Base
           MSG = "Don't use the deprecated easy_install resource removed in Chef Infra Client 13"
 
           def on_send(node)
-            add_offense(node, location: :expression, message: MSG, severity: :warning) if node.method_name == :easy_install
+            add_offense(node, message: MSG, severity: :warning) if node.method_name == :easy_install
           end
         end
       end

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

@@ -32,14 +32,14 @@ module RuboCop
         #     end
         #   end
 
-        class EOLAuditModeUsage < Cop
+        class EOLAuditModeUsage < Base
           MSG = 'The beta Audit Mode feature in Chef Infra Client was removed in Chef Infra Client 15.0. Users should instead use InSpec and the audit cookbook. See https://www.inspec.io/ for more information.'
 
           def_node_matcher :control_group?, '(send nil? :control_group ...)'
 
           def on_send(node)
             control_group?(node) do
-              add_offense(node, location: :selector, message: MSG, severity: :warning)
+              add_offense(node.loc.selector, message: MSG, severity: :warning)
             end
           end
         end

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

@@ -34,15 +34,14 @@ module RuboCop
         #     ignore_failure true
         #   end
         #
-        class EpicFail < Cop
+        class EpicFail < Base
+          extend AutoCorrector
+
           MSG = 'Use ignore_failure method instead of the deprecated epic_fail method'
 
           def on_send(node)
-            add_offense(node, location: :expression, message: MSG, severity: :warning) if node.method_name == :epic_fail
-          end
-
-          def autocorrect(node)
-            lambda do |corrector|
+            return unless node.method_name == :epic_fail
+            add_offense(node, message: MSG, severity: :warning) do |corrector|
               corrector.replace(node.loc.expression, 'ignore_failure true')
             end
           end

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

@@ -29,11 +29,11 @@ module RuboCop
         #     bar
         #   end
         #
-        class ErlCallResource < Cop
+        class ErlCallResource < Base
           MSG = "Don't use the deprecated erl_call resource removed in Chef Infra Client 13"
 
           def on_send(node)
-            add_offense(node, location: :expression, message: MSG, severity: :warning) if node.method_name == :erl_call
+            add_offense(node, message: MSG, severity: :warning) if node.method_name == :erl_call
           end
         end
       end

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

@@ -82,7 +82,9 @@ module RuboCop
         #  # better
         #  Convert your legacy HWRPs to custom resources
         #
-        class HWRPWithoutProvides < Cop
+        class HWRPWithoutProvides < Base
+          extend AutoCorrector
+
           MSG = 'In Chef Infra Client 16 and later a legacy HWRP resource must use `provides` to define how the resource is called in recipes or other resources. To maintain compatibility with Chef Infra Client < 16 use both `resource_name` and `provides`.'
 
           def_node_matcher :HWRP?, <<-PATTERN
@@ -102,8 +104,15 @@ module RuboCop
           def_node_search :resource_name, '(send nil? :resource_name (sym $_))'
 
           def on_class(node)
+            return if has_provides?
             HWRP?(node) do |inherit|
-              add_offense(inherit, location: :expression, message: MSG, severity: :warning) unless has_provides?
+              add_offense(inherit, message: MSG, severity: :warning) do |corrector|
+                resource_name_ast(node) do |ast_match|
+                  # build a new string to add after that includes the new line and the proper indentation
+                  new_string = "\n" + ast_match.source.dup.gsub('resource_name', 'provides').prepend(' ' * indentation(ast_match))
+                  corrector.insert_after(ast_match.source_range, new_string)
+                end
+              end
             end
           end
 
@@ -125,16 +134,6 @@ module RuboCop
           def indentation(node)
             node.source_range.source_line =~ /\S/
           end
-
-          def autocorrect(node)
-            lambda do |corrector|
-              resource_name_ast(node) do |ast_match|
-                # build a new string to add after that includes the new line and the proper indentation
-                new_string = "\n" + ast_match.source.dup.gsub('resource_name', 'provides').prepend(' ' * indentation(ast_match))
-                corrector.insert_after(ast_match.source_range, new_string)
-              end
-            end
-          end
         end
       end
     end