solargraph 0.50.0 → 0.53.0

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

@@ -6,6 +6,8 @@ class Solargraph::LanguageServer::Message::TextDocument::DocumentSymbol < Solarg
   def process
     pins = host.document_symbols params['textDocument']['uri']
     info = pins.map do |pin|
+      next nil unless pin.location&.filename
+
       result = {
         name: pin.name,
         containerName: pin.namespace,
@@ -17,7 +19,8 @@ class Solargraph::LanguageServer::Message::TextDocument::DocumentSymbol < Solarg
         deprecated: pin.deprecated?
       }
       result
-    end
+    end.compact
+
     set_result info
   end
 end

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

@@ -17,17 +17,17 @@ module Solargraph
             args = cli_args(file_uri, config)
 
             require_rubocop(config['version'])
-            options, paths = RuboCop::Options.new.parse(args)
+            options, paths = ::RuboCop::Options.new.parse(args)
             options[:stdin] = original
             corrections = redirect_stdout do
-              RuboCop::Runner.new(options, RuboCop::ConfigStore.new).run(paths)
+              ::RuboCop::Runner.new(options, ::RuboCop::ConfigStore.new).run(paths)
             end
             result = options[:stdin]
 
             log_corrections(corrections)
 
             format original, result
-          rescue RuboCop::ValidationError, RuboCop::ConfigNotFoundError => e
+          rescue ::RuboCop::ValidationError, ::RuboCop::ConfigNotFoundError => e
             set_error(Solargraph::LanguageServer::ErrorCodes::INTERNAL_ERROR, "[#{e.class}] #{e.message}")
           end
 
@@ -54,7 +54,7 @@ module Solargraph
           def cli_args file_uri, config
             file = UriHelpers.uri_to_file(file_uri)
             args = [
-              config['cops'] == 'all' ? '--autocorrect-all' : '--autocorrect',
+              config['cops'] == 'all' ? '-A' : '-a',
               '--cache', 'false',
               '--format', formatter_class(config).name,
             ]

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

@@ -37,6 +37,8 @@ module Solargraph
 
           private
 
+          # @param contents [Array<String>]
+          # @return [Hash{Symbol => Hash{Symbol => String}}, nil]
           def contents_or_nil contents
             stripped = contents
               .map(&:strip)

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Solargraph::LanguageServer::Message::TextDocument
+  class TypeDefinition < Base
+    def process
+      @line = params['position']['line']
+      @column = params['position']['character']
+      set_result(code_location || [])
+    end
+
+    private
+
+    def code_location
+      suggestions = host.type_definitions_at(params['textDocument']['uri'], @line, @column)
+      return nil if suggestions.empty?
+      suggestions.reject { |pin| pin.location.nil? || pin.location.filename.nil? }.map do |pin|
+        {
+          uri: file_to_uri(pin.location.filename),
+          range: pin.location.range.to_hash
+        }
+      end
+    end
+  end
+end

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

@@ -12,9 +12,9 @@ module Solargraph
         autoload :DidSave,           'solargraph/language_server/message/text_document/did_save'
         autoload :Hover,             'solargraph/language_server/message/text_document/hover'
         autoload :SignatureHelp,     'solargraph/language_server/message/text_document/signature_help'
-        autoload :DiagnosticsQueue,  'solargraph/language_server/message/text_document/diagnostics_queue'
         autoload :OnTypeFormatting,  'solargraph/language_server/message/text_document/on_type_formatting'
         autoload :Definition,        'solargraph/language_server/message/text_document/definition'
+        autoload :TypeDefinition,    'solargraph/language_server/message/text_document/type_definition'
         autoload :DocumentSymbol,    'solargraph/language_server/message/text_document/document_symbol'
         autoload :Formatting,        'solargraph/language_server/message/text_document/formatting'
         autoload :References,        'solargraph/language_server/message/text_document/references'

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

@@ -11,8 +11,12 @@ module Solargraph::LanguageServer::Message::Workspace
 
     private
 
+    # @return [void]
     def register_from_options
