1 2 3 4 5 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 35 36 37 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 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102
|
# encoding: UTF-8
require 'csv'
module RailsAdmin
class CSVConverter
UTF8_ENCODINGS = [nil, '', 'utf8', 'utf-8', 'unicode', 'UTF8', 'UTF-8', 'UNICODE', 'utf8mb4']
TARGET_ENCODINGS = %w(UTF-8 UTF-16LE UTF-16BE UTF-32LE UTF-32BE UTF-7 ISO-8859-1 ISO-8859-15 IBM850 MacRoman Windows-1252 ISO-8859-3 IBM852 ISO-8859-2 Windows-1250 IBM855 ISO-8859-5 KOI8-R MacCyrillic Windows-1251 IBM866 GB2312 GBK GB18030 Big5 Big5-HKSCS EUC-TW EUC-JP ISO-2022-JP Shift_JIS EUC-KR)
def initialize(objects = [], schema = {})
return self if (@objects = objects).blank?
@model = objects.dup.first.class
@abstract_model = RailsAdmin::AbstractModel.new(@model)
@model_config = @abstract_model.config
@methods = [(schema[:only] || []) + (schema[:methods] || [])].flatten.compact
@fields = @methods.collect { |m| export_fields_for(m).first }
@empty = ::I18n.t('admin.export.empty_value_for_associated_objects')
schema_include = schema.delete(:include) || {}
@associations = schema_include.each_with_object({}) do |(key, values), hash|
association = association_for(key)
model_config = association.associated_model_config
abstract_model = model_config.abstract_model
methods = [(values[:only] || []) + (values[:methods] || [])].flatten.compact
hash[key] = {
association: association,
model: abstract_model.model,
abstract_model: abstract_model,
model_config: model_config,
fields: methods.collect { |m| export_fields_for(m, model_config).first },
}
hash
end
end
def to_csv(options = {})
# encoding shenanigans first
@encoding_from = Encoding.find(UTF8_ENCODINGS.include?(@abstract_model.encoding) ? 'UTF-8' : @abstract_model.encoding)
@encoding_to = Encoding.find(options[:encoding_to].presence || @encoding_from)
csv_string = generate_csv_string(options)
if @encoding_to != @encoding_from
csv_string = csv_string.encode(@encoding_to, @encoding_from, invalid: :replace, undef: :replace, replace: '?')
end
# Add a BOM for utf8 encodings, helps with utf8 auto-detect for some versions of Excel.
# Don't add if utf8 but user don't want to touch input encoding:
# If user chooses utf8, they will open it in utf8 and BOM will disappear at reading.
# But that way "English" users who don't bother and chooses to let utf8 by default won't get BOM added
# and will not see it if Excel opens the file with a different encoding.
if options[:encoding_to].present? && @encoding_to == Encoding::UTF_8
csv_string = "\xEF\xBB\xBF#{csv_string}"
end
[!options[:skip_header], @encoding_to.to_s, csv_string]
end
private
def association_for(key)
export_fields_for(key).detect(&:association?)
end
def export_fields_for(method, model_config = @model_config)
model_config.export.fields.select { |f| f.name == method }
end
def generate_csv_string(options)
generator_options = (options[:generator] || {}).symbolize_keys.delete_if { |_, value| value.blank? }
CSV.generate(generator_options) do |csv|
csv << generate_csv_header unless options[:skip_header]
method = @objects.respond_to?(:find_each) ? :find_each : :each
@objects.send(method) do |object|
csv << generate_csv_row(object)
end
end
end
def generate_csv_header
@fields.collect do |field|
::I18n.t('admin.export.csv.header_for_root_methods', name: field.label, model: @abstract_model.pretty_name)
end +
@associations.flat_map do |_association_name, option_hash|
option_hash[:fields].collect do |field|
::I18n.t('admin.export.csv.header_for_association_methods', name: field.label, association: option_hash[:association].label)
end
end
end
def generate_csv_row(object)
@fields.collect do |field|
field.with(object: object).export_value
end +
@associations.flat_map do |association_name, option_hash|
associated_objects = [object.send(association_name)].flatten.compact
option_hash[:fields].collect do |field|
associated_objects.collect { |ao| field.with(object: ao).export_value.presence || @empty }.join(',')
end
end
end
end
end
|