alchemymvc 1.1.9 → 1.2.1

package/lib/class/migration.js

@@ -0,0 +1,138 @@
+const libpath = alchemy.use('path');
+
+/**
+ * Migrations
+ *
+ * @constructor
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    1.2.0
+ * @version  1.2.0
+ */
+const Migration = Function.inherits('Alchemy.Base', function Migration(document) {
+	this.document = document;
+});
+
+/**
+ * Start the necesary migrations
+ *
+ * @constructor
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    1.2.0
+ * @version  1.2.0
+ */
+Migration.setStatic(async function start() {
+
+	const AlchemyMigration = Model.get('AlchemyMigration');
+
+	console.log('Starting migration task...');
+
+	let dir = new Classes.Alchemy.Inode.Directory(libpath.resolve(PATH_APP, 'migrations'));
+
+	await dir.loadContents();
+
+	for (let entry of dir) {
+
+		let name = entry.name.beforeLast('.js');
+
+		if (!name) {
+			continue;
+		}
+
+		let crit = AlchemyMigration.find();
+		crit.where('name').equals(name);
+
+		let record = await AlchemyMigration.find('first', crit);
+
+		if (record) {
+			if (record.ended) {
+				console.log(' »» Migration "' + name + '" already finished on ' + record.ended.format('Y-m-d H:i'));
+			} else if (record.error) {
+				console.log(' »» Migration "' + name + '" failed with error: ' + record.error);
+				console.log('Migrations stopped');
+				return;
+			} else {
+				console.log(' »» Migration "' + name + '" has not yet finished!');
+				console.log('Migrations stopped');
+				return;
+			}
+
+			continue;
+		}
+
+		record = AlchemyMigration.createDocument();
+		record.name = name;
+		record.path = entry.path;
+
+		await record.save();
+
+		try {
+
+			console.log(' »» Starting migration "' + name + '"');
+
+			let migration = new Migration(record);
+
+			await Blast.require(entry.path, {
+				client: false,
+				async : true,
+				arguments: {
+					names  : [
+						'Blast',
+						'Collection',
+						'Bound',
+						'Obj',
+						'Fn',
+						'migration'
+					],
+					values : [
+						Blast,
+						Blast.Collection,
+						Blast.Bound,
+						Blast.Bound.Object,
+						Blast.Collection.Function,
+						migration,
+					]
+				}
+			});
+
+			record.ended = new Date();
+			await record.save();
+
+		} catch (err) {
+			console.log(' »» Migration error:', err);
+			record.error = err.message + '\n' + err.stack;
+			await record.save();
+			console.log('Migrations stopped');
+			return;
+		}
+	}
+
+	console.log('Executed all migrations');
+});
+
+/**
+ * Migrate methods
+ *
+ * @constructor
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    1.2.0
+ * @version  1.2.0
+ */
+Migration.setMethod(function processRecords(model_name, fnc) {
+
+	const model = Model.get(model_name);
+
+	let options = {
+		document       : false,
+		parallel_limit : 1,
+	};
+
+	return model.eachRecord(options, async (record, index, next) => {
+		await fnc(model, record[model_name], index);
+		next();
+	}, (err) => {
+		// Done!
+	});
+});

package/lib/class/model.js

@@ -800,7 +800,7 @@ Model.setMethod(function ensureIds(list, callback) {
  *
  * @author   Jelle De Loecker   <jelle@develry.be>
  * @since    0.0.1
- * @version  1.1.0
+ * @version  1.2.0
  *
  * @param    {Document}   document
  * @param    {Object}     options
@@ -853,7 +853,14 @@ Model.setMethod(function saveRecord(document, options, callback) {
 	}, function doBeforeSave(next) {
 
 		if (typeof that.beforeSave == 'function') {
-			that.beforeSave(document, options, next);
+			let promise = that.beforeSave(document, options, next);
+
+			if (promise) {
+				Pledge.done(promise, next);
+			} else if (that.beforeSave.length < 3) {
+				// If the method accepts no `next` callback, call it now
+				next();
+			}
 		} else {
 			next();
 		}
@@ -1133,21 +1140,6 @@ Model.setMethod(function processDatasourceFormat(ds_data, options, callback) {
 	return pledge;
 });
 
-/**
- * Get a field instance from the schema
- *
- * @author   Jelle De Loecker   <jelle@develry.be>
- * @since    0.2.0
- * @version  0.2.0
- *
- * @param    {String}   name   The name of the field
- *
- * @return   {FieldType}
- */
-Model.setMethod(function getField(name) {
-	return this.schema.getField(name);
-});
-
 /**
  * Get the title to display for this record
  *
@@ -1317,7 +1309,7 @@ Model.setMethod(function remove(id, callback) {
  *
  * @author   Jelle De Loecker <jelle@develry.be>
  * @since    0.5.0
- * @version  1.0.5
+ * @version  1.2.0
  *
  * @param    {Object}    options    Find options
  * @param    {Function}  task       Task to perform on each record
@@ -1382,7 +1374,7 @@ Model.setMethod(function eachRecord(options, task, callback) {
 
 			var record_index = index++;
 
-			last_id = record[that.primary_key];
+			last_id = record[that.model_name][that.primary_key];
 
 			tasks.push(function doSave(next) {
 				pledge.reportProgress(((record_index - 1) / available) * 100);

package/lib/class/schema.js

@@ -184,7 +184,7 @@ Schema.setMethod(function eachAlternateIndex(data, fnc) {
  *
  * @author   Jelle De Loecker   <jelle@develry.be>
  * @since    1.1.0
- * @version  1.1.0
+ * @version  1.2.0
  *
  * @return   {Pledge}
  */
@@ -192,20 +192,24 @@ Schema.setMethod(function getDatasource() {
 
 	var that = this;
 
-	return Function.parallel(function waitForModelClass(next) {
-		that.afterOnce('has_model_class', function hasModelClass() {
-			next();
-		});
+	return Function.series(function waitForModelClass(next) {
+		that.afterOnce('has_model_class', next);
 	}, function waitForDatasources(next) {
 
 		alchemy.sputnik.after('datasources', function afterDs() {
 
-			var datasource = Datasource.get(that.model_class.prototype.dbConfig);
+			let datasource;
 
-			if (!datasource) {
-				console.log('Failed to get', that.model_class.prototype.dbConfig, 'datasource?');
-				return next(new Error('Could not get datasource "' + that.model_class.prototype.dbConfig + '"'));
-			}
+			if (that.model_class) {
+				datasource = Datasource.get(that.model_class.prototype.dbConfig);
+
+				if (!datasource) {
+					console.log('Failed to get', that.model_class.prototype.dbConfig, 'datasource?');
+					return next(new Error('Could not get datasource "' + that.model_class.prototype.dbConfig + '"'));
+				}
+			} else {
+				return next(new Error('Unable to get datasource for this sub-schema'));
+			}		
 
 			next(null, datasource);
 		});
@@ -218,8 +222,6 @@ Schema.setMethod(function getDatasource() {
 
 		return result[1];
 	});
-
-	return pledge;
 });
 
 /**

package/lib/core/client_alchemy.js

@@ -1066,4 +1066,18 @@ Alchemy.setMethod(function syncDataWithServer() {
 	});
 
 	return Function.parallel(tasks);
+});
+
+/**
+ * Create a new schema on the client
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    1.2.1
+ * @version  1.2.1
+ *
+ * @param    {*}   parent
+ */
+Alchemy.setMethod(function createSchema(parent) {
+	let schema = new Classes.Alchemy.Client.Schema(parent);
+	return schema;
 });

package/lib/core/socket.js

@@ -1,160 +1,160 @@
-'use strict';
-
-var types     = alchemy.shared('Socket.types'),
-    iostream,
-    path      = alchemy.use('path'),
-    fs        = alchemy.use('fs');
-
-/**
- * The "socket" stage:
- * 
- * Create the socket.io listener
- *
- * @author        Jelle De Loecker   <jelle@develry.be>
- * @since         0.1.0
- * @version       1.1.3
- */
-alchemy.sputnik.add(function socket() {
-
-	var clientPath,
-	    streamPath,
-	    io;
-
-	if (!alchemy.settings.websockets) {
-		log.info('Websockets have been disabled');
-		return;
-	} else {
-		if (alchemy.settings.websockets == 'optional') {
-			log.info('Websockets have been enabled optionally');
-		} else {
-			log.info('Websockets have been enabled, clients will automatically connect');
-		}
-	}
-
-	io = alchemy.use('socket.io');
-
-	if (!io) {
-		return log.error('Could not load socket.io!');
-	}
-
-	iostream = alchemy.use('socket.io-stream');
-
-	// Create the Socket.io listener
-	alchemy.io = io.listen(alchemy.server, {serveClient: false});
-
-	// Get the core client path
-	clientPath = path.dirname(alchemy.findModule('socket.io-client').module_path);
-	clientPath = path.resolve(clientPath, '..', 'dist', 'socket.io.slim.js');
-
-	// Get the stream client path
-	streamPath = path.dirname(alchemy.findModule('socket.io-stream').module_path);
-	streamPath = path.resolve(streamPath, 'socket.io-stream.js');
-
-	// Serve the socket io core file
-	Router.use('/scripts/socket.io.js', function getSocketIo(req, res, next) {
-		alchemy.minifyScript(clientPath, function gotMinifiedPath(err, mpath) {
-			req.conduit.serveFile(mpath || clientPath);
-		});
-	});
-
-	// Serve the socket io stream file
-	Router.use('/scripts/socket.io-stream.js', function getSocketStream(req, res, next) {
-		alchemy.minifyScript(streamPath, function gotMinifiedPath(err, mpath) {
-			req.conduit.serveFile(mpath || streamPath);
-		});
-	});
-
-	/**
-	 * Handle connections
-	 *
-	 * @author   Jelle De Loecker   <jelle@develry.be>
-	 * @since    0.0.1
-	 * @version  0.2.0
-	 */
-	alchemy.io.sockets.on('connection', function onConnect(socket){
-
-		var syncs = {},
-		    latencies = [],
-		    latency_avg = 2,
-		    offset = 0;
-
-		socket.on('timesync', function gotTimesyncRequest(data) {
-
-			var received = Date.now(),
-			    latency;
-
-			// This is the initial request
-			if (data.count == null) {
-				data.count = 0;
-				data.latency_trip = 0;
-
-				// Reset the latencies array
-				latencies.length = 0;
-			}
-
-			// Do 8 round trips to determine latency
-			if (data.latency_trip <= 8) {
-
-				if (data.last_sent) {
-
-					// Latency is the timestamp when we received the response
-					// minus the timestamp when we sent the request
-					latency = received - data.last_sent;
-					latencies.push(latency);
-				}
-
-				// Wait before responding
-				setTimeout(function waitForLatency() {
-					data.last_sent = Date.now();
-					socket.emit('timesync', data);
-				}, 100 + (data.latency_trip * 150));
-
-				data.latency_trip++;
-			} else if (data.latency_trip) {
-
-				latency_avg = ~~(Math.median(latencies) / 2);
-				offset = (received - latency_avg) - data.client_time;
-
-				socket.emit('timesync', {offset: offset, latency: latency_avg});
-			}
-		});
-
-		// Wait for the announcement
-		socket.once('announce', function gotAnnouncement(data) {
-
-			var SocketClass,
-			    class_name;
-
-			// Try getting the socket class of this type
-			if (typeof data.type == 'string') {
-				class_name = data.type.classify();
-				SocketClass = Classes.Alchemy.Conduit[class_name + 'Socket'];
-			}
-
-			// If no socket class was found get the regular class
-			if (!SocketClass) {
-				SocketClass = Classes.Alchemy.Conduit.Socket;
-			}
-
-			new SocketClass(socket, data);
-		});
-	});
-});
-
-/**
- * Connect to another alchemy instance
- *
- * @author        Jelle De Loecker   <jelle@develry.be>
- * @since         0.1.0
- * @version       0.4.0
- */
-Alchemy.setMethod(function callServer(address, data, callback) {
-
-	var server = new Classes.ClientSocket();
-
-	server.reconnect = false;
-
-	server.connect(address, data, callback);
-
-	return server;
+'use strict';
+
+var types     = alchemy.shared('Socket.types'),
+    iostream,
+    path      = alchemy.use('path'),
+    fs        = alchemy.use('fs');
+
+/**
+ * The "socket" stage:
+ * 
+ * Create the socket.io listener
+ *
+ * @author        Jelle De Loecker   <jelle@develry.be>
+ * @since         0.1.0
+ * @version       1.1.3
+ */
+alchemy.sputnik.add(function socket() {
+
+	var clientPath,
+	    streamPath,
+	    io;
+
+	if (!alchemy.settings.websockets) {
+		log.info('Websockets have been disabled');
+		return;
+	} else {
+		if (alchemy.settings.websockets == 'optional') {
+			log.info('Websockets have been enabled optionally');
+		} else {
+			log.info('Websockets have been enabled, clients will automatically connect');
+		}
+	}
+
+	io = alchemy.use('socket.io');
+
+	if (!io) {
+		return log.error('Could not load socket.io!');
+	}
+
+	iostream = alchemy.use('socket.io-stream');
+
+	// Create the Socket.io listener
+	alchemy.io = io.listen(alchemy.server, {serveClient: false});
+
+	// Get the core client path
+	clientPath = path.dirname(alchemy.findModule('socket.io-client').module_path);
+	clientPath = path.resolve(clientPath, '..', 'dist', 'socket.io.slim.js');
+
+	// Get the stream client path
+	streamPath = path.dirname(alchemy.findModule('@11ways/socket.io-stream').module_path);
+	streamPath = path.resolve(streamPath, 'socket.io-stream.js');
+
+	// Serve the socket io core file
+	Router.use('/scripts/socket.io.js', function getSocketIo(req, res, next) {
+		alchemy.minifyScript(clientPath, function gotMinifiedPath(err, mpath) {
+			req.conduit.serveFile(mpath || clientPath);
+		});
+	});
+
+	// Serve the socket io stream file
+	Router.use('/scripts/socket.io-stream.js', function getSocketStream(req, res, next) {
+		alchemy.minifyScript(streamPath, function gotMinifiedPath(err, mpath) {
+			req.conduit.serveFile(mpath || streamPath);
+		});
+	});
+
+	/**
+	 * Handle connections
+	 *
+	 * @author   Jelle De Loecker   <jelle@develry.be>
+	 * @since    0.0.1
+	 * @version  0.2.0
+	 */
+	alchemy.io.sockets.on('connection', function onConnect(socket){
+
+		var syncs = {},
+		    latencies = [],
+		    latency_avg = 2,
+		    offset = 0;
+
+		socket.on('timesync', function gotTimesyncRequest(data) {
+
+			var received = Date.now(),
+			    latency;
+
+			// This is the initial request
+			if (data.count == null) {
+				data.count = 0;
+				data.latency_trip = 0;
+
+				// Reset the latencies array
+				latencies.length = 0;
+			}
+
+			// Do 8 round trips to determine latency
+			if (data.latency_trip <= 8) {
+
+				if (data.last_sent) {
+
+					// Latency is the timestamp when we received the response
+					// minus the timestamp when we sent the request
+					latency = received - data.last_sent;
+					latencies.push(latency);
+				}
+
+				// Wait before responding
+				setTimeout(function waitForLatency() {
+					data.last_sent = Date.now();
+					socket.emit('timesync', data);
+				}, 100 + (data.latency_trip * 150));
+
+				data.latency_trip++;
+			} else if (data.latency_trip) {
+
+				latency_avg = ~~(Math.median(latencies) / 2);
+				offset = (received - latency_avg) - data.client_time;
+
+				socket.emit('timesync', {offset: offset, latency: latency_avg});
+			}
+		});
+
+		// Wait for the announcement
+		socket.once('announce', function gotAnnouncement(data) {
+
+			var SocketClass,
+			    class_name;
+
+			// Try getting the socket class of this type
+			if (typeof data.type == 'string') {
+				class_name = data.type.classify();
+				SocketClass = Classes.Alchemy.Conduit[class_name + 'Socket'];
+			}
+
+			// If no socket class was found get the regular class
+			if (!SocketClass) {
+				SocketClass = Classes.Alchemy.Conduit.Socket;
+			}
+
+			new SocketClass(socket, data);
+		});
+	});
+});
+
+/**
+ * Connect to another alchemy instance
+ *
+ * @author        Jelle De Loecker   <jelle@develry.be>
+ * @since         0.1.0
+ * @version       0.4.0
+ */
+Alchemy.setMethod(function callServer(address, data, callback) {
+
+	var server = new Classes.ClientSocket();
+
+	server.reconnect = false;
+
+	server.connect(address, data, callback);
+
+	return server;
 });