+      Solargraph.logger.debug "Registering capabilities from options: #{host.options.inspect}"
+      # @type [Array<String>]
       y = []
+      # @type [Array<String>]
       n = []
       (host.options['completion'] ? y : n).push('textDocument/completion')
       (host.options['hover'] ? y : n).push('textDocument/hover', 'textDocument/signatureHelp')
@@ -20,6 +24,7 @@ module Solargraph::LanguageServer::Message::Workspace
       (host.options['formatting'] ? y : n).push('textDocument/formatting')
       (host.options['symbols'] ? y : n).push('textDocument/documentSymbol', 'workspace/symbol')
       (host.options['definitions'] ? y : n).push('textDocument/definition')
+      (host.options['typeDefinitions'] ? y : n).push('textDocument/typeDefinition')
       (host.options['references'] ? y : n).push('textDocument/references')
       (host.options['folding'] ? y : n).push('textDocument/folding')
       (host.options['highlights'] ? y : n).push('textDocument/documentHighlight')

data/lib/solargraph/language_server/message.rb

@@ -66,6 +66,7 @@ module Solargraph
       register 'textDocument/didClose',               TextDocument::DidClose
       register 'textDocument/hover',                  TextDocument::Hover
       register 'textDocument/definition',             TextDocument::Definition
+      register 'textDocument/typeDefinition',         TextDocument::TypeDefinition
       register 'textDocument/formatting',             TextDocument::Formatting
       register 'textDocument/onTypeFormatting',       TextDocument::OnTypeFormatting
       register 'textDocument/documentSymbol',         TextDocument::DocumentSymbol

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

@@ -8,6 +8,17 @@ module Solargraph
       # A common module for running language servers in Backport.
       #
       module Adapter
+        # This runs in the context of Backport::Adapter, which
+        # provides write() - but if we didn't hide this behind a parse
+        # tag, it would override the one in the class.
+        #
+        # @!method write(text)
+        #   @abstract
+        #   Write the change to the specified text.
+        #   @param text [String] The text to be changed.
+        #   @return [String] The updated text.
+
+        # @return [void]
         def opening
           @host = Solargraph::LanguageServer::Host.new
           @host.add_observer self
@@ -18,15 +29,18 @@ module Solargraph
           end
         end
 
+        # @return [void]
         def closing
           @host.stop
         end
 
         # @param data [String]
+        # @return [void]
         def receiving data
           @data_reader.receive data
         end
 
+        # @return [void]
         def update
           if @host.stopped?
             shutdown
@@ -38,12 +52,13 @@ module Solargraph
 
         private
 
-        # @param request [String]
+        # @param request [Hash]
         # @return [void]
         def process request
           @host.process(request)
         end
 
+        # @return [void]
         def shutdown
           Backport.stop unless @host.options['transport'] == 'external'
         end

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

@@ -16,6 +16,7 @@ module Solargraph
         # client.
         #
         # @yieldparam [Hash] The message received from the client
+        # @return [void]
         def set_message_handler &block
           @message_handler = block
         end
@@ -26,6 +27,7 @@ module Solargraph
         # will be buffered and subsequent data will be appended to the buffer.
         #
         # @param data [String]
+        # @return [void]
         def receive data
           data.each_char do |char|
             @buffer.concat char

data/lib/solargraph/library.rb

@@ -97,7 +97,7 @@ module Solargraph
     def create filename, text
       result = false
       mutex.synchronize do
-        next unless contain?(filename) || open?(filename) || workspace.would_merge?(filename)
+        next unless contain?(filename) || open?(filename)
         @synchronized = false
         source = Solargraph::Source.load_string(text, filename)
         workspace.merge(source)
@@ -159,7 +159,7 @@ 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 [SourceMap::Completion]
+    # @return [SourceMap::Completion, nil]
     # @todo Take a Location instead of filename/line/column
     def completions_at filename, line, column
       position = Position.new(line, column)
