extralite 1.27 → 2.1

data/test/test_query.rb

@@ -0,0 +1,519 @@
+# frozen_string_literal: true
+
+require_relative 'helper'
+
+class QueryTest < MiniTest::Test
+  def setup
+    @db = Extralite::Database.new(':memory:')
+    @db.query('create table if not exists t (x,y,z)')
+    @db.query('delete from t')
+    @db.query('insert into t values (1, 2, 3)')
+    @db.query('insert into t values (4, 5, 6)')
+    @db.query('insert into t values (7, 8, 9)')
+
+    @query = @db.prepare('select * from t where x = ?')
+  end
+
+  def test_prepare
+    query = @db.prepare('select 1')
+    assert_equal 1, query.next_single_column
+
+    query = @db.prepare('select x from t where y = ?', 5)
+    assert_equal 4, query.next_single_column
+  end
+
+  def test_query_props
+    assert_kind_of Extralite::Query, @query
+    assert_equal @db, @query.database
+    assert_equal @db, @query.db
+    assert_equal 'select * from t where x = ?', @query.sql
+  end
+
+  def test_bind
+    @db.query("insert into t values ('a', 'b', 'c')")
+
+    q = @db.prepare('select * from t where `z` = :foo')
+    results = q.bind(foo: 'c').to_a_ary
+
+    assert_equal [['a', 'b', 'c']], results
+  end
+
+  def test_query_next
+    query = @db.prepare('select * from t')
+    v = query.next
+    assert_equal({ x: 1, y: 2, z: 3}, v)
+
+    v = query.next
+    assert_equal({ x: 4, y: 5, z: 6}, v)
+
+    v = query.next
+    assert_equal({ x: 7, y: 8, z: 9}, v)
+
+    v = query.next
+    assert_nil v
+
+    # EOF should repeat
+    v = query.next
+    assert_nil v
+
+    query = @db.prepare('select * from t')
+    v = query.next_hash
+    assert_equal({ x: 1, y: 2, z: 3}, v)
+
+    v = query.next_hash
+    assert_equal({ x: 4, y: 5, z: 6}, v)
+
+    v = query.next_hash
+    assert_equal({ x: 7, y: 8, z: 9}, v)
+
+    v = query.next_hash
+    assert_nil v
+  end
+
+  def test_query_next_with_row_count
+    query = @db.prepare('select * from t')
+    v = query.next(1)
+    assert_equal([{ x: 1, y: 2, z: 3}], v)
+
+    v = query.next(2)
+    assert_equal([{ x: 4, y: 5, z: 6}, { x: 7, y: 8, z: 9}], v)
+
+    v = query.next
+    assert_nil v
+
+    query = @db.prepare('select * from t')
+    v = query.next(-1)
+    assert_equal([{ x: 1, y: 2, z: 3}, { x: 4, y: 5, z: 6}, { x: 7, y: 8, z: 9}], v)
+  end
+
+  def test_query_next_with_block
+    query = @db.prepare('select * from t')
+    buf = []
+    v = query.next { |r| buf << r }
+    assert_equal query, v
+    assert_equal [{x: 1, y: 2, z: 3}], buf
+
+    buf = []
+    v = query.next(2) { |r| buf << r }
+    assert_equal query, v
+    assert_equal [{ x: 4, y: 5, z: 6}, { x: 7, y: 8, z: 9}], buf
+
+    buf = []
+    v = query.next(2) { |r| buf << r }
+    assert_equal query, v
+    assert_equal [], buf
+
+    buf = []
+    v = query.next(2) { |r| buf << r }
+    assert_equal query, v
+    assert_equal [], buf
+  end
+
+  def test_query_next_with_block_with_break
+    query = @db.prepare('select * from t')
+    buf = []
+    v = query.next(-1) { |r| buf << r; break }
+    assert_nil v
+    assert_equal [{x: 1, y: 2, z: 3}], buf
+
+    buf = []
+    v = query.next(-1) { |r| buf << r }
+    assert_equal query, v
+    assert_equal [{x: 4, y: 5, z: 6}, {x: 7, y: 8, z: 9}], buf
+
+    buf = []
+    v = query.next(2) { |r| buf << r }
+    assert_equal query, v
+    assert_equal [], buf
+  end
+
+  def test_query_next_ary
+    query = @db.prepare('select * from t')
+    v = query.next_ary
+    assert_equal([1, 2, 3], v)
+
+    v = query.next_ary
+    assert_equal([4, 5, 6], v)
+
+    v = query.next_ary
+    assert_equal([7, 8, 9], v)
+
+    v = query.next_ary
+    assert_nil v
+
+    v = query.next_ary
+    assert_nil v
+  end
+
+  def test_query_next_ary_with_row_count
+    query = @db.prepare('select * from t')
+    v = query.next_ary(1)
+    assert_equal([[1, 2, 3]], v)
+
+    v = query.next_ary(2)
+    assert_equal([[4, 5, 6], [7, 8, 9]], v)
+
+    v = query.next_ary(2)
+    assert_equal([], v)
+
+    v = query.next_ary(2)
+    assert_nil v
+  end
+
+  def test_query_next_ary_with_block
+    query = @db.prepare('select * from t')
+    buf = []
+    v = query.next_ary { |r| buf << r }
+    assert_equal query, v
+    assert_equal [[1, 2, 3]], buf
+
+    buf = []
+    v = query.next_ary(2) { |r| buf << r }
+    assert_equal query, v
+    assert_equal [[4, 5, 6], [7, 8, 9]], buf
+
+    buf = []
+    v = query.next_ary(2) { |r| buf << r }
+    assert_equal query, v
+    assert_equal [], buf
+  end
+
+  def test_query_next_single_column
+    query = @db.prepare('select x from t')
+    v = query.next_single_column
+    assert_equal(1, v)
+
+    v = query.next_single_column
+    assert_equal(4, v)
+
+    v = query.next_single_column
+    assert_equal(7, v)
+
+    v = query.next_single_column
+    assert_nil v
+  end
+
+  def test_query_next_single_column_with_row_count
+    query = @db.prepare('select x from t')
+    v = query.next_single_column(1)
+    assert_equal([1], v)
+
+    v = query.next_single_column(3)
+    assert_equal([4, 7], v)
+
+    v = query.next_single_column(2)
+    assert_nil v
+  end
+
+  def test_query_next_single_column_with_block
+    query = @db.prepare('select x from t')
+    buf = []
+    v = query.next_single_column { |r| buf << r }
+    assert_equal query, v
+    assert_equal [1], buf
+
+    buf = []
+    v = query.next_single_column(2) { |r| buf << r }
+    assert_equal query, v
+    assert_equal [4, 7], buf
+
+    buf = []
+    v = query.next_single_column(2) { |r| buf << r }
+    assert_equal query, v
+    assert_equal [], buf
+  end
+
+  def test_query_to_a
+    assert_equal [{ x: 1, y: 2, z: 3 }], @query.bind(1).to_a
+    assert_equal [{ x: 4, y: 5, z: 6 }], @query.bind(4).to_a
+
+    assert_equal [{ x: 1, y: 2, z: 3 }], @query.bind(1).to_a_hash
+    assert_equal [{ x: 4, y: 5, z: 6 }], @query.bind(4).to_a_hash
+
+    assert_equal [[1, 2, 3]], @query.bind(1).to_a_ary
+    assert_equal [[4, 5, 6]], @query.bind(4).to_a_ary
+
+    query = @db.prepare('select y from t')
+    assert_equal [2, 5, 8], query.to_a_single_column
+  end
+
+  def test_query_each
+    buf = []
+    @query.bind(1).each { |r| buf << r }
+    assert_equal [{x: 1, y: 2, z: 3}], buf
+
+    # each should reset the stmt
+    buf = []
+    @query.each { |r| buf << r }
+    assert_equal [{x: 1, y: 2, z: 3}], buf
+
+    query = @db.prepare('select * from t')
+    buf = []
+    query.each { |r| buf << r }
+    assert_equal [{x: 1, y: 2, z: 3},{ x: 4, y: 5, z: 6 }, { x: 7, y: 8, z: 9 }], buf
+  end
+
+  def test_query_each_with_break
+    query = @db.prepare('select * from t')
+
+    buf = []
+    query.each { |r| buf << r; break }
+    assert_equal [{x: 1, y: 2, z: 3}], buf
+
+    # each should reset the stmt
+    buf = []
+    query.each { |r| buf << r }
+    assert_equal [{x: 1, y: 2, z: 3},{ x: 4, y: 5, z: 6 }, { x: 7, y: 8, z: 9 }], buf
+  end
+
+  def test_query_each_without_block
+    query = @db.prepare('select * from t') 
+    iter = query.each
+    assert_kind_of Extralite::Iterator, iter
+
+    buf = []
+    v = iter.each { |r| buf << r }
+    assert_equal iter, v
+    assert_equal [{x: 1, y: 2, z: 3},{ x: 4, y: 5, z: 6 }, { x: 7, y: 8, z: 9 }], buf
+  end
+
+  def test_query_each_ary
+    buf = []
+    @query.bind(1).each_ary { |r| buf << r }
+    assert_equal [[1, 2, 3]], buf
+
+    # each should reset the stmt
+    buf = []
+    @query.each_ary { |r| buf << r }
+    assert_equal [[1, 2, 3]], buf
+
+    query = @db.prepare('select * from t')
+    buf = []
+    query.each_ary { |r| buf << r }
+    assert_equal [[1, 2, 3], [4, 5, 6], [7, 8, 9]], buf
+  end
+
+  def test_query_each_ary_without_block
+    query = @db.prepare('select * from t') 
+    iter = query.each_ary
+    assert_kind_of Extralite::Iterator, iter
+
+    buf = []
+    v = iter.each { |r| buf << r }
+    assert_equal iter, v
+    assert_equal [[1, 2, 3], [4, 5, 6], [7, 8, 9]], buf
+  end
+
+  def test_query_each_single_column
+    query = @db.prepare('select x from t where x = ?')
+    buf = []
+    query.bind(1).each_single_column { |r| buf << r }
+    assert_equal [1], buf
+
+    # each should reset the stmt
+    buf = []
+    query.each_single_column { |r| buf << r }
+    assert_equal [1], buf
+
+    query = @db.prepare('select x from t')
+    buf = []
+    query.each_single_column { |r| buf << r }
+    assert_equal [1, 4, 7], buf
+  end
+
+  def test_query_each_single_column_without_block
+    query = @db.prepare('select x from t') 
+    iter = query.each_single_column
+    assert_kind_of Extralite::Iterator, iter
+
+    buf = []
+    v = iter.each { |r| buf << r }
+    assert_equal iter, v
+    assert_equal [1, 4, 7], buf
+  end
+
+  def test_query_with_invalid_sql
+    assert_raises(Extralite::SQLError) { @db.prepare('blah').to_a }
+  end
+
+  def test_query_with_multiple_queries
+    assert_raises(Extralite::Error) { @db.prepare('select 1; select 2').to_a }
+  end
+
+  def test_query_multiple_statements
+    assert_raises(Extralite::Error) {
+      @db.prepare("insert into t values ('a', 'b', 'c'); insert into t values ('d', 'e', 'f');").to_a
+    }
+  end
+
+  def test_query_multiple_statements_with_bad_sql
+    error = nil
+    begin
+      query =@db.prepare("insert into t values foo; insert into t values ('d', 'e', 'f');")
+      query.next
+    rescue => error
+    end
+
+    assert_kind_of Extralite::SQLError, error
+    assert_equal 'near "foo": syntax error', error.message
+  end
+
+  def test_query_repeated_execution_missing_param
+    assert_nil @query.next
+
+    @query.bind(4)
+    assert_equal({x: 4, y: 5, z: 6}, @query.next)
+  end
+
+  def test_query_empty_sql
+    assert_raises(Extralite::Error) { @db.prepare(' ') }
+
+    r = @db.prepare('select 1 as foo;  ').next
+    assert_equal({ foo: 1 }, r)
+  end
+
+  def test_query_parameter_binding_simple
+    r = @db.prepare('select x, y, z from t where x = ?').bind(1).next
+    assert_equal({ x: 1, y: 2, z: 3 }, r)
+  end
+
+  def test_query_parameter_binding_with_index
+    r = @db.prepare('select x, y, z from t where x = ?2').bind(0, 1).next
+    assert_equal({ x: 1, y: 2, z: 3 }, r)
+
+    r = @db.prepare('select x, y, z from t where z = ?3').bind(3, 4, 6).next
+    assert_equal({ x: 4, y: 5, z: 6 }, r)
+  end
+
+  def test_query_parameter_binding_with_name
+    r = @db.prepare('select x, y, z from t where x = :x').bind(x: 1, y: 2).next
+    assert_equal({ x: 1, y: 2, z: 3 }, r)
+
+    r = @db.prepare('select x, y, z from t where z = :zzz').bind('zzz' => 6).next
+    assert_equal({ x: 4, y: 5, z: 6 }, r)
+
+    r = @db.prepare('select x, y, z from t where z = :bazzz').bind(':bazzz' => 6).next
+    assert_equal({ x: 4, y: 5, z: 6 }, r)
+  end
+
+  def test_query_parameter_binding_with_index_key
+    r = @db.prepare('select x, y, z from t where z = ?').bind(1 => 3).next
+    assert_equal({ x: 1, y: 2, z: 3 }, r)
+
+    r = @db.prepare('select x, y, z from t where x = ?2').bind(1 => 42, 2 => 4).next
+    assert_equal({ x: 4, y: 5, z: 6 }, r)
+  end
+
+  def test_query_columns
+    r = @db.prepare("select 'abc' as a, 'def' as b").columns
+    assert_equal [:a, :b], r
+  end
+
+  def test_query_columns_with_parameterized_sql
+    q = @db.prepare('select * from t where z = :z')
+    q.bind(z: 9)
+    assert_equal [:x, :y, :z], q.columns
+    assert_equal [[7, 8, 9]], q.to_a_ary
+  end
+
+  def test_query_close
+    p = @db.prepare("select 'abc'")
+
+    assert_equal false, p.closed?
+
+    p.close
+    assert_equal true, p.closed?
+
+    p.close
+    assert_equal true, p.closed?
+
+    assert_raises(Extralite::Error) { p.next }
+  end
+
+  def test_query_execute
+    q = @db.prepare('update t set x = 42')
+    assert_equal 3, q.execute
+    assert_equal [[42, 2, 3], [42, 5, 6], [42, 8, 9]], @db.query_ary('select * from t order by z')
+  end
+
+  def test_query_execute_with_params
+    q = @db.prepare('update t set x = ? where z = ?')
+    assert_equal 1, q.execute(42, 9)
+    assert_equal [[1, 2, 3], [4, 5, 6], [42, 8, 9]], @db.query_ary('select * from t order by z')
+  end
+
+  def test_query_execute_multi
+    @db.query('create table foo (a, b, c)')
+    assert_equal [], @db.query('select * from foo')
+
+    records = [
+      [1, '2', 3],
+      ['4', 5, 6]
+    ]
+
+    p = @db.prepare('insert into foo values (?, ?, ?)')
+    changes = p.execute_multi(records)
+
+    assert_equal 2, changes
+    assert_equal [
+      { a: 1, b: '2', c: 3 },
+      { a: '4', b: 5, c: 6 }
+    ], @db.query('select * from foo')
+  end  
+
+  def test_query_status
+    assert_equal 0, @query.status(Extralite::SQLITE_STMTSTATUS_RUN)
+    @query.to_a
+    assert_equal 1, @query.status(Extralite::SQLITE_STMTSTATUS_RUN)
+    @query.to_a
+    assert_equal 2, @query.status(Extralite::SQLITE_STMTSTATUS_RUN)
+    @query.to_a
+    assert_equal 3, @query.status(Extralite::SQLITE_STMTSTATUS_RUN, true)
+    assert_equal 0, @query.status(Extralite::SQLITE_STMTSTATUS_RUN)
+  end
+
+  def test_query_status_after_close
+    assert_equal 0, @query.status(Extralite::SQLITE_STMTSTATUS_RUN)
+    @query.to_a
+    assert_equal 1, @query.status(Extralite::SQLITE_STMTSTATUS_RUN)
+    @query.close
+    assert_raises(Extralite::Error) { @query.status(Extralite::SQLITE_STMTSTATUS_RUN) }
+  end
+
+  def test_query_after_db_close
+    assert_equal [{ x: 4, y: 5, z: 6}], @query.bind(4).to_a
+    @db.close
+    assert_equal [{ x: 4, y: 5, z: 6}], @query.bind(4).to_a
+  end
+
+  def test_query_eof
+    query = @db.prepare('select x from t')
+    assert_equal false, query.eof?
+
+    query.next
+    assert_equal false, query.eof?
+
+    query.next(2)
+    assert_equal false, query.eof?
+
+    query.next
+    assert_equal true, query.eof?
+
+    query.next
+    assert_equal true, query.eof?
+
+    query.reset
+    assert_equal false, query.eof?
+
+    query.next
+    assert_equal false, query.eof?
+
+    assert_equal [1, 4, 7], query.to_a_single_column
+    assert_equal true, query.eof?
+  end
+
+  def test_query_inspect
+    q = @db.prepare('select x from t')
+    assert_match /^\#\<Extralite::Query:0x[0-9a-f]+ #{q.sql.inspect}\>$/, q.inspect
+  end
+end

