/ 
TableDataRoles-Standard-0.025
River stage two • 27 direct dependents • 42 total dependents
/ TableDataRole::Source::CSVInFile

NAME

TableDataRole::Source::CSVInFile - Role to access table data from CSV in a file/filehandle

VERSION

This document describes version 0.025 of TableDataRole::Source::CSVInFile (from Perl distribution TableDataRoles-Standard), released on 2024-05-14.

SYNOPSIS

To use this role and create a curried constructor:

package TableDataRole::MyTable;
use Role::Tiny;
with 'TableDataRole::Source::CSVInFile';
around new => sub {
    my $orig = shift;
    $orig->(@_, filename => '/path/to/some.csv'); # you can also pass 'filehandle', alternatively
};

package TableData::MyTable;
use Role::Tiny::With;
with 'TableDataRole::MyTable';
1;

In code that uses your TableData class:

use TableData::MyTable;

my $td = TableData::MyTable->new;
...

DESCRIPTION

This role expects table data in CSV format in a specified file/filehandle. First row MUST contain the column names.

ROLES MIXED IN

TableDataRole::Spec::Basic

PROVIDED METHODS

new

Usage:

my $obj = $class->new(%args);

Constructor. Known arguments:

  • filename

    Supply path to the CSV file. Alternatively, you can also pass filehandle instead. Either filename or filehandle is required.

  • filehandle

    Supply handle to the CSV file. Alternatively, you can also pass filename instead. Either filename or filehandle is required.

Note that if your class wants to wrap this constructor in its own, you need to create another role first, as shown in the example in Synopsis.

as_csv

A more efficient version than one provided by TableDataRole::Util::CSV, since the data is already in CSV form.

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/TableDataRoles-Standard.

SOURCE

Source repository is at https://github.com/perlancar/perl-TableDataRoles-Standard.

SEE ALSO

TableDataRole::Source::CSVInDATA

TableDataRole::Source::CSVInFiles

AUTHOR

perlancar <perlancar@cpan.org>

CONTRIBUTING

To contribute, you can send patches by email/via RT, or send pull requests on GitHub.

Most of the time, you don't need to build the distribution yourself. You can simply modify the code, then test via:

% prove -l

If you want to build the distribution (e.g. to try to install it locally on your system), you can install Dist::Zilla, Dist::Zilla::PluginBundle::Author::PERLANCAR, Pod::Weaver::PluginBundle::Author::PERLANCAR, and sometimes one or two other Dist::Zilla- and/or Pod::Weaver plugins. Any additional steps required beyond that are considered a bug and can be reported to me.

COPYRIGHT AND LICENSE

This software is copyright (c) 2024, 2023, 2022, 2021 by perlancar <perlancar@cpan.org>.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

BUGS

Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=TableDataRoles-Standard

When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.