Module: Utils::Git Private
- Defined in:
- utils/git.rb
Overview
This module is part of a private API. This module may only be used in the Homebrew/brew repository. Third parties should avoid using this module if possible, as it may be removed or changed without warning.
Helper functions for querying Git information.
Class Method Summary collapse
-
.available? ⇒ Boolean
private
-
.cherry_pick!(repo, *args, resolve: false, verbose: false) ⇒ Object
private
Special case of
git cherry-pick
that permits non-verbose output and optional resolution on merge conflict. -
.clear_available_cache ⇒ Object
private
-
.ensure_installed! ⇒ Object
private
-
.file_at_commit(repo, file, commit) ⇒ Object
private
-
.git ⇒ Object
private
-
.last_revision_commit_of_file(repo, file, before_commit: nil) ⇒ Object
private
-
.last_revision_commit_of_files(repo, files, before_commit: nil) ⇒ Object
private
-
.last_revision_of_file(repo, file, before_commit: nil) ⇒ String
private
-
.path ⇒ Object
private
-
.remote_exists?(url) ⇒ Boolean
private
-
.set_name_email!(author: true, committer: true) ⇒ Object
private
-
.setup_gpg! ⇒ Object
private
-
.supports_partial_clone_sparse_checkout? ⇒ Boolean
private
-
.version ⇒ Object
private
Class Method Details
.available? ⇒ Boolean
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
10 11 12 |
# File 'utils/git.rb', line 10 def self.available? version.present? end |
.cherry_pick!(repo, *args, resolve: false, verbose: false) ⇒ Object
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
Special case of git cherry-pick
that permits non-verbose output and
optional resolution on merge conflict.
134 135 136 137 138 139 140 141 142 143 144 |
# File 'utils/git.rb', line 134 def self.cherry_pick!(repo, *args, resolve: false, verbose: false) cmd = [git, "-C", repo, "cherry-pick"] + args output = Utils.popen_read(*cmd, err: :out) if $CHILD_STATUS.success? puts output if verbose output else system git, "-C", repo, "cherry-pick", "--abort" unless resolve raise ErrorDuringExecution.new(cmd, status: $CHILD_STATUS, output: [[:stdout, output]]) end end |
.clear_available_cache ⇒ Object
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
40 41 42 43 44 |
# File 'utils/git.rb', line 40 def self.clear_available_cache remove_instance_variable(:@version) if defined?(@version) remove_instance_variable(:@path) if defined?(@path) remove_instance_variable(:@git) if defined?(@git) end |
.ensure_installed! ⇒ Object
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 |
# File 'utils/git.rb', line 93 def self.ensure_installed! return if available? # we cannot install brewed git if homebrew/core is unavailable. if CoreTap.instance.installed? begin # Otherwise `git` will be installed from source in tests that need it. This is slow # and will also likely fail due to `OS::Linux` and `OS::Mac` being undefined. raise "Refusing to install Git on a generic OS." if ENV["HOMEBREW_TEST_GENERIC_OS"] ensure_formula_installed!("git") clear_available_cache rescue raise "Git is unavailable" end end raise "Git is unavailable" unless available? end |
.file_at_commit(repo, file, commit) ⇒ Object
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
87 88 89 90 91 |
# File 'utils/git.rb', line 87 def self.file_at_commit(repo, file, commit) relative_file = Pathname(file) relative_file = relative_file.relative_path_from(repo) if relative_file.absolute? Utils.popen_read(git, "-C", repo, "show", "#{commit}:#{relative_file}") end |
.git ⇒ Object
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
28 29 30 31 32 |
# File 'utils/git.rb', line 28 def self.git return @git if defined?(@git) @git = HOMEBREW_SHIMS_PATH/"shared/git" end |
.last_revision_commit_of_file(repo, file, before_commit: nil) ⇒ Object
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
46 47 48 49 50 51 52 53 54 |
# File 'utils/git.rb', line 46 def self.last_revision_commit_of_file(repo, file, before_commit: nil) args = if before_commit.nil? ["--skip=1"] else [before_commit.split("..").first] end Utils.popen_read(git, "-C", repo, "log", "--format=%h", "--abbrev=7", "--max-count=1", *args, "--", file).chomp end |
.last_revision_commit_of_files(repo, files, before_commit: nil) ⇒ Object
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 |
# File 'utils/git.rb', line 56 def self.last_revision_commit_of_files(repo, files, before_commit: nil) args = if before_commit.nil? ["--skip=1"] else [before_commit.split("..").first] end # git log output format: # <commit_hash> # <file_path1> # <file_path2> # ... # return [<commit_hash>, [file_path1, file_path2, ...]] rev, *paths = Utils.popen_read( git, "-C", repo, "log", "--pretty=format:%h", "--abbrev=7", "--max-count=1", "--diff-filter=d", "--name-only", *args, "--", *files ).lines.map(&:chomp).reject(&:empty?) [rev, paths] end |
.last_revision_of_file(repo, file, before_commit: nil) ⇒ String
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
81 82 83 84 85 |
# File 'utils/git.rb', line 81 def self.last_revision_of_file(repo, file, before_commit: nil) relative_file = Pathname(file).relative_path_from(repo) commit_hash = last_revision_commit_of_file(repo, relative_file, before_commit: before_commit) file_at_commit(repo, file, commit_hash) end |
.path ⇒ Object
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
21 22 23 24 25 26 |
# File 'utils/git.rb', line 21 def self.path return unless available? return @path if defined?(@path) @path = Utils.popen_read(git, "--homebrew=print-path").chomp.presence end |
.remote_exists?(url) ⇒ Boolean
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
34 35 36 37 38 |
# File 'utils/git.rb', line 34 def self.remote_exists?(url) return true unless available? quiet_system "git", "ls-remote", url end |
.set_name_email!(author: true, committer: true) ⇒ Object
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
113 114 115 116 117 118 119 120 121 122 123 |
# File 'utils/git.rb', line 113 def self.set_name_email!(author: true, committer: true) if Homebrew::EnvConfig.git_name ENV["GIT_AUTHOR_NAME"] = Homebrew::EnvConfig.git_name if ENV["GIT_COMMITTER_NAME"] = Homebrew::EnvConfig.git_name if committer end return unless Homebrew::EnvConfig.git_email ENV["GIT_AUTHOR_EMAIL"] = Homebrew::EnvConfig.git_email if ENV["GIT_COMMITTER_EMAIL"] = Homebrew::EnvConfig.git_email if committer end |
.setup_gpg! ⇒ Object
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
125 126 127 128 129 130 |
# File 'utils/git.rb', line 125 def self.setup_gpg! gnupg_bin = HOMEBREW_PREFIX/"opt/gnupg/bin" return unless gnupg_bin.directory? ENV["PATH"] = PATH.new(ENV.fetch("PATH")).prepend(gnupg_bin).to_s end |
.supports_partial_clone_sparse_checkout? ⇒ Boolean
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
146 147 148 149 150 |
# File 'utils/git.rb', line 146 def self.supports_partial_clone_sparse_checkout? # There is some support for partial clones prior to 2.20, but we avoid using it # due to performance issues Version.new(version) >= Version.new("2.20.0") end |
.version ⇒ Object
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
14 15 16 17 18 19 |
# File 'utils/git.rb', line 14 def self.version return @version if defined?(@version) stdout, _, status = system_command(git, args: ["--version"], verbose: false, print_stderr: false) @version = status.success? ? stdout.chomp[/git version (\d+(?:\.\d+)*)/, 1] : nil end |