ruby-lsp 0.26.8 → 0.27.0.beta1

data/lib/ruby_lsp/listeners/hover.rb

@@ -48,6 +48,7 @@ module RubyLsp
         @response_builder = response_builder
         @global_state = global_state
         @index = global_state.index #: RubyIndexer::Index
+        @graph = global_state.graph #: Rubydex::Graph
         @type_inferrer = global_state.type_inferrer #: TypeInferrer
         @path = uri.to_standardized_path #: String?
         @node_context = node_context
@@ -178,32 +179,32 @@ module RubyLsp
 
       #: (Prism::InstanceVariableReadNode node) -> void
       def on_instance_variable_read_node_enter(node)
-        handle_instance_variable_hover(node.name.to_s)
+        handle_variable_hover(node.name.to_s)
       end
 
       #: (Prism::InstanceVariableWriteNode node) -> void
       def on_instance_variable_write_node_enter(node)
-        handle_instance_variable_hover(node.name.to_s)
+        handle_variable_hover(node.name.to_s)
       end
 
       #: (Prism::InstanceVariableAndWriteNode node) -> void
       def on_instance_variable_and_write_node_enter(node)
-        handle_instance_variable_hover(node.name.to_s)
+        handle_variable_hover(node.name.to_s)
       end
 
       #: (Prism::InstanceVariableOperatorWriteNode node) -> void
       def on_instance_variable_operator_write_node_enter(node)
-        handle_instance_variable_hover(node.name.to_s)
+        handle_variable_hover(node.name.to_s)
       end
 
       #: (Prism::InstanceVariableOrWriteNode node) -> void
       def on_instance_variable_or_write_node_enter(node)
-        handle_instance_variable_hover(node.name.to_s)
+        handle_variable_hover(node.name.to_s)
       end
 
       #: (Prism::InstanceVariableTargetNode node) -> void
       def on_instance_variable_target_node_enter(node)
-        handle_instance_variable_hover(node.name.to_s)
+        handle_variable_hover(node.name.to_s)
       end
 
       #: (Prism::SuperNode node) -> void
@@ -223,32 +224,32 @@ module RubyLsp
 
       #: (Prism::ClassVariableAndWriteNode node) -> void
       def on_class_variable_and_write_node_enter(node)
-        handle_class_variable_hover(node.name.to_s)
+        handle_variable_hover(node.name.to_s)
       end
 
       #: (Prism::ClassVariableOperatorWriteNode node) -> void
       def on_class_variable_operator_write_node_enter(node)
-        handle_class_variable_hover(node.name.to_s)
+        handle_variable_hover(node.name.to_s)
       end
 
       #: (Prism::ClassVariableOrWriteNode node) -> void
       def on_class_variable_or_write_node_enter(node)
-        handle_class_variable_hover(node.name.to_s)
+        handle_variable_hover(node.name.to_s)
       end
 
       #: (Prism::ClassVariableTargetNode node) -> void
       def on_class_variable_target_node_enter(node)
-        handle_class_variable_hover(node.name.to_s)
+        handle_variable_hover(node.name.to_s)
       end
 
       #: (Prism::ClassVariableReadNode node) -> void
       def on_class_variable_read_node_enter(node)
-        handle_class_variable_hover(node.name.to_s)
+        handle_variable_hover(node.name.to_s)
       end
 
       #: (Prism::ClassVariableWriteNode node) -> void
       def on_class_variable_write_node_enter(node)
-        handle_class_variable_hover(node.name.to_s)
+        handle_variable_hover(node.name.to_s)
       end
 
       private
@@ -324,62 +325,46 @@ module RubyLsp
         end
       end
 
-      #: (String name) -> void
-      def handle_instance_variable_hover(name)
-        # Sorbet enforces that all instance variables be declared on typed strict or higher, which means it will be able
-        # to provide all features for them
-        return if @sorbet_level.strict?
-
-        type = @type_inferrer.infer_receiver_type(@node_context)
-        return unless type
-
-        entries = @index.resolve_instance_variable(name, type.name)
-        return unless entries
-
-        categorized_markdown_from_index_entries(name, entries).each do |category, content|
-          @response_builder.push(content, category: category)
-        end
-      rescue RubyIndexer::Index::NonExistingNamespaceError
-        # If by any chance we haven't indexed the owner, then there's no way to find the right declaration
-      end
-
       #: (String name) -> void
       def handle_global_variable_hover(name)
-        entries = @index[name]
-        return unless entries
+        declaration = @graph[name]
+        return unless declaration
 
-        categorized_markdown_from_index_entries(name, entries).each do |category, content|
+        categorized_markdown_from_definitions(name, declaration.definitions).each do |category, content|
           @response_builder.push(content, category: category)
         end
       end
 
+      # Handle class or instance variables. We collect all definitions across the ancestors of the type
+      #
       #: (String name) -> void
-      def handle_class_variable_hover(name)
+      def handle_variable_hover(name)
+        # Sorbet enforces that all variables be declared on typed strict or higher, which means it will be able to
+        # provide all features for them
+        return if @sorbet_level.strict?
+
         type = @type_inferrer.infer_receiver_type(@node_context)
         return unless type
 
-        entries = @index.resolve_class_variable(name, type.name)
-        return unless entries
+        owner = @graph[type.name]
+        return unless owner.is_a?(Rubydex::Namespace)
 
-        categorized_markdown_from_index_entries(name, entries).each do |category, content|
-          @response_builder.push(content, category: category)
+        owner.ancestors.each do |ancestor|
+          member = ancestor.member(name)
+          next unless member
+
+          categorized_markdown_from_definitions(member.name, member.definitions).each do |category, content|
+            @response_builder.push(content, category: category)
+          end
         end
-      rescue RubyIndexer::Index::NonExistingNamespaceError
-        # If by any chance we haven't indexed the owner, then there's no way to find the right declaration
       end
 
       #: (String name, Prism::Location location) -> void
       def generate_hover(name, location)
-        entries = @index.resolve(name, @node_context.nesting)
-        return unless entries
-
-        # We should only show hover for private constants if the constant is defined in the same namespace as the
-        # reference
-        first_entry = entries.first #: as !nil
-        full_name = first_entry.name
-        return if first_entry.private? && full_name != "#{@node_context.fully_qualified_name}::#{name}"
+        declaration = @graph.resolve_constant(name, @node_context.nesting)
+        return unless declaration
 
-        categorized_markdown_from_index_entries(full_name, entries).each do |category, content|
+        categorized_markdown_from_definitions(declaration.name, declaration.definitions).each do |category, content|
           @response_builder.push(content, category: category)
         end
       end

data/lib/ruby_lsp/listeners/semantic_highlighting.rb

@@ -162,7 +162,7 @@ module RubyLsp
 
       #: (Prism::SelfNode node) -> void
       def on_self_node_enter(node)
-        @response_builder.add_token(node.location, :variable, [:default_library])
+        @response_builder.add_token(node.location, :variable, [:defaultLibrary])
       end
 
       #: (Prism::LocalVariableWriteNode node) -> void

data/lib/ruby_lsp/listeners/test_style.rb

@@ -266,7 +266,7 @@ module RubyLsp
         # We only support regular Minitest tests. The declarative syntax provided by ActiveSupport is handled by the
         # Rails add-on
         name_parts = fully_qualified_name.split("::")
-        singleton_name = "#{name_parts.join("::")}::<Class:#{name_parts.last}>"
+        singleton_name = "#{name_parts.join("::")}::<#{name_parts.last}>"
         !@index.linearized_ancestors_of(singleton_name).include?("ActiveSupport::Testing::Declarative")
       rescue RubyIndexer::Index::NonExistingNamespaceError
         true

data/lib/ruby_lsp/node_context.rb

@@ -62,12 +62,12 @@ module RubyLsp
         when Prism::ClassNode, Prism::ModuleNode
           nesting << node.constant_path.slice
         when Prism::SingletonClassNode
-          nesting << "<Class:#{nesting.flat_map { |n| n.split("::") }.last}>"
+          nesting << "<#{nesting.flat_map { |n| n.split("::") }.last}>"
         when Prism::DefNode
           surrounding_method = node.name.to_s
           next unless node.receiver.is_a?(Prism::SelfNode)
 
-          nesting << "<Class:#{nesting.flat_map { |n| n.split("::") }.last}>"
+          nesting << "<#{nesting.flat_map { |n| n.split("::") }.last}>"
         end
       end
 

data/lib/ruby_lsp/requests/on_type_formatting.rb

@@ -120,6 +120,10 @@ module RubyLsp
 
         return unless END_REGEXES.any? { |regex| regex.match?(@previous_line) }
 
+        # Endless method definitions (e.g., `def foo = 42`) are complete statements
+        # and should not have `end` added
+        return if @previous_line.match?(/\bdef\s+[\w.]+[!?=]?(\([^)]*\))?\s*=[^=~>]/)
+
         indents = " " * @indentation
         current_line = @lines[@position[:line]]
         next_line = @lines[@position[:line] + 1]

