bootstrap_form 5.0.0 → 5.2.0

data/RELEASING.md

@@ -6,20 +6,26 @@ 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.5.
-* 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).
+* You must be using a Ruby version that is not end-of-life.
 
 ## 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`.**
+1. Run `BUNDLE_GEMFILE=gemfiles/7.0.gemfile bundle update` to make sure that you have all the gems necessary for testing and releasing.
+2. **Ensure the tests are passing by running the tests**
+
+   (There should be no errors or warnings.)
+
+       BUNDLE_GEMFILE=gemfiles/7.0.gemfile bundle exec rake test
+
+2. **Ensure the demo tests are passing by running**
+
+       cd demo
+       bundle update
+       bundle exec rake test:all
+
 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):
-    * Rename the Pending Release section to `[version][] (date)` with appropriate values `version` and `date`
-    * Remove the "Your contribution here!" bullets from the release notes
-    * Add a new Pending Release section at the top of the file with a template for contributors to fill in, including "Your contribution here!" bullets
-    * Add the appropriate GitHub diff links to the footer of the document
+5. Update the GitHub diff links at the beginning of `CHANGELOG.md` (The pattern should be obvious when you look at them).
 6. Update the installation instructions in `README.md` to use the new version.
 7. Commit the CHANGELOG and version changes in a single commit; the message should be "Preparing vX.Y.Z" where `X.Y.Z` is the version being released.
-8. Run `bundle exec rake release`; this will tag, push to GitHub, publish to rubygems.org, and upload the latest CHANGELOG entry to the [GitHub releases page](https://github.com/bootstrap-ruby/bootstrap_form/releases).
+8. Run `bundle exec rake release`; this will tag, push to GitHub, and publish to rubygems.org.

data/Rakefile

@@ -17,12 +17,13 @@ end
 
 require 'bundler/gem_tasks'
 
-require 'rake/testtask'
+require "minitest/test_task"
 
-Rake::TestTask.new(:test) do |t|
-  t.libs << 'test'
-  t.pattern = 'test/**/*_test.rb'
-  t.verbose = false
+Minitest::TestTask.create(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.warning = false
+  t.test_globs = ["test/**/*_test.rb"]
 end
 
 # This automatically updates GitHub Releases whenever we `rake release` the gem
@@ -34,4 +35,4 @@ end
 desc 'Run RuboCop checks'
 RuboCop::RakeTask.new(:rubocop)
 
-task default: %i[test rubocop]
+task default: %i[test rubocop:autocorrect]

data/bootstrap_form.gemspec

@@ -3,31 +3,28 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 require "bootstrap_form/version"
 
-REQUIRED_RAILS_VERSION = ">= 5.2".freeze
-
 Gem::Specification.new do |s|
   s.name        = "bootstrap_form"
   s.version     = BootstrapForm::VERSION
   s.authors     = ["Stephen Potenza", "Carlos Lopes"]
   s.email       = ["potenza@gmail.com", "carlos.el.lopes@gmail.com"]
   s.homepage    = "https://github.com/bootstrap-ruby/bootstrap_form"
-  s.summary     = "Rails form builder that makes it easy to style forms using "\
+  s.summary     = "Rails form builder that makes it easy to style forms using " \
                   "Bootstrap 5"
-  s.description = "bootstrap_form is a rails form builder that makes it super "\
+  s.description = "bootstrap_form is a rails form builder that makes it super " \
                   "easy to create beautiful-looking forms using Bootstrap 5"
   s.license     = "MIT"
+  s.metadata    = { "rubygems_mfa_required" => "true" }
 
   s.files = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test)/})
+    f.match(%r{^(test)/|^(demo)/})
   end
 
   s.bindir        = "exe"
   s.require_paths = ["lib"]
 
-  s.required_ruby_version = ">= 2.5"
-
-  s.add_dependency("actionpack", REQUIRED_RAILS_VERSION)
-  s.add_dependency("activemodel", REQUIRED_RAILS_VERSION)
+  s.required_ruby_version = ">= 3.0"
 
-  s.add_development_dependency("rails", REQUIRED_RAILS_VERSION)
+  s.add_dependency("actionpack", BootstrapForm::REQUIRED_RAILS_VERSION)
+  s.add_dependency("activemodel", BootstrapForm::REQUIRED_RAILS_VERSION)
 end

