associations.rb 111.7 KB
Newer Older
1
require 'active_record/associations/association_proxy'
D
Initial  
David Heinemeier Hansson 已提交
2
require 'active_record/associations/association_collection'
3
require 'active_record/associations/belongs_to_association'
4
require 'active_record/associations/belongs_to_polymorphic_association'
5
require 'active_record/associations/has_one_association'
D
Initial  
David Heinemeier Hansson 已提交
6
require 'active_record/associations/has_many_association'
7
require 'active_record/associations/has_many_through_association'
D
Initial  
David Heinemeier Hansson 已提交
8
require 'active_record/associations/has_and_belongs_to_many_association'
9
require 'active_record/associations/has_one_through_association'
D
Initial  
David Heinemeier Hansson 已提交
10 11

module ActiveRecord
D
David Heinemeier Hansson 已提交
12
  class HasManyThroughAssociationNotFoundError < ActiveRecordError #:nodoc:
13 14
    def initialize(owner_class_name, reflection)
      super("Could not find the association #{reflection.options[:through].inspect} in model #{owner_class_name}")
15 16 17
    end
  end

D
David Heinemeier Hansson 已提交
18
  class HasManyThroughAssociationPolymorphicError < ActiveRecordError #:nodoc:
19
    def initialize(owner_class_name, reflection, source_reflection)
20
      super("Cannot have a has_many :through association '#{owner_class_name}##{reflection.name}' on the polymorphic object '#{source_reflection.class_name}##{source_reflection.name}'.")
21 22
    end
  end
23

24 25 26 27 28
  class HasManyThroughAssociationPointlessSourceTypeError < ActiveRecordError #:nodoc:
    def initialize(owner_class_name, reflection, source_reflection)
      super("Cannot have a has_many :through association '#{owner_class_name}##{reflection.name}' with a :source_type option if the '#{reflection.through_reflection.class_name}##{source_reflection.name}' is not polymorphic.  Try removing :source_type on your association.")
    end
  end
29

D
David Heinemeier Hansson 已提交
30
  class HasManyThroughSourceAssociationNotFoundError < ActiveRecordError #:nodoc:
31
    def initialize(reflection)
32 33 34 35
      through_reflection      = reflection.through_reflection
      source_reflection_names = reflection.source_reflection_names
      source_associations     = reflection.through_reflection.klass.reflect_on_all_associations.collect { |a| a.name.inspect }
      super("Could not find the source association(s) #{source_reflection_names.collect(&:inspect).to_sentence :connector => 'or'} in model #{through_reflection.klass}.  Try 'has_many #{reflection.name.inspect}, :through => #{through_reflection.name.inspect}, :source => <name>'.  Is it one of #{source_associations.to_sentence :connector => 'or'}?")
36 37 38
    end
  end

39
  class HasManyThroughSourceAssociationMacroError < ActiveRecordError #:nodoc:
40
    def initialize(reflection)
41 42 43
      through_reflection = reflection.through_reflection
      source_reflection  = reflection.source_reflection
      super("Invalid source reflection macro :#{source_reflection.macro}#{" :through" if source_reflection.options[:through]} for has_many #{reflection.name.inspect}, :through => #{through_reflection.name.inspect}.  Use :source to specify the source reflection.")
44 45 46
    end
  end

47 48 49 50 51
  class HasManyThroughCantAssociateThroughHasManyReflection < ActiveRecordError #:nodoc:
    def initialize(owner, reflection)
      super("Cannot modify association '#{owner.class.name}##{reflection.name}' because the source reflection class '#{reflection.source_reflection.class_name}' is associated to '#{reflection.through_reflection.class_name}' via :#{reflection.source_reflection.macro}.")
    end
  end
52 53 54 55 56 57
  class HasManyThroughCantAssociateNewRecords < ActiveRecordError #:nodoc:
    def initialize(owner, reflection)
      super("Cannot associate new records through '#{owner.class.name}##{reflection.name}' on '#{reflection.source_reflection.class_name rescue nil}##{reflection.source_reflection.name rescue nil}'. Both records must have an id in order to create the has_many :through record associating them.")
    end
  end

58 59 60 61 62 63
  class HasManyThroughCantDissociateNewRecords < ActiveRecordError #:nodoc:
    def initialize(owner, reflection)
      super("Cannot dissociate new records through '#{owner.class.name}##{reflection.name}' on '#{reflection.source_reflection.class_name rescue nil}##{reflection.source_reflection.name rescue nil}'. Both records must have an id in order to delete the has_many :through record associating them.")
    end
  end

D
David Heinemeier Hansson 已提交
64
  class EagerLoadPolymorphicError < ActiveRecordError #:nodoc:
65
    def initialize(reflection)
66
      super("Can not eagerly load the polymorphic association #{reflection.name.inspect}")
67 68 69
    end
  end

70 71
  class ReadOnlyAssociation < ActiveRecordError #:nodoc:
    def initialize(reflection)
72
      super("Can not add to a has_many :through association.  Try adding to #{reflection.through_reflection.name.inspect}.")
73 74 75
    end
  end

P
Pratik Naik 已提交
76
  # See ActiveRecord::Associations::ClassMethods for documentation.
D
Initial  
David Heinemeier Hansson 已提交
77
  module Associations # :nodoc:
78
    def self.included(base)
79 80 81
      base.extend(ClassMethods)
    end

82
    # Clears out the association cache
83 84 85
    def clear_association_cache #:nodoc:
      self.class.reflect_on_all_associations.to_a.each do |assoc|
        instance_variable_set "@#{assoc.name}", nil
86
      end unless self.new_record?
87
    end
88 89 90 91

    # Associations are a set of macro-like class methods for tying objects together through foreign keys. They express relationships like
    # "Project has one Project Manager" or "Project belongs to a Portfolio". Each macro adds a number of methods to the class which are
    # specialized according to the collection or association symbol and the options hash. It works much the same way as Ruby's own <tt>attr*</tt>
D
Initial  
David Heinemeier Hansson 已提交
92 93 94 95
    # methods. Example:
    #
    #   class Project < ActiveRecord::Base
    #     belongs_to              :portfolio
96
    #     has_one                 :project_manager
D
Initial  
David Heinemeier Hansson 已提交
97 98 99 100 101
    #     has_many                :milestones
    #     has_and_belongs_to_many :categories
    #   end
    #
    # The project class now has the following methods (and more) to ease the traversal and manipulation of its relationships:
102
    # * <tt>Project#portfolio, Project#portfolio=(portfolio), Project#portfolio.nil?</tt>
D
Initial  
David Heinemeier Hansson 已提交
103 104
    # * <tt>Project#project_manager, Project#project_manager=(project_manager), Project#project_manager.nil?,</tt>
    # * <tt>Project#milestones.empty?, Project#milestones.size, Project#milestones, Project#milestones<<(milestone),</tt>
105
    #   <tt>Project#milestones.delete(milestone), Project#milestones.find(milestone_id), Project#milestones.find(:all, options),</tt>
D
Initial  
David Heinemeier Hansson 已提交
106 107 108 109
    #   <tt>Project#milestones.build, Project#milestones.create</tt>
    # * <tt>Project#categories.empty?, Project#categories.size, Project#categories, Project#categories<<(category1),</tt>
    #   <tt>Project#categories.delete(category1)</tt>
    #
110 111 112 113
    # === A word of warning
    #
    # Don't create associations that have the same name as instance methods of ActiveRecord::Base. Since the association
    # adds a method with that name to its model, it will override the inherited method and break things.
P
Pratik Naik 已提交
114
    # For instance, +attributes+ and +connection+ would be bad choices for association names.
115
    #
116
    # == Auto-generated methods
D
Initial  
David Heinemeier Hansson 已提交
117
    #
118
    # === Singular associations (one-to-one)
119 120 121 122 123 124 125 126
    #                                     |            |  belongs_to  |
    #   generated methods                 | belongs_to | :polymorphic | has_one
    #   ----------------------------------+------------+--------------+---------
    #   #other                            |     X      |      X       |    X
    #   #other=(other)                    |     X      |      X       |    X
    #   #build_other(attributes={})       |     X      |              |    X
    #   #create_other(attributes={})      |     X      |              |    X
    #   #other.create!(attributes={})     |            |              |    X
127
    #   #other.nil?                       |     X      |      X       |
128 129 130
    #
    # ===Collection associations (one-to-many / many-to-many)
    #                                     |       |          | has_many
131
    #   generated methods                 | habtm | has_many | :through
132 133
    #   ----------------------------------+-------+----------+----------
    #   #others                           |   X   |    X     |    X
134
    #   #others=(other,other,...)         |   X   |    X     |    X
135
    #   #other_ids                        |   X   |    X     |    X
136
    #   #other_ids=(id,id,...)            |   X   |    X     |    X
137 138 139
    #   #others<<                         |   X   |    X     |    X
    #   #others.push                      |   X   |    X     |    X
    #   #others.concat                    |   X   |    X     |    X
140 141
    #   #others.build(attributes={})      |   X   |    X     |    X
    #   #others.create(attributes={})     |   X   |    X     |    X
142
    #   #others.create!(attributes={})    |   X   |    X     |    X
143 144
    #   #others.size                      |   X   |    X     |    X
    #   #others.length                    |   X   |    X     |    X
P
Pratik Naik 已提交
145
    #   #others.count                     |   X   |    X     |    X
146
    #   #others.sum(args*,&block)         |   X   |    X     |    X
147
    #   #others.empty?                    |   X   |    X     |    X
148
    #   #others.clear                     |   X   |    X     |    X
149
    #   #others.delete(other,other,...)   |   X   |    X     |    X
150
    #   #others.delete_all                |   X   |    X     |
151
    #   #others.destroy_all               |   X   |    X     |    X
152
    #   #others.find(*args)               |   X   |    X     |    X
153
    #   #others.find_first                |   X   |          |
P
Pratik Naik 已提交
154
    #   #others.exist?                    |   X   |    X     |    X
155
    #   #others.uniq                      |   X   |    X     |    X
156
    #   #others.reset                     |   X   |    X     |    X
D
Initial  
David Heinemeier Hansson 已提交
157
    #
158
    # == Cardinality and associations
159
    #
P
Pratik Naik 已提交
160
    # Active Record associations can be used to describe one-to-one, one-to-many and many-to-many
P
Pratik Naik 已提交
161 162
    # relationships between models. Each model uses an association to describe its role in
    # the relation. The +belongs_to+ association is always used in the model that has
163
    # the foreign key.
164 165 166
    #
    # === One-to-one
    #
167
    # Use +has_one+ in the base, and +belongs_to+ in the associated model.
168 169 170 171 172 173 174 175 176 177
    #
    #   class Employee < ActiveRecord::Base
    #     has_one :office
    #   end
    #   class Office < ActiveRecord::Base
    #     belongs_to :employee    # foreign key - employee_id
    #   end
    #
    # === One-to-many
    #
178
    # Use +has_many+ in the base, and +belongs_to+ in the associated model.
179 180 181 182 183
    #
    #   class Manager < ActiveRecord::Base
    #     has_many :employees
    #   end
    #   class Employee < ActiveRecord::Base
184
    #     belongs_to :manager     # foreign key - manager_id
185 186 187 188 189 190
    #   end
    #
    # === Many-to-many
    #
    # There are two ways to build a many-to-many relationship.
    #
191
    # The first way uses a +has_many+ association with the <tt>:through</tt> option and a join model, so
192 193 194 195 196 197 198 199 200 201 202 203 204 205 206
    # there are two stages of associations.
    #
    #   class Assignment < ActiveRecord::Base
    #     belongs_to :programmer  # foreign key - programmer_id
    #     belongs_to :project     # foreign key - project_id
    #   end
    #   class Programmer < ActiveRecord::Base
    #     has_many :assignments
    #     has_many :projects, :through => :assignments
    #   end
    #   class Project < ActiveRecord::Base
    #     has_many :assignments
    #     has_many :programmers, :through => :assignments
    #   end
    #
207
    # For the second way, use +has_and_belongs_to_many+ in both models. This requires a join table
208 209 210 211 212 213 214 215 216
    # that has no corresponding model or primary key.
    #
    #   class Programmer < ActiveRecord::Base
    #     has_and_belongs_to_many :projects       # foreign keys in the join table
    #   end
    #   class Project < ActiveRecord::Base
    #     has_and_belongs_to_many :programmers    # foreign keys in the join table
    #   end
    #
217
    # Choosing which way to build a many-to-many relationship is not always simple.
218
    # If you need to work with the relationship model as its own entity,
219
    # use <tt>has_many :through</tt>. Use +has_and_belongs_to_many+ when working with legacy schemas or when
220 221
    # you never work directly with the relationship itself.
    #
222
    # == Is it a +belongs_to+ or +has_one+ association?
D
Initial  
David Heinemeier Hansson 已提交
223
    #
224 225
    # Both express a 1-1 relationship. The difference is mostly where to place the foreign key, which goes on the table for the class
    # declaring the +belongs_to+ relationship. Example:
D
Initial  
David Heinemeier Hansson 已提交
226
    #
227 228 229
    #   class User < ActiveRecord::Base
    #     # I reference an account.
    #     belongs_to :account
D
Initial  
David Heinemeier Hansson 已提交
230 231
    #   end
    #
232 233 234
    #   class Account < ActiveRecord::Base
    #     # One user references me.
    #     has_one :user
D
Initial  
David Heinemeier Hansson 已提交
235 236 237 238
    #   end
    #
    # The tables for these classes could look something like:
    #
239
    #   CREATE TABLE users (
D
Initial  
David Heinemeier Hansson 已提交
240
    #     id int(11) NOT NULL auto_increment,
241 242
    #     account_id int(11) default NULL,
    #     name varchar default NULL,
D
Initial  
David Heinemeier Hansson 已提交
243 244 245
    #     PRIMARY KEY  (id)
    #   )
    #
246
    #   CREATE TABLE accounts (
D
Initial  
David Heinemeier Hansson 已提交
247 248 249 250 251
    #     id int(11) NOT NULL auto_increment,
    #     name varchar default NULL,
    #     PRIMARY KEY  (id)
    #   )
    #
252 253
    # == Unsaved objects and associations
    #
254
    # You can manipulate objects and associations before they are saved to the database, but there is some special behavior you should be
255 256 257 258
    # aware of, mostly involving the saving of associated objects.
    #
    # === One-to-one associations
    #
259 260 261
    # * Assigning an object to a +has_one+ association automatically saves that object and the object being replaced (if there is one), in
    #   order to update their primary keys - except if the parent object is unsaved (<tt>new_record? == true</tt>).
    # * If either of these saves fail (due to one of the objects being invalid) the assignment statement returns +false+ and the assignment
