solargraph 0.30.2 → 0.31.0

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

@@ -1,6 +1,8 @@
 module Solargraph
   module LanguageServer
     class Host
+      # An asynchronous library cataloging handler.
+      #
       class Cataloger
         def initialize host
           @host = host
@@ -11,10 +13,12 @@ module Solargraph
 
         # Notify the Cataloger that changes are pending.
         #
+        # @param lib [Library] The library that needs cataloging
         # @return [void]
         def ping lib
           mutex.synchronize { pings.push lib }
         end
+        alias schedule ping
 
         def synchronizing?
           !pings.empty?
@@ -42,17 +46,23 @@ module Solargraph
           @stopped = false
           Thread.new do
             until stopped?
-              sleep 0.1
-              next if pings.empty?
-              mutex.synchronize do
-                lib = pings.shift
-                next if pings.include?(lib)
-                host.catalog lib
-              end
+              tick
+              sleep 0.01
             end
           end
         end
 
+        # Perform cataloging.
+        #
+        # @return [void]
+        def tick
+          return if pings.empty?
+          mutex.synchronize do
+            lib = pings.shift
+            lib.catalog unless pings.include?(lib)
+          end
+        end
+
         private
 
         # @return [Host]

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

@@ -1,7 +1,10 @@
 module Solargraph
   module LanguageServer
     class Host
+      # An asynchronous diagnosis reporter.
+      #
       class Diagnoser
+        # @param host [Host]
         def initialize host
           @host = host
           @mutex = Mutex.new
@@ -39,22 +42,28 @@ module Solargraph
           @stopped = false
           Thread.new do
             until stopped?
+              tick
               sleep 0.1
-              next if queue.empty? || host.synchronizing?
-              if !host.options['diagnostics']
-                mutex.synchronize { queue.clear }
-                next
-              end
-              current = nil
-              mutex.synchronize { current = queue.shift }
-              next if queue.include?(current)
-              host.diagnose current
-              sleep 0.5
             end
           end
           self
         end
 
+        # Perform diagnoses.
+        #
+        # @return [void]
+        def tick
+          return if queue.empty? || host.synchronizing?
+          if !host.options['diagnostics']
+            mutex.synchronize { queue.clear }
+            return
+          end
+          current = nil
+          mutex.synchronize { current = queue.shift }
+          return if queue.include?(current)
+          host.diagnose current
+        end
+
         private
 
         # @return [Host]

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

@@ -0,0 +1,110 @@
+module Solargraph
+  module LanguageServer
+    class Host
+      # Methods for associating sources with libraries via URIs.
+      #
+      module Dispatch
+        # @return [Sources]
+        def sources
+          @sources ||= begin
+            src = Sources.new
+            src.add_observer self, :update_libraries
+            src
+          end
+        end
+
+        # @return [Array<Library>]
+        def libraries
+          @libraries ||= []
+        end
+
+        # The Sources observer callback that merges a source into the host's
+        # libraries when it gets updated.
+        #
+        # @param src [Source]
+        # @return [void]
+        def update_libraries src
+          # @todo This module should not call cataloger and diagnoser
+          libraries.each do |lib|
+            lib.merge src
+            cataloger.ping(lib) if lib.contain?(src.filename) || lib.open?(src.filename)
+          end
+          diagnoser.schedule file_to_uri(src.filename) if src.synchronized?
+        end
+
+        # Find the best libary match for the given URI.
+        #
+        # @param uri [String]
+        # @return [Library]
+        def library_for uri
+          explicit_library_for(uri) ||
+            implicit_library_for(uri) ||
+            generic_library_for(uri)
+        end
+
+        # Find an explicit library match for the given URI. An explicit match
+        # means the libary's workspace includes the file.
+        #
+        # If a matching library is found, the source corresponding to the URI
+        # gets attached to it.
+        #
+        # @raise [FileNotFoundError] if the source could not be attached.
+        #
+        # @param uri [String]
+        # @return [Library, nil]
+        def explicit_library_for uri
+          filename = UriHelpers.uri_to_file(uri)
+          libraries.each do |lib|
+            if lib.contain?(filename)
+              lib.attach sources.find(uri) if sources.include?(uri)
+              return lib
+            end
+          end
+          nil
+        end
+
+        # Find an implicit library match for the given URI. An implicit match
+        # means the file is located inside the library's workspace directory,
+        # regardless of whether the workspace is configured to include it.
+        #
+        # If a matching library is found, the source corresponding to the URI
+        # gets attached to it.
+        #
+        # @raise [FileNotFoundError] if the source could not be attached.
+        #
+        # @param uri [String]
+        # @return [Library, nil]
+        def implicit_library_for uri
+          filename = UriHelpers.uri_to_file(uri)
+          libraries.each do |lib|
+            # @todo We probably shouldn't depend on attachments to select
+            #   a library.
+            # return lib if lib.open?(filename)
+            if filename.start_with?(lib.workspace.directory)
+              lib.attach sources.find(uri)
+              return lib
+            end
+          end
+          nil
+        end
+
+        # Get a generic library for the given URI and attach the corresponding
+        # source.
+        #
+        # @raise [FileNotFoundError] if the source could not be attached.
+        #
+        # @param uri [String]
+        # @return [Library]
+        def generic_library_for uri
+          generic_library.attach sources.find(uri)
+          generic_library
+        end
+
+        # @return [Library]
+        def generic_library
+          @generic_library ||= Solargraph::Library.new
+        end
+      end
+    end
+  end
+end

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

