alchemymvc 1.3.23 → 1.4.0-alpha.10

package/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2013-2023 Jelle De Loecker <jelle@elevenways.be>
+Copyright (c) 2013-2024 Jelle De Loecker <jelle@elevenways.be>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

package/README.md

@@ -3,9 +3,9 @@
   <b>Alchemy</b>
 </h1>
 <div align="center">
-  <!-- CI - TravisCI -->
-  <a href="https://travis-ci.org/11ways/alchemy">
-    <img src="https://travis-ci.org/11ways/alchemy.svg?branch=master" alt="Mac/Linux Build Status" />
+  <!-- CI - Github Actions -->
+  <a href="https://github.com/11ways/alchemy/actions/workflows/unit_test.yaml">
+    <img src="https://github.com/11ways/alchemy/actions/workflows/unit_test.yaml/badge.svg" alt="Node.js CI (Linux, MacOS, Windows)" />
   </a>
 
   <!-- Coverage - Codecov -->

package/lib/app/assets/stylesheets/{alchemy-info.less → alchemy-info.scss}

@@ -1,3 +1,5 @@
+@use "alchemy";
+
 html {
 	font-family: sans-serif;
 	text-size-adjust: 100%;

package/lib/app/behaviour/publishable_behaviour.js

@@ -4,18 +4,16 @@
  * @constructor
  * @extends       Alchemy.Behaviour
  *
- * @author        Jelle De Loecker   <jelle@develry.be>
- * @since         0.1.0
- * @version       0.3.0
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    0.1.0
+ * @version  0.3.0
  */
-var Publish = Function.inherits('Alchemy.Behaviour', function PublishableBehaviour(model, options) {
-	PublishableBehaviour.super.call(this, model, options);
-});
+var Publish = Function.inherits('Alchemy.Behaviour', 'PublishableBehaviour');
 
 /**
  * Listen to attachments to schema's
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.0.3
  * @version  1.0.3
  *
@@ -37,7 +35,7 @@ Publish.setStatic(function attached(schema, options) {
 /**
  * Set publish options
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.1.0
  * @version  1.1.0
  *

package/lib/app/behaviour/revision_behaviour.js

@@ -8,30 +8,53 @@ var jsondiffpatch = alchemy.use('jsondiffpatch'),
  * @constructor
  * @extends       Alchemy.Behaviour
  *
- * @author        Jelle De Loecker   <jelle@develry.be>
- * @since         0.0.1
- * @version       0.2.0
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    0.0.1
+ * @version  0.2.0
  */
-var Revision = Function.inherits('Alchemy.Behaviour', function RevisionBehaviour(model, options) {
-	Behaviour.call(this, model, options);
-});
+const Revision = Function.inherits('Alchemy.Behaviour', 'RevisionBehaviour');
 
 /**
- * Get the Revision Model class for the attached model
+ * Get the Revision model class for the given main model
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
- * @since    1.0.3
- * @version  1.1.0
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    1.4.0
+ * @version  1.4.0
+ *
+ * @param    {Schema}    schema
+ * @param    {Object}    options
  */
-Revision.setProperty(function revision_model_class() {
+Revision.setStatic(function getRevisionModel(model) {
 
-	var class_name = this.model.name + 'DataRevision';
+	if (typeof model == 'function') {
+		model = model.model_name;
+	}
 
-	if (Classes.Alchemy.Model[class_name]) {
-		return Classes.Alchemy.Model[class_name];
+	if (typeof model == 'string') {
+		model = Model.get(model);
 	}
 
-	let model_class = Function.inherits('Alchemy.Model', Function.create(class_name, function DataRevision(options) {
+	if (!model) {
+		throw new Error('Unable to add Revision behaviour to undefined model');
+	}
+
+	let revision_model_name = model.model_name + 'DataRevision',
+	    revision_model;
+
+	try {
+		revision_model = Model.get(revision_model_name, false);
+	} catch (err) {
+		// Ignore
+	}
+
+	if (revision_model) {
+		return revision_model;
+	}
+	
+	let namespace = model.constructor.namespace,
+	    class_name = model.name + 'DataRevision';
+
+	let model_class = Function.inherits('Alchemy.Model', namespace, Function.create(class_name, function DataRevision(options) {
 		Model.call(this, options);
 	}));
 
@@ -42,12 +65,18 @@ Revision.setProperty(function revision_model_class() {
 		this.schema.remove('updated');
 
 		this.addField('record_id', 'ObjectId');
-		this.addField('revision', 'Number');
+		this.addField('revision', 'Integer');
 		this.addField('delta', 'Object');
 
 		if (Classes.Alchemy.Model.User) {
 			this.belongsTo('User');
 		}
+
+		// Add an index on the record_id
+		this.addIndex('record_id', {
+			unique : false,
+			sparse : false,
+		});
 	});
 
 	// Force the constitutors to load now
@@ -56,10 +85,43 @@ Revision.setProperty(function revision_model_class() {
 	return model_class;
 });
 
+/**
+ * Listen to attachments to schema's
+ *
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    1.0.3
+ * @version  1.4.0
+ *
+ * @param    {Schema}    schema
+ * @param    {Object}    options
+ */
+Revision.setStatic(function attached(schema, new_options) {
+
+	const context = schema.model_class;
+
+	// Add the revision number to the main model
+	context.addField('__r', 'Integer', {
+		title: 'Revision',
+	});
+
+	Revision.getRevisionModel(schema.model_class);
+});
+
+/**
+ * Get the Revision Model class for the attached model
+ *
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    1.0.3
+ * @version  1.4.0
+ */
+Revision.setProperty(function revision_model_class() {
+	return Revision.getRevisionModel(this.model);
+});
+
 /**
  * Get the revision model for the attached model
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.0.3
  * @version  1.0.3
  */
@@ -76,7 +138,7 @@ Revision.setProperty(function revision_model() {
 /**
  * Get the jsondiffpatch instance
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.0.3
  * @version  1.0.3
  */
@@ -122,28 +184,10 @@ Revision.setProperty(function diff_patcher() {
 	return diff_patch_instance;
 });
 
-/**
- * Listen to attachments to schema's
- *
- * @author   Jelle De Loecker   <jelle@develry.be>
- * @since    1.0.3
- * @version  1.0.3
- *
- * @param    {Schema}    schema
- * @param    {Object}    options
- */
-Revision.setStatic(function attached(schema, new_options) {
-
-	var context = schema.model_class;
-
-	// Add the revision
-	context.addField('__r', 'Number', {title: 'Revision'});
-});
-
 /**
  * Compare 2 objects
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.0.1
  * @version  1.0.3
  */
@@ -155,16 +199,16 @@ Revision.setMethod(function compare(left, right) {
  * Called before the model saves a record,
  * but after it has applied the strictFields
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.0.1
- * @version  1.0.5
+ * @version  1.4.0
  */
 Revision.setMethod(function beforeSave(record, options, creating) {
 
-	let main = record[this.model.name];
+	let main = record.$main;
 
 	if (!main) {
-		throw new Error('Unable to find main "' + this.model.name + '" data');
+		throw new Error('Unable to find main "' + this.model.model_name + '" data');
 	}
 
 	// No revision to save when creating a record
@@ -173,50 +217,54 @@ Revision.setMethod(function beforeSave(record, options, creating) {
 		return;
 	}
 
-	let that = this,
-	    next = this.wait('series');
-
-	// Find the original record
-	Model.get(that.model.name).findById(main._id, async function gotRecord(err, result) {
+	let that = this;
 
-		var ori;
+	let pledge = new Swift();
 
-		if (result) {
+	// Find the original record
+	Model.get(this.model.model_name).findById(record.$pk, function gotRecord(err, result) {
 
-			// Get the original data
-			ori = await that.model.convertRecordToDatasourceFormat(result);
+		if (err || !result) {
+			return pledge.resolve();
+		}
 
-			// Store the original data in a weakmap for later
-			revision_before.set(options, ori);
+		let conversion;
 
-			// Increase the revision count by 1
-			if (ori.__r) {
-				main.__r = ori.__r+1;
-			} else {
-				main.__r = 1;
-			}
+		try {
+			conversion = that.model.convertRecordToDatasourceFormat(result);
+		} catch (err) {
+			return pledge.reject(err);
 		}
 
-		next();
+		pledge.resolve(Swift.waterfall(
+			conversion,
+			ori => {
+				// Store the original data in a weakmap for later
+				revision_before.set(options, ori);
+
+				// Increase the revision count by 1
+				if (ori.__r) {
+					main.__r = ori.__r+1;
+				} else {
+					main.__r = 1;
+				}
+			}
+		));
 	});
+
+	return pledge;
 });
 
 /**
  * Called after the model saves a record.
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.0.1
- * @version  1.1.0
+ * @version  1.4.0
  */
 Revision.setMethod(function afterSave(record, options, created) {
 
-	var that = this,
-	    earlier_data,
-	    right,
-	    main,
-	    that,
-	    left,
-	    next;
+	let earlier_data;
 
 	if (created) {
 		earlier_data = {};
@@ -229,11 +277,13 @@ Revision.setMethod(function afterSave(record, options, created) {
 		return;
 	}
 
-	next = this.wait();
-	main = record[that.model.name] || record;
+	let doc = this.model.createDocument(record);
+	const that = this;
+
+	let pledge = new Swift();
 
 	// Find the complete saved item
-	Model.get(that.model.name).findById(main._id, async function gotRecord(err, result) {
+	Model.get(this.model.model_name).findByPk(doc.$pk, async function gotRecord(err, result) {
 
 		if (result) {
 
@@ -243,8 +293,8 @@ Revision.setMethod(function afterSave(record, options, created) {
 			if (new_data) {
 
 				// Convert the objects so they can be diffed properly
-				left = JSON.toDryObject(earlier_data);
-				right = JSON.toDryObject(new_data);
+				let left = JSON.toDryObject(earlier_data),
+				    right = JSON.toDryObject(new_data);
 
 				// Diff them
 				let delta = that.compare(left, right);
@@ -267,7 +317,7 @@ Revision.setMethod(function afterSave(record, options, created) {
 
 				// Add the delta information
 				revision_data = {
-					[that.revision_model.name] : revision_data
+					[that.revision_model.model_name] : revision_data
 				};
 
 				// Save the data
@@ -275,6 +325,8 @@ Revision.setMethod(function afterSave(record, options, created) {
 			}
 		}
 
-		next();
+		pledge.resolve();
 	});
+
+	return pledge;
 });

package/lib/app/behaviour/sluggable_behaviour.js

@@ -4,9 +4,9 @@
  * @constructor
  * @extends       Alchemy.Behaviour
  *
- * @author        Jelle De Loecker   <jelle@develry.be>
- * @since         0.1.0
- * @version       1.3.16
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    0.1.0
+ * @version  1.3.16
  */
 var Sluggable = Function.inherits('Alchemy.Behaviour', function SluggableBehaviour(model, options) {
 
@@ -37,7 +37,7 @@ var Sluggable = Function.inherits('Alchemy.Behaviour', function SluggableBehavio
 /**
  * Default slug options
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.2.0
  * @version  0.2.3
  *
@@ -53,11 +53,11 @@ Sluggable.setProperty('default_options', {
 /**
  * Get the source field
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.2.0
  * @version  0.2.0
  *
- * @param    {String}    source
+ * @param    {string}    source
  * @param    {Schema}    schema
  */
 Sluggable.setStatic(function getSource(source, schema) {
@@ -81,7 +81,7 @@ Sluggable.setStatic(function getSource(source, schema) {
 /**
  * Listen to attachments to schema's
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.2.0
  * @version  1.3.0
  *
@@ -139,13 +139,13 @@ Sluggable.setStatic(function attached(schema, new_options) {
 /**
  * The beforeSave
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.1.0
  * @version  1.0.6
  *
  * @param    {Object}    data      The data that is to be saved
  * @param    {Object}    options   Behaviour options
- * @param    {Boolean}   creating  Is this record being created?
+ * @param    {boolean}   creating  Is this record being created?
  */
 Sluggable.setMethod(async function beforeSave(data, options, creating) {
 
@@ -153,8 +153,7 @@ Sluggable.setMethod(async function beforeSave(data, options, creating) {
 	    has_new_value,
 	    old_record,
 	    new_value,
-	    old_value,
-	    next;
+	    old_value;
 
 	// Get the actual record data
 	if (data[that.model.name]) {
@@ -170,9 +169,6 @@ Sluggable.setMethod(async function beforeSave(data, options, creating) {
 		has_new_value = true;
 	}
 
-	// Let other event callbacks wait for this one
-	next = this.wait('series');
-
 	if (!creating) {
 		old_record = await this.model.findById(data._id);
 
@@ -186,7 +182,7 @@ Sluggable.setMethod(async function beforeSave(data, options, creating) {
 	// and we're not explicitly setting a new slug value,
 	// then do nothing
 	if (!creating && old_value && !has_new_value) {
-		return next();
+		return;
 	}
 
 	let new_data = {};
@@ -198,30 +194,34 @@ Sluggable.setMethod(async function beforeSave(data, options, creating) {
 		Object.assign(new_data, data);
 	}
 
+	let pledge = new Swift();
+
 	// Try creating a new slug
 	that.createSlug(new_data, new_value, function createdSlug(err, result) {
 
 		if (err) {
-			return next(err);
+			return pledge.reject(err);
 		}
 
 		if (!Object.isEmpty(result)) {
 			data[that.target_field.name] = result;
 		}
 
-		next();
+		pledge.resolve();
 	});
+
+	return pledge;
 });
 
 /**
  * Start the slug creating process
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.1.0
  * @version  1.1.0
  *
  * @param    {Object}   record
- * @param    {String}   new_value
+ * @param    {string}   new_value
  * @param    {Function} callback
  */
 Sluggable.setMethod(function createSlug(record, new_value, callback) {
@@ -295,12 +295,12 @@ Sluggable.setMethod(function createSlug(record, new_value, callback) {
  * Actually generate the slug from the given string,
  * and look for existing slugs in the path
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.1.0
  * @version  1.1.8
  *
- * @param    {String}   title
- * @param    {String}   path
+ * @param    {string}   title
+ * @param    {string}   path
  * @param    {Document} record
  * @param    {Function} callback
  */

package/lib/app/conduit/electron_conduit.js

@@ -6,12 +6,12 @@ var fs = require('fs');
  * @constructor
  * @extends       Alchemy.Conduit
  *
- * @author        Jelle De Loecker   <jelle@develry.be>
- * @since         0.2.0
- * @version       1.1.3
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    0.2.0
+ * @version  1.1.3
  *
- * @param         {Object}     request
- * @param         {Function}   callback
+ * @param    {Object}     request
+ * @param    {Function}   callback
  */
 var ElectronConduit = Function.inherits('Alchemy.Conduit', function Electron(request, callback, router) {
 
@@ -32,7 +32,7 @@ var ElectronConduit = Function.inherits('Alchemy.Conduit', function Electron(req
 	request.conduit = this;
 
 	// Allow use of the log in the views
-	if (alchemy.settings.debug) {
+	if (alchemy.settings.debugging.debug) {
 		this.internal('debuglog', {_placeholder_: 'debuglog'});
 	}
 
@@ -62,7 +62,7 @@ var ElectronConduit = Function.inherits('Alchemy.Conduit', function Electron(req
 /**
  * Create a new Hawkejs' ViewRender instance
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.2.0
  * @version  1.1.0
  */
@@ -86,7 +86,7 @@ ElectronConduit.setMethod(function setHeader(name, val) {
 /**
  * Call the actual end method
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.2.0
  * @version  1.0.0
  */
@@ -97,7 +97,7 @@ ElectronConduit.setMethod(function _end(message, encoding) {
 /**
  * Serve a file
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.2.0
  * @version  0.2.0
  */

package/lib/app/conduit/http_conduit.js

@@ -1,7 +1,7 @@
 /**
  * The Http Conduit Class
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.2.0
  * @version  1.1.3
  *
@@ -20,11 +20,11 @@ var HttpConduit = Function.inherits('Alchemy.Conduit.Conduit', function Http(req
 /**
  * Has the client aborted the request?
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.1.0
  * @version  1.1.0
  *
- * @type     {Boolean}
+ * @type     {boolean}
  */
 HttpConduit.setProperty(function aborted() {
 
@@ -38,7 +38,7 @@ HttpConduit.setProperty(function aborted() {
 /**
  * Return the IP address
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.2.0
  * @version  1.1.0
  */
@@ -84,11 +84,11 @@ HttpConduit.setProperty(function ip() {
  * Get a simple fingerprint of the client
  * based on ip, accept-language & user-agent
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.1.0
  * @version  1.1.0
  *
- * @type     {String}
+ * @type     {string}
  */
 HttpConduit.enforceProperty(function fingerprint() {
 
@@ -105,9 +105,9 @@ HttpConduit.enforceProperty(function fingerprint() {
 /**
  * Init
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.3.3
- * @version  1.3.1
+ * @version  1.4.0
  *
  * @param    {IncomingMessage}   req
  * @param    {ServerResponse}    res
@@ -133,7 +133,7 @@ HttpConduit.setMethod(async function initHttp(req, res, router) {
 		return;
 	}
 
-	if (alchemy.settings.debug || alchemy.settings.environment != 'live') {
+	if (alchemy.settings.debugging.debug || alchemy.settings.environment != 'live') {
 		this.setHeader('X-Robots-Tag', 'none');
 	}
 
@@ -151,11 +151,11 @@ HttpConduit.setMethod(async function initHttp(req, res, router) {
 /**
  * Get the original url path
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.1.0
  * @version  1.1.0
  *
- * @type     {String}
+ * @type     {string}
  */
 HttpConduit.setProperty(function original_path() {
 	return this.original_url.path;
@@ -166,11 +166,11 @@ HttpConduit.setProperty(function original_path() {
 /**
  * Get the original url pathname
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.1.0
  * @version  1.1.0
  *
- * @type     {String}
+ * @type     {string}
  */
 HttpConduit.setProperty(function original_pathname() {
 	return this.original_url.pathname;