fix tests for clear_flash (mocking was bad)

[catagits/Catalyst-Plugin-Session.git] / lib / Catalyst / Plugin / Session.pm

diff --git a/lib/Catalyst/Plugin/Session.pm b/lib/Catalyst/Plugin/Session.pm
index 3b8d60f..d8ce67e 100644 (file)
--- a/lib/Catalyst/Plugin/Session.pm
+++ b/lib/Catalyst/Plugin/Session.pm
@@ -12,7 +12,7 @@ use Digest              ();
 use overload            ();
 use Object::Signature   ();
 
-our $VERSION = "0.07";
+our $VERSION = "0.13";
 
 my @session_data_accessors; # used in delete_session
 BEGIN {
@@ -22,6 +22,7 @@ BEGIN {
           _sessionid
           _session
           _session_expires
+          _extended_session_expires
           _session_data_sig
           _flash
           _flash_keep_keys
@@ -90,27 +91,39 @@ sub prepare_action {
 sub finalize {
     my $c = shift;
 
-    $c->_save_session_expires;
+    $c->finalize_session;
+    
+    $c->NEXT::finalize(@_);
+}
+
+sub finalize_session {
+    my $c = shift;
+
+    $c->NEXT::finalize_session;
+
+    $c->_save_session_id;
     $c->_save_session;
     $c->_save_flash;
-    $c->_save_session_id;
+    $c->_save_session_expires;
 
-    $c->NEXT::finalize(@_);
+    $c->_clear_session_instance_data;
 }
 
 sub _save_session_id {
     my $c = shift;
+
+    # we already called set when allocating
+    # no need to tell the state plugins anything new
 }
 
 sub _save_session_expires {
     my $c = shift;
 
-    if ( defined(my $expires = $c->_session_expires) ) {
+    if ( defined($c->_session_expires) ) {
+        my $expires = $c->session_expires; # force extension
+
         my $sid = $c->sessionid;
         $c->store_session_data( "expires:$sid" => $expires );
-
-        $c->_session_expires(undef);
-        $c->_tried_loading_session_expires(undef);
     }
 }
 
@@ -127,9 +140,6 @@ sub _save_session {
             my $sid = $c->sessionid;
             $c->store_session_data( "session:$sid" => $session_data );
         }
-
-        $c->_session(undef);
-        $c->_tried_loading_session_data(undef);
     }
 }
 
@@ -154,9 +164,6 @@ sub _save_flash {
         else {
             $c->delete_session_data("flash:$sid");
         }
-        
-        $c->_flash(undef);
-        $c->_tried_loading_flash_data(undef);
     }
 }
 
@@ -169,7 +176,8 @@ sub _load_session_expires {
         my $expires = $c->get_session_data("expires:$sid") || 0;
 
         if ( $expires >= time() ) {
-            return $c->extend_session_expires( $expires );
+            $c->_session_expires( $expires );
+            return $expires;
         } else {
             $c->delete_session( "session expired" );
             return 0;
@@ -185,7 +193,7 @@ sub _load_session {
     $c->_tried_loading_session_data(1);
 
     if ( my $sid = $c->sessionid ) {
-        if ( $c->session_expires ) {    # > 0
+        if ( $c->_load_session_expires ) {    # > 0
 
             my $session_data = $c->get_session_data("session:$sid") || return;
             $c->_session($session_data);
@@ -244,10 +252,16 @@ sub _expire_session_keys {
     }
 }
 
+sub _clear_session_instance_data {
+    my $c = shift;
+    $c->$_(undef) for @session_data_accessors;
+    $c->NEXT::_clear_session_instance_data; # allow other plugins to hook in on this
+}
+
 sub delete_session {
     my ( $c, $msg ) = @_;
 
-    $c->log->debug("Deleting session") if $c->debug;
+    $c->log->debug("Deleting session" . ( defined($msg) ? "($msg)" : '(no reason given)') ) if $c->debug;
 
     # delete the session data
     if ( my $sid = $c->sessionid ) {
@@ -257,7 +271,7 @@ sub delete_session {
 
     # reset the values in the context object
     # see the BEGIN block
-    $c->$_(undef) for @session_data_accessors;
+    $c->_clear_session_instance_data;
 
     $c->_session_delete_reason($msg);
 }
@@ -273,11 +287,10 @@ sub session_delete_reason {
 sub session_expires {
     my $c = shift;
 
-    if ( defined( my $expires = $c->_session_expires ) ) {
+    if ( defined( my $expires = $c->_extended_session_expires ) ) {
         return $expires;
     } elsif ( defined( $expires = $c->_load_session_expires ) ) {
-        $c->_session_expires($expires);
-        return $expires;
+        return $c->extend_session_expires( $expires );
     } else {
         return 0;
     }
@@ -285,7 +298,7 @@ sub session_expires {
 
 sub extend_session_expires {
     my ( $c, $expires ) = @_;
-    $c->_session_expires( my $updated = $c->calculate_extended_session_expires( $expires ) );
+    $c->_extended_session_expires( my $updated = $c->calculate_extended_session_expires( $expires ) );
     $c->extend_session_id( $c->sessionid, $updated );
     return $updated;
 }
@@ -302,7 +315,10 @@ sub calculate_extended_session_expires {
 
 sub reset_session_expires {
     my ( $c, $sid ) = @_;
-    $c->_session_expires( my $exp = $c->calculate_initial_session_expires );
+    
+    my $exp = $c->calculate_initial_session_expires;
+    $c->_session_expires( $exp );
+    $c->_extended_session_expires( $exp );
     $exp;
 }
 
@@ -319,7 +335,8 @@ sub _load_sessionid {
 
     if ( defined( my $sid = $c->get_session_id ) ) {
         if ( $c->validate_session_id($sid) ) {
-            $c->_sessionid( $sid );
+            # temporarily set the inner key, so that validation will work
+            $c->_sessionid($sid);
             return $sid;
         } else {
             my $err = "Tried to set invalid session ID '$sid'";
@@ -371,6 +388,15 @@ sub flash {
     }
 }
 
+sub clear_flash {
+    my $c = shift;
+    
+    #$c->delete_session_data("flash:" . $c->sessionid); # should this be in here? or delayed till finalization?
+    $c->_flash_key_hashes({});
+    $c->_flash_keep_keys({});
+    $c->_flash({});
+}
+
 sub session_expire_key {
     my ( $c, %keys ) = @_;
 
@@ -622,6 +648,10 @@ of every request.
         }
     }
 
+=item clear_flash
+
+Zap all the keys in the flash regardless of their current state.
+
 =item keep_flash @keys
 
 If you wawnt to keep a flash key for the next request too, even if it hasn't
@@ -778,6 +808,12 @@ Or even more directly, replace C<generate_session_id>:
 Also have a look at L<Crypt::Random> and the various openssl bindings - these
 modules provide APIs for cryptographically secure random data.
 
+=item finalize_session
+
+Clean up the session during C<finalize>.
+
+This clears the various accessors after saving to the store.
+
 =item dump_these
 
 See L<Catalyst/dump_these> - ammends the session data structure to the list of