JSAN::Index::Library - A JavaScript Archive Network (JSAN) Software Library
This class provides objects for the various libraries (software components) in the JSAN.
In addition to the general methods provided by Class::DBI, it has the following methods
The name accessor returns the name (possibly including the use of pseudo-namespaces) of the library. e.g. "Test.Simple.Container.Browser"
name
The release method returns the JSAN::Index::Release object for the release that the library is defined in.
release
The version accessor returns the version of the library.
version
The doc accessor returns the root-relative location of the documentation for this library on the http://openjsan.org/ website.
doc
The distribution method is a shortcut for $library->release->distribution and returns the JSAN::Index::Distribution for the distribution that this library is of.
distribution
$library->release->distribution
The extract_libs method will extract the libraries for a release (i.e. the contents of the lib directory> to the local filesystem.
extract_libs
lib
It takes named parameters to control its behaviour.
The to parameter 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.
to
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.
The extract_tests method will extract the test scripts for a release (i.e. the contents of the tests directory> to the local filesystem.
extract_tests
tests
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.
Adam Kennedy <cpan@ali.as>, http://ali.as/
JSAN::Index, JSAN::Shell, http://openjsan.org
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.
To install JSAN::Client, copy and paste the appropriate command in to your terminal.
cpanm
cpanm JSAN::Client
CPAN shell
perl -MCPAN -e shell install JSAN::Client
For more information on module installation, please visit the detailed CPAN module installation guide.