123456789_123456789_123456789_123456789_123456789_

Class: Bundler::Source::Rubygems

Relationships & Source Files
Namespace Children
Classes:
Extension / Inclusion / Inheritance Descendants
Subclasses:
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
Instance Chain:
Inherits: Bundler::Source
Defined in: lib/bundler/source/rubygems.rb,
lib/bundler/source/rubygems/remote.rb

Constant Summary

Class Method Summary

Instance Attribute Summary

Instance Method Summary

::Bundler::Source - Inherited

#add_dependency_names, #cached!, #can_lock?, #dependency_names_to_double_check,
#double_check_for

it’s possible that gems from one source depend on gems from some other source, so now we download gemspecs and iterate over those dependencies, looking for gems we don’t have info on yet.

#extension_cache_path, #identifier, #include?, #inspect, #local!, #local_only!, #remote!, #spec_names, #unmet_deps, #version_message, #earlier_version?, #extension_cache_slug, #print_using_message, #version_color

Constructor Details

.new(options = {}) ⇒ Rubygems

[ GitHub ]

  
# File 'lib/bundler/source/rubygems.rb', line 17

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

Class Method Details

.from_lock(options)

[ GitHub ]

  
# File 'lib/bundler/source/rubygems.rb', line 89

def self.from_lock(options)
  new(options)
end

Instance Attribute Details

#caches (readonly)

[ GitHub ]

  
# File 'lib/bundler/source/rubygems.rb', line 15

attr_reader :remotes, :caches

#dependency_api_available?Boolean (readonly)

[ GitHub ]

  
# File 'lib/bundler/source/rubygems.rb', line 328

def dependency_api_available?
  api_fetchers.any?
end

#multiple_remotes?Boolean (readonly)

[ GitHub ]

  
# File 'lib/bundler/source/rubygems.rb', line 72

def multiple_remotes?
  @remotes.size > 1
end

#no_remotes?Boolean (readonly)

[ GitHub ]

  
# File 'lib/bundler/source/rubygems.rb', line 76

def no_remotes?
  @remotes.size == 0
end

#remotes (readonly)

[ GitHub ]

  
# File 'lib/bundler/source/rubygems.rb', line 15

attr_reader :remotes, :caches

#requires_sudo?Boolean (readonly, protected)

[ GitHub ]

  
# File 'lib/bundler/source/rubygems.rb', line 506

def requires_sudo?
  Bundler.requires_sudo?
end

Instance Method Details

#==(other)

Alias for #eql?.

[ GitHub ]

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

alias_method :==, :eql?

#add_remote(source)

[ GitHub ]

  
# File 'lib/bundler/source/rubygems.rb', line 266

def add_remote(source)
  uri = normalize_uri(source)
  @remotes.unshift(uri) unless @remotes.include?(uri)
end

#api_fetchers (protected)

[ GitHub ]

  
# File 'lib/bundler/source/rubygems.rb', line 428

def api_fetchers
  fetchers.select {|f| f.use_api && f.fetchers.first.api_fetcher? }
end

#cache(spec, custom_path = nil)

[ GitHub ]

  
# File 'lib/bundler/source/rubygems.rb', line 242

def cache(spec, custom_path = nil)
  cached_path = Bundler.settings[:cache_all_platforms] ? fetch_gem_if_possible(spec) : cached_gem(spec)
  raise GemNotFound, "Missing gem file '#{spec.file_name}'." 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

#cache_path (protected)

[ GitHub ]

  
# File 'lib/bundler/source/rubygems.rb', line 518

def cache_path
  Bundler.app_cache
end

#cached!

[ GitHub ]

  
# File 'lib/bundler/source/rubygems.rb', line 50

def cached!
  return if @allow_cached

  @specs = nil
  @allow_local = true
  @allow_cached = true
end

#cached_built_in_gem(spec)

[ GitHub ]

  
# File 'lib/bundler/source/rubygems.rb', line 253

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

#cached_gem(spec) (protected)

[ GitHub ]

  
# File 'lib/bundler/source/rubygems.rb', line 353

def cached_gem(spec)
  if spec.default_gem?
    cached_built_in_gem(spec)
  else
    cached_path(spec)
  end
end

#cached_path(spec) (protected)

[ GitHub ]

  
# File 'lib/bundler/source/rubygems.rb', line 361

def cached_path(spec)
  global_cache_path = download_cache_path(spec)
  @caches << global_cache_path if global_cache_path

  possibilities = @caches.map {|p| package_path(p, spec) }
  possibilities.find {|p| File.exist?(p) }
end

#cached_specs (protected)

[ GitHub ]

  
# File 'lib/bundler/source/rubygems.rb', line 413

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

#can_lock?(spec) ⇒ Boolean

[ GitHub ]

  
# File 'lib/bundler/source/rubygems.rb', line 80

def can_lock?(spec)
  return super unless multiple_remotes?
  include?(spec.source)
end

#credless_remotes (protected)

[ GitHub ]

  
# File 'lib/bundler/source/rubygems.rb', line 338

def credless_remotes
  if Bundler.settings[:allow_deployment_source_credential_changes]
    remotes.map(&method(:remove_auth))
  else
    remotes.map(&method(:suppress_configured_credentials))
  end
end

#default_cache_path_for(dir) (protected)

[ GitHub ]

  
# File 'lib/bundler/source/rubygems.rb', line 514

def default_cache_path_for(dir)
  "#{dir}/cache"
end

#dependency_names_to_double_check

[ GitHub ]

  
# File 'lib/bundler/source/rubygems.rb', line 313

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)

[ GitHub ]

  
# File 'lib/bundler/source/rubygems.rb', line 294

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

#download_cache_path(spec) ⇒ Pathname (private)

Returns the global cache path of the calling Rubygems::Source object.

Note that the ::Bundler::Source determines the path’s subdirectory. We use this subdirectory in the global cache path so that gems with the same name – and possibly different versions – from different sources are saved to their respective subdirectories and do not override one another.

Parameters:

Returns:

  • (Pathname)

    The global cache path.

[ GitHub ]

  
# File 'lib/bundler/source/rubygems.rb', line 553

def download_cache_path(spec)
  return unless Bundler.feature_flag.global_gem_cache?
  return unless remote = spec.remote
  return unless cache_slug = remote.cache_slug

  Bundler.user_cache.join("gems", cache_slug)
end

#download_gem(spec, download_cache_path, previous_spec = nil) (private)

Checks if the requested spec exists in the global cache. If it does, we copy it to the download path, and if it does not, we download it.

Parameters:

  • spec (Specification)

    the spec we want to download or retrieve from the cache.

  • download_cache_path (String)

    the local directory the .gem will end up in.

  • previous_spec (Specification) (defaults to: nil)

    the spec previously locked

[ GitHub ]

  
# File 'lib/bundler/source/rubygems.rb', line 536

def download_gem(spec, download_cache_path, previous_spec = nil)
  uri = spec.remote.uri
  Bundler.ui.confirm("Fetching #{version_message(spec, previous_spec)}")
  Bundler.rubygems.download_gem(spec, uri, download_cache_path)
end

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

[ GitHub ]

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

def eql?(other)
  other.is_a?(Rubygems) && other.credless_remotes == credless_remotes
end

#extension_cache_slug(spec) (private)

[ GitHub ]

  
# File 'lib/bundler/source/rubygems.rb', line 561

def extension_cache_slug(spec)
  return unless remote = spec.remote
  remote.cache_slug
end

#fetch_gem(spec, previous_spec = nil) (protected)

[ GitHub ]

  
# File 'lib/bundler/source/rubygems.rb', line 471

def fetch_gem(spec, previous_spec = nil)
  spec.fetch_platform

  cache_path = download_cache_path(spec) || default_cache_path_for(rubygems_dir)
  gem_path = package_path(cache_path, spec)
  return gem_path if File.exist?(gem_path)

  if requires_sudo?
    download_path = Bundler.tmp(spec.full_name)
    download_cache_path = default_cache_path_for(download_path)
  else
    download_cache_path = cache_path
  end

  SharedHelpers.filesystem_access(download_cache_path) do |p|
    FileUtils.mkdir_p(p)
  end
  download_gem(spec, download_cache_path, previous_spec)

  if requires_sudo?
    SharedHelpers.filesystem_access(cache_path) do |p|
      Bundler.mkdir_p(p)
    end
    Bundler.sudo "mv #{package_path(download_cache_path, spec)} #{gem_path}"
  end

  gem_path
ensure
  Bundler.rm_rf(download_path) if requires_sudo?
end

#fetch_gem_if_possible(spec, previous_spec = nil) (protected)

[ GitHub ]

  
# File 'lib/bundler/source/rubygems.rb', line 463

def fetch_gem_if_possible(spec, previous_spec = nil)
  if spec.remote
    fetch_gem(spec, previous_spec)
  else
    cached_gem(spec)
  end
end

#fetch_names(fetchers, dependency_names, index, override_dupes) (protected)

[ GitHub ]

  
# File 'lib/bundler/source/rubygems.rb', line 450

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

#fetchers

[ GitHub ]

  
# File 'lib/bundler/source/rubygems.rb', line 287

def fetchers
  @fetchers ||= remotes.map do |uri|
    remote = Source::Rubygems::Remote.new(uri)
    Bundler::Fetcher.new(remote)
  end
end

#hash

[ GitHub ]

  
# File 'lib/bundler/source/rubygems.rb', line 58

def hash
  @remotes.hash
end

#identifier Also known as: #name

[ GitHub ]

  
# File 'lib/bundler/source/rubygems.rb', line 117

def identifier
  if remotes.empty?
    "locally installed gems"
  else
    "rubygems repository #{remote_names}"
  end
end

#include?(o) ⇒ Boolean

[ GitHub ]

  
# File 'lib/bundler/source/rubygems.rb', line 68

def include?(o)
  o.is_a?(Rubygems) && (o.credless_remotes - credless_remotes).empty?
end

#install(spec, options = {})

[ GitHub ]

  
# File 'lib/bundler/source/rubygems.rb', line 138

def install(spec, options = {})
  force = options[:force]
  ensure_builtin_gems_cached = options[:ensure_builtin_gems_cached]

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

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

  if spec.remote
    # Check for this spec from other sources
    uris = [spec.remote, *remotes_for_spec(spec)].map(&:anonymized_uri).uniq
    Installer.ambiguous_gems << [spec.name, *uris] if uris.length > 1
  end

  path = fetch_gem_if_possible(spec, options[:previous_spec])
  raise GemNotFound, "Could not find #{spec.file_name} for installation" unless path

  return if Bundler.settings[:no_install]

  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"

  installer = Bundler::RubyGemsGemInstaller.at(
    path,
    :security_policy     => Bundler.rubygems.security_policies[Bundler.settings["trust-policy"]],
    :install_dir         => install_path.to_s,
    :bin_dir             => bin_path.to_s,
    :ignore_dependencies => true,
    :wrappers            => true,
    :env_shebang         => true,
    :build_args          => options[:build_args],
    :bundler_expected_checksum => spec.respond_to?(:checksum) && spec.checksum,
    :bundler_extension_cache_path => extension_cache_path(spec)
  )

  if spec.remote
    s = begin
      installer.spec
    rescue Gem::Package::FormatError
      Bundler.rm_rf(path)
      raise
    rescue Gem::Security::Exception => e
      raise SecurityError,
       "The gem #{File.basename(path, ".gem")} can't be installed because " \
       "the security policy didn't allow it, with the message: #{e.message}"
    end

    spec.__swap__(s)
  end

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

  installed_spec = installer.install

  spec.full_gem_path = installed_spec.full_gem_path
  spec.loaded_from = installed_spec.loaded_from

  # 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

  spec.post_install_message
