associations.rb 97.2 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 9 10
require 'active_record/associations/has_and_belongs_to_many_association'

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

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

23 24 25 26 27
  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
28

D
David Heinemeier Hansson 已提交
29
  class HasManyThroughSourceAssociationNotFoundError < ActiveRecordError #:nodoc:
30
    def initialize(reflection)
31 32 33 34
      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'}?")
35 36 37
    end
  end

38
  class HasManyThroughSourceAssociationMacroError < ActiveRecordError #:nodoc:
39
    def initialize(reflection)
40 41 42
      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.")
43 44 45
    end
  end

46 47 48 49 50 51
  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

52 53 54 55 56 57
  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

58 59 60 61 62 63
  class HasManyThroughCantCountOnColumnForGroupedAssociation < ActiveRecordError #:nodoc:
    def initialize(owner, reflection, column_name)
      super("Cannot count on column '#{column_name}' for association '#{owner.class.name}##{reflection.name}' grouped by '#{reflection.options[:group]}'.")
    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

D
Initial  
David Heinemeier Hansson 已提交
76
  module Associations # :nodoc:
77
    def self.included(base)
78 79 80
      base.extend(ClassMethods)
    end

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

    # 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 已提交
91 92 93 94
    # methods. Example:
    #
    #   class Project < ActiveRecord::Base
    #     belongs_to              :portfolio
95
    #     has_one                 :project_manager
D
Initial  
David Heinemeier Hansson 已提交
96 97 98 99 100
    #     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:
101
    # * <tt>Project#portfolio, Project#portfolio=(portfolio), Project#portfolio.nil?</tt>
D
Initial  
David Heinemeier Hansson 已提交
102 103
    # * <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>
104
    #   <tt>Project#milestones.delete(milestone), Project#milestones.find(milestone_id), Project#milestones.find(:all, options),</tt>
D
Initial  
David Heinemeier Hansson 已提交
105 106 107 108
    #   <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>
    #
109 110 111 112 113 114
    # === 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.
    # For instance, #attributes and #connection would be bad choices for association names.
    #
115
    # == Auto-generated methods
D
Initial  
David Heinemeier Hansson 已提交
116
    #
117 118 119 120 121 122 123 124 125
    # ===Singular associations (one-to-one)
    #                                     |            |  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
126
    #   #other.nil?                       |     X      |      X       |
127 128 129
    #
    # ===Collection associations (one-to-many / many-to-many)
    #                                     |       |          | has_many
130
    #   generated methods                 | habtm | has_many | :through
131 132
    #   ----------------------------------+-------+----------+----------
    #   #others                           |   X   |    X     |    X
133
    #   #others=(other,other,...)         |   X   |    X     |
134
    #   #other_ids                        |   X   |    X     |    X
135
    #   #other_ids=(id,id,...)            |   X   |    X     |
136 137 138
    #   #others<<                         |   X   |    X     |    X
    #   #others.push                      |   X   |    X     |    X
    #   #others.concat                    |   X   |    X     |    X
139
    #   #others.build(attributes={})      |   X   |    X     |
140
    #   #others.create(attributes={})     |   X   |    X     |
141
    #   #others.create!(attributes={})    |   X   |    X     |    X
142 143 144
    #   #others.size                      |   X   |    X     |    X
    #   #others.length                    |   X   |    X     |    X
    #   #others.count                     |       |    X     |    X
145
    #   #others.sum(args*,&block)         |   X   |    X     |    X
146
    #   #others.empty?                    |   X   |    X     |    X
147
    #   #others.clear                     |   X   |    X     |
148
    #   #others.delete(other,other,...)   |   X   |    X     |    X
149
    #   #others.delete_all                |   X   |    X     |
150
    #   #others.destroy_all               |   X   |    X     |    X
151
    #   #others.find(*args)               |   X   |    X     |    X
152 153
    #   #others.find_first                |   X   |          |
    #   #others.uniq                      |   X   |    X     |
154
    #   #others.reset                     |   X   |    X     |    X
D
Initial  
David Heinemeier Hansson 已提交
155
    #
156
    # == Cardinality and associations
157
    #
158 159
    # ActiveRecord associations can be used to describe relations with one-to-one, one-to-many
    # and many-to-many cardinality. Each model uses an association to describe its role in
160
    # the relation. In each case, the +belongs_to+ association is used in the model that has
161
    # the foreign key.
162 163 164
    #
    # === One-to-one
    #
165
    # Use +has_one+ in the base, and +belongs_to+ in the associated model.
166 167 168 169 170 171 172 173 174 175
    #
    #   class Employee < ActiveRecord::Base
    #     has_one :office
    #   end
    #   class Office < ActiveRecord::Base
    #     belongs_to :employee    # foreign key - employee_id
    #   end
    #
    # === One-to-many
    #
176
    # Use +has_many+ in the base, and +belongs_to+ in the associated model.
177 178 179 180 181
    #
    #   class Manager < ActiveRecord::Base
    #     has_many :employees
    #   end
    #   class Employee < ActiveRecord::Base
182
    #     belongs_to :manager     # foreign key - manager_id
183 184 185 186 187 188
    #   end
    #
    # === Many-to-many
    #
    # There are two ways to build a many-to-many relationship.
    #
189
    # The first way uses a +has_many+ association with the <tt>:through</tt> option and a join model, so
190 191 192 193 194 195 196 197 198 199 200 201 202 203 204
    # 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
    #
205
    # For the second way, use +has_and_belongs_to_many+ in both models. This requires a join table
206 207 208 209 210 211 212 213 214
    # 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
    #
215
    # Choosing which way to build a many-to-many relationship is not always simple.
216
    # If you need to work with the relationship model as its own entity,
217
    # use <tt>has_many :through</tt>. Use +has_and_belongs_to_many+ when working with legacy schemas or when
218 219
    # you never work directly with the relationship itself.
    #
220
    # == Is it a +belongs_to+ or +has_one+ association?
D
Initial  
David Heinemeier Hansson 已提交
221
    #
222 223
    # 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 已提交
224
    #
225 226 227
    #   class User < ActiveRecord::Base
    #     # I reference an account.
    #     belongs_to :account
D
Initial  
David Heinemeier Hansson 已提交
228 229
    #   end
    #
230 231 232
    #   class Account < ActiveRecord::Base
    #     # One user references me.
    #     has_one :user
D
Initial  
David Heinemeier Hansson 已提交
233 234 235 236
    #   end
    #
    # The tables for these classes could look something like:
    #
237
    #   CREATE TABLE users (
D
Initial  
David Heinemeier Hansson 已提交
238
    #     id int(11) NOT NULL auto_increment,
239 240
    #     account_id int(11) default NULL,
    #     name varchar default NULL,
D
Initial  
David Heinemeier Hansson 已提交
241 242 243
    #     PRIMARY KEY  (id)
    #   )
    #
244
    #   CREATE TABLE accounts (
D
Initial  
David Heinemeier Hansson 已提交
245 246 247 248 249
    #     id int(11) NOT NULL auto_increment,
    #     name varchar default NULL,
    #     PRIMARY KEY  (id)
    #   )
    #
250 251
    # == Unsaved objects and associations
    #
252
    # You can manipulate objects and associations before they are saved to the database, but there is some special behavior you should be
253 254 255 256
    # aware of, mostly involving the saving of associated objects.
    #
    # === One-to-one associations
    #
257 258 259
    # * 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
260
    #   is cancelled.
261
    # * If you wish to assign an object to a +has_one+ association without saving it, use the <tt>#association.build</tt> method (documented below).
262
    # * Assigning an object to a +belongs_to+ association does not save the object, since the foreign key field belongs on the parent. It
263
    #   does not save the parent either.
264 265 266
    #
    # === Collections
    #
267
    # * Adding an object to a collection (+has_many+ or +has_and_belongs_to_many+) automatically saves that object, except if the parent object
268
    #   (the owner of the collection) is not yet stored in the database.
269 270 271
    # * 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).
    # * All unsaved (<tt>new_record? == true</tt>) members of the collection are automatically saved when the parent is saved.
272
    #
273
    # === Association callbacks
274
    #
275
    # Similar to the normal callbacks that hook into the lifecycle of an Active Record object, you can also define callbacks that get
276
    # triggered when you add an object to or remove an object from an association collection. Example:
277 278 279 280 281 282 283
    #
    #   class Project
    #     has_and_belongs_to_many :developers, :after_add => :evaluate_velocity
    #
    #     def evaluate_velocity(developer)
    #       ...
    #     end
284
    #   end
285 286
    #
    # It's possible to stack callbacks by passing them as an array. Example:
287
    #
288
    #   class Project
289
    #     has_and_belongs_to_many :developers, :after_add => [:evaluate_velocity, Proc.new { |p, d| p.shipping_date = Time.now}]
290 291
    #   end
    #
292
    # Possible callbacks are: +before_add+, +after_add+, +before_remove+ and +after_remove+.
293
    #
294 295
    # 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.
296
    #
297 298
    # === Association extensions
    #
299
    # The proxy objects that control the access to associations can be extended through anonymous modules. This is especially
300
    # beneficial for adding new finders, creators, and other factory-type methods that are only used as part of this association.
301 302 303
    # Example:
    #
    #   class Account < ActiveRecord::Base
304
    #     has_many :people do
305
    #       def find_or_create_by_name(name)
306
    #         first_name, last_name = name.split(" ", 2)
D
David Heinemeier Hansson 已提交
307
    #         find_or_create_by_first_name_and_last_name(first_name, last_name)
308
    #       end
309
    #     end
310 311 312 313 314 315
    #   end
    #
    #   person = Account.find(:first).people.find_or_create_by_name("David Heinemeier Hansson")
    #   person.first_name # => "David"
    #   person.last_name  # => "Heinemeier Hansson"
    #
316 317 318 319
    # 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)
320
    #       first_name, last_name = name.split(" ", 2)
D
David Heinemeier Hansson 已提交
321
    #       find_or_create_by_first_name_and_last_name(first_name, last_name)
322 323 324 325 326 327 328 329 330 331
    #     end
    #   end
    #
    #   class Account < ActiveRecord::Base
    #     has_many :people, :extend => FindOrCreateByNameExtension
    #   end
    #
    #   class Company < ActiveRecord::Base
    #     has_many :people, :extend => FindOrCreateByNameExtension
    #   end
332
    #
333
    # If you need to use multiple named extension modules, you can specify an array of modules with the <tt>:extend</tt> option.
334 335 336 337 338 339 340
    # 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
    #
341 342
    # 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:
343
    #
344 345
    # * +proxy_owner+ - Returns the object the association is part of.
    # * +proxy_reflection+ - Returns the reflection object that describes the association.
346
    # * +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+.
347
    #
R
Rick Olson 已提交
348
    # === Association Join Models
349
    #
350 351
    # 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,
352
    # callbacks, and extra attributes on the join model.  Consider the following schema:
353
    #
354 355 356 357
    #   class Author < ActiveRecord::Base
    #     has_many :authorships
    #     has_many :books, :through => :authorships
    #   end
358
    #
359 360 361 362
    #   class Authorship < ActiveRecord::Base
    #     belongs_to :author
    #     belongs_to :book
    #   end
363
    #
364 365 366
    #   @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
367
    #
368
    # You can also go through a +has_many+ association on the join model:
369
    #
370 371 372 373
    #   class Firm < ActiveRecord::Base
    #     has_many   :clients
    #     has_many   :invoices, :through => :clients
    #   end
374
    #
375 376 377 378
    #   class Client < ActiveRecord::Base
    #     belongs_to :firm
    #     has_many   :invoices
    #   end
379
    #
380 381 382 383 384 385 386 387
    #   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 已提交
388
    # === Polymorphic Associations
389 390
    #
    # Polymorphic associations on models are not restricted on what types of models they can be associated with.  Rather, they
391
    # specify an interface that a +has_many+ association must adhere to.
392
    #
R
Rick Olson 已提交
393 394 395
    #   class Asset < ActiveRecord::Base
    #     belongs_to :attachable, :polymorphic => true
    #   end
396
    #
R
Rick Olson 已提交
397
    #   class Post < ActiveRecord::Base
398
    #     has_many :assets, :as => :attachable         # The :as option specifies the polymorphic interface to use.
R
Rick Olson 已提交
399 400 401
    #   end
    #
    #   @asset.attachable = @post
402
    #
R
Rick Olson 已提交
403
    # 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
404
    # an +attachable_id+ integer column and an +attachable_type+ string column.
R
Rick Olson 已提交
405
    #
D
David Heinemeier Hansson 已提交
406
    # Using polymorphic associations in combination with single table inheritance (STI) is a little tricky. In order
407
    # for the associations to work as expected, ensure that you store the base model for the STI models in the
D
David Heinemeier Hansson 已提交
408
    # type column of the polymorphic association. To continue with the asset example above, suppose there are guest posts
409
    # 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 已提交
410 411 412
    #
    #   class Asset < ActiveRecord::Base
    #     belongs_to :attachable, :polymorphic => true
413
    #
D
David Heinemeier Hansson 已提交
414 415 416 417
    #     def attachable_type=(sType)
    #        super(sType.to_s.classify.constantize.base_class.to_s)
    #     end
    #   end
418
    #
D
David Heinemeier Hansson 已提交
419 420 421 422 423
    #   class Post < ActiveRecord::Base
    #     # because we store "Post" in attachable_type now :dependent => :destroy will work
    #     has_many :assets, :as => :attachable, :dependent => :destroy
    #   end
    #
424
    #   class GuestPost < Post
D
David Heinemeier Hansson 已提交
425 426
    #   end
    #
427
    #   class MemberPost < Post
D
David Heinemeier Hansson 已提交
428 429
    #   end
    #
D
Initial  
David Heinemeier Hansson 已提交
430 431 432
    # == Caching
    #
    # All of the methods are built on a simple caching principle that will keep the result of the last query around unless specifically
433
    # 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 已提交
434 435 436 437 438 439 440 441
    # 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
    #
442 443 444
    # == Eager loading of associations
    #
    # Eager loading is a way to find objects of a certain class and a number of named associations along with it in a single SQL call. This is
445
    # 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
446 447 448 449 450 451 452 453 454
    # triggers 101 database queries. Through the use of eager loading, the 101 queries can be reduced to 1. Example:
    #
    #   class Post < ActiveRecord::Base
    #     belongs_to :author
    #     has_many   :comments
    #   end
    #
    # Consider the following loop using the class above:
    #
455
    #   for post in Post.find(:all)
456 457 458
    #     puts "Post:            " + post.title
    #     puts "Written by:      " + post.author.name
    #     puts "Last comment on: " + post.comments.first.created_on
459
    #   end
460 461 462
    #
    # To iterate over these one hundred posts, we'll generate 201 database queries. Let's first just optimize it for retrieving the author:
    #
463
    #   for post in Post.find(:all, :include => :author)
464
    #
465 466
    # This references the name of the +belongs_to+ association that also used the <tt>:author</tt> symbol, so the find will now weave in a join something
    # like this: <tt>LEFT OUTER JOIN authors ON authors.id = posts.author_id</tt>. Doing so will cut down the number of queries from 201 to 101.
467 468 469
    #
    # We can improve upon the situation further by referencing both associations in the finder with:
    #
470
    #   for post in Post.find(:all, :include => [ :author, :comments ])
471
    #
472
    # That'll add another join along the lines of: <tt>LEFT OUTER JOIN comments ON comments.post_id = posts.id</tt>. And we'll be down to 1 query.
473
    #
474
    # To include a deep hierarchy of associations, use a hash:
475 476 477 478 479 480 481
    #
    #   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 已提交
482 483
    # 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.
484
    #
485
    # Since the eager loading pulls from multiple tables, you'll have to disambiguate any column references in both conditions and orders. So
486 487
    # <tt>:order => "posts.id DESC"</tt> will work while <tt>:order => "id DESC"</tt> will not. Because eager loading generates the +SELECT+ statement too, the
    # <tt>:select</tt> option is ignored.
488
    #
489 490
    # You can use eager loading on multiple associations from the same table, but you cannot use those associations in orders and conditions
    # as there is currently not any way to disambiguate them. Eager loading will not pull additional attributes on join tables, so "rich
491
    # associations" with +has_and_belongs_to_many+ are not a good fit for eager loading.
492
    #
493 494
    # 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.
495
    #
496 497
    # Eager loading is not supported with polymorphic associations up to (and including)
    # version 2.0.2. Given
498 499 500 501 502 503 504 505 506 507 508 509
    #
    #   class Address < ActiveRecord::Base
    #     belongs_to :addressable, :polymorphic => true
    #   end
    #
    # a call that tries to eager load the addressable model
    #
    #   Address.find(:all, :include => :addressable)   # INVALID
    #
    # will raise <tt>ActiveRecord::EagerLoadPolymorphicError</tt>. 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 early query.
    #
510 511 512
    # In versions greater than 2.0.2 eager loading in polymorphic associations is supported
    # thanks to a change in the overall preloading strategy.
    #
513 514 515
    # It does work the other way around though: if the <tt>User</tt> model is <tt>addressable</tt> you can eager load
    # their addresses with <tt>:include</tt> just fine, every piece needed to construct the query is known beforehand.
    #
516 517 518
    # == Table Aliasing
    #
    # ActiveRecord uses table aliasing in the case that a table is referenced multiple times in a join.  If a table is referenced only once,
519
    # the standard table name is used.  The second time, the table is aliased as <tt>#{reflection_name}_#{parent_table_name}</tt>.  Indexes are appended
520
    # for any more successive uses of the table name.
521
    #
522 523 524 525 526 527
    #   Post.find :all, :include => :comments
    #   # => SELECT ... FROM posts LEFT OUTER JOIN comments ON ...
    #   Post.find :all, :include => :special_comments # STI
    #   # => SELECT ... FROM posts LEFT OUTER JOIN comments ON ... AND comments.type = 'SpecialComment'
    #   Post.find :all, :include => [:comments, :special_comments] # special_comments is the reflection name, posts is the parent table name
    #   # => SELECT ... FROM posts LEFT OUTER JOIN comments ON ... LEFT OUTER JOIN comments special_comments_posts
528
    #
529
    # Acts as tree example:
530
    #
531 532 533
    #   TreeMixin.find :all, :include => :children
    #   # => SELECT ... FROM mixins LEFT OUTER JOIN mixins childrens_mixins ...
    #   TreeMixin.find :all, :include => {:children => :parent} # using cascading eager includes
534 535 536 537
    #   # => SELECT ... FROM mixins LEFT OUTER JOIN mixins childrens_mixins ...
    #                               LEFT OUTER JOIN parents_mixins ...
    #   TreeMixin.find :all, :include => {:children => {:parent => :children}}
    #   # => SELECT ... FROM mixins LEFT OUTER JOIN mixins childrens_mixins ...
538
    #                               LEFT OUTER JOIN parents_mixins ...
539
    #                               LEFT OUTER JOIN mixins childrens_mixins_2
540
    #
541
    # Has and Belongs to Many join tables use the same idea, but add a <tt>_join</tt> suffix:
542
    #
543 544 545 546 547 548 549 550 551
    #   Post.find :all, :include => :categories
    #   # => SELECT ... FROM posts LEFT OUTER JOIN categories_posts ... LEFT OUTER JOIN categories ...
    #   Post.find :all, :include => {:categories => :posts}
    #   # => SELECT ... FROM posts LEFT OUTER JOIN categories_posts ... LEFT OUTER JOIN categories ...
    #                              LEFT OUTER JOIN categories_posts posts_categories_join LEFT OUTER JOIN posts posts_categories
    #   Post.find :all, :include => {:categories => {:posts => :categories}}
    #   # => SELECT ... FROM posts LEFT OUTER JOIN categories_posts ... LEFT OUTER JOIN categories ...
    #                              LEFT OUTER JOIN categories_posts posts_categories_join LEFT OUTER JOIN posts posts_categories
    #                              LEFT OUTER JOIN categories_posts categories_posts_join LEFT OUTER JOIN categories categories_posts
