Class: Tina4::Session

Inherits:
Object
  • Object
show all
Defined in:
lib/tina4/session.rb

Constant Summary collapse

DEFAULT_OPTIONS = 
{
  cookie_name: "tina4_session",
  secret: nil,
  max_age: 86400,
  handler: :file,
  handler_options: {}
}.freeze

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(env, options = {}) ⇒ Session

Returns a new instance of Session.



17
18
19
20
21
22
23
24
 
# File 'lib/tina4/session.rb', line 17

def initialize(env, options = {})
  @options = DEFAULT_OPTIONS.merge(options)
  @options[:secret] ||= ENV["SECRET"] || "tina4-default-secret"
  @handler = create_handler
  @id = extract_session_id(env) || SecureRandom.hex(32)
  @data = load_session
  @modified = false
end

Instance Attribute Details

#data ⇒ Object (readonly)

Returns the value of attribute data.



15
16
17
 
# File 'lib/tina4/session.rb', line 15

def data
  @data
end

#id ⇒ Object (readonly)

Returns the value of attribute id.



15
16
17
 
# File 'lib/tina4/session.rb', line 15

def id
  @id
end

Instance Method Details

#[](key) ⇒ Object 



26
27
28
 
# File 'lib/tina4/session.rb', line 26

def [](key)
  @data[key.to_s]
end

#[]=(key, value) ⇒ Object 



30
31
32
33
 
# File 'lib/tina4/session.rb', line 30

def []=(key, value)
  @data[key.to_s] = value
  @modified = true
end

#all ⇒ Object

Return all session data



77
78
79
 
# File 'lib/tina4/session.rb', line 77

def all
  @data.dup
end

#clear ⇒ Object 



40
41
42
43
 
# File 'lib/tina4/session.rb', line 40

def clear
  @data = {}
  @modified = true
end

#cookie_header(cookie_name = nil) ⇒ Object 



151
152
153
154
155
 
# File 'lib/tina4/session.rb', line 151

def cookie_header(cookie_name = nil)
  name = cookie_name || @options[:cookie_name]
  samesite = ENV["TINA4_SESSION_SAMESITE"] || "Lax"
  "#{name}=#{@id}; Path=/; HttpOnly; SameSite=#{samesite}; Max-Age=#{@options[:max_age]}"
end

#delete(key) ⇒ Object 



35
36
37
38
 
# File 'lib/tina4/session.rb', line 35

def delete(key)
  @data.delete(key.to_s)
  @modified = true
end

#destroy ⇒ Object 



55
56
57
58
 
# File 'lib/tina4/session.rb', line 55

def destroy
  @handler.destroy(@id)
  @data = {}
end

#flash(key, value = nil) ⇒ Object

Flash data: set a value that is removed after next read. Call with value to set, call without value to get (and remove).



83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/tina4/session.rb', line 83

def flash(key, value = nil)
  flash_key = "_flash_#{key}"
  if value.nil?
    val = @data.delete(flash_key.to_s)
    @modified = true if val
    val
  else
    @data[flash_key.to_s] = value
    @modified = true
    value
  end
end

#gc(max_lifetime = nil) ⇒ Object

Garbage collection: remove expired sessions from the handler



146
147
148
149
 
# File 'lib/tina4/session.rb', line 146

def gc(max_lifetime = nil)
  max_lifetime ||= @options[:max_age]
  @handler.gc(max_lifetime) if @handler.respond_to?(:gc)
end

#get(key, default = nil) ⇒ Object

Get a session value with optional default



61
62
63
 
# File 'lib/tina4/session.rb', line 61

def get(key, default = nil)
  @data[key.to_s] || default
end

#get_flash(key, default = nil) ⇒ Object

Get flash data by key (alias for flash(key) without value)



97
98
99
100
 
# File 'lib/tina4/session.rb', line 97

def get_flash(key, default = nil)
  result = flash(key)
  result.nil? ? default : result
end

#get_session_id ⇒ Object

Returns the current session ID string.



126
127
128
 
# File 'lib/tina4/session.rb', line 126

def get_session_id
  @id
end

#has?(key) ⇒ Boolean

Check if a key exists in the session

Returns:

  • (Boolean) 


72
73
74
 
# File 'lib/tina4/session.rb', line 72

def has?(key)
  @data.key?(key.to_s)
end

#read(session_id) ⇒ Object

Reads raw session data for a given session ID from backend storage. Returns the data hash or nil.



132
133
134
 
# File 'lib/tina4/session.rb', line 132

def read(session_id)
  @handler.read(session_id)
end

#regenerate ⇒ Object

Regenerate the session ID while preserving data — returns new ID



103
104
105
106
107
108
109
 
# File 'lib/tina4/session.rb', line 103

def regenerate
  old_id = @id
  @id = SecureRandom.hex(32)
  @handler.destroy(old_id)
  @modified = true
  @id
end

#save ⇒ Object 



49
50
51
52
53
 
# File 'lib/tina4/session.rb', line 49

def save
  return unless @modified
  @handler.write(@id, @data)
  @modified = false
end

#set(key, value) ⇒ Object

Set a session value



66
67
68
69
 
# File 'lib/tina4/session.rb', line 66

def set(key, value)
  @data[key.to_s] = value
  @modified = true
end

#start(session_id = nil) ⇒ Object

Start or resume a session. If session_id is given, load that session; otherwise generate a new ID. Returns the session ID string.



113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/tina4/session.rb', line 113

def start(session_id = nil)
  if session_id
    @id = session_id
    @data = load_session
  else
    @id = SecureRandom.hex(32)
    @data = {}
  end
  @modified = false
  @id
end

#to_hash ⇒ Object 



45
46
47
 
# File 'lib/tina4/session.rb', line 45

def to_hash
  @data.dup
end

#write(session_id, data, ttl = nil) ⇒ Object

Writes raw session data for a given session ID to backend storage.



137
138
139
140
141
142
143
 
# File 'lib/tina4/session.rb', line 137

def write(session_id, data, ttl = nil)
  if ttl
    @handler.write(session_id, data, ttl)
  else
    @handler.write(session_id, data)
  end
end