From f38709b7cb3c5866f9602b450622203e3dcd3cdb Mon Sep 17 00:00:00 2001
From: Simon Ho <simonho@ca.ibm.com>
Date: Fri, 30 Dec 2016 17:27:49 -0800
Subject: [PATCH] Add flush operation to KVAO

Used to delete all keys (and values) associated to the current model.
---
 lib/connectors/kv-memory.js |  6 ++++++
 lib/kvao/flush.js           | 30 ++++++++++++++++++++++++++++++
 lib/kvao/index.js           |  1 +
 test/kvao/flush.suite.js    | 26 ++++++++++++++++++++++++++
 4 files changed, 63 insertions(+)
 create mode 100644 lib/kvao/flush.js
 create mode 100644 test/kvao/flush.suite.js

diff --git a/lib/connectors/kv-memory.js b/lib/connectors/kv-memory.js
index 98cd009e..d49d8c15 100644
--- a/lib/connectors/kv-memory.js
+++ b/lib/connectors/kv-memory.js
@@ -201,6 +201,12 @@ KeyValueMemoryConnector.prototype.disconnect = function(callback) {
   process.nextTick(callback);
 };
 
+KeyValueMemoryConnector.prototype.flush =
+function(modelName, options, callback) {
+  this._store = Object.create(null);
+  callback();
+};
+
 function StoreItem(value, ttl) {
   this.value = value;
   this.setTtl(ttl);
diff --git a/lib/kvao/flush.js b/lib/kvao/flush.js
new file mode 100644
index 00000000..1b6568fb
--- /dev/null
+++ b/lib/kvao/flush.js
@@ -0,0 +1,30 @@
+'use strict';
+
+var assert = require('assert');
+var utils = require('../utils');
+
+/**
+ * Delete all keys (and values) associated to the current model.
+ *
+ * @options {Object} options Unused ATM, placeholder for future options.
+ * @callback {Function} callback
+ * @param {Error} err Error object.
+ * @promise
+ *
+ * @header KVAO.prototype.flush(options, cb)
+ */
+module.exports = function flush(options, callback) {
+  if (callback == undefined && typeof options === 'function') {
+    callback = options;
+    options = {};
+  } else if (!options) {
+    options = {};
+  }
+
+  assert(typeof options === 'object', 'options must be an object');
+
+  callback = callback || utils.createPromiseCallback();
+
+  this.getConnector().flush(this.modelName, options, callback);
+  return callback.promise;
+};
diff --git a/lib/kvao/index.js b/lib/kvao/index.js
index ebdd6478..24a85dcb 100644
--- a/lib/kvao/index.js
+++ b/lib/kvao/index.js
@@ -8,6 +8,7 @@ module.exports = KeyValueAccessObject;
 KeyValueAccessObject.get = require('./get');
 KeyValueAccessObject.set = require('./set');
 KeyValueAccessObject.expire = require('./expire');
+KeyValueAccessObject.flush = require('./flush');
 KeyValueAccessObject.ttl = require('./ttl');
 KeyValueAccessObject.iterateKeys = require('./iterate-keys');
 KeyValueAccessObject.keys = require('./keys');
diff --git a/test/kvao/flush.suite.js b/test/kvao/flush.suite.js
new file mode 100644
index 00000000..cbb79132
--- /dev/null
+++ b/test/kvao/flush.suite.js
@@ -0,0 +1,26 @@
+'use strict';
+
+const bdd = require('../helpers/bdd-if');
+const helpers = require('./_helpers');
+const should = require('should');
+
+module.exports = function(dataSourceFactory, connectorCapabilities) {
+  var supportsFlushOperation =
+    connectorCapabilities.supportsFlushOperation !== false;
+
+  bdd.describeIf(supportsFlushOperation, 'flush', function() {
+    let CacheItem;
+    beforeEach(function unpackContext() {
+      CacheItem = helpers.givenCacheItem(dataSourceFactory);
+    });
+
+    it('removes all associated keys for a given model', function() {
+      return helpers.givenKeys(CacheItem, ['key1', 'key2'])
+        .then(() => CacheItem.flush())
+        .then(() => CacheItem.keys())
+        .done((keys) => {
+          should(keys).eql([]);
+        });
+    });
+  });
+};