Module: Mongoid::Association::Nested::Buildable

Included in:
Many, One
Defined in:
lib/mongoid/association/nested/nested_buildable.rb

Overview

Mixin module containing common functionality used to perform #accepts_nested_attributes_for attribute assignment on associations.

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#association ⇒ Object

Returns the value of attribute association.



10
11
12
 
# File 'lib/mongoid/association/nested/nested_buildable.rb', line 10

def association
  @association
end

#attributes ⇒ Object

Returns the value of attribute attributes.



10
11
12
 
# File 'lib/mongoid/association/nested/nested_buildable.rb', line 10

def attributes
  @attributes
end

#existing ⇒ Object

Returns the value of attribute existing.



10
11
12
 
# File 'lib/mongoid/association/nested/nested_buildable.rb', line 10

def existing
  @existing
end

#options ⇒ Object

Returns the value of attribute options.



10
11
12
 
# File 'lib/mongoid/association/nested/nested_buildable.rb', line 10

def options
  @options
end

Instance Method Details

#allow_destroy? ⇒ true | false

Determines if destroys are allowed for this document.

Examples:

Do we allow a destroy?

builder.allow_destroy?

Returns:

  • (true | false) —

    True if the allow destroy option was set.



18
19
20
 
# File 'lib/mongoid/association/nested/nested_buildable.rb', line 18

def allow_destroy?
  options[:allow_destroy] || false
end

#convert_id(klass, id) ⇒ BSON::ObjectId | String | Object

Convert an id to its appropriate type.

Ids arriving from a form are always scalars. A Hash or an Array here means the parameters were crafted, and letting one through would turn the id into a query operator, so they are rejected.

Examples:

Convert the id.

builder.convert_id(Person, "4d371b444835d98b8b000010")

Parameters:

  • klass (Class) —

    The class we're trying to convert for.

  • id (String) —

    The id, usually coming from the form.

Returns:

  • (BSON::ObjectId | String | Object) —

    The converted id.

Raises:

  • (Errors::DocumentNotFound) —

    if the id is not a scalar, or cannot be converted to the type the class uses for its ids. The BSON::Error rescue is defensive: a value that reaches BSON::ObjectId.mongoize and raises there must not surface as an unhandled BSON error in the caller.



72
73
74
75
76
77
78
 
# File 'lib/mongoid/association/nested/nested_buildable.rb', line 72

def convert_id(klass, id)
  raise Errors::DocumentNotFound.new(klass, id) if id.is_a?(::Hash) || id.is_a?(::Array)

  klass.using_object_ids? ? BSON::ObjectId.mongoize(id) : id
rescue BSON::Error
  raise Errors::DocumentNotFound.new(klass, id)
end

#reject?(document, attrs) ⇒ true | false

Returns the reject if option defined with the macro.

Examples:

Is there a reject proc?

builder.reject?

Parameters:

  • document (Document) —

    The parent document of the association

  • attrs (Hash) —

    The attributes to check for rejection.

Returns:

  • (true | false) —

    True and call proc or method if rejectable, false if not.



31
32
33
34
35
36
37
38
39
40
 
# File 'lib/mongoid/association/nested/nested_buildable.rb', line 31

def reject?(document, attrs)
  case callback = options[:reject_if]
  when Symbol
    (document.method(callback).arity == 0) ? document.send(callback) : document.send(callback, attrs)
  when Proc
    callback.call(attrs)
  else
    false
  end
end

#update_only? ⇒ true | false

Determines if only updates can occur. Only valid for one-to-one associations.

Examples:

Is this update only?

builder.update_only?

Returns:

  • (true | false) —

    True if the update_only option was set.



49
50
51
 
# File 'lib/mongoid/association/nested/nested_buildable.rb', line 49

def update_only?
  options[:update_only] || false
end