@@ -1,38 +1,137 @@
+require 'observer'
+
 module Solargraph
   module LanguageServer
     class Host
+      # A Host class for managing sources.
+      #
       class Sources
+        include Observable
         include UriHelpers
 
+        def initialize
+          @stopped = true
+        end
+
+        def stopped?
+          @stopped
+        end
+
+        # @return [void]
+        def start
+          return unless @stopped
+          @stopped = false
+          Thread.new do
+            until stopped?
+              tick
+              sleep 0.25 if queue.empty?
+            end
+          end
+        end
+
+        # @return [void]
+        def tick
+          return if queue.empty?
+          uri = mutex.synchronize { queue.shift }
+          return if queue.include?(uri)
+          mutex.synchronize do
+            nxt = open_source_hash[uri].finish_synchronize
+            open_source_hash[uri] = nxt
+            changed
+            notify_observers open_source_hash[uri]
+          end
+        end
+
+        # @return [void]
+        def stop
+          @stopped = true
+        end
+
+        # Open a source.
+        #
+        # @param uri [String]
+        # @param text [String]
+        # @param version [Integer]
+        # @return [Source]
         def open uri, text, version
           filename = uri_to_file(uri)
           source = Solargraph::Source.new(text, filename, version)
           open_source_hash[uri] = source
         end
 
+        # Update an existing source.
+        #
+        # @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)
-          open_source_hash[uri] = src.synchronize(updater)
+          mutex.synchronize { open_source_hash[uri] = src.synchronize(updater) }
+          changed
+          notify_observers open_source_hash[uri]
+        end
+
+        # @param uri [String]
+        # @param updater [Source::Updater]
+        # @return [Thread]
+        def async_update uri, updater
+          src = find(uri)
+          mutex.synchronize { open_source_hash[uri] = src.start_synchronize(updater) }
+          mutex.synchronize { queue.push uri }
+          changed
+          notify_observers open_source_hash[uri]
         end
 
+        # Find the source with the given URI.
+        #
+        # @raise [FileNotFoundError] if the URI does not match an open source.
+        #
+        # @param uri [String]
         # @return [Source]
         def find uri
           open_source_hash[uri] || raise(Solargraph::FileNotFoundError, "Host could not find #{uri}")
         end
 
+        # Close the source with the given URI.
+        #
+        # @param uri [String]
+        # @return [void]
         def close uri
           open_source_hash.delete uri
         end
 
