rails_bootstrap_form 0.2.1 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1e721e3897b40c0457a2cd5cfdd2d70be38f43b1c707f103e3799ea03a9c398d
-  data.tar.gz: baef33d0746182ad54d2dd1b0ca0b4e827bb1ff4ad70762fca8c44d4826f94c8
+  metadata.gz: 58960cc1bb39e990327bb9653961f25761070edbd1d8cd0ddb281506fc0cf564
+  data.tar.gz: 6d19cd1958e1667a51ad91d60a09144934ddfaf3b5bdbc21972bfb00ed2cd2cb
 SHA512:
-  metadata.gz: 8f1916dfbb809f724be629beeff70e6e7ca287967bf769dc9d5d3501f3ee00beb641ca73966661d33d3293972090667390672a4d444c32318f5a9ca74863822a
-  data.tar.gz: 6357308e7ddd7df6667d9a36a96cd506039526c258438bfa19583cc898f36221ffff2f96c4dcdb06f34fb75b39c9fbebfd3a9ced43ab5257f5323b61921bd8e9
+  metadata.gz: 1baea47dd00f08b64d4f7c156748b4dace0e30cdf16f95ebd568dd6db4de2d869748728a5d11d4844dfce943873136767d30cdc0c5262b2ac4c7a6dc898c6188
+  data.tar.gz: bf4c3178074b47e4ab37f7cc0ec0649d681e82c6a44f80196a071312235ed6503cc493385c08fde619dc1bb92636d8f0bc3f19b6ecca8599e925a150fa1a80ba

data/Gemfile.lock

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

data/app/assets/stylesheets/rails_bootstrap_form.css

@@ -1 +1,10 @@
-
+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;
+}

data/lib/rails_bootstrap_form/bootstrap_form_options.rb

@@ -34,6 +34,27 @@ module RailsBootstrapForm
     # Default is nil.
     attr_accessor :help_text
 
+    # An option to override automatically generated label text.
+    attr_accessor :label_text
+
+    # An option to custmize whether the label is to be displayed or not.
+    attr_accessor :skip_label
+
+    # An option to customize whether the label is only visible to screen readers.
+    attr_accessor :hide_label
+
+    # The CSS class that will be used when the label is only accessible by screen
+    # readers. Default is `visually-hidden`
+    attr_accessor :hide_class
+
+    # Default CSS class that will be applied to all label tags.
+    # Default is `form-label`.
+    attr_accessor :label_class
+
+    # An additional CSS class that will be added along with the existing
+    # `label_class` of the label. Default is nil.
+    attr_accessor :additional_label_class
+
     def initialize(options = {})
       set_defaults
       set_bootstrap_form_options(options)
@@ -83,6 +104,13 @@ module RailsBootstrapForm
       @additional_field_class = nil
 
       @help_text = nil
+
+      @label_text = ""
+      @skip_label = false
+      @hide_label = false
+      @hide_class = "visually-hidden"
+      @label_class = "form-label"
+      @additional_label_class = nil
     end
 
     private :set_defaults

data/lib/rails_bootstrap_form/components/labels.rb

@@ -0,0 +1,35 @@
+# -*- encoding: utf-8 -*-
+# -*- frozen_string_literal: true -*-
+# -*- warn_indent: true -*-
+
+module RailsBootstrapForm
+  module Components
+    module Labels
+      extend ActiveSupport::Concern
+
+      def self.included(base_class)
+        def label(attribute, bootstrap_options)
+          unless bootstrap_options.skip_label
+            label_class = label_classes(attribute, bootstrap_options)
+            label_text = label_text(attribute, bootstrap_options)
+
+            super(attribute, label_text, class: label_class)
+          end
+        end
+
+        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.flatten.compact
+        end
+
+        def label_text(attribute, bootstrap_options)
+          bootstrap_options.label_text || object&.class.try(:human_attribute_name, attribute)
+        end
+
+        private :label, :label_classes, :label_text
+      end
+    end
+  end
+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(options, attribute)
+          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

@@ -7,7 +7,11 @@ module RailsBootstrapForm
     extend ActiveSupport::Autoload
 
     autoload :HelpText
+    autoload :Labels
+    autoload :RequiredField
 
     include HelpText
+    include Labels
+    include RequiredField
   end
 end

data/lib/rails_bootstrap_form/field_wrapper_builder.rb

@@ -13,9 +13,11 @@ module RailsBootstrapForm
     end
 
     def field_wrapper(attribute, bootstrap_options, options, &block)
+      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)
       end

data/lib/rails_bootstrap_form/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_bootstrap_form
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.3
 platform: ruby
 authors:
 - Harshal LADHE (shivam091)
@@ -109,6 +109,8 @@ files:
 - lib/rails_bootstrap_form/bootstrap_form_options.rb
 - lib/rails_bootstrap_form/components.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