mdbx 0.3.2 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 678369c278e65d4faf56eb814e2cb7eba22da57fb5c07c6e4f9dc4e6edd7f09f
-  data.tar.gz: 0fc4b455b4556bb932f867fa40e7c240f555a5a6bbb7d09cb55c68ed7745bfd0
+  metadata.gz: a6ce9c7c96bb8e8857f7a6150df3ded621f5eca3d40848f52999fbe8192f72de
+  data.tar.gz: 8445320bae46524ae7dac00dfb9b1bc6d38c9401607a5d2d983380fa73c8d2b4
 SHA512:
-  metadata.gz: b9844be65fc6e46df8dbaee242ce9bf185c4330559d2a5d8c803eca43f4d09a783276c3d2a20258ef84be099a133031acf0f0b36ff0c2af1f69d0882a0dd4335
-  data.tar.gz: 22fd3c418db16d2a58100ad6bd8f3ae7b7ddce2172075713a798065440e59f6a2fd4cea47bd37d3585781dbeaebc0421f483e20375a5e652fe3a81ee76e0da2f
+  metadata.gz: 0d062355ba32667ac5f4f1d2e6a26a977823d2b0cf841d2f0131509bd2b96f7e36eeb981e96c343a3d960ba77f23996a57f0d1dad4210c99cce9cf870d7a36ee
+  data.tar.gz: 2e517e62946e3005da7d5e20190c5362106253fb925c1bd97e15fc4d7fdf5a0e7c536553babb5ef9b704043f7646dbc1dc46873d9939dd85c64a665562fe0de5

data/History.md

@@ -1,5 +1,27 @@
 # Release History for MDBX
 
+---
+## v0.3.4 [2022-12-21] Mahlon E. Smith <mahlon@martini.nu>
+
+Bugfixes:
+
+ - Don't use mdbx_replace() when not using the original value(s)
+
+
+---
+## v0.3.3 [2021-10-22] Mahlon E. Smith <mahlon@martini.nu>
+
+Bugfixes:
+
+ - Close any open transactions if serialization functions fail.
+ - Don't use functions that assume NUL is the stream terminator.
+
+
+Enhancements:
+
+ - Add Loggability for debug output.
+
+
 ---
 ## v0.3.2 [2021-07-13] Mahlon E. Smith <mahlon@martini.nu>
 

data/README.md

@@ -2,22 +2,13 @@
 # Ruby::MDBX
 
 home
-: https://code.martini.nu/ruby-mdbx
-
-code
-: https://code.martini.nu/ruby-mdbx
+: https://code.martini.nu/fossil/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
+github mirror
+: https://github.com/mahlonsmith/ruby-mdbx
 
 
 ## Description
@@ -30,13 +21,13 @@ of properties and capabilities, focused on creating unique lightweight
 solutions.
 
 For more information about libmdbx (features, limitations, etc), see the
