Class: ComfyBootstrapForm::FormBuilder

Inherits:
ActionView::Helpers::FormBuilder
  • Object
show all
Defined in:
lib/comfy_bootstrap_form/form_builder.rb

Constant Summary collapse

FIELD_HELPERS = 
%w[
  color_field date_field datetime_field email_field month_field
  number_field password_field phone_field range_field search_field text_area
  text_field time_field url_field week_field
].freeze
DATE_SELECT_HELPERS = 
%w[
  date_select datetime_select time_select
].freeze

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(object_name, object, template, options) ⇒ FormBuilder

Returns a new instance of FormBuilder.



23
24
25
26
 
# File 'lib/comfy_bootstrap_form/form_builder.rb', line 23

def initialize(object_name, object, template, options)
  @form_bootstrap = ComfyBootstrapForm::BootstrapOptions.new(options.delete(:bootstrap))
  super(object_name, object, template, options)
end

Instance Attribute Details

#form_bootstrap ⇒ Object

Bootstrap settings set on the form itself



21
22
23
 
# File 'lib/comfy_bootstrap_form/form_builder.rb', line 21

def form_bootstrap
  @form_bootstrap
end

Instance Method Details

#check_box(method, options = {}, checked_value = "1", unchecked_value = "0") ⇒ Object

Wrapper around checkbox. Example usage:

checkbox :agree, bootstrap: {label: {text: "Do you agree?"}}



115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/comfy_bootstrap_form/form_builder.rb', line 115

def check_box(method, options = {}, checked_value = "1", unchecked_value = "0")
  bootstrap = form_bootstrap.scoped(options.delete(:bootstrap))
  return super if bootstrap.disabled

  help_text = draw_help(bootstrap.help)
  errors    = draw_errors(method)

  add_css_class!(options, "form-check-input")
  add_css_class!(options, "is-invalid") if errors.present?

  label_text = nil
  if (custom_text = bootstrap.label[:text]).present?
    label_text = custom_text
  end

  fieldset_css_class = "form-group"
  fieldset_css_class += " row" if bootstrap.horizontal?
  fieldset_css_class += " #{bootstrap.inline_margin_class}" if bootstrap.inline?

  content_tag(:fieldset, class: fieldset_css_class) do
    draw_control_column(bootstrap, offset: true) do
      if bootstrap.custom_control
        content_tag(:div, class: "custom-control custom-checkbox") do
          add_css_class!(options, "custom-control-input")
          remove_css_class!(options, "form-check-input")
          concat super(method, options, checked_value, unchecked_value)
          concat label(method, label_text, class: "custom-control-label")
          concat errors     if errors.present?
          concat help_text  if help_text.present?
        end
      else
        content_tag(:div, class: "form-check") do
          concat super(method, options, checked_value, unchecked_value)
          concat label(method, label_text, class: "form-check-label")
          concat errors     if errors.present?
          concat help_text  if help_text.present?
        end
      end
    end
  end
end

#collection_check_boxes(method, collection, value_method, text_method, options = {}, html_options = {}) ⇒ Object

Helper to generate multiple checkboxes. Same options as for radio buttons. Example usage:

collection_check_boxes :choices, Choice.all, :id, :label



183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
 
# File 'lib/comfy_bootstrap_form/form_builder.rb', line 183

def collection_check_boxes(method, collection, value_method, text_method, options = {}, html_options = {})
  bootstrap = form_bootstrap.scoped(options.delete(:bootstrap))
  return super if bootstrap.disabled

  content = "".html_safe
  unless options[:include_hidden] == false
    content << hidden_field(method, multiple: true, value: "")
  end

  args = [bootstrap, :check_box, method, collection, value_method, text_method, options, html_options]
  content << draw_choices(*args) do |m, v, opts|
    opts[:multiple]       = true
    opts[:include_hidden] = false
    ActionView::Helpers::FormBuilder.instance_method(:check_box).bind(self).call(m, opts, v)
  end
end

#collection_radio_buttons(method, collection, value_method, text_method, options = {}, html_options = {}) ⇒ Object

Helper to generate multiple radio buttons. Example usage:

collection_radio_buttons :choices, ["a", "b"], :to_s, :to_s %>
collection_radio_buttons :choices, [["a", "Label A"], ["b", "Label B"]], :first, :second
collection_radio_buttons :choices, Choice.all, :id, :label

Takes bootstrap options:

inline: true            - to render inputs inline
label: {text: "Custom"} - to specify a label
label: {hide: true}     - to not render label at all



168
169
170
171
172
173
174
175
176
 
# File 'lib/comfy_bootstrap_form/form_builder.rb', line 168

def collection_radio_buttons(method, collection, value_method, text_method, options = {}, html_options = {})
  bootstrap = form_bootstrap.scoped(options.delete(:bootstrap))
  return super if bootstrap.disabled

  args = [bootstrap, :radio_button, method, collection, value_method, text_method, options, html_options]
  draw_choices(*args) do |m, v, opts|
    radio_button(m, v, opts)
  end
