Class: ActiveRecord::Associations::AssociationCollection

Inherits:
AssociationProxy show all
Defined in:
lib/active_record/associations/association_collection.rb

Overview

Active Record Association Collection

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

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.

Instance Method Summary collapse

Methods inherited from AssociationProxy

#===, #aliased_table_name, #conditions, #inspect, #loaded, #loaded?, #proxy_owner, #proxy_reflection, #proxy_target, #reload, #respond_to?, #send, #target, #target=

Constructor Details

#initialize(owner, reflection) ⇒ AssociationCollection

:nodoc:



22
23
24
25
 
# File 'lib/active_record/associations/association_collection.rb', line 22

def initialize(owner, reflection)
  super
  construct_sql
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(method, *args) ⇒ Object (protected) 



422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
 
# File 'lib/active_record/associations/association_collection.rb', line 422

def method_missing(method, *args)
  match = DynamicFinderMatch.match(method)
  if match && match.creator?
    attributes = match.attribute_names
    return send(:"find_by_#{attributes.join('_and_')}", *args) || create(Hash[attributes.zip(args)])
  end

  if @target.respond_to?(method) || (!@reflection.klass.respond_to?(method) && Class.respond_to?(method))
    if block_given?
      super { |*block_args| yield(*block_args) }
    else
      super
    end
  elsif @reflection.klass.scopes[method]
    @_named_scopes_cache ||= {}
    @_named_scopes_cache[method] ||= {}
    @_named_scopes_cache[method][args] ||= with_scope(construct_scope) { @reflection.klass.send(method, *args) }
  else
    with_scope(construct_scope) do
      if block_given?
        @reflection.klass.send(method, *args) { |*block_args| yield(*block_args) }
      else
        @reflection.klass.send(method, *args)
      end
    end
  end
end

Instance Method Details

#<<(*records) ⇒ Object Also known as: push, concat

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.



128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/active_record/associations/association_collection.rb', line 128

def <<(*records)
  result = true
  load_target if @owner.new_record?

  transaction do
    flatten_deeper(records).each do |record|
      raise_on_type_mismatch(record)
      add_record_to_target_with_callbacks(record) do |r|
        result &&= insert_record(record) unless @owner.new_record?
      end
    end
  end

  result && self
end

#any? ⇒ Boolean

Returns:

  • (Boolean) 


324
325
326
327
328
329
330
 
# File 'lib/active_record/associations/association_collection.rb', line 324

def any?
  if block_given?
    method_missing(:any?) { |*block_args| yield(*block_args) }
  else
    !empty?
  end
end

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



115
116
117
118
119
120
121
122
123
124
 
# File 'lib/active_record/associations/association_collection.rb', line 115

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

#clear ⇒ Object

Removes all records from this association. Returns self so method calls may be chained.



244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/active_record/associations/association_collection.rb', line 244

def clear
  return self if length.zero? # forces load_target if it hasn't happened already

  if @reflection.options[:dependent] && @reflection.options[:dependent] == :destroy
    destroy_all
  else
    delete_all
  end

  self
end

#count(column_name = nil, options = {}) ⇒ Object

Count all records using SQL. If the :counter_sql option is set for the association, it will be used for the query. If no :counter_sql was supplied, but :finder_sql was set, the descendant’s construct_sql method will have set :counter_sql automatically. Otherwise, construct options and pass them with scope to the target class’s count.



185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/active_record/associations/association_collection.rb', line 185

def count(column_name = nil, options = {})
  column_name, options = nil, column_name if column_name.is_a?(Hash)

  if @reflection.options[:finder_sql] || @reflection.options[:counter_sql]
    unless options.blank?
      raise ArgumentError, "If finder_sql/counter_sql is used then options cannot be passed"
    end

    @reflection.klass.count_by_sql(@counter_sql)
  else

    if @reflection.options[:uniq]
      # This is needed because 'SELECT count(DISTINCT *)..' is not valid SQL.
      column_name = "#{@reflection.quoted_table_name}.#{@reflection.klass.primary_key}" unless column_name
      options.merge!(:distinct => true)
    end

    value = @reflection.klass.send(:with_scope, construct_scope) { @reflection.klass.count(column_name, options) }

    limit  = @reflection.options[:limit]
    offset = @reflection.options[:offset]

    if limit || offset
      [ [value - offset.to_i, 0].max, limit.to_i ].min
    else
      value
    end
  end
