Module: DynamicFieldsetsHelper

Defined in:
app/helpers/dynamic_fieldsets_helper.rb

Instance Method Summary collapse

Instance Method Details

#dynamic_fieldset_form_renderer(fsa) ⇒ String

Build HTML for a specific dynamic fieldset on a form page

Parameters:

  • The (FieldsetAssociator) —

    fieldset associator for the dynamic fieldset to render

Returns:

  • (String) —

    The HTML for the entire dynamic fieldset



186
187
188
 
# File 'app/helpers/dynamic_fieldsets_helper.rb', line 186

def dynamic_fieldset_form_renderer(fsa)
  return dynamic_fieldset_renderer(fsa, "form") << javascript_renderer(fsa)
end

#dynamic_fieldset_renderer(fsa, form_type) ⇒ String

Builds HTML for a specific dynamic fieldset in a form.

Parameters:

  • The (FieldsetAssociator) —

    fieldset associator for the dynamic fieldset to render

Returns:

  • (String) —

    The HTML for the entire dynamic fieldset



193
194
195
196
197
198
199
200
201
202
203
 
# File 'app/helpers/dynamic_fieldsets_helper.rb', line 193

def dynamic_fieldset_renderer(fsa, form_type)
  rendered_dynamic_fieldset = "<div id='fsa-#{fsa.id}'>\n"
  rendered_dynamic_fieldset += "<input type='hidden' name='fsa-#{fsa.id}[fieldset_id]' value='#{fsa.fieldset_id}' />\n"
  rendered_dynamic_fieldset += "<input type='hidden' name='fsa-#{fsa.id}[fieldset_model_name]' value='#{fsa.fieldset_model_name}' />\n"
  fieldset_renderer( fsa, fsa.fieldset, fsa.field_values, form_type ).each do |line|
    rendered_dynamic_fieldset += line + "\n"
  end
  rendered_dynamic_fieldset += "</div>"

  return rendered_dynamic_fieldset.html_safe
end

#dynamic_fieldset_show_renderer(fsa) ⇒ String

Build HTML for a specific dynamic fieldset on a show page

Parameters:

  • The (FieldsetAssociator) —

    fieldset associator for the dynamic fieldset to render

Returns:

  • (String) —

    The HTML for the entire dynamic fieldset



179
180
181
 
# File 'app/helpers/dynamic_fieldsets_helper.rb', line 179

def dynamic_fieldset_show_renderer(fsa)
  return dynamic_fieldset_renderer(fsa, "show")
end

#field_form_renderer(fsa, fieldset_child, values = []) ⇒ Array

Builds HTML for the provided field for a form.

Parameters:

  • fsa (FieldsetAssociator) —

    parent FieldsetAssociator

  • fieldset_child (FieldsetChild) —

    The FieldsetChild to render

  • values (Array) (defaults to: []) —

    Saved values for the field

Returns:

  • (Array) —

    The HTML elements for the field



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
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
 
# File 'app/helpers/dynamic_fieldsets_helper.rb', line 58

def field_form_renderer(fsa, fieldset_child, values = [])
  field = fieldset_child.child
  classes  = "#{field.field_type} "
  classes += ( field.required ? 'required' : 'optional' )
  
  field_markup = ["<li class='#{classes}' id='input-field-#{field.id}-child-#{fieldset_child.id}'>"]
  
  if !field.field_type.eql?('instruction')
    field_markup.push "<label for='field-#{field.id}'>"
    field_markup.push "#{field.label}: "
    field_markup.push "<abbr title='required'>*</abbr>" if field.required?
    field_markup.push "</label>"
  end
  
  attrs = { :id => "field-#{field.id}-child-#{fieldset_child.id}" }
  field.field_html_attributes.each{ |a| attrs.merge! a.attribute_name.to_sym => a.value } if !field.field_html_attributes.empty?
  
  case field.field_type.to_sym
  when :select
    selected = populate(field,values).to_i # should return the ID of the saved or default option
    field_markup.push select_tag "fsa-#{fsa.id}[field-#{fieldset_child.id}]", options_from_collection_for_select( field.options, :id, :name, selected ), attrs
    
  when :multiple_select
    attrs.merge! multiple: true
    opts = populate( field, values )
    opts = [opts] if !opts.is_a? Array
    selected = opts.map( &:to_i ) if !opts.empty? # array of option IDs, saved > default
    field_markup.push select_tag "fsa-#{fsa.id}[field-#{fieldset_child.id}]", options_from_collection_for_select( field.options, :id, :name, selected ), attrs
    
  when :radio
    field_markup.push "<div id='field-#{field.id}-child-#{fieldset_child.id}'>"
    field.options.each do |option|
      attrs[:id] = "field-#{field.id}-#{option.name.parameterize}"
      these_attrs = attrs
      these_attrs = attrs.merge checked: true if populate(field,values).to_i.eql? option.id
      field_markup.push "<label for='#{these_attrs[:id]}'>"
      field_markup.push radio_button "fsa-#{fsa.id}", "field-#{fieldset_child.id}", option.id, these_attrs
      field_markup.push "#{option.name}"
      field_markup.push "</label>"
    end
    field_markup.push "</div>"
    
  when :checkbox
    field_markup.push "<div id='field-#{field.id}-child-#{fieldset_child.id}'>"
    attrs[:name] = "fsa-#{fsa.id}[field-#{fieldset_child.id}][]"
    opts = populate( field, values )
    checked = []
    checked = opts.map( &:to_i ) if !opts.empty? # array of option IDs, saved > default
    field.options.each do |option|
      attrs[:id] = "field-#{field.id}-#{option.name.underscore}"
      field_markup.push "<label for='#{attrs[:id]}'>"
      field_markup.push check_box_tag "#{attrs[:name]}", "#{option.id}", checked.include?(option.id), attrs
      field_markup.push "#{option.name}"
      field_markup.push "</label>"
    end
    field_markup.push "</div>"
    
  when :textfield
    attrs.merge!( {:value => populate( field, values )} )
    field_markup.push text_field "fsa-#{fsa.id}", "field-#{fieldset_child.id}", attrs
    
  when :textarea
    attrs.merge! cols: '40' if !attrs.include? :cols
    attrs.merge! rows: '6' if !attrs.include? :rows
    attrs.merge! name: "fsa-#{fsa.id}[field-#{fieldset_child.id}]"
    tag = "<textarea"
    attrs.each{ |att,val| tag += " #{att}=\"#{val}\"" }
    tag += ">"
    tag += populate( field, values )
    tag += "</textarea>"
    field_markup.push tag
    
  when :date
    date_options = { start_year: Time.now.year - 70 }
    setdate = populate( field, values ) # date string if saved or default
    date_options.merge! default: Time.parse( setdate ) if !setdate.empty?
    # attrs.reject!{ |k| k.eql? :id }
    field_markup.push date_select "fsa-#{fsa.id}", "field-#{fieldset_child.id}", date_options, attrs
    
  when :datetime
    date_options = { start_year: Time.now.year - 70 }
    setdate = populate( field, values ) # datetime string if saved or default
    date_options.merge! default: Time.parse( setdate ) if !setdate.empty?
    # attrs.reject!{ |k| k.eql? :id }
    field_markup.push datetime_select "fsa-#{fsa.id}", "field-#{fieldset_child.id}", date_options, attrs
    
  when :instruction
    field_markup.push "<p>#{field.label}</p>"
    
  end # case field.field_type
  
  field_markup.push "</li>"
  return field_markup
end

#field_renderer(fsa, fieldset_child, values = [], form_type) ⇒ Array

Builds HTML for the provided field.

Parameters:

  • fsa (FieldsetAssociator) —

    parent FieldsetAssociator

  • fieldset_child (FieldsetChild) —

    The FieldsetChild to render

  • values (Array) (defaults to: []) —

    Saved values for the field

Returns:

  • (Array) —

    The HTML elements for the field



9
10
11
12
13
14
15
 
# File 'app/helpers/dynamic_fieldsets_helper.rb', line 9

def field_renderer(fsa, fieldset_child, values = [], form_type)
  if form_type == "form"
    return field_form_renderer(fsa, fieldset_child, values)
  else
    return field_show_renderer(fsa, fieldset_child, values)
  end
end

#field_show_renderer(fsa, fieldset_child, values = []) ⇒ Array

Builds HTML for the provided field for a show page.

The code to get the names for fields using field options (select, multiple select, checkbox, and radio) is not optimized to minimize hitting the database

Parameters:

  • fsa (FieldsetAssociator) —

    parent FieldsetAssociator

  • fieldset_child (FieldsetChild) —

    The FieldsetChild to render

  • values (Array) (defaults to: []) —

    Saved values for the field

Returns:

  • (Array) —

    The HTML elements for the field



27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
 
# File 'app/helpers/dynamic_fieldsets_helper.rb', line 27

def field_show_renderer(fsa, fieldset_child, values = [])
  field = fieldset_child.child
  lines = []
  lines.push "<div class='dynamic_fieldsets_field'>"
  lines.push "<div class='dynamic_fieldsets_field_label'>#{field.label}</div>"
  lines.push "<div class='dynamic_fieldsets_field_value'>"
  if values
    if field.field_type == "multiple_select" || field.field_type == "checkbox"
      values.each do |value|
        lines.push field.options.select { |opt| opt.id = value }.first.name + "<br />"
      end
    elsif field.field_type == "select" || field.field_type == "radio"
      lines.push field.options.select { |opt| opt.id = values }.first.name
      # this might be easier on the db
      # lines.push DynamicFieldsets::FieldOption.find(values).name
    else
      lines.push values + "wow3"
    end
  else
    lines.push "No answer given"
  end
  lines.push "</div>"
  return lines
end

#fieldset_renderer(fsa, fieldset, values, form_type) ⇒ Array

Builds HTML for the provided fieldset and its children.

Parameters:

  • fsa (FieldsetAssociator) —

    parent FieldsetAssociator

  • fieldset (Fieldset) —

    The Fieldset to render

  • values (Hash) —

    Stored values for the fieldset

Returns:

  • (Array) —

    The HTML elements for the fieldset



158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'app/helpers/dynamic_fieldsets_helper.rb', line 158

def fieldset_renderer(fsa, fieldset, values, form_type)
  lines = ["<div id='fieldset-#{fieldset.id}' class='inputs'>"]
  lines.push "<h3 class='name'>#{fieldset.name}</h3>"
  lines.push "<ol>"
  fieldset.children.each do |child|
    if child.is_a? DynamicFieldsets::Field then
      fieldset_child = DynamicFieldsets::FieldsetChild.where( :child_id => child.id, :fieldset_id => fieldset.id, :child_type => child.class.name ).first
      lines += field_renderer( fsa, fieldset_child, values[fieldset_child.id], form_type )
    else # child.is_a? Fieldset
      lines += fieldset_renderer( fsa, child, values, form_type )
    end
  end
  lines.push "</ol>"
  lines.push "</div>"

  return lines
end

#javascript_renderer(fsa) ⇒ String

Method that returns the javascript in string format to be pushed on with the rest of the generated form

Returns:

  • (String) —

    The javascript variable that shows what fields have dependencies



229
230
231
232
233
234
235
236
237
 
# File 'app/helpers/dynamic_fieldsets_helper.rb', line 229

def javascript_renderer(fsa)
  unless fsa.id == nil
    rendered_javascript = "<script type='text/javascript'> var json_holder = #{fsa.dependency_child_hash.to_json}; </script>"
    rendered_javascript += render "dynamic_fieldsets/shared/javascript_watcher"
    return rendered_javascript.html_safe
  else
    return ""
  end
end

#populate(field, value) ⇒ Object

Gives precedence to saved values; returns default values if empty I know this is messy; this is what happens when we are past deadline.

Parameters:

  • field (Field) —

    Field to populate

  • value (String) —

    Possibly saved values

Returns:

  • The saved or default value(s)



210
211
212
213
214
215
216
217
218
219
220
221
222
 
# File 'app/helpers/dynamic_fieldsets_helper.rb', line 210

def populate(field, value)
  if value.nil? || (value.is_a?(Array) && value.empty?)
    if field.field_defaults.length == 0
      return ""
    elsif field.field_defaults.length > 1
      return field.field_defaults.collect{ |d| d[:value] }
    else
      return field.field_defaults.first.value
    end
  else
    return value
  end
end