@@ -175,7 +175,7 @@ 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 [Array<Solargraph::Pin::Base>]
+    # @return [Array<Solargraph::Pin::Base>, nil]
     # @todo Take filename/position instead of filename/line/column
     def definitions_at filename, line, column
       position = Position.new(line, column)
@@ -199,6 +199,22 @@ module Solargraph
       handle_file_not_found(filename, e)
     end
 
+    # Get type definition suggestions for the expression at the specified file and
+    # location.
+    #
+    # @param filename [String] The file to analyze
+    # @param line [Integer] The zero-based line number
+    # @param column [Integer] The zero-based column number
+    # @return [Array<Solargraph::Pin::Base>, nil]
+    # @todo Take filename/position instead of filename/line/column
+    def type_definitions_at filename, line, column
+      position = Position.new(line, column)
+      cursor = Source::Cursor.new(read(filename), position)
+      api_map.clip(cursor).types
+    rescue FileNotFoundError => e
+      handle_file_not_found filename, e
+    end
+
     # Get signature suggestions for the method at the specified file and
     # location.
     #
@@ -267,10 +283,16 @@ module Solargraph
       return if map.nil?
       pin = map.requires.select { |p| p.location.range.contain?(location.range.start) }.first
       return nil if pin.nil?
+      # @param full [String]
+      return_if_match = proc do |full|
+        if source_map_hash.key?(full)
+          return Location.new(full, Solargraph::Range.from_to(0, 0, 0, 0))
+        end
+      end
       workspace.require_paths.each do |path|
-        full = Pathname.new(path).join("#{pin.name}.rb").to_s
-        next unless source_map_hash.key?(full)
-        return Location.new(full, Solargraph::Range.from_to(0, 0, 0, 0))
+        full = File.join path, pin.name
+        return_if_match.(full)
+        return_if_match.(full << ".rb")
       end
       nil
     rescue FileNotFoundError
@@ -280,13 +302,13 @@ module Solargraph
     # Get an array of pins that match a path.
     #
     # @param path [String]
-    # @return [Array<Solargraph::Pin::Base>]
+    # @return [Enumerable<Solargraph::Pin::Base>]
     def get_path_pins path
       api_map.get_path_suggestions(path)
     end
 
     # @param query [String]
-    # @return [Array<YARD::CodeObjects::Base>]
+    # @return [Enumerable<YARD::CodeObjects::Base>]
     def document query
       api_map.document query
     end
@@ -318,11 +340,12 @@ module Solargraph
     end
 
     # @param path [String]
-    # @return [Array<Solargraph::Pin::Base>]
+    # @return [Enumerable<Solargraph::Pin::Base>]
     def path_pins path
       api_map.get_path_suggestions(path)
     end
 
+    # @return [Array<SourceMap>]
     def source_maps
       source_map_hash.values
     end
@@ -379,14 +402,19 @@ module Solargraph
       end
     end
 
+    # @return [void]
     private def catalog_inlock
-        return if synchronized?
-        logger.info "Cataloging #{workspace.directory.empty? ? 'generic workspace' : workspace.directory}"
-        api_map.catalog bench
-        @synchronized = true
-        logger.info "Catalog complete (#{api_map.source_maps.length} files, #{api_map.pins.length} pins)" if logger.info?
+      return if synchronized?
+
+      logger.info "Cataloging #{workspace.directory.empty? ? 'generic workspace' : workspace.directory}"
+      api_map.catalog bench
+      @synchronized = true
+      logger.info "Catalog complete (#{api_map.source_maps.length} files, #{api_map.pins.length} pins)"
+      logger.info "#{api_map.uncached_gemspecs.length} uncached gemspecs"
+      cache_next_gemspec
     end
 
+    # @return [Bench]
     def bench
       Bench.new(
         source_maps: source_map_hash.values,
@@ -431,6 +459,7 @@ module Solargraph
       result
     end
 
+    # @return [Hash{String => SourceMap}]
     def source_map_hash
       @source_map_hash ||= {}
     end
@@ -439,6 +468,7 @@ module Solargraph
       (workspace.filenames - source_map_hash.keys).empty?
     end
 
+    # @return [SourceMap, Boolean]
     def next_map
       return false if mapped?
       mutex.synchronize do
@@ -455,6 +485,7 @@ module Solargraph
       end
     end
 
+    # @return [self]
     def map!
       workspace.sources.each do |src|
         source_map_hash[src.filename] = Solargraph::SourceMap.map(src)
@@ -463,28 +494,34 @@ module Solargraph
       self
     end
 
+    # @return [Array<Solargraph::Pin::Base>]
     def pins
       @pins ||= []
     end
 
+    # @return [Set<String>]
     def external_requires
       @external_requires ||= source_map_external_require_hash.values.flatten.to_set
     end
 
     private
 
+    # @return [Hash{String => Set<String>}]
     def source_map_external_require_hash
       @source_map_external_require_hash ||= {}
     end
 
     # @param source_map [SourceMap]
+    # @return [void]
     def find_external_requires source_map
       new_set = source_map.requires.map(&:name).to_set
       # return if new_set == source_map_external_require_hash[source_map.filename]
+      _filenames = nil
+      filenames = ->{ _filenames ||= workspace.filenames.to_set }
       source_map_external_require_hash[source_map.filename] = new_set.reject do |path|
         workspace.require_paths.any? do |base|
-          full = Pathname.new(base).join("#{path}.rb").to_s
-          workspace.filenames.include?(full)
+          full = File.join(base, path)
+          filenames[].include?(full) or filenames[].include?(full << ".rb")
         end
       end
       @external_requires = nil
@@ -514,6 +551,9 @@ module Solargraph
       workspace.source(filename)
     end
 
+    # @param filename [String]
+    # @param error [FileNotFoundError]
+    # @return [nil]
     def handle_file_not_found filename, error
       if workspace.source(filename)
         Solargraph.logger.debug "#{filename} is not cataloged in the ApiMap"
@@ -523,6 +563,8 @@ module Solargraph
       end
     end
 
+    # @param source [Source]
+    # @return [void]
     def maybe_map source
       return unless source
       return unless @current == source || workspace.has_file?(source.filename)
@@ -547,5 +589,33 @@ module Solargraph
         @synchronized = false
       end
     end
+
+    # @return [Set<Gem::Specification>]
+    def cache_errors
+      @cache_errors ||= Set.new
+    end
+
+    # @return [void]
+    def cache_next_gemspec
+      return if @cache_pid
+      spec = api_map.uncached_gemspecs.find { |spec| !cache_errors.include?(spec)}
+      return unless spec
+
+      logger.info "Caching #{spec.name} #{spec.version}"
+      Thread.new do
+        @cache_pid = Process.spawn('solargraph', 'cache', spec.name, spec.version.to_s)
+        Process.wait(@cache_pid)
+        logger.info "Cached #{spec.name} #{spec.version}"
+        @synchronized = false
+      rescue Errno::EINVAL => e
+        logger.info "Cached #{spec.name} #{spec.version} with EINVAL"
+        @synchronized = false
+      rescue StandardError => e
+        cache_errors.add spec
+        Solargraph.logger.warn "Error caching gemspec #{spec.name} #{spec.version}: [#{e.class}] #{e.message}"
+      ensure
+        @cache_pid = nil
+      end
+    end
   end
 end

data/lib/solargraph/location.rb

@@ -25,6 +25,7 @@ module Solargraph
       }
     end
 
+    # @param other [BasicObject]
     def == other
       return false unless other.is_a?(Location)
       filename == other.filename and range == other.range

data/lib/solargraph/parser/comment_ripper.rb

@@ -3,6 +3,9 @@ require 'ripper'
 module Solargraph
   module Parser
     class CommentRipper < Ripper::SexpBuilderPP
+      # @param src [String]
+      # @param filename [String]
+      # @param lineno [Integer]
       def initialize src, filename = '(ripper)', lineno = 0
         super
         @buffer = src
@@ -42,6 +45,7 @@ module Solargraph
         result
       end
 
