X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=p5sagit%2FConfig-Any.git;a=blobdiff_plain;f=lib%2FConfig%2FAny.pm;h=4c614d7b7828fbe926659f066902f1f03e3d0f1a;hp=55cf4c340618b2fa6c3aba5f3353dbd5f37a7dfb;hb=a86df341bff3173831af40e70e915c8ea701cacf;hpb=ade8c46e9b5c63a262f6db99c9a0d703695912b0 diff --git a/lib/Config/Any.pm b/lib/Config/Any.pm index 55cf4c3..4c614d7 100644 --- a/lib/Config/Any.pm +++ b/lib/Config/Any.pm @@ -6,16 +6,12 @@ use warnings; use Carp; use Module::Pluggable::Object (); -our $VERSION = '0.09_01'; +our $VERSION = '0.23'; =head1 NAME Config::Any - Load configuration from different file formats, transparently -=head1 VERSION - -This document describes Config::Any version 0.09 - =head1 SYNOPSIS use Config::Any; @@ -25,7 +21,7 @@ This document describes Config::Any version 0.09 my $cfg = Config::Any->load_files({files => \@filepaths, ... }); for (@$cfg) { - my ($filename, $config) = each %$_; + my ($filename, $config) = %$_; $class->config($config); warn "loaded config from file: $filename"; } @@ -53,6 +49,7 @@ configuration formats. Config::Any->load_files( { files => \@files } ); Config::Any->load_files( { files => \@files, filter => \&filter } ); Config::Any->load_files( { files => \@files, use_ext => 1 } ); + Config::Any->load_files( { files => \@files, flatten_to_hash => 1 } ); C attempts to load configuration from the list of files passed in the C parameter, if the file exists. @@ -69,6 +66,9 @@ be aware that you will lose flexibility -- for example, a file called C or C would be. +When the C parameter is defined, the loader will return a hash +keyed on the file names, as opposed to the usual list of single-key hashes. + C also supports a 'force_plugins' parameter, whose value should be an arrayref of plugin names like C. Its intended use is to allow the use of a non-standard file extension while forcing it to be offered to a particular parser. @@ -99,6 +99,7 @@ sub load_files { Config::Any->load_stems( { stems => \@stems } ); Config::Any->load_stems( { stems => \@stems, filter => \&filter } ); Config::Any->load_stems( { stems => \@stems, use_ext => 1 } ); + Config::Any->load_stems( { stems => \@stems, flatten_to_hash => 1 } ); C attempts to load configuration from a list of files which it generates by combining the filename stems list passed in the C parameter with the @@ -141,14 +142,19 @@ sub _load { } # figure out what plugins we're using - my @plugins = $force ? @{ $args->{ force_plugins } } : $class->plugins; + my @plugins = $force + ? map { eval "require $_;"; $_; } @{ $args->{ force_plugins } } + : $class->plugins; # map extensions if we have to my ( %extension_lut, $extension_re ); my $use_ext_lut = !$force && $args->{ use_ext }; if ( $use_ext_lut ) { for my $plugin ( @plugins ) { - $extension_lut{ $_ } = $plugin for $plugin->extensions; + for ( $plugin->extensions ) { + $extension_lut{ $_ } ||= []; + push @{ $extension_lut{ $_ } }, $plugin; + } } $extension_re = join( '|', keys %extension_lut ); @@ -173,17 +179,26 @@ sub _load { if ( $use_ext_lut ) { $filename =~ m{\.($extension_re)\z}; - next unless $1; - @try_plugins = $extension_lut{ $1 }; + + if ( !$1 ) { + $filename =~ m{\.([^.]+)\z}; + croak "There are no loaders available for .${1} files"; + } + + @try_plugins = @{ $extension_lut{ $1 } }; } + # not using use_ext means we try all plugins anyway, so we'll + # ignore it for the "unsupported" error + my $supported = $use_ext_lut ? 0 : 1; for my $loader ( @try_plugins ) { next unless $loader->is_supported; + $supported = 1; my @configs = eval { $loader->load( $filename, $loader_args{ $loader } ); }; # fatal error if we used extension matching - croak "Error parsing file: $filename" if $@ and $use_ext_lut; + croak "Error parsing $filename: $@" if $@ and $use_ext_lut; next if $@ or !@configs; # post-process config with a filter callback @@ -195,11 +210,35 @@ sub _load { { $filename => @configs == 1 ? $configs[ 0 ] : \@configs }; last; } + + if ( !$supported ) { + croak + "Cannot load $filename: required support modules are not available.\nPlease install " + . join( " OR ", map { _support_error( $_ ) } @try_plugins ); + } + } + + if ( defined $args->{ flatten_to_hash } ) { + my %flattened = map { %$_ } @results; + return \%flattened; } return \@results; } +sub _support_error { + my $module = shift; + if ( $module->can( 'requires_all_of' ) ) { + return join( ' and ', + map { ref $_ ? join( ' ', @$_ ) : $_ } $module->requires_all_of ); + } + if ( $module->can( 'requires_any_of' ) ) { + return 'one of ' + . join( ' or ', + map { ref $_ ? join( ' ', @$_ ) : $_ } $module->requires_any_of ); + } +} + =head2 finder( ) The C classmethod returns the @@ -213,6 +252,7 @@ sub finder { my $class = shift; my $finder = Module::Pluggable::Object->new( search_path => [ __PACKAGE__ ], + except => [ __PACKAGE__ . '::Base' ], require => 1 ); return $finder; @@ -227,7 +267,9 @@ found by L. sub plugins { my $class = shift; - return $class->finder->plugins; + + # filter out things that don't look like our plugins + return grep { $_->isa( 'Config::Any::Base' ) } $class->finder->plugins; } =head2 extensions( ) @@ -240,7 +282,8 @@ parameter to those methods. sub extensions { my $class = shift; - my @ext = map { $_->extensions } $class->plugins; + my @ext + = map { $_->extensions } $class->plugins; return wantarray ? @ext : \@ext; } @@ -292,7 +335,7 @@ L. =head1 AUTHOR -Joel Bernstein Erataxis@cpan.orgE +Joel Bernstein Erataxis@cpan.orgE =head1 CONTRIBUTORS