Class: RailsAdmin::CSVConverter

Inherits:
Object
  • Object
show all
Defined in:
lib/rails_admin/support/csv_converter.rb

Instance Method Summary collapse

Constructor Details

#initialize(objects = [], schema = nil) ⇒ CSVConverter

Returns a new instance of CSVConverter.



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
 
# File 'lib/rails_admin/support/csv_converter.rb', line 7

def initialize(objects = [], schema = nil)
  @fields = []
  @associations = []
  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_field_for(m) }.compact
  @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 = export_field_for(key)
    next unless association&.association?

    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_field_for(m, model_config) }.compact,
    }
    hash
  end
end

Instance Method Details

#to_csv(options = {}) ⇒ Object 



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/rails_admin/support/csv_converter.rb', line 41

def to_csv(options = {})
  if CSV::VERSION == '3.0.2'
    raise <<~MSG
      CSV library bundled with Ruby 2.6.0 has encoding issue, please upgrade Ruby to 2.6.1 or later.
      https://github.com/ruby/csv/issues/62
    MSG
  end

  options = HashWithIndifferentAccess.new(options)
  encoding_to = Encoding.find(options[:encoding_to]) if options[:encoding_to].present?

  csv_string = generate_csv_string(options)
  csv_string = csv_string.encode(encoding_to, invalid: :replace, undef: :replace, replace: '?') if encoding_to

  # 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.
  csv_string = "\xEF\xBB\xBF#{csv_string}" if encoding_to == Encoding::UTF_8

  [!options[:skip_header], (encoding_to || csv_string.encoding).to_s, csv_string]
end