Class: Parse::RelationCollectionProxy

Inherits:
PointerCollectionProxy show all
Defined in:
lib/parse/model/associations/relation_collection_proxy.rb

Overview

The RelationCollectionProxy is similar to a PointerCollectionProxy except that there is no actual “array” object in Parse. Parse treats relation through an intermediary table (a.k.a. join table). Whenever a developer wants the contents of a collection, the foreign table needs to be queried instead. In this scenario, the parse_class: initializer argument should be passed in order to know which remote table needs to be queried in order to fetch the items of the collection.

Unlike managing an array of Pointers, relations in Parse are done throug atomic operations, which have a specific API. The design of this proxy is to maintain two sets of lists, items to be added to the relation and a separate list of items to be removed from the relation.

Because this relationship is based on queryable Parse table, we are also able to not just get all the items in a collection, but also provide additional constraints to get matching items within the relation collection.

When creating a Relation proxy, all the delegate methods defined in the superclasses need to be implemented, in addition to a few others with the key parameter: _relation_query and _commit_relation_updates . :'key'_relation_query should return a Parse::Query object that is properly tied to the foreign table class related to this object column. Example, if an Artist has many Song objects, then the query to be returned by this method should be a Parse::Query for the class 'Song'. Because relation changes are separate from object changes, you can call save on a relation collection to save the current add and remove operations. Because the delegate needs to be informed of the changes being committed, it will be notified through :'key'_commit_relation_updates message. The delegate is also in charge of clearing out the change information for the collection if saved successfully.

Instance Attribute Summary collapse

Attributes inherited from PointerCollectionProxy

#collection

Attributes inherited from CollectionProxy

#collection, #delegate, #key, #loaded, #parse_class

Instance Method Summary collapse

Methods inherited from PointerCollectionProxy

#as_json, #fetch, #fetch!

Methods inherited from CollectionProxy

#&, #+, #-, #==, #add_unique, #as_json, #changes_applied!, #clear, #clear_changes!, #count, #destroy!, #each, #empty?, #first, #flatten, #forward, #last, #loaded?, #map, #notify_will_change!, #parse_objects, #parse_pointers, #reload!, #reset!, #rollback!, #second, #select, #set_collection!, #to_a, #uniq, #uniq!, #|

Constructor Details

#initialize(collection = nil, delegate: nil, key: nil, parse_class: nil) ⇒ RelationCollectionProxy

Returns a new instance of RelationCollectionProxy.


48
49
50
51
52
# File 'lib/parse/model/associations/relation_collection_proxy.rb', line 48

def initialize(collection = nil, delegate: nil, key: nil, parse_class: nil)
  super
  @additions = []
  @removals = []
end

Instance Attribute Details

#additionsObject (readonly)

The objects that have been newly added to this collection


46
47
48
# File 'lib/parse/model/associations/relation_collection_proxy.rb', line 46

def additions
  @additions
end

#removalsArray<Parse::Object> (readonly)


46
# File 'lib/parse/model/associations/relation_collection_proxy.rb', line 46

attr_reader :additions, :removals

Instance Method Details

#<<(*list) ⇒ Object

See Also:


154
155
156
157
# File 'lib/parse/model/associations/relation_collection_proxy.rb', line 154

def <<(*list)
  list.each { |d| add(d) }
  @collection
end

#add(parse_object) ⇒ Array<Parse::Object> #add(parse_objects) ⇒ Array<Parse::Object>

Add Parse::Objects to the relation.

Overloads:

Returns:


79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
# File 'lib/parse/model/associations/relation_collection_proxy.rb', line 79

def add(*items)
  items = items.flatten.parse_objects
  return @collection if items.empty?

  notify_will_change!
  additions_will_change!
  removals_will_change!
  # take all the items
  items.each do |item|
    @additions.push item
    @collection.push item
    #cleanup
    @removals.delete item
  end
  @collection
end

#add!(*items) ⇒ Object

Atomically add a set of Parse::Objects to this relation. This is done by making the API request directly with Parse server; the local object is not updated with changes.


122
123
124
125
126
# File 'lib/parse/model/associations/relation_collection_proxy.rb', line 122

def add!(*items)
  return false unless @delegate.respond_to?(:op_add_relation!)
  items = items.flatten.parse_pointers
  @delegate.send :op_add_relation!, @key, items
end

#add_unique!(*items) ⇒ Object

Atomically add a set of Parse::Objects to this relation. This is done by making the API request directly with Parse server; the local object is not updated with changes.


131
132
133
134
135
# File 'lib/parse/model/associations/relation_collection_proxy.rb', line 131

def add_unique!(*items)
  return false unless @delegate.respond_to?(:op_add_relation!)
  items = items.flatten.parse_pointers
  @delegate.send :op_add_relation!, @key, items
end

#all(constraints = {}, &block) ⇒ Object

You can get items within the collection relation filtered by a specific set of query constraints.


56
57
58
59
60
61
62
63
64
# File 'lib/parse/model/associations/relation_collection_proxy.rb', line 56

def all(constraints = {}, &block)
  q = query({ limit: :max }.merge(constraints))
  if block_given?
    # if we have a query, then use the Proc with it (more efficient)
    return q.present? ? q.results(&block) : collection.each(&block)
  end
  # if no block given, get all the results
  q.present? ? q.results : collection
end

#query(constraints = {}) ⇒ Object

Ask the delegate to return a query for this collection type


67
68
69
# File 'lib/parse/model/associations/relation_collection_proxy.rb', line 67

def query(constraints = {})
  q = forward :"#{@key}_relation_query"
end

#remove(parse_object) ⇒ Array<Parse::Object> #remove(parse_objects) ⇒ Array<Parse::Object>

Removes Parse::Objects from the relation.

Overloads:

Returns:


104
105
106
107
108
109
110
111
112
113
114
115
116
117
# File 'lib/parse/model/associations/relation_collection_proxy.rb', line 104

def remove(*items)
  items = items.flatten.parse_objects
  return @collection if items.empty?
  notify_will_change!
  additions_will_change!
  removals_will_change!
  items.each do |item|
    @removals.push item
    @collection.delete item
    # remove it from any add operations
    @additions.delete item
  end
  @collection
end

#remove!(*items) ⇒ Object

Atomically remove a set of Parse::Objects to this relation. This is done by making the API request directly with Parse server; the local object is not updated with changes.


140
141
142
143
144
# File 'lib/parse/model/associations/relation_collection_proxy.rb', line 140

def remove!(*items)
  return false unless @delegate.respond_to?(:op_remove_relation!)
  items = items.flatten.parse_pointers
  @delegate.send :op_remove_relation!, @key, items
end

#saveObject

Save the changes to the relation


147
148
149
150
151
# File 'lib/parse/model/associations/relation_collection_proxy.rb', line 147

def save
  unless @removals.empty? && @additions.empty?
    forward :"#{@key}_commit_relation_updates"
  end
end