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:


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

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


79
80
81
82
83
84
85
86
87
88
89
90
# File 'actionpack/lib/action_dispatch/middleware/flash.rb', line 79

def self.from_session_value(value)
  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


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

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

#[]=(k, v) ⇒ Object


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

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

#alertObject

Convenience accessor for flash[:alert].


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

def alert
  self[:alert]
end

#alert=(message) ⇒ Object

Convenience accessor for flash[:alert]=.


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

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

#clearObject


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

def clear
  @discard.clear
  @flashes.clear
end

#delete(key) ⇒ Object


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

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

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

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

#each(&block) ⇒ Object


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

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

#empty?Boolean

Returns:

  • (Boolean)

146
147
148
# File 'actionpack/lib/action_dispatch/middleware/flash.rb', line 146

def empty?
  @flashes.empty?
end

#initialize_copy(other) ⇒ Object


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

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

193
194
195
196
197
# File 'actionpack/lib/action_dispatch/middleware/flash.rb', line 193

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)

131
132
133
# File 'actionpack/lib/action_dispatch/middleware/flash.rb', line 131

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

#keysObject


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

def keys
  @flashes.keys
end

#noticeObject

Convenience accessor for flash[:notice].


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

def notice
  self[:notice]
end

#notice=(message) ⇒ Object

Convenience accessor for flash[:notice]=.


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

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

185
186
187
# File 'actionpack/lib/action_dispatch/middleware/flash.rb', line 185

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

#replace(h) ⇒ Object

:nodoc:


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

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.


212
213
214
215
# File 'actionpack/lib/action_dispatch/middleware/flash.rb', line 212

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

#to_hashObject


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

def to_hash
  @flashes.dup
end

#to_session_valueObject


92
93
94
95
# File 'actionpack/lib/action_dispatch/middleware/flash.rb', line 92

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

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

:nodoc:


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

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