NAME
JSAN::Index::Distribution - A JavaScript Archive Network (JSAN) Distribution
DESCRIPTION
This class provides objects for named distributions in the JSAN index.
METHODS
In addition to the general methods provided by Class::DBI, it has the following methods
name
The name accessor returns the name of the distribution.
doc
The doc accessor returns the root-relative location of the documentation for this distribution on the http://openjsan.org/ website.
releases
The releases method finds and retrieves all of the releases of the distribution.
Returns a list of JSAN::Index::Release objects.
latest_release
One distribution generally has a number of releases.
The latest_release method returns the JSAN::Index::Release object that represents the most recent release of the distribution.
extract_libs to => $path
The extract_libs method will extract the libraries for the most recent version of the distribution to the local filesystem.
It takes named parameters to control its behaviour.
- to
-
The
toparameter specifies the destination for the files to be extracted to. When passed as a single string, this is taken to be a directory on the local host.No other destination options other than the local filesystem are available at this time, but more destination options are expected at a later date.
Returns the number of files extracted, or dies on error.
extract_tests to => $path
The extract_tests method will extract the test scripts for the most recent release of the distribution to the local filesystem.
Returns the number of files extracted, or dies on error.
SUPPORT
Bugs should be reported via the CPAN bug tracker at
http://rt.cpan.org/NoAuth/ReportBug.html?Queue=JSAN-Client
For other issues, contact the author.
AUTHOR
Adam Kennedy <cpan@ali.as>, http://ali.as/
SEE ALSO
JSAN::Index, JSAN::Shell, http://openjsan.org
COPYRIGHT
Copyright 2005 Adam Kennedy. All rights reserved.
This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
The full text of the license can be found in the LICENSE file included with this module.