Module: Mongoid::Persistable::Pushable

Extended by:
ActiveSupport::Concern
Included in:
Mongoid::Persistable
Defined in:
lib/mongoid/persistable/pushable.rb

Overview

Defines behaviour for $push and $addToSet operations.

Since:

  • 4.0.0

Instance Method Summary collapse

Instance Method Details

#add_to_set(adds) ⇒ true, false

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:

  • (true, false)

    If the operation succeeded.

Since:

  • 4.0.0



22
23
24
25
26
27
28
29
30
31
32
33
34
# File 'lib/mongoid/persistable/pushable.rb', line 22

def add_to_set(adds)
  prepare_atomic_operation do |ops|
    process_atomic_operations(adds) do |field, value|
      existing = send(field) || (attributes[field] ||= [])
      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) ⇒ true, false

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:

  • (true, false)

    If the operation succeeded.

Since:

  • 4.0.0



49
50
51
52
53
54
55
56
57
58
59
# File 'lib/mongoid/persistable/pushable.rb', line 49

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