extralite 1.13.1 → 1.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 887537f02a38e762c189e2c322074efc59ef28a662021f59fbfad6cc0dafc13c
-  data.tar.gz: e519f080b81120044cd25113145fb571e5655b377e992643b5fc711a7ab6abfa
+  metadata.gz: 32105cda1ba5871c89609e42828a095d76d4cd2da29bd6d47beefc6a3ae93bd6
+  data.tar.gz: 4ff38c0e6144b22792e2a57792f295fc85a6b3d4b9eb09820e4f3b3e4c78bec1
 SHA512:
-  metadata.gz: 50fef96363c87e0f2461165bed0c608b0bf7a24d1d3d9b90fc1b741446a2685d94bd54d392bae1714984b4c95fbf925c1a839c2b70bfb62262fc3e1112c321a8
-  data.tar.gz: ca51f38183ebc65b01b18ad4ce58885eba4481ab8804de3e70ad140e1470bfeb2c99177db6e0817fb8aa5532c532d6a848e0b20814da93f29b84f7f4fd9bdd6d
+  metadata.gz: c0e94553b7ca02732fe93729844ef16ce58bce7582be1e9c1684f215999b7a4a84414265c6a6932fbc379887940bd70d8ff913c782b0ce6b1ee0eebd9f4438a0
+  data.tar.gz: 14db1538d2aafb781375d636cdcb9a42e92a74ce11304a953930f7456c76895051f8a37e61cf5dfff7b8dc3c4e02694187fd0ad6a8204ca0d948ec1fe3b26479

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 1.14 2022-02-28
+
+- Introduce `extralite-bundle` gem for bundling SQLite, use system lib by
+  default.
+
 ## 1.13.1 2022-02-27
 
 - Fix compilation on TruffleRuby

data/Gemfile

@@ -1,3 +1,3 @@
 source 'https://rubygems.org'
 
-gemspec
+gemspec name: 'extralite'

data/Gemfile.lock

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

data/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021 Sharon Rosner
+Copyright (c) 2022 Sharon Rosner
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -25,14 +25,16 @@
 
 Extralite is a fast, extra-lightweight (about 600 lines of C-code) SQLite3
 wrapper for Ruby. It provides a minimal set of methods for interacting with an
-SQLite3 database, as well as prepared statements. Extralite bundles the latest
-version of SQLite, offering access to the latest features and enhancements.
+SQLite3 database, as well as prepared statements.
+
+Extralite comes in two flavors: the `extralite` gem which uses the
+system-installed sqlite3 library, and the `extralite-bundle` gem which bundles
+the latest version of SQLite
+([3.38.0](https://sqlite.org/releaselog/3_38_0.html)), offering access to the
+latest features and enhancements.
 
 ## Features
 
-- Zero dependencies: Extralite bundles SQLite3 version
-  [3.38.0](https://sqlite.org/releaselog/3_38_0.html) - no need to install any
-  `libsqlite3` packages.
 - A variety of methods for different data access patterns: rows as hashes, rows
   as arrays, single row, single column, single value.
 - Prepared statements.
@@ -61,9 +63,18 @@ gem 'extralite'
 
 You can also run `gem install extralite` if you just want to check it out.
 
-> **Important note**: Extralite will take a while to install (on my modest
-> machine it takes about a minute). This is owing to the fact that Extralite
-> bundles the sqlite3 code, which is compiled upon installation.
+## 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
+SQLite3, you can install the `extralite-bundle` gem, which integrates the
+SQLite3 source code.
+
+> **Important note**: The `extralite-bundle` will take a while to install (on my
+> modest machine it takes about a minute), due to the size of the sqlite3 code.
+
+Usage of the `extralite-bundle` gem is identical to the usage of the normal
+`extralite` gem.
 
 ## Usage
 
@@ -71,7 +82,7 @@ You can also run `gem install extralite` if you just want to check it out.
 require 'extralite'
 
 # get sqlite3 version
-Extralite.sqlite3_version #=> "3.38.0"
+Extralite.sqlite3_version #=> "3.35.2"
 
 # open a database
 db = Extralite::Database.new('/tmp/my.db')
@@ -225,6 +236,12 @@ As those benchmarks show, Extralite is capabale of reading up to 3M rows/second
 when fetching rows as arrays, and up to 2.6M rows/second when fetching
 rows as hashes.
 
+## License
+
+The source code for Extralite is published under the [MIT license](LICENSE). The
+source code for SQLite is in the [public
+domain](https://sqlite.org/copyright.html).
+
 ## Contributing
 
 Contributions in the form of issues, PRs or comments will be greatly

data/Rakefile

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require 'bundler/gem_tasks'
 require 'rake/clean'
 
 require 'rake/extensiontask'

data/ext/extralite/extconf-bundle.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'mkmf'
+
+$CFLAGS << " -Wno-undef"
+$CFLAGS << " -Wno-discarded-qualifiers"
+
+dir_config('extralite_ext')
+create_makefile('extralite_ext')

data/ext/extralite/extconf.rb

@@ -1,9 +1,115 @@
 # frozen_string_literal: true
 
+# require 'rubygems'
+# require 'mkmf'
+
+# # $CFLAGS << "-Wdiscarded-qualifier"
+#   # $CFLAGS << " -Wno-comment"
+#   # $CFLAGS << " -Wno-unused-result"
+#   # $CFLAGS << " -Wno-dangling-else"
+#   # $CFLAGS << " -Wno-parentheses"
+
+# dir_config 'extralite_ext'
+# create_makefile 'extralite_ext'
+
+ENV['RC_ARCHS'] = '' if RUBY_PLATFORM =~ /darwin/
+
 require 'mkmf'
 
-$CFLAGS << " -Wno-undef"
-$CFLAGS << " -Wno-discarded-qualifiers"
+# :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"
+    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_enable_load_extension')
+have_func('sqlite3_load_extension')
+
+unless have_func('sqlite3_open_v2')
+  abort "Please use a newer version of SQLite3"
+end
+
+have_func('sqlite3_prepare_v2')
+have_type('sqlite3_int64', 'sqlite3.h')
+have_type('sqlite3_uint64', 'sqlite3.h')
+
+$defs << "-DEXTRALITE_NO_BUNDLE"
 
 dir_config('extralite_ext')
 create_makefile('extralite_ext')

data/ext/extralite/extralite.h

@@ -3,7 +3,12 @@
 
 #include "ruby.h"
 #include "ruby/thread.h"
+
+#ifdef EXTRALITE_NO_BUNDLE
 #include <sqlite3.h>
+#else
+#include "../sqlite3/sqlite3.h"
+#endif
 
 // debug utility
 #define INSPECT(str, obj) { \

data/ext/extralite/extralite_sqlite3.c

@@ -0,0 +1,3 @@
+#ifndef EXTRALITE_NO_BUNDLE
+#include "../sqlite3/sqlite3.c"
+#endif

data/extralite-bundle.gemspec

@@ -0,0 +1,8 @@
+require_relative './gemspec'
+
+Gem::Specification.new do |s|
+  common_spec(s)
+  s.name        = 'extralite-bundle'
+  s.summary     = 'Extra-lightweight SQLite3 wrapper for Ruby with bundled SQLite3'
+  s.extensions  = ["ext/extralite/extconf-bundle.rb"]
+end

data/extralite.gemspec

@@ -1,30 +1,8 @@
-require_relative './lib/extralite/version'
+require_relative './gemspec'
 
 Gem::Specification.new do |s|
+  common_spec(s)
   s.name        = 'extralite'
-  s.version     = Extralite::VERSION
-  s.licenses    = ['MIT']
   s.summary     = 'Extra-lightweight SQLite3 wrapper for Ruby'
-  s.author      = 'Sharon Rosner'
-  s.email       = 'sharon@noteflakes.com'
-  s.files       = `git ls-files`.split
-  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"
-  }
-  s.rdoc_options = ["--title", "extralite", "--main", "README.md"]
-  s.extra_rdoc_files = ["README.md"]
-  s.extensions = ["ext/extralite/extconf.rb"]
-  s.require_paths = ["lib"]
-  s.required_ruby_version = '>= 2.7'
-
-  s.add_development_dependency  'rake-compiler',        '1.1.6'
-  s.add_development_dependency  'minitest',             '5.15.0'
-  s.add_development_dependency  'simplecov',            '0.17.1'
-  s.add_development_dependency  'yard',                 '0.9.27'
-
-  s.add_development_dependency  'sequel',               '5.51.0'
+  s.extensions  = ["ext/extralite/extconf.rb"]
 end

data/gemspec.rb

@@ -0,0 +1,26 @@
+require_relative './lib/extralite/version'
+
+def common_spec(s)
+  s.version     = Extralite::VERSION
+  s.licenses    = ['MIT']
+  s.author      = 'Sharon Rosner'
+  s.email       = 'sharon@noteflakes.com'
+  s.files       = `git ls-files`.split
+  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"
+  }
+  s.rdoc_options = ["--title", "extralite", "--main", "README.md"]
+  s.extra_rdoc_files = ["README.md"]
+  s.require_paths = ["lib"]
+  s.required_ruby_version = '>= 2.7'
+
+  s.add_development_dependency  'rake-compiler',        '1.1.6'
+  s.add_development_dependency  'minitest',             '5.15.0'
+  s.add_development_dependency  'simplecov',            '0.17.1'
+  s.add_development_dependency  'yard',                 '0.9.27'
+  s.add_development_dependency  'sequel',               '5.51.0'
+end

data/lib/extralite/version.rb

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

data/test/helper.rb

@@ -4,4 +4,4 @@ require 'bundler/setup'
 require 'extralite'
 require 'minitest/autorun'
 
-puts "sqlite3 version: #{Extralite.sqlite3_version}"
+puts "sqlite3 version: #{Extralite.sqlite3_version}"

data/test/test_extralite.rb

@@ -3,12 +3,11 @@
 require_relative 'helper'
 
 class ExtraliteTest < MiniTest::Test
-  SQLITE3_C_PATH = File.expand_path('../ext/extralite/sqlite3.c', __dir__)
-  SQLITE_VERSION_DEFINE_REGEXP = /#define SQLITE_VERSION\s+"([\d\.]+)"/m.freeze
-
   def test_sqlite3_version
-    version = IO.read(SQLITE3_C_PATH).match(SQLITE_VERSION_DEFINE_REGEXP)[1]
-
-    assert_equal version, Extralite.sqlite3_version
+    reported = `sqlite3 --version` rescue ''
+    match = reported.match(/^([\d\.]+)/)
+    if match
+      assert_equal match[1], Extralite.sqlite3_version
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: extralite
 version: !ruby/object:Gem::Version
-  version: 1.13.1
+  version: '1.14'
 platform: ruby
 authors:
 - Sharon Rosner
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-27 00:00:00.000000000 Z
+date: 2022-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake-compiler
@@ -101,13 +101,17 @@ files:
 - bin/update_sqlite_source
 - ext/extralite/common.c
 - ext/extralite/database.c
+- ext/extralite/extconf-bundle.rb
 - ext/extralite/extconf.rb
 - ext/extralite/extralite.h
 - ext/extralite/extralite_ext.c
+- ext/extralite/extralite_sqlite3.c
 - ext/extralite/prepared_statement.c
-- ext/extralite/sqlite3.c
-- ext/extralite/sqlite3.h
+- ext/sqlite3/sqlite3.c
+- ext/sqlite3/sqlite3.h
+- extralite-bundle.gemspec
 - extralite.gemspec
+- gemspec.rb
 - lib/extralite.rb
 - lib/extralite/version.rb
 - lib/sequel/adapters/extralite.rb