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, :class_name, :dependent, :extend, :foreign_key, :polymorphic]

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of Base.



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

def initialize(type, name, options={}, &extension)
  @type, @name, @options, @finder_options = type, name, {}, {}
  options.symbolize_keys!

  options[:extend] = modulized_extensions(extension, options[:extend])

  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 



64
65
66
 
# File 'lib/mongo_mapper/associations/base.rb', line 64

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

#as? ⇒ Boolean

Returns:



56
57
58
 
# File 'lib/mongo_mapper/associations/base.rb', line 56

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

#belongs_to? ⇒ Boolean

Returns:



44
45
46
 
# File 'lib/mongo_mapper/associations/base.rb', line 44

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

#class_name ⇒ Object 



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

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:



76
77
78
 
# File 'lib/mongo_mapper/associations/base.rb', line 76

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

#foreign_key ⇒ Object 



68
69
70
 
# File 'lib/mongo_mapper/associations/base.rb', line 68

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

#ivar ⇒ Object 



72
73
74
 
# File 'lib/mongo_mapper/associations/base.rb', line 72

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

#klass ⇒ Object 



36
37
38
 
# File 'lib/mongo_mapper/associations/base.rb', line 36

def klass
  @klass ||= options[:class] || class_name.constantize
end

#many? ⇒ Boolean

Returns:



40
41
42
 
# File 'lib/mongo_mapper/associations/base.rb', line 40

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

#one? ⇒ Boolean

Returns:



48
49
50
 
# File 'lib/mongo_mapper/associations/base.rb', line 48

def one?
  @one_type ||= @type == :one
end

#polymorphic? ⇒ Boolean

Returns:



52
53
54
 
# File 'lib/mongo_mapper/associations/base.rb', line 52

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

#proxy_class ⇒ Object 



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/mongo_mapper/associations/base.rb', line 80

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

#type_key_name ⇒ Object 



60
61
62
 
# File 'lib/mongo_mapper/associations/base.rb', line 60

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