262
    #   is cancelled.
P
Pratik Naik 已提交
263
    # * If you wish to assign an object to a +has_one+ association without saving it, use the <tt>association.build</tt> method (documented below).
264
    # * Assigning an object to a +belongs_to+ association does not save the object, since the foreign key field belongs on the parent. It
265
    #   does not save the parent either.
266 267 268
    #
    # === Collections
    #
269
    # * Adding an object to a collection (+has_many+ or +has_and_belongs_to_many+) automatically saves that object, except if the parent object
270
    #   (the owner of the collection) is not yet stored in the database.
P
Pratik Naik 已提交
271 272
    # * If saving any of the objects being added to a collection (via <tt>push</tt> or similar) fails, then <tt>push</tt> returns +false+.
    # * You can add an object to a collection without automatically saving it by using the <tt>collection.build</tt> method (documented below).
273
    # * All unsaved (<tt>new_record? == true</tt>) members of the collection are automatically saved when the parent is saved.
274
    #
275
    # === Association callbacks
276
    #
277
    # Similar to the normal callbacks that hook into the lifecycle of an Active Record object, you can also define callbacks that get
278
    # triggered when you add an object to or remove an object from an association collection. Example:
279 280 281 282 283 284 285
    #
    #   class Project
    #     has_and_belongs_to_many :developers, :after_add => :evaluate_velocity
    #
    #     def evaluate_velocity(developer)
    #       ...
    #     end
286
    #   end
287 288
    #
    # It's possible to stack callbacks by passing them as an array. Example:
289
    #
290
    #   class Project
291
    #     has_and_belongs_to_many :developers, :after_add => [:evaluate_velocity, Proc.new { |p, d| p.shipping_date = Time.now}]
292 293
    #   end
    #
294
    # Possible callbacks are: +before_add+, +after_add+, +before_remove+ and +after_remove+.
295
    #
296 297
    # Should any of the +before_add+ callbacks throw an exception, the object does not get added to the collection. Same with
    # the +before_remove+ callbacks; if an exception is thrown the object doesn't get removed.
298
    #
299 300
    # === Association extensions
    #
301
    # The proxy objects that control the access to associations can be extended through anonymous modules. This is especially
302
    # beneficial for adding new finders, creators, and other factory-type methods that are only used as part of this association.
303 304 305
    # Example:
    #
    #   class Account < ActiveRecord::Base
306
    #     has_many :people do
307
    #       def find_or_create_by_name(name)
308
    #         first_name, last_name = name.split(" ", 2)
D
David Heinemeier Hansson 已提交
309
    #         find_or_create_by_first_name_and_last_name(first_name, last_name)
310
    #       end
311
    #     end
312 313 314 315 316 317
    #   end
    #
    #   person = Account.find(:first).people.find_or_create_by_name("David Heinemeier Hansson")
    #   person.first_name # => "David"
    #   person.last_name  # => "Heinemeier Hansson"
    #
318 319 320 321
    # If you need to share the same extensions between many associations, you can use a named extension module. Example:
    #
    #   module FindOrCreateByNameExtension
    #     def find_or_create_by_name(name)
322
    #       first_name, last_name = name.split(" ", 2)
D
David Heinemeier Hansson 已提交
323
    #       find_or_create_by_first_name_and_last_name(first_name, last_name)
324 325 326 327 328 329 330 331 332 333
    #     end
    #   end
    #
    #   class Account < ActiveRecord::Base
    #     has_many :people, :extend => FindOrCreateByNameExtension
    #   end
    #
    #   class Company < ActiveRecord::Base
    #     has_many :people, :extend => FindOrCreateByNameExtension
    #   end
334
    #
335
    # If you need to use multiple named extension modules, you can specify an array of modules with the <tt>:extend</tt> option.
336 337 338 339 340 341 342
    # In the case of name conflicts between methods in the modules, methods in modules later in the array supercede
    # those earlier in the array. Example:
    #
    #   class Account < ActiveRecord::Base
    #     has_many :people, :extend => [FindOrCreateByNameExtension, FindRecentExtension]
    #   end
    #
343 344
    # Some extensions can only be made to work with knowledge of the association proxy's internals.
    # Extensions can access relevant state using accessors on the association proxy:
345
    #
346 347
    # * +proxy_owner+ - Returns the object the association is part of.
    # * +proxy_reflection+ - Returns the reflection object that describes the association.
348
    # * +proxy_target+ - Returns the associated object for +belongs_to+ and +has_one+, or the collection of associated objects for +has_many+ and +has_and_belongs_to_many+.
349
    #
R
Rick Olson 已提交
350
    # === Association Join Models
351
    #
352 353
    # Has Many associations can be configured with the <tt>:through</tt> option to use an explicit join model to retrieve the data.  This
    # operates similarly to a +has_and_belongs_to_many+ association.  The advantage is that you're able to add validations,
354
    # callbacks, and extra attributes on the join model.  Consider the following schema:
355
    #
356 357 358 359
    #   class Author < ActiveRecord::Base
    #     has_many :authorships
    #     has_many :books, :through => :authorships
    #   end
360
    #
361 362 363 364
    #   class Authorship < ActiveRecord::Base
    #     belongs_to :author
    #     belongs_to :book
    #   end
365
    #
366 367 368
    #   @author = Author.find :first
    #   @author.authorships.collect { |a| a.book } # selects all books that the author's authorships belong to.
    #   @author.books                              # selects all books by using the Authorship join model
369
    #
370
    # You can also go through a +has_many+ association on the join model:
371
    #
372 373 374 375
    #   class Firm < ActiveRecord::Base
    #     has_many   :clients
    #     has_many   :invoices, :through => :clients
    #   end
376
    #
377 378 379 380
    #   class Client < ActiveRecord::Base
    #     belongs_to :firm
    #     has_many   :invoices
    #   end
381
    #
382 383 384 385 386 387 388 389
    #   class Invoice < ActiveRecord::Base
    #     belongs_to :client
    #   end
    #
    #   @firm = Firm.find :first
    #   @firm.clients.collect { |c| c.invoices }.flatten # select all invoices for all clients of the firm
    #   @firm.invoices                                   # selects all invoices by going through the Client join model.
    #
R
Rick Olson 已提交
390
    # === Polymorphic Associations
391 392
    #
    # Polymorphic associations on models are not restricted on what types of models they can be associated with.  Rather, they
393
    # specify an interface that a +has_many+ association must adhere to.
394
    #
R
Rick Olson 已提交
395 396 397
    #   class Asset < ActiveRecord::Base
    #     belongs_to :attachable, :polymorphic => true
    #   end
398
    #
R
Rick Olson 已提交
399
    #   class Post < ActiveRecord::Base
400
    #     has_many :assets, :as => :attachable         # The :as option specifies the polymorphic interface to use.
R
Rick Olson 已提交
401 402 403
    #   end
    #
    #   @asset.attachable = @post
404
    #
R
Rick Olson 已提交
405
    # This works by using a type column in addition to a foreign key to specify the associated record.  In the Asset example, you'd need
406
    # an +attachable_id+ integer column and an +attachable_type+ string column.
R
Rick Olson 已提交
407
    #
D
David Heinemeier Hansson 已提交
408
    # Using polymorphic associations in combination with single table inheritance (STI) is a little tricky. In order
409
    # for the associations to work as expected, ensure that you store the base model for the STI models in the
D
David Heinemeier Hansson 已提交
410
    # type column of the polymorphic association. To continue with the asset example above, suppose there are guest posts
411
    # and member posts that use the posts table for STI. In this case, there must be a +type+ column in the posts table.
D
David Heinemeier Hansson 已提交
412 413 414
    #
    #   class Asset < ActiveRecord::Base
    #     belongs_to :attachable, :polymorphic => true
415
    #
D
David Heinemeier Hansson 已提交
416 417 418 419
    #     def attachable_type=(sType)
    #        super(sType.to_s.classify.constantize.base_class.to_s)
    #     end
    #   end
420
    #
D
David Heinemeier Hansson 已提交
421 422 423 424 425
    #   class Post < ActiveRecord::Base
    #     # because we store "Post" in attachable_type now :dependent => :destroy will work
    #     has_many :assets, :as => :attachable, :dependent => :destroy
    #   end
    #
426
    #   class GuestPost < Post
D
David Heinemeier Hansson 已提交
427 428
    #   end
    #
429
    #   class MemberPost < Post
D
David Heinemeier Hansson 已提交
430 431
    #   end
    #
D
Initial  
David Heinemeier Hansson 已提交
432 433 434
    # == Caching
    #
    # All of the methods are built on a simple caching principle that will keep the result of the last query around unless specifically
435
    # instructed not to. The cache is even shared across methods to make it even cheaper to use the macro-added methods without
D
Initial  
David Heinemeier Hansson 已提交
436 437 438 439 440 441 442 443
    # worrying too much about performance at the first go. Example:
    #
    #   project.milestones             # fetches milestones from the database
    #   project.milestones.size        # uses the milestone cache
    #   project.milestones.empty?      # uses the milestone cache
    #   project.milestones(true).size  # fetches milestones from the database
    #   project.milestones             # uses the milestone cache
    #
444 445
    # == Eager loading of associations
    #
P
Pratik Naik 已提交
446
    # Eager loading is a way to find objects of a certain class and a number of named associations. This is
447
    # one of the easiest ways of to prevent the dreaded 1+N problem in which fetching 100 posts that each need to display their author
P
Pratik Naik 已提交
448
    # triggers 101 database queries. Through the use of eager loading, the 101 queries can be reduced to 2. Example:
449 450 451 452 453 454 455 456
    #
    #   class Post < ActiveRecord::Base
    #     belongs_to :author
    #     has_many   :comments
    #   end
    #
    # Consider the following loop using the class above:
    #
P
Pratik Naik 已提交
457
    #   for post in Post.all
458 459 460
    #     puts "Post:            " + post.title
    #     puts "Written by:      " + post.author.name
    #     puts "Last comment on: " + post.comments.first.created_on
461
    #   end
462 463 464
    #
    # To iterate over these one hundred posts, we'll generate 201 database queries. Let's first just optimize it for retrieving the author:
    #
465
    #   for post in Post.find(:all, :include => :author)
466
    #
P
Pratik Naik 已提交
467 468
    # This references the name of the +belongs_to+ association that also used the <tt>:author</tt> symbol. After loading the posts, find
    # will collect the +author_id+ from each one and load all the referenced authors with one query. Doing so will cut down the number of queries from 201 to 102.
469 470 471
    #
    # We can improve upon the situation further by referencing both associations in the finder with:
    #
472
    #   for post in Post.find(:all, :include => [ :author, :comments ])
473
    #
P
Pratik Naik 已提交
474 475
    # This will load all comments with a single query. This reduces the total number of queries to 3. More generally the number of queries
    # will be 1 plus the number of associations named (except if some of the associations are polymorphic +belongs_to+ - see below).
476
    #
477
    # To include a deep hierarchy of associations, use a hash:
478 479 480 481 482 483 484
    #
    #   for post in Post.find(:all, :include => [ :author, { :comments => { :author => :gravatar } } ])
    #
    # That'll grab not only all the comments but all their authors and gravatar pictures.  You can mix and match
    # symbols, arrays and hashes in any combination to describe the associations you want to load.
    #
    # All of this power shouldn't fool you into thinking that you can pull out huge amounts of data with no performance penalty just because you've reduced
D
David Heinemeier Hansson 已提交
485 486
    # the number of queries. The database still needs to send all the data to Active Record and it still needs to be processed. So it's no
    # catch-all for performance problems, but it's a great way to cut down on the number of queries in a situation as the one described above.
487
    #
P
Pratik Naik 已提交
488 489 490 491
    # Since only one table is loaded at a time, conditions or orders cannot reference tables other than the main one. If this is the case
    # Active Record falls back to the previously used LEFT OUTER JOIN based strategy. For example
    #  
    #   Post.find(:all, :include => [ :author, :comments ], :conditions => ['comments.approved = ?', true])
492
    #
P
Pratik Naik 已提交
493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508
    # will result in a single SQL query with joins along the lines of: <tt>LEFT OUTER JOIN comments ON comments.post_id = posts.id</tt> and
    # <tt>LEFT OUTER JOIN authors ON authors.id = posts.author_id</tt>. Note that using conditions like this can have unintended consequences.
    # In the above example posts with no approved comments are not returned at all, because the conditions apply to the SQL statement as a whole
    # and not just to the association. You must disambiguate column references for this fallback to happen, for example
    # <tt>:order => "author.name DESC"</tt> will work but <tt>:order => "name DESC"</tt> will not. 
    #
    # If you do want eagerload only some members of an association it is usually more natural to <tt>:include</tt> an association
    # which has conditions defined on it:
    #
    #   class Post < ActiveRecord::Base
    #     has_many :approved_comments, :class_name => 'Comment', :conditions => ['approved = ?', true]
    #   end
    #
    #   Post.find(:all, :include => :approved_comments)
    #
    # will load posts and eager load the +approved_comments+ association, which contains only those comments that have been approved.
509
    #
510 511
    # When eager loaded, conditions are interpolated in the context of the model class, not the model instance.  Conditions are lazily interpolated
    # before the actual model exists.
512
    #
P
Pratik Naik 已提交
513
    # Eager loading is supported with polymorphic associations.
514 515 516 517 518
    #
    #   class Address < ActiveRecord::Base
    #     belongs_to :addressable, :polymorphic => true
    #   end
    #
P
Pratik Naik 已提交
519
    # A call that tries to eager load the addressable model
520
    #
P
Pratik Naik 已提交
521
    #   Address.find(:all, :include => :addressable)
522
    #
P
Pratik Naik 已提交
523 524 525 526 527
    # will execute one query to load the addresses and load the addressables with one query per addressable type. 
    # For example if all the addressables are either of class Person or Company then a total of 3 queries will be executed. The list of
    # addressable types to load is determined on the back of the addresses loaded. This is not supported if Active Record has to fallback
    # to the previous implementation of eager loading and will raise ActiveRecord::EagerLoadPolymorphicError. The reason is that the parent 
    # model's type is a column value so its corresponding table name cannot be put in the +FROM+/+JOIN+ clauses of that query.
528
    #
529 530
    # == Table Aliasing
    #
P
Pratik Naik 已提交
531
    # Active Record uses table aliasing in the case that a table is referenced multiple times in a join.  If a table is referenced only once,
