ruby-lsp 0.4.2 → 0.5.0

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

@@ -67,12 +67,13 @@ module RubyLsp
             return unless RAILTIES_VERSION
 
             warn("Fetching Rails Documents...")
-            # If the version's doc is not found, e.g. Rails main, it'll be redirected
-            # In this case, we just fetch the latest doc
-            response = if Gem::Version.new(RAILTIES_VERSION).prerelease?
-              Net::HTTP.get_response(URI("#{RAILS_DOC_HOST}/js/search_index.js"))
-            else
-              Net::HTTP.get_response(URI("#{RAILS_DOC_HOST}/v#{RAILTIES_VERSION}/js/search_index.js"))
+
+            response = Net::HTTP.get_response(URI("#{RAILS_DOC_HOST}/v#{RAILTIES_VERSION}/js/search_index.js"))
+
+            if response.code == "302"
+              # If the version's doc is not found, e.g. Rails main, it'll be redirected
+              # In this case, we just fetch the latest doc
+              response = Net::HTTP.get_response(URI("#{RAILS_DOC_HOST}/js/search_index.js"))
             end
 
             if response.code == "200"

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

@@ -1,7 +1,6 @@
 # typed: strict
 # frozen_string_literal: true
 
-require "ruby_lsp/requests/support/rubocop_runner"
 return unless defined?(RubyLsp::Requests::Support::RuboCopRunner)
 
 require "cgi"

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

@@ -1,7 +1,6 @@
 # typed: strict
 # frozen_string_literal: true
 
-require "ruby_lsp/requests/support/rubocop_runner"
 return unless defined?(RubyLsp::Requests::Support::RuboCopRunner)
 
 require "cgi"

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

@@ -4,7 +4,7 @@
 module RubyLsp
   module Requests
     module Support
-      class SelectionRange < LanguageServer::Protocol::Interface::SelectionRange
+      class SelectionRange < Interface::SelectionRange
         extend T::Sig
 
         sig { params(position: Document::PositionShape).returns(T::Boolean) }

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

@@ -16,7 +16,7 @@ module RubyLsp
         sig do
           params(
             tokens: T::Array[SemanticHighlighting::SemanticToken],
-          ).returns(LanguageServer::Protocol::Interface::SemanticTokens)
+          ).returns(Interface::SemanticTokens)
         end
         def encode(tokens)
           delta = tokens
@@ -27,7 +27,7 @@ module RubyLsp
               compute_delta(token)
             end
 
-          LanguageServer::Protocol::Interface::SemanticTokens.new(data: delta)
+          Interface::SemanticTokens.new(data: delta)
         end
 
         # The delta array is computed according to the LSP specification:

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

@@ -63,7 +63,8 @@ module RubyLsp
             when SyntaxTree::VCall
               ANNOTATIONS[node.value.value]
             when SyntaxTree::CallNode
-              ANNOTATIONS[node.message.value]
+              message = node.message
+              ANNOTATIONS[message.value] unless message.is_a?(Symbol)
             else
               T.absurd(node)
             end
@@ -84,21 +85,10 @@ module RubyLsp
           end
 
           sig do
-            params(node: T.nilable(T.any(
-              SyntaxTree::VarRef,
-              SyntaxTree::CallNode,
-              SyntaxTree::VCall,
-              SyntaxTree::Ident,
-              SyntaxTree::Backtick,
-              SyntaxTree::Const,
-              SyntaxTree::Op,
-              Symbol,
-            ))).returns(T.nilable(String))
+            params(node: T.nilable(SyntaxTree::Node)).returns(T.nilable(String))
           end
           def node_name(node)
             case node
-            when NilClass
-              nil
             when SyntaxTree::VarRef
               node.value.value
             when SyntaxTree::CallNode
@@ -107,8 +97,8 @@ module RubyLsp
               node_name(node.value)
             when SyntaxTree::Ident, SyntaxTree::Backtick, SyntaxTree::Const, SyntaxTree::Op
               node.value
-            when Symbol
-              node.to_s
+            when NilClass, SyntaxTree::Node
+              nil
             else
               T.absurd(node)
             end

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

@@ -0,0 +1,42 @@
+# typed: strict
+# frozen_string_literal: true
+
+require "syntax_tree/cli"
+require "singleton"
+
+module RubyLsp
+  module Requests
+    module Support
+      # :nodoc:
+      class SyntaxTreeFormattingRunner
+        extend T::Sig
+        include Singleton
+
+        sig { void }
+        def initialize
+          @options =
+            T.let(
+              begin
+                opts = SyntaxTree::CLI::Options.new
+                opts.parse(SyntaxTree::CLI::ConfigFile.new.arguments)
+                opts
+              end,
+              SyntaxTree::CLI::Options,
+            )
+        end
+
+        sig { params(uri: String, document: Document).returns(T.nilable(String)) }
+        def run(uri, document)
+          relative_path = Pathname.new(URI(uri).path).relative_path_from(T.must(WORKSPACE_URI.path))
+          return if @options.ignore_files.any? { |pattern| File.fnmatch(pattern, relative_path) }
+
+          SyntaxTree.format(
+            document.source,
+            @options.print_width,
+            options: @options.formatter_options,
+          )
+        end
+      end
+    end
+  end
+end

