#!perl
#
# The copyright notice and plain old documentation (POD)
# are at the end of this file.
#
package Docs::Site_SVD::File_Package;
use strict;
use warnings;
use warnings::register;
use vars qw($VERSION $DATE $FILE );
$VERSION = '0.06';
$DATE = '2004/04/26';
$FILE = __FILE__;
use vars qw(%INVENTORY);
%INVENTORY = (
'lib/Docs/Site_SVD/File_Package.pm' => [qw(0.06 2004/04/26), 'revised 0.05'],
'MANIFEST' => [qw(0.06 2004/04/26), 'generated, replaces 0.05'],
'Makefile.PL' => [qw(0.06 2004/04/26), 'generated, replaces 0.05'],
'README' => [qw(0.06 2004/04/26), 'generated, replaces 0.05'],
'lib/File/Package.pm' => [qw(1.16 2004/04/26), 'revised 1.15'],
't/File/Package.d' => [qw(0.03 2004/04/26), 'revised 0.02'],
't/File/Package.pm' => [qw(0.01 2004/04/10), 'unchanged'],
't/File/Package.t' => [qw(0.12 2004/04/26), 'revised 0.11'],
't/File/_File_/BadLoad.pm' => [qw(0.01 2004/04/10), 'unchanged'],
't/File/_File_/BadPackage.pm' => [qw(0.01 2004/04/10), 'unchanged'],
't/File/_File_/Hyphen-Test.pm' => [qw(1.15 2004/04/10), 'unchanged'],
't/File/_File_/Multi.pm' => [qw(1.15 2004/04/10), 'unchanged'],
't/File/Test/Tech.pm' => [qw(1.21 2004/04/26), 'revised 1.17'],
't/File/Data/Secs2.pm' => [qw(1.18 2004/04/26), 'revised 1.15'],
't/File/Data/SecsPack.pm' => [qw(0.03 2004/04/26), 'new'],
't/File/Data/Startup.pm' => [qw(0.03 2004/04/26), 'new'],
);
########
# The ExtUtils::SVDmaker module uses the data after the __DATA__
# token to automatically generate this file.
#
# Don't edit anything before __DATA_. Edit instead
# the data after the __DATA__ token.
#
# ANY CHANGES MADE BEFORE the __DATA__ token WILL BE LOST
#
# the next time ExtUtils::SVDmaker generates this file.
#
#
=head1 Title Page
Software Version Description
for
File::Package - test load a pm and import symbs without eval and $@ misbehavoirs
Revision: E
Version: 0.06
Date: 2004/04/26
Prepared for: General Public
Prepared by: SoftwareDiamonds.com E<lt>support@SoftwareDiamonds.comE<gt>
Copyright: copyright © 2003 Software Diamonds
Classification: NONE
=head1 1.0 SCOPE
This paragraph identifies and provides an overview
of the released files.
=head2 1.1 Identification
This release,
identified in L<3.2|/3.2 Inventory of software contents>,
is a collection of Perl modules that
extend the capabilities of the Perl language.
=head2 1.2 System overview
One very useful test of the installation of a package is whether
or not the package loaded.
If it did not load, the reason it did not load is helpful
diagnostics and may be used to programically (automatically) take corrective
action.
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 error messages are returned with a warn instead of die so
that the using program may take the appropriate action such
as reporting the errors back to the author when used in test
software or perhaps falling back on a system 'gzip' command
when the 'Compress::Zlib' module fails to load.
=head2 1.3 Document overview.
This document releases File::Package version 0.06
providing a description of the inventory, installation
instructions and other information necessary to
utilize and track this release.
=head1 3.0 VERSION DESCRIPTION
All file specifications in this SVD
use the Unix operating
system file specification.
=head2 3.1 Inventory of materials released.
This document releases the file
File-Package-0.06.tar.gz
found at the following repository(s):
http://www.softwarediamonds/packages/
http://www.perl.com/CPAN/authors/id/S/SO/SOFTDIA/
Restrictions regarding duplication and license provisions
are as follows:
=over 4
=item Copyright.
copyright © 2003 Software Diamonds
=item Copyright holder contact.
603 882-0846 E<lt>support@SoftwareDiamonds.comE<gt>
=item License.
Software Diamonds permits the redistribution
and use in source and binary forms, with or
without modification, provided that the
following conditions are met:
=over 4
=item 1
Redistributions of source code, modified or unmodified
must retain the above copyright notice, this list of
conditions and the following disclaimer.
=item 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.
=back
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.
=back
=head2 3.2 Inventory of software contents
The content of the released, compressed, archieve file,
consists of the following files:
file version date comment
------------------------------------------------------------ ------- ---------- ------------------------
lib/Docs/Site_SVD/File_Package.pm 0.06 2004/04/26 revised 0.05
MANIFEST 0.06 2004/04/26 generated, replaces 0.05
Makefile.PL 0.06 2004/04/26 generated, replaces 0.05
README 0.06 2004/04/26 generated, replaces 0.05
lib/File/Package.pm 1.16 2004/04/26 revised 1.15
t/File/Package.d 0.03 2004/04/26 revised 0.02
t/File/Package.pm 0.01 2004/04/10 unchanged
t/File/Package.t 0.12 2004/04/26 revised 0.11
t/File/_File_/BadLoad.pm 0.01 2004/04/10 unchanged
t/File/_File_/BadPackage.pm 0.01 2004/04/10 unchanged
t/File/_File_/Hyphen-Test.pm 1.15 2004/04/10 unchanged
t/File/_File_/Multi.pm 1.15 2004/04/10 unchanged
t/File/Test/Tech.pm 1.21 2004/04/26 revised 1.17
t/File/Data/Secs2.pm 1.18 2004/04/26 revised 1.15
t/File/Data/SecsPack.pm 0.03 2004/04/26 new
t/File/Data/Startup.pm 0.03 2004/04/26 new
=head2 3.3 Changes
The file names from 0.05 were changed as follows:
return if $file =~ s=lib/File/FileUtil.pm=lib/File/Package.pm=;
return if $file =~ s=t/File/FileUtil/FileUtil.t=t/File/package.t=;
Changes to past revisions are as follows:
=over 4
=item Test-TestUtil-0.01
Originated
=item Test-TestUtil-0.02
Correct failure from Josts Smokehouse" <Jost.Krieger+smokeback@ruhr-uni-bochum.de>
test run
t/Test/TestUtil/TestUtil....Bareword "fspec_dirs" not allowed
while "strict subs" in use at
/net/sunu991/disc1/.cpanplus/5.8.0/build/Test-TestUtil-0.01/blib/lib/Test/TestUtil.pm line 56.
Changed line 56 from
my @dirs = (fspec_dirs) ? $from_package->splitdir( $fspec_dirs ) : ();
to
my @dirs = ($fspec_dirs) ? $from_package->splitdir( $fspec_dirs ) : ();
This error is troublesome since the test passed on my system using Active Perl
under Microsoft NT. It should never have passed.
This error is in a core method, I<fspec2fspec>,
that changes file specifications from one operating system
to another operating system.
This method has been in service unchanged for some time.
=item Test-TestUtil-0.03
Correct failure from Josts Smokehouse" <Jost.Krieger+smokeback@ruhr-uni-bochum.de>
test run
PERL_DL_NONLAZY=1 /usr/local/perl/bin/perl "-MExtUtils::Command::MM" "-e" "test_harness(0, 'blib/lib', 'blib/arch')" t/Test/TestUtil/TestUtil.t
t/Test/TestUtil/TestUtil....# Test 18 got: '$VAR1 = '';
' (t/Test/TestUtil/TestUtil.t at line 540 fail #17)
# Expected: '$VAR1 = '\\=head1 Title Page
The I<pm2datah> method is not returning any data for Test 18. This will also cause
the test of I<pm2data>, test 19 to fail.
The I<pm2datah> is searching for the string "\n__DATA__\n".
The "\n" character on Perl is a logical end of line character sequence.
The "\n" end of line is different on Mr. Smokehouse's Unix operating system
than on my Windows NT operating system.
The test file was created under MSWin32 and uses a MSWin32 "\n".
Under UNIX, I<pm2datah> method will look for the Unix "\n"
and there will not be any.
Changed "\n__DATA__\n" to /[\012\015]__DATA__/.
During the clean-up for CPAN, broke the I<format_hash_table>
method for tables in hash of hash format.
Fixed the break, added test 29 to the I<t/Test/TestUtil/TestUtil.t>
test script for this
feature, and added a discusssion of this feature in
POD discription for I<format_hash_table>
=item Test-TestUtil-0.04
item our old friend visits again - DOS and UNIX text file incompatibility
This impacts other modules. We have to examine all modules for
this portability defect and correct any found defects.
Correct failure from Josts Smokehouse" <Jost.Krieger+smokeback@ruhr-uni-bochum.de>
and Kingpin <mthurn@carbon> test runs.
On Mr. Smokehouse's run email the got: VAR1 clearly showed extra white space
line that is not present in the expected: VAR1.
In Mr. Kingpin's run the got: VAR1 and expected: VAR1 look visually the same.
However, the Unix found a difference(s) and failed the test.
For Mr. Smokehouse's run:
PERL_DL_NONLAZY=1 /usr/local/bin/perl "-MExtUtils::Command::MM" "-e" "test_harness(0, 'blib/lib', 'blib/arch')" t/Test/TestUtil/TestUtil.t
t/Test/TestUtil/TestUtil....NOK 18# Test 18 got: '$VAR1 = '\\=head1 Title Page
Software Version Description
for
File::Package - test load a pm and import symbs without eval and $@ misbehavoirs
Revision: E
[snip]
(t/Test/TestUtil/TestUtil.t at line 565 fail #17)
# Expected: '$VAR1 = '\\=head1 Title Page
Software Version Description
for
File::Package - test load a pm and import symbs without eval and $@ misbehavoirs
What we have before, was a totally "failure to communicate." aka Cool Hand Luke.
VAR1 was empty. Now VAR1 has something. It is not completely dead.
One probable cause is the Unix operating system must be producing two Unix \012 new lines
for a Microsoft single newline \015\012.
Without being able to examine the test with a debugger, the only way to verify
this is to provide the fix and see if the problem goes away when this great group
of testers try for the fourth time.
Revised I<fin> method to take a handle, change I<pm2datah> method handle, I<$fh>,
to binary by adding a I<binmode $fh> statement, and pass the actual
thru the I<fin> method for test 18.
Use I<fin($fh)> to read in the data for I<pm2data>, test 19 Unit Under Test (UUT),
instead of using the raw file handle.
The I<fin> method takes any \015\012 combination and changes it into the
logical Perl new line, I<"\n">, for the current operating system.
=item File-FileUtil-0.01
=over 4
=item *
At 02:44 AM 6/14/2003 +0200, Max Maischein wrote:
A second thing that I would like you to reconsider is the naming of
"Test::TestUtil" respectively "Test::Tech" - neither of those is descriptive
of what the routines actually do or what the module implements. I would
recommend renaming them to something closer to your other modules, maybe
"Test::SVDMaker::Util" and "Test::SVDMaker::Tech", as some routines do not
seem to be specific to the Test::-suite but rather general
(format_array_table). Some parts (the "scrub" routines) might even better
live in another module namespace, "Test::Util::ScrubData" or something like
that.
Broke away all the file related methods from Test::TestUtil and
created this module File::FileUtil so the module name is
more descriptive of the methods within the module.
=item *
Broke the smart nl code out of the fin method and made it
is own separate method, smart_nl method.
At 02:44 AM 6/14/2003 +0200, Max Maischein wrote:
Perl, as Perl already does smart newline handling, (even though with the
advent of 5.8 even Unix-people have to learn the word "binmode" now :-))
The only place where I see Perl does smart newline handling is
the crlf IO displine introduce in Perl 5.6. The File::FileUtil has
a use 5.001 so that 5.6 Perl built-ins cannot be used. Added comment
to smart_nl that for users with 5.6 Perl that it may be better to
use the built-in crlf IO discipline.
=item *
For the load_package method that uses a eval "require $package" to load the
package, the $@ does not capture all the warnings and error messages,
at least not with ActiveState Perl. Added code the captures also the
warnings, by temporaily reassigning $SIG(__WARN__), and added these
to the $@ error messages.
=item *
Added two new tests to verify the NOGO paths for the for the load_package
method. One tests for load module failure looking for all the possilbe
information on why the module did not load. The other verifies that
the vocabulary is present after the loading the module.
This information is very helpful when you must remote debug a load
failure from CPAN testing whose is running on a different platform.
=back
=item File-FileUtil-0.02
Added the method I<hex_dump>.
=item File-FileUtil-0.03
=over 4
=item test_lib2inc
Returns to parent directory of
the first t directory going up
from the test script instead of the
t directory.
=item find_t_roots
Added the function find_t_roots that
returns the parent directory of all
the directories in @INC
=back
=item File-Package-0.01
Removed the methods for loading a
program module with the same name
from the "File::FileUtil" module to their own module
"File::Package" module.
The module name is now much more descriptive
of the routines in the module.
=item File-Package-0.02
Replace the obsolete "File::FileUtil" with File::Packgage
in the test script "t\File\package.t".
=item File-Package-0.03
Added subroutine interfaces.
Added @import input to load_packages method
=item File-Package-0.04
Upgraded the 'tlib\Test\Tech' and changed the
name of 'tlib\Data\strify' to 'tlib\Data\Secs2'.
The new name is more self-explanatory.
=item File-Package-0.05
The lastest build of Test::STDmaker expects the test library in the same
directory as the test script.
Coordiated with the lastest Test::STDmaker by moving the
test library from tlib to t/File, the same directory as the test script
and deleting the test library File::TestPath program module.
=item File-Package-0.06
Added C<Carp::longmess>, that dumps the call stack, to the
Carp::croak trap function.
=item File-Package-0.07
Expanded the description.
Under the Perl 5.6, Microsoft distribute, C<Carp> program module,
C<import> sends warings out using C<&Carp::carp> function as well
as C<Carp::croak> function. Adjust to also pick up these messages.
=back
=head2 3.4 Adaptation data.
This installation requires that the installation site
has the Perl programming language installed.
There are no other additional requirements or tailoring needed of
configurations files, adaptation data or other software needed for this
installation particular to any installation site.
=head2 3.5 Related documents.
There are no related documents needed for the installation and
test of this release.
=head2 3.6 Installation instructions.
Instructions for installation, installation tests
and installation support are as follows:
=over 4
=item Installation Instructions.
To installed the release file, use the CPAN module
pr PPM module in the Perl release
or the INSTALL.PL script at the following web site:
http://packages.SoftwareDiamonds.com
Follow the instructions for the the chosen installation software.
If all else fails, the file may be manually installed.
Enter one of the following repositories in a web browser:
http://www.softwarediamonds/packages/
http://www.perl.com/CPAN/authors/id/S/SO/SOFTDIA/
Right click on 'File-Package-0.06.tar.gz' and download to a temporary
installation directory.
Enter the following where $make is 'nmake' for microsoft
windows; otherwise 'make'.
gunzip File-Package-0.06.tar.gz
tar -xf File-Package-0.06.tar
perl Makefile.PL
$make test
$make install
On Microsoft operating system, nmake, tar, and gunzip
must be in the exeuction path. If tar and gunzip are
not install, download and install unxutils from
http://packages.softwarediamonds.com
=item Prerequistes.
None.
=item Security, privacy, or safety precautions.
None.
=item Installation Tests.
Most Perl installation software will run the following test script(s)
as part of the installation:
t/File/Package.t
=item Installation support.
If there are installation problems or questions with the installation
contact
603 882-0846 E<lt>support@SoftwareDiamonds.comE<gt>
=back
=head2 3.7 Possible problems and known errors
There is still much work needed to ensure the quality
of this module as follows:
=over 4
=item *
State the functional requirements for each method
including not only the GO paths but also what to
expect for the NOGO paths
=item *
All the tests are GO path tests. Should add
NOGO tests.
=item *
Add the requirements addressed as I<# R: >
comment to the tests
=back
=head1 4.0 NOTES
The following are useful acronyms:
=over 4
=item .d
extension for a Perl demo script file
=item .pm
extension for a Perl Library Module
=item .t
extension for a Perl test script file
=item POD
Plain Old Documentation
=back
=head1 2.0 SEE ALSO
=over 4
=item L<File::Package|File::Package>
=item L<Docs::US_DOD::SVD|Docs::US_DOD::SVD>
=back
=for html
<hr>
<p><br>
<!-- BLK ID="PROJECT_MANAGEMENT" -->
<!-- /BLK -->
<p><br>
<!-- BLK ID="NOTICE" -->
<!-- /BLK -->
<p><br>
<!-- BLK ID="OPT-IN" -->
<!-- /BLK -->
<p><br>
<!-- BLK ID="LOG_CGI" -->
<!-- /BLK -->
<p><br>
=cut
1;
__DATA__
DISTNAME: File-Package^
VERSION : 0.06^
FREEZE: 1^
PREVIOUS_DISTNAME: ^
PREVIOUS_RELEASE: 0.05^
REVISION: E^
AUTHOR : SoftwareDiamonds.com E<lt>support@SoftwareDiamonds.comE<gt>^
ABSTRACT: test load a pm and import symbols without eval and $@ misbehavoirs^
TITLE : File::Package - test load a pm and import symbs without eval and $@ misbehavoirs^
END_USER: General Public^
COPYRIGHT: copyright © 2003 Software Diamonds^
CLASSIFICATION: NONE^
TEMPLATE: ^
CSS: help.css^
SVD_FSPEC: Unix^
REPOSITORY_DIR: packages^
REPOSITORY:
http://www.softwarediamonds/packages/
http://www.perl.com/CPAN/authors/id/S/SO/SOFTDIA/
^
COMPRESS: gzip^
COMPRESS_SUFFIX: gz^
RESTRUCTURE: ^
CHANGE2CURRENT:
return if $file =~ s=lib/File/FileUtil.pm=lib/File/Package.pm=;
return if $file =~ s=t/File/FileUtil/FileUtil.t=t/File/package.t=;
^
AUTO_REVISE:
lib/File/Package.pm
t/File/Package.*
t/File/_File_/BadLoad.pm
t/File/_File_/BadPackage.pm
t/File/_File_/Hyphen-Test.pm
t/File/_File_/Multi.pm
lib/Test/Tech.pm => t/File/Test/Tech.pm
lib/Data/Secs2.pm => t/File/Data/Secs2.pm
lib/Data/SecsPack.pm => t/File/Data/SecsPack.pm
lib/Data/Startup.pm => t/File/Data/Startup.pm
^
PREREQ_PM: ^
README_PODS: lib/File/Package.pm^
TESTS: t/File/Package.t^
EXE_FILES: ^
CHANGES:
Changes to past revisions are as follows:
\=over 4
\=item Test-TestUtil-0.01
Originated
\=item Test-TestUtil-0.02
Correct failure from Josts Smokehouse" <Jost.Krieger+smokeback@ruhr-uni-bochum.de>
test run
t/Test/TestUtil/TestUtil....Bareword "fspec_dirs" not allowed
while "strict subs" in use at
/net/sunu991/disc1/.cpanplus/5.8.0/build/Test-TestUtil-0.01/blib/lib/Test/TestUtil.pm line 56.
Changed line 56 from
my @dirs = (fspec_dirs) ? $from_package->splitdir( $fspec_dirs ) : ();
to
my @dirs = ($fspec_dirs) ? $from_package->splitdir( $fspec_dirs ) : ();
This error is troublesome since the test passed on my system using Active Perl
under Microsoft NT. It should never have passed.
This error is in a core method, I<fspec2fspec>,
that changes file specifications from one operating system
to another operating system.
This method has been in service unchanged for some time.
\=item Test-TestUtil-0.03
Correct failure from Josts Smokehouse" <Jost.Krieger+smokeback@ruhr-uni-bochum.de>
test run
PERL_DL_NONLAZY=1 /usr/local/perl/bin/perl "-MExtUtils::Command::MM" "-e" "test_harness(0, 'blib/lib', 'blib/arch')" t/Test/TestUtil/TestUtil.t
t/Test/TestUtil/TestUtil....# Test 18 got: '$VAR1 = '';
' (t/Test/TestUtil/TestUtil.t at line 540 fail #17)
# Expected: '$VAR1 = '\\=head1 Title Page
The I<pm2datah> method is not returning any data for Test 18. This will also cause
the test of I<pm2data>, test 19 to fail.
The I<pm2datah> is searching for the string "\n__DATA__\n".
The "\n" character on Perl is a logical end of line character sequence.
The "\n" end of line is different on Mr. Smokehouse's Unix operating system
than on my Windows NT operating system.
The test file was created under MSWin32 and uses a MSWin32 "\n".
Under UNIX, I<pm2datah> method will look for the Unix "\n"
and there will not be any.
Changed "\n__DATA__\n" to /[\012\015]__DATA__/.
During the clean-up for CPAN, broke the I<format_hash_table>
method for tables in hash of hash format.
Fixed the break, added test 29 to the I<t/Test/TestUtil/TestUtil.t>
test script for this
feature, and added a discusssion of this feature in
POD discription for I<format_hash_table>
\=item Test-TestUtil-0.04
item our old friend visits again - DOS and UNIX text file incompatibility
This impacts other modules. We have to examine all modules for
this portability defect and correct any found defects.
Correct failure from Josts Smokehouse" <Jost.Krieger+smokeback@ruhr-uni-bochum.de>
and Kingpin <mthurn@carbon> test runs.
On Mr. Smokehouse's run email the got: VAR1 clearly showed extra white space
line that is not present in the expected: VAR1.
In Mr. Kingpin's run the got: VAR1 and expected: VAR1 look visually the same.
However, the Unix found a difference(s) and failed the test.
For Mr. Smokehouse's run:
PERL_DL_NONLAZY=1 /usr/local/bin/perl "-MExtUtils::Command::MM" "-e" "test_harness(0, 'blib/lib', 'blib/arch')" t/Test/TestUtil/TestUtil.t
t/Test/TestUtil/TestUtil....NOK 18# Test 18 got: '$VAR1 = '\\=head1 Title Page
Software Version Description
for
${TITLE}
Revision: ${REVISION}
[snip]
(t/Test/TestUtil/TestUtil.t at line 565 fail #17)
# Expected: '$VAR1 = '\\=head1 Title Page
Software Version Description
for
${TITLE}
What we have before, was a totally "failure to communicate." aka Cool Hand Luke.
VAR1 was empty. Now VAR1 has something. It is not completely dead.
One probable cause is the Unix operating system must be producing two Unix \012 new lines
for a Microsoft single newline \015\012.
Without being able to examine the test with a debugger, the only way to verify
this is to provide the fix and see if the problem goes away when this great group
of testers try for the fourth time.
Revised I<fin> method to take a handle, change I<pm2datah> method handle, I<$fh>,
to binary by adding a I<binmode $fh> statement, and pass the actual
thru the I<fin> method for test 18.
Use I<fin($fh)> to read in the data for I<pm2data>, test 19 Unit Under Test (UUT),
instead of using the raw file handle.
The I<fin> method takes any \015\012 combination and changes it into the
logical Perl new line, I<"\n">, for the current operating system.
\=item File-FileUtil-0.01
\=over 4
\=item *
At 02:44 AM 6/14/2003 +0200, Max Maischein wrote:
A second thing that I would like you to reconsider is the naming of
"Test::TestUtil" respectively "Test::Tech" - neither of those is descriptive
of what the routines actually do or what the module implements. I would
recommend renaming them to something closer to your other modules, maybe
"Test::SVDMaker::Util" and "Test::SVDMaker::Tech", as some routines do not
seem to be specific to the Test::-suite but rather general
(format_array_table). Some parts (the "scrub" routines) might even better
live in another module namespace, "Test::Util::ScrubData" or something like
that.
Broke away all the file related methods from Test::TestUtil and
created this module File::FileUtil so the module name is
more descriptive of the methods within the module.
\=item *
Broke the smart nl code out of the fin method and made it
is own separate method, smart_nl method.
At 02:44 AM 6/14/2003 +0200, Max Maischein wrote:
Perl, as Perl already does smart newline handling, (even though with the
advent of 5.8 even Unix-people have to learn the word "binmode" now :-))
The only place where I see Perl does smart newline handling is
the crlf IO displine introduce in Perl 5.6. The File::FileUtil has
a use 5.001 so that 5.6 Perl built-ins cannot be used. Added comment
to smart_nl that for users with 5.6 Perl that it may be better to
use the built-in crlf IO discipline.
\=item *
For the load_package method that uses a eval "require $package" to load the
package, the $@ does not capture all the warnings and error messages,
at least not with ActiveState Perl. Added code the captures also the
warnings, by temporaily reassigning $SIG(__WARN__), and added these
to the $@ error messages.
\=item *
Added two new tests to verify the NOGO paths for the for the load_package
method. One tests for load module failure looking for all the possilbe
information on why the module did not load. The other verifies that
the vocabulary is present after the loading the module.
This information is very helpful when you must remote debug a load
failure from CPAN testing whose is running on a different platform.
\=back
\=item File-FileUtil-0.02
Added the method I<hex_dump>.
\=item File-FileUtil-0.03
\=over 4
\=item test_lib2inc
Returns to parent directory of
the first t directory going up
from the test script instead of the
t directory.
\=item find_t_roots
Added the function find_t_roots that
returns the parent directory of all
the directories in @INC
\=back
\=item File-Package-0.01
Removed the methods for loading a
program module with the same name
from the "File::FileUtil" module to their own module
"File::Package" module.
The module name is now much more descriptive
of the routines in the module.
\=item File-Package-0.02
Replace the obsolete "File::FileUtil" with File::Packgage
in the test script "t\File\package.t".
\=item File-Package-0.03
Added subroutine interfaces.
Added @import input to load_packages method
\=item File-Package-0.04
Upgraded the 'tlib\Test\Tech' and changed the
name of 'tlib\Data\strify' to 'tlib\Data\Secs2'.
The new name is more self-explanatory.
\=item File-Package-0.05
The lastest build of Test::STDmaker expects the test library in the same
directory as the test script.
Coordiated with the lastest Test::STDmaker by moving the
test library from tlib to t/File, the same directory as the test script
and deleting the test library File::TestPath program module.
\=item File-Package-0.06
Added C<Carp::longmess>, that dumps the call stack, to the
Carp::croak trap function.
\=item File-Package-0.07
Expanded the description.
Under the Perl 5.6, Microsoft distribute, C<Carp> program module,
C<import> sends warings out using C<&Carp::carp> function as well
as C<Carp::croak> function. Adjust to also pick up these messages.
\=back
^
DOCUMENT_OVERVIEW:
This document releases ${NAME} version ${VERSION}
providing a description of the inventory, installation
instructions and other information necessary to
utilize and track this release.
^
CAPABILITIES:
One very useful test of the installation of a package is whether
or not the package loaded.
If it did not load, the reason it did not load is helpful
diagnostics and may be used to programically (automatically) take corrective
action.
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 error messages are returned with a warn instead of die so
that the using program may take the appropriate action such
as reporting the errors back to the author when used in test
software or perhaps falling back on a system 'gzip' command
when the 'Compress::Zlib' module fails to load.
^
PROBLEMS:
There is still much work needed to ensure the quality
of this module as follows:
\=over 4
\=item *
State the functional requirements for each method
including not only the GO paths but also what to
expect for the NOGO paths
\=item *
All the tests are GO path tests. Should add
NOGO tests.
\=item *
Add the requirements addressed as I<# R: >
comment to the tests
\=back
^
LICENSE:
Software Diamonds permits the redistribution
and use in source and binary forms, with or
without modification, provided that the
following conditions are met:
\=over 4
\=item 1
Redistributions of source code, modified or unmodified
must retain the above copyright notice, this list of
conditions and the following disclaimer.
\=item 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.
\=back
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.
^
INSTALLATION:
To installed the release file, use the CPAN module
pr PPM module in the Perl release
or the INSTALL.PL script at the following web site:
http://packages.SoftwareDiamonds.com
Follow the instructions for the the chosen installation software.
If all else fails, the file may be manually installed.
Enter one of the following repositories in a web browser:
${REPOSITORY}
Right click on '${DIST_FILE}' and download to a temporary
installation directory.
Enter the following where $make is 'nmake' for microsoft
windows; otherwise 'make'.
gunzip ${BASE_DIST_FILE}.tar.${COMPRESS_SUFFIX}
tar -xf ${BASE_DIST_FILE}.tar
perl Makefile.PL
$make test
$make install
On Microsoft operating system, nmake, tar, and gunzip
must be in the exeuction path. If tar and gunzip are
not install, download and install unxutils from
http://packages.softwarediamonds.com
^
SUPPORT: 603 882-0846 E<lt>support@SoftwareDiamonds.comE<gt>
^
SUPPORT: 603 882-0846 E<lt>support@SoftwareDiamonds.comE<gt>^
NOTES:
The following are useful acronyms:
\=over 4
\=item .d
extension for a Perl demo script file
\=item .pm
extension for a Perl Library Module
\=item .t
extension for a Perl test script file
\=item POD
Plain Old Documentation
\=back
^
SEE_ALSO:
\=over 4
\=item L<File::Package|File::Package>
\=item L<Docs::US_DOD::SVD|Docs::US_DOD::SVD>
\=back
^
HTML:
<hr>
<p><br>
<!-- BLK ID="PROJECT_MANAGEMENT" -->
<!-- /BLK -->
<p><br>
<!-- BLK ID="NOTICE" -->
<!-- /BLK -->
<p><br>
<!-- BLK ID="OPT-IN" -->
<!-- /BLK -->
<p><br>
<!-- BLK ID="LOG_CGI" -->
<!-- /BLK -->
<p><br>
^
~-~