alchemymvc 1.2.0 → 1.2.1

package/lib/app/helper/backed_map.js

@@ -0,0 +1,257 @@
+const OBJECT = Symbol('Object'),
+      BACKING = Symbol('Backing'),
+	  MAP = Symbol('Map');
+
+/**
+ * The Backed map class
+ *
+ * @constructor
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    1.2.1
+ * @version  1.2.1
+ */
+const Backed = Function.inherits('Alchemy.Base', 'Alchemy.Map', function Backed(backing) {
+	this.local = new Map();
+	this.type = null;
+	this.backing = backing;
+});
+
+/**
+ * Undry the given value
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    1.2.1
+ * @version  1.2.1
+ *
+ * @param    {Object}   value
+ *
+ * @return   {EnumValues}
+ */
+Backed.setStatic(function unDry(value, custom_method, whenDone) {
+	let result = new this(value.backing);
+	return result;
+});
+
+/**
+ * Get the size
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    1.2.1
+ * @version  1.2.1
+ */
+Backed.setProperty(function size() {
+	return this.keys().length;
+});
+
+/**
+ * Set the backing value
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    1.2.1
+ * @version  1.2.1
+ */
+Backed.enforceProperty(function backing(new_value, old_value) {
+
+	this.backing = null;
+	this.type = null;
+
+	if (!new_value) {
+		return;
+	}
+
+	if (new_value instanceof Backed) {
+		this.type = BACKING;
+	} else if (new_value instanceof Map) {
+		this.type = MAP;
+	} else if (typeof new_value == 'object') {
+		this.type = OBJECT;
+	}
+
+	return new_value;
+});
+
+/**
+ * Create a (shallow) clone of this backed map.
+ * Since we don't ever touch the backing itself, we don't have to clone that.
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    1.2.1
+ * @version  1.2.1
+ *
+ * @return   {Backed}
+ */
+Backed.setMethod(function clone() {
+	let result = new Backed(this.backing);
+	result.local = new Map(this.local);
+	return result;
+});
+
+/**
+ * Create a (shallow) clone of this backed map.
+ * Since we don't ever touch the backing itself, we don't have to clone that.
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    1.2.1
+ * @version  1.2.1
+ *
+ * @return   {Backed}
+ */
+Backed.setMethod(function dryClone(wm, custom_method) {
+	return this.clone();
+});
+
+/**
+ * Simplify the object for Hawkejs
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    1.2.1
+ * @version  1.2.1
+ *
+ * @param    {WeakMap}   wm
+ *
+ * @return   {Backed}
+ */
+Backed.setMethod(function toHawkejs(wm) {
+
+	let values = new Map(),
+	    value,
+	    keys = this.keys(),
+		key;
+	
+	for (key of keys) {
+		value = this.get(key);
+		values.set(key, JSON.clone(value, 'toHawkejs', wm));
+	}
+
+	return new this.constructor(values);
+});
+
+/**
+ * Get all the keys
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    1.2.1
+ * @version  1.2.1
+ *
+ * @return   {String[]}
+ */
+Backed.setMethod(function keys() {
+
+	let result;
+
+	if (this.type == BACKING) {
+		result = this.backing.keys();
+	} else if (this.type == MAP) {
+		result = [...this.backing.keys()];
+	} else if (this.type == OBJECT) {
+		result = Object.keys(this.backing);
+	} else {
+		result = [];
+	}
+
+	if (this.local.size) {
+		for (let key of this.local.keys()) {
+			if (result.indexOf(key) == -1) {
+				result.push(key);
+			}
+		}
+	}
+
+	return result;
+});
+
+/**
+ * Get a value by it's name
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    1.2.1
+ * @version  1.2.1
+ *
+ * @param    {String}   name
+ *
+ * @return   {Mixed}
+ */
+Backed.setMethod(function get(name) {
+
+	if (this.local.has(name)) {
+		return this.local.get(name);
+	}
+
+	if (!this.type) {
+		return;
+	}
+
+	let value;
+
+	if (this.type == BACKING || this.type == MAP) {
+		value = this.backing.get(name);
+	} else if (this.type == OBJECT) {
+		value = this.backing[name];
+	}
+
+	return value;
+});
+
+/**
+ * Set a value
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    1.2.1
+ * @version  1.2.1
+ *
+ * @param    {String}   name
+ * @param    {*}        value
+ *
+ * @return   {*}
+ */
+Backed.setMethod(function set(name, value) {
+	this.local.set(name, value);
+	return value;
+});
+
+/**
+ * Dry the object
+ *
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    1.2.1
+ * @version  1.2.1
+ *
+ * @return   {Object}
+ */
+Backed.setMethod(function toDry() {
+	
+	let result = {
+		backing  : {}
+	};
+
+	let value,
+	    key;
+
+	for (key of this.keys()) {
+		value = this.get(key);
+		result.backing[key] = value;
+	}
+
+	return {value: result};
+});
+
+/**
+ * Iterate over the object
+ *
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    1.2.1
+ * @version  1.2.1
+ *
+ * @return   {Object}
+ */
+Backed.setMethod(Symbol.iterator, function* iterate() {
+
+	let value,
+	    key;
+
+	for (key of this.keys()) {
+		value = this.get(key);
+		yield value;
+	}
+});

package/lib/app/helper/enum_values.js

@@ -0,0 +1,125 @@
+/**
+ * The EnumValues class
+ *
+ * @constructor
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    1.2.1
+ * @version  1.2.1
+ */
+const EnumMap = Function.inherits('Alchemy.Map.Backed', 'Enum');
+
+/**
+ * Get a value by it's name
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    1.2.1
+ * @version  1.2.1
+ *
+ * @param    {String}   name
+ *
+ * @return   {Mixed}
+ */
+EnumMap.setMethod(function get(name) {
+
+	if (this.local.has(name)) {
+		return this.local.get(name);
+	}
+
+	let value = get.super.call(this, name);
+
+	if (value) {
+		value = this.set(name, value);
+	}
+
+	return value;
+});
+
+/**
+ * Set a value
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    1.2.1
+ * @version  1.2.1
+ *
+ * @param    {String}   name
+ * @param    {*}        value
+ *
+ * @return   {*}
+ */
+EnumMap.setMethod(function set(name, value) {
+
+	if (value == null) {
+		return;
+	}
+
+	if (value.is_enumified) {
+		this.local.set(name, value);
+		return value;
+	}
+
+	let result;
+
+	if (typeof value == 'string') {
+		result = {
+			name  : value,
+			title : value,
+		};
+	} else if (typeof value == 'function') {
+		result = {
+			name  : value.name,
+			title : value.title,
+		};
+	} else {
+		result = {
+			name  : value.name,
+			title : value.title || value.name,
+		};
+	}
+
+	result.value = value;
+	result.is_enumified = true;
+
+	this.local.set(name, result);
+
+	return result;
+});
+
+
+/**
+ * Simplify the object for Hawkejs
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    1.2.1
+ * @version  1.2.1
+ *
+ * @param    {WeakMap}   wm
+ *
+ * @return   {Enum}
+ */
+EnumMap.setMethod(function toHawkejs(wm) {
+
+	let result = toHawkejs.super.call(this, wm),
+	    original_value,
+		cloned_value,
+	    keys = this.keys(),
+		key;
+	
+	for (key of keys) {
+		original_value = this.get(key);
+		cloned_value = result.get(key);
+
+		if (original_value.value) {
+
+			if (typeof original_value.value == 'function') {
+				cloned_value.type = 'function';
+			}
+
+			if (original_value.value.schema) {
+				cloned_value.schema = JSON.clone(original_value.value.schema, 'toHawkejs', wm);
+			}
+		}
+	}
+
+	return result;
+});

package/lib/app/helper/router_helper.js