ensure
  Bundler.rm_rf(install_path) if requires_sudo?
end

#installed?(spec) ⇒ Boolean (protected)

[ GitHub ]

  
# File 'lib/bundler/source/rubygems.rb', line 502

def installed?(spec)
  installed_specs[spec].any? && !spec.deleted_gem?
end

#installed_specs (protected)

[ GitHub ]

  
# File 'lib/bundler/source/rubygems.rb', line 400

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

#local!

[ GitHub ]

  
# File 'lib/bundler/source/rubygems.rb', line 36

def local!
  return if @allow_local

  @specs = nil
  @allow_local = true
end

#local_only!

[ GitHub ]

  
# File 'lib/bundler/source/rubygems.rb', line 29

def local_only!
  @specs = nil
  @allow_local = true
  @allow_cached = false
  @allow_remote = false
end

#name

Alias for #identifier.

[ GitHub ]

  
# File 'lib/bundler/source/rubygems.rb', line 124

alias_method :name, :identifier

#normalize_uri(uri) (protected)

Raises:

  • (ArgumentError)
[ GitHub ]

  
# File 'lib/bundler/source/rubygems.rb', line 373

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

#options

[ GitHub ]

  
# File 'lib/bundler/source/rubygems.rb', line 85

def options
  { "remotes" => @remotes.map(&:to_s) }
end

#package_path(cache_path, spec) (protected)

[ GitHub ]

  
# File 'lib/bundler/source/rubygems.rb', line 369

def package_path(cache_path, spec)
  "#{cache_path}/#{spec.file_name}"
end

#remote!

[ GitHub ]

  
# File 'lib/bundler/source/rubygems.rb', line 43

def remote!
  return if @allow_remote

  @specs = nil
  @allow_remote = true
end

#remote_names (protected)

[ GitHub ]

  
# File 'lib/bundler/source/rubygems.rb', line 334

def remote_names
  remotes.map(&:to_s).join(", ")
end

#remote_specs (protected)

[ GitHub ]

  
# File 'lib/bundler/source/rubygems.rb', line 432

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) (protected)

[ GitHub ]

  
# File 'lib/bundler/source/rubygems.rb', line 346

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) (protected)

[ GitHub ]

  
# File 'lib/bundler/source/rubygems.rb', line 392

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

#rubygems_dir (protected)

[ GitHub ]

  
# File 'lib/bundler/source/rubygems.rb', line 510

def rubygems_dir
  Bundler.bundle_path
end

#spec_names

[ GitHub ]

  
# File 'lib/bundler/source/rubygems.rb', line 271

def spec_names
  if @allow_remote && dependency_api_available?
    remote_specs.spec_names
  else
    []
  end
end

#specs

[ GitHub ]

  
# File 'lib/bundler/source/rubygems.rb', line 126

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

#suppress_configured_credentials(remote) (protected)

[ GitHub ]

  
# File 'lib/bundler/source/rubygems.rb', line 383

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

#to_lock

[ GitHub ]

  
# File 'lib/bundler/source/rubygems.rb', line 93

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

[ GitHub ]

  
# File 'lib/bundler/source/rubygems.rb', line 101

def to_s
  if remotes.empty?
    "locally installed gems"
  elsif @allow_remote && @allow_cached && @allow_local
    "rubygems repository #{remote_names}, cached gems or installed locally"
  elsif @allow_remote && @allow_local
    "rubygems repository #{remote_names} or installed locally"
  elsif @allow_remote
    "rubygems repository #{remote_names}"
  elsif @allow_cached && @allow_local
    "cached gems or installed locally"
  else
    "locally installed gems"
  end
end

#unmet_deps

[ GitHub ]

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

def unmet_deps
  if @allow_remote && dependency_api_available?
    remote_specs.unmet_dependency_names
  else
    []
  end
end