extralite 1.14 → 1.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 32105cda1ba5871c89609e42828a095d76d4cd2da29bd6d47beefc6a3ae93bd6
-  data.tar.gz: 4ff38c0e6144b22792e2a57792f295fc85a6b3d4b9eb09820e4f3b3e4c78bec1
+  metadata.gz: 0275df0298c578e4b166e392a43e7edcc4566d08eccdfe8c76ef0fd4e2a0c244
+  data.tar.gz: 312f5218786eaeaa879703c403ace437b351f76fe1fd5660d3d64fe6592f1c8a
 SHA512:
-  metadata.gz: c0e94553b7ca02732fe93729844ef16ce58bce7582be1e9c1684f215999b7a4a84414265c6a6932fbc379887940bd70d8ff913c782b0ce6b1ee0eebd9f4438a0
-  data.tar.gz: 14db1538d2aafb781375d636cdcb9a42e92a74ce11304a953930f7456c76895051f8a37e61cf5dfff7b8dc3c4e02694187fd0ad6a8204ca0d948ec1fe3b26479
+  metadata.gz: 8b2052fc2ca18c5d1e61c5ada2a094a1ef5e56053ab8434b8fbb55da35bd2633dcae0131b383caf0b7a9f2990a05205d8788a72ae98ce79b69854f8b517e4c6e
+  data.tar.gz: cff930e31e7f6d0050f2467c2661fa8369ba259bdaf9359154da1ba9ba5dc67ca3c6f327a34dbac73f0edf3d145962c2e973e12bee9c2f323a07612c5b984c03

data/.github/workflows/test.yml

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

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 1.15 2022-10-01
+
+- Add `Database#pragma` method
+- Add `Database#tables` method
+
 ## 1.14 2022-02-28
 
 - Introduce `extralite-bundle` gem for bundling SQLite, use system lib by

data/Gemfile.lock

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

data/README.md

@@ -38,6 +38,8 @@ latest features and enhancements.
 - A variety of methods for different data access patterns: rows as hashes, rows
   as arrays, single row, single column, single value.
 - Prepared statements.
