class Solargraph::RbsMap

Attributes

Public Class Methods

from_gemspec (gemspec, rbs_collection_path, rbs_collection_config_path)

Source

# File lib/solargraph/rbs_map.rb, line 79
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

@param gemspec [Gem::Specification, Bundler::LazySpecification] @param rbs_collection_path [String, Pathname, nil] @param rbs_collection_config_path [String, Pathname, nil] @return [RbsMap]

load (library)

Source

# File lib/solargraph/rbs_map.rb, line 127
def self.load library
  @@rbs_maps_hash[library] ||= RbsMap.new(library)
end

@param library [String] @return [RbsMap]

new (library, version = nil, rbs_collection_config_path: nil, rbs_collection_paths: [])

Source

# File lib/solargraph/rbs_map.rb, line 29
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

@param library [String] @param version [String, nil] @param rbs_collection_config_path [String, Pathname, nil] @param rbs_collection_paths [Array<Pathname, String>]

Public Instance Methods

cache_key ()

Source

# File lib/solargraph/rbs_map.rb, line 49
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

@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.

loader ()

Source

# File lib/solargraph/rbs_map.rb, line 41
def loader
  @loader ||= RBS::EnvironmentLoader.new(core_root: nil, repository: repository)
end

@return [RBS::EnvironmentLoader]

path_pin (path, klass = Pin::Base)

Source

# File lib/solargraph/rbs_map.rb, line 100
def path_pin path, klass = Pin::Base
  pin = pins.find { |p| p.path == path }
  pin if pin&.is_a?(klass)
end

@generic T @param path [String] @param klass [Class<generic<T>>] @return [generic<T>, nil]

path_pins (path)

Source

# File lib/solargraph/rbs_map.rb, line 107
def path_pins path
  pins.select { |p| p.path == path }
end

@param path [String] @return [Array<Pin::Base>]

pins ()

Source

# File lib/solargraph/rbs_map.rb, line 92
def pins
  @pins ||= resolved? ? conversions.pins : []
end

@return [Array<Pin::Base>]

repository ()

Source

# File lib/solargraph/rbs_map.rb, line 116
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

@return [RBS::Repository]

resolved? ()

Source

# File lib/solargraph/rbs_map.rb, line 111
def resolved?
  @resolved
end

Private Instance Methods

add_library (loader, library, version)

Source

# File lib/solargraph/rbs_map.rb, line 147
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

@param loader [RBS::EnvironmentLoader] @param library [String] @param version [String, nil] @return [Boolean] true if adding the library succeeded

conversions ()

Source

# File lib/solargraph/rbs_map.rb, line 139
def conversions
  @conversions ||= Conversions.new(loader: loader)
end

@return [Conversions]

short_name ()

Source

# File lib/solargraph/rbs_map.rb, line 159
def short_name
  self.class.name.split('::').last
end

@return [String]