New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Makefile.PL metadata #10

Merged
merged 5 commits into from Dec 21, 2017

Conversation

Projects
None yet
2 participants
@paultcochrane
Contributor

paultcochrane commented Dec 21, 2017

This PR bundles a few changes which are related to metadata updates in Makefile.PL.

  • the AUTHOR and ABSTRACT entries are helpful for sites like MetaCPAN to display more complete data about the dist
  • I noticed that some variable definitions simply used empty values and hence these could be removed
  • I also noticed that instead of evaluating the value of $ExtUtils::MakeMaker::VERSION one could just refer to it directly, hence saving an eval and the use of a temporary variable without hurting readability
  • I set the minimum Perl version to 5.8.0. As mentioned in the commit message, the code actually supports 5.6.0, however since the tests use the use uft8 pragma, they require at least 5.8.0, thus by setting this value in the metadata, this should help CPAN Testers use the correct Perl version when testing, while at the same time still allowing users to install on 5.6.0 if the so desire.

I've split this PR into separate commits so that you can cherry pick them if you want to. If you want me to update any of the commits, please just let me know and I'll be happy to fix the commits and resubmit the PR.

I also noticed that it's probably easier to set the minimum ExtUtils::MakeMaker version in the use statement rather by having extra metadata options specified in an if block. Since even the current version of ExtUtils::MakeMaker is supported on Perl 5.6.0, such a change should still be OK and it would remove the need for the if block in Makefile.PL thus simplifying the code a little bit. I didn't include such a change in this PR since I wanted to ask you about this first to check if such a change would fit with your coding practices (I don't want to step on any toes!).

paultcochrane added some commits Dec 20, 2017

Replace temporary variable with direct lookup
It turns out that one can simply reference the
`ExtUtils::MakeMaker::VERSION` variable directly and there doesn't seem
to be a need to first eval the version and then make the numerical
comparison: this can all be completed in one line with minimal impact on
readability.
Set minimum Perl version in metadata
Since this addition requires at least version 6.48 of
ExtUtils::MakeMaker, the version check in Makefile.PL has been bumped to
at least this version.

Even though the minimum version of Perl that the module code supports is
5.6.0, the version is set to 5.8.0 here since the test code requires at
least this version (since it uses the `use utf8` pragma).  Since the
version metadata information is used in things such as CPAN Testers it
will be helpful there, however by *not* setting the minimum version
explicitly in the code means that someone wanting to install and run
this module on a 5.6.x Perl would still be able to do so.
@hoytech

This comment has been minimized.

Show comment
Hide comment
@hoytech

hoytech Dec 21, 2017

Owner

Makes sense. I think I just copied how some other module tests for META_MERGE support, no idea why it was evaling that TBH.

Owner

hoytech commented Dec 21, 2017

Makes sense. I think I just copied how some other module tests for META_MERGE support, no idea why it was evaling that TBH.

@hoytech hoytech merged commit ce7ee7b into hoytech:master Dec 21, 2017

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment