solargraph 0.47.2 → 0.54.0

data/lib/solargraph/language_server/host.rb

@@ -3,7 +3,6 @@
 require 'diff/lcs'
 require 'observer'
 require 'securerandom'
-require 'set'
 
 module Solargraph
   module LanguageServer
@@ -13,7 +12,6 @@ module Solargraph
     #
     class Host
       autoload :Diagnoser,     'solargraph/language_server/host/diagnoser'
-      autoload :Cataloger,     'solargraph/language_server/host/cataloger'
       autoload :Sources,       'solargraph/language_server/host/sources'
       autoload :Dispatch,      'solargraph/language_server/host/dispatch'
       autoload :MessageWorker, 'solargraph/language_server/host/message_worker'
@@ -44,8 +42,6 @@ module Solargraph
         return unless stopped?
         @stopped = false
         diagnoser.start
-        cataloger.start
-        sources.start
         message_worker.start
       end
 
@@ -59,7 +55,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 +97,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 +123,44 @@ 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_observer self
+          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.
@@ -249,7 +251,7 @@ module Solargraph
       # @return [void]
       def change params
         updater = generate_updater(params)
-        sources.async_update params['textDocument']['uri'], updater
+        sources.update params['textDocument']['uri'], updater
         diagnoser.schedule params['textDocument']['uri']
       end
 
@@ -288,9 +290,11 @@ 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)
+          lib.add_observer self
           libraries.push lib
-          async_library_map lib
+          library_map lib
         rescue WorkspaceTooLargeError => e
           send_notification 'window/showMessage', {
             'type' => Solargraph::LanguageServer::MessageTypes::WARNING,
@@ -319,6 +323,7 @@ module Solargraph
         # @param lib [Library]
         libraries.delete_if do |lib|
           next false if lib.workspace.directory != directory
+          lib.delete_observer self
           true
         end
       end
@@ -453,9 +458,7 @@ module Solargraph
         return if @stopped
         @stopped = true
         message_worker.stop
-        cataloger.stop
         diagnoser.stop
-        sources.stop
         changed
         notify_observers
       end
@@ -488,6 +491,24 @@ module Solargraph
         end
         if params['data']['path']
           result.concat library.path_pins(params['data']['path'])
+          # @todo This exception is necessary because `Library#path_pins` does
+          #   not perform a namespace method query, so the implicit `.new` pin
+          #   might not exist.
+          if result.empty? && params['data']['path'] =~ /\.new$/
+            result.concat(library.path_pins(params['data']['path'].sub(/\.new$/, '#initialize')).map do |pin|
+              next pin unless pin.name == 'initialize'
+
+              Pin::Method.new(
+                name: 'new',
+                scope: :class,
+                location: pin.location,
+                parameters: pin.parameters,
+                return_type: ComplexType.try_parse(params['data']['path']),
+                comments: pin.comments,
+                closure: pin.closure
+              )
+            end)
+          end
         end
         # Selecting by both location and path can result in duplicate pins
         result.uniq { |p| [p.path, p.location] }
@@ -501,6 +522,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 +552,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 +651,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,10 +682,15 @@ module Solargraph
         libraries.each(&:catalog)
       end
 
+      # @return [Hash{String => Hash{String => Boolean}}]
       def client_capabilities
         @client_capabilities ||= {}
       end
 
+      def client_supports_progress?
+        client_capabilities['window'] && client_capabilities['window']['workDoneProgress']
+      end
+
       private
 
       # @return [MessageWorker]
@@ -665,15 +703,10 @@ module Solargraph
         @diagnoser ||= Diagnoser.new(self)
       end
 
-      # @return [Cataloger]
-      def cataloger
-        @cataloger ||= Cataloger.new(self)
-      end
-
       # 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 +725,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 +798,9 @@ module Solargraph
           'textDocument/definition' => {
             definitionProvider: true
           },
+          'textDocument/typeDefinition' => {
+            typeDefinitionProvider: true
+          },
           'textDocument/references' => {
             referencesProvider: true
           },
@@ -796,69 +832,28 @@ module Solargraph
         client_capabilities['rename'] && client_capabilities['rename']['prepareSupport']
       end
 
-      def client_supports_progress?
-        client_capabilities['window'] && client_capabilities['window']['workDoneProgress']
-      end
-
       # @param library [Library]
       # @return [void]
-      def async_library_map library
+      def library_map library
         return if library.mapped?
-        Thread.new do
-          if client_supports_progress?
-            uuid = SecureRandom.uuid
-            send_request 'window/workDoneProgress/create', {
-              token: uuid
-            } do |response|
-              do_async_library_map library, response.nil? ? uuid : nil
-            end
-          else
-            do_async_library_map library
-          end
-        end
+        Thread.new { sync_library_map library }
       end
 
-      def do_async_library_map library, uuid = nil
+      # @param library [Library]
+      # @param uuid [String, nil]
+      # @return [void]
+      def sync_library_map library
         total = library.workspace.sources.length
-        if uuid
-          send_notification '$/progress', {
-            token: uuid,
-            value: {
-              kind: 'begin',
-              title: "Mapping workspace",
-              message: "0/#{total} files",
-              cancellable: false,
-              percentage: 0
-            }
-          }
-        end
-        pct = 0
-        mod = 10
+        progress = Progress.new('Mapping workspace')
+        progress.begin "0/#{total} files", 0
+        progress.send self
         while library.next_map
-          next unless uuid
-          cur = ((library.source_map_hash.keys.length.to_f / total.to_f) * 100).to_i
-          if cur > pct && cur % mod == 0
-            pct = cur
-            send_notification '$/progress', {
-              token: uuid,
-              value: {
-                kind: 'report',
-                cancellable: false,
-                message: "#{library.source_map_hash.keys.length}/#{total} files",
-                percentage: pct
-              }
-            }
-          end
-        end
-        if uuid
-          send_notification '$/progress', {
-            token: uuid,
-            value: {
-              kind: 'end',
-              message: 'Mapping complete'
-            }
-          }
+          pct = ((library.source_map_hash.keys.length.to_f / total) * 100).to_i
+          progress.report "#{library.source_map_hash.keys.length}/#{total} files", pct
+          progress.send self
         end
+        progress.finish 'done'
+        progress.send self
       end
     end
   end

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]

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')
@@ -44,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'] &&
@@ -51,6 +56,7 @@ module Solargraph
             params['workspaceFolders']
         end
 