+- Use system-installed sqlite3, or the [bundled latest version of
+  SQLite3](#installing-the-extralite-sqlite3-bundle).
 - Super fast - [up to 12.5x faster](#performance) than the
   [sqlite3](https://github.com/sparklemotion/sqlite3-ruby) gem (see also
   [comparison](#why-not-just-use-the-sqlite3-gem).)
@@ -63,7 +65,7 @@ gem 'extralite'
 
 You can also run `gem install extralite` if you just want to check it out.
 
-## Installing the Extralite-SQLite3 bundle
+### Installing the Extralite-SQLite3 bundle
 
 If you don't have sqlite3 installed on your system, do not want to use the
 system-installed version of SQLite3, or would like to use the latest version of
@@ -136,6 +138,14 @@ number_of_rows_affected = db.changes
 # get db filename
 db.filename #=> "/tmp/my.db"
 
+# get list of tables
+db.tables #=> ['foo', 'bar']
+
+# get and set pragmas
+db.pragma(:journal_mode) #=> 'delete'
+db.pragma(journal_mode: 'wal')
+db.pragma(:journal_mode) #=> 'wal'
+
 # load an extension
 db.load_extension('/path/to/extension.so')
 
@@ -175,7 +185,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|
+|SQLite3 dependency|depends on OS-installed libsqlite3|Use either system sqlite3 or [bundled latest version of SQLite3](#installing-the-extralite-sqlite3-bundle)|
 |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|

data/Rakefile

@@ -24,3 +24,23 @@ YARD::Rake::YardocTask.new do |t|
   t.files   = YARD_FILES
   t.options = %w(-o doc --readme README.md)
 end
+
+task :release do
+  require_relative './lib/extralite/version'
+  version = Extralite::VERSION
+  
+  puts 'Building extralite...'
+  `gem build extralite.gemspec`
+
+  puts 'Building extralite-bundle...'
+  `gem build extralite-bundle.gemspec`
+
+  puts "Pushing extralite #{version}..."
+  `gem push extralite-#{version}.gem`
+
+  puts "Pushing extralite-bundle #{version}..."
+  `gem push extralite-bundle-#{version}.gem`
+
+  puts "Cleaning up..."
+  `rm *.gem`
+end

data/ext/extralite/common.c

@@ -31,7 +31,7 @@ void bind_hash_parameter_values(sqlite3_stmt *stmt, VALUE hash) {
 
     switch (TYPE(k)) {
       case T_FIXNUM:
-        bind_parameter_value(stmt, NUM2INT(k), v);
+        bind_parameter_value(stmt, FIX2INT(k), v);
         break;
       case T_SYMBOL:
         k = rb_funcall(k, ID_TO_S, 0);
@@ -345,3 +345,7 @@ VALUE safe_query_single_value(query_ctx *ctx) {
   RB_GC_GUARD(value);
   return value;
 }
+
+VALUE safe_query_columns(query_ctx *ctx) {
+  return get_column_names(ctx->stmt, sqlite3_column_count(ctx->stmt));
+}

data/ext/extralite/database.c

@@ -263,6 +263,15 @@ VALUE Database_query_single_value(int argc, VALUE *argv, VALUE self) {
   return Database_perform_query(argc, argv, self, safe_query_single_value);
 }
 
+/* call-seq:
+ *   db.columns(sql) -> columns
+ *
+ * Returns the column names for the given query, without running it.
+ */
+VALUE Database_columns(VALUE self, VALUE sql) {
+  return Database_perform_query(1, &sql, self, safe_query_columns);
+}
+
 /* call-seq:
  *   db.last_insert_rowid -> int
  *
@@ -272,7 +281,7 @@ VALUE Database_last_insert_rowid(VALUE self) {
   Database_t *db;
   GetOpenDatabase(self, db);
 
-  return INT2NUM(sqlite3_last_insert_rowid(db->sqlite3_db));
+  return INT2FIX(sqlite3_last_insert_rowid(db->sqlite3_db));
 }
 
 /* call-seq:
@@ -284,7 +293,7 @@ VALUE Database_changes(VALUE self) {
   Database_t *db;
   GetOpenDatabase(self, db);
 
-  return INT2NUM(sqlite3_changes(db->sqlite3_db));
+  return INT2FIX(sqlite3_changes(db->sqlite3_db));
 }
 
 /* call-seq:
@@ -362,6 +371,7 @@ void Init_ExtraliteDatabase() {
   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);
+  rb_define_method(cDatabase, "columns", Database_columns, 1);
 
   rb_define_method(cDatabase, "last_insert_rowid", Database_last_insert_rowid, 0);
   rb_define_method(cDatabase, "changes", Database_changes, 0);

data/ext/extralite/extralite.h

@@ -53,6 +53,7 @@ VALUE safe_query_hash(query_ctx *ctx);
 VALUE safe_query_single_column(query_ctx *ctx);
 VALUE safe_query_single_row(query_ctx *ctx);
 VALUE safe_query_single_value(query_ctx *ctx);
+VALUE safe_query_columns(query_ctx *ctx);
 
 void prepare_single_stmt(sqlite3 *db, sqlite3_stmt **stmt, VALUE sql);
 void prepare_multi_stmt(sqlite3 *db, sqlite3_stmt **stmt, VALUE sql);

data/ext/extralite/prepared_statement.c

@@ -63,6 +63,9 @@ static inline VALUE PreparedStatement_perform_query(int argc, VALUE *argv, VALUE
   PreparedStatement_t *stmt;
   GetPreparedStatement(self, stmt);
 
+  if (!stmt->stmt)
+    rb_raise(cError, "Prepared statement is closed");
+
   sqlite3_reset(stmt->stmt);
   sqlite3_clear_bindings(stmt->stmt);
   bind_all_parameters(stmt->stmt, argc, argv);
@@ -218,6 +221,43 @@ VALUE PreparedStatement_sql(VALUE self) {
   return stmt->sql;
 }
 
+/* call-seq:
+ *   stmt.columns -> columns
+ *
+ * Returns the column names for the prepared statement without running it.
+ */
+VALUE PreparedStatement_columns(VALUE self) {
+  return PreparedStatement_perform_query(0, NULL, self, safe_query_columns);
+}
+
+/* call-seq:
+ *   stmt.close -> stmt
+ *
+ * Closes the prepared statement. Running a closed prepared statement will raise
+ * an error.
+ */
+VALUE PreparedStatement_close(VALUE self) {
+  PreparedStatement_t *stmt;
+  GetPreparedStatement(self, stmt);
+  if (stmt->stmt) {
+    sqlite3_finalize(stmt->stmt);
+    stmt->stmt = NULL;
+  }
+  return self;
+}
+
+/* call-seq:
+ *   stmt.closed? -> closed
+ *
+ * Returns true if the prepared statement is closed.
+ */
+VALUE PreparedStatement_closed_p(VALUE self) {
+  PreparedStatement_t *stmt;
+  GetPreparedStatement(self, stmt);
+
+  return stmt->stmt ? Qfalse : Qtrue;
+}
+
 void Init_ExtralitePreparedStatement() {
   VALUE mExtralite = rb_define_module("Extralite");
 
@@ -235,4 +275,9 @@ void Init_ExtralitePreparedStatement() {
   rb_define_method(cPreparedStatement, "query_single_row", PreparedStatement_query_single_row, -1);
   rb_define_method(cPreparedStatement, "query_single_column", PreparedStatement_query_single_column, -1);
   rb_define_method(cPreparedStatement, "query_single_value", PreparedStatement_query_single_value, -1);
+
+  rb_define_method(cPreparedStatement, "columns", PreparedStatement_columns, 0);
+
+  rb_define_method(cPreparedStatement, "close", PreparedStatement_close, 0);
+  rb_define_method(cPreparedStatement, "closed?", PreparedStatement_closed_p, 0);
 }

data/lib/extralite/version.rb

@@ -1,3 +1,3 @@
 module Extralite
-  VERSION = '1.14'
+  VERSION = '1.15'
 end

data/lib/extralite.rb

@@ -17,5 +17,29 @@ module Extralite
 
   # An SQLite database
   class Database
+    alias_method :execute, :query
+
+    TABLES_SQL = <<~SQL
+      SELECT name FROM sqlite_schema
+      WHERE type ='table'
+        AND name NOT LIKE 'sqlite_%';
+    SQL
+
+    def tables
+      query_single_column(TABLES_SQL)
+    end
+
+    def pragma(value)
+      value.is_a?(Hash) ? pragma_set(value) : pragma_get(value)
+    end
+
+    def pragma_set(values)
+      sql = values.inject(+'') { |s, (k, v)| s += "pragma #{k}=#{v}; " }
+      query(sql)
+    end
+
+    def pragma_get(key)
+      query_single_value("pragma #{key}")
+    end
   end
-end
+end

data/lib/sequel/adapters/extralite.rb

@@ -122,17 +122,17 @@ module Sequel
         
         connection_pragmas.each{|s| log_connection_yield(s, db){db.query(s)}}
         
-        # class << db
-        #   attr_reader :prepared_statements
-        # end
-        # db.instance_variable_set(:@prepared_statements, {})
+        class << db
+          attr_reader :prepared_statements
+        end
+        db.instance_variable_set(:@prepared_statements, {})
         
         db
       end
 
       # Disconnect given connections from the database.
       def disconnect_connection(c)
-        # c.prepared_statements.each_value{|v| v.first.close}
+        c.prepared_statements.each_value{|v| v.first.close }
         c.close
       end
       
@@ -149,13 +149,13 @@ module Sequel
       # Drop any prepared statements on the connection when executing DDL.  This is because
       # prepared statements lock the table in such a way that you can't drop or alter the
       # table while a prepared statement that references it still exists.
-      # def execute_ddl(sql, opts=OPTS)
-      #   synchronize(opts[:server]) do |conn|
-      #     conn.prepared_statements.values.each{|cps, s| cps.close}
-      #     conn.prepared_statements.clear
-      #     super
-      #   end
-      # end
+      def execute_ddl(sql, opts=OPTS)
+        synchronize(opts[:server]) do |conn|
+          conn.prepared_statements.values.each{|cps, s| cps.close}
+          conn.prepared_statements.clear
+          super
+        end
+      end
       
       def execute_insert(sql, opts=OPTS)
         _execute(:insert, sql, opts)
@@ -193,7 +193,7 @@ module Sequel
       def _execute(type, sql, opts, &block)
         begin
           synchronize(opts[:server]) do |conn|
-            # return execute_prepared_statement(conn, type, sql, opts, &block) if sql.is_a?(Symbol)
+            return execute_prepared_statement(conn, type, sql, opts, &block) if sql.is_a?(Symbol)
             log_args = opts[:arguments]
             args = {}
             opts.fetch(:arguments, OPTS).each{|k, v| args[k] = prepared_statement_argument(v) }

data/test/test_database.rb

@@ -68,6 +68,11 @@ end
     assert_nil r
   end
 
+  def test_columns
+    r = @db.columns('select x, z from t')
+    assert_equal [:x, :z], r
+  end
+
   def test_transaction_active?
     assert_equal false, @db.transaction_active?
     @db.query('begin')
@@ -177,6 +182,31 @@ end
     r = @db.query_single_value("select reverse('abcd')")
     assert_equal 'dcba', r
   end
+
+  def test_tables
+    assert_equal ['t'], @db.tables
+
+    @db.query('create table foo (bar text)')
+    assert_equal ['t', 'foo'], @db.tables
+
+    @db.query('drop table t')
+    assert_equal ['foo'], @db.tables
+
+    @db.query('drop table foo')
+    assert_equal [], @db.tables
+  end
+
+  def test_pragma
+    assert_equal 'memory', @db.pragma('journal_mode')
+    assert_equal 2, @db.pragma('synchronous')
+
+    assert_equal 1, @db.pragma(:schema_version)
+    assert_equal 0, @db.pragma(:recursive_triggers)
+
+    assert_equal [], @db.pragma(schema_version: 33, recursive_triggers: 1)
+    assert_equal 33, @db.pragma(:schema_version)
+    assert_equal 1, @db.pragma(:recursive_triggers)
+  end
 end
 
 class ScenarioTest < MiniTest::Test

data/test/test_extralite.rb

@@ -4,10 +4,6 @@ require_relative 'helper'
 
 class ExtraliteTest < MiniTest::Test
   def test_sqlite3_version
-    reported = `sqlite3 --version` rescue ''
-    match = reported.match(/^([\d\.]+)/)
-    if match
-      assert_equal match[1], Extralite.sqlite3_version
-    end
+    assert_match /^3\.\d+\.\d+$/, Extralite.sqlite3_version
   end
 end

data/test/test_prepared_statement.rb

@@ -162,4 +162,23 @@ end
     r = @db.prepare('select null').query_single_value
     assert_nil r
   end
+
+  def test_prepared_statement_columns
+    r = @db.prepare("select 'abc' as a, 'def' as b").columns
+    assert_equal [:a, :b], r
+  end
+
+  def test_prepared_statement_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 { p.query_single_value }
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: extralite
 version: !ruby/object:Gem::Version
-  version: '1.14'
+  version: '1.15'
 platform: ruby
 authors:
 - Sharon Rosner
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-02-28 00:00:00.000000000 Z
+date: 2022-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake-compiler
@@ -80,7 +80,7 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 5.51.0
-description:
+description: 
 email: sharon@noteflakes.com
 executables: []
 extensions:
@@ -134,7 +134,7 @@ metadata:
   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:
+post_install_message: 
 rdoc_options:
 - "--title"
 - extralite
@@ -153,8 +153,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
-signing_key:
+rubygems_version: 3.3.7
+signing_key: 
 specification_version: 4
 summary: Extra-lightweight SQLite3 wrapper for Ruby
 test_files: []