rubocop 1.72.1 → 1.81.7

data/lib/rubocop/lsp/diagnostic.rb

@@ -16,8 +16,8 @@ module RuboCop
     # Diagnostic for Language Server Protocol of RuboCop.
     # @api private
     class Diagnostic
-      def initialize(document_encoding, offense, uri, cop_class)
-        @document_encoding = document_encoding
+      def initialize(position_encoding, offense, uri, cop_class)
+        @position_encoding = position_encoding
         @offense = offense
         @uri = uri
         @cop_class = cop_class
@@ -45,11 +45,11 @@ module RuboCop
           range: LanguageServer::Protocol::Interface::Range.new(
             start: LanguageServer::Protocol::Interface::Position.new(
               line: @offense.line - 1,
-              character: highlighted.begin_pos
+              character: to_position_character(highlighted.begin_pos)
             ),
             end: LanguageServer::Protocol::Interface::Position.new(
               line: @offense.line - 1,
-              character: highlighted.end_pos
+              character: to_position_character(highlighted.end_pos)
             )
           ),
           data: {
@@ -79,7 +79,7 @@ module RuboCop
         LanguageServer::Protocol::Interface::CodeDescription.new(href: doc_url)
       end
 
-      # rubocop:disable Layout/LineLength, Metrics/MethodLength
+      # rubocop:disable Metrics/MethodLength
       def autocorrect_action
         LanguageServer::Protocol::Interface::CodeAction.new(
           title: "Autocorrect #{@offense.cop_name}",
@@ -98,7 +98,7 @@ module RuboCop
           is_preferred: true
         )
       end
-      # rubocop:enable Layout/LineLength, Metrics/MethodLength
+      # rubocop:enable Metrics/MethodLength
 
       # rubocop:disable Metrics/MethodLength
       def offense_replacements
@@ -107,11 +107,11 @@ module RuboCop
             range: LanguageServer::Protocol::Interface::Range.new(
               start: LanguageServer::Protocol::Interface::Position.new(
                 line: range.line - 1,
-                character: range.column
+                character: to_position_character(range.column)
               ),
               end: LanguageServer::Protocol::Interface::Position.new(
                 line: range.last_line - 1,
-                character: range.last_column
+                character: to_position_character(range.last_column)
               )
             ),
             new_text: replacement
@@ -120,7 +120,7 @@ module RuboCop
       end
       # rubocop:enable Metrics/MethodLength
 
-      # rubocop:disable Layout/LineLength, Metrics/MethodLength
+      # rubocop:disable Metrics/MethodLength
       def disable_line_action
         LanguageServer::Protocol::Interface::CodeAction.new(
           title: "Disable #{@offense.cop_name} for this line",
@@ -138,7 +138,7 @@ module RuboCop
           )
         )
       end
-      # rubocop:enable Layout/LineLength, Metrics/MethodLength
+      # rubocop:enable Metrics/MethodLength
 
       def line_disable_comment
         new_text = if @offense.source_line.include?(' # rubocop:disable ')
@@ -149,7 +149,7 @@ module RuboCop
 
         eol = LanguageServer::Protocol::Interface::Position.new(
           line: @offense.line - 1,
-          character: length_of_line(@offense.source_line)
+          character: to_position_character
         )
 
         # TODO: fails for multiline strings - may be preferable to use block
@@ -162,19 +162,6 @@ module RuboCop
         [inline_comment]
       end
 
-      def length_of_line(line)
-        if @document_encoding == Encoding::UTF_16LE
-          line_length = 0
-          line.codepoints.each do |codepoint|
-            line_length += 1
-            line_length += 1 if codepoint > RubyLsp::Document::Scanner::SURROGATE_PAIR_START
-          end
-          line_length
-        else
-          line.length
-        end
-      end
-
       def correctable?
         !@offense.corrector.nil?
       end
@@ -184,6 +171,20 @@ module RuboCop
         uri.scheme = 'file' if uri.scheme.nil?
         uri
       end
