rubocop 0.90.0 → 0.93.1

data/lib/rubocop/result_cache.rb

@@ -3,6 +3,7 @@
 require 'digest/sha1'
 require 'find'
 require 'etc'
+require 'zlib'
 
 module RuboCop
   # Provides functionality for caching rubocop runs.
@@ -30,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)
@@ -61,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.
@@ -76,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)
@@ -85,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?
@@ -92,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
 
@@ -159,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
@@ -192,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

@@ -26,7 +26,7 @@ module CopHelper
   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

@@ -133,14 +133,14 @@ module RuboCop
             "#{@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
+        @offenses
       end
 
       def expect_correction(correction, loop: true)
@@ -157,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

data/lib/rubocop/runner.rb

@@ -11,9 +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(' -> ')
+
+        message = 'Infinite loop detected'
+        message += " in #{path}" if path
+        message += " and caused by #{root_cause}" if root_cause
+        super message
       end
     end
 
@@ -81,7 +88,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
@@ -233,18 +243,21 @@ module RuboCop
 
     def do_inspection_loop(file)
       processed_source = get_processed_source(file)
-      offenses = []
+      # 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 +267,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 +284,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 +297,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
@@ -305,8 +324,8 @@ module RuboCop
     end
 
     def mobilized_cop_classes(config)
-      @mobilized_cop_classes ||= {}
-      @mobilized_cop_classes[config.object_id] ||= begin
+      @mobilized_cop_classes ||= {}.compare_by_identity
+      @mobilized_cop_classes[config] ||= begin
         cop_classes = Cop::Registry.all
 
         OptionsValidator.new(@options).validate_cop_options
@@ -380,8 +399,8 @@ module RuboCop
     # otherwise dormant team that can be used for config- and option-
     # level caching in ResultCache.
     def standby_team(config)
-      @team_by_config ||= {}
-      @team_by_config[config.object_id] ||=
+      @team_by_config ||= {}.compare_by_identity
+      @team_by_config[config] ||=
         Cop::Team.mobilize(mobilized_cop_classes(config), config, @options)
     end
   end

data/lib/rubocop/target_finder.rb

@@ -5,6 +5,8 @@ module RuboCop
   # and picking ruby files.
   # @api private
   class TargetFinder
+    HIDDEN_PATH_SUBSTRING = "#{File::SEPARATOR}."
+
     def initialize(config_store, options = {})
       @config_store = config_store
       @options = options
@@ -55,7 +57,8 @@ module RuboCop
       # Support Windows: Backslashes from command-line -> forward slashes
       base_dir = base_dir.gsub(File::ALT_SEPARATOR, File::SEPARATOR) if File::ALT_SEPARATOR
       all_files = find_files(base_dir, File::FNM_DOTMATCH)
-      hidden_files = Set.new(all_files - find_files(base_dir, 0))
+      # use file.include? for performance optimization
+      hidden_files = all_files.select { |file| file.include?(HIDDEN_PATH_SUBSTRING) }
       base_dir_config = @config_store.for(base_dir)
 
       target_files = all_files.select do |file|
@@ -78,34 +81,32 @@ module RuboCop
     # the top level directories that are excluded in configuration in the
     # normal way (dir/**/*).
     def find_files(base_dir, flags)
-      wanted_toplevel_dirs = toplevel_dirs(base_dir, flags) -
-                             excluded_dirs(base_dir)
-      wanted_toplevel_dirs.map! { |dir| dir << '/**/*' }
-
-      pattern = if wanted_toplevel_dirs.empty?
-                  # We need this special case to avoid creating the pattern
-                  # /**/* which searches the entire file system.
-                  ["#{base_dir}/**/*"]
-                else
-                  # Search the non-excluded top directories, but also add files
-                  # on the top level, which would otherwise not be found.
-                  wanted_toplevel_dirs.unshift("#{base_dir}/*")
+      # get all wanted directories first to improve speed of finding all files
+      exclude_pattern = combined_exclude_glob_patterns(base_dir)
+      dir_flags = flags | File::FNM_PATHNAME | File::FNM_EXTGLOB
+      patterns = wanted_dir_patterns(base_dir, exclude_pattern, dir_flags)
+      patterns.map! { |dir| File.join(dir, '*') }
+      # We need this special case to avoid creating the pattern
+      # /**/* which searches the entire file system.
+      patterns = [File.join(dir, '**/*')] if patterns.empty?
+
+      Dir.glob(patterns, flags).select { |path| FileTest.file?(path) }
+    end
+
+    def wanted_dir_patterns(base_dir, exclude_pattern, flags)
+      dirs = Dir.glob(File.join(base_dir, '*/'), flags)
+                .reject do |dir|
+                  dir.end_with?('/./', '/../') || File.fnmatch?(exclude_pattern, dir, flags)
                 end
-      Dir.glob(pattern, flags).select { |path| FileTest.file?(path) }
+      dirs.flat_map { |dir| wanted_dir_patterns(dir, exclude_pattern, flags) }
+          .unshift(base_dir)
     end
 
-    def toplevel_dirs(base_dir, flags)
-      Dir.glob(File.join(base_dir, '*'), flags).select do |dir|
-        File.directory?(dir) && !dir.end_with?('/.', '/..')
-      end
-    end
-
-    def excluded_dirs(base_dir)
-      all_cops_config = @config_store.for(base_dir).for_all_cops
-      dir_tree_excludes = all_cops_config['Exclude'].select do |pattern|
-        pattern.is_a?(String) && pattern.end_with?('/**/*')
-      end
-      dir_tree_excludes.map { |pattern| pattern.sub(%r{/\*\*/\*$}, '') }
+    def combined_exclude_glob_patterns(base_dir)
+      exclude = @config_store.for(base_dir).for_all_cops['Exclude']
+      patterns = exclude.select { |pattern| pattern.is_a?(String) && pattern.end_with?('/**/*') }
+                        .map { |pattern| pattern.sub("#{base_dir}/", '') }
+      "#{base_dir}/{#{patterns.join(',')}}"
     end
 
     def ruby_extension?(file)

data/lib/rubocop/target_ruby.rb

