Class: ActionDispatch::Flash::FlashHash

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

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Enumerable

#as_json, #exclude?, #index_by, #many?, #sum

Constructor Details

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

:nodoc:


103
104
105
106
107
# File 'actionpack/lib/action_dispatch/middleware/flash.rb', line 103

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:


82
83
84
85
86
87
88
89
90
91
92
93
# File 'actionpack/lib/action_dispatch/middleware/flash.rb', line 82

def self.from_session_value(value) #:nodoc:
  flash = case value
          when FlashHash # Rails 3.1, 3.2
            new(value.instance_variable_get(:@flashes), value.instance_variable_get(:@used))
          when Hash # Rails 4.0
            new(value['flashes'], value['discard'])
          else
            new
          end

  flash.tap(&:sweep)
end

Instance Method Details

#[](k) ⇒ Object


123
124
125
# File 'actionpack/lib/action_dispatch/middleware/flash.rb', line 123

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

#[]=(k, v) ⇒ Object


117
118
119
120
121
# File 'actionpack/lib/action_dispatch/middleware/flash.rb', line 117

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

#alertObject

Convenience accessor for flash[:alert].


224
225
226
# File 'actionpack/lib/action_dispatch/middleware/flash.rb', line 224

def alert
  self[:alert]
end

#alert=(message) ⇒ Object

Convenience accessor for flash[:alert]=.


229
230
231
# File 'actionpack/lib/action_dispatch/middleware/flash.rb', line 229

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

#clearObject


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

def clear
  @discard.clear
  @flashes.clear
end

#delete(key) ⇒ Object


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

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

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

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

#each(&block) ⇒ Object


161
162
163
# File 'actionpack/lib/action_dispatch/middleware/flash.rb', line 161

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

#empty?Boolean

Returns:

  • (Boolean)

152
153
154
# File 'actionpack/lib/action_dispatch/middleware/flash.rb', line 152

def empty?
  @flashes.empty?
end

#initialize_copy(other) ⇒ Object


109
110
111
112
113
114
115
# File 'actionpack/lib/action_dispatch/middleware/flash.rb', line 109

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

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

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)

137
138
139
# File 'actionpack/lib/action_dispatch/middleware/flash.rb', line 137

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

#keysObject


133
134
135
# File 'actionpack/lib/action_dispatch/middleware/flash.rb', line 133

def keys
  @flashes.keys
end

#noticeObject

Convenience accessor for flash[:notice].


234
235
236
# File 'actionpack/lib/action_dispatch/middleware/flash.rb', line 234

def notice
  self[:notice]
end

#notice=(message) ⇒ Object

Convenience accessor for flash[:notice]=.


239
240
241
# File 'actionpack/lib/action_dispatch/middleware/flash.rb', line 239

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

#nowObject

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['my-key'].

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!"


191
192
193
# File 'actionpack/lib/action_dispatch/middleware/flash.rb', line 191

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

#replace(h) ⇒ Object

:nodoc:


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

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

#sweepObject

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.


218
219
220
221
# File 'actionpack/lib/action_dispatch/middleware/flash.rb', line 218

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

#to_hashObject


148
149
150
# File 'actionpack/lib/action_dispatch/middleware/flash.rb', line 148

def to_hash
  @flashes.dup
end

#to_session_valueObject

Builds a hash containing the discarded values and the hashes representing the flashes. If there are no values in @flashes, returns nil.


98
99
100
101
# File 'actionpack/lib/action_dispatch/middleware/flash.rb', line 98

def to_session_value #:nodoc:
  return nil if empty?
  {'discard' => @discard.to_a, 'flashes' => @flashes}
end

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

:nodoc:


127
128
129
130
131
# File 'actionpack/lib/action_dispatch/middleware/flash.rb', line 127

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