Class: ActionDispatch::Flash::FlashHash

Inherits:
Object
  • Object
show all
Includes:
Enumerable
Defined in:
lib/action_dispatch/middleware/flash.rb

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(flashes = {}, discard = []) ⇒ FlashHash

:nodoc:



149
150
151
152
153
 
# File 'lib/action_dispatch/middleware/flash.rb', line 149

def initialize(flashes = {}, discard = []) # :nodoc:
  @discard = Set.new(stringify_array(discard))
  @flashes = flashes.stringify_keys
  @now     = nil
end

Class Method Details

.from_session_value(value) ⇒ Object

:nodoc:



122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/action_dispatch/middleware/flash.rb', line 122

def self.from_session_value(value) # :nodoc:
  case value
  when FlashHash # Rails 3.1, 3.2
    flashes = value.instance_variable_get(:@flashes)
    if discard = value.instance_variable_get(:@used)
      flashes.except!(*discard)
    end
    new(flashes, flashes.keys)
  when Hash # Rails 4.0
    flashes = value["flashes"]
    if discard = value["discard"]
      flashes.except!(*discard)
    end
    new(flashes, flashes.keys)
  else
    new
  end
end

Instance Method Details

#[](k) ⇒ Object 



169
170
171
 
# File 'lib/action_dispatch/middleware/flash.rb', line 169

def [](k)
  @flashes[k.to_s]
end

#[]=(k, v) ⇒ Object 



163
164
165
166
167
 
# File 'lib/action_dispatch/middleware/flash.rb', line 163

def []=(k, v)
  k = k.to_s
  @discard.delete k
  @flashes[k] = v
end

#alert ⇒ Object

Convenience accessor for ‘flash`.



280
281
282
 
# File 'lib/action_dispatch/middleware/flash.rb', line 280

def alert
  self[:alert]
end

#alert=(message) ⇒ Object

Convenience accessor for ‘flash=`.



285
286
287
 
# File 'lib/action_dispatch/middleware/flash.rb', line 285

def alert=(message)
  self[:alert] = message
end

#clear ⇒ Object 



204
205
206
207
 
# File 'lib/action_dispatch/middleware/flash.rb', line 204

def clear
  @discard.clear
  @flashes.clear
end

#delete(key) ⇒ Object

Immediately deletes the single flash entry. Use this method when you want remove the message within the current action. See also #discard.



189
190
191
192
193
194
 
# File 'lib/action_dispatch/middleware/flash.rb', line 189

def delete(key)
  key = key.to_s
  @discard.delete key
  @flashes.delete key
  self
end

#discard(k = nil) ⇒ Object

Marks the entire flash or a single flash entry to be discarded by the end of the current action:

flash.discard              # discard the entire flash at the end of the current action
flash.discard(:warning)    # discard only the "warning" entry at the end of the current action

Use this method when you want to display the message in the current action but not in the next one. See also #delete.



264
265
266
267
268
 
# File 'lib/action_dispatch/middleware/flash.rb', line 264

def discard(k = nil)
  k = k.to_s if k
  @discard.merge Array(k || keys)
  k ? self[k] : self
end

#each(&block) ⇒ Object 



209
210
211
 
# File 'lib/action_dispatch/middleware/flash.rb', line 209

def each(&block)
  @flashes.each(&block)
end

#empty? ⇒ Boolean

Returns:

  • (Boolean) 


200
201
202
 
# File 'lib/action_dispatch/middleware/flash.rb', line 200

def empty?
  @flashes.empty?
end

#initialize_copy(other) ⇒ Object 



155
156
157
158
159
160
161
 
# File 'lib/action_dispatch/middleware/flash.rb', line 155

def initialize_copy(other)
  if other.now_is_loaded?
    @now = other.now.dup
    @now.flash = self
  end
  super
end

#keep(k = nil) ⇒ Object

Keeps either the entire current flash or a specific flash entry available for the next action:

flash.keep            # keeps the entire flash
flash.keep(:notice)   # keeps only the "notice" entry, the rest of the flash is discarded



250
251
252
253
254
 
# File 'lib/action_dispatch/middleware/flash.rb', line 250

def keep(k = nil)
  k = k.to_s if k
  @discard.subtract Array(k || keys)
  k ? self[k] : self
end

#key?(name) ⇒ Boolean

Returns:

  • (Boolean) 


183
184
185
 
# File 'lib/action_dispatch/middleware/flash.rb', line 183

def key?(name)
  @flashes.key? name.to_s
end

#keys ⇒ Object 



179
180
181
 
# File 'lib/action_dispatch/middleware/flash.rb', line 179

def keys
  @flashes.keys
end

#notice ⇒ Object

Convenience accessor for ‘flash`.



290
291
292
 
# File 'lib/action_dispatch/middleware/flash.rb', line 290

def notice
  self[:notice]
end

#notice=(message) ⇒ Object

Convenience accessor for ‘flash=`.



295
296
297
 
# File 'lib/action_dispatch/middleware/flash.rb', line 295

def notice=(message)
  self[:notice] = message
end

#now ⇒ Object

Sets a flash that will not be available to the next action, only to the current.

flash.now[:message] = "Hello current action"

This method enables you to use the flash as a central messaging system in your app. When you need to pass an object to the next action, you use the standard flash assign (‘[]=`). When you need to pass an object to the current action, you use `now`, and your object will vanish when the current action is done.

Entries set via ‘now` are accessed the same way as standard entries: `flash`.

Also, brings two convenience accessors:

flash.now.alert = "Beware now!"
# Equivalent to flash.now[:alert] = "Beware now!"

flash.now.notice = "Good luck now!"
# Equivalent to flash.now[:notice] = "Good luck now!"



241
242
243
 
# File 'lib/action_dispatch/middleware/flash.rb', line 241

def now
  @now ||= FlashNow.new(self)
end

#replace(h) ⇒ Object

:nodoc:



215
216
217
218
219
 
# File 'lib/action_dispatch/middleware/flash.rb', line 215

def replace(h) # :nodoc:
  @discard.clear
  @flashes.replace h.stringify_keys
  self
end

#sweep ⇒ Object

Mark for removal entries that were kept, and delete unkept ones.

This method is called automatically by filters, so you generally don’t need to care about it.



274
275
276
277
 
# File 'lib/action_dispatch/middleware/flash.rb', line 274

def sweep # :nodoc:
  @discard.each { |k| @flashes.delete k }
  @discard.replace @flashes.keys
end

#to_hash ⇒ Object 



196
197
198
 
# File 'lib/action_dispatch/middleware/flash.rb', line 196

def to_hash
  @flashes.dup
end

#to_session_value ⇒ Object

Builds a hash containing the flashes to keep for the next request. If there are none to keep, returns ‘nil`.



143
144
145
146
147
 
# File 'lib/action_dispatch/middleware/flash.rb', line 143

def to_session_value # :nodoc:
  flashes_to_keep = @flashes.except(*@discard)
  return nil if flashes_to_keep.empty?
  { "discard" => [], "flashes" => flashes_to_keep }
end

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

:nodoc:



173
174
175
176
177
 
# File 'lib/action_dispatch/middleware/flash.rb', line 173

def update(h) # :nodoc:
  @discard.subtract stringify_array(h.keys)
  @flashes.update h.stringify_keys
  self
end