Module: ActiveScaffold::Helpers::FormColumnHelpers

Included in:
ViewHelpers
Defined in:
lib/active_scaffold/bridges/file_column/form_ui.rb,
lib/active_scaffold/bridges/dragonfly/form_ui.rb,
lib/active_scaffold/bridges/paperclip/form_ui.rb,
lib/active_scaffold/bridges/carrierwave/form_ui.rb,
lib/active_scaffold/helpers/form_column_helpers.rb

Overview

Helpers that assist with the rendering of a Form Column

Instance Method Summary collapse

Instance Method Details

#active_scaffold_add_existing_input(options) ⇒ Object 



632
633
634
635
636
637
638
639
640
641
642
643
644
645
 
# File 'lib/active_scaffold/helpers/form_column_helpers.rb', line 632

def active_scaffold_add_existing_input(options)
  record = options.delete(:object)
  if !ActiveScaffold.js_framework.nil? && controller.respond_to?(:record_select_config, true)
    remote_controller = active_scaffold_controller_for(record_select_config.model).controller_path
    options[:controller] = remote_controller
    options.merge!(active_scaffold_input_text_options)
    record_select_field(options[:name], record, options)
  else
    select_options = sorted_association_options_find(nested.association, nil, record)
    select_options ||= active_scaffold_config.model.all
    select_options = options_from_collection_for_select(select_options, :id, :to_label)
    select_tag 'associated_id', ('<option value="">' + as_(:_select_) + '</option>' + select_options).html_safe unless select_options.empty?
  end
end

#active_scaffold_add_existing_label ⇒ Object 



647
648
649
650
651
652
653
 
# File 'lib/active_scaffold/helpers/form_column_helpers.rb', line 647

def active_scaffold_add_existing_label
  if controller.respond_to?(:record_select_config, true)
    record_select_config.model.model_name.human
  else
    active_scaffold_config.model.model_name.human
  end
end

#active_scaffold_checkbox_list(column, select_options, associated_ids, options) ⇒ Object 



384
385
386
387
388
389
390
391
392
393
394
395
 
# File 'lib/active_scaffold/helpers/form_column_helpers.rb', line 384

def active_scaffold_checkbox_list(column, select_options, associated_ids, options)
  label_method = column.options[:label_method] || :to_label
  html = hidden_field_tag("#{options[:name]}[]", '', :id => nil)
  html << content_tag(:ul, options.merge(:class => "#{options[:class]} checkbox-list#{' draggable-lists' if column.options[:draggable_lists]}")) do
    content = ''.html_safe
    select_options.each_with_index do |option, i|
      content << active_scaffold_checkbox_option(option, label_method, associated_ids, :name => "#{options[:name]}[]", :id => "#{options[:id]}_#{i}_id")
    end
    content
  end
  html
end

#active_scaffold_checkbox_option(option, label_method, associated_ids, checkbox_options, li_options = {}) ⇒ Object 



375
376
377
378
379
380
381
382
 
# File 'lib/active_scaffold/helpers/form_column_helpers.rb', line 375

def active_scaffold_checkbox_option(option, label_method, associated_ids, checkbox_options, li_options = {})
  content_tag(:li, li_options) do
    option_id = option.is_a?(Array) ? option[1] : option.id
    label = option.is_a?(Array) ? option[0] : option.send(label_method)
    check_box_tag(checkbox_options[:name], option_id, associated_ids.include?(option_id), checkbox_options) <<
      content_tag(:label, label, :for => checkbox_options[:id])
  end
end

#active_scaffold_enum_options(column, record = nil) ⇒ Object 



402
403
404
 
# File 'lib/active_scaffold/helpers/form_column_helpers.rb', line 402

def active_scaffold_enum_options(column, record = nil)
  column.options[:options]
end

#active_scaffold_file_with_content(column, content, options, remove_file_prefix, controls_class) ⇒ Object 



318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
 
# File 'lib/active_scaffold/helpers/form_column_helpers.rb', line 318

def active_scaffold_file_with_content(column, content, options, remove_file_prefix, controls_class)
  required = options.delete(:required)
  case ActiveScaffold.js_framework
  when :jquery
    js_remove_file_code = "jQuery(this).prev().val('true'); jQuery(this).parent().hide().next().show()#{".find('input').attr('required', 'required')" if required}; return false;"
    js_dont_remove_file_code = "jQuery(this).parents('div.#{controls_class}').find('input.remove_file').val('false'); return false;"
  when :prototype
    js_remove_file_code = "$(this).previous().value='true'; $(this).up().hide().next().show()#{".down().writeAttribute('required', 'required')" if required}; return false;"
    js_dont_remove_file_code = "jQuery(this).parents('div.#{controls_class}').find('input.remove_file').val('false'); return false;"
  end

  object_name, method = options[:name].split(/\[(#{column.name})\]/)
  method.sub!(/#{column.name}/, "#{remove_file_prefix}\\0")
  fields = block_given? ? yield : ''
  input = file_field(:record, column.name, options.merge(:onchange => js_dont_remove_file_code))
  content_tag(:div, class: controls_class) do
    content_tag(:div) do
      safe_join [content, ' | ', fields,
                 hidden_field(object_name, method, :value => 'false', class: 'remove_file'),
                 content_tag(:a, as_(:remove_file), :href => '#', :onclick => js_remove_file_code)]
    end << content_tag(:div, input, :style => 'display: none')
  end
end

#active_scaffold_file_with_remove_link(column, options, content, remove_file_prefix, controls_class, &block) ⇒ Object 



309
310
311
312
313
314
315
316
 
# File 'lib/active_scaffold/helpers/form_column_helpers.rb', line 309

def active_scaffold_file_with_remove_link(column, options, content, remove_file_prefix, controls_class, &block)
  options = active_scaffold_input_text_options(options.merge(column.options))
  if content
    active_scaffold_file_with_content(column, content, options, remove_file_prefix, controls_class, &block)
  else
    file_field(:record, column.name, options)
  end
end

#active_scaffold_grouped_options(column, select_options, optgroup) ⇒ Object

Form input methods



263
264
265
266
267
268
269
270
 
# File 'lib/active_scaffold/helpers/form_column_helpers.rb', line 263

def active_scaffold_grouped_options(column, select_options, optgroup)
  group_column = active_scaffold_config_for(column.association.klass).columns[optgroup]
  group_label = group_column.options[:label_method] if group_column
  group_label ||= group_column.try(:association) ? :to_label : :to_s
  select_options.group_by(&optgroup.to_sym).collect do |group, options|
    [group.send(group_label), options.collect { |r| [r.send(column.options[:label_method] || :to_label), r.id] }]
  end
end

#active_scaffold_input_boolean(column, options) ⇒ Object

Column.type-based inputs



537
538
539
540
541
542
543
544
545
 
# File 'lib/active_scaffold/helpers/form_column_helpers.rb', line 537

def active_scaffold_input_boolean(column, options)
  record = options.delete(:object)
  select_options = []
  select_options << [as_(:_select_), nil] if !column.virtual? && column.column.null
  select_options << [as_(:true), true]
  select_options << [as_(:false), false]

  select_tag(options[:name], options_for_select(select_options, record.send(column.name)), options)
end

#active_scaffold_input_carrierwave(column, options) ⇒ Object 



4
5
6
7
8
9
10
11
12
13
14
15
 
# File 'lib/active_scaffold/bridges/carrierwave/form_ui.rb', line 4

def active_scaffold_input_carrierwave(column, options)
  record = options[:object]
  carrierwave = record.send(column.name.to_s)
  content = get_column_value(record, column) if carrierwave.file.present?
  active_scaffold_file_with_remove_link(column, options, content, 'remove_', 'carrierwave_controls') do
    cache_field_options = {
      name: options[:name].gsub(/\[#{column.name}\]$/, "[#{column.name}_cache]"),
      id: options[:id] + '_cache'
    }
    hidden_field(:record, "#{column.name}_cache", cache_field_options)
  end
end

#active_scaffold_input_checkbox(column, options) ⇒ Object 



462
463
464
 
# File 'lib/active_scaffold/helpers/form_column_helpers.rb', line 462

def active_scaffold_input_checkbox(column, options)
  check_box(:record, column.name, options.merge(column.options))
end

#active_scaffold_input_color(column, options) ⇒ Object

A color picker



520
521
522
523
524
525
526
527
528
529
530
531
 
# File 'lib/active_scaffold/helpers/form_column_helpers.rb', line 520

def active_scaffold_input_color(column, options)
  options = active_scaffold_input_text_options(options)
  if column.column.try(:null)
    no_color = options[:object].send(column.name).nil?
    method = no_color ? :hidden_field : :color_field
    html = content_tag(:label, check_box_tag('disable', '1', no_color, id: nil, name: nil, class: 'no-color') << " #{as_ column.options[:no_color] || :no_color}")
  else
    method = :color_field
    html = ''.html_safe
  end
  html << send(method, :record, column.name, options.merge(column.options).except(:format, :no_color))
end

#active_scaffold_input_date(column, options) ⇒ Object 



547
548
549
 
# File 'lib/active_scaffold/helpers/form_column_helpers.rb', line 547

def active_scaffold_input_date(column, options)
  active_scaffold_text_input :date_field, column, options
end

#active_scaffold_input_datetime(column, options) ⇒ Object 



555
556
557
 
# File 'lib/active_scaffold/helpers/form_column_helpers.rb', line 555

def active_scaffold_input_datetime(column, options)
  active_scaffold_text_input :datetime_local_field, column, options
end

#active_scaffold_input_dragonfly(column, options) ⇒ Object 



4
5
6
7
8
9
 
# File 'lib/active_scaffold/bridges/dragonfly/form_ui.rb', line 4

def active_scaffold_input_dragonfly(column, options)
  record = options[:object]
  dragonfly = record.send(column.name.to_s)
  content = active_scaffold_column_dragonfly(record, column) if dragonfly.present?
  active_scaffold_file_with_remove_link(column, options, content, 'remove_', 'dragonfly_controls')
end

#active_scaffold_input_email(column, options) ⇒ Object

A text box, that accepts only valid email address (in-browser validation)



482
483
484
 
# File 'lib/active_scaffold/helpers/form_column_helpers.rb', line 482

def active_scaffold_input_email(column, options)
  active_scaffold_text_input :email_field, column, options
end

#active_scaffold_input_enum(column, html_options, options = {}) ⇒ Object 



406
407
408
409
410
411
412
413
414
415
416
417
418
 
# File 'lib/active_scaffold/helpers/form_column_helpers.rb', line 406

def active_scaffold_input_enum(column, html_options, options = {})
  record = html_options.delete(:object)
  options[:selected] = record.send(column.name)
  options[:object] = record
  options_for_select = active_scaffold_enum_options(column, record).collect do |text, value|
    active_scaffold_translated_option(column, text, value)
  end
  html_options.merge!(column.options[:html_options] || {})
  options.merge!(column.options)
  active_scaffold_select_name_with_multiple html_options
  active_scaffold_translate_select_options(options)
  select(:record, column.name, options_for_select, options, html_options)
end

#active_scaffold_input_file_column(column, options) ⇒ Object 



5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
 
# File 'lib/active_scaffold/bridges/file_column/form_ui.rb', line 5

def active_scaffold_input_file_column(column, options)
  record = options[:object]
  if record.send(column.name)
    # we already have a value? display the form for deletion.
    case ActiveScaffold.js_framework
    when :jquery
      remove_file_js = "jQuery(this).prev().val('true'); jQuery(this).parent().hide().next().show(); return false;"
    when :prototype
      remove_file_js = "$(this).previous().value='true'; p=$(this).up(); p.hide(); p.next().show(); return false;"
    end

    hidden_options = options.merge(:id => options[:id] + '_delete', :name => options[:name].sub("[#{column.name}]", "[delete_#{column.name}]"), :value => 'false')
    custom_hidden_field_tag = hidden_field(:record, column.name, hidden_options)

    content_tag(:div) do
      content_tag(:div) do
        get_column_value(record, column) + " #{custom_hidden_field_tag} | ".html_safe <<
          content_tag(:a, as_(:remove_file), :href => '#', :onclick => remove_file_js) <<
          content_tag(:div, file_column_field('record', column.name, options), :style => 'display: none')
      end
    end
  else
    file_column_field('record', column.name, options)
  end
end

#active_scaffold_input_for(column, scope = nil, options = nil) ⇒ Object

This method decides which input to use for the given column. It does not do any rendering. It only decides which method is responsible for rendering.



7
8
9
10
11
 
# File 'lib/active_scaffold/helpers/form_column_helpers.rb', line 7

def active_scaffold_input_for(column, scope = nil, options = nil)
  options ||= active_scaffold_input_options(column, scope)
  options = update_columns_options(column, scope, options)
  active_scaffold_render_input(column, options)
end

#active_scaffold_input_month(column, options) ⇒ Object 



559
560
561
 
# File 'lib/active_scaffold/helpers/form_column_helpers.rb', line 559

def active_scaffold_input_month(column, options)
  active_scaffold_text_input :month_field, column, options
end

#active_scaffold_input_number(column, options) ⇒ Object

A spinbox control for number values (in-browser validation)



497
498
499
 
# File 'lib/active_scaffold/helpers/form_column_helpers.rb', line 497

def active_scaffold_input_number(column, options)
  active_scaffold_number_input :number_field, column, options, :format
end

#active_scaffold_input_options(column, scope = nil, options = {}) ⇒ Object

the standard active scaffold options used for class, name and scope



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/active_scaffold/helpers/form_column_helpers.rb', line 95

def active_scaffold_input_options(column, scope = nil, options = {})
  name = scope ? "record#{scope}[#{column.name}]" : "record[#{column.name}]"
  record = options[:object]

  # Add some HTML5 attributes for in-browser validation and better user experience
  if column.required? && (!@disable_required_for_new || scope.nil? || record.try(:persisted?))
    options[:required] = true
  end
  options[:placeholder] = column.placeholder if column.placeholder.present?

  # Fix for keeping unique IDs in subform
  id_control = "record_#{column.name}_#{[params[:eid], params[:parent_id] || params[:id]].compact.join '_'}"
  id_control += scope_id(scope) if scope

  classes = "#{column.name}-input"
  classes += ' numeric-input' if column.number?

  {:name => name, :class => classes, :id => id_control}.merge(options)
end

#active_scaffold_input_paperclip(column, options) ⇒ Object 



4
5
6
7
8
9
 
# File 'lib/active_scaffold/bridges/paperclip/form_ui.rb', line 4

def active_scaffold_input_paperclip(column, options)
  record = options[:object]
  paperclip = record.send(column.name.to_s)
  content = active_scaffold_column_paperclip(record, column) if paperclip.file?
  active_scaffold_file_with_remove_link(column, options, content, 'delete_', 'paperclip_controls')
end

#active_scaffold_input_password(column, options) ⇒ Object 



466
467
468
 
# File 'lib/active_scaffold/helpers/form_column_helpers.rb', line 466

def active_scaffold_input_password(column, options)
  active_scaffold_text_input :password_field, column, options
end

#active_scaffold_input_plural_association(column, options) ⇒ Object 



360
361
362
363
364
365
366
367
368
369
370
371
372
373
 
# File 'lib/active_scaffold/helpers/form_column_helpers.rb', line 360

def active_scaffold_input_plural_association(column, options)
  record = options.delete(:object)
  associated_options, select_options = active_scaffold_plural_association_options(column, record)

  html =
    if select_options.empty?
      content_tag(:span, as_(:no_options), :class => "#{options[:class]} no-options", :id => options[:id]) <<
        hidden_field_tag("#{options[:name]}[]", '', :id => nil)
    else
      active_scaffold_checkbox_list(column, select_options, associated_options.collect(&:id), options)
    end
  html << active_scaffold_refresh_link(column, options, record) if column.options[:refresh_link]
  html
end

#active_scaffold_input_radio(column, html_options) ⇒ Object 



445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
 
# File 'lib/active_scaffold/helpers/form_column_helpers.rb', line 445

def active_scaffold_input_radio(column, html_options)
  record = html_options[:object]
  html_options.merge!(column.options[:html_options] || {})
  options =
    if column.association
      sorted_association_options_find(column.association, nil, record)
    else
      active_scaffold_enum_options(column, record)
    end

  selected = record.send(column.association.name).try(:id) if column.association
  radios = options.map do |option|
    active_scaffold_radio_option(option, selected, column, html_options)
  end
  safe_join radios
end

#active_scaffold_input_range(column, options) ⇒ Object

A slider control for number values (in-browser validation)



502
503
504
 
# File 'lib/active_scaffold/helpers/form_column_helpers.rb', line 502

def active_scaffold_input_range(column, options)
  active_scaffold_number_input :range_field, column, options, :format
end

#active_scaffold_input_select(column, html_options) ⇒ Object 



420
421
422
423
424
425
426
427
428
 
# File 'lib/active_scaffold/helpers/form_column_helpers.rb', line 420

def active_scaffold_input_select(column, html_options)
  if column.association.try :singular?
    active_scaffold_input_singular_association(column, html_options)
  elsif column.association.try :collection?
    active_scaffold_input_plural_association(column, html_options)
  else
    active_scaffold_input_enum(column, html_options)
  end
end

#active_scaffold_input_singular_association(column, html_options, options = {}) ⇒ Object 



284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
 
# File 'lib/active_scaffold/helpers/form_column_helpers.rb', line 284

def active_scaffold_input_singular_association(column, html_options, options = {})
  record = html_options.delete(:object)
  associated = record.send(column.association.name)

  select_options = sorted_association_options_find(column.association, nil, record)
  select_options.unshift(associated) unless associated.nil? || select_options.include?(associated)

  method = column.name
  options.merge! :selected => associated.try(:id), :include_blank => as_(:_select_), :object => record

  html_options.merge!(column.options[:html_options] || {})
  options.merge!(column.options)
  active_scaffold_select_name_with_multiple html_options
  active_scaffold_translate_select_options(options)

  html =
    if (optgroup = options.delete(:optgroup))
      select(:record, method, active_scaffold_grouped_options(column, select_options, optgroup), options, html_options)
    else
      collection_select(:record, method, select_options, :id, column.options[:label_method] || :to_label, options, html_options)
    end
  html << active_scaffold_refresh_link(column, html_options, record) if column.options[:refresh_link]
  html
end

#active_scaffold_input_telephone(column, options) ⇒ Object

A text box, that accepts only valid phone-number (in-browser validation)



492
493
494
 
# File 'lib/active_scaffold/helpers/form_column_helpers.rb', line 492

def active_scaffold_input_telephone(column, options)
  active_scaffold_text_input :telephone_field, column, options, :format
end

#active_scaffold_input_text_options(options = {}) ⇒ Object

the standard active scaffold options used for textual inputs



88
89
90
91
92
 
# File 'lib/active_scaffold/helpers/form_column_helpers.rb', line 88

def active_scaffold_input_text_options(options = {})
  options[:autocomplete] = 'off'
  options[:class] = "#{options[:class]} text-input".strip
  options
end

#active_scaffold_input_textarea(column, options) ⇒ Object 



470
471
472
 
# File 'lib/active_scaffold/helpers/form_column_helpers.rb', line 470

def active_scaffold_input_textarea(column, options)
  text_area(:record, column.name, options.merge(:cols => column.options[:cols], :rows => column.options[:rows], :size => column.options[:size]))
end

#active_scaffold_input_time(column, options) ⇒ Object 



551
552
553
 
# File 'lib/active_scaffold/helpers/form_column_helpers.rb', line 551

def active_scaffold_input_time(column, options)
  active_scaffold_text_input :time_field, column, options
end

#active_scaffold_input_url(column, options) ⇒ Object

A text box, that accepts only valid URI (in-browser validation)



487
488
489
 
# File 'lib/active_scaffold/helpers/form_column_helpers.rb', line 487

def active_scaffold_input_url(column, options)
  active_scaffold_text_input :url_field, column, options
end

#active_scaffold_input_virtual(column, options) ⇒ Object 



474
475
476
 
# File 'lib/active_scaffold/helpers/form_column_helpers.rb', line 474

def active_scaffold_input_virtual(column, options)
  active_scaffold_text_input :text_field, column, options
end

#active_scaffold_input_week(column, options) ⇒ Object 



563
564
565
 
# File 'lib/active_scaffold/helpers/form_column_helpers.rb', line 563

def active_scaffold_input_week(column, options)
  active_scaffold_text_input :week_field, column, options
end

#active_scaffold_number_input(method, column, options, remove_options = nil) ⇒ Object

A slider control for number values (in-browser validation)



507
508
509
510
 
# File 'lib/active_scaffold/helpers/form_column_helpers.rb', line 507

def active_scaffold_number_input(method, column, options, remove_options = nil)
  options = numerical_constraints_for_column(column, options)
  active_scaffold_text_input method, column, options, remove_options
end

#active_scaffold_plural_association_options(column, record = nil) ⇒ Object 



355
356
357
358
 
# File 'lib/active_scaffold/helpers/form_column_helpers.rb', line 355

def active_scaffold_plural_association_options(column, record = nil)
  associated_options = record.send(column.association.name)
  [associated_options, associated_options | sorted_association_options_find(column.association, nil, record)]
end

#active_scaffold_radio_option(option, selected, column, radio_options) ⇒ Object 



430
431
432
433
434
435
436
437
438
439
440
441
442
443
 
# File 'lib/active_scaffold/helpers/form_column_helpers.rb', line 430

def active_scaffold_radio_option(option, selected, column, radio_options)
  if column.association
    label_method = column.options[:label_method] || :to_label
    text, value = [option.send(label_method), option.id]
    checked = {:checked => selected == value}
  else
    text, value = active_scaffold_translated_option(column, *option)
  end

  id_key = radio_options[:"data-id"] ? :"data-id" : :id
  radio_options = radio_options.merge(id_key => radio_options[id_key] + '-' + value.to_s.parameterize)
  radio_options.merge!(checked) if checked
  content_tag(:label, radio_button(:record, column.name, value, radio_options) + text)
end

#active_scaffold_refresh_link(column, html_options, record) ⇒ Object 



342
343
344
345
346
347
348
349
350
351
352
353
 
# File 'lib/active_scaffold/helpers/form_column_helpers.rb', line 342

def active_scaffold_refresh_link(column, html_options, record)
  link_options = {:object => record}
  if html_options['data-update_url']
    link_options['data-update_send_form'] = html_options['data-update_send_form']
    link_options['data-update_send_form_selector'] = html_options['data-update_send_form_selector']
  else
    scope = html_options[:name].scan(/^record((\[[^\]]*\])*)\[#{column.name}\]/)[0].try(:first) if html_options[:name]
    link_options = update_columns_options(column, scope.presence, link_options, true)
  end
  link_options[:class] = 'refresh-link'
  link_to(as_(:refresh), link_options.delete('data-update_url') || html_options['data-update_url'], link_options)
end

#active_scaffold_render_input(column, options) ⇒ Object 



13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/active_scaffold/helpers/form_column_helpers.rb', line 13

def active_scaffold_render_input(column, options)
  record = options[:object]

  # first, check if the dev has created an override for this specific field
  if (method = override_form_field(column))
    send(method, record, options)
  # second, check if the dev has specified a valid form_ui for this column
  elsif column.form_ui && (method = override_input(column.form_ui))
    send(method, column, options)
  # fallback: we get to make the decision
  else
    if column.association
      if column.form_ui.nil?
        # its an association and nothing is specified, we will assume form_ui :select
        active_scaffold_input_select(column, options)
      else
        # if we get here, it's because the column has a form_ui but not one ActiveScaffold knows about.
        raise "Unknown form_ui `#{column.form_ui}' for column `#{column.name}'"
      end
    elsif column.virtual?
      options[:value] = format_number_value(record.send(column.name), column.options) if column.number?
      active_scaffold_input_virtual(column, options)

    else # regular model attribute column
      # if we (or someone else) have created a custom render option for the column type, use that
      if (method = override_input(column.column.type))
        send(method, column, options)
      # final ultimate fallback: use rails' generic input method
      else
        # for textual fields we pass different options
        text_types = %i[text string integer float decimal]
        options = active_scaffold_input_text_options(options) if text_types.include?(column.column.type)
        if column.column.type == :string && options[:maxlength].blank?
          options[:maxlength] = column.column.limit
          options[:size] ||= options[:maxlength].to_i > 30 ? 30 : options[:maxlength]
        end
        options[:value] = format_number_value(record.send(column.name), column.options) if column.number?
        text_field(:record, column.name, options.merge(column.options).except(:format))
      end
    end
  end
rescue StandardError => e
  logger.error "#{e.class.name}: #{e.message} -- on the ActiveScaffold column = :#{column.name} in #{controller.class}"
  raise e
end

#active_scaffold_render_subform_column(column, scope, crud_type, readonly, add_class = false, record = nil) ⇒ Object 



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/active_scaffold/helpers/form_column_helpers.rb', line 59

def active_scaffold_render_subform_column(column, scope, crud_type, readonly, add_class = false, record = nil)
  if add_class
    col_class = []
    col_class << 'required' if column.required?
    col_class << column.css_class unless column.css_class.nil? || column.css_class.is_a?(Proc)
    col_class << 'hidden' if column_renders_as(column) == :hidden
    col_class << 'checkbox' if column.form_ui == :checkbox
    col_class = col_class.join(' ')
  end
  if readonly && !record.new_record? || !record.authorized_for?(:crud_type => crud_type, :column => column.name)
    options = active_scaffold_input_options(column, scope).except(:name)
    options[:class] = "#{options[:class]} #{col_class}" if col_class
    content_tag :span, get_column_value(record, column), options
  else
    renders_as = column_renders_as(column)
    html = render_column(column, record, renders_as, scope, false, col_class)
    html = content_tag(:div, html, active_scaffold_subform_attributes(column)) if renders_as == :subform
    html
  end
end

#active_scaffold_select_name_with_multiple(options) ⇒ Object 



278
279
280
281
282
 
# File 'lib/active_scaffold/helpers/form_column_helpers.rb', line 278

def active_scaffold_select_name_with_multiple(options)
  if options[:multiple] && !options[:name].to_s.ends_with?('[]')
    options[:name] = "#{options[:name]}[]"
  end
end

#active_scaffold_subform_attributes(column, column_css_class = nil) ⇒ Object 



80
81
82
83
84
85
 
# File 'lib/active_scaffold/helpers/form_column_helpers.rb', line 80

def active_scaffold_subform_attributes(column, column_css_class = nil)
  {
    :class => "sub-form #{active_scaffold_config_for(column.association.klass).subform.layout}-sub-form #{column_css_class} #{column.name}-sub-form",
    :id => sub_form_id(:association => column.name)
  }
end

#active_scaffold_text_input(method, column, options, remove_options = nil) ⇒ Object 



512
513
514
515
516
517
 
# File 'lib/active_scaffold/helpers/form_column_helpers.rb', line 512

def active_scaffold_text_input(method, column, options, remove_options = nil)
  options = active_scaffold_input_text_options(options)
  options = options.merge(column.options)
  options = options.except(*remove_options) if remove_options.present?
  send method, :record, column.name, options
end

#active_scaffold_translate_select_options(options) ⇒ Object 



272
273
274
275
276
 
# File 'lib/active_scaffold/helpers/form_column_helpers.rb', line 272

def active_scaffold_translate_select_options(options)
  options[:include_blank] = as_(options[:include_blank].to_s) if options[:include_blank].is_a? Symbol
  options[:prompt] = as_(options[:prompt].to_s) if options[:prompt].is_a? Symbol
  options
end

#active_scaffold_translated_option(column, text, value = nil) ⇒ Object 



397
398
399
400
 
# File 'lib/active_scaffold/helpers/form_column_helpers.rb', line 397

def active_scaffold_translated_option(column, text, value = nil)
  value = text if value.nil?
  [(text.is_a?(Symbol) ? column.active_record_class.human_attribute_name(text) : text), value]
end

#column_renders_as(column) ⇒ Object

Macro-level rendering decisions for columns



612
613
614
615
616
617
618
619
620
621
622
 
# File 'lib/active_scaffold/helpers/form_column_helpers.rb', line 612

def column_renders_as(column)
  if column.respond_to? :each
    :subsection
  elsif column.active_record_class.locking_column.to_s == column.name.to_s || column.form_ui == :hidden
    :hidden
  elsif column.association.nil? || column.form_ui || !active_scaffold_config_for(column.association.klass).actions.include?(:subform) || override_form_field?(column)
    :field
  else
    :subform
  end
end

#column_scope(column, scope = nil, record = nil) ⇒ Object 



624
625
626
627
628
629
630
 
# File 'lib/active_scaffold/helpers/form_column_helpers.rb', line 624

def column_scope(column, scope = nil, record = nil)
  if column.association.try(:collection?)
    "#{scope}[#{column.name}][#{record.id || generate_temporary_id(record)}]"
  else
    "#{scope}[#{column.name}]"
  end
end

#column_show_add_existing(column, record = nil) ⇒ Object 



247
248
249
 
# File 'lib/active_scaffold/helpers/form_column_helpers.rb', line 247

def column_show_add_existing(column, record = nil)
  column.allow_add_existing && options_for_association_count(column.association, record) > 0
end

#column_show_add_new(column, associated, record) ⇒ Object 



251
252
253
254
255
256
257
 
# File 'lib/active_scaffold/helpers/form_column_helpers.rb', line 251

def column_show_add_new(column, associated, record)
  assoc = column.association
  value = assoc.singular?
  value ||= assoc.collection? && !assoc.readonly? && (!assoc.through? || !assoc.through_reflection.collection?)
  value &&= false unless assoc.klass.authorized_for?(:crud_type => :create)
  value
end

#current_form_columns(record, scope, subform_controller = nil) ⇒ Object 



115
116
117
118
119
120
121
122
123
 
# File 'lib/active_scaffold/helpers/form_column_helpers.rb', line 115

def current_form_columns(record, scope, subform_controller = nil)
  if scope
    subform_controller.active_scaffold_config.subform.columns.names
  elsif %i[new create edit update render_field].include? action_name.to_sym
    # disable update_columns for inplace_edit (GET render_field)
    return if action_name == 'render_field' && request.get?
    active_scaffold_config.send(record.new_record? ? :create : :update).columns.names
  end
end

#field_attributes(column, record) ⇒ Object 



151
152
153
 
# File 'lib/active_scaffold/helpers/form_column_helpers.rb', line 151

def field_attributes(column, record)
  {}
end

#form_attribute(column, record, scope = nil, only_value = false, col_class = nil) ⇒ Object 



167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/active_scaffold/helpers/form_column_helpers.rb', line 167

def form_attribute(column, record, scope = nil, only_value = false, col_class = nil)
  column_options = active_scaffold_input_options(column, scope, :object => record)
  attributes = field_attributes(column, record)
  attributes[:class] = "#{attributes[:class]} #{col_class}" if col_class.present?
  if only_value
    field = content_tag(:span, get_column_value(record, column), column_options.except(:name, :object))
    if column.association.nil? || column.association.belongs_to?
      # hidden field probably not needed, but leaving it just in case
      # but it isn't working for assocations which are not belongs_to
      method = column.association ? column.association.foreign_key : column.name
      field << hidden_field(:record, method, column_options)
    end
  else
    field = active_scaffold_input_for column, scope, column_options
  end

  content_tag :dl, attributes do
    %(<dt>#{label_tag label_for(column, column_options), column.label}</dt><dd>#{field}
#{loading_indicator_tag(:action => :render_field, :id => params[:id]) if column.update_columns}
#{content_tag :span, column.description, :class => 'description' if column.description.present?}
</dd>).html_safe
  end
end

#form_hidden_attribute(column, record, scope = nil) ⇒ Object 



199
200
201
202
203
204
 
# File 'lib/active_scaffold/helpers/form_column_helpers.rb', line 199

def form_hidden_attribute(column, record, scope = nil)
  content_tag :dl, style: 'display: none' do
    content_tag(:dt, '') <<
      content_tag(:dd, form_hidden_field(column, record, scope))
  end
end

#form_hidden_field(column, record, scope) ⇒ Object 



206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
 
# File 'lib/active_scaffold/helpers/form_column_helpers.rb', line 206

def form_hidden_field(column, record, scope)
  options = active_scaffold_input_options(column, scope)
  if column.association.try(:collection?)
    associated = record.send(column.name)
    if associated.blank?
      hidden_field_tag options[:name], '', options
    else
      options[:name] += '[]'
      fields = associated.map do |r|
        hidden_field_tag options[:name], r.id, options.merge(id: options[:id] + "_#{r.id}")
      end
      safe_join fields, ''
    end
  elsif column.association
    hidden_field_tag options[:name], record.send(column.name).try(:id), options
  else
    hidden_field :record, column.name, options.merge(object: record)
  end
end

#in_subform?(column, parent_record, parent_column) ⇒ Boolean

Should this column be displayed in the subform?

Returns:

  • (Boolean) 


227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/active_scaffold/helpers/form_column_helpers.rb', line 227

def in_subform?(column, parent_record, parent_column)
  return true unless column.association

  if column.association.reverse.nil?
    # Polymorphic associations can't appear because they *might* be the reverse association
    return false if column.association.polymorphic?

    # A column shouldn't be in the subform if it's the reverse association to the parent
    !column.association.inverse_for?(parent_record.class)
  elsif column.association.reverse == parent_column.name
    if column.association.polymorphic?
      column.association.name != parent_column.association.as
    else
      !column.association.inverse_for?(parent_record.class)
    end
  else
    true
  end
end

#label_for(column, options) ⇒ Object 



191
192
193
 
# File 'lib/active_scaffold/helpers/form_column_helpers.rb', line 191

def label_for(column, options)
  options[:id] unless column.form_ui == :select && column.association.try(:collection?)
end

#numerical_constraints_for_column(column, options) ⇒ Object

Try to get numerical constraints from model’s validators



656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
 
# File 'lib/active_scaffold/helpers/form_column_helpers.rb', line 656

def numerical_constraints_for_column(column, options)
  if column.numerical_constraints.nil?
    numerical_constraints = {}
    validators = column.active_record_class.validators.select do |v|
      v.is_a?(ActiveModel::Validations::NumericalityValidator) && v.attributes.include?(column.name)
    end
    equal_to = (val = validators.find { |v| v.options[:equal_to] }) ? val.options[:equal_to] : nil

    # If there is equal_to constraint - use it (unless otherwise specified by user)
    if equal_to && !(options[:min] || options[:max])
      numerical_constraints[:min] = numerical_constraints[:max] = equal_to
    else # find minimum and maximum from validators
      # we can safely modify :min and :max by 1 for :greater_tnan or :less_than value only for integer values
      only_integer = column.column.type == :integer if column.column
      only_integer ||= validators.find { |v| v.options[:only_integer] }.present?
      margin = only_integer ? 1 : 0

      # Minimum
      unless options[:min]
        min = validators.map { |v| v.options[:greater_than_or_equal] }.compact.max
        greater_than = validators.map { |v| v.options[:greater_than] }.compact.max
        numerical_constraints[:min] = [min, (greater_than + margin if greater_than)].compact.max
      end

      # Maximum
      unless options[:max]
        max = validators.map { |v| v.options[:less_than_or_equal] }.compact.min
        less_than = validators.map { |v| v.options[:less_than] }.compact.min
        numerical_constraints[:max] = [max, (less_than - margin if less_than)].compact.min
      end

      # Set step = 2 for column values restricted to be odd or even (but only if minimum is set)
      unless options[:step]
        only_odd_valid  = validators.any? { |v| v.options[:odd] }
        only_even_valid = validators.any? { |v| v.options[:even] } unless only_odd_valid
        if !only_integer
          numerical_constraints[:step] ||= "0.#{'0' * (column.column.scale - 1)}1" if column.column && column.column.scale.to_i > 0
        elsif options[:min] && options[:min].respond_to?(:even?) && (only_odd_valid || only_even_valid)
          numerical_constraints[:step] = 2
          numerical_constraints[:min] += 1 if only_odd_valid  && options[:min].even?
          numerical_constraints[:min] += 1 if only_even_valid && options[:min].odd?
        end
        numerical_constraints[:step] ||= 'any' unless only_integer
      end
    end

    column.numerical_constraints = numerical_constraints
  end
  column.numerical_constraints.merge(options)
end

#override_form_field(column) ⇒ Object Also known as: override_form_field? 



591
592
593
 
# File 'lib/active_scaffold/helpers/form_column_helpers.rb', line 591

def override_form_field(column)
  override_helper column, 'form_column'
end

#override_form_field_partial(column) ⇒ Object

the naming convention for overriding form fields with helpers



587
588
589
 
# File 'lib/active_scaffold/helpers/form_column_helpers.rb', line 587

def override_form_field_partial(column)
  partial_for_model(column.active_record_class, "#{clean_column_name(column.name)}_form_column")
end

#override_input(form_ui) ⇒ Object Also known as: override_input?

the naming convention for overriding form input types with helpers



597
598
599
600
 
# File 'lib/active_scaffold/helpers/form_column_helpers.rb', line 597

def override_input(form_ui)
  method = "active_scaffold_input_#{form_ui}"
  method if respond_to? method
end

#override_subform_partial(column, subform_partial) ⇒ Object

add functionality for overriding subform partials from association class path



582
583
584
 
# File 'lib/active_scaffold/helpers/form_column_helpers.rb', line 582

def override_subform_partial(column, subform_partial)
  partial_for_model(column.association.klass, subform_partial) if column_renders_as(column) == :subform
end

#partial_for_model(model, partial) ⇒ Object

Form column override signatures



571
572
573
574
575
576
577
578
579
 
# File 'lib/active_scaffold/helpers/form_column_helpers.rb', line 571

def partial_for_model(model, partial)
  controller = active_scaffold_controller_for(model)
  while controller.uses_active_scaffold?
    path = File.join(controller.controller_path, partial)
    return path if template_exists?(path, true)
    controller = controller.superclass
  end
  nil
end

#render_column(column, record, renders_as, scope = nil, only_value = false, col_class = nil) ⇒ Object 



155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/active_scaffold/helpers/form_column_helpers.rb', line 155

def render_column(column, record, renders_as, scope = nil, only_value = false, col_class = nil)
  if partial = override_form_field_partial(column)
    render :partial => partial, :locals => {:column => column, :only_value => only_value, :scope => scope, :col_class => col_class, :record => record}
  elsif renders_as == :field || override_form_field?(column)
    form_attribute(column, record, scope, only_value, col_class)
  elsif renders_as == :subform
    render :partial => 'form_association', :locals => {:column => column, :scope => scope, :parent_record => record}
  else
    form_hidden_attribute(column, record, scope)
  end
end

#subform_label(column, hidden) ⇒ Object 



195
196
197
 
# File 'lib/active_scaffold/helpers/form_column_helpers.rb', line 195

def subform_label(column, hidden)
  column.label unless hidden
end

#subform_partial_for_column(column) ⇒ Object 



603
604
605
606
 
# File 'lib/active_scaffold/helpers/form_column_helpers.rb', line 603

def subform_partial_for_column(column)
  subform_partial = "#{active_scaffold_config_for(column.association.klass).subform.layout}_subform"
  override_subform_partial(column, subform_partial) || subform_partial
end

#update_columns_options(column, scope, options, force = false) ⇒ Object 



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
 
# File 'lib/active_scaffold/helpers/form_column_helpers.rb', line 125

def update_columns_options(column, scope, options, force = false)
  record = options[:object]
  subform_controller = controller.class.active_scaffold_controller_for(record.class) if scope
  form_columns = @main_columns.try(:names) if scope.nil? || subform_controller == controller.class
  form_columns ||= current_form_columns(record, scope, subform_controller)
  if force || (form_columns && column.update_columns && (column.update_columns & form_columns).present?)
    url_params = params_for(:action => 'render_field', :column => column.name, :id => record.to_param)
    if nested? && scope
      url_params[:nested] = url_params.slice(:parent_scaffold, :association, nested.param_name)
      url_params = url_params.except(:parent_scaffold, :association, nested.param_name)
    end
    if scope
      url_params[:parent_controller] ||= url_params[:controller].gsub(/^\//, '')
      url_params[:controller] = subform_controller.controller_path
      url_params[:scope] = scope
      url_params[:parent_id] = params[:parent_id] || params[:id]
    end

    options[:class] = "#{options[:class]} update_form".strip
    options['data-update_url'] = url_for(url_params)
    options['data-update_send_form'] = column.send_form_on_update_column
    options['data-update_send_form_selector'] = column.options[:send_form_selector] if column.options[:send_form_selector]
  end
  options
end