simple_form 3.1.0.rc1 → 3.1.0.rc2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b8f1158908d7180ea273c9c3f411d61d58297825
-  data.tar.gz: 33db5d3272ef17c15ad7390b432dcc3b390ae484
+  metadata.gz: 88d85494e222c13d302bed66c947ebc999702a46
+  data.tar.gz: 6974cf74dc9cada33d515c0125c4506262aa4118
 SHA512:
-  metadata.gz: 9ccf6e4cd2f1c171d4acf02861c78b54ec05bdf3161f2ed32442fe6cc814538ca991b7e5bc0748aa3b3dedfac9a14fd31feed025a95cb48623038463585d2a8e
-  data.tar.gz: df77813f38fe1e70c73be0cc41b88a065030c6d2c998586273e550984d3b342f6604e87acc8e5ef19343c26fb6d87d5ac13a0b84d9d63806aa5e52b8052f0bd1
+  metadata.gz: c2f1599b149fd691ccc0471af01e5f2f997465f55449bfea0924768c45f83510d36911342e54e8c42dfa75adf5da278261188f17c938b3571446b97c419e2011
+  data.tar.gz: 4c1677e4c36aa1381a378ef3a2c688db1881089d014cb97078f14dd2f5000a618fddc9671f78663fd693c86e4bc8524f3f2c9837aa5e8f7707c9b07b223cf114

data/CHANGELOG.md

@@ -1,6 +1,9 @@
-## 3.1.0.rc1
+## 3.1.0.rc2
 
 ### enhancements
