123456789_123456789_123456789_123456789_123456789_

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

Instance Attribute Summary

::Enumerable - Included

#many?

Returns true if the enumerable has more than 1 element.

Instance Method Summary

::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 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)  
  

  

    This method is for internal use only.
  

  [ GitHub ]


  

  


# File 'actionpack/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 Attribute Details



  

    #alert   (rw)
  



  

    

Convenience accessor for :alert.


  



  [ GitHub ]


  

  


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



def alert
  self[:alert]
end


  








  

    #alert=(message)   (rw)
  



  

    

Convenience accessor for =.


  



  [ GitHub ]


  

  


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



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


  








  

    #empty?  ⇒ Boolean  (readonly)
  

  [ GitHub ]


  

  


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



def empty?
  @flashes.empty?
end


  








  

    #notice   (rw)
  



  

    

Convenience accessor for :notice.


  



  [ GitHub ]


  

  


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



def notice
  self[:notice]
end


  








  

    #notice=(message)   (rw)
  



  

    

Convenience accessor for =.


  



  [ GitHub ]


  

  


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



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


  








  

    #now_is_loaded?  ⇒ Boolean  (readonly, protected)
  

  [ GitHub ]


  

  


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



def now_is_loaded?
  @now
end


  







Instance Method Details



  

    #[](k)  
  

  [ GitHub ]


  

  


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



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


  








  

    #[]=(k, v)  
  

  [ GitHub ]


  

  


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



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


  








  

    #clear  
  

  [ GitHub ]


  

  


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



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 189



def delete(key)
  key = key.to_s
  @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 264



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


  








  

    #each(&block)  
  

  [ GitHub ]


  

  


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



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


  








  

    #initialize_copy(other)  
  

  [ GitHub ]


  

  


# File 'actionpack/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)  
  



  

    

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 250



def keep(k = nil)
  k = k.to_s 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 183



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


  








  

    #keys  
  

  [ GitHub ]


  

  


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



def keys
  @flashes.keys
end


  








  

    #merge!(h)  
  



  

    

Alias for #update.


  



  [ GitHub ]


  

  


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



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: '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 241



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 215



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 305



def stringify_array(array) # :doc:
  array.map do |item|
    item.kind_of?(Symbol) ? item.to_s : item
  end
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 274



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 196



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

  

    This method is for internal use only.
  

  [ GitHub ]


  

  


# File 'actionpack/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