simple_form 5.0.3 → 5.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 184b100fac3f2109461f1678b8a7fc1d0691e285946a5c2395bcba13a90ac4cd
-  data.tar.gz: bd14c6e07ab469e8d8df1822545c0707231412d10b18eaa00c1bfd015dfee4d5
+  metadata.gz: 5ad9e2ec1c9f339ea03d225a1dc971adea0fb60efc571cd40655b7738eff273f
+  data.tar.gz: 937cee947cb4432fea02ff967879356442721bed0e01cb0c4fa3e9f50626a2cb
 SHA512:
-  metadata.gz: 99a5a7a83a866c5582d413b49ef6a5c14571b943e0e3c8a72b88084e24b91d46aa04f308566ce9aae0b6a6e7475e747f08fb82945f6f4122da84f9b0672c95d0
-  data.tar.gz: c6ae34fe070436f81a1cd79c18a359853e3a3dab4b5413c302011d82623d523e6c4826f44b4b58b59d1faddf319e3dae1da835d55e6c756f93cae4195d403e42
+  metadata.gz: cf3e4b076014b076ff2168a0a1d236e21fbdf631ea0198d9e6a3b86eff908de1068f8a0f972fa7f4f9990ca3e3f7ae1d63a762b53f9975cebbd71e4f1a5a233e
+  data.tar.gz: a0a12ac9760afd5ade06c4a26942adbe515570947b0ae1eb7889fb0d626e2e57b177e82e32a02346ec0fe23591ce74cd609f669892df0d9969ae8b858562ec91

data/CHANGELOG.md

@@ -1,3 +1,22 @@
+## Unreleased
+
+
+## 5.2.0
+
+* Add support for Rails 7.0 and Ruby 3.1/3.2 (no changes required)
+* Fix escaping issue on boolean input with `include_hidden: false` and custom wrapper.
+* Update Bootstrap install generator version 5. [@mhw](https://github.com/mhw)
+* Accept proc as `group_method` for grouped collection select
+* Honor `include_hidden` option on inline boolean inputs [@yboulkaid](https://github.com/yboulkaid)
+* Fix deprecation error when using country_select input.
+
+## 5.1.0
+
+* Remove `I18nCache` module entirely. It was added complexity for very little gain in some translations, and caused extra trouble upgrading to Ruby 3. If you need that level of caching consider looking into I18n caching as a whole.
+* Add support for Ruby 3.0, drop support for Ruby < 2.5.
+* Add support for Rails 6.1, drop support for Rails < 5.2.
+* Move CI to GitHub Actions.
+
 ## 5.0.3
 
 ### Bug fix

data/README.md

@@ -9,6 +9,43 @@ which we are thankful for and should make you feel right at home.
 
 INFO: This README refers to **Simple Form** 5.0. For older releases, check the related branch for your version.
 
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+## Table of Contents
+
+- [Installation](#installation)
+  - [Bootstrap](#bootstrap-5)
+  - [Zurb Foundation 5](#zurb-foundation-5)
+  - [Country Select](#country-select)
+- [Usage](#usage)
+  - [Stripping away all wrapper divs](#stripping-away-all-wrapper-divs)
+  - [Collections](#collections)
+  - [Priority](#priority)
+  - [Associations](#associations)
+  - [Buttons](#buttons)
+  - [Wrapping Rails Form Helpers](#wrapping-rails-form-helpers)
+  - [Extra helpers](#extra-helpers)
+    - [Simple Fields For](#simple-fields-for)
+    - [Collection Radio Buttons](#collection-radio-buttons)
+    - [Collection Check Boxes](#collection-check-boxes)
+- [Available input types and defaults for each column type](#available-input-types-and-defaults-for-each-column-type)
+- [Custom inputs](#custom-inputs)
+- [Custom form builder](#custom-form-builder)
+- [I18n](#i18n)
+- [Configuration](#configuration)
+  - [The wrappers API](#the-wrappers-api)
+- [Custom Components](#custom-components)
+- [HTML 5 Notice](#html-5-notice)
+  - [Using non Active Record objects](#using-non-active-record-objects)
+- [Information](#information)
+  - [RDocs](#rdocs)
+  - [Supported Ruby / Rails versions](#supported-ruby--rails-versions)
+  - [Bug reports](#bug-reports)
+- [Maintainers](#maintainers)
+- [License](#license)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
 ## Installation
 
 Add it to your Gemfile:
@@ -29,21 +66,23 @@ Run the generator:
 rails generate simple_form:install
 ```
 
-### Bootstrap
+### Bootstrap 5
 
-**Simple Form** can be easily integrated to the [Bootstrap](http://getbootstrap.com/).
-To do that you have to use the `bootstrap` option in the install generator, like this:
+**Simple Form** can be easily integrated with [Bootstrap 5](http://getbootstrap.com/).
+Use the `bootstrap` option in the install generator, like this:
 
 ```console
 rails generate simple_form:install --bootstrap
 ```
 
+This will add an initializer that configures **Simple Form** wrappers for
+Bootstrap 5's [form controls](https://getbootstrap.com/docs/5.0/forms/overview/).
 You have to be sure that you added a copy of the [Bootstrap](http://getbootstrap.com/)
 assets on your application.
 
 For more information see the generator output, our
-[example application code](https://github.com/rafaelfranca/simple_form-bootstrap) and
-[the live example app](http://simple-form-bootstrap.plataformatec.com.br/).
+[example application code](https://github.com/heartcombo/simple_form-bootstrap) and
+[the live example app](https://simple-form-bootstrap.herokuapp.com/).
 
 ### Zurb Foundation 5
 
@@ -116,7 +155,7 @@ of any of them:
 ```erb
 <%= simple_form_for @user do |f| %>
   <%= f.input :username, label_html: { class: 'my_class' }, hint_html: { class: 'hint_class' } %>
-  <%= f.input :password, hint: false, error_html: { id: 'password_error'} %>
+  <%= f.input :password, hint: false, error_html: { id: 'password_error' } %>
   <%= f.input :password_confirmation, label: false %>
   <%= f.button :submit %>
 <% end %>
@@ -218,7 +257,18 @@ the wrapper as well:
   <%= f.input :date_of_birth, as: :date, start_year: Date.today.year - 90,
                               end_year: Date.today.year - 12, discard_day: true,
                               order: [:month, :year] %>
-  <%= f.input :accepts, as: :boolean, checked_value: true, unchecked_value: false %>
+  <%= f.input :accepts, as: :boolean, checked_value: 'positive', unchecked_value: 'negative' %>
+  <%= f.button :submit %>
+<% end %>
+```
+
+By default, **Simple Form** generates a hidden field to handle the un-checked case for boolean fields. 
+Passing `unchecked_value: false` in the options for boolean fields will cause this hidden field to be omitted,
+following the convention in Rails. You can also specify `include_hidden: false` to skip the hidden field:
+
+```erb
+<%= simple_form_for @user do |f| %>
+  <%= f.input :just_the_checked_case, as: :boolean, include_hidden: false %>
   <%= f.button :submit %>
 <% end %>
 ```
@@ -285,7 +335,7 @@ end
 </form>
 ```
 
-To view the actual RDocs for this, check them out here - http://rubydoc.info/github/heartcombo/simple_form/master/SimpleForm/FormBuilder:input_field
+To view the actual RDocs for this, check them out here - http://rubydoc.info/github/heartcombo/simple_form/main/SimpleForm/FormBuilder:input_field
 
 ### Collections
 
@@ -326,14 +376,13 @@ If you want to change this behavior you must make it explicit, like this:
 <% end %>
 ```
 
-All other options given are sent straight to the underlying helper. For example, you can give prompt as:
+All other options given are sent straight to the underlying Rails helper(s): [`collection_select`](http://api.rubyonrails.org/classes/ActionView/Helpers/FormOptionsHelper.html#method-i-collection_select), [`collection_check_boxes`](http://api.rubyonrails.org/classes/ActionView/Helpers/FormOptionsHelper.html#method-i-collection_check_boxes), [`collection_radio_buttons`](http://api.rubyonrails.org/classes/ActionView/Helpers/FormOptionsHelper.html#method-i-collection_radio_buttons). For example, you can pass `prompt` and `selected` as:
 
 ```ruby
 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 may also be useful to explicitly pass a value to the optional `:selected` like above, 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:
 
@@ -1062,7 +1111,7 @@ 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.use :number, wrap_with: { tag: 'div', class: 'span1 number' }
   b.wrapper tag: 'div', class: 'span8' do |ba|
     ba.use :placeholder
     ba.use :label
@@ -1214,7 +1263,14 @@ end
 
 You can view the **Simple Form** documentation in RDoc format here:
 
-http://rubydoc.info/github/heartcombo/simple_form/master/frames
+http://rubydoc.info/github/heartcombo/simple_form/main/frames
+
+### Supported Ruby / Rails versions
+
+We intend to maintain support for all Ruby / Rails versions that haven't reached end-of-life.
+
+For more information about specific versions please check [Ruby](https://www.ruby-lang.org/en/downloads/branches/)
+and [Rails](https://guides.rubyonrails.org/maintenance_policy.html) maintenance policies, and our test matrix.
 
 ### Bug reports
 
@@ -1233,7 +1289,6 @@ If you have discovered a security related bug, please do NOT use the GitHub issu
 * Felipe Renan (https://github.com/feliperenan)
 
 [![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/heartcombo/simple_form.svg?branch=master)](http://travis-ci.org/heartcombo/simple_form)
 [![Code Climate](https://codeclimate.com/github/heartcombo/simple_form.png)](https://codeclimate.com/github/heartcombo/simple_form)
 [![Inline docs](http://inch-ci.org/github/heartcombo/simple_form.png)](http://inch-ci.org/github/heartcombo/simple_form)
 
@@ -1242,4 +1297,3 @@ If you have discovered a security related bug, please do NOT use the GitHub issu
 MIT License. Copyright 2020 Rafael França, Carlos Antônio da Silva. Copyright 2009-2019 Plataformatec.
 
 The Simple Form logo is licensed under [Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International License](https://creativecommons.org/licenses/by-nc-nd/4.0/).
-

data/lib/generators/simple_form/install_generator.rb

@@ -5,12 +5,12 @@ module SimpleForm
       desc "Copy SimpleForm default files"
       source_root File.expand_path('../templates', __FILE__)
       class_option :template_engine, desc: 'Template engine to be invoked (erb, haml or slim).'
-      class_option :bootstrap, type: :boolean, desc: 'Add the Bootstrap wrappers to the SimpleForm initializer.'
+      class_option :bootstrap, type: :boolean, desc: 'Add the Bootstrap 5 wrappers to the SimpleForm initializer.'
       class_option :foundation, type: :boolean, desc: 'Add the Zurb Foundation 5 wrappers to the SimpleForm initializer.'
 
       def info_bootstrap
         return if options.bootstrap? || options.foundation?
-        puts "SimpleForm 3 supports Bootstrap and Zurb Foundation 5. If you want "\
+        puts "SimpleForm supports Bootstrap 5 and Zurb Foundation 5. If you want "\
           "a configuration that is compatible with one of these frameworks, then please " \
           "re-run this generator with --bootstrap or --foundation as an option."
       end

data/lib/generators/simple_form/templates/README

@@ -5,6 +5,6 @@
 
   For usage examples and documentation, see:
 
-    http://simple-form-bootstrap.plataformatec.com.br/
+    https://simple-form-bootstrap.herokuapp.com
 
 ===============================================================================

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

@@ -112,7 +112,7 @@ SimpleForm.setup do |config|
   # You can define the class to use on all labels. Default is nil.
   # config.label_class = nil
 
-  # You can define the default class to be used on forms. Can be overriden
+  # You can define the default class to be used on forms. Can be overridden
   # with `html: { :class }`. Defaulting to none.
   # config.default_form_class = nil