solargraph 0.59.0.dev.2 → 0.59.0

data/lib/solargraph/library.rb

@@ -1,16 +1,9 @@
 # frozen_string_literal: true
 
-require 'rubygems'
 require 'pathname'
 require 'observer'
 require 'open3'
 
-# @!parse
-#   class ::Gem::Specification
-#     # @return [String]
-#     def name; end
-#   end
-
 module Solargraph
   # A Library handles coordination between a Workspace and an ApiMap.
   #
@@ -40,7 +33,6 @@ module Solargraph
       # @type [Source, nil]
       @current = nil
       @sync_count = 0
-      @cache_progress = nil
     end
 
     def inspect
@@ -65,12 +57,11 @@ module Solargraph
     # @param source [Source, nil]
     # @return [void]
     def attach source
-      # @sg-ignore Need to add nil check here
-      if @current && (!source || @current.filename != source.filename) && source_map_hash.key?(@current.filename) && !workspace.has_file?(@current.filename)
-        # @sg-ignore Need to add nil check here
-        source_map_hash.delete @current.filename
-        # @sg-ignore Need to add nil check here
-        source_map_external_require_hash.delete @current.filename
+      # @type [String, nil]
+      current_filename = @current&.filename
+      if @current && (!source || current_filename != source.filename) && current_filename && source_map_hash.key?(current_filename) && !workspace.has_file?(current_filename)
+        source_map_hash.delete current_filename
+        source_map_external_require_hash.delete current_filename
         @external_requires = nil
       end
       changed = source && @current != source
@@ -193,14 +184,12 @@ module Solargraph
       if cursor.comment?
         source = read(filename)
         offset = Solargraph::Position.to_offset(source.code, Solargraph::Position.new(line, column))
-        # @sg-ignore Need to add nil check here
         # @type [MatchData, nil]
-        lft = source.code[0..(offset - 1)].match(/\[[a-z0-9_:<, ]*?([a-z0-9_:]*)\z/i)
-        # @sg-ignore Need to add nil check here
+        lft = source.code[0..(offset - 1)]&.match(/\[[a-z0-9_:<, ]*?([a-z0-9_:]*)\z/i)
         # @type [MatchData, nil]
-        rgt = source.code[offset..].match(/^([a-z0-9_]*)(:[a-z0-9_:]*)?[\]>, ]/i)
+        rgt = source.code[offset..]&.match(/^([a-z0-9_]*)(:[a-z0-9_:]*)?[\]>, ]/i)
         if lft && rgt
-          # @sg-ignore Need to add nil check here
+          # @sg-ignore lft and rgt are checked for nil above
           tag = (lft[1] + rgt[1]).sub(/:+$/, '')
           clip = mutex.synchronize { api_map.clip(cursor) }
           clip.translate tag
@@ -262,6 +251,7 @@ module Solargraph
       clip = mutex.synchronize { api_map.clip(cursor) }
       pin = clip.define.first
       return [] unless pin
+
       result = []
       files = if only
                 [api_map.source_map(filename)]
@@ -271,19 +261,15 @@ module Solargraph
       files.uniq(&:filename).each do |source|
         found = source.references(pin.name)
         found.select! do |loc|
-          # @sg-ignore Need to add nil check here
-          # @type [Solargraph::Pin::Base, nil]
-          referenced = definitions_at(loc.filename, loc.range.ending.line, loc.range.ending.character).first
+          referenced = definitions_at(loc.filename, loc.range.ending.line, loc.range.ending.character)&.first
           referenced&.path == pin.path
         end
         if pin.path == 'Class#new'
-          # @todo flow sensitive typing should allow shadowing of Kernel#caller
           caller = cursor.chain.base.infer(api_map, clip.send(:closure), 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(:closure), clip.locals).first
-              # @todo flow sensitive typing should allow shadowing of Kernel#caller
               caller == other
             end
           else
@@ -293,13 +279,13 @@ module Solargraph
         # HACK: for language clients that exclude special characters from the start of variable names
         if strip && (match = cursor.word.match(/^[^a-z0-9_]+/i))
           found.map! do |loc|
