edge badge

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.

Methods
D
F
N
W
Class Public methods
new(app, options = {})
# File actionpack/lib/action_dispatch/middleware/session/cache_store.rb, line 15
def initialize(app, options = {})
  @cache = options[:cache] || Rails.cache
  options[:expire_after] ||= @cache.options[:expires_in]
  super
end
Instance Public methods
delete_session(env, sid, options)

Remove a session from the cache.

# File actionpack/lib/action_dispatch/middleware/session/cache_store.rb, line 41
def delete_session(env, sid, options)
  @cache.delete(cache_key(sid))
  generate_sid
end
find_session(env, sid)

Get a session from the cache.

# File actionpack/lib/action_dispatch/middleware/session/cache_store.rb, line 22
def find_session(env, sid)
  unless sid && (session = @cache.read(cache_key(sid)))
    sid, session = generate_sid, {}
  end
  [sid, session]
end
write_session(env, sid, session, options)

Set a session in the cache.

# File actionpack/lib/action_dispatch/middleware/session/cache_store.rb, line 30
def write_session(env, sid, session, options)
  key = cache_key(sid)
  if session
    @cache.write(key, session, expires_in: options[:expire_after])
  else
    @cache.delete(key)
  end
  sid
end