Module: ActiveScaffold::Helpers::IdHelpers

Included in:
ControllerHelpers, ViewHelpers
Defined in:
lib/active_scaffold/helpers/id_helpers.rb

Overview

A bunch of helper methods to produce the common view ids

Instance Method Summary collapse

Instance Method Details

#action_iframe_id(options) ⇒ Object


125
126
127
# File 'lib/active_scaffold/helpers/id_helpers.rb', line 125

def action_iframe_id(options)
  "#{controller_id}-#{options[:action]}-#{options[:id]}-iframe"
end

57
58
59
# File 'lib/active_scaffold/helpers/id_helpers.rb', line 57

def action_link_id(link_action, link_id)
  "#{controller_id}-#{link_action}-#{link_id}-link"
end

#active_scaffold_calculations_id(options = {}) ⇒ Object


41
42
43
# File 'lib/active_scaffold/helpers/id_helpers.rb', line 41

def active_scaffold_calculations_id(options = {})
  "#{options[:controller_id] || controller_id}-calculations#{'-' + options[:column].name.to_s if options[:column]}"
end

#active_scaffold_column_header_id(column) ⇒ Object


61
62
63
64
# File 'lib/active_scaffold/helpers/id_helpers.rb', line 61

def active_scaffold_column_header_id(column)
  name = column.respond_to?(:name) ? column.name : column.to_s
  clean_id "#{controller_id}-#{name}-column"
end

#active_scaffold_content_idObject


29
30
31
# File 'lib/active_scaffold/helpers/id_helpers.rb', line 29

def active_scaffold_content_id
  "#{controller_id}-content"
end

#active_scaffold_idObject


25
26
27
# File 'lib/active_scaffold/helpers/id_helpers.rb', line 25

def active_scaffold_id
  "#{controller_id}-active-scaffold"
end

#active_scaffold_messages_id(options = {}) ⇒ Object


37
38
39
# File 'lib/active_scaffold/helpers/id_helpers.rb', line 37

def active_scaffold_messages_id(options = {})
  "#{options[:controller_id] || controller_id}-messages"
end

#active_scaffold_tbody_idObject


33
34
35
# File 'lib/active_scaffold/helpers/id_helpers.rb', line 33

def active_scaffold_tbody_id
  "#{controller_id}-tbody"
end

#association_subform_id(column) ⇒ Object


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

def association_subform_id(column)
  klass = column.association.klass.to_s.underscore
  clean_id "#{controller_id}-associated-#{klass}"
end

#before_header_idObject


49
50
51
# File 'lib/active_scaffold/helpers/id_helpers.rb', line 49

def before_header_id
  "#{controller_id}-search-container"
end

#controller_id(controller = (params[:eid] || nested_id || params[:parent_controller] || params[:controller])) ⇒ Object


9
10
11
# File 'lib/active_scaffold/helpers/id_helpers.rb', line 9

def controller_id(controller = (params[:eid] || nested_id || params[:parent_controller] || params[:controller]))
  'as_' + id_from_controller(controller)
end

#element_cell_id(options = {}) ⇒ Object


73
74
75
76
77
78
79
# File 'lib/active_scaffold/helpers/id_helpers.rb', line 73

def element_cell_id(options = {})
  options[:action] ||= params[:action]
  options[:id] ||= params[:id]
  options[:id] ||= nested_parent_id if nested?
  options[:name] ||= params[:name]
  clean_id "#{controller_id}-#{options[:action]}-#{options[:id]}-#{options[:name]}-cell"
end

#element_form_id(options = {}) ⇒ Object


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

def element_form_id(options = {})
  options[:action] ||= params[:action]
  options[:id] ||= params[:id]
  options[:id] ||= nested_parent_id if nested?
  clean_id "#{controller_id}-#{options[:action]}-#{options[:id]}-form"
end

#element_messages_id(options = {}) ⇒ Object


118
119
120
121
122
123
# File 'lib/active_scaffold/helpers/id_helpers.rb', line 118

def element_messages_id(options = {})
  options[:action] ||= params[:action]
  options[:id] ||= params[:id]
  options[:id] ||= nested_parent_id if nested?
  clean_id "#{controller_id}-#{options[:action]}-#{options[:id]}-messages"
end

#element_row_id(options = {}) ⇒ Object


66
67
68
69
70
71
# File 'lib/active_scaffold/helpers/id_helpers.rb', line 66

def element_row_id(options = {})
  options[:action] ||= params[:action]
  options[:id] ||= params[:id]
  options[:id] ||= nested_parent_id if nested?
  clean_id "#{options[:controller_id] || controller_id}-#{options[:action]}-#{options[:id]}-row"
end

#empty_message_idObject


45
46
47
# File 'lib/active_scaffold/helpers/id_helpers.rb', line 45

def empty_message_id
  "#{controller_id}-empty-message"
end

#id_from_controller(controller) ⇒ Object


5
6
7
# File 'lib/active_scaffold/helpers/id_helpers.rb', line 5

def id_from_controller(controller)
  ERB::Util.h controller.to_s.gsub('/', '__')
end

#loading_indicator_id(options = {}) ⇒ Object


93
94
95
96
97
98
# File 'lib/active_scaffold/helpers/id_helpers.rb', line 93

def loading_indicator_id(options = {})
  options[:action] ||= params[:action]
  options[:id] ||= params[:id]
  options[:id] ||= nested_parent_id if nested?
  clean_id "#{controller_id}-#{options[:action]}-#{options[:id]}-loading-indicator"
end

#nested?Boolean

Returns:

  • (Boolean)

13
14
15
# File 'lib/active_scaffold/helpers/id_helpers.rb', line 13

def nested?
  false # will be overrided in AS controllers with helper_method
end

#nested_id(controller = nil) ⇒ Object


21
22
23
# File 'lib/active_scaffold/helpers/id_helpers.rb', line 21

def nested_id(controller = nil)
  "#{nested.parent_scaffold.controller_path}-#{nested_parent_id}-#{controller || params[:parent_controller] || params[:controller]}" if nested?
end

#nested_parent_idObject


17
18
19
# File 'lib/active_scaffold/helpers/id_helpers.rb', line 17

def nested_parent_id
  nested_parent_record.id
end

#scope_id(scope) ⇒ Object


129
130
131
# File 'lib/active_scaffold/helpers/id_helpers.rb', line 129

def scope_id(scope)
  scope.gsub(/(\[|\])/, '_').gsub('__', '_').gsub(/_$/, '')
end

#search_input_idObject


53
54
55
# File 'lib/active_scaffold/helpers/id_helpers.rb', line 53

def search_input_id
  "#{controller_id}-search-input"
end

#sub_form_id(options = {}) ⇒ Object


106
107
108
109
110
# File 'lib/active_scaffold/helpers/id_helpers.rb', line 106

def sub_form_id(options = {})
  options[:id] ||= params[:id]
  options[:id] ||= nested_parent_id if nested?
  clean_id "#{controller_id}-#{options[:id]}-#{options[:association]}-subform"
end

#sub_form_list_id(options = {}) ⇒ Object


112
113
114
115
116
# File 'lib/active_scaffold/helpers/id_helpers.rb', line 112

def sub_form_list_id(options = {})
  options[:id] ||= params[:id]
  options[:id] ||= nested_parent_id if nested?
  clean_id "#{controller_id}-#{options[:id]}-#{options[:association]}-subform-list"
end

#sub_section_id(options = {}) ⇒ Object


100
101
102
103
104
# File 'lib/active_scaffold/helpers/id_helpers.rb', line 100

def sub_section_id(options = {})
  options[:id] ||= params[:id]
  options[:id] ||= nested_parent_id if nested?
  clean_id "#{controller_id}-#{options[:id]}-#{options[:sub_section]}-subsection"
end