simple_form 5.0.0 → 5.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a1bfd4d5f14c750caf9e2fa6287033c0331473215737a96b4bcece8e6f84a7a9
-  data.tar.gz: 9c09b014e449f5b8823c062092b864e538c638fd418d782919a9c0a3cd50df78
+  metadata.gz: 3b89606503cd2fc01363418e51dd00630a770820b8482f35aa85ddba1a653cc5
+  data.tar.gz: 1a078f896c0e4bd41b0462a5b591fcc04038dbb0dd64c65c61b5584450a9b569
 SHA512:
-  metadata.gz: 620056c8b34f6f93229b2ee0771adb0aa7d267fcc22b9d94c214f62287061930e9b0e35a648f47a890452cb8098bc57643a1dce7bbed3df3c2058546b58c5090
-  data.tar.gz: 4fa4e5a106b9065405fbba77b8a84ed99e86d84ea4a4435d0a459ee0196a020afbec0ec62fcd2c79f8885d771e48700409ae055ea4858d15b2b5ddd9c3fb5168
+  metadata.gz: 17a0ecd1d326536cdb1e4e1291bcfbad43fac2d8e4e0895ad0619515e9f951c4618da9b4ad8c568bcd9b702f94227f58b3967a14eb9b7adc3343ca07cfb8f451
+  data.tar.gz: 810793e24f74792775bbe3e5bba0b157f59673879b8c6c360c4af15ba2d91fc0d293eace5556aba5b32e7a99f01d7e3e96099046401e802fbba3a1b2bcddcaf5

data/CHANGELOG.md

@@ -1,4 +1,45 @@
-## Unreleased
+## 5.3.0
+
+* Add support for Rails 7.1. (no meaningful changes required.)
+* Add `SimpleForm.deprecator` to integrate with new application deprecators in Rails 7.1.
+* Remove test files from the gem package. [@orien](https://github.com/orien)
+* Speed up input mapping lookup by avoiding rescuing exceptions. [@meanphil](https://github.com/meanphil) [@kriom](https://github.com/kriom) [@egeek](https://github.com/egeek)
+
+## 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
+* Fix for ActiveStorage::Attached::Many. [@enriquez](https://github.com/enriquez)
+
+## 5.0.2
+
+### Enhancements
+* Remove instruction to use form-inline class. [@goalaleo](https://github.com/goalaleo)
+* Added RichTextAreaInput for ActionText. [itsterry](https://github.com/itsterry)
+* Skip valid_class check if no class defined. [TALlama](https://github.com/TALlama)
+
+### Bug fix
+* Fix 'aria-required' field generated by prompt. [@CarlosAlbertoSantos](https://github.com/CarlosAlbertoSantos)
+
+## 5.0.1
+
+### Bug fix
+* Replace `_url` with `remote_url` when trying to guess file inputs [@tegon](https://github.com/tegon). This has the side-effect of changing carrierwave's support from `0.2.1` to `0.2.2`.
 
 ## 5.0.0
 
@@ -107,7 +148,7 @@ See http://blog.plataformatec.com.br/2019/09/incorrect-access-control-in-simple-
 
 ### 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).
+  Closes [#1278](https://github.com/heartcombo/simple_form/issues/1278).
 
 ## 3.2.1
 
@@ -169,11 +210,11 @@ See http://blog.plataformatec.com.br/2019/09/incorrect-access-control-in-simple-
   * Add `boolean_label_class` config.
   * Add `:html` option to include additional attributes on custom wrappers [@remofritzsche](https://github.com/remofritzsche) and [@ulissesalmeida](https://github.com/ulissesalmeida)
   * Make possible to use the Wrappers API to define attributes for the components.
-  See https://github.com/plataformatec/simple_form/pull/997 for more information.
+  See https://github.com/heartcombo/simple_form/pull/997 for more information.
   * Put a whitespace before the `inline_label` options of boolean input if it is present.
   * Add support to configure the `label_text` proc at the wrapper level. [@NOX73](https://github.com/NOX73)
   * `label_text` proc now receive three arguments (label, request, and if the label was explicit). [@timscott](https://github.com/timscott)
-  * Add I18n support to `:include_blank` and `:prompt` when `:translate` is used as value. [@haines](https://github.com/plataformatec/simple_form/pull/616)
+  * Add I18n support to `:include_blank` and `:prompt` when `:translate` is used as value. [@haines](https://github.com/heartcombo/simple_form/pull/616)
   * Add support to define custom error messages for the attributes.
   * Add support to change the I18n scope to be used in Simple Form. [@nielsbuus](https://github.com/nielsbuus)
   * The default form class can now be overridden with `html: { :class }`. [@rmm5t](https://github.com/rmm5t)
@@ -182,16 +223,16 @@ See http://blog.plataformatec.com.br/2019/09/incorrect-access-control-in-simple-
   * Fix `full_error` when the attribute is an association. [@mvdamme](https://github.com/jorge-d)
   * Fix suppport to `:namespace` and `:index` options for nested check boxes and radio buttons when the attribute is an association.
   * Collection input that uses automatic collection translation properly sets checked values.
-  Closes [#971](https://github.com/plataformatec/simple_form/issues/971) [@nashby](https://github.com/nashby)
+  Closes [#971](https://github.com/heartcombo/simple_form/issues/971) [@nashby](https://github.com/nashby)
   * Collection input generates `required` attribute if it has `prompt` option. [@nashby](https://github.com/nashby)
   * Grouped collection uses the first non-empty object to detect label and value methods.
 
 ## deprecation
   * Methods on custom inputs now accept a required argument with the wrapper options.
-  See https://github.com/plataformatec/simple_form/pull/997 for more information.
+  See https://github.com/heartcombo/simple_form/pull/997 for more information.
   * SimpleForm.form_class is deprecated in favor of SimpleForm.default_form_class.
   Future versions of Simple Form will not generate `simple_form` class for the form
   element.
-  See https://github.com/plataformatec/simple_form/pull/1109 for more information.
+  See https://github.com/heartcombo/simple_form/pull/1109 for more information.
 
-Please check [v3.0](https://github.com/plataformatec/simple_form/blob/v3.0/CHANGELOG.md) for previous changes.
+Please check [v3.0](https://github.com/heartcombo/simple_form/blob/v3.0/CHANGELOG.md) for previous changes.

data/MIT-LICENSE

@@ -1,4 +1,5 @@
-Copyright (c) 2009-2019 Plataformatec http://plataformatec.com.br/
+Copyright (c) 2020-2023 Rafael França, Carlos Antônio da Silva
+Copyright (c) 2009-2019 Plataformatec
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,6 +1,4 @@
-![Simple Form Logo](https://raw.github.com/plataformatec/simple_form/master/simple_form.png)
-
-By [Plataformatec](http://plataformatec.com.br/).
+![Simple Form Logo](https://raw.github.com/heartcombo/simple_form/main/simple_form.png)
 
 Rails forms made easy.
 
@@ -9,8 +7,44 @@ your forms. The basic goal of **Simple Form** is to not touch your way of defini
 you find the better design for your eyes. Most of the DSL was inherited from Formtastic,
 which we are thankful for and should make you feel right at home.
 
-INFO: This README is [also available in a friendly navigable format](http://simple-form.plataformatec.com.br/)
-and refers to **Simple Form** 3.1. For older releases, check the related branch for your version.
+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
 
@@ -32,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
 
@@ -118,8 +154,8 @@ of any of them:
 
 ```erb
 <%= simple_form_for @user do |f| %>
-  <%= f.input :username, label_html: { class: 'my_class' } %>
-  <%= f.input :password, hint: false, error_html: { id: 'password_error'} %>
+  <%= 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_confirmation, label: false %>
   <%= f.button :submit %>
 <% end %>
@@ -184,7 +220,7 @@ By default, **Simple Form** will look at the column type in the database and use
 appropriate input for the column. For example, a column created with type
 `:text` in the database will use a `textarea` input by default. See the section
 [Available input types and defaults for each column
-type](https://github.com/plataformatec/simple_form#available-input-types-and-defaults-for-each-column-type)
+type](https://github.com/heartcombo/simple_form#available-input-types-and-defaults-for-each-column-type)
 for a complete list of defaults.
 
 **Simple Form** also lets you overwrite the default input type it creates:
@@ -221,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 %>
 ```
@@ -288,7 +335,7 @@ end
 </form>
 ```
 
-To view the actual RDocs for this, check them out here - http://rubydoc.info/github/plataformatec/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
 
@@ -318,7 +365,7 @@ 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. 
+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:
@@ -329,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:
 
@@ -541,7 +587,7 @@ end
 To add a CSS class to the label item, you can use the `item_label_class` option:
 
 ```ruby
-f.collection_check_boxes :role_ids, Role.all, :id, :name, item_label_class: 'my-custom-class' 
+f.collection_check_boxes :role_ids, Role.all, :id, :name, item_label_class: 'my-custom-class'
 ```
 
 ## Available input types and defaults for each column type
@@ -561,6 +607,7 @@ Mapping         | Generated HTML Element               | Database Column Type
 `password`      | `input[type=password]`               | `string` with `name =~ /password/`
 `search`        | `input[type=search]`                 | -
 `uuid`          | `input[type=text]`                   | `uuid`
+`color`         | `input[type=color]`                  | `string`
 `text`          | `textarea`                           | `text`
 `hstore`        | `textarea`                           | `hstore`
 `json`          | `textarea`                           | `json`
@@ -991,7 +1038,7 @@ when the content is present.
 
 ## Custom Components
 
-When you use custom wrappers, you might also be looking for a way to add custom components to your 
+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
@@ -1064,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
@@ -1142,7 +1189,7 @@ by passing the html5 option:
 
 ### Using non Active Record objects
 
-There are few ways to build forms with objects that don't inherit from Active Record, as 
+There are few ways to build forms with objects that don't inherit from Active Record, as
 follows:
 
 You can include the module `ActiveModel::Model`.
@@ -1155,14 +1202,14 @@ class User
 end
 ```
 
-If you are using Presenters or Decorators that inherit from `SimpleDelegator` you can delegate 
+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 
+  def to_model
+    self
   end
 end
 ```
@@ -1170,7 +1217,7 @@ end
 You can define all methods required by the helpers.
 
 ```ruby
-class User 
+class User
   extend ActiveModel::Naming
 
   attr_accessor :id, :name
@@ -1179,25 +1226,25 @@ class User
     self
   end
 
-  def to_key 
-    id 
+  def to_key
+    id
   end
 
-  def persisted? 
-    false 
+  def persisted?
+    false
   end
 end
 ```
 
-If your object doesn't implement those methods, you must make explicit it when you are 
+If your object doesn't implement those methods, you must make explicit it when you are
 building the form
 
 ```ruby
-class User 
+class User
   attr_accessor :id, :name
 
   # The only method required to use the f.submit helper.
-  def persisted? 
+  def persisted?
     false
   end
 end
@@ -1205,25 +1252,25 @@ end
 
 ```erb
 <%= simple_form_for(@user, as: :user, method: :post, url: users_path) do |f| %>
-  <%= f.input :name %> 
+  <%= f.input :name %>
   <%= f.submit 'New user' %>
 <% end %>
 ```
 
 ## Information
 
-### Google Group
+### RDocs
 
-If you have any questions, comments, or concerns please use the Google Group instead of the GitHub
-Issues tracker:
+You can view the **Simple Form** documentation in RDoc format here:
 
-http://groups.google.com/group/plataformatec-simpleform
+http://rubydoc.info/github/heartcombo/simple_form/main/frames
 
-### RDocs
+### Supported Ruby / Rails versions
 
-You can view the **Simple Form** documentation in RDoc format here:
+We intend to maintain support for all Ruby / Rails versions that haven't reached end-of-life.
 
-http://rubydoc.info/github/plataformatec/simple_form/master/frames
+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
 
@@ -1231,23 +1278,21 @@ If you discover any bugs, feel free to create an issue on GitHub. Please add as
 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
+https://github.com/heartcombo/simple_form/issues
+
+If you have discovered a security related bug, please do NOT use the GitHub issue tracker. Send an e-mail to heartcombo@googlegroups.com.
 
 ## Maintainers
 
-* José Valim (https://github.com/josevalim)
 * Carlos Antonio da Silva (https://github.com/carlosantoniodasilva)
 * Rafael Mendonça França (https://github.com/rafaelfranca)
-* Vasiliy Ermolovich (https://github.com/nashby)
+* 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/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-ci.org/github/plataformatec/simple_form.png)](http://inch-ci.org/github/plataformatec/simple_form)
+[![Inline docs](http://inch-ci.org/github/heartcombo/simple_form.png)](http://inch-ci.org/github/heartcombo/simple_form)
 
 ## License
 
-MIT License. Copyright 2009-2019 Plataformatec. http://plataformatec.com.br
+MIT License. Copyright 2020-2023 Rafael França, Carlos Antônio da Silva. Copyright 2009-2019 Plataformatec.
 
-You are not granted rights or licenses to the trademarks of the Plataformatec, including without
-limitation the Simple Form name or logo.
+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

@@ -3,9 +3,8 @@
   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 the Bootstrap form
-  class, '.form-inline', as the following:
+  For usage examples and documentation, see:
 
-    = simple_form_for(@user, html: { class: 'form-inline' }) do |form|
+    https://simple-form-bootstrap.herokuapp.com
 
 ===============================================================================

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

@@ -2,7 +2,7 @@
 #
 # Uncomment this and change the path if necessary to include your own
 # components.
-# See https://github.com/plataformatec/simple_form#custom-components to know
+# See https://github.com/heartcombo/simple_form#custom-components to know
 # more about custom components.
 # Dir[Rails.root.join('lib/components/**/*.rb')].each { |f| require f }
 #
@@ -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