552
    #
553
    # 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:
554
    #
555 556 557
    #   Post.find :all, :include => :comments, :joins => "inner join comments ..."
    #   # => SELECT ... FROM posts LEFT OUTER JOIN comments_posts ON ... INNER JOIN comments ...
    #   Post.find :all, :include => [:comments, :special_comments], :joins => "inner join comments ..."
558
    #   # => SELECT ... FROM posts LEFT OUTER JOIN comments comments_posts ON ...
559 560
    #                              LEFT OUTER JOIN comments special_comments_posts ...
    #                              INNER JOIN comments ...
561
    #
562
    # Table aliases are automatically truncated according to the maximum length of table identifiers according to the specific database.
563
    #
D
Initial  
David Heinemeier Hansson 已提交
564 565 566 567 568 569 570 571 572 573 574 575 576 577
    # == 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
    #
    #       class Company < ActiveRecord::Base; end
    #     end
    #   end
    #
578 579
    # When <tt>Firm#clients</tt> is called, it will in turn call <tt>MyApplication::Business::Company.find(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 已提交
580 581 582 583 584 585 586 587 588 589 590 591 592
    #
    #   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
    #
593
    # == Type safety with <tt>ActiveRecord::AssociationTypeMismatch</tt>
D
Initial  
David Heinemeier Hansson 已提交
594 595
    #
    # If you attempt to assign an object to an association that doesn't match the inferred or specified <tt>:class_name</tt>, you'll
596
    # get an <tt>ActiveRecord::AssociationTypeMismatch</tt>.
D
Initial  
David Heinemeier Hansson 已提交
597 598 599
    #
    # == Options
    #
600
    # 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 已提交
601 602
    # possible.
    module ClassMethods
603
      # Adds the following methods for retrieval and query of collections of associated objects:
604
      # +collection+ is replaced with the symbol passed as the first argument, so
605
      # <tt>has_many :clients</tt> would add among others <tt>clients.empty?</tt>.
D
Initial  
David Heinemeier Hansson 已提交
606 607 608
      # * <tt>collection(force_reload = false)</tt> - returns an array of all the associated objects.
      #   An empty array is returned if none are found.
      # * <tt>collection<<(object, ...)</tt> - adds one or more objects to the collection by setting their foreign keys to the collection's primary key.
609
      # * <tt>collection.delete(object, ...)</tt> - removes one or more objects from the collection by setting their foreign keys to NULL.
610
      #   This will also destroy the objects if they're declared as +belongs_to+ and dependent on this model.
611
      # * <tt>collection=objects</tt> - replaces the collections content by deleting and adding objects as appropriate.
612
      # * <tt>collection_singular_ids</tt> - returns an array of the associated objects' ids
613
      # * <tt>collection_singular_ids=ids</tt> - replace the collection with the objects identified by the primary keys in +ids+
614
      # * <tt>collection.clear</tt> - removes every object from the collection. This destroys the associated objects if they
615
      #   are associated with <tt>:dependent => :destroy</tt>, deletes them directly from the database if <tt>:dependent => :delete_all</tt>,
616
      #   otherwise sets their foreign keys to NULL.
617
      # * <tt>collection.empty?</tt> - returns +true+ if there are no associated objects.
D
Initial  
David Heinemeier Hansson 已提交
618
      # * <tt>collection.size</tt> - returns the number of associated objects.
619
      # * <tt>collection.find</tt> - finds an associated object according to the same rules as Base.find.
R
Rick Olson 已提交
620
      # * <tt>collection.build(attributes = {}, ...)</tt> - returns one or more new objects of the collection type that have been instantiated
621
      #   with +attributes+ and linked to this object through a foreign key, but have not yet been saved. *Note:* This only works if an
622
      #   associated object already exists, not if it's +nil+!
D
Initial  
David Heinemeier Hansson 已提交
623
      # * <tt>collection.create(attributes = {})</tt> - returns a new object of the collection type that has been instantiated
624 625
      #   with +attributes+, linked to this object through a foreign key, and that has already been saved (if it passed the validation).
      #   *Note:* This only works if an associated object already exists, not if it's +nil+!
D
Initial  
David Heinemeier Hansson 已提交
626
      #
627
      # Example: A +Firm+ class declares <tt>has_many :clients</tt>, which will add:
628
      # * <tt>Firm#clients</tt> (similar to <tt>Clients.find :all, :conditions => "firm_id = #{id}"</tt>)
D
Initial  
David Heinemeier Hansson 已提交
629 630
      # * <tt>Firm#clients<<</tt>
      # * <tt>Firm#clients.delete</tt>
631
      # * <tt>Firm#clients=</tt>
632
      # * <tt>Firm#client_ids</tt>
633
      # * <tt>Firm#client_ids=</tt>
D
Initial  
David Heinemeier Hansson 已提交
634 635 636
      # * <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>)
637
      # * <tt>Firm#clients.find</tt> (similar to <tt>Client.find(id, :conditions => "firm_id = #{id}")</tt>)
D
Initial  
David Heinemeier Hansson 已提交
638
      # * <tt>Firm#clients.build</tt> (similar to <tt>Client.new("firm_id" => id)</tt>)
D
David Heinemeier Hansson 已提交
639
      # * <tt>Firm#clients.create</tt> (similar to <tt>c = Client.new("firm_id" => id); c.save; c</tt>)
D
Initial  
David Heinemeier Hansson 已提交
640
      # The declaration can also include an options hash to specialize the behavior of the association.
641
      #
D
Initial  
David Heinemeier Hansson 已提交
642
      # Options are:
643
      # * <tt>:class_name</tt>  - specify the class name of the association. Use it only if that name can't be inferred
D
Initial  
David Heinemeier Hansson 已提交
644 645
      #   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.
646 647 648 649
      # * <tt>:conditions</tt>  - specify the conditions that the associated objects must meet in order to be included as a +WHERE+
      #   SQL fragment, such as <tt>price > 5 AND name LIKE 'B%'</tt>.
      # * <tt>:order</tt>       - specify the order in which the associated objects are returned as an <tt>ORDER BY</tt> SQL fragment,
      #   such as <tt>last_name, first_name DESC</tt>
D
Initial  
David Heinemeier Hansson 已提交
650
      # * <tt>:foreign_key</tt> - specify the foreign key used for the association. By default this is guessed to be the name
651 652 653 654 655 656
      #   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 +foreign_key+.
      # * <tt>:dependent</tt>   - if set to <tt>:destroy</tt> all the associated objects are destroyed
      #   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.
D
Initial  
David Heinemeier Hansson 已提交
657
      # * <tt>:finder_sql</tt>  - specify a complete SQL statement to fetch the association. This is a good way to go for complex
D
David Heinemeier Hansson 已提交
658
      #   associations that depend on multiple tables. Note: When this option is used, +find_in_collection+ is _not_ added.
659
      # * <tt>:counter_sql</tt>  - specify a complete SQL statement to fetch the size of the association. If <tt>:finder_sql</tt> is
660
      #   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>.
661
      # * <tt>:extend</tt>  - specify a named module for extending the proxy. See "Association extensions".
662
      # * <tt>:include</tt>  - specify second-order associations that should be eager loaded when the collection is loaded.
663
      # * <tt>:group</tt>: An attribute name by which the result should be grouped. Uses the <tt>GROUP BY</tt> SQL-clause.
664 665
      # * <tt>:limit</tt>: An integer determining the limit on the number of rows that should be returned.
      # * <tt>:offset</tt>: An integer determining the offset from where the rows should be fetched. So at 5, it would skip the first 4 rows.
666
      # * <tt>:select</tt>: 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
667 668
      #   but not include the joined columns.
      # * <tt>:as</tt>: Specifies a polymorphic interface (See <tt>#belongs_to</tt>).
669
      # * <tt>:through</tt>: Specifies a Join Model through which to perform the query.  Options for <tt>:class_name</tt> and <tt>:foreign_key</tt>
670 671
      #   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.
672
      # * <tt>:source</tt>: Specifies the source association name used by <tt>has_many :through</tt> queries.  Only use it if the name cannot be
673 674 675 676 677
      #   inferred from the association.  <tt>has_many :subscribers, :through => :subscriptions</tt> will look for either <tt>:subscribers</tt> or
      #   <tt>:subscriber</tt> on +Subscription+, unless a <tt>:source</tt> is given.
      # * <tt>:source_type</tt>: Specifies type of the source association used by <tt>has_many :through</tt> queries where the source
      #   association is a polymorphic +belongs_to+.
      # * <tt>:uniq</tt> - if set to +true+, duplicates will be omitted from the collection. Useful in conjunction with <tt>:through</tt>.
D
Initial  
David Heinemeier Hansson 已提交
678 679 680
      #
      # Option examples:
      #   has_many :comments, :order => "posted_on"
681
      #   has_many :comments, :include => :author
D
Initial  
David Heinemeier Hansson 已提交
682
      #   has_many :people, :class_name => "Person", :conditions => "deleted = 0", :order => "name"
683 684
      #   has_many :tracks, :order => "position", :dependent => :destroy
      #   has_many :comments, :dependent => :nullify
R
Rick Olson 已提交
685
      #   has_many :tags, :as => :taggable
686
      #   has_many :subscribers, :through => :subscriptions, :source => :user
D
Initial  
David Heinemeier Hansson 已提交
687 688 689 690 691
      #   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'
692
      def has_many(association_id, options = {}, &extension)
693
        reflection = create_has_many_reflection(association_id, options, &extension)
694

695
        configure_dependency_for_has_many(reflection)
696

697
        if options[:through]
698
          collection_accessor_methods(reflection, HasManyThroughAssociation, false)
699 700 701 702
        else
          add_multiple_associated_save_callbacks(reflection.name)
          add_association_callbacks(reflection.name, reflection.options)
          collection_accessor_methods(reflection, HasManyAssociation)
D
Initial  
David Heinemeier Hansson 已提交
703 704 705
        end
      end

