ruby-lsp 0.17.3 → 0.17.5

data/lib/ruby_lsp/requests/completion_resolve.rb

@@ -40,7 +40,8 @@ module RubyLsp
       def perform
         # Based on the spec https://microsoft.github.io/language-server-protocol/specification#textDocument_completion,
         # a completion resolve request must always return the original completion item without modifying ANY fields
-        # other than label details and documentation. If we modify anything, the completion behaviour might be broken.
+        # other than detail and documentation (NOT labelDetails). If we modify anything, the completion behaviour might
+        # be broken.
         #
         # For example, forgetting to return the `insertText` included in the original item will make the editor use the
         # `label` for the text edit instead
@@ -56,9 +57,11 @@ module RubyLsp
           end
         end
 
-        @item[:labelDetails] = Interface::CompletionItemLabelDetails.new(
-          description: entries.take(MAX_DOCUMENTATION_ENTRIES).map(&:file_name).join(","),
-        )
+        first_entry = T.must(entries.first)
+
+        if first_entry.is_a?(RubyIndexer::Entry::Member)
+          label = "#{label}#{first_entry.decorated_parameters}"
+        end
 
         @item[:documentation] = Interface::MarkupContent.new(
           kind: "markdown",

data/lib/ruby_lsp/requests/definition.rb

@@ -42,8 +42,8 @@ module RubyLsp
       def initialize(document, global_state, position, dispatcher, typechecker_enabled)
         super()
         @response_builder = T.let(
-          ResponseBuilders::CollectionResponseBuilder[Interface::Location].new,
-          ResponseBuilders::CollectionResponseBuilder[Interface::Location],
+          ResponseBuilders::CollectionResponseBuilder[T.any(Interface::Location, Interface::LocationLink)].new,
+          ResponseBuilders::CollectionResponseBuilder[T.any(Interface::Location, Interface::LocationLink)],
         )
         @dispatcher = dispatcher
 
@@ -90,6 +90,7 @@ module RubyLsp
           Listeners::Definition.new(
             @response_builder,
             global_state,
+            document.language_id,
             document.uri,
             node_context,
             dispatcher,
@@ -104,7 +105,7 @@ module RubyLsp
         @target = T.let(target, T.nilable(Prism::Node))
       end
 
-      sig { override.returns(T::Array[Interface::Location]) }
+      sig { override.returns(T::Array[T.any(Interface::Location, Interface::LocationLink)]) }
       def perform
         @dispatcher.dispatch_once(@target) if @target
         @response_builder.response

data/lib/ruby_lsp/requests/formatting.rb

@@ -40,6 +40,8 @@ module RubyLsp
         return unless @active_formatter
         return if @document.syntax_error?
 
+        # We don't format erb documents yet
+
         formatted_text = @active_formatter.run_formatting(@uri, @document)
         return unless formatted_text
 

data/lib/ruby_lsp/requests/prepare_type_hierarchy.rb

@@ -0,0 +1,88 @@
+# typed: strict
+# frozen_string_literal: true
+
+module RubyLsp
+  module Requests
+    # ![Prepare type hierarchy demo](../../prepare_type_hierarchy.gif)
+    #
+    # The [prepare type hierarchy
+    # request](https://microsoft.github.io/language-server-protocol/specification#textDocument_prepareTypeHierarchy)
+    # displays the list of ancestors (supertypes) and descendants (subtypes) for the selected type.
+    #
+    # Currently only supports supertypes due to a limitation of the index.
+    #
+    # # Example
+    #
+    # ```ruby
+    # class Foo; end
+    # class Bar < Foo; end
+    #
+    # puts Bar # <-- right click on `Bar` and select "Show Type Hierarchy"
+    # ```
+    class PrepareTypeHierarchy < Request
+      extend T::Sig
+
+      include Support::Common
+
+      class << self
+        extend T::Sig
+
+        sig { returns(Interface::TypeHierarchyOptions) }
+        def provider
+          Interface::TypeHierarchyOptions.new
+        end
+      end
+
+      sig do
+        params(
+          document: Document,
+          index: RubyIndexer::Index,
+          position: T::Hash[Symbol, T.untyped],
+        ).void
+      end
+      def initialize(document, index, position)
+        super()
+
+        @document = document
+        @index = index
+        @position = position
+      end
+
+      sig { override.returns(T.nilable(T::Array[Interface::TypeHierarchyItem])) }
+      def perform
+        context = @document.locate_node(
+          @position,
+          node_types: [
+            Prism::ConstantReadNode,
+            Prism::ConstantWriteNode,
+            Prism::ConstantPathNode,
+          ],
+        )
+
+        node = context.node
+        parent = context.parent
+        return unless node && parent
+
+        target = determine_target(node, parent, @position)
+        entries = @index.resolve(target.slice, context.nesting)
+        return unless entries
+
+        # While the spec allows for multiple entries, VSCode seems to only support one
+        # We'll just return the first one for now
+        first_entry = T.must(entries.first)
+
+        range = range_from_location(first_entry.location)
+
+        [
+          Interface::TypeHierarchyItem.new(
+            name: first_entry.name,
+            kind: kind_for_entry(first_entry),
+            uri: URI::Generic.from_path(path: first_entry.file_path).to_s,
+            range: range,
+            selection_range: range,
+          ),
+        ]
+      end
+    end
+  end
+end

data/lib/ruby_lsp/requests/selection_ranges.rb

@@ -34,7 +34,7 @@ module RubyLsp
       sig { override.returns(T.all(T::Array[Support::SelectionRange], Object)) }
       def perform
         # [node, parent]
-        queue = [[@document.tree, nil]]
+        queue = [[@document.parse_result.value, nil]]
 
         until queue.empty?
           node, parent = queue.shift

data/lib/ruby_lsp/requests/show_syntax_tree.rb

@@ -25,6 +25,7 @@ module RubyLsp
         super()
         @document = document
         @range = range
+        @tree = T.let(document.parse_result.value, Prism::ProgramNode)
       end
 
       sig { override.returns(String) }
@@ -32,7 +33,7 @@ module RubyLsp
         return ast_for_range if @range
 
         output_string = +""
-        PP.pp(@document.tree, output_string)
+        PP.pp(@tree, output_string)
         output_string
       end
 
@@ -46,7 +47,7 @@ module RubyLsp
         start_char = scanner.find_char_position(range[:start])
         end_char = scanner.find_char_position(range[:end])
 
-        queue = @document.tree.statements.body.dup
+        queue = @tree.statements.body.dup
         found_nodes = []
 
         until queue.empty?

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

@@ -26,7 +26,7 @@ module RubyLsp
           )
         end
 
-        sig { params(location: Prism::Location).returns(Interface::Range) }
+        sig { params(location: T.any(Prism::Location, RubyIndexer::Location)).returns(Interface::Range) }
         def range_from_location(location)
           Interface::Range.new(
             start: Interface::Position.new(
@@ -186,6 +186,24 @@ module RubyLsp
             current = current.parent
           end
         end
+
+        sig { params(entry: RubyIndexer::Entry).returns(T.nilable(Integer)) }
+        def kind_for_entry(entry)
+          case entry
+          when RubyIndexer::Entry::Class
+            Constant::SymbolKind::CLASS
+          when RubyIndexer::Entry::Module
+            Constant::SymbolKind::NAMESPACE
+          when RubyIndexer::Entry::Constant
+            Constant::SymbolKind::CONSTANT
+          when RubyIndexer::Entry::Method
+            entry.name == "initialize" ? Constant::SymbolKind::CONSTRUCTOR : Constant::SymbolKind::METHOD
+          when RubyIndexer::Entry::Accessor
+            Constant::SymbolKind::PROPERTY
+          when RubyIndexer::Entry::InstanceVariable
+            Constant::SymbolKind::FIELD
+          end
+        end
       end
     end
   end

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

@@ -42,7 +42,7 @@ module RubyLsp
         def to_lsp_code_actions
           code_actions = []
 
-          code_actions << autocorrect_action if @offense.correctable?
+          code_actions << autocorrect_action if correctable?
           code_actions << disable_line_action
 
           code_actions
@@ -70,7 +70,7 @@ module RubyLsp
               ),
             ),
             data: {
-              correctable: @offense.correctable?,
+              correctable: correctable?,
               code_actions: to_lsp_code_actions,
             },
           )
