Module: ActiveScaffold::Helpers::ListColumnHelpers

Included in:
ViewHelpers
Defined in:
lib/active_scaffold/bridges/file_column/list_ui.rb,
lib/active_scaffold/bridges/dragonfly/list_ui.rb,
lib/active_scaffold/bridges/paperclip/list_ui.rb,
lib/active_scaffold/bridges/carrierwave/list_ui.rb,
lib/active_scaffold/helpers/list_column_helpers.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



67
68
69
70
71
72
73
74
75
76
 
# File 'lib/active_scaffold/helpers/list_column_helpers.rb', line 67

def action_link_to_inline_form(column, record, associated, text)
  link = column.link.clone
  link.label = text
  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/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::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 



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

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/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/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_dragonfly(column, record) ⇒ Object 



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

def active_scaffold_column_dragonfly(column, record)
  attachment = record.send("#{column.name}")
  return nil unless attachment.present?
  content = if attachment.image?
    image_tag(attachment.thumb(column.options[:thumb] || ActiveScaffold::Bridges::Dragonfly::DragonflyBridgeHelpers.thumbnail_style).url, :border => 0)
  else
    attachment.name
  end
  link_to(content, attachment.remote_url, {'data-popup' => true, :target => '_blank'})
end

#active_scaffold_column_marked(column, record) ⇒ Object 



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

def active_scaffold_column_marked(column, record)
  options = {:id => nil, :object => record}
  content_tag(:span, check_box(:record, column.name, options), :class => 'in_place_editor_field', :data => {:ie_id => record.id.to_s})
end

#active_scaffold_column_paperclip(column, record) ⇒ Object 



4
5
6
7
8
9
10
11
12
13
 
# File 'lib/active_scaffold/bridges/paperclip/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::PaperclipBridgeHelpers.thumbnail_style)
    image_tag(paperclip.url(ActiveScaffold::Bridges::Paperclip::PaperclipBridgeHelpers.thumbnail_style), :border => 0)
  else
    paperclip.original_filename
  end
  link_to(content, paperclip.url, {'data-popup' => true, :target => '_blank'})
end

#active_scaffold_column_text(column, record) ⇒ Object

Overrides



130
131
132
 
# File 'lib/active_scaffold/helpers/list_column_helpers.rb', line 130

def active_scaffold_column_text(column, record)
  clean_column_value(truncate(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/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 



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

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, as_(:inplace_edit_handle), :class => 'handle') <<
  content_tag(:span, formatted_column, tag_options)
end

#all_marked? ⇒ Boolean

Returns:

  • (Boolean) 


317
318
319
320
321
322
323
 
# File 'lib/active_scaffold/helpers/list_column_helpers.rb', line 317

def all_marked?
  if active_scaffold_config.mark.mark_all_mode == :page
    all_marked = @page.items.detect { |record| !marked_records.include?(record.id) }.nil?
  else
    all_marked = (marked_records.length >= @page.pager.count)
  end
end

#cache_association(value, column, size) ⇒ Object 



236
237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'lib/active_scaffold/helpers/list_column_helpers.rb', line 236

def cache_association(value, column, size)
  # 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 to display '...'
    if column.associated_limit.nil?
      Rails.logger.warn "ActiveScaffold: Enable eager loading for #{column.name} association to reduce SQL queries"
    elsif column.associated_limit > 0
      value.target = value.find(:all, :limit => column.associated_limit + 1, :select => column.select_columns)
    elsif @cache_associations
      value.target = size.to_i.zero? ? [] : [nil]
    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).



123
124
125
 
# File 'lib/active_scaffold/helpers/list_column_helpers.rb', line 123

def clean_column_value(v)
  h(v)
end

#column_heading_value(column, sorting, sort_direction) ⇒ Object 



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

def column_heading_value(column, sorting, sort_direction)
  if column.name == :as_marked
    mark_column_heading
  elsif 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
    content_tag(:p, column.label)
  end
end

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

Returns:

  • (Boolean) 


98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/active_scaffold/helpers/list_column_helpers.rb', line 98

def column_link_authorized?(link, column, record, associated)
  if column.association
    associated_for_authorized = if associated.nil? || (column.plural_association? && !associated.loaded?) || (associated.respond_to?(:blank?) && associated.blank?)
      column.association.klass
    elsif [:has_many, :has_and_belongs_to_many].include? column.association.macro
      # may be cached with [] or [nil] to avoid some queries
      associated.first || column.association.klass
    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 Also known as: column_override? 



145
146
147
 
# File 'lib/active_scaffold/helpers/list_column_helpers.rb', line 145

def column_override(column)
  override_helper column, 'column'
end

#configure_column_link(link, associated, actions) ⇒ Object 



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/active_scaffold/helpers/list_column_helpers.rb', line 78

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
      link.label = as_(:create_new)
    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 if link.action.present?
end

#format_association_value(value, column, size) ⇒ Object 



197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/active_scaffold/helpers/list_column_helpers.rb', line 197

def format_association_value(value, column, size)
  format_value case column.association.macro
    when :has_one, :belongs_to
      if column.polymorphic_association?
        "#{value.class.model_name.human}: #{value.to_label}"
      else
        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 = firsts.join(active_scaffold_config.list.association_join_text)
        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



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

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, associated_size) if column.plural_association?
  end
  if column.association.nil? or column_empty?(value)
    if column.form_ui == :select && column.options[:options]
      text, val = column.options[:options].find {|text, val| (val.nil? ? text : val).to_s == value.to_s}
      value = active_scaffold_translated_option(column, text, val).first if text
    end
    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_number_value(value, options = {}) ⇒ Object 



181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/active_scaffold/helpers/list_column_helpers.rb', line 181

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
      number_with_delimiter(value, options[:i18n_options] || {})
    else
      value
  end
  clean_column_value(value)
end

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



223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'lib/active_scaffold/helpers/list_column_helpers.rb', line 223

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
30
31
32
33
34
 
# 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 (method = 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.
      if method(method).arity == 1
        ActiveSupport::Deprecation.warn("Add column argument to field override, signature is unified with list_ui")
        send(method, record)
      else
        send(method, record, column)
      end
    # second, check if the dev has specified a valid list_ui for this column
    elsif column.list_ui and (method = override_column_ui(column.list_ui))
      send(method, column, record)
    elsif column.column and (method = override_column_ui(column.column.type))
      send(method, 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) 


254
255
256
257
258
259
260
 
# File 'lib/active_scaffold/helpers/list_column_helpers.rb', line 254

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) 


262
263
264
 
# File 'lib/active_scaffold/helpers/list_column_helpers.rb', line 262

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
285
286
 
# 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)
    old_record, @record = @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).tap do
      @record = old_record
    end
  end
end

#inplace_edit_control_css_class ⇒ Object 



288
289
290
 
# File 'lib/active_scaffold/helpers/list_column_helpers.rb', line 288

def inplace_edit_control_css_class
  "as_inplace_pattern"
end

#inplace_edit_data(column) ⇒ Object 



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

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

  if column.list_ui == :checkbox
    data[:ie_mode] = :inline_checkbox
  elsif inplace_edit_cloning?(column)
    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)
    plural = column.plural_association? && !override_form_field?(column) && [:select, :record_select].include?(column.form_ui)
    data[:ie_render_url] = url
    data[:ie_mode] = :ajax
    data[:ie_plural] = plural
  end
  data
end

#mark_column_heading ⇒ Object 



325
326
327
328
329
330
331
 
# File 'lib/active_scaffold/helpers/list_column_helpers.rb', line 325

def mark_column_heading
  tag_options = {
    :id => "#{controller_id}_mark_heading",
    :class => "mark_heading in_place_editor_field",
  }
  content_tag(:span, check_box_tag("#{controller_id}_mark_heading_span_input", '1', all_marked?), tag_options)
end

#override_column_ui(list_ui) ⇒ Object Also known as: override_column_ui?

the naming convention for overriding column types with helpers



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

def override_column_ui(list_ui)
  method = "active_scaffold_column_#{list_ui}"
  method if respond_to? method
end

#render_column_heading(column, sorting, sort_direction) ⇒ Object 



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

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}
  if column.name == :as_marked
    tag_options[:data] = {
      :ie_mode => :inline_checkbox,
      :ie_url => url_for(params_for(:action => 'mark', :id => '__id__'))
    }
  else
    tag_options[:data] = inplace_edit_data(column) if column.inplace_edit
  end
  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.



38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/active_scaffold/helpers/list_column_helpers.rb', line 38

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)

    # setup automatic link
    if column.autolink? && column.singular_association? # link to inline form
      link = action_link_to_inline_form(column, record, associated, text)
      return text if link.nil?
    else
      url_options[:link] = text
    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
  elsif inplace_edit?(record, column)
    active_scaffold_inplace_edit(record, column, {:formatted_column => text})
  elsif active_scaffold_config.list.wrap_tag
    content_tag active_scaffold_config.list.wrap_tag, text
  else
    text
  end
end

#render_nested_view(action_links, url_options, record) ⇒ Object 



362
363
364
365
366
367
368
369
370
371
372
 
# File 'lib/active_scaffold/helpers/list_column_helpers.rb', line 362

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