706
      # Adds the following methods for retrieval and query of a single associated object:
707
      # +association+ is replaced with the symbol passed as the first argument, so
708
      # <tt>has_one :manager</tt> would add among others <tt>manager.nil?</tt>.
709
      # * <tt>association(force_reload = false)</tt> - returns the associated object. +nil+ is returned if none is found.
710
      # * <tt>association=(associate)</tt> - assigns the associate object, extracts the primary key, sets it as the foreign key,
D
Initial  
David Heinemeier Hansson 已提交
711
      #   and saves the associate object.
712
      # * <tt>association.nil?</tt> - returns +true+ if there is no associated object.
713
      # * <tt>build_association(attributes = {})</tt> - returns a new object of the associated type that has been instantiated
714 715
      #   with +attributes+ and linked to this object through a foreign key, but has not yet been saved. Note: This ONLY works if
      #   an association already exists. It will NOT work if the association is +nil+.
716
      # * <tt>create_association(attributes = {})</tt> - returns a new object of the associated type that has been instantiated
717
      #   with +attributes+, linked to this object through a foreign key, and that has already been saved (if it passed the validation).
D
Initial  
David Heinemeier Hansson 已提交
718 719
      #
      # Example: An Account class declares <tt>has_one :beneficiary</tt>, which will add:
720
      # * <tt>Account#beneficiary</tt> (similar to <tt>Beneficiary.find(:first, :conditions => "account_id = #{id}")</tt>)
D
Initial  
David Heinemeier Hansson 已提交
721 722
      # * <tt>Account#beneficiary=(beneficiary)</tt> (similar to <tt>beneficiary.account_id = account.id; beneficiary.save</tt>)
      # * <tt>Account#beneficiary.nil?</tt>
723 724 725
      # * <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>)
      #
D
Initial  
David Heinemeier Hansson 已提交
726
      # The declaration can also include an options hash to specialize the behavior of the association.
727
      #
D
Initial  
David Heinemeier Hansson 已提交
728
      # Options are:
729
      # * <tt>:class_name</tt>  - specify the class name of the association. Use it only if that name can't be inferred
D
Initial  
David Heinemeier Hansson 已提交
730 731
      #   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.
732 733
      # * <tt>:conditions</tt>  - specify the conditions that the associated object must meet in order to be included as a +WHERE+
      #   SQL fragment, such as <tt>rank = 5</tt>.
734 735
      # * <tt>:order</tt>       - specify the order in which the associated objects are returned as an <tt>ORDER BY</tt> SQL fragment,
      #   such as <tt>last_name, first_name DESC</tt>
736
      # * <tt>:dependent</tt>   - if set to <tt>:destroy</tt>, the associated object is destroyed when this object is. If set to
737 738
      #   <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.
D
Initial  
David Heinemeier Hansson 已提交
739
      # * <tt>:foreign_key</tt> - specify the foreign key used for the association. By default this is guessed to be the name
740 741
      #   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 +foreign_key+.
742
      # * <tt>:include</tt>  - specify second-order associations that should be eager loaded when this object is loaded.
743
      # * <tt>:as</tt>: Specifies a polymorphic interface (See <tt>#belongs_to</tt>).
744
            #
D
Initial  
David Heinemeier Hansson 已提交
745
      # Option examples:
746
      #   has_one :credit_card, :dependent => :destroy  # destroys the associated credit card
747
      #   has_one :credit_card, :dependent => :nullify  # updates the associated records foreign key value to NULL rather than destroying it
D
Initial  
David Heinemeier Hansson 已提交
748 749
      #   has_one :last_comment, :class_name => "Comment", :order => "posted_on"
      #   has_one :project_manager, :class_name => "Person", :conditions => "role = 'project_manager'"
750
      #   has_one :attachment, :as => :attachable
D
Initial  
David Heinemeier Hansson 已提交
751
      def has_one(association_id, options = {})
752
        reflection = create_has_one_reflection(association_id, options)
D
Initial  
David Heinemeier Hansson 已提交
753

754 755
        ivar = "@#{reflection.name}"

756 757
        module_eval do
          after_save <<-EOF
758 759
            association = instance_variable_get("#{ivar}") if instance_variable_defined?("#{ivar}")

760
            if !association.nil? && (new_record? || association.new_record? || association["#{reflection.primary_key_name}"] != id)
761
              association["#{reflection.primary_key_name}"] = id
762 763 764 765
              association.save(true)
            end
          EOF
        end
766

767 768 769
        association_accessor_methods(reflection, HasOneAssociation)
        association_constructor_method(:build,  reflection, HasOneAssociation)
        association_constructor_method(:create, reflection, HasOneAssociation)
770

771
        configure_dependency_for_has_one(reflection)
D
Initial  
David Heinemeier Hansson 已提交
772 773
      end

774
      # Adds the following methods for retrieval and query for a single associated object for which this object holds an id:
775
      # +association+ is replaced with the symbol passed as the first argument, so
776
      # <tt>belongs_to :author</tt> would add among others <tt>author.nil?</tt>.
777
      # * <tt>association(force_reload = false)</tt> - returns the associated object. +nil+ is returned if none is found.
D
Initial  
David Heinemeier Hansson 已提交
778
      # * <tt>association=(associate)</tt> - assigns the associate object, extracts the primary key, and sets it as the foreign key.
779
      # * <tt>association.nil?</tt> - returns +true+ if there is no associated object.
780
      # * <tt>build_association(attributes = {})</tt> - returns a new object of the associated type that has been instantiated
781
      #   with +attributes+ and linked to this object through a foreign key, but has not yet been saved.
782
      # * <tt>create_association(attributes = {})</tt> - returns a new object of the associated type that has been instantiated
783
      #   with +attributes+, linked to this object through a foreign key, and that has already been saved (if it passed the validation).
D
Initial  
David Heinemeier Hansson 已提交
784
      #
785
      # Example: A Post class declares <tt>belongs_to :author</tt>, which will add:
D
Initial  
David Heinemeier Hansson 已提交
786 787 788 789
      # * <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 已提交
790 791
      # * <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 已提交
792
      # The declaration can also include an options hash to specialize the behavior of the association.
793
      #
D
Initial  
David Heinemeier Hansson 已提交
794
      # Options are:
795
      # * <tt>:class_name</tt>  - specify the class name of the association. Use it only if that name can't be inferred
D
Initial  
David Heinemeier Hansson 已提交
796 797
      #   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.
798 799
      # * <tt>:conditions</tt>  - specify the conditions that the associated object must meet in order to be included as a +WHERE+
      #   SQL fragment, such as <tt>authorized = 1</tt>.
800 801
      # * <tt>:order</tt>       - specify the order in which the associated objects are returned as an <tt>ORDER BY</tt> SQL fragment,
      #   such as <tt>last_name, first_name DESC</tt>
D
Initial  
David Heinemeier Hansson 已提交
802
      # * <tt>:foreign_key</tt> - specify the foreign key used for the association. By default this is guessed to be the name
803 804
      #   of the association with an +_id+ suffix. So a class that defines a +belongs_to :person+ association will use +person_id+ as the default +foreign_key+.
      #   Similarly, +belongs_to :favorite_person, :class_name => "Person"+ will use a foreign key of +favorite_person_id+.
805 806 807 808
      # * <tt>:dependent</tt>   - if set to <tt>:destroy</tt>, the associated object is destroyed when this object is. If set to
      #   <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.
809
      # * <tt>:counter_cache</tt> - caches the number of belonging objects on the associate class through the use of +increment_counter+
810 811
      #   and +decrement_counter+. The counter cache is incremented when an object of this class is created and decremented when it's
      #   destroyed. This requires that a column named <tt>#{table_name}_count</tt> (such as +comments_count+ for a belonging +Comment+ class)
812
      #   is used on the associate class (such as a +Post+ class). You can also specify a custom counter cache column by providing
813
      #   a column name instead of a +true+/+false+ value to this option (e.g., <tt>:counter_cache => :my_custom_counter</tt>.)
814
      #   Note: Specifying a counter_cache will add it to that model's list of readonly attributes using #attr_readonly.
815
      # * <tt>:include</tt>  - specify second-order associations that should be eager loaded when this object is loaded.
816
      #   Not allowed if the association is polymorphic.
817
      # * <tt>:polymorphic</tt> - specify this association is a polymorphic association by passing +true+.
818
      #   Note: If you've enabled the counter cache, then you may want to add the counter cache attribute
819
      #   to the attr_readonly list in the associated classes (e.g. class Post; attr_readonly :comments_count; end).
D
Initial  
David Heinemeier Hansson 已提交
820 821 822 823
      #
      # Option examples:
      #   belongs_to :firm, :foreign_key => "client_of"
      #   belongs_to :author, :class_name => "Person", :foreign_key => "author_id"
824
      #   belongs_to :valid_coupon, :class_name => "Coupon", :foreign_key => "coupon_id",
D
Initial  
David Heinemeier Hansson 已提交
825
      #              :conditions => 'discounts > #{payments_count}'
R
Rick Olson 已提交
826
      #   belongs_to :attachable, :polymorphic => true
827
      def belongs_to(association_id, options = {})
828
        reflection = create_belongs_to_reflection(association_id, options)
829 830 831

        ivar = "@#{reflection.name}"

832 833
        if reflection.options[:polymorphic]
          association_accessor_methods(reflection, BelongsToPolymorphicAssociation)
834 835 836

          module_eval do
            before_save <<-EOF
837 838
              association = instance_variable_get("#{ivar}") if instance_variable_defined?("#{ivar}")

839
              if association && association.target
840
                if association.new_record?
841 842
                  association.save(true)
                end
843

844
                if association.updated?
845
                  self["#{reflection.primary_key_name}"] = association.id
846
                  self["#{reflection.options[:foreign_type]}"] = association.class.base_class.name.to_s
847
                end
848
              end
849 850 851
            EOF
          end
        else
852 853 854
          association_accessor_methods(reflection, BelongsToAssociation)
          association_constructor_method(:build,  reflection, BelongsToAssociation)
          association_constructor_method(:create, reflection, BelongsToAssociation)
