Skip to content

this is include three pull requests.(#11, #12, #13) #14

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open

this is include three pull requests.(#11, #12, #13) #14

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
793b804
support get_cache callback
nihen Oct 5, 2012
ace0e07
support expires in Store::Cache
nihen Oct 5, 2012
48a8ac5
support key prefix on Store::Cache
nihen Oct 5, 2012
5b579b9
Merge branch 'cache_expires' into get_cache_prefix_expires
nihen Oct 5, 2012
19cf0cd
Merge branch 'cache_prefix' into get_cache_prefix_expires
nihen Oct 5, 2012
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
62 changes: 50 additions & 12 deletions lib/Plack/Session/Store/Cache.pm
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,33 +9,46 @@ use Scalar::Util qw[ blessed ];

use parent 'Plack::Session::Store';

use Plack::Util::Accessor qw[ cache ];
use Plack::Util::Accessor qw[ cache get_cache expires prefix ];

sub new {
my ($class, %params) = @_;

die('cache require get, set and remove method.')
unless blessed $params{cache}
&& $params{cache}->can('get')
&& $params{cache}->can('set')
&& $params{cache}->can('remove');
my $cache;
if ( $params{get_cache} ) {
$cache = $params{get_cache}->();
}
else {
$cache = $params{cache};
$params{get_cache} = sub { $params{cache} };
}

bless { %params } => $class;
die('cache require get, set and remove method.')
unless blessed $cache
&& $cache->can('get')
&& $cache->can('set')
&& $cache->can('remove');

bless {
prefix => '',
%params,
} => $class;
}


sub fetch {
my ($self, $session_id ) = @_;
$self->cache->get($session_id);
$self->get_cache->()->get($self->prefix . $session_id);
}

sub store {
my ($self, $session_id, $session) = @_;
$self->cache->set($session_id => $session);
$self->get_cache->()->set($self->prefix . $session_id => $session, $self->expires);
}

sub remove {
my ($self, $session_id) = @_;
$self->cache->remove($session_id);
$self->get_cache->()->remove($self->prefix . $session_id);
}

1;
Expand All @@ -61,7 +74,18 @@ Plack::Session::Store::Cache - Cache session store
builder {
enable 'Session',
store => Plack::Session::Store::Cache->new(
cache => CHI->new(driver => 'FastMmap')
cache => CHI->new(driver => 'FastMmap'),
expires => 86400,
prefix => 'session:',
);
$app;
};

# set get_cache callback for ondemand
builder {
enable 'Session',
store => Plack::Session::Store::Cache->new(
get_cache => sub { MyAppSingleton->cache },
);
$app;
};
Expand All @@ -81,14 +105,28 @@ its full interface.

=item B<new ( %params )>

The constructor expects the I<cache> param to be an object instance
The constructor expects the I<cache> param or return of I<get_cache> to be an object instance
which has the I<get>, I<set>, and I<remove> methods, it will throw an
exception if that is not the case.

=item B<cache>

A simple accessor for the cache handle.

=item B<get_cache>

A callback for the cache handle.

=item B<expires>

This value uses in set method, Like this

$cache->set($key, $data, $expires)

=item B<prefix>

The prefix associated with this cache. Defaults to "" if not explicitly set.

=back

=head1 BUGS
Expand Down
124 changes: 123 additions & 1 deletion t/005_basic_w_cache_store.t
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,8 @@ use t::lib::TestSession;
package TestCache;

sub new {
bless {} => shift;
my $class = shift;
bless +{@_} => $class;
}

sub set {
Expand All @@ -37,6 +38,58 @@ use t::lib::TestSession;
delete $self->{$key};
}
}
{
package TestCacheMatchExpires;
use base 'TestCache';

sub set {
my ($self, $key, $val, $expires ) = @_;

Test::More::is $self->{expires} => $expires;
$self->{$key} = $val;
}
}
{
package TestCacheDenyExpires;
use base 'TestCache';

sub set {
my ($self, $key, $val, $expires ) = @_;

Test::More::is $expires => undef;

$self->{$key} = $val;
}
}
{
package TestCachePrefix;
use base 'TestCache';


sub set {
my ($self, $key, $val ) = @_;

Test::More::like $key, qr/^$self->{prefix}/;

$self->{$key} = $val;
}

sub get {
my ($self, $key ) = @_;

Test::More::like $key, qr/^$self->{prefix}/;

$self->{$key};
}

sub remove {
my ($self, $key ) = @_;

Test::More::like $key, qr/^$self->{prefix}/;

delete $self->{$key};
}
}

t::lib::TestSession::run_all_tests(
store => Plack::Session::Store::Cache->new( cache => TestCache->new ),
Expand All @@ -55,5 +108,74 @@ t::lib::TestSession::run_all_tests(
},
);

my $cache = TestCache->new;
t::lib::TestSession::run_all_tests(
store => Plack::Session::Store::Cache->new( get_cache => sub { $cache } ),
state => Plack::Session::State->new,
env_cb => sub {
open my $in, '<', \do { my $d };
my $env = {
'psgi.version' => [ 1, 0 ],
'psgi.input' => $in,
'psgi.errors' => *STDERR,
'psgi.url_scheme' => 'http',
SERVER_PORT => 80,
REQUEST_METHOD => 'GET',
QUERY_STRING => join "&" => map { $_ . "=" . $_[0]->{ $_ } } keys %{$_[0] || +{}},
};
},
);

t::lib::TestSession::run_all_tests(
store => Plack::Session::Store::Cache->new( cache => TestCacheMatchExpires->new(expires => 111), expires => 111 ),
state => Plack::Session::State->new,
env_cb => sub {
open my $in, '<', \do { my $d };
my $env = {
'psgi.version' => [ 1, 0 ],
'psgi.input' => $in,
'psgi.errors' => *STDERR,
'psgi.url_scheme' => 'http',
SERVER_PORT => 80,
REQUEST_METHOD => 'GET',
QUERY_STRING => join "&" => map { $_ . "=" . $_[0]->{ $_ } } keys %{$_[0] || +{}},
};
},
);

t::lib::TestSession::run_all_tests(
store => Plack::Session::Store::Cache->new( cache => TestCacheDenyExpires->new ),
state => Plack::Session::State->new,
env_cb => sub {
open my $in, '<', \do { my $d };
my $env = {
'psgi.version' => [ 1, 0 ],
'psgi.input' => $in,
'psgi.errors' => *STDERR,
'psgi.url_scheme' => 'http',
SERVER_PORT => 80,
REQUEST_METHOD => 'GET',
QUERY_STRING => join "&" => map { $_ . "=" . $_[0]->{ $_ } } keys %{$_[0] || +{}},
};
},
);

t::lib::TestSession::run_all_tests(
store => Plack::Session::Store::Cache->new( cache => TestCachePrefix->new(prefix => 'test:'), prefix => 'test:' ),
state => Plack::Session::State->new,
env_cb => sub {
open my $in, '<', \do { my $d };
my $env = {
'psgi.version' => [ 1, 0 ],
'psgi.input' => $in,
'psgi.errors' => *STDERR,
'psgi.url_scheme' => 'http',
SERVER_PORT => 80,
REQUEST_METHOD => 'GET',
QUERY_STRING => join "&" => map { $_ . "=" . $_[0]->{ $_ } } keys %{$_[0] || +{}},
};
},
);


done_testing;
124 changes: 123 additions & 1 deletion t/005a_basic_w_cache_store.t
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,8 @@ use t::lib::TestSessionHash;
package TestCache;

sub new {
bless {} => shift;
my $class = shift;
bless +{@_} => $class;
}

sub set {
Expand All @@ -36,6 +37,58 @@ use t::lib::TestSessionHash;
delete $self->{$key};
}
}
{
package TestCacheMatchExpires;
use base 'TestCache';

sub set {
my ($self, $key, $val, $expires ) = @_;

Test::More::is $self->{expires} => $expires;
$self->{$key} = $val;
}
}
{
package TestCacheDenyExpires;
use base 'TestCache';

sub set {
my ($self, $key, $val, $expires ) = @_;

Test::More::is $expires => undef;

$self->{$key} = $val;
}
}
{
package TestCachePrefix;
use base 'TestCache';


sub set {
my ($self, $key, $val ) = @_;

Test::More::like $key, qr/^$self->{prefix}/;

$self->{$key} = $val;
}

sub get {
my ($self, $key ) = @_;

Test::More::like $key, qr/^$self->{prefix}/;

$self->{$key};
}

sub remove {
my ($self, $key ) = @_;

Test::More::like $key, qr/^$self->{prefix}/;

delete $self->{$key};
}
}