data/lib/ruby_lsp/requests.rb

@@ -4,20 +4,21 @@
 module RubyLsp
   # Supported features
   #
-  # - {RubyLsp::Requests::DocumentSymbol}
-  # - {RubyLsp::Requests::DocumentLink}
-  # - {RubyLsp::Requests::Hover}
-  # - {RubyLsp::Requests::FoldingRanges}
-  # - {RubyLsp::Requests::SelectionRanges}
-  # - {RubyLsp::Requests::SemanticHighlighting}
-  # - {RubyLsp::Requests::Formatting}
-  # - {RubyLsp::Requests::OnTypeFormatting}
-  # - {RubyLsp::Requests::Diagnostics}
-  # - {RubyLsp::Requests::CodeActions}
-  # - {RubyLsp::Requests::CodeActionResolve}
-  # - {RubyLsp::Requests::DocumentHighlight}
-  # - {RubyLsp::Requests::InlayHints}
-  # - {RubyLsp::Requests::PathCompletion}
+  # - [DocumentSymbol](rdoc-ref:RubyLsp::Requests::DocumentSymbol)
+  # - [DocumentLink](rdoc-ref:RubyLsp::Requests::DocumentLink)
+  # - [Hover](rdoc-ref:RubyLsp::Requests::Hover)
+  # - [FoldingRange](rdoc-ref:RubyLsp::Requests::FoldingRanges)
+  # - [SelectionRange](rdoc-ref:RubyLsp::Requests::SelectionRanges)
+  # - [SemanticHighlighting](rdoc-ref:RubyLsp::Requests::SemanticHighlighting)
+  # - [Formatting](rdoc-ref:RubyLsp::Requests::Formatting)
+  # - [OnTypeFormatting](rdoc-ref:RubyLsp::Requests::OnTypeFormatting)
+  # - [Diagnostic](rdoc-ref:RubyLsp::Requests::Diagnostics)
+  # - [CodeAction](rdoc-ref:RubyLsp::Requests::CodeActions)
+  # - [CodeActionResolve](rdoc-ref:RubyLsp::Requests::CodeActionResolve)
+  # - [DocumentHighlight](rdoc-ref:RubyLsp::Requests::DocumentHighlight)
+  # - [InlayHint](rdoc-ref:RubyLsp::Requests::InlayHints)
+  # - [PathCompletion](rdoc-ref:RubyLsp::Requests::PathCompletion)
+  # - [CodeLens](rdoc-ref:RubyLsp::Requests::CodeLens)
 
   module Requests
     autoload :BaseRequest, "ruby_lsp/requests/base_request"
@@ -35,6 +36,7 @@ module RubyLsp
     autoload :DocumentHighlight, "ruby_lsp/requests/document_highlight"
     autoload :InlayHints, "ruby_lsp/requests/inlay_hints"
     autoload :PathCompletion, "ruby_lsp/requests/path_completion"
+    autoload :CodeLens, "ruby_lsp/requests/code_lens"
 
     # :nodoc:
     module Support
@@ -46,6 +48,7 @@ module RubyLsp
       autoload :HighlightTarget, "ruby_lsp/requests/support/highlight_target"
       autoload :RailsDocumentClient, "ruby_lsp/requests/support/rails_document_client"
       autoload :PrefixTree, "ruby_lsp/requests/support/prefix_tree"
+      autoload :Common, "ruby_lsp/requests/support/common"
     end
   end
 end

data/lib/ruby_lsp/server.rb

@@ -2,9 +2,11 @@
 # frozen_string_literal: true
 
 module RubyLsp
+  # rubocop:disable RubyLsp/UseLanguageServerAliases
   Interface = LanguageServer::Protocol::Interface
   Constant = LanguageServer::Protocol::Constant
   Transport = LanguageServer::Protocol::Transport
+  # rubocop:enable RubyLsp/UseLanguageServerAliases
 
   class Server
     extend T::Sig
@@ -22,6 +24,32 @@ module RubyLsp
       @mutex = T.let(Mutex.new, Mutex)
       @worker = T.let(new_worker, Thread)
 
