File Coverage

lib/Sanger/CGP/TraFiC.pm
Criterion Covered Total %
branch n/a
subroutine 3 4 75.0
pod 1 1 100.0
total 4 5 80.0


line bran sub pod code
1       package Sanger::CGP::TraFiC;
2        
3       ##########LICENCE##########
4       # Copyright (c) 2015 Genome Research Ltd.
5       #
6       # Author: Cancer Genome Project cgpit@sanger.ac.uk
7       #
8       # This file is part of TraFiC.
9       #
10       # TraFiC is free software: you can redistribute it and/or modify it under
11       # the terms of the GNU Affero General Public License as published by the Free
12       # Software Foundation; either version 3 of the License, or (at your option) any
13       # later version.
14       #
15       # This program is distributed in the hope that it will be useful, but WITHOUT
16       # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
17       # FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
18       # details.
19       #
20       # You should have received a copy of the GNU Affero General Public License
21       # along with this program. If not, see <http://www.gnu.org/licenses/>.
22       #
23       # 1. The usage of a range of years within a copyright statement contained within
24       # this distribution should be interpreted as being equivalent to a list of years
25       # including the first and last year specified and all consecutive years between
26       # them. For example, a copyright statement that reads 'Copyright (c) 2005, 2007-
27       # 2009, 2011-2012' should be interpreted as being identical to a statement that
28       # reads 'Copyright (c) 2005, 2007, 2008, 2009, 2011, 2012' and a copyright
29       # statement that reads "Copyright (c) 2005-2012' should be interpreted as being
30       # identical to a statement that reads 'Copyright (c) 2005, 2006, 2007, 2008,
31       ##########LICENCE##########
32        
33   5   use strict;
34        
35   5   use Const::Fast qw(const);
36   5   use base 'Exporter';
37       our $VERSION = '1.0.0';
38       our @EXPORT = qw($VERSION);
39        
40       const my $LICENSE =>
41       q{##########LICENCE##########
42       # Copyright (c) 2015 Genome Research Ltd.
43       #
44       # Author: Cancer Genome Project cgpit@sanger.ac.uk
45       #
46       # This file is part of TraFiC.
47       #
48       # TraFiC is free software: you can redistribute it and/or modify it under
49       # the terms of the GNU Affero General Public License as published by the Free
50       # Software Foundation; either version 3 of the License, or (at your option) any
51       # later version.
52       #
53       # This program is distributed in the hope that it will be useful, but WITHOUT
54       # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
55       # FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
56       # details.
57       #
58       # You should have received a copy of the GNU Affero General Public License
59       # along with this program. If not, see <http://www.gnu.org/licenses/>.
60       #
61       # 1. The usage of a range of years within a copyright statement contained within
62       # this distribution should be interpreted as being equivalent to a list of years
63       # including the first and last year specified and all consecutive years between
64       # them. For example, a copyright statement that reads 'Copyright (c) 2005, 2007-
65       # 2009, 2011-2012' should be interpreted as being identical to a statement that
66       # reads 'Copyright (c) 2005, 2007, 2008, 2009, 2011, 2012' and a copyright
67       # statement that reads "Copyright (c) 2005-2012' should be interpreted as being
68       # identical to a statement that reads 'Copyright (c) 2005, 2006, 2007, 2008,
69       ##########LICENCE##########};
70        
71       sub license {
72   0 1 return sprintf $LICENSE, $VERSION;
73       }
74        
75       1;
76        
77       __END__
78        
79       =head1 NAME
80        
81       Sanger::CGP::TraFiC - Base class to house version and generic functions.
82        
83       =head2 Methods
84        
85       =over 4
86        
87       =item license
88        
89       my $brief_license = Sanger::CGP::TraFiC::licence;
90        
91       Output the brief license text for use in help messages.
92        
93       =back