In Files

  • bundler/source/rubygems.rb
  • bundler/source/rubygems/remote.rb

Class/Module Index [+]

Quicksearch

Bundler::Source::Rubygems

Constants

API_REQUEST_LIMIT

Use the API when installing less than X gems

API_REQUEST_SIZE

Ask for X gems per API request

Attributes

caches[R]
remotes[R]

Public Class Methods

from_lock(options) click to toggle source
 
               # File bundler/source/rubygems.rb, line 82
def self.from_lock(options)
  new(options)
end
            
new(options = {}) click to toggle source
 
               # File bundler/source/rubygems.rb, line 16
def initialize(options = {})
  @options = options
  @remotes = []
  @dependency_names = []
  @allow_remote = false
  @allow_cached = false
  @allow_local = options["allow_local"] || false
  @caches = [cache_path, *Bundler.rubygems.gem_cache]

  Array(options["remotes"]).reverse_each {|r| add_remote(r) }
end
            

Public Instance Methods

==(other) click to toggle source
Alias for: eql?
add_remote(source) click to toggle source
 
               # File bundler/source/rubygems.rb, line 245
def add_remote(source)
  uri = normalize_uri(source)
  @remotes.unshift(uri) unless @remotes.include?(uri)
end
            
cache(spec, custom_path = nil) click to toggle source
 
               # File bundler/source/rubygems.rb, line 217
def cache(spec, custom_path = nil)
  if builtin_gem?(spec)
    cached_path = cached_built_in_gem(spec)
  else
    cached_path = cached_gem(spec)
  end
  raise GemNotFound, "Missing gem file '#{spec.full_name}.gem'." unless cached_path
  return if File.dirname(cached_path) == Bundler.app_cache.to_s
  Bundler.ui.info "  * #{File.basename(cached_path)}"
  FileUtils.cp(cached_path, Bundler.app_cache(custom_path))
rescue Errno::EACCES => e
  Bundler.ui.debug(e)
  raise InstallError, e.message
end
            
cached!() click to toggle source
 
               # File bundler/source/rubygems.rb, line 48
def cached!
  return if @allow_cached

  @specs = nil
  @allow_cached = true
end
            
cached_built_in_gem(spec) click to toggle source
 
               # File bundler/source/rubygems.rb, line 232
def cached_built_in_gem(spec)
  cached_path = cached_path(spec)
  if cached_path.nil?
    remote_spec = remote_specs.search(spec).first
    if remote_spec
      cached_path = fetch_gem(remote_spec)
    else
      Bundler.ui.warn "#{spec.full_name} is built in to Ruby, and can't be cached because your Gemfile doesn't have any sources that contain it."
    end
  end
  cached_path
end
            
can_lock?(spec) click to toggle source
 
               # File bundler/source/rubygems.rb, line 73
def can_lock?(spec)
  return super unless multiple_remotes?
  include?(spec.source)
end
            
dependency_api_available?() click to toggle source
 
               # File bundler/source/rubygems.rb, line 311
def dependency_api_available?
  api_fetchers.any?
end
            
dependency_names_to_double_check() click to toggle source
 
               # File bundler/source/rubygems.rb, line 296
def dependency_names_to_double_check
  names = []
  remote_specs.each do |spec|
    case spec
    when EndpointSpecification, Gem::Specification, StubSpecification, LazySpecification
      names.concat(spec.runtime_dependencies.map(&:name))
    when RemoteSpecification # from the full index
      return nil
    else
      raise "unhandled spec type (#{spec.inspect})"
    end
  end
  names
end
            
double_check_for(unmet_dependency_names) click to toggle source
 
               # File bundler/source/rubygems.rb, line 277
def double_check_for(unmet_dependency_names)
  return unless @allow_remote
  return unless dependency_api_available?

  unmet_dependency_names = unmet_dependency_names.call
  unless unmet_dependency_names.nil?
    if api_fetchers.size <= 1
      # can't do this when there are multiple fetchers because then we might not fetch from _all_
      # of them
      unmet_dependency_names -= remote_specs.spec_names # avoid re-fetching things we've already gotten
    end
    return if unmet_dependency_names.empty?
  end

  Bundler.ui.debug "Double checking for #{unmet_dependency_names || "all specs (due to the size of the request)"} in #{self}"

  fetch_names(api_fetchers, unmet_dependency_names, specs, false)
end
            
eql?(other) click to toggle source
 
               # File bundler/source/rubygems.rb, line 59
def eql?(other)
  other.is_a?(Rubygems) && other.credless_remotes == credless_remotes
end
            
Also aliased as: ==
equivalent_remotes?(other_remotes) click to toggle source
 
               # File bundler/source/rubygems.rb, line 250