data/lib/ruby_lsp/requests/rename.rb

@@ -22,6 +22,7 @@ module RubyLsp
       def initialize(global_state, store, document, params)
         super()
         @global_state = global_state
+        @graph = global_state.graph #: Rubydex::Graph
         @store = store
         @document = document
         @position = params[:position] #: Hash[Symbol, Integer]
@@ -56,17 +57,14 @@ module RubyLsp
         name = RubyIndexer::Index.constant_name(target)
         return unless name
 
-        entries = @global_state.index.resolve(name, node_context.nesting)
-        return unless entries
+        declaration = @graph.resolve_constant(name, node_context.nesting)
+        return unless declaration
 
-        if (conflict_entries = @global_state.index.resolve(@new_name, node_context.nesting))
-          raise InvalidNameError, "The new name is already in use by #{conflict_entries.first&.name}"
+        if (conflict = @graph.resolve_constant(@new_name, node_context.nesting))
+          raise InvalidNameError, "The new name is already in use by #{conflict.name}"
         end
 
-        fully_qualified_name = entries.first #: as !nil
-          .name
-        reference_target = RubyIndexer::ReferenceFinder::ConstTarget.new(fully_qualified_name)
-        changes = collect_text_edits(reference_target, name)
+        changes = collect_text_edits(declaration, name)
 
         # If the client doesn't support resource operations, such as renaming files, then we can only return the basic
         # text changes
@@ -78,99 +76,93 @@ module RubyLsp
         # renamed and then the URI associated to the text edit no longer exists, causing it to be dropped
         document_changes = changes.map do |uri, edits|
           Interface::TextDocumentEdit.new(
-            text_document: Interface::VersionedTextDocumentIdentifier.new(uri: uri, version: nil),
+            text_document: Interface::OptionalVersionedTextDocumentIdentifier.new(uri: uri, version: nil),
             edits: edits,
           )
         end
 
-        collect_file_renames(fully_qualified_name, document_changes)
+        collect_file_renames(declaration, document_changes)
         Interface::WorkspaceEdit.new(document_changes: document_changes)
       end
 
       private
 
-      #: (String fully_qualified_name, Array[(Interface::RenameFile | Interface::TextDocumentEdit)] document_changes) -> void
-      def collect_file_renames(fully_qualified_name, document_changes)
+      #: (Rubydex::Declaration, Array[(Interface::RenameFile | Interface::TextDocumentEdit)]) -> void
+      def collect_file_renames(declaration, document_changes)
         # Check if the declarations of the symbol being renamed match the file name. In case they do, we automatically
         # rename the files for the user.
         #
         # We also look for an associated test file and rename it too
-        short_name = fully_qualified_name.split("::").last #: as !nil
 
-        @global_state.index[fully_qualified_name]&.each do |entry|
+        unless [
+          Rubydex::Class,
+          Rubydex::Module,
+          Rubydex::Constant,
+          Rubydex::ConstantAlias,
+        ].any? { |type| declaration.is_a?(type) }
+          return
+        end
+
+        short_name = declaration.unqualified_name
+
+        declaration.definitions.each do |definition|
           # Do not rename files that are not part of the workspace
-          uri = entry.uri
+          uri = URI(definition.location.uri)
           file_path = uri.full_path
           next unless file_path&.start_with?(@global_state.workspace_path)
 
-          case entry
-          when RubyIndexer::Entry::Class, RubyIndexer::Entry::Module, RubyIndexer::Entry::Constant,
-               RubyIndexer::Entry::ConstantAlias, RubyIndexer::Entry::UnresolvedConstantAlias
-
-            file_name = file_from_constant_name(short_name)
+          file_name = file_from_constant_name(short_name)
+          next unless "#{file_name}.rb" == File.basename(file_path)
 
-            if "#{file_name}.rb" == entry.file_name
-              new_file_name = file_from_constant_name(
-                @new_name.split("::").last, #: as !nil
-              )
+          new_file_name = file_from_constant_name(
+            @new_name.split("::").last, #: as !nil
+          )
 
-              new_uri = URI::Generic.from_path(path: File.join(
-                File.dirname(file_path),
-                "#{new_file_name}.rb",
-              )).to_s
+          new_uri = URI::Generic.from_path(path: File.join(
+            File.dirname(file_path),
+            "#{new_file_name}.rb",
+          )).to_s
 
