alchemy-form 0.1.5 → 0.1.8

package/helper/query_builder_variable_definition/00_variable_definition.js

@@ -0,0 +1,371 @@
+/**
+ * ValueType
+ *
+ * @constructor
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    0.1.6
+ * @version  0.1.6
+ *
+ * @param    {Object}   config
+ */
+const VariableDefinition = Function.inherits('Alchemy.Base', 'Alchemy.QueryBuilder.VariableDefinition', function VariableDefinition(config) {
+	this.applyConfig(config);
+});
+
+/**
+ * Make this an abtract class
+ */
+VariableDefinition.makeAbstractClass();
+
+/**
+ * This class starts a new group
+ */
+VariableDefinition.startNewGroup('qb_variable_definitions');
+
+/**
+ * The machine-readable name of the variable
+ *
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    0.1.6
+ * @version  0.1.6
+ */
+VariableDefinition.setProperty('name');
+
+/**
+ * The human-readable title of the variable
+ *
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    0.1.6
+ * @version  0.1.6
+ */
+VariableDefinition.setProperty('title');
+
+/**
+ * The description of the variable
+ *
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    0.1.6
+ * @version  0.1.6
+ */
+VariableDefinition.setProperty('description');
+
+/**
+ * Is this variable readonly? (Mainly used for assignments)
+ *
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    0.1.6
+ * @version  0.1.6
+ */
+VariableDefinition.setProperty('readonly', false);
+
+/**
+ * The flags of this variable
+ *
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    0.1.6
+ * @version  0.1.6
+ */
+VariableDefinition.setProperty('flags');
+
+/**
+ * Get the type_name from the constructor
+ *
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    0.1.6
+ * @version  0.1.6
+ */
+VariableDefinition.setProperty(function type_name() {
+	return this.constructor.type_name;
+});
+
+/**
+ * The `id` property just refers to the `name`
+ *
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    0.1.6
+ * @version  0.1.6
+ */
+VariableDefinition.setProperty(function id() {
+	return this.name;
+});
+
+/**
+ * Make sure this definition has operators
+ *
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    0.1.6
+ * @version  0.1.6
+ */
+VariableDefinition.constitute(function prepareOperators() {
+	this.logical_operators = {};
+	this.assignment_operators = {};
+});
+
+/**
+ * Create the correct variable definition
+ *
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    0.1.6
+ * @version  0.1.6
+ */
+VariableDefinition.setStatic(function cast(entry) {
+
+	if (!entry) {
+		return null;
+	}
+
+	if (entry instanceof VariableDefinition) {
+		return entry;
+	}
+
+	if (!entry.type) {
+		return null;
+	}
+
+	let constructor = VariableDefinition.getMember(entry.type);
+
+	if (!constructor) {
+		return null;
+	}
+
+	let result = new constructor(entry);
+
+	return result;
+});
+
+/**
+ * Add a logical operator
+ *
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    0.1.6
+ * @version  0.1.6
+ *
+ * @param    {String}   name
+ * @param    {Object}   config
+ */
+VariableDefinition.setStatic(function addLogicalOperator(name, config) {
+
+	if (typeof config == 'string') {
+		config = {
+			title : config
+		};
+	} else if (!config) {
+		config = {};
+	}
+
+	if (!config.title) {
+		config.title = name.titleize();
+	}
+
+	// By default logical operators have a binary arity:
+	// they take 2 operands. The value of the variable + another value.
+	if (!config.arity) {
+		config.arity = 'binary';
+	}
+
+	if (config.arity != 'unary' && config.arity != 'binary' && config.arity != 'ternary') {
+		throw new Error('Unable to add Logical operator "' + name + '" to ' + this.name + ', unknown arity: "' + config.arity);
+	}
+
+	config.id = name;
+
+	this.constitute(function _addOperator() {
+		this.logical_operators[name] = config;
+	});
+});
+
+/**
+ * Add an assignment operator
+ *
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    0.1.6
+ * @version  0.1.6
+ *
+ * @param    {String}   name
+ * @param    {Object}   config
+ */
+VariableDefinition.setStatic(function addAssignmentOperator(name, config) {
+
+	if (typeof config == 'string') {
+		config = {
+			title : config
+		};
+	} else if (!config) {
+		config = {};
+	}
+
+	if (!config.title) {
+		config.title = name.titleize();
+	}
+
+	// By default assignment operators have a binary arity:
+	// they take 2 operands. The value of the variable + another value
+	if (!config.arity) {
+		config.arity = 'binary';
+	}
+
+	if (config.arity != 'unary' && config.arity != 'binary' && config.arity != 'ternary') {
+		throw new Error('Unable to add Assignment operator "' + name + '" to ' + this.name + ', unknown arity: "' + config.arity);
+	}
+
+	config.id = name;
+
+	this.constitute(function _addOperator() {
+		this.assignment_operators[name] = config;
+	});
+});
+
+/**
+ * Apply configuration
+ *
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    0.1.6
+ * @version  0.1.6
+ */
+VariableDefinition.setMethod(function applyConfig(config) {
+
+	if (!config) {
+		return;
+	}
+
+	if (config.name != null) {
+		this.name = config.name;
+	}
+
+	if (config.title != null) {
+		this.title = config.title;
+	}
+
+	if (config.description != null) {
+		this.description = config.description;
+	}
+});
+
+/**
+ * Return an simple object for JSON-ifying
+ *
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    0.1.6
+ * @version  0.1.6
+ *
+ * @return   {Object}
+ */
+VariableDefinition.setMethod(function toJSON() {
+	return {
+		name        : this.name,
+		title       : this.title,
+		description : this.description,
+		type        : this.type_name,
+	};
+});
+
+/**
+ * Return an object for json-drying this object
+ *
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    0.1.6
+ * @version  0.1.6
+ *
+ * @return   {Object}
+ */
+VariableDefinition.setMethod(function toDry() {
+	return {
+		value : this.toJSON(),
+	};
+});
+
+/**
+ * unDry an object
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    0.1.6
+ * @version  0.1.6
+ *
+ * @return   {VariableDefinition}
+ */
+VariableDefinition.setStatic(function unDry(obj) {
+	return new this(obj);
+});
+
+/**
+ * Get all available logical operators
+ *
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    0.1.6
+ * @version  0.1.6
+ */
+VariableDefinition.setMethod(function getLogicalOperators(value) {
+	return Object.values(this.constructor.logical_operators);
+});
+
+/**
+ * Get all available logical operators
+ *
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    0.1.6
+ * @version  0.1.6
+ */
+VariableDefinition.setMethod(function getAssignmentOperators(value) {
+	return Object.values(this.constructor.assignment_operators);
+});
+
+/**
+ * Create a value input element
+ *
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    0.1.6
+ * @version  0.1.6
+ */
+VariableDefinition.setMethod(function createValueInput(renderer, value_data) {
+
+	let input = renderer.createElement('input');
+	input.setAttribute('type', 'text');
+
+	return input;
+});
+
+/**
+ * The `equals` operator
+ *
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    0.1.6
+ * @version  0.1.6
+ */
+VariableDefinition.addLogicalOperator('equals');
+
+/**
+ * The `not_equals` operator
+ *
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    0.1.6
+ * @version  0.1.6
+ */
+VariableDefinition.addLogicalOperator('not_equals');
+
+/**
+ * The `is_empty` operator
+ *
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    0.1.6
+ * @version  0.1.6
+ */
+VariableDefinition.addLogicalOperator('is_empty', {arity: 'unary'});
+
+/**
+ * The `is_null` operator
+ *
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    0.1.6
+ * @version  0.1.6
+ */
+VariableDefinition.addLogicalOperator('is_null', {arity: 'unary'});
+
+/**
+ * The `set` operator sets a value
+ *
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    0.1.6
+ * @version  0.1.6
+ */
+VariableDefinition.addAssignmentOperator('set', 'Set');

package/helper/query_builder_variable_definition/boolean_variable_definition.js

@@ -0,0 +1,24 @@
+/**
+ * The Boolean Value Type
+ *
+ * @constructor
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    0.1.6
+ * @version  0.1.6
+ */
+const BooleanDefinition = Function.inherits('Alchemy.QueryBuilder.VariableDefinition', 'Boolean');
+
+/**
+ * Create a value input element
+ *
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    0.1.6
+ * @version  0.1.6
+ *
+ * @param    {Hawkejs.Renderer}
+ */
+BooleanDefinition.setMethod(function createValueInput(renderer) {
+	let toggle = renderer.createElement('alchemy-toggle');
+	return toggle;
+});

package/helper/query_builder_variable_definition/list_variable_definition.js

@@ -0,0 +1,38 @@
+/**
+ * The List Value Type:
+ * Can contain other value types.
+ *
+ * @constructor
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    0.1.7
+ * @version  0.1.7
+ */
+const ListDefinition = Function.inherits('Alchemy.QueryBuilder.VariableDefinition', 'List');
+
+/**
+ * The optional type this list holds
+ *
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    0.1.7
+ * @version  0.1.7
+ */
+ListDefinition.setProperty('content_type');
+
+/**
+ * The `contains` operator
+ *
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    0.1.7
+ * @version  0.1.7
+ */
+ListDefinition.addLogicalOperator('contains');
+
+/**
+ * The `add` assignment operator adds an entry
+ *
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    0.1.7
+ * @version  0.1.7
+ */
+ListDefinition.addAssignmentOperator('add');

