html5_validators 1.1.3 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ce3e90d93c4855d7bc7680fe214fd9d4715df134
-  data.tar.gz: b9c00e66bf79c7f2f1ba6cc7485dc499abfa0866
+  metadata.gz: 53351810292bd43edac8e3b5ce7a32981d4bf2ea
+  data.tar.gz: 2e86f48bbb046c3d2a586330991817bf59790442
 SHA512:
-  metadata.gz: 0897fd574293e79806322a314675fd41b5802709326ab508a19f276b70d11a57d2a4f1411a4f1711034c2fd44e9f287a4ca4de687256da97f9eedc354ae3ebd9
-  data.tar.gz: 819f6a2ab4e1ee7deb2741ef2f92ed5d1f3b433bebca0b863575286deda4de6d479330c018b582d71f2e03573228cf08eb2ee31bddc350ef62b34deee00290a2
+  metadata.gz: f945e1ad923ebd7c2de76b926365d7c892e704e536c3d82bd7fe96f01fcc8fe8d84a5e84b5182f0e63362fb035ca3fc8fa347eaa778b240bc631e52bea95b172
+  data.tar.gz: 201accfc19d6e505bbdb6a97a02fc9658c10be1e231c044b460ca89df1078ab767af2d2a7408aeb1c7400ca7645021ce0c76499815350d685c9ce8f988c957ca

data/.travis.yml

@@ -5,7 +5,7 @@ rvm:
   - 1.9.3
   - 2.0.0
   - 2.1
-  - 2.2.1
+  - 2.2.2
   - ruby-head
 
 gemfile:
@@ -35,11 +35,11 @@ matrix:
       gemfile: gemfiles/Gemfile.rails-edge
     - rvm: 2.1
       gemfile: gemfiles/Gemfile.rails-edge
-    - rvm: 2.2.1
+    - rvm: 2.2.2
       gemfile: gemfiles/Gemfile.rails-3.0
-    - rvm: 2.2.1
+    - rvm: 2.2.2
       gemfile: gemfiles/Gemfile.rails-3.1
-    - rvm: 2.2.1
+    - rvm: 2.2.2
       gemfile: gemfiles/Gemfile.rails-3.2
     - rvm: ruby-head
       gemfile: gemfiles/Gemfile.rails-3.0

data/README.md

@@ -0,0 +1,201 @@
+# HTML5Validators
+
+Automatic client-side validation using HTML5 Form Validation
+
+## What is this?
+
+html5_validators is a gem/plugin for Rails 3+ that enables automatic 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
+
+### PresenceValidator => required
+
+* Model
+```ruby
+class User
+  include ActiveModel::Validations
+  validates_presence_of :name
+end
+```
+
+* View
+```erb
+<%= f.text_field :name %>
+```
+other `text_field`ish helpers, `text_area`, `radio_button`, and `check_box` are also available
+
+* HTML
+```html
+<input id="user_name" name="user[name]" required="required" type="text" />
+```
+
+* SPEC
+
+http://dev.w3.org/html5/spec/Overview.html#attr-input-required
+
+![PresenceValidator](https://raw.githubusercontent.com/amatsuda/html5_validators/0928dc13fdd1a7746deed9a9cf7e865e13039df8/assets/presence.png)
+
+### LengthValidator => maxlength
+
+* Model
+```ruby
+class User
+  include ActiveModel::Validations
+  validates_length_of :name, maximum: 10
+end
+```
+
+* View
+```erb
+<%= f.text_field :name %>
+```
+`text_area` is also available
+
+* HTML
+```html
+<input id="user_name" maxlength="10" name="user[name]" size="10" type="text" />
+```
+
+* SPEC
+
+http://dev.w3.org/html5/spec/Overview.html#attr-input-maxlength
+
+### NumericalityValidator => max, min
+
+* Model
+```ruby
+class User
+  include ActiveModel::Validations
+  validates_numericality_of :age, greater_than_or_equal_to: 20
+end
+```
+
+* View (be sure to use number_field)
+```erb
+<%= f.number_field :age %>
+```
+
+* HTML
+```html
+<input id="user_age" min="20" name="user[age]" size="30" type="number" />
+```
+
+* SPEC
+
+http://dev.w3.org/html5/spec/Overview.html#attr-input-max
+http://dev.w3.org/html5/spec/Overview.html#attr-input-min
+
+![NumericalityValidator](https://raw.githubusercontent.com/amatsuda/html5_validators/0928dc13fdd1a7746deed9a9cf7e865e13039df8/assets/numericality.png)
+
+### And more (coming soon...?)
+:construction:
+
+## Disabling automatic client-side validation
+
+There are four ways to cancel the automatic HTML5 validation.
+
+### 1. Per form (via form_for option)
+
+Set `auto_html5_validation: false` to `form_for` parameter.
+
+* View
+```erb
+<%= form_for @user, auto_html5_validation: false do |f| %>
+  ...
+<% end %>
+```
+
+### 2. Per model instance (via model attribute)
+
+Set `auto_html5_validation = false` attribute to ActiveModelish object.
+
+* Controller
+```ruby
+@user = User.new auto_html5_validation: false
+```
+
+* View
+```erb
+<%= form_for @user do |f| %>
+  ...
+<% end %>
+```
+
+### 3. Per model class (via model class attribute)
+
+Set `auto_html5_validation = false` to ActiveModelish class variable.
+
+* Model
+```ruby
+class User < ActiveRecord::Base
+  self.auto_html5_validation = false
+end
+```
+
+* Controller
+```ruby
+@user = User.new
+```
+
+* View
+```erb
+<%= form_for @user do |f| %>
+  ...
+<% end %>
+```
+
+### 4. Globally (via HTML5Validators module configuration)
+
+Set `config.enabled = false` to Html5Validators module.
+Maybe you want to put this in your test_helper, or add a controller filter as
+follows for development mode.
+
+* Controller
+```ruby
+# an example filter that disables the validator if the request has {h5v: 'disable'} params
+around_action do |controller, block|
+  h5v_enabled_was = Html5Validators.enabled
+  Html5Validators.enabled = false if params[:h5v] == 'disable'
+  block.call
+  Html5Validators.enabled = h5v_enabled_was
+end
+```
+
+## Supported versions
+
+* Ruby 1.8.7, 1.9.2, 1.9.3, 2.0, 2.1, 2.2, 2.3 (trunk)
+
+* Rails 3.0.x, 3.1.x, 3.2.x, 4.0.x, 4.1, 4.2, 5.0 (edge)
+
+* HTML5 compatible browsers
+
+
+## Installation
+
+Put this line into your Gemfile:
+```ruby
+gem 'html5_validators'
+```
+
+Then bundle:
+```
+% bundle
+```
+
+## Notes
+
+When accessed by an HTML5 incompatible lagacy browser, these extra attributes
+will just be ignored.
+
+## Todo
+
+* more validations
+
+
+## Copyright
+
+Copyright (c) 2011 Akira Matsuda. See MIT-LICENSE for further details.

data/html5_validators.gemspec

@@ -11,6 +11,7 @@ Gem::Specification.new do |s|
   s.homepage    = 'https://github.com/amatsuda/html5_validators'
   s.summary     = 'Automatic client side validation using HTML5 Form Validation'
   s.description = 'A gem/plugin for Rails 3+ that enables client-side validation using ActiveModel + HTML5'
+  s.license     = 'MIT'
 
   s.rubyforge_project = 'html5_validators'
 

data/lib/html5_validators.rb

@@ -1,6 +1,16 @@
 require 'rails'
 
 module Html5Validators
+  @enabled = true
+
+  def self.enabled
+    @enabled
+  end
+
+  def self.enabled=(enable)
+    @enabled = enable
+  end
+
   class Railtie < ::Rails::Railtie #:nodoc:
     initializer 'html5_validators' do |app|
       ActiveSupport.on_load(:active_record) do

data/lib/html5_validators/action_view/form_helpers.rb

@@ -2,13 +2,13 @@ module Html5Validators
   module ActionViewExtension
     def inject_required_field
       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["required"] ||= @options[:required] || object.class.attribute_required?(@method_name)
       end
     end
 
     def inject_maxlength_field
       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["maxlength"] ||= @options[:maxlength] || object.class.attribute_maxlength(@method_name)
       end
     end
   end
@@ -19,7 +19,11 @@ 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=)
+        if record.respond_to?(:auto_html5_validation=)
+          if !Html5Validators.enabled || (options[:auto_html5_validation] == false)
+            record.auto_html5_validation = false
+          end
+        end
         form_for_without_auto_html5_validation_option record, options, &proc
       end
       alias_method_chain :form_for, :auto_html5_validation_option
@@ -37,8 +41,8 @@ module ActionView
             inject_maxlength_field
 
             if object.class.ancestors.include?(ActiveModel::Validations) && (object.auto_html5_validation != false) && (object.class.auto_html5_validation != false)
-              @options["max"] ||= object.class.attribute_max(@method_name)
-              @options["min"] ||= object.class.attribute_min(@method_name)
+              @options["max"] ||= @options["maxlength"] || @options[:maxlength] || object.class.attribute_max(@method_name)
+              @options["min"] ||= @options["minlength"] || @options[:minlength] || object.class.attribute_min(@method_name)
             end
             render_without_html5_attributes
           end

data/lib/html5_validators/version.rb

@@ -1,3 +1,3 @@
 module Html5Validators
-  VERSION = '1.1.3'
+  VERSION = '1.2.0'
 end

data/spec/fake_app.rb

@@ -16,6 +16,7 @@ app.routes.draw do
   resources :people, :only => [:new, :create] do
     collection do
       get :new_without_html5_validation
+      get :new_with_required_true
     end
   end
 end
@@ -46,6 +47,15 @@ ERB
 <% end %>
 ERB
   end
+
+  def new_with_required_true
+    @person = Person.new
+    render :inline => <<-ERB
+<%= form_for @person do |f| %>
+<%= f.text_field :email, :required => true %>
+<% end %>
+    ERB
+  end
 end
 
 # helpers

data/spec/features/validation_spec.rb

@@ -33,6 +33,11 @@ feature 'person#new' do
 
       find('input#person_name')[:required].should be_nil
     end
+    scenario 'new_with_required_true form' do
+      visit '/people/new_with_required_true'
+
+      find('input#person_email')[:required].should == 'required'
+    end
 
     context 'disabling html5_validation in class level' do
       background do
@@ -51,6 +56,21 @@ feature 'person#new' do
         find('input#person_name')[:required].should be_nil
       end
     end
+
+    context 'disabling html5_validations in gem' do
+      background do
+        Html5Validators.enabled = false
+      end
+      after do
+        Html5Validators.enabled = true
+      end
+      scenario 'new form' do
+        visit '/people/new'
+
+        find('input#person_name')[:required].should be_nil
+        find('textarea#person_bio')[:required].should be_nil
+      end
+    end
   end
 
   context 'with maxlength validation' do

data/spec/spec_helper.rb

@@ -11,6 +11,10 @@ require 'rspec/rails'
 Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
 
 RSpec.configure do |config|
+  if config.respond_to? :expect_with
+    config.expect_with(:rspec) { |c| c.syntax = :should }
+  end
+
   config.before :all do
     ActiveRecord::Migration.verbose = false
     CreateAllTables.up unless ActiveRecord::Base.connection.table_exists? 'people'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: html5_validators
 version: !ruby/object:Gem::Version
-  version: 1.1.3
+  version: 1.2.0
 platform: ruby
 authors:
 - Akira Matsuda
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-10 00:00:00.000000000 Z
+date: 2015-05-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec-rails
@@ -79,7 +79,7 @@ files:
 - ".travis.yml"
 - Gemfile
 - MIT-LICENSE
-- README.rdoc
+- README.md
 - Rakefile
 - gemfiles/Gemfile.rails-3.0
 - gemfiles/Gemfile.rails-3.1
@@ -101,7 +101,8 @@ files:
 - spec/models/active_record/inherited_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/amatsuda/html5_validators
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []

data/README.rdoc

@@ -1,149 +0,0 @@
-= HTML5Validators
-
-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.
-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
-
-===  PresenceValidator => requried
-
-  Model:
-    class User
-      include ActiveModel::Validations
-      validates_presence_of :name
-    end
-
-  View:
-    <%= f.text_field :name %>
-    other text_fieldish helpers, text_area, radio_button, and check_box are also available
-
-  HTML:
-    <input id="user_name" name="user[name]" required="required" type="text" />
-
-  SPEC:
-    http://dev.w3.org/html5/spec/Overview.html#attr-input-required
-
-http://img.skitch.com/20110517-8sagqrkjnmkinapmcc5tduy2b8.jpg
-
-===  LengthValidator => maxlength
-
-  Model:
-    class User
-      include ActiveModel::Validations
-      validates_length_of :name, :maximum => 10
-    end
-
-  View:
-    <%= f.text_field :name %>
-    text_area is also available
-
-  HTML:
-    <input id="user_name" maxlength="10" name="user[name]" size="10" type="text" />
-
-  SPEC:
-    http://dev.w3.org/html5/spec/Overview.html#attr-input-maxlength
-
-===  NumericalityValidator => max, min
-
-  Model:
-    class User
-      include ActiveModel::Validations
-      validates_numericality_of :age, :greater_than_or_equal_to => 20
-    end
-
-  View: (be sure to use number_field)
-    <%= f.number_field :age %>
-
-  HTML:
-    <input id="user_age" min="20" name="user[age]" size="30" type="number" />
-
-  SPEC:
-    http://dev.w3.org/html5/spec/Overview.html#attr-input-max
-    http://dev.w3.org/html5/spec/Overview.html#attr-input-min
-
-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
-      self.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, 2.1, 2.2, 2.3 (trunk)
-
-* Rails 3.0.x, 3.1.x, 3.2.x, 4.0.x, 4.1, 4.2, 5.0 (edge)
-
-* HTML5 compatible browsers
-
-
-== Installation
-
-Put this line into your Gemfile:
-  gem 'html5_validators'
-
-Then bundle:
-  % bundle
-
-
-== Notes
-
-When accessed by an HTML5 incompatible lagacy browser, these extra attributes will just be ignored.
-
-
-== Todo
-
-* more validations
-
-
-== Copyright
-
-Copyright (c) 2011 Akira Matsuda. See MIT-LICENSE for further details.