ConfigLoader updated to version 0.07

[catagits/Catalyst-Runtime.git] / lib / Catalyst / Plugin / ConfigLoader.pm

diff --git a/lib/Catalyst/Plugin/ConfigLoader.pm b/lib/Catalyst/Plugin/ConfigLoader.pm
index 0ba9f99..374dc41 100644 (file)
--- a/lib/Catalyst/Plugin/ConfigLoader.pm
+++ b/lib/Catalyst/Plugin/ConfigLoader.pm
@@ -8,8 +8,9 @@ use Module::Pluggable::Fast
     name    => '_config_loaders',\r
     search  => [ __PACKAGE__ ],\r
     require => 1;\r
+use Data::Visitor::Callback;\r
 \r
-our $VERSION = '0.03';\r
+our $VERSION = '0.07';\r
 \r
 =head1 NAME\r
 \r
@@ -22,25 +23,28 @@ Catalyst::Plugin::ConfigLoader - Load config files of various types
     # ConfigLoader should be first in your list so\r
     # other plugins can get the config information\r
     use Catalyst qw( ConfigLoader ... );\r
-       \r
+    \r
     # by default myapp.* will be loaded\r
     # you can specify a file if you'd like\r
-    __PACKAGE__->config( file = > 'config.yaml' );\r
-    \r
+    __PACKAGE__->config( file = > 'config.yaml' );    \r
 \r
 =head1 DESCRIPTION\r
 \r
-This mdoule will attempt to load find and load a configuration\r
+This module will attempt to load find and load a configuration\r
 file of various types. Currently it supports YAML, JSON, XML,\r
 INI and Perl formats.\r
 \r
+To support the distinction between development and production environments,\r
+this module will also attemp to load a local config (e.g. myapp_local.yaml)\r
+which will override any duplicate settings.\r
+\r
 =head1 METHODS\r
 \r
 =head2 setup( )\r
 \r
 This method is automatically called by Catalyst's setup routine. It will\r
 attempt to use each plugin and, once a file has been successfully\r
-loaded, set the C<config()> section.\r
+loaded, set the C<config()> section. \r
 \r
 =cut\r
 \r
@@ -58,22 +62,68 @@ sub setup {
             push @files, $path;\r
         }\r
         else {\r
-            push @files, "$path.$_" for @extensions;\r
+            @files = map { ( "$path.$_", "${path}_local.$_" ) } @extensions;\r
         }\r
 \r
         for( @files ) {\r
             next unless -f $_;\r
             my $config = $loader->load( $_ );\r
-            if( $config ) {\r
-                $c->config( $config );\r
-                last;\r
-            }\r
+            \r
+            _fix_syntax( $config );\r
+            \r
+            $c->config( $config ) if $config;\r
         }\r
     }\r
 \r
+    $c->finalize_config;\r
+\r
     $c->NEXT::setup( @_ );\r
 }\r
 \r
+=head2 finalize_config\r
+\r
+This method is called after the config file is loaded. It can be\r
+used to implement tuning of config values that can only be done\r
+at runtime. If you need to do this to properly configure any\r
+plugins, it's important to load ConfigLoader before them.\r
+ConfigLoader provides a default finalize_config method which\r
+walks through the loaded config hash and replaces any strings\r
+beginning containing C<__HOME__> with the full path to\r
+app's home directory (i.e. C<$c-E<gt>path_to('')> ).\r
+You can also use C<__path_to('foo/bar')__> which translates to\r
+C<$c-E<gt>path_to('foo', 'bar')> \r
+\r
+=cut\r
+\r
+sub finalize_config {\r
+    my $c = shift;\r
+    my $v = Data::Visitor::Callback->new(\r
+        plain_value => sub {\r
+            return unless defined $_;\r
+            s[__HOME__][ $c->path_to( '' ) ]e;\r
+            s[__path_to\((.+)\)__][ $c->path_to( split( '/', $1 ) ) ]e;\r
+        }\r
+    );\r
+    $v->visit( $c->config );\r
+}\r
+\r
+sub _fix_syntax {\r
+    my $config     = shift;\r
+    my @components = (\r
+        map +{\r
+            prefix => $_ eq 'Component' ? '' : $_ . '::',\r
+            values => delete $config->{ lc $_ } || delete $config->{ $_ }\r
+        }, qw( Component Model View Controller )\r
+    );\r
+\r
+    foreach my $comp ( @components ) {\r
+        my $prefix = $comp->{ prefix };\r
+        foreach my $element ( keys %{ $comp->{ values } } ) {\r
+            $config->{ "$prefix$element" } = $comp->{ values }->{ $element };\r
+        }\r
+    }\r
+}\r
+\r
 =head1 AUTHOR\r
 \r
 =over 4 \r
@@ -82,6 +132,17 @@ sub setup {
 \r
 =back\r
 \r
+=head1 CONTRIBUTORS\r
+\r
+The following people have generously donated their time to the\r
+development of this module:\r
+\r
+=over 4\r
+\r
+=item * David Kamholz E<lt>dkamholz@cpan.orgE<gt>\r
+\r
+=back\r
+\r
 =head1 COPYRIGHT AND LICENSE\r
 \r
 Copyright 2006 by Brian Cassidy\r
@@ -99,4 +160,4 @@ it under the same terms as Perl itself.
 \r
 =cut\r
 \r
-1;
\ No newline at end of file
+1;\r