associations.rb 90.9 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 28
  
  class HasManyThroughAssociationPointlessSourceTypeError < ActiveRecordError #:nodoc:
    def initialize(owner_class_name, reflection, source_reflection)
      super("Cannot have a has_many :through association '#{owner_class_name}##{reflection.name}' with a :source_type option if the '#{reflection.through_reflection.class_name}##{source_reflection.name}' is not polymorphic.  Try removing :source_type on your association.")
    end
  end
  
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

D
David Heinemeier Hansson 已提交
52
  class EagerLoadPolymorphicError < ActiveRecordError #:nodoc:
53
    def initialize(reflection)
54
      super("Can not eagerly load the polymorphic association #{reflection.name.inspect}")
55 56 57
    end
  end

58 59
  class ReadOnlyAssociation < ActiveRecordError #:nodoc:
    def initialize(reflection)
60
      super("Can not add to a has_many :through association.  Try adding to #{reflection.through_reflection.name.inspect}.")
61 62 63
    end
  end

D
Initial  
David Heinemeier Hansson 已提交
64
  module Associations # :nodoc:
65
    def self.included(base)
66 67 68
      base.extend(ClassMethods)
    end

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

666
        configure_dependency_for_has_many(reflection)
667

668 669
        if options[:through]
          collection_reader_method(reflection, HasManyThroughAssociation)
670
          collection_accessor_methods(reflection, HasManyThroughAssociation, false)
671 672 673 674
        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 已提交
675 676 677
        end
      end

678
      # Adds the following methods for retrieval and query of a single associated object:
D
Initial  
David Heinemeier Hansson 已提交
679
      # +association+ is replaced with the symbol passed as the first argument, so 
680
      # <tt>has_one :manager</tt> would add among others <tt>manager.nil?</tt>.
681
      # * <tt>association(force_reload = false)</tt> - returns the associated object. +nil+ is returned if none is found.
D
Initial  
David Heinemeier Hansson 已提交
682 683
      # * <tt>association=(associate)</tt> - assigns the associate object, extracts the primary key, sets it as the foreign key, 
      #   and saves the associate object.
684
      # * <tt>association.nil?</tt> - returns +true+ if there is no associated object.
685
      # * <tt>build_association(attributes = {})</tt> - returns a new object of the associated type that has been instantiated
686 687
      #   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+.
688
      # * <tt>create_association(attributes = {})</tt> - returns a new object of the associated type that has been instantiated
689
      #   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 已提交
690 691
      #
      # Example: An Account class declares <tt>has_one :beneficiary</tt>, which will add:
692
      # * <tt>Account#beneficiary</tt> (similar to <tt>Beneficiary.find(:first, :conditions => "account_id = #{id}")</tt>)
D
Initial  
David Heinemeier Hansson 已提交
693 694
      # * <tt>Account#beneficiary=(beneficiary)</tt> (similar to <tt>beneficiary.account_id = account.id; beneficiary.save</tt>)
      # * <tt>Account#beneficiary.nil?</tt>
695 696 697
      # * <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 已提交
698 699 700
      # The declaration can also include an options hash to specialize the behavior of the association.
      # 
      # Options are:
701
      # * <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 已提交
702 703
      #   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.
704 705
      # * <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>.
D
Initial  
David Heinemeier Hansson 已提交
706
      # * <tt>:order</tt>       - specify the order from which the associated object will be picked at the top. Specified as
707 708 709 710
      #   an <tt>ORDER BY</tt> SQL fragment, such as <tt>last_name, first_name DESC</tt>
      # * <tt>:dependent</tt>   - if set to <tt>:destroy</tt> (or +true+), 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. 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 已提交
711
      # * <tt>:foreign_key</tt> - specify the foreign key used for the association. By default this is guessed to be the name
712 713
      #   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+.
714
      # * <tt>:include</tt>  - specify second-order associations that should be eager loaded when this object is loaded.
715
      # * <tt>:as</tt>: Specifies a polymorphic interface (See <tt>#belongs_to</tt>).
716
            #
D
Initial  
David Heinemeier Hansson 已提交
717
      # Option examples:
718
      #   has_one :credit_card, :dependent => :destroy  # destroys the associated credit card
719
      #   has_one :credit_card, :dependent => :nullify  # updates the associated records foreign key value to null rather than destroying it
D
Initial  
David Heinemeier Hansson 已提交
720 721
      #   has_one :last_comment, :class_name => "Comment", :order => "posted_on"
      #   has_one :project_manager, :class_name => "Person", :conditions => "role = 'project_manager'"
722
      #   has_one :attachment, :as => :attachable
D
Initial  
David Heinemeier Hansson 已提交
723
      def has_one(association_id, options = {})
724
        reflection = create_has_one_reflection(association_id, options)
D
Initial  
David Heinemeier Hansson 已提交
725

726 727
        module_eval do
          after_save <<-EOF
728
            association = instance_variable_get("@#{reflection.name}")
729
            if !association.nil? && (new_record? || association.new_record? || association["#{reflection.primary_key_name}"] != id)
730
              association["#{reflection.primary_key_name}"] = id
731 732 733 734 735
              association.save(true)
            end
          EOF
        end
      
736 737 738
        association_accessor_methods(reflection, HasOneAssociation)
        association_constructor_method(:build,  reflection, HasOneAssociation)
        association_constructor_method(:create, reflection, HasOneAssociation)
D
Initial  
David Heinemeier Hansson 已提交
739
        
740
        configure_dependency_for_has_one(reflection)
