bootstrap_form 4.4.0 → 5.1.0

data/docker-compose.yml

@@ -0,0 +1,49 @@
+version: '3.3'
+
+services:
+  app: &app
+    build:
+      context: .
+      args:
+        NODE_MAJOR: '12'
+        YARN_VERSION: '1.22.4'
+    image: bootstrap-form:0.0.1
+    tmpfs:
+      - /tmp
+
+  shell: &shell
+    <<: *app
+    stdin_open: true
+    tty: true
+    volumes:
+      - .:/app:cached
+      # - rails_cache:/app/tmp/cache
+      # - bundle:/app/vendor/bundle
+      # - node_modules:/app/node_modules
+      # - packs:/app/public/packs
+      - /etc/passwd:/etc/passwd:ro
+      # One or the other of the following lines might be redundant, or one might be
+      # better than the other.
+      - ~/.ssh:${HOME}/.ssh
+      - ${SSH_AUTH_SOCK}:/ssh-agent
+    environment:
+      - SSH_AUTH_SOCK=/ssh-agent
+      - NODE_ENV=development
+      - RAILS_ENV=${RAILS_ENV:-development}
+      - BOOTSNAP_CACHE_DIR=/usr/local/bundle/_bootsnap
+      - WEBPACKER_DEV_SERVER_HOST=webpacker
+      - WEB_CONCURRENCY=1
+      - HISTFILE=/app/.bash_history
+    command: /bin/bash
+
+  # server:
+  #   <<: *shell
+  #   command: sh -c "cd demo/app && bundle exec rails server -b 0.0.0.0"
+  #   ports:
+  #     - '3000:3000'
+
+# volumes:
+#   bundle:
+#   node_modules:
+#   rails_cache:
+#   packs:

data/gemfiles/5.2.gemfile

@@ -1,17 +1,4 @@
-source "http://rubygems.org"
-
-gemspec path: "../"
+gems = "#{File.dirname __dir__}/Gemfile"
+eval File.read(gems), binding, gems # rubocop: disable Security/Eval
 
 gem "rails", "~> 5.2.0"
-
-group :development do
-  gem "rubocop-rails", require: false
-end
-
-group :test do
-  gem "diffy"
-  gem "equivalent-xml"
-  gem "mocha"
-  gem "sqlite3", "~> 1.4"
-  gem "timecop", "~> 0.7.1"
-end

data/gemfiles/6.0.gemfile

@@ -1,19 +1,4 @@
-source "http://rubygems.org"
-
-gemspec path: "../"
+gems = "#{File.dirname __dir__}/Gemfile"
+eval File.read(gems), binding, gems # rubocop: disable Security/Eval
 
 gem "rails", "~> 6.0.0"
-
-group :development do
-  gem "rubocop-rails", require: false
-  gem "sassc"
-  gem "webpacker", ">= 4.0.0.rc.3"
-end
-
-group :test do
-  gem "diffy"
-  gem "equivalent-xml"
-  gem "mocha"
-  gem "sqlite3"
-  gem "timecop", "~> 0.7.1"
-end

data/gemfiles/6.1.gemfile

@@ -0,0 +1,4 @@
+gems = "#{File.dirname __dir__}/Gemfile"
+eval File.read(gems), binding, gems # rubocop: disable Security/Eval
+
+gem "rails", "~> 6.1.0"

data/gemfiles/7.0.gemfile

@@ -0,0 +1,6 @@
+gems = "#{File.dirname __dir__}/Gemfile"
+eval File.read(gems), binding, gems # rubocop: disable Security/Eval
+
+# 7.0.0 has an issue with Ruby 3.1.
+# And a test case has an issue with 7.0.1
+gem "rails", "~> 7.0.2"

data/gemfiles/edge.gemfile

@@ -1,19 +1,4 @@
-source "http://rubygems.org"
-
-gemspec path: "../"
+gems = "#{File.dirname __dir__}/Gemfile"
+eval File.read(gems), binding, gems # rubocop: disable Security/Eval
 
 gem "rails", git: "https://github.com/rails/rails.git"
-
-group :development do
-  gem "rubocop-rails", require: false
-  gem "sassc-rails"
-  gem "webpacker"
-end
-
-group :test do
-  gem "diffy"
-  gem "equivalent-xml"
-  gem "mocha"
-  gem "sqlite3"
-  gem "timecop", "~> 0.7.1"
-end

data/lib/bootstrap_form/action_view_extensions/form_helper.rb

@@ -29,7 +29,7 @@ module BootstrapForm
         options.reverse_merge!(builder: BootstrapForm::FormBuilder)
 
         with_bootstrap_form_field_error_proc do
-          form_with(options, &block)
+          form_with(**options, &block)
         end
       end
 

data/lib/bootstrap_form/components/hints.rb

@@ -8,7 +8,7 @@ module BootstrapForm
       private
 
       def generate_help(name, help_text)
-        return if help_text == false || inline_error?(name)
+        return if help_text == false
 
         help_klass ||= "form-text text-muted"
         help_text ||= get_help_text_by_i18n_key(name)
@@ -20,10 +20,10 @@ module BootstrapForm
       def get_help_text_by_i18n_key(name)
         return unless object
 
-        partial_scope = if object.class.respond_to?(:model_name)
-                          object.class.model_name.name
+        partial_scope = if object_class.respond_to?(:model_name)
+                          object_class.model_name.name
                         else
-                          object.class.name
+                          object_class.name
                         end
 
         # First check for a subkey :html, as it is also accepted by i18n, and the
@@ -38,6 +38,15 @@ module BootstrapForm
         help_text
       end
 
+      def object_class
+        if !object.class.is_a?(ActiveModel::Naming) &&
+           object.respond_to?(:klass) && object.klass.is_a?(ActiveModel::Naming)
+          object.klass
+        else
+          object.class
+        end
+      end
+
       def scoped_help_text(name, partial_scope)
         underscored_scope = "activerecord.help.#{partial_scope.underscore}"
         downcased_scope = "activerecord.help.#{partial_scope.downcase}"

data/lib/bootstrap_form/components/labels.rb

@@ -23,7 +23,7 @@ module BootstrapForm
       end
 
       def label_classes(name, options, custom_label_col, group_layout)
-        classes = [options[:class], label_layout_classes(custom_label_col, group_layout)]
+        classes = ["form-label", options[:class], label_layout_classes(custom_label_col, group_layout)]
 
         case options.delete(:required)
         when true
@@ -48,7 +48,7 @@ module BootstrapForm
         if label_errors && error?(name)
           (options[:text] || object.class.human_attribute_name(name)).to_s.concat(" #{get_error_messages(name)}")
         else
-          options[:text]
+          options[:text] || object&.class.try(:human_attribute_name, name)
         end
       end
     end

data/lib/bootstrap_form/components/validation.rb

@@ -14,7 +14,7 @@ module BootstrapForm
       def required_attribute?(obj, attribute)
         return false unless obj && attribute
 
-        target = obj.class == Class ? obj : obj.class
+        target = obj.instance_of?(Class) ? obj : obj.class
 
         target_validators = if target.respond_to? :validators_on
                               target.validators_on(attribute).map(&:class)

data/lib/bootstrap_form/configuration.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module BootstrapForm
+  class Configuration
+    def default_form_attributes=(attributes)
+      case attributes
+      when nil
+        @default_form_attributes = {}
+      when Hash
+        @default_form_attributes = attributes
+      else
+        raise ArgumentError, "Unsupported default_form_attributes #{attributes.inspect}"
+      end
+    end
+
+    def default_form_attributes
+      return @default_form_attributes if defined? @default_form_attributes
+
+      {}
+    end
+  end
+end

data/lib/bootstrap_form/form_builder.rb

@@ -43,9 +43,8 @@ module BootstrapForm
     include BootstrapForm::Inputs::UrlField
     include BootstrapForm::Inputs::WeekField
 
-    delegate :content_tag, :capture, :concat, to: :@template
+    delegate :content_tag, :capture, :concat, :tag, to: :@template
 
-    # rubocop:disable Metrics/AbcSize
     def initialize(object_name, object, template, options)
       @layout = options[:layout] || default_layout
       @label_col = options[:label_col] || default_label_col
@@ -58,24 +57,24 @@ module BootstrapForm
                          options[:inline_errors] != false
                        end
       @acts_like_form_tag = options[:acts_like_form_tag]
-      add_form_role_and_form_inline options
+      add_default_form_attributes_and_form_inline options
       super
     end
-    # rubocop:enable Metrics/AbcSize
 
-    def add_form_role_and_form_inline(options)
+    def add_default_form_attributes_and_form_inline(options)
       options[:html] ||= {}
-      options[:html][:role] ||= "form"
+      options[:html].reverse_merge!(BootstrapForm.config.default_form_attributes)
 
       return unless options[:layout] == :inline
 
-      options[:html][:class] = [options[:html][:class], "form-inline"].compact.join(" ")
+      options[:html][:class] =
+        ([*options[:html][:class]&.split(/\s+/)] + %w[row row-cols-auto g-3 align-items-center])
+        .compact.uniq.join(" ")
     end
 
     def fields_for_with_bootstrap(record_name, record_object=nil, fields_options={}, &block)
       fields_options = fields_for_options(record_object, fields_options)
-      record_object.is_a?(Hash) && record_object.extractable_options? &&
-        record_object = nil
+      record_object = nil if record_object.is_a?(Hash) && record_object.extractable_options?
       fields_for_without_bootstrap(record_name, record_object, fields_options, &block)
     end
 
@@ -89,8 +88,7 @@ module BootstrapForm
 
     def fields_for_options(record_object, fields_options)
       field_options = fields_options
-      record_object.is_a?(Hash) && record_object.extractable_options? &&
-        field_options = record_object
+      field_options = record_object if record_object.is_a?(Hash) && record_object.extractable_options?
       %i[layout control_col inline_errors label_errors].each do |option|
         field_options[option] ||= options[option]
       end
@@ -116,7 +114,7 @@ module BootstrapForm
     end
 
     def hide_class
-      "sr-only" # still accessible for screen readers
+      "visually-hidden" # still accessible for screen readers
     end
 
     def control_class

data/lib/bootstrap_form/form_group.rb

@@ -10,9 +10,9 @@ module BootstrapForm
 
       options[:class] = form_group_classes(options)
 
-      content_tag(:div, options.except(:append, :id, :label, :help, :icon,
-                                       :input_group_class, :label_col, :control_col,
-                                       :add_control_col_class, :layout, :prepend)) do
+      tag.div(**options.except(:append, :id, :label, :help, :icon,
+                               :input_group_class, :label_col, :control_col,
+                               :add_control_col_class, :layout, :prepend, :floating)) do
         form_group_content(
           generate_label(options[:id], name, options[:label], options[:label_col], options[:layout]),
           generate_help(name, options[:help]), options, &block
@@ -24,8 +24,8 @@ module BootstrapForm
 
     def form_group_content_tag(name, field_name, without_field_name, options, html_options)
       html_class = control_specific_class(field_name)
-      html_class = "#{html_class} form-inline" if @layout == :horizontal && options[:skip_inline].blank?
-      content_tag(:div, class: html_class) do
+      html_class = "#{html_class} col-auto g-3" if @layout == :horizontal && options[:skip_inline].blank?
+      tag.div(class: html_class) do
         input_with_error(name) do
           send(without_field_name, name, options, html_options)
         end
@@ -34,10 +34,12 @@ module BootstrapForm
 
     def form_group_content(label, help_text, options, &block)
       if group_layout_horizontal?(options[:layout])
-        concat(label).concat(content_tag(:div, capture(&block) + help_text, class: form_group_control_class(options)))
+        concat(label).concat(tag.div(capture(&block) + help_text, class: form_group_control_class(options)))
       else
-        concat(label)
+        # Floating labels need to be rendered after the field
+        concat(label) unless options[:floating]
         concat(capture(&block))
+        concat(label) if options[:floating]
         concat(help_text) if help_text
       end
     end
@@ -50,15 +52,28 @@ module BootstrapForm
     end
 
     def form_group_classes(options)
-      classes = ["form-group", options[:class].try(:split)].flatten.compact
-      classes << "row" if group_layout_horizontal?(options[:layout]) && classes.exclude?("form-row")
-      classes << "form-inline" if field_inline_override?(options[:layout])
+      classes = options[:class] == false ? [] : (options[:class] || form_group_default_class).split
+      classes << "row" if horizontal_group_with_gutters?(options[:layout], classes)
+      classes << "col-auto g-3" if field_inline_override?(options[:layout])
       classes << feedback_class if options[:icon]
-      classes
+      classes << "form-floating" if options[:floating]
+      classes.presence
+    end
+
+    def form_group_default_class
+      (layout == :inline ? "col" : "mb-3")
+    end
+
+    def horizontal_group_with_gutters?(layout, classes)
+      group_layout_horizontal?(layout) && !classes_include_gutters?(classes)
     end
 
     def group_layout_horizontal?(layout)
       get_group_layout(layout) == :horizontal
     end
+
+    def classes_include_gutters?(classes)
+      classes.any? { |c| c =~ /^g-\d+$/ }
+    end
   end
 end

data/lib/bootstrap_form/form_group_builder.rb

@@ -6,7 +6,7 @@ module BootstrapForm
 
     private
 
-    def form_group_builder(method, options, html_options=nil)
+    def form_group_builder(method, options, html_options=nil, &block)
       no_wrapper = options[:wrapper] == false
 
       options = form_group_builder_options(options, method)
@@ -21,16 +21,14 @@ module BootstrapForm
       if no_wrapper
         yield
       else
-        form_group(method, form_group_options) { yield }
+        form_group(method, form_group_options, &block)
       end
     end
 
     def form_group_builder_options(options, method)
       options.symbolize_keys!
       options = convert_form_tag_options(method, options) if acts_like_form_tag
-      unless options[:skip_label]
-        options[:required] = form_group_required(options) if options.key?(:skip_required)
-      end
+      options[:required] = form_group_required(options) if !options[:skip_label] && options.key?(:skip_required)
       options
     end
 
@@ -48,7 +46,8 @@ module BootstrapForm
         id: options[:id], help: options[:help], icon: options[:icon],
         label_col: options[:label_col], control_col: options[:control_col],
         add_control_col_class: options[:add_control_col_class],
-        layout: get_group_layout(options[:layout]), class: options[:wrapper_class]
+        layout: get_group_layout(options[:layout]), class: options[:wrapper_class],
+        floating: options[:floating]
       }
 
       form_group_options.merge!(wrapper_options) if wrapper_options.is_a?(Hash)
@@ -57,12 +56,11 @@ module BootstrapForm
     end
 
     def form_group_label(options, css_options)
-      hash = {
+      {
         text: form_group_label_text(options[:label]),
         class: form_group_label_class(options),
         required: options[:required]
       }.merge(css_options[:id].present? ? { for: css_options[:id] } : {})
-      hash
     end
 
     def form_group_label_text(label)

data/lib/bootstrap_form/helpers/bootstrap.rb

@@ -8,13 +8,13 @@ module BootstrapForm
 
       def submit(name=nil, options={})
         setup_css_class "btn btn-secondary", options
-        super
+        layout == :inline ? form_group { super } : super
       end
 
       def primary(name=nil, options={}, &block)
         setup_css_class "btn btn-primary", options
 
-        if options[:render_as_button] || block_given?
+        if options[:render_as_button] || block
           options.except! :render_as_button
           button(name, options, &block)
         else
@@ -26,18 +26,22 @@ module BootstrapForm
         css = options[:class] || "alert alert-danger"
         return unless object.respond_to?(:errors) && object.errors.full_messages.any?
 
-        content_tag :div, class: css do
-          concat content_tag :p, title
-          concat error_summary unless options[:error_summary] == false
+        tag.div class: css do
+          if options[:error_summary] == false
+            title
+          else
+            concat tag.p title
+            concat error_summary
+          end
         end
       end
 
       def error_summary
         return unless object.errors.any?
 
-        content_tag :ul, class: "rails-bootstrap-forms-error-summary" do
+        tag.ul class: "rails-bootstrap-forms-error-summary" do
           object.errors.full_messages.each do |error|
-            concat content_tag(:li, error)
+            concat tag.li(error)
           end
         end
       end
@@ -46,8 +50,9 @@ module BootstrapForm
         return unless error?(name)
 
         hide_attribute_name = options[:hide_attribute_name] || false
+        custom_class = options[:custom_class] || false
 
-        content_tag :div, class: "alert alert-danger" do
+        tag.div class: custom_class || "invalid-feedback" do
           if hide_attribute_name
             object.errors[name].join(", ")
           else
@@ -85,7 +90,7 @@ module BootstrapForm
         input = attach_input(options, :prepend) + input + attach_input(options, :append)
         input += generate_error(name)
         options.present? &&
-          input = content_tag(:div, input, class: ["input-group", options[:input_group_class]].compact)
+          input = tag.div(input, class: ["input-group", options[:input_group_class]].compact)
         input
       end
 
@@ -95,9 +100,9 @@ module BootstrapForm
       end
 
       def input_group_content(content)
-        return content if content =~ /btn/
+        return content if /btn/.match?(content)
 
-        content_tag(:span, content, class: "input-group-text")
+        tag.span(content, class: "input-group-text")
       end
 
       def static_class
@@ -108,7 +113,7 @@ module BootstrapForm
 
       def attach_input(options, key)
         tags = [*options[key]].map do |item|
-          content_tag(:div, input_group_content(item), class: "input-group-#{key}")
+          input_group_content(item)
         end
         ActiveSupport::SafeBuffer.new(tags.join)
       end

data/lib/bootstrap_form/inputs/base.rb

@@ -10,7 +10,8 @@ module BootstrapForm
           define_method "#{field_name}_with_bootstrap" do |name, options={}|
             form_group_builder(name, options) do
               prepend_and_append_input(name, options) do
-                send("#{field_name}_without_bootstrap".to_sym, name, options)
+                options[:placeholder] ||= name if options[:floating]
+                send("#{field_name}_without_bootstrap".to_sym, name, options.except(:floating))
               end
             end
           end
@@ -19,11 +20,10 @@ module BootstrapForm
         end
 
         def bootstrap_select_group(field_name)
-          with_field_name = "#{field_name}_with_bootstrap"
-          without_field_name = "#{field_name}_without_bootstrap"
-          define_method(with_field_name) do |name, options={}, html_options={}|
+          define_method("#{field_name}_with_bootstrap") do |name, options={}, html_options={}|
+            html_options = html_options.reverse_merge(control_class: "form-select")
             form_group_builder(name, options, html_options) do
-              form_group_content_tag(name, field_name, without_field_name, options, html_options)
+              form_group_content_tag(name, field_name, "#{field_name}_without_bootstrap", options, html_options)
             end
           end
 

data/lib/bootstrap_form/inputs/check_box.rb

@@ -10,10 +10,10 @@ module BootstrapForm
         def check_box_with_bootstrap(name, options={}, checked_value="1", unchecked_value="0", &block)
           options = options.symbolize_keys!
           check_box_options = options.except(:class, :label, :label_class, :error_message, :help,
-                                             :inline, :custom, :hide_label, :skip_label, :wrapper_class)
+                                             :inline, :hide_label, :skip_label, :wrapper, :wrapper_class, :switch)
           check_box_options[:class] = check_box_classes(name, options)
 
-          content_tag(:div, class: check_box_wrapper_class(options)) do
+          tag.div(class: check_box_wrapper_class(options), **options[:wrapper].to_h.except(:class)) 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]
@@ -38,7 +38,7 @@ module BootstrapForm
       end
 
       def check_box_description(name, options, &block)
-        content = block_given? ? capture(&block) : options[:label]
+        content = block ? capture(&block) : options[:label]
         content || object&.class&.human_attribute_name(name) || name.to_s.humanize
       end
 
@@ -50,40 +50,28 @@ module BootstrapForm
       end
 
       def check_box_classes(name, options)
-        classes = [options[:class]]
-        classes << (options[:custom] ? "custom-control-input" : "form-check-input")
+        classes = Array(options[:class]) << "form-check-input"
         classes << "is-invalid" if error?(name)
         classes << "position-static" if options[:skip_label] || options[:hide_label]
         classes.flatten.compact
       end
 
       def check_box_label_class(options)
-        classes = []
-        classes << (options[:custom] ? "custom-control-label" : "form-check-label")
+        classes = ["form-check-label"]
         classes << options[:label_class]
         classes << hide_class if options[:hide_label]
         classes.flatten.compact
       end
 
       def check_box_wrapper_class(options)
-        classes = []
-        if options[:custom]
-          classes << custom_check_box_wrapper_class(options)
-        else
-          classes << "form-check"
-          classes << "form-check-inline" if layout_inline?(options[:inline])
-        end
-        classes << options[:wrapper_class] if options[:wrapper_class].present?
+        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.dig(:wrapper, :class).presence
+        classes << options[:wrapper_class].presence
         classes.flatten.compact
       end
-
-      def custom_check_box_wrapper_class(options)
-        classes = []
-        classes << "custom-control"
-        classes << (options[:custom] == :switch ? "custom-switch" : "custom-checkbox")
-        classes << "custom-control-inline" if layout_inline?(options[:inline])
-        classes
-      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

@@ -10,8 +10,9 @@ module BootstrapForm
         # Disabling Metrics/ParameterLists because the upstream Rails method has the same parameters
         # rubocop:disable Metrics/ParameterLists
         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/file_field.rb

@@ -8,28 +8,16 @@ module BootstrapForm
 
       included do
         def file_field_with_bootstrap(name, options={})
-          options = options.reverse_merge(control_class: "custom-file-input")
+          options = options.reverse_merge(control_class: "form-control")
           form_group_builder(name, options) do
-            content_tag(:div, class: "custom-file") do
-              input_with_error(name) do
-                file_field_input(name, options)
-              end
+            input_with_error(name) do
+              file_field_without_bootstrap(name, options)
             end
           end
         end
 
         bootstrap_alias :file_field
       end
-
-      private
-
-      def file_field_input(name, options)
-        placeholder = options.delete(:placeholder) || "Choose file"
-        placeholder_opts = { class: "custom-file-label" }
-        placeholder_opts[:for] = options[:id] if options[:id].present?
-
-        file_field_without_bootstrap(name, options) + label(name, placeholder, placeholder_opts)
-      end
     end
   end
 end