James Counts > Test-Approvals-v0.0.5 > Test::Approvals::Writers::TextWriter

Download:
Test-Approvals-v0.0.5.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Module Version: v0.0.5   Source  

NAME ^

Test::Approvals::Writers::TextWriter - Writes text to files

VERSION ^

This documentation refers to Test::Approvals version v0.0.5

SYNOPSIS ^

    use Test::Approvals::Writers::TextWriter;
    my $w = Test::Approvals::Writers::TextWriter->new( result => 'Hello' );
    
    # Write to a file
    $w->write_to('out.txt');

    # Print to a handle
    my $out_buf;
    open my $out, '>', \$out_buf;
    $w->print_to($out);
    close $out;

    # Let collaborators know what kind of result is stored in the writer
    my $x = Test::Approvals::Writers::TextWriter->new(
        result         => 'Hello',
        file_extension => 'html'
    );

    # $ext gets 'html'
    my $ext = $x->file_extension;

DESCRIPTION ^

The Test::Approvals::Writers::TextWriter method stores results until an approver is ready to write them.

SUBROUTINES/METHODS ^

print_to

Write the result to an open handle.

    my $w = Test::Approvals::Writers::TextWriter->new( result => 'Hello' );
    my $out_buf;
    open my $out, '>', \$out_buf;
    $w->print_to($out);
    close $out;

write_to

Write the result to a file at the specified path.

    my $w = Test::Approvals::Writers::TextWriter->new( result => 'Hello' );
    $w->write_to('out.txt');

DIAGNOSTICS ^

None at this time.

CONFIGURATION AND ENVIRONMENT ^

None.

DEPENDENCIES ^

Carp English Moose version

INCOMPATIBILITIES ^

None known.

BUGS AND LIMITATIONS ^

Windows-only. Linux/OSX/other support will be added when time and access to those platforms permit.

AUTHOR ^

Jim Counts - @jamesrcounts

LICENSE AND COPYRIGHT ^

Copyright (C) 2013 Jim Counts

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

    L<http://www.apache.org/licenses/LICENSE-2.0>

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

syntax highlighting: