class Bundler::Source::Rubygems - bundler-1.15.4 Documentation

# 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 58
    def self.from_lock(options)
      new(options)
    end

new(options = {}) click to toggle source

    # File lib/bundler/source/rubygems.rb, line 16
    def initialize(options = {})
      @options = options
      @remotes = []
      @dependency_names = []
      @allow_remote = false
      @allow_cached = false
      @caches = [cache_path, *Bundler.rubygems.gem_cache]

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

### Public Instance Methods

==(other)
Alias for: eql?
add_remote(source) click to toggle source

    # File lib/bundler/source/rubygems.rb, line 209
    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 181
    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 32
    def cached!
      @allow_cached = true
    end

cached_built_in_gem(spec) click to toggle source

    # File lib/bundler/source/rubygems.rb, line 196
    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 lib/bundler/source/rubygems.rb, line 50
    def can_lock?(spec)
      spec.source.is_a?(Rubygems)
    end

eql?(other) click to toggle source

    # File lib/bundler/source/rubygems.rb, line 40
    def eql?(other)
      other.is_a?(Rubygems) && other.credless_remotes == credless_remotes
    end

Also aliased as: ==
fetchers() click to toggle source

    # File lib/bundler/source/rubygems.rb, line 231
    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 lib/bundler/source/rubygems.rb, line 36
    def hash
      @remotes.hash
    end

include?(o) click to toggle source

    # File lib/bundler/source/rubygems.rb, line 46
    def include?(o)
      o.is_a?(Rubygems) && (o.credless_remotes - credless_remotes).empty?
    end

install(spec, opts = {}) click to toggle source

    # File lib/bundler/source/rubygems.rb, line 88
    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) && (!force || spec.name.eql?("bundler"))
        Bundler.ui.info "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

        s = Bundler.rubygems.spec_from_gem(fetch_gem(spec), Bundler.settings["trust-policy"])
        spec.__swap__(s)
      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

        installed_spec = nil
        Bundler.rubygems.preserve_paths do
          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
          ).install
        end
        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

name()
Alias for: to_s
options() click to toggle source

    # File lib/bundler/source/rubygems.rb, line 54
    def options
      { "remotes" => @remotes.map(&:to_s) }
    end

remote!() click to toggle source

    # File lib/bundler/source/rubygems.rb, line 27
    def remote!
      @specs = nil
      @allow_remote = true
    end

replace_remotes(other_remotes) click to toggle source

    # File lib/bundler/source/rubygems.rb, line 214
    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 76
    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 62
    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 lib/bundler/source/rubygems.rb, line 70
    def to_s
      remote_names = remotes.map(&: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 223
    def unmet_deps
      if @allow_remote && api_fetchers.any?
        remote_specs.unmet_dependency_names
      else
        []
      end
    end

### Protected Instance Methods

api_fetchers() click to toggle source

    # File lib/bundler/source/rubygems.rb, line 341
    def api_fetchers
      fetchers.select {|f| f.use_api && f.fetchers.first.api_fetcher? }
    end

builtin_gem?(spec) click to toggle source

    # File lib/bundler/source/rubygems.rb, line 436
    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 lib/bundler/source/rubygems.rb, line 456
    def cache_path
      Bundler.app_cache
    end

cached_gem(spec) click to toggle source

    # File lib/bundler/source/rubygems.rb, line 255
    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 263
    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 322
    def cached_specs
      @cached_specs ||= begin
        idx = installed_specs.dup

        Dir["#{cache_path}/*.gem"].each do |gemfile|
          next if gemfile =~ /^bundler\-[\d\.]+?\.gem/
          s ||= Bundler.rubygems.spec_from_gem(gemfile)
          s.source = self
          if Bundler.rubygems.spec_missing_extensions?(s, false)
            Bundler.ui.debug "Source #{self} is ignoring #{s} because it is missing extensions"
            next
          end
          idx << s
        end
      end

      idx
    end

credless_remotes() click to toggle source

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

fetch_gem(spec) click to toggle source

    # File lib/bundler/source/rubygems.rb, line 410
    def fetch_gem(spec)
      return false unless spec.remote
      uri = spec.remote.uri
      spec.fetch_platform
      Bundler.ui.confirm("Fetching #{version_message(spec)}")

      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
      Bundler.rubygems.download_gem(spec, uri, 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

installed?(spec) click to toggle source

    # File lib/bundler/source/rubygems.rb, line 444
    def installed?(spec)
      installed_specs[spec].any?
    end

installed_specs() click to toggle source

    # File lib/bundler/source/rubygems.rb, line 286
    def installed_specs
      @installed_specs ||= begin
        idx = Index.new
        have_bundler = false
        Bundler.rubygems.all_specs.reverse_each do |spec|
          if spec.name == "bundler"
            next unless spec.version.to_s == VERSION
            have_bundler = true
          end
          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

        # 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 251
    def loaded_from(spec)
      "#{rubygems_dir}/specifications/#{spec.full_name}.gemspec"
    end

normalize_uri(uri) click to toggle source

    # File lib/bundler/source/rubygems.rb, line 268
    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. For example:\n"            "source 'https://rubygems.org'" if !uri.absolute? || (uri.is_a?(URI::HTTP) && uri.host.nil?)
      uri
    end

remote_specs() click to toggle source

    # File lib/bundler/source/rubygems.rb, line 345
    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_with_retry(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 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_with_retry(dependency_names, self)
            Bundler.ui.info "" unless 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.
          loop do
            idxcount = idx.size
            api_fetchers.each do |f|
              Bundler.ui.info "Fetching version metadata from #{f.uri}", Bundler.ui.debug?
              idx.use f.specs_with_retry(idx.dependency_names, self), true
              Bundler.ui.info "" unless Bundler.ui.debug? # new line now that the dots are over
            end
            break if idxcount == idx.size
          end

          if api_fetchers.any?
            # 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_with_retry(unmet, self)
              Bundler.ui.info "" unless Bundler.ui.debug? # new line now that the dots are over
            end if unmet.any?
          else
            allow_api = false
          end
        end

        unless allow_api
          api_fetchers.each do |f|
            Bundler.ui.info "Fetching source index from #{f.uri}"
            idx.use f.specs_with_retry(nil, self)
          end
        end
      end
    end

remotes_for_spec(spec) click to toggle source

    # File lib/bundler/source/rubygems.rb, line 244
    def remotes_for_spec(spec)
      specs.search_all(spec.name).inject([]) do |uris, s|
        uris << s.remote if s.remote
        uris
      end
    end

requires_sudo?() click to toggle source

    # File lib/bundler/source/rubygems.rb, line 448
    def requires_sudo?
      Bundler.requires_sudo?
    end

rubygems_dir() click to toggle source

    # File lib/bundler/source/rubygems.rb, line 452
    def rubygems_dir
      Bundler.rubygems.gem_dir
    end

suppress_configured_credentials(remote) click to toggle source

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