solargraph 0.26.1 → 0.27.0

data/lib/solargraph/diagnostics/type_not_defined.rb

@@ -6,7 +6,8 @@ module Solargraph
     class TypeNotDefined < Base
       def diagnose source, api_map
         result = []
-        source.pins.select{|p| p.kind == Pin::METHOD or p.kind == Pin::ATTRIBUTE}.each do |pin|
+        api_map.document_symbols(source.filename).each do |pin|
+          next unless pin.kind == Pin::METHOD or pin.kind == Pin::ATTRIBUTE
           result.concat check_return_type(pin, api_map, source)
           result.concat check_param_types(pin, api_map, source)
           result.concat check_param_tags(pin, api_map, source)
@@ -95,11 +96,11 @@ module Solargraph
         tags.any?{|t| t.name == param}
       end
 
-      # @param position [Solargraph::Source::Position]
+      # @param position [Solargraph::Position]
       # @param source [Solargraph::Source]
       # @return [Integer]
       def last_character position, source
-        cursor = Source::Position.to_offset(source.code, position)
+        cursor = Position.to_offset(source.code, position)
         source.code.index(/[\r\n]/, cursor) || source.code.length
       end
     end

data/lib/solargraph/diagnostics/update_errors.rb

@@ -0,0 +1,18 @@
+module Solargraph
+  module Diagnostics
+    class UpdateErrors < Base
+      def diagnose source, api_map
+        result = []
+        source.error_ranges.each do |range|
+          result.push(
+            range: range.to_hash,
+            severity: Diagnostics::Severities::ERROR,
+            source: 'Solargraph',
+            message: 'Syntax error'
+          )
+        end
+        result
+      end
+    end
+  end
+end

data/lib/solargraph/language_server/host.rb

@@ -8,23 +8,21 @@ module Solargraph
     # safety for multi-threaded transports.
     #
     class Host
+      autoload :Diagnoser, 'solargraph/language_server/host/diagnoser'
+      autoload :Cataloger, 'solargraph/language_server/host/cataloger'
+
       include Solargraph::LanguageServer::UriHelpers
 
       def initialize
-        @change_semaphore = Mutex.new
         @cancel_semaphore = Mutex.new
         @buffer_semaphore = Mutex.new
         @register_semaphore = Mutex.new
-        @change_queue = []
-        @diagnostics_queue = []
         @cancel = []
         @buffer = ''
         @stopped = false
         @next_request_id = 0
         @dynamic_capabilities = Set.new
         @registered_capabilities = Set.new
-        start_change_thread
-        start_diagnostics_thread
       end
 
       # Update the configuration options with the provided hash.
@@ -97,24 +95,19 @@ module Solargraph
       # @param uri [String] The file uri.
       def create uri
         filename = uri_to_file(uri)
-        @change_semaphore.synchronize do
-          library.create_from_disk filename
-        end
+        library.create_from_disk filename
       end
 
       # Delete the specified file from the library.
       #
       # @param uri [String] The file uri.
       def delete uri
-        @change_semaphore.synchronize do
-          filename = uri_to_file(uri)
-          library.delete filename
-          # Remove diagnostics for deleted files
-          send_notification "textDocument/publishDiagnostics", {
-            uri: uri,
-            diagnostics: []
-          }
-        end
+        filename = uri_to_file(uri)
+        library.delete filename
+        send_notification "textDocument/publishDiagnostics", {
+          uri: uri,
+          diagnostics: []
+        }
       end
 
       # Open the specified file in the library.
@@ -123,10 +116,8 @@ module Solargraph
       # @param text [String] The contents of the file.
       # @param version [Integer] A version number.
       def open uri, text, version
-        @change_semaphore.synchronize do
-          library.open uri_to_file(uri), text, version
-          @diagnostics_queue.push uri
-        end
+        library.open uri_to_file(uri), text, version
+        diagnoser.schedule uri
       end
 
       # True if the specified file is currently open in the library.
@@ -134,52 +125,33 @@ module Solargraph
       # @param uri [String]
       # @return [Boolean]
       def open? uri
-        result = nil
-        @change_semaphore.synchronize do
-          result = unsafe_open?(uri)
-        end
-        result
+        unsafe_open?(uri)
       end
 
       # Close the file specified by the URI.
       #
       # @param uri [String]
       def close uri
-        @change_semaphore.synchronize do
-          library.close uri_to_file(uri)
-          @diagnostics_queue.push uri
-        end
+        library.close uri_to_file(uri)
+        diagnoser.schedule uri
       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
+        uri = params['textDocument']['uri']
+        filename = uri_to_file(uri)
+        version = params['textDocument']['version']
+        library.overwrite filename, version
+      end
+
+      def diagnose uri
+        library.diagnose uri_to_file(uri)
       end
 
       def change params
