rubocop 0.89.1 → 0.93.0

data/lib/rubocop/formatter/html_formatter.rb

@@ -90,9 +90,11 @@ module RuboCop
         end
 
         # Make Kernel#binding public.
+        # rubocop:disable Lint/UselessMethodDefinition
         def binding
           super
         end
+        # rubocop:enable Lint/UselessMethodDefinition
 
         def decorated_message(offense)
           offense.message.gsub(/`(.+?)`/) do

data/lib/rubocop/formatter/progress_formatter.rb

@@ -45,7 +45,8 @@ module RuboCop
 
         report_summary(inspected_files.size,
                        @total_offense_count,
-                       @total_correction_count)
+                       @total_correction_count,
+                       @total_correctable_count)
       end
 
       def report_file_as_mark(offenses)

data/lib/rubocop/formatter/quiet_formatter.rb

@@ -5,7 +5,7 @@ module RuboCop
     # If no offenses are found, no output is displayed.
     # Otherwise, SimpleTextFormatter's output is displayed.
     class QuietFormatter < SimpleTextFormatter
-      def report_summary(file_count, offense_count, correction_count)
+      def report_summary(file_count, offense_count, correction_count, correctable_count)
         super unless offense_count.zero?
       end
     end

data/lib/rubocop/formatter/simple_text_formatter.rb

@@ -23,6 +23,7 @@ module RuboCop
       def started(_target_files)
         @total_offense_count = 0
         @total_correction_count = 0
+        @total_correctable_count = 0
       end
 
       def file_finished(file, offenses)
@@ -35,7 +36,8 @@ module RuboCop
       def finished(inspected_files)
         report_summary(inspected_files.count,
                        @total_offense_count,
-                       @total_correction_count)
+                       @total_correction_count,
+                       @total_correctable_count)
       end
 
       def report_file(file, offenses)
@@ -52,11 +54,13 @@ module RuboCop
         end
       end
 
-      def report_summary(file_count, offense_count, correction_count)
+      def report_summary(file_count, offense_count, correction_count, correctable_count)
         report = Report.new(file_count,
                             offense_count,
                             correction_count,
-                            rainbow)
+                            correctable_count,
+                            rainbow,
+                            safe_auto_correct: @options[:safe_auto_correct])
 
         output.puts
         output.puts report.summary
@@ -66,7 +70,9 @@ module RuboCop
 
       def count_stats(offenses)
         @total_offense_count += offenses.count
-        @total_correction_count += offenses.count(&:corrected?)
+        corrected = offenses.count(&:corrected?)
+        @total_correction_count += corrected
+        @total_correctable_count += offenses.count(&:correctable?) - corrected
       end
 
       def colored_severity_code(offense)
@@ -96,16 +102,30 @@ module RuboCop
         include Colorizable
         include TextUtil
 
-        def initialize(file_count, offense_count, correction_count, rainbow)
+        # rubocop:disable Metrics/ParameterLists
+        def initialize(
+          file_count, offense_count, correction_count, correctable_count, rainbow,
+          safe_auto_correct: false
+        )
           @file_count = file_count
           @offense_count = offense_count
           @correction_count = correction_count
+          @correctable_count = correctable_count
           @rainbow = rainbow
+          @safe_auto_correct = safe_auto_correct
         end
+        # rubocop:enable Metrics/ParameterLists
 
         def summary
           if @correction_count.positive?
-            "#{files} inspected, #{offenses} detected, #{corrections} corrected"
+            if @correctable_count.positive?
+              "#{files} inspected, #{offenses} detected, #{corrections} corrected,"\
+                " #{correctable}"
+            else
+              "#{files} inspected, #{offenses} detected, #{corrections} corrected"
+            end
+          elsif @correctable_count.positive?
+            "#{files} inspected, #{offenses} detected, #{correctable}"
           else
             "#{files} inspected, #{offenses} detected"
           end
@@ -132,6 +152,16 @@ module RuboCop
 
           colorize(text, color)
         end
+
+        def correctable
+          if @safe_auto_correct
+            text = pluralize(@correctable_count, 'more offense')
+            "#{colorize(text, :yellow)} can be corrected with `rubocop -A`"
+          else
+            text = pluralize(@correctable_count, 'offense')
+            "#{colorize(text, :yellow)} auto-correctable"
+          end
+        end
       end
     end
   end

