Class: Bundler::Source::Rubygems

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

def local_only?
  @allow_local && !@allow_remote
end

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

def multiple_remotes?
  @remotes.size > 1
end

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

def no_remotes?
  @remotes.size == 0
end

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

attr_accessor :remotes, :remote_cooldowns

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

attr_accessor :remotes, :remote_cooldowns

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

def add_remote(source, cooldown: nil)
  uri = normalize_uri(source)
  @remotes.unshift(uri) unless @remotes.include?(uri)
  @remote_cooldowns[uri] = cooldown if cooldown
end

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

def api_fetchers
  fetchers.select(&:api_fetcher?)
end

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

def backfill_created_at(index, snapshot)
  index.each do |spec|
    next unless spec.respond_to?(:created_at=)
    next if spec.created_at
    remote_created_at, remote = snapshot[[spec.name, spec.version]]
    next unless remote_created_at
    spec.created_at = remote_created_at
    spec.remote ||= remote if remote && spec.respond_to?(:remote=)
  end
end

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

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

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

def cache_path
  Bundler.app_cache
end

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

def cached!
  return unless File.exist?(cache_path)

  return if @allow_cached

  @specs = nil
  @allow_cached = true
end

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

def cached_built_in_gem(spec, local: false)
  cached_path = cached_gem(spec)
  if cached_path.nil? && !local
    remote_spec = remote_spec_for(spec)
    if remote_spec
      cached_path = fetch_gem(remote_spec)
      spec.remote = remote_spec.remote
    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

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

def cached_gem(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

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

def cached_specs
  @cached_specs ||= begin
    idx = Index.new

    Dir["#{cache_path}/*.gem"].each do |gemfile|
      s ||= Bundler.rubygems.spec_from_gem(gemfile)
      s.source = self
      idx << s
    end

    idx
  end
end

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

def caches
  @caches ||= [cache_path, *Bundler.rubygems.gem_cache]
end

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

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

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

def clear_cache
  @specs = nil
  @installed_specs = nil
  @default_specs = nil
  @cached_specs = nil
end

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

def collect_remote_created_at(index)
  return {} unless @allow_remote

  snapshot = {}
  index.each do |spec|
    next unless spec.respond_to?(:created_at) && spec.created_at
    # Remember the remote that supplied the date too: when a source has
    # several remotes with different per-URI cooldown settings we must
    # restore the same one during backfill so `effective_cooldown` agrees.
    snapshot[[spec.name, spec.version]] = [spec.created_at, spec.remote]
  end
  snapshot
end

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

def cooldown_for(uri)
  @remote_cooldowns[uri]
end

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

def credless_remotes
  remotes.map(&method(:remove_auth))
end

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

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

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

def default_specs
  @default_specs ||= Index.build do |idx|
    Bundler.rubygems.default_specs.each do |spec|
      spec.source = self
      idx << spec
    end
  end
end

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

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

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

def double_check_for(unmet_dependency_names)
  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, remote_specs)

  specs.use remote_specs
end

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

def download(spec, options = {})
  if (spec.default_gem? && !cached_built_in_gem(spec, local: options[:local])) || (installed?(spec) && !options[:force])
    return true
  end

  installer = rubygems_gem_installer(spec, options)

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

    spec.__swap__(s)
  end

  spec
end

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

def download_cache_path(spec)
  return unless Bundler.settings[:global_gem_cache]
  return unless remote = spec.remote
  return unless cache_slug = remote.cache_slug

  if Gem.respond_to?(:global_gem_cache_path)
    Pathname.new(Gem.global_gem_cache_path).join(cache_slug)
  else
    # Fall back to old location for older RubyGems versions
    Bundler.user_cache.join("gems", cache_slug)
  end
end

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

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

  Plugin.hook(Plugin::Events::GEM_BEFORE_FETCH, spec)
  begin
    Gem.time("Downloaded #{spec.name} in", 0, true) do
      Bundler.rubygems.download_gem(spec, uri, download_cache_path, gem_remote_fetcher)
    end
  ensure
    Plugin.hook(Plugin::Events::GEM_AFTER_FETCH, spec)
  end
end

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

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

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

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

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

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)

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

  gem_path
end

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

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

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

def fetch_names(fetchers, dependency_names, index)
  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)
      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)
    end
  end
end

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

def fetchers
  @fetchers ||= remote_fetchers.values.freeze
end

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

def hash
  @remotes.hash
end

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

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

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

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

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

def install(spec, options = {})
  if (spec.default_gem? && !cached_built_in_gem(spec, local: options[:local])) || (installed?(spec) && !options[:force])
    print_using_message "Using #{version_message(spec, options[:previous_spec])}"
    return nil # no post-install message
  end

  return if Bundler.settings[:no_install]

  installer = rubygems_gem_installer(spec, options)
  spec.source.checksum_store.register(spec, installer.gem_checksum)

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

  installed_spec = nil

  Gem.time("Installed #{spec.name} in", 0, true) do
    installed_spec = installer.install
  end

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

  spec.post_install_message
