libcdb-ruby 0.0.1-x86-mingw32 → 0.0.2-x86-mingw32

data/ChangeLog

@@ -1,5 +1,12 @@
 = Revision history for libcdb-ruby
 
+== 0.0.2 [2012-01-20]
+
+* Refactored C code to DRY.
+* Added Writer#<< as alias for Writer#store.
+* Added missing delegate CDB#total.
+* A little housekeeping.
+
 == 0.0.1 [2012-01-12]
 
 * Birthday :-)

data/README

@@ -2,7 +2,7 @@
 
 == VERSION
 
-This documentation refers to libcdb-ruby version 0.0.1
+This documentation refers to libcdb-ruby version 0.0.2
 
 
 == DESCRIPTION
@@ -35,6 +35,8 @@ creating and reading {constant databases}[http://cr.yp.to/cdb.html].
     cdb['b']  #=> "123"
     cdb['c']  #=> nil
 
+    # database is truncated whenever
+    # a new writer is opened:
     cdb['a'] = 'two'
     cdb['c'] = 'xyz'
 
@@ -45,8 +47,10 @@ creating and reading {constant databases}[http://cr.yp.to/cdb.html].
 
   # update existing database
   LibCDB::CDB.open('foo.cdb', 'r+') { |cdb|
-    cdb.store(cdb.to_h)
+    # store existing records
+    cdb << cdb.to_h
 
+    # and add a new one
     cdb['d'] = '42'
 
     cdb['a']  #=> "two"
@@ -56,10 +60,23 @@ creating and reading {constant databases}[http://cr.yp.to/cdb.html].
   }
 
 
+== PREREQUISITES
+
+<b></b>
+* Ruby 1.8.7+ or 1.9+ (see below for details)
+* TinyCDB[http://corpit.ru/mjt/tinycdb.html] headers (not
+  needed when installing the fat binary gem on Windows)
+
+  Debian/Ubuntu:: +libcdb-dev+
+  Fedora/SuSE::   +tinycdb-devel+
+  Gentoo::        +dev-db/tinycdb+
+
+
 == SUPPORTED PLATFORMS
 
-Linux::   1.8 & 1.9
-Windows:: 1.9 only
+<b></b>
+Linux::   1.8 & 1.9 (Tested on Ubuntu with 1.8.7p302 and 1.9.3p19)
+Windows:: 1.9 only (Tested on XP with 1.9.3p0)
 
 
 == LINKS
@@ -77,6 +94,16 @@ CDB::           http://cr.yp.to/cdb.html
 * Jens Wille <mailto:jens.wille@uni-koeln.de>
 
 
+== CREDITS
+
+This project was inspired by ruby-cdb[https://github.com/mbj/ruby-cdb] and
+cdb-full[https://rubygems.org/gems/cdb-full]. The code organization, especially the
+extension part, was modeled after libxml-ruby[https://github.com/xml4r/libxml-ruby].
+
+And props to the rake-compiler[http://github.com/luislavena/rake-compiler]
+team for making extension building such a breeze :)
+
+
 == LICENSE AND COPYRIGHT
 
 Copyright (C) 2012 University of Cologne,

data/TODO

@@ -1,4 +1,5 @@
 * More specs!!
 * More Documentation!
 * Atomic updates? (rename after create)
+* Memory efficient way to update an existing database?
 * Benchmarks?

data/ext/libcdb/ruby_cdb.h

@@ -2,11 +2,62 @@
 #define __RUBY_CDB_H__
 
 #ifdef HAVE_RUBY_IO_H
-#define GetFileFD(fptr) (fptr)->fd
+#define RCDB_GET_FD(fptr) (fptr)->fd
 #else
-#define GetFileFD(fptr) fileno((fptr)->f)
+#define RCDB_GET_FD(fptr) fileno((fptr)->f)
 #endif
 
+#define RCDB_GET_STRUCT(what, _struct, obj, ptr) {\
+  if (RTEST(rcdb_##what##er_closed_p(obj))) {\
+    rb_raise(rb_eIOError, "closed stream");\
+  }\
+  else {\
+    Data_Get_Struct((obj), struct _struct, (ptr));\
+  }\
+}
+
+#define RCDB_DEFINE_ALLOC(what, _struct) \
+static void \
+rcdb_##what##er_free(void *ptr) {\
+  free(ptr);\
+}\
+\
+static VALUE \
+rcdb_##what##er_alloc(VALUE klass) {\
+  struct _struct *ptr = ALLOC_N(struct _struct, 1);\
+  return Data_Wrap_Struct(klass, NULL, rcdb_##what##er_free, ptr);\
+}
+
+#define RCDB_INITIALIZE(what, WHAT, _struct, init) \
+  struct _struct *ptr = NULL;\
+  rb_io_t *fptr;\
+\
+  Check_Type(io, T_FILE);\
+  GetOpenFile(io, fptr);\
+\
+  rb_io_check_##what##able(fptr);\
+  rb_iv_set(self, "@io", io);\
+  rb_iv_set(self, "closed", Qfalse);\
+\
+  RCDB_##WHAT##ER_GET(self, ptr);\
+\
+  if (cdb_##init(ptr, RCDB_GET_FD(fptr)) == -1) {\
+    rb_sys_fail(0);\
+  }
+
+#define RCDB_DEFINE_INSPECT(what) \
+static VALUE \
+rcdb_##what##er_inspect(VALUE self) {\
+  VALUE str = rb_call_super(0, NULL);\
+\
+  if (RTEST(rcdb_##what##er_closed_p(self))) {\
+    rb_funcall(str,\
+      rb_intern("insert"), 2, INT2FIX(-2), rb_str_new2(" (closed)"));\
+  }\
+\
+  return str;\
+}
+
 VALUE cCDB;
 void rcdb_init_cdb(void);
 

data/ext/libcdb/ruby_cdb_reader.c

@@ -1,15 +1,6 @@
 #include "ruby_libcdb.h"
 
-static void
-rcdb_reader_free(void *ptr) {
-  free(ptr);
-}
-
-static VALUE
-rcdb_reader_alloc(VALUE klass) {
-  struct cdb *cdb = ALLOC_N(struct cdb, 1);
-  return Data_Wrap_Struct(klass, NULL, rcdb_reader_free, cdb);
-}
+RCDB_DEFINE_ALLOC(read, cdb)
 
 /*
  * call-seq:
@@ -31,64 +22,22 @@ rcdb_reader_closed_p(VALUE self) {
  */
 static VALUE
 rcdb_reader_initialize(VALUE self, VALUE io) {
-  struct cdb *cdb = NULL;
-  rb_io_t *fptr;
-
-  Check_Type(io, T_FILE);
-  GetOpenFile(io, fptr);
-
-  rb_io_check_readable(fptr);
-  rb_iv_set(self, "@io", io);
-  rb_iv_set(self, "closed", Qfalse);
-
-  Get_CDB_Reader(self, cdb);
-
-  if (cdb_init(cdb, GetFileFD(fptr)) == -1) {
-    rb_sys_fail(0);
-  }
-
+  RCDB_INITIALIZE(read, READ, cdb, init)
   return self;
 }
 
-/* Helper method */
-static VALUE
-rcdb_reader_read_key(struct cdb *cdb) {
-  size_t len;
-  VALUE key;
-
-  len = cdb_keylen(cdb);
-  key = rb_str_buf_new(len);
-
-  cdb_read(cdb, RSTRING_PTR(key), len, cdb_keypos(cdb));
-  rb_str_set_len(key, len);
-
-  return key;
-}
-
-/* Helper method */
-static VALUE
-rcdb_reader_read_value(struct cdb *cdb) {
-  size_t len;
-  VALUE val;
-
-  len = cdb_datalen(cdb);
-  val = rb_str_buf_new(len);
-
-  cdb_read(cdb, RSTRING_PTR(val), len, cdb_datapos(cdb));
-  rb_str_set_len(val, len);
-
-  return val;
-}
+RCDB_READER_DEFINE_READ(key)
+RCDB_READER_DEFINE_READ(data)
 
 /* Helper method */
 static VALUE
-rcdb_reader_iter_push(VALUE val, VALUE ary) {
+_rcdb_reader_iter_push(VALUE val, VALUE ary) {
   return rb_ary_push(ary, val);
 }
 
 /* Helper method */
 static VALUE
-rcdb_reader_iter_aset(VALUE pair, VALUE hash) {
+_rcdb_reader_iter_aset(VALUE pair, VALUE hash) {
   VALUE key = rb_ary_entry(pair, 0), val = rb_ary_entry(pair, 1), old;
 
   if (!st_lookup(RHASH_TBL(hash), key, 0)) {
@@ -112,8 +61,8 @@ rcdb_reader_iter_aset(VALUE pair, VALUE hash) {
 
 /* Helper method */
 static VALUE
-rcdb_reader_break_equal(VALUE val, VALUE ary) {
-  if (VALUE_EQUAL(val)) {
+_rcdb_reader_break_equal(VALUE val, VALUE ary) {
+  if (RCDB_READER_EQUAL(val)) {
     rb_ary_store(ary, 0, Qtrue);
     rb_iter_break();
   }
@@ -123,8 +72,8 @@ rcdb_reader_break_equal(VALUE val, VALUE ary) {
 
 /* Helper method */
 static VALUE
-rcdb_reader_break_equal2(VALUE pair, VALUE ary) {
-  if (VALUE_EQUAL(rb_ary_entry(pair, 1))) {
+_rcdb_reader_break_equal2(VALUE pair, VALUE ary) {
+  if (RCDB_READER_EQUAL(rb_ary_entry(pair, 1))) {
     rb_ary_store(ary, 0, rb_ary_entry(pair, 0));
     rb_iter_break();
   }
@@ -134,7 +83,7 @@ rcdb_reader_break_equal2(VALUE pair, VALUE ary) {
 
 /* Helper method */
 static VALUE
-rcdb_reader_break_shift(VALUE val, VALUE ary) {
+_rcdb_reader_break_shift(VALUE val, VALUE ary) {
   rb_ary_shift(ary);
   rb_iter_break();
 
@@ -143,16 +92,14 @@ rcdb_reader_break_shift(VALUE val, VALUE ary) {
 
 /* Helper method */
 static VALUE
-rcdb_reader_iter_inc(VALUE val, VALUE ary) {
+_rcdb_reader_iter_inc(VALUE val, VALUE ary) {
   rb_ary_store(ary, 0, rb_funcall(rb_ary_entry(ary, 0), rb_intern("succ"), 0));
   return Qnil;
 }
 
 /* Helper method */
 static VALUE
-rcdb_reader_iter_dump(VALUE val, VALUE ary) {
-  VALUE str = rb_ary_entry(ary, 0);
-
+_rcdb_reader_iter_dump(VALUE val, VALUE str) {
   rb_str_append(str, val);
   rb_str_cat2(str, "\n");
 
@@ -161,7 +108,7 @@ rcdb_reader_iter_dump(VALUE val, VALUE ary) {
 
 /* Helper method */
 static VALUE
-rcdb_reader_dump_pair(VALUE key, VALUE val) {
+_rcdb_reader_dump_pair(VALUE key, VALUE val) {
   VALUE str = rb_str_new2("");
 
   rb_str_cat2(str, "+");
@@ -178,40 +125,21 @@ rcdb_reader_dump_pair(VALUE key, VALUE val) {
 
 /* Helper method */
 static VALUE
-rcdb_reader_yield_dump(VALUE pair, VALUE ary) {
-  return rb_yield(rcdb_reader_dump_pair(
+_rcdb_reader_yield_dump(VALUE pair, VALUE ary) {
+  return rb_yield(_rcdb_reader_dump_pair(
     rb_ary_entry(pair, 0), rb_ary_entry(pair, 1)));
 }
 
 /* Helper method */
 static VALUE
-rcdb_reader_yield_dump2(VALUE val, VALUE ary) {
-  return rb_yield(rcdb_reader_dump_pair(rb_ary_entry(ary, 0), val));
+_rcdb_reader_yield_dump2(VALUE val, VALUE ary) {
+  return rb_yield(_rcdb_reader_dump_pair(rb_ary_entry(ary, 0), val));
 }
 
-/* Helper method */
-static VALUE
-rcdb_reader_call_each(VALUE args) {
-  CALL_ITERATOR("each")
-}
-
-/* Helper method */
-static VALUE
-rcdb_reader_call_each_key(VALUE args) {
-  CALL_ITERATOR("each_key")
-}
-
-/* Helper method */
-static VALUE
-rcdb_reader_call_each_value(VALUE args) {
-  CALL_ITERATOR("each_value")
-}
-
-/* Helper method */
-static VALUE
-rcdb_reader_call_each_dump(VALUE args) {
-  CALL_ITERATOR("each_dump")
-}
+RCDB_READER_DEFINE_CALL(each)
+RCDB_READER_DEFINE_CALL(each_key)
+RCDB_READER_DEFINE_CALL(each_value)
+RCDB_READER_DEFINE_CALL(each_dump)
 
 /*
  * call-seq:
@@ -235,7 +163,7 @@ rcdb_reader_each(int argc, VALUE *argv, VALUE self) {
 
   RETURN_ENUMERATOR(self, argc, argv);
 
-  Get_CDB_Reader(self, cdb);
+  RCDB_READER_GET(self, cdb);
 
   if (rb_scan_args(argc, argv, "01", &key) == 1 && !NIL_P(key)) {
     StringValue(key);
@@ -245,7 +173,7 @@ rcdb_reader_each(int argc, VALUE *argv, VALUE self) {
     }
 
     while (cdb_findnext(&cdbf) > 0) {
-      rb_yield(rcdb_reader_read_value(cdb));
+      rb_yield(_rcdb_reader_read_data(cdb));
     }
   }
   else {
@@ -253,8 +181,8 @@ rcdb_reader_each(int argc, VALUE *argv, VALUE self) {
 
     while (cdb_seqnext(&cdbp, cdb) > 0) {
       rb_yield(rb_ary_new3(2,
-        rcdb_reader_read_key(cdb),
-        rcdb_reader_read_value(cdb)));
+        _rcdb_reader_read_key(cdb),
+        _rcdb_reader_read_data(cdb)));
     }
   }
 
@@ -273,7 +201,7 @@ rcdb_reader_each(int argc, VALUE *argv, VALUE self) {
 static VALUE
 rcdb_reader_each_dump(int argc, VALUE *argv, VALUE self) {
   VALUE key, args = rb_ary_new3(1, self), ary = rb_ary_new();
-  VALUE (*block)(ANYARGS) = rcdb_reader_yield_dump;
+  VALUE (*block)(ANYARGS) = _rcdb_reader_yield_dump;
 
   if (argc > 1) {
     rb_raise(rb_eArgError, "wrong number of arguments (%d for 0-1)", argc);
@@ -285,10 +213,10 @@ rcdb_reader_each_dump(int argc, VALUE *argv, VALUE self) {
     rb_ary_push(ary,  key);
     rb_ary_push(args, key);
 
-    block = rcdb_reader_yield_dump2;
+    block = _rcdb_reader_yield_dump2;
   }
 
-  rb_iterate(rcdb_reader_call_each, args, block, ary);
+  rb_iterate(_rcdb_reader_call_each, args, block, ary);
 
   return self;
 }
@@ -307,11 +235,11 @@ rcdb_reader_each_key(VALUE self) {
   unsigned cdbp;
   VALUE key, hash = rb_hash_new();
 
-  Get_CDB_Reader(self, cdb);
+  RCDB_READER_GET(self, cdb);
   cdb_seqinit(&cdbp, cdb);
 
   while (cdb_seqnext(&cdbp, cdb) > 0) {
-    if (!st_lookup(RHASH_TBL(hash), key = rcdb_reader_read_key(cdb), 0)) {
+    if (!st_lookup(RHASH_TBL(hash), key = _rcdb_reader_read_key(cdb), 0)) {
       rb_hash_aset(hash, key, Qtrue);
       rb_yield(key);
     }
@@ -333,11 +261,11 @@ rcdb_reader_each_value(VALUE self) {
   struct cdb *cdb = NULL;
   unsigned cdbp;
 
-  Get_CDB_Reader(self, cdb);
+  RCDB_READER_GET(self, cdb);
   cdb_seqinit(&cdbp, cdb);
 
   while (cdb_seqnext(&cdbp, cdb) > 0) {
-    rb_yield(rcdb_reader_read_value(cdb));
+    rb_yield(_rcdb_reader_read_data(cdb));
   }
 
   return self;
@@ -351,12 +279,10 @@ rcdb_reader_each_value(VALUE self) {
  */
 static VALUE
 rcdb_reader_fetch(VALUE self, VALUE key) {
-  VALUE ary = rb_ary_new();
-
-  rb_iterate(rcdb_reader_call_each,
-    rb_ary_new3(2, self, key), rcdb_reader_iter_push, ary);
+  RCDB_READER_ITERATE0(each, iter_push,
+    rb_ary_new(), rb_ary_new3(2, self, key))
 
-  return ary;
+  return arg;
 }
 
 /*
@@ -371,10 +297,10 @@ rcdb_reader_fetch_first(VALUE self, VALUE key) {
   VALUE val = Qnil;
 
   StringValue(key);
-  Get_CDB_Reader(self, cdb);
+  RCDB_READER_GET(self, cdb);
 
   if (cdb_find(cdb, RSTRING_PTR(key), RSTRING_LEN(key)) > 0) {
-    val = rcdb_reader_read_value(cdb);
+    val = _rcdb_reader_read_data(cdb);
   }
 
   return val;
@@ -395,7 +321,7 @@ rcdb_reader_fetch_last(VALUE self, VALUE key) {
   size_t len = 0;
 
   StringValue(key);
-  Get_CDB_Reader(self, cdb);
+  RCDB_READER_GET(self, cdb);
 
   if (cdb_findinit(&cdbf, cdb, RSTRING_PTR(key), RSTRING_LEN(key)) == -1) {
     rb_sys_fail(0);
@@ -423,12 +349,7 @@ rcdb_reader_fetch_last(VALUE self, VALUE key) {
  */
 static VALUE
 rcdb_reader_keys(VALUE self) {
-  VALUE ary = rb_ary_new();
-
-  rb_iterate(rcdb_reader_call_each_key,
-    rb_ary_new3(1, self), rcdb_reader_iter_push, ary);
-
-  return ary;
+  RCDB_READER_ITERATE(each_key, iter_push, rb_ary_new())
 }
 
 /*
@@ -439,12 +360,7 @@ rcdb_reader_keys(VALUE self) {
  */
 static VALUE
 rcdb_reader_values(VALUE self) {
-  VALUE ary = rb_ary_new();
-
-  rb_iterate(rcdb_reader_call_each_value,
-    rb_ary_new3(1, self), rcdb_reader_iter_push, ary);
-
-  return ary;
+  RCDB_READER_ITERATE(each_value, iter_push, rb_ary_new())
 }
 
 /*
@@ -473,8 +389,8 @@ rcdb_reader_values_at(int argc, VALUE *argv, VALUE self) {
  */
 static VALUE
 rcdb_reader_has_key_p(VALUE self, VALUE key) {
-  VALUE ary = rb_ary_new3(2, Qfalse, key);
-  ITER_RESULT(rcdb_reader_call_each_key, rcdb_reader_break_equal)
+  RCDB_READER_ITERATE_ARY(each_key, break_equal,
+    rb_ary_new3(2, Qfalse, key))
 }
 
 /*
@@ -485,8 +401,8 @@ rcdb_reader_has_key_p(VALUE self, VALUE key) {
  */
 static VALUE
 rcdb_reader_has_value_p(VALUE self, VALUE val) {
-  VALUE ary = rb_ary_new3(2, Qfalse, val);
-  ITER_RESULT(rcdb_reader_call_each_value, rcdb_reader_break_equal)
+  RCDB_READER_ITERATE_ARY(each_value, break_equal,
+    rb_ary_new3(2, Qfalse, val))
 }
 
 /*
@@ -498,8 +414,8 @@ rcdb_reader_has_value_p(VALUE self, VALUE val) {
  */
 static VALUE
 rcdb_reader_key(VALUE self, VALUE val) {
-  VALUE ary = rb_ary_new3(2, Qnil, val);
-  ITER_RESULT(rcdb_reader_call_each, rcdb_reader_break_equal2)
+  RCDB_READER_ITERATE_ARY(each, break_equal2,
+    rb_ary_new3(2, Qnil, val))
 }
 
 /*
@@ -510,8 +426,8 @@ rcdb_reader_key(VALUE self, VALUE val) {
  */
 static VALUE
 rcdb_reader_empty_p(VALUE self) {
-  VALUE ary = rb_ary_new3(2, Qtrue, Qfalse);
-  ITER_RESULT(rcdb_reader_call_each_key, rcdb_reader_break_shift)
+  RCDB_READER_ITERATE_ARY(each_key, break_shift,
+    rb_ary_new3(2, Qtrue, Qfalse))
 }
 
 /*
@@ -522,8 +438,8 @@ rcdb_reader_empty_p(VALUE self) {
  */
 static VALUE
 rcdb_reader_size(VALUE self) {
-  VALUE ary = rb_ary_new3(1, INT2FIX(0));
-  ITER_RESULT(rcdb_reader_call_each_key, rcdb_reader_iter_inc)
+  RCDB_READER_ITERATE_ARY(each_key, iter_inc,
+    rb_ary_new3(1, INT2FIX(0)))
 }
 
 /*
@@ -538,7 +454,7 @@ rcdb_reader_total(VALUE self) {
   unsigned cdbp;
   long i = 0;
 
-  Get_CDB_Reader(self, cdb);
+  RCDB_READER_GET(self, cdb);
   cdb_seqinit(&cdbp, cdb);
 
   while (cdb_seqnext(&cdbp, cdb) > 0) {
@@ -556,8 +472,7 @@ rcdb_reader_total(VALUE self) {
  */
 static VALUE
 rcdb_reader_dump(VALUE self) {
-  VALUE ary = rb_ary_new3(1, rb_str_new2(""));
-  ITER_RESULT(rcdb_reader_call_each_dump, rcdb_reader_iter_dump)
+  RCDB_READER_ITERATE(each_dump, iter_dump, rb_str_new2(""))
 }
 
 /*
@@ -571,12 +486,7 @@ rcdb_reader_dump(VALUE self) {
  */
 static VALUE
 rcdb_reader_to_h(VALUE self) {
-  VALUE hash = rb_hash_new();
-
-  rb_iterate(rcdb_reader_call_each,
-    rb_ary_new3(1, self), rcdb_reader_iter_aset, hash);
-
-  return hash;
+  RCDB_READER_ITERATE(each, iter_aset, rb_hash_new())
 }
 
 /*
@@ -589,12 +499,7 @@ rcdb_reader_to_h(VALUE self) {
  */
 static VALUE
 rcdb_reader_to_a(VALUE self) {
-  VALUE ary = rb_ary_new();
-
-  rb_iterate(rcdb_reader_call_each,
-    rb_ary_new3(1, self), rcdb_reader_iter_push, ary);
-
-  return ary;
+  RCDB_READER_ITERATE(each, iter_push, rb_ary_new())
 }
 
 /*
@@ -611,7 +516,7 @@ rcdb_reader_close(VALUE self) {
     return Qnil;
   }
 
-  Get_CDB_Reader(self, cdb);
+  RCDB_READER_GET(self, cdb);
   rb_iv_set(self, "closed", Qtrue);
 
   rb_io_close(rb_iv_get(self, "@io"));
@@ -619,18 +524,7 @@ rcdb_reader_close(VALUE self) {
   return Qnil;
 }
 
-/* :nodoc: */
-static VALUE
-rcdb_reader_inspect(VALUE self) {
-  VALUE str = rb_call_super(0, NULL);
-
-  if (RTEST(rcdb_reader_closed_p(self))) {
-    rb_funcall(str,
-      rb_intern("insert"), 2, INT2FIX(-2), rb_str_new2(" (closed)"));
-  }
-
-  return str;
-}
+RCDB_DEFINE_INSPECT(read)
 
 void
 rcdb_init_reader(void) {

data/ext/libcdb/ruby_cdb_reader.h

@@ -1,29 +1,49 @@
 #ifndef __RCDB_READER_H__
 #define __RCDB_READER_H__
 
-#define Get_CDB_Reader(obj, var) {\
-  if (RTEST(rcdb_reader_closed_p(obj))) {\
-    rb_raise(rb_eRuntimeError, "closed stream");\
-  }\
-  else {\
-    Data_Get_Struct((obj), struct cdb, (var));\
-  }\
-}
+#define RCDB_READER_GET(obj, ptr) RCDB_GET_STRUCT(read, cdb, obj, ptr)
 
-#define CALL_ITERATOR(iter) {\
+#define RCDB_READER_DEFINE_CALL(iter) \
+static VALUE \
+_rcdb_reader_call_##iter(VALUE args) {\
   VALUE self = rb_ary_shift(args);\
-  return rb_funcall2(self, rb_intern(iter),\
+  return rb_funcall2(self, rb_intern(#iter),\
     RARRAY_LEN(args), RARRAY_PTR(args));\
 }
 
-#define ITER_RESULT(method, block) {\
-  rb_iterate(method, rb_ary_new3(1, self), block, ary);\
-  return rb_ary_entry(ary, 0);\
-}
+#define RCDB_READER_ITERATE0(method, block, arg1, arg2) \
+  VALUE arg = arg1;\
+  rb_iterate(_rcdb_reader_call_##method, arg2, _rcdb_reader_##block, arg);
+
+#define RCDB_READER_ITERATE1(method, block, arg1) \
+  RCDB_READER_ITERATE0(method, block, arg1, rb_ary_new3(1, self))
+
+#define RCDB_READER_ITERATE(method, block, arg1) \
+  RCDB_READER_ITERATE1(method, block, arg1)\
+  return arg;
 
-#define VALUE_EQUAL(val) \
+#define RCDB_READER_ITERATE_ARY(method, block, arg1) \
+  RCDB_READER_ITERATE1(method, block, arg1)\
+  return rb_ary_entry(arg, 0);
+
+#define RCDB_READER_EQUAL(val) \
   RTEST(rb_funcall((val), rb_intern("=="), 1, rb_ary_entry(ary, 1)))
 
+#define RCDB_READER_DEFINE_READ(what) \
+static VALUE \
+_rcdb_reader_read_##what(struct cdb *cdb) {\
+  size_t len;\
+  VALUE ret;\
+\
+  len = cdb_##what##len(cdb);\
+  ret = rb_str_buf_new(len);\
+\
+  cdb_read(cdb, RSTRING_PTR(ret), len, cdb_##what##pos(cdb));\
+  rb_str_set_len(ret, len);\
+\
+  return ret;\
+}
+
 VALUE cCDBReader;
 void rcdb_init_reader(void);
 

data/ext/libcdb/ruby_cdb_writer.c

@@ -1,15 +1,6 @@
 #include "ruby_libcdb.h"
 
-static void
-rcdb_writer_free(void *ptr) {
-  free(ptr);
-}
-
-static VALUE
-rcdb_writer_alloc(VALUE klass) {
-  struct cdb_make *cdbm = ALLOC_N(struct cdb_make, 1);
-  return Data_Wrap_Struct(klass, NULL, rcdb_writer_free, cdbm);
-}
+RCDB_DEFINE_ALLOC(writ, cdb_make)
 
 /*
  * call-seq:
@@ -32,23 +23,9 @@ rcdb_writer_closed_p(VALUE self) {
  */
 static VALUE
 rcdb_writer_initialize(VALUE self, VALUE io) {
-  struct cdb_make *cdbm = NULL;
-  rb_io_t *fptr;
-
-  Check_Type(io, T_FILE);
-  GetOpenFile(io, fptr);
-
-  rb_io_check_writable(fptr);
-  rb_iv_set(self, "@io", io);
-  rb_iv_set(self, "closed", Qfalse);
-
-  Get_CDB_Writer(self, cdbm);
+  RCDB_INITIALIZE(writ, WRIT, cdb_make, make_start)
 
-  if (cdb_make_start(cdbm, GetFileFD(fptr)) == -1) {
-    rb_sys_fail(0);
-  }
-
-  if (lseek(cdb_fileno(cdbm), 0, SEEK_SET) == -1)  {
+  if (lseek(cdb_fileno(ptr), 0, SEEK_SET) == -1) {
     rb_sys_fail(0);
   }
 
@@ -137,7 +114,7 @@ rcdb_writer_put(int argc, VALUE *argv, VALUE self, enum cdb_put_mode mode) {
   VALUE arg, val;
   long i;
 
-  Get_CDB_Writer(self, cdbm);
+  RCDB_WRITER_GET(self, cdbm);
 
   switch (argc) {
     case 1:
@@ -256,7 +233,7 @@ rcdb_writer_close(VALUE self) {
     return Qnil;
   }
 
-  Get_CDB_Writer(self, cdbm);
+  RCDB_WRITER_GET(self, cdbm);
   rb_iv_set(self, "closed", Qtrue);
 
   if (cdb_make_finish(cdbm) == -1) {
@@ -268,18 +245,7 @@ rcdb_writer_close(VALUE self) {
   return Qnil;
 }
 
-/* :nodoc: */
-static VALUE
-rcdb_writer_inspect(VALUE self) {
-  VALUE str = rb_call_super(0, NULL);
-
-  if (RTEST(rcdb_writer_closed_p(self))) {
-    rb_funcall(str,
-      rb_intern("insert"), 2, INT2FIX(-2), rb_str_new2(" (closed)"));
-  }
-
-  return str;
-}
+RCDB_DEFINE_INSPECT(writ)
 
 void rcdb_init_writer(void) {
   /*
@@ -296,6 +262,7 @@ void rcdb_init_writer(void) {
   rb_define_method(cCDBWriter, "replace",    rcdb_writer_replace,    -1);
   rb_define_method(cCDBWriter, "store",      rcdb_writer_store,      -1);
 
+  rb_define_alias(cCDBWriter, "<<",  "store");
   rb_define_alias(cCDBWriter, "[]=", "replace");
   rb_define_alias(cCDBWriter, "add", "store");
 }

data/ext/libcdb/ruby_cdb_writer.h

@@ -1,14 +1,7 @@
 #ifndef __RCDB_WRITER_H__
 #define __RCDB_WRITER_H__
 
-#define Get_CDB_Writer(obj, var) {\
-  if (RTEST(rcdb_writer_closed_p(obj))) {\
-    rb_raise(rb_eRuntimeError, "closed stream");\
-  }\
-  else {\
-    Data_Get_Struct((obj), struct cdb_make, (var));\
-  }\
-}
+#define RCDB_WRITER_GET(obj, ptr) RCDB_GET_STRUCT(writ, cdb_make, obj, ptr)
 
 VALUE cCDBWriter;
 void rcdb_init_writer(void);

data/lib/libcdb/version.rb

@@ -6,7 +6,7 @@ module LibCDB
 
       MAJOR = 0
       MINOR = 0
-      TINY  = 1
+      TINY  = 2
 
       class << self
 

data/lib/libcdb.rb

@@ -13,8 +13,8 @@ module LibCDB
 
     extend Forwardable
 
-    MODE_READ  = 'r' # :nodoc:
-    MODE_WRITE = 'w' # :nodoc:
+    MODE_READ  = 'r'  # :nodoc:
+    MODE_WRITE = 'w'  # :nodoc:
 
     class << self
 
@@ -133,9 +133,9 @@ module LibCDB
                             :fetch_first, :fetch_last, :get, :has_key?,
                             :has_value?, :include?, :key, :key?, :keys,
                             :length, :member?, :rget, :size, :to_a,
-                            :to_h, :value?, :values, :values_at
+                            :to_h, :total, :value?, :values, :values_at
 
-    def_delegators :writer, :[]=, :add, :insert, :replace, :store
+    def_delegators :writer, :<<, :[]=, :add, :insert, :replace, :store
 
     # call-seq:
     #   cdb.read? -> true | false

data/spec/libcdb/reader_spec.rb

@@ -55,6 +55,18 @@ describe LibCDB::CDB::Reader do
       @db.size.should == 0
     end
 
+    it "should know its total" do
+      @db.total.should == 0
+    end
+
+    it "should know its keys" do
+      @db.keys.should == []
+    end
+
+    it "should know its values" do
+      @db.values.should == []
+    end
+
     it "should know if it doesn't have a key" do
       @db.should_not have_key('key3')
     end
@@ -63,6 +75,18 @@ describe LibCDB::CDB::Reader do
       @db.should_not have_value('value3.2')
     end
 
+    it "should dump itself" do
+      @db.dump.should == ''
+    end
+
+    it "should convert itself into a hash" do
+      @db.to_h.should == {}
+    end
+
+    it "should convert itself into an array" do
+      @db.to_a.should == []
+    end
+
   end
 
   describe "non-empty" do
@@ -87,6 +111,18 @@ describe LibCDB::CDB::Reader do
       @db.size.should == 11
     end
 
+    it "should know its total" do
+      @db.total.should == 56
+    end
+
+    it "should know its keys" do
+      @db.keys.should == TEST_DATA.map { |k, _| k }.uniq
+    end
+
+    it "should know its values" do
+      @db.values.should == TEST_DATA.map { |_, v| v }.flatten
+    end
+
     it "should know if it has a key" do
       @db.should have_key('key3')
     end
@@ -137,6 +173,24 @@ describe LibCDB::CDB::Reader do
       @db.key('value33.22').should be_nil
     end
 
+    it "should dump records for key" do
+      d = []
+      @db.each_dump('key3') { |e| d << e }
+      d.should == %w[+4,8:key3->value3.1 +4,8:key3->value3.2 +4,8:key3->value3.3]
+    end
+
+    it "should convert itself into a hash" do
+      h = {}
+      TEST_DATA.each { |k, v| h[k] = v.size > 1 ? v : v.first }
+      @db.to_h.should == h
+    end
+
+    it "should convert itself into an array" do
+      a = []
+      TEST_DATA.each { |k, v| v.each { |w| a << [k, w] } }
+      @db.to_a.should == a
+    end
+
   end
 
 end

data/spec/spec_helper.rb

@@ -8,8 +8,8 @@ RSpec.configure { |config|
     TEST_DATA = {}
 
     1.upto(10) { |i|
-      val = TEST_DATA[key = "key#{i}"] = []
-      1.upto(i) { |j| val << "value#{i}.#{j}" }
+      v = TEST_DATA["key#{i}"] = []
+      1.upto(i) { |j| v << "value#{i}.#{j}" }
     }
 
     TEST_DATA['a' * 1024] = Array('b' * 1024 ** 2)

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: libcdb-ruby
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: 
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: x86-mingw32
 authors: 
 - Jens Wille
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-01-18 00:00:00 Z
+date: 2012-01-20 00:00:00 Z
 dependencies: []
 
 description: Ruby bindings for CDB Constant Databases.
@@ -63,13 +63,13 @@ licenses: []
 
 post_install_message: 
 rdoc_options: 
-- --charset
-- UTF-8
-- --title
-- libcdb-ruby Application documentation (v0.0.1)
 - --main
 - README
 - --all
+- --charset
+- UTF-8
+- --title
+- libcdb-ruby Application documentation (v0.0.2)
 - --line-numbers
 require_paths: 
 - lib