1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
|
## ----------------------------------------------------------------------------
# cil is a Command line Issue List
# Copyright (C) 2008 Andrew Chilton
#
# This file is part of 'cil'.
#
# cil is free software: you can redistribute it and/or modify it under the
# terms of the GNU General Public License as published by the Free Software
# Foundation, either version 3 of the License, or (at your option) any later
# version.
#
# This program is distributed in the hope that it will be useful, but WITHOUT
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
# FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
# details.
#
# You should have received a copy of the GNU General Public License along with
# this program. If not, see <http://www.gnu.org/licenses/>.
#
## ----------------------------------------------------------------------------
package CIL::Issue;
use strict;
use warnings;
use Carp;
use CIL;
use CIL::Utils;
use base qw(CIL::Base);
# fields specific to Issue
__PACKAGE__->mk_accessors(qw(Summary Status AssignedTo Label Comment Attachment Description));
my @FIELDS = ( qw(Summary Status CreatedBy AssignedTo Label Comment Attachment Inserted Updated Description) );
my $cfg = {
array => {
Label => 1,
Comment => 1,
Attachment => 1,
},
};
## ----------------------------------------------------------------------------
sub new {
my ($proto, $name) = @_;
croak 'please provide an issue name'
unless defined $name;
my $class = ref $proto || $proto;
my $self = {};
bless $self, $class;
$self->set_name( $name );
$self->{data} = {
Summary => '',
Status => '',
CreatedBy => '',
AssignedTo => '',
Inserted => '',
Updated => '',
Label => [],
Comment => [],
Attachment => [],
Description => '',
};
$self->{Changed} = 0;
$self->set_inserted_now;
return $self;
}
sub prefix {
return 'i';
}
sub fields {
return \@FIELDS;
}
sub array_fields {
return $cfg->{array};
}
sub last_field {
return 'Description';
}
sub is_valid {
my ($self, $cil) = @_;
my @errors;
# issues should have a Summary
unless ( defined defined $self->Summary and length $self->Summary ) {
push @errors, 'Issue does not have a summary';
}
# see if we only allow certain Statuses
if ( $cil->StatusStrict ) {
unless ( exists $cil->StatusAllowed()->{$self->Status} ) {
push @errors, "StatusStrict is turned on but this issue has an invalid status '" . $self->Status . "'";
}
}
# see if we only allow certain Labels
if ( $cil->LabelStrict ) {
my @labels = @{$self->Labels};
foreach my $label ( @labels ) {
unless ( exists $cil->LabelAllowed()->{$label} ) {
push @errors, "LabelStrict is turned on but this issue has an invalid label '$label'";
}
}
}
$self->errors( \@errors );
return @errors ? 0 : 1;
}
sub add_label {
my ($self, $label) = @_;
croak 'provide a label when adding one'
unless defined $label;
push @{$self->{data}{Label}}, $label;
$self->flag_as_updated();
}
sub add_comment {
my ($self, $comment) = @_;
croak "can only add comments of type CIL::Comment"
unless $comment->isa( 'CIL::Comment' );
# add the comment name and set this issue's updated time
push @{$self->{data}{Comment}}, $comment->name;
$self->Updated( $comment->Updated );
$self->flag_as_updated();
}
sub add_attachment {
my ($self, $attachment) = @_;
croak "can only add attachments of type CIL::Attachment"
unless $attachment->isa( 'CIL::Attachment' );
# add the attachment name and set this issue's updated time
push @{$self->{data}{Attachment}}, $attachment->name;
$self->Updated( $attachment->Updated );
$self->flag_as_updated();
}
sub Labels {
my ($self) = @_;
return $self->{data}{Label};
}
sub Comments {
my ($self) = @_;
return $self->{data}{Comment};
}
sub Attachments {
my ($self) = @_;
return $self->{data}{Attachment};
}
sub is_open {
my ($self, $cil) = @_;
# check against the list of Open Statuses
my $open = $cil->StatusOpen();
return exists $open->{$self->Status};
}
sub is_closed {
my ($self, $cil) = @_;
# check against the list of Closed Statuses
my $closed = $cil->StatusClosed();
return exists $closed->{$self->Status};
}
sub assigned_to_email {
my ($self) = @_;
return CIL::Utils->extract_email_address( $self->AssignedTo );
}
sub created_by_email {
my ($self) = @_;
return CIL::Utils->extract_email_address( $self->CreatedBy );
}
## ----------------------------------------------------------------------------
1;
## ----------------------------------------------------------------------------
|
