solargraph 0.52.0 → 0.53.0

data/lib/solargraph/library.rb

@@ -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)
@@ -205,7 +205,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 type_definitions_at filename, line, column
       position = Position.new(line, column)
@@ -283,6 +283,7 @@ 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))
@@ -301,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
@@ -339,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
@@ -400,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,
@@ -452,6 +459,7 @@ module Solargraph
       result
     end
 
+    # @return [Hash{String => SourceMap}]
     def source_map_hash
       @source_map_hash ||= {}
     end
@@ -460,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
@@ -476,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)
@@ -484,21 +494,25 @@ 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]
@@ -537,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"
@@ -546,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)
@@ -570,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

data/lib/solargraph/parser/node_methods.rb

@@ -3,39 +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
 
-      # @return [Source::Chain]
-      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, nil]
-        # @return [Array(Parser::AST::Node, Array<Parser::Source::Comment>)]
+        # @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 = []

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

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

@@ -2,7 +2,7 @@
 
 module Solargraph
   module Parser
-    module Legacy
+    module ParserGem
       # A factory for generating chains from nodes.
       #
       class NodeChainer
@@ -11,10 +11,11 @@ module Solargraph
 
         # @param node [Parser::AST::Node]
         # @param filename [String, nil]
-        def initialize node, filename = nil, in_block = false
+        # @param parent [Parser::AST::Node, nil]
+        def initialize node, filename = nil, parent = nil
           @node = node
           @filename = filename
-          @in_block = in_block ? 1 : 0
+          @parent = parent
         end
 
         # @return [Source::Chain]
@@ -26,9 +27,10 @@ module Solargraph
         class << self
           # @param node [Parser::AST::Node]
           # @param filename [String, nil]
+          # @param parent [Parser::AST::Node, nil]
           # @return [Source::Chain]
-          def chain node, filename = nil, in_block = false
-            NodeChainer.new(node, filename, in_block).chain
+          def chain node, filename = nil, parent = nil
+            NodeChainer.new(node, filename, parent).chain
           end
 
           # @param code [String]
@@ -48,55 +50,42 @@ module Solargraph
         def generate_links n
           return [] unless n.is_a?(::Parser::AST::Node)
           return generate_links(n.children[0]) if n.type == :splat
+          # @type [Array<Chain::Link>]
           result = []
           if n.type == :block
-            @in_block += 1
-            result.concat generate_links(n.children[0])
-            @in_block -= 1
+            result.concat NodeChainer.chain(n.children[0], @filename, n).links
           elsif n.type == :send
             if n.children[0].is_a?(::Parser::AST::Node)
               result.concat generate_links(n.children[0])
-              args = []
-              n.children[2..-1].each do |c|
-                args.push NodeChainer.chain(c)
-              end
-              result.push Chain::Call.new(n.children[1].to_s, args, @in_block > 0 || block_passed?(n))
+              result.push Chain::Call.new(n.children[1].to_s, node_args(n), passed_block(n))
             elsif n.children[0].nil?
               args = []
               n.children[2..-1].each do |c|
-                args.push NodeChainer.chain(c)
+                args.push NodeChainer.chain(c, @filename, n)
               end
-              result.push Chain::Call.new(n.children[1].to_s, args, @in_block > 0 || block_passed?(n))
+              result.push Chain::Call.new(n.children[1].to_s, node_args(n), passed_block(n))
             else
               raise "No idea what to do with #{n}"
             end
           elsif n.type == :csend
             if n.children[0].is_a?(::Parser::AST::Node)
               result.concat generate_links(n.children[0])
-              args = []
-              n.children[2..-1].each do |c|
-                args.push NodeChainer.chain(c)
-              end
-              result.push Chain::QCall.new(n.children[1].to_s, args, @in_block > 0 || block_passed?(n))
+              result.push Chain::QCall.new(n.children[1].to_s, node_args(n))
             elsif n.children[0].nil?
-              args = []
-              n.children[2..-1].each do |c|
-                args.push NodeChainer.chain(c)
-              end
-              result.push Chain::QCall.new(n.children[1].to_s, args, @in_block > 0 || block_passed?(n))
+              result.push Chain::QCall.new(n.children[1].to_s, node_args(n))
             else
               raise "No idea what to do with #{n}"
             end
           elsif n.type == :self
             result.push Chain::Head.new('self')
           elsif n.type == :zsuper
-            result.push Chain::ZSuper.new('super', @in_block > 0 || block_passed?(n))
+            result.push Chain::ZSuper.new('super')
           elsif n.type == :super
-            args = n.children.map { |c| NodeChainer.chain(c) }
-            result.push Chain::Call.new('super', args, @in_block > 0 || block_passed?(n))
+            args = n.children.map { |c| NodeChainer.chain(c, @filename, n) }
+            result.push Chain::Call.new('super', args)
           elsif n.type == :yield
-            args = n.children.map { |c| NodeChainer.chain(c) }
-            result.push Chain::Call.new('yield', args, @in_block > 0 || block_passed?(n))
+            args = n.children.map { |c| NodeChainer.chain(c, @filename, n) }
+            result.push Chain::Call.new('yield', args)
           elsif n.type == :const
             const = unpack_name(n)
             result.push Chain::Constant.new(const)
@@ -116,7 +105,9 @@ module Solargraph
           elsif n.type == :and
             result.concat generate_links(n.children.last)
           elsif n.type == :or
-            result.push Chain::Or.new([NodeChainer.chain(n.children[0], @filename), NodeChainer.chain(n.children[1], @filename)])
+            result.push Chain::Or.new([NodeChainer.chain(n.children[0], @filename), NodeChainer.chain(n.children[1], @filename, n)])
+          elsif n.type == :if
+            result.push Chain::If.new([NodeChainer.chain(n.children[1], @filename), NodeChainer.chain(n.children[2], @filename, n)])
           elsif [:begin, :kwbegin].include?(n.type)
             result.concat generate_links(n.children.last)
           elsif n.type == :block_pass
@@ -126,7 +117,11 @@ module Solargraph
               # added in Ruby 3.1 - https://bugs.ruby-lang.org/issues/11256
               result.push Chain::BlockVariable.new(nil)
             else
-              result.push Chain::BlockVariable.new("&#{block_variable_name_node.children[0].to_s}")
+              if block_variable_name_node.type == :sym
+                result.push Chain::BlockSymbol.new("#{block_variable_name_node.children[0].to_s}")
+              else
+                result.push Chain::BlockVariable.new("&#{block_variable_name_node.children[0].to_s}")
+              end
             end
           elsif n.type == :hash
             result.push Chain::Hash.new('::Hash', hash_is_splatted?(n))
@@ -140,6 +135,7 @@ module Solargraph
           result
         end
 
+        # @param node [Parser::AST::Node]
         def hash_is_splatted? node
           return false unless Parser.is_ast_node?(node) && node.type == :hash
           return false unless Parser.is_ast_node?(node.children.last) && node.children.last.type == :kwsplat
@@ -147,8 +143,20 @@ module Solargraph
           true
         end
 
-        def block_passed? node
-          node.children.last.is_a?(::Parser::AST::Node) && node.children.last.type == :block_pass
+        # @param node [Parser::AST::Node]
+        # @return [Source::Chain, nil]
+        def passed_block node
+          return unless node == @node && @parent&.type == :block
+
+          NodeChainer.chain(@parent.children[2], @filename)
+        end
+
+        # @param node [Parser::AST::Node]
+        # @return [Array<Source::Chain>]
+        def node_args node
+          node.children[2..-1].map do |child|
+            NodeChainer.chain(child, @filename, node)
+          end
         end
       end
     end