rails_bootstrap_form 0.6.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 34303679b08cf0617516305e5b4e1f21d8c201ffcd9f4cc8eb90f26a587a7f7a
-  data.tar.gz: 4e01e2321eb0318e222e802ce84e8c63648296c50e78de5de9f3c8e14be9570e
+  metadata.gz: ad6e14683d4d77bee3ee35855f75a8af8258bf8208f47504678e2a9d9b3be743
+  data.tar.gz: f0a40a462746c5990a5df46ef604fce57a43359cda481b42557ee5e182e65019
 SHA512:
-  metadata.gz: c7f4349d0933eeea1f1965df83eb80ec0fd83392a3a47e2299214a797ec36e5c198e647d727969443779d60910741f91b49f88973a6ebcf6d93a29302f308b46
-  data.tar.gz: adab966d0ca4b8064094e7e941296d95e75e594452384e9cb6e7370ca19fd288a4e9d9cea1e56dbf7981804ef58f9cafc1398d1e0203bb1eefb80004f27ab18d
+  metadata.gz: c4db5095b17363d92f5fe629d05a8cc1031e925aeecc461a113a905dd98e3b6b6bff3298c3154332b82160a3adfd72e358cef2578bc7ecb0af24296d0bdd9102
+  data.tar.gz: 603478636468cc3a2d379b6499a15674b21d990aed61b333b2aa3db356b96af703dc423b67c2fb1b0a4a74a1589c02bd11e0c11c91229d526a65c330e6bbda41

data/CHANGELOG.md

@@ -4,6 +4,17 @@ You can find recent releases with docs in GitHub:
 
 https://github.com/shivam091/rails_bootstrap_form/releases
 
+## [0.7.0](https://github.com/shivam091/rails_bootstrap_form/compare/v0.6.2...v0.7.0) - 2023-05-24
+
+### What's new
+- Added helper methods for rendering submit buttons on forms.
+
+## [0.6.2](https://github.com/shivam091/rails_bootstrap_form/compare/v0.6.1...v0.6.2) - 2023-05-24
+
+### What's fixed
+- Added support for setting bootstrap options of parent form to `fields_for` ([#10](https://github.com/shivam091/rails_bootstrap_form/issues/10))
+- Ignore skip_label option when field has floating labels ([#9](https://github.com/shivam091/rails_bootstrap_form/issues/9))
+
 ## [0.6.1](https://github.com/shivam091/rails_bootstrap_form/compare/v0.6.0...v0.6.1) - 2023-05-24
 
 ### What's changed

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rails_bootstrap_form (0.6.1)
+    rails_bootstrap_form (0.7.0)
       actionpack (~> 7.0)
       activemodel (~> 7.0)
 

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

@@ -14,7 +14,7 @@
       <%= form.collection_radio_buttons :fruit_id, ::Fruit.all, :id, :name, {checked: form.object.fruit_id} %>
       <%= form.color_field :favorite_color %>
       <%= form.collection_check_boxes :skill_ids, ::Skill.all, :id, :name %>
-      <%= form.fields_for :address, include_id: false, bootstrap_form: {layout: :horizontal} do |address_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.includes(:cities), :cities, :name, :id, :name, {include_blank: "Select city"} %>
@@ -24,7 +24,7 @@
       <% end %>
       <%= form.check_box :terms, required: true %>
       <div class="mt-3">
-        <%= form.submit "Register", class: "btn btn-primary" %>
+        <%= form.primary "Register" %>
         <%= link_to "Cancel", users_path, class: "btn btn-secondary" %>
       </div>
     <% end %>

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

@@ -24,7 +24,7 @@
       <% end %>
       <%= form.check_box :terms, required: true %>
       <div class="mt-3">
-        <%= form.submit "Register", class: "btn btn-primary" %>
+        <%= form.primary "Register" %>
         <%= link_to "Cancel", users_path, class: "btn btn-secondary" %>
       </div>
     <% end %>

data/lib/rails_bootstrap_form/bootstrap_form_builder.rb

@@ -15,16 +15,28 @@ module RailsBootstrapForm
     attr_accessor :bootstrap_form_options
 
     def initialize(object_name, object, template, options)
-      @bootstrap_form_options = RailsBootstrapForm::BootstrapFormOptions.new(options.delete(:bootstrap_form))
+      @bootstrap_form_options = RailsBootstrapForm::BootstrapFormOptions.new(options[:bootstrap_form])
       apply_default_form_options(options)
       super(object_name, object, template, options)
     end
 
+    def fields_for(record_name, record_object = nil, fields_options = {}, &block)
+      fields_options = fields_for_options(record_object, fields_options)
+      record_object = nil if record_object.is_a?(Hash) && record_object.extractable_options?
+      super(record_name, record_object, fields_options, &block)
+    end
+
     def apply_default_form_options(options)
       options[:html] ||= {}
       options[:html].reverse_merge!(RailsBootstrapForm.config.default_form_attributes)
     end
 
-    private :apply_default_form_options
+    def fields_for_options(record_object, fields_options)
+      field_options = record_object if record_object.is_a?(Hash) && record_object.extractable_options?
+      field_options = {bootstrap_form: options[:bootstrap_form]}.deep_merge!(field_options)
+      field_options
+    end
+
+    private :apply_default_form_options, :fields_for_options
   end
 end

data/lib/rails_bootstrap_form/bootstrap_form_options.rb

@@ -119,6 +119,11 @@ module RailsBootstrapForm
     # The default value is `col-sm-10`.
     attr_accessor :field_col_wrapper_class
 
+    # Option to render submit button using `<button type="submit">` instead of
+    # `<input type="submit">`.
+    # The default value is `false`.
+    attr_accessor :render_as_button
+
     def initialize(options = {})
       set_defaults
       set_bootstrap_form_options(options)
@@ -136,10 +141,6 @@ module RailsBootstrapForm
       @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:
@@ -161,6 +162,10 @@ module RailsBootstrapForm
       end
     end
 
+    %i(inline floating switch skip_label hide_label render_as_button).each do |method|
+      define_method("#{method}?") { self.send(method) }
+    end
+
     def set_defaults
       @layout = "vertical"
 
@@ -191,6 +196,8 @@ module RailsBootstrapForm
       @label_col_class = "col-form-label"
       @label_col_wrapper_class = "col-sm-2"
       @field_col_wrapper_class = "col-sm-10"
+
+      @render_as_button = false
     end
 
     private :set_defaults

data/lib/rails_bootstrap_form/field_wrapper_builder.rb

@@ -27,7 +27,7 @@ module RailsBootstrapForm
           end)
         end
       else
-        if bootstrap_options.floating
+        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
@@ -82,7 +82,7 @@ module RailsBootstrapForm
       css_options[:class] = field_classes.flatten.compact
       css_options.merge!(required_field_options(attribute, options))
 
-      if (bootstrap_options.floating && !bootstrap_options.layout_horizontal?)
+      if (bootstrap_options.floating? && !bootstrap_options.layout_horizontal?)
         css_options[:placeholder] ||= label_text(attribute, bootstrap_options)
       end
 

data/lib/rails_bootstrap_form/helpers/buttons.rb

@@ -0,0 +1,39 @@
+# -*- encoding: utf-8 -*-
+# -*- frozen_string_literal: true -*-
+# -*- warn_indent: true -*-
+
+module RailsBootstrapForm
+  module Helpers
+    module Buttons
+      extend ActiveSupport::Concern
+
+      def self.included(base_class)
+        def render_button(value = nil, options = {}, &block)
+          value, options = nil, value if value.is_a?(Hash)
+          bootstrap_options = bootstrap_form_options.scoped(options.delete(:bootstrap_form))
+
+          if (bootstrap_options.render_as_button? || block)
+            button(value, options, &block)
+          else
+            submit(value, options)
+          end
+        end
+
+        def secondary(value = nil, options = {}, &block)
+          add_css_class!(options, "btn btn-secondary")
+          render_button(value, options, &block)
+        end
+
+        def primary(value = nil, options = {}, &block)
+          add_css_class!(options, "btn btn-primary")
+          render_button(value, options, &block)
+        end
+
+        def danger(value = nil, options = {}, &block)
+          add_css_class!(options, "btn btn-danger")
+          render_button(value, options, &block)
+        end
+      end
+    end
+  end
+end

data/lib/rails_bootstrap_form/helpers/check_box.rb

@@ -9,7 +9,7 @@ module RailsBootstrapForm
 
       def self.included(base_class)
         def check_box_label(attribute, checked_value, options, bootstrap_options, &block)
-          unless bootstrap_options.skip_label
+          unless bootstrap_options.skip_label?
             label_options = {
               class: check_box_label_class(attribute, bootstrap_options, options)
             }
@@ -54,13 +54,13 @@ module RailsBootstrapForm
           classes = Array("form-check-label") << bootstrap_options.additional_label_class
           classes << "required" if is_field_required?(attribute, options) && !bootstrap_options.inline?
           classes << "is-invalid" if is_invalid?(attribute)
-          classes << bootstrap_options.hide_class if bootstrap_options.hide_label
+          classes << bootstrap_options.hide_class if bootstrap_options.hide_label?
           classes.flatten.compact
         end
 
         def check_box_wrapper_class(bootstrap_options)
           classes = Array("form-check")
-          classes << "form-switch" if bootstrap_options.switch
+          classes << "form-switch" if bootstrap_options.switch?
           classes << "form-check-inline" if bootstrap_options.inline?
           classes << "mb-3" unless (bootstrap_options.layout_horizontal? || bootstrap_options.inline?)
           classes.flatten.compact

data/lib/rails_bootstrap_form/helpers/labels.rb

@@ -9,7 +9,7 @@ module RailsBootstrapForm
 
       def self.included(base_class)
         def draw_label(attribute, options, bootstrap_options)
-          unless bootstrap_options.skip_label
+          unless bootstrap_options.skip_label? && !bootstrap_options.floating?
             label_options = {
               class: label_classes(attribute, bootstrap_options)
             }
@@ -28,7 +28,7 @@ module RailsBootstrapForm
             bootstrap_options.label_class
           end
           classes << bootstrap_options.additional_label_class
-          classes << bootstrap_options.hide_class if bootstrap_options.hide_label
+          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

data/lib/rails_bootstrap_form/helpers/radio_button.rb

@@ -9,7 +9,7 @@ module RailsBootstrapForm
 
       def self.included(base_class)
         def radio_button_label(attribute, value, options, bootstrap_options)
-          unless bootstrap_options.skip_label
+          unless bootstrap_options.skip_label?
             label_options = {
               value: value,
               class: radio_button_label_class(attribute, bootstrap_options, options)
@@ -51,7 +51,7 @@ module RailsBootstrapForm
           classes = Array("form-check-label") << bootstrap_options.additional_label_class
           classes << "required" if is_field_required?(attribute, options) && !bootstrap_options.inline?
           classes << "is-invalid" if is_invalid?(attribute)
-          classes << bootstrap_options.hide_class if bootstrap_options.hide_label
+          classes << bootstrap_options.hide_class if bootstrap_options.hide_label?
           classes.flatten.compact
         end
 

data/lib/rails_bootstrap_form/helpers.rb

@@ -13,6 +13,7 @@ module RailsBootstrapForm
     autoload :Errors
     autoload :CheckBox
     autoload :RadioButton
+    autoload :Buttons
 
     include HelpText
     include Labels
@@ -20,6 +21,7 @@ module RailsBootstrapForm
     include Errors
     include CheckBox
     include RadioButton
+    include Buttons
 
     def self.included(base_class)
       def collection_input_checked?(checked, obj, input_value)
@@ -39,7 +41,19 @@ module RailsBootstrapForm
         label_col_wrapper_class.gsub(/\bcol-(\w+)-(\d)\b/, 'offset-\1-\2')
       end
 
-      private :collection_input_checked?, :control_specific_class, :is_size_valid?
+      def add_css_class!(options, css_class)
+        the_class = [options[:class], css_class].compact
+        options[:class] = the_class if the_class.present?
+      end
+
+      def remove_css_class!(options, css_class)
+        the_class = options[:class].to_s.split(" ")
+        options[:class] = (the_class - [css_class]).compact.join(" ")
+        options.delete(:class) if options[:class].blank?
+      end
+
+      private :collection_input_checked?, :control_specific_class, :is_size_valid?,
+              :add_css_class!, :remove_css_class!
     end
   end
 end

data/lib/rails_bootstrap_form/version.rb

@@ -3,6 +3,6 @@
 # -*- warn_indent: true -*-
 
 module RailsBootstrapForm
-  VERSION = "0.6.1".freeze
+  VERSION = "0.7.0".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.6.1
+  version: 0.7.0
 platform: ruby
 authors:
 - Harshal LADHE (shivam091)
@@ -143,6 +143,7 @@ files:
 - lib/rails_bootstrap_form/engine.rb
 - lib/rails_bootstrap_form/field_wrapper_builder.rb
 - lib/rails_bootstrap_form/helpers.rb
+- lib/rails_bootstrap_form/helpers/buttons.rb
 - lib/rails_bootstrap_form/helpers/check_box.rb
 - lib/rails_bootstrap_form/helpers/errors.rb
 - lib/rails_bootstrap_form/helpers/help_text.rb