Class: Padrino::Helpers::FormBuilder::AbstractFormBuilder

Inherits:
Object
  • Object
show all
Defined in:
lib/padrino-helpers/form_builder/abstract_form_builder.rb

Overview

Base class for Padrino Form Builder

Direct Known Subclasses

StandardFormBuilder

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(template, object, options = {}) ⇒ AbstractFormBuilder

Returns a new instance of AbstractFormBuilder.



9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
 
# File 'lib/padrino-helpers/form_builder/abstract_form_builder.rb', line 9

def initialize(template, object, options={})
  @template = template
  fail "FormBuilder template must be initialized" unless template
  @object = object.kind_of?(Symbol) ? build_object(object) : object
  fail "FormBuilder object must be present. If there's no object, use a symbol instead (i.e. :user)" unless object
  @options = options
  @namespace = options[:namespace]
  @model_name = options[:as] || Inflections.underscore(@object.class).tr('/', '_')
  nested = options[:nested]
  if @is_nested = nested && (nested_parent = nested[:parent]) && nested_parent.respond_to?(:object)
    @parent_form = nested_parent
    @nested_index = nested[:index]
    @attributes_name = "#{nested[:association]}_attributes"
  end
end

Instance Attribute Details

#attributes_name ⇒ Object (readonly)

Returns the value of attribute attributes_name.



7
8
9
 
# File 'lib/padrino-helpers/form_builder/abstract_form_builder.rb', line 7

def attributes_name
  @attributes_name
end

#is_nested ⇒ Object (readonly)

Returns the value of attribute is_nested.



7
8
9
 
# File 'lib/padrino-helpers/form_builder/abstract_form_builder.rb', line 7

def is_nested
  @is_nested
end

#model_name ⇒ Object (readonly)

Returns the value of attribute model_name.



7
8
9
 
# File 'lib/padrino-helpers/form_builder/abstract_form_builder.rb', line 7

def model_name
  @model_name
end

#multipart ⇒ Object

Returns the value of attribute multipart.



6
7
8
 
# File 'lib/padrino-helpers/form_builder/abstract_form_builder.rb', line 6

def multipart
  @multipart
end

#namespace ⇒ Object (readonly)

Returns the value of attribute namespace.



7
8
9
 
# File 'lib/padrino-helpers/form_builder/abstract_form_builder.rb', line 7

def namespace
  @namespace
end

#nested_index ⇒ Object (readonly)

Returns the value of attribute nested_index.



7
8
9
 
# File 'lib/padrino-helpers/form_builder/abstract_form_builder.rb', line 7

def nested_index
  @nested_index
end

#object ⇒ Object

Returns the value of attribute object.



6
7
8
 
# File 'lib/padrino-helpers/form_builder/abstract_form_builder.rb', line 6

def object
  @object
end

#parent_form ⇒ Object (readonly)

Returns the value of attribute parent_form.



7
8
9
 
# File 'lib/padrino-helpers/form_builder/abstract_form_builder.rb', line 7

def parent_form
  @parent_form
end

#template ⇒ Object

Returns the value of attribute template.



6
7
8
 
# File 'lib/padrino-helpers/form_builder/abstract_form_builder.rb', line 6

def template
  @template
end

Class Method Details

.field_types ⇒ Object (protected)

Returns the known field types for a Formbuilder.



171
172
173
174
175
176
 
# File 'lib/padrino-helpers/form_builder/abstract_form_builder.rb', line 171

def self.field_types
  [:hidden_field, :text_field, :text_area, :password_field, :file_field, :radio_button, :check_box, :select,
    :number_field, :telephone_field, :email_field, :search_field, :url_field,
    :datetime_field, :datetime_local_field, :date_field, :month_field, :week_field, :time_field, :color_field,
  ]
end

Instance Method Details

#build_object(symbol) ⇒ Object (protected)

Returns a record from template instance or create a record of specified class.



234
235
236
 
# File 'lib/padrino-helpers/form_builder/abstract_form_builder.rb', line 234

def build_object(symbol)
  @template.instance_variable_get("@#{symbol}") || Inflections.constantize(Inflections.camelize(symbol)).new
end

#check_box(field, options = {}) ⇒ Object 



90
91
92
93
94
95
96
 
# File 'lib/padrino-helpers/form_builder/abstract_form_builder.rb', line 90

def check_box(field, options={})
  options = default_options(field, options, :value => '1')
  options[:checked] = true if is_checked?(field, options)
  name = field_name(field)
  html = @template.hidden_field_tag(name, :value => options.delete(:uncheck_value) || '0')
  html << @template.check_box_tag(name, options)
end

#check_box_group(field, options = {}) ⇒ Object 



78
79
80
81
82
 
# File 'lib/padrino-helpers/form_builder/abstract_form_builder.rb', line 78

def check_box_group(field, options={})
  labeled_group(field, options) do |attributes|
    @template.check_box_tag(field_name(field)+'[]', attributes)
  end
end

#color_field(field, options = {}) ⇒ Object 



142
143
144
 
# File 'lib/padrino-helpers/form_builder/abstract_form_builder.rb', line 142

def color_field(field, options={})
  @template.color_field_tag field_name(field), default_options(field, options)
end

#csrf_token_field ⇒ Object 



164
165
166
 
# File 'lib/padrino-helpers/form_builder/abstract_form_builder.rb', line 164

def csrf_token_field
  @template.csrf_token_field
end

#date_field(field, options = {}) ⇒ Object 



126
127
128
 
# File 'lib/padrino-helpers/form_builder/abstract_form_builder.rb', line 126

def date_field(field, options={})
  @template.date_field_tag field_name(field), default_options(field, options)
end

#datetime_field(field, options = {}) ⇒ Object 



118
119
120
 
# File 'lib/padrino-helpers/form_builder/abstract_form_builder.rb', line 118

def datetime_field(field, options={})
  @template.datetime_field_tag field_name(field), default_options(field, options)
end

#datetime_local_field(field, options = {}) ⇒ Object 



122
123
124
 
# File 'lib/padrino-helpers/form_builder/abstract_form_builder.rb', line 122

def datetime_local_field(field, options={})
  @template.datetime_local_field_tag field_name(field), default_options(field, options)
end

#email_field(field, options = {}) ⇒ Object 



54
55
56
 
# File 'lib/padrino-helpers/form_builder/abstract_form_builder.rb', line 54

def email_field(field, options={})
  @template.email_field_tag field_name(field), default_options(field, options)
end

#error_message_on(field, options = {}) ⇒ Object 



29
30
31
 
# File 'lib/padrino-helpers/form_builder/abstract_form_builder.rb', line 29

def error_message_on(field, options={})
  @template.error_message_on object, field, options
end

#error_messages(*params) ⇒ Object 



25
26
27
 
# File 'lib/padrino-helpers/form_builder/abstract_form_builder.rb', line 25

def error_messages(*params)
  @template.error_messages_for object, *params
end

#field_human_name(field) ⇒ Object (protected)

Returns the human name of the field. Look that use builtin I18n.



181
182
183
 
# File 'lib/padrino-helpers/form_builder/abstract_form_builder.rb', line 181

def field_human_name(field)
  I18n.translate("#{model_name}.attributes.#{field}", :count => 1, :default => Inflections.humanize(field), :scope => :models)
end

#field_id(field = nil, value = nil) ⇒ Object (protected)

Returns the id for the given field. field_id(:username) => “user_username” field_id(:gender, :male) => “user_gender_male” field_name(:number) => “user_telephone_attributes_number” field_name(:street) => “user_addresses_attributes_0_street”



209
210
211
212
213
214
215
 
# File 'lib/padrino-helpers/form_builder/abstract_form_builder.rb', line 209

def field_id(field=nil, value=nil)
  result = (namespace && !is_nested) ? "#{namespace}_" : ''
  result << field_id_fragment
  result << "_#{field}" if field
  result << "_#{value}" if value
  result
end

#field_name(field = nil) ⇒ Object (protected)

Returns the name for the given field. field_name(:username) => “user” field_name(:number) => “user[number]” field_name(:street) => “user[0]”



197
198
199
200
201
 
# File 'lib/padrino-helpers/form_builder/abstract_form_builder.rb', line 197

def field_name(field=nil)
  result = field_name_fragment
  result << "[#{field}]" if field
  result
end

#field_value(field) ⇒ Object (protected)

Returns the value for the object’s field.



227
228
229
 
# File 'lib/padrino-helpers/form_builder/abstract_form_builder.rb', line 227

def field_value(field)
  @object.respond_to?(field) ? @object.send(field) : ''
end

#fields_for(child_association, collection = nil, options = {}, &block) ⇒ Object

Supports nested fields for a child model within a form. f.fields_for :addresses f.fields_for :addresses, address f.fields_for :addresses, @addresses f.fields_for :addresses, address, index: i



152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/padrino-helpers/form_builder/abstract_form_builder.rb', line 152

def fields_for(child_association, collection=nil, options={}, &block)
  default_collection = self.object.send(child_association)
  collection ||= default_collection
  include_index = default_collection.respond_to?(:each)

  nested_options = { :parent => self, :association => child_association }
  Array(collection).each_with_index.inject(SafeBuffer.new) do |all,(child_instance,index)|
    nested_options[:index] = options[:index] || (include_index ? index : nil)
    all << @template.fields_for(child_instance,  { :nested => nested_options, :builder => self.class }, &block) << "\n"
  end
end

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



105
106
107
108
 
# File 'lib/padrino-helpers/form_builder/abstract_form_builder.rb', line 105

def file_field(field, options={})
  self.multipart = true
  @template.file_field_tag field_name(field), default_options(field, options).reject{ |key, _| key == :value }
end

#hidden_field(field, options = {}) ⇒ Object 



37
38
39
 
# File 'lib/padrino-helpers/form_builder/abstract_form_builder.rb', line 37

def hidden_field(field, options={})
  @template.hidden_field_tag field_name(field), default_options(field, options)
end

#image_submit(source, options = {}) ⇒ Object 



114
115
116
 
# File 'lib/padrino-helpers/form_builder/abstract_form_builder.rb', line 114

def image_submit(source, options={})
  @template.image_submit_tag source, options
end

#label(field, options = {}, &block) ⇒ Object 



33
34
35
 
# File 'lib/padrino-helpers/form_builder/abstract_form_builder.rb', line 33

def label(field, options={}, &block)
  @template.label_tag(field_id(field), { :caption => "#{field_human_name(field)}: " }.update(options), &block)
end

#labeled_group(field, options = {}) ⇒ Object (protected)

Builds a group of labels for radios or checkboxes.



241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/padrino-helpers/form_builder/abstract_form_builder.rb', line 241

def labeled_group(field, options={})
  options = { :id => field_id(field), :selected => field_value(field) }.update(options)
  options.update(error_class(field)){ |_,*values| values.compact.join(' ') }
  selected_values = resolve_checked_values(field, options)
  variants_for_group(options).inject(SafeBuffer.new) do |html, (caption,value)|
    variant_id = "#{options[:id]}_#{value}"
    attributes = { :value => value, :id => variant_id, :checked => selected_values.include?(value) }
    caption = yield(attributes) << ' ' << caption
    html << @template.label_tag("#{field_name(field)}[]", :for => variant_id, :caption => caption)
  end
end

#month_field(field, options = {}) ⇒ Object 



130
131
132
 
# File 'lib/padrino-helpers/form_builder/abstract_form_builder.rb', line 130

def month_field(field, options={})
  @template.month_field_tag field_name(field), default_options(field, options)
end

#nested_object_id ⇒ Object (protected)

Returns the child object if it exists.



220
221
222
 
# File 'lib/padrino-helpers/form_builder/abstract_form_builder.rb', line 220

def nested_object_id
  is_nested && object.respond_to?(:new_record?) && !object.new_record? && object.id
end

#number_field(field, options = {}) ⇒ Object 



45
46
47
 
# File 'lib/padrino-helpers/form_builder/abstract_form_builder.rb', line 45

def number_field(field, options={})
  @template.number_field_tag field_name(field), default_options(field, options)
end

#object_model_name(explicit_object = object) ⇒ Object (protected)

Returns the object’s models name.



188
189
190
 
# File 'lib/padrino-helpers/form_builder/abstract_form_builder.rb', line 188

def object_model_name(explicit_object=object)
  explicit_object.is_a?(Symbol) ? explicit_object : explicit_object.class.to_s.underscore.gsub(/\//, '_')
end

#password_field(field, options = {}) ⇒ Object 



70
71
72
 
# File 'lib/padrino-helpers/form_builder/abstract_form_builder.rb', line 70

def password_field(field, options={})
  @template.password_field_tag field_name(field), default_options(field, options)
end

#radio_button(field, options = {}) ⇒ Object 



98
99
100
101
102
103
 
# File 'lib/padrino-helpers/form_builder/abstract_form_builder.rb', line 98

def radio_button(field, options={})
  options = default_options(field, options)
  options[:checked] = true if is_checked?(field, options)
  options[:id] = field_id(field, options[:value])
  @template.radio_button_tag field_name(field), options
end

#radio_button_group(field, options = {}) ⇒ Object 



84
85
86
87
88
 
# File 'lib/padrino-helpers/form_builder/abstract_form_builder.rb', line 84

def radio_button_group(field, options={})
  labeled_group(field, options) do |attributes|
    @template.radio_button_tag(field_name(field), attributes)
  end
end

#search_field(field, options = {}) ⇒ Object 



58
59
60
 
# File 'lib/padrino-helpers/form_builder/abstract_form_builder.rb', line 58

def search_field(field, options={})
  @template.search_field_tag field_name(field), default_options(field, options)
end

#select(field, options = {}) ⇒ Object 



74
75
76
 
# File 'lib/padrino-helpers/form_builder/abstract_form_builder.rb', line 74

def select(field, options={})
  @template.select_tag field_name(field), default_options(field, options)
end

#submit(*args) ⇒ Object 



110
111
112
 
# File 'lib/padrino-helpers/form_builder/abstract_form_builder.rb', line 110

def submit(*args)
  @template.submit_tag(*args)
end

#telephone_field(field, options = {}) ⇒ Object Also known as: phone_field 



49
50
51
 
# File 'lib/padrino-helpers/form_builder/abstract_form_builder.rb', line 49

def telephone_field(field, options={})
  @template.telephone_field_tag field_name(field), default_options(field, options)
end

#text_area(field, options = {}) ⇒ Object 



66
67
68
 
# File 'lib/padrino-helpers/form_builder/abstract_form_builder.rb', line 66

def text_area(field, options={})
  @template.text_area_tag field_name(field), default_options(field, options)
end

#text_field(field, options = {}) ⇒ Object 



41
42
43
 
# File 'lib/padrino-helpers/form_builder/abstract_form_builder.rb', line 41

def text_field(field, options={})
  @template.text_field_tag field_name(field), default_options(field, options)
end

#time_field(field, options = {}) ⇒ Object 



138
139
140
 
# File 'lib/padrino-helpers/form_builder/abstract_form_builder.rb', line 138

def time_field(field, options={})
  @template.time_field_tag field_name(field), default_options(field, options)
end

#url_field(field, options = {}) ⇒ Object 



62
63
64
 
# File 'lib/padrino-helpers/form_builder/abstract_form_builder.rb', line 62

def url_field(field, options={})
  @template.url_field_tag field_name(field), default_options(field, options)
end

#week_field(field, options = {}) ⇒ Object 



134
135
136
 
# File 'lib/padrino-helpers/form_builder/abstract_form_builder.rb', line 134

def week_field(field, options={})
  @template.week_field_tag field_name(field), default_options(field, options)
end