def equivalent_remotes?(other_remotes)
  other_remotes.map(&method(:remove_auth)) == @remotes.map(&method(:remove_auth))
end
            
fetchers() click to toggle source
 
               # File bundler/source/rubygems.rb, line 270
def fetchers
  @fetchers ||= remotes.map do |uri|
    remote = Source::Rubygems::Remote.new(uri)
    Bundler::Fetcher.new(remote)
  end
end
            
hash() click to toggle source
 
               # File bundler/source/rubygems.rb, line 55
def hash
  @remotes.hash
end
            
include?(o) click to toggle source
 
               # File bundler/source/rubygems.rb, line 65
def include?(o)
  o.is_a?(Rubygems) && (o.credless_remotes - credless_remotes).empty?
end
            
install(spec, opts = {}) click to toggle source
 
               # File bundler/source/rubygems.rb, line 116
def install(spec, opts = {})
  force = opts[:force]
  ensure_builtin_gems_cached = opts[:ensure_builtin_gems_cached]

  if ensure_builtin_gems_cached && builtin_gem?(spec)
    if !cached_path(spec)
      cached_built_in_gem(spec) unless spec.remote
      force = true
    else
      spec.loaded_from = loaded_from(spec)
    end
  end

  if (installed?(spec) || Plugin.installed?(spec.name)) && !force
    print_using_message "Using #{version_message(spec)}"
    return nil # no post-install message
  end

  # Download the gem to get the spec, because some specs that are returned
  # by rubygems.org are broken and wrong.
  if spec.remote
    # Check for this spec from other sources
    uris = [spec.remote.anonymized_uri]
    uris += remotes_for_spec(spec).map(&:anonymized_uri)
    uris.uniq!
    Installer.ambiguous_gems << [spec.name, *uris] if uris.length > 1

    path = fetch_gem(spec)
    begin
      s = Bundler.rubygems.spec_from_gem(path, Bundler.settings["trust-policy"])
      spec.__swap__(s)
    rescue StandardError
      Bundler.rm_rf(path)
      raise
    end
  end

  unless Bundler.settings[:no_install]
    message = "Installing #{version_message(spec)}"
    message += " with native extensions" if spec.extensions.any?
    Bundler.ui.confirm message

    path = cached_gem(spec)
    if requires_sudo?
      install_path = Bundler.tmp(spec.full_name)
      bin_path     = install_path.join("bin")
    else
      install_path = rubygems_dir
      bin_path     = Bundler.system_bindir
    end

    Bundler.mkdir_p bin_path, :no_sudo => true unless spec.executables.empty? || Bundler.rubygems.provides?(">= 2.7.5")

    require_relative "../rubygems_gem_installer"

    installed_spec = Bundler::RubyGemsGemInstaller.at(
      path,
      :install_dir         => install_path.to_s,
      :bin_dir             => bin_path.to_s,
      :ignore_dependencies => true,
      :wrappers            => true,
      :env_shebang         => true,
      :build_args          => opts[:build_args],
      :bundler_expected_checksum => spec.respond_to?(:checksum) && spec.checksum,
      :bundler_extension_cache_path => extension_cache_path(spec)
    ).install
    spec.full_gem_path = installed_spec.full_gem_path

    # SUDO HAX
    if requires_sudo?
      Bundler.rubygems.repository_subdirectories.each do |name|
        src = File.join(install_path, name, "*")
        dst = File.join(rubygems_dir, name)
        if name == "extensions" && Dir.glob(src).any?
          src = File.join(src, "*/*")
          ext_src = Dir.glob(src).first
          ext_src.gsub!(src[0..-6], "")
          dst = File.dirname(File.join(dst, ext_src))
        end
        SharedHelpers.filesystem_access(dst) do |p|
          Bundler.mkdir_p(p)
        end
        Bundler.sudo "cp -R #{src} #{dst}" if Dir[src].any?
      end

      spec.executables.each do |exe|
        SharedHelpers.filesystem_access(Bundler.system_bindir) do |p|
          Bundler.mkdir_p(p)
        end
        Bundler.sudo "cp -R #{install_path}/bin/#{exe} #{Bundler.system_bindir}/"
      end
    end
    installed_spec.loaded_from = loaded_from(spec)
  end
  spec.loaded_from = loaded_from(spec)

  spec.post_install_message
ensure
  Bundler.rm_rf(install_path) if requires_sudo?
end
            
local!() click to toggle source
 
               # File bundler/source/rubygems.rb, line 34
def local!
  return if @allow_local

  @specs = nil
  @allow_local = true
end
            
local_only!() click to toggle source
 
               # File bundler/source/rubygems.rb, line 28
def local_only!
  @specs = nil
  @allow_local = true
  @allow_remote = false
end
            
multiple_remotes?() click to toggle source
 
               # File bundler/source/rubygems.rb, line 69
def multiple_remotes?
  @remotes.size > 1
end
            
name() click to toggle source
Alias for: to_s
options() click to toggle source
 
               # File bundler/source/rubygems.rb, line 78
def options
  { "remotes" => @remotes.map(&:to_s) }
end
            
remote!() click to toggle source
 
               # File bundler/source/rubygems.rb, line 41
def remote!
  return if @allow_remote

  @specs = nil
  @allow_remote = true
end
            
spec_names() click to toggle source
 
               # File bundler/source/rubygems.rb, line 254
def spec_names
  if @allow_remote && dependency_api_available?
    remote_specs.spec_names
  else
    []
  end
end
            
specs() click to toggle source
 
               # File bundler/source/rubygems.rb, line 104
def specs
  @specs ||= begin
    # remote_specs usually generates a way larger Index than the other
    # sources, and large_idx.use small_idx is way faster than
    # small_idx.use large_idx.
    idx = @allow_remote ? remote_specs.dup : Index.new
    idx.use(cached_specs, :override_dupes) if @allow_cached || @allow_remote
    idx.use(installed_specs, :override_dupes) if @allow_local
    idx
  end
end
            
to_lock() click to toggle source
 
               # File bundler/source/rubygems.rb, line 86
def to_lock
  out = String.new("GEM\n")
  remotes.reverse_each do |remote|
    out << "  remote: #{suppress_configured_credentials remote}\n"
  end
  out << "  specs:\n"
end
            
to_s() click to toggle source
 
               # File bundler/source/rubygems.rb, line 94
def to_s
  if remotes.empty?
    "locally installed gems"
  else
    remote_names = remotes.map(&:to_s).join(", ")
    "rubygems repository #{remote_names} or installed locally"
  end
end
            
Also aliased as: name
unmet_deps() click to toggle source
 
               # File bundler/source/rubygems.rb, line 262
def unmet_deps
  if @allow_remote && dependency_api_available?
    remote_specs.unmet_dependency_names
  else
    []
  end
end
            

Protected Instance Methods

api_fetchers() click to toggle source
 
               # File bundler/source/rubygems.rb, line 400
def api_fetchers
  fetchers.select {|f| f.use_api && f.fetchers.first.api_fetcher? }
end
            
builtin_gem?(spec) click to toggle source
 
               # File bundler/source/rubygems.rb, line 460
def builtin_gem?(spec)
  # Ruby 2.1, where all included gems have this summary
  return true if spec.summary =~ /is bundled with Ruby/

  # Ruby 2.0, where gemspecs are stored in specifications/default/
  spec.loaded_from && spec.loaded_from.include?("specifications/default/")
end
            
cache_path() click to toggle source
 
               # File bundler/source/rubygems.rb, line 480
def cache_path
  Bundler.app_cache
end
            
cached_gem(spec) click to toggle source
 
               # File bundler/source/rubygems.rb, line 332
def cached_gem(spec)
  cached_gem = cached_path(spec)
  unless cached_gem
    raise Bundler::GemNotFound, "Could not find #{spec.file_name} for installation"
  end
  cached_gem
end
            
cached_path(spec) click to toggle source
 
               # File bundler/source/rubygems.rb, line 340
def cached_path(spec)
  possibilities = @caches.map {|p| "#{p}/#{spec.file_name}" }
  possibilities.find {|p| File.exist?(p) }
end
            
cached_specs() click to toggle source
 
               # File bundler/source/rubygems.rb, line 385
def cached_specs
  @cached_specs ||= begin
    idx = @allow_local ? installed_specs.dup : Index.new

    Dir["#{cache_path}/*.gem"].each do |gemfile|
      next if gemfile =~ /^bundler\-[\d\.]+?\.gem/
      s ||= Bundler.rubygems.spec_from_gem(gemfile)
      s.source = self
      idx << s
    end

    idx
  end
end
            
credless_remotes() click to toggle source
 
               # File bundler/source/rubygems.rb, line 317
def credless_remotes
  remotes.map(&method(:suppress_configured_credentials))
end
            
fetch_gem(spec) click to toggle source
 
               # File bundler/source/rubygems.rb, line 435
