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 48
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 69
def branch
  @branch ||= allowed_in_path do
    git("rev-parse --abbrev-ref HEAD").strip
  end
end
checkout() click to toggle source
# File lib/bundler/source/git/git_proxy.rb, line 86
def checkout
  if path.exist?
    return if has_revision_cached?
    Bundler.ui.info "Fetching #{uri}"
    in_path do
      git_retry %Q(fetch --force --quiet --tags #{uri_escaped_with_configured_credentials} "refs/heads/*:refs/heads/*")
    end
  else
    Bundler.ui.info "Fetching #{uri}"
    SharedHelpers.filesystem_access(path.dirname) do |p|
      FileUtils.mkdir_p(p)
    end
    git_retry %Q(clone #{uri_escaped_with_configured_credentials} "#{path}" --bare --no-hardlinks --quiet)
  end
end
contains?(commit) click to toggle source
# File lib/bundler/source/git/git_proxy.rb, line 75
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 102
def copy_to(destination, submodules = false)
  # method 1
  unless File.exist?(destination.join(".git"))
    begin
      SharedHelpers.filesystem_access(destination.dirname) do |p|
        FileUtils.mkdir_p(p)
      end
      SharedHelpers.filesystem_access(destination) do |p|
        FileUtils.rm_rf(p)
      end
      git_retry %Q(clone --no-checkout --quiet "#{path}" "#{destination}")
      File.chmod(((File.stat(destination).mode | 0777) & ~File.umask), destination)
    rescue Errno::EEXIST => e
      file_path = e.message[%r{.*?(/.*)}, 1]
      raise GitError, "Bundler could not install a gem because it needs to "                  "create a directory, but a file exists - #{file_path}. Please delete "                  "this file and try again."
    end
  end
  # method 2
  SharedHelpers.chdir(destination) do
    git_retry %Q(fetch --force --quiet --tags "#{path}")
    git "reset --hard #{@revision}"

    git_retry "submodule update --init --recursive" if submodules
  end
end
revision() click to toggle source
# File lib/bundler/source/git/git_proxy.rb, line 57
def revision
  return @revision if @revision

  begin
    @revision ||= find_local_revision
  rescue GitCommandError
    raise MissingGitRevisionError.new(ref, uri)
  end

  @revision
end
version() click to toggle source
# File lib/bundler/source/git/git_proxy.rb, line 82
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 198
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 207
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
configured_uri_for(uri) click to toggle source

Adds credentials to the URI as Fetcher#configured_uri_for does

# File lib/bundler/source/git/git_proxy.rb, line 187
def configured_uri_for(uri)
  if /https?:/ =~ uri
    remote = URI(uri)
    config_auth = Bundler.settings[remote.to_s] || Bundler.settings[remote.host]
    remote.userinfo ||= config_auth
    remote.to_s
  else
    uri
  end
end
find_local_revision() click to toggle source
# File lib/bundler/source/git/git_proxy.rb, line 166
def find_local_revision
  allowed_in_path do
    git("rev-parse --verify #{ref}", true).strip
  end
end
git(command, check_errors = true, error_msg = nil) click to toggle source
# File lib/bundler/source/git/git_proxy.rb, line 147
def git(command, check_errors = true, error_msg = nil)
  raise GitNotAllowedError.new(command) unless allow?
  out = SharedHelpers.with_clean_git_env { %x`git #{command}` }
  raise GitCommandError.new(command, path, error_msg) 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 137
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 141
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 154
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 202
def in_path(&blk)
  checkout unless path.exist?
  SharedHelpers.chdir(path, &blk)
end
remove_cache() click to toggle source
# File lib/bundler/source/git/git_proxy.rb, line 162
def remove_cache
  FileUtils.rm_rf(path)
end
uri_escaped_with_configured_credentials() click to toggle source

Escape the URI for git commands

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