Class: Rack::Session::Abstract::SessionHash

Inherits:
Object
  • Object
show all
Includes:
Enumerable
Defined in:
lib/rack/session/abstract/id.rb

Overview

SessionHash is responsible to lazily load the session from store.

Direct Known Subclasses

PersistedSecure::SecureSessionHash

Constant Summary collapse

Unspecified = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(store, req) ⇒ SessionHash

Returns a new instance of SessionHash.



65
66
67
68
69
 
# File 'lib/rack/session/abstract/id.rb', line 65

def initialize(store, req)
  @store = store
  @req = req
  @loaded = false
end

Instance Attribute Details

#id ⇒ Object 



71
72
73
74
 
# File 'lib/rack/session/abstract/id.rb', line 71

def id
  return @id if @loaded or instance_variable_defined?(:@id)
  @id = @store.send(:extract_session_id, @req)
end

Class Method Details

.find(req) ⇒ Object 



53
54
55
 
# File 'lib/rack/session/abstract/id.rb', line 53

def self.find(req)
  req.get_header RACK_SESSION
end

.set(req, session) ⇒ Object 



57
58
59
 
# File 'lib/rack/session/abstract/id.rb', line 57

def self.set(req, session)
  req.set_header RACK_SESSION, session
end

.set_options(req, options) ⇒ Object 



61
62
63
 
# File 'lib/rack/session/abstract/id.rb', line 61

def self.set_options(req, options)
  req.set_header RACK_SESSION_OPTIONS, options.dup
end

Instance Method Details

#[](key) ⇒ Object 



85
86
87
88
 
# File 'lib/rack/session/abstract/id.rb', line 85

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

#[]=(key, value) ⇒ Object Also known as: store 



111
112
113
114
 
# File 'lib/rack/session/abstract/id.rb', line 111

def []=(key, value)
  load_for_write!
  @data[key.to_s] = value
end

#clear ⇒ Object 



117
118
119
120
 
# File 'lib/rack/session/abstract/id.rb', line 117

def clear
  load_for_write!
  @data.clear
end

#delete(key) ⇒ Object 



143
144
145
146
 
# File 'lib/rack/session/abstract/id.rb', line 143

def delete(key)
  load_for_write!
  @data.delete(key.to_s)
end

#destroy ⇒ Object 



122
123
124
125
 
# File 'lib/rack/session/abstract/id.rb', line 122

def destroy
  clear
  @id = @store.send(:delete_session, @req, id, options)
end

#dig(key, *keys) ⇒ Object 



90
91
92
93
 
# File 'lib/rack/session/abstract/id.rb', line 90

def dig(key, *keys)
  load_for_read!
  @data.dig(key.to_s, *keys)
end

#each(&block) ⇒ Object 



80
81
82
83
 
# File 'lib/rack/session/abstract/id.rb', line 80

def each(&block)
  load_for_read!
  @data.each(&block)
end

#empty? ⇒ Boolean

Returns:

  • (Boolean) 


166
167
168
169
 
# File 'lib/rack/session/abstract/id.rb', line 166

def empty?
  load_for_read!
  @data.empty?
end

#exists? ⇒ Boolean

Returns:

  • (Boolean) 


156
157
158
159
160
 
# File 'lib/rack/session/abstract/id.rb', line 156

def exists?
  return @exists if instance_variable_defined?(:@exists)
  @data = {}
  @exists = @store.send(:session_exists?, @req)
end

#fetch(key, default = Unspecified, &block) ⇒ Object 



95
96
97
98
99
100
101
102
 
# File 'lib/rack/session/abstract/id.rb', line 95

def fetch(key, default = Unspecified, &block)
  load_for_read!
  if default == Unspecified
    @data.fetch(key.to_s, &block)
  else
    @data.fetch(key.to_s, default, &block)
  end
end

#has_key?(key) ⇒ Boolean Also known as: key?, include?

Returns:

  • (Boolean) 


104
105
106
107
 
# File 'lib/rack/session/abstract/id.rb', line 104

def has_key?(key)
  load_for_read!
  @data.has_key?(key.to_s)
end

#inspect ⇒ Object 



148
149
150
151
152
153
154
 
# File 'lib/rack/session/abstract/id.rb', line 148

def inspect
  if loaded?
    @data.inspect
  else
    "#<#{self.class}:0x#{self.object_id.to_s(16)} not yet loaded>"
  end
end

#keys ⇒ Object 



171
172
173
174
 
# File 'lib/rack/session/abstract/id.rb', line 171

def keys
  load_for_read!
  @data.keys
end

#loaded? ⇒ Boolean

Returns:

  • (Boolean) 


162
163
164
 
# File 'lib/rack/session/abstract/id.rb', line 162

def loaded?
  @loaded
end

#options ⇒ Object 



76
77
78
 
# File 'lib/rack/session/abstract/id.rb', line 76

def options
  @req.session_options
end

#replace(hash) ⇒ Object 



138
139
140
141
 
# File 'lib/rack/session/abstract/id.rb', line 138

def replace(hash)
  load_for_write!
  @data.replace(stringify_keys(hash))
end

#to_hash ⇒ Object 



127
128
129
130
 
# File 'lib/rack/session/abstract/id.rb', line 127

def to_hash
  load_for_read!
  @data.dup
end

#update(hash) ⇒ Object Also known as: merge! 



132
133
134
135
 
# File 'lib/rack/session/abstract/id.rb', line 132

def update(hash)
  load_for_write!
  @data.update(stringify_keys(hash))
end

#values ⇒ Object 



176
177
178
179
 
# File 'lib/rack/session/abstract/id.rb', line 176

def values
  load_for_read!
  @data.values
end