extralite 1.8.2 → 1.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dd26d2937628e408ba8ee2f69e2e170755a43d5e1ffcdcbb82ca184cd5734576
-  data.tar.gz: c762b88c6e1671de5daab90f6f6fb574bb4dfb43fb0a866e8154fb8ac02f755f
+  metadata.gz: ed6cb05e12c36bbbc92701af98639a9a92b91d9ba0fca0362b35fb12f3af676e
+  data.tar.gz: 6d7976fc5b39aa414a5a3431a9c5a1a6c517166d4e82de621b22da3be50fe38b
 SHA512:
-  metadata.gz: 9ea096a28f15e8415b8e450a45035ffbe0c2186ebc7bba2ddd76c34e2328baaff307cee3c5079dda235992011497ef72b924bf3916628842e100ba8953ee7454
-  data.tar.gz: 0efd84d3a7fa1fd1157df43f65bd4fa6999a0943efc8c0b36030a8550bbb2bc1c3a96509d4bf6c7a8a2bb9c4bd071dc0a650cb45e54e75c7ec722ee29c8bb72e
+  metadata.gz: 9baa147f13fa4498264e6e942e9c154bcdcd458f503944be9385f5ea61b82a8e6d381f77a75ad7a4c7643aa124cc2a4d5aa8ffb58400efa641dcb62fad810437
+  data.tar.gz: 789d203582c86f54a8f234b67d7b54b03150b900d25a5c76e81a57d779d1735fa7a8dc9822d121df7d08af4513481bf4c0a1a6d2fb1d6dfc54d80022b2b6e559

data/.github/FUNDING.yml

@@ -0,0 +1 @@
+github: ciconia

data/.github/workflows/test.yml

@@ -7,8 +7,8 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        os: [ubuntu-latest]
-        ruby: [2.6, 2.7, '3.0']
+        os: [ubuntu-latest, macos-10.15]
+        ruby: [2.7, 3.0, 3.1, truffleruby]
 
     name: >-
       ${{matrix.os}}, ${{matrix.ruby}}

data/CHANGELOG.md

