summaryrefslogtreecommitdiffstats
path: root/lib/Lintian/Data/Authorities.pm
blob: fdb77cd998c1402ff1381874f894a9e63b562f2f (plain)
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
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
# Copyright (C) 2011 Niels Thykier <niels@thykier.net>
# Copyright (C) 2018 Chris Lamb <lamby@debian.org>
# Copyright (C) 2021 Felix Lechner
#
# This program 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 2 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, you can find it on the World Wide
# Web at https://www.gnu.org/copyleft/gpl.html, or write to the Free
# Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston,
# MA 02110-1301, USA.

package Lintian::Data::Authorities;

use v5.20;
use warnings;
use utf8;

use Const::Fast;

use Lintian::Data::Authority::DebconfSpecification;
use Lintian::Data::Authority::DebianPolicy;
use Lintian::Data::Authority::DeveloperReference;
use Lintian::Data::Authority::DocBaseManual;
use Lintian::Data::Authority::FilesystemHierarchy;
use Lintian::Data::Authority::JavaPolicy;
use Lintian::Data::Authority::LintianManual;
use Lintian::Data::Authority::MenuPolicy;
use Lintian::Data::Authority::MenuManual;
use Lintian::Data::Authority::NewMaintainer;
use Lintian::Data::Authority::PerlPolicy;
use Lintian::Data::Authority::PythonPolicy;
use Lintian::Data::Authority::VimPolicy;

const my $EMPTY => q{};

use Moo::Role;
use namespace::clean;

=head1 NAME

Lintian::Data::Authorities - Lintian's Reference Authorities

=head1 SYNOPSIS

 my $data = Lintian::Data->new;

=head1 DESCRIPTION

Lintian::Data::Authorities handles finding, parsing and implementation of Lintian reference authorities

=head1 INSTANCE METHODS

=over 4

=item markdown_authority_reference

=cut

sub markdown_authority_reference {
    my ($self, $volume, $section) = @_;

    my @MARKDOWN_CAPABLE = (
        $self->new_maintainer,$self->menu_policy,
        $self->perl_policy,$self->python_policy,
        $self->java_policy,$self->vim_policy,
        $self->lintian_manual,$self->developer_reference,
        $self->policy_manual,$self->debconf_specification,
        $self->menu_manual,$self->doc_base_manual,
        $self->filesystem_hierarchy_standard,
    );

    my %by_shorthand = map { $_->shorthand => $_ } @MARKDOWN_CAPABLE;

    return $EMPTY
      unless exists $by_shorthand{$volume};

    my $manual = $by_shorthand{$volume};

    return $manual->markdown_citation($section);
}

=item debconf_specification

=cut

has debconf_specification => (
    is => 'rw',
    lazy => 1,
    default => sub {
        my ($self) = @_;

        my $manual = Lintian::Data::Authority::DebconfSpecification->new;
        $manual->load($self->data_paths, $self->vendor);

        return $manual;
    }
);

=item developer_reference

=cut

has developer_reference => (
    is => 'rw',
    lazy => 1,
    default => sub {
        my ($self) = @_;

        my $manual = Lintian::Data::Authority::DeveloperReference->new;
        $manual->load($self->data_paths, $self->vendor);

        return $manual;
    }
);

=item doc_base_manual

=cut

has doc_base_manual => (
    is => 'rw',
    lazy => 1,
    default => sub {
        my ($self) = @_;

        my $manual = Lintian::Data::Authority::DocBaseManual->new;
        $manual->load($self->data_paths, $self->vendor);

        return $manual;
    }
);

=item filesystem_hierarchy_standard

=cut

has filesystem_hierarchy_standard => (
    is => 'rw',
    lazy => 1,
    default => sub {
        my ($self) = @_;

        my $manual= Lintian::Data::Authority::FilesystemHierarchy->new;
        $manual->load($self->data_paths, $self->vendor);

        return $manual;
    }
);

=item java_policy

=cut

has java_policy => (
    is => 'rw',
    lazy => 1,
    default => sub {
        my ($self) = @_;

        my $manual = Lintian::Data::Authority::JavaPolicy->new;
        $manual->load($self->data_paths, $self->vendor);

        return $manual;
    }
);

=item lintian_manual

=cut

has lintian_manual => (
    is => 'rw',
    lazy => 1,
    default => sub {
        my ($self) = @_;

        my $manual = Lintian::Data::Authority::LintianManual->new;
        $manual->load($self->data_paths, $self->vendor);

        return $manual;
    }
);

=item menu_manual

=cut

has menu_manual => (
    is => 'rw',
    lazy => 1,
    default => sub {
        my ($self) = @_;

        my $manual = Lintian::Data::Authority::MenuManual->new;
        $manual->load($self->data_paths, $self->vendor);

        return $manual;
    }
);

=item menu_policy

=cut

has menu_policy => (
    is => 'rw',
    lazy => 1,
    default => sub {
        my ($self) = @_;

        my $manual = Lintian::Data::Authority::MenuPolicy->new;
        $manual->load($self->data_paths, $self->vendor);

        return $manual;
    }
);

=item menu_policy

=cut

has new_maintainer => (
    is => 'rw',
    lazy => 1,
    default => sub {
        my ($self) = @_;

        my $manual = Lintian::Data::Authority::NewMaintainer->new;
        $manual->load($self->data_paths, $self->vendor);

        return $manual;
    }
);

=item perl_policy

=cut

has perl_policy => (
    is => 'rw',
    lazy => 1,
    default => sub {
        my ($self) = @_;

        my $manual = Lintian::Data::Authority::PerlPolicy->new;
        $manual->load($self->data_paths, $self->vendor);

        return $manual;
    }
);

=item policy_manual

=cut

has policy_manual => (
    is => 'rw',
    lazy => 1,
    default => sub {
        my ($self) = @_;

        my $manual = Lintian::Data::Authority::DebianPolicy->new;
        $manual->load($self->data_paths, $self->vendor);

        return $manual;
    }
);

=item python_policy

=cut

has python_policy => (
    is => 'rw',
    lazy => 1,
    default => sub {
        my ($self) = @_;

        my $manual = Lintian::Data::Authority::PythonPolicy->new;
        $manual->load($self->data_paths, $self->vendor);

        return $manual;
    }
);

=item vim_policy

=cut

has vim_policy => (
    is => 'rw',
    lazy => 1,
    default => sub {
        my ($self) = @_;

        my $manual = Lintian::Data::Authority::VimPolicy->new;
        $manual->load($self->data_paths, $self->vendor);

        return $manual;
    }
);

=back

=head1 AUTHOR

Originally written by Felix Lechner <felix.lechner@lease-up.com> for Lintian.

=head1 SEE ALSO

lintian(1)

=cut

1;

# Local Variables:
# indent-tabs-mode: nil
# cperl-indent-level: 4
# End:
# vim: syntax=perl sw=4 sts=4 sr et