rails_bootstrap_form 0.5.2 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ed3da45cc2109afbc15026f1a12f80000890c7b7759bc7dbbbe855f3184bf0a2
-  data.tar.gz: 5e7897c4c60eb47a89f2eaf26a3f3ad46b5cc78cdc5519ff1dfe755302e7ab40
+  metadata.gz: aa73fbc58e6dd0b2dc4b823cd6732de17b0e84e52d9177bce4684b61609238e0
+  data.tar.gz: f190515751e2cbc2bf51c195c8aa0ac7e2459ae040f1ba8dd544532f6887a514
 SHA512:
-  metadata.gz: 6b84a087632ef6236a0b1975910ae6cabe61f5f1f70aa0f2950c765f53c23caa93de366b00517622a5fffabff0fb34794a563d04eb7ebe8bf4061bec6858ef57
-  data.tar.gz: 288e303d2c86355e5cd4a88d9046a84704d9091954981d7dee818f3f57f583995fa8bde1f28aa7f067ff851724deb6c8e00c03912a6c240da266000d353bd385
+  metadata.gz: f41528a442151162803ec730b18fde0d10cd002446e5a402c037acb4aea7933e5749a5f5d3824762a83fc41a5fc2d87ecedafc7371755c45cdeafcb783f13a7f
+  data.tar.gz: 139a3f9bd52be5936676ddc8b730a9a211f715f32b8ca8ba12ad6d045233ed9836e90317bf33a43ab07e27ac52c0ae77e5c9c290e9157e75def6b07341a96a30

data/Gemfile.lock

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

data/app/assets/stylesheets/rails_bootstrap_form.css

@@ -20,3 +20,6 @@ label.required::after {
   display: inline-block;
   width: auto;
 }
+.invalid-feedback {
+  display: block;
+}

data/demo/app/views/users/_form.html.erb

@@ -3,3 +3,5 @@
 <% end %>
 
 <%= render partial: "users/vertical_form" %>
+
+<%= render partial: "users/horizontal_form" %>

data/demo/app/views/users/_horizontal_form.html.erb

@@ -0,0 +1,32 @@
+<div class="card card-primary my-3">
+  <div class="card-header fw-bold">
+    Profile Form (Horizontal layout)
+  </div>
+  <div class="card-body">
+    <%= bootstrap_form_for @user, bootstrap_form: {layout: :horizontal} do |form| %>
+      <%= form.text_field :name, autocomplete: "new-name" %>
+      <%= form.text_field :email, autocomplete: "new-email" %>
+      <%= form.text_field :password, autocomplete: "new-password" %>
+      <%= form.phone_field :mobile_number %>
+      <%= form.date_field :birth_date %>
+      <%= form.radio_button :terms, 1, required: true %>
+      <%= form.range_field :excellence %>
+      <%= form.url_field :blog_url %>
+      <%= form.collection_radio_buttons :fruit_id, ::Fruit.all, :id, :name, {bootstrap_form: {}, checked: form.object.fruit_id} %>
+      <%= form.color_field :favorite_color %>
+      <%= form.collection_check_boxes :skill_ids, ::Skill.all, :id, :name, {bootstrap_form: {}} %>
+      <%= form.fields_for :address, include_id: false, bootstrap_form: {layout: :horizontal} do |address_form| %>
+        <%= address_form.text_area :street %>
+        <%= address_form.text_field :state %>
+        <%= address_form.grouped_collection_select :city, ::Country.includes(:cities), :cities, :name, :id, :name, {include_blank: "Select city"} %>
+        <%= address_form.text_field :postal_code %>
+        <%= address_form.select :country_id, options_for_select(::Country.pluck(:name, :id), address_form.object.country_id),
+            {include_blank: "Select Country", bootstrap_form: {}} %>
+      <% end %>
+      <div class="mt-3">
+        <%= form.submit "Register", class: "btn btn-primary" %>
+        <%= link_to "Cancel", users_path, class: "btn btn-secondary" %>
+      </div>
+    <% end %>
+  </div>
+</div>

data/demo/app/views/users/_vertical_form.html.erb

@@ -12,13 +12,13 @@
       <%= form.check_box :terms, bootstrap_form: {switch: false}, required: true %>
       <%= form.range_field :excellence %>
       <%= form.url_field :blog_url %>
-      <%= form.collection_radio_buttons :fruit_id, ::Fruit.all, :id, :name, {bootstrap_form: {layout: :inline}, checked: form.object.fruit_id} %>
+      <%= form.collection_radio_buttons :fruit_id, ::Fruit.all, :id, :name, {bootstrap_form: {}, checked: form.object.fruit_id} %>
       <%= form.color_field :favorite_color %>
-      <%= form.collection_check_boxes :skill_ids, ::Skill.all, :id, :name, {bootstrap_form: {layout: :inline}} %>
+      <%= form.collection_check_boxes :skill_ids, ::Skill.all, :id, :name, {bootstrap_form: {}} %>
       <%= form.fields_for :address, include_id: false do |address_form| %>
         <%= address_form.text_area :street %>
         <%= address_form.text_field :state %>
-        <%= address_form.grouped_collection_select :city, ::Country.all, :cities, :name, :id, :name, {include_blank: "Select city"} %>
+        <%= address_form.grouped_collection_select :city, ::Country.includes(:cities), :cities, :name, :id, :name, {include_blank: "Select city"} %>
         <%= address_form.text_field :postal_code %>
         <%= address_form.select :country_id, options_for_select(::Country.pluck(:name, :id), address_form.object.country_id),
             {include_blank: "Select Country", bootstrap_form: {}} %>

data/lib/rails_bootstrap_form/bootstrap_form_options.rb

@@ -50,8 +50,9 @@ module RailsBootstrapForm
     # readers. Default is `visually-hidden`
     attr_accessor :hide_class
 
-    # Default CSS class that will be applied to all label tags.
-    # Default is `form-label`.
+    # Default CSS class that will be applied to all label tags when layout is
+    # vertical.
+    # The default value is `form-label`.
     attr_accessor :label_class
 
     # An additional CSS class that will be added along with the existing
@@ -98,29 +99,53 @@ module RailsBootstrapForm
     # The valid values are `sm` and `lg`. The default value is `nil`.
     attr_accessor :size
 
+    # Option to render checkboxes and radio buttons inline.
+    # The default value if `false`.
+    #
+    # Example:
+    #   form.collection_radio_buttons :choices, ["yes", "no"], :to_s, :to_s, bootstrap_form: {inline: true}
+    attr_accessor :inline
+
+    # Default CSS class that will be applied to all label tags when layout is
+    # horizontal.
+    # The default value is `col-form-label`.
+    attr_accessor :label_col_class
+
+    # Default CSS class for label column when using horizontal form.
+    # The default value is `col-sm-2`.
+    attr_accessor :label_col_wrapper_class
+
+    # Default CSS class for control column when using horizontal form.
+    # The default value is `col-sm-10`.
+    attr_accessor :field_col_wrapper_class
+
     def initialize(options = {})
       set_defaults
       set_bootstrap_form_options(options)
     end
 
-    def horizontal?
+    def layout_horizontal?
       @layout.to_s == "horizontal"
     end
 
-    def inline?
+    def layout_inline?
       @layout.to_s == "inline"
     end
 
-    def vertical?
+    def layout_vertical?
       @layout.to_s == "vertical"
     end
 
+    def inline?
+      self.inline
+    end
+
     # This will return a copy of `BootstrapFormOptions` object with new options set
     # that don't affect original object. This way we can have options specific
     # to a given form field. For example, we can change grid just for one field:
     #
     #   bootstrap_form_with model: @user do |f|
-    #     f.text_field :email, bootstrap_form: {label_col_class: "col-md-6", control_col_class: "col-md-6"}
+    #     f.text_field :email, bootstrap_form: {label_col_wrapper_class: "col-md-6", field_col_wrapper_class: "col-md-6"}
     #     f.password_field :password
     #   end
     #
@@ -160,6 +185,12 @@ module RailsBootstrapForm
       @wrapper_options = {}
 
       @size = nil
+
+      @inline = false
+
+      @label_col_class = "col-form-label"
+      @label_col_wrapper_class = "col-sm-2"
+      @field_col_wrapper_class = "col-sm-10"
     end
 
     private :set_defaults

data/lib/rails_bootstrap_form/components/check_box.rb

@@ -7,6 +7,8 @@ module RailsBootstrapForm
     module CheckBox
       extend ActiveSupport::Concern
 
