7 use Module::Pluggable::Object ();
8 use English qw(-no_match_vars);
10 our $VERSION = '0.09';
14 Config::Any - Load configuration from different file formats, transparently
18 This document describes Config::Any version 0.0.8
24 my $cfg = Config::Any->load_stems({stems => \@filepath_stems, ... });
26 my $cfg = Config::Any->load_files({files => \@filepaths, ... });
29 my ($filename, $config) = each %$_;
30 $class->config($config);
31 warn "loaded config from file: $filename";
36 L<Config::Any|Config::Any> provides a facility for Perl applications and libraries
37 to load configuration data from multiple different file formats. It supports XML, YAML,
38 JSON, Apache-style configuration, Windows INI files, and even Perl code.
40 The rationale for this module is as follows: Perl programs are deployed on many different
41 platforms and integrated with many different systems. Systems administrators and end
42 users may prefer different configuration formats than the developers. The flexibility
43 inherent in a multiple format configuration loader allows different users to make
44 different choices, without generating extra work for the developers. As a developer
45 you only need to learn a single interface to be able to use the power of different
46 configuration formats.
54 Config::Any->load_files( { files => \@files } );
55 Config::Any->load_files( { files => \@files, filter => \&filter } );
56 Config::Any->load_files( { files => \@files, use_ext => 1 } );
58 C<load_files()> attempts to load configuration from the list of files passed in
59 the C<files> parameter, if the file exists.
61 If the C<filter> parameter is set, it is used as a callback to modify the configuration
62 data before it is returned. It will be passed a single hash-reference parameter which
63 it should modify in-place.
65 If the C<use_ext> parameter is defined, the loader will attempt to parse the file
66 extension from each filename and will skip the file unless it matches a standard
67 extension for the loading plugins. Only plugins whose standard extensions match the
68 file extension will be used. For efficiency reasons, its use is encouraged, but
69 be aware that you will lose flexibility -- for example, a file called C<myapp.cfg>
70 containing YAML data will not be offered to the YAML plugin, whereas C<myapp.yml>
71 or C<myapp.yaml> would be.
73 C<load_files()> also supports a 'force_plugins' parameter, whose value should be an
74 arrayref of plugin names like C<Config::Any::INI>. Its intended use is to allow the use
75 of a non-standard file extension while forcing it to be offered to a particular parser.
76 It is not compatible with 'use_ext'.
78 You can supply a C<driver_args> hashref to pass special options to a particular
79 parser object. Example:
81 Config::Any->load_files( { files => \@files, driver_args => {
82 General => { -LowerCaseNames => 1 }
88 my ( $class, $args ) = @_;
90 unless ( $args && exists $args->{ files } ) {
91 warn "No files specified!";
95 return $class->_load( $args );
100 Config::Any->load_stems({stems => \@stems]});
101 Config::Any->load_stems({stems => \@stems, filter => \&filter});
102 Config::Any->load_stems({stems => \@stems, use_ext => 1});
104 C<load_stems()> attempts to load configuration from a list of files which it generates
105 by combining the filename stems list passed in the C<stems> parameter with the
106 potential filename extensions from each loader, which you can check with the
107 C<extensions()> classmethod described below. Once this list of possible filenames is
108 built it is treated exactly as in C<load_files()> above, as which it takes the same
109 parameters. Please read the C<load_files()> documentation before using this method.
114 my ( $class, $args ) = @_;
115 return unless defined $args;
116 unless ( exists $args->{ stems } ) {
117 warn "no stems specified";
122 = map { $_ => defined $args->{ $_ } ? $args->{ $_ } : undef }
123 qw(filter use_ext force_plugins driver_args);
125 $load_args{ files } = $class->_stems_to_files( $args->{ stems } );
126 return $class->_load( \%load_args );
129 sub _stems_to_files {
130 my ( $class, $stems ) = @_;
131 return unless defined $stems;
134 for my $s ( @$stems ) {
135 for my $ext ( $class->extensions ) {
136 push @files, "$s.$ext";
142 sub _maphash { # syntactic sugar
146 # this is where we do the real work
147 # it's a private class-method because users should use the interface described
150 my ( $class, $args ) = @_;
151 my ( $files_ref, $filter_cb, $use_ext, $force_plugins_ref )
152 = @{ $args }{ qw(files filter use_ext force_plugins) };
153 croak "_load requires a arrayref of file paths" unless defined $files_ref;
155 my %files = _maphash @$files_ref;
156 my %force_plugins = _maphash @$force_plugins_ref;
157 my $enforcing = keys %force_plugins ? 1 : 0;
159 my $final_configs = [];
160 my $originally_loaded = {};
162 # perform a separate file loop for each loader
163 for my $loader ( $class->plugins ) {
164 next if $enforcing && not defined $force_plugins{ $loader };
165 last unless keys %files;
166 my %ext = _maphash $loader->extensions;
168 my ( $loader_class ) = $loader =~ /::([^:]+)$/;
169 my $driver_args = $args->{ driver_args }{ $loader_class } || {};
172 for my $filename ( keys %files ) {
173 next unless -f $filename;
175 # use file extension to decide whether this loader should try this file
176 # use_ext => 1 hits this block
177 if ( defined $use_ext && !$enforcing ) {
180 for my $e ( keys %ext ) {
181 next EXT unless $filename =~ m{ \. $e \z }xms;
182 next FILE unless exists $ext{ $e };
186 next FILE unless $matched_ext;
190 eval { $config = $loader->load( $filename, $driver_args ); };
192 next if $EVAL_ERROR; # if it croaked or warned, we can't use it
194 delete $files{ $filename };
196 # post-process config with a filter callback, if we got one
197 $filter_cb->( $config ) if defined $filter_cb;
199 push @$final_configs, { $filename => $config };
207 The C<finder()> classmethod returns the
208 L<Module::Pluggable::Object|Module::Pluggable::Object>
209 object which is used to load the plugins. See the documentation for that module for
216 my $finder = Module::Pluggable::Object->new(
217 search_path => [ __PACKAGE__ ],
225 The C<plugins()> classmethod returns the names of configuration loading plugins as
226 found by L<Module::Pluggable::Object|Module::Pluggable::Object>.
232 return $class->finder->plugins;
237 The C<extensions()> classmethod returns the possible file extensions which can be loaded
238 by C<load_stems()> and C<load_files()>. This may be useful if you set the C<use_ext>
239 parameter to those methods.
245 my @ext = map { $_->extensions } $class->plugins;
246 return wantarray ? @ext : \@ext;
253 =item C<no files specified> or C<no stems specified>
255 The C<load_files()> and C<load_stems()> methods will issue this warning if
256 called with an empty list of files/stems to load.
258 =item C<_load requires a arrayref of file paths>
260 This fatal error will be thrown by the internal C<_load> method. It should not occur
261 but is specified here for completeness. If your code dies with this error, please
262 email a failing test case to the authors below.
266 =head1 CONFIGURATION AND ENVIRONMENT
268 Config::Any requires no configuration files or environment variables.
272 L<Module::Pluggable|Module::Pluggable>
274 And at least one of the following:
275 L<Config::General|Config::General>
276 L<Config::Tiny|Config::Tiny>
279 L<JSON::Syck|JSON::Syck>
280 L<YAML::Syck|YAML::Syck>
281 L<XML::Simple|XML::Simple>
283 =head1 INCOMPATIBILITIES
287 =head1 BUGS AND LIMITATIONS
289 No bugs have been reported.
291 Please report any bugs or feature requests to
292 C<bug-config-any@rt.cpan.org>, or through the web interface at
293 L<http://rt.cpan.org>.
297 Joel Bernstein E<lt>rataxis@cpan.orgE<gt>
301 This module was based on the original
302 L<Catalyst::Plugin::ConfigLoader|Catalyst::Plugin::ConfigLoader>
303 module by Brian Cassidy C<< <bricas@cpan.org> >>.
305 With ideas and support from Matt S Trout C<< <mst@shadowcatsystems.co.uk> >>.
307 Further enhancements suggested by Evan Kaufman C<< <evank@cpan.org> >>.
309 =head1 LICENCE AND COPYRIGHT
311 Copyright (c) 2006, Portugal Telecom C<< http://www.sapo.pt/ >>. All rights reserved.
312 Portions copyright 2007, Joel Bernstein C<< <rataxis@cpan.org> >>.
314 This module is free software; you can redistribute it and/or
315 modify it under the same terms as Perl itself. See L<perlartistic>.
317 =head1 DISCLAIMER OF WARRANTY
319 BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
320 FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
321 OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
322 PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER
323 EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
324 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE
325 ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH
326 YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL
327 NECESSARY SERVICING, REPAIR, OR CORRECTION.
329 IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
330 WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
331 REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE
332 LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL,
333 OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE
334 THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
335 RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
336 FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
337 SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
342 L<Catalyst::Plugin::ConfigLoader|Catalyst::Plugin::ConfigLoader>
343 -- now a wrapper around this module.