solargraph 0.18.2 → 0.18.3

data/lib/solargraph/api_map/source_to_yard.rb

@@ -18,6 +18,7 @@ module Solargraph
         code_object_map.clear
         sources.each do |s|
           s.namespace_pins.each do |pin|
+            next if pin.path.empty?
             if pin.kind == Solargraph::Suggestion::CLASS
               code_object_map[pin.path] ||= YARD::CodeObjects::ClassObject.new(root_code_object, pin.path)
             else
@@ -26,9 +27,9 @@ module Solargraph
             code_object_map[pin.path].docstring = pin.docstring unless pin.docstring.nil?
             code_object_map[pin.path].files.push pin.source.filename
           end
-          s.namespace_includes.each_pair do |n, i|
-            i.each do |inc|
-              code_object_map[n].instance_mixins.push code_object_map[inc] unless code_object_map[inc].nil? or code_object_map[n].nil?
+          s.namespace_pins.each do |pin|
+            pin.include_references.each do |ref|
+              code_object_map[pin.path].instance_mixins.push code_object_map[ref.name] unless code_object_map[ref.name].nil? or code_object_map[pin.path].nil?
             end
           end
           s.attribute_pins.each do |pin|

data/lib/solargraph/diagnostics/rubocop.rb

@@ -2,6 +2,7 @@ require 'open3'
 require 'shellwords'
 
 module Solargraph
+
   module Diagnostics
     class Rubocop
       def initialize
@@ -13,10 +14,10 @@ module Solargraph
           cmd = "rubocop -f j -s #{Shellwords.escape(filename)}"
           o, e, s = Open3.capture3(cmd, stdin_data: text)
           make_array text, JSON.parse(o)
+        rescue JSON::ParserError
+          raise DiagnosticsError, 'RuboCop returned invalid data'
         rescue Exception => e
-          STDERR.puts "#{e}"
-          STDERR.puts "#{e.backtrace}"
-          nil
+          raise DiagnosticsError, 'An internal error occurred while running diagnostics'
         end
       end
 

data/lib/solargraph/language_server/host.rb

@@ -1,4 +1,3 @@
-# require 'rubocop'
 require 'thread'
 require 'set'
 
@@ -10,18 +9,15 @@ module Solargraph
     class Host
       include Solargraph::LanguageServer::UriHelpers
 
-      # @return [Solargraph::Library]
-      attr_reader :library
-
       def initialize
         @change_semaphore = Mutex.new
+        @cancel_semaphore = Mutex.new
         @buffer_semaphore = Mutex.new
         @change_queue = []
         @diagnostics_queue = []
         @cancel = []
         @buffer = ''
         @stopped = false
-        @library = nil # @todo How to initialize the library
         start_change_thread
         start_diagnostics_thread
       end
@@ -37,15 +33,17 @@ module Solargraph
       end
 
       def cancel id
-        @cancel.push id
+        @cancel_semaphore.synchronize { @cancel.push id }
       end
 
       def cancel? id
-        @cancel.include? id
+        result = false
+        @cancel_semaphore.synchronize { result = @cancel.include? id }
+        result
       end
 
       def clear id
-        @cancel.delete id
+        @cancel_semaphore.synchronize { @cancel.delete id }
       end
 
       def start request
@@ -53,37 +51,69 @@ module Solargraph
         begin
           message.process
         rescue Exception => e
-          STDERR.puts e.message
-          STDERR.puts e.backtrace
-          message.set_error Solargraph::LanguageServer::ErrorCodes::INTERNAL_ERROR, e.message
+          message.set_error Solargraph::LanguageServer::ErrorCodes::INTERNAL_ERROR, "[#{e.class}] #{e.message}"
         end
         message
       end
 
       def create uri
-        filename = uri_to_file(uri)
-        library.create filename, File.read(filename)
+        @change_semaphore.synchronize do
+          filename = uri_to_file(uri)
+          library.create filename, File.read(filename)
+        end
       end
 
       def delete uri