855 856 857

          module_eval do
            before_save <<-EOF
858 859 860
              association = instance_variable_get("#{ivar}") if instance_variable_defined?("#{ivar}")

              if !association.nil?
861
                if association.new_record?
862 863
                  association.save(true)
                end
864

865
                if association.updated?
866
                  self["#{reflection.primary_key_name}"] = association.id
867
                end
868
              end
869 870 871
            EOF
          end
        end
872

873
        # Create the callbacks to update counter cache
874
        if options[:counter_cache]
875 876 877 878
          cache_column = options[:counter_cache] == true ?
            "#{self.to_s.underscore.pluralize}_count" :
            options[:counter_cache]

879
          module_eval(
880
            "after_create '#{reflection.name}.class.increment_counter(\"#{cache_column}\", #{reflection.primary_key_name})" +
881 882 883 884
            " unless #{reflection.name}.nil?'"
          )

          module_eval(
885
            "before_destroy '#{reflection.name}.class.decrement_counter(\"#{cache_column}\", #{reflection.primary_key_name})" +
886
            " unless #{reflection.name}.nil?'"
887
          )
888

889
          module_eval(
890
            "#{reflection.class_name}.send(:attr_readonly,\"#{cache_column}\".intern) if defined?(#{reflection.class_name}) && #{reflection.class_name}.respond_to?(:attr_readonly)"
891
          )
892
        end
893 894

        configure_dependency_for_belongs_to(reflection)
895 896
      end

D
Initial  
David Heinemeier Hansson 已提交
897
      # Associates two classes via an intermediate join table.  Unless the join table is explicitly specified as
898 899
      # an option, it is guessed using the lexical order of the class names. So a join between +Developer+ and +Project+
      # will give the default join table name of +developers_projects+ because "D" outranks "P".  Note that this precedence
900
      # is calculated using the <tt><</tt> operator for <tt>String</tt>.  This means that if the strings are of different lengths,
901
      # and the strings are equal when compared up to the shortest length, then the longer string is considered of higher
902
      # lexical precedence than the shorter one.  For example, one would expect the tables <tt>paper_boxes</tt> and <tt>papers</tt>
903
      # to generate a join table name of <tt>papers_paper_boxes</tt> because of the length of the name <tt>paper_boxes</tt>,
904
      # but it in fact generates a join table name of <tt>paper_boxes_papers</tt>.  Be aware of this caveat, and use the
905
      # custom <tt>join_table</tt> option if you need to.
D
Initial  
David Heinemeier Hansson 已提交
906
      #
907
      # Deprecated: Any additional fields added to the join table will be placed as attributes when pulling records out through
908
      # +has_and_belongs_to_many+ associations. Records returned from join tables with additional attributes will be marked as
909
      # +ReadOnly+ (because we can't save changes to the additional attributes). It's strongly recommended that you upgrade any
910
      # associations with attributes to a real join model (see introduction).
D
Initial  
David Heinemeier Hansson 已提交
911
      #
912
      # Adds the following methods for retrieval and query:
913
      # +collection+ is replaced with the symbol passed as the first argument, so
914
      # <tt>has_and_belongs_to_many :categories</tt> would add among others <tt>categories.empty?</tt>.
D
Initial  
David Heinemeier Hansson 已提交
915
      # * <tt>collection(force_reload = false)</tt> - returns an array of all the associated objects.
916
      #   An empty array is returned if none are found.
917
      # * <tt>collection<<(object, ...)</tt> - adds one or more objects to the collection by creating associations in the join table
918
      #   (<tt>collection.push</tt> and <tt>collection.concat</tt> are aliases to this method).
919
      # * <tt>collection.delete(object, ...)</tt> - removes one or more objects from the collection by removing their associations from the join table.
D
Initial  
David Heinemeier Hansson 已提交
920
      #   This does not destroy the objects.
921 922
      # * <tt>collection=objects</tt> - replaces the collection's content by deleting and adding objects as appropriate.
      # * <tt>collection_singular_ids</tt> - returns an array of the associated objects' ids
923
      # * <tt>collection_singular_ids=ids</tt> - replace the collection by the objects identified by the primary keys in +ids+
D
Initial  
David Heinemeier Hansson 已提交
924
      # * <tt>collection.clear</tt> - removes every object from the collection. This does not destroy the objects.
925
      # * <tt>collection.empty?</tt> - returns +true+ if there are no associated objects.
D
Initial  
David Heinemeier Hansson 已提交
926
      # * <tt>collection.size</tt> - returns the number of associated objects.
927 928
      # * <tt>collection.find(id)</tt> - finds an associated object responding to the +id+ and that
      #   meets the condition that it has to be associated with this object.
929
      # * <tt>collection.build(attributes = {})</tt> - returns a new object of the collection type that has been instantiated
930
      #   with +attributes+ and linked to this object through the join table, but has not yet been saved.
931
      # * <tt>collection.create(attributes = {})</tt> - returns a new object of the collection type that has been instantiated
932
      #   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 已提交
933
      #
934
      # Example: A Developer class declares <tt>has_and_belongs_to_many :projects</tt>, which will add:
D
Initial  
David Heinemeier Hansson 已提交
935 936 937
      # * <tt>Developer#projects</tt>
      # * <tt>Developer#projects<<</tt>
      # * <tt>Developer#projects.delete</tt>
938
      # * <tt>Developer#projects=</tt>
939
      # * <tt>Developer#project_ids</tt>
940
      # * <tt>Developer#project_ids=</tt>
D
Initial  
David Heinemeier Hansson 已提交
941 942 943 944
      # * <tt>Developer#projects.clear</tt>
      # * <tt>Developer#projects.empty?</tt>
      # * <tt>Developer#projects.size</tt>
      # * <tt>Developer#projects.find(id)</tt>
945 946
      # * <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 已提交
947
      # The declaration may include an options hash to specialize the behavior of the association.
948
      #
D
Initial  
David Heinemeier Hansson 已提交
949
      # Options are:
950
      # * <tt>:class_name</tt> - specify the class name of the association. Use it only if that name can't be inferred
951
      #   from the association name. So <tt>has_and_belongs_to_many :projects</tt> will by default be linked to the
D
Initial  
David Heinemeier Hansson 已提交
952 953
      #   +Project+ class, but if the real class name is +SuperProject+, you'll have to specify it with this option.
      # * <tt>:join_table</tt> - specify the name of the join table if the default based on lexical order isn't what you want.
954 955
      #   WARNING: 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.
D
Initial  
David Heinemeier Hansson 已提交
956
      # * <tt>:foreign_key</tt> - specify the foreign key used for the association. By default this is guessed to be the name
957 958
      #   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 +foreign_key+.
D
Initial  
David Heinemeier Hansson 已提交
959
      # * <tt>:association_foreign_key</tt> - specify the association foreign key used for the association. By default this is
960 961 962 963
      #   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 association +foreign_key+.
      # * <tt>:conditions</tt>  - specify the conditions that the associated object must meet in order to be included as a +WHERE+
      #   SQL fragment, such as <tt>authorized = 1</tt>.
964 965
      # * <tt>:order</tt> - specify the order in which the associated objects are returned as an <tt>ORDER BY</tt> SQL fragment,
      #   such as <tt>last_name, first_name DESC</tt>
966 967
      # * <tt>:uniq</tt> - if set to +true+, duplicate associated objects will be ignored by accessors and query methods
      # * <tt>:finder_sql</tt> - overwrite the default generated SQL statement used to fetch the association with a manual statement
968
      # * <tt>:delete_sql</tt> - overwrite the default generated SQL statement used to remove links between the associated
969 970 971
      #   classes with a manual statement
      # * <tt>:insert_sql</tt> - overwrite the default generated SQL statement used to add links between the associated classes
      #   with a manual statement
972
      # * <tt>:extend</tt>  - anonymous module for extending the proxy, see "Association extensions".
973
      # * <tt>:include</tt>  - specify second-order associations that should be eager loaded when the collection is loaded.
974
      # * <tt>:group</tt>: An attribute name by which the result should be grouped. Uses the <tt>GROUP BY</tt> SQL-clause.
975 976
      # * <tt>:limit</tt>: An integer determining the limit on the number of rows that should be returned.
      # * <tt>:offset</tt>: An integer determining the offset from where the rows should be fetched. So at 5, it would skip the first 4 rows.
977 978
      # * <tt>:select</tt>: 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
      #   but not include the joined columns.
D
Initial  
David Heinemeier Hansson 已提交
979 980 981
      #
      # Option examples:
      #   has_and_belongs_to_many :projects
982
      #   has_and_belongs_to_many :projects, :include => [ :milestones, :manager ]
D
Initial  
David Heinemeier Hansson 已提交
983 984
      #   has_and_belongs_to_many :nations, :class_name => "Country"
      #   has_and_belongs_to_many :categories, :join_table => "prods_cats"
985
      #   has_and_belongs_to_many :active_projects, :join_table => 'developers_projects', :delete_sql =>
986
      #   'DELETE FROM developers_projects WHERE active=1 AND developer_id = #{id} AND project_id = #{record.id}'
987
      def has_and_belongs_to_many(association_id, options = {}, &extension)
988
        reflection = create_has_and_belongs_to_many_reflection(association_id, options, &extension)
989

990 991
        add_multiple_associated_save_callbacks(reflection.name)
        collection_accessor_methods(reflection, HasAndBelongsToManyAssociation)
D
Initial  
David Heinemeier Hansson 已提交
992

993 994
        # Don't use a before_destroy callback since users' before_destroy
        # callbacks will be executed after the association is wiped out.
995
        old_method = "destroy_without_habtm_shim_for_#{reflection.name}"
996
        class_eval <<-end_eval unless method_defined?(old_method)
997 998
          alias_method :#{old_method}, :destroy_without_callbacks
          def destroy_without_callbacks
999
            #{reflection.name}.clear
1000 1001 1002 1003
            #{old_method}
          end
        end_eval

1004
        add_association_callbacks(reflection.name, options)
