client-validations 0.1.0

data/.gitignore

@@ -0,0 +1,8 @@
+**/*/log/*
+**/*/tmp/*
+*~
+coverage/*
+*.sqlite3
+rdoc/*
+*.gemspec
+pkg

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 [name of plugin creator]
+
+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.

data/README.textile

@@ -0,0 +1,63 @@
+h2. Dependencies
+
+To use this plugin, you first need to download the Validation Reflection plugin:
+
+<pre><code>script/plugin install git://github.com/redinger/validation_reflection.git</code></pre>
+
+And you need to download the jQuery and jQuery Validator:
+
+* http://code.jquery.com/jquery-latest.min.js
+* http://ajax.microsoft.com/ajax/jquery.validate/1.6/jquery.validate.min.js
+
+h2. Installation
+
+h3. as a Gem
+
+<pre><code>sudo gem install client-validations</code></pre>
+
+h3. as a Plugin
+
+<pre><code>script/plugin install git://github.com/willian/client_validations.git</code></pre>
+
+h2. Usage
+
+All you have to do is use the client_validations form_helper. Example:
+
+<pre><code><% form_for(@post) do |f| %>
+  <%= f.label :title %>
+  <%= f.text_field :title %>
+
+  <%= f.label :content %>
+  <%= f.text_area :content %>
+
+  <%= f.submit 'Create' %>
+
+  <%= f.client_validations %>
+<% end %></code></pre>
+
+h2. Maintainer
+
+Willian Fernandes (http://willianfernandes.com.br)
+
+h2. License
+
+Copyright (c) 2010 Willian Fernandes
+
+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.

data/Rakefile

@@ -0,0 +1,38 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the client_validations plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the client_validations plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ClientValidations'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "client-validations"
+    gemspec.summary = "Translates the validations of model to the jQuery Validator"
+    gemspec.description = "Translates the validations of model to the jQuery Validator"
+    gemspec.email = "willian@willianfernandes.com.br"
+    gemspec.homepage = "http://github.com/willian/client_validations"
+    gemspec.authors = ["Willian Fernandes"]
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with: gem install jeweler"
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/app/controllers/client_validations_controller.rb

@@ -0,0 +1,8 @@
+class ClientValidationsController < ApplicationController
+  # Poll with /client_validations/uniqueness?model_class=User&column=username&value=theusername. Returns
+  # either 'true' or 'false'.
+  def uniqueness
+    responder = ClientValidation.current_adapter.validation_responses[:uniqueness]
+    render :text => responder.respond(params)
+  end
+end

data/config/routes.rb

@@ -0,0 +1,3 @@
+ActionController::Routing::Routes.draw do |map|
+  map.connect 'client_validations/:action', :controller => 'client_validations'
+end

data/init.rb

@@ -0,0 +1,11 @@
+require "client_validations"
+require "client_validations/form_builder"
+require "client_validations/util"
+require "client_validations/adapter_base"
+require "client_validations/adapter_base/validation_hook"
+require "client_validations/adapter_base/validation_response"
+require "client_validations/adapters/jquery_validations"
+
+# Hook into the default form builder
+# ActionView::Helpers::FormBuilder.class_eval { include ClientValidation::FormBuilder }
+ActionView::Helpers::FormBuilder.send :include, ClientValidation::FormBuilder

data/lib/client_validations.rb

@@ -0,0 +1,14 @@
+module ClientValidation
+  def current_adapter
+    self.current_adapter = ClientValidation::Adapters::JqueryValidations
+    adapter = @current_adapter
+
+    return adapter
+  end
+
+  def current_adapter=(adapter)
+    @current_adapter = adapter
+  end
+
+  extend self
+end

data/lib/client_validations/adapter_base.rb

@@ -0,0 +1,13 @@
+module ClientValidation
+  # The base class of an adapter.
+  class AdapterBase
+    def self.response(name, &block)
+      self.validation_responses[name] = ValidationResponse.new(&block)
+    end
+
+    private
+      def self.validation_responses
+        @validation_responses ||= {}
+      end
+  end
+end

data/lib/client_validations/adapter_base/validation_hook.rb

@@ -0,0 +1,66 @@
+module LiveValidations
+  class AdapterBase
+    # A ValidationHook is this plugins representation of a validation, and is created with
+    # the adapter DSL through the Validations::AdapterBase.validates method.
+    class ValidationHook
+      attr_reader :data, :callback, :prefix, :adapter_instance
+      
+      def initialize(&block)
+        @proc = block
+        @data = {}
+      end
+      
+      def [](key)
+        data[key]
+      end
+      
+      def []=(key, value)
+        data[key] = value
+      end
+
+      def run_validation(adapter_instance, callback)
+        @adapter_instance = adapter_instance
+        @callback = callback
+        @prefix = @adapter_instance.prefix
+        
+        # The @proc is called once for each of the attributes in the @callback,
+        # passing the attribute to the proc much like validates_each.
+        @callback.options[:attributes].each {|attribute| @proc.call(self, attribute) }
+        
+
+        @data.each do |key, value|
+          case value
+          when Hash
+            recursively_merge_hashes(@adapter_instance[key], value)
+          when Array
+            @adapter_instance[key] += value
+          end
+        end
+      end
+
+      # Returns either the :message specified, or the default I18n error message.
+      def message_for(attribute, key,options={})
+        handwritten_message_for(attribute) || I18n.translate(key, {:scope => 'activerecord.errors.messages'}.merge(options))
+      end
+      
+      def handwritten_message_for(attribute)
+        return unless callback.options[:message]
+        
+        I18n.backend.send(:interpolate, I18n.locale, callback.options[:message], {
+          :model => adapter_instance.active_record_instance.class.human_name,
+          :attribute => attribute
+        })
+      end
+      
+      def regex
+        callback.options[:live_validator] || callback.options[:with]
+      end
+      
+      private
+      
+      def recursively_merge_hashes(h1, h2)
+        h1.merge!(h2) {|key, _old, _new| if _old.class == Hash then recursively_merge_hashes(_old, _new) else _new end  }
+      end
+    end
+  end
+end

data/lib/client_validations/adapter_base/validation_response.rb

@@ -0,0 +1,19 @@
+module ClientValidation
+  class AdapterBase
+    # Currently this is used in the validates_uniqueness_of controller callback.
+    class ValidationResponse
+      attr_reader :params
+      def initialize(&block)
+        @proc = block
+      end
+
+      def respond(params)
+        @params = params
+
+        return @proc.call(self)
+      rescue
+        nil
+      end
+    end
+  end
+end

data/lib/client_validations/adapters/jquery_validations.rb

@@ -0,0 +1,156 @@
+module ClientValidation
+  module Adapters
+    # Adapter for jQuery Validation
+    class JqueryValidations < ClientValidation::AdapterBase
+
+      response :uniqueness do |r|
+        column  = r.params[r.params[:model_class].downcase].keys.first
+        value   = r.params[r.params[:model_class].downcase][column]
+        r.params[:model_class].constantize.count(:conditions => {column => value}) == 0
+      end
+
+      def self.render_script(object)
+        @declarations = []
+        @validators = {}
+        @messages = {}
+
+        @klasses = [object.class]
+
+        # Discovering all models
+        object.class.reflections.keys.uniq.each do |assoc_object|
+          @klasses << eval(assoc_object.to_s.classify)
+        end
+
+        # Gererating the jQuery Validator code
+        @klasses.each do |klass|
+          @klass = klass
+
+          @klass.reflect_on_all_validations.each do |@v|
+            prefix = @klass.to_s.downcase
+
+            attribute_name = @v.name unless @v.macro == :validates_confirmation_of
+            attribute_name = "#{@v.name}_confirmation" if @v.macro == :validates_confirmation_of
+
+            @translate_message_key = "#{prefix}.#{@v.name}"
+
+            # debugger
+            if object.class.to_s.downcase == prefix
+              @field_name = "#{prefix}[#{attribute_name}]"
+              @field_id = "#{prefix}_#{attribute_name}"
+            else
+              prefix = "#{prefix}_attributes"
+
+              @field_name = "#{object.class.to_s.downcase}[#{prefix}][#{attribute_name}]"
+              @field_id = "#{object.class.to_s.downcase}_#{prefix}_#{attribute_name}"
+            end
+            @validators[@field_name] = {} unless @validators[@field_name]
+            @messages[@field_name] = {} unless @messages[@field_name]
+
+            # Set validation
+            unless @v.options[:allow_nil] && @v.options[:allow_blank]
+              @validators[@field_name]['required'] = true
+              @messages[@field_name]['required'] = ClientValidation::Util.message_for(@translate_message_key, :blank)
+            end
+            eval("self.set_#{@v.macro.to_s}")
+          end
+        end
+        [@declarations, {:rules => @validators, :messages => @messages}]
+      end
+
+      def self.set_validates_acceptance_of
+        @validators[@field_name]['required'] = true
+        @messages[@field_name]['required'] = ClientValidation::Util.message_for(@translate_message_key, :accepted)
+      end
+
+      def self.set_validates_associated
+        # Nothing to do here
+      end
+
+      def self.set_validates_confirmation_of
+        @validators[@field_name]['equalTo'] = "##{@field_id.gsub('_confirmation', '')}"
+        @validators[@field_name]['required'] = true
+
+        message = ClientValidation::Util.message_for(@translate_message_key, :confirmation)
+        @messages[@field_name]['equalTo'] = message
+        @messages[@field_name]['required'] = message
+      end
+
+      def self.set_validates_exclusion_of
+        enum = @v.options[:in]
+        message = ClientValidation::Util.message_for(@translate_message_key, :exclusion)
+        add_custom_rule(@field_name, Digest::SHA1.hexdigest(enum.inspect), "var list = #{enum.to_json}; for (var i=0; i<list.length; i++){if(list[i] == value) { return false; }} return true;", message)
+      end
+
+      def self.set_validates_inclusion_of
+        enum = @v.options[:in] || @v.options[:within]
+        message = ClientValidation::Util.message_for(@translate_message_key, :inclusion)
+
+        case enum
+        when Range
+          @validators[@field_name]['range'] = [enum.first, enum.last]
+          @messages[@field_name]['range'] = message
+        when Array
+          add_custom_rule(@field_name, Digest::SHA1.hexdigest(enum.inspect), "var list = #{enum.to_json}; for (var i=0; i<list.length; i++){if(list[i] == value) { return true; }}", message)
+        end
+      end
+
+      def self.set_validates_format_of
+        regex = @v.options[:with].inspect.gsub(/(.*)\/.*$/, '\1/')
+        message = ClientValidation::Util.message_for(@translate_message_key, :invalid)
+        add_custom_rule(@field_name, Digest::SHA1.hexdigest(regex.inspect), "return #{regex}.test(value)", message)
+      end
+
+      def self.set_validates_length_of
+        if @v.options[:minimum]
+          @validators[@field_name]['minlength'] = @v.options[:minimum]
+          @messages[@field_name]['minlength'] = ClientValidation::Util.message_for(@translate_message_key, :too_short)
+        end
+
+        if @v.options[:maximum]
+          @validators[@field_name]['maxlength'] = @v.options[:maximum]
+          @messages[@field_name]['maxlength'] = ClientValidation::Util.message_for(@translate_message_key, :too_long)
+        end
+
+        if @v.options[:within] || @v.options[:in]
+          r = @v.options[:within] || @v.options[:in]
+          @validators[@field_name]['rangelength'] = [r.first, r.last]
+          @messages[@field_name]['rangelength'] = "#{ClientValidation::Util.message_for(@translate_message_key, :inclusion)} (min: #{r.first}, max: #{r.last})"
+        end
+
+        if @v.options[:is]
+          length = @v.options[:is]
+          add_custom_rule(@field_name, "lengthIs#{length}", "return value.length == #{length}", ClientValidation::Util.message_for(@translate_message_key, :wrong_length))
+        end
+      end
+
+      def self.set_validates_numericality_of
+        @validators[@field_name]['digits'] = true
+        @validators[@field_name]['required'] = true
+
+        message = ClientValidation::Util.message_for(@translate_message_key, :not_a_number)
+        @messages[@field_name]['digits'] = message
+        @messages[@field_name]['required'] = message
+      end
+
+      def self.set_validates_uniqueness_of
+        @validators[@field_name]['remote'] = "/client_validations/uniqueness?model_class=#{@klass.to_s}"
+        @messages[@field_name]['remote'] = ClientValidation::Util.message_for(@translate_message_key, :taken)
+      end
+
+      def self.set_validates_presence_of
+        @validators[@field_name]['required'] = true
+        @messages[@field_name]['required'] = ClientValidation::Util.message_for(@translate_message_key, :blank)
+      end
+
+      def self.add_custom_rule(attribute, identifier, validation, message)
+        @declarations << <<-EOF
+          jQuery.validator.addMethod('#{identifier}', function(value){
+            #{validation}
+          }, '#{message}');
+        EOF
+        @validators[@field_name][identifier] = true
+      end
+
+    end
+  end
+end

data/lib/client_validations/form_builder.rb

@@ -0,0 +1,22 @@
+module ClientValidation
+  module FormBuilder
+    def client_validations
+      if object.new_record?
+        form_id = "new_#{object.class.to_s.downcase}"
+      else
+        form_id = "edit_#{object.class.to_s.downcase}"
+      end
+      declarations, validations = ClientValidation.current_adapter.render_script(object)
+      js = <<-EOF
+        #{declarations}
+        $('##{form_id}').validate({
+          rules: #{validations[:rules].to_json},
+          messages: #{validations[:messages].to_json}
+        });
+      EOF
+
+      html = template.content_tag(:script, js, :type => "text/javascript")
+      html.respond_to?(:html_safe!) ? html.html_safe! : html
+    end
+  end
+end

data/lib/client_validations/util.rb

@@ -0,0 +1,9 @@
+module ClientValidation
+  class Util
+    def self.message_for(field_scope, key)
+      field_name = I18n.translate(field_scope, {:scope => "activerecord.attributes"})
+      message_text = I18n.translate(key, {:scope => 'activerecord.errors.messages'})
+      "#{field_name} #{message_text}"
+    end
+  end
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification 
+name: client-validations
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Willian Fernandes
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-27 00:00:00 -02:00
+default_executable: 
+dependencies: []
+
+description: Translates the validations of model to the jQuery Validator
+email: willian@willianfernandes.com.br
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.textile
+files: 
+- .gitignore
+- MIT-LICENSE
+- README.textile
+- Rakefile
+- VERSION
+- app/controllers/client_validations_controller.rb
+- config/routes.rb
+- init.rb
+- lib/client_validations.rb
+- lib/client_validations/adapter_base.rb
+- lib/client_validations/adapter_base/validation_hook.rb
+- lib/client_validations/adapter_base/validation_response.rb
+- lib/client_validations/adapters/jquery_validations.rb
+- lib/client_validations/form_builder.rb
+- lib/client_validations/util.rb
+has_rdoc: true
+homepage: http://github.com/willian/client_validations
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Translates the validations of model to the jQuery Validator
+test_files: []
+