123456789_123456789_123456789_123456789_123456789_

Module: Mongoid::Criteria::Queryable::Extensions::Hash

Relationships & Source Files
Defined in: lib/mongoid/criteria/queryable/extensions/hash.rb

Overview

Adds query type-casting behavior to Hash class.

Instance Method Summary

Instance Method Details

#__add__(object) ⇒ Hash

Add an object to a hash using the merge strategies.

Examples:

Add an object to a hash.

{ field: value }.__add__({ field: other_value })

Parameters:

  • object (Hash) —

    The other hash to add.

Returns:

  • (Hash) —

    The hash with object added.

[ GitHub ] 

  


# File 'lib/mongoid/criteria/queryable/extensions/hash.rb', line 20



def __add__(object)
  apply_strategy(:__add__, object)
end


  








  

    #__add_from_array__(array)  ⇒ Hash 
  



  

    

Merge this hash into the provided array.


  





    

    
Examples:

        


Merge the hash into the array.



      
{ field: value }.__add_from_array__([ 1, 2 ])

  


Parameters:


    
  
  • 
    array
    (Array)
—    
    

    The array to add to.
    

    
  
    • 



Returns:


    
  
  • 
    (Hash)
—    
    

    The merged hash.
    

    
  
    • 





  [ GitHub ]


  

  


# File 'lib/mongoid/criteria/queryable/extensions/hash.rb', line 32



def __add_from_array__(array)
  { keys.first => array.__add__(values.first) }
end


  








  

    #__deep_copy__  ⇒ Hash 
  



  

    

Make a deep copy of this hash.


  





    

    
Examples:

        


Make a deep copy of the hash.



      
{ field: value }.__deep_copy__

  


Returns:


    
  
  • 
    (Hash)
—    
    

    The copied hash.
    

    
  
    • 





  [ GitHub ]


  

  


# File 'lib/mongoid/criteria/queryable/extensions/hash.rb', line 102



def __deep_copy__
  {}.tap do |copy|
    each_pair do |key, value|
      copy.store(key, value.__deep_copy__)
    end
  end
end


  








  

    #__expand_complex__  ⇒ Hash 
  



  

    

Get the object as expanded.


  





    

    
Examples:

        


Get the object expanded.



      
obj.__expand_complex__

  


Returns:


    
  
  • 
    (Hash)
—    
    

    The expanded hash.
    

    
  
    • 





  [ GitHub ]


  

  


# File 'lib/mongoid/criteria/queryable/extensions/hash.rb', line 130



def __expand_complex__
  replacement = {}
  each_pair do |key, value|
    replacement.merge!(key.__expr_part__(value.__expand_complex__))
  end
  replacement
end


  








  

    #__intersect__(object)  ⇒ Hash 
  



  

    

Add an object to a hash using the merge strategies.


  





    

    
Examples:

        


Add an object to a hash.



      
{ field: value }.__intersect__({ field: other_value })

  


Parameters:


    
  
  • 
    object
    (Hash)
—    
    

    The other hash to intersect.
    

    
  
    • 



Returns:


    
  
  • 
    (Hash)
—    
    

    The hash with object intersected.
    

    
  
    • 





  [ GitHub ]


  

  


# File 'lib/mongoid/criteria/queryable/extensions/hash.rb', line 44



def __intersect__(object)
  apply_strategy(:__intersect__, object)
end


  








  

    #__intersect_from_array__(array)  ⇒ Hash 
  



  

    

Merge this hash into the provided array.


  





    

    
Examples:

        


Merge the hash into the array.



      
{ field: value }.__intersect_from_array__([ 1, 2 ])

  


Parameters:


    
  
  • 
    array
    (Array)
—    
    

    The array to intersect to.
    

    
  
    • 



Returns:


    
  
  • 
    (Hash)
—    
    

    The merged hash.
    

    
  
    • 





  [ GitHub ]


  

  


# File 'lib/mongoid/criteria/queryable/extensions/hash.rb', line 56



def __intersect_from_array__(array)
  { keys.first => array.__intersect__(values.first) }
end


  








  

    #__intersect_from_object__(object)  ⇒ Hash 
  



  

    

Merge this hash into the provided object.


  





    

    
Examples:

        


Merge the hash into the object.



      
{ field: value }.__intersect_from_object__([ 1, 2 ])

  


Parameters:


    
  
  • 
    object
    (Object)
—    
    

    The object to intersect to.
    

    
  
    • 



Returns:


    
  
  • 
    (Hash)
—    
    

    The merged hash.
    

    
  
    • 





  [ GitHub ]


  

  


# File 'lib/mongoid/criteria/queryable/extensions/hash.rb', line 68



def __intersect_from_object__(object)
  { keys.first => object.__intersect__(values.first) }
end


  








  

    #__sort_option__  ⇒ Hash 
  



  

    

Get the hash as a sort option.


  





    

    
Examples:

        


Get the hash as a sort option.



      
{ field: 1 }.__sort_option__

  


Returns:


    
  
  • 
    (Hash)
—    
    

    The hash as sort option.
    

    
  
    • 





  [ GitHub ]


  

  


# File 'lib/mongoid/criteria/queryable/extensions/hash.rb', line 116



def __sort_option__
  tap do |hash|
    hash.each_pair do |key, value|
      hash.store(key, Mongoid::Criteria::Translator.to_direction(value))
    end
  end
end


  








  

    #__union__(object)  ⇒ Hash 
  



  

    

Add an object to a hash using the merge strategies.


  





    

    
Examples:

        


Add an object to a hash.



      
{ field: value }.__union__({ field: other_value })

  


Parameters:


    
  
  • 
    object
    (Hash)
—    
    

    The other hash to union.
    

    
  
    • 



Returns:


    
  
  • 
    (Hash)
—    
    

    The hash with object unioned.
    

    
  
    • 





  [ GitHub ]


  

  


# File 'lib/mongoid/criteria/queryable/extensions/hash.rb', line 80



def __union__(object)
  apply_strategy(:__union__, object)
end


  








  

    #__union_from_object__(object)  ⇒ Hash 
  



  

    

Merge this hash into the provided object.


  





    

    
Examples:

        


Merge the hash into the object.



      
{ field: value }.__union_from_object__([ 1, 2 ])

  


Parameters:


    
  
  • 
    object
    (Object)
—    
    

    The object to union to.
    

    
  
    • 



Returns:


    
  
  • 
    (Hash)
—    
    

    The merged hash.
    

    
  
    • 





  [ GitHub ]


  

  


# File 'lib/mongoid/criteria/queryable/extensions/hash.rb', line 92



def __union_from_object__(object)
  { keys.first => object.__union__(values.first) }
end


  








  

    #apply_strategy(strategy, object)  ⇒ Hash  (private)
  

  

    This method is for internal use only.
  



  

    

Apply the provided strategy for the hash with the given object.


  





    

    
Examples:

        


Apply the strategy.



      
{ field: value }.apply_strategy(:__add__, 1)

  


Parameters:


    
  
  • 
    strategy
    (Symbol)
—    
    

    The strategy to apply.
    

    
  
    • 
  
  • 
    object
    (Object)
—    
    

    The object to merge.
    

    
  
    • 



Returns:


    
  
  • 
    (Hash)
—    
    

    The merged hash.
    

    
  
    • 





  [ GitHub ]


  

  


# File 'lib/mongoid/criteria/queryable/extensions/hash.rb', line 151



def apply_strategy(strategy, object)
  tap do |hash|
    object.each_pair do |key, value|
      hash.store(key, hash[key].send(strategy, value))
    end
  end
end