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
|
# Copyright (C) 2019 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 Test::Lintian::Output::Universal;
=head1 NAME
Test::Lintian::Output::Universal -- routines to process universal hints
=head1 SYNOPSIS
use Test::Lintian::Output::Universal qw(get_tag_names);
my $filepath = "path to a universal hint file";
my @tags = get_tag_names($filepath);
=head1 DESCRIPTION
Helper routines to deal with universal hints and hint files. This is an
abstract format that has the minimum information found in all Lintian
output formats.
=cut
use v5.20;
use warnings;
use utf8;
use Exporter qw(import);
BEGIN {
our @EXPORT_OK = qw(
get_tag_names
order
package_name
package_type
tag_name
parse_line
universal_string
);
}
use Carp;
use Const::Fast;
use List::SomeUtils qw(uniq);
use List::Util qw(all);
use Path::Tiny;
use Unicode::UTF8 qw(encode_utf8);
const my $SPACE => q{ };
const my $COLON => q{:};
const my $LPARENS => q{(};
const my $RPARENS => q{)};
=head1 FUNCTIONS
=over 4
=item get_tag_names(PATH)
Gets all the tag names mentioned in universal hint file located
at PATH.
=cut
sub get_tag_names {
my ($path) = @_;
my @lines = path($path)->lines_utf8({ chomp => 1 });
my @names = map { tag_name($_) } @lines;
return uniq @names;
}
=item order
=cut
sub order {
my ($line) = @_;
return package_type($line) . $line;
}
=item package_name
=cut
sub package_name {
my ($line) = @_;
my ($package, undef, undef, undef) = parse_line($line);
return $package;
}
=item package_type
=cut
sub package_type {
my ($line) = @_;
my (undef, $type, undef, undef) = parse_line($line);
return $type;
}
=item tag_name
=cut
sub tag_name {
my ($line) = @_;
my (undef, undef, $name, undef) = parse_line($line);
return $name;
}
=item parse_line
=cut
sub parse_line {
my ($line) = @_;
my ($package, $type, $name, $details)
= $line =~ qr/^(\S+)\s+\(([^)]+)\):\s+(\S+)(?:\s+(.*))?$/;
croak encode_utf8("Cannot parse line $line")
unless all { length } ($package, $type, $name);
return ($package, $type, $name, $details);
}
=item universal_string
=cut
sub universal_string {
my ($package, $type, $name, $details) = @_;
croak encode_utf8('Need a package name')
unless length $package;
croak encode_utf8('Need a package type')
unless length $type;
croak encode_utf8('Need a tag name')
unless length $name;
my $line
= $package. $SPACE. $LPARENS. $type. $RPARENS. $COLON. $SPACE. $name;
$line .= $SPACE . $details
if length $details;
return $line;
}
=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
|
