Class: Rugged::Repository
- Inherits:
-
Object
- Object
- Rugged::Repository
- Defined in:
- lib/rugged/repository.rb,
ext/rugged/rugged_repo.c
Overview
Repository is an interface into a Git repository on-disk. It’s the primary interface between your app and the main Git objects Rugged makes available to you.
Class Method Summary collapse
-
.bare(path[, alternates]) ⇒ Object
Open a bare Git repository at
path
and return aRepository
object representing it. -
.clone_at(url, local_path[, options]) ⇒ Object
Clone a repository from
url
tolocal_path
. -
.discover(path = nil, across_fs = true) ⇒ Object
Traverse
path
upwards until a Git working directory with a.git
folder has been found, open it and return it as aRepository
object. -
.hash_data(str, type) ⇒ Object
Hash the contents of
str
as raw bytes (ignoring any encoding information) and adding the relevant header corresponding totype
, and return a hex string representing the result from the hash. -
.hash_file(path, type) ⇒ Object
Hash the contents of the file pointed at by
path
, assuming that it’d be stored in the ODB with the giventype
, and return a hex string representing the SHA1 OID resulting from the hash. -
.init_at(path, is_bare = false) ⇒ Object
Initialize a Git repository in
path
. -
.new(path, options = {}) ⇒ Object
Open a Git repository in the given
path
and return aRepository
object representing it.
Instance Method Summary collapse
-
#ahead_behind(local, upstream) ⇒ Array
Returns a 2 element Array containing the number of commits that the upstream object is ahead and behind the local object.
-
#bare? ⇒ Boolean
Return whether a repository is bare or not.
-
#blob_at(revision, path) ⇒ Object
Get the blob at a path for a specific revision.
-
#branches ⇒ Object
All the branches in the repository.
-
#checkout(target, options = {}) ⇒ Object
Checkout the specified branch, reference or commit.
-
#checkout_head([options]) ⇒ nil
Updates files in the index and the working tree to match the content of the commit pointed at by
HEAD
. -
#checkout_tree(treeish[, options]) ⇒ Object
Updates files in the index and working tree to match the content of the tree pointed at by the
treeish
. -
#close ⇒ nil
Frees all the resources used by this repository immediately.
-
#config ⇒ Object
Return a Rugged::Config object representing this repository’s config.
-
#config=(cfg) ⇒ Object
Set the configuration file for this
Repository
. -
#create_branch(name, sha_or_ref = "HEAD") ⇒ Object
Create a new branch in the repository.
-
#notes_default_ref ⇒ String
Get the default notes reference for a
repository
:. -
#default_signature ⇒ nil
Returns a
Hash
with the default usersignature
ornil
. - #diff(left, right, opts = {}) ⇒ Object
- #diff_workdir(left, opts = {}) ⇒ Object
-
#each_id ⇒ Object
Call the given
block
once with every object ID found inrepo
and all its alternates. -
#each_note(*args) ⇒ Object
Call the given block once for each note_blob/annotated_object pair in
repository
-notes_ref
: (optional): canonical name of the reference to use defaults to “refs/notes/commits”. -
#empty? ⇒ Boolean
Return whether a repository is empty or not.
-
#exists?(hex) ⇒ Object
Return whether an object with the given SHA1 OID (represented as a 40-character string) exists in the repository.
- #fetch(remote_or_url, *args) ⇒ Object
-
#head ⇒ Object
Retrieve and resolve the reference pointed at by the repository’s
HEAD
. -
#head=(str) ⇒ Object
Make the repository’s
HEAD
point to the specified reference. -
#head_detached? ⇒ Boolean
Return whether the
HEAD
of a repository is detached or not. -
#head_unborn? ⇒ Boolean
Return whether the current branch is unborn (
HEAD
points to a non-existent branch). -
#include?(hex) ⇒ Object
Return whether an object with the given SHA1 OID (represented as a 40-character string) exists in the repository.
-
#index ⇒ Object
Return the default index for this repository.
-
#index=(idx) ⇒ Object
Set the index for this
Repository
. -
#inspect ⇒ Object
Pretty formatting of a Repository.
-
#last_commit ⇒ Object
Get the most recent commit from this repo.
-
#lookup(oid) ⇒ Object
Look up a SHA1.
-
#merge_analysis(their_commit) ⇒ Array
Analyzes the given commit and determines the opportunities for merging it into the repository’s HEAD.
-
#merge_base(rb_args) ⇒ Object
Find a merge base, given two or more commits or oids.
-
#merge_commits(our_commit, their_commit, options = {}) ⇒ Object
Merges the two given commits, returning a Rugged::Index that reflects the result of the merge.
-
#namespace ⇒ String
Returns the active namespace for the repository.
-
#namespace=(new_namespace) ⇒ Object
Sets the active namespace for the repository.
-
#path ⇒ Object
Return the full, normalized path to this repository.
-
#path_ignored?(path) ⇒ Boolean
Return whether a path is ignored or not.
-
#push(remote_or_url, *args) ⇒ Object
Push a list of refspecs to the given remote.
-
#read(oid) ⇒ String
Read and return the raw data of the object identified by the given
oid
. -
#read_header(oid) ⇒ Hash
Read and return the header information in
repo
‘s ODB for the object identified by the givenoid
. -
#ref(ref_name) ⇒ Object
Look up a single reference by name.
- #ref_names(glob = nil) ⇒ Object
- #references ⇒ Object
- #refs(glob = nil) ⇒ Object
-
#remotes ⇒ Object
All the remotes in the repository.
-
#reset(target, reset_type, options = {}) ⇒ nil
Sets the current head to the specified commit oid and optionally resets the index and working tree to match.
-
#reset_path(pathspecs, target = nil) ⇒ nil
Updates entries in the index from the
target
commit tree, matching the givenpathspecs
. -
#rev_parse(spec) ⇒ Object
Look up an object by a revision string.
-
#rev_parse_oid(spec) ⇒ Object
Look up an object by a revision string.
-
#shallow? ⇒ Boolean
Return whether a repository is a shallow clone or not.
-
#status(*args) ⇒ Object
Returns the status for one or more files in the working directory of the repository.
-
#tags ⇒ Object
All the tags in the repository.
-
#walk(from, sorting = Rugged::SORT_DATE, &block) ⇒ Object
Walks over a set of commits using Rugged::Walker.
-
#workdir ⇒ nil
Return the working directory for this repository, or
nil
if the repository is bare. -
#workdir=(path) ⇒ Object
Sets the working directory of
repo
topath
. -
#write(buffer, type) ⇒ Object
Write the data contained in the
buffer
string as a raw object of the giventype
into the repository’s object database.
Class Method Details
.bare(path[, alternates]) ⇒ Object
Open a bare Git repository at path
and return a Repository
object representing it.
This is faster than Rugged::Repository.new, as it won’t attempt to perform any .git
directory discovery, won’t try to load the config options to determine whether the repository is bare and won’t try to load the workdir.
Optionally, you can pass a list of alternate object folders.
Rugged::Repository.(path, ['./other/repo/.git/objects'])
200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 |
# File 'ext/rugged/rugged_repo.c', line 200
static VALUE rb_git_repo_open_bare(int argc, VALUE *argv, VALUE klass)
{
git_repository *repo;
int error = 0;
VALUE rb_path, rb_alternates;
rb_scan_args(argc, argv, "11", &rb_path, &rb_alternates);
Check_Type(rb_path, T_STRING);
error = git_repository_open_bare(&repo, StringValueCStr(rb_path));
rugged_exception_check(error);
load_alternates(repo, rb_alternates);
return rugged_repo_new(klass, repo);
}
|
.clone_at(url, local_path[, options]) ⇒ Object
Clone a repository from url
to local_path
.
The following options can be passed in the options
Hash:
- :bare
-
If
true
, the clone will be created as a bare repository. Defaults tofalse
. - :checkout_branch
-
The name of a branch to checkout. Defaults to the remote’s
HEAD
. - :remote
-
The name to give to the “origin” remote. Defaults to
"origin"
. - :ignore_cert_errors
-
If set to
true
, errors while validating the remote’s host certificate will be ignored. - :credentials
-
The credentials to use for the clone operation. Can be either an instance of one of the Rugged::Credentials types, or a proc returning one of the former. The proc will be called with the
url
, theusername
from the url (if applicable) and a list of applicable credential types. - :progress
-
A callback that will be executed with the textual progress received from the remote. This is the text send over the progress side-band (ie. the “counting objects” output).
- :transfer_progress
-
A callback that will be executed to report clone progress information. It will be passed the amount of
total_objects
,indexed_objects
,received_objects
,local_objects
,total_deltas
,indexed_deltas
, andreceived_bytes
. - :update_tips
-
A callback that will be executed each time a reference was updated locally. It will be passed the
refname
,old_oid
andnew_oid
.
Example:
Repository.clone_at("https://github.com/libgit2/rugged.git", "./some/dir", {
transfer_progress: lambda { |total_objects, indexed_objects, received_objects, local_objects, total_deltas, indexed_deltas, received_bytes|
# ...
}
})
363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 |
# File 'ext/rugged/rugged_repo.c', line 363
static VALUE rb_git_repo_clone_at(int argc, VALUE *argv, VALUE klass)
{
VALUE url, local_path, rb_options_hash;
git_clone_options options = GIT_CLONE_OPTIONS_INIT;
struct rugged_remote_cb_payload remote_payload = { Qnil, Qnil, Qnil, Qnil, 0 };
git_repository *repo;
int error;
rb_scan_args(argc, argv, "21", &url, &local_path, &rb_options_hash);
Check_Type(url, T_STRING);
Check_Type(local_path, T_STRING);
parse_clone_options(&options, rb_options_hash, &remote_payload);
error = git_clone(&repo, StringValueCStr(url), StringValueCStr(local_path), &options);
if (RTEST(remote_payload.exception))
rb_jump_tag(remote_payload.exception);
rugged_exception_check(error);
return rugged_repo_new(klass, repo);
}
|
.discover(path = nil, across_fs = true) ⇒ Object
Traverse path
upwards until a Git working directory with a .git
folder has been found, open it and return it as a Repository
object.
If path
is nil
, the current working directory will be used as a starting point.
If across_fs
is true
, the traversal won’t stop when reaching a different device than the one that contained path
(only applies to UNIX-based OSses).
1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 |
# File 'ext/rugged/rugged_repo.c', line 1038
static VALUE rb_git_repo_discover(int argc, VALUE *argv, VALUE klass)
{
git_repository *repo;
VALUE rb_path, rb_across_fs;
git_buf repository_path = { NULL };
int error, across_fs = 0;
rb_scan_args(argc, argv, "02", &rb_path, &rb_across_fs);
if (NIL_P(rb_path)) {
VALUE rb_dir = rb_const_get(rb_cObject, rb_intern("Dir"));
rb_path = rb_funcall(rb_dir, rb_intern("pwd"), 0);
}
if (!NIL_P(rb_across_fs)) {
across_fs = rugged_parse_bool(rb_across_fs);
}
Check_Type(rb_path, T_STRING);
error = git_repository_discover(
&repository_path,
StringValueCStr(rb_path),
across_fs,
NULL
);
rugged_exception_check(error);
error = git_repository_open(&repo, repository_path.ptr);
git_buf_free(&repository_path);
rugged_exception_check(error);
return rugged_repo_new(klass, repo);
}
|
.hash_data(str, type) ⇒ Object
Hash the contents of str
as raw bytes (ignoring any encoding information) and adding the relevant header corresponding to type
, and return a hex string representing the result from the hash.
Repository.hash_data('hello world', :commit) #=> "de5ba987198bcf2518885f0fc1350e5172cded78"
Repository.hash_data('hello_world', :tag) #=> "9d09060c850defbc7711d08b57def0d14e742f4e"
751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 |
# File 'ext/rugged/rugged_repo.c', line 751
static VALUE rb_git_repo_hash(VALUE self, VALUE rb_buffer, VALUE rb_type)
{
int error;
git_oid oid;
Check_Type(rb_buffer, T_STRING);
error = git_odb_hash(&oid,
RSTRING_PTR(rb_buffer),
RSTRING_LEN(rb_buffer),
rugged_otype_get(rb_type)
);
rugged_exception_check(error);
return rugged_create_oid(&oid);
}
|
.hash_file(path, type) ⇒ Object
Hash the contents of the file pointed at by path
, assuming that it’d be stored in the ODB with the given type
, and return a hex string representing the SHA1 OID resulting from the hash.
Repository.hash_file('foo.txt', :commit) #=> "de5ba987198bcf2518885f0fc1350e5172cded78"
Repository.hash_file('foo.txt', :tag) #=> "9d09060c850defbc7711d08b57def0d14e742f4e"
780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 |
# File 'ext/rugged/rugged_repo.c', line 780
static VALUE rb_git_repo_hashfile(VALUE self, VALUE rb_path, VALUE rb_type)
{
int error;
git_oid oid;
Check_Type(rb_path, T_STRING);
error = git_odb_hashfile(&oid,
StringValueCStr(rb_path),
rugged_otype_get(rb_type)
);
rugged_exception_check(error);
return rugged_create_oid(&oid);
}
|
.init_at(path, is_bare = false) ⇒ Object
Initialize a Git repository in path
. This implies creating all the necessary files on the FS, or re-initializing an already existing repository if the files have already been created.
The is_bare
(optional, defaults to false) attribute specifies whether the Repository should be created on disk as bare or not. Bare repositories have no working directory and are created in the root of path
. Non-bare repositories are created in a .git
folder and use path
as working directory.
Rugged::Repository.init_at('~/repository', :bare) #=> #<Rugged::Repository:0x108849488>
277 278 279 280 281 282 283 284 285 286 287 288 289 290 |
# File 'ext/rugged/rugged_repo.c', line 277
static VALUE rb_git_repo_init_at(int argc, VALUE *argv, VALUE klass)
{
git_repository *repo;
VALUE rb_path, rb_is_bare;
rb_scan_args(argc, argv, "11", &rb_path, &rb_is_bare);
Check_Type(rb_path, T_STRING);
rugged_exception_check(
git_repository_init(&repo, StringValueCStr(rb_path), RTEST(rb_is_bare))
);
return rugged_repo_new(klass, repo);
}
|
.new(path, options = {}) ⇒ Object
Open a Git repository in the given path
and return a Repository
object representing it. An exception will be thrown if path
doesn’t point to a valid repository. If you need to create a repository from scratch, use Rugged::Repository.init_at instead.
The path
must point to either the actual folder (.git
) of a Git repository, or to the directorly that contains the .git
folder.
See also Rugged::Repository.discover and Rugged::Repository.bare.
The following options can be passed in the options
Hash:
- :alternates
-
A list of alternate object folders.
Examples:
Rugged::Repository.new('~/test/.git') #=> #<Rugged::Repository:0x108849488>
Rugged::Repository.new(path, :alternates => ['./other/repo/.git/objects'])
241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 |
# File 'ext/rugged/rugged_repo.c', line 241
static VALUE rb_git_repo_new(int argc, VALUE *argv, VALUE klass)
{
git_repository *repo;
int error = 0;
VALUE rb_path, rb_options;
rb_scan_args(argc, argv, "10:", &rb_path, &rb_options);
Check_Type(rb_path, T_STRING);
error = git_repository_open(&repo, StringValueCStr(rb_path));
rugged_exception_check(error);
if (!NIL_P(rb_options)) {
/* Check for `:alternates` */
load_alternates(repo, rb_hash_aref(rb_options, CSTR2SYM("alternates")));
}
return rugged_repo_new(klass, repo);
}
|
Instance Method Details
#ahead_behind(local, upstream) ⇒ Array
Returns a 2 element Array containing the number of commits that the upstream object is ahead and behind the local object.
local
and upstream
can either be strings containing SHA1 OIDs or Rugged::Object instances.
1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 |
# File 'ext/rugged/rugged_repo.c', line 1427
static VALUE rb_git_repo_ahead_behind(VALUE self, VALUE rb_local, VALUE rb_upstream) {
git_repository *repo;
int error;
git_oid local, upstream;
size_t ahead, behind;
VALUE rb_result;
Data_Get_Struct(self, git_repository, repo);
error = rugged_oid_get(&local, repo, rb_local);
rugged_exception_check(error);
error = rugged_oid_get(&upstream, repo, rb_upstream);
rugged_exception_check(error);
error = git_graph_ahead_behind(&ahead, &behind, repo, &local, &upstream);
rugged_exception_check(error);
rb_result = rb_ary_new2(2);
rb_ary_push(rb_result, INT2FIX((int) ahead));
rb_ary_push(rb_result, INT2FIX((int) behind));
return rb_result;
}
|
#bare? ⇒ Boolean
Return whether a repository is bare or not. A bare repository has no working directory.
855 856 857 858 |
# File 'ext/rugged/rugged_repo.c', line 855
static VALUE rb_git_repo_is_bare(VALUE self)
{
RB_GIT_REPO_GETTER(is_bare);
}
|
#blob_at(revision, path) ⇒ Object
Get the blob at a path for a specific revision.
revision - The String SHA1. path - The String file path.
Returns a String.
187 188 189 190 191 192 193 194 195 196 |
# File 'lib/rugged/repository.rb', line 187 def blob_at(revision, path) tree = Rugged::Commit.lookup(self, revision).tree begin blob_data = tree.path(path) rescue Rugged::TreeError return nil end blob = Rugged::Blob.lookup(self, blob_data[:oid]) (blob.type == :blob) ? blob : nil end |
#branches ⇒ Object
All the branches in the repository
Returns an BranchCollection containing Rugged::Branch objects
159 160 161 |
# File 'lib/rugged/repository.rb', line 159 def branches @branches ||= BranchCollection.new(self) end |
#checkout(target, options = {}) ⇒ Object
Checkout the specified branch, reference or commit.
target - A revparse spec for the branch, reference or commit to check out. options - Options passed to #checkout_tree.
24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 |
# File 'lib/rugged/repository.rb', line 24 def checkout(target, = {}) [:strategy] ||= :safe .delete(:paths) return checkout_head() if target == "HEAD" if target.kind_of?(Rugged::Branch) branch = target else branch = branches[target] end if branch self.checkout_tree(branch.target, ) if branch.remote? references.create("HEAD", branch.target_id, force: true) else references.create("HEAD", branch.canonical_name, force: true) end else commit = Commit.lookup(self, self.rev_parse_oid(target)) references.create("HEAD", commit.oid, force: true) self.checkout_tree(commit, ) end end |
#checkout_head([options]) ⇒ nil
Updates files in the index and the working tree to match the content of the commit pointed at by HEAD
.
See Repository#checkout_tree for a list of supported options
.
1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 |
# File 'ext/rugged/rugged_repo.c', line 1873
static VALUE rb_git_checkout_head(int argc, VALUE *argv, VALUE self)
{
VALUE rb_options;
git_repository *repo;
git_checkout_options opts = GIT_CHECKOUT_OPTIONS_INIT;
struct rugged_cb_payload *payload;
int error, exception = 0;
rb_scan_args(argc, argv, "00:", &rb_options);
Data_Get_Struct(self, git_repository, repo);
rugged_parse_checkout_options(&opts, rb_options);
error = git_checkout_head(repo, &opts);
xfree(opts.paths.strings);
if ((payload = opts.notify_payload) != NULL) {
exception = payload->exception;
xfree(opts.notify_payload);
}
if ((payload = opts.progress_payload) != NULL) {
exception = payload->exception;
xfree(opts.progress_payload);
}
if (exception)
rb_jump_tag(exception);
rugged_exception_check(error);
return Qnil;
}
|
#checkout_tree(treeish[, options]) ⇒ Object
Updates files in the index and working tree to match the content of the tree pointed at by the treeish
.
The following options can be passed in the options
Hash:
- :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
or0644
. - :file_open_flags
-
Mode for opening files. Default:
IO::CREAT | IO::TRUNC | IO::WRONLY
. - :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.
1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 |
# File 'ext/rugged/rugged_repo.c', line 1818
static VALUE rb_git_checkout_tree(int argc, VALUE *argv, VALUE self)
{
VALUE rb_treeish, rb_options;
git_repository *repo;
git_object *treeish;
git_checkout_options opts = GIT_CHECKOUT_OPTIONS_INIT;
struct rugged_cb_payload *payload;
int error, exception = 0;
rb_scan_args(argc, argv, "10:", &rb_treeish, &rb_options);
if (TYPE(rb_treeish) == T_STRING) {
rb_treeish = rugged_object_rev_parse(self, rb_treeish, 1);
}
if (!rb_obj_is_kind_of(rb_treeish, rb_cRuggedCommit) &&
!rb_obj_is_kind_of(rb_treeish, rb_cRuggedTag) &&
!rb_obj_is_kind_of(rb_treeish, rb_cRuggedTree)) {
rb_raise(rb_eTypeError, "Expected Rugged::Commit, Rugged::Tag or Rugged::Tree");
}
Data_Get_Struct(self, git_repository, repo);
Data_Get_Struct(rb_treeish, git_object, treeish);
rugged_parse_checkout_options(&opts, rb_options);
error = git_checkout_tree(repo, treeish, &opts);
xfree(opts.paths.strings);
if ((payload = opts.notify_payload) != NULL) {
exception = payload->exception;
xfree(opts.notify_payload);
}
if ((payload = opts.progress_payload) != NULL) {
exception = payload->exception;
xfree(opts.progress_payload);
}
if (exception)
rb_jump_tag(exception);
rugged_exception_check(error);
return Qnil;
}
|
#close ⇒ nil
Frees all the resources used by this repository immediately. The repository can still be used after this call. Resources will be opened as necessary.
It is not required to call this method explicitly. Repositories are closed automatically before garbage collection
1365 1366 1367 1368 1369 1370 1371 1372 1373 |
# File 'ext/rugged/rugged_repo.c', line 1365
static VALUE rb_git_repo_close(VALUE self)
{
git_repository *repo;
Data_Get_Struct(self, git_repository, repo);
git_repository__cleanup(repo);
return Qnil;
}
|
#config ⇒ Object
Return a Rugged::Config object representing this repository’s config.
472 473 474 475 |
# File 'ext/rugged/rugged_repo.c', line 472
static VALUE rb_git_repo_get_config(VALUE self)
{
RB_GIT_REPO_OWNED_GET(rb_cRuggedConfig, config);
}
|
#config=(cfg) ⇒ Object
Set the configuration file for this Repository
. cfg
must be a instance of Rugged::Config. This config file will be used internally by all operations that need to lookup configuration settings on repo
.
Note that it’s not necessary to set the config
for any repository; by default repositories are loaded with their relevant config files on the filesystem, and the corresponding global and system files if they can be found.
461 462 463 464 |
# File 'ext/rugged/rugged_repo.c', line 461
static VALUE rb_git_repo_set_config(VALUE self, VALUE rb_data)
{
RB_GIT_REPO_OWNED_SET(rb_cRuggedConfig, config);
}
|
#create_branch(name, sha_or_ref = "HEAD") ⇒ Object
Create a new branch in the repository
name - The name of the branch (without a full reference path) sha_or_ref - The target of the branch; either a String representing an OID or a reference name, or a Rugged::Object instance.
Returns a Rugged::Branch object
170 171 172 173 174 175 176 177 178 179 |
# File 'lib/rugged/repository.rb', line 170 def create_branch(name, sha_or_ref = "HEAD") case sha_or_ref when Rugged::Object target = sha_or_ref.oid else target = rev_parse_oid(sha_or_ref) end branches.create(name, target) end |
#notes_default_ref ⇒ String
Get the default notes reference for a repository
:
Returns a new String object.
repo.default_notes_ref #=> "refs/notes/commits"
349 350 351 352 353 354 355 356 357 358 359 360 361 |
# File 'ext/rugged/rugged_note.c', line 349
static VALUE rb_git_note_default_ref_GET(VALUE self)
{
git_repository *repo = NULL;
const char * ref_name;
Data_Get_Struct(self, git_repository, repo);
rugged_exception_check(
git_note_default_ref(&ref_name, repo)
);
return rb_str_new_utf8(ref_name);
}
|
#default_signature ⇒ nil
Returns a Hash
with the default user signature
or nil
.
Looks up the user.name
and user.email
from the configuration and uses the current time as the timestamp, and creates a new signature based on that information. It will return nil
if either the user.name
or user.email
are not set.
Returns a Hash
:
-
:name
: theuser.name
config value -
:email
: theuser.email
config value -
:time
: the current time as aTime
instance
1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 |
# File 'ext/rugged/rugged_repo.c', line 1467
static VALUE rb_git_repo_default_signature(VALUE self) {
int error;
git_repository *repo;
git_signature *signature;
VALUE rb_signature;
Data_Get_Struct(self, git_repository, repo);
error = git_signature_default(&signature, repo);
if (error == GIT_ENOTFOUND)
return Qnil;
rugged_exception_check(error);
rb_signature = rugged_signature_new(signature, NULL);
git_signature_free(signature);
return rb_signature;
}
|
#diff(left, right, opts = {}) ⇒ Object
51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 |
# File 'lib/rugged/repository.rb', line 51 def diff(left, right, opts = {}) left = rev_parse(left) if left.kind_of?(String) right = rev_parse(right) if right.kind_of?(String) if !left.is_a?(Rugged::Tree) && !left.is_a?(Rugged::Commit) && !left.nil? raise TypeError, "Expected a Rugged::Tree or Rugged::Commit instance" end if !right.is_a?(Rugged::Tree) && !right.is_a?(Rugged::Commit) && !right.nil? raise TypeError, "Expected a Rugged::Tree or Rugged::Commit instance" end if left left.diff(right, opts) elsif right right.diff(left, opts.merge(:reverse => !opts[:reverse])) end end |
#diff_workdir(left, opts = {}) ⇒ Object
70 71 72 73 74 75 76 77 78 |
# File 'lib/rugged/repository.rb', line 70 def diff_workdir(left, opts = {}) left = rev_parse(left) if left.kind_of?(String) if !left.is_a?(Rugged::Tree) && !left.is_a?(Rugged::Commit) raise TypeError, "Expected a Rugged::Tree or Rugged::Commit instance" end left.diff_workdir(opts) end |
#each_id {|id| ... } ⇒ Object #each_id ⇒ Iterator
Call the given block
once with every object ID found in repo
and all its alternates. Object IDs are passed as 40-character strings.
1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 |
# File 'ext/rugged/rugged_repo.c', line 1196
static VALUE rb_git_repo_each_id(VALUE self)
{
git_repository *repo;
git_odb *odb;
int error, exception = 0;
if (!rb_block_given_p())
return rb_funcall(self, rb_intern("to_enum"), 1, CSTR2SYM("each_id"));
Data_Get_Struct(self, git_repository, repo);
error = git_repository_odb(&odb, repo);
rugged_exception_check(error);
error = git_odb_foreach(odb, &rugged__each_id_cb, &exception);
git_odb_free(odb);
if (exception)
rb_jump_tag(exception);
rugged_exception_check(error);
return Qnil;
}
|
#each_note(notes_ref = "refs/notes/commits") {|note_blob, annotated_object| ... } ⇒ Object #each_note(notes_ref = "refs/notes/commits") ⇒ Object
Call the given block once for each note_blob/annotated_object pair in repository
-
notes_ref
: (optional): canonical name of the reference to use defaults to “refs/notes/commits”
If no block is given, an Enumerator
is returned.
@repo.each_note do |note_blob, annotated_object|
puts "#{note_blob.oid} => #{annotated_object.oid}"
end
309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 |
# File 'ext/rugged/rugged_note.c', line 309
static VALUE rb_git_note_each(int argc, VALUE *argv, VALUE self)
{
git_repository *repo;
const char *notes_ref = NULL;
int error;
struct rugged_cb_payload payload = { self, 0 };
VALUE rb_notes_ref;
rb_scan_args(argc, argv, "01", &rb_notes_ref);
if (!rb_block_given_p()) {
return rb_funcall(self, rb_intern("to_enum"), 3, CSTR2SYM("each_note"), self, rb_notes_ref);
}
if (!NIL_P(rb_notes_ref)) {
Check_Type(rb_notes_ref, T_STRING);
notes_ref = StringValueCStr(rb_notes_ref);
}
Data_Get_Struct(self, git_repository, repo);
error = git_note_foreach(repo, notes_ref, &cb_note__each, &payload);
if (payload.exception)
rb_jump_tag(payload.exception);
rugged_exception_check(error);
return Qnil;
}
|
#empty? ⇒ Boolean
Return whether a repository is empty or not. An empty repository has just been initialized and has no commits yet.
880 881 882 883 |
# File 'ext/rugged/rugged_repo.c', line 880
static VALUE rb_git_repo_is_empty(VALUE self)
{
RB_GIT_REPO_GETTER(is_empty);
}
|
#include?(oid) ⇒ Boolean #exists?(oid) ⇒ Boolean
Return whether an object with the given SHA1 OID (represented as a 40-character string) exists in the repository.
repo.include?("d8786bfc97485e8d7b19b21fb88c8ef1f199fc3f") #=> true
650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 |
# File 'ext/rugged/rugged_repo.c', line 650
static VALUE rb_git_repo_exists(VALUE self, VALUE hex)
{
git_repository *repo;
git_odb *odb;
git_oid oid;
int error;
VALUE rb_result;
Data_Get_Struct(self, git_repository, repo);
Check_Type(hex, T_STRING);
error = git_oid_fromstr(&oid, StringValueCStr(hex));
rugged_exception_check(error);
error = git_repository_odb(&odb, repo);
rugged_exception_check(error);
rb_result = git_odb_exists(odb, &oid) ? Qtrue : Qfalse;
git_odb_free(odb);
return rb_result;
}
|
#fetch(remote_or_url, *args) ⇒ Object
198 199 200 201 202 203 204 |
# File 'lib/rugged/repository.rb', line 198 def fetch(remote_or_url, *args) unless remote_or_url.kind_of? Remote remote_or_url = remotes[remote_or_url] || remotes.create_anonymous(remote_or_url) end remote_or_url.fetch(*args) end |
#head ⇒ Object
Retrieve and resolve the reference pointed at by the repository’s HEAD
.
Returns nil
if HEAD
is missing.
936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 |
# File 'ext/rugged/rugged_repo.c', line 936
static VALUE rb_git_repo_get_head(VALUE self)
{
git_repository *repo;
git_reference *head;
int error;
Data_Get_Struct(self, git_repository, repo);
error = git_repository_head(&head, repo);
if (error == GIT_ENOTFOUND)
return Qnil;
else
rugged_exception_check(error);
return rugged_ref_new(rb_cRuggedReference, self, head);
}
|
#head=(str) ⇒ Object
Make the repository’s HEAD
point to the specified reference.
914 915 916 917 918 919 920 921 922 923 924 925 926 |
# File 'ext/rugged/rugged_repo.c', line 914
static VALUE rb_git_repo_set_head(VALUE self, VALUE rb_head)
{
git_repository *repo;
int error;
Data_Get_Struct(self, git_repository, repo);
Check_Type(rb_head, T_STRING);
error = git_repository_set_head(repo, StringValueCStr(rb_head), NULL, NULL);
rugged_exception_check(error);
return Qnil;
}
|
#head_detached? ⇒ Boolean
Return whether the HEAD
of a repository is detached or not.
891 892 893 894 |
# File 'ext/rugged/rugged_repo.c', line 891
static VALUE rb_git_repo_head_detached(VALUE self)
{
RB_GIT_REPO_GETTER(head_detached);
}
|
#head_unborn? ⇒ Boolean
Return whether the current branch is unborn (HEAD
points to a non-existent branch).
903 904 905 906 |
# File 'ext/rugged/rugged_repo.c', line 903
static VALUE rb_git_repo_head_unborn(VALUE self)
{
RB_GIT_REPO_GETTER(head_unborn);
}
|
#include?(oid) ⇒ Boolean #exists?(oid) ⇒ Boolean
Return whether an object with the given SHA1 OID (represented as a 40-character string) exists in the repository.
repo.include?("d8786bfc97485e8d7b19b21fb88c8ef1f199fc3f") #=> true
650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 |
# File 'ext/rugged/rugged_repo.c', line 650
static VALUE rb_git_repo_exists(VALUE self, VALUE hex)
{
git_repository *repo;
git_odb *odb;
git_oid oid;
int error;
VALUE rb_result;
Data_Get_Struct(self, git_repository, repo);
Check_Type(hex, T_STRING);
error = git_oid_fromstr(&oid, StringValueCStr(hex));
rugged_exception_check(error);
error = git_repository_odb(&odb, repo);
rugged_exception_check(error);
rb_result = git_odb_exists(odb, &oid) ? Qtrue : Qfalse;
git_odb_free(odb);
return rb_result;
}
|
#index ⇒ Object
Return the default index for this repository.
443 444 445 446 |
# File 'ext/rugged/rugged_repo.c', line 443
static VALUE rb_git_repo_get_index(VALUE self)
{
RB_GIT_REPO_OWNED_GET(rb_cRuggedIndex, index);
}
|
#index=(idx) ⇒ Object
Set the index for this Repository
. idx
must be a instance of Rugged::Index. This index will be used internally by all operations that use the Git index on repo
.
Note that it’s not necessary to set the index
for any repository; by default repositories are loaded with the index file that can be located on the .git
folder in the filesystem.
432 433 434 435 |
# File 'ext/rugged/rugged_repo.c', line 432
static VALUE rb_git_repo_set_index(VALUE self, VALUE rb_data)
{
RB_GIT_REPO_OWNED_SET(rb_cRuggedIndex, index);
}
|
#inspect ⇒ Object
Pretty formatting of a Repository.
Returns a very pretty String.
9 10 11 |
# File 'lib/rugged/repository.rb', line 9 def inspect "#<Rugged::Repository:#{object_id} {path: #{path.inspect}}>" end |
#last_commit ⇒ Object
Get the most recent commit from this repo.
Returns a Rugged::Commit object.
16 17 18 |
# File 'lib/rugged/repository.rb', line 16 def last_commit self.head.target end |
#lookup(oid) ⇒ Object
Look up a SHA1.
Returns one of the four classes that inherit from Rugged::Object.
98 99 100 |
# File 'lib/rugged/repository.rb', line 98 def lookup(oid) Rugged::Object.lookup(self, oid) end |
#merge_analysis(their_commit) ⇒ Array
Analyzes the given commit and determines the opportunities for merging it into the repository’s HEAD. Returns an Array containing a combination of the following symbols:
- :normal
-
A “normal” merge is possible, both HEAD and the given commit have diverged from their common ancestor. The divergent commits must be merged.
- :up_to_date
-
The given commit is reachable from HEAD, meaning HEAD is up-to-date and no merge needs to be performed.
- :fastforward
-
The given commit is a fast-forward from HEAD and no merge needs to be performed. HEAD can simply be set to the given commit.
- :unborn
-
The HEAD of the current repository is “unborn” and does not point to a valid commit. No merge can be performed, but the caller may wish to simply set HEAD to the given commit.
544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 |
# File 'ext/rugged/rugged_repo.c', line 544
static VALUE rb_git_repo_merge_analysis(int argc, VALUE *argv, VALUE self)
{
int error;
git_repository *repo;
git_commit *their_commit;
git_merge_head *merge_head;
git_merge_analysis_t analysis;
git_merge_preference_t preference;
VALUE rb_their_commit, result;
rb_scan_args(argc, argv, "10", &rb_their_commit);
Data_Get_Struct(self, git_repository, repo);
if (TYPE(rb_their_commit) == T_STRING) {
rb_their_commit = rugged_object_rev_parse(self, rb_their_commit, 1);
}
if (!rb_obj_is_kind_of(rb_their_commit, rb_cRuggedCommit)) {
rb_raise(rb_eArgError, "Expected a Rugged::Commit.");
}
Data_Get_Struct(rb_their_commit, git_commit, their_commit);
error = git_merge_head_from_id(&merge_head, repo, git_commit_id(their_commit));
rugged_exception_check(error);
error = git_merge_analysis(&analysis, &preference, repo,
/* hack as we currently only do one commit */
(const git_merge_head **) &merge_head, 1);
git_merge_head_free(merge_head);
rugged_exception_check(error);
result = rb_ary_new();
if (analysis & GIT_MERGE_ANALYSIS_NORMAL)
rb_ary_push(result, CSTR2SYM("normal"));
if (analysis & GIT_MERGE_ANALYSIS_UP_TO_DATE)
rb_ary_push(result, CSTR2SYM("up_to_date"));
if (analysis & GIT_MERGE_ANALYSIS_FASTFORWARD)
rb_ary_push(result, CSTR2SYM("fastforward"));
if (analysis & GIT_MERGE_ANALYSIS_UNBORN)
rb_ary_push(result, CSTR2SYM("unborn"));
return result;
}
|
#merge_base(oid1, oid2, ...) ⇒ Object #merge_base(ref1, ref2, ...) ⇒ Object #merge_base(commit1, commit2, ...) ⇒ Object
Find a merge base, given two or more commits or oids. Returns nil if a merge base is not found.
486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 |
# File 'ext/rugged/rugged_repo.c', line 486
static VALUE rb_git_repo_merge_base(VALUE self, VALUE rb_args)
{
int error = GIT_OK, i;
git_repository *repo;
git_oid base, *input_array = xmalloc(sizeof(git_oid) * RARRAY_LEN(rb_args));
int len = (int)RARRAY_LEN(rb_args);
if (len < 2)
rb_raise(rb_eArgError, "wrong number of arguments (%d for 2+)", len);
Data_Get_Struct(self, git_repository, repo);
for (i = 0; !error && i < len; ++i) {
error = rugged_oid_get(&input_array[i], repo, rb_ary_entry(rb_args, i));
}
if (error) {
xfree(input_array);
rugged_exception_check(error);
}
error = git_merge_base_many(&base, repo, len, input_array);
xfree(input_array);
if (error == GIT_ENOTFOUND)
return Qnil;
rugged_exception_check(error);
return rugged_create_oid(&base);
}
|
#merge_commits(our_commit, their_commit, options = {}) ⇒ Object
Merges the two given commits, returning a Rugged::Index that reflects the result of the merge.
our_commit
and their_commit
can either be Rugged::Commit objects, or OIDs resolving to the former.
600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 |
# File 'ext/rugged/rugged_repo.c', line 600
static VALUE rb_git_repo_merge_commits(int argc, VALUE *argv, VALUE self)
{
VALUE rb_our_commit, rb_their_commit, rb_options;
git_commit *our_commit, *their_commit;
git_index *index;
git_repository *repo;
git_merge_options opts = GIT_MERGE_OPTIONS_INIT;
rb_scan_args(argc, argv, "20:", &rb_our_commit, &rb_their_commit, &rb_options);
if (TYPE(rb_our_commit) == T_STRING) {
rb_our_commit = rugged_object_rev_parse(self, rb_our_commit, 1);
}
if (!rb_obj_is_kind_of(rb_our_commit, rb_cRuggedCommit)) {
rb_raise(rb_eArgError, "Expected a Rugged::Commit.");
}
if (TYPE(rb_their_commit) == T_STRING) {
rb_their_commit = rugged_object_rev_parse(self, rb_their_commit, 1);
}
if (!rb_obj_is_kind_of(rb_their_commit, rb_cRuggedCommit)) {
rb_raise(rb_eArgError, "Expected a Rugged::Commit.");
}
if (!NIL_P(rb_options)) {
Check_Type(rb_options, T_HASH);
rugged_parse_merge_options(&opts, rb_options);
}
Data_Get_Struct(self, git_repository, repo);
Data_Get_Struct(rb_our_commit, git_commit, our_commit);
Data_Get_Struct(rb_their_commit, git_commit, their_commit);
rugged_exception_check(git_merge_commits(&index, repo, our_commit, their_commit, &opts));
return rugged_index_new(rb_cRuggedIndex, self, index);
}
|
#namespace ⇒ String
Returns the active namespace for the repository.
1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 |
# File 'ext/rugged/rugged_repo.c', line 1406
static VALUE rb_git_repo_get_namespace(VALUE self)
{
git_repository *repo;
const char *namespace;
Data_Get_Struct(self, git_repository, repo);
namespace = git_repository_get_namespace(repo);
return namespace ? rb_str_new_utf8(namespace) : Qnil;
}
|
#namespace=(new_namespace) ⇒ Object
Sets the active namespace for the repository. If set to nil, no namespace will be active.
1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 |
# File 'ext/rugged/rugged_repo.c', line 1382
static VALUE rb_git_repo_set_namespace(VALUE self, VALUE rb_namespace)
{
git_repository *repo;
int error;
Data_Get_Struct(self, git_repository, repo);
if (!NIL_P(rb_namespace)) {
Check_Type(rb_namespace, T_STRING);
error = git_repository_set_namespace(repo, StringValueCStr(rb_namespace));
} else {
error = git_repository_set_namespace(repo, NULL);
}
rugged_exception_check(error);
return Qnil;
}
|
#path ⇒ Object
Return the full, normalized path to this repository. For non-bare repositories, this is the path of the actual .git
folder, not the working directory.
repo.path #=> "/home/foo/workthing/.git"
962 963 964 965 966 967 |
# File 'ext/rugged/rugged_repo.c', line 962
static VALUE rb_git_repo_path(VALUE self)
{
git_repository *repo;
Data_Get_Struct(self, git_repository, repo);
return rb_str_new_utf8(git_repository_path(repo));
}
|
#path_ignored?(path) ⇒ Boolean
Return whether a path is ignored or not.
1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 |
# File 'ext/rugged/rugged_repo.c', line 1914
static VALUE rb_git_repo_is_path_ignored(VALUE self, VALUE rb_path) {
git_repository *repo;
const char *path;
int error;
int ignored;
Data_Get_Struct(self, git_repository, repo);
path = StringValueCStr(rb_path);
error = git_ignore_path_is_ignored(&ignored, repo, path);
rugged_exception_check(error);
return ignored ? Qtrue : Qfalse;
}
|
#push(remote_or_url, *args) ⇒ Object
Push a list of refspecs to the given remote.
refspecs - A list of refspecs that should be pushed to the remote.
Returns a hash containing the pushed refspecs as keys and any error messages or nil
as values.
212 213 214 215 216 217 218 |
# File 'lib/rugged/repository.rb', line 212 def push(remote_or_url, *args) unless remote_or_url.kind_of? Remote remote_or_url = remotes[remote_or_url] || remotes.create_anonymous(remote_or_url) end remote_or_url.push(*args) end |
#read(oid) ⇒ String
Read and return the raw data of the object identified by the given oid
.
679 680 681 682 683 684 685 686 687 688 689 690 691 692 |
# File 'ext/rugged/rugged_repo.c', line 679
static VALUE rb_git_repo_read(VALUE self, VALUE hex)
{
git_repository *repo;
git_oid oid;
int error;
Data_Get_Struct(self, git_repository, repo);
Check_Type(hex, T_STRING);
error = git_oid_fromstr(&oid, StringValueCStr(hex));
rugged_exception_check(error);
return rugged_raw_read(repo, &oid);
}
|
#read_header(oid) ⇒ Hash
Read and return the header information in repo
‘s ODB for the object identified by the given oid
.
Returns a Hash object with the following key/value pairs:
- :type
-
A Symbol denoting the object’s type. Possible values are:
:tree
,:blob
,:commit
or:tag
. - :len
-
A Number representing the object’s length, in bytes.
709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 |
# File 'ext/rugged/rugged_repo.c', line 709
static VALUE rb_git_repo_read_header(VALUE self, VALUE hex)
{
git_repository *repo;
git_oid oid;
git_odb *odb;
git_otype type;
size_t len;
VALUE rb_hash;
int error;
Data_Get_Struct(self, git_repository, repo);
Check_Type(hex, T_STRING);
error = git_oid_fromstr(&oid, StringValueCStr(hex));
rugged_exception_check(error);
error = git_repository_odb(&odb, repo);
rugged_exception_check(error);
error = git_odb_read_header(&len, &type, odb, &oid);
git_odb_free(odb);
rugged_exception_check(error);
rb_hash = rb_hash_new();
rb_hash_aset(rb_hash, CSTR2SYM("type"), CSTR2SYM(git_object_type2string(type)));
rb_hash_aset(rb_hash, CSTR2SYM("len"), INT2FIX(len));
return rb_hash;
}
|
#ref(ref_name) ⇒ Object
Look up a single reference by name.
Example:
repo.ref 'refs/heads/master'
# => #<Rugged::Reference:2199125780 {name: "refs/heads/master",
target: "25b5d3b40c4eadda8098172b26c68cf151109799"}>
Returns a Rugged::Reference.
125 126 127 |
# File 'lib/rugged/repository.rb', line 125 def ref(ref_name) references[ref_name] end |
#ref_names(glob = nil) ⇒ Object
137 138 139 |
# File 'lib/rugged/repository.rb', line 137 def ref_names(glob = nil) references.each_name(glob) end |
#references ⇒ Object
133 134 135 |
# File 'lib/rugged/repository.rb', line 133 def references @references ||= ReferenceCollection.new(self) end |
#refs(glob = nil) ⇒ Object
129 130 131 |
# File 'lib/rugged/repository.rb', line 129 def refs(glob = nil) references.each(glob) end |
#remotes ⇒ Object
All the remotes in the repository.
Returns a Rugged::RemoteCollection containing all the Rugged::Remote objects in the repository.
152 153 154 |
# File 'lib/rugged/repository.rb', line 152 def remotes @remotes ||= RemoteCollection.new(self) end |
#reset(target, reset_type, options = {}) ⇒ nil
Sets the current head to the specified commit oid and optionally resets the index and working tree to match.
-
target
: Rugged::Commit, Rugged::Tag or rev that resolves to a commit or tag object -
reset_type
::soft
,:mixed
or:hard
- :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)
The following options can be passed in the options
Hash:
- :message
-
A single line log message to be appended to the reflog.
- :signature
-
The signature to be used for populating the reflog entry.
Examples:
repo.reset('origin/master', :hard) #=> nil
1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 |
# File 'ext/rugged/rugged_repo.c', line 1270
static VALUE rb_git_repo_reset(int argc, VALUE *argv, VALUE self)
{
VALUE rb_target, rb_reset_type, rb_options;
git_repository *repo;
int reset_type;
git_object *target = NULL;
char *log_message = NULL;
git_signature *signature = NULL;
int error;
rb_scan_args(argc, argv, "20:", &rb_target, &rb_reset_type, &rb_options);
Data_Get_Struct(self, git_repository, repo);
reset_type = parse_reset_type(rb_reset_type);
target = rugged_object_get(repo, rb_target, GIT_OBJ_ANY);
if (!NIL_P(rb_options)) {
VALUE rb_val;
rb_val = rb_hash_aref(rb_options, CSTR2SYM("signature"));
if (!NIL_P(rb_val))
signature = rugged_signature_get(rb_val, repo);
rb_val = rb_hash_aref(rb_options, CSTR2SYM("message"));
if (!NIL_P(rb_val))
log_message = StringValueCStr(rb_val);
}
error = git_reset(repo, target, reset_type, signature, log_message);
git_object_free(target);
git_signature_free(signature);
rugged_exception_check(error);
return Qnil;
}
|
#reset_path(pathspecs, target = nil) ⇒ nil
Updates entries in the index from the target
commit tree, matching the given pathspecs
.
Passing a nil target
will result in removing entries in the index matching the provided pathspecs.
-
pathspecs
: list of pathspecs to operate on (String
orArray
ofString
objects) -
target
(optional): Rugged::Commit, Rugged::Tag or rev that resolves to a commit or tag object.
Examples:
reset_path(File.join('subdir','file.txt'), '441034f860c1d5d90e4188d11ae0d325176869a8') #=> nil
1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 |
# File 'ext/rugged/rugged_repo.c', line 1325
static VALUE rb_git_repo_reset_path(int argc, VALUE *argv, VALUE self)
{
git_repository *repo;
git_object *target = NULL;
git_strarray pathspecs;
VALUE rb_target, rb_paths;
int error = 0;
pathspecs.strings = NULL;
pathspecs.count = 0;
Data_Get_Struct(self, git_repository, repo);
rb_scan_args(argc, argv, "11", &rb_paths, &rb_target);
rugged_rb_ary_to_strarray(rb_paths, &pathspecs);
if (!NIL_P(rb_target))
target = rugged_object_get(repo, rb_target, GIT_OBJ_ANY);
error = git_reset_default(repo, target, &pathspecs);
xfree(pathspecs.strings);
git_object_free(target);
rugged_exception_check(error);
return Qnil;
}
|
#rev_parse(spec) ⇒ Object
Look up an object by a revision string.
Returns one of the four classes that inherit from Rugged::Object.
105 106 107 |
# File 'lib/rugged/repository.rb', line 105 def rev_parse(spec) Rugged::Object.rev_parse(self, spec) end |
#rev_parse_oid(spec) ⇒ Object
Look up an object by a revision string.
Returns the oid of the matched object as a String
112 113 114 |
# File 'lib/rugged/repository.rb', line 112 def rev_parse_oid(spec) Rugged::Object.rev_parse_oid(self, spec) end |
#shallow? ⇒ Boolean
Return whether a repository is a shallow clone or not. A shallow clone has a truncated history and can not be cloned or fetched from, nor can be pushed from nor into it.
868 869 870 871 |
# File 'ext/rugged/rugged_repo.c', line 868
static VALUE rb_git_repo_is_shallow(VALUE self)
{
RB_GIT_REPO_GETTER(is_shallow);
}
|
#status {|file, status_data| ... } ⇒ Object #status(path) ⇒ Object
Returns the status for one or more files in the working directory of the repository. This is equivalent to the git status command.
The returned status_data
is always an array containing one or more status flags as Ruby symbols. Possible flags are:
-
:index_new
: the file is new in the index -
:index_modified
: the file has been modified in the index -
:index_deleted
: the file has been deleted from the index -
:worktree_new
: the file is new in the working directory -
:worktree_modified
: the file has been modified in the working directory -
:worktree_deleted
: the file has been deleted from the working directory
If a block
is given, status information will be gathered for every single file on the working dir. The block
will be called with the status data for each file.
repo.status { |file, status_data| puts "#{file} has status: #{status_data.inspect}" }
results in, for example:
src/diff.c has status: [:index_new, :worktree_new]
README has status: [:worktree_modified]
If a path
is given instead, the function will return the status_data
for the file pointed to by path, or raise an exception if the path doesn’t exist.
path
must be relative to the repository’s working directory.
repo.status('src/diff.c') #=> [:index_new, :worktree_new]
1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 |
# File 'ext/rugged/rugged_repo.c', line 1148
static VALUE rb_git_repo_status(int argc, VALUE *argv, VALUE self)
{
int error;
VALUE rb_path;
git_repository *repo;
Data_Get_Struct(self, git_repository, repo);
if (rb_scan_args(argc, argv, "01", &rb_path) == 1) {
unsigned int flags;
Check_Type(rb_path, T_STRING);
error = git_status_file(&flags, repo, StringValueCStr(rb_path));
rugged_exception_check(error);
return flags_to_rb(flags);
}
if (!rb_block_given_p())
rb_raise(rb_eRuntimeError,
"A block was expected for iterating through "
"the repository contents.");
error = git_status_foreach(
repo,
&rugged__status_cb,
(void *)rb_block_proc()
);
rugged_exception_check(error);
return Qnil;
}
|
#tags ⇒ Object
All the tags in the repository.
Returns an TagCollection containing all the tags.
144 145 146 |
# File 'lib/rugged/repository.rb', line 144 def @tags ||= TagCollection.new(self) end |
#walk(from, sorting = Rugged::SORT_DATE, &block) ⇒ Object
Walks over a set of commits using Rugged::Walker.
from - The String SHA1 to push onto Walker to begin our walk. sorting - The sorting order of the commits, as defined in the README. block - A block that we pass into walker#each.
Returns nothing if called with a block, otherwise returns an instance of Enumerable::Enumerator containing Rugged::Commit objects.
88 89 90 91 92 93 |
# File 'lib/rugged/repository.rb', line 88 def walk(from, sorting=Rugged::SORT_DATE, &block) walker = Rugged::Walker.new(self) walker.sorting(sorting) walker.push(from) walker.each(&block) end |
#workdir ⇒ nil
Return the working directory for this repository, or nil
if the repository is bare.
repo1. #=> false
repo1.workdir #=> "/home/foo/workthing/"
repo2. #=> true
repo2.workdir #=> nil
982 983 984 985 986 987 988 989 990 991 |
# File 'ext/rugged/rugged_repo.c', line 982
static VALUE rb_git_repo_workdir(VALUE self)
{
git_repository *repo;
const char *workdir;
Data_Get_Struct(self, git_repository, repo);
workdir = git_repository_workdir(repo);
return workdir ? rb_str_new_utf8(workdir) : Qnil;
}
|
#workdir=(path) ⇒ Object
Sets the working directory of repo
to path
. All internal operations on repo
that affect the working directory will instead use path
.
The workdir
can be set on bare repositories to temporarily turn them into normal repositories.
repo. #=> true
repo.workdir = "/tmp/workdir"
repo. #=> false
repo.checkout
1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 |
# File 'ext/rugged/rugged_repo.c', line 1009
static VALUE rb_git_repo_set_workdir(VALUE self, VALUE rb_workdir)
{
git_repository *repo;
Data_Get_Struct(self, git_repository, repo);
Check_Type(rb_workdir, T_STRING);
rugged_exception_check(
git_repository_set_workdir(repo, StringValueCStr(rb_workdir), 0)
);
return Qnil;
}
|
#write(buffer, type) ⇒ Object
Write the data contained in the buffer
string as a raw object of the given type
into the repository’s object database.
type
can be either :tag
, :commit
, :tree
or :blob
.
Returns the newly created object’s oid.
807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 |
# File 'ext/rugged/rugged_repo.c', line 807
static VALUE rb_git_repo_write(VALUE self, VALUE rb_buffer, VALUE rub_type)
{
git_repository *repo;
git_odb_stream *stream;
git_odb *odb;
git_oid oid;
int error;
git_otype type;
Data_Get_Struct(self, git_repository, repo);
Check_Type(rb_buffer, T_STRING);
error = git_repository_odb(&odb, repo);
rugged_exception_check(error);
type = rugged_otype_get(rub_type);
error = git_odb_open_wstream(&stream, odb, RSTRING_LEN(rb_buffer), type);
git_odb_free(odb);
rugged_exception_check(error);
error = git_odb_stream_write(stream, RSTRING_PTR(rb_buffer), RSTRING_LEN(rb_buffer));
if (!error)
error = git_odb_stream_finalize_write(&oid, stream);
git_odb_stream_free(stream);
rugged_exception_check(error);
return rugged_create_oid(&oid);
}
|