@@ -4,7 +4,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
+    KNOWN_RUBIES = [2.4, 2.5, 2.6, 2.7, 3.0].freeze
     DEFAULT_VERSION = KNOWN_RUBIES.first
 
     OBSOLETE_RUBIES = {

data/lib/rubocop/version.rb

@@ -3,7 +3,7 @@
 module RuboCop
   # This module holds the RuboCop version information.
   module Version
-    STRING = '0.90.0'
+    STRING = '0.93.1'
 
     MSG = '%<version>s (using Parser %<parser_version>s, '\
           'rubocop-ast %<rubocop_ast_version>s, ' \
@@ -20,5 +20,10 @@ module RuboCop
         STRING
       end
     end
+
+    # @api private
+    def self.document_version
+      STRING.match('\d+\.\d+').to_s
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop
 version: !ruby/object:Gem::Version
-  version: 0.90.0
+  version: 0.93.1
 platform: ruby
 authors:
 - Bozhidar Batsov
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-09-01 00:00:00.000000000 Z
+date: 2020-10-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parallel
@@ -32,14 +32,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.7.1.1
+        version: 2.7.1.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.7.1.1
+        version: 2.7.1.5
 - !ruby/object:Gem::Dependency
   name: rainbow
   requirement: !ruby/object:Gem::Requirement
@@ -66,14 +66,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '1.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '1.8'
 - !ruby/object:Gem::Dependency
   name: rexml
   requirement: !ruby/object:Gem::Requirement
@@ -94,20 +94,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.3.0
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 0.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.3.0
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 0.6.0
 - !ruby/object:Gem::Dependency
   name: ruby-progressbar
   requirement: !ruby/object:Gem::Requirement
@@ -199,6 +193,7 @@ files:
 - lib/rubocop/config_loader.rb
 - lib/rubocop/config_loader_resolver.rb
 - lib/rubocop/config_obsoletion.rb
+- lib/rubocop/config_regeneration.rb
 - lib/rubocop/config_store.rb
 - lib/rubocop/config_validator.rb
 - lib/rubocop/cop/autocorrect_logic.rb
@@ -248,6 +243,7 @@ files:
 - lib/rubocop/cop/layout/argument_alignment.rb
 - lib/rubocop/cop/layout/array_alignment.rb
 - lib/rubocop/cop/layout/assignment_indentation.rb
+- lib/rubocop/cop/layout/begin_end_alignment.rb
 - lib/rubocop/cop/layout/block_alignment.rb
 - lib/rubocop/cop/layout/block_end_newline.rb
 - lib/rubocop/cop/layout/case_indentation.rb
@@ -345,6 +341,7 @@ files:
 - lib/rubocop/cop/lint/binary_operator_with_identical_operands.rb
 - lib/rubocop/cop/lint/boolean_symbol.rb
 - lib/rubocop/cop/lint/circular_argument_reference.rb
+- lib/rubocop/cop/lint/constant_definition_in_block.rb
 - lib/rubocop/cop/lint/constant_resolution.rb
 - lib/rubocop/cop/lint/debugger.rb
 - lib/rubocop/cop/lint/deprecated_class_methods.rb
@@ -370,7 +367,9 @@ files:
 - lib/rubocop/cop/lint/float_comparison.rb
 - lib/rubocop/cop/lint/float_out_of_range.rb
 - lib/rubocop/cop/lint/format_parameter_mismatch.rb
+- lib/rubocop/cop/lint/hash_compare_by_identity.rb
 - lib/rubocop/cop/lint/heredoc_method_call_position.rb
+- lib/rubocop/cop/lint/identity_comparison.rb
 - lib/rubocop/cop/lint/implicit_string_concatenation.rb
 - lib/rubocop/cop/lint/ineffective_access_modifier.rb
 - lib/rubocop/cop/lint/inherit_exception.rb
@@ -398,6 +397,7 @@ files:
 - lib/rubocop/cop/lint/redundant_cop_disable_directive.rb
 - lib/rubocop/cop/lint/redundant_cop_enable_directive.rb
 - lib/rubocop/cop/lint/redundant_require_statement.rb
+- lib/rubocop/cop/lint/redundant_safe_navigation.rb
 - lib/rubocop/cop/lint/redundant_splat_expansion.rb
 - lib/rubocop/cop/lint/redundant_string_coercion.rb
 - lib/rubocop/cop/lint/redundant_with_index.rb
@@ -435,6 +435,7 @@ files:
 - lib/rubocop/cop/lint/useless_else_without_rescue.rb
 - lib/rubocop/cop/lint/useless_method_definition.rb
 - lib/rubocop/cop/lint/useless_setter_call.rb
+- lib/rubocop/cop/lint/useless_times.rb
 - lib/rubocop/cop/lint/void.rb
 - lib/rubocop/cop/message_annotator.rb
 - lib/rubocop/cop/metrics/abc_size.rb
@@ -502,7 +503,6 @@ files:
 - lib/rubocop/cop/mixin/preferred_delimiters.rb
 - lib/rubocop/cop/mixin/range_help.rb
 - lib/rubocop/cop/mixin/rational_literal.rb
-- lib/rubocop/cop/mixin/regexp_literal_help.rb
 - lib/rubocop/cop/mixin/rescue_node.rb
 - lib/rubocop/cop/mixin/safe_assignment.rb
 - lib/rubocop/cop/mixin/space_after_punctuation.rb
@@ -560,6 +560,7 @@ files:
 - lib/rubocop/cop/style/character_literal.rb
 - lib/rubocop/cop/style/class_and_module_children.rb
 - lib/rubocop/cop/style/class_check.rb
+- lib/rubocop/cop/style/class_equality_comparison.rb
 - lib/rubocop/cop/style/class_methods.rb
 - lib/rubocop/cop/style/class_methods_definitions.rb
 - lib/rubocop/cop/style/class_vars.rb
@@ -740,7 +741,6 @@ files:
 - lib/rubocop/cop/style/yoda_condition.rb
 - lib/rubocop/cop/style/zero_length_predicate.rb
 - lib/rubocop/cop/team.rb
-- lib/rubocop/cop/tokens_util.rb
 - lib/rubocop/cop/util.rb
 - lib/rubocop/cop/utils/format_string.rb
 - lib/rubocop/cop/variable_force.rb
@@ -753,6 +753,7 @@ files:
 - lib/rubocop/cop/variable_force/variable_table.rb
 - lib/rubocop/cops_documentation_generator.rb
 - lib/rubocop/core_ext/string.rb
+- lib/rubocop/directive_comment.rb
 - lib/rubocop/error.rb
 - lib/rubocop/ext/processed_source.rb
 - lib/rubocop/ext/regexp_node.rb
@@ -804,7 +805,7 @@ metadata:
   homepage_uri: https://rubocop.org/
   changelog_uri: https://github.com/rubocop-hq/rubocop/blob/master/CHANGELOG.md
   source_code_uri: https://github.com/rubocop-hq/rubocop/
-  documentation_uri: https://docs.rubocop.org/
+  documentation_uri: https://docs.rubocop.org/rubocop/0.93/
   bug_tracker_uri: https://github.com/rubocop-hq/rubocop/issues
 post_install_message: 
 rdoc_options: []
@@ -821,7 +822,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Automatic Ruby code style checking tool.