solargraph 0.47.2 → 0.54.0

data/lib/solargraph/language_server/message/text_document.rb

@@ -12,9 +12,9 @@ module Solargraph
         autoload :DidSave,           'solargraph/language_server/message/text_document/did_save'
         autoload :Hover,             'solargraph/language_server/message/text_document/hover'
         autoload :SignatureHelp,     'solargraph/language_server/message/text_document/signature_help'
-        autoload :DiagnosticsQueue,  'solargraph/language_server/message/text_document/diagnostics_queue'
         autoload :OnTypeFormatting,  'solargraph/language_server/message/text_document/on_type_formatting'
         autoload :Definition,        'solargraph/language_server/message/text_document/definition'
+        autoload :TypeDefinition,    'solargraph/language_server/message/text_document/type_definition'
         autoload :DocumentSymbol,    'solargraph/language_server/message/text_document/document_symbol'
         autoload :Formatting,        'solargraph/language_server/message/text_document/formatting'
         autoload :References,        'solargraph/language_server/message/text_document/references'

data/lib/solargraph/language_server/message/workspace/did_change_configuration.rb

@@ -11,8 +11,12 @@ module Solargraph::LanguageServer::Message::Workspace
 
     private
 
+    # @return [void]
     def register_from_options
+      Solargraph.logger.debug "Registering capabilities from options: #{host.options.inspect}"
+      # @type [Array<String>]
       y = []
+      # @type [Array<String>]
       n = []
       (host.options['completion'] ? y : n).push('textDocument/completion')
       (host.options['hover'] ? y : n).push('textDocument/hover', 'textDocument/signatureHelp')
@@ -20,6 +24,7 @@ module Solargraph::LanguageServer::Message::Workspace
       (host.options['formatting'] ? y : n).push('textDocument/formatting')
       (host.options['symbols'] ? y : n).push('textDocument/documentSymbol', 'workspace/symbol')
       (host.options['definitions'] ? y : n).push('textDocument/definition')
+      (host.options['typeDefinitions'] ? y : n).push('textDocument/typeDefinition')
       (host.options['references'] ? y : n).push('textDocument/references')
       (host.options['folding'] ? y : n).push('textDocument/folding')
       (host.options['highlights'] ? y : n).push('textDocument/documentHighlight')

data/lib/solargraph/language_server/message/workspace/did_change_watched_files.rb

@@ -10,22 +10,29 @@ module Solargraph::LanguageServer::Message::Workspace
 
     def process
       need_catalog = false
+      to_create = []
+      to_delete = []
+
       # @param change [Hash]
       params['changes'].each do |change|
         if change['type'] == CREATED
-          host.create change['uri']
+          to_create << change['uri']
           need_catalog = true
         elsif change['type'] == CHANGED
           next if host.open?(change['uri'])
-          host.create change['uri']
+          to_create << change['uri']
           need_catalog = true
         elsif change['type'] == DELETED
-          host.delete change['uri']
+          to_delete << change['uri']
           need_catalog = true
         else
           set_error Solargraph::LanguageServer::ErrorCodes::INVALID_PARAMS, "Unknown change type ##{change['type']} for #{uri_to_file(change['uri'])}"
         end
       end
+
+      host.create *to_create
+      host.delete *to_delete
+
       # Force host to catalog libraries after file changes (see castwide/solargraph#139)
       host.catalog if need_catalog
     end

data/lib/solargraph/language_server/message.rb

@@ -66,6 +66,7 @@ module Solargraph
       register 'textDocument/didClose',               TextDocument::DidClose
       register 'textDocument/hover',                  TextDocument::Hover
       register 'textDocument/definition',             TextDocument::Definition
+      register 'textDocument/typeDefinition',         TextDocument::TypeDefinition
       register 'textDocument/formatting',             TextDocument::Formatting
       register 'textDocument/onTypeFormatting',       TextDocument::OnTypeFormatting
       register 'textDocument/documentSymbol',         TextDocument::DocumentSymbol

data/lib/solargraph/language_server/progress.rb