end

#create(attrs = {}) ⇒ Object 



267
268
269
270
271
272
273
274
275
276
 
# File 'lib/active_record/associations/association_collection.rb', line 267

def create(attrs = {})
  if attrs.is_a?(Array)
    attrs.collect { |attr| create(attr) }
  else
    create_record(attrs) do |record|
      yield(record) if block_given?
      record.save
    end
  end
end

#create!(attrs = {}) ⇒ Object 



278
279
280
281
282
283
 
# File 'lib/active_record/associations/association_collection.rb', line 278

def create!(attrs = {})
  create_record(attrs) do |record|
    yield(record) if block_given?
    record.save!
  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.



222
223
224
225
226
227
 
# File 'lib/active_record/associations/association_collection.rb', line 222

def delete(*records)
  remove_records(records) do |_records, old_records|
    delete_records(old_records) if old_records.any?
    _records.each { |record| @target.delete(record) }
  end
end

#delete_all ⇒ Object

Remove all records from this association

See delete for more info.



165
166
167
168
169
170
 
# File 'lib/active_record/associations/association_collection.rb', line 165

def delete_all
  load_target
  delete(@target)
  reset_target!
  reset_named_scopes_cache!
end

#destroy(*records) ⇒ Object

Destroy records and remove them from this association calling before_remove and after_remove callbacks.

Note that this method will always remove records from the database ignoring the :dependent option.



234
235
236
237
238
239
240
241
 
# File 'lib/active_record/associations/association_collection.rb', line 234

def destroy(*records)
  records = find(records) if records.any? {|record| record.kind_of?(Fixnum) || record.kind_of?(String)}
  remove_records(records) do |_records, old_records|
    old_records.each { |record| record.destroy }
  end

  load_target
end

#destroy_all ⇒ Object

Destroy all the records from this association.

See destroy for more info.



259
260
261
262
263
264
265
 
# File 'lib/active_record/associations/association_collection.rb', line 259

def destroy_all
  load_target
  destroy(@target).tap do
    reset_target!
    reset_named_scopes_cache!
  end
end

#empty? ⇒ Boolean

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

Returns:

  • (Boolean) 


320
321
322
 
# File 'lib/active_record/associations/association_collection.rb', line 320

def empty?
  size.zero?
end

#find(*args) ⇒ Object 



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/active_record/associations/association_collection.rb', line 42

def find(*args)
  options = args.extract_options!

  # If using a custom finder_sql, scan the entire collection.
  if @reflection.options[:finder_sql]
    expects_array = args.first.kind_of?(Array)
    ids           = args.flatten.compact.uniq.map { |arg| arg.to_i }

    if ids.size == 1
      id = ids.first
      record = load_target.detect { |r| id == r.id }
      expects_array ? [ record ] : record
    else
      load_target.select { |r| ids.include?(r.id) }
    end
  else
    merge_options_from_reflection!(options)
    construct_find_options!(options)

    find_scope = construct_scope[:find].slice(:conditions, :order)

    with_scope(:find => find_scope) do
      relation = @reflection.klass.send(:construct_finder_arel, options, @reflection.klass.send(:current_scoped_methods))

      case args.first
      when :first, :last
        relation.send(args.first)
      when :all
        records = relation.all
        @reflection.options[:uniq] ? uniq(records) : records
      else
        relation.find(*args)
      end
    end
  end
end

#first(*args) ⇒ Object

Fetches the first one using SQL if possible.



80
81
82
83
84
85
86
87
 
# File 'lib/active_record/associations/association_collection.rb', line 80

def first(*args)
  if fetch_first_or_last_using_find?(args)
    find(:first, *args)
  else
    load_target unless loaded?
    @target.first(*args)
  end
end

#include?(record) ⇒ Boolean

Returns:

  • (Boolean) 


366
367
368
369
370
371
372
 
# File 'lib/active_record/associations/association_collection.rb', line 366

