rails_bootstrap_form 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eeb7afe12b186dfa741279347931a85c33ff4950dcb691d6089e18767d5edb80
-  data.tar.gz: 18787c6cfd1ad0c3156f1611395551fb5c9c41d1e17983ac1393b7987d099455
+  metadata.gz: 54148096404aa5a60bc550aca63ac09e15c0ec5b6bc9de993bd908879d366908
+  data.tar.gz: 85a7d48bf6ccf530828395265f9aa41db7be3b1bf9fc6a8f83455614449ec02a
 SHA512:
-  metadata.gz: 7de97d7da63f5742b0db6816e908335540c1b66eaab7509bca8257005dc30e7bb2dd7f1974d3f7d0cf45dcdb909e9644c4cd29bddd7de6450bad05e2216f7c64
-  data.tar.gz: 97997858453d5b926fb23a8a64fe36294d5cf08c7d164a8a984eb5b42ee5d956451908567d4f3473bf1cd369b2570119bb211c8071f26096e78e3b90852bdc54
+  metadata.gz: d9569aeb686d7bef2a2c15018c46e14413c35ecb9eb18ce784cc4b074dcfdc2e5205e583cbf9ad85a6d98da8ab2939af772903c12c5d1a2d3bc0812bd908bf4f
+  data.tar.gz: 6b7222a2477195f38db5b63aeddecf28777e8f1de3dcb17ddbcd3126c747aa61903d411bad1341976590ccfb92e1cab07c93dcb31c4e49e7743b607478acce8b

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rails_bootstrap_form (0.2.2)
+    rails_bootstrap_form (0.3.0)
 
 GEM
   remote: http://rubygems.org/

data/app/assets/images/exclamation-triangle.svg

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
+<svg version="1.1" id="icon-exclamation-triangle" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" viewBox="0 0 24 24" fill="#cf222e">
+  <path d="M12,16a1,1,0,1,0,1,1A1,1,0,0,0,12,16Zm10.67,1.47-8.05-14a3,3,0,0,0-5.24,0l-8,14A3,3,0,0,0,3.94,22H20.06a3,3,0,0,0,2.61-4.53Zm-1.73,2a1,1,0,0,1-.88.51H3.94a1,1,0,0,1-.88-.51,1,1,0,0,1,0-1l8-14a1,1,0,0,1,1.78,0l8.05,14A1,1,0,0,1,20.94,19.49ZM12,8a1,1,0,0,0-1,1v4a1,1,0,0,0,2,0V9A1,1,0,0,0,12,8Z" />
+</svg>

data/app/assets/stylesheets/rails_bootstrap_form.css

@@ -1 +1,16 @@
-
+label.is-invalid, .invalid-feedback {
+  color: var(--bs-danger);
+}
+label.required::after {
+  color: var(--bs-danger);
+  content: "*";
+  padding-left: .25rem;
+  top: -2px;
+  font-weight: bolder;
+}
+.form-control.is-invalid, .form-select.is-invalid {
+  background-image: url("exclamation-triangle.svg") !important;
+  background-repeat: no-repeat !important;
+  background-position: right 0.5rem center, center right 2rem !important;
+  background-size: 24px 24px, calc(0.75em + 0.375rem) calc(0.75em + 0.375rem) !important;
+}

data/lib/rails_bootstrap_form/bootstrap_form_builder.rb

@@ -7,6 +7,7 @@ module RailsBootstrapForm
 
     include RailsBootstrapForm::FieldWrapperBuilder
     include RailsBootstrapForm::Components
+    include RailsBootstrapForm::InputGroupBuilder
     include RailsBootstrapForm::Inputs
 
     delegate :capture, :concat, :tag, to: :@template

data/lib/rails_bootstrap_form/bootstrap_form_options.rb

@@ -35,12 +35,15 @@ module RailsBootstrapForm
     attr_accessor :help_text
 
     # An option to override automatically generated label text.
+    # Default is `nil`.
     attr_accessor :label_text
 
     # An option to custmize whether the label is to be displayed or not.
