ruby-lsp 0.14.6 → 0.16.5

data/lib/ruby_lsp/requests/support/common.rb

@@ -86,13 +86,16 @@ module RubyLsp
           params(
             title: String,
             entries: T.any(T::Array[RubyIndexer::Entry], RubyIndexer::Entry),
+            max_entries: T.nilable(Integer),
           ).returns(T::Hash[Symbol, String])
         end
-        def categorized_markdown_from_index_entries(title, entries)
+        def categorized_markdown_from_index_entries(title, entries, max_entries = nil)
           markdown_title = "```ruby\n#{title}\n```"
           definitions = []
           content = +""
-          Array(entries).each do |entry|
+          entries = Array(entries)
+          entries_to_format = max_entries ? entries.take(max_entries) : entries
+          entries_to_format.each do |entry|
             loc = entry.location
 
             # We always handle locations as zero based. However, for file links in Markdown we need them to be one
@@ -108,9 +111,16 @@ module RubyLsp
             content << "\n\n#{entry.comments.join("\n")}" unless entry.comments.empty?
           end
 
+          additional_entries_text = if max_entries && entries.length > max_entries
+            additional = entries.length - max_entries
+            " | #{additional} other#{additional > 1 ? "s" : ""}"
+          else
+            ""
+          end
+
           {
             title: markdown_title,
-            links: "**Definitions**: #{definitions.join(" | ")}",
+            links: "**Definitions**: #{definitions.join(" | ")}#{additional_entries_text}",
             documentation: content,
           }
         end
@@ -119,10 +129,11 @@ module RubyLsp
           params(
             title: String,
             entries: T.any(T::Array[RubyIndexer::Entry], RubyIndexer::Entry),
+            max_entries: T.nilable(Integer),
           ).returns(String)
         end
-        def markdown_from_index_entries(title, entries)
-          categorized_markdown = categorized_markdown_from_index_entries(title, entries)
+        def markdown_from_index_entries(title, entries, max_entries = nil)
+          categorized_markdown = categorized_markdown_from_index_entries(title, entries, max_entries)
 
           <<~MARKDOWN.chomp
             #{categorized_markdown[:title]}

data/lib/ruby_lsp/requests/support/formatter.rb

@@ -0,0 +1,26 @@
+# typed: strict
+# frozen_string_literal: true
+
+module RubyLsp
+  module Requests
+    module Support
+      module Formatter
+        extend T::Sig
+        extend T::Helpers
+
+        interface!
+
+        sig { abstract.params(uri: URI::Generic, document: Document).returns(T.nilable(String)) }
+        def run_formatting(uri, document); end
+
+        sig do
+          abstract.params(
+            uri: URI::Generic,
+            document: Document,
+          ).returns(T.nilable(T::Array[Interface::Diagnostic]))
+        end
+        def run_diagnostic(uri, document); end
+      end
+    end
+  end
+end

data/lib/ruby_lsp/requests/support/rubocop_diagnostic.rb

@@ -163,7 +163,7 @@ module RubyLsp
 
         sig { params(line: String).returns(Integer) }
         def length_of_line(line)
-          if @document.encoding == Constant::PositionEncodingKind::UTF16
+          if @document.encoding == Encoding::UTF_16LE
             line_length = 0
             line.codepoints.each do |codepoint|
               line_length += 1

data/lib/ruby_lsp/requests/support/rubocop_formatter.rb

@@ -0,0 +1,47 @@
+# typed: strict
+# frozen_string_literal: true
+
+return unless defined?(RubyLsp::Requests::Support::RuboCopRunner)
+
+module RubyLsp
+  module Requests
+    module Support
+      class RuboCopFormatter
+        extend T::Sig
+        include Formatter
+
+        sig { void }
+        def initialize
+          @diagnostic_runner = T.let(RuboCopRunner.new, RuboCopRunner)
+          # -a is for "--auto-correct" (or "--autocorrect" on newer versions of RuboCop)
+          @format_runner = T.let(RuboCopRunner.new("-a"), RuboCopRunner)
+        end
+
+        sig { override.params(uri: URI::Generic, document: Document).returns(T.nilable(String)) }
+        def run_formatting(uri, document)
+          filename = T.must(uri.to_standardized_path || uri.opaque)
+
+          # Invoke RuboCop with just this file in `paths`
+          @format_runner.run(filename, document.source)
+          @format_runner.formatted_source
+        end
+
+        sig do
+          override.params(
+            uri: URI::Generic,
+            document: Document,
+          ).returns(T.nilable(T::Array[Interface::Diagnostic]))
+        end
+        def run_diagnostic(uri, document)
+          filename = T.must(uri.to_standardized_path || uri.opaque)
+          # Invoke RuboCop with just this file in `paths`
+          @diagnostic_runner.run(filename, document.source)
+
+          @diagnostic_runner.offenses.map do |offense|
+            Support::RuboCopDiagnostic.new(document, offense, uri).to_lsp_diagnostic
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ruby_lsp/requests/support/rubocop_runner.rb

