alchemymvc 1.3.21 → 1.4.0-alpha.1

package/lib/class/path_definition.js

@@ -1,7 +1,7 @@
 /**
  * Path definition parser
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.0.0
  * @version  1.3.0
  */
@@ -46,7 +46,7 @@ const PathDefinition = Function.inherits('Alchemy.Base', function PathDefinition
 /**
  * The main path matching regexp utility
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.0.0
  * @version  1.1.0
  */
@@ -66,7 +66,7 @@ PathDefinition.setStatic('path_regexp', RegExp([
 /**
  * Type definition testers
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.0.0
  * @version  1.0.0
  */
@@ -75,8 +75,8 @@ PathDefinition.setStatic('typedefs', {});
 /**
  * Register a type (like ObjectId or Number)
  *
- * @param   {String}   name
- * @param   {Function} fnc
+ * @param    {string}   name
+ * @param    {Function} fnc
  */
 PathDefinition.setStatic(function registerType(name, fnc) {
 
@@ -91,9 +91,9 @@ PathDefinition.setStatic(function registerType(name, fnc) {
 /**
  * Escape a regular expression string.
  *
- * @param  {String}   group
+ * @param    {string}   group
  *
- * @return {String}
+ * @return   {string}
  */
 PathDefinition.setStatic(function escapeGroup(group) {
 	return group.replace(/([=!:$/()])/g, '\\$1')
@@ -102,9 +102,9 @@ PathDefinition.setStatic(function escapeGroup(group) {
 /**
  * Escape the capturing group by escaping special characters and meaning.
  *
- * @param  {String}   str
+ * @param    {string}   str
  *
- * @return {String}
+ * @return   {string}
  */
 PathDefinition.setStatic(function escapeString(str) {
 	return str.replace(/([.+*?=^!:${}()[\]|/\\])/g, '\\$1')
@@ -114,7 +114,7 @@ PathDefinition.setStatic(function escapeString(str) {
 /**
  * Does this path use any type class checks?
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.3.0
  * @version  1.3.0
  */
@@ -141,7 +141,7 @@ PathDefinition.enforceProperty(function uses_type_class_checks(new_value) {
 /**
  * Get the complete section identifier
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.0.0
  * @version  1.1.0
  */
@@ -260,7 +260,7 @@ PathDefinition.setMethod(function parse(str, options) {
 /**
  * Convert tokens to regular expression
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.0.0
  * @version  1.0.0
  *
@@ -352,12 +352,12 @@ PathDefinition.setMethod(function tokensToRegexp(tokens, keys, options) {
 /**
  * Get parameters object
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.0.0
  * @version  1.1.0
  *
  * @param    {Array}   values
- * @param    {String}  info_type
+ * @param    {string}  info_type
  *
  * @return   {Object}
  */
@@ -397,11 +397,11 @@ PathDefinition.setMethod(function getParametersObject(values, info_type) {
 /**
  * Test the given string
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.0.0
  * @version  1.3.0
  *
- * @param    {String}   path
+ * @param    {string}   path
  *
  * @return   {Array|Pledge}
  */
@@ -480,13 +480,13 @@ PathDefinition.setMethod(function test(path, conduit) {
 /**
  * Make sure it's a valid ObjectId string
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.0.0
  * @version  1.0.0
  *
- * @param    {String}   value
+ * @param    {string}   value
  *
- * @return   {String}
+ * @return   {string}
  */
 PathDefinition.registerType(function ObjectId(value) {
 	if (value.isObjectId()) {
@@ -497,13 +497,13 @@ PathDefinition.registerType(function ObjectId(value) {
 /**
  * Make sure it's a number
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.0.0
  * @version  1.0.0
  *
- * @param    {String}   value
+ * @param    {string}   value
  *
- * @return   {Number}
+ * @return   {number}
  */
 PathDefinition.registerType(function Number(value) {
 	if (Classes.Number.isNumeric(value)) {

package/lib/class/path_evaluator.js

@@ -4,11 +4,11 @@
  *
  * @constructor
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.1.0
  * @version  1.3.20
  *
- * @param    {String}   path
+ * @param    {string}   path
  */
 const PathEvaluator = Function.inherits(null, 'Alchemy', function PathEvaluator(path) {
 
@@ -26,7 +26,7 @@ const PathEvaluator = Function.inherits(null, 'Alchemy', function PathEvaluator(
 /**
  * Undry the value
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.1.0
  * @version  1.1.0
  */
@@ -37,7 +37,7 @@ PathEvaluator.setStatic(function unDry(value) {
 /**
  * Create a dry object
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.1.0
  * @version  1.1.0
  */
@@ -52,7 +52,7 @@ PathEvaluator.setMethod(function toDry() {
 /**
  * Get the actual value
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.1.0
  * @version  1.3.20
  */

package/lib/class/path_param_definition.js

@@ -3,7 +3,7 @@ const PathDefinition = Classes.Alchemy.PathDefinition;
 /**
  * Path param definition
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.3.0
  * @version  1.3.7
  */
@@ -51,7 +51,7 @@ const PathParamDefinition = Function.inherits('Alchemy.Base', function PathParam
 /**
  * Create path param definitions
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.3.0
  * @version  1.3.0
  *
@@ -85,7 +85,7 @@ PathParamDefinition.setStatic(function from(input) {
 /**
  * Get the model constructor
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.3.7
  * @version  1.3.7
  */
@@ -109,7 +109,7 @@ PathParamDefinition.enforceProperty(function model_constructor(new_value) {
 /**
  * Parse the type definition
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.3.0
  * @version  1.3.12
  */
@@ -172,11 +172,11 @@ PathParamDefinition.setMethod(function parseTypeDefinition() {
 /**
  * Check the value
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.3.0
  * @version  1.3.0
  *
- * @param    {Boolean|Pledge<Boolean>}
+ * @param    {boolean|Pledge<boolean>}
  */
 PathParamDefinition.setMethod(function castValueToType(value, conduit) {
 
@@ -199,7 +199,7 @@ PathParamDefinition.setMethod(function castValueToType(value, conduit) {
 /**
  * Parse an original path value
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.3.0
  * @version  1.3.0
  *

package/lib/class/plugin.js

@@ -0,0 +1,312 @@
+const PLUGINS_STAGE = STAGES.getStage('load_app').getStage('plugins'),
+      libpath = require('path'),
+      libfs = require('fs'),
+      FLAGS = Symbol('flags');
+
+/**
+ * The Plugin class:
+ * Represents a plugin that can be used by Alchemy
+ *
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    1.4.0
+ * @version  1.4.0
+ *
+ * @param    {string}   name     The name of the plugin
+ * @param    {string}   path     The path of the plugin
+ * @param    {Object}   default_settings
+ */
+const Plugin = Function.inherits('Alchemy.Base', function Plugin(name, path, default_settings) {
+
+	// The name of the plugin
+	this.name = name;
+
+	// The path of the plugin
+	this.path = path;
+
+	// The hard-coded default settings
+	this.default_settings = default_settings;
+
+	// Flags
+	this[FLAGS] = {
+		attempted_bootstrap : false,
+		preloaded           : false,
+		created_settings    : false,
+		started             : false,
+	};
+});
+
+/**
+ * Preload the plugin
+ * (Bootstrap & settings)
+ *
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    1.4.0
+ * @version  1.4.0
+ *
+ * @return   {boolean}
+ */
+Plugin.setMethod(function doPreload() {
+
+	if (this[FLAGS].preloaded) {
+		return false;
+	}
+
+	// Create settings from the `config/settings.js` file
+	this.loadSettingDefinitions();
+
+	// Load the bootstrap file
+	this.loadBootstrap();
+
+	PLUGINS_STAGE.addPostTask(() => {
+		return this.startPlugin();
+	});
+});
+
+/**
+ * Do the rest of the plugin loading
+ *
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    1.4.0
+ * @version  1.4.0
+ *
+ * @return   {boolean}
+ */
+Plugin.setMethod(async function startPlugin() {
+
+	if (this[FLAGS].started) {
+		return false;
+	}
+
+	this[FLAGS].started = true;
+
+	await alchemy.useAppPath(this.path, {plugin: this});
+});
+
+/**
+ * Create the setting definitions
+ *
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    1.4.0
+ * @version  1.4.0
+ *
+ * @return   {boolean}
+ */
+Plugin.setMethod(function loadSettingDefinitions() {
+
+	if (this[FLAGS].created_settings) {
+		return false;
+	}
+
+	this[FLAGS].created_settings = true;
+
+	let settings_path = libpath.resolve(this.path, 'config', 'settings.js');
+
+	// See if the file exists
+	if (!libfs.existsSync(settings_path)) {
+		return false;
+	}
+
+	// Get/create this plugin's group definition
+	let group = this.getSettingsGroup();
+
+	// Get any already-existing settings
+	let parent = alchemy.system_settings.get('plugins');
+	let existing = parent.get(this.name);
+
+	if (existing) {
+		// Remove the existing settings.
+		// They are not linked properly anyway.
+		parent.remove(this.name);
+	}
+
+	// Require the settings.js file now
+	this.useFile(settings_path, {client: false});
+
+	// Create the new group settings with default values
+	let default_group = group.generateValue();
+
+	if (this.default_settings) {
+		default_group.setDefaultValue(this.default_settings);
+	}
+
+	if (existing) {
+		default_group.setValueSilently(existing);
+	}
+
+	parent.injectSubGroupValue(this.name, default_group);
+
+	return true;
+});
+
+/**
+ * Load the bootstrap file
+ *
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    1.4.0
+ * @version  1.4.0
+ *
+ * @return   {boolean}
+ */
+Plugin.setMethod(function loadBootstrap() {
+
+	if (this[FLAGS].attempted_bootstrap) {
+		return false;
+	}
+
+	this[FLAGS].attempted_bootstrap = true;
+
+	let bootstrap_path = libpath.resolve(this.path, 'bootstrap.js');
+
+	// See if the file exists
+	if (!libfs.existsSync(bootstrap_path)) {
+		return false;
+	}
+
+	// Require the bootstrap.js file now
+	this.useFile(bootstrap_path, {client: false});
+
+	if (this.default_settings) {
+		let settings_group = this.getSettingsGroup();
+		settings_group.setDefaultValue(this.default_settings);
+	}
+
+	return true;
+});
+
+/**
+ * Use an entire path
+ *
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    1.4.0
+ * @version  1.4.0
+ *
+ * @param    {string}   path
+ * @param    {Object}   options
+ */
+Plugin.setMethod(function usePath(path, options) {
+
+	if (!options) {
+		options = {};
+	}
+
+	options.plugin = this;
+
+	return alchemy.usePath(path, options);
+});
+
+/**
+ * Require a file of this plugin
+ *
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    1.4.0
+ * @version  1.4.0
+ *
+ * @param    {string}   path
+ * @param    {Object}   options
+ *
+ * @return   {Mixed}
+ */
+Plugin.setMethod(function useOnce(path, options) {
+	return this.useFile(path, options);
+});
+
+/**
+ * Require a file of this plugin
+ *
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    1.4.0
+ * @version  1.4.0
+ *
+ * @param    {string}   path
+ * @param    {Object}   options
+ *
+ * @return   {Mixed}
+ */
+Plugin.setMethod(function useFile(path, options) {
+
+	if (!options) {
+		options = {};
+	}
+
+	options.plugin = this;
+
+	if (!options.arguments) {
+
+		let argument_configuration = {
+			values : [
+				Blast,
+				Blast.Classes,
+				Blast.Types,
+				Blast.Collection,
+				Blast.Bound,
+				Blast.Bound.Object,
+				Blast.Collection.Function,
+				this,
+			],
+			names : [
+				'Blast',
+				'Classes',
+				'Types',
+				'Collection',
+				'Bound',
+				'Obj',
+				'Fn',
+				'Plugin',
+			],
+		};
+
+		options.arguments = argument_configuration;
+	}
+
+	if (typeof path == 'string' && path[0] != '/') {
+		path = libpath.resolve(this.path, path);
+	}
+
+	return alchemy.useOnce(path, options);
+});
+
+/**
+ * Get this plugin's settings group
+ *
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    1.4.0
+ * @version  1.4.0
+ *
+ * @return   {Alchemy.Setting.Group}
+ */
+Plugin.setMethod(function getSettingsGroup() {
+
+	let group = Classes.Alchemy.Setting.PLUGINS.get(this.name);
+
+	if (!group) {
+		group = Classes.Alchemy.Setting.PLUGINS.createGroup(this.name);
+	}
+
+	return group;
+});
+
+/**
+ * Add a route
+ *
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    1.4.0
+ * @version  1.4.0
+ *
+ * @return   {Alchemy.Router.Route}
+ */
+Plugin.setMethod(function addRoute(config) {
+	return Router.add(config);
+});
+
+/**
+ * Custom Janeway representation (right side)
+ *
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    1.4.0
+ * @version  1.4.0
+ *
+ * @return   {String}
+ */
+Plugin.setMethod(Symbol.for('janeway_arg_right'), function janewayInstanceInfo() {
+	return this.name;
+});