bootstrap_form 2.7.0 → 4.0.0.alpha1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 41c3a580253c0f5779afb58401a47f0105cdd873
-  data.tar.gz: 4588b91f6cb9b9aab4e2df9aa3d7a6de009fd834
+SHA256:
+  metadata.gz: 8eb7cf943e5416aff7a98a51666bee424be65eec12c55244a327c88d21a6d68d
+  data.tar.gz: 1ef48e511095bbab5bbef27ec4542019872f25fd5504834e51b1a253fd6dc1bf
 SHA512:
-  metadata.gz: a0397c4d48b99bee8a4c270587b6aa642489b6debc23a05e8ab06fdffe53d21ee6918c40cf9bb54bdec08875e835ba6b10def50e12781ec8b7977d3916456a1a
-  data.tar.gz: 5ce6f17e04659531c7db6fd9cd8d055e5622b96295b75534e8193a7cfe3df7537adba7d8d26c72f0acb94f2828c2cf105a31a72013327011a869118419e03a4b
+  metadata.gz: 4022101ea8932a6ad3198cb9b517e65db477203633cbc31b9db4cb554ebf90cb73745ba4fe4f80dd3a5aca272a5ee92d18fc8955d391ece5e7eb6899f43600af
+  data.tar.gz: 5536da85294e55e980ed267576f84433e3adca060ecaad50594b7e600b9bb5d49a414ab75c559bb841e04f0ac1f336b24a64a0aaa05501f9e947e8e138a7d2cc

data/.gitignore