+
+      def to_position_character(utf8_index = nil)
+        str = utf8_index ? @offense.source_line[0, utf8_index] : @offense.source_line
+        case @position_encoding
+        when 'utf-8', Encoding::UTF_8
+          str.bytesize
+        when 'utf-32', Encoding::UTF_32
+          str.size
+        else # 'utf-16'
+          # utf-16 is default position encoding on LSP
+          # https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/
+          str.size + str.count("\u{10000}-\u{10FFFF}")
+        end
+      end
     end
   end
 end

data/lib/rubocop/lsp/routes.rb

@@ -15,7 +15,7 @@ module RuboCop
   module LSP
     # Routes for Language Server Protocol of RuboCop.
     # @api private
-    class Routes
+    class Routes # rubocop:disable Metrics/ClassLength
       CONFIGURATION_FILE_PATTERNS = [
         RuboCop::ConfigFinder::DOTFILE,
         RuboCop::CLI::Command::AutoGenerateConfig::AUTO_GENERATED_FILE
@@ -42,6 +42,7 @@ module RuboCop
 
       handle 'initialize' do |request|
         initialization_options = extract_initialization_options_from(request)
+        @position_encoding = initialization_options[:position_encoding]
 
         @server.configure(initialization_options)
 
@@ -51,9 +52,10 @@ module RuboCop
             capabilities: LanguageServer::Protocol::Interface::ServerCapabilities.new(
               document_formatting_provider: true,
               text_document_sync: LanguageServer::Protocol::Interface::TextDocumentSyncOptions.new(
-                change: LanguageServer::Protocol::Constant::TextDocumentSyncKind::FULL,
+                change: LanguageServer::Protocol::Constant::TextDocumentSyncKind::INCREMENTAL,
                 open_close: true
-              )
+              ),
+              position_encoding: @position_encoding
             )
           )
         )
@@ -76,7 +78,12 @@ module RuboCop
 
       handle 'textDocument/didChange' do |request|
         params = request[:params]
-        result = diagnostic(params[:textDocument][:uri], params[:contentChanges][0][:text])
+        file_uri = params[:textDocument][:uri]
+        text = @text_cache[file_uri]
+        params[:contentChanges].each do |content|
+          text = change_text(text, content[:text], content[:range])
+        end
+        result = diagnostic(file_uri, text)
         @server.write(result)
       end
 
@@ -179,14 +186,26 @@ module RuboCop
 
       def extract_initialization_options_from(request)
         safe_autocorrect = request.dig(:params, :initializationOptions, :safeAutocorrect)
+        position_encodings = request.dig(:params, :capabilities, :general, :positionEncodings)
 
         {
           safe_autocorrect: safe_autocorrect.nil? || safe_autocorrect == true,
           lint_mode: request.dig(:params, :initializationOptions, :lintMode) == true,
-          layout_mode: request.dig(:params, :initializationOptions, :layoutMode) == true
+          layout_mode: request.dig(:params, :initializationOptions, :layoutMode) == true,
+          position_encoding: position_encoding(position_encodings)
         }
       end
 
+      def position_encoding(position_encodings)
+        if position_encodings&.include?('utf-8')
+          'utf-8'
+        elsif position_encodings&.include?('utf-32')
+          'utf-32'
+        else
+          'utf-16'
+        end
+      end
+
       def format_file(file_uri, command: nil)
         unless (text = @text_cache[file_uri])
           Logger.log("Format request arrived before text synchronized; skipping: `#{file_uri}'")
@@ -194,7 +213,7 @@ module RuboCop
           return []
         end
 
-        new_text = @server.format(remove_file_protocol_from(file_uri), text, command: command)
+        new_text = @server.format(convert_file_uri_to_path(file_uri), text, command: command)
 
         return [] if new_text == text
 
@@ -214,13 +233,50 @@ module RuboCop
           method: 'textDocument/publishDiagnostics',
           params: {
             uri: file_uri,
-            diagnostics: @server.offenses(remove_file_protocol_from(file_uri), text)
+            diagnostics: @server.offenses(convert_file_uri_to_path(file_uri),
+                                          text, @position_encoding)
           }
         }
       end
 
-      def remove_file_protocol_from(uri)
-        uri.delete_prefix('file://')
+      def change_text(orig_text, text, range)
+        return text unless range
+
+        start_pos = text_pos(orig_text, range[:start])
+        end_pos = text_pos(orig_text, range[:end])
+        orig_text[start_pos...end_pos] = text
+        orig_text
+      end
+
+      def text_pos(text, range)
+        line = range[:line]
+        char = range[:character]
+        pos = 0
+        text.each_line.with_index do |l, i|
+          if i == line
+            pos += line_pos(l, char)
+            return pos
+          end
+          pos += l.size
+        end
+        pos
+      end
+
+      def line_pos(line, char)
+        case @position_encoding
+        when 'utf-8'
+          line.byteslice(0, char).size
+        when 'utf-32'
+          char
+        else # 'utf-16'
+          # utf-16 is default position encoding on LSP
+          # https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/
+          line.encode('utf-16be').byteslice(0, char * 2).size
+        end
+      end
+
+      def convert_file_uri_to_path(uri)
+        URI.decode_www_form_component(uri.delete_prefix('file://'))
       end
     end
   end

data/lib/rubocop/lsp/runtime.rb

@@ -30,7 +30,7 @@ module RuboCop
         @layout_mode = false
       end
 
-      def format(path, text, command:)
+      def format(path, text, command:, prism_result: nil)
         safe_autocorrect = if command
                              command == 'rubocop.formatAutocorrects'
                            else
@@ -40,18 +40,18 @@ module RuboCop
         formatting_options = { autocorrect: true, safe_autocorrect: safe_autocorrect }
         formatting_options[:only] = config_only_options if @lint_mode || @layout_mode
 
-        @runner.run(path, text, formatting_options)
+        @runner.run(path, text, formatting_options, prism_result: prism_result)
         @runner.formatted_source
       end
 
-      def offenses(path, text, document_encoding = nil)
+      def offenses(path, text, position_encoding, prism_result: nil)
         diagnostic_options = {}
         diagnostic_options[:only] = config_only_options if @lint_mode || @layout_mode
 
-        @runner.run(path, text, diagnostic_options)
+        @runner.run(path, text, diagnostic_options, prism_result: prism_result)
         @runner.offenses.map do |offense|
           Diagnostic.new(
-            document_encoding, offense, path, @cop_registry[offense.cop_name]&.first
+            position_encoding, offense, path, @cop_registry[offense.cop_name]&.first
           ).to_lsp_diagnostic(@runner.config_for_working_directory)
         end
       end

data/lib/rubocop/lsp/server.rb

@@ -51,8 +51,8 @@ module RuboCop
         @runtime.format(path, text, command: command)
       end
 
-      def offenses(path, text)
-        @runtime.offenses(path, text)
+      def offenses(path, text, position_encoding)
+        @runtime.offenses(path, text, position_encoding)
       end
 
       def configure(options)

data/lib/rubocop/lsp/stdin_runner.rb

@@ -40,11 +40,12 @@ module RuboCop
         super(@options, config_store)
       end
 
-      # rubocop:disable Metrics/MethodLength
-      def run(path, contents, options)
+      def run(path, contents, options, prism_result: nil)
         @options = options.merge(DEFAULT_RUBOCOP_OPTIONS)
         @options[:stdin] = contents
 
+        @prism_result = prism_result
+
         @offenses = []
         @warnings = []
         @errors = []
@@ -52,22 +53,7 @@ module RuboCop
         super([path])
 
         raise Interrupt if aborting?
-      rescue RuboCop::Runner::InfiniteCorrectionLoop => e
-        if defined?(::RubyLsp::Requests::Formatting::Error)
-          raise ::RubyLsp::Requests::Formatting::Error, e.message
-        end
-
-        raise e
-      rescue RuboCop::ValidationError => e
-        raise ConfigurationError, e.message
-      rescue StandardError => e
-        if defined?(::RubyLsp::Requests::Formatting::Error)
-          raise ::RubyLsp::Requests::Support::InternalRuboCopError, e
-        end
-
-        raise e
       end
