Config::JFDI - Just * Do it: A Catalyst::Plugin::ConfigLoader-style layer over Config::Any
Version 0.05
use Config::JFDI; my $config = Config::JFDI->new(name => "my_application", path => "path/to/my/application"); my $config_hash = $config->get;
This will look for something like (depending on what Config::Any will find):
path/to/my/application/my_application_local.{yml,yaml,cnf,conf,jsn,json,...} AND path/to/my/application/my_application.{yml,yaml,cnf,conf,jsn,json,...}
... and load the found configuration information appropiately, with _local taking precedence.
You can also specify a file directly:
my $config = Config::JFDI->new(file => "/path/to/my/application/my_application.cnf");
To later reload your configuration, fresh from disk:
$config->reload;
Config::JFDI is an implementation of Catalyst::Plugin::ConfigLoader that exists outside of Catalyst.
Essentially, Config::JFDI will scan a directory for files matching a certain name. If such a file is found which also matches an extension that Config::Any can read, then the configuration from that file will be loaded.
Config::JFDI will also look for special files that end with a "_local" suffix. Files with this special suffix will take precedence over any other existing configuration file, if any. The precedence takes place by merging the local configuration with the "standard" configuration via Hash::Merge::Simple.
Finally, you can override/modify the path search from outside your application, by setting the <NAME>_CONFIG variable outside your application (where <NAME> is the uppercase version of what you passed to Config::JFDI->new).
You can configure the $config object by passing the following to new:
name The name specifying the prefix of the configuration file to look for and the ENV variable to read. This can be a package name. In any case, :: will be substituted with _ in <name> and the result will be lowercased. To prevent modification of <name>, pass it in as a scalar reference. path The directory to search in file Directly read the configuration from this file. Config::Any must recognize the extension. Setting this will override path local_suffix The suffix to match when looking for a local configuration. "local" By default ("config_local_suffix" will also work so as to be drop-in compatible with C::P::CL) env_lookup Additional ENV to check if $ENV{<NAME>...} is not found no_env Set this to 1 to disregard anything in the ENV. Off by default driver A hash consisting of Config:: driver information. This is passed directly through to Config::Any install_accessor Set this to 1 to install a Catalyst-style accessor as <name>::config You can also specify the package name directly by setting install_accessor to it (e.g. install_accessor => "My::Application") substitute A hash consisting of subroutines called during the substitution phase of configuration preparation. ("substitutions" will also work so as to be drop-in compatible with C::P::CL) A substitution subroutine has the following signature: ($config, [ $argument1, $argument2, ... ]) path_to The path to dir to use for the __path_to(...)__ substitution. If nothing is given, then the 'home' config value will be used ($config->get->{home}). Failing that, the current directory will be used. default A hash filled with default keys/values
Returns a new Config::JFDI object
Load a config as specified by ->new(...) and ENV and return a hash
These will only load the configuration once, so it's safe to call them multiple times without incurring any loading-time penalty
Return a clone of the configuration hash using Clone
This will load the configuration first, if it hasn't already
Reload the configuration, examining ENV and scanning the path anew
Returns a hash of the configuration
For each given <value>, if <value> looks like a substitution specification, then run the substitution macro on <value> and store the result.
There are three default substitutions (the same as Catalyst::Plugin::ConfigLoader)
__HOME__ - replaced with $c->path_to('')
__HOME__
$c->path_to('')
__path_to(foo/bar)__ - replaced with $c->path_to('foo/bar')
__path_to(foo/bar)__
$c->path_to('foo/bar')
__literal(__FOO__)__ - leaves __FOO__ alone (allows you to use __DATA__ as a config value, for example)
__literal(__FOO__)__
__DATA__
The parameter list is split on comma (,).
,
You can define your own substitutions by supplying the substitute option to ->new
Robert Krimen, <rkrimen at cpan.org>
<rkrimen at cpan.org>
Catalyst::Plugin::ConfigLoader, Config::Any, Catalyst
You can contribute or fork this project via GitHub:
http://github.com/robertkrimen/config-jfdi/tree/master
git clone git://github.com/robertkrimen/config-jfdi.git PACKAGE
Please report any bugs or feature requests to bug-config-jfdi at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Config-JFDI. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.
bug-config-jfdi at rt.cpan.org
You can find documentation for this module with the perldoc command.
perldoc Config::JFDI
You can also look for information at:
RT: CPAN's request tracker
http://rt.cpan.org/NoAuth/Bugs.html?Dist=Config-JFDI
AnnoCPAN: Annotated CPAN documentation
http://annocpan.org/dist/Config-JFDI
CPAN Ratings
http://cpanratings.perl.org/d/Config-JFDI
Search CPAN
http://search.cpan.org/dist/Config-JFDI
Copyright 2008 Robert Krimen, all rights reserved.
This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
To install Config::JFDI, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Config::JFDI
CPAN shell
perl -MCPAN -e shell install Config::JFDI
For more information on module installation, please visit the detailed CPAN module installation guide.