File Coverage

blib/lib/Config/MVP/Reader/Findable.pm
Criterion Covered Total %
statement 6 6 100.0
branch n/a
condition n/a
subroutine 2 2 100.0
pod n/a
total 8 8 100.0


line stmt bran cond sub pod time code
1             package Config::MVP::Reader::Findable 2.200013;
2             # ABSTRACT: a config class that Config::MVP::Reader::Finder can find
3              
4 1     1   535 use Moose::Role;
  1         2  
  1         6  
5              
6             #pod =head1 DESCRIPTION
7             #pod
8             #pod Config::MVP::Reader::Findable is a role meant to be composed alongside
9             #pod Config::MVP::Reader.
10             #pod
11             #pod =method refined_location
12             #pod
13             #pod This method is used to decide whether a Findable reader can read a specific
14             #pod thing under the C<$location> argument passed to C<read_config>. The location
15             #pod could be a directory or base file name or dbh or almost anything else. This
16             #pod method will return false if it can't find anything to read. If it can find
17             #pod something to read, it will return a new (or unchanged) value for C<$location>
18             #pod to be used in reading the config.
19             #pod
20             #pod =cut
21              
22             requires 'refined_location';
23              
24 1     1   4133 no Moose::Role;
  1         2  
  1         3  
25             1;
26              
27             __END__
28              
29             =pod
30              
31             =encoding UTF-8
32              
33             =head1 NAME
34              
35             Config::MVP::Reader::Findable - a config class that Config::MVP::Reader::Finder can find
36              
37             =head1 VERSION
38              
39             version 2.200013
40              
41             =head1 DESCRIPTION
42              
43             Config::MVP::Reader::Findable is a role meant to be composed alongside
44             Config::MVP::Reader.
45              
46             =head1 PERL VERSION
47              
48             This module should work on any version of perl still receiving updates from
49             the Perl 5 Porters. This means it should work on any version of perl released
50             in the last two to three years. (That is, if the most recently released
51             version is v5.40, then this module should work on both v5.40 and v5.38.)
52              
53             Although it may work on older versions of perl, no guarantee is made that the
54             minimum required version will not be increased. The version may be increased
55             for any reason, and there is no promise that patches will be accepted to lower
56             the minimum required perl.
57              
58             =head1 METHODS
59              
60             =head2 refined_location
61              
62             This method is used to decide whether a Findable reader can read a specific
63             thing under the C<$location> argument passed to C<read_config>. The location
64             could be a directory or base file name or dbh or almost anything else. This
65             method will return false if it can't find anything to read. If it can find
66             something to read, it will return a new (or unchanged) value for C<$location>
67             to be used in reading the config.
68              
69             =head1 AUTHOR
70              
71             Ricardo Signes <cpan@semiotic.systems>
72              
73             =head1 COPYRIGHT AND LICENSE
74              
75             This software is copyright (c) 2022 by Ricardo Signes.
76              
77             This is free software; you can redistribute it and/or modify it under
78             the same terms as the Perl 5 programming language system itself.
79              
80             =cut