-      # rubocop:enable Metrics/MethodLength
 
       def formatted_source
         @options[:stdin]

data/lib/rubocop/magic_comment.rb

@@ -193,6 +193,10 @@ module RuboCop
       SEPARATOR = ';'
       OPERATOR  = ':'
 
+      def new_frozen_string_literal(value)
+        "# -*- frozen_string_literal: #{value} -*-"
+      end
+
       private
 
       def extract_frozen_string_literal
@@ -275,6 +279,10 @@ module RuboCop
         end
       end
 
+      def new_frozen_string_literal(value)
+        "# frozen_string_literal: #{value}"
+      end
+
       private
 
       # Extract `frozen_string_literal`.

data/lib/rubocop/pending_cops_reporter.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module RuboCop
+  # Reports information about pending cops that are not explicitly configured.
+  #
+  # This class is responsible for displaying warnings when new cops have been added to RuboCop
+  # but have not yet been enabled or disabled in the user's configuration.
+  # It provides a centralized way to determine whether such warnings should be shown,
+  # based on global flags or configuration settings.
+  class PendingCopsReporter
+    class << self
+      PENDING_BANNER = <<~BANNER
+        The following cops were added to RuboCop, but are not configured. Please set Enabled to either `true` or `false` in your `.rubocop.yml` file.
+
+        Please also note that you can opt-in to new cops by default by adding this to your config:
+          AllCops:
+            NewCops: enable
+      BANNER
+
+      attr_accessor :disable_pending_cops, :enable_pending_cops
+
+      def warn_if_needed(config)
+        return if possible_new_cops?(config)
+
+        pending_cops = pending_cops_only_qualified(config.pending_cops)
+        warn_on_pending_cops(pending_cops) unless pending_cops.empty?
+      end
+
+      private
+
+      def pending_cops_only_qualified(pending_cops)
+        pending_cops.select { |cop| Cop::Registry.qualified_cop?(cop.name) }
+      end
+
+      def possible_new_cops?(config)
+        disable_pending_cops || enable_pending_cops ||
+          config.disabled_new_cops? || config.enabled_new_cops?
+      end
+
+      def warn_on_pending_cops(pending_cops)
+        warn Rainbow(PENDING_BANNER).yellow
+
+        pending_cops.each { |cop| warn_pending_cop cop }
+
+        warn Rainbow('For more information: https://docs.rubocop.org/rubocop/versioning.html').yellow
+      end
+
+      def warn_pending_cop(cop)
+        version = cop.metadata['VersionAdded'] || 'N/A'
+
+        warn Rainbow("#{cop.name}: # new in #{version}").yellow
+        warn Rainbow('  Enabled: true').yellow
+      end
+    end
+  end
+end

data/lib/rubocop/plugin/configuration_integrator.rb

@@ -57,6 +57,8 @@ module RuboCop
                 all_cop_keys_configured_by_plugins
               )
 
+              plugin_config.make_excludes_absolute
+
               ConfigLoader.merge_with_default(plugin_config, plugin_config_path)
             end
           end

data/lib/rubocop/plugin/load_error.rb

@@ -15,7 +15,7 @@ module RuboCop
         <<~MESSAGE
           Failed to load plugin `#{@plugin_name}` because the corresponding plugin class could not be determined for instantiation.
           Try upgrading it first (e.g., `bundle update #{@plugin_name}`).
-          If `#{@plugin_name}` is not yet a plugin, use `require: #{@plugin_name}` instead of `plugins: `#{@plugin_name}` in your configuration.
+          If `#{@plugin_name}` is not yet a plugin, use `require: #{@plugin_name}` instead of `plugins: #{@plugin_name}` in your configuration.
 
           For further assistance, check with the developer regarding the following points:
           https://docs.rubocop.org/rubocop/plugin_migration_guide.html

data/lib/rubocop/plugin.rb