D
Initial  
David Heinemeier Hansson 已提交
741 742
      end

743
      # Adds the following methods for retrieval and query for a single associated object for which this object holds an id:
D
Initial  
David Heinemeier Hansson 已提交
744
      # +association+ is replaced with the symbol passed as the first argument, so 
745
      # <tt>belongs_to :author</tt> would add among others <tt>author.nil?</tt>.
746
      # * <tt>association(force_reload = false)</tt> - returns the associated object. +nil+ is returned if none is found.
D
Initial  
David Heinemeier Hansson 已提交
747
      # * <tt>association=(associate)</tt> - assigns the associate object, extracts the primary key, and sets it as the foreign key.
748
      # * <tt>association.nil?</tt> - returns +true+ if there is no associated object.
749
      # * <tt>build_association(attributes = {})</tt> - returns a new object of the associated type that has been instantiated
750
      #   with +attributes+ and linked to this object through a foreign key, but has not yet been saved.
751
      # * <tt>create_association(attributes = {})</tt> - returns a new object of the associated type that has been instantiated
752
      #   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 已提交
753
      #
754
      # Example: A Post class declares <tt>belongs_to :author</tt>, which will add:
D
Initial  
David Heinemeier Hansson 已提交
755 756 757 758
      # * <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 已提交
759 760
      # * <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 已提交
761 762 763
      # The declaration can also include an options hash to specialize the behavior of the association.
      # 
      # Options are:
764
      # * <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 已提交
765 766
      #   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.
767 768
      # * <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>.
D
Initial  
David Heinemeier Hansson 已提交
769
      # * <tt>:order</tt>       - specify the order from which the associated object will be picked at the top. Specified as
770
      #   an <tt>ORDER BY</tt> SQL fragment, such as <tt>last_name, first_name DESC</tt>
D
Initial  
David Heinemeier Hansson 已提交
771
      # * <tt>:foreign_key</tt> - specify the foreign key used for the association. By default this is guessed to be the name
772 773 774 775 776 777 778
      #   of the associated class in lower-case and +_id+ suffixed. So a +Person+ class that makes a +belongs_to+ association to a
      #   +Boss+ class will use +boss_id+ as the default +foreign_key+.
      # * <tt>:counter_cache</tt> - caches the number of belonging objects on the associate class through use of +increment_counter+ 
      #   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)
      #   is used on the associate class (such as a +Post+ class). You can also specify a custom counter cache column by providing 
      #   a column name instead of a +true+/+false+ value to this option (e.g., <tt>:counter_cache => :my_custom_counter</tt>.)
779
      # * <tt>:include</tt>  - specify second-order associations that should be eager loaded when this object is loaded.
780
      # * <tt>:polymorphic</tt> - specify this association is a polymorphic association by passing +true+.
D
Initial  
David Heinemeier Hansson 已提交
781 782 783 784 785 786
      #
      # Option examples:
      #   belongs_to :firm, :foreign_key => "client_of"
      #   belongs_to :author, :class_name => "Person", :foreign_key => "author_id"
      #   belongs_to :valid_coupon, :class_name => "Coupon", :foreign_key => "coupon_id", 
      #              :conditions => 'discounts > #{payments_count}'
R
Rick Olson 已提交
787
      #   belongs_to :attachable, :polymorphic => true
788
      def belongs_to(association_id, options = {})
789 790 791 792
        reflection = create_belongs_to_reflection(association_id, options)
        
        if reflection.options[:polymorphic]
          association_accessor_methods(reflection, BelongsToPolymorphicAssociation)
793 794 795

          module_eval do
            before_save <<-EOF
796
              association = instance_variable_get("@#{reflection.name}")
797
              if association && association.target
798
                if association.new_record?
799 800 801 802
                  association.save(true)
                end
                
                if association.updated?
803
                  self["#{reflection.primary_key_name}"] = association.id
804
                  self["#{reflection.options[:foreign_type]}"] = association.class.base_class.name.to_s
805
                end
806
              end
807 808 809
            EOF
          end
        else
810 811 812
          association_accessor_methods(reflection, BelongsToAssociation)
          association_constructor_method(:build,  reflection, BelongsToAssociation)
          association_constructor_method(:create, reflection, BelongsToAssociation)
813 814 815

          module_eval do
            before_save <<-EOF
816
              association = instance_variable_get("@#{reflection.name}")
817
              if !association.nil? 
818
                if association.new_record?
819 820 821 822
                  association.save(true)
                end
                
                if association.updated?
823
                  self["#{reflection.primary_key_name}"] = association.id
824 825 826 827 828
                end
              end            
            EOF
          end
        end
829

830
        # Create the callbacks to update counter cache
831
        if options[:counter_cache]
832 833 834 835
          cache_column = options[:counter_cache] == true ?
            "#{self.to_s.underscore.pluralize}_count" :
            options[:counter_cache]

836
          module_eval(
837
            "after_create '#{reflection.name}.class.increment_counter(\"#{cache_column}\", #{reflection.primary_key_name})" +
838 839 840 841
            " unless #{reflection.name}.nil?'"
          )

          module_eval(
842
            "before_destroy '#{reflection.name}.class.decrement_counter(\"#{cache_column}\", #{reflection.primary_key_name})" +
843
            " unless #{reflection.name}.nil?'"
844 845 846
          )
          
          module_eval(
847
            "#{reflection.class_name}.send(:attr_readonly,\"#{cache_column}\".intern) if defined?(#{reflection.class_name}) && #{reflection.class_name}.respond_to?(:attr_readonly)"
848
          )
849
        end
