ruby-lsp 0.13.3 → 0.14.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 28e657dce7a85c270d1c647a158fd1a1c5f81dca211844defd817070fd264126
-  data.tar.gz: f129245dd0e632916573c0b9dcf04bfaa2c7b942b39aaa6aa1618dd70f13e69e
+  metadata.gz: 293c03761c9b7d497045546e3bf7ca88a08ed5556ad0ba52c205a9798e820ce5
+  data.tar.gz: 38157f012f3f1dc944186ac1530dc660d8662cb59ca7b12ad3b117655e0c1709
 SHA512:
-  metadata.gz: 3ab4afce37f672fd0d3c3ecc54c7b30247f893fc4b7b4f10549e13db4ab181c67a9b84da37dea9fbdd195e8d87ca2f2f794cbcce300c68b4709ee0ae3b3171b2
-  data.tar.gz: ffdb3a1bdb2d5c4172f74c934da896bd6c19f09158effa137afd0443e79b8c2dfd392989997d5745616db58e1286191a9e35570bd69024779137e7aaf15bb987
+  metadata.gz: c4996e277088f015004df0f82e2cc47dc2f979f6658f9dfac19fe495c8c4deced3028b021e330ac0681dbfd79048e9033037c7ce93e6cc044c8ae6d91087e0df
+  data.tar.gz: 67c5c31c97c279f192b0b3d6c729c97a19f7aac4581eca037c0e5355cc0f3d3ed69fb4007a5f32985e046980324575e2e35a92ce81e8078b41ee5b6db711ac88

data/README.md

@@ -1,6 +1,6 @@
 [![Build Status](https://github.com/Shopify/ruby-lsp/workflows/CI/badge.svg)](https://github.com/Shopify/ruby-lsp/actions/workflows/ci.yml)
 [![Ruby LSP extension](https://img.shields.io/badge/VS%20Code-Ruby%20LSP-success?logo=visual-studio-code)](https://marketplace.visualstudio.com/items?itemName=Shopify.ruby-lsp)
-[![Ruby DX Slack](https://img.shields.io/badge/Slack-Ruby%20DX-success?logo=slack)](https://join.slack.com/t/ruby-dx/shared_invite/zt-1zjp7lmgk-zL7bGvze8gj5hFaYS~r5vg)
+[![Ruby DX Slack](https://img.shields.io/badge/Slack-Ruby%20DX-success?logo=slack)](https://join.slack.com/t/ruby-dx/shared_invite/zt-2c8zjlir6-uUDJl8oIwcen_FS_aA~b6Q)
 
 # Ruby LSP
 
@@ -9,7 +9,7 @@ for Ruby, used to improve rich features in editors. It is a part of a wider goal
 experience to Ruby developers using modern standards for cross-editor features, documentation and debugging.
 
 Want to discuss Ruby developer experience? Consider joining the public
-[Ruby DX Slack workspace](https://join.slack.com/t/ruby-dx/shared_invite/zt-1zjp7lmgk-zL7bGvze8gj5hFaYS~r5vg).
+[Ruby DX Slack workspace](https://join.slack.com/t/ruby-dx/shared_invite/zt-2c8zjlir6-uUDJl8oIwcen_FS_aA~b6Q).
 
 ## Usage
 
@@ -83,6 +83,10 @@ features. This is the mechanism that powers addons like
 
 - [Ruby LSP Rails](https://github.com/Shopify/ruby-lsp-rails)
 - [Ruby LSP RSpec](https://github.com/st0012/ruby-lsp-rspec)
+- [Ruby LSP rubyfmt](https://github.com/jscharf/ruby-lsp-rubyfmt)
+
+Other community driven addons can be found in [rubygems](https://rubygems.org/search?query=name%3A+ruby-lsp) by
+searching for the `ruby-lsp` prefix.
 
 For instructions on how to create addons, see the [addons documentation](ADDONS.md).
 

data/VERSION

@@ -1 +1 @@
-0.13.3
+0.14.2

data/exe/ruby-lsp-doctor

@@ -6,6 +6,8 @@ require "ruby_lsp/internal"
 
 index = RubyIndexer::Index.new
 
+puts "Globbing for indexable files"
+
 RubyIndexer.configuration.indexables.each do |indexable|
   puts "indexing: #{indexable.full_path}"
   content = File.read(indexable.full_path)

data/lib/rubocop/cop/ruby_lsp/use_register_with_handler_method.rb

@@ -13,9 +13,8 @@ module RuboCop
       # # Register without handler method.
       #
       # # bad
-      # class MyListener < Listener
+      # class MyListener
       #   def initialize(dispatcher)
-      #     super()
       #     dispatcher.register(
       #       self,
       #       :on_string_node_enter,
@@ -24,9 +23,8 @@ module RuboCop
       # end
       #
       # # good
-      # class MyListener < Listener
+      # class MyListener
       #   def initialize(dispatcher)
-      #     super()
       #     dispatcher.register(
       #       self,
       #       :on_string_node_enter,
@@ -41,9 +39,8 @@ module RuboCop
       # # Handler method without register.
       #
       # # bad
-      # class MyListener < Listener
+      # class MyListener
       #   def initialize(dispatcher)
-      #     super()
       #     dispatcher.register(
       #       self,
       #     )
@@ -54,9 +51,8 @@ module RuboCop
       # end
       #
       # # good
-      # class MyListener < Listener
+      # class MyListener
       #   def initialize(dispatcher)
-      #     super()
       #     dispatcher.register(
       #       self,
       #       :on_string_node_enter,

data/lib/ruby_indexer/lib/ruby_indexer/collector.rb

@@ -304,7 +304,11 @@ module RubyIndexer
         break unless comment
 
         comment_content = comment.location.slice.chomp
-        next if comment_content.match?(RubyIndexer.configuration.magic_comment_regex)
+
+        # invalid encodings would raise an "invalid byte sequence" exception
+        if !comment_content.valid_encoding? || comment_content.match?(RubyIndexer.configuration.magic_comment_regex)
+          next
+        end
 
         comment_content.delete_prefix!("#")
         comment_content.delete_prefix!(" ")

data/lib/ruby_indexer/lib/ruby_indexer/configuration.rb

@@ -192,6 +192,9 @@ module RubyIndexer
 
       # When working on a gem, we need to make sure that its gemspec dependencies can't be excluded. This is necessary
       # because Bundler doesn't assign groups to gemspec dependencies
+      #
+      # If the dependency is prerelease, `to_spec` may return `nil` due to a bug in older version of Bundler/RubyGems:
+      # https://github.com/Shopify/ruby-lsp/issues/1246
       this_gem = Bundler.definition.dependencies.find do |d|
         d.to_spec&.full_gem_path == Dir.pwd
       rescue Gem::MissingSpecError
@@ -203,7 +206,6 @@ module RubyIndexer
       excluded.each do |dependency|
         next unless dependency.runtime?
 
-        # If the dependency is prerelease, to_spec may return `nil`
         spec = dependency.to_spec
         next unless spec
 
@@ -213,7 +215,7 @@ module RubyIndexer
 
           # If the transitive dependency is included as a transitive dependency of a gem outside of the development
           # group, skip it
-          next if others.any? { |d| d.to_spec.dependencies.include?(transitive_dependency) }
+          next if others.any? { |d| d.to_spec&.dependencies&.include?(transitive_dependency) }
 
           excluded << transitive_dependency
         end

data/lib/ruby_indexer/lib/ruby_indexer/index.rb

@@ -237,16 +237,21 @@ module RubyIndexer
       real_parts.join("::")
     end
 
-    # Attempts to find a given method for a resolved fully qualified receiver name. Returns `nil` if the method does not
-    # exist on that receiver
-    sig { params(method_name: String, receiver_name: String).returns(T.nilable(Entry::Method)) }
+    # Attempts to find methods for a resolved fully qualified receiver name.
+    # Returns `nil` if the method does not exist on that receiver
+    sig { params(method_name: String, receiver_name: String).returns(T.nilable(T::Array[Entry::Member])) }
     def resolve_method(method_name, receiver_name)
-      method_entries = T.cast(self[method_name], T.nilable(T::Array[Entry::Method]))
+      method_entries = self[method_name]
       owner_entries = self[receiver_name]
       return unless owner_entries && method_entries
 
       owner_name = T.must(owner_entries.first).name
-      method_entries.find { |entry| entry.owner&.name == owner_name }
+      T.cast(
+        method_entries.grep(Entry::Member).select do |entry|
+          T.cast(entry, Entry::Member).owner&.name == owner_name
+        end,
+        T::Array[Entry::Member],
+      )
     end
 
     private

data/lib/ruby_indexer/test/classes_and_modules_test.rb

@@ -168,6 +168,15 @@ module RubyIndexer
       assert_equal("This Bar comment has 1 line padding", bar_entry.comments.join("\n"))
     end
 
+    def test_skips_comments_containing_invalid_encodings
+      index(<<~RUBY)
+        # comment \xBA
+        class Foo
+        end
+      RUBY
+      assert(@index["Foo"].first)
+    end
+
     def test_comments_can_be_attached_to_a_namespaced_class
       index(<<~RUBY)
         # This is a Foo comment

data/lib/ruby_indexer/test/index_test.rb

@@ -226,9 +226,60 @@ module RubyIndexer
         end
       RUBY
 
-      entry = T.must(@index.resolve_method("baz", "Foo::Bar"))
-      assert_equal("baz", entry.name)
-      assert_equal("Foo::Bar", T.must(entry.owner).name)
+      entries = T.must(@index.resolve_method("baz", "Foo::Bar"))
+      assert_equal("baz", entries.first.name)
+      assert_equal("Foo::Bar", T.must(entries.first.owner).name)
+    end
+
+    def test_resolve_method_with_class_name_conflict
+      index(<<~RUBY)
+        class Array
+        end
+
+        class Foo
+          def Array(*args); end
+        end
+      RUBY
+
+      entries = T.must(@index.resolve_method("Array", "Foo"))
+      assert_equal("Array", entries.first.name)
+      assert_equal("Foo", T.must(entries.first.owner).name)
+    end
+
+    def test_resolve_method_attribute
+      index(<<~RUBY)
+        class Foo
+          attr_reader :bar
+        end
+      RUBY
+
+      entries = T.must(@index.resolve_method("bar", "Foo"))
+      assert_equal("bar", entries.first.name)
+      assert_equal("Foo", T.must(entries.first.owner).name)
+    end
+
+    def test_resolve_method_with_two_definitions
+      index(<<~RUBY)
+        class Foo
+          # Hello from first `bar`
+          def bar; end
+        end
+
+        class Foo
+          # Hello from second `bar`
+          def bar; end
+        end
+      RUBY
+
+      first_entry, second_entry = T.must(@index.resolve_method("bar", "Foo"))
+
+      assert_equal("bar", first_entry.name)
+      assert_equal("Foo", T.must(first_entry.owner).name)
+      assert_includes(first_entry.comments, "Hello from first `bar`")
+
+      assert_equal("bar", second_entry.name)
+      assert_equal("Foo", T.must(second_entry.owner).name)
+      assert_includes(second_entry.comments, "Hello from second `bar`")
     end
 
     def test_prefix_search_for_methods

data/lib/ruby_lsp/addon.rb

@@ -25,21 +25,25 @@ module RubyLsp
 
     abstract!
 
+    @addons = T.let([], T::Array[Addon])
+    @addon_classes = T.let([], T::Array[T.class_of(Addon)])
+
     class << self
       extend T::Sig
 
+      sig { returns(T::Array[Addon]) }
+      attr_accessor :addons
+
+      sig { returns(T::Array[T.class_of(Addon)]) }
+      attr_reader :addon_classes
+
       # Automatically track and instantiate addon classes
       sig { params(child_class: T.class_of(Addon)).void }
       def inherited(child_class)
-        addons << child_class.new
+        addon_classes << child_class
         super
       end
 
-      sig { returns(T::Array[Addon]) }
-      def addons
-        @addons ||= T.let([], T.nilable(T::Array[Addon]))
-      end
-
       # Discovers and loads all addons. Returns the list of activated addons
       sig { params(message_queue: Thread::Queue).returns(T::Array[Addon]) }
       def load_addons(message_queue)
@@ -48,15 +52,16 @@ module RubyLsp
         Gem.find_files("ruby_lsp/**/addon.rb").each do |addon|
           require File.expand_path(addon)
         rescue => e
-          warn(e.message)
-          warn(e.backtrace.to_s) # rubocop:disable Lint/RedundantStringCoercion
+          $stderr.puts(e.full_message)
         end
 
+        # Instantiate all discovered addon classes
+        self.addons = addon_classes.map(&:new)
+
         # Activate each one of the discovered addons. If any problems occur in the addons, we don't want to
         # fail to boot the server
         addons.each do |addon|
           addon.activate(message_queue)
-          nil
         rescue => e
           addon.add_error(e)
         end
@@ -109,39 +114,51 @@ module RubyLsp
     # Creates a new CodeLens listener. This method is invoked on every CodeLens request
     sig do
       overridable.params(
+        response_builder: ResponseBuilders::CollectionResponseBuilder[Interface::CodeLens],
         uri: URI::Generic,
         dispatcher: Prism::Dispatcher,
-      ).returns(T.nilable(Listener[T::Array[Interface::CodeLens]]))
+      ).void
     end
-    def create_code_lens_listener(uri, dispatcher); end
+    def create_code_lens_listener(response_builder, uri, dispatcher); end
 
     # Creates a new Hover listener. This method is invoked on every Hover request
     sig do
       overridable.params(
+        response_builder: ResponseBuilders::Hover,
         nesting: T::Array[String],
         index: RubyIndexer::Index,
         dispatcher: Prism::Dispatcher,
-      ).returns(T.nilable(Listener[T.nilable(Interface::Hover)]))
+      ).void
     end
-    def create_hover_listener(nesting, index, dispatcher); end
+    def create_hover_listener(response_builder, nesting, index, dispatcher); end
 
     # Creates a new DocumentSymbol listener. This method is invoked on every DocumentSymbol request
     sig do
       overridable.params(
+        response_builder: ResponseBuilders::DocumentSymbol,
+        dispatcher: Prism::Dispatcher,
+      ).void
+    end
+    def create_document_symbol_listener(response_builder, dispatcher); end
+
+    sig do
+      overridable.params(
+        response_builder: ResponseBuilders::SemanticHighlighting,
         dispatcher: Prism::Dispatcher,
-      ).returns(T.nilable(Listener[T::Array[Interface::DocumentSymbol]]))
+      ).void
     end
-    def create_document_symbol_listener(dispatcher); end
+    def create_semantic_highlighting_listener(response_builder, dispatcher); end
 
     # Creates a new Definition listener. This method is invoked on every Definition request
     sig do
       overridable.params(
+        response_builder: ResponseBuilders::CollectionResponseBuilder[Interface::Location],
         uri: URI::Generic,
         nesting: T::Array[String],
         index: RubyIndexer::Index,
         dispatcher: Prism::Dispatcher,
-      ).returns(T.nilable(Listener[T.nilable(T.any(T::Array[Interface::Location], Interface::Location))]))
+      ).void
     end
-    def create_definition_listener(uri, nesting, index, dispatcher); end
+    def create_definition_listener(response_builder, uri, nesting, index, dispatcher); end
   end
 end

data/lib/ruby_lsp/check_docs.rb

@@ -6,7 +6,7 @@ require "objspace"
 
 module RubyLsp
   # This rake task checks that all requests or addons are fully documented. Add the rake task to your Rakefile and
-  # specify the absolute path for all files that must be required in order to discover all listeners and their related
+  # specify the absolute path for all files that must be required in order to discover all requests and their related
   # GIFs
   #
   #   # Rakefile
@@ -33,7 +33,7 @@ module RubyLsp
 
     sig { void }
     def define_task
-      desc("Checks if all Ruby LSP listeners are documented")
+      desc("Checks if all Ruby LSP requests are documented")
       task(@name) { run_task }
     end
 
@@ -46,10 +46,10 @@ module RubyLsp
 
     sig { void }
     def run_task
-      # Require all files configured to make sure all listeners are loaded
+      # Require all files configured to make sure all requests are loaded
       @file_list.each { |f| require(f.delete_suffix(".rb")) }
 
-      # Find all classes that inherit from BaseRequest or Listener, which are the ones we want to make sure are
+      # Find all classes that inherit from BaseRequest, which are the ones we want to make sure are
       # documented
       features = ObjectSpace.each_object(Class).select do |k|
         klass = T.unsafe(k)
@@ -69,7 +69,7 @@ module RubyLsp
         lines = File.readlines(file_path)
         docs = []
 
-        # Extract the documentation on top of the listener constant
+        # Extract the documentation on top of the request constant
         while (line = lines[line_number]&.strip) && line.start_with?("#")
           docs.unshift(line)
           line_number -= 1
@@ -115,8 +115,8 @@ module RubyLsp
       end
 
       if missing_docs.any?
-        warn(<<~WARN)
-          The following listeners are missing documentation:
+        $stderr.puts(<<~WARN)
+          The following requests are missing documentation:
 
           #{missing_docs.map { |k, v| "#{k}\n\n#{v.join("\n")}" }.join("\n\n")}
         WARN
@@ -124,7 +124,7 @@ module RubyLsp
         abort
       end
 
-      puts "All listeners are documented!"
+      puts "All requests are documented!"
     end
   end
 end

data/lib/ruby_lsp/executor.rb

@@ -25,7 +25,7 @@ module RubyLsp
       begin
         response = run(request)
       rescue StandardError, LoadError => e
-        warn(e.message)
+        $stderr.puts(e.full_message)
         error = e
       end
 
@@ -55,7 +55,7 @@ module RubyLsp
             ),
           )
 
-          warn(errored_addons.map(&:backtraces).join("\n\n"))
+          $stderr.puts(errored_addons.map(&:backtraces).join("\n\n"))
         end
 
         RubyVM::YJIT.enable if defined? RubyVM::YJIT.enable
@@ -63,7 +63,7 @@ module RubyLsp
         perform_initial_indexing
         check_formatter_is_available
 
-        warn("Ruby LSP is ready")
+        $stderr.puts("Ruby LSP is ready")
         VOID
       when "textDocument/didOpen"
         text_document_did_open(
@@ -99,8 +99,7 @@ module RubyLsp
         folding_range = Requests::FoldingRanges.new(document.parse_result.comments, dispatcher)
         document_symbol = Requests::DocumentSymbol.new(dispatcher)
         document_link = Requests::DocumentLink.new(uri, document.comments, dispatcher)
-        lenses_configuration = T.must(@store.features_configuration.dig(:codeLens))
-        code_lens = Requests::CodeLens.new(uri, lenses_configuration, dispatcher)
+        code_lens = Requests::CodeLens.new(uri, dispatcher)
 
         semantic_highlighting = Requests::SemanticHighlighting.new(dispatcher)
         dispatcher.dispatch(document.tree)
@@ -113,7 +112,7 @@ module RubyLsp
         document.cache_set("textDocument/codeLens", code_lens.perform)
         document.cache_set(
           "textDocument/semanticTokens/full",
-          Requests::Support::SemanticTokenEncoder.new.encode(semantic_highlighting.perform),
+          semantic_highlighting.perform,
         )
         document.cache_get(request[:method])
       when "textDocument/semanticTokens/range"
@@ -222,6 +221,8 @@ module RubyLsp
         workspace_symbol(request.dig(:params, :query))
       when "rubyLsp/textDocument/showSyntaxTree"
         show_syntax_tree(uri, request.dig(:params, :range))
+      when "rubyLsp/workspace/dependencies"
+        workspace_dependencies
       else
         VOID
       end
@@ -252,6 +253,22 @@ module RubyLsp
       VOID
     end
 
+    sig { returns(T::Array[T::Hash[Symbol, T.untyped]]) }
+    def workspace_dependencies
+      definition = Bundler.definition
+      dep_keys = definition.locked_deps.keys.to_set
+      definition.specs.map do |spec|
+        {
+          name: spec.name,
+          version: spec.version,
+          path: spec.full_gem_path,
+          dependency: dep_keys.include?(spec.name),
+        }
+      end
+    rescue Bundler::GemfileNotFound
+      []
+    end
+
     sig { void }
     def perform_initial_indexing
       # The begin progress invocation happens during `initialize`, so that the notification is sent before we are
@@ -361,7 +378,7 @@ module RubyLsp
       ).returns(T::Array[Interface::TextEdit])
     end
     def on_type_formatting(uri, position, character)
-      Requests::OnTypeFormatting.new(@store.get(uri), position, character).perform
+      Requests::OnTypeFormatting.new(@store.get(uri), position, character, @store.client_name).perform
     end
 
     sig do
@@ -431,7 +448,7 @@ module RubyLsp
       request = Requests::SemanticHighlighting.new(dispatcher, range: start_line..end_line)
       dispatcher.visit(document.tree)
 
-      Requests::Support::SemanticTokenEncoder.new.encode(request.perform)
+      request.perform
     end
 
     sig { params(id: String, title: String, percentage: Integer).void }
@@ -497,6 +514,9 @@ module RubyLsp
       workspace_uri = options.dig(:workspaceFolders, 0, :uri)
       @store.workspace_uri = URI(workspace_uri) if workspace_uri
 
+      client_name = options.dig(:clientInfo, :name)
+      @store.client_name = client_name if client_name
+
       encodings = options.dig(:capabilities, :general, :positionEncodings)
       @store.encoding = if encodings.nil? || encodings.empty?
         Constant::PositionEncodingKind::UTF16
@@ -519,9 +539,7 @@ module RubyLsp
       @store.experimental_features = options.dig(:initializationOptions, :experimentalFeaturesEnabled) || false
 
       configured_hints = options.dig(:initializationOptions, :featuresConfiguration, :inlayHint)
-      configured_lenses = options.dig(:initializationOptions, :featuresConfiguration, :codeLens)
       T.must(@store.features_configuration.dig(:inlayHint)).configuration.merge!(configured_hints) if configured_hints
-      T.must(@store.features_configuration.dig(:codeLens)).configuration.merge!(configured_lenses) if configured_lenses
 
       enabled_features = case configured_features
       when Array

data/lib/ruby_lsp/internal.rb

@@ -7,13 +7,17 @@ yarp_require_paths = Gem.loaded_specs["yarp"]&.full_require_paths
 $LOAD_PATH.delete_if { |path| yarp_require_paths.include?(path) } if yarp_require_paths
 
 require "sorbet-runtime"
-require "prism"
-require "prism/visitor"
-require "language_server-protocol"
+
+# Set Bundler's UI level to silent as soon as possible to prevent any prints to STDOUT
 require "bundler"
+Bundler.ui.level = :silent
+
 require "uri"
 require "cgi"
 require "set"
+require "prism"
+require "prism/visitor"
+require "language_server-protocol"
 
 require "ruby-lsp"
 require "ruby_indexer/ruby_indexer"
@@ -23,11 +27,9 @@ require "ruby_lsp/parameter_scope"
 require "ruby_lsp/server"
 require "ruby_lsp/executor"
 require "ruby_lsp/requests"
-require "ruby_lsp/listener"
+require "ruby_lsp/response_builders"
 require "ruby_lsp/document"
 require "ruby_lsp/ruby_document"
 require "ruby_lsp/store"
 require "ruby_lsp/addon"
 require "ruby_lsp/requests/support/rubocop_runner"
-
-Bundler.ui.level = :silent