Class: Grit::Repo
- Inherits:
-
Object
- Object
- Grit::Repo
- Defined in:
- lib/grit/repo.rb
Constant Summary collapse
Instance Attribute Summary collapse
-
#bare ⇒ Object
readonly
Public: The Boolean of whether or not the repo is bare.
-
#git ⇒ Object
Public: The Grit::Git command line interface object.
-
#path ⇒ Object
Public: The String path of the Git repo.
-
#working_dir ⇒ Object
Public: The String path to the working directory of the repo, or nil if there is no working directory.
Class Method Summary collapse
-
.init(path, git_options = {}, repo_options = {}) ⇒ Object
Public: Initialize a git repository (create it on the filesystem).
-
.init_bare(path, git_options = {}, repo_options = {}) ⇒ Object
Public: Initialize a bare git repository (create it on the filesystem).
-
.init_bare_or_open(path, git_options = {}, repo_options = {}) ⇒ Object
Public: Initialize a bare Git repository (create it on the filesystem) or, if the repo already exists, simply return it.
Instance Method Summary collapse
-
#add(*files) ⇒ Object
Adds files to the index.
-
#alternates ⇒ Object
The list of alternates for this repo.
-
#alternates=(alts) ⇒ Object
Sets the alternates
alts
is the Array of String paths representing the alternates. -
#archive_tar(treeish = 'master', prefix = nil) ⇒ Object
Archive the given treeish
treeish
is the treeish name/id (default ‘master’)prefix
is the optional prefix. -
#archive_tar_gz(treeish = 'master', prefix = nil) ⇒ Object
Archive and gzip the given treeish
treeish
is the treeish name/id (default ‘master’)prefix
is the optional prefix. -
#archive_to_file(treeish = 'master', prefix = nil, filename = 'archive.tar.gz', format = nil, pipe = "gzip") ⇒ Object
Write an archive directly to a file
treeish
is the treeish name/id (default ‘master’)prefix
is the optional prefix (default nil)filename
is the name of the file (default ‘archive.tar.gz’)format
is the optional format (default nil)pipe
is the command to run the output through (default ‘gzip’). -
#batch(*shas) ⇒ Object
Public: Return the full Git objects from the given SHAs.
- #blame(file, commit = nil) ⇒ Object
- #blame_tree(commit, path = nil) ⇒ Object
-
#blob(id) ⇒ Object
The Blob object for the given id
id
is the SHA1 id of the blob. -
#commit(id) ⇒ Object
The Commit object for the specified id
id
is the SHA1 identifier of the commit. -
#commit_all(message) ⇒ Object
Commits all tracked and modified files.
-
#commit_count(start = 'master') ⇒ Object
The number of commits reachable by the given branch/commit
start
is the branch/commit name (default ‘master’). -
#commit_deltas_from(other_repo, ref = "master", other_ref = "master") ⇒ Object
Returns a list of commits that is in
other_repo
but not in self. -
#commit_diff(commit) ⇒ Object
The commit diff for the given commit
commit
is the commit name/id. -
#commit_index(message) ⇒ Object
Commits current index.
- #commit_objects(refs) ⇒ Object
- #commit_stats(start = 'master', max_count = 10, skip = 0) ⇒ Object
-
#commits(start = 'master', max_count = 10, skip = 0) ⇒ Object
An array of Commit objects representing the history of a given ref/commit
start
is the branch/commit name (default ‘master’)max_count
is the maximum number of commits to return (default 10, usefalse
for all)skip
is the number of commits to skip (default 0). -
#commits_between(from, to) ⇒ Object
The Commits objects that are reachable via
to
but not viafrom
Commits are returned in chronological order. -
#commits_since(start = 'master', since = '1970-01-01', extra_options = {}) ⇒ Object
The Commits objects that are newer than the specified date.
- #config ⇒ Object
-
#description ⇒ Object
The project’s description.
-
#diff(a, b, *paths) ⇒ Object
The diff from commit
a
to commitb
, optionally restricted to the given file(s)a
is the base commitb
is the other commitpaths
is an optional list of file paths on which to restrict the diff. - #diff_objects(commit_sha, parents = true) ⇒ Object
-
#disable_daemon_serve ⇒ Object
Disable git-daemon serving of this repository by ensuring there is no git-daemon-export-ok file in its git directory.
-
#enable_daemon_serve ⇒ Object
Enable git-daemon serving of this repository by writing the git-daemon-export-ok file to its git directory.
-
#fork_bare(path, options = {}) ⇒ Object
Public: Create a bare fork of this repository.
-
#fork_bare_from(path, options = {}) ⇒ Object
Public: Fork a bare git repository from another repo.
- #gc_auto ⇒ Object
- #get_head(head_name) ⇒ Object
-
#head ⇒ Object
Object reprsenting the current repo head.
-
#heads ⇒ Object
(also: #branches)
An array of Head objects representing the branch heads in this repo.
- #index ⇒ Object
-
#initialize(path, options = {}) ⇒ Repo
constructor
Public: Create a new Repo instance.
-
#inspect ⇒ Object
Pretty object inspection.
- #is_head?(head_name) ⇒ Boolean
-
#log(commit = 'master', path = nil, options = {}) ⇒ Object
The commit log for a treeish.
- #objects(refs) ⇒ Object
- #objects_between(ref1, ref2 = nil) ⇒ Object
-
#parse_batch(text) ⇒ Object
Parses ‘git cat-file –batch` output, returning an array of Grit objects.
-
#recent_tag_name(committish = nil, options = {}) ⇒ Object
Finds the most recent annotated tag name that is reachable from a commit.
-
#refs ⇒ Object
An array of Ref objects representing the refs in this repo.
- #remote_add(name, url) ⇒ Object
- #remote_fetch(name) ⇒ Object
- #remote_list ⇒ Object
-
#remotes ⇒ Object
An array of Remote objects representing the remote branches in this repo.
-
#remotes_fetch_needed(remotes) ⇒ Object
takes an array of remote names and last pushed dates fetches from all of the remotes where the local fetch date is earlier than the passed date, then records the last fetched date.
-
#remove(*files) ⇒ Object
Remove files from the index.
-
#rename(name) ⇒ Object
Rename the current repository directory.
- #status ⇒ Object
-
#tags ⇒ Object
An array of Tag objects that are available in this repo.
-
#tree(treeish = 'master', paths = []) ⇒ Object
The Tree object for the given treeish reference
treeish
is the reference (default ‘master’)paths
is an optional Array of directory paths to restrict the tree (deafult []). - #update_ref(head, commit_sha) ⇒ Object
Constructor Details
#initialize(path, options = {}) ⇒ Repo
Public: Create a new Repo instance.
path - The String path to either the root git directory or the bare
git repo. Bare repos are expected to end with ".git".
options - A Hash of options (default: {}):
:is_bare - Boolean whether to consider the repo as bare even
if the repo name does not end with ".git".
Examples
r = Repo.new("/Users/tom/dev/normal")
r = Repo.new("/Users/tom/public/bare.git")
r = Repo.new("/Users/tom/public/bare", {:is_bare => true})
Returns a newly initialized Grit::Repo. Raises Grit::InvalidGitRepositoryError if the path exists but is not
a Git repository.
Raises Grit::NoSuchPathError if the path does not exist.
40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 |
# File 'lib/grit/repo.rb', line 40 def initialize(path, = {}) epath = File.(path) if File.exist?(File.join(epath, '.git')) self.working_dir = epath self.path = File.join(epath, '.git') @bare = false elsif File.exist?(epath) && (epath =~ /\.git$/ || [:is_bare]) self.path = epath @bare = true elsif File.exist?(epath) raise InvalidGitRepositoryError.new(epath) else raise NoSuchPathError.new(epath) end self.git = Git.new(self.path) end |
Instance Attribute Details
#bare ⇒ Object (readonly)
Public: The Boolean of whether or not the repo is bare.
17 18 19 |
# File 'lib/grit/repo.rb', line 17 def @bare end |
#git ⇒ Object
Public: The Grit::Git command line interface object.
20 21 22 |
# File 'lib/grit/repo.rb', line 20 def git @git end |
#path ⇒ Object
Public: The String path of the Git repo.
10 11 12 |
# File 'lib/grit/repo.rb', line 10 def path @path end |
#working_dir ⇒ Object
Public: The String path to the working directory of the repo, or nil if there is no working directory.
14 15 16 |
# File 'lib/grit/repo.rb', line 14 def working_dir @working_dir end |
Class Method Details
.init(path, git_options = {}, repo_options = {}) ⇒ Object
Public: Initialize a git repository (create it on the filesystem). By default, the newly created repository will contain a working directory. If you would like to create a bare repo, use Grit::Repo.init_bare.
path - The String full path to the repo. Traditionally ends with
"/<name>.git".
git_options - A Hash of additional options to the git init command
(default: {}).
repo_options - A Hash of additional options to the Grit::Repo.new call
(default: {}).
Examples
Grit::Repo.init('/var/git/myrepo.git')
Returns the newly created Grit::Repo.
75 76 77 78 79 80 81 |
# File 'lib/grit/repo.rb', line 75 def self.init(path, = {}, = {}) = {:base => false}.merge() git = Git.new(path) git.fs_mkdir('..') git.init(, path) self.new(path, ) end |
.init_bare(path, git_options = {}, repo_options = {}) ⇒ Object
Public: Initialize a bare git repository (create it on the filesystem).
path - The String full path to the repo. Traditionally ends with
"/<name>.git".
git_options - A Hash of additional options to the git init command
(default: {}).
repo_options - A Hash of additional options to the Grit::Repo.new call
(default: {}).
Examples
Grit::Repo.('/var/git/myrepo.git')
Returns the newly created Grit::Repo.
97 98 99 100 101 102 103 104 |
# File 'lib/grit/repo.rb', line 97 def self.(path, = {}, = {}) = {:bare => true}.merge() git = Git.new(path) git.fs_mkdir('..') git.init() = {:is_bare => true}.merge() self.new(path, ) end |
.init_bare_or_open(path, git_options = {}, repo_options = {}) ⇒ Object
Public: Initialize a bare Git repository (create it on the filesystem) or, if the repo already exists, simply return it.
path - The String full path to the repo. Traditionally ends with
"/<name>.git".
git_options - A Hash of additional options to the git init command
(default: {}).
repo_options - A Hash of additional options to the Grit::Repo.new call
(default: {}).
Returns the new or existing Grit::Repo.
117 118 119 120 121 122 123 124 125 126 |
# File 'lib/grit/repo.rb', line 117 def self.(path, = {}, = {}) git = Git.new(path) unless git.exist? git.fs_mkdir(path) git.init() end self.new(path, ) end |
Instance Method Details
#add(*files) ⇒ Object
Adds files to the index
248 249 250 |
# File 'lib/grit/repo.rb', line 248 def add(*files) self.git.add({}, *files.flatten) end |
#alternates ⇒ Object
The list of alternates for this repo
Returns Array (pathnames of alternates)
598 599 600 601 602 603 |
# File 'lib/grit/repo.rb', line 598 def alternates alternates_path = "objects/info/alternates" self.git.fs_read(alternates_path).strip.split("\n") rescue Errno::ENOENT [] end |
#alternates=(alts) ⇒ Object
Sets the alternates
+alts+ is the Array of String paths representing the alternates
Returns nothing
609 610 611 612 613 614 615 616 617 618 619 620 621 |
# File 'lib/grit/repo.rb', line 609 def alternates=(alts) alts.each do |alt| unless File.exist?(alt) raise "Could not set alternates. Alternate path #{alt} must exist" end end if alts.empty? self.git.fs_write('objects/info/alternates', '') else self.git.fs_write('objects/info/alternates', alts.join("\n")) end end |
#archive_tar(treeish = 'master', prefix = nil) ⇒ Object
Archive the given treeish
+treeish+ is the treeish name/id (default 'master')
+prefix+ is the optional prefix
Examples
repo.archive_tar
# => <String containing tar archive>
repo.archive_tar('a87ff14')
# => <String containing tar archive for commit a87ff14>
repo.archive_tar('master', 'myproject/')
# => <String containing tar archive and prefixed with 'myproject/'>
Returns String (containing tar archive)
533 534 535 536 537 |
# File 'lib/grit/repo.rb', line 533 def archive_tar(treeish = 'master', prefix = nil) = {} [:prefix] = prefix if prefix self.git.archive(, treeish) end |
#archive_tar_gz(treeish = 'master', prefix = nil) ⇒ Object
Archive and gzip the given treeish
+treeish+ is the treeish name/id (default 'master')
+prefix+ is the optional prefix
Examples
repo.archive_tar_gz
# => <String containing tar.gz archive>
repo.archive_tar_gz('a87ff14')
# => <String containing tar.gz archive for commit a87ff14>
repo.archive_tar_gz('master', 'myproject/')
# => <String containing tar.gz archive and prefixed with 'myproject/'>
Returns String (containing tar.gz archive)
554 555 556 557 558 |
# File 'lib/grit/repo.rb', line 554 def archive_tar_gz(treeish = 'master', prefix = nil) = {} [:prefix] = prefix if prefix self.git.archive(, treeish, "| gzip -n") end |
#archive_to_file(treeish = 'master', prefix = nil, filename = 'archive.tar.gz', format = nil, pipe = "gzip") ⇒ Object
Write an archive directly to a file
+treeish+ is the treeish name/id (default 'master')
+prefix+ is the optional prefix (default nil)
+filename+ is the name of the file (default 'archive.tar.gz')
+format+ is the optional format (default nil)
+pipe+ is the command to run the output through (default 'gzip')
Returns nothing
568 569 570 571 572 573 |
# File 'lib/grit/repo.rb', line 568 def archive_to_file(treeish = 'master', prefix = nil, filename = 'archive.tar.gz', format = nil, pipe = "gzip") = {} [:prefix] = prefix if prefix [:format] = format if format self.git.archive(, treeish, "| #{pipe} > #{filename}") end |
#batch(*shas) ⇒ Object
Public: Return the full Git objects from the given SHAs. Only Commit objects are parsed for now.
*shas - Array of String SHAs.
Returns an Array of Grit objects (Grit::Commit).
168 169 170 171 172 |
# File 'lib/grit/repo.rb', line 168 def batch(*shas) shas.flatten! text = git.native(:cat_file, {:batch => true, :input => (shas * "\n")}) parse_batch(text) end |
#blame(file, commit = nil) ⇒ Object
203 204 205 |
# File 'lib/grit/repo.rb', line 203 def blame(file, commit = nil) Blame.new(self, file, commit) end |
#blame_tree(commit, path = nil) ⇒ Object
258 259 260 261 262 263 264 265 266 |
# File 'lib/grit/repo.rb', line 258 def blame_tree(commit, path = nil) commit_array = self.git.blame_tree(commit, path) final_array = {} commit_array.each do |file, sha| final_array[file] = commit(sha) end final_array end |
#blob(id) ⇒ Object
The Blob object for the given id
+id+ is the SHA1 id of the blob
Returns Grit::Blob (unbaked)
480 481 482 |
# File 'lib/grit/repo.rb', line 480 def blob(id) Blob.create(self, :id => id) end |
#commit(id) ⇒ Object
The Commit object for the specified id
+id+ is the SHA1 identifier of the commit
Returns Grit::Commit (baked)
403 404 405 406 407 |
# File 'lib/grit/repo.rb', line 403 def commit(id) = {:max_count => 1} Commit.find_all(self, id, ).first end |
#commit_all(message) ⇒ Object
Commits all tracked and modified files
Returns true/false if commit worked
243 244 245 |
# File 'lib/grit/repo.rb', line 243 def commit_all() self.git.commit({}, '-a', '-m', ) end |
#commit_count(start = 'master') ⇒ Object
The number of commits reachable by the given branch/commit
+start+ is the branch/commit name (default 'master')
Returns Integer
395 396 397 |
# File 'lib/grit/repo.rb', line 395 def commit_count(start = 'master') Commit.count(self, start) end |
#commit_deltas_from(other_repo, ref = "master", other_ref = "master") ⇒ Object
Returns a list of commits that is in other_repo
but not in self
Returns Grit::Commit[]
412 413 414 415 416 417 418 419 420 421 |
# File 'lib/grit/repo.rb', line 412 def commit_deltas_from(other_repo, ref = "master", other_ref = "master") # TODO: we should be able to figure out the branch point, rather than # rev-list'ing the whole thing repo_refs = self.git.rev_list({}, ref).strip.split("\n") other_repo_refs = other_repo.git.rev_list({}, other_ref).strip.split("\n") (other_repo_refs - repo_refs).map do |ref| Commit.find_all(other_repo, ref, {:max_count => 1}).first end end |
#commit_diff(commit) ⇒ Object
The commit diff for the given commit
+commit+ is the commit name/id
Returns Grit::Diff[]
514 515 516 |
# File 'lib/grit/repo.rb', line 514 def commit_diff(commit) Commit.diff(self, commit) end |
#commit_index(message) ⇒ Object
Commits current index
Returns true/false if commit worked
236 237 238 |
# File 'lib/grit/repo.rb', line 236 def commit_index() self.git.commit({}, '-m', ) end |
#commit_objects(refs) ⇒ Object
430 431 432 433 434 435 |
# File 'lib/grit/repo.rb', line 430 def commit_objects(refs) Grit.no_quote = true obj = self.git.rev_list({:timeout => false}, refs).split("\n").map { |a| a[0, 40] } Grit.no_quote = false obj end |
#commit_stats(start = 'master', max_count = 10, skip = 0) ⇒ Object
348 349 350 351 352 353 |
# File 'lib/grit/repo.rb', line 348 def commit_stats(start = 'master', max_count = 10, skip = 0) = {:max_count => max_count, :skip => skip} CommitStats.find_all(self, start, ) end |
#commits(start = 'master', max_count = 10, skip = 0) ⇒ Object
An array of Commit objects representing the history of a given ref/commit
+start+ is the branch/commit name (default 'master')
+max_count+ is the maximum number of commits to return (default 10, use +false+ for all)
+skip+ is the number of commits to skip (default 0)
Returns Grit::Commit[] (baked)
361 362 363 364 365 366 |
# File 'lib/grit/repo.rb', line 361 def commits(start = 'master', max_count = 10, skip = 0) = {:max_count => max_count, :skip => skip} Commit.find_all(self, start, ) end |
#commits_between(from, to) ⇒ Object
The Commits objects that are reachable via to
but not via from
Commits are returned in chronological order.
+from+ is the branch/commit name of the younger item
+to+ is the branch/commit name of the older item
Returns Grit::Commit[] (baked)
374 375 376 |
# File 'lib/grit/repo.rb', line 374 def commits_between(from, to) Commit.find_all(self, "#{from}..#{to}").reverse end |
#commits_since(start = 'master', since = '1970-01-01', extra_options = {}) ⇒ Object
The Commits objects that are newer than the specified date. Commits are returned in chronological order.
+start+ is the branch/commit name (default 'master')
+since+ is a string represeting a date/time
+extra_options+ is a hash of extra options
Returns Grit::Commit[] (baked)
385 386 387 388 389 |
# File 'lib/grit/repo.rb', line 385 def commits_since(start = 'master', since = '1970-01-01', = {}) = {:since => since}.merge() Commit.find_all(self, start, ) end |
#config ⇒ Object
623 624 625 |
# File 'lib/grit/repo.rb', line 623 def config @config ||= Config.new(self) end |
#description ⇒ Object
The project’s description. Taken verbatim from GIT_REPO/description
Returns String
199 200 201 |
# File 'lib/grit/repo.rb', line 199 def description self.git.fs_read('description').chomp end |
#diff(a, b, *paths) ⇒ Object
The diff from commit a
to commit b
, optionally restricted to the given file(s)
+a+ is the base commit
+b+ is the other commit
+paths+ is an optional list of file paths on which to restrict the diff
499 500 501 502 503 504 505 506 507 508 |
# File 'lib/grit/repo.rb', line 499 def diff(a, b, *paths) diff = self.git.native('diff', {}, a, b, '--', *paths) if diff =~ /diff --git a/ diff = diff.sub(/.*?(diff --git a)/m, '\1') else diff = '' end Diff.list_from_string(self, diff) end |
#diff_objects(commit_sha, parents = true) ⇒ Object
446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 |
# File 'lib/grit/repo.rb', line 446 def diff_objects(commit_sha, parents = true) revs = [] Grit.no_quote = true if parents # PARENTS: cmd = "-r -t -m #{commit_sha}" revs = self.git.diff_tree({:timeout => false}, cmd).strip.split("\n").map{ |a| r = a.split(' '); r[3] if r[1] != '160000' } else # NO PARENTS: cmd = "-r -t #{commit_sha}" revs = self.git.native(:ls_tree, {:timeout => false, :r => true, :t => true}, commit_sha). split("\n").map{ |a| a.split("\t").first.split(' ')[2] } end revs << self.commit(commit_sha).tree.id Grit.no_quote = false return revs.uniq.compact end |
#disable_daemon_serve ⇒ Object
Disable git-daemon serving of this repository by ensuring there is no git-daemon-export-ok file in its git directory
Returns nothing
587 588 589 |
# File 'lib/grit/repo.rb', line 587 def disable_daemon_serve self.git.fs_delete(DAEMON_EXPORT_FILE) end |
#enable_daemon_serve ⇒ Object
Enable git-daemon serving of this repository by writing the git-daemon-export-ok file to its git directory
Returns nothing
579 580 581 |
# File 'lib/grit/repo.rb', line 579 def enable_daemon_serve self.git.fs_write(DAEMON_EXPORT_FILE, '') end |
#fork_bare(path, options = {}) ⇒ Object
Public: Create a bare fork of this repository.
path - The String full path of where to create the new fork.
Traditionally ends with "/<name>.git".
options - The Hash of additional options to the git clone command.
These options will be merged on top of the default Hash:
{:bare => true, :shared => true}.
Returns the newly forked Grit::Repo.
137 138 139 140 141 142 143 |
# File 'lib/grit/repo.rb', line 137 def (path, = {}) = {:bare => true, :shared => true} = .merge() Git.new(path).fs_mkdir('..') self.git.clone(, self.path, path) Repo.new(path) end |
#fork_bare_from(path, options = {}) ⇒ Object
Public: Fork a bare git repository from another repo.
path - The String full path of the repo from which to fork..
Traditionally ends with "/<name>.git".
options - The Hash of additional options to the git clone command.
These options will be merged on top of the default Hash:
{:bare => true, :shared => true}.
Returns the newly forked Grit::Repo.
154 155 156 157 158 159 160 |
# File 'lib/grit/repo.rb', line 154 def (path, = {}) = {:bare => true, :shared => true} = .merge() Git.new(self.path).fs_mkdir('..') self.git.clone(, path, self.path) Repo.new(self.path) end |
#gc_auto ⇒ Object
591 592 593 |
# File 'lib/grit/repo.rb', line 591 def gc_auto self.git.gc({:auto => true}) end |
#get_head(head_name) ⇒ Object
217 218 219 |
# File 'lib/grit/repo.rb', line 217 def get_head(head_name) heads.find { |h| h.name == head_name } end |
#head ⇒ Object
Object reprsenting the current repo head.
Returns Grit::Head (baked)
228 229 230 |
# File 'lib/grit/repo.rb', line 228 def head Head.current(self) end |
#heads ⇒ Object Also known as: branches
An array of Head objects representing the branch heads in this repo
Returns Grit::Head[] (baked)
211 212 213 |
# File 'lib/grit/repo.rb', line 211 def heads Head.find_all(self) end |
#inspect ⇒ Object
Pretty object inspection
650 651 652 |
# File 'lib/grit/repo.rb', line 650 def inspect %Q{#<Grit::Repo "#{@path}">} end |
#is_head?(head_name) ⇒ Boolean
221 222 223 |
# File 'lib/grit/repo.rb', line 221 def is_head?(head_name) get_head(head_name) end |
#log(commit = 'master', path = nil, options = {}) ⇒ Object
The commit log for a treeish
Returns Grit::Commit[]
487 488 489 490 491 492 493 |
# File 'lib/grit/repo.rb', line 487 def log(commit = 'master', path = nil, = {}) = {:pretty => "raw"} = .merge() arg = path ? [commit, '--', path] : [commit] commits = self.git.log(, *arg) Commit.list_from_string(self, commits) end |
#objects(refs) ⇒ Object
423 424 425 426 427 428 |
# File 'lib/grit/repo.rb', line 423 def objects(refs) Grit.no_quote = true obj = self.git.rev_list({:objects => true, :timeout => false}, refs).split("\n").map { |a| a[0, 40] } Grit.no_quote = false obj end |
#objects_between(ref1, ref2 = nil) ⇒ Object
437 438 439 440 441 442 443 444 |
# File 'lib/grit/repo.rb', line 437 def objects_between(ref1, ref2 = nil) if ref2 refs = "#{ref2}..#{ref1}" else refs = ref1 end self.objects(refs) end |
#parse_batch(text) ⇒ Object
Parses ‘git cat-file –batch` output, returning an array of Grit objects.
text - Raw String output.
Returns an Array of Grit objects (Grit::Commit).
179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 |
# File 'lib/grit/repo.rb', line 179 def parse_batch(text) io = StringIO.new(text) objects = [] while line = io.gets sha, type, size = line.split(" ", 3) parser = BATCH_PARSERS[type] if type == 'missing' || !parser objects << nil next end object = io.read(size.to_i + 1) objects << parser.parse_batch(self, sha, size, object) end objects end |
#recent_tag_name(committish = nil, options = {}) ⇒ Object
Finds the most recent annotated tag name that is reachable from a commit.
@repo.recent_tag_name('master')
# => "v1.0-0-abcdef"
committish - optional commit SHA, branch, or tag name. options - optional hash of options to pass to git.
Default: {:always => true}
:tags => true # use lightweight tags too.
:abbrev => Integer # number of hex digits to form the unique
name. Defaults to 7.
:long => true # always output tag + commit sha
# see `git describe` docs for more options.
Returns the String tag name, or just the commit if no tag is found. If there have been updates since the tag was made, a suffix is added with the number of commits since the tag, and the abbreviated object name of the most recent commit. Returns nil if the committish value is not found.
299 300 301 302 |
# File 'lib/grit/repo.rb', line 299 def recent_tag_name(committish = nil, = {}) value = git.describe({:always => true}.update(), committish.to_s).to_s.strip value.size.zero? ? nil : value end |
#refs ⇒ Object
An array of Ref objects representing the refs in this repo
Returns Grit::Ref[] (baked)
344 345 346 |
# File 'lib/grit/repo.rb', line 344 def refs [ Head.find_all(self), Tag.find_all(self), Remote.find_all(self) ].flatten end |
#remote_add(name, url) ⇒ Object
316 317 318 |
# File 'lib/grit/repo.rb', line 316 def remote_add(name, url) self.git.remote({}, 'add', name, url) end |
#remote_fetch(name) ⇒ Object
320 321 322 |
# File 'lib/grit/repo.rb', line 320 def remote_fetch(name) self.git.fetch({}, name) end |
#remote_list ⇒ Object
312 313 314 |
# File 'lib/grit/repo.rb', line 312 def remote_list self.git.list_remotes end |
#remotes ⇒ Object
An array of Remote objects representing the remote branches in this repo
Returns Grit::Remote[] (baked)
308 309 310 |
# File 'lib/grit/repo.rb', line 308 def remotes Remote.find_all(self) end |
#remotes_fetch_needed(remotes) ⇒ Object
takes an array of remote names and last pushed dates fetches from all of the remotes where the local fetch date is earlier than the passed date, then records the last fetched date
{ ‘origin’ => date,
'peter => date,
}
332 333 334 335 336 337 |
# File 'lib/grit/repo.rb', line 332 def remotes_fetch_needed(remotes) remotes.each do |remote, date| # TODO: check against date self.remote_fetch(remote) end end |
#remove(*files) ⇒ Object
Remove files from the index
253 254 255 |
# File 'lib/grit/repo.rb', line 253 def remove(*files) self.git.rm({}, *files.flatten) end |
#rename(name) ⇒ Object
Rename the current repository directory.
+name+ is the new name
Returns nothing
641 642 643 644 645 646 647 |
# File 'lib/grit/repo.rb', line 641 def rename(name) if @bare self.git.fs_move('/', "../#{name}") else self.git.fs_move('/', "../../#{name}") end end |
#tags ⇒ Object
An array of Tag objects that are available in this repo
Returns Grit::Tag[] (baked)
276 277 278 |
# File 'lib/grit/repo.rb', line 276 def Tag.find_all(self) end |
#tree(treeish = 'master', paths = []) ⇒ Object
The Tree object for the given treeish reference
+treeish+ is the reference (default 'master')
+paths+ is an optional Array of directory paths to restrict the tree (deafult [])
Examples
repo.tree('master', ['lib/'])
Returns Grit::Tree (baked)
472 473 474 |
# File 'lib/grit/repo.rb', line 472 def tree(treeish = 'master', paths = []) Tree.construct(self, treeish, paths) end |
#update_ref(head, commit_sha) ⇒ Object
631 632 633 634 635 |
# File 'lib/grit/repo.rb', line 631 def update_ref(head, commit_sha) return nil if !commit_sha || (commit_sha.size != 40) self.git.fs_write("refs/heads/#{head}", commit_sha) commit_sha end |