data/lib/rubocop/name_similarity.rb

@@ -2,6 +2,7 @@
 
 module RuboCop
   # Common functionality for finding names that are similar to a given name.
+  # @api private
   module NameSimilarity
     module_function
 

data/lib/rubocop/options.rb

@@ -8,6 +8,7 @@ module RuboCop
   class OptionArgumentError < StandardError; end
 
   # This class handles command line options.
+  # @api private
   class Options
     E_STDIN_NO_PATH = '-s/--stdin requires exactly one path, relative to the ' \
       'root of the project. RuboCop will use this path to determine which ' \
@@ -68,6 +69,7 @@ module RuboCop
 
         add_severity_option(opts)
         add_flags_with_optional_args(opts)
+        add_cache_options(opts)
         add_boolean_flags(opts)
         add_aliases(opts)
 
@@ -112,20 +114,19 @@ module RuboCop
     def add_auto_gen_options(opts)
       option(opts, '--auto-gen-config')
 
+      option(opts, '--regenerate-todo') do
+        @options.replace(ConfigRegeneration.new.options.merge(@options))
+      end
+
       option(opts, '--exclude-limit COUNT') do
         @validator.validate_exclude_limit_option
       end
 
       option(opts, '--disable-uncorrectable')
 
-      option(opts, '--no-offense-counts') do
-        @options[:no_offense_counts] = true
-      end
-
-      option(opts, '--auto-gen-only-exclude')
-      option(opts, '--no-auto-gen-timestamp') do
-        @options[:no_auto_gen_timestamp] = true
-      end
+      option(opts, '--[no-]offense-counts')
+      option(opts, '--[no-]auto-gen-only-exclude')
+      option(opts, '--[no-]auto-gen-timestamp')
 
       option(opts, '--init')
     end
@@ -163,10 +164,16 @@ module RuboCop
       end
     end
 
+    def add_cache_options(opts)
+      option(opts, '-C', '--cache FLAG')
+      option(opts, '--cache-root DIR') do
+        @validator.validate_cache_enabled_for_cache_root
+      end
+    end
+
     # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
     def add_boolean_flags(opts)
       option(opts, '-F', '--fail-fast')
-      option(opts, '-C', '--cache FLAG')
       option(opts, '-d', '--debug')
       option(opts, '-D', '--[no-]display-cop-names')
       option(opts, '-E', '--extra-details')
@@ -232,6 +239,7 @@ module RuboCop
   end
 
   # Validates option arguments and the options' compatibility with each other.
+  # @api private
   class OptionsValidator
     class << self
       # Cop name validation must be done later than option parsing, so it's not
@@ -309,7 +317,7 @@ module RuboCop
 
       message = '--%<flag>s can only be used together with --auto-gen-config.'
 
-      %i[exclude_limit no_offense_counts no_auto_gen_timestamp
+      %i[exclude_limit offense_counts auto_gen_timestamp
          auto_gen_only_exclude].each do |option|
         if @options.key?(option)
           raise OptionArgumentError,
@@ -390,9 +398,17 @@ module RuboCop
       # of option order.
       raise OptionParser::MissingArgument
     end
+
+    def validate_cache_enabled_for_cache_root
+      return unless @options[:cache] == 'false'
+
+      raise OptionArgumentError, '--cache-root can not be used with ' \
+                                  '--cache false'
+    end
   end
 
   # This module contains help texts for command line options.
+  # @api private
   module OptionsHelp
     MAX_EXCL = RuboCop::Options::DEFAULT_MAXIMUM_EXCLUSION_ITEMS.to_s
     FORMATTER_OPTION_LIST = RuboCop::Formatter::FormatterSet::BUILTIN_FORMATTERS_FOR_KEYS.keys
@@ -406,17 +422,20 @@ module RuboCop
       config:                           'Specify configuration file.',
       auto_gen_config:                  ['Generate a configuration file acting as a',
                                          'TODO list.'],
-      no_offense_counts:                ['Do not include offense counts in configuration',
-                                         'file generated by --auto-gen-config.'],
-      no_auto_gen_timestamp:
-                                        ['Do not include the date and time when',
-                                         'the --auto-gen-config was run in the file it',
-                                         'generates.'],
+      regenerate_todo:                  ['Regenerate the TODO configuration file using',
+                                         'the last configuration. If there is no existing',
+                                         'TODO file, acts like --auto-gen-config.'],
+      offense_counts:                   ['Include offense counts in configuration',
+                                         'file generated by --auto-gen-config.',
+                                         'Default is true.'],
+      auto_gen_timestamp:
+                                        ['Include the date and time when the --auto-gen-config',
+                                         'was run in the file it generates. Default is true.'],
       auto_gen_only_exclude:
                                         ['Generate only Exclude parameters and not Max',
                                          'when running --auto-gen-config, except if the',
                                          'number of files with offenses is bigger than',
-                                         'exclude-limit.'],
+                                         'exclude-limit. Default is false.'],
       exclude_limit:                    ['Used together with --auto-gen-config to',
                                          'set the limit for how many Exclude',
                                          "properties to generate. Default is #{MAX_EXCL}."],
@@ -461,6 +480,10 @@ module RuboCop
       cache:                            ["Use result caching (FLAG=true) or don't",
                                          '(FLAG=false), default determined by',
                                          'configuration parameter AllCops: UseCache.'],
+      cache_root:                       ['Set the cache root directory.',
+                                         'Takes precedence over the configuration',
+                                         'parameter AllCops: CacheRootDirectory and',
+                                         'the $RUBOCOP_CACHE_ROOT environment variable.'],
       debug:                            'Display debug info.',
       display_cop_names:                ['Display cop names in offense messages.',
                                          'Default is true.'],

data/lib/rubocop/remote_config.rb

@@ -5,6 +5,7 @@ require 'time'
 
 module RuboCop
   # Common methods and behaviors for dealing with remote config files.
+  # @api private
   class RemoteConfig
     attr_reader :uri
 

data/lib/rubocop/result_cache.rb

@@ -3,9 +3,11 @@
 require 'digest/sha1'
 require 'find'
 require 'etc'
+require 'zlib'
 
 module RuboCop
   # Provides functionality for caching rubocop runs.
+  # @api private
   class ResultCache
     NON_CHANGING = %i[color format formatters out debug fail_level auto_correct
                       cache fail_fast stdin parallel].freeze
@@ -29,6 +31,11 @@ module RuboCop
     end
 
     class << self
+      # @api private
+      attr_accessor :rubocop_required_features
+
+      ResultCache.rubocop_required_features = []
+
       private
 
       def requires_file_removal?(file_count, config_store)
@@ -60,7 +67,8 @@ module RuboCop
     end
 
     def self.cache_root(config_store)
-      root = config_store.for_pwd.for_all_cops['CacheRootDirectory']
+      root = ENV['RUBOCOP_CACHE_ROOT']
+      root ||= config_store.for_pwd.for_all_cops['CacheRootDirectory']
       root ||= if ENV.key?('XDG_CACHE_HOME')
                  # Include user ID in the path to make sure the user has write
                  # access.
@@ -75,7 +83,10 @@ module RuboCop
       config_store.for_pwd.for_all_cops['AllowSymlinksInCacheRootDirectory']
     end
 
+    attr :path
+
     def initialize(file, team, options, config_store, cache_root = nil)
+      cache_root ||= options[:cache_root]
       cache_root ||= ResultCache.cache_root(config_store)
       @allow_symlinks_in_cache_location =
         ResultCache.allow_symlinks_in_cache_location?(config_store)
@@ -84,6 +95,11 @@ module RuboCop
                         context_checksum(team, options),
                         file_checksum(file, config_store))
       @cached_data = CachedData.new(file)
+      @debug = options[:debug]
+    end
+
+    def debug?
+      @debug
     end
 
     def valid?
@@ -91,6 +107,7 @@ module RuboCop
     end
 
     def load
+      puts "Loading cache from #{@path}" if debug?
       @cached_data.from_json(IO.read(@path, encoding: Encoding::UTF_8))
     end
 
@@ -158,27 +175,34 @@ module RuboCop
     end
 
     # The checksum of the rubocop program running the inspection.
-    # rubocop:disable Metrics/AbcSize
     def rubocop_checksum
       ResultCache.source_checksum ||=
         begin
