solargraph 0.56.0 → 0.58.1

data/lib/solargraph/language_server/host.rb

@@ -94,7 +94,8 @@ module Solargraph
       # processed, caller is responsible for sending the response.
       #
       # @param request [Hash{String => unspecified}] The contents of the message.
-      # @return [Solargraph::LanguageServer::Message::Base, nil] The message handler.
+      #
+      # @return [Solargraph::LanguageServer::Message::Base, Solargraph::LanguageServer::Request, nil] The message handler.
       def receive request
         if request['method']
           logger.info "Host received ##{request['id']} #{request['method']}"
@@ -299,6 +300,7 @@ module Solargraph
         end
       end
 
+      # @return [String]
       def command_path
         options['commandPath'] || 'solargraph'
       end
@@ -502,6 +504,7 @@ module Solargraph
                 name: 'new',
                 scope: :class,
                 location: pin.location,
+                # @sg-ignore Unresolved call to parameters on Solargraph::Pin::Base
                 parameters: pin.parameters,
                 return_type: ComplexType.try_parse(params['data']['path']),
                 comments: pin.comments,
@@ -533,7 +536,7 @@ module Solargraph
       # @param uri [String]
       # @param line [Integer]
       # @param column [Integer]
-      # @return [Solargraph::SourceMap::Completion]
+      # @return [Solargraph::SourceMap::Completion, nil]
       def completions_at uri, line, column
         library = library_for(uri)
         library.completions_at uri_to_file(uri), line, column
@@ -547,7 +550,7 @@ module Solargraph
       # @param uri [String]
       # @param line [Integer]
       # @param column [Integer]
-      # @return [Array<Solargraph::Pin::Base>]
+      # @return [Array<Solargraph::Pin::Base>, nil]
       def definitions_at uri, line, column
         library = library_for(uri)
         library.definitions_at(uri_to_file(uri), line, column)
@@ -556,7 +559,7 @@ module Solargraph
       # @param uri [String]
       # @param line [Integer]
       # @param column [Integer]
-      # @return [Array<Solargraph::Pin::Base>]
+      # @return [Array<Solargraph::Pin::Base>, nil]
       def type_definitions_at uri, line, column
         library = library_for(uri)
         library.type_definitions_at(uri_to_file(uri), line, column)
@@ -580,6 +583,10 @@ module Solargraph
       def references_from uri, line, column, strip: true, only: false
         library = library_for(uri)
         library.references_from(uri_to_file(uri), line, column, strip: strip, only: only)
+      rescue FileNotFoundError, InvalidOffsetError => e
+        Solargraph.logger.warn "[#{e.class}] #{e.message}"
+        Solargraph.logger.debug e.backtrace
+        []
       end
 
       # @param query [String]
@@ -716,7 +723,7 @@ module Solargraph
       # A hash of client requests by ID. The host uses this to keep track of
       # pending responses.
       #
-      # @return [Hash{Integer => Solargraph::LanguageServer::Host}]
+      # @return [Hash{Integer => Solargraph::LanguageServer::Request}]
       def requests
         @requests ||= {}
       end

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

@@ -16,7 +16,7 @@ module Solargraph
         # @return [String]
         attr_reader :method
 
-        # @return [Hash{String => Array<undefined>, Hash{String => undefined}, String, Integer}]
+        # @return [Hash{String => undefined}]
         attr_reader :params
 
         # @return [Hash, Array, nil]
@@ -79,6 +79,7 @@ module Solargraph
 
         private
 
+        # @return [void]
         def accept_or_cancel
           if host.cancel?(id)
             # https://microsoft.github.io/language-server-protocol/specifications/specification-current/#cancelRequest

data/lib/solargraph/language_server/message/extended/check_gem_version.rb

@@ -83,7 +83,7 @@ module Solargraph
               @fetched = true
               begin
                 @available ||= begin
-                  # @sg-ignore
+                  # @sg-ignore Variable type could not be inferred for tuple
                   # @type [Gem::Dependency, nil]
                   tuple = CheckGemVersion.fetcher.search_for_dependency(Gem::Dependency.new('solargraph')).flatten.first
                   if tuple.nil?

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

@@ -10,6 +10,7 @@ module Solargraph::LanguageServer::Message::TextDocument
 
     private
 
+    # @return [Array<Hash>, nil]
     def code_location
       suggestions = host.definitions_at(params['textDocument']['uri'], @line, @column)
       return nil if suggestions.empty?
@@ -21,6 +22,7 @@ module Solargraph::LanguageServer::Message::TextDocument
       end
     end
 
