Module: ActiveScaffold::Helpers::ExportHelpers

Defined in:
lib/active_scaffold/helpers/export_helpers.rb

Overview

Helpers that assist with the rendering of a Export Column

Instance Method Summary collapse

Instance Method Details

#export_column_override(column) ⇒ Object 



30
31
32
 
# File 'lib/active_scaffold/helpers/export_helpers.rb', line 30

def export_column_override(column)
  override_helper column, 'export_column'
end

#format_export_column(raw_value, format) ⇒ Object 



34
35
36
37
 
# File 'lib/active_scaffold/helpers/export_helpers.rb', line 34

def format_export_column(raw_value, format)
  method = "format_value_for_#{format}"
  respond_to?(method) ? send(method, raw_value) : raw_value
end

#format_export_column_header_name(column) ⇒ Object

This helper can be overridden to change the way that the headers are formatted. For instance, you might want column.name.to_s.humanize



63
64
65
 
# File 'lib/active_scaffold/helpers/export_helpers.rb', line 63

def format_export_column_header_name(column)
  column.label
end

#format_plural_association_export_column(association_records) ⇒ Object 



55
56
57
58
59
 
# File 'lib/active_scaffold/helpers/export_helpers.rb', line 55

def format_plural_association_export_column(association_records)
  firsts = association_records.first(4).collect { |v| v.to_label }
  firsts[3] = ' ' if firsts.length == 4
  format_value(firsts.join(','))
end

#format_singular_association_export_column(association_record) ⇒ Object 



51
52
53
 
# File 'lib/active_scaffold/helpers/export_helpers.rb', line 51

def format_singular_association_export_column(association_record)
  format_value(association_record.to_label)
end

#format_value_for_csv(column_value) ⇒ Object 



39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/active_scaffold/helpers/export_helpers.rb', line 39

def format_value_for_csv(column_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 => :default)
  elsif [FalseClass, TrueClass].include?(column_value.class)
    as_(column_value.to_s.to_sym)
  else
    column_value.to_s
  end
end

#get_export_column_value(record, column, format) ⇒ Object

individual columns can be overridden by defining a helper method <column_name>_export_column(record) You can customize the output of all columns by overriding the following helper methods: format_export_column(raw_value) format_singular_association_export_column(association_record) format_plural_association_export_column(association_records)



12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
 
# File 'lib/active_scaffold/helpers/export_helpers.rb', line 12

def get_export_column_value(record, column, format)
  if (method = export_column_override(column))
    send(method, record)
  else
    raw_value = record.send(column.name)

    if column.association.nil? or column_empty?(raw_value)
      format_export_column(raw_value, format)
    elsif column.association
      if column.association.collection?
        format_plural_association_export_column(raw_value)
      else
        format_singular_association_export_column(raw_value)
      end
    end
  end
end