class 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 lib/bundler/source/rubygems.rb, line 56
def self.from_lock(options)
  new(options)
end
new(options = {}) click to toggle source
# File lib/bundler/source/rubygems.rb, line 15
def initialize(options = {})
  @options = options
  @remotes = []
  @dependency_names = []
  @allow_remote = false
  @allow_cached = false
  @caches = [Bundler.app_cache, *Bundler.rubygems.gem_cache]

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

Public Instance Methods

==(o)
Alias for: eql?
add_remote(source) click to toggle source
# File lib/bundler/source/rubygems.rb, line 175
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 lib/bundler/source/rubygems.rb, line 151
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 lib/bundler/source/rubygems.rb, line 30
def cached!
  @allow_cached = true
end
cached_built_in_gem(spec) click to toggle source
# File lib/bundler/source/rubygems.rb, line 166
def cached_built_in_gem(spec)
  cached_path = cached_path(spec)
  if cached_path.nil?
    remote_spec = remote_specs.search(spec).first
    cached_path = fetch_gem(remote_spec)
  end
  cached_path
end
can_lock?(spec) click to toggle source
# File lib/bundler/source/rubygems.rb, line 48
def can_lock?(spec)
  spec.source.is_a?(Rubygems)
end
eql?(o) click to toggle source
# File lib/bundler/source/rubygems.rb, line 38
def eql?(o)
  o.is_a?(Rubygems) && o.credless_remotes == credless_remotes
end
Also aliased as: ==
fetchers() click to toggle source
# File lib/bundler/source/rubygems.rb, line 197
def fetchers
  @fetchers ||= remotes.map do |uri|
      Bundler::Fetcher.new(uri)
  end
end
hash() click to toggle source
# File lib/bundler/source/rubygems.rb, line 34
def hash
  @remotes.hash
end
include?(o) click to toggle source
# File lib/bundler/source/rubygems.rb, line 44
def include?(o)
  o.is_a?(Rubygems) && (o.credless_remotes - credless_remotes).empty?
end
install(spec) click to toggle source
# File lib/bundler/source/rubygems.rb, line 86
def install(spec)
  return ["Using #{version_message(spec)}", nil] if installed_specs[spec].any?

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

    s = Bundler.rubygems.spec_from_gem(fetch_gem(spec), Bundler.settings["trust-policy"])
    spec.__swap__(s)
  end

  unless Bundler.settings[:no_install]
    path = cached_gem(spec)
    if Bundler.requires_sudo?
      install_path = Bundler.tmp(spec.full_name)
      bin_path     = install_path.join("bin")
    else
      install_path = Bundler.rubygems.gem_dir
      bin_path     = Bundler.system_bindir
    end

    installed_spec = nil
    Bundler.rubygems.preserve_paths do
      installed_spec = Bundler::GemInstaller.new(path,
        :install_dir         => install_path.to_s,
        :bin_dir             => bin_path.to_s,
        :ignore_dependencies => true,
        :wrappers            => true,
        :env_shebang         => true
      ).install
    end

    # SUDO HAX
    if Bundler.requires_sudo?
      Bundler.rubygems.repository_subdirectories.each do |name|
        src = File.join(install_path, name, "*")
        dst = File.join(Bundler.rubygems.gem_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
        Bundler.mkdir_p dst
        Bundler.sudo "cp -R #{src} #{dst}" if Dir[src].any?
      end

      spec.executables.each do |exe|
        Bundler.mkdir_p Bundler.system_bindir
        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)
  ["Installing #{version_message(spec)}", spec.post_install_message]
ensure
  Bundler.rm_rf(install_path) if Bundler.requires_sudo?
end
name()
Alias for: to_s
options() click to toggle source
# File lib/bundler/source/rubygems.rb, line 52
def options
  { "remotes" => @remotes.map { |r| r.to_s } }
end
remote!() click to toggle source
# File lib/bundler/source/rubygems.rb, line 26
def remote!
  @allow_remote = true
end
replace_remotes(other_remotes) click to toggle source
# File lib/bundler/source/rubygems.rb, line 180
def replace_remotes(other_remotes)
  return false if other_remotes == @remotes

  @remotes = []
  other_remotes.reverse_each do |r|
    add_remote r.to_s
  end
end
specs() click to toggle source
# File lib/bundler/source/rubygems.rb, line 74
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)
    idx
  end
end
to_lock() click to toggle source
# File lib/bundler/source/rubygems.rb, line 60
def to_lock
  out = "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 lib/bundler/source/rubygems.rb, line 68
def to_s
  remote_names = self.remotes.map { |r| r.to_s }.join(', ')
  "rubygems repository #{remote_names}"
end
Also aliased as: name
unmet_deps() click to toggle source
# File lib/bundler/source/rubygems.rb, line 189
def unmet_deps
  if @allow_remote && api_fetchers.any?
    remote_specs.unmet_dependency_names
  else
    []
  end
end

Protected Instance Methods

credless_remotes() click to toggle source
# File lib/bundler/source/rubygems.rb, line 205
def credless_remotes
  remotes.map(&method(:suppress_configured_credentials))
end

Private Instance Methods

