class ActiveAdmin::CSVBuilder

CSVBuilder stores CSV configuration

Usage example:

csv_builder = CSVBuilder.new
csv_builder.column :id
csv_builder.column("Name") { |resource| resource.full_name }
csv_builder.column(:name, humanize_name: false)
csv_builder.column("name", humanize_name: false) { |resource| resource.full_name }

csv_builder = CSVBuilder.new col_sep: ";"
csv_builder = CSVBuilder.new humanize_name: false
csv_builder.column :id

Constants

COLUMN_TRANSITIVE_OPTIONS

Attributes

columns[R]
options[R]
view_context[R]

Public Class Methods

default_for_resource(resource) click to toggle source

Return a default CSVBuilder for a resource The CSVBuilder’s columns would be Id followed by this resource’s content columns

# File lib/active_admin/csv_builder.rb, line 23
def self.default_for_resource(resource)
  new resource: resource do
    column :id
    resource.content_columns.each { |c| column c }
  end
end
new(options = {}, &block) click to toggle source
# File lib/active_admin/csv_builder.rb, line 34
def initialize(options = {}, &block)
  @resource = options.delete(:resource)
  @columns = []
  @options = ActiveAdmin.application.csv_options.merge options
  @block = block
end

Public Instance Methods

build(controller, csv) click to toggle source
# File lib/active_admin/csv_builder.rb, line 45
def build(controller, csv)
  columns = exec_columns controller.view_context
  bom = options[:byte_order_mark]
  column_names = options.delete(:column_names) { true }
  csv_options = options.except :encoding_options, :humanize_name, :byte_order_mark

  csv << bom if bom

  if column_names
    csv << CSV.generate_line(columns.map { |c| sanitize(encode(c.name, options)) }, **csv_options)
  end

  controller.send(:in_paginated_batches) do |resource|
    csv << CSV.generate_line(build_row(resource, columns, options), **csv_options)
  end

  csv
end
build_row(resource, columns, options) click to toggle source
# File lib/active_admin/csv_builder.rb, line 71
def build_row(resource, columns, options)
  columns.map do |column|
    sanitize(encode(call_method_or_proc_on(resource, column.data), options))
  end
end
column(name, options = {}, &block) click to toggle source
# File lib/active_admin/csv_builder.rb, line 41
def column(name, options = {}, &block)
  @columns << Column.new(name, @resource, column_transitive_options.merge(options), block)
end
encode(content, options) click to toggle source
# File lib/active_admin/csv_builder.rb, line 77
def encode(content, options)
  if options[:encoding]
    if options[:encoding_options]
      content.to_s.encode options[:encoding], **options[:encoding_options]
    else
      content.to_s.encode options[:encoding]
    end
  else
    content
  end
end
exec_columns(view_context = nil) click to toggle source
# File lib/active_admin/csv_builder.rb, line 64
def exec_columns(view_context = nil)
  @view_context = view_context
  @columns = [] # we want to re-render these every instance
  instance_exec &@block if @block.present?
  columns
end
method_missing(method, *args, &block) click to toggle source
Calls superclass method
# File lib/active_admin/csv_builder.rb, line 93
def method_missing(method, *args, &block)
  if @view_context.respond_to? method
    @view_context.public_send method, *args, &block
  else
    super
  end
end
sanitize(content) click to toggle source
# File lib/active_admin/csv_builder.rb, line 89
def sanitize(content)
  Sanitizer.sanitize(content)
end

Private Instance Methods

column_transitive_options() click to toggle source
# File lib/active_admin/csv_builder.rb, line 123
def column_transitive_options
  @column_transitive_options ||= @options.slice(*COLUMN_TRANSITIVE_OPTIONS)
end