solargraph 0.53.4 → 0.54.0

data/lib/solargraph/complex_type.rb

@@ -11,7 +11,7 @@ module Solargraph
     autoload :TypeMethods, 'solargraph/complex_type/type_methods'
     autoload :UniqueType,  'solargraph/complex_type/unique_type'
 
-    # @param types [Array<[UniqueType, ComplexType]>]
+    # @param types [Array<UniqueType, ComplexType>]
     def initialize types = [UniqueType::UNDEFINED]
       # @todo @items here should not need an annotation
       # @type [Array<UniqueType>]
@@ -86,6 +86,10 @@ module Solargraph
       @items
     end
 
+    def tags
+      @items.map(&:tag).join(', ')
+    end
+
     # @param index [Integer]
     # @return [UniqueType]
     def [](index)
@@ -126,6 +130,10 @@ module Solargraph
       map(&:tag).join(', ')
     end
 
+    def rooted_tags
+      map(&:rooted_tag).join(', ')
+    end
+
     def all? &block
       @items.all? &block
     end
@@ -147,15 +155,23 @@ module Solargraph
     # @yieldreturn [UniqueType]
     # @return [ComplexType]
     def transform(new_name = nil, &transform_type)
+      raise "Please remove leading :: and set rooted with recreate() instead - #{new_name}" if new_name&.start_with?('::')
       ComplexType.new(map { |ut| ut.transform(new_name, &transform_type) })
     end
 
+    # @return [self]
+    def force_rooted
+      transform do |t|
+        t.recreate(make_rooted: true)
+      end
+    end
+
     # @param definitions [Pin::Namespace, Pin::Method]
     # @param context_type [ComplexType]
     # @return [ComplexType]
     def resolve_generics definitions, context_type
       result = @items.map { |i| i.resolve_generics(definitions, context_type) }
-      ComplexType.parse(*result.map(&:tag))
+      ComplexType.try_parse(*result.map(&:tag))
     end
 
     # @param dst [String]
@@ -164,7 +180,7 @@ module Solargraph
       return self unless selfy?
       red = reduce_class(dst)
       result = @items.map { |i| i.self_to red }
-      ComplexType.parse(*result.map(&:tag))
+      ComplexType.try_parse(*result.map(&:tag))
     end
 
     def nullable?
@@ -190,21 +206,6 @@ module Solargraph
       @items.all?(&:bot?)
     end
 
-    private
-
-    # @todo This is a quick and dirty hack that forces `self` keywords
-    #   to reference an instance of their class and never the class itself.
-    #   This behavior may change depending on which result is expected
-    #   from YARD conventions. See https://github.com/lsegal/yard/issues/1257
-    # @param dst [String]
-    # @return [String]
-    def reduce_class dst
-      while dst =~ /^(Class|Module)\<(.*?)\>$/
-        dst = dst.sub(/^(Class|Module)\</, '').sub(/\>$/, '')
-      end
-      dst
-    end
-
     class << self
       # Parse type strings into a ComplexType.
       #
@@ -250,7 +251,7 @@ module Solargraph
               elsif base.end_with?('=')
                 raise ComplexTypeError, "Invalid hash thing" unless key_types.nil?
                 # types.push ComplexType.new([UniqueType.new(base[0..-2].strip)])
-                types.push UniqueType.new(base[0..-2].strip)
+                types.push UniqueType.parse(base[0..-2].strip, subtype_string)
                 # @todo this should either expand key_type's type
                 #   automatically or complain about not being
                 #   compatible with key_type's type in type checking
@@ -281,7 +282,7 @@ module Solargraph
               next
             elsif char == ',' && point_stack == 0 && curly_stack == 0 && paren_stack == 0
               # types.push ComplexType.new([UniqueType.new(base.strip, subtype_string.strip)])
-              types.push UniqueType.new(base.strip, subtype_string.strip)
+              types.push UniqueType.parse(base.strip, subtype_string.strip)
               base.clear
               subtype_string.clear
               next
@@ -294,7 +295,7 @@ module Solargraph
           end
           raise ComplexTypeError, "Unclosed subtype in #{type_string}" if point_stack != 0 || curly_stack != 0 || paren_stack != 0
           # types.push ComplexType.new([UniqueType.new(base, subtype_string)])
