Module: CsvExporter

Defined in:
lib/dm_core/csv_exporter.rb

Overview

Implements CSV Export functionality

Instance Method Summary collapse

Instance Method Details

#csv_export(column_definitions, data_array, options = {}) ⇒ Object

Exports data to a CSV formatted file. column_definitions: defines the name of the fields and how they are accessed.

Array of items, where each item is an array of 
  name used in CSV column
  name used to access the value in the data records
  width of field
  optional formatting instructions as a Hash
  ex)
     column_definitions = []
     column_definitions <<     ["Receipt Code",      "'R-' + item.receipt_code", 75]
     column_definitions <<     ["State",             "item.state.capitalize"]
     column_definitions <<     ['Process State',     'item.aasm_state', 100]
     column_definitions <<     ['Registered on',     'item.created_at.to_date', 75, {:type => 'DateTime', :numberformat => 'd mmm, yyyy'}]
     column_definitions <<     ["Price",             "item.workshop_price.price.to_f", nil, {:type => 'Number', :numberformat => '#,##0.00'}]

data_array: an array of objects (link from a find) :filename => ‘file_name’ name of file to save as. :expressions => true : the data definintion can be a complex expression, 

so simply evaluate it directly. To access the current item, the expression
should use 'item', as in 'item.name.blank? ? "n/a" : item.name'



46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/dm_core/csv_exporter.rb', line 46

def csv_export(column_definitions, data_array, options = {})
  options.symbolize_keys
  outputArray = Array.new
  csv_string  = CSV.generate do |csv|
    column_definitions.each { |x| outputArray << x[0] }
    csv << outputArray

    data_array.each do |item|
      outputArray.clear
      column_definitions.each do |x|
        data = get_data_value(item, x[1], options)
        #data = "\"#{data}\"" if data.include?(',') #--- add quotes if comma included
        outputArray << data
      end            
      csv << outputArray
    end
  end
  if options[:filename]
    send_data csv_string, :filename => to_csv_filename(options[:filename]), :disposition => 'attachment', :type => 'text/csv'
  else
    return csv_string
  end
end

#csv_export_rawtable(table_name, data_array, options = {}) ⇒ Object

Exports data to a CSV formatted file, using columns directly from a table table_name: name of the table exporting. Column names are pulled from it. data_array: an array of hashes (link from a find)



74
75
76
77
78
79
80
 
# File 'lib/dm_core/csv_exporter.rb', line 74

def csv_export_rawtable(table_name, data_array, options = {})
  column_definitions = Array.new
  for column in eval("#{table_name}.content_columns")
      column_definitions << [column.name, column.name]
  end
  csv_export(column_definitions, data_array, options)
end

#data_export(column_definitions, data_array, options = {}) ⇒ Object 



14
15
16
17
18
19
20
21
22
23
 
# File 'lib/dm_core/csv_exporter.rb', line 14

def data_export(column_definitions, data_array, options = {})
  case options[:format]
  when 'xls'
    excel_export(column_definitions, data_array, options)
  when 'ruport'
    # ruport_export(column_definitions, data_array, options)
  else
    csv_export(column_definitions, data_array, options)
  end
end

#excel_export(column_definitions, data_array, options = {}) ⇒ Object

Exports data to an Excel formatted file. column_definitions: defines the name of the fields and how they are accessed.

Array of items, where each item is an array of 
  name used in CSV column
  name used to access the value in the data records
  width of field
  optional formatting instructions as a Hash
  ex)
     column_definitions = []
     column_definitions <<     ["Receipt Code",      "'R-' + item.receipt_code", 75]
     column_definitions <<     ["State",             "item.state.capitalize"]
     column_definitions <<     ['Process State',     'item.aasm_state', 100]
     column_definitions <<     ['Registered on',     'item.created_at.to_date', 75, {:type => 'DateTime', :numberformat => 'd mmm, yyyy'}]
     column_definitions <<     ["Price",             "item.workshop_price.price.to_f", nil, {:type => 'Number', :numberformat => '#,##0.00'}]

data_array: an array of objects (link from a find) :filename => ‘file_name’ name of file to save as. :expressions => true : the data definintion can be a complex expression, 

so simply evaluate it directly. To access the current item, the expression
should use 'item', as in 'item.name.blank? ? "n/a" : item.name'



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/dm_core/csv_exporter.rb', line 103

def excel_export(column_definitions, data_array, options = {})
  options.symbolize_keys
  rows      = Array.new
  columns   = Array.new

  #--- create the workbook
  wb          = Scio::Excel::SimpleWorkbook.new(to_excel_filename(options[:filename] ? options[:filename] : 'Workbook'))
  stc         = wb.default_cell_style
  stc.borders = stc.borders & 0

  column_definitions.each do |x|
    style = x[3].nil? ? nil : Scio::Excel::SimpleStyle.new(x[3])
    c = Scio::Excel::Column.new(x[0], x[3].nil? ? {} : x[3])
    c.width = x[2] unless x[2].nil?
    c.cell_style = style
    columns << c
  end

  data_array.each do |item|
    data = {}
    column_definitions.each do |x|
      data[x[0]] = get_data_value(item, x[1], options)
    end
    rows << data
  end

  wb.columns  = columns
  wb.rows     = rows

  if options[:filename]
    send_data wb.create, :filename => to_excel_filename(options[:filename]), :disposition => 'attachment', :type => 'application/excel'
  else
    return wb.create
  end
end