html5_validators 0.2.0 → 1.0.0

data/.gitignore

@@ -2,3 +2,5 @@
 .bundle
 Gemfile.lock
 pkg/*
+tmp
+log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format=d

data/README.rdoc

@@ -5,7 +5,8 @@ Automatic client-side validation using HTML5 Form Validation
 
 == What is this?
 
-html5_validators is a gem/plugin for Rails 3 that enables client-side validation using ActiveModel + HTML5
+html5_validators is a gem/plugin for Rails 3 that enables client-side validation using ActiveModel + HTML5.
+Once you bundle this gem on your app, the gem will automatically translate your model validation code into HTML5 validation attributes on every `form_for` invocation unless you explicitly cancel it.
 
 
 == Features
@@ -28,7 +29,6 @@ html5_validators is a gem/plugin for Rails 3 that enables client-side validation
   SPEC:
     http://dev.w3.org/html5/spec/Overview.html#attr-input-required
 
-  SCREENSHOTS:
 http://img.skitch.com/20110517-8sagqrkjnmkinapmcc5tduy2b8.jpg
 
 ===  LengthValidator => maxlength
@@ -66,13 +66,55 @@ http://img.skitch.com/20110517-8sagqrkjnmkinapmcc5tduy2b8.jpg
     http://dev.w3.org/html5/spec/Overview.html#attr-input-max
     http://dev.w3.org/html5/spec/Overview.html#attr-input-min
 
-  SCREENSHOT:
 http://img.skitch.com/20110516-n3jhu5m4gan8iy1j8er1qb7yfa.jpg
 
 
 * And more (coming soon...?)
 
 
+== Disabling automatic client-side validation
+
+There are three ways to cancel the automatic HTML5 validation
+
+* form_for option
+
+Set `auto_html5_validation: false` to `form_for` parameter
+
+  View:
+    <%= form_for @user, :auto_html5_validation => false do |f| %>
+      ...
+    <% end %>
+
+* model attribute
+
+Set `auto_html5_validation = false` attribute to ActiveModelish object
+
+  Controller:
+    @user = User.new auto_html5_validation: false
+
+  View:
+    <%= form_for @user do |f| %>
+      ...
+    <% end %>
+
+* model class configuration
+
+Write `auto_html5_validation = false` in ActiveModelish class
+
+  Model:
+    class User < ActiveRecord::Base
+      auto_html5_validation = false
+    end
+
+  Controller:
+    @user = User.new
+
+  View:
+    <%= form_for @user do |f| %>
+      ...
+    <% end %>
+
+
 == Supported versions
 
 * Ruby 1.8.7, 1.9.2, 1.9.3, 2.0 (trunk)
@@ -98,7 +140,6 @@ When accessed by an HTML5 incompatible lagacy browser, these extra attributes wi
 
 == Todo
 
-* specs
 * more validations
 
 

data/Rakefile

@@ -1,2 +1,10 @@
 require 'bundler'
 Bundler::GemHelper.install_tasks
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+task :noop do; end
+task :default => :spec
+
+RSpec::Core::RakeTask.new(:spec => :noop)

data/html5_validators.gemspec

@@ -18,4 +18,8 @@ Gem::Specification.new do |s|
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ['lib']
+  s.add_development_dependency 'activerecord'
+  s.add_development_dependency 'rspec-rails'
+  s.add_development_dependency 'capybara'
+  s.add_development_dependency 'sqlite3'
 end

data/lib/html5_validators/action_view/form_helpers.rb

@@ -1,7 +1,7 @@
 module Html5Validators
   module ActionViewExtension
     def inject_required_field
-      if object.class.ancestors.include?(ActiveModel::Validations)
+      if object.class.ancestors.include?(ActiveModel::Validations) && (object.auto_html5_validation != false) && (object.class.auto_html5_validation != false)
         @options["required"] ||= object.class.attribute_required?(@method_name)
       end
     end
@@ -11,6 +11,14 @@ end if ActionPack::VERSION::STRING >= '4'
 
 module ActionView
   module Helpers
+    module FormHelper
+      def form_for_with_auto_html5_validation_option(record, options = {}, &proc)
+        record.auto_html5_validation = false if (options[:auto_html5_validation] == false) && (record.respond_to? :auto_html5_validation=)
+        form_for_without_auto_html5_validation_option record, options, &proc
+      end
+      alias_method_chain :form_for, :auto_html5_validation_option
+    end
+
     if ActionPack::VERSION::STRING >= '4'
       module Tags
         class Base #:nodoc:
@@ -21,7 +29,7 @@ module ActionView
           def render_with_html5_attributes
             inject_required_field
 
-            if object.class.ancestors.include?(ActiveModel::Validations)
+            if object.class.ancestors.include?(ActiveModel::Validations) && (object.auto_html5_validation != false) && (object.class.auto_html5_validation != false)
               @options["maxlength"] ||= object.class.attribute_maxlength(@method_name)
               @options["max"] ||= object.class.attribute_max(@method_name)
               @options["min"] ||= object.class.attribute_min(@method_name)
@@ -46,7 +54,7 @@ module ActionView
     else
       class InstanceTag
         def to_input_field_tag_with_html5_attributes(field_type, options = {})
-          if object.class.ancestors.include?(ActiveModel::Validations)
+          if object.class.ancestors.include?(ActiveModel::Validations) && (object.auto_html5_validation != false) && (object.class.auto_html5_validation != false)
             options["required"] ||= object.class.attribute_required?(method_name)
             options["maxlength"] ||= object.class.attribute_maxlength(method_name)
             options["max"] ||= object.class.attribute_max(method_name)
@@ -57,7 +65,7 @@ module ActionView
         alias_method_chain :to_input_field_tag, :html5_attributes
 
         def to_text_area_tag_with_html5_attributes(options = {})
-          if object.class.ancestors.include?(ActiveModel::Validations)
+          if object.class.ancestors.include?(ActiveModel::Validations) && (object.auto_html5_validation != false) && (object.class.auto_html5_validation != false)
             options["required"] ||= object.class.attribute_required?(method_name)
           end
           to_text_area_tag_without_html5_attributes options
@@ -65,7 +73,7 @@ module ActionView
         alias_method_chain :to_text_area_tag, :html5_attributes
 
         def to_radio_button_tag_with_html5_attributes(tag_value, options = {})
-          if object.class.ancestors.include?(ActiveModel::Validations)
+          if object.class.ancestors.include?(ActiveModel::Validations) && (object.auto_html5_validation != false) && (object.class.auto_html5_validation != false)
             options["required"] ||= object.class.attribute_required?(method_name)
           end
           to_radio_button_tag_without_html5_attributes tag_value, options
@@ -73,7 +81,7 @@ module ActionView
         alias_method_chain :to_radio_button_tag, :html5_attributes
 
         def to_check_box_tag_with_html5_attributes(options = {}, checked_value = "1", unchecked_value = "0")
-          if object.class.ancestors.include?(ActiveModel::Validations)
+          if object.class.ancestors.include?(ActiveModel::Validations) && (object.auto_html5_validation != false) && (object.class.auto_html5_validation != false)
             options["required"] ||= object.class.attribute_required?(method_name)
           end
           to_check_box_tag_without_html5_attributes options, checked_value, unchecked_value

data/lib/html5_validators/active_model/validations.rb

@@ -0,0 +1,5 @@
+module ActiveModel
+  module Validations
+    attr_accessor :auto_html5_validation
+  end
+end

data/lib/html5_validators/active_record/base.rb

@@ -0,0 +1,19 @@
+module ActiveRecord
+  class Base
+    # Future subclasses will pick up the model extension
+    class << self
+      def inherited_with_html5_validation(kls) #:nodoc:
+        inherited_without_html5_validation kls
+        kls.class_eval do
+          cattr_accessor :auto_html5_validation, :instance_accessor => false
+        end if kls.superclass == ActiveRecord::Base
+      end
+      alias_method_chain :inherited, :html5_validation
+    end
+
+    # Existing subclasses pick up the model extension as well
+    self.descendants.each do |kls|
+      cattr_accessor :auto_html5_validation, :instance_accessor => false if kls.superclass == ActiveRecord::Base
+    end
+  end
+end

data/lib/html5_validators/version.rb

@@ -1,3 +1,3 @@
 module Html5Validators
-  VERSION = '0.2.0'
+  VERSION = '1.0.0'
 end

data/lib/html5_validators.rb

@@ -4,13 +4,15 @@ module Html5Validators
   class Railtie < ::Rails::Railtie #:nodoc:
     initializer 'html5_validators' do |app|
       ActiveSupport.on_load(:active_record) do
-        require File.join(File.dirname(__FILE__), 'html5_validators/active_model/helper_methods')
+        require 'html5_validators/active_model/helper_methods'
+        require 'html5_validators/active_model/validations'
         if (Rails.version < '3.1.0.beta2') && (Rails.version != '3.1.0')
-          require File.join(File.dirname(__FILE__), 'html5_validators/active_model/initializer_monkey_patches')
+          require 'html5_validators/active_model/initializer_monkey_patches'
         end
+        require 'html5_validators/active_record/base'
       end
       ActiveSupport.on_load(:action_view) do
-        require File.join(File.dirname(__FILE__), 'html5_validators/action_view/form_helpers')
+        require 'html5_validators/action_view/form_helpers'
       end
     end
   end

data/spec/fake_app.rb

@@ -0,0 +1,57 @@
+require 'active_record'
+require 'action_controller/railtie'
+
+# config
+ActiveRecord::Base.establish_connection(:adapter => 'sqlite3', :database => ':memory:')
+
+app = Class.new(Rails::Application)
+app.config.secret_token = "You know I'm born to lose, and gambling's for fools, But that's the way I like it baby, I don't wanna live for ever, And don't forget the joker!"
+app.config.session_store :cookie_store, :key => '_myapp_session'
+app.config.active_support.deprecation = :log
+app.initialize!
+
+# routes
+app.routes.draw do
+  resources :people, :only => [:new, :create] do
+    collection do
+      get :new_without_html5_validation
+    end
+  end
+end
+
+# models
+class Person < ActiveRecord::Base
+end
+
+# controllers
+class ApplicationController < ActionController::Base; end
+class PeopleController < ApplicationController
+  def new
+    @person = Person.new
+    render :inline => <<-ERB
+<%= form_for @person do |f| %>
+<%= f.text_field :name %>
+<% end %>
+ERB
+  end
+
+  def new_without_html5_validation
+    @person = Person.new
+    render :inline => <<-ERB
+<%= form_for @person, :auto_html5_validation => false do |f| %>
+<%= f.text_field :name %>
+<%= f.text_field :email %>
+<% end %>
+ERB
+  end
+end
+
+# helpers
+module ApplicationHelper; end
+
+#migrations
+class CreateAllTables < ActiveRecord::Migration
+  def self.up
+    create_table(:people) {|t| t.string :name; t.string :email; t.integer :age}
+  end
+end

data/spec/requests/validation_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+
+feature 'person#new' do
+  context 'without validation' do
+    scenario 'new form' do
+      visit '/people/new'
+      page.should have_css('input#person_name')
+      page.should_not have_css('input#person_name[required=required]')
+    end
+
+    scenario 'new_without_html5_validation form' do
+      visit '/people/new_without_html5_validation'
+      page.should have_css('input#person_email')
+      page.should_not have_css('input#person_email[required=required]')
+    end
+  end
+
+  context 'with required validation' do
+    background do
+      Person.validates_presence_of :name
+    end
+    after do
+      Person._validators.clear
+    end
+    scenario 'new form' do
+      visit '/people/new'
+      page.should have_css('input#person_name')
+      page.should have_css('input#person_name[required=required]')
+    end
+    scenario 'new_without_html5_validation form' do
+      visit '/people/new_without_html5_validation'
+      page.should have_css('input#person_name')
+      page.should_not have_css('input#person_name[required=required]')
+    end
+
+    context 'disabling html5_validation in class level' do
+      background do
+        Person.class_eval do |kls|
+          kls.auto_html5_validation = false
+        end
+      end
+      after do
+        Person.class_eval do |kls|
+          kls.auto_html5_validation = nil
+        end
+      end
+      scenario 'new form' do
+        visit '/people/new'
+        page.should have_css('input#person_name')
+        page.should_not have_css('input#person_name[required=required]')
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+# load Rails first
+require 'rails'
+require 'html5_validators'
+# needs to load the app before loading rspec/rails => capybara
+require 'fake_app'
+require 'rspec/rails'
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  config.before :all do
+    CreateAllTables.up unless ActiveRecord::Base.connection.table_exists? 'people'
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: html5_validators
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,8 +9,52 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-02 00:00:00.000000000 Z
-dependencies: []
+date: 2012-05-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: &70174708849260 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70174708849260
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: &70174708848720 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70174708848720
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: &70174708848200 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70174708848200
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: &70174708847560 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70174708847560
 description: A gem/plugin for Rails 3 that enables client-side validation using ActiveModel
   + HTML5
 email:
@@ -20,6 +64,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
 - Gemfile
 - MIT-LICENSE
 - README.rdoc
@@ -29,7 +74,12 @@ files:
 - lib/html5_validators/action_view/form_helpers.rb
 - lib/html5_validators/active_model/helper_methods.rb
 - lib/html5_validators/active_model/initializer_monkey_patches.rb
+- lib/html5_validators/active_model/validations.rb
+- lib/html5_validators/active_record/base.rb
 - lib/html5_validators/version.rb
+- spec/fake_app.rb
+- spec/requests/validation_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/amatsuda/html5_validators
 licenses: []
 post_install_message: 
@@ -54,4 +104,7 @@ rubygems_version: 1.8.16
 signing_key: 
 specification_version: 3
 summary: Automatic client side validation using HTML5 Form Validation
-test_files: []
+test_files:
+- spec/fake_app.rb
+- spec/requests/validation_spec.rb
+- spec/spec_helper.rb