+    # @return [Array<Hash>, nil]
     def require_location
       # @todo Terrible hack
       lib = host.library_for(params['textDocument']['uri'])

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

@@ -18,10 +18,18 @@ module Solargraph
 
             require_rubocop(config['version'])
             options, paths = ::RuboCop::Options.new.parse(args)
+            # @sg-ignore Unresolved call to []=
             options[:stdin] = original
-            corrections = redirect_stdout do
-              ::RuboCop::Runner.new(options, ::RuboCop::ConfigStore.new).run(paths)
+
+            # Ensure only one instance of RuboCop::Runner is running at
+            # a time - it uses 'chdir' to read config files with ERB,
+            # which can conflict with other chdirs.
+            corrections = Solargraph::CHDIR_MUTEX.synchronize do
+              redirect_stdout do
+                ::RuboCop::Runner.new(options, ::RuboCop::ConfigStore.new).run(paths)
+              end
             end
+            # @sg-ignore Unresolved call to []=
             result = options[:stdin]
 
             log_corrections(corrections)
@@ -34,6 +42,7 @@ module Solargraph
           private
 
           # @param corrections [String]
+          # @return [void]
           def log_corrections(corrections)
             corrections = corrections&.strip
             return if corrections&.empty?
@@ -45,6 +54,8 @@ module Solargraph
             end
           end
 
+          # @param file_uri [String]
+          # @return [Hash{String => undefined}]
           def config_for(file_uri)
             conf = host.formatter_config(file_uri)
             return {} unless conf.is_a?(Hash)
@@ -52,7 +63,9 @@ module Solargraph
             conf['rubocop'] || {}
           end
 
+          # @param file_uri [String]
           # @param config [Hash{String => String}]
+          # @return [Array<String>]
           def cli_args file_uri, config
             file = UriHelpers.uri_to_file(file_uri)
             args = [
@@ -71,6 +84,8 @@ module Solargraph
           end
 
           # @param config [Hash{String => String}]
+          # @sg-ignore
+          # @return [Class<RuboCop::Formatter::BaseFormatter>]
           def formatter_class(config)
             if self.class.const_defined?('BlankRubocopFormatter')
               # @sg-ignore
@@ -83,7 +98,9 @@ module Solargraph
           end
 
           # @param value [Array, String]
+          # @return [String, nil]
           def cop_list(value)
+            # @type [String]
             value = value.join(',') if value.respond_to?(:join)
             return nil if value == '' || !value.is_a?(String)
             value

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

@@ -10,6 +10,7 @@ module Solargraph::LanguageServer::Message::TextDocument
 
     private
 
+    # @return [Array<Hash>, nil]
     def code_location
       suggestions = host.type_definitions_at(params['textDocument']['uri'], @line, @column)
       return nil if suggestions.empty?

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

@@ -9,11 +9,13 @@ module Solargraph::LanguageServer::Message::Workspace
 
     private
 
+    # @return [void]
     def add_folders
       return unless params['event'] && params['event']['added']
       host.prepare_folders params['event']['added']
     end
 
+    # @return [void]
     def remove_folders
       return unless params['event'] && params['event']['removed']
       params['event']['removed'].each do |folder|

data/lib/solargraph/language_server/progress.rb

@@ -39,6 +39,7 @@ module Solargraph
 
       # @param message [String]
       # @param percentage [Integer]
+      # @return [void]
       def begin message, percentage
         @kind = 'begin'
         @message = message
@@ -47,6 +48,7 @@ module Solargraph
 
       # @param message [String]
       # @param percentage [Integer]
+      # @return [void]
       def report message, percentage
         @kind = 'report'
         @message = message
@@ -54,6 +56,7 @@ module Solargraph
       end
 
       # @param message [String]
+      # @return [void]
       def finish message
         @kind = 'end'
         @message = message
@@ -62,6 +65,7 @@ module Solargraph
       end
 
       # @param host [Solargraph::LanguageServer::Host]
+      # @return [void]
       def send host
         return unless host.client_supports_progress? && !finished?
 
@@ -91,6 +95,7 @@ module Solargraph
         @status = CREATED
       end
 
+      # @return [Hash]
       def build
         {
           token: uuid,
@@ -101,6 +106,7 @@ module Solargraph
         }
       end
 
+      # @return [Hash]
       def build_value
         case kind
         when 'begin'
@@ -115,6 +121,7 @@ module Solargraph
       end
 
       # @param host [Host]
+      # @return [void]
       def keep_alive host
         mutex.synchronize { @last = Time.now }
         @keep_alive ||= Thread.new do
@@ -127,6 +134,7 @@ module Solargraph
         end
       end
 
+      # @return [Thread::Mutex]
       def mutex
         @mutex ||= Mutex.new
       end

data/lib/solargraph/language_server/request.rb

@@ -11,11 +11,14 @@ module Solargraph
       end
 
       # @param result [Object]
-      # @return [void]
+      # @generic T
+      # @yieldreturn [generic<T>]
+      # @return [generic<T>, nil]
       def process result
         @block.call(result) unless @block.nil?
       end
 
+      # @return [void]
       def send_response
         # noop
       end

data/lib/solargraph/library.rb

@@ -2,6 +2,7 @@
 
 require 'pathname'
 require 'observer'
+require 'open3'
 
 module Solargraph
   # A Library handles coordination between a Workspace and an ApiMap.
@@ -258,11 +259,11 @@ module Solargraph
           referenced&.path == pin.path
         end
         if pin.path == 'Class#new'
-          caller = cursor.chain.base.infer(api_map, clip.send(:block), clip.locals).first
+          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(:block), clip.locals).first
+              other = clip.send(:cursor).chain.base.infer(api_map, clip.send(:closure), clip.locals).first
               caller == other
             end
           else