+    # Default is `false`.
     attr_accessor :skip_label
 
     # An option to customize whether the label is only visible to screen readers.
+    # Default is `false`.
     attr_accessor :hide_label
 
     # The CSS class that will be used when the label is only accessible by screen
@@ -52,9 +55,33 @@ module RailsBootstrapForm
     attr_accessor :label_class
 
     # An additional CSS class that will be added along with the existing
-    # `label_class` of the label. Default is nil.
+    # `label_class` of the label. Default is `nil`.
     attr_accessor :additional_label_class
 
+    # Input group specific options. Input groups allow prepending and appending
+    # arbitrary html or text to the field.
+    #
+    # Example:
+    #
+    #   form.text_field :dollars, bootstrap_form: {input_group: {prepend: "$", append: ".00"}}
+    #   form.text_field :search, bootstrap_form: {input_group: {append: button_tag("Go", type: :submit, class: "btn btn-secondary")}}
+    #
+    # Raw or HTML content to be prepended to the field.
+    # Default is `nil`.
+    attr_accessor :prepend
+
+    # Raw or HTML content to be appended to the field.
+    # Default is `nil`.
+    attr_accessor :append
+
+    # Append additional CSS class added to the input group wrapper.
+    # Default is `nil`.
+    attr_accessor :additional_input_group_class
+
+    # Option to control whether the field should have a floating label.
+    # Default is false.
+    attr_accessor :floating
+
     def initialize(options = {})
       set_defaults
       set_bootstrap_form_options(options)
@@ -105,12 +132,14 @@ module RailsBootstrapForm
 
       @help_text = nil
 
-      @label_text = ""
+      @label_text = nil
       @skip_label = false
       @hide_label = false
       @hide_class = "visually-hidden"
       @label_class = "form-label"
       @additional_label_class = nil
+
+      @floating = false
     end
 
     private :set_defaults

data/lib/rails_bootstrap_form/components/errors.rb

@@ -0,0 +1,67 @@
+# -*- encoding: utf-8 -*-
+# -*- frozen_string_literal: true -*-
+# -*- warn_indent: true -*-
+
+module RailsBootstrapForm
+  module Components
+    module Errors
+      extend ActiveSupport::Concern
+
+      def self.included(base_class)
+        def is_invalid?(attribute)
+          (attribute && object.respond_to?(:errors) && object.errors[attribute].any?) ||
+            has_association_error?(attribute)
+        end
+
+        def input_with_error(attribute, &block)
+          input = capture(&block)
+          input << generate_error(attribute)
+          input
+        end
+
+        def generate_error(attribute)
+          if is_invalid?(attribute)
+            error_text = error_messages(attribute)
+            error_klass = "invalid-feedback"
+
+            tag.div(error_text, class: error_klass)
+          end
+        end
+
+        def has_association_error?(attribute)
+          object.class.reflections.any? do |association_name, association|
+            next unless is_belongs_to_association?(association)
+            next unless is_association_same?(attribute, association)
+
+            object.errors[association_name].any?
+          end
+        end
+
+        def error_messages(attribute)
+          messages = object.errors[attribute]
+
+          object.class.reflections.each do |association_name, association|
+            next unless is_belongs_to_association?(association)
+            next unless is_association_same?(attribute, association)
+
+            messages << object.errors[association_name]
+          end
+
+          messages.flatten.to_sentence
+        end
+
+        def is_belongs_to_association?(association)
+          association.is_a?(ActiveRecord::Reflection::BelongsToReflection)
+        end
+
+        def is_association_same?(attribute, association)
+          (association.foreign_key == attribute.to_s)
+        end
+
+        private :is_invalid?, :input_with_error, :generate_error,
+                :has_association_error?, :error_messages,
+                :is_belongs_to_association?, :is_association_same?
+      end
+    end
+  end
+end

data/lib/rails_bootstrap_form/components/labels.rb

@@ -20,6 +20,8 @@ module RailsBootstrapForm
         def label_classes(attribute, bootstrap_options)
           classes = [bootstrap_options.label_class, bootstrap_options.additional_label_class]
           classes << bootstrap_options.hide_class if bootstrap_options.hide_label
+          classes << "required" if is_attribute_required?(attribute)
+          classes << "is-invalid" if is_invalid?(attribute)
           classes.flatten.compact
         end
 

data/lib/rails_bootstrap_form/components/required_field.rb

@@ -0,0 +1,64 @@
+# -*- encoding: utf-8 -*-
+# -*- frozen_string_literal: true -*-
+# -*- warn_indent: true -*-
+
+module RailsBootstrapForm
+  module Components
+    module RequiredField
+      extend ActiveSupport::Concern
+
+      def self.included(base_class)
+        def is_field_required?(attribute, options)
+          return false unless attribute
+
+          if options.key?(:required)
+            options[:required]
+          else
+            is_attribute_required?(attribute)
+          end
+        end
+
+        def required_field_options(attribute, options)
+          required = is_field_required?(attribute, options)
+
+          {}.tap do |option|
+            option[:aria] = {required: true} if required
+            option[:required] = required
+          end
+        end
+
+        def is_attribute_required?(attribute)
+          return false unless attribute
+
+          target = object.instance_of?(Class) ? object : object.class
+          return false unless target.respond_to?(:validators_on)
+
+          has_presence_validator?(target_validators(target, attribute)) ||
+            is_required_association?(target, attribute)
+        end
+
+        def target_validators(target, attribute)
+          target.validators_on(attribute).map(&:class)
+        end
+
+        def has_presence_validator?(target_validators)
+          target_validators.include?(ActiveModel::Validations::PresenceValidator) ||
+            (defined?(ActiveRecord::Validations::PresenceValidator) &&
+              target_validators.include?(ActiveRecord::Validations::PresenceValidator))
+        end
+
+        def is_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
+
+            has_presence_validator?(target_validators(target, name))
+          end
+        end
+
+        private :is_field_required?, :required_field_options, :target_validators,
+                :has_presence_validator?, :is_required_association?
+      end
+    end
+  end
+end

data/lib/rails_bootstrap_form/components.rb

@@ -8,8 +8,12 @@ module RailsBootstrapForm
 
     autoload :HelpText
     autoload :Labels
+    autoload :RequiredField
+    autoload :Errors
 
     include HelpText
     include Labels
+    include RequiredField
+    include Errors
   end
 end

data/lib/rails_bootstrap_form/field_wrapper_builder.rb

@@ -16,10 +16,24 @@ module RailsBootstrapForm
       label = label(attribute, bootstrap_options)
       help_text = help_text(attribute, bootstrap_options)
 
-      tag.div(class: field_wrapper_classes) do
-        concat(label)
-        concat(capture(&block))
-        concat(help_text)
+      if bootstrap_options.floating
+        tag.div(class: field_wrapper_classes) do
+          concat(input_group_wrapper(attribute, bootstrap_options) do
+            tag.div(class: floating_label_classes(attribute)) do
+              concat(capture(&block))
+              concat(label)
+            end
+          end)
+          concat(help_text)
+        end
+      else
+        tag.div(class: field_wrapper_classes) do
+          concat(label)
+          concat(input_group_wrapper(attribute, bootstrap_options) do
+            capture(&block)
+          end)
+          concat(help_text)
+        end
       end
     end
 
@@ -42,12 +56,28 @@ module RailsBootstrapForm
         bootstrap_options.field_class,
         bootstrap_options.additional_field_class
       ]
+      field_classes << "is-invalid" if is_invalid?(attribute)
+
       css_options[:class] = field_classes.flatten.compact
 
+      css_options.merge!(required_field_options(attribute, options))
+
+      if bootstrap_options.floating
+        css_options[:placeholder] ||= label_text(attribute, bootstrap_options)
+      end
+
       css_options
     end
 
+    def floating_label_classes(attribute)
+      classes = Array("form-floating")
+      # Floating label fields with input group requires `is-invalid` class in
+      # order to display error messages.
+      classes << "is-invalid" if is_invalid?(attribute)
+      classes
+    end
+
     private :field_wrapper, :field_wrapper_classes, :form_wrapper_default_class,
-            :field_css_options
+            :field_css_options, :floating_label_classes
   end
 end

data/lib/rails_bootstrap_form/input_group_builder.rb

@@ -0,0 +1,49 @@
+# -*- encoding: utf-8 -*-
+# -*- frozen_string_literal: true -*-
+# -*- warn_indent: true -*-
+
+module RailsBootstrapForm
+  module InputGroupBuilder
+    extend ActiveSupport::Concern
+
+    def self.included(base_class)
+      def input_group_wrapper(attribute, bootstrap_options, &block)
+        input = capture(&block) || ActiveSupport::SafeBuffer.new
+
+        prepend = attach_input(bootstrap_options, :prepend)
+        append = attach_input(bootstrap_options, :append)
+
+        input = prepend + input + append
+        input += generate_error(attribute)
+
+        input = tag.div(input, class: input_group_classes(attribute, bootstrap_options))
+
+        input
+      end
+
+      def input_group_classes(attribute, bootstrap_options)
+        classes = ["input-group", bootstrap_options.additional_input_group_class]
+        # Require `has-validation` class if field has errors.
+        classes << "has-validation" if is_invalid?(attribute)
+        classes.flatten.compact
+      end
+
+      def attach_input(bootstrap_options, key)
+        tags = [*bootstrap_options.send(key)].map do |item|
+          input_group_content(item)
+        end
+
+        ActiveSupport::SafeBuffer.new(tags.join)
+      end
+
+      def input_group_content(content)
+        return content if /button|submit/.match?(content)
+
+        tag.span(content.html_safe, class: "input-group-text")
+      end
+
+      private :input_group_wrapper, :input_group_classes, :attach_input,
+              :input_group_content
+    end
+  end
+end

data/lib/rails_bootstrap_form/version.rb

@@ -3,6 +3,6 @@
 # -*- warn_indent: true -*-
 
 module RailsBootstrapForm
-  VERSION = "0.2.2".freeze
+  VERSION = "0.3.0".freeze
   REQUIRED_RAILS_VERSION = "~> 7.0".freeze
 end

data/lib/rails_bootstrap_form.rb

@@ -13,8 +13,9 @@ module RailsBootstrapForm
     autoload :Configuration
     autoload :BootstrapFormOptions
     autoload :BootstrapFormBuilder
-    autoload :FieldWrapperBuilder
     autoload :Components
+    autoload :FieldWrapperBuilder
+    autoload :InputGroupBuilder
     autoload :Inputs
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_bootstrap_form
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Harshal LADHE (shivam091)
@@ -40,6 +40,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- app/assets/images/exclamation-triangle.svg
 - app/assets/stylesheets/rails_bootstrap_form.css
 - demo/.byebug_history
 - demo/.ruby-version
@@ -108,11 +109,14 @@ files:
 - lib/rails_bootstrap_form/bootstrap_form_builder.rb
 - lib/rails_bootstrap_form/bootstrap_form_options.rb
 - lib/rails_bootstrap_form/components.rb
+- lib/rails_bootstrap_form/components/errors.rb
 - lib/rails_bootstrap_form/components/help_text.rb
 - lib/rails_bootstrap_form/components/labels.rb
+- lib/rails_bootstrap_form/components/required_field.rb
 - lib/rails_bootstrap_form/configuration.rb
 - lib/rails_bootstrap_form/engine.rb
 - lib/rails_bootstrap_form/field_wrapper_builder.rb
+- lib/rails_bootstrap_form/input_group_builder.rb
 - lib/rails_bootstrap_form/inputs.rb
 - lib/rails_bootstrap_form/version.rb
 - sig/rails_bootstrap_form.rbs