Class: ActionDispatch::Flash::FlashHash

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Instance Chain: self, `::Enumerable`, `::ActiveSupport::EnumerableCoreExt::Constants`
Inherits:	Object
Defined in:	actionpack/lib/action_dispatch/middleware/flash.rb

Class Method Summary

.from_session_value(value) Internal use only
.new(flashes = {}, discard = []) ⇒ FlashHash constructor Internal use only

Instance Attribute Summary

#alert rw

Convenience accessor for flash[:alert].
#alert=(message) rw

Convenience accessor for flash[:alert]=.
#empty? ⇒ Boolean readonly
#notice rw

Convenience accessor for flash[:notice].
#notice=(message) rw

Convenience accessor for flash[:notice]=.
#now_is_loaded? ⇒ Boolean readonly protected

`::Enumerable` - Included

#many?

Returns true if the enumerable has more than 1 element.

Instance Method Summary

#[](k)
#[]=(k, v)
#clear
#delete(key)

Immediately deletes the single flash entry.
#discard(k = nil)

Marks the entire flash or a single flash entry to be discarded by the end of the current action:
#each(&block)
#initialize_copy(other)
#keep(k = nil)

Keeps either the entire current flash or a specific flash entry available for the next action:
#key?(name) ⇒ Boolean
#keys
#merge!(h)

Alias for #update.
#now

Sets a flash that will not be available to the next action, only to the current.
#to_hash
#stringify_array(array) private
#stringify_key(key) private

::ActionDispatch::Flash keys are Symbols at nearly every call site.
#replace(h) Internal use only
#sweep Internal use only

Mark for removal entries that were kept, and delete unkept ones.
#to_session_value Internal use only

Builds a hash containing the flashes to keep for the next request.
#update(h) (also: #merge!) Internal use only

`::Enumerable` - Included

#compact_blank	Returns a new `::Array` without the blank items.
#exclude?	The negative of the `Enumerable#include?`.
#excluding	Returns a copy of the enumerable excluding the specified elements.
#in_order_of	Returns a new `::Array` where the order has been set to that provided in the `series`, based on the `key` of the objects in the original enumerable.
#including	Returns a new array that includes the passed elements.
#index_by	Convert an enumerable to a hash, using the block result as the key and the element as the value.
#index_with	Convert an enumerable to a hash, using the element as the key and the block result as the value.
#maximum	Calculates the maximum from the extracted elements.
#minimum	Calculates the minimum from the extracted elements.
#pick	Extract the given key from the first element in the enumerable.
#pluck	Extract the given key from each element in the enumerable.
#sole	Returns the sole item in the enumerable.
#without	Alias for Enumerable#excluding.
#as_json

`::ActiveSupport::EnumerableCoreExt::Constants` - Included

#const_missing

Constructor Details

.new(flashes = {}, discard = []) ⇒ `FlashHash`

This method is for internal use only.

[ GitHub ]

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


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)

This method is for internal use only.

[ GitHub ]

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


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 Attribute Details

#alert (rw)

Convenience accessor for flash[:alert].

[ GitHub ]

# File 'actionpack/lib/action_dispatch/middleware/flash.rb', line 277


def alert
  self[:alert]
end

#alert=(message) (rw)

Convenience accessor for flash[:alert]=.

[ GitHub ]

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


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

#empty? ⇒ `Boolean` (readonly)

[ GitHub ]

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


def empty?
  @flashes.empty?
end

#notice (rw)

Convenience accessor for flash[:notice].

[ GitHub ]

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


def notice
  self[:notice]
end

#notice=(message) (rw)

Convenience accessor for flash[:notice]=.

[ GitHub ]

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


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

#now_is_loaded? ⇒ `Boolean` (readonly, protected)

[ GitHub ]

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


def now_is_loaded?
  @now
end

Instance Method Details

#[](k)

[ GitHub ]

# File 'actionpack/lib/action_dispatch/middleware/flash.rb', line 166


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

#[]=(k, v)

[ GitHub ]

# File 'actionpack/lib/action_dispatch/middleware/flash.rb', line 160


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

#clear

[ GitHub ]

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


def clear
  @discard.clear
  @flashes.clear
end

#delete(key)

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

[ GitHub ]

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


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

#discard(k = nil)

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.

[ GitHub ]

# File 'actionpack/lib/action_dispatch/middleware/flash.rb', line 261


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

#each(&block)

[ GitHub ]

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


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

#initialize_copy(other)

[ GitHub ]

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


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

#keep(k = nil)

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

[ GitHub ]

# File 'actionpack/lib/action_dispatch/middleware/flash.rb', line 247


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

#key?(name) ⇒ `Boolean`

[ GitHub ]

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


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

#keys

[ GitHub ]

# File 'actionpack/lib/action_dispatch/middleware/flash.rb', line 176


def keys
  @flashes.keys
end

#merge!(h)

Alias for #update.

[ GitHub ]

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


alias :merge! :update

#now

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

[ GitHub ]

# File 'actionpack/lib/action_dispatch/middleware/flash.rb', line 238


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

#replace(h)

This method is for internal use only.

[ GitHub ]

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


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

#stringify_array(array) (private)

[ GitHub ]

# File 'actionpack/lib/action_dispatch/middleware/flash.rb', line 302


def stringify_array(array) # :doc:
  array.map do |item|
    item.kind_of?(Symbol) ? item.name : item
  end
end

#stringify_key(key) (private)

::ActionDispatch::Flash keys are Symbols at nearly every call site. Symbol#name returns the interned frozen string where Symbol#to_s would allocate a new one.

[ GitHub ]

# File 'actionpack/lib/action_dispatch/middleware/flash.rb', line 310


def stringify_key(key)
  key.is_a?(Symbol) ? key.name : key.to_s
end

#sweep

This method is for internal use only.

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.

[ GitHub ]

# File 'actionpack/lib/action_dispatch/middleware/flash.rb', line 271


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

#to_hash

[ GitHub ]

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


def to_hash
  @flashes.dup
end

#to_session_value

This method is for internal use only.

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

[ GitHub ]

# File 'actionpack/lib/action_dispatch/middleware/flash.rb', line 140


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) Also known as: #merge!

This method is for internal use only.

[ GitHub ]

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


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

Class: ActionDispatch::Flash::FlashHash

Class Method Summary

Instance Attribute Summary

::Enumerable - Included

Instance Method Summary

::Enumerable - Included

::ActiveSupport::EnumerableCoreExt::Constants - Included

Constructor Details

.new(flashes = {}, discard = []) ⇒ FlashHash

Class Method Details

.from_session_value(value)

Instance Attribute Details

#alert (rw)

#alert=(message) (rw)

#empty? ⇒ Boolean (readonly)

#notice (rw)

#notice=(message) (rw)

#now_is_loaded? ⇒ Boolean (readonly, protected)

Instance Method Details

#[](k)

#[]=(k, v)

#clear

#delete(key)

#discard(k = nil)

#each(&block)

#initialize_copy(other)

#keep(k = nil)

#key?(name) ⇒ Boolean

#keys

#merge!(h)

#now

#replace(h)

#stringify_array(array) (private)

#stringify_key(key) (private)

#sweep

#to_hash

#to_session_value

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

`::Enumerable` - Included

`::Enumerable` - Included

`::ActiveSupport::EnumerableCoreExt::Constants` - Included

.new(flashes = {}, discard = []) ⇒ `FlashHash`

#empty? ⇒ `Boolean` (readonly)

#now_is_loaded? ⇒ `Boolean` (readonly, protected)

#key?(name) ⇒ `Boolean`