bootstrap_form 5.0.0 → 5.2.0

data/lib/bootstrap_form/inputs/check_box.rb

@@ -9,14 +9,11 @@ module BootstrapForm
       included do
         def check_box_with_bootstrap(name, options={}, checked_value="1", unchecked_value="0", &block)
           options = options.symbolize_keys!
-          check_box_options = options.except(:class, :label, :label_class, :error_message, :help,
-                                             :inline, :hide_label, :skip_label, :wrapper_class, :switch)
-          check_box_options[:class] = check_box_classes(name, options)
 
-          tag.div(class: check_box_wrapper_class(options)) do
-            html = check_box_without_bootstrap(name, check_box_options, checked_value, unchecked_value)
-            html.concat(check_box_label(name, options, checked_value, &block)) unless options[:skip_label]
-            html.concat(generate_error(name)) if options[:error_message]
+          tag.div(class: check_box_wrapper_class(options), **options[:wrapper].to_h.except(:class)) do
+            html = check_box_without_bootstrap(name, check_box_options(name, options), checked_value, unchecked_value)
+            html << check_box_label(name, options, checked_value, &block) unless options[:skip_label]
+            html << generate_error(name) if options[:error_message]
             html
           end
         end
@@ -26,6 +23,13 @@ module BootstrapForm
 
       private
 
+      def check_box_options(name, options)
+        check_box_options = options.except(:class, :label, :label_class, :error_message, :help,
+                                           :inline, :hide_label, :skip_label, :wrapper, :wrapper_class, :switch)
+        check_box_options[:class] = check_box_classes(name, options)
+        check_box_options.merge!(required_field_options(options, name))
+      end
+
       def check_box_label(name, options, checked_value, &block)
         label_name = if options[:multiple]
                        check_box_value(name, checked_value)
@@ -59,6 +63,7 @@ module BootstrapForm
       def check_box_label_class(options)
         classes = ["form-check-label"]
         classes << options[:label_class]
+        classes << "required" if options[:required]
         classes << hide_class if options[:hide_label]
         classes.flatten.compact
       end
@@ -66,10 +71,23 @@ module BootstrapForm
       def check_box_wrapper_class(options)
         classes = ["form-check"]
         classes << "form-check-inline" if layout_inline?(options[:inline])
+        classes << "mb-3" unless options[:multiple] || layout == :horizontal
         classes << "form-switch" if options[:switch]
-        classes << options[:wrapper_class] if options[:wrapper_class].present?
+        classes << options.dig(:wrapper, :class).presence
+        classes << options[:wrapper_class].presence
         classes.flatten.compact
       end
+
+      def checkbox_required(options, method)
+        if options[:skip_required]
+          warn "`:skip_required` is deprecated, use `:required: false` instead"
+          false
+        elsif options.key?(:required)
+          options[:required]
+        else
+          required_attribute?(object, method)
+        end
+      end
     end
   end
 end

data/lib/bootstrap_form/inputs/collection_check_boxes.rb

@@ -13,7 +13,11 @@ module BootstrapForm
             options[:multiple] = true
             check_box(name, options, value, nil)
           end
-          hidden_field(args.first, value: "", multiple: true).concat(html)
+
+          if args.extract_options!.symbolize_keys!.delete(:include_hidden) { true }
+            html.prepend hidden_field(args.first, value: "", multiple: true)
+          end
+          html
         end
 
         bootstrap_alias :collection_check_boxes

data/lib/bootstrap_form/inputs/collection_select.rb

@@ -12,7 +12,7 @@ module BootstrapForm
         def collection_select_with_bootstrap(method, collection, value_method, text_method, options={}, html_options={})
           html_options = html_options.reverse_merge(control_class: "form-select")
           form_group_builder(method, options, html_options) do
-            input_with_error(method) do
+            prepend_and_append_input(method, options) do
               collection_select_without_bootstrap(method, collection, value_method, text_method, options, html_options)
             end
           end

data/lib/bootstrap_form/inputs/grouped_collection_select.rb

@@ -14,7 +14,7 @@ module BootstrapForm
                                                      option_value_method, options={}, html_options={})
           html_options = html_options.reverse_merge(control_class: "form-select")
           form_group_builder(method, options, html_options) do
-            input_with_error(method) do
+            prepend_and_append_input(method, options) do
               grouped_collection_select_without_bootstrap(method, collection, group_method,
                                                           group_label_method, option_key_method,
                                                           option_value_method, options, html_options)