+        # True if a source with given URI is currently open.
+        # @param uri [String]
+        # @return [Boolean]
         def include? uri
           open_source_hash.key? uri
         end
 
+        # @return [void]
+        def clear
+          open_source_hash.clear
+        end
+
         private
 
+        # @return [Array<Source>]
         def open_source_hash
           @open_source_hash ||= {}
         end
+
+        # @return [Mutex]
+        def mutex
+          @mutex ||= Mutex.new
+        end
+
+        # An array of source URIs that are waiting to finish synchronizing.
+        #
+        # @return [Array<String>]
+        def queue
+          @queue ||= []
+        end
       end
     end
   end

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

@@ -58,18 +58,22 @@ module Solargraph
 
         # @return [void]
         def send_response
-          unless id.nil? or host.cancel?(id)
-            response = {
-              jsonrpc: "2.0",
-              id: id,
-            }
-            response[:result] = result unless result.nil?
-            response[:error] = error unless error.nil?
-            response[:result] = nil if result.nil? and error.nil?
-            json = response.to_json
-            envelope = "Content-Length: #{json.bytesize}\r\n\r\n#{json}"
-            host.queue envelope
+          return if id.nil?
+          if host.cancel?(id)
+            Solargraph::Logging.logger.info "Cancelled response to #{method}"
+            return
           end
+          Solargraph::Logging.logger.info "Sending response to #{method}"
+          response = {
+            jsonrpc: "2.0",
+            id: id,
+          }
+          response[:result] = result unless result.nil?
+          response[:error] = error unless error.nil?
+          response[:result] = nil if result.nil? and error.nil?
+          json = response.to_json
+          envelope = "Content-Length: #{json.bytesize}\r\n\r\n#{json}"
+          host.queue envelope
           host.clear id
         end
       end

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

@@ -36,7 +36,7 @@ module Solargraph
                 host.show_message "The Solargraph gem is up to date (version #{Solargraph::VERSION})."
               end
             elsif fetched?
-              STDERR.puts error
+              Solargraph::Logging.logger.warn error
               host.show_message(error, MessageTypes::ERROR) if params['verbose']
             end
             set_result({

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

@@ -1,39 +1,44 @@
+require 'benchmark'
+
 module Solargraph
   module LanguageServer
     module Message
       class Initialize < Base
         def process
-          host.configure params['initializationOptions']
-          if support_workspace_folders?
-            host.prepare_folders params['workspaceFolders']
-          elsif params['rootUri']
-            host.prepare UriHelpers.uri_to_file(params['rootUri'])
-          else
-            host.prepare params['rootPath']
-          end
-          result = {
-            capabilities: {
-              textDocumentSync: 2, # @todo What should this be?
-              workspace: {
-                workspaceFolders: {
-                  supported: true,
-                  changeNotifications: true
+          bm = Benchmark.measure {
+            host.configure params['initializationOptions']
+            if support_workspace_folders?
+              host.prepare_folders params['workspaceFolders']
+            elsif params['rootUri']
+              host.prepare UriHelpers.uri_to_file(params['rootUri'])
+            else
+              host.prepare params['rootPath']
+            end
+            result = {
+              capabilities: {
+                textDocumentSync: 2, # @todo What should this be?
+                workspace: {
+                  workspaceFolders: {
+                    supported: true,
+                    changeNotifications: true
+                  }
                 }
               }
             }
+            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')
+            result[:capabilities].merge! static_hover unless dynamic_registration_for?('textDocument', 'hover')
+            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_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')
+            result[:capabilities].merge! static_folding_range unless dynamic_registration_for?('textDocument', 'foldingRange')
+            set_result result
           }
-          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')
-          result[:capabilities].merge! static_hover unless dynamic_registration_for?('textDocument', 'hover')
-          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_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')
-          result[:capabilities].merge! static_folding_range unless dynamic_registration_for?('textDocument', 'foldingRange')
-          set_result result
+          Solargraph.logger.unknown "Solargraph initialized (#{bm.real} seconds)"
         end
 
         private