Class: Rugged::Repository
- Inherits:
-
Object
- Object
- Rugged::Repository
- Defined in:
- lib/rugged/repository.rb,
lib/rugged/attributes.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.
Defined Under Namespace
Classes: Attributes
Class Method Summary collapse
-
.bare(*args) ⇒ 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, opts = {}) ⇒ 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.
- #attributes(path, options = {}) ⇒ 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_index(index[,options]) ⇒ nil
Updates files in the index and the working tree to match the content of the commit pointed at by
index
. -
#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
. -
#cherrypick(commit[, options]) ⇒ nil
Cherry-pick the given commit and update the index and working directory accordingly.
-
#cherrypick_commit(commit, our_commit, [mainline, options]) ⇒ nil
Cherry-pick the given commit on the given base in-memory and return an index with the result.
-
#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
. -
#descendant_of?(commit, ancestor) ⇒ Boolean
commit
andancestor
must be String commit OIDs or instances of Rugged::Commit. - #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 hex string of at least 7 characters) exists in the repository.
-
#expand_oids([oid..], object_type = :any) ⇒ Hash
Expand a list of short oids to their full value, assuming they exist in the repository.
- #fetch(remote_or_url, *args) ⇒ Object
- #fetch_attributes(*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). -
#ident ⇒ Object
Return a Hash containing the identity that is used to write reflogs.
-
#ident=(ident) ⇒ Object
Set the identity to be used for writing reflogs.
-
#include?(hex) ⇒ Object
Return whether an object with the given SHA1 OID (represented as a hex string of at least 7 characters) 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_bases(rb_args) ⇒ Object
Find all merge bases, 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) ⇒ 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.
-
#revert_commit(revert_commit, our_commit, options = {}) ⇒ Object
Reverts the given commit against the given “our” commit, producing an index that reflects the result of the revert.
-
#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.
-
#submodules ⇒ Object
All the submodules in 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 .bare(path[, options]) ⇒ 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 or an options Hash.
Rugged::Repository.(path, ['./other/repo/.git/objects'])
Rugged::Repository.(path, opts)
The following options can be passed in the options
Hash:
- :backend
-
A Rugged::Backend instance
- :alternates
-
A list of alternate object folders. Rugged::Repository.bare(path, :alternates => [‘./other/repo/.git/objects’])
287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 |
# File 'ext/rugged/rugged_repo.c', line 287
static VALUE rb_git_repo_open_bare(int argc, VALUE *argv, VALUE klass)
{
git_repository *repo = NULL;
int error = 0;
VALUE rb_path, rb_options, rb_alternates = 0;
rb_scan_args(argc, argv, "11", &rb_path, &rb_options);
if (!NIL_P(rb_options) && TYPE(rb_options) == T_ARRAY)
rb_alternates = rb_options;
if (!NIL_P(rb_options) && TYPE(rb_options) == T_HASH) {
/* Check for `:backend` */
VALUE rb_backend = rb_hash_aref(rb_options, CSTR2SYM("backend"));
if (!NIL_P(rb_backend)) {
rugged_repo_new_with_backend(&repo, rb_path, rb_backend);
}
/* Check for `:alternates` */
rb_alternates = rb_hash_aref(rb_options, CSTR2SYM("alternates"));
}
if (!repo) {
Check_Type(rb_path, T_STRING);
error = git_repository_open_bare(&repo, StringValueCStr(rb_path));
rugged_exception_check(error);
}
if (rb_alternates) {
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|
# ...
}
})
484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 |
# File 'ext/rugged/rugged_repo.c', line 484
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).
1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 |
# File 'ext/rugged/rugged_repo.c', line 1449
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"
1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 |
# File 'ext/rugged/rugged_repo.c', line 1158
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"
1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 |
# File 'ext/rugged/rugged_repo.c', line 1187
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, opts = {}) ⇒ 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.
The following options can be passed in the options
Hash:
- :backend
-
A Rugged::Backend instance
Rugged::Repository.init_at(‘repository’, :bare) #=> #<Rugged::Repository:0x108849488>
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 |
# File 'ext/rugged/rugged_repo.c', line 390
static VALUE rb_git_repo_init_at(int argc, VALUE *argv, VALUE klass)
{
git_repository *repo = NULL;
VALUE rb_path, rb_is_bare, rb_options;
int error;
rb_scan_args(argc, argv, "11:", &rb_path, &rb_is_bare, &rb_options);
Check_Type(rb_path, T_STRING);
if (!NIL_P(rb_options)) {
/* Check for `:backend` */
VALUE rb_backend = rb_hash_aref(rb_options, CSTR2SYM("backend"));
if (rb_backend && !NIL_P(rb_backend)) {
rugged_repo_new_with_backend(&repo, rb_path, rb_backend);
}
}
if(!repo) {
error = git_repository_init(&repo, StringValueCStr(rb_path), RTEST(rb_is_bare));
rugged_exception_check(error);
}
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'])
348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 |
# File 'ext/rugged/rugged_repo.c', line 348
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.
1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 |
# File 'ext/rugged/rugged_repo.c', line 1812
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;
}
|
#attributes(path, options = {}) ⇒ Object
3 4 5 |
# File 'lib/rugged/attributes.rb', line 3 def attributes(path, = {}) Attributes.new(self, path, ) end |
#bare? ⇒ Boolean
Return whether a repository is bare or not. A bare repository has no working directory.
1262 1263 1264 1265 |
# File 'ext/rugged/rugged_repo.c', line 1262
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.
194 195 196 197 198 199 200 201 202 203 |
# File 'lib/rugged/repository.rb', line 194 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
.
2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 |
# File 'ext/rugged/rugged_repo.c', line 2306
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_index(index[,options]) ⇒ nil
Updates files in the index and the working tree to match the content of the commit pointed at by index
.
See Repository#checkout_tree for a list of supported options
.
2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 |
# File 'ext/rugged/rugged_repo.c', line 2258
static VALUE rb_git_checkout_index(int argc, VALUE *argv, VALUE self)
{
VALUE rb_index, rb_options;
git_repository *repo;
git_index *index;
git_checkout_options opts = GIT_CHECKOUT_OPTIONS_INIT;
struct rugged_cb_payload *payload;
int error, exception = 0;
rb_scan_args(argc, argv, "10:", &rb_index, &rb_options);
if (!rb_obj_is_kind_of(rb_index, rb_cRuggedIndex))
rb_raise(rb_eTypeError, "Expected Rugged::Index");
Data_Get_Struct(self, git_repository, repo);
Data_Get_Struct(rb_index, git_index, index);
rugged_parse_checkout_options(&opts, rb_options);
error = git_checkout_index(repo, index, &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.
- :recreate_missing
-
Allow checkout to recreate 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.
2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 |
# File 'ext/rugged/rugged_repo.c', line 2203
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;
}
|
#cherrypick(commit[, options]) ⇒ nil
Cherry-pick the given commit and update the index and working directory accordingly.
‘commit` can be either a string containing a commit id or a `Rugged::Commit` object.
The following options can be passed in the options
Hash:
- :mainline
-
When cherry-picking a merge, you need to specify the parent number (starting from 1) which should be considered the mainline.
2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 |
# File 'ext/rugged/rugged_repo.c', line 2502
static VALUE rb_git_repo_cherrypick(int argc, VALUE *argv, VALUE self)
{
VALUE rb_options, rb_commit;
git_repository *repo;
git_commit *commit;
git_cherrypick_options opts = GIT_CHERRYPICK_OPTIONS_INIT;
int error;
rb_scan_args(argc, argv, "10:", &rb_commit, &rb_options);
if (TYPE(rb_commit) == T_STRING) {
rb_commit = rugged_object_rev_parse(self, rb_commit, 1);
}
if (!rb_obj_is_kind_of(rb_commit, rb_cRuggedCommit)) {
rb_raise(rb_eArgError, "Expected a Rugged::Commit.");
}
Data_Get_Struct(self, git_repository, repo);
Data_Get_Struct(rb_commit, git_commit, commit);
rugged_parse_cherrypick_options(&opts, rb_options);
error = git_cherrypick(repo, commit, &opts);
rugged_exception_check(error);
return Qnil;
}
|
#cherrypick_commit(commit, our_commit, [mainline, options]) ⇒ nil
Cherry-pick the given commit on the given base in-memory and return an index with the result.
‘commit` can be either a string containing a commit id or a `Rugged::Commit` object.
‘our_commit` is the base commit, can be either a string containing a commit id or a `Rugged::Commit` object.
‘mainline` when cherry-picking a merge, this is the parent number
(starting from 1) which should be considered the mainline.
2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 |
# File 'ext/rugged/rugged_repo.c', line 2549
static VALUE rb_git_repo_cherrypick_commit(int argc, VALUE *argv, VALUE self)
{
VALUE rb_options, rb_commit, rb_our_commit, rb_mainline;
git_repository *repo;
git_commit *commit, *our_commit;
git_merge_options opts = GIT_MERGE_OPTIONS_INIT;
git_index *index;
int error, mainline;
rb_scan_args(argc, argv, "21:", &rb_commit, &rb_our_commit, &rb_mainline, &rb_options);
if (TYPE(rb_commit) == T_STRING) {
rb_commit = rugged_object_rev_parse(self, rb_commit, 1);
}
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_commit, rb_cRuggedCommit)) {
rb_raise(rb_eArgError, "Expected a Rugged::Commit.");
}
if (!rb_obj_is_kind_of(rb_our_commit, rb_cRuggedCommit)) {
rb_raise(rb_eArgError, "Expected a Rugged::Commit.");
}
Data_Get_Struct(self, git_repository, repo);
Data_Get_Struct(rb_commit, git_commit, commit);
Data_Get_Struct(rb_our_commit, git_commit, our_commit);
rugged_parse_merge_options(&opts, rb_options);
mainline = NIL_P(rb_mainline) ? 0 : FIX2UINT(rb_mainline);
error = git_cherrypick_commit(&index, repo, commit, our_commit, mainline, &opts);
rugged_exception_check(error);
return rugged_index_new(rb_cRuggedIndex, self, index);
}
|
#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
1750 1751 1752 1753 1754 1755 1756 1757 1758 |
# File 'ext/rugged/rugged_repo.c', line 1750
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.
593 594 595 596 |
# File 'ext/rugged/rugged_repo.c', line 593
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.
582 583 584 585 |
# File 'ext/rugged/rugged_repo.c', line 582
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
177 178 179 180 181 182 183 184 185 186 |
# File 'lib/rugged/repository.rb', line 177 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 362 363 364 365 366 |
# File 'ext/rugged/rugged_note.c', line 349
static VALUE rb_git_note_default_ref_GET(VALUE self)
{
git_repository *repo = NULL;
git_buf ref_name = { 0 };
VALUE rb_result;
Data_Get_Struct(self, git_repository, repo);
rugged_exception_check(
git_note_default_ref(&ref_name, repo)
);
rb_result = rb_enc_str_new(ref_name.ptr, ref_name.size, rb_utf8_encoding());
git_buf_free(&ref_name);
return rb_result;
}
|
#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
1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 |
# File 'ext/rugged/rugged_repo.c', line 1852
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;
}
|
#descendant_of?(commit, ancestor) ⇒ Boolean
commit
and ancestor
must be String commit OIDs or instances of Rugged::Commit.
Returns true if commit
is a descendant of ancestor
, or false if not.
1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 |
# File 'ext/rugged/rugged_repo.c', line 1125
static VALUE rb_git_repo_descendant_of(VALUE self, VALUE rb_commit, VALUE rb_ancestor)
{
int result;
int error;
git_repository *repo;
git_oid commit, ancestor;
Data_Get_Struct(self, git_repository, repo);
error = rugged_oid_get(&commit, repo, rb_commit);
rugged_exception_check(error);
error = rugged_oid_get(&ancestor, repo, rb_ancestor);
rugged_exception_check(error);
result = git_graph_descendant_of(repo, &commit, &ancestor);
rugged_exception_check(result);
return result ? Qtrue : Qfalse;
}
|
#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.
1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 |
# File 'ext/rugged/rugged_repo.c', line 1607
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.
1287 1288 1289 1290 |
# File 'ext/rugged/rugged_repo.c', line 1287
static VALUE rb_git_repo_is_empty(VALUE self)
{
RB_GIT_REPO_GETTER(is_empty);
}
|
#include?(oid) ⇒ Boolean #exists?(oid) ⇒ Boolean
954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 |
# File 'ext/rugged/rugged_repo.c', line 954
static VALUE rb_git_repo_exists(VALUE self, VALUE hex)
{
git_repository *repo;
git_odb *odb;
git_oid oid;
int error;
Data_Get_Struct(self, git_repository, repo);
Check_Type(hex, T_STRING);
error = git_oid_fromstrn(&oid, RSTRING_PTR(hex), RSTRING_LEN(hex));
rugged_exception_check(error);
error = git_repository_odb(&odb, repo);
rugged_exception_check(error);
error = git_odb_exists_prefix(NULL, odb, &oid, RSTRING_LEN(hex));
git_odb_free(odb);
if (error == 0 || error == GIT_EAMBIGUOUS)
return Qtrue;
return Qfalse;
}
|
#expand_oids([oid..], object_type = :any) ⇒ Hash
Expand a list of short oids to their full value, assuming they exist in the repository. If ‘object_type` is passed, OIDs are expected to be of the given type.
Returns a hash of ‘{ short_oid => full_oid }` for the short OIDs which exist in the repository and match the expected object type. Missing OIDs will not appear in the resulting hash.
1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 |
# File 'ext/rugged/rugged_repo.c', line 1057
static VALUE rb_git_repo_expand_oids(int argc, VALUE *argv, VALUE self)
{
VALUE rb_result, rb_oids, rb_expected_type;
git_otype expected_type = GIT_OBJ_ANY;
git_repository *repo;
git_oid oid;
git_odb *odb;
int i, error;
Data_Get_Struct(self, git_repository, repo);
rb_scan_args(argc, argv, "11", &rb_oids, &rb_expected_type);
Check_Type(rb_oids, T_ARRAY);
expected_type = rugged_otype_get(rb_expected_type);
error = git_repository_odb(&odb, repo);
rugged_exception_check(error);
rb_result = rb_hash_new();
for (i = 0; i < RARRAY_LEN(rb_oids); ++i) {
VALUE hex_oid = rb_ary_entry(rb_oids, i);
git_oid found_oid;
if (TYPE(hex_oid) != T_STRING) {
git_odb_free(odb);
rb_raise(rb_eTypeError, "Expected a SHA1 OID");
}
error = git_oid_fromstrn(&oid, RSTRING_PTR(hex_oid), RSTRING_LEN(hex_oid));
if (error < 0) {
git_odb_free(odb);
rugged_exception_check(error);
}
error = git_odb_exists_prefix(&found_oid, odb, &oid, RSTRING_LEN(hex_oid));
if (!error) {
if (expected_type != GIT_OBJ_ANY) {
size_t found_size;
git_otype found_type;
if (git_odb_read_header(&found_size, &found_type, odb, &found_oid) < 0)
continue;
if (found_type != expected_type)
continue;
}
rb_hash_aset(rb_result, hex_oid, rugged_create_oid(&found_oid));
}
}
git_odb_free(odb);
return rb_result;
}
|
#fetch(remote_or_url, *args) ⇒ Object
205 206 207 208 209 210 211 |
# File 'lib/rugged/repository.rb', line 205 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 |
#fetch_attributes(*args) ⇒ Object
2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 |
# File 'ext/rugged/rugged_repo.c', line 2400
static VALUE rb_git_repo_attributes(int argc, VALUE *argv, VALUE self)
{
VALUE rb_path, rb_names, rb_options;
git_repository *repo;
int error, options = 0;
rb_scan_args(argc, argv, "12", &rb_path, &rb_names, &rb_options);
Data_Get_Struct(self, git_repository, repo);
Check_Type(rb_path, T_STRING);
if (!NIL_P(rb_options)) {
Check_Type(rb_options, T_FIXNUM);
options = FIX2INT(rb_options);
}
switch (TYPE(rb_names)) {
case T_ARRAY:
{
VALUE rb_result;
const char **values;
const char **names;
long i, num_attr = RARRAY_LEN(rb_names);
if (num_attr > 32)
rb_raise(rb_eRuntimeError, "Too many attributes requested");
values = alloca(num_attr * sizeof(const char *));
names = alloca(num_attr * sizeof(const char *));
for (i = 0; i < num_attr; ++i) {
VALUE attr = rb_ary_entry(rb_names, i);
Check_Type(attr, T_STRING);
names[i] = StringValueCStr(attr);
}
error = git_attr_get_many(
values, repo, options,
StringValueCStr(rb_path),
(size_t)num_attr, names);
rugged_exception_check(error);
rb_result = rb_hash_new();
for (i = 0; i < num_attr; ++i) {
VALUE attr = rb_ary_entry(rb_names, i);
rb_hash_aset(rb_result, attr, rugged_create_attr(values[i]));
}
return rb_result;
}
case T_STRING:
{
const char *value;
error = git_attr_get(
&value, repo, options,
StringValueCStr(rb_path),
StringValueCStr(rb_names));
rugged_exception_check(error);
return rugged_create_attr(value);
}
case T_NIL:
{
VALUE rb_result = rb_hash_new();
error = git_attr_foreach(
repo, options,
StringValueCStr(rb_path),
&foreach_attr_hash,
(void *)rb_result);
rugged_exception_check(error);
return rb_result;
}
default:
rb_raise(rb_eTypeError,
"Invalid attribute name (expected String or Array)");
}
}
|
#head ⇒ Object
Retrieve and resolve the reference pointed at by the repository’s HEAD
.
Returns nil
if HEAD
is missing.
1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 |
# File 'ext/rugged/rugged_repo.c', line 1343
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.
1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 |
# File 'ext/rugged/rugged_repo.c', line 1321
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));
rugged_exception_check(error);
return Qnil;
}
|
#head_detached? ⇒ Boolean
Return whether the HEAD
of a repository is detached or not.
1298 1299 1300 1301 |
# File 'ext/rugged/rugged_repo.c', line 1298
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).
1310 1311 1312 1313 |
# File 'ext/rugged/rugged_repo.c', line 1310
static VALUE rb_git_repo_head_unborn(VALUE self)
{
RB_GIT_REPO_GETTER(head_unborn);
}
|
#ident ⇒ Object
Return a Hash containing the identity that is used to write reflogs.
ident
is a Hash containing name
and/or email
entries, or ‘nil`.
643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 |
# File 'ext/rugged/rugged_repo.c', line 643
static VALUE rb_git_repo_get_ident(VALUE self)
{
VALUE rb_ident = rb_hash_new();
git_repository *repo;
const char *name = NULL, *email = NULL;
Data_Get_Struct(self, git_repository, repo);
rugged_exception_check(
git_repository_ident(&name, &email, repo)
);
if (name) {
rb_hash_aset(rb_ident, CSTR2SYM("name"), rb_str_new_utf8(name));
}
if (email) {
rb_hash_aset(rb_ident, CSTR2SYM("email"), rb_str_new_utf8(email));
}
return rb_ident;
}
|
#ident=(ident) ⇒ Object
Set the identity to be used for writing reflogs.
ident
can be either nil
or a Hash containing name
and/or email
entries.
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 |
# File 'ext/rugged/rugged_repo.c', line 606
static VALUE rb_git_repo_set_ident(VALUE self, VALUE rb_ident) {
VALUE rb_val;
git_repository *repo;
const char *name = NULL, *email = NULL;
Data_Get_Struct(self, git_repository, repo);
if (!NIL_P(rb_ident)) {
Check_Type(rb_ident, T_HASH);
if (!NIL_P(rb_val = rb_hash_aref(rb_ident, CSTR2SYM("name")))) {
Check_Type(rb_val, T_STRING);
name = StringValueCStr(rb_val);
}
if (!NIL_P(rb_val = rb_hash_aref(rb_ident, CSTR2SYM("email")))) {
Check_Type(rb_val, T_STRING);
email = StringValueCStr(rb_val);
}
}
rugged_exception_check(
git_repository_set_ident(repo, name, email)
);
return Qnil;
}
|
#include?(oid) ⇒ Boolean #exists?(oid) ⇒ Boolean
954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 |
# File 'ext/rugged/rugged_repo.c', line 954
static VALUE rb_git_repo_exists(VALUE self, VALUE hex)
{
git_repository *repo;
git_odb *odb;
git_oid oid;
int error;
Data_Get_Struct(self, git_repository, repo);
Check_Type(hex, T_STRING);
error = git_oid_fromstrn(&oid, RSTRING_PTR(hex), RSTRING_LEN(hex));
rugged_exception_check(error);
error = git_repository_odb(&odb, repo);
rugged_exception_check(error);
error = git_odb_exists_prefix(NULL, odb, &oid, RSTRING_LEN(hex));
git_odb_free(odb);
if (error == 0 || error == GIT_EAMBIGUOUS)
return Qtrue;
return Qfalse;
}
|
#index ⇒ Object
Return the default index for this repository.
564 565 566 567 |
# File 'ext/rugged/rugged_repo.c', line 564
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.
553 554 555 556 |
# File 'ext/rugged/rugged_repo.c', line 553
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.
786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 |
# File 'ext/rugged/rugged_repo.c', line 786
static VALUE rb_git_repo_merge_analysis(int argc, VALUE *argv, VALUE self)
{
int error;
git_repository *repo;
git_commit *their_commit;
git_annotated_commit *annotated_commit;
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_annotated_commit_lookup(&annotated_commit, 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_annotated_commit **) &annotated_commit, 1);
git_annotated_commit_free(annotated_commit);
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.
676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 |
# File 'ext/rugged/rugged_repo.c', line 676
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_bases(oid1, oid2, ...) ⇒ Array #merge_bases(ref1, ref2, ...) ⇒ Array #merge_bases(commit1, commit2, ...) ⇒ Array
Find all merge bases, given two or more commits or oids. Returns an empty array if no merge bases are found.
717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 |
# File 'ext/rugged/rugged_repo.c', line 717
static VALUE rb_git_repo_merge_bases(VALUE self, VALUE rb_args)
{
int error = GIT_OK;
size_t i, len = (size_t)RARRAY_LEN(rb_args);
git_repository *repo;
git_oidarray bases = {NULL, 0};
git_oid *input_array;
VALUE rb_bases;
if (len < 2)
rb_raise(rb_eArgError, "wrong number of arguments (%ld for 2+)", RARRAY_LEN(rb_args));
Data_Get_Struct(self, git_repository, repo);
input_array = xmalloc(sizeof(git_oid) * len);
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_bases_many(&bases, repo, len, input_array);
xfree(input_array);
if (error != GIT_ENOTFOUND)
rugged_exception_check(error);
rb_bases = rb_ary_new2(bases.count);
for (i = 0; i < bases.count; ++i) {
rb_ary_push(rb_bases, rugged_create_oid(&bases.ids[i]));
}
git_oidarray_free(&bases);
return rb_bases;
}
|
#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.
898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 |
# File 'ext/rugged/rugged_repo.c', line 898
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;
int error;
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);
error = git_merge_commits(&index, repo, our_commit, their_commit, &opts);
if (error == GIT_EMERGECONFLICT)
return Qnil;
rugged_exception_check(error);
return rugged_index_new(rb_cRuggedIndex, self, index);
}
|
#namespace ⇒ String
Returns the active namespace for the repository.
1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 |
# File 'ext/rugged/rugged_repo.c', line 1791
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.
1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 |
# File 'ext/rugged/rugged_repo.c', line 1767
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"
1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 |
# File 'ext/rugged/rugged_repo.c', line 1369
static VALUE rb_git_repo_path(VALUE self)
{
git_repository *repo;
const char *path;
Data_Get_Struct(self, git_repository, repo);
path = git_repository_path(repo);
return path ? rb_str_new_utf8(path) : Qnil;
}
|
#path_ignored?(path) ⇒ Boolean
Return whether a path is ignored or not.
2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 |
# File 'ext/rugged/rugged_repo.c', line 2347
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.
219 220 221 222 223 224 225 |
# File 'lib/rugged/repository.rb', line 219 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
.
985 986 987 988 989 990 991 992 993 994 995 996 997 998 |
# File 'ext/rugged/rugged_repo.c', line 985
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.
1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 |
# File 'ext/rugged/rugged_repo.c', line 1015
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) ⇒ 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)
Examples:
repo.reset('origin/master', :hard) #=> nil
1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 |
# File 'ext/rugged/rugged_repo.c', line 1673
static VALUE rb_git_repo_reset(VALUE self, VALUE rb_target, VALUE rb_reset_type)
{
git_repository *repo;
int reset_type;
git_object *target = NULL;
int error;
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);
error = git_reset(repo, target, reset_type, NULL);
git_object_free(target);
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
1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 |
# File 'ext/rugged/rugged_repo.c', line 1710
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 |
#revert_commit(revert_commit, our_commit, options = {}) ⇒ Object
Reverts the given commit against the given “our” commit, producing an index that reflects the result of the revert.
839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 |
# File 'ext/rugged/rugged_repo.c', line 839
static VALUE rb_git_repo_revert_commit(int argc, VALUE *argv, VALUE self)
{
VALUE rb_revert_commit, rb_our_commit, rb_options;
git_commit *revert_commit, *our_commit;
git_index *index;
git_repository *repo;
git_merge_options opts = GIT_MERGE_OPTIONS_INIT;
unsigned int mainline = 0;
int error;
rb_scan_args(argc, argv, "20:", &rb_revert_commit, &rb_our_commit, &rb_options);
if (TYPE(rb_revert_commit) == T_STRING)
rb_revert_commit = rugged_object_rev_parse(self, rb_revert_commit, 1);
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_revert_commit, rb_cRuggedCommit) ||
!rb_obj_is_kind_of(rb_our_commit, rb_cRuggedCommit)) {
rb_raise(rb_eArgError, "Expected a Rugged::Commit.");
}
if (!NIL_P(rb_options)) {
VALUE rb_mainline;
Check_Type(rb_options, T_HASH);
rugged_parse_merge_options(&opts, rb_options);
rb_mainline = rb_hash_aref(rb_options, CSTR2SYM("mainline"));
if (!NIL_P(rb_mainline)) {
Check_Type(rb_mainline, T_FIXNUM);
mainline = FIX2UINT(rb_mainline);
}
}
Data_Get_Struct(self, git_repository, repo);
Data_Get_Struct(rb_revert_commit, git_commit, revert_commit);
Data_Get_Struct(rb_our_commit, git_commit, our_commit);
error = git_revert_commit(&index, repo, revert_commit, our_commit, mainline, &opts);
if (error == GIT_EMERGECONFLICT)
return Qnil;
rugged_exception_check(error);
return rugged_index_new(rb_cRuggedIndex, self, index);
}
|
#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.
1275 1276 1277 1278 |
# File 'ext/rugged/rugged_repo.c', line 1275
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]
1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 |
# File 'ext/rugged/rugged_repo.c', line 1559
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;
}
|
#submodules ⇒ Object
All the submodules in the repository
Returns an SubmoduleCollection containing Rugged::Submodule objects
166 167 168 |
# File 'lib/rugged/repository.rb', line 166 def submodules @submodules ||= SubmoduleCollection.new(self) end |
#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
1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 |
# File 'ext/rugged/rugged_repo.c', line 1393
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
1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 |
# File 'ext/rugged/rugged_repo.c', line 1420
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.
1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 |
# File 'ext/rugged/rugged_repo.c', line 1214
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);
}
|