-              document_changes << Interface::RenameFile.new(kind: "rename", old_uri: uri.to_s, new_uri: new_uri)
-            end
-          end
+          document_changes << Interface::RenameFile.new(kind: "rename", old_uri: uri.to_s, new_uri: new_uri)
         end
       end
 
-      #: (RubyIndexer::ReferenceFinder::Target target, String name) -> Hash[String, Array[Interface::TextEdit]]
-      def collect_text_edits(target, name)
-        changes = {}
-
-        Dir.glob(File.join(@global_state.workspace_path, "**/*.rb")).each do |path|
-          uri = URI::Generic.from_path(path: path)
-          # If the document is being managed by the client, then we should use whatever is present in the store instead
-          # of reading from disk
-          next if @store.key?(uri)
-
-          parse_result = Prism.parse_file(path)
-          edits = collect_changes(target, parse_result.value, name, uri)
-          changes[uri.to_s] = edits unless edits.empty?
-        rescue Errno::EISDIR, Errno::ENOENT
-          # If `path` is a directory, just ignore it and continue. If the file doesn't exist, then we also ignore it.
-        end
-
-        @store.each do |uri, document|
-          next unless document.is_a?(RubyDocument) || document.is_a?(ERBDocument)
+      #: (Rubydex::Declaration declaration, String name) -> Hash[String, Array[Interface::TextEdit]]
+      def collect_text_edits(declaration, name)
+        changes = {} #: Hash[String, Array[Interface::TextEdit]]
+        short_name = name.split("::").last #: as !nil
+        new_short_name = @new_name.split("::").last #: as !nil
+
+        # Collect edits for definition sites (where the constant is declared)
+        declaration.definitions.each do |definition|
+          name_loc = definition.name_location
+          next unless name_loc
+
+          uri_string = name_loc.uri
+          edits = (changes[uri_string] ||= [])
+
+          # The name_location spans the constant name as written in the definition.
+          # We only replace the unqualified name portion (the last segment).
+          range = Interface::Range.new(
+            start: Interface::Position.new(
+              line: name_loc.end_line,
+              character: name_loc.end_column - short_name.length,
+            ),
+            end: Interface::Position.new(line: name_loc.end_line, character: name_loc.end_column),
+          )
 
-          edits = collect_changes(target, document.ast, name, document.uri)
-          changes[uri] = edits unless edits.empty?
+          edits << Interface::TextEdit.new(range: range, new_text: new_short_name)
         end
 
-        changes
-      end
-
-      #: (RubyIndexer::ReferenceFinder::Target target, Prism::Node ast, String name, URI::Generic uri) -> Array[Interface::TextEdit]
-      def collect_changes(target, ast, name, uri)
-        dispatcher = Prism::Dispatcher.new
-        finder = RubyIndexer::ReferenceFinder.new(target, @global_state.index, dispatcher, uri)
-        dispatcher.visit(ast)
-
-        finder.references.map do |reference|
-          adjust_reference_for_edit(name, reference)
+        # Collect edits for reference sites (where the constant is used)
+        declaration.references.each do |reference|
+          ref = reference #: as Rubydex::ConstantReference
+          uri_string = ref.location.uri
+          edits = (changes[uri_string] ||= [])
+          edits << Interface::TextEdit.new(range: ref.to_lsp_range, new_text: new_short_name)
         end
-      end
-
-      #: (String name, RubyIndexer::ReferenceFinder::Reference reference) -> Interface::TextEdit
-      def adjust_reference_for_edit(name, reference)
-        # The reference may include a namespace in front. We need to check if the rename new name includes namespaces
-        # and then adjust both the text and the location to produce the correct edit
-        location = reference.location
-        new_text = reference.name.sub(name, @new_name)
 
-        Interface::TextEdit.new(range: range_from_location(location), new_text: new_text)
+        changes
       end
 
       #: (String constant_name) -> String

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

@@ -64,6 +64,46 @@ module RubyLsp
           receiver.nil? || receiver.is_a?(Prism::SelfNode)
         end
 
+        #: (String, Enumerable[Rubydex::Definition], ?Integer?) -> Hash[Symbol, String]
+        def categorized_markdown_from_definitions(title, definitions, max_entries = nil)
+          markdown_title = "```ruby\n#{title}\n```"
+          file_links = []
+          content = +""
+          defs = max_entries ? definitions.take(max_entries) : definitions
+          defs.each do |definition|
+            # For Markdown links, we need 1 based display locations
+            loc = definition.location.to_display
+            uri = URI(loc.uri)
+            file_name = if uri.scheme == "untitled"
+              uri.opaque #: as !nil
+            else
+              File.basename(
+                uri.full_path, #: as !nil
+              )
+            end
+
+            # The format for VS Code file URIs is `file:///path/to/file.rb#Lstart_line,start_column-end_line,end_column`
+            string_uri = "#{loc.uri}#L#{loc.start_line},#{loc.start_column}-#{loc.end_line},#{loc.end_column}"
+            file_links << "[#{file_name}](#{string_uri})"
+            content << "\n\n#{definition.comments.map { |comment| comment.string.delete_prefix("# ") }.join("\n")}" unless definition.comments.empty?
+          end
+
+          total_definitions = definitions.count
+
+          additional_entries_text = if max_entries && total_definitions > max_entries
+            additional = total_definitions - max_entries
+            " | #{additional} other#{additional > 1 ? "s" : ""}"
+          else
+            ""
+          end
+
+          {
+            title: markdown_title,
+            links: "**Definitions**: #{file_links.join(" | ")}#{additional_entries_text}",
+            documentation: content,
+          }
+        end
+
         #: (String title, (Array[RubyIndexer::Entry] | RubyIndexer::Entry) entries, ?Integer? max_entries) -> Hash[Symbol, String]
         def categorized_markdown_from_index_entries(title, entries, max_entries = nil)
           markdown_title = "```ruby\n#{title}\n```"

data/lib/ruby_lsp/requests/workspace_symbol.rb

@@ -12,54 +12,32 @@ module RubyLsp
       #: (GlobalState global_state, String? query) -> void
       def initialize(global_state, query)
         super()
-        @global_state = global_state
         @query = query
-        @index = global_state.index #: RubyIndexer::Index
+        @graph = global_state.graph #: Rubydex::Graph
       end
 
       # @override
       #: -> Array[Interface::WorkspaceSymbol]
       def perform
-        fuzzy_search.filter_map do |entry|
-          kind = kind_for_entry(entry)
-          loc = entry.location
+        response = []
 
-          # We use the namespace as the container name, but we also use the full name as the regular name. The reason we
-          # do this is to allow people to search for fully qualified names (e.g.: `Foo::Bar`). If we only included the
-          # short name `Bar`, then searching for `Foo::Bar` would not return any results
-          *container, _short_name = entry.name.split("::")
+        @graph.fuzzy_search(@query || "").each do |declaration|
+          name = declaration.name
 
-          Interface::WorkspaceSymbol.new(
-            name: entry.name,
-            container_name: container.join("::"),
-            kind: kind,
-            location: Interface::Location.new(
-              uri: entry.uri.to_s,
-              range:  Interface::Range.new(
-                start: Interface::Position.new(line: loc.start_line - 1, character: loc.start_column),
-                end: Interface::Position.new(line: loc.end_line - 1, character: loc.end_column),
-              ),
-            ),
-          )
-        end
-      end
-
-      private
+          declaration.definitions.each do |definition|
+            location = definition.location
+            uri = URI(location.uri)
+            file_path = uri.full_path
 
-      #: -> Array[RubyIndexer::Entry]
-      def fuzzy_search
-        @index.fuzzy_search(@query) do |entry|
-          file_path = entry.uri.full_path
+            # We only show symbols declared in the workspace
+            in_dependencies = file_path && !not_in_dependencies?(file_path)
+            next if in_dependencies
 
-          # We only show symbols declared in the workspace
-          in_dependencies = file_path && !not_in_dependencies?(file_path)
-          next if in_dependencies
-
-          # We should never show private symbols when searching the entire workspace
-          next if entry.private?
-
-          true
+            response << definition.to_lsp_workspace_symbol(name)
+          end
         end
+
+        response
       end
     end
   end

data/lib/ruby_lsp/response_builders/semantic_highlighting.rb

@@ -43,7 +43,7 @@ module RubyLsp
         async: 6,
         modification: 7,
         documentation: 8,
-        default_library: 9,
+        defaultLibrary: 9,
       }.freeze #: Hash[Symbol, Integer]
 
       #: ((^(Integer arg0) -> Integer | Prism::CodeUnitsCache) code_units_cache) -> void
@@ -184,8 +184,8 @@ module RubyLsp
         end
 
         # Encode an array of modifiers to positions onto a bit flag
-        # For example, [:default_library] will be encoded as
-        # 0b1000000000, as :default_library is the 10th bit according
+        # For example, [:defaultLibrary] will be encoded as
+        # 0b1000000000, as :defaultLibrary is the 10th bit according
         # to the token modifiers index map.
         #: (Array[Integer] modifiers) -> Integer
         def encode_modifiers(modifiers)