Class: Gem::Source

Relationships & Source Files
Namespace Children
Classes: `Git`, `Installed`, `Local`, `Lock`, `SpecificFile`, `Vendor`
Extension / Inclusion / Inheritance Descendants
Subclasses: Git, Installed, Local, Lock, SpecificFile, Vendor
Super Chains via Extension / Inclusion / Inheritance
Instance Chain: self, `Text`, Comparable
Inherits:	Object
Defined in:	lib/rubygems/source.rb

Overview

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.

Constant Summary

FILES = Internal use only
# File 'lib/rubygems/source.rb', line 14

{ # :nodoc:
  released: "specs",
  latest: "latest_specs",
  prerelease: "prerelease_specs",
}.freeze

Class Method Summary

.new(uri) ⇒ Source constructor

Creates a new Source which will use the index located at #uri.

Instance Attribute Summary

#update_cache? ⇒ Boolean readonly

Returns true when it is possible and safe to update the cache directory.
#uri readonly

The URI this source will fetch gems from.

Instance Method Summary

#<=>(other)

Sources are ordered by installation preference.
#cache_dir(uri)

Returns the local directory to write #uri to.
#dependency_resolver_set(prerelease = false)

Returns a Set that can fetch specifications from this source.
#download(spec, dir = Dir.pwd)

Downloads spec and writes it to dir.
#fetch_spec(name_tuple)

Fetches a specification for the given NameTuple.
#load_specs(type)

Loads type kind of specs fetching from @uri if the on-disk cache is out of date.
#typo_squatting?(host, distance_threshold = 4) ⇒ Boolean
#compact_index_cache_dir(index_uri) private
#compact_index_uri private
#compact_index_versions private
#enforce_trailing_slash(uri) private
#load_compact_index_specs(type) private

Builds the name tuple list for type from the compact index versions file.
#load_marshal_specs(type) private
#max_versions_by_platform(tuples) private
#new_dependency_resolver_set private
#==(other) (also: #eql?) Internal use only
#compact_index_client Internal use only

The compact index client for this source, caching under spec_cache_dir.
#eql?(other) Internal use only

Alias for #==.
#hash Internal use only
#pretty_print(q) Internal use only

`Text` - Included

#clean_text	Remove any non-printable characters and make the text suitable for printing.
#format_text	Wraps `text` to `wrap` characters and optionally indents by `indent` characters.
#levenshtein_distance	Returns a value representing the "cost" of transforming str1 into str2 Vendored version of `DidYouMean::Levenshtein.distance` from the ruby/did_you_mean gem @ 1.4.0 https://github.com/ruby/did_you_mean/blob/2ddf39b874808685965dbc47d344cf6c7651807c/lib/did_you_mean/levenshtein.rb#L7-L37.
#truncate_text, #min3

Constructor Details

.new(uri) ⇒ `Source`

Creates a new Source which will use the index located at #uri.

[ GitHub ]

# File 'lib/rubygems/source.rb', line 28


def initialize(uri)
  require_relative "uri"
  @uri = Gem::Uri.parse!(uri)
  @update_cache = nil
end

Instance Attribute Details

#update_cache? ⇒ `Boolean` (readonly)

Returns true when it is possible and safe to update the cache directory.

[ GitHub ]

# File 'lib/rubygems/source.rb', line 94


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

#uri (readonly)

The URI this source will fetch gems from.

[ GitHub ]

# File 'lib/rubygems/source.rb', line 23


attr_reader :uri

Instance Method Details

#<=>(other)

Sources are ordered by installation preference.

[ GitHub ]

# File 'lib/rubygems/source.rb', line 37


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

#==(other) Also known as: #eql?

This method is for internal use only.

[ GitHub ]

# File 'lib/rubygems/source.rb', line 62


def ==(other) # :nodoc:
  self.class === other && @uri == other.uri
end

#cache_dir(uri)

Returns the local directory to write #uri to.

[ GitHub ]

# File 'lib/rubygems/source.rb', line 84


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

#compact_index_cache_dir(index_uri) (private)

[ GitHub ]

# File 'lib/rubygems/source.rb', line 293


