feat: introduce VERSION_INFO hash

which will remain mostly undocumented for now

Also: document the various "version" constants

Author: flavorjones

.rdoc_options

@@ -14,6 +14,9 @@ exclude:
 - "bin"
 - "rakelib"
 - "ext/sqlite3/extconf.rb"
+- "vendor"
+- "ports"
+- "tmp"
 hyperlink_all: false
 line_numbers: false
 locale: 

ext/sqlite3/sqlite3.c

@@ -201,8 +201,13 @@ Init_sqlite3_native(void)
     rb_define_singleton_method(mSqlite3, "libversion", libversion, 0);
     rb_define_singleton_method(mSqlite3, "threadsafe", threadsafe_p, 0);
     rb_define_singleton_method(mSqlite3, "status", rb_sqlite3_status, -1);
+
+    /* (String) The version of the sqlite3 library compiled with (e.g., "3.46.1") */
     rb_define_const(mSqlite3, "SQLITE_VERSION", rb_str_new2(SQLITE_VERSION));
+
+    /* (Integer) The version of the sqlite3 library compiled with (e.g., 346001) */
     rb_define_const(mSqlite3, "SQLITE_VERSION_NUMBER", INT2FIX(SQLITE_VERSION_NUMBER));
-    rb_define_const(mSqlite3, "SQLITE_LOADED_VERSION", rb_str_new2(sqlite3_libversion()));
 
+    /* (String) The version of the sqlite3 library loaded at runtime (e.g., "3.46.1") */
+    rb_define_const(mSqlite3, "SQLITE_LOADED_VERSION", rb_str_new2(sqlite3_libversion()));
 }

lib/sqlite3.rb

@@ -15,3 +15,5 @@ def self.threadsafe?
     threadsafe > 0
   end
 end
+
+require "sqlite3/version_info"

lib/sqlite3/version.rb

@@ -1,3 +1,4 @@
 module SQLite3
+  # (String) the version of the sqlite3 gem, e.g. "2.1.1"
   VERSION = "2.2.0"
 end

lib/sqlite3/version_info.rb

@@ -0,0 +1,15 @@
+module SQLite3
+  # a hash of descriptive metadata about the current version of the sqlite3 gem
+  VERSION_INFO = {
+    ruby: RUBY_DESCRIPTION,
+    gem: {
+      version: SQLite3::VERSION
+    },
+    sqlite: {
+      compiled: SQLite3::SQLITE_VERSION,
+      loaded: SQLite3::SQLITE_LOADED_VERSION,
+      sqlcipher: SQLite3.sqlcipher?,
+      threadsafe: SQLite3.threadsafe?
+    }
+  }
+end

rakelib/check-manifest.rake

@@ -10,6 +10,7 @@ task :check_manifest do
     .git
     .github
     .ruby-lsp
+    adr
     bin
     doc
     gems

sqlite3.gemspec

@@ -67,7 +67,8 @@ Gem::Specification.new do |s|
     "lib/sqlite3/resultset.rb",
     "lib/sqlite3/statement.rb",
     "lib/sqlite3/value.rb",
-    "lib/sqlite3/version.rb"
+    "lib/sqlite3/version.rb",
+    "lib/sqlite3/version_info.rb"
   ]
 
   s.extra_rdoc_files = [

test/helper.rb

@@ -1,11 +1,8 @@
 require "sqlite3"
 require "minitest/autorun"
+require "yaml"
 
-puts "info: ruby version: #{RUBY_DESCRIPTION}"
-puts "info: gem version: #{SQLite3::VERSION}"
-puts "info: sqlite version: #{SQLite3::SQLITE_VERSION}/#{SQLite3::SQLITE_LOADED_VERSION}"
-puts "info: sqlcipher?: #{SQLite3.sqlcipher?}"
-puts "info: threadsafe?: #{SQLite3.threadsafe?}"
+puts SQLite3::VERSION_INFO.to_yaml
 
 module SQLite3
   class TestCase < Minitest::Test