bootstrap_form 5.1.0 → 5.2.0

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,30 +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.7"
+  s.required_ruby_version = ">= 3.0"
 
-  s.add_dependency("actionpack", REQUIRED_RAILS_VERSION)
-  s.add_dependency("activemodel", REQUIRED_RAILS_VERSION)
+  s.add_dependency("actionpack", BootstrapForm::REQUIRED_RAILS_VERSION)
+  s.add_dependency("activemodel", BootstrapForm::REQUIRED_RAILS_VERSION)
 end

data/docker-compose.yml

@@ -5,9 +5,10 @@ services:
     build:
       context: .
       args:
-        NODE_MAJOR: '12'
-        YARN_VERSION: '1.22.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
 
@@ -17,15 +18,6 @@ services:
     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
@@ -34,16 +26,6 @@ services:
       - WEBPACKER_DEV_SERVER_HOST=webpacker
       - WEB_CONCURRENCY=1
       - HISTFILE=/app/.bash_history
+    ports:
+      - "3000:3000"
     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/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

@@ -1,6 +1,5 @@
-gems = "#{File.dirname __dir__}/Gemfile"
+gems = "#{__dir__}/common.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"
+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/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,7 +40,7 @@ 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] || object&.class.try(:human_attribute_name, name)
         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
@@ -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
 

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

@@ -30,8 +30,7 @@ module BootstrapForm
           if options[:error_summary] == false
             title
           else
-            concat tag.p title
-            concat error_summary
+            tag.p(title) + error_summary
           end
         end
       end
@@ -39,9 +38,9 @@ module BootstrapForm
       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
@@ -83,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
@@ -100,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

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, :wrapper_class, :switch)
-          check_box_options[:class] = check_box_classes(name, options)
 
           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]
+            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
@@ -72,6 +77,17 @@ module BootstrapForm
         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/radio_button.rb

@@ -13,8 +13,8 @@ module BootstrapForm
           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.concat(radio_button_label(name, value, options)) unless options[:skip_label]
-            html.concat(generate_error(name)) if options[:error_message]
+            html << radio_button_label(name, value, options) unless options[:skip_label]
+            html << generate_error(name) if options[:error_message]
             html
           end
         end
@@ -28,7 +28,7 @@ module BootstrapForm
         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
+        radio_button_options.merge!(required_field_options(options, name))
       end
 
       def radio_button_label(name, value, options)

data/lib/bootstrap_form/version.rb

@@ -1,3 +1,4 @@
 module BootstrapForm
-  VERSION = "5.1.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"