@@ -401,8 +402,8 @@ module Solargraph
       repargs = {}
       workspace.config.reporters.each do |line|
         if line == 'all!'
-          Diagnostics.reporters.each do |reporter|
-            repargs[reporter] ||= []
+          Diagnostics.reporters.each do |reporter_name|
+            repargs[Diagnostics.reporter(reporter_name)] ||= []
           end
         else
           args = line.split(':').map(&:strip)
@@ -436,17 +437,6 @@ module Solargraph
       )
     end
 
-    # Get an array of foldable ranges for the specified file.
-    #
-    # @deprecated The library should not need to handle folding ranges. The
-    #   source itself has all the information it needs.
-    #
-    # @param filename [String]
-    # @return [Array<Range>]
-    def folding_ranges filename
-      read(filename).folding_ranges
-    end
-
     # Create a library from a directory.
     #
     # @param directory [String] The path to be used for the workspace
@@ -510,7 +500,7 @@ module Solargraph
 
     private
 
-    # @return [Hash{String => Set<String>}]
+    # @return [Hash{String => Array<String>}]
     def source_map_external_require_hash
       @source_map_external_require_hash ||= {}
     end
@@ -518,6 +508,7 @@ module Solargraph
     # @param source_map [SourceMap]
     # @return [void]
     def find_external_requires source_map
+      # @type [Set<String>]
       new_set = source_map.requires.map(&:name).to_set
       # return if new_set == source_map_external_require_hash[source_map.filename]
       _filenames = nil
@@ -531,7 +522,7 @@ module Solargraph
       @external_requires = nil
     end
 
-    # @return [Mutex]
+    # @return [Thread::Mutex]
     def mutex
       @mutex ||= Mutex.new
     end
@@ -588,29 +579,54 @@ module Solargraph
     # @return [void]
     def cache_next_gemspec
       return if @cache_progress
-      spec = (api_map.uncached_yard_gemspecs + api_map.uncached_rbs_collection_gemspecs).
-               find { |spec| !cache_errors.include?(spec) }
+
+      spec = cacheable_specs.first
       return end_cache_progress unless spec
 
       pending = api_map.uncached_gemspecs.length - cache_errors.length - 1
-      logger.info "Caching #{spec.name} #{spec.version}"
-      Thread.new do
-        cache_pid = Process.spawn(workspace.command_path, 'cache', spec.name, spec.version.to_s)
-        report_cache_progress spec.name, pending
-        Process.wait(cache_pid)
-        logger.info "Cached #{spec.name} #{spec.version}"
-      rescue Errno::EINVAL => _e
-        logger.info "Cached #{spec.name} #{spec.version} with EINVAL"
-      rescue StandardError => e
-        cache_errors.add spec
-        Solargraph.logger.warn "Error caching gemspec #{spec.name} #{spec.version}: [#{e.class}] #{e.message}"
-      ensure
-        end_cache_progress
+
+      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
+
         catalog
         sync_catalog
+      else
+        logger.info "Caching #{spec.name} #{spec.version}"
+        Thread.new do
+          report_cache_progress spec.name, pending
+          _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
+            cache_errors.add spec
+            logger.warn "Error caching gemspec #{spec.name} #{spec.version}"
+            logger.warn e
+          end
+          end_cache_progress
+          catalog
+          sync_catalog
+        end
       end
     end
 