-            Solargraph::Location.new(loc.filename,
-                                     # @sg-ignore flow sensitive typing needs to handle if foo = bar
-                                     Solargraph::Range.from_to(loc.range.start.line, loc.range.start.column + match[0].length, loc.range.ending.line,
-                                                               loc.range.ending.column))
+            # @sg-ignore Unresolved call to []
+            Solargraph::Location.new(loc.filename, Solargraph::Range.from_to(loc.range.start.line, loc.range.start.column + match[0].length, loc.range.ending.line, loc.range.ending.column))
           end
         end
-        result.concat(found.sort { |a, b| a.range.start.line <=> b.range.start.line })
+        result.concat(found.sort do |a, b|
+          a.range.start.line <=> b.range.start.line
+        end)
       end
       result.uniq
     end
@@ -320,12 +306,13 @@ module Solargraph
     def locate_ref location
       map = source_map_hash[location.filename]
       return if map.nil?
-      # @sg-ignore Need to add nil check here
-      pin = map.requires.select { |p| p.location.range.contain?(location.range.start) }.first
+      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|
-        return Location.new(full, Solargraph::Range.from_to(0, 0, 0, 0)) if source_map_hash.key?(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 = File.join path, pin.name
@@ -423,17 +410,17 @@ module Solargraph
       workspace.config.reporters.each do |line|
         if line == 'all!'
           Diagnostics.reporters.each do |reporter_name|
-            # @sg-ignore Need to add nil check here
-            repargs[Diagnostics.reporter(reporter_name)] ||= []
+            r = Diagnostics.reporter(reporter_name)
+            repargs[r] ||= [] if r
           end
         else
           args = line.split(':').map(&:strip)
           name = args.shift
           reporter = Diagnostics.reporter(name)
           raise DiagnosticsError, "Diagnostics reporter #{name} does not exist" if reporter.nil?
-          # @sg-ignore flow sensitive typing needs to handle 'raise if'
+          # @sg-ignore Hash errors
           repargs[reporter] ||= []
-          # @sg-ignore flow sensitive typing needs to handle 'raise if'
+          # @sg-ignore Hash errors
           repargs[reporter].concat args
         end
       end
@@ -456,7 +443,7 @@ module Solargraph
         source_maps: source_map_hash.values,
         workspace: workspace,
         external_requires: external_requires,
-        # @sg-ignore Need to add nil check here
+        # @sg-ignore OK if @current.filename is nil
         live_map: @current ? source_map_hash[@current.filename] : nil
       )
     end
@@ -493,13 +480,12 @@ module Solargraph
     # @return [SourceMap, Boolean]
     def next_map
       return false if mapped?
-      # @sg-ignore Need to add nil check here
       src = workspace.sources.find { |s| !source_map_hash.key?(s.filename) }
       if src
         Logging.logger.debug "Mapping #{src.filename}"
-        # @sg-ignore Need to add nil check here
+        # @sg-ignore OK if src.filename is nil
         source_map_hash[src.filename] = Solargraph::SourceMap.map(src)
-        # @sg-ignore Need to add nil check here
+        # @sg-ignore OK if src.filename is nil
         source_map_hash[src.filename]
       else
         false
@@ -509,9 +495,9 @@ module Solargraph
     # @return [self]
     def map!
       workspace.sources.each do |src|
-        # @sg-ignore Need to add nil check here
+        # @sg-ignore OK if src.filename is nil
         source_map_hash[src.filename] = Solargraph::SourceMap.map(src)
-        # @sg-ignore Need to add nil check here
+        # @sg-ignore OK if src.filename is nil
         find_external_requires source_map_hash[src.filename]
       end
       self
@@ -529,11 +515,6 @@ module Solargraph
 
     private
 
-    # @return [PinCache]
-    def pin_cache
-      workspace.pin_cache
-    end
-
     # @return [Hash{String => Array<String>}]
     def source_map_external_require_hash
       @source_map_external_require_hash ||= {}
@@ -544,10 +525,9 @@ module Solargraph
     def find_external_requires source_map
       # @type [Set<String>]
       new_set = source_map.requires.to_set(&:name)
-      # return if new_set == source_map_external_require_hash[source_map.filename]
       _filenames = nil
       filenames = -> { _filenames ||= workspace.filenames.to_set }
-      # @sg-ignore Need to add nil check here
+      # @sg-ignore OK if source_map.filename is nil
       source_map_external_require_hash[source_map.filename] = new_set.reject do |path|
         workspace.require_paths.any? do |base|
           full = File.join(base, path)
