NAME

MyCPAN::Indexer::DPAN - Create a D(ark)PAN out of the indexed distributions

SYNOPSIS

use MyCPAN::Indexer;

DESCRIPTION

This module implements the indexer_class and reporter_class components to allow backpan_indexer.pl to count the test modules used in the indexed distributions. This application of MyCPAN::Indexer is specifically aimed at creating a 02packages.details file, so it strives to collect a minimum of information.

It runs through the indexing and prints a report at the end of the run.

Indexer class

examine_dist_steps

Returns the list of techniques that examine_dist should use to index distributions. See the documentation in MyCPAN::Indexer::examine_dist_steps.

For DPAN, unpack the dist, ensure you are in the dist directory, the find the modules.

find_modules_techniques

Returns the list of techniques that find_modules should use to look for Perl module files. See the documentation in MyCPAN::Indexer::find_modules.

get_module_info_tasks
setup_run_info

Like setup_run_info in MyCPAN::Indexer, but it remembers fewer things. The DarkPAN census really just cares about finding packages, so the details about the run aren't as interesting.

setup_dist_info

Like setup_dist_info in MyCPAN::Indexer, but it remembers fewer things. The test census really just cares about statements in the test files, so the details about the distribution aren't as interesting.

Reporter class

get_reporter( $Notes )

Inherited for MyCPAN::App::BackPAN::Indexer

final_words( $Notes )

get_reporter sets the reporter key in the $Notes hash reference. The value is a code reference that takes the information collected about a distribution and counts the modules used in the test files.

See MyCPAN::Indexer::Tutorial for details about what get_reporter expects and should do.

create_package_details
create_modlist
create_checksums

TO DO

Count the lines in the files
Code stats? Lines of code, lines of pod, lines of comments

SOURCE AVAILABILITY

This code is in Github:

git://github.com/briandfoy/mycpan-indexer.git

AUTHOR

brian d foy, <bdfoy@cpan.org>

COPYRIGHT AND LICENSE

Copyright (c) 2008, brian d foy, All Rights Reserved.

You may redistribute this under the same terms as Perl itself.