Class: ActionView::Helpers::InstanceTag

Inherits:
Object
  • Object
show all
Includes:
DateHelper, FormOptionsHelper, TagHelper
Defined in:
lib/action_view/helpers/date_helper.rb,
lib/action_view/helpers/form_helper.rb,
lib/action_view/helpers/form_options_helper.rb,
lib/action_view/helpers/active_record_helper.rb

Overview

:nodoc:

Constant Summary collapse

DEFAULT_FIELD_OPTIONS = 
{ "size" => 30 }.freeze
DEFAULT_RADIO_OPTIONS = 
{ }.freeze
DEFAULT_TEXT_AREA_OPTIONS = 
{ "cols" => 40, "rows" => 20 }.freeze
DEFAULT_DATE_OPTIONS = 
{ :discard_type => true }.freeze

Constants included from FormOptionsHelper

FormOptionsHelper::COUNTRIES

Constants included from ERB::Util

ERB::Util::HTML_ESCAPE

Constants included from TagHelper

TagHelper::BOOLEAN_ATTRIBUTES

Constants included from DateHelper

DateHelper::DEFAULT_PREFIX

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from FormOptionsHelper

#collection_select, #country_options_for_select, #country_select, #option_groups_from_collection_for_select, #options_for_select, #options_from_collection_for_select, #select, #time_zone_options_for_select, #time_zone_select

Methods included from ERB::Util

#html_escape

Methods included from TagHelper

#cdata_section, #escape_once

Methods included from DateHelper

#date_select, #datetime_select, #distance_of_time_in_words, #select_date, #select_datetime, #select_day, #select_hour, #select_minute, #select_month, #select_second, #select_time, #select_year, #time_ago_in_words, #time_select

Constructor Details

#initialize(object_name, method_name, template_object, local_binding = nil, object = nil) ⇒ InstanceTag

Returns a new instance of InstanceTag.



437
438
439
440
441
442
443
444
445
446
447
448
 
# File 'lib/action_view/helpers/form_helper.rb', line 437

def initialize(object_name, method_name, template_object, local_binding = nil, object = nil)
  @object_name, @method_name = object_name.to_s.dup, method_name.to_s.dup
  @template_object, @local_binding = template_object, local_binding
  @object = object
  if @object_name.sub!(/\[\]$/,"")
    if object ||= @template_object.instance_variable_get("@#{Regexp.last_match.pre_match}") and object.respond_to?(:to_param)
      @auto_index = object.to_param
    else
      raise ArgumentError, "object[] naming but object param and @object var don't exist or don't respond to to_param: #{object.inspect}"
    end
  end
end

Instance Attribute Details

#method_name ⇒ Object (readonly)

Returns the value of attribute method_name.



430
431
432
 
# File 'lib/action_view/helpers/form_helper.rb', line 430

def method_name
  @method_name
end

#object_name ⇒ Object (readonly)

Returns the value of attribute object_name.



430
431
432
 
# File 'lib/action_view/helpers/form_helper.rb', line 430

def object_name
  @object_name
end

Class Method Details

.check_box_checked?(value, checked_value) ⇒ Boolean

Returns:

  • (Boolean) 


567
568
569
570
571
572
573
574
575
576
577
578
579
580
 
# File 'lib/action_view/helpers/form_helper.rb', line 567

def check_box_checked?(value, checked_value)
  case value
  when TrueClass, FalseClass
    value
  when NilClass
    false
  when Integer
    value != 0
  when String
    value == checked_value
  else
    value.to_i != 0
  end
end

.radio_button_checked?(value, checked_value) ⇒ Boolean

Returns:

  • (Boolean) 


582
583
584
 
# File 'lib/action_view/helpers/form_helper.rb', line 582

def radio_button_checked?(value, checked_value)
  value.to_s == checked_value.to_s
end

.value(object, method_name) ⇒ Object 



555
556
557
 
# File 'lib/action_view/helpers/form_helper.rb', line 555

def value(object, method_name)
  object.send method_name unless object.nil?
end

.value_before_type_cast(object, method_name) ⇒ Object 



559
560
561
562
563
564
565
 
# File 'lib/action_view/helpers/form_helper.rb', line 559

def value_before_type_cast(object, method_name)
  unless object.nil?
    object.respond_to?(method_name + "_before_type_cast") ?
    object.send(method_name + "_before_type_cast") :
    object.send(method_name)
  end
end

Instance Method Details

#column_type ⇒ Object 



250
251
252
 
# File 'lib/action_view/helpers/active_record_helper.rb', line 250

def column_type
  object.send("column_for_attribute", @method_name).type
end

#content_tag(name, value, options) ⇒ Object 



207
208
209
210
211
212
213
 
# File 'lib/action_view/helpers/active_record_helper.rb', line 207

def content_tag(name, value, options)
  if object.respond_to?("errors") && object.errors.respond_to?("on")
    error_wrapping(content_tag_without_error_wrapping(name, value, options), object.errors.on(@method_name))
  else
    content_tag_without_error_wrapping(name, value, options)
  end
end

#content_tag_without_error_wrapping ⇒ Object 



206
 
# File 'lib/action_view/helpers/active_record_helper.rb', line 206

alias_method :content_tag_without_error_wrapping, :content_tag

#error_message ⇒ Object 



246
247
248
 
# File 'lib/action_view/helpers/active_record_helper.rb', line 246

def error_message
  object.errors.on(@method_name)
end

#error_wrapping(html_tag, has_error) ⇒ Object 



242
243
244
 
# File 'lib/action_view/helpers/active_record_helper.rb', line 242

def error_wrapping(html_tag, has_error)
  has_error ? Base.field_error_proc.call(html_tag, self) : html_tag
end

#object ⇒ Object 



542
543
544
 
# File 'lib/action_view/helpers/form_helper.rb', line 542

def object
  @object || (@template_object.instance_variable_get("@#{@object_name}") rescue nil)
end

#tag(name, options) ⇒ Object 



198
199
200
201
202
203
204
 
# File 'lib/action_view/helpers/active_record_helper.rb', line 198

def tag(name, options)
  if object.respond_to?("errors") && object.errors.respond_to?("on")
    error_wrapping(tag_without_error_wrapping(name, options), object.errors.on(@method_name))
  else
    tag_without_error_wrapping(name, options)
  end
end

#tag_without_error_wrapping ⇒ Object 



197
 
# File 'lib/action_view/helpers/active_record_helper.rb', line 197

alias_method :tag_without_error_wrapping, :tag

#to_boolean_select_tag(options = {}) ⇒ Object 



525
526
527
528
529
530
531
532
533
534
535
536
 
# File 'lib/action_view/helpers/form_helper.rb', line 525

def to_boolean_select_tag(options = {})
  options = options.stringify_keys
  add_default_name_and_id(options)
  value = value(object)
  tag_text = "<select"
  tag_text << tag_options(options)
  tag_text << "><option value=\"false\""
  tag_text << " selected" if value == false
  tag_text << ">False</option><option value=\"true\""
  tag_text << " selected" if value
  tag_text << ">True</option></select>"
end

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



501
502
503
504
505
506
507
508
509
510
511
512
513
514
 
# File 'lib/action_view/helpers/form_helper.rb', line 501

def to_check_box_tag(options = {}, checked_value = "1", unchecked_value = "0")
  options = options.stringify_keys
  options["type"]     = "checkbox"
  options["value"]    = checked_value
  if options.has_key?("checked")
    cv = options.delete "checked"
    checked = cv == true || cv == "checked"
  else
    checked = self.class.check_box_checked?(value(object), checked_value)
  end
  options["checked"] = "checked" if checked
  add_default_name_and_id(options)
  tag("input", options) << tag("input", "name" => options["name"], "type" => "hidden", "value" => options['disabled'] && checked ? checked_value : unchecked_value)
end

#to_collection_select_tag(collection, value_method, text_method, options, html_options) ⇒ Object 



372
373
374
375
376
377
378
379
 
# File 'lib/action_view/helpers/form_options_helper.rb', line 372

def to_collection_select_tag(collection, value_method, text_method, options, html_options)
  html_options = html_options.stringify_keys
  add_default_name_and_id(html_options)
  value = value(object)
  content_tag(
    "select", add_options(options_from_collection_for_select(collection, value_method, text_method, value), options, value), html_options
  )
end

#to_content_tag(tag_name, options = {}) ⇒ Object 



538
539
540
 
# File 'lib/action_view/helpers/form_helper.rb', line 538

def to_content_tag(tag_name, options = {})
  content_tag(tag_name, value(object), options)
end

#to_country_select_tag(priority_countries, options, html_options) ⇒ Object 



381
382
383
384
385
386
387
388
389
390
391
 
# File 'lib/action_view/helpers/form_options_helper.rb', line 381

def to_country_select_tag(priority_countries, options, html_options)
  html_options = html_options.stringify_keys
  add_default_name_and_id(html_options)
  value = value(object)
  content_tag("select",
    add_options(
      country_options_for_select(value, priority_countries),
      options, value
    ), html_options
  )
end

#to_date_select_tag(options = {}) ⇒ Object 



580
581
582
 
# File 'lib/action_view/helpers/date_helper.rb', line 580

def to_date_select_tag(options = {})
  date_or_time_select(options.merge(:discard_hour => true))
end

#to_date_select_tag_without_error_wrapping ⇒ Object 



215
216
217
 
# File 'lib/action_view/helpers/active_record_helper.rb', line 215

def to_date_select_tag(options = {})
  date_or_time_select(options.merge(:discard_hour => true))
end

#to_date_tag ⇒ Object 



516
517
518
519
520
521
522
523
 
# File 'lib/action_view/helpers/form_helper.rb', line 516

def to_date_tag()
  defaults = DEFAULT_DATE_OPTIONS.dup
  date     = value(object) || Date.today
  options  = Proc.new { |position| defaults.merge(:prefix => "#{@object_name}[#{@method_name}(#{position}i)]") }
  html_day_select(date, options.call(3)) +
  html_month_select(date, options.call(2)) +
  html_year_select(date, options.call(1))
end

#to_datetime_select_tag(options = {}) ⇒ Object 



588
589
590
 
# File 'lib/action_view/helpers/date_helper.rb', line 588

def to_datetime_select_tag(options = {})
  date_or_time_select options
end

#to_datetime_select_tag_without_error_wrapping ⇒ Object 



224
225
226
 
# File 'lib/action_view/helpers/active_record_helper.rb', line 224

def to_datetime_select_tag(options = {})
  date_or_time_select options
end

#to_input_field_tag(field_type, options = {}) ⇒ Object 



458
459
460
461
462
463
464
465
466
467
468
469
 
# File 'lib/action_view/helpers/form_helper.rb', line 458

def to_input_field_tag(field_type, options = {})
  options = options.stringify_keys
  options["size"] = options["maxlength"] || DEFAULT_FIELD_OPTIONS["size"] unless options.key?("size")
  options = DEFAULT_FIELD_OPTIONS.merge(options)
  if field_type == "hidden"
    options.delete("size")
  end
  options["type"] = field_type
  options["value"] ||= value_before_type_cast(object) unless field_type == "file"
  add_default_name_and_id(options)
  tag("input", options)
end

#to_label_tag(text = nil, options = {}) ⇒ Object 



450
451
452
453
454
455
456
 
# File 'lib/action_view/helpers/form_helper.rb', line 450

def to_label_tag(text = nil, options = {})
  name_and_id = options.dup
  add_default_name_and_id(name_and_id)
  options["for"] = name_and_id["id"]
  content = (text.blank? ? nil : text.to_s) || method_name.humanize
  content_tag("label", content, options)
end

#to_radio_button_tag(tag_value, options = {}) ⇒ Object 



471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
 
# File 'lib/action_view/helpers/form_helper.rb', line 471

def to_radio_button_tag(tag_value, options = {})
  options = DEFAULT_RADIO_OPTIONS.merge(options.stringify_keys)
  options["type"]     = "radio"
  options["value"]    = tag_value
  if options.has_key?("checked")
    cv = options.delete "checked"
    checked = cv == true || cv == "checked"
  else
    checked = self.class.radio_button_checked?(value(object), tag_value)
  end
  options["checked"]  = "checked" if checked
  pretty_tag_value    = tag_value.to_s.gsub(/\s/, "_").gsub(/\W/, "").downcase
  options["id"]     ||= defined?(@auto_index) ?
    "#{@object_name}_#{@auto_index}_#{@method_name}_#{pretty_tag_value}" :
    "#{@object_name}_#{@method_name}_#{pretty_tag_value}"
  add_default_name_and_id(options)
  tag("input", options)
end

#to_select_tag(choices, options, html_options) ⇒ Object 



364
365
366
367
368
369
370
 
# File 'lib/action_view/helpers/form_options_helper.rb', line 364

def to_select_tag(choices, options, html_options)
  html_options = html_options.stringify_keys
  add_default_name_and_id(html_options)
  value = value(object)
  selected_value = options.has_key?(:selected) ? options[:selected] : value
  content_tag("select", add_options(options_for_select(choices, selected_value), options, selected_value), html_options)
end

#to_tag(options = {}) ⇒ Object 



177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/action_view/helpers/active_record_helper.rb', line 177

def to_tag(options = {})
  case column_type
    when :string
      field_type = @method_name.include?("password") ? "password" : "text"
      to_input_field_tag(field_type, options)
    when :text
      to_text_area_tag(options)
    when :integer, :float, :decimal
      to_input_field_tag("text", options)
    when :date
      to_date_select_tag(options)
    when :datetime, :timestamp
      to_datetime_select_tag(options)
    when :time
      to_time_select_tag(options)
    when :boolean
      to_boolean_select_tag(options)
  end
end

#to_text_area_tag(options = {}) ⇒ Object 



490
491
492
493
494
495
496
497
498
499
 
# File 'lib/action_view/helpers/form_helper.rb', line 490

def to_text_area_tag(options = {})
  options = DEFAULT_TEXT_AREA_OPTIONS.merge(options.stringify_keys)
  add_default_name_and_id(options)

  if size = options.delete("size")
    options["cols"], options["rows"] = size.split("x") if size.respond_to?(:split)
  end

  content_tag("textarea", html_escape(options.delete('value') || value_before_type_cast(object)), options)
end

#to_time_select_tag(options = {}) ⇒ Object 



584
585
586
 
# File 'lib/action_view/helpers/date_helper.rb', line 584

def to_time_select_tag(options = {})
  date_or_time_select options.merge(:discard_year => true, :discard_month => true)
end

#to_time_select_tag_without_error_wrapping ⇒ Object 



233
234
235
 
# File 'lib/action_view/helpers/active_record_helper.rb', line 233

def to_time_select_tag(options = {})
  date_or_time_select options.merge(:discard_year => true, :discard_month => true)
end

#to_time_zone_select_tag(priority_zones, options, html_options) ⇒ Object 



393
394
395
396
397
398
399
400
401
402
403
 
# File 'lib/action_view/helpers/form_options_helper.rb', line 393

def to_time_zone_select_tag(priority_zones, options, html_options)
  html_options = html_options.stringify_keys
  add_default_name_and_id(html_options)
  value = value(object)
  content_tag("select",
    add_options(
      time_zone_options_for_select(value || options[:default], priority_zones, options[:model] || TimeZone),
      options, value
    ), html_options
  )
end

#value(object) ⇒ Object 



546
547
548
 
# File 'lib/action_view/helpers/form_helper.rb', line 546

def value(object)
  self.class.value(object, @method_name)
end

#value_before_type_cast(object) ⇒ Object 



550
551
552
 
# File 'lib/action_view/helpers/form_helper.rb', line 550

def value_before_type_cast(object)
  self.class.value_before_type_cast(object, @method_name)
end