Convert SQLite3::Database objects to TypedData API

The replacement API was introduced in Ruby 1.9.2 (2010),
and the old untyped data API was marked a deprecated in the documentation
as of Ruby 2.3.0 (2015)

Ref: https://bugs.ruby-lang.org/issues/19998

ext/sqlite3/aggregator.c

@@ -206,12 +206,11 @@ VALUE
 rb_sqlite3_define_aggregator2(VALUE self, VALUE aggregator, VALUE ruby_name)
 {
   /* define_aggregator is added as a method to SQLite3::Database in database.c */
-  sqlite3RubyPtr ctx;
+  sqlite3RubyPtr ctx = sqlite3_database_unwrap(self);
   int arity, status;
   VALUE aw;
   VALUE aggregators;
 
-  Data_Get_Struct(self, sqlite3Ruby, ctx);
   if (!ctx->db) {
     rb_raise(rb_path2class("SQLite3::Exception"), "cannot use a closed database");
   }

ext/sqlite3/backup.c

@@ -76,8 +76,8 @@ static VALUE initialize(VALUE self, VALUE dstdb, VALUE dstname, VALUE srcdb, VAL
   sqlite3_backup *pBackup;
 
   TypedData_Get_Struct(self, sqlite3BackupRuby, &backup_type, ctx);
-  Data_Get_Struct(dstdb, sqlite3Ruby, ddb_ctx);
-  Data_Get_Struct(srcdb, sqlite3Ruby, sdb_ctx);
+  ddb_ctx = sqlite3_database_unwrap(dstdb);
+  sdb_ctx = sqlite3_database_unwrap(srcdb);
 
   if(!sdb_ctx->db)
     rb_raise(rb_eArgError, "cannot backup from a closed database");

ext/sqlite3/database.c

@@ -21,10 +21,29 @@ static void deallocate(void * ctx)
   xfree(c);
 }
 
+static size_t database_memsize(const void *ctx)
+{
+  const sqlite3RubyPtr c = (const sqlite3RubyPtr)ctx;
+  // NB: can't account for ctx->db because the type is incomplete.
+  return sizeof(*c);
+}
+
+static const rb_data_type_t database_type = {
+  "SQLite3::Backup",
+  {
+      NULL,
+      deallocate,
+      database_memsize,
+  },
+  0,
+  0,
+  RUBY_TYPED_WB_PROTECTED, // Not freed immediately because the dfree function do IOs.
+};
+
 static VALUE allocate(VALUE klass)
 {
-  sqlite3RubyPtr ctx = xcalloc((size_t)1, sizeof(sqlite3Ruby));
-  return Data_Wrap_Struct(klass, NULL, deallocate, ctx);
+  sqlite3RubyPtr ctx;
+  return TypedData_Make_Struct(klass, sqlite3Ruby, &database_type, ctx);
 }
 
 static char *
@@ -37,12 +56,18 @@ utf16_string_value_ptr(VALUE str)
 
 static VALUE sqlite3_rb_close(VALUE self);
 
+sqlite3RubyPtr sqlite3_database_unwrap(VALUE database){
+  sqlite3RubyPtr ctx;
+  TypedData_Get_Struct(database, sqlite3Ruby, &database_type, ctx);
+  return ctx;
+}
+
 static VALUE rb_sqlite3_open_v2(VALUE self, VALUE file, VALUE mode, VALUE zvfs)
 {
   sqlite3RubyPtr ctx;
   int status;
 
-  Data_Get_Struct(self, sqlite3Ruby, ctx);
+  TypedData_Get_Struct(self, sqlite3Ruby, &database_type, ctx);
 
 #if defined TAINTING_SUPPORT
 #  if defined StringValueCStr
@@ -69,7 +94,7 @@ static VALUE rb_sqlite3_disable_quirk_mode(VALUE self)
 {
 #if defined SQLITE_DBCONFIG_DQS_DDL
   sqlite3RubyPtr ctx;
-  Data_Get_Struct(self, sqlite3Ruby, ctx);
+  TypedData_Get_Struct(self, sqlite3Ruby, &database_type, ctx);
 
   if(!ctx->db) return Qfalse;
 
@@ -90,7 +115,7 @@ static VALUE sqlite3_rb_close(VALUE self)
 {
   sqlite3RubyPtr ctx;
   sqlite3 * db;
-  Data_Get_Struct(self, sqlite3Ruby, ctx);
+  TypedData_Get_Struct(self, sqlite3Ruby, &database_type, ctx);
 
   db = ctx->db;
   CHECK(db, sqlite3_close(ctx->db));
@@ -109,7 +134,7 @@ static VALUE sqlite3_rb_close(VALUE self)
 static VALUE closed_p(VALUE self)
 {
   sqlite3RubyPtr ctx;
-  Data_Get_Struct(self, sqlite3Ruby, ctx);
+  TypedData_Get_Struct(self, sqlite3Ruby, &database_type, ctx);
 
   if(!ctx->db) return Qtrue;
 
@@ -124,7 +149,7 @@ static VALUE closed_p(VALUE self)
 static VALUE total_changes(VALUE self)
 {
   sqlite3RubyPtr ctx;
-  Data_Get_Struct(self, sqlite3Ruby, ctx);
+  TypedData_Get_Struct(self, sqlite3Ruby, &database_type, ctx);
   REQUIRE_OPEN_DB(ctx);
 
   return INT2NUM(sqlite3_total_changes(ctx->db));
@@ -150,7 +175,7 @@ static VALUE trace(int argc, VALUE *argv, VALUE self)
   sqlite3RubyPtr ctx;
   VALUE block;
 
-  Data_Get_Struct(self, sqlite3Ruby, ctx);
+  TypedData_Get_Struct(self, sqlite3Ruby, &database_type, ctx);
   REQUIRE_OPEN_DB(ctx);
 
   rb_scan_args(argc, argv, "01", &block);
@@ -195,7 +220,7 @@ static VALUE busy_handler(int argc, VALUE *argv, VALUE self)
   VALUE block;
   int status;
 
-  Data_Get_Struct(self, sqlite3Ruby, ctx);
+  TypedData_Get_Struct(self, sqlite3Ruby, &database_type, ctx);
   REQUIRE_OPEN_DB(ctx);
 
   rb_scan_args(argc, argv, "01", &block);
@@ -220,7 +245,7 @@ static VALUE busy_handler(int argc, VALUE *argv, VALUE self)
 static VALUE last_insert_row_id(VALUE self)
 {
   sqlite3RubyPtr ctx;
-  Data_Get_Struct(self, sqlite3Ruby, ctx);
+  TypedData_Get_Struct(self, sqlite3Ruby, &database_type, ctx);
   REQUIRE_OPEN_DB(ctx);
 
   return LL2NUM(sqlite3_last_insert_rowid(ctx->db));
@@ -340,7 +365,7 @@ static VALUE define_function_with_flags(VALUE self, VALUE name, VALUE flags)
   VALUE block;
   int status;
 
-  Data_Get_Struct(self, sqlite3Ruby, ctx);
+  TypedData_Get_Struct(self, sqlite3Ruby, &database_type, ctx);
   REQUIRE_OPEN_DB(ctx);
 
   block = rb_block_proc();
@@ -380,7 +405,7 @@ static VALUE define_function(VALUE self, VALUE name)
 static VALUE interrupt(VALUE self)
 {
   sqlite3RubyPtr ctx;
-  Data_Get_Struct(self, sqlite3Ruby, ctx);
+  TypedData_Get_Struct(self, sqlite3Ruby, &database_type, ctx);
   REQUIRE_OPEN_DB(ctx);
 
   sqlite3_interrupt(ctx->db);
@@ -396,7 +421,7 @@ static VALUE interrupt(VALUE self)
 static VALUE errmsg(VALUE self)
 {
   sqlite3RubyPtr ctx;
-  Data_Get_Struct(self, sqlite3Ruby, ctx);
+  TypedData_Get_Struct(self, sqlite3Ruby, &database_type, ctx);
   REQUIRE_OPEN_DB(ctx);
 
   return rb_str_new2(sqlite3_errmsg(ctx->db));
@@ -410,7 +435,7 @@ static VALUE errmsg(VALUE self)
 static VALUE errcode_(VALUE self)
 {
   sqlite3RubyPtr ctx;
-  Data_Get_Struct(self, sqlite3Ruby, ctx);
+  TypedData_Get_Struct(self, sqlite3Ruby, &database_type, ctx);
   REQUIRE_OPEN_DB(ctx);
 
   return INT2NUM(sqlite3_errcode(ctx->db));
@@ -438,7 +463,7 @@ static VALUE complete_p(VALUE UNUSED(self), VALUE sql)
 static VALUE changes(VALUE self)
 {
   sqlite3RubyPtr ctx;
-  Data_Get_Struct(self, sqlite3Ruby, ctx);
+  TypedData_Get_Struct(self, sqlite3Ruby, &database_type, ctx);
   REQUIRE_OPEN_DB(ctx);
 
   return INT2NUM(sqlite3_changes(ctx->db));
@@ -483,7 +508,7 @@ static VALUE set_authorizer(VALUE self, VALUE authorizer)
   sqlite3RubyPtr ctx;
   int status;
 
-  Data_Get_Struct(self, sqlite3Ruby, ctx);
+  TypedData_Get_Struct(self, sqlite3Ruby, &database_type, ctx);
   REQUIRE_OPEN_DB(ctx);
 
   status = sqlite3_set_authorizer(
@@ -510,7 +535,7 @@ static VALUE set_authorizer(VALUE self, VALUE authorizer)
 static VALUE set_busy_timeout(VALUE self, VALUE timeout)
 {
   sqlite3RubyPtr ctx;
-  Data_Get_Struct(self, sqlite3Ruby, ctx);
+  TypedData_Get_Struct(self, sqlite3Ruby, &database_type, ctx);
   REQUIRE_OPEN_DB(ctx);
 
   CHECK(ctx->db, sqlite3_busy_timeout(ctx->db, (int)NUM2INT(timeout)));
@@ -526,7 +551,7 @@ static VALUE set_busy_timeout(VALUE self, VALUE timeout)
 static VALUE set_extended_result_codes(VALUE self, VALUE enable)
 {
   sqlite3RubyPtr ctx;
-  Data_Get_Struct(self, sqlite3Ruby, ctx);
+  TypedData_Get_Struct(self, sqlite3Ruby, &database_type, ctx);
   REQUIRE_OPEN_DB(ctx);
 
   CHECK(ctx->db, sqlite3_extended_result_codes(ctx->db, RTEST(enable) ? 1 : 0));
@@ -571,7 +596,7 @@ int rb_comparator_func(void * ctx, int a_len, const void * a, int b_len, const v
 static VALUE collation(VALUE self, VALUE name, VALUE comparator)
 {
   sqlite3RubyPtr ctx;
-  Data_Get_Struct(self, sqlite3Ruby, ctx);
+  TypedData_Get_Struct(self, sqlite3Ruby, &database_type, ctx);
   REQUIRE_OPEN_DB(ctx);
 
   CHECK(ctx->db, sqlite3_create_collation(
@@ -600,7 +625,7 @@ static VALUE load_extension(VALUE self, VALUE file)
   int status;
   char *errMsg;
   VALUE errexp;
-  Data_Get_Struct(self, sqlite3Ruby, ctx);
+  TypedData_Get_Struct(self, sqlite3Ruby, &database_type, ctx);
   REQUIRE_OPEN_DB(ctx);
 
   status = sqlite3_load_extension(ctx->db, StringValuePtr(file), 0, &errMsg);
@@ -624,7 +649,7 @@ static VALUE enable_load_extension(VALUE self, VALUE onoff)
 {
   sqlite3RubyPtr ctx;
   int onoffparam;
-  Data_Get_Struct(self, sqlite3Ruby, ctx);
+  TypedData_Get_Struct(self, sqlite3Ruby, &database_type, ctx);
   REQUIRE_OPEN_DB(ctx);
 
   if (Qtrue == onoff) {
@@ -661,7 +686,7 @@ static VALUE db_encoding(VALUE self)
   sqlite3RubyPtr ctx;
   VALUE enc;
 
-  Data_Get_Struct(self, sqlite3Ruby, ctx);
+  TypedData_Get_Struct(self, sqlite3Ruby, &database_type, ctx);
   REQUIRE_OPEN_DB(ctx);
 
   enc = rb_iv_get(self, "@encoding");
@@ -681,7 +706,7 @@ static VALUE db_encoding(VALUE self)
 static VALUE transaction_active_p(VALUE self)
 {
   sqlite3RubyPtr ctx;
-  Data_Get_Struct(self, sqlite3Ruby, ctx);
+  TypedData_Get_Struct(self, sqlite3Ruby, &database_type, ctx);
   REQUIRE_OPEN_DB(ctx);
 
   return sqlite3_get_autocommit(ctx->db) ? Qfalse : Qtrue;
@@ -740,7 +765,7 @@ static VALUE exec_batch(VALUE self, VALUE sql, VALUE results_as_hash)
   char *errMsg;
   VALUE errexp;
 
-  Data_Get_Struct(self, sqlite3Ruby, ctx);
+  TypedData_Get_Struct(self, sqlite3Ruby, &database_type, ctx);
   REQUIRE_OPEN_DB(ctx);
 
   if(results_as_hash == Qtrue) {
@@ -768,7 +793,7 @@ static VALUE db_filename(VALUE self, VALUE db_name)
 {
   sqlite3RubyPtr ctx;
   const char * fname;
-  Data_Get_Struct(self, sqlite3Ruby, ctx);
+  TypedData_Get_Struct(self, sqlite3Ruby, &database_type, ctx);
   REQUIRE_OPEN_DB(ctx);
 
   fname = sqlite3_db_filename(ctx->db, StringValueCStr(db_name));
@@ -782,7 +807,7 @@ static VALUE rb_sqlite3_open16(VALUE self, VALUE file)
   int status;
   sqlite3RubyPtr ctx;
 
-  Data_Get_Struct(self, sqlite3Ruby, ctx);
+  TypedData_Get_Struct(self, sqlite3Ruby, &database_type, ctx);
 
 #if defined TAINTING_SUPPORT
 #if defined StringValueCStr

ext/sqlite3/database.h

@@ -12,6 +12,8 @@ typedef sqlite3Ruby * sqlite3RubyPtr;
 
 void init_sqlite3_database();
 void set_sqlite3_func_result(sqlite3_context * ctx, VALUE result);
+
+sqlite3RubyPtr sqlite3_database_unwrap(VALUE database);
 VALUE sqlite3val2rb(sqlite3_value * val);
 
 #endif

ext/sqlite3/statement.c

@@ -30,14 +30,13 @@ static VALUE allocate(VALUE klass)
  */
 static VALUE initialize(VALUE self, VALUE db, VALUE sql)
 {
-  sqlite3RubyPtr db_ctx;
+  sqlite3RubyPtr db_ctx = sqlite3_database_unwrap(db);
   sqlite3StmtRubyPtr ctx;
   const char *tail = NULL;
   int status;
 
   StringValue(sql);
 
-  Data_Get_Struct(db, sqlite3Ruby, db_ctx);
   Data_Get_Struct(self, sqlite3StmtRuby, ctx);
 
   if(!db_ctx->db)