NAME

Mojolicious::Plugin::MultiConfig - Load multiple configs and merge

VERSION

Version 0.2

SYNOPSIS

        # In Mojo startup()...

        my $config = $self->plugin('multi_config', foo => 'bar');
        say($config->{this});
        say($self->config->{that});

DESCRIPTION

Mojolicious::Plugin::MultiConfig is a wrapper around Config::Any to load multiple configuration files and merge them together.

The default behaviour is to load 3 config files based on templates containing moniker (%a), mode (%m), username (%u) and file extenstion (%e):

* %a.%e * %a.%m.%e * %a.%m.%u.%e

The config files are loaded in order, with later files in the chain overwriting option(s) in the previous config file.

The filenames are configurable, see OPTIONS section below.

Missing config files are ignored without error. (TODO: config option to be added in the near future ensure an error).

OPTIONS

Mojolicious::Plugin::MultiConfig supports some options. They can be passed as named args. e.g.:

        $self->plugin('multi_config', option1 => 'value1', foo => 'bar');

moniker

        moniker => 'appconfig'

Will use this value in place of %a (moniker) in filenames. Defaults to $app->moniker if not specified.

mode

        mode => 'test'

Will use this value in place of %m (mode) in filenames. Defaults to $app->mode if not specified.

dir

        dir => 'my_config_dir'

Will load config files from this directory. Defaults to $app->home('conf') if not specified.

files

        files => ['file1.conf', 'file2.%u.conf']

Will load these config files instead of the default. You can use template codes as per DESCRIPTION section.

Defaults to ['%a.%e', '%a.%m.%e', '%a.%m.%u.%e'] if not specified.

ext

        ext => 'yml'

Will use this value in place of %e (file extension) in filenames. Defaults to conf if not specified.

METHODS

register

Register as a plugin and load config files. Called automatically by $app->plugin

AUTHOR

Ben Vinnerd, <ben at vinnerd.com>

LICENCE AND COPYRIGHT

Copyright 2013 Ben Vinnerd.

This program is free software; you can redistribute it and/or modify it under the terms of the the Artistic License (2.0). You may obtain a copy of the full license at:

http://www.perlfoundation.org/artistic_license_2_0

Any use, modification, and distribution of the Standard or Modified Versions is governed by this Artistic License. By using, modifying or distributing the Package, you accept this license. Do not use, modify, or distribute the Package, if you do not accept this license.

If your Modified Version has been derived from a Modified Version made by someone other than you, you are nevertheless required to ensure that your Modified Version complies with the requirements of this license.

This license does not grant you the right to use any trademark, service mark, tradename, or logo of the Copyright Holder.

This license includes the non-exclusive, worldwide, free-of-charge patent license to make, have made, use, offer to sell, sell, import and otherwise transfer the Package with respect to any patent claims licensable by the Copyright Holder that are necessarily infringed by the Package. If you institute patent litigation (including a cross-claim or counterclaim) against any party alleging that the Package constitutes direct or contributory patent infringement, then this Artistic License to you shall terminate on the date that such litigation is filed.

Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES. THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

cpanm Mojolicious::Plugin::MultiConfig

perl -MCPAN -e shell
install Mojolicious::Plugin::MultiConfig