RFC: Catalyst::View::CSV

Do you have a question? Post it now! No Registration Necessary.  Now with pictures!

I have written a module for producing CSV formatted output as a view.
It, of course, can create any sort of delimited format one desires.
Here is the POD for details.

This has also been posted on the Catalyst Developer Mailing List:

=head1 NAME

Catalyst::View::CSV - Comma separated values or Delimiter separated
values for your data


  # lib/MyApp/View/CSV.pm
  package MyApp::View::CSV;
  use base qw( Catalyst::View::CSV );

  # lib/MyApp/Controller/SomeController.pm
  sub example_action_1 : Local {
    my ($self, $c) = @_;

    # Array reference of array references.
    my $data = [
      ['col 1','col 2','col ...','col N'], # row 1
      ['col 1','col 2','col ...','col N'], # row 2
      ['col 1','col 2','col ...','col N'], # row ...
      ['col 1','col 2','col ...','col N']  # row N

    # To output your data in comma seperated values just pass your
array by reference into the 'csv' key of the stash
    $c->stash-> = $data;

    # Finally forward processing to the CSV View

  # Other ways of storing data
  sub example_action_2 : Local {
    my ($self, $c) = @_;

    # Array of array references
    my @data;

    push(@data,['col 1','col 2','col ...','col N']); # row 1
    push(@data,['col 1','col 2','col ...','col N']); # row 2
    push(@data,['col 1','col 2','col ...','col N']); # row ...
    push(@data,['col 1','col 2','col ...','col N']); # row N

    # OR to produce a single column of data you can simply do the
    my @data = (
                'col 1 row 1',
                'col 1 row 2',
                'col 1 row ...',
                'col 1 row N'

    $c->stash-> = \@data;


  # Available Options to produce other types of delimiter seperated
  sub  example_action_3 : Local {
    my ($self, $c) = @_;

    my $data = [
      ['col 1','col 2','col ...','col N'], # row 1
      ['col 1','col 2','col ...','col N'] # row 2

    # You can change any of the aspects of a delimiter seperated
values format by storing them in the appropriate stash key
    # This is an example of tab seperated values for instance

    $c->stash-> = '"'; # default: '"'

    $c->stash-> = '"'; # default: '"'

    $c->stash-> = '\t'; # default: ','

    $c->stash-> = "\n"; # default: "\n"

    $c->stash-> = $data;


Catalyst::View::CSV is a Catalyst View handler that returns data in
delimiter seperated values (default is comma) format.


If the Content-Type HTTP Header is not set, it will default to 'text/

  # Example of setting your own Content-Type
  $c->res->headers->header('Content-Type' => 'text/plain');

  # Forward processing to CSV View with a text/plain Content-Type

=head1 OPTIONS

=over 4

=item quote_char

Determines what value will be enclosed within if it contains
whitespace or the delimiter character. DEFAULT: '"'

  $c->stash-> = '/';

=item escape_char

Determines what value will be to escape any delimiter's found in a
column. DEFAULT: '"'

  $c->stash-> = '/';

=item sep_char

Determines the separator between columns. DEFAULT: ','

  $c->stash-> = '|';

=item eol

Any characters defined in eol will be placed at the end of a row.

  $c->stash-> = '';

=item csv

The data that will be processed into delimiter separated values format
is stored here. The data should be an array ref of array refs of
scalars or an array ref of scalars. Note: if nothing is found in csv,
the stash is searched and any array references found will be used as
the data instead.

  # Array ref of array refs of scalars
  my $data = [

  $c->stash-> = $data;

  # Array ref of scalars
  my @data = ('Jan','Feb','Mar','Apr');

  $c->stash-> = \@data;



=over 4

=item process

This method will be called by Catalyst if it is asked to forward to a
component without a specified action.

=item render

Allows others to use this view for much more fine-grained content

=item _csv

Subroutine that actually produces the delimiter separated values.
Intended to be private in scope to this module.


=head1 AUTHOR

Travis Chase - gaudeon_at_cpan_dot_org

=head1 SEE ALSO

L<Catalyst> L<Text::CSV>

=head1 LICENSE

This library is free software, you can redistribute it and/or modify
it under the same terms as Perl itself.


Site Timeline