bootstrap_form 2.2.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8742255adf9a08c30983097065574da44048f88e
-  data.tar.gz: 3b301bdd5e3c144a89151bb8b8f7eafb7a3a31e3
+  metadata.gz: 319bdcb130ea16ed9c69b8765dacf04e1666a35c
+  data.tar.gz: ce99ec8cf9fd4235eb9bde58e3f88a44df5da0b1
 SHA512:
-  metadata.gz: 22c55ab50ba7ca0e6e7e9c5cd836d2461817d7a97036d87d13d52aa1cb62148d5e163fd1c68ca88806b76dd927cd30e1528dcbad8fbca8e502b9de1306875870
-  data.tar.gz: 2400158a438d1aed212116ccc6dc4c983b3ba0f8e5e02d0125e9971d747fafda44a38af10e2d6a9284eb4cb78bdab6d25330bccb62381c5e52820d1625a3f193
+  metadata.gz: 0a44aad58c31502e3cdd179b254ea3b705798223beae55fb996aeb1b84ec42beb85116ee01da593b34a0373c6f6246ed1f0137af964162f15570efb21c281076
+  data.tar.gz: ff91c59ec997473c5cf8ecb14d25ae4cc5a45c6406130bff044f3b1a72ea12880ca81e313636a4fc447df82adc3b2a3c15cc590cbce0fa2879184e3ad68d7412

data/README.md

@@ -115,7 +115,7 @@ This gem wraps the following Rails form helpers:
 * time_zone_select
 * url_field
 * week_field
- 
+
 These helpers accept the same options as the standard Rails form helpers, with
 a few extra options:
 
@@ -134,6 +134,30 @@ class, which keeps your labels accessible to those using screen readers.
 <%= f.text_area :comment, hide_label: :true, placeholder: "Leave a comment..." %>
 ```
 
+To add custom classes to the field's label:
+
+```erb
+<%= f.text_field :email, label_class: "custom-class" %>
+```
+
+#### Required Fields
+
+A label that is associated with a required field is automatically annotated with
+a `required` CSS class. You are free to add any appropriate CSS to style 
+required fields as desired.  One example would be to automatically add an
+asterisk to the end of the label:
+
+```css
+label.required:after {
+  content:" *";
+}
+```
+
+The label `required` class is determined based on the definition of a presence
+validator with the associated model attribute. Presently this is one of:
+ActiveRecord::Validations::PresenceValidator or
+ActiveModel::Validations::PresenceValidator.
+
 ### Help Text
 
 To add help text, use the `help` option:
@@ -152,6 +176,9 @@ en:
         password: "A good password should be at least six characters long"
 ```
 
+If your model name has multiple words (like `SuperUser`), the key on the
+translation file should be underscored (`super_user`).
+
 You can override help translations for a particular field by passing the `help`
 option or turn them off completely by passing `help: false`.
 
@@ -257,7 +284,7 @@ To display checkboxes and radios inline, pass the `inline: true` option:
 
 #### Collections
 
-BootstrapForms also provideshelpers that automatically creates the
+BootstrapForms also provides helpers that automatically creates the
 `form_group` and the `radio_button`s or `check_box`es for you:
 
 ```erb
@@ -316,7 +343,7 @@ buttons.
 ```
 
 You can also use the `primary` helper, which adds `btn btn-primary` to your
-submit button **(master branch only)**:
+submit button:
 
 ```erb
 <%= f.primary "Optional Label" %>
@@ -357,6 +384,12 @@ using screen readers.
 <% end %>
 ```
 
+To skip label rendering at all, use `skip_label: true` option.
+
+```erb
+<%= f.password_field :password, skip_label: true %>
+```
+
 ### Horizontal Forms
 
 To use a horizontal-layout form with labels to the left of the control, use the
@@ -393,7 +426,7 @@ The `label_col` and `control_col` css classes can also be changed per control:
 
 ### Custom Field Layout
 
-The `layout` can be overriden per field:
+The `layout` can be overridden per field:
 
 ```erb
 <%= bootstrap_form_for(@user, layout: :horizontal) do |f| %>
@@ -430,6 +463,26 @@ You can turn off inline errors for the entire form like this:
 <% end %>
 ```
 