@@ -0,0 +1,14 @@
+.bundle/
+log/*.log
+pkg/
+demo/db/*.sqlite3
+demo/log/*.log
+demo/tmp/
+*.gem
+.rbenv-gemsets
+*.swp
+Gemfile.lock
+test/gemfiles/*.lock
+.ruby-version
+Vagrantfile
+.vagrant

data/.travis.yml

@@ -0,0 +1,29 @@
+language: ruby
+rvm:
+  - 2.2.9
+  - 2.3.6
+  - 2.4.3
+  - 2.5.0
+gemfile:
+  - test/gemfiles/5.0.gemfile
+  - test/gemfiles/5.1.gemfile
+  - test/gemfiles/5.2.gemfile
+before_install:
+  - gem update --system
+  - gem install bundler --no-document
+
+matrix:
+  include:
+    # Bleeding edge
+    - rvm: ruby-head
+      gemfile: test/gemfiles/5.2.gemfile
+
+    # Running one job to execute DANGER bot
+    - rvm: 2.5.0
+      gemfile: test/gemfiles/5.2.gemfile
+      script:
+        - gem install danger
+        - danger
+
+  allow_failures:
+    - rvm: ruby-head

data/CHANGELOG.md

@@ -0,0 +1,227 @@
+## [Pending Release][]
+
+### Breaking changes
+
+* Your contribution here!
+
+### New features
+
+* Your contribution here!
+
+### Bugfixes
+
+* Your contribution here!
+
+
+## [4.0.0.alpha1][] (2018-06-16)
+
+🚨 **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
+
+* Rails 4.x is no longer supported
+* Ruby 2.2 or newer is required
+* Built-in support for the `nested_form` gem has been completely removed
+* The `icon` option is no longer supported (Bootstrap v4 does not include icons)
+* The deprecated Rails methods `check_boxes_collection` and `radio_buttons_collection` have been removed
+* `hide_label: true` and `skip_label: true` on individual check boxes and radio buttons apply Bootstrap 4 markup. This means the appearance of a page may change if you're upgrading from the Bootstrap 3 version of `bootstrap_form`, and you used `check_box` or `radio_button` with either of those options
+* `static_control` will no longer properly show error messages. This is the result of bootstrap changes.
+* `static_control` will also no longer accept a block, use the `value` option instead.
+* `form_group` with a block that produces arbitrary text needs to be modified to produce validation error messages (see the UPGRADE-4.0 document). [@lcreid](https://github.com/lcreid).
+* `form_group` with a block that contains more than one `check_box` or `radio_button` needs to be modified to produce validation error messages (see the UPGRADE-4.0 document). [@lcreid](https://github.com/lcreid).
+* [#456](https://github.com/bootstrap-ruby/bootstrap_form/pull/456): Fix label `for` attribute when passing non-english characters using `collection_check_boxes` - [@ug0](https://github.com/ug0).
+* [#449](https://github.com/bootstrap-ruby/bootstrap_form/pull/449): Bootstrap 4 no longer mixes in `.row` in `.form-group`. `bootstrap_form` adds `.row` to `div.form-group` when layout is horizontal.
+
+### New features
+
+* Support for Rails 5.1 `form_with` - [@lcreid](https://github.com/lcreid).
+* Support Bootstrap v4's [Custom Checkboxes and Radios](https://getbootstrap.com/docs/4.0/components/forms/#checkboxes-and-radios-1) with a new `custom: true` option
+* Allow HTML in help translations by using the `_html` suffix on the key - [@unikitty37](https://github.com/unikitty37)
+* [#408](https://github.com/bootstrap-ruby/bootstrap_form/pull/408): Add option[:id] on static control #245 - [@duleorlovic](https://github.com/duleorlovic).
+* [#455](https://github.com/bootstrap-ruby/bootstrap_form/pull/455): Support for i18n `:html` subkeys in help text - [@jsaraiva](https://github.com/jsaraiva).
+* Adds support for `label_as_placeholder` option, which will set the label text as an input fields placeholder (and hiding the label for sr_only).
+* [#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).
+
+### Bugfixes
+
+* [#357](https://github.com/bootstrap-ruby/bootstrap_form/pull/357) if provided,
+  use html option `id` to specify `for` attribute on label
+  [@duleorlovic](https://github.com/duleorlovic)
+
+
+## [2.7.0][] (2017-04-21)
+
+Features:
+  * [#325](https://github.com/bootstrap-ruby/bootstrap_form/pull/325): Support :prepend and :append for the `select` helper - [@donv](https://github.com/donv).
+
+## [2.6.0][] (2017-02-03)
+
+Bugfixes:
+  - Fix ambiguous first argument warning (#311, @mikenicklas)
+
+Features:
+  - Add a FormBuilder#custom_control helper [#289](https://github.com/bootstrap-ruby/bootstrap_form/pull/289)
+
+## [2.5.3][] (2016-12-23)
+
+There are no user-facing changes with this release. Behind the scenes, the tests have been greatly improved. The project is now tested against and compatible with the following Rails versions 4.0, 4.1, 4.2 and 5.0 (#278).
+
+## [2.5.2][] (2016-10-08)
+
+Bugfixes:
+  - Allow objects without `model_name`s to act as form objects (#295, @laserlemon)
+  - Fix offset for submit for horizontal forms when using non-sm column breakers for label column (#293, @oteyatosys)
+
+## [2.5.1][] (2016-09-23)
+
+Bugfixes:
+  - Fix getting help text for elements when using anonymous models (see [issue 282](https://github.com/bootstrap-ruby/bootstrap_form/issues/282))
+
+## [2.5.0][] (2016-08-12)
+
+Bugfixes:
+
+  - Sanitize <label> name (IE `for` attribute) in same manner that Rails sanitizes
+    the <input> `id` attribute to fix a11y issue with `for` and `id` mismatch
+  - Fix loading of ActionView helpers in combination with RSpec and `rails-controller-testing`. (see [rails-controller-testing/issues#24](https://github.com/rails/rails-controller-testing/issues/24))
+
+Features:
+
+  - Add support for input-group-sm and input-group-lg in prepend/append (#226, @rusanu)
+  - Added option to prevent the 'required' CSS class on labels (#205, @LucasAU)
+
+## [2.4.0][] (2016-07-04)
+
+This version is ready to use with Rails 5.0.0!
+
+Bugfixes:
+
+  - Minor README corrections (#184, @msmithstubbs)
+  - Fix `alias_method_chain` deprecation warnings when using Rails 5
+  - Allow `form_group` to work with frozen string options
+
+Features:
+
+  - Allow primary button classes to be overridden (#183, @tanimichi)
+  - Allow to pass a block to select helper in Rails >= 4.1.0 (#229, @doits)
+
+## 2.3.0 (2015-02-17)
+
+Bugfixes:
+
+  - Use #underscore, not #downcase for help text scope (#140, @atipugin)
+  - Radio button and checkbox labels will now include the disabled class as needed. (#156, @ScottSwezey)
+  - Fixed issue with setting offset in form_group without label in horizontal layout
+    when form uses non-default label_col
+  - Fixed wrapper options (#153, @veilleperso)
+  - Fix errors on non-ActiveRecord setups (#200, @sgnn7)
+
+Features:
+
+  - Allow users to display validation errors in labels (#144, @timcheadle)
+  - Use humanized attribute name in label errors (#146, @atipugin)
+  - Allow to skip label rendering (#145, @atipugin)
+  - Added a `required` CSS class for labels with required attributes (#150, @krsyoung)
+  - Added option to customize labels' class.
+  - Allow callable value_method and text_method for collection_check_boxes and collection_radio_buttons (#199, @shadwell)
+
+## 2.2.0 (2014-09-16)
+
+Bugfixes:
+
+  - Fixed an exception raised when form_group block returns nil (#111)
+  - Fixed an exception on human_attribute_name when using bootstrap_form_tag (#115)
+  - Set offset in form_group without label in horizontal layout (#94, @datWav)
+  - Fixes an offset bug in form_group without a given label in horizontal layout (#130, @datWav)
+  - Fixed bug where collection_check_boxes doesn't work if all are unchecked (#116, @burnt43)
+
+Features:
+
+  - Added the ability to append/prepend buttons (@retoo)
+  - Added support for time_zone_select
+  - Accept multiple values, and objects as well, on `collection_check_boxes`
+    checked option (#114)
+  - Added support for hidding attribute name in errors_on helper (@datWav)
+  - Added support for additional class to the wrapper form_group by a field (@datWav)
+  - Support showing error summaries when inline_errors is enabled (@rosswilson)
+  - Name is now optional when creating static controls
+  - Keep original form helper methods with _without_bootstrap suffix (#123, @a2ikm)
+  - Added glyphicon support
+  - Added i18n support for help messages (#122, @huynhquancam)
+  - Added the ability to pass any attributes to wrapper (#136, @atipugin)
+  - Split monolithic test file into several smaller files (#141, @spacewander)
+  - Added role="form" attribute to forms (#142, @spacewander)
+
+## 2.1.1 (2014-04-20)
+
+Bugfixes:
+
+  - Do not reset additional classes on the form-group (@rzane)
+  - Fixed an exception when specifying a label while using bootstrap_form_tag
+
+Features:
+
+  - [nested_form](https://github.com/ryanb/nested_form) integration via
+    `bootstrap_nested_form_for` (#44 and #66)
+  - `form_group` no longer requires a name (#83)
+
+## 2.1.0 (2014-04-01)
+
+Moved GitHub repository from https://github.com/potenza/bootstrap_form
+to https://github.com/bootstrap-ruby/bootstrap_form
+
+Bugfixes:
+
+  - i18n fix for checkbox labels (@i10a)
+  - Wrapped date & time helpers inside control-specific css classes to prevent stacking
+  - control-label class was not being added unless the form was horizontal (@slave2zeros)
+  - selects & collection selects were dropping label options
+  - allow html content in check_box tag label (@desheikh)
+  - allow check_box label to be defined with a block
+  - omit form-control class from file_field (@mbrictson)
+  - Collection inputs honour `checked` attribute (@desheikh)
+  - Fixing label/input pairing for checkbox collections (@byped)
+  - Removing for attribute on radio button labels (@sigmike)
+
+Features:
+
+  - The control_class can be overridden per field by passing in the
+    :control_class option. Default value is "form-control".
+  - Make name optional in FormBuilder#submit (@adrpac)
+  - Added the FormBuilder#primary helper back in
+  - Added a FormBuilder#static_control helper
+  - Added support for radio_buttons_collection and check_boxes_collection
+  - Added a FormBuilder#error_summary helper method
+  - inline_errors can be turned off: bootstrap_form_for(obj, inline_errors: false)
+    When inline errors are off, FormBuilder#alert_message contains the error summary.
+    This can also be turned off with the option 'error_summary: false'
+  - Added support for: color_field, date_field, datetime_field, datetime_local_field,
+    month_field, range_field, search_field (#42), time_field, week_field
+  - Added ability to override the left/right classes for a particular control
+    when using horizontal forms. (@baldwindavid)
+  - Added support for grouped_collection_select (@rzane)
+  - Added support of Rails 4 syntax for collection inputs (@desheikh)
+  - Renamed options :left to :label_col and :right to :control_col
+  - Renamed option :style to :layout (@baldwindavid)
+  - Added errors_on helper (@baldwindavid)
+  - Added per field layout option (@baldwindavid)
+  - Added support for bootstrap_form_tag (@baldwindavid)
+
+
+[Pending Release]: https://github.com/bootstrap-ruby/bootstrap_form/compare/v4.0.0.alpha1...HEAD
+[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
+[2.5.3]: https://github.com/bootstrap-ruby/bootstrap_form/compare/v2.5.2...v2.5.3
+[2.5.2]: https://github.com/bootstrap-ruby/bootstrap_form/compare/v2.5.1...v2.5.2
+[2.5.1]: https://github.com/bootstrap-ruby/bootstrap_form/compare/v2.5.0...v2.5.1
+[2.5.0]: https://github.com/bootstrap-ruby/bootstrap_form/compare/v2.4.0...v2.5.0
+[2.4.0]: https://github.com/bootstrap-ruby/bootstrap_form/compare/v2.3.0...v2.4.0

data/CONTRIBUTING.md

@@ -0,0 +1,57 @@
+# Contributing
+
+The release of Bootstrap 4 and Rails 5.1 have implications for the future
+direction of `bootstrap_form`. Don't worry. We plan to move this gem forward to
+Bootstrap 4 and to support Rails 5.1 and beyond. If you're thinking of
+contributing to `bootstrap_form`, please read
+[issue #361](https://github.com/bootstrap-ruby/bootstrap_form/issues/361).
+
+Your comments are welcome.
+
+Thanks so much for considering a contribution to bootstrap_form. We love pull requests!
+
+Here's a quick guide for contributing:
+
+### 1. Check if issue or feature is available to work on
+
+Make sure no one else is working on the same issue or feature. Search the issues
+and pull requests for anything that looks like the issue or feature you want to
+address. If no one else is working on your issue or feature, carry on with the
+following steps.
+
+### 2. Fork the repo
+
+For the project. Optionally, create a branch you want to work on
+
+### 3. Get it running locally
+
+- Install the required dependencies with `bundle install`
+- Run tests via: `bundle exec rake`
+
+### 4. Hack away
+
+- Try to keep your changes small. Consider making several smaller pull requests.
+- Don't forget to add necessary tests.
+- Update the README if necessary.
+- Add a line to the CHANGELOG for your bug fix or feature.
+
+You may find using demo application useful for development and debugging.
+
+- `cd demo`
+- `rake db:schema:load`
+- `rails s`
+- Navigate to http://localhost:3000
+
+### 5. Make a Pull Request
+
+- If you never done it before read this: https://help.github.com/articles/about-pull-requests/
+- When PR is submitted check if TravisCI ran all tests successfully didn't raise any issues
+
+### 6. Done!
+
+Somebody will shortly review your pull request and if everything is good will be
+merged into master branch. Eventually gem will be published with your changes.
+
+---
+
+Thanks to all the great contributors over the years: https://github.com/bootstrap-ruby/bootstrap_form/graphs/contributors

data/Dangerfile

@@ -0,0 +1,54 @@
+# Adapted from https://github.com/ruby-grape/danger/blob/master/Dangerfile
+# Q: What is a Dangerfile, anyway? A: See http://danger.systems/
+
+# ------------------------------------------------------------------------------
+# Additional pull request data
+# ------------------------------------------------------------------------------
+project_name = github.pr_json["base"]["repo"]["name"]
+pr_number = github.pr_json["number"]
+pr_url = github.pr_json["_links"]["html"]["href"]
+
+# ------------------------------------------------------------------------------
+# What changed?
+# ------------------------------------------------------------------------------
+has_lib_changes = !git.modified_files.grep(/^lib/).empty?
+has_test_changes = !git.modified_files.grep(/^test/).empty?
+has_changelog_changes = git.modified_files.include?("CHANGELOG.md")
+
+# ------------------------------------------------------------------------------
+# You've made changes to lib, but didn't write any tests?
+# ------------------------------------------------------------------------------
+if has_lib_changes && !has_test_changes
+  warn("There are code changes, but no corresponding tests. "\
+       "Please include tests if this PR introduces any modifications in "\
+       "#{project_name}'s behavior.",
+       :sticky => false)
+end
+
+# ------------------------------------------------------------------------------
+# Have you updated CHANGELOG.md?
+# ------------------------------------------------------------------------------
+if !has_changelog_changes && has_lib_changes
+  markdown <<-MARKDOWN
+Here's an example of a CHANGELOG.md entry (place it immediately under the `* Your contribution here!` line):
+
+```markdown
+* [##{pr_number}](#{pr_url}): #{github.pr_title} - [@#{github.pr_author}](https://github.com/#{github.pr_author}).
+```
+MARKDOWN
+  warn("Please update CHANGELOG.md with a description of your changes. "\
+       "If this PR is not a user-facing change (e.g. just refactoring), "\
+       "you can disregard this.", :sticky => false)
+end
+
+# ------------------------------------------------------------------------------
+# Did you remove the CHANGELOG's "Your contribution here!" line?
+# ------------------------------------------------------------------------------
+if has_changelog_changes
+  if IO.read("CHANGELOG.md").scan(/^\s*[-\*] Your contribution here/i).count < 3
+    fail(
+      "Please put the `- Your contribution here!` line back into CHANGELOG.md.",
+      :sticky => false
+    )
+  end
+end

data/Gemfile

@@ -0,0 +1,21 @@
+source "http://rubygems.org"
+
+gemspec
+
+# Uncomment and change rails version for testing purposes
+# gem "rails", "~> 5.2.0.beta2"
+
+group :development do
+  gem "htmlbeautifier"
+end
+
+group :test do
+  # can relax version requirement for Rails 5.2.beta3+
+  gem "minitest", "~> 5.10.3"
+
+  gem "diffy"
+  gem "equivalent-xml"
+  gem "mocha"
+  gem "sqlite3"
+  gem "timecop", "~> 0.7.1"
+end

data/{MIT-LICENSE → LICENSE.txt}

@@ -1,4 +1,4 @@
-Copyright 2012-2014 Stephen Potenza <potenza@gmail.com>
+Copyright 2012-2018 Stephen Potenza <potenza@gmail.com>
 
 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,22 +1,28 @@
-[![Build Status](https://travis-ci.org/bootstrap-ruby/rails-bootstrap-forms.svg?branch=master)](https://travis-ci.org/bootstrap-ruby/rails-bootstrap-forms)
-[![Gem Version](https://badge.fury.io/rb/bootstrap_form.svg)](http://badge.fury.io/rb/bootstrap_form)
+⚠️ **This documentation is for the master branch, which is not yet stable and targets Bootstrap v4.** If you are using Bootstrap v3, refer to the stable [legacy-2.7](https://github.com/bootstrap-ruby/bootstrap_form/tree/legacy-2.7) branch.
 
-# Rails Bootstrap Forms
+---
 
-**Rails Bootstrap Forms** is a rails form builder that makes it super easy to integrate
-twitter bootstrap-style forms into your rails application.
+# bootstrap_form
+
+[![Build Status](https://travis-ci.org/bootstrap-ruby/bootstrap_form.svg?branch=master)](https://travis-ci.org/bootstrap-ruby/bootstrap_form)
+[![Gem Version](https://badge.fury.io/rb/bootstrap_form.svg)](https://rubygems.org/gems/bootstrap_form)
+
+**bootstrap_form** is a Rails form builder that makes it super easy to integrate
+Bootstrap v4-style forms into your Rails application.
 
 ## Requirements
 
-* Ruby 1.9+
-* Rails 4.0+
-* Twitter Bootstrap 3.0+
+* Ruby 2.2.2+
+* Rails 5.0+ (Rails 5.1+ for `bootstrap_form_with`)
+* Bootstrap 4.0.0+
 
 ## Installation
 
 Add it to your Gemfile:
 
-`gem 'bootstrap_form'`
+```ruby
+gem "bootstrap_form", ">= 4.0.0.alpha1"
+```
 
 Then:
 
@@ -55,21 +61,15 @@ This generates the following HTML:
     <label for="user_password">Password</label>
     <input class="form-control" id="user_password" name="user[password]" type="password">
   </div>
-  <div class="checkbox">
-    <label for="user_remember_me">
-      <input name="user[remember_me]" type="hidden" value="0">
-      <input id="user_remember_me" name="user[remember_me]" type="checkbox" value="1"> Remember me
-    </label>
+  <div class="form-check">
+    <input name="user[remember_me]" type="hidden" value="0">
+    <input class="form-check-input" id="user_remember_me" name="user[remember_me]" type="checkbox" value="1">
+    <label class="form-check-label" for="user_remember_me">Remember me</label>
   </div>
-  <input class="btn btn-default" name="commit" type="submit" value="Log In">
+  <input class="btn btn-secondary" name="commit" type="submit" value="Log In">
 </form>
 ```
 
-### Nested Forms
-
-In order to active [nested_form](https://github.com/ryanb/nested_form) support,
-use `bootstrap_nested_form_for` instead of `bootstrap_form_for`.
-
 ### bootstrap_form_tag
 
 If your form is not backed by a model, use the `bootstrap_form_tag`. Usage of this helper is the same as `bootstrap_form_for`, except no model object is passed in as the first argument. Here's an example:
@@ -81,6 +81,53 @@ If your form is not backed by a model, use the `bootstrap_form_tag`. Usage of th
 <% end %>
 ```
 
+### `bootstrap_form_with` (Rails 5.1+)
+
+Note that `form_with` in Rails 5.1 does not add IDs to form elements and labels by default, which are both important to Bootstrap markup. This behavior is corrected in Rails 5.2.
+
+To get started, just use the `bootstrap_form_with` helper in place of `form_with`. Here's an example:
+
+```erb
+<%= bootstrap_form_with(model: @user, local: true) do |f| %>
+  <%= f.email_field :email %>
+  <%= f.password_field :password %>
+  <%= f.check_box :remember_me %>
+  <%= f.submit "Log In" %>
+<% end %>
+```
+
+This generates:
+
+```html
+<form role="form" action="/users" accept-charset="UTF-8" method="post">
+  <input name="utf8" type="hidden" value="&#x2713;" />
+  <div class="form-group">
+    <label class="required" for="user_email">Email</label>
+    <input class="form-control" type="email" value="steve@example.com" name="user[email]" />
+  </div>
+  <div class="form-group">
+    <label for="user_password">Password</label>
+    <input class="form-control" type="password" name="user[password]" />
+    <small class="form-text text-muted">A good password should be at least six characters long</small>
+  </div>
+  <div class="form-check">
+    <input name="user[remember_me]" type="hidden" value="0">
+    <input class="form-check-input" id="user_remember_me" name="user[remember_me]" type="checkbox" value="1">
+    <label class="form-check-label" for="user_remember_me">Remember me</label>
+  </div>
+  <input type="submit" name="commit" value="Log In" class="btn btn-secondary" data-disable-with="Log In" />
+</form>
+```
+
+`bootstrap_form_with` supports both the `model:` and `url:` use cases
+in `form_with`.
+
+`form_with` has some important differences compared to `form_for` and `form_tag`, and these differences apply to `bootstrap_form_with`. A good summary of the differences can be found at: https://m.patrikonrails.com/rails-5-1s-form-with-vs-old-form-helpers-3a5f72a8c78a, or in the [Rails documentation](api.rubyonrails.org).
+
+### Future Compatibility
+
+The Rails team has [suggested](https://github.com/rails/rails/issues/25197) that `form_for` and `form_tag` may be deprecated and then removed in future versions of Rails. `bootstrap_form` will continue to support `bootstrap_form_for` and `bootstrap_form_tag` as long as Rails supports `form_for` and `form_tag`.
+
 ## Form Helpers
 
 This gem wraps the following Rails form helpers:
@@ -115,6 +162,8 @@ This gem wraps the following Rails form helpers:
 * time_zone_select
 * url_field
 * week_field
+* submit
+* button
 
 These helpers accept the same options as the standard Rails form helpers, with
 a few extra options:
@@ -140,6 +189,12 @@ To add custom classes to the field's label:
 <%= f.text_field :email, label_class: "custom-class" %>
 ```
 
+Or you can add the label as input placeholder instead (this automatically hides the label):
+
+```erb
+<%= f.text_field :email, label_as_placeholder: true %>
+```
+
 #### Required Fields
 
 A label that is associated with a required field is automatically annotated with
@@ -166,7 +221,7 @@ In cases where this behavior is undesirable, use the `skip_required` option:
 
 ### Input Elements / Controls
 
-To specify the class of the generated input, use the `control_class` option:
+To specify the class of the generated input tag, use the `control_class` option:
 
 ```erb
 <%= f.text_field :email, control_class: "custom-class" %>
@@ -190,31 +245,22 @@ en:
         password: "A good password should be at least six characters long"
 ```
 
+Help translations containing HTML should follow the convention of appending `_html` to the name:
+
+```yml
+en:
+  activerecord:
+    help:
+      user:
+        password_html: "A <strong>good</strong> password should be at least six characters long"
+```
+
 If your model name has multiple words (like `SuperUser`), the key on the
 translation file should be underscored (`super_user`).
 
 You can override help translations for a particular field by passing the `help`
 option or turn them off completely by passing `help: false`.
 
-### Icons
-
-To add an icon to a field, use the `icon` option and pass the icon name
-*without* the 'glyphicon' prefix:
-
-```erb
-<%= f.text_field :login, icon: "user" %>
-```
-
-This automatically adds the `has-feedback` class to the `form-group`:
-
-```html
-<div class="form-group has-feedback">
-  <label class="control-label" for="user_login">Login</label>
-  <input class="form-control" id="user_login" name="user[login]" type="text" />
-  <span class="glyphicon glyphicon-user form-control-feedback"></span>
-</div>
-```
-
 ### Prepending and Appending Inputs
 
 You can pass `prepend` and/or `append` options to input fields:
@@ -227,10 +273,10 @@ You can also prepend and append buttons. Note: The buttons must contain the
 `btn` class to generate the correct markup.
 
 ```erb
-<%= f.text_field :search, append: link_to("Go", "#", class: "btn btn-default") %>
+<%= f.text_field :search, append: link_to("Go", "#", class: "btn btn-secondary") %>
 ```
 
-To add a class to the input group wrapper, use `:input_group_class` option.
+To add a class to the input group wrapper, use the `:input_group_class` option.
 
 ```erb
 <%= f.email_field :email, append: f.primary('Subscribe'), input_group_class: 'input-group-lg' %>
@@ -249,7 +295,7 @@ Which produces the following output:
 
 ```erb
 <div class="form-group has-warning" data-foo="bar">
-  <label class="control-label" for="user_name">Id</label>
+  <label class="form-control-label" for="user_name">Id</label>
   <input class="form-control" id="user_name" name="user[name]" type="text">
 </div>
 ```
@@ -261,7 +307,7 @@ You still can use `wrapper_class` option to set only a css class. This is just a
 Our select helper accepts the same arguments as the [default Rails helper](http://api.rubyonrails.org/classes/ActionView/Helpers/FormOptionsHelper.html#method-i-select). Here's an example of how you pass both options and html_options hashes:
 
 ```erb
-<%= f.select :product, [[1, "Apple"], [2, "Grape"]], { label: "Choose your favorite fruit:" }, { class: "selectpicker" } %>
+<%= f.select :product, [["Apple", 1], ["Grape", 2]], { label: "Choose your favorite fruit:" }, { class: "selectpicker",  wrapper: { class: 'has-warning', data: { foo: 'bar' } } } %>
 ```
 
 ### Checkboxes and Radios
@@ -304,7 +350,7 @@ To display checkboxes and radios inline, pass the `inline: true` option:
 
 #### Collections
 
-BootstrapForms also provides helpers that automatically creates the
+`bootstrap_form` also provides helpers that automatically creates the
 `form_group` and the `radio_button`s or `check_box`es for you:
 
 ```erb
@@ -326,13 +372,13 @@ You can create a static control like this:
 <%= f.static_control :email %>
 ```
 
-Here's the output:
+Here's the output for a horizontal layout:
 
 ```html
 <div class="form-group">
-  <label class="col-sm-2 control-label" for="user_email">Email</label>
+  <label class="col-sm-2 form-control-label" for="user_email">Email</label>
   <div class="col-sm-10">
-    <p class="form-control-static">test@email.com</p>
+    <input class="form-control-plaintext" id="user_email" name="user[email]" readonly="readonly" type="text" value="test@email.com"/>
   </div>
 </div>
 ```
@@ -350,12 +396,12 @@ You can also create a static control that isn't based on a model attribute:
 The multiple selects that the date and time helpers (`date_select`,
 `time_select`, `datetime_select`) generate are wrapped inside a
 `div.rails-bootstrap-forms-[date|time|datetime]-select` tag. This is because
-Bootstrap automatically stylizes ours controls as `block`s. This wrapper fix
+Bootstrap automatically styles our controls as `block`s. This wrapper fixes
 this defining these selects as `inline-block` and a width of `auto`.
 
 ### Submit Buttons
 
-The `btn btn-default` css classes are automatically added to your submit
+The `btn btn-secondary` css classes are automatically added to your submit
 buttons.
 
 ```erb
@@ -375,6 +421,26 @@ You can specify your own classes like this:
 <%= f.submit "Log In", class: "btn btn-success" %>
 ```
 
+If the `primary` helper receives a `render_as_button: true` option or a block,
+it will be rendered as an HTML button, instead of an input tag. This allows you
+to specify HTML content and styling for your buttons (such as adding
+illustrative icons to them). For example, the following statements
+
+```erb
+<%= f.primary "Save changes <span class='fa fa-save'></span>".html_safe, render_as_button: true %>
+
+<%= f.primary do
+      concat 'Save changes '
+      concat content_tag(:span, nil, class: 'fa fa-save')
+    end %>
+```
+
+are equivalent, and each of them both be rendered as
+
+```html
+<button name="button" type="submit" class="btn btn-primary">Save changes <span class="fa fa-save"></span></button>
+```
+
 ### Accessing Rails Form Helpers
 
 If you want to use the original Rails form helpers for a particular field,
@@ -446,7 +512,7 @@ The `label_col` and `control_col` css classes can also be changed per control:
 
 ### Custom Field Layout
 
-The `layout` can be overridden per field:
+The form-level `layout` can be overridden per field, unless the form-level layout was `inline`:
 
 ```erb
 <%= bootstrap_form_for(@user, layout: :horizontal) do |f| %>
@@ -459,19 +525,34 @@ The `layout` can be overridden per field:
 <% end %>
 ```
 
-## Validation & Errors
+A form-level `layout: :inline` can't be overridden because of the way Bootstrap 4 implements in-line layouts. One possible work-around is to leave the form-level layout as default, and specify the individual fields as `layout: :inline`, except for the fields(s) that should be other than in-line.
+
+### Custom Form Element Styles
+
+The `custom` option can be used to replace the browser default styles for check boxes and radio buttons with dedicated Bootstrap styled form elements. Here's an example:
+
+```erb
+<%= bootstrap_form_for(@user) do |f| %>
+  <%= f.email_field :email %>
+  <%= f.password_field :password %>
+  <%= f.check_box :remember_me, custom: true %>
+  <%= f.submit "Log In" %>
+<% end %>
+```
+
+## Validation and Errors
 
 ### Inline Errors
 
-By default, fields that have validation errors will outlined in red and the
+By default, fields that have validation errors will be outlined in red and the
 error will be displayed below the field. Rails normally wraps the fields in a
 div (field_with_errors), but this behavior is suppressed. Here's an example:
 
 ```html
-<div class="form-group has-error">
-  <label class="control-label" for="user_email">Email</label>
-  <input class="form-control" id="user_email" name="user[email]" type="email" value="">
-  <span class="help-block">can't be blank</span>
+<div class="form-group">
+  <label class="form-control-label" for="user_email">Email</label>
+  <input class="form-control is-invalid" id="user_email" name="user[email]" type="email" value="">
+  <small class="invalid-feedback">can't be blank</small>
 </div>
 ```
 
@@ -576,46 +657,32 @@ Which outputs:
 bootstrap_form follows standard rails conventions so it's i18n-ready. See more
 here: http://guides.rubyonrails.org/i18n.html#translations-for-active-record-models
 
-## Code Triage page
-
-http://www.codetriage.com/potenza/bootstrap_form
-
-## Contributing
-
-We love pull requests! Here's a quick guide for contributing:
-
-1. Fork the repo.
+## Other Tips and Edge Cases
+By their very nature, forms are extremely diverse. It would be extremely difficult to provide a gem that could handle every need. Here are some tips for handling edge cases.
 
-2. Install the required dependencies.
+### Empty But Visible Labels
+Some third party plug-ins require an empty but visible label on an input control. The `hide_label` option generates a label that won't appear on the screen, but it's considered invisible and therefore doesn't work with such a plug-in. An empty label (e.g. `""`) causes the underlying Rails helper to generate a label based on the field's attribute's name.
 
+The solution is to use a zero-width character for the label, or some other "empty" HTML. For example:
 ```
-bundle install
-bundle exec appraisal install
+label: "&#8203;".html_safe
 ```
-
-3. Run the existing test suite:
-
+or
 ```
-$ bundle exec rake -f test/dummy/Rakefile db:create db:migrate RAILS_ENV=test
-$ bundle exec appraisal rake test
+label: "<span></span>".html_safe
 ```
 
-4. Add tests for your change.
-
-5. Add your changes and make your test(s) pass. Following the conventions you
-see used in the source will increase the chance that your pull request is
-accepted right away.
-
-6. Update the README if necessary.
-
-7. Add a line to the CHANGELOG for your bug fix or feature.
+## Code Triage page
 
-8. Push to your fork and submit a pull request.
+http://www.codetriage.com/potenza/bootstrap_form
 
-## Contributors
+## Contributing
 
-https://github.com/bootstrap-ruby/rails-bootstrap-forms/graphs/contributors
+We welcome contributions.
+If you're considering contributing to bootstrap_form,
+please review the [Contributing](/CONTRIBUTING.md)
+document first.
 
 ## License
 
-MIT License. Copyright 2012-2014 Stephen Potenza (https://github.com/potenza)
+MIT License. Copyright 2012-2018 Stephen Potenza (https://github.com/potenza)