package Config::Any;
-# $Id: $
-use warnings;
+
use strict;
+use warnings;
+
use Carp;
use Module::Pluggable::Object ();
use English qw(-no_match_vars);
-our $VERSION = '0.04';
+our $VERSION = '0.09';
=head1 NAME
=head1 VERSION
-This document describes Config::Any version 0.0.4
+This document describes Config::Any version 0.0.8
=head1 SYNOPSIS
use Config::Any;
- my $cfg = Config::Any->load_stems({stems => \@filepath_stems, ... });
- # or
- my $cfg = Config::Any->load_files({files => \@filepaths, ... });
+ my $cfg = Config::Any->load_stems({stems => \@filepath_stems, ... });
+ # or
+ my $cfg = Config::Any->load_files({files => \@filepaths, ... });
- for (@$cfg) {
- my ($filename, $config) = each %$_;
- $class->config($config);
- warn "loaded config from file: $filename";
- }
+ for (@$cfg) {
+ my ($filename, $config) = each %$_;
+ $class->config($config);
+ warn "loaded config from file: $filename";
+ }
=head1 DESCRIPTION
=head2 load_files( )
- 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 } );
+ Config::Any->load_files( { files => \@files, filter => \&filter } );
+ Config::Any->load_files( { files => \@files, use_ext => 1 } );
C<load_files()> attempts to load configuration from the list of files passed in
the C<files> parameter, if the file exists.
containing YAML data will not be offered to the YAML plugin, whereas C<myapp.yml>
or C<myapp.yaml> would be.
+C<load_files()> also supports a 'force_plugins' parameter, whose value should be an
+arrayref of plugin names like C<Config::Any::INI>. Its intended use is to allow the use
+of a non-standard file extension while forcing it to be offered to a particular parser.
+It is not compatible with 'use_ext'.
+
+You can supply a C<driver_args> hashref to pass special options to a particular
+parser object. Example:
+
+ Config::Any->load_files( { files => \@files, driver_args => {
+ General => { -LowerCaseNames => 1 }
+ } )
+
=cut
sub load_files {
- my ($class, $args) = @_;
- return unless defined $args;
- unless (exists $args->{files}) {
- warn "no files specified";
+ my ( $class, $args ) = @_;
+
+ unless ( $args && exists $args->{ files } ) {
+ warn "No files specified!";
return;
}
- my $files = [ grep { -f $_ } @{$args->{files}} ];
- my $filter_cb = delete $args->{filter};
- my $use_ext = delete $args->{use_ext};
- return $class->_load($files, $filter_cb, $use_ext);
+ return $class->_load( $args );
}
=head2 load_stems( )
=cut
sub load_stems {
- my ($class, $args) = @_;
+ my ( $class, $args ) = @_;
return unless defined $args;
- unless (exists $args->{stems}) {
+ unless ( exists $args->{ stems } ) {
warn "no stems specified";
return;
}
-
- my $filter_cb = delete $args->{filter};
- my $use_ext = delete $args->{use_ext};
- my $stems = $args->{stems};
+
+ my %load_args
+ = map { $_ => defined $args->{ $_ } ? $args->{ $_ } : undef }
+ qw(filter use_ext force_plugins driver_args);
+
+ $load_args{ files } = $class->_stems_to_files( $args->{ stems } );
+ return $class->_load( \%load_args );
+}
+
+sub _stems_to_files {
+ my ( $class, $stems ) = @_;
+ return unless defined $stems;
+
my @files;
- STEM:
- for my $s (@$stems) {
- EXT:
- for my $ext ($class->extensions) {
- my $file = "$s.$ext";
- next EXT unless -f $file;
- push @files, $file;
- last EXT;
+ for my $s ( @$stems ) {
+ for my $ext ( $class->extensions ) {
+ push @files, "$s.$ext";
}
}
- return $class->_load(\@files, $filter_cb, $use_ext);
+ return \@files;
}
+sub _maphash { # syntactic sugar
+ map { $_ => 1 } @_;
+}
+
# this is where we do the real work
# it's a private class-method because users should use the interface described
# in the POD.
sub _load {
- my ($class, $files_ref, $filter_cb, $use_ext) = @_;
+ my ( $class, $args ) = @_;
+ my ( $files_ref, $filter_cb, $use_ext, $force_plugins_ref )
+ = @{ $args }{ qw(files filter use_ext force_plugins) };
croak "_load requires a arrayref of file paths" unless defined $files_ref;
- my $final_configs = [];
- my $originally_loaded = {};
- my %files = map { $_ => 1 } @$files_ref;
+ my %files = _maphash @$files_ref;
+ my %force_plugins = _maphash @$force_plugins_ref;
+ my $enforcing = keys %force_plugins ? 1 : 0;
+
+ my $final_configs = [];
+ my $originally_loaded = {};
+ # perform a separate file loop for each loader
for my $loader ( $class->plugins ) {
- last unless keys %files;
-# warn "loader: $loader\n";
- my %ext = map { $_ => 1 } $loader->extensions;
- FILE:
- for my $filename (keys %files) {
- if (defined $use_ext) {
-# warn "using file extension to decide which loader to use for file $filename\n";
- my $matched_ext = 0;
- EXT:
- for my $e (keys %ext) {
-# warn "trying ext $e\n";
- next EXT unless $filename =~ m{ \. $e \z }xms;
-# warn "filename $filename matched extension $e\n";
- next FILE unless exists $ext{$e};
- $matched_ext = 1;
+ next if $enforcing && not defined $force_plugins{ $loader };
+ last unless keys %files;
+ my %ext = _maphash $loader->extensions;
+
+ my ( $loader_class ) = $loader =~ /::([^:]+)$/;
+ my $driver_args = $args->{ driver_args }{ $loader_class } || {};
+
+ FILE:
+ for my $filename ( keys %files ) {
+ next unless -f $filename;
+
+ # use file extension to decide whether this loader should try this file
+ # use_ext => 1 hits this block
+ if ( defined $use_ext && !$enforcing ) {
+ my $matched_ext = 0;
+ EXT:
+ for my $e ( keys %ext ) {
+ next EXT unless $filename =~ m{ \. $e \z }xms;
+ next FILE unless exists $ext{ $e };
+ $matched_ext = 1;
}
- next FILE unless $matched_ext;
+
+ next FILE unless $matched_ext;
}
my $config;
- eval {
- $config = $loader->load( $filename );
- };
- next if $EVAL_ERROR;
+ eval { $config = $loader->load( $filename, $driver_args ); };
+
+ next if $EVAL_ERROR; # if it croaked or warned, we can't use it
next if !$config;
- delete $files{$filename};
-# warn "loader $loader loaded file $filename\n";
+ delete $files{ $filename };
+
+ # post-process config with a filter callback, if we got one
$filter_cb->( $config ) if defined $filter_cb;
+
push @$final_configs, { $filename => $config };
}
}
=cut
sub finder {
- my $class = shift;
+ my $class = shift;
my $finder = Module::Pluggable::Object->new(
search_path => [ __PACKAGE__ ],
require => 1
sub extensions {
my $class = shift;
my @ext = map { $_->extensions } $class->plugins;
- return wantarray ? @ext : [@ext];
+ return wantarray ? @ext : \@ext;
}
=head1 DIAGNOSTICS
=head1 AUTHOR
-Joel Bernstein C<< <rataxis@cpan.org> >>
+Joel Bernstein E<lt>rataxis@cpan.orgE<gt>
=head1 CONTRIBUTORS
With ideas and support from Matt S Trout C<< <mst@shadowcatsystems.co.uk> >>.
+Further enhancements suggested by Evan Kaufman C<< <evank@cpan.org> >>.
+
=head1 LICENCE AND COPYRIGHT
Copyright (c) 2006, Portugal Telecom C<< http://www.sapo.pt/ >>. All rights reserved.
+Portions copyright 2007, Joel Bernstein C<< <rataxis@cpan.org> >>.
This module is free software; you can redistribute it and/or
modify it under the same terms as Perl itself. See L<perlartistic>.
=cut
-1; # Magic true value required at end of module
-
+"Drink more beer";
projects / p5sagit/Config-Any.git / blobdiff