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=4f9b40113f90dad15e147a473290e774792c7745;hp=d097776740f4cd52374ffbe04083cda79eb06b92;hb=4efab5582d1ec3acd99a2ffb898bed58d5f2420b;hpb=89706e8e580604123ebf0930c88286eabb2c3d09 diff --git a/lib/Config/Any.pm b/lib/Config/Any.pm index d097776..4f9b401 100644 --- a/lib/Config/Any.pm +++ b/lib/Config/Any.pm @@ -1,12 +1,13 @@ 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 @@ -14,21 +15,21 @@ Config::Any - Load configuration from different file formats, transparently =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 @@ -50,9 +51,9 @@ configuration formats. =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 attempts to load configuration from the list of files passed in the C parameter, if the file exists. @@ -69,20 +70,29 @@ be aware that you will lose flexibility -- for example, a file called C or C would be. +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. +It is not compatible with 'use_ext'. + +You can supply a C 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( ) @@ -101,70 +111,91 @@ parameters. Please read the C documentation before using this meth =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 }; } } @@ -181,7 +212,7 @@ more information. =cut sub finder { - my $class = shift; + my $class = shift; my $finder = Module::Pluggable::Object->new( search_path => [ __PACKAGE__ ], require => 1 @@ -212,7 +243,7 @@ parameter to those methods. sub extensions { my $class = shift; my @ext = map { $_->extensions } $class->plugins; - return wantarray ? @ext : [@ext]; + return wantarray ? @ext : \@ext; } =head1 DIAGNOSTICS @@ -263,7 +294,7 @@ L. =head1 AUTHOR -Joel Bernstein C<< >> +Joel Bernstein Erataxis@cpan.orgE =head1 CONTRIBUTORS @@ -273,9 +304,12 @@ module by Brian Cassidy C<< >>. With ideas and support from Matt S Trout C<< >>. +Further enhancements suggested by Evan Kaufman C<< >>. + =head1 LICENCE AND COPYRIGHT Copyright (c) 2006, Portugal Telecom C<< http://www.sapo.pt/ >>. All rights reserved. +Portions copyright 2007, Joel Bernstein C<< >>. This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See L. @@ -310,5 +344,4 @@ L =cut -1; # Magic true value required at end of module - +"Drink more beer";