class Bundler::Source::Git

Attributes

branch[R]
glob[R]
options[R]
ref[R]
submodules[R]
uri[R]

Public Class Methods

from_lock(options) click to toggle source
# File bundler/source/git.rb, line 35
def self.from_lock(options)
  new(options.merge("uri" => options.delete("remote")))
end
new(options) click to toggle source
# File bundler/source/git.rb, line 12
def initialize(options)
  @options = options
  @checksum_store = Checksum::Store.new
  @glob = options["glob"] || DEFAULT_GLOB

  @allow_cached = false
  @allow_remote = false

  # Stringify options that could be set as symbols
  %w[ref branch tag revision].each {|k| options[k] = options[k].to_s if options[k] }

  @uri        = URINormalizer.normalize_suffix(options["uri"] || "", :trailing_slash => false)
  @safe_uri   = URICredentialsFilter.credential_filtered_uri(@uri)
  @branch     = options["branch"]
  @ref        = options["ref"] || options["branch"] || options["tag"]
  @submodules = options["submodules"]
  @name       = options["name"]
  @version    = options["version"].to_s.strip.gsub("-", ".pre.")

  @copied     = false
  @local      = false
end

Public Instance Methods

==(other)
Alias for: eql?
allow_git_ops?() click to toggle source
# File bundler/source/git.rb, line 249
def allow_git_ops?
  @allow_remote || @allow_cached
end
app_cache_dirname() click to toggle source
# File bundler/source/git.rb, line 237
def app_cache_dirname
  "#{base_name}-#{shortref_for_path(cached_revision || revision)}"
end
cache(spec, custom_path = nil) click to toggle source
# File bundler/source/git.rb, line 207
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() click to toggle source

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 bundler/source/git.rb, line 229
def cache_path
  @cache_path ||= if Bundler.feature_flag.global_gem_cache?
    Bundler.user_cache
  else
    Bundler.bundle_path.join("cache", "bundler")
  end.join("git", git_scope)
end
current_branch() click to toggle source
# File bundler/source/git.rb, line 245
def current_branch
  git_proxy.current_branch
end
eql?(other) click to toggle source
# File bundler/source/git.rb, line 62
def eql?(other)
  other.is_a?(Git) && uri == other.uri && ref == other.ref &&
    branch == other.branch && name == other.name &&
    version == other.version && glob == other.glob &&
    submodules == other.submodules
end
Also aliased as: ==
extension_dir_name() click to toggle source
# File bundler/source/git.rb, line 124
def extension_dir_name
  "#{base_name}-#{shortref_for_path(revision)}"
end
hash() click to toggle source
# File bundler/source/git.rb, line 58
def hash
  [self.class, uri, ref, branch, name, version, glob, submodules].hash
end
identifier() click to toggle source
# File bundler/source/git.rb, line 90
def identifier
  uri_with_specifiers([humanized_ref, cached_revision, glob_for_display])
end
include?(other) click to toggle source
# File bundler/source/git.rb, line 71
def include?(other)
  other.is_a?(Git) && uri == other.uri &&
    name == other.name &&
    glob == other.glob &&
    submodules == other.submodules
end
install(spec, options = {}) click to toggle source
# File bundler/source/git.rb, line 188
def install(spec, options = {})
  return if Bundler.settings[:no_install]
  force = options[:force]

  print_using_message "Using #{version_message(spec, options[:previous_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

  generate_bin_options = { :disable_extensions => !Bundler.rubygems.spec_missing_extensions?(spec), :build_args => options[:build_args] }
  generate_bin(spec, generate_bin_options)

  requires_checkout? ? spec.post_install_message : nil
end
install_path() click to toggle source

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 bundler/source/git.rb, line 114
def install_path
  @install_path ||= begin
    git_scope = "#{base_name}-#{shortref_for_path(revision)}"

    Bundler.install_path.join(git_scope)
  end
end
Also aliased as: path
load_spec_files() click to toggle source
Calls superclass method
# File bundler/source/git.rb, line 218
def load_spec_files
  super
rescue PathError => e
  Bundler.ui.trace e
  raise GitError, "#{self} is not yet checked out. Run `bundle install` first."
end
local?() click to toggle source
# File bundler/source/git.rb, line 253
def local?
  @local
end
local_override!(path) click to toggle source
# File bundler/source/git.rb, line 135
def local_override!(path)
  return false if local?

  original_path = path
  path = Pathname.new(path)
  path = path.expand_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, options)

  if current_branch != branch && !Bundler.settings[:disable_local_branch_check]
    raise GitError, "Local override for #{name} at #{path} is using branch " \
      "#{current_branch} but Gemfile specifies #{branch}"
  end

  changed = cached_revision && cached_revision != revision

  if !Bundler.settings[:disable_local_revision_check] && 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() click to toggle source
# File bundler/source/git.rb, line 107
def name
  File.basename(@uri, ".git")
end
path()
Alias for: install_path
revision() click to toggle source
# File bundler/source/git.rb, line 241
def revision
  git_proxy.revision
end
specs(*) click to toggle source
# File bundler/source/git.rb, line 175
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_gemfile() click to toggle source
# File bundler/source/git.rb, line 50
def to_gemfile
  specifiers = %w[ref branch tag submodules glob].map do |opt|
    "#{opt}: #{options[opt]}" if options[opt]
  end

  uri_with_specifiers(specifiers)
