JSAN::Index::Library 0.14

JSAN::Index::Library is a JavaScript Archive Network (JSAN) Software Library.

This class provides objects for the various libraries (software components) in the JSAN.

METHODS

In addition to the general methods provided by Class::DBI, it has the following methods

name

The name accessor returns the name (possibly including the use of pseudo-namespaces) of the library. e.g. "Test.Simple.Container.Browser"

release

The release method returns the JSAN::Index::Release object for the release that the library is defined in.

version

The version accessor returns the version of the library.

doc

The doc accessor returns the root-relative location of the documentation for this library on the http://openjsan.org/ website.

distribution

The distribution method is a shortcut for $library->release->distribution and returns the JSAN::Index::Distribution for the distribution that this library is of.

extract_libs to => $path

The extract_libs method will extract the libraries for a release (i.e. the contents of the lib directory> to the local filesystem.

It takes named parameters to control its behaviour.

to

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.

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 a release (i.e. the contents of the tests directory> to the local filesystem.

Returns the number of files extracted, or dies on error.