rails_bootstrap_form 0.9.3 → 0.9.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8bb2a8a391176d2d0e578b3ce1591c6f1f996cc8f5ebbb1ad6fcaddf9087be7e
-  data.tar.gz: a995a9c68d6509edc9f3327674783fb85c831f0107e269fc1ffbd75b98438b04
+  metadata.gz: c769ec63a2b3c1a8abaeaa8f8a8d11f7b473e71c69d7eb4fda3a4d200b9106e7
+  data.tar.gz: a477abf8d26482d15d9eb6a1a4dae62be453823def408d9958961945d81cfe97
 SHA512:
-  metadata.gz: 62c3811ebcb7356b7e5333c48146f2f2958aa16ecefc71cd7c9a05dcb1bafac659d019484e26a1bb5b0e901d1cbc041b9d88509816cb270a6ceb11a870252a12
-  data.tar.gz: d395785a7267dd780584e0ca968faf265e9ca5d637e206d66fa46a7c77da69b71314ae397b02a5a8b6e4bb6cb1cbc79dfcecf62ddbc11b2951af733668ee2a8e
+  metadata.gz: 6394304b9d69627c1032d8392a6cb586964f9dce3e0d948aeaf0854303ae222f26f9a357e4df40f41c4f42e4d381140d27cf3cb65b2d1582c2a0f8400895be72
+  data.tar.gz: fb8f1d8a37574de977551917b2e0b1577c2240d6443f48e7ac9d65fff3ca97939eaea6c97f54e88eb5d1322aed18c4336b4d6f440594b8089372d5185013ef6d

data/CHANGELOG.md

@@ -4,6 +4,24 @@ You can find recent releases with docs in GitHub:
 
 https://github.com/shivam091/rails_bootstrap_form/releases
 
+## [0.9.4](https://github.com/shivam091/rails_bootstrap_form/compare/v0.9.3...v0.9.4) - 2023-06-17
+
+### What's new
+
+- Added specs for field helpers.
+
+### What's changed
+
+- Change to take `additional_field_class` precedence over HTML `class` ([#42](https://github.com/shivam091/rails_bootstrap_form/issues/42))
+- Change to `collection_check_boxes` and `collection_radio buttons` to render inline `check boxes` and
+  `radio buttons`, respectively when form layout is inline. ([#43](https://github.com/shivam091/rails_bootstrap_form/issues/43))
+
+### What's fixed
+
+- Fixed bug causing `skip_label` option not to work in `radio_button` and `check_box` ([#37](https://github.com/shivam091/rails_bootstrap_form/issues/37))
+- Fixed bug causing `additional_field_class` to apply on `radio_button` and `check_box` ([#40](https://github.com/shivam091/rails_bootstrap_form/issues/40))
+- Fixed bug causing `bootstrap` options to not set on `static_field` ([#41](https://github.com/shivam091/rails_bootstrap_form/issues/41))
+
 ## [0.9.3](https://github.com/shivam091/rails_bootstrap_form/compare/v0.9.2...v0.9.3) - 2023-06-04
 
 ### What's changed

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rails_bootstrap_form (0.9.3)
+    rails_bootstrap_form (0.9.4)
       actionpack (~> 7.0)
       activemodel (~> 7.0)
 

data/README.md

@@ -4,7 +4,7 @@
 [![Gem Version](https://badge.fury.io/rb/rails_bootstrap_form.svg)](https://badge.fury.io/rb/rails_bootstrap_form)
 
 **rails_bootstrap_form** is a Rails form builder that makes it super easy to integrate [Bootstrap 5](https://getbootstrap.com/) forms into your Rails application.
-`rails_bootstrap_forms`'s form helpers generate the form field and its label along with all the Bootstrap mark-up required for proper Bootstrap display.
+`rails_bootstrap_form`'s form helpers generate the form field and its label along with all the Bootstrap mark-up required for proper Bootstrap display.
 
 ## Minimum Requirements
 
@@ -28,7 +28,7 @@ for setting up `application.scss` and `application.js`.
 Add the `rails_bootstrap_form` gem to your `Gemfile`:
 
 ```ruby
-gem "rails_bootstrap_form", "~> 0.8.2"
+gem "rails_bootstrap_form", "~> 0.9.4"
 ```
 
 Then:
@@ -64,7 +64,7 @@ Example:
 # config/initializers/rails_bootstrap_form.rb
 RailsBootstrapForm.configure do |config|
   # to make forms non-compliant with W3C.
-  config.default_form_attributes = {role: "form", novalidate: true}
+  config.default_form_attributes = {novalidate: true}
 end
 ```
 
@@ -72,7 +72,7 @@ The current configuration options are:
 
 | Option | Default value | Description |
 |---------------------------|------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| `default_form_attributes` | | Set this option to `{role: "form"}` to make forms non-compliant with W3C, but generate the `role="form"` attribute. |
+| `default_form_attributes` | | Set this option to `{novalidate: true}` to instruct `rails_bootstrap_form` to skip all HTML 5 validation. |
 
 ## Usage
 
@@ -161,7 +161,6 @@ Here's a list of all possible options you can pass via `bootstrap` option that c
 | `disabled` | An option to disable **rails_bootstrap_form** helpers. Default rails form builder element is rendered when set to `true` | `false` |
 | `layout` | Controls layout of form and field helpers. It can be `vertical` `horizontal`, or `inline`. | `vertical` |
 | `field_class` | A CSS class that will be applied to all form fields. | `form-control` |
-| `additional_field_class` | An additional CSS class that will be added along with the existing css classes of field helpers. | `nil` |
 | `help_text` | Describes help text for the HTML field. Help text is automatically read from translation file. If you want to customize it, you can pass a string. You can also set it `false` if you do not want help text displayed. | `nil` |
 | `label_text` | An option to customize automatically generated label text. | `nil` |
 | `skip_label` | An option to control whether the label is to be displayed or not. | `false` |
@@ -183,7 +182,7 @@ Here's a list of all possible options you can pass via `bootstrap` option that c
 | `field_col_wrapper_class` | A CSS class for field column when layout is `horizontal`. | `col-sm-10` |
 | `render_as_button` | An option to render submit button using `<button type="submit">` instead of `<input type="submit">`. | `false` |
 
-Options applied on the form level will apply to all field helpers. Options applied on field helpers will override form-level options.
+Options defined on the form level will apply to all field helpers. Options defined on field helpers takes precedence over form-level options.
 Here's an example of a form where one field uses different layout:
 
 ![bootstrap_option_override](https://github.com/shivam091/rails_bootstrap_form/assets/7858927/9d312870-033f-4bc4-922b-1b65df202352)
@@ -235,9 +234,15 @@ You can completely disable bootstrap and use default form builder by passing `di
 <%= form.text_field :username, bootstrap: {disabled: true} %>
 ```
 
+This generates the following HTML:
+
+```html
+<input type="text" name="user[username]" id="user_username">
+```
+
 ### Disabling wrapper
 
-In some cases, you may need to disable the default wrapper. You can do this by passing 'wrapper: false':
+In some cases, you may need to disable the default wrapper. You can do this by passing `wrapper: false` option:
 
 ![wrapper_false](https://github.com/shivam091/rails_bootstrap_form/assets/7858927/1693cf0f-7a30-494d-9fb5-394f4fb2c676)
 
@@ -252,6 +257,53 @@ This generates the following HTML:
 <input class="form-control" aria-required="true" required="required" type="text" name="user[name]" id="user_name">
 ```
 
+### Add additional CSS class
+
+You can use `additional_field_class` option at form or field level to add extra CSS classes to the fields.
+
+```erb
+<%= form.text_field :name, autocomplete: "new-name", bootstrap: {additional_field_class: "custom-class"} %>
+```
+
+This generates the following HTML:
+
+```html
+<div class="mb-3">
+  <label class="form-label required" for="user_name">Name</label>
+  <input autocomplete="new-name" class="form-control custom-class" aria-required="true" required="required" type="text" name="user[name]" id="user_name">
+</div>
+```
+
+You can also use HTML `class` attribute to add additional CSS class to the single field:
+
+```erb
+<%= form.text_field :name, autocomplete: "new-name", class: "custom-class" %>
+```
+
+This generates the following HTML:
+
+```html
+<div class="mb-3">
+  <label class="form-label required" for="user_name">Name</label>
+  <input autocomplete="new-name" class="form-control custom-class" aria-required="true" required="required" type="text" name="user[name]" id="user_name">
+</div>
+```
+
+Here `additional_field_class` option takes precedance over HTML `class` attribute:
+
+```erb
+<%= form.text_field :name, autocomplete: "new-name", bootstrap: {additional_field_class: "custom-class"}, class: "html-class" %>
+```
+
+This generates the following HTML:
+
+```html
+<div class="mb-3">
+  <label class="form-label required" for="user_name">Name</label>
+  <input autocomplete="new-name" class="form-control custom-class" aria-required="true" required="required" type="text" name="user[name]" id="user_name">
+</div>
+```
+
 ## Supported Form Helpers
 
 This gem wraps most of the form field helpers. Here's the current list:
@@ -274,7 +326,7 @@ url_field                    week_field                   weekday_select
 
 ### Vertical Layout
 
-This layout is default layout for the form in which labels are above the fields and labels and fields take 100% of the width.
+This layout is default layout for the form in which labels are above the fields. In this layout, labels and fields take 100% of the width.
 
 Here's an example of how it looks like:
 
@@ -308,7 +360,7 @@ This generates the following HTML:
 
 If you want to align label and field side by side, you can use horizontal layout for the form.
 You can optionally override `label_col_wrapper_class` and `field_col_wrapper_class` (they default to `col-sm-2` and `col-sm-10`) at either form level
-or field helpers if want to customize space between label and field.
+or field level if want to customize space between label and field.
 
 Here's an example of how it looks like by default:
 
@@ -341,7 +393,7 @@ This generates the following HTML:
 </form>
 ```
 
-The `label_col_wrapper_class` and `field_col_wrapper_class` css classes can also be changed per control:
+The `label_col_wrapper_class` and `field_col_wrapper_class` css classes can also be customized per control:
 
 ![horizontal_form_custom_classes](https://github.com/shivam091/rails_bootstrap_form/assets/7858927/ae5492f0-4a10-4f63-ae4d-9675bfb93226)
 
@@ -454,7 +506,7 @@ This generates the following HTML:
 </div>
 ```
 
-To hide a label, you can set `hide_label` option to `true`. This adds the `visually-hidden` class, which keeps your labels accessible
+To hide a label, you can set `hide_label: true` option. This adds the `visually-hidden` class, which keeps your labels accessible
 to those using screen readers.
 
 ![hide_label](https://github.com/shivam091/rails_bootstrap_form/assets/7858927/512a16b9-6829-40a2-bf07-f087970c9dac)
@@ -472,7 +524,7 @@ This generates the following HTML:
 </div>
 ```
 
-To skip a label, you can set `skip_label` option to `true`. This will not render label in a field wrapper.
+To skip a label, you can set `skip_label: true` option. This will not render label in a field wrapper.
 
 ![skip_label](https://github.com/shivam091/rails_bootstrap_form/assets/7858927/251e28ac-b98b-4e6a-8d55-8c0cb061e65a)
 
@@ -552,7 +604,7 @@ This generates the following HTML:
 </div>
 ```
 
-You can also disable help text by setting `help_text` option to `false`:
+You can also disable help text by setting `help_text: false` option:
 
 ![help_text_false](https://github.com/shivam091/rails_bootstrap_form/assets/7858927/be1a229a-cffd-447d-b846-9b9588b1b25e)
 
@@ -707,7 +759,7 @@ This generates the following HTML:
 </div>
 ```
 
-You can set `switch` option to `true` if you want check box to look like switches.
+You can set `switch: true` option if you want check box to look like switches.
 
 ![check_box_switch](https://github.com/shivam091/rails_bootstrap_form/assets/7858927/20c493ce-7f2c-4ac9-a854-e1520cae6a54)
 
@@ -845,7 +897,7 @@ This generates the following HTML:
 
 Our `fields_for` helper accepts the same arguments as the [default Rails helper](https://api.rubyonrails.org/classes/ActionView/Helpers/FormHelper.html#method-i-fields_for).
 
-`rails_bootstrap_form` allows us to set `bootstrap` option just like `bootstrap_form_for` and `bootstrap_form_with`. By setting this option on fields_for, it applies to all the fields defined for that form:
+`rails_bootstrap_form` allows us to set `bootstrap` option just like `bootstrap_form_for` and `bootstrap_form_with`. By setting this option on `fields_for`, it applies to all the fields defined for that nested form:
 
 ![fields_for](https://github.com/shivam091/rails_bootstrap_form/assets/7858927/f515302f-a92a-4b5c-a444-af91cbb00dff)
 
@@ -1441,7 +1493,7 @@ an argument and takes care of rendering labels, check boxes, and wrapper for you
 ![collection_check_boxes](https://github.com/shivam091/rails_bootstrap_form/assets/7858927/c92f5921-e572-4384-812e-31308e018f66)
 
 ```erb
-<%= form.collection_check_boxes :skill_ids, ::Skill.all, :id, :name, {bootstrap: {layout: :horizontal, inline: true}, onchange: "this.form.submit();"}, {} %>
+<%= form.collection_check_boxes :skill_ids, ::Skill.all, :id, :name, {multiple: true, bootstrap: {layout: :horizontal, inline: true}, onchange: "this.form.submit();"}, {} %>
 ```
 
 This generates the following HTML:
@@ -1498,6 +1550,8 @@ This generates the following HTML:
 </div>
 ```
 
+_If form layout is inline, `collection_check_boxes` always render `inline` check boxes._
+
 ### collection_radio_buttons
 
 This helper provides a way to create collection of radio buttons. This helper accepts same arguments as [default Rails helper](https://api.rubyonrails.org/classes/ActionView/Helpers/FormOptionsHelper.html#method-i-collection_radio_buttons) except it don't accept a `block` as
@@ -1538,6 +1592,8 @@ This generates the following HTML:
 </div>
 ```
 
+_If form layout is inline, `collection_check_boxes` always render `inline` check boxes._
+
 ## Date Helpers
 
 The multiple selects that the date and time helpers (`date_select`, `time_select`, `datetime_select`) generate are wrapped inside a `fieldset.rails-bootstrap-forms-[date|time|datetime]-select` tag.
@@ -1710,7 +1766,7 @@ This generates the following HTML:
 ## Submit Buttons
 
 `rails_bootstrap_form` allows to easily create submit button for the form. `rails_bootstrap_form` supports three color variants for submit buttons: `secondary`, `primary`, and `danger`. Submit buttons are supported in `vertical`, `horizontal`, and `inline` layout.
-Submit buttons in inline form are wrapped inside `div.col-12` to properly render on small width devices.
+Submit buttons in inline form are wrapped inside `div.col-12` to properly align on small width devices.
 
 ![button_helpers](https://github.com/shivam091/rails_bootstrap_form/assets/7858927/f41a013b-b8c9-4689-a079-b8b102084cf0)
 
@@ -1743,7 +1799,7 @@ This generates the following HTML:
 <input type="submit" name="commit" value="Register" class="register-button btn btn-primary" data-disable-with="Register">
 ```
 
-To render submit helper as a button helper, you can set `render_as_button` option to `true` or pass a block.
+To render submit helper as a button helper, you can set `render_as_button: true` option or pass a block.
 
 ![render_as_button](https://github.com/shivam091/rails_bootstrap_form/assets/7858927/dffd72d8-3acf-4029-be04-3bf7776e8d9c)
 
@@ -1786,6 +1842,8 @@ This generates the following HTML:
 </div>
 ```
 
+_`static_field` supports all the bootstrap options which are supported by `text_field`._
+
 ## Floating Labels
 
 The `floating` option can be used to enable Bootstrap floating labels. This option is supported on text fields, text areas and dropdowns. Here's an example:
@@ -1850,7 +1908,7 @@ This generates the following HTML:
 </form>
 ```
 
-_Floating labels gets disabled by `rails_bootstrap_form` automatically for unsupported helpers._
+_`rails_bootstrap_form` automatically disables floating labels for unsupported helpers._
 
 ## Validation and Errors
 
@@ -1913,6 +1971,9 @@ This generates the following HTML:
 </div>
 ```
 
+The `has-validation` CSS class is added to an input group when the field has errors.
+The `is-invalid` CSS class is added to floating label container when field with floating label has errors.
+
 ## Required Fields
 
 A label that is associated with a mandatory field is automatically annotated with a `required` CSS class. `rails_bootstrap_form` provides styling for required fields.

data/lib/generators/rails_bootstrap_form/templates/install.rb

@@ -6,5 +6,5 @@
 
 RailsBootstrapForm.configure do |config|
   # to make forms non-compliant with W3C.
-  config.default_form_attributes = {role: "form", novalidate: true}
+  config.default_form_attributes = {novalidate: true}
 end

data/lib/rails_bootstrap_form/field_wrapper_builder.rb

@@ -72,11 +72,7 @@ module RailsBootstrapForm
     def field_css_options(attribute, bootstrap, options, html_options)
       css_options = (html_options || options)
 
-      field_classes = Array(options[:class])
-      field_classes << [
-        bootstrap.field_class,
-        bootstrap.additional_field_class
-      ]
+      field_classes = Array(bootstrap.field_class) << [bootstrap.additional_field_class || options[:class]]
       field_classes << "is-invalid" if is_invalid?(attribute)
       if is_size_valid?(bootstrap)
         field_classes << "#{bootstrap.field_class}-#{bootstrap.size}"

data/lib/rails_bootstrap_form/helpers/choice.rb

@@ -10,21 +10,23 @@ module RailsBootstrapForm
       def self.included(base_class)
         [:check_box, :radio_button].each do |tag_name|
           define_method("#{tag_name}_label") do |attribute, value, options, bootstrap|
-            label_options = {
-              class: choice_label_classes(attribute, bootstrap, options)
-            }
-            label_options[:value] = value if tag_name.eql?(:radio_button)
-            label_options[:for] = options[:id] if options[:id].present?
+            unless bootstrap.skip_label?
+              label_options = {
+                class: choice_label_classes(attribute, bootstrap, options)
+              }
+              label_options[:value] = value if tag_name.eql?(:radio_button)
+              label_options[:for] = options[:id] if options[:id].present?
 
-            label_text = label_text(attribute, bootstrap)
+              label_text = label_text(attribute, bootstrap)
 
-            label(attribute, label_text, label_options)
+              label(attribute, label_text, label_options)
+            end
           end
         end
 
         [:check_box, :radio_button].each do |tag_name|
           define_method("bootstrap_#{tag_name}") do |attribute, value, options, bootstrap|
-            options[:class] = choice_classes(attribute, options)
+            options[:class] = choice_classes(attribute, bootstrap, options)
 
             if tag_name.eql?(:check_box)
               choice_field = check_box_without_bootstrap(attribute, options, value, nil)
@@ -38,8 +40,8 @@ module RailsBootstrapForm
           end
         end
 
-        def choice_classes(attribute, options)
-          classes = Array("form-check-input") << options[:class]
+        def choice_classes(attribute, bootstrap, options)
+          classes = Array("form-check-input") << [bootstrap.additional_field_class || options[:class]]
           classes << "is-invalid" if is_invalid?(attribute)
           classes.flatten.compact
         end

data/lib/rails_bootstrap_form/helpers.rb

@@ -45,14 +45,13 @@ module RailsBootstrapForm
         options[:class] = the_class if the_class.present?
       end
 
-      def remove_css_class!(options, css_class)
-        the_class = options[:class].to_s.split(" ")
-        options[:class] = (the_class - [css_class]).compact.join(" ")
-        options.delete(:class) if options[:class].blank?
-      end
+      # def remove_css_class!(options, css_class)
+      #   the_class = options[:class].to_s.split(" ")
+      #   options[:class] = (the_class - [css_class]).compact.join(" ")
+      #   options.delete(:class) if options[:class].blank?
+      # end
 
-      private :control_specific_class, :is_size_valid?, :add_css_class!,
-              :remove_css_class!
+      private :control_specific_class, :is_size_valid?, :add_css_class!
     end
   end
 end

data/lib/rails_bootstrap_form/inputs/base.rb

@@ -17,7 +17,7 @@ module RailsBootstrapForm
             input_options = {
               bootstrap: {
                 label_text: text_method.respond_to?(:call) ? text_method.call(object) : object.send(text_method),
-                inline: bootstrap.inline?
+                inline: (bootstrap.inline? || bootstrap.layout_inline?) 
               },
               required: false,
               id: sanitized_tag_name(attribute, value)

data/lib/rails_bootstrap_form/inputs/static_field.rb

@@ -17,7 +17,7 @@ module RailsBootstrapForm
             disabled: true,
             bootstrap: {
               field_class: bootstrap_form_options.static_field_class
-            }
+            }.reverse_merge!(options.delete(:bootstrap))
           )
 
           static_options[:value] = object.send(attribute) unless options.key?(:value)

data/lib/rails_bootstrap_form/version.rb

@@ -3,6 +3,6 @@
 # -*- warn_indent: true -*-
 
 module RailsBootstrapForm
-  VERSION = "0.9.3".freeze
+  VERSION = "0.9.4".freeze
   REQUIRED_RAILS_VERSION = "~> 7.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_bootstrap_form
 version: !ruby/object:Gem::Version
-  version: 0.9.3
+  version: 0.9.4
 platform: ruby
 authors:
 - Harshal LADHE (shivam091)
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-06-04 00:00:00.000000000 Z
+date: 2023-06-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: generator_spec