rapscallion 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e4faa2b9c0fb094df19be7f5660885e1f3df7333
-  data.tar.gz: f8ea9dddf622c0e2b376a4d1d4d75723d262eaca
+  metadata.gz: d1eb9596f7264fe5da4e2fcd9e84bdbdaba00d03
+  data.tar.gz: 9e4a2f9cfdf540669207c7744e78a3620740da4b
 SHA512:
-  metadata.gz: bd52ff49f1bfcbd024308a1e41b26d67c46bf2086f984b6f12a8dc356f3308e9e1e03a3f96012c45caf2d5ffeb8c5a1e60345293e20b285414f4fb69d373866e
-  data.tar.gz: f6d393b835ac74b6bba5d01a99ab8c62c0ce9a7e58d5f526098340ccd532c52971ce6ab0e4ba163c8122ab42e6d80a3f98b058c922432b470a4c7c9589753ca9
+  metadata.gz: 34efc3abee76681704f75a43d0a60878a6915cde9782dbf8ef119263a492373f43084e5f623fbd0ee6e764fa548bafdb1377a1f8bc7c13d0c8767345d03ed302
+  data.tar.gz: 6e3688cddf645cd664d1ba688baf67edc067bdef7b1b5a81b99040723c22399a049e22102fcba0afa57ac12da88985e6a34f690f418b1fd7b58a06bdb3581039

data/README.md

@@ -1,34 +1,56 @@
-rapscallion
+Rapscallion
 ===========
 
 Ruby on Rails client side validations
 
-application.js:
+### Add Rapscallion to application.js:
 
 ``` javascript
 //= require rapscallion/validations
 ```
 
-Gemfile:
+### Activate in Javascript:
+	$(selector).rapscallion();
+
+#### Options:
+
+- **Change class of error message div**  
+  error_message_container_class: "error_messages"
+
+- **Set a class on field with error**  
+  field_with_error_class: 'has_error'
+
+- **Set a class on field with success**  
+  field_valid_class: 'is_valid'
+
+- **Container for input – used to add and remove error messages**  
+  field_container: 'div.input'
+
+- **Event that triggers validation**  
+  trigger: 'blur'
+
+eg $('.rapscallion').rapscallion({error_message_container_class: 'errors', field_container: '.field'})
+
+### Add Rapscallion to Gemfile:
 
 ``` ruby
 gem 'rapscallion'
 ```
 
-View example with Simple Form:
+### View example of input tag with Simple Form:
 
 ``` haml
 .input
   = f.input :username, input_html: {class: 'rapscallion'}
 ```
 
-When validating an existing record (for example to avoid uniqueness validation problems):
+### Form tag when validating an existing record (for example to avoid uniqueness validation problems):
 
 ``` haml
 = simple_form_for @thing, html: {data: {existing_record: @thing.id}} do |f|
 ```
 
