solargraph 0.47.2 → 0.53.3

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)
@@ -106,36 +106,37 @@ module Solargraph
       result
     end
 
-    # Create a file source from a file on disk. The file is ignored if it is
+    # Create file sources from files on disk. A file is ignored if it is
     # neither open in the library nor included in the workspace.
     #
-    # @param filename [String]
-    # @return [Boolean] True if the file was added to the workspace.
-    def create_from_disk filename
+    # @param filenames [Array<String>]
+    # @return [Boolean] True if at least one file was added to the workspace.
+    def create_from_disk *filenames
       result = false
       mutex.synchronize do
-        next if File.directory?(filename) || !File.exist?(filename)
-        next unless contain?(filename) || open?(filename) || workspace.would_merge?(filename)
-        source = Solargraph::Source.load_string(File.read(filename), filename)
-        workspace.merge(source)
-        maybe_map source
-        result = true
+        sources = filenames
+          .reject { |filename| File.directory?(filename) || !File.exist?(filename) }
+          .map { |filename| Solargraph::Source.load_string(File.read(filename), filename) }
+        result = workspace.merge(*sources)
+        sources.each { |source| maybe_map source }
       end
       result
     end
 
-    # Delete a file from the library. Deleting a file will make it unavailable
+    # Delete files from the library. Deleting a file will make it unavailable
     # for checkout and optionally remove it from the workspace unless the
     # workspace configuration determines that it should still exist.
     #
-    # @param filename [String]
-    # @return [Boolean] True if the file was deleted
-    def delete filename
-      detach filename
+    # @param filenames [Array<String>]
+    # @return [Boolean] True if any file was deleted
+    def delete *filenames
       result = false
-      mutex.synchronize do
-        result = workspace.remove(filename)
-        @synchronized = !result if synchronized?
+      filenames.each do |filename|
+        detach filename
+        mutex.synchronize do
+          result ||= workspace.remove(filename)
+          @synchronized = !result if synchronized?
+        end
       end
       result
     end
@@ -158,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)
@@ -174,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)
@@ -198,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.
     #
@@ -234,7 +251,19 @@ module Solargraph
         found = source.references(pin.name)
         found.select! do |loc|
           referenced = definitions_at(loc.filename, loc.range.ending.line, loc.range.ending.character).first
-          referenced && referenced.path == pin.path
+          referenced&.path == pin.path
+        end
+        if pin.path == 'Class#new'
+          caller = cursor.chain.base.infer(api_map, clip.send(:block), clip.locals).first
+          if caller.defined?
+            found.select! do |loc|
+              clip = api_map.clip_at(loc.filename, loc.range.start)
+              other = clip.send(:cursor).chain.base.infer(api_map, clip.send(:block), clip.locals).first
+              caller == other
+            end
+          else
+            found.clear
+          end
         end
         # HACK: for language clients that exclude special characters from the start of variable names
         if strip && match = cursor.word.match(/^[^a-z0-9_]+/i)
@@ -257,17 +286,27 @@ module Solargraph
       api_map.locate_pins(location).map { |pin| pin.realize(api_map) }
     end
 
+    # Match a require reference to a file.
+    #
+    # @param location [Location]
+    # @return [Location, nil]
     def locate_ref location
       map = source_map_hash[location.filename]
       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
-      api_map.yard_map.require_reference(pin.name)
+      nil
     rescue FileNotFoundError
       nil
     end
@@ -275,13 +314,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
@@ -313,11 +352,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
@@ -374,14 +414,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,
@@ -426,6 +471,7 @@ module Solargraph
       result
     end
 
+    # @return [Hash{String => SourceMap}]
     def source_map_hash
       @source_map_hash ||= {}
     end
@@ -434,6 +480,7 @@ module Solargraph
       (workspace.filenames - source_map_hash.keys).empty?
     end
 
+    # @return [SourceMap, Boolean]
     def next_map
       return false if mapped?
       mutex.synchronize do
@@ -450,6 +497,7 @@ module Solargraph
       end
     end
 
+    # @return [self]
     def map!
       workspace.sources.each do |src|
         source_map_hash[src.filename] = Solargraph::SourceMap.map(src)
@@ -458,28 +506,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
@@ -509,6 +563,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"
@@ -518,11 +575,13 @@ 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)
       if source_map_hash.key?(source.filename)
-        return if source_map_hash[source.filename].code == source.code && 
+        return if source_map_hash[source.filename].code == source.code &&
           source_map_hash[source.filename].source.synchronized? &&
           source.synchronized?
         if source.synchronized?
@@ -542,5 +601,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(workspace.command_path, '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/page.rb

@@ -7,6 +7,12 @@ require 'cgi'
 
 module Solargraph
   class Page
+    # @todo This method directive is necessary because OpenStruct.new confuses
+    #   the typechecker.
+    # @!method self.new(locals, render_method)
+    #   @param locals[Hash]
+    #   @param render_method [Proc]
+    #   @return [Binder]
     class Binder < OpenStruct
       # @param locals [Hash]
       # @param render_method [Proc]

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

data/lib/solargraph/parser/{legacy → parser_gem}/class_methods.rb

@@ -1,12 +1,15 @@
+# frozen_string_literal: true
+
 require 'parser/current'
+require 'parser/source/buffer'
 
 module Solargraph
   module Parser
-    module Legacy
+    module ParserGem
       module ClassMethods
         # @param code [String]
-        # @param filename [String]
-        # @return [Array(Parser::AST::Node, Array<Parser::Source::Comment>)]
+        # @param filename [String, nil]
+        # @return [Array(Parser::AST::Node, Hash{Integer => String})]
         def parse_with_comments code, filename = nil
           buffer = ::Parser::Source::Buffer.new(filename, 0)
           buffer.source = code
@@ -29,7 +32,7 @@ module Solargraph
           raise Parser::SyntaxError, e.message
         end
 
-        # @return [Parser::Base]
+        # @return [::Parser::Base]
         def parser
           # @todo Consider setting an instance variable. We might not need to
           #   recreate the parser every time we use it.
@@ -39,19 +42,30 @@ module Solargraph
           parser
         end
 
+        # @param source [Source]
+        # @return [Array(Array<Pin::Base>, Array<Pin::Base>)]
         def map source
           NodeProcessor.process(source.node, Region.new(source: source))
         end
 
+        # @param node [Parser::AST::Node]
+        # @return [Array<Parser::AST::Node>]
         def returns_from node
           NodeMethods.returns_from(node)
         end
 
+        # @param source [Source]
+        # @param name [String]
+        # @return [Array<Location>]
         def references source, name
           if name.end_with?("=")
             reg = /#{Regexp.escape name[0..-2]}\s*=/
+            # @param code [String]
+            # @param offset [Integer]
             extract_offset = ->(code, offset) { reg.match(code, offset).offset(0) }
           else
+            # @param code [String]
+            # @param offset [Integer]
             extract_offset = ->(code, offset) { [soff = code.index(name, offset), soff + name.length] }
           end
           inner_node_references(name, source.node).map do |n|
@@ -80,36 +94,48 @@ module Solargraph
           result
         end
 
+        # @return [Source::Chain]
         def chain *args
           NodeChainer.chain *args
         end
 
+        # @return [Source::Chain]
         def chain_string *args
           NodeChainer.load_string *args
         end
 
+        # @return [Array(Array<Pin::Base>, Array<Pin::Base>)]
         def process_node *args
           Solargraph::Parser::NodeProcessor.process *args
         end
 
+        # @param node [Parser::AST::Node]
+        # @return [String, nil]
         def infer_literal_node_type node
           NodeMethods.infer_literal_node_type node
         end
 
+        # @return [void]
         def version
           parser.version
         end
 
+        # @param node [BasicObject]
+        # @return [Boolean]
         def is_ast_node? node
           node.is_a?(::Parser::AST::Node)
         end
 
+        # @param node [Parser::AST::Node]
+        # @return [Range]
         def node_range node
           st = Position.new(node.loc.line, node.loc.column)
           en = Position.new(node.loc.last_line, node.loc.last_column)
           Range.new(st, en)
         end
 
+        # @param node [Parser::AST::Node]
+        # @return [Array<Range>]
         def string_ranges node
           return [] unless is_ast_node?(node)
           result = []
@@ -128,7 +154,7 @@ module Solargraph
             end
           end
           result
-        end  
+        end
       end
     end
   end

data/lib/solargraph/parser/{legacy → parser_gem}/flawed_builder.rb

@@ -2,11 +2,13 @@
 
 module Solargraph
   module Parser
-    module Legacy
+    module ParserGem
       # A custom builder for source parsers that ignores character encoding
       # issues in literal strings.
       #
       class FlawedBuilder < ::Parser::Builders::Default
+        # @param token [::Parser::AST::Node]
+        # @return [String]
         def string_value(token)
           value(token)
         end