ruby-rpm 1.3.0 → 1.3.1

data/ext/rpm/source.c

@@ -17,6 +17,16 @@ static ID id_fn;
 static ID id_num;
 static ID id_no;
 
+/*
+ * Creates a new +Source+ object
+ * @param [String] url
+ * @param [Number] source number (index)
+ * @param [Boolean] nosource Sets the NoSource flag (default false)
+ *
+ * @example
+ *   RPM::Source.new ('http://example.com/hoge/hoge.tar.bz2', 0)
+ *   RPM:: Source.new ('http://example.com/fuga/fuga.tar.gz', 1, true)
+ */
 static VALUE
 source_initialize(int argc, VALUE* argv, VALUE src)
 {
@@ -93,12 +103,24 @@ rpm_icon_new(const char* fullname, unsigned int num, int no)
 	return src;
 }
 
+/*
+ * @return [String] Source's fullname
+ * @example
+ *   src = RPM::Source.new('http://example.com/hoge/hoge.tar.bz2', 0)
+ *   src.fullname => 'http://example.com/hoge/hoge.tar.bz2'
+ */
 VALUE
 rpm_source_get_fullname(VALUE src)
 {
 	return rb_ivar_get(src, id_full);
 }
 
+/*
+ * @return [String] Source's filename
+ * @example
+ *   src = RPM::Source.new('http://example.com/hoge/hoge.tar.bz2', 0)
+ *   src.filename => 'hoge.tar.bz2'
+ */
 VALUE
 rpm_source_get_filename(VALUE src)
 {
@@ -119,12 +141,24 @@ rpm_source_get_filename(VALUE src)
 	return fn;
 }
 
+/*
+ * @return [Number] Source's index
+ * @example
+ *   src = RPM::Source.new ('http://example.com/hoge/hoge.tar.bz2', 0)
+ *   src.num => 0
+ */
 VALUE
 rpm_source_get_num(VALUE src)
 {
 	return rb_ivar_get(src, id_num);
 }
 
