class Gem::Source
A Source knows how to list and fetch gems from a RubyGems marshal index.
There are other Source subclasses for installed gems, local gems, the Compact Index API and so-forth.
Constants
- ContentAddressableInfo
-
Decoded compact index metadata for one content-addressable gem build: its
version, content-addresssuffix,ruby_abi, andplatform. Two infos are equal when their version and suffix match.
Attributes
Public Class Methods
Public Instance Methods
Sources are ordered by installation preference.
# File lib/rubygems/source.rb, line 56 def <=>(other) case other when Gem::Source::Installed, Gem::Source::Local, Gem::Source::Lock, Gem::Source::SpecificFile, Gem::Source::Git, Gem::Source::Vendor then -1 when Gem::Source then unless @uri return 0 unless other.uri return 1 end return -1 unless other.uri # Returning 1 here ensures that when sorting a list of sources, the # original ordering of sources supplied by the user is preserved. return 1 unless @uri.to_s == other.uri.to_s 0 end end
Returns the local directory to write uri to.
# File lib/rubygems/source.rb, line 103 def cache_dir(uri) # Correct for windows paths escaped_path = uri.path.sub(%r{^/([a-z]):/}i, '/\\1-/') File.join Gem.spec_cache_dir, "#{uri.host}%#{uri.port}", File.dirname(escaped_path) end
The publish time of gem name at version for suffix, when this source provides it through the compact index created_at metadata. Returns nil when the source, the gem or the version has no known publish time.
# File lib/rubygems/source.rb, line 248 def created_at(name, version, suffix = Gem::Platform::RUBY) return unless %w[http https].include?(uri.scheme) @created_at_info ||= {} info = @created_at_info[name] ||= begin compact_index_client.fetch_info(name) rescue Gem::RemoteFetcher::FetchError, Gem::CompactIndexClient::Error [] end suffix = (suffix || Gem::Platform::RUBY).to_s version = version.to_s row = info.find do |row_info| row_info[Gem::CompactIndexClient::INFO_VERSION] == version && (row_info[Gem::CompactIndexClient::INFO_SUFFIX] || Gem::Platform::RUBY) == suffix end return unless row value = row[Gem::CompactIndexClient::INFO_REQS].assoc("created_at")&.last&.first Gem::Cooldown.parse_created_at(value) end
The publish time for tuple. Content-addressable tuples are looked up by content address; all other tuples are looked up by platform.
# File lib/rubygems/source.rb, line 276 def created_at_for_tuple(tuple) created_at(tuple.name, tuple.version, tuple.content_address || tuple.platform) end
Decodes content-addressable tuples (whose platform field holds the content address) into tuples carrying their real platform and Ruby ABI from the compact index /info metadata.
# File lib/rubygems/source.rb, line 211 def decode_content_addressable_tuples(tuples, latest: false) ca_tuples = tuples.select(&:content_address) return tuples if ca_tuples.empty? decoded_tuples = ca_tuples.group_by(&:name).flat_map do |name, name_tuples| rows = name_tuples.map do |tuple| [tuple.name, tuple.version, tuple.version.to_s, tuple.content_address] end content_addressable_tuples(name, rows) end decoded_by_key = decoded_tuples.to_h do |tuple| [[tuple.name, tuple.version, tuple.content_address], tuple] end decoded = tuples.filter_map do |tuple| if tuple.content_address decoded_by_key[[tuple.name, tuple.version, tuple.content_address]] else tuple end end return decoded unless latest decoded.group_by(&:name).flat_map do |_, name_tuples| max_versions_by_platform(name_tuples) end end
Returns a Set that can fetch specifications from this source.
The set will optionally fetch prereleases if requested.
# File lib/rubygems/source.rb, line 92 def dependency_resolver_set(prerelease = false) new_dependency_resolver_set.tap {|set| set.prerelease = prerelease } end
Downloads spec and writes it to dir. See also Gem::RemoteFetcher#download.
# File lib/rubygems/source.rb, line 284 def download(spec, dir = Dir.pwd) fetcher = Gem::RemoteFetcher.fetcher fetcher.download spec, uri.to_s, dir end
Fetches a specification for the given Gem::NameTuple.
# File lib/rubygems/source.rb, line 126 def fetch_spec(name_tuple) fetcher = Gem::RemoteFetcher.fetcher spec_file_name = name_tuple.spec_name # The name tuple comes from a remote index and is not otherwise # validated, so refuse anything that would escape the spec cache # directory when used as a path component. if File.basename(spec_file_name) != spec_file_name raise Gem::Exception, "malformed spec name: #{spec_file_name.inspect}" end source_uri = enforce_trailing_slash(uri) + "#{Gem::MARSHAL_SPEC_DIR}#{spec_file_name}" cache_dir = cache_dir source_uri local_spec = File.join cache_dir, spec_file_name if File.exist? local_spec spec = Gem.read_binary local_spec Gem.load_safe_marshal spec = begin Gem::SafeMarshal.safe_load(spec) rescue StandardError nil end return spec if spec end source_uri.path << ".rz" spec = fetcher.fetch_path source_uri spec = Gem::Util.inflate spec if update_cache? require "fileutils" FileUtils.mkdir_p cache_dir File.open local_spec, "wb" do |io| io.write spec end end Gem.load_safe_marshal # TODO: Investigate setting Gem::Specification#loaded_from to a URI Gem::SafeMarshal.safe_load spec end
Loads type kind of specs fetching from +@uri+ if the on-disk cache is out of date.
type is one of the following:
:released => Return the list of all released specs :latest => Return the list of only the highest version of each gem :prerelease => Return the list of all prerelease only specs
The compact index is used when the source provides it, falling back to the Marshal spec indexes.
# File lib/rubygems/source.rb, line 187 def load_specs(type) load_compact_index_specs(type) || load_marshal_specs(type) end
# File lib/rubygems/source.rb, line 304 def typo_squatting?(host, distance_threshold = 4) return if @uri.host.nil? levenshtein_distance(@uri.host, host).between? 1, distance_threshold end
Returns true when it is possible and safe to update the cache directory.
# File lib/rubygems/source.rb, line 113 def update_cache? return @update_cache unless @update_cache.nil? @update_cache = begin File.stat(Gem.user_home).uid == Process.uid rescue Errno::ENOENT false end end