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_SIZE =
# File 'lib/bundler/source/rubygems.rb', line 11
Ask for X gems per API request
100 -
REQUIRE_MUTEX =
# File 'lib/bundler/source/rubygems.rb', line 12Mutex.new
Class Method Summary
- .from_lock(options)
- .new(options = {}) ⇒ Rubygems constructor
Instance Attribute Summary
- #dependency_api_available? ⇒ Boolean readonly
- #local_only? ⇒ Boolean readonly
- #multiple_remotes? ⇒ Boolean readonly
- #no_remotes? ⇒ Boolean readonly
- #remotes rw
::Bundler::Source - Inherited
Instance Method Summary
-
#==(other)
Alias for #eql?.
- #add_remote(source)
- #cache(spec, custom_path = nil)
- #cached!
- #cached_built_in_gem(spec, local: false)
- #caches
- #can_lock?(spec) ⇒ Boolean
- #dependency_names_to_double_check
- #double_check_for(unmet_dependency_names)
- #download(spec, options = {})
- #eql?(other) ⇒ Boolean (also: #==)
- #fetchers
- #hash
- #identifier (also: #name, #to_gemfile)
- #include?(o) ⇒ Boolean
- #install(spec, options = {})
- #local!
- #local_only!
-
#name
Alias for #identifier.
- #options
- #prefer_local!
- #remote!
- #remote_fetchers
- #spec_names
- #specs
-
#to_gemfile
Alias for #identifier.
- #to_lock
- #to_s
- #unmet_deps
- #api_fetchers protected
- #cache_path protected
- #cached_gem(spec) protected
- #cached_specs protected
- #credless_remotes protected
- #default_cache_path_for(dir) protected
- #default_specs protected
- #fetch_gem(spec, previous_spec = nil) protected
- #fetch_gem_if_possible(spec, previous_spec = nil) protected
- #fetch_names(fetchers, dependency_names, index) protected
- #installed?(spec) ⇒ Boolean protected
- #installed_specs protected
- #normalize_uri(uri) protected
- #package_path(cache_path, spec) protected
- #remote_names protected
- #remote_specs protected
- #remove_auth(remote) protected
- #rubygems_dir protected
-
#download_cache_path(spec) ⇒ Pathname
private
Returns the global cache path of the calling
Rubygems::Sourceobject. -
#download_gem(spec, download_cache_path, previous_spec = nil)
private
Checks if the requested spec exists in the global cache.
- #extension_cache_slug(spec) private
- #lockfile_remotes private
-
#rubygems_gem_installer(spec, options)
private
We are using a mutex to reaed and write from/to the hash.
::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. |
| #download, #extension_cache_path, #identifier, #include?, #inspect, #local!, #local_only!, #prefer_local!, #remote!, #spec_names, #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 16
def initialize( = {}) @options = @remotes = [] @dependency_names = [] @allow_remote = false @allow_cached = false @allow_local = ["allow_local"] || false @prefer_local = false @checksum_store = Checksum::Store.new @gem_installers = {} @gem_installers_mutex = Mutex.new Array(["remotes"]).reverse_each {|r| add_remote(r) } @lockfile_remotes = @remotes if ["from_lockfile"] end
Class Method Details
.from_lock(options)
[ GitHub ]# File 'lib/bundler/source/rubygems.rb', line 106
def self.from_lock() ["remotes"] = Array(.delete("remote")).reverse new(.merge("from_lockfile" => true)) end
Instance Attribute Details
#dependency_api_available? ⇒ Boolean (readonly)
[ GitHub ]
# File 'lib/bundler/source/rubygems.rb', line 313
def dependency_api_available? @allow_remote && api_fetchers.any? end
#local_only? ⇒ Boolean (readonly)
[ GitHub ]
# File 'lib/bundler/source/rubygems.rb', line 48
def local_only? @allow_local && !@allow_remote end
#multiple_remotes? ⇒ Boolean (readonly)
[ GitHub ]
# File 'lib/bundler/source/rubygems.rb', line 89
def multiple_remotes? @remotes.size > 1 end
#no_remotes? ⇒ Boolean (readonly)
[ GitHub ]
# File 'lib/bundler/source/rubygems.rb', line 93
def no_remotes? @remotes.size == 0 end
#remotes (rw)
[ GitHub ]# File 'lib/bundler/source/rubygems.rb', line 14
attr_accessor :remotes
Instance Method Details
#==(other)
Alias for #eql?.
# File 'lib/bundler/source/rubygems.rb', line 83
alias_method :==, :eql?
#add_remote(source)
[ GitHub ]# File 'lib/bundler/source/rubygems.rb', line 246
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 389
def api_fetchers fetchers.select(&:api_fetcher?) end
#cache(spec, custom_path = nil)
[ GitHub ]# File 'lib/bundler/source/rubygems.rb', line 221
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. end
#cache_path (protected)
[ GitHub ]#cached!
[ GitHub ]# File 'lib/bundler/source/rubygems.rb', line 66
def cached! return unless File.exist?(cache_path) return if @allow_cached @specs = nil @allow_cached = true end
#cached_built_in_gem(spec, local: false)
[ GitHub ]# File 'lib/bundler/source/rubygems.rb', line 232
def cached_built_in_gem(spec, local: false) cached_path = cached_gem(spec) if cached_path.nil? && !local remote_spec = remote_specs.search(spec).first 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
#cached_gem(spec) (protected)
[ GitHub ]# File 'lib/bundler/source/rubygems.rb', line 327
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
#cached_specs (protected)
[ GitHub ]#caches
[ GitHub ]# File 'lib/bundler/source/rubygems.rb', line 33
def caches @caches ||= [cache_path, *Bundler.rubygems.gem_cache] end
#can_lock?(spec) ⇒ Boolean
# File 'lib/bundler/source/rubygems.rb', line 97
def can_lock?(spec) return super unless multiple_remotes? include?(spec.source) end
#credless_remotes (protected)
[ GitHub ]# File 'lib/bundler/source/rubygems.rb', line 323
def credless_remotes remotes.map(&method(:remove_auth)) end
#default_cache_path_for(dir) (protected)
[ GitHub ]# File 'lib/bundler/source/rubygems.rb', line 449
def default_cache_path_for(dir) "#{dir}/cache" end
#default_specs (protected)
[ GitHub ]#dependency_names_to_double_check
[ GitHub ]# File 'lib/bundler/source/rubygems.rb', line 298
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 278
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
#download(spec, options = {})
[ GitHub ]# File 'lib/bundler/source/rubygems.rb', line 168
def download(spec, = {}) if (spec.default_gem? && !cached_built_in_gem(spec, local: [:local])) || (installed?(spec) && ![:force]) return true end installer = rubygems_gem_installer(spec, ) 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.}" end spec.__swap__(s) end spec 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 496
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
#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.
# File 'lib/bundler/source/rubygems.rb', line 475
def download_gem(spec, download_cache_path, previous_spec = nil) uri = spec.remote.uri Bundler.ui.confirm("Fetching #{(spec, previous_spec)}") gem_remote_fetcher = remote_fetchers.fetch(spec.remote).gem_remote_fetcher Gem.time("Downloaded #{spec.name} in", 0, true) do Bundler.rubygems.download_gem(spec, uri, download_cache_path, gem_remote_fetcher) end end
#eql?(other) ⇒ Boolean
Also known as: #==
# File 'lib/bundler/source/rubygems.rb', line 79
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 509
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 426
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
#fetch_gem_if_possible(spec, previous_spec = nil) (protected)
[ GitHub ]# File 'lib/bundler/source/rubygems.rb', line 418
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) (protected)
[ GitHub ]# File 'lib/bundler/source/rubygems.rb', line 405
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
#fetchers
[ GitHub ]# File 'lib/bundler/source/rubygems.rb', line 274
def fetchers @fetchers ||= remote_fetchers.values.freeze end
#hash
[ GitHub ]# File 'lib/bundler/source/rubygems.rb', line 75
def hash @remotes.hash end
#identifier Also known as: #name, #to_gemfile
[ GitHub ]# File 'lib/bundler/source/rubygems.rb', line 135
def identifier if remotes.empty? "locally installed gems" else "rubygems repository #{remote_names}" end end
#include?(o) ⇒ Boolean
# File 'lib/bundler/source/rubygems.rb', line 85
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 193
def install(spec, = {}) if (spec.default_gem? && !cached_built_in_gem(spec, local: [:local])) || (installed?(spec) && ![:force]) "Using #{(spec, [:previous_spec])}" return nil # no post-install message end return if Bundler.settings[:no_install] installer = rubygems_gem_installer(spec, ) spec.source.checksum_store.register(spec, installer.gem_checksum) = "Installing #{(spec, [:previous_spec])}" += " with native extensions" if spec.extensions.any? Bundler.ui.confirm 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. end
#installed?(spec) ⇒ Boolean (protected)
# File 'lib/bundler/source/rubygems.rb', line 441
def installed?(spec) installed_specs[spec].any? && !spec.installation_missing? end
#installed_specs (protected)
[ GitHub ]#local!
[ GitHub ]# File 'lib/bundler/source/rubygems.rb', line 52
def local! return if @allow_local @specs = nil @allow_local = true end
#local_only!
[ GitHub ]# File 'lib/bundler/source/rubygems.rb', line 41
def local_only! @specs = nil @allow_local = true @allow_cached = false @allow_remote = false end
#lockfile_remotes (private)
[ GitHub ]# File 'lib/bundler/source/rubygems.rb', line 459
def lockfile_remotes @lockfile_remotes || credless_remotes end
#name
Alias for #identifier.
# File 'lib/bundler/source/rubygems.rb', line 142
alias_method :name, :identifier
#normalize_uri(uri) (protected)
# File 'lib/bundler/source/rubygems.rb', line 339
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
#options
[ GitHub ]# File 'lib/bundler/source/rubygems.rb', line 102
def { "remotes" => @remotes.map(&:to_s) } end
#package_path(cache_path, spec) (protected)
[ GitHub ]# File 'lib/bundler/source/rubygems.rb', line 335
def package_path(cache_path, spec) "#{cache_path}/#{spec.file_name}" end
#prefer_local!
[ GitHub ]# File 'lib/bundler/source/rubygems.rb', line 37
def prefer_local! @prefer_local = true end
#remote!
[ GitHub ]# File 'lib/bundler/source/rubygems.rb', line 59
def remote! return if @allow_remote @specs = nil @allow_remote = true end
#remote_fetchers
[ GitHub ]#remote_names (protected)
[ GitHub ]#remote_specs (protected)
[ GitHub ]# File 'lib/bundler/source/rubygems.rb', line 393
def remote_specs @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
#remove_auth(remote) (protected)
[ GitHub ]#rubygems_dir (protected)
[ GitHub ]# File 'lib/bundler/source/rubygems.rb', line 445
def rubygems_dir Bundler.bundle_path end
#rubygems_gem_installer(spec, options) (private)
We are using a mutex to reaed and write from/to the hash. The reason this double synchronization was added is for performance and lock the mutex for the shortest possible amount of time. Otherwise, all threads are fighting over this mutex and when it gets acquired it gets locked until a threads finishes downloading a gem, leaving the other threads waiting doing nothing.
# File 'lib/bundler/source/rubygems.rb', line 520
def rubygems_gem_installer(spec, ) @gem_installers_mutex.synchronize { @gem_installers[spec.name] } || begin path = fetch_gem_if_possible(spec, [: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: [:build_args], bundler_extension_cache_path: extension_cache_path(spec) ) @gem_installers_mutex.synchronize { @gem_installers[spec.name] ||= installer } end end
#spec_names
[ GitHub ]# File 'lib/bundler/source/rubygems.rb', line 251
def spec_names if dependency_api_available? remote_specs.spec_names else [] end end
#specs
[ GitHub ]# File 'lib/bundler/source/rubygems.rb', line 145
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 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 index end end
#to_gemfile
Alias for #identifier.
# File 'lib/bundler/source/rubygems.rb', line 143
alias_method :to_gemfile, :identifier
#to_lock
[ GitHub ]# File 'lib/bundler/source/rubygems.rb', line 111
def to_lock out = String.new("GEM\n") lockfile_remotes.reverse_each do |remote| out << " remote: #{remote}\n" end out << " specs:\n" end
#to_s
[ GitHub ]# File 'lib/bundler/source/rubygems.rb', line 119
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 259
def unmet_deps if dependency_api_available? remote_specs.unmet_dependency_names else [] end end