alchemymvc 1.1.10 → 1.2.0

package/lib/app/datasource/mongo_datasource.js

@@ -228,7 +228,7 @@ Mongo.setMethod(function collection(name, callback) {
  *
  * @author   Jelle De Loecker   <jelle@develry.be>
  * @since    0.2.0
- * @version  1.1.0
+ * @version  1.2.0
  */
 Mongo.setMethod(function _read(model, criteria, callback) {
 
@@ -250,22 +250,87 @@ Mongo.setMethod(function _read(model, criteria, callback) {
 
 		if (compiled.pipeline) {
 
-			collection.aggregate(compiled.pipeline, {}, function gotAggregate(err, cursor) {
+			// Sorting should happen in the pipeline
+			if (options.sort && options.sort.length) {
+				let sort_object = {};
 
-				if (err) {
-					return callback(err);
+				for (let entry of options.sort) {
+					sort_object[entry[0]] = entry[1];
 				}
 
-				cursor.toArray(function gotArray(err, items) {
+				compiled.pipeline.unshift({$sort: sort_object});
+			}
+
+			// Skipping also happens in the pipeline
+			if (options.skip) {
+				compiled.pipeline.push({$skip: options.skip});
+			}
+
+			let aggregate_options = {};
 
-					if (err) {
-						return callback(err);
+			// Limits can still be set as an option though
+			if (options.limit) {
+				aggregate_options.limit = options.limit;
+			}
+
+			Function.parallel({
+				available: function getAvailable(next) {
+
+					if (criteria.options.available === false) {
+						return next(null, null);
 					}
 
-					items = that.organizeResultItems(model, items);
+					let pipeline = JSON.clone(compiled.pipeline),
+					    cloned_options = JSON.clone(aggregate_options);
+
+					pipeline.push({$count: 'available'});
+
+					// Expensive aggregate just to get the available count...
+					collection.aggregate(pipeline, cloned_options, function gotAggregate(err, cursor) {
+
+						if (err) {
+							return next(err);
+						}
+
+						cursor.toArray(function gotAvailableArray(err, items) {
+
+							if (err) {
+								return next(err);
+							}
+
+							if (!items || !items.length) {
+								return next(null, null);
+							}
+
+							let available = items[0].available;
+
+							if (options.skip) {
+								available += options.skip;
+							}
+
+							return next(null, available);
+						});
+					});
+				},
+				items: function getItems(next) {
+					collection.aggregate(compiled.pipeline, aggregate_options, function gotAggregate(err, cursor) {
+
+						if (err) {
+							return next(err);
+						}
+
+						cursor.toArray(next);
+					});
+				}
+			}, function done(err, data) {
+
+				if (err) {
+					return callback(err);
+				}
+
+				data.items = that.organizeResultItems(model, data.items);
 
-					callback(null, items);
-				});
+				callback(err, data.items, data.available);
 			});
 
 			return;

package/lib/app/helper_datasource/00-nosql_datasource.js

@@ -611,6 +611,15 @@ NoSQL.setMethod(function compileCriteria(criteria, group) {
 		group = criteria.group;
 	}
 
+	let getAggregate = () => {
+		if (!aggregate) {
+			aggregate = {
+				pipeline: [],
+				lookups: {}
+			};
+		}
+	}
+
 	for (i = 0; i < group.items.length; i++) {
 		entry = group.items[i];
 
@@ -620,12 +629,7 @@ NoSQL.setMethod(function compileCriteria(criteria, group) {
 		}
 
 		if (entry.association) {
-			if (!aggregate) {
-				aggregate = {
-					pipeline: [],
-					lookups: {}
-				};
-			}
+			getAggregate();
 
 			// Get the association info
 			assoc = criteria.model.getAssociation(entry.association);
@@ -705,9 +709,45 @@ NoSQL.setMethod(function compileCriteria(criteria, group) {
 			    not,
 			    obj = {};
 
+			let field_entry = {},
+			    name = entry.target_path;
+
+			// Do we need to look into an object itself?
+			// (Like the "timestamp" property of a date field when stored with units)
+			if (entry.db_property) {
+				name += '.' + entry.db_property;
+			}
+
+			if (entry.association) {
+				name = entry.association + '.' + name;
+			}
+
 			for (let i = 0; i < entry.items.length; i++) {
 				item = entry.items[i];
 
+				// If the value is a RegExp, we might have to stringify the value
+				if (shouldStringify(entry, item) && RegExp.isRegExp(item.value)) {
+
+					let stringified_field = name + '_stringified';
+
+					getAggregate();
+
+					aggregate.pipeline.push({
+						$addFields: {
+							[stringified_field]: {
+								$convert: {
+									input: '$' + name,
+									to: 'string',
+									onError: '',
+									onNull: ''
+								}
+							}
+						}
+					});
+
+					name = stringified_field;
+				}
+
 				if (item.type == 'ne') {
 					obj.$ne = item.value;
 				} else if (item.type == 'not') {
@@ -771,19 +811,6 @@ NoSQL.setMethod(function compileCriteria(criteria, group) {
 					throw new Error('Unknown criteria expression: "' + item.type + '"');
 				}
 
-				let field_entry = {},
-				    name = entry.target_path;
-
-				// Do we need to look into an object itself?
-				// (Like the "timestamp" property of a date field when stored with units)
-				if (entry.db_property) {
-					name += '.' + entry.db_property;
-				}
-
-				if (entry.association) {
-					name = entry.association + '.' + name;
-				}
-
 				if (obj && obj.$or) {
 
 					let $or = [],
@@ -870,6 +897,33 @@ NoSQL.setMethod(function compileCriteria(criteria, group) {
 	return {$and: result};
 });
 
+/**
+ * Is the given item about a string field?
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    1.2.0
+ * @version  1.2.0
+ *
+ * @param    {Object}   entry
+ * @param    {Object}   item
+ *
+ * @return   {boolean}
+ */
+function shouldStringify(entry, item) {
+
+	if (!item || !item.value) {
+		return false;
+	}
+
+	try {
+		let field = entry.model.getField(entry.target_path);
+
+		// The field value should only be stringified if it isn't a string already
+		return !(field instanceof Classes.Alchemy.Field.String);
+	} catch (err) {}
+
+	return false;
+}
 
 /**
  * Get the MongoDB options from this criteria

package/lib/app/helper_model/criteria.js

@@ -388,15 +388,26 @@ Criteria.setMethod(function clone() {
  *
  * @author   Jelle De Loecker   <jelle@develry.be>
  * @since    1.1.0
- * @version  1.1.0
+ * @version  1.2.0
  *
- * @return   {Array}
+ * @return   {String[]}
  */
 Criteria.setMethod(function getFieldsToSelect() {
 
-	var result = this.options.select.fields || [];
+	let result;
 
-	return result;
+	if (this.options.select.fields && this.options.select.fields.length) {
+		result = this.options.select.fields.slice(0);
+	}
+
+	// Fields can sometimes be required for a query (like in a join) but they
+	// won't be selected if other fields are explicitly set.
+	// So in that case: add these special fields to the projection
+	if (result && this.options.select.query_fields && this.options.select.query_fields) {
+		result.push(...this.options.select.query_fields);
+	}
+
+	return result || [];
 });
 
 /**
@@ -663,7 +674,7 @@ Criteria.setMethod(function page(page, page_size) {
  *
  * @author   Jelle De Loecker   <jelle@develry.be>
  * @since    1.1.0
- * @version  1.1.3
+ * @version  1.2.0
  *
  * @param    {String|Array}   field
  *
@@ -681,12 +692,6 @@ Criteria.setMethod(function select(field) {
 		}
 	} else {
 
-		if (typeof field == 'object') {
-			if (field instanceof Classes.Alchemy.Criteria.FieldConfig || field.name) {
-				field = field.name;
-			}
-		}
-
 		if (this._select) {
 			context = this._select.parse(field);
 		} else {
@@ -1383,7 +1388,7 @@ Select.setMethod(Blast.checksumSymbol, function toChecksum() {
  *
  * @author   Jelle De Loecker   <jelle@develry.be>
  * @since    1.1.0
- * @version  1.1.0
+ * @version  1.2.0
  *
  * @param    {String}   name
  *
@@ -1419,9 +1424,39 @@ Select.setMethod(function addAssociation(name) {
 		this.associations[name].association_name = name;
 	}
 
+	// Get the association data
+	try {
+		let info = this.criteria.model.getAssociation(name);
+
+		if (info) {
+			// Make sure the localkey is added to the resultset
+			this.requireFieldForQuery(info.options.localKey);
+		}
+	} catch (err) {
+		console.warn('Failed to find "' + name + '" association for ' + this.criteria.model.modelName);
+	}
+
 	return this.associations[name];
 });
 
+/**
+ * Require a field for query purposes
+ *
+ * @author   Jelle De Loecker   <jelle@develry.be>
+ * @since    1.2.0
+ * @version  1.2.0
+ *
+ * @param    {String}   path
+ */
+Select.setMethod(function requireFieldForQuery(path) {
+
+	if (!this.query_fields) {
+		this.query_fields = [];
+	}
+
+	this.query_fields.push(path);
+});
+
 /**
  * Add a field
  *
@@ -1445,17 +1480,33 @@ Select.setMethod(function addField(path) {
  *
  * @author   Jelle De Loecker   <jelle@develry.be>
  * @since    1.1.0
- * @version  1.1.0
+ * @version  1.2.0
  *
- * @param    {String}   path
+ * @param    {String|Object}   path
  *
  * @return   {Criteria|Null}   A criteria object if the context has changed
  */
 Select.setMethod(function parse(path) {
 
-	var context,
+	let context,
 	    select = this,
-	    parsed = Criteria.parsePath(path, this.criteria);
+	    parsed;
+
+	if (typeof path == 'object' && path && path.name) {
+
+		if (path.path) {
+			path = path.path;
+		} else {
+			let obj = path;
+			path = obj.name;
+
+			if (obj.association) {
+				path = obj.association + '.' + path;
+			}
+		}
+	}
+
+	parsed = Criteria.parsePath(path, this.criteria);
 
 	// Associations were found,
 	// like "Comment._id" or "Comment.User"
@@ -1470,7 +1521,7 @@ Select.setMethod(function parse(path) {
 				continue;
 			}
 
-			select = this.addAssociation(name);
+			select = select.addAssociation(name);
 		}
 	}
 
@@ -1489,7 +1540,7 @@ Select.setMethod(function parse(path) {
  *
  * @author   Jelle De Loecker   <jelle@develry.be>
  * @since    1.1.0
- * @version  1.1.0
+ * @version  1.2.0
  *
  * @param    {Criteria}   criteria
  *
@@ -1507,6 +1558,10 @@ Select.setMethod(function cloneForCriteria(criteria) {
 		clone.fields = this.fields.slice(0);
 	}
 
+	if (this.query_fields && this.query_fields.length) {
+		clone.query_fields = this.query_fields.slice(0);
+	}
+
 	if (this.associations) {
 		let key;
 

package/lib/app/helper_model/field_config.js

@@ -7,7 +7,7 @@
  *
  * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.1.3
- * @version  1.1.7
+ * @version  1.2.0
  * 
  * @param    {string}   path
  * @param    {Object}   options
@@ -20,6 +20,9 @@ const FieldConfig = Fn.inherits('Alchemy.Base', 'Alchemy.Criteria', function Fie
 	// The full path to the value
 	this.path = null;
 
+	// The local path to the value (subfields)
+	this.local_path = null;
+
 	// The pieces of the path
 	this.pieces = null;
 
@@ -89,7 +92,7 @@ FieldConfig.setMethod(function toDry() {
  *
  * @author   Jelle De Loecker   <jelle@elevenways.be>
  * @since    1.1.3
- * @version  1.1.4
+ * @version  1.2.0
  *
  * @return   {Object}
  */
@@ -97,6 +100,7 @@ FieldConfig.setMethod(function toJSON() {
 	return {
 		name        : this.name,
 		path        : this.path,
+		local_path  : this.local_path,
 		association : this.association,
 		options     : this.options,
 	};
@@ -107,7 +111,7 @@ FieldConfig.setMethod(function toJSON() {
  *
  * @author   Jelle De Loecker   <jelle@elevenways.be>
  * @since    1.1.3
- * @version  1.1.3
+ * @version  1.2.0
  *
  * @param    {string}   path
  */
@@ -120,6 +124,7 @@ FieldConfig.setMethod(function parsePath(path) {
 	} else if (path.indexOf('.') == -1) {
 		this.name = path;
 		this.path = path;
+		this.local_path = path;
 		this.pieces = [path];
 		return;
 	} else {
@@ -132,13 +137,27 @@ FieldConfig.setMethod(function parsePath(path) {
 
 	this.path = path;
 	this.pieces = pieces;
+	this.local_path = '';
 
 	for (i = 0; i < pieces.length; i++) {
 		piece = pieces[i];
 
-		if (i == 0 && piece[0].isUpperCase()) {
-			this.association = piece;
+		if (piece[0].isUpperCase()) {
+
+			if (this.association) {
+				this.association += '.';
+			} else {
+				this.association = '';
+			}
+
+			this.association += piece;
 			continue;
+		} else {
+			if (this.local_path) {
+				this.local_path += '.';
+			}
+
+			this.local_path += piece;
 		}
 	}
 

package/lib/app/helper_model/model.js

@@ -403,7 +403,7 @@ Model.setMethod(function getFindOptions(options) {
  *
  * @author   Jelle De Loecker   <jelle@develry.be>
  * @since    1.1.0
- * @version  1.1.0
+ * @version  1.2.0
  *
  * @param    {String}   alias
  *
@@ -415,7 +415,30 @@ Model.setMethod(function getAssociation(alias) {
 		throw new Error('Unable to find ' + this.constructor.name + ' schema associations');
 	}
 
-	let config = this.schema.associations[alias];
+	let config;
+
+	// @TODO: Test nested association getting
+	if (alias && alias.indexOf('.') > -1) {
+		let pieces = alias.split('.'),
+		    context = this,
+		    piece,
+		    temp;
+
+		for (piece of pieces) {
+			temp = context.getAssociation(piece);
+
+			if (!temp) {
+				break;
+			}
+
+			context = this.getModel(temp.modelName);
+		}
+
+		// The config s the last association gotten
+		config = temp;
+	} else {
+		config = this.schema.associations[alias];
+	}
 
 	if (!config) {
 		throw new Error('Unable to find ' + JSON.stringify(alias) + ' association in ' + this.constructor.name + ' model');
@@ -1401,15 +1424,30 @@ Model.setProperty(function associations() {
  *
  * @author   Jelle De Loecker   <jelle@develry.be>
  * @since    1.0.0
- * @version  1.1.0
+ * @version  1.2.0
  *
- * @param    {String}   name   The name of the field
+ * @param    {string}   path   The path to the field
  *
  * @return   {Object}
  */
-Model.setMethod(function getField(name) {
-	return this.schema.getField(name);
-}, false);
+Model.setMethod(function getField(path) {
+
+	if (path.indexOf('.') > -1) {
+		let config = new Classes.Alchemy.Criteria.FieldConfig(path);
+
+		// If part of the path is an association, look for that now
+		if (config.association) {
+			let association = this.getAssociation(config.association);
+			let model = this.getModel(association.modelName);
+			return model.getField(config.local_path);
+		}
+
+		// If not, just use the local_path
+		path = config.local_path;
+	}
+
+	return this.schema.getField(path);
+});
 
 // Make this class easily available
 Hawkejs.Model = Model;

package/lib/app/model/alchemy_migration_model.js

@@ -0,0 +1,33 @@
+/**
+ * The Alchemy Migration Model class
+ *
+ * @constructor
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    1.2.0
+ * @version  1.2.0
+ */
+const AlchemyMigration = Function.inherits('Alchemy.Model.App', 'AlchemyMigration');
+
+/**
+ * Constitute the class wide schema
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    1.2.0
+ * @version  1.2.0
+ */
+AlchemyMigration.constitute(function addTaskFields() {
+
+	// The name of the migration
+	this.addField('name', 'String');
+
+	// The full path of the file
+	this.addField('path', 'String');
+
+	// When the migration ended
+	this.addField('ended', 'Datetime');
+
+	// Was there an error?
+	this.addField('error', 'String');
+
+});

package/lib/bootstrap.js

@@ -61,6 +61,15 @@ require('./core/base');
  */
 require('./core/client_base');
 
+/**
+ * The migration class
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    1.2.0
+ * @version  1.2.0
+ */
+require('./class/migration');
+
 var hawkejs_options = {
 	server : false,
 	make_commonjs: true,

package/lib/class/datasource.js

@@ -165,7 +165,7 @@ Datasource.setMethod(function getSchema(schema) {
  *
  * @author   Jelle De Loecker   <jelle@develry.be>
  * @since    0.2.0
- * @version  1.1.0
+ * @version  1.2.0
  *
  * @param    {Schema|Model}   schema
  * @param    {Object}         data
@@ -187,7 +187,7 @@ Datasource.setMethod(function toDatasource(schema, data, callback) {
 	}
 
 	if (!schema) {
-		log.todo('Schema not found: not normalizing data');
+		log.todo('Schema not found: not normalizing data', data);
 		pledge = Pledge.resolve(data);
 		pledge.done(callback);
 		return pledge;

package/lib/class/field.js

@@ -594,7 +594,7 @@ Field.setMethod(function castCondition(value, field_paths) {
  *
  * @author   Jelle De Loecker   <jelle@develry.be>
  * @since    0.5.0
- * @version  1.0.7
+ * @version  1.2.0
  *
  * @param    {Mixed}   value
  * @param    {Array}   field_paths   The path to the field
@@ -602,6 +602,12 @@ Field.setMethod(function castCondition(value, field_paths) {
  * @return   {Mixed}
  */
 Field.setMethod(function _castCondition(value, field_paths) {
+
+	// Always allow regex values, we'll use those in the projection stage
+	if (value && RegExp.isRegExp(value)) {
+		return value;
+	}
+
 	return this.cast(value, true);
 });