data/lib/bootstrap_form/inputs/radio_button.rb

@@ -9,15 +9,12 @@ module BootstrapForm
       included do
         def radio_button_with_bootstrap(name, value, *args)
           options = args.extract_options!.symbolize_keys!
-          radio_button_options = options.except(:class, :label, :label_class, :error_message, :help,
-                                                :inline, :hide_label, :skip_label, :wrapper_class)
-
-          radio_button_options[:class] = radio_button_classes(name, options)
-
-          tag.div(class: radio_button_wrapper_class(options)) do
-            html = radio_button_without_bootstrap(name, value, radio_button_options)
-            html.concat(radio_button_label(name, value, options)) unless options[:skip_label]
-            html.concat(generate_error(name)) if options[:error_message]
+          wrapper_attributes = options[:wrapper] || {}
+          wrapper_attributes[:class] = radio_button_wrapper_class(options)
+          tag.div(**wrapper_attributes) do
+            html = radio_button_without_bootstrap(name, value, radio_button_options(name, options))
+            html << radio_button_label(name, value, options) unless options[:skip_label]
+            html << generate_error(name) if options[:error_message]
             html
           end
         end
@@ -27,6 +24,13 @@ module BootstrapForm
 
       private
 
+      def radio_button_options(name, options)
+        radio_button_options = options.except(:class, :label, :label_class, :error_message, :help,
+                                              :inline, :hide_label, :skip_label, :wrapper, :wrapper_class)
+        radio_button_options[:class] = radio_button_classes(name, options)
+        radio_button_options.merge!(required_field_options(options, name))
+      end
+
       def radio_button_label(name, value, options)
         label_options = { value: value, class: radio_button_label_class(options) }
         label_options[:for] = options[:id] if options[:id].present?
@@ -51,7 +55,8 @@ module BootstrapForm
         classes = ["form-check"]
         classes << "form-check-inline" if layout_inline?(options[:inline])
         classes << "disabled" if options[:disabled]
-        classes << options[:wrapper_class] if options[:wrapper_class].present?
+        classes << options.dig(:wrapper, :class).presence
+        classes << options[:wrapper_class].presence
         classes.flatten.compact
       end
     end

data/lib/bootstrap_form/version.rb

@@ -1,3 +1,4 @@
 module BootstrapForm
-  VERSION = "5.0.0".freeze
+  VERSION = "5.2.0".freeze
+  REQUIRED_RAILS_VERSION = ">= 6.0".freeze
 end

data/lib/bootstrap_form.rb

@@ -1,7 +1,7 @@
 # NOTE: The rich_text_area and rich_text_area_tag helpers are defined in a file with a different
 # name and not in the usual autoload-reachable way.
 # The following line is definitely need to make `bootstrap_form` work.
-if ::Rails::VERSION::STRING > "6"
+if Rails::VERSION::STRING > "6"
   require "#{Gem::Specification.find_by_name('actiontext').gem_dir}/app/helpers/action_text/tag_helper"
 end
 require "action_view"

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: bootstrap_form
 version: !ruby/object:Gem::Version
-  version: 5.0.0
+  version: 5.2.0
 platform: ruby
 authors:
 - Stephen Potenza
 - Carlos Lopes
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-11-12 00:00:00.000000000 Z
+date: 2023-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -17,42 +17,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: activemodel
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.2'
-- !ruby/object:Gem::Dependency
-  name: rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '5.2'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '6.0'
 description: bootstrap_form is a rails form builder that makes it super easy to create
   beautiful-looking forms using Bootstrap 5
 email:
@@ -66,6 +52,7 @@ files:
 - ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rubocop.yml"
+- ".yarnrc"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - CONTRIBUTING.md
@@ -81,70 +68,11 @@ files:
 - UPGRADE-5.0.md
 - app/assets/stylesheets/rails_bootstrap_forms.css
 - bootstrap_form.gemspec
-- demo/.postcssrc.yml
-- demo/README.md
-- demo/Rakefile
-- demo/app/assets/config/manifest.js
-- demo/app/assets/stylesheets/actiontext.scss
-- demo/app/assets/stylesheets/application.scss
-- demo/app/controllers/application_controller.rb
-- demo/app/controllers/bootstrap_controller.rb
-- demo/app/helpers/bootstrap_helper.rb
-- demo/app/javascript/channels/consumer.js
-- demo/app/javascript/channels/index.js
-- demo/app/javascript/packs/application.js
-- demo/app/models/address.rb
-- demo/app/models/application_record.rb
-- demo/app/models/faux_user.rb
-- demo/app/models/super_user.rb
-- demo/app/models/user.rb
-- demo/app/views/active_storage/blobs/_blob.html.erb
-- demo/app/views/bootstrap/form.html.erb
-- demo/app/views/layouts/application.html.erb
-- demo/bin/bundle
-- demo/bin/rails
-- demo/bin/rake
-- demo/bin/setup
-- demo/bin/update
-- demo/bin/webpack
-- demo/bin/webpack-dev-server
-- demo/bin/yarn
-- demo/config.ru
-- demo/config/application.rb
-- demo/config/boot.rb
-- demo/config/database.yml
-- demo/config/environment.rb
-- demo/config/environments/development.rb
-- demo/config/environments/production.rb
-- demo/config/environments/test.rb
-- demo/config/initializers/application_controller_renderer.rb
-- demo/config/initializers/assets.rb
-- demo/config/initializers/backtrace_silencers.rb
-- demo/config/initializers/cookies_serializer.rb
-- demo/config/initializers/filter_parameter_logging.rb
-- demo/config/initializers/inflections.rb
-- demo/config/initializers/mime_types.rb
-- demo/config/initializers/wrap_parameters.rb
-- demo/config/locales/en.yml
-- demo/config/puma.rb
-- demo/config/routes.rb
-- demo/config/spring.rb
-- demo/config/storage.yml
-- demo/config/webpack/development.js
-- demo/config/webpack/environment.js
-- demo/config/webpack/production.js
-- demo/config/webpack/test.js
-- demo/config/webpacker.yml
-- demo/db/schema.rb
-- demo/log/.keep
-- demo/package.json
-- demo/public/favicon.ico
-- demo/test/fixtures/action_text/rich_texts.yml
-- demo/yarn.lock
 - docker-compose.yml
-- gemfiles/5.2.gemfile
 - gemfiles/6.0.gemfile
 - gemfiles/6.1.gemfile
+- gemfiles/7.0.gemfile
+- gemfiles/common.gemfile
 - gemfiles/edge.gemfile
 - lib/bootstrap_form.rb
 - lib/bootstrap_form/action_view_extensions/form_helper.rb
@@ -160,6 +88,7 @@ files:
 - lib/bootstrap_form/form_group_builder.rb
 - lib/bootstrap_form/helpers.rb
 - lib/bootstrap_form/helpers/bootstrap.rb
+- lib/bootstrap_form/helpers/field.rb
 - lib/bootstrap_form/inputs.rb
 - lib/bootstrap_form/inputs/base.rb
 - lib/bootstrap_form/inputs/check_box.rb
@@ -197,8 +126,9 @@ files:
 homepage: https://github.com/bootstrap-ruby/bootstrap_form
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -206,16 +136,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.4.10
+signing_key:
 specification_version: 4
 summary: Rails form builder that makes it easy to style forms using Bootstrap 5
 test_files: []

data/demo/.postcssrc.yml

@@ -1,3 +0,0 @@
-plugins:
-  postcss-import: {}
-  postcss-cssnext: {}

data/demo/README.md

@@ -1,17 +0,0 @@
-# DEMO APP (Rails 5.2)
-
-### Usage
-
-- `rake db:schema:load`
-- `rails s`
-- Navigate to http://localhost:3000
-
-### Following files were added or changed:
-
-- db/schema.rb
-- config/{application, routes, boot}.rb
-- config/environments/{development, test}.rb
-- app/models/{address,user,super_user,faux_user}.rb
-- app/controllers/bootstrap_controller.rb
-- app/views/layouts/application.html.erb
-- app/views/bootstrap/form.html.erb

data/demo/Rakefile

@@ -1,6 +0,0 @@
-# Add your own tasks in files placed in lib/tasks ending in .rake,
-# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
-
-require_relative 'config/application'
-
-Rails.application.load_tasks

data/demo/app/assets/config/manifest.js

@@ -1 +0,0 @@
-//= link application.css

data/demo/app/assets/stylesheets/actiontext.scss