-        @change_semaphore.synchronize do
-          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
-              updater = generate_updater(params)
-              library.synchronize updater
-              library.refresh
-              @change_queue.pop
-              @diagnostics_queue.push params['textDocument']['uri']
-            end
-          end
-        end
+        updater = generate_updater(params)
+        library.update updater
+        cataloger.ping unless library.synchronized?
+        diagnoser.schedule params['textDocument']['uri']
       end
 
       # Queue a message to be sent to the client.
@@ -209,17 +181,17 @@ module Solargraph
       def prepare directory
         path = nil
         path = normalize_separators(directory) unless directory.nil?
-        @change_semaphore.synchronize do
-          begin
-            @library = Solargraph::Library.load(path)
-          rescue WorkspaceTooLargeError => e
-            send_notification 'window/showMessage', {
-              'type' => Solargraph::LanguageServer::MessageTypes::WARNING,
-              'message' => "The workspace is too large to index (#{e.size} files, max #{e.max})"
-            }
-            @library = Solargraph::Library.load(nil)
-          end
+        begin
+          @library = Solargraph::Library.load(path)
+        rescue WorkspaceTooLargeError => e
+          send_notification 'window/showMessage', {
+            'type' => Solargraph::LanguageServer::MessageTypes::WARNING,
+            'message' => "The workspace is too large to index (#{e.size} files, max #{e.max})"
+          }
+          @library = Solargraph::Library.load(nil)
         end
+        diagnoser.start
+        cataloger.start
       end
 
       # Send a notification to the client.
@@ -325,15 +297,17 @@ module Solargraph
       #
       # @return [Boolean]
       def changing? file_uri
-        result = false
-        @change_semaphore.synchronize do
-          result = unsafe_changing?(file_uri)
-        end
-        result
+        unsafe_changing?(file_uri)
+      end
+
+      def synchronizing?
+        cataloger.synchronizing?
       end
 
       def stop
         @stopped = true
+        cataloger.stop
+        diagnoser.stop
       end
 
       def stopped?
@@ -342,12 +316,22 @@ module Solargraph
 
       def locate_pin params
         pin = nil
-        @change_semaphore.synchronize do
-          pin = library.locate_pin(params['data']['location']).first unless params['data']['location'].nil?
-          # @todo Improve pin location
-          if pin.nil? or pin.path != params['data']['path']
-            pin = library.path_pins(params['data']['path']).first
-          end
+        pin = nil
+        unless params['data']['location'].nil?
+          location = Location.new(
+            params['data']['location']['filename'],
+            Range.from_to(
+              params['data']['location']['range']['start']['line'],
+              params['data']['location']['range']['start']['character'],
+              params['data']['location']['range']['end']['line'],
+              params['data']['location']['range']['end']['character']
+            )
+          )
+          pin = library.locate_pin(location)
+        end
+        # @todo Improve pin location
+        if pin.nil? or pin.path != params['data']['path']
+          pin = library.path_pins(params['data']['path']).first
         end
         pin
       end
@@ -356,11 +340,7 @@ module Solargraph
       # @return [String]
       def read_text uri
         filename = uri_to_file(uri)
-        text = nil
-        @change_semaphore.synchronize do
-          text = library.read_text(filename)
-        end
-        text
+        library.read_text(filename)
       end
 
       # @param filename [String]
@@ -369,9 +349,7 @@ module Solargraph
       # @return [Solargraph::ApiMap::Completion]
       def completions_at filename, line, column
         result = nil
-        @change_semaphore.synchronize do
-          result = library.completions_at filename, line, column
-        end
+        result = library.completions_at filename, line, column
         result
       end
 
@@ -380,11 +358,7 @@ module Solargraph
       # @param column [Integer]
       # @return [Array<Solargraph::Pin::Base>]
       def definitions_at filename, line, column
-        result = []
-        @change_semaphore.synchronize do
-          result = library.definitions_at(filename, line, column)
-        end
-        result
+        library.definitions_at(filename, line, column)
       end
 
       # @param filename [String]
@@ -392,53 +366,39 @@ module Solargraph
       # @param column [Integer]
       # @return [Array<Solargraph::Pin::Base>]
       def signatures_at filename, line, column
-        result = nil
-        @change_semaphore.synchronize do
-          result = library.signatures_at(filename, line, column)
-        end
-        result
+        library.signatures_at(filename, line, column)
       end
 
       # @param filename [String]
       # @param line [Integer]
       # @param column [Integer]
-      # @return [Array<Solargraph::Source::Range>]
+      # @return [Array<Solargraph::Range>]
       def references_from filename, line, column
-        result = nil
-        @change_semaphore.synchronize do
-          result = library.references_from(filename, line, column)
-        end
-        result
+        result = library.references_from(filename, line, column)
       end
 
       # @param query [String]
       # @return [Array<Solargraph::Pin::Base>]
       def query_symbols query
-        result = nil
-        @change_semaphore.synchronize { result = library.query_symbols(query) }
-        result
+        library.query_symbols(query)
       end
 
       # @param query [String]
       # @return [Array<String>]
       def search query
