client_side_validations 0.8.0 → 2.2.0

data/README.markdown

@@ -0,0 +1,109 @@
+# Client Side Validations
+Now you can easily drop in client side validations in any Rails app. It will use validations defined in a given ActiveRecord (or ActiveModel) class for use with a Javascript form validator. (currently only [jquery.validate](http://bassistance.de/jquery-plugins/jquery-plugin-validation/) is supported)
+
+For Rails 2 and Rails 3 example apps please see [client_side_validations_example](http://github.com/dnclabs/client_side_validations_examples)
+
+The concept is simple:
+
+1. Include the middleware
+2. Define validations in the model as you normally would
+3. The validations are sent to the client in JSON
+4. client_side_validations.js converts the JSON for a given validation plugin and binds the validator to the form
+
+Currently the following validations are supported:
+
+* validates_presence_of
+* validates_format_of
+* validates_numericality_of
+* validates_length_of
+* validates_uniqueness_of
+
+The uniqueness validation works for both ActiveRecord and Mongoid.
+
+## Installation
+> gem install client_side_validations
+
+### Rails 2
+Add "config.gem :client_side_validations" to the "config/environment.rb" file
+
+Then run the generator:
+   > script/generate client_side_validations
+
+This will copy client_side_validations.js to "public/javascripts"
+
+### Rails 3
+Add "gem 'client_side_validations" to the Gemfile
+
+Then run the generator:
+   > rails g client_side_validations
+
+This will copy client_side_validations.js to "public/javascripts"
+
+## Configuration
+Currently only [jquery.validate](http://bassistance.de/jquery-plugins/jquery-plugin-validation/) is supported so you will need to download [jQuery](http://docs.jquery.com/Downloading_jQuery) and the jQuery Validate plugin to "public/javascripts"
+
+### Rack
+The following routes will be reserved for client side validations:
+
+/validations.json
+/validations/uniqueness.json
+
+Add the middleware to your stack:
+
+config/environment.rb for Rails 2.x
+
+config/application.rb for Rails 3.x
+
+    ...
+    config.middleware.use 'ClientSideValidations'
+    ...
+
+### Model
+Validate your models as you normally would
+
+    class Book < ActiveRecord::Base
+      validates_presence_of :author
+    end
+
+### Layout
+You currently need both jQuery and the jQuery Validate plugin loaded before you load Client Side Validations
+
+    ...
+    <%= javascript_include_tag 'jquery', 'jquery.validate', 'client_side_validations' %>
+    ...
+   
+### View
+Have a form ask for client side validations by passing :validate => true
+
+    ...
+    
+    <% form_for @book, :validations => true do |b| %>
+      <%= b.label :author %></br>
+      <%= b.text_field :author %></br>
+      <%= submit_tag 'Create' %>
+    <% end %>
+    
+    ...
+   
+That should be it!
+
+## Advanced Options
+
+### Model
+If you want to define only specific fields for client side validations just override the validation_fields method on each model
+
+    class Book < ActiveRecord::Base
+      validatese_presence_of :author
+      validates_presence_of :body
+      
+      private
+      
+      def validation_fields
+        [:author]
+      end
+    end
+    
+
+Written by Brian Cardarella
+
+Copyright (c) 2010 Democratic National Committee. See LICENSE for details.

data/TODO

@@ -1,2 +1 @@
-- Add Rails Generators
 - Accept options in helper to extend the given validation plugin

data/javascript/lib/client_side_validations.js

@@ -1,33 +1,36 @@
-/* Additional jQueryValidator methods */
-
 if (typeof(jQuery) != "undefined") {
-  if (typeof($('').validate) != "undefined") {
-    jQuery.validator.addMethod("format", function(value, element, params) { 
-        var pattern = new RegExp(params, "i");
-        return this.optional(element) || pattern.test(value); 
-    }, jQuery.validator.format("Invalid format."));
-  }
-}
-
-$.extend($.fn, {
-  clientSideValidations: function(url, adapter) {
-    var form = this;
-    var id = form[0].id;
-    if (/new/.test(id)) {
-      id = /new_(\w+)/.exec(id)[1]
-    } else if (/edit/.test(id)) {
-      id = /edit_(\w+)_\d+/.exec(id)[1]
-    }
-    var client = new ClientSideValidations(id, adapter)
-    $.getJSON(url, function(json) {
-      var validations = client.adaptValidations(json);
-      form.validate({
-        rules:    validations.rules,
-        messages: validations.messages
+  jQuery.validator.addMethod("format", function(value, element, params) { 
+    var pattern = new RegExp(params, "i");
+    return this.optional(element) || pattern.test(value); 
+  }, jQuery.validator.format("Invalid format."));
+  
+  $.extend($.fn, {
+    clientSideValidations: function() {
+      var form    = this;
+      var object  = form.attr('object-csv');
+      var url     = '/validations.json?model=' + object;
+      var id      = form[0].id;
+      var adapter = 'jquery.validate';
+      if (/new/.test(id)) {
+        id = /new_(\w+)/.exec(id)[1]
+      } else if (/edit/.test(id)) {
+        id = /edit_(\w+)_\d+/.exec(id)[1]
+      }
+      var client = new ClientSideValidations(id, adapter)
+      $.getJSON(url, function(json) {
+        var validations = client.adaptValidations(json);
+        form.validate({
+          rules:    validations.rules,
+          messages: validations.messages
+        });
       });
-    });
-  }
-});
+    }
+  });
+
+  $(document).ready(function() {
+    $('form[object-csv]').clientSideValidations();
+  });
+}
 
 ClientSideValidations = function(id, adapter) {
   this.id                = id;
@@ -64,6 +67,13 @@ ClientSideValidations = function(id, adapter) {
                 value = this.validations[attr][validation]['maximum'];
               }
               break;
+            case 'uniqueness':
+              rule  = 'remote';
+              value = {
+                url: '/validations/uniqueness.json'
+              }
+              break;
+
             default:
           }
           if(rule == null) {

data/lib/client_side_validations.rb

@@ -1,47 +1,44 @@
-require 'rubygems' unless defined?(Gem)
+require 'rubygems'
+require 'json'
+require 'cgi'
 
-module DNCLabs
-  module ClientSideValidations
-    def validations_to_json(*attrs)
-      hash = Hash.new { |h, attribute| h[attribute] = {} }
-      attrs.each do |attr|
-        hash[attr].merge!(validation_to_hash(attr))
-      end
-      hash.to_json
-    end
-    
-    def validation_to_hash(_attr, _options = {})
-      @dnc_csv_adapter ||= Adapter.new(self)
-      @dnc_csv_adapter.validation_to_hash(_attr, _options)
+class ClientSideValidations
+  def initialize(app)
+    @app = app
+  end
+  
+  def call(env)
+    params = CGI::parse(env['QUERY_STRING'])
+    case env['PATH_INFO']
+    when %r{^/validations.json}
+      body = get_validations(params['model'][0])
+      [200, {'Content-Type' => 'application/json', 'Content-Length' => "#{body.length}"}, body]
+    when %r{^/validations/uniqueness.json}
+      field               = params.keys.first
+      resource, attribute = field.split(/[^\w]/)
+      value               = params[field][0]
+      body                = is_unique?(resource, attribute, value).to_s
+      [200, {'Content-Type' => 'application/json', 'Content-Length' => "#{body.length}"}, body]
+    else
+      @app.call(env)
     end
   end
-end
-
-
-# ORM
-
-if defined?(ActiveModel)
-  require 'adapters/active_model'
-  unless Object.respond_to?(:to_json)
-    require 'active_support/json/encoding'
+  
+  private
+  
+  def get_validations(resource)
+    constantize_resource(resource).new.validations_to_json
   end
-  DNCLabs::ClientSideValidations::Adapter = DNCLabs::ClientSideValidations::Adapters::ActiveModel
-  klass = ActiveModel::Validations
-elsif defined?(ActiveRecord)
-  if ActiveRecord::VERSION::MAJOR == 2
-    require 'adapters/active_record_2'
-    DNCLabs::ClientSideValidations::Adapter = DNCLabs::ClientSideValidations::Adapters::ActiveRecord2
-    klass = ActiveRecord::Base
+  
+  def is_unique?(resource, attribute, value)
+    constantize_resource(resource).send("find_by_#{attribute}", value) == nil
   end
+  
+  def constantize_resource(resource)
+    eval(resource.split('_').map{ |word| word.capitalize}.join)
+  end
+  
 end
 
-klass.class_eval do
-  include DNCLabs::ClientSideValidations
-end
-
-
-# Template
-
-if defined?(ActionView)
-  require 'adapters/action_view'
-end
+require 'client_side_validations/orm'
+require 'client_side_validations/template'

data/lib/client_side_validations/adapters/action_view.rb

@@ -0,0 +1,57 @@
+module DNCLabs
+  module ClientSideValidations
+    module Adapters
+      module ActionView
+        module BaseMethods
+          
+          def self.included(base)
+            form_method = base.instance_method(:form_for)
+            base.class_eval do
+              define_method(:form_for) do |record_or_name_or_array, *args, &proc|
+                options = args.extract_options!
+                options.symbolize_keys!
+                if validations = options.delete(:validations)
+                  unless options.key?(:html)
+                    options[:html] = {}
+                  end
+                  
+                  unless validations == true
+                    object = validations.to_s.underscore
+                  else
+                    case record_or_name_or_array
+                    when String, Symbol
+                      object = record_or_name_or_array.to_s
+                    else
+                      object = record_or_name_or_array.class.to_s.underscore
+                    end
+                  end
+                  
+                  options[:html]['object-csv'] = object
+                end
+                args << options
+                form_method.bind(self).call(record_or_name_or_array, *args, &proc)
+              end
+            end
+          end
+          
+        end # BaseMethods
+        
+        module FormBuilderMethods
+
+          def client_side_validations(options = {})
+            @template.send(:client_side_validations, @object_name, objectify_options(options))
+          end
+          
+        end # FormBuilderMethods
+      end
+    end
+  end
+end
+
+ActionView::Base.class_eval do
+  include DNCLabs::ClientSideValidations::Adapters::ActionView::BaseMethods
+end
+
+ActionView::Helpers::FormBuilder.class_eval do
+  include DNCLabs::ClientSideValidations::Adapters::ActionView::FormBuilderMethods
+end

data/lib/{adapters → client_side_validations/adapters}/active_model.rb

@@ -35,6 +35,10 @@ module DNCLabs
           validation_hash
         end
         
+        def validation_fields
+          base._validators.keys
+        end
+        
         private
 
         def get_validation_message(validation, locale)
@@ -45,12 +49,18 @@ module DNCLabs
             I18n.translate('errors.messages.invalid', :locale => locale)
           when :length
             if count = validation.options[:minimum]
-              I18n.translate('errors.messages.too_short', :locale => locale).sub('{{count}}', count.to_s)
+              I18n.translate('errors.messages.too_short', :locale => locale).sub('%{count}', count.to_s)
             elsif count = validation.options[:maximum]
-              I18n.translate('errors.messages.too_long', :locale => locale).sub('{{count}}', count.to_s)
+              I18n.translate('errors.messages.too_long', :locale => locale).sub('%{count}', count.to_s)
             end
           when :numericality
             I18n.translate('errors.messages.not_a_number', :locale => locale)
+          when :uniqueness
+            if defined?(ActiveRecord) && base.kind_of?(ActiveRecord::Base)
+              I18n.translate('activerecord.errors.messages.taken', :locale => locale)
+            elsif defined?(Mongoid) && base.class.included_modules.include?(Mongoid::Document)
+              I18n.translate('errors.messages.taken', :locale => locale)
+            end
           end
 
           message = validation.options[:message]
@@ -65,10 +75,11 @@ module DNCLabs
 
         def get_validation_options(options)
           options = options.stringify_keys
-          options.delete('on')
+          options.delete('on') == :create
           options.delete('tokenizer')
           options.delete('only_integer')
           options.delete('allow_nil')
+          options.delete('case_sensitive')
           if options['with'].kind_of?(Regexp)
             options['with'] = options['with'].inspect.to_s.sub("\\A","^").sub("\\Z","$").sub(%r{^/},"").sub(%r{/i?$}, "")
           end
@@ -82,6 +93,7 @@ module DNCLabs
         def remove_reserved_conditionals(*conditionals)
           conditionals.flatten!
           conditionals.delete_if { |conditional| conditional =~ /@_/ }
+          conditionals.delete_if { |conditional| conditional =~ /validation_context/ }
           conditionals.first
         end
       end

data/lib/{adapters → client_side_validations/adapters}/active_record_2.rb

@@ -35,6 +35,10 @@ module DNCLabs
           validation_hash
         end
         
+        def validation_fields
+          base.class.reflect_on_all_validations.map { |v| v.name }.uniq
+        end
+        
         private
 
         def get_validation_message(validation, locale)
@@ -51,6 +55,8 @@ module DNCLabs
             end
           when 'validates_numericality_of'
             I18n.translate('activerecord.errors.messages.not_a_number', :locale => locale)
+          when 'validates_uniqueness_of'
+            I18n.translate('activerecord.errors.messages.taken', :locale => locale)
           end
 
           message = validation.options[:message]
@@ -82,6 +88,8 @@ module DNCLabs
             'numericality'
           when 'validates_length_of'
             'length'
+          when 'validates_uniqueness_of'
+            'uniqueness'
           end
         end
       end

data/lib/client_side_validations/orm.rb

@@ -0,0 +1,45 @@
+module DNCLabs
+  module ClientSideValidations
+    def validations_to_json
+      hash = Hash.new { |h, field| h[field] = {} }
+      validation_fields.each do |field|
+        hash[field].merge!(validation_to_hash(field))
+      end
+      hash.to_json
+    end
+    
+    def validation_to_hash(field, options = {})
+      dnc_csv_adapter.validation_to_hash(field, options)
+    end
+    
+    def validation_fields
+      dnc_csv_adapter.validation_fields
+    end
+    
+    def dnc_csv_adapter
+      unless @dnc_csv_adapter
+        @dnc_csv_adapter = Adapter.new(self)
+      end
+      @dnc_csv_adapter
+    end
+  end
+end
+
+if defined?(ActiveModel)
+  require 'client_side_validations/adapters/active_model'
+  DNCLabs::ClientSideValidations::Adapter = DNCLabs::ClientSideValidations::Adapters::ActiveModel
+  klass = ActiveModel::Validations
+
+elsif defined?(ActiveRecord)
+  if ActiveRecord::VERSION::MAJOR == 2
+    require 'client_side_validations/adapters/active_record_2'
+    DNCLabs::ClientSideValidations::Adapter = DNCLabs::ClientSideValidations::Adapters::ActiveRecord2
+    klass = ActiveRecord::Base
+  end
+end
+
+if klass
+  klass.class_eval do
+    include DNCLabs::ClientSideValidations
+  end
+end