-        filename = uri_to_file(uri)
-        library.delete filename
+        @change_semaphore.synchronize do
+          filename = uri_to_file(uri)
+          library.delete filename
+        end
       end
 
       def open uri, text, version
-        library.open uri_to_file(uri), text, version
-        @change_semaphore.synchronize { @diagnostics_queue.push uri }
+        @change_semaphore.synchronize do
+          library.open uri_to_file(uri), text, version
+          @diagnostics_queue.push uri
+        end
+      end
+
+      def open? uri
+        result = nil
+        @change_semaphore.synchronize do
+          result = library.open?(uri_to_file(uri))
+        end
+        result
+      end
+
+      def close uri
+        @change_semaphore.synchronize do
+          library.close uri_to_file(uri)
+        end
+      end
+
+      def save params
+        @change_semaphore.synchronize do
+          uri = params['textDocument']['uri']
+          filename = uri_to_file(uri)
+          version = params['textDocument']['version']
+          @change_queue.delete_if do |change|
+            return true if change['textDocument']['uri'] == uri and change['textDocument']['version'] <= version
+            false
+          end
+          library.overwrite filename, version
+        end
       end
 
       def change params
         @change_semaphore.synchronize do
-          if changing? params['textDocument']['uri']
+          if unsafe_changing? params['textDocument']['uri']
             @change_queue.push params
           else
             source = library.checkout(uri_to_file(params['textDocument']['uri']))
             @change_queue.push params
             if params['textDocument']['version'] == source.version + params['contentChanges'].length
-              source.synchronize(params['contentChanges'], params['textDocument']['version'])
+              updater = generate_updater(params)
+              library.synchronize updater
               library.refresh
               @change_queue.pop
               @diagnostics_queue.push params['textDocument']['uri']
@@ -128,7 +158,11 @@ module Solargraph
       end
 
       def changing? file_uri
-        @change_queue.any?{|change| change['textDocument']['uri'] == file_uri}
+        result = false
+        @change_semaphore.synchronize do
+          result = unsafe_changing?(file_uri)
+        end
+        result
       end
 
       def stop
@@ -139,12 +173,6 @@ module Solargraph
         @stopped
       end
 
-      def synchronize &block
-        @change_semaphore.synchronize do
-          block.call
-        end
-      end
-
       def locate_pin params
         pin = nil
         @change_semaphore.synchronize do
@@ -159,7 +187,11 @@ module Solargraph
 
       def read_text uri
         filename = uri_to_file(uri)
-        library.read_text(filename)
+        text = nil
+        @change_semaphore.synchronize do
+          text = library.read_text(filename)
+        end
+        text
       end
 
       def completions_at filename, line, column
@@ -172,7 +204,7 @@ module Solargraph
 
       # @return [Array<Solargraph::Pin::Base>]
       def definitions_at filename, line, column
-        results = nil
+        results = []
         @change_semaphore.synchronize do
           results = library.definitions_at(filename, line, column)
         end
@@ -187,45 +219,69 @@ module Solargraph
         results
       end
 
+      def query_symbols query
+        results = nil
+        @change_semaphore.synchronize { results = library.query_symbols(query) }
+        results
+      end
+
+      def file_symbols uri
+        library.file_symbols(uri_to_file(uri))
+      end
+
       private
 
+      # @return [Solargraph::Library]
+      def library
+        @library
+      end
+
+      def unsafe_changing? file_uri
+        @change_queue.any?{|change| change['textDocument']['uri'] == file_uri}
+      end
+
       def start_change_thread
         Thread.new do
           until stopped?
             @change_semaphore.synchronize do
               begin
                 changed = false
+                @change_queue.sort!{|a, b| a['textDocument']['version'] <=> b['textDocument']['version']}
                 @change_queue.delete_if do |change|
                   filename = uri_to_file(change['textDocument']['uri'])
                   source = library.checkout(filename)
                   if change['textDocument']['version'] == source.version + change['contentChanges'].length
-                    source.synchronize(change['contentChanges'], change['textDocument']['version'])
+                    updater = generate_updater(change)
+                    library.synchronize updater
                     @diagnostics_queue.push change['textDocument']['uri']
                     changed = true
-                    true
+                    next true
                   elsif change['textDocument']['version'] == source.version + 1 #and change['contentChanges'].length == 0
                     # HACK: This condition fixes the fact that formatting
                     # increments the version by one regardless of the number
                     # of changes
-                    source.synchronize(change['contentChanges'], change['textDocument']['version'])
+                    STDERR.puts "Warning: change applied to #{uri_to_file(change['textDocument']['uri'])} is possibly out of sync"
+                    updater = generate_updater(change)
+                    library.synchronize updater
                     @diagnostics_queue.push change['textDocument']['uri']
-                    true
+                    changed = true
+                    next true
                   elsif change['textDocument']['version'] <= source.version
                     # @todo Is deleting outdated changes correct behavior?
-                    STDERR.puts "Deleting stale change"
+                    STDERR.puts "Warning: outdated to change to #{change['textDocument']['uri']} was ignored"
                     @diagnostics_queue.push change['textDocument']['uri']
-                    changed = true
-                    true
+                    next true
                   else
                     # @todo Change is out of order. Save it for later
-                    STDERR.puts "Kept in queue: #{change['textDocument']['uri']} from #{source.version} to #{change['textDocument']['version']}"
-                    false
+                    next false
                   end
                 end
-                STDERR.puts "#{@change_queue.length} pending" unless @change_queue.empty?
-                library.refresh if changed
+                refreshable = changed and @change_queue.empty?
+                library.refresh if refreshable
               rescue Exception => e
-                STDERR.puts e.message
+                # Trying to get anything out of the error except its class
+                # hangs the thread for some reason
+                STDERR.puts "An error occurred in the change thread: #{e.class}"
               end
             end
             sleep 0.1
@@ -237,43 +293,39 @@ module Solargraph
         Thread.new do
           diagnoser = Diagnostics::Rubocop.new
           until stopped?
+            sleep 1
             if options['diagnostics'] != 'rubocop'
               @change_semaphore.synchronize { @diagnostics_queue.clear }
-              sleep 1
               next
             end
-            unless @change_semaphore.locked?
-              begin
-                current = nil
-                @change_semaphore.synchronize do
-                  current = @diagnostics_queue.shift
-                end
-                unless current.nil?
-                  already_changing = false
-                  @change_semaphore.synchronize { already_changing = (changing?(current) or @diagnostics_queue.include?(current)) }
-                  unless already_changing
-                    filename = nil
-                    text = nil
-                    @change_semaphore.synchronize do
-                      filename = uri_to_file(current)
-                      text = library.read_text(filename)
-                    end
-                    results = diagnoser.diagnose text, filename
-                    @change_semaphore.synchronize { already_changing = (changing?(current) or @diagnostics_queue.include?(current)) }
-                    # publish_diagnostics current, resp unless already_changing
-                    unless already_changing
-                      send_notification "textDocument/publishDiagnostics", {
-                        uri: current,
-                        diagnostics: results
-                      }
-                    end
-                  end
+            begin
+              # Diagnosis is broken into two parts to reduce the amount of times it runs while
+              # a document is changing
+              current = nil
+              already_changing = nil
+              @change_semaphore.synchronize do
+                current = @diagnostics_queue.shift
+                break if current.nil?
+                already_changing = unsafe_changing?(current)
+                @diagnostics_queue.delete current unless already_changing
+              end
+              next if current.nil? or already_changing
+              filename = uri_to_file(current)
+              text = library.read_text(filename)
+              results = diagnoser.diagnose text, filename
+              @change_semaphore.synchronize do
+                already_changing = (unsafe_changing?(current) or @diagnostics_queue.include?(current))
+                # publish_diagnostics current, resp unless already_changing
+                unless already_changing
+                  send_notification "textDocument/publishDiagnostics", {
+                    uri: current,
+                    diagnostics: results
+                  }
                 end
-              rescue Exception => e
-                STDERR.puts e.message
               end
+            rescue Exception => e
+              STDERR.puts "Error in diagnostics: #{e.class}"
             end
-            sleep 0.1
           end
         end
       end
@@ -282,6 +334,24 @@ module Solargraph
         return path if File::ALT_SEPARATOR.nil?
         path.gsub(File::ALT_SEPARATOR, File::SEPARATOR)
       end
+
+      def generate_updater params
+        changes = []
+        params['contentChanges'].each do |chng|
+          changes.push Solargraph::Source::Change.new(
+            (chng['range'].nil? ? 
+              nil : 
+              Solargraph::Source::Range.from_to(chng['range']['start']['line'], chng['range']['start']['character'], chng['range']['end']['line'], chng['range']['end']['character'])
+            ),
+            chng['text']
+          )
+        end
+        Solargraph::Source::Updater.new(
+          uri_to_file(params['textDocument']['uri']),
+          params['textDocument']['version'],
+          changes
+        )
+      end
     end
   end
 end

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

@@ -52,6 +52,7 @@ module Solargraph
             }
             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

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

@@ -1,5 +1,9 @@
 module Solargraph
-  module Client
-    autoload :RegisterCapability, 'solargraph/language_server/message/client/register_capability'
+  module LanguageServer
+    module Message
+      module Client
+        autoload :RegisterCapability, 'solargraph/language_server/message/client/register_capability'
+      end
+    end
   end
 end

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

@@ -6,33 +6,20 @@ module Solargraph
       module TextDocument
         class Completion < Base
           def process
-            begin
-              start = Time.now
-              processed = false
-              until processed
-                if host.changing?(params['textDocument']['uri'])
-                  if Time.now - start > 1
-                    set_error Solargraph::LanguageServer::ErrorCodes::INTERNAL_ERROR, 'Completion request timed out'
-                    processed = true
-                  end
-                else
-                  inner_process
+            start = Time.now
+            processed = false
+            until processed
+              if host.changing?(params['textDocument']['uri'])
+                if Time.now - start > 1
+                  # set_error Solargraph::LanguageServer::ErrorCodes::INTERNAL_ERROR, 'Completion request timed out'
+                  set_result empty_result
                   processed = true
                 end
-                sleep 0.1 unless processed
-              end
-            rescue Exception => e
-              STDERR.puts e.message
-              STDERR.puts e.backtrace
-              # Ignore 'Invalid offset' errors, since they usually just mean
-              # that the document is in the process of changing.
-              if e.message.include?('Invalid offset')
-                # @todo Should this result be marked as incomplete? It might
-                #   be possible to resolve it after changes are finished.
-                set_result empty_result
               else
-                set_error ErrorCodes::INTERNAL_ERROR, e.message
+                inner_process
+                processed = true
               end
+              sleep 0.1 unless processed
             end
           end
 
@@ -42,23 +29,31 @@ module Solargraph
             filename = uri_to_file(params['textDocument']['uri'])
             line = params['position']['line']
             col = params['position']['character']
-            completion = host.completions_at(filename, line, col)
-            items = []
-            idx = 0
-            completion.pins.each do |pin|
-              items.push pin.completion_item.merge({
-                textEdit: {
-                  range: completion.range.to_hash,
-                  newText: pin.name
-                },
-                sortText: "#{pin.name}#{idx.to_s.rjust(4, '0')}"
-              })
-              idx += 1
+            begin
+              completion = host.completions_at(filename, line, col)
+              if host.cancel?(id)
+                return set_result(empty_result) if host.cancel?(id)
+              end
+              items = []
+              idx = 0
+              completion.pins.each do |pin|
+                items.push pin.completion_item.merge({
+                  textEdit: {
+                    range: completion.range.to_hash,
+                    newText: pin.name
+                  },
+                  sortText: "#{pin.name}#{idx.to_s.rjust(4, '0')}"
+                })
+                idx += 1
+              end
+              set_result(
+                isIncomplete: false,
+                items: items
+              )
+            rescue InvalidOffsetError => e
+              STDERR.puts "Skipping invalid offset: #{filename}, line #{line}, character #{col}"
+              set_result empty_result
             end
-            set_result(
-              isIncomplete: false,
-              items: items
-            )
           end
 
           def empty_result