Software Version Description for Text::Scrub - Utilites to wild card parts of a text file for comparisons.


Title Page

 Software Version Description
 for
 Text::Scrub - Utilites to wild card parts of a text file for comparisons.
 Revision: B
 Version: 0.03
 Date: 2003/09/15
 Prepared for: General Public
 Prepared by:  SoftwareDiamonds.com E<lt>support@SoftwareDiamonds.comE<gt>
 Copyright: copyright  2003 Software Diamonds
 Classification: NONE

'Back to Top'


1.0 SCOPE

This paragraph identifies and provides an overview of the released files.

1.1 Identification

This release, identified in 3.2, is a collection of Perl modules that extend the capabilities of the Perl language.

1.2 System overview

The ``Text::Scrub'' module extends the Perl language (the system).

When comparing text there are small snippets such as version numbers and dates that should be wild carded out and not influence the comparisions. The Test::STD:Scrub module replaces these small snippets with invariant snippet. By replacing the same part of each file with the same invariant snippet, those small sections of text are effectively wild carded for the comparisions.

When performing tests, the ability to wild card small snippets of text is vital in making accurate comparison. The same capability is also essential for version control in comparing two pieces of software to see if there are significant changes.

1.3 Document overview.

This document releases Text::Scrub version 0.03 providing a description of the inventory, installation instructions and other information necessary to utilize and track this release.

'Back to Top'


3.0 VERSION DESCRIPTION

All file specifications in this SVD use the Unix operating system file specification.

3.1 Inventory of materials released.

This document releases the file found at the following repository(s):

   http://www.softwarediamonds/packages/Text-Scrub-0.03
   http://www.perl.com/CPAN-local/authors/id/S/SO/SOFTDIA/Text-Scrub-0.03

Restrictions regarding duplication and license provisions are as follows:

Copyright.
copyright 2003 Software Diamonds

Copyright holder contact.
 603 882-0846 E<lt>support@SoftwareDiamonds.comE<gt>
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, modified or unmodified 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.

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/Text_Scrub.pm                              0.03    2003/09/15 revised 0.02
 MANIFEST                                                     0.03    2003/09/15 generated, replaces 0.02
 Makefile.PL                                                  0.03    2003/09/15 generated, replaces 0.02
 README                                                       0.03    2003/09/15 generated, replaces 0.02
 lib/Text/Scrub.pm                                            1.1     2003/07/05 unchanged
 t/Text/Scrub.t                                               0.07    2003/07/27 unchanged
 tlib/File/Package.pm                                         1.12    2003/09/15 revised 1.11

3.3 Changes

The changes are as follows:

Test-STD-Scrub-0.01
Rename Module
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 the ``scrub'' routines from Test::TestUtil created this module Test::STD::Scrub.

new methods
Added the scrub_data and scrub_probe methods

Test-STD-Scrub-0.02
Use the new modules from the break-up of the ``File::FileUtil'' module

Text-Scrub-0.01
Moved to a more appropriate library location.

Text-Scrub-0.02
Change the test so that test support program modules resides in distribution directory tlib directory instead of the lib directory. Because they are no longer in the lib directory, test support files will not be installed as a pre-condition for the test of this module. The test of this module will precede immediately. The test support files in the tlib directory will vanish after the installtion.

Text-Scrub-0.03
Recreate distribution file with Archive::TarGzip 0.02 that uses mode 777 for directories instead of 666. Started to get emails from Unix installers about untar not being able to change to a directory with mode of 666.

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.

3.5 Related documents.

There are no related documents needed for the installation and test of this release.

3.6 Installation instructions.

Instructions for installation, installation tests and installation support are as follows:

Installation Instructions.
To installed the release file, use the CPAN 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.

The distribution file is at the following respositories:

   http://www.softwarediamonds/packages/Text-Scrub-0.03
   http://www.perl.com/CPAN-local/authors/id/S/SO/SOFTDIA/Text-Scrub-0.03

Prerequistes.
 None.
Security, privacy, or safety precautions.
None.

Installation Tests.
Most Perl installation software will run the following test script(s) as part of the installation:
 t/Text/Scrub.t

Installation support.
If there are installation problems or questions with the installation contact
 603 882-0846 E<lt>support@SoftwareDiamonds.comE<gt>

3.7 Possible problems and known errors

There is still much work needed to ensure the quality of this module as follows:

'Back to Top'


4.0 NOTES

The following are useful acronyms:

.pm
extension for a Perl Library Module

.t
extension for a Perl test script file

'Back to Top'


2.0 SEE ALSO

File::Scrub
Docs::US_DOD::SVD






'Back to Top'

 Software Version Description for Text::Scrub - Utilites to wild card parts of a text file for comparisons.