@@ -594,15 +574,14 @@ module Solargraph
     # @return [void]
     def maybe_map source
       return unless source
-      # @sg-ignore Need to add nil check here
+      # @sg-ignore Wrong argument type for Solargraph::Workspace#has_file?: filename expected String, received String, nil
       return unless @current == source || workspace.has_file?(source.filename)
-      # @sg-ignore Need to add nil check here
       if source_map_hash.key?(source.filename)
         new_map = Solargraph::SourceMap.map(source)
-        # @sg-ignore Need to add nil check here
+        # @sg-ignore OK if source.filename is nil
         source_map_hash[source.filename] = new_map
       else
-        # @sg-ignore Need to add nil check here
+        # @sg-ignore OK if source.filename is nil
         source_map_hash[source.filename] = Solargraph::SourceMap.map(source)
       end
     end
@@ -621,7 +600,7 @@ module Solargraph
 
       pending = api_map.uncached_gemspecs.length - cache_errors.length - 1
 
-      if pin_cache.yardoc_processing?(spec)
+      if Yardoc.processing?(spec)
         logger.info "Enqueuing cache of #{spec.name} #{spec.version} (already being processed)"
         queued_gemspec_cache.push(spec)
         return if pending - queued_gemspec_cache.length < 1
@@ -632,10 +611,7 @@ module Solargraph
         logger.info "Caching #{spec.name} #{spec.version}"
         Thread.new do
           report_cache_progress spec.name, pending
-          kwargs = {}
-          kwargs[:chdir] = workspace.directory.to_s if workspace.directory && !workspace.directory.empty?
-          _o, e, s = Open3.capture3(workspace.command_path, 'cache', spec.name, spec.version.to_s,
-                                    **kwargs)
+          _o, e, s = Open3.capture3(workspace.command_path, 'cache', spec.name, spec.version.to_s)
           if s.success?
             logger.info "Cached #{spec.name} #{spec.version}"
           else
@@ -652,7 +628,8 @@ module Solargraph
 
     # @return [Array<Gem::Specification>]
     def cacheable_specs
-      cacheable = api_map.uncached_gemspecs +
+      cacheable = api_map.uncached_yard_gemspecs +
+                  api_map.uncached_rbs_collection_gemspecs -
                   queued_gemspec_cache -
                   cache_errors.to_a
       return cacheable unless cacheable.empty?
@@ -670,15 +647,15 @@ module Solargraph
     # @return [void]
     def report_cache_progress gem_name, pending
       @total ||= pending
-      # @sg-ignore flow sensitive typing needs better handling of ||= on lvars
+      # @sg-ignore Wrong argument type for Integer#>: arg_0 expected Numeric, received Integer, nil
       @total = pending if pending > @total
-      # @sg-ignore flow sensitive typing needs better handling of ||= on lvars
+      # @sg-ignore Unresolved call to - on Integer, nil
       finished = @total - pending
-      # @sg-ignore flow sensitive typing needs better handling of ||= on lvars
+      # @sg-ignore @total should always be an Integer
       pct = if @total.zero?
               0
             else
