Show actual parse errors
[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;
92c29326 162 warn $@ if $@;
a918b0b8 163
164 for my $filename ( @{ $args->{ files } } ) {
72628dc7 165
a918b0b8 166 # don't even bother if it's not there
167 next unless -f $filename;
168
169 my @try_plugins = @plugins;
41f47406 170
72628dc7 171 if ( $use_ext_lut ) {
a918b0b8 172 $filename =~ m{\.($extension_re)\z};
173 next unless $1;
174 @try_plugins = $extension_lut{ $1 };
175 }
176
177 for my $loader ( @try_plugins ) {
ade8c46e 178 next unless $loader->is_supported;
72628dc7 179 my @configs
180 = eval { $loader->load( $filename, $loader_args{ $loader } ); };
41f47406 181
a918b0b8 182 # fatal error if we used extension matching
92c29326 183 croak "Error parsing $filename: $@" if $@ and $use_ext_lut;
a918b0b8 184 next if $@ or !@configs;
185
186 # post-process config with a filter callback
187 if ( $args->{ filter } ) {
188 $args->{ filter }->( $_ ) for @configs;
189 }
41f47406 190
72628dc7 191 push @results,
192 { $filename => @configs == 1 ? $configs[ 0 ] : \@configs };
a918b0b8 193 last;
c80a0905 194 }
195 }
7c218182 196
a918b0b8 197 return \@results;
c80a0905 198}
199
59a80452 200=head2 finder( )
201
202The C<finder()> classmethod returns the
203L<Module::Pluggable::Object|Module::Pluggable::Object>
204object which is used to load the plugins. See the documentation for that module for
205more information.
206
207=cut
208
c80a0905 209sub finder {
92a04e78 210 my $class = shift;
c80a0905 211 my $finder = Module::Pluggable::Object->new(
212 search_path => [ __PACKAGE__ ],
213 require => 1
214 );
bef9e9a5 215 return $finder;
c80a0905 216}
217
59a80452 218=head2 plugins( )
219
220The C<plugins()> classmethod returns the names of configuration loading plugins as
221found by L<Module::Pluggable::Object|Module::Pluggable::Object>.
222
223=cut
224
c80a0905 225sub plugins {
226 my $class = shift;
227 return $class->finder->plugins;
228}
229
59a80452 230=head2 extensions( )
c80a0905 231
59a80452 232The C<extensions()> classmethod returns the possible file extensions which can be loaded
233by C<load_stems()> and C<load_files()>. This may be useful if you set the C<use_ext>
234parameter to those methods.
c80a0905 235
59a80452 236=cut
c80a0905 237
59a80452 238sub extensions {
239 my $class = shift;
240 my @ext = map { $_->extensions } $class->plugins;
4efab558 241 return wantarray ? @ext : \@ext;
59a80452 242}
c80a0905 243
244=head1 DIAGNOSTICS
245
c80a0905 246=over
247
7c218182 248=item C<No files specified!> or C<No stems specified!>
c80a0905 249
59a80452 250The C<load_files()> and C<load_stems()> methods will issue this warning if
251called with an empty list of files/stems to load.
c80a0905 252
59a80452 253=item C<_load requires a arrayref of file paths>
c80a0905 254
59a80452 255This fatal error will be thrown by the internal C<_load> method. It should not occur
256but is specified here for completeness. If your code dies with this error, please
257email a failing test case to the authors below.
c80a0905 258
259=back
260
c80a0905 261=head1 CONFIGURATION AND ENVIRONMENT
262
c80a0905 263Config::Any requires no configuration files or environment variables.
264
c80a0905 265=head1 DEPENDENCIES
266
59a80452 267L<Module::Pluggable|Module::Pluggable>
c80a0905 268
59a80452 269And at least one of the following:
270L<Config::General|Config::General>
271L<Config::Tiny|Config::Tiny>
272L<JSON|JSON>
273L<YAML|YAML>
274L<JSON::Syck|JSON::Syck>
275L<YAML::Syck|YAML::Syck>
276L<XML::Simple|XML::Simple>
c80a0905 277
278=head1 INCOMPATIBILITIES
279
c80a0905 280None reported.
281
c80a0905 282=head1 BUGS AND LIMITATIONS
283
c80a0905 284No bugs have been reported.
285
286Please report any bugs or feature requests to
287C<bug-config-any@rt.cpan.org>, or through the web interface at
288L<http://rt.cpan.org>.
289
c80a0905 290=head1 AUTHOR
291
f0e3c221 292Joel Bernstein E<lt>rataxis@cpan.orgE<gt>
c80a0905 293
59a80452 294=head1 CONTRIBUTORS
295
296This module was based on the original
297L<Catalyst::Plugin::ConfigLoader|Catalyst::Plugin::ConfigLoader>
298module by Brian Cassidy C<< <bricas@cpan.org> >>.
299
300With ideas and support from Matt S Trout C<< <mst@shadowcatsystems.co.uk> >>.
c80a0905 301
41f47406 302Further enhancements suggested by Evan Kaufman C<< <evank@cpan.org> >>.
303
c80a0905 304=head1 LICENCE AND COPYRIGHT
305
306Copyright (c) 2006, Portugal Telecom C<< http://www.sapo.pt/ >>. All rights reserved.
41f47406 307Portions copyright 2007, Joel Bernstein C<< <rataxis@cpan.org> >>.
c80a0905 308
309This module is free software; you can redistribute it and/or
310modify it under the same terms as Perl itself. See L<perlartistic>.
311
c80a0905 312=head1 DISCLAIMER OF WARRANTY
313
314BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
315FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
316OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
317PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER
318EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
319WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE
320ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH
321YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL
322NECESSARY SERVICING, REPAIR, OR CORRECTION.
323
324IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
325WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
326REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE
327LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL,
328OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE
329THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
330RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
331FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
332SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
333SUCH DAMAGES.
59a80452 334
335=head1 SEE ALSO
336
337L<Catalyst::Plugin::ConfigLoader|Catalyst::Plugin::ConfigLoader>
338-- now a wrapper around this module.
339
340=cut
341
41f47406 342"Drink more beer";