solargraph 0.47.2 → 0.53.3

data/lib/solargraph/language_server/host.rb

@@ -3,7 +3,6 @@
 require 'diff/lcs'
 require 'observer'
 require 'securerandom'
-require 'set'
 
 module Solargraph
   module LanguageServer
@@ -59,7 +58,7 @@ module Solargraph
         logger.level = LOG_LEVELS[options['logLevel']] || DEFAULT_LOG_LEVEL
       end
 
-      # @return [Hash]
+      # @return [Hash{String => [Boolean, String]}]
       def options
         @options ||= default_configuration
       end
@@ -101,8 +100,8 @@ module Solargraph
       # Start processing a request from the client. After the message is
       # processed, caller is responsible for sending the response.
       #
-      # @param request [Hash] The contents of the message.
-      # @return [Solargraph::LanguageServer::Message::Base] The message handler.
+      # @param request [Hash{String => unspecified}] The contents of the message.
+      # @return [Solargraph::LanguageServer::Message::Base, nil] The message handler.
       def receive request
         if request['method']
           logger.info "Server received #{request['method']}"
@@ -127,38 +126,43 @@ module Solargraph
         else
           logger.warn "Invalid message received."
           logger.debug request
+          nil
         end
       end
 
-      # Respond to a notification that a file was created in the workspace.
-      # The libraries will determine whether the file should be merged; see
+      # Respond to a notification that files were created in the workspace.
+      # The libraries will determine whether the files should be merged; see
       # Solargraph::Library#create_from_disk.
       #
-      # @param uri [String] The file uri.
-      # @return [Boolean] True if a library accepted the file.
-      def create uri
-        filename = uri_to_file(uri)
+      # @param uris [Array<String>] The URIs of the files.
+      # @return [Boolean] True if at least one library accepted at least one file.
+      def create *uris
+        filenames = uris.map { |uri| uri_to_file(uri) }
         result = false
         libraries.each do |lib|
-          result = true if lib.create_from_disk(filename)
+          result = true if lib.create_from_disk(*filenames)
+        end
+        uris.each do |uri|
+          diagnoser.schedule uri if open?(uri)
         end
-        diagnoser.schedule uri if open?(uri)
         result
       end
 
-      # Delete the specified file from the library.
+      # Delete the specified files from the library.
       #
-      # @param uri [String] The file uri.
+      # @param uris [Array<String>] The file uris.
       # @return [void]
-      def delete uri
-        filename = uri_to_file(uri)
+      def delete *uris
+        filenames = uris.map { |uri| uri_to_file(uri) }
         libraries.each do |lib|
-          lib.delete(filename)
+          lib.delete(*filenames)
+        end
+        uris.each do |uri|
+          send_notification "textDocument/publishDiagnostics", {
+            uri: uri,
+            diagnostics: []
+          }
         end
-        send_notification "textDocument/publishDiagnostics", {
-          uri: uri,
-          diagnostics: []
-        }
       end
 
       # Open the specified file in the library.
@@ -288,7 +292,8 @@ module Solargraph
         path = ''
         path = normalize_separators(directory) unless directory.nil?
         begin
-          lib = Solargraph::Library.load(path, name)
+          workspace = Solargraph::Workspace.new(path, nil, options)
+          lib = Solargraph::Library.new(workspace, name)
           libraries.push lib
           async_library_map lib
         rescue WorkspaceTooLargeError => e
@@ -501,6 +506,8 @@ module Solargraph
         library.read_text(filename)
       end
 
+      # @param uri [String]
+      # @return [Hash]
       def formatter_config uri
         library = library_for(uri)
         library.workspace.config.formatter
@@ -529,6 +536,15 @@ module Solargraph
         library.definitions_at(uri_to_file(uri), line, column)
       end
 
+      # @param uri [String]
+      # @param line [Integer]
+      # @param column [Integer]
+      # @return [Array<Solargraph::Pin::Base>]
+      def type_definitions_at uri, line, column
+        library = library_for(uri)
+        library.type_definitions_at(uri_to_file(uri), line, column)
+      end
+
       # @param uri [String]
       # @param line [Integer]
       # @param column [Integer]
@@ -619,17 +635,18 @@ module Solargraph
         requests.keys
       end
 
-      # @return [Hash{String => Object}]
+      # @return [Hash{String => [Boolean,String]}]
       def default_configuration
         {
           'completion' => true,
           'hover' => true,
           'symbols' => true,
           'definitions' => true,
+          'typeDefinitions' => true,
           'rename' => true,
           'references' => true,
           'autoformat' => false,
-          'diagnostics' => false,
+          'diagnostics' => true,
           'formatting' => false,
           'folding' => true,
           'highlights' => true,
@@ -649,6 +666,7 @@ module Solargraph
         libraries.each(&:catalog)
       end
 
+      # @return [Hash{String => BasicObject}]
       def client_capabilities
         @client_capabilities ||= {}
       end
@@ -673,7 +691,7 @@ module Solargraph
       # A hash of client requests by ID. The host uses this to keep track of
       # pending responses.
       #
-      # @return [Hash{Integer => Hash}]
+      # @return [Hash{Integer => Solargraph::LanguageServer::Host}]
       def requests
         @requests ||= {}
       end
@@ -692,7 +710,7 @@ module Solargraph
         params['contentChanges'].each do |recvd|
           chng = check_diff(params['textDocument']['uri'], recvd)
           changes.push Solargraph::Source::Change.new(
-            (chng['range'].nil? ? 
+            (chng['range'].nil? ?
               nil :
               Solargraph::Range.from_to(chng['range']['start']['line'], chng['range']['start']['character'], chng['range']['end']['line'], chng['range']['end']['character'])
             ),
@@ -765,6 +783,9 @@ module Solargraph
           'textDocument/definition' => {
             definitionProvider: true
           },
+          'textDocument/typeDefinition' => {
+            typeDefinitionProvider: true
+          },
           'textDocument/references' => {
             referencesProvider: true
           },
@@ -818,6 +839,9 @@ module Solargraph
         end
       end
 
+      # @param library [Library]
+      # @param uuid [String, nil]
+      # @return [void]
       def do_async_library_map library, uuid = nil
         total = library.workspace.sources.length
         if uuid

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/extended/download_core.rb

@@ -10,11 +10,7 @@ module Solargraph
         #
         class DownloadCore < Base
           def process
-            ver = Solargraph::YardMap::CoreDocs.best_download
-            Solargraph::YardMap::CoreDocs.download ver
-            host.show_message "Downloaded documentation for Ruby #{ver}.", LanguageServer::MessageTypes::INFO
-          rescue StandardError => e
-            host.show_message "An error occurred while downloading documentation: [#{e.class}] #{e.message}", LanguageServer::MessageTypes::ERROR
+            host.show_message "Downloading cores is deprecated. Solargraph currently uses RBS for core and stdlib documentation", LanguageServer::MessageTypes::INFO
           end
         end
       end

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

@@ -25,6 +25,8 @@ module Solargraph
               }
             }
           }
+          # FIXME: lsp default is utf-16, may have different position
+          result[:capabilities][:positionEncoding] = "utf-32" if params.dig("capabilities", "general", "positionEncodings")&.include?("utf-32")
           result[:capabilities].merge! static_completion unless dynamic_registration_for?('textDocument', 'completion')
           result[:capabilities].merge! static_signature_help unless dynamic_registration_for?('textDocument', 'signatureHelp')
           # result[:capabilities].merge! static_on_type_formatting unless dynamic_registration_for?('textDocument', 'onTypeFormatting')
@@ -32,6 +34,7 @@ module Solargraph
           result[:capabilities].merge! static_document_formatting unless dynamic_registration_for?('textDocument', 'formatting')
           result[:capabilities].merge! static_document_symbols unless dynamic_registration_for?('textDocument', 'documentSymbol')
           result[:capabilities].merge! static_definitions unless dynamic_registration_for?('textDocument', 'definition')
+          result[:capabilities].merge! static_type_definitions unless dynamic_registration_for?('textDocument', 'typeDefinition')
           result[:capabilities].merge! static_rename unless dynamic_registration_for?('textDocument', 'rename')
           result[:capabilities].merge! static_references unless dynamic_registration_for?('textDocument', 'references')
           result[:capabilities].merge! static_workspace_symbols unless dynamic_registration_for?('workspace', 'symbol')
@@ -51,6 +54,7 @@ module Solargraph
             params['workspaceFolders']
         end
 
+        # @return [Hash{Symbol => undefined}]
         def static_completion
           return {} unless host.options['completion']
           {
@@ -61,6 +65,7 @@ module Solargraph
           }
         end
 
+        # @return [Hash{Symbol => BasicObject}]
         def static_code_action
           {
             codeActionProvider: true,
@@ -68,6 +73,7 @@ module Solargraph
           }
         end
 
+        # @return [Hash{Symbol => BasicObject}]
         def static_signature_help
           {
             signatureHelpProvider: {
@@ -119,6 +125,13 @@ module Solargraph
           }
         end
 
+        def static_type_definitions
+          return {} unless host.options['typeDefinitions']
+          {
+            typeDefinitionProvider: true
+          }
+        end
+
         def static_rename
           {
             renameProvider: {prepareProvider: true}

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

@@ -13,6 +13,7 @@ module Solargraph
             textDocument/formatting
             textDocument/documentSymbol
             textDocument/definition
+            textDocument/typeDefinition
             textDocument/references
             textDocument/rename
             textDocument/prepareRename

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

@@ -6,6 +6,8 @@ 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
+
       result = {
         name: pin.name,
         containerName: pin.namespace,
@@ -17,7 +19,8 @@ class Solargraph::LanguageServer::Message::TextDocument::DocumentSymbol < Solarg
         deprecated: pin.deprecated?
       }
       result
-    end
+    end.compact
+
     set_result info
   end
 end

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

@@ -17,17 +17,17 @@ module Solargraph
             args = cli_args(file_uri, config)
 
             require_rubocop(config['version'])
-            options, paths = RuboCop::Options.new.parse(args)
+            options, paths = ::RuboCop::Options.new.parse(args)
             options[:stdin] = original
             corrections = redirect_stdout do
-              RuboCop::Runner.new(options, RuboCop::ConfigStore.new).run(paths)
+              ::RuboCop::Runner.new(options, ::RuboCop::ConfigStore.new).run(paths)
             end
             result = options[:stdin]
 
             log_corrections(corrections)
 
             format original, result
-          rescue RuboCop::ValidationError, RuboCop::ConfigNotFoundError => e
+          rescue ::RuboCop::ValidationError, ::RuboCop::ConfigNotFoundError => e
             set_error(Solargraph::LanguageServer::ErrorCodes::INTERNAL_ERROR, "[#{e.class}] #{e.message}")
           end
 
@@ -54,7 +54,7 @@ module Solargraph
           def cli_args file_uri, config
             file = UriHelpers.uri_to_file(file_uri)
             args = [
-              config['cops'] == 'all' ? '--auto-correct-all' : '--auto-correct',
+              config['cops'] == 'all' ? '-A' : '-a',
               '--cache', 'false',
               '--format', formatter_class(config).name,
             ]

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

@@ -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/signature_help.rb

@@ -9,13 +9,8 @@ module Solargraph
             line = params['position']['line']
             col = params['position']['character']
             suggestions = host.signatures_at(params['textDocument']['uri'], line, col)
-            info = []
-            suggestions.each do |pin|
-              info.concat pin.overloads.map(&:signature_help)
-              info.push pin.signature_help
-            end
             set_result({
-              signatures: info
+              signatures: suggestions.flat_map { |pin| pin.signature_help }
             })
           rescue FileNotFoundError => e
             Logging.logger.warn "[#{e.class}] #{e.message}"

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Solargraph::LanguageServer::Message::TextDocument
+  class TypeDefinition < Base
+    def process
+      @line = params['position']['line']
+      @column = params['position']['character']
+      set_result(code_location || [])
+    end
+
+    private
+
+    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|
+        {
+          uri: file_to_uri(pin.location.filename),
+          range: pin.location.range.to_hash
+        }
+      end
+    end
+  end
+end

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/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