-          types.push UniqueType.new(base.strip, subtype_string.strip)
+          types.push UniqueType.parse(base.strip, subtype_string.strip)
         end
         unless key_types.nil?
           raise ComplexTypeError, "Invalid use of key/value parameters" unless partial
@@ -311,18 +312,33 @@ module Solargraph
       def try_parse *strings
         parse *strings
       rescue ComplexTypeError => e
-        Solargraph.logger.info "Error parsing complex type: #{e.message}"
+        Solargraph.logger.info "Error parsing complex type `#{strings.join(', ')}`: #{e.message}"
         ComplexType::UNDEFINED
       end
     end
 
     VOID = ComplexType.parse('void')
     UNDEFINED = ComplexType.parse('undefined')
-    SYMBOL = ComplexType.parse('Symbol')
-    ROOT = ComplexType.parse('Class<>')
+    SYMBOL = ComplexType.parse('::Symbol')
+    ROOT = ComplexType.parse('::Class<>')
     NIL = ComplexType.parse('nil')
     SELF = ComplexType.parse('self')
-    BOOLEAN = ComplexType.parse('Boolean')
+    BOOLEAN = ComplexType.parse('::Boolean')
     BOT = ComplexType.parse('bot')
+
+    private
+
+    # @todo This is a quick and dirty hack that forces `self` keywords
+    #   to reference an instance of their class and never the class itself.
+    #   This behavior may change depending on which result is expected
+    #   from YARD conventions. See https://github.com/lsegal/yard/issues/1257
+    # @param dst [String]
+    # @return [String]
+    def reduce_class dst
+      while dst =~ /^(Class|Module)\<(.*?)\>$/
+        dst = dst.sub(/^(Class|Module)\</, '').sub(/\>$/, '')
+      end
+      dst
+    end
   end
 end

data/lib/solargraph/doc_map.rb

@@ -18,9 +18,11 @@ module Solargraph
 
     # @param requires [Array<String>]
     # @param preferences [Array<Gem::Specification>]
-    def initialize(requires, preferences)
+    # @param rbs_path [String, Pathname, nil]
+    def initialize(requires, preferences, rbs_path = nil)
       @requires = requires.compact
       @preferences = preferences.compact
+      @rbs_path = rbs_path
       generate
     end
 
@@ -39,6 +41,7 @@ module Solargraph
       @gems_in_memory ||= {}
     end
 
+    # @return [Set<Gem::Specification>]
     def dependencies
       @dependencies ||= (gemspecs.flat_map { |spec| fetch_dependencies(spec) } - gemspecs).to_set
     end
@@ -57,6 +60,7 @@ module Solargraph
         end
       end
       dependencies.each { |dep| try_cache dep }
+      @uncached_gemspecs.uniq!
     end
 
     # @return [Hash{String => Gem::Specification, nil}]
@@ -75,7 +79,8 @@ module Solargraph
       return if try_gem_in_memory(gemspec)
       cache_file = File.join('gems', "#{gemspec.name}-#{gemspec.version}.ser")
       if Cache.exist?(cache_file)
-        gempins = Cache.load(cache_file)
+        cached = Cache.load(cache_file)
+        gempins = update_from_collection(gemspec, cached)
         self.class.gems_in_memory[gemspec] = gempins
         @pins.concat gempins
       else
@@ -93,7 +98,7 @@ module Solargraph
         @pins.concat map.pins
       else
         # @todo Temporarily ignoring unresolved `require 'set'`
-        Solargraph.logger.warn "Require path #{path} could not be resolved" unless path == 'set'
+        Solargraph.logger.debug "Require path #{path} could not be resolved" unless path == 'set'
       end
     end
 
@@ -107,6 +112,17 @@ module Solargraph
       true
     end
 
