extralite 1.0 → 1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9c69948d51f689ead3e4ccf008bc7b0670085d0c987d39359bb38172b9993b58
-  data.tar.gz: 776ed4e4f95cdb405b9b3be277d0aaa5a27fcd0e84aff8f6ebb3aeece531b1cf
+  metadata.gz: b112a3c34429f8b44c4b4a922c4e038387f6c1db54e6f01377200d7a60324dd4
+  data.tar.gz: a664bc81719347079fdfbbffdf2e665bd2772fe8dcf9c30b3ec18c6238a8888a
 SHA512:
-  metadata.gz: 472db7ae94e195e647712ce04213538b229bcfebc3f9ec22b3f8e69dceb0a5cbba9000e14147a27ed2e26231aa7c73b43585a45be369f94d8cd2507643dd88b9
-  data.tar.gz: 6475f99ebe990b9b073f77379f58ddcd4fa0f678fb32e64b39021e3aa7b6d6f9343c8f02d69cce1826a9d156c8b0918985536732af5a11be2bda28524524e8c2
+  metadata.gz: '053783bb3f186130fc92b0a57403f0f9472a98e6ce45b1fbb128c5e43914b2a6ec56d39a5e6b10e16f5e6b46f8e9d586837860f63e7538ad238fc0a7aa0995c3'
+  data.tar.gz: '058538866f9b2c6a5a0116c8ed3a801aa7bbb8ef8f911eff6d94d7a9cfa98861ad98f4d27e06a736b18c4b62e3c2369a4a306492cc562693da0282363e00f208'

data/CHANGELOG.md

@@ -1,3 +1,19 @@
+## 1.4 2021-08-25
+
+- Fix possible segfault in cleanup_stmt
+
+## 1.3 2021-08-17
+
+- Pin error classes (for better compatibility with `GC.compact`)
+
+## 1.2 2021-06-06
+
+- Add support for big integers
+
+## 1.1 2021-06-02
+
+- Add `#close`, `#closed?` methods
+
 ## 1.0 2021-05-27
 
 - Refactor C code

data/Gemfile.lock

@@ -1,24 +1,17 @@
 PATH
   remote: .
   specs:
-    extralite (1.0)
+    extralite (1.4)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    ansi (1.5.0)
     ast (2.4.2)
-    builder (3.2.4)
     coderay (1.1.3)
     docile (1.4.0)
     json (2.5.1)
     method_source (1.0.0)
     minitest (5.14.4)
-    minitest-reporters (1.4.2)
-      ansi
-      builder
-      minitest (>= 5.0)
-      ruby-progressbar
     parallel (1.20.1)
     parser (3.0.1.1)
       ast (~> 2.4.1)
@@ -56,7 +49,6 @@ PLATFORMS
 DEPENDENCIES
   extralite!
   minitest (= 5.14.4)
-  minitest-reporters (= 1.4.2)
   pry (= 0.13.1)
   rake-compiler (= 1.1.1)
   rubocop (= 0.85.1)

data/README.md

@@ -1,10 +1,16 @@
-## Extralite
+# Extralite - a Ruby gem for working with SQLite3 databases
 