data/docker-compose.yml

@@ -1,70 +1,31 @@
-version: '2.4'
+version: '3.3'
 
 services:
   app: &app
     build:
       context: .
       args:
-        RUBY_VERSION: '2.7.1'
-        NODE_MAJOR: '12'
-        YARN_VERSION: '1.22.4'
-        BUNDLER_VERSION: '2.1.4'
-    image: bootstrap-form:0.0.1
+        NODE_MAJOR: "12"
+        YARN_VERSION: "1.22.4"
+        RUBY_VERSION: ${RUBY_VERSION}
+    image: bootstrap-form:latest-$RUBY_VERSION
     tmpfs:
       - /tmp
 
-  backend: &backend
+  shell: &shell
     <<: *app
     stdin_open: true
     tty: true
     volumes:
       - .:/app:cached
-      - rails_cache:/app/tmp/cache
-      - bundle:/usr/local/bundle
-      - node_modules:/app/node_modules
-      - packs:/app/public/packs
     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
-      - EDITOR=vi
-
-  shell:
-    <<: *backend
-    command: /bin/bash
-    ports:
-      - '3000:3000'
-
-  server:
-    <<: *backend
-    command: sh -c "cd demo/app && bundle exec rails server -b 0.0.0.0"
-    ports:
-      - '3000:3000'
-
-  test:
-    <<: *backend
-    command: rake test
-
-  webpacker:
-    <<: *app
-    command: ./bin/webpack-dev-server
     ports:
-      - '3035:3035'
-    volumes:
-      - .:/app:cached
-      - bundle:/usr/local/bundle
-      - node_modules:/app/node_modules
-      - packs:/app/public/packs
-    environment:
-      - NODE_ENV=${NODE_ENV:-development}
-      - RAILS_ENV=${RAILS_ENV:-development}
-      - WEBPACKER_DEV_SERVER_HOST=0.0.0.0
-
-volumes:
-  bundle:
-  node_modules:
-  rails_cache:
-  packs:
+      - "3000:3000"
+    command: /bin/bash

data/gemfiles/6.0.gemfile

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

data/gemfiles/6.1.gemfile

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

data/gemfiles/7.0.gemfile

@@ -0,0 +1,5 @@
+gems = "#{__dir__}/common.gemfile"
+eval File.read(gems), binding, gems # rubocop: disable Security/Eval
+
+gem "rails", "~> 7.0.2"
+gem "sprockets-rails", require: "sprockets/railtie"

data/gemfiles/common.gemfile

@@ -0,0 +1,28 @@
+source "http://rubygems.org"
+
+gemspec path: File.dirname(__dir__)
+
+# To test with different Rails versions, use the files in `./gemfiles`
+
+group :development do
+  gem "htmlbeautifier"
+  gem "puma"
+  gem "rubocop-performance", require: false
+  gem "rubocop-rails", require: false
+end
+
+group :test do
+  gem "diffy"
+  gem "equivalent-xml"
+  gem "mocha"
+  gem "sqlite3"
+end
+
+group :development, :test do
+  gem "debug"
+  gem "pry-byebug"
+end
+
+group :ci do
+  gem "danger"
+end

data/gemfiles/edge.gemfile

@@ -1,4 +1,5 @@
-gems = "#{File.dirname __dir__}/Gemfile"
+gems = "#{__dir__}/common.gemfile"
 eval File.read(gems), binding, gems # rubocop: disable Security/Eval
 
-gem "rails", git: "https://github.com/rails/rails.git"
+gem "rails", git: "https://github.com/rails/rails.git", branch: "main"
+gem "sprockets-rails", require: "sprockets/railtie"

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

@@ -24,14 +24,8 @@ module BootstrapForm
 
       def label_classes(name, options, custom_label_col, group_layout)
         classes = ["form-label", options[:class], label_layout_classes(custom_label_col, group_layout)]
-
-        case options.delete(:required)
-        when true
-          classes << "required"
-        when nil, :default
-          classes << "required" if required_attribute?(object, name)
-        end
-
+        classes << "required" if required_field_options(options, name)[:required]
+        options.delete(:required)
         classes << "text-danger" if label_errors && error?(name)
         classes.flatten.compact
       end
