123456789_123456789_123456789_123456789_123456789_

Module: Mongoid::Persistable::Pushable

Relationships & Source Files
Extension / Inclusion / Inheritance Descendants
Included In:
::Mongoid::Composable, ::Mongoid::Document, ::Mongoid::GlobalDiscriminatorKeyAssignment::InvalidFieldHost, ::Mongoid::Persistable
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, ActiveSupport::Concern
Defined in: lib/mongoid/persistable/pushable.rb

Overview

Defines behavior for $push and $addToSet operations.

Instance Method Summary

Instance Method Details

#add_to_set(adds) ⇒ Document

Add the single values to the arrays only if the value does not already exist in the array.

Examples:

Add the values to the sets.

document.add_to_set(names: "James", aliases: "Bond")

Parameters:

  • adds (Hash) —

    The field/value pairs to add.

Returns:

[ GitHub ] 

  


# File 'lib/mongoid/persistable/pushable.rb', line 20



def add_to_set(adds)
  prepare_atomic_operation do |ops|
    process_atomic_operations(adds) do |field, value|
      existing = send(field) || attributes[field]
      if existing.nil?
        attributes[field] = []
        # Read the value out of attributes:
        # https://jira.mongodb.org/browse/MONGOID-4874
        existing = attributes[field]
      end
      values = [ value ].flatten(1)
      values.each do |val|
        existing.push(val) unless existing.include?(val)
      end
      ops[atomic_attribute_name(field)] = { "$each" => values }
    end
    { "$addToSet" => ops }
  end
end


  








  

    #push(pushes)  ⇒ Document 
  



  

    

Push a single value or multiple values onto arrays.


  





    

    
Examples:

        


Push a single value onto arrays.



      
document.push(names: "James", aliases: "007")

        


Push multiple values onto arrays.



      
document.push(names: [ "James", "Bond" ])

  


Parameters:


    
  
  • 
    pushes
    (Hash)
—    
    

    The $push operations.
    

    
  
    • 



Returns:





  [ GitHub ]


  

  


# File 'lib/mongoid/persistable/pushable.rb', line 51



def push(pushes)
  prepare_atomic_operation do |ops|
    process_atomic_operations(pushes) do |field, value|
      existing = send(field) || begin
        attributes[field] ||= []
        attributes[field]
      end
      values = [ value ].flatten(1)
      values.each{ |val| existing.push(val) }
      ops[atomic_attribute_name(field)] = { "$each" => values }
    end
    { "$push" => ops }
  end
end