Merge pull request #18 from CodingCarlos/modifiers

First idea on modifiers

Author: CodingCarlos

examples/validators/default.js

@@ -0,0 +1,17 @@
+/* Just a first basic test */
+var Modelate = require('../../index');
+// In production, just change the require for:
+// var Modelate = require('modelate');
+
+var model = {
+	name: {
+		default: 'I am the default value'
+	}
+};
+var user = Modelate('User').set(model);
+
+var data = {};
+var result = user.modelate(data);
+
+
+console.log(result);	// Shall be { name: 'I am the default value' }

lib/modelate.js

@@ -2,6 +2,7 @@ const util = require('./util');
 
 const models = require('./model').models;
 const validate = require('./validate').check;
+const modify = require('./modify').check;
 
 /**
  *	Create a new modelate, validating all properties
@@ -19,6 +20,10 @@ function modelate(data, opts) {
 	const result = util.clone(model) || {};
 
 	for (const prop in model) {
+		// Step 1: Apply the modifiers
+		data[prop] = modify(data[prop], model[prop]);
+
+		// Step 2: validate the result
 		if (validate(data[prop], model[prop])) {
 			result[prop] = data[prop];
 		} else {

lib/modifiers/default.js

@@ -0,0 +1,22 @@
+/**
+ *	Default modifier
+ *
+ *	{
+ *		default: value	// If no value set, write this.
+ *	}
+ */
+
+function modify(data, model) {
+	if (!model.default) {
+		return null;
+	}
+
+	if (!data) {
+		return model.default;
+	}
+
+	return null;
+}
+
+
+module.exports = modify;

lib/modify.js

@@ -0,0 +1,38 @@
+
+// Add modifier names here
+const modifiers = ['default'];
+
+// Turn modifier names to modifier instances.
+for (let i = 0; i < modifiers.length; i++) {
+	modifiers[i] = modifier(modifiers[i]);
+}
+
+/**
+ *	Validate
+ *	
+ *	@param data {Object} Data to validate
+ *	@param model {Object} Model to apply validations
+ */
+function modify(data, model) {
+	for (let i = 0; i < modifiers.length; i++) {
+		const newValue = modifiers[i].check(data, model);
+		return newValue ? newValue : data;
+	}
+
+	return true;
+}
+
+/**
+ *	Create new modifier instances
+ */
+function modifier(name) {
+	return {
+		name: name,
+		check: require('./modifiers/' + name),
+	};
+}
+
+module.exports = {
+	modifiers: modifiers, 
+	check: modify 
+};

spec/modifiers/default.spec.js

@@ -0,0 +1,24 @@
+var valid = require('../../lib/modifiers/default');
+
+const model = {
+	default: 'default value'
+};
+
+describe(' - Default modifier', () => {
+	it('shall be a function', () => {
+		expect(typeof valid).toEqual('function');
+	});
+
+	it('shall not modify data when no model set', () => {
+		expect(valid('validData', {})).toEqual(null);
+		expect(valid(undefined, {})).toEqual(null);
+	});
+
+	it('shall not modify data if exists and model set', () => {
+		expect(valid('validData', model)).toEqual(null);
+	});
+
+	it('shall return the default value when not data and model set', () => {
+		expect(valid(undefined, model)).toEqual(model.default);
+	});
+});

spec/validators/value.spec.js

@@ -248,7 +248,7 @@ describe(' - Date validator', () => {
 				}
 			};
 
-			expect(valid('string', model)).toEqual(false);
+			expect(valid('whatever', model)).toEqual(false);
 		});
 
 		// Again the for loop here! ^^