-          lib_root = File.join(File.dirname(__FILE__), '..')
-          exe_root = File.join(lib_root, '..', 'exe')
-
-          # These are all the files we have `require`d plus everything in the
-          # exe directory. A change to any of them could affect the cop output
-          # so we include them in the cache hash.
-          source_files = $LOADED_FEATURES + Find.find(exe_root).to_a
-
           digest = Digest::SHA1.new
-          source_files
+          rubocop_extra_features
             .select { |path| File.file?(path) }
             .sort!
-            .each { |path| digest << File.mtime(path).to_s }
+            .each do |path|
+              content = File.open(path, 'rb', &:read)
+              digest << Zlib.crc32(content).to_s # mtime not reliable
+            end
+          digest << RuboCop::Version::STRING << RuboCop::AST::Version::STRING
           digest.hexdigest
         end
     end
-    # rubocop:enable Metrics/AbcSize
+
+    def rubocop_extra_features
+      lib_root = File.join(File.dirname(__FILE__), '..')
+      exe_root = File.join(lib_root, '..', 'exe')
+
+      # These are all the files we have `require`d plus everything in the
+      # exe directory. A change to any of them could affect the cop output
+      # so we include them in the cache hash.
+      source_files = $LOADED_FEATURES + Find.find(exe_root).to_a
+      source_files -= ResultCache.rubocop_required_features # Rely on gem versions
+
+      source_files
+    end
 
     # Return a hash of the options given at invocation, minus the ones that have
     # no effect on which offenses and disabled line ranges are found, and thus
@@ -191,8 +215,8 @@ module RuboCop
     # The external dependency checksums are cached per RuboCop team so that
     # the checksums don't need to be recomputed for each file.
     def team_checksum(team)
-      @checksum_by_team ||= {}
-      @checksum_by_team[team.object_id] ||= team.external_dependency_checksum
+      @checksum_by_team ||= {}.compare_by_identity
+      @checksum_by_team[team] ||= team.external_dependency_checksum
     end
 
     # We combine team and options into a single "context" checksum to avoid

data/lib/rubocop/rspec/cop_helper.rb

@@ -17,13 +17,16 @@ module CopHelper
     RuboCop::Formatter::DisabledConfigFormatter.config_to_allow_offenses = {}
     RuboCop::Formatter::DisabledConfigFormatter.detected_styles = {}
     processed_source = parse_source(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
 
     _investigate(cop, processed_source)
   end
 
   def parse_source(source, file = nil)
-    if file&.respond_to?(:write)
+    if file.respond_to?(:write)
       file.write(source)
       file.rewind
       file = file.path

data/lib/rubocop/rspec/expect_offense.rb

@@ -128,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)
+        @offenses = _investigate(cop, @processed_source)
         actual_annotations =
-          expected_annotations.with_offense_annotations(offenses)
+          expected_annotations.with_offense_annotations(@offenses)
 
         expect(actual_annotations).to eq(expected_annotations), ''
-        expect(offenses.map(&:severity).uniq).to eq([severity]) if severity
+        expect(@offenses.map(&:severity).uniq).to eq([severity]) if severity
+
+        @offenses
       end
 
       def expect_correction(correction, loop: true)
@@ -152,7 +157,7 @@ module RuboCop
           break corrected_source if corrected_source == @processed_source.buffer.source
 
           if iteration > RuboCop::Runner::MAX_ITERATIONS
-            raise RuboCop::Runner::InfiniteCorrectionLoop.new(@processed_source.path, [])
+            raise RuboCop::Runner::InfiniteCorrectionLoop.new(@processed_source.path, [@offenses])
           end
 
           # Prepare for next loop
@@ -236,10 +241,10 @@ module RuboCop
         def match_annotations?(other)
           annotations.zip(other.annotations) do |(_actual_line, actual_annotation),
                                                  (_expected_line, expected_annotation)|
-            if expected_annotation&.end_with?(ABBREV)
-              if actual_annotation.start_with?(expected_annotation[0...-ABBREV.length])
-                expected_annotation.replace(actual_annotation)
-              end
+            if expected_annotation&.end_with?(ABBREV) &&
+               actual_annotation.start_with?(expected_annotation[0...-ABBREV.length])
+
+              expected_annotation.replace(actual_annotation)
             end
           end