@@ -1,38 +0,0 @@
-//
-// Provides a drop-in pointer for the default Trix stylesheet that will format the toolbar and
-// the trix-editor content (whether displayed or under editing). Feel free to incorporate this
-// inclusion directly in any other asset bundle and remove this file.
-//
-//= require trix/dist/trix
-// When using `application.scss`, this has to be `import`, not `require`.
-@import "trix/dist/trix";
-
-// We need to override trix.css’s image gallery styles to accommodate the
-// <action-text-attachment> element we wrap around attachments. Otherwise,
-// images in galleries will be squished by the max-width: 33%; rule.
-.trix-content {
-  .attachment-gallery {
-    > action-text-attachment,
-    > .attachment {
-      flex: 1 0 33%;
-      padding: 0 0.5em;
-      max-width: 33%;
-    }
-
-    &.attachment-gallery--2,
-    &.attachment-gallery--4 {
-      > action-text-attachment,
-      > .attachment {
-        flex-basis: 50%;
-        max-width: 50%;
-      }
-    }
-  }
-
-  action-text-attachment {
-    .attachment {
-      padding: 0 !important;
-      max-width: 100% !important;
-    }
-  }
-}

data/demo/app/assets/stylesheets/application.scss

@@ -1 +0,0 @@
-@import "actiontext";

data/demo/app/controllers/application_controller.rb

@@ -1,2 +0,0 @@
-class ApplicationController < ActionController::Base
-end

data/demo/app/controllers/bootstrap_controller.rb

@@ -1,14 +0,0 @@
-class BootstrapController < ApplicationController
-  def form
-    @collection = [
-      Address.new(id: 1, street: "Foo"),
-      Address.new(id: 2, street: "Bar")
-    ]
-
-    @user = User.new
-
-    @user_with_error = User.new
-    @user_with_error.errors.add(:email)
-    @user_with_error.errors.add(:misc)
-  end
-end

data/demo/app/helpers/bootstrap_helper.rb

@@ -1,27 +0,0 @@
-module BootstrapHelper
-  def form_with_source(&block)
-    form_html = capture(&block)
-
-    tag.div(class: "example") do
-      concat(form_html)
-      concat(toggle)
-      concat(codemirror(form_html))
-    end
-  end
-
-  private
-
-  def codemirror(form_html)
-    tag.div(class: "code", style: "display: none") do
-      tag.textarea(class: "codemirror") do
-        HtmlBeautifier.beautify(form_html.strip.gsub(">", ">\n").gsub("<", "\n<"))
-      end
-    end
-  end
-
-  def toggle
-    tag.button(class: "toggle btn btn-sm btn-info") do
-      "Show Source Code"
-    end
-  end
-end

data/demo/app/javascript/channels/consumer.js

@@ -1,6 +0,0 @@
-// Action Cable provides the framework to deal with WebSockets in Rails.
-// You can generate new channels where WebSocket features live using the `rails generate channel` command.
-
-import { createConsumer } from "@rails/actioncable"
-
-export default createConsumer()

data/demo/app/javascript/channels/index.js

@@ -1,5 +0,0 @@
-// Load all the channels within this directory and all subdirectories.
-// Channel files must be named *_channel.js.
-
-const channels = require.context('.', true, /_channel\.js$/)
-channels.keys().forEach(channels)

data/demo/app/javascript/packs/application.js

@@ -1,11 +0,0 @@
-// This file is automatically compiled by Webpack, along with any other files
-// present in this directory. You're encouraged to place your actual application logic in
-// a relevant structure within app/javascript and only use these pack files to reference
-// that code so it'll be compiled.
-
-require("@rails/ujs").start()
-require("turbolinks").start()
-require("@rails/activestorage").start()
-require("channels")
-require("trix")
-require("@rails/actiontext")

data/demo/app/models/address.rb

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

data/demo/app/models/application_record.rb

@@ -1,3 +0,0 @@
-class ApplicationRecord < ActiveRecord::Base
-  self.abstract_class = true
-end

data/demo/app/models/faux_user.rb

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

data/demo/app/models/super_user.rb

@@ -1,2 +0,0 @@
-class SuperUser < User
-end

data/demo/app/models/user.rb

@@ -1,11 +0,0 @@
-class User < ApplicationRecord
-  serialize :preferences
-
-  validates :email, presence: true, length: { minimum: 5 }
-  validates :terms, acceptance: { accept: true }
-
-  has_one :address
-  accepts_nested_attributes_for :address
-
-  has_rich_text(:life_story) if Rails::VERSION::STRING > "6"
-end

data/demo/app/views/active_storage/blobs/_blob.html.erb

@@ -1,14 +0,0 @@
-<figure class="attachment attachment--<%= blob.representable? ? "preview" : "file" %> attachment--<%= blob.filename.extension %>">
-  <% if blob.representable? %>
-    <%= image_tag blob.representation(resize_to_fit: local_assigns[:in_gallery] ? [ 800, 600 ] : [ 1024, 768 ]) %>
-  <% end %>
-
-  <figcaption class="attachment__caption">
-    <% if caption = blob.try(:caption) %>
-      <%= caption %>
-    <% else %>
-      <span class="attachment__name"><%= blob.filename %></span>
-      <span class="attachment__size"><%= number_to_human_size blob.byte_size %></span>
-    <% end %>
-  </figcaption>
-</figure>

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

@@ -1,67 +0,0 @@
-<h3>Horizontal Form</h3>
-
-<%= form_with_source do %>
-  <%= bootstrap_form_with model: @user, layout: :horizontal, local: true do |form| %>
-    <%= form.email_field :email, placeholder: "Enter Email", label: "Email address", help: "We'll never share your email with anyone else" %>
-    <%= form.password_field :password, placeholder: "Password" %>
-    <%= form.select :status, [['activated', 1], ['blocked', 2]], prompt: "Please Select" %>
-    <%= form.text_area :misc %>
-    <%= form.check_box :terms, label: "Agree to Terms" %>
-    <%= form.collection_check_boxes :misc, @collection, :id, :street %>
-    <%= form.collection_radio_buttons :misc, @collection, :id, :street %>
-    <%= form.file_field :misc %>
-    <%= form.datetime_select :misc, include_blank: true %>
-
-    <%= form.submit %>
-  <% end %>
-<% end %>
-
-<h3>With Validation Error</h3>
-
-<%= form_with_source do %>
-  <%= bootstrap_form_for @user_with_error, layout: :horizontal do |form| %>
-    <%= form.alert_message "This is an alert" %>
-    <%= form.error_summary %>
-    <%= form.email_field :email, placeholder: "Enter Email", label: "Email address", help: "We'll never share your email with anyone else" %>
-    <%= form.collection_check_boxes :misc, @collection, :id, :street %>
-    <%= form.submit %>
-  <% end %>
-<% end %>
-
-<h3>Inline Form</h3>
-
-<%= form_with_source do %>
-  <%= bootstrap_form_for @user, layout: :inline do |form| %>
-    <%= form.email_field :email, placeholder: "Enter Email", label: "Email address", help: "We'll never share your email with anyone else" %>
-    <%= form.password_field :password, placeholder: "Password" %>
-    <%= form.check_box :terms, label: "Agree to Terms" %>
-    <%= form.collection_check_boxes :misc, @collection, :id, :street %>
-    <%= form.submit %>
-  <% end %>
-<% end %>
-
-<h3>Simple Action Text Example</h3>
-
-<%= form_with_source do %>
-  <%= bootstrap_form_for @user, url: "/" do |form| %>
-    <%= form.email_field :email, placeholder: "Enter Email", label: "Email address", help: "We'll never share your email with anyone else" %>
-    <%= form.password_field :password, placeholder: "Password" %>
-    <%= form.check_box :terms, label: "Agree to Terms" %>
-    <%= form.collection_check_boxes :misc, @collection, :id, :street %>
-    <%= form.rich_text_area(:life_story) if Rails::VERSION::STRING > "6" %>
-    <%= form.submit %>
-  <% end %>
-<% end %>
-
-<h3>Floating Labels</h3>
-
-<%= form_with_source do %>
-  <%= bootstrap_form_for @user do |form| %>
-    <%= form.email_field :email, placeholder: "Enter Email", label: "Email address", help: "We'll never share your email with anyone else", floating: true %>
-    <%= form.password_field :password, placeholder: "Password", floating: true %>
-    <%= form.text_field :misc, floating: true %>
-    <%= form.text_area :comments, floating: true %>
-    <%= form.select :status, [["Active", 1], ["Inactive", 2]], include_blank: "Select a value", floating: true %>
-    <%= form.submit %>
-  <% end %>
-<% end %>