-[introduction](https://erthink.github.io/libmdbx/intro.html).
+[introduction](https://libmdbx.dqdkfa.ru).
 
 
 ## Prerequisites
 
 * Ruby 2.6+
-* [libmdbx](https://github.com/erthink/libmdbx)
+* [libmdbx](https://gitflic.ru/project/erthink/libmdbx)
 
 
 ## Installation
@@ -342,8 +333,8 @@ the currently connected clients.
 
 ## 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
+You can check out the current development source with Fossil via its
+[home repo](https://code.martini.nu/fossil/ruby-mdbx), or with Git at its
 [project mirror](https://gitlab.com/mahlon/ruby-mdbx).
 
 After checking out the source, run:
@@ -362,7 +353,7 @@ development.
 
 ## License
 
-Copyright (c) 2020-2021 Mahlon E. Smith
+Copyright (c) 2020-2022 Mahlon E. Smith
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

data/ext/mdbx_ext/database.c

@@ -101,16 +101,6 @@ rmdbx_closed_p( VALUE self )
 }
 
 
-/*
- * Check if a given +flag+ is enabled for flag +val+.
- */
-int
-rmdbx_flag_enabled( val, flag )
-{
-	return ( val & flag ) == flag;
-}
-
-
 /*
  * Given a ruby string +key+ and a pointer to an MDBX_val, prepare the
  * key for usage within mdbx.  All keys are explicitly converted to
@@ -123,7 +113,7 @@ rmdbx_key_for( VALUE key, MDBX_val *ckey )
 	VALUE key_str  = rb_funcall( key, rb_intern("to_s"), 0 );
 	ckey->iov_len  = RSTRING_LEN( key_str );
 	ckey->iov_base = malloc( ckey->iov_len );
-	strlcpy( ckey->iov_base, StringValuePtr(key_str), ckey->iov_len + 1 );
+	memcpy( ckey->iov_base, StringValuePtr(key_str), ckey->iov_len );
 }
 
 
@@ -135,30 +125,12 @@ rmdbx_key_for( VALUE key, MDBX_val *ckey )
 void
 rmdbx_val_for( VALUE self, VALUE val, MDBX_val *data )
 {
-	VALUE serialize_proc = rb_iv_get( self, "@serializer" );
-
-	if ( ! NIL_P( serialize_proc ) )
-		val = rb_funcall( serialize_proc, rb_intern("call"), 1, val );
-
+	val = rb_funcall( self, rb_intern("serialize"), 1, val );
 	Check_Type( val, T_STRING );
 
 	data->iov_len  = RSTRING_LEN( val );
 	data->iov_base = malloc( data->iov_len );
-	strlcpy( data->iov_base, StringValuePtr(val), data->iov_len + 1 );
-}
-
-
-/*
- * Deserialize and return a value.
- */
-VALUE
-rmdbx_deserialize( VALUE self, VALUE val )
-{
-	VALUE deserialize_proc = rb_iv_get( self, "@deserializer" );
-	if ( ! NIL_P( deserialize_proc ) )
-		val = rb_funcall( deserialize_proc, rb_intern("call"), 1, val );
-
-	return val;
+	memcpy( data->iov_base, StringValuePtr(val), data->iov_len );
 }
 
 
@@ -355,7 +327,7 @@ rmdbx_get_val( VALUE self, VALUE key )
 	switch ( rc ) {
 		case MDBX_SUCCESS:
 			rv = rb_str_new( data.iov_base, data.iov_len );
-			return rmdbx_deserialize( self, rv );
+			return rb_funcall( self, rb_intern("deserialize"), 1, rv );
 
 		case MDBX_NOTFOUND:
 			return Qnil;
@@ -389,10 +361,9 @@ rmdbx_put_val( VALUE self, VALUE key, VALUE val )
 		rc = mdbx_del( db->txn, db->dbi, &ckey, NULL );
 	}
 	else {
-		MDBX_val old;
 		MDBX_val data;
 		rmdbx_val_for( self, val, &data );
-		rc = mdbx_replace( db->txn, db->dbi, &ckey, &data, &old, 0 );
+		rc = mdbx_put( db->txn, db->dbi, &ckey, &data, 0 );
 		xfree( data.iov_base );
 	}
 
@@ -439,13 +410,17 @@ rmdbx_set_subdb( VALUE self, VALUE name )
 	if ( db->txn )
 		rb_raise( rmdbx_eDatabaseError, "Unable to change collection: transaction open" );
 
-	xfree( db->subdb ); 
+	xfree( db->subdb );
 	db->subdb = NULL;
 
 	if ( ! NIL_P(name) ) {
 		size_t len = RSTRING_LEN( name ) + 1;
 		db->subdb = malloc( len );
 		strlcpy( db->subdb, StringValuePtr(name), len );
+		rmdbx_log_obj( self, "debug", "setting subdb: %s", RSTRING_PTR(name) );
+	}
+	else {
+		rmdbx_log_obj( self, "debug", "clearing subdb" );
 	}
 
 	/* Reset the db handle and issue a single transaction to reify
@@ -644,11 +619,11 @@ rmdbx_each_value_i( VALUE self )
 
 	if ( mdbx_cursor_get( db->cursor, &key, &data, MDBX_FIRST ) == MDBX_SUCCESS ) {
 		VALUE rv = rb_str_new( data.iov_base, data.iov_len );
-		rb_yield( rmdbx_deserialize( self, rv ) );
+		rb_yield( rb_funcall( self, rb_intern("deserialize"), 1, rv ) );
 
 		while ( mdbx_cursor_get( db->cursor, &key, &data, MDBX_NEXT ) == MDBX_SUCCESS ) {
 			rv = rb_str_new( data.iov_base, data.iov_len );
-			rb_yield( rmdbx_deserialize( self, rv ) );
+			rb_yield( rb_funcall( self, rb_intern("deserialize"), 1, rv ) );
 		}
 	}
 
@@ -694,12 +669,15 @@ rmdbx_each_pair_i( VALUE self )
 	if ( mdbx_cursor_get( db->cursor, &key, &data, MDBX_FIRST ) == MDBX_SUCCESS ) {
 		VALUE rkey = rb_str_new( key.iov_base, key.iov_len );
 		VALUE rval = rb_str_new( data.iov_base, data.iov_len );
-		rb_yield( rb_assoc_new( rkey, rmdbx_deserialize( self, rval ) ) );
+		rval = rb_funcall( self, rb_intern("deserialize"), 1, rval );
+		rb_yield( rb_assoc_new( rkey, rval  ) );
 
 		while ( mdbx_cursor_get( db->cursor, &key, &data, MDBX_NEXT ) == MDBX_SUCCESS ) {
 			rkey = rb_str_new( key.iov_base, key.iov_len );
 			rval = rb_str_new( data.iov_base, data.iov_len );
-			rb_yield( rb_assoc_new( rkey, rmdbx_deserialize( self, rval ) ) );
+			rval = rb_funcall( self, rb_intern("deserialize"), 1, rval );
+
+			rb_yield( rb_assoc_new( rkey, rval ) );
 		}
 	}
 
@@ -881,7 +859,7 @@ static VALUE rmdbx_init_copy( VALUE copy, VALUE orig )
 void
 rmdbx_init_database()
 {
-	rmdbx_cDatabase = rb_define_class_under( rmdbx_mMDBX, "Database", rb_cData );
+	rmdbx_cDatabase = rb_define_class_under( rmdbx_mMDBX, "Database", rb_cObject );
 
 #ifdef FOR_RDOC
 	rmdbx_mMDBX = rb_define_module( "MDBX" );

data/ext/mdbx_ext/mdbx_ext.c

@@ -6,6 +6,60 @@ VALUE rmdbx_mMDBX;
 VALUE rmdbx_eDatabaseError;
 VALUE rmdbx_eRollback;
 
+/*
+ * Log a message to the given +context+ object's logger.
+ */
+void
+#ifdef HAVE_STDARG_PROTOTYPES
+rmdbx_log_obj( VALUE context, const char *level, const char *fmt, ... )
+#else
+rmdbx_log_obj( VALUE context, const char *level, const char *fmt, va_dcl )
+#endif
+{
+	char buf[BUFSIZ];
+	va_list	args;
+	VALUE logger = Qnil;
+	VALUE message = Qnil;
+
+	va_init_list( args, fmt );
+	vsnprintf( buf, BUFSIZ, fmt, args );
+	message = rb_str_new2( buf );
+
+	logger = rb_funcall( context, rb_intern("log"), 0 );
+	rb_funcall( logger, rb_intern(level), 1, message );
+
+	va_end( args );
+}
+
+
+/*
+ * Log a message to the global logger.
+ */
+void
+#ifdef HAVE_STDARG_PROTOTYPES
+rmdbx_log( const char *level, const char *fmt, ... )
+#else
+rmdbx_log( const char *level, const char *fmt, va_dcl )
+#endif
+{
+	char buf[BUFSIZ];
+	va_list	args;
+	VALUE logger = Qnil;
+	VALUE message = Qnil;
+
+	va_init_list( args, fmt );
+	vsnprintf( buf, BUFSIZ, fmt, args );
+	message = rb_str_new2( buf );
+
+	logger = rb_funcall( rmdbx_mMDBX, rb_intern("logger"), 0 );
+	rb_funcall( logger, rb_intern(level), 1, message );
+
+	va_end( args );
+}
+
+
+
+
 /*
  * MDBX initialization
  */

data/ext/mdbx_ext/mdbx_ext.h

@@ -54,6 +54,22 @@ typedef struct rmdbx_db rmdbx_db_t;
 static const rb_data_type_t rmdbx_db_data;
 
 
+/* ------------------------------------------------------------
+ * Logging
+ * ------------------------------------------------------------ */
+#ifdef HAVE_STDARG_PROTOTYPES
+#include <stdarg.h>
+#define va_init_list(a,b) va_start(a,b)
+void rmdbx_log_obj( VALUE, const char *, const char *, ... );
+void rmdbx_log( const char *, const char *, ... );
+#else
+#include <varargs.h>
+#define va_init_list(a,b) va_start(a)
+void rmdbx_log_obj( VALUE, const char *, const char *, va_dcl );
+void rmdbx_log( const char *, const char *, va_dcl );
+#endif
+
+
 /* ------------------------------------------------------------
  * Globals
  * ------------------------------------------------------------ */

data/lib/mdbx/database.rb

@@ -8,6 +8,9 @@ require 'mdbx' unless defined?( MDBX )
 # The primary class for interacting with an MDBX database.
 #
 class MDBX::Database
+	extend Loggability
+
+	log_to :mdbx
 
 	### call-seq:
 	###    MDBX::Database.open( path ) => db
@@ -82,7 +85,7 @@ class MDBX::Database
 	###
 	### [:no_threadlocal]
 	###   Parallelize read-only transactions across threads.  Writes are
-	###   always thread local. (See MDBX documentatoin for details.)
+	###   always thread local. (See MDBX documentation for details.)
 	###
 	### [:readonly]
 	###   Reject any write attempts while using this database handle.
@@ -361,6 +364,32 @@ class MDBX::Database
 	protected
 	#########
 
+	### Safely serialize a value, closing any open transaction and re-raising
+	### if necessary.
+	###
+	def serialize( val )
+		return val unless self.serializer
+		return self.serializer.call( val )
+
+	rescue => err
+		self.close_transaction( false )
+		raise err
+	end
+
+
+	### Safely deserialize a value, closing any open transaction and re-raising
+	### if necessary.
+	###
+	def deserialize( val )
+		return val unless self.deserializer
+		return self.deserializer.call( val )
+
+	rescue => err
+		self.close_transaction( false )
+		raise err
+	end
+
+
 	### Yield and return the block, opening a snapshot first if
 	### there isn't already a transaction in progress.  Closes
 	### the snapshot if this method opened it.

data/lib/mdbx.rb

@@ -2,15 +2,22 @@
 # vim: set nosta noet ts=4 sw=4 ft=ruby:
 # encoding: utf-8
 
+require 'loggability'
+
 require 'mdbx_ext'
 
 
 # Top level namespace for MDBX.
 #
 module MDBX
+	extend Loggability
 
 	# The version of this gem.
-	VERSION = '0.3.2'
+	VERSION = '0.3.4'
+
+
+	log_as :mdbx
+
 
 end # module MDBX
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mdbx
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.4
 platform: ruby
 authors:
 - Mahlon E. Smith
@@ -34,8 +34,22 @@ cert_chain:
   49pOzX5KHZLTS9DKeaP/xcGPz6C8MiwQdYrZarr2SHRASX1zFa79rkItO8kE6RDr
   b6WDF79UvZ55ajtE00TiwqjQL/ZPEtbd
   -----END CERTIFICATE-----
-date: 2021-07-13 00:00:00.000000000 Z
+date: 2022-12-21 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: loggability
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -192,14 +206,13 @@ files:
 - ext/mdbx_ext/stats.c
 - lib/mdbx.rb
 - lib/mdbx/database.rb
-homepage: https://code.martini.nu/ruby-mdbx
+homepage: https://code.martini.nu/fossil/ruby-mdbx
 licenses:
 - BSD-3-Clause
 metadata:
-  homepage_uri: https://code.martini.nu/ruby-mdbx
+  homepage_uri: https://code.martini.nu/fossil/ruby-mdbx
   documentation_uri: https://martini.nu/docs/ruby-mdbx
   changelog_uri: https://martini.nu/docs/ruby-mdbx/History_md.html
-  source_uri: https://code.martini.nu/ruby-mdbx
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -215,7 +228,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.11
+rubygems_version: 3.3.7
 signing_key: 
 specification_version: 4
 summary: A ruby binding to libmdbx, an improved version of the Lightning Memory Mapped