package/helper/query_builder_variable_definition/number_variable_definition.js

@@ -0,0 +1,106 @@
+/**
+ * The Number Value Type
+ *
+ * @constructor
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    0.1.6
+ * @version  0.1.6
+ */
+const NumberDefinition = Function.inherits('Alchemy.QueryBuilder.VariableDefinition', 'Number');
+
+/**
+ * The `<` operator
+ *
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    0.1.6
+ * @version  0.1.6
+ */
+NumberDefinition.addLogicalOperator('lt', 'Is Less Than');
+
+/**
+ * The `<=` operator
+ *
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    0.1.6
+ * @version  0.1.6
+ */
+NumberDefinition.addLogicalOperator('lte', 'Is Less Or Equal Than');
+
+/**
+ * The `>` operator
+ *
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    0.1.6
+ * @version  0.1.6
+ */
+NumberDefinition.addLogicalOperator('gt', 'Is Greater Than');
+
+/**
+ * The `>=` operator
+ *
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    0.1.6
+ * @version  0.1.6
+ */
+NumberDefinition.addLogicalOperator('gte', 'Is Greater Or Equal Than');
+
+/**
+ * The `add` assignment operator adds a value
+ *
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    0.1.6
+ * @version  0.1.6
+ */
+NumberDefinition.addAssignmentOperator('add');
+
+/**
+ * The `subtract` assignment operator subtracts a value
+ *
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    0.1.6
+ * @version  0.1.6
+ */
+NumberDefinition.addAssignmentOperator('subtract');
+
+/**
+ * The `multiply` assignment operator multiplies a value
+ *
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    0.1.6
+ * @version  0.1.6
+ */
+NumberDefinition.addAssignmentOperator('multiply');
+
+/**
+ * The `divide` assignment operator divides a value
+ *
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    0.1.6
+ * @version  0.1.6
+ */
+NumberDefinition.addAssignmentOperator('divide');
+
+/**
+ * The `module` assignment operator leaves the rest
+ *
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    0.1.6
+ * @version  0.1.6
+ */
+NumberDefinition.addAssignmentOperator('modulo');
+
+/**
+ * Create a value input element
+ *
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    0.1.6
+ * @version  0.1.6
+ */
+NumberDefinition.setMethod(function createValueInput(renderer, value_data) {
+
+	let input = renderer.createElement('input');
+	input.setAttribute('type', 'number');
+
+	return input;
+});

package/helper/query_builder_variable_definition/string_variable_definition.js

@@ -0,0 +1,46 @@
+/**
+ * The String Value Type
+ *
+ * @constructor
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    0.1.6
+ * @version  0.1.6
+ */
+const StringDefinition = Function.inherits('Alchemy.QueryBuilder.VariableDefinition', 'String');
+
+/**
+ * The `contains` operator
+ *
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    0.1.6
+ * @version  0.1.6
+ */
+StringDefinition.addLogicalOperator('contains');
+
+/**
+ * The `starts_with` operator
+ *
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    0.1.6
+ * @version  0.1.6
+ */
+StringDefinition.addLogicalOperator('starts_with');
+
+/**
+ * The `ends_with` operator
+ *
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    0.1.6
+ * @version  0.1.6
+ */
+StringDefinition.addLogicalOperator('ends_with');
+
+/**
+ * The `append` assignment operator adds text
+ *
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    0.1.6
+ * @version  0.1.6
+ */
+StringDefinition.addAssignmentOperator('append');

package/helper_field/query_builder_assignment.js

@@ -0,0 +1,11 @@
+/**
+ * A QueryBuilderAssignment field lets you set variable values
+ * using the QueryBuilder logic
+ *
+ * @constructor
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    0.1.6
+ * @version  0.1.6
+ */
+const QueryBuilderAssignment = Function.inherits('Alchemy.Field.QueryBuilder', 'QueryBuilderAssignment');

package/helper_field/query_builder_field.js

@@ -0,0 +1,91 @@
+/**
+ * Schema fields are nested schema's
+ *
+ * @constructor
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    0.1.6
+ * @version  0.1.6
+ */
+const QueryBuilderField = Function.inherits('Alchemy.Field', function QueryBuilder(schema, name, options) {
+
+	if (!options) {
+		options = {};
+	}
+
+	QueryBuilder.super.call(this, schema, name, options);
+});
+
+/**
+ * Set the datatype name
+ *
+ * @author   Jelle De Loecker   <jelle@develry.be>
+ * @since    0.1.6
+ * @version  0.1.6
+ */
+QueryBuilderField.setDatatype('object');
+
+/**
+ * This field value is self-contained
+ *
+ * @author   Jelle De Loecker   <jelle@develry.be>
+ * @since    0.1.6
+ * @version  0.1.6
+ */
+QueryBuilderField.setSelfContained(true);
+
+/**
+ * Cast the given value to this field's type
+ *
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    0.1.6
+ * @version  0.1.6
+ */
+QueryBuilderField.setMethod(function cast(value, to_datasource) {
+	return value;
+});
+
+/**
+ * Load remote data
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    0.1.6
+ * @version  0.1.6
+ *
+ * @param    {Object}        config
+ * @param    {HTMLElement}   element
+ */
+QueryBuilderField.setMethod(function loadData(config, element) {
+
+	if (element) {
+		let form = element.queryParents('alchemy-form');
+
+		if (form) {
+			let doc = form.document;
+
+			if (doc && doc.root_document) {
+				doc = doc.root_document;
+			}
+
+			let model_name,
+			    $pk;
+			
+			if (doc) {
+				model_name = doc.$model_name;
+				$pk = doc.$pk;
+			}
+
+			return element.hawkejs_helpers.Alchemy.getResource({
+				name  : 'FormApi#queryBuilderData',
+				post  : true,
+				body  : {
+					model        : model_name,
+					$pk          : $pk,
+					config       : config,
+				}
+			});
+		}
+	}
+
+	return [];
+});