solargraph 0.51.2 → 0.54.2

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

@@ -16,7 +16,7 @@ module Solargraph
         # @return [String]
         attr_reader :method
 
-        # @return [Hash]
+        # @return [Hash{String => Array, Hash, String, Integer}]
         attr_reader :params
 
         # @return [Hash, Array, nil]
@@ -61,18 +61,11 @@ module Solargraph
         # @return [void]
         def send_response
           return if id.nil?
-          if host.cancel?(id)
-            # https://microsoft.github.io/language-server-protocol/specifications/specification-current/#cancelRequest
-            # cancel should send response RequestCancelled
-            Solargraph::Logging.logger.info "Cancelled response to #{method}"
-            set_result nil
-            set_error ErrorCodes::REQUEST_CANCELLED, "cancelled by client"
-          else
-            Solargraph::Logging.logger.info "Sending response to #{method}"
-          end
+
+          accept_or_cancel
           response = {
-            jsonrpc: "2.0",
-            id: id,
+            jsonrpc: '2.0',
+            id: id
           }
           response[:result] = result unless result.nil?
           response[:error] = error unless error.nil?
@@ -83,6 +76,20 @@ module Solargraph
           host.queue envelope
           host.clear id
         end
+
+        private
+
+        def accept_or_cancel
+          if host.cancel?(id)
+            # https://microsoft.github.io/language-server-protocol/specifications/specification-current/#cancelRequest
+            # cancel should send response RequestCancelled
+            Solargraph::Logging.logger.info "Cancelled response to ##{id} #{method}"
+            set_result nil
+            set_error ErrorCodes::REQUEST_CANCELLED, 'Cancelled by client'
+          else
+            Solargraph::Logging.logger.info "Sending response to ##{id} #{method}"
+          end
+        end
       end
     end
   end

data/lib/solargraph/language_server/message/completion_item/resolve.rb

@@ -29,7 +29,7 @@ module Solargraph
           end
 
           # @param text [String]
-          # @return [Hash{Symbol => String}]
+          # @return [Hash{Symbol => String}, nil]
           def markup_content text
             return nil if text.strip.empty?
             {
@@ -38,6 +38,8 @@ module Solargraph
             }
           end
 
+          # @param pins [Array<Pin::Base>]
+          # @return [String]
           def join_docs pins
             result = []
             last_link = nil

data/lib/solargraph/language_server/message/extended/check_gem_version.rb

@@ -1,6 +1,11 @@
 # frozen_string_literal: true
 
-require 'rubygems'
+
+# @todo PR the RBS gem to add this
+# @!parse
+#   module ::Gem
+#    class SpecFetcher; end
+#   end
 
 module Solargraph
   module LanguageServer
@@ -11,16 +16,23 @@ module Solargraph
         # is true, notify the client when the gem is up to date.
         #
         class CheckGemVersion < Base
+          # @return [Gem::SpecFetcher]
           def self.fetcher
             @fetcher ||= Gem::SpecFetcher.new
           end
 
+          # @param obj [Gem::SpecFetcher]
+          # @return [Gem::SpecFetcher]
           def self.fetcher= obj
             @fetcher = obj
           end
 
           GEM_ZERO = Gem::Version.new('0.0.0')
 
+          # @param host [Solargraph::LanguageServer::Host]
+          # @param request [Hash]
+          # @param current [Gem::Version]
+          # @param available [Gem::Version, nil]
           def initialize host, request, current: Gem::Version.new(Solargraph::VERSION), available: nil
             super(host, request)
             @current = current

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

@@ -47,6 +47,8 @@ module Solargraph
 
         private
 
+        # @todo '?' methods should type like RBS 'boolish' rather than a strict true or false
+        # @sg-ignore
         def support_workspace_folders?
           params['capabilities'] &&
             params['capabilities']['workspace'] &&
@@ -54,6 +56,7 @@ module Solargraph
             params['workspaceFolders']
         end
 
+        # @return [Hash{Symbol => undefined}]
         def static_completion
           return {} unless host.options['completion']
           {
@@ -64,6 +67,7 @@ module Solargraph
           }
         end
 
+        # @return [Hash{Symbol => BasicObject}]
         def static_code_action
           {
             codeActionProvider: true,
@@ -71,6 +75,7 @@ module Solargraph
           }
         end
 
+        # @return [Hash{Symbol => BasicObject}]
         def static_signature_help
           {
             signatureHelpProvider: {
@@ -79,6 +84,7 @@ module Solargraph
           }
         end
 
+        # @return [Hash{Symbol => Hash{Symbol => String, Array<String>}}]
         def static_on_type_formatting
           {
             documentOnTypeFormattingProvider: {
@@ -88,6 +94,7 @@ module Solargraph
           }
         end
 
+        # @return [Hash{Symbol => Boolean}]
         def static_hover
           return {} unless host.options['hover']
           {
@@ -95,6 +102,7 @@ module Solargraph
           }
         end
 
+        # @return [Hash{Symbol => Boolean}]
         def static_document_formatting
           return {} unless host.options['formatting']
           {
@@ -102,6 +110,7 @@ module Solargraph
           }
         end
 
+        # @return [Hash{Symbol => Boolean}]
         def static_document_symbols
           return {} unless host.options['symbols']
           {
@@ -109,12 +118,14 @@ module Solargraph
           }
         end
 
+        # @return [Hash{Symbol => Boolean}]
         def static_workspace_symbols
           {
             workspaceSymbolProvider: true
           }
         end
 
+        # @return [Hash{Symbol => Boolean}]
         def static_definitions
           return {} unless host.options['definitions']
           {
@@ -122,19 +133,23 @@ module Solargraph
           }
         end
 
+        # @return [Hash{Symbol => Boolean}]
         def static_type_definitions
-          return {} unless host.options['type_definitions']
+          return {} unless host.options['typeDefinitions']
           {
-            definitionProvider: true
+            typeDefinitionProvider: true
           }
         end
 
+        # @return [Hash{Symbol => Hash{Symbol => Boolean}}]
         def static_rename
           {
             renameProvider: {prepareProvider: true}
           }
         end
 
+
+        # @return [Hash{Symbol => Boolean}]
         def static_references
           return {} unless host.options['references']
           {
@@ -142,6 +157,7 @@ module Solargraph
           }
         end
 
+        # @return [Hash{Symbol => Boolean}]
         def static_folding_range
           return {} unless host.options['folding']
           {
@@ -149,6 +165,7 @@ module Solargraph
           }
         end
 
+        # @return [Hash{Symbol => Boolean}]
         def static_highlights
           {
             documentHighlightProvider: true

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

@@ -12,9 +12,6 @@ module Solargraph
             col = params['position']['character']
             begin
               completion = host.completions_at(params['textDocument']['uri'], line, col)
-              if host.cancel?(id)
-                return set_result(empty_result) if host.cancel?(id)
-              end
               items = []
               last_context = nil
               idx = -1

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

@@ -13,10 +13,10 @@ module Solargraph::LanguageServer::Message::TextDocument
     def code_location
       suggestions = host.definitions_at(params['textDocument']['uri'], @line, @column)
       return nil if suggestions.empty?
-      suggestions.reject { |pin| pin.location.nil? || pin.location.filename.nil? }.map do |pin|
+      suggestions.reject { |pin| pin.best_location.nil? || pin.best_location.filename.nil? }.map do |pin|
         {
-          uri: file_to_uri(pin.location.filename),
-          range: pin.location.range.to_hash
+          uri: file_to_uri(pin.best_location.filename),
+          range: pin.best_location.range.to_hash
         }
       end
     end

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

@@ -6,15 +6,15 @@ class Solargraph::LanguageServer::Message::TextDocument::DocumentSymbol < Solarg
   def process
     pins = host.document_symbols params['textDocument']['uri']
     info = pins.map do |pin|
-      next nil unless pin.location&.filename
+      next nil unless pin.best_location&.filename
 
       result = {
         name: pin.name,
         containerName: pin.namespace,
         kind: pin.symbol_kind,
         location: {
-          uri: file_to_uri(pin.location.filename),
-          range: pin.location.range.to_hash
+          uri: file_to_uri(pin.best_location.filename),
+          range: pin.best_location.range.to_hash
         },
         deprecated: pin.deprecated?
       }

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

@@ -70,6 +70,7 @@ module Solargraph
 
           def formatter_class(config)
             if self.class.const_defined?('BlankRubocopFormatter')
+              # @sg-ignore
               BlankRubocopFormatter
             else
               require_rubocop(config['version'])

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

@@ -21,7 +21,7 @@ module Solargraph
               parts.push pin.documentation unless pin.documentation.nil? || pin.documentation.empty?
               unless parts.empty?
                 data = parts.join("\n\n")
-                next if contents.last && contents.last.end_with?(data)
+                next if contents.last&.end_with?(data)
                 contents.push data
               end
               last_link = this_link unless this_link.nil?
@@ -37,6 +37,8 @@ module Solargraph
 
           private
 
+          # @param contents [Array<String>]
+          # @return [Hash{Symbol => Hash{Symbol => String}}, nil]
           def contents_or_nil contents
             stripped = contents
               .map(&:strip)

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

@@ -13,10 +13,10 @@ module Solargraph::LanguageServer::Message::TextDocument
     def code_location
       suggestions = host.type_definitions_at(params['textDocument']['uri'], @line, @column)
       return nil if suggestions.empty?
-      suggestions.reject { |pin| pin.location.nil? || pin.location.filename.nil? }.map do |pin|
+      suggestions.reject { |pin| pin.best_location.nil? || pin.best_location.filename.nil? }.map do |pin|
         {
-          uri: file_to_uri(pin.location.filename),
-          range: pin.location.range.to_hash
+          uri: file_to_uri(pin.best_location.filename),
+          range: pin.best_location.range.to_hash
         }
       end
     end

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

@@ -12,7 +12,6 @@ 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'

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/workspace_symbol.rb

@@ -6,14 +6,14 @@ class Solargraph::LanguageServer::Message::Workspace::WorkspaceSymbol < Solargra
   def process
     pins = host.query_symbols(params['query'])
     info = pins.map do |pin|
-      uri = file_to_uri(pin.location.filename)
+      uri = file_to_uri(pin.best_location.filename)
       {
         name: pin.path,
         containerName: pin.namespace,
         kind: pin.symbol_kind,
         location: {
           uri: uri,
-          range: pin.location.range.to_hash
+          range: pin.best_location.range.to_hash
         },
         deprecated: pin.deprecated?
       }

data/lib/solargraph/language_server/progress.rb

@@ -0,0 +1,135 @@
+# 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)
+        host.send_notification '$/progress', message
+        @status = FINISHED if kind == 'end'
+        keep_alive host
+      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
+
+      # @param host [Host]
+      def keep_alive host
+        mutex.synchronize { @last = Time.now }
+        @keep_alive ||= Thread.new do
+          until finished?
+            sleep 10
+            break if finished?
+            next if mutex.synchronize { Time.now - @last < 10 }
+            send host
+          end
+        end
+      end
+
+      def mutex
+        @mutex ||= Mutex.new
+      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