end

#file_field(method, options = {}) ⇒ Object

Wrapper for file_field helper. It can accept ‘custom_control` option.

file_field :photo, bootstrap: {custom_control: true}



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/comfy_bootstrap_form/form_builder.rb', line 89

def file_field(method, options = {})
  bootstrap = form_bootstrap.scoped(options.delete(:bootstrap))
  return super if bootstrap.disabled

  draw_form_group(bootstrap, method, options) do
    if bootstrap.custom_control
      content_tag(:div, class: "custom-file") do
        add_css_class!(options, "custom-file-input")
        remove_css_class!(options, "form-control")
        label_text = options.delete(:placeholder)
        concat super(method, options)

        label_options = { class: "custom-file-label" }
        label_options[:for] = options[:id] if options[:id].present?
        concat label(method, label_text, label_options)
      end
    else
      super(method, options)
    end
  end
end

#form_group(options = {}) ⇒ Object

Helper method to put arbitrary content in markup that renders correctly for the Bootstrap form. Example:

form_group bootstrap: {label: {text: "Label"}} do
  "Some content"
end



262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'lib/comfy_bootstrap_form/form_builder.rb', line 262

def form_group(options = {})
  bootstrap = form_bootstrap.scoped(options.delete(:bootstrap))

  label_options = bootstrap.label.clone
  label_text = label_options.delete(:text)

  label =
    if label_text.present?
      if bootstrap.horizontal?
        add_css_class!(label_options, "col-form-label")
        add_css_class!(label_options, bootstrap.label_col_class)
        add_css_class!(label_options, bootstrap.label_align_class)
      elsif bootstrap.inline?
        add_css_class!(label_options, bootstrap.inline_margin_class)
      end

      content_tag(:label, label_text, label_options)
    end

  form_group_class = "form-group"
  form_group_class += " row"      if bootstrap.horizontal?
  form_group_class += " mr-sm-2"  if bootstrap.inline?

  content_tag(:div, class: form_group_class) do
    content = "".html_safe
    content << label if label.present?
    content << draw_control_column(bootstrap, offset: label.blank?) do
      yield
    end
  end
end

#plaintext(method, options = {}) ⇒ Object

Bootstrap wrapper for readonly text field that is shown as plain text.

plaintext(:value)



204
205
206
207
208
209
210
211
212
 
# File 'lib/comfy_bootstrap_form/form_builder.rb', line 204

def plaintext(method, options = {})
  bootstrap = form_bootstrap.scoped(options.delete(:bootstrap))
  draw_form_group(bootstrap, method, options) do
    remove_css_class!(options, "form-control")
    add_css_class!(options, "form-control-plaintext")
    options[:readonly] = true
    ActionView::Helpers::FormBuilder.instance_method(:text_field).bind(self).call(method, options)
  end
end

#primary(value = nil, options = {}, &block) ⇒ Object

Same as submit button, only with btn-primary class added



250
251
252
253
 
# File 'lib/comfy_bootstrap_form/form_builder.rb', line 250

def primary(value = nil, options = {}, &block)
  add_css_class!(options, "btn-primary")
  submit(value, options, &block)
end

#select(method, choices = nil, options = {}, html_options = {}, &block) ⇒ Object

Wrapper for select helper. Boostrap options are sent via options hash:

select :choices, ["a", "b"], bootstrap: {label: {text: "Custom"}}



74
75
76
77
78
79
80
81
82
83
 
# File 'lib/comfy_bootstrap_form/form_builder.rb', line 74

def select(method, choices = nil, options = {}, html_options = {}, &block)
  bootstrap = form_bootstrap.scoped(options.delete(:bootstrap))
  return super if bootstrap.disabled

  add_css_class!(html_options, "custom-select") if bootstrap.custom_control

  draw_form_group(bootstrap, method, html_options) do
    super(method, choices, options, html_options, &block)
  end
end

#submit(value = nil, options = {}, &block) ⇒ Object

Add bootstrap formatted submit button. If you need to change its type or add another css class, you need to override all css classes like so:

submit(class: "btn btn-info custom-class")

You may add additional content that directly follows the button. Here’s an example of a cancel link:

submit do
  link_to("Cancel", "/", class: "btn btn-link")
end



226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/comfy_bootstrap_form/form_builder.rb', line 226

def submit(value = nil, options = {}, &block)
  if value.is_a?(Hash)
    options = value
    value   = nil
  end

  bootstrap = form_bootstrap.scoped(options.delete(:bootstrap))
  return super if bootstrap.disabled

  add_css_class!(options, "btn")

  form_group_class = "form-group"
  form_group_class += " row" if bootstrap.horizontal?

  content_tag(:div, class: form_group_class) do
    draw_control_column(bootstrap, offset: true) do
      out = super(value, options)
      out << capture(&block) if block_given?
      out
    end
  end
end