+### Label Errors
+
+You can also display validation errors in the field's label; just turn
+on the `:label_errors` option. Here's an example:
+
+```
+<%= bootstrap_form_for(@user, label_errors: true) do |f| %>
+  ...
+<% end %>
+```
+
+By default, turning on `:label_errors` will also turn off
+`:inline_errors`. If you want both turned on, you can do that too:
+
+```
+<%= bootstrap_form_for(@user, label_errors: true, inline_errors: true) do |f| %>
+  ...
+<% end %>
+```
+
 ### Alert Messages
 
 To display an error message with an error summary, you can use the
@@ -515,8 +568,10 @@ We love pull requests! Here's a quick guide for contributing:
 
 2. Run the existing test suite:
 
-  `$ cd test/dummy && bundle exec rake db:create db:migrate RAILS_ENV=test && cd ../../`
-  `$ bundle exec rake`
+```
+$ bundle exec rake -f test/dummy/Rakefile db:create db:migrate RAILS_ENV=test
+$ bundle exec rake
+```
 
 3. Add tests for your change.
 

data/lib/bootstrap_form/form_builder.rb

@@ -4,7 +4,7 @@ module BootstrapForm
   class FormBuilder < ActionView::Helpers::FormBuilder
     include BootstrapForm::Helpers::Bootstrap
 
-    attr_reader :layout, :label_col, :control_col, :has_error, :inline_errors, :acts_like_form_tag
+    attr_reader :layout, :label_col, :control_col, :has_error, :inline_errors, :label_errors, :acts_like_form_tag
 
     FIELD_HELPERS = %w{color_field date_field datetime_field datetime_local_field
       email_field month_field number_field password_field phone_field
@@ -19,7 +19,12 @@ module BootstrapForm
       @layout = options[:layout]
       @label_col = options[:label_col] || default_label_col
       @control_col = options[:control_col] || default_control_col
-      @inline_errors = options[:inline_errors] != false
+      @label_errors = options[:label_errors] || false
+      @inline_errors = if options[:inline_errors].nil?
+        @label_errors != true
+      else
+        options[:inline_errors] != false
+      end
       @acts_like_form_tag = options[:acts_like_form_tag]
 
       super
@@ -95,19 +100,24 @@ module BootstrapForm
 
     def check_box_with_bootstrap(name, options = {}, checked_value = "1", unchecked_value = "0", &block)
       options = options.symbolize_keys!
+      check_box_options = options.except(:label, :label_class, :help, :inline)
 
-      html = check_box_without_bootstrap(name, options.except(:label, :help, :inline), checked_value, unchecked_value)
+      html = check_box_without_bootstrap(name, check_box_options, checked_value, unchecked_value)
       label_content = block_given? ? capture(&block) : options[:label]
       html.concat(" ").concat(label_content || (object && object.class.human_attribute_name(name)) || name.to_s.humanize)
 
       label_name = name
       label_name = "#{name}_#{checked_value}" if options[:multiple]
 
+      disabled_class = " disabled" if options[:disabled]
+      label_class    = options[:label_class]
+
       if options[:inline]
-        label(label_name, html, class: "checkbox-inline")
+        label_class = " #{label_class}" if label_class
+        label(label_name, html, class: "checkbox-inline#{disabled_class}#{label_class}")
       else
-        content_tag(:div, class: "checkbox") do
-          label(label_name, html)
+        content_tag(:div, class: "checkbox#{disabled_class}") do
+          label(label_name, html, class: label_class)
         end
       end
     end
@@ -116,15 +126,19 @@ module BootstrapForm
 
     def radio_button_with_bootstrap(name, value, *args)
       options = args.extract_options!.symbolize_keys!
-      args << options.except(:label, :help, :inline)
+      args << options.except(:label, :label_class, :help, :inline)
 
       html = radio_button_without_bootstrap(name, value, *args) + " " + options[:label]
 
+      disabled_class = " disabled" if options[:disabled]
+      label_class    = options[:label_class]
+
       if options[:inline]
-        label(name, html, class: "radio-inline", value: value)
+        label_class = " #{label_class}" if label_class
+        label(name, html, class: "radio-inline#{disabled_class}#{label_class}", value: value)
       else
-        content_tag(:div, class: "radio") do
-          label(name, html, value: value)
+        content_tag(:div, class: "radio#{disabled_class}") do
+          label(name, html, value: value, class: label_class)
         end
       end
     end
@@ -164,16 +178,15 @@ module BootstrapForm
       options[:class] << " #{feedback_class}" if options[:icon]
 
       content_tag(:div, options.except(:id, :label, :help, :icon, :label_col, :control_col, :layout)) do
-        label   = generate_label(options[:id], name, options[:label], options[:label_col], options[:layout]) if options[:label]
+        label = generate_label(options[:id], name, options[:label], options[:label_col], options[:layout]) if options[:label]
         control = capture(&block).to_s
         control.concat(generate_help(name, options[:help]).to_s)
         control.concat(generate_icon(options[:icon])) if options[:icon]
 
         if get_group_layout(options[:layout]) == :horizontal
           control_class = (options[:control_col] || control_col.clone)
-
           unless options[:label]
-            control_offset = offset_col(/([0-9]+)$/.match(options[:label_col] || default_label_col))
+            control_offset = offset_col(/([0-9]+)$/.match(options[:label_col] || @label_col))
             control_class.concat(" #{control_offset}")
           end
           control = content_tag(:div, control, class: control_class)
@@ -188,6 +201,8 @@ module BootstrapForm
       fields_options[:layout] ||= options[:layout]
       fields_options[:label_col] = fields_options[:label_col].present? ? "#{fields_options[:label_col]} #{label_class}" : options[:label_col]
       fields_options[:control_col] ||= options[:control_col]
+      fields_options[:inline_errors] ||= options[:inline_errors]
+      fields_options[:label_errors] ||= options[:label_errors]
       fields_for_without_bootstrap(record_name, record_object, fields_options, &block)
     end
 
@@ -243,6 +258,24 @@ module BootstrapForm
       object.respond_to?(:errors) && !(name.nil? || object.errors[name].empty?)
     end
 
+    def required_attribute?(obj, attribute)
+
+      return false unless obj and attribute
+
+      target = (obj.class == Class) ? obj : obj.class
+      target_validators = target.validators_on(attribute).map(&:class)
+
+      has_presence_validator = target_validators.include?(
+                                 ActiveModel::Validations::PresenceValidator)
+
+      if defined? ActiveRecord::Validations::PresenceValidator
+        has_presence_validator |= target_validators.include?(
+                                    ActiveRecord::Validations::PresenceValidator)
+      end
+
+      has_presence_validator
+    end
+
     def form_group_builder(method, options, html_options = nil)
       options.symbolize_keys!
       html_options.symbolize_keys! if html_options
@@ -254,10 +287,8 @@ module BootstrapForm
 
       options = convert_form_tag_options(method, options) if acts_like_form_tag
 
-      label = options.delete(:label)
-      label_class = hide_class if options.delete(:hide_label)
-      wrapper_class = options.delete(:wrapper_class)
-      wrapper_options = options.delete(:wrapper)
+      wrapper_class = css_options.delete(:wrapper_class)
+      wrapper_options = css_options.delete(:wrapper)
       help = options.delete(:help)
       icon = options.delete(:icon)
       label_col = options.delete(:label_col)
@@ -265,10 +296,6 @@ module BootstrapForm
       layout = get_group_layout(options.delete(:layout))
       form_group_options = {
         id: options[:id],
-        label: {
-          text: label,
-          class: label_class
-        },
         help: help,
         icon: icon,
         label_col: label_col,
@@ -278,7 +305,17 @@ module BootstrapForm
       }
 
       if wrapper_options.is_a?(Hash)
-        form_group_options.reverse_merge!(wrapper_options)
+        form_group_options.merge!(wrapper_options)
+      end
+
+      unless options.delete(:skip_label)
+        label_class = hide_class if options.delete(:hide_label)
+        label_class ||= options.delete(:label_class)
+
+        form_group_options.reverse_merge!(label: {
+          text: options.delete(:label),
+          class: label_class
+        })
       end
 
       form_group(method, form_group_options) do
@@ -296,16 +333,26 @@ module BootstrapForm
       options[:for] = id if acts_like_form_tag
       classes = [options[:class], label_class]
       classes << (custom_label_col || label_col) if get_group_layout(group_layout) == :horizontal
+      classes << "required" if required_attribute?(object, name)
+
       options[:class] = classes.compact.join(" ")
 
-      label(name, options[:text], options.except(:text))
+      if label_errors && has_error?(name)
+        error_messages = get_error_messages(name)
+        label_text = (options[:text] || object.class.human_attribute_name(name)).to_s.concat(" #{error_messages}")
+        label(name, label_text, options.except(:text))
+      else
+        label(name, options[:text], options.except(:text))
+      end
+
     end
 
     def generate_help(name, help_text)
-      help_text = object.errors[name].join(", ") if has_error?(name) && inline_errors
+      help_text = get_error_messages(name) if has_error?(name) && inline_errors
       return if help_text === false
 
-      help_text ||= I18n.t(name, scope: "activerecord.help.#{object.class.to_s.downcase}", default: '')
+      help_text ||= get_help_text_by_i18n_key(name)
+
       content_tag(:span, help_text, class: 'help-block') if help_text.present?
     end
 
@@ -313,26 +360,43 @@ module BootstrapForm
       content_tag(:span, "", class: "glyphicon glyphicon-#{icon} form-control-feedback")
     end
 
+    def get_error_messages(name)
+      object.errors[name].join(", ")
+    end
+
     def inputs_collection(name, collection, value, text, options = {}, &block)
       form_group_builder(name, options) do
         inputs = ""
 
         collection.each do |obj|
-          input_options = options.merge(label: obj.send(text))
+          input_options = options.merge(label: text.respond_to?(:call) ? text.call(obj) : obj.send(text))
 
+          input_value = value.respond_to?(:call) ? value.call(obj) : obj.send(value)
           if checked = input_options[:checked]
-            input_options[:checked] = checked == obj.send(value)              ||
-                                      checked.try(:include?, obj.send(value)) ||
-                                      checked == obj                          ||
-                                      checked.try(:include?, obj)
+            input_options[:checked] = checked == input_value                     ||
+                                      Array(checked).try(:include?, input_value) ||
+                                      checked == obj                             ||
+                                      Array(checked).try(:include?, obj)
           end
 
           input_options.delete(:class)
-          inputs << block.call(name, obj.send(value), input_options)
+          inputs << block.call(name, input_value, input_options)
         end
 
         inputs.html_safe
       end
     end
+
+    def get_help_text_by_i18n_key(name)
+      underscored_scope = "activerecord.help.#{object.class.name.underscore}"
+      downcased_scope = "activerecord.help.#{object.class.name.downcase}"
+      help_text = I18n.t(name, scope: underscored_scope, default: '').presence
+      help_text ||= if text = I18n.t(name, scope: downcased_scope, default: '').presence
+        warn "I18n key '#{downcased_scope}.#{name}' is deprecated, use '#{underscored_scope}.#{name}' instead"
+        text
+      end
+
+      help_text
+    end
   end
 end

data/lib/bootstrap_form/version.rb

@@ -1,3 +1,3 @@
 module BootstrapForm
-  VERSION = "2.2.0"
+  VERSION = "2.3.0"
 end

data/test/bootstrap_checkbox_test.rb

@@ -12,6 +12,11 @@ class BootstrapCheckboxTest < ActionView::TestCase
     assert_equal expected, @builder.check_box(:terms, label: 'I agree to the terms')
   end
 
+  test "disabled check_box has proper wrapper classes" do
+    expected = %{<div class="checkbox disabled"><label for="user_terms"><input disabled="disabled" name="user[terms]" type="hidden" value="0" /><input disabled="disabled" id="user_terms" name="user[terms]" type="checkbox" value="1" /> I agree to the terms</label></div>}
+    assert_equal expected, @builder.check_box(:terms, label: 'I agree to the terms', disabled: true)
+  end
+
   test "check_box label allows html" do
     expected = %{<div class="checkbox"><label for="user_terms"><input name="user[terms]" type="hidden" value="0" /><input id="user_terms" name="user[terms]" type="checkbox" value="1" /> I agree to the <a href="#">terms</a></label></div>}
     assert_equal expected, @builder.check_box(:terms, label: %{I agree to the <a href="#">terms</a>}.html_safe)
@@ -22,6 +27,11 @@ class BootstrapCheckboxTest < ActionView::TestCase
     assert_equal expected, @builder.check_box(:terms) { "I agree to the terms" }
   end
 
+  test "check_box accepts a custom label class" do
+    expected = %{<div class="checkbox"><label class="btn" for="user_terms"><input name="user[terms]" type="hidden" value="0" /><input id="user_terms" name="user[terms]" type="checkbox" value="1" /> Terms</label></div>}
+    assert_equal expected, @builder.check_box(:terms, label_class: 'btn')
+  end
+
   test "check_box responds to checked_value and unchecked_value arguments" do
     expected = %{<div class="checkbox"><label for="user_terms"><input name="user[terms]" type="hidden" value="no" /><input id="user_terms" name="user[terms]" type="checkbox" value="yes" /> I agree to the terms</label></div>}
     assert_equal expected, @builder.check_box(:terms, {label: 'I agree to the terms'}, 'yes', 'no')
@@ -32,6 +42,16 @@ class BootstrapCheckboxTest < ActionView::TestCase
     assert_equal expected, @builder.check_box(:terms, label: 'I agree to the terms', inline: true)
   end
 
+  test "disabled inline check_box" do
+    expected = %{<label class="checkbox-inline disabled" for="user_terms"><input disabled="disabled" name="user[terms]" type="hidden" value="0" /><input disabled="disabled" id="user_terms" name="user[terms]" type="checkbox" value="1" /> I agree to the terms</label>}
+    assert_equal expected, @builder.check_box(:terms, label: 'I agree to the terms', inline: true, disabled: true)
+  end
+
+  test "inline checkboxes with custom label class" do
+    expected = %{<label class="checkbox-inline btn" for="user_terms"><input name="user[terms]" type="hidden" value="0" /><input id="user_terms" name="user[terms]" type="checkbox" value="1" /> Terms</label>}
+    assert_equal expected, @builder.check_box(:terms, inline: true, label_class: 'btn')
+  end
+
   test 'collection_check_boxes renders the form_group correctly' do
     collection = [Address.new(id: 1, street: 'Foobar')]
     expected = %{<input id="user_misc" multiple="multiple" name="user[misc][]" type="hidden" value="" /><div class="form-group"><label class="control-label" for="user_misc">This is a checkbox collection</label><div class="checkbox"><label for="user_misc_1"><input id="user_misc_1" name="user[misc][]" type="checkbox" value="1" /> Foobar</label></div><span class="help-block">With a help!</span></div>}
@@ -68,4 +88,50 @@ class BootstrapCheckboxTest < ActionView::TestCase
     assert_equal expected, @builder.collection_check_boxes(:misc, collection, :id, :street, checked: [1, 2])
     assert_equal expected, @builder.collection_check_boxes(:misc, collection, :id, :street, checked: collection)
   end
+
+  test 'collection_check_boxes renders multiple checkboxes with labels defined by Proc :text_method correctly' do
+    collection = [Address.new(id: 1, street: 'Foo'), Address.new(id: 2, street: 'Bar')]
+    expected = %{<input id="user_misc" multiple="multiple" name="user[misc][]" type="hidden" value="" /><div class="form-group"><label class="control-label" for="user_misc">Misc</label><div class="checkbox"><label for="user_misc_1"><input id="user_misc_1" name="user[misc][]" type="checkbox" value="1" /> ooF</label></div><div class="checkbox"><label for="user_misc_2"><input id="user_misc_2" name="user[misc][]" type="checkbox" value="2" /> raB</label></div></div>}
+
+    assert_equal expected, @builder.collection_check_boxes(:misc, collection, :id, Proc.new { |a| a.street.reverse })
+  end
+
+  test 'collection_check_boxes renders multiple checkboxes with values defined by Proc :value_method correctly' do
+    collection = [Address.new(id: 1, street: 'Foo'), Address.new(id: 2, street: 'Bar')]
+    expected = %{<input id="user_misc" multiple="multiple" name="user[misc][]" type="hidden" value="" /><div class="form-group"><label class="control-label" for="user_misc">Misc</label><div class="checkbox"><label for="user_misc_address_1"><input id="user_misc_address_1" name="user[misc][]" type="checkbox" value="address_1" /> Foo</label></div><div class="checkbox"><label for="user_misc_address_2"><input id="user_misc_address_2" name="user[misc][]" type="checkbox" value="address_2" /> Bar</label></div></div>}
+
+    assert_equal expected, @builder.collection_check_boxes(:misc, collection, Proc.new { |a| "address_#{a.id}" }, :street)
+  end
+
+  test 'collection_check_boxes renders multiple checkboxes with labels defined by lambda :text_method correctly' do
+    collection = [Address.new(id: 1, street: 'Foo'), Address.new(id: 2, street: 'Bar')]
+    expected = %{<input id="user_misc" multiple="multiple" name="user[misc][]" type="hidden" value="" /><div class="form-group"><label class="control-label" for="user_misc">Misc</label><div class="checkbox"><label for="user_misc_1"><input id="user_misc_1" name="user[misc][]" type="checkbox" value="1" /> ooF</label></div><div class="checkbox"><label for="user_misc_2"><input id="user_misc_2" name="user[misc][]" type="checkbox" value="2" /> raB</label></div></div>}
+
+    assert_equal expected, @builder.collection_check_boxes(:misc, collection, :id, lambda { |a| a.street.reverse })
+  end
+
+  test 'collection_check_boxes renders multiple checkboxes with values defined by lambda :value_method correctly' do
+    collection = [Address.new(id: 1, street: 'Foo'), Address.new(id: 2, street: 'Bar')]
+    expected = %{<input id="user_misc" multiple="multiple" name="user[misc][]" type="hidden" value="" /><div class="form-group"><label class="control-label" for="user_misc">Misc</label><div class="checkbox"><label for="user_misc_address_1"><input id="user_misc_address_1" name="user[misc][]" type="checkbox" value="address_1" /> Foo</label></div><div class="checkbox"><label for="user_misc_address_2"><input id="user_misc_address_2" name="user[misc][]" type="checkbox" value="address_2" /> Bar</label></div></div>}
+
+    assert_equal expected, @builder.collection_check_boxes(:misc, collection, lambda { |a| "address_#{a.id}" }, :street)
+  end
+
+  test 'collection_check_boxes renders with checked option correctly with Proc :value_method' do
+    collection = [Address.new(id: 1, street: 'Foo'), Address.new(id: 2, street: 'Bar')]
+    expected = %{<input id="user_misc" multiple="multiple" name="user[misc][]" type="hidden" value="" /><div class="form-group"><label class="control-label" for="user_misc">Misc</label><div class="checkbox"><label for="user_misc_address_1"><input checked="checked" id="user_misc_address_1" name="user[misc][]" type="checkbox" value="address_1" /> Foo</label></div><div class="checkbox"><label for="user_misc_address_2"><input id="user_misc_address_2" name="user[misc][]" type="checkbox" value="address_2" /> Bar</label></div></div>}
+
+    assert_equal expected, @builder.collection_check_boxes(:misc, collection, Proc.new { |a| "address_#{a.id}" }, :street, checked: "address_1")
+    assert_equal expected, @builder.collection_check_boxes(:misc, collection, Proc.new { |a| "address_#{a.id}" }, :street, checked: collection.first)
+  end
+
+  test 'collection_check_boxes renders with multiple checked options correctly with lambda :value_method' do
+    collection = [Address.new(id: 1, street: 'Foo'), Address.new(id: 2, street: 'Bar')]
+    expected = %{<input id="user_misc" multiple="multiple" name="user[misc][]" type="hidden" value="" /><div class="form-group"><label class="control-label" for="user_misc">Misc</label><div class="checkbox"><label for="user_misc_address_1"><input checked="checked" id="user_misc_address_1" name="user[misc][]" type="checkbox" value="address_1" /> Foo</label></div><div class="checkbox"><label for="user_misc_address_2"><input checked="checked" id="user_misc_address_2" name="user[misc][]" type="checkbox" value="address_2" /> Bar</label></div></div>}
+
+    assert_equal expected, @builder.collection_check_boxes(:misc, collection, lambda { |a| "address_#{a.id}" }, :street, checked: ["address_1", "address_2"])
+    assert_equal expected, @builder.collection_check_boxes(:misc, collection, lambda { |a| "address_#{a.id}" }, :street, checked: collection)
+  end
+
+
 end