extralite 1.7 → 1.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cf088c359bb74b23020c8cb290cb6c65d06cedd885e4421c3e81f3c21a31ca33
-  data.tar.gz: a14199c2f5d07068a1a57eb0b24119964aa7a9960f23e6cb58bac39fe535dbfa
+  metadata.gz: 149ddf21bc7feaf4d7c3a19011ac9a515fe83d5f57b88c507783bee8c6d5e096
+  data.tar.gz: 55507a0acbd8efeb89d5dfcf652441081285a670a5968a96f2696d3073844975
 SHA512:
-  metadata.gz: '009ccdd0998a39df02718feeecf981eb03dbf55d0dd6b2d0b8bcfb66754a0ec8fcc2ee9e4e9a2b421a63ed6fa89ae29f7c748ca370d32dae2199a01e50febabc'
-  data.tar.gz: e0fc9eb0f8a69dd2017c4d821430a861535fecc2c51e937c58d471098cc0c815867f514a357e2a0572eb848e02e97fac9454116b3cac2ff21abb0e479241552e
+  metadata.gz: c7cdc5d0179c26c3deddc8439e4aaa5f91429ed3839cffc2224fefd8e90c78f0db9c4768f9534b693638572ec5e99ab0317a948f037c654262eca6d801a438f9
+  data.tar.gz: 4ae156e6850e5485b31b1f701597c0692608b59facd1473ca064d0b23ca8b5d2d84995f4fe4c99800b3e01815fb32e21481290e369506e5d2c4e9794af8fe853

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 1.8 2021-12-15
+
+- Add documentation
+
 ## 1.7 2021-12-13
 
 - Add extralite Sequel adapter

data/Gemfile.lock

@@ -1,60 +1,37 @@
 PATH
   remote: .
   specs:
-    extralite (1.7)
+    extralite (1.8)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    ast (2.4.2)
-    coderay (1.1.3)
     docile (1.4.0)
     json (2.5.1)
-    method_source (1.0.0)
-    minitest (5.14.4)
-    parallel (1.20.1)
-    parser (3.0.1.1)
-      ast (~> 2.4.1)
-    pry (0.13.1)
-      coderay (~> 1.1)
-      method_source (~> 1.0)
-    rainbow (3.0.0)
-    rake (13.0.3)
-    rake-compiler (1.1.1)
+    minitest (5.15.0)
+    rake (13.0.6)
+    rake-compiler (1.1.6)
       rake
-    regexp_parser (2.1.1)
-    rexml (3.2.5)
-    rubocop (0.85.1)
-      parallel (~> 1.10)
-      parser (>= 2.7.0.1)
-      rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.7)
-      rexml
-      rubocop-ast (>= 0.0.3)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (1.5.0)
-      parser (>= 3.0.1.1)
-    ruby-progressbar (1.11.0)
     sequel (5.51.0)
     simplecov (0.17.1)
       docile (~> 1.1)
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.2)
-    unicode-display_width (1.7.0)
+    webrick (1.7.0)
+    yard (0.9.27)
+      webrick (~> 1.7.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   extralite!
-  minitest (= 5.14.4)
-  pry (= 0.13.1)
-  rake-compiler (= 1.1.1)
-  rubocop (= 0.85.1)
+  minitest (= 5.15.0)
+  rake-compiler (= 1.1.6)
   sequel (= 5.51.0)
   simplecov (= 0.17.1)
+  yard (= 0.9.27)
 
 BUNDLED WITH
    2.1.4

data/README.md

@@ -73,7 +73,7 @@ db.query('select * from foo where bar = :bar', 'bar' => 42)
 db.query('select * from foo where bar = :bar', ':bar' => 42)
 
 # get last insert rowid
-rowid = db.last_insert_id
+rowid = db.last_insert_rowid
 
 # get number of rows changed in last query
 number_of_rows_affected = db.changes

data/Rakefile

@@ -1,18 +1,27 @@
 # frozen_string_literal: true
 
-require "bundler/gem_tasks"
-require "rake/clean"
+require 'bundler/gem_tasks'
+require 'rake/clean'
 
-require "rake/extensiontask"
-Rake::ExtensionTask.new("extralite_ext") do |ext|
-  ext.ext_dir = "ext/extralite"
+require 'rake/extensiontask'
+Rake::ExtensionTask.new('extralite_ext') do |ext|
+  ext.ext_dir = 'ext/extralite'
 end
 
 task :recompile => [:clean, :compile]
 
-task :default => [:compile, :test]
+task :default => [:compile, :doc, :test]
+task :doc => :yard
 task :test do
   exec 'ruby test/run.rb'
 end
 
-CLEAN.include "**/*.o", "**/*.so", "**/*.so.*", "**/*.a", "**/*.bundle", "**/*.jar", "pkg", "tmp"
+CLEAN.include '**/*.o', '**/*.so', '**/*.so.*', '**/*.a', '**/*.bundle', '**/*.jar', 'pkg', 'tmp'
+
+require 'yard'
+YARD_FILES = FileList['ext/extralite/extralite.c', 'lib/extralite.rb', 'lib/sequel/adapters/extralite.rb']
+
+YARD::Rake::YardocTask.new do |t|
+  t.files   = YARD_FILES
+  t.options = %w(-o doc --readme README.md)
+end

data/ext/extralite/extralite.c

@@ -51,6 +51,10 @@ static VALUE Database_allocate(VALUE klass) {
   } \
 }
 
+/* call-seq: initialize(path)
+ *
+ * Initializes a new SQLite database with the given path.
+ */
 
 VALUE Database_initialize(VALUE self, VALUE path) {
   int rc;
@@ -72,6 +76,10 @@ VALUE Database_initialize(VALUE self, VALUE path) {
   return Qnil;
 }
 
+/* call-seq: close
+ *
+ * Closes the database.
+ */
 VALUE Database_close(VALUE self) {
   int rc;
   Database_t *db;
@@ -86,6 +94,10 @@ VALUE Database_close(VALUE self) {
   return self;
 }
 
+/* call-seq: closed?
+ *
+ * Returns true if the database is closed.
+ */
 VALUE Database_closed_p(VALUE self) {
   Database_t *db;
   GetDatabase(self, db);
@@ -342,6 +354,29 @@ VALUE safe_query_hash(VALUE arg) {
   return result;
 }
 
+/* call-seq:
+ *    query(sql, *parameters, &block)
+ *    query_hash(sql, *parameters, &block)
+ *
+ * Runs a query returning rows as hashes (with symbol keys). If a block is
+ * given, it will be called for each row. Otherwise, an array containing all
+ * rows is returned.
+ * 
+ * Query parameters to be bound to placeholders in the query can be specified as
+ * a list of values or as a hash mapping parameter names to values. When
+ * parameters are given as a least, the query should specify parameters using
+ * `?`:
+ * 
+ *     db.query('select * from foo where x = ?', 42)
+ *
+ * Named placeholders are specified using `:`. The placeholder values are
+ * specified using a hash, where keys are either strings are symbols. String
+ * keys can include or omit the `:` prefix. The following are equivalent:
+ * 
+ *     db.query('select * from foo where x = :bar', bar: 42)
+ *     db.query('select * from foo where x = :bar', 'bar' => 42)
+ *     db.query('select * from foo where x = :bar', ':bar' => 42)
+ */
 VALUE Database_query_hash(int argc, VALUE *argv, VALUE self) {
   query_ctx ctx = { self, argc, argv, 0 };
   return rb_ensure(safe_query_hash, (VALUE)&ctx, cleanup_stmt, (VALUE)&ctx);
@@ -376,6 +411,26 @@ VALUE safe_query_ary(VALUE arg) {
   return result;
 }
 
+/* call-seq: query_ary(sql, *parameters, &block)
+ *
+ * Runs a query returning rows as arrays. If a block is given, it will be called
+ * for each row. Otherwise, an array containing all rows is returned.
+ *
+ * Query parameters to be bound to placeholders in the query can be specified as
+ * a list of values or as a hash mapping parameter names to values. When
+ * parameters are given as a least, the query should specify parameters using
+ * `?`:
+ *
+ *     db.query_ary('select * from foo where x = ?', 42)
+ *
+ * Named placeholders are specified using `:`. The placeholder values are
+ * specified using a hash, where keys are either strings are symbols. String
+ * keys can include or omit the `:` prefix. The following are equivalent:
+ *
+ *     db.query_ary('select * from foo where x = :bar', bar: 42)
+ *     db.query_ary('select * from foo where x = :bar', 'bar' => 42)
+ *     db.query_ary('select * from foo where x = :bar', ':bar' => 42)
+ */
 VALUE Database_query_ary(int argc, VALUE *argv, VALUE self) {
   query_ctx ctx = { self, argc, argv, 0 };
   return rb_ensure(safe_query_ary, (VALUE)&ctx, cleanup_stmt, (VALUE)&ctx);
@@ -405,6 +460,25 @@ VALUE safe_query_single_row(VALUE arg) {
   return row;
 }
 
+/* call-seq: query_single_row(sql, *parameters)
+ *
+ * Runs a query returning a single row as a hash.
+ *
+ * Query parameters to be bound to placeholders in the query can be specified as
+ * a list of values or as a hash mapping parameter names to values. When
+ * parameters are given as a least, the query should specify parameters using
+ * `?`:
+ *
+ *     db.query_single_row('select * from foo where x = ?', 42)
+ *
+ * Named placeholders are specified using `:`. The placeholder values are
+ * specified using a hash, where keys are either strings are symbols. String
+ * keys can include or omit the `:` prefix. The following are equivalent:
+ *
+ *     db.query_single_row('select * from foo where x = :bar', bar: 42)
+ *     db.query_single_row('select * from foo where x = :bar', 'bar' => 42)
+ *     db.query_single_row('select * from foo where x = :bar', ':bar' => 42)
+ */
 VALUE Database_query_single_row(int argc, VALUE *argv, VALUE self) {
   query_ctx ctx = { self, argc, argv, 0 };
   return rb_ensure(safe_query_single_row, (VALUE)&ctx, cleanup_stmt, (VALUE)&ctx);
@@ -442,6 +516,26 @@ VALUE safe_query_single_column(VALUE arg) {
   return result;
 }
 
+/* call-seq: query_single_column(sql, *parameters, &block)
+ *
+ * Runs a query returning single column values. If a block is given, it will be called
+ * for each value. Otherwise, an array containing all values is returned.
+ *
+ * Query parameters to be bound to placeholders in the query can be specified as
+ * a list of values or as a hash mapping parameter names to values. When
+ * parameters are given as a least, the query should specify parameters using
+ * `?`:
+ *
+ *     db.query_single_column('select x from foo where x = ?', 42)
+ *
+ * Named placeholders are specified using `:`. The placeholder values are
+ * specified using a hash, where keys are either strings are symbols. String
+ * keys can include or omit the `:` prefix. The following are equivalent:
+ *
+ *     db.query_single_column('select x from foo where x = :bar', bar: 42)
+ *     db.query_single_column('select x from foo where x = :bar', 'bar' => 42)
+ *     db.query_single_column('select x from foo where x = :bar', ':bar' => 42)
+ */
 VALUE Database_query_single_column(int argc, VALUE *argv, VALUE self) {
   query_ctx ctx = { self, argc, argv, 0 };
   return rb_ensure(safe_query_single_column, (VALUE)&ctx, cleanup_stmt, (VALUE)&ctx);
@@ -470,11 +564,34 @@ VALUE safe_query_single_value(VALUE arg) {
   return value;
 }
 
+/* call-seq: query_single_value(sql, *parameters)
+ *
+ * Runs a query returning a single value from the first row.
+ *
+ * Query parameters to be bound to placeholders in the query can be specified as
+ * a list of values or as a hash mapping parameter names to values. When
+ * parameters are given as a least, the query should specify parameters using
+ * `?`:
+ *
+ *     db.query_single_value('select x from foo where x = ?', 42)
+ *
+ * Named placeholders are specified using `:`. The placeholder values are
+ * specified using a hash, where keys are either strings are symbols. String
+ * keys can include or omit the `:` prefix. The following are equivalent:
+ *
+ *     db.query_single_value('select x from foo where x = :bar', bar: 42)
+ *     db.query_single_value('select x from foo where x = :bar', 'bar' => 42)
+ *     db.query_single_value('select x from foo where x = :bar', ':bar' => 42)
+ */
 VALUE Database_query_single_value(int argc, VALUE *argv, VALUE self) {
   query_ctx ctx = { self, argc, argv, 0 };
   return rb_ensure(safe_query_single_value, (VALUE)&ctx, cleanup_stmt, (VALUE)&ctx);
 }
 
+/* call-seq: last_insert_rowid
+ *
+ * Returns the rowid of the last inserted row.
+ */
 VALUE Database_last_insert_rowid(VALUE self) {
   Database_t *db;
   GetOpenDatabase(self, db);
@@ -482,6 +599,10 @@ VALUE Database_last_insert_rowid(VALUE self) {
   return INT2NUM(sqlite3_last_insert_rowid(db->sqlite3_db));
 }
 
+/* call-seq: changes
+ *
+ * Returns the number of changes made to the database by the last operation.
+ */
 VALUE Database_changes(VALUE self) {
   Database_t *db;
   GetOpenDatabase(self, db);
@@ -489,6 +610,10 @@ VALUE Database_changes(VALUE self) {
   return INT2NUM(sqlite3_changes(db->sqlite3_db));
 }
 
+/* call-seq: filename
+ *
+ * Returns the database filename.
+ */
 VALUE Database_filename(int argc, VALUE *argv, VALUE self) {
   const char *db_name;
   const char *filename;
@@ -501,6 +626,10 @@ VALUE Database_filename(int argc, VALUE *argv, VALUE self) {
   return filename ? rb_str_new_cstr(filename) : Qnil;
 }
 
+/* call-seq: transaction_active?
+ *
+ * Returns true if a transaction is currently in progress.
+ */
 VALUE Database_transaction_active_p(VALUE self) {
   Database_t *db;
   GetOpenDatabase(self, db);
@@ -508,6 +637,10 @@ VALUE Database_transaction_active_p(VALUE self) {
   return sqlite3_get_autocommit(db->sqlite3_db) ? Qfalse : Qtrue;
 }
 
+/* call-seq: load_extension(path)
+ *
+ * Loads an extension with the given path.
+ */
 VALUE Database_load_extension(VALUE self, VALUE path) {
   Database_t *db;
   GetOpenDatabase(self, db);

data/extralite.gemspec

@@ -11,7 +11,6 @@ Gem::Specification.new do |s|
   s.homepage    = 'https://github.com/digital-fabric/extralite'
   s.metadata    = {
     "source_code_uri" => "https://github.com/digital-fabric/extralite",
-    "documentation_uri" => "https://github.com/digital-fabric/extralite",
     "homepage_uri" => "https://github.com/digital-fabric/extralite",
     "changelog_uri" => "https://github.com/digital-fabric/extralite/blob/master/CHANGELOG.md"
   }
@@ -21,10 +20,10 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
   s.required_ruby_version = '>= 2.6'
 
-  s.add_development_dependency  'rake-compiler',        '1.1.1'
-  s.add_development_dependency  'minitest',             '5.14.4'
+  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  'rubocop',              '0.85.1'
-  s.add_development_dependency  'pry',                  '0.13.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.7'
+  VERSION = '1.8.1'
 end

data/lib/extralite.rb

@@ -1 +1,21 @@
 require_relative './extralite_ext'
+
+# Extralite is a Ruby gem for working with SQLite databases
+module Extralite
+  # A base class for Extralite exceptions
+  class Error < RuntimeError
+  end
+
+  # An exception representing an SQL error emitted by SQLite
+  class SQLError < Error
+  end
+
+  # An exception raised when an SQLite database is busy (locked by another
+  # thread or process)
+  class BusyError < Error
+  end
+
+  # An SQLite database
+  class Database
+  end
+end

data/lib/sequel/adapters/extralite.rb

@@ -1,5 +1,9 @@
 # frozen-string-literal: true
 
+# This file was adapted from the SQLite adapter included in Sequel:
+# https://github.com/jeremyevans/sequel
+# (distributed under the MIT license)
+
 require 'extralite'
 require 'sequel/adapters/shared/sqlite'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: extralite
 version: !ruby/object:Gem::Version
-  version: '1.7'
+  version: 1.8.1
 platform: ruby
 authors:
 - Sharon Rosner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-12-13 00:00:00.000000000 Z
+date: 2021-12-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake-compiler
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.1.1
+        version: 1.1.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.1.1
+        version: 1.1.6
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.14.4
+        version: 5.15.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.14.4
+        version: 5.15.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -53,33 +53,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.17.1
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.85.1
+        version: 0.9.27
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.85.1
-- !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.13.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.13.1
+        version: 0.9.27
 - !ruby/object:Gem::Dependency
   name: sequel
   requirement: !ruby/object:Gem::Requirement
@@ -128,7 +114,6 @@ licenses:
 - MIT
 metadata:
   source_code_uri: https://github.com/digital-fabric/extralite
-  documentation_uri: https://github.com/digital-fabric/extralite
   homepage_uri: https://github.com/digital-fabric/extralite
   changelog_uri: https://github.com/digital-fabric/extralite/blob/master/CHANGELOG.md
 post_install_message: