Class: Bundler::Source::Rubygems
Relationships & Source Files | |
Namespace Children | |
Classes:
| |
Extension / Inclusion / Inheritance Descendants | |
Subclasses:
|
|
Super Chains via Extension / Inclusion / Inheritance | |
Class Chain:
self,
::Bundler::Source
|
|
Instance Chain:
self,
::Bundler::Source
|
|
Inherits: |
Bundler::Source
|
Defined in: | lib/bundler/source/rubygems.rb, lib/bundler/source/rubygems/remote.rb |
Constant Summary
-
API_REQUEST_LIMIT =
Use the API when installing less than X gems
500
-
API_REQUEST_SIZE =
Ask for X gems per API request
50
Class Method Summary
- .from_lock(options)
- .new(options = {}) ⇒ Rubygems constructor
Instance Attribute Summary
- #caches readonly
- #remotes readonly
- #requires_sudo? ⇒ Boolean readonly protected
::Bundler::Source
- Inherited
Instance Method Summary
-
#==(other)
Alias for #eql?.
- #add_remote(source)
- #cache(spec, custom_path = nil)
- #cached!
- #cached_built_in_gem(spec)
- #can_lock?(spec) ⇒ Boolean
- #dependency_names_to_double_check
- #double_check_for(unmet_dependency_names)
- #eql?(other) ⇒ Boolean (also: #==)
- #equivalent_remotes?(other_remotes) ⇒ Boolean
- #fetchers
- #hash
- #include?(o) ⇒ Boolean
- #install(spec, opts = {})
-
#name
Alias for #to_s.
- #options
- #remote!
- #replace_remotes(other_remotes, allow_equivalent = false)
- #specs
- #to_lock
- #to_s (also: #name)
- #unmet_deps
- #api_fetchers protected
- #builtin_gem?(spec) ⇒ Boolean protected
- #cache_path protected
- #cached_gem(spec) protected
- #cached_path(spec) protected
- #cached_specs protected
- #credless_remotes protected
- #fetch_gem(spec) protected
- #fetch_names(fetchers, dependency_names, index, override_dupes) protected
- #installed?(spec) ⇒ Boolean protected
- #installed_specs protected
- #loaded_from(spec) protected
- #normalize_uri(uri) protected
- #remote_specs protected
- #remotes_for_spec(spec) protected
- #remove_auth(remote) protected
- #rubygems_dir protected
- #suppress_configured_credentials(remote) protected
-
#cache_globally(spec, local_cache_path)
private
Checks if the requested spec exists in the global cache.
-
#download_cache_path(spec) ⇒ Pathname
private
Returns the global cache path of the calling
Rubygems::Source
object. -
#download_gem(spec, download_path)
private
Checks if the requested spec exists in the global cache.
- #extension_cache_slug(spec) private
::Bundler::Source
- Inherited
#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, #include?, #inspect, #unmet_deps, #version_message, #earlier_version?, #extension_cache_slug, #print_using_message, #version_color |
Constructor Details
.new(options = {}) ⇒ Rubygems
# File 'lib/bundler/source/rubygems.rb', line 17
def initialize( = {}) @options = @remotes = [] @dependency_names = [] @allow_remote = false @allow_cached = false @caches = [cache_path, *Bundler.rubygems.gem_cache] Array( ["remotes"] || []).reverse_each {|r| add_remote(r) } end
Class Method Details
.from_lock(options)
[ GitHub ]# File 'lib/bundler/source/rubygems.rb', line 61
def self.from_lock( ) new( ) end
Instance Attribute Details
#caches (readonly)
[ GitHub ]# File 'lib/bundler/source/rubygems.rb', line 15
attr_reader :remotes, :caches
#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 459
def requires_sudo? Bundler.requires_sudo? end
Instance Method Details
#==(other)
Alias for #eql?.
# File 'lib/bundler/source/rubygems.rb', line 46
alias_method :==, :eql?
#add_remote(source)
[ GitHub ]# File 'lib/bundler/source/rubygems.rb', line 225
def add_remote(source) uri = normalize_uri(source) @remotes.unshift(uri) unless @remotes.include?(uri) end
#api_fetchers (protected)
[ GitHub ]
#builtin_gem?(spec) ⇒ Boolean
(protected)
# File 'lib/bundler/source/rubygems.rb', line 447
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(spec, custom_path = nil)
[ GitHub ]# File 'lib/bundler/source/rubygems.rb', line 197
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. end
#cache_globally(spec, local_cache_path) (private)
Checks if the requested spec exists in the global cache. If it does not, we create the relevant global cache subdirectory if it does not exist and copy the spec from the local cache to the global cache.
# File 'lib/bundler/source/rubygems.rb', line 510
def cache_globally(spec, local_cache_path) return unless cache_path = download_cache_path(spec) return if cache_path.exist? SharedHelpers.filesystem_access(cache_path.dirname, &:mkpath) SharedHelpers.filesystem_access(cache_path) do FileUtils.cp(local_cache_path, cache_path) end end
#cache_path (protected)
[ GitHub ]#cached!
[ GitHub ]# File 'lib/bundler/source/rubygems.rb', line 33
def cached! @specs = nil @allow_cached = true end
#cached_built_in_gem(spec)
[ GitHub ]# File 'lib/bundler/source/rubygems.rb', line 212
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 314
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) (protected)
[ GitHub ]# File 'lib/bundler/source/rubygems.rb', line 322
def cached_path(spec) possibilities = @caches.map {|p| "#{p}/#{spec.file_name}" } possibilities.find {|p| File.exist?(p) } end
#cached_specs (protected)
[ GitHub ]# File 'lib/bundler/source/rubygems.rb', line 368
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 idx end end
#can_lock?(spec) ⇒ Boolean
# File 'lib/bundler/source/rubygems.rb', line 52
def can_lock?(spec) return super if Bundler.feature_flag.disable_multisource? spec.source.is_a?(Rubygems) end
#credless_remotes (protected)
[ GitHub ]# File 'lib/bundler/source/rubygems.rb', line 299
def credless_remotes remotes.map(&method(:suppress_configured_credentials)) end
#dependency_names_to_double_check
[ GitHub ]# File 'lib/bundler/source/rubygems.rb', line 281
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) when RemoteSpecification # from the full index return nil else raise "unhandled spec type (#{spec.inspect})" end end names.map!(&:name) if names names end
#double_check_for(unmet_dependency_names)
[ GitHub ]# File 'lib/bundler/source/rubygems.rb', line 262
def double_check_for(unmet_dependency_names) return unless @allow_remote return unless api_fetchers.any? 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.
# File 'lib/bundler/source/rubygems.rb', line 531
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, spec.file_name) end
#download_gem(spec, download_path) (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.
# File 'lib/bundler/source/rubygems.rb', line 482
def download_gem(spec, download_path) local_path = File.join(download_path, "cache/#{spec.full_name}.gem") if (cache_path = download_cache_path(spec)) && cache_path.file? SharedHelpers.filesystem_access(local_path) do FileUtils.cp(cache_path, local_path) end else uri = spec.remote.uri Bundler.ui.confirm("Fetching #{ (spec)}") rubygems_local_path = Bundler.rubygems.download_gem(spec, uri, download_path) if rubygems_local_path != local_path FileUtils.mv(rubygems_local_path, local_path) end cache_globally(spec, local_path) end end
#eql?(other) ⇒ Boolean
Also known as: #==
# File 'lib/bundler/source/rubygems.rb', line 42
def eql?(other) other.is_a?(Rubygems) && other.credless_remotes == credless_remotes end
#equivalent_remotes?(other_remotes) ⇒ Boolean
# File 'lib/bundler/source/rubygems.rb', line 230
def equivalent_remotes?(other_remotes) other_remotes.map(&method(:remove_auth)) == @remotes.map(&method(:remove_auth)) end
#extension_cache_slug(spec) (private)
[ GitHub ]# File 'lib/bundler/source/rubygems.rb', line 539
def extension_cache_slug(spec) return unless remote = spec.remote remote.cache_slug end
#fetch_gem(spec) (protected)
[ GitHub ]# File 'lib/bundler/source/rubygems.rb', line 422
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) (protected)
[ GitHub ]# File 'lib/bundler/source/rubygems.rb', line 409
def fetch_names(fetchers, dependency_names, index, override_dupes) fetchers.each do |f| if dependency_names Bundler.ui.info "Fetching gem metadata from #{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 #{f.uri}" index.use f.specs_with_retry(nil, self), override_dupes end end end
#fetchers
[ GitHub ]#hash
[ GitHub ]# File 'lib/bundler/source/rubygems.rb', line 38
def hash @remotes.hash end
#include?(o) ⇒ Boolean
# File 'lib/bundler/source/rubygems.rb', line 48
def include?(o) o.is_a?(Rubygems) && (o.credless_remotes - credless_remotes).empty? end
#install(spec, opts = {})
[ GitHub ]# File 'lib/bundler/source/rubygems.rb', line 95
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 "Using #{ (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] = "Installing #{ (spec)}" += " with native extensions" if spec.extensions.any? Bundler.ui.confirm 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") 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, :bundler_extension_cache_path => extension_cache_path(spec) ).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. ensure Bundler.rm_rf(install_path) if requires_sudo? end
#installed?(spec) ⇒ Boolean
(protected)
# File 'lib/bundler/source/rubygems.rb', line 455
def installed?(spec) installed_specs[spec].any? end
#installed_specs (protected)
[ GitHub ]# File 'lib/bundler/source/rubygems.rb', line 354
def installed_specs @installed_specs ||= Index.build do |idx| Bundler.rubygems.all_specs.reverse_each do |spec| next if spec.name == "bundler" 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) (protected)
[ GitHub ]# File 'lib/bundler/source/rubygems.rb', line 310
def loaded_from(spec) "#{rubygems_dir}/specifications/#{spec.full_name}.gemspec" end
#name
Alias for #to_s.
# File 'lib/bundler/source/rubygems.rb', line 81
alias_method :name, :to_s
#normalize_uri(uri) (protected)
# File 'lib/bundler/source/rubygems.rb', line 327
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 57
def { "remotes" => @remotes.map(&:to_s) } end
#remote!
[ GitHub ]# File 'lib/bundler/source/rubygems.rb', line 28
def remote! @specs = nil @allow_remote = true end
#remote_specs (protected)
[ GitHub ]# File 'lib/bundler/source/rubygems.rb', line 391
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 ]#remove_auth(remote) (protected)
[ GitHub ]#replace_remotes(other_remotes, allow_equivalent = false)
[ GitHub ]# File 'lib/bundler/source/rubygems.rb', line 234
def replace_remotes(other_remotes, allow_equivalent = false) return false if other_remotes == @remotes equivalent = allow_equivalent && equivalent_remotes?(other_remotes) @remotes = [] other_remotes.reverse_each do |r| add_remote r.to_s end !equivalent end
#rubygems_dir (protected)
[ GitHub ]#specs
[ GitHub ]# File 'lib/bundler/source/rubygems.rb', line 83
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
#suppress_configured_credentials(remote) (protected)
[ GitHub ]# File 'lib/bundler/source/rubygems.rb', line 337
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 65
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 Also known as: #name
[ GitHub ]#unmet_deps
[ GitHub ]# File 'lib/bundler/source/rubygems.rb', line 247
def unmet_deps if @allow_remote && api_fetchers.any? remote_specs.unmet_dependency_names else [] end end