die() instead of silently skip files with extensions we can't handle
[catagits/Catalyst-Plugin-ConfigLoader.git] / lib / Catalyst / Plugin / ConfigLoader.pm
index 12b1731..04ac7e3 100644 (file)
@@ -8,7 +8,7 @@ use NEXT;
 use Data::Visitor::Callback;
 use Catalyst::Utils ();
 
-our $VERSION = '0.16';
+our $VERSION = '0.20';
 
 =head1 NAME
 
@@ -26,6 +26,15 @@ Catalyst::Plugin::ConfigLoader - Load config files of various types
     # you can specify a file if you'd like
     __PACKAGE__->config( 'Plugin::ConfigLoader' => { file => 'config.yaml' } );    
 
+  In the file, assuming it's in YAML format:
+
+    foo: bar
+
+  Accessible through the context object, or the class itself
+
+   $c->config->{foo}    # bar
+   MyApp->config->{foo} # bar
+
 =head1 DESCRIPTION
 
 This module will attempt to load find and load a configuration
@@ -50,27 +59,32 @@ loaded, set the C<config()> section.
 sub setup {
     my $c     = shift;
     my @files = $c->find_files;
-    my $cfg   = Config::Any->load_files( {
-        files       => \@files, 
-        filter      => \&_fix_syntax,
-        use_ext     => 1,
-        driver_args => $c->config->{'Plugin::ConfigLoader'}->{driver} || {},
-    } );
+    my $cfg   = Config::Any->load_files(
+        {   files       => \@files,
+            filter      => \&_fix_syntax,
+            use_ext     => 1,
+            driver_args => $c->config->{ 'Plugin::ConfigLoader' }->{ driver }
+                || {},
+        }
+    );
+    # map the array of hashrefs to a simple hash
+    my %configs = map { %$_ } @$cfg;
 
     # split the responses into normal and local cfg
     my $local_suffix = $c->get_config_local_suffix;
-    my( @cfg, @localcfg );
-    for( @$cfg ) {
-        if( ( keys %$_ )[ 0 ] =~ m{ $local_suffix \. }xms ) {
-            push @localcfg, $_;
-        } else {
-            push @cfg, $_;
+    my ( @main, @locals );
+    for ( sort keys %configs ) {
+        if ( m{$local_suffix\.}ms ) {
+            push @locals, $_;
+        }
+        else {
+            push @main, $_;
         }
     }
-    
+
     # load all the normal cfgs, then the local cfgs last so they can override
     # normal cfgs
-    $c->load_config( $_ ) for @cfg, @localcfg;
+    $c->load_config( { $_ => $configs{ $_ } } ) for @main, @locals;
 
     $c->finalize_config;
     $c->NEXT::setup( @_ );
@@ -86,9 +100,9 @@ context object. It does not return a value.
 sub load_config {
     my $c   = shift;
     my $ref = shift;
-    
-    my( $file, $config ) = each %$ref;
-    
+
+    my ( $file, $config ) = %$ref;
+
     $c->config( $config );
     $c->log->debug( qq(Loaded Config "$file") )
         if $c->debug;
@@ -106,18 +120,20 @@ L<Config::Any|Config::Any> for loading.
 
 sub find_files {
     my $c = shift;
-    my( $path, $extension ) = $c->get_config_path;
+    my ( $path, $extension ) = $c->get_config_path;
     my $suffix     = $c->get_config_local_suffix;
     my @extensions = @{ Config::Any->extensions };
-    
+
     my @files;
-    if ($extension) {
-        next unless grep { $_ eq $extension } @extensions;
-        push @files, $path, "${path}_${suffix}";
-    } else {
+    if ( $extension ) {
+        die "Unable to handle files with the extension '${extension}'"
+            unless grep { $_ eq $extension } @extensions;
+        ( my $local = $path ) =~ s{\.$extension}{_$suffix.$extension};
+        push @files, $path, $local;
+    }
+    else {
         @files = map { ( "$path.$_", "${path}_${suffix}.$_" ) } @extensions;
     }
-
     @files;
 }
 
@@ -135,7 +151,7 @@ The order of preference is specified as:
 
 =item * C<$ENV{ CATALYST_CONFIG }>
 
-=item * C<$c-E<gt>config-E<gt>{ 'Plugin::ConfigLoader' }-E>gt>{ file }>
+=item * C<$c-E<gt>config-E<gt>{ 'Plugin::ConfigLoader' }-E<gt>{ file }>
 
 =item * C<$c-E<gt>path_to( $application_prefix )>
 
@@ -150,28 +166,31 @@ and will be removed in the next release.
 =cut
 
 sub get_config_path {
-    my $c       = shift;
+    my $c = shift;
 
     # deprecation notice
-    if( exists $c->config->{ file } ) {
-        $c->log->warn( q("file" config parameter has been deprecated in favor of "$c->config->{ 'Plugin::ConfigLoader' }->{ file }") );
+    if ( exists $c->config->{ file } ) {
+        $c->log->warn(
+            q(*** "file" config parameter has been deprecated in favor of "$c->config->{ 'Plugin::ConfigLoader' }->{ file }")
+        );
+        sleep( 3 );
     }
 
     my $appname = ref $c || $c;
     my $prefix  = Catalyst::Utils::appprefix( $appname );
     my $path    = Catalyst::Utils::env_value( $c, 'CONFIG' )
         || $c->config->{ 'Plugin::ConfigLoader' }->{ file }
-        || $c->config->{ file } # to be removed next release
+        || $c->config->{ file }    # to be removed next release
         || $c->path_to( $prefix );
 
-    my( $extension ) = ( $path =~ m{\.(.{1,4})$} );
-    
-    if( -d $path ) {
-        $path  =~ s{[\/\\]$}{};
+    my ( $extension ) = ( $path =~ m{\.(.{1,4})$} );
+
+    if ( -d $path ) {
+        $path =~ s{[\/\\]$}{};
         $path .= "/$prefix";
     }
-    
-    return( $path, $extension );
+
+    return ( $path, $extension );
 }
 
 =head2 get_config_local_suffix
@@ -195,17 +214,21 @@ and will be removed in the next release.
 =cut
 
 sub get_config_local_suffix {
-    my $c       = shift;
+    my $c = shift;
 
     # deprecation notice
-    if( exists $c->config->{ config_local_suffix } ) {
-        $c->log->warn( q("config_local_suffix" config parameter has been deprecated in favor of "$c->config->{ 'Plugin::ConfigLoader' }->{ config_local_suffix }") );
+    if ( exists $c->config->{ config_local_suffix } ) {
+        $c->log->warn(
+            q(*** "config_local_suffix" config parameter has been deprecated in favor of "$c->config->{ 'Plugin::ConfigLoader' }->{ config_local_suffix }")
+        );
+        sleep( 3 );
     }
 
     my $appname = ref $c || $c;
-    my $suffix  = Catalyst::Utils::env_value( $c, 'CONFIG_LOCAL_SUFFIX' )
+    my $suffix = Catalyst::Utils::env_value( $c, 'CONFIG_LOCAL_SUFFIX' )
         || $c->config->{ 'Plugin::ConfigLoader' }->{ config_local_suffix }
-        || $c->config->{ config_local_suffix } # to be remove in the next release
+        || $c->config
+        ->{ config_local_suffix }    # to be remove in the next release
         || 'local';
 
     return $suffix;
@@ -218,10 +241,8 @@ sub _fix_syntax {
             prefix => $_ eq 'Component' ? '' : $_ . '::',
             values => delete $config->{ lc $_ } || delete $config->{ $_ }
         },
-        grep {
-            ref $config->{ lc $_ } || ref $config->{ $_ }
-        }
-        qw( Component Model M View V Controller C )
+        grep { ref $config->{ lc $_ } || ref $config->{ $_ } }
+            qw( Component Model M View V Controller C )
     );
 
     foreach my $comp ( @components ) {
@@ -285,9 +306,10 @@ The above will respond to C<__baz(x,y)__> in config strings.
 =cut
 
 sub config_substitutions {
-    my $c = shift;
-    my $subs = $c->config->{ 'Plugin::ConfigLoader' }->{ substitutions } || {};
-    $subs->{ HOME } ||= sub { shift->path_to( '' ); };
+    my $c    = shift;
+    my $subs = $c->config->{ 'Plugin::ConfigLoader' }->{ substitutions }
+        || {};
+    $subs->{ HOME }    ||= sub { shift->path_to( '' ); };
     $subs->{ path_to } ||= sub { shift->path_to( @_ ); };
     $subs->{ literal } ||= sub { return $_[ 1 ]; };
     my $subsre = join( '|', keys %$subs );
@@ -297,7 +319,6 @@ sub config_substitutions {
     }
 }
 
-
 =head1 AUTHOR
 
 Brian Cassidy E<lt>bricas@cpan.orgE<gt>
@@ -325,7 +346,7 @@ Work to this module has been generously sponsored by:
 
 =head1 COPYRIGHT AND LICENSE
 
-Copyright 2007 by Brian Cassidy
+Copyright 2008 by Brian Cassidy
 
 This library is free software; you can redistribute it and/or modify
 it under the same terms as Perl itself.