You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
654 lines
20 KiB
654 lines
20 KiB
/* ******************************
|
|
Form Validation Components
|
|
Author: Jack Lukic
|
|
Notes: First Commit April 08, 2012
|
|
|
|
Refactored May 28, 2013
|
|
|
|
Allows you to validate forms based on a form validation object
|
|
Form validation objects are bound by either data-validate="" metadata, or form id or name tags
|
|
|
|
****************************** */
|
|
|
|
;(function ( $, window, document, undefined ) {
|
|
|
|
$.fn.form = function(fields, parameters) {
|
|
var
|
|
$allModules = $(this),
|
|
|
|
settings = $.extend(true, {}, $.fn.form.settings, parameters),
|
|
validation = $.extend({}, $.fn.form.settings.defaults, fields),
|
|
|
|
namespace = settings.namespace,
|
|
metadata = settings.metadata,
|
|
selector = settings.selector,
|
|
className = settings.className,
|
|
error = settings.error,
|
|
|
|
eventNamespace = '.' + namespace,
|
|
moduleNamespace = 'module-' + namespace,
|
|
|
|
moduleSelector = $allModules.selector || '',
|
|
|
|
time = new Date().getTime(),
|
|
performance = [],
|
|
|
|
query = arguments[0],
|
|
methodInvoked = (typeof query == 'string'),
|
|
queryArguments = [].slice.call(arguments, 1),
|
|
invokedResponse
|
|
;
|
|
$allModules
|
|
.each(function() {
|
|
var
|
|
$module = $(this),
|
|
$field = $(this).find(selector.field),
|
|
$group = $(this).find(selector.group),
|
|
$message = $(this).find(selector.message),
|
|
$prompt = $(this).find(selector.prompt),
|
|
$submit = $(this).find(selector.submit),
|
|
|
|
formErrors = [],
|
|
|
|
element = this,
|
|
instance = $module.data(moduleNamespace),
|
|
module
|
|
;
|
|
|
|
module = {
|
|
|
|
initialize: function() {
|
|
module.verbose('Initializing form validation', $module, validation, settings);
|
|
if(settings.keyboardShortcuts) {
|
|
$field
|
|
.on('keydown' + eventNamespace, module.event.field.keydown)
|
|
;
|
|
}
|
|
$module
|
|
.on('submit' + eventNamespace, module.validate.form)
|
|
;
|
|
$field
|
|
.on('blur' + eventNamespace, module.event.field.change)
|
|
;
|
|
$submit
|
|
.on('click' + eventNamespace, module.submit)
|
|
;
|
|
module.instantiate();
|
|
},
|
|
|
|
instantiate: function() {
|
|
module.verbose('Storing instance of module', module);
|
|
instance = module;
|
|
$module
|
|
.data(moduleNamespace, module)
|
|
;
|
|
},
|
|
|
|
destroy: function() {
|
|
module.verbose('Destroying previous module', instance);
|
|
$module
|
|
.off(eventNamespace)
|
|
.removeData(moduleNamespace)
|
|
;
|
|
},
|
|
|
|
refresh: function() {
|
|
module.verbose('Refreshing selector cache');
|
|
$field = $module.find(selector.field);
|
|
},
|
|
|
|
submit: function() {
|
|
module.verbose('Submitting form', $module);
|
|
$module
|
|
.submit()
|
|
;
|
|
},
|
|
|
|
event: {
|
|
field: {
|
|
keydown: function(event) {
|
|
var
|
|
$field = $(this),
|
|
key = event.which,
|
|
keyCode = {
|
|
enter : 13,
|
|
escape : 27
|
|
}
|
|
;
|
|
if( key == keyCode.escape) {
|
|
module.verbose('Escape key pressed blurring field');
|
|
$field
|
|
.blur()
|
|
;
|
|
}
|
|
if( key == keyCode.enter && $field.is(selector.input) ) {
|
|
module.debug('Enter key pressed, submitting form');
|
|
$submit
|
|
.addClass(className.down)
|
|
;
|
|
$field
|
|
.one('keyup' + eventNamespace, module.event.field.keyup)
|
|
;
|
|
event.preventDefault();
|
|
return false;
|
|
}
|
|
},
|
|
keyup: function() {
|
|
module.verbose('Doing keyboard shortcut form submit');
|
|
$submit.removeClass(className.down);
|
|
module.submit();
|
|
},
|
|
change: function() {
|
|
var
|
|
$field = $(this),
|
|
$fieldGroup = $field.closest($group)
|
|
;
|
|
if( $fieldGroup.hasClass(className.error) ) {
|
|
module.debug('Revalidating field', $field, module.get.validation($field));
|
|
module.validate.field( module.get.validation($field) );
|
|
}
|
|
else if(settings.on == 'change') {
|
|
module.validate.field( module.get.validation($field) );
|
|
}
|
|
}
|
|
}
|
|
|
|
},
|
|
|
|
get: {
|
|
field: function(identifier) {
|
|
module.verbose('Finding field with identifier', identifier);
|
|
if( $field.filter('#' + identifier).size() > 0 ) {
|
|
return $field.filter('#' + identifier);
|
|
}
|
|
else if( $field.filter('[name="' + identifier +'"]').size() > 0 ) {
|
|
return $field.filter('[name="' + identifier +'"]');
|
|
}
|
|
else if( $field.filter('[data-' + metadata.validate + '="'+ identifier +'"]').size() > 0 ) {
|
|
return $field.filter('[data-' + metadata.validate + '="'+ identifier +'"]');
|
|
}
|
|
return $('<input/>');
|
|
},
|
|
validation: function($field) {
|
|
var
|
|
rules
|
|
;
|
|
$.each(validation, function(fieldName, field) {
|
|
if( module.get.field(field.identifier).get(0) == $field.get(0) ) {
|
|
rules = field;
|
|
}
|
|
});
|
|
return rules || false;
|
|
}
|
|
},
|
|
|
|
has: {
|
|
|
|
field: function(identifier) {
|
|
module.verbose('Checking for existence of a field with identifier', identifier);
|
|
if( $field.filter('#' + identifier).size() > 0 ) {
|
|
return true;
|
|
}
|
|
else if( $field.filter('[name="' + identifier +'"]').size() > 0 ) {
|
|
return true;
|
|
}
|
|
else if( $field.filter('[data-' + metadata.validate + '="'+ identifier +'"]').size() > 0 ) {
|
|
return true;
|
|
}
|
|
return false;
|
|
}
|
|
|
|
},
|
|
|
|
add: {
|
|
prompt: function(field, errors) {
|
|
var
|
|
$field = module.get.field(field.identifier),
|
|
$fieldGroup = $field.closest($group),
|
|
$prompt = $fieldGroup.find(selector.prompt),
|
|
promptExists = ($prompt.size() !== 0)
|
|
;
|
|
module.verbose('Adding inline validation prompt');
|
|
$fieldGroup
|
|
.addClass(className.error)
|
|
;
|
|
if(settings.inlineError) {
|
|
if(!promptExists) {
|
|
$prompt = settings.templates.prompt(errors);
|
|
$prompt
|
|
.appendTo($fieldGroup)
|
|
.hide()
|
|
;
|
|
}
|
|
$prompt
|
|
.html(errors[0])
|
|
;
|
|
if($prompt.is(':not(:visible)')) {
|
|
$prompt
|
|
.fadeIn(settings.animateSpeed)
|
|
;
|
|
}
|
|
}
|
|
},
|
|
errors: function(errors) {
|
|
module.debug('Adding form error messages', errors);
|
|
$message
|
|
.html( settings.templates.error(errors) )
|
|
;
|
|
}
|
|
},
|
|
|
|
remove: {
|
|
prompt: function(field) {
|
|
var
|
|
$field = module.get.field(field.identifier),
|
|
$fieldGroup = $field.closest($group),
|
|
$prompt = $fieldGroup.find(selector.prompt)
|
|
;
|
|
$fieldGroup
|
|
.removeClass(className.error)
|
|
;
|
|
if(settings.inlineError) {
|
|
$prompt.hide();
|
|
}
|
|
}
|
|
},
|
|
|
|
validate: {
|
|
|
|
form: function(event) {
|
|
var
|
|
allValid = true
|
|
;
|
|
// reset errors
|
|
formErrors = [];
|
|
$.each(validation, function(fieldName, field) {
|
|
if( !( module.validate.field(field) ) ) {
|
|
allValid = false;
|
|
}
|
|
});
|
|
if(allValid) {
|
|
module.debug('Form has no validation errors, submitting');
|
|
$module
|
|
.removeClass(className.error)
|
|
.addClass(className.success)
|
|
;
|
|
$.proxy(settings.onSuccess, this)(event);
|
|
}
|
|
else {
|
|
module.debug('Form has errors');
|
|
$module.addClass(className.error);
|
|
if(!settings.inlineError) {
|
|
module.add.errors(formErrors);
|
|
}
|
|
return $.proxy(settings.onFailure, this)(formErrors);
|
|
}
|
|
},
|
|
|
|
// takes a validation object and returns whether field passes validation
|
|
field: function(field) {
|
|
var
|
|
$field = module.get.field(field.identifier),
|
|
fieldValid = true,
|
|
fieldErrors = []
|
|
;
|
|
if(field.rules !== undefined) {
|
|
$.each(field.rules, function(index, rule) {
|
|
if( module.has.field(field.identifier) && !( module.validate.rule(field, rule) ) ) {
|
|
module.debug('Field is invalid', field.identifier, rule.type);
|
|
fieldErrors.push(rule.prompt);
|
|
fieldValid = false;
|
|
}
|
|
});
|
|
}
|
|
if(fieldValid) {
|
|
module.remove.prompt(field, fieldErrors);
|
|
$.proxy(settings.onValid, $field)();
|
|
}
|
|
else {
|
|
formErrors = formErrors.concat(fieldErrors);
|
|
module.add.prompt(field, fieldErrors);
|
|
$.proxy(settings.onInvalid, $field)(fieldErrors);
|
|
return false;
|
|
}
|
|
return true;
|
|
},
|
|
|
|
// takes validation rule and returns whether field passes rule
|
|
rule: function(field, validation) {
|
|
var
|
|
$field = module.get.field(field.identifier),
|
|
type = validation.type,
|
|
value = $field.val(),
|
|
|
|
bracketRegExp = /\[(.*?)\]/i,
|
|
bracket = bracketRegExp.exec(type),
|
|
isValid = true,
|
|
ancillary,
|
|
functionType
|
|
;
|
|
// if bracket notation is used, pass in extra parameters
|
|
if(bracket !== undefined && bracket !== null) {
|
|
ancillary = bracket[1];
|
|
functionType = type.replace(bracket[0], '');
|
|
isValid = $.proxy(settings.rules[functionType], $module)(value, ancillary);
|
|
}
|
|
// normal notation
|
|
else {
|
|
isValid = (type == 'checked')
|
|
? $field.filter(':checked').size() > 0
|
|
: settings.rules[type](value)
|
|
;
|
|
}
|
|
return isValid;
|
|
}
|
|
},
|
|
|
|
setting: function(name, value) {
|
|
module.debug('Changing setting', name, value);
|
|
if(value !== undefined) {
|
|
if( $.isPlainObject(name) ) {
|
|
$.extend(true, settings, name);
|
|
}
|
|
else {
|
|
settings[name] = value;
|
|
}
|
|
}
|
|
else {
|
|
return settings[name];
|
|
}
|
|
},
|
|
internal: function(name, value) {
|
|
module.debug('Changing internal', name, value);
|
|
if(value !== undefined) {
|
|
if( $.isPlainObject(name) ) {
|
|
$.extend(true, module, name);
|
|
}
|
|
else {
|
|
module[name] = value;
|
|
}
|
|
}
|
|
else {
|
|
return module[name];
|
|
}
|
|
},
|
|
debug: function() {
|
|
if(settings.debug) {
|
|
if(settings.performance) {
|
|
module.performance.log(arguments);
|
|
}
|
|
else {
|
|
module.debug = Function.prototype.bind.call(console.info, console, settings.moduleName + ':');
|
|
module.debug.apply(console, arguments);
|
|
}
|
|
}
|
|
},
|
|
verbose: function() {
|
|
if(settings.verbose && settings.debug) {
|
|
if(settings.performance) {
|
|
module.performance.log(arguments);
|
|
}
|
|
else {
|
|
module.verbose = Function.prototype.bind.call(console.info, console, settings.moduleName + ':');
|
|
module.verbose.apply(console, arguments);
|
|
}
|
|
}
|
|
},
|
|
error: function() {
|
|
module.error = Function.prototype.bind.call(console.error, console, settings.moduleName + ':');
|
|
module.error.apply(console, arguments);
|
|
},
|
|
performance: {
|
|
log: function(message) {
|
|
var
|
|
currentTime,
|
|
executionTime,
|
|
previousTime
|
|
;
|
|
if(settings.performance) {
|
|
currentTime = new Date().getTime();
|
|
previousTime = time || currentTime;
|
|
executionTime = currentTime - previousTime;
|
|
time = currentTime;
|
|
performance.push({
|
|
'Element' : element,
|
|
'Name' : message[0],
|
|
'Arguments' : [].slice.call(message, 1) || '',
|
|
'Execution Time' : executionTime
|
|
});
|
|
}
|
|
clearTimeout(module.performance.timer);
|
|
module.performance.timer = setTimeout(module.performance.display, 100);
|
|
},
|
|
display: function() {
|
|
var
|
|
title = settings.moduleName + ':',
|
|
totalTime = 0
|
|
;
|
|
time = false;
|
|
clearTimeout(module.performance.timer);
|
|
$.each(performance, function(index, data) {
|
|
totalTime += data['Execution Time'];
|
|
});
|
|
title += ' ' + totalTime + 'ms';
|
|
if(moduleSelector) {
|
|
title += ' \'' + moduleSelector + '\'';
|
|
}
|
|
if( (console.group !== undefined || console.table !== undefined) && performance.length > 0) {
|
|
console.groupCollapsed(title);
|
|
if(console.table) {
|
|
console.table(performance);
|
|
}
|
|
else {
|
|
$.each(performance, function(index, data) {
|
|
console.log(data['Name'] + ': ' + data['Execution Time']+'ms');
|
|
});
|
|
}
|
|
console.groupEnd();
|
|
}
|
|
performance = [];
|
|
}
|
|
},
|
|
invoke: function(query, passedArguments, context) {
|
|
var
|
|
maxDepth,
|
|
found,
|
|
response
|
|
;
|
|
passedArguments = passedArguments || queryArguments;
|
|
context = element || context;
|
|
if(typeof query == 'string' && instance !== undefined) {
|
|
query = query.split(/[\. ]/);
|
|
maxDepth = query.length - 1;
|
|
$.each(query, function(depth, value) {
|
|
var camelCaseValue = (depth != maxDepth)
|
|
? value + query[depth + 1].charAt(0).toUpperCase() + query[depth + 1].slice(1)
|
|
: query
|
|
;
|
|
if( $.isPlainObject( instance[value] ) && (depth != maxDepth) ) {
|
|
instance = instance[value];
|
|
}
|
|
else if( $.isPlainObject( instance[camelCaseValue] ) && (depth != maxDepth) ) {
|
|
instance = instance[camelCaseValue];
|
|
}
|
|
else if( instance[value] !== undefined ) {
|
|
found = instance[value];
|
|
return false;
|
|
}
|
|
else if( instance[camelCaseValue] !== undefined ) {
|
|
found = instance[camelCaseValue];
|
|
return false;
|
|
}
|
|
else {
|
|
module.error(error.method);
|
|
return false;
|
|
}
|
|
});
|
|
}
|
|
if ( $.isFunction( found ) ) {
|
|
response = found.apply(context, passedArguments);
|
|
}
|
|
else if(found !== undefined) {
|
|
response = found;
|
|
}
|
|
if($.isArray(invokedResponse)) {
|
|
invokedResponse.push(response);
|
|
}
|
|
else if(typeof invokedResponse == 'string') {
|
|
invokedResponse = [invokedResponse, response];
|
|
}
|
|
else if(response !== undefined) {
|
|
invokedResponse = response;
|
|
}
|
|
return found;
|
|
}
|
|
};
|
|
if(methodInvoked) {
|
|
if(instance === undefined) {
|
|
module.initialize();
|
|
}
|
|
module.invoke(query);
|
|
}
|
|
else {
|
|
if(instance !== undefined) {
|
|
module.destroy();
|
|
}
|
|
module.initialize();
|
|
}
|
|
|
|
})
|
|
;
|
|
|
|
return (invokedResponse !== undefined)
|
|
? invokedResponse
|
|
: this
|
|
;
|
|
};
|
|
|
|
$.fn.form.settings = {
|
|
|
|
// module info
|
|
moduleName : 'Form',
|
|
|
|
debug : true,
|
|
verbose : true,
|
|
performance : true,
|
|
|
|
namespace : 'form',
|
|
|
|
keyboardShortcuts : true,
|
|
on : 'submit',
|
|
animateSpeed : 150,
|
|
inlineError : false,
|
|
|
|
|
|
onValid : function() {},
|
|
onInvalid : function() {},
|
|
onSuccess : function() { return true; },
|
|
onFailure : function() { return false; },
|
|
|
|
metadata : {
|
|
validate: 'validate'
|
|
},
|
|
|
|
selector : {
|
|
message : '.error.message',
|
|
field : 'input, textarea, select',
|
|
group : '.field',
|
|
input : 'input',
|
|
prompt : '.prompt',
|
|
submit : '.submit'
|
|
},
|
|
|
|
className : {
|
|
error : 'error',
|
|
success: 'success',
|
|
down : 'down',
|
|
label : 'ui label prompt'
|
|
},
|
|
|
|
// errors
|
|
error: {
|
|
method : 'The method you called is not defined.'
|
|
},
|
|
|
|
|
|
|
|
templates: {
|
|
error: function(errors) {
|
|
var
|
|
html = '<ul class="list">'
|
|
;
|
|
$.each(errors, function(index, value) {
|
|
html += '<li>' + value + '</li>';
|
|
});
|
|
html += '</ul>';
|
|
return $(html);
|
|
},
|
|
prompt: function(errors) {
|
|
return $('<div/>')
|
|
.addClass('ui red pointing prompt label')
|
|
.html(errors[0])
|
|
;
|
|
}
|
|
},
|
|
|
|
rules: {
|
|
empty: function(value) {
|
|
return !(value === undefined || '' === value);
|
|
},
|
|
email: function(value){
|
|
var
|
|
emailRegExp = new RegExp("[a-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\\.[a-z0-9!#$%&'*+/=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?")
|
|
;
|
|
return emailRegExp.test(value);
|
|
},
|
|
length: function(value, requiredLength) {
|
|
return (value !== undefined)
|
|
? (value.length >= requiredLength)
|
|
: false
|
|
;
|
|
},
|
|
not: function(value, notValue) {
|
|
return (value != notValue);
|
|
},
|
|
is: function(value, text) {
|
|
return (value == text);
|
|
},
|
|
maxLength: function(value, maxLength) {
|
|
return (value !== undefined)
|
|
? (value.length <= maxLength)
|
|
: false
|
|
;
|
|
},
|
|
match: function(value, matchingField) {
|
|
// use either id or name of field
|
|
var
|
|
$form = $(this),
|
|
matchingValue
|
|
;
|
|
if($form.find('#' + matchingField).size() > 0) {
|
|
matchingValue = $form.find('#' + matchingField).val();
|
|
}
|
|
else if($form.find('[name=' + matchingField +']').size() > 0) {
|
|
matchingValue = $form.find('[name=' + matchingField + ']').val();
|
|
}
|
|
else if( $form.find('[data-validate="'+ matchingField +'"]').size() > 0 ) {
|
|
matchingValue = $form.find('[data-validate="'+ matchingField +'"]').val();
|
|
}
|
|
return (matchingValue !== undefined)
|
|
? ( value.toString() == matchingValue.toString() )
|
|
: false
|
|
;
|
|
},
|
|
url: function(value) {
|
|
var
|
|
urlRegExp = /(ftp|http|https):\/\/(\w+:{0,1}\w*@)?(\S+)(:[0-9]+)?(\/|\/([\w#!:.?+=&%@!\-\/]))?/
|
|
;
|
|
return urlRegExp.test(value);
|
|
}
|
|
}
|
|
|
|
};
|
|
|
|
})( jQuery, window , document );
|