extralite 0.2 → 0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 407877ae6a216daacd70b87735171f77845fe57ec6a0b109a96e4cc31c00f97b
-  data.tar.gz: 2273841ec089faac02d3e7901d0e9ffd91cf1bc95e47e0b7c912cfbb218f6f55
+  metadata.gz: 89b99ba7c6d26fc887574bf943f8e07f4c27f0c058a99723be73d7b64a90b3d5
+  data.tar.gz: 41c9bc62b91d78d0507d58b6a3e150608aae813b7b929410f23b0389a8b8c98f
 SHA512:
-  metadata.gz: eed74e69024c0e714e1a1e8449e3e2503e8dde5e2ed807a64ce46cec079b58c9c7417014ac6a4600958e355e0218b0ccc63def43b1ba98c5d5fe0de11b4d4559
-  data.tar.gz: dd20969cb233586cbaf998fda0d65cafe703d5cdaa3f1ff9377a9a679f7b9dd602d71525259cd459bfabddc6d2a4c01b330c59a673b23de6ed37abe9920b7aab
+  metadata.gz: 6c29b92468cdf3a2fe9f65088c579a901ff981b11c68d8dc32c99508c4ab7fae5a8d9a348e2310dcf18b0980edac9f3503889de76e097c6d27c6c3fb20480245
+  data.tar.gz: 49c703000e9285cff90dadd0d64f40690d96a6f6c59305021dca0561d41aff6fedcc64a4918ce16337acbb7537fd91c73f2b1d65953cdff8be591773844c3465

data/CHANGELOG.md

@@ -1,4 +1,20 @@
-## 0.2 2021-05-24
+## 0.6 2021-05-25
+
+- Add more specific errors: `SQLError`, `BusyError`
+
+## 0.5 2021-05-25
+
+- Implement `Database#query_single_row`
+
+## 0.4 2021-05-24
+
+- Add support for loading extensions
+
+## 0.3 2021-05-24
+
+- Add support for running multiple statements
+
+## 0.2 2021-05-23
 
 - Implement `Database#transaction_active?`
 - Add tests

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    extralite (0.2)
+    extralite (0.6)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -5,12 +5,13 @@ class with a minimal set of methods to interact with an SQLite3 database.
 
 ### Features
 
-- A variety of ways to get back query results: row as hash, row as array, single
-  column, single value.
+- A variety of methods for different data access patterns: row as hash, row as array, single
+  single row, single column, single value.
 - Iterate over records with a block, or collect records into an array.
 - Parameter binding.
 - Get last insert rowid.
 - Get number of rows changed by last query.
+- Load extensions.
 
 ### Usage
 
@@ -34,6 +35,9 @@ db.query_ary('select 1, 2, 3') #=> [[1, 2, 3]]
 db.query_ary('select 1, 2, 3') { |r| p r }
 # [1, 2, 3]
 
+# get a single row as a hash
+db.query_single_row("select 1 as foo") #=> { :foo => 1 }
+
 # get single column query results as array of values
 db.query_single_column('select 42') #=> [42]
 # or iterate over results

data/ext/extralite/extralite.c

@@ -3,6 +3,9 @@
 #include "../sqlite3/sqlite3.h"
 
 VALUE cError;
+VALUE cSQLError;
+VALUE cBusyError;
+ID ID_STRIP;
 
 typedef struct Database_t {
   sqlite3 *sqlite3_db;
@@ -44,10 +47,14 @@ VALUE Database_initialize(VALUE self, VALUE path) {
 
   rc = sqlite3_open(StringValueCStr(path), &db->sqlite3_db);
   if (rc) {
-    fprintf(stderr, "Can't open database: %s\n", sqlite3_errmsg(db->sqlite3_db));
     sqlite3_close(db->sqlite3_db);
-    // TODO: raise error
-    return Qfalse;
+    rb_raise(cError, "%s", sqlite3_errmsg(db->sqlite3_db));
+  }
+
+  rc = sqlite3_enable_load_extension(db->sqlite3_db, 1);
+  if (rc) {
+    sqlite3_close(db->sqlite3_db);
+    rb_raise(cError, "%s", sqlite3_errmsg(db->sqlite3_db));
   }
 
   return Qnil;
@@ -123,6 +130,41 @@ static inline VALUE row_to_hash(sqlite3_stmt *stmt, int column_count, VALUE colu
   return row;
 }
 
+static inline VALUE row_to_ary(sqlite3_stmt *stmt, int column_count) {
+  VALUE row = rb_ary_new2(column_count);
+  for (int i = 0; i < column_count; i++) {
+    VALUE value = get_column_value(stmt, i, sqlite3_column_type(stmt, i));
+    rb_ary_push(row, value);
+  }
+  return row;
+}
+
+inline void prepare_multi_stmt(sqlite3 *db, sqlite3_stmt **stmt, VALUE sql) {
+  const char *rest = 0;
+  const char *ptr = RSTRING_PTR(sql);
+  const char *end = ptr + RSTRING_LEN(sql);
+  while (1) {
+    int rc = sqlite3_prepare(db, ptr, end - ptr, stmt, &rest);
+    if (rc) {
+      sqlite3_finalize(*stmt);
+      rb_raise(cSQLError, "%s", sqlite3_errmsg(db));
+    }
+
+    if (rest == end) return;
+    
+    // perform current query, but discard its results
+    rc = sqlite3_step(*stmt);
+    sqlite3_finalize(*stmt);
+    switch (rc) {
+    case SQLITE_BUSY:
+      rb_raise(cBusyError, "Database is busy");
+    case SQLITE_ERROR:
+      rb_raise(cSQLError, "%s", sqlite3_errmsg(db));
+    }
+    ptr = rest;
+  }
+}
+
 VALUE Database_query_hash(int argc, VALUE *argv, VALUE self) {
   int rc;
   sqlite3_stmt* stmt;
@@ -135,16 +177,12 @@ VALUE Database_query_hash(int argc, VALUE *argv, VALUE self) {
   VALUE sql;
   
   rb_check_arity(argc, 1, UNLIMITED_ARGUMENTS);
-  sql = argv[0];
-  GetDatabase(self, db);
+  sql = rb_funcall(argv[0], ID_STRIP, 0);
+  if (RSTRING_LEN(sql) == 0) return Qnil;
 
-  rc = sqlite3_prepare(db->sqlite3_db, RSTRING_PTR(sql), RSTRING_LEN(sql), &stmt, 0);
-  if (rc) {
-    sqlite3_finalize(stmt);
-    rb_raise(cError, "%s", sqlite3_errmsg(db->sqlite3_db));
-    return Qnil;
-  }
+  GetDatabase(self, db);
 
+  prepare_multi_stmt(db->sqlite3_db, &stmt, sql);
   bind_all_parameters(stmt, argc, argv);
   column_count = sqlite3_column_count(stmt);
   column_names = get_column_names(stmt, column_count);
@@ -163,10 +201,10 @@ step:
       break;
     case SQLITE_BUSY:
       sqlite3_finalize(stmt);
-      rb_raise(cError, "Database is busy");
+      rb_raise(cBusyError, "Database is busy");
     case SQLITE_ERROR:
       sqlite3_finalize(stmt);
-      rb_raise(cError, "%s", sqlite3_errmsg(db->sqlite3_db));
+      rb_raise(cSQLError, "%s", sqlite3_errmsg(db->sqlite3_db));
     default:
       sqlite3_finalize(stmt);
       rb_raise(cError, "Invalid return code for sqlite3_step: %d", rc);
@@ -179,15 +217,6 @@ step:
   return result;
 }
 
-static inline VALUE row_to_ary(sqlite3_stmt *stmt, int column_count) {
-  VALUE row = rb_ary_new2(column_count);
-  for (int i = 0; i < column_count; i++) {
-    VALUE value = get_column_value(stmt, i, sqlite3_column_type(stmt, i));
-    rb_ary_push(row, value);
-  }
-  return row;
-}
-
 VALUE Database_query_ary(int argc, VALUE *argv, VALUE self) {
   int rc;
   sqlite3_stmt* stmt;
@@ -199,17 +228,11 @@ VALUE Database_query_ary(int argc, VALUE *argv, VALUE self) {
   VALUE sql;
 
   rb_check_arity(argc, 1, UNLIMITED_ARGUMENTS);
-  sql = argv[0];
+  sql = rb_funcall(argv[0], ID_STRIP, 0);
+  if (RSTRING_LEN(sql) == 0) return Qnil;
   GetDatabase(self, db);
 
-  rc = sqlite3_prepare(db->sqlite3_db, RSTRING_PTR(sql), RSTRING_LEN(sql), &stmt, 0);
-  if (rc) {
-    fprintf(stderr, "Failed to prepare statement: %s\n", sqlite3_errmsg(db->sqlite3_db));
-    sqlite3_finalize(stmt);
-    // TODO: raise error
-    return Qfalse;
-  }
-
+  prepare_multi_stmt(db->sqlite3_db, &stmt, sql);
   bind_all_parameters(stmt, argc, argv);
   column_count = sqlite3_column_count(stmt);
 
@@ -225,10 +248,13 @@ step:
     case SQLITE_DONE:
       break;
     case SQLITE_BUSY:
-      rb_raise(cError, "Database is busy");
+      sqlite3_finalize(stmt);
+      rb_raise(cBusyError, "Database is busy");
     case SQLITE_ERROR:
-      rb_raise(cError, "%s", sqlite3_errmsg(db->sqlite3_db));
+      sqlite3_finalize(stmt);
+      rb_raise(cSQLError, "%s", sqlite3_errmsg(db->sqlite3_db));
     default:
+      sqlite3_finalize(stmt);
       rb_raise(cError, "Invalid return code for sqlite3_step: %d", rc);
   }
   sqlite3_finalize(stmt);
@@ -237,6 +263,47 @@ step:
   return result;
 }
 
+VALUE Database_query_single_row(int argc, VALUE *argv, VALUE self) {
+  int rc;
+  sqlite3_stmt* stmt;
+  int column_count;
+  Database_t *db;
+  VALUE sql;
+  VALUE row = Qnil;
+  VALUE column_names;
+
+  rb_check_arity(argc, 1, UNLIMITED_ARGUMENTS);
+  sql = rb_funcall(argv[0], ID_STRIP, 0);
+  if (RSTRING_LEN(sql) == 0) return Qnil;
+
+  GetDatabase(self, db);
+
+  prepare_multi_stmt(db->sqlite3_db, &stmt, sql);
+  bind_all_parameters(stmt, argc, argv);
+  column_count = sqlite3_column_count(stmt);
+  column_names = get_column_names(stmt, column_count);
+
+  rc = sqlite3_step(stmt);
+  switch (rc) {
+    case SQLITE_ROW:
+      row = row_to_hash(stmt, column_count, column_names);
+      break;
+    case SQLITE_DONE:
+      break;
+    case SQLITE_BUSY:
+      rb_raise(cBusyError, "Database is busy");
+    case SQLITE_ERROR:
+      rb_raise(cSQLError, "%s", sqlite3_errmsg(db->sqlite3_db));
+    default:
+      rb_raise(cError, "Invalid return code for sqlite3_step: %d", rc);
+  }
+
+  sqlite3_finalize(stmt);
+  RB_GC_GUARD(row);
+  RB_GC_GUARD(column_names);
+  return row;
+}
+
 VALUE Database_query_single_column(int argc, VALUE *argv, VALUE self) {
   int rc;
   sqlite3_stmt* stmt;
@@ -248,17 +315,12 @@ VALUE Database_query_single_column(int argc, VALUE *argv, VALUE self) {
   VALUE value;
 
   rb_check_arity(argc, 1, UNLIMITED_ARGUMENTS);
-  sql = argv[0];
-  GetDatabase(self, db);
+  sql = rb_funcall(argv[0], ID_STRIP, 0);
+  if (RSTRING_LEN(sql) == 0) return Qnil;
 
-  rc = sqlite3_prepare(db->sqlite3_db, RSTRING_PTR(sql), RSTRING_LEN(sql), &stmt, 0);
-  if (rc) {
-    fprintf(stderr, "Failed to prepare statement: %s\n", sqlite3_errmsg(db->sqlite3_db));
-    sqlite3_finalize(stmt);
-    // TODO: raise error
-    return Qfalse;
-  }
+  GetDatabase(self, db);
 
+  prepare_multi_stmt(db->sqlite3_db, &stmt, sql);
   bind_all_parameters(stmt, argc, argv);
   column_count = sqlite3_column_count(stmt);
   if (column_count != 1)
@@ -276,10 +338,13 @@ step:
     case SQLITE_DONE:
       break;
     case SQLITE_BUSY:
-      rb_raise(cError, "Database is busy");
+      sqlite3_finalize(stmt);
+      rb_raise(cBusyError, "Database is busy");
     case SQLITE_ERROR:
-      rb_raise(cError, "%s", sqlite3_errmsg(db->sqlite3_db));
+      sqlite3_finalize(stmt);
+      rb_raise(cSQLError, "%s", sqlite3_errmsg(db->sqlite3_db));
     default:
+      sqlite3_finalize(stmt);
       rb_raise(cError, "Invalid return code for sqlite3_step: %d", rc);
   }
 
@@ -298,17 +363,12 @@ VALUE Database_query_single_value(int argc, VALUE *argv, VALUE self) {
   VALUE value = Qnil;
 
   rb_check_arity(argc, 1, UNLIMITED_ARGUMENTS);
-  sql = argv[0];
-  GetDatabase(self, db);
+  sql = rb_funcall(argv[0], ID_STRIP, 0);
+  if (RSTRING_LEN(sql) == 0) return Qnil;
 
-  rc = sqlite3_prepare(db->sqlite3_db, RSTRING_PTR(sql), RSTRING_LEN(sql), &stmt, 0);
-  if (rc) {
-    fprintf(stderr, "Failed to prepare statement: %s\n", sqlite3_errmsg(db->sqlite3_db));
-    sqlite3_finalize(stmt);
-    // TODO: raise error
-    return Qfalse;
-  }
+  GetDatabase(self, db);
 
+  prepare_multi_stmt(db->sqlite3_db, &stmt, sql);
   bind_all_parameters(stmt, argc, argv);
   column_count = sqlite3_column_count(stmt);
   if (column_count != 1)
@@ -319,10 +379,12 @@ VALUE Database_query_single_value(int argc, VALUE *argv, VALUE self) {
     case SQLITE_ROW:
       value = get_column_value(stmt, 0, sqlite3_column_type(stmt, 0));
       break;
+    case SQLITE_DONE:
+      break;
     case SQLITE_BUSY:
-      rb_raise(cError, "Database is busy");
+      rb_raise(cBusyError, "Database is busy");
     case SQLITE_ERROR:
-      rb_raise(cError, "%s", sqlite3_errmsg(db->sqlite3_db));
+      rb_raise(cSQLError, "%s", sqlite3_errmsg(db->sqlite3_db));
     default:
       rb_raise(cError, "Invalid return code for sqlite3_step: %d", rc);
   }
@@ -365,6 +427,21 @@ VALUE Database_transaction_active_p(VALUE self) {
   return sqlite3_get_autocommit(db->sqlite3_db) ? Qfalse : Qtrue;
 }
 
+VALUE Database_load_extension(VALUE self, VALUE path) {
+  Database_t *db;
+  GetDatabase(self, db);
+  char *err_msg;
+
+  int rc = sqlite3_load_extension(db->sqlite3_db, RSTRING_PTR(path), 0, &err_msg);
+  if (rc != SQLITE_OK) {
+    VALUE error = rb_exc_new2(cError, err_msg);
+    sqlite3_free(err_msg);
+    rb_exc_raise(error);
+  }
+
+  return self;
+}
+
 void Init_Extralite() {
   VALUE mExtralite = rb_define_module("Extralite");
   VALUE cDatabase = rb_define_class_under(mExtralite, "Database", rb_cObject);
@@ -375,6 +452,7 @@ void Init_Extralite() {
   rb_define_method(cDatabase, "query", Database_query_hash, -1);
   rb_define_method(cDatabase, "query_hash", Database_query_hash, -1);
   rb_define_method(cDatabase, "query_ary", Database_query_ary, -1);
+  rb_define_method(cDatabase, "query_single_row", Database_query_single_row, -1);
   rb_define_method(cDatabase, "query_single_column", Database_query_single_column, -1);
   rb_define_method(cDatabase, "query_single_value", Database_query_single_value, -1);
   
@@ -382,6 +460,11 @@ void Init_Extralite() {
   rb_define_method(cDatabase, "changes", Database_changes, 0);
   rb_define_method(cDatabase, "filename", Database_filename, -1);
   rb_define_method(cDatabase, "transaction_active?", Database_transaction_active_p, 0);
+  rb_define_method(cDatabase, "load_extension", Database_load_extension, 1);
 
   cError = rb_define_class_under(mExtralite, "Error", rb_eRuntimeError);
+  cSQLError = rb_define_class_under(mExtralite, "SQLError", cError);
+  cBusyError = rb_define_class_under(mExtralite, "BusyError", cError);
+
+  ID_STRIP = rb_intern("strip");
 }

data/extralite.gemspec

@@ -11,8 +11,8 @@ Gem::Specification.new do |s|
   s.homepage    = 'https://github.com/digital-fabric/extralite'
   s.metadata    = {
     "source_code_uri" => "https://github.com/digital-fabric/extralite",
-    "documentation_uri" => "https://digital-fabric.github.io/extralite/",
-    "homepage_uri" => "https://digital-fabric.github.io/extralite/",
+    "documentation_uri" => "https://github.com/digital-fabric/extralite",
+    "homepage_uri" => "https://github.com/digital-fabric/extralite",
     "changelog_uri" => "https://github.com/digital-fabric/extralite/blob/master/CHANGELOG.md"
   }
   s.rdoc_options = ["--title", "extralite", "--main", "README.md"]

data/lib/extralite/version.rb

@@ -1,3 +1,3 @@
 module Extralite
-  VERSION = '0.2'
+  VERSION = '0.6'
 end

data/test/test_database.rb

@@ -19,26 +19,53 @@ class DatabaseTest < MiniTest::Test
   def test_query
     r = @db.query('select * from t')
     assert_equal [{x: 1, y: 2, z: 3}, {x: 4, y: 5, z: 6}], r
+
+    r = @db.query('select * from t where x = 2')
+    assert_equal [], r
+  end
+
+  def test_invalid_query
+    assert_raises(Extralite::SQLError) { @db.query('blah') }
   end
 
   def test_query_hash
     r = @db.query_hash('select * from t')
     assert_equal [{x: 1, y: 2, z: 3}, {x: 4, y: 5, z: 6}], r
+
+    r = @db.query_hash('select * from t where x = 2')
+    assert_equal [], r
   end
 
   def test_query_ary
     r = @db.query_ary('select * from t')
     assert_equal [[1, 2, 3], [4, 5, 6]], r
+
+    r = @db.query_ary('select * from t where x = 2')
+    assert_equal [], r
+  end
+
+  def test_query_single_row
+    r = @db.query_single_row('select * from t order by x desc limit 1')
+    assert_equal({ x: 4, y: 5, z: 6 }, r)
+
+    r = @db.query_single_row('select * from t where x = 2')
+    assert_nil r
   end
 
   def test_query_single_column
     r = @db.query_single_column('select y from t')
     assert_equal [2, 5], r
-  end
+  
+    r = @db.query_single_column('select y from t where x = 2')
+    assert_equal [], r
+end
 
   def test_query_single_value
     r = @db.query_single_value('select z from t order by Z desc limit 1')
     assert_equal 6, r
+
+    r = @db.query_single_value('select z from t where x = 2')
+    assert_nil r
   end
 
   def test_transaction_active?
@@ -48,4 +75,18 @@ class DatabaseTest < MiniTest::Test
     @db.query('rollback')
     assert_equal false, @db.transaction_active?
   end
+
+  def test_multiple_statements
+    @db.query("insert into t values ('a', 'b', 'c'); insert into t values ('d', 'e', 'f');")
+
+    assert_equal [1, 4, 'a', 'd'], @db.query_single_column('select x from t order by x')
+  end
+
+  def test_empty_sql
+    r = @db.query(' ')
+    assert_nil r
+
+    r = @db.query('select 1 as foo;  ')
+    assert_equal [{ foo: 1 }], r
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: extralite
 version: !ruby/object:Gem::Version
-  version: '0.2'
+  version: '0.6'
 platform: ruby
 authors:
 - Sharon Rosner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-23 00:00:00.000000000 Z
+date: 2021-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake-compiler
@@ -125,8 +125,8 @@ licenses:
 - MIT
 metadata:
   source_code_uri: https://github.com/digital-fabric/extralite
-  documentation_uri: https://digital-fabric.github.io/extralite/
-  homepage_uri: https://digital-fabric.github.io/extralite/
+  documentation_uri: https://github.com/digital-fabric/extralite
+  homepage_uri: https://github.com/digital-fabric/extralite
   changelog_uri: https://github.com/digital-fabric/extralite/blob/master/CHANGELOG.md
 post_install_message: 
 rdoc_options: