Changed update() method to take the arguments as an object.

Author: roundhill

src/simperium/bucket.js

@@ -150,7 +150,7 @@ export default function Bucket( name, storeProvider, channel ) {
 	this.onChannelIndex = this.emit.bind( this, 'index' );
 	this.onChannelError = this.emit.bind( this, 'error' );
 	this.onChannelUpdate = ( id, data, original, patch, isIndexing ) => {
-		this.update( id, data, original, patch, isIndexing, { sync: false } );
+		this.update( { id, data, original, patch, isIndexing }, { sync: false } );
 	};
 
 	this.onChannelIndexingStateChange = ( isIndexing ) => {
@@ -209,13 +209,13 @@ Bucket.prototype.reload = function() {
  * Stores an object in the bucket and syncs it to simperium. Generates an
  * object ID to represent the object in simperium.
  *
- * @param {Object} object - plain js object literal to be saved/synced
+ * @param {Object} data - plain js object literal to be saved/synced
  * @param {?bucketStoreGetCallback} callback - runs when object has been saved
  * @return {Promise<Object>} data stored in the bucket
  */
-Bucket.prototype.add = function( object, callback ) {
+Bucket.prototype.add = function( data, callback ) {
 	var id = uuid();
-	return this.update( id, object, null, null, null, null, callback );
+	return this.update( { id, data }, callback );
 };
 
 /**
@@ -232,17 +232,18 @@ Bucket.prototype.get = function( id, callback ) {
 /**
  * Update the bucket object of `id` with the given data.
  *
- * @param {String} id - the bucket id for the object to update
- * @param {Object} data - object literal to replace the object data with
- * @param {Object} original - the original object before the udpate
- * @param {Object} patch - the JSONDiff patch to apply to the object
- * @param {Boolean} isIndexing - true if the bucket is currently indexing
+ * @param {Object} args - the function arguments
+ * @param {String} [args.id] - the bucket id for the object to update
+ * @param {Object} [args.data] - object literal to replace the object data with
+ * @param {Object} [args.original] - the original object before the udpate
+ * @param {Object} [args.patch] - the JSONDiff patch to apply to the object
+ * @param {Boolean} [args.isIndexing] - true if the bucket is currently indexing
  * @param {Object} [options] - optional settings
  * @param {Boolean} [options.sync=true] - false if object should not be synced with this update
  * @param {?bucketStoreGetCallback} callback - executed when object is updated localy
  * @returns {Promise<Object>} - update data
  */
-Bucket.prototype.update = function( id, data, original, patch, isIndexing, options, callback ) {
+Bucket.prototype.update = function( { id, data, original, patch, isIndexing = false }, options, callback ) {
 	if ( typeof options === 'function' ) {
 		callback = options;
 		options = { sync: true };
@@ -306,7 +307,7 @@ Bucket.prototype.getVersion = function( id, callback ) {
  */
 Bucket.prototype.touch = function( id, callback ) {
 	const task = this.storeAPI.get( id )
-		.then( object => this.update( object.id, object.data ) );
+		.then( object => this.update( { id: object.id, data: object.data } ) );
 
 	return deprecateCallback( callback, task );
 };

test/simperium/bucket_test.js

@@ -37,23 +37,23 @@ describe( 'Bucket', () => {
 
 	it( 'should store object update callback', ( done ) => {
 		const id = 'thing',
-			object = {one: 'two'};
+			data = {one: 'two'};
 
-		bucket.update( id, object, null, null, null, function() {
+		bucket.update( { id, data }, function() {
 			bucket.get( id, function( err, savedObject ) {
-				deepEqual( object, savedObject );
+				deepEqual( data, savedObject );
 				done();
 			} );
 		} );
 	} );
 
 	it( 'should update with options callback', ( done ) => {
 		const id = 'thing',
-			object = {one: 'two'}
+			data = {one: 'two'}
 
-		bucket.update( id, object, null, null, null, {}, function() {
+		bucket.update( { id, data }, function() {
 			bucket.get( id, function( err, savedObject ) {
-				deepEqual( object, savedObject );
+				deepEqual( data, savedObject );
 				done();
 			} )
 		} )

test/simperium/channel_test.js

@@ -108,7 +108,8 @@ describe( 'Channel', function() {
 				done();
 			} );
 
-			bucket.update( '12345', {content: 'Hola mundo!'} );
+			const updateArgs = {id: '12345', data: {content: 'Hola mundo!'}}
+			bucket.update( updateArgs );
 		} );
 
 		it( 'should not send a change with an empty diff', function( done ) {
@@ -121,7 +122,7 @@ describe( 'Channel', function() {
 					channel.once( 'unmodified', function() {
 						done();
 					} );
-					bucket.update( 'thing', data );
+					bucket.update( {id: 'thing', data} );
 				} );
 		} );
 
@@ -131,21 +132,21 @@ describe( 'Channel', function() {
 				checkSent = function() {
 					throw new Error( 'Sent too many changes' );
 				},
-				objectId = '123456';
+				id = '123456';
 
 			channel.on( 'send', fn.counts( 1, checkSent ) );
 
 			channel.on( 'send', function() {
-				bucket.update( objectId, data2 );
+				bucket.update( { id, data: data2 } );
 			} )
 
 			channel.localQueue.on( 'wait', function( id ) {
 				equal( id, objectId );
 				done();
 			} );
 
-			objectId = '123456';
-			bucket.update( objectId, data );
+			const objectId = '123456';
+			bucket.update( {id: objectId, data} );
 		} );
 
 		it( 'should acknowledge sent change', function( done ) {
@@ -160,7 +161,7 @@ describe( 'Channel', function() {
 				acknowledge( channel, msg );
 			} );
 
-			bucket.update( 'mock-id', data );
+			bucket.update( { id: 'mock-id', data } );
 		} );
 
 		it( 'should ignore duplicate change error if nothing to acknowledge', ( done ) => {
@@ -225,13 +226,14 @@ describe( 'Channel', function() {
 
 			channel.localQueue.on( 'wait', validate );
 
+			const id = '123';
 			channel.once( 'send', function() {
-				bucket.update( '123', {title: 'hello again world'} );
-				bucket.remove( '123' );
+				bucket.update( {id, data: {title: 'hello again world'}} );
+				bucket.remove( id );
 			} );
 
 			store.put( '123', 3, {title: 'hello world'} ).then( function() {
-				bucket.update( '123', {title: 'goodbye world'} );
+				bucket.update( {id, data: {title: 'goodbye world'}} );
 			} );
 		} );
 
@@ -266,7 +268,7 @@ describe( 'Channel', function() {
 				}, reject );
 			} );
 
-			bucket.update( key, {title: 'hello world'}, null, null, null, function() {
+			bucket.update( {id: key, data: {title: 'hello world'}}, function() {
 				channel.handleMessage( 'c:' + JSON.stringify( [{
 					o: '-', ev: 1, cv: 'cv1', id: key
 				}] ) );
@@ -319,8 +321,9 @@ describe( 'Channel', function() {
 				} );
 			} );
 
-			store.put( '123', 3, {title: 'hello world'} ).then( function() {
-				bucket.update( '123', {title: 'goodbye world!!'} );
+			const id = '123';
+			store.put( id, 3, {title: 'hello world'} ).then( function() {
+				bucket.update( {id, data: {title: 'goodbye world!!'}} );
 			} );
 		} );
 
@@ -352,7 +355,7 @@ describe( 'Channel', function() {
 			}] ) );
 
 			// We're changing "Hello world" to "Goodbye world"
-			bucket.update( key, {title: 'Goodbye world'} );
+			bucket.update( {id: key, data: {title: 'Goodbye world'}} );
 		} ) );
 
 		it( 'should emit errors on the bucket instance', ( done ) => {
@@ -426,7 +429,7 @@ describe( 'Channel', function() {
 					acknowledge( channel, msg );
 				} );
 
-				bucket.update( 'mock-id', data );
+				bucket.update( {id: 'mock-id', data} );
 			} );
 
 			it( 'should get version', ( done ) => {

test/simperium/default_storage_test.js

@@ -14,7 +14,7 @@ describe( 'default store', () => {
 		const id = 'thing',
 			data = {one: 'two'};
 
-		return bucket.update( id, data )
+		return bucket.update( {id, data} )
 			.then( () => bucket.get( id ) )
 			.then( ( object ) => {
 				deepEqual( object, { data, id } );
@@ -25,7 +25,7 @@ describe( 'default store', () => {
 		const id = 'thing',
 			data = {one: 'two'}
 
-		return bucket.update( id, data )
+		return bucket.update( {id, data} )
 			.then( () => bucket.get( id ) )
 			.then( ( object ) => {
 				deepEqual( object, { data, id } );