Class: Bundler::Source::Git
Relationships & Source Files | |
Namespace Children | |
Classes:
| |
Exceptions:
| |
Extension / Inclusion / Inheritance Descendants | |
Subclasses:
|
|
Super Chains via Extension / Inclusion / Inheritance | |
Class Chain:
self,
Path ,
::Bundler::Source
|
|
Instance Chain:
self,
Path ,
::Bundler::Source
|
|
Inherits: |
Bundler::Source::Path
|
Defined in: | lib/bundler/source/git.rb, lib/bundler/source/git/git_proxy.rb |
Constant Summary
Path
- Inherited
Class Method Summary
Instance Attribute Summary
- #allow_git_ops? ⇒ Boolean readonly
- #branch readonly
- #glob readonly
- #options readonly
- #ref readonly
- #submodules readonly
- #uri readonly
- #cached? ⇒ Boolean readonly private
- #cached_revision_checked_out? ⇒ Boolean readonly private
- #has_app_cache? ⇒ Boolean readonly private
- #local? ⇒ Boolean readonly private
- #requires_checkout? ⇒ Boolean readonly private
Path
- Inherited
::Bundler::Source
- Inherited
Instance Method Summary
-
#==(other)
Alias for #eql?.
- #app_cache_dirname
- #cache(spec, custom_path = nil)
-
#cache_path
This is the path which is going to contain a cache of the git repository.
- #eql?(other) ⇒ Boolean (also: #==)
- #extension_dir_name
- #hash
- #install(spec, options = {})
-
#install_path
(also: #path)
This is the path which is going to contain a specific checkout of the git repository.
- #load_spec_files
- #local_override!(path)
- #name
-
#path
Alias for #install_path.
- #revision
- #specs
- #to_lock
- #to_s
- #unlock!
- #base_name private
- #cached_revision private
- #extension_cache_slug(_) private
- #fetch private
- #git_proxy private
- #git_scope private
- #load_gemspec(file) private
- #override_for(path) private
- #serialize_gemspecs_in(destination) private
- #set_local!(path) private
- #shortref_for_display(ref) private
- #shortref_for_path(ref) private
- #uri_hash private
-
#validate_spec(_spec)
private
no-op, since we validate when re-serializing the gemspec.
Path
- Inherited
::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) ⇒ Git
# File 'lib/bundler/source/git.rb', line 12
def initialize( ) @options = @glob = ["glob"] || DEFAULT_GLOB @allow_cached = false @allow_remote = false # Stringify options that could be set as symbols %w[ref branch tag revision].each {|k| [k] = [k].to_s if [k] } @uri = ["uri"] || "" @safe_uri = URICredentialsFilter.credential_filtered_uri(@uri) @branch = ["branch"] @ref = ["ref"] || ["branch"] || ["tag"] || "master" @submodules = ["submodules"] @name = ["name"] @version = ["version"].to_s.strip.gsub("-", ".pre.") @copied = false @local = false end
Class Method Details
.from_lock(options)
[ GitHub ]# File 'lib/bundler/source/git.rb', line 34
def self.from_lock( ) new( .merge("uri" => .delete("remote"))) end
Instance Attribute Details
#allow_git_ops? ⇒ Boolean
(readonly)
[ GitHub ]
# File 'lib/bundler/source/git.rb', line 229
def allow_git_ops? @allow_remote || @allow_cached end
#branch (readonly)
[ GitHub ]# File 'lib/bundler/source/git.rb', line 10
attr_reader :uri, :ref, :branch, :, :glob, :submodules
#cached? ⇒ Boolean
(readonly, private)
[ GitHub ]
# File 'lib/bundler/source/git.rb', line 299
def cached? cache_path.exist? end
#cached_revision_checked_out? ⇒ Boolean
(readonly, private)
[ GitHub ]
# File 'lib/bundler/source/git.rb', line 267
def cached_revision_checked_out? cached_revision && cached_revision == revision && install_path.exist? end
#glob (readonly)
[ GitHub ]# File 'lib/bundler/source/git.rb', line 10
attr_reader :uri, :ref, :branch, :, :glob, :submodules
#has_app_cache? ⇒ Boolean
(readonly, private)
[ GitHub ]
# File 'lib/bundler/source/git.rb', line 255
def has_app_cache? cached_revision && super end
#local? ⇒ Boolean
(readonly, private)
[ GitHub ]
# File 'lib/bundler/source/git.rb', line 259
def local? @local end
#options (readonly)
[ GitHub ]# File 'lib/bundler/source/git.rb', line 10
attr_reader :uri, :ref, :branch, :, :glob, :submodules
#ref (readonly)
[ GitHub ]# File 'lib/bundler/source/git.rb', line 10
attr_reader :uri, :ref, :branch, :, :glob, :submodules
#requires_checkout? ⇒ Boolean
(readonly, private)
[ GitHub ]
# File 'lib/bundler/source/git.rb', line 263
def requires_checkout? allow_git_ops? && !local? && !cached_revision_checked_out? end
#submodules (readonly)
[ GitHub ]#uri (readonly)
[ GitHub ]# File 'lib/bundler/source/git.rb', line 10
attr_reader :uri, :ref, :branch, :, :glob, :submodules
Instance Method Details
#==(other)
Alias for #eql?.
# File 'lib/bundler/source/git.rb', line 60
alias_method :==, :eql?
#app_cache_dirname
[ GitHub ]# File 'lib/bundler/source/git.rb', line 221
def app_cache_dirname "#{base_name}-#{shortref_for_path(cached_revision || revision)}" end
#base_name (private)
[ GitHub ]# File 'lib/bundler/source/git.rb', line 271
def base_name File.basename(uri.sub(%r{^(\w://)?([^/:]:)?(//\w*/)?(\w*/)*}, ""), ".git") end
#cache(spec, custom_path = nil)
[ GitHub ]# File 'lib/bundler/source/git.rb', line 189
def cache(spec, custom_path = nil) app_cache_path = app_cache_path(custom_path) return unless Bundler.feature_flag.cache_all? return if path == app_cache_path cached! FileUtils.rm_rf(app_cache_path) git_proxy.checkout if requires_checkout? git_proxy.copy_to(app_cache_path, @submodules) serialize_gemspecs_in(app_cache_path) end
#cache_path
This is the path which is going to contain a cache of the git repository. When using the same git repository across different projects, this cache will be shared. When using local git repos, this is set to the local repo.
# File 'lib/bundler/source/git.rb', line 211
def cache_path @cache_path ||= begin if Bundler.requires_sudo? || Bundler.feature_flag.global_gem_cache? Bundler.user_cache else Bundler.bundle_path.join("cache", "bundler") end.join("git", git_scope) end end
#cached_revision (private)
[ GitHub ]# File 'lib/bundler/source/git.rb', line 295
def cached_revision ["revision"] end
#eql?(other) ⇒ Boolean
Also known as: #==
#extension_cache_slug(_) (private)
[ GitHub ]# File 'lib/bundler/source/git.rb', line 327
def extension_cache_slug(_) extension_dir_name end
#extension_dir_name
[ GitHub ]# File 'lib/bundler/source/git.rb', line 107
def extension_dir_name "#{base_name}-#{shortref_for_path(revision)}" end
#fetch (private)
[ GitHub ]#git_proxy (private)
[ GitHub ]# File 'lib/bundler/source/git.rb', line 303
def git_proxy @git_proxy ||= GitProxy.new(cache_path, uri, ref, cached_revision, self) end
#git_scope (private)
[ GitHub ]#hash
[ GitHub ]#install(spec, options = {})
[ GitHub ]# File 'lib/bundler/source/git.rb', line 171
def install(spec, = {}) force = [:force] "Using #{ (spec)} from #{self}" if (requires_checkout? && !@copied) || force Bundler.ui.debug " * Checking out revision: #{ref}" git_proxy.copy_to(install_path, submodules) serialize_gemspecs_in(install_path) @copied = true end = { :disable_extensions => !Bundler.rubygems.spec_missing_extensions?(spec), :build_args => [:build_args] } generate_bin(spec, ) requires_checkout? ? spec. : nil end
#install_path Also known as: #path
This is the path which is going to contain a specific checkout of the git repository. When using local git repos, this is set to the local repo.
# File 'lib/bundler/source/git.rb', line 91
def install_path @install_path ||= begin git_scope = "#{base_name}-#{shortref_for_path(revision)}" path = Bundler.install_path.join(git_scope) if !path.exist? && Bundler.requires_sudo? Bundler.user_bundle_path.join(Bundler.ruby_scope).join(git_scope) else path end end end
#load_gemspec(file) (private)
[ GitHub ]# File 'lib/bundler/source/git.rb', line 317
def load_gemspec(file) stub = Gem::StubSpecification.gemspec_stub(file, install_path.parent, install_path.parent) stub.full_gem_path = Pathname.new(file).dirname. (root).to_s.tap{|x| x.untaint if RUBY_VERSION < "2.7" } StubSpecification.from_stub(stub) end
#load_spec_files
[ GitHub ]#local_override!(path)
[ GitHub ]# File 'lib/bundler/source/git.rb', line 118
def local_override!(path) return false if local? original_path = path path = Pathname.new(path) path = path. (Bundler.root) unless path.relative? unless ["branch"] || Bundler.settings[:disable_local_branch_check] raise GitError, "Cannot use local override for #{name} at #{path} because " \ ":branch is not specified in Gemfile. Specify a branch or run " \ "`bundle config unset local.#{override_for(original_path)}` to remove the local override" end unless path.exist? raise GitError, "Cannot use local override for #{name} because #{path} " \ "does not exist. Run `bundle config unset local.#{override_for(original_path)}` to remove the local override" end set_local!(path) # Create a new git proxy without the cached revision # so the Gemfile.lock always picks up the new revision. @git_proxy = GitProxy.new(path, uri, ref) if git_proxy.branch != ["branch"] && !Bundler.settings[:disable_local_branch_check] raise GitError, "Local override for #{name} at #{path} is using branch " \ "#{git_proxy.branch} but Gemfile specifies #{ ["branch"]}" end changed = cached_revision && cached_revision != git_proxy.revision if changed && !@unlocked && !git_proxy.contains?(cached_revision) raise GitError, "The Gemfile lock is pointing to revision #{shortref_for_display(cached_revision)} " \ "but the current branch in your local override for #{name} does not contain such commit. " \ "Please make sure your branch is up to date." end changed end
#name
[ GitHub ]# File 'lib/bundler/source/git.rb', line 84
def name File.basename(@uri, ".git") end
#override_for(path) (private)
[ GitHub ]#path
Alias for #install_path.
# File 'lib/bundler/source/git.rb', line 105
alias_method :path, :install_path
#revision
[ GitHub ]# File 'lib/bundler/source/git.rb', line 225
def revision git_proxy.revision end
#serialize_gemspecs_in(destination) (private)
[ GitHub ]# File 'lib/bundler/source/git.rb', line 235
def serialize_gemspecs_in(destination) destination = destination. (Bundler.root) if destination.relative? Dir["#{destination}/#{@glob}"].each do |spec_path| # Evaluate gemspecs and cache the result. Gemspecs # in git might require git or other dependencies. # The gemspecs we cache should already be evaluated. spec = Bundler.load_gemspec(spec_path) next unless spec Bundler.rubygems.set_installed_by_version(spec) Bundler.rubygems.validate(spec) File.open(spec_path, "wb") {|file| file.write(spec.to_ruby) } end end
#set_local!(path) (private)
[ GitHub ]#shortref_for_display(ref) (private)
[ GitHub ]#shortref_for_path(ref) (private)
[ GitHub ]#specs
[ GitHub ]# File 'lib/bundler/source/git.rb', line 158
def specs(*) set_local!(app_cache_path) if has_app_cache? && !local? if requires_checkout? && !@copied fetch git_proxy.copy_to(install_path, submodules) serialize_gemspecs_in(install_path) @copied = true end local_specs end
#to_lock
[ GitHub ]# File 'lib/bundler/source/git.rb', line 38
def to_lock out = String.new("GIT\n") out << " remote: #{@uri}\n" out << " revision: #{revision}\n" %w[ref branch tag submodules].each do |opt| out << " #{opt}: #{ [opt]}\n" if [opt] end out << " glob: #{@glob}\n" unless @glob == DEFAULT_GLOB out << " specs:\n" end
#to_s
[ GitHub ]# File 'lib/bundler/source/git.rb', line 62
def to_s at = if local? path elsif user_ref = ["ref"] if ref =~ /\A[a-z0-9]{4,}\z/i shortref_for_display(user_ref) else user_ref end else ref end rev = begin "@#{shortref_for_display(revision)}" rescue GitError nil end "#{@safe_uri} (at #{at}#{rev})" end
#unlock!
[ GitHub ]#uri_hash (private)
[ GitHub ]# File 'lib/bundler/source/git.rb', line 283
def uri_hash if uri =~ %r{^\w://(\w@)?} # Downcase the domain component of the URI # and strip off a trailing slash, if one is present input = Bundler::URI.parse(uri).normalize.to_s.sub(%r{/$}, "") else # If there is no URI scheme, assume it is an ssh/git URI input = uri end SharedHelpers.digest(:SHA1).hexdigest(input) end
#validate_spec(_spec) (private)
no-op, since we validate when re-serializing the gemspec
# File 'lib/bundler/source/git.rb', line 315
def validate_spec(_spec); end