ruby-rpm 1.3.0 → 1.3.1

data/CHANGELOG.rdoc

@@ -1,3 +1,17 @@
+2011-08-20  Duncan Mac-Vicar P. <dmacvicar@suse.de>
+
+  * Release 1.3.1     
+  * Move the japanese guide to in-source documentation that can
+    be generated
+  * Use bundler tasks
+  * Specify version for gem dependencies  
+  * patches from Anders F Bjorklund (2):
+    - stpcpy declaration clashing with darwin's <string.h>
+    - use rbconfig to get DLEXT instead of hardcoding .so
+    - patches for rpm 4.4.6, 4.4.8 and 5
+  * patches from Lubomir Rintel (1):
+    - Add a missing header that caused compile to fail
+
 2010-08-19  Duncan Mac-Vicar P. <dmacvicar@suse.de>
 
   * build system cleanup

data/ext/rpm/db.c

@@ -50,6 +50,20 @@ db_free(rpm_db_t* db)
 		db_unref(db);
 }
 
+/*
+ * The package database is opened, but transactional processing
+ * (@see RPM::DB#transaction) cannot be done for when +writable+ is false.
+ * When +writable+ is +false+ then the generated object gets freezed.
+ * @param [Boolean] writable Whether the database is writable. Default is +false+.
+ * @param [String] root Root path for the database, default is empty.
+ * @return [RPM::DB]
+ *
+ * @example
+ *   db = RPM::DB.open
+ *   db.each do |pkg|
+ *     puts pkg.name
+ *   end
+ */
 static VALUE
 db_s_open(int argc, VALUE* argv, VALUE obj)
 {
@@ -107,6 +121,13 @@ rpm_db_open(int writable, const char* root)
 	return db_s_open(2, argv, rpm_cDB);
 }
 
+/*
+ * Initialize the package database
+ * The database {RPM::DB#root} / var / lib /rpm is created.
+ *
+ * @param [String] root Root of the database
+ * @param [Boolean] writable Whether the database is writable. Default +false+.
+ */
 static VALUE
 db_s_init(int argc, VALUE* argv, VALUE obj)
 {
@@ -140,6 +161,9 @@ db_s_init(int argc, VALUE* argv, VALUE obj)
 	return Qnil;
 }
 
+/*
+ * See RPM::DB#init
+ */
 void
 rpm_db_init(const char* root, int writable)
 {
@@ -149,6 +173,11 @@ rpm_db_init(const char* root, int writable)
 	db_s_init(2, argv, rpm_cDB);
 }
 
