alchemymvc 1.3.21 → 1.4.0-alpha.1

package/lib/app/helper_model/remote_data_provider.js

@@ -1,7 +1,7 @@
 /**
  * The Remote DataProvider class
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.2.2
  * @version  1.2.2
  */
@@ -81,7 +81,7 @@ RemoteDataProvider.setMethod(function getById(id) {
  * @since    1.2.2
  * @version  1.3.13
  *
- * @param    {Number}   page   1-indexed page number
+ * @param    {number}   page   1-indexed page number
  */
 RemoteDataProvider.setMethod(function getPage(page) {
 	return this.performSourceRequest('page', {

package/lib/app/helper_validator/00_validator.js

@@ -4,7 +4,7 @@
  *
  * @constructor
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.0.5
  * @version  1.1.0
  *
@@ -17,18 +17,18 @@ var Validator = Function.inherits('Alchemy.Base', 'Alchemy.Validator', function
 /**
  * The error message to use
  *
- * @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}
  */
 Validator.setProperty('error_message', '{field} violates the {rule} rule');
 
 /**
  * Revive a dried validator
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.1.0
  * @version  1.1.0
  *
@@ -41,7 +41,7 @@ Validator.setStatic(function unDry(value) {
 /**
  * Return an object for json-drying this validator
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.2.0
  * @version  1.1.0
  *
@@ -58,13 +58,13 @@ Validator.setMethod(function toDry() {
 /**
  * Get the invalid message for the given field
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.1.0
  * @version  1.3.1
  *
  * @param    {FieldValue}   fv   The FieldValue instance
  *
- * @return   {String}
+ * @return   {string}
  */
 Validator.setTypedMethod([Types.Alchemy.FieldValue], function getInvalidFieldMessage(fv) {
 
@@ -84,7 +84,7 @@ Validator.setTypedMethod([Types.Alchemy.FieldValue], function getInvalidFieldMes
 /**
  * Create a violation for this validator
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.1.0
  * @version  1.1.4
  *
@@ -108,7 +108,7 @@ Validator.setMethod(function createFieldViolation(fv) {
 /**
  * Validate a value
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.3.1
  * @version  1.3.1
  *
@@ -124,12 +124,12 @@ Validator.setTypedMethod([Types.Alchemy.Field, Types.Any], function validateFiel
 /**
  * Validate a value
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.3.1
  * @version  1.3.1
  *
  * @param    {Field}   field
- * @param    {String}  path
+ * @param    {string}  path
  * @param    {*}       value
  *
  * @return   {Promise<Violation|undefined>}
@@ -142,7 +142,7 @@ Validator.setTypedMethod([Types.Alchemy.Field, Types.String, Types.Any], functio
 /**
  * Validate a value
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.1.0
  * @version  1.3.1
  *
@@ -190,7 +190,7 @@ Validator.setTypedMethod([Types.Alchemy.FieldValue.array()], async function vali
 /**
  * Validate the given document
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.1.0
  * @version  1.1.0
  *
@@ -240,13 +240,13 @@ Validator.setMethod(async function validateDocument(root, context, schema) {
 /**
  * Does this rule apply to the given field?
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.1.0
  * @version  1.1.0
  *
- * @param    {String|Field}   field   The field to check
+ * @param    {string|Field}   field   The field to check
  *
- * @return   {Boolean}
+ * @return   {boolean}
  */
 Validator.setMethod(function appliesToField(field) {
 

package/lib/app/helper_validator/not_empty_validator.js

@@ -4,7 +4,7 @@
  *
  * @constructor
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.0.5
  * @version  1.0.5
  *
@@ -15,46 +15,46 @@ const NotEmpty = Function.inherits('Alchemy.Validator', 'NotEmpty');
 /**
  * The message to use inside errors
  *
- * @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}
  */
 NotEmpty.setProperty('error_message', '{field} must not be empty');
 
 /**
  * The microcopy to use for users
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.1.4
  * @version  1.1.4
  *
- * @type     {String}
+ * @type     {string}
  */
 NotEmpty.setProperty('error_microcopy', 'cannot-be-empty');
 
 /**
  * This validator should not pass when there are no values
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.1.0
  * @version  1.1.0
  *
- * @type     {Boolean}
+ * @type     {boolean}
  */
 NotEmpty.setProperty('error_when_no_values', true);
 
 /**
  * Validate the value
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.0.5
  * @version  1.1.0
  *
  * @param    {FieldValue}   fv   The FieldValue instance
  *
- * @return   {Boolean}
+ * @return   {boolean}
  */
 NotEmpty.setMethod(function validate(fv) {
 

package/lib/app/model/00-default_app_model.js

@@ -0,0 +1,18 @@
+/**
+ * The default App model class.
+ * The main app can use this to extend from and add custom functionality.
+ *
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    1.4.0
+ * @version  1.4.0
+ */
+const App = Function.inherits('Alchemy.Model', 'App');
+
+/**
+ * Mark this class as being abstract
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    1.4.0
+ * @version  1.4.0
+ */
+App.makeAbstractClass();

package/lib/app/model/05-system_model.js

@@ -0,0 +1,27 @@
+/**
+ * The base System model class.
+ * Models meant for the Alchemy system.
+ *
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    1.4.0
+ * @version  1.4.0
+ */
+const System = Function.inherits('Alchemy.Model.App', 'Alchemy.Model.System', 'System');
+
+/**
+ * Mark this class as being abstract
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    1.4.0
+ * @version  1.4.0
+ */
+System.makeAbstractClass();
+
+/**
+ * Use the `alchemy` prefix for the table name
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    1.4.0
+ * @version  1.4.0
+ */
+System.setTablePrefix('alchemy');

package/lib/app/model/{alchemy_migration_model.js → system_migration_model.js}

@@ -3,20 +3,20 @@
  *
  * @constructor
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.2.0
  * @version  1.2.0
  */
-const AlchemyMigration = Function.inherits('Alchemy.Model.App', 'AlchemyMigration');
+const Migration = Function.inherits('Alchemy.Model.System', 'Migration');
 
 /**
  * Constitute the class wide schema
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.2.0
  * @version  1.2.0
  */
-AlchemyMigration.constitute(function addTaskFields() {
+Migration.constitute(function addTaskFields() {
 
 	// The name of the migration
 	this.addField('name', 'String');

package/lib/app/model/system_setting_model.js

@@ -0,0 +1,154 @@
+/**
+ * The Alchemy Setting model:
+ * Contains all the system settings of Alchemy.
+ *
+ * @constructor
+ *
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    1.4.0
+ * @version  1.4.0
+ */
+const SystemSetting = Function.inherits('Alchemy.Model.System', 'Setting');
+
+/**
+ * Constitute the class wide schema
+ *
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    1.4.0
+ * @version  1.4.0
+ */
+SystemSetting.constitute(function addTaskFields() {
+
+	this.addField('setting_id', 'Enum', {
+		description: 'The setting id',
+		values     : Classes.Alchemy.Setting.SYSTEM.createEnumMap(),
+	});
+
+	this.addField('configuration', 'Schema', {
+		description: 'The actual configuration of the setting',
+		schema     : 'setting_id',
+	});
+});
+
+/**
+ * Configure the default chimera fieldsets
+ *
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    1.4.0
+ * @version  1.4.0
+ */
+SystemSetting.constitute(function chimeraConfig() {
+
+	if (!this.chimera) {
+		return;
+	}
+
+	// Get the list group
+	let list = this.chimera.getActionFields('list');
+
+	list.addField('setting_id');
+
+	// Get the edit group
+	let edit = this.chimera.getActionFields('edit');
+
+	edit.addField('setting_id');
+	edit.addField('configuration')
+});
+
+/**
+ * Apply the given changes
+ *
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    1.4.0
+ * @version  1.4.0
+ *
+ * @param    {Object}   changes
+ * @param    {Conduit}  permission_context
+ */
+SystemSetting.setMethod(async function saveChanges(changes, permission_context) {
+
+	if (!changes) {
+		return;
+	}
+
+	let setting_id,
+	    new_value,
+	    setting,
+	    doc;
+
+	for (setting_id in changes) {
+		new_value = changes[setting_id];
+		setting = Classes.Alchemy.Setting.SYSTEM.get(setting_id);
+
+		if (!setting) {
+			throw new Error('Unknown setting: ' + setting_id);
+		}
+
+		// We don't throw an error here:
+		// we assume the user should not have seen this setting anyway
+		if (!setting.canBeEditedBy(permission_context)) {
+			continue;
+		}
+
+		doc = await this.findByValues({
+			setting_id: setting_id
+		});
+
+		if (!doc) {
+			doc = this.createDocument({
+				setting_id
+			});
+		}
+
+		doc.configuration = setting.createConfigurationObject(new_value);
+
+		await doc.save();
+	}
+});
+
+/**
+ * Do something before saving the record
+ *
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    1.4.0
+ * @version  1.4.0
+ *
+ * @param    {Document.AlchemyTask}   doc
+ */
+SystemSetting.setMethod(function beforeSave(doc) {
+	return doc.applySetting();
+});
+
+/**
+ * Apply this setting
+ *
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    1.4.0
+ * @version  1.4.0
+ *
+ * @param    {boolean}   do_actions   Should the setting actions be executed
+ */
+SystemSetting.setDocumentMethod(function applySetting(do_actions = true) {
+
+	if (!this.setting_id) {
+		return;
+	}
+
+	let setting = Classes.Alchemy.Setting.SYSTEM.get(this.setting_id);
+
+	if (!setting) {
+		return;
+	}
+
+	let existing_value = alchemy.system_settings.getPath(this.setting_id);
+
+	if (!existing_value) {
+		existing_value = setting.generateValue();
+	}
+
+	if (do_actions) {
+		return existing_value.setValue(this.configuration.value);
+	} else {
+		return existing_value.setValueSilently(this.configuration.value);
+	}
+});

package/lib/app/model/{alchemy_task_history_model.js → system_task_history_model.js}

@@ -4,22 +4,22 @@
  *
  * @constructor
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.5.0
  * @version  0.5.0
  */
-const AlchemyTaskHistory = Function.inherits('Alchemy.Model.App', 'AlchemyTaskHistory');
+const SystemTaskHistory = Function.inherits('Alchemy.Model.System', 'TaskHistory');
 
 /**
  * Constitute the class wide schema
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.5.0
  * @version  1.3.17
  */
-AlchemyTaskHistory.constitute(function addTaskFields() {
+SystemTaskHistory.constitute(function addTaskFields() {
 
-	this.belongsTo('AlchemyTask', {
+	this.belongsTo('System.Task', {
 		description : 'The original AlchemyTask document it belonged to',
 	});
 
@@ -75,11 +75,11 @@ AlchemyTaskHistory.constitute(function addTaskFields() {
 /**
  * Configure the default chimera fieldsets
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.3.17
  * @version  1.3.17
  */
-AlchemyTaskHistory.constitute(function chimeraConfig() {
+SystemTaskHistory.constitute(function chimeraConfig() {
 
 	if (!this.chimera) {
 		return;

package/lib/app/model/{alchemy_task_model.js → system_task_model.js}

@@ -4,20 +4,20 @@
  *
  * @constructor
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.3.17
  * @version  1.3.17
  */
-const AlchemyTask = Function.inherits('Alchemy.Model.App', 'AlchemyTask');
+const SystemTask = Function.inherits('Alchemy.Model.System', 'Task');
 
 /**
  * Constitute the class wide schema
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.3.17
  * @version  1.3.17
  */
-AlchemyTask.constitute(function addTaskFields() {
+SystemTask.constitute(function addTaskFields() {
 
 	this.addField('title', 'String', {
 		description : 'The title of the task',
@@ -68,11 +68,11 @@ AlchemyTask.constitute(function addTaskFields() {
 /**
  * Configure the default chimera fieldsets
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.3.17
  * @version  1.3.17
  */
-AlchemyTask.constitute(function chimeraConfig() {
+SystemTask.constitute(function chimeraConfig() {
 
 	if (!this.chimera) {
 		return;
@@ -101,13 +101,13 @@ AlchemyTask.constitute(function chimeraConfig() {
 /**
  * Do something before saving the record
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.3.17
  * @version  1.3.17
  *
- * @param    {Document.AlchemyTask}   doc
+ * @param    {Document.SystemTask}   doc
  */
-AlchemyTask.setMethod(function beforeSave(doc) {
+SystemTask.setMethod(function beforeSave(doc) {
 
 	if (!doc.schedule_type) {
 		doc.schedule_type = 'user';
@@ -136,14 +136,14 @@ AlchemyTask.setMethod(function beforeSave(doc) {
 /**
  * Update the schedules after saving
  *
- * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    1.3.17
  * @version  1.3.17
  *
  * @param    {Object}   main
  * @param    {Object}   info
  */
-AlchemyTask.setMethod(function afterSave(main, info) {
+SystemTask.setMethod(function afterSave(main, info) {
 
 	if (!main.type) {
 		return;