end

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

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

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

def installed_specs
  @installed_specs ||= Index.build do |idx|
    Bundler.rubygems.installed_specs.reverse_each do |spec|
      spec.source = self
      next if spec.ignored?
      idx << spec
    end
  end
end

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

def local!
  return if @allow_local

  @specs = nil
  @allow_local = true
end

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

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

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

def lockfile_remotes
  @lockfile_remotes || credless_remotes
end

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

alias_method :name, :identifier

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

def normalize_uri(uri)
  uri = URINormalizer.normalize_suffix(uri.to_s)
  require_relative "../vendored_uri"
  uri = Gem::URI(uri)
  raise ArgumentError, "The source must be an absolute URI. For example:\n" \
    "source 'https://rubygems.org'" if !uri.absolute? || (uri.is_a?(Gem::URI::HTTP) && uri.host.nil?)
  uri
end

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

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

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

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

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

def prefer_local!
  @prefer_local = true
end

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

def release_resolution_memory!
  @specs = nil
  @remote_specs_mutex.synchronize { @remote_specs = nil }
  @fetchers&.each(&:release_resolution_memory!)
end

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

def remote!
  return if @allow_remote

  @specs = nil
  @allow_remote = true
end

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

def remote_fetchers
  @remote_fetchers ||= remotes.to_h do |uri|
    remote = Source::Rubygems::Remote.new(uri, cooldown: cooldown_for(uri))
    [remote, Bundler::Fetcher.new(remote)]
  end.freeze
end

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

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

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

def remote_spec_for(spec)
  return remote_specs.search(spec).first if @remote_specs || api_fetchers.empty?

  index = Index.build do |idx|
    fetch_names(api_fetchers, [spec.name], idx)
  end
  index.search(spec).first
end

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

def remote_specs
  @remote_specs ||= @remote_specs_mutex.synchronize do
    @remote_specs ||= Index.build do |idx|
      index_fetchers = fetchers - api_fetchers

      if index_fetchers.empty?
        fetch_names(api_fetchers, dependency_names, idx)
      else
        fetch_names(fetchers, nil, idx)
      end
    end
  end
end

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

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

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

def rubygems_dir
  Bundler.bundle_path
end

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

def rubygems_gem_installer(spec, options)
  @gem_installers_mutex.synchronize { @gem_installers[spec.name] } || begin
    path = fetch_gem_if_possible(spec, options[:previous_spec])
    raise GemNotFound, "Could not find #{spec.file_name} for installation" unless path

    REQUIRE_MUTEX.synchronize { require_relative "../rubygems_gem_installer" }

    installer = Bundler::RubyGemsGemInstaller.at(
      path,
      security_policy: Bundler.rubygems.security_policies[Bundler.settings["trust-policy"]],
      install_dir: rubygems_dir.to_s,
      bin_dir: Bundler.system_bindir.to_s,
      ignore_dependencies: true,
      wrappers: true,
      env_shebang: true,
      build_args: options[:build_args],
      bundler_extension_cache_path: extension_cache_path(spec),
      build_extension: Bundler.settings[:no_build_extension] ? false : nil,
      install_plugin: Bundler.settings[:no_install_plugin] ? false : nil
    )
    @gem_installers_mutex.synchronize { @gem_installers[spec.name] ||= installer }
  end
end

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

def spec_names
  if dependency_api_available?
    remote_specs.spec_names
  else
    []
  end
end

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

def specs
  @specs ||= begin
    # remote_specs usually generates a way larger Index than the other
    # sources, and large_idx.merge! small_idx is way faster than
    # small_idx.merge! large_idx.
    index = @allow_remote ? remote_specs.dup : Index.new

    # Snapshot per-version `created_at` from the remote info before installed
    # / cached specs overwrite the EndpointSpecification objects that carry
    # it. The cooldown filter consults `created_at` on every candidate, so
    # local stubs need the published date back-filled to participate.
    remote_created_at = collect_remote_created_at(index)

    index.merge!(cached_specs) if @allow_cached
    index.merge!(installed_specs) if @allow_local

    if @allow_local
      if @prefer_local
        index.merge!(default_specs)
      else
        # complete with default specs, only if not already available in the
        # index through remote, cached, or installed specs
        index.use(default_specs)
      end
    end

    backfill_created_at(index, remote_created_at) unless remote_created_at.empty?

    index
  end
end

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

alias_method :to_gemfile, :identifier

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

def to_lock
  out = String.new("GEM\n")
  lockfile_remotes.reverse_each do |remote|
    out << "  remote: #{remote}\n"
  end
  out << "  specs:\n"
end

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

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

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

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