-Model:
+### Model:
 
 ``` ruby
 class User < ActiveRecord::Base

data/app/assets/javascripts/rapscallion/validations.js

@@ -1,83 +1,110 @@
-$(document).on('blur', '.rapscallion', function(){
-
-  var settings = {
-  
-    /* error messages will be shown in a div set the class for that here */
-    error_message_container_class: "error_messages",
-    
-    /* fields with errors will get a class to indicate errors, change that class name here */
-    field_with_error_class: 'has_error',
+/* 
     
-    /* valid fields will get a class to indicate success, change that class name here */
-    field_valid_class: 'is_valid',
-    
-    /* error messages will be remove from input container, eg closest(:selector), set that here */
-    field_container: 'div.input'
+    Rapscallion
+    Ruby on Rails Client Side Validations
+    Author: Gordon B. Isnor
+    http://www.github.com/gordonbisnor/rapscallion
+    http://blog.isnorcreative.com/2014/06/10/rapscallion.html
 
-  };
-  
-  /* the input in question */  
-  var el = $(this);
-  
-  /* the form */
-  var form = el.closest('form');
-  
-  /* model reference from field name eg user from user[username] */
-  var klass = el.prop('name').replace(/\[.*\]/,'');
-  
-  /* field name eg username from user[username] */
-  var attr = el.prop('id').replace(klass+"_",'');
-  
-  /* field value */
-  var field_val = el.val();
-  
-  /* set up basic hash for validation */
-  validation_data = {klass: klass, attr: attr, field_val: field_val}
-
-  /* 
-  confirmation fields are special cases, and add the field to confirm for 
-  eg password and password_confirmation
-  */
-  if(attr.match(/.*_confirmation/) != undefined){
-    var confirmation_field = attr.replace('_confirmation','');
-    var confirmation_value = form.find('#' + klass + "_" + confirmation_field).val();
-  };
-
-  validation_data[confirmation_field] = confirmation_value;
+*/
 
-  /* existing record? */
-  if(form.data('existing-record') != undefined) {
-    validation_data['existing_record'] = form.data('existing-record');
-  };
+(function($){
 
-  /* do ajax request */
-  $.ajax({
-    type: "POST",
-    url: '/rapscallion',
-    dataType: 'json',
-    data: validation_data,
+  $.fn.rapscallion = function(options){
 
-    success: function(data, status, xhr) {
+    var settings = $.extend({
+    
+      /* error messages will be shown in a div set the class for that here */
+      error_message_container_class: "error_messages",
+      
+      /* fields with errors will get a class to indicate errors, change that class name here */
+      field_with_error_class: 'has_error',
+      
+      /* valid fields will get a class to indicate success, change that class name here */
+      field_valid_class: 'is_valid',
       
-      /* remove existing error messages */
-      el.closest(settings.field_container).find('.'+settings.error_message_container_class).remove();
-  
-      /* if no errors present field is valid, add is_valid css class */
-      if(data.length == 0) {
-        el.removeClass(settings.field_with_error_class).addClass(settings.field_valid_class);
-
-      /* if error present field is not valid, add has_error class to input, and error messages after input */  
+      /* error messages will be remove from input container, eg closest(:selector), set that here */
+      field_container: 'div.input',
+
+      /* event that triggers validation */
+      trigger: 'blur'
+
+    }, options);
+
+    return this.each(function() {
       
-      } else {
-        /* cycle through json response adding errors for each */
-        $.each( data, function( key, val ) {
-          el.after('<div class="' + settings.error_message_container_class + '">' + val + '</div>');
-          el.removeClass(settings.field_valid_class).addClass(settings.field_with_error_class)
-        });
-      }; /* end if errors or not */
+      $(this).on(settings.trigger, function(){
 
-    } /* end success */
+        /* the input in question */  
+        var el = $(this);
+        
+        /* the form */
+        var form = el.closest('form');
+        
+        /* model reference from field name eg user from user[username] */
+        var klass = el.prop('name').replace(/\[.*\]/,'');
+        
+        /* field name eg username from user[username] */
+        var attr = el.prop('id').replace(klass+"_",'');
+        
+        /* field value */
+        var field_val = el.val();
+        
+        /* set up basic hash for validation */
+        validation_data = {klass: klass, attr: attr, field_val: field_val}
 
-  }); /* end ajax */
+        /* 
+        confirmation fields are special cases, and add the field to confirm for 
+        eg password and password_confirmation
+        */
+        if(attr.match(/.*_confirmation/) != undefined){
+          var confirmation_field = attr.replace('_confirmation','');
+          var confirmation_value = form.find('#' + klass + "_" + confirmation_field).val();
+        };
 
-}); /* end on blur */
+        validation_data[confirmation_field] = confirmation_value;
+
+        /* existing record? */
+        if(form.data('existing-record') != undefined) {
+          validation_data['existing_record'] = form.data('existing-record');
+        };
+
+        /* do ajax request */
+        $.ajax({
+          type: "POST",
+          url: '/rapscallion',
+          dataType: 'json',
+          data: validation_data,
+
+          success: function(data, status, xhr) {
+            
+            /* remove existing error messages */
+            el.closest(settings.field_container).find('.'+settings.error_message_container_class).remove();
+        
+            /* if no errors present field is valid, add is_valid css class */
+            if(data.length == 0) {
+              el.removeClass(settings.field_with_error_class).addClass(settings.field_valid_class);
+
+            /* if error present field is not valid, add has_error class to input, and error messages after input */  
+            
+            } else {
+              /* cycle through json response adding errors for each */
+              $.each( data, function( key, val ) {
+                el.after('<div class="' + settings.error_message_container_class + '">' + val + '</div>');
+                el.removeClass(settings.field_valid_class).addClass(settings.field_with_error_class)
+              });
+            }; /* end if errors or not */
+
+          } /* end success */
+
+        }); /* end ajax */
+
+
+      });
+    
+
+    });
+    
+   
+  };
+}(jQuery));

data/lib/rapscallion/version.rb

@@ -1,3 +1,3 @@
 module Rapscallion
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rapscallion
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Gordon Isnor