For Programmers: Free Programming Magazines  


Home > Archive > PERL Modules > July 2004 > Q: What to name a module?









You are viewing an archived Text-only version of the thread. To view this thread in it's original format and/or if you want to reply to this thread please [click here]

 

Author Q: What to name a module?
Robert Rothenberg

2004-07-15, 3:56 pm



I am working on a module that when given a CPAN distribution, will return
which modules the distribtion requires (by parsing the Makefile.PL using
Module::MakefilePL::Parse if the META.yml file is not available).

A companion module will actually try to fetch the distribution information
from CPAN (since it can query a .meta file if it exists before downloading an
entire distribution).

Because it is more closely tied to CPAN and works with distributions rather
than modules, I am thinking of calling it CPAN::Distribution::Depends.

Comments or suggestions about the namespace would be appreciated.

FYI--I am writing yet another module to do this because existing modules
either do not work on my platform or they require preqrequisite modules to be
installed. Basically they either compile the module or run
Makefile.PL/Build.PL and see what modules are asked for. I'd rather use a
safer (and I think faster) method to partially-parse the Makefile.PL if no
META.yml is available.

Some tests using all the latest distribution on CPAN show that it works for
all but a handful of distributions.

This is actually part of a larger project to show test results (organized by
platform) of module dependencies. If there is a failure in the dependency
tree, authors can check for this.

I've also posted this question on Perl Monks at
<http://perlmonks.org/index.pl?node_id=374747>

Mohammad Mahmoud Khajah

2004-07-16, 8:56 pm

Hi,

CPAN::Distribution::Depends is good, but how about
CPAN::Distribution::Resolv ?

Krishna Sethuraman

2004-07-17, 8:55 pm

Robert Rothenberg wrote:

> Because it is more closely tied to CPAN and works with distributions
> rather than modules, I am thinking of calling it
> CPAN::Distribution::Depends.
>
> Comments or suggestions about the namespace would be appreciated.


The one recommendation I remember from many, many years ago was that in
the vein of the data structure being the real core of an object system,
that you name the module after a noun, rather than a verb. So 'Depends'
would be good (as short for 'dependencies'), and 'Distribution' is
better than 'Distribute'.

Krishna Sethuraman
krishgoo@wapacut.com
Sponsored Links







Also available: Server administration forum archive | Web Design forum archive | Software forum archive | Hardware reviews archive

Copyright 2008 codecomments.com