File Coverage

erecipes/perl/lib/CGI/Ex/Recipes/Cache.pm

Criterion	Covered	Total	%
statement	36	42	85.7
branch	8	16	50.0
condition	7	14	50.0
subroutine	12	13	92.3
pod	6	7	85.7
total	69	92	75.0

package CGI::Ex::Recipes::Cache;
use utf8;
use warnings;
use strict;
use Carp qw(croak);
use CGI::Ex::Dump qw(debug dex_warn ctrace dex_trace);
use Storable;
our $VERSION = '0.01';

sub new {
    my $class = shift || __PACKAGE__;
    my $args  = shift || {};
    $args->{expires}  ||= time + 3600;#one hour by default
    $args->{cache_hash} ||= {};
    $args->{dbh} || croak 'Please provide a database handle with a `cache` table in the database!';
    return bless {%$args}, $class;
}

#tries first the 'our %CACHE_HASH', then the database.
sub exists {
    my ($self,$key) = @_;
    1 if(exists $self->{cache_hash}{$key});
    0;
}

sub get {
    my ($self,$key) = @_;
    #dex_trace(); #debug $self;
    if(exists $self->{cache_hash}{$key}) {
        return $self->{cache_hash}{$key}{value};
    }
    #warn 'getting $key'.$key.' from database';
    my $row = $self->{dbh}->selectrow_hashref('SELECT * FROM cache WHERE id=?',{},$key)
        || return undef;
    $self->{cache_hash}{$key} = $row;
    if($self->{cache_hash}{$key}{expires} < time ){
        #warn 'could not $key'.$key.' from database. data expired.';
        return undef;
    }
    return $self->{cache_hash}{$key}{value};
}

sub set {
    if (!$_[2]) {
        croak 'Please provide a value to be set!';
    }
    #NOTE: compatible only with SQLITE and MySQL
    $_[0]->{dbh}->prepare(
        'REPLACE INTO `cache` (id, value, tstamp, expires) VALUES ( ?,?,?,? )'
    )->execute( $_[1], $_[2], time, ($_[3]?time+$_[3]:$_[0]->{expires}) );
}

sub clear {
    $_[0]->{cache_hash} = {};
    $_[0]->{dbh}->do('DELETE FROM `cache`')
        and $_[0]->{dbh}->do('VACUUM');

}

sub freeze {
    $_[0]->set(
        $_[1],
        ref $_[2] ? Storable::nfreeze($_[2]) : $_[2],
        $_[3] || $_[0]->{expires},
    );
}

sub thaw {
    Storable::thaw( $_[0]->get($_[1]) ) ;
}


1;

__END__