88 lines
1.8 KiB
Perl
88 lines
1.8 KiB
Perl
package Config::Any::Base;
|
|
|
|
use strict;
|
|
use warnings;
|
|
|
|
=head1 NAME
|
|
|
|
Config::Any::Base - Base class for loaders
|
|
|
|
=head1 DESCRIPTION
|
|
|
|
This is a base class for all loaders. It currently handles the specification
|
|
of dependencies in order to ensure the subclass can load the config file
|
|
format.
|
|
|
|
=head1 METHODS
|
|
|
|
=head2 is_supported( )
|
|
|
|
Allows us to determine if the file format can be loaded. The can be done via
|
|
one of two subclass methods:
|
|
|
|
=over 4
|
|
|
|
=item * C<requires_all_of()> - returns an array of items that must all be present in order to work
|
|
|
|
=item * C<requires_any_of()> - returns an array of items in which at least one must be present
|
|
|
|
=back
|
|
|
|
You can specify a module version by passing an array reference in the return.
|
|
|
|
sub requires_all_of { [ 'My::Module', '1.1' ], 'My::OtherModule' }
|
|
|
|
Lack of specifying these subs will assume you require no extra modules to function.
|
|
|
|
=cut
|
|
|
|
sub is_supported {
|
|
my ( $class ) = shift;
|
|
local $@;
|
|
if ( $class->can( 'requires_all_of' ) ) {
|
|
return eval {
|
|
_require($_) for $class->requires_all_of;
|
|
1;
|
|
} || 0;
|
|
}
|
|
if ( $class->can( 'requires_any_of' ) ) {
|
|
eval { _require( $_ ); 1 } and return 1
|
|
for $class->requires_any_of;
|
|
return 0;
|
|
}
|
|
|
|
# requires nothing!
|
|
return 1;
|
|
}
|
|
|
|
sub _require {
|
|
my ( $input ) = shift;
|
|
my ( $module, $version ) = ( ref $input ? @$input : $input );
|
|
(my $file = "$module.pm") =~ s{::}{/}g;
|
|
require $file;
|
|
$module->VERSION if $version;
|
|
}
|
|
|
|
=head1 AUTHOR
|
|
|
|
Brian Cassidy <bricas@cpan.org>
|
|
|
|
=head1 COPYRIGHT AND LICENSE
|
|
|
|
Copyright 2008-2009 by Brian Cassidy
|
|
|
|
This library is free software; you can redistribute it and/or modify
|
|
it under the same terms as Perl itself.
|
|
|
|
=head1 SEE ALSO
|
|
|
|
=over 4
|
|
|
|
=item * L<Config::Any>
|
|
|
|
=back
|
|
|
|
=cut
|
|
|
|
1;
|