532
    # the standard table name is used.  The second time, the table is aliased as <tt>#{reflection_name}_#{parent_table_name}</tt>.  Indexes are appended
533
    # for any more successive uses of the table name.
534
    #
P
Pratik Naik 已提交
535 536 537 538 539 540
    #   Post.find :all, :joins => :comments
    #   # => SELECT ... FROM posts INNER JOIN comments ON ...
    #   Post.find :all, :joins => :special_comments # STI
    #   # => SELECT ... FROM posts INNER JOIN comments ON ... AND comments.type = 'SpecialComment'
    #   Post.find :all, :joins => [:comments, :special_comments] # special_comments is the reflection name, posts is the parent table name
    #   # => SELECT ... FROM posts INNER JOIN comments ON ... INNER JOIN comments special_comments_posts
541
    #
542
    # Acts as tree example:
543
    #
P
Pratik Naik 已提交
544 545 546 547 548 549 550 551 552
    #   TreeMixin.find :all, :joins => :children
    #   # => SELECT ... FROM mixins INNER JOIN mixins childrens_mixins ...
    #   TreeMixin.find :all, :joins => {:children => :parent}
    #   # => SELECT ... FROM mixins INNER JOIN mixins childrens_mixins ...
    #                               INNER JOIN parents_mixins ...
    #   TreeMixin.find :all, :joins => {:children => {:parent => :children}}
    #   # => SELECT ... FROM mixins INNER JOIN mixins childrens_mixins ...
    #                               INNER JOIN parents_mixins ...
    #                               INNER JOIN mixins childrens_mixins_2
553
    #
554
    # Has and Belongs to Many join tables use the same idea, but add a <tt>_join</tt> suffix:
555
    #
P
Pratik Naik 已提交
556 557 558 559 560 561 562 563 564
    #   Post.find :all, :joins => :categories
    #   # => SELECT ... FROM posts INNER JOIN categories_posts ... INNER JOIN categories ...
    #   Post.find :all, :joins => {:categories => :posts}
    #   # => SELECT ... FROM posts INNER JOIN categories_posts ... INNER JOIN categories ...
    #                              INNER JOIN categories_posts posts_categories_join INNER JOIN posts posts_categories
    #   Post.find :all, :joins => {:categories => {:posts => :categories}}
    #   # => SELECT ... FROM posts INNER JOIN categories_posts ... INNER JOIN categories ...
    #                              INNER JOIN categories_posts posts_categories_join INNER JOIN posts posts_categories
    #                              INNER JOIN categories_posts categories_posts_join INNER JOIN categories categories_posts_2
565
    #
566
    # If you wish to specify your own custom joins using a <tt>:joins</tt> option, those table names will take precedence over the eager associations:
567
    #
P
Pratik Naik 已提交
568 569 570 571 572
    #   Post.find :all, :joins => :comments, :joins => "inner join comments ..."
    #   # => SELECT ... FROM posts INNER JOIN comments_posts ON ... INNER JOIN comments ...
    #   Post.find :all, :joins => [:comments, :special_comments], :joins => "inner join comments ..."
    #   # => SELECT ... FROM posts INNER JOIN comments comments_posts ON ...
    #                              INNER JOIN comments special_comments_posts ...
573
    #                              INNER JOIN comments ...
574
    #
575
    # Table aliases are automatically truncated according to the maximum length of table identifiers according to the specific database.
576
    #
D
Initial  
David Heinemeier Hansson 已提交
577 578 579 580 581 582 583 584 585 586
    # == Modules
    #
    # By default, associations will look for objects within the current module scope. Consider:
    #
    #   module MyApplication
    #     module Business
    #       class Firm < ActiveRecord::Base
    #          has_many :clients
    #        end
    #
P
Pratik Naik 已提交
587
    #       class Client < ActiveRecord::Base; end
D
Initial  
David Heinemeier Hansson 已提交
588 589 590
    #     end
    #   end
    #
P
Pratik Naik 已提交
591 592 593
    # When <tt>Firm#clients</tt> is called, it will in turn call <tt>MyApplication::Business::Client.find_all_by_firm_id(firm.id)</tt>.
    # If you want to associate with a class in another module scope, this can be done by specifying the complete class name.
    # Example:
D
Initial  
David Heinemeier Hansson 已提交
594 595 596 597 598 599 600 601 602 603 604 605 606
    #
    #   module MyApplication
    #     module Business
    #       class Firm < ActiveRecord::Base; end
    #     end
    #
    #     module Billing
    #       class Account < ActiveRecord::Base
    #         belongs_to :firm, :class_name => "MyApplication::Business::Firm"
    #       end
    #     end
    #   end
    #
607
    # == Type safety with <tt>ActiveRecord::AssociationTypeMismatch</tt>
D
Initial  
David Heinemeier Hansson 已提交
608 609
    #
    # If you attempt to assign an object to an association that doesn't match the inferred or specified <tt>:class_name</tt>, you'll
610
    # get an <tt>ActiveRecord::AssociationTypeMismatch</tt>.
D
Initial  
David Heinemeier Hansson 已提交
611 612 613
    #
    # == Options
    #
614
    # All of the association macros can be specialized through options. This makes cases more complex than the simple and guessable ones
D
Initial  
David Heinemeier Hansson 已提交
615 616
    # possible.
    module ClassMethods
P
Pratik Naik 已提交
617 618 619 620 621
      # Specifies a one-to-many association. The following methods for retrieval and query of
      # collections of associated objects will be added:
      #
      # [collection(force_reload = false)]
      #   Returns an array of all the associated objects.
D
Initial  
David Heinemeier Hansson 已提交
622
      #   An empty array is returned if none are found.
P
Pratik Naik 已提交
623 624 625 626
      # [collection<<(object, ...)]
      #   Adds one or more objects to the collection by setting their foreign keys to the collection's primary key.
      # [collection.delete(object, ...)]
      #   Removes one or more objects from the collection by setting their foreign keys to +NULL+.
627
      #   This will also destroy the objects if they're declared as +belongs_to+ and dependent on this model.
P
Pratik Naik 已提交
628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661
      # [collection=objects]
      #   Replaces the collections content by deleting and adding objects as appropriate.
      # [collection_singular_ids]
      #   Returns an array of the associated objects' ids
      # [collection_singular_ids=ids]
      #   Replace the collection with the objects identified by the primary keys in +ids+
      # [collection.clear]
      #   Removes every object from the collection. This destroys the associated objects if they
      #   are associated with <tt>:dependent => :destroy</tt>, deletes them directly from the
      #   database if <tt>:dependent => :delete_all</tt>, otherwise sets their foreign keys to +NULL+.
      # [collection.empty?]
      #   Returns +true+ if there are no associated objects.
      # [collection.size]
      #   Returns the number of associated objects.
      # [collection.find(...)]
      #   Finds an associated object according to the same rules as ActiveRecord::Base.find.
      # [collection.exist?(...)]
      #   Checks whether an associated object with the given conditions exists.
      #   Uses the same rules as ActiveRecord::Base.exists?.
      # [collection.build(attributes = {}, ...)]
      #   Returns one or more new objects of the collection type that have been instantiated
      #   with +attributes+ and linked to this object through a foreign key, but have not yet
      #   been saved. <b>Note:</b> This only works if an associated object already exists, not if
      #   it's +nil+!
      # [collection.create(attributes = {})]
      #   Returns a new object of the collection type that has been instantiated
      #   with +attributes+, linked to this object through a foreign key, and that has already
      #   been saved (if it passed the validation). <b>Note:</b> This only works if an associated
      #   object already exists, not if it's +nil+!
      #
      # (*Note*: +collection+ is replaced with the symbol passed as the first argument, so
      # <tt>has_many :clients</tt> would add among others <tt>clients.empty?</tt>.)
      #
      # === Example
D
Initial  
David Heinemeier Hansson 已提交
662
      #
P
Pratik Naik 已提交
663 664
      # Example: A Firm class declares <tt>has_many :clients</tt>, which will add:
      # * <tt>Firm#clients</tt> (similar to <tt>Clients.find :all, :conditions => ["firm_id = ?", id]</tt>)
D
Initial  
David Heinemeier Hansson 已提交
665 666
      # * <tt>Firm#clients<<</tt>
      # * <tt>Firm#clients.delete</tt>
667
      # * <tt>Firm#clients=</tt>
668
      # * <tt>Firm#client_ids</tt>
669
      # * <tt>Firm#client_ids=</tt>
D
Initial  
David Heinemeier Hansson 已提交
670 671 672
      # * <tt>Firm#clients.clear</tt>
      # * <tt>Firm#clients.empty?</tt> (similar to <tt>firm.clients.size == 0</tt>)
      # * <tt>Firm#clients.size</tt> (similar to <tt>Client.count "firm_id = #{id}"</tt>)
673
      # * <tt>Firm#clients.find</tt> (similar to <tt>Client.find(id, :conditions => "firm_id = #{id}")</tt>)
P
Pratik Naik 已提交
674
      # * <tt>Firm#clients.exist?(:name => 'ACME')</tt> (similar to <tt>Client.exist?(:name => 'ACME', :firm_id => firm.id)</tt>)
D
Initial  
David Heinemeier Hansson 已提交
675
      # * <tt>Firm#clients.build</tt> (similar to <tt>Client.new("firm_id" => id)</tt>)
D
David Heinemeier Hansson 已提交
676
      # * <tt>Firm#clients.create</tt> (similar to <tt>c = Client.new("firm_id" => id); c.save; c</tt>)
D
Initial  
David Heinemeier Hansson 已提交
677
      # The declaration can also include an options hash to specialize the behavior of the association.
678
      #
P
Pratik Naik 已提交
679 680 681
      # === Supported options
      # [:class_name]
      #   Specify the class name of the association. Use it only if that name can't be inferred
P
Pratik Naik 已提交
682 683
      #   from the association name. So <tt>has_many :products</tt> will by default be linked to the Product class, but
      #   if the real class name is SpecialProduct, you'll have to specify it with this option.
P
Pratik Naik 已提交
684 685
      # [:conditions]
      #   Specify the conditions that the associated objects must meet in order to be included as a +WHERE+
686 687 688
      #   SQL fragment, such as <tt>price > 5 AND name LIKE 'B%'</tt>.  Record creations from the association are scoped if a hash
      #   is used.  <tt>has_many :posts, :conditions => {:published => true}</tt> will create published posts with <tt>@blog.posts.create</tt>
      #   or <tt>@blog.posts.build</tt>.
P
Pratik Naik 已提交
689 690
      # [:order]
      #   Specify the order in which the associated objects are returned as an <tt>ORDER BY</tt> SQL fragment,
P
Pratik Naik 已提交
691
      #   such as <tt>last_name, first_name DESC</tt>.
P
Pratik Naik 已提交
692 693
      # [:foreign_key]
      #   Specify the foreign key used for the association. By default this is guessed to be the name
P
Pratik Naik 已提交
694 695
      #   of this class in lower-case and "_id" suffixed. So a Person class that makes a +has_many+ association will use "person_id"
      #   as the default <tt>:foreign_key</tt>.
P
Pratik Naik 已提交
696 697 698 699
      # [:primary_key]
      #   Specify the method that returns the primary key used for the association. By default this is +id+.
      # [:dependent]
      #   If set to <tt>:destroy</tt> all the associated objects are destroyed
P
Pratik Naik 已提交
700 701 702 703
      #   alongside this object by calling their +destroy+ method.  If set to <tt>:delete_all</tt> all associated
      #   objects are deleted *without* calling their +destroy+ method.  If set to <tt>:nullify</tt> all associated
      #   objects' foreign keys are set to +NULL+ *without* calling their +save+ callbacks. *Warning:* This option is ignored when also using
      #   the <tt>:through</tt> option.
P
Pratik Naik 已提交
704 705
      # [:finder_sql]
      #   Specify a complete SQL statement to fetch the association. This is a good way to go for complex
D
David Heinemeier Hansson 已提交
706
      #   associations that depend on multiple tables. Note: When this option is used, +find_in_collection+ is _not_ added.
P
Pratik Naik 已提交
707 708
      # [:counter_sql]
      #   Specify a complete SQL statement to fetch the size of the association. If <tt>:finder_sql</tt> is
709
      #   specified but not <tt>:counter_sql</tt>, <tt>:counter_sql</tt> will be generated by replacing <tt>SELECT ... FROM</tt> with <tt>SELECT COUNT(*) FROM</tt>.
P
Pratik Naik 已提交
710 711 712 713 714 715 716 717 718 719 720 721
      # [:extend]
      #   Specify a named module for extending the proxy. See "Association extensions".
      # [:include]
      #   Specify second-order associations that should be eager loaded when the collection is loaded.
      # [:group]
      #   An attribute name by which the result should be grouped. Uses the <tt>GROUP BY</tt> SQL-clause.
      # [:limit]
      #   An integer determining the limit on the number of rows that should be returned.
      # [:offset]
      #   An integer determining the offset from where the rows should be fetched. So at 5, it would skip the first 4 rows.
      # [:select]
      #   By default, this is <tt>*</tt> as in <tt>SELECT * FROM</tt>, but can be changed if you, for example, want to do a join
722
      #   but not include the joined columns. Do not forget to include the primary and foreign keys, otherwise it will raise an error.
P
Pratik Naik 已提交
723 724 725 726
      # [:as]
      #   Specifies a polymorphic interface (See <tt>belongs_to</tt>).
      # [:through]
      #   Specifies a Join Model through which to perform the query.  Options for <tt>:class_name</tt> and <tt>:foreign_key</tt>
727 728
      #   are ignored, as the association uses the source reflection. You can only use a <tt>:through</tt> query through a <tt>belongs_to</tt>
      #   or <tt>has_many</tt> association on the join model.
P
Pratik Naik 已提交
729 730
      # [:source]
      #   Specifies the source association name used by <tt>has_many :through</tt> queries.  Only use it if the name cannot be
731
      #   inferred from the association.  <tt>has_many :subscribers, :through => :subscriptions</tt> will look for either <tt>:subscribers</tt> or
P
Pratik Naik 已提交
732
      #   <tt>:subscriber</tt> on Subscription, unless a <tt>:source</tt> is given.
P
Pratik Naik 已提交
733 734
      # [:source_type]
      #   Specifies type of the source association used by <tt>has_many :through</tt> queries where the source
735
      #   association is a polymorphic +belongs_to+.
P
Pratik Naik 已提交
736 737 738 739 740 741
      # [:uniq]
      #   If true, duplicates will be omitted from the collection. Useful in conjunction with <tt>:through</tt>.
      # [:readonly]
      #   If true, all the associated objects are readonly through the association.
      # [:validate]
      #   If false, don't validate the associated objects when saving the parent object. true by default.
D
Initial  
David Heinemeier Hansson 已提交
742 743
      # Option examples:
      #   has_many :comments, :order => "posted_on"
744
      #   has_many :comments, :include => :author
D
Initial  
David Heinemeier Hansson 已提交
745
      #   has_many :people, :class_name => "Person", :conditions => "deleted = 0", :order => "name"
746 747
      #   has_many :tracks, :order => "position", :dependent => :destroy
      #   has_many :comments, :dependent => :nullify
R
Rick Olson 已提交
748
      #   has_many :tags, :as => :taggable
749
      #   has_many :reports, :readonly => true
750
      #   has_many :subscribers, :through => :subscriptions, :source => :user
D
Initial  
David Heinemeier Hansson 已提交
751 752 753 754 755
      #   has_many :subscribers, :class_name => "Person", :finder_sql =>
      #       'SELECT DISTINCT people.* ' +
      #       'FROM people p, post_subscriptions ps ' +
      #       'WHERE ps.post_id = #{id} AND ps.person_id = p.id ' +
      #       'ORDER BY p.first_name'
756
      def has_many(association_id, options = {}, &extension)
757
        reflection = create_has_many_reflection(association_id, options, &extension)
758

759
        configure_dependency_for_has_many(reflection)
760

761 762
        add_multiple_associated_validation_callbacks(reflection.name) unless options[:validate] == false
        add_multiple_associated_save_callbacks(reflection.name)
763 764
        add_association_callbacks(reflection.name, reflection.options)

765
        if options[:through]
766
          collection_accessor_methods(reflection, HasManyThroughAssociation)
767 768
        else
          collection_accessor_methods(reflection, HasManyAssociation)
D
Initial  
David Heinemeier Hansson 已提交
769 770 771
        end
      end

P
Pratik Naik 已提交
772 773 774 775 776 777 778 779 780 781 782
      # Specifies a one-to-one association with another class. This method should only be used
      # if the other class contains the foreign key. If the current class contains the foreign key,
      # then you should use +belongs_to+ instead. See also ActiveRecord::Associations::ClassMethods's overview
      # on when to use has_one and when to use belongs_to.
      #
      # The following methods for retrieval and query of a single associated object will be added:
      #
      # [association(force_reload = false)]
      #   Returns the associated object. +nil+ is returned if none is found.
      # [association=(associate)]
      #   Assigns the associate object, extracts the primary key, sets it as the foreign key,
D
Initial  
David Heinemeier Hansson 已提交
783
      #   and saves the associate object.
P
Pratik Naik 已提交
784 785 786 787 788 789 790 791 792 793 794 795 796 797
      # [association.nil?]
      #   Returns +true+ if there is no associated object.
      # [build_association(attributes = {})]
      #   Returns a new object of the associated type that has been instantiated
      #   with +attributes+ and linked to this object through a foreign key, but has not
      #   yet been saved. <b>Note:</b> This ONLY works if an association already exists.
      #   It will NOT work if the association is +nil+.
      # [create_association(attributes = {})]
      #   Returns a new object of the associated type that has been instantiated
      #   with +attributes+, linked to this object through a foreign key, and that
      #   has already been saved (if it passed the validation).
      #
      # (+association+ is replaced with the symbol passed as the first argument, so
      # <tt>has_one :manager</tt> would add among others <tt>manager.nil?</tt>.)
D
Initial  
David Heinemeier Hansson 已提交
798
      #
P
Pratik Naik 已提交
799 800 801
      # === Example
      #
      # An Account class declares <tt>has_one :beneficiary</tt>, which will add:
802
      # * <tt>Account#beneficiary</tt> (similar to <tt>Beneficiary.find(:first, :conditions => "account_id = #{id}")</tt>)
D
Initial  
David Heinemeier Hansson 已提交
803 804
      # * <tt>Account#beneficiary=(beneficiary)</tt> (similar to <tt>beneficiary.account_id = account.id; beneficiary.save</tt>)
      # * <tt>Account#beneficiary.nil?</tt>
805 806 807
      # * <tt>Account#build_beneficiary</tt> (similar to <tt>Beneficiary.new("account_id" => id)</tt>)
      # * <tt>Account#create_beneficiary</tt> (similar to <tt>b = Beneficiary.new("account_id" => id); b.save; b</tt>)
      #
P
Pratik Naik 已提交
808 809
      # === Options
      #
D
Initial  
David Heinemeier Hansson 已提交
810
      # The declaration can also include an options hash to specialize the behavior of the association.
811
      #
D
Initial  
David Heinemeier Hansson 已提交
812
      # Options are:
P
Pratik Naik 已提交
813 814
      # [:class_name]
      #   Specify the class name of the association. Use it only if that name can't be inferred
P
Pratik Naik 已提交
815 816
      #   from the association name. So <tt>has_one :manager</tt> will by default be linked to the Manager class, but
      #   if the real class name is Person, you'll have to specify it with this option.
P
Pratik Naik 已提交
817 818
      # [:conditions]
      #   Specify the conditions that the associated object must meet in order to be included as a +WHERE+
819
      #   SQL fragment, such as <tt>rank = 5</tt>.
P
Pratik Naik 已提交
820 821
      # [:order]
      #   Specify the order in which the associated objects are returned as an <tt>ORDER BY</tt> SQL fragment,
P
Pratik Naik 已提交
822
      #   such as <tt>last_name, first_name DESC</tt>.
P
Pratik Naik 已提交
823 824
      # [:dependent]
      #   If set to <tt>:destroy</tt>, the associated object is destroyed when this object is. If set to
825 826
      #   <tt>:delete</tt>, the associated object is deleted *without* calling its destroy method. If set to <tt>:nullify</tt>, the associated
      #   object's foreign key is set to +NULL+. Also, association is assigned.
P
Pratik Naik 已提交
827 828
      # [:foreign_key]
      #   Specify the foreign key used for the association. By default this is guessed to be the name
P
Pratik Naik 已提交
829 830
      #   of this class in lower-case and "_id" suffixed. So a Person class that makes a +has_one+ association will use "person_id"
      #   as the default <tt>:foreign_key</tt>.
P
Pratik Naik 已提交
831 832 833 834 835 836 837 838
      # [:primary_key]
      #   Specify the method that returns the primary key used for the association. By default this is +id+.
      # [:include]
      #   Specify second-order associations that should be eager loaded when this object is loaded.
      # [:as]
      #   Specifies a polymorphic interface (See <tt>belongs_to</tt>).
      # [:select]
      #   By default, this is <tt>*</tt> as in <tt>SELECT * FROM</tt>, but can be changed if, for example, you want to do a join
839
      #   but not include the joined columns. Do not forget to include the primary and foreign keys, otherwise it will raise an error.
P
Pratik Naik 已提交
840 841
      # [:through]
      #   Specifies a Join Model through which to perform the query.  Options for <tt>:class_name</tt> and <tt>:foreign_key</tt>
842 843
      #   are ignored, as the association uses the source reflection. You can only use a <tt>:through</tt> query through a 
      #   <tt>has_one</tt> or <tt>belongs_to</tt> association on the join model.
P
Pratik Naik 已提交
844 845
      # [:source]
      #   Specifies the source association name used by <tt>has_one :through</tt> queries.  Only use it if the name cannot be
846
      #   inferred from the association.  <tt>has_one :favorite, :through => :favorites</tt> will look for a
P
Pratik Naik 已提交
847
      #   <tt>:favorite</tt> on Favorite, unless a <tt>:source</tt> is given.      
P
Pratik Naik 已提交
848 849
      # [:source_type]
      #   Specifies type of the source association used by <tt>has_one :through</tt> queries where the source
850
      #   association is a polymorphic +belongs_to+.      
P
Pratik Naik 已提交
851 852 853 854
      # [:readonly]
      #   If true, the associated object is readonly through the association.
      # [:validate]
      #   If false, don't validate the associated object when saving the parent object. +false+ by default.
855
      #
D
Initial  
David Heinemeier Hansson 已提交
856
      # Option examples:
857
      #   has_one :credit_card, :dependent => :destroy  # destroys the associated credit card
858
      #   has_one :credit_card, :dependent => :nullify  # updates the associated records foreign key value to NULL rather than destroying it
D
Initial  
David Heinemeier Hansson 已提交
859 860
      #   has_one :last_comment, :class_name => "Comment", :order => "posted_on"
      #   has_one :project_manager, :class_name => "Person", :conditions => "role = 'project_manager'"
861
      #   has_one :attachment, :as => :attachable
862
      #   has_one :boss, :readonly => :true
863 864
      #   has_one :club, :through => :membership
      #   has_one :primary_address, :through => :addressables, :conditions => ["addressable.primary = ?", true], :source => :addressable
D
Initial  
David Heinemeier Hansson 已提交
865
      def has_one(association_id, options = {})
866 867 868 869 870
        if options[:through]
          reflection = create_has_one_through_reflection(association_id, options)
          association_accessor_methods(reflection, ActiveRecord::Associations::HasOneThroughAssociation)
        else
          reflection = create_has_one_reflection(association_id, options)
D
Initial  
David Heinemeier Hansson 已提交
871

872
          ivar = "@#{reflection.name}"
873

874 875
          method_name = "has_one_after_save_for_#{reflection.name}".to_sym
          define_method(method_name) do
876
            association = instance_variable_get(ivar) if instance_variable_defined?(ivar)
877

878 879
            if !association.nil? && (new_record? || association.new_record? || association[reflection.primary_key_name] != id)
              association[reflection.primary_key_name] = id
880 881
              association.save(true)
            end
882
          end
883
          after_save method_name
884

885
          add_single_associated_validation_callbacks(reflection.name) if options[:validate] == true
886 887 888
          association_accessor_methods(reflection, HasOneAssociation)
          association_constructor_method(:build,  reflection, HasOneAssociation)
          association_constructor_method(:create, reflection, HasOneAssociation)
889

890 891
          configure_dependency_for_has_one(reflection)
        end
D
Initial  
David Heinemeier Hansson 已提交
892 893
      end

P
Pratik Naik 已提交
894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909
      # Specifies a one-to-one association with another class. This method should only be used
      # if this class contains the foreign key. If the other class contains the foreign key,
      # then you should use +has_one+ instead. See also ActiveRecord::Associations::ClassMethods's overview
      # on when to use +has_one+ and when to use +belongs_to+.
      #
      # Methods will be added for retrieval and query for a single associated object, for which
      # this object holds an id:
      #
      # [association(force_reload = false)]
      #   Returns the associated object. +nil+ is returned if none is found.
      # [association=(associate)]
      #   Assigns the associate object, extracts the primary key, and sets it as the foreign key.
      # [association.nil?]
      #   Returns +true+ if there is no associated object.
      # [build_association(attributes = {})]
      #   Returns a new object of the associated type that has been instantiated
910
      #   with +attributes+ and linked to this object through a foreign key, but has not yet been saved.
P
Pratik Naik 已提交
911 912 913 914 915 916 917
      # [create_association(attributes = {})]
      #   Returns a new object of the associated type that has been instantiated
      #   with +attributes+, linked to this object through a foreign key, and that
      #   has already been saved (if it passed the validation).
      #
      # (+association+ is replaced with the symbol passed as the first argument, so
      # <tt>belongs_to :author</tt> would add among others <tt>author.nil?</tt>.)
D
Initial  
David Heinemeier Hansson 已提交
918
      #
P
Pratik Naik 已提交
919 920 921
      # === Example
      #
      # A Post class declares <tt>belongs_to :author</tt>, which will add:
D
Initial  
David Heinemeier Hansson 已提交
922 923 924 925
      # * <tt>Post#author</tt> (similar to <tt>Author.find(author_id)</tt>)
      # * <tt>Post#author=(author)</tt> (similar to <tt>post.author_id = author.id</tt>)
      # * <tt>Post#author?</tt> (similar to <tt>post.author == some_author</tt>)
      # * <tt>Post#author.nil?</tt>
D
David Heinemeier Hansson 已提交
926 927
      # * <tt>Post#build_author</tt> (similar to <tt>post.author = Author.new</tt>)
      # * <tt>Post#create_author</tt> (similar to <tt>post.author = Author.new; post.author.save; post.author</tt>)
D
Initial  
David Heinemeier Hansson 已提交
928
      # The declaration can also include an options hash to specialize the behavior of the association.
929
      #
P
Pratik Naik 已提交
930 931 932 933
      # === Options
      #
      # [:class_name]
      #   Specify the class name of the association. Use it only if that name can't be inferred
P
Pratik Naik 已提交
934 935
      #   from the association name. So <tt>has_one :author</tt> will by default be linked to the Author class, but
      #   if the real class name is Person, you'll have to specify it with this option.
P
Pratik Naik 已提交
936 937
      # [:conditions]
      #   Specify the conditions that the associated object must meet in order to be included as a +WHERE+
938
      #   SQL fragment, such as <tt>authorized = 1</tt>.
P
Pratik Naik 已提交
939 940
      # [:select]
      #   By default, this is <tt>*</tt> as in <tt>SELECT * FROM</tt>, but can be changed if, for example, you want to do a join
941
      #   but not include the joined columns. Do not forget to include the primary and foreign keys, otherwise it will raise an error.
P
Pratik Naik 已提交
942 943
      # [:foreign_key]
      #   Specify the foreign key used for the association. By default this is guessed to be the name
P
Pratik Naik 已提交
944 945 946
      #   of the association with an "_id" suffix. So a class that defines a <tt>belongs_to :person</tt> association will use
      #   "person_id" as the default <tt>:foreign_key</tt>. Similarly, <tt>belongs_to :favorite_person, :class_name => "Person"</tt>
      #   will use a foreign key of "favorite_person_id".
P
Pratik Naik 已提交
947 948
      # [:dependent]
      #   If set to <tt>:destroy</tt>, the associated object is destroyed when this object is. If set to
949 950 951
      #   <tt>:delete</tt>, the associated object is deleted *without* calling its destroy method. This option should not be specified when
      #   <tt>belongs_to</tt> is used in conjunction with a <tt>has_many</tt> relationship on another class because of the potential to leave
      #   orphaned records behind.
P
Pratik Naik 已提交
952 953
      # [:counter_cache]
      #   Caches the number of belonging objects on the associate class through the use of +increment_counter+
954
      #   and +decrement_counter+. The counter cache is incremented when an object of this class is created and decremented when it's
P
Pratik Naik 已提交
955 956
      #   destroyed. This requires that a column named <tt>#{table_name}_count</tt> (such as +comments_count+ for a belonging Comment class)
      #   is used on the associate class (such as a Post class). You can also specify a custom counter cache column by providing
957
      #   a column name instead of a +true+/+false+ value to this option (e.g., <tt>:counter_cache => :my_custom_counter</tt>.)
P
Pratik Naik 已提交
958
      #   Note: Specifying a counter cache will add it to that model's list of readonly attributes using +attr_readonly+.
P
Pratik Naik 已提交
959 960 961 962
      # [:include]
      #   Specify second-order associations that should be eager loaded when this object is loaded.
      # [:polymorphic]
      #   Specify this association is a polymorphic association by passing +true+.
963
      #   Note: If you've enabled the counter cache, then you may want to add the counter cache attribute
P
Pratik Naik 已提交
964
      #   to the +attr_readonly+ list in the associated classes (e.g. <tt>class Post; attr_readonly :comments_count; end</tt>).
P
Pratik Naik 已提交
965 966 967 968
      # [:readonly]
      #   If true, the associated object is readonly through the association.
      # [:validate]
      #   If false, don't validate the associated objects when saving the parent object. +false+ by default.
D
Initial  
David Heinemeier Hansson 已提交
969 970 971 972
      #
      # Option examples:
      #   belongs_to :firm, :foreign_key => "client_of"
      #   belongs_to :author, :class_name => "Person", :foreign_key => "author_id"
973
      #   belongs_to :valid_coupon, :class_name => "Coupon", :foreign_key => "coupon_id",
D
Initial  
David Heinemeier Hansson 已提交
974
      #              :conditions => 'discounts > #{payments_count}'
R
Rick Olson 已提交
975
      #   belongs_to :attachable, :polymorphic => true
976
      #   belongs_to :project, :readonly => true
977
      #   belongs_to :post, :counter_cache => true
978
      def belongs_to(association_id, options = {})
979
        reflection = create_belongs_to_reflection(association_id, options)
980 981 982

        ivar = "@#{reflection.name}"

983 984
        if reflection.options[:polymorphic]
          association_accessor_methods(reflection, BelongsToPolymorphicAssociation)
985

986 987
          method_name = "polymorphic_belongs_to_before_save_for_#{reflection.name}".to_sym
          define_method(method_name) do
988
            association = instance_variable_get(ivar) if instance_variable_defined?(ivar)
989

990 991 992 993
            if association && association.target
              if association.new_record?
                association.save(true)
              end
994

995
              if association.updated?
996 997
                self[reflection.primary_key_name] = association.id
                self[reflection.options[:foreign_type]] = association.class.base_class.name.to_s
998
              end
999
            end
1000
          end
1001
          before_save method_name
1002
        else
1003 1004 1005
          association_accessor_methods(reflection, BelongsToAssociation)
          association_constructor_method(:build,  reflection, BelongsToAssociation)
          association_constructor_method(:create, reflection, BelongsToAssociation)
1006

1007 1008
          method_name = "belongs_to_before_save_for_#{reflection.name}".to_sym
          define_method(method_name) do
1009
            association = instance_variable_get(ivar) if instance_variable_defined?(ivar)
1010

1011 1012 1013 1014
            if !association.nil?
              if association.new_record?
                association.save(true)
              end
1015

1016
              if association.updated?
1017
                self[reflection.primary_key_name] = association.id
1018
              end
1019
            end
1020
          end
1021
          before_save method_name
1022
        end
1023

1024
        # Create the callbacks to update counter cache
1025
        if options[:counter_cache]
1026
          cache_column = options[:counter_cache] == true ?
1027
            "#{self.to_s.demodulize.underscore.pluralize}_count" :
1028 1029
            options[:counter_cache]

1030 1031
          method_name = "belongs_to_counter_cache_after_create_for_#{reflection.name}".to_sym
          define_method(method_name) do
1032 1033
            association = send(reflection.name)
            association.class.increment_counter(cache_column, send(reflection.primary_key_name)) unless association.nil?
1034 1035
          end
          after_create method_name
1036

1037 1038
          method_name = "belongs_to_counter_cache_before_destroy_for_#{reflection.name}".to_sym
          define_method(method_name) do
1039 1040
            association = send(reflection.name)
            association.class.decrement_counter(cache_column, send(reflection.primary_key_name)) unless association.nil?
1041 1042
          end
          before_destroy method_name
1043

1044
          module_eval(
1045
            "#{reflection.class_name}.send(:attr_readonly,\"#{cache_column}\".intern) if defined?(#{reflection.class_name}) && #{reflection.class_name}.respond_to?(:attr_readonly)"
1046
          )
1047
        end
1048

1049
        add_single_associated_validation_callbacks(reflection.name) if options[:validate] == true
1050

1051
        configure_dependency_for_belongs_to(reflection)
1052 1053
      end

P
Pratik Naik 已提交
1054 1055 1056
      # Specifies a many-to-many relationship with another class. This associates two classes via an
      # intermediate join table.  Unless the join table is explicitly specified as an option, it is
      # guessed using the lexical order of the class names. So a join between Developer and Project
P
Pratik Naik 已提交
1057 1058
      # will give the default join table name of "developers_projects" because "D" outranks "P".  Note that this precedence
      # is calculated using the <tt><</tt> operator for String.  This means that if the strings are of different lengths,
1059
      # and the strings are equal when compared up to the shortest length, then the longer string is considered of higher
P
Pratik Naik 已提交
1060 1061 1062 1063
      # lexical precedence than the shorter one.  For example, one would expect the tables "paper_boxes" and "papers"
      # to generate a join table name of "papers_paper_boxes" because of the length of the name "paper_boxes",
      # but it in fact generates a join table name of "paper_boxes_papers".  Be aware of this caveat, and use the
      # custom <tt>:join_table</tt> option if you need to.
D
Initial  
David Heinemeier Hansson 已提交
1064
      #
1065
      # Deprecated: Any additional fields added to the join table will be placed as attributes when pulling records out through
1066
      # +has_and_belongs_to_many+ associations. Records returned from join tables with additional attributes will be marked as
P
Pratik Naik 已提交
1067
      # readonly (because we can't save changes to the additional attributes). It's strongly recommended that you upgrade any
1068
      # associations with attributes to a real join model (see introduction).
D
Initial  
David Heinemeier Hansson 已提交
1069
      #
1070
      # Adds the following methods for retrieval and query:
P
Pratik Naik 已提交
1071 1072 1073
      #
      # [collection(force_reload = false)]
      #   Returns an array of all the associated objects.
1074
      #   An empty array is returned if none are found.
P
Pratik Naik 已提交
1075 1076
      # [collection<<(object, ...)]
      #   Adds one or more objects to the collection by creating associations in the join table
1077
      #   (<tt>collection.push</tt> and <tt>collection.concat</tt> are aliases to this method).
P
Pratik Naik 已提交
1078 1079
      # [collection.delete(object, ...)]
      #   Removes one or more objects from the collection by removing their associations from the join table.
D
Initial  
David Heinemeier Hansson 已提交
1080
      #   This does not destroy the objects.
P
Pratik Naik 已提交
1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094
      # [collection=objects]
      #   Replaces the collection's content by deleting and adding objects as appropriate.
      # [collection_singular_ids]
      #   Returns an array of the associated objects' ids.
      # [collection_singular_ids=ids]
      #   Replace the collection by the objects identified by the primary keys in +ids+.
      # [collection.clear]
      #   Removes every object from the collection. This does not destroy the objects.
      # [collection.empty?]
      #   Returns +true+ if there are no associated objects.
      # [collection.size]
      #   Returns the number of associated objects.
      # [collection.find(id)]
      #   Finds an associated object responding to the +id+ and that
1095
      #   meets the condition that it has to be associated with this object.
P
Pratik Naik 已提交
1096 1097 1098 1099 1100 1101
      #   Uses the same rules as ActiveRecord::Base.find.
      # [collection.exist?(...)]
      #   Checks whether an associated object with the given conditions exists.
      #   Uses the same rules as ActiveRecord::Base.exists?.
      # [collection.build(attributes = {})]
      #   Returns a new object of the collection type that has been instantiated
1102
      #   with +attributes+ and linked to this object through the join table, but has not yet been saved.
P
Pratik Naik 已提交
1103 1104
      # [collection.create(attributes = {})]
      #   Returns a new object of the collection type that has been instantiated
1105
      #   with +attributes+, linked to this object through the join table, and that has already been saved (if it passed the validation).
D
Initial  
David Heinemeier Hansson 已提交
1106
      #
P
Pratik Naik 已提交
1107 1108 1109 1110 1111 1112
      # (+collection+ is replaced with the symbol passed as the first argument, so
      # <tt>has_and_belongs_to_many :categories</tt> would add among others <tt>categories.empty?</tt>.)
      #
      # === Example
      #
      # A Developer class declares <tt>has_and_belongs_to_many :projects</tt>, which will add:
D
Initial  
David Heinemeier Hansson 已提交
1113 1114 1115
      # * <tt>Developer#projects</tt>
      # * <tt>Developer#projects<<</tt>
      # * <tt>Developer#projects.delete</tt>
1116
      # * <tt>Developer#projects=</tt>
1117
      # * <tt>Developer#project_ids</tt>
1118
      # * <tt>Developer#project_ids=</tt>
D
Initial  
David Heinemeier Hansson 已提交
1119 1120 1121 1122
      # * <tt>Developer#projects.clear</tt>
      # * <tt>Developer#projects.empty?</tt>
      # * <tt>Developer#projects.size</tt>
      # * <tt>Developer#projects.find(id)</tt>
P
Pratik Naik 已提交
1123
      # * <tt>Developer#clients.exist?(...)</tt>
1124 1125
      # * <tt>Developer#projects.build</tt> (similar to <tt>Project.new("project_id" => id)</tt>)
      # * <tt>Developer#projects.create</tt> (similar to <tt>c = Project.new("project_id" => id); c.save; c</tt>)
D
Initial  
David Heinemeier Hansson 已提交
1126
      # The declaration may include an options hash to specialize the behavior of the association.
1127
      #
P
Pratik Naik 已提交
1128 1129 1130 1131
      # === Options
      #
      # [:class_name]
      #   Specify the class name of the association. Use it only if that name can't be inferred
1132
      #   from the association name. So <tt>has_and_belongs_to_many :projects</tt> will by default be linked to the
P
Pratik Naik 已提交
1133
      #   Project class, but if the real class name is SuperProject, you'll have to specify it with this option.
P
Pratik Naik 已提交
1134 1135 1136 1137 1138 1139
      # [:join_table]
      #   Specify the name of the join table if the default based on lexical order isn't what you want.
      #   <b>WARNING:</b> If you're overwriting the table name of either class, the +table_name+ method
      #   MUST be declared underneath any +has_and_belongs_to_many+ declaration in order to work.
      # [:foreign_key]
      #   Specify the foreign key used for the association. By default this is guessed to be the name
P
Pratik Naik 已提交
1140 1141
      #   of this class in lower-case and "_id" suffixed. So a Person class that makes a +has_and_belongs_to_many+ association
      #   will use "person_id" as the default <tt>:foreign_key</tt>.
P
Pratik Naik 已提交
1142 1143
      # [:association_foreign_key]
      #   Specify the association foreign key used for the association. By default this is
P
Pratik Naik 已提交
1144 1145
      #   guessed to be the name of the associated class in lower-case and "_id" suffixed. So if the associated class is Project,
      #   the +has_and_belongs_to_many+ association will use "project_id" as the default <tt>:association_foreign_key</tt>.
P
Pratik Naik 已提交
1146 1147
      # [:conditions]
      #   Specify the conditions that the associated object must meet in order to be included as a +WHERE+
1148 1149 1150
      #   SQL fragment, such as <tt>authorized = 1</tt>.  Record creations from the association are scoped if a hash is used.  
      #   <tt>has_many :posts, :conditions => {:published => true}</tt> will create published posts with <tt>@blog.posts.create</tt> 
      #   or <tt>@blog.posts.build</tt>.
P
Pratik Naik 已提交
1151 1152
      # [:order]
      #   Specify the order in which the associated objects are returned as an <tt>ORDER BY</tt> SQL fragment,
1153
      #   such as <tt>last_name, first_name DESC</tt>
P
Pratik Naik 已提交
1154 1155 1156 1157
      # [:uniq]
      #   If true, duplicate associated objects will be ignored by accessors and query methods.
      # [:finder_sql]
      #   Overwrite the default generated SQL statement used to fetch the association with a manual statement
1158 1159 1160
      # [:counter_sql]
      #   Specify a complete SQL statement to fetch the size of the association. If <tt>:finder_sql</tt> is
      #   specified but not <tt>:counter_sql</tt>, <tt>:counter_sql</tt> will be generated by replacing <tt>SELECT ... FROM</tt> with <tt>SELECT COUNT(*) FROM</tt>.
P
Pratik Naik 已提交
1161 1162
      # [:delete_sql]
      #   Overwrite the default generated SQL statement used to remove links between the associated
P
Pratik Naik 已提交
1163
      #   classes with a manual statement.
P
Pratik Naik 已提交
1164 1165
      # [:insert_sql]
      #   Overwrite the default generated SQL statement used to add links between the associated classes
P
Pratik Naik 已提交
1166
      #   with a manual statement.
P
Pratik Naik 已提交
1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178
      # [:extend]
      #   Anonymous module for extending the proxy, see "Association extensions".
      # [:include]
      #   Specify second-order associations that should be eager loaded when the collection is loaded.
      # [:group]
      #   An attribute name by which the result should be grouped. Uses the <tt>GROUP BY</tt> SQL-clause.
      # [:limit]
      #   An integer determining the limit on the number of rows that should be returned.
      # [:offset]
      #   An integer determining the offset from where the rows should be fetched. So at 5, it would skip the first 4 rows.
      # [:select]
      #   By default, this is <tt>*</tt> as in <tt>SELECT * FROM</tt>, but can be changed if, for example, you want to do a join
1179
      #   but not include the joined columns. Do not forget to include the primary and foreign keys, otherwise it will raise an error.
P
Pratik Naik 已提交
1180 1181 1182 1183
      # [:readonly]
      #   If true, all the associated objects are readonly through the association.
      # [:validate]
      #   If false, don't validate the associated objects when saving the parent object. +true+ by default.
D
Initial  
David Heinemeier Hansson 已提交
1184 1185 1186
      #
      # Option examples:
      #   has_and_belongs_to_many :projects
1187
      #   has_and_belongs_to_many :projects, :include => [ :milestones, :manager ]
D
Initial  
David Heinemeier Hansson 已提交
1188 1189
      #   has_and_belongs_to_many :nations, :class_name => "Country"
      #   has_and_belongs_to_many :categories, :join_table => "prods_cats"
1190
      #   has_and_belongs_to_many :categories, :readonly => true
1191
      #   has_and_belongs_to_many :active_projects, :join_table => 'developers_projects', :delete_sql =>
1192
      #   'DELETE FROM developers_projects WHERE active=1 AND developer_id = #{id} AND project_id = #{record.id}'
1193
      def has_and_belongs_to_many(association_id, options = {}, &extension)
1194
        reflection = create_has_and_belongs_to_many_reflection(association_id, options, &extension)
1195

1196 1197
        add_multiple_associated_validation_callbacks(reflection.name) unless options[:validate] == false
        add_multiple_associated_save_callbacks(reflection.name)
1198
        collection_accessor_methods(reflection, HasAndBelongsToManyAssociation)
D
Initial  
David Heinemeier Hansson 已提交
1199

1200 1201
        # Don't use a before_destroy callback since users' before_destroy
        # callbacks will be executed after the association is wiped out.
1202
        old_method = "destroy_without_habtm_shim_for_#{reflection.name}"
1203
        class_eval <<-end_eval unless method_defined?(old_method)
1204 1205
          alias_method :#{old_method}, :destroy_without_callbacks
          def destroy_without_callbacks
1206
            #{reflection.name}.clear
1207 1208 1209 1210
            #{old_method}
          end
        end_eval

1211
        add_association_callbacks(reflection.name, options)
D
Initial  
David Heinemeier Hansson 已提交
1212 1213 1214
      end

      private
P
Pratik Naik 已提交
1215 1216 1217 1218 1219
        # Generates a join table name from two provided table names.
        # The names in the join table namesme end up in lexicographic order.
        #
        #   join_table_name("members", "clubs")         # => "clubs_members"
        #   join_table_name("members", "special_clubs") # => "members_special_clubs"
D
Initial  
David Heinemeier Hansson 已提交
1220 1221 1222 1223 1224 1225 1226 1227 1228
        def join_table_name(first_table_name, second_table_name)
          if first_table_name < second_table_name
            join_table = "#{first_table_name}_#{second_table_name}"
          else
            join_table = "#{second_table_name}_#{first_table_name}"
          end

          table_name_prefix + join_table + table_name_suffix
        end
1229

1230
        def association_accessor_methods(reflection, association_proxy_class)
1231 1232
          ivar = "@#{reflection.name}"

1233
          define_method(reflection.name) do |*params|
1234
            force_reload = params.first unless params.empty?
1235 1236

            association = instance_variable_get(ivar) if instance_variable_defined?(ivar)
1237

1238
            if association.nil? || !association.loaded? || force_reload
1239
              association = association_proxy_class.new(self, reflection)
1240
              retval = association.reload
1241
              if retval.nil? and association_proxy_class == BelongsToAssociation
1242
                instance_variable_set(ivar, nil)
1243 1244
                return nil
              end
1245
              instance_variable_set(ivar, association)
1246
            end
1247 1248

            association.target.nil? ? nil : association
1249 1250
          end

1251 1252 1253 1254 1255
          define_method("loaded_#{reflection.name}?") do
            association = instance_variable_get(ivar) if instance_variable_defined?(ivar)
            association && association.loaded?
          end

1256
          define_method("#{reflection.name}=") do |new_value|
1257 1258
            association = instance_variable_get(ivar) if instance_variable_defined?(ivar)

1259
            if association.nil? || association.target != new_value
1260
              association = association_proxy_class.new(self, reflection)
1261
            end
1262

1263 1264 1265 1266
            if association_proxy_class == HasOneThroughAssociation
              association.create_through_record(new_value)
              self.send(reflection.name, new_value)
            else
P
pivotal 已提交
1267 1268
              association.replace(new_value)
              instance_variable_set(ivar, new_value.nil? ? nil : association)
1269
            end
1270
          end
1271

1272 1273
          if association_proxy_class == BelongsToAssociation
            define_method("#{reflection.primary_key_name}=") do |target_id|
1274 1275 1276 1277 1278
              if instance_variable_defined?(ivar)
                if association = instance_variable_get(ivar)
                  association.reset
                end
              end
1279 1280 1281 1282
              write_attribute(reflection.primary_key_name, target_id)
            end
          end

1283
          define_method("set_#{reflection.name}_target") do |target|
1284
            return if target.nil? and association_proxy_class == BelongsToAssociation
1285
            association = association_proxy_class.new(self, reflection)
1286
            association.target = target
1287
            instance_variable_set(ivar, association)
1288
          end
1289 1290
        end

1291 1292
        def collection_reader_method(reflection, association_proxy_class)
          define_method(reflection.name) do |*params|
1293 1294
            ivar = "@#{reflection.name}"

1295
            force_reload = params.first unless params.empty?
1296
            association = instance_variable_get(ivar) if instance_variable_defined?(ivar)
1297

1298
            unless association.respond_to?(:loaded?)
1299
              association = association_proxy_class.new(self, reflection)
1300
              instance_variable_set(ivar, association)
D
Initial  
David Heinemeier Hansson 已提交
1301
            end
1302

1303
            association.reload if force_reload
1304

1305 1306
            association
          end
1307 1308

          define_method("#{reflection.name.to_s.singularize}_ids") do
1309 1310 1311
            if send(reflection.name).loaded?
              send(reflection.name).map(&:id)
            else
1312
              send(reflection.name).all(:select => "#{reflection.quoted_table_name}.#{reflection.klass.primary_key}").map(&:id)
1313
            end
1314
          end
1315
        end
D
Initial  
David Heinemeier Hansson 已提交
1316

1317
        def collection_accessor_methods(reflection, association_proxy_class, writer = true)
1318 1319
          collection_reader_method(reflection, association_proxy_class)

1320 1321 1322 1323 1324 1325 1326
          if writer
            define_method("#{reflection.name}=") do |new_value|
              # Loads proxy class instance (defined in collection_reader_method) if not already loaded
              association = send(reflection.name)
              association.replace(new_value)
              association
            end
1327

1328 1329 1330 1331
            define_method("#{reflection.name.to_s.singularize}_ids=") do |new_value|
              ids = (new_value || []).reject { |nid| nid.blank? }
              send("#{reflection.name}=", reflection.class_name.constantize.find(ids))
            end
1332
          end
D
Initial  
David Heinemeier Hansson 已提交
1333
        end
1334

1335
        def add_single_associated_validation_callbacks(association_name)
1336 1337 1338 1339
          method_name = "validate_associated_records_for_#{association_name}".to_sym
          define_method(method_name) do
            association = instance_variable_get("@#{association_name}")
            if !association.nil?
1340
              errors.add association_name unless association.target.nil? || association.valid?
1341 1342
            end
          end
1343

1344 1345
          validate method_name
        end
1346

1347
        def add_multiple_associated_validation_callbacks(association_name)
1348
          method_name = "validate_associated_records_for_#{association_name}".to_sym
1349 1350
          ivar = "@#{association_name}"

1351
          define_method(method_name) do
1352 1353
            association = instance_variable_get(ivar) if instance_variable_defined?(ivar)

1354
            if association.respond_to?(:loaded?)
1355
              if new_record?
1356
                association
1357
              elsif association.loaded?
1358
                association.select { |record| record.new_record? }
1359 1360
              else
                association.target.select { |record| record.new_record? }
1361
              end.each do |record|
1362
                errors.add association_name unless record.valid?
D
Initial  
David Heinemeier Hansson 已提交
1363
              end
1364
            end
1365
          end
D
Initial  
David Heinemeier Hansson 已提交
1366

1367
          validate method_name
1368 1369 1370 1371
        end

        def add_multiple_associated_save_callbacks(association_name)
          ivar = "@#{association_name}"
1372

1373 1374 1375 1376 1377 1378 1379 1380 1381
          method_name = "before_save_associated_records_for_#{association_name}".to_sym
          define_method(method_name) do
            @new_record_before_save = new_record?
            true
          end
          before_save method_name

          method_name = "after_create_or_update_associated_records_for_#{association_name}".to_sym
          define_method(method_name) do
1382
            association = instance_variable_get(ivar) if instance_variable_defined?(ivar)
1383

1384 1385 1386 1387
            records_to_save = if @new_record_before_save
              association
            elsif association.respond_to?(:loaded?) && association.loaded?
              association.select { |record| record.new_record? }
1388 1389
            elsif association.respond_to?(:loaded?) && !association.loaded?
              association.target.select { |record| record.new_record? }
1390 1391 1392
            else
              []
            end
1393
            records_to_save.each { |record| association.send(:insert_record, record) } unless records_to_save.blank?
1394

1395 1396
            # reconstruct the SQL queries now that we know the owner's id
            association.send(:construct_sql) if association.respond_to?(:construct_sql)
1397
          end
1398

1399
          # Doesn't use after_save as that would save associations added in after_create/after_update twice
1400 1401
          after_create method_name
          after_update method_name
D
Initial  
David Heinemeier Hansson 已提交
1402
        end
1403

1404 1405
        def association_constructor_method(constructor, reflection, association_proxy_class)
          define_method("#{constructor}_#{reflection.name}") do |*params|
1406 1407
            ivar = "@#{reflection.name}"

1408 1409
            attributees      = params.first unless params.empty?
            replace_existing = params[1].nil? ? true : params[1]
1410
            association      = instance_variable_get(ivar) if instance_variable_defined?(ivar)
1411 1412

            if association.nil?
1413
              association = association_proxy_class.new(self, reflection)
1414
              instance_variable_set(ivar, association)
1415 1416
            end

1417 1418 1419 1420 1421
            if association_proxy_class == HasOneAssociation
              association.send(constructor, attributees, replace_existing)
            else
              association.send(constructor, attributees)
            end
1422 1423
          end
        end
1424

1425
        def find_with_associations(options = {})
1426
          catch :invalid_query do
1427
            join_dependency = JoinDependency.new(self, merge_includes(scope(:find, :include), options[:include]), options[:joins])
1428 1429 1430 1431
            rows = select_all_rows(options, join_dependency)
            return join_dependency.instantiate(rows)
          end
          []
1432
        end
1433

1434 1435 1436
        # Creates before_destroy callback methods that nullify, delete or destroy
        # has_many associated objects, according to the defined :dependent rule.
        #
1437 1438
        # See HasManyAssociation#delete_records.  Dependent associations
        # delete children, otherwise foreign key is set to NULL.
1439 1440 1441 1442 1443
        #
        # The +extra_conditions+ parameter, which is not used within the main
        # Active Record codebase, is meant to allow plugins to define extra
        # finder conditions.
        def configure_dependency_for_has_many(reflection, extra_conditions = nil)
1444 1445 1446 1447 1448 1449
          if reflection.options.include?(:dependent)
            # Add polymorphic type if the :as option is present
            dependent_conditions = []
            dependent_conditions << "#{reflection.primary_key_name} = \#{record.quoted_id}"
            dependent_conditions << "#{reflection.options[:as]}_type = '#{base_class.name}'" if reflection.options[:as]
            dependent_conditions << sanitize_sql(reflection.options[:conditions]) if reflection.options[:conditions]
1450
            dependent_conditions << extra_conditions if extra_conditions
1451
            dependent_conditions = dependent_conditions.collect {|where| "(#{where})" }.join(" AND ")
1452

1453 1454
            case reflection.options[:dependent]
              when :destroy
1455 1456
                method_name = "has_many_dependent_destroy_for_#{reflection.name}".to_sym
                define_method(method_name) do
1457
                  send(reflection.name).each { |o| o.destroy }
1458 1459
                end
                before_destroy method_name
1460
              when :delete_all
1461 1462 1463 1464 1465 1466 1467 1468
                module_eval %Q{
                  before_destroy do |record|
                    delete_all_has_many_dependencies(record,
                      "#{reflection.name}",
                      #{reflection.class_name},
                      "#{dependent_conditions}")
                  end
                }
1469
              when :nullify
1470 1471 1472 1473 1474 1475 1476 1477 1478
                module_eval %Q{
                  before_destroy do |record|
                    nullify_has_many_dependencies(record,
                      "#{reflection.name}",
                      #{reflection.class_name},
                      "#{reflection.primary_key_name}",
                      "#{dependent_conditions}")
                  end
                }
1479 1480 1481
              else
                raise ArgumentError, "The :dependent option expects either :destroy, :delete_all, or :nullify (#{reflection.options[:dependent].inspect})"
            end
1482 1483
          end
        end
1484

P
Pratik Naik 已提交
1485 1486
        # Creates before_destroy callback methods that nullify, delete or destroy
        # has_one associated objects, according to the defined :dependent rule.
1487
        def configure_dependency_for_has_one(reflection)
1488 1489 1490
          if reflection.options.include?(:dependent)
            case reflection.options[:dependent]
              when :destroy
1491 1492
                method_name = "has_one_dependent_destroy_for_#{reflection.name}".to_sym
                define_method(method_name) do
1493
                  association = send(reflection.name)
1494 1495 1496
                  association.destroy unless association.nil?
                end
                before_destroy method_name
1497
              when :delete
1498 1499
                method_name = "has_one_dependent_delete_for_#{reflection.name}".to_sym
                define_method(method_name) do
P
Pratik Naik 已提交
1500 1501 1502 1503
                  # Retrieve the associated object and delete it. The retrieval
                  # is necessary because there may be multiple associated objects
                  # with foreign keys pointing to this object, and we only want
                  # to delete the correct one, not all of them.
1504
                  association = send(reflection.name)
1505
                  association.delete unless association.nil?
1506 1507
                end
                before_destroy method_name
1508
              when :nullify
1509 1510
                method_name = "has_one_dependent_nullify_for_#{reflection.name}".to_sym
                define_method(method_name) do
1511 1512
                  association = send(reflection.name)
                  association.update_attribute(reflection.primary_key_name, nil) unless association.nil?
1513 1514
                end
                before_destroy method_name
1515 1516 1517
              else
                raise ArgumentError, "The :dependent option expects either :destroy, :delete or :nullify (#{reflection.options[:dependent].inspect})"
            end
1518 1519 1520
          end
        end

1521 1522 1523 1524
        def configure_dependency_for_belongs_to(reflection)
          if reflection.options.include?(:dependent)
            case reflection.options[:dependent]
              when :destroy
1525 1526
                method_name = "belongs_to_dependent_destroy_for_#{reflection.name}".to_sym
                define_method(method_name) do