+    def update_from_collection gemspec, gempins
+      return gempins unless @rbs_path && File.directory?(@rbs_path)
+      return gempins if RbsMap.new(gemspec.name, gemspec.version).resolved?
+
+      rbs_map = RbsMap.new(gemspec.name, gemspec.version, directories: [@rbs_path])
+      return gempins unless rbs_map.resolved?
+
+      Solargraph.logger.info "Updating #{gemspec.name} #{gemspec.version} from collection"
+      GemPins.combine(gempins, rbs_map)
+    end
+
     # @param path [String]
     # @return [Gem::Specification, nil]
     def resolve_path_to_gemspec path

data/lib/solargraph/gem_pins.rb

@@ -16,13 +16,21 @@ module Solargraph
     def self.build(gemspec)
       yard_pins = build_yard_pins(gemspec)
       rbs_map = RbsMap.from_gemspec(gemspec)
+      combine yard_pins, rbs_map
+    end
+
+    # @param yard_pins [Array<Pin::Base>]
+    # @param rbs_map [RbsMap]
+    # @return [Array<Pin::Base>]
+    def self.combine(yard_pins, rbs_map)
       in_yard = Set.new
       combined = yard_pins.map do |yard|
         in_yard.add yard.path
         next yard unless yard.is_a?(Pin::Method)
+
         rbs = rbs_map.path_pin(yard.path, Pin::Method)
         next yard unless rbs
