Here is an example of a validation object. This technique will validate arguments and produce error messages when users put in bad values. The validation object contains methods and properties that it uses for its own functionality, but at the bottom are key-value objects which are keyed by the function name and have properties which are keyed by the function's argument names. Those property objects have some generic checking properties such as 'regex' and 'min', 'max', etc. Since a lot of these would be duplicated and this validation object can grow very big, some custom or elaborate validations such as the "email" field example could be extracted to stand-alone named functions which can then be assigned to the 'parsingFunction' property. Otherwise, the collection of per-property validations could be put into a separate object in its own file.
#target illustrator
function test () {
if (!Array.prototype.indexOf) {
Array.prototype.indexOf = function(searchElement, fromIndex) {
var k;
if (this == null) {
throw new TypeError('"this" is null or not defined');
}
var o = Object(this);
var len = o.length >>> 0;
if (len === 0) {
return -1;
}
var n = +fromIndex || 0;
if (Math.abs(n) === Infinity) {
n = 0;
}
if (n >= len) {
return -1;
}
k = Math.max(n >= 0 ? n : len - Math.abs(n), 0);
while (k < len) {
if (k in o && o[k] === searchElement) {
return k;
}
k++;
}
return -1;
};
};
const FruitTypes = {
APPLE : "apple",
BANANA : "banana"
};
const ShapeTypes = {
CIRCLE : 0,
SQUARE : 1,
TRIANGLE : 2
};
const StringKeyValidations = {
debugLevel : 0,
validationLog : [],
notifyMessage : function (str, func) {
this.validationLog.push(func.name + "() : " + str);
if (this.debugLevel == 1) {
$.writeln(str);
} else if (this.debugLevel == 2) {
alert(str);
}
},
getPropValues : function (obj) {
var arr = [];
for (var all in obj) {
arr.push(obj[all]);
}
return arr;
},
validateProperty : function (func, propName, val) {
var funcName = func.name;
var prop = this[funcName][propName];
var STRING = "string";
var NUMBER = "number";
var MIN = "min";
var MAX = "max";
var MAXLENGTH = "maxLength";
var MINLENGTH = "minLength";
var REGEX = "regex";
var PARSINGFUNCTION = "parsingFunction";
var thisValueType = typeof(val);
if (prop.type == STRING) {
if (thisValueType != STRING) {
this.notifyMessage("Value of '" + propName + "' is expected to be '" + STRING + "', got '" + thisValueType + "'", func);
return false;
}
if (MAXLENGTH in prop) {
var maxLength = prop[MAXLENGTH];
if (val.length > maxLength) {
this.notifyMessage("Length of '" + propName + "' is expected to be at most '" + maxLength + "', got '" + val.length + "'", func);
return false;
}
}
if (MINLENGTH in prop) {
var minLength = prop[MINLENGTH];
if (val.length < minLength) {
this.notifyMessage("Length of '" + propName + "' is expected to be at least '" + minLength + "', got '" + val.length + "'", func);
return false;
}
}
if (REGEX in prop) {
var regex = prop[REGEX];
if (!regex.test(val)) {
this.notifyMessage("'" + propName + "' does not pass regular expression test '" + regex + "'.", func);
return false;
}
}
} else if (prop.type == "number") {
if (thisValueType != NUMBER) {
this.notifyMessage("Value of '" + propName + "' is expected to be '" + NUMBER + "', got '" + thisValueType + "'", func);
return false;
}
if (MIN in prop) {
var min = prop[MIN];
if (val < min) {
this.notifyMessage("'" + propName + "' is expected to be at least '" + min + "', got '" + val + "'", func);
return false;
}
}
if (MAX in prop) {
var max = prop[MAX];
if (val > max) {
this.notifyMessage("'" + propName + "' is expected to be at most '" + max + "', got '" + val + "'", func);
return false;
}
}
} else if (typeof(prop.type) == "object") {
// enum check
var validValues = this.getPropValues(prop.type);
if (validValues.indexOf(val) == -1) {
this.notifyMessage("'" + propName + "' value '" + val + "' is not among expected values: '" + validValues.join(", ") + "'", func);
return false;
}
}
if (PARSINGFUNCTION in prop) {
var parsedResult = prop[PARSINGFUNCTION](val);
if (!parsedResult.status) {
this.notifyMessage(parsedResult.message, func);
return false;
}
}
return true;
},
//============================================================ validations for each function ================================================//
getCustomString_3 : {
userName : {
type : "string",
maxLength : 20
},
email : {
type : "string",
parsingFunction : function (str) {
var result = { status : true, message : "Success" };
var isValid = str.indexOf("@") > -1;
if (!isValid) {
result.message = ("This should be a valid email.");
result.status = false;
return result;
}
return result;
}
},
phone : {
type : "string",
regex : /^[\+]?[(]?[0-9]{3}[)]?[-\s\.]?[0-9]{3}[-\s\.]?[0-9]{4,6}$/i
}
},
getCustomString_4 : {
fruitChoice : {
type : FruitTypes
},
shapeChoice : {
type : ShapeTypes
},
someAmount : {
type : "number",
min : 1,
max : 100
}
}
};
function setDefaultsWithValidation (defaultObj, func, args) {
var argNames = func.toString().match(/function\s[a-z0-9_]+\s?\((([a-z0-9_]\s?,?\s?)+)\)/i)[1].split(/\s?,\s?/g);
var thisArg, thisArgName, isValid;
for (var i = 0; i < args.length; i++) {
thisArg = args[i];
thisArgName = argNames[i];
if (!(thisArgName in defaultObj)) {
continue;
}
if (typeof(thisArg) != "undefined") {
isValid = StringKeyValidations.validateProperty(func, thisArgName, thisArg);
if (!isValid) {
continue;
}
defaultObj[thisArgName] = args[i];
}
}
return defaultObj;
}
function getCustomString_3 (itemArg, userName, email, phone) {
var paramObj = setDefaultsWithValidation(
{
userName : "Bob",
email : "bob@bob.com",
phone : null
},
arguments.callee,
arguments
);
var templateString = "User name: #userName#\nEmail: #email#\nPhone: #phone#";
for (var all in paramObj) {
templateString = templateString.replace("#" + all + "#", paramObj[all]);
}
return templateString;
}
alert(getCustomString_3("SomeItem", "Suzy", undefined, "000.222.2323")); // ok
alert(getCustomString_3("SomeItem", "Suzy", "bad_email_with_no_at", "000.222.2323")); // validation error
alert(getCustomString_3("SomeItem", "Suzy", "suzy@aol.com", "000.2-----22.2323")); // validation error
function getCustomString_4 (itemArg, fruitChoice, shapeChoice, someAmount) {
var paramObj = setDefaultsWithValidation(
{
fruitChoice : "apple",
shapeChoice : 0,
someAmount : 1
},
arguments.callee,
arguments
);
var templateString = "Fruit Choice: #fruitChoice#\nShape Choice: #shapeChoice#\nSome Amount: #someAmount#";
for (var all in paramObj) {
templateString = templateString.replace("#" + all + "#", paramObj[all]);
}
return templateString;
}
alert(getCustomString_4("SomeItem", "banana", 2, 10)); // ok
alert(getCustomString_4("SomeItem", "watermelon", 5, -10)); // validation error
alert(StringKeyValidations.validationLog.join("\n"));
};
test();
Plus, the default object can now be moved into the validation object using some property such as ".default".
The functions can be augmented so that when it does not validate, the default value is pulled from the validation property object.
1 Correct answer
27
Replies
AdChoices