+      # @return [Hash{Integer => String}]
       def parse
         @comments = {}
         super

data/lib/solargraph/parser/node_methods.rb

@@ -3,38 +3,78 @@ module Solargraph
     class NodeMethods
       module_function
 
+      # @abstract
+      # @param node [Parser::AST::Node]
+      # @return [String]
       def unpack_name node
         raise NotImplementedError
       end
 
-      def infer_literal_type node
+      # @abstract
+      # @todo Temporarily here for testing. Move to Solargraph::Parser.
+      # @param node [Parser::AST::Node]
+      # @return [Array<Parser::AST::Node>]
+      def call_nodes_from node
         raise NotImplementedError
       end
 
-      def calls_from node
+      # Find all the nodes within the provided node that potentially return a
+      # value.
+      #
+      # The node parameter typically represents a method's logic, e.g., the
+      # second child (after the :args node) of a :def node. A simple one-line
+      # method would typically return itself, while a node with conditions
+      # would return the resulting node from each conditional branch. Nodes
+      # that follow a :return node are assumed to be unreachable. Nil values
+      # are converted to nil node types.
+      #
+      # @abstract
+      # @param node [Parser::AST::Node]
+      # @return [Array<Parser::AST::Node>]
+      def returns_from_method_body node
         raise NotImplementedError
       end
 
-      def returns_from node
+      # @abstract
+      # @param node [Parser::AST::Node]
+      #
+      # @return [Array<Parser::AST::Node>]
+      def const_nodes_from node
         raise NotImplementedError
       end
 
-      def process node
+      # @abstract
+      # @param cursor [Solargraph::Source::Cursor]
+      # @return [Parser::AST::Node, nil]
+      def find_recipient_node cursor
         raise NotImplementedError
       end
 
-      def references node
+      # @abstract
+      # @param node [Parser::AST::Node]
+      # @return [Array<AST::Node>] low-level value nodes in
+      #   value position.  Does not include explicit return
+      #   statements
+      def value_position_nodes_only(node)
         raise NotImplementedError
       end
 
-      def chain node, filename = nil, in_block = false
+      # @abstract
+      # @param nodes [Enumerable<Parser::AST::Node>]
+      def any_splatted_call?(nodes)
         raise NotImplementedError
       end
 
-      def node? node
+      # @abstract
+      # @param node [Parser::AST::Node]
+      # @return [void]
+      def process node
         raise NotImplementedError
       end
 
+      # @abstract
+      # @param node [Parser::AST::Node]
+      # @return [Hash{Parser::AST::Node => Chain}]
       def convert_hash node
         raise NotImplementedError
       end

data/lib/solargraph/parser/node_processor/base.rb

@@ -19,6 +19,7 @@ module Solargraph
         # @param node [Parser::AST::Node]
         # @param region [Region]
         # @param pins [Array<Pin::Base>]
+        # @param locals [Array<Pin::LocalVariable>]
         def initialize node, region, pins, locals
           @node = node
           @region = region
@@ -54,20 +55,28 @@ module Solargraph
           Location.new(region.filename, range)
         end
 
+        # @param node [Parser::AST::Node]
+        # @return [String, nil]
         def comments_for(node)
           region.source.comments_for(node)
         end
 
+        # @param position [Solargraph::Position]
+        # @return [Pin::Base, nil]
         def named_path_pin position
           pins.select{|pin| pin.is_a?(Pin::Closure) && pin.path && !pin.path.empty? && pin.location.range.contain?(position)}.last
         end
 
         # @todo Candidate for deprecation
+        # @param position [Solargraph::Position]
+        # @return [Pin::Closure, nil]
         def block_pin position
           pins.select{|pin| pin.is_a?(Pin::Closure) && pin.location.range.contain?(position)}.last
         end
 
         # @todo Candidate for deprecation
+        # @param position [Solargraph::Position]
+        # @return [Pin::Closure, nil]
         def closure_pin position
           pins.select{|pin| pin.is_a?(Pin::Closure) && pin.location.range.contain?(position)}.last
         end