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
|
package Module::CPANTS::Kwalitee::License;
use warnings;
use strict;
use File::Spec::Functions qw(catfile);
use Pod::Simple::TextContent;
use List::MoreUtils qw(all any);
sub order { 100 }
##################################################################
# Analyse
##################################################################
sub analyse {
my $class=shift;
my $me=shift;
main::logger(__PACKAGE__ . "::analyse called");
# check META.yml
my $yaml=$me->d->{meta_yml};
$me->d->{license} = '';
if ($yaml) {
if ($yaml->{license} and $yaml->{license} ne 'unknown') {
$me->d->{license_from_yaml} = $yaml->{license};
$me->d->{license} = $yaml->{license}.' defined in META.yaml';
}
}
my $files=$me->d->{files_array};
# check if there's a LICEN[CS]E file
if (my ($file) = grep {/^LICEN[CS]E$/} @$files) {
$me->d->{license} .= " defined in $file";
$me->d->{external_license_file}=$file;
#$me->d->{license_from_external_license_file} = Software::LicenseUtils->licens_text(slurp());
}
# check pod
#if ( $me->d->{licenses} ) {
# $me->d->{license_in_pod} = 1;
# $me->d->{license} .= " defined in POD";
#}
foreach my $file (grep { /\.p(m|od)$/ } @$files ) {
my $parser=Pod::Simple::TextContent->new;
my $out;
$parser->output_string($out);
$parser->parse_file( catfile($me->distdir,$file) );
if ($out=~/LICEN[CS]E/) {
$me->d->{license_in_pod} = 1;
$me->d->{license}="defined in POD ($file)";
}
}
return;
}
##################################################################
# Kwalitee Indicators
##################################################################
sub kwalitee_indicators{
my @fedora_licenses = qw(perl apache artistic_2 gpl lgpl mit mozilla);
# based on: http://fedoraproject.org/wiki/Licensing
my $fedora_licenses = "Acceptable licenses: (" . join(", ", @fedora_licenses) . ")";
return [
{
name=>'has_humanreadable_license',
error=>q{This distribution does not have a license defined in the documentation or in a file called LICENSE},
remedy=>q{Add a section called 'LICENSE' to the documentation, or add a file named LICENSE to the distribution.},
code=>sub {
my $d = shift;
return $d->{external_license_file} || $d->{license_in_pod} ? 1 : 0;
}
},
{
name=>'has_separate_license_file',
error=>q{This distribution does not have a LICENSE or LICENCE file in its root directory.},
remedy=>q{This is not a critical issue. Currently mainly informative for the CPANTS authors. It might be removed later.},
is_experimental=>1,
code=>sub { shift->{external_license_file} ? 1 : 0 }
},
# {
# name=>'has_known_license_in_external_license_file',
# error=>q{This distribution has a LICENSE or LICENCE file in its root directory but the license in it was not recognized by CPANTS.},
# remedy=>q{Either CPANTS needs to be fixed or your LICENSE file.},
# is_experimental=>1,
# code=>sub {
# my $d = shift;
# return 1 if not $d->{external_license_file};
# return $d->{license_from_external_license_file} ? 1 : 0;
# },
# },
{
name=>'has_license_in_source_file',
error=>q{Does not have license information in any of its source files},
remedy=>q{Add =head1 LICENSE and the text of the license to the main module in your code.},
is_experimental=>1,
code=>sub {
my $d = shift;
# data collected in File.pm
return 0 if not $d->{licenses};
return 1 if $d->{license_type};
$d->{error}{has_license_in_source_file} = "Seemingly conflicting licenses in files: "
. join ", ", map {"$_ : $d->{licenses}{$_}"} keys %{ $d->{licenses} };
return 0;
}
},
{
name=>'fits_fedora_license',
error=>qq{Fits the licensing requirements of Fedora ($fedora_licenses).},
remedy=>q{Replace the license or convince Fedora to accept this license as well.},
is_experimental=>1,
code=>sub {
my $d=shift;
my $license = $d->{meta_yml}{license};
return ((defined $license and any {$license eq $_} @fedora_licenses) ? 1 : 0);
}
},
];
}
q{Favourite record of the moment:
Lili Allen - Allright, still};
__END__
=encoding UTF-8
=head1 NAME
Module::CPANTS::Kwalitee::License - Checks if there is a license
=head1 SYNOPSIS
Checks if the disttribution specifies a license.
=head1 DESCRIPTION
=head2 Methods
=head3 order
Defines the order in which Kwalitee tests should be run.
Returns C<100>.
=head3 analyse
C<MCK::License> checks if there's a C<license> field C<META.yml>. Additionally, it looks for a file called LICENSE and a POD section namend LICENSE
=head3 kwalitee_indicators
Returns the Kwalitee Indicators datastructure.
=over
=item * has_license
=item * has_license_in_metayml
=back
=head2 License information
Pleaces wher the licens information is taken from:
Has a LICENSE file file_license 1|0
Content of LICENSE file matches License X from Software::License
License in META.yml
License in META.yml matches one of the known licenses
License in source files recognized by Software::LicenseUtils
For each file keep where is was it recognized.
Has license or copyright entry in pod (that might not be recognized by Software::LicenseUtils)
# has_license
=head1 SEE ALSO
L<Module::CPANTS::Analyse>
=head1 AUTHOR
L<Thomas Klausner|https://metacpan.org/author/domm>
and L<Gábor Szabó|https://metacpan.org/author/szabgab>
=head1 COPYRIGHT AND LICENSE
Copyright © 2003–2009 L<Thomas Klausner|https://metacpan.org/author/domm>
Copyright © 2006–2008 L<Gábor Szabó|https://metacpan.org/author/szabgab>
You may use and distribute this module according to the same terms
that Perl is distributed under.
|
