alchemymvc 1.3.21 → 1.4.0-alpha.1

package/lib/class/document.js

@@ -1,13 +1,13 @@
-var Stream = alchemy.use('stream'),
-    zlib   = alchemy.use('zlib'),
-    fs     = alchemy.use('fs');
+const Stream = alchemy.use('stream'),
+      zlib   = alchemy.use('zlib'),
+      fs     = alchemy.use('fs');
 
 /**
  * The Document class
  *
  * @constructor
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.2.0
  * @version  1.1.0
  *
@@ -25,70 +25,57 @@ var Document = Function.inherits('Alchemy.Base', 'Alchemy.Document', function Do
 /**
  * Create document class for specific model
  *
- * @author   Jelle De Loecker <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.2.0
- * @version  1.0.6
+ * @version  1.4.0
  *
- * @param    {Model|String}   model_param
+ * @param    {Model|string}   model_param
  */
 Document.setStatic(function getDocumentClass(model_param) {
 
-	var doc_constructor,
-	    document_name,
-	    parent_path,
-	    model_name,
-	    namespace,
-	    doc_path,
-	    DocClass,
-	    model,
-	    alias;
-
 	if (!model_param) {
 		throw new Error('No model name was given, can not get Document class');
 	}
 
-	if (typeof model_param == 'function') {
-		model = model_param;
-	} else {
-		model = Model.get(model_param, false);
-	}
+	let model = typeof model_param == 'function' ? model_param : Model.get(model_param, false);
 
 	if (!model) {
 		throw new Error('There is no model named "' + model_param + '"');
 	}
 
-	// Unfortunately we need the model_name right now,
-	// though sometimes it's set in the future.
-	// This happens when we need to do a setDocumentMethod
-	if (model.prototype.name) {
-		model_name = model.prototype.name;
-	} else {
-		model_name = model.name;
-	}
+	// Model name like "System_Task" or "User"
+	let model_name = model.model_name || model.name;
 
-	// Make sure we got a model name
 	if (!model_name) {
 		throw new Error('Tried to get nameless document class');
 	}
 
-	// Get the namespace
-	namespace = 'Alchemy.Document';
+	// Get the Document namespace
+	let namespace = 'Alchemy.Document';
+
+	let model_namespace = model.model_namespace;
+
+	if (model_namespace) {
+		namespace += '.' + model_namespace;
+	}
 
-	// Get the name of the document class
-	document_name = model.name;
+	// The name of the document class will be the same as the name of the model
+	let document_name = model.name;
 
-	doc_path = namespace + '.' + document_name;
+	let doc_path = namespace + '.' + document_name;
 
 	// Get the document class
-	DocClass = Object.path(Classes, doc_path);
+	let DocClass = Object.path(Classes, doc_path);
 
 	if (DocClass == null) {
 
 		// Create the document constructor function
-		doc_constructor = Function.create(document_name, function med(data, options) {
-			med.wrapper.super.call(this, data, options);
+		let doc_constructor = Function.create(document_name, function DocumentConstructor(data, options) {
+			DocumentConstructor.super.call(this, data, options);
 		});
 
+		let parent_path;
+
 		if (!model.super || model.super.name == 'Model' || !model.super.Document) {
 			parent_path = 'Alchemy.Document.Document';
 		} else {
@@ -101,6 +88,9 @@ Document.setStatic(function getDocumentClass(model_param) {
 			DocClass = Function.inherits(parent_path, doc_constructor);
 		}
 
+		// Set a reference to the Model class
+		DocClass.Model = model;
+
 		// Set the getter for this document alias itself
 		DocClass.setAliasGetter(model_name);
 
@@ -110,13 +100,12 @@ Document.setStatic(function getDocumentClass(model_param) {
 		// Set the path to this document
 		DocClass.setProperty('path_to_class', doc_path);
 
+		let alias;
+
 		// Set association getters
 		for (alias in model.schema.associations) {
 			DocClass.setAliasGetter(alias);
 		}
-
-		// Set a reference to the Model class
-		DocClass.Model = model;
 	}
 
 	return DocClass;
@@ -125,43 +114,33 @@ Document.setStatic(function getDocumentClass(model_param) {
 /**
  * Get the client-side document class
  *
- * @author   Jelle De Loecker <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.0.0
- * @version  1.0.0
- *
- * @param    {String}   model_name
+ * @version  1.4.0
  */
-Document.setStatic(function getClientDocumentClass(model_name) {
-
-	if (!model_name) {
-		model_name = this.prototype.$model_name;
-	}
-
-	return Classes.Alchemy.Client.Document.Document.getDocumentClass(model_name);
+Document.setStatic(function getClientDocumentClass() {
+	return Classes.Alchemy.Client.Document.Document.getDocumentClass(this.Model);
 });
 
 /**
  * unDry an object
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.0.0
  * @version  1.0.6
  *
  * @param    {Object}           obj
- * @param    {Boolean|String}   cloned
+ * @param    {boolean|string}   cloned
  *
  * @return   {Document}
  */
 Document.setStatic(function unDry(obj, cloned) {
 
-	var DocClass,
-	    result;
-
 	// Get the document class
-	DocClass = this.getDocumentClass(obj.$model_name);
+	const DocClass = this.getDocumentClass(obj.$model_name);
 
 	// Create a new instance, without constructing it yet
-	result = Object.create(DocClass.prototype);
+	const result = Object.create(DocClass.prototype);
 
 	// Restore the attributes object if there is one
 	if (obj.$_attributes) {
@@ -185,7 +164,7 @@ Document.setStatic(function unDry(obj, cloned) {
  * @since    1.3.21
  * @version  1.3.21
  *
- * @param    {String}     name     Name of the property
+ * @param    {string}     name     Name of the property
  * @param    {Function}   getter   Optional getter function
  * @param    {Function}   setter   Optional setter function
  */
@@ -208,11 +187,11 @@ Document.setStatic(function setComputedFieldGetter(name) {
 /**
  * Set the getter for this field
  *
- * @author   Jelle De Loecker <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.2.0
  * @version  1.0.4
  *
- * @param    {String}     name     Name of the property
+ * @param    {string}     name     Name of the property
  * @param    {Function}   getter   Optional getter function
  * @param    {Function}   setter   Optional setter function
  */
@@ -248,11 +227,11 @@ Document.setStatic(function setFieldGetter(name, getter, setter) {
 /**
  * Set the getter for an alias
  *
- * @author   Jelle De Loecker <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.2.0
  * @version  0.4.0
  *
- * @param    {String}   name
+ * @param    {string}   name
  */
 Document.setStatic(function setAliasGetter(name) {
 
@@ -280,13 +259,13 @@ Document.setStatic(function setAliasGetter(name) {
 /**
  * Is the given argument a Document?
  *
- * @author   Jelle De Loecker <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.0.5
  * @version  1.0.5
  *
  * @param    {Object}     obj
  *
- * @return   {Boolean}
+ * @return   {boolean}
  */
 Document.setStatic(function isDocument(obj) {
 
@@ -309,7 +288,7 @@ Document.setStatic(function isDocument(obj) {
 /**
  * Get the model instance
  *
- * @author   Jelle De Loecker <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.2.0
  * @version  1.0.0
  */
@@ -325,7 +304,7 @@ Document.setProperty(function $model() {
 /**
  * Get the conduit instance
  *
- * @author   Jelle De Loecker <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.3.3
  * @version  1.2.7
  */
@@ -351,7 +330,7 @@ Document.setProperty(function conduit() {
  * Clone this document
  * @todo: more speed, custom properties, singularized?
  *
- * @author   Jelle De Loecker <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.2.0
  * @version  0.2.0
  */
@@ -362,7 +341,7 @@ Document.setMethod(function clone() {
 /**
  * Clone this document for JSON-dry
  *
- * @author   Jelle De Loecker <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.2.0
  * @version  1.0.7
  *
@@ -393,7 +372,7 @@ Document.setMethod(function dryClone(wm, custom_method) {
 /**
  * Return an object for json-drying this document
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.0.4
  * @version  1.0.4
  *
@@ -415,7 +394,7 @@ Document.setMethod(function toDry() {
 /**
  * Simplify the object for Hawkejs
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.2.0
  * @version  1.2.7
  *
@@ -490,7 +469,7 @@ Document.setMethod(function keepPrivateFields(value) {
 /**
  * Return the basic record for JSON
  *
- * @author   Jelle De Loecker <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.2.0
  * @version  0.2.0
  */
@@ -501,7 +480,7 @@ Document.setMethod(function toJSON() {
 /**
  * Return the array to util.inspect
  *
- * @author   Jelle De Loecker <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.2.0
  * @version  0.2.0
  */
@@ -512,12 +491,12 @@ Document.setMethod(function inspect(depth) {
 /**
  * Get a record field property
  *
- * @author   Jelle De Loecker <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.2.0
  * @version  1.0.0
  *
- * @param    {String}   alias   Optional alias
- * @param    {String}   field
+ * @param    {string}   alias   Optional alias
+ * @param    {string}   field
  *
  * @return   {Mixed}
  */
@@ -536,11 +515,11 @@ Document.setMethod(function get(alias, field) {
 /**
  * Set an alias object
  *
- * @author   Jelle De Loecker <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.2.0
  * @version  1.0.0
  *
- * @param    {String}   alias
+ * @param    {string}   alias
  * @param    {Object}   obj
  *
  * @return   {Mixed}
@@ -562,7 +541,7 @@ Document.setMethod(function setAlias(alias, obj) {
 /**
  * Alias for save
  *
- * @author   Jelle De Loecker <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.2.0
  * @version  0.2.0
  *
@@ -576,7 +555,7 @@ Document.setMethod(function update(data, callback) {
 /**
  * Remove this document
  *
- * @author   Jelle De Loecker <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.4.1
  * @version  1.1.0
  *
@@ -600,9 +579,9 @@ Document.setMethod(function remove(callback) {
  *
  * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.2.3
- * @version  1.3.4
+ * @version  1.4.0
  *
- * @param    {Criteria|String} criteria
+ * @param    {Criteria|string} criteria
  *
  * @return   {Criteria}
  */
@@ -625,9 +604,9 @@ Document.setMethod(function preparePopulationCriteria(criteria) {
 	}
 
 	if (!Classes.Alchemy.Criteria.Criteria.isCriteria(criteria)) {
-		let new_criteria = new Classes.Alchemy.Criteria(model);
+		let new_criteria = new Classes.Alchemy.Criteria.Model(model);
 		new_criteria.model = model;
-		new_criteria.applyOldConditions(criteria);
+		new_criteria.applyConditions(criteria);
 		criteria = new_criteria;
 	}
 
@@ -648,7 +627,7 @@ Document.setMethod(function preparePopulationCriteria(criteria) {
 /**
  * Add associated data to this record
  *
- * @author   Jelle De Loecker <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.2.0
  * @version  1.2.3
  *
@@ -672,13 +651,13 @@ Document.setMethod(['populate', 'addAssociatedData'], function addAssociatedData
 /**
  * Get the display field value
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.3.0
  * @version  1.3.3
  *
  * @param    {Object}   options
  *
- * @return   {String|undefined}
+ * @return   {string|undefined}
  */
 Document.setMethod(function getDisplayFieldValue(options = {}) {
 
@@ -735,7 +714,7 @@ Document.setMethod(async function getPreviousRevision() {
  * @since    1.1.0
  * @version  1.1.0
  *
- * @param    {Number}   revisions
+ * @param    {number}   revisions
  *
  * @return   {Pledge<DocumentList>}
  */
@@ -766,7 +745,7 @@ Document.setMethod(function getRevisions(revisions) {
 /**
  * Revert to the given revision id
  *
- * @author   Jelle De Loecker <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.1.0
  * @version  1.1.0
  *
@@ -805,11 +784,11 @@ Document.setMethod(async function revertTo(revision_id) {
 /**
  * Revert this document
  *
- * @author   Jelle De Loecker <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.0.3
  * @version  1.3.4
  *
- * @param    {Number}   revisions
+ * @param    {number}   revisions
  *
  * @return   {Pledge}
  */
@@ -864,7 +843,7 @@ Document.setMethod(function revert(revisions) {
 /**
  * Export this document by pushing to the writable stream
  *
- * @author   Jelle De Loecker <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.0.5
  * @version  1.0.5
  *
@@ -927,7 +906,7 @@ Document.setMethod(function exportToStream(output) {
 /**
  * Import a document from a gzipped buffer
  *
- * @author   Jelle De Loecker <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.0.5
  * @version  1.0.5
  *

package/lib/class/document_list.js

@@ -4,7 +4,7 @@
  *
  * @constructor
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.0.0
  * @version  1.1.3
  *
@@ -18,7 +18,7 @@ var DocumentList = Function.inherits(['Alchemy.Base', 'Array'], 'Alchemy', funct
 /**
  * unDry an object
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.0.3
  * @version  1.0.3
  *
@@ -39,7 +39,7 @@ DocumentList.setStatic(function unDry(obj) {
 /**
  * Clone this list
  *
- * @author   Jelle De Loecker <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.0.3
  * @version  1.0.3
  *
@@ -61,7 +61,7 @@ DocumentList.setMethod(function clone() {
 /**
  * Add associated data to all these records
  *
- * @author   Jelle De Loecker <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.1.0
  * @version  1.2.3
  *
@@ -88,7 +88,7 @@ DocumentList.setMethod(['populate', 'addAssociatedData'], function addAssociated
 /**
  * Get next page
  *
- * @author   Jelle De Loecker <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.4.0
  * @version  1.0.3
  *

package/lib/class/element.js

@@ -1,7 +1,7 @@
 /**
  * Custom alchemy elements
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.0.0
  * @version  1.0.0
  */
@@ -10,7 +10,7 @@ const Element = Function.inherits('Hawkejs.Element', 'Alchemy.Element', 'Element
 /**
  * The default element prefix (when element contains no hyphen) is "al"
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.0.0
  * @version  1.0.0
  */
@@ -19,11 +19,11 @@ Function.getNamespace('Alchemy.Element').setStatic('default_element_prefix', 'al
 /**
  * Get the current URL
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.1.3
  * @version  1.2.5
  *
- * @return  {RURL}
+ * @return   {RURL}
  */
 Element.setMethod(function getCurrentUrl() {
 	return this.hawkejs_renderer?.helpers?.Router?.current_url;
@@ -32,15 +32,15 @@ Element.setMethod(function getCurrentUrl() {
 /**
  * Get a resource
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.1.3
  * @version  1.1.3
  *
- * @param   {Object}     options
- * @param   {Object}     data
- * @param   {Function}   callback
+ * @param    {Object}     options
+ * @param    {Object}     data
+ * @param    {Function}   callback
  *
- * @return  {Pledge}
+ * @return   {Pledge}
  */
 Element.setMethod(function getResource(options, data, callback) {
 
@@ -60,14 +60,14 @@ Element.setMethod(function getResource(options, data, callback) {
 /**
  * Get a client-side model, attach a conduit if possible
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.0.4
  * @version  1.0.4
  *
- * @param   {String}   model_name
- * @param   {Object}   options
+ * @param    {string}   model_name
+ * @param    {Object}   options
  *
- * @return  {Model}
+ * @return   {Model}
  */
 Element.setMethod(function getModel(model_name, options) {
 
@@ -105,14 +105,14 @@ Element.setMethod(function getModel(model_name, options) {
 /**
  * Default translation implementation
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.2.4
  * @version  1.2.4
  *
- * @param   {String}   key
- * @param   {Object}   parameters
+ * @param    {string}   key
+ * @param    {Object}   parameters
  *
- * @return  {String}
+ * @return   {string}
  */
 Element.setMethod(function __(key, parameters) {
 	return key;

package/lib/class/error.js

@@ -3,7 +3,7 @@
  *
  * @constructor
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.1.0
  * @version  1.1.0
  */
@@ -14,11 +14,11 @@ const AlchemyError = Function.inherits('Develry.Error', 'Alchemy.Error', functio
 /**
  * Return string interpretation of this error
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.1.0
  * @version  1.1.0
  *
- * @return   {String}
+ * @return   {string}
  */
 AlchemyError.setMethod(function toString() {
 	let result = this.name + ' Error';