Bug #102220 for Map-Tube-Plugin-FuzzyFind: Prerequisites not declared

Thu Feb 19 13:03:45 2015 SREZIC [...] cpan.org - Ticket created

Subject:

Prerequisites not declared

It seems that Text::Levenshtein, Text::Soundex, and Text::Metaphone (and maybe other modules) are not declared as prerequisites. See http://matrix.cpantesters.org/?dist=Map-Tube-Plugin-FuzzyFind%200.02 for a fail/pass overview.

Thu Feb 19 13:31:28 2015 GWS [...] cpan.org - Correspondence added

They are not, strictly speaking, prerequisites. The module will work fine without then, only with limited functionality, of course. So they are not required, but suggested. I hope I encoded this properly in Makefile.pl, but I'm not sure I have managed according to current best practice. (Anyone to enlighten me, please?) However, the test scripts indeed do not take this into account. They treat the extra modules like requirements proper. This is a bug I need to fix this.

Thu Feb 19 13:31:28 2015 The RT System itself - Status changed from 'new' to 'open'

Thu Feb 19 13:31:29 2015 GWS [...] cpan.org - Taken

Thu Feb 19 13:31:50 2015 GWS [...] cpan.org - Correspondence added

They are not, strictly speaking, prerequisites. The module will work fine without then, only with limited functionality, of course. So they are not required, but suggested. I hope I encoded this properly in Makefile.pl, but I'm not sure I have managed according to current best practice. (Anyone to enlighten me, please?) However, the test scripts indeed do not take this into account. They treat the extra modules like requirements proper. This is a bug I need to fix.

Thu Feb 19 14:25:21 2015 SREZIC [...] cpan.org - Correspondence added

On 2015-02-19 13:31:50, GWS wrote: Show quoted text

> They are not, strictly speaking, prerequisites. The module will work > fine without then, only with limited functionality, of course. So they > are not required, but suggested. I hope I encoded this properly in > Makefile.pl, but I'm not sure I have managed according to current best > practice. (Anyone to enlighten me, please?) > However, the test scripts indeed do not take this into account. They > treat the extra modules like requirements proper. > This is a bug I need to fix.

Easiest is to skip tests (parts or whole test scripts) if optional prereqs are missing.

Thu Feb 19 14:38:53 2015 GWS [...] cpan.org - Correspondence added

Yep, for the tests that is what I'm currently doing, and that should fix the bug reported. My question beyond that would be how to advertise formally (in addition to mentioning in the man page) that some other modules are not required but nice to have. E.g., in CRAN (of R, not Perl) each module advertises clearly and in a standardised way what it requires and what it suggests. (Also, reverse-requires and reverse-suggests, but that is another story.) In the E::MM docs I haven't found any clear recipe how to achieve this. It seems the Meta-Merge section is the best I can get. Is this The Thing To Do, or is there some better way?

Thu Feb 19 14:47:13 2015 SREZIC [...] cpan.org - Correspondence added

On 2015-02-19 14:38:53, GWS wrote: Show quoted text

> Yep, for the tests that is what I'm currently doing, and that should > fix the bug reported. > My question beyond that would be how to advertise formally (in > addition to mentioning in the man page) that some other modules are > not required but nice to have. > E.g., in CRAN (of R, not Perl) each module advertises clearly and in a > standardised way what it requires and what it suggests. (Also, > reverse-requires and reverse-suggests, but that is another story.) > > In the E::MM docs I haven't found any clear recipe how to achieve > this. It seems the Meta-Merge section is the best I can get. Is this > The Thing To Do, or is there some better way?

META_MERGE is the way to do it, and probably EUMM should have better documentation on this topic. You can look at other distributions how to use it, for example https://metacpan.org/source/ETHER/libwww-perl-6.13/Makefile.PL

Mon Feb 23 14:34:21 2015 GWS [...] cpan.org - Correspondence added

Am 2015-02-19 14:47:13, SREZIC schrieb: Show quoted text

> META_MERGE is the way to do it, and probably EUMM should have better > documentation on this topic. You can look at other distributions how > to use it, for example > https://metacpan.org/source/ETHER/libwww-perl-6.13/Makefile.PL

Thanks for the pointer, Slaven! That looks like a good introduction.

Mon Feb 23 14:34:58 2015 GWS [...] cpan.org - Told changed from Mon Feb 23 14:34:22 2015 to Mon Feb 23 14:34:57 2015

Mon Feb 23 14:37:49 2015 GWS [...] cpan.org - Correspondence added

Tests now check for availability of optional modules and skip if not present.

Mon Feb 23 14:37:50 2015 GWS [...] cpan.org - Status changed from 'open' to 'resolved'

Mon Feb 23 14:37:50 2015 GWS [...] cpan.org - Fixed in 0.03 added