solargraph 0.25.1 → 0.26.0

data/lib/solargraph/core_fills.rb

@@ -8,17 +8,21 @@ module Solargraph
       'then', 'true', 'undef', 'unless', 'until', 'when', 'while', 'yield'
     ].freeze
 
-    METHODS_RETURNING_SELF = %w{
+    METHODS_RETURNING_SELF = %w[
+      Array#select Array#reject Array#keep_if Array#delete_if
+      Enumerable#select
       Object#clone Object#dup Object#freeze Object#taint Object#untaint
-    }.freeze
+    ].freeze
 
-    METHODS_RETURNING_SUBTYPES = %w{
-      Array#[]
-    }.freeze
+    METHODS_RETURNING_SUBTYPES = %w[
+      Array#[] Array#first Array#last
+    ].freeze
 
-    METHODS_WITH_YIELDPARAM_SUBTYPES = %w{
-      Array#each Hash#each_pair Array#map
-    }.freeze
+    METHODS_WITH_YIELDPARAM_SUBTYPES = %w[
+      Array#each Array#map Array#any? Array#all?
+      Enumerable#each_entry Enumerable#map Enumerable#any? Enumerable#all?
+      Set#each
+    ].freeze
 
     CUSTOM_RETURN_TYPES = {
       'String#split' => 'Array<String>'

data/lib/solargraph/diagnostics/type_not_defined.rb

@@ -73,10 +73,10 @@ module Solargraph
       end
 
       def defined_return_type? pin, api_map
-        return true unless pin.return_type.nil?
+        return true unless pin.return_complex_type.undefined?
         matches = api_map.get_method_stack(pin.namespace, pin.name, scope: pin.scope)
         matches.shift
-        matches.any?{|m| !m.return_type.nil?}
+        matches.any?{|m| !m.return_complex_type.undefined?}
       end
 
       def defined_param_type? pin, param, api_map

data/lib/solargraph/language_server.rb

@@ -3,6 +3,9 @@ require 'solargraph/language_server/completion_item_kinds'
 require 'solargraph/language_server/symbol_kinds'
 
 module Solargraph
+  # The LanguageServer namespace contains the classes and modules that compose
+  # concrete implementations of language servers.
+  #
   module LanguageServer
     autoload :Host,         'solargraph/language_server/host'
     autoload :Message,      'solargraph/language_server/message'

data/lib/solargraph/language_server/completion_item_kinds.rb

@@ -1,5 +1,7 @@
 module Solargraph
   module LanguageServer
+    # The CompletionItemKind constants for the language server protocol.
+    #
     module CompletionItemKinds
       TEXT = 1
       METHOD = 2

data/lib/solargraph/language_server/error_codes.rb

@@ -1,5 +1,7 @@
 module Solargraph
   module LanguageServer
+    # The ErrorCode constants for the language server protocol.
+    #
     module ErrorCodes
       PARSE_ERROR =            -32700
       INVALID_REQUEST =        -32600

data/lib/solargraph/language_server/host.rb

@@ -136,7 +136,7 @@ module Solargraph
       def open? uri
         result = nil
         @change_semaphore.synchronize do
-          result = library.open?(uri_to_file(uri))
+          result = unsafe_open?(uri)
         end
         result
       end
@@ -343,7 +343,7 @@ module Solargraph
       def locate_pin params
         pin = nil
         @change_semaphore.synchronize do
-          pin = library.locate_pin(params['data']['location']) unless params['data']['location'].nil?
+          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
@@ -352,6 +352,8 @@ module Solargraph
         pin
       end
 
+      # @param uri [String]
+      # @return [String]
       def read_text uri
         filename = uri_to_file(uri)
         text = nil
@@ -361,6 +363,10 @@ module Solargraph
         text
       end
 
+      # @param filename [String]
+      # @param line [Integer]
+      # @param column [Integer]
+      # @return [Solargraph::ApiMap::Completion]
       def completions_at filename, line, column
         result = nil
         @change_semaphore.synchronize do
@@ -369,6 +375,9 @@ module Solargraph
         result
       end
 
+      # @param filename [String]
+      # @param line [Integer]
+      # @param column [Integer]
       # @return [Array<Solargraph::Pin::Base>]
       def definitions_at filename, line, column
         result = []
@@ -378,6 +387,10 @@ module Solargraph
         result
       end
 
+      # @param filename [String]
+      # @param line [Integer]
+      # @param column [Integer]
+      # @return [Array<Solargraph::Pin::Base>]
       def signatures_at filename, line, column
         result = nil
         @change_semaphore.synchronize do
@@ -386,6 +399,10 @@ module Solargraph
         result
       end
 
+      # @param filename [String]
+      # @param line [Integer]
+      # @param column [Integer]
+      # @return [Array<Solargraph::Source::Range>]
       def references_from filename, line, column
         result = nil
         @change_semaphore.synchronize do
@@ -394,18 +411,24 @@ module Solargraph
         result
       end
 
+      # @param query [String]
+      # @return [Array<Solargraph::Pin::Base>]
       def query_symbols query
         result = nil
         @change_semaphore.synchronize { result = library.query_symbols(query) }
         result
       end
 
+      # @param query [String]
+      # @return [Array<String>]
       def search query
         result = nil
         @change_semaphore.synchronize { result = library.search(query) }
         result
       end
 
+      # @param query [String]
+      # @return [String]
       def document query
         result = nil
         @change_semaphore.synchronize { result = library.document(query) }
@@ -418,6 +441,10 @@ module Solargraph
         library.file_symbols(uri_to_file(uri))
       end
 
+      # Send a notification to the client.
+      #
+      # @param text [String]
+      # @param type [Integer] A MessageType constant
       def show_message text, type = LanguageServer::MessageTypes::INFO
         send_notification 'window/showMessage', {
           type: type,
@@ -425,6 +452,13 @@ module Solargraph
         }
       end
 
+      # Send a notification with optional responses.
+      #
+      # @param text [String]
+      # @param type [Integer] A MessageType constant
+      # @param actions [Array<String>] Response options for the client
+      # @param &block The block that processes the response
+      # @yieldparam [String] The action received from the client
       def show_message_request text, type, actions, &block
         send_request 'window/showMessageRequest', {
           type: type,
@@ -441,6 +475,7 @@ module Solargraph
         requests.keys
       end
 
+      # @return [Hash{String => Object}]
       def default_configuration
         {
           'completion' => true,
@@ -462,10 +497,16 @@ module Solargraph
         @library
       end
 
+      # @param file_uri [String]
+      # @return [Boolean]
       def unsafe_changing? file_uri
         @change_queue.any?{|change| change['textDocument']['uri'] == file_uri}
       end
 
+      def unsafe_open? uri
+        library.open?(uri_to_file(uri))
+      end
+
       def requests
         @requests ||= {}
       end
@@ -509,9 +550,13 @@ module Solargraph
                     @diagnostics_queue.push change['textDocument']['uri']
                     next true
                   else
-                    # @todo Change is out of order. Save it for later
-                    STDERR.puts "Skipping out of order change to #{change['textDocument']['uri']}"
-                    next false
+                    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?
@@ -520,9 +565,11 @@ module Solargraph
                 # 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.1
+            sleep 0.01
           end
         end
       end

data/lib/solargraph/language_server/message.rb

@@ -3,6 +3,9 @@ require 'uri'
 
 module Solargraph
   module LanguageServer
+    # The Message namespace contains classes that implement language server
+    # protocol methods.
+    #
     module Message
       autoload :Base,                 'solargraph/language_server/message/base'
       autoload :Initialize,           'solargraph/language_server/message/initialize'
@@ -18,6 +21,15 @@ module Solargraph
       autoload :Workspace,            'solargraph/language_server/message/workspace'
 
       class << self
+        # Register a method name and message for handling by the language
+        # server.
+        #
+        # @example
+        #   Message.register 'initialize', Solargraph::Message::Initialize
+        #
+        # @param path [String] The method name
+        # @param message_class [Class<Message::Base>] The message class
+        # @return [void]
         def register path, message_class
           method_map[path] = message_class
         end
@@ -36,6 +48,7 @@ module Solargraph
 
         private
 
+        # @return [Hash{String => Class<Message::Base>}]
         def method_map
           @method_map ||= {}
         end

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

@@ -12,12 +12,10 @@ module Solargraph::LanguageServer::Message::TextDocument
       col = params['position']['character']
       suggestions = host.definitions_at(filename, line, col)
       locations = suggestions.reject{|pin| pin.location.nil?}.map do |pin|
-        unless pin.location.nil?
-          {
-            uri: file_to_uri(pin.location.filename),
-            range: pin.location.range.to_hash
-          }
-        end
+        {
+          uri: file_to_uri(pin.location.filename),
+          range: pin.location.range.to_hash
+        }
       end
       set_result locations
     end

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

@@ -11,7 +11,8 @@ class Solargraph::LanguageServer::Message::TextDocument::DocumentSymbol < Solarg
         location: {
           uri: file_to_uri(pin.location.filename),
           range: pin.location.range.to_hash
-        }
+        },
+        deprecated: pin.deprecated?
       }
       result
     end

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

@@ -12,7 +12,8 @@ class Solargraph::LanguageServer::Message::Workspace::WorkspaceSymbol < Solargra
         location: {
           uri: uri,
           range: pin.location.range.to_hash
-        }
+        },
+        deprecated: pin.deprecated?
       }
     end
     set_result info

