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             # ABSTRACT: a config class that Config::MVP::Reader::Finder can find
3             $Config::MVP::Reader::Findable::VERSION = '2.200012';
4 1     1   809 use Moose::Role;
  1         4  
  1         7  
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   5382 no Moose::Role;
  1         2  
  1         5  
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.200012
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 METHODS
47              
48             =head2 refined_location
49              
50             This method is used to decide whether a Findable reader can read a specific
51             thing under the C<$location> argument passed to C<read_config>. The location
52             could be a directory or base file name or dbh or almost anything else. This
53             method will return false if it can't find anything to read. If it can find
54             something to read, it will return a new (or unchanged) value for C<$location>
55             to be used in reading the config.
56              
57             =head1 AUTHOR
58              
59             Ricardo Signes <rjbs@cpan.org>
60              
61             =head1 COPYRIGHT AND LICENSE
62              
63             This software is copyright (c) 2021 by Ricardo Signes.
64              
65             This is free software; you can redistribute it and/or modify it under
66             the same terms as the Perl 5 programming language system itself.
67              
68             =cut