850 851
      end

D
Initial  
David Heinemeier Hansson 已提交
852
      # Associates two classes via an intermediate join table.  Unless the join table is explicitly specified as
853 854
      # 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
855 856 857 858 859 860
      # is calculated using the <tt><</tt> operator for <tt>String</tt>.  This means that if the strings are of different lengths, 
      # and the strings are equal when compared up to the shortest length, then the longer string is considered of higher
      # lexical precedence than the shorter one.  For example, one would expect the tables <tt>paper_boxes</tt> and <tt>papers</tt> 
      # to generate a join table name of <tt>papers_paper_boxes</tt> because of the length of the name <tt>paper_boxes</tt>,
      # but it in fact generates a join table name of <tt>paper_boxes_papers</tt>.  Be aware of this caveat, and use the 
      # custom <tt>join_table</tt> option if you need to.
D
Initial  
David Heinemeier Hansson 已提交
861
      #
862
      # Deprecated: Any additional fields added to the join table will be placed as attributes when pulling records out through
863
      # +has_and_belongs_to_many+ associations. Records returned from join tables with additional attributes will be marked as
864
      # +ReadOnly+ (because we can't save changes to the additional attributes). It's strongly recommended that you upgrade any
865
      # associations with attributes to a real join model (see introduction).
D
Initial  
David Heinemeier Hansson 已提交
866
      #
867
      # Adds the following methods for retrieval and query:
D
Initial  
David Heinemeier Hansson 已提交
868
      # +collection+ is replaced with the symbol passed as the first argument, so 
869
      # <tt>has_and_belongs_to_many :categories</tt> would add among others <tt>categories.empty?</tt>.
D
Initial  
David Heinemeier Hansson 已提交
870
      # * <tt>collection(force_reload = false)</tt> - returns an array of all the associated objects.
871
      #   An empty array is returned if none are found.
D
Initial  
David Heinemeier Hansson 已提交
872
      # * <tt>collection<<(object, ...)</tt> - adds one or more objects to the collection by creating associations in the join table 
873
      #   (<tt>collection.push</tt> and <tt>collection.concat</tt> are aliases to this method).
D
Initial  
David Heinemeier Hansson 已提交
874 875
      # * <tt>collection.delete(object, ...)</tt> - removes one or more objects from the collection by removing their associations from the join table.  
      #   This does not destroy the objects.
876 877
      # * <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
878
      # * <tt>collection_singular_ids=ids</tt> - replace the collection by the objects identified by the primary keys in +ids+
D
Initial  
David Heinemeier Hansson 已提交
879
      # * <tt>collection.clear</tt> - removes every object from the collection. This does not destroy the objects.
880
      # * <tt>collection.empty?</tt> - returns +true+ if there are no associated objects.
D
Initial  
David Heinemeier Hansson 已提交
881
      # * <tt>collection.size</tt> - returns the number of associated objects.
882 883
      # * <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.
884
      # * <tt>collection.build(attributes = {})</tt> - returns a new object of the collection type that has been instantiated
885
      #   with +attributes+ and linked to this object through the join table, but has not yet been saved.
886
      # * <tt>collection.create(attributes = {})</tt> - returns a new object of the collection type that has been instantiated
887
      #   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 已提交
888
      #
889
      # Example: A Developer class declares <tt>has_and_belongs_to_many :projects</tt>, which will add:
D
Initial  
David Heinemeier Hansson 已提交
890 891 892
      # * <tt>Developer#projects</tt>
      # * <tt>Developer#projects<<</tt>
      # * <tt>Developer#projects.delete</tt>
893
      # * <tt>Developer#projects=</tt>
894
      # * <tt>Developer#project_ids</tt>
895
      # * <tt>Developer#project_ids=</tt>
D
Initial  
David Heinemeier Hansson 已提交
896 897 898 899
      # * <tt>Developer#projects.clear</tt>
      # * <tt>Developer#projects.empty?</tt>
      # * <tt>Developer#projects.size</tt>
      # * <tt>Developer#projects.find(id)</tt>
900 901
      # * <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 已提交
902 903 904
      # The declaration may include an options hash to specialize the behavior of the association.
      # 
      # Options are:
905
      # * <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 已提交
906 907 908
      #   from the association name. So <tt>has_and_belongs_to_many :projects</tt> will by default be linked to the 
      #   +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.
909 910
      #   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 已提交
911
      # * <tt>:foreign_key</tt> - specify the foreign key used for the association. By default this is guessed to be the name
912 913
      #   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 已提交
914
      # * <tt>:association_foreign_key</tt> - specify the association foreign key used for the association. By default this is
915 916 917 918 919 920 921 922 923 924 925
      #   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>.
      # * <tt>:order</tt> - specify the order in which the associated objects are returned as a <tt>ORDER BY</tt> SQL fragment, such as <tt>last_name, first_name DESC</tt>
      # * <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
      # * <tt>:delete_sql</tt> - overwrite the default generated SQL statement used to remove links between the associated 
      #   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
926
      # * <tt>:extend</tt>  - anonymous module for extending the proxy, see "Association extensions".
927
      # * <tt>:include</tt>  - specify second-order associations that should be eager loaded when the collection is loaded.
928
      # * <tt>:group</tt>: An attribute name by which the result should be grouped. Uses the <tt>GROUP BY</tt> SQL-clause.
929 930
      # * <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.
931 932
      # * <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 已提交
933 934 935
      #
      # Option examples:
      #   has_and_belongs_to_many :projects
936
      #   has_and_belongs_to_many :projects, :include => [ :milestones, :manager ]
D
Initial  
David Heinemeier Hansson 已提交
937 938
      #   has_and_belongs_to_many :nations, :class_name => "Country"
      #   has_and_belongs_to_many :categories, :join_table => "prods_cats"
939 940
      #   has_and_belongs_to_many :active_projects, :join_table => 'developers_projects', :delete_sql => 
      #   'DELETE FROM developers_projects WHERE active=1 AND developer_id = #{id} AND project_id = #{record.id}'
941
      def has_and_belongs_to_many(association_id, options = {}, &extension)
942 943 944 945
        reflection = create_has_and_belongs_to_many_reflection(association_id, options, &extension)
        
        add_multiple_associated_save_callbacks(reflection.name)
        collection_accessor_methods(reflection, HasAndBelongsToManyAssociation)
D
Initial  
David Heinemeier Hansson 已提交
946

947 948
        # Don't use a before_destroy callback since users' before_destroy
        # callbacks will be executed after the association is wiped out.
949
        old_method = "destroy_without_habtm_shim_for_#{reflection.name}"
950 951 952
        class_eval <<-end_eval
          alias_method :#{old_method}, :destroy_without_callbacks
          def destroy_without_callbacks
953
            #{reflection.name}.clear
954 955 956 957
            #{old_method}
          end
        end_eval

958
        add_association_callbacks(reflection.name, options)
D
Initial  
David Heinemeier Hansson 已提交
959 960 961
      end

      private
962 963 964 965 966 967
        # 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 已提交
968 969 970 971 972 973 974 975 976
        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
977
      
978 979
        def association_accessor_methods(reflection, association_proxy_class)
          define_method(reflection.name) do |*params|
980
            force_reload = params.first unless params.empty?
981 982 983 984
            association = instance_variable_get("@#{reflection.name}")

            if association.nil? || force_reload
              association = association_proxy_class.new(self, reflection)
985
              retval = association.reload
986
              if retval.nil? and association_proxy_class == BelongsToAssociation
987
                instance_variable_set("@#{reflection.name}", nil)
988 989
                return nil
              end
990
              instance_variable_set("@#{reflection.name}", association)
991
            end
992 993

            association.target.nil? ? nil : association
994 995
          end

996 997
          define_method("#{reflection.name}=") do |new_value|
            association = instance_variable_get("@#{reflection.name}")
998
            if association.nil? || association.target != new_value
999
              association = association_proxy_class.new(self, reflection)
1000
            end
1001

1002
            association.replace(new_value)
1003

1004
            unless new_value.nil?
1005
              instance_variable_set("@#{reflection.name}", association)
1006
            else
1007
              instance_variable_set("@#{reflection.name}", nil)
1008 1009
            end
          end
1010

1011
          define_method("set_#{reflection.name}_target") do |target|
1012
            return if target.nil? and association_proxy_class == BelongsToAssociation
1013
            association = association_proxy_class.new(self, reflection)
1014
            association.target = target
1015
            instance_variable_set("@#{reflection.name}", association)
1016
          end
1017 1018
        end

1019 1020
        def collection_reader_method(reflection, association_proxy_class)
          define_method(reflection.name) do |*params|
1021
            force_reload = params.first unless params.empty?
1022 1023
            association = instance_variable_get("@#{reflection.name}")

1024
            unless association.respond_to?(:loaded?)
1025 1026
              association = association_proxy_class.new(self, reflection)
              instance_variable_set("@#{reflection.name}", association)
D
Initial  
David Heinemeier Hansson 已提交
1027
            end
1028

1029
            association.reload if force_reload
1030

1031 1032
            association
          end
1033
        end
D
Initial  
David Heinemeier Hansson 已提交
1034

1035
        def collection_accessor_methods(reflection, association_proxy_class, writer = true)
1036 1037 1038
          collection_reader_method(reflection, association_proxy_class)

          define_method("#{reflection.name}=") do |new_value|
1039 1040
            # Loads proxy class instance (defined in collection_reader_method) if not already loaded
            association = send(reflection.name) 
1041 1042 1043
            association.replace(new_value)
            association
          end
1044

1045 1046 1047 1048
          define_method("#{reflection.name.to_s.singularize}_ids") do
            send(reflection.name).map(&:id)
          end

1049
          define_method("#{reflection.name.to_s.singularize}_ids=") do |new_value|
1050 1051
            ids = (new_value || []).reject { |nid| nid.blank? }
            send("#{reflection.name}=", reflection.class_name.constantize.find(ids))
1052
          end if writer
D
Initial  
David Heinemeier Hansson 已提交
1053 1054
        end

1055
        def add_multiple_associated_save_callbacks(association_name)
1056 1057 1058 1059
          method_name = "validate_associated_records_for_#{association_name}".to_sym
          define_method(method_name) do
            association = instance_variable_get("@#{association_name}")
            if association.respond_to?(:loaded?)
1060
              if new_record?
1061 1062
                association
              else
1063
                association.select { |record| record.new_record? }
1064 1065
              end.each do |record|
                errors.add "#{association_name}" unless record.valid?
D
Initial  
David Heinemeier Hansson 已提交
1066
              end
1067
            end
1068
          end
D
Initial  
David Heinemeier Hansson 已提交
1069

1070
          validate method_name
1071
          before_save("@new_record_before_save = new_record?; true")
1072 1073 1074

          after_callback = <<-end_eval
            association = instance_variable_get("@#{association_name}")
1075 1076

            if association.respond_to?(:loaded?) && association.loaded?
1077 1078 1079
              if @new_record_before_save
                records_to_save = association
              else
1080
                records_to_save = association.select { |record| record.new_record? }
1081
              end
1082 1083 1084 1085
              records_to_save.each { |record| association.send(:insert_record, record) }
              association.send(:construct_sql)   # reconstruct the SQL queries now that we know the owner's id
            end
          end_eval
1086

1087 1088 1089
          # 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 已提交
1090
        end
1091

1092 1093
        def association_constructor_method(constructor, reflection, association_proxy_class)
          define_method("#{constructor}_#{reflection.name}") do |*params|
1094 1095
            attributees      = params.first unless params.empty?
            replace_existing = params[1].nil? ? true : params[1]
1096
            association      = instance_variable_get("@#{reflection.name}")
1097 1098

            if association.nil?
1099 1100
              association = association_proxy_class.new(self, reflection)
              instance_variable_set("@#{reflection.name}", association)
1101 1102
            end

1103 1104 1105 1106 1107
            if association_proxy_class == HasOneAssociation
              association.send(constructor, attributees, replace_existing)
            else
              association.send(constructor, attributees)
            end
1108 1109
          end
        end
1110
        
1111
        def find_with_associations(options = {})
1112 1113 1114 1115 1116 1117
          catch :invalid_query do
            join_dependency = JoinDependency.new(self, merge_includes(scope(:find, :include), options[:include]), options[:joins])
            rows = select_all_rows(options, join_dependency)
            return join_dependency.instantiate(rows)
          end
          []
1118
        end
1119

1120 1121 1122
        def configure_dependency_for_has_many(reflection)
          # See HasManyAssociation#delete_records.  Dependent associations
          # delete children, otherwise foreign key is set to NULL.
1123 1124

          # Add polymorphic type if the :as option is present
1125 1126 1127 1128 1129
          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 ")
1130

1131
          case reflection.options[:dependent]
1132
            when :destroy
1133 1134
              module_eval "before_destroy '#{reflection.name}.each { |o| o.destroy }'"
            when :delete_all
1135
              module_eval "before_destroy { |record| #{reflection.class_name}.delete_all(%(#{dependent_conditions})) }"
1136
            when :nullify
1137
              module_eval "before_destroy { |record| #{reflection.class_name}.update_all(%(#{reflection.primary_key_name} = NULL),  %(#{dependent_conditions})) }"
1138
            when nil
1139 1140
              # pass
            else
1141
              raise ArgumentError, 'The :dependent option expects either :destroy, :delete_all, or :nullify'
1142 1143
          end
        end
1144

1145 1146
        def configure_dependency_for_has_one(reflection)
          case reflection.options[:dependent]
1147
            when :destroy
1148
              module_eval "before_destroy '#{reflection.name}.destroy unless #{reflection.name}.nil?'"
1149 1150
            when :delete
              module_eval "before_destroy '#{reflection.class_name}.delete(#{reflection.name}.id) unless #{reflection.name}.nil?'"
1151
            when :nullify
1152
              module_eval "before_destroy '#{reflection.name}.update_attribute(\"#{reflection.primary_key_name}\", nil) unless #{reflection.name}.nil?'"
1153
            when nil
1154 1155
              # pass
            else
1156
              raise ArgumentError, "The :dependent option expects either :destroy, :delete or :nullify."
1157 1158 1159 1160 1161
          end
        end

        def create_has_many_reflection(association_id, options, &extension)
          options.assert_valid_keys(
1162
            :class_name, :table_name, :foreign_key,
1163
            :dependent,
1164
            :select, :conditions, :include, :order, :group, :limit, :offset,
1165
            :as, :through, :source, :source_type,
1166
            :uniq,
1167 1168 1169
            :finder_sql, :counter_sql, 
            :before_add, :after_add, :before_remove, :after_remove, 
            :extend
1170 1171
          )

1172
          options[:extend] = create_extension_modules(association_id, extension, options[:extend]) if block_given?
1173

1174
          create_reflection(:has_many, association_id, options, self)
1175 1176 1177 1178
        end

        def create_has_one_reflection(association_id, options)
          options.assert_valid_keys(
1179
            :class_name, :foreign_key, :remote, :conditions, :order, :include, :dependent, :counter_cache, :extend, :as
1180 1181
          )

1182
          create_reflection(:has_one, association_id, options, self)
1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201
        end

        def create_belongs_to_reflection(association_id, options)
          options.assert_valid_keys(
            :class_name, :foreign_key, :foreign_type, :remote, :conditions, :order, :include, :dependent, 
            :counter_cache, :extend, :polymorphic
          )
          
          reflection = create_reflection(:belongs_to, association_id, options, self)

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

          reflection
        end
        
        def create_has_and_belongs_to_many_reflection(association_id, options, &extension)
          options.assert_valid_keys(
1202 1203
            :class_name, :table_name, :join_table, :foreign_key, :association_foreign_key, 
            :select, :conditions, :include, :order, :group, :limit, :offset,
1204 1205
            :uniq, 
            :finder_sql, :delete_sql, :insert_sql,
1206 1207
            :before_add, :after_add, :before_remove, :after_remove, 
            :extend
1208 1209
          )

1210
          options[:extend] = create_extension_modules(association_id, extension, options[:extend]) if block_given?
1211 1212 1213 1214 1215 1216 1217 1218

          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))
          
          reflection
        end

1219
        def reflect_on_included_associations(associations)
1220
          [ associations ].flatten.collect { |association| reflect_on_association(association.to_s.intern) }
1221 1222
        end

