module Rugged
Copyright (C) the Rugged
contributors. All rights reserved.
This file is part of Rugged
, distributed under the MIT license. For full terms see the included LICENSE file.
Copyright (C) the Rugged
contributors. All rights reserved.
This file is part of Rugged
, distributed under the MIT license. For full terms see the included LICENSE file.
Copyright (C) the Rugged
contributors. All rights reserved.
This file is part of Rugged
, distributed under the MIT license. For full terms see the included LICENSE file.
Copyright (C) the Rugged
contributors. All rights reserved.
This file is part of Rugged
, distributed under the MIT license. For full terms see the included LICENSE file.
Copyright (C) the Rugged
contributors. All rights reserved.
This file is part of Rugged
, distributed under the MIT license. For full terms see the included LICENSE file.
Copyright (C) the Rugged
contributors. All rights reserved.
This file is part of Rugged
, distributed under the MIT license. For full terms see the included LICENSE file.
Copyright (C) the Rugged
contributors. All rights reserved.
This file is part of Rugged
, distributed under the MIT license. For full terms see the included LICENSE file.
Copyright (C) the Rugged
contributors. All rights reserved.
This file is part of Rugged
, distributed under the MIT license. For full terms see the included LICENSE file.
Copyright (C) the Rugged
contributors. All rights reserved.
This file is part of Rugged
, distributed under the MIT license. For full terms see the included LICENSE file.
Copyright (C) the Rugged
contributors. All rights reserved.
This file is part of Rugged
, distributed under the MIT license. For full terms see the included LICENSE file.
Copyright (C) the Rugged
contributors. All rights reserved.
This file is part of Rugged
, distributed under the MIT license. For full terms see the included LICENSE file.
Copyright (C) the Rugged
contributors. All rights reserved.
This file is part of Rugged
, distributed under the MIT license. For full terms see the included LICENSE file.
Copyright (C) the Rugged
contributors. All rights reserved.
This file is part of Rugged
, distributed under the MIT license. For full terms see the included LICENSE file.
Copyright (C) the Rugged
contributors. All rights reserved.
This file is part of Rugged
, distributed under the MIT license. For full terms see the included LICENSE file.
Copyright (C) the Rugged
contributors. All rights reserved.
This file is part of Rugged
, distributed under the MIT license. For full terms see the included LICENSE file.
Copyright (C) the Rugged
contributors. All rights reserved.
This file is part of Rugged
, distributed under the MIT license. For full terms see the included LICENSE file.
Copyright (C) the Rugged
contributors. All rights reserved.
This file is part of Rugged
, distributed under the MIT license. For full terms see the included LICENSE file.
Copyright (C) the Rugged
contributors. All rights reserved.
This file is part of Rugged
, distributed under the MIT license. For full terms see the included LICENSE file.
Copyright (C) the Rugged
contributors. All rights reserved.
This file is part of Rugged
, distributed under the MIT license. For full terms see the included LICENSE file.
Constants
- SORT_DATE
Sort the repository contents by commit time; this sorting mode can be combined with topological sorting.
- SORT_NONE
Sort the output with the same default time-order method from git. This is the default sorting for new walkers.
- SORT_REVERSE
Iterate through the repository contents in reverse order; this sorting mode can be combined with any of the above.
- SORT_TOPO
Sort the repository contents in topological order (parents before children); this sorting mode can be combined with time sorting to produce git's “time-order”.
- Version
Public Class Methods
Returns an array representing the current bytes in the internal libgit2 cache and the maximum size of the cache.
static VALUE rb_git_cache_usage(VALUE self) { int64_t used, max; git_libgit2_opts(GIT_OPT_GET_CACHED_MEMORY, &used, &max); return rb_ary_new3(2, LL2NUM(used), LL2NUM(max)); }
static VALUE rb_git_path_is_dotgit_attributes(VALUE self, VALUE rb_path) { const char *path; int is_dotgit; Check_Type(rb_path, T_STRING); path = StringValueCStr(rb_path); is_dotgit = git_path_is_gitfile(path, strlen(path), GIT_PATH_GITFILE_GITATTRIBUTES, GIT_PATH_FS_GENERIC); return is_dotgit ? Qtrue : Qfalse; }
static VALUE rb_git_path_is_dotgit_ignore(VALUE self, VALUE rb_path) { const char *path; int is_dotgit; Check_Type(rb_path, T_STRING); path = StringValueCStr(rb_path); is_dotgit = git_path_is_gitfile(path, strlen(path), GIT_PATH_GITFILE_GITIGNORE, GIT_PATH_FS_GENERIC); return is_dotgit ? Qtrue : Qfalse; }
static VALUE rb_git_path_is_dotgit_modules(VALUE self, VALUE rb_path) { const char *path; int is_dotgit; Check_Type(rb_path, T_STRING); path = StringValueCStr(rb_path); is_dotgit = git_path_is_gitfile(path, strlen(path), GIT_PATH_GITFILE_GITMODULES, GIT_PATH_FS_GENERIC); return is_dotgit ? Qtrue : Qfalse; }
Returns an array representing the features that libgit2 was compiled with — this includes `:threads` (thread support), `:https` and `:ssh`.
Rugged.features #=> [:threads, :https]
static VALUE rb_git_features(VALUE self) { VALUE ret_arr = rb_ary_new(); int caps = git_libgit2_features(); if (caps & GIT_FEATURE_THREADS) rb_ary_push(ret_arr, CSTR2SYM("threads")); if (caps & GIT_FEATURE_HTTPS) rb_ary_push(ret_arr, CSTR2SYM("https")); if (caps & GIT_FEATURE_SSH) rb_ary_push(ret_arr, CSTR2SYM("ssh")); return ret_arr; }
Turn a string of 40 hexadecimal characters into the buffer of 20 bytes it represents.
Rugged.hex_to_raw('d8786bfc97485e8d7b19b21fb88c8ef1f199fc3f') #=> "\330xk\374\227H^\215{\031\262\037\270\214\216\361\361\231\374?"
static VALUE rb_git_hex_to_raw(VALUE self, VALUE hex) { git_oid oid; Check_Type(hex, T_STRING); rugged_exception_check(git_oid_fromstr(&oid, StringValueCStr(hex))); return rb_str_new((const char *)oid.id, 20); }
Returns a string with the prerelease string for libgit2. This will be empty for tagged releases.
static VALUE rb_git_libgit2_prerelease(VALUE self) { const char *prerelease; prerelease = git_libgit2_prerelease(); return rb_str_new_utf8(prerelease ? prerelease : ""); }
Returns an array representing the current libgit2 version in use. Using the array makes it easier for the end-user to take conditional actions based on each respective version attribute: major, minor, rev.
Rugged.libgit2_version #=> [0, 17, 0]
static VALUE rb_git_libgit2_version(VALUE self) { int major; int minor; int rev; git_libgit2_version(&major, &minor, &rev); // We return an array of three elements to represent the version components return rb_ary_new3(3, INT2NUM(major), INT2NUM(minor), INT2NUM(rev)); }
Iterate through oid_iterator
, which should yield any number of SHA1 OIDs (represented as 40-character hexadecimal strings), and tries to minify them.
Minifying a set of a SHA1 strings means finding the shortest root substring for each string that uniquely identifies it.
If no block
is given, the function will return the minimal length as an integer value:
oids = [ 'd8786bfc974aaaaaaaaaaaaaaaaaaaaaaaaaaaaa', 'd8786bfc974bbbbbbbbbbbbbbbbbbbbbbbbbbbbb', 'd8786bfc974ccccccccccccccccccccccccccccc', '68d041ee999cb07c6496fbdd4f384095de6ca9e1', ] Rugged.minimize_oids(oids) #=> 12
If a block
is given, it will be called with each OID from iterator
in its minified form:
Rugged.minimize_oid(oids) { |oid| puts oid }
produces:
d8786bfc974a d8786bfc974b d8786bfc974c 68d041ee999c
The optional min_length
argument allows you to specify a lower bound for the minified strings; returned strings won't be shorter than the given value, even if they would still be uniquely represented.
Rugged.minimize_oid(oids, 18) #=> 18
static VALUE rb_git_minimize_oid(int argc, VALUE *argv, VALUE self) { git_oid_shorten *shrt; int length, minlen = 7; VALUE rb_enum, rb_minlen, rb_block; rb_scan_args(argc, argv, "11&", &rb_enum, &rb_minlen, &rb_block); if (!NIL_P(rb_minlen)) { Check_Type(rb_minlen, T_FIXNUM); minlen = FIX2INT(rb_minlen); } if (!rb_respond_to(rb_enum, rb_intern("each"))) rb_raise(rb_eTypeError, "Expecting an Enumerable instance"); shrt = git_oid_shorten_new(minlen); rb_block_call(rb_enum, rb_intern("each"), 0, NULL, minimize_cb, (VALUE)shrt); length = git_oid_shorten_add(shrt, NULL); git_oid_shorten_free(shrt); rugged_exception_check(length); if (!NIL_P(rb_block)) { VALUE yield_data[2]; yield_data[0] = rb_block; yield_data[1] = INT2FIX(length); rb_block_call(rb_enum, rb_intern("each"), 0, NULL, minimize_yield, (VALUE)yield_data); return Qnil; } return INT2FIX(length); }
Process a commit or tag message into standard form, by stripping trailing spaces and comments, and making sure that the message has a proper header line.
static VALUE rb_git_prettify_message(int argc, VALUE *argv, VALUE self) { char comment_char = '#'; int strip_comments = 1; git_buf message = { NULL }; VALUE rb_message, rb_strip; int error; VALUE result = Qnil; rb_scan_args(argc, argv, "11", &rb_message, &rb_strip); Check_Type(rb_message, T_STRING); switch (TYPE(rb_strip)) { case T_FALSE: strip_comments = 0; break; case T_STRING: if (RSTRING_LEN(rb_strip) > 0) comment_char = RSTRING_PTR(rb_strip)[0]; break; case T_TRUE: case T_NIL: default: break; } error = git_message_prettify(&message, StringValueCStr(rb_message), strip_comments, comment_char); if (!error) result = rb_enc_str_new(message.ptr, message.size, rb_utf8_encoding()); git_buf_dispose(&message); rugged_exception_check(error); return result; }
Turn a buffer of 20 bytes (representing a SHA1 OID) into its readable hexadecimal representation.
Rugged.raw_to_hex("\330xk\374\227H^\215{\031\262\037\270\214\216\361\361\231\374?") #=> "d8786bfc97485e8d7b19b21fb88c8ef1f199fc3f"
static VALUE rb_git_raw_to_hex(VALUE self, VALUE raw) { git_oid oid; char out[40]; Check_Type(raw, T_STRING); if (RSTRING_LEN(raw) != GIT_OID_RAWSZ) rb_raise(rb_eTypeError, "Invalid buffer size for an OID"); git_oid_fromraw(&oid, (const unsigned char *)RSTRING_PTR(raw)); git_oid_fmt(out, &oid); return rb_usascii_str_new(out, 40); }
Parse the signature from the given buffer. If an encoding is given, the strings will be tagged with that encoding.
commit.author #=> {:email=>"tanoku@gmail.com", :time=>Tue Jan 24 05:42:45 UTC 2012, :name=>"Vicent Mart\303\255"}
static VALUE rb_git_signature_from_buffer(int argc, VALUE *argv, VALUE self) { VALUE rb_buffer, rb_encoding_name; const char *buffer, *encoding_name = NULL; rb_scan_args(argc, argv, "11", &rb_buffer, &rb_encoding_name); buffer = StringValueCStr(rb_buffer); if (!NIL_P(rb_encoding_name)) encoding_name = StringValueCStr(rb_encoding_name); return rugged_signature_from_buffer(buffer, encoding_name); }
Checks to see if a string contains a full 40-character sha1.
Rugged.valid_full_oid?('d8786bfc97485e8d7b19b21fb88c8ef1f199fc3f') #=> true
static VALUE rb_git_valid_full_oid(VALUE self, VALUE hex) { git_oid oid; int errorcode; Check_Type(hex, T_STRING); errorcode = git_oid_fromstr(&oid, StringValueCStr(hex)); if (errorcode < 0) { return Qfalse; } else { return Qtrue; } }