@@ -0,0 +1,118 @@
+# frozen_string_literal: true
+
+require 'securerandom'
+
+module Solargraph
+  module LanguageServer
+    # Progress notification handling for language server hosts.
+    #
+    class Progress
+      WAITING = :waiting
+      CREATED = :created
+      FINISHED = :finished
+
+      # @return [String]
+      attr_reader :uuid
+
+      # @return [String]
+      attr_reader :title
+
+      # @return [String, nil]
+      attr_reader :kind
+
+      # @return [String, nil]
+      attr_reader :message
+
+      # @return [Integer]
+      attr_reader :percentage
+
+      # @return [Symbol]
+      attr_reader :status
+
+      # @param title [String]
+      def initialize title
+        @title = title
+        @uuid = SecureRandom.uuid
+        @percentage = 0
+        @status = WAITING
+      end
+
+      # @param message [String]
+      # @param percentage [Integer]
+      def begin message, percentage
+        @kind = 'begin'
+        @message = message
+        @percentage = percentage
+      end
+
+      # @param message [String]
+      # @param percentage [Integer]
+      def report message, percentage
+        @kind = 'report'
+        @message = message
+        @percentage = percentage
+      end
+
+      # @param message [String]
+      def finish message
+        @kind = 'end'
+        @message = message
+        @percentage = 100
+        true
+      end
+
+      # @param host [Solargraph::LanguageServer::Host]
+      def send host
+        return unless host.client_supports_progress? && !finished?
+
+        message = build
+
+        create(host) unless created?
+        host.send_notification '$/progress', message
+        @status = FINISHED if kind == 'end'
+      end
+
+      def created?
+        [CREATED, FINISHED].include?(status)
+      end
+
+      def finished?
+        status == FINISHED
+      end
+
+      private
+
+      # @param host [Solargraph::LanguageServer::Host]
+      # @return [void]
+      def create host
+        return if created?
+
+        host.send_request 'window/workDoneProgress/create', { token: uuid }
+        @status = CREATED
+      end
+
+      def build
+        {
+          token: uuid,
+          value: {
+            kind: kind,
+            cancellable: false
+          }.merge(build_value)
+        }
+      end
+
+      def build_value
+        case kind
+        when 'begin'
+          { title: title, message: message, percentage: percentage }
+        when 'report'
+          { message: message, percentage: percentage }
+        when 'end'
+          { message: message }
+        else
+          raise "Invalid progress kind #{kind}"
+        end
+      end
+    end
+  end
+end

data/lib/solargraph/language_server/transport/adapter.rb

@@ -8,6 +8,17 @@ module Solargraph
       # A common module for running language servers in Backport.
       #
       module Adapter
+        # This runs in the context of Backport::Adapter, which
+        # provides write() - but if we didn't hide this behind a parse
+        # tag, it would override the one in the class.
+        #
+        # @!method write(text)
+        #   @abstract
+        #   Write the change to the specified text.
+        #   @param text [String] The text to be changed.
+        #   @return [String] The updated text.
+
+        # @return [void]
         def opening
           @host = Solargraph::LanguageServer::Host.new
           @host.add_observer self
@@ -18,15 +29,18 @@ module Solargraph
           end
         end
 
+        # @return [void]
         def closing
           @host.stop
         end
 
         # @param data [String]
+        # @return [void]
         def receiving data
           @data_reader.receive data
         end
 
+        # @return [void]
         def update
           if @host.stopped?
             shutdown
@@ -38,12 +52,13 @@ module Solargraph
 
         private
 
-        # @param request [String]
+        # @param request [Hash]
         # @return [void]
         def process request
           @host.process(request)
         end
 
+        # @return [void]
         def shutdown
           Backport.stop unless @host.options['transport'] == 'external'
         end

data/lib/solargraph/language_server/transport/data_reader.rb

@@ -16,6 +16,7 @@ module Solargraph
         # client.
         #
         # @yieldparam [Hash] The message received from the client
+        # @return [void]
         def set_message_handler &block
           @message_handler = block
         end
@@ -26,6 +27,7 @@ module Solargraph
         # will be buffered and subsequent data will be appended to the buffer.
         #
         # @param data [String]
+        # @return [void]
         def receive data
           data.each_char do |char|
             @buffer.concat char

data/lib/solargraph/language_server.rb

@@ -15,5 +15,6 @@ module Solargraph
     autoload :MessageTypes, 'solargraph/language_server/message_types'
     autoload :Request,      'solargraph/language_server/request'
     autoload :Transport,    'solargraph/language_server/transport'
+    autoload :Progress,     'solargraph/language_server/progress'
   end
 end