mdbx 0.1.0.pre.20201217111933

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: be5af4b8718ccda99471808092ab76ed497758add8a8c429d6eae16b9279c007
+  data.tar.gz: a183a3ba5019cc1b8cbda9ae45f803342c02011de762202728b6ab96c8f7d133
+SHA512:
+  metadata.gz: e7e463a36ed38653930e9894404431de494cc39e6efa2ae6993681d4198b28c9ecf0c160b09f01353d6296699e9a2ea780973f983a7a32b91b6630d76ad10e2a
+  data.tar.gz: 300534e3d3c342019d803840e956afdc7d4e3bb114d8fe4df95918cfb85808df146979ff56af539e23ae8bfbacf9f7acab1aaaef4742b0b16a162ad6364d7bba

data/History.md

@@ -0,0 +1,9 @@
+# Release History for mdbx
+
+---
+
+## v0.0.1 [2020-12-16] Mahlon E. Smith <mahlon@martini.nu>
+
+Early release, initial basic functionality.
+
+

data/README.md

@@ -0,0 +1,129 @@
+# Ruby MDBX
+
+home
+: https://code.martini.nu/ruby-mdbx
+
+code
+: https://code.martini.nu/ruby-mdbx
+
+docs
+: https://martini.nu/docs/ruby-mdbx
+
+github
+: https://github.com/mahlon/ruby-mdbx
+
+gitlab
+: https://gitlab.com/mahlon/ruby-mdbx
+
+sourcehut:
+: https://hg.sr.ht/~mahlon/ruby-mdbx
+
+
+## Description
+
+This is a Ruby (MRI) binding for the libmdbx database library.
+
+libmdbx is an extremely fast, compact, powerful, embedded, transactional
+key-value database, with permissive license. libmdbx has a specific set
+of properties and capabilities, focused on creating unique lightweight
+solutions.
+
+  - Allows a swarm of multi-threaded processes to ACIDly read and update
+  several key-value maps and multimaps in a locally-shared database.
+
+  - Provides extraordinary performance, minimal overhead through
+  Memory-Mapping and Olog(N) operations costs by virtue of B+ tree.
+
+  - Requires no maintenance and no crash recovery since it doesn't use
+  WAL, but that might be a caveat for write-intensive workloads with
+  durability requirements.
+
+  - Compact and friendly for fully embedding. Only ≈25KLOC of C11,
+  ≈64K x86 binary code of core, no internal threads neither server
+  process(es), but implements a simplified variant of the Berkeley DB
+  and dbm API.
+
+  - Enforces serializability for writers just by single mutex and
+  affords wait-free for parallel readers without atomic/interlocked
+  operations, while writing and reading transactions do not block each
+  other.
+
+  - Guarantee data integrity after crash unless this was explicitly
+  neglected in favour of write performance.
+
+  - Supports Linux, Windows, MacOS, Android, iOS, FreeBSD, DragonFly,
+  Solaris, OpenSolaris, OpenIndiana, NetBSD, OpenBSD and other systems
+  compliant with POSIX.1-2008.
+
+  - Historically, libmdbx is a deeply revised and extended descendant
+  of the amazing Lightning Memory-Mapped Database. libmdbx inherits
+  all benefits from LMDB, but resolves some issues and adds a set of
+  improvements.
+
+
+### Examples
+
+[forthcoming]
+
+
+## Prerequisites
+
+* Ruby 2.6+
+* libmdbx (https://github.com/erthink/libmdbx)
+
+
+## Installation
+
+    $ gem install mdbx
+
+
+## Contributing
+
+You can check out the current development source with Mercurial via its
+[home repo](https://code.martini.nu/ruby-mdbx), or with Git at its
+[project page](https://gitlab.com/mahlon/ruby-mdbx).
+
+After checking out the source, run:
+
+    $ gem install -Ng
+    $ rake setup
+
+This will install dependencies, and do any other necessary setup for
+development.
+
+
+## Authors
+
+- Mahlon E. Smith <mahlon@martini.nu>
+
+
+## License
+
+Copyright (c) 2020, Mahlon E. Smith
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice,
+  this list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the name of the author/s, nor the names of the project's
+  contributors may be used to endorse or promote products derived from this
+  software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+

data/ext/mdbx_ext/database.c

@@ -0,0 +1,511 @@
+/* vim: set noet sta sw=4 ts=4 : */
+
+#include "mdbx_ext.h"
+
+/* VALUE str = rb_sprintf( "path: %+"PRIsVALUE", opts: %+"PRIsVALUE, path, opts ); */
+/* printf( "%s\n", StringValueCStr(str) ); */
+
+VALUE rmdbx_cDatabase;
+
+
+/* Shortcut for fetching current DB variables.
+ *
+ */
+#define UNWRAP_DB( val, db ) \
+	rmdbx_db_t *db; \
+	TypedData_Get_Struct( val, rmdbx_db_t, &rmdbx_db_data, db );
+
+
+/*
+ * A struct encapsulating an instance's DB state.
+ */
+struct rmdbx_db {
+	MDBX_env *env;
+	MDBX_dbi dbi;
+	MDBX_txn *txn;
+	MDBX_cursor *cursor;
+	int env_flags;
+	int mode;
+	int open;
+	int max_collections;
+	char *path;
+	char *subdb;
+};
+typedef struct rmdbx_db rmdbx_db_t;
+
+
+/*
+ * Ruby allocation hook.
+ */
+void rmdbx_free( void *db );  /* forward declaration */
+static const rb_data_type_t rmdbx_db_data = {
+	.wrap_struct_name = "MDBX::Database::Data",
+	.function = { .dfree = rmdbx_free },
+	.flags = RUBY_TYPED_FREE_IMMEDIATELY
+};
+
+
+/*
+ * Allocate a DB environment onto the stack.
+ */
+VALUE
+rmdbx_alloc( VALUE klass )
+{
+	rmdbx_db_t *new = RB_ALLOC( rmdbx_db_t );
+	return TypedData_Make_Struct( klass, rmdbx_db_t, &rmdbx_db_data, new );
+}
+
+
+/*
+ * Ensure all database file descriptors are collected and
+ * removed.
+ */
+void
+rmdbx_close_all( rmdbx_db_t* db )
+{
+	if ( db->cursor ) mdbx_cursor_close( db->cursor );
+	if ( db->txn )    mdbx_txn_abort( db->txn );
+	if ( db->dbi )    mdbx_dbi_close( db->env, db->dbi );
+	if ( db->env )    mdbx_env_close( db->env );
+	db->open = 0;
+}
+
+
+/*
+ * Cleanup a previously allocated DB environment.
+ */
+void
+rmdbx_free( void *db )
+{
+	if ( db ) {
+		rmdbx_close_all( db );
+		free( db );
+	}
+}
+
+
+/*
+ * Cleanly close an opened database from Ruby.
+ */
+VALUE
+rmdbx_close( VALUE self )
+{
+	UNWRAP_DB( self, db );
+	rmdbx_close_all( db );
+	return Qtrue;
+}
+
+
+/*
+ * Open the DB environment handle.
+ */
+VALUE
+rmdbx_open_env( VALUE self )
+{
+	int rc;
+	UNWRAP_DB( self, db );
+	rmdbx_close_all( db );
+
+	/* Allocate an mdbx environment.
+	 */
+	rc = mdbx_env_create( &db->env );
+	if ( rc != MDBX_SUCCESS )
+		rb_raise( rmdbx_eDatabaseError, "mdbx_env_create: (%d) %s", rc, mdbx_strerror(rc) );
+
+	/* Set the maximum number of named databases for the environment. */
+	// FIXME: potenially more env setups here?  maxreaders, pagesize?
+	mdbx_env_set_maxdbs( db->env, db->max_collections );
+
+	rc = mdbx_env_open( db->env, db->path, db->env_flags, db->mode );
+	if ( rc != MDBX_SUCCESS ) {
+		rmdbx_close( self );
+		rb_raise( rmdbx_eDatabaseError, "mdbx_env_open: (%d) %s", rc, mdbx_strerror(rc) );
+	}
+	db->open = 1;
+
+	return Qtrue;
+}
+
+
+/*
+ * call-seq:
+ *    db.closed? #=> false
+ *
+ * Predicate: return true if the database environment is closed.
+ */
+VALUE
+rmdbx_closed_p( VALUE self )
+{
+	UNWRAP_DB( self, db );
+	return db->open == 1 ? Qfalse : Qtrue;
+}
+
+
+/*
+ * Open a new database transaction.
+ *
+ * +rwflag+ must be either MDBX_TXN_RDONLY or MDBX_TXN_READWRITE.
+ */
+void
+rmdbx_open_txn( VALUE self, int rwflag )
+{
+	int rc;
+	UNWRAP_DB( self, db );
+
+	rc = mdbx_txn_begin( db->env, NULL, rwflag, &db->txn);
+	if ( rc != MDBX_SUCCESS ) {
+		rmdbx_close( self );
+		rb_raise( rmdbx_eDatabaseError, "mdbx_txn_begin: (%d) %s", rc, mdbx_strerror(rc) );
+	}
+
+	if ( db->dbi == 0 ) {
+		// FIXME: dbi_flags
+		rc = mdbx_dbi_open( db->txn, db->subdb, MDBX_CREATE, &db->dbi );
+		if ( rc != MDBX_SUCCESS ) {
+			rmdbx_close( self );
+			rb_raise( rmdbx_eDatabaseError, "mdbx_dbi_open: (%d) %s", rc, mdbx_strerror(rc) );
+		}
+	}
+
+	return;
+}
+
+
+/*
+ * call-seq:
+ *    db.clear
+ *
+ * Empty the database (or collection) on disk.  Unrecoverable!
+ */
+VALUE
+rmdbx_clear( VALUE self )
+{
+	UNWRAP_DB( self, db );
+
+	rmdbx_open_txn( self, MDBX_TXN_READWRITE );
+	int rc = mdbx_drop( db->txn, db->dbi, true );
+
+	if ( rc != MDBX_SUCCESS )
+		rb_raise( rmdbx_eDatabaseError, "mdbx_drop: (%d) %s", rc, mdbx_strerror(rc) );
+
+	mdbx_txn_commit( db->txn );
+
+	/* Refresh the environment handles. */
+	rmdbx_open_env( self );
+
+	return Qnil;
+}
+
+
+/*
+ * Given a ruby +arg+, convert and return a structure
+ * suitable for usage as a key for mdbx.  All keys are explicitly
+ * converted to strings.
+ */
+MDBX_val
+rmdbx_key_for( VALUE arg )
+{
+	MDBX_val rv;
+
+	arg = rb_funcall( arg, rb_intern("to_s"), 0 );
+	rv.iov_len  = RSTRING_LEN( arg );
+	rv.iov_base = StringValuePtr( arg );
+
+	return rv;
+}
+
+
+/*
+ * Given a ruby +arg+, convert and return a structure
+ * suitable for usage as a value for mdbx.
+ */
+MDBX_val
+rmdbx_val_for( VALUE self, VALUE arg )
+{
+	MDBX_val rv;
+	VALUE serialize_proc;
+
+	serialize_proc = rb_iv_get( self, "@serializer" );
+	if ( ! NIL_P( serialize_proc ) )
+		arg = rb_funcall( serialize_proc, rb_intern("call"), 1, arg );
+
+	rv.iov_len  = RSTRING_LEN( arg );
+	rv.iov_base = StringValuePtr( arg );
+
+	return rv;
+}
+
+
+/* call-seq:
+ *    db.keys #=> [ 'key1', 'key2', ... ]
+ *
+ * Return an array of all keys in the current collection.
+ */
+VALUE
+rmdbx_keys( VALUE self )
+{
+	UNWRAP_DB( self, db );
+	VALUE rv = rb_ary_new();
+	MDBX_val key, data;
+	int rc;
+
+	if ( ! db->open ) rb_raise( rmdbx_eDatabaseError, "Closed database." );
+
+	rmdbx_open_txn( self, MDBX_TXN_RDONLY );
+	rc = mdbx_cursor_open( db->txn, db->dbi, &db->cursor);
+
+	if ( rc != MDBX_SUCCESS ) {
+		rmdbx_close( self );
+		rb_raise( rmdbx_eDatabaseError, "Unable to open cursor: (%d) %s", rc, mdbx_strerror(rc) );
+	}
+
+	rc = mdbx_cursor_get( db->cursor, &key, &data, MDBX_FIRST );
+	if ( rc == MDBX_SUCCESS ) {
+		rb_ary_push( rv, rb_str_new( key.iov_base, key.iov_len ) );
+		while ( mdbx_cursor_get( db->cursor, &key, &data, MDBX_NEXT ) == 0 ) {
+			rb_ary_push( rv, rb_str_new( key.iov_base, key.iov_len ) );
+		}
+	}
+
+	mdbx_cursor_close( db->cursor );
+	db->cursor = NULL;
+	mdbx_txn_abort( db->txn );
+	return rv;
+}
+
+
+/* call-seq:
+ *    db[ 'key' ]  #=> value
+ *
+ * Convenience method:  return a single value for +key+ immediately.
+ */
+VALUE
+rmdbx_get_val( VALUE self, VALUE key )
+{
+	int rc;
+	VALUE deserialize_proc;
+	UNWRAP_DB( self, db );
+
+	if ( ! db->open ) rb_raise( rmdbx_eDatabaseError, "Closed database." );
+
+	rmdbx_open_txn( self, MDBX_TXN_RDONLY );
+
+	MDBX_val ckey = rmdbx_key_for( key );
+	MDBX_val data;
+	rc = mdbx_get( db->txn, db->dbi, &ckey, &data );
+	mdbx_txn_abort( db->txn );
+
+	switch ( rc ) {
+		case MDBX_SUCCESS:
+			deserialize_proc = rb_iv_get( self, "@deserializer" );
+			VALUE rv = rb_str_new( data.iov_base, data.iov_len );
+			if ( ! NIL_P( deserialize_proc ) )
+				return rb_funcall( deserialize_proc, rb_intern("call"), 1, rv );
+			return rv;
+
+		case MDBX_NOTFOUND:
+			return Qnil;
+
+		default:
+			rmdbx_close( self );
+			rb_raise( rmdbx_eDatabaseError, "Unable to fetch value: (%d) %s", rc, mdbx_strerror(rc) );
+	}
+}
+
+
+/* call-seq:
+ *    db[ 'key' ] = value #=> value
+ *
+ * Convenience method:  set a single value for +key+
+ */
+VALUE
+rmdbx_put_val( VALUE self, VALUE key, VALUE val )
+{
+	int rc;
+	UNWRAP_DB( self, db );
+
+	if ( ! db->open ) rb_raise( rmdbx_eDatabaseError, "Closed database." );
+
+	rmdbx_open_txn( self, MDBX_TXN_READWRITE );
+
+	MDBX_val ckey = rmdbx_key_for( key );
+
+	// FIXME: DUPSORT is enabled -- different api?
+	// See:  MDBX_NODUPDATA / MDBX_NOOVERWRITE
+	if ( NIL_P(val) ) { /* remove if set to nil */
+		rc = mdbx_del( db->txn, db->dbi, &ckey, NULL );
+	}
+	else {
+		MDBX_val old;
+		MDBX_val data = rmdbx_val_for( self, val );
+		rc = mdbx_replace( db->txn, db->dbi, &ckey, &data, &old, 0 );
+	}
+
+	mdbx_txn_commit( db->txn );
+
+	switch ( rc ) {
+		case MDBX_SUCCESS:
+			return val;
+		case MDBX_NOTFOUND:
+			return Qnil;
+		default:
+			rb_raise( rmdbx_eDatabaseError, "Unable to store value: (%d) %s", rc, mdbx_strerror(rc) );
+	}
+}
+
+
+/*
+ * call-seq:
+ *    db.collection( 'collection_name' ) # => db
+ *    db.collection( nil ) # => db (main)
+ *
+ * Operate on a sub-database "collection".  Passing +nil+
+ * sets the database to the main, top-level namespace.
+ *
+ */
+VALUE
+rmdbx_set_subdb( int argc, VALUE *argv, VALUE self )
+{
+	UNWRAP_DB( self, db );
+	VALUE subdb;
+
+	rb_scan_args( argc, argv, "01", &subdb );
+	if ( argc == 0 ) {
+		if ( db->subdb == NULL ) return Qnil;
+		return rb_str_new_cstr( db->subdb );
+	}
+
+	rb_iv_set( self, "@collection", subdb );
+	db->subdb = NIL_P( subdb ) ? NULL : StringValueCStr( subdb );
+
+	/* Close any currently open dbi handle, to be re-opened with
+	 * the new collection on next access.
+	 *
+	  FIXME:  Immediate transaction write to auto-create new env?
+	  Fetching from here at the moment causes an error if you
+	  haven't written anything yet.
+	 */
+	if ( db->dbi ) {
+		mdbx_dbi_close( db->env, db->dbi );
+		db->dbi = 0;
+	}
+
+	return self;
+}
+
+
+/*
+ * call-seq:
+ *    MDBX::Database.open( path ) -> db
+ *    MDBX::Database.open( path, options ) -> db
+ *    MDBX::Database.open( path, options ) do |db|
+ *    		db...
+ *    end
+ *
+ * Open an existing (or create a new) mdbx database at filesystem
+ * +path+.  In block form, the database is automatically closed.
+ *
+ */
+VALUE
+rmdbx_database_initialize( int argc, VALUE *argv, VALUE self )
+{
+	int mode            = 0644;
+	int max_collections = 0;
+	int env_flags       = MDBX_ENV_DEFAULTS;
+	VALUE path, opts, opt;
+
+	rb_scan_args( argc, argv, "11", &path, &opts );
+
+	/* Ensure options is a hash if it was passed in.
+	 */
+	if ( NIL_P(opts) ) {
+		opts = rb_hash_new();
+	}
+	else {
+		Check_Type( opts, T_HASH );
+	}
+	rb_hash_freeze( opts );
+
+	/* Options setup, overrides.
+	 */
+	opt = rb_hash_aref( opts, ID2SYM( rb_intern("mode") ) );
+	if ( ! NIL_P(opt) ) mode = FIX2INT( opt );
+	opt = rb_hash_aref( opts, ID2SYM( rb_intern("max_collections") ) );
+	if ( ! NIL_P(opt) ) max_collections = FIX2INT( opt );
+	opt = rb_hash_aref( opts, ID2SYM( rb_intern("nosubdir") ) );
+	if ( RTEST(opt) ) env_flags = env_flags | MDBX_NOSUBDIR;
+	opt = rb_hash_aref( opts, ID2SYM( rb_intern("readonly") ) );
+	if ( RTEST(opt) ) env_flags = env_flags | MDBX_RDONLY;
+	opt = rb_hash_aref( opts, ID2SYM( rb_intern("exclusive") ) );
+	if ( RTEST(opt) ) env_flags = env_flags | MDBX_EXCLUSIVE;
+	opt = rb_hash_aref( opts, ID2SYM( rb_intern("compat") ) );
+	if ( RTEST(opt) ) env_flags = env_flags | MDBX_ACCEDE;
+	opt = rb_hash_aref( opts, ID2SYM( rb_intern("writemap") ) );
+	if ( RTEST(opt) ) env_flags = env_flags | MDBX_WRITEMAP;
+	opt = rb_hash_aref( opts, ID2SYM( rb_intern("no_threadlocal") ) );
+	if ( RTEST(opt) ) env_flags = env_flags | MDBX_NOTLS;
+	opt = rb_hash_aref( opts, ID2SYM( rb_intern("no_readahead") ) );
+	if ( RTEST(opt) ) env_flags = env_flags | MDBX_NORDAHEAD;
+	opt = rb_hash_aref( opts, ID2SYM( rb_intern("no_memory_init") ) );
+	if ( RTEST(opt) ) env_flags = env_flags | MDBX_NOMEMINIT;
+	opt = rb_hash_aref( opts, ID2SYM( rb_intern("coalesce") ) );
+	if ( RTEST(opt) ) env_flags = env_flags | MDBX_COALESCE;
+	opt = rb_hash_aref( opts, ID2SYM( rb_intern("lifo_reclaim") ) );
+	if ( RTEST(opt) ) env_flags = env_flags | MDBX_LIFORECLAIM;
+	opt = rb_hash_aref( opts, ID2SYM( rb_intern("no_metasync") ) );
+	if ( RTEST(opt) ) env_flags = env_flags | MDBX_NOMETASYNC;
+
+	/* Duplicate keys, on mdbx_dbi_open, maybe set here? */
+	/* MDBX_DUPSORT = UINT32_C(0x04), */
+
+	/* Initialize the DB vals.
+	 */
+	UNWRAP_DB( self, db );
+	db->env       = NULL;
+	db->dbi       = 0;
+	db->txn       = NULL;
+	db->cursor    = NULL;
+	db->env_flags = env_flags;
+	db->mode      = mode;
+	db->max_collections = max_collections;
+	db->path      = StringValueCStr( path );
+	db->open      = 0;
+	db->subdb     = NULL;
+
+	/* Set instance variables.
+	 */
+	rb_iv_set( self, "@path", path );
+	rb_iv_set( self, "@options", opts );
+
+	rmdbx_open_env( self );
+	return self;
+}
+
+
+/*
+ * Initialization for the MDBX::Database class.
+ */
+void
+rmdbx_init_database()
+{
+	rmdbx_cDatabase = rb_define_class_under( rmdbx_mMDBX, "Database", rb_cData );
+
+#ifdef FOR_RDOC
+	rmdbx_mMDBX = rb_define_module( "MDBX" );
+#endif
+
+	rb_define_alloc_func( rmdbx_cDatabase, rmdbx_alloc );
+
+	rb_define_protected_method( rmdbx_cDatabase, "initialize", rmdbx_database_initialize, -1 );
+	rb_define_method( rmdbx_cDatabase, "collection", rmdbx_set_subdb, -1 );
+	rb_define_method( rmdbx_cDatabase, "close", rmdbx_close, 0 );
+	rb_define_method( rmdbx_cDatabase, "reopen", rmdbx_open_env, 0 );
+	rb_define_method( rmdbx_cDatabase, "closed?", rmdbx_closed_p, 0 );
+	rb_define_method( rmdbx_cDatabase, "clear", rmdbx_clear, 0 );
+	rb_define_method( rmdbx_cDatabase, "keys", rmdbx_keys, 0 );
+	rb_define_method( rmdbx_cDatabase, "[]", rmdbx_get_val, 1 );
+	rb_define_method( rmdbx_cDatabase, "[]=", rmdbx_put_val, 2 );
+
+	rb_require( "mdbx/database" );
+}
+

data/ext/mdbx_ext/extconf.rb

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# vim: set noet sta sw=4 ts=4 :
+
+require 'mkmf'
+
+have_library( 'mdbx' )  or abort "No mdbx library!"
+have_header( 'mdbx.h' ) or abort "No mdbx.h header!"
+
+create_header()
+create_makefile( 'mdbx_ext' )
+

data/ext/mdbx_ext/mdbx_ext.c

@@ -0,0 +1,26 @@
+/* vim: set noet sta sw=4 ts=4 : */
+
+#include "mdbx_ext.h"
+
+VALUE rmdbx_mMDBX;
+VALUE rmdbx_eDatabaseError;
+VALUE rmdbx_eRollback;
+
+/*
+ * MDBX initialization
+ */
+void
+Init_mdbx_ext()
+{
+	rmdbx_mMDBX = rb_define_module( "MDBX" );
+
+	/* The backend library version. */
+	VALUE version = rb_str_new_cstr( mdbx_version.git.describe );
+	rb_define_const( rmdbx_mMDBX, "LIBRARY_VERSION", version );
+
+	rmdbx_eDatabaseError = rb_define_class_under( rmdbx_mMDBX, "DatabaseError", rb_eRuntimeError );
+	rmdbx_eRollback      = rb_define_class_under( rmdbx_mMDBX, "Rollback", rb_eRuntimeError );
+
+	rmdbx_init_database();
+}
+

data/ext/mdbx_ext/mdbx_ext.h

@@ -0,0 +1,29 @@
+
+#include <ruby.h>
+#include "extconf.h"
+
+#include "mdbx.h"
+
+#ifndef MDBX_EXT_0_9_2
+#define MDBX_EXT_0_9_2
+
+
+/* ------------------------------------------------------------
+ * Globals
+ * ------------------------------------------------------------ */
+
+extern VALUE rmdbx_mMDBX;
+extern VALUE rmdbx_cDatabase;
+extern VALUE rmdbx_eDatabaseError;
+extern VALUE rmdbx_eRollback;
+
+
+/* ------------------------------------------------------------
+ * Functions
+ * ------------------------------------------------------------ */
+extern void Init_rmdbx ( void );
+extern void rmdbx_init_database ( void );
+
+
+#endif /* define MDBX_EXT_0_9_2 */
+

data/lib/mdbx.rb

@@ -0,0 +1,20 @@
+# -*- ruby -*-
+# vim: set nosta noet ts=4 sw=4 ft=ruby:
+# encoding: utf-8
+
+require 'mdbx_ext'
+
+
+# Top level namespace for MDBX.
+#
+module MDBX
+
+	# The version of this gem.
+	#
+	# Note: the MDBX library version this gem was built
+	# against can be found in the 'LIBRARY_VERSION' constant.
+	#
+	VERSION = '0.0.1'
+
+end # module MDBX
+

data/lib/mdbx/database.rb

@@ -0,0 +1,68 @@
+# -*- ruby -*-
+# vim: set nosta noet ts=4 sw=4 ft=ruby:
+# encoding: utf-8
+
+require 'mdbx' unless defined?( MDBX )
+
+
+# TODO: rdoc
+#
+class MDBX::Database
+
+	### Open an existing (or create a new) mdbx database at filesystem
+	### +path+.  In block form, the database is automatically closed.
+	###
+	###    MDBX::Database.open( path ) -> db
+	###    MDBX::Database.open( path, options ) -> db
+	###    MDBX::Database.open( path, options ) do |db|
+	###        db[ 'key' ] #=> value
+	###    end
+	###
+	### FIXME: options!
+	###
+	def self::open( *args, &block )
+		db = new( *args )
+
+		db.serializer   = ->( v ) { Marshal.dump( v ) }
+		db.deserializer = ->( v ) { Marshal.load( v ) }
+
+		if block_given?
+			begin
+				yield db
+			ensure
+				db.close
+			end
+		end
+
+		return db
+	end
+
+
+	# Only instantiate Database objects via #open.
+	private_class_method :new
+
+
+	# The options used to instantiate this database.
+	attr_reader :options
+
+	# The path on disk of the database.
+	attr_reader :path
+
+	# A Proc for automatically serializing values.
+	attr_accessor :serializer
+
+	# A Proc for automatically deserializing values.
+	attr_accessor :deserializer
+
+
+	### Switch to the top-level collection.
+	###
+	def main
+		return self.collection( nil )
+	end
+
+	# Allow for some common nomenclature.
+	alias_method :namespace, :collection
+
+end # class MDBX::Database
+

metadata

@@ -0,0 +1,208 @@
+--- !ruby/object:Gem::Specification
+name: mdbx
+version: !ruby/object:Gem::Version
+  version: 0.1.0.pre.20201217111933
+platform: ruby
+authors:
+- Mahlon E. Smith
+autorequire: 
+bindir: bin
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIENDCCApygAwIBAgIBATANBgkqhkiG9w0BAQsFADAiMSAwHgYDVQQDDBdtYWhs
+  b24vREM9bWFydGluaS9EQz1udTAeFw0yMDEyMjIwMDQwNDBaFw0zMDEyMjAwMDQw
+  NDBaMCIxIDAeBgNVBAMMF21haGxvbi9EQz1tYXJ0aW5pL0RDPW51MIIBojANBgkq
+  hkiG9w0BAQEFAAOCAY8AMIIBigKCAYEA2aRhRIb+Cb3OX58q1VHxmeeFM0R0Tyvh
+  rSRequJbgH05Lph3yPqm9Gdvcvqb+5HE4LdTTdRiQuDGE9y1lxaw7CpNxFHgEqDD
+  iBFDClzExQIosju9hzJv7VVEgBobd4da3I37tQH4bJEweOrpoiPESkezGyyeFxVU
+  Sk4ncvMdzk3/XVhiILln5d+s2kB9H6gKE7UTToUay/Faeoo8Ob6TvYfDmVmRR4Mg
+  AJ/SZs1+XY9FrVesyiU81qVo0k7SfA4nsXAOGeJZ7Fku9lG2EoGAepVRwthMu6nb
+  L+vgc2Yc8FE3gLdxgnnqXyuWy7ivK3RmqXkGq0JR3O3+lXedan9eHVEQjIJTio+i
+  QTo9dwtfMKE8EjzT8uN025xe/PJ8XZOtc3AkO5rGVkRcseuZRL8C6v7Ypr4jA454
+  ZGvaNmaKzLlKl6b7caPaeb+AAeVIyBm3CLVdlUdqibttUrm/N+LmeJA+enp8VYTA
+  g8yHOp2C/uyUHLAwmBt41tZqO6hFmMilAgMBAAGjdTBzMAkGA1UdEwQCMAAwCwYD
+  VR0PBAQDAgSwMB0GA1UdDgQWBBRLTYPDE5cpv/oQ3PVlpuCuDXs5uDAcBgNVHREE
+  FTATgRFtYWhsb25AbWFydGluaS5udTAcBgNVHRIEFTATgRFtYWhsb25AbWFydGlu
+  aS5udTANBgkqhkiG9w0BAQsFAAOCAYEAAKlzY37tbOIEGy/gAu5Z6Y4+u6ph2p0C
+  SeveRaItIYHHk870qpFZEpiYah6iupPGMmOXV3uAYNywQb6MGg/3ZguTIF8fQdJh
+  zb3ltiUNsuCCURNsaJ5XpmifO5xoyM3jqb+LuDUnCuDL1qfM/JNXrBguFOfE1Pgb
+  Hv4Asf3a9o7P9V7lBSr1VAF9UTIEqcsV9ZouxTdP9tHtzUpUMaGXQP1myVUJSE35
+  cwSRJbCf8E0NX0iH31nhboVZODZgwgYiyjv4sbjDgI/1V8q7EaI9IdDWsoi8fm4o
+  KdDjQCJ3z7nUXe0ojb0v9xikanWH2S70UX46A/awTwLCh1nXbRc1SwSzfPWVUZpv
+  f46eTlAa9H9cl8GC1tHzl3NUxQ5/bZcSw8FzJXjGivhsyYJ+rL53Skefy5Jdn7Vs
+  AWgz1mmbCTaQJS+NuCrrtq0NbfgluSB/fGvf9ADVPi9ImWpPY3BQE0s6TmJgBI74
+  /KwqC+7jPv0TJhph1OPgnOvSM/sflGsi
+  -----END CERTIFICATE-----
+date: 2020-12-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rake-compiler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: rake-deveiate
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.15.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.15.1
+- !ruby/object:Gem::Dependency
+  name: rdoc-generator-fivefish
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.93'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.93'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+description: |
+  This is a native ruby binding to libmdbx, an improved version
+  of the Lightning Memory Mapped Database.
+
+  libmdbx is an extremely fast, compact, powerful, embedded,
+  transactional key-value database, with permissive license.
+  libmdbx has a specific set of properties and capabilities,
+  focused on creating unique lightweight solutions.
+email:
+- mahlon@martini.nu
+executables: []
+extensions:
+- ext/mdbx_ext/extconf.rb
+extra_rdoc_files: []
+files:
+- History.md
+- README.md
+- ext/mdbx_ext/database.c
+- ext/mdbx_ext/extconf.rb
+- ext/mdbx_ext/mdbx_ext.c
+- ext/mdbx_ext/mdbx_ext.h
+- lib/mdbx.rb
+- lib/mdbx/database.rb
+- lib/mdbx_ext.so
+homepage: https://code.martini.nu/ruby-mdbx
+licenses:
+- BSD-3-Clause
+metadata:
+  changelog_uri: https://martini.nu/docs/ruby-mdbx/History_md.html
+  documentation_uri: https://martini.nu/docs/ruby-mdbx
+  homepage_uri: https://code.martini.nu/ruby-mdbx
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: A ruby binding to libmdbx, an improved version of the Lightning Memory Mapped
+  Database.
+test_files: []

metadata.gz.sig

@@ -0,0 +1,2 @@
+^/Ʌ>�e��j��LKlē�%�2$��[Y�~��!6d��
O�t�0K*�&�B熣��NZ�k����>��sa��pdq�']Z��-��E��K�����P�ǚ3����<����>����{�:��PT���\�-E�n>�[V4��{^���yh?T�+����hRu��N�\�@���儈aV�Sܽ�X��y?�/�QFR�ɣ"���؛�`/���x��j��L��mpdS�wпDq�T������c"��޸�$���kD�W���;(�<:��.���Y +�E	���F�Óɣ_�px�4.+�%	z�*���9
+E��Uh�&Y�?]zȷ�Z<�FKa��֬��*����72�dn��`%