bootstrap_form 4.2.0 → 4.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3eb9dd9edad01a3b8fc83d83506c4a9a19d70f849620dde77847baaaa0231b9a
-  data.tar.gz: 942e9b16f5ffe3873e49defc113255c61939e479621c25ed5846348b2bdfe304
+  metadata.gz: 60d4313478eda1a0db587b6c45b7e107aedca0d59683f2231d348c09e9585e59
+  data.tar.gz: f07b72a464b509975d9a6a573718787b9c245b7b3b1f362e3448d842fff93891
 SHA512:
-  metadata.gz: e61107ff84b13b61270438556d0320c94a1f395b5acdb9221122ba89078c7dca3c0d96b3f2db8bc5e3c7e0cdca4eb124f0bb5944fd47be31a9a217ad6a714716
-  data.tar.gz: 55b15e5a89aa152ad0c2ca05e1bfb6fc99c15f0e1b5235ad6a0d41df0429097e775d3c006ed59e0773e9b397d2c7332fb57334bc577a47331eebff0c7dff75b8
+  metadata.gz: 370f4f419457d0737505add14f48f6ebb879e185f9b132d7409d59b789944dff9a156eabb3c821764f1de8783879729639f99334812077f2c99cccf44da7378c
+  data.tar.gz: a5ac9f28944a788c996a7da4d57760cb6331bf2d3a490a8a3a96ddaffec2f7357fce07e2e16fcabbe59eb7f12967fc8950f19f4644369981b30eaaa63fd588a4

data/.editorconfig

@@ -0,0 +1,13 @@
+# editorconfig.org
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.md]
+trim_trailing_whitespace = false

data/.rubocop.yml

@@ -1,9 +1,11 @@
 # Taken from: https://github.com/mattbrictson/rails-template/blob/master/rubocop.yml.tt
 # Modified for demo app in `demo/` directory.
+require: rubocop-rails
+
 AllCops:
   DisplayCopNames: true
   DisplayStyleGuide: true
-  TargetRubyVersion: 2.2.2
+  TargetRubyVersion: 2.3
   Exclude:
     - "bin/*"
     - Capfile
@@ -59,9 +61,6 @@ Naming/MemoizedInstanceVariableName:
 Naming/VariableNumber:
   Enabled: false
 
-Performance/Casecmp:
-  Enabled: false
-
 Rails:
   Enabled: true
 

data/.travis.yml

@@ -1,13 +1,13 @@
 language: ruby
 rvm:
-  - 2.2.9
-  - 2.3.6
-  - 2.4.3
-  - 2.5.0
+  - 2.4.6
+  - 2.5.6
+  - 2.6.4
 gemfile:
   - test/gemfiles/5.0.gemfile
   - test/gemfiles/5.1.gemfile
   - test/gemfiles/5.2.gemfile
+  - test/gemfiles/6.0.gemfile
 before_install:
   - gem i rubygems-update -v '<3' && update_rubygems
   - gem install bundler -v 1.17.3 --no-document
@@ -15,18 +15,22 @@ script:
   - bundle exec rake test
 
 matrix:
+  exclude:
+    - rvm: 2.4.6
+      gemfile: test/gemfiles/6.0.gemfile
+
   include:
     # Bleeding edge Ruby
     - rvm: ruby-head
-      gemfile: test/gemfiles/5.2.gemfile
+      gemfile: test/gemfiles/6.0.gemfile
 
     # Next version of Rails
     - rvm: 2.5.0
-      gemfile: test/gemfiles/6.0.gemfile
+      gemfile: test/gemfiles/edge.gemfile
 
     # Running one job to execute DANGER bot and linting
     - rvm: 2.5.0
-      gemfile: test/gemfiles/5.2.gemfile
+      gemfile: test/gemfiles/6.0.gemfile
       script:
         - gem install danger
         - danger
@@ -35,4 +39,4 @@ matrix:
   allow_failures:
     - rvm: ruby-head
     - rvm: 2.5.0
-      gemfile: test/gemfiles/6.0.gemfile
+      gemfile: test/gemfiles/edge.gemfile

data/CHANGELOG.md

@@ -12,6 +12,13 @@
 
 * Your contribution here!
 
