Class: Bundler::Source::Git::GitProxy
Relationships & Source Files | |
Inherits: | Object |
Defined in: | lib/bundler/source/git/git_proxy.rb |
Overview
The GitProxy is responsible to interact with git repositories. All actions required by the ::Bundler::Source::Git
source is encapsulated in this object.
Class Method Summary
Instance Attribute Summary
- #path rw
- #ref rw
- #revision rw
- #revision=(value) rw
- #uri rw
- #allow? ⇒ Boolean readonly private
- #has_revision_cached? ⇒ Boolean readonly private
Instance Method Summary
- #branch
- #checkout
- #contains?(commit) ⇒ Boolean
- #copy_to(destination, submodules = false)
- #full_version
- #version
- #allowed_in_path private
- #capture_and_filter_stderr(uri, cmd) private
- #capture_and_ignore_stderr(cmd) private
-
#configured_uri_for(uri)
private
Adds credentials to the
::Bundler::URI
asFetcher#configured_uri_for
does. - #find_local_revision private
- #git(command, check_errors = true, error_msg = nil) private
- #git_null(command) private
- #git_retry(command) private
- #in_path(&blk) private
- #remove_cache private
-
#uri_escaped_with_configured_credentials
private
Escape the
::Bundler::URI
for git commands.
Constructor Details
.new(path, uri, ref, revision = nil, git = nil) ⇒ GitProxy
Instance Attribute Details
#allow? ⇒ Boolean
(readonly, private)
[ GitHub ]
# File 'lib/bundler/source/git/git_proxy.rb', line 229
def allow? @git ? @git.allow_git_ops? : true end
#has_revision_cached? ⇒ Boolean
(readonly, private)
[ GitHub ]
#path (rw)
[ GitHub ]#ref (rw)
[ GitHub ]#revision (rw)
[ GitHub ]# File 'lib/bundler/source/git/git_proxy.rb', line 64
def revision return @revision if @revision begin @revision ||= find_local_revision rescue GitCommandError => e raise MissingGitRevisionError.new(e.command, path, ref, URICredentialsFilter.credential_filtered_uri(uri)) end @revision end
#revision=(value) (rw)
[ GitHub ]# File 'lib/bundler/source/git/git_proxy.rb', line 53
attr_writer :revision
#uri (rw)
[ GitHub ]Instance Method Details
#allowed_in_path (private)
#branch
[ GitHub ]# File 'lib/bundler/source/git/git_proxy.rb', line 76
def branch @branch ||= allowed_in_path do git("rev-parse --abbrev-ref HEAD").strip end end
#capture_and_filter_stderr(uri, cmd) (private)
[ GitHub ]# File 'lib/bundler/source/git/git_proxy.rb', line 244
def capture_and_filter_stderr(uri, cmd) require "open3" return_value, captured_err, status = Open3.capture3(cmd) Bundler.ui.warn URICredentialsFilter.credential_filtered_string(captured_err, uri) if uri && !captured_err.empty? [return_value, status] end
#capture_and_ignore_stderr(cmd) (private)
[ GitHub ]# File 'lib/bundler/source/git/git_proxy.rb', line 251
def capture_and_ignore_stderr(cmd) require "open3" return_value, _, status = Open3.capture3(cmd) [return_value, status] end
#checkout
[ GitHub ]# File 'lib/bundler/source/git/git_proxy.rb', line 97
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
#configured_uri_for(uri) (private)
Adds credentials to the ::Bundler::URI
as Fetcher#configured_uri_for
does
#contains?(commit) ⇒ Boolean
# File 'lib/bundler/source/git/git_proxy.rb', line 82
def contains?(commit) allowed_in_path do result, status = git_null("branch --contains #{commit}") status.success? && result =~ /^\* (.*)$/ end end
#copy_to(destination, submodules = false)
[ GitHub ]# File 'lib/bundler/source/git/git_proxy.rb', line 116
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. [%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 => e raise MissingGitRevisionError.new(e.command, path, @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
#find_local_revision (private)
[ GitHub ]# File 'lib/bundler/source/git/git_proxy.rb', line 197
def find_local_revision allowed_in_path do git("rev-parse --verify #{Shellwords.shellescape(ref)}", true).strip end end
#full_version
[ GitHub ]# File 'lib/bundler/source/git/git_proxy.rb', line 93
def full_version git("--version").sub("git version", "").strip end
#git(command, check_errors = true, error_msg = nil) (private)
# File 'lib/bundler/source/git/git_proxy.rb', line 172
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, status = 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 && !status.success? stdout_with_no_credentials end
#git_null(command) (private)
# File 'lib/bundler/source/git/git_proxy.rb', line 155
def git_null(command) command_with_no_credentials = URICredentialsFilter.credential_filtered_string(command, uri) raise GitNotAllowedError.new(command_with_no_credentials) unless allow? out, status = SharedHelpers.with_clean_git_env do capture_and_ignore_stderr("git #{command}") end [URICredentialsFilter.credential_filtered_string(out, uri), status] end
#git_retry(command) (private)
[ GitHub ]# File 'lib/bundler/source/git/git_proxy.rb', line 166
def git_retry(command) Bundler::Retry.new("`git #{URICredentialsFilter.credential_filtered_string(command, uri)}`", GitNotAllowedError).attempts do git(command) end end
#in_path(&blk) (private)
[ GitHub ]# File 'lib/bundler/source/git/git_proxy.rb', line 233
def in_path(&blk) checkout unless path.exist? _ = URICredentialsFilter # load it before we chdir SharedHelpers.chdir(path, &blk) end
#remove_cache (private)
[ GitHub ]#uri_escaped_with_configured_credentials (private)
Escape the ::Bundler::URI
for git commands
# File 'lib/bundler/source/git/git_proxy.rb', line 204
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
#version
[ GitHub ]# File 'lib/bundler/source/git/git_proxy.rb', line 89
def version git("--version").match(/(git version\s*)?((\.?\d)).*/)[2] end