Class: Gitlab::Git::Repository
- Inherits:
-
Object
- Object
- Gitlab::Git::Repository
- Includes:
- Popen
- Defined in:
- lib/gitlab_git/repository.rb
Defined Under Namespace
Classes: InvalidBlobName, NoRepository
Constant Summary collapse
- SEARCH_CONTEXT_LINES =
3
- AUTOCRLF_VALUES =
{ "true" => true, "false" => false, "input" => :input }.freeze
Instance Attribute Summary collapse
-
#name ⇒ Object
readonly
Directory name of repo.
-
#path ⇒ Object
readonly
Full path to repo.
-
#root_ref ⇒ Object
Default branch in the repository.
-
#rugged ⇒ Object
readonly
Rugged repo object.
Instance Method Summary collapse
- #archive_file_path(ref, storage_path, format = "tar.gz") ⇒ Object
- #archive_name(ref) ⇒ Object
- #archive_pid_file_path(*args) ⇒ Object
-
#archive_repo(ref, storage_path, format = "tar.gz") ⇒ Object
Archive Project to .tar.gz.
- #autocrlf ⇒ Object
- #autocrlf=(value) ⇒ Object
- #bare? ⇒ Boolean
-
#branch_names ⇒ Object
Returns an Array of branch names sorted by name ASC.
-
#branch_names_contains(commit) ⇒ Object
Returns branch names collection that contains the special commit(SHA1 or name).
-
#branches ⇒ Object
Returns an Array of Branches.
-
#branches_contains(commit) ⇒ Object
Returns branch collection that contains the special commit(SHA1 or name).
-
#checkout(ref, options = {}, start_point = "HEAD") ⇒ Object
Check out the specified ref.
-
#clean(options = {}) ⇒ Object
Mimic the ‘git clean` command and recursively delete untracked files.
-
#commit_count(ref) ⇒ Object
Return total commits count accessible from passed ref.
-
#commits_between(from, to) ⇒ Object
Return a collection of Rugged::Commits between the two SHA arguments.
- #commits_since(from_date) ⇒ Object
-
#delete_branch(branch_name) ⇒ Object
Delete the specified branch from the repository.
-
#diff(from, to, options = {}, *paths) ⇒ Object
Return an array of Diff objects that represent the diff between
from
andto
. -
#diff_text(from, to, options = {}, *paths) ⇒ Object
Return the diff between
from
andto
in a single patch string. -
#discover_default_branch ⇒ Object
Discovers the default branch based on the repository’s available branches.
- #empty? ⇒ Boolean
-
#fetch(remote_name) ⇒ Object
Fetch the specified remote.
-
#find_commits(options = {}) ⇒ Object
Returns commits collection.
-
#format_patch(from, to, options = {}) ⇒ Object
Return a String containing the mbox-formatted diff between
from
andto
. - #has_commits? ⇒ Boolean
-
#heads ⇒ Object
Deprecated.
-
#initialize(path) ⇒ Repository
constructor
‘path’ must be the path to a bare git repository, e.g.
-
#log(options) ⇒ Object
Use the Rugged Walker API to build an array of commits.
-
#lookup(oid_or_ref_name) ⇒ Object
Lookup for rugged object by oid or ref name.
-
#merge(source_name, target_name, options = {}) ⇒ Object
Merge the
source_name
branch into thetarget_name
branch. -
#merge_base_commit(from, to) ⇒ Object
Returns the SHA of the most recent common ancestor of
from
andto
. -
#push(remote_name, *refspecs) ⇒ Object
Push *refspecs to the remote identified by
remote_name
. -
#raw ⇒ Object
Alias to old method for compatibility.
-
#ref_names ⇒ Object
Returns an Array of branch and tag names.
-
#refs_hash ⇒ Object
Get refs hash which key is SHA1 and value is a Rugged::Reference.
-
#remote_add(remote_name, url) ⇒ Object
Add a new remote to this repository.
-
#remote_delete(remote_name) ⇒ Object
Delete the specified remote from this repository.
-
#remote_names ⇒ Object
Return an array of this repository’s remote names.
-
#remote_update(remote_name, options = {}) ⇒ Object
Update the specified remote using the values in the
options
hash. - #repo_exists? ⇒ Boolean
-
#reset(ref, reset_type) ⇒ Object
Sets HEAD to the commit specified by
ref
;ref
can be a branch or tag name or a commit SHA. -
#rev_parse_target(revspec) ⇒ Object
Return the object that
revspec
points to. - #rugged_head ⇒ Object
-
#search_files(query, ref = nil) ⇒ Object
Returns an array of BlobSnippets for files at the specified
ref
that contain thequery
string. - #sha_from_ref(ref) ⇒ Object
-
#size ⇒ Object
Return repo size in megabytes.
-
#submodules(ref) ⇒ Object
Return hash with submodules info for this repository.
-
#tag_names ⇒ Object
Returns an Array of tag names.
-
#tags ⇒ Object
Returns an Array of Tags.
Methods included from Popen
Constructor Details
#initialize(path) ⇒ Repository
‘path’ must be the path to a bare git repository, e.g. /path/to/my-repo.git
30 31 32 33 34 |
# File 'lib/gitlab_git/repository.rb', line 30 def initialize(path) @path = path @name = path.split("/").last @root_ref = discover_default_branch end |
Instance Attribute Details
#name ⇒ Object (readonly)
Directory name of repo
23 24 25 |
# File 'lib/gitlab_git/repository.rb', line 23 def name @name end |
#path ⇒ Object (readonly)
Full path to repo
20 21 22 |
# File 'lib/gitlab_git/repository.rb', line 20 def path @path end |
#root_ref ⇒ Object
Default branch in the repository
17 18 19 |
# File 'lib/gitlab_git/repository.rb', line 17 def root_ref @root_ref end |
#rugged ⇒ Object (readonly)
Rugged repo object
26 27 28 |
# File 'lib/gitlab_git/repository.rb', line 26 def rugged @rugged end |
Instance Method Details
#archive_file_path(ref, storage_path, format = "tar.gz") ⇒ Object
203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 |
# File 'lib/gitlab_git/repository.rb', line 203 def archive_file_path(ref, storage_path, format = "tar.gz") # Build file path name = archive_name(ref) return nil unless name extension = case format when "tar.bz2", "tbz", "tbz2", "tb2", "bz2" "tar.bz2" when "tar" "tar" when "zip" "zip" else # everything else should fall back to tar.gz "tar.gz" end file_name = "#{name}.#{extension}" File.join(storage_path, self.name, file_name) end |
#archive_name(ref) ⇒ Object
194 195 196 197 198 199 200 201 |
# File 'lib/gitlab_git/repository.rb', line 194 def archive_name(ref) ref ||= root_ref commit = Gitlab::Git::Commit.find(self, ref) return nil unless commit project_name = self.name.sub(/\.git\z/, "") file_name = "#{project_name}-#{ref}-#{commit.id}" end |
#archive_pid_file_path(*args) ⇒ Object
225 226 227 |
# File 'lib/gitlab_git/repository.rb', line 225 def archive_pid_file_path(*args) "#{archive_file_path(*args)}.pid" end |
#archive_repo(ref, storage_path, format = "tar.gz") ⇒ Object
Archive Project to .tar.gz
Already packed repo archives stored at app_root/tmp/repositories/<project_name>.git/<project_name>-<ref>-<commit id>.tar.gz
144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 |
# File 'lib/gitlab_git/repository.rb', line 144 def archive_repo(ref, storage_path, format = "tar.gz") ref ||= root_ref file_path = archive_file_path(ref, storage_path, format) return nil unless file_path return file_path if File.exist?(file_path) case format when "tar.bz2", "tbz", "tbz2", "tb2", "bz2" compress_cmd = %W(bzip2) when "tar" compress_cmd = %W(cat) when "zip" git_archive_format = "zip" compress_cmd = %W(cat) else # everything else should fall back to tar.gz compress_cmd = %W(gzip -n) end FileUtils.mkdir_p File.dirname(file_path) pid_file_path = archive_pid_file_path(ref, storage_path, format) return file_path if File.exist?(pid_file_path) File.open(pid_file_path, "w") do |file| file.puts Process.pid end # Create the archive in temp file, to avoid leaving a corrupt archive # to be downloaded by the next user if we get interrupted while # creating the archive. temp_file_path = "#{file_path}.#{Process.pid}-#{Time.now.to_i}" begin archive_to_file(ref, temp_file_path, git_archive_format, compress_cmd) rescue FileUtils.rm(temp_file_path) raise ensure FileUtils.rm(pid_file_path) end # move temp file to persisted location FileUtils.move(temp_file_path, file_path) file_path end |
#autocrlf ⇒ Object
802 803 804 |
# File 'lib/gitlab_git/repository.rb', line 802 def autocrlf AUTOCRLF_VALUES[rugged.config['core.autocrlf']] end |
#autocrlf=(value) ⇒ Object
806 807 808 |
# File 'lib/gitlab_git/repository.rb', line 806 def autocrlf=(value) rugged.config['core.autocrlf'] = AUTOCRLF_VALUES.invert[value] end |
#bare? ⇒ Boolean
106 107 108 |
# File 'lib/gitlab_git/repository.rb', line 106 def rugged. end |
#branch_names ⇒ Object
Returns an Array of branch names sorted by name ASC
49 50 51 |
# File 'lib/gitlab_git/repository.rb', line 49 def branch_names branches.map(&:name) end |
#branch_names_contains(commit) ⇒ Object
Returns branch names collection that contains the special commit(SHA1 or name)
Ex.
repo.branch_names_contains('master')
431 432 433 |
# File 'lib/gitlab_git/repository.rb', line 431 def branch_names_contains(commit) branches_contains(commit).map { |c| c.name } end |
#branches ⇒ Object
Returns an Array of Branches
54 55 56 57 58 59 60 61 62 |
# File 'lib/gitlab_git/repository.rb', line 54 def branches rugged.branches.map do |rugged_ref| begin Branch.new(rugged_ref.name, rugged_ref.target) rescue Rugged::ReferenceError # Omit invalid branch end end.compact.sort_by(&:name) end |
#branches_contains(commit) ⇒ Object
Returns branch collection that contains the special commit(SHA1 or name)
Ex.
repo.branch_names_contains('master')
440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 |
# File 'lib/gitlab_git/repository.rb', line 440 def branches_contains(commit) commit_obj = rugged.rev_parse(commit) parent = commit_obj.parents.first unless commit_obj.parents.empty? walker = Rugged::Walker.new(rugged) rugged.branches.select do |branch| walker.push(branch.target_id) walker.hide(parent) if parent result = walker.any? { |c| c.oid == commit_obj.oid } walker.reset result end end |
#checkout(ref, options = {}, start_point = "HEAD") ⇒ Object
Check out the specified ref. Valid options are:
:b - Create a new branch at +start_point+ and set HEAD to the new
branch.
* These options are passed to the Rugged::Repository#checkout method:
:progress ::
A callback that will be executed for checkout progress notifications.
Up to 3 parameters are passed on each execution:
- The path to the last updated file (or +nil+ on the very first
invocation).
- The number of completed checkout steps.
- The number of total checkout steps to be performed.
:notify ::
A callback that will be executed for each checkout notification
types specified with +:notify_flags+. Up to 5 parameters are passed
on each execution:
- An array containing the +:notify_flags+ that caused the callback
execution.
- The path of the current file.
- A hash describing the baseline blob (or +nil+ if it does not
exist).
- A hash describing the target blob (or +nil+ if it does not exist).
- A hash describing the workdir blob (or +nil+ if it does not
exist).
:strategy ::
A single symbol or an array of symbols representing the strategies
to use when performing the checkout. Possible values are:
:none ::
Perform a dry run (default).
:safe ::
Allow safe updates that cannot overwrite uncommitted data.
:safe_create ::
Allow safe updates plus creation of missing files.
:force ::
Allow all updates to force working directory to look like index.
:allow_conflicts ::
Allow checkout to make safe updates even if conflicts are found.
:remove_untracked ::
Remove untracked files not in index (that are not ignored).
:remove_ignored ::
Remove ignored files not in index.
:update_only ::
Only update existing files, don't create new ones.
:dont_update_index ::
Normally checkout updates index entries as it goes; this stops
that.
:no_refresh ::
Don't refresh index/config/etc before doing checkout.
:disable_pathspec_match ::
Treat pathspec as simple list of exact match file paths.
:skip_locked_directories ::
Ignore directories in use, they will be left empty.
:skip_unmerged ::
Allow checkout to skip unmerged files (NOT IMPLEMENTED).
:use_ours ::
For unmerged files, checkout stage 2 from index (NOT IMPLEMENTED).
:use_theirs ::
For unmerged files, checkout stage 3 from index (NOT IMPLEMENTED).
:update_submodules ::
Recursively checkout submodules with same options (NOT
IMPLEMENTED).
:update_submodules_if_changed ::
Recursively checkout submodules if HEAD moved in super repo (NOT
IMPLEMENTED).
:disable_filters ::
If +true+, filters like CRLF line conversion will be disabled.
:dir_mode ::
Mode for newly created directories. Default: +0755+.
:file_mode ::
Mode for newly created files. Default: +0755+ or +0644+.
:file_open_flags ::
Mode for opening files. Default:
<code>IO::CREAT | IO::TRUNC | IO::WRONLY</code>.
:notify_flags ::
A single symbol or an array of symbols representing the cases in
which the +:notify+ callback should be invoked. Possible values are:
:none ::
Do not invoke the +:notify+ callback (default).
:conflict ::
Invoke the callback for conflicting paths.
:dirty ::
Invoke the callback for "dirty" files, i.e. those that do not need
an update but no longer match the baseline.
:updated ::
Invoke the callback for any file that was changed.
:untracked ::
Invoke the callback for untracked files.
:ignored ::
Invoke the callback for ignored files.
:all ::
Invoke the callback for all these cases.
:paths ::
A glob string or an array of glob strings specifying which paths
should be taken into account for the checkout operation. +nil+ will
match all files. Default: +nil+.
:baseline ::
A Rugged::Tree that represents the current, expected contents of the
workdir. Default: +HEAD+.
:target_directory ::
A path to an alternative workdir directory in which the checkout
should be performed.
694 695 696 697 698 699 700 701 |
# File 'lib/gitlab_git/repository.rb', line 694 def checkout(ref, = {}, start_point = "HEAD") if [:b] rugged.branches.create(ref, start_point) .delete(:b) end = { strategy: :safe_create } rugged.checkout(ref, .merge()) end |
#clean(options = {}) ⇒ Object
Mimic the ‘git clean` command and recursively delete untracked files. Valid keys that can be passed in the options
hash are:
:d - Remove untracked directories :f - Remove untracked directories that are managed by a different
repository
:x - Remove ignored files
The value in options
must evaluate to true for an option to take effect.
Examples:
repo.clean(d: true, f: true) # Enable the -d and -f options
repo.clean(d: false, x: true) # -x is enabled, -d is not
547 548 549 550 551 552 553 |
# File 'lib/gitlab_git/repository.rb', line 547 def clean( = {}) strategies = [:remove_untracked] strategies.push(:force) if [:f] strategies.push(:remove_ignored) if [:x] # TODO: implement this method end |
#commit_count(ref) ⇒ Object
Return total commits count accessible from passed ref
508 509 510 511 512 513 |
# File 'lib/gitlab_git/repository.rb', line 508 def commit_count(ref) walker = Rugged::Walker.new(rugged) walker.sorting(Rugged::SORT_TOPO | Rugged::SORT_REVERSE) walker.push(ref) walker.count end |
#commits_between(from, to) ⇒ Object
Return a collection of Rugged::Commits between the two SHA arguments.
321 322 323 324 325 326 327 328 329 330 331 332 |
# File 'lib/gitlab_git/repository.rb', line 321 def commits_between(from, to) walker = Rugged::Walker.new(rugged) walker.sorting(Rugged::SORT_DATE | Rugged::SORT_REVERSE) walker.push(to) walker.hide(from) commits = walker.to_a walker.reset commits end |
#commits_since(from_date) ⇒ Object
779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 |
# File 'lib/gitlab_git/repository.rb', line 779 def commits_since(from_date) walker = Rugged::Walker.new(rugged) walker.sorting(Rugged::SORT_DATE | Rugged::SORT_REVERSE) rugged.references.each("refs/heads/*") do |ref| walker.push(ref.target_id) end commits = [] walker.each do |commit| break if commit.[:time].to_date < from_date commits.push(commit) end commits end |
#delete_branch(branch_name) ⇒ Object
Delete the specified branch from the repository
704 705 706 |
# File 'lib/gitlab_git/repository.rb', line 704 def delete_branch(branch_name) rugged.branches.delete(branch_name) end |
#diff(from, to, options = {}, *paths) ⇒ Object
Return an array of Diff objects that represent the diff between from
and to
. See Diff::filter_diff_options for the allowed diff options. The options
hash can also include :break_rewrites to split larger rewrites into delete/add pairs.
343 344 345 346 347 |
# File 'lib/gitlab_git/repository.rb', line 343 def diff(from, to, = {}, *paths) diff_patches(from, to, , *paths).map do |p| Gitlab::Git::Diff.new(p) end end |
#diff_text(from, to, options = {}, *paths) ⇒ Object
Return the diff between from
and to
in a single patch string. The options
hash has the same allowed keys as #diff.
351 352 353 354 355 356 357 358 |
# File 'lib/gitlab_git/repository.rb', line 351 def diff_text(from, to, = {}, *paths) # NOTE: It would be simpler to use the Rugged::Diff#patch method, but # that formats the diff text differently than Rugged::Patch#to_s for # changes to binary files. diff_patches(from, to, , *paths).map do |p| p.to_s end.join("\n") end |
#discover_default_branch ⇒ Object
Discovers the default branch based on the repository’s available branches
-
If no branches are present, returns nil
-
If one branch is present, returns its name
-
If two or more branches are present, returns current HEAD or master or first branch
119 120 121 122 123 124 125 126 127 128 129 130 131 |
# File 'lib/gitlab_git/repository.rb', line 119 def discover_default_branch if branch_names.length == 0 nil elsif branch_names.length == 1 branch_names.first elsif rugged_head && branch_names.include?(Ref.extract_branch_name(rugged_head.name)) Ref.extract_branch_name(rugged_head.name) elsif branch_names.include?("master") "master" else branch_names.first end end |
#empty? ⇒ Boolean
102 103 104 |
# File 'lib/gitlab_git/repository.rb', line 102 def empty? rugged.empty? end |
#fetch(remote_name) ⇒ Object
Fetch the specified remote
735 736 737 |
# File 'lib/gitlab_git/repository.rb', line 735 def fetch(remote_name) rugged.remotes[remote_name].fetch end |
#find_commits(options = {}) ⇒ Object
Returns commits collection
Ex.
repo.find_commits(
ref: 'master',
max_count: 10,
skip: 5,
order: :date
)
+options+ is a Hash of optional arguments to git
:ref is the ref from which to begin (SHA1 or name)
:contains is the commit contained by the refs from which to begin (SHA1 or name)
:max_count is the maximum number of commits to fetch
:skip is the number of commits to skip
:order is the commits order and allowed value is :date(default) or :topo
377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 |
# File 'lib/gitlab_git/repository.rb', line 377 def find_commits( = {}) = .dup = [:ref, :max_count, :skip, :contains, :order] .keep_if do |key| .include?(key) end = { skip: 0 } = .merge() walker = Rugged::Walker.new(rugged) if [:ref] walker.push(rugged.rev_parse_oid([:ref])) elsif [:contains] branches_contains([:contains]).each do |branch| walker.push(branch.target_id) end else rugged.references.each("refs/heads/*") do |ref| walker.push(ref.target_id) end end if [:order] == :topo walker.sorting(Rugged::SORT_TOPO) else walker.sorting(Rugged::SORT_DATE) end commits = [] offset = [:skip] limit = [:max_count] walker.each(offset: offset, limit: limit) do |commit| gitlab_commit = Gitlab::Git::Commit.decorate(commit) commits.push(gitlab_commit) end walker.reset commits rescue Rugged::OdbError [] end |
#format_patch(from, to, options = {}) ⇒ Object
Return a String containing the mbox-formatted diff between from
and to
. See #diff for the allowed keys in the options
hash.
746 747 748 749 750 751 752 753 754 755 756 |
# File 'lib/gitlab_git/repository.rb', line 746 def format_patch(from, to, = {}) ||= {} break_rewrites = [:break_rewrites] = Diff.() from_sha = rugged.rev_parse_oid(from) to_sha = rugged.rev_parse_oid(to) commits_between(from_sha, to_sha).map do |commit| commit.to_mbox() end.join("\n") end |
#has_commits? ⇒ Boolean
98 99 100 |
# File 'lib/gitlab_git/repository.rb', line 98 def has_commits? !empty? end |
#heads ⇒ Object
Deprecated. Will be removed in 5.2
92 93 94 95 96 |
# File 'lib/gitlab_git/repository.rb', line 92 def heads rugged.references.each("refs/heads/*").map do |head| Gitlab::Git::Ref.new(head.name, head.target) end.sort_by(&:name) end |
#log(options) ⇒ Object
Use the Rugged Walker API to build an array of commits.
Usage.
repo.log(
ref: 'master',
path: 'app/models',
limit: 10,
offset: 5,
)
266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 |
# File 'lib/gitlab_git/repository.rb', line 266 def log() = { limit: 10, offset: 0, path: nil, ref: root_ref, follow: false, skip_merges: false } = .merge() [:limit] ||= 0 [:offset] ||= 0 actual_ref = [:ref] || root_ref begin sha = sha_from_ref(actual_ref) rescue Rugged::OdbError, Rugged::InvalidError, Rugged::ReferenceError # Return an empty array if the ref wasn't found return [] end repo = [:repo] cmd = %W(git --git-dir=#{path} log) cmd += %W(-n #{[:limit].to_i}) cmd += %W(--format=%H) cmd += %W(--skip=#{[:offset].to_i}) cmd += %W(--follow) if [:follow] cmd += %W(--no-merges) if [:skip_merges] cmd += [sha] cmd += %W(-- #{[:path]}) if [:path] raw_output = IO.popen(cmd) {|io| io.read } log = raw_output.lines.map do |c| Rugged::Commit.new(rugged, c.strip) end log.is_a?(Array) ? log : [] end |
#lookup(oid_or_ref_name) ⇒ Object
Lookup for rugged object by oid or ref name
476 477 478 |
# File 'lib/gitlab_git/repository.rb', line 476 def lookup(oid_or_ref_name) rugged.rev_parse(oid_or_ref_name) end |
#merge(source_name, target_name, options = {}) ⇒ Object
Merge the source_name
branch into the target_name
branch. This is equivalent to ‘git merge –no_ff source_name
`, since a merge commit is always created.
761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 |
# File 'lib/gitlab_git/repository.rb', line 761 def merge(source_name, target_name, = {}) our_commit = rugged.branches[target_name].target their_commit = rugged.branches[source_name].target raise "Invalid merge target" if our_commit.nil? raise "Invalid merge source" if their_commit.nil? merge_index = rugged.merge_commits(our_commit, their_commit) return false if merge_index.conflicts? = .merge( parents: [our_commit, their_commit], tree: merge_index.write_tree(rugged), update_ref: "refs/heads/#{target_name}" ) Rugged::Commit.create(rugged, ) end |
#merge_base_commit(from, to) ⇒ Object
Returns the SHA of the most recent common ancestor of from
and to
335 336 337 |
# File 'lib/gitlab_git/repository.rb', line 335 def merge_base_commit(from, to) rugged.merge_base(from, to) end |
#push(remote_name, *refspecs) ⇒ Object
Push *refspecs to the remote identified by remote_name
.
740 741 742 |
# File 'lib/gitlab_git/repository.rb', line 740 def push(remote_name, *refspecs) rugged.remotes[remote_name].push(refspecs) end |
#raw ⇒ Object
Alias to old method for compatibility
37 38 39 |
# File 'lib/gitlab_git/repository.rb', line 37 def raw rugged end |
#ref_names ⇒ Object
Returns an Array of branch and tag names
87 88 89 |
# File 'lib/gitlab_git/repository.rb', line 87 def ref_names branch_names + tag_names end |
#refs_hash ⇒ Object
Get refs hash which key is SHA1 and value is a Rugged::Reference
458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 |
# File 'lib/gitlab_git/repository.rb', line 458 def refs_hash # Initialize only when first call if @refs_hash.nil? @refs_hash = Hash.new { |h, k| h[k] = [] } rugged.references.each do |r| # Symbolic/remote references may not have an OID; skip over them target_oid = r.target.try(:oid) if target_oid sha = rev_parse_target(target_oid).oid @refs_hash[sha] << r end end end @refs_hash end |
#remote_add(remote_name, url) ⇒ Object
Add a new remote to this repository. Returns a Rugged::Remote object
719 720 721 |
# File 'lib/gitlab_git/repository.rb', line 719 def remote_add(remote_name, url) rugged.remotes.create(remote_name, url) end |
#remote_delete(remote_name) ⇒ Object
Delete the specified remote from this repository.
714 715 716 |
# File 'lib/gitlab_git/repository.rb', line 714 def remote_delete(remote_name) rugged.remotes.delete(remote_name) end |
#remote_names ⇒ Object
Return an array of this repository’s remote names
709 710 711 |
# File 'lib/gitlab_git/repository.rb', line 709 def remote_names rugged.remotes.each_name.to_a end |
#remote_update(remote_name, options = {}) ⇒ Object
Update the specified remote using the values in the options
hash
Example repo.update_remote(“origin”, url: “path/to/repo”)
727 728 729 730 731 732 |
# File 'lib/gitlab_git/repository.rb', line 727 def remote_update(remote_name, = {}) # TODO: Implement other remote options remote = rugged.remotes[remote_name] remote.url = [:url] if [:url] remote.save end |
#repo_exists? ⇒ Boolean
110 111 112 |
# File 'lib/gitlab_git/repository.rb', line 110 def repo_exists? !!rugged end |
#reset(ref, reset_type) ⇒ Object
Sets HEAD to the commit specified by ref
; ref
can be a branch or tag name or a commit SHA. Valid reset_type
values are:
[:soft]
the head will be moved to the commit.
[:mixed]
will trigger a +:soft+ reset, plus the index will be replaced
with the content of the commit tree.
[:hard]
will trigger a +:mixed+ reset and the working directory will be
replaced with the content of the index. (Untracked and ignored files
will be left alone)
527 528 529 |
# File 'lib/gitlab_git/repository.rb', line 527 def reset(ref, reset_type) rugged.reset(ref, reset_type) end |
#rev_parse_target(revspec) ⇒ Object
Return the object that revspec
points to. If revspec
is an annotated tag, then return the tag’s target instead.
313 314 315 316 317 |
# File 'lib/gitlab_git/repository.rb', line 313 def rev_parse_target(revspec) obj = rugged.rev_parse(revspec) obj = obj.target while obj.is_a?(Rugged::Tag::Annotation) obj end |
#rugged_head ⇒ Object
133 134 135 136 137 |
# File 'lib/gitlab_git/repository.rb', line 133 def rugged_head rugged.head rescue Rugged::ReferenceError nil end |
#search_files(query, ref = nil) ⇒ Object
Returns an array of BlobSnippets for files at the specified ref
that contain the query
string.
237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 |
# File 'lib/gitlab_git/repository.rb', line 237 def search_files(query, ref = nil) greps = [] ref ||= root_ref populated_index(ref).each do |entry| # Discard submodules next if submodule?(entry) content = Blob.raw(self, entry[:oid]).data # Skip binary files next if content.encoding == Encoding::ASCII_8BIT greps += build_greps(content, query, ref, entry[:path]) end greps end |
#sha_from_ref(ref) ⇒ Object
307 308 309 |
# File 'lib/gitlab_git/repository.rb', line 307 def sha_from_ref(ref) rev_parse_target(ref).oid end |
#size ⇒ Object
Return repo size in megabytes
230 231 232 233 |
# File 'lib/gitlab_git/repository.rb', line 230 def size size = popen(%W(du -s), path).first.strip.to_i (size.to_f / 1024).round(2) end |
#submodules(ref) ⇒ Object
Return hash with submodules info for this repository
Ex.
{
"rack" => {
"id" => "c67be4624545b4263184c4a0e8f887efd0a66320",
"path" => "rack",
"url" => "git://github.com/chneukirchen/rack.git"
},
"encoding" => {
"id" => ....
}
}
494 495 496 497 498 499 500 501 502 503 504 505 |
# File 'lib/gitlab_git/repository.rb', line 494 def submodules(ref) commit = rev_parse_target(ref) return {} unless commit begin content = blob_content(commit, ".gitmodules") rescue InvalidBlobName return {} end parse_gitmodules(commit, content) end |
#tag_names ⇒ Object
Returns an Array of tag names
65 66 67 |
# File 'lib/gitlab_git/repository.rb', line 65 def tag_names rugged..map { |t| t.name } end |
#tags ⇒ Object
Returns an Array of Tags
70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 |
# File 'lib/gitlab_git/repository.rb', line 70 def rugged.references.each("refs/tags/*").map do |ref| = nil if ref.target.is_a?(Rugged::Tag::Annotation) = ref.target. if .respond_to?(:chomp) = .chomp end end Tag.new(ref.name, ref.target, ) end.sort_by(&:name) end |