+  * Add mapping to `uuid` columns.
+  * Add custom namespaces for custom inputs feature. [@vala](https://github.com/vala)
+  * Add `:unless_blank` option to the wrapper API. [@IanVaughan](https://github.com/IanVaughan)
   * Add support to html markup in the I18n options. [@laurocaetano](https://github.com/laurocaetano)
   * Add the `full_error` component. [@laurocaetano](https://github.com/laurocaetano)
   * Add support to `scope` to be used on associations. [@laurocaetano](https://github.com/laurocaetano)

data/README.md

@@ -259,7 +259,7 @@ end
 ```
 
 For check boxes and radio buttons you can remove the label changing `boolean_style` from default value `:nested` to `:inline`.
-Also, `item_wrap_tag` will not work when `boolean_style` is set to `:nested`.
+Also, `item_wrapper_tag` will not work when `boolean_style` is set to `:nested`.
 
 Example:
 
@@ -521,6 +521,7 @@ specifying the helper method in the column `Mapping` as the `as:` option.
      `tel`           | `input[type=tel]`                    | `string` with `name =~ /phone/`
      `password`      | `input[type=password]`               | `string` with `name =~ /password/`
      `search`        | `input[type=search]`                 | -
+     `uuid`          | `input[type=text]`                   | `uuid`
      `text`          | `textarea`                           | `text`
      `file`          | `input[type=file]`                   | `string` responding to file methods
      `hidden`        | `input[type=hidden]`                 | -
@@ -581,6 +582,28 @@ class CollectionSelectInput < SimpleForm::Inputs::CollectionSelectInput
 end
 ```
 
+If needed, you can namespace your custom inputs in a module and tell **Simple Form** to look for
+their definitions in this module. This can avoid conflicts with other form libraries (like Formtastic) that look up
+the global context to find inputs definition too.
+
+```ruby
+# app/inputs/custom_inputs/numeric_input
+module CustomInputs
+  class NumericInput < SimpleForm::Inputs::NumericInput
+    def input_html_classes
+      super.push('no-spinner')
+    end
+  end
+end
+```
+
+And in the **SimpleForm** initializer :
+
+```ruby
+# config/simple_form.rb
+config.custom_inputs_namespaces << "CustomInputs"
+```
+
 ## Custom form builder
 
 You can create a custom form builder that uses **Simple Form**.
@@ -599,8 +622,7 @@ Create a form builder class that inherits from `SimpleForm::FormBuilder`.
 ```ruby
 class CustomFormBuilder < SimpleForm::FormBuilder
   def input(attribute_name, options = {}, &block)
-    options[:input_html].merge! class: 'custom'
-    super
+    super(attribute_name, options.merge(label: false), &block)
   end
 end
 ```
@@ -629,8 +651,8 @@ en:
       user:
         age: 'Rather not say'
     prompts:
-      gender:
-        age: 'Select your gender'
+      user:
+        gender: 'Select your gender'
 ```
 
 And your forms will use this information to render the components for you.
@@ -896,6 +918,15 @@ end
 By setting it as `optional`, a hint will only be generated when `hint: true` is explicitly used.
 The same for placeholder.
 
+It is also possible to give the option `:unless_blank` to the wrapper if you want to render it only
+when the content is present.
+
+```ruby
+  b.wrapper tag: :span, class: 'hint', unless_blank: true do |component|
+    component.optional :hint
+  end
+```
+
 ## HTML 5 Notice
 
 By default, **Simple Form** will generate input field types and attributes that are supported in HTML5,
@@ -985,7 +1016,7 @@ https://github.com/plataformatec/simple_form/issues
 [![Gem Version](https://fury-badge.herokuapp.com/rb/simple_form.png)](http://badge.fury.io/rb/simple_form)
 [![Build Status](https://api.travis-ci.org/plataformatec/simple_form.svg?branch=master)](http://travis-ci.org/plataformatec/simple_form)
 [![Code Climate](https://codeclimate.com/github/plataformatec/simple_form.png)](https://codeclimate.com/github/plataformatec/simple_form)
-[![Inline docs](http://inch-pages.github.io/github/plataformatec/simple_form.png)](http://inch-pages.github.io/github/plataformatec/simple_form)
+[![Inline docs](http://inch-ci.org/github/plataformatec/simple_form.png)](http://inch-ci.org/github/plataformatec/simple_form)
 
 ## License
 

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

@@ -22,9 +22,9 @@ SimpleForm.setup do |config|
     b.use :placeholder
 
     ## Optional extensions
-    # They are disabled unless you pass `f.input EXTENSION_NAME => :lookup`
+    # They are disabled unless you pass `f.input EXTENSION_NAME => true`
     # to the input. If so, they will retrieve the values from the model
-    # if any exists. If you want to enable the lookup for any of those
+    # if any exists. If you want to enable any of those
     # extensions by default, you can change `b.optional` to `b.use`.
 
     # Calculates maxlength from length validations for string inputs
@@ -131,6 +131,10 @@ SimpleForm.setup do |config|
   # type as key and the wrapper that will be used for all inputs with specified type.
   # config.wrapper_mappings = { string: :prepend }
 
+  # Namespaces where SimpleForm should look for custom input classes that
+  # override default inputs.
+  # config.custom_inputs_namespaces << "CustomInputs"
+
   # Default priority for time_zone inputs.
   # config.time_zone_priority = nil
 

data/lib/generators/simple_form/templates/config/initializers/simple_form_bootstrap.rb

@@ -1,35 +1,38 @@
 # Use this setup block to configure all options available in SimpleForm.
 SimpleForm.setup do |config|
+  config.error_notification_class = 'alert alert-danger'
   config.button_class = 'btn btn-default'
   config.boolean_label_class = nil
 
   config.wrappers :vertical_form, tag: 'div', class: 'form-group', error_class: 'has-error' do |b|
     b.use :html5
     b.use :placeholder
+    b.optional :maxlength
+    b.optional :pattern
+    b.optional :min_max
+    b.optional :readonly
     b.use :label, class: 'control-label'
 
-    b.wrapper tag: 'div' do |ba|
-      ba.use :input, class: 'form-control'
-      ba.use :error, wrap_with: { tag: 'span', class: 'help-block' }
-      ba.use :hint,  wrap_with: { tag: 'p', class: 'help-block' }
-    end
+    b.use :input, class: 'form-control'
+    b.use :error, wrap_with: { tag: 'span', class: 'help-block' }
+    b.use :hint,  wrap_with: { tag: 'p', class: 'help-block' }
   end
 
   config.wrappers :vertical_file_input, tag: 'div', class: 'form-group', error_class: 'has-error' do |b|
     b.use :html5
     b.use :placeholder
+    b.optional :maxlength
+    b.optional :readonly
     b.use :label, class: 'control-label'
 
-    b.wrapper tag: 'div' do |ba|
-      ba.use :input
-      ba.use :error, wrap_with: { tag: 'span', class: 'help-block' }
-      ba.use :hint,  wrap_with: { tag: 'p', class: 'help-block' }
-    end
+    b.use :input
+    b.use :error, wrap_with: { tag: 'span', class: 'help-block' }
+    b.use :hint,  wrap_with: { tag: 'p', class: 'help-block' }
   end
 
   config.wrappers :vertical_boolean, tag: 'div', class: 'form-group', error_class: 'has-error' do |b|
     b.use :html5
-    b.use :placeholder
+    b.optional :readonly
 
     b.wrapper tag: 'div', class: 'checkbox' do |ba|
       ba.use :label_input
@@ -41,7 +44,7 @@ SimpleForm.setup do |config|
 
   config.wrappers :vertical_radio_and_checkboxes, tag: 'div', class: 'form-group', error_class: 'has-error' do |b|
     b.use :html5
-    b.use :placeholder
+    b.optional :readonly
     b.use :label_input
     b.use :error, wrap_with: { tag: 'span', class: 'help-block' }
     b.use :hint,  wrap_with: { tag: 'p', class: 'help-block' }
@@ -50,6 +53,10 @@ SimpleForm.setup do |config|
   config.wrappers :horizontal_form, tag: 'div', class: 'form-group', error_class: 'has-error' do |b|
     b.use :html5
     b.use :placeholder
+    b.optional :maxlength
+    b.optional :pattern
+    b.optional :min_max
+    b.optional :readonly
     b.use :label, class: 'col-sm-3 control-label'
 
     b.wrapper tag: 'div', class: 'col-sm-9' do |ba|
@@ -62,6 +69,8 @@ SimpleForm.setup do |config|
   config.wrappers :horizontal_file_input, tag: 'div', class: 'form-group', error_class: 'has-error' do |b|
     b.use :html5
     b.use :placeholder
+    b.optional :maxlength
+    b.optional :readonly
     b.use :label, class: 'col-sm-3 control-label'
 
     b.wrapper tag: 'div', class: 'col-sm-9' do |ba|
@@ -73,7 +82,7 @@ SimpleForm.setup do |config|
 
   config.wrappers :horizontal_boolean, tag: 'div', class: 'form-group', error_class: 'has-error' do |b|
     b.use :html5
-    b.use :placeholder
+    b.optional :readonly
 
     b.wrapper tag: 'div', class: 'col-sm-offset-3 col-sm-9' do |wr|
       wr.wrapper tag: 'div', class: 'checkbox' do |ba|
@@ -87,7 +96,7 @@ SimpleForm.setup do |config|
 
   config.wrappers :horizontal_radio_and_checkboxes, tag: 'div', class: 'form-group', error_class: 'has-error' do |b|
     b.use :html5
-    b.use :placeholder
+    b.optional :readonly
 
     b.use :label, class: 'col-sm-3 control-label'
 
@@ -98,6 +107,20 @@ SimpleForm.setup do |config|
     end
   end
 
+  config.wrappers :inline_form, tag: 'div', class: 'form-group', error_class: 'has-error' do |b|
+    b.use :html5
+    b.use :placeholder
+    b.optional :maxlength
+    b.optional :pattern
+    b.optional :min_max
+    b.optional :readonly
+    b.use :label, class: 'sr-only'
+
+    b.use :input, class: 'form-control'
+    b.use :error, wrap_with: { tag: 'span', class: 'help-block' }
+    b.use :hint,  wrap_with: { tag: 'p', class: 'help-block' }
+  end
+
   # Wrappers for forms and inputs using the Bootstrap toolkit.
   # Check the Bootstrap docs (http://getbootstrap.com)
   # to learn about the different styles for forms and inputs,

data/lib/simple_form.rb

@@ -130,6 +130,14 @@ See https://github.com/plataformatec/simple_form/pull/997 for more information.
   mattr_accessor :wrapper_mappings
   @@wrapper_mappings = nil
 
+  # Namespaces where SimpleForm should look for custom input classes that override
+  # default inputs. Namespaces are given as string to allow lazy loading inputs.
+  # e.g. config.custom_inputs_namespaces << "CustomInputs"
+  #      will try to find CustomInputs::NumericInput when an :integer
+  #      field is called.
+  mattr_accessor :custom_inputs_namespaces
+  @@custom_inputs_namespaces = []
+
   # Default priority for time_zone inputs.
   mattr_accessor :time_zone_priority
   @@time_zone_priority = nil

data/lib/simple_form/components/labels.rb

@@ -31,7 +31,7 @@ module SimpleForm
         end
       end
 
-      def label_text
+      def label_text(wrapper_options = nil)
         label_text = options[:label_text] || SimpleForm.label_text
         label_text.call(html_escape(raw_label_text), required_label_text, options[:label].present?).strip.html_safe
       end

data/lib/simple_form/form_builder.rb

@@ -17,19 +17,19 @@ module SimpleForm
     extend MapType
     include SimpleForm::Inputs
 
-    map_type :text,                                to: SimpleForm::Inputs::TextInput
-    map_type :file,                                to: SimpleForm::Inputs::FileInput
-    map_type :string, :email, :search, :tel, :url, to: SimpleForm::Inputs::StringInput
-    map_type :password,                            to: SimpleForm::Inputs::PasswordInput
-    map_type :integer, :decimal, :float,           to: SimpleForm::Inputs::NumericInput
-    map_type :range,                               to: SimpleForm::Inputs::RangeInput
-    map_type :check_boxes,                         to: SimpleForm::Inputs::CollectionCheckBoxesInput
-    map_type :radio_buttons,                       to: SimpleForm::Inputs::CollectionRadioButtonsInput
-    map_type :select,                              to: SimpleForm::Inputs::CollectionSelectInput
-    map_type :grouped_select,                      to: SimpleForm::Inputs::GroupedCollectionSelectInput
-    map_type :date, :time, :datetime,              to: SimpleForm::Inputs::DateTimeInput
-    map_type :country, :time_zone,                 to: SimpleForm::Inputs::PriorityInput
-    map_type :boolean,                             to: SimpleForm::Inputs::BooleanInput
+    map_type :text,                                       to: SimpleForm::Inputs::TextInput
+    map_type :file,                                       to: SimpleForm::Inputs::FileInput
+    map_type :string, :email, :search, :tel, :url, :uuid, to: SimpleForm::Inputs::StringInput
+    map_type :password,                                   to: SimpleForm::Inputs::PasswordInput
+    map_type :integer, :decimal, :float,                  to: SimpleForm::Inputs::NumericInput
+    map_type :range,                                      to: SimpleForm::Inputs::RangeInput
+    map_type :check_boxes,                                to: SimpleForm::Inputs::CollectionCheckBoxesInput
+    map_type :radio_buttons,                              to: SimpleForm::Inputs::CollectionRadioButtonsInput
+    map_type :select,                                     to: SimpleForm::Inputs::CollectionSelectInput
+    map_type :grouped_select,                             to: SimpleForm::Inputs::GroupedCollectionSelectInput
+    map_type :date, :time, :datetime,                     to: SimpleForm::Inputs::DateTimeInput
+    map_type :country, :time_zone,                        to: SimpleForm::Inputs::PriorityInput
+    map_type :boolean,                                    to: SimpleForm::Inputs::BooleanInput
 
     def self.discovery_cache
       @discovery_cache ||= {}
@@ -566,7 +566,9 @@ module SimpleForm
           mapping_override(mapping) || mapping
         else
           camelized = "#{input_type.to_s.camelize}Input"
-          attempt_mapping(camelized, Object) || attempt_mapping(camelized, self.class) ||
+          attempt_mapping_with_custom_namespace(camelized) ||
+            attempt_mapping(camelized, Object) ||
+            attempt_mapping(camelized, self.class) ||
             raise("No input found for #{input_type}")
         end
     end
@@ -604,7 +606,9 @@ module SimpleForm
     def mapping_override(klass)
       name = klass.name
       if name =~ /^SimpleForm::Inputs/
-        attempt_mapping name.split("::").last, Object
+        input_name = name.split("::").last
+        attempt_mapping_with_custom_namespace(input_name) ||
+          attempt_mapping(input_name, Object)
       end
     end
 
@@ -617,5 +621,15 @@ module SimpleForm
         raise if e.message !~ /#{mapping}$/
       end
     end
+
+    def attempt_mapping_with_custom_namespace(input_name)
+      SimpleForm.custom_inputs_namespaces.each do |namespace|
+        if (mapping = attempt_mapping(input_name, namespace.constantize))
+          return mapping
+        end
+      end
+
+      nil
+    end
   end
 end

data/lib/simple_form/inputs/boolean_input.rb

@@ -16,7 +16,7 @@ module SimpleForm
       end
 
       def label_input(wrapper_options = nil)
-        if options[:label] == false
+        if options[:label] == false || inline_label?
           input(wrapper_options)
         elsif nested_boolean_style?
           html_options = label_html_options.dup
@@ -61,13 +61,16 @@ module SimpleForm
         @builder.hidden_field(attribute_name, options)
       end
 
+      def inline_label?
+        nested_boolean_style? && options[:inline_label]
+      end
+
       def inline_label
         inline_option = options[:inline_label]
 
         if inline_option
-          label = inline_option == true ? " #{label_text}" : " #{html_escape(inline_option)}"
-
-          label.html_safe
+          label = inline_option == true ? label_text : html_escape(inline_option)
+          " #{label}".html_safe
         end
       end
 

data/lib/simple_form/tags.rb

@@ -19,6 +19,7 @@ module SimpleForm
             label_options = {}
             add_default_name_and_id_for_value(value, label_options)
             label_options['for'] = label_options.delete('id')
+            label_options['class'] = @options[:item_label_class]
             rendered_item = content_tag(:label, rendered_item, label_options)
           end
 

data/lib/simple_form/version.rb

@@ -1,3 +1,3 @@
 module SimpleForm
-  VERSION = "3.1.0.rc1".freeze
+  VERSION = "3.1.0.rc2".freeze
 end

data/lib/simple_form/wrappers/builder.rb

@@ -45,7 +45,7 @@ module SimpleForm
         @components = []
       end
 
-      def use(name, options = {}, &block)
+      def use(name, options = {})
         if options && wrapper = options[:wrap_with]
           @components << Single.new(name, wrapper, options.except(:wrap_with))
         else
@@ -55,7 +55,7 @@ module SimpleForm
 
       def optional(name, options = {}, &block)
         @options[name] = false
-        use(name, options, &block)
+        use(name, options)
       end
 
       def wrapper(name, options = nil)

data/lib/simple_form/wrappers/many.rb

@@ -50,6 +50,7 @@ module SimpleForm
 
       def wrap(input, options, content)
         return content if options[namespace] == false
+        return if defaults[:unless_blank] && content.empty?
 
         tag = (namespace && options[:"#{namespace}_tag"]) || @defaults[:tag]
         return content unless tag

data/test/action_view_extensions/builder_test.rb

@@ -42,7 +42,7 @@ class BuilderTest < ActionView::TestCase
     assert_select 'form label.collection_radio_buttons[for=user_active_no]', 'No'
   end
 
-  test "collection radio should sanitize collection values for labels correctly" do
+  test "collection radio sanitizes collection values for labels correctly" do
     with_collection_radio_buttons @user, :name, ['$0.99', '$1.99'], :to_s, :to_s
     assert_select 'label.collection_radio_buttons[for=user_name_099]', '$0.99'
     assert_select 'label.collection_radio_buttons[for=user_name_199]', '$1.99'
@@ -289,7 +289,7 @@ class BuilderTest < ActionView::TestCase
     assert_select 'form label.collection_check_boxes[for=user_active_no]', 'No'
   end
 
-  test "collection check box should sanitize collection values for labels correctly" do
+  test "collection check box sanitizes collection values for labels correctly" do
     with_collection_check_boxes @user, :name, ['$0.99', '$1.99'], :to_s, :to_s
     assert_select 'label.collection_check_boxes[for=user_name_099]', '$0.99'
     assert_select 'label.collection_check_boxes[for=user_name_199]', '$1.99'
@@ -593,7 +593,7 @@ class BuilderTest < ActionView::TestCase
     end
   end
 
-  test "fields inherites wrapper option from the parent form" do
+  test "fields inherits wrapper option from the parent form" do
     swap_wrapper :another do
       simple_form_for(:user, wrapper: :another) do |f|
         f.simple_fields_for(:company) do |company|