alchemymvc 1.3.20 → 1.3.22

package/lib/app/helper_model/model.js

@@ -49,7 +49,7 @@ Model.constitute(function setModelName() {
  *
  * @author   Jelle De Loecker   <jelle@elevenways.be>
  * @since    1.2.5
- * @version  1.2.5
+ * @version  1.3.22
  */
 Model.mapEventToMethod({
 	saved          : 'afterSave',
@@ -58,6 +58,7 @@ Model.mapEventToMethod({
 	associated     : 'afterAssociated',
 	found          : 'afterData',
 	foundDocuments : 'afterFind',
+	removed        : 'afterRemove',
 });
 
 /**
@@ -629,7 +630,7 @@ Model.setMethod(function getAliasModel(alias) {
  *
  * @author   Jelle De Loecker   <jelle@elevenways.be>
  * @since    0.0.1
- * @version  1.3.8
+ * @version  1.3.21
  *
  * @param    {String}     type       The type of find (first, all)
  * @param    {Criteria}   criteria   The criteria object
@@ -797,6 +798,27 @@ Model.setMethod(function find(type, criteria, callback) {
 				next();
 			}
 		});
+	}, function recomputeAfterFind(next) {
+
+		if (!that.schema.has_recompute_after_find || criteria.options.document === false) {
+			return next();
+		}
+
+		let tasks = [];
+
+		for (let document of records) {
+			tasks.push((next) => {
+				let promise = document.recomputeValues();
+
+				if (!promise) {
+					return next();
+				}
+
+				Pledge.done(promise, next);
+			});
+		}
+
+		Function.parallel(8, tasks, next);
 	}, function done(err) {
 
 		var i;
@@ -1773,7 +1795,7 @@ Model.setMethod(function compose(data, options) {
  *
  * @author   Jelle De Loecker   <jelle@elevenways.be>
  * @since    0.2.0
- * @version  1.3.20
+ * @version  1.3.21
  *
  * @param    {Document}   document
  * @param    {Object}     options
@@ -1786,10 +1808,17 @@ Model.setMethod(function createRecord(document, options, callback) {
 	// Normalize & clone the data, set default values, ...
 	let data = this.compose(document, options);
 
-	// Turn it into a new document
-	document = this.createDocument(data);
+	document = createDocumentForSaving(this, document, data);
+
+	Function.series(function recompute(next) {
+		let result = document.recomputeValues();
 
-	Function.series(function doBeforeValidate(next) {
+		if (result) {
+			result.done(next);
+		} else {
+			next();
+		}
+	}, function doBeforeValidate(next) {
 		that.callOrNext('beforeValidate', [document, options], next);
 	}, function validate(next) {
 
@@ -1823,12 +1852,35 @@ Model.setMethod(function createRecord(document, options, callback) {
 	})
 });
 
+/**
+ * Create a document used for saving
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    1.3.21
+ * @version  1.3.21
+ *
+ * @param    {Model}             model
+ * @param    {Document|Object}   original_input
+ * @param    {Object}            data
+ */
+function createDocumentForSaving(model, original_input, data) {
+
+	// Turn it into a new document
+	let document = model.createDocument(data);
+
+	if (original_input?.$attributes.original_record) {
+		document.$attributes.original_record = original_input.$attributes.original_record;
+	}
+
+	return document;
+}
+
 /**
  * Update a record in the database
  *
  * @author   Jelle De Loecker   <jelle@elevenways.be>
  * @since    0.2.0
- * @version  1.3.20
+ * @version  1.3.21
  *
  * @param    {Document}   document
  * @param    {Object}     options
@@ -1842,9 +1894,17 @@ Model.setMethod(function updateRecord(document, options, callback) {
 	let data = this.compose(document, Object.assign({update: true}, options));
 
 	// Turn it into a new document
-	document = this.createDocument(data);
+	document = createDocumentForSaving(this, document, data);
+
+	Function.series(function recompute(next) {
+		let result = document.recomputeValues();
 
-	Function.series(function doBeforeValidate(next) {
+		if (result) {
+			result.done(next);
+		} else {
+			next();
+		}
+	}, function doBeforeValidate(next) {
 		that.callOrNext('beforeValidate', [document, options], next);
 	}, function validate(next) {
 

package/lib/class/conduit.js

@@ -1578,7 +1578,7 @@ Conduit.setMethod(function redirect(status, options) {
  *
  * @author   Jelle De Loecker   <jelle@elevenways.be>
  * @since    0.2.0
- * @version  1.3.16
+ * @version  1.3.21
  *
  * @param    {Nulber}  status       Response statuscode
  * @param    {Error}   message      Optional error to send
@@ -1613,7 +1613,7 @@ Conduit.setMethod(function error(status, message, print_error) {
 	if (alchemy.settings.environment == 'dev') {
 		print_dev = true;
 
-		if (is_400 && this.original_path.indexOf('.js.map') > -1) {
+		if (is_400 && this.original_path && this.original_path.indexOf('.js.map') > -1) {
 			print_dev = false;
 			print_error = false;
 		}
@@ -1806,6 +1806,10 @@ Conduit.setMethod(function end(message) {
 
 	if (typeof message !== 'string') {
 
+		if (message && message instanceof Classes.Stream.Stream) {
+			return this._endWithStream(message);
+		}
+
 		// Use regular JSON if DRY has been disabled in settings
 		if (alchemy.settings.json_dry_response === false || this.json_dry === false) {
 			json_type = 'json';
@@ -1878,12 +1882,29 @@ Conduit.setMethod(function end(message) {
 	this._end(message, 'utf-8');
 });
 
+/**
+ * End with a stream
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    1.3.22
+ * @version  1.3.22
+ */
+Conduit.setMethod(function _endWithStream(stream) {
+
+	this.ended = new Date();
+	this.emit('ending');
+
+	this.flushHeaders();
+
+	stream.pipe(this.response);
+});
+
 /**
  * Call the actual end method
  *
  * @author   Jelle De Loecker   <jelle@elevenways.be>
  * @since    0.2.0
- * @version  1.3.14
+ * @version  1.3.22
  */
 Conduit.setMethod(function _end(message, encoding = 'utf-8') {
 
@@ -1906,18 +1927,42 @@ Conduit.setMethod(function _end(message, encoding = 'utf-8') {
 		return;
 	}
 
-	let headers = [],
-	    value,
-	    key;
+	// Set the content-length if it hasn't been set yet
+	if (arguments.length > 0 && !this.response_headers['content-length']) {
+		this.response_headers['content-length'] = Buffer.byteLength(message);
+	}
+
+	this.flushHeaders();
+
+	if (arguments.length === 0) {
+		return this.response.end();
+	}
+
+	// End the response
+	return this.response.end(message, encoding);
+});
+
+/**
+ * Flush the headers
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    1.3.22
+ * @version  1.3.22
+ */
+Conduit.setMethod(function flushHeaders() {
+
+	if (this._flushed) {
+		return;
+	}
+
+	this._flushed = true;
 
 	if (this.status) {
 		this.response.statusCode = this.status;
 	}
 
-	// Set the content-length if it hasn't been set yet
-	if (arguments.length > 0 && !this.response_headers['content-length']) {
-		this.response_headers['content-length'] = Buffer.byteLength(message);
-	}
+	let value,
+	    key;
 
 	for (key in this.response_headers) {
 		value = this.response_headers[key];
@@ -1935,13 +1980,6 @@ Conduit.setMethod(function _end(message, encoding = 'utf-8') {
 
 	// Write the actual headers
 	this.response.writeHead(this.status);
-
-	if (arguments.length === 0) {
-		return this.response.end();
-	}
-
-	// End the response
-	return this.response.end(message, encoding);
 });
 
 /**

package/lib/class/document.js

@@ -178,6 +178,33 @@ Document.setStatic(function unDry(obj, cloned) {
 	return result;
 });
 
+/**
+ * Set the getter for this computed field
+ *
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    1.3.21
+ * @version  1.3.21
+ *
+ * @param    {String}     name     Name of the property
+ * @param    {Function}   getter   Optional getter function
+ * @param    {Function}   setter   Optional setter function
+ */
+Document.setStatic(function setComputedFieldGetter(name) {
+	this.setProperty(name, function getComputedFieldValue() {
+		this.recomputeFieldIfNecessary(name);
+		return this.$main[name];
+	}, function setComputedFieldValue(value) {
+
+		const field = this.$model.schema.getField(name);
+
+		if (field?.options?.allow_manual_set) {
+			return this.$main[name] = value;
+		}
+
+		console.error('Can not set computed field "' + name + '" to', value);
+	});
+});
+
 /**
  * Set the getter for this field
  *

package/lib/class/field.js

@@ -207,6 +207,116 @@ Field.setProperty(function is_array() {
 	return !!result;
 });
 
+/**
+ * Does this field have a computed value?
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    1.3.21
+ * @version  1.3.21
+ *
+ * @type     {Boolean}
+ */
+Field.setProperty(function is_computed() {
+	return !!this.options.is_computed;
+});
+
+/**
+ * Get the required related fields
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    1.3.21
+ * @version  1.3.21
+ *
+ * @type     {Field[]}
+ */
+Field.enforceProperty(function required_fields(new_value) {
+
+	if (!new_value) {
+		new_value = resolveFieldPaths(this, this.options.required_fields);
+	}
+
+	return new_value;
+});
+
+/**
+ * Get the optional related fields
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    1.3.21
+ * @version  1.3.21
+ *
+ * @type     {Field[]}
+ */
+Field.enforceProperty(function optional_fields(new_value) {
+
+	if (!new_value) {
+		new_value = resolveFieldPaths(this, this.options.optional_fields);
+	}
+
+	return new_value;
+});
+
+/**
+ * Get all the dependency fields
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    1.3.21
+ * @version  1.3.21
+ *
+ * @type     {Field[]}
+ */
+Field.enforceProperty(function dependency_fields(new_value) {
+
+	if (!new_value) {
+		let required_fields = this.required_fields,
+		    optional_fields = this.optional_fields;
+
+		new_value = [];
+
+		if (required_fields) {
+			new_value = new_value.concat(required_fields);
+		}
+
+		if (optional_fields) {
+			new_value = new_value.concat(optional_fields);
+		}
+	}
+
+	return new_value;
+});
+
+/**
+ * Resolve a field path to a field instance
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    1.3.21
+ * @version  1.3.21
+ */
+function resolveFieldPaths(field, field_paths) {
+	
+	let result = [],
+	    i;
+
+	if (!field_paths) {
+		return result;
+	}
+
+	for (i = 0; i < field_paths.length; i++) {
+
+		if (!field.parent_schema) {
+			continue
+		}
+
+		let other_field = field.parent_schema.getField(field_paths[i]);
+
+		if (other_field && result.indexOf(other_field) == -1) {
+			result.push(other_field);
+		}
+	}
+
+	return result;
+}
+
 /**
  * The datasource this field is used in
  *

package/lib/class/inode_file.js

@@ -338,4 +338,29 @@ File.setMethod(function readString(encoding) {
 	}
 
 	return this.read({encoding: encoding});
+});
+
+/**
+ * Write the given data to the file
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    1.3.22
+ * @version  1.3.22
+ */
+File.setMethod(function overwrite(contents, options = {}) {
+
+	let pledge = new Pledge();
+
+	options.flag = 'w';
+
+	fs.writeFile(this.path, contents, options, function done(err) {
+
+		if (err) {
+			return pledge.reject(err);
+		}
+
+		pledge.resolve();
+	});
+
+	return pledge;
 });

package/lib/class/model.js

@@ -366,24 +366,49 @@ Model.setStatic(async function checkPathValue(value, name, field_name, conduit)
 	return result;
 });
 
+/**
+ * Add a computed field to this model's schema
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    1.3.21
+ * @version  1.3.21
+ *
+ * @return   {Alchemy.Field}
+ */
+Model.setStatic(function addComputedField(name, type, options) {
+	let is_new = !this.schema.has(name);
+
+	// Add it to the schema
+	let field = this.schema.addComputedField(name, type, options);
+
+	if (is_new) {
+		// Add it to the Document class
+		this.Document.setComputedFieldGetter(name);
+
+		// False means it should not be set on the server implementation
+		// (because that's where it's coming from)
+		// Yes, this also sets private fields on the server-side client document.
+		this.ClientDocument.setComputedFieldGetter(name, null, null, false);
+	}
+
+	return field;
+});
+
 /**
  * Add a field to this model's schema
  *
  * @author   Jelle De Loecker   <jelle@develry.be>
  * @since    0.2.0
- * @version  1.2.4
+ * @version  1.2.21
  *
  * @return   {Alchemy.Field}
  */
 Model.setStatic(function addField(name, type, options) {
 
-	var field,
-	    is_new;
-
-	is_new = !this.schema.has(name);
+	let is_new = !this.schema.has(name);
 
 	// Add it to the schema
-	field = this.schema.addField(name, type, options);
+	let field = this.schema.addField(name, type, options);
 
 	if (is_new) {
 		// Add it to the Document class
@@ -1262,7 +1287,7 @@ Model.setMethod(async function executeMongoPipeline(pipeline) {
  *
  * @author   Jelle De Loecker   <jelle@develry.be>
  * @since    0.0.1
- * @version  1.0.7
+ * @version  1.3.22
  *
  * @param   {String}     id        The object id
  * @param   {Function}   callback
@@ -1288,17 +1313,51 @@ Model.setMethod(function remove(id, callback) {
 		id = String(id);
 	}
 
-	let query = {};
-	query[this.primary_key] = id;
+	let query = {
+		[this.primary_key] : id,
+	};
+
+	let has_remove_events = typeof this.beforeRemove == 'function' || typeof this.afterRemove == 'function' || this.listeners('removed').length;
+	let doc;
+	let tasks = [];
 
-	this.datasource.remove(this, query, {}, function afterRemove(err, result) {
+	if (has_remove_events) {
+
+		// Get the actual document
+		tasks.push(async next => {
+			doc = await this.findByPk(id);
+
+			if (!doc) {
+				return next(new Error('Unable to find document with id ' + id));
+			}
 
-		if (err != null) {
-			return pledge.reject(err);
+			next();
+		});
+
+		tasks.push(next => {
+			this.callOrNext('beforeRemove', [doc], next);
+		});
+	}
+
+	Function.series(tasks, function done(err) {
+
+		if (err) {
+			pledge.reject(err);
+			return;
 		}
 
-		that.emit('removed', result, {}, false, function afterRemovedEvent() {
-			pledge.resolve(result);
+		that.datasource.remove(that, query, {}, function afterRemove(err, result) {
+
+			if (err != null) {
+				return pledge.reject(err);
+			}
+
+			if (has_remove_events) {
+				that.issueEvent('removed', [doc, result], () => pledge.resolve(result));
+			} else {
+				pledge.resolve(result);
+			}
+	
 		});
 	});
 

package/lib/class/route.js

@@ -3,7 +3,7 @@
  *
  * @author   Jelle De Loecker   <jelle@elevenways.be>
  * @since    0.2.0
- * @version  1.3.16
+ * @version  1.3.21
  */
 const Route = Function.inherits('Alchemy.Base', function Route(router, paths, options) {
 
@@ -62,6 +62,9 @@ const Route = Function.inherits('Alchemy.Base', function Route(router, paths, op
 	// All routes can be postponed by default
 	this.can_be_postponed = true;
 
+	// Possible cache instructions
+	this.cache = null;
+
 	this.setPaths(paths);
 });
 

package/lib/class/router.js

@@ -767,7 +767,7 @@ RouterClass.setMethod(function setOption(name, value) {
  *
  * @author   Jelle De Loecker   <jelle@elevenways.be>
  * @since    0.2.0
- * @version  1.3.16
+ * @version  1.3.21
  *
  * @param    {Object}   args
  * @param    {String}   args.name            Optional route name
@@ -819,6 +819,7 @@ RouterClass.setMethod(function add(args) {
 	route.setBreadcrumb(args.breadcrumb);
 	route.sitemap = args.sitemap;
 	route.title = args.title;
+	route.cache = args.cache;
 
 	if (args.visible_location != null) {
 		route.visible_location = args.visible_location;
@@ -1167,7 +1168,7 @@ RouterClass.setMethod(function getOptions(result) {
  *
  * @author   Jelle De Loecker   <jelle@elevenways.be>
  * @since    0.2.0
- * @version  1.3.16
+ * @version  1.3.21
  *
  * @param    {Object}   result   Optional object to store sectioned results in
  *
@@ -1219,6 +1220,7 @@ RouterClass.setMethod(function getRoutes(result) {
 			is_system_route            : route.is_system_route,
 			schema                     : route.schema,
 			param_definitions          : route.param_definitions,
+			cache                      : route.cache,
 		};
 	}