NAME

Text::Replace - replace variables from a hash

SYNOPSIS

 #######
 # Subroutine Interface
 #
 use Text::Replace qw(&replace_variables);
 $success = replace_variables(\$template, \%variable_hash, \@variable);

 ########
 # Class Interface
 #
 use Text::Replace;
 $success = Text::Replace->replace_variables(\$template, \%variable_hash, \@variable);

DESCRIPTION

The Text::Replace program module is simple and plain by design. The Text::Replace program module mimics the built-in Perl double quote, '"', literal scalar that replaces Perl scalar variables named with a leading '$'. The Text::Replace program module stays in the background, just like John William's movie scores. There is no large manual thicker than the Bible with tricks and tips and gyrations to learn and to distract. The module is plain, simple with no expressiveness. The Text::Replace program module does only one thing: substitute a value for a variable. It is amazing how many times, just a simple double quote literal replacement in a small string or even a large text string gets the job done.

Does Text::Replace solve all variable replacement, template problems? Definitely not. There is no capabilities for inserting graphs, text wrap plug-ins, GD interface. If an application needs something this sophisticated, there are many fine template program modules in CPAN such as the highly rated Template program module.

SUBROUTINES

replace_variables

The replace_variables subroutine, takes a \$template reference containing Perl scalar variables, always named the leading funny character '$', and recursively looks up the value for the scalar variables in the \%variable_hash and replaces the value in the \$template. The replace_variables subroutine only replaces those variables in the \@variable list.

REQUIREMENTS

Some day.

DEMONSTRATION

 #########
 # perl Replace.d
 ###

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

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

 2 + 2
 # 4

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

     use File::Spec;

     use File::Package;
     my $fp = 'File::Package';

     my $tr = 'Text::Replace';

     my $loaded = '';
     my $template = '';
     my %variables = ();
     my $expected = '';

 ##################
 # Load UUT
 # 

 my $errors = $fp->load_package($tr)
 $errors

 # ''
 #

 ##################
 # replace variables
 # 

 $template = << 'EOF';
 =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

 EOF

 %variables = (
    TITLE => 'SVDmaker',
    REVISION => '-',
    VERSION => '0.01',
    DATE => '1969/5/6',
    END_USER => 'General Public',
    AUTHOR => 'Software Diamonds',
    COPYRIGHT => 'none',
    CLASSIFICATION => 'none');

 $tr->replace_variables( \$template, \%variables );
 $template

 # '=head1 Title Page

 # Software Version Description

 # for

 # SVDmaker

 # Revision: -

 # Version: 0.01

 # Date: 1969/5/6

 # Prepared for: General Public 

 # Prepared by:  Software Diamonds

 # Copyright: none

 # Classification: none

 #=cut

 #'
 #

QUALITY ASSURANCE

Running the test script Replace.t verifies the requirements for this module. The tmake.pl cover script for Test::STDmaker automatically generated the Replace.t test script, Replace.d demo script, and t::Text::Replace program module POD, from the t::Text::Replace program module contents. The tmake.pl cover script automatically ran the Replace.d demo script and inserted the results into the 'DEMONSTRATION' section above. The t::Text::Replace program module is in the distribution file Text-Replace-$VERSION.tar.gz.

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

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, STD490A 3.2.3.6. 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.

3. Commercial installation of the binary or source must visually present to the installer the above copyright notice, this list of conditions intact, that the original source is available at http://softwarediamonds.com and provide means for the installer to actively accept the list of conditions; otherwise, a license fee must be paid to Softwareware Diamonds.

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.

SEE ALSO

Template

Docs::Site_SVD::Text_Replace

Test::STDmaker

ExtUtils::SVDmaker

cpanm Text::Replace

perl -MCPAN -e shell
install Text::Replace