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 =
Ask for X gems per API request
50
Class Method Summary
- .from_lock(options)
- .new(options = {}) ⇒ Rubygems constructor
Instance Attribute Summary
- #dependency_api_available? ⇒ Boolean readonly
- #multiple_remotes? ⇒ Boolean readonly
- #no_remotes? ⇒ Boolean readonly
- #remotes readonly
::Bundler::Source
- Inherited
Instance Method Summary
-
#==(other)
Alias for #eql?.
- #add_remote(source)
- #cache(spec, custom_path = nil)
- #cached!
- #cached_built_in_gem(spec)
- #caches
- #can_lock?(spec) ⇒ Boolean
- #dependency_names_to_double_check
- #double_check_for(unmet_dependency_names)
- #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
- #remote!
- #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_path(spec) protected
- #cached_specs protected
- #credless_remotes protected
- #default_cache_path_for(dir) protected
- #fetch_gem(spec, previous_spec = nil) protected
- #fetch_gem_if_possible(spec, previous_spec = nil) protected
- #fetch_names(fetchers, dependency_names, index, override_dupes) protected
- #installed?(spec) ⇒ Boolean protected
- #installed_specs protected
- #normalize_uri(uri) protected
- #package_path(cache_path, spec) protected
- #remote_names protected
- #remote_specs protected
- #remotes_for_spec(spec) protected
- #remove_auth(remote) protected
- #rubygems_dir protected
- #suppress_configured_credentials(remote) protected
-
#download_cache_path(spec) ⇒ Pathname
private
Returns the global cache path of the calling
Rubygems::Source
object. -
#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
::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. |
#extension_cache_path, #identifier, #include?, #inspect, #local!, #local_only!, #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 15
def initialize( = {}) @options = @remotes = [] @dependency_names = [] @allow_remote = false @allow_cached = false @allow_local = ["allow_local"] || false Array( ["remotes"]).reverse_each {|r| add_remote(r) } end
Class Method Details
.from_lock(options)
[ GitHub ]# File 'lib/bundler/source/rubygems.rb', line 90
def self.from_lock( ) new( ) end
Instance Attribute Details
#dependency_api_available? ⇒ Boolean
(readonly)
[ GitHub ]
# File 'lib/bundler/source/rubygems.rb', line 296
def dependency_api_available? @allow_remote && api_fetchers.any? end
#multiple_remotes? ⇒ Boolean
(readonly)
[ GitHub ]
# File 'lib/bundler/source/rubygems.rb', line 73
def multiple_remotes? @remotes.size > 1 end
#no_remotes? ⇒ Boolean
(readonly)
[ GitHub ]
# File 'lib/bundler/source/rubygems.rb', line 77
def no_remotes? @remotes.size == 0 end
#remotes (readonly)
[ GitHub ]# File 'lib/bundler/source/rubygems.rb', line 13
attr_reader :remotes
Instance Method Details
#==(other)
Alias for #eql?.
# File 'lib/bundler/source/rubygems.rb', line 67
alias_method :==, :eql?
#add_remote(source)
[ GitHub ]# File 'lib/bundler/source/rubygems.rb', line 234
def add_remote(source) uri = normalize_uri(source) @remotes.unshift(uri) unless @remotes.include?(uri) end
#api_fetchers (protected)
[ GitHub ]#cache(spec, custom_path = nil)
[ GitHub ]# File 'lib/bundler/source/rubygems.rb', line 210
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 51
def cached! return if @allow_cached @specs = nil @allow_local = true @allow_cached = true end
#cached_built_in_gem(spec)
[ GitHub ]# File 'lib/bundler/source/rubygems.rb', line 221
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 321
def cached_gem(spec) if spec.default_gem? cached_built_in_gem(spec) else cached_path(spec) end end
#cached_path(spec) (protected)
[ GitHub ]# File 'lib/bundler/source/rubygems.rb', line 329
def cached_path(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 ]# File 'lib/bundler/source/rubygems.rb', line 380
def cached_specs @cached_specs ||= begin idx = @allow_local ? installed_specs.dup : 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
#caches
[ GitHub ]# File 'lib/bundler/source/rubygems.rb', line 26
def caches @caches ||= [cache_path, *Bundler.rubygems.gem_cache] end
#can_lock?(spec) ⇒ Boolean
# File 'lib/bundler/source/rubygems.rb', line 81
def can_lock?(spec) return super unless multiple_remotes? include?(spec.source) end
#credless_remotes (protected)
[ GitHub ]# File 'lib/bundler/source/rubygems.rb', line 306
def credless_remotes if Bundler.settings[:allow_deployment_source_credential_changes] remotes.map(&method(:remove_auth)) else remotes.map(&method(:suppress_configured_credentials)) end end
#default_cache_path_for(dir) (protected)
[ GitHub ]# File 'lib/bundler/source/rubygems.rb', line 459
def default_cache_path_for(dir) "#{dir}/cache" 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.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 262
def double_check_for(unmet_dependency_names) return unless @allow_remote 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, 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 498
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) 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 481
def download_gem(spec, download_cache_path, previous_spec = nil) uri = spec.remote.uri Bundler.ui.confirm("Fetching #{ (spec, previous_spec)}") Bundler.rubygems.download_gem(spec, uri, download_cache_path) end
#eql?(other) ⇒ Boolean
Also known as: #==
# File 'lib/bundler/source/rubygems.rb', line 63
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 506
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 436
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 428
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, override_dupes) (protected)
[ GitHub ]# File 'lib/bundler/source/rubygems.rb', line 415
def fetch_names(fetchers, dependency_names, index, override_dupes) 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), 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 #{URICredentialsFilter.credential_filtered_uri(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 59
def hash @remotes.hash end
#identifier Also known as: #name, #to_gemfile
[ GitHub ]# File 'lib/bundler/source/rubygems.rb', line 118
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 69
def include?(o) o.is_a?(Rubygems) && (o.credless_remotes - credless_remotes).empty? end
#install(spec, options = {})
# File 'lib/bundler/source/rubygems.rb', line 140
def install(spec, = {}) force = [:force] ensure_builtin_gems_cached = [:ensure_builtin_gems_cached] if ensure_builtin_gems_cached && spec.default_gem? && !cached_path(spec) cached_built_in_gem(spec) unless spec.remote force = true end if installed?(spec) && !force "Using #{ (spec, [:previous_spec])}" return nil # no post-install message end if spec.remote # Check for this spec from other sources uris = [spec.remote, *remotes_for_spec(spec)].map(&:anonymized_uri).uniq Installer.ambiguous_gems << [spec.name, *uris] if uris.length > 1 end path = fetch_gem_if_possible(spec, [:previous_spec]) raise GemNotFound, "Could not find #{spec.file_name} for installation" unless path return if Bundler.settings[:no_install] install_path = rubygems_dir bin_path = Bundler.system_bindir require_relative "../rubygems_gem_installer" installer = Bundler::RubyGemsGemInstaller.at( path, :security_policy => Bundler.rubygems.security_policies[Bundler.settings["trust-policy"]], :install_dir => install_path.to_s, :bin_dir => bin_path.to_s, :ignore_dependencies => true, :wrappers => true, :env_shebang => true, :build_args => [:build_args], :bundler_expected_checksum => spec.respond_to?(:checksum) && spec.checksum, :bundler_extension_cache_path => extension_cache_path(spec) ) if spec.remote s = begin installer.spec rescue Gem::Package::FormatError Bundler.rm_rf(path) raise rescue Gem::Security::Exception => e raise SecurityError, "The gem #{File.basename(path, ".gem")} can't be installed because " \ "the security policy didn't allow it, with the message: #{e.}" end spec.__swap__(s) end = "Installing #{ (spec, [:previous_spec])}" += " with native extensions" if spec.extensions.any? Bundler.ui.confirm installed_spec = installer.install spec.full_gem_path = installed_spec.full_gem_path spec.loaded_from = installed_spec.loaded_from spec. end
#installed?(spec) ⇒ Boolean
(protected)
# File 'lib/bundler/source/rubygems.rb', line 451
def installed?(spec) installed_specs[spec].any? && !spec.deleted_gem? end
#installed_specs (protected)
[ GitHub ]# File 'lib/bundler/source/rubygems.rb', line 367
def installed_specs @installed_specs ||= Index.build do |idx| Bundler.rubygems.all_specs.reverse_each do |spec| 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
#local!
[ GitHub ]# File 'lib/bundler/source/rubygems.rb', line 37
def local! return if @allow_local @specs = nil @allow_local = true end
#local_only!
[ GitHub ]# File 'lib/bundler/source/rubygems.rb', line 30
def local_only! @specs = nil @allow_local = true @allow_cached = false @allow_remote = false end
#name
Alias for #identifier.
# File 'lib/bundler/source/rubygems.rb', line 125
alias_method :name, :identifier
#normalize_uri(uri) (protected)
# File 'lib/bundler/source/rubygems.rb', line 341
def normalize_uri(uri) uri = URINormalizer.normalize_suffix(uri.to_s) 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 86
def { "remotes" => @remotes.map(&:to_s) } end
#package_path(cache_path, spec) (protected)
[ GitHub ]# File 'lib/bundler/source/rubygems.rb', line 337
def package_path(cache_path, spec) "#{cache_path}/#{spec.file_name}" end
#remote!
[ GitHub ]# File 'lib/bundler/source/rubygems.rb', line 44
def remote! return if @allow_remote @specs = nil @allow_remote = true end
#remote_names (protected)
[ GitHub ]#remote_specs (protected)
[ GitHub ]# File 'lib/bundler/source/rubygems.rb', line 398
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) # legacy multi-remote sources need special logic to figure out # dependency names and that logic can be very costly if one remote # uses the dependency API but others don't. So use full indexes # consistently in that particular case. allow_api = !multiple_remotes? fetch_names(api_fetchers, allow_api && dependency_names, idx, false) end end
#remotes_for_spec(spec) (protected)
[ GitHub ]#remove_auth(remote) (protected)
[ GitHub ]#rubygems_dir (protected)
[ GitHub ]# File 'lib/bundler/source/rubygems.rb', line 455
def rubygems_dir Bundler.bundle_path end
#spec_names
[ GitHub ]# File 'lib/bundler/source/rubygems.rb', line 239
def spec_names if @allow_remote && dependency_api_available? remote_specs.spec_names else [] end end
#specs
[ GitHub ]# File 'lib/bundler/source/rubygems.rb', line 128
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) if @allow_local idx end end
#suppress_configured_credentials(remote) (protected)
[ GitHub ]# File 'lib/bundler/source/rubygems.rb', line 350
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_gemfile
Alias for #identifier.
# File 'lib/bundler/source/rubygems.rb', line 126
alias_method :to_gemfile, :identifier
#to_lock
[ GitHub ]# File 'lib/bundler/source/rubygems.rb', line 94
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
[ GitHub ]# File 'lib/bundler/source/rubygems.rb', line 102
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 247
def unmet_deps if @allow_remote && dependency_api_available? remote_specs.unmet_dependency_names else [] end end