+        # @return [Hash{Symbol => undefined}]
         def static_completion
           return {} unless host.options['completion']
           {
@@ -61,6 +67,7 @@ module Solargraph
           }
         end
 
+        # @return [Hash{Symbol => BasicObject}]
         def static_code_action
           {
             codeActionProvider: true,
@@ -68,6 +75,7 @@ module Solargraph
           }
         end
 
+        # @return [Hash{Symbol => BasicObject}]
         def static_signature_help
           {
             signatureHelpProvider: {
@@ -76,6 +84,7 @@ module Solargraph
           }
         end
 
+        # @return [Hash{Symbol => Hash{Symbol => String, Array<String>}}]
         def static_on_type_formatting
           {
             documentOnTypeFormattingProvider: {
@@ -85,6 +94,7 @@ module Solargraph
           }
         end
 
+        # @return [Hash{Symbol => Boolean}]
         def static_hover
           return {} unless host.options['hover']
           {
@@ -92,6 +102,7 @@ module Solargraph
           }
         end
 
+        # @return [Hash{Symbol => Boolean}]
         def static_document_formatting
           return {} unless host.options['formatting']
           {
@@ -99,6 +110,7 @@ module Solargraph
           }
         end
 
+        # @return [Hash{Symbol => Boolean}]
         def static_document_symbols
           return {} unless host.options['symbols']
           {
@@ -106,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']
           {
@@ -119,12 +133,23 @@ module Solargraph
           }
         end
 
+        # @return [Hash{Symbol => Boolean}]
+        def static_type_definitions
+          return {} unless host.options['typeDefinitions']
+          {
+            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']
           {
@@ -132,6 +157,7 @@ module Solargraph
           }
         end
 
+        # @return [Hash{Symbol => Boolean}]
         def static_folding_range
           return {} unless host.options['folding']
           {
@@ -139,6 +165,7 @@ module Solargraph
           }
         end
 
+        # @return [Hash{Symbol => Boolean}]
         def static_highlights
           {
             documentHighlightProvider: 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,
             ]
@@ -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

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