Class: Mongoid::Relations::NestedBuilder

Inherits:
Object
  • Object
show all
Defined in:
lib/mongoid/relations/nested_builder.rb

Overview

This is the superclass for builders that are in charge of handling creation, deletion, and updates of documents through that ever so lovely #accepts_nested_attributes_for.

Direct Known Subclasses

Builders::NestedAttributes::Many, Builders::NestedAttributes::One

Instance Attribute Summary (collapse)

Instance Method Summary (collapse)

Instance Attribute Details

- (Object) attributes

Returns the value of attribute attributes



9
10
11
 
# File 'lib/mongoid/relations/nested_builder.rb', line 9

def attributes
  @attributes
end

- (Object) existing

Returns the value of attribute existing



9
10
11
 
# File 'lib/mongoid/relations/nested_builder.rb', line 9

def existing
  @existing
end

- (Object) metadata

Returns the value of attribute metadata



9
10
11
 
# File 'lib/mongoid/relations/nested_builder.rb', line 9

def metadata
  @metadata
end

- (Object) options

Returns the value of attribute options



9
10
11
 
# File 'lib/mongoid/relations/nested_builder.rb', line 9

def options
  @options
end

Instance Method Details

- (true, false) allow_destroy?

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.

Since:

  • 2.0.0.rc.1



19
20
21
 
# File 'lib/mongoid/relations/nested_builder.rb', line 19

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

- (BSON::ObjectId, ...) convert_id(klass, id)

TODO:

Durran: Move this into a common reusable place.

Convert an id to its appropriate type.

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.

Since:

  • 2.0.0.rc.6



71
72
73
 
# File 'lib/mongoid/relations/nested_builder.rb', line 71

def convert_id(klass, id)
  klass.using_object_ids? ? BSON::ObjectId.mongoize(id) : id
end

- (true, false) reject?(document, attrs)

Returns the reject if option defined with the macro.

Examples:

Is there a reject proc?

builder.reject?

Parameters:

  • The —

    parent document of the relation

  • attrs (Hash) —

    The attributes to check for rejection.

Returns:

  • (true, false) —

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

Since:

  • 2.0.0.rc.1



34
35
36
37
38
39
40
41
42
43
 
# File 'lib/mongoid/relations/nested_builder.rb', line 34

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

- (true, false) update_only?

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

Examples:

Is this update only?

builder.update_only?

Returns:

  • (true, false) —

    True if the update_only option was set.

Since:

  • 2.0.0.rc.1



54
55
56
 
# File 'lib/mongoid/relations/nested_builder.rb', line 54

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