class Gem::Source

Source 知道如何从 RubyGems 的 marshal 索引中列出和获取 gem 包。

还有其他的 Source 子类,用于已安装的 gem 包、本地 gem 包、bundler 依赖 API 等等。

属性

uri[R]

此源将从中获取 gem 包的 URI。

公共类方法

new(uri) 点击切换源代码

创建一个新的 Source,它将使用位于 uri 的索引。

# File rubygems/source.rb, line 28
def initialize(uri)
  require_relative "uri"
  @uri = Gem::Uri.parse!(uri)
  @update_cache = nil
end

公共实例方法

<=>(other) 点击切换源代码

源按安装优先级排序。

# File 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
cache_dir(uri) 点击切换源代码

返回将 uri 写入的本地目录。

# File rubygems/source.rb, line 101
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
download(spec, dir=Dir.pwd) 点击切换源代码

下载 spec 并将其写入 dir。另请参阅 Gem::RemoteFetcher#download

# File rubygems/source.rb, line 210
def download(spec, dir=Dir.pwd)
  fetcher = Gem::RemoteFetcher.fetcher
  fetcher.download spec, uri.to_s, dir
end
fetch_spec(name_tuple) 点击切换源代码

获取给定 name_tuple 的规范。

# File rubygems/source.rb, line 124
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
load_specs(type) 点击切换源代码

加载 type 类型的规范,如果磁盘缓存已过期,则从 +@uri+ 获取。

type 是以下之一

:released => 返回所有已发布规范的列表 :latest => 返回每个 gem 的最高版本列表 :prerelease => 返回所有预发布版本规范的列表

# File rubygems/source.rb, line 176
def load_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
typo_squatting?(host, distance_threshold=4) 点击切换源代码
# File rubygems/source.rb, line 230
def typo_squatting?(host, distance_threshold=4)
  return if @uri.host.nil?
  levenshtein_distance(@uri.host, host).between? 1, distance_threshold
end
update_cache?() 点击切换源代码

当可以安全地更新缓存目录时,返回 true。

# File rubygems/source.rb, line 111
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

私有实例方法

enforce_trailing_slash(uri) 点击切换源代码
# File rubygems/source.rb, line 237
def enforce_trailing_slash(uri)
  uri.merge(uri.path.gsub(%r{/+$}, "") + "/")
end