+    # @return [Array<Gem::Specification>]
+    def cacheable_specs
+      cacheable = api_map.uncached_yard_gemspecs +
+                  api_map.uncached_rbs_collection_gemspecs -
+                  queued_gemspec_cache -
+                  cache_errors.to_a
+      return cacheable unless cacheable.empty?
+
+      queued_gemspec_cache
+    end
+
+    # @return [Array<Gem::Specification>]
+    def queued_gemspec_cache
+      @queued_gemspec_cache ||= []
+    end
+
     # @param gem_name [String]
     # @param pending [Integer]
     # @return [void]
@@ -648,13 +664,14 @@ module Solargraph
       @total = nil
     end
 
+    # @return [void]
     def sync_catalog
       return if @sync_count == 0
 
       mutex.synchronize do
         logger.info "Cataloging #{workspace.directory.empty? ? 'generic workspace' : workspace.directory}"
-        api_map.catalog bench
         source_map_hash.values.each { |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_yard_gemspecs.length} uncached YARD gemspecs"
         logger.info "#{api_map.uncached_rbs_collection_gemspecs.length} uncached RBS collection gemspecs"

data/lib/solargraph/location.rb

@@ -25,6 +25,7 @@ module Solargraph
       [filename, range]
     end
 
+    # @param other [self]
     def <=>(other)
       return nil unless other.is_a?(Location)
       if filename == other.filename
@@ -60,6 +61,7 @@ module Solargraph
     end
 
     # @param node [Parser::AST::Node, nil]
+    # @return [Location, nil]
     def self.from_node(node)
       return nil if node.nil? || node.loc.nil?
       range = Range.from_node(node)
@@ -69,6 +71,7 @@ module Solargraph
     # @param other [BasicObject]
     def == other
       return false unless other.is_a?(Location)
+      # @sg-ignore https://github.com/castwide/solargraph/pull/1114
       filename == other.filename and range == other.range
     end
 

data/lib/solargraph/logging.rb

@@ -11,8 +11,17 @@ module Solargraph
       'info' => Logger::INFO,
       'debug' => Logger::DEBUG
     }
-
-    @@logger = Logger.new(STDERR, level: DEFAULT_LOG_LEVEL)
+    configured_level = ENV.fetch('SOLARGRAPH_LOG', nil)
+    level = if LOG_LEVELS.keys.include?(configured_level)
+              LOG_LEVELS.fetch(configured_level)
+            else
+              if configured_level
+                warn "Invalid value for SOLARGRAPH_LOG: #{configured_level.inspect} - " \
+                     "valid values are #{LOG_LEVELS.keys}"
+              end
+              DEFAULT_LOG_LEVEL
+            end
+    @@logger = Logger.new(STDERR, level: level)
     # @sg-ignore Fix cvar issue
     @@logger.formatter = proc do |severity, datetime, progname, msg|
       "[#{severity}] #{msg}\n"

data/lib/solargraph/page.rb

@@ -29,6 +29,7 @@ module Solargraph
       # @param text [String]
       # @return [String]
       def htmlify text
+        # @type [String]
         YARD::Templates::Helpers::Markup::RDocMarkup.new(text).to_html
       end
 
@@ -70,8 +71,10 @@ module Solargraph
     # @param template [String]
     # @param layout [Boolean]
     # @param locals [Hash]
+    # @sg-ignore
     # @return [String]
     def render template, layout: true, locals: {}
+      # @type [String]
       @render_method.call(template, layout: layout, locals: locals)
     end
 

data/lib/solargraph/parser/comment_ripper.rb

@@ -3,6 +3,13 @@ require 'ripper'
 module Solargraph
   module Parser
     class CommentRipper < Ripper::SexpBuilderPP
+      # @!override Ripper::SexpBuilder#on_embdoc_beg
+      #   @return [Array(Symbol, String, Array)]
+      # @!override Ripper::SexpBuilder#on_embdoc
+      #   @return [Array(Symbol, String, Array)]
+      # @!override Ripper::SexpBuilder#on_embdoc_end
+      #   @return [Array(Symbol, String, Array)]
+
       # @param src [String]
       # @param filename [String]
       # @param lineno [Integer]
@@ -51,7 +58,7 @@ module Solargraph
         result
       end
 
-      # @return [Hash{Integer => String}]
+      # @return [Hash{Integer => Solargraph::Parser::Snippet}]
       def parse
         @comments = {}
         super

data/lib/solargraph/parser/flow_sensitive_typing.rb

@@ -4,14 +4,20 @@ module Solargraph
       include Solargraph::Parser::NodeMethods
 
       # @param locals [Array<Solargraph::Pin::LocalVariable, Solargraph::Pin::Parameter>]
+      # @param enclosing_breakable_pin [Solargraph::Pin::Breakable, nil]
       def initialize(locals, enclosing_breakable_pin = nil)
         @locals = locals
         @enclosing_breakable_pin = enclosing_breakable_pin
       end
 
       # @param and_node [Parser::AST::Node]
+      # @param true_ranges [Array<Range>]
+      #
+      # @return [void]
       def process_and(and_node, true_ranges = [])
+        # @type [Parser::AST::Node]
         lhs = and_node.children[0]
+        # @type [Parser::AST::Node]
         rhs = and_node.children[1]
 
         before_rhs_loc = rhs.location.expression.adjust(begin_pos: -1)
@@ -23,6 +29,8 @@ module Solargraph
       end
 
       # @param if_node [Parser::AST::Node]
+      #
+      # @return [void]
       def process_if(if_node)
         #
         # See if we can refine a type based on the result of 'if foo.nil?'
@@ -36,7 +44,9 @@ module Solargraph
         #   s(:send, nil, :bar))
         # [4] pry(main)>
         conditional_node = if_node.children[0]
+        # @type [Parser::AST::Node]
         then_clause = if_node.children[1]
+        # @type [Parser::AST::Node]
         else_clause = if_node.children[2]
 
         true_ranges = []
@@ -72,8 +82,11 @@ module Solargraph
       # them based on the Closure and Location.
       #
       # @param pins [Array<Pin::LocalVariable>]
+      # @param name [String]
       # @param closure [Pin::Closure]
       # @param location [Location]
+      #
+      # @return [Array<Pin::LocalVariable>]
       def self.visible_pins(pins, name, closure, location)
         logger.debug { "FlowSensitiveTyping#visible_pins(name=#{name}, closure=#{closure}, location=#{location})" }
         pins_with_name = pins.select { |p| p.name == name }
@@ -107,7 +120,10 @@ module Solargraph
       private
 
       # @param pin [Pin::LocalVariable]
-      # @param if_node [Parser::AST::Node]
+      # @param downcast_type_name [String]
+      # @param presence [Range]
+      #
+      # @return [void]
       def add_downcast_local(pin, downcast_type_name, presence)
         # @todo Create pin#update method
         new_pin = Solargraph::Pin::LocalVariable.new(
@@ -126,6 +142,7 @@ module Solargraph
 
       # @param facts_by_pin [Hash{Pin::LocalVariable => Array<Hash{Symbol => String}>}]
       # @param presences [Array<Range>]
+      #
       # @return [void]
       def process_facts(facts_by_pin, presences)
         #
@@ -142,6 +159,9 @@ module Solargraph
       end
 
       # @param conditional_node [Parser::AST::Node]
+      # @param true_ranges [Array<Range>]
+      #
+      # @return [void]
       def process_conditional(conditional_node, true_ranges)
         if conditional_node.type == :send
           process_isa(conditional_node, true_ranges)
@@ -151,7 +171,7 @@ module Solargraph
       end
 
       # @param isa_node [Parser::AST::Node]
-      # @return [Array(String, String)]
+      # @return [Array(String, String), nil]
       def parse_isa(isa_node)
         return unless isa_node&.type == :send && isa_node.children[1] == :is_a?
         # Check if conditional node follows this pattern:
@@ -176,12 +196,20 @@ module Solargraph
         [isa_type_name, variable_name]
       end
 
+      # @param variable_name [String]
+      # @param position [Position]
+      #
+      # @return [Solargraph::Pin::LocalVariable, nil]
       def find_local(variable_name, position)
         pins = locals.select { |pin| pin.name == variable_name && pin.presence.include?(position) }
         return unless pins.length == 1
         pins.first
       end
 
+      # @param isa_node [Parser::AST::Node]
+      # @param true_presences [Array<Range>]
+      #
+      # @return [void]
       def process_isa(isa_node, true_presences)
         isa_type_name, variable_name = parse_isa(isa_node)
         return if variable_name.nil? || variable_name.empty?
@@ -197,10 +225,12 @@ module Solargraph
       end
 
       # @param node [Parser::AST::Node]
+      #
+      # @return [String, nil]
       def type_name(node)
         # e.g.,
         #  s(:const, nil, :Baz)
-        return unless node.type == :const
+        return unless node&.type == :const
         module_node = node.children[0]
         class_node = node.children[1]
 
@@ -212,8 +242,6 @@ module Solargraph
         "#{module_type_name}::#{class_node}"
       end
 
-      # @todo "return type could not be inferred" should not trigger here
-      # @sg-ignore
       # @param clause_node [Parser::AST::Node]
       def always_breaks?(clause_node)
         clause_node&.type == :break