NAME

Spreadsheet::Reader::ExcelXML::Error - Moose class for remembering the last error

SYNOPSIS

    #!/usr/bin/env perl
    $|=1;
        use MooseX::ShortCut::BuildInstance qw( build_instance );
        use Spreadsheet::Reader::ExcelXML::Error;

        my      $action = build_instance(
                        add_attributes =>{
                                error_inst =>{
                                        handles =>[ qw( error set_error clear_error set_warnings if_warn ) ],
                                },
                        },
                        error_inst => Spreadsheet::Reader::ExcelXML::Error->new(
                                should_warn => 1,# 0 to turn off cluck when the error is set
                        ),
                );
        print   $action->dump;
                        $action->set_error( "You did something wrong" );
        print   $action->dump;
        print   $action->error . "\n";

    ##############################################################################
    # SYNOPSIS Screen Output
    # 01: $VAR1 = bless( {
    # 02:             'error_inst' => bless( {
    # 03:                                 'should_warn' => 1,
    # 04:                                 'spew_longmess' => 1
    # 04:                             }, 'Spreadsheet::Reader::ExcelXML::Error' )
    # 05:         }, 'ANONYMOUS_SHIRAS_MOOSE_CLASS_1' );
    # 06: You did something wrong at ~~error_string (defined at ../../../../lib/Spreadsheet/Reader/ExcelXML/Error.pm line 43) line 13.
    # 08:    Spreadsheet::Reader::ExcelXML::Error::::set_error(Spreadsheet::Reader::ExcelXML::Error=HASH(0x31e398), "You did something wrong") called at ~~ line 110
    # 09:    ANONYMOUS_SHIRAS_MOOSE_CLASS_1::set_error(ANONYMOUS_SHIRAS_MOOSE_CLASS_1=HASH(0x3300f0), "You did something wrong") called at error_example.pl line 18
    # 10: $VAR1 = bless( {
    # 11:             'error_inst' => bless( {
    # 12:                                 'should_warn' => 1,
    # 13:                                 'error_string' => 'You did something wrong'
    # 14:                                 'spew_longmess' => 1,
    # 15:                             }, 'Spreadsheet::Reader::ExcelXML::Error' )
    # 16:         }, 'ANONYMOUS_SHIRAS_MOOSE_CLASS_1' );
    # 17: You did something wrong
    ##############################################################################

DESCRIPTION

This documentation is written to explain ways to use this module when writing your own excel parser. To use the general package for excel parsing out of the box please review the documentation for Workbooks, Worksheets, and Cells

This Moose class contains two attributes. It is intended to be used through (by) delegation in other classes. The first attribute is used to store the current error string. The second, is set to turn on or off pushing the error string to STDERR when the first attribute is (re)set.

Attributes

Data passed to new when creating an instance. For modification of these attributes see the listed 'attribute methods'. For more information on attributes see Moose::Manual::Attributes.

error_string

    Definition: This stores an error string for recall later.

    Default undef (init_arg = undef)

    Range any string (error objects with the 'as_string' or 'message' are auto coerced to a string)

    attribute methods Methods provided to adjust this attribute

error

    Definition: returns the currently stored error string

clear_error

    Definition: clears the currently stored error string

set_error( $error_string )

    Definition: sets the attribute with $error_string.

should_warn

    Definition: This determines if the package will push any low level errors logged during processing to STDERR when they occur. (rather than just made available) It should be noted that failures that kill the package should push to STDERR by default. If your Excel sheet is malformed it can error without failing. Sometimes this package will handle those cases correctly and sometimes it wont. If you want to know more behind the scenes about the unexpected behaviour of the sheet then turn this attribute on.

    Default 1 -> it will push to STDERR

    Range Boolean values

    attribute methods Methods provided to adjust this attribute

set_warnings( $bool )

    Definition: Turn pushed warnings on or off

if_warn

    Definition: Returns the current setting of this attribute

spew_longmess

    Definition: This (the Error) class is capable of pulling the "longmess" in Carp for each error in order to understand what happened. If that is just too much you can change the behaviour

    Default 1 -> it will pull the longmess (using Carp);

    Range Boolean values

    attribute methods Methods provided to adjust this attribute

should_spew_longmess( $bool )

    Definition: add the longmess to errors

spewing_longmess

    Definition: Returns the current setting of this attribute

SUPPORT

TODO

    1. get clases in this package to return error numbers and or error strings and then provide opportunity for this class to localize.

    2. Get the @CARP_NOT section to work and skip most of the Moose level reporting

AUTHOR

    Jed Lund

    jandrew@cpan.org

COPYRIGHT

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

The full text of the license can be found in the LICENSE file included with this module.

This software is copyrighted (c) 2016 by Jed Lund

DEPENDENCIES

SEE ALSO