1223 1224 1225 1226 1227 1228 1229 1230 1231
        def guard_against_unlimitable_reflections(reflections, options)
          if (options[:offset] || options[:limit]) && !using_limitable_reflections?(reflections)
            raise(
              ConfigurationError, 
              "You can not use offset and limit together with has_many or has_and_belongs_to_many associations"
            )
          end
        end

1232
        def select_all_rows(options, join_dependency)
1233
          connection.select_all(
1234
            construct_finder_sql_with_included_associations(options, join_dependency),
1235 1236 1237
            "#{name} Load Including Associations"
          )
        end
1238

1239
        def construct_finder_sql_with_included_associations(options, join_dependency)
1240
          scope = scope(:find)
1241
          sql = "SELECT #{column_aliases(join_dependency)} FROM #{(scope && scope[:from]) || options[:from] || table_name} "
1242
          sql << join_dependency.join_associations.collect{|join| join.association_join }.join
1243
 
1244 1245
          add_joins!(sql, options, scope)
          add_conditions!(sql, options[:conditions], scope)
1246
          add_limited_ids_condition!(sql, options, join_dependency) if !using_limitable_reflections?(join_dependency.reflections) && ((scope && scope[:limit]) || options[:limit])
1247

1248
          add_group!(sql, options[:group], scope)
1249
          add_order!(sql, options[:order], scope)
1250
          add_limit!(sql, options, scope) if using_limitable_reflections?(join_dependency.reflections)
1251
          add_lock!(sql, options, scope)
1252
 
1253 1254
          return sanitize_sql(sql)
        end
1255
 
1256 1257
        def add_limited_ids_condition!(sql, options, join_dependency)
          unless (id_list = select_limited_ids_list(options, join_dependency)).empty?
1258
            sql << "#{condition_word(sql)} #{table_name}.#{primary_key} IN (#{id_list}) "
1259 1260
          else
            throw :invalid_query
1261 1262
          end
        end
1263

1264
        def select_limited_ids_list(options, join_dependency)
1265 1266
          pk = columns_hash[primary_key]

1267
          connection.select_all(
1268
            construct_finder_sql_for_association_limiting(options, join_dependency),
1269
            "#{name} Load IDs For Limited Eager Loading"
1270
          ).collect { |row| connection.quote(row[primary_key], pk) }.join(", ")
1271
        end
1272

1273
        def construct_finder_sql_for_association_limiting(options, join_dependency)
1274
          scope       = scope(:find)
1275
          is_distinct = !options[:joins].blank? || include_eager_conditions?(options) || include_eager_order?(options)
1276
          sql = "SELECT "
1277
          if is_distinct
1278
            sql << connection.distinct("#{table_name}.#{primary_key}", options[:order])
1279 1280 1281
          else
            sql << primary_key
          end
1282
          sql << " FROM #{table_name} "
1283

1284
          if is_distinct
1285
            sql << join_dependency.join_associations.collect(&:association_join).join
1286
            add_joins!(sql, options, scope)
1287
          end
1288

1289
          add_conditions!(sql, options[:conditions], scope)
1290
          add_group!(sql, options[:group], scope)
1291

1292 1293 1294 1295
          if options[:order]
            if is_distinct
              connection.add_order_by_for_association_limiting!(sql, options)
            else
1296
              add_order!(sql, options[:order], scope)
1297 1298
            end
          end
1299

1300
          add_limit!(sql, options, scope)
1301

1302 1303
          return sanitize_sql(sql)
        end
1304

1305
        # Checks if the conditions reference a table other than the current model table
1306
        def include_eager_conditions?(options)
1307 1308 1309 1310 1311 1312 1313 1314 1315
          # 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?
1316
          conditions.join(' ').scan(/([\.\w]+)\.\w+/).flatten.any? do |condition_table_name|
1317 1318 1319
            condition_table_name != table_name
          end
        end
1320
        
1321
        # Checks if the query order references a table other than the current model's table.
1322 1323 1324
        def include_eager_order?(options)
          order = options[:order]
          return false unless order
1325
          order.scan(/([\.\w]+)\.\w+/).flatten.any? do |order_table_name|
1326 1327 1328
            order_table_name != table_name
          end
        end
1329

1330 1331 1332 1333
        def using_limitable_reflections?(reflections)
          reflections.reject { |r| [ :belongs_to, :has_one ].include?(r.macro) }.length.zero?
        end

1334 1335 1336
        def column_aliases(join_dependency)
          join_dependency.joins.collect{|join| join.column_names_with_alias.collect{|column_name, aliased_name|
              "#{join.aliased_table_name}.#{connection.quote_column_name column_name} AS #{aliased_name}"}}.flatten.join(", ")
1337 1338
        end

1339
        def add_association_callbacks(association_name, options)
1340 1341
          callbacks = %w(before_add after_add before_remove after_remove)
          callbacks.each do |callback_name|
1342
            full_callback_name = "#{callback_name}_for_#{association_name}"
1343 1344 1345 1346 1347 1348
            defined_callbacks = options[callback_name.to_sym]
            if options.has_key?(callback_name.to_sym)
              class_inheritable_reader full_callback_name.to_sym
              write_inheritable_array(full_callback_name.to_sym, [defined_callbacks].flatten)
            end
          end
1349
        end
1350

1351 1352 1353
        def condition_word(sql)
          sql =~ /where/i ? " AND " : "WHERE "
        end
1354

1355
        def create_extension_modules(association_id, block_extension, extensions)