1527
                  association = send(reflection.name)
1528 1529 1530
                  association.destroy unless association.nil?
                end
                before_destroy method_name
1531
              when :delete
1532 1533
                method_name = "belongs_to_dependent_delete_for_#{reflection.name}".to_sym
                define_method(method_name) do
1534
                  association = send(reflection.name)
1535
                  association.delete unless association.nil?
1536 1537
                end
                before_destroy method_name
1538 1539 1540 1541 1542 1543
              else
                raise ArgumentError, "The :dependent option expects either :destroy or :delete (#{reflection.options[:dependent].inspect})"
            end
          end
        end

1544 1545 1546 1547 1548 1549 1550 1551
        def delete_all_has_many_dependencies(record, reflection_name, association_class, dependent_conditions)
          association_class.delete_all(dependent_conditions)
        end

        def nullify_has_many_dependencies(record, reflection_name, association_class, primary_key_name, dependent_conditions)
          association_class.update_all("#{primary_key_name} = NULL", dependent_conditions)
        end

1552 1553 1554 1555 1556 1557 1558 1559 1560 1561
        mattr_accessor :valid_keys_for_has_many_association
        @@valid_keys_for_has_many_association = [
          :class_name, :table_name, :foreign_key, :primary_key,
          :dependent,
          :select, :conditions, :include, :order, :group, :limit, :offset,
          :as, :through, :source, :source_type,
          :uniq,
          :finder_sql, :counter_sql,
          :before_add, :after_add, :before_remove, :after_remove,
          :extend, :readonly,
1562
          :validate
1563 1564
        ]

1565
        def create_has_many_reflection(association_id, options, &extension)
1566
          options.assert_valid_keys(valid_keys_for_has_many_association)
1567
          options[:extend] = create_extension_modules(association_id, extension, options[:extend])
1568

1569
          create_reflection(:has_many, association_id, options, self)
1570 1571
        end

1572 1573 1574 1575
        mattr_accessor :valid_keys_for_has_one_association
        @@valid_keys_for_has_one_association = [
          :class_name, :foreign_key, :remote, :select, :conditions, :order,
          :include, :dependent, :counter_cache, :extend, :as, :readonly,
1576
          :validate, :primary_key
1577 1578
        ]

1579
        def create_has_one_reflection(association_id, options)
1580
          options.assert_valid_keys(valid_keys_for_has_one_association)
1581
          create_reflection(:has_one, association_id, options, self)
1582
        end
1583

1584 1585
        def create_has_one_through_reflection(association_id, options)
          options.assert_valid_keys(
1586
            :class_name, :foreign_key, :remote, :select, :conditions, :order, :include, :dependent, :counter_cache, :extend, :as, :through, :source, :source_type, :validate
1587 1588 1589
          )
          create_reflection(:has_one, association_id, options, self)
        end
1590

1591 1592 1593 1594
        mattr_accessor :valid_keys_for_belongs_to_association
        @@valid_keys_for_belongs_to_association = [
          :class_name, :foreign_key, :foreign_type, :remote, :select, :conditions,
          :include, :dependent, :counter_cache, :extend, :polymorphic, :readonly,
1595
          :validate
1596 1597
        ]

1598
        def create_belongs_to_reflection(association_id, options)
1599
          options.assert_valid_keys(valid_keys_for_belongs_to_association)
1600 1601 1602 1603 1604 1605 1606 1607
          reflection = create_reflection(:belongs_to, association_id, options, self)

          if options[:polymorphic]
            reflection.options[:foreign_type] ||= reflection.class_name.underscore + "_type"
          end

          reflection
        end
1608

1609 1610
        def create_has_and_belongs_to_many_reflection(association_id, options, &extension)
          options.assert_valid_keys(
1611
            :class_name, :table_name, :join_table, :foreign_key, :association_foreign_key,
1612
            :select, :conditions, :include, :order, :group, :limit, :offset,
1613
            :uniq,
1614
            :finder_sql, :delete_sql, :insert_sql,
1615
            :before_add, :after_add, :before_remove, :after_remove,
1616
            :extend, :readonly,
1617
            :validate
1618 1619
          )

1620
          options[:extend] = create_extension_modules(association_id, extension, options[:extend])
1621 1622 1623 1624

          reflection = create_reflection(:has_and_belongs_to_many, association_id, options, self)

          reflection.options[:join_table] ||= join_table_name(undecorated_table_name(self.to_s), undecorated_table_name(reflection.class_name))
1625

1626 1627 1628
          reflection
        end

1629
        def reflect_on_included_associations(associations)
1630
          [ associations ].flatten.collect { |association| reflect_on_association(association.to_s.intern) }
1631 1632
        end

1633 1634 1635
        def guard_against_unlimitable_reflections(reflections, options)
          if (options[:offset] || options[:limit]) && !using_limitable_reflections?(reflections)
            raise(
1636
              ConfigurationError,
1637 1638 1639 1640 1641
              "You can not use offset and limit together with has_many or has_and_belongs_to_many associations"
            )
          end
        end

1642
        def select_all_rows(options, join_dependency)
1643
          connection.select_all(
1644
            construct_finder_sql_with_included_associations(options, join_dependency),
1645 1646 1647
            "#{name} Load Including Associations"
          )
        end
1648

1649
        def construct_finder_sql_with_included_associations(options, join_dependency)
1650
          scope = scope(:find)
1651
          sql = "SELECT #{column_aliases(join_dependency)} FROM #{(scope && scope[:from]) || options[:from] || quoted_table_name} "
1652
          sql << join_dependency.join_associations.collect{|join| join.association_join }.join
1653

1654
          add_joins!(sql, options[:joins], scope)
1655
          add_conditions!(sql, options[:conditions], scope)
1656
          add_limited_ids_condition!(sql, options, join_dependency) if !using_limitable_reflections?(join_dependency.reflections) && ((scope && scope[:limit]) || options[:limit])
1657

1658
          add_group!(sql, options[:group], scope)
1659
          add_order!(sql, options[:order], scope)
1660
          add_limit!(sql, options, scope) if using_limitable_reflections?(join_dependency.reflections)
1661
          add_lock!(sql, options, scope)
1662

1663 1664
          return sanitize_sql(sql)
        end
1665

1666 1667
        def add_limited_ids_condition!(sql, options, join_dependency)
          unless (id_list = select_limited_ids_list(options, join_dependency)).empty?
1668
            sql << "#{condition_word(sql)} #{connection.quote_table_name table_name}.#{primary_key} IN (#{id_list}) "
1669 1670
          else
            throw :invalid_query
1671 1672
          end
        end
1673

1674
        def select_limited_ids_list(options, join_dependency)
1675 1676
          pk = columns_hash[primary_key]

1677
          connection.select_all(
1678
            construct_finder_sql_for_association_limiting(options, join_dependency),
1679
            "#{name} Load IDs For Limited Eager Loading"
1680
          ).collect { |row| connection.quote(row[primary_key], pk) }.join(", ")
1681
        end
1682

1683
        def construct_finder_sql_for_association_limiting(options, join_dependency)
1684
          scope       = scope(:find)
1685 1686 1687 1688 1689

          # Only join tables referenced in order or conditions since this is particularly slow on the pre-query.
          tables_from_conditions = conditions_tables(options)
          tables_from_order      = order_tables(options)
          all_tables             = tables_from_conditions + tables_from_order
1690 1691 1692 1693
          distinct_join_associations = all_tables.uniq.map{|table|
            join_dependency.joins_for_table_name(table)
          }.flatten.compact.uniq

1694 1695 1696 1697 1698
          order = options[:order]
          if scoped_order = (scope && scope[:order])
            order = order ? "#{order}, #{scoped_order}" : scoped_order
          end

1699
          is_distinct = !options[:joins].blank? || include_eager_conditions?(options, tables_from_conditions) || include_eager_order?(options, tables_from_order)
1700
          sql = "SELECT "
1701
          if is_distinct
1702
            sql << connection.distinct("#{connection.quote_table_name table_name}.#{primary_key}", order)
1703 1704 1705
          else
            sql << primary_key
          end
1706
          sql << " FROM #{connection.quote_table_name table_name} "
1707

1708
          if is_distinct
1709
            sql << distinct_join_associations.collect { |assoc| assoc.association_join }.join
1710
            add_joins!(sql, options[:joins], scope)
1711
          end
1712

1713
          add_conditions!(sql, options[:conditions], scope)
1714
          add_group!(sql, options[:group], scope)
1715

1716 1717
          if order && is_distinct
            connection.add_order_by_for_association_limiting!(sql, :order => order)
1718 1719
          else
            add_order!(sql, options[:order], scope)
1720
          end
1721

1722
          add_limit!(sql, options, scope)
1723

1724 1725
          return sanitize_sql(sql)
        end
1726

1727
        def conditions_tables(options)
1728 1729 1730 1731 1732 1733 1734 1735
          # look in both sets of conditions
          conditions = [scope(:find, :conditions), options[:conditions]].inject([]) do |all, cond|
            case cond
              when nil   then all
              when Array then all << cond.first
              else            all << cond
            end
          end
1736
          conditions.join(' ').scan(/([\.a-zA-Z_]+).?\./).flatten
1737 1738 1739
        end

        def order_tables(options)
1740
          order = [options[:order], scope(:find, :order) ].join(", ")
1741
          return [] unless order && order.is_a?(String)
1742
          order.scan(/([\.a-zA-Z_]+).?\./).flatten
1743 1744
        end

1745 1746 1747
        def selects_tables(options)
          select = options[:select]
          return [] unless select && select.is_a?(String)
1748
          select.scan(/"?([\.a-zA-Z_]+)"?.?\./).flatten
1749 1750
        end

1751
        # Checks if the conditions reference a table other than the current model table
1752 1753
        def include_eager_conditions?(options, tables = nil)
          ((tables || conditions_tables(options)) - [table_name]).any?
1754
        end
1755

1756
        # Checks if the query order references a table other than the current model's table.
1757 1758
        def include_eager_order?(options, tables = nil)
          ((tables || order_tables(options)) - [table_name]).any?
1759
        end
1760

1761
        def include_eager_select?(options)
1762
          (selects_tables(options) - [table_name]).any?
1763 1764
        end

1765
        def references_eager_loaded_tables?(options)
1766
          include_eager_order?(options) || include_eager_conditions?(options) || include_eager_select?(options)
1767 1768
        end

1769 1770 1771 1772
        def using_limitable_reflections?(reflections)
          reflections.reject { |r| [ :belongs_to, :has_one ].include?(r.macro) }.length.zero?
        end

1773 1774
        def column_aliases(join_dependency)
          join_dependency.joins.collect{|join| join.column_names_with_alias.collect{|column_name, aliased_name|
1775
              "#{connection.quote_table_name join.aliased_table_name}.#{connection.quote_column_name column_name} AS #{aliased_name}"}}.flatten.join(", ")
1776 1777
        end

1778
        def add_association_callbacks(association_name, options)
1779 1780
          callbacks = %w(before_add after_add before_remove after_remove)
          callbacks.each do |callback_name|
1781
            full_callback_name = "#{callback_name}_for_#{association_name}"
1782 1783 1784
            defined_callbacks = options[callback_name.to_sym]
            if options.has_key?(callback_name.to_sym)
              class_inheritable_reader full_callback_name.to_sym
1785 1786 1787
              write_inheritable_attribute(full_callback_name.to_sym, [defined_callbacks].flatten)
            else
              write_inheritable_attribute(full_callback_name.to_sym, [])
1788 1789
            end
          end
1790
        end
1791

1792 1793 1794
        def condition_word(sql)
          sql =~ /where/i ? " AND " : "WHERE "
        end
1795

1796
        def create_extension_modules(association_id, block_extension, extensions)
1797
          if block_extension
1798
            extension_module_name = "#{self.to_s.demodulize}#{association_id.to_s.camelize}AssociationExtension"
1799

1800
            silence_warnings do
1801
              self.parent.const_set(extension_module_name, Module.new(&block_extension))
1802
            end
1803
            Array(extensions).push("#{self.parent}::#{extension_module_name}".constantize)
1804 1805
          else
            Array(extensions)
1806 1807
          end
        end
1808

D
David Heinemeier Hansson 已提交
1809
        class JoinDependency # :nodoc:
1810
          attr_reader :joins, :reflections, :table_aliases
1811

1812
          def initialize(base, associations, joins)
1813
            @joins                 = [JoinBase.new(base, joins)]
1814 1815 1816 1817
            @associations          = associations
            @reflections           = []
            @base_records_hash     = {}
            @base_records_in_order = []
1818 1819
            @table_aliases         = Hash.new { |aliases, table| aliases[table] = 0 }
            @table_aliases[base.table_name] = 1
1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836
            build(associations)
          end

          def join_associations
            @joins[1..-1].to_a
          end

          def join_base
            @joins[0]
          end

          def instantiate(rows)
            rows.each_with_index do |row, i|
              primary_id = join_base.record_id(row)
              unless @base_records_hash[primary_id]
                @base_records_in_order << (@base_records_hash[primary_id] = join_base.instantiate(row))
              end
1837
              construct(@base_records_hash[primary_id], @associations, join_associations.dup, row)
1838
            end
1839
            remove_duplicate_results!(join_base.active_record, @base_records_in_order, @associations)
1840 1841 1842
            return @base_records_in_order
          end

1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859
          def remove_duplicate_results!(base, records, associations)
            case associations
              when Symbol, String
                reflection = base.reflections[associations]
                if reflection && [:has_many, :has_and_belongs_to_many].include?(reflection.macro)
                  records.each { |record| record.send(reflection.name).target.uniq! }
                end
              when Array
                associations.each do |association|
                  remove_duplicate_results!(base, records, association)
                end
              when Hash
                associations.keys.each do |name|
                  reflection = base.reflections[name]
                  is_collection = [:has_many, :has_and_belongs_to_many].include?(reflection.macro)

                  parent_records = records.map do |record|
1860 1861 1862 1863
                    descendant = record.send(reflection.name)
                    next unless descendant
                    descendant.target.uniq! if is_collection
                    descendant
1864 1865 1866 1867 1868 1869 1870
                  end.flatten.compact

                  remove_duplicate_results!(reflection.class_name.constantize, parent_records, associations[name]) unless parent_records.empty?
                end
            end
          end

1871
          def join_for_table_name(table_name)
