rubocop 0.87.1 → 0.91.0

data/lib/rubocop/rspec/expect_offense.rb

@@ -73,19 +73,20 @@ module RuboCop
     #   expect_no_corrections
     #
     # If your code has variables of different lengths, you can use `%{foo}`,
-    # `^{foo}`, and `_{foo}` to format your template:
+    # `^{foo}`, and `_{foo}` to format your template; you can also abbreviate
+    # offense messages with `[...]`:
     #
     #   %w[raise fail].each do |keyword|
     #     expect_offense(<<~RUBY, keyword: keyword)
     #       %{keyword}(RuntimeError, msg)
-    #       ^{keyword}^^^^^^^^^^^^^^^^^^^ Redundant `RuntimeError` argument can be removed.
+    #       ^{keyword}^^^^^^^^^^^^^^^^^^^ Redundant `RuntimeError` argument [...]
     #     RUBY
     #
     #   %w[has_one has_many].each do |type|
     #     expect_offense(<<~RUBY, type: type)
     #       class Book
     #         %{type} :chapter, foreign_key: 'book_id'
-    #         _{type}           ^^^^^^^^^^^^^^^^^^^^^^ Specifying the default value is redundant.
+    #         _{type}           ^^^^^^^^^^^^^^^^^^^^^^ Specifying the default [...]
     #       end
     #     RUBY
     #   end
@@ -102,6 +103,7 @@ module RuboCop
     module ExpectOffense
       def format_offense(source, **replacements)
         replacements.each do |keyword, value|
+          value = value.to_s
           source = source.gsub("%{#{keyword}}", value)
                          .gsub("^{#{keyword}}", '^' * value.size)
                          .gsub("_{#{keyword}}", ' ' * value.size)
@@ -126,14 +128,19 @@ module RuboCop
         @processed_source = parse_source(expected_annotations.plain_source,
                                          file)
 
-        raise 'Error parsing example code' unless @processed_source.valid_syntax?
+        unless @processed_source.valid_syntax?
+          raise 'Error parsing example code: ' \
+            "#{@processed_source.diagnostics.map(&:render).join("\n")}"
+        end
 
         offenses = _investigate(cop, @processed_source)
         actual_annotations =
           expected_annotations.with_offense_annotations(offenses)
 
-        expect(actual_annotations.to_s).to eq(expected_annotations.to_s)
+        expect(actual_annotations).to eq(expected_annotations), ''
         expect(offenses.map(&:severity).uniq).to eq([severity]) if severity
+
+        offenses
       end
 
       def expect_correction(correction, loop: true)
@@ -188,6 +195,7 @@ module RuboCop
       # Parsed representation of code annotated with the `^^^ Message` style
       class AnnotatedSource
         ANNOTATION_PATTERN = /\A\s*(\^+|\^{}) /.freeze
+        ABBREV = "[...]\n"
 
         # @param annotated_source [String] string passed to the matchers
         #
@@ -206,6 +214,7 @@ module RuboCop
               source << source_line
             end
           end
+          annotations.each { |a| a[0] = 1 } if source.empty?
 
           new(source, annotations)
         end
@@ -221,6 +230,27 @@ module RuboCop
           @annotations = annotations.sort.freeze
         end
 
+        def ==(other)
+          other.is_a?(self.class) &&
+            other.lines == lines &&
+            match_annotations?(other)
+        end
+
+        # Dirty hack: expectations with [...] are rewritten when they match
+        # This way the diff is clean.
+        def match_annotations?(other)
+          annotations.zip(other.annotations) do |(_actual_line, actual_annotation),
+                                                 (_expected_line, expected_annotation)|
+            if expected_annotation&.end_with?(ABBREV) &&
+               actual_annotation.start_with?(expected_annotation[0...-ABBREV.length])
+
+              expected_annotation.replace(actual_annotation)
+            end
+          end
+
+          annotations == other.annotations
+        end
+
         # Construct annotated source string (like what we parse)
         #
         # Reconstruct a deterministic annotated source string. This is
@@ -253,6 +283,7 @@ module RuboCop
 
           reconstructed.join
         end
+        alias inspect to_s
 
         # Return the plain source code without annotations
         #
@@ -279,7 +310,7 @@ module RuboCop
           self.class.new(lines, offense_annotations)
         end
 
-        private
+        protected
 
         attr_reader :lines, :annotations
       end

data/lib/rubocop/rspec/shared_contexts.rb

@@ -12,19 +12,22 @@ RSpec.shared_context 'isolated environment', :isolated_environment do
       # get mismatched pathnames when loading config files later on.
       tmpdir = File.realpath(tmpdir)
 
+      virtual_home = File.expand_path(File.join(tmpdir, 'home'))
+      Dir.mkdir(virtual_home)
+      ENV['HOME'] = virtual_home
+      ENV.delete('XDG_CONFIG_HOME')
+
+      base_dir = example.metadata[:project_inside_home] ? virtual_home : tmpdir
+      root = example.metadata[:root]
+      working_dir = root ? File.join(base_dir, 'work', root) : File.join(base_dir, 'work')
+
       # Make upwards search for .rubocop.yml files stop at this directory.
-      RuboCop::FileFinder.root_level = tmpdir
+      RuboCop::FileFinder.root_level = working_dir
 
       begin
-        virtual_home = File.expand_path(File.join(tmpdir, 'home'))
-        Dir.mkdir(virtual_home)
-        ENV['HOME'] = virtual_home
-        ENV.delete('XDG_CONFIG_HOME')
-
-        working_dir = File.join(tmpdir, 'work')
-        Dir.mkdir(working_dir)
+        FileUtils.mkdir_p(working_dir)
 
-        RuboCop::PathUtil.chdir(working_dir) do
+        Dir.chdir(working_dir) do
           example.run
         end
       ensure
@@ -37,12 +40,22 @@ RSpec.shared_context 'isolated environment', :isolated_environment do
   end
 end
 
+RSpec.shared_context 'maintain registry', :restore_registry do
+  around(:each) do |example|
+    RuboCop::Cop::Registry.with_temporary_global { example.run }
+  end
+
+  def stub_cop_class(name, inherit: RuboCop::Cop::Base, &block)
+    klass = Class.new(inherit, &block)
+    stub_const(name, klass)
+    klass
+  end
+end
+
 # This context assumes nothing and defines `cop`, among others.
 RSpec.shared_context 'config', :config do # rubocop:disable Metrics/BlockLength
   ### Meant to be overridden at will
 
-  let(:source) { 'code = {some: :ruby}' }
-
   let(:cop_class) do
     unless described_class.is_a?(Class) && described_class < RuboCop::Cop::Base
       raise 'Specify which cop class to use (e.g `let(:cop_class) { RuboCop::Cop::Base }`, ' \
@@ -94,9 +107,7 @@ RSpec.shared_context 'config', :config do # rubocop:disable Metrics/BlockLength
   end
 
   let(:cop) do
-    cop_class.new(config, cop_options).tap do |cop|
-      cop.send :begin_investigation, processed_source
-    end
+    cop_class.new(config, cop_options)
   end
 end
 

data/lib/rubocop/runner.rb

@@ -11,12 +11,16 @@ module RuboCop
     class InfiniteCorrectionLoop < RuntimeError
       attr_reader :offenses
 
-      def initialize(path, offenses)
-        super "Infinite loop detected in #{path}."
-        @offenses = offenses
+      def initialize(path, offenses_by_iteration, loop_start: -1)
+        @offenses = offenses_by_iteration.flatten.uniq
+        root_cause = offenses_by_iteration[loop_start..-1]
+                     .map { |x| x.map(&:cop_name).uniq.join(', ') }
+                     .join(' -> ')
+        super "Infinite loop detected in #{path} and caused by #{root_cause}"
       end
     end
 
+    # @api private
     MAX_ITERATIONS = 200
 
     attr_reader :errors, :warnings
@@ -80,7 +84,10 @@ module RuboCop
       # OPTIMIZE: Calling `ResultCache.cleanup` takes time. This optimization
       # mainly targets editors that integrates RuboCop. When RuboCop is run
       # by an editor, it should be inspecting only one file.
-      ResultCache.cleanup(@config_store, @options[:debug]) if files.size > 1 && cached_run?
+      if files.size > 1 && cached_run?
+        ResultCache.cleanup(@config_store, @options[:debug], @options[:cache_root])
+      end
+
       formatter_set.finished(inspected_files.freeze)
       formatter_set.close_output_files
     end
@@ -118,8 +125,7 @@ module RuboCop
 
     def file_offenses(file)
       file_offense_cache(file) do
-        source = get_processed_source(file)
-        source, offenses = do_inspection_loop(file, source)
+        source, offenses = do_inspection_loop(file)
         offenses = add_redundant_disables(file, offenses.compact.sort, source)
         offenses.sort.reject(&:disabled?).freeze
       end