@@ -22,9 +22,16 @@ module RuboCop
       def plugin_capable?(feature_name)
         return true if BUILTIN_INTERNAL_PLUGINS.key?(feature_name)
         return true if feature_name == OBSOLETE_INTERNAL_AFFAIRS_PLUGIN_NAME
-        return false unless (gem = Gem.loaded_specs[feature_name])
 
-        !!gem.metadata['default_lint_roller_plugin']
+        begin
+          # When not using Bundler. Makes the spec available but does not require it.
+          gem feature_name
+        rescue Gem::LoadError
+          # The user requested a gem that they do not have installed
+        end
+        return false unless (spec = Gem.loaded_specs[feature_name])
+
+        !!spec.metadata['default_lint_roller_plugin']
       end
 
       def integrate_plugins(rubocop_config, plugins)

data/lib/rubocop/result_cache.rb

@@ -9,7 +9,7 @@ module RuboCop
   # Provides functionality for caching RuboCop runs.
   # @api private
   class ResultCache
-    NON_CHANGING = %i[color format formatters out debug fail_level
+    NON_CHANGING = %i[color format formatters out debug display_time fail_level
                       fix_layout autocorrect safe_autocorrect autocorrect_all
                       cache fail_fast stdin parallel].freeze
 
@@ -198,20 +198,22 @@ module RuboCop
     end
 
     def rubocop_extra_features
-      lib_root = File.join(File.dirname(__FILE__), '..')
-      exe_root = File.join(lib_root, '..', 'exe')
+      @rubocop_extra_features ||= begin
+        lib_root = File.join(File.dirname(__FILE__), '..')
+        exe_root = File.join(lib_root, '..', 'exe')
 
-      # Make sure to use an absolute path to prevent errors on Windows
-      # when traversing the relative paths with symlinks.
-      exe_root = File.absolute_path(exe_root)
+        # Make sure to use an absolute path to prevent errors on Windows
+        # 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
-      source_files -= ResultCache.rubocop_required_features # Rely on gem versions
+        # 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
+        source_files
+      end
     end
 
     # Return a hash of the options given at invocation, minus the ones that have

data/lib/rubocop/rspec/cop_helper.rb

@@ -10,10 +10,15 @@ module CopHelper
     # The minimum version Prism can parse is 3.3.
     ENV['PARSER_ENGINE'] == 'parser_prism' ? 3.3 : RuboCop::TargetRuby::DEFAULT_VERSION
   end
-  let(:parser_engine) { ENV.fetch('PARSER_ENGINE', :parser_whitequark).to_sym }
+  let(:parser_engine) do
+    # The maximum version Parser can correctly parse is 3.3.
+    ruby_version >= 3.4 ? :parser_prism : ENV.fetch('PARSER_ENGINE', :parser_whitequark).to_sym
+  end
   let(:rails_version) { false }
 
   before(:all) do
+    next if ENV['RUBOCOP_CORE_DEVELOPMENT']
+
     plugins = Gem.loaded_specs.filter_map do |feature_name, feature_specification|
       feature_name if feature_specification.metadata['default_lint_roller_plugin']
     end

data/lib/rubocop/rspec/expect_offense.rb

@@ -72,9 +72,15 @@ module RuboCop
     #
     #   expect_no_corrections
     #
-    # If your code has variables of different lengths, you can use `%{foo}`,
-    # `^{foo}`, and `_{foo}` to format your template; you can also abbreviate
-    # offense messages with `[...]`:
+    # If your code has variables of different lengths, you can use the
+    # following markers to format your template by passing the variables as a
+    # keyword arguments:
+    #
+    # - `%{foo}`: Interpolates `foo`
+    # - `^{foo}`: Inserts `'^' * foo.size` for dynamic offense range length
+    # - `_{foo}`: Inserts `' ' * foo.size` for dynamic offense range indentation
+    #
+    # You can also abbreviate offense messages with `[...]`.
     #
     #   %w[raise fail].each do |keyword|
     #     expect_offense(<<~RUBY, keyword: keyword)

data/lib/rubocop/rspec/shared_contexts.rb

@@ -80,6 +80,21 @@ RSpec.shared_context 'maintain registry' do
   end
 end
 
+RSpec.shared_context 'maintain default configuration' do
+  around(:each) do |example|
+    # Make a copy of the current configuration that will not change when source hash changes
+    default_configuration = RuboCop::ConfigLoader.default_configuration
+    config = RuboCop::Config.create(
+      default_configuration.to_h.clone,
+      default_configuration.loaded_path
+    )
+
+    example.run
+
+    RuboCop::ConfigLoader.instance_variable_set(:@default_configuration, config)
+  end
+end
+
 # This context assumes nothing and defines `cop`, among others.
 RSpec.shared_context 'config' do # rubocop:disable Metrics/BlockLength
   ### Meant to be overridden at will
@@ -163,6 +178,21 @@ RSpec.shared_context 'mock console output' do
   end
 end
 
+RSpec.shared_context 'mock obsoletion' do
+  include_context 'mock console output'
+
+  let(:obsoletion_configuration_path) { 'obsoletions.yml' }
+
+  before do
+    RuboCop::ConfigObsoletion.reset!
+    allow(RuboCop::ConfigObsoletion).to receive(:files).and_return([obsoletion_configuration_path])
+  end
+
+  after do
+    RuboCop::ConfigObsoletion.reset!
+  end
+end
+
 RSpec.shared_context 'lsp' do
   before do
     RuboCop::LSP.enable
@@ -235,3 +265,7 @@ end
 RSpec.shared_context 'ruby 3.4' do
   let(:ruby_version) { 3.4 }
 end
+
+RSpec.shared_context 'ruby 3.5' do
+  let(:ruby_version) { 3.5 }
+end

data/lib/rubocop/rspec/support.rb

@@ -15,6 +15,8 @@ RSpec.configure do |config|
   config.include_context 'isolated bundler', :isolated_bundler
   config.include_context 'lsp', :lsp
   config.include_context 'maintain registry', :restore_registry
+  config.include_context 'maintain default configuration', :restore_configuration
+  config.include_context 'mock obsoletion', :mock_obsoletion
   config.include_context 'ruby 2.0', :ruby20
   config.include_context 'ruby 2.1', :ruby21
   config.include_context 'ruby 2.2', :ruby22
@@ -28,4 +30,5 @@ RSpec.configure do |config|
   config.include_context 'ruby 3.2', :ruby32
   config.include_context 'ruby 3.3', :ruby33
   config.include_context 'ruby 3.4', :ruby34
+  config.include_context 'ruby 3.5', :ruby35
 end

data/lib/rubocop/runner.rb

@@ -273,7 +273,8 @@ module RuboCop
     end
 
     def do_inspection_loop(file)
-      processed_source = get_processed_source(file)
+      # We can reuse the prism result since the source did not change yet.
+      processed_source = get_processed_source(file, @prism_result)
       # This variable is 2d array used to track corrected offenses after each
       # inspection iteration. This is used to output meaningful infinite loop
       # error message.
@@ -295,7 +296,8 @@ module RuboCop
         # loop if we find any.
         break unless updated_source_file
 
-        processed_source = get_processed_source(file)
+        # Autocorrect has happened, don't use the prism result since it is stale.
+        processed_source = get_processed_source(file, nil)
       end
 
       # Return summary of corrected offenses after all iterations
@@ -482,14 +484,18 @@ module RuboCop
     end
 
     # rubocop:disable Metrics/MethodLength
-    def get_processed_source(file)
+    def get_processed_source(file, prism_result)
       config = @config_store.for_file(file)
       ruby_version = config.target_ruby_version
       parser_engine = config.parser_engine
 
       processed_source = if @options[:stdin]
                            ProcessedSource.new(
-                             @options[:stdin], ruby_version, file, parser_engine: parser_engine
+                             @options[:stdin],
+                             ruby_version,
+                             file,
+                             parser_engine: parser_engine,
+                             prism_result: prism_result
                            )
                          else
                            begin