solargraph 0.47.2 → 0.54.0

data/lib/solargraph/library.rb

@@ -1,12 +1,14 @@
 # frozen_string_literal: true
 
 require 'pathname'
+require 'observer'
 
 module Solargraph
   # A Library handles coordination between a Workspace and an ApiMap.
   #
   class Library
     include Logging
+    include Observable
 
     # @return [Solargraph::Workspace]
     attr_reader :workspace
@@ -17,12 +19,19 @@ module Solargraph
     # @return [Source, nil]
     attr_reader :current
 
+    # @return [LanguageServer::Progress, nil]
+    attr_reader :cache_progress
+
     # @param workspace [Solargraph::Workspace]
     # @param name [String, nil]
     def initialize workspace = Solargraph::Workspace.new, name = nil
       @workspace = workspace
       @name = name
-      @synchronized = false
+      @threads = []
+      # @type [Integer, nil]
+      @total = nil
+      # @type [Source, nil]
+      @current = nil
     end
 
     def inspect
@@ -35,7 +44,7 @@ module Solargraph
     #
     # @return [Boolean]
     def synchronized?
-      @synchronized
+      !mutex.locked?
     end
 
     # Attach a source to the library.
@@ -47,17 +56,15 @@ module Solargraph
     # @param source [Source, nil]
     # @return [void]
     def attach source
-      mutex.synchronize do
-        if @current && (!source || @current.filename != source.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
-          @synchronized = false
-        end
-        @current = source
-        maybe_map @current
-        catalog_inlock
+      if @current && (!source || @current.filename != source.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
+      @current = source
+      maybe_map @current
+      catalog if changed
     end
 
     # True if the specified file is currently attached.
@@ -95,47 +102,37 @@ module Solargraph
     # @param text [String] The contents of the file
     # @return [Boolean] True if the file was added to the workspace.
     def create filename, text
-      result = false
-      mutex.synchronize do
-        next unless contain?(filename) || open?(filename) || workspace.would_merge?(filename)
-        @synchronized = false
-        source = Solargraph::Source.load_string(text, filename)
-        workspace.merge(source)
-        result = true
-      end
-      result
+      return false unless contain?(filename) || open?(filename)
+      source = Solargraph::Source.load_string(text, filename)
+      workspace.merge(source)
+      true
     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
-      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
-      end
+    # @param filenames [Array<String>]
+    # @return [Boolean] True if at least one file was added to the workspace.
+    def create_from_disk *filenames
+      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 }
       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
+        result ||= workspace.remove(filename)
       end
       result
     end
@@ -146,11 +143,10 @@ module Solargraph
     # @param filename [String]
     # @return [void]
     def close filename
-      mutex.synchronize do
-        @synchronized = false
-        @current = nil if @current && @current.filename == filename
-        catalog
-      end
+      return unless @current&.filename == filename
+
+      @current = nil
+      catalog unless workspace.has_file?(filename)
     end
 
     # Get completion suggestions at the specified file and location.
@@ -158,12 +154,13 @@ 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
+      sync_catalog
       position = Position.new(line, column)
       cursor = Source::Cursor.new(read(filename), position)
-      api_map.clip(cursor).complete
+      mutex.synchronize { api_map.clip(cursor).complete }
     rescue FileNotFoundError => e
       handle_file_not_found filename, e
     end
@@ -174,11 +171,12 @@ 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)
       cursor = Source::Cursor.new(read(filename), position)
+      sync_catalog
       if cursor.comment?
         source = read(filename)
         offset = Solargraph::Position.to_offset(source.code, Solargraph::Position.new(line, column))
@@ -186,18 +184,35 @@ module Solargraph
         rgt = source.code[offset..-1].match(/^([a-z0-9_]*)(:[a-z0-9_:]*)?[\]>, ]/i)
         if lft && rgt
           tag = (lft[1] + rgt[1]).sub(/:+$/, '')
