File Coverage: blib/lib/MySQL/Util/Data/Cache.pm

# File Coverage

File: | blib/lib/MySQL/Util/Data/Cache.pm
Coverage: | 100.0%

line | stmt | bran | cond | sub | code
--- | --- | --- | --- | --- | ---
1 |  |  |  |  | package MySQL::Util::Data::Cache;
2 |
3 | 4 4 4 |  |  | 4 | use Moose;
4 | 4 4 4 |  |  | 4 | use namespace::autoclean;
5 | 4 4 4 |  |  | 4 | use warnings FATAL => 'all';
6 |
7 |
8 - 16 |  |
    =head1 NAME

    MySQL::Util::Data::Cache - The great new MySQL::Util::Data::Cache!

    =head1 VERSION

    Version 0.01

    =cut
17 |
18 |  |  |  |  | our $VERSION = '0.01';
19 |
20 |
21 - 41 |  |
    =head1 SYNOPSIS

    Quick summary of what the module does.

    Perhaps a little code snippet.

        use MySQL::Util::Data::Cache;

        my $foo = MySQL::Util::Data::Cache->new();
        ...

    =head1 EXPORT

    A list of functions that can be exported.  You can delete this section
    if you don't export anything, such as for a purely object-oriented module.

    =head1 SUBROUTINES/METHODS

    =head2 function1

    =cut
42 |
43 |  |  |  |  | #
44 |  |  |  |  | # the main purpose of this class is to capture cache hits
45 |  |  |  |  | # to ensure the cache is working properly
46 |  |  |  |  | #
47 |
48 |  |  |  |  | has 'data' => (
49 |  |  |  |  | is => 'rw',
50 |  |  |  |  | required => 1,
51 |  |  |  |  | default => sub { [] }
52 |  |  |  |  | );
53 |
54 |  |  |  |  | before 'data' => sub {
55 |  |  |  |  | my $self = shift;
56 |  |  |  |  | if ( !scalar(@_) ) { $self->hits( $self->hits() + 1 ) } # cache hit
57 |  |  |  |  | };
58 |
59 |  |  |  |  | has 'hits' => (
60 |  |  |  |  | is => 'rw',
61 |  |  |  |  | isa => 'Int',
62 |  |  |  |  | required => 0,
63 |  |  |  |  | default => 0
64 |  |  |  |  | );
65 |
66 |
67 - 154 |  |
    =head1 AUTHOR

    John Gravatt, C<< <john at gravatt.org> >>

    =head1 BUGS

    Please report any bugs or feature requests to C<bug-mysql-util-data-cache at rt.cpan.org>, or through
    the web interface at L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=MySQL-Util-Data-Cache>.  I will be notified, and then you'll
    automatically be notified of progress on your bug as I make changes.

    =head1 SUPPORT

    You can find documentation for this module with the perldoc command.

        perldoc MySQL::Util::Data::Cache

    You can also look for information at:

    =over 4

    =item * RT: CPAN's request tracker (report bugs here)

    L<http://rt.cpan.org/NoAuth/Bugs.html?Dist=MySQL-Util-Data-Cache>

    =item * AnnoCPAN: Annotated CPAN documentation

    L<http://annocpan.org/dist/MySQL-Util-Data-Cache>

    =item * CPAN Ratings

    L<http://cpanratings.perl.org/d/MySQL-Util-Data-Cache>

    =item * Search CPAN

    L<http://search.cpan.org/dist/MySQL-Util-Data-Cache/>

    =back

    =head1 ACKNOWLEDGEMENTS

    =head1 LICENSE AND COPYRIGHT

    Copyright 2013 John Gravatt.

    This program is free software; you can redistribute it and/or modify it
    under the terms of the the Artistic License (2.0). You may obtain a
    copy of the full license at:

    L<http://www.perlfoundation.org/artistic_license_2_0>

    Any use, modification, and distribution of the Standard or Modified
    Versions is governed by this Artistic License. By using, modifying or
    distributing the Package, you accept this license. Do not use, modify,
    or distribute the Package, if you do not accept this license.

    If your Modified Version has been derived from a Modified Version made
    by someone other than you, you are nevertheless required to ensure that
    your Modified Version complies with the requirements of this license.

    This license does not grant you the right to use any trademark, service
    mark, tradename, or logo of the Copyright Holder.

    This license includes the non-exclusive, worldwide, free-of-charge
    patent license to make, have made, use, offer to sell, sell, import and
    otherwise transfer the Package with respect to any patent claims
    licensable by the Copyright Holder that are necessarily infringed by the
    Package. If you institute patent litigation (including a cross-claim or
    counterclaim) against any party alleging that the Package constitutes
    direct or contributory patent infringement, then this Artistic License
    to you shall terminate on the date that such litigation is filed.

    Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER
    AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES.
    THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
    PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY
    YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR
    CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR
    CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE,
    EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

    =cut
155 |
156 |  |  |  |  | __PACKAGE__->meta->make_immutable; # moose stuff
157 |
158 |  |  |  |  | 1; # End of MySQL::Util::Data::Cache
159 |