Bug #88945 for Software-License: doesn't detect =head1 COPYRIGHT and LICENSE as generated by Dist::Zilla::Plugin::PodWeaver

Tue Sep 24 13:22:36 2013 abraxxa [...] cpan.org - Ticket created

Subject:

doesn't detect =head1 COPYRIGHT and LICENSE as generated by Dist::Zilla::Plugin::PodWeaver

I'm using Dist::Zilla::Plugin::Test::Kwalitee through Dist::Zilla::PluginBundle::TestingMania in conjunction with Dist::Zilla::Plugin::PodWeaver. Its Pod::Weaver::Section::Legal, which is part of the default profile (Pod::Weaver::PluginBundle::Default), generates a =head1 pod section called 'COPYRIGHT and LICENSE' which includes the license. test number 13 has_license_in_source_file doens't pick that up and fails.

Tue Sep 24 14:38:58 2013 ether [...] cpan.org - Correspondence added

On 2013-09-24 10:22:36, ABRAXXA wrote: Show quoted text

> I'm using Dist::Zilla::Plugin::Test::Kwalitee through > Dist::Zilla::PluginBundle::TestingMania in conjunction with > Dist::Zilla::Plugin::PodWeaver. > Its Pod::Weaver::Section::Legal, which is part of the default profile > (Pod::Weaver::PluginBundle::Default), generates a =head1 pod section > called 'COPYRIGHT and LICENSE' which includes the license. > test number 13 has_license_in_source_file doens't pick that up and > fails.

I've seen this before; I believe it is not the header itself that is not being recognized, but the particular license you are using -- what license is that? But anyway, Test::Kwalitee is just a thin shell around Module::CPANTS::Analyse, which is where all the checking logic lives, so this ticket belongs there.

Tue Sep 24 14:38:58 2013 The RT System itself - Status changed from 'new' to 'open'

Tue Sep 24 14:39:07 2013 ether [...] cpan.org - Queue changed from Test-Kwalitee to Module-CPANTS-Analyse

Tue Sep 24 14:50:08 2013 abraxxa [...] cpan.org - Correspondence added

Am Di 24. Sep 2013, 14:38:58, ETHER schrieb: Show quoted text

> On 2013-09-24 10:22:36, ABRAXXA wrote:

> > I'm using Dist::Zilla::Plugin::Test::Kwalitee through > > Dist::Zilla::PluginBundle::TestingMania in conjunction with > > Dist::Zilla::Plugin::PodWeaver. > > Its Pod::Weaver::Section::Legal, which is part of the default profile > > (Pod::Weaver::PluginBundle::Default), generates a =head1 pod section > > called 'COPYRIGHT and LICENSE' which includes the license. > > test number 13 has_license_in_source_file doens't pick that up and > > fails.

> > > I've seen this before; I believe it is not the header itself that is > not being recognized, but the particular license you are using -- what > license is that? > > But anyway, Test::Kwalitee is just a thin shell around > Module::CPANTS::Analyse, which is where all the checking logic lives, > so this ticket belongs there.

Thanks for reassigning the ticket! The license used is 'None' as it's a company internal dist.

Tue Sep 24 14:50:09 2013 abraxxa [...] cpan.org - Fixed in 0.92 added

Tue Sep 24 14:51:10 2013 abraxxa [...] cpan.org - Broken in 0.92 added

Tue Sep 24 14:51:11 2013 abraxxa [...] cpan.org - Fixed in 0.92 deleted

Wed Sep 25 01:56:14 2013 ishigaki [...] cpan.org - Correspondence added

On Wed Sep 25 03:50:08 2013, ABRAXXA wrote: Show quoted text

> Am Di 24. Sep 2013, 14:38:58, ETHER schrieb:

> > On 2013-09-24 10:22:36, ABRAXXA wrote:

> > > I'm using Dist::Zilla::Plugin::Test::Kwalitee through > > > Dist::Zilla::PluginBundle::TestingMania in conjunction with > > > Dist::Zilla::Plugin::PodWeaver. > > > Its Pod::Weaver::Section::Legal, which is part of the default profile > > > (Pod::Weaver::PluginBundle::Default), generates a =head1 pod section > > > called 'COPYRIGHT and LICENSE' which includes the license. > > > test number 13 has_license_in_source_file doens't pick that up and > > > fails.

> > > > > > I've seen this before; I believe it is not the header itself that is > > not being recognized, but the particular license you are using -- what > > license is that? > > > > But anyway, Test::Kwalitee is just a thin shell around > > Module::CPANTS::Analyse, which is where all the checking logic lives, > > so this ticket belongs there.

> > > Thanks for reassigning the ticket! > The license used is 'None' as it's a company internal dist.

Hi. It looks like there are several issues here. 1) As you know, CPANTS is a testing service for CPAN distributions. Though CPAN doesn't impose any limitation on the licenses of distributions, I think it's reasonably acceptable to encourage people to use one of the well-known open source licenses Software::License supports (at least for CPAN distributions, to be clear, to reuse them without fear). So I'm inclined to consider this is not a bug but a feature because of your internal distributions' proprietary license. You can exclude license metrics by adding parameters when you use Test::Kwalitee (at least by hand, but I'm not sure if Dist::Zilla plugins support the feature). 2) That said, it may be a problem if Software::LicenseUtils can't guess a license it supports. If you think so, could you open another ticket for Software::License to ask RJBS to improve Software::LicenseUtils so that its "guess_license_from_pod" method (this is the one used in MCK) guesses "None" license correctly? 3) Also, it might be nice to split the metric so that we can separately test if a dist has a license section (no matter what the actual license is) and if the license is open-source friendly or not. But anyway, you'll probably need to exclude the latter.

Wed Sep 25 05:00:13 2013 abraxxa [...] cpan.org - Correspondence added

Am Mi 25. Sep 2013, 01:56:14, ISHIGAKI schrieb: Show quoted text

> On Wed Sep 25 03:50:08 2013, ABRAXXA wrote:

> > Am Di 24. Sep 2013, 14:38:58, ETHER schrieb:

> > > On 2013-09-24 10:22:36, ABRAXXA wrote:

> > > > I'm using Dist::Zilla::Plugin::Test::Kwalitee through > > > > Dist::Zilla::PluginBundle::TestingMania in conjunction with > > > > Dist::Zilla::Plugin::PodWeaver. > > > > Its Pod::Weaver::Section::Legal, which is part of the default > > > > profile > > > > (Pod::Weaver::PluginBundle::Default), generates a =head1 pod > > > > section > > > > called 'COPYRIGHT and LICENSE' which includes the license. > > > > test number 13 has_license_in_source_file doens't pick that up > > > > and > > > > fails.

> > > > > > > > > I've seen this before; I believe it is not the header itself that > > > is > > > not being recognized, but the particular license you are using -- > > > what > > > license is that? > > > > > > But anyway, Test::Kwalitee is just a thin shell around > > > Module::CPANTS::Analyse, which is where all the checking logic > > > lives, > > > so this ticket belongs there.

> > > > > > Thanks for reassigning the ticket! > > The license used is 'None' as it's a company internal dist.

> > Hi. It looks like there are several issues here. > > 1) As you know, CPANTS is a testing service for CPAN distributions. > Though CPAN doesn't impose any limitation on the licenses of > distributions, I think it's reasonably acceptable to encourage people > to use one of the well-known open source licenses Software::License > supports (at least for CPAN distributions, to be clear, to reuse them > without fear).

'None' is Software::License::None which was added exactly to support private dists. Show quoted text

> > So I'm inclined to consider this is not a bug but a feature because of > your internal distributions' proprietary license. > > You can exclude license metrics by adding parameters when you use > Test::Kwalitee (at least by hand, but I'm not sure if Dist::Zilla > plugins support the feature). > > 2) That said, it may be a problem if Software::LicenseUtils can't > guess a license it supports. If you think so, could you open another > ticket for Software::License to ask RJBS to improve > Software::LicenseUtils so that its "guess_license_from_pod" method > (this is the one used in MCK) guesses "None" license correctly?

Will talk to him on IRC or reassign this one to Software::License. Show quoted text

> > 3) Also, it might be nice to split the metric so that we can > separately test if a dist has a license section (no matter what the > actual license is) and if the license is open-source friendly or not. > But anyway, you'll probably need to exclude the latter.

I thought that's what the test does, at least the method name made me think that.

Wed Sep 25 05:14:40 2013 ishigaki [...] cpan.org - Correspondence added

On Wed Sep 25 18:00:13 2013, ABRAXXA wrote: Show quoted text

> Am Mi 25. Sep 2013, 01:56:14, ISHIGAKI schrieb:

> > On Wed Sep 25 03:50:08 2013, ABRAXXA wrote:

> > > Am Di 24. Sep 2013, 14:38:58, ETHER schrieb:

> > > > On 2013-09-24 10:22:36, ABRAXXA wrote:

> > > > > I'm using Dist::Zilla::Plugin::Test::Kwalitee through > > > > > Dist::Zilla::PluginBundle::TestingMania in conjunction with > > > > > Dist::Zilla::Plugin::PodWeaver. > > > > > Its Pod::Weaver::Section::Legal, which is part of the default > > > > > profile > > > > > (Pod::Weaver::PluginBundle::Default), generates a =head1 pod > > > > > section > > > > > called 'COPYRIGHT and LICENSE' which includes the license. > > > > > test number 13 has_license_in_source_file doens't pick that up > > > > > and > > > > > fails.

> > > > > > > > > > > > I've seen this before; I believe it is not the header itself that > > > > is > > > > not being recognized, but the particular license you are using -- > > > > what > > > > license is that? > > > > > > > > But anyway, Test::Kwalitee is just a thin shell around > > > > Module::CPANTS::Analyse, which is where all the checking logic > > > > lives, > > > > so this ticket belongs there.

> > > > > > > > > Thanks for reassigning the ticket! > > > The license used is 'None' as it's a company internal dist.