-          clip = api_map.clip(cursor)
+          clip = mutex.synchronize { api_map.clip(cursor) }
           clip.translate tag
         else
           []
         end
       else
-        api_map.clip(cursor).define.map { |pin| pin.realize(api_map) }
+        mutex.synchronize { api_map.clip(cursor).define.map { |pin| pin.realize(api_map) } }
       end
     rescue FileNotFoundError => e
       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)
+      sync_catalog
+      mutex.synchronize { 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.
     #
@@ -209,7 +224,8 @@ module Solargraph
     def signatures_at filename, line, column
       position = Position.new(line, column)
       cursor = Source::Cursor.new(read(filename), position)
-      api_map.clip(cursor).signify
+      sync_catalog
+      mutex.synchronize { api_map.clip(cursor).signify }
     end
 
     # @param filename [String]
@@ -220,8 +236,9 @@ module Solargraph
     # @return [Array<Solargraph::Range>]
     # @todo Take a Location instead of filename/line/column
     def references_from filename, line, column, strip: false, only: false
-      cursor = api_map.cursor_at(filename, Position.new(line, column))
-      clip = api_map.clip(cursor)
+      sync_catalog
+      cursor = Source::Cursor.new(read(filename), [line, column])
+      clip = mutex.synchronize { api_map.clip(cursor) }
       pin = clip.define.first
       return [] unless pin
       result = []
@@ -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)
@@ -254,20 +283,31 @@ module Solargraph
     # @param location [Location]
     # @return [Array<Solargraph::Pin::Base>]
     def locate_pins location
-      api_map.locate_pins(location).map { |pin| pin.realize(api_map) }
+      sync_catalog
+      mutex.synchronize { 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,21 +315,24 @@ 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)
+      sync_catalog
+      mutex.synchronize { 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
+      sync_catalog
+      mutex.synchronize { api_map.document query }
     end
 
     # @param query [String]
     # @return [Array<String>]
     def search query
-      api_map.search query
+      sync_catalog
+      mutex.synchronize { api_map.search query }
     end
 
     # Get an array of all symbols in the workspace that match the query.
@@ -297,7 +340,8 @@ module Solargraph
     # @param query [String]
     # @return [Array<Pin::Base>]
     def query_symbols query
-      api_map.query_symbols query
+      sync_catalog
+      mutex.synchronize { api_map.query_symbols query }
     end
 
     # Get an array of document symbols.
@@ -309,15 +353,18 @@ module Solargraph
     # @param filename [String]
     # @return [Array<Solargraph::Pin::Base>]
     def document_symbols filename
-      api_map.document_symbols(filename)
+      sync_catalog
+      mutex.synchronize { api_map.document_symbols(filename) }
     end
 
     # @param path [String]
-    # @return [Array<Solargraph::Pin::Base>]
+    # @return [Enumerable<Solargraph::Pin::Base>]
     def path_pins path
-      api_map.get_path_suggestions(path)
+      sync_catalog
+      mutex.synchronize { api_map.get_path_suggestions(path) }
     end
 
+    # @return [Array<SourceMap>]
     def source_maps
       source_map_hash.values
     end
@@ -340,10 +387,10 @@ module Solargraph
       #   everything in the workspace should get diagnosed, or if there should
       #   be an option to do so.
       #
+      sync_catalog
       return [] unless open?(filename)
       result = []
       source = read(filename)
-      catalog
       repargs = {}
       workspace.config.reporters.each do |line|
         if line == 'all!'
@@ -369,19 +416,23 @@ module Solargraph
     #
     # @return [void]
     def catalog
-      mutex.synchronize do
-        catalog_inlock
-      end
-    end
-
-    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?
+      @threads.delete_if(&:stop?)
+      @threads.push(Thread.new do
+        sleep 0.05 if RUBY_PLATFORM =~ /mingw/
+        next unless @threads.last == Thread.current
+
+        mutex.synchronize do
+          logger.info "Cataloging #{workspace.directory.empty? ? 'generic workspace' : workspace.directory}"
+          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"
+          cache_next_gemspec
+        end
+      end)
+      @threads.last.run if RUBY_PLATFORM =~ /mingw/
     end
 
+    # @return [Bench]
     def bench
       Bench.new(
         source_maps: source_map_hash.values,
@@ -417,15 +468,12 @@ module Solargraph
     # @return [Boolean] True if the source was merged into the workspace.
     def merge source
       Logging.logger.debug "Merging source: #{source.filename}"
-      result = false
-      mutex.synchronize do
-        result = workspace.merge(source)
-        maybe_map source
-      end
-      # catalog
+      result = workspace.merge(source)
+      maybe_map source
       result
     end
 
+    # @return [Hash{String => SourceMap}]
     def source_map_hash
       @source_map_hash ||= {}
     end
@@ -434,22 +482,21 @@ module Solargraph
       (workspace.filenames - source_map_hash.keys).empty?
     end
 
+    # @return [SourceMap, Boolean]
     def next_map
       return false if mapped?
-      mutex.synchronize do
-        @synchronized = false
-        src = workspace.sources.find { |s| !source_map_hash.key?(s.filename) }
-        if src
-          Logging.logger.debug "Mapping #{src.filename}"
-          source_map_hash[src.filename] = Solargraph::SourceMap.map(src)
-          find_external_requires(source_map_hash[src.filename])
-          source_map_hash[src.filename]
-        else
-          false
-        end
+      src = workspace.sources.find { |s| !source_map_hash.key?(s.filename) }
+      if src
+        Logging.logger.debug "Mapping #{src.filename}"
+        source_map_hash[src.filename] = Solargraph::SourceMap.map(src)
+        find_external_requires(source_map_hash[src.filename])
+        source_map_hash[src.filename]
+      else
+        false
       end
     end
 
+    # @return [self]
     def map!
       workspace.sources.each do |src|
         source_map_hash[src.filename] = Solargraph::SourceMap.map(src)
@@ -458,28 +505,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 +562,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 +574,13 @@ module Solargraph
       end
     end
 
+    # @param source [Source, nil]
+    # @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?
@@ -530,7 +588,6 @@ module Solargraph
           unless source_map_hash[source.filename].try_merge!(new_map)
             source_map_hash[source.filename] = new_map
             find_external_requires(source_map_hash[source.filename])
-            @synchronized = false
           end
         else
           # @todo Smelly instance variable access
@@ -539,8 +596,78 @@ module Solargraph
       else
         source_map_hash[source.filename] = Solargraph::SourceMap.map(source)
         find_external_requires(source_map_hash[source.filename])
-        @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_progress
+      spec = api_map.uncached_gemspecs.find { |spec| !cache_errors.include?(spec) }
+      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
+        catalog
+      end
+    end
+
+    # @param gem_name [String]
+    # @param pending [Integer]
+    # @return [void]
+    def report_cache_progress gem_name, pending
+      @total ||= pending
+      @total = pending if pending > @total
+      finished = @total - pending
+      pct = if @total.zero?
+        0
+      else
+        ((finished.to_f / @total.to_f) * 100).to_i
+      end
+      message = "#{gem_name}#{pending > 0 ? " (+#{pending})" : ''}"
+      # "
+      if @cache_progress
+        @cache_progress.report(message, pct)
+      else
+        @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
+        @cache_progress.begin(message, pct)
+        changed
+        notify_observers @cache_progress
+        @cache_progress.report(message, pct)
+      end
+      changed
+      notify_observers @cache_progress
+    end
+
+    # @return [void]
+    def end_cache_progress
+      changed if @cache_progress&.finish('done')
+      notify_observers @cache_progress
+      @cache_progress = nil
+      @total = nil
+    end
+
+    def sync_catalog
+      @threads.delete_if(&:stop?)
+              .last&.join
+    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