@@ -159,8 +165,7 @@ module RuboCop
           # Do one extra inspection loop if any redundant disables were
           # removed. This is done in order to find rubocop:enable directives that
           # have now become useless.
-          _source, new_offenses = do_inspection_loop(file,
-                                                     get_processed_source(file))
+          _source, new_offenses = do_inspection_loop(file)
           offenses |= new_offenses
         end
       end
@@ -213,7 +218,7 @@ module RuboCop
       @cached_run ||=
         (@options[:cache] == 'true' ||
          @options[:cache] != 'false' &&
-         @config_store.for_dir(Dir.pwd).for_all_cops['UseCache']) &&
+         @config_store.for_pwd.for_all_cops['UseCache']) &&
         # When running --auto-gen-config, there's some processing done in the
         # cops related to calculating the Max parameters for Metrics cops. We
         # need to do that processing and cannot use caching.
@@ -232,19 +237,23 @@ module RuboCop
       cache.save(offenses)
     end
 
-    def do_inspection_loop(file, processed_source)
-      offenses = []
+    def do_inspection_loop(file)
+      processed_source = get_processed_source(file)
+      # This variable is 2d array used to track corrected offenses after each
+      # inspection iteration. This is used to output meaningful infinite loop
+      # error message.
+      offenses_by_iteration = []
 
       # When running with --auto-correct, we need to inspect the file (which
       # includes writing a corrected version of it) until no more corrections
       # are made. This is because automatic corrections can introduce new
       # offenses. In the normal case the loop is only executed once.
-      iterate_until_no_changes(processed_source, offenses) do
+      iterate_until_no_changes(processed_source, offenses_by_iteration) do
         # The offenses that couldn't be corrected will be found again so we
         # only keep the corrected ones in order to avoid duplicate reporting.
-        offenses.select!(&:corrected?)
+        !offenses_by_iteration.empty? && offenses_by_iteration.last.select!(&:corrected?)
         new_offenses, updated_source_file = inspect_file(processed_source)
-        offenses.concat(new_offenses).uniq!
+        offenses_by_iteration.push(new_offenses)
 
         # We have to reprocess the source to pickup the changes. Since the
         # change could (theoretically) introduce parsing errors, we break the
@@ -254,10 +263,12 @@ module RuboCop
         processed_source = get_processed_source(file)
       end
 
+      # Return summary of corrected offenses after all iterations
+      offenses = offenses_by_iteration.flatten.uniq
       [processed_source, offenses]
     end
 
-    def iterate_until_no_changes(source, offenses)
+    def iterate_until_no_changes(source, offenses_by_iteration)
       # Keep track of the state of the source. If a cop modifies the source
       # and another cop undoes it producing identical source we have an
       # infinite loop.
@@ -269,10 +280,10 @@ module RuboCop
       iterations = 0
 
       loop do
-        check_for_infinite_loop(source, offenses)
+        check_for_infinite_loop(source, offenses_by_iteration)
 
         if (iterations += 1) > MAX_ITERATIONS
-          raise InfiniteCorrectionLoop.new(source.path, offenses)
+          raise InfiniteCorrectionLoop.new(source.path, offenses_by_iteration)
         end
 
         source = yield
@@ -282,11 +293,15 @@ module RuboCop
 
     # Check whether a run created source identical to a previous run, which
     # means that we definitely have an infinite loop.
-    def check_for_infinite_loop(processed_source, offenses)
+    def check_for_infinite_loop(processed_source, offenses_by_iteration)
       checksum = processed_source.checksum
 
-      if @processed_sources.include?(checksum)
-        raise InfiniteCorrectionLoop.new(processed_source.path, offenses)
+      if (loop_start_index = @processed_sources.index(checksum))
+        raise InfiniteCorrectionLoop.new(
+          processed_source.path,
+          offenses_by_iteration,
+          loop_start: loop_start_index
+        )
       end
 
       @processed_sources << checksum
@@ -307,7 +322,7 @@ module RuboCop
     def mobilized_cop_classes(config)
       @mobilized_cop_classes ||= {}
       @mobilized_cop_classes[config.object_id] ||= begin
-        cop_classes = Cop::Cop.all
+        cop_classes = Cop::Registry.all
 
         OptionsValidator.new(@options).validate_cop_options
 

data/lib/rubocop/string_interpreter.rb

@@ -17,6 +17,9 @@ module RuboCop
                             u\{[^}]*\}        |   # extended unicode escape
                             .                     # any other escaped char
                           )/x.freeze
+
+    private_constant :STRING_ESCAPES, :STRING_ESCAPE_REGEX
+
     class << self
       def interpret(string)
         # We currently don't handle \cx, \C-x, and \M-x

data/lib/rubocop/target_finder.rb

@@ -1,10 +1,9 @@
 # frozen_string_literal: true
 
-require 'set'
-
 module RuboCop
   # This class finds target files to inspect by scanning the directory tree
   # and picking ruby files.
+  # @api private
   class TargetFinder
     def initialize(config_store, options = {})
       @config_store = config_store
@@ -114,10 +113,12 @@ module RuboCop
     end
 
     def ruby_extensions
-      ext_patterns = all_cops_include.select do |pattern|
-        pattern.start_with?('**/*.')
+      @ruby_extensions ||= begin
+        ext_patterns = all_cops_include.select do |pattern|
+          pattern.start_with?('**/*.')
+        end
+        ext_patterns.map { |pattern| pattern.sub('**/*', '') }
       end
-      ext_patterns.map { |pattern| pattern.sub('**/*', '') }
     end
 
     def ruby_filename?(file)
@@ -125,14 +126,17 @@ module RuboCop
     end
 
     def ruby_filenames
-      file_patterns = all_cops_include.reject do |pattern|
-        pattern.start_with?('**/*.')
+      @ruby_filenames ||= begin
+        file_patterns = all_cops_include.reject do |pattern|
+          pattern.start_with?('**/*.')
+        end
+        file_patterns.map { |pattern| pattern.sub('**/', '') }
       end
-      file_patterns.map { |pattern| pattern.sub('**/', '') }
     end
 
     def all_cops_include
-      @config_store.for('.').for_all_cops['Include'].map(&:to_s)
+      @all_cops_include ||=
+        @config_store.for_pwd.for_all_cops['Include'].map(&:to_s)
     end
 
     def ruby_executable?(file)
@@ -160,7 +164,7 @@ module RuboCop
     end
 
     def configured_include?(file)
-      @config_store.for('.').file_to_include?(file)
+      @config_store.for_pwd.file_to_include?(file)
     end
 
     def included_file?(file)

data/lib/rubocop/target_ruby.rb

@@ -2,6 +2,7 @@
 
 module RuboCop
   # The kind of Ruby that code inspected by RuboCop is written in.
+  # @api private
   class TargetRuby
     KNOWN_RUBIES = [2.4, 2.5, 2.6, 2.7, 2.8].freeze
     DEFAULT_VERSION = KNOWN_RUBIES.first
@@ -12,6 +13,7 @@ module RuboCop
     private_constant :KNOWN_RUBIES, :OBSOLETE_RUBIES
 
     # A place where information about a target ruby version is found.
+    # @api private
     class Source
       attr_reader :version, :name
 
@@ -26,6 +28,7 @@ module RuboCop
     end
 
     # The target ruby version may be configured in RuboCop's config.
+    # @api private
     class RuboCopConfig < Source
       def name
         "`TargetRubyVersion` parameter (in #{@config.smart_loaded_path})"
@@ -39,6 +42,7 @@ module RuboCop
     end
 
     # The target ruby version may be found in a .ruby-version file.
+    # @api private
     class RubyVersionFile < Source
       FILENAME = '.ruby-version'
 
@@ -68,6 +72,7 @@ module RuboCop
     end
 
     # The lock file of Bundler may identify the target ruby version.
+    # @api private
     class BundlerLockFile < Source
       def name
         "`#{bundler_lock_file_path}`"
@@ -108,6 +113,7 @@ module RuboCop
     end
 
     # If all else fails, a default version will be picked.
+    # @api private
     class Default < Source
       def name
         'default'

data/lib/rubocop/version.rb

@@ -3,13 +3,14 @@
 module RuboCop
   # This module holds the RuboCop version information.
   module Version
-    STRING = '0.87.1'
+    STRING = '0.91.0'
 
     MSG = '%<version>s (using Parser %<parser_version>s, '\
           'rubocop-ast %<rubocop_ast_version>s, ' \
           'running on %<ruby_engine>s %<ruby_version>s %<ruby_platform>s)'
 
-    def self.version(debug = false)
+    # @api private
+    def self.version(debug: false)
       if debug
         format(MSG, version: STRING, parser_version: Parser::VERSION,
                     rubocop_ast_version: RuboCop::AST::Version::STRING,