Merge pull request #62 from bjornstar/1.0.0-beta.5

1.0.0-beta.5 - 2017-02-07

Author: bjornstar

.jshintrc

@@ -0,0 +1,3 @@
+{
+  "proto": true
+}

HISTORY.md

@@ -1,10 +1,14 @@
 #Tomes Release Notes
 
+##1.0.0-beta.5
+ * Tomes now have a destroy method
+ * Add .jshintrc and run on tests
+
 ##1.0.0-beta.4
  * Update `README.md` to fix first link
 
 ##1.0.0-beta.3
- * Update `README.md` to point to this fork.
+ * Update `README.md` to point to this fork
 
 ##1.0.0-beta.2
  * Tomes now have an unTome method

README.md

@@ -102,6 +102,9 @@ Get all change operations from the Tome
 ###merge( *diff* )
 Applies a change operation or an array of change operations to a Tome.
 
+###destroy( )
+Makes the tome and all of it's sub-tomes emit destroy. Does not delete anything.
+
 ###unTome( )
 Returns a regular javascript version of your Tome.
 

index.js

@@ -630,6 +630,10 @@ Tome.prototype.unTome = function () {
 	return Tome.unTome(this);
 };
 
+Tome.prototype.destroy = function () {
+	return Tome.destroy(this);
+};
+
 Tome.prototype.set = function (key, val) {
 
 	// We use this to set a property on a Tome to the specified value. This can

package.json

@@ -1,13 +1,13 @@
 {
     "name": "@bjornstar/tomes",
     "description": "Evented Storage Agnostic Data API",
-    "version": "1.0.0-beta.4",
+    "version": "1.0.0-beta.5",
     "author": "Bjorn Stromberg <[email protected]>",
     "maintainers": [
         { "name": "Bjorn Stromberg", "email": "[email protected]" }
     ],
     "scripts": {
-        "test": "node test"
+        "test": "jshint index.js && node test"
     },
     "main": "index.js",
     "devDependencies": {

test/modules/destroy.js

@@ -0,0 +1,59 @@
+var Tome = require('../..');
+
+exports.testSelfDestroy = function (test) {
+  test.expect(5);
+
+  var a = { b: { c: 1 }, d: { e: 1} };
+  var b = Tome.conjure(a);
+
+  function fail() {
+    test.ok();
+  }
+
+  function ok() {
+    test.ok(true);
+  }
+
+  b.on('readable', fail);
+
+  b.on('destroy', ok);
+  b.b.on('destroy', ok);
+  b.b.c.on('destroy', ok);
+  b.d.on('destroy', ok);
+  b.d.e.on('destroy', ok);
+
+  b.destroy();
+  // Calling a 2nd time shouldn't have any effect.
+  b.destroy();
+
+  test.done();
+};
+
+exports.testTomeDestroy = function (test) {
+  test.expect(5);
+
+  var a = { b: { c: 1 }, d: { e: 1} };
+  var b = Tome.conjure(a);
+
+  function fail() {
+    test.ok();
+  }
+
+  function ok() {
+    test.ok(true);
+  }
+
+  b.on('readable', fail);
+
+  b.on('destroy', ok);
+  b.b.on('destroy', ok);
+  b.b.c.on('destroy', ok);
+  b.d.on('destroy', ok);
+  b.d.e.on('destroy', ok);
+
+  Tome.destroy(b);
+  // Calling a 2nd time shouldn't have any effect.
+  Tome.destroy(b);
+
+  test.done();
+};