@@ -1,3 +1,20 @@
+## 1.12 2022-02-15
+
+- Add `Extralite.sqlite3_version` method
+- Bundle sqlite3 in gem
+
+## 1.11 2021-12-17
+
+- Fix compilation on MacOS (#3)
+
+## 1.10 2021-12-15
+
+- Fix mutliple parameter binding with hash
+
+## 1.9 2021-12-15
+
+- Add support for reading BLOBs
+
 ## 1.8.2 2021-12-15
 
 - Add documentation

data/Gemfile.lock

@@ -1,13 +1,13 @@
 PATH
   remote: .
   specs:
-    extralite (1.8.2)
+    extralite (1.12)
 
 GEM
   remote: https://rubygems.org/
   specs:
     docile (1.4.0)
-    json (2.5.1)
+    json (2.6.1)
     minitest (5.15.0)
     rake (13.0.6)
     rake-compiler (1.1.6)
@@ -34,4 +34,4 @@ DEPENDENCIES
   yard (= 0.9.27)
 
 BUNDLED WITH
-   2.1.4
+   2.3.3

data/README.md

@@ -1,17 +1,36 @@
-# Extralite - a Ruby gem for working with SQLite3 databases
-
-[![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)
+<h1 align="center">
+  Extralite
+</h1>
+
+<h4 align="center">A fast Ruby gem for working with SQLite3 databases</h4>
+
+<p align="center">
+  <a href="http://rubygems.org/gems/extralite">
+    <img src="https://badge.fury.io/rb/extralite.svg" alt="Ruby gem">
+  </a>
+  <a href="https://github.com/digital-fabric/extralite/actions?query=workflow%3ATests">
+    <img src="https://github.com/digital-fabric/extralite/workflows/Tests/badge.svg" alt="Tests">
+  </a>
+  <a href="https://github.com/digital-fabric/extralite/blob/master/LICENSE">
+    <img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="MIT License">
+  </a>
+</p>
+
+<p align="center">
+  <a href="https://www.rubydoc.info/gems/extralite">DOCS</a> |
+  <a href="https://noteflakes.com/articles/2021-12-15-extralite">BLOG POST</a>
+</p>
 
 ## What is Extralite?
 
-Extralite is an extra-lightweight (less than 430 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.
+Extralite is a fast, extra-lightweight (less than 460 lines of C-code) SQLite3
+wrapper for Ruby. It provides a single class with a minimal set of methods for
+interacting with an SQLite3 database.
 
 ## Features
 
+- Zero dependencies: Extralite bundles SQLite3 version 3.37.2 - no need to
+  install any `libsqlite3` packages.
 - A variety of methods for different data access patterns: rows as hashes, rows
   as arrays, single row, single column, single value.
 - Super fast - [up to 12.5x faster](#performance) than the
@@ -28,13 +47,16 @@ interact with an SQLite3 database.
 - Get number of rows changed by last query.
 - Load extensions (loading of extensions is autmatically enabled. You can find
   some useful extensions here: https://github.com/nalgeon/sqlean.)
-- Includes a [Sequel adapter](#usage-with-sequel) (an ActiveRecord)
+- Includes a [Sequel adapter](#usage-with-sequel).
 
 ## Usage
 
 ```ruby
 require 'extralite'
 
+# get sqlite3 version
+Extralite.sqlite3_version #=> "3.37.2"
+
 # open a database
 db = Extralite::Database.new('/tmp/my.db')
 
@@ -96,7 +118,7 @@ Extralite includes an adapter for
 just use the `extralite` scheme instead of `sqlite`:
 
 ```ruby
-DB = Sequel.connect('extralite:blog.db')
+DB = Sequel.connect('extralite://blog.db')
 articles = DB[:articles]
 p articles.to_a
 ```
@@ -120,6 +142,7 @@ Here's a table summarizing the differences between the two gems:
 
 | |sqlite3-ruby|Extralite|
 |-|-|-|
+|SQLite3 dependency|depends on OS-installed libsqlite3|bundles latest version of SQLite3|
 |API design|multiple classes|single class|
 |Query results|row as hash, row as array, single row, single value|row as hash, row as array, __single column__, single row, single value|
 |execute multiple statements|separate API (#execute_batch)|integrated|
@@ -127,7 +150,7 @@ Here's a table summarizing the differences between the two gems:
 |custom collations|yes|no|
 |custom aggregate functions|yes|no|
 |Multithread friendly|no|[yes](#what-about-concurrency)|
-|Code size|~2650LoC|~500LoC|
+|Code size|~2650LoC|~530LoC|
 |Performance|1x|1.5x to 12.5x (see [below](#performance))|
 
 ## What about concurrency?
@@ -140,23 +163,33 @@ performance:
 
 ## Performance
 
-A benchmark script is
-[included](https://github.com/digital-fabric/extralite/blob/main/test/perf.rb),
-creating a table of various row counts, then fetching the entire table using
-either `sqlite3` or `extralite`. This benchmark shows Extralite to be up to 12.5
-times faster than `sqlite3` when fetching a large number of rows. Here are the
-results (using the `sqlite3` gem performance as baseline):
+A benchmark script is included, creating a table of various row counts, then
+fetching the entire table using either `sqlite3` or `extralite`. This benchmark
+shows Extralite to be up to 12.5 times faster than `sqlite3` when fetching a
+large number of rows. Here are the [results for fetching rows as hashes](https://github.com/digital-fabric/extralite/blob/main/test/perf_hash.rb):
+
+|Row count|sqlite3-ruby|Extralite|Advantage|
+|-:|-:|-:|-:|
+|10|57620 rows/s|95340 rows/s|__1.65x__|
+|1K|286.8K rows/s|2106.4 rows/s|__7.35x__|
+|100K|181K rows/s|2275.3K rows/s|__12.53x__|
 
-|Row count|sqlite3-ruby (baseline)|Extralite (relative - rounded)|
-|-:|-:|-:|
-|10|1x|1.5x|
-|1K|1x|7x|
-|100K|1x|12.5x|
+When [fetching rows as arrays](https://github.com/digital-fabric/extralite/blob/main/test/perf_ary.rb) Extralite also significantly outperforms sqlite3-ruby:
+
+|Row count|sqlite3-ruby|Extralite|Advantage|
+|-:|-:|-:|-:|
+|10|64365 rows/s|94031 rows/s|__1.46x__|
+|1K|498.9K rows/s|2478.2K rows/s|__4.97x__|
+|100K|441.1K rows/s|3023.4K rows/s|__6.85x__|
 
 (If you're interested in checking this yourself, just run the script and let me
-know if your results are different.)
+know if your results are better/worse.)
+
+As those benchmarks show, Extralite is capabale of reading more than 3M
+rows/second (when fetching rows as arrays), and more than 2.2M rows/second (when
+fetching rows as hashes.)
 
 ## Contributing
 
 Contributions in the form of issues, PRs or comments will be greatly
-appreciated!
+appreciated!

data/ext/extralite/extconf.rb

@@ -1,115 +1,9 @@
 # frozen_string_literal: true
 
-# require 'rubygems'
-# require 'mkmf'
-
-# # $CFLAGS << "-Wdiscarded-qualifier"
-#   # $CFLAGS << " -Wno-comment"
-#   # $CFLAGS << " -Wno-unused-result"
-#   # $CFLAGS << " -Wno-dangling-else"
-#   # $CFLAGS << " -Wno-parentheses"
-
-# dir_config 'extralite_ext'
-# create_makefile 'extralite_ext'
-
-ENV['RC_ARCHS'] = '' if RUBY_PLATFORM =~ /darwin/
-
 require 'mkmf'
 
-# :stopdoc:
-
-RbConfig::MAKEFILE_CONFIG['CC'] = ENV['CC'] if ENV['CC']
-
-ldflags = cppflags = nil
-if RbConfig::CONFIG["host_os"] =~ /darwin/
-  begin
-    if with_config('sqlcipher')
-      brew_prefix = `brew --prefix sqlcipher`.chomp
-      ldflags   = "#{brew_prefix}/lib"
-      cppflags  = "#{brew_prefix}/include/sqlcipher"
-      pkg_conf  = "#{brew_prefix}/lib/pkgconfig"
-    else
-      brew_prefix = `brew --prefix sqlite3`.chomp
-      ldflags   = "#{brew_prefix}/lib"
-      cppflags  = "#{brew_prefix}/include"
-      pkg_conf  = "#{brew_prefix}/lib/pkgconfig"
-    end
-
-    # pkg_config should be less error prone than parsing compiler
-    # commandline options, but we need to set default ldflags and cpp flags
-    # in case the user doesn't have pkg-config installed
-    ENV['PKG_CONFIG_PATH'] ||= pkg_conf
-  rescue
-  end
-end
-
-if with_config('sqlcipher')
-  pkg_config("sqlcipher")
-else
-  pkg_config("sqlite3")
-end
-
-# --with-sqlite3-{dir,include,lib}
-if with_config('sqlcipher')
-  $CFLAGS << ' -DUSING_SQLCIPHER'
-  dir_config("sqlcipher", cppflags, ldflags)
-else
-  dir_config("sqlite3", cppflags, ldflags)
-end
-
-if RbConfig::CONFIG["host_os"] =~ /mswin/
-  $CFLAGS << ' -W3'
-end
-
-if RUBY_VERSION < '2.7'
-  $CFLAGS << ' -DTAINTING_SUPPORT'
-end
-
-def asplode missing
-  if RUBY_PLATFORM =~ /mingw|mswin/
-    abort "#{missing} is missing. Install SQLite3 from " +
-          "http://www.sqlite.org/ first."
-  else
-    abort <<-error
-#{missing} is missing. Try 'brew install sqlite3',
-'yum install sqlite-devel' or 'apt-get install libsqlite3-dev'
-and check your shared library search path (the
-location where your sqlite3 shared library is located).
-    error
-  end
-end
-
-asplode('sqlite3.h')  unless find_header  'sqlite3.h'
-find_library 'pthread', 'pthread_create' # 1.8 support. *shrug*
-
-have_library 'dl' # for static builds
-
-if with_config('sqlcipher')
-  asplode('sqlcipher') unless find_library 'sqlcipher', 'sqlite3_libversion_number'
-else
-  asplode('sqlite3') unless find_library 'sqlite3', 'sqlite3_libversion_number'
-end
-
-# Functions defined in 1.9 but not 1.8
-have_func('rb_proc_arity')
-
-# Functions defined in 2.1 but not 2.0
-have_func('rb_integer_pack')
-
-# These functions may not be defined
-have_func('sqlite3_initialize')
-have_func('sqlite3_backup_init')
-have_func('sqlite3_column_database_name')
-have_func('sqlite3_enable_load_extension')
-have_func('sqlite3_load_extension')
-
-unless have_func('sqlite3_open_v2')
-  abort "Please use a newer version of SQLite3"
-end
-
-have_func('sqlite3_prepare_v2')
-have_type('sqlite3_int64', 'sqlite3.h')
-have_type('sqlite3_uint64', 'sqlite3.h')
+$CFLAGS << " -Wno-undef"
+$CFLAGS << " -Wno-discarded-qualifiers"
 
 dir_config('extralite_ext')
-create_makefile('extralite_ext')
+create_makefile('extralite_ext')

data/ext/extralite/extralite.c

@@ -51,6 +51,15 @@ static VALUE Database_allocate(VALUE klass) {
   } \
 }
 
+/* call-seq: sqlite3_version
+ *
+ * Returns the sqlite3 version used by Extralite.
+ */
+
+VALUE Extralite_sqlite3_version(VALUE self) {
+  return rb_str_new_cstr(sqlite3_version);
+}
+
 /* call-seq: initialize(path)
  *
  * Initializes a new SQLite database with the given path.
@@ -105,7 +114,7 @@ VALUE Database_closed_p(VALUE self) {
   return db->sqlite3_db ? Qfalse : Qtrue;
 }
 
-inline VALUE get_column_value(sqlite3_stmt *stmt, int col, int type) {
+static inline VALUE get_column_value(sqlite3_stmt *stmt, int col, int type) {
   switch (type) {
     case SQLITE_NULL:
       return Qnil;
@@ -116,7 +125,7 @@ inline VALUE get_column_value(sqlite3_stmt *stmt, int col, int type) {
     case SQLITE_TEXT:
       return rb_str_new_cstr((char *)sqlite3_column_text(stmt, col));
     case SQLITE_BLOB:
-      rb_raise(cError, "BLOB reading not yet implemented");
+      return rb_str_new((const char *)sqlite3_column_blob(stmt, col), (long)sqlite3_column_bytes(stmt, col));
     default:
       rb_raise(cError, "Unknown column type: %d", type);
   }
@@ -128,24 +137,24 @@ static void bind_parameter_value(sqlite3_stmt *stmt, int pos, VALUE value);
 
 static inline void bind_hash_parameter_values(sqlite3_stmt *stmt, VALUE hash) {
   VALUE keys = rb_funcall(hash, ID_KEYS, 0);
-  int len = RARRAY_LEN(keys);
-  for (int i = 0; i < len; i++) {
+  long len = RARRAY_LEN(keys);
+  for (long i = 0; i < len; i++) {
     VALUE k = RARRAY_AREF(keys, i);
     VALUE v = rb_hash_aref(hash, k);
 
     switch (TYPE(k)) {
       case T_FIXNUM:
         bind_parameter_value(stmt, NUM2INT(k), v);
-        return;
+        break;
       case T_SYMBOL:
         k = rb_funcall(k, ID_TO_S, 0);
       case T_STRING:
         if(RSTRING_PTR(k)[0] != ':') k = rb_str_plus(rb_str_new2(":"), k);
         int pos = sqlite3_bind_parameter_index(stmt, StringValuePtr(k));
         bind_parameter_value(stmt, pos, v);
-        return;
+        break;
       default:
-      rb_raise(cError, "Cannot bind hash key value idx %d", i);
+        rb_raise(cError, "Cannot bind hash key value idx %ld", i);
     }
   }
   RB_GC_GUARD(keys);
@@ -218,7 +227,7 @@ struct multi_stmt_ctx {
   sqlite3 *db;
   sqlite3_stmt **stmt;
   const char *str;
-  int len;
+  long len;
   int rc;
 };
 
@@ -256,7 +265,7 @@ statements. It will release the GVL while the statements are being prepared and
 executed. All statements excluding the last one are executed. The last statement
 is not executed, but instead handed back to the caller for looping over results.
 */
-inline void prepare_multi_stmt(sqlite3 *db, sqlite3_stmt **stmt, VALUE sql) {
+static inline void prepare_multi_stmt(sqlite3 *db, sqlite3_stmt **stmt, VALUE sql) {
   struct multi_stmt_ctx ctx = {db, stmt, RSTRING_PTR(sql), RSTRING_LEN(sql), 0};
   rb_thread_call_without_gvl(prepare_multi_stmt_without_gvl, (void *)&ctx, RUBY_UBF_IO, 0);
   RB_GC_GUARD(sql);
@@ -284,7 +293,7 @@ void *stmt_iterate_without_gvl(void *ptr) {
   return NULL;
 }
 
-inline int stmt_iterate(sqlite3_stmt *stmt, sqlite3 *db) {
+static inline int stmt_iterate(sqlite3_stmt *stmt, sqlite3 *db) {
   struct step_ctx ctx = {stmt, 0};
   rb_thread_call_without_gvl(stmt_iterate_without_gvl, (void *)&ctx, RUBY_UBF_IO, 0);
   switch (ctx.rc) {
@@ -658,6 +667,8 @@ VALUE Database_load_extension(VALUE self, VALUE path) {
 
 void Init_Extralite() {
   VALUE mExtralite = rb_define_module("Extralite");
+  rb_define_singleton_method(mExtralite, "sqlite3_version", Extralite_sqlite3_version, 0);
+
   VALUE cDatabase = rb_define_class_under(mExtralite, "Database", rb_cObject);
   rb_define_alloc_func(cDatabase, Database_allocate);