def fetch_gem(spec)
  return false unless spec.remote

  spec.fetch_platform

  download_path = requires_sudo? ? Bundler.tmp(spec.full_name) : rubygems_dir
  gem_path = "#{rubygems_dir}/cache/#{spec.full_name}.gem"

  SharedHelpers.filesystem_access("#{download_path}/cache") do |p|
    FileUtils.mkdir_p(p)
  end
  download_gem(spec, download_path)

  if requires_sudo?
    SharedHelpers.filesystem_access("#{rubygems_dir}/cache") do |p|
      Bundler.mkdir_p(p)
    end
    Bundler.sudo "mv #{download_path}/cache/#{spec.full_name}.gem #{gem_path}"
  end

  gem_path
ensure
  Bundler.rm_rf(download_path) if requires_sudo?
end
            
fetch_names(fetchers, dependency_names, index, override_dupes) click to toggle source
 
               # File bundler/source/rubygems.rb, line 422
def fetch_names(fetchers, dependency_names, index, override_dupes)
  fetchers.each do |f|
    if dependency_names
      Bundler.ui.info "Fetching gem metadata from #{URICredentialsFilter.credential_filtered_uri(f.uri)}", Bundler.ui.debug?
      index.use f.specs_with_retry(dependency_names, self), override_dupes
      Bundler.ui.info "" unless Bundler.ui.debug? # new line now that the dots are over
    else
      Bundler.ui.info "Fetching source index from #{URICredentialsFilter.credential_filtered_uri(f.uri)}"
      index.use f.specs_with_retry(nil, self), override_dupes
    end
  end
end
            
installed?(spec) click to toggle source
 
               # File bundler/source/rubygems.rb, line 468
def installed?(spec)
  installed_specs[spec].any?
end
            
installed_specs() click to toggle source
 
               # File bundler/source/rubygems.rb, line 372
def installed_specs
  @installed_specs ||= Index.build do |idx|
    Bundler.rubygems.all_specs.reverse_each do |spec|
      spec.source = self
      if Bundler.rubygems.spec_missing_extensions?(spec, false)
        Bundler.ui.debug "Source #{self} is ignoring #{spec} because it is missing extensions"
        next
      end
      idx << spec
    end
  end
end
            
loaded_from(spec) click to toggle source
 
               # File bundler/source/rubygems.rb, line 328
def loaded_from(spec)
  "#{rubygems_dir}/specifications/#{spec.full_name}.gemspec"
end
            
normalize_uri(uri) click to toggle source
 
               # File bundler/source/rubygems.rb, line 345
def normalize_uri(uri)
  uri = uri.to_s
  uri = "#{uri}/" unless uri =~ %r{/$}
  require_relative "../vendored_uri"
  uri = Bundler::URI(uri)
  raise ArgumentError, "The source must be an absolute URI. For example:\n"            "source 'https://rubygems.org'" if !uri.absolute? || (uri.is_a?(Bundler::URI::HTTP) && uri.host.nil?)
  uri
end
            
remote_specs() click to toggle source
 
               # File bundler/source/rubygems.rb, line 404
def remote_specs
  @remote_specs ||= Index.build do |idx|
    index_fetchers = fetchers - api_fetchers

    # gather lists from non-api sites
    fetch_names(index_fetchers, nil, idx, false)

    # because ensuring we have all the gems we need involves downloading
    # the gemspecs of those gems, if the non-api sites contain more than
    # about 500 gems, we treat all sites as non-api for speed.
    allow_api = idx.size < API_REQUEST_LIMIT && dependency_names.size < API_REQUEST_LIMIT
    Bundler.ui.debug "Need to query more than #{API_REQUEST_LIMIT} gems."              " Downloading full index instead..." unless allow_api

    fetch_names(api_fetchers, allow_api && dependency_names, idx, false)
  end
end
            
remotes_for_spec(spec) click to toggle source
 
               # File bundler/source/rubygems.rb, line 321
def remotes_for_spec(spec)
  specs.search_all(spec.name).inject([]) do |uris, s|
    uris << s.remote if s.remote
    uris
  end
end
            
remove_auth(remote) click to toggle source
 
               # File bundler/source/rubygems.rb, line 364
def remove_auth(remote)
  if remote.user || remote.password
    remote.dup.tap {|uri| uri.user = uri.password = nil }.to_s
  else
    remote.to_s
  end
end
            
requires_sudo?() click to toggle source
 
               # File bundler/source/rubygems.rb, line 472
def requires_sudo?
  Bundler.requires_sudo?
end
            
rubygems_dir() click to toggle source
 
               # File bundler/source/rubygems.rb, line 476
def rubygems_dir
  Bundler.rubygems.gem_dir
end
            
suppress_configured_credentials(remote) click to toggle source
 
               # File bundler/source/rubygems.rb, line 355
def suppress_configured_credentials(remote)
  remote_nouser = remove_auth(remote)
  if remote.userinfo && remote.userinfo == Bundler.settings[remote_nouser]
    remote_nouser
  else
    remote
  end
end