class Rugged::Remote
Public Instance Methods
Add a fetch refspec to the remote.
static VALUE rb_git_remote_add_fetch(VALUE self, VALUE rb_refspec) { return rb_git_remote_add_refspec(self, rb_refspec, GIT_DIRECTION_FETCH); }
Add a push refspec to the remote.
static VALUE rb_git_remote_add_push(VALUE self, VALUE rb_refspec) { return rb_git_remote_add_refspec(self, rb_refspec, GIT_DIRECTION_PUSH); }
Try to connect to the remote
. Useful to simulate git
fetch --dry-run
and git push --dry-run
.
Returns true
if connection is successful, false
otherwise.
direction
must be either :fetch
or
:push
.
The following options can be passed in the options
Hash:
credentials
-
The credentials to use for the connection. 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.
Example:
remote = repo.remotes["origin"] success = remote.check_connection(:fetch) raise Error("Unable to pull without credentials") unless success
static VALUE rb_git_remote_check_connection(int argc, VALUE *argv, VALUE self) { git_remote *remote; git_remote_callbacks callbacks = GIT_REMOTE_CALLBACKS_INIT; struct rugged_remote_cb_payload payload = { Qnil, Qnil, Qnil, Qnil, Qnil, Qnil, 0 }; VALUE rb_direction, rb_options; ID id_direction; int error, direction; Data_Get_Struct(self, git_remote, remote); rb_scan_args(argc, argv, "01:", &rb_direction, &rb_options); Check_Type(rb_direction, T_SYMBOL); id_direction = SYM2ID(rb_direction); if (id_direction == rb_intern("fetch")) direction = GIT_DIRECTION_FETCH; else if (id_direction == rb_intern("push")) direction = GIT_DIRECTION_PUSH; else rb_raise(rb_eTypeError, "Invalid direction. Expected :fetch or :push"); rugged_remote_init_callbacks_and_payload_from_options(rb_options, &callbacks, &payload); if ((error = git_remote_set_callbacks(remote, &callbacks)) < 0) goto cleanup; if (git_remote_connect(remote, direction)) return Qfalse; else { git_remote_disconnect(remote); return Qtrue; } cleanup: if (payload.exception) rb_jump_tag(payload.exception); rugged_exception_check(error); return Qfalse; }
Remove all configured fetch and push refspecs from the remote.
static VALUE rb_git_remote_clear_refspecs(VALUE self) { git_remote *remote; Data_Get_Struct(self, git_remote, remote); git_remote_clear_refspecs(remote); return Qnil; }
Downloads new data from the remote for the given refspecs
and
updates tips.
You can optionally pass in a single or multiple alternative
refspecs
to use instead of the fetch refspecs already
configured for remote
.
Returns a hash containing statistics for the fetch operation.
The following options can be passed in the options
Hash:
- :credentials
-
The credentials to use for the fetch 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 is updated locally. It will be passed the
refname
,old_oid
andnew_oid
. - :message
-
The message to insert into the reflogs. Defaults to “fetch”.
- :signature
-
The signature to be used for updating the reflogs.
Example:
remote = Rugged::Remote.lookup(@repo, 'origin') remote.fetch({ transfer_progress: lambda { |total_objects, indexed_objects, received_objects, local_objects, total_deltas, indexed_deltas, received_bytes| # ... } })
static VALUE rb_git_remote_fetch(int argc, VALUE *argv, VALUE self) { git_remote *remote; git_repository *repo; git_signature *signature = NULL; git_strarray refspecs; git_remote_callbacks callbacks = GIT_REMOTE_CALLBACKS_INIT; struct rugged_remote_cb_payload payload = { Qnil, Qnil, Qnil, Qnil, Qnil, Qnil, 0 }; char *log_message = NULL; int error; VALUE rb_options, rb_refspecs, rb_result = Qnil, rb_repo = rugged_owner(self); rb_scan_args(argc, argv, "01:", &rb_refspecs, &rb_options); rugged_rb_ary_to_strarray(rb_refspecs, &refspecs); Data_Get_Struct(self, git_remote, remote); rugged_check_repo(rb_repo); Data_Get_Struct(rb_repo, git_repository, repo); rugged_remote_init_callbacks_and_payload_from_options(rb_options, &callbacks, &payload); if (!NIL_P(rb_options)) { VALUE 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); } if ((error = git_remote_set_callbacks(remote, &callbacks))) goto cleanup; if ((error = git_remote_fetch(remote, &refspecs, signature, log_message)) == GIT_OK) { const git_transfer_progress *stats = git_remote_stats(remote); rb_result = rb_hash_new(); rb_hash_aset(rb_result, CSTR2SYM("total_objects"), UINT2NUM(stats->total_objects)); rb_hash_aset(rb_result, CSTR2SYM("indexed_objects"), UINT2NUM(stats->indexed_objects)); rb_hash_aset(rb_result, CSTR2SYM("received_objects"), UINT2NUM(stats->received_objects)); rb_hash_aset(rb_result, CSTR2SYM("local_objects"), UINT2NUM(stats->local_objects)); rb_hash_aset(rb_result, CSTR2SYM("total_deltas"), UINT2NUM(stats->total_deltas)); rb_hash_aset(rb_result, CSTR2SYM("indexed_deltas"), UINT2NUM(stats->indexed_deltas)); rb_hash_aset(rb_result, CSTR2SYM("received_bytes"), INT2FIX(stats->received_bytes)); } cleanup: xfree(refspecs.strings); git_signature_free(signature); if (payload.exception) rb_jump_tag(payload.exception); rugged_exception_check(error); return rb_result; }
Get the remote's list of fetch refspecs as array
.
static VALUE rb_git_remote_fetch_refspecs(VALUE self) { return rb_git_remote_refspecs(self, GIT_DIRECTION_FETCH); }
Connects remote
to list all references available along with
their associated commit ids.
The given block is called once for each remote head with a Hash containing the following keys:
- :local?
-
true
if the remote head is available locally,false
otherwise. - :oid
-
The id of the object the remote head is currently pointing to.
- :loid
-
The id of the object the local copy of the remote head is currently pointing to. Set to
nil
if there is no local copy of the remote head. - :name
-
The fully qualified reference name of the remote head.
If no block is given, an enumerator will be returned.
The following options can be passed in the options
Hash:
- :credentials
-
The credentials to use for the ls 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.
static VALUE rb_git_remote_ls(int argc, VALUE *argv, VALUE self) { git_remote *remote; git_remote_callbacks callbacks = GIT_REMOTE_CALLBACKS_INIT; const git_remote_head **heads; struct rugged_remote_cb_payload payload = { Qnil, Qnil, Qnil, Qnil, Qnil, Qnil, 0 }; VALUE rb_options; int error; size_t heads_len, i; Data_Get_Struct(self, git_remote, remote); rb_scan_args(argc, argv, ":", &rb_options); if (!rb_block_given_p()) return rb_funcall(self, rb_intern("to_enum"), 2, CSTR2SYM("ls"), rb_options); rugged_remote_init_callbacks_and_payload_from_options(rb_options, &callbacks, &payload); if ((error = git_remote_set_callbacks(remote, &callbacks)) || (error = git_remote_connect(remote, GIT_DIRECTION_FETCH)) || (error = git_remote_ls(&heads, &heads_len, remote))) goto cleanup; for (i = 0; i < heads_len && !payload.exception; i++) rb_protect(rb_yield, rugged_rhead_new(heads[i]), &payload.exception); cleanup: git_remote_disconnect(remote); if (payload.exception) rb_jump_tag(payload.exception); rugged_exception_check(error); return Qnil; }
Returns the remote's name.
remote.name #=> "origin"
static VALUE rb_git_remote_name(VALUE self) { git_remote *remote; const char * name; Data_Get_Struct(self, git_remote, remote); name = git_remote_name(remote); return name ? rb_str_new_utf8(name) : Qnil; }
Pushes the given refspecs
to the given remote
.
Returns a hash that contains key-value pairs that reflect pushed refs and
error messages, if applicable.
You can optionally pass in an alternative list of refspecs
to
use instead of the push refspecs already configured for
remote
.
The following options can be passed in the options
Hash:
- :credentials
-
The credentials to use for the push 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. - :update_tips
-
A callback that will be executed each time a reference is updated remotely. It will be passed the
refname
,old_oid
andnew_oid
. - :message
-
A single line log message to be appended to the reflog of each local remote-tracking branch that gets updated. Defaults to: “fetch”.
- :signature
-
The signature to be used for populating the reflog entries.
Example:
remote = Rugged::Remote.lookup(@repo, 'origin') remote.push(["refs/heads/master", ":refs/heads/to_be_deleted"])
static VALUE rb_git_remote_push(int argc, VALUE *argv, VALUE self) { VALUE rb_refspecs, rb_options, rb_val; VALUE rb_repo = rugged_owner(self); git_repository *repo; git_remote *remote; git_remote_callbacks callbacks = GIT_REMOTE_CALLBACKS_INIT; git_signature *signature = NULL; git_strarray refspecs; git_push_options opts = GIT_PUSH_OPTIONS_INIT; int error = 0; char *log_message = NULL; struct rugged_remote_cb_payload payload = { Qnil, Qnil, Qnil, Qnil, Qnil, rb_hash_new(), 0 }; rb_scan_args(argc, argv, "01:", &rb_refspecs, &rb_options); rugged_rb_ary_to_strarray(rb_refspecs, &refspecs); rugged_check_repo(rb_repo); Data_Get_Struct(rb_repo, git_repository, repo); Data_Get_Struct(self, git_remote, remote); rugged_remote_init_callbacks_and_payload_from_options(rb_options, &callbacks, &payload); if (!NIL_P(rb_options)) { rb_val = rb_hash_aref(rb_options, CSTR2SYM("message")); if (!NIL_P(rb_val)) log_message = StringValueCStr(rb_val); rb_val = rb_hash_aref(rb_options, CSTR2SYM("signature")); if (!NIL_P(rb_val)) signature = rugged_signature_get(rb_val, repo); } if ((error = git_remote_set_callbacks(remote, &callbacks))) goto cleanup; error = git_remote_push(remote, &refspecs, &opts, signature, log_message); cleanup: xfree(refspecs.strings); git_signature_free(signature); if (payload.exception) rb_jump_tag(payload.exception); rugged_exception_check(error); return payload.result; }
Get the remote's list of push refspecs as array
.
static VALUE rb_git_remote_push_refspecs(VALUE self) { return rb_git_remote_refspecs(self, GIT_DIRECTION_PUSH); }
Returns the remote's url for pushing or nil if no special url for pushing is set.
remote.push_url #=> "git://github.com/libgit2/rugged.git"
static VALUE rb_git_remote_push_url(VALUE self) { git_remote *remote; const char * push_url; Data_Get_Struct(self, git_remote, remote); push_url = git_remote_pushurl(remote); return push_url ? rb_str_new_utf8(push_url) : Qnil; }
Sets the remote's url for pushing without persisting it in the config. Existing connections will not be updated.
remote.push_url = 'git@github.com/libgit2/rugged.git' #=> "git@github.com/libgit2/rugged.git"
static VALUE rb_git_remote_set_push_url(VALUE self, VALUE rb_url) { git_remote *remote; Check_Type(rb_url, T_STRING); Data_Get_Struct(self, git_remote, remote); rugged_exception_check( git_remote_set_pushurl(remote, StringValueCStr(rb_url)) ); return rb_url; }
Saves the remote data (url, fetchspecs, …) to the config.
Anonymous, in-memory remotes created through +ReferenceCollection#create_anonymous+ can not be saved. Doing so will result in an exception being raised.
static VALUE rb_git_remote_save(VALUE self) { git_remote *remote; Data_Get_Struct(self, git_remote, remote); rugged_exception_check( git_remote_save(remote) ); return Qtrue; }
Returns the remote's url
remote.url #=> "git://github.com/libgit2/rugged.git"
static VALUE rb_git_remote_url(VALUE self) { git_remote *remote; Data_Get_Struct(self, git_remote, remote); return rb_str_new_utf8(git_remote_url(remote)); }
Sets the remote's url without persisting it in the config. Existing connections will not be updated.
remote.url = 'git://github.com/libgit2/rugged.git' #=> "git://github.com/libgit2/rugged.git"
static VALUE rb_git_remote_set_url(VALUE self, VALUE rb_url) { git_remote *remote; Check_Type(rb_url, T_STRING); Data_Get_Struct(self, git_remote, remote); rugged_exception_check( git_remote_set_url(remote, StringValueCStr(rb_url)) ); return rb_url; }