solargraph 0.26.1 → 0.27.0

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

@@ -0,0 +1,68 @@
+module Solargraph
+  module LanguageServer
+    class Host
+      class Cataloger
+        def initialize host
+          @host = host
+          @mutex = Mutex.new
+          @stopped = true
+          @pings = []
+        end
+
+        # Notify the Cataloger that changes are pending.
+        #
+        # @return [void]
+        def ping
+          mutex.synchronize { pings.push nil }
+        end
+
+        def synchronizing?
+          !pings.empty?
+        end
+
+        # Stop the catalog thread.
+        #
+        # @return [void]
+        def stop
+          @stopped = true
+        end
+
+        # True if the cataloger is stopped.
+        #
+        # @return [Boolean]
+        def stopped?
+          @stopped
+        end
+
+        # Start the catalog thread.
+        #
+        # @return [void]
+        def start
+          return unless stopped?
+          @stopped = false
+          Thread.new do
+            until stopped?
+              sleep 0.1
+              next if pings.empty?
+              mutex.synchronize do
+                host.catalog
+                pings.clear
+              end
+            end
+          end
+        end
+
+        private
+
+        # @return [Host]
+        attr_reader :host
+
+        # @return [Mutex]
+        attr_reader :mutex
+
+        # @return [Array]
+        attr_reader :pings
+      end
+    end
+  end
+end

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

@@ -0,0 +1,85 @@
+module Solargraph
+  module LanguageServer
+    class Host
+      class Diagnoser
+        def initialize host
+          @host = host
+          @mutex = Mutex.new
+          @queue = []
+          @stopped = true
+        end
+
+        # Schedule a file to be diagnosed.
+        #
+        # @param uri [String]
+        # @return [void]
+        def schedule uri
+          mutex.synchronize { queue.push uri }
+        end
+
+        # Stop the diagnosis thread.
+        #
+        # @return [void]
+        def stop
+          @stopped = true
+        end
+
+        # True is the diagnoser is stopped.
+        #
+        # @return [Boolean]
+        def stopped?
+          @stopped
+        end
+
+        # Start the diagnosis thread.
+        #
+        # @return [self]
+        def start
+          return unless @stopped
+          @stopped = false
+          Thread.new do
+            until stopped?
+              sleep 0.1
+              next if queue.empty? || host.synchronizing?
+              if !host.options['diagnostics']
+                mutex.synchronize { queue.clear }
+                next
+              end
+              begin
+                current = nil
+                mutex.synchronize { current = queue.shift }
+                next if queue.include?(current)
+                results = []
+                results.concat host.diagnose(current) if host.open?(current)
+                host.send_notification "textDocument/publishDiagnostics", {
+                  uri: current,
+                  diagnostics: results
+                }
+                sleep 0.5
+              rescue DiagnosticsError => e
+                STDERR.puts "Error in diagnostics: #{e.message}"
+                options['diagnostics'] = false
+                host.send_notification 'window/showMessage', {
+                  type: LanguageServer::MessageTypes::ERROR,
+                  message: "Error in diagnostics: #{e.message}"
+                }
+              end
+            end
+          end
+          self
+        end
+
+        private
+
+        # @return [Host]
+        attr_reader :host
+
+        # @return [Mutex]
+        attr_reader :mutex
+
+        # @return [Array]
+        attr_reader :queue
+      end
+    end
+  end
+end

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

@@ -1,4 +1,4 @@
-require 'open3'
+require 'rubygems'
 
 module Solargraph
   module LanguageServer
@@ -10,30 +10,41 @@ module Solargraph
         #
         class CheckGemVersion < Base
           def process
-            o, s = Open3.capture2("gem search solargraph")
-            match = o.match(/solargraph \(([\d]*\.[\d]*\.[\d]*)\)/)
-            # @todo Error if no match or status code != 0
-            available = Gem::Version.new(match[1])
-            current = Gem::Version.new(Solargraph::VERSION)
-            if available > current
-              host.show_message_request "Solagraph gem version #{available} is available.",
-                                        LanguageServer::MessageTypes::INFO,
-                                        ['Update now'] do |result|
-                                          break unless result == 'Update now'
-                                          o, s = Open3.capture2("gem update solargraph")
-                                          if s == 0
-                                            host.show_message 'Successfully updated the Solargraph gem.', LanguageServer::MessageTypes::INFO
-                                          else
-                                            host.show_message 'An error occurred while updating the gem.', LanguageServer::MessageTypes::ERROR
-                                          end
-                                        end
-            elsif params['verbose']
-              host.show_message "The Solargraph gem is up to date (version #{Solargraph::VERSION})."
+            begin
+              fetcher = Gem::SpecFetcher.new
+              tuple = fetcher.search_for_dependency(Gem::Dependency.new('solargraph')).flatten.first
+              if tuple.nil?
+                msg = "An error occurred checking the Solargraph gem version."
+                STDERR.puts msg
+                host.show_message(msg, MessageTypes::ERROR) if params['verbose']
+              else
+                available = Gem::Version.new(tuple.version)
+                current = Gem::Version.new(Solargraph::VERSION)
+                if available > current
+                  host.show_message_request "Solagraph gem version #{available} is available.",
+                                            LanguageServer::MessageTypes::INFO,
+                                            ['Update now'] do |result|
+                                              break unless result == 'Update now'
+                                              o, s = Open3.capture2("gem update solargraph")
+                                              if s == 0
+                                                host.show_message 'Successfully updated the Solargraph gem.', LanguageServer::MessageTypes::INFO
+                                              else
+                                                host.show_message 'An error occurred while updating the gem.', LanguageServer::MessageTypes::ERROR
+                                              end
+                                            end
+                elsif params['verbose']
+                  host.show_message "The Solargraph gem is up to date (version #{Solargraph::VERSION})."
+                end
+                set_result({
+                  installed: current,
+                  available: available
+                })
+              end
+            rescue Errno::EADDRNOTAVAIL => e
+              msg = "Unable to connect to gem source: #{e.message}"
+              STDERR.puts msg
+              host.show_message(msg, MessageTypes::ERROR) if params['verbose']
             end
-            set_result({
-              installed: current,
-              available: available
-            })
           end
         end
       end

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

@@ -6,11 +6,7 @@ module Solargraph
       module TextDocument
         class Completion < Base
           def process
-            if host.changing?(params['textDocument']['uri'])
-              set_result empty_result(true)
-            else
-              inner_process
-            end
+            inner_process
           end
 
           private
@@ -26,16 +22,18 @@ module Solargraph
                 return set_result(empty_result) if host.cancel?(id)
               end
               items = []
-              idx = 0
+              last_context = nil
+              idx = -1
               completion.pins.each do |pin|
+                idx += 1 if last_context != pin.context
                 items.push pin.completion_item.merge({
                   textEdit: {
                     range: completion.range.to_hash,
                     newText: pin.name.sub(/=$/, ' = ')
                   },
-                  sortText: "#{pin.name}#{idx.to_s.rjust(4, '0')}"
+                  sortText: "#{idx.to_s.rjust(4, '0')}#{pin.name}"
                 })
