Class: Sinatra::Cookies::Jar

Inherits:
Object
  • Object
show all
Includes:
Enumerable
Defined in:
lib/sinatra/cookies.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(app) ⇒ Jar

Returns a new instance of Jar


61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
# File 'lib/sinatra/cookies.rb', line 61

def initialize(app)
  @response_string = nil
  @response_hash   = {}
  @response        = app.response
  @request         = app.request
  @deleted         = []

  @options = {
    :path => @request.script_name.to_s.empty? ? '/' : @request.script_name,
    :domain => @request.host == 'localhost' ? nil : @request.host,
    :secure   => @request.secure?,
    :httponly => true
  }

  if app.settings.respond_to? :cookie_options
    @options.merge! app.settings.cookie_options
  end
end

Instance Attribute Details

#optionsObject (readonly)

Returns the value of attribute options


59
60
61
# File 'lib/sinatra/cookies.rb', line 59

def options
  @options
end

Instance Method Details

#==(other) ⇒ Object


80
81
82
# File 'lib/sinatra/cookies.rb', line 80

def ==(other)
  other.respond_to? :to_hash and to_hash == other.to_hash
end

#[](key) ⇒ Object


84
85
86
# File 'lib/sinatra/cookies.rb', line 84

def [](key)
  response_cookies[key.to_s] || request_cookies[key.to_s]
end

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


88
89
90
# File 'lib/sinatra/cookies.rb', line 88

def []=(key, value)
  @response.set_cookie key.to_s, @options.merge(:value => value)
end

#assoc(key) ⇒ Object


92
93
94
# File 'lib/sinatra/cookies.rb', line 92

def assoc(key)
  to_hash.assoc(key.to_s)
end

#clearObject


96
97
98
# File 'lib/sinatra/cookies.rb', line 96

def clear
  each_key { |k| delete(k) }
end

#compare_by_identity?Boolean

Returns:

  • (Boolean)

100
101
102
# File 'lib/sinatra/cookies.rb', line 100

def compare_by_identity?
  false
end

#defaultObject Also known as: default_proc


104
105
106
# File 'lib/sinatra/cookies.rb', line 104

def default
  nil
end

#delete(key) ⇒ Object


110
111
112
113
114
# File 'lib/sinatra/cookies.rb', line 110

def delete(key)
  result = self[key]
  @response.delete_cookie(key.to_s, @options)
  result
end

#delete_ifObject Also known as: reject!


116
117
118
119
120
# File 'lib/sinatra/cookies.rb', line 116

def delete_if
  return enum_for(__method__) unless block_given?
  each { |k, v| delete(k) if yield(k, v) }
  self
end

#each(&block) ⇒ Object Also known as: each_pair


122
123
124
125
# File 'lib/sinatra/cookies.rb', line 122

def each(&block)
  return enum_for(__method__) unless block_given?
  to_hash.each(&block)
end

#each_key(&block) ⇒ Object


127
128
129
130
# File 'lib/sinatra/cookies.rb', line 127

def each_key(&block)
  return enum_for(__method__) unless block_given?
  to_hash.each_key(&block)
end

#each_value(&block) ⇒ Object


134
135
136
137
# File 'lib/sinatra/cookies.rb', line 134

def each_value(&block)
  return enum_for(__method__) unless block_given?
  to_hash.each_value(&block)
end

#empty?Boolean

Returns:

  • (Boolean)

139
140
141
# File 'lib/sinatra/cookies.rb', line 139

def empty?
  to_hash.empty?
end

#fetch(key, &block) ⇒ Object


143
144
145
146
147
# File 'lib/sinatra/cookies.rb', line 143

def fetch(key, &block)
  response_cookies.fetch(key.to_s) do
    request_cookies.fetch(key.to_s, &block)
  end
end

#flattenObject


149
150
151
# File 'lib/sinatra/cookies.rb', line 149

def flatten
  to_hash.flatten
end

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

Returns:

  • (Boolean)

153
154
155
# File 'lib/sinatra/cookies.rb', line 153

def has_key?(key)
  response_cookies.has_key? key.to_s or request_cookies.has_key? key.to_s
end

