extralite 2.15 → 3.0.0

data/ext/extralite/extralite.h

@@ -14,10 +14,10 @@
 // debug utility
 #define INSPECT(str, obj) { \
   printf(str); \
-  VALUE s = rb_funcall(obj, rb_intern("inspect"), 0); \
+  VALUE s = rb_funcall(obj, ID_inspect, 0); \
   printf(": %s\n", StringValueCStr(s)); \
 }
-#define CALLER() rb_funcall(rb_mKernel, rb_intern("caller"), 0)
+#define CALLER() rb_funcall(rb_mKernel, rb_intern_const("caller"), 0)
 #define TRACE_CALLER() INSPECT("caller: ", CALLER())
 
 #define SAFE(f) (VALUE (*)(VALUE))(f)
@@ -29,6 +29,9 @@ extern VALUE cQuery;
 extern VALUE cIterator;
 extern VALUE cChangeset;
 extern VALUE cBlob;
+extern VALUE cTransform;
+
+extern VALUE mJSON;
 
 extern VALUE cError;
 extern VALUE cSQLError;
@@ -40,6 +43,7 @@ extern ID ID_call;
 extern ID ID_each;
 extern ID ID_keys;
 extern ID ID_new;
+extern ID ID_parse;
 extern ID ID_strip;
 extern ID ID_to_s;
 extern ID ID_track;
@@ -81,7 +85,7 @@ typedef struct {
   VALUE               self;
   VALUE               db;
   VALUE               sql;
-  VALUE               transform_proc;
+  VALUE               transform;
   VALUE               bound_params;
   Database_t          *db_struct;
   sqlite3             *sqlite3_db;
@@ -89,6 +93,7 @@ typedef struct {
   int                 eof;
   int                 closed;
   int                 should_reset;
+  int                 transform_object;
   enum query_mode     query_mode;
 } Query_t;
 
@@ -103,6 +108,42 @@ typedef struct {
 } Changeset_t;
 #endif
 
+// #define TRANSFORM_F_CONTAINER (1 << 0) // node is a container
+#define TRANSFORM_F_ARRAY     (1 << 0) // node is an array container
+#define TRANSFORM_F_IDENTITY  (1 << 1) // node is an identity column
+#define TRANSFORM_F_NAME      (1 << 2) // node has a name VALUE
+
+enum transform_node_type {
+  TRANSFORM_T_AUTO,
+  TRANSFORM_T_INTEGER,
+  TRANSFORM_T_FLOAT,
+  TRANSFORM_T_TEXT,
+  TRANSFORM_T_BOOL,
+  TRANSFORM_T_JSON,
+  TRANSFORM_T_PROC,
+  TRANSFORM_T_RELATION
+};
+
+struct transform_node {
+  enum transform_node_type type;
+  unsigned short flags;
+  unsigned short idx; // column index
+
+  VALUE name;
+  VALUE conversion_proc;
+
+  unsigned short identity_idx; // identity column index
+  struct transform_node *identity_node;
+
+  struct transform_node *subnodes_head;
+  struct transform_node *subnodes_tail;
+  struct transform_node *next;
+};
+
+typedef struct {
+  struct transform_node *root;
+} Transform_t;
+
 enum row_mode {
   ROW_YIELD,
   ROW_MULTI,
@@ -113,7 +154,7 @@ typedef struct {
   VALUE               self;
   VALUE               sql;
   VALUE               params;
-  VALUE               transform_proc;
+  VALUE               transform;
 
   Database_t          *db;
   sqlite3             *sqlite3_db;
@@ -137,11 +178,11 @@ enum gvl_mode {
 #define SINGLE_ROW -2
 #define ROW_YIELD_OR_MODE(default) (rb_block_given_p() ? ROW_YIELD : default)
 #define ROW_MULTI_P(mode) (mode == ROW_MULTI)
-#define QUERY_CTX(self, sql, db, stmt, params, transform_proc, query_mode, row_mode, max_rows) { \
+#define QUERY_CTX(self, sql, db, stmt, params, transform, query_mode, row_mode, max_rows) { \
   self, \
   sql, \
   params, \
-  transform_proc, \
+  transform, \
   db, \
   db->sqlite3_db, \
   stmt, \
@@ -170,13 +211,16 @@ VALUE safe_query_array(query_ctx *ctx);
 VALUE safe_query_changes(query_ctx *ctx);
 VALUE safe_query_columns(query_ctx *ctx);
 VALUE safe_query_hash(query_ctx *ctx);
+VALUE safe_query_transform(query_ctx *ctx);
 VALUE safe_query_single_row_hash(query_ctx *ctx);
 VALUE safe_query_single_row_splat(query_ctx *ctx);
 VALUE safe_query_single_row_array(query_ctx *ctx);
+VALUE safe_query_single_row_transform(query_ctx *ctx);
 
 VALUE Query_each(VALUE self);
 VALUE Query_next(int argc, VALUE *argv, VALUE self);
 VALUE Query_to_a(VALUE self);
+VALUE Query_transform_set(VALUE self, VALUE transform);
 
 void prepare_single_stmt(enum gvl_mode mode, sqlite3 *db, sqlite3_stmt **stmt, VALUE sql);
 void prepare_multi_stmt(enum gvl_mode mode, sqlite3 *db, sqlite3_stmt **stmt, VALUE sql);
@@ -192,4 +236,6 @@ Database_t *self_to_database(VALUE self);
 
 void *gvl_call(enum gvl_mode mode, void *(*fn)(void *), void *data);
 
+struct transform_node *get_transform_root(VALUE obj);
+
 #endif /* EXTRALITE_H */

data/ext/extralite/extralite_ext.c

@@ -6,6 +6,7 @@ void Init_ExtraliteIterator();
 #ifdef EXTRALITE_ENABLE_CHANGESET
 void Init_ExtraliteChangeset();
 #endif
+void Init_ExtraliteTransform();
 
 void Init_extralite_ext(void) {
   rb_ext_ractor_safe(true);
@@ -16,4 +17,5 @@ void Init_extralite_ext(void) {
 #ifdef EXTRALITE_ENABLE_CHANGESET
   Init_ExtraliteChangeset();
 #endif
+  Init_ExtraliteTransform();
 }

data/ext/extralite/query.c

@@ -28,7 +28,7 @@ static void Query_mark(void *ptr) {
   Query_t *query = ptr;
   rb_gc_mark_movable(query->db);
   rb_gc_mark_movable(query->sql);
-  rb_gc_mark_movable(query->transform_proc);
+  rb_gc_mark_movable(query->transform);
   rb_gc_mark_movable(query->bound_params);
 }
 
@@ -36,7 +36,7 @@ static void Query_compact(void *ptr) {
   Query_t *query = ptr;
   query->db = rb_gc_location(query->db);
   query->sql = rb_gc_location(query->sql);
-  query->transform_proc = rb_gc_location(query->transform_proc);
+  query->transform = rb_gc_location(query->transform);
   query->bound_params = rb_gc_location(query->bound_params);
 }
 
@@ -54,12 +54,11 @@ static const rb_data_type_t Query_type = {
 
 static VALUE Query_allocate(VALUE klass) {
   Query_t *query = ALLOC(Query_t);
+  memset(query, 0, sizeof(Query_t));
   query->db = Qnil;
   query->sql = Qnil;
-  query->transform_proc = Qnil;
+  query->transform = Qnil;
   query->bound_params = Qnil;
-  query->sqlite3_db = NULL;
-  query->stmt = NULL;
   return TypedData_Wrap_Struct(klass, &Query_type, query);
 }
 
@@ -118,7 +117,7 @@ VALUE Query_initialize(VALUE self, VALUE db, VALUE sql, VALUE mode) {
   RB_OBJ_WRITE(self, &query->db, db);
   RB_OBJ_WRITE(self, &query->sql, sql);
   if (rb_block_given_p())
-    RB_OBJ_WRITE(self, &query->transform_proc, rb_block_proc());
+    RB_OBJ_WRITE(self, &query->transform, rb_block_proc());
 
   query->self = self;
   query->db = db;
@@ -153,7 +152,7 @@ static inline void query_bind(Query_t *query, int argc, VALUE * argv) {
     // changing the binding. See note at bottom of
     // https://www.sqlite.org/c3ref/bind_blob.html
     sqlite3_reset(query->stmt);
-  
+
   sqlite3_clear_bindings(query->stmt);
   if (argc > 0) {
     bind_all_parameters(query->stmt, argc, argv);
@@ -231,13 +230,18 @@ static inline VALUE Query_perform_next(VALUE self, int max_rows, safe_query_impl
   if (!query->stmt || query->should_reset) query_reset(query);
   if (query->eof) return rb_block_given_p() ? self : Qnil;
 
+  if (query->transform_object) {
+    max_rows = ALL_ROWS;
+    call = safe_query_transform;
+  }
+
   query_ctx ctx = QUERY_CTX(
     self,
     query->sql,
     query->db_struct,
     query->stmt,
     Qnil,
-    query->transform_proc,
+    query->transform,
     query->query_mode,
     ROW_YIELD_OR_MODE(max_rows == SINGLE_ROW ? ROW_SINGLE : ROW_MULTI),
     MAX_ROWS(max_rows)
@@ -378,7 +382,7 @@ VALUE Query_execute_chevrons(VALUE self, VALUE params) {
  * parameters for running the query. If a callable is given, it is called
  * repeatedly and each of its return values is used as the parameters, until nil
  * is returned.
- * 
+ *
  * Returns the number of changes effected. This method is designed for inserting
  * multiple records.
  *
@@ -388,7 +392,7 @@ VALUE Query_execute_chevrons(VALUE self, VALUE params) {
  *       [4, 5, 6]
  *     ]
  *     query.batch_execute(records)
- * 
+ *
  *     source = [
  *       [1, 2, 3],
  *       [4, 5, 6]
@@ -432,7 +436,7 @@ VALUE Query_batch_execute(VALUE self, VALUE parameters) {
  * invocation of the query, and the total number of changes is returned.
  * Otherwise, an array containing the resulting rows for each invocation is
  * returned.
- * 
+ *
  * Rows are returned according to the query mode and transform.
  *
  *     q = db.prepare('insert into foo values (?, ?) returning bar, baz')
@@ -460,7 +464,7 @@ VALUE Query_batch_query(VALUE self, VALUE parameters) {
     query->db_struct,
     query->stmt,
     parameters,
-    query->transform_proc,
+    query->transform,
     query->query_mode,
     ROW_YIELD_OR_MODE(ROW_MULTI),
     ALL_ROWS
@@ -514,7 +518,7 @@ VALUE Query_clone(VALUE self) {
     query->sql,
     query_mode_to_symbol(query->query_mode)
   };
-  return rb_funcall_with_block(cQuery, ID_new, 3, args, query->transform_proc);
+  return rb_funcall_with_block(cQuery, ID_new, 3, args, query->transform);
 }
 
 /* Closes the query. Attempting to run a closed query will raise an error.
@@ -566,27 +570,6 @@ VALUE Query_status(int argc, VALUE* argv, VALUE self) {
   return INT2NUM(value);
 }
 
-/* Sets the transform block to the given block. If a transform block is set,
- * calls to #to_a, #next, #each and #batch_query will transform values fetched
- * from the database using the transform block before passing them to the
- * application code. To remove the transform block, call `#transform`
- * without a block. The transform for each row is done by passing the row hash
- * to the block.
- *
- *     # fetch column c as an ORM object
- *     q = db.prepare('select * from foo order by a').transform do |h|
- *       MyModel.new(h)
- *     end
- *
- * @return [Extralite::Query] query
- */
-VALUE Query_transform(VALUE self) {
-  Query_t *query = self_to_query_verify(self);
-
-  RB_OBJ_WRITE(self, &query->transform_proc, rb_block_given_p() ? rb_block_proc() : Qnil);
-  return self;
-}
-
 /* Returns a short string representation of the query instance, including the
  * SQL string.
  *
@@ -616,7 +599,7 @@ VALUE Query_mode_get(VALUE self) {
 
 /* call-seq:
  *   query.mode = mode
- * 
+ *
  * Sets the query mode. This can be one of `:hash`, `:splat`, `:array`.
  *
  * @param mode [Symbol] query mode
@@ -628,6 +611,48 @@ VALUE Query_mode_set(VALUE self, VALUE mode) {
   return mode;
 }
 
+/*
+ * Returns the transform set for the query.
+ *
+ * @return [Proc, Extralite::Transform, nil] transform
+ */
+VALUE Query_transform_get(VALUE self) {
+  Query_t *query = self_to_query_verify(self);
+  return query->transform;
+}
+
+/*
+ * Sets the transform block to the given proc or transform object. If a
+ * transform is set, calls to #to_a, #next, #each and #batch_query will
+ * transform values fetched from the database using the transform before passing
+ * them to the application code. To remove the transform, call `#transform=`
+ * with a nil value.
+ *
+ *     # fetch column c as an ORM object
+ *     q = db.prepare('select * from foo')
+ *     q.transform = ->(h) {
+ *       MyModel.new(h)
+ *     }
+ *
+ *     # use a custom transform
+ *     q = db.prepare('select id, name from foo')
+ *     q.transform = Extralite::Transform.new(
+ *       columns: {
+ *         id: { type: integer, identity: true },
+ *         name: { type: :text }
+ *       }
+ *     )
+ *
+ * @param transform [Extralite::Transform, Proc, nil] transform or nil
+ * @return [Extralite::Query] query
+ */
+VALUE Query_transform_set(VALUE self, VALUE transform) {
+  Query_t *query = self_to_query(self);
+  query->transform = transform;
+  query->transform_object = rb_obj_is_instance_of(transform, cTransform);
+  return self;
+}
+
 void Init_ExtraliteQuery(void) {
   VALUE mExtralite = rb_define_module("Extralite");
 
@@ -657,14 +682,15 @@ void Init_ExtraliteQuery(void) {
   rb_define_method(cQuery, "sql",            Query_sql, 0);
   rb_define_method(cQuery, "status",         Query_status, -1);
   rb_define_method(cQuery, "to_a",           Query_to_a, 0);
-  rb_define_method(cQuery, "transform",      Query_transform, 0);
+  rb_define_method(cQuery, "transform",      Query_transform_get, 0);
+  rb_define_method(cQuery, "transform=",     Query_transform_set, 1);
 
-  ID_inspect  = rb_intern("inspect");
-  ID_slice    = rb_intern("slice");
+  ID_inspect  = rb_intern_const("inspect");
+  ID_slice    = rb_intern_const("slice");
 
-  SYM_hash          = ID2SYM(rb_intern("hash"));
-  SYM_splat          = ID2SYM(rb_intern("splat"));
-  SYM_array           = ID2SYM(rb_intern("array"));
+  SYM_hash    = ID2SYM(rb_intern_const("hash"));
+  SYM_splat   = ID2SYM(rb_intern_const("splat"));
+  SYM_array   = ID2SYM(rb_intern_const("array"));
 
   rb_gc_register_mark_object(SYM_hash);
   rb_gc_register_mark_object(SYM_splat);