alchemymvc 1.3.22 → 1.4.0-alpha.2

package/lib/class/model.js

@@ -9,51 +9,90 @@ var nameCache   = {},
  *
  * @constructor
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.0.1
  * @version  1.1.0
  */
-var Model = Function.inherits('Alchemy.Base', 'Alchemy.Model', function Model(options) {
+const Model = Function.inherits('Alchemy.Base', 'Alchemy.Model', function Model(options) {
 	this.init(options);
 });
 
+/**
+ * This is a wrapper class
+ */
+Model.makeAbstractClass();
+
+/**
+ * This wrapper class starts a new group
+ */
+Model.startNewGroup();
+
 /**
  * Set the modelName property after class creation
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.2.0
- * @version  1.1.0
+ * @version  1.4.0
  */
-Model.constitute(function setModelName() {
-	this.model_name = this.name;
-	this.setProperty('model_name', this.model_name);
+Model.postInherit(function setModelName() {
+
+	let base_name = this.name;
+	let model_name = base_name;
+	let table_prefix = this.table_prefix;
+	let namespace = this.namespace;
+
+	if (namespace.startsWith('Alchemy.Model.') || namespace == 'Alchemy.Model') {
+		namespace = namespace.slice(14);
+	} else if (namespace.startsWith('Alchemy.Client.Model.') || namespace == 'Alchemy.Client.Model') {
+		namespace = namespace.slice(21);
+	}
+
+	this.setStatic('model_namespace', namespace, false);
 
-	if (!this.table) {
-		this.table = this.model_name.tableize();
+	let ns = namespace.replaceAll('.', '_');
+	
+	if (!table_prefix && ns) {
+		table_prefix = ns.tableize();
+	}
+
+	if (ns) {
+		model_name = ns + '_' + model_name;
 	}
+
+	// The simple name of the model
+	this.model_name = model_name;
+	this.setProperty('model_name', model_name);
+
+	let table_name = base_name.tableize();
+
+	if (table_prefix) {
+		table_name = table_prefix + '_' + table_name;
+	}
+
+	this.table = table_name;
 });
 
 /**
  * This is a model constructor
  *
- * @type {Boolean}
+ * @type     {boolean}
  */
 Model.setStaticProperty('model', true);
 
 /**
  * The cache duration static getter/setter
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.1.0
  * @version  1.0.3
  *
  * @property cache_duration
- * @type     {String}
+ * @type     {string}
  */
 Model.setStaticProperty(function cache_duration() {
 
 	if (this._cache_duration == null) {
-		this._cache_duration = alchemy.settings.model_query_cache_duration;
+		this._cache_duration = alchemy.settings.data_management.model_query_cache_duration;
 	}
 
 	return this._cache_duration;
@@ -66,7 +105,7 @@ Model.setStaticProperty(function cache_duration() {
 /**
  * Get the cache object
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.1.0
  * @version  1.0.3
  *
@@ -94,11 +133,11 @@ Model.setStaticProperty(function cache() {
 /**
  * Is this an abstract model?
  *
- * @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}
  */
 Model.setStaticProperty(function is_abstract() {
 
@@ -130,11 +169,10 @@ Model.setStaticProperty(function is_abstract() {
 	return field_count < 1;
 });
 
-
 /**
  * Get the document class constructor
  *
- * @type   {Alchemy.Document}
+ * @type     {Alchemy.Document}
  */
 Model.prepareStaticProperty('Document', function getDocumentClass() {
 	return Classes.Alchemy.Document.Document.getDocumentClass(this);
@@ -143,7 +181,7 @@ Model.prepareStaticProperty('Document', function getDocumentClass() {
 /**
  * Get the client document class constructor
  *
- * @type   {Hawkejs.Document}
+ * @type     {Hawkejs.Document}
  */
 Model.prepareStaticProperty('ClientDocument', function getClientDocumentClass() {
 	return this.Document.getClientDocumentClass();
@@ -154,7 +192,7 @@ Model.prepareStaticProperty('ClientDocument', function getClientDocumentClass()
  *
  * @version  1.1.0
  *
- * @type   {Schema}
+ * @type     {Schema}
  */
 Model.staticCompose('schema', function createSchema(doNext) {
 
@@ -171,7 +209,7 @@ Model.staticCompose('schema', function createSchema(doNext) {
 		schema.setModel(model);
 
 		// Set the schema name
-		schema.setName(model.name);
+		schema.setName(model.model_name);
 
 		if (model.prototype.add_basic_fields !== false) {
 
@@ -206,28 +244,28 @@ Model.setDeprecatedProperty('displayField', 'display_field');
 /**
  * The default database config to use
  *
- * @type {String}
+ * @type     {string}
  */
 Model.setProperty('dbConfig', 'default');
 
 /**
  * The default field to use as display
  *
- * @type {String}
+ * @type     {string}
  */
 Model.setProperty('display_field', 'title');
 
 /**
  * Translate is on by default
  *
- * @type {Boolean}
+ * @type     {boolean}
  */
 Model.setProperty('translate', true);
 
 /**
  * Set the name of the primary key field
  *
- * @author   Jelle De Loecker <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.1.0
  * @version  0.1.0
  */
@@ -236,7 +274,7 @@ Model.setProperty('primary_key', '_id');
 /**
  * Should we load the schema from the database?
  *
- * @author   Jelle De Loecker <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.1.0
  * @version  1.1.0
  */
@@ -245,14 +283,14 @@ Model.setProperty('load_external_schema', false);
 /**
  * Object where behaviours are stored
  *
- * @type {Object}
+ * @type     {Object}
  */
 Model.prepareProperty('behaviours', Object);
 
 /**
  * Associations
  *
- * @type {Object}
+ * @type     {Object}
  */
 Model.setProperty(function associations() {
 	return this.schema.associations;
@@ -261,7 +299,7 @@ Model.setProperty(function associations() {
 /**
  * Instance access to static cache
  *
- * @type {Expirable}
+ * @type     {Expirable}
  */
 Model.prepareProperty('cache', function cache() {
 	return this.constructor.cache;
@@ -270,7 +308,7 @@ Model.prepareProperty('cache', function cache() {
 /**
  * Instance access to static schema
  *
- * @type   {Schema}
+ * @type     {Schema}
  */
 Model.setProperty(function schema() {
 	return this.constructor.schema;
@@ -279,26 +317,16 @@ Model.setProperty(function schema() {
 /**
  * Is this an abstract model?
  *
- * @type   {Boolean}
+ * @type     {boolean}
  */
 Model.setProperty(function is_abstract() {
 	return this.constructor.is_abstract;
 });
 
-/**
- * This is a wrapper class
- */
-Model.makeAbstractClass();
-
-/**
- * This wrapper class starts a new group
- */
-Model.startNewGroup();
-
 /**
  * The connection
  *
- * @type {Object}
+ * @type     {Object}
  */
 Model.prepareProperty('datasource', function datasource() {
 	if (this.table) return Datasource.get(this.dbConfig);
@@ -307,7 +335,7 @@ Model.prepareProperty('datasource', function datasource() {
 /**
  * The default sort options
  *
- * @type {Object}
+ * @type     {Object}
  */
 Model.prepareProperty('sort', function sort() {
 	return {[this.primary_key]: -1};
@@ -316,13 +344,13 @@ Model.prepareProperty('sort', function sort() {
 /**
  * Check a url value
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.0.0
  * @version  1.2.5
  *
- * @param    {String}   value       The value in the url
- * @param    {String}   name        The name of the url parameter
- * @param    {String}   field_name  The name of the field to check
+ * @param    {string}   value       The value in the url
+ * @param    {string}   name        The name of the url parameter
+ * @param    {string}   field_name  The name of the field to check
  * @param    {Conduit}  conduit     The optional conduit
  *
  * @return   {Pledge}
@@ -369,7 +397,7 @@ Model.setStatic(async function checkPathValue(value, name, field_name, conduit)
 /**
  * Add a computed field to this model's schema
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.3.21
  * @version  1.3.21
  *
@@ -397,7 +425,7 @@ Model.setStatic(function addComputedField(name, type, options) {
 /**
  * Add a field to this model's schema
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.2.0
  * @version  1.2.21
  *
@@ -423,11 +451,21 @@ Model.setStatic(function addField(name, type, options) {
 	return field;
 });
 
+/**
+ * Set the wanted table prefix
+ *
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    1.4.0
+ * @version  1.4.0
+ */
+Model.setStatic(function setTablePrefix(prefix) {
+	this.setStatic('table_prefix', prefix);
+});
 
 /**
  * Add a behaviour to this model
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.2.0
  * @version  0.2.0
  */
@@ -439,7 +477,7 @@ Model.setStatic(function addBehaviour(behaviour_name, options) {
  * Add an association to this model's schema
  * and set it on the Document as a getter
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.2.0
  * @version  1.2.4
  */
@@ -456,7 +494,7 @@ Model.setStatic(function addAssociation(type, alias, model_name, options) {
 /**
  * Set a method on the document class
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.2.0
  * @version  1.0.6
  */
@@ -477,7 +515,7 @@ Model.setStatic(function setDocumentMethod(name, fnc) {
 /**
  * Set a property on the document class
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.2.0
  * @version  1.0.6
  */
@@ -494,7 +532,7 @@ Model.setStatic(function setDocumentProperty(name, fnc) {
 /**
  * Get a field
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.2.0
  * @version  0.2.0
  *
@@ -532,22 +570,24 @@ Model.setStatic(function getField(name) {
  * Get the model's public configuration
  * (This is used to create the client-side Model instances)
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.0.0
  * @version  1.3.1
  */
 Model.setStatic(function getClientConfig() {
 
 	const result = {
-		name          : this.model_name,
-		schema        : this.schema,
-		primary_key   : this.prototype.primary_key,
-		display_field : this.prototype.display_field,
-		ancestors     : 0,
+		class_name      : this.name,
+		model_name      : this.model_name,
+		model_namespace : this.model_namespace || undefined,
+		schema          : this.schema,
+		primary_key     : this.prototype.primary_key,
+		display_field   : this.prototype.display_field,
+		ancestors       : 0,
 	};
 
 	if (this.super.name != 'Model') {
-		result.parent = this.super.name;
+		result.parent = this.super.model_name;
 
 		let ancestors = 0,
 		    ancestor = this.super;
@@ -566,7 +606,7 @@ Model.setStatic(function getClientConfig() {
 /**
  * Initialize behaviours
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.2.0
  * @version  0.2.0
  *
@@ -590,7 +630,7 @@ Model.setMethod(function initBehaviours() {
 /**
  * Enable a behaviour on-the-fly
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.0.1
  * @version  0.2.0
  */
@@ -611,11 +651,11 @@ Model.setMethod(function addBehaviour(behaviourname, options) {
 /**
  * Get a behaviour instance
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.0.3
  * @version  1.0.3
  *
- * @param    {String}   name
+ * @param    {string}   name
  *
  * @return   {Behaviour}
  */
@@ -633,7 +673,7 @@ Model.setMethod(function getBehaviour(name) {
 /**
  * Enable translations
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.2.0
  * @version  0.2.0
  */
@@ -644,7 +684,7 @@ Model.setMethod(function enableTranslations() {
 /**
  * Disable translations
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.2.0
  * @version  0.2.0
  */
@@ -655,7 +695,7 @@ Model.setMethod(function disableTranslations() {
 /**
  * Aggregate
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.5.0
  * @version  0.5.0
  *
@@ -677,7 +717,7 @@ Model.setMethod(function aggregate(pipeline, callback) {
 /**
  * Translate the given records
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.2.0
  * @version  1.3.0
  *
@@ -725,7 +765,7 @@ Model.setMethod(function translateItems(items, options, callback) {
 	let conduit = this.conduit;
 
 	// Should we use fallback translations?
-	const allow_fallbacks = options.allow_fallback_translations ?? alchemy.settings.allow_fallback_translations ?? false;
+	const allow_fallbacks = options.allow_fallback_translations ?? alchemy.settings.data_management.allow_fallback_translations ?? false;
 
 	let use_predefined_prefixes = false;
 
@@ -824,7 +864,7 @@ Model.setMethod(function translateItems(items, options, callback) {
 /**
  * Create the given record if the id does not exist in the database
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.0.1
  * @version  1.1.0
  *
@@ -868,7 +908,7 @@ Model.setMethod(function ensureIds(list, callback) {
 /**
  * Save one record
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.0.1
  * @version  1.3.20
  *
@@ -1001,7 +1041,7 @@ Model.setMethod(function saveRecord(document, options, callback) {
 /**
  * Look for the record id by checking the indexes
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.1.0
  * @version  1.1.0
  *
@@ -1129,7 +1169,7 @@ Model.setMethod(function auditRecord(document, options, callback) {
 /**
  * Turn a record into something the database will understand
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.0.3
  * @version  1.0.4
  *
@@ -1141,10 +1181,6 @@ Model.setMethod(function auditRecord(document, options, callback) {
  */
 Model.setMethod(function convertRecordToDatasourceFormat(record, options, callback) {
 
-	var that = this,
-	    pledge,
-	    data;
-
 	if (typeof options == 'function') {
 		callback = options;
 		options = {};
@@ -1154,12 +1190,12 @@ Model.setMethod(function convertRecordToDatasourceFormat(record, options, callba
 		options = {};
 	}
 
-	data = record[this.name] || record;
+	let data = record.$main || record[this.model_name] || record;
 
 	// Normalize the data
 	data = this.compose(data, options);
 
-	pledge = this.datasource.toDatasource(this, data);
+	let pledge = this.datasource.toDatasource(this, data);
 
 	pledge.handleCallback(callback);
 
@@ -1169,7 +1205,7 @@ Model.setMethod(function convertRecordToDatasourceFormat(record, options, callba
 /**
  * Process an object of datasource format
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.0.3
  * @version  1.0.3
  *
@@ -1204,11 +1240,11 @@ Model.setMethod(function processDatasourceFormat(ds_data, options, callback) {
 /**
  * Clear the cache of this and all associated models
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.0.1
  * @version  1.1.6
  *
- * @param    {Boolean}   associated   Also nuke associated models
+ * @param    {boolean}   associated   Also nuke associated models
  * @param    {Branch}    parent
  */
 Model.setMethod(function nukeCache(associated, parent) {
@@ -1261,13 +1297,13 @@ Model.setMethod(function nukeCache(associated, parent) {
 /**
  * Perform a MongoDB pipeline
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.3.17
  * @version  1.3.17
  *
- * @param   {Array}     pipeline
+ * @param    {Array}     pipeline
  *
- * @return  {Promise}
+ * @return   {Promise}
  */
 Model.setMethod(async function executeMongoPipeline(pipeline) {
 
@@ -1285,14 +1321,14 @@ Model.setMethod(async function executeMongoPipeline(pipeline) {
 /**
  * Delete the given record id
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.0.1
  * @version  1.3.22
  *
- * @param   {String}     id        The object id
- * @param   {Function}   callback
+ * @param    {string}     id        The object id
+ * @param    {Function}   callback
  *
- * @return  {Pledge}
+ * @return   {Pledge}
  */
 Model.setMethod(function remove(id, callback) {
 
@@ -1367,7 +1403,7 @@ Model.setMethod(function remove(id, callback) {
 /**
  * Get all the records and perform the given task on them
  *
- * @author   Jelle De Loecker <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.5.0
  * @version  1.2.0
  *
@@ -1464,7 +1500,7 @@ Model.setMethod(function eachRecord(options, task, callback) {
 /**
  * Strip out private fields
  *
- * @author   Jelle De Loecker <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.0.0
  * @version  1.0.0
  *
@@ -1505,7 +1541,7 @@ Model.setMethod(function removePrivateFields(records) {
 /**
  * Create an export stream
  *
- * @author   Jelle De Loecker <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.0.5
  * @version  1.0.5
  *
@@ -1555,7 +1591,7 @@ Model.setMethod(function exportToStream(output, options) {
 /**
  * Import from a stream
  *
- * @author   Jelle De Loecker <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.0.5
  * @version  1.0.5
  *
@@ -1728,99 +1764,44 @@ Model.setMethod(function importFromStream(input, options) {
 /**
  * Get a model
  *
- * @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
  *
- * @param   {String}     name
- * @param   {Boolean}    init
+ * @param    {string}     name
+ * @param    {boolean}    init
  *
- * @return  {Model}
+ * @return   {Model}
  */
 Model.get = function get(name, init, options) {
 
-	var constructor,
-	    namespace,
-	    pieces,
-	    path,
-	    obj;
-
-	if (typeof name == 'function') {
-		name = name.name;
-	}
-
-	if (!name) {
-		throw new TypeError('Model name should be a non-empty string');
-	}
-
-	if (init && typeof init == 'object') {
+	if (typeof init != 'boolean') {
 		options = init;
 		init = true;
 	}
 
-	if (!options) {
-		options = {};
-	}
+	let path = Blast.parseClassPath(name);
 
-	if (nameCache[name]) {
-		if (init === false) {
-			return nameCache[name];
-		} else {
-			return new nameCache[name];
-		}
-	}
-
-	pieces = name.split('.');
-
-	if (pieces.length > 1) {
-		// The first part is the namespace
-		namespace = pieces.shift();
-
-		// The rest should be the path
-		path = pieces.join('.');
+	let constructor = Object.path(Blast.Classes.Alchemy.Model, path) || Object.path(Blast.Classes, path);
 
-		obj = Classes[namespace];
-
-		if (!obj) {
-			if (init === false) {
-				return null;
-			}
-
-			throw new TypeError('Namespace "' + namespace + '" could not be found');
-		}
-	} else {
-		path = name;
-		obj = Classes.Alchemy.Model;
+	if (!constructor) {
+		throw new Error('Model "' + name + '" could not be found');
 	}
 
-	constructor = Object.path(obj, path) || obj[String(path).modelName()];
-
-	if (constructor == null) {
-		if (init === false) {
-			return null;
-		}
-
-		throw new Error('Could not find model "' + name + '"');
-	}
-
-	// Store this name in the cache,
-	// so we don't have to perform the expensive #modelName() method again
-	nameCache[name] = constructor;
-
-	if (init === false) {
+	if (!init) {
 		return constructor;
-	} else {
-		return new constructor;
 	}
+
+	return new constructor(options);
 };
 
 /**
  * Make the base Model class a global
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.0.1
  * @version  0.2.0
  *
- * @type   {Object}
+ * @type     {Object}
  */
-global.Model = Model;
+DEFINE('Model', Model);