data/test/test_sequel.rb

@@ -34,13 +34,32 @@ class SequelExtraliteTest < MiniTest::Test
     prepared_query = items.where(name: :$name).prepare(:select, :select_by_name)
     prepared_insert = items.prepare(:insert, :insert_with_name_and_price, name: :$name, price: :$price)
 
-    assert_equal prepared_query.call(name: 'def'), [{ id: 2, name: 'def', price: 456 }]
-    assert_equal @db.call(:select_by_name, name: 'def'), [{ id: 2, name: 'def', price: 456 }]
+    assert_equal [{ id: 2, name: 'def', price: 456 }], prepared_query.call(name: 'def')
+    assert_equal [{ id: 2, name: 'def', price: 456 }], @db.call(:select_by_name, name: 'def')
 
     id = prepared_insert.call(name: 'jkl', price: 444)
-    assert_equal items[id: id], { id: id, name: 'jkl', price: 444 }
+    assert_equal({ id: id, name: 'jkl', price: 444 }, items[id: id])
 
     id = @db.call(:insert_with_name_and_price, name: 'mno', price: 555)
-    assert_equal items[id: id], { id: id, name: 'mno', price: 555 }
+    assert_equal({ id: id, name: 'mno', price: 555 }, items[id: id])
+  end
+
+  def test_migration
+    # Adapted from https://github.com/digital-fabric/extralite/issues/8
+    Dir.mktmpdir("extralite-migration") do |dir|
+      File.write(dir + "/001_migrate.rb", <<~RUBY)
+        Sequel.migration do 
+          change do
+            create_table(:foobars) { primary_key :id } 
+          end
+        end
+      RUBY
+    
+      Sequel.extension :migration
+      db = Sequel.connect("extralite://")
+      Sequel::Migrator.run(db, dir)
+
+      assert_equal [:id], db[:foobars].columns
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: extralite
 version: !ruby/object:Gem::Version
-  version: '1.27'
+  version: '2.1'
 platform: ruby
 authors:
 - Sharon Rosner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-06-12 00:00:00.000000000 Z
+date: 2023-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake-compiler
@@ -107,7 +107,8 @@ files:
 - ext/extralite/extralite.h
 - ext/extralite/extralite_ext.c
 - ext/extralite/extralite_sqlite3.c
-- ext/extralite/prepared_statement.c
+- ext/extralite/iterator.c
+- ext/extralite/query.c
 - extralite-bundle.gemspec
 - extralite.gemspec
 - gemspec.rb
@@ -124,7 +125,8 @@ files:
 - test/run.rb
 - test/test_database.rb
 - test/test_extralite.rb
-- test/test_prepared_statement.rb
+- test/test_iterator.rb
+- test/test_query.rb
 - test/test_sequel.rb
 homepage: https://github.com/digital-fabric/extralite
 licenses: