X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst%2FPlugin%2FConfigLoader.pm;h=f073ccf1a0274bcffd909108a6a43d4fbb83b3ca;hb=04ea923f91f29550671e555bc8606b59ec778eef;hp=d4092cb51e0c294426482073a876168ded6ecc61;hpb=c7413665fa4fdabbd3d0e796070ef2f218eef333;p=catagits%2FCatalyst-Plugin-ConfigLoader.git diff --git a/lib/Catalyst/Plugin/ConfigLoader.pm b/lib/Catalyst/Plugin/ConfigLoader.pm index d4092cb..f073ccf 100644 --- a/lib/Catalyst/Plugin/ConfigLoader.pm +++ b/lib/Catalyst/Plugin/ConfigLoader.pm @@ -8,8 +8,9 @@ use Module::Pluggable::Fast name => '_config_loaders', search => [ __PACKAGE__ ], require => 1; +use Data::Visitor::Callback; -our $VERSION = '0.02'; +our $VERSION = '0.05'; =head1 NAME @@ -19,26 +20,31 @@ Catalyst::Plugin::ConfigLoader - Load config files of various types package MyApp; - use Catalyst( ConfigLoader ); + # ConfigLoader should be first in your list so + # other plugins can get the config information + use Catalyst qw( ConfigLoader ... ); # by default myapp.* will be loaded # you can specify a file if you'd like - __PACKAGE__->config( file = > 'config.yaml' ); - + __PACKAGE__->config( file = > 'config.yaml' ); =head1 DESCRIPTION -This mdoule will attempt to load find and load a configuration +This module will attempt to load find and load a configuration file of various types. Currently it supports YAML, JSON, XML, INI and Perl formats. +To support the distinction between development and production environments, +this module will also attemp to load a local config (e.g. myapp_local.yaml) +which will override any duplicate settings. + =head1 METHODS =head2 setup( ) This method is automatically called by Catalyst's setup routine. It will -attempt to use each plugin and set the C section once a file has been -successfully loaded. +attempt to use each plugin and, once a file has been successfully +loaded, set the C section. =cut @@ -56,7 +62,7 @@ sub setup { push @files, $path; } else { - push @files, "$path.$_" for @extensions; + @files = map { ( "$path.$_", "${path}_local.$_" ) } @extensions; } for( @files ) { @@ -69,9 +75,38 @@ sub setup { } } + $c->finalize_config; + $c->NEXT::setup( @_ ); } +=head2 finalize_config + +This method is called after the config file is loaded. It can be +used to implement tuning of config values that can only be done +at runtime. If you need to do this to properly configure any +plugins, it's important to load ConfigLoader before them. +ConfigLoader provides a default finalize_config method which +walks through the loaded config hash and replaces any strings +beginning containing C<__HOME__> with the full path to +app's home directory (i.e. C<$c-Epath_to('')> ). +You can also use C<__path_to('foo/bar')__> which translates to +C<$c-Epath_to('foo', 'bar')> + +=cut + +sub finalize_config { + my $c = shift; + my $v = Data::Visitor::Callback->new( + plain_value => sub { + return unless defined $_; + s[__HOME__][ $c->path_to( '' ) ]e; + s[__path_to\((.+)\)__][ $c->path_to( split( '/', $1 ) ) ]e; + } + ); + $v->visit( $c->config ); +} + =head1 AUTHOR =over 4 @@ -80,6 +115,17 @@ sub setup { =back +=head1 CONTRIBUTORS + +The following people have generously donated their time to the +development of this module: + +=over 4 + +=item * David Kamholz Edkamholz@cpan.orgE + +=back + =head1 COPYRIGHT AND LICENSE Copyright 2006 by Brian Cassidy @@ -97,4 +143,4 @@ it under the same terms as Perl itself. =cut -1; \ No newline at end of file +1;