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

#active_scaffold_column_carrierwave(record, column) ⇒ 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(record, column)
  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(record, column) ⇒ Object 



84
85
86
87
88
 
# File 'lib/active_scaffold/helpers/list_column_helpers.rb', line 84

def active_scaffold_column_checkbox(record, column)
  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(record, column, 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(record, column, 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(record, column) ⇒ 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(record, column)
  return nil if record.send(column.name).nil?
  active_scaffold_column_download_link(record, column, File.basename(record.send(column.name)))
end

#active_scaffold_column_dragonfly(record, column) ⇒ 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(record, column)
  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_fulltext(record, column) ⇒ Object 



75
76
77
 
# File 'lib/active_scaffold/helpers/list_column_helpers.rb', line 75

def active_scaffold_column_fulltext(record, column)
  clean_column_value(record.send(column.name))
end

#active_scaffold_column_marked(record, column) ⇒ Object 



79
80
81
82
 
# File 'lib/active_scaffold/helpers/list_column_helpers.rb', line 79

def active_scaffold_column_marked(record, column)
  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(record, column) ⇒ 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(record, column)
  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(record, column) ⇒ Object

Overrides



71
72
73
 
# File 'lib/active_scaffold/helpers/list_column_helpers.rb', line 71

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

#active_scaffold_column_thumbnail(record, column) ⇒ 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(record, column)
  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 



212
213
214
215
216
217
218
219
220
221
 
# File 'lib/active_scaffold/helpers/list_column_helpers.rb', line 212

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}}
  tag_options[:data][:ie_update] = column.inplace_edit if column.inplace_edit != true

  content_tag(:span, as_(:inplace_edit_handle), :class => 'handle') <<
  content_tag(:span, formatted_column, tag_options)
end

#all_marked? ⇒ Boolean

Returns:

  • (Boolean) 


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

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.to_i)
  end
end

#cache_association(value, column, size) ⇒ Object 



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

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_associated_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).



64
65
66
 
# File 'lib/active_scaffold/helpers/list_column_helpers.rb', line 64

def clean_column_value(v)
  h(v)
end

#column_heading_attributes(column, sorting, sort_direction) ⇒ Object 



282
283
284
 
# File 'lib/active_scaffold/helpers/list_column_helpers.rb', line 282

def column_heading_attributes(column, sorting, sort_direction)
  tag_options = {:id => active_scaffold_column_header_id(column), :class => column_heading_class(column, sorting), :title => strip_tags(column.description)}
end

#column_heading_label(column) ⇒ Object 



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

def column_heading_label(column)
  column.label
end

#column_heading_value(column, sorting, sort_direction) ⇒ Object 



300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'lib/active_scaffold/helpers/list_column_helpers.rb', line 300

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)
    unless active_scaffold_config.
      url_options.merge!(:search => search_params) if search_params.present?
    end
    link_to column_heading_label(column), url_options, options
  else
    content_tag(:p, column_heading_label(column))
  end
end

#column_override(column) ⇒ Object Also known as: column_override? 



90
91
92
 
# File 'lib/active_scaffold/helpers/list_column_helpers.rb', line 90

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

#format_association_value(value, column, size) ⇒ Object 



144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/active_scaffold/helpers/list_column_helpers.rb', line 144

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(h(active_scaffold_config.list.association_join_text)).html_safe
        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



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/active_scaffold/helpers/list_column_helpers.rb', line 107

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 



128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/active_scaffold/helpers/list_column_helpers.rb', line 128

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 



170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'lib/active_scaffold/helpers/list_column_helpers.rb', line 170

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



19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
 
# File 'lib/active_scaffold/helpers/list_column_helpers.rb', line 19

def get_column_method(record, column)
  # check for an override helper
  method = column.list_method
  unless method
    method = 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.
      method
    # 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))
      method
    elsif column.column and (method = override_column_ui(column.column.type))
      method
    else
      :format_column_value
    end
    column.list_method = method
  end
  method
end

#get_column_value(record, column) ⇒ Object 



6
7
8
9
10
11
12
13
14
15
16
 
# File 'lib/active_scaffold/helpers/list_column_helpers.rb', line 6

def get_column_value(record, column)
  begin
    method = get_column_method(record, column)
    value = send(method, record, column)
    value = '&nbsp;'.html_safe if value.nil? or value.blank? # 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) 


201
202
203
204
205
206
 
# File 'lib/active_scaffold/helpers/list_column_helpers.rb', line 201

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

#inplace_edit_cloning?(column) ⇒ Boolean

Returns:

  • (Boolean) 


208
209
210
 
# File 'lib/active_scaffold/helpers/list_column_helpers.rb', line 208

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 



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

def inplace_edit_control(column)
  if inplace_edit?(active_scaffold_config.model, column) and inplace_edit_cloning?(column)
    old_record, @record = @record, new_model # TODO remove when relying on @record is removed
    column = column.clone
    column.options = column.options.clone
    column.form_ui = :select if (column.association && column.form_ui.nil?)
    options = active_scaffold_input_options(column).merge(:object => new_model)
    options[:class] = "#{options[:class]} inplace_field"
    content_tag(:div, active_scaffold_input_for(column, nil, options), :style => "display:none;", :class => inplace_edit_control_css_class).tap do
      @record = old_record
    end
  end
end

#inplace_edit_control_css_class ⇒ Object 



237
238
239
 
# File 'lib/active_scaffold/helpers/list_column_helpers.rb', line 237

def inplace_edit_control_css_class
  "as_inplace_pattern"
end

#inplace_edit_data(column) ⇒ Object 



241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/active_scaffold/helpers/list_column_helpers.rb', line 241

def inplace_edit_data(column)
  data = {}
  data[:ie_url] = url_for(params_for(: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__', :update_column => column.name)
    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 



274
275
276
277
278
279
280
 
# File 'lib/active_scaffold/helpers/list_column_helpers.rb', line 274

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



96
97
98
99
100
101
 
# File 'lib/active_scaffold/helpers/list_column_helpers.rb', line 96

def override_column_ui(list_ui)
  @_column_ui_overrides ||= {}
  return @_column_ui_overrides[list_ui] if @_column_ui_overrides.include? list_ui
  method = "active_scaffold_column_#{list_ui}"
  @_column_ui_overrides[list_ui] = (method if respond_to? method)
end

#render_column_heading(column, sorting, sort_direction) ⇒ Object 



286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'lib/active_scaffold/helpers/list_column_helpers.rb', line 286

def render_column_heading(column, sorting, sort_direction)
  tag_options = column_heading_attributes(column, sorting, sort_direction)
  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.



43
44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/active_scaffold/helpers/list_column_helpers.rb', line 43

def render_list_column(text, column, record)
  if column.link && !skip_action_link?(column.link, record)
    link = column.link
    associated = record.send(column.association.name) if column.association
    render_action_link(link, record, :link => text, :authorized => link.action.nil? || column_link_authorized?(link, column, record, associated))
  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, record) ⇒ Object 



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

def render_nested_view(action_links, 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, true)
      link_url_options = {:adapter => '_list_inline_adapter', :format => :js}.merge(action_link_url_options(link, record))
      link_id = get_action_link_id(link, record)
      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