NAME
Text::Scrub - used to wild card out text used for comparison
SYNOPSIS
#########
# Subroutine Interface
#
use Text::Scrub qw(scrub_date scrub_date_ticket scrub_date_version
scrub_file_line scrub_probe scrub_test_file);
$scrubbed_text = scrub_date($script_text)
$scrubbed_text = scrub_date_ticket($script_text)
$scrubbed_text = scrub_date_version($script_text)
$scrubbed_text = scrub_file_line($script_text)
$scrubbed_text = scrub_probe($script_text)
$scrubbed_text = scrub_test_file($script_text)
#########
# Class Interface
#
use Text::Scrub
$scrubbed_text = Text::Scrub->scrub_date($script_text)
$scrubbed_text = Text::Scrub->scrub_date_ticket($script_text)
$scrubbed_text = Text::Scrub->scrub_date_version($script_text)
$scrubbed_text = Text::Scrub->scrub_file_line($script_text)
$scrubbed_text = Text::Scrub->scrub_probe($script_text)
$scrubbed_text = Text::Scrub->scrub_test_file($script_text)DESCRIPTION
The methods in the Test::STD:Scrub package are designed to support the Test::STDmaker and the ExtUtils::SVDmaker package. This is the focus and no other focus. Since Test::STD::Scrub 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.
scrub_date_ticket
$scrubbed_text = Test::STD::Scrub->scrub_date_ticket($script_text)When comparing the contents of email messages, the date and email ticket should not be used in the comparision. The scrub_date_ticket method will replace the date and email ticket with a generic value. Applying the scrub_date_ticket to the contents of both files before the comparision will eliminate the data and ticket as factors in the comparision.
scrub_date_version
$scrubbed_text = Test::STD::Scrub->scrub_date_version($script_text)When comparing the contents of two Perl program modules, the date and version should not be used in the comparision. The scrub_date_ticket method will replace the date and version with a generic value. Applying the scrub_date_ticket to the contents of both files before the comparision will eliminate the date and version as factors in the comparision.
scrub_file_line
$scrubbed_text = Test::STD::Scrub->scrub_file_line($script_text)When comparing the ouput of Test module the file and line number should not be used in the comparision. The scrub_file_line method will replace the file and line with a generic value. Applying the scrub_file_line to the contents of both files before the comparision will eliminate the file and line as factors in the comparision.
scrub_test_file
$scrubbed_text = Test::STD::Scrub->scrub_test_file($script_text)When comparing the ouput of Test:Harness module the test file should not be used in the comparision. The scrub_test_file method will replace the test file with a generic value. Applying the scrub_test_file to the contents of both files before the comparision will eliminate the test file as a factor in the comparision.
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 $fp = 'File::Package';
=> my $uut = 'Text::Scrub';
=> my $loaded = '';
=> my $template = '';
=> my %variables = ();
=> my $expected = '';
=> my $errors = $fp->load_package($uut)
=> $errors
''
=> my $text = 'ok 2 # (E:/User/SoftwareDiamonds/installation/t/Test/STDmaker/tgA1.t at line 123 TODO?!)'
=> $uut->scrub_file_line($text)
'ok 2 # (xxxx.t at line 000 TODO?!)'
=> $text = 'Running Tests\n\nE:/User/SoftwareDiamonds/installation/t/Test/STDmaker/tgA1.1..16 todo 2 5;'
=> $uut->scrub_test_file($text)
'Running Tests xxx.t 1..16 todo 2 5;'
=> $text = '$VERSION = \'0.01\';\n$DATE = \'2003/06/07\';'
=> $uut->scrub_date_version($text)
'$VERSION = '0.00';\n$DATE = 'Feb 6, 1969';'
=> $text = <<'EOF';
=> Date: Apr 12 00 00 00 2003 +0000
=> Subject: 20030506, This Week in Health'
=> X-SDticket: 20030205
=> X-eudora-date: Feb 6 2000 00 00 2003 +0000
=> X-SDmailit: dead Feb 5 2000 00 00 2003
=> Sent email 20030205-20030506 to support.softwarediamonds.com
=> EOF
=> my $expected_text = <<'EOF';
=> Date: Feb 6 00 00 00 1969 +0000
=> Subject: XXXXXXXXX-X, This Week in Health'
=> X-SDticket: XXXXXXXXX-X
=> X-eudora-date: Feb 6 00 00 00 1969 +0000
=> X-SDmailit: dead Sat Feb 6 00 00 00 1969 +0000
=> Sent email XXXXXXXXX-X to support.softwarediamonds.com
=> EOF
=> # end of EOF
=> $uut->scrub_date_ticket($text)
'Date: Feb 6 00 00 00 1969 +0000
Subject: XXXXXXXXX-X, This Week in Health'
X-SDticket: XXXXXXXXX-X
X-eudora-date: Feb 6 00 00 00 1969 +0000
X-SDmailit: dead Sat Feb 6 00 00 00 1969 +0000
Sent email XXXXXXXXX-X to support.softwarediamonds.com
'
=> $text = 'Going to happy valley 2003/06/07'
=> $uut->scrub_date($text)
'Going to happy valley 1969/02/06'
=> $text = <<'EOF';
=> 1..8 todo 2 5;
=> # OS : MSWin32
=> # Perl : 5.6.1
=> # Local Time : Thu Jun 19 23:49:54 2003
=> # GMT Time : Fri Jun 20 03:49:54 2003 GMT
=> # Number Storage: string
=> # Test::Tech : 1.06
=> # Test : 1.15
=> # Data::Dumper : 2.102
=> # =cut
=> # Pass test
=> ok 1
=> EOF
=> $expected_text = <<'EOF';
=> 1..8 todo 2 5;
=> # Pass test
=> ok 1
=> EOF
=> # end of EOF
=> $uut->scrub_probe($text)
'1..8 todo 2 5;
# Pass test
ok 1
'
=> unlink 'actual.txt'QUALITY ASSURANCE
Running the test script 'Scrub.t' found in the "Text-Scrub-$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::Text::Scrub', found in the distribution file "Text-Scrub-$VERSION.tar.gz".
The 't::Text::Scrub' 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 'Scrub.t' test script.
The t::Text::Scrub' STD program module '__DATA__' section contains the data to perform the following:
to generate the test script 'Scrub.t'
generate the tailored STD POD in the 't::Text::Scrub' module,
generate the 'Scrub.d' demo script,
Replace the POD demonstration section herein with the demo script 'Scrub.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::Text::Scrub' at the same level in the directory struture as the directory holding the 'Text::Scrub' module
execute the following in any directory:
tmake -test_verbose -replace -run -pm=t::Text::Scrub
NOTES
FILES
The installation of the "Text-Scrub-$VERSION.tar.gz" distribution file installs the 'Docs::Site_SVD::Text_Scrub' SVD program module.
The __DATA__ data section of the 'Docs::Site_SVD::Text_Scrub' contains all the necessary data to generate the POD section of 'Docs::Site_SVD::Text_Scrub' and the "Text-Scrub-$VERSION.tar.gz" distribution file.
To make use of the 'Docs::Site_SVD::Text_Scrub' 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::Text_Scrub' module. For example, any changes to 'Text::Scrub' will impact the at least 'Changes' field.
Execute the following:
vmake readme_html all -pm=Docs::Site_SVD::Text_Scrub
NOTES
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.