@@ -92,6 +92,10 @@ module RubyLsp
           @options[:stdin] = contents
 
           super([path])
+
+          # RuboCop rescues interrupts and then sets the `@aborting` variable to true. We don't want them to be rescued,
+          # so here we re-raise in case RuboCop received an interrupt.
+          raise Interrupt if aborting?
         rescue RuboCop::Runner::InfiniteCorrectionLoop => error
           raise Formatting::Error, error.message
         rescue RuboCop::ValidationError => error

data/lib/ruby_lsp/requests/support/{syntax_tree_formatting_runner.rb → syntax_tree_formatter.rb}

@@ -8,16 +8,13 @@ rescue LoadError
   return
 end
 
-require "singleton"
-
 module RubyLsp
   module Requests
     module Support
       # :nodoc:
-      class SyntaxTreeFormattingRunner
+      class SyntaxTreeFormatter
         extend T::Sig
-        include Singleton
-        include Support::FormatterRunner
+        include Support::Formatter
 
         sig { void }
         def initialize
@@ -33,12 +30,22 @@ module RubyLsp
         end
 
         sig { override.params(uri: URI::Generic, document: Document).returns(T.nilable(String)) }
-        def run(uri, document)
+        def run_formatting(uri, document)
           path = uri.to_standardized_path
           return if path && @options.ignore_files.any? { |pattern| File.fnmatch?("*/#{pattern}", path) }
 
           SyntaxTree.format(document.source, @options.print_width, options: @options.formatter_options)
         end
+
+        sig do
+          override.params(
+            uri: URI::Generic,
+            document: Document,
+          ).returns(T.nilable(T::Array[Interface::Diagnostic]))
+        end
+        def run_diagnostic(uri, document)
+          nil
+        end
       end
     end
   end

data/lib/ruby_lsp/requests/workspace_symbol.rb

@@ -22,11 +22,12 @@ module RubyLsp
       extend T::Sig
       include Support::Common
 
-      sig { params(query: T.nilable(String), index: RubyIndexer::Index).void }
-      def initialize(query, index)
+      sig { params(global_state: GlobalState, query: T.nilable(String)).void }
+      def initialize(global_state, query)
         super()
+        @global_state = global_state
         @query = query
-        @index = index
+        @index = T.let(global_state.index, RubyIndexer::Index)
       end
 
       sig { override.returns(T::Array[Interface::WorkspaceSymbol]) }
@@ -35,7 +36,7 @@ module RubyLsp
           # If the project is using Sorbet, we let Sorbet handle symbols defined inside the project itself and RBIs, but
           # we still return entries defined in gems to allow developers to jump directly to the source
           file_path = entry.file_path
-          next if DependencyDetector.instance.typechecker && not_in_dependencies?(file_path)
+          next if @global_state.typechecker && not_in_dependencies?(file_path)
 
           # We should never show private symbols when searching the entire workspace
           next if entry.visibility == :private

data/lib/ruby_lsp/requests.rb

@@ -18,6 +18,7 @@ module RubyLsp
   # - [DocumentHighlight](rdoc-ref:RubyLsp::Requests::DocumentHighlight)
   # - [InlayHint](rdoc-ref:RubyLsp::Requests::InlayHints)
   # - [Completion](rdoc-ref:RubyLsp::Requests::Completion)
+  # - [CompletionResolve](rdoc-ref:RubyLsp::Requests::CompletionResolve)
   # - [CodeLens](rdoc-ref:RubyLsp::Requests::CodeLens)
   # - [Definition](rdoc-ref:RubyLsp::Requests::Definition)
   # - [ShowSyntaxTree](rdoc-ref:RubyLsp::Requests::ShowSyntaxTree)
@@ -40,6 +41,7 @@ module RubyLsp
     autoload :DocumentHighlight, "ruby_lsp/requests/document_highlight"
     autoload :InlayHints, "ruby_lsp/requests/inlay_hints"
     autoload :Completion, "ruby_lsp/requests/completion"
