remove eval so the Perl loader dies on invalid content.
[p5sagit/Config-Any.git] / lib / Config / Any.pm
CommitLineData
c80a0905 1package Config::Any;
92a04e78 2
c80a0905 3use strict;
92a04e78 4use warnings;
5
c80a0905 6use Carp;
7use Module::Pluggable::Object ();
59a80452 8
8af0a7cf 9our $VERSION = '0.12';
c80a0905 10
59a80452 11=head1 NAME
12
13Config::Any - Load configuration from different file formats, transparently
14
59a80452 15=head1 SYNOPSIS
16
17 use Config::Any;
18
f0e3c221 19 my $cfg = Config::Any->load_stems({stems => \@filepath_stems, ... });
20 # or
21 my $cfg = Config::Any->load_files({files => \@filepaths, ... });
59a80452 22
f0e3c221 23 for (@$cfg) {
0c6989c6 24 my ($filename, $config) = %$_;
f0e3c221 25 $class->config($config);
26 warn "loaded config from file: $filename";
27 }
59a80452 28
29=head1 DESCRIPTION
30
31L<Config::Any|Config::Any> provides a facility for Perl applications and libraries
32to load configuration data from multiple different file formats. It supports XML, YAML,
33JSON, Apache-style configuration, Windows INI files, and even Perl code.
34
35The rationale for this module is as follows: Perl programs are deployed on many different
36platforms and integrated with many different systems. Systems administrators and end
37users may prefer different configuration formats than the developers. The flexibility
38inherent in a multiple format configuration loader allows different users to make
39different choices, without generating extra work for the developers. As a developer
40you only need to learn a single interface to be able to use the power of different
41configuration formats.
42
43=head1 INTERFACE
44
45=cut
46
7c218182 47=head2 load_files( \%args )
59a80452 48
4efab558 49 Config::Any->load_files( { files => \@files } );
50 Config::Any->load_files( { files => \@files, filter => \&filter } );
51 Config::Any->load_files( { files => \@files, use_ext => 1 } );
59a80452 52
53C<load_files()> attempts to load configuration from the list of files passed in
54the C<files> parameter, if the file exists.
55
56If the C<filter> parameter is set, it is used as a callback to modify the configuration
57data before it is returned. It will be passed a single hash-reference parameter which
58it should modify in-place.
59
60If the C<use_ext> parameter is defined, the loader will attempt to parse the file
61extension from each filename and will skip the file unless it matches a standard
62extension for the loading plugins. Only plugins whose standard extensions match the
63file extension will be used. For efficiency reasons, its use is encouraged, but
64be aware that you will lose flexibility -- for example, a file called C<myapp.cfg>
65containing YAML data will not be offered to the YAML plugin, whereas C<myapp.yml>
66or C<myapp.yaml> would be.
67
41f47406 68C<load_files()> also supports a 'force_plugins' parameter, whose value should be an
69arrayref of plugin names like C<Config::Any::INI>. Its intended use is to allow the use
70of a non-standard file extension while forcing it to be offered to a particular parser.
71It is not compatible with 'use_ext'.
72
ef87b7dc 73You can supply a C<driver_args> hashref to pass special options to a particular
74parser object. Example:
75
76 Config::Any->load_files( { files => \@files, driver_args => {
77 General => { -LowerCaseNames => 1 }
78 } )
79
59a80452 80=cut
81
c80a0905 82sub load_files {
92a04e78 83 my ( $class, $args ) = @_;
4efab558 84
85 unless ( $args && exists $args->{ files } ) {
86 warn "No files specified!";
59a80452 87 return;
88 }
89
4efab558 90 return $class->_load( $args );
c80a0905 91}
92
7c218182 93=head2 load_stems( \%args )
59a80452 94
bef9e9a5 95 Config::Any->load_stems( { stems => \@stems } );
96 Config::Any->load_stems( { stems => \@stems, filter => \&filter } );
97 Config::Any->load_stems( { stems => \@stems, use_ext => 1 } );
59a80452 98
99C<load_stems()> attempts to load configuration from a list of files which it generates
100by combining the filename stems list passed in the C<stems> parameter with the
101potential filename extensions from each loader, which you can check with the
102C<extensions()> classmethod described below. Once this list of possible filenames is
103built it is treated exactly as in C<load_files()> above, as which it takes the same
104parameters. Please read the C<load_files()> documentation before using this method.
105
106=cut
107
c80a0905 108sub load_stems {
92a04e78 109 my ( $class, $args ) = @_;
bef9e9a5 110
111 unless ( $args && exists $args->{ stems } ) {
112 warn "No stems specified!";
59a80452 113 return;
114 }
92a04e78 115
bef9e9a5 116 my $stems = delete $args->{ stems };
c80a0905 117 my @files;
92a04e78 118 for my $s ( @$stems ) {
92a04e78 119 for my $ext ( $class->extensions ) {
4efab558 120 push @files, "$s.$ext";
c80a0905 121 }
122 }
c80a0905 123
bef9e9a5 124 $args->{ files } = \@files;
125 return $class->_load( $args );
126}
41f47406 127
c80a0905 128sub _load {
92a04e78 129 my ( $class, $args ) = @_;
a918b0b8 130 croak "_load requires a arrayref of file paths" unless $args->{ files };
131
c84f1613 132 my $force = defined $args->{ force_plugins };
133 if ( !$force and !defined $args->{ use_ext } ) {
72628dc7 134 warn
135 "use_ext argument was not explicitly set, as of 0.09, this is true by default";
a918b0b8 136 $args->{ use_ext } = 1;
137 }
138
139 # figure out what plugins we're using
ade8c46e 140 my @plugins = $force ? @{ $args->{ force_plugins } } : $class->plugins;
a918b0b8 141
142 # map extensions if we have to
72628dc7 143 my ( %extension_lut, $extension_re );
a918b0b8 144 my $use_ext_lut = !$force && $args->{ use_ext };
72628dc7 145 if ( $use_ext_lut ) {
a918b0b8 146 for my $plugin ( @plugins ) {
147 $extension_lut{ $_ } = $plugin for $plugin->extensions;
148 }
149
150 $extension_re = join( '|', keys %extension_lut );
151 }
59a80452 152
a918b0b8 153 # map args to plugins
154 my $base_class = __PACKAGE__;
155 my %loader_args;
156 for my $plugin ( @plugins ) {
157 $plugin =~ m{^$base_class\::(.+)};
158 $loader_args{ $plugin } = $args->{ driver_args }->{ $1 } || {};
159 }
160
161 my @results;
162
163 for my $filename ( @{ $args->{ files } } ) {
72628dc7 164
a918b0b8 165 # don't even bother if it's not there
166 next unless -f $filename;
167
168 my @try_plugins = @plugins;
41f47406 169
72628dc7 170 if ( $use_ext_lut ) {
a918b0b8 171 $filename =~ m{\.($extension_re)\z};
172 next unless $1;
173 @try_plugins = $extension_lut{ $1 };
174 }
175
176 for my $loader ( @try_plugins ) {
ade8c46e 177 next unless $loader->is_supported;
72628dc7 178 my @configs
179 = eval { $loader->load( $filename, $loader_args{ $loader } ); };
41f47406 180
a918b0b8 181 # fatal error if we used extension matching
182 croak "Error parsing file: $filename" if $@ and $use_ext_lut;
183 next if $@ or !@configs;
184
185 # post-process config with a filter callback
186 if ( $args->{ filter } ) {
187 $args->{ filter }->( $_ ) for @configs;
188 }
41f47406 189
72628dc7 190 push @results,
191 { $filename => @configs == 1 ? $configs[ 0 ] : \@configs };
a918b0b8 192 last;
c80a0905 193 }
194 }
7c218182 195
a918b0b8 196 return \@results;
c80a0905 197}
198
59a80452 199=head2 finder( )
200
201The C<finder()> classmethod returns the
202L<Module::Pluggable::Object|Module::Pluggable::Object>
203object which is used to load the plugins. See the documentation for that module for
204more information.
205
206=cut
207
c80a0905 208sub finder {
92a04e78 209 my $class = shift;
c80a0905 210 my $finder = Module::Pluggable::Object->new(
211 search_path => [ __PACKAGE__ ],
212 require => 1
213 );
bef9e9a5 214 return $finder;
c80a0905 215}
216
59a80452 217=head2 plugins( )
218
219The C<plugins()> classmethod returns the names of configuration loading plugins as
220found by L<Module::Pluggable::Object|Module::Pluggable::Object>.
221
222=cut
223
c80a0905 224sub plugins {
225 my $class = shift;
226 return $class->finder->plugins;
227}
228
59a80452 229=head2 extensions( )
c80a0905 230
59a80452 231The C<extensions()> classmethod returns the possible file extensions which can be loaded
232by C<load_stems()> and C<load_files()>. This may be useful if you set the C<use_ext>
233parameter to those methods.
c80a0905 234
59a80452 235=cut
c80a0905 236
59a80452 237sub extensions {
238 my $class = shift;
239 my @ext = map { $_->extensions } $class->plugins;
4efab558 240 return wantarray ? @ext : \@ext;
59a80452 241}
c80a0905 242
243=head1 DIAGNOSTICS
244
c80a0905 245=over
246
7c218182 247=item C<No files specified!> or C<No stems specified!>
c80a0905 248
59a80452 249The C<load_files()> and C<load_stems()> methods will issue this warning if
250called with an empty list of files/stems to load.
c80a0905 251
59a80452 252=item C<_load requires a arrayref of file paths>
c80a0905 253
59a80452 254This fatal error will be thrown by the internal C<_load> method. It should not occur
255but is specified here for completeness. If your code dies with this error, please
256email a failing test case to the authors below.
c80a0905 257
258=back
259
c80a0905 260=head1 CONFIGURATION AND ENVIRONMENT
261
c80a0905 262Config::Any requires no configuration files or environment variables.
263
c80a0905 264=head1 DEPENDENCIES
265
59a80452 266L<Module::Pluggable|Module::Pluggable>
c80a0905 267
59a80452 268And at least one of the following:
269L<Config::General|Config::General>
270L<Config::Tiny|Config::Tiny>
271L<JSON|JSON>
272L<YAML|YAML>
273L<JSON::Syck|JSON::Syck>
274L<YAML::Syck|YAML::Syck>
275L<XML::Simple|XML::Simple>
c80a0905 276
277=head1 INCOMPATIBILITIES
278
c80a0905 279None reported.
280
c80a0905 281=head1 BUGS AND LIMITATIONS
282
c80a0905 283No bugs have been reported.
284
285Please report any bugs or feature requests to
286C<bug-config-any@rt.cpan.org>, or through the web interface at
287L<http://rt.cpan.org>.
288
c80a0905 289=head1 AUTHOR
290
f0e3c221 291Joel Bernstein E<lt>rataxis@cpan.orgE<gt>
c80a0905 292
59a80452 293=head1 CONTRIBUTORS
294
295This module was based on the original
296L<Catalyst::Plugin::ConfigLoader|Catalyst::Plugin::ConfigLoader>
297module by Brian Cassidy C<< <bricas@cpan.org> >>.
298
299With ideas and support from Matt S Trout C<< <mst@shadowcatsystems.co.uk> >>.
c80a0905 300
41f47406 301Further enhancements suggested by Evan Kaufman C<< <evank@cpan.org> >>.
302
c80a0905 303=head1 LICENCE AND COPYRIGHT
304
305Copyright (c) 2006, Portugal Telecom C<< http://www.sapo.pt/ >>. All rights reserved.
41f47406 306Portions copyright 2007, Joel Bernstein C<< <rataxis@cpan.org> >>.
c80a0905 307
308This module is free software; you can redistribute it and/or
309modify it under the same terms as Perl itself. See L<perlartistic>.
310
c80a0905 311=head1 DISCLAIMER OF WARRANTY
312
313BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
314FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
315OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
316PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER
317EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
318WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE
319ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH
320YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL
321NECESSARY SERVICING, REPAIR, OR CORRECTION.
322
323IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
324WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
325REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE
326LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL,
327OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE
328THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
329RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
330FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
331SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
332SUCH DAMAGES.
59a80452 333
334=head1 SEE ALSO
335
336L<Catalyst::Plugin::ConfigLoader|Catalyst::Plugin::ConfigLoader>
337-- now a wrapper around this module.
338
339=cut
340
41f47406 341"Drink more beer";