Class: DuckRecord::Associations::CollectionAssociation

Inherits:
Association
  • Object
show all
Defined in:
lib/duck_record/associations/collection_association.rb

Overview

Active Record Association Collection

CollectionAssociation is an abstract class that provides common stuff to ease the implementation of association proxies that represent collections. See the class hierarchy in Association.

CollectionAssociation:
  HasManyAssociation => has_many
    HasManyThroughAssociation + ThroughAssociation => has_many :through

The CollectionAssociation class provides common methods to the collections defined by has_and_belongs_to_many, has_many or has_many with the :through association option.

You need to be careful with assumptions regarding the target: The proxy does not fetch records from the database until it needs them, but new ones created with build are added to the target. So, the target may be non-empty and still lack children waiting to be read from the database. If you look directly to the database you cannot assume that’s the entire collection because new records may have been added to the target, etc.

If you need to work on all current children, new and existing records, load_target and the loaded flag are your friends.

Direct Known Subclasses

HasManyAssociation

Instance Attribute Summary

Attributes inherited from Association

#owner, #reflection, #target

Instance Method Summary collapse

Methods inherited from Association

#aliased_table_name, #association_scope, #create, #create!, #extensions, #initialize, #initialize_attributes, #interpolate, #klass, #loaded!, #loaded?, #marshal_dump, #marshal_load, #reload, #remove_inverse_instance, #reset_scope, #set_inverse_instance, #stale_target?, #target_scope

Constructor Details

This class inherits a constructor from DuckRecord::Associations::Association

Instance Method Details

#add_to_target(record, skip_callbacks = false, &block) ⇒ Object 



252
253
254
255
256
257
 
# File 'lib/duck_record/associations/collection_association.rb', line 252

def add_to_target(record, skip_callbacks = false, &block)
  if association_scope.distinct_value
    index = @target.index(record)
  end
  replace_on_target(record, index, skip_callbacks, &block)
end

#build(attributes = {}, &block) ⇒ Object 



82
83
84
85
86
87
88
89
90
 
# File 'lib/duck_record/associations/collection_association.rb', line 82

def build(attributes = {}, &block)
  if attributes.is_a?(Array)
    attributes.collect { |attr| build(attr, &block) }
  else
    add_to_target(build_record(attributes)) do |record|
      yield(record) if block_given?
    end
  end
end

#concat(*records) ⇒ Object

Add records to this association. Returns self so method calls may be chained. Since << flattens its argument list and inserts each record, push and concat behave identically.



95
96
97
98
99
100
101
102
103
 
# File 'lib/duck_record/associations/collection_association.rb', line 95

def concat(*records)
  records = records.flatten
  if owner.new_record?
    load_target
    concat_records(records)
  else
    transaction { concat_records(records) }
  end
end

#delete(*records) ⇒ Object

Removes records from this association calling before_remove and after_remove callbacks.

This method is abstract in the sense that delete_records has to be provided by descendants. Note this method does not imply the records are actually removed from the database, that depends precisely on delete_records. They are in any case removed from the collection.



157
158
159
160
161
 
# File 'lib/duck_record/associations/collection_association.rb', line 157

def delete(*records)
  return if records.empty?
  records = find(records) if records.any? { |record| record.kind_of?(Integer) || record.kind_of?(String) }
  delete_or_destroy(records, options[:dependent])
end

#delete_all ⇒ Object

Removes all records from the association without calling callbacks on the associated records. It honors the :dependent option. However if the :dependent value is :destroy then in that case the :delete_all deletion strategy for the association is applied.

You can force a particular deletion strategy by passing a parameter.

Example:

@author.books.delete_all(:nullify) @author.books.delete_all(:delete_all)

See delete for more info.



133
134
135
136
137
138
 
# File 'lib/duck_record/associations/collection_association.rb', line 133

def delete_all
  delete_or_nullify_all_records(:delete_all).tap do
    reset
    loaded!
  end
end

#destroy(*records) ⇒ Object

Deletes the records and removes them from this association calling before_remove , after_remove , before_destroy and after_destroy callbacks.

Note that this method removes records from the database ignoring the :dependent option.



168
169
170
171
172
 
# File 'lib/duck_record/associations/collection_association.rb', line 168

def destroy(*records)
  return if records.empty?
  records = find(records) if records.any? { |record| record.kind_of?(Integer) || record.kind_of?(String) }
  delete_or_destroy(records, :destroy)
end

#destroy_all ⇒ Object

Destroy all the records from this association.

See destroy for more info.



143
144
145
146
147
148
 
# File 'lib/duck_record/associations/collection_association.rb', line 143

def destroy_all
  destroy(load_target).tap do
    reset
    loaded!
  end
end

#empty? ⇒ Boolean

Returns true if the collection is empty.

If the collection has been loaded it is equivalent to collection.size.zero?. If the collection has not been loaded, it is equivalent to collection.exists?. If the collection has not already been loaded and you are going to fetch the records anyway it is better to check collection.length.zero?.

Returns:

  • (Boolean) 


205
206
207
208
209
210
211
 
# File 'lib/duck_record/associations/collection_association.rb', line 205

def empty?
  if loaded?
    size.zero?
  else
    @target.blank? && !scope.exists?
  end
end

#find(*args) ⇒ Object 



74
75
76
77
78
79
80
 
# File 'lib/duck_record/associations/collection_association.rb', line 74

def find(*args)
  if block_given?
    load_target.find(*args) { |*block_args| yield(*block_args) }
  else
    scope.find(*args)
  end
end

#find_from_target? ⇒ Boolean

Returns:

  • (Boolean) 


269
270
271
272
273
 
# File 'lib/duck_record/associations/collection_association.rb', line 269

def find_from_target?
  loaded? ||
    owner.new_record? ||
    target.any? { |record| record.new_record? || record.changed? }
end

#ids_reader ⇒ Object

Implements the ids reader method, e.g. foo.item_ids for Foo.has_many :items



43
44
45
46
47
48
49
 
# File 'lib/duck_record/associations/collection_association.rb', line 43

def ids_reader
  if loaded?
    target.pluck(reflection.association_primary_key)
  else
    @association_ids ||= scope.pluck(reflection.association_primary_key)
  end
end

#ids_writer(ids) ⇒ Object

Implements the ids writer method, e.g. foo.item_ids= for Foo.has_many :items



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/duck_record/associations/collection_association.rb', line 52

def ids_writer(ids)
  pk_type = reflection.association_primary_key_type
  ids = Array(ids).reject(&:blank?)
  ids.map! { |i| pk_type.cast(i) }

  primary_key = reflection.association_primary_key
  records = klass.where(primary_key => ids).index_by do |r|
    r.public_send(primary_key)
  end.values_at(*ids).compact

  if records.size != ids.size
    klass.all.raise_record_not_found_exception!(ids, records.size, ids.size, primary_key)
  else
    replace(records)
  end
end

#include?(record) ⇒ Boolean

Returns:

  • (Boolean) 


231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/duck_record/associations/collection_association.rb', line 231

def include?(record)
  if record.is_a?(reflection.klass)
    if record.new_record?
      include_in_memory?(record)
    else
      loaded? ? target.include?(record) : scope.exists?(record.id)
    end
  else
    false
  end
end

#load_target ⇒ Object 



243
244
245
246
247
248
249
250
 
# File 'lib/duck_record/associations/collection_association.rb', line 243

def load_target
  if find_target?
    @target = merge_target_lists(find_target, target)
  end

  loaded!
  target
end

#null_scope? ⇒ Boolean

Returns:

  • (Boolean) 


265
266
267
 
# File 'lib/duck_record/associations/collection_association.rb', line 265

def null_scope?
  owner.new_record? && !foreign_key_present?
end

#reader ⇒ Object

Implements the reader method, e.g. foo.items for Foo.has_many :items



28
29
30
31
32
33
34
35
 
# File 'lib/duck_record/associations/collection_association.rb', line 28

def reader
  if stale_target?
    reload
  end

  @proxy ||= CollectionProxy.new(klass, self)
  @proxy.reset_scope
end

#replace(other_array) ⇒ Object

Replace this collection with other_array. This will perform a diff and delete/add only records that have changed.



215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/duck_record/associations/collection_association.rb', line 215

def replace(other_array)
  other_array.each { |val| raise_on_type_mismatch!(val) }
  original_target = load_target.dup

  if owner.new_record?
    replace_records(other_array, original_target)
  else
    replace_common_records_in_memory(other_array, original_target)
    if other_array != original_target
      transaction { replace_records(other_array, original_target) }
    else
      other_array
    end
  end
end

#reset ⇒ Object 



69
70
71
72
 
# File 'lib/duck_record/associations/collection_association.rb', line 69

def reset
  super
  @target = []
end

#scope ⇒ Object 



259
260
261
262
263
 
# File 'lib/duck_record/associations/collection_association.rb', line 259

def scope
  scope = super
  scope.none! if null_scope?
  scope
end

#size ⇒ Object

Returns the size of the collection by executing a SELECT COUNT(*) query if the collection hasn’t been loaded, and calling collection.size if it has.

If the collection has been already loaded size and length are equivalent. If not and you are going to need the records anyway length will take one less query. Otherwise size is more efficient.

This method is abstract in the sense that it relies on count_records, which is a method descendants have to provide.



184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/duck_record/associations/collection_association.rb', line 184

def size
  if !find_target? || loaded?
    target.size
  elsif !association_scope.group_values.empty?
    load_target.size
  elsif !association_scope.distinct_value && target.is_a?(Array)
    unsaved_records = target.select(&:new_record?)
    unsaved_records.size + count_records
  else
    count_records
  end
end

#transaction(*args) ⇒ Object

Starts a transaction in the association class’s database connection.

class Author < ActiveRecord::Base
  has_many :books
end

Author.first.books.transaction do
  # same effect as calling Book.transaction
end



114
115
116
117
118
 
# File 'lib/duck_record/associations/collection_association.rb', line 114

def transaction(*args)
  reflection.klass.transaction(*args) do
    yield
  end
end

#writer(records) ⇒ Object

Implements the writer method, e.g. foo.items= for Foo.has_many :items



38
39
40
 
# File 'lib/duck_record/associations/collection_association.rb', line 38

def writer(records)
  replace(records)
end