extralite 1.27 → 2.0

data/ext/extralite/extralite.h

@@ -20,7 +20,8 @@
 #define SAFE(f) (VALUE (*)(VALUE))(f)
 
 extern VALUE cDatabase;
-extern VALUE cPreparedStatement;
+extern VALUE cQuery;
+extern VALUE cIterator;
 
 extern VALUE cError;
 extern VALUE cSQLError;
@@ -33,32 +34,64 @@ extern ID ID_new;
 extern ID ID_strip;
 extern ID ID_to_s;
 
+extern VALUE SYM_hash;
+extern VALUE SYM_ary;
+extern VALUE SYM_single_column;
+
 typedef struct {
   sqlite3 *sqlite3_db;
-  VALUE trace_block;
+  VALUE   trace_block;
 } Database_t;
 
 typedef struct {
-  VALUE db;
-  VALUE sql;
-  Database_t *db_struct;
-  sqlite3 *sqlite3_db;
-  sqlite3_stmt *stmt;
-} PreparedStatement_t;
+  VALUE         db;
+  VALUE         sql;
+  Database_t    *db_struct;
+  sqlite3       *sqlite3_db;
+  sqlite3_stmt  *stmt;
+  int           eof;
+  int           closed;
+} Query_t;
+
+enum iterator_mode {
+  ITERATOR_HASH,
+  ITERATOR_ARY,
+  ITERATOR_SINGLE_COLUMN
+};
 
 typedef struct {
-  VALUE self;
-  sqlite3 *sqlite3_db;
-  sqlite3_stmt *stmt;
-  VALUE params;
+  VALUE               query;
+  enum iterator_mode  mode;
+} Iterator_t;
+
+enum query_mode {
+  QUERY_YIELD,
+  QUERY_MULTI_ROW,
+  QUERY_SINGLE_ROW
+};
+
+typedef struct {
+  VALUE           self;
+  sqlite3         *sqlite3_db;
+  sqlite3_stmt    *stmt;
+  VALUE           params;
+  enum query_mode mode;
+  int             max_rows;
+  int             eof;
 } query_ctx;
 
 typedef struct {
-  VALUE dst;
-  VALUE src;
-  sqlite3_backup *p;
+  VALUE           dst;
+  VALUE           src;
+  sqlite3_backup  *p;
 } backup_t;
 
+#define TUPLE_MAX_EMBEDDED_VALUES 20
+#define ALL_ROWS -1
+#define SINGLE_ROW -2
+#define QUERY_MODE(default) (rb_block_given_p() ? QUERY_YIELD : default)
+#define MULTI_ROW_P(mode) (mode == QUERY_MULTI_ROW)
+
 VALUE safe_execute_multi(query_ctx *ctx);
 VALUE safe_query_ary(query_ctx *ctx);
 VALUE safe_query_columns(query_ctx *ctx);
@@ -67,11 +100,23 @@ VALUE safe_query_single_column(query_ctx *ctx);
 VALUE safe_query_single_row(query_ctx *ctx);
 VALUE safe_query_single_value(query_ctx *ctx);
 
+VALUE Query_each_hash(VALUE self);
+VALUE Query_each_ary(VALUE self);
+VALUE Query_each_single_column(VALUE self);
+
+VALUE Query_next_hash(int argc, VALUE *argv, VALUE self);
+VALUE Query_next_ary(int argc, VALUE *argv, VALUE self);
+VALUE Query_next_single_column(int argc, VALUE *argv, VALUE self);
+
+VALUE Query_to_a_hash(VALUE self);
+VALUE Query_to_a_ary(VALUE self);
+VALUE Query_to_a_single_column(VALUE self);
+
 void prepare_single_stmt(sqlite3 *db, sqlite3_stmt **stmt, VALUE sql);
 void prepare_multi_stmt(sqlite3 *db, sqlite3_stmt **stmt, VALUE sql);
 void bind_all_parameters(sqlite3_stmt *stmt, int argc, VALUE *argv);
 void bind_all_parameters_from_object(sqlite3_stmt *stmt, VALUE obj);
-int stmt_iterate(sqlite3_stmt *stmt, sqlite3 *db);
+int stmt_iterate(query_ctx *ctx);
 VALUE cleanup_stmt(query_ctx *ctx);
 
 sqlite3 *Database_sqlite3_db(VALUE self);

data/ext/extralite/extralite_ext.c

@@ -1,7 +1,9 @@
 void Init_ExtraliteDatabase();
-void Init_ExtralitePreparedStatement();
+void Init_ExtraliteQuery();
+void Init_ExtraliteIterator();
 
 void Init_extralite_ext(void) {
   Init_ExtraliteDatabase();
-  Init_ExtralitePreparedStatement();
+  Init_ExtraliteQuery();
+  Init_ExtraliteIterator();
 }

data/ext/extralite/iterator.c

