simple_form 3.5.0 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 21876f0dc22464c3d3cc192c6cb1b387d87a3ffa
-  data.tar.gz: 5dca755be1ecf07cf96360b81c338333787976fb
+  metadata.gz: bdc43deadddaaf9bc4b3872855d677c5e560066d
+  data.tar.gz: 1a58416a2a4977e825f25c345ba41abec78c85a9
 SHA512:
-  metadata.gz: fdda2693ca2da6c6b33e393b960969c46de2a1fbea4475cb412429020bb029c4ce1e6fb210e7bfeb6f7e5d19630b9b68f6f89f29eaf02cb200ecf36d22d3ff60
-  data.tar.gz: 912d804b0b3d7b832b7ddc1a1f3e1a57a88fe5ed2d9907d472bd12a3882e1b1b2442e0eae2a95dd9abaa1fa2f4cd74832f6f80ed17144162d6b528ce7d5856ee
+  metadata.gz: 9812df086c46e0abe897274ac1260cac8dccb7d906da88f75182efc741a4802931f0c5c8b556dfa1ab0793cf93fe9cd68909d69948cee1f43f26b7a807e3ae29
+  data.tar.gz: dca2a8eaf706656f77f5294a18068521aa83a9ab2fbd1e269009e68751e9ea2d2811127d5daa017d137c5c9ec5c74b62bbfaaa3fb002211f6778d09cb19a066c

data/CHANGELOG.md

@@ -1,5 +1,45 @@
 ## Unreleased
 
