solargraph 0.51.2 → 0.54.2

data/lib/solargraph/gem_pins.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require 'rbs'
+
+module Solargraph
+  # A utility for building gem pins from a combination of YARD and RBS
+  # documentation.
+  #
+  module GemPins
+    # Build an array of pins from a gem specification. The process starts with
+    # YARD, enhances the resulting pins with RBS definitions, and appends RBS
+    # pins that don't exist in the YARD mapping.
+    #
+    # @param gemspec [Gem::Specification]
+    # @return [Array<Pin::Base>]
+    def self.build(gemspec)
+      yard_pins = build_yard_pins(gemspec)
+      rbs_map = RbsMap.from_gemspec(gemspec)
+      combine yard_pins, rbs_map
+    end
+
+    # @param yard_pins [Array<Pin::Base>]
+    # @param rbs_map [RbsMap]
+    # @return [Array<Pin::Base>]
+    def self.combine(yard_pins, rbs_map)
+      in_yard = Set.new
+      combined = yard_pins.map do |yard|
+        in_yard.add yard.path
+        next yard unless yard.is_a?(Pin::Method)
+
+        rbs = rbs_map.path_pin(yard.path, Pin::Method)
+        next yard unless rbs
+
+        # @sg-ignore
+        yard.class.new(
+          location: yard.location,
+          closure: yard.closure,
+          name: yard.name,
+          comments: yard.comments,
+          scope: yard.scope,
+          parameters: rbs.parameters,
+          generics: rbs.generics,
+          node: yard.node,
+          signatures: yard.signatures,
+          return_type: best_return_type(rbs.return_type, yard.return_type)
+        )
+      end
+      in_rbs = rbs_map.pins.reject { |pin| in_yard.include?(pin.path) }
+      combined + in_rbs
+    end
+
+    class << self
+      private
+
+      # @param gemspec [Gem::Specification]
+      # @return [Array<Pin::Base>]
+      def build_yard_pins(gemspec)
+        Yardoc.cache(gemspec) unless Yardoc.cached?(gemspec)
+        yardoc = Yardoc.load!(gemspec)
+        YardMap::Mapper.new(yardoc, gemspec).map
+      end
+
+      # Select the first defined type.
+      #
+      # @param choices [Array<ComplexType>]
+      # @return [ComplexType]
+      def best_return_type *choices
+        choices.find { |pin| pin.defined? } || choices.first || ComplexType::UNDEFINED
+      end
+    end
+  end
+end

data/lib/solargraph/language_server/host/diagnoser.rb

@@ -38,7 +38,7 @@ module Solargraph
 
         # Start the diagnosis thread.
         #
-        # @return [self]
+        # @return [self, nil]
         def start
           return unless @stopped
           @stopped = false
@@ -81,7 +81,7 @@ module Solargraph
         # @return [Mutex]
         attr_reader :mutex
 
-        # @return [Array]
+        # @return [::Array]
         attr_reader :queue
       end
     end

data/lib/solargraph/language_server/host/dispatch.rb

@@ -6,6 +6,12 @@ module Solargraph
       # Methods for associating sources with libraries via URIs.
       #
       module Dispatch
+        # @abstract
+        # @return [Host::Diagnoser]
+        def diagnoser
+          raise NotImplementedError, 'Host::Dispatch requires a diagnoser method'
+        end
+
         # @return [Sources]
         def sources
           @sources ||= begin
@@ -15,7 +21,7 @@ module Solargraph
           end
         end
 
-        # @return [Array<Library>]
+        # @return [::Array<Library>]
         def libraries
           @libraries ||= []
         end
@@ -27,9 +33,9 @@ module Solargraph
         # @return [void]
         def update_libraries uri
           src = sources.find(uri)
-          libraries.each do |lib|
-            lib.merge src if lib.contain?(src.filename)
-          end
+          using = libraries.select { |lib| lib.contain?(src.filename) }
+          using.push library_for(uri) if using.empty?
+          using.each { |lib| lib.merge src }
           diagnoser.schedule uri
         end
 
@@ -89,6 +95,10 @@ module Solargraph
           nil
         end
 
+        def options
+          @options ||= {}.freeze
+        end
+
         # Get a generic library for the given URI and attach the corresponding
         # source.
         #
@@ -103,7 +113,14 @@ module Solargraph
 
         # @return [Library]
         def generic_library
-          @generic_library ||= Solargraph::Library.new
+          @generic_library ||= Solargraph::Library.new(Solargraph::Workspace.new('', nil, options), nil)
+                                                  .tap { |lib| lib.add_observer self }
+        end
+
+        # @param library [Solargraph::Library]
+        # @return [void]
+        def update progress
+          progress&.send(self)
         end
       end
     end

data/lib/solargraph/language_server/host/message_worker.rb

@@ -3,10 +3,15 @@
 module Solargraph
   module LanguageServer
     class Host
-      # A serial worker Thread to handle message.
+      # A serial worker Thread to handle incoming messages.
       #
-      # this make check pending message possible, and maybe cancelled to speedup process
       class MessageWorker
+        UPDATE_METHODS = [
+          'textDocument/didOpen',
+          'textDocument/didChange',
+          'workspace/didChangeWatchedFiles'
+        ].freeze
+
         # @param host [Host]
         def initialize(host)
           @host = host
@@ -16,6 +21,7 @@ module Solargraph
         end
 
         # pending handle messages
+        # @return [Array<Hash>]
         def messages
           @messages ||= []
         end
@@ -24,11 +30,12 @@ module Solargraph
           @stopped
         end
 
+        # @return [void]
         def stop
           @stopped = true
         end
 
-        # @param message [Hash] The message should be handle. will pass back to Host#receive
+        # @param message [Hash] The message to handle. Will be forwarded to Host#receive
         # @return [void]
         def queue(message)
           @mutex.synchronize do
@@ -37,6 +44,7 @@ module Solargraph
           end
         end
 
+        # @return [void]
         def start
           return unless @stopped
           @stopped = false
@@ -45,13 +53,49 @@ module Solargraph
           end
         end
 
+        # @return [void]
         def tick
           message = @mutex.synchronize do
             @resource.wait(@mutex) if messages.empty?
-            messages.shift
+            next_message
           end
           handler = @host.receive(message)
-          handler && handler.send_response
+          handler&.send_response
+        end
+
+        private
+
+        def next_message
+          cancel_message || next_priority
+        end
+
+        def cancel_message
+          # Handle cancellations first
+          idx = messages.find_index { |msg| msg['method'] == '$/cancelRequest' }
+          return unless idx
+
+          msg = messages[idx]
+          messages.delete_at idx
+          msg
+        end
+
+        def next_priority
+          # Prioritize updates and version-dependent messages for performance
+          idx = messages.find_index do |msg|
+            UPDATE_METHODS.include?(msg['method']) || version_dependent?(msg)
+          end
+          return messages.shift unless idx
+
+          msg = messages[idx]
+          messages.delete_at idx
+          msg
+        end
+
+        # True if the message requires a previous update to have executed in
+        # order to work correctly.
+        #
+        def version_dependent? msg
+          msg['textDocument'] && msg['position']
         end
       end
     end

data/lib/solargraph/language_server/host/sources.rb

@@ -11,53 +11,10 @@ module Solargraph
         include Observable
         include UriHelpers
 
-        def initialize
-          @mutex = Mutex.new
-          @stopped = true
-          @has_uri = ConditionVariable.new
-        end
-
-        def stopped?
-          @stopped
-        end
-
-        # @return [void]
-        def start
-          return unless @stopped
-          @stopped = false
-          Thread.new do
-            tick until stopped?
-          end
-        end
-
-        # @return [void]
-        def tick
-          uri = mutex.synchronize { next_uri }
-
-          return if queue.include?(uri)
-          mutex.synchronize do
-            nxt = open_source_hash[uri].finish_synchronize
-            open_source_hash[uri] = nxt
-            changed
-            notify_observers uri
-          end
-        end
-
+        # @param uri [String]
         # @return [void]
         def add_uri(uri)
           queue.push(uri)
-          @has_uri.signal
-        end
-
-        # @return [String]
-        def next_uri
-          @has_uri.wait(mutex) if queue.empty?
-          queue.shift
-        end
-
-        # @return [void]
-        def stop
-          @stopped = true
         end
 
         # Open a source.
@@ -72,6 +29,8 @@ module Solargraph
           open_source_hash[uri] = source
         end
 
+        # @param uri [String]
+        # @return [void]
         def open_from_disk uri
           source = Solargraph::Source.load(UriHelpers.uri_to_file(uri))
           open_source_hash[uri] = source
@@ -81,25 +40,12 @@ module Solargraph
         #
         # @raise [FileNotFoundError] if the URI does not match an open source.
         #
-        # @param uri [String]
-        # @param updater [Source::Updater]
-        # @return [Source]
-        def update uri, updater
-          src = find(uri)
-          mutex.synchronize { open_source_hash[uri] = src.synchronize(updater) }
-          changed
-          notify_observers uri
-        end
-
         # @param uri [String]
         # @param updater [Source::Updater]
         # @return [void]
-        def async_update uri, updater
+        def update uri, updater
           src = find(uri)
-          mutex.synchronize do
-            open_source_hash[uri] = src.start_synchronize(updater)
-            add_uri(uri)
-          end
+          open_source_hash[uri] = src.synchronize(updater)
           changed
           notify_observers uri
         end
@@ -109,7 +55,7 @@ module Solargraph
         # @raise [FileNotFoundError] if the URI does not match an open source.
         #
         # @param uri [String]
-        # @return [Source]
+        # @return [Solargraph::Source]
         def find uri
           open_source_hash[uri] || raise(Solargraph::FileNotFoundError, "Host could not find #{uri}")
         end
@@ -136,17 +82,14 @@ module Solargraph
 
         private
 
-        # @return [Hash]
+        # @return [Hash{String => Solargraph::Source}]
         def open_source_hash
           @open_source_hash ||= {}
         end
 
-        # @return [Mutex]
-        attr_reader :mutex
-
         # An array of source URIs that are waiting to finish synchronizing.
         #
-        # @return [Array<String>]
+        # @return [::Array<String>]
         def queue
           @queue ||= []
         end

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'
@@ -26,10 +24,8 @@ module Solargraph
       attr_writer :client_capabilities
 
       def initialize
-        @cancel_semaphore = Mutex.new
         @buffer_semaphore = Mutex.new
         @request_mutex = Mutex.new
-        @cancel = []
         @buffer = String.new
         @stopped = true
         @next_request_id = 1
@@ -44,8 +40,6 @@ module Solargraph
         return unless stopped?
         @stopped = false
         diagnoser.start
-        cataloger.start
-        sources.start
         message_worker.start
       end
 
@@ -59,7 +53,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
@@ -69,7 +63,7 @@ module Solargraph
       # @param id [Integer]
       # @return [void]
       def cancel id
-        @cancel_semaphore.synchronize { @cancel.push id }
+        cancelled.push id
       end
 
       # True if the host received a request to cancel the method with the
@@ -78,9 +72,7 @@ module Solargraph
       # @param id [Integer]
       # @return [Boolean]
       def cancel? id
-        result = false
-        @cancel_semaphore.synchronize { result = @cancel.include? id }
-        result
+        cancelled.include? id
       end
 
       # Delete the specified ID from the list of cancelled IDs if it exists.
@@ -88,7 +80,7 @@ module Solargraph
       # @param id [Integer]
       # @return [void]
       def clear id
-        @cancel_semaphore.synchronize { @cancel.delete id }
+        cancelled.delete id
       end
 
       # Called by adapter, to handle the request
@@ -101,15 +93,15 @@ 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']}"
+          logger.info "Host received ##{request['id']} #{request['method']}"
           logger.debug request
           message = Message.select(request['method']).new(self, request)
           begin
-            message.process
+            message.process unless cancel?(request['id'])
           rescue StandardError => e
             logger.warn "Error processing request: [#{e.class}] #{e.message}"
             logger.warn e.backtrace.join("\n")
@@ -127,6 +119,7 @@ module Solargraph
         else
           logger.warn "Invalid message received."
           logger.debug request
+          nil
         end
       end
 
@@ -155,6 +148,7 @@ module Solargraph
       def delete *uris
         filenames = uris.map { |uri| uri_to_file(uri) }
         libraries.each do |lib|
+          lib.delete_observer self
           lib.delete(*filenames)
         end
         uris.each do |uri|
@@ -253,7 +247,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
 
@@ -292,9 +286,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,
@@ -323,6 +319,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
@@ -380,7 +377,6 @@ module Solargraph
           envelope = "Content-Length: #{json.bytesize}\r\n\r\n#{json}"
           queue envelope
           @next_request_id += 1
-          logger.info "Server sent #{method}"
           logger.debug params
         end
       end
@@ -457,9 +453,7 @@ module Solargraph
         return if @stopped
         @stopped = true
         message_worker.stop
-        cataloger.stop
         diagnoser.stop
-        sources.stop
         changed
         notify_observers
       end
@@ -492,6 +486,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] }
@@ -505,6 +517,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
@@ -632,7 +646,7 @@ module Solargraph
         requests.keys
       end
 
-      # @return [Hash{String => Object}]
+      # @return [Hash{String => [Boolean,String]}]
       def default_configuration
         {
           'completion' => true,
@@ -663,12 +677,22 @@ 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 [Array<Integer>]
+      def cancelled
+        @cancelled ||= []
+      end
+
       # @return [MessageWorker]
       def message_worker
         @message_worker ||= MessageWorker.new(self)
@@ -679,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
@@ -779,6 +798,9 @@ module Solargraph
           'textDocument/definition' => {
             definitionProvider: true
           },
+          'textDocument/typeDefinition' => {
+            typeDefinitionProvider: true
+          },
           'textDocument/references' => {
             referencesProvider: true
           },
@@ -810,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