extralite 0.4 → 0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8cdf5b562230dd1dc2e3dcc4083836c6d61ac4bfd51fdc12d7129ff57dc36148
-  data.tar.gz: 1db604b9d586ed4f3ca45516ad25ed73c4d668407616c5657372074a7d0d13a8
+  metadata.gz: 8fa0672decf076e478bfd52359196baecbcf837e00cec91c7f9cf963b103af68
+  data.tar.gz: e54364225b96fc355a8198eab73c7a27848a672e04479a7eed06f724991ae238
 SHA512:
-  metadata.gz: bca80a7a86e23651cf7c672a74bbc423b696b080155a1932378af4028d282260b079754d99c0e6e52e1ab7bd2ca9417c67fe285af8bcd7e090c9b4d764f0f6a5
-  data.tar.gz: 74f35b4542eda30a6944403b1ea46d329a64deacf75a023bdae1ff718f7b0cce01278ffbc1e67f2a7a865d8fca44788454329d2aaedad69b402692c059ca8e90
+  metadata.gz: 9606a7e0154d61adc29150161a44018638f7e05a3c17f4f8e8b992e166ad0cd46705cb4eab2e9e6f7cc7f4d9eece8406e468822ff8a84116ff6f58cc493a89dd
+  data.tar.gz: fa5e4e1425187986ec097990f84ae103428645f94caaa41471305b414c78f15fb9522311b4eb50d40bc91c715f9e20e1c2fac18c0fd02892b41e75994602691d

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.5 2021-05-25
+
+- Implement `Database#query_single_row`
+
 ## 0.4 2021-05-24
 
 - Add support for loading extensions

data/Gemfile.lock

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

data/README.md

@@ -5,8 +5,8 @@ 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.
@@ -34,6 +34,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_column("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,7 @@
 #include "../sqlite3/sqlite3.h"
 
 VALUE cError;
+ID ID_STRIP;
 
 typedef struct Database_t {
   sqlite3 *sqlite3_db;
@@ -127,6 +128,15 @@ 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);
@@ -165,7 +175,9 @@ VALUE Database_query_hash(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);
 
   prepare_multi_stmt(db->sqlite3_db, &stmt, sql);
@@ -203,15 +215,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;
@@ -223,7 +226,8 @@ 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);
 
   prepare_multi_stmt(db->sqlite3_db, &stmt, sql);
@@ -257,6 +261,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(cError, "Database is busy");
+    case SQLITE_ERROR:
+      rb_raise(cError, "%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;
@@ -268,7 +313,9 @@ VALUE Database_query_single_column(int argc, VALUE *argv, VALUE self) {
   VALUE value;
 
   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);
 
   prepare_multi_stmt(db->sqlite3_db, &stmt, sql);
@@ -281,7 +328,6 @@ VALUE Database_query_single_column(int argc, VALUE *argv, VALUE self) {
   if (!yield_to_block) result = rb_ary_new();
 step:
   rc = sqlite3_step(stmt);
-  printf("rc=%d\n", rc);
   switch (rc) {
     case SQLITE_ROW:
       value = get_column_value(stmt, 0, sqlite3_column_type(stmt, 0));
@@ -315,7 +361,9 @@ VALUE Database_query_single_value(int argc, VALUE *argv, VALUE self) {
   VALUE value = Qnil;
 
   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);
 
   prepare_multi_stmt(db->sqlite3_db, &stmt, sql);
@@ -329,6 +377,8 @@ 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");
     case SQLITE_ERROR:
@@ -400,6 +450,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);
   
@@ -410,4 +461,5 @@ void Init_Extralite() {
   rb_define_method(cDatabase, "load_extension", Database_load_extension, 1);
 
   cError = rb_define_class_under(mExtralite, "Error", rb_eRuntimeError);
+  ID_STRIP = rb_intern("strip");
 }

data/lib/extralite/version.rb

@@ -1,3 +1,3 @@
 module Extralite
-  VERSION = '0.4'
+  VERSION = '0.5'
 end

data/test/test_database.rb

@@ -19,26 +19,49 @@ 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_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?
@@ -54,4 +77,12 @@ class DatabaseTest < MiniTest::Test
 
     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.4'
+  version: '0.5'
 platform: ruby
 authors:
 - Sharon Rosner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-24 00:00:00.000000000 Z
+date: 2021-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake-compiler