api_fetchers() click to toggle source
# File lib/bundler/source/rubygems.rb, line 298
def api_fetchers
  fetchers.select{|f| f.use_api }
end
builtin_gem?(spec) click to toggle source
# File lib/bundler/source/rubygems.rb, line 371
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
cached_gem(spec) click to toggle source
# File lib/bundler/source/rubygems.rb, line 222
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 lib/bundler/source/rubygems.rb, line 230
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 lib/bundler/source/rubygems.rb, line 282
def cached_specs
  @cached_specs ||= begin
    idx = installed_specs.dup

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

  idx
end
fetch_gem(spec) click to toggle source
# File lib/bundler/source/rubygems.rb, line 366
def fetch_gem(spec)
  return false unless spec.source_uri
  Fetcher.download_gem_from_uri(spec, spec.source_uri.original_uri)
end
installed_specs() click to toggle source
# File lib/bundler/source/rubygems.rb, line 252
def installed_specs
  @installed_specs ||= begin
    idx = Index.new
    have_bundler = false
    Bundler.rubygems.all_specs.reverse.each do |spec|
      next if spec.name == 'bundler' && spec.version.to_s != VERSION
      have_bundler = true if spec.name == 'bundler'
      spec.source = self
      idx << spec
    end

    # Always have bundler locally
    unless have_bundler
     # We're running bundler directly from the source
     # so, let's create a fake gemspec for it (it's a path)
     # gemspec
     bundler = Gem::Specification.new do |s|
       s.name     = 'bundler'
       s.version  = VERSION
       s.platform = Gem::Platform::RUBY
       s.source   = self
       s.authors  = ["bundler team"]
       s.loaded_from = File.expand_path("..", __FILE__)
     end
     idx << bundler
    end
    idx
  end
end
loaded_from(spec) click to toggle source
# File lib/bundler/source/rubygems.rb, line 218
def loaded_from(spec)
  "#{Bundler.rubygems.gem_dir}/specifications/#{spec.full_name}.gemspec"
end
normalize_uri(uri) click to toggle source
# File lib/bundler/source/rubygems.rb, line 235
def normalize_uri(uri)
  uri = uri.to_s
  uri = "#{uri}/" unless uri =~ %r'/$'
  uri = URI(uri)
  raise ArgumentError, "The source must be an absolute URI" unless uri.absolute?
  uri
end
remote_specs() click to toggle source
# File lib/bundler/source/rubygems.rb, line 302
def remote_specs
  @remote_specs ||= Index.build do |idx|
    index_fetchers = fetchers - api_fetchers

    # gather lists from non-api sites
    index_fetchers.each do |f|
      Bundler.ui.info "Fetching source index from #{f.uri}"
      idx.use f.specs(nil, self)
    end

    # 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 100 gems, we just 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

    if allow_api
      api_fetchers.each do |f|
        Bundler.ui.info "Fetching gem metadata from #{f.uri}", Bundler.ui.debug?
        idx.use f.specs(dependency_names, self)
        Bundler.ui.info "" if !Bundler.ui.debug? # new line now that the dots are over
      end

      # Suppose the gem Foo depends on the gem Bar.  Foo exists in Source A.  Bar has some versions that exist in both
      # sources A and B.  At this point, the API request will have found all the versions of Bar in source A,
      # but will not have found any versions of Bar from source B, which is a problem if the requested version
      # of Foo specifically depends on a version of Bar that is only found in source B. This ensures that for
      # each spec we found, we add all possible versions from all sources to the index.
      begin
        idxcount = idx.size
        api_fetchers.each do |f|
          Bundler.ui.info "Fetching version metadata from #{f.uri}", Bundler.ui.debug?
          idx.use f.specs(idx.dependency_names, self), true
          Bundler.ui.info "" if !Bundler.ui.debug? # new line now that the dots are over
        end
      end until idxcount == idx.size

      if api_fetchers.any? && api_fetchers.all?{|f| f.use_api }
        # 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.
        unmet = idx.unmet_dependency_names

        # if there are any cross-site gems we missed, get them now
        api_fetchers.each do |f|
          Bundler.ui.info "Fetching dependency metadata from #{f.uri}", Bundler.ui.debug?
          idx.use f.specs(unmet, self)
          Bundler.ui.info "" if !Bundler.ui.debug? # new line now that the dots are over
        end if unmet.any?
      else
        allow_api = false
      end
    end

    if !allow_api
      api_fetchers.each do |f|
        Bundler.ui.info "Fetching source index from #{f.uri}"
        idx.use f.specs(nil, self)
      end
    end
  end
end
source_uris_for_spec(spec) click to toggle source
# File lib/bundler/source/rubygems.rb, line 211
def source_uris_for_spec(spec)
  specs.search_all(spec.name).inject([]) do |uris, s|
    uris << s.source_uri.without_credentials if s.source_uri
    uris
  end
end
suppress_configured_credentials(remote) click to toggle source
# File lib/bundler/source/rubygems.rb, line 243
def suppress_configured_credentials(remote)
  remote_nouser = remote.dup.tap { |uri| uri.user = uri.password = nil }.to_s
  if remote.userinfo && remote.userinfo == Bundler.settings[remote_nouser]
    remote_nouser
  else
    remote
  end
end