1356 1357 1358
          extension_module_name = "#{self.to_s}#{association_id.to_s.camelize}AssociationExtension"

          silence_warnings do
1359
            Object.const_set(extension_module_name, Module.new(&block_extension))
1360
          end
1361 1362

          Array(extensions).push(extension_module_name.constantize)
1363
        end
1364

D
David Heinemeier Hansson 已提交
1365
        class JoinDependency # :nodoc:
1366
          attr_reader :joins, :reflections, :table_aliases
1367

1368 1369
          def initialize(base, associations, joins)
            @joins                 = [JoinBase.new(base, joins)]
1370 1371 1372 1373
            @associations          = associations
            @reflections           = []
            @base_records_hash     = {}
            @base_records_in_order = []
1374 1375
            @table_aliases         = Hash.new { |aliases, table| aliases[table] = 0 }
            @table_aliases[base.table_name] = 1
1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450
            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
              construct(@base_records_hash[primary_id], @associations, join_associations.dup, row)
            end
            return @base_records_in_order
          end

          def aliased_table_names_for(table_name)
            joins.select{|join| join.table_name == table_name }.collect{|join| join.aliased_table_name}
          end

          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
                  @joins << JoinAssociation.new(reflection, self, parent)
                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

            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
1451

1452 1453 1454
                  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)
                  collection.target.push(association) unless collection.target.include?(association)
1455 1456 1457 1458 1459
                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
1460 1461 1462 1463 1464 1465 1466 1467 1468
                  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 已提交
1469
          class JoinBase # :nodoc:
1470
            attr_reader :active_record, :table_joins
1471
            delegate    :table_name, :column_names, :primary_key, :reflections, :sanitize_sql, :to => :active_record
1472

1473
            def initialize(active_record, joins = nil)
1474 1475
              @active_record = active_record
              @cached_record = {}
1476
              @table_joins   = joins
1477 1478 1479 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 1506 1507 1508 1509
            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
              unless @column_names_with_alias
                @column_names_with_alias = []
                ([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
              return @column_names_with_alias
            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)
1510
              @cached_record[record_id(row)] ||= active_record.send(:instantiate, extract_record(row))
1511 1512 1513
            end
          end

D
David Heinemeier Hansson 已提交
1514
          class JoinAssociation < JoinBase # :nodoc:
1515
            attr_reader :reflection, :parent, :aliased_table_name, :aliased_prefix, :aliased_join_table_name, :parent_table_name
1516
            delegate    :options, :klass, :through_reflection, :source_reflection, :to => :reflection
1517 1518

            def initialize(reflection, join_dependency, parent = nil)
1519 1520 1521 1522 1523
              reflection.check_validity!
              if reflection.options[:polymorphic]
                raise EagerLoadPolymorphicError.new(reflection)
              end

1524 1525 1526 1527
              super(reflection.klass)
              @parent             = parent
              @reflection         = reflection
              @aliased_prefix     = "t#{ join_dependency.joins.size }"
1528
              @aliased_table_name = table_name #.tr('.', '_') # start with the table name, sub out any .'s
1529
              @parent_table_name  = parent.active_record.table_name
1530

1531
              if !parent.table_joins.blank? && parent.table_joins.to_s.downcase =~ %r{join(\s+\w+)?\s+#{aliased_table_name.downcase}\son}
1532 1533 1534
                join_dependency.table_aliases[aliased_table_name] += 1
              end
              
1535 1536
              unless join_dependency.table_aliases[aliased_table_name].zero?
                # if the table name has been used, then use an alias
J
Jeremy Kemper 已提交
1537
                @aliased_table_name = active_record.connection.table_alias_for "#{pluralize(reflection.name)}_#{parent_table_name}"
1538
                table_index = join_dependency.table_aliases[aliased_table_name]
J
Jeremy Kemper 已提交
1539
                join_dependency.table_aliases[aliased_table_name] += 1
1540
                @aliased_table_name = @aliased_table_name[0..active_record.connection.table_alias_length-3] + "_#{table_index+1}" if table_index > 0
1541 1542
              else
                join_dependency.table_aliases[aliased_table_name] += 1
1543
              end
1544
              
1545
              if reflection.macro == :has_and_belongs_to_many || (reflection.macro == :has_many && reflection.options[:through])
1546
                @aliased_join_table_name = reflection.macro == :has_and_belongs_to_many ? reflection.options[:join_table] : reflection.through_reflection.klass.table_name
1547
                unless join_dependency.table_aliases[aliased_join_table_name].zero?
1548 1549
                  @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 已提交
1550
                  join_dependency.table_aliases[aliased_join_table_name] += 1
1551
                  @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 已提交
1552 1553
                else
                  join_dependency.table_aliases[aliased_join_table_name] += 1
1554 1555
                end
              end
1556 1557 1558
            end

            def association_join
1559
              join = case reflection.macro
1560
                when :has_and_belongs_to_many
1561 1562 1563
                  " LEFT OUTER JOIN %s ON %s.%s = %s.%s " % [
                     table_alias_for(options[:join_table], aliased_join_table_name),
                     aliased_join_table_name,
1564
                     options[:foreign_key] || reflection.active_record.to_s.foreign_key,
J
Jeremy Kemper 已提交
1565
                     parent.aliased_table_name, reflection.active_record.primary_key] +
1566 1567
                  " LEFT OUTER JOIN %s ON %s.%s = %s.%s " % [
                     table_name_and_alias, aliased_table_name, klass.primary_key,
1568
                     aliased_join_table_name, options[:association_foreign_key] || klass.to_s.foreign_key
1569 1570
                     ]
                when :has_many, :has_one
1571 1572
                  case
                    when reflection.macro == :has_many && reflection.options[:through]
1573
                      through_conditions = through_reflection.options[:conditions] ? "AND #{interpolate_sql(sanitize_sql(through_reflection.options[:conditions]))}" : ''
1574 1575 1576 1577
                      
                      jt_foreign_key = jt_as_extra = jt_source_extra = jt_sti_extra = nil 
                      first_key = second_key = as_extra = nil 
                      
1578
                      if through_reflection.options[:as] # has_many :through against a polymorphic join
1579 1580 1581 1582 1583
                        jt_foreign_key = through_reflection.options[:as].to_s + '_id'
                        jt_as_extra = " AND %s.%s = %s" % [
                          aliased_join_table_name,
                          reflection.active_record.connection.quote_column_name(through_reflection.options[:as].to_s + '_type'),
                          klass.quote_value(parent.active_record.base_class.name)
1584
                        ]
1585
                      else
1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597
                        jt_foreign_key = through_reflection.primary_key_name 
                      end
                        
                      case source_reflection.macro
                      when :has_many
                        if source_reflection.options[:as] 
                          first_key   = "#{source_reflection.options[:as]}_id" 
                          second_key  = options[:foreign_key] || primary_key 
                          as_extra    = " AND %s.%s = %s" % [
                            aliased_table_name,
                            reflection.active_record.connection.quote_column_name("#{source_reflection.options[:as]}_type"),  
                            klass.quote_value(source_reflection.active_record.base_class.name) 
1598 1599
                          ]
                        else
1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617
                          first_key   = through_reflection.klass.base_class.to_s.foreign_key
                          second_key  = options[:foreign_key] || primary_key
                        end
                        
                        unless through_reflection.klass.descends_from_active_record?
                          jt_sti_extra = " AND %s.%s = %s" % [
                            aliased_join_table_name,
                            reflection.active_record.connection.quote_column_name(through_reflection.active_record.inheritance_column),
                            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" % [
                            aliased_join_table_name,
                            reflection.active_record.connection.quote_column_name(reflection.source_reflection.options[:foreign_type]),
                            klass.quote_value(reflection.options[:source_type])
1618
                          ]
1619 1620
                        else
                          second_key = source_reflection.options[:foreign_key] || klass.to_s.foreign_key
1621
                        end
1622
                      end
1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636

                      " LEFT OUTER JOIN %s ON (%s.%s = %s.%s%s%s%s) " % [
                        table_alias_for(through_reflection.klass.table_name, aliased_join_table_name),
                        parent.aliased_table_name, reflection.active_record.connection.quote_column_name(parent.primary_key),
                        aliased_join_table_name, reflection.active_record.connection.quote_column_name(jt_foreign_key), 
                        jt_as_extra, jt_source_extra, jt_sti_extra
                      ] +
                      " LEFT OUTER JOIN %s ON (%s.%s = %s.%s%s) " % [
                        table_name_and_alias, 
                        aliased_table_name, reflection.active_record.connection.quote_column_name(first_key),
                        aliased_join_table_name, reflection.active_record.connection.quote_column_name(second_key),
                        as_extra
                      ]

1637
                    when reflection.options[:as] && [:has_many, :has_one].include?(reflection.macro)
1638 1639
                      " LEFT OUTER JOIN %s ON %s.%s = %s.%s AND %s.%s = %s" % [
                        table_name_and_alias,
1640 1641 1642
                        aliased_table_name, "#{reflection.options[:as]}_id",
                        parent.aliased_table_name, parent.primary_key,
                        aliased_table_name, "#{reflection.options[:as]}_type",
1643
                        klass.quote_value(parent.active_record.base_class.name)
1644 1645
                      ]
                    else
1646
                      foreign_key = options[:foreign_key] || reflection.active_record.name.foreign_key
1647 1648
                      " LEFT OUTER JOIN %s ON %s.%s = %s.%s " % [
                        table_name_and_alias,
1649
                        aliased_table_name, foreign_key,
1650 1651 1652
                        parent.aliased_table_name, parent.primary_key
                      ]
                  end
1653
                when :belongs_to
1654 1655
                  " LEFT OUTER JOIN %s ON %s.%s = %s.%s " % [
                     table_name_and_alias, aliased_table_name, reflection.klass.primary_key,
1656
                     parent.aliased_table_name, options[:foreign_key] || klass.to_s.foreign_key
1657 1658 1659
                    ]
                else
                  ""
1660
              end || ''
1661
              join << %(AND %s.%s = %s ) % [
1662
                aliased_table_name, 
1663
                reflection.active_record.connection.quote_column_name(klass.inheritance_column), 
1664
                klass.quote_value(klass.name.demodulize)] unless klass.descends_from_active_record?
1665 1666 1667 1668 1669

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

1670
              join
1671
            end
1672 1673
            
            protected
1674

1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685
              def pluralize(table_name)
                ActiveRecord::Base.pluralize_table_names ? table_name.to_s.pluralize : table_name
              end
              
              def table_alias_for(table_name, table_alias)
                "#{table_name} #{table_alias if table_name != table_alias}".strip
              end

              def table_name_and_alias
                table_alias_for table_name, @aliased_table_name
              end
1686 1687 1688 1689

              def interpolate_sql(sql)
                instance_eval("%@#{sql.gsub('@', '\@')}@") 
              end 
1690 1691
          end
        end
1692
    end
D
Initial  
David Heinemeier Hansson 已提交
1693
  end
1694
end