Module: ActiveScaffold::Helpers::ListColumnHelpers

Included in:
ViewHelpers
Defined in:
lib/active_scaffold/helpers/list_column_helpers.rb,
lib/active_scaffold/bridges/paperclip/lib/list_ui.rb,
lib/active_scaffold/bridges/carrierwave/lib/list_ui.rb,
lib/active_scaffold/bridges/file_column/lib/list_ui.rb

Overview

Helpers that assist with the rendering of a List Column

Instance Method Summary collapse

Instance Method Details

setup the action link to inline form



58
59
60
61
62
63
64
65
66
 
# File 'lib/active_scaffold/helpers/list_column_helpers.rb', line 58

def action_link_to_inline_form(column, record, associated)
  link = column.link.clone
  if column.polymorphic_association?
    polymorphic_controller = controller_path_for_activerecord(record.send(column.association.name).class)
    return link if polymorphic_controller.nil?
    link.controller = polymorphic_controller
  end
  configure_column_link(link, associated, column.actions_for_association_links)
end

#active_scaffold_column_carrierwave(column, record) ⇒ Object 



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

def active_scaffold_column_carrierwave(column, record)
  carrierwave = record.send("#{column.name}")
  return nil unless !carrierwave.file.blank?
  thumbnail_style = ActiveScaffold::Bridges::Carrierwave::Lib::CarrierwaveBridgeHelpers.thumbnail_style
  content = if carrierwave.versions.keys.include?(thumbnail_style)
    image_tag(carrierwave.url(thumbnail_style), :border => 0).html_safe
  else
    record.send(record.send(:_mounter, column.name).send(:serialization_column))
  end
  link_to(content, carrierwave.url, :target => '_blank')
end

#active_scaffold_column_checkbox(column, record) ⇒ Object 



133
134
135
136
137
 
# File 'lib/active_scaffold/helpers/list_column_helpers.rb', line 133

def active_scaffold_column_checkbox(column, record)
  options = {:disabled => true, :id => nil, :object => record}
  options.delete(:disabled) if inplace_edit?(record, column)
  check_box(:record, column.name, options)
end

#active_scaffold_column_download_link(column, record, label = nil) ⇒ Object 



10
11
12
13
14
 
# File 'lib/active_scaffold/bridges/file_column/lib/list_ui.rb', line 10

def active_scaffold_column_download_link(column, record, label = nil)
  return nil if record.send(column.name).nil?
  label||=as_(:download)
  link_to( label, url_for_file_column(record, column.name.to_s), :popup => true)
end

#active_scaffold_column_download_link_with_filename(column, record) ⇒ Object 



5
6
7
8
 
# File 'lib/active_scaffold/bridges/file_column/lib/list_ui.rb', line 5

def active_scaffold_column_download_link_with_filename(column, record)
  return nil if record.send(column.name).nil?
  active_scaffold_column_download_link(column, record, File.basename(record.send(column.name)))
end

#active_scaffold_column_paperclip(column, record) ⇒ Object 



4
5
6
7
8
9
10
11
12
13
 
# File 'lib/active_scaffold/bridges/paperclip/lib/list_ui.rb', line 4

def active_scaffold_column_paperclip(column, record)
  paperclip = record.send("#{column.name}")
  return nil unless paperclip.file?
  content = if paperclip.styles.include?(ActiveScaffold::Bridges::Paperclip::Lib::PaperclipBridgeHelpers.thumbnail_style)
    image_tag(paperclip.url(ActiveScaffold::Bridges::Paperclip::Lib::PaperclipBridgeHelpers.thumbnail_style), :border => 0)
  else
    paperclip.original_filename
  end
  link_to(content, paperclip.url, {'data-popup' => true, :target => '_blank'})
end

#active_scaffold_column_select(column, record) ⇒ Object 



122
123
124
125
126
127
128
129
130
131
 
# File 'lib/active_scaffold/helpers/list_column_helpers.rb', line 122

def active_scaffold_column_select(column, record)
  if column.association
    format_column_value(record, column)
  else
    value = record.send(column.name)
    text, val = column.options[:options].find {|text, val| (val || text).to_s == value}
    value = active_scaffold_translated_option(column, text, val).first if text
    format_column_value(record, column, value)
  end
end

#active_scaffold_column_text(column, record) ⇒ Object

Overrides



118
119
120
 
# File 'lib/active_scaffold/helpers/list_column_helpers.rb', line 118

def active_scaffold_column_text(column, record)
  truncate(clean_column_value(record.send(column.name)), :length => column.options[:truncate] || 50)
end

#active_scaffold_column_thumbnail(column, record) ⇒ Object 



16
17
18
19
20
21
22
 
# File 'lib/active_scaffold/bridges/file_column/lib/list_ui.rb', line 16

def active_scaffold_column_thumbnail(column, record)
  return nil if record.send(column.name).nil?
  link_to( 
    image_tag(url_for_file_column(record, column.name.to_s, "thumb"), :border => 0), 
    url_for_file_column(record, column.name.to_s), 
    :popup => true)
end

#active_scaffold_inplace_edit(record, column, options = {}) ⇒ Object 



267
268
269
270
271
272
273
274
 
# File 'lib/active_scaffold/helpers/list_column_helpers.rb', line 267

def active_scaffold_inplace_edit(record, column, options = {})
  formatted_column = options[:formatted_column] || format_column_value(record, column)
  id_options = {:id => record.id.to_s, :action => 'update_column', :name => column.name.to_s}
  tag_options = {:id => element_cell_id(id_options), :class => "in_place_editor_field",
                 :title => as_(:click_to_edit), 'data-ie_id' => record.id.to_s}

  content_tag(:span, formatted_column, tag_options)
end

#cache_association(value, column) ⇒ Object 



231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/active_scaffold/helpers/list_column_helpers.rb', line 231

def cache_association(value, column)
  # we are not using eager loading, cache firsts records in order not to query the database in a future
  unless value.loaded?
    # load at least one record, is needed for column_empty? and checking permissions
    if column.associated_limit.nil?
      Rails.logger.warn "ActiveScaffold: Enable eager loading for #{column.name} association to reduce SQL queries"
    else
      value.target = value.find(:all, :limit => column.associated_limit + 1, :select => column.select_columns)
    end
  end
end

#clean_column_value(v) ⇒ Object

There are two basic ways to clean a column’s value: h() and sanitize(). The latter is useful when the column contains valid html data, and you want to just disable any scripting. People can always use field overrides to clean data one way or the other, but having this override lets people decide which way it should happen by default.

Why is it not a configuration option? Because it seems like a somewhat rare request. But it could eventually be an option in config.list (and config.show, I guess).



111
112
113
 
# File 'lib/active_scaffold/helpers/list_column_helpers.rb', line 111

def clean_column_value(v)
  h(v)
end

#column_heading_value(column, sorting, sort_direction) ⇒ Object 



329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
 
# File 'lib/active_scaffold/helpers/list_column_helpers.rb', line 329

def column_heading_value(column, sorting, sort_direction)
  if column.sortable?
    options = {:id => nil, :class => "as_sort",
               'data-page-history' => controller_id,
               :remote => true, :method => :get}
    url_options = params_for(:action => :index, :page => 1,
                     :sort => column.name, :sort_direction => sort_direction)
    link_to column.label, url_options, options
  else
    if column.name != :marked
      content_tag(:p, column.label)
    else
      mark_column_heading
    end
  end
end

#column_link_authorized?(link, column, record, associated) ⇒ Boolean

Returns:

  • (Boolean) 


87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/active_scaffold/helpers/list_column_helpers.rb', line 87

def column_link_authorized?(link, column, record, associated)
  if column.association
    associated_for_authorized = if associated.nil? || (associated.respond_to?(:empty?) && associated.empty?)
      column.association.klass
    elsif [:has_many, :has_and_belongs_to_many].include? column.association.macro
      associated.first
    else
      associated
    end
    authorized = associated_for_authorized.authorized_for?(:crud_type => link.crud_type)
    authorized = authorized and record.authorized_for?(:crud_type => :update, :column => column.name) if link.crud_type == :create
    authorized
  else
    record.authorized_for?(:crud_type => link.crud_type)
  end
end

#column_override(column) ⇒ Object 



139
140
141
 
# File 'lib/active_scaffold/helpers/list_column_helpers.rb', line 139

def column_override(column)
  "#{column.name.to_s.gsub('?', '')}_column" # parse out any question marks (see issue 227)
end

#column_override?(column) ⇒ Boolean

Returns:

  • (Boolean) 


143
144
145
 
# File 'lib/active_scaffold/helpers/list_column_helpers.rb', line 143

def column_override?(column)
  respond_to?(column_override(column))
end

#configure_column_link(link, associated, actions) ⇒ Object 



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/active_scaffold/helpers/list_column_helpers.rb', line 68

def configure_column_link(link, associated, actions)
  if column_empty?(associated) # if association is empty, we only can link to create form
    if actions.include?(:new)
      link.action = 'new'
      link.crud_type = :create
    end
  elsif actions.include?(:edit)
    link.action = 'edit'
    link.crud_type = :update
  elsif actions.include?(:show)
    link.action = 'show'
    link.crud_type = :read
  elsif actions.include?(:list)
    link.action = 'index'
    link.crud_type = :read
  end
  link
end

#format_association_value(value, column, size) ⇒ Object 



192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/active_scaffold/helpers/list_column_helpers.rb', line 192

def format_association_value(value, column, size)
  case column.association.macro
    when :has_one, :belongs_to
      if column.polymorphic_association?
        format_value("#{value.class.model_name.human}: #{value.to_label}")
      else
        format_value(value.to_label)
      end
    when :has_many, :has_and_belongs_to_many
      if column.associated_limit.nil?
        firsts = value.collect { |v| v.to_label }
      else
        firsts = value.first(column.associated_limit)
        firsts.collect! { |v| v.to_label }
        firsts[column.associated_limit] = '…' if value.size > column.associated_limit
      end
      if column.associated_limit == 0
        size if column.associated_number?
      else
        joined_associated = format_value(firsts.join(', '))
        joined_associated << " (#{size})" if column.associated_number? and column.associated_limit and value.size > column.associated_limit
        joined_associated
      end
  end
end

#format_column_value(record, column, value = nil) ⇒ Object

Formatting



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

def format_column_value(record, column, value = nil)
  value ||= record.send(column.name) unless record.nil?
  if value && column.association # cache association size before calling column_empty?
    associated_size = value.size if column.plural_association? and column.associated_number? # get count before cache association
    cache_association(value, column)
  end
  if column.association.nil? or column_empty?(value)
    if value.is_a? Numeric
      format_number_value(value, column.options)
    else
      format_value(value, column.options)
    end
  else
    format_association_value(value, column, associated_size)
  end
end

#format_inplace_edit_column(record, column) ⇒ Object 



259
260
261
262
263
264
265
 
# File 'lib/active_scaffold/helpers/list_column_helpers.rb', line 259

def format_inplace_edit_column(record,column)
  if column.list_ui == :checkbox
    active_scaffold_column_checkbox(column, record)
  else
    format_column_value(record, column)
  end
end

#format_number_value(value, options = {}) ⇒ Object 



176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/active_scaffold/helpers/list_column_helpers.rb', line 176

def format_number_value(value, options = {})
  value = case options[:format]
    when :size
      number_to_human_size(value, options[:i18n_options] || {})
    when :percentage
      number_to_percentage(value, options[:i18n_options] || {})
    when :currency
      number_to_currency(value, options[:i18n_options] || {})
    when :i18n_number
      send("number_with_#{value.is_a?(Integer) ? 'delimiter' : 'precision'}", value, options[:i18n_options] || {})
    else
      value
  end
  clean_column_value(value)
end

#format_value(column_value, options = {}) ⇒ Object 



218
219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/active_scaffold/helpers/list_column_helpers.rb', line 218

def format_value(column_value, options = {})
  value = if column_empty?(column_value)
    active_scaffold_config.list.empty_field_text
  elsif column_value.is_a?(Time) || column_value.is_a?(Date)
    l(column_value, :format => options[:format] || :default)
  elsif [FalseClass, TrueClass].include?(column_value.class)
    as_(column_value.to_s.to_sym)
  else
    column_value.to_s
  end
  clean_column_value(value)
end

#get_column_value(record, column) ⇒ Object 



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/helpers/list_column_helpers.rb', line 6

def get_column_value(record, column)
  begin
    # check for an override helper
    value = if column_override? column
      # we only pass the record as the argument. we previously also passed the formatted_value,
      # but mike perham pointed out that prohibited the usage of overrides to improve on the
      # performance of our default formatting. see issue #138.
      send(column_override(column), record)
    # second, check if the dev has specified a valid list_ui for this column
    elsif column.list_ui and override_column_ui?(column.list_ui)
      send(override_column_ui(column.list_ui), column, record)
    elsif column.column and override_column_ui?(column.column.type)
      send(override_column_ui(column.column.type), column, record)
    else
      format_column_value(record, column)
    end

    value = '&nbsp;'.html_safe if value.nil? or (value.respond_to?(:empty?) and value.empty?) # fix for IE 6
    return value
  rescue Exception => e
    logger.error Time.now.to_s + "#{e.inspect} -- on the ActiveScaffold column = :#{column.name} in #{controller.class}"
    raise e
  end
end

#inplace_edit?(record, column) ⇒ Boolean

Inline Edit =

Returns:

  • (Boolean) 


247
248
249
250
251
252
253
 
# File 'lib/active_scaffold/helpers/list_column_helpers.rb', line 247

def inplace_edit?(record, column)
  if column.inplace_edit
    editable = controller.send(:update_authorized?, record) if controller.respond_to?(:update_authorized?)
    editable = record.authorized_for?(:crud_type => :update, :column => column.name) if editable.nil? || editable == true
    editable
  end
end

#inplace_edit_cloning?(column) ⇒ Boolean

Returns:

  • (Boolean) 


255
256
257
 
# File 'lib/active_scaffold/helpers/list_column_helpers.rb', line 255

def inplace_edit_cloning?(column)
   column.inplace_edit != :ajax and (override_form_field?(column) or column.form_ui or (column.column and override_input?(column.column.type)))
end

#inplace_edit_control(column) ⇒ Object 



276
277
278
279
280
281
282
283
284
 
# File 'lib/active_scaffold/helpers/list_column_helpers.rb', line 276

def inplace_edit_control(column)
  if inplace_edit?(active_scaffold_config.model, column) and inplace_edit_cloning?(column)
    @record = new_model
    column = column.clone
    column.options = column.options.clone
    column.form_ui = :select if (column.association && column.form_ui.nil?)
    content_tag(:div, active_scaffold_input_for(column), {:style => "display:none;", :class => inplace_edit_control_css_class})
  end
end

#inplace_edit_control_css_class ⇒ Object 



286
287
288
 
# File 'lib/active_scaffold/helpers/list_column_helpers.rb', line 286

def inplace_edit_control_css_class
  "as_inplace_pattern"
end

#inplace_edit_tag_attributes(column) ⇒ Object 



290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
 
# File 'lib/active_scaffold/helpers/list_column_helpers.rb', line 290

def inplace_edit_tag_attributes(column)
  tag_options = {}
  tag_options['data-ie_url'] = url_for({:controller => params_for[:controller], :action => "update_column", :column => column.name, :id => '__id__'})
  tag_options['data-ie_cancel_text'] = column.options[:cancel_text] || as_(:cancel)
  tag_options['data-ie_loading_text'] = column.options[:loading_text] || as_(:loading)
  tag_options['data-ie_save_text'] = column.options[:save_text] || as_(:update)
  tag_options['data-ie_saving_text'] = column.options[:saving_text] || as_(:saving)
  tag_options['data-ie_rows'] = column.options[:rows] || 5 if column.column.try(:type) == :text
  tag_options['data-ie_cols'] = column.options[:cols] if column.options[:cols]
  tag_options['data-ie_size'] = column.options[:size] if column.options[:size]

  if column.list_ui == :checkbox
    tag_options['data-ie_mode'] = :inline_checkbox
  elsif inplace_edit_cloning?(column)
    tag_options['data-ie_mode'] = :clone
  elsif column.inplace_edit == :ajax
    url = url_for(:controller => params_for[:controller], :action => 'render_field', :id => '__id__', :column => column.name, :update_column => column.name, :in_place_editing => true, :escape => false)
    plural = column.plural_association? && !override_form_field?(column) && [:select, :record_select].include?(column.form_ui)
    tag_options['data-ie_render_url'] = url
    tag_options['data-ie_mode'] = :ajax
    tag_options['data-ie_plural'] = plural
  end
  tag_options
end

#mark_column_heading ⇒ Object 



315
316
317
318
319
320
 
# File 'lib/active_scaffold/helpers/list_column_helpers.rb', line 315

def mark_column_heading
  all_marked = (marked_records.length >= @page.pager.count)
  tag_options = {:id => "#{controller_id}_mark_heading", :class => "mark_heading in_place_editor_field"}
  tag_options['data-ie_url'] = url_for({:controller => params_for[:controller], :action => 'mark_all', :eid => params[:eid]})
  content_tag(:span, check_box_tag("#{controller_id}_mark_heading_span_input", !all_marked, all_marked), tag_options)
end

#override_column_ui(list_ui) ⇒ Object

the naming convention for overriding column types with helpers



152
153
154
 
# File 'lib/active_scaffold/helpers/list_column_helpers.rb', line 152

def override_column_ui(list_ui)
  "active_scaffold_column_#{list_ui}"
end

#override_column_ui?(list_ui) ⇒ Boolean

Returns:

  • (Boolean) 


147
148
149
 
# File 'lib/active_scaffold/helpers/list_column_helpers.rb', line 147

def override_column_ui?(list_ui)
  respond_to?(override_column_ui(list_ui))
end

#render_column_heading(column, sorting, sort_direction) ⇒ Object 



322
323
324
325
326
 
# File 'lib/active_scaffold/helpers/list_column_helpers.rb', line 322

def render_column_heading(column, sorting, sort_direction)
  tag_options = {:id => active_scaffold_column_header_id(column), :class => column_heading_class(column, sorting), :title => column.description}
  tag_options.merge!(inplace_edit_tag_attributes(column)) if column.inplace_edit
  content_tag(:th, column_heading_value(column, sorting, sort_direction) + inplace_edit_control(column), tag_options)
end

#render_list_column(text, column, record) ⇒ Object

TODO: move empty_field_text and &nbsp; logic in here? TODO: we need to distinguish between the automatic links we create and the ones that the dev specified. some logic may not apply if the dev specified the link.



33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/active_scaffold/helpers/list_column_helpers.rb', line 33

def render_list_column(text, column, record)
  if column.link
    link = column.link
    associated = record.send(column.association.name) if column.association
    url_options = params_for(:action => nil, :id => record.id, :link => text)

    # setup automatic link
    if column.autolink? && column.singular_association? # link to inline form
      link = action_link_to_inline_form(column, record, associated)
      return text if link.crud_type.nil?
      url_options[:link] = as_(:create_new) if link.crud_type == :create
    end

    if column_link_authorized?(link, column, record, associated)
      render_action_link(link, url_options, record)
    else
      "<a class='disabled'>#{text}</a>".html_safe
    end
  else
    text = active_scaffold_inplace_edit(record, column, {:formatted_column => text}) if inplace_edit?(record, column)
    text
  end
end

#render_nested_view(action_links, url_options, record) ⇒ Object 



346
347
348
349
350
351
352
353
354
355
356
 
# File 'lib/active_scaffold/helpers/list_column_helpers.rb', line 346

def render_nested_view(action_links, url_options, record)
  rendered = []
  action_links.member.each do |link|
    if link.nested_link? && link.column && @nested_auto_open[link.column.name] && @records.length <= @nested_auto_open[link.column.name] && controller.respond_to?(:render_component_into_view)
      link_url_options = {:adapter => '_list_inline_adapter', :format => :js}.merge(action_link_url_options(link, url_options, record, options = {:reuse_eid => true})) 
      link_id = get_action_link_id(link_url_options, record, link.column)
      rendered << (controller.send(:render_component_into_view, link_url_options) + javascript_tag("ActiveScaffold.ActionLink.get('#{link_id}').set_opened();"))
    end 
  end
  rendered.join(' ').html_safe
end