> > > > Hi. It looks like there are several issues here. > > > > 1) As you know, CPANTS is a testing service for CPAN distributions. > > Though CPAN doesn't impose any limitation on the licenses of > > distributions, I think it's reasonably acceptable to encourage people > > to use one of the well-known open source licenses Software::License > > supports (at least for CPAN distributions, to be clear, to reuse them > > without fear).

> 'None' is Software::License::None which was added exactly to support > private dists. >

> > > > So I'm inclined to consider this is not a bug but a feature because > > of > > your internal distributions' proprietary license. > > > > You can exclude license metrics by adding parameters when you use > > Test::Kwalitee (at least by hand, but I'm not sure if Dist::Zilla > > plugins support the feature). > > > > 2) That said, it may be a problem if Software::LicenseUtils can't > > guess a license it supports. If you think so, could you open another > > ticket for Software::License to ask RJBS to improve > > Software::LicenseUtils so that its "guess_license_from_pod" method > > (this is the one used in MCK) guesses "None" license correctly?

> Will talk to him on IRC or reassign this one to Software::License.

Thanks. Show quoted text

>

> > > > 3) Also, it might be nice to split the metric so that we can > > separately test if a dist has a license section (no matter what the > > actual license is) and if the license is open-source friendly or not. > > But anyway, you'll probably need to exclude the latter.

> I thought that's what the test does, at least the method name made me > think that.

OK. Then I'll fix this part, and maybe add an extra/experimental metric for open-source friendliness.

Fri Sep 27 07:13:36 2013 abraxxa [...] cpan.org - Queue changed from Module-CPANTS-Analyse to Software-License

Fri Sep 27 07:13:49 2013 abraxxa [...] cpan.org - Broken in 0.103005 added

Fri Sep 27 17:18:42 2013 DOHERTY [...] cpan.org - Correspondence added

On Tue Sep 24 14:38:58 2013, ETHER wrote: Show quoted text

> On 2013-09-24 10:22:36, ABRAXXA wrote:

> > I'm using Dist::Zilla::Plugin::Test::Kwalitee through > > Dist::Zilla::PluginBundle::TestingMania in conjunction with > > Dist::Zilla::Plugin::PodWeaver. > > Its Pod::Weaver::Section::Legal, which is part of the default profile > > (Pod::Weaver::PluginBundle::Default), generates a =head1 pod section > > called 'COPYRIGHT and LICENSE' which includes the license. > > test number 13 has_license_in_source_file doens't pick that up and > > fails.

> > > I've seen this before; I believe it is not the header itself that is > not being recognized, but the particular license you are using -- what > license is that?

I'm seeing the same problem for a dist using Apache 2. Software::License should be able to recognize supported licenses. (Although it strikes me as odd that we are using Software::License to generate the license text, and then asking it to recognize the exact same license text in Kwalitee tests... that seems un-DRY or something.)

Fri Oct 18 14:26:25 2013 ether [...] cpan.org - Requestor ETHER added

Fri Oct 18 14:27:30 2013 ether [...] cpan.org - Correspondence added

Sun Oct 20 14:19:19 2013 rjbs [...] cpan.org - Correspondence added

Fixed by today's release, I hope. 0.103005 -- rjbs

Sun Oct 20 14:19:19 2013 rjbs [...] cpan.org - Status changed from 'open' to 'resolved'

Wed Nov 27 11:47:27 2013 abraxxa [...] cpan.org - Correspondence added

Am So 20. Okt 2013, 14:19:19, RJBS schrieb: Show quoted text

> Fixed by today's release, I hope. > > 0.103005

I guess you meant 0.103006 as its Changes entry suggests. Unfortunately 0.103008 with Test::Kwalitee 1.17 still fails: not ok 13 - has_license_in_source_file # Failed test 'has_license_in_source_file' # at t/release-kwalitee.t line 12. # Error: Does not have license information in any of its source files # Details: # LICENSE section was not found in the pod. # Remedy: Add =head1 LICENSE and the text of the license to the main module in your code. That's the section from the pod which is generated by Software::License::None: =head1 COPYRIGHT AND LICENSE This software is copyright (c) 2013 by T-Systems Austria GesmbH. No license is granted to other entities. =cut

Wed Nov 27 11:47:27 2013 abraxxa [...] cpan.org - Status changed from 'resolved' to 'open'

Mon Feb 10 10:24:06 2014 rjbs [...] cpan.org - Correspondence added

On 2013-11-27 11:47:27, ABRAXXA wrote: Show quoted text

You don't grant a license. The code doesn't find one. Seems sort of appropriate to me. I'll sleep on it. -- rjbs

Thu Feb 20 22:11:31 2014 rjbs [...] cpan.org - Correspondence added

We discussed on IRC that you thought the issue was a case of the required =head being too tightly constrained, and we discussed that this is not the case. I think that finding no license for this particular text is correct. -- rjbs

Thu Feb 20 22:11:32 2014 rjbs [...] cpan.org - Status changed from 'open' to 'resolved'

Bug #88945 for Software-License: doesn't detect =head1 COPYRIGHT and LICENSE as generated by Dist::Zilla::Plugin::PodWeaver

Preferred bug tracker