def compact_index_cache_dir(index_uri)
  if update_cache?
    # Correct for windows paths
    escaped_path = index_uri.path.sub(%r{^/([a-z]):/}i, '/\\1-/')

    File.join Gem.spec_cache_dir, "compact_index",
      "#{index_uri.host}%#{index_uri.port}", *escaped_path.split("/").reject(&:empty?)
  else
    require "tmpdir"
    require "fileutils"
    dir = Dir.mktmpdir "gem_compact_index"
    at_exit { FileUtils.rm_rf dir }
    dir
  end
end

#compact_index_client

This method is for internal use only.

The compact index client for this source, caching under Gem.spec_cache_dir. Also used by Resolver::APISet.

[ GitHub ]

# File 'lib/rubygems/source.rb', line 169


def compact_index_client # :nodoc:
  @compact_index_client ||= begin
    require_relative "compact_index_client"

    index_uri = compact_index_uri

    Gem::CompactIndexClient.new(compact_index_cache_dir(index_uri),
      Gem::CompactIndexClient::HTTPFetcher.new(index_uri))
  end
end

#compact_index_uri (private)

[ GitHub ]

# File 'lib/rubygems/source.rb', line 283


def compact_index_uri
  if uri.host == "rubygems.org"
    index_uri = uri.dup
    index_uri.host = "index.rubygems.org"
    index_uri
  else
    uri
  end
end

#compact_index_versions (private)

[ GitHub ]

# File 'lib/rubygems/source.rb', line 272


def compact_index_versions
  @compact_index_versions ||= compact_index_client.versions
rescue Gem::RemoteFetcher::FetchError, Gem::CompactIndexClient::Error
  @compact_index_versions = {}
  nil
end

#dependency_resolver_set(prerelease = false)

Returns a Set that can fetch specifications from this source.

The set will optionally fetch prereleases if requested.

[ GitHub ]

# File 'lib/rubygems/source.rb', line 73


def dependency_resolver_set(prerelease = false)
  new_dependency_resolver_set.tap {|set| set.prerelease = prerelease }
end

#download(spec, dir = Dir.pwd)

Downloads spec and writes it to Gem.dir. See also RemoteFetcher#download.

[ GitHub ]

# File 'lib/rubygems/source.rb', line 184


def download(spec, dir = Dir.pwd)
  fetcher = Gem::RemoteFetcher.fetcher
  fetcher.download spec, uri.to_s, dir
end

#enforce_trailing_slash(uri) (private)

[ GitHub ]

# File 'lib/rubygems/source.rb', line 324


def enforce_trailing_slash(uri)
  uri.merge(uri.path.gsub(%r{/+$}, "") + "/")
end

#eql?(other)

This method is for internal use only.

Alias for #==.

[ GitHub ]

# File 'lib/rubygems/source.rb', line 66


alias_method :eql?, :== # :nodoc:

#fetch_spec(name_tuple)

Fetches a specification for the given NameTuple.

[ GitHub ]

# File 'lib/rubygems/source.rb', line 107


def fetch_spec(name_tuple)
  fetcher = Gem::RemoteFetcher.fetcher

  spec_file_name = name_tuple.spec_name

  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

#hash

This method is for internal use only.

[ GitHub ]

# File 'lib/rubygems/source.rb', line 77


def hash # :nodoc:
  @uri.hash
end

#load_compact_index_specs(type) (private)

Builds the name tuple list for type from the compact index versions file. Returns nil when the source does not provide a usable compact index, so the caller can fall back to the Marshal spec indexes.

[ GitHub ]

# File 'lib/rubygems/source.rb', line 246


def load_compact_index_specs(type)
  return unless %w[http https].include?(uri.scheme)

  versions = compact_index_versions
  return if versions.nil? || versions.empty?

  tuples = []

  versions.each_value do |rows|
    gem_tuples = rows.filter_map do |name, version_string, platform|
      next unless Gem::Version.correct?(version_string)

      version = Gem::Version.new(version_string)
      next if version.prerelease? != (type == :prerelease)

      Gem::NameTuple.new(name, version, platform || "ruby")
    end

    gem_tuples = max_versions_by_platform(gem_tuples) if type == :latest

    tuples.concat(gem_tuples)
  end

  tuples
end

#load_marshal_specs(type) (private)

[ GitHub ]

# File 'lib/rubygems/source.rb', line 211


def load_marshal_specs(type)
  file       = FILES[type]
  fetcher    = Gem::RemoteFetcher.fetcher
  file_name  = "#{file}.#{Gem.marshal_version}"
  spec_path  = enforce_trailing_slash(uri) + "#{file_name}.gz"
  cache_dir  = cache_dir spec_path
  local_file = File.join(cache_dir, file_name)
  retried    = false

  if update_cache?
    require "fileutils"
    FileUtils.mkdir_p cache_dir
  end

  spec_dump = fetcher.cache_update_path spec_path, local_file, update_cache?

  Gem.load_safe_marshal
  begin
    Gem::NameTuple.from_list Gem::SafeMarshal.safe_load(spec_dump)
  rescue ArgumentError
    if update_cache? && !retried
      FileUtils.rm local_file
      retried = true
      retry
    else
      raise Gem::Exception.new("Invalid spec cache file in #{local_file}")
    end
  end
end

#load_specs(type)

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.

[ GitHub ]

# File 'lib/rubygems/source.rb', line 161


def load_specs(type)
  load_compact_index_specs(type) || load_marshal_specs(type)
end

#max_versions_by_platform(tuples) (private)

[ GitHub ]

# File 'lib/rubygems/source.rb', line 279


def max_versions_by_platform(tuples)
  tuples.group_by(&:platform).map {|_, platform_tuples| platform_tuples.max_by(&:version) }
end

#new_dependency_resolver_set (private)

[ GitHub ]

# File 'lib/rubygems/source.rb', line 309


def new_dependency_resolver_set
  return Gem::Resolver::IndexSet.new self if uri.scheme == "file"

  bundler_api_uri = enforce_trailing_slash(compact_index_uri) + "versions"

  begin
    fetcher = Gem::RemoteFetcher.fetcher
    response = fetcher.fetch_path bundler_api_uri, nil, true
  rescue Gem::RemoteFetcher::FetchError
    Gem::Resolver::IndexSet.new self
  else
    Gem::Resolver::APISet.new response.uri + "./info/"
  end
end

#pretty_print(q)

This method is for internal use only.

[ GitHub ]

# File 'lib/rubygems/source.rb', line 189


def pretty_print(q) # :nodoc:
  q.object_group(self) do
    q.group 2, "[Remote:", "]" do
      q.breakable
      q.text @uri.to_s

      if api = uri
        q.breakable
        q.text "API URI: "
        q.text api.to_s
      end
    end
  end
end

#typo_squatting?(host, distance_threshold = 4) ⇒ `Boolean`

[ GitHub ]

# File 'lib/rubygems/source.rb', line 204


def typo_squatting?(host, distance_threshold = 4)
  return if @uri.host.nil?
  levenshtein_distance(@uri.host, host).between? 1, distance_threshold
end

Class: Gem::Source

Overview

Constant Summary

Class Method Summary

Instance Attribute Summary

Instance Method Summary

Text - Included

Constructor Details

.new(uri) ⇒ Source

Instance Attribute Details

#update_cache? ⇒ Boolean (readonly)

#uri (readonly)

Instance Method Details

#<=>(other)

#==(other) Also known as: #eql?

#cache_dir(uri)

#compact_index_cache_dir(index_uri) (private)

#compact_index_client

#compact_index_uri (private)

#compact_index_versions (private)

#dependency_resolver_set(prerelease = false)

#download(spec, dir = Dir.pwd)

#enforce_trailing_slash(uri) (private)

#eql?(other)

#fetch_spec(name_tuple)

#hash

#load_compact_index_specs(type) (private)

#load_marshal_specs(type) (private)

#load_specs(type)

#max_versions_by_platform(tuples) (private)

#new_dependency_resolver_set (private)

#pretty_print(q)

#typo_squatting?(host, distance_threshold = 4) ⇒ Boolean

`Text` - Included

.new(uri) ⇒ `Source`

#update_cache? ⇒ `Boolean` (readonly)

#typo_squatting?(host, distance_threshold = 4) ⇒ `Boolean`