+## [4.3.0][] (2019-03-08)
+
+### New features
+
+* [#503] Support Rails 6.0.0.
+* Small documentation changes.
+
 ## [4.2.0][] (2019-03-08)
 
 ### New features

data/CONTRIBUTING.md

@@ -63,7 +63,7 @@ merged into the master branch. Eventually the gem will be published with your ch
 ### Coding guidelines
 
 This project uses [RuboCop](https://github.com/bbatsov/rubocop) to enforce standard Ruby coding
-guidelines. Currently we run RuboCop's as described by [this post](https://tech.offgrid-electric.com/rubocop-getting-to-green-in-a-huge-rails-app-12d1ad6678eb), under the section "How to make CI pass". That means we allow certain existing RuboCop offences in the code, but prevent people from adding any new offences. So you might copy some existing code, and then discover that it doesn't pass. Please fix the new code, and if you're ambitious, fix the old code as well.
+guidelines.
 
 * Test that your contribution passes with `rake rubocop`.
 * RuboCop is also run as part of the full test suite with `bundle exec rake`.
@@ -71,6 +71,12 @@ guidelines. Currently we run RuboCop's as described by [this post](https://tech.
 
 Note that most editors have plugins to run RuboCop as you type, or when you save a file. You may find it well worth your time to install and configure the RuboCop plugin for your editor. Read the [RuboCop documentation](https://rubocop.readthedocs.io/en/latest/integration_with_other_tools/).
 
+### Supported Versions of Ruby and Rails
+
+The goal of `bootstrap_form` is to support all versions of Rails currently supported for bug fixes and security issues. We do not test against versions supported for severe security issues. We test against the minimum [version of Ruby required](https://guides.rubyonrails.org/upgrading_ruby_on_rails.html#ruby-versions) for those versions of Rails.
+
+The Ruby on Rails support policy is [here](https://guides.rubyonrails.org/maintenance_policy.html).
+
 ## Documentation Contributions
 
 Contributions to documentation are always welcome. Even fixing one typo improves the quality of `bootstrap_form`. To make a documentation contribution, follow steps 1-3 of Code Contributions, then make the documentation changes, then make the pull request (step 6 of Code Contributions).

data/Gemfile

@@ -3,15 +3,15 @@ source "http://rubygems.org"
 gemspec
 
 # Uncomment and change rails version for testing purposes
-gem "rails", "~> 5.2.0"
-# gem "rails", "~> 6.0.0.beta1"
+# gem "rails", "~> 5.2.0"
+gem "rails", "~> 6.0.0"
 
 group :development do
   gem "chandler", ">= 0.7.0"
   gem "htmlbeautifier"
-  gem "rubocop", require: false
-  gem "sass-rails"
-  gem 'webpacker', '>= 4.0.0.rc.3'
+  gem "rubocop-rails", require: false
+  gem "sassc-rails"
+  gem "webpacker", ">= 4.0.0.rc.3"
 end
 
 group :test do
@@ -21,8 +21,6 @@ group :test do
   gem "diffy"
   gem "equivalent-xml"
   gem "mocha"
-  # sqlite3 1.4.0 breaks the test suite.
-  # https://github.com/rails/rails/pull/35154
-  gem "sqlite3", "~> 1.3.6"
+  gem "sqlite3"
   gem "timecop", "~> 0.7.1"
 end

data/OLD-README.md

@@ -415,8 +415,19 @@ Here's the output for a horizontal layout:
 You can also create a static control that isn't based on a model attribute:
 
 ```erb
-<%= f.static_control label: "Custom Static Control" value: "Content Here" %>
+<%= f.static_control :field_name, label: "Custom Static Control" value: "Content Here" %>
 ```
+
+`field_name` may be any name that isn't already used in the form. Note that you may get "unpermitted parameter" messages in your log file with this approach.
+
+You can also create the static control the following way, if you don't need to get the value of the static control as a parameter when the form is submitted:
+
+```erb
+<%= f.static_control label: "Custom Static Control" value: "Content Here", name: nil %>
+```
+
+(If you neither provide a field name nor `name: nil`, the Rails code that submits the form will give a JavaScript error.)
+
 Prior to version 4 of `bootstrap_form`, you could pass a block to the `static_control` method.
 The value of the block would be used for the content of the static "control".
 Bootstrap 4 actually creates and styles a disabled input field for static controls, so the value of the control has to be specified by the `value:` option.

data/README.md

@@ -1,4 +1,4 @@
-⚠️ **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.
+If you are using Bootstrap v3, refer to the legacy [legacy-2.7](https://github.com/bootstrap-ruby/bootstrap_form/tree/legacy-2.7) branch.
 
 This is a new take on the `bootstrap_form` README. Please leave comments at: #520. You can go back to the traditional [README](/OLD-README.md).
 
@@ -28,18 +28,19 @@ Some other nice things that `bootstrap_form` does for you are:
 `bootstrap_form` works like the standard Rails form helpers, and this README assumes you know how they work. You start a form with one of [`bootstrap_form_with`](#bootstrap-form-with), [`bootstrap_form_for`](#bootstrap-form-for), or [`bootstrap_form_tag`](#bootstrap-form-tag) in a view file. You get a form builder that calls the [`bootstrap_form` helpers](#form-helpers) instead of the standard Rails helpers. You use that form builder in the view file to render one or more form fields.
 
 ## Requirements
-`bootstrap_form` supports currently supported versions of Rails:
 
-* Ruby 2.2.2+
+`bootstrap_form` supports at a minimum the currently supported versions of Ruby and Rails:
+
+* Ruby 2.4+
 * Rails 5.0+ (Rails 5.1+ for `bootstrap_form_with`)
-* Bootstrap 4.0.0+
+* Bootstrap 4.0+
 
 ## Installation
 
 Add it to your Gemfile:
 
 ```ruby
-gem "bootstrap_form", ">= 4.2.0"
+gem "bootstrap_form", "~> 4.0"
 ```
 
 Then:
@@ -386,7 +387,7 @@ To render checkboxes as switches with Bootstrap 4.2+, use `custom: :switch`:
 <%= f.collection_check_boxes :skills, Skill.all, :id, :name %>
 ```
 
-NOTE: These helpers do not currently support a block, unlike their equivalent Rails helpers. See issue #477.
+NOTE: These helpers do not currently support a block, unlike their equivalent Rails helpers. See issue [#477](https://github.com/bootstrap-ruby/bootstrap_form/issues/477). If you need to use the block syntax, use `collection_check_boxes_without_bootstrap` or `collection_radio_buttons_without_bootstrap` for now.
 
 Collection methods accept these options:
 * `:label`: Customize the `form_group`'s label
@@ -416,8 +417,19 @@ Here's the output for a horizontal layout:
 You can also create a static control that isn't based on a model attribute:
 
 ```erb
-<%= f.static_control label: "Custom Static Control" value: "Content Here" %>
+<%= f.static_control :field_name, label: "Custom Static Control", value: "Content Here" %>
 ```
+
+`field_name` may be any name that isn't already used in the form. Note that you may get "unpermitted parameter" messages in your log file with this approach.
+
+You can also create the static control the following way, if you don't need to get the value of the static control as a parameter when the form is submitted:
+
+```erb
+<%= f.static_control label: "Custom Static Control", value: "Content Here", name: nil %>
+```
+
+(If you neither provide a field name nor `name: nil`, the Rails code that submits the form will give a JavaScript error.)
+
 Prior to version 4 of `bootstrap_form`, you could pass a block to the `static_control` method.
 The value of the block would be used for the content of the static "control".
 Bootstrap 4 actually creates and styles a disabled input field for static controls, so the value of the control has to be specified by the `value:` option.
@@ -497,13 +509,17 @@ will be rendered as
 (some unimportant HTML attributes have been removed for simplicity)
 
 ## Rich Text Areas AKA Trix Editor
+
 If you're using Rails 6, `bootstrap_form` supports the `rich_text_area` helper.
 
-```
+
+```erb
 <%= f.rich_text_area(:life_story) %>
 ```
+
 will be rendered as:
-```
+
+```html
 <div class="form-group">
   <label for="user_life_story">Life story</label>
   <input type="hidden" name="user[life_story]" id="user_life_story_trix_input_user"/>
@@ -513,9 +529,11 @@ will be rendered as:
 ```
 
 ## File Fields
+
 The `file_field` helper generates mark-up for a Bootstrap 4 custom file field entry. It takes the [options for `text_field`](#form-helper-options), minus `append` and `prepend`.
 
 ## Hidden Fields
+
 The `hidden_field` helper in `bootstrap_form` calls the Rails helper directly, and does no additional mark-up.
 
 ## Accessing Rails Form Helpers
@@ -589,7 +607,7 @@ The `label_col` and `control_col` css classes can also be changed per control:
 
 or default value can be changed in initializer:
 
-```erb
+```ruby
 # config/initializers/bootstrap_form.rb
 module BootstrapForm
   class FormBuilder
@@ -646,6 +664,7 @@ The `custom` option can be used to replace the browser default styles for check
 ```
 
 ## Validation and Errors
+
 Rails normally wraps fields with validation errors in a `div.field_with_errors`, but this behaviour isn't consistent with Bootstrap 4 styling. By default, `bootstrap_form` generations in-line errors which appear below the field. But it can also generate errors on the label, or not display any errors, leaving it up to you.
 
 ### Inline Errors
@@ -674,7 +693,7 @@ You can turn off inline errors for the entire form like this:
 You can also display validation errors in the field's label; just turn
 on the `:label_errors` option. Here's an example:
 
-```
+```erb
 <%= bootstrap_form_for(@user, label_errors: true) do |f| %>
   ...
 <% end %>
@@ -683,7 +702,7 @@ on the `:label_errors` option. Here's an example:
 By default, turning on `:label_errors` will also turn off
 `:inline_errors`. If you want both turned on, you can do that too:
 
-```
+```erb
 <%= bootstrap_form_for(@user, label_errors: true, inline_errors: true) do |f| %>
   ...
 <% end %>
@@ -792,24 +811,25 @@ here: http://guides.rubyonrails.org/i18n.html#translations-for-active-record-mod
 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`.
 
 ## 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.
 
 ### 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:
-```
+
+```ruby
 label: "&#8203;".html_safe
 ```
+
 or
-```
+
+```ruby
 label: "<span></span>".html_safe
 ```
 
-## Code Triage page
-
-http://www.codetriage.com/potenza/bootstrap_form
-
 ## Contributing
 
 We welcome contributions.

data/RELEASING.md

@@ -6,13 +6,13 @@ Follow these steps to release a new version of bootstrap_form to rubygems.org.
 
 * 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.
+* You must be using Ruby >= 2.4.
 * 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`.**
+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):

data/bootstrap_form.gemspec

@@ -22,7 +22,7 @@ Gem::Specification.new do |s|
   s.bindir        = "exe"
   s.require_paths = ["lib"]
 
-  s.required_ruby_version = ">= 2.2.2"
+  s.required_ruby_version = ">= 2.3"
 
   s.add_dependency("actionpack", ">= 5.0")
   s.add_dependency("activemodel", ">= 5.0")

data/demo/app/helpers/bootstrap_helper.rb

@@ -5,7 +5,7 @@ module BootstrapHelper
     content_tag(:div, class: "example") do
       concat(form_html)
       concat(toggle)
-      concat(codemirror)
+      concat(codemirror(form_html))
     end
   end
 

data/demo/app/views/bootstrap/form.html.erb

@@ -40,7 +40,7 @@
   <% end %>
 <% end %>
 
-<h3>Simple</h3>
+<h3>Simple Action Text Example</h3>
 
 <%= form_with_source do %>
   <%= bootstrap_form_for @user, url: "/" do |form| %>

data/lib/bootstrap_form/inputs/check_box.rb

@@ -39,7 +39,7 @@ module BootstrapForm
 
       def check_box_description(name, options, &block)
         content = block_given? ? capture(&block) : options[:label]
-        content || (object && object.class.human_attribute_name(name)) || name.to_s.humanize
+        content || object&.class&.human_attribute_name(name) || name.to_s.humanize
       end
 
       def check_box_value(name, value)

data/lib/bootstrap_form/inputs/radio_button.rb

@@ -61,14 +61,14 @@ module BootstrapForm
       end
 
       def standard_radio_button_wrapper_class(options)
-        classes = ["form-check"]
+        classes = %w[form-check]
         classes << "form-check-inline" if layout_inline?(options[:inline])
         classes << "disabled" if options[:disabled]
         classes
       end
 
       def custom_radio_button_wrapper_class(options)
-        classes = ["custom-control", "custom-radio"]
+        classes = %w[custom-control custom-radio]
         classes << "custom-control-inline" if layout_inline?(options[:inline])
         classes
       end

data/lib/bootstrap_form/version.rb

@@ -1,3 +1,3 @@
 module BootstrapForm
-  VERSION = "4.2.0".freeze
+  VERSION = "4.3.0".freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bootstrap_form
 version: !ruby/object:Gem::Version
-  version: 4.2.0
+  version: 4.3.0
 platform: ruby
 authors:
 - Stephen Potenza
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-03-08 00:00:00.000000000 Z
+date: 2019-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -48,6 +48,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".editorconfig"
 - ".gitignore"
 - ".rubocop.yml"
 - ".travis.yml"
@@ -183,7 +184,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.2.2
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="