@@ -81,7 +81,7 @@ module RubyLsp
         sig { returns(String) }
         def message
           message  = @offense.message
-          message += "\n\nThis offense is not auto-correctable.\n" unless @offense.correctable?
+          message += "\n\nThis offense is not auto-correctable.\n" unless correctable?
           message
         end
 
@@ -115,7 +115,7 @@ module RubyLsp
                     uri: @uri.to_s,
                     version: nil,
                   ),
-                  edits: @offense.correctable? ? offense_replacements : [],
+                  edits: correctable? ? offense_replacements : [],
                 ),
               ],
             ),
@@ -193,6 +193,14 @@ module RubyLsp
             line.length
           end
         end
+
+        # When `RuboCop::LSP.enable` is called, contextual autocorrect will not offer itself
+        # as `correctable?` to prevent annoying changes while typing. Instead check if
+        # a corrector is present. If it is, then that means some code transformation can be applied.
+        sig { returns(T::Boolean) }
+        def correctable?
+          !@offense.corrector.nil?
+        end
       end
     end
   end

data/lib/ruby_lsp/requests/type_hierarchy_supertypes.rb

@@ -0,0 +1,87 @@
+# typed: strict
+# frozen_string_literal: true
+
+module RubyLsp
+  module Requests
+    # ![Type hierarchy supertypes demo](../../type_hierarchy_supertypes.gif)
+    #
+    # The [type hierarchy supertypes
+    # request](https://microsoft.github.io/language-server-protocol/specification#typeHierarchy_supertypes)
+    # displays the list of ancestors (supertypes) for the selected type.
+    #
+    # # Example
+    #
+    # ```ruby
+    # class Foo; end
+    # class Bar < Foo; end
+    #
+    # puts Bar # <-- right click on `Bar` and select "Show Type Hierarchy"
+    # ```
+    class TypeHierarchySupertypes < Request
+      extend T::Sig
+
+      include Support::Common
+
+      sig { params(index: RubyIndexer::Index, item: T::Hash[Symbol, T.untyped]).void }
+      def initialize(index, item)
+        super()
+
+        @index = index
+        @item = item
+      end
+
+      sig { override.returns(T.nilable(T::Array[Interface::TypeHierarchyItem])) }
+      def perform
+        name = @item[:name]
+        entries = @index[name]
+
+        parents = T.let(Set.new, T::Set[RubyIndexer::Entry::Namespace])
+        return unless entries&.any?
+
+        entries.each do |entry|
+          next unless entry.is_a?(RubyIndexer::Entry::Namespace)
+
+          if entry.is_a?(RubyIndexer::Entry::Class)
+            parent_class_name = entry.parent_class
+            if parent_class_name
+              resolved_parent_entries = @index.resolve(parent_class_name, entry.nesting)
+              resolved_parent_entries&.each do |entry|
+                next unless entry.is_a?(RubyIndexer::Entry::Class)
+
+                parents << entry
+              end
+            end
+          end
+
+          entry.mixin_operations.each do |mixin_operation|
+            mixin_name = mixin_operation.module_name
+            resolved_mixin_entries = @index.resolve(mixin_name, entry.nesting)
+            next unless resolved_mixin_entries
+
+            resolved_mixin_entries.each do |mixin_entry|
+              next unless mixin_entry.is_a?(RubyIndexer::Entry::Module)
+
+              parents << mixin_entry
+            end
+          end
+        end
+
+        parents.map { |entry| hierarchy_item(entry) }
+      end
+
+      private
+
+      sig { params(entry: RubyIndexer::Entry).returns(Interface::TypeHierarchyItem) }
+      def hierarchy_item(entry)
+        Interface::TypeHierarchyItem.new(
+          name: entry.name,
+          kind: kind_for_entry(entry),
+          uri: URI::Generic.from_path(path: entry.file_path).to_s,
+          range: range_from_location(entry.location),
+          selection_range: range_from_location(entry.name_location),
+          detail: entry.file_name,
+        )
+      end
+    end
+  end
+end

data/lib/ruby_lsp/requests/workspace_symbol.rb

@@ -52,7 +52,7 @@ module RubyLsp
 
           Interface::WorkspaceSymbol.new(
             name: entry.name,
-            container_name: T.must(container).join("::"),
+            container_name: container.join("::"),
             kind: kind,
             location: Interface::Location.new(
               uri: URI::Generic.from_path(path: file_path).to_s,
@@ -64,26 +64,6 @@ module RubyLsp
           )
         end
       end
-
-      private
-
-      sig { params(entry: RubyIndexer::Entry).returns(T.nilable(Integer)) }
-      def kind_for_entry(entry)
-        case entry
-        when RubyIndexer::Entry::Class
-          Constant::SymbolKind::CLASS
-        when RubyIndexer::Entry::Module
-          Constant::SymbolKind::NAMESPACE
-        when RubyIndexer::Entry::Constant
-          Constant::SymbolKind::CONSTANT
-        when RubyIndexer::Entry::Method
-          entry.name == "initialize" ? Constant::SymbolKind::CONSTRUCTOR : Constant::SymbolKind::METHOD
-        when RubyIndexer::Entry::Accessor
-          Constant::SymbolKind::PROPERTY
-        when RubyIndexer::Entry::InstanceVariable
-          Constant::SymbolKind::FIELD
-        end
-      end
     end
   end
 end

data/lib/ruby_lsp/requests.rb

@@ -47,6 +47,8 @@ module RubyLsp
     autoload :ShowSyntaxTree, "ruby_lsp/requests/show_syntax_tree"
     autoload :WorkspaceSymbol, "ruby_lsp/requests/workspace_symbol"
     autoload :SignatureHelp, "ruby_lsp/requests/signature_help"
+    autoload :PrepareTypeHierarchy, "ruby_lsp/requests/prepare_type_hierarchy"
+    autoload :TypeHierarchySupertypes, "ruby_lsp/requests/type_hierarchy_supertypes"
 
     # :nodoc:
     module Support

data/lib/ruby_lsp/ruby_document.rb

@@ -10,5 +10,15 @@ module RubyLsp
       @needs_parsing = false
       @parse_result = Prism.parse(@source)
     end
+
+    sig { override.returns(T::Boolean) }
+    def syntax_error?
+      @parse_result.failure?
+    end
+
+    sig { override.returns(LanguageId) }
+    def language_id
+      LanguageId::Ruby
+    end
   end
 end