Module: Dynamoid::Associations::ManyAssociation

Includes:
Association, Enumerable
Included in:
HasAndBelongsToMany, HasMany
Defined in:
lib/dynamoid/associations/many_association.rb

Instance Attribute Summary collapse

Attributes included from Association

#loaded, #name, #options, #source

Instance Method Summary collapse

Methods included from Association

#declaration_field_name, #declaration_field_type, #loaded?, #reset, #target

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(method, *args) ⇒ Object

Delegate methods we don’t find directly to the records array.

Since:

  • 0.2.0



212
213
214
215
216
217
218
 
# File 'lib/dynamoid/associations/many_association.rb', line 212

def method_missing(method, *args)
  if records.respond_to?(method)
    records.send(method, *args)
  else
    super
  end
end

Instance Attribute Details

#query ⇒ Object

Returns the value of attribute query.



8
9
10
 
# File 'lib/dynamoid/associations/many_association.rb', line 8

def query
  @query
end

Instance Method Details

#<<(object) ⇒ Dynamoid::Document

Add an object or array of objects to an association.

tag.posts << post
tag.posts << [post1, post2, post3]

This preserves the current records in the association (if any) and adds the object to the target association if it is detected to exist.

It saves both models immediately - the source model and the target one so any not saved changes will be saved as well.

Parameters:

  • object (Dynamoid::Document|Array) —

    model (or array of models) to add to the association

Returns:

Since:

  • 0.2.0



87
88
89
90
91
92
93
94
95
 
# File 'lib/dynamoid/associations/many_association.rb', line 87

def <<(object)
  associate(Array(object).collect(&:hash_key))

  if target_association
    Array(object).each { |obj| obj.send(target_association).associate(source.hash_key) }
  end

  object
end

#==(other) ⇒ Boolean

Is this array equal to the association’s records?

Returns:

  • (Boolean) —

    true/false

Since:

  • 0.2.0



204
205
206
 
# File 'lib/dynamoid/associations/many_association.rb', line 204

def ==(other)
  records == Array(other)
end

#associate(hash_key) ⇒ Object 



221
222
223
 
# File 'lib/dynamoid/associations/many_association.rb', line 221

def associate(hash_key)
  source.update_attribute(source_attribute, source_ids.merge(Array(hash_key)))
end

#create(attributes = {}) ⇒ Dynamoid::Document|Array

Create a new instance of the target class, persist it and add directly to the association.

tag.posts.create(title: 'foo')

Several models can be created at once when an array of attributes specified:

tag.posts.create([{ title: 'foo' }, {title: 'bar'} ])

Parameters:

  • attributes (Hash) (defaults to: {}) —

    attribute values for the new object

Returns:

Since:

  • 0.2.0



144
145
146
 
# File 'lib/dynamoid/associations/many_association.rb', line 144

def create(attributes = {})
  self << target_class.create(attributes)
end

#create!(attributes = {}) ⇒ Dynamoid::Document|Array

Create a new instance of the target class, persist it and add directly to the association.

tag.posts.create!(title: 'foo')

Several models can be created at once when an array of attributes specified:

tag.posts.create!([{ title: 'foo' }, {title: 'bar'} ])

If the creation fails an exception will be raised.

Parameters:

  • attributes (Hash) (defaults to: {}) —

    attribute values for the new object

Returns:

Since:

  • 0.2.0



127
128
129
 
# File 'lib/dynamoid/associations/many_association.rb', line 127

def create!(attributes = {})
  self << target_class.create!(attributes)
end

#delete(object) ⇒ Dynamoid::Document|Array

Delete an object or array of objects from the association.

tag.posts.delete(post)
tag.posts.delete([post1, post2, post3])

This removes their records from the association field on the source, and attempts to remove the source from the target association if it is detected to exist.

It saves both models immediately - the source model and the target one so any not saved changes will be saved as well.

Parameters:

  • object (Dynamoid::Document|Array) —

    model (or array of models) to remove from the association

Returns:

Since:

  • 0.2.0



65
66
67
68
69
70
71
 
# File 'lib/dynamoid/associations/many_association.rb', line 65

def delete(object)
  disassociate(Array(object).collect(&:hash_key))
  if target_association
    Array(object).each { |obj| obj.send(target_association).disassociate(source.hash_key) }
  end
  object
end

#delete_all ⇒ Object

Deletes all members of the association and removes them from the association.

tag.posts.delete_all

Since:

  • 0.2.0



176
177
178
179
180
 
# File 'lib/dynamoid/associations/many_association.rb', line 176

def delete_all
  objs = target
  source.update_attribute(source_attribute, nil)
  objs.each(&:delete)
end

#destroy_all ⇒ Object

Destroys all members of the association and removes them from the association.

tag.posts.destroy_all

Since:

  • 0.2.0



164
165
166
167
168
 
# File 'lib/dynamoid/associations/many_association.rb', line 164

def destroy_all
  objs = target
  source.update_attribute(source_attribute, nil)
  objs.each(&:destroy)
end

#disassociate(hash_key) ⇒ Object 



226
227
228
 
# File 'lib/dynamoid/associations/many_association.rb', line 226

def disassociate(hash_key)
  source.update_attribute(source_attribute, source_ids - Array(hash_key))
end

#each(&block) ⇒ Dynamoid::Document

Create a new instance of the target class and add it directly to the association. If the create fails an exception will be raised.

Returns:

Since:

  • 0.2.0



154
155
156
 
# File 'lib/dynamoid/associations/many_association.rb', line 154

def each(&block)
  records.each(&block)
end

#find_target ⇒ Object

The records associated to the source.

Returns:

  • the association records; depending on which association this is, either a single instance or an array

Since:

  • 0.2.0



27
28
29
 
# File 'lib/dynamoid/associations/many_association.rb', line 27

def find_target
  Array(target_class.find(source_ids.to_a))
end

#include?(object) ⇒ Boolean

Delegate include? to the records.

Returns:

  • (Boolean) 


46
47
48
 
# File 'lib/dynamoid/associations/many_association.rb', line 46

def include?(object)
  records.include?(object)
end

#initialize(*args) ⇒ Object 



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

def initialize(*args)
  @query = {}
  super
end

#records ⇒ Object Also known as: all 



32
33
34
35
36
37
38
 
# File 'lib/dynamoid/associations/many_association.rb', line 32

def records
  if query.empty?
    target
  else
    results_with_query(target)
  end
end

#setter(object) ⇒ Dynamoid::Document|Array

Replace an association with object or array of objects. This removes all of the existing associated records and replaces them with the passed object(s), and associates the target association if it is detected to exist.

Parameters:

  • object (Dynamoid::Document) —

    the object (or array of objects) to add to the association

Returns:

Since:

  • 0.2.0



106
107
108
109
110
 
# File 'lib/dynamoid/associations/many_association.rb', line 106

def setter(object)
  target.each { |o| delete(o) }
  self << object
  object
end

#where(args) ⇒ Dynamoid::Association

Naive association filtering.

tag.posts.where(title: 'foo')

It loads lazily all the associated models and checks provided conditions. That’s why only equality conditions can be specified.

Parameters:

  • args (Hash) —

    A hash of attributes; each must match every returned object’s attribute exactly.

Returns:

  • (Dynamoid::Association) —

    the association this method was called on (for chaining purposes)

Since:

  • 0.2.0



192
193
194
195
196
197
 
# File 'lib/dynamoid/associations/many_association.rb', line 192

def where(args)
  filtered = clone
  filtered.query = query.clone
  args.each { |k, v| filtered.query[k] = v }
  filtered
end