extralite 1.8.1 → 1.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 149ddf21bc7feaf4d7c3a19011ac9a515fe83d5f57b88c507783bee8c6d5e096
-  data.tar.gz: 55507a0acbd8efeb89d5dfcf652441081285a670a5968a96f2696d3073844975
+  metadata.gz: d88bd81eca07e148be1f8d5b07d24c0aab49b32a9dc9aeb4a9ea5a74cf769491
+  data.tar.gz: 9f5d55a8cd4a58e2026ca3e850d48c28d86878e191e91fb92e59c76335a64484
 SHA512:
-  metadata.gz: c7cdc5d0179c26c3deddc8439e4aaa5f91429ed3839cffc2224fefd8e90c78f0db9c4768f9534b693638572ec5e99ab0317a948f037c654262eca6d801a438f9
-  data.tar.gz: 4ae156e6850e5485b31b1f701597c0692608b59facd1473ca064d0b23ca8b5d2d84995f4fe4c99800b3e01815fb32e21481290e369506e5d2c4e9794af8fe853
+  metadata.gz: cca614a4e3ffde8ff56ef3e8394f85f4a57d37f8615f2f144a9a39f84d50e51dd015348da7f93340326b40ff4b16202ec21bc03f23edacf678c03f57d0955974
+  data.tar.gz: 2e9f9c9091ac99fa96c3562fdb1e49642b2961ee682c30d98f8babd95b8366d9c96019df7185c5ef493b330f6c32066be6868398dcdb123c4607e9ab4875462b

data/.github/FUNDING.yml

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

data/.github/workflows/test.yml

@@ -7,7 +7,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        os: [ubuntu-latest]
+        os: [ubuntu-latest, macos-10.15]
         ruby: [2.6, 2.7, '3.0']
 
     name: >-

data/CHANGELOG.md

@@ -1,4 +1,16 @@
-## 1.8 2021-12-15
+## 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,7 +1,7 @@
 PATH
   remote: .
   specs:
-    extralite (1.8)
+    extralite (1.11)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,14 +1,31 @@
-# 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
 
@@ -127,7 +144,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 +157,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/extralite.c

@@ -105,7 +105,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 +116,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 +128,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 +218,7 @@ struct multi_stmt_ctx {
   sqlite3 *db;
   sqlite3_stmt **stmt;
   const char *str;
-  int len;
+  long len;
   int rc;
 };
 
@@ -256,7 +256,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 +284,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) {

data/extralite.gemspec

@@ -11,6 +11,7 @@ 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://www.rubydoc.info/gems/extralite",
     "homepage_uri" => "https://github.com/digital-fabric/extralite",
     "changelog_uri" => "https://github.com/digital-fabric/extralite/blob/master/CHANGELOG.md"
   }

data/lib/extralite/version.rb

@@ -1,3 +1,3 @@
 module Extralite
-  VERSION = '1.8.1'
+  VERSION = '1.11'
 end

data/test/perf_ary.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require 'bundler/inline'
+
+gemfile do
+  source 'https://rubygems.org'
+  gem 'sqlite3'
+  gem 'extralite', path: '..'
+  gem 'benchmark-ips'
+end
+
+require 'benchmark/ips'
+require 'fileutils'
+
+DB_PATH = '/tmp/extralite_sqlite3_perf.db'
+
+def prepare_database(count)
+  FileUtils.rm(DB_PATH) rescue nil
+  db = Extralite::Database.new(DB_PATH)
+  db.query('create table foo ( a integer primary key, b text )')
+  db.query('begin')
+  count.times { db.query('insert into foo (b) values (?)', "hello#{rand(1000)}" )}
+  db.query('commit')
+end
+
+def sqlite3_run(count)
+  db = SQLite3::Database.new(DB_PATH)
+  results = db.execute('select * from foo')
+  raise unless results.size == count
+end
+
+def extralite_run(count)
+  db = Extralite::Database.new(DB_PATH)
+  results = db.query_ary('select * from foo')
+  raise unless results.size == count
+end
+
+[10, 1000, 100000].each do |c|
+  puts; puts; puts "Record count: #{c}"
+
+  prepare_database(c)
+
+  Benchmark.ips do |x|
+    x.config(:time => 3, :warmup => 1)
+
+    x.report("sqlite3") { sqlite3_run(c) }
+    x.report("extralite") { extralite_run(c) }
+
+    x.compare!
+  end
+end

data/test/test_database.rb

@@ -138,6 +138,31 @@ end
     r = @db.query('select x, y, z from t where z = :bazzz', ':bazzz' => 6)
     assert_equal [{ x: 4, y: 5, z: 6 }], r
   end
+
+  def test_parameter_binding_with_index_key
+    r = @db.query('select x, y, z from t where z = ?', 1 => 3)
+    assert_equal [{ x: 1, y: 2, z: 3 }], r
+
+    r = @db.query('select x, y, z from t where x = ?2', 1 => 42, 2 => 4)
+    assert_equal [{ x: 4, y: 5, z: 6 }], r
+  end
+
+  def test_value_casting
+    r = @db.query_single_value("select 'abc'")
+    assert_equal 'abc', r
+
+    r = @db.query_single_value('select 123')
+    assert_equal 123, r
+
+    r = @db.query_single_value('select 12.34')
+    assert_equal 12.34, r
+
+    r = @db.query_single_value('select zeroblob(4)')
+    assert_equal "\x00\x00\x00\x00", r
+
+    r = @db.query_single_value('select null')
+    assert_nil r
+  end
 end
 
 class ScenarioTest < MiniTest::Test

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: extralite
 version: !ruby/object:Gem::Version
-  version: 1.8.1
+  version: '1.11'
 platform: ruby
 authors:
 - Sharon Rosner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-12-15 00:00:00.000000000 Z
+date: 2021-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake-compiler
@@ -88,6 +88,7 @@ extensions:
 extra_rdoc_files:
 - README.md
 files:
+- ".github/FUNDING.yml"
 - ".github/workflows/test.yml"
 - ".gitignore"
 - CHANGELOG.md
@@ -105,7 +106,8 @@ files:
 - lib/extralite/version.rb
 - lib/sequel/adapters/extralite.rb
 - test/helper.rb
-- test/perf.rb
+- test/perf_ary.rb
+- test/perf_hash.rb
 - test/run.rb
 - test/test_database.rb
 - test/test_sequel.rb
@@ -114,6 +116,7 @@ licenses:
 - MIT
 metadata:
   source_code_uri: https://github.com/digital-fabric/extralite
+  documentation_uri: https://www.rubydoc.info/gems/extralite
   homepage_uri: https://github.com/digital-fabric/extralite
   changelog_uri: https://github.com/digital-fabric/extralite/blob/master/CHANGELOG.md
 post_install_message: