bootstrap_form 4.0.0.alpha1 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8eb7cf943e5416aff7a98a51666bee424be65eec12c55244a327c88d21a6d68d
-  data.tar.gz: 1ef48e511095bbab5bbef27ec4542019872f25fd5504834e51b1a253fd6dc1bf
+  metadata.gz: 02eeb0d89ce2c25d6c38aba37ec7ea381e8110ea31ac771cde6a0f92dc36823e
+  data.tar.gz: 3b8448de1c213e51e9a5b34b4c79328318297f0ee30b724f73a65d79f871bb70
 SHA512:
-  metadata.gz: 4022101ea8932a6ad3198cb9b517e65db477203633cbc31b9db4cb554ebf90cb73745ba4fe4f80dd3a5aca272a5ee92d18fc8955d391ece5e7eb6899f43600af
-  data.tar.gz: 5536da85294e55e980ed267576f84433e3adca060ecaad50594b7e600b9bb5d49a414ab75c559bb841e04f0ac1f336b24a64a0aaa05501f9e947e8e138a7d2cc
+  metadata.gz: 6abcc632e3ccda2b53d839b32cf8f1189a0eb8ccdff59864de232ebfee82df795ed77530bb7de10f12b2de0fecf75a318845030159b73a17e87aedc087150474
+  data.tar.gz: e111e67482e8ed21d54e441d82be365658aad122306d50571d0ae95e68cb7bb344af8906b4b35774a60cafef5757efe6566c642b795e20c3277ab4d23db9467d

data/CHANGELOG.md

@@ -12,6 +12,32 @@
 
 * Your contribution here!
 
+## [4.0.0][] (2018-10-27)
+
+🚨 **This release adds support for Bootstrap v4 and drops support for Bootstrap v3.** 🚨
+
+If your app uses Bootstrap v3, you should continue using bootstrap_form 2.7.x instead.
+
+Bootstrap v3 and v4 are very different, and thus bootstrap_form now produces different markup in order to target v4. The changes are too many to list here; you can refer to Bootstrap's [Migrating to v4](https://getbootstrap.com/docs/4.0/migration/) page for a detailed explanation.
+
+In addition to these necessary markup changes, the bootstrap_form API itself has the following important changes in this release.
+
+### Breaking changes
+
+* See [Migrating to v4](https://getbootstrap.com/docs/4.0/migration/).
+
+### New features
+
+* [#476] Give a way to pass classes to the `div.form-check` wrapper for check boxes and radio buttons - [@lcreid](https://github.com/lcreid).
+* [461](https://github.com/bootstrap-ruby/bootstrap_form/pull/461): default form-inline class applied to parent content div on date select helpers. Can override with a :skip_inline option on the field helper - [@lancecarlson](https://github.com/lancecarlson).
+* The `button`, `submit`, and `primary` helpers can now receive an additional option, `extra_class`. This option allows us to specify additional CSS classes to be added to the corresponding button/input, _while_ maintaining the original default ones. E.g., a primary button with an `extra_class` 'test-button' will have its final CSS classes declaration as 'btn btn-primary test-button'.
+
+### Bugfixes
+
+* [#347](https://github.com/bootstrap-ruby/bootstrap_form/issues/347) Fix `wrapper_class` and `wrapper` options for helpers that have `html_options`.
+* [#472](https://github.com/bootstrap-ruby/bootstrap_form/pull/472) Use `id` option value as `for` attribute of label for custom checkboxes and radio buttons.
+* [#478](https://github.com/bootstrap-ruby/bootstrap_form/issues/478) Fix offset for form group without label when multiple label widths are specified.
+
 
 ## [4.0.0.alpha1][] (2018-06-16)
 
@@ -49,6 +75,7 @@ In addition to these necessary markup changes, the bootstrap_form API itself has
 * [#449](https://github.com/bootstrap-ruby/bootstrap_form/pull/449): Passing `.form-row` overrides default `.form-group.row` in horizontal layouts.
 * Added an option to the `submit` (and `primary`, by transitivity) form tag helper, `render_as_button`, which when truthy makes the submit button render as a button instead of an input. This allows you to easily provide further styling to your form submission buttons, without requiring you to reinvent the wheel and use the `button` helper (and having to manually insert the typical Bootstrap classes). - [@jsaraiva](https://github.com/jsaraiva).
 * Add `:error_message` option to `check_box` and `radio_button`, so they can output validation error messages if needed. [@lcreid](https://github.com/lcreid).
+* Your contribution here!
 
 ### Bugfixes
 
@@ -216,7 +243,8 @@ Features:
   - Added support for bootstrap_form_tag (@baldwindavid)
 
 
-[Pending Release]: https://github.com/bootstrap-ruby/bootstrap_form/compare/v4.0.0.alpha1...HEAD
+[Pending Release]: https://github.com/bootstrap-ruby/bootstrap_form/compare/v4.0.0...HEAD
+[4.0.0]: https://github.com/bootstrap-ruby/bootstrap_form/compare/v4.0.0.alpha1...v4.0.0
 [4.0.0.alpha1]: https://github.com/bootstrap-ruby/bootstrap_form/compare/v2.7.0...v4.0.0.alpha1
 [2.7.0]: https://github.com/bootstrap-ruby/bootstrap_form/compare/v2.6.0...v2.7.0
 [2.6.0]: https://github.com/bootstrap-ruby/bootstrap_form/compare/v2.5.3...v2.6.0

data/Gemfile

@@ -6,6 +6,7 @@ gemspec
 # gem "rails", "~> 5.2.0.beta2"
 
 group :development do
+  gem "chandler", ">= 0.7.0"
   gem "htmlbeautifier"
 end
 

data/README.md

@@ -21,7 +21,7 @@ Bootstrap v4-style forms into your Rails application.
 Add it to your Gemfile:
 
 ```ruby
-gem "bootstrap_form", ">= 4.0.0.alpha1"
+gem "bootstrap_form", ">= 4.0.0"
 ```
 
 Then:
@@ -348,9 +348,15 @@ To display checkboxes and radios inline, pass the `inline: true` option:
 <% end %>
 ```
 
+Check boxes and radio buttons are wrapped in a `div.form-check`. You can add classes to this `div` with the `:wrapper_class` option:
+
+```erb
+<%= f.radio_button :skill_level, 0, label: "Novice", inline: true, wrapper_class: "w-auto" %>
+```
+
 #### Collections
 
-`bootstrap_form` also provides helpers that automatically creates the
+`bootstrap_form` also provides helpers that automatically create the
 `form_group` and the `radio_button`s or `check_box`es for you:
 
 ```erb
@@ -401,7 +407,7 @@ this defining these selects as `inline-block` and a width of `auto`.
 
 ### Submit Buttons
 
-The `btn btn-secondary` css classes are automatically added to your submit
+The `btn btn-secondary` CSS classes are automatically added to your submit
 buttons.
 
 ```erb
@@ -441,6 +447,29 @@ are equivalent, and each of them both be rendered as
 <button name="button" type="submit" class="btn btn-primary">Save changes <span class="fa fa-save"></span></button>
 ```
 
+If you wish to add additional CSS classes to your button, while keeping the
+default ones, you can use the `extra_class` option. This is particularly useful
+for adding extra details to buttons (without forcing you to repeat the
+Bootstrap classes), or for element targeting via CSS classes.
+Be aware, however, that using the `class` option will discard any extra classes
+you add. As an example, the following button declarations
+
+```erb
+<%= f.primary "My Nice Button", extra_class: 'my-button' %>
+
+<%= f.primary "My Button", class: 'my-button' %>
+```
+
+will be rendered as
+
+```html
+<input type="submit" value="My Nice Button" class="btn btn-primary my-button" />
+
+<input type="submit" value="My Button" class="my-button" />
+```
+
+(some unimportant HTML attributes have been removed for simplicity)
+
 ### Accessing Rails Form Helpers
 
 If you want to use the original Rails form helpers for a particular field,

data/RELEASING.md

@@ -0,0 +1,25 @@
+# Releasing
+
+Follow these steps to release a new version of bootstrap_form to rubygems.org.
+
+## Prerequisites
+
+* You must have commit rights to the bootstrap_form repository.
+* You must have push rights for the bootstrap_form gem on rubygems.org.
+* You must be using Ruby >= 2.2.
+* Your GitHub credentials must be available to Chandler via `~/.netrc` or an environment variable, [as explained here](https://github.com/mattbrictson/chandler#2-configure-credentials).
+
+## How to release
+
+1. Run `bundle install` to make sure that you have all the gems necessary for testing and releasing.
+2.  **Ensure the tests are passing by running `bundle exec rake`.**
+3. Determine which would be the correct next version number according to [semver](http://semver.org/).
+4. Update the version in `./lib/bootstrap_form/version.rb`.
+5. Update the `CHANGELOG.md` (for an illustration of these steps, refer to the [4.0.0.alpha1 commit](https://github.com/bootstrap-ruby/bootstrap_form/commit/8aac3667931a16537ab68038ec4cebce186bd596#diff-4ac32a78649ca5bdd8e0ba38b7006a1e) as an example):
+    * Rename the Pending Release section to `[version][] (date)` with appropriate values `version` and `date`
+    * Remove the "Your contribution here!" bullets from the release notes
+    * Add a new Pending Release section at the top of the file with a template for contributors to fill in, including "Your contribution here!" bullets
+    * Add the appropriate GitHub diff links to the footer of the document
+6. Update the installation instructions in `README.md` to use the new version.
+7. Commit the CHANGELOG and version changes in a single commit; the message should be "Preparing vX.Y.Z" where `X.Y.Z` is the version being released.
+8. Run `bundle exec rake release`; this will tag, push to GitHub, publish to rubygems.org, and upload the latest CHANGELOG entry to the [GitHub releases page](https://github.com/bootstrap-ruby/bootstrap_form/releases).

data/Rakefile

@@ -24,4 +24,10 @@ Rake::TestTask.new(:test) do |t|
   t.verbose = false
 end
 
+# This automatically updates GitHub Releases whenever we `rake release` the gem
+task "release:rubygem_push" do
+  require "chandler/tasks"
+  Rake.application.invoke_task("chandler:push")
+end
+
 task default: :test

data/lib/bootstrap_form/form_builder.rb

@@ -53,7 +53,11 @@ module BootstrapForm
 
       define_method(with_method_name) do |name, options = {}, html_options = {}|
         form_group_builder(name, options, html_options) do
-          content_tag(:div, class: control_specific_class(method_name)) do
+          html_class = control_specific_class(method_name)
+          if @layout == :horizontal && !options[:skip_inline].present?
+            html_class = "#{html_class} form-inline"
+          end
+          content_tag(:div, class: html_class) do
             input_with_error(name) do
               send(without_method_name, name, options, html_options)
             end
@@ -126,14 +130,24 @@ module BootstrapForm
 
     def check_box_with_bootstrap(name, options = {}, checked_value = "1", unchecked_value = "0", &block)
       options = options.symbolize_keys!
-      check_box_options = options.except(:label, :label_class, :error_message, :help, :inline, :custom, :hide_label, :skip_label)
+      check_box_options = options.except(:label, :label_class, :error_message, :help, :inline, :custom, :hide_label, :skip_label, :wrapper_class)
       check_box_classes = [check_box_options[:class]]
       check_box_classes << "position-static" if options[:skip_label] || options[:hide_label]
       check_box_classes << "is-invalid" if has_error?(name)
+
+      label_classes = [options[:label_class]]
+      label_classes << hide_class if options[:hide_label]
+
       if options[:custom]
         check_box_options[:class] = (["custom-control-input"] + check_box_classes).compact.join(' ')
+        wrapper_class = ["custom-control", "custom-checkbox"]
+        wrapper_class.append("custom-control-inline") if layout_inline?(options[:inline])
+        label_class = label_classes.prepend("custom-control-label").compact.join(" ")
       else
         check_box_options[:class] = (["form-check-input"] + check_box_classes).compact.join(' ')
+        wrapper_class = ["form-check"]
+        wrapper_class.append("form-check-inline") if layout_inline?(options[:inline])
+        label_class = label_classes.prepend("form-check-label").compact.join(" ")
       end
 
       checkbox_html = check_box_without_bootstrap(name, check_box_options, checked_value, unchecked_value)
@@ -149,39 +163,19 @@ module BootstrapForm
           "#{name}_#{checked_value.to_s.gsub(/\s/, "_").gsub(/[^-[[:word:]]]/, "").mb_chars.downcase.to_s}"
       end
 
-      label_classes = [options[:label_class]]
-      label_classes << hide_class if options[:hide_label]
+      label_options = { class: label_class }
+      label_options[:for] = options[:id] if options[:id].present?
 
-      if options[:custom]
-        div_class = ["custom-control", "custom-checkbox"]
-        div_class.append("custom-control-inline") if layout_inline?(options[:inline])
-        label_class = label_classes.prepend("custom-control-label").compact.join(" ")
-        content_tag(:div, class: div_class.compact.join(" ")) do
-          html = if options[:skip_label]
-            checkbox_html
-          else
-            # TODO: Notice we don't seem to pass the ID into the custom control.
-            checkbox_html.concat(label(label_name, label_description, class: label_class))
-          end
-          html.concat(generate_error(name)) if options[:error_message]
-          html
-        end
-      else
-        wrapper_class = "form-check"
-        wrapper_class += " form-check-inline" if layout_inline?(options[:inline])
-        label_class = label_classes.prepend("form-check-label").compact.join(" ")
-        content_tag(:div, class: wrapper_class) do
-          html = if options[:skip_label]
-            checkbox_html
-          else
-            checkbox_html
-              .concat(label(label_name,
-                            label_description,
-                            { class: label_class }.merge(options[:id].present? ? { for: options[:id] } : {})))
-          end
-          html.concat(generate_error(name)) if options[:error_message]
-          html
+      wrapper_class.append(options[:wrapper_class]) if options[:wrapper_class]
+
+      content_tag(:div, class: wrapper_class.compact.join(" ")) do
+        html = if options[:skip_label]
+          checkbox_html
+        else
+          checkbox_html.concat(label(label_name, label_description, label_options))
         end
+        html.concat(generate_error(name)) if options[:error_message]
+        html
       end
     end
 
@@ -189,49 +183,41 @@ module BootstrapForm
 
     def radio_button_with_bootstrap(name, value, *args)
       options = args.extract_options!.symbolize_keys!
-      radio_options = options.except(:label, :label_class, :error_message, :help, :inline, :custom, :hide_label, :skip_label)
+      radio_options = options.except(:label, :label_class, :error_message, :help, :inline, :custom, :hide_label, :skip_label, :wrapper_class)
       radio_classes = [options[:class]]
       radio_classes << "position-static" if options[:skip_label] || options[:hide_label]
       radio_classes << "is-invalid" if has_error?(name)
-      if options[:custom]
-        radio_options[:class] = radio_classes.prepend("custom-control-input").compact.join(' ')
-      else
-        radio_options[:class] = radio_classes.prepend("form-check-input").compact.join(' ')
-      end
-      radio_html = radio_button_without_bootstrap(name, value, radio_options)
 
-      disabled_class = " disabled" if options[:disabled]
       label_classes  = [options[:label_class]]
       label_classes << hide_class if options[:hide_label]
 
       if options[:custom]
-        div_class = ["custom-control", "custom-radio"]
-        div_class.append("custom-control-inline") if layout_inline?(options[:inline])
+        radio_options[:class] = radio_classes.prepend("custom-control-input").compact.join(' ')
+        wrapper_class = ["custom-control", "custom-radio"]
+        wrapper_class.append("custom-control-inline") if layout_inline?(options[:inline])
         label_class = label_classes.prepend("custom-control-label").compact.join(" ")
-        content_tag(:div, class: div_class.compact.join(" ")) do
-          html = if options[:skip_label]
-            radio_html
-          else
-            # TODO: Notice we don't seem to pass the ID into the custom control.
-            radio_html.concat(label(name, options[:label], value: value, class: label_class))
-          end
-          html.concat(generate_error(name)) if options[:error_message]
-          html
-        end
       else
-        wrapper_class = "form-check"
-        wrapper_class += " form-check-inline" if layout_inline?(options[:inline])
+        radio_options[:class] = radio_classes.prepend("form-check-input").compact.join(' ')
+        wrapper_class = ["form-check"]
+        wrapper_class.append("form-check-inline") if layout_inline?(options[:inline])
+        wrapper_class.append("disabled") if options[:disabled]
         label_class = label_classes.prepend("form-check-label").compact.join(" ")
-        content_tag(:div, class: "#{wrapper_class}#{disabled_class}") do
-          html = if options[:skip_label]
-            radio_html
-          else
-            radio_html
-              .concat(label(name, options[:label], { value: value, class: label_class }.merge(options[:id].present? ? { for: options[:id] } : {})))
-          end
-          html.concat(generate_error(name)) if options[:error_message]
-          html
+      end
+      radio_html = radio_button_without_bootstrap(name, value, radio_options)
+
+      label_options = { value: value, class: label_class }
+      label_options[:for] = options[:id] if options[:id].present?
+
+      wrapper_class.append(options[:wrapper_class]) if options[:wrapper_class]
+
+      content_tag(:div, class: wrapper_class.compact.join(" ")) do
+        html = if options[:skip_label]
+          radio_html
+        else
+          radio_html.concat(label(name, options[:label], label_options))
         end
+        html.concat(generate_error(name)) if options[:error_message]
+        html
       end
     end
 
@@ -340,7 +326,7 @@ module BootstrapForm
     end
 
     def offset_col(label_col)
-      label_col.sub(/^col-(\w+)-(\d)$/, 'offset-\1-\2')
+      label_col.gsub(/\bcol-(\w+)-(\d)\b/, 'offset-\1-\2')
     end
 
     def default_control_col
@@ -392,6 +378,10 @@ module BootstrapForm
 
     def form_group_builder(method, options, html_options = nil)
       options.symbolize_keys!
+
+      wrapper_class = options.delete(:wrapper_class)
+      wrapper_options = options.delete(:wrapper)
+
       html_options.symbolize_keys! if html_options
 
       # Add control_class; allow it to be overridden by :control_class option
@@ -402,8 +392,6 @@ module BootstrapForm
 
       options = convert_form_tag_options(method, options) if acts_like_form_tag
 
-      wrapper_class = css_options.delete(:wrapper_class)
-      wrapper_options = css_options.delete(:wrapper)
       help = options.delete(:help)
       icon = options.delete(:icon)
       label_col = options.delete(:label_col)

data/lib/bootstrap_form/helpers/bootstrap.rb

@@ -1,18 +1,19 @@
 module BootstrapForm
   module Helpers
     module Bootstrap
+
       def button(value = nil, options = {}, &block)
-        options.reverse_merge! class: 'btn btn-secondary'
+        setup_css_class 'btn btn-secondary', options
         super
       end
 
       def submit(name = nil, options = {})
-        options.reverse_merge! class: 'btn btn-secondary'
+        setup_css_class 'btn btn-secondary', options
         super
       end
 
       def primary(name = nil, options = {}, &block)
-        options.reverse_merge! class: 'btn btn-primary'
+        setup_css_class 'btn btn-primary', options
 
         if options[:render_as_button] || block_given?
           options.except! :render_as_button
@@ -34,9 +35,11 @@ module BootstrapForm
       end
 
       def error_summary
-        content_tag :ul, class: 'rails-bootstrap-forms-error-summary' do
-          object.errors.full_messages.each do |error|
-            concat content_tag(:li, error)
+        if object.errors.any?
+          content_tag :ul, class: 'rails-bootstrap-forms-error-summary' do
+            object.errors.full_messages.each do |error|
+              concat content_tag(:li, error)
+            end
           end
         end
       end
@@ -64,7 +67,7 @@ module BootstrapForm
           control_class: [options[:control_class], static_class].compact.join(" ")
         })
 
-        static_options[:value] = object.send(name) if static_options[:value].nil?
+        static_options[:value] = object.send(name) unless static_options.has_key?(:value)
 
         text_field_with_bootstrap(name, static_options)
       end
@@ -102,6 +105,19 @@ module BootstrapForm
       def static_class
         "form-control-plaintext"
       end
+
+
+      private
+
+        def setup_css_class(the_class, options = {})
+          unless options.has_key? :class
+            if extra_class = options.delete(:extra_class)
+              the_class = "#{the_class} #{extra_class}"
+            end
+            options[:class] = the_class
+          end
+        end
+
     end
   end
 end

data/lib/bootstrap_form/version.rb

@@ -1,3 +1,3 @@
 module BootstrapForm
-  VERSION = "4.0.0.alpha1".freeze
+  VERSION = "4.0.0".freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bootstrap_form
 version: !ruby/object:Gem::Version
-  version: 4.0.0.alpha1
+  version: 4.0.0
 platform: ruby
 authors:
 - Stephen Potenza
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-06-16 00:00:00.000000000 Z
+date: 2018-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -42,6 +42,7 @@ files:
 - Gemfile
 - LICENSE.txt
 - README.md
+- RELEASING.md
 - Rakefile
 - UPGRADE-4.0.md
 - app/assets/stylesheets/rails_bootstrap_forms.css
@@ -109,12 +110,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.2.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Rails form builder that makes it easy to style forms using Bootstrap 4