File Coverage

blib/lib/Debian/Copyright/Stanza/Files.pm
Criterion Covered Total %
statement 14 14 100.0
branch n/a
condition n/a
subroutine 5 5 100.0
pod 1 1 100.0
total 20 20 100.0


line stmt bran cond sub pod time code
1             =head1 NAME
2              
3             Debian::Copyright::Stanza::Files - Files stanza of Debian copyright file
4              
5             =head1 VERSION
6              
7             This document describes Debian::Copyright::Stanza::Files version 0.2 .
8              
9             =head1 SYNOPSIS
10              
11             my $copy = Debian::Copyright::Stanza::Files->new(\%data);
12             print $copy; # auto-stringification
13              
14             =head1 DESCRIPTION
15              
16             Debian::Copyright::Stanza::Files can be used for representation and
17             manipulation of a C stanza of Debian copyright files in an
18             object-oriented way. Converts itself to a textual representation in string
19             context.
20              
21             =head1 FIELDS
22              
23             The supported fields for Files stanzas are listed below.
24              
25             Note that real copyright fields may contain dashes in their names. These are
26             replaced with underscores.
27              
28             =over
29              
30             =item Files
31              
32             =item License
33              
34             =item Copyright
35              
36             =item Comment
37              
38             =back
39              
40             =cut
41              
42             package Debian::Copyright::Stanza::Files;
43             require v5.10.1;
44 3     3   18 use strict;
  3         7  
  3         119  
45 3     3   17 use warnings;
  3         5  
  3         103  
46 3     3   16 use base qw(Debian::Copyright::Stanza);
  3         5  
  3         280  
47 3         329 use constant fields => qw (
48             Files Copyright License Comment
49 3     3   15 );
  3         6  
50              
51             our $VERSION = '0.2';
52              
53             =head1 CONSTRUCTOR
54              
55             =head2 new( { field => value, ... } )
56              
57             Creates a new L object and optionally
58             initialises it with the supplied data.
59              
60             =head1 METHODS
61              
62             =head2 is_or_separated($field)
63              
64             Returns true for the C field.
65              
66             =cut
67              
68             sub is_or_separated {
69 143     143 1 194 my( $self, $field ) = @_;
70 143         402 return $field eq 'License';
71             }
72              
73              
74             =head1 SEE ALSO
75              
76             Debian::Copyright::Stanza::Files inherits most of its functionality from
77             L
78              
79             =head1 COPYRIGHT & LICENSE
80              
81             Copyright (C) 2011-12 Nicholas Bamber L
82              
83             This module is substantially based upon L.
84             Copyright (C) 2009 Damyan Ivanov L
85              
86             This program is free software; you can redistribute it and/or modify it under
87             the terms of the GNU General Public License version 2 as published by the Free
88             Software Foundation.
89              
90             This program is distributed in the hope that it will be useful, but WITHOUT ANY
91             WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
92             PARTICULAR PURPOSE.
93              
94             =cut
95              
96             1;