+      include RailsBootstrapForm::Helpers
+
       def self.included(base_class)
         def check_box_label(attribute, checked_value, options, bootstrap_options, &block)
           unless bootstrap_options.skip_label
@@ -61,11 +63,19 @@ module RailsBootstrapForm
         def check_box_wrapper_class(bootstrap_options)
           classes = Array("form-check")
           classes << "form-switch" if bootstrap_options.switch
-          classes << (bootstrap_options.inline? ? "form-check-inline" : "mb-3")
+          classes << "form-check-inline" if bootstrap_options.inline?
+          classes << "mb-3" unless (bootstrap_options.layout_horizontal? || bootstrap_options.inline?)
+          classes.flatten.compact
+        end
+
+        def check_box_container_classes(bootstrap_options)
+          classes = Array(bootstrap_options.field_col_wrapper_class)
+          classes << field_offset_class(bootstrap_options.label_col_wrapper_class)
           classes.flatten.compact
         end
 
-        private :check_box_label, :check_box_classes, :check_box_label_class, :check_box_wrapper_class
+        private :check_box_label, :check_box_classes, :check_box_label_class,
+                :check_box_wrapper_class, :check_box_container_classes
       end
     end
   end

data/lib/rails_bootstrap_form/components/labels.rb

@@ -21,7 +21,13 @@ module RailsBootstrapForm
         end
 
         def label_classes(attribute, bootstrap_options)
-          classes = [bootstrap_options.label_class, bootstrap_options.additional_label_class]
+          classes = []
+          classes << if bootstrap_options.layout_horizontal?
+            [bootstrap_options.label_col_class, bootstrap_options.label_col_wrapper_class]
+          else
+            bootstrap_options.label_class
+          end
+          classes << 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)

data/lib/rails_bootstrap_form/components/radio_button.rb

@@ -7,6 +7,8 @@ module RailsBootstrapForm
     module RadioButton
       extend ActiveSupport::Concern
 
+      include RailsBootstrapForm::Helpers
+
       def self.included(base_class)
         def radio_button_label(attribute, value, options, bootstrap_options)
           unless bootstrap_options.skip_label
@@ -57,11 +59,19 @@ module RailsBootstrapForm
 
         def radio_button_wrapper_class(bootstrap_options)
           classes = Array("form-check")
-          classes << (bootstrap_options.inline? ? "form-check-inline" : "mb-3")
+          classes << "form-check-inline" if bootstrap_options.inline?
+          classes << "mb-3" unless (bootstrap_options.layout_horizontal? || bootstrap_options.inline?)
+          classes.flatten.compact
+        end
+
+        def radio_button_container_classes(bootstrap_options)
+          classes = Array(bootstrap_options.field_col_wrapper_class)
+          classes << field_offset_class(bootstrap_options.label_col_wrapper_class)
           classes.flatten.compact
         end
 
-        private :radio_button_label, :radio_button_classes, :radio_button_label_class, :radio_button_wrapper_class
+        private :radio_button_label, :radio_button_classes, :radio_button_label_class,
+                :radio_button_wrapper_class, :radio_button_container_classes
       end
     end
   end

data/lib/rails_bootstrap_form/field_wrapper_builder.rb

@@ -16,35 +16,49 @@ module RailsBootstrapForm
       label = draw_label(attribute, options, bootstrap_options)
       help_text = help_text(attribute, bootstrap_options)
 
-      if bootstrap_options.floating
+      if bootstrap_options.layout_horizontal?
         tag.div(**field_wrapper_options(bootstrap_options)) do
-          concat(input_group_wrapper(attribute, bootstrap_options) do
-            tag.div(class: floating_label_classes(attribute)) do
-              concat(capture(&block))
-              concat(label)
-            end
+          concat(label)
+          concat(tag.div(class: bootstrap_options.field_col_wrapper_class) do
+            concat(input_group_wrapper(attribute, bootstrap_options) do
+              capture(&block)
+            end)
+            concat(help_text)
           end)
-          concat(help_text)
         end
       else
-        tag.div(**field_wrapper_options(bootstrap_options)) do
-          concat(label)
-          concat(input_group_wrapper(attribute, bootstrap_options) do
-            capture(&block)
-          end)
-          concat(help_text)
+        if bootstrap_options.floating
+          tag.div(**field_wrapper_options(bootstrap_options)) 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(**field_wrapper_options(bootstrap_options)) do
+            concat(label)
+            concat(input_group_wrapper(attribute, bootstrap_options) do
+              capture(&block)
+            end)
+            concat(help_text)
+          end
         end
       end
     end
 
     def field_wrapper_options(bootstrap_options)
       {}.tap do |option|
-        option[:class] = field_wrapper_classes
+        option[:class] = field_wrapper_classes(bootstrap_options)
       end.merge(bootstrap_options.wrapper_options)
     end
 
-    def field_wrapper_classes
-      classes = [form_wrapper_default_class]
+    def field_wrapper_classes(bootstrap_options)
+      classes = []
+      classes << "row" if bootstrap_options.layout_horizontal?
+      classes << form_wrapper_default_class
       classes.flatten.compact
     end
 
@@ -68,7 +82,7 @@ module RailsBootstrapForm
       css_options[:class] = field_classes.flatten.compact
       css_options.merge!(required_field_options(attribute, options))
 
-      if bootstrap_options.floating
+      if (bootstrap_options.floating && !bootstrap_options.layout_horizontal?)
         css_options[:placeholder] ||= label_text(attribute, bootstrap_options)
       end
 

data/lib/rails_bootstrap_form/helpers.rb

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+# -*- frozen_string_literal: true -*-
+# -*- warn_indent: true -*-
+
+module RailsBootstrapForm
+  module Helpers
+    extend ActiveSupport::Concern
+
+    def self.included(base_class)
+      def collection_input_checked?(checked, obj, input_value)
+        checked == input_value || Array(checked).try(:include?, input_value) ||
+          checked == obj || Array(checked).try(:include?, obj)
+      end
+
+      def control_specific_class(field_tag_name)
+        "rails-bootstrap-forms-#{field_tag_name.to_s.tr("_", "-")}"
+      end
+
+      def is_size_valid?(bootstrap_options)
+        bootstrap_options.size && %i(sm lg).include?(bootstrap_options.size)
+      end
+
+      def field_offset_class(label_col_wrapper_class)
+        label_col_wrapper_class.gsub(/\bcol-(\w+)-(\d)\b/, 'offset-\1-\2')
+      end
+
+      private :collection_input_checked?, :control_specific_class, :is_size_valid?
+    end
+  end
+end

data/lib/rails_bootstrap_form/inputs.rb

@@ -3,14 +3,9 @@
 # -*- warn_indent: true -*-
 
 module RailsBootstrapForm
-  module Inputs
-
-    extend ActiveSupport::Autoload
-
-    autoload :Base
-
-    include Base
+  include Helpers
 
+  module Inputs
     FIELD_HELPERS = %i[
       text_field
       url_field
@@ -141,10 +136,22 @@ module RailsBootstrapForm
         concat(check_box_field)
         concat(check_box_label)
         concat(check_box_help_text) unless bootstrap_options.inline?
-        concat(generate_error(attribute)) if is_invalid?(attribute) && !bootstrap_options.inline?
+        concat(generate_error(attribute)) if (is_invalid?(attribute) && !bootstrap_options.inline?)
       end
 
-      check_box_html
+      if bootstrap_options.inline?
+        check_box_html
+      else
+        if bootstrap_options.layout_horizontal?
+          tag.div(class: field_wrapper_classes(bootstrap_options)) do
+            tag.div(class: check_box_container_classes(bootstrap_options)) do
+              check_box_html
+            end
+          end
+        else
+          check_box_html
+        end
+      end
     end
 
     def radio_button(attribute, value, options = {})
@@ -161,10 +168,22 @@ module RailsBootstrapForm
         concat(radio_button_field)
         concat(radio_button_label)
         concat(radio_button_help_text) unless bootstrap_options.inline?
-        concat(generate_error(attribute)) if is_invalid?(attribute) && !bootstrap_options.inline?
+        concat(generate_error(attribute)) if (is_invalid?(attribute) && !bootstrap_options.inline?)
       end
 
-      radio_button_html
+      if bootstrap_options.inline?
+        radio_button_html
+      else
+        if bootstrap_options.layout_horizontal?
+          tag.div(class: field_wrapper_classes(bootstrap_options)) do
+            tag.div(class: radio_button_container_classes(bootstrap_options)) do
+              radio_button_html
+            end
+          end
+        else
+          radio_button_html
+        end
+      end
     end
 
     def collection_check_boxes(attribute, collection, value_method, text_method, options = {}, html_options = {}, &block)
@@ -176,7 +195,8 @@ module RailsBootstrapForm
         input_value = value_method.respond_to?(:call) ? value_method.call(object) : object.send(value_method)
         input_options = {
           bootstrap_form: {
-            label_text: text_method.respond_to?(:call) ? text_method.call(object) : object.send(text_method)
+            label_text: text_method.respond_to?(:call) ? text_method.call(object) : object.send(text_method),
+            inline: true
           }
         }.deep_merge!(options)
 
@@ -184,7 +204,7 @@ module RailsBootstrapForm
       end
 
       if options.delete(:include_hidden) { true }
-        inputs.prepend hidden_field(attribute, value: "", multiple: true)
+        inputs.prepend(hidden_field(attribute, value: "", multiple: options[:multiple]))
       end
 
       field_wrapper_builder(attribute, options, html_options) do
@@ -201,7 +221,8 @@ module RailsBootstrapForm
         input_value = value_method.respond_to?(:call) ? value_method.call(object) : object.send(value_method)
         input_options = {
           bootstrap_form: {
-            label_text: text_method.respond_to?(:call) ? text_method.call(object) : object.send(text_method)
+            label_text: text_method.respond_to?(:call) ? text_method.call(object) : object.send(text_method),
+            inline: true
           }
         }.deep_merge!(options)
 

data/lib/rails_bootstrap_form/version.rb

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

data/lib/rails_bootstrap_form.rb

@@ -17,6 +17,7 @@ module RailsBootstrapForm
     autoload :FieldWrapperBuilder
     autoload :InputGroupBuilder
     autoload :Inputs
+    autoload :Helpers
   end
 
   class << self

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_bootstrap_form
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.6.0
 platform: ruby
 authors:
 - Harshal LADHE (shivam091)
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-05-21 00:00:00.000000000 Z
+date: 2023-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: generator_spec
@@ -65,6 +65,7 @@ files:
 - demo/app/views/layouts/application.html.erb
 - demo/app/views/users/_form.html.erb
 - demo/app/views/users/_form_without_bootstrap_helpers.html.erb
+- demo/app/views/users/_horizontal_form.html.erb
 - demo/app/views/users/_vertical_form.html.erb
 - demo/app/views/users/edit.html.erb
 - demo/app/views/users/index.html.erb
@@ -120,9 +121,9 @@ files:
 - lib/rails_bootstrap_form/configuration.rb
 - lib/rails_bootstrap_form/engine.rb
 - lib/rails_bootstrap_form/field_wrapper_builder.rb
+- lib/rails_bootstrap_form/helpers.rb
 - lib/rails_bootstrap_form/input_group_builder.rb
 - lib/rails_bootstrap_form/inputs.rb
-- lib/rails_bootstrap_form/inputs/base.rb
 - lib/rails_bootstrap_form/version.rb
 - sig/rails_bootstrap_form.rbs
 homepage: https://github.com/shivam091/rails_bootstrap_form

data/lib/rails_bootstrap_form/inputs/base.rb

@@ -1,28 +0,0 @@
-# -*- encoding: utf-8 -*-
-# -*- frozen_string_literal: true -*-
-# -*- warn_indent: true -*-
-
-module RailsBootstrapForm
-  module Inputs
-    module Base
-      extend ActiveSupport::Concern
-
-      def self.included(base_class)
-        def collection_input_checked?(checked, obj, input_value)
-          checked == input_value || Array(checked).try(:include?, input_value) ||
-            checked == obj || Array(checked).try(:include?, obj)
-        end
-
-        def control_specific_class(field_tag_name)
-          "rails-bootstrap-forms-#{field_tag_name.to_s.tr("_", "-")}"
-        end
-
-        def is_size_valid?(bootstrap_options)
-          bootstrap_options.size && %i(sm lg).include?(bootstrap_options.size)
-        end
-
-        private :collection_input_checked?, :control_specific_class, :is_size_valid?
-      end
-    end
-  end
-end