node-barefoot/lib/server/datastore-mixin.js

Barefoot makes code sharing between browser and server reality. Write your application once and run it on both ends of the wire.

/** Mixin: Barefoot.DataStore.Server
 * This mixin contains client specific code for the <Barefoot.DataStore>
 * component.
 *
 * Code for serializing the <DataStore> on the server is contained here.
 *
 * See also:
 * * <Barefoot.DataStore>
 * * <Barefoot.DataStore.Client>
 */
var _ = require('underscore')
	, debug = require('debug')('barefoot:server:datastore');

/** Function: toJSON
 * Serializes all models and collections of this DataStore into a plain
 * JavaScript object.
 *
 * Beside the actual data, this object contains meta information to accomplish
 * a proper deserialization with <Barefoot.DataStore.Client.parse>. This means,
 * the DataStore can completely restore its content from a given serialized
 * version of itself, including correct model and collection types.
 *
 * Please make sure you registered all model and collection types with
 * <Barefoot.DataStore.registerModel> and
 * <Barefoot.DataStore.registerCollection>. Otherwise parse will throw an error
 * as soon as it tries to deserialize such an object.
 *
 * Returns:
 *     (Object) A serialized version of this DataStore
 */
function toJSON() {
	var self = this
		, keys = self.keys()
		, serializedStore = {};

	_.each(keys, function(key) {
		var modelOrCollection = self.get(key)
			, jsonRepresentation = modelOrCollection.toJSON()
			, identifier = self.findRegisteredIdentifier.call(
				self, modelOrCollection);

		if(identifier) {
				var serializedData = {
					dataStoreModelIdentifier: identifier
					, data: jsonRepresentation
				};

			serializedStore[key] = serializedData;
		} else {
			throw new Error('Could not serialize DataStore because ' +
				'a required modelOrCollection was not registered before!');
		}

	});

	debug('to json `%j`', serializedStore);

	return serializedStore;
}


module.exports = {
	toJSON: toJSON
	, parse: function(){}
};