NAME
Test::STD::STDutil - generic functions that support Test::STDmaker
SYNOPSIS
use Test::STD::STDutil
$table = Test::STD::STDutil->format_hash_table(\%hash, \@width, \@header)
$table = Test::STD::STDutil->format_array_table(\@array, \@width, \@header)
$date = Test::STD::STDutil->get_date( )
$success = Test::STD::STDutil->replace_variables( \$template, \%variable_hash, \@variable)DESCRIPTION
The methods in the Test::STD:STDutil package are designed to support the Test::STDmaker and the ExtUtils::SVDmaker package. This is the focus and no other focus. Since Test::STD::STDutil is a separate package, the methods may be used elsewhere. In all likehood, any revisions will maintain backwards compatibility with previous revisions. However, support and the performance of the Test::STDmaker and ExtUtils::SVDmaker packages has priority over backwards compatibility.
format_array_table method
$formated_table = Test::STD::STDutil->format_array_table(\@array, \@width, \@header)The format_array_table method provides a formatted table suitable for inclusion in a POD. The \@array variable references an array of array references. Each array reference in the top array is for a row array that contains the items in column order for the row. The \@width variable references the width of each column in column order while the \@header references the table column names in column order.
For example,
==> @array_table
([qw(module.pm 0.01 2003/5/6 new)],
[qw(bin/script.pl 1.04 2003/5/5 generated)],
[qw(bin/script.pod 3.01 2003/6/8), 'revised 2.03'])
Test::STD::STDutil->format_array_table(\@array_table, [15,7,10,15], [qw(file version date comment)])
file version date comment
--------------- ------- ---------- ---------------
module.pm 0.01 2003/5/6 new
bin/script.pl 1.04 2003/5/5 generated
bin/script.pod 3.01 2003/6/8 revised 2.03format_hash_table method
$table = Test::STD::STDutil->format_hash_table(\%hash, \@width, \@header)The format_hash_table method provides a formatted table suitable for inclusion in a POD. The \%array variable references a hash of references to either arrays or hashes. Each key is the first column of a row. An array referenced by the hash value contains the items in column order for the rest of the row. The keys of a hash referenced by the hash value is the items for the next column in the row. Any other hash value signals the end of the row. The format_hash_table method always sort hash keys.
The \@width variable references the width of each column in column order while the \@header references the table column names in column order.
For example,
=> %hash_array_table
('module.pm' => [qw(0.01 2003/5/6 new)],
'bin/script.pl' => [qw(1.04 2003/5/5 generated)],
'bin/script.pod' => [qw(3.01 2003/6/8), 'revised 2.03'])
==> Test::STD::STDutil->format_hash_table(\%hash_array_table, [15,7,10,15],[qw(file version date comment)])
file version date comment
--------------- ------- ---------- ---------------
bin/script.pl 1.04 2003/5/5 generated
bin/script.pod 3.01 2003/6/8 revised 2.03
module.pm 0.01 2003/5/6 new
==> %hash_hash_table
('L<test1>' => {'L<requirement4>' => undef, 'L<requirement1>' => undef },
'L<test2>' => {'L<requirement3>' => undef },
'L<test3>' => {'L<requirement2>' => undef, 'L<requirement1>' => undef },)
==> Test::STD::STDutil->format_hash_table(\%hash_hash_table, [20,20],[qw(test requirement)])
test requirement
-------------------- --------------------
L<test1> L<requirement1>
L<test1> L<requirement4>
L<test2> L<requirement3>
L<test3> L<requirement1>
L<test3> L<requirement2>get_date method
$date = Test::STD::STDutil->get_date( )The get_date method returns the data in yyyy/mm/dd format. This is the preferred US Department of Defense (DOD) format because the dates sort naturally in ascending order.
For example,
=> Test::STD::STDutil->get_date( )
1969/02/06replace_variables
$success = Test::STD::STDutil->replace_variables( \$template, \%variable_hash, \@variable)For example
==> $template
=head1 Title Page
Software Version Description
for
${TITLE}
Revision: ${REVISION}
Version: ${VERSION}
Date: ${DATE}
Prepared for: ${END_USER}
Prepared by: ${AUTHOR}
Copyright: ${COPYRIGHT}
Classification: ${CLASSIFICATION}
=cut
==> %variables
(TITLE => 'SVDmaker',
REVISION => '-',
VERSION => '0.01',
DATE => '2003/6/10',
END_USER => 'General Public',
AUTHOR => 'Software Diamonds',
COPYRIGHT => 'none',
CLASSIFICATION => 'none')
==> $Test::STD::STDutil->replace_variables(\$template, \%variables);
=head1 Title Page
Software Version Description
for
SVDmaker
Revision: -
Version: 0.01
Date: 2003/6/10
Prepared for: General Public
Prepared by: Software Diamonds
Copyright: none
Classification: none
=cutNOTES
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:
Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
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.