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
|
# $Id: Output.pm 1179 2006-08-05 08:30:57Z warly $
package Youri::Check::Output;
=head1 NAME
Youri::Check::Output - Abstract output plugin
=head1 DESCRIPTION
This abstract class defines output plugin interface.
=cut
use warnings;
use strict;
use Carp;
use Youri::Utils;
=head1 CLASS METHODS
=head2 new(%args)
Creates and returns a new Youri::Check::Output object.
Generic parameters (subclasses may define additional ones):
=over
=item global true/false
Global reports generation (default: true).
=item individual true/false
Individual reports generation (default: true).
=back
Warning: do not call directly, call subclass constructor instead.
=cut
sub new {
my $class = shift;
croak "Abstract class" if $class eq __PACKAGE__;
my %options = (
id => '',
test => 0,
verbose => 0,
global => 1,
individual => 1,
config => undef,
@_
);
croak "Neither global nor individual reporting selected" unless $options{global} || $options{individual};
my $self = bless {
_id => $options{id},
_test => $options{test},
_verbose => $options{verbose},
_global => $options{global},
_individual => $options{individual},
_config => $options{config}
}, $class;
$self->_init(%options);
return $self;
}
sub _init {
# do nothing
}
=head1 INSTANCE METHODS
=head2 get_id()
Returns plugin identity.
=cut
sub get_id {
my ($self) = @_;
croak "Not a class method" unless ref $self;
return $self->{_id};
}
=head2 run($resultset)
Reports the result stored in given L<Youri::Check::Resultset> object.
=cut
sub run {
my ($self, $resultset) = @_;
$self->_init_report();
# get types and maintainers list from resultset
my @maintainers = $resultset->get_maintainers();
my @types = $resultset->get_types();
foreach my $type (@types) {
# get formatting instructions from class
my $class = $self->{_config}->get($type . '_class');
load($class);
my @columns = $class->columns();
my %links = $class->links();
if ($self->{_global}) {
print STDERR "generating global report for $type\n" if $self->{_verbose};
$self->_global_report(
$resultset,
$type,
\@columns,
\%links
);
}
if ($self->{_individual}) {
foreach my $maintainer (@maintainers) {
print STDERR "generating individual report for $type and $maintainer\n" if $self->{_verbose};
$self->_individual_report(
$resultset,
$type,
\@columns,
\%links,
$maintainer
);
}
}
}
$self->_finish_report(\@types, \@maintainers);
}
sub _init_report {
# do nothing
}
sub _global_report {
# do nothing
}
sub _individual_report {
# do nothing
}
sub _finish_report {
# do nothing
}
=head1 SUBCLASSING
The following methods have to be implemented:
=over
=item run
As an alternative, the following hooks can be implemented:
=over
=item _init_report
=item _global_report
=item _individual_report
=item _finish_report
=back
=back
=head1 COPYRIGHT AND LICENSE
Copyright (C) 2002-2006, YOURI project
This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
=cut
1;
|