+/*
+ * Rebuild the package database
+ * It should reside in +root+ / var / lib /rpm
+ * @param [String] root Root path of the database
+ */
 static VALUE
 db_s_rebuild(int argc, VALUE* argv, VALUE obj)
 {
@@ -175,8 +204,10 @@ db_s_rebuild(int argc, VALUE* argv, VALUE obj)
 
 #if RPM_VERSION_CODE < RPM_VERSION(4,1,0)
 	ret = rpmdbRebuild(root);
-#else
+#elif RPM_VERSION_CODE < RPM_VERSION(5,0,0)
 	ret = rpmdbRebuild(root, NULL, NULL);
+#else
+	ret = rpmdbRebuild(root, NULL);
 #endif
 	if (ret) {
 		rb_raise(rb_eRuntimeError, "can not rebuild database in %s",
@@ -195,6 +226,9 @@ rpm_db_rebuild(const char* root)
 	db_s_rebuild(1, argv, rpm_cDB);
 }
 
+/*
+ * Closes the database
+ */
 VALUE
 rpm_db_close(VALUE db)
 {
@@ -204,6 +238,9 @@ rpm_db_close(VALUE db)
     return Qnil;
 }
 
+/*
+ * @return [Boolean] +true+ if the database is closed
+ */
 VALUE
 rpm_db_is_closed(VALUE vdb)
 {
@@ -219,6 +256,9 @@ check_closed(VALUE db)
 }
 
 #ifndef RPMDB_OPAQUE
+/*
+ * @return [String] The root path of the database
+ */
 VALUE
 rpm_db_get_root(VALUE db)
 {
@@ -226,6 +266,9 @@ rpm_db_get_root(VALUE db)
 	return rb_str_new2(RPM_DB(db)->db_root);
 }
 
+/*
+ * @return [String] The home path of the database
+ */
 VALUE
 rpm_db_get_home(VALUE db)
 {
@@ -234,6 +277,9 @@ rpm_db_get_home(VALUE db)
 }
 #endif
 
+/*
+ * @return [Boolean] +true+ if the database is writable
+ */
 VALUE
 rpm_db_is_writable(VALUE db)
 {
@@ -241,6 +287,15 @@ rpm_db_is_writable(VALUE db)
 	return OBJ_FROZEN(db) ? Qfalse : Qtrue;
 }
 
+/*
+ * @yield [Package] Called for each match
+ * @param [Number] key RPM tag key
+ * @param [String] val Value to match
+ * @example
+ *   db.each_match(RPM::TAG_ARCH, "x86_64") do |pkg|
+ *     puts pkg.name
+ *   end
+ */
 VALUE
 rpm_db_each_match(VALUE db, VALUE key, VALUE val)
 {
@@ -255,6 +310,13 @@ rpm_db_each_match(VALUE db, VALUE key, VALUE val)
         return Qnil;
 }
 
+/*
+ * @yield [Package] Called for each package in the database
+ * @example
+ *   db.each do |pkg|
+ *     puts pkg.name
+ *   end
+ */
 VALUE
 rpm_db_each(VALUE db)
 {
@@ -342,18 +404,30 @@ rpm_db_transaction(int argc, VALUE* argv, VALUE db)
 	return rb_ivar_get(trans, id_pl);
 }
 
+/*
+ * @return [RPM::DB] The database associated with this transaction
+ */
 VALUE
 rpm_transaction_get_db(VALUE trans)
 {
 	return rb_ivar_get(trans, id_db);
 }
 
+/*
+ * @return [File] Get transaction script file handle
+ *   i.e stdout/stderr on scriptlet execution
+ */
 VALUE
 rpm_transaction_get_script_file(VALUE trans)
 {
 	return rb_ivar_get(trans, id_sf);
 }
 
+/*
+ * Set the transaction script file handle
+ *   i.e stdout/stderr on scriptlet execution
+ * @param [File] file File handle
+ */
 VALUE
 rpm_transaction_set_script_file(VALUE trans, VALUE file)
 {
@@ -370,6 +444,10 @@ rpm_transaction_set_script_file(VALUE trans, VALUE file)
 	return Qnil;
 }
 
+/*
+ * Add a install operation to the transaction
+ * @param [Package] pkg Package to install
+ */
 VALUE
 rpm_transaction_install(VALUE trans, VALUE pkg, VALUE key)
 {
@@ -402,6 +480,10 @@ rpm_transaction_install(VALUE trans, VALUE pkg, VALUE key)
 	return Qnil;
 }
 
+/*
+ * Add a upgrade operation to the transaction
+ * @param [Package] pkg Package to upgrade
+ */
 VALUE
 rpm_transaction_upgrade(VALUE trans, VALUE pkg, VALUE key)
 {
@@ -468,6 +550,10 @@ rpm_transaction_available(VALUE trans, VALUE pkg, VALUE key)
 }
 #endif /* RPMTS_AVAILABLE */
 
+/*
+ * Add a delete operation to the transaction
+ * @param [String, Package, Dependency] pkg Package to delete
+ */
 VALUE
 rpm_transaction_delete(VALUE trans, VALUE pkg)
 {
@@ -601,7 +687,11 @@ package_new_from_NEVR(const char* nevr)
 }
 #endif
 
-
+/*
+ * Check the dependencies.
+ * @return [Array<Dependency>, +nil+] If dependencies are not met returns an
+ *    array with dependencies. Otherwise +nil+.
+ */
 VALUE
 rpm_transaction_check(VALUE trans)
 {
@@ -797,6 +887,9 @@ rpm_transaction_check(VALUE trans)
 #endif
 }
 
+/*
+ * To determine the processing order.
+ */
 VALUE
 rpm_transaction_order(VALUE trans)
 {
@@ -808,6 +901,10 @@ rpm_transaction_order(VALUE trans)
 	return Qnil;
 }
 
+/*
+ * @return [Array<String>] an array of keys corresponding to all transactions
+ *   that have been added.
+ */
 VALUE
 rpm_transaction_keys(VALUE trans)
 {
@@ -815,16 +912,16 @@ rpm_transaction_keys(VALUE trans)
 }
 
 #if RPM_VERSION_CODE < RPM_VERSION(4,4,5)
-static void*
-transaction_callback(const void* hd, const rpmCallbackType type,
-					 const unsigned long amount, const unsigned long total,
-					 fnpyKey key, rpmCallbackData data)
+typedef unsigned long rpmCallbackSize_t;
+#elif RPM_VERSION(5,0,0) <= RPM_VERSION_CODE
+typedef uint64_t rpmCallbackSize_t;
 #else
+typedef unsigned long long rpmCallbackSize_t;
+#endif
 static void*
 transaction_callback(const void* hd, const rpmCallbackType type,
-					 const unsigned long long amount, const unsigned long long total,
+					 const rpmCallbackSize_t amount, const rpmCallbackSize_t total,
 					 fnpyKey key, rpmCallbackData data)
-#endif
 {
 	VALUE trans = (VALUE)data;
 	FD_t fdt;
@@ -859,6 +956,15 @@ transaction_callback(const void* hd, const rpmCallbackType type,
 	return NULL;
 }
 
+/*
+ * Performs the transaction.
+ * @param [Number] flag Transaction flags, default +RPM::TRANS_FLAG_NONE+
+ * @param [Number] filter Transaction filter, default +RPM::PROB_FILTER_NONE+
+ * @example
+ *   transaction.commit do |sig|
+ *   end
+ * @yield [CallbackData] sig Transaction progress
+ */
 VALUE
 rpm_transaction_commit(int argc, VALUE* argv, VALUE trans)
 {
@@ -1020,6 +1126,9 @@ rpm_transaction_commit(int argc, VALUE* argv, VALUE trans)
 	return Qnil; /* NOT REACHED */
 }
 
+/*
+ * To abort the transaction. Database is not changed.
+ */
 VALUE
 rpm_transaction_abort(VALUE trans)
 {
@@ -1190,8 +1299,9 @@ Init_rpm_transaction(void)
 	rb_undef_method(rpm_cTransaction, "dup");
 	rb_undef_method(rpm_cTransaction, "clone");
 
-	rpm_sCallbackData = rb_struct_define(NULL, "type", "key", "package",
+    rpm_sCallbackData = rb_struct_define(NULL, "type", "key", "package",
 										 "amount", "total", NULL);
+
 	rb_define_const(rpm_mRPM, "CallbackData", rpm_sCallbackData);
 
 	rpm_sProblem = rb_struct_define(NULL, "type", "key", "package",

data/ext/rpm/dependency.c

@@ -159,6 +159,10 @@ rpm_obsolete_new(const char* name, VALUE version, int flags, VALUE target)
 	return obso;
 }
 
+/*
+ * @param [Package, Dependency, Version] other
+ * @return [Boolean] true if +other+ satisfies this dependency
+ */
 VALUE
 rpm_dependency_is_satisfy(VALUE dep,VALUE other)
 {
@@ -209,30 +213,43 @@ rpm_dependency_is_satisfy(VALUE dep,VALUE other)
 	return Qfalse;
 }
 
+/*
+ * @return [String] dependency name
+ */
 VALUE
 rpm_dependency_get_name(VALUE dep)
 {
 	return rb_ivar_get(dep, id_name);
 }
 
+/*
+ * @return [String] dependency version
+ */
 VALUE
 rpm_dependency_get_version(VALUE dep)
 {
 	return rb_ivar_get(dep, id_ver);
 }
 
+/*
+ * @return [Number] dependency flags
+ */
 VALUE
 rpm_dependency_get_flags(VALUE dep)
 {
 	return rb_ivar_get(dep, id_flags);
 }
 
+/*
+ * @return [Package] package this dependency belongs to
+ */
 VALUE
 rpm_dependency_get_owner(VALUE dep)
 {
 	return rb_ivar_get(dep, id_owner);
 }
 
+
 VALUE
 rpm_dependency_get_nametag(VALUE dep)
 {
@@ -251,24 +268,36 @@ rpm_dependency_get_flagstag(VALUE dep)
 	return rb_ivar_get(dep, id_flagstag);
 }
 
+/*
+ * @return [Boolean] true if '<' or '=<' are used to compare the version
+ */
 VALUE
 rpm_dependency_is_lt(VALUE dep)
 {
 	return (NUM2INT(rb_ivar_get(dep, id_flags)) & RPMSENSE_LESS) ? Qtrue : Qfalse;
 }
 
+/*
+ * @return [Boolean] true if '>' or '>=' are used to compare the version
+ */
 VALUE
 rpm_dependency_is_gt(VALUE dep)
 {
 	return (NUM2INT(rb_ivar_get(dep, id_flags)) & RPMSENSE_GREATER) ? Qtrue : Qfalse;
 }
 
+/*
+ * @return [Boolean] true if '=', '=<' or '>=' are used to compare the version
+ */
 VALUE
 rpm_dependency_is_eq(VALUE dep)
 {
 	return (NUM2INT(rb_ivar_get(dep, id_flags)) & RPMSENSE_EQUAL) ? Qtrue : Qfalse;
 }
 
+/*
+ * @return [Boolean] true if '=<' is used to compare the version
+ */
 VALUE
 rpm_dependency_is_le(VALUE dep)
 {
@@ -276,6 +305,9 @@ rpm_dependency_is_le(VALUE dep)
 	return ((flags & RPMSENSE_LESS) && (flags & RPMSENSE_EQUAL)) ? Qtrue : Qfalse;
 }
 
+/*
+ * @return [Boolean] true if '>=' is used to compare the version
+ */
 VALUE
 rpm_dependency_is_ge(VALUE dep)
 {
@@ -283,6 +315,9 @@ rpm_dependency_is_ge(VALUE dep)
 	return ((flags & RPMSENSE_GREATER) && (flags & RPMSENSE_EQUAL)) ? Qtrue : Qfalse;
 }
 
+/*
+ * @return [Boolean] true if this is a pre-requires
+ */
 VALUE
 rpm_require_is_pre(VALUE req)
 {

data/ext/rpm/extconf.rb

@@ -43,18 +43,18 @@ def check_db
 end
 
 def check_rpm
-  return false unless check_db
   # Set things up manually
   dir_config("rpm")
   $libs = append_library($libs, 'rpmdb') if rpm_version < rpm_version([4,6,0])
   $libs = append_library($libs, 'rpm')
+  have_library('rpmbuild', 'getBuildTime')
   if rpm_version >= rpm_version([4,6,0])
     $defs << "-D_RPM_4_4_COMPAT"
     return true
   end
   if have_header('rpm/rpmlib.h') and
-      have_library('rpmio') and
-      have_library('rpmbuild', 'getBuildTime') then
+      check_db and
+      have_library('rpmio') then
     true
   else
     STDERR.puts "rpm library not found"

data/ext/rpm/file.c

@@ -78,54 +78,84 @@ rpm_file_new(const char* path, const char* md5sum, const char* link_to,
 	return file;
 }
 
+/*
+ * @return [String] file path
+ */
 VALUE
 rpm_file_get_path(VALUE file)
 {
 	return rb_ivar_get(file, id_path);
 }
 
+/*
+ * @return [String] md5sum as string
+ */
 VALUE
 rpm_file_get_md5sum(VALUE file)
 {
 	return rb_ivar_get(file, id_md5sum);
 }
 
+/*
+ * @return [String] Path to the destination if the file is a symbolic link
+ * @note
+ *   This path is sometimes relative. To convert an absolute path from relative path:
+ *   File.expand_path (file.link_to, File.dirname (file.path))
+ */
 VALUE
 rpm_file_get_link_to(VALUE file)
 {
 	return rb_ivar_get(file, id_link_to);
 }
 
+/*
+ * @return [Number] File size
+ */
 VALUE
 rpm_file_get_size(VALUE file)
 {
 	return rb_ivar_get(file, id_size);
 }
 
+/*
+ * @return [Time] File modification time.
+ */
 VALUE
 rpm_file_get_mtime(VALUE file)
 {
 	return rb_ivar_get(file, id_mtime);
 }
 
+/*
+ * @return [String] File owner. Nil may be returned.
+ */
 VALUE
 rpm_file_get_owner(VALUE file)
 {
 	return rb_ivar_get(file, id_owner);
 }
 
+/*
+ * @return [String] Group that owns the file. Nil may be returned.
+ */
 VALUE
 rpm_file_get_group(VALUE file)
 {
 	return rb_ivar_get(file, id_group);
 }
 
+/*
+ * @return [Number] Device type of the file
+ */
 VALUE
 rpm_file_get_rdev(VALUE file)
 {
 	return rb_ivar_get(file, id_rdev);
 }
 
+/*
+ * @return [Number] File permissions
+ */
 VALUE
 rpm_file_get_mode(VALUE file)
 {
@@ -144,24 +174,36 @@ rpm_file_get_state(VALUE file)
 	return rb_ivar_get(file, id_state);
 }
 
+/*
+ * @return [Boolean] True if the file is a symbolic link
+ */
 VALUE
 rpm_file_is_symlink(VALUE file)
 {
 	return NIL_P(rb_ivar_get(file, id_link_to)) ? Qfalse : Qtrue;
 }
 
+/*
+ * @return [Boolean] True if the file is marked as a configuration file
+ */
 VALUE
 rpm_file_is_config(VALUE file)
 {
 	return (NUM2INT(rb_ivar_get(file, id_attr)) & RPMFILE_CONFIG) ? Qtrue : Qfalse;
 }
 
+/*
+ * @return [Boolean] True if the file is marked as documentation
+ */
 VALUE
 rpm_file_is_doc(VALUE file)
 {
 	return (NUM2INT(rb_ivar_get(file, id_attr)) & RPMFILE_DOC) ? Qtrue : Qfalse;
 }
 
+/*
+ * @return [Boolean] True if the file is marked as do not use
+ */
 VALUE
 rpm_file_is_donotuse(VALUE file)
 {
@@ -172,48 +214,86 @@ rpm_file_is_donotuse(VALUE file)
 #endif
 }
 
+/*
+ * @return [Boolean] True if the file is marked that can be missing on disk
+ *
+ * This modifier is used for files or links that are created during the %post scripts
+ *   but will need to be removed if the package is removed
+ */
 VALUE
 rpm_file_is_missingok(VALUE file)
 {
 	return (NUM2INT(rb_ivar_get(file, id_attr)) & RPMFILE_MISSINGOK) ? Qtrue : Qfalse;
 }
 
+/*
+ * @return [Boolean] True if the file is marked as configuration not to be replaced
+ *
+ * This flag is used to protect local modifications.
+ * If used, the file will not overwrite an existing file that has been modified.
+ * If the file has not been modified on disk, the rpm command will overwrite the file. But,
+ *   if the file has been modified on disk, the rpm command will copy the new file with an extra
+ *   file-name extension of .rpmnew.
+ */
 VALUE
 rpm_file_is_noreplace(VALUE file)
 {
 	return (NUM2INT(rb_ivar_get(file, id_attr)) & RPMFILE_NOREPLACE) ? Qtrue : Qfalse;
 }
 
+/*
+ * @return [Boolean] True if the file is marked as a spec file
+ */
 VALUE
 rpm_file_is_specfile(VALUE file)
 {
 	return (NUM2INT(rb_ivar_get(file, id_attr)) & RPMFILE_SPECFILE) ? Qtrue : Qfalse;
 }
 
+/*
+ * @return [Boolean] True if the file is marked as ghost
+ *
+ * This flag indicates the file should not be included in the package.
+ * It can be used to name the needed attributes for a file that the program, when installed,
+ *   will create.
+ * For example, you may want to ensure that a program’s log file has certain attributes.
+ */
 VALUE
 rpm_file_is_ghost(VALUE file)
 {
 	return (NUM2INT(rb_ivar_get(file, id_attr)) & RPMFILE_GHOST) ? Qtrue : Qfalse;
 }
 
+/*
+ * @return [Boolean] True if the file is a license
+ */
 VALUE
 rpm_file_is_license(VALUE file)
 {
 	return (NUM2INT(rb_ivar_get(file, id_attr)) & RPMFILE_LICENSE) ? Qtrue : Qfalse;
 }
 
+/*
+ * @return [Boolean] True if the file is a README
+ */
 VALUE
 rpm_file_is_readme(VALUE file)
 {
 	return (NUM2INT(rb_ivar_get(file, id_attr)) & RPMFILE_README) ? Qtrue : Qfalse;
 }
 
+/*
+ * @return [Boolean] True if the file is listed in the exlude section
+ */
 VALUE
 rpm_file_is_exclude(VALUE file)
 {
 	return (NUM2INT(rb_ivar_get(file, id_attr)) & RPMFILE_EXCLUDE) ? Qtrue : Qfalse;
 }
 
+/*
+ * @return [Boolean] True if the file is replaced during installation
+ */
 VALUE
 rpm_file_is_replaced(VALUE file)
 {
@@ -221,6 +301,9 @@ rpm_file_is_replaced(VALUE file)
 			== RPMFILE_STATE_REPLACED) ? Qtrue : Qfalse;
 }
 
+/*
+ * @return [Boolean] True if the file is not installed
+ */
 VALUE
 rpm_file_is_notinstalled(VALUE file)
 {
@@ -228,6 +311,9 @@ rpm_file_is_notinstalled(VALUE file)
 			== RPMFILE_STATE_NOTINSTALLED) ? Qtrue : Qfalse;
 }
 
+/*
+ * @return [Boolean] True if the file is shared over the network
+ */
 VALUE
 rpm_file_is_netshared(VALUE file)
 {