D
Initial  
David Heinemeier Hansson 已提交
1005 1006 1007
      end

      private
1008 1009 1010 1011 1012 1013
        # Generate a join table name from two provided tables names.
        # The order of names in join name is determined by lexical precedence.
        #   join_table_name("members", "clubs")
        #   => "clubs_members"
        #   join_table_name("members", "special_clubs")
        #   => "members_special_clubs"
D
Initial  
David Heinemeier Hansson 已提交
1014 1015 1016 1017 1018 1019 1020 1021 1022
        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
1023

1024
        def association_accessor_methods(reflection, association_proxy_class)
1025 1026
          ivar = "@#{reflection.name}"

1027
          define_method(reflection.name) do |*params|
1028
            force_reload = params.first unless params.empty?
1029 1030

            association = instance_variable_get(ivar) if instance_variable_defined?(ivar)
1031 1032 1033

            if association.nil? || force_reload
              association = association_proxy_class.new(self, reflection)
1034
              retval = association.reload
1035
              if retval.nil? and association_proxy_class == BelongsToAssociation
1036
                instance_variable_set(ivar, nil)
1037 1038
                return nil
              end
1039
              instance_variable_set(ivar, association)
1040
            end
1041 1042

            association.target.nil? ? nil : association
1043 1044
          end

1045
          define_method("#{reflection.name}=") do |new_value|
1046 1047
            association = instance_variable_get(ivar) if instance_variable_defined?(ivar)

1048
            if association.nil? || association.target != new_value
1049
              association = association_proxy_class.new(self, reflection)
1050
            end
1051

1052
            association.replace(new_value)
1053

1054
            instance_variable_set(ivar, new_value.nil? ? nil : association)
1055
          end
1056

1057
          define_method("set_#{reflection.name}_target") do |target|
1058
            return if target.nil? and association_proxy_class == BelongsToAssociation
1059
            association = association_proxy_class.new(self, reflection)
1060
            association.target = target
1061
            instance_variable_set(ivar, association)
1062
          end
1063 1064
        end

1065 1066
        def collection_reader_method(reflection, association_proxy_class)
          define_method(reflection.name) do |*params|
1067 1068
            ivar = "@#{reflection.name}"

1069
            force_reload = params.first unless params.empty?
1070
            association = instance_variable_get(ivar) if instance_variable_defined?(ivar)
1071

1072
            unless association.respond_to?(:loaded?)
1073
              association = association_proxy_class.new(self, reflection)
1074
              instance_variable_set(ivar, association)
D
Initial  
David Heinemeier Hansson 已提交
1075
            end
1076

1077
            association.reload if force_reload
1078

1079 1080
            association
          end
1081 1082 1083 1084

          define_method("#{reflection.name.to_s.singularize}_ids") do
            send(reflection.name).map(&:id)
          end
1085
        end
D
Initial  
David Heinemeier Hansson 已提交
1086

1087
        def collection_accessor_methods(reflection, association_proxy_class, writer = true)
1088 1089
          collection_reader_method(reflection, association_proxy_class)

1090 1091 1092 1093 1094 1095 1096
          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
1097

1098 1099 1100 1101
            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
1102
          end
D
Initial  
David Heinemeier Hansson 已提交
1103 1104
        end

1105
        def add_multiple_associated_save_callbacks(association_name)
1106
          method_name = "validate_associated_records_for_#{association_name}".to_sym
1107 1108
          ivar = "@#{association_name}"

1109
          define_method(method_name) do
1110 1111
            association = instance_variable_get(ivar) if instance_variable_defined?(ivar)

1112
            if association.respond_to?(:loaded?)
1113
              if new_record?
1114
                association
1115
              elsif association.loaded?
1116
                association.select { |record| record.new_record? }
1117 1118
              else
                association.target.select { |record| record.new_record? }
1119 1120
              end.each do |record|
                errors.add "#{association_name}" unless record.valid?
D
Initial  
David Heinemeier Hansson 已提交
1121
              end
1122
            end
1123
          end
D
Initial  
David Heinemeier Hansson 已提交
1124

1125
          validate method_name
1126
          before_save("@new_record_before_save = new_record?; true")
1127 1128

          after_callback = <<-end_eval
1129
            association = instance_variable_get("#{ivar}") if instance_variable_defined?("#{ivar}")
1130

1131 1132 1133 1134
            records_to_save = if @new_record_before_save
              association
            elsif association.respond_to?(:loaded?) && association.loaded?
              association.select { |record| record.new_record? }
1135 1136
            elsif association.respond_to?(:loaded?) && !association.loaded?
              association.target.select { |record| record.new_record? }
1137 1138 1139 1140
            else
              []
            end

1141
            records_to_save.each { |record| association.send(:insert_record, record) } unless records_to_save.blank?
1142

1143 1144
            # reconstruct the SQL queries now that we know the owner's id
            association.send(:construct_sql) if association.respond_to?(:construct_sql)
1145
          end_eval
1146

1147 1148 1149
          # Doesn't use after_save as that would save associations added in after_create/after_update twice
          after_create(after_callback)
          after_update(after_callback)
D
Initial  
David Heinemeier Hansson 已提交
1150
        end
1151

1152 1153
        def association_constructor_method(constructor, reflection, association_proxy_class)
          define_method("#{constructor}_#{reflection.name}") do |*params|
1154 1155
            ivar = "@#{reflection.name}"

1156 1157
            attributees      = params.first unless params.empty?
            replace_existing = params[1].nil? ? true : params[1]
1158
            association      = instance_variable_get(ivar) if instance_variable_defined?(ivar)
1159 1160

            if association.nil?
1161
              association = association_proxy_class.new(self, reflection)
1162
              instance_variable_set(ivar, association)
1163 1164
            end

1165 1166 1167 1168 1169
            if association_proxy_class == HasOneAssociation
              association.send(constructor, attributees, replace_existing)
            else
              association.send(constructor, attributees)
            end
1170 1171
          end
        end
1172

1173
        def find_with_associations(options = {})
1174
          catch :invalid_query do
1175
            join_dependency = JoinDependency.new(self, merge_includes(scope(:find, :include), options[:include]), options[:joins])
1176 1177 1178 1179
            rows = select_all_rows(options, join_dependency)
            return join_dependency.instantiate(rows)
          end
          []
1180
        end
1181

1182 1183
        # See HasManyAssociation#delete_records.  Dependent associations
        # delete children, otherwise foreign key is set to NULL.
1184
        def configure_dependency_for_has_many(reflection)
1185 1186 1187 1188 1189 1190 1191
          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]
            dependent_conditions = dependent_conditions.collect {|where| "(#{where})" }.join(" AND ")
1192

1193 1194 1195 1196 1197 1198 1199 1200 1201 1202
            case reflection.options[:dependent]
              when :destroy
                module_eval "before_destroy '#{reflection.name}.each { |o| o.destroy }'"
              when :delete_all
                module_eval "before_destroy { |record| #{reflection.class_name}.delete_all(%(#{dependent_conditions})) }"
              when :nullify
                module_eval "before_destroy { |record| #{reflection.class_name}.update_all(%(#{reflection.primary_key_name} = NULL),  %(#{dependent_conditions})) }"
              else
                raise ArgumentError, "The :dependent option expects either :destroy, :delete_all, or :nullify (#{reflection.options[:dependent].inspect})"
            end
1203 1204
          end
        end
1205

1206
        def configure_dependency_for_has_one(reflection)
1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217
          if reflection.options.include?(:dependent)
            case reflection.options[:dependent]
              when :destroy
                module_eval "before_destroy '#{reflection.name}.destroy unless #{reflection.name}.nil?'"
              when :delete
                module_eval "before_destroy '#{reflection.class_name}.delete(#{reflection.name}.id) unless #{reflection.name}.nil?'"
              when :nullify
                module_eval "before_destroy '#{reflection.name}.update_attribute(\"#{reflection.primary_key_name}\", nil) unless #{reflection.name}.nil?'"
              else
                raise ArgumentError, "The :dependent option expects either :destroy, :delete or :nullify (#{reflection.options[:dependent].inspect})"
            end
1218 1219 1220
          end
        end

1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233
        def configure_dependency_for_belongs_to(reflection)
          if reflection.options.include?(:dependent)
            case reflection.options[:dependent]
              when :destroy
                module_eval "before_destroy '#{reflection.name}.destroy unless #{reflection.name}.nil?'"
              when :delete
                module_eval "before_destroy '#{reflection.class_name}.delete(#{reflection.name}.id) unless #{reflection.name}.nil?'"
              else
                raise ArgumentError, "The :dependent option expects either :destroy or :delete (#{reflection.options[:dependent].inspect})"
            end
          end
        end

1234 1235
        def create_has_many_reflection(association_id, options, &extension)
          options.assert_valid_keys(
1236
            :class_name, :table_name, :foreign_key,
1237
            :dependent,
1238
            :select, :conditions, :include, :order, :group, :limit, :offset,
1239
            :as, :through, :source, :source_type,
1240
            :uniq,
1241 1242
            :finder_sql, :counter_sql,
            :before_add, :after_add, :before_remove, :after_remove,
1243
            :extend
1244 1245
          )

1246
          options[:extend] = create_extension_modules(association_id, extension, options[:extend])
1247

1248
          create_reflection(:has_many, association_id, options, self)
1249 1250 1251 1252
        end

        def create_has_one_reflection(association_id, options)
          options.assert_valid_keys(
1253
            :class_name, :foreign_key, :remote, :conditions, :order, :include, :dependent, :counter_cache, :extend, :as
1254 1255
          )

1256
          create_reflection(:has_one, association_id, options, self)
1257 1258 1259 1260
        end

        def create_belongs_to_reflection(association_id, options)
          options.assert_valid_keys(
1261
            :class_name, :foreign_key, :foreign_type, :remote, :conditions, :order, :include, :dependent,
1262 1263
            :counter_cache, :extend, :polymorphic
          )
1264

1265 1266 1267 1268 1269 1270 1271 1272
          reflection = create_reflection(:belongs_to, association_id, options, self)

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

          reflection
        end