@@ -46,9 +40,9 @@ module BootstrapForm
 
       def label_text(name, options)
         if label_errors && error?(name)
-          (options[:text] || object.class.human_attribute_name(name)).to_s.concat(" #{get_error_messages(name)}")
+          (options[:text] || object.class.human_attribute_name(name)).to_s + " #{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

@@ -8,35 +8,45 @@ module BootstrapForm
       private
 
       def error?(name)
-        object.respond_to?(:errors) && !(name.nil? || object.errors[name].empty?)
+        name && object.respond_to?(:errors) && (object.errors[name].any? || association_error?(name))
+      end
+
+      def association_error?(name)
+        object.class.reflections.any? do |association_name, a|
+          next unless a.is_a?(ActiveRecord::Reflection::BelongsToReflection)
+          next unless a.foreign_key == name.to_s
+
+          object.errors[association_name].any?
+        end
       end
 
       def required_attribute?(obj, attribute)
         return false unless obj && attribute
 
         target = obj.instance_of?(Class) ? obj : obj.class
+        return false unless target.respond_to? :validators_on
 
-        target_validators = if target.respond_to? :validators_on
-                              target.validators_on(attribute).map(&:class)
-                            else
-                              []
-                            end
-
-        presence_validator?(target_validators)
+        presence_validator?(target_validators(target, attribute)) ||
+          required_association?(target, attribute)
       end
 
-      def presence_validator?(target_validators)
-        has_presence_validator = target_validators.include?(
-          ActiveModel::Validations::PresenceValidator
-        )
-
-        if defined? ActiveRecord::Validations::PresenceValidator
-          has_presence_validator |= target_validators.include?(
-            ActiveRecord::Validations::PresenceValidator
-          )
+      def required_association?(target, attribute)
+        target.reflections.find do |name, a|
+          next unless a.is_a?(ActiveRecord::Reflection::BelongsToReflection)
+          next unless a.foreign_key == attribute.to_s
+
+          presence_validator?(target_validators(target, name))
         end
+      end
+
+      def target_validators(target, attribute)
+        target.validators_on(attribute).map(&:class)
+      end
 
-        has_presence_validator
+      def presence_validator?(target_validators)
+        target_validators.include?(ActiveModel::Validations::PresenceValidator) ||
+          (defined?(ActiveRecord::Validations::PresenceValidator) &&
+            target_validators.include?(ActiveRecord::Validations::PresenceValidator))
       end
 
       def inline_error?(name)
@@ -54,7 +64,14 @@ module BootstrapForm
       end
 
       def get_error_messages(name)
-        object.errors[name].join(", ")
+        messages = object.errors[name]
+        object.class.reflections.each do |association_name, a|
+          next unless a.is_a?(ActiveRecord::Reflection::BelongsToReflection)
+          next unless a.foreign_key == name.to_s
+
+          messages << object.errors[association_name]
+        end
+        messages.join(", ")
       end
     end
   end

data/lib/bootstrap_form/form_builder.rb

@@ -1,10 +1,12 @@
 # require 'bootstrap_form/aliasing'
 
+# rubocop:disable Metrics/ClassLength
 module BootstrapForm
   class FormBuilder < ActionView::Helpers::FormBuilder
     attr_reader :layout, :label_col, :control_col, :has_error, :inline_errors,
                 :label_errors, :acts_like_form_tag
 
+    include BootstrapForm::Helpers::Field
     include BootstrapForm::Helpers::Bootstrap
 
     include BootstrapForm::FormGroupBuilder
@@ -67,13 +69,14 @@ module BootstrapForm
 
       return unless options[:layout] == :inline
 
-      options[:html][:class] = [options[:html][:class], "col-auto", "g-3"].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
 
@@ -87,8 +90,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
@@ -114,7 +116,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
@@ -130,3 +132,4 @@ module BootstrapForm
     end
   end
 end
+# rubocop:enable Metrics/ClassLength

data/lib/bootstrap_form/form_group.rb

@@ -32,15 +32,18 @@ module BootstrapForm
       end
     end
 
-    def form_group_content(label, help_text, options, &block)
+    def form_group_content(label, help_text, options, &block) # rubocop:disable Metrics/AbcSize
+      label ||= ActiveSupport::SafeBuffer.new
       if group_layout_horizontal?(options[:layout])
-        concat(label).concat(tag.div(capture(&block) + help_text, class: form_group_control_class(options)))
+        label + tag.div(capture(&block) + help_text, class: form_group_control_class(options))
       else
+        content = ActiveSupport::SafeBuffer.new
         # 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
+        content << label unless options[:floating]
+        content << capture(&block)
+        content << label if options[:floating]
+        content << help_text if help_text
+        content
       end
     end
 
@@ -52,12 +55,16 @@ module BootstrapForm
     end
 
     def form_group_classes(options)
-      classes = ["mb-3", options[:class].try(:split)].flatten.compact
+      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 << "form-floating" if options[:floating]
-      classes
+      classes.presence
+    end
+
+    def form_group_default_class
+      (layout == :inline ? "col" : "mb-3")
     end
 
     def horizontal_group_with_gutters?(layout, classes)

data/lib/bootstrap_form/form_group_builder.rb

@@ -28,8 +28,7 @@ module BootstrapForm
     def form_group_builder_options(options, method)
       options.symbolize_keys!
       options = convert_form_tag_options(method, options) if acts_like_form_tag
-      options[:required] = form_group_required(options) if !options[:skip_label] && options.key?(:skip_required)
-      options
+      options.merge!(required_field_options(options, method))
     end
 
     def convert_form_tag_options(method, options={})
@@ -77,11 +76,15 @@ module BootstrapForm
       classes
     end
 
-    def form_group_required(options)
-      return unless options.key?(:skip_required)
-
-      warn "`:skip_required` is deprecated, use `:required: false` instead"
-      options[:skip_required] ? false : :default
+    def form_group_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
 
     def form_group_css_options(method, html_options, options)

data/lib/bootstrap_form/helpers/bootstrap.rb

@@ -8,7 +8,7 @@ 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)
@@ -27,17 +27,20 @@ module BootstrapForm
         return unless object.respond_to?(:errors) && object.errors.full_messages.any?
 
         tag.div class: css do
-          concat tag.p title
-          concat error_summary unless options[:error_summary] == false
+          if options[:error_summary] == false
+            title
+          else
+            tag.p(title) + error_summary
+          end
         end
       end
 
       def error_summary
         return unless object.errors.any?
 
-        tag.ul class: "rails-bootstrap-forms-error-summary" do
-          object.errors.full_messages.each do |error|
-            concat tag.li(error)
+        tag.ul(class: "rails-bootstrap-forms-error-summary") do
+          object.errors.full_messages.reduce(ActiveSupport::SafeBuffer.new) do |acc, error|
+            acc << tag.li(error)
           end
         end
       end
@@ -79,12 +82,12 @@ module BootstrapForm
       end
 
       def prepend_and_append_input(name, options, &block)
-        options = options.extract!(:prepend, :append, :input_group_class)
+        options = options.extract!(:prepend, :append, :input_group_class).compact
 
         input = capture(&block) || ActiveSupport::SafeBuffer.new
 
         input = attach_input(options, :prepend) + input + attach_input(options, :append)
-        input += generate_error(name)
+        input << generate_error(name)
         options.present? &&
           input = tag.div(input, class: ["input-group", options[:input_group_class]].compact)
         input
@@ -96,7 +99,7 @@ module BootstrapForm
       end
 
       def input_group_content(content)
-        return content if /btn/.match?(content)
+        return content if content.include?("btn")
 
         tag.span(content, class: "input-group-text")
       end

data/lib/bootstrap_form/helpers/field.rb

@@ -0,0 +1,26 @@
+module BootstrapForm
+  module Helpers
+    module Field
+      def required_field_options(options, method)
+        required = required_field?(options, method)
+        {}.tap do |option|
+          option[:required] = required
+          option[:aria] = { required: true } if required
+        end
+      end
+
+      private
+
+      def required_field?(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/helpers.rb

@@ -5,5 +5,6 @@ module BootstrapForm
     extend ActiveSupport::Autoload
 
     autoload :Bootstrap
+    autoload :Field
   end
 end