ruby-lsp 0.12.2 → 0.13.0

data/lib/ruby_lsp/requests/semantic_highlighting.rb

@@ -107,20 +107,15 @@ module RubyLsp
       sig { override.returns(ResponseType) }
       attr_reader :_response
 
-      sig do
-        params(
-          dispatcher: Prism::Dispatcher,
-          message_queue: Thread::Queue,
-          range: T.nilable(T::Range[Integer]),
-        ).void
-      end
-      def initialize(dispatcher, message_queue, range: nil)
-        super(dispatcher, message_queue)
+      sig { params(dispatcher: Prism::Dispatcher, range: T.nilable(T::Range[Integer])).void }
+      def initialize(dispatcher, range: nil)
+        super(dispatcher)
 
         @_response = T.let([], ResponseType)
         @range = range
         @special_methods = T.let(nil, T.nilable(T::Array[String]))
         @current_scope = T.let(ParameterScope.new, ParameterScope)
+        @inside_regex_capture = T.let(false, T::Boolean)
 
         dispatcher.register(
           self,
@@ -135,7 +130,8 @@ module RubyLsp
           :on_local_variable_write_node_enter,
           :on_local_variable_read_node_enter,
           :on_block_parameter_node_enter,
-          :on_keyword_parameter_node_enter,
+          :on_required_keyword_parameter_node_enter,
+          :on_optional_keyword_parameter_node_enter,
           :on_keyword_rest_parameter_node_enter,
           :on_optional_parameter_node_enter,
           :on_required_parameter_node_enter,
@@ -151,6 +147,8 @@ module RubyLsp
           :on_local_variable_or_write_node_enter,
           :on_local_variable_target_node_enter,
           :on_block_local_variable_node_enter,
+          :on_match_write_node_enter,
+          :on_match_write_node_leave,
         )
       end
 
@@ -164,14 +162,28 @@ module RubyLsp
         # We can't push a semantic token for [] and []= because the argument inside the brackets is a part of
         # the message_loc
         return if message.start_with?("[") && (message.end_with?("]") || message.end_with?("]="))
-
-        return process_regexp_locals(node) if message == "=~"
+        return if message == "=~"
         return if special_method?(message)
 
         type = Support::Sorbet.annotation?(node) ? :type : :method
         add_token(T.must(node.message_loc), type)
       end
 
+      sig { params(node: Prism::MatchWriteNode).void }
+      def on_match_write_node_enter(node)
+        call = node.call
+
+        if call.message == "=~"
+          @inside_regex_capture = true
+          process_regexp_locals(call)
+        end
+      end
+
+      sig { params(node: Prism::MatchWriteNode).void }
+      def on_match_write_node_leave(node)
+        @inside_regex_capture = true if node.call.message == "=~"
+      end
+
       sig { params(node: Prism::ConstantReadNode).void }
       def on_constant_read_node_enter(node)
         return unless visible?(node, @range)
@@ -252,11 +264,18 @@ module RubyLsp
         @current_scope << name.to_sym if name
       end
 
-      sig { params(node: Prism::KeywordParameterNode).void }
-      def on_keyword_parameter_node_enter(node)
-        name = node.name
-        @current_scope << name.to_s.delete_suffix(":").to_sym if name
+      sig { params(node: Prism::RequiredKeywordParameterNode).void }
+      def on_required_keyword_parameter_node_enter(node)
+        @current_scope << node.name
+        return unless visible?(node, @range)
+
+        location = node.name_loc
+        add_token(location.copy(length: location.length - 1), :parameter)
+      end
 
+      sig { params(node: Prism::OptionalKeywordParameterNode).void }
+      def on_optional_keyword_parameter_node_enter(node)
+        @current_scope << node.name
         return unless visible?(node, @range)
 
         location = node.name_loc
@@ -351,6 +370,12 @@ module RubyLsp
 
       sig { params(node: Prism::LocalVariableTargetNode).void }
       def on_local_variable_target_node_enter(node)
+        # If we're inside a regex capture, Prism will add LocalVariableTarget nodes for each captured variable.
+        # Unfortunately, if the regex contains a backslash, the location will be incorrect and we'll end up highlighting
+        # the entire regex as a local variable. We process these captures in process_regexp_locals instead and then
+        # prevent pushing local variable target tokens. See https://github.com/ruby/prism/issues/1912
+        return if @inside_regex_capture
+
         return unless visible?(node, @range)
 
         add_token(node.location, @current_scope.type_for(node.name))

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

@@ -9,6 +9,9 @@ module RubyLsp
         # https://github.com/Shopify/ruby-lsp-rails, or addons by created by developers outside of Shopify, so be
         # cautious of changing anything.
         extend T::Sig
+        extend T::Helpers
+
+        requires_ancestor { Kernel }
 
         sig { params(node: Prism::Node).returns(Interface::Range) }
         def range_from_node(node)
@@ -66,12 +69,29 @@ module RubyLsp
           )
         end
 
-        sig { params(title: String, entries: T::Array[RubyIndexer::Entry]).returns(Interface::MarkupContent) }
+        sig { params(file_path: String).returns(T.nilable(T::Boolean)) }
+        def defined_in_gem?(file_path)
+          DependencyDetector.instance.typechecker && BUNDLE_PATH && !file_path.start_with?(T.must(BUNDLE_PATH)) &&
+            !file_path.start_with?(RbConfig::CONFIG["rubylibdir"])
+        end
+
+        sig { params(node: Prism::CallNode).returns(T::Boolean) }
+        def self_receiver?(node)
+          receiver = node.receiver
+          receiver.nil? || receiver.is_a?(Prism::SelfNode)
+        end
+
+        sig do
+          params(
+            title: String,
+            entries: T.any(T::Array[RubyIndexer::Entry], RubyIndexer::Entry),
+          ).returns(Interface::MarkupContent)
+        end
         def markdown_from_index_entries(title, entries)
           markdown_title = "```ruby\n#{title}\n```"
           definitions = []
           content = +""
-          entries.each do |entry|
+          Array(entries).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

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

@@ -66,7 +66,6 @@ module RubyLsp
 
     sig { returns(T::Array[String]) }
     def dependencies
-      # NOTE: If changing this behaviour, it's likely that the VS Code extension will also need changed.
       @dependencies ||= T.let(
         begin
           Bundler.with_original_env { Bundler.default_gemfile }

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

@@ -34,15 +34,10 @@ module RubyLsp
 
         sig { override.params(uri: URI::Generic, document: Document).returns(T.nilable(String)) }
         def run(uri, document)
-          relative_path = Pathname.new(T.must(uri.to_standardized_path || uri.opaque))
-            .relative_path_from(T.must(WORKSPACE_URI.to_standardized_path))
-          return if @options.ignore_files.any? { |pattern| File.fnmatch(pattern, relative_path) }
+          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,
-          )
+          SyntaxTree.format(document.source, @options.print_width, options: @options.formatter_options)
         end
       end
     end

data/lib/ruby_lsp/requests/workspace_symbol.rb

@@ -20,6 +20,7 @@ module RubyLsp
     #
     class WorkspaceSymbol
       extend T::Sig
+      include Support::Common
 
       sig { params(query: T.nilable(String), index: RubyIndexer::Index).void }
       def initialize(query, index)
@@ -29,21 +30,11 @@ module RubyLsp
 
       sig { returns(T::Array[Interface::WorkspaceSymbol]) }
       def run
-        bundle_path = begin
-          Bundler.bundle_path.to_s
-        rescue Bundler::GemfileNotFound
-          nil
-        end
-
         @index.fuzzy_search(@query).filter_map do |entry|
           # 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
-          if DependencyDetector.instance.typechecker && bundle_path && !file_path.start_with?(bundle_path) &&
-              !file_path.start_with?(RbConfig::CONFIG["rubylibdir"])
-
-            next
-          end
+          next if defined_in_gem?(file_path)
 
           # We should never show private symbols when searching the entire workspace
           next if entry.visibility == :private
@@ -82,6 +73,10 @@ module RubyLsp
           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
         end
       end
     end

data/lib/ruby_lsp/ruby_document.rb

@@ -0,0 +1,14 @@
+# typed: strict
+# frozen_string_literal: true
+
+module RubyLsp
+  class RubyDocument < Document
+    sig { override.returns(Prism::ParseResult) }
+    def parse
+      return @parse_result unless @needs_parsing
+
+      @needs_parsing = false
+      @parse_result = Prism.parse(@source)
+    end
+  end
+end

data/lib/ruby_lsp/setup_bundler.rb

@@ -12,6 +12,8 @@ require "time"
 # the Ruby LSP without including the gem in their application's Gemfile while at the same time giving us access to the
 # exact locked versions of dependencies.
 
+Bundler.ui.level = :silent
+
 module RubyLsp
   class SetupBundler
     extend T::Sig

data/lib/ruby_lsp/store.rb

@@ -1,8 +1,6 @@
 # typed: strict
 # frozen_string_literal: true
 
-require "ruby_lsp/document"
-
 module RubyLsp
   class Store
     extend T::Sig
@@ -19,6 +17,9 @@ module RubyLsp
     sig { returns(T::Boolean) }
     attr_accessor :experimental_features
 
+    sig { returns(URI::Generic) }
+    attr_accessor :workspace_uri
+
     sig { void }
     def initialize
       @state = T.let({}, T::Hash[String, Document])
@@ -26,6 +27,7 @@ module RubyLsp
       @formatter = T.let("auto", String)
       @supports_progress = T.let(true, T::Boolean)
       @experimental_features = T.let(false, T::Boolean)
+      @workspace_uri = T.let(URI::Generic.from_path(path: Dir.pwd), URI::Generic)
     end
 
     sig { params(uri: URI::Generic).returns(Document) }
@@ -40,7 +42,7 @@ module RubyLsp
 
     sig { params(uri: URI::Generic, source: String, version: Integer).void }
     def set(uri:, source:, version:)
-      document = Document.new(source: source, version: version, uri: uri, encoding: @encoding)
+      document = RubyDocument.new(source: source, version: version, uri: uri, encoding: @encoding)
       @state[uri.to_s] = document
     end
 

data/lib/ruby_lsp/utils.rb

@@ -4,9 +4,14 @@
 module RubyLsp
   # Used to indicate that a request shouldn't return a response
   VOID = T.let(Object.new.freeze, Object)
-
-  # This freeze is not redundant since the interpolated string is mutable
-  WORKSPACE_URI = T.let(URI::Generic.from_path(path: Dir.pwd), URI::Generic)
+  BUNDLE_PATH = T.let(
+    begin
+      Bundler.bundle_path.to_s
+    rescue Bundler::GemfileNotFound
+      nil
+    end,
+    T.nilable(String),
+  )
 
   # A notification to be sent to the client
   class Message

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-lsp
 version: !ruby/object:Gem::Version
-  version: 0.12.2
+  version: 0.13.0
 platform: ruby
 authors:
 - Shopify
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-10-31 00:00:00.000000000 Z
+date: 2023-11-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: language_server-protocol
@@ -30,20 +30,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.15.1
+        version: 0.18.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '0.16'
+        version: '0.19'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.15.1
+        version: 0.18.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '0.16'
+        version: '0.19'
 - !ruby/object:Gem::Dependency
   name: sorbet-runtime
   requirement: !ruby/object:Gem::Requirement
@@ -78,12 +78,12 @@ files:
 - lib/rubocop/cop/ruby_lsp/use_language_server_aliases.rb
 - lib/rubocop/cop/ruby_lsp/use_register_with_handler_method.rb
 - lib/ruby-lsp.rb
+- lib/ruby_indexer/lib/ruby_indexer/collector.rb
 - lib/ruby_indexer/lib/ruby_indexer/configuration.rb
 - lib/ruby_indexer/lib/ruby_indexer/entry.rb
 - lib/ruby_indexer/lib/ruby_indexer/index.rb
 - lib/ruby_indexer/lib/ruby_indexer/indexable_path.rb
 - lib/ruby_indexer/lib/ruby_indexer/prefix_tree.rb
-- lib/ruby_indexer/lib/ruby_indexer/visitor.rb
 - lib/ruby_indexer/ruby_indexer.rb
 - lib/ruby_indexer/test/classes_and_modules_test.rb
 - lib/ruby_indexer/test/configuration_test.rb
@@ -132,6 +132,7 @@ files:
 - lib/ruby_lsp/requests/support/source_uri.rb
 - lib/ruby_lsp/requests/support/syntax_tree_formatting_runner.rb
 - lib/ruby_lsp/requests/workspace_symbol.rb
+- lib/ruby_lsp/ruby_document.rb
 - lib/ruby_lsp/server.rb
 - lib/ruby_lsp/setup_bundler.rb
 - lib/ruby_lsp/store.rb