1273

1274 1275
        def create_has_and_belongs_to_many_reflection(association_id, options, &extension)
          options.assert_valid_keys(
1276
            :class_name, :table_name, :join_table, :foreign_key, :association_foreign_key,
1277
            :select, :conditions, :include, :order, :group, :limit, :offset,
1278
            :uniq,
1279
            :finder_sql, :delete_sql, :insert_sql,
1280
            :before_add, :after_add, :before_remove, :after_remove,
1281
            :extend
1282 1283
          )

1284
          options[:extend] = create_extension_modules(association_id, extension, options[:extend])
1285 1286 1287 1288

          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))
1289

1290 1291 1292
          reflection
        end

1293
        def reflect_on_included_associations(associations)
1294
          [ associations ].flatten.collect { |association| reflect_on_association(association.to_s.intern) }
1295 1296
        end

1297 1298 1299
        def guard_against_unlimitable_reflections(reflections, options)
          if (options[:offset] || options[:limit]) && !using_limitable_reflections?(reflections)
            raise(
1300
              ConfigurationError,
1301 1302 1303 1304 1305
              "You can not use offset and limit together with has_many or has_and_belongs_to_many associations"
            )
          end
        end

1306
        def select_all_rows(options, join_dependency)
1307
          connection.select_all(
1308
            construct_finder_sql_with_included_associations(options, join_dependency),
1309 1310 1311
            "#{name} Load Including Associations"
          )
        end
1312

1313
        def construct_finder_sql_with_included_associations(options, join_dependency)
1314
          scope = scope(:find)
1315
          sql = "SELECT #{column_aliases(join_dependency)} FROM #{(scope && scope[:from]) || options[:from] || quoted_table_name} "
1316
          sql << join_dependency.join_associations.collect{|join| join.association_join }.join
1317

1318 1319
          add_joins!(sql, options, scope)
          add_conditions!(sql, options[:conditions], scope)
1320
          add_limited_ids_condition!(sql, options, join_dependency) if !using_limitable_reflections?(join_dependency.reflections) && ((scope && scope[:limit]) || options[:limit])
1321

1322
          add_group!(sql, options[:group], scope)
1323
          add_order!(sql, options[:order], scope)
1324
          add_limit!(sql, options, scope) if using_limitable_reflections?(join_dependency.reflections)
1325
          add_lock!(sql, options, scope)
1326

1327 1328
          return sanitize_sql(sql)
        end
1329

1330 1331
        def add_limited_ids_condition!(sql, options, join_dependency)
          unless (id_list = select_limited_ids_list(options, join_dependency)).empty?
1332
            sql << "#{condition_word(sql)} #{connection.quote_table_name table_name}.#{primary_key} IN (#{id_list}) "
1333 1334
          else
            throw :invalid_query
1335 1336
          end
        end
1337

1338
        def select_limited_ids_list(options, join_dependency)
1339 1340
          pk = columns_hash[primary_key]

1341
          connection.select_all(
1342
            construct_finder_sql_for_association_limiting(options, join_dependency),
1343
            "#{name} Load IDs For Limited Eager Loading"
1344
          ).collect { |row| connection.quote(row[primary_key], pk) }.join(", ")
1345
        end
1346

1347
        def construct_finder_sql_for_association_limiting(options, join_dependency)
1348
          scope       = scope(:find)
1349
          is_distinct = !options[:joins].blank? || include_eager_conditions?(options) || include_eager_order?(options)
1350
          sql = "SELECT "
1351
          if is_distinct
1352
            sql << connection.distinct("#{connection.quote_table_name table_name}.#{primary_key}", options[:order])
1353 1354 1355
          else
            sql << primary_key
          end
1356
          sql << " FROM #{connection.quote_table_name table_name} "
1357

1358
          if is_distinct
1359
            sql << join_dependency.join_associations.collect(&:association_join).join
1360
            add_joins!(sql, options, scope)
1361
          end
1362

1363
          add_conditions!(sql, options[:conditions], scope)
1364
          add_group!(sql, options[:group], scope)
1365

1366 1367 1368 1369
          if options[:order] && is_distinct
            connection.add_order_by_for_association_limiting!(sql, options)
          else
            add_order!(sql, options[:order], scope)
1370
          end
1371

1372
          add_limit!(sql, options, scope)
1373

1374 1375
          return sanitize_sql(sql)
        end
1376

1377
        # Checks if the conditions reference a table other than the current model table
1378
        def include_eager_conditions?(options)
1379 1380 1381 1382 1383 1384 1385 1386 1387
          # 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
          return false unless conditions.any?
1388
          conditions.join(' ').scan(/([\.\w]+)\.\w+/).flatten.any? do |condition_table_name|
1389 1390 1391
            condition_table_name != table_name
          end
        end
1392

1393
        # Checks if the query order references a table other than the current model's table.
1394 1395 1396
        def include_eager_order?(options)
          order = options[:order]
          return false unless order
1397
          order.to_s.scan(/([\.\w]+)\.\w+/).flatten.any? do |order_table_name|
1398 1399 1400
            order_table_name != table_name
          end
        end
1401

1402 1403 1404 1405
        def references_eager_loaded_tables?(options)
          include_eager_order?(options) || include_eager_conditions?(options)
        end

1406 1407 1408 1409
        def using_limitable_reflections?(reflections)
          reflections.reject { |r| [ :belongs_to, :has_one ].include?(r.macro) }.length.zero?
        end

1410 1411
        def column_aliases(join_dependency)
          join_dependency.joins.collect{|join| join.column_names_with_alias.collect{|column_name, aliased_name|
1412
              "#{connection.quote_table_name join.aliased_table_name}.#{connection.quote_column_name column_name} AS #{aliased_name}"}}.flatten.join(", ")
1413 1414
        end

1415
        def add_association_callbacks(association_name, options)
1416 1417
          callbacks = %w(before_add after_add before_remove after_remove)
          callbacks.each do |callback_name|
1418
            full_callback_name = "#{callback_name}_for_#{association_name}"
1419 1420 1421
            defined_callbacks = options[callback_name.to_sym]
            if options.has_key?(callback_name.to_sym)
              class_inheritable_reader full_callback_name.to_sym
1422 1423 1424
              write_inheritable_attribute(full_callback_name.to_sym, [defined_callbacks].flatten)
            else
              write_inheritable_attribute(full_callback_name.to_sym, [])
1425 1426
            end
          end
1427
        end
1428

1429 1430 1431
        def condition_word(sql)
          sql =~ /where/i ? " AND " : "WHERE "
        end
1432

1433
        def create_extension_modules(association_id, block_extension, extensions)
1434 1435
          if block_extension
            extension_module_name = "#{self.to_s}#{association_id.to_s.camelize}AssociationExtension"
1436

1437 1438 1439 1440 1441 1442
            silence_warnings do
              Object.const_set(extension_module_name, Module.new(&block_extension))
            end
            Array(extensions).push(extension_module_name.constantize)
          else
            Array(extensions)
1443 1444
          end
        end
1445

D
David Heinemeier Hansson 已提交
1446
        class JoinDependency # :nodoc:
1447
          attr_reader :joins, :reflections, :table_aliases
1448

1449
          def initialize(base, associations, joins)
1450
            @joins                 = [JoinBase.new(base, joins)]
1451 1452 1453 1454
            @associations          = associations
            @reflections           = []
            @base_records_hash     = {}
            @base_records_in_order = []
1455 1456
            @table_aliases         = Hash.new { |aliases, table| aliases[table] = 0 }
            @table_aliases[base.table_name] = 1
1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473
            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
1474
              construct(@base_records_hash[primary_id], @associations, join_associations.dup, row)
1475
            end
1476
            remove_duplicate_results!(join_base.active_record, @base_records_in_order, @associations)
1477 1478 1479
            return @base_records_in_order
          end

1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505
          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|
                    next unless record.send(reflection.name)
                    is_collection ? record.send(reflection.name).target.uniq! : record.send(reflection.name)
                  end.flatten.compact

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

1506 1507 1508 1509 1510 1511 1512 1513
          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
1514
                  @joins << build_join_association(reflection, parent)
1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528
                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

1529 1530 1531 1532 1533
            # overridden in InnerJoinDependency subclass
            def build_join_association(reflection, parent)
              JoinAssociation.new(reflection, self, parent)
            end

1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559
            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
1560

1561 1562
                  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)
1563
                  collection.target.push(association)
1564 1565 1566 1567 1568
                when :has_one
                  return if record.id.to_s != join.parent.record_id(row).to_s
                  association = join.instantiate(row) unless row[join.aliased_primary_key].nil?
                  record.send("set_#{join.reflection.name}_target", association)
                when :belongs_to
1569 1570 1571 1572 1573 1574 1575 1576 1577
                  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 已提交
1578
          class JoinBase # :nodoc:
1579
            attr_reader :active_record, :table_joins
1580
            delegate    :table_name, :column_names, :primary_key, :reflections, :sanitize_sql, :to => :active_record
1581

1582
            def initialize(active_record, joins = nil)
1583 1584
              @active_record = active_record
              @cached_record = {}
1585
              @table_joins   = joins
1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600
            end

            def aliased_prefix
              "t0"
            end

            def aliased_primary_key
              "#{ aliased_prefix }_r0"
            end

            def aliased_table_name
              active_record.table_name
            end

            def column_names_with_alias
1601
              unless defined?(@column_names_with_alias)
1602
                @column_names_with_alias = []
1603

1604 1605 1606 1607
                ([primary_key] + (column_names - [primary_key])).each_with_index do |column_name, i|
                  @column_names_with_alias << [column_name, "#{ aliased_prefix }_r#{ i }"]
                end
              end
1608 1609

              @column_names_with_alias
1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620
            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)
1621
              @cached_record[record_id(row)] ||= active_record.send(:instantiate, extract_record(row))
1622 1623 1624
            end
          end

D
David Heinemeier Hansson 已提交
1625
          class JoinAssociation < JoinBase # :nodoc:
