make3pm

Tools for making makefiles with.

Usage

  use constant MOD_REQS =>
    [
     { name    => 'Pod::Usage',
       version => '1.12', },

     { name    => 'IPC::Run',
       package => 'IPC-Run',
       version => '0.44', },
    ];

  use constant EXEC_REQS =>
    [
     { name    => 'blastpgp',
       version => '1.50',
       vopt    => '--version', },

     { name    => 'mkprofile', },

     { name    => 'mp3id',
       version => '0.4',
       vopt    => '--help',
       vexpect => 255, },
    ];

  use constant NAME         => 'Module-Name';
  use constant VERSION_FROM => catfile (qw( lib Module Name.pm ));
  use constant AUTHOR       => 'Martyn J. Pearce [email protected]';
  use constant ABSTRACT     => 'This module makes chocolate biscuits';

  use make.pm

Overview

This package provides methods and initialization to build standard perl modules.

The plan is, you define the requirements, and let the module take care of the rest.

The requirements you must define are:

MOD_REQS

An arrayref of hashrefs. Each hashref represents a required Perl module, and has the following keys:

name: Mandatory Name of the module used. The presence of this module is checked, and an exception is raised if it does not exist.

package

Optional Name of the package in which the module is to be found. If not defined, the package is assumed to be present in core Perl.

Modules that have been in core Perl since 5.005 need not be listed; the "core perl" default is for modules such as "Pod::Usage" which have been added to the core since 5.005.

version: Optional If supplied, the version of the module is checked against this number, and an exception raised if the version found is lower than that requested.

EXEC_REQS

name: Name of the executable used. The presence of this executable is checked, and an exception is raised if it does not exist (in the PATH).

package: Optional Name of the package in which the executable is to be found.

version

Optional If supplied, the version of the module is checked against this number, and an exception raised if the version found is lower than that requested.

If supplied, the vopt key must also be supplied.

vopt: Optional This is used only if the "version" key is also used. This is the option that is passed to the executable to ask for its version number. It may be the empty string if no option is used (but must be defined if "version" is defined).

vexpect: Optional This is used only if the "version" key is also used. This is the exit code to expect from the program when polling for its version number. Defaults to 0. This is the exit code (value of $? in the shell) to use, not the value of the "wait" call.

NAME: The module name. It must conform to the established standard; in particular, it must not contain colon characters. The usual process, when providing a single-package module (e.g., to provide "MIME::Base64"), is to replace the "::" occurences with hyphens (hence, "MIME-Base64").

VERSION_FROM: The module from which to establish the version number. This module must have a line of the form "$VERSION = '0.01';". Declarative prefixes (.e.g, "our") are fine; "our" is the usual one, since $VERSION is almost always a package variable.

AUTHOR: The name of the module author(s), along with an email address. This is normally the person primarily responsible for the upkeep of the module.

ABSTRACT: A single (concise!) sentence describing the rough purpose of the module. It is not expected to be mightily accurate, but is for quick browsing of modules.

Usage

Overview

Examples