NAME

Narada::Config - manage project configuration

VERSION

This document describes Narada::Config version 1.3.14

SYNOPSIS

use Narada::Config;

my $version = get_config_line("version");
my $exclude = get_config("backup/exclude");
set_config("log/output", "/dev/stderr");

my $db = get_db_config();
my $dbh = DBI->connect($db->{dsn}, $db->{login}, $db->{pass});

DESCRIPTION

Project's configuration keept in files under directory 'config/' in project root directory. Usually single file contain value for single variable (variable name is file name itself).

While it's possible to manage project configuration with reading/writing to these files, this module provide easier way to do this.

INTERFACE

get_config( VARIABLE_NAME )

VARIABLE_NAME must contain only [/A-Za-z0-9._-]. It must not contain "./" or "../".

Return: contents of file 'config/VARIABLE_NAME' as scalar.

get_config_line( VARIABLE_NAME )

Suitable for reading files which contain single string (with/without \n at end).

VARIABLE_NAME must contain only [/A-Za-z0-9._-]. It must not contain "./" or "../".

Return: contents of file 'config/VARIABLE_NAME' as scalar without last \n (if any). Raise exception if file contain more than one line.

get_db_config()

Helper for reading database configuration from config/db/*.

Return: nothing if database not configured, or hashref with keys:

{db}        contents of config/db/db
{login}     contents of config/db/login
{pass}      contents of config/db/pass
{host}      contents of config/db/host
{port}      contents of config/db/port
{dsn_nodb}  'dbi:mysql:;host=$host;port=$port'
{dsn}       'dbi:mysql:;host=$host;port=$port;database=$db'

set_config( VARIABLE_NAME, VARIABLE_VALUE )

See limitation for VARIABLE_VALUE above.

Atomically write VARIABLE_VALUE (scalar) to file 'config/VARIABLE_NAME'. If 'config/VARIABLE_NAME' doesn't exist it will be created (including parent directories if needed).

Return: nothing.

DIAGNOSTICS

bad config: %s

Thrown by set_config() and get_config() on wrong VARIABLE_NAME.

no such config: %s

Thrown by get_config() if file 'config/VARIABLE_NAME' doesn't exist.

open(config/%s): %s

close: %s

rename to config/%s: %s

Internal errors.

CONFIGURATION AND ENVIRONMENT

Narada::Config requires configuration files and directories provided by Narada framework.

DEPENDENCIES

Perl6::Export::Attrs

INCOMPATIBILITIES

None reported.

BUGS AND LIMITATIONS

No bugs have been reported.

Please report any bugs or feature requests to bug-narada@rt.cpan.org, or through the web interface at http://rt.cpan.org.

AUTHOR

Alex Efros <powerman@cpan.org>

LICENSE AND COPYRIGHT

Copyright (c) 2008-2014 Alex Efros <powerman@cpan.org>. All rights reserved.

This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See perlartistic.

DISCLAIMER OF WARRANTY

BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.

IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.