end
to_lock() click to toggle source
# File bundler/source/git.rb, line 39
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}: #{options[opt]}\n" if options[opt]
  end
  out << "  glob: #{@glob}\n" unless default_glob?
  out << "  specs:\n"
end
to_s() click to toggle source
# File bundler/source/git.rb, line 78
def to_s
  begin
    at = humanized_ref || current_branch

    rev = "at #{at}@#{shortref_for_display(revision)}"
  rescue GitError
    ""
  end

  uri_with_specifiers([rev, glob_for_display])
end
unlock!() click to toggle source
# File bundler/source/git.rb, line 128
def unlock!
  git_proxy.revision = nil
  options["revision"] = nil

  @unlocked = true
end
uri_with_specifiers(specifiers) click to toggle source
# File bundler/source/git.rb, line 94
def uri_with_specifiers(specifiers)
  specifiers.compact!

  suffix =
    if specifiers.any?
      " (#{specifiers.join(", ")})"
    else
      ""
    end

  "#{@safe_uri}#{suffix}"
end

Private Instance Methods

base_name() click to toggle source
# File bundler/source/git.rb, line 305
def base_name
  File.basename(uri.sub(%r{^(\w+://)?([^/:]+:)?(//\w*/)?(\w*/)*}, ""), ".git")
end
cached?() click to toggle source
# File bundler/source/git.rb, line 343
def cached?
  cache_path.exist?
end
cached_revision() click to toggle source
# File bundler/source/git.rb, line 339
def cached_revision
  options["revision"]
end
cached_revision_checked_out?() click to toggle source
# File bundler/source/git.rb, line 301
def cached_revision_checked_out?
  cached_revision && cached_revision == revision && install_path.exist?
end
default_glob?() click to toggle source
# File bundler/source/git.rb, line 321
def default_glob?
  @glob == DEFAULT_GLOB
end
extension_cache_slug(_) click to toggle source
# File bundler/source/git.rb, line 371
def extension_cache_slug(_)
  extension_dir_name
end
fetch() click to toggle source
# File bundler/source/git.rb, line 351
def fetch
  git_proxy.checkout
rescue GitError => e
  raise unless Bundler.feature_flag.allow_offline_install?
  Bundler.ui.warn "Using cached git data because of network errors:\n#{e}"
end
git_proxy() click to toggle source
# File bundler/source/git.rb, line 347
def git_proxy
  @git_proxy ||= GitProxy.new(cache_path, uri, options, cached_revision, self)
end
git_scope() click to toggle source
# File bundler/source/git.rb, line 367
def git_scope
  "#{base_name}-#{uri_hash}"
end
glob_for_display() click to toggle source
# File bundler/source/git.rb, line 317
def glob_for_display
  default_glob? ? nil : "glob: #{@glob}"
end
has_app_cache?() click to toggle source
Calls superclass method
# File bundler/source/git.rb, line 293
def has_app_cache?
  cached_revision && super
end
humanized_ref() click to toggle source
# File bundler/source/git.rb, line 259
def humanized_ref
  if local?
    path
  elsif user_ref = options["ref"]
    if /\A[a-z0-9]{4,}\z/i.match?(ref)
      shortref_for_display(user_ref)
    else
      user_ref
    end
  elsif ref
    ref
  end
end
load_gemspec(file) click to toggle source
# File bundler/source/git.rb, line 361
def load_gemspec(file)
  stub = Gem::StubSpecification.gemspec_stub(file, install_path.parent, install_path.parent)
  stub.full_gem_path = Pathname.new(file).dirname.expand_path(root).to_s.tap {|x| x.untaint if RUBY_VERSION < "2.7" }
  StubSpecification.from_stub(stub)
end
override_for(path) click to toggle source
# File bundler/source/git.rb, line 375
def override_for(path)
  Bundler.settings.local_overrides.key(path)
end
requires_checkout?() click to toggle source
# File bundler/source/git.rb, line 297
def requires_checkout?
  allow_git_ops? && !local? && !cached_revision_checked_out?
end
serialize_gemspecs_in(destination) click to toggle source
# File bundler/source/git.rb, line 273
def serialize_gemspecs_in(destination)
  destination = destination.expand_path(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) click to toggle source
# File bundler/source/git.rb, line 287
def set_local!(path)
  @local       = true
  @local_specs = @git_proxy = nil
  @cache_path  = @install_path = path
end
shortref_for_display(ref) click to toggle source
# File bundler/source/git.rb, line 309
def shortref_for_display(ref)
  ref[0..6]
end
shortref_for_path(ref) click to toggle source
# File bundler/source/git.rb, line 313
def shortref_for_path(ref)
  ref[0..11]
end
uri_hash() click to toggle source
# File bundler/source/git.rb, line 325
def uri_hash
  if %r{^\w+://(\w+@)?}.match?(uri)
    # 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
  # We use SHA1 here for historical reason and to preserve backward compatibility.
  # But a transition to a simpler mangling algorithm would be welcome.
  Bundler::Digest.sha1(input)
end
validate_spec(_spec) click to toggle source

no-op, since we validate when re-serializing the gemspec

# File bundler/source/git.rb, line 359
def validate_spec(_spec); end