+    autoload :CompletionResolve, "ruby_lsp/requests/completion_resolve"
     autoload :CodeLens, "ruby_lsp/requests/code_lens"
     autoload :Definition, "ruby_lsp/requests/definition"
     autoload :ShowSyntaxTree, "ruby_lsp/requests/show_syntax_tree"
@@ -54,7 +56,7 @@ module RubyLsp
       autoload :Sorbet, "ruby_lsp/requests/support/sorbet"
       autoload :RailsDocumentClient, "ruby_lsp/requests/support/rails_document_client"
       autoload :Common, "ruby_lsp/requests/support/common"
-      autoload :FormatterRunner, "ruby_lsp/requests/support/formatter_runner"
+      autoload :Formatter, "ruby_lsp/requests/support/formatter"
     end
   end
 end

data/lib/ruby_lsp/response_builders/semantic_highlighting.rb

@@ -55,19 +55,21 @@ module RubyLsp
 
       ResponseType = type_member { { fixed: Interface::SemanticTokens } }
 
-      sig { void }
-      def initialize
-        super
+      sig { params(encoding: Encoding).void }
+      def initialize(encoding)
+        super()
+        @encoding = encoding
         @stack = T.let([], T::Array[SemanticToken])
       end
 
       sig { params(location: Prism::Location, type: Symbol, modifiers: T::Array[Symbol]).void }
       def add_token(location, type, modifiers = [])
-        length = location.end_offset - location.start_offset
+        length = location.end_code_units_offset(@encoding) - location.start_code_units_offset(@encoding)
         modifiers_indices = modifiers.filter_map { |modifier| TOKEN_MODIFIERS[modifier] }
         @stack.push(
           SemanticToken.new(
-            location: location,
+            start_line: location.start_line,
+            start_code_unit_column: location.start_code_units_column(@encoding),
             length: length,
             type: T.must(TOKEN_TYPES[type]),
             modifier: modifiers_indices,
@@ -75,6 +77,15 @@ module RubyLsp
         )
       end
 
+      sig { params(location: Prism::Location).returns(T::Boolean) }
+      def last_token_matches?(location)
+        token = @stack.last
+        return false unless token
+
+        token.start_line == location.start_line &&
+          token.start_code_unit_column == location.start_code_units_column(@encoding)
+      end
+
       sig { returns(T.nilable(SemanticToken)) }
       def last
         @stack.last
@@ -88,8 +99,11 @@ module RubyLsp
       class SemanticToken
         extend T::Sig
 
-        sig { returns(Prism::Location) }
-        attr_reader :location
+        sig { returns(Integer) }
+        attr_reader :start_line
+
+        sig { returns(Integer) }
+        attr_reader :start_code_unit_column
 
         sig { returns(Integer) }
         attr_reader :length
@@ -100,9 +114,18 @@ module RubyLsp
         sig { returns(T::Array[Integer]) }
         attr_reader :modifier
 
-        sig { params(location: Prism::Location, length: Integer, type: Integer, modifier: T::Array[Integer]).void }
-        def initialize(location:, length:, type:, modifier:)
-          @location = location
+        sig do
+          params(
+            start_line: Integer,
+            start_code_unit_column: Integer,
+            length: Integer,
+            type: Integer,
+            modifier: T::Array[Integer],
+          ).void
+        end
+        def initialize(start_line:, start_code_unit_column:, length:, type:, modifier:)
+          @start_line = start_line
+          @start_code_unit_column = start_code_unit_column
           @length = length
           @type = type
           @modifier = modifier
@@ -146,7 +169,7 @@ module RubyLsp
             # Enumerable#sort_by is not deterministic when the compared values are equal.
             # When that happens, we need to use the index as a tie breaker to ensure
             # that the order of the tokens is always the same.
-            [token.location.start_line, token.location.start_column, index]
+            [token.start_line, token.start_code_unit_column, index]
           end
 
           delta = sorted_tokens.flat_map do |token|
@@ -167,8 +190,8 @@ module RubyLsp
         # https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocument_semanticTokens
         sig { params(token: SemanticToken).returns(T::Array[Integer]) }
         def compute_delta(token)
-          row = token.location.start_line - 1
-          column = token.location.start_column
+          row = token.start_line - 1
+          column = token.start_code_unit_column
 
           begin
             delta_line = row - @current_row