rails_bootstrap_form 0.2.0 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7902b4c3c6edd102d01a2008a8d69a639b6afde3a93997c202e9267dcda93e4b
-  data.tar.gz: 4e65ba157ac848d45093d2aeda0673e840335bafd24b5861b0551dddc6cd130b
+  metadata.gz: eeb7afe12b186dfa741279347931a85c33ff4950dcb691d6089e18767d5edb80
+  data.tar.gz: 18787c6cfd1ad0c3156f1611395551fb5c9c41d1e17983ac1393b7987d099455
 SHA512:
-  metadata.gz: 1641aaa9fa84627e32bd9d5d59c7bfb6c89f12fd7498a6ed443309125ee11b4a79a8f7636b55da81e28a003146e00707c89df0d10c2e2d58957a975a035af3dc
-  data.tar.gz: 9ecea91f9b5c2af60282eb938e957e18cbfcbc7b089341b126db05728cdb44dd41cb4af9632e1cf6e6a14b6146a3b5c8841af3cd3c95a24b7c77af8dabcd6d10
+  metadata.gz: 7de97d7da63f5742b0db6816e908335540c1b66eaab7509bca8257005dc30e7bb2dd7f1974d3f7d0cf45dcdb909e9644c4cd29bddd7de6450bad05e2216f7c64
+  data.tar.gz: 97997858453d5b926fb23a8a64fe36294d5cf08c7d164a8a984eb5b42ee5d956451908567d4f3473bf1cd369b2570119bb211c8071f26096e78e3b90852bdc54

data/Gemfile.lock

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

data/demo/config/locales/en.rb

@@ -6,11 +6,44 @@
   en: {
     activerecord: {
       attributes: {
-
+        country: {
+          name: "Name",
+        },
+        fruit: {
+          name: "Name",
+        },
+        skill: {
+          name: "Name",
+        },
+        user: {
+          name: "Name",
+          email: "Email address",
+          password: "Password",
+          password_confirmation: "Confirm password",
+          mobile_number: "Mobile number",
+          blog_url: "Blog URL",
+          birth_date: "Birth date",
+          fruit_id: "Favorite fruit",
+          terms: "I accept terms and conditions",
+          excellence: "Excellence",
+        },
+        user_skill: {
+          user_id: "User",
+          skill_id: "Skill"
+        },
+        address: {
+          street: "Street",
+          state: "State",
+          city: "City",
+          postal_code: "Postal code",
+          country_id: "Country"
+        },
       },
       help_texts: {
-
+        user: {
+          email: "Please use official email address"
+        }
       },
-    },
+    }
   }
 }

data/lib/rails_bootstrap_form/bootstrap_form_builder.rb

@@ -4,6 +4,11 @@
 
 module RailsBootstrapForm
   class BootstrapFormBuilder < ActionView::Helpers::FormBuilder
+
+    include RailsBootstrapForm::FieldWrapperBuilder
+    include RailsBootstrapForm::Components
+    include RailsBootstrapForm::Inputs
+
     delegate :capture, :concat, :tag, to: :@template
 
     attr_accessor :bootstrap_form_options

data/lib/rails_bootstrap_form/bootstrap_form_options.rb

@@ -20,6 +20,41 @@ module RailsBootstrapForm
     # It can also be "floating" if field should have floating labels.
     attr_accessor :layout
 
+    # A CSS class that will be applied to all form fields and it can be overridden
+    # by the `BootstrapFormOptions` object. Default is `form-control`.
+    attr_accessor :field_class
+
+    # An additional CSS class that will be added along with the existing
+    # `field_class` of the field. Default is nil.
+    attr_accessor :additional_field_class
+
+    # Describes help text for the HTML field. Help text is automatically read
+    # from translation file. If you want to customize it, you can pass string.
+    # You can also set it false if you do not want help text displayed.
+    # 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)
@@ -64,6 +99,18 @@ module RailsBootstrapForm
 
     def set_defaults
       @layout = "vertical"
+
+      @field_class = "form-control"
+      @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/help_text.rb

@@ -0,0 +1,53 @@
+# -*- encoding: utf-8 -*-
+# -*- frozen_string_literal: true -*-
+# -*- warn_indent: true -*-
+
+module RailsBootstrapForm
+  module Components
+    module HelpText
+      extend ActiveSupport::Concern
+
+      def self.included(base_class)
+        def help_text(attribute, bootstrap_options)
+          return if bootstrap_options.help_text == false
+
+          help_text = (bootstrap_options.help_text || scoped_help_text(attribute))
+
+          tag.span(help_text, class: "form-text text-muted") if help_text.present?
+        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 partial_scope
+          if object_class.respond_to?(:model_name)
+            object_class.model_name.name
+          else
+            object_class.name
+          end
+        end
+
+        def scoped_help_text(attribute)
+          translation_scope = "activerecord.help_texts.#{partial_scope.underscore}"
+
+          help_text = translated_help_text(attribute, translation_scope).presence
+
+          help_text
+        end
+
+        def translated_help_text(attribute, scope)
+          ActiveSupport::SafeBuffer.new(I18n.t(attribute, scope: scope, default: ""))
+        end
+
+        private :help_text, :partial_scope, :object_class, :scoped_help_text
+                :translated_help_text
+      end
+    end
+  end
+end

data/lib/rails_bootstrap_form/components/labels.rb

@@ -0,0 +1,34 @@
+# -*- 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.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.rb

@@ -0,0 +1,15 @@
+# -*- encoding: utf-8 -*-
+# -*- frozen_string_literal: true -*-
+# -*- warn_indent: true -*-
+
+module RailsBootstrapForm
+  module Components
+    extend ActiveSupport::Autoload
+
+    autoload :HelpText
+    autoload :Labels
+
+    include HelpText
+    include Labels
+  end
+end

data/lib/rails_bootstrap_form/field_wrapper_builder.rb

@@ -0,0 +1,53 @@
+# -*- encoding: utf-8 -*-
+# -*- frozen_string_literal: true -*-
+# -*- warn_indent: true -*-
+
+module RailsBootstrapForm
+  module FieldWrapperBuilder
+    def field_wrapper_builder(attribute, options, html_options = nil, &block)
+      bootstrap_options = bootstrap_form_options.scoped(options.delete(:bootstrap_form))
+
+      field_options = field_css_options(attribute, bootstrap_options, options, html_options.try(:symbolize_keys!))
+
+      field_wrapper(attribute, bootstrap_options, field_options, &block)
+    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
+    end
+
+    def field_wrapper_classes
+      classes = [form_wrapper_default_class]
+      classes.flatten.compact
+    end
+
+    def field_wrapper_options
+    end
+
+    def form_wrapper_default_class
+      "mb-3"
+    end
+
+    def field_css_options(attribute, bootstrap_options, options, html_options)
+      css_options = (html_options || options)
+
+      field_classes = [
+        bootstrap_options.field_class,
+        bootstrap_options.additional_field_class
+      ]
+      css_options[:class] = field_classes.flatten.compact
+
+      css_options
+    end
+
+    private :field_wrapper, :field_wrapper_classes, :form_wrapper_default_class,
+            :field_css_options
+  end
+end

data/lib/rails_bootstrap_form/inputs.rb

@@ -0,0 +1,43 @@
+# -*- encoding: utf-8 -*-
+# -*- frozen_string_literal: true -*-
+# -*- warn_indent: true -*-
+
+module RailsBootstrapForm
+  module Inputs
+
+    FIELD_HELPERS = %i[
+      text_field
+      url_field
+      search_field
+      telephone_field
+      number_field
+      email_field
+      file_field
+      phone_field
+      password_field
+      text_area
+      date_field
+      time_field
+      datetime_field
+      datetime_local_field
+      month_field
+      week_field
+    ].freeze
+
+    FIELD_HELPERS.each do |field_tag_name|
+      define_method(field_tag_name) do |attribute, options = {}|
+        field_wrapper_builder(attribute, options) do
+          super(attribute, options)
+        end
+      end
+    end
+
+    def select(attribute, choices = nil, options = {}, html_options = {}, &block)
+      options = options.reverse_merge(bootstrap_form: {field_class: "form-select"})
+
+      field_wrapper_builder(attribute, options, html_options) do
+        super(attribute, choices, options, html_options, &block)
+      end
+    end
+  end
+end

data/lib/rails_bootstrap_form/version.rb

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

data/lib/rails_bootstrap_form.rb

@@ -13,11 +13,15 @@ module RailsBootstrapForm
     autoload :Configuration
     autoload :BootstrapFormOptions
     autoload :BootstrapFormBuilder
+    autoload :FieldWrapperBuilder
+    autoload :Components
+    autoload :Inputs
   end
 
   class << self
     def eager_load!
       super
+      RailsBootstrapForm::Components.eager_load!
     end
 
     def config

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_bootstrap_form
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.2
 platform: ruby
 authors:
 - Harshal LADHE (shivam091)
@@ -107,8 +107,13 @@ files:
 - lib/rails_bootstrap_form/action_view_extensions/bootstrap_form_helper.rb
 - 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/help_text.rb
+- lib/rails_bootstrap_form/components/labels.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/inputs.rb
 - lib/rails_bootstrap_form/version.rb
 - sig/rails_bootstrap_form.rbs
 homepage: https://github.com/shivam091/rails_bootstrap_form