bootstrap_form 4.0.0 → 4.1.0

data/Dangerfile

@@ -22,7 +22,7 @@ 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)
+       sticky: false)
 end
 
 # ------------------------------------------------------------------------------
@@ -35,10 +35,10 @@ Here's an example of a CHANGELOG.md entry (place it immediately under the `* You
 ```markdown
 * [##{pr_number}](#{pr_url}): #{github.pr_title} - [@#{github.pr_author}](https://github.com/#{github.pr_author}).
 ```
-MARKDOWN
+  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)
+       "you can disregard this.", sticky: false)
 end
 
 # ------------------------------------------------------------------------------
@@ -46,9 +46,9 @@ end
 # ------------------------------------------------------------------------------
 if has_changelog_changes
   if IO.read("CHANGELOG.md").scan(/^\s*[-\*] Your contribution here/i).count < 3
-    fail(
+    raise(
       "Please put the `- Your contribution here!` line back into CHANGELOG.md.",
-      :sticky => false
+      sticky: false
     )
   end
 end

data/Gemfile

@@ -8,6 +8,7 @@ gemspec
 group :development do
   gem "chandler", ">= 0.7.0"
   gem "htmlbeautifier"
+  gem "rubocop", require: false
 end
 
 group :test do

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"
+gem "bootstrap_form", ">= 4.1.0"
 ```
 
 Then:
@@ -213,10 +213,11 @@ validator with the associated model attribute. Presently this is one of:
 ActiveRecord::Validations::PresenceValidator or
 ActiveModel::Validations::PresenceValidator.
 
-In cases where this behavior is undesirable, use the `skip_required` option:
+In cases where this behavior is undesirable, use the `required` option to force the class to be present or absent:
 
 ```erb
-<%= f.password_field :password, label: "New Password", skip_required: true %>
+<%= f.password_field :login, label: "New Username", required: true %>
+<%= f.password_field :password, label: "New Password", required: false %>
 ```
 
 ### Input Elements / Controls
@@ -302,12 +303,24 @@ Which produces the following output:
 
 You still can use `wrapper_class` option to set only a css class. This is just a short form of `wrapper: { class: 'additional-class' }`.
 
+### Suppressing the Form Group Altogether
+
+You may have want to define your own form group div around a field. To do so, add the option `wrapper: false` to the input field. For example:
+
+```
+f.form_group :user do
+  f.email_field :email, wrapper: false
+end
+```
+
+Note that Bootstrap relies on the form group div to correctly format most fields, so if you use the `wrapper: false` option, you should provide your own form group div around the input field. You can write your own HTML, or use the `form_group` helper.
+
 ### Selects
 
 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, [["Apple", 1], ["Grape", 2]], { label: "Choose your favorite fruit:" }, { class: "selectpicker",  wrapper: { class: 'has-warning', data: { foo: 'bar' } } } %>
+<%= f.select :product, [["Apple", 1], ["Grape", 2]], { label: "Choose your favorite fruit:", wrapper: { class: 'has-warning', data: { foo: 'bar' } } }, { class: "selectpicker" } %>
 ```
 
 ### Checkboxes and Radios
@@ -353,6 +366,13 @@ Check boxes and radio buttons are wrapped in a `div.form-check`. You can add cla
 ```erb
 <%= f.radio_button :skill_level, 0, label: "Novice", inline: true, wrapper_class: "w-auto" %>
 ```
+#### Switches
+
+To render checkboxes as switches with Bootstrap 4.2+, add the proper wrapper class:
+
+```erb
+<%= f.check_box :remember_me, custom: true, wrapper_class: 'custom-switch' %>
+```
 
 #### Collections
 
@@ -539,6 +559,34 @@ The `label_col` and `control_col` css classes can also be changed per control:
 <% end %>
 ```
 
+or default value can be changed in initializer:
+
+```erb
+# config/initializers/bootstrap_form.rb
+module BootstrapForm
+  class FormBuilder
+    def default_label_col
+      'col-sm-4'
+    end
+    def default_control_col
+      'col-sm-8'
+    end
+  end
+end
+```
+
+Control col wrapper class can be modified with `add_control_col_class`. This option will preserve column definition:
+
+```erb
+<%= bootstrap_form_for(@user, layout: :horizontal) do |f| %>
+  <%= f.email_field :email %>
+  <%= f.text_field :age, add_control_col_class: "additional-control-col-class" %>
+  <%= f.form_group do %>
+    <%= f.submit %>
+  <% end %>
+<% end %>
+```
+
 ### Custom Field Layout
 
 The form-level `layout` can be overridden per field, unless the form-level layout was `inline`:

data/Rakefile

@@ -1,5 +1,6 @@
 begin
   require 'bundler/setup'
+  require 'rubocop/rake_task'
 rescue LoadError
   puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
 end
@@ -30,4 +31,9 @@ task "release:rubygem_push" do
   Rake.application.invoke_task("chandler:push")
 end
 
-task default: :test
+desc 'Run RuboCop checks -- see .rubocop_todo.yml for outstanding offenses'
+RuboCop::RakeTask.new(:rubocop) do |task|
+  task.options = %w[--config .rubocop_todo.yml]
+end
+
+task default: %i[test rubocop]

data/bootstrap_form.gemspec

@@ -1,4 +1,4 @@
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 require "bootstrap_form/version"

data/demo/app/controllers/bootstrap_controller.rb

@@ -1,9 +1,8 @@
 class BootstrapController < ApplicationController
-
   def form
     @collection = [
-      Address.new(id: 1, street: 'Foo'),
-      Address.new(id: 2, street: 'Bar')
+      Address.new(id: 1, street: "Foo"),
+      Address.new(id: 2, street: "Bar")
     ]
 
     @user = User.new
@@ -12,5 +11,4 @@ class BootstrapController < ApplicationController
     @user_with_error.errors.add(:email)
     @user_with_error.errors.add(:misc)
   end
-
 end

data/demo/app/helpers/bootstrap_helper.rb

@@ -1,5 +1,4 @@
 module BootstrapHelper
-
   def form_with_source(&block)
     form_html = capture(&block)
 
@@ -19,5 +18,4 @@ module BootstrapHelper
       concat(codemirror)
     end
   end
-
 end

data/demo/app/models/address.rb

@@ -1,3 +1,3 @@
-class Address < ActiveRecord::Base
+class Address < ApplicationRecord
   belongs_to :user
 end

data/demo/app/models/faux_user.rb

@@ -1,7 +1,7 @@
 class FauxUser
   attr_accessor :email, :password, :comments, :misc
 
-  def initialize(attributes = {})
+  def initialize(attributes={})
     attributes.each do |name, value|
       send("#{name}=", value)
     end

data/demo/app/models/user.rb

@@ -1,7 +1,7 @@
-class User < ActiveRecord::Base
+class User < ApplicationRecord
   serialize :preferences
 
-  validates :email, presence: true, :length => { minimum: 5 }
+  validates :email, presence: true, length: { minimum: 5 }
   validates :terms, acceptance: { accept: true }
 
   has_one :address

data/demo/bin/bundle

@@ -1,3 +1,3 @@
 #!/usr/bin/env ruby
-ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__)
-load Gem.bin_path('bundler', 'bundle')
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
+load Gem.bin_path("bundler", "bundle")

data/demo/bin/rails

@@ -1,4 +1,4 @@
 #!/usr/bin/env ruby
-APP_PATH = File.expand_path('../config/application', __dir__)
-require_relative '../config/boot'
-require 'rails/commands'
+APP_PATH = File.expand_path("../config/application", __dir__)
+require_relative "../config/boot"
+require "rails/commands"

data/demo/bin/rake

@@ -1,4 +1,4 @@
 #!/usr/bin/env ruby
-require_relative '../config/boot'
-require 'rake'
+require_relative "../config/boot"
+require "rake"
 Rake.application.run

data/demo/bin/setup

@@ -1,9 +1,9 @@
 #!/usr/bin/env ruby
-require 'fileutils'
+require "fileutils"
 include FileUtils
 
 # path to your application root.
-APP_ROOT = File.expand_path('..', __dir__)
+APP_ROOT = File.expand_path("..", __dir__)
 
 def system!(*args)
   system(*args) || abort("\n== Command #{args} failed ==")
@@ -13,9 +13,9 @@ chdir APP_ROOT do
   # This script is a starting point to setup your application.
   # Add necessary setup steps to this file.
 
-  puts '== Installing dependencies =='
-  system! 'gem install bundler --conservative'
-  system('bundle check') || system!('bundle install')
+  puts "== Installing dependencies =="
+  system! "gem install bundler --conservative"
+  system("bundle check") || system!("bundle install")
 
   # Install JavaScript dependencies if using Yarn
   # system('bin/yarn')
@@ -26,11 +26,11 @@ chdir APP_ROOT do
   # end
 
   puts "\n== Preparing database =="
-  system! 'bin/rails db:setup'
+  system! "bin/rails db:setup"
 
   puts "\n== Removing old logs and tempfiles =="
-  system! 'bin/rails log:clear tmp:clear'
+  system! "bin/rails log:clear tmp:clear"
 
   puts "\n== Restarting application server =="
-  system! 'bin/rails restart'
+  system! "bin/rails restart"
 end

data/demo/bin/update

@@ -1,9 +1,9 @@
 #!/usr/bin/env ruby
-require 'fileutils'
+require "fileutils"
 include FileUtils
 
 # path to your application root.
-APP_ROOT = File.expand_path('..', __dir__)
+APP_ROOT = File.expand_path("..", __dir__)
 
 def system!(*args)
   system(*args) || abort("\n== Command #{args} failed ==")
@@ -13,19 +13,19 @@ chdir APP_ROOT do
   # This script is a way to update your development environment automatically.
   # Add necessary update steps to this file.
 
-  puts '== Installing dependencies =='
-  system! 'gem install bundler --conservative'
-  system('bundle check') || system!('bundle install')
+  puts "== Installing dependencies =="
+  system! "gem install bundler --conservative"
+  system("bundle check") || system!("bundle install")
 
   # Install JavaScript dependencies if using Yarn
   # system('bin/yarn')
 
   puts "\n== Updating database =="
-  system! 'bin/rails db:migrate'
+  system! "bin/rails db:migrate"
 
   puts "\n== Removing old logs and tempfiles =="
-  system! 'bin/rails log:clear tmp:clear'
+  system! "bin/rails log:clear tmp:clear"
 
   puts "\n== Restarting application server =="
-  system! 'bin/rails restart'
+  system! "bin/rails restart"
 end

data/demo/bin/yarn

@@ -1,11 +1,11 @@
 #!/usr/bin/env ruby
-APP_ROOT = File.expand_path('..', __dir__)
+APP_ROOT = File.expand_path("..", __dir__)
 Dir.chdir(APP_ROOT) do
   begin
     exec "yarnpkg #{ARGV.join(' ')}"
   rescue Errno::ENOENT
-    $stderr.puts "Yarn executable was not detected in the system."
-    $stderr.puts "Download Yarn at https://yarnpkg.com/en/docs/install"
+    warn "Yarn executable was not detected in the system."
+    warn "Download Yarn at https://yarnpkg.com/en/docs/install"
     exit 1
   end
 end

data/demo/config.ru

@@ -1,5 +1,5 @@
 # This file is used by Rack-based servers to start the application.
 
-require_relative 'config/environment'
+require_relative "config/environment"
 
 run Rails.application

data/demo/config/application.rb

@@ -1,6 +1,6 @@
-require_relative 'boot'
+require_relative "boot"
 
-require 'rails/all'
+require "rails/all"
 
 Bundler.require(*Rails.groups)
 require "bootstrap_form"
@@ -13,9 +13,7 @@ module Dummy
       config.load_defaults [Rails::VERSION::MAJOR, Rails::VERSION::MINOR].join(".")
     end
 
-    if config.respond_to?(:secret_key_base)
-      config.secret_key_base = "ignore"
-    end
+    config.secret_key_base = "ignore" if config.respond_to?(:secret_key_base)
 
     # Settings in config/environments/* take precedence over those specified here.
     # Application configuration should go into files in config/initializers

data/demo/config/environments/development.rb

@@ -14,12 +14,12 @@ Rails.application.configure do
 
   # Enable/disable caching. By default caching is disabled.
   # Run rails dev:cache to toggle caching.
-  if Rails.root.join('tmp/caching-dev.txt').exist?
+  if Rails.root.join("tmp/caching-dev.txt").exist?
     config.action_controller.perform_caching = true
 
     config.cache_store = :memory_store
     config.public_file_server.headers = {
-      'Cache-Control' => "public, max-age=#{2.days.to_i}"
+      "Cache-Control" => "public, max-age=#{2.days.to_i}"
     }
   else
     config.action_controller.perform_caching = false
@@ -28,9 +28,7 @@ Rails.application.configure do
   end
 
   # Store uploaded files on the local file system (see config/storage.yml for options)
-  if config.respond_to?(:active_storage)
-    config.active_storage.service = :local
-  end
+  config.active_storage.service = :local if config.respond_to?(:active_storage)
 
   # Don't care if the mailer can't send.
   config.action_mailer.raise_delivery_errors = false

data/demo/config/environments/test.rb

@@ -15,7 +15,7 @@ Rails.application.configure do
   # Configure public file server for tests with Cache-Control for performance.
   config.public_file_server.enabled = true
   config.public_file_server.headers = {
-    'Cache-Control' => "public, max-age=#{1.hour.to_i}"
+    "Cache-Control" => "public, max-age=#{1.hour.to_i}"
   }
 
   # Show full error reports and disable caching.
@@ -29,9 +29,7 @@ Rails.application.configure do
   config.action_controller.allow_forgery_protection = false
 
   # Store uploaded files on the local file system in a temporary directory
-  if config.respond_to?(:active_storage)
-    config.active_storage.service = :test
-  end
+  config.active_storage.service = :test if config.respond_to?(:active_storage)
 
   config.action_mailer.perform_caching = false
 

data/demo/config/initializers/assets.rb

@@ -1,12 +1,12 @@
 # Be sure to restart your server when you modify this file.
 
 # Version of your assets, change this if you want to expire all your assets.
-Rails.application.config.assets.version = '1.0'
+Rails.application.config.assets.version = "1.0"
 
 # Add additional assets to the asset load path.
 # Rails.application.config.assets.paths << Emoji.images_path
 # Add Yarn node_modules folder to the asset load path.
-Rails.application.config.assets.paths << Rails.root.join('node_modules')
+Rails.application.config.assets.paths << Rails.root.join("node_modules")
 
 # Precompile additional assets.
 # application.js, application.css, and all non-JS/CSS in the app/assets

data/lib/bootstrap_form.rb

@@ -1,5 +1,5 @@
-require 'bootstrap_form/form_builder'
-require 'bootstrap_form/helper'
+require "bootstrap_form/form_builder"
+require "bootstrap_form/helper"
 
 module BootstrapForm
   module Rails

data/lib/bootstrap_form/aliasing.rb

@@ -13,7 +13,8 @@ module BootstrapForm
 
       # Strip out punctuation on predicates, bang or writer methods since
       # e.g. target?_without_feature is not a valid method name.
-      aliased_target, punctuation = target.to_s.sub(/([?!=])$/, ''), $1
+      aliased_target = target.to_s.sub(/([?!=])$/, "")
+      punctuation = Regexp.last_match(1)
       yield(aliased_target, punctuation) if block_given?
 
       with_method = "#{aliased_target}_with_#{feature}#{punctuation}"
@@ -22,12 +23,11 @@ module BootstrapForm
       alias_method without_method, target
       alias_method target, with_method
 
-      case
-      when public_method_defined?(without_method)
+      if public_method_defined?(without_method)
         public target
-      when protected_method_defined?(without_method)
+      elsif protected_method_defined?(without_method)
         protected target
-      when private_method_defined?(without_method)
+      elsif private_method_defined?(without_method)
         private target
       end
     end