On this page
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
Public Class Methods
# File lib/bundler/source/git/git_proxy.rb, line 51
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
# File lib/bundler/source/git/git_proxy.rb, line 72
def branch
@branch ||= allowed_in_path do
git("rev-parse --abbrev-ref HEAD").strip
end
end
# File lib/bundler/source/git/git_proxy.rb, line 93
def checkout
return if path.exist? && has_revision_cached?
extra_ref = "#{Shellwords.shellescape(ref)}:#{Shellwords.shellescape(ref)}" if ref && ref.start_with?("refs/")
Bundler.ui.info "Fetching #{URICredentialsFilter.credential_filtered_uri(uri)}"
unless path.exist?
SharedHelpers.filesystem_access(path.dirname) do |p|
FileUtils.mkdir_p(p)
end
git_retry %(clone #{uri_escaped_with_configured_credentials} "#{path}" --bare --no-hardlinks --quiet)
return unless extra_ref
end
in_path do
git_retry %(fetch --force --quiet --tags #{uri_escaped_with_configured_credentials} "refs/heads/*:refs/heads/*" #{extra_ref})
end
end
# File lib/bundler/source/git/git_proxy.rb, line 78
def contains?(commit)
allowed_in_path do
result = git_null("branch --contains #{commit}")
$? == 0 && result =~ /^\* (.*)$/
end
end
# File lib/bundler/source/git/git_proxy.rb, line 112
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 %(clone --no-checkout --quiet "#{path}" "#{destination}")
File.chmod(((File.stat(destination).mode | 0o777) & ~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 %(fetch --force --quiet --tags "#{path}")
begin
git "reset --hard #{@revision}"
rescue GitCommandError
raise MissingGitRevisionError.new(@revision, URICredentialsFilter.credential_filtered_uri(uri))
end
if submodules
git_retry "submodule update --init --recursive"
elsif Gem::Version.create(version) >= Gem::Version.create("2.9.0")
git_retry "submodule deinit --all --force"
end
end
end
# File lib/bundler/source/git/git_proxy.rb, line 89
def full_version
git("--version").sub("git version", "").strip
end
# File lib/bundler/source/git/git_proxy.rb, line 60
def revision
return @revision if @revision
begin
@revision ||= find_local_revision
rescue GitCommandError
raise MissingGitRevisionError.new(ref, URICredentialsFilter.credential_filtered_uri(uri))
end
@revision
end
# File lib/bundler/source/git/git_proxy.rb, line 85
def version
git("--version").match(/(git version\s*)?((\.?\d+)+).*/)[2]
end
Private Instance Methods
# File lib/bundler/source/git/git_proxy.rb, line 223
def allow?
@git ? @git.allow_git_ops? : true
end
# File lib/bundler/source/git/git_proxy.rb, line 233
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
# File lib/bundler/source/git/git_proxy.rb, line 243
def capture_and_filter_stderr(uri)
return_value, captured_err = ""
backup_stderr = STDERR.dup
begin
Tempfile.open("captured_stderr") do |f|
STDERR.reopen(f)
return_value = yield
f.rewind
captured_err = f.read
end
ensure
STDERR.reopen backup_stderr
end
$stderr.puts URICredentialsFilter.credential_filtered_string(captured_err, uri) if uri && !captured_err.empty?
return_value
end
TODO: Replace this with Open3
when upgrading to bundler 2 Similar to git_null
, as Open3
is not cross-platform, a temporary way is to use Tempfile
to capture the stderr. When replacing this using Open3
, make sure git_null
is also replaced by Open3
, so stdout and stderr all got handled properly.
# File lib/bundler/source/git/git_proxy.rb, line 212
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
Adds credentials to the URI
as Fetcher#configured_uri_for does
# File lib/bundler/source/git/git_proxy.rb, line 191
def find_local_revision
allowed_in_path do
git("rev-parse --verify #{Shellwords.shellescape(ref)}", true).strip
end
end
# File lib/bundler/source/git/git_proxy.rb, line 166
def git(command, check_errors = true, error_msg = nil)
command_with_no_credentials = URICredentialsFilter.credential_filtered_string(command, uri)
raise GitNotAllowedError.new(command_with_no_credentials) unless allow?
out = SharedHelpers.with_clean_git_env do
capture_and_filter_stderr(uri) { `git #{command}` }
end
stdout_with_no_credentials = URICredentialsFilter.credential_filtered_string(out, uri)
raise GitCommandError.new(command_with_no_credentials, path, error_msg) if check_errors && !$?.success?
stdout_with_no_credentials
end
# File lib/bundler/source/git/git_proxy.rb, line 156
def git_null(command)
git("#{command} 2>#{Bundler::NULL}", false)
end
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 160
def git_retry(command)
Bundler::Retry.new("`git #{URICredentialsFilter.credential_filtered_string(command, uri)}`", GitNotAllowedError).attempts do
git(command)
end
end
# File lib/bundler/source/git/git_proxy.rb, line 179
def has_revision_cached?
return unless @revision
in_path { git("cat-file -e #{@revision}") }
true
rescue GitError
false
end
# File lib/bundler/source/git/git_proxy.rb, line 227
def in_path(&blk)
checkout unless path.exist?
_ = URICredentialsFilter # load it before we chdir
SharedHelpers.chdir(path, &blk)
end
# File lib/bundler/source/git/git_proxy.rb, line 187
def remove_cache
FileUtils.rm_rf(path)
end
# File lib/bundler/source/git/git_proxy.rb, line 198
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
Escape the URI
for git commands
Ruby Core © 1993–2017 Yukihiro Matsumoto
Licensed under the Ruby License.
Ruby Standard Library © contributors
Licensed under their own licenses.