Class: ActionDispatch::Session::CacheStore

Inherits:
AbstractSecureStore
  • Object
show all
Defined in:
lib/action_dispatch/middleware/session/cache_store.rb

Overview

# Action Dispatch Session CacheStore

A session store that uses an ActiveSupport::Cache::Store to store the sessions. This store is most useful if you don’t store critical data in your sessions and you don’t need them to live for extended periods of time.

#### Options

  • ‘cache` - The cache to use. If it is not specified, `Rails.cache` will be used.

  • ‘expire_after` - The length of time a session will be stored before automatically expiring. By default, the `:expires_in` option of the cache is used.

Instance Method Summary collapse

Methods inherited from AbstractSecureStore

#generate_sid

Methods included from SessionObject

#commit_session, #loaded_session?, #prepare_session

Methods included from StaleSessionCheck

#extract_session_id, #load_session, #stale_session_check!

Methods included from Compatibility

#generate_sid

Constructor Details

#initialize(app, options = {}) ⇒ CacheStore

Returns a new instance of CacheStore.



23
24
25
26
27
 
# File 'lib/action_dispatch/middleware/session/cache_store.rb', line 23

def initialize(app, options = {})
  @cache = options[:cache] || Rails.cache
  options[:expire_after] ||= @cache.options[:expires_in]
  super
end

Instance Method Details

#delete_session(env, sid, options) ⇒ Object

Remove a session from the cache.



49
50
51
52
53
 
# File 'lib/action_dispatch/middleware/session/cache_store.rb', line 49

def delete_session(env, sid, options)
  @cache.delete(cache_key(sid.private_id))
  @cache.delete(cache_key(sid.public_id))
  generate_sid
end

#find_session(env, sid) ⇒ Object

Get a session from the cache.



30
31
32
33
34
35
 
# File 'lib/action_dispatch/middleware/session/cache_store.rb', line 30

def find_session(env, sid)
  unless sid && (session = get_session_with_fallback(sid))
    sid, session = generate_sid, {}
  end
  [sid, session]
end

#write_session(env, sid, session, options) ⇒ Object

Set a session in the cache.



38
39
40
41
42
43
44
45
46
 
# File 'lib/action_dispatch/middleware/session/cache_store.rb', line 38

def write_session(env, sid, session, options)
  key = cache_key(sid.private_id)
  if session
    @cache.write(key, session, expires_in: options[:expire_after])
  else
    @cache.delete(key)
  end
  sid
end