sqlite3 1.4.2 → 1.5.4

data/README.md

@@ -0,0 +1,235 @@
+# Ruby Interface for SQLite3
+
+* Source code: https://github.com/sparklemotion/sqlite3-ruby
+* Mailing list: http://groups.google.com/group/sqlite3-ruby
+* Download: http://rubygems.org/gems/sqlite3
+* Documentation: http://www.rubydoc.info/gems/sqlite3
+
+[![Unit tests](https://github.com/sparklemotion/sqlite3-ruby/actions/workflows/sqlite3-ruby.yml/badge.svg)](https://github.com/sparklemotion/sqlite3-ruby/actions/workflows/sqlite3-ruby.yml)
+[![Native packages](https://github.com/sparklemotion/sqlite3-ruby/actions/workflows/gem-install.yml/badge.svg)](https://github.com/sparklemotion/sqlite3-ruby/actions/workflows/gem-install.yml)
+
+
+## Description
+
+This library allows Ruby programs to use the SQLite3 database engine (http://www.sqlite.org).
+
+Note that this module is only compatible with SQLite 3.6.16 or newer.
+
+
+## Synopsis
+
+``` ruby
+require "sqlite3"
+
+# Open a database
+db = SQLite3::Database.new "test.db"
+
+# Create a table
+rows = db.execute <<-SQL
+  create table numbers (
+    name varchar(30),
+    val int
+  );
+SQL
+
+# Execute a few inserts
+{
+  "one" => 1,
+  "two" => 2,
+}.each do |pair|
+  db.execute "insert into numbers values ( ?, ? )", pair
+end
+
+# Find a few rows
+db.execute( "select * from numbers" ) do |row|
+  p row
+end
+# => ["one", 1]
+#    ["two", 2]
+
+# Create another table with multiple columns
+db.execute <<-SQL
+  create table students (
+    name varchar(50),
+    email varchar(50),
+    grade varchar(5),
+    blog varchar(50)
+  );
+SQL
+
+# Execute inserts with parameter markers
+db.execute("INSERT INTO students (name, email, grade, blog)
+            VALUES (?, ?, ?, ?)", ["Jane", "me@janedoe.com", "A", "http://blog.janedoe.com"])
+
+db.execute( "select * from students" ) do |row|
+  p row
+end
+# => ["Jane", "me@janedoe.com", "A", "http://blog.janedoe.com"]
+```
+
+## Installation
+
+### Native Gems (recommended)
+
+As of v1.5.0 of this library, native (precompiled) gems are available for Ruby 2.6, 2.7, 3.0, and 3.1 on all these platforms:
+
+- `aarch64-linux`
+- `arm-linux`
+- `arm64-darwin`
+- `x64-mingw32` / `x64-mingw-ucrt`
+- `x86-linux`
+- `x86_64-darwin`
+- `x86_64-linux`
+
+If you are using one of these Ruby versions on one of these platforms, the native gem is the recommended way to install sqlite3-ruby.
+
+For example, on a linux system running Ruby 3.1:
+
+``` text
+$ ruby -v
+ruby 3.1.2p20 (2022-04-12 revision 4491bb740a) [x86_64-linux]
+
+$ time gem install sqlite3
+Fetching sqlite3-1.5.0-x86_64-linux.gem
+Successfully installed sqlite3-1.5.0-x86_64-linux
+1 gem installed
+
+real    0m4.274s
+user    0m0.734s
+sys     0m0.165s
+```
+
+#### Avoiding the precompiled native gem
+
+The maintainers strongly urge you to use a native gem if at all possible. It will be a better experience for you and allow us to focus our efforts on improving functionality rather than diagnosing installation issues.
+
+If you're on a platform that supports a native gem but you want to avoid using it in your project, do one of the following:
+
+- If you're not using Bundler, then run `gem install sqlite3 --platform=ruby`
+- If you are using Bundler
+  - version 2.3.18 or later, you can specify [`gem "sqlite3", force_ruby_platform: true`](https://bundler.io/v2.3/man/gemfile.5.html#FORCE_RUBY_PLATFORM)
+  - version 2.1 or later, then you'll need to run `bundle config set force_ruby_platform true`
+  - version 2.0 or earlier, then you'll need to run `bundle config force_ruby_platform true`
+
+
+### Compiling the source gem
+
+If you are on a platform or version of Ruby that is not covered by the Native Gems, then the vanilla "ruby platform" (non-native) gem will be installed by the `gem install` or `bundle` commands.
+
+
+#### Packaged libsqlite3
+
+By default, as of v1.5.0 of this library, the latest available version of libsqlite3 is packaged with the gem and will be compiled and used automatically. This takes a bit longer than the native gem, but will provide a modern, well-supported version of libsqlite3.
+
+For example, on a linux system running Ruby 2.5:
+
+``` text
+$ ruby -v
+ruby 2.5.9p229 (2021-04-05 revision 67939) [x86_64-linux]
+
+$ time gem install sqlite3
+Building native extensions. This could take a while...
+Successfully installed sqlite3-1.5.0
+1 gem installed
+
+real    0m20.620s
+user    0m23.361s
+sys     0m5.839s
+```
+
+
+#### System libsqlite3
+
+If you would prefer to build the sqlite3-ruby gem against your system libsqlite3, which requires that you install libsqlite3 and its development files yourself, you may do so by using the `--enable-system-libraries` flag at gem install time.
+
+PLEASE NOTE:
+
+- you must avoid installing a precompiled native gem (see [previous section](#avoiding-the-precompiled-native-gem))
+- only versions of libsqlite3 `>= 3.5.0` are supported,
+- and some library features may depend on how your libsqlite3 was compiled.
+
+For example, on a linux system running Ruby 2.5:
+
+``` text
+$ time gem install sqlite3 -- --enable-system-libraries
+Building native extensions with: '--enable-system-libraries'
+This could take a while...
+Successfully installed sqlite3-1.5.0
+1 gem installed
+
+real    0m4.234s
+user    0m3.809s
+sys     0m0.912s
+```
+
+If you're using bundler, you can opt into system libraries like this:
+
+``` sh
+bundle config build.sqlite3 --enable-system-libraries
+```
+
+If you have sqlite3 installed in a non-standard location, you may need to specify the location of the include and lib files by using `--with-sqlite-include` and `--with-sqlite-lib` options (or a `--with-sqlite-dir` option, see [MakeMakefile#dir_config](https://ruby-doc.org/stdlib-3.1.1/libdoc/mkmf/rdoc/MakeMakefile.html#method-i-dir_config)). If you have pkg-config installed and configured properly, this may not be necessary.
+
+``` sh
+gem install sqlite3 -- \
+  --enable-system-libraries \
+  --with-sqlite3-include=/opt/local/include \
+  --with-sqlite3-lib=/opt/local/lib
+```
+
+
+#### System libsqlcipher
+
+If you'd like to link against a system-installed libsqlcipher, you may do so by using the `--with-sqlcipher` flag:
+
+``` text
+$ time gem install sqlite3 -- --with-sqlcipher
+Building native extensions with: '--with-sqlcipher'
+This could take a while...
+Successfully installed sqlite3-1.5.0
+1 gem installed
+
+real    0m4.772s
+user    0m3.906s
+sys     0m0.896s
+```
+
+If you have sqlcipher installed in a non-standard location, you may need to specify the location of the include and lib files by using `--with-sqlite-include` and `--with-sqlite-lib` options (or a `--with-sqlite-dir` option, see [MakeMakefile#dir_config](https://ruby-doc.org/stdlib-3.1.1/libdoc/mkmf/rdoc/MakeMakefile.html#method-i-dir_config)). If you have pkg-config installed and configured properly, this may not be necessary.
+
+
+## Support
+
+### Something has gone wrong! Where do I get help?
+
+You can ask for help or support from the
+[sqlite3-ruby mailing list](http://groups.google.com/group/sqlite3-ruby) which
+can be found here:
+
+> http://groups.google.com/group/sqlite3-ruby
+
+
+### I've found a bug! How do I report it?
+
+After contacting the mailing list, you've found that you've uncovered a bug. You can file the bug at the [github issues page](https://github.com/sparklemotion/sqlite3-ruby/issues) which can be found here:
+
+> https://github.com/sparklemotion/sqlite3-ruby/issues
+
+
+## Usage
+
+For help figuring out the SQLite3/Ruby interface, check out the SYNOPSIS as well as the RDoc. It includes examples of usage. If you have any questions that you feel should be addressed in the FAQ, please send them to [the mailing list](http://groups.google.com/group/sqlite3-ruby).
+
+
+## Contributing
+
+See [`CONTRIBUTING.md`](./CONTRIBUTING.md).
+
+
+## License
+
+This library is licensed under `BSD-3-Clause`, see [`LICENSE`](./LICENSE).
+
+
+### Dependencies
+
+The source code of `sqlite` is distributed in the "ruby platform" gem. This code is public domain, see [`LICENSE-DEPENDENCIES`](./LICENSE-DEPENDENCIES) for details.

data/dependencies.yml

@@ -0,0 +1,14 @@
+# TODO: stop using symbols here once we no longer support Ruby 2.7 and can rely on symbolize_names
+:sqlite3:
+  # checksum verified by first checking the published sha3(256) checksum against https://sqlite.org/download.html:
+  #
+  # $ sha3sum -a 256 ports/archives/sqlite-autoconf-3400000.tar.gz
+  # 7ee8f02b21edb4489df5082b5cf5b7ef47bcebcdb0e209bf14240db69633c878  ports/archives/sqlite-autoconf-3400000.tar.gz
+  #
+  # $ sha256sum ports/archives/sqlite-autoconf-3400000.tar.gz
+  # 0333552076d2700c75352256e91c78bf5cd62491589ba0c69aed0a81868980e7  ports/archives/sqlite-autoconf-3400000.tar.gz
+  #
+  :version: "3.40.0"
+  :files:
+    - :url: "https://sqlite.org/2022/sqlite-autoconf-3400000.tar.gz"
+      :sha256: "0333552076d2700c75352256e91c78bf5cd62491589ba0c69aed0a81868980e7"

data/ext/sqlite3/aggregator.c

@@ -10,13 +10,13 @@
  *                 in-flight for this aggregator. */
 static VALUE cAggregatorWrapper;
 
-/* wraps a intance of the "handler" class. Loses its reference at the end of
+/* wraps a instance of the "handler" class. Loses its reference at the end of
  * the xFinal callback.
  *
- * An AggregatorInstance holds the following instnace variables:
+ * An AggregatorInstance holds the following instance variables:
  * -handler_instance: the instance to call `step` and `finalize` on.
  * -exc_status:       status returned by rb_protect.
- *                    != 0 if an exception occurred. If an exception occured
+ *                    != 0 if an exception occurred. If an exception occurred
  *                    `step` and `finalize` won't be called any more. */
 static VALUE cAggregatorInstance;
 
@@ -48,7 +48,7 @@ rb_sqlite3_protected_funcall(VALUE self, ID method, int argc, VALUE *params,
 }
 
 /* called in rb_sqlite3_aggregator_step and rb_sqlite3_aggregator_final. It
- * checks if the exection context already has an associated instance. If it
+ * checks if the execution context already has an associated instance. If it
  * has one, it returns it. If there is no instance yet, it creates one and
  * associates it with the context. */
 static VALUE
@@ -165,8 +165,8 @@ rb_sqlite3_aggregator_final(sqlite3_context * ctx)
   if (exc_status) {
     /* the user should never see this, as Statement.step() will pick up the
      * outstanding exception and raise it instead of generating a new one
-     * for SQLITE_ERROR with message "Ruby Exception occured" */
-    sqlite3_result_error(ctx, "Ruby Exception occured", -1);
+     * for SQLITE_ERROR with message "Ruby Exception occurred" */
+    sqlite3_result_error(ctx, "Ruby Exception occurred", -1);
   }
 
   rb_sqlite3_aggregate_instance_destroy(ctx);
@@ -265,9 +265,10 @@ rb_sqlite3_define_aggregator2(VALUE self, VALUE aggregator, VALUE ruby_name)
 void
 rb_sqlite3_aggregator_init(void)
 {
-  rb_gc_register_address(&cAggregatorWrapper);
-  rb_gc_register_address(&cAggregatorInstance);
   /* rb_class_new generatos class with undefined allocator in ruby 1.9 */
   cAggregatorWrapper = rb_funcall(rb_cClass, rb_intern("new"), 0);
+  rb_gc_register_mark_object(cAggregatorWrapper);
+
   cAggregatorInstance = rb_funcall(rb_cClass, rb_intern("new"), 0);
+  rb_gc_register_mark_object(cAggregatorInstance);
 }

data/ext/sqlite3/database.c

@@ -1,6 +1,11 @@
 #include <sqlite3_ruby.h>
 #include <aggregator.h>
 
+#ifdef _MSC_VER
+#pragma warning( push )
+#pragma warning( disable : 4028 )
+#endif
+
 #define REQUIRE_OPEN_DB(_ctxt) \
   if(!_ctxt->db) \
     rb_raise(rb_path2class("SQLite3::Exception"), "cannot use a closed database");
@@ -26,7 +31,7 @@ static char *
 utf16_string_value_ptr(VALUE str)
 {
   StringValue(str);
-  rb_str_buf_cat(str, "\x00", 1L);
+  rb_str_buf_cat(str, "\x00\x00", 2L);
   return RSTRING_PTR(str);
 }
 
@@ -35,18 +40,17 @@ static VALUE sqlite3_rb_close(VALUE self);
 static VALUE rb_sqlite3_open_v2(VALUE self, VALUE file, VALUE mode, VALUE zvfs)
 {
   sqlite3RubyPtr ctx;
-  VALUE flags;
   int status;
 
   Data_Get_Struct(self, sqlite3Ruby, ctx);
 
 #if defined TAINTING_SUPPORT
-#if defined StringValueCStr
+#  if defined StringValueCStr
   StringValuePtr(file);
   rb_check_safe_obj(file);
-#else
+#  else
   Check_SafeStr(file);
-#endif
+#  endif
 #endif
 
       status = sqlite3_open_v2(
@@ -61,6 +65,23 @@ static VALUE rb_sqlite3_open_v2(VALUE self, VALUE file, VALUE mode, VALUE zvfs)
   return self;
 }
 
+static VALUE rb_sqlite3_disable_quirk_mode(VALUE self)
+{
+#if defined SQLITE_DBCONFIG_DQS_DDL
+  sqlite3RubyPtr ctx;
+  Data_Get_Struct(self, sqlite3Ruby, ctx);
+
+  if(!ctx->db) return Qfalse;
+
+  sqlite3_db_config(ctx->db, SQLITE_DBCONFIG_DQS_DDL, 0, (void*)0);
+  sqlite3_db_config(ctx->db, SQLITE_DBCONFIG_DQS_DML, 0, (void*)0);
+
+  return Qtrue;
+#else
+  return Qfalse;
+#endif
+}
+
 /* call-seq: db.close
  *
  * Closes this database.
@@ -582,7 +603,7 @@ static VALUE load_extension(VALUE self, VALUE file)
   Data_Get_Struct(self, sqlite3Ruby, ctx);
   REQUIRE_OPEN_DB(ctx);
 
-  status = sqlite3_load_extension(ctx->db, RSTRING_PTR(file), 0, &errMsg);
+  status = sqlite3_load_extension(ctx->db, StringValuePtr(file), 0, &errMsg);
   if (status != SQLITE_OK)
   {
     errexp = rb_exc_new2(rb_eRuntimeError, errMsg);
@@ -705,7 +726,7 @@ static int regular_callback_function(VALUE callback_ary, int count, char **data,
 
 /* Is invoked by calling db.execute_batch2(sql, &block)
  *
- * Executes all statments in a given string separated by semicolons.
+ * Executes all statements in a given string separated by semicolons.
  * If a query is made, all values returned are strings
  * (except for 'NULL' values which return nil),
  * so the user may parse values with a block.
@@ -723,9 +744,9 @@ static VALUE exec_batch(VALUE self, VALUE sql, VALUE results_as_hash)
   REQUIRE_OPEN_DB(ctx);
 
   if(results_as_hash == Qtrue) {
-    status = sqlite3_exec(ctx->db, StringValuePtr(sql), hash_callback_function, callback_ary, &errMsg);
+    status = sqlite3_exec(ctx->db, StringValuePtr(sql), (sqlite3_callback)hash_callback_function, (void*)callback_ary, &errMsg);
   } else {
-    status = sqlite3_exec(ctx->db, StringValuePtr(sql), regular_callback_function, callback_ary, &errMsg);
+    status = sqlite3_exec(ctx->db, StringValuePtr(sql), (sqlite3_callback)regular_callback_function, (void*)callback_ary, &errMsg);
   }
 
   if (status != SQLITE_OK)
@@ -800,6 +821,7 @@ void init_sqlite3_database()
   /* public "define_aggregator" is now a shim around define_aggregator2
    * implemented in Ruby */
   rb_define_private_method(cSqlite3Database, "define_aggregator2", rb_sqlite3_define_aggregator2, 2);
+  rb_define_private_method(cSqlite3Database, "disable_quirk_mode", rb_sqlite3_disable_quirk_mode, 0);
   rb_define_method(cSqlite3Database, "interrupt", interrupt, 0);
   rb_define_method(cSqlite3Database, "errmsg", errmsg, 0);
   rb_define_method(cSqlite3Database, "errcode", errcode_, 0);
@@ -825,3 +847,7 @@ void init_sqlite3_database()
 
   rb_sqlite3_aggregator_init();
 }
+
+#ifdef _MSC_VER
+#pragma warning( pop )
+#endif