ueberdb2 1.4.19 → 2.0.1

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Notable Changes
 
+## v2.0.0
+
+* When saving an object that has a `.toJSON()` method, the value returned from
+  that method is saved to the database instead of the object itself. This
+  matches [the behavior of
+  `JSON.stringify()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify#tojson_behavior).
+  The `.toJSON()` method is used even if the chosen database driver never
+  actually converts anything to JSON.
+* New `memory` database driver that stores values in memory only.
+
 ## v1.4.19
 
 Updated database (and other) dependencies:

package/README.md

@@ -18,6 +18,7 @@ writes are done in a bulk. This can be turned off.
 * Dirty
 * Elasticsearch
 * Maria
+* `memory`: An in-memory ephemeral database.
 * Mongo
 * MsSQL
 * MySQL

package/databases/memory_db.js

@@ -0,0 +1,41 @@
+'use strict';
+
+const AbstractDatabase = require('../lib/AbstractDatabase');
+
+exports.Database = class extends AbstractDatabase {
+  constructor(settings) {
+    super();
+    this.settings = settings;
+    settings.json = false;
+    settings.cache = 0;
+    settings.writeInterval = 0;
+    this._data = null;
+  }
+
+  get isAsync() { return true; }
+
+  close() {
+    this._data = null;
+  }
+
+  findKeys(key, notKey) {
+    const regex = this.createFindRegex(key, notKey);
+    return [...this._data.keys()].filter((k) => regex.test(k));
+  }
+
+  get(key) {
+    return this._data.get(key);
+  }
+
+  init() {
+    this._data = new Map();
+  }
+
+  remove(key) {
+    this._data.delete(key);
+  }
+
+  set(key, value) {
+    this._data.set(key, value);
+  }
+};

package/index.js

@@ -153,10 +153,12 @@ exports.Database = class {
   }
 };
 
-const clone = (obj) => {
+const clone = (obj, key = '') => {
   // Handle the 3 simple types, and null or undefined
   if (null == obj || 'object' !== typeof obj) return obj;
 
+  if (typeof obj.toJSON === 'function') return clone(obj.toJSON(key));
+
   // Handle Date
   if (obj instanceof Date) {
     const copy = new Date();
@@ -168,7 +170,7 @@ const clone = (obj) => {
   if (obj instanceof Array) {
     const copy = [];
     for (let i = 0, len = obj.length; i < len; ++i) {
-      copy[i] = clone(obj[i]);
+      copy[i] = clone(obj[i], String(i));
     }
     return copy;
   }
@@ -177,7 +179,7 @@ const clone = (obj) => {
   if (obj instanceof Object) {
     const copy = {};
     for (const attr in obj) {
-      if (Object.prototype.hasOwnProperty.call(obj, attr)) copy[attr] = clone(obj[attr]);
+      if (Object.prototype.hasOwnProperty.call(obj, attr)) copy[attr] = clone(obj[attr], attr);
     }
     return copy;
   }

package/package.json

@@ -57,7 +57,7 @@
     "url": "https://github.com/ether/ueberDB.git"
   },
   "main": "./index",
-  "version": "1.4.19",
+  "version": "2.0.1",
   "bugs": {
     "url": "https://github.com/ether/ueberDB/issues"
   },

package/test/lib/databases.js

@@ -1,6 +1,7 @@
 'use strict';
 
 exports.databases = {
+  memory: {},
   dirty: {
     filename: '/tmp/ueberdb-test.db',
     speeds: {

package/test/test_tojson.js

@@ -0,0 +1,40 @@
+'use strict';
+
+const assert = require('assert').strict;
+const ueberdb = require('../index');
+const util = require('util');
+
+describe(__filename, function () {
+  let db = null;
+
+  before(async function () {
+    const udb = new ueberdb.Database('memory', {}, {});
+    db = {};
+    for (const fn of ['init', 'close', 'set', 'get']) db[fn] = util.promisify(udb[fn].bind(udb));
+    await db.init();
+  });
+
+  after(async function () {
+    await db.close();
+  });
+
+  it('no .toJSON method', async function () {
+    await db.set('key', {prop: 'value'});
+    assert.deepEqual(await db.get('key'), {prop: 'value'});
+  });
+
+  it('direct', async function () {
+    await db.set('key', {toJSON: (arg) => `toJSON ${arg}`});
+    assert.equal(await db.get('key'), 'toJSON ');
+  });
+
+  it('object property', async function () {
+    await db.set('key', {prop: {toJSON: (arg) => `toJSON ${arg}`}});
+    assert.deepEqual(await db.get('key'), {prop: 'toJSON prop'});
+  });
+
+  it('array entry', async function () {
+    await db.set('key', [{toJSON: (arg) => `toJSON ${arg}`}]);
+    assert.deepEqual(await db.get('key'), ['toJSON 0']);
+  });
+});