From: Brian Cassidy <bricas@cpan.org>
Date: Wed, 22 Aug 2007 18:18:46 +0000 (+0000)
Subject: allow custom macros or overriding of config_substitutions() sub.
X-Git-Tag: v0.16~5
X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=catagits%2FCatalyst-Plugin-ConfigLoader.git;a=commitdiff_plain;h=d392c48d4316f74673af8fb568d792451c25a2bf

allow custom macros or overriding of config_substitutions() sub.
---

diff --git a/lib/Catalyst/Plugin/ConfigLoader.pm b/lib/Catalyst/Plugin/ConfigLoader.pm
index 8763331..5462f27 100644
--- a/lib/Catalyst/Plugin/ConfigLoader.pm
+++ b/lib/Catalyst/Plugin/ConfigLoader.pm
@@ -217,11 +217,8 @@ 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-E<gt>path_to('')> ).
-You can also use C<__path_to(foo/bar)__> which translates to
-C<$c-E<gt>path_to('foo', 'bar')> 
+walks through the loaded config hash and calls the C<config_substitutions>
+sub on any string.
 
 =cut
 
@@ -230,13 +227,54 @@ sub finalize_config {
     my $v = Data::Visitor::Callback->new(
         plain_value => sub {
             return unless defined $_;
-            s{__HOME__}{ $c->path_to( '' ) }eg;
-            s{__path_to\((.+?)\)__}{ $c->path_to( split( '/', $1 ) ) }eg;
+            $c->config_substitutions( $_ );
         }
     );
     $v->visit( $c->config );
 }
 
+=head2 config_substitutions( $value )
+
+This method substitutes macros found with calls to a function. There are three
+default macros:
+
+=over 4
+
+=item * C<__HOME__> - replaced with C<$c-E<gt>path_to('')>
+
+=item * C<__path_to(foo/bar)__> - replaced with C<$c-E<gt>path_to('foo/bar')>
+
+=item * C<__literal(__FOO__)__> - leaves __FOO__ alone (allows you to use
+C<__DATA__> as a config value, for example)
+
+=back
+
+The parameter list is split on comma (C<,>). You can override this method to
+do your own string munging, or you can define your own macros in
+C<MyApp->config->{ substitutions }>. Example:
+
+    MyApp->config->{ substitutions } = {
+        baz => sub { my $c = shift; qux( @_ ); }
+    }
+
+The above will respond to C<__baz(x,y)__> in config strings.
+
+=cut
+
+sub config_substitutions {
+    my $c = shift;
+    my $subs = $c->config->{ substitutions } || {};
+    $subs->{ HOME } ||= sub { shift->path_to( '' ); };
+    $subs->{ path_to } ||= sub { shift->path_to( @_ ); };
+    $subs->{ literal } ||= sub { return $_[ 1 ]; };
+    my $subsre = join( '|', keys %$subs );
+
+    for ( @_ ) {
+        s{__($subsre)(?:\((.+?)\))?__}{ $subs->{ $1 }->( $c, $2 ? split( /,/, $2 ) : () ) }eg;
+    }
+}
+
+
 =head1 AUTHOR
 
 Brian Cassidy E<lt>bricas@cpan.orgE<gt>
diff --git a/t/20-mock_load.t b/t/20-mock_load.t
index b58c795..6b7e8c6 100644
--- a/t/20-mock_load.t
+++ b/t/20-mock_load.t
@@ -1,12 +1,16 @@
 package MockApp;
 
-use Test::More tests => 7;
+use Test::More tests => 9;
 
 use Cwd;
 $ENV{ CATALYST_HOME } = cwd . '/t/mockapp';
 
 use_ok( 'Catalyst', qw( ConfigLoader ) );
 
+__PACKAGE__->config->{ substitutions } = {
+    foo => sub { shift; join('-', @_); }
+};
+
 __PACKAGE__->setup;
 
 ok( __PACKAGE__->config );
@@ -15,3 +19,5 @@ is( __PACKAGE__->config->{ 'Controller::Foo' }->{ new }, 'key' );
 is( __PACKAGE__->config->{ 'Model::Baz' }->{ qux }, 'xyzzy' );
 is( __PACKAGE__->config->{ 'Model::Baz' }->{ another }, 'new key' );
 is( __PACKAGE__->config->{ 'view' }, 'View::TT::New' );
+is( __PACKAGE__->config->{ 'foo_sub' }, 'x-y' );
+is( __PACKAGE__->config->{ 'literal_macro' }, '__DATA__' );
diff --git a/t/mockapp/mockapp.pl b/t/mockapp/mockapp.pl
index 1dcef6c..d1c3f59 100644
--- a/t/mockapp/mockapp.pl
+++ b/t/mockapp/mockapp.pl
@@ -6,5 +6,7 @@
     },
     'Model::Baz' => {
         qux => 'xyzzy'
-    }
+    },
+    foo_sub => '__foo(x,y)__',
+    literal_macro => '__literal(__DATA__)__',
 }