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:


94
95
96
97
98
# File 'actionpack/lib/action_dispatch/middleware/flash.rb', line 94

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

Class Method Details

.from_session_value(value) ⇒ Object


76
77
78
79
80
81
82
83
84
85
86
87
# File 'actionpack/lib/action_dispatch/middleware/flash.rb', line 76

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


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

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

#[]=(k, v) ⇒ Object


108
109
110
111
# File 'actionpack/lib/action_dispatch/middleware/flash.rb', line 108

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

#alertObject

Convenience accessor for flash[:alert].


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

def alert
  self[:alert]
end

#alert=(message) ⇒ Object

Convenience accessor for flash[:alert]=.


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

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

#clearObject


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

def clear
  @discard.clear
  @flashes.clear
end

#delete(key) ⇒ Object


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

def delete(key)
  @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

197
198
199
200
# File 'actionpack/lib/action_dispatch/middleware/flash.rb', line 197

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

#each(&block) ⇒ Object


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

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

#empty?Boolean


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

def empty?
  @flashes.empty?
end

#initialize_copy(other) ⇒ Object


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

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

188
189
190
191
# File 'actionpack/lib/action_dispatch/middleware/flash.rb', line 188

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

#key?(name) ⇒ Boolean


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

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

#keysObject


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

def keys
  @flashes.keys
end

#noticeObject

Convenience accessor for flash[:notice].


221
222
223
# File 'actionpack/lib/action_dispatch/middleware/flash.rb', line 221

def notice
  self[:notice]
end

#notice=(message) ⇒ Object

Convenience accessor for flash[:notice]=.


226
227
228
# File 'actionpack/lib/action_dispatch/middleware/flash.rb', line 226

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

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

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

#replace(h) ⇒ Object

:nodoc:


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

def replace(h) #:nodoc:
  @discard.clear
  @flashes.replace h
  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.


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

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

#to_hashObject


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

def to_hash
  @flashes.dup
end

#to_session_valueObject


89
90
91
92
# File 'actionpack/lib/action_dispatch/middleware/flash.rb', line 89

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

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

:nodoc:


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

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