-                idx += 1
+                last_context = pin.context
               end
               set_result(
                 isIncomplete: false,

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

@@ -2,7 +2,7 @@ class Solargraph::LanguageServer::Message::TextDocument::DocumentSymbol < Solarg
   include Solargraph::LanguageServer::UriHelpers
 
   def process
-    pins = host.file_symbols params['textDocument']['uri']
+    pins = host.document_symbols params['textDocument']['uri']
     info = pins.map do |pin|
       result = {
         name: pin.name,

data/lib/solargraph/language_server/message/workspace/did_change_watched_files.rb

@@ -22,7 +22,6 @@ module Solargraph::LanguageServer::Message::Workspace
         elsif change['type'] == DELETED
           host.delete change['uri']
         else
-          # @todo Handle error
           set_error Solargraph::LanguageServer::ErrorCodes::INVALID_PARAMS, "Unknown change type ##{change['type']} for #{uri_to_file(change['uri'])}"
         end
       end

data/lib/solargraph/language_server/transport/socket.rb

@@ -16,12 +16,10 @@ module Solargraph
         end
 
         def process request
-          Thread.new do
-            message = @host.start(request)
-            message.send_response
-            tmp = @host.flush
-            send_data tmp unless tmp.empty?
-          end
+          message = @host.start(request)
+          message.send_response
+          tmp = @host.flush
+          send_data tmp unless tmp.empty?
         end
 
         # @param data [String]

data/lib/solargraph/language_server/transport/stdio.rb

@@ -44,12 +44,10 @@ module Solargraph
         end
 
         def process request
-          Thread.new do
-            message = @host.start(request)
-            message.send_response
-            tmp = @host.flush
-            send_data tmp unless tmp.empty?
-          end
+          message = @host.start(request)
+          message.send_response
+          tmp = @host.flush
+          send_data tmp unless tmp.empty?
         end
 
         def start_timers

data/lib/solargraph/library.rb

@@ -1,11 +1,23 @@
+require 'set'
+
 module Solargraph
   # A library handles coordination between a Workspace and an ApiMap.
   #
   class Library
     # @param workspace [Solargraph::Workspace]
     def initialize workspace = Solargraph::Workspace.new(nil)
+      @mutex = Mutex.new
       @workspace = workspace
-      api_map
+      api_map.catalog bundle
+      @synchronized = true
+    end
+
+    # True if the ApiMap is up to date with the library's workspace and open
+    # files.
+    #
+    # @return [Boolean]
+    def synchronized?
+      @synchronized
     end
 
     # Open a file in the library. Opening a file will make it available for
@@ -14,20 +26,22 @@ module Solargraph
     # @param filename [String]
     # @param text [String]
     # @param version [Integer]
+    # @return [void]
     def open filename, text, version
-      source = Solargraph::Source.load_string(text, filename)
-      source.version = version
-      source_hash[filename] = source
-      workspace.merge source
-      api_map.refresh
+      mutex.synchronize do
+        source = Solargraph::Source.load_string(text, filename, version)
+        workspace.merge source
+        open_file_hash[filename] = source
+        catalog #unless api_map.try_merge!(source)
+      end
     end
 
-    # True if the specified file is currently open in the workspace.
+    # True if the specified file is currently open.
     #
     # @param filename [String]
     # @return [Boolean]
     def open? filename
-      source_hash.has_key? filename
+      open_file_hash.has_key? filename
     end
 
     # True if the specified file is included in the workspace (but not
@@ -39,18 +53,22 @@ module Solargraph
       workspace.has_file?(filename)
     end
 
-    # Create a file source to be added to the workspace. The file is ignored
-    # if the workspace is not configured to include the file.
+    # Create a source to be added to the workspace. The file is ignored if the
+    # workspace is not configured to include the file.
     #
     # @param filename [String]
     # @param text [String] The contents of the file
     # @return [Boolean] True if the file was added to the workspace.
     def create filename, text
-      return false unless workspace.would_merge?(filename)
-      source = Solargraph::Source.load_string(text, filename)
-      workspace.merge(source)
-      api_map.refresh
-      true
+      result = false
+      mutex.synchronize do
+        next unless workspace.would_merge?(filename)
+        source = Solargraph::Source.load_string(text, filename)
+        workspace.merge(source)
+        catalog #unless api_map.try_merge!(source)
+        result = true
+      end
+      result
     end
 
     # Create a file source from a file on disk. The file is ignored if the
@@ -59,12 +77,16 @@ module Solargraph
     # @param filename [String]
     # @return [Boolean] True if the file was added to the workspace.
     def create_from_disk filename
-      return false if File.directory?(filename) or !File.exist?(filename)
-      return false unless workspace.would_merge?(filename)
-      source = Solargraph::Source.load_string(File.read(filename), filename)
-      workspace.merge(source)
-      api_map.refresh
-      true
+      result = false
+      mutex.synchronize do
+        next if File.directory?(filename) or !File.exist?(filename)
+        next unless workspace.would_merge?(filename)
+        source = Solargraph::Source.load_string(File.read(filename), filename)
+        workspace.merge(source)
+        catalog #unless api_map.try_merge!(source)
+        result = true
+      end
+      result
     end
 
     # Delete a file from the library. Deleting a file will make it unavailable
@@ -72,35 +94,40 @@ module Solargraph
     # workspace configuration determines that it should still exist.
     #
     # @param filename [String]
+    # @return [void]
     def delete filename
-      source = source_hash[filename]
-      return if source.nil?
-      source_hash.delete filename
-      workspace.remove source
-      api_map.refresh
+      mutex.synchronize do
+        open_file_hash.delete filename
+        workspace.remove filename
+        catalog
+      end
     end
 
     # Close a file in the library. Closing a file will make it unavailable for
     # checkout although it may still exist in the workspace.
     #
     # @param filename [String]
+    # @return [void]
     def close filename
-      source_hash.delete filename
-      if workspace.has_file?(filename)
-        source = Solargraph::Source.load(filename)
-        workspace.merge source
+      mutex.synchronize do
+        open_file_hash.delete filename
+        catalog
       end
     end
 
     # @param filename [String]
     # @param version [Integer]
+    # @return [void]
     def overwrite filename, version
-      source = source_hash[filename]
-      return if source.nil?
-      if source.version > version
-        STDERR.puts "Save out of sync for #{filename} (current #{source.version}, overwrite #{version})" if source.version > version
-      else
-        open filename, File.read(filename), version
+      mutex.synchronize do
+        source = source_hash[filename]
+        return if source.nil?
+        if source.version > version
+          STDERR.puts "Save out of sync for #{filename} (current #{source.version}, overwrite #{version})" if source.version > version
+        else
+          open filename, File.read(filename), version
+        end
+        catalog
       end
     end
 
@@ -109,12 +136,12 @@ module Solargraph
     # @param filename [String] The file to analyze
     # @param line [Integer] The zero-based line number
     # @param column [Integer] The zero-based column number
-    # @return [ApiMap::Completion]
+    # @return [SourceMap::Completion]
+    # @todo Take a Location instead of filename/line/column
     def completions_at filename, line, column
-      source = read(filename)
-      api_map.virtualize source
-      fragment = source.fragment_at(line, column)
-      fragment.complete(api_map)
+      position = Position.new(line, column)
+      cursor = Source::Cursor.new(checkout(filename), position)
+      api_map.clip(cursor).complete
     end
 
     # Get definition suggestions for the expression at the specified file and
@@ -124,11 +151,11 @@ module Solargraph
     # @param line [Integer] The zero-based line number
     # @param column [Integer] The zero-based column number
     # @return [Array<Solargraph::Pin::Base>]
+    # @todo Take filename/position instead of filename/line/column
     def definitions_at filename, line, column
-      source = read(filename)
-      api_map.virtualize source
-      fragment = source.fragment_at(line, column)
-      fragment.define(api_map)
+      position = Position.new(line, column)
+      cursor = Source::Cursor.new(checkout(filename), position)
+      api_map.clip(cursor).define
     end
 
     # Get signature suggestions for the method at the specified file and
@@ -138,37 +165,33 @@ module Solargraph
     # @param line [Integer] The zero-based line number
     # @param column [Integer] The zero-based column number
     # @return [Array<Solargraph::Pin::Base>]
+    # @todo Take filename/position instead of filename/line/column
     def signatures_at filename, line, column
-      source = read(filename)
-      api_map.virtualize source
-      fragment = source.fragment_at(line, column)
-      fragment.signify(api_map)
+      position = Position.new(line, column)
+      cursor = Source::Cursor.new(checkout(filename), position)
+      api_map.clip(cursor).signify
     end
 
     # @param filename [String]
     # @param line [Integer]
     # @param column [Integer]
-    # @return [Array<Solargraph::Source::Range>]
+    # @return [Array<Solargraph::Range>]
+    # @todo Take a Location instead of filename/line/column
     def references_from filename, line, column
-      source = read(filename)
-      api_map.virtualize source
-      fragment = source.fragment_at(line, column)
-      pins = fragment.define(api_map)
+      clip = api_map.clip_at(filename, Position.new(line, column))
+      pins = clip.define
       return [] if pins.empty?
       result = []
-      # @param pin [Solargraph::Pin::Base]
       pins.uniq.each do |pin|
-        if pin.kind != Solargraph::Pin::NAMESPACE and !pin.location.nil?
-          mn_loc = get_symbol_name_location(pin)
-          result.push mn_loc unless mn_loc.nil?
-        end
-        (workspace.sources + source_hash.values).uniq(&:filename).each do |source|
+        (workspace.sources + open_file_hash.values).uniq.each do |source|
           found = source.references(pin.name)
           found.select do |loc|
             referenced = definitions_at(loc.filename, loc.range.ending.line, loc.range.ending.character)
             referenced.any?{|r| r.path == pin.path}
           end
-          result.concat found.sort{|a, b| a.range.start.line <=> b.range.start.line}
+          result.concat(found.sort{ |a, b|
+            a.range.start.line <=> b.range.start.line
+          })
         end
       end
       result
@@ -176,6 +199,7 @@ module Solargraph
 
     # Get the pin at the specified location or nil if the pin does not exist.
     #
+    # @param location [Location]
     # @return [Solargraph::Pin::Base]
     def locate_pin location
       api_map.locate_pin location
@@ -200,16 +224,7 @@ module Solargraph
     # @param filename [String]
     # @return [Source]
     def checkout filename
-      if filename.nil?
-        api_map.virtualize nil
-        nil
-      else
-        read filename
-      end
-    end
-
-    def refresh force = false
-      api_map.refresh force
+      read filename
     end
 
     # @param query [String]
@@ -232,10 +247,17 @@ module Solargraph
       api_map.query_symbols query
     end
 
+    # Get an array of document symbols.
+    #
+    # Document symbols are composed of namespace, method, and constant pins.
+    # The results of this query are appropriate for building the response to a
+    # textDocument/documentSymbol message in the language server protocol.
+    #
     # @param filename [String]
     # @return [Array<Solargraph::Pin::Base>]
-    def file_symbols filename
-      read(filename).all_symbols
+    def document_symbols filename
+      return [] unless open_file_hash.has_key?(filename)
+      api_map.document_symbols(filename)
     end
 
     # @param path [String]
@@ -244,10 +266,26 @@ module Solargraph
       api_map.get_path_suggestions(path)
     end
 
+    # Update a source in the library from the provided updater.
+    #
+    # @note This method will not update the library's ApiMap. See
+    #   Library#ynchronized? and Library#catalog for more information.
+    #
+    #
+    # @raise [FileNotFoundError] if the updater's file is not available.
     # @param updater [Solargraph::Source::Updater]
-    def synchronize updater, reparse = true
-      source = read(updater.filename)
-      source.synchronize updater, reparse
+    # @return [void]
+    def update updater
+      mutex.synchronize do
+        if workspace.has_file?(updater.filename)
+          workspace.synchronize!(updater)
+          open_file_hash[updater.filename] = workspace.source(updater.filename) if open?(updater.filename)
+        else
+          raise FileNotFoundError, "Unable to update #{updater.filename}" unless open?(updater.filename)
+          open_file_hash[updater.filename] = open_file_hash[updater.filename].synchronize(updater)
+        end
+        @synchronized = false
+      end
     end
 
     # Get the current text of a file in the library.
@@ -278,6 +316,14 @@ module Solargraph
       result
     end
 
+    # Update the ApiMap from the library's workspace and open files.
+    #
+    # @return [void]
+    def catalog
+      api_map.catalog bundle
+      @synchronized = true
+    end
+
     # Create a library from a directory.
     #
     # @param directory [String] The path to be used for the workspace
@@ -288,14 +334,27 @@ module Solargraph
 
     private
 
-    # @return [Hash<String, Solargraph::Source>]
-    def source_hash
-      @source_hash ||= {}
-    end
+    # @return [Mutex]
+    attr_reader :mutex
 
-    # @return [Solargraph::ApiMap]
+    # @return [ApiMap]
     def api_map
-      @api_map ||= Solargraph::ApiMap.new(workspace)
+      @api_map ||= Solargraph::ApiMap.new
+    end
+
+    # @return [YardMap]
+    def yard_map
+      @yard_map ||= Solargraph::YardMap.new
+    end
+
+    # @return [Bundle]
+    def bundle
+      Bundle.new(
+        sources: (workspace.sources + open_file_hash.values).uniq(&:filename),
+        required: workspace.config.required,
+        load_paths: workspace.require_paths,
+        yard_map: yard_map
+      )
     end
 
     # @return [Solargraph::Workspace]
@@ -303,6 +362,14 @@ module Solargraph
       @workspace
     end
 
+    # A collection of files that are currently open in the library. Open
+    # files do not need to be in the workspace.
+    #
+    # @return [Hash{String => Source}]
+    def open_file_hash
+      @open_file_hash ||= {}
+    end
+
     # Get the source for an open file or create a new source if the file
     # exists on disk. Sources created from disk are not added to the open
     # workspace files, i.e., the version on disk remains the authoritative
@@ -312,23 +379,9 @@ module Solargraph
     # @param filename [String]
     # @return [Solargraph::Source]
     def read filename
-      return source_hash[filename] if open?(filename)
-      return workspace.source(filename) if workspace.has_file?(filename)
-      raise FileNotFoundError, "File not found: #{filename}" unless File.file?(filename)
-      Solargraph::Source.load(filename)
-    end
-
-    def get_symbol_name_location pin
-      decsrc = read(pin.location.filename)
-      offset = Solargraph::Source::Position.to_offset(decsrc.code, pin.location.range.start)
-      soff = decsrc.code.index(pin.name, offset)
-      eoff = soff + pin.name.length
-      Solargraph::Source::Location.new(
-        pin.location.filename, Solargraph::Source::Range.new(
-          Solargraph::Source::Position.from_offset(decsrc.code, soff),
-          Solargraph::Source::Position.from_offset(decsrc.code, eoff)
-        )
-      )
+      return open_file_hash[filename] if open_file_hash.has_key?(filename)
+      raise FileNotFoundError, "File not found: #{filename}" unless workspace.has_file?(filename)
+      workspace.source(filename)
     end
   end
 end