class Bundler::Source::Git::GitProxy

The GitProxy is responsible to interact with git repositories. All actions required by the Git source is encapsulated in this object.

Attributes

path[RW]
ref[RW]
revision[W]
uri[RW]

Public Class Methods

new(path, uri, ref, revision = nil, git = nil) click to toggle source
# File lib/bundler/source/git/git_proxy.rb, line 37
def initialize(path, uri, ref, revision = nil, git = nil)
  @path     = path
  @uri      = uri
  @ref      = ref
  @revision = revision
  @git      = git
  raise GitNotInstalledError.new if allow? && !Bundler.git_present?
end

Public Instance Methods

branch() click to toggle source
# File lib/bundler/source/git/git_proxy.rb, line 50
def branch
  @branch ||= allowed_in_path do
    git("branch") =~ /^\* (.*)$/ && $1.strip
  end
end
checkout() click to toggle source
# File lib/bundler/source/git/git_proxy.rb, line 67
def checkout
  if path.exist?
    return if has_revision_cached?
    Bundler.ui.confirm "Updating #{uri}"
    in_path do
      git_retry %Qfetch --force --quiet --tags #{uri_escaped} "refs/heads/*:refs/heads/*"|
    end
  else
    Bundler.ui.info "Fetching #{uri}"
    FileUtils.mkdir_p(path.dirname)
    git_retry %Qclone #{uri_escaped} "#{path}" --bare --no-hardlinks --quiet|
  end
end
contains?(commit) click to toggle source
# File lib/bundler/source/git/git_proxy.rb, line 56
def contains?(commit)
  allowed_in_path do
    result = git_null("branch --contains #{commit}")
    $? == 0 && result =~ /^\* (.*)$/
  end
end
copy_to(destination, submodules=false) click to toggle source
# File lib/bundler/source/git/git_proxy.rb, line 81
def copy_to(destination, submodules=false)
  unless File.exist?(destination.join(".git"))
    FileUtils.mkdir_p(destination.dirname)
    FileUtils.rm_rf(destination)
    git_retry %Qclone --no-checkout --quiet "#{path}" "#{destination}"|
    File.chmod(((File.stat(destination).mode | 0777) & ~File.umask), destination)
  end

  SharedHelpers.chdir(destination) do
    git_retry %Qfetch --force --quiet --tags "#{path}"|
    git "reset --hard #{@revision}"

    if submodules
      git_retry "submodule update --init --recursive"
    end
  end
end
revision() click to toggle source
# File lib/bundler/source/git/git_proxy.rb, line 46
def revision
  @revision ||= allowed_in_path { git("rev-parse #{ref}").strip }
end
version() click to toggle source
# File lib/bundler/source/git/git_proxy.rb, line 63
def version
  git("--version").sub("git version", "").strip
end

Private Instance Methods

allow?() click to toggle source
# File lib/bundler/source/git/git_proxy.rb, line 144
def allow?
  @git ? @git.allow_git_ops? : true
end
allowed_in_path() { || ... } click to toggle source
# File lib/bundler/source/git/git_proxy.rb, line 153
def allowed_in_path
  return in_path { yield } if allow?
  raise GitError, "The git source #{uri} is not yet checked out. Please run `bundle install` before trying to start your application"
end
git(command, check_errors=true) click to toggle source
# File lib/bundler/source/git/git_proxy.rb, line 116
def git(command, check_errors=true)
  raise GitNotAllowedError.new(command) unless allow?
  out = SharedHelpers.with_clean_git_env { %x{git #{command}} }
  raise GitCommandError.new(command, path) if check_errors && !$?.success?
  out
end
git_null(command) click to toggle source

TODO: Do not rely on /dev/null. Given that open3 is not cross platform until Ruby 1.9.3, the best solution is to pipe to /dev/null if it exists. If it doesn't, everything will work fine, but the user will get the $stderr messages as well.

# File lib/bundler/source/git/git_proxy.rb, line 106
def git_null(command)
  git("#{command} 2>#{Bundler::NULL}", false)
end
git_retry(command) click to toggle source
# File lib/bundler/source/git/git_proxy.rb, line 110
def git_retry(command)
  Bundler::Retry.new("git #{command}", GitNotAllowedError).attempts do
    git(command)
  end
end
has_revision_cached?() click to toggle source
# File lib/bundler/source/git/git_proxy.rb, line 123
def has_revision_cached?
  return unless @revision
  in_path { git("cat-file -e #{@revision}") }
  true
rescue GitError
  false
end
in_path(&blk) click to toggle source
# File lib/bundler/source/git/git_proxy.rb, line 148
def in_path(&blk)
  checkout unless path.exist?
  SharedHelpers.chdir(path, &blk)
end
uri_escaped() click to toggle source

Escape the URI for git commands

# File lib/bundler/source/git/git_proxy.rb, line 132
def uri_escaped
  if Bundler::WINDOWS
    # Windows quoting requires double quotes only, with double quotes
    # inside the string escaped by being doubled.
    '"' + uri.gsub('"') {|s| '""'} + '"'
  else
    # Bash requires single quoted strings, with the single quotes escaped
    # by ending the string, escaping the quote, and restarting the string.
    "'" + uri.gsub("'") {|s| "'\\''"} + "'"
  end
end