solargraph 0.58.1 → 0.59.0.dev.1

data/lib/solargraph/rbs_map/core_map.rb

@@ -1,58 +1,65 @@
-# frozen_string_literal: true
-
-module Solargraph
-  class RbsMap
-    # Ruby core pins
-    #
-    class CoreMap
-      include Logging
-
-      def resolved?
-        true
-      end
-
-      FILLS_DIRECTORY = File.expand_path(File.join(File.dirname(__FILE__), '..', '..', '..', 'rbs', 'fills'))
-
-      def initialize; end
-
-      # @return [Enumerable<Pin::Base>]
-      def pins
-        return @pins if @pins
-
-        @pins = []
-        cache = PinCache.deserialize_core
-        if cache
-          @pins.replace cache
-        else
-          @pins.concat conversions.pins
-
-          # Avoid RBS::DuplicatedDeclarationError by loading in a different EnvironmentLoader
-          fill_loader = RBS::EnvironmentLoader.new(core_root: nil, repository: RBS::Repository.new(no_stdlib: false))
-          fill_loader.add(path: Pathname(FILLS_DIRECTORY))
-          fill_conversions = Conversions.new(loader: fill_loader)
-          @pins.concat fill_conversions.pins
-
-          @pins.concat RbsMap::CoreFills::ALL
-
-          processed = ApiMap::Store.new(pins).pins.reject { |p| p.is_a?(Solargraph::Pin::Reference::Override) }
-          @pins.replace processed
-
-          PinCache.serialize_core @pins
-        end
-        @pins
-      end
-
-      private
-
-      # @return [RBS::EnvironmentLoader]
-      def loader
-        @loader ||= RBS::EnvironmentLoader.new(repository: RBS::Repository.new(no_stdlib: false))
-      end
-
-      # @return [Conversions]
-      def conversions
-        @conversions ||= Conversions.new(loader: loader)
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Solargraph
+  class RbsMap
+    # Ruby core pins
+    #
+    class CoreMap
+      include Logging
+
+      def resolved?
+        true
+      end
+
+      FILLS_DIRECTORY = File.expand_path(File.join(File.dirname(__FILE__), '..', '..', '..', 'rbs', 'fills'))
+
+      def initialize; end
+
+      # @param out [IO, nil] output stream for logging
+      # @return [Enumerable<Pin::Base>]
+      def pins out: $stderr
+        return @pins if @pins
+        @pins = cache_core(out: out)
+      end
+
+      # @param out [StringIO, IO, nil] output stream for logging
+      # @return [Array<Pin::Base>]
+      def cache_core out: $stderr
+        new_pins = []
+        cache = PinCache.deserialize_core
+        return cache if cache
+        new_pins.concat conversions.pins
+
+        # Avoid RBS::DuplicatedDeclarationError by loading in a different EnvironmentLoader
+        fill_loader = RBS::EnvironmentLoader.new(core_root: nil, repository: RBS::Repository.new(no_stdlib: false))
+        fill_loader.add(path: Pathname(FILLS_DIRECTORY))
+        out&.puts 'Caching RBS pins for Ruby core'
+        fill_conversions = Conversions.new(loader: fill_loader)
+        new_pins.concat fill_conversions.pins
+
+        # add some overrides
+        new_pins.concat RbsMap::CoreFills::ALL
+
+        # process overrides, then remove any which couldn't be resolved
+        processed = ApiMap::Store.new(new_pins).pins.reject { |p| p.is_a?(Solargraph::Pin::Reference::Override) }
+        new_pins.replace processed
+
+        PinCache.serialize_core new_pins
+
+        new_pins
+      end
+
+      private
+
+      # @return [RBS::EnvironmentLoader]
+      def loader
+        @loader ||= RBS::EnvironmentLoader.new(repository: RBS::Repository.new(no_stdlib: false))
+      end
+
+      # @return [Conversions]
+      def conversions
+        @conversions ||= Conversions.new(loader: loader)
+      end
+    end
+  end
+end

data/lib/solargraph/rbs_map/stdlib_map.rb

@@ -1,43 +1,72 @@
-# frozen_string_literal: true
-
-require 'rbs'
-
-module Solargraph
-  class RbsMap
-    # Ruby stdlib pins
-    #
-    class StdlibMap < RbsMap
-      include Logging
-
-      # @type [Hash{String => RbsMap}]
-      @stdlib_maps_hash = {}
-
-      # @param library [String]
-      def initialize library
-        cached_pins = PinCache.deserialize_stdlib_require library
-        if cached_pins
-          @pins = cached_pins
-          @resolved = true
-          @loaded = true
-          logger.debug { "Deserialized #{cached_pins.length} cached pins for stdlib require #{library.inspect}" }
-        else
-          super
-          unless resolved?
-            @pins = []
-            logger.info { "Could not resolve #{library.inspect}" }
-            return
-          end
-          generated_pins = pins
-          logger.debug { "Found #{generated_pins.length} pins for stdlib library #{library}" }
-          PinCache.serialize_stdlib_require library, generated_pins
-        end
-      end
-
-      # @param library [String]
-      # @return [StdlibMap]
-      def self.load library
-        @stdlib_maps_hash[library] ||= StdlibMap.new(library)
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+require 'rbs'
+
+module Solargraph
+  class RbsMap
+    # Ruby stdlib pins
+    #
+    class StdlibMap < RbsMap
+      include Logging
+
+      # @type [Hash{String => RbsMap}]
+      @stdlib_maps_hash = {}
+
+
+      # @param rebuild [Boolean] build pins regardless of whether we
+      #   have cached them already
+      # @param library [String]
+      # @param out [StringIO, IO, nil] where to log messages
+      def initialize library, rebuild: false, out: $stderr
+        cached_pins = PinCache.deserialize_stdlib_require library
+        if cached_pins && !rebuild
+          @pins = cached_pins
+          @resolved = true
+          @loaded = true
+          logger.debug { "Deserialized #{cached_pins.length} cached pins for stdlib require #{library.inspect}" }
+        elsif self.class.source.has? library, nil
+          super(library, out: out)
+          unless resolved?
+            @pins = []
+            logger.debug { "StdlibMap could not resolve #{library.inspect}" }
+            return
+          end
+          generated_pins = pins
+          logger.debug { "Found #{generated_pins.length} pins for stdlib library #{library}" }
+          PinCache.serialize_stdlib_require library, generated_pins
+        end
+      end
+
+      # @return [RBS::Collection::Sources::Stdlib]
+      def self.source
+        @source ||= RBS::Collection::Sources::Stdlib.instance
+      end
+
+      # @param name [String]
+      # @param version [String, nil]
+      # @return [Array<Hash{String => String}>, nil]
+      def self.stdlib_dependencies name, version = nil
+        if source.has?(name, version)
+          # @sg-ignore we are relying on undocumented behavior where
+          #   passing version=nil gives the latest version it has
+          source.dependencies_of(name, version)
+        else
+          []
+        end
+      end
+
+      def resolve_dependencies?
+        # there are 'virtual' dependencies for stdlib gems in RBS that
+        # aren't represented in the actual gemspecs that we'd
+        # otherwise use
+        true
+      end
+
+      # @param library [String]
+      # @return [StdlibMap]
+      def self.load library
+        @stdlib_maps_hash[library] ||= StdlibMap.new(library)
+      end
+    end
+  end
+end

data/lib/solargraph/rbs_map.rb

@@ -1,163 +1,217 @@
-# frozen_string_literal: true
-
-require 'digest'
-require 'pathname'
-require 'rbs'
-
-module Solargraph
-  class RbsMap
-    autoload :Conversions, 'solargraph/rbs_map/conversions'
-    autoload :CoreMap,     'solargraph/rbs_map/core_map'
-    autoload :CoreFills,   'solargraph/rbs_map/core_fills'
-    autoload :StdlibMap,   'solargraph/rbs_map/stdlib_map'
-
-    include Logging
-
-    # @type [Hash{String => RbsMap}]
-    @@rbs_maps_hash = {}
-
-    attr_reader :library
-
-    attr_reader :rbs_collection_paths
-
-    attr_reader :rbs_collection_config_path
-
-    # @param library [String]
-    # @param version [String, nil]
-    # @param rbs_collection_config_path [String, Pathname, nil]
-    # @param rbs_collection_paths [Array<Pathname, String>]
-    def initialize library, version = nil, rbs_collection_config_path: nil, rbs_collection_paths: []
-      if rbs_collection_config_path.nil? && !rbs_collection_paths.empty?
-        raise 'Please provide rbs_collection_config_path if you provide rbs_collection_paths'
-      end
-      @library = library
-      @version = version
-      @rbs_collection_config_path = rbs_collection_config_path
-      @rbs_collection_paths = rbs_collection_paths
-      add_library loader, library, version
-    end
-
-    # @return [RBS::EnvironmentLoader]
-    def loader
-      @loader ||= RBS::EnvironmentLoader.new(core_root: nil, repository: repository)
-    end
-
-    # @return [String] representing the version of the RBS info fetched
-    #   for the given library.  Must change when the RBS info is
-    #   updated upstream for the same library and version.  May change
-    #   if the config for where information comes form changes.
-    def cache_key
-      @hextdigest ||= begin
-        # @type [String, nil]
-        data = nil
-        if rbs_collection_config_path
-          lockfile_path = RBS::Collection::Config.to_lockfile_path(Pathname.new(rbs_collection_config_path))
-          if lockfile_path.exist?
-            collection_config = RBS::Collection::Config.from_path lockfile_path
-            gem_config = collection_config.gem(library)
-            data = gem_config&.to_s
-          end
-        end
-        if data.nil? || data.empty?
-          if resolved?
-            # definitely came from the gem itself and not elsewhere -
-            # only one version per gem
-            'gem-export'
-          else
-            'unresolved'
-          end
-        else
-          Digest::SHA1.hexdigest(data)
-        end
-      end
-    end
-
-    # @param gemspec [Gem::Specification, Bundler::LazySpecification]
-    # @param rbs_collection_path [String, Pathname, nil]
-    # @param rbs_collection_config_path [String, Pathname, nil]
-    # @return [RbsMap]
-    def self.from_gemspec gemspec, rbs_collection_path, rbs_collection_config_path
-      rbs_map = RbsMap.new(gemspec.name, gemspec.version,
-                           rbs_collection_paths: [rbs_collection_path].compact,
-                           rbs_collection_config_path: rbs_collection_config_path)
-      return rbs_map if rbs_map.resolved?
-
-      # try any version of the gem in the collection
-      RbsMap.new(gemspec.name, nil,
-                 rbs_collection_paths: [rbs_collection_path].compact,
-                 rbs_collection_config_path: rbs_collection_config_path)
-    end
-
-    # @return [Array<Pin::Base>]
-    def pins
-      @pins ||= resolved? ? conversions.pins : []
-    end
-
-    # @generic T
-    # @param path [String]
-    # @param klass [Class<generic<T>>]
-    # @return [generic<T>, nil]
-    def path_pin path, klass = Pin::Base
-      pin = pins.find { |p| p.path == path }
-      pin if pin&.is_a?(klass)
-    end
-
-    # @param path [String]
-    # @return [Array<Pin::Base>]
-    def path_pins path
-      pins.select { |p| p.path == path }
-    end
-
-    def resolved?
-      @resolved
-    end
-
-    # @return [RBS::Repository]
-    def repository
-      @repository ||= RBS::Repository.new(no_stdlib: false).tap do |repo|
-        @rbs_collection_paths.each do |dir|
-          dir_path = Pathname.new(dir)
-          repo.add(dir_path) if dir_path.exist? && dir_path.directory?
-        end
-      end
-    end
-
-    # @param library [String]
-    # @return [RbsMap]
-    def self.load library
-      @@rbs_maps_hash[library] ||= RbsMap.new(library)
-    end
-
-    private
-
-    # @return [RBS::EnvironmentLoader]
-    def loader
-      @loader ||= RBS::EnvironmentLoader.new(core_root: nil, repository: repository)
-    end
-
-    # @return [Conversions]
-    def conversions
-      @conversions ||= Conversions.new(loader: loader)
-    end
-
-    # @param loader [RBS::EnvironmentLoader]
-    # @param library [String]
-    # @param version [String, nil]
-    # @return [Boolean] true if adding the library succeeded
-    def add_library loader, library, version
-      @resolved = if loader.has_library?(library: library, version: version)
-        loader.add library: library, version: version
-        logger.debug { "#{short_name} successfully loaded library #{library}:#{version}" }
-        true
-      else
-        logger.info { "#{short_name} did not find data for library #{library}:#{version}" }
-        false
-      end
-    end
-
-    # @return [String]
-    def short_name
-      self.class.name.split('::').last
-    end
-  end
-end
+# frozen_string_literal: true
+
+require 'digest'
+require 'pathname'
+require 'rbs'
+
+module Solargraph
+  class RbsMap
+    autoload :Conversions, 'solargraph/rbs_map/conversions'
+    autoload :CoreMap,     'solargraph/rbs_map/core_map'
+    autoload :CoreFills,   'solargraph/rbs_map/core_fills'
+    autoload :StdlibMap,   'solargraph/rbs_map/stdlib_map'
+
+    include Logging
+
+    # @type [Hash{String => RbsMap}]
+    @@rbs_maps_hash = {}
+
+    attr_reader :library
+
+    attr_reader :rbs_collection_paths
+
+    attr_reader :rbs_collection_config_path
+
+    # @param library [String]
+    # @param version [String, nil]
+    # @param rbs_collection_config_path [String, Pathname, nil]
+    # @param rbs_collection_paths [Array<Pathname, String>]
+    # @param out [StringIO, IO, nil] where to log messages
+    def initialize library, version = nil, rbs_collection_config_path: nil, rbs_collection_paths: [], out: $stderr
+      if rbs_collection_config_path.nil? && !rbs_collection_paths.empty?
+        raise 'Please provide rbs_collection_config_path if you provide rbs_collection_paths'
+      end
+      @library = library
+      @version = version
+      @rbs_collection_config_path = rbs_collection_config_path
+      @rbs_collection_paths = rbs_collection_paths
+      add_library loader, library, version
+    end
+
+    CACHE_KEY_GEM_EXPORT = 'gem-export'
+    CACHE_KEY_UNRESOLVED = 'unresolved'
+    CACHE_KEY_STDLIB = 'stdlib'
+    CACHE_KEY_LOCAL = 'local'
+
+    # @param cache_key [String, nil]
+    # @return [String, nil] a description of the source of the RBS info
+    def self.rbs_source_desc cache_key
+      case cache_key
+      when CACHE_KEY_GEM_EXPORT
+        'RBS gem export'
+      when CACHE_KEY_UNRESOLVED
+        nil
+      when CACHE_KEY_STDLIB
+        'RBS standard library'
+      when CACHE_KEY_LOCAL
+        'local RBS shims'
+      else
+        'RBS collection'
+      end
+    end
+
+    # @return [RBS::EnvironmentLoader]
+    def loader
+      @loader ||= RBS::EnvironmentLoader.new(core_root: nil, repository: repository)
+    end
+
+    # @return [String] representing the version of the RBS info fetched
+    #   for the given library.  Must change when the RBS info is
+    #   updated upstream for the same library and version.  May change
+    #   if the config for where information comes form changes.
+    def cache_key
+      return CACHE_KEY_UNRESOLVED unless resolved?
+
+      @hextdigest ||= begin
+        # @type [String, nil]
+        data = nil
+        # @type gem_config [nil, Hash{String => Hash{String => String}}]
+        gem_config = nil
+        if rbs_collection_config_path
+          # @sg-ignore flow sensitive typing needs to handle attrs
+          lockfile_path = RBS::Collection::Config.to_lockfile_path(Pathname.new(rbs_collection_config_path))
+          if lockfile_path.exist?
+            collection_config = RBS::Collection::Config.from_path lockfile_path
+            gem_config = collection_config.gem(library)
+            data = gem_config&.to_s
+          end
+        end
+        if gem_config.nil?
+          CACHE_KEY_STDLIB
+        else
+          # @type [String]
+          source = gem_config.dig('source', 'type')
+          case source
+          when 'rubygems'
+            CACHE_KEY_GEM_EXPORT
+          when 'local'
+            CACHE_KEY_LOCAL
+          when 'stdlib'
+            CACHE_KEY_STDLIB
+          else
+            # @sg-ignore Need to add nil check here
+            Digest::SHA1.hexdigest(data)
+          end
+        end
+      end
+    end
+
+    # @param gemspec [Gem::Specification, Bundler::LazySpecification]
+    # @param rbs_collection_path [String, Pathname, nil]
+    # @param rbs_collection_config_path [String, Pathname, nil]
+    # @return [RbsMap]
+    def self.from_gemspec gemspec, rbs_collection_path, rbs_collection_config_path
+      # prefers stdlib RBS if available
+      rbs_map = RbsMap::StdlibMap.new(gemspec.name)
+      return rbs_map if rbs_map.resolved?
+
+      rbs_map = RbsMap.new(gemspec.name, gemspec.version,
+                           rbs_collection_paths: [rbs_collection_path].compact,
+                           rbs_collection_config_path: rbs_collection_config_path)
+      return rbs_map if rbs_map.resolved?
+
+      # try any version of the gem in the collection
+      RbsMap.new(gemspec.name, nil,
+                 rbs_collection_paths: [rbs_collection_path].compact,
+                 rbs_collection_config_path: rbs_collection_config_path)
+    end
+
+    # @param out [IO, nil] where to log messages
+    # @return [Array<Pin::Base>]
+    def pins out: $stderr
+      @pins ||= if resolved?
+                  conversions.pins
+                else
+                  []
+                end
+    end
+
+    # @generic T
+    # @param path [String]
+    # @param klass [Class<generic<T>>]
+    #
+    # @sg-ignore Need to be able to resolve generics based on a
+    #   Class<generic<T>> param
+    # @return [generic<T>, nil]
+    def path_pin path, klass = Pin::Base
+      pin = pins.find { |p| p.path == path }
+      pin if pin&.is_a?(klass)
+    end
+
+    # @param path [String]
+    # @return [Array<Pin::Base>]
+    def path_pins path
+      pins.select { |p| p.path == path }
+    end
+
+    def resolved?
+      @resolved
+    end
+
+    # @return [RBS::Repository]
+    def repository
+      @repository ||= RBS::Repository.new(no_stdlib: false).tap do |repo|
+        @rbs_collection_paths.each do |dir|
+          dir_path = Pathname.new(dir)
+          repo.add(dir_path) if dir_path.exist? && dir_path.directory?
+        end
+      end
+    end
+
+    # @param library [String]
+    # @return [RbsMap]
+    def self.load library
+      @@rbs_maps_hash[library] ||= RbsMap.new(library)
+    end
+
+    private
+
+    # @return [RBS::EnvironmentLoader]
+    def loader
+      @loader ||= RBS::EnvironmentLoader.new(core_root: nil, repository: repository)
+    end
+
+    # @return [Conversions]
+    def conversions
+      @conversions ||= Conversions.new(loader: loader)
+    end
+
+    def resolve_dependencies?
+      # we need to resolve dependencies via gemfile.lock manually for
+      # YARD regardless, so use same mechanism here so we don't
+      # duplicate work generating pins from dependencies
+      false
+    end
+
+    # @param loader [RBS::EnvironmentLoader]
+    # @param library [String]
+    # @param version [String, nil] the version of the library to load, or nil for any
+    # @param out [StringIO, IO, nil] where to log messages
+    # @return [Boolean] true if adding the library succeeded
+    def add_library loader, library, version, out: $stderr
+      @resolved = if loader.has_library?(library: library, version: version)
+                    loader.add library: library, version: version, resolve_dependencies: resolve_dependencies?
+                    logger.debug { "#{short_name} successfully loaded library #{library}:#{version}" }
+                    true
+                  else
+                    logger.info { "#{short_name} did not find data for library #{library}:#{version}" }
+                    false
+                  end
+    end
+
+    # @return [String]
+    def short_name
+      self.class.name.split('::').last
+    end
+  end
+end