@@ -266,7 +266,7 @@ Router.setMethod(function routeConfig(name, socket_route) {
  *
  * @author   Jelle De Loecker   <jelle@develry.be>
  * @since    0.2.0
- * @version  1.1.5
+ * @version  1.2.1
  *
  * @param    {String}   name
  * @param    {Object}   parameters
@@ -331,6 +331,12 @@ Router.setMethod(function routeUrl(name, _parameters, options) {
 		// Remove [brackets]
 		url = url.replace(/\[.*?\]/g, '');
 		url = url.assign(parameters, true, RURL.encodeUriQuery);
+
+		// Remove capturing regexes
+		if (url.indexOf('(') > -1) {
+			// @TODO: should exclude escaped colons like "\\("
+			url = url.replace(/\(.*?\)/g, '');
+		}
 	}
 
 	url = this.parseURL(url);

package/lib/app/helper_field/enum_field.js

@@ -5,9 +5,14 @@
  *
  * @author   Jelle De Loecker   <jelle@develry.be>
  * @since    0.2.0
- * @version  1.1.0
+ * @version  1.2.1
  */
 var Enum = Function.inherits('Alchemy.Field', function Enum(schema, name, options) {
+
+	if (options.values) {
+		options.values = new Classes.Alchemy.Map.Enum(options.values);
+	}
+
 	Enum.super.call(this, schema, name, options);
 });
 
@@ -40,9 +45,9 @@ Enum.setMethod(function cast(value) {
  *
  * @author   Jelle De Loecker   <jelle@develry.be>
  * @since    0.2.0
- * @version  0.2.0
+ * @version  1.2.1
  *
- * @return   {Object}
+ * @return   {EnumValues}
  */
 Enum.setMethod(function getValues() {
 
@@ -62,7 +67,7 @@ Enum.setMethod(function getValues() {
  *
  * @author   Jelle De Loecker   <jelle@develry.be>
  * @since    1.1.0
- * @version  1.1.0
+ * @version  1.2.1
  *
  * @param    {WeakMap}   wm
  *
@@ -72,37 +77,5 @@ Enum.setMethod(function getClientConfigOptions(wm) {
 
 	let options = JSON.clone(this.options, 'toHawkejs', wm);
 
-	if (this.options.values) {
-		let value,
-		    entry,
-		    key;
-
-		if (!options.values) {
-			options.values = {};
-		}
-
-		for (key in this.options.values) {
-
-			if (options.values[key]) {
-				continue;
-			}
-
-			value = this.options.values[key];
-
-			if (typeof value == 'function') {
-				entry = {
-					name  : value.name,
-					title : value.title,
-				};
-
-				if (value.schema) {
-					entry.schema = JSON.clone(value.schema, 'toHawkejs', wm);
-				}
-
-				options.values[key] = entry;
-			}
-		}
-	}
-
 	return options;
 });

package/lib/app/helper_field/schema_field.js

@@ -91,7 +91,7 @@ SchemaField.setProperty(function requires_translating() {
  *
  * @author   Jelle De Loecker   <jelle@develry.be>
  * @since    0.2.0
- * @version  0.4.0
+ * @version  1.2.1
  *
  * @param    {Object}   record
  * @param    {String}   some_path   Some path to a field in the wanted schema
@@ -106,8 +106,7 @@ SchemaField.setMethod(function getSubschema(record, some_path) {
 	    record_value,
 	    pieces,
 	    field,
-	    name,
-	    temp;
+	    name;
 
 	// If schema is a string,
 	// it needs to be extracted from another field's value
@@ -131,9 +130,9 @@ SchemaField.setMethod(function getSubschema(record, some_path) {
 		}
 
 		// Get the values that field can have (probably an enum)
-		temp = field.getValues();
+		let values = field.getValues();
 
-		if (temp == null) {
+		if (values == null) {
 			return null;
 		}
 
@@ -146,23 +145,14 @@ SchemaField.setMethod(function getSubschema(record, some_path) {
 		}
 
 		// Get the correct field value
-		temp = temp[record_value];
-
-		if (temp != null) {
-			schema = temp[property_name];
+		let enum_value = values.get(record_value);
 
-			if (schema == null && typeof temp == 'function') {
-				temp = new temp();
-				schema = temp[property_name] || temp.schema || temp.blueprint;
-
-				if (schema != null) {
-					schema.setModel(this.schema.model_name);
-					schema.setName(this.name);
-					schema.setParent(this.schema);
-				}
-			}
-		} else {
+		if (!enum_value) {
 			schema = null;
+		} else if (enum_value.schema) {
+			schema = enum_value.schema;
+		} else if (enum_value.value) {
+			schema = enum_value.value[property_name] || enum_value.value.schema;
 		}
 	}
 
@@ -243,7 +233,7 @@ SchemaField.setMethod(function _toDatasource(value, data, datasource, callback)
 		}
 	}
 
-	log.warning('Model and subschema were not found for', that.name);
+	log.warning('Model and subschema were not found for', that.path);
 	return datasource.toDatasource(null, value, callback);
 });
 

package/lib/class/element.js

@@ -23,12 +23,17 @@ Function.getNamespace('Alchemy.Element').setStatic('default_element_prefix', 'al
  *
  * @author   Jelle De Loecker   <jelle@elevenways.be>
  * @since    1.1.3
- * @version  1.1.3
+ * @version  1.2.1
  *
  * @return  {RURL}
  */
 Element.setMethod(function getCurrentUrl() {
 	if (Blast.isBrowser) {
+
+		if (hawkejs.scene.opening_url && hawkejs.scene.opening_url.url) {
+			return Blast.Classes.RURL.parse(hawkejs.scene.opening_url.url);
+		}
+		
 		return Blast.Classes.RURL.parse(window.location);
 	} else if (this.hawkejs_renderer && this.hawkejs_renderer.variables && this.hawkejs_renderer.variables.__url) {
 		return this.hawkejs_renderer.variables.__url.clone();

package/lib/core/client_alchemy.js

@@ -1066,4 +1066,18 @@ Alchemy.setMethod(function syncDataWithServer() {
 	});
 
 	return Function.parallel(tasks);
+});
+
+/**
+ * Create a new schema on the client
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    1.2.1
+ * @version  1.2.1
+ *
+ * @param    {*}   parent
+ */
+Alchemy.setMethod(function createSchema(parent) {
+	let schema = new Classes.Alchemy.Client.Schema(parent);
+	return schema;
 });

package/lib/init/alchemy.js

@@ -1721,6 +1721,20 @@ Alchemy.setMethod(function importFromStream(input, options) {
 	return pledge;
 });
 
+/**
+ * Create a new schema
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    1.2.1
+ * @version  1.2.1
+ *
+ * @param    {*}   parent
+ */
+Alchemy.setMethod(function createSchema(parent) {
+	let schema = new Classes.Alchemy.Schema(parent);
+	return schema;
+});
+
 /**
  * The alchemy global, where everything will be stored
  *

package/lib/init/functions.js

@@ -1325,7 +1325,7 @@ Alchemy.setMethod(function exposeStatic(name, value) {
  *
  * @author   Jelle De Loecker   <jelle@develry.be>
  * @since    1.1.0
- * @version  1.1.0
+ * @version  1.2.1
  */
 Alchemy.setMethod(function exposeDefaultStaticVariables() {
 
@@ -1372,6 +1372,9 @@ Alchemy.setMethod(function exposeDefaultStaticVariables() {
 
 	hawkejs.exposeStatic('app_version', app_version);
 	hawkejs.app_version = app_version;
+
+	// Emit as a global event so plugins can also expose their data
+	this.emit('generate_static_variables', hawkejs);
 });
 
 /**

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "alchemymvc",
 	"description": "MVC framework for Node.js",
-	"version": "1.2.0",
+	"version": "1.2.1",
 	"author": "Jelle De Loecker <jelle@elevenways.be>",
 	"keywords": [
 		"alchemy",
@@ -22,7 +22,7 @@
 		"chokidar"         : "~3.5.3",
 		"formidable"       : "~1.2.2",
 		"graceful-fs"      : "~4.2.9",
-		"hawkejs"          : "~2.2.0",
+		"hawkejs"          : "~2.2.3",
 		"jsondiffpatch"    : "~0.4.1",
 		"mime"             : "~3.0.0",
 		"minimist"         : "~1.2.5",
@@ -31,7 +31,7 @@
 		"mongodb"          : "~3.6.6",
 		"ncp"              : "~2.0.0",
 		"postcss"          : "~8.4.6",
-		"protoblast"       : "~0.7.10",
+		"protoblast"       : "~0.7.16",
 		"semver"           : "~7.3.5",
 		"socket.io"        : "~2.4.0",
 		"@11ways/socket.io-stream" : "~0.9.2",