t::lib::TestSessionHash::run_all_tests(
store => Plack::Session::Store::Cache->new( cache => TestCache->new ),
Expand All @@ -54,5 +107,74 @@ t::lib::TestSessionHash::run_all_tests(
},
);

my $cache = TestCache->new;
t::lib::TestSessionHash::run_all_tests(
store => Plack::Session::Store::Cache->new( get_cache => sub { $cache } ),
state => Plack::Session::State->new,
env_cb => sub {
open my $in, '<', \do { my $d };
my $env = {
'psgi.version' => [ 1, 0 ],
'psgi.input' => $in,
'psgi.errors' => *STDERR,
'psgi.url_scheme' => 'http',
SERVER_PORT => 80,
REQUEST_METHOD => 'GET',
QUERY_STRING => join "&" => map { $_ . "=" . $_[0]->{ $_ } } keys %{$_[0] || +{}},
};
},
);

t::lib::TestSessionHash::run_all_tests(
store => Plack::Session::Store::Cache->new( cache => TestCacheMatchExpires->new(expires => 111), expires => 111 ),
state => Plack::Session::State->new,
env_cb => sub {
open my $in, '<', \do { my $d };
my $env = {
'psgi.version' => [ 1, 0 ],
'psgi.input' => $in,
'psgi.errors' => *STDERR,
'psgi.url_scheme' => 'http',
SERVER_PORT => 80,
REQUEST_METHOD => 'GET',
QUERY_STRING => join "&" => map { $_ . "=" . $_[0]->{ $_ } } keys %{$_[0] || +{}},
};
},
);