data/lib/solargraph/language_server/message_types.rb

@@ -1,5 +1,7 @@
 module Solargraph
   module LanguageServer
+    # The MessageType constants from the language server specification.
+    #
     module MessageTypes
       ERROR = 1
       WARNING = 2

data/lib/solargraph/language_server/request.rb

@@ -1,11 +1,15 @@
 module Solargraph
   module LanguageServer
     class Request
+      # @param id [Integer]
+      # @param &block The block that processes the client's response
       def initialize id, &block
         @id = id
         @block = block
       end
 
+      # @param result [Object]
+      # @return [void]
       def process result
         @block.call(result) unless @block.nil?
       end

data/lib/solargraph/language_server/symbol_kinds.rb

@@ -1,32 +1,34 @@
 module Solargraph
   module LanguageServer
+    # The SymbolKind constants for the language server protocol.
+    #
     module SymbolKinds
-      FILE = 1;
-      MODULE = 2;
-      NAMESPACE = 3;
-      PACKAGE = 4;
-      CLASS = 5;
-      METHOD = 6;
-      PROPERTY = 7;
-      FIELD = 8;
-      CONSTRUCTOR = 9;
-      ENUM = 10;
-      INTERFACE = 11;
-      FUNCTION = 12;
-      VARIABLE = 13;
-      CONSTANT = 14;
-      STRING = 15;
-      NUMBER = 16;
-      BOOLEAN = 17;
-      ARRAY = 18;
-      OBJECT = 19;
-      KEY = 20;
-      NULL = 21;
-      ENUM_MEMBER = 22;
-      STRUCT = 23;
-      EVENT = 24;
-      OPERATOR = 25;
-      TYPE_PARAMETER = 26;
+      FILE = 1
+      MODULE = 2
+      NAMESPACE = 3
+      PACKAGE = 4
+      CLASS = 5
+      METHOD = 6
+      PROPERTY = 7
+      FIELD = 8
+      CONSTRUCTOR = 9
+      ENUM = 10
+      INTERFACE = 11
+      FUNCTION = 12
+      VARIABLE = 13
+      CONSTANT = 14
+      STRING = 15
+      NUMBER = 16
+      BOOLEAN = 17
+      ARRAY = 18
+      OBJECT = 19
+      KEY = 20
+      NULL = 21
+      ENUM_MEMBER = 22
+      STRUCT = 23
+      EVENT = 24
+      OPERATOR = 25
+      TYPE_PARAMETER = 26
     end
   end
 end

data/lib/solargraph/language_server/transport.rb

@@ -1,5 +1,8 @@
 module Solargraph
   module LanguageServer
+    # The Transport namespace contains concrete implementations of
+    # communication protocols for language servers.
+    #
     module Transport
       autoload :DataReader, 'solargraph/language_server/transport/data_reader'
       autoload :Socket,     'solargraph/language_server/transport/socket'

data/lib/solargraph/language_server/uri_helpers.rb

@@ -1,5 +1,7 @@
 module Solargraph
   module LanguageServer
+    # Methods to handle conversions between file URIs and paths.
+    #
     module UriHelpers
       module_function
 

data/lib/solargraph/library.rb

@@ -114,7 +114,7 @@ module Solargraph
       source = read(filename)
       api_map.virtualize source
       fragment = source.fragment_at(line, column)
-      api_map.complete(fragment)
+      fragment.complete(api_map)
     end
 
     # Get definition suggestions for the expression at the specified file and
@@ -128,7 +128,7 @@ module Solargraph
       source = read(filename)
       api_map.virtualize source
       fragment = source.fragment_at(line, column)
-      api_map.define(fragment)
+      fragment.define(api_map)
     end
 
     # Get signature suggestions for the method at the specified file and
@@ -142,14 +142,18 @@ module Solargraph
       source = read(filename)
       api_map.virtualize source
       fragment = source.fragment_at(line, column)
-      api_map.signify(fragment)
+      fragment.signify(api_map)
     end
 
+    # @param filename [String]
+    # @param line [Integer]
+    # @param column [Integer]
+    # @return [Array<Solargraph::Source::Range>]
     def references_from filename, line, column
       source = read(filename)
       api_map.virtualize source
       fragment = source.fragment_at(line, column)
-      pins = api_map.define(fragment)
+      pins = fragment.define(api_map)
       return [] if pins.empty?
       result = []
       # @param pin [Solargraph::Pin::Base]
@@ -159,9 +163,10 @@ module Solargraph
           result.push mn_loc unless mn_loc.nil?
         end
         (workspace.sources + source_hash.values).uniq(&:filename).each do |source|
-          found = source.references(pin.name).select do |loc|
-            referenced = definitions_at(loc.filename, loc.range.ending.line, loc.range.ending.character).first
-            !referenced.nil? and referenced.path == pin.path
+          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}
         end