File Coverage

blib/lib/Mojolicious/Plugin/Sessions3S.pm

Criterion	Covered	Total	%
statement	20	21	95.2
branch	1	2	50.0
condition	2	4	50.0
subroutine	6	6	100.0
pod	1	1	100.0
total	30	34	88.2

package Mojolicious::Plugin::Sessions3S;
# ABSTRACT: Manage Sessions Storage, State and Sid generation in Mojolicious
$Mojolicious::Plugin::Sessions3S::VERSION = '0.004';
=head1 NAME

Mojolicious::Plugin::Sessions3S - Manage mojolicious sessions Storage, State and SID generation

=head1 DESCRIPTION

This plugins puts you in control of how your sessions are stored, how the state persists
in the client browser and how session Ids are generated.

It provides a drop in replacement for the standard Mojolicious::Sessions mechanism and
will NOT require any change of your application code (except the setup of course).

=head1 SYNOPSIS

  $app->plugin( 'Sessions3S' => {
     state => ..,
     storage => ...,
     sidgen => ...
  });

See L for the parameters description.

If no arguments are provided, this fallsback to the stock L behaviour.

You can then use L session related methods (C, C) as usual.

With the addition of the following methods (helpers):

=head2 session_id

Always returns the ID of the current session:

  my $session_id = $c->session_id();

=cut

use strict;
use warnings;
use Mojo::Base 'Mojolicious::Plugin';

use Mojolicious::Sessions::ThreeS;

=head2 register

Implementation for L base class

=cut

sub register{
    my ($self, $app, $args) = @_;
    $args ||= {};
    unless( ( ref($args) || '' ) eq 'HASH' ){
        confess("Argument to ".ref($self)." should be an HashRef");
    }

    # Inject the session manager in the Mojo::App:
    my $sessions_manager = Mojolicious::Sessions::ThreeS->new( $args );
    $app->sessions( $sessions_manager );

    # Install the helpers
    $app->helper( session_id => sub{
                      my ($c) = @_;
                      return $sessions_manager->get_session_id( $c->session() , $c );
                  } );
}

=head1 COPYRIGHT

This is copyright Jerome Eteve (JETEVE) 2016

With the support of Broadbean UK Ltd. L

=cut

1;