+      # The messages queue includes requests and notifications to be sent to the client
+      @message_queue = T.let(Thread::Queue.new, Thread::Queue)
+
+      # Create a thread to watch the messages queue and send them to the client
+      @message_dispatcher = T.let(
+        Thread.new do
+          current_request_id = 1
+
+          loop do
+            message = @message_queue.pop
+            break if message.nil?
+
+            @mutex.synchronize do
+              case message
+              when Notification
+                @writer.write(method: message.message, params: message.params)
+              when Request
+                @writer.write(id: current_request_id, method: message.message, params: message.params)
+                current_request_id += 1
+              end
+            end
+          end
+        end,
+        Thread,
+      )
+
       Thread.main.priority = 1
     end
 
@@ -34,7 +62,7 @@ module RubyLsp
       @reader.read do |request|
         case request[:method]
         when "initialize", "initialized", "textDocument/didOpen", "textDocument/didClose", "textDocument/didChange"
-          result = Executor.new(@store).execute(request)
+          result = Executor.new(@store, @message_queue).execute(request)
           finalize_request(result, request)
         when "$/cancelRequest"
           # Cancel the job if it's still in the queue
@@ -42,6 +70,7 @@ module RubyLsp
         when "shutdown"
           warn("Shutting down Ruby LSP...")
 
+          @message_queue.close
           # Close the queue so that we can no longer receive items
           @job_queue.close
           # Clear any remaining jobs so that the thread can terminate
@@ -49,9 +78,10 @@ module RubyLsp
           @jobs.clear
           # Wait until the thread is finished
           @worker.join
+          @message_dispatcher.join
           @store.clear
 
-          finalize_request(Result.new(response: nil, notifications: []), request)
+          finalize_request(Result.new(response: nil), request)
         when "exit"
           # We return zero if shutdown has already been received or one otherwise as per the recommendation in the spec
           # https://microsoft.github.io/language-server-protocol/specification/#exit
@@ -62,8 +92,17 @@ module RubyLsp
           # Default case: push the request to the queue to be executed by the worker
           job = Job.new(request: request, cancelled: false)
 
-          # Remember a handle to the job, so that we can cancel it
-          @mutex.synchronize { @jobs[request[:id]] = job }
+          @mutex.synchronize do
+            # Remember a handle to the job, so that we can cancel it
+            @jobs[request[:id]] = job
+
+            # We must parse the document under a mutex lock or else we might switch threads and accept text edits in the
+            # source. Altering the source reference during parsing will put the parser in an invalid internal state,
+            # since it started parsing with one source but then it changed in the middle
+            uri = request.dig(:params, :textDocument, :uri)
+            @store.get(uri).parse if uri
+          end
+
           @job_queue << job
         end
       end
@@ -85,9 +124,9 @@ module RubyLsp
 
           result = if job.cancelled
             # We need to return nil to the client even if the request was cancelled
-            Result.new(response: nil, notifications: [])
+            Result.new(response: nil)
           else
-            Executor.new(@store).execute(request)
+            Executor.new(@store, @message_queue).execute(request)
           end
 
           finalize_request(result, request)
@@ -102,9 +141,6 @@ module RubyLsp
         error = result.error
         response = result.response
 
-        # If the response include any notifications, go through them and publish each one
-        result.notifications.each { |n| @writer.write(method: n.message, params: n.params) }
-
         if error
           @writer.write(
             id: request[:id],

data/lib/ruby_lsp/store.rb

@@ -9,8 +9,8 @@ module RubyLsp
   class Store
     extend T::Sig
 
-    sig { params(encoding: String).void }
-    attr_writer :encoding
+    sig { returns(String) }
+    attr_accessor :encoding
 
     sig { returns(String) }
     attr_accessor :formatter
@@ -18,7 +18,7 @@ module RubyLsp
     sig { void }
     def initialize
       @state = T.let({}, T::Hash[String, Document])
-      @encoding = T.let("utf-8", String)
+      @encoding = T.let(Constant::PositionEncodingKind::UTF8, String)
       @formatter = T.let("auto", String)
     end
 
@@ -27,19 +27,19 @@ module RubyLsp
       document = @state[uri]
       return document unless document.nil?
 
-      set(uri, File.binread(CGI.unescape(URI.parse(uri).path)))
+      set(uri: uri, source: File.binread(CGI.unescape(URI.parse(uri).path)), version: 0)
       T.must(@state[uri])
     end
 
-    sig { params(uri: String, content: String).void }
-    def set(uri, content)
-      document = Document.new(content, @encoding)
+    sig { params(uri: String, source: String, version: Integer).void }
+    def set(uri:, source:, version:)
+      document = Document.new(source: source, version: version, uri: uri, encoding: @encoding)
       @state[uri] = document
     end
 
-    sig { params(uri: String, edits: T::Array[Document::EditShape]).void }
-    def push_edits(uri, edits)
-      T.must(@state[uri]).push_edits(edits)
+    sig { params(uri: String, edits: T::Array[Document::EditShape], version: Integer).void }
+    def push_edits(uri:, edits:, version:)
+      T.must(@state[uri]).push_edits(edits, version: version)
     end
 
     sig { void }
@@ -61,7 +61,7 @@ module RubyLsp
       type_parameters(:T)
         .params(
           uri: String,
-          request_name: Symbol,
+          request_name: String,
           block: T.proc.params(document: Document).returns(T.type_parameter(:T)),
         ).returns(T.type_parameter(:T))
     end

data/lib/ruby_lsp/utils.rb

@@ -6,11 +6,14 @@ module RubyLsp
   VOID = T.let(Object.new.freeze, Object)
 
   # This freeze is not redundant since the interpolated string is mutable
-  WORKSPACE_URI = T.let("file://#{Dir.pwd}".freeze, String) # rubocop:disable Style/RedundantFreeze
+  WORKSPACE_URI = T.let(URI("file://#{Dir.pwd}".freeze), URI::Generic) # rubocop:disable Style/RedundantFreeze
 
   # A notification to be sent to the client
-  class Notification
+  class Message
     extend T::Sig
+    extend T::Helpers
+
+    abstract!
 
     sig { returns(String) }
     attr_reader :message
@@ -25,6 +28,9 @@ module RubyLsp
     end
   end
 
+  class Notification < Message; end
+  class Request < Message; end
+
   # The final result of running a request before its IO is finalized
   class Result
     extend T::Sig
@@ -32,9 +38,6 @@ module RubyLsp
     sig { returns(T.untyped) }
     attr_reader :response
 
-    sig { returns(T::Array[Notification]) }
-    attr_reader :notifications
-
     sig { returns(T.nilable(Exception)) }
     attr_reader :error
 
@@ -44,14 +47,12 @@ module RubyLsp
     sig do
       params(
         response: T.untyped,
-        notifications: T::Array[Notification],
         error: T.nilable(Exception),
         request_time: T.nilable(Float),
       ).void
     end
-    def initialize(response:, notifications:, error: nil, request_time: nil)
+    def initialize(response:, error: nil, request_time: nil)
       @response = response
-      @notifications = notifications
       @error = error
       @request_time = request_time
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-lsp
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.5.0
 platform: ruby
 authors:
 - Shopify
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-03-20 00:00:00.000000000 Z
+date: 2023-05-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: language_server-protocol
@@ -44,7 +44,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.0.2
+        version: 6.1.1
     - - "<"
       - !ruby/object:Gem::Version
         version: '7'
@@ -54,7 +54,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.0.2
+        version: 6.1.1
     - - "<"
       - !ruby/object:Gem::Version
         version: '7'
@@ -70,14 +70,20 @@ files:
 - README.md
 - VERSION
 - exe/ruby-lsp
+- lib/rubocop/cop/ruby_lsp/use_language_server_aliases.rb
 - lib/ruby-lsp.rb
+- lib/ruby_lsp/check_docs.rb
 - lib/ruby_lsp/document.rb
+- lib/ruby_lsp/event_emitter.rb
 - lib/ruby_lsp/executor.rb
+- lib/ruby_lsp/extension.rb
 - lib/ruby_lsp/internal.rb
+- lib/ruby_lsp/listener.rb
 - lib/ruby_lsp/requests.rb
 - lib/ruby_lsp/requests/base_request.rb
 - lib/ruby_lsp/requests/code_action_resolve.rb
 - lib/ruby_lsp/requests/code_actions.rb
+- lib/ruby_lsp/requests/code_lens.rb
 - lib/ruby_lsp/requests/diagnostics.rb
 - lib/ruby_lsp/requests/document_highlight.rb
 - lib/ruby_lsp/requests/document_link.rb
@@ -91,6 +97,7 @@ files:
 - lib/ruby_lsp/requests/selection_ranges.rb
 - lib/ruby_lsp/requests/semantic_highlighting.rb
 - lib/ruby_lsp/requests/support/annotation.rb
+- lib/ruby_lsp/requests/support/common.rb
 - lib/ruby_lsp/requests/support/highlight_target.rb
 - lib/ruby_lsp/requests/support/prefix_tree.rb
 - lib/ruby_lsp/requests/support/rails_document_client.rb
@@ -102,6 +109,7 @@ files:
 - lib/ruby_lsp/requests/support/semantic_token_encoder.rb
 - lib/ruby_lsp/requests/support/sorbet.rb
 - lib/ruby_lsp/requests/support/source_uri.rb
+- lib/ruby_lsp/requests/support/syntax_tree_formatting_runner.rb
 - lib/ruby_lsp/server.rb
 - lib/ruby_lsp/store.rb
 - lib/ruby_lsp/utils.rb
@@ -125,7 +133,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.4.12
 signing_key: 
 specification_version: 4
 summary: An opinionated language server for Ruby