Class: Ruport::Formatter::CSV

This formatter implements the CSV format for Ruport’s Row, Table, Group and Grouping controllers. It is a light wrapper around James Edward Gray II’s FasterCSV.

Rendering Options

:style Used for grouping (:inline,:justified,:raw)

:format_options A hash of FasterCSV options

:formatter An existing FasterCSV object to write to

:show_table_headers True by default

:show_group_headers True by default

Methods

apply_template build_group_body build_group_header build_grouping_body build_grouping_header build_row build_table_body build_table_header csv_writer new

Attributes

csv_writer [W]

Public Class methods

new()

Public Instance methods

apply_template()

Hook for setting available options using a template. See the template documentation for the available options and their format.

build_group_body()

Renders the group body - uses the table controller to generate the output.

build_group_header()

Renders the header for a group using the group name.

build_grouping_body()

Determines the proper style to use and renders the Grouping.

build_grouping_header()

Generates a header for the grouping using the grouped_by column and the column names.

build_row(data = self.data)

Produces CSV output for a data row.

build_table_body()

Calls the row controller for each row in the Data::Table

build_table_header()

Generates table header by turning column_names into a CSV row. Uses the row controller to generate the actual formatted output

This method does not do anything if options.show_table_headers is false or the Data::Table has no column names.

csv_writer()

Returns the current FCSV object or creates a new one if it has not been set yet. Note that FCSV(sig) has a cache and returns the same FCSV object if writing to the same underlying output with the same options.