simple_form 1.4.0 → 1.4.2

data/.travis.yml

@@ -1,6 +1,7 @@
-script: "git submodule update --init && rake test"
+script: "git submodule update --init && bundle exec rake test"
 rvm:
   - 1.8.7
   - 1.9.2
   - ree
   - jruby
+  - rubinius

data/CHANGELOG.rdoc

@@ -1,3 +1,19 @@
+== 1.4.2
+
+* enhancements
+  * Rails 3.1 support
+
+== 1.4.1
+
+* enhancements
+  * ignore required attribute when conditional validations are present
+
+* bug fix
+  * Do not use required='required' when browser validations are turned off
+  * Sanitize HMTL attributes in error and hint helpers when options are present
+  * Improve i18n lookup by ignoring explicit child index given to form builder (tests by github.com/rywall)
+  * Fixes the form specific validation option if specified on the form itself (by github.com/medihack)
+
 == 1.4.0
 
 * enhancements

data/Gemfile

@@ -1,8 +1,8 @@
 source "http://rubygems.org"
 
-gem "rails", "~> 3.0.7"
+gemspec
 
 group :test do
   gem "mocha",      :require => false
-  gem "ruby-debug", :require => false, :platform => :ruby_18
+  gem "ruby-debug", :require => false, :platform => :mri_18
 end

data/Gemfile.lock

@@ -1,13 +1,17 @@
+PATH
+  remote: .
+  specs:
+    simple_form (1.4.1)
+      actionpack (~> 3.0)
+      activemodel (~> 3.0)
+
 GEM
   remote: http://rubygems.org/
   specs:
     abstract (1.0.0)
-    actionmailer (3.0.7)
-      actionpack (= 3.0.7)
-      mail (~> 2.2.15)
-    actionpack (3.0.7)
-      activemodel (= 3.0.7)
-      activesupport (= 3.0.7)
+    actionpack (3.0.9)
+      activemodel (= 3.0.9)
+      activesupport (= 3.0.9)
       builder (~> 2.1.2)
       erubis (~> 2.6.6)
       i18n (~> 0.5.0)
@@ -15,68 +19,36 @@ GEM
       rack-mount (~> 0.6.14)
       rack-test (~> 0.5.7)
       tzinfo (~> 0.3.23)
-    activemodel (3.0.7)
-      activesupport (= 3.0.7)
+    activemodel (3.0.9)
+      activesupport (= 3.0.9)
       builder (~> 2.1.2)
       i18n (~> 0.5.0)
-    activerecord (3.0.7)
-      activemodel (= 3.0.7)
-      activesupport (= 3.0.7)
-      arel (~> 2.0.2)
-      tzinfo (~> 0.3.23)
-    activeresource (3.0.7)
-      activemodel (= 3.0.7)
-      activesupport (= 3.0.7)
-    activesupport (3.0.7)
-    arel (2.0.9)
+    activesupport (3.0.9)
     builder (2.1.2)
     columnize (0.3.2)
     erubis (2.6.6)
       abstract (>= 1.0.0)
     i18n (0.5.0)
     linecache (0.43)
-    mail (2.2.18)
-      activesupport (>= 2.3.6)
-      i18n (>= 0.4.0)
-      mime-types (~> 1.16)
-      treetop (~> 1.4.8)
-    mime-types (1.16)
     mocha (0.9.10)
       rake
-    polyglot (0.3.1)
-    rack (1.2.2)
+    rack (1.2.3)
     rack-mount (0.6.14)
       rack (>= 1.0.0)
     rack-test (0.5.7)
       rack (>= 1.0)
-    rails (3.0.7)
-      actionmailer (= 3.0.7)
-      actionpack (= 3.0.7)
-      activerecord (= 3.0.7)
-      activeresource (= 3.0.7)
-      activesupport (= 3.0.7)
-      bundler (~> 1.0)
-      railties (= 3.0.7)
-    railties (3.0.7)
-      actionpack (= 3.0.7)
-      activesupport (= 3.0.7)
-      rake (>= 0.8.7)
-      thor (~> 0.14.4)
     rake (0.8.7)
     ruby-debug (0.10.4)
       columnize (>= 0.1)
       ruby-debug-base (~> 0.10.4.0)
     ruby-debug-base (0.10.4)
       linecache (>= 0.3)
-    thor (0.14.6)
-    treetop (1.4.9)
-      polyglot (>= 0.3.1)
-    tzinfo (0.3.27)
+    tzinfo (0.3.28)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   mocha
-  rails (~> 3.0.7)
   ruby-debug
+  simple_form!

data/README.rdoc

@@ -232,6 +232,16 @@ All web forms need buttons, right? SimpleForm wraps them in the DSL, acting like
 
 The above will simply call submit. You choose to use it or not, it's just a question of taste.
 
+== Wrapping Rails Form Helpers
+
+Say you wanted to use a rails form helper but still wrap it in SimpleForm goodness? You can, by calling input with a block like so:
+
+  <%= f.input :role do %>
+    <%= f.select :role, Role.all.map { |r| [r.name, r.id, { :class => r.company.id }] }, :include_blank => true %>
+  <% end %>
+
+In the above example, we're taking advantage of Rails 3's select method that allows us to pass in a hash of additional attributes for each option.
+
 == Extra helpers
 
 SimpleForm also comes with some extra helpers you can use inside rails default forms without relying on simple_form_for helper. They are listed below.
@@ -275,6 +285,13 @@ Creates a collection of check boxes with labels associated (same API as collecti
   <input id="user_options_false" name="user[options][]" type="checkbox" value="false" />
   <label class="collection_check_box" for="user_options_false">No</label>
 
+To use this with associations in your model, you can do the following:
+
+  form_for @user do |f|
+    f.collection_check_boxes :role_ids, Role.all, :id, :name # using :roles here is not going to work.
+  end
+
+
 == Mappings/Inputs available
 
 SimpleForm comes with a lot of default mappings:
@@ -308,9 +325,9 @@ SimpleForm comes with a lot of default mappings:
 It is very easy to add custom inputs to SimpleForm. For instance, if you want to add a custom input that extends the string one, you just need to add this file:
 
     # app/inputs/currency_input.rb
-    class CurrencyInput < SimpleForm::Inputs::StringInput
+    class CurrencyInput < SimpleForm::Inputs::Base
       def input
-        "$ #{super}".html_safe
+        "$ #{@builder.text_field(attribute_name, input_html_options)}".html_safe
       end
     end
 
@@ -425,6 +442,10 @@ If you want to have all other HTML 5 features, such as the new field types, you
 
 This option adds a new `novalidate` property to the form, instructing it to skip all HTML 5 validation. The inputs will still be generated with the required and other attributes, that might help you to use some generic javascript validation.
 
+You can also add `novalidate` to a specific form by setting the option on the form itself:
+
+  <%= simple_form_for(resource, :html => {:novalidate => true}) do |form| %>
+
 Please notice that any of the configurations above will disable the `placeholder` component, which is an HTML 5 feature. We believe most of the newest browsers are handling this attribute fine, and if they aren't, any plugin you use would take of using the placeholder attribute to do it. However, you can disable it if you want, by removing the placeholder component from the components list in SimpleForm configuration file.
 
 == Configuration

data/lib/generators/simple_form/templates/simple_form.rb

@@ -43,10 +43,10 @@ SimpleForm.setup do |config|
   # You can wrap each item in a collection of radio/check boxes with a tag, defaulting to span.
   # config.item_wrapper_tag = :span
 
-  # Series of attemps to detect a default label method for collection.
+  # Series of attempts to detect a default label method for collection.
   # config.collection_label_methods = [ :to_label, :name, :title, :to_s ]
 
-  # Series of attemps to detect a default value method for collection.
+  # Series of attempts to detect a default value method for collection.
   # config.collection_value_methods = [ :id, :to_s ]
 
   # How the label text should be generated altogether with the required text.

data/lib/simple_form/action_view_extensions/form_helper.rb

@@ -29,25 +29,31 @@ module SimpleForm
         result
       end
 
-      [:form_for, :fields_for].each do |helper|
-        class_eval <<-METHOD, __FILE__, __LINE__
-          def simple_#{helper}(record_or_name_or_array, *args, &block)
-            options = args.extract_options!
-            options[:builder] ||= SimpleForm::FormBuilder
-            css_class = case record_or_name_or_array
-              when String, Symbol then record_or_name_or_array.to_s
-              when Array then dom_class(record_or_name_or_array.last)
-              else dom_class(record_or_name_or_array)
-            end
-            options[:html] ||= {}
-            options[:html][:novalidate] = !SimpleForm.browser_validations
-            options[:html][:class] = "\#{SimpleForm.form_class} \#{css_class} \#{options[:html][:class]}".strip
+      def simple_form_for(record, options={}, &block)
+        options[:builder] ||= SimpleForm::FormBuilder
+        css_class = case record
+                    when String, Symbol then record.to_s
+                    when Array then dom_class(record.last)
+                    else dom_class(record)
+                    end
+        options[:html] ||= {}
+        unless options[:html].key?(:novalidate)
+          options[:html][:novalidate] = !SimpleForm.browser_validations
+        end
+        options[:html][:class] = "#{SimpleForm.form_class} #{css_class} #{options[:html][:class]}".strip
 
-            with_custom_field_error_proc do
-              #{helper}(record_or_name_or_array, *(args << options), &block)
-            end
-          end
-        METHOD
+        with_custom_field_error_proc do
+          form_for(record, options, &block)
+        end
+      end
+
+      def simple_fields_for(record_name, record_object = nil, options = {}, &block)
+        options, record_object = record_object, nil if record_object.is_a?(Hash)
+        options[:builder] ||= SimpleForm::FormBuilder
+
+        with_custom_field_error_proc do
+          fields_for(record_name, record_object, options, &block)
+        end
       end
     end
   end

data/lib/simple_form/form_builder.rb

@@ -109,7 +109,7 @@ module SimpleForm
     #        name="user[name]" size="100" type="text" value="Carlos" />
     #
     def input_field(attribute_name, options={})
-      options[:input_html] = options.except(:as)
+      options[:input_html] = options.except(:as, :collection, :label_method, :value_method)
       options.merge!(:components => [:input], :wrapper => false)
       input(attribute_name, options)
     end
@@ -204,7 +204,7 @@ module SimpleForm
     #    f.error :name, :id => "cool_error"
     #
     def error(attribute_name, options={})
-      options[:error_html] = options.dup
+      options[:error_html] = options.except(:error_tag, :error_prefix, :error_method)
       column      = find_attribute_column(attribute_name)
       input_type  = default_input_type(attribute_name, column, options)
       SimpleForm::Inputs::Base.new(self, attribute_name, column, input_type, options).error
@@ -238,7 +238,7 @@ module SimpleForm
     #    f.hint "Don't forget to accept this"
     #
     def hint(attribute_name, options={})
-      options[:hint_html] = options.dup
+      options[:hint_html] = options.except(:hint_tag)
       if attribute_name.is_a?(String)
         options[:hint] = attribute_name
         attribute_name, column, input_type = nil, nil, nil

data/lib/simple_form/inputs/base.rb

@@ -66,7 +66,9 @@ module SimpleForm
         if !options[:required].nil?
           options[:required]
         elsif has_validators?
-          (attribute_validators + reflection_validators).any? { |v| v.kind == :presence }
+          (attribute_validators + reflection_validators).any? do |v|
+            v.kind == :presence && !conditional_validators?(v)
+          end
         else
           attribute_required_by_default?
         end
@@ -74,7 +76,7 @@ module SimpleForm
 
       # Whether this input is valid for HTML 5 required attribute.
       def has_required?
-        attribute_required? && SimpleForm.html5
+        attribute_required? && SimpleForm.html5 && SimpleForm.browser_validations
       end
 
       def has_autofocus?
@@ -93,6 +95,10 @@ module SimpleForm
         reflection ? object.class.validators_on(reflection.name) : []
       end
 
+      def conditional_validators?(validator)
+        validator.options.include?(:if) || validator.options.include?(:unless)
+      end
+
       def attribute_required_by_default?
         SimpleForm.required_by_default
       end
@@ -169,7 +175,8 @@ module SimpleForm
         I18n.t(lookups.shift, :scope => :"simple_form.#{namespace}", :default => lookups).presence
       end
 
-      # Extract the model names from the object_name mess.
+      # Extract the model names from the object_name mess, ignoring numeric and
+      # explicit child indexes.
       #
       # Example:
       #
@@ -177,9 +184,10 @@ module SimpleForm
       # ["route", "blocks", "blocks_learning_object", "foo"]
       #
       def lookup_model_names
-        object_name.to_s.scan(/([a-zA-Z_]+)/).flatten.map do |x|
-          x.gsub('_attributes', '')
-        end
+        child_index = @builder.options[:child_index]
+        names = object_name.to_s.scan(/([a-zA-Z_]+)/).flatten
+        names.delete(child_index) if child_index
+        names.each { |name| name.gsub!('_attributes', '') }
       end
 
       # The action to be used in lookup.

data/lib/simple_form/version.rb

@@ -1,3 +1,3 @@
 module SimpleForm
-  VERSION = "1.4.0".freeze
+  VERSION = "1.4.2".freeze
 end

data/simple_form.gemspec

@@ -19,4 +19,7 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   s.rubyforge_project = "simple_form"
+
+  s.add_dependency('activemodel', '~> 3.0')
+  s.add_dependency('actionpack', '~> 3.0')
 end

data/test/action_view_extensions/form_helper_test.rb

@@ -25,6 +25,18 @@ class FormHelperTest < ActionView::TestCase
     end
   end
 
+  test 'a form specific disabled validation option should override the default enabled browser validation configuration option' do
+    concat(simple_form_for(:user, :html => { :novalidate => true }) do |f| end)
+    assert_select 'form[novalidate="novalidate"]'
+  end
+
+  test 'a form specific enabled validation option should override the disabled browser validation configuration option' do
+    swap SimpleForm, :browser_validations => false do
+      concat(simple_form_for(:user, :html => { :novalidate => false }) do |f| end)
+      assert_no_select 'form[novalidate]'
+    end
+  end
+
   test 'simple form should add object name as css class to form when object is not present' do
     concat(simple_form_for(:user) do |f| end)
     assert_select 'form.simple_form.user'

data/test/components/label_test.rb

@@ -133,6 +133,25 @@ class LabelTest < ActionView::TestCase
     end
   end
 
+  test 'label should do correct i18n lookup for nested has_many models with no nested translation' do
+    @user.tags = [Tag.new(1, 'Empresa')]
+
+    store_translations(:en, :simple_form => { :labels => {
+      :user => { :name => 'Usuario' },
+      :tags => { :name => 'Nome da empresa' }
+    } } ) do
+      with_concat_form_for @user do |f|
+        concat f.input :name
+        concat(f.simple_fields_for(:tags, :child_index => "new_index") do |tags_form|
+          concat(tags_form.input :name)
+        end)
+      end
+
+      assert_select 'label[for=user_name]', /Usuario/
+      assert_select 'label[for=user_tags_attributes_new_index_name]', /Nome da empresa/
+    end
+  end
+
   test 'label should have css class from type' do
     with_label_for @user, :name, :string
     assert_select 'label.string'

data/test/form_builder_test.rb

@@ -52,7 +52,7 @@ class FormBuilderTest < ActionView::TestCase
   end
 
   # All
-  test 'nested simple fields should yields an instance of FormBuilder' do
+  test 'nested simple fields should yield an instance of FormBuilder' do
     simple_form_for :user do |f|
       f.simple_fields_for :posts do |posts_form|
         assert posts_form.instance_of?(SimpleForm::FormBuilder)
@@ -90,7 +90,7 @@ class FormBuilderTest < ActionView::TestCase
     end
   end
 
-  test 'builder uses the first matching custom input map when more than one match' do
+  test 'builder uses the first matching custom input map when more than one matches' do
     swap SimpleForm, :input_mappings => { /count$/ => :integer, /^post_/ => :password } do
       with_form_for @user, :post_count
       assert_no_select 'form input#user_post_count.password'
@@ -338,6 +338,20 @@ class FormBuilderTest < ActionView::TestCase
     assert_select 'input.optional#user_name'
   end
 
+  test 'builder input should not be required when ActiveModel::Validations is included and if option is present' do
+    with_form_for @validating_user, :age
+    assert_no_select 'input.required'
+    assert_no_select 'input[required]'
+    assert_select 'input.optional#validating_user_age'
+  end
+
+  test 'builder input should not be required when ActiveModel::Validations is included and unless option is present' do
+    with_form_for @validating_user, :amount
+    assert_no_select 'input.required'
+    assert_no_select 'input[required]'
+    assert_select 'input.optional#validating_user_amount'
+  end
+
   # WRAPPERS
   test 'builder support wrapping around an specific tag' do
     swap SimpleForm, :wrapper_tag => :p do
@@ -420,6 +434,17 @@ class FormBuilderTest < ActionView::TestCase
     assert_no_select 'input.integer[as]'
   end
 
+  test 'builder collection input_field should generate input tag with a clean HTML' do
+    with_concat_form_for(@user) do |f|
+      f.input_field :status, :collection => ['Open', 'Closed'], :class => 'status', :label_method => :to_s, :value_method => :to_s
+    end
+
+    assert_no_select 'select.status[input_html]'
+    assert_no_select 'select.status[collection]'
+    assert_no_select 'select.status[label_method]'
+    assert_no_select 'select.status[value_method]'
+  end
+
   # WITHOUT OBJECT
   test 'builder should generate properly when object is not present' do
     with_form_for :project, :name
@@ -456,6 +481,14 @@ class FormBuilderTest < ActionView::TestCase
     assert_no_select 'span.error[error_html]'
   end
 
+  test 'builder should generate an error tag with a clean HTML when errors options are present' do
+    with_error_for @user, :name, :error_tag => :p, :error_prefix => 'Name', :error_method => :first
+    assert_no_select 'p.error[error_html]'
+    assert_no_select 'p.error[error_tag]'
+    assert_no_select 'p.error[error_prefix]'
+    assert_no_select 'p.error[error_method]'
+  end
+
   test 'builder should allow passing options to error tag' do
     with_error_for @user, :name, :id => 'name_error'
     assert_select 'span.error#name_error', "can't be blank"
@@ -501,6 +534,13 @@ class FormBuilderTest < ActionView::TestCase
     assert_no_select 'span.hint[hint_html]'
   end
 
+  test 'builder should generate a hint componet tag with a clean HTML when hint_tag option is present' do
+    with_hint_for @user, 'Hello World!', :hint_tag => :p
+    assert_no_select 'p.hint[hint]'
+    assert_no_select 'p.hint[hint_html]'
+    assert_no_select 'p.hint[hint_tag]'
+  end
+
   test 'builder should allow passing options to hint tag' do
     with_hint_for @user, :name, :hint => 'Hello World!', :id => 'name_hint'
     assert_select 'span.hint#name_hint', 'Hello World!'
@@ -559,7 +599,7 @@ class FormBuilderTest < ActionView::TestCase
     end
   end
 
-  test 'builder association with a block call simple_fields_for' do
+  test 'builder association with a block calls simple_fields_for' do
     simple_form_for @user do |f|
       f.association :posts do |posts_form|
         assert posts_form.instance_of?(SimpleForm::FormBuilder)
@@ -578,7 +618,7 @@ class FormBuilderTest < ActionView::TestCase
     assert_equal 3, calls
   end
 
-  test 'builder association mark input as required based both association and attribute' do
+  test 'builder association marks input as required based on both association and attribute' do
     swap SimpleForm, :required_by_default => false do
       with_association_for @validating_user, :company, :collection => []
       assert_select 'label.required'
@@ -595,7 +635,7 @@ class FormBuilderTest < ActionView::TestCase
     assert_select 'form select option[value=3]', 'Tag 3'
   end
 
-  test 'builder does not preload collection association if preload false' do
+  test 'builder does not preload collection association if preload is false' do
     value = @user.company
     value.expects(:to_a).never
     with_association_for @user, :company, :preload => false
@@ -605,7 +645,7 @@ class FormBuilderTest < ActionView::TestCase
     assert_select 'form select option[value=3]', 'Company 3'
   end
 
-  test 'builder does not preload non collection association' do
+  test 'builder does not preload non-collection association' do
     value = @user.company
     value.expects(:to_a).never
     with_association_for @user, :company, :preload => false

data/test/inputs_test.rb

@@ -780,6 +780,14 @@ class InputTest < ActionView::TestCase
     end
   end
 
+  test 'when not using browser validations, input should not generate required html attribute' do
+    swap SimpleForm, :browser_validations => false do
+      with_input_for @user, :name, :string
+      assert_select 'input[type=text].required'
+      assert_no_select 'input[type=text][required]'
+    end
+  end
+
   test 'collection input with select type should not generate invalid required html attribute' do
     with_input_for @user, :name, :select, :collection => ['Jose' , 'Carlos']
     assert_select 'select.required'

data/test/support/mock_controller.rb

@@ -12,4 +12,13 @@ class MockController
   def url_for(*args)
     "http://example.com"
   end
+
+  def url_helpers
+    self
+  end
+
+  def hash_for_user_path(*args); end
+  def hash_for_validating_user_path(*args); end
+  def hash_for_other_validating_user_path(*args); end
+  def hash_for_users_path(*args); end
 end

data/test/support/models.rb

@@ -61,6 +61,9 @@ class User
   def company_attributes=(*)
   end
 
+  def tags_attributes=(*)
+  end
+
   def column_for_attribute(attribute)
     column_type, limit = case attribute.to_sym
       when :name, :status, :password then [:string, 100]
@@ -124,6 +127,8 @@ class ValidatingUser < User
   include ActiveModel::Validations
   validates :name, :presence => true
   validates :company, :presence => true
+  validates :age, :presence => true, :if => Proc.new { |user| user.name }
+  validates :amount, :presence => true, :unless => Proc.new { |user| user.age }
   validates_numericality_of :age,
     :greater_than_or_equal_to => 18,
     :less_than_or_equal_to => 99,

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: simple_form
 version: !ruby/object:Gem::Version 
-  hash: 7
+  hash: 3
   prerelease: 
   segments: 
   - 1
   - 4
-  - 0
-  version: 1.4.0
+  - 2
+  version: 1.4.2
 platform: ruby
 authors: 
 - "Jos\xC3\xA9 Valim"
@@ -16,10 +16,39 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-18 00:00:00 -03:00
+date: 2011-06-27 00:00:00 -03:00
 default_executable: 
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activemodel
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        version: "3.0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: actionpack
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        version: "3.0"
+  type: :runtime
+  version_requirements: *id002
 description: Forms made easy!
 email: contact@plataformatec.com.br
 executables: []
@@ -120,7 +149,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: simple_form
-rubygems_version: 1.6.2
+rubygems_version: 1.5.3
 signing_key: 
 specification_version: 3
 summary: Forms made easy!