NAME

File::Package - test load a program module with a package of the same name

SYNOPSIS

##########
# Subroutine interface
#
use File::Package qw( is_package_loaded, load_package)

$package = is_package_loaded($package)
$error   = load_package($package)
$error   = load_package($package, @import)

##########
# Class Interface
# 
use File::Package

$package = File::Package->is_package_loaded($package)
$error   = File::Package->load_package($package)
$error   = File::Package->load_package($package, @import)

###### 
# Class Interface - Add File::Package to another class
#
use File::Package
use vars qw(@ISA)
@ISA = qw(File::Package)

$package = __PACKAGE__->is_package_loaded($package)
$error   = __PACKAGE__->load_package($package)
$error   = __PACKAGE__->load_package($package, @import)

DESCRIPTION

The load_package method attempts to capture any load problems by loading the package with a "require " under an eval and capturing all the "warn" and $@ messages. The @import is optional and causes the load package messages to import the symbols named by @import.

One very useful application is in test scripts. If a package does load, it is very helpful that the program does not die and reports the reason the package did not load. This information is readily available when loaded at a local site. However, it the load occurs at a remote site and the load crashes Perl, the remote tester usually will not have this information readily available.

If using it in a test script with the 'Test' module, be sure to use two arguments (2nd argument must be defined, not 0, not '') for &Test::ok; otherwise the &Test::ok will not output the the actual and expected in the failure error report. For example,

use Test;
use File::Package qw(load_package);
my $load_error = load_package($package_name);
ok(!$load_error, 1);

# skip rests of the tests unless $load_error eq ''

Other applications include using backup alternative software if a package does not load. For example if the package 'Compress::Zlib' did not load, an attempt may be made to use the gzip system command.

METHODS

is_package_loaded method

$package = File::Package->is_package_loaded($package)

The is_package_loaded method determines if a package vocabulary is present.

For example, if File::Basename is not loaded

==> File::Package->is_package_loaded('File::Basename')

''
=head1 REQUIREMENTS

Coming soon.

DEMONSTRATION

~~~~~~ Demonstration overview ~~~~~

Perl code begins with the prompt

=>

The selected results from executing the Perl Code follow on the next lines. For example,

=> 2 + 2
4

~~~~~~ The demonstration follows ~~~~~

=>     use File::Spec;

=>     use File::Package;
=>     my $uut = 'File::Package';
=>     use File::Package;
=> my $errors = $uut->load_package( 'File::Basename' )
''

=> '' ne ($errors = $uut->load_package( 't::File::BadLoad' ) )
'1'

=> '' ne ($errors = $uut->load_package( 't::File::BadVocab' ) )
'1'

=> !defined($main::{'find'})
'1'

=> $errors = $uut->load_package( 'File::Find', 'find' )
''

=> defined($main::{'find'})
'1'

=> !defined($main::{'finddepth'})
'1'

=> $errors = $uut->load_package( 'File::Find', '')
''

=> !defined($main::{'finddepth'})
'1'

=> $errors = $uut->load_package( 'File::Find')
''

=> defined($main::{'finddepth'})
'1'

QUALITY ASSURANCE

Running the test script 'Package.t' found in the "File-Package-$VERSION.tar.gz" distribution file verifies the requirements for this module.

All testing software and documentation stems from the Software Test Description (STD) program module 't::File::Package', found in the distribution file "File-Package-$VERSION.tar.gz".

The 't::File::Package' STD POD contains a tracebility matix between the requirements established above for this module, and the test steps identified by a 'ok' number from running the 'Package.t' test script.

The t::File::Package' STD program module '__DATA__' section contains the data to perform the following:

• to generate the test script 'Package.t'

• generate the tailored STD POD in the 't::File::Package' module,

• generate the 'Package.d' demo script,

• replace the POD demonstration section herein with the demo script 'Package.d' output, and

• run the test script using Test::Harness with or without the verbose option,

To perform all the above, prepare and run the automation software as follows:

• Install "Test_STDmaker-$VERSION.tar.gz" from one of the respositories only if it has not been installed:

  • http://www.softwarediamonds/packages/

  • http://www.perl.com/CPAN-local/authors/id/S/SO/SOFTDIA/

• manually place the script tmake.pl in "Test_STDmaker-$VERSION.tar.gz' in the site operating system executable path only if it is not in the executable path

• place the 't::File::Package' at the same level in the directory struture as the directory holding the 'File::Package' module

• execute the following in any directory:

  tmake -test_verbose -replace -run -pm=t::File::Package

NOTES

FILES

The installation of the "File-Package-$VERSION.tar.gz" distribution file installs the 'Docs::Site_SVD::File_Package' SVD program module.

The __DATA__ data section of the 'Docs::Site_SVD::File_Package' contains all the necessary data to generate the POD section of 'Docs::Site_SVD::File_Package' and the "File-Package-$VERSION.tar.gz" distribution file.

To make use of the 'Docs::Site_SVD::File_Package' SVD program module, perform the following:

• install "ExtUtils-SVDmaker-$VERSION.tar.gz" from one of the respositories only if it has not been installed:

  • http://www.softwarediamonds/packages/

  • http://www.perl.com/CPAN-local/authors/id/S/SO/SOFTDIA/

• manually place the script vmake.pl in "ExtUtils-SVDmaker-$VERSION.tar.gz' in the site operating system executable path only if it is not in the executable path

• Make any appropriate changes to the __DATA__ section of the 'Docs::Site_SVD::File_Package' module. For example, any changes to 'File::Package' will impact the at least 'Changes' field.

• Execute the following:

  vmake readme_html all -pm=Docs::Site_SVD::File_Package

AUTHOR

The holder of the copyright and maintainer is

<support@SoftwareDiamonds.com>

COPYRIGHT NOTICE

Copyrighted (c) 2002 Software Diamonds

All Rights Reserved

BINDING REQUIREMENTS NOTICE

Binding requirements are indexed with the pharse 'shall[dd]' where dd is an unique number for each header section. This conforms to standard federal government practices, 490A ("3.2.3.6" in STD490A). In accordance with the License, Software Diamonds is not liable for any requirement, binding or otherwise.

LICENSE

Software Diamonds permits the redistribution and use in source and binary forms, with or without modification, provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

SOFTWARE DIAMONDS, http::www.softwarediamonds.com, PROVIDES THIS SOFTWARE 'AS IS' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SOFTWARE DIAMONDS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING USE OF THIS SOFTWARE, EVEN IF ADVISED OF NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE POSSIBILITY OF SUCH DAMAGE.

cpanm Tie::Gzip

perl -MCPAN -e shell
install Tie::Gzip