6 use Module::Pluggable::Object ();
7 use English qw(-no_match_vars);
9 our $VERSION = '0.06_01';
13 Config::Any - Load configuration from different file formats, transparently
17 This document describes Config::Any version 0.0.5
23 my $cfg = Config::Any->load_stems({stems => \@filepath_stems, ... });
25 my $cfg = Config::Any->load_files({files => \@filepaths, ... });
28 my ($filename, $config) = each %$_;
29 $class->config($config);
30 warn "loaded config from file: $filename";
35 L<Config::Any|Config::Any> provides a facility for Perl applications and libraries
36 to load configuration data from multiple different file formats. It supports XML, YAML,
37 JSON, Apache-style configuration, Windows INI files, and even Perl code.
39 The rationale for this module is as follows: Perl programs are deployed on many different
40 platforms and integrated with many different systems. Systems administrators and end
41 users may prefer different configuration formats than the developers. The flexibility
42 inherent in a multiple format configuration loader allows different users to make
43 different choices, without generating extra work for the developers. As a developer
44 you only need to learn a single interface to be able to use the power of different
45 configuration formats.
53 Config::Any->load_files({files => \@files]});
54 Config::Any->load_files({files => \@files, filter => \&filter});
55 Config::Any->load_files({files => \@files, use_ext => 1});
57 C<load_files()> attempts to load configuration from the list of files passed in
58 the C<files> parameter, if the file exists.
60 If the C<filter> parameter is set, it is used as a callback to modify the configuration
61 data before it is returned. It will be passed a single hash-reference parameter which
62 it should modify in-place.
64 If the C<use_ext> parameter is defined, the loader will attempt to parse the file
65 extension from each filename and will skip the file unless it matches a standard
66 extension for the loading plugins. Only plugins whose standard extensions match the
67 file extension will be used. For efficiency reasons, its use is encouraged, but
68 be aware that you will lose flexibility -- for example, a file called C<myapp.cfg>
69 containing YAML data will not be offered to the YAML plugin, whereas C<myapp.yml>
70 or C<myapp.yaml> would be.
72 C<load_files()> also supports a 'force_plugins' parameter, whose value should be an
73 arrayref of plugin names like C<Config::Any::INI>. Its intended use is to allow the use
74 of a non-standard file extension while forcing it to be offered to a particular parser.
75 It is not compatible with 'use_ext'.
80 my ($class, $args) = @_;
81 return unless defined $args;
82 unless (exists $args->{files}) {
83 warn "no files specified";
87 my %load_args = map { $_ => defined $args->{$_} ? $args->{$_} : undef }
88 qw(filter use_ext force_plugins);
89 $load_args{files} = [ grep { -f $_ } @{$args->{files}} ];
90 return $class->_load(\%load_args);
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});
99 C<load_stems()> attempts to load configuration from a list of files which it generates
100 by combining the filename stems list passed in the C<stems> parameter with the
101 potential filename extensions from each loader, which you can check with the
102 C<extensions()> classmethod described below. Once this list of possible filenames is
103 built it is treated exactly as in C<load_files()> above, as which it takes the same
104 parameters. Please read the C<load_files()> documentation before using this method.
109 my ($class, $args) = @_;
110 return unless defined $args;
111 unless (exists $args->{stems}) {
112 warn "no stems specified";
116 my %load_args = map { $_ => defined $args->{$_} ? $args->{$_} : undef }
117 qw(filter use_ext force_plugins);
119 my $filenames = $class->_stems_to_files($args->{stems});
120 $load_args{files} = [ grep { -f $_ } @{$filenames} ];
121 return $class->_load(\%load_args);
124 sub _stems_to_files {
125 my ($class, $stems) = @_;
126 return unless defined $stems;
130 for my $s (@$stems) {
132 for my $ext ($class->extensions) {
133 my $file = "$s.$ext";
134 next EXT unless -f $file;
142 sub _maphash (@) { map { $_ => 1 } @_ } # sugar
144 # this is where we do the real work
145 # it's a private class-method because users should use the interface described
148 my ($class, $args) = @_;
149 my ($files_ref, $filter_cb, $use_ext, $force_plugins_ref) =
150 @{$args}{qw(files filter use_ext force_plugins)};
151 croak "_load requires a arrayref of file paths" unless defined $files_ref;
153 my %files = _maphash @$files_ref;
154 my %force_plugins = _maphash @$force_plugins_ref;
155 my $enforcing = keys %force_plugins ? 1 : 0;
157 my $final_configs = [];
158 my $originally_loaded = {};
160 # perform a separate file loop for each loader
161 for my $loader ( $class->plugins ) {
162 next if $enforcing && not defined $force_plugins{$loader};
163 last unless keys %files;
164 my %ext = _maphash $loader->extensions;
167 for my $filename (keys %files) {
168 # use file extension to decide whether this loader should try this file
169 # use_ext => 1 hits this block
170 if (defined $use_ext && !$enforcing) {
173 for my $e (keys %ext) {
174 next EXT unless $filename =~ m{ \. $e \z }xms;
175 next FILE unless exists $ext{$e};
179 next FILE unless $matched_ext;
184 $config = $loader->load( $filename );
187 next if $EVAL_ERROR; # if it croaked or warned, we can't use it
189 delete $files{$filename};
191 # post-process config with a filter callback, if we got one
192 $filter_cb->( $config ) if defined $filter_cb;
194 push @$final_configs, { $filename => $config };
202 The C<finder()> classmethod returns the
203 L<Module::Pluggable::Object|Module::Pluggable::Object>
204 object which is used to load the plugins. See the documentation for that module for
211 my $finder = Module::Pluggable::Object->new(
212 search_path => [ __PACKAGE__ ],
220 The C<plugins()> classmethod returns the names of configuration loading plugins as
221 found by L<Module::Pluggable::Object|Module::Pluggable::Object>.
227 return $class->finder->plugins;
232 The C<extensions()> classmethod returns the possible file extensions which can be loaded
233 by C<load_stems()> and C<load_files()>. This may be useful if you set the C<use_ext>
234 parameter to those methods.
240 my @ext = map { $_->extensions } $class->plugins;
241 return wantarray ? @ext : [@ext];
248 =item C<no files specified> or C<no stems specified>
250 The C<load_files()> and C<load_stems()> methods will issue this warning if
251 called with an empty list of files/stems to load.
253 =item C<_load requires a arrayref of file paths>
255 This fatal error will be thrown by the internal C<_load> method. It should not occur
256 but is specified here for completeness. If your code dies with this error, please
257 email a failing test case to the authors below.
261 =head1 CONFIGURATION AND ENVIRONMENT
263 Config::Any requires no configuration files or environment variables.
267 L<Module::Pluggable|Module::Pluggable>
269 And at least one of the following:
270 L<Config::General|Config::General>
271 L<Config::Tiny|Config::Tiny>
274 L<JSON::Syck|JSON::Syck>
275 L<YAML::Syck|YAML::Syck>
276 L<XML::Simple|XML::Simple>
278 =head1 INCOMPATIBILITIES
282 =head1 BUGS AND LIMITATIONS
284 No bugs have been reported.
286 Please report any bugs or feature requests to
287 C<bug-config-any@rt.cpan.org>, or through the web interface at
288 L<http://rt.cpan.org>.
292 Joel Bernstein C<< <rataxis@cpan.org> >>
296 This module was based on the original
297 L<Catalyst::Plugin::ConfigLoader|Catalyst::Plugin::ConfigLoader>
298 module by Brian Cassidy C<< <bricas@cpan.org> >>.
300 With ideas and support from Matt S Trout C<< <mst@shadowcatsystems.co.uk> >>.
302 Further enhancements suggested by Evan Kaufman C<< <evank@cpan.org> >>.
304 =head1 LICENCE AND COPYRIGHT
306 Copyright (c) 2006, Portugal Telecom C<< http://www.sapo.pt/ >>. All rights reserved.
307 Portions copyright 2007, Joel Bernstein C<< <rataxis@cpan.org> >>.
309 This module is free software; you can redistribute it and/or
310 modify it under the same terms as Perl itself. See L<perlartistic>.
312 =head1 DISCLAIMER OF WARRANTY
314 BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
315 FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
316 OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
317 PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER
318 EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
319 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE
320 ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH
321 YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL
322 NECESSARY SERVICING, REPAIR, OR CORRECTION.
324 IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
325 WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
326 REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE
327 LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL,
328 OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE
329 THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
330 RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
331 FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
332 SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
337 L<Catalyst::Plugin::ConfigLoader|Catalyst::Plugin::ConfigLoader>
338 -- now a wrapper around this module.