module Mongoid::Copyable

This module contains the behaviour of Mongoid's clone/dup of documents.

Public Instance Methods

clone() click to toggle source

Clone or dup the current Document. This will return all attributes with the exception of the document's id, and will reset all the instance variables.

This clone also includes embedded documents.

@example Clone the document.

document.clone

@param [ Document ] other The document getting cloned.

@return [ Document ] The new document.

# File lib/mongoid/copyable.rb, line 20
def clone
  # @note This next line is here to address #2704, even though having an
  # _id and id field in the document would cause problems with Mongoid
  # elsewhere.
  attrs = clone_document.except("_id", "id")
  dynamic_attrs = {}
  attrs.reject! do |attr_name, value|
    dynamic_attrs.merge!(attr_name => value) unless self.attribute_names.include?(attr_name)
  end
  self.class.new(attrs).tap do |object|
    dynamic_attrs.each do |attr_name, value|
      if object.respond_to?("#{attr_name}=")
        object.send("#{attr_name}=", value)
      else
        object.attributes[attr_name] = value
      end
    end
  end
end

Also aliased as: dup

dup()

Alias for: clone

Private Instance Methods

clone_document() click to toggle source

Clone the document attributes

@api private

@example clone document

model.clone_document

@param [ Hash ] dcoument The document with hash format

@since 3.0.22

# File lib/mongoid/copyable.rb, line 53
def clone_document
  attrs = as_document.__deep_copy__
  process_localized_attributes(self, attrs)
  attrs
end

process_localized_attributes(klass, attrs) click to toggle source

When cloning, if the document has localized fields we need to ensure they are properly processed in the clone.

@api private

@example Process localized attributes.

model.process_localized_attributes(attributes)

@param [ Hash ] attrs The attributes.

@since 3.0.20

# File lib/mongoid/copyable.rb, line 70
def process_localized_attributes(klass, attrs)
  klass.localized_fields.keys.each do |name|
    if value = attrs.delete(name)
      attrs["#{name}_translations"] = value
    end
  end
  klass.embedded_relations.each do |_, metadata|
    next unless attrs.present? && attrs[metadata.key].present?

    if metadata.macro == :embeds_many
      attrs[metadata.key].each do |attr|
        process_localized_attributes(metadata.klass, attr)
      end
    else
      process_localized_attributes(metadata.klass, attrs[metadata.key])
    end
  end
end