simple_form 3.1.0 → 3.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 275599af691b7ba0bd40146940b8936b7b00bb65
-  data.tar.gz: bf12768bc9960272a7823e62276f8191a5b293d7
+  metadata.gz: 21876f0dc22464c3d3cc192c6cb1b387d87a3ffa
+  data.tar.gz: 5dca755be1ecf07cf96360b81c338333787976fb
 SHA512:
-  metadata.gz: f62bec40ad89719416a5010cd0ec3eab18a6322289cd817e732061d4b53dd01e6f749a3a1a89caabe2fa233749d9841dea374365572fa91f8dc70755382d6811
-  data.tar.gz: 82930fed0d675a74d7e226ebf39e78ebf86807ba583988959be4f633c50f76e3cbc2e2b924d243ce87e5423089610962dab3f1795eb242ce544d985d702c8f36
+  metadata.gz: fdda2693ca2da6c6b33e393b960969c46de2a1fbea4475cb412429020bb029c4ce1e6fb210e7bfeb6f7e5d19630b9b68f6f89f29eaf02cb200ecf36d22d3ff60
+  data.tar.gz: 912d804b0b3d7b832b7ddc1a1f3e1a57a88fe5ed2d9907d472bd12a3882e1b1b2442e0eae2a95dd9abaa1fa2f4cd74832f6f80ed17144162d6b528ce7d5856ee

data/CHANGELOG.md

@@ -1,3 +1,70 @@
+## Unreleased
+
+## 3.5.0
+
+* Updated gem dependency to support Rails 5.1.x.
+
+## 3.4.0
+
+* Removed Ruby 2.4.0 `Integer` unification deprecation warning.
+* Removed EOL Ruby 1.9.3 from the build matrix.
+* Added `minlength` component.
+* `boolean_label_class` can be set on a per-input basis.
+
+## 3.3.1
+
+### Bug fix
+
+* Fix support for symbols when looking up types with `ActiveModel::Type`.
+
+## 3.3.0
+
+### enhancements
+  * Add the `aria-invalid` attribute on inputs with errors.
+  * Added support for the new `ActiveModel::Type` API over Active Record's
+    column objects.
+
+### bug fix
+  * Fix `merge_wrapper_options` to correctly merge options with duplicated keys. [@herminiotorres](https://github.com/herminiotorres)
+  Closes [#1278](https://github.com/plataformatec/simple_form/issues/1278).
+
+## 3.2.1
+
+### enhancements
+  * Updated gem dependency to support Rails 5.0.x.
+
+## 3.2.0
+
+### bug fix
+  * Improve performance of input generation by disabling support for `_html` translations. This reverts the feature introduced on the 3.1.0 branch
+
+## 3.1.1
+
+### enhancements
+  * Add the `disabled_class` to the label when the input is disabled. [@rhodrid](https://github.com/rhodrid)
+
+### bug fix
+  * Make it possible to override `required` value that was previously set in the wrapper. [@nashby](https://github.com/nashby)
+
+  * `date/time/datetime` inputs now correctly generate the label `for` attribute when
+  HTML5 compatibility is explicitly enabled. [@ericsullivan](https://github.com/ericsullivan)
+
+  * The datetime, date, and time inputs now have a nice format by default on bootstrap.
+  [@ulissesalmeida](https://github.com/ulissesalmeida) [@eltonchrls](https://github.com/eltonchrls)
+
+  * Now it is possible to set custom input mappings for collections.
+
+  Example:
+
+  ```ruby
+    # On configuration:
+    config.input_mappings = { /gender$/ => :check_boxes }
+
+    # On form:
+    f.input :gender, collection: [:male, :female]
+  ```
+  [strangeworks](https://github.com/strangeworks)
+
 ## 3.1.0
 
 ### enhancements

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2009-2014 Plataformatec http://plataformatec.com.br/
+Copyright (c) 2009-2016 Plataformatec http://plataformatec.com.br/
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -32,13 +32,6 @@ Run the generator:
 rails generate simple_form:install
 ```
 
-Also, if you want to use the country select, you will need the
-[country_select gem](https://rubygems.org/gems/country_select), add it to your Gemfile:
-
-```ruby
-gem 'country_select'
-```
-
 ### Bootstrap
 
 **Simple Form** can be easily integrated to the [Bootstrap](http://getbootstrap.com/).
@@ -70,6 +63,22 @@ You will need to provide your own CSS styles for hints.
 
 Please see the [instructions on how to install Foundation in a Rails app](http://foundation.zurb.com/docs/applications.html).
 
+### Country Select
+
+If you want to use the country select, you will need the
+[country_select gem](https://rubygems.org/gems/country_select), add it to your Gemfile:
+
+```ruby
+gem 'country_select'
+```
+
+If you don't want to use the gem you can easily override this behaviour by mapping the
+country inputs to something else, with a line like this in your `simple_form.rb` initializer:
+
+```ruby
+config.input_mappings = { /country/ => :string }
+```
+
 ## Usage
 
 **Simple Form** was designed to be customized as you need to. Basically it's a stack of components that
@@ -91,12 +100,12 @@ To start using **Simple Form** you just have to use the helper it provides:
 This will generate an entire form with labels for user name and password as well, and render errors
 by default when you render the form with invalid data (after submitting for example).
 
-You can overwrite the default label by passing it to the input method. You can also add a hint or
-even a placeholder. For boolean inputs, you can add an inline label as well:
+You can overwrite the default label by passing it to the input method. You can also add a hint,
+an error, or even a placeholder. For boolean inputs, you can add an inline label as well:
 
 ```erb
 <%= simple_form_for @user do |f| %>
-  <%= f.input :username, label: 'Your username please' %>
+  <%= f.input :username, label: 'Your username please', error: 'Username is mandatory, please specify one' %>
   <%= f.input :password, hint: 'No special characters.' %>
   <%= f.input :email, placeholder: 'user@domain.com' %>
   <%= f.input :remember_me, inline_label: 'Yes, remember me' %>
@@ -104,7 +113,7 @@ even a placeholder. For boolean inputs, you can add an inline label as well:
 <% end %>
 ```
 
-In some cases you may want to disable labels, hints or error. Or you may want to configure the html
+In some cases you may want to disable labels, hints or errors. Or you may want to configure the html
 of any of them:
 
 ```erb
@@ -155,8 +164,9 @@ any html attribute to that wrapper as well using the `:wrapper_html` option, lik
 
 Required fields are marked with an * prepended to their labels.
 
-By default all inputs are required. When the form object has `presence` validations attached to its
-fields, **Simple Form** tells required and optional fields apart. For performance reasons, this
+By default all inputs are required. When the form object includes `ActiveModel::Validations`
+(which, for example, happens with Active Record models), fields are required only when there is `presence` validation.
+Otherwise, **Simple Form** will mark fields as optional. For performance reasons, this
 detection is skipped on validations that make use of conditional options, such as `:if` and `:unless`.
 
 And of course, the `required` property of any input can be overwritten as needed:
@@ -204,7 +214,7 @@ the wrapper as well:
 <% end %>
 ```
 
-**Simple Form** accepts same options as their corresponding input type helper in Rails:
+**Simple Form** inputs accept the same options as their corresponding input type helper in Rails:
 
 ```erb
 <%= simple_form_for @user do |f| %>
@@ -259,7 +269,6 @@ end
 ```
 
 For check boxes and radio buttons you can remove the label changing `boolean_style` from default value `:nested` to `:inline`.
-Also, `item_wrapper_tag` will not work when `boolean_style` is set to `:nested`.
 
 Example:
 
@@ -315,12 +324,16 @@ Collection inputs accept two other options beside collections:
 
 Those methods are useful to manipulate the given collection. Both of these options also accept
 lambda/procs in case you want to calculate the value or label in a special way eg. custom
-translation. All other options given are sent straight to the underlying helper. For example, you
-can give prompt as:
+translation. You can also define a `to_label` method on your model as **Simple Form** will search for
+and use `:to_label` as a `:label_method` first if it is found. All other options given are sent
+straight to the underlying helper. For example, you can give prompt as:
 
 ```ruby
-f.input :age, collection: 18..60, prompt: "Select your age"
+f.input :age, collection: 18..60, prompt: "Select your age", selected: 21
 ```
+Extra options are passed into helper [`collection_select`](http://api.rubyonrails.org/classes/ActionView/Helpers/FormOptionsHelper.html#method-i-collection_select).
+
+You may also find it useful to explicitly pass a value to the optional `:selected`, especially if passing a collection of nested objects.
 
 It is also possible to create grouped collection selects, that will use the html *optgroup* tags, like this:
 
@@ -404,7 +417,7 @@ The association helper just invokes `input` under the hood, so all options avail
 the collection by hand, all together with the prompt:
 
 ```ruby
-f.association :company, collection: Company.active.all(order: 'name'), prompt: "Choose a Company"
+f.association :company, collection: Company.active.order(:name), prompt: "Choose a Company"
 ```
 
 In case you want to declare different labels and values:
@@ -435,6 +448,16 @@ The button method also accepts optional parameters, that are delegated to the un
 <%= f.button :submit, "Custom Button Text", class: "my-button" %>
 ```
 
+To create a `<button>` element, use the following syntax:
+
+```erb
+<%= f.button :button, "Custom Button Text" %>
+
+<%= f.button :button do %>
+  Custom Button Text
+<% end %>
+```
+
 ### Wrapping Rails Form Helpers
 
 Say you wanted to use a rails form helper but still wrap it in **Simple Form** goodness? You can, by
@@ -660,7 +683,7 @@ en:
         age: 'Rather not say'
     prompts:
       user:
-        gender: 'Select your gender'
+        role: 'Select your role'
 ```
 
 And your forms will use this information to render the components for you.
@@ -715,16 +738,16 @@ For `:prompt` and `:include_blank` the I18n lookup is optional and to enable it
 `:translate` as value.
 
 ```ruby
-f.input :gender, prompt: :translate
+f.input :role, prompt: :translate
 ```
 
 **Simple Form** also has support for translating options in collection helpers. For instance, given a
-User with a `:gender` attribute, you might want to create a select box showing translated labels
-that would post either `male` or `female` as value. With **Simple Form** you could create an input
+User with a `:role` attribute, you might want to create a select box showing translated labels
+that would post either `:admin` or `:editor` as value. With **Simple Form** you could create an input
 like this:
 
 ```ruby
-f.input :gender, collection: [:male, :female]
+f.input :role, collection: [:admin, :editor]
 ```
 
 And **Simple Form** will try a lookup like this in your locale file, to find the right labels to show:
@@ -734,9 +757,9 @@ en:
   simple_form:
     options:
       user:
-        gender:
-          male: 'Male'
-          female: 'Female'
+        role:
+          admin: 'Administrator'
+          editor: 'Editor'
 ```
 
 You can also use the `defaults` key as you would do with labels, hints and placeholders. It is
@@ -789,6 +812,22 @@ object itself. Thus, similarly, if a form for an `Admin::User` object is defined
 `simple_form_for @admin_user, as: :some_user`, **Simple Form** will look for translations
 under `some_user` instead of `admin_user`.
 
+When translating `simple_fields_for` attributes be sure to use the same name you pass to it, e.g. `simple_fields_for :posts` should be placed under `posts` not `post`:
+
+```yaml
+en:
+  simple_form:
+    labels:
+      posts:
+        title: 'Post title'
+    hints:
+      posts:
+        title: 'A good title'
+    placeholders:
+      posts:
+        title: 'Once upon a time...'
+```
+
 ## Configuration
 
 **Simple Form** has several configuration options. You can read and change them in the initializer
@@ -947,8 +986,8 @@ required attribute to force a value into an input and will prevent form submissi
 Depending on the design of the application this may or may not be desired. In many cases it can
 break existing UI's.
 
-It is possible to disable all HTML 5 extensions in **Simple Form** removing the `html5` component
-from the wrapper used to render the inputs.
+It is possible to disable all HTML 5 extensions in **Simple Form** by removing the `html5`
+component from the wrapper used to render the inputs.
 
 For example, change:
 
@@ -1018,7 +1057,7 @@ http://rubydoc.info/github/plataformatec/simple_form/master/frames
 ### Bug reports
 
 If you discover any bugs, feel free to create an issue on GitHub. Please add as much information as
-possible to help us fixing the possible bug. We also encourage you to help even more by forking and
+possible to help us in fixing the potential bug. We also encourage you to help even more by forking and
 sending us a pull request.
 
 https://github.com/plataformatec/simple_form/issues
@@ -1037,7 +1076,7 @@ https://github.com/plataformatec/simple_form/issues
 
 ## License
 
-MIT License. Copyright 2009-2014 Plataformatec. http://plataformatec.com.br
+MIT License. Copyright 2009-2016 Plataformatec. http://plataformatec.com.br
 
 You are not granted rights or licenses to the trademarks of the Plataformatec, including without
 limitation the Simple Form name or logo.

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

@@ -28,8 +28,12 @@ SimpleForm.setup do |config|
     # extensions by default, you can change `b.optional` to `b.use`.
 
     # Calculates maxlength from length validations for string inputs
+    # and/or database column lengths
     b.optional :maxlength
 
+    # Calculate minlength from length validations for string inputs
+    b.optional :minlength
+
     # Calculates pattern from format validations for string inputs
     b.optional :pattern
 
@@ -90,8 +94,7 @@ SimpleForm.setup do |config|
   # config.collection_wrapper_class = nil
 
   # You can wrap each item in a collection of radio/check boxes with a tag,
-  # defaulting to :span. Please note that when using :boolean_style = :nested,
-  # SimpleForm will force this option to be a label.
+  # defaulting to :span.
   # config.item_wrapper_tag = :span
 
   # You can define a class to use in all item wrappers. Defaulting to none.

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

@@ -8,6 +8,7 @@ SimpleForm.setup do |config|
     b.use :html5
     b.use :placeholder
     b.optional :maxlength
+    b.optional :minlength
     b.optional :pattern
     b.optional :min_max
     b.optional :readonly
@@ -22,6 +23,7 @@ SimpleForm.setup do |config|
     b.use :html5
     b.use :placeholder
     b.optional :maxlength
+    b.optional :minlength
     b.optional :readonly
     b.use :label, class: 'control-label'
 
@@ -55,6 +57,7 @@ SimpleForm.setup do |config|
     b.use :html5
     b.use :placeholder
     b.optional :maxlength
+    b.optional :minlength
     b.optional :pattern
     b.optional :min_max
     b.optional :readonly
@@ -71,6 +74,7 @@ SimpleForm.setup do |config|
     b.use :html5
     b.use :placeholder
     b.optional :maxlength
+    b.optional :minlength
     b.optional :readonly
     b.use :label, class: 'col-sm-3 control-label'
 
@@ -87,7 +91,7 @@ SimpleForm.setup do |config|
 
     b.wrapper tag: 'div', class: 'col-sm-offset-3 col-sm-9' do |wr|
       wr.wrapper tag: 'div', class: 'checkbox' do |ba|
-        ba.use :label_input, class: 'col-sm-9'
+        ba.use :label_input
       end
 
       wr.use :error, wrap_with: { tag: 'span', class: 'help-block' }
@@ -112,6 +116,7 @@ SimpleForm.setup do |config|
     b.use :html5
     b.use :placeholder
     b.optional :maxlength
+    b.optional :minlength
     b.optional :pattern
     b.optional :min_max
     b.optional :readonly
@@ -122,6 +127,16 @@ SimpleForm.setup do |config|
     b.use :hint,  wrap_with: { tag: 'p', class: 'help-block' }
   end
 
+  config.wrappers :multi_select, tag: 'div', class: 'form-group', error_class: 'has-error' do |b|
+    b.use :html5
+    b.optional :readonly
+    b.use :label, class: 'control-label'
+    b.wrapper tag: 'div', class: 'form-inline' 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
+  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,
@@ -132,5 +147,8 @@ SimpleForm.setup do |config|
     radio_buttons: :vertical_radio_and_checkboxes,
     file: :vertical_file_input,
     boolean: :vertical_boolean,
+    datetime: :multi_select,
+    date: :multi_select,
+    time: :multi_select
   }
 end

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

@@ -4,13 +4,14 @@ SimpleForm.setup do |config|
   # all the grid-related classes)
   #
   # Please note that hints are commented out by default since Foundation
-  # does't provide styles for hints. You will need to provide your own CSS styles for hints.
+  # doesn't provide styles for hints. You will need to provide your own CSS styles for hints.
   # Uncomment them to enable hints.
 
   config.wrappers :vertical_form, class: :input, hint_class: :field_with_hint, error_class: :error do |b|
     b.use :html5
     b.use :placeholder
     b.optional :maxlength
+    b.optional :minlength
     b.optional :pattern
     b.optional :min_max
     b.optional :readonly
@@ -24,6 +25,7 @@ SimpleForm.setup do |config|
     b.use :html5
     b.use :placeholder
     b.optional :maxlength
+    b.optional :minlength
     b.optional :pattern
     b.optional :min_max
     b.optional :readonly
@@ -65,6 +67,7 @@ SimpleForm.setup do |config|
     b.use :html5
     b.use :placeholder
     b.optional :maxlength
+    b.optional :minlength
     b.optional :pattern
     b.optional :min_max
     b.optional :readonly
@@ -95,7 +98,7 @@ SimpleForm.setup do |config|
   config.button_class = 'button'
 
   # Set this to div to make the checkbox and radio properly work
-  # otherwise simple_form adds a label tag instead of a div arround
+  # otherwise simple_form adds a label tag instead of a div around
   # the nested label
   config.item_wrapper_tag = :div
 

data/lib/simple_form/action_view_extensions/form_helper.rb

@@ -66,4 +66,6 @@ module SimpleForm
   end
 end
 
-ActionView::Base.send :include, SimpleForm::ActionViewExtensions::FormHelper
+ActiveSupport.on_load(:action_view) do
+  include SimpleForm::ActionViewExtensions::FormHelper
+end

data/lib/simple_form/components/html5.rb

@@ -7,10 +7,12 @@ module SimpleForm
 
       def html5(wrapper_options = nil)
         @html5 = true
-        if has_required?
-          input_html_options[:required] = true
-          input_html_options[:'aria-required'] = true
-        end
+
+        input_html_options[:required]        = input_html_required_option
+        input_html_options[:'aria-required'] = input_html_aria_required_option
+
+        input_html_options[:'aria-invalid']  = has_errors? || nil
+
         nil
       end
 
@@ -18,6 +20,14 @@ module SimpleForm
         @html5
       end
 
+      def input_html_required_option
+        !options[:required].nil? ? required_field? : has_required?
+      end
+
+      def input_html_aria_required_option
+        !options[:required].nil? ? (required_field? || nil) : (has_required? || nil)
+      end
+
       def has_required?
         # We need to check browser_validations because
         # some browsers are still checking required even

data/lib/simple_form/components/labels.rb

@@ -42,7 +42,7 @@ module SimpleForm
 
       def label_html_options
         label_html_classes = SimpleForm.additional_classes_for(:label) {
-          [input_type, required_class, SimpleForm.label_class].compact
+          [input_type, required_class, disabled_class, SimpleForm.label_class].compact
         }
 
         label_options = html_options_for(:label, label_html_classes)

data/lib/simple_form/components/maxlength.rb

@@ -15,10 +15,7 @@ module SimpleForm
           maxlength
         else
           length_validator = find_length_validator
-
-          if length_validator && !has_tokenizer?(length_validator)
-            length_validator.options[:is] || length_validator.options[:maximum]
-          end
+          maximum_length_value_from(length_validator)
         end
       end
 
@@ -29,6 +26,22 @@ module SimpleForm
       def has_tokenizer?(length_validator)
         length_validator.options[:tokenizer]
       end
+
+      # Use validation with tokenizer if version of Rails is less than 5,
+      # if not validate without the tokenizer, if version is greater than Rails 4.
+      if ActionPack::VERSION::STRING < '5'
+        def maximum_length_value_from(length_validator)
+          if length_validator && !has_tokenizer?(length_validator)
+            length_validator.options[:is] || length_validator.options[:maximum]
+          end
+        end
+      elsif ActionPack::VERSION::STRING >= '5'
+        def maximum_length_value_from(length_validator)
+          if length_validator
+            length_validator.options[:is] || length_validator.options[:maximum]
+          end
+        end
+      end
     end
   end
 end

data/lib/simple_form/components/minlength.rb

@@ -0,0 +1,47 @@
+module SimpleForm
+  module Components
+    # Needs to be enabled in order to do automatic lookups.
+    module Minlength
+      def minlength(wrapper_options = nil)
+        input_html_options[:minlength] ||= minimum_length_from_validation || limit
+        nil
+      end
+
+      private
+
+      def minimum_length_from_validation
+        minlength = options[:minlength]
+        if minlength.is_a?(String) || minlength.is_a?(Integer)
+          minlength
+        else
+          length_validator = find_length_validator
+          minimum_length_value_from(length_validator)
+        end
+      end
+
+      def find_length_validator
+        find_validator(:length)
+      end
+
+      def has_tokenizer?(length_validator)
+        length_validator.options[:tokenizer]
+      end
+
+      # Use validation with tokenizer if version of Rails is less than 5,
+      # if not validate without the tokenizer, if version is greater than Rails 4.
+      if ActionPack::VERSION::STRING < '5'
+        def minimum_length_value_from(length_validator)
+          if length_validator && !has_tokenizer?(length_validator)
+            length_validator.options[:is] || length_validator.options[:minimum]
+          end
+        end
+      elsif ActionPack::VERSION::STRING >= '5'
+        def minimum_length_value_from(length_validator)
+          if length_validator
+            length_validator.options[:is] || length_validator.options[:minimum]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/simple_form/components.rb

@@ -15,6 +15,7 @@ module SimpleForm
     autoload :Labels
     autoload :MinMax
     autoload :Maxlength
+    autoload :Minlength
     autoload :Pattern
     autoload :Placeholders
     autoload :Readonly