1872 1873 1874
            join = (@joins.select{|j|j.aliased_table_name == table_name.gsub(/^\"(.*)\"$/){$1} }.first) rescue nil
            return join unless join.nil?
            @joins.select{|j|j.is_a?(JoinAssociation) && j.aliased_join_table_name == table_name.gsub(/^\"(.*)\"$/){$1} }.first rescue nil
1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889
          end

          def joins_for_table_name(table_name)
            join = join_for_table_name(table_name)
            result = nil
            if join && join.is_a?(JoinAssociation)
              result = [join]
              if join.parent && join.parent.is_a?(JoinAssociation)
                result = joins_for_table_name(join.parent.aliased_table_name) +
                         result
              end
            end
            result
          end

1890 1891 1892 1893 1894 1895 1896 1897
          protected
            def build(associations, parent = nil)
              parent ||= @joins.last
              case associations
                when Symbol, String
                  reflection = parent.reflections[associations.to_s.intern] or
                  raise ConfigurationError, "Association named '#{ associations }' was not found; perhaps you misspelled it?"
                  @reflections << reflection
1898
                  @joins << build_join_association(reflection, parent)
1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912
                when Array
                  associations.each do |association|
                    build(association, parent)
                  end
                when Hash
                  associations.keys.sort{|a,b|a.to_s<=>b.to_s}.each do |name|
                    build(name, parent)
                    build(associations[name])
                  end
                else
                  raise ConfigurationError, associations.inspect
              end
            end

1913 1914 1915 1916 1917
            # overridden in InnerJoinDependency subclass
            def build_join_association(reflection, parent)
              JoinAssociation.new(reflection, self, parent)
            end

1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943
            def construct(parent, associations, joins, row)
              case associations
                when Symbol, String
                  while (join = joins.shift).reflection.name.to_s != associations.to_s
                    raise ConfigurationError, "Not Enough Associations" if joins.empty?
                  end
                  construct_association(parent, join, row)
                when Array
                  associations.each do |association|
                    construct(parent, association, joins, row)
                  end
                when Hash
                  associations.keys.sort{|a,b|a.to_s<=>b.to_s}.each do |name|
                    association = construct_association(parent, joins.shift, row)
                    construct(association, associations[name], joins, row) if association
                  end
                else
                  raise ConfigurationError, associations.inspect
              end
            end

            def construct_association(record, join, row)
              case join.reflection.macro
                when :has_many, :has_and_belongs_to_many
                  collection = record.send(join.reflection.name)
                  collection.loaded
1944

1945 1946
                  return nil if record.id.to_s != join.parent.record_id(row).to_s or row[join.aliased_primary_key].nil?
                  association = join.instantiate(row)
1947
                  collection.target.push(association)
1948 1949
                when :has_one
                  return if record.id.to_s != join.parent.record_id(row).to_s
1950
                  return if record.instance_variable_defined?("@#{join.reflection.name}")
1951 1952 1953
                  association = join.instantiate(row) unless row[join.aliased_primary_key].nil?
                  record.send("set_#{join.reflection.name}_target", association)
                when :belongs_to
1954 1955 1956 1957 1958 1959 1960 1961 1962
                  return if record.id.to_s != join.parent.record_id(row).to_s or row[join.aliased_primary_key].nil?
                  association = join.instantiate(row)
                  record.send("set_#{join.reflection.name}_target", association)
                else
                  raise ConfigurationError, "unknown macro: #{join.reflection.macro}"
              end
              return association
            end

D
David Heinemeier Hansson 已提交
1963
          class JoinBase # :nodoc:
1964
            attr_reader :active_record, :table_joins
1965
            delegate    :table_name, :column_names, :primary_key, :reflections, :sanitize_sql, :to => :active_record
1966

1967
            def initialize(active_record, joins = nil)
1968 1969
              @active_record = active_record
              @cached_record = {}
1970
              @table_joins   = joins
1971 1972 1973 1974 1975 1976 1977
            end

            def aliased_prefix
              "t0"
            end

            def aliased_primary_key
1978
              "#{aliased_prefix}_r0"
1979 1980 1981 1982 1983 1984 1985
            end

            def aliased_table_name
              active_record.table_name
            end

            def column_names_with_alias
1986
              unless defined?(@column_names_with_alias)
1987
                @column_names_with_alias = []
1988

1989
                ([primary_key] + (column_names - [primary_key])).each_with_index do |column_name, i|
1990
                  @column_names_with_alias << [column_name, "#{aliased_prefix}_r#{i}"]
1991 1992
                end
              end
1993 1994

              @column_names_with_alias
1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005
            end

            def extract_record(row)
              column_names_with_alias.inject({}){|record, (cn, an)| record[cn] = row[an]; record}
            end

            def record_id(row)
              row[aliased_primary_key]
            end

            def instantiate(row)
2006
              @cached_record[record_id(row)] ||= active_record.send(:instantiate, extract_record(row))
2007 2008 2009
            end
          end

D
David Heinemeier Hansson 已提交
2010
          class JoinAssociation < JoinBase # :nodoc:
2011
            attr_reader :reflection, :parent, :aliased_table_name, :aliased_prefix, :aliased_join_table_name, :parent_table_name
2012
            delegate    :options, :klass, :through_reflection, :source_reflection, :to => :reflection
2013 2014

            def initialize(reflection, join_dependency, parent = nil)
2015 2016 2017 2018 2019
              reflection.check_validity!
              if reflection.options[:polymorphic]
                raise EagerLoadPolymorphicError.new(reflection)
              end

2020
              super(reflection.klass)
2021
              @join_dependency    = join_dependency
2022 2023 2024
              @parent             = parent
              @reflection         = reflection
              @aliased_prefix     = "t#{ join_dependency.joins.size }"
2025
              @parent_table_name  = parent.active_record.table_name
2026
              @aliased_table_name = aliased_table_name_for(table_name)
2027

2028 2029
              if reflection.macro == :has_and_belongs_to_many
                @aliased_join_table_name = aliased_table_name_for(reflection.options[:join_table], "_join")
2030
              end
2031

2032
              if [:has_many, :has_one].include?(reflection.macro) && reflection.options[:through]
2033
                @aliased_join_table_name = aliased_table_name_for(reflection.through_reflection.klass.table_name, "_join")
2034
              end
2035 2036 2037
            end

            def association_join
2038
              connection = reflection.active_record.connection
2039
              join = case reflection.macro
2040
                when :has_and_belongs_to_many
2041
                  " #{join_type} %s ON %s.%s = %s.%s " % [
2042
                     table_alias_for(options[:join_table], aliased_join_table_name),
2043
                     connection.quote_table_name(aliased_join_table_name),
2044
                     options[:foreign_key] || reflection.active_record.to_s.foreign_key,
2045
                     connection.quote_table_name(parent.aliased_table_name),
2046
                     reflection.active_record.primary_key] +
2047
                  " #{join_type} %s ON %s.%s = %s.%s " % [
2048
                     table_name_and_alias,
2049 2050
                     connection.quote_table_name(aliased_table_name),
                     klass.primary_key,
2051
                     connection.quote_table_name(aliased_join_table_name),
2052
                     options[:association_foreign_key] || klass.to_s.foreign_key
2053 2054
                     ]
                when :has_many, :has_one
2055
                  case
2056
                    when reflection.options[:through]
2057
                      through_conditions = through_reflection.options[:conditions] ? "AND #{interpolate_sql(sanitize_sql(through_reflection.options[:conditions]))}" : ''
2058 2059 2060 2061

                      jt_foreign_key = jt_as_extra = jt_source_extra = jt_sti_extra = nil
                      first_key = second_key = as_extra = nil

2062
                      if through_reflection.options[:as] # has_many :through against a polymorphic join
2063 2064
                        jt_foreign_key = through_reflection.options[:as].to_s + '_id'
                        jt_as_extra = " AND %s.%s = %s" % [
2065 2066
                          connection.quote_table_name(aliased_join_table_name),
                          connection.quote_column_name(through_reflection.options[:as].to_s + '_type'),
2067
                          klass.quote_value(parent.active_record.base_class.name)
2068
                        ]
2069
                      else
2070
                        jt_foreign_key = through_reflection.primary_key_name
2071
                      end
2072

2073 2074
                      case source_reflection.macro
                      when :has_many
2075 2076 2077
                        if source_reflection.options[:as]
                          first_key   = "#{source_reflection.options[:as]}_id"
                          second_key  = options[:foreign_key] || primary_key
2078
                          as_extra    = " AND %s.%s = %s" % [
2079 2080
                            connection.quote_table_name(aliased_table_name),
                            connection.quote_column_name("#{source_reflection.options[:as]}_type"),
2081
                            klass.quote_value(source_reflection.active_record.base_class.name)
2082 2083
                          ]
                        else
2084 2085 2086
                          first_key   = through_reflection.klass.base_class.to_s.foreign_key
                          second_key  = options[:foreign_key] || primary_key
                        end
2087

2088 2089
                        unless through_reflection.klass.descends_from_active_record?
                          jt_sti_extra = " AND %s.%s = %s" % [
2090 2091
                            connection.quote_table_name(aliased_join_table_name),
                            connection.quote_column_name(through_reflection.active_record.inheritance_column),
2092
                            through_reflection.klass.quote_value(through_reflection.klass.sti_name)]
2093 2094 2095 2096 2097 2098
                        end
                      when :belongs_to
                        first_key = primary_key
                        if reflection.options[:source_type]
                          second_key = source_reflection.association_foreign_key
                          jt_source_extra = " AND %s.%s = %s" % [
2099 2100
                            connection.quote_table_name(aliased_join_table_name),
                            connection.quote_column_name(reflection.source_reflection.options[:foreign_type]),
2101
                            klass.quote_value(reflection.options[:source_type])
2102
                          ]
2103
                        else
2104
                          second_key = source_reflection.primary_key_name
2105
                        end
2106
                      end
2107

2108
                      " #{join_type} %s ON (%s.%s = %s.%s%s%s%s) " % [
2109
                        table_alias_for(through_reflection.klass.table_name, aliased_join_table_name),
2110
                        connection.quote_table_name(parent.aliased_table_name),
2111
                        connection.quote_column_name(parent.primary_key),
2112
                        connection.quote_table_name(aliased_join_table_name),
2113
                        connection.quote_column_name(jt_foreign_key),
2114 2115
                        jt_as_extra, jt_source_extra, jt_sti_extra
                      ] +
2116
                      " #{join_type} %s ON (%s.%s = %s.%s%s) " % [
2117
                        table_name_and_alias,
2118
                        connection.quote_table_name(aliased_table_name),
2119
                        connection.quote_column_name(first_key),
2120
                        connection.quote_table_name(aliased_join_table_name),
2121
                        connection.quote_column_name(second_key),
2122 2123 2124
                        as_extra
                      ]

2125
                    when reflection.options[:as] && [:has_many, :has_one].include?(reflection.macro)
2126
                      " #{join_type} %s ON %s.%s = %s.%s AND %s.%s = %s" % [
2127
                        table_name_and_alias,
2128
                        connection.quote_table_name(aliased_table_name),
2129
                        "#{reflection.options[:as]}_id",
2130
                        connection.quote_table_name(parent.aliased_table_name),
2131
                        parent.primary_key,
2132
                        connection.quote_table_name(aliased_table_name),
2133
                        "#{reflection.options[:as]}_type",
2134
                        klass.quote_value(parent.active_record.base_class.name)
2135 2136
                      ]
                    else
2137
                      foreign_key = options[:foreign_key] || reflection.active_record.name.foreign_key
2138
                      " #{join_type} %s ON %s.%s = %s.%s " % [
2139
                        table_name_and_alias,
2140
                        aliased_table_name,
2141
                        foreign_key,
2142
                        parent.aliased_table_name,
2143
                        parent.primary_key
2144 2145
                      ]
                  end
2146
                when :belongs_to
2147
                  " #{join_type} %s ON %s.%s = %s.%s " % [
2148
                     table_name_and_alias,
2149 2150
                     connection.quote_table_name(aliased_table_name),
                     reflection.klass.primary_key,
2151
                     connection.quote_table_name(parent.aliased_table_name),
2152
                     options[:foreign_key] || reflection.primary_key_name
2153 2154 2155
                    ]
                else
                  ""
2156
              end || ''
2157 2158
              join << %(AND %s) % [
                klass.send(:type_condition, aliased_table_name)] unless klass.descends_from_active_record?
2159 2160 2161 2162 2163

              [through_reflection, reflection].each do |ref|
                join << "AND #{interpolate_sql(sanitize_sql(ref.options[:conditions]))} " if ref && ref.options[:conditions]
              end

2164
              join
2165
            end
2166

2167
            protected
2168

2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185
              def aliased_table_name_for(name, suffix = nil)
                if !parent.table_joins.blank? && parent.table_joins.to_s.downcase =~ %r{join(\s+\w+)?\s+#{name.downcase}\son}
                  @join_dependency.table_aliases[name] += 1
                end

                unless @join_dependency.table_aliases[name].zero?
                  # if the table name has been used, then use an alias
                  name = active_record.connection.table_alias_for "#{pluralize(reflection.name)}_#{parent_table_name}#{suffix}"
                  table_index = @join_dependency.table_aliases[name]
                  @join_dependency.table_aliases[name] += 1
                  name = name[0..active_record.connection.table_alias_length-3] + "_#{table_index+1}" if table_index > 0
                else
                  @join_dependency.table_aliases[name] += 1
                end

                name
              end
2186

2187 2188 2189
              def pluralize(table_name)
                ActiveRecord::Base.pluralize_table_names ? table_name.to_s.pluralize : table_name
              end
2190

2191
              def table_alias_for(table_name, table_alias)
2192
                 "#{reflection.active_record.connection.quote_table_name(table_name)} #{table_alias if table_name != table_alias}".strip
2193 2194 2195 2196 2197
              end

              def table_name_and_alias
                table_alias_for table_name, @aliased_table_name
              end
2198 2199

              def interpolate_sql(sql)
2200 2201
                instance_eval("%@#{sql.gsub('@', '\@')}@")
              end
2202 2203

            private
2204 2205 2206 2207
              def join_type
                "LEFT OUTER JOIN"
              end
          end
2208 2209 2210 2211 2212 2213 2214 2215 2216
        end

        class InnerJoinDependency < JoinDependency # :nodoc:
          protected
            def build_join_association(reflection, parent)
              InnerJoinAssociation.new(reflection, self, parent)
            end

          class InnerJoinAssociation < JoinAssociation
2217 2218 2219 2220
            private
              def join_type
                "INNER JOIN"
              end
2221 2222
          end
        end
2223

2224
    end
D
Initial  
David Heinemeier Hansson 已提交
2225
  end
2226
end