Module: Dynamoid::Associations::Association

Included in:
HasOne, ManyAssociation, SingleAssociation
Defined in:
lib/dynamoid/associations/association.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#loadedObject

Returns the value of attribute loaded


11
12
13
# File 'lib/dynamoid/associations/association.rb', line 11

def loaded
  @loaded
end

#nameObject

Returns the value of attribute name


11
12
13
# File 'lib/dynamoid/associations/association.rb', line 11

def name
  @name
end

#optionsObject

Returns the value of attribute options


11
12
13
# File 'lib/dynamoid/associations/association.rb', line 11

def options
  @options
end

#sourceObject

Returns the value of attribute source


11
12
13
# File 'lib/dynamoid/associations/association.rb', line 11

def source
  @source
end

Instance Method Details

#declaration_field_nameObject


53
54
55
# File 'lib/dynamoid/associations/association.rb', line 53

def declaration_field_name
  "#{name}_ids"
end

#declaration_field_typeObject


57
58
59
# File 'lib/dynamoid/associations/association.rb', line 57

def declaration_field_type
  :set
end

#disassociate_sourceObject


61
62
63
64
65
# File 'lib/dynamoid/associations/association.rb', line 61

def disassociate_source
  Array(target).each do |target_entry|
    target_entry.send(target_association).disassociate(source.hash_key) if target_entry && target_association
  end
end

#find_targetObject


37
# File 'lib/dynamoid/associations/association.rb', line 37

def find_target; end

#initialize(source, name, options) ⇒ Dynamoid::Association

Create a new association.

Parameters:

  • source (Class)

    the source record of the association; that is, the record that you already have

  • name (Symbol)

    the name of the association

  • options (Hash)

    optional parameters for the association

Options Hash (options):

  • :class (Class)

    the target class of the association; that is, the class to which the association objects belong

  • :class_name (Symbol)

    the name of the target class of the association; only this or Class is necessary

  • :inverse_of (Symbol)

    the name of the association on the target class

  • :foreign_key (Symbol)

    the name of the field for belongs_to association

Returns:

  • (Dynamoid::Association)

    the actual association instance itself

Since:

  • 0.2.0


26
27
28
29
30
31
# File 'lib/dynamoid/associations/association.rb', line 26

def initialize(source, name, options)
  @name = name
  @options = options
  @source = source
  @loaded = false
end

#loaded?Boolean

Returns:

  • (Boolean)

33
34
35
# File 'lib/dynamoid/associations/association.rb', line 33

def loaded?
  @loaded
end

#resetObject


48
49
50
51
# File 'lib/dynamoid/associations/association.rb', line 48

def reset
  @target = nil
  @loaded = false
end

#targetObject


39
40
41
42
43
44
45
46
# File 'lib/dynamoid/associations/association.rb', line 39

def target
  unless loaded?
    @target = find_target
    @loaded = true
  end

  @target
end