sqlite3 1.4.4 → 1.5.0.rc1

data/README.md

@@ -0,0 +1,233 @@
+# 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.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, libsqlite3 v3.38.5 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:
+
+- 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/ext/sqlite3/database.c

@@ -1,7 +1,7 @@
 #include <sqlite3_ruby.h>
 #include <aggregator.h>
 
-#if _MSC_VER
+#ifdef _MSC_VER
 #pragma warning( push )
 #pragma warning( disable : 4028 )
 #endif
@@ -40,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(
@@ -745,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)
@@ -849,6 +848,6 @@ void init_sqlite3_database()
   rb_sqlite3_aggregator_init();
 }
 
-#if _MSC_VER
+#ifdef _MSC_VER
 #pragma warning( pop )
 #endif

data/ext/sqlite3/extconf.rb

@@ -1,100 +1,159 @@
-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"
+require "mkmf"
+require "mini_portile2"
+
+module Sqlite3
+  module ExtConf
+    ENV_ALLOWLIST = ["CC", "CFLAGS", "LDFLAGS", "LIBS", "CPPFLAGS", "LT_SYS_LIBRARY_PATH", "CPP"]
+
+    class << self
+      def configure
+        configure_cross_compiler
+
+        if system_libraries?
+          message "Building sqlite3-ruby using system #{libname}.\n"
+          configure_system_libraries
+        else
+          message "Building sqlite3-ruby using packaged sqlite3.\n"
+          configure_packaged_libraries
+        end
+
+        configure_extension
+
+        create_makefile('sqlite3/sqlite3_native')
+      end
+
+      def configure_cross_compiler
+        RbConfig::CONFIG["CC"] = RbConfig::MAKEFILE_CONFIG["CC"] = ENV["CC"] if ENV["CC"]
+        ENV["CC"] = RbConfig::CONFIG["CC"]
+      end
+
+      def system_libraries?
+        sqlcipher? || enable_config("system-libraries")
+      end
+
+      def libname
+        sqlcipher? ? "sqlcipher" : "sqlite3"
+      end
+
+      def sqlcipher?
+        with_config("sqlcipher")
+      end
+
+      def configure_system_libraries
+        pkg_config(libname)
+        append_cflags("-DUSING_SQLCIPHER") if sqlcipher?
+      end
+
+      def configure_packaged_libraries
+        minimal_recipe.tap do |recipe|
+          recipe.configure_options += ["--enable-shared=no", "--enable-static=yes"]
+          ENV.to_h.tap do |env|
+            env["CFLAGS"] = [env["CFLAGS"], "-fPIC"].join(" ") # needed for linking the static library into a shared library
+            recipe.configure_options += env.select { |k,v| ENV_ALLOWLIST.include?(k) }
+                                           .map { |key, value| "#{key}=#{value.strip}" }
+          end
+
+          unless File.exist?(File.join(recipe.target, recipe.host, recipe.name, recipe.version))
+            recipe.cook
+          end
+          recipe.activate
+
+          ENV["PKG_CONFIG_ALLOW_SYSTEM_CFLAGS"] = "t" # on macos, pkg-config will not return --cflags without this
+          pcfile = File.join(recipe.path, "lib", "pkgconfig", "sqlite3.pc")
+          if pkg_config(pcfile)
+            # see https://bugs.ruby-lang.org/issues/18490
+            libs = xpopen(["pkg-config", "--libs", "--static", pcfile], err: [:child, :out], &:read)
+            libs.split.each { |lib| append_ldflags(lib) } if $?.success?
+          else
+            abort("\nCould not configure the build properly. Please install either the `pkg-config` utility or the `pkg-config` rubygem.\n\n")
+          end
+        end
+      end
+
+      def configure_extension
+        if Gem::Requirement.new("< 2.7").satisfied_by?(Gem::Version.new(RUBY_VERSION))
+          append_cflags("-DTAINTING_SUPPORT")
+        end
+
+        abort_could_not_find("sqlite3.h") unless find_header("sqlite3.h")
+        abort_could_not_find(libname) unless find_library(libname, "sqlite3_libversion_number", "sqlite3.h")
+
+        # 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') # https://www.sqlite.org/releaselog/3_5_0.html
+          abort("\nPlease use a version of SQLite3 >= 3.5.0\n\n")
+        end
+
+        have_func('sqlite3_prepare_v2')
+        have_type('sqlite3_int64', 'sqlite3.h')
+        have_type('sqlite3_uint64', 'sqlite3.h')
+      end
+
+      def minimal_recipe
+        MiniPortile.new(libname, sqlite3_config[:version]).tap do |recipe|
+          recipe.files = sqlite3_config[:files]
+          recipe.target = File.join(package_root_dir, "ports")
+          recipe.patch_files = Dir[File.join(package_root_dir, "patches", "*.patch")].sort
+        end
+      end
+
+      def package_root_dir
+        File.expand_path(File.join(File.dirname(__FILE__), "..", ".."))
+      end
+
+      def sqlite3_config
+        mini_portile_config[:sqlite3]
+      end
+
+      def mini_portile_config
+        {
+          sqlite3: {
+            # checksum verified by first checking the published sha3(256) checksum:
+            #
+            #   $ sha3sum -a 256 sqlite-autoconf-3390000.tar.gz
+            #   b8e5b3265992350d40c4ad31efc2e6dec6256813f1d5acc8f0ea805e9f33ca2a  sqlite-autoconf-3390000.tar.gz
+            #
+            #   $ sha256sum sqlite-autoconf-3390000.tar.gz
+            #   e90bcaef6dd5813fcdee4e867f6b65f3c9bfd0aec0f1017f9f3bbce1e4ed09e2  sqlite-autoconf-3390000.tar.gz
+            #
+            version: "3.39.0",
+            files: [{
+                      url: "https://www.sqlite.org/2022/sqlite-autoconf-3390000.tar.gz",
+                      sha256: "e90bcaef6dd5813fcdee4e867f6b65f3c9bfd0aec0f1017f9f3bbce1e4ed09e2",
+                    }],
+          }
+        }
+      end
+
+      def abort_could_not_find(missing)
+        abort("\nCould not find #{missing}.\nPlease visit https://github.com/sparklemotion/sqlite3-ruby for installation instructions.\n\n")
+      end
+
+      def cross_build?
+        enable_config("cross-build")
+      end
+
+      def download
+        minimal_recipe.download
+      end
     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"
+if arg_config("--download-dependencies")
+  Sqlite3::ExtConf.download
+  exit!(0)
 end
 
-have_func('sqlite3_prepare_v2')
-have_type('sqlite3_int64', 'sqlite3.h')
-have_type('sqlite3_uint64', 'sqlite3.h')
-
-create_makefile('sqlite3/sqlite3_native')
+Sqlite3::ExtConf.configure

data/ext/sqlite3/sqlite3.c

@@ -158,4 +158,6 @@ void Init_sqlite3_native()
   rb_define_singleton_method(mSqlite3, "threadsafe", threadsafe_p, 0);
   rb_define_const(mSqlite3, "SQLITE_VERSION", rb_str_new2(SQLITE_VERSION));
   rb_define_const(mSqlite3, "SQLITE_VERSION_NUMBER", INT2FIX(SQLITE_VERSION_NUMBER));
+  rb_define_const(mSqlite3, "SQLITE_LOADED_VERSION", rb_str_new2(sqlite3_libversion()));
+
 }