-        # @todo Could not include: attribute and anon_splat
+
         # @sg-ignore
         yard.class.new(
           location: yard.location,

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

@@ -34,7 +34,7 @@ module Solargraph
         def update_libraries uri
           src = sources.find(uri)
           using = libraries.select { |lib| lib.contain?(src.filename) }
-          using.push generic_library_for(uri) if using.empty?
+          using.push library_for(uri) if using.empty?
           using.each { |lib| lib.merge src }
           diagnoser.schedule uri
         end
@@ -114,6 +114,13 @@ module Solargraph
         # @return [Library]
         def generic_library
           @generic_library ||= Solargraph::Library.new(Solargraph::Workspace.new('', nil, options), nil)
+                                                  .tap { |lib| lib.add_observer self }
+        end
+
+        # @param library [Solargraph::Library]
+        # @return [void]
+        def update progress
+          progress&.send(self)
         end
       end
     end

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

@@ -11,54 +11,10 @@ module Solargraph
         include Observable
         include UriHelpers
 
-        def initialize
-          @mutex = Mutex.new
-          @stopped = true
-          @has_uri = ConditionVariable.new
-        end
-
-        def stopped?
-          @stopped
-        end
-
-        # @return [void]
-        def start
-          return unless @stopped
-          @stopped = false
-          Thread.new do
-            tick until stopped?
-          end
-        end
-
-        # @return [void]
-        def tick
-          uri = mutex.synchronize { next_uri }
-
-          return if queue.include?(uri)
-          mutex.synchronize do
-            nxt = open_source_hash[uri].finish_synchronize
-            open_source_hash[uri] = nxt
-            changed
-            notify_observers uri
-          end
-        end
-
         # @param uri [String]
         # @return [void]
         def add_uri(uri)
           queue.push(uri)
-          @has_uri.signal
-        end
-
-        # @return [String]
-        def next_uri
-          @has_uri.wait(mutex) if queue.empty?
-          queue.shift
-        end
-
-        # @return [void]
-        def stop
-          @stopped = true
         end
 
         # Open a source.
@@ -89,20 +45,7 @@ module Solargraph
         # @return [void]
         def update uri, updater
           src = find(uri)
-          mutex.synchronize { open_source_hash[uri] = src.synchronize(updater) }
-          changed
-          notify_observers uri
-        end
-
-        # @param uri [String]
-        # @param updater [Source::Updater]
-        # @return [void]
-        def async_update uri, updater
-          src = find(uri)
-          mutex.synchronize do
-            open_source_hash[uri] = src.start_synchronize(updater)
-            add_uri(uri)
-          end
+          open_source_hash[uri] = src.synchronize(updater)
           changed
           notify_observers uri
         end
@@ -144,9 +87,6 @@ module Solargraph
           @open_source_hash ||= {}
         end
 
-        # @return [Mutex]
-        attr_reader :mutex
-
         # An array of source URIs that are waiting to finish synchronizing.
         #
         # @return [::Array<String>]

data/lib/solargraph/language_server/host.rb

@@ -12,7 +12,6 @@ module Solargraph
     #
     class Host
       autoload :Diagnoser,     'solargraph/language_server/host/diagnoser'
-      autoload :Cataloger,     'solargraph/language_server/host/cataloger'
       autoload :Sources,       'solargraph/language_server/host/sources'
       autoload :Dispatch,      'solargraph/language_server/host/dispatch'
       autoload :MessageWorker, 'solargraph/language_server/host/message_worker'
@@ -43,8 +42,6 @@ module Solargraph
         return unless stopped?
         @stopped = false
         diagnoser.start
-        cataloger.start
-        sources.start
         message_worker.start
       end
 
@@ -155,6 +152,7 @@ module Solargraph
       def delete *uris
         filenames = uris.map { |uri| uri_to_file(uri) }
         libraries.each do |lib|
+          lib.delete_observer self
           lib.delete(*filenames)
         end
         uris.each do |uri|
@@ -253,7 +251,7 @@ module Solargraph
       # @return [void]
       def change params
         updater = generate_updater(params)
-        sources.async_update params['textDocument']['uri'], updater
+        sources.update params['textDocument']['uri'], updater
         diagnoser.schedule params['textDocument']['uri']
       end
 
@@ -294,8 +292,9 @@ module Solargraph
         begin
           workspace = Solargraph::Workspace.new(path, nil, options)
           lib = Solargraph::Library.new(workspace, name)
+          lib.add_observer self
           libraries.push lib
-          async_library_map lib
+          library_map lib
         rescue WorkspaceTooLargeError => e
           send_notification 'window/showMessage', {
             'type' => Solargraph::LanguageServer::MessageTypes::WARNING,
@@ -324,6 +323,7 @@ module Solargraph
         # @param lib [Library]
         libraries.delete_if do |lib|
           next false if lib.workspace.directory != directory
+          lib.delete_observer self
           true
         end
       end
@@ -458,9 +458,7 @@ module Solargraph
         return if @stopped
         @stopped = true
         message_worker.stop
-        cataloger.stop
         diagnoser.stop
-        sources.stop
         changed
         notify_observers
       end
@@ -684,11 +682,15 @@ module Solargraph
         libraries.each(&:catalog)
       end
 
-      # @return [Hash{String => BasicObject}]
+      # @return [Hash{String => Hash{String => Boolean}}]
       def client_capabilities
         @client_capabilities ||= {}
       end
 
+      def client_supports_progress?
+        client_capabilities['window'] && client_capabilities['window']['workDoneProgress']
+      end
+
       private
 
       # @return [MessageWorker]
@@ -701,11 +703,6 @@ module Solargraph
         @diagnoser ||= Diagnoser.new(self)
       end
 
-      # @return [Cataloger]
-      def cataloger
-        @cataloger ||= Cataloger.new(self)
-      end
-
       # A hash of client requests by ID. The host uses this to keep track of
       # pending responses.
       #
@@ -835,72 +832,28 @@ module Solargraph
         client_capabilities['rename'] && client_capabilities['rename']['prepareSupport']
       end
 
-      def client_supports_progress?
-        client_capabilities['window'] && client_capabilities['window']['workDoneProgress']
-      end
-
       # @param library [Library]
       # @return [void]
-      def async_library_map library
+      def library_map library
         return if library.mapped?
-        Thread.new do
-          if client_supports_progress?
-            uuid = SecureRandom.uuid
-            send_request 'window/workDoneProgress/create', {
-              token: uuid
-            } do |response|
-              do_async_library_map library, response.nil? ? uuid : nil
-            end
-          else
-            do_async_library_map library
-          end
-        end
+        Thread.new { sync_library_map library }
       end
 
       # @param library [Library]
       # @param uuid [String, nil]
       # @return [void]
-      def do_async_library_map library, uuid = nil
+      def sync_library_map library
         total = library.workspace.sources.length
-        if uuid
-          send_notification '$/progress', {
-            token: uuid,
-            value: {
-              kind: 'begin',
-              title: "Mapping workspace",
-              message: "0/#{total} files",
-              cancellable: false,
-              percentage: 0
-            }
-          }
-        end
-        pct = 0
-        mod = 10
+        progress = Progress.new('Mapping workspace')
+        progress.begin "0/#{total} files", 0
+        progress.send self
         while library.next_map
-          next unless uuid
-          cur = ((library.source_map_hash.keys.length.to_f / total.to_f) * 100).to_i
-          if cur > pct && cur % mod == 0
-            pct = cur
-            send_notification '$/progress', {
-              token: uuid,
-              value: {
-                kind: 'report',
-                cancellable: false,
-                message: "#{library.source_map_hash.keys.length}/#{total} files",
-                percentage: pct
-              }
-            }
-          end
-        end
-        if uuid
-          send_notification '$/progress', {
-            token: uuid,
-            value: {
-              kind: 'end',
-              message: 'Mapping complete'
-            }
-          }
+          pct = ((library.source_map_hash.keys.length.to_f / total) * 100).to_i
+          progress.report "#{library.source_map_hash.keys.length}/#{total} files", pct
+          progress.send self
         end
+        progress.finish 'done'
+        progress.send self
       end
     end
   end

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

@@ -16,7 +16,7 @@ module Solargraph
         # @return [String]
         attr_reader :method
 
-        # @return [Hash]
+        # @return [Hash{String => Array, Hash, String, Integer}]
         attr_reader :params
 
         # @return [Hash, Array, nil]

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

@@ -47,6 +47,8 @@ module Solargraph
 
         private
 
+        # @todo '?' methods should type like RBS 'boolish' rather than a strict true or false
+        # @sg-ignore
         def support_workspace_folders?
           params['capabilities'] &&
             params['capabilities']['workspace'] &&
@@ -82,6 +84,7 @@ module Solargraph
           }
         end
 
+        # @return [Hash{Symbol => Hash{Symbol => String, Array<String>}}]
         def static_on_type_formatting
           {
             documentOnTypeFormattingProvider: {
@@ -91,6 +94,7 @@ module Solargraph
           }
         end
 
+        # @return [Hash{Symbol => Boolean}]
         def static_hover
           return {} unless host.options['hover']
           {
@@ -98,6 +102,7 @@ module Solargraph
           }
         end
 
+        # @return [Hash{Symbol => Boolean}]
         def static_document_formatting
           return {} unless host.options['formatting']
           {
@@ -105,6 +110,7 @@ module Solargraph
           }
         end
 
+        # @return [Hash{Symbol => Boolean}]
         def static_document_symbols
           return {} unless host.options['symbols']
           {
@@ -112,12 +118,14 @@ module Solargraph
           }
         end
 
+        # @return [Hash{Symbol => Boolean}]
         def static_workspace_symbols
           {
             workspaceSymbolProvider: true
           }
         end
 
+        # @return [Hash{Symbol => Boolean}]
         def static_definitions
           return {} unless host.options['definitions']
           {
@@ -125,6 +133,7 @@ module Solargraph
           }
         end
 
+        # @return [Hash{Symbol => Boolean}]
         def static_type_definitions
           return {} unless host.options['typeDefinitions']
           {
@@ -132,12 +141,15 @@ module Solargraph
           }
         end
 
+        # @return [Hash{Symbol => Hash{Symbol => Boolean}}]
         def static_rename
           {
             renameProvider: {prepareProvider: true}
           }
         end
 
+
+        # @return [Hash{Symbol => Boolean}]
         def static_references
           return {} unless host.options['references']
           {
@@ -145,6 +157,7 @@ module Solargraph
           }
         end
 
+        # @return [Hash{Symbol => Boolean}]
         def static_folding_range
           return {} unless host.options['folding']
           {
@@ -152,6 +165,7 @@ module Solargraph
           }
         end
 
+        # @return [Hash{Symbol => Boolean}]
         def static_highlights
           {
             documentHighlightProvider: true

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

@@ -70,6 +70,7 @@ module Solargraph
 
           def formatter_class(config)
             if self.class.const_defined?('BlankRubocopFormatter')
+              # @sg-ignore
               BlankRubocopFormatter
             else
               require_rubocop(config['version'])