+## 4.0.0
+
+### Enhancements
+* Add bootstrap v4.1 generator template. [@m5o](https://github.com/m5o)
+* Add Rails 5.2 support. [@gobijan](https://github.com/gobijan)
+* Add API to register custom components.[@feliperenan](https://github.com/feliperenan)
+* Allow custom errors classes to inputs.[@feliperenan](https://github.com/feliperenan)
+* Remove support from Rails 4.0, 4.1 and 4.2. [@feliperenan](https://github.com/feliperenan)
+* Add support for citext, hstore, json & jsonb column types. [@swrobel](https://github.com/swrobel)
+* Add :valid_class on input wrapper when value is present and valid [@aeberlin](https://github.com/aeberlin), [@m5o](https://github.com/m5o)
+* Allow :valid_class to inputs when value is present and valid. [@m5o](https://github.com/m5o)
+* Allow validation classes on input_field. [@feliperenan](https://github.com/feliperenan)
+* Add basic ActiveStorage support. [@murb](https://github.com/murb)
+
+### Bug fix
+* Fix horizontal form label position, from right to text-right. [@cavpollo](https://github.com/cavpollo)
+* Add base error display alongside existing errors. [@bluefalcon26](https://github.com/bluefalcon26)
+* Silent deprication warning for placeholder_text. [@moofkit](https://github.com/moofkit)
+* Use custom i18n scope for label required html. [@tvdeyen](https://github.com/tvdeyen)
+
+## 3.5.1
+
+### Enhancements
+* Exclude hidden field when unchecked_value: false. [@fschwahn](https://github.com/fschwahn)
+* Add frozen_string_literal magic comment to several files. [@oniofchaos](https://github.com/oniofchaos)
+* Try convert @object to model in case we got decorated object [@timurvafin](https://github.com/timurvafin)
+- From now, if you are using some object that inherits from `SimpleDelegator`, you must implement
+  `def to_model; self; end`. Otherwise, *Simple Form* will convert the decorated object to the model
+  since `SimpleDelegator` will delegate it to the model.
+* Code cleanup [@Fornacula](https://github.com/Fornacula)
+
+### Bug fix
+* Fix error when the scope from association has parameter. [@feliperenan](https://github.com/feliperenan)
+* Only call `where` on associations when they respond to it. [@anicholson](https://github.com/anicholson)
+* require 'action_pack' before using it. [@etagwerker](https://github.com/etagwerker)
+* Check if Rails.env is defined. [@etagwerker](https://github.com/etagwerker)
+* Fix minlength. [@mameier](https://github.com/mameier)
+* Make errors_on_attribute return [] when not present. [@redrick](https://github.com/redrick)
+* Fix boolean inputs in nested style for label non-string. [@feliperenan](https://github.com/feliperenan)
+
 ## 3.5.0
 
 * Updated gem dependency to support Rails 5.1.x.

data/README.md

@@ -325,8 +325,18 @@ 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. 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:
+and use `:to_label` as a `:label_method` first if it is found. 
+
+By default, **Simple Form** will use the first item from an array as the label and the second one as the value.
+If you want to change this behavior you must make it explicit, like this:
+
+```erb
+<%= simple_form_for @user do |f| %>
+  <%= f.input :gender, as: :radio_buttons, collection: [['0', 'female'], ['1', 'male']], label_method: :second, value_method: :first %>
+<% end %>
+```
+
+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", selected: 21
@@ -541,31 +551,35 @@ The following table shows the html element you will get for each attribute
 according to its database definition. These defaults can be changed by
 specifying the helper method in the column `Mapping` as the `as:` option.
 
-     Mapping         | Generated HTML Element               | Database Column Type
-     --------------- |:-------------------------------------|:--------------------
-     `boolean`       | `input[type=checkbox]`               | `boolean`
-     `string`        | `input[type=text]`                   | `string`
-     `email`         | `input[type=email]`                  | `string` with `name =~ /email/`
-     `url`           | `input[type=url]`                    | `string` with `name =~ /url/`
-     `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]`                 | -
-     `integer`       | `input[type=number]`                 | `integer`
-     `float`         | `input[type=number]`                 | `float`
-     `decimal`       | `input[type=number]`                 | `decimal`
-     `range`         | `input[type=range]`                  | -
-     `datetime`      | `datetime select`                    | `datetime/timestamp`
-     `date`          | `date select`                        | `date`
-     `time`          | `time select`                        | `time`
-     `select`        | `select`                             | `belongs_to`/`has_many`/`has_and_belongs_to_many` associations
-     `radio_buttons` | collection of `input[type=radio]`    | `belongs_to` associations
-     `check_boxes`   | collection of `input[type=checkbox]` | `has_many`/`has_and_belongs_to_many` associations
-     `country`       | `select` (countries as options)      | `string` with `name =~ /country/`
-     `time_zone`     | `select` (timezones as options)      | `string` with `name =~ /time_zone/`
+Mapping         | Generated HTML Element               | Database Column Type
+--------------- |--------------------------------------|---------------------
+`boolean`       | `input[type=checkbox]`               | `boolean`
+`string`        | `input[type=text]`                   | `string`
+`citext`        | `input[type=text]`                   | `citext`
+`email`         | `input[type=email]`                  | `string` with `name =~ /email/`
+`url`           | `input[type=url]`                    | `string` with `name =~ /url/`
+`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`
+`hstore`        | `textarea`                           | `hstore`
+`json`          | `textarea`                           | `json`
+`jsonb`         | `textarea`                           | `jsonb`
+`file`          | `input[type=file]`                   | `string` responding to file methods
+`hidden`        | `input[type=hidden]`                 | -
+`integer`       | `input[type=number]`                 | `integer`
+`float`         | `input[type=number]`                 | `float`
+`decimal`       | `input[type=number]`                 | `decimal`
+`range`         | `input[type=range]`                  | -
+`datetime`      | `datetime select`                    | `datetime/timestamp`
+`date`          | `date select`                        | `date`
+`time`          | `time select`                        | `time`
+`select`        | `select`                             | `belongs_to`/`has_many`/`has_and_belongs_to_many` associations
+`radio_buttons` | collection of `input[type=radio]`    | `belongs_to` associations
+`check_boxes`   | collection of `input[type=checkbox]` | `has_many`/`has_and_belongs_to_many` associations
+`country`       | `select` (countries as options)      | `string` with `name =~ /country/`
+`time_zone`     | `select` (timezones as options)      | `string` with `name =~ /time_zone/`
 
 ## Custom inputs
 
@@ -842,7 +856,8 @@ The syntax looks like this:
 
 ```ruby
 config.wrappers tag: :div, class: :input,
-                error_class: :field_with_errors do |b|
+                error_class: :field_with_errors,
+                valid_class: :field_without_errors do |b|
 
   # Form extensions
   b.use :html5
@@ -891,11 +906,12 @@ You can customize _Form components_ passing options to them:
 
 ```ruby
 config.wrappers do |b|
-  b.use :label_input, class: 'label-input-class'
+  b.use :label_input, class: 'label-input-class', error_class: 'is-invalid', valid_class: 'is-valid'
 end
 ```
 
-This you set the input and label class to `'label-input-class'`.
+This you set the input and label class to `'label-input-class'` and will set the class `'is-invalid'`
+when the input has errors and `'is-valid'` if the input is valid.
 
 If you want to customize the custom _Form components_ on demand you can give it a name like this:
 
@@ -974,6 +990,92 @@ when the content is present.
   end
 ```
 
+## Custom Components
+
+When you use custom wrappers, you might also be looking for a way to add custom components to your 
+wrapper. The default components are:
+
+```ruby
+:label         # The <label> tag alone
+:input         # The <input> tag alone
+:label_input   # The <label> and the <input> tags
+:hint          # The hint for the input
+:error         # The error for the input
+```
+
+A custom component might be interesting for you if your views look something like this:
+
+```erb
+<%= simple_form_for @blog do |f| %>
+  <div class="row">
+    <div class="span1 number">
+      1
+    </div>
+    <div class="span8">
+      <%= f.input :title %>
+    </div>
+  </div>
+  <div class="row">
+    <div class="span1 number">
+      2
+    </div>
+    <div class="span8">
+      <%= f.input :body, as: :text %>
+    </div>
+  </div>
+<% end %>
+```
+
+A cleaner method to create your views would be:
+
+```erb
+<%= simple_form_for @blog, wrapper: :with_numbers do |f| %>
+  <%= f.input :title, number: 1 %>
+  <%= f.input :body, as: :text, number: 2 %>
+<% end %>
+```
+
+To use the number option on the input, first, tells to Simple Form the place where the components
+will be:
+
+``` ruby
+# config/initializers/simple_form.rb
+Dir[Rails.root.join('lib/components/**/*.rb')].each { |f| require f }
+```
+
+Create a new component within the path specified above:
+
+```ruby
+# lib/components/numbers_component.rb
+module NumbersComponent
+  # To avoid deprecation warning, you need to make the wrapper_options explicit
+  # even when they won't be used.
+  def number(wrapper_options = nil)
+    @number ||= begin
+      options[:number].to_s.html_safe if options[:number].present?
+    end
+  end
+end
+
+SimpleForm.include_component(NumbersComponent)
+```
+
+Finally, add a new wrapper to the config/initializers/simple_form.rb file:
+
+```ruby
+config.wrappers :with_numbers, tag: 'div', class: 'row', error_class: 'error' do |b|
+  b.use :html5
+  b.use :number, wrap_with: { tag: 'div', class: 'span1 number'}
+  b.wrapper tag: 'div', class: 'span8' do |ba|
+    ba.use :placeholder
+    ba.use :label
+    ba.use :input
+    ba.use :error, wrap_with: { tag: 'span', class: 'help-inline' }
+    ba.use :hint,  wrap_with: { tag: 'p', class: 'help-block' }
+  end
+end
+```
+
 ## HTML 5 Notice
 
 By default, **Simple Form** will generate input field types and attributes that are supported in HTML5,
@@ -1039,6 +1141,76 @@ by passing the html5 option:
 <%= f.input :expires_at, as: :date, html5: true %>
 ```
 
+### Using non Active Record objects
+
+There are few ways to build forms with objects that don't inherit from Active Record, as 
+follow:
+
+You can include the module `ActiveModel::Model`.
+
+```ruby
+class User
+  include ActiveModel::Model
+
+  attr_accessor :id, :name
+end
+```
+
+If you are using Presenters or Decorators that inherit from `SimpleDelegator` you can delegate 
+it to the model.
+
+```ruby
+class UserPresenter < SimpleDelegator
+  # Without that, Simple Form will consider the user model as the object.
+  def to_model 
+    self 
+  end
+end
+```
+
+You can define all methods required by the helpers.
+
+```ruby
+class User 
+  extend ActiveModel::Naming
+
+  attr_accessor :id, :name
+
+  def to_model
+    self
+  end
+
+  def to_key 
+    id 
+  end
+
+  def persisted? 
+    false 
+  end
+end
+```
+
+If your object doesn't implement those methods, you must make explicit it when you are 
+building the form
+
+```ruby
+class User 
+  attr_accessor :id, :name
+
+  # The only method required to use the f.submit helper.
+  def persisted? 
+    false
+  end
+end
+```
+
+```erb
+<%= simple_form_for(@user, as: :user, method: :post, url: users_path) do |f| %>
+  <%= f.input :name %> 
+  <%= f.submit 'New user' %>
+<% end %>
+```
+
 ## Information
 
 ### Google Group
@@ -1076,7 +1248,7 @@ https://github.com/plataformatec/simple_form/issues
 
 ## License
 
-MIT License. Copyright 2009-2016 Plataformatec. http://plataformatec.com.br
+MIT License. Copyright 2009-2018 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/install_generator.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module SimpleForm
   module Generators
     class InstallGenerator < Rails::Generators::Base

data/lib/generators/simple_form/templates/README

@@ -3,9 +3,9 @@
   Be sure to have a copy of the Bootstrap stylesheet available on your
   application, you can get it on http://getbootstrap.com/.
 
-  Inside your views, use the 'simple_form_for' with one of the Bootstrap form
-  classes, '.form-horizontal' or '.form-inline', as the following:
+  Inside your views, use the 'simple_form_for' with the Bootstrap form
+  class, '.form-inline', as the following:
 
-    = simple_form_for(@user, html: { class: 'form-horizontal' }) do |form|
+    = simple_form_for(@user, html: { class: 'form-inline' }) do |form|
 
 ===============================================================================

data/lib/generators/simple_form/templates/_form.html.erb

@@ -1,5 +1,7 @@
+<%# frozen_string_literal: true %>
 <%%= simple_form_for(@<%= singular_table_name %>) do |f| %>
   <%%= f.error_notification %>
+  <%%= f.error_notification message: f.object.errors[:base].to_sentence if f.object.errors[:base].present? %>
 
   <div class="form-inputs">
   <%- attributes.each do |attribute| -%>

data/lib/generators/simple_form/templates/_form.html.haml

@@ -1,5 +1,7 @@
+-# frozen_string_literal: true
 = simple_form_for(@<%= singular_table_name %>) do |f|
   = f.error_notification
+  = f.error_notification message: f.object.errors[:base].to_sentence if f.object.errors[:base].present?
 
   .form-inputs
   <%- attributes.each do |attribute| -%>

data/lib/generators/simple_form/templates/_form.html.slim

@@ -1,5 +1,6 @@
 = simple_form_for(@<%= singular_table_name %>) do |f|
   = f.error_notification
+  = f.error_notification message: f.object.errors[:base].to_sentence if f.object.errors[:base].present?
 
   .form-inputs
 <%- attributes.each do |attribute| -%>

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

@@ -1,3 +1,11 @@
+# frozen_string_literal: true
+#
+# Uncomment this and change the path if necessary to include your own
+# components.
+# See https://github.com/plataformatec/simple_form#custom-components to know
+# more about custom components.
+# Dir[Rails.root.join('lib/components/**/*.rb')].each { |f| require f }
+#
 # Use this setup block to configure all options available in SimpleForm.
 SimpleForm.setup do |config|
   # Wrappers are used by the form builder to generate a
@@ -6,7 +14,7 @@ SimpleForm.setup do |config|
   # stack. The options given below are used to wrap the
   # whole input.
   config.wrappers :default, class: :input,
-    hint_class: :field_with_hint, error_class: :field_with_errors do |b|
+    hint_class: :field_with_hint, error_class: :field_with_errors, valid_class: :field_without_errors do |b|
     ## Extensions enabled by default
     # Any of these extensions can be disabled for a
     # given input by passing: `f.input EXTENSION_NAME => false`.
@@ -44,6 +52,7 @@ SimpleForm.setup do |config|
     b.optional :readonly
 
     ## Inputs
+    # b.use :input, class: 'input', error_class: 'is-invalid', valid_class: 'is-valid'
     b.use :label_input
     b.use :hint,  wrap_with: { tag: :span, class: :hint }
     b.use :error, wrap_with: { tag: :span, class: :error }
@@ -124,7 +133,7 @@ SimpleForm.setup do |config|
   config.browser_validations = false
 
   # Collection of methods to detect if a file type was given.
-  # config.file_methods = [ :mounted_as, :file?, :public_filename ]
+  # config.file_methods = [ :mounted_as, :file?, :public_filename :attached? ]
 
   # Custom mappings for input types. This should be a hash containing a regexp
   # to match as key, and the input type that will be used when the field name
@@ -166,4 +175,8 @@ SimpleForm.setup do |config|
 
   # Defines which i18n scope will be used in Simple Form.
   # config.i18n_scope = 'simple_form'
+
+  # Defines validation classes to the input_field. By default it's nil.
+  # config.input_field_valid_class = 'is-valid'
+  # config.input_field_error_class = 'is-invalid'
 end