Skip to content

Commit

Permalink
adding basic js validation for forms
Browse files Browse the repository at this point in the history
  • Loading branch information
kakwa committed Jun 3, 2015
1 parent 9fe80cd commit 2b52e12
Show file tree
Hide file tree
Showing 5 changed files with 330 additions and 6 deletions.
323 changes: 323 additions & 0 deletions resources/static/js/validator.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,323 @@
/* ========================================================================
* Bootstrap (plugin): validator.js v0.8.1
* ========================================================================
* The MIT License (MIT)
*
* Copyright (c) 2015 Cina Saffary.
* Made by @1000hz in the style of Bootstrap 3 era @fat
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
* ======================================================================== */


+function ($) {
'use strict';

var inputSelector = ':input:not([type="submit"], button):enabled:visible'
// VALIDATOR CLASS DEFINITION
// ==========================

var Validator = function (element, options) {
this.$element = $(element)
this.options = options

options.errors = $.extend({}, Validator.DEFAULTS.errors, options.errors)

for (var custom in options.custom) {
if (!options.errors[custom]) throw new Error('Missing default error message for custom validator: ' + custom)
}

$.extend(Validator.VALIDATORS, options.custom)

this.$element.attr('novalidate', true) // disable automatic native validation
this.toggleSubmit()

this.$element.on('input.bs.validator change.bs.validator focusout.bs.validator', $.proxy(this.validateInput, this))
this.$element.on('submit.bs.validator', $.proxy(this.onSubmit, this))

this.$element.find('[data-match]').each(function () {
var $this = $(this)
var target = $this.data('match')

$(target).on('input.bs.validator', function (e) {
$this.val() && $this.trigger('input.bs.validator')
})
})
}

Validator.DEFAULTS = {
delay: 500,
html: false,
disable: true,
custom: {},
errors: {
match: 'Does not match',
minlength: 'Not long enough'
},
feedback: {
success: 'glyphicon-ok',
error: 'glyphicon-warning-sign'
}
}

Validator.VALIDATORS = {
'native': function ($el) {
var el = $el[0]
return el.checkValidity ? el.checkValidity() : true
},
match: function ($el) {
var target = $el.data('match')
return !$el.val() || $el.val() === $(target).val()
},
minlength: function ($el) {
var minlength = $el.data('minlength')
return !$el.val() || $el.val().length >= minlength
}
}

Validator.prototype.validateInput = function (e) {
var $el = $(e.target)
var prevErrors = $el.data('bs.validator.errors')
var errors

if ($el.is('[type="radio"]')) $el = this.$element.find('input[name="' + $el.attr('name') + '"]')

this.$element.trigger(e = $.Event('validate.bs.validator', {relatedTarget: $el[0]}))

if (e.isDefaultPrevented()) return

var self = this

this.runValidators($el).done(function (errors) {
$el.data('bs.validator.errors', errors)

errors.length ? self.showErrors($el) : self.clearErrors($el)

if (!prevErrors || errors.toString() !== prevErrors.toString()) {
e = errors.length
? $.Event('invalid.bs.validator', {relatedTarget: $el[0], detail: errors})
: $.Event('valid.bs.validator', {relatedTarget: $el[0], detail: prevErrors})

self.$element.trigger(e)
}

self.toggleSubmit()

self.$element.trigger($.Event('validated.bs.validator', {relatedTarget: $el[0]}))
})
}


Validator.prototype.runValidators = function ($el) {
var errors = []
var deferred = $.Deferred()
var options = this.options

$el.data('bs.validator.deferred') && $el.data('bs.validator.deferred').reject()
$el.data('bs.validator.deferred', deferred)

function getErrorMessage(key) {
return $el.data(key + '-error')
|| $el.data('error')
|| key == 'native' && $el[0].validationMessage
|| options.errors[key]
}

$.each(Validator.VALIDATORS, $.proxy(function (key, validator) {
if (($el.data(key) || key == 'native') && !validator.call(this, $el)) {
var error = getErrorMessage(key)
!~errors.indexOf(error) && errors.push(error)
}
}, this))

if (!errors.length && $el.val() && $el.data('remote')) {
this.defer($el, function () {
var data = {}
data[$el.attr('name')] = $el.val()
$.get($el.data('remote'), data)
.fail(function (jqXHR, textStatus, error) { errors.push(getErrorMessage('remote') || error) })
.always(function () { deferred.resolve(errors)})
})
} else deferred.resolve(errors)

return deferred.promise()
}

Validator.prototype.validate = function () {
var delay = this.options.delay

this.options.delay = 0
this.$element.find(inputSelector).trigger('input.bs.validator')
this.options.delay = delay

return this
}

Validator.prototype.showErrors = function ($el) {
var method = this.options.html ? 'html' : 'text'

this.defer($el, function () {
var $group = $el.closest('.form-group')
var $block = $group.find('.help-block.with-errors')
var $feedback = $group.find('.form-control-feedback')
var errors = $el.data('bs.validator.errors')

if (!errors.length) return

errors = $('<ul/>')
.addClass('list-unstyled')
.append($.map(errors, function (error) { return $('<li/>')[method](error) }))

$block.data('bs.validator.originalContent') === undefined && $block.data('bs.validator.originalContent', $block.html())
$block.empty().append(errors)
$group.addClass('has-error')

$feedback.length
&& $feedback.removeClass(this.options.feedback.success)
&& $feedback.addClass(this.options.feedback.error)
&& $group.removeClass('has-success')
})
}

Validator.prototype.clearErrors = function ($el) {
var $group = $el.closest('.form-group')
var $block = $group.find('.help-block.with-errors')
var $feedback = $group.find('.form-control-feedback')

$block.html($block.data('bs.validator.originalContent'))
$group.removeClass('has-error')

$feedback.length
&& $feedback.removeClass(this.options.feedback.error)
&& $feedback.addClass(this.options.feedback.success)
&& $group.addClass('has-success')
}

Validator.prototype.hasErrors = function () {
function fieldErrors() {
return !!($(this).data('bs.validator.errors') || []).length
}

return !!this.$element.find(inputSelector).filter(fieldErrors).length
}

Validator.prototype.isIncomplete = function () {
function fieldIncomplete() {
return this.type === 'checkbox' ? !this.checked :
this.type === 'radio' ? !$('[name="' + this.name + '"]:checked').length :
$.trim(this.value) === ''
}

return !!this.$element.find(inputSelector).filter('[required]').filter(fieldIncomplete).length
}

Validator.prototype.onSubmit = function (e) {
this.validate()
if (this.isIncomplete() || this.hasErrors()) e.preventDefault()
}

Validator.prototype.toggleSubmit = function () {
if(!this.options.disable) return
var $btn = $('button[type="submit"], input[type="submit"]')
.filter('[form="' + this.$element.attr('id') + '"]')
.add(this.$element.find('input[type="submit"], button[type="submit"]'))
$btn.toggleClass('disabled', this.isIncomplete() || this.hasErrors())
.css({'pointer-events': 'all', 'cursor': 'pointer'})
}

Validator.prototype.defer = function ($el, callback) {
callback = $.proxy(callback, this)
if (!this.options.delay) return callback()
window.clearTimeout($el.data('bs.validator.timeout'))
$el.data('bs.validator.timeout', window.setTimeout(callback, this.options.delay))
}

Validator.prototype.destroy = function () {
this.$element
.removeAttr('novalidate')
.removeData('bs.validator')
.off('.bs.validator')

this.$element.find(inputSelector)
.off('.bs.validator')
.removeData(['bs.validator.errors', 'bs.validator.deferred'])
.each(function () {
var $this = $(this)
var timeout = $this.data('bs.validator.timeout')
window.clearTimeout(timeout) && $this.removeData('bs.validator.timeout')
})

this.$element.find('.help-block.with-errors').each(function () {
var $this = $(this)
var originalContent = $this.data('bs.validator.originalContent')

$this
.removeData('bs.validator.originalContent')
.html(originalContent)
})

this.$element.find('input[type="submit"], button[type="submit"]').removeClass('disabled')

this.$element.find('.has-error').removeClass('has-error')

return this
}

// VALIDATOR PLUGIN DEFINITION
// ===========================


function Plugin(option) {
return this.each(function () {
var $this = $(this)
var options = $.extend({}, Validator.DEFAULTS, $this.data(), typeof option == 'object' && option)
var data = $this.data('bs.validator')

if (!data && option == 'destroy') return
if (!data) $this.data('bs.validator', (data = new Validator(this, options)))
if (typeof option == 'string') data[option]()
})
}

var old = $.fn.validator

$.fn.validator = Plugin
$.fn.validator.Constructor = Validator


// VALIDATOR NO CONFLICT
// =====================

$.fn.validator.noConflict = function () {
$.fn.validator = old
return this
}


// VALIDATOR DATA-API
// ==================

$(window).on('load', function () {
$('form[data-toggle="validator"]').each(function () {
var $form = $(this)
Plugin.call($form, $form.data())
})
})

}(jQuery);
2 changes: 1 addition & 1 deletion resources/templates/adduser.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
</div>
<div class="col-md-8 column">
<div class="well well-sm">
<form method='POST' action='/adduser' role="form" class="form-signin">
<form method='POST' action='/adduser' role="form" class="form-signin" data-toggle="validator">
${form}
<div class="form-group">
<div class="input-group">
Expand Down
1 change: 1 addition & 0 deletions resources/templates/base.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@
<script type="text/javascript" src="/static/js/jquery.min.js"></script>
<script type="text/javascript" src="/static/js/bootstrap.min.js"></script>
<script type="text/javascript" src="/static/js/scripts.js"></script>
<script type="text/javascript" src="/static/js/validator.js"></script>
<script type="text/javascript" src="/static/js/jquery.tablesorter.min.js"></script>