-        result = nil
-        @change_semaphore.synchronize { result = library.search(query) }
-        result
+        library.search(query)
       end
 
       # @param query [String]
       # @return [String]
       def document query
-        result = nil
-        @change_semaphore.synchronize { result = library.document(query) }
-        result
+        library.document(query)
       end
 
       # @param uri [String]
       # @return [Array<Solargraph::Pin::Base>]
-      def file_symbols uri
-        library.file_symbols(uri_to_file(uri))
+      def document_symbols uri
+        library.document_symbols(uri_to_file(uri))
       end
 
       # Send a notification to the client.
@@ -490,6 +450,13 @@ module Solargraph
         }
       end
 
+      # Catalog the library.
+      #
+      # @return [void]
+      def catalog
+        library.catalog
+      end
+
       private
 
       # @return [Solargraph::Library]
@@ -497,10 +464,20 @@ module Solargraph
         @library
       end
 
+      # @return [Diagnoser]
+      def diagnoser
+        @diagnoser ||= Diagnoser.new(self)
+      end
+
+      # @return [Cataloger]
+      def cataloger
+        @cataloger ||= Cataloger.new(self)
+      end
+
       # @param file_uri [String]
       # @return [Boolean]
       def unsafe_changing? file_uri
-        @change_queue.any?{|change| change['textDocument']['uri'] == file_uri}
+        file = uri_to_file(file_uri)
       end
 
       def unsafe_open? uri
@@ -511,115 +488,6 @@ module Solargraph
         @requests ||= {}
       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']}
-                pending = {}
-                @change_queue.each do |obj|
-                  pending[obj['textDocument']['uri']] ||= 0
-                  pending[obj['textDocument']['uri']] += 1
-                end
-                @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
-                    pending[change['textDocument']['uri']] -= 1
-                    updater = generate_updater(change)
-                    library.synchronize updater, pending[change['textDocument']['uri']] == 0
-                    @diagnostics_queue.push change['textDocument']['uri']
-                    changed = true
-                    next true
-                  elsif change['textDocument']['version'] == source.version + 1
-                    # HACK: This condition fixes the fact that certain changes
-                    # increment the version by one regardless of the number of
-                    # changes
-                    STDERR.puts "Warning: change applied to #{uri_to_file(change['textDocument']['uri'])} is possibly out of sync"
-                    pending[change['textDocument']['uri']] -= 1
-                    updater = generate_updater(change)
-                    library.synchronize updater, pending[change['textDocument']['uri']] == 0
-                    @diagnostics_queue.push change['textDocument']['uri']
-                    changed = true
-                    next true
-                  elsif change['textDocument']['version'] <= source.version
-                    # @todo Is deleting outdated changes correct behavior?
-                    STDERR.puts "Warning: outdated change to #{change['textDocument']['uri']} was ignored"
-                    @diagnostics_queue.push change['textDocument']['uri']
-                    next true
-                  else
-                    if unsafe_open?(change['textDocument']['uri'])
-                      STDERR.puts "Skipping out of order change to #{change['textDocument']['uri']}"
-                      next false
-                    else
-                      STDERR.puts "Deleting out of order change to closed file #{change['textDocument']['uri']}"
-                      next true
-                    end
-                  end
-                end
-                refreshable = changed and @change_queue.empty?
-                library.refresh if refreshable
-              rescue Exception => e
-                # 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}"
-                STDERR.puts e.backtrace
-                @change_queue.clear
-              end
-            end
-            sleep 0.01
-          end
-        end
-      end
-
-      def start_diagnostics_thread
-        Thread.new do
-          until stopped?
-            sleep 0.1
-            if !options['diagnostics']
-              @change_semaphore.synchronize { @diagnostics_queue.clear }
-              next
-            end
-            begin
-              # Diagnosis is broken into two parts to reduce the number 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)
-              results = library.diagnose(filename)
-              @change_semaphore.synchronize do
-                already_changing = (unsafe_changing?(current) or @diagnostics_queue.include?(current))
-                unless already_changing
-                  send_notification "textDocument/publishDiagnostics", {
-                    uri: current,
-                    diagnostics: results
-                  }
-                end
-              end
-            rescue DiagnosticsError => e
-              STDERR.puts "Error in diagnostics: #{e.message}"
-              options['diagnostics'] = false
-              send_notification 'window/showMessage', {
-                type: LanguageServer::MessageTypes::ERROR,
-                message: "Error in diagnostics: #{e.message}"
-              }
-            rescue Exception => e
-              STDERR.puts "#{e.message}"
-              STDERR.puts "#{e.backtrace}"
-            end
-          end
-        end
-      end
-
       def normalize_separators path
         return path if File::ALT_SEPARATOR.nil?
         path.gsub(File::ALT_SEPARATOR, File::SEPARATOR)
@@ -631,7 +499,7 @@ module Solargraph
           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'])
+              Solargraph::Range.from_to(chng['range']['start']['line'], chng['range']['start']['character'], chng['range']['end']['line'], chng['range']['end']['character'])
             ),
             chng['text']
           )