1626
            attr_reader :reflection, :parent, :aliased_table_name, :aliased_prefix, :aliased_join_table_name, :parent_table_name
1627
            delegate    :options, :klass, :through_reflection, :source_reflection, :to => :reflection
1628 1629

            def initialize(reflection, join_dependency, parent = nil)
1630 1631 1632 1633 1634
              reflection.check_validity!
              if reflection.options[:polymorphic]
                raise EagerLoadPolymorphicError.new(reflection)
              end

1635 1636 1637 1638
              super(reflection.klass)
              @parent             = parent
              @reflection         = reflection
              @aliased_prefix     = "t#{ join_dependency.joins.size }"
1639
              @aliased_table_name = table_name #.tr('.', '_') # start with the table name, sub out any .'s
1640
              @parent_table_name  = parent.active_record.table_name
1641

1642
              if !parent.table_joins.blank? && parent.table_joins.to_s.downcase =~ %r{join(\s+\w+)?\s+#{aliased_table_name.downcase}\son}
1643 1644
                join_dependency.table_aliases[aliased_table_name] += 1
              end
1645

1646 1647
              unless join_dependency.table_aliases[aliased_table_name].zero?
                # if the table name has been used, then use an alias
J
Jeremy Kemper 已提交
1648
                @aliased_table_name = active_record.connection.table_alias_for "#{pluralize(reflection.name)}_#{parent_table_name}"
1649
                table_index = join_dependency.table_aliases[aliased_table_name]
J
Jeremy Kemper 已提交
1650
                join_dependency.table_aliases[aliased_table_name] += 1
1651
                @aliased_table_name = @aliased_table_name[0..active_record.connection.table_alias_length-3] + "_#{table_index+1}" if table_index > 0
1652 1653
              else
                join_dependency.table_aliases[aliased_table_name] += 1
1654
              end
1655

1656
              if reflection.macro == :has_and_belongs_to_many || (reflection.macro == :has_many && reflection.options[:through])
1657
                @aliased_join_table_name = reflection.macro == :has_and_belongs_to_many ? reflection.options[:join_table] : reflection.through_reflection.klass.table_name
1658
                unless join_dependency.table_aliases[aliased_join_table_name].zero?
1659 1660
                  @aliased_join_table_name = active_record.connection.table_alias_for "#{pluralize(reflection.name)}_#{parent_table_name}_join"
                  table_index = join_dependency.table_aliases[aliased_join_table_name]
J
Jeremy Kemper 已提交
1661
                  join_dependency.table_aliases[aliased_join_table_name] += 1
1662
                  @aliased_join_table_name = @aliased_join_table_name[0..active_record.connection.table_alias_length-3] + "_#{table_index+1}" if table_index > 0
J
Jeremy Kemper 已提交
1663 1664
                else
                  join_dependency.table_aliases[aliased_join_table_name] += 1
1665 1666
                end
              end
1667 1668 1669
            end

            def association_join
1670
              connection = reflection.active_record.connection
1671
              join = case reflection.macro
1672
                when :has_and_belongs_to_many
1673
                  " #{join_type} %s ON %s.%s = %s.%s " % [
1674
                     table_alias_for(options[:join_table], aliased_join_table_name),
1675
                     connection.quote_table_name(aliased_join_table_name),
1676
                     options[:foreign_key] || reflection.active_record.to_s.foreign_key,
1677
                     connection.quote_table_name(parent.aliased_table_name),
1678
                     reflection.active_record.primary_key] +
1679
                  " #{join_type} %s ON %s.%s = %s.%s " % [
1680
                     table_name_and_alias,
1681 1682
                     connection.quote_table_name(aliased_table_name),
                     klass.primary_key,
1683
                     connection.quote_table_name(aliased_join_table_name),
1684
                     options[:association_foreign_key] || klass.to_s.foreign_key
1685 1686
                     ]
                when :has_many, :has_one
1687 1688
                  case
                    when reflection.macro == :has_many && reflection.options[:through]
1689
                      through_conditions = through_reflection.options[:conditions] ? "AND #{interpolate_sql(sanitize_sql(through_reflection.options[:conditions]))}" : ''
1690 1691 1692 1693

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

1694
                      if through_reflection.options[:as] # has_many :through against a polymorphic join
1695 1696
                        jt_foreign_key = through_reflection.options[:as].to_s + '_id'
                        jt_as_extra = " AND %s.%s = %s" % [
1697 1698
                          connection.quote_table_name(aliased_join_table_name),
                          connection.quote_column_name(through_reflection.options[:as].to_s + '_type'),
1699
                          klass.quote_value(parent.active_record.base_class.name)
1700
                        ]
1701
                      else
1702
                        jt_foreign_key = through_reflection.primary_key_name
1703
                      end
1704

1705 1706
                      case source_reflection.macro
                      when :has_many
1707 1708 1709
                        if source_reflection.options[:as]
                          first_key   = "#{source_reflection.options[:as]}_id"
                          second_key  = options[:foreign_key] || primary_key
1710
                          as_extra    = " AND %s.%s = %s" % [
1711 1712
                            connection.quote_table_name(aliased_table_name),
                            connection.quote_column_name("#{source_reflection.options[:as]}_type"),
1713
                            klass.quote_value(source_reflection.active_record.base_class.name)
1714 1715
                          ]
                        else
1716 1717 1718
                          first_key   = through_reflection.klass.base_class.to_s.foreign_key
                          second_key  = options[:foreign_key] || primary_key
                        end
1719

1720 1721
                        unless through_reflection.klass.descends_from_active_record?
                          jt_sti_extra = " AND %s.%s = %s" % [
1722 1723
                            connection.quote_table_name(aliased_join_table_name),
                            connection.quote_column_name(through_reflection.active_record.inheritance_column),
1724 1725 1726 1727 1728 1729 1730
                            through_reflection.klass.quote_value(through_reflection.klass.name.demodulize)]
                        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" % [
1731 1732
                            connection.quote_table_name(aliased_join_table_name),
                            connection.quote_column_name(reflection.source_reflection.options[:foreign_type]),
1733
                            klass.quote_value(reflection.options[:source_type])
1734
                          ]
1735
                        else
1736
                          second_key = source_reflection.primary_key_name
1737
                        end
1738
                      end
1739

1740
                      " #{join_type} %s ON (%s.%s = %s.%s%s%s%s) " % [
1741
                        table_alias_for(through_reflection.klass.table_name, aliased_join_table_name),
1742
                        connection.quote_table_name(parent.aliased_table_name),
1743
                        connection.quote_column_name(parent.primary_key),
1744
                        connection.quote_table_name(aliased_join_table_name),
1745
                        connection.quote_column_name(jt_foreign_key),
1746 1747
                        jt_as_extra, jt_source_extra, jt_sti_extra
                      ] +
1748
                      " #{join_type} %s ON (%s.%s = %s.%s%s) " % [
1749
                        table_name_and_alias,
1750
                        connection.quote_table_name(aliased_table_name),
1751
                        connection.quote_column_name(first_key),
1752
                        connection.quote_table_name(aliased_join_table_name),
1753
                        connection.quote_column_name(second_key),
1754 1755 1756
                        as_extra
                      ]

1757
                    when reflection.options[:as] && [:has_many, :has_one].include?(reflection.macro)
1758
                      " #{join_type} %s ON %s.%s = %s.%s AND %s.%s = %s" % [
1759
                        table_name_and_alias,
1760
                        connection.quote_table_name(aliased_table_name),
1761
                        "#{reflection.options[:as]}_id",
1762
                        connection.quote_table_name(parent.aliased_table_name),
1763
                        parent.primary_key,
1764
                        connection.quote_table_name(aliased_table_name),
1765
                        "#{reflection.options[:as]}_type",
1766
                        klass.quote_value(parent.active_record.base_class.name)
1767 1768
                      ]
                    else
1769
                      foreign_key = options[:foreign_key] || reflection.active_record.name.foreign_key
1770
                      " #{join_type} %s ON %s.%s = %s.%s " % [
1771
                        table_name_and_alias,
1772
                        aliased_table_name,
1773
                        foreign_key,
1774
                        parent.aliased_table_name,
1775
                        parent.primary_key
1776 1777
                      ]
                  end
1778
                when :belongs_to
1779
                  " #{join_type} %s ON %s.%s = %s.%s " % [
1780
                     table_name_and_alias,
1781 1782
                     connection.quote_table_name(aliased_table_name),
                     reflection.klass.primary_key,
1783
                     connection.quote_table_name(parent.aliased_table_name),
1784
                     options[:foreign_key] || reflection.primary_key_name
1785 1786 1787
                    ]
                else
                  ""
1788
              end || ''
1789
              join << %(AND %s.%s = %s ) % [
1790 1791
                connection.quote_table_name(aliased_table_name),
                connection.quote_column_name(klass.inheritance_column),
1792
                klass.quote_value(klass.name.demodulize)] unless klass.descends_from_active_record?
1793 1794 1795 1796 1797

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

1798
              join
1799
            end
1800

1801
            protected
1802 1803 1804
              def pluralize(table_name)
                ActiveRecord::Base.pluralize_table_names ? table_name.to_s.pluralize : table_name
              end
1805

1806
              def table_alias_for(table_name, table_alias)
1807
                 "#{reflection.active_record.connection.quote_table_name(table_name)} #{table_alias if table_name != table_alias}".strip
1808 1809 1810 1811 1812
              end

              def table_name_and_alias
                table_alias_for table_name, @aliased_table_name
              end
1813 1814

              def interpolate_sql(sql)
1815 1816
                instance_eval("%@#{sql.gsub('@', '\@')}@")
              end
1817 1818

            private
1819 1820 1821 1822
              def join_type
                "LEFT OUTER JOIN"
              end
          end
1823 1824 1825 1826 1827 1828 1829 1830 1831
        end

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

          class InnerJoinAssociation < JoinAssociation
1832 1833 1834 1835
            private
              def join_type
                "INNER JOIN"
              end
1836 1837
          end
        end
1838

1839
    end
D
Initial  
David Heinemeier Hansson 已提交
1840
  end
1841
end