-Extralite is an extra-lightweight (~365 lines of C-code) SQLite3 wrapper for
+[![Gem Version](https://badge.fury.io/rb/extralite.svg)](http://rubygems.org/gems/extralite)
+[![Modulation Test](https://github.com/digital-fabric/extralite/workflows/Tests/badge.svg)](https://github.com/digital-fabric/extralite/actions?query=workflow%3ATests)
+[![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/digital-fabric/extralite/blob/master/LICENSE)
+
+## What is Extralite?
+
+Extralite is an extra-lightweight (less than 400 lines of C-code) SQLite3 wrapper for
 Ruby. It provides a single class with a minimal set of methods to interact with
 an SQLite3 database.
 
-### Features
+## Features
 
 - A variety of methods for different data access patterns: row as hash, row as
   array, single single row, single column, single value.
@@ -17,7 +23,7 @@ an SQLite3 database.
 - Load extensions (loading of extensions is autmatically enabled. You can find
   some useful extensions here: https://github.com/nalgeon/sqlean.)
 
-### Usage
+## Usage
 
 ```ruby
 require 'extralite'
@@ -65,16 +71,20 @@ db.filename #=> "/tmp/my.db"
 
 # load an extension
 db.load_extension('/path/to/extension.so')
+
+# close database
+db.close
+db.closed? #=> true
 ```
 
-### Why not just use the sqlite3 gem?
+## Why not just use the sqlite3 gem?
 
 The sqlite3-ruby gem is a popular, solid, well-maintained project, used by
 thousands of developers. I've been doing a lot of work with SQLite3 lately, and
 wanted to have a simpler API that gives me query results in a variety of ways.
 Thus extralite was born.
 
-### What about concurrency?
+## What about concurrency?
 
 Extralite currently does not release the GVL. This means that even if queries
 are executed on a separate thread, no other Ruby threads will be scheduled while
@@ -83,7 +93,7 @@ SQLite3 is busy fetching the next record.
 In the future Extralite might be changed to release the GVL each time
 `sqlite3_step` is called.
 
-### Can I use it with an ORM like ActiveRecord or Sequel?
+## Can I use it with an ORM like ActiveRecord or Sequel?
 
 Not yet, but you are welcome to contribute adapters for those projects. I will
 be releasing my own not-an-ORM tool in the near future.

data/ext/extralite/extralite.c

@@ -39,6 +39,14 @@ static VALUE Database_allocate(VALUE klass) {
 #define GetDatabase(obj, database) \
   TypedData_Get_Struct((obj), Database_t, &Database_type, (database))
 
+// make sure the database is open
+#define GetOpenDatabase(obj, database) { \
+  TypedData_Get_Struct((obj), Database_t, &Database_type, (database)); \
+  if (!(database)->sqlite3_db) { \
+    rb_raise(cError, "Database is closed"); \
+  } \
+}
+
 
 VALUE Database_initialize(VALUE self, VALUE path) {
   int rc;
@@ -60,12 +68,33 @@ VALUE Database_initialize(VALUE self, VALUE path) {
   return Qnil;
 }
 
+VALUE Database_close(VALUE self) {
+  int rc;
+  Database_t *db;
+  GetDatabase(self, db);
+
+  rc = sqlite3_close(db->sqlite3_db);
+  if (rc) {
+    rb_raise(cError, "%s", sqlite3_errmsg(db->sqlite3_db));
+  }
+
+  db->sqlite3_db = 0;
+  return self;
+}
+
+VALUE Database_closed_p(VALUE self) {
+  Database_t *db;
+  GetDatabase(self, db);
+
+  return db->sqlite3_db ? Qfalse : Qtrue;
+}
+
 inline VALUE get_column_value(sqlite3_stmt *stmt, int col, int type) {
   switch (type) {
     case SQLITE_NULL:
       return Qnil;
     case SQLITE_INTEGER:
-      return INT2NUM(sqlite3_column_int(stmt, col));
+      return LL2NUM(sqlite3_column_int64(stmt, col));
     case SQLITE_FLOAT:
       return DBL2NUM(sqlite3_column_double(stmt, col));
     case SQLITE_TEXT:
@@ -85,7 +114,7 @@ static inline void bind_parameter_value(sqlite3_stmt *stmt, int pos, VALUE value
       sqlite3_bind_null(stmt, pos);
       return;
     case T_FIXNUM:
-      sqlite3_bind_int(stmt, pos, NUM2INT(value));
+      sqlite3_bind_int64(stmt, pos, NUM2LL(value));
       return;
     case T_FLOAT:
       sqlite3_bind_double(stmt, pos, NUM2DBL(value));
@@ -193,7 +222,7 @@ typedef struct query_ctx {
 
 VALUE cleanup_stmt(VALUE arg) {
   query_ctx *ctx = (query_ctx *)arg;
-  sqlite3_finalize(ctx->stmt);
+  if (ctx->stmt) sqlite3_finalize(ctx->stmt);
   return Qnil;
 }
 
@@ -214,7 +243,7 @@ VALUE safe_query_hash(VALUE arg) {
   VALUE column_names;
 
   check_arity_and_prepare_sql(ctx->argc, ctx->argv, sql);
-  GetDatabase(ctx->self, db);
+  GetOpenDatabase(ctx->self, db);
 
   prepare_multi_stmt(db->sqlite3_db, &ctx->stmt, sql);
   bind_all_parameters(ctx->stmt, ctx->argc, ctx->argv);
@@ -250,7 +279,7 @@ VALUE safe_query_ary(VALUE arg) {
   VALUE sql;
 
   check_arity_and_prepare_sql(ctx->argc, ctx->argv, sql);
-  GetDatabase(ctx->self, db);
+  GetOpenDatabase(ctx->self, db);
 
   prepare_multi_stmt(db->sqlite3_db, &ctx->stmt, sql);
   bind_all_parameters(ctx->stmt, ctx->argc, ctx->argv);
@@ -283,7 +312,7 @@ VALUE safe_query_single_row(VALUE arg) {
   VALUE column_names;
 
   check_arity_and_prepare_sql(ctx->argc, ctx->argv, sql);
-  GetDatabase(ctx->self, db);
+  GetOpenDatabase(ctx->self, db);
 
   prepare_multi_stmt(db->sqlite3_db, &ctx->stmt, sql);
   bind_all_parameters(ctx->stmt, ctx->argc, ctx->argv);
@@ -314,7 +343,7 @@ VALUE safe_query_single_column(VALUE arg) {
   VALUE value;
 
   check_arity_and_prepare_sql(ctx->argc, ctx->argv, sql);
-  GetDatabase(ctx->self, db);
+  GetOpenDatabase(ctx->self, db);
 
   prepare_multi_stmt(db->sqlite3_db, &ctx->stmt, sql);
   bind_all_parameters(ctx->stmt, ctx->argc, ctx->argv);
@@ -348,7 +377,7 @@ VALUE safe_query_single_value(VALUE arg) {
   VALUE value = Qnil;
 
   check_arity_and_prepare_sql(ctx->argc, ctx->argv, sql);
-  GetDatabase(ctx->self, db);
+  GetOpenDatabase(ctx->self, db);
 
   prepare_multi_stmt(db->sqlite3_db, &ctx->stmt, sql);
   bind_all_parameters(ctx->stmt, ctx->argc, ctx->argv);
@@ -370,14 +399,14 @@ VALUE Database_query_single_value(int argc, VALUE *argv, VALUE self) {
 
 VALUE Database_last_insert_rowid(VALUE self) {
   Database_t *db;
-  GetDatabase(self, db);
+  GetOpenDatabase(self, db);
 
   return INT2NUM(sqlite3_last_insert_rowid(db->sqlite3_db));
 }
 
 VALUE Database_changes(VALUE self) {
   Database_t *db;
-  GetDatabase(self, db);
+  GetOpenDatabase(self, db);
 
   return INT2NUM(sqlite3_changes(db->sqlite3_db));
 }
@@ -386,7 +415,7 @@ VALUE Database_filename(int argc, VALUE *argv, VALUE self) {
   const char *db_name;
   const char *filename;
   Database_t *db;
-  GetDatabase(self, db);
+  GetOpenDatabase(self, db);
 
   rb_check_arity(argc, 0, 1);
   db_name = (argc == 1) ? StringValueCStr(argv[0]) : "main";
@@ -396,14 +425,14 @@ VALUE Database_filename(int argc, VALUE *argv, VALUE self) {
 
 VALUE Database_transaction_active_p(VALUE self) {
   Database_t *db;
-  GetDatabase(self, db);
+  GetOpenDatabase(self, db);
 
   return sqlite3_get_autocommit(db->sqlite3_db) ? Qfalse : Qtrue;
 }
 
 VALUE Database_load_extension(VALUE self, VALUE path) {
   Database_t *db;
-  GetDatabase(self, db);
+  GetOpenDatabase(self, db);
   char *err_msg;
 
   int rc = sqlite3_load_extension(db->sqlite3_db, RSTRING_PTR(path), 0, &err_msg);
@@ -422,6 +451,8 @@ void Init_Extralite() {
   rb_define_alloc_func(cDatabase, Database_allocate);
 
   rb_define_method(cDatabase, "initialize", Database_initialize, 1);
+  rb_define_method(cDatabase, "close", Database_close, 0);
+  rb_define_method(cDatabase, "closed?", Database_closed_p, 0);
   
   rb_define_method(cDatabase, "query", Database_query_hash, -1);
   rb_define_method(cDatabase, "query_hash", Database_query_hash, -1);
@@ -439,6 +470,9 @@ void Init_Extralite() {
   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);
+  rb_gc_register_mark_object(cError);
+  rb_gc_register_mark_object(cSQLError);
+  rb_gc_register_mark_object(cBusyError);
 
   ID_STRIP = rb_intern("strip");
 }

data/extralite.gemspec

@@ -23,7 +23,6 @@ Gem::Specification.new do |s|
 
   s.add_development_dependency  'rake-compiler',        '1.1.1'
   s.add_development_dependency  'minitest',             '5.14.4'
-  s.add_development_dependency  'minitest-reporters',   '1.4.2'
   s.add_development_dependency  'simplecov',            '0.17.1'
   s.add_development_dependency  'rubocop',              '0.85.1'
   s.add_development_dependency  'pry',                  '0.13.1'

data/lib/extralite/version.rb

@@ -1,3 +1,3 @@
 module Extralite
-  VERSION = '1.0'
+  VERSION = '1.4'
 end

data/test/helper.rb

@@ -3,8 +3,3 @@
 require 'bundler/setup'
 require 'extralite'
 require 'minitest/autorun'
-require 'minitest/reporters'
-
-Minitest::Reporters.use! [
-  Minitest::Reporters::SpecReporter.new
-]

data/test/test_database.rb

@@ -89,4 +89,15 @@ end
     r = @db.query('select 1 as foo;  ')
     assert_equal [{ foo: 1 }], r
   end
+
+  def test_close
+    assert_equal false, @db.closed?
+    r = @db.query_single_value('select 42')
+    assert_equal 42, r
+
+    assert_equal @db, @db.close
+    assert_equal true, @db.closed?
+    
+    assert_raises(Extralite::Error) { @db.query_single_value('select 42') }
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: extralite
 version: !ruby/object:Gem::Version
-  version: '1.0'
+  version: '1.4'
 platform: ruby
 authors:
 - Sharon Rosner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-27 00:00:00.000000000 Z
+date: 2021-08-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake-compiler
@@ -38,20 +38,6 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 5.14.4
-- !ruby/object:Gem::Dependency
-  name: minitest-reporters
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 1.4.2
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 1.4.2
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -146,7 +132,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Extra-lightweight SQLite3 wrapper for Ruby