<script>
Expand Down
8 changes: 4 additions & 4 deletions resources/templates/form.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
% if attr['type'] == 'string':
<input type="text" name="${a}" class="form-control" placeholder="${attr['description']}" aria-describedby="basic-addon1" required>
% elif attr['type'] == 'email':
<input type="email" name="${a}" class="form-control" placeholder="${attr['description']}" aria-describedby="basic-addon1" required>
<input type="email" name="${a}" class="form-control" placeholder="${attr['description']}" aria-describedby="basic-addon1" required data-error="email address is invalid">
% elif attr['type'] == 'int':
<input type="number" name="${a}" class="form-control" placeholder="${attr['description']}" aria-describedby="basic-addon1" required>
% elif attr['type'] == 'fix':
Expand All @@ -19,9 +19,9 @@
%endfor
</select>
% elif attr['type'] == 'password':
<input type="password" name="${a}1" class="form-control" placeholder="${attr['description']}" aria-describedby="basic-addon1" required>
<span class="input-group-addon" id="basic-addon1">Retype ${attr['display_name']}</span>
<input type="password" name="${a}2" class="form-control" placeholder="${attr['description']}" aria-describedby="basic-addon1" required>
<input type="password" class="form-control" name="${a}1" id="${a}1" placeholder="${attr['description']}" required>
<span class="input-group-addon" id="basic-addon1">Retype ${attr['display_name']}</span>
<input type="password" class="form-control" name="${a}2" id="#${a}2" data-match="#${a}1" placeholder="Confirm" required>
% endif
</div>
</div>
Expand Down
2 changes: 1 addition & 1 deletion resources/templates/selfmodify.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
</div>
<div class="col-md-8 column">
<div class="well well-sm">
<form method='POST' action='/selfmodify' role="form" class="form-signin">
<form method='POST' action='/selfmodify' role="form" class="form-signin" data-toggle="validator">
${form}
<div class="form-group">
<div class="input-group">
Expand Down

0 comments on commit 2b52e12

Please sign in to comment.