File Coverage

blib/lib/Config/MVP/Reader/Findable/ByExtension.pm

Criterion	Covered	Total	%
statement	13	13	100.0
branch	1	2	50.0
condition	1	3	33.3
subroutine	4	4	100.0
pod	1	1	100.0
total	20	23	86.9

package Config::MVP::Reader::Findable::ByExtension;
# ABSTRACT: a Findable Reader that looks for files by extension
$Config::MVP::Reader::Findable::ByExtension::VERSION = '2.200012';
use Moose::Role;

with qw(Config::MVP::Reader::Findable);

use File::Spec;

#pod =method default_extension
#pod
#pod This method, B<which must be composed by classes including this role>, returns
#pod the default extension used by files in the format this reader can read.
#pod
#pod When the Finder tries to find configuration, it have a directory root and a
#pod basename.  Each (Findable) reader that it tries in turn will look for a file
#pod F<basename.extension> in the root directory.  If exactly one file is found,
#pod that file is read.
#pod
#pod =cut

requires 'default_extension';

#pod =method refined_location
#pod
#pod This role provides a default implementation of the
#pod L<C<refined_location>|Config::MVP::Reader::Findable/refined_location> method
#pod required by Config::MVP::Reader.  It will return a filename based on the
#pod original location, if a file exists matching that location plus the reader's
#pod C<default_extension>.
#pod
#pod =cut

sub refined_location {
  my ($self, $location) = @_;

  my $candidate_name = "$location." . $self->default_extension;
  return unless -r $candidate_name and -f _;
  return $candidate_name;
}

no Moose::Role;
1;

__END__

=pod

=encoding UTF-8

=head1 NAME

Config::MVP::Reader::Findable::ByExtension - a Findable Reader that looks for files by extension

=head1 VERSION

version 2.200012

=head1 METHODS

=head2 default_extension

This method, B<which must be composed by classes including this role>, returns
the default extension used by files in the format this reader can read.

When the Finder tries to find configuration, it have a directory root and a
basename.  Each (Findable) reader that it tries in turn will look for a file
F<basename.extension> in the root directory.  If exactly one file is found,
that file is read.

=head2 refined_location

This role provides a default implementation of the
L<C<refined_location>|Config::MVP::Reader::Findable/refined_location> method
required by Config::MVP::Reader.  It will return a filename based on the
original location, if a file exists matching that location plus the reader's
C<default_extension>.

=head1 AUTHOR

Ricardo Signes <[e-mail]>

=head1 COPYRIGHT AND LICENSE

This software is copyright (c) 2021 by Ricardo Signes.

This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.

=cut