The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.

NAME

Module::Cloud - Generates a tag cloud for modules used in given code

SYNOPSIS

  use Module::Cloud;
  my $clouder = Module::Cloud->new(dir => \@dirs);
  my $cloud = $clouder->get_cloud;  # returns an HTML::TagCloud object
  print $cloud->html_and_css;

DESCRIPTION

This class traverses the given directories, searches for perl code, extracts the modules used by this code and generates a HTML::TagCloud object that gives an impression of how often each module is used.

METHODS

new
  my $clouder = Module::Cloud->new(dir => \@dirs);

Creates and returns a new object. The constructor will accept as arguments a list of pairs, from component name to initial value. For each pair, the named component is initialized by calling the method of the same name with the given value.

dir =item dir_clear =item dir_count =item dir_index =item dir_isset =item dir_pop =item dir_push =item dir_reset =item dir_set =item dir_shift =item dir_splice =item dir_unshift

An array accessor. See Class::Method::array for details on related methods provided.

get_cloud
  my $cloud = $clouder->get_cloud;

Traverses the directories set on the dir accessor and searches for files containing perl code. For each such file, the modules it uses are extracted. From this data a HTML::TagCloud object is created and returned. The more often a module is used the bigger it will appear in the tag cloud.

TAGS

If you talk about this module in blogs, on del.icio.us or anywhere else, please use the modulecloud tag.

BUGS AND LIMITATIONS

No bugs have been reported.

Please report any bugs or feature requests to bug-module-cloud@rt.cpan.org, or through the web interface at http://rt.cpan.org.

INSTALLATION

See perlmodinstall for information and options on installing Perl modules.

AVAILABILITY

The latest version of this module is available from the Comprehensive Perl Archive Network (CPAN). Visit <http://www.perl.com/CPAN/> to find a CPAN site near you. Or see <http://www.perl.com/CPAN/authors/id/M/MA/MARCEL/>.

AUTHOR

Marcel Grünauer, <marcel@cpan.org>

COPYRIGHT AND LICENSE

Copyright 2007 by Marcel Grünauer

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.