+/*
+ * @return [Boolean] Whether the NoSource flag is set
+ * @example
+ *   src = RPM::Source.new('http://example.com/hoge/hoge.tar.bz2', 0, true)
+ *   src.no? => true
+ */
 VALUE
 rpm_source_is_no(VALUE src)
 {

data/ext/rpm/spec.c

@@ -17,6 +17,11 @@ static ID id_src;
 static ID id_pkg;
 static ID id_rest;
 
+#if RPM_VERSION(5,0,0) <= RPM_VERSION_CODE
+#define headerGetEntryMinMemory(hdr,tag,type,ptr,cnt) \
+        headerGetEntry(hdr,tag,type,(void**)ptr,cnt)
+#endif
+
 #if RPM_VERSION_CODE < RPM_VERSION(4,1,0)
 static void
 spec_free(Spec rspec)
@@ -33,6 +38,11 @@ ts_free(rpmts ts)
 
 #endif
 
+/*
+ * Create a spec file object from a spec file
+ * @param [String] filename Spec file path
+ * @return [Spec]
+ */
 static VALUE
 spec_s_open(VALUE klass, VALUE filename)
 {
@@ -59,7 +69,15 @@ spec_s_open(VALUE klass, VALUE filename)
 	return Data_Wrap_Struct(klass, NULL, spec_free, rspec);
 #else
 	ts = rpmtsCreate();
+#if RPM_VERSION_CODE < RPM_VERSION(4,4,8)
+	switch (parseSpec(ts, RSTRING_PTR(filename), "/", NULL, 0, "", NULL, 1, 1)) {
+#elif RPM_VERSION_CODE < RPM_VERSION(4,5,90)
+	switch (parseSpec(ts, RSTRING_PTR(filename), "/", 0, "", NULL, 1, 1, 0)) {
+#elif RPM_VERSION_CODE < RPM_VERSION(5,0,0)
 	switch (parseSpec(ts, RSTRING_PTR(filename), "/", NULL, 0, "", NULL, 1, 1)) {
+#else
+	switch (parseSpec(ts, RSTRING_PTR(filename), "/", 0, "", NULL, 1, 1, 0)) {
+#endif
 	case 0:
 		if (ts != NULL) {
 			break;
@@ -72,27 +90,46 @@ spec_s_open(VALUE klass, VALUE filename)
 #endif
 }
 
+/*
+ *
+ * Alias for Spec#open
+ */
 VALUE
 rpm_spec_open(const char* filename)
 {
 	return spec_s_open(rpm_cSpec, rb_str_new2(filename));
 }
 
+/*
+ * @return [String] Return Build root defined in the spec file
+ */
 VALUE
 rpm_spec_get_buildroot(VALUE spec)
 {
-#if RPM_VERSION_CODE >= RPM_VERSION(4,5,90)
+#if RPM_VERSION_CODE < RPM_VERSION(4,5,90)
+	if (RPM_SPEC(spec)->buildRootURL) {
+		return rb_str_new2(RPM_SPEC(spec)->buildRootURL);
+	}
+#elif RPM_VERSION_CODE < RPM_VERSION(4,5,90)
+	if (RPM_SPEC(spec)->rootURL) {
+		return rb_str_new2(RPM_SPEC(spec)->rootURL);
+	}
+#elif RPM_VERSION_CODE < RPM_VERSION(5,0,0)
 	if (RPM_SPEC(spec)->buildRoot) {
 		return rb_str_new2(RPM_SPEC(spec)->buildRoot);
 	}
 #else
-	if (RPM_SPEC(spec)->buildRootURL) {
-		return rb_str_new2(RPM_SPEC(spec)->buildRootURL);
-	}
+	const char *buildRootURL = rpmGenPath(RPM_SPEC(spec)->rootURL, "%{?buildroot}", NULL);
+	VALUE result = rb_str_new2(buildRootURL);
+	buildRootURL = _free(buildRootURL);
+	return result;
 #endif
 	return Qnil;
 }
 
+/*
+ * @return [String] Return Build subdirectory defined in the spec file
+ */
 VALUE
 rpm_spec_get_buildsubdir(VALUE spec)
 {
@@ -102,6 +139,9 @@ rpm_spec_get_buildsubdir(VALUE spec)
 	return Qnil;
 }
 
+/*
+ * @return [Array<String>] Return Build architectures defined in the spec file
+ */
 VALUE
 rpm_spec_get_buildarchs(VALUE spec)
 {
@@ -119,12 +159,15 @@ rpm_spec_get_buildarchs(VALUE spec)
 	return ba;
 }
 
+/*
+ * @return [Array<RPM::Require>] Return Build requires defined in the spec file
+ */
 VALUE
 rpm_spec_get_buildrequires(VALUE spec)
 {
 	VALUE br = rb_ivar_get(spec, id_br);
 
-#if RPM_VERSION_CODE < RPM_VERSION(4,6,0)
+#if RPM_VERSION_CODE < RPM_VERSION(4,6,0) || RPM_VERSION_CODE >= RPM_VERSION(5,0,0)
 	if (NIL_P(br)) {
 		const char** names;
 		const char** vers;
@@ -174,7 +217,7 @@ rpm_spec_get_buildrequires(VALUE spec)
 				  versiontd);
 		get_entry(RPM_SPEC(spec)->buildRestrictions, RPMTAG_REQUIREFLAGS,
 				  flagtd);
-		
+
 		rpmtdInit(nametd);
         while ( rpmtdNext(nametd) != -1 ) {
 			rb_ary_push(br, rpm_require_new(rpmtdGetString(nametd), rpm_version_new(rpmtdNextString(versiontd)), *rpmtdNextUint32(flagtd), spec));
@@ -191,11 +234,14 @@ rpm_spec_get_buildrequires(VALUE spec)
 #endif
 }
 
+/*
+ * @return [Array<RPM::Conflict>] Return Build conflicts defined in the spec file
+ */
 VALUE
 rpm_spec_get_buildconflicts(VALUE spec)
 {
 	VALUE bc = rb_ivar_get(spec, id_bc);
-#if RPM_VERSION_CODE < RPM_VERSION(4,6,0)
+#if RPM_VERSION_CODE < RPM_VERSION(4,6,0) || RPM_VERSION_CODE >= RPM_VERSION(5,0,0)
 	if (NIL_P(bc)) {
 		const char** names;
 		const char** vers;
@@ -237,7 +283,7 @@ rpm_spec_get_buildconflicts(VALUE spec)
 		bc = rb_ary_new();
 		if (!headerGet(RPM_SPEC(spec)->buildRestrictions,
                        RPMTAG_CONFLICTNAME, nametd, HEADERGET_MINMEM)) {
-		
+
 			goto leave;
 		}
 
@@ -275,6 +321,9 @@ rpm_spec_get_build_restrictions(VALUE spec)
 	return cache;
 }
 
+/*
+ * @return [Array<RPM::Source>] Sources defined in the spec file
+ */
 VALUE
 rpm_spec_get_sources(VALUE spec)
 {
@@ -305,6 +354,9 @@ rpm_spec_get_sources(VALUE spec)
 	return src;
 }
 
+/*
+ * @return [Array<RPM::Package>] Packages defined in the spec file
+ */
 VALUE
 rpm_spec_get_packages(VALUE spec)
 {
@@ -326,6 +378,16 @@ rpm_spec_get_packages(VALUE spec)
 	return pkg;
 }
 
+/*
+ * Builds the spec file
+ * @param [Number] flags bits to enable stages of build
+ * @param [Boolean] test When true, don't execute scripts or package
+ * @return [Number] exit code
+ *
+ * @example
+ *   spec = RPM::Spec.open("foo.spec")
+ *   spec.build(RPM::BUILD__UNTIL_BUILD)
+ */
 VALUE
 rpm_spec_build(int argc, VALUE* argv, VALUE spec)
 {
@@ -362,6 +424,16 @@ rpm_spec_build(int argc, VALUE* argv, VALUE spec)
 	return INT2NUM(rc);
 }
 
+/*
+ * Expands a macro in the spec file
+ * @param [String] name Name of the macro
+ * @return [String]
+ * @example
+ *    spec.expand_macros("configure")
+ *    => "\n CFLAGS=......."
+ *    spec.expand_macros("_prefix")
+ *    => "/usr"
+ */
 VALUE
 rpm_spec_expand_macros(VALUE spec, VALUE name)
 {

data/ext/rpm/version.c

@@ -83,6 +83,24 @@ version_parse(const char* str, VALUE* v, VALUE* r, VALUE* e)
 	}
 }
 
+/*
+ * @overload new(vr, e = nil)
+ *   Creates a version object from a string representation
+ *   @param [String] vr version and release in the form "v-r"
+ *   @param [Number] e epoch
+ *   @return [Version]
+ * @overload new(v, r, e = nil)
+ *   Creates a version object from a string representation
+ *   @param [String] v version
+ *   @param [String] r release
+ *   @param [Number] e epoch
+ *   @return [Version]
+ * @example
+ *   RPM:: Version.new "1.0.0-3"
+ *   RPM:: Version.new "1.04"
+ *   RPM:: Version.new "1.0.0-3k", 1
+ *   RPM:: Version.new "2.0.3", "5k"
+ */
 static VALUE
 version_initialize(int argc, VALUE* argv, VALUE ver)
 {
@@ -184,6 +202,18 @@ rpm_version_new3(const char* v, const char* r, int e)
 	return ver;
 }
 
+/*
+ * Comparison between versions
+ * @param [Version] other
+ * @return [Number] -1 if +other+ is greater than, 0 if +other+ is equal to,
+ *   and +1 if other is less than version.
+ *
+ * @example
+ *   v1 = RPM::Version.new("3.0-0",1)
+ *   v2 = RPM::Version.new("3.1-0",1)
+ *   v1 <=> v2
+ *   => -1
+ */
 VALUE
 rpm_version_cmp(VALUE ver, VALUE other)
 {
@@ -233,36 +263,63 @@ rpm_version_cmp(VALUE ver, VALUE other)
 	return INT2FIX(sense);
 }
 
+/*
+ * @param [Version] other Version to compare against
+ * @return [Boolean] true if the version is newer than +other+
+ */
 VALUE
 rpm_version_is_newer(VALUE ver, VALUE other)
 {
 	return (NUM2INT(rpm_version_cmp(ver, other)) > 0) ? Qtrue : Qfalse;
 }
 
+/*
+ * @param [Version] other Version to compare against
+ * @return [Boolean] true if the version is older than +other+
+ */
 VALUE
 rpm_version_is_older(VALUE ver, VALUE other)
 {
 	return rpm_version_is_newer(ver, other) ? Qfalse : Qtrue;
 }
 
+/*
+ * Access the version component
+ * @return [String] version component
+ */
 VALUE
 rpm_version_get_v(VALUE ver)
 {
 	return rb_ivar_get(ver, id_v);
 }
 
+/*
+ * Access the release component
+ * @return [String] release component or nil if the
+ *   version does not have a release component
+ */
 VALUE
 rpm_version_get_r(VALUE ver)
 {
 	return rb_ivar_get(ver, id_r);
 }
 
+/*
+ * Access the epoch component
+ * @return [Number] epoch component or nil if the
+ *   version does not have an epoch component
+ */
 VALUE
 rpm_version_get_e(VALUE ver)
 {
 	return rb_ivar_get(ver, id_e);
 }
 
+/*
+ * String representation in the form "v-r"
+ * @return [String]
+ * @note The epoch is not included
+ */
 VALUE
 rpm_version_to_s(VALUE ver)
 {
@@ -279,6 +336,11 @@ rpm_version_to_s(VALUE ver)
 	return rb_str_new2(buf);
 }
 
+/*
+ * String representation in the form "e:v-r"
+ * @return [String]
+ * @note The epoch is included
+ */
 VALUE
 rpm_version_to_vre(VALUE ver)
 {
@@ -300,6 +362,10 @@ rpm_version_to_vre(VALUE ver)
 	return rb_str_new2(buf);
 }
 
+/*
+ * Inspect the version object
+ * @return [String] object in the form "#<RPM::Version v=V, r=R, e=E>"
+ */
 VALUE
 rpm_version_inspect(VALUE ver)
 {
@@ -318,6 +384,11 @@ rpm_version_inspect(VALUE ver)
 	return rb_str_new2(buf);
 }
 
+/*
+ * Hash based on the version content
+ * @return [String]
+ */
+
 VALUE
 rpm_version_hash(VALUE ver)
 {

data/lib/rpm.rb

@@ -5,12 +5,34 @@
 
 ### $Id: rpm.rb 22 2004-03-29 03:42:35Z zaki $
 
+require 'rbconfig'
 # native
-require 'rpm.so'
+require "rpm.#{RbConfig::CONFIG['DLEXT']}"
 require 'rpm/version'
 
 module RPM
 
+  # @attr [Number] type Type of event
+  # @attr [Number] key Key transactions
+  # @attr [Package] package Package being processed
+  # @attr [Number] amount Progress
+  # @attr [Number] total Total size
+  class CallbackData
+  end
+
+  # @attr [Number] type Type of event
+  # @attr [Number] key Key in the transaction
+  # @attr [Package] package Package being processed
+  # @attr [Description] Description of the problem
+  class Problem
+  end
+
+  # @attr [Time] time Timestamp of the changelog entry
+  # @attr [String] name Name of the changelog entry
+  # @attr [Text] text description of the changelog entry
+  class Changelog
+  end
+
   def vercmp(ver1, ver2)
     unless String === ver1 and String === ver2 then
       raise TypeError, 'illegal argument type'

data/lib/rpm/version.rb

@@ -1,4 +1,4 @@
 module RPM
   PKG_NAME='ruby-rpm'
-  VERSION='1.3.0'
+  VERSION='1.3.1'
 end