rubocop 1.88.2 → 1.89.0

data/lib/rubocop/project_index_loader.rb

@@ -62,5 +62,21 @@ module RuboCop
     rescue StandardError => e
       warn Rainbow("rubydex index build failed: #{e.message}. Continuing without it.").yellow
     end
+
+    # The Ruby source files of every gem in the project's bundle, for
+    # `AllCops/ProjectIndexIncludesGems`. Returns an empty array when RuboCop
+    # does not run inside Bundler, so the option silently degrades to
+    # project-only indexing.
+    def bundled_gem_source_files
+      return [] unless defined?(Bundler) && Bundler::SharedHelpers.in_bundle?
+
+      Bundler.load.specs.flat_map do |spec|
+        Dir.glob(File.join(spec.full_gem_path, 'lib', '**', '*.rb'))
+      end
+    rescue StandardError => e
+      message = "rubydex bundle indexing failed: #{e.message}. Indexing the project only."
+      warn Rainbow(message).yellow
+      []
+    end
   end
 end

data/lib/rubocop/result_cache.rb

@@ -237,10 +237,12 @@ module RuboCop
         # when traversing the relative paths with symlinks.
         exe_root = File.absolute_path(exe_root)
 
-        # 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
+        # These are all the files we have `require`d, all of RuboCop's own files whether loaded
+        # or not (cops are loaded lazily, so which of them are in `$LOADED_FEATURES` varies from
+        # run to run), 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.
+        rubocop_lib_files = Dir[File.join(File.absolute_path(lib_root), 'rubocop', '**', '*.rb')]
+        source_files = $LOADED_FEATURES | rubocop_lib_files | Find.find(exe_root).to_a
         source_files -= ResultCache.rubocop_required_features # Rely on gem versions
 
         source_files

data/lib/rubocop/rspec/shared_contexts.rb

@@ -6,11 +6,14 @@ require 'tmpdir'
 # or stubbing Dir.pwd get a fresh value.
 RSpec.configure { |c| c.before { RuboCop::PathUtil.reset_pwd } }
 
-RSpec.shared_context 'isolated environment' do # rubocop:disable Metrics/BlockLength
-  around do |example| # rubocop:disable Metrics/BlockLength
+# rubocop:disable Metrics/BlockLength
+RSpec.shared_context 'isolated environment' do
+  around do |example|
     Dir.mktmpdir do |tmpdir|
       original_home = Dir.home
       original_xdg_config_home = ENV.fetch('XDG_CONFIG_HOME', nil)
+      original_xdg_cache_home = ENV.fetch('XDG_CACHE_HOME', nil)
+      original_rubocop_cache_root = ENV.fetch('RUBOCOP_CACHE_ROOT', nil)
 
       # Make sure to expand all symlinks in the path first. Otherwise we may
       # get mismatched pathnames when loading config files later on.
@@ -23,6 +26,12 @@ RSpec.shared_context 'isolated environment' do # rubocop:disable Metrics/BlockLe
       ENV['HOME'] = virtual_home
       ENV.delete('XDG_CONFIG_HOME')
 
+      # `XDG_CACHE_HOME` and `RUBOCOP_CACHE_ROOT` are set on some CI runners and
+      # would otherwise point the result cache at a fixed directory shared across examples
+      # and parallel test-queue workers, letting one example's cache leak into another.
+      ENV.delete('XDG_CACHE_HOME')
+      ENV.delete('RUBOCOP_CACHE_ROOT')
+
       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')
@@ -38,6 +47,8 @@ RSpec.shared_context 'isolated environment' do # rubocop:disable Metrics/BlockLe
       ensure
         ENV['HOME'] = original_home
         ENV['XDG_CONFIG_HOME'] = original_xdg_config_home
+        ENV['XDG_CACHE_HOME'] = original_xdg_cache_home
+        ENV['RUBOCOP_CACHE_ROOT'] = original_rubocop_cache_root
 
         RuboCop::ResultCache.reset_config_cache
         RuboCop::ConfigLoader.clear_options # This also resets RuboCop::FileFinder.root_level
@@ -58,6 +69,7 @@ RSpec.shared_context 'isolated environment' do # rubocop:disable Metrics/BlockLe
     end
   end
 end
+# rubocop:enable Metrics/BlockLength
 
 # Workaround for https://github.com/rubocop/rubocop/issues/12978,
 # there should already be no gemfile in the temp directory

data/lib/rubocop/runner.rb

@@ -72,7 +72,7 @@ module RuboCop
       ResultCache.source_checksum
 
       target_files = find_target_files(paths)
-      @project_index = ProjectIndexLoader.build_index(target_files) if project_index_enabled?
+      build_project_index(target_files)
 
       if @options[:list_target_files]
         list_files(target_files)
@@ -104,6 +104,34 @@ module RuboCop
       target_files.each(&:freeze).freeze
     end
 
+    def build_project_index(target_files)
+      return unless project_index_enabled?
+
+      @project_index = ProjectIndexLoader.build_index(project_index_files(target_files))
+    end
+
+    # The index always covers the whole project, not just the files being
+    # inspected: cross-file offenses must not depend on which files a
+    # particular run happens to include, or single-file runs (editors, CI
+    # sharding) would see different offenses than full runs. The project is
+    # rooted at the directory of the configuration that enabled the index.
+    def project_index_files(target_files)
+      root = @config_store.for_pwd.base_dir_for_path_parameters
+      project_files = begin
+        find_target_files([root]) | target_files
+      rescue Errno::ENOENT
+        target_files
+      end
+
+      (project_files | bundled_gem_files).sort
+    end
+
+    def bundled_gem_files
+      return [] unless @config_store.for_pwd.for_all_cops['ProjectIndexIncludesGems']
+
+      ProjectIndexLoader.bundled_gem_source_files
+    end
+
     def project_index_enabled?
       return false unless @config_store.for_pwd.for_all_cops['UseProjectIndex']
 
@@ -479,27 +507,31 @@ module RuboCop
       team
     end
 
-    def mobilized_cop_classes(config) # rubocop:disable Metrics/AbcSize
+    def mobilized_cop_classes(config)
       @mobilized_cop_classes ||= {}.compare_by_identity
       @mobilized_cop_classes[config] ||= begin
-        cop_classes = Cop::Registry.all
-
         # `@options[:only]` and `@options[:except]` are not qualified until
-        # needed so that the Registry can be fully loaded, including any
-        # cops added by `require`s.
+        # needed so that the registry contains any cops added by `require`s,
+        # which register eagerly when their files are loaded.
         qualify_option_cop_names
 
         OptionsValidator.new(@options).validate_cop_options
 
-        if @options[:only]
-          cop_classes.select! { |c| c.match?(@options[:only]) }
-        else
-          filter_cop_classes(cop_classes, config)
-        end
+        # Filtering by badge keeps lazy-loaded cops unloaded; only the cops
+        # that survive the filter and are enabled will be loaded.
+        Cop::Registry.global.filter_by_badge(@options) { |badge| mobilize_cop_badge?(badge, config) }
+      end
+    end
 
-        cop_classes.reject! { |c| c.match?(@options[:except]) }
+    def mobilize_cop_badge?(badge, config)
+      return false if badge.department == :Test
+      return false if badge.match_name?(@options[:except])
 
-        Cop::Registry.new(cop_classes, @options)
+      if @options[:only]
+        badge.match_name?(@options[:only])
+      else
+        # use only cops that link to a style guide if requested.
+        !style_guide_cops_only?(config) || config.for_cop(badge.to_s)['StyleGuide']
       end
     end
 
@@ -513,13 +545,6 @@ module RuboCop
       end
     end
 
-    def filter_cop_classes(cop_classes, config)
-      # use only cops that link to a style guide if requested
-      return unless style_guide_cops_only?(config)
-
-      cop_classes.select! { |cop| config.for_cop(cop)['StyleGuide'] }
-    end
-
     def style_guide_cops_only?(config)
       @options[:only_guide_cops] || config.for_all_cops['StyleGuideCopsOnly']
     end

data/lib/rubocop/server/cache.rb

@@ -64,11 +64,15 @@ module RuboCop
         # rubocop:enable Metrics/AbcSize
 
         def dir
-          Pathname.new(File.join(cache_path, project_dir_cache_key)).tap do |d|
+          dir_path.tap do |d|
             d.mkpath unless d.exist?
           end
         end
 
+        def dir_path
+          Pathname.new(File.join(cache_path, project_dir_cache_key))
+        end
+
         def cache_path
           cache_root_dir = if cache_root_path
                              File.join(cache_root_path, 'rubocop_cache')
@@ -87,8 +91,8 @@ module RuboCop
           dir.join('token')
         end
 
-        def pid_path
-          dir.join('pid')
+        def pid_path(create_dir: true)
+          (create_dir ? dir : dir_path).join('pid')
         end
 
         def lock_path
@@ -108,8 +112,9 @@ module RuboCop
         end
 
         def pid_running?
-          Process.kill(0, pid_path.read.to_i) == 1
-        rescue Errno::ESRCH, Errno::ENOENT, Errno::EACCES, Errno::EROFS, Errno::ENAMETOOLONG
+          Process.kill(0, pid_path(create_dir: false).read.to_i) == 1
+        rescue Errno::ESRCH, Errno::ENOENT, Errno::EACCES, Errno::EROFS, Errno::ENAMETOOLONG,
+               Errno::ENOTDIR
           false
         end
 

data/lib/rubocop/target_ruby.rb

@@ -212,7 +212,7 @@ module RuboCop
       end
 
       def pattern
-        /^ruby = "(?<version>\d+\.\d+)/.freeze
+        /^ruby = ["'](?<version>\d+\.\d+)/.freeze
       end
     end
 

data/lib/rubocop/version.rb

@@ -3,7 +3,7 @@
 module RuboCop
   # This module holds the RuboCop version information.
   module Version
-    STRING = '1.88.2'
+    STRING = '1.89.0'
 
     MSG = '%<version>s (using %<parser_version>s, ' \
           'rubocop-ast %<rubocop_ast_version>s, ' \