File Coverage

blib/lib/Renard/Incunabula/Devel/TestHelper.pm
Criterion Covered Total %
statement 9 16 56.2
branch 0 2 0.0
condition n/a
subroutine 3 3 100.0
pod n/a
total 12 21 57.1


line stmt bran cond sub pod time code
1 1     1   187623 use Renard::Incunabula::Common::Setup;
  1         3  
  1         8  
2             package Renard::Incunabula::Devel::TestHelper;
3             # ABSTRACT: A test helper with functions useful for various Renard distributions
4             $Renard::Incunabula::Devel::TestHelper::VERSION = '0.005';
5 1     1   643 use Renard::Incunabula::Common::Types qw(Dir);
  1         4  
  1         12  
6              
7 0           classmethod test_data_directory() :ReturnType(Dir) {
  0            
8 0           require Path::Tiny;
9 0           Path::Tiny->import();
10              
11 0 0         if( not defined $ENV{RENARD_TEST_DATA_PATH} ) {
12 0           die "Must set environment variable RENARD_TEST_DATA_PATH to the path for the test-data repository";
13             }
14 0           return path( $ENV{RENARD_TEST_DATA_PATH} );
15 1     1   1247 }
  1         2  
  1         9  
16              
17             1;
18              
19             __END__
20              
21             =pod
22              
23             =encoding UTF-8
24              
25             =head1 NAME
26              
27             Renard::Incunabula::Devel::TestHelper - A test helper with functions useful for various Renard distributions
28              
29             =head1 VERSION
30              
31             version 0.005
32              
33             =head1 FUNCTIONS
34              
35             =head2 test_data_directory
36              
37             Renard::Incunabula::Devel::TestHelper->test_data_directory
38              
39             Returns a L<Path::Tiny> object that points to the path defined by
40             the environment variable C<RENARD_TEST_DATA_PATH>.
41              
42             If the environment variable is not defined, throws an error.
43              
44             =head1 AUTHOR
45              
46             Project Renard
47              
48             =head1 COPYRIGHT AND LICENSE
49              
50             This software is copyright (c) 2017 by Project Renard.
51              
52             This is free software; you can redistribute it and/or modify it under
53             the same terms as the Perl 5 programming language system itself.
54              
55             =cut