t::lib::TestSessionHash::run_all_tests(
store => Plack::Session::Store::Cache->new( cache => TestCacheDenyExpires->new ),
state => Plack::Session::State->new,
env_cb => sub {
open my $in, '<', \do { my $d };
my $env = {
'psgi.version' => [ 1, 0 ],
'psgi.input' => $in,
'psgi.errors' => *STDERR,
'psgi.url_scheme' => 'http',
SERVER_PORT => 80,
REQUEST_METHOD => 'GET',
QUERY_STRING => join "&" => map { $_ . "=" . $_[0]->{ $_ } } keys %{$_[0] || +{}},
};
},
);

t::lib::TestSessionHash::run_all_tests(
store => Plack::Session::Store::Cache->new( cache => TestCachePrefix->new(prefix => 'test:'), prefix => 'test:' ),
state => Plack::Session::State->new,
env_cb => sub {
open my $in, '<', \do { my $d };
my $env = {
'psgi.version' => [ 1, 0 ],
'psgi.input' => $in,
'psgi.errors' => *STDERR,
'psgi.url_scheme' => 'http',
SERVER_PORT => 80,
REQUEST_METHOD => 'GET',
QUERY_STRING => join "&" => map { $_ . "=" . $_[0]->{ $_ } } keys %{$_[0] || +{}},
};
},
);


done_testing;