#has_value?(value) ⇒ Boolean Also known as: value?

Returns:

  • (Boolean)

157
158
159
# File 'lib/sinatra/cookies.rb', line 157

def has_value?(value)
  response_cookies.has_value? value or request_cookies.has_value? value
end

#hashObject


161
162
163
# File 'lib/sinatra/cookies.rb', line 161

def hash
  to_hash.hash
end

#index(value) ⇒ Object


168
169
170
171
# File 'lib/sinatra/cookies.rb', line 168

def index(value)
  warn "Hash#index is deprecated; use Hash#key" if RUBY_VERSION > '1.9'
  key(value)
end

#inspectObject


173
174
175
# File 'lib/sinatra/cookies.rb', line 173

def inspect
  "<##{self.class}: #{to_hash.inspect[1..-2]}>"
end

#invertObject


177
178
179
# File 'lib/sinatra/cookies.rb', line 177

def invert
  to_hash.invert
end

#keep_ifObject Also known as: select!


181
182
183
184
# File 'lib/sinatra/cookies.rb', line 181

def keep_if
  return enum_for(__method__) unless block_given?
  delete_if { |*a| not yield(*a) }
end

#key(value) ⇒ Object


186
187
188
# File 'lib/sinatra/cookies.rb', line 186

def key(value)
  to_hash.key(value)
end

#keysObject


192
193
194
# File 'lib/sinatra/cookies.rb', line 192

def keys
  to_hash.keys
end

#lengthObject Also known as: size


196
197
198
# File 'lib/sinatra/cookies.rb', line 196

def length
  to_hash.length
end

#merge(other, &block) ⇒ Object


200
201
202
# File 'lib/sinatra/cookies.rb', line 200

def merge(other, &block)
  to_hash.merge(other, &block)
end

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


204
205
206
207
208
209
210
211
212
# File 'lib/sinatra/cookies.rb', line 204

def merge!(other)
  other.each_pair do |key, value|
    if block_given? and include? key
      self[key] = yield(key.to_s, self[key], value)
    else
      self[key] = value
    end
  end
end

#rassoc(value) ⇒ Object


214
215
216
# File 'lib/sinatra/cookies.rb', line 214

def rassoc(value)
  to_hash.rassoc(value)
end

#rehashObject


218
219
220
221
222
# File 'lib/sinatra/cookies.rb', line 218

def rehash
  response_cookies.rehash
  request_cookies.rehash
  self
end

#reject(&block) ⇒ Object


224
225
226
227
# File 'lib/sinatra/cookies.rb', line 224

def reject(&block)
  return enum_for(__method__) unless block_given?
  to_hash.reject(&block)
end

#replace(other) ⇒ Object


231
232
233
234
# File 'lib/sinatra/cookies.rb', line 231

def replace(other)
  select! { |k, v| other.include?(k) or other.include?(k.to_s)  }
  merge! other
end

#select(&block) ⇒ Object


236
237
238
239
# File 'lib/sinatra/cookies.rb', line 236

def select(&block)
  return enum_for(__method__) unless block_given?
  to_hash.select(&block)
end

#shiftObject


243
244
245
246
247
# File 'lib/sinatra/cookies.rb', line 243

def shift
  key, value = to_hash.shift
  delete(key)
  [key, value]
end

#sort(&block) ⇒ Object


251
252
253
# File 'lib/sinatra/cookies.rb', line 251

def sort(&block)
  to_hash.sort(&block)
end

#to_aObject


261
262
263
# File 'lib/sinatra/cookies.rb', line 261

def to_a
  to_hash.to_a
end

#to_hashObject


257
258
259
# File 'lib/sinatra/cookies.rb', line 257

def to_hash
  request_cookies.merge(response_cookies)
end

#to_sObject


265
266
267
# File 'lib/sinatra/cookies.rb', line 265

def to_s
  to_hash.to_s
end

#valuesObject


272
273
274
# File 'lib/sinatra/cookies.rb', line 272

def values
  to_hash.values
end

#values_at(*list) ⇒ Object


276
277
278
# File 'lib/sinatra/cookies.rb', line 276

def values_at(*list)
  list.map { |k| self[k] }
end