Jakob Voß > Config-Any-CSV > Config::Any::CSV

Download:
Config-Any-CSV-0.05.tar.gz

Dependencies

Annotate this POD

Website

View/Report Bugs
Module Version: 0.05   Source  

NAME ^

Config::Any::CSV - Load CSV as config files

VERSION ^

version 0.05

SYNOPSIS ^

    use Config::Any;
 
    my $config = Config::Any->load_files({files => \@files});

I recommend to use Config::ZOMG for a nicer interface to Config::Any:

    use Config::ZOMG;

    # just load a single file
    my $config_hash = Config::ZOMG->open( $csv_file );

    # load foo.csv (and possible foo_local.csv)
    my $config = Config::ZOMG->new( 
        path => '/path/to/config',
        name => 'foo'
    );

    # load with CSV options
    my $config = Config::ZOMG->new( 
        path => '/path/to/config',
        name => 'foo',
        drivers => {
            CSV => { 
                sep_char => ';', 
                with_key => 1,
            } 
        }
    );

DESCRIPTION ^

This small module adds support of CSV files to Config::Any. Files with extension .csv are read with Text::CSV - see that module for documentation of the particular CSV format. By default, Config::Any::CSV enables the options binary and allow_whitespace. One can modify options with driver_args (Config::Any) or driver (Config::ZOMG). The first row of a CSV file is always interpreted as a list of field names and the first field is always interpreted as key field. For instance this CSV file

    name,age,mail
    alice, 42, alice@example.org
    bob, 23, bob@example.org

Is parsed into this Perl structure:

    {
        alice => {
            age  => '42',
            mail => 'alice@example.org',
        },
         bob => {
            age => '23',
            mail => 'bob@example.org'
        }
    }

The driver option with_key adds key field to each row:

    {
        alice => {
            name => 'alice',
            age  => '42',
            mail => 'alice@example.org',
        },
         bob => {
            name => 'bob',
            age => '23',
            mail => 'bob@example.org'
        }
    }

The name of the first field is irrelevant and the order of rows gets lost. If a file contains multiple rows with the same first field value, only the last of these rows is used. Empty lines are ignored.

This module requires Perl 5.10 but it could easily be modified to also run in more ancient versions of Perl.

AUTHOR ^

Jakob Voß

COPYRIGHT AND LICENSE ^

This software is copyright (c) 2014 by Jakob Voß.

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

syntax highlighting: