solargraph 0.54.4 → 0.57.0

data/lib/solargraph/language_server/host/message_worker.rb

@@ -7,9 +7,16 @@ module Solargraph
       #
       class MessageWorker
         UPDATE_METHODS = [
-          'textDocument/didOpen',
           'textDocument/didChange',
-          'workspace/didChangeWatchedFiles'
+          'textDocument/didClose',
+          'textDocument/didOpen',
+          'textDocument/didSave',
+          'workspace/didChangeConfiguration',
+          'workspace/didChangeWatchedFiles',
+          'workspace/didCreateFiles',
+          'workspace/didChangeWorkspaceFolders',
+          'workspace/didDeleteFiles',
+          'workspace/didRenameFiles'
         ].freeze
 
         # @param host [Host]
@@ -65,10 +72,12 @@ module Solargraph
 
         private
 
+        # @return [Hash, nil]
         def next_message
           cancel_message || next_priority
         end
 
+        # @return [Hash, nil]
         def cancel_message
           # Handle cancellations first
           idx = messages.find_index { |msg| msg['method'] == '$/cancelRequest' }
@@ -79,16 +88,13 @@ module Solargraph
           msg
         end
 
+        # @return [Hash, nil]
         def next_priority
           # Prioritize updates and version-dependent messages for performance
           idx = messages.find_index do |msg|
             UPDATE_METHODS.include?(msg['method']) || version_dependent?(msg)
           end
-          return messages.shift unless idx
-
-          msg = messages[idx]
-          messages.delete_at idx
-          msg
+          idx ? messages.delete_at(idx) : messages.shift
         end
 
         # True if the message requires a previous update to have executed in

data/lib/solargraph/language_server/host.rb

@@ -299,6 +299,11 @@ module Solargraph
         end
       end
 
+      # @return [String]
+      def command_path
+        options['commandPath'] || 'solargraph'
+      end
+
       # Prepare multiple folders.
       #
       # @param array [Array<Hash{String => String}>]
@@ -501,7 +506,8 @@ module Solargraph
                 parameters: pin.parameters,
                 return_type: ComplexType.try_parse(params['data']['path']),
                 comments: pin.comments,
-                closure: pin.closure
+                closure: pin.closure,
+                source: :solargraph
               )
             end)
           end
@@ -597,7 +603,11 @@ module Solargraph
       # @return [Array]
       def document query
         result = []
-        libraries.each { |lib| result.concat lib.document(query) }
+        if libraries.empty?
+          result.concat generic_library.document(query)
+        else
+          libraries.each { |lib| result.concat lib.document(query) }
+        end
         result
       end
 
@@ -707,7 +717,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
@@ -749,6 +759,7 @@ module Solargraph
         return change if source.code.length + 1 != change['text'].length
         diffs = Diff::LCS.diff(source.code, change['text'])
         return change if diffs.length.zero? || diffs.length > 1 || diffs.first.length > 1
+        # @sg-ignore push this upstream
         # @type [Diff::LCS::Change]
         diff = diffs.first.first
         return change unless diff.adding? && ['.', ':', '(', ',', ' '].include?(diff.element)

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,6 +83,8 @@ module Solargraph
               @fetched = true
               begin
                 @available ||= begin
+                  # @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?
                     @error = 'An error occurred fetching the gem data'

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

@@ -6,12 +6,15 @@ module Solargraph
       module Extended
         class Document < Base
           def process
-            objects = host.document(params['query'])
+            api_map, pins = host.document(params['query'])
             page = Solargraph::Page.new(host.options['viewsPath'])
-            content = page.render('document', layout: true, locals: {objects: objects})
+            content = page.render('document', layout: true, locals: { api_map: api_map, pins: pins })
             set_result(
               content: content
             )
+          rescue StandardError => e
+            Solargraph.logger.warn "Error processing document: [#{e.class}] #{e.message}"
+            Solargraph.logger.debug e.backtrace.join("\n")
           end
         end
       end

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

@@ -11,9 +11,9 @@ module Solargraph
         #
         class DocumentGems < Base
           def process
-            cmd = "yard gems"
-            cmd += " --rebuild" if params['rebuild']
-            o, s = Open3.capture2(cmd)
+            cmd = [host.command_path, 'gems']
+            cmd.push '--rebuild' if params['rebuild']
+            o, s = Open3.capture2(*cmd)
             if s != 0
               host.show_message "An error occurred while building gem documentation.", LanguageServer::MessageTypes::ERROR
               set_result({

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

@@ -10,6 +10,7 @@ module Solargraph::LanguageServer::Message::TextDocument
 
     private
 
+    # @return [Array<Hash>]
     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>]
     def require_location
       # @todo Terrible hack
       lib = host.library_for(params['textDocument']['uri'])

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

@@ -19,8 +19,14 @@ module Solargraph
             require_rubocop(config['version'])
             options, paths = ::RuboCop::Options.new.parse(args)
             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
             result = options[:stdin]
 
@@ -34,6 +40,7 @@ module Solargraph
           private
 
           # @param corrections [String]
+          # @return [void]
           def log_corrections(corrections)
             corrections = corrections&.strip
             return if corrections&.empty?
@@ -45,6 +52,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 +61,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 +82,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,6 +96,7 @@ module Solargraph
           end
 
           # @param value [Array, String]
+          # @return [String]
           def cop_list(value)
             value = value.join(',') if value.respond_to?(:join)
             return nil if value == '' || !value.is_a?(String)

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

@@ -10,6 +10,7 @@ module Solargraph::LanguageServer::Message::TextDocument
 
     private
 
+    # @return [Array<Hash>]
     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 [Mutex]
       def mutex
         @mutex ||= Mutex.new
       end

data/lib/solargraph/language_server/request.rb

@@ -16,6 +16,7 @@ module Solargraph
         @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.
@@ -327,9 +328,10 @@ module Solargraph
 
     # @param query [String]
     # @return [Enumerable<YARD::CodeObjects::Base>]
+    # @return [Array(ApiMap, Enumerable<Pin::Base>)]
     def document query
       sync_catalog
-      mutex.synchronize { api_map.document query }
+      mutex.synchronize { [api_map, api_map.get_path_pins(query)] }
     end
 
     # @param query [String]
@@ -400,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)
@@ -430,21 +432,11 @@ module Solargraph
       Bench.new(
         source_maps: source_map_hash.values,
         workspace: workspace,
-        external_requires: external_requires
+        external_requires: external_requires,
+        live_map: @current ? source_map_hash[@current.filename] : nil
       )
     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
@@ -508,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
@@ -516,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
@@ -586,28 +579,54 @@ module Solargraph
     # @return [void]
     def cache_next_gemspec
       return if @cache_progress
-      spec = api_map.uncached_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]
@@ -645,15 +664,17 @@ 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_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/location.rb

@@ -25,11 +25,33 @@ module Solargraph
       [filename, range]
     end
 
+    # @param other [self]
+    def <=>(other)
+      return nil unless other.is_a?(Location)
+      if filename == other.filename
+        range <=> other.range
+      else
+        filename <=> other.filename
+      end
+    end
+
+    def rbs?
+      filename.end_with?('.rbs')
+    end
+
     # @param location [self]
     def contain? location
       range.contain?(location.range.start) && range.contain?(location.range.ending) && filename == location.filename
     end
 
+    def inspect
+      "<#{self.class.name}: filename=#{filename}, range=#{range.inspect}>"
+    end
+
+    def to_s
+      inspect
+    end
+
     # @return [Hash]
     def to_hash
       {
@@ -39,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)

data/lib/solargraph/logging.rb

@@ -11,8 +11,18 @@ 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"
     end

data/lib/solargraph/page.rb

@@ -27,8 +27,10 @@ module Solargraph
       end
 
       # @param text [String]
+      # @sg-ignore https://github.com/lsegal/yard/pull/1615
       # @return [String]
       def htmlify text
+        # @type [String]
         YARD::Templates::Helpers::Markup::RDocMarkup.new(text).to_html
       end
 
@@ -70,8 +72,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]
@@ -13,6 +20,8 @@ module Solargraph
       end
 
       def on_comment *args
+        # @sg-ignore
+        # @type [Array(Symbol, String, Array([Integer, nil], [Integer, nil]))]
         result = super
         if @buffer_lines[result[2][0]][0..result[2][1]].strip =~ /^#/
           chomped = result[1].chomp
@@ -24,28 +33,32 @@ module Solargraph
         result
       end
 
+      # @param result [Array(Symbol, String, Array([Integer, nil], [Integer, nil]))]
+      # @return [void]
+      def create_snippet(result)
+        chomped = result[1].chomp
+        @comments[result[2][0]] = Snippet.new(Range.from_to(result[2][0] || 0, result[2][1] || 0, result[2][0] || 0, (result[2][1] || 0) + chomped.length), chomped)
+      end
+
       def on_embdoc_beg *args
         result = super
-        chomped = result[1].chomp
-        @comments[result[2][0]] = Snippet.new(Range.from_to(result[2][0], result[2][1], result[2][0], result[2][1] + chomped.length), chomped)
+        create_snippet(result)
         result
       end
 
       def on_embdoc *args
         result = super
-        chomped = result[1].chomp
-        @comments[result[2][0]] = Snippet.new(Range.from_to(result[2][0], result[2][1], result[2][0], result[2][1] + chomped.length), chomped)
+        create_snippet(result)
         result
       end
 
       def on_embdoc_end *args
         result = super
-        chomped = result[1].chomp
-        @comments[result[2][0]] = Snippet.new(Range.from_to(result[2][0], result[2][1], result[2][0], result[2][1] + chomped.length), chomped)
+        create_snippet(result)
         result
       end
 
-      # @return [Hash{Integer => String}]
+      # @return [Hash{Integer => Solargraph::Parser::Snippet}]
       def parse
         @comments = {}
         super