def include?(record)
  return false unless record.is_a?(@reflection.klass)
  return include_in_memory?(record) if record.new_record?
  load_target if @reflection.options[:finder_sql] && !loaded?
  return @target.include?(record) if loaded?
  exists?(record)
end

#last(*args) ⇒ Object

Fetches the last one using SQL if possible.



90
91
92
93
94
95
96
97
 
# File 'lib/active_record/associations/association_collection.rb', line 90

def last(*args)
  if fetch_first_or_last_using_find?(args)
    find(:last, *args)
  else
    load_target unless loaded?
    @target.last(*args)
  end
end

#length ⇒ Object

Returns the size of the collection calling size on the target.

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



313
314
315
 
# File 'lib/active_record/associations/association_collection.rb', line 313

def length
  load_target.size
end

#many? ⇒ Boolean

Returns true if the collection has more than 1 record. Equivalent to collection.size > 1.

Returns:

  • (Boolean) 


333
334
335
336
337
338
339
 
# File 'lib/active_record/associations/association_collection.rb', line 333

def many?
  if block_given?
    method_missing(:many?) { |*block_args| yield(*block_args) }
  else
    size > 1
  end
end

#proxy_respond_to?(method, include_private = false) ⇒ Boolean

Returns:

  • (Boolean) 


374
375
376
 
# File 'lib/active_record/associations/association_collection.rb', line 374

def proxy_respond_to?(method, include_private = false)
  super || @reflection.klass.respond_to?(method, include_private)
end

#replace(other_array) ⇒ Object

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



353
354
355
356
357
358
359
360
361
362
363
364
 
# File 'lib/active_record/associations/association_collection.rb', line 353

def replace(other_array)
  other_array.each { |val| raise_on_type_mismatch(val) }

  load_target
  other   = other_array.size < 100 ? other_array : other_array.to_set
  current = @target.size < 100 ? @target : @target.to_set

  transaction do
    delete(@target.select { |v| !other.include?(v) })
    concat(other_array.select { |v| !current.include?(v) })
  end
end

#reset ⇒ Object 



109
110
111
112
113
 
# File 'lib/active_record/associations/association_collection.rb', line 109

def reset
  reset_target!
  reset_named_scopes_cache!
  @loaded = false
end

#scoped ⇒ Object 



38
39
40
 
# File 'lib/active_record/associations/association_collection.rb', line 38

def scoped
  with_scope(construct_scope) { @reflection.klass.scoped }
end

#select(select = nil) ⇒ Object 



29
30
31
32
33
34
35
36
 
# File 'lib/active_record/associations/association_collection.rb', line 29

def select(select = nil)
  if block_given?
    load_target
    @target.select.each { |e| yield e }
  else
    scoped.select(select)
  end
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.



295
296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/active_record/associations/association_collection.rb', line 295

def size
  if @owner.new_record? || (loaded? && !@reflection.options[:uniq])
    @target.size
  elsif !loaded? && @reflection.options[:group]
    load_target.size
  elsif !loaded? && !@reflection.options[:uniq] && @target.is_a?(Array)
    unsaved_records = @target.select { |r| r.new_record? }
    unsaved_records.size + count_records
  else
    count_records
  end
end

#sum(*args) ⇒ Object

Calculate sum using SQL, not Enumerable



173
174
175
176
177
178
179
 
# File 'lib/active_record/associations/association_collection.rb', line 173

def sum(*args)
  if block_given?
    calculate(:sum, *args) { |*block_args| yield(*block_args) }
  else
    calculate(:sum, *args)
  end
end

#to_ary ⇒ Object Also known as: to_a 



99
100
101
102
103
104
105
106
 
# File 'lib/active_record/associations/association_collection.rb', line 99

def to_ary
  load_target
  if @target.is_a?(Array)
    @target.to_ary
  else
    Array.wrap(@target)
  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



156
157
158
159
160
 
# File 'lib/active_record/associations/association_collection.rb', line 156

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

#uniq(collection = self) ⇒ Object 



341
342
343
344
345
346
347
348
349
 
# File 'lib/active_record/associations/association_collection.rb', line 341

def uniq(collection = self)
  seen = Set.new
  collection.map do |record|
    unless seen.include?(record.id)
      seen << record.id
      record
    end
  end.compact
end