rugged 0.16.0 → 0.17.0b1

data/ext/rugged/rugged_tag.c

@@ -29,6 +29,15 @@ extern VALUE rb_cRuggedObject;
 extern VALUE rb_cRuggedRepo;
 VALUE rb_cRuggedTag;
 
+/*
+ *	call-seq:
+ *		tag.target -> object
+ *
+ *	Return the +object+ pointed at by this tag, as a <tt>Rugged::Object</tt>
+ *	instance.
+ *		
+ *		tag.target #=> #<Rugged::Commit:0x108828918>
+ */
 static VALUE rb_git_tag_target_GET(VALUE self)
 {
 	git_tag *tag;
@@ -45,14 +54,56 @@ static VALUE rb_git_tag_target_GET(VALUE self)
 	return rugged_object_new(owner, target);
 }
 
+/*
+ *	call-seq:
+ *		tag.target_oid -> oid
+ *
+ *	Return the oid pointed at by this tag, as a <tt>String</tt>
+ *	instance.
+ *
+ *		tag.target #=> "2cb831a8aea28b2c1b9c63385585b864e4d3bad1"
+ */
+static VALUE rb_git_tag_target_oid_GET(VALUE self)
+{
+	git_tag *tag;
+	const git_oid *target_oid;
+	int error;
+
+	Data_Get_Struct(self, git_tag, tag);
+
+	target_oid = git_tag_target_oid(tag);
+
+	return rugged_create_oid(target_oid);
+}
+
+/*
+ *	call-seq:
+ *		tag.type -> t
+ *
+ *	Return a symbol representing the type of the objeced pointed at by
+ *	this +tag+. Possible values are +:blob+, +:commit+, +:tree+ and +:tag+.
+ *
+ *	This is always the same as the +type+ of the returned <tt>tag.target</tt>
+ *
+ *		tag.type #=> :commit
+ *		tag.target.type == tag.type #=> true
+ */
 static VALUE rb_git_tag_target_type_GET(VALUE self)
 {
 	git_tag *tag;
 	Data_Get_Struct(self, git_tag, tag);
 
-	return rugged_str_new2(git_object_type2string(git_tag_type(tag)), NULL);
+	return rugged_otype_new(git_tag_type(tag));
 }
 
+/*
+ *	call-seq:
+ *		tag.name -> name
+ *
+ *	Return a string with the name of this +tag+.
+ *
+ *		tag.name #=> "v0.16.0"
+ */
 static VALUE rb_git_tag_name_GET(VALUE self)
 {
 	git_tag *tag;
@@ -61,6 +112,16 @@ static VALUE rb_git_tag_name_GET(VALUE self)
 	return rugged_str_new2(git_tag_name(tag), NULL);
 }
 
+/*
+ *	call-seq:
+ *		tag.tagger -> signature
+ *
+ *	Return the signature for the author of this +tag+. The signature
+ *	is returned as a +Hash+ containing +:name+, +:email+ of the author
+ *	and +:time+ of the tagging.
+ *
+ *		tag.tagger #=> {:email=>"tanoku@gmail.com", :time=>Tue Jan 24 05:42:45 UTC 2012, :name=>"Vicent Mart\303\255"}
+ */
 static VALUE rb_git_tag_tagger_GET(VALUE self)
 {
 	git_tag *tag;
@@ -69,6 +130,15 @@ static VALUE rb_git_tag_tagger_GET(VALUE self)
 	return rugged_signature_new(git_tag_tagger(tag), NULL);
 }
 
+/*
+ *	call-seq:
+ *		tag.message -> msg
+ *
+ *	Return the message of this +tag+. This includes the full body of the
+ *	message and any optional footers or signatures after it.
+ *
+ *		tag.message #=> "Release v0.16.0, codename 'broken stuff'"
+ */
 static VALUE rb_git_tag_message_GET(VALUE self)
 {
 	git_tag *tag;
@@ -211,6 +281,7 @@ void Init_rugged_tag()
 	rb_define_method(rb_cRuggedTag, "message", rb_git_tag_message_GET, 0);
 	rb_define_method(rb_cRuggedTag, "name", rb_git_tag_name_GET, 0);
 	rb_define_method(rb_cRuggedTag, "target", rb_git_tag_target_GET, 0);
+	rb_define_method(rb_cRuggedTag, "target_oid", rb_git_tag_target_oid_GET, 0);
 	rb_define_method(rb_cRuggedTag, "target_type", rb_git_tag_target_type_GET, 0);
 	rb_define_method(rb_cRuggedTag, "tagger", rb_git_tag_tagger_GET, 0);
 }

data/ext/rugged/rugged_tree.c

@@ -67,6 +67,16 @@ static VALUE rb_git_treeentry_fromC(const git_tree_entry *entry)
 /*
  * Rugged Tree
  */
+/*
+ *	call-seq:
+ *		tree.count -> count
+ *		tree.length -> count
+ *
+ *	Return the number of entries contained in the tree.
+ *
+ *	Note that this only applies to entries in the root of the tree,
+ *	not any other entries contained in sub-folders.
+ */
 static VALUE rb_git_tree_entrycount(VALUE self)
 {
 	git_tree *tree;
@@ -75,6 +85,23 @@ static VALUE rb_git_tree_entrycount(VALUE self)
 	return INT2FIX(git_tree_entrycount(tree));
 }
 
+/*
+ *	call-seq:
+ *		tree[e] -> entry
+ *		tree.get_entry(e) -> entry
+ *
+ *	Return one of the entries from a tree as a +Hash+. If +e+ is a number, the +e+nth entry
+ *	from the tree will be returned. If +e+ is a string, the entry with that name
+ *	will be returned.
+ *
+ *	If the entry doesn't exist, +nil+ will be returned.
+ *
+ *		tree[3] #=> {:name => "foo.txt", :type => :blob, :oid => "d8786bfc97485e8d7b19b21fb88c8ef1f199fc3f", :attributes => 0}
+ *
+ *		tree['bar.txt'] #=> {:name => "bar.txt", :type => :blob, :oid => "de5ba987198bcf2518885f0fc1350e5172cded78", :attributes => 0}
+ *
+ *		tree['baz.txt'] #=> nil
+ */
 static VALUE rb_git_tree_get_entry(VALUE self, VALUE entry_id)
 {
 	git_tree *tree;
@@ -90,6 +117,25 @@ static VALUE rb_git_tree_get_entry(VALUE self, VALUE entry_id)
 		rb_raise(rb_eTypeError, "entry_id must be either an index or a filename");
 }
 
+/*
+ *	call-seq:
+ *		tree.each { |entry| block }
+ *		tree.each -> Iterator
+ *
+ *	Call +block+ with each of the entries of the subtree as a +Hash+. If no +block+
+ *	is given, an +Iterator+ is returned instead.
+ *
+ *	Note that only the entries in the root of the tree are yielded; if you need to
+ *	list also entries in subfolders, use +tree.walk+ instead.
+ *
+ *		tree.each { |entry| puts entry.inspect }
+ *
+ *	generates:
+ *
+ *		{:name => "foo.txt", :type => :blob, :oid => "d8786bfc97485e8d7b19b21fb88c8ef1f199fc3f", :attributes => 0}
+ *		{:name => "bar.txt", :type => :blob, :oid => "de5ba987198bcf2518885f0fc1350e5172cded78", :attributes => 0}
+ *		...
+ */
 static VALUE rb_git_tree_each(VALUE self)
 {
 	git_tree *tree;
@@ -115,9 +161,31 @@ static int rugged__treewalk_cb(const char *root, git_tree_entry *entry, void *pr
 		rugged_str_new2(root, NULL),
 		rb_git_treeentry_fromC(entry));
 
-	return GIT_SUCCESS;
+	return GIT_OK;
 }
 
+/*
+ *	call-seq:
+ *		tree.walk(mode) { |root, entry| block }
+ *		tree.walk(mode) -> Iterator
+ *
+ *	Walk +tree+ with the given mode (either +:preorder+ or +:postorder+) and yield
+ *	to +block+ every entry in +tree+ and all its subtrees, as a +Hash+. The +block+
+ *	also takes a +root+, the relative path in the traversal, starting from the root
+ *	of the original tree.
+ *
+ *	If no +block+ is given, an +Iterator+ is returned instead.
+ *
+ *		tree.walk(:postorder) { |root, entry| puts "#{root}#{entry[:name]} [#{entry[:oid]}]" }
+ *
+ *	generates:
+ *
+ *		USAGE.rb [02bae86c91f96b5fdb6b1cf06f5aa3612139e318]
+ *		ext [23f135b3c576b6ac4785821888991d7089f35db1]
+ *		ext/rugged [25c88faa9302e34e16664eb9c990deb2bcf77849]
+ *		ext/rugged/extconf.rb [40c1aa8a8cec8ca444ed5758e3f00ecff093070a]
+ *		...
+ */
 static VALUE rb_git_tree_walk(VALUE self, VALUE rb_mode)
 {
 	git_tree *tree;
@@ -222,7 +290,7 @@ static VALUE rb_git_treebuilder_insert(VALUE self, VALUE rb_entry)
 	Data_Get_Struct(self, git_treebuilder, builder);
 	Check_Type(rb_entry, T_HASH);
 
-	rb_path = rb_hash_aref(rb_entry, CSTR2SYM("path"));
+	rb_path = rb_hash_aref(rb_entry, CSTR2SYM("name"));
 	Check_Type(rb_path, T_STRING);
 
 	rb_oid = rb_hash_aref(rb_entry, CSTR2SYM("oid"));

data/ext/rugged/vendor/libgit2-dist/deps/regex/config.h

@@ -0,0 +1,7 @@
+#ifndef _REGEX_CONFIG_H_
+#define _REGEX_CONFIG_H_
+
+# define GAWK
+# define NO_MBSUPPORT
+
+#endif