Class: MongoMapper::Associations::Base

Inherits:
Object
  • Object
show all
Defined in:
lib/mongo_mapper/associations/base.rb

Constant Summary collapse

AssociationOptions =

Options that should not be considered MongoDB query options/criteria

[:as, :class_name, :dependent, :extend, :foreign_key, :polymorphic]

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(type, name, options = {}) ⇒ Base

Returns a new instance of Base.



9
10
11
12
13
14
15
16
17
18
19
20
 
# File 'lib/mongo_mapper/associations/base.rb', line 9

def initialize(type, name, options={})
  @type, @name = type, name
  @options, @finder_options = {}, {}
  
  options.each_pair do |key, value|
    if AssociationOptions.include?(key)
      @options[key] = value
    else
      @finder_options[key] = value
    end
  end
end

Instance Attribute Details

#finder_options ⇒ Object (readonly)

Returns the value of attribute finder_options.



4
5
6
 
# File 'lib/mongo_mapper/associations/base.rb', line 4

def finder_options
  @finder_options
end

#name ⇒ Object (readonly)

Returns the value of attribute name.



4
5
6
 
# File 'lib/mongo_mapper/associations/base.rb', line 4

def name
  @name
end

#options ⇒ Object (readonly)

Returns the value of attribute options.



4
5
6
 
# File 'lib/mongo_mapper/associations/base.rb', line 4

def options
  @options
end

#type ⇒ Object (readonly)

Returns the value of attribute type.



4
5
6
 
# File 'lib/mongo_mapper/associations/base.rb', line 4

def type
  @type
end

Instance Method Details

#as ⇒ Object 



58
59
60
 
# File 'lib/mongo_mapper/associations/base.rb', line 58

def as
  @options[:as] || self.name
end

#as? ⇒ Boolean

Returns:



50
51
52
 
# File 'lib/mongo_mapper/associations/base.rb', line 50

def as?
  !!@options[:as]
end

#belongs_to? ⇒ Boolean

Returns:



42
43
44
 
# File 'lib/mongo_mapper/associations/base.rb', line 42

def belongs_to?
  @belongs_to_type ||= @type == :belongs_to
end

#class_name ⇒ Object 



22
23
24
25
26
27
28
29
30
31
32
 
# File 'lib/mongo_mapper/associations/base.rb', line 22

def class_name
  @class_name ||= begin
    if cn = options[:class_name]
      cn
    elsif many?
      name.to_s.singularize.camelize
    else
      name.to_s.camelize
    end
  end
end

#embeddable? ⇒ Boolean

Returns:



70
71
72
 
# File 'lib/mongo_mapper/associations/base.rb', line 70

def embeddable?
  many? && klass.embeddable?
end

#foreign_key ⇒ Object 



62
63
64
 
# File 'lib/mongo_mapper/associations/base.rb', line 62

def foreign_key
  @options[:foreign_key] || "#{name}_id"
end

#ivar ⇒ Object 



66
67
68
 
# File 'lib/mongo_mapper/associations/base.rb', line 66

def ivar
  @ivar ||= "@_#{name}"
end

#klass ⇒ Object 



34
35
36
 
# File 'lib/mongo_mapper/associations/base.rb', line 34

def klass
  @klass ||= class_name.constantize
end

#many? ⇒ Boolean

Returns:



38
39
40
 
# File 'lib/mongo_mapper/associations/base.rb', line 38

def many?
  @many_type ||= @type == :many
end

#polymorphic? ⇒ Boolean

Returns:



46
47
48
 
# File 'lib/mongo_mapper/associations/base.rb', line 46

def polymorphic?
  !!@options[:polymorphic]
end

#proxy_class ⇒ Object 



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/mongo_mapper/associations/base.rb', line 74

def proxy_class
  @proxy_class ||= begin
    if many?
      if self.klass.embeddable?
        polymorphic? ? ManyEmbeddedPolymorphicProxy : ManyEmbeddedProxy
      else
        if polymorphic?
          ManyPolymorphicProxy
        elsif as?
          ManyDocumentsAsProxy
        else
          ManyProxy
        end
      end
    else
      polymorphic? ? BelongsToPolymorphicProxy : BelongsToProxy
    end
  end # end begin
end

#type_key_name ⇒ Object 



54
55
56
 
# File 'lib/mongo_mapper/associations/base.rb', line 54

def type_key_name
  @type_key_name ||= many? ? '_type' : "#{as}_type"
end