@@ -0,0 +1,180 @@
+#include <stdio.h>
+#include "extralite.h"
+
+/*
+ * Document-class: Extralite::Iterator
+ *
+ * This class implements an iterator used to iterate through query results.
+ */
+
+VALUE cIterator;
+
+VALUE SYM_hash;
+VALUE SYM_ary;
+VALUE SYM_single_column;
+
+static size_t Iterator_size(const void *ptr) {
+  return sizeof(Iterator_t);
+}
+
+static void Iterator_mark(void *ptr) {
+  Iterator_t *iterator = ptr;
+  rb_gc_mark(iterator->query);
+}
+
+static const rb_data_type_t Iterator_type = {
+    "Iterator",
+    {Iterator_mark, free, Iterator_size,},
+    0, 0, RUBY_TYPED_FREE_IMMEDIATELY
+};
+
+static VALUE Iterator_allocate(VALUE klass) {
+  Iterator_t *iterator = ALLOC(Iterator_t);
+  iterator->query = Qnil;
+  return TypedData_Wrap_Struct(klass, &Iterator_type, iterator);
+}
+
+static inline Iterator_t *value_to_iterator(VALUE obj) {
+  Iterator_t *iterator;
+  TypedData_Get_Struct((obj), Iterator_t, &Iterator_type, (iterator));
+  return iterator;
+}
+
+static inline enum iterator_mode symbol_to_mode(VALUE sym) {
+  if (sym == SYM_hash) return ITERATOR_HASH;
+  if (sym == SYM_ary) return ITERATOR_ARY;
+  if (sym == SYM_single_column) return ITERATOR_SINGLE_COLUMN;
+
+  rb_raise(cError, "Invalid iterator mode");
+}
+
+/* Initializes an iterator using the given query object and iteration mode. The
+ * iteration mode is one of: `:hash`, `:ary`, or `:single_column`. An iterator
+ * is normally returned from one of the methods `Query#each`/`Query#each_hash`,
+ * `Query#each_ary` or `Query#each_single_column` when called without a block:
+ * 
+ *     iterator = query.each
+ *     ...
+ *
+ * @param query [Extralite::Query] associated query
+ * @param mode [Symbol] iteration mode
+ * @return [void]
+ */
+VALUE Iterator_initialize(VALUE self, VALUE query, VALUE mode) {
+  Iterator_t *iterator = value_to_iterator(self);
+
+  iterator->query = query;
+  iterator->mode = symbol_to_mode(mode);
+
+  return Qnil;
+}
+
+typedef VALUE (*each_method)(VALUE);
+
+inline each_method mode_to_each_method(enum iterator_mode mode) {
+  switch (mode) {
+    case ITERATOR_ARY:
+      return Query_each_ary;
+    case ITERATOR_SINGLE_COLUMN:
+      return Query_each_single_column;
+    default:
+      return Query_each_hash;
+  }
+}
+
+/* Iterates through the associated query's result set using the iteration mode
+ * set when initialized. Each row would be passed to the given block according
+ * to the iteration mode, i.e. as a hash, an array, or a single value. In
+ * `:single column` mode an error will be raised if the result sets contains
+ * more than one columns.
+ *
+ * @return [Extralite::Iterator] self
+ */
+VALUE Iterator_each(VALUE self) {
+  if (rb_block_given_p()) {
+    Iterator_t *iterator = value_to_iterator(self);
+    each_method method = mode_to_each_method(iterator->mode);
+    method(iterator->query);
+  }
+
+  return self;
+}
+
+typedef VALUE (*next_method)(int, VALUE *, VALUE);
+
+inline next_method mode_to_next_method(enum iterator_mode mode) {
+  switch (mode) {
+    case ITERATOR_ARY:
+      return Query_next_ary;
+    case ITERATOR_SINGLE_COLUMN:
+      return Query_next_single_column;
+    default:
+      return Query_next_hash;
+  }
+}
+
+/* Returns the next 1 or more rows from the associated query's result set
+ * according to the iteration mode, i.e. as a hash, an array or a single value.
+ * 
+ * If no row count is given, a single row is returned. If a row count is given,
+ * an array containing up to the `row_count` rows is returned. If `row_count` is
+ * -1, all rows are returned. If the end of the result set has been reached,
+ * `nil` is returned.
+ * 
+ * If a block is given, rows are passed to the block and self is returned.
+ *
+ * @overload next()
+ *   @return [Hash, Array, Object, Extralite::Iterator] next row or self if block is given
+ * @overload next(row_count)
+ *   @param row_count [Integer] maximum row count or -1 for all rows
+ *   @return [Array, Extralite::Iterator] next rows or self if block is given
+ */
+VALUE Iterator_next(int argc, VALUE *argv, VALUE self) {
+  Iterator_t *iterator = value_to_iterator(self);
+  next_method method = mode_to_next_method(iterator->mode);
+  VALUE result = method(argc, argv, iterator->query);
+
+  return rb_block_given_p() ? self : result;
+}
+
+typedef VALUE (*to_a_method)(VALUE);
+
+inline to_a_method mode_to_to_a_method(enum iterator_mode mode) {
+  switch (mode) {
+    case ITERATOR_ARY:
+      return Query_to_a_ary;
+    case ITERATOR_SINGLE_COLUMN:
+      return Query_to_a_single_column;
+    default:
+      return Query_to_a_hash;
+  }
+}
+
+/* Returns all rows from the associated query's result set according to the
+ * iteration mode, i.e. as a hash, an array or a single value.
+ * 
+ * @return [Array] array of query result set rows
+ */
+VALUE Iterator_to_a(VALUE self) {
+  Iterator_t *iterator = value_to_iterator(self);
+  to_a_method method = mode_to_to_a_method(iterator->mode);
+  return method(iterator->query);
+}
+
+void Init_ExtraliteIterator(void) {
+  VALUE mExtralite = rb_define_module("Extralite");
+
+  cIterator = rb_define_class_under(mExtralite, "Iterator", rb_cObject);
+  rb_define_alloc_func(cIterator, Iterator_allocate);
+
+  rb_include_module(cIterator, rb_mEnumerable);
+
+  rb_define_method(cIterator, "initialize", Iterator_initialize, 2);
+  rb_define_method(cIterator, "each", Iterator_each, 0);
+  rb_define_method(cIterator, "next", Iterator_next, -1);
+  rb_define_method(cIterator, "to_a", Iterator_to_a, 0);
+
+  SYM_hash          = ID2SYM(rb_intern("hash"));
+  SYM_ary           = ID2SYM(rb_intern("ary"));
+  SYM_single_column = ID2SYM(rb_intern("single_column"));
+}