-              # @sg-ignore flow sensitive typing needs better handling of ||= on lvars
+              # @sg-ignore Unresolved call to to_f
               ((finished.to_f / @total) * 100).to_i
             end
       message = "#{gem_name}#{" (+#{pending})" if pending.positive?}"
@@ -687,12 +664,12 @@ module Solargraph
         @cache_progress = LanguageServer::Progress.new('Caching gem')
         # If we don't send both a begin and a report, the progress notification
         # might get stuck in the status bar forever
-        # @sg-ignore flow sensitive typing should be able to handle redefinition
+        # @sg-ignore Unresolved call to begin
         @cache_progress.begin(message, pct)
         changed
         notify_observers @cache_progress
       end
-      # @sg-ignore flow sensitive typing should be able to handle redefinition
+      # @sg-ignore Unresolved call to report
       @cache_progress.report(message, pct)
       changed
       notify_observers @cache_progress
@@ -715,7 +692,8 @@ module Solargraph
         source_map_hash.each_value { |map| find_external_requires(map) }
         api_map.catalog bench
         logger.info "Catalog complete (#{api_map.source_maps.length} files, #{api_map.pins.length} pins)"
-        logger.info "#{api_map.uncached_gemspecs.length} uncached gemspecs"
+        logger.info "#{api_map.uncached_yard_gemspecs.length} uncached YARD gemspecs"
+        logger.info "#{api_map.uncached_rbs_collection_gemspecs.length} uncached RBS collection gemspecs"
         cache_next_gemspec
         @sync_count = 0
       end

data/lib/solargraph/logging.rb

@@ -47,8 +47,6 @@ module Solargraph
         new_log_level = LOG_LEVELS[log_level.to_s]
         logger = Logger.new($stderr, level: new_log_level)
 
-        # @sg-ignore Wrong argument type for Logger#formatter=: arg_0
-        #   expected nil, received Logger::_Formatter, nil
         logger.formatter = @@logger.formatter
         logger
       end

data/lib/solargraph/parser/flow_sensitive_typing.rb

@@ -275,7 +275,6 @@ module Solargraph
         end
         # or like this:
         # (lvar :repr)
-        # @sg-ignore Need to look at Tuple#include? handling
         variable_name = call_receiver.children[0].to_s if %i[lvar ivar].include?(call_receiver&.type)
         return unless variable_name
 
@@ -463,7 +462,6 @@ module Solargraph
       # @param clause_node [Parser::AST::Node, nil]
       def always_leaves_compound_statement? clause_node
         # https://docs.ruby-lang.org/en/2.2.0/keywords_rdoc.html
-        # @sg-ignore Need to look at Tuple#include? handling
         %i[return raise next redo retry].include?(clause_node&.type)
       end
 

data/lib/solargraph/parser/parser_gem/class_methods.rb

@@ -34,9 +34,7 @@ module Solargraph
         # @return [::Parser::Base]
         def parser
           @parser ||= Prism::Translation::Parser.new(FlawedBuilder.new).tap do |parser|
-            # @sg-ignore Unresolved call to diagnostics on Prism::Translation::Parser
             parser.diagnostics.all_errors_are_fatal = true
-            # @sg-ignore Unresolved call to diagnostics on Prism::Translation::Parser
             parser.diagnostics.ignore_warnings      = true
           end
         end

data/lib/solargraph/parser/parser_gem/node_processors/block_node.rb

@@ -36,7 +36,6 @@ module Solargraph
           def other_class_eval?
             node.children[0].type == :send &&
               node.children[0].children[1] == :class_eval &&
-              # @sg-ignore Need to add nil check here
               %i[cbase const].include?(node.children[0].children[0]&.type)
           end
         end

data/lib/solargraph/pin/base.rb

@@ -241,8 +241,6 @@ module Solargraph
         results = [self, other].map(&attr).compact
         # true and false are different classes and can't be sorted
 
-        # @sg-ignore Wrong argument type for Array#include?: object
-        #   expected Boolean, received Proc
         return true if results.any? { |r| [true, false].include?(r) }
         return results.first if results.any? { |r| r.is_a? AST::Node }
         results.min

data/lib/solargraph/pin/method.rb

@@ -505,6 +505,9 @@ module Solargraph
       #
       # @return [Array<Pin::Signature>]
       def combine_same_type_arity_signatures same_type_arity_signatures
+        # @todo Stubbing this method while we debug an infinite loop bug in Ruby 3.x
+        return same_type_arity_signatures
+
         # This is an O(n^2) operation, so bail out if n is not small
         return same_type_arity_signatures if same_type_arity_signatures.length > 10
 

data/lib/solargraph/pin/reference/type_alias.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Solargraph
+  module Pin
+    class Reference
+      class TypeAlias < Reference
+        # @param return_type [ComplexType]
+        # @param [Hash{Symbol => Object}] splat
+        def initialize return_type:, **splat
+          super(**splat)
+          @return_type = return_type
+        end
+      end
+    end
+  end
+end

data/lib/solargraph/pin/reference.rb

@@ -9,6 +9,7 @@ module Solargraph
       autoload :Prepend,    'solargraph/pin/reference/prepend'
       autoload :Extend,     'solargraph/pin/reference/extend'
       autoload :Override,   'solargraph/pin/reference/override'
+      autoload :TypeAlias,  'solargraph/pin/reference/type_alias'
 
       attr_reader :generic_values