associations.rb 111.9 KB
Newer Older
D
Initial  
David Heinemeier Hansson 已提交
1
module ActiveRecord
D
David Heinemeier Hansson 已提交
2
  class HasManyThroughAssociationNotFoundError < ActiveRecordError #:nodoc:
3 4
    def initialize(owner_class_name, reflection)
      super("Could not find the association #{reflection.options[:through].inspect} in model #{owner_class_name}")
5 6 7
    end
  end

D
David Heinemeier Hansson 已提交
8
  class HasManyThroughAssociationPolymorphicError < ActiveRecordError #:nodoc:
9
    def initialize(owner_class_name, reflection, source_reflection)
10
      super("Cannot have a has_many :through association '#{owner_class_name}##{reflection.name}' on the polymorphic object '#{source_reflection.class_name}##{source_reflection.name}'.")
11 12
    end
  end
13

14 15 16 17 18
  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
19

D
David Heinemeier Hansson 已提交
20
  class HasManyThroughSourceAssociationNotFoundError < ActiveRecordError #:nodoc:
21
    def initialize(reflection)
22 23 24
      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 }
25
      super("Could not find the source association(s) #{source_reflection_names.collect(&:inspect).to_sentence(:two_words_connector => ' or ', :last_word_connector => ', or ', :locale => :en)} 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(:two_words_connector => ' or ', :last_word_connector => ', or ', :locale => :en)}?")
26 27 28
    end
  end

29
  class HasManyThroughSourceAssociationMacroError < ActiveRecordError #:nodoc:
30
    def initialize(reflection)
31 32 33
      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.")
34 35 36
    end
  end

37 38 39 40 41
  class HasManyThroughCantAssociateThroughHasManyReflection < ActiveRecordError #:nodoc:
    def initialize(owner, reflection)
      super("Cannot modify association '#{owner.class.name}##{reflection.name}' because the source reflection class '#{reflection.source_reflection.class_name}' is associated to '#{reflection.through_reflection.class_name}' via :#{reflection.source_reflection.macro}.")
    end
  end
42 43 44 45 46 47
  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

48 49 50 51 52 53
  class HasManyThroughCantDissociateNewRecords < ActiveRecordError #:nodoc:
    def initialize(owner, reflection)
      super("Cannot dissociate new records through '#{owner.class.name}##{reflection.name}' on '#{reflection.source_reflection.class_name rescue nil}##{reflection.source_reflection.name rescue nil}'. Both records must have an id in order to delete the has_many :through record associating them.")
    end
  end

54 55 56 57 58 59
  class HasAndBelongsToManyAssociationForeignKeyNeeded < ActiveRecordError #:nodoc:
    def initialize(reflection)
      super("Cannot create self referential has_and_belongs_to_many association on '#{reflection.class_name rescue nil}##{reflection.name rescue nil}'. :association_foreign_key cannot be the same as the :foreign_key.")
    end
  end

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

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

P
Pratik Naik 已提交
72
  # See ActiveRecord::Associations::ClassMethods for documentation.
D
Initial  
David Heinemeier Hansson 已提交
73
  module Associations # :nodoc:
74
    # These classes will be loaded when associations are created.
J
Joshua Peek 已提交
75 76 77 78 79 80 81 82 83 84 85
    # So there is no need to eager load them.
    autoload :AssociationCollection, 'active_record/associations/association_collection'
    autoload :AssociationProxy, 'active_record/associations/association_proxy'
    autoload :BelongsToAssociation, 'active_record/associations/belongs_to_association'
    autoload :BelongsToPolymorphicAssociation, 'active_record/associations/belongs_to_polymorphic_association'
    autoload :HasAndBelongsToManyAssociation, 'active_record/associations/has_and_belongs_to_many_association'
    autoload :HasManyAssociation, 'active_record/associations/has_many_association'
    autoload :HasManyThroughAssociation, 'active_record/associations/has_many_through_association'
    autoload :HasOneAssociation, 'active_record/associations/has_one_association'
    autoload :HasOneThroughAssociation, 'active_record/associations/has_one_through_association'

86
    def self.included(base)
87 88 89
      base.extend(ClassMethods)
    end

90
    # Clears out the association cache
91 92 93
    def clear_association_cache #:nodoc:
      self.class.reflect_on_all_associations.to_a.each do |assoc|
        instance_variable_set "@#{assoc.name}", nil
94
      end unless self.new_record?
95
    end
96

97 98 99 100 101 102 103 104 105 106 107 108
    private
      # Gets the specified association instance if it responds to :loaded?, nil otherwise.
      def association_instance_get(name)
        association = instance_variable_get("@#{name}")
        association if association.respond_to?(:loaded?)
      end

      # Set the specified association instance.
      def association_instance_set(name, association)
        instance_variable_set("@#{name}", association)
      end

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

798
        if options[:through]
799
          collection_accessor_methods(reflection, HasManyThroughAssociation)
800 801
        else
          collection_accessor_methods(reflection, HasManyAssociation)
D
Initial  
David Heinemeier Hansson 已提交
802 803 804
        end
      end

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

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

996 997
        if reflection.options[:polymorphic]
          association_accessor_methods(reflection, BelongsToPolymorphicAssociation)
998
        else
999 1000 1001
          association_accessor_methods(reflection, BelongsToAssociation)
          association_constructor_method(:build,  reflection, BelongsToAssociation)
          association_constructor_method(:create, reflection, BelongsToAssociation)
1002
        end
1003

1004
        # Create the callbacks to update counter cache
1005
        if options[:counter_cache]
1006
          cache_column = reflection.counter_cache_column
1007

1008 1009
          method_name = "belongs_to_counter_cache_after_create_for_#{reflection.name}".to_sym
          define_method(method_name) do
1010 1011
            association = send(reflection.name)
            association.class.increment_counter(cache_column, send(reflection.primary_key_name)) unless association.nil?
1012 1013
          end
          after_create method_name
1014

1015 1016
          method_name = "belongs_to_counter_cache_before_destroy_for_#{reflection.name}".to_sym
          define_method(method_name) do
1017 1018
            association = send(reflection.name)
            association.class.decrement_counter(cache_column, send(reflection.primary_key_name)) unless association.nil?
1019 1020
          end
          before_destroy method_name
1021

1022
          module_eval(
1023
            "#{reflection.class_name}.send(:attr_readonly,\"#{cache_column}\".intern) if defined?(#{reflection.class_name}) && #{reflection.class_name}.respond_to?(:attr_readonly)"
1024
          )
1025
        end
1026 1027

        configure_dependency_for_belongs_to(reflection)
1028 1029
      end

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

1194 1195
        # Don't use a before_destroy callback since users' before_destroy
        # callbacks will be executed after the association is wiped out.
1196
        old_method = "destroy_without_habtm_shim_for_#{reflection.name}"
1197
        class_eval <<-end_eval unless method_defined?(old_method)
1198 1199 1200 1201 1202
          alias_method :#{old_method}, :destroy_without_callbacks  # alias_method :destroy_without_habtm_shim_for_posts, :destroy_without_callbacks
          def destroy_without_callbacks                            # def destroy_without_callbacks
            #{reflection.name}.clear                               #   posts.clear
            #{old_method}                                          #   destroy_without_habtm_shim_for_posts
          end                                                      # end
1203 1204
        end_eval

1205
        add_association_callbacks(reflection.name, options)
D
Initial  
David Heinemeier Hansson 已提交
1206 1207 1208
      end

      private
P
Pratik Naik 已提交
1209 1210 1211 1212 1213
        # Generates a join table name from two provided table names.
        # The names in the join table namesme end up in lexicographic order.
        #
        #   join_table_name("members", "clubs")         # => "clubs_members"
        #   join_table_name("members", "special_clubs") # => "members_special_clubs"
D
Initial  
David Heinemeier Hansson 已提交
1214 1215 1216 1217 1218 1219 1220 1221 1222
        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
1223

1224 1225
        def association_accessor_methods(reflection, association_proxy_class)
          define_method(reflection.name) do |*params|
1226
            force_reload = params.first unless params.empty?
1227
            association = association_instance_get(reflection.name)
1228

1229
            if association.nil? || force_reload
1230
              association = association_proxy_class.new(self, reflection)
1231
              retval = association.reload
1232
              if retval.nil? and association_proxy_class == BelongsToAssociation
1233
                association_instance_set(reflection.name, nil)
1234 1235
                return nil
              end
1236
              association_instance_set(reflection.name, association)
1237
            end
1238 1239

            association.target.nil? ? nil : association
1240 1241
          end

1242
          define_method("loaded_#{reflection.name}?") do
1243
            association = association_instance_get(reflection.name)
1244 1245 1246
            association && association.loaded?
          end

1247
          define_method("#{reflection.name}=") do |new_value|
1248
            association = association_instance_get(reflection.name)
1249

1250
            if association.nil? || association.target != new_value
1251
              association = association_proxy_class.new(self, reflection)
1252
            end
1253

1254 1255 1256 1257
            if association_proxy_class == HasOneThroughAssociation
              association.create_through_record(new_value)
              self.send(reflection.name, new_value)
            else
P
pivotal 已提交
1258
              association.replace(new_value)
1259
              association_instance_set(reflection.name, new_value.nil? ? nil : association)
1260
            end
1261
          end
1262

1263
          define_method("set_#{reflection.name}_target") do |target|
1264
            return if target.nil? and association_proxy_class == BelongsToAssociation
1265
            association = association_proxy_class.new(self, reflection)
1266
            association.target = target
1267
            association_instance_set(reflection.name, association)
1268
          end
1269 1270
        end

1271 1272
        def collection_reader_method(reflection, association_proxy_class)
          define_method(reflection.name) do |*params|
1273
            force_reload = params.first unless params.empty?
1274
            association = association_instance_get(reflection.name)
1275

1276
            unless association
1277
              association = association_proxy_class.new(self, reflection)
1278
              association_instance_set(reflection.name, association)
D
Initial  
David Heinemeier Hansson 已提交
1279
            end
1280

1281
            association.reload if force_reload
1282

1283 1284
            association
          end
1285 1286

          define_method("#{reflection.name.to_s.singularize}_ids") do
1287
            if send(reflection.name).loaded? || reflection.options[:finder_sql]
1288 1289
              send(reflection.name).map(&:id)
            else
1290
              send(reflection.name).all(:select => "#{reflection.quoted_table_name}.#{reflection.klass.primary_key}").map(&:id)
1291
            end
1292
          end
1293
        end
D
Initial  
David Heinemeier Hansson 已提交
1294

1295
        def collection_accessor_methods(reflection, association_proxy_class, writer = true)
1296 1297
          collection_reader_method(reflection, association_proxy_class)

1298 1299 1300 1301 1302 1303 1304
          if writer
            define_method("#{reflection.name}=") do |new_value|
              # Loads proxy class instance (defined in collection_reader_method) if not already loaded
              association = send(reflection.name)
              association.replace(new_value)
              association
            end
1305

1306 1307 1308 1309
            define_method("#{reflection.name.to_s.singularize}_ids=") do |new_value|
              ids = (new_value || []).reject { |nid| nid.blank? }
              send("#{reflection.name}=", reflection.class_name.constantize.find(ids))
            end
1310
          end
D
Initial  
David Heinemeier Hansson 已提交
1311
        end
1312

1313 1314
        def association_constructor_method(constructor, reflection, association_proxy_class)
          define_method("#{constructor}_#{reflection.name}") do |*params|
1315 1316
            attributees      = params.first unless params.empty?
            replace_existing = params[1].nil? ? true : params[1]
1317
            association      = association_instance_get(reflection.name)
1318

1319
            unless association
1320
              association = association_proxy_class.new(self, reflection)
1321
              association_instance_set(reflection.name, association)
1322 1323
            end

1324 1325 1326 1327 1328
            if association_proxy_class == HasOneAssociation
              association.send(constructor, attributees, replace_existing)
            else
              association.send(constructor, attributees)
            end
1329 1330
          end
        end
1331

1332
        def find_with_associations(options = {})
1333
          catch :invalid_query do
1334
            join_dependency = JoinDependency.new(self, merge_includes(scope(:find, :include), options[:include]), options[:joins])
1335 1336 1337 1338
            rows = select_all_rows(options, join_dependency)
            return join_dependency.instantiate(rows)
          end
          []
1339
        end
1340

1341 1342 1343
        # Creates before_destroy callback methods that nullify, delete or destroy
        # has_many associated objects, according to the defined :dependent rule.
        #
1344 1345
        # See HasManyAssociation#delete_records.  Dependent associations
        # delete children, otherwise foreign key is set to NULL.
1346 1347 1348 1349 1350
        #
        # The +extra_conditions+ parameter, which is not used within the main
        # Active Record codebase, is meant to allow plugins to define extra
        # finder conditions.
        def configure_dependency_for_has_many(reflection, extra_conditions = nil)
1351 1352 1353 1354 1355 1356
          if reflection.options.include?(:dependent)
            # Add polymorphic type if the :as option is present
            dependent_conditions = []
            dependent_conditions << "#{reflection.primary_key_name} = \#{record.quoted_id}"
            dependent_conditions << "#{reflection.options[:as]}_type = '#{base_class.name}'" if reflection.options[:as]
            dependent_conditions << sanitize_sql(reflection.options[:conditions]) if reflection.options[:conditions]
1357
            dependent_conditions << extra_conditions if extra_conditions
1358
            dependent_conditions = dependent_conditions.collect {|where| "(#{where})" }.join(" AND ")
1359
            dependent_conditions = dependent_conditions.gsub('@', '\@')
1360 1361
            case reflection.options[:dependent]
              when :destroy
1362 1363
                method_name = "has_many_dependent_destroy_for_#{reflection.name}".to_sym
                define_method(method_name) do
1364
                  send(reflection.name).each { |o| o.destroy }
1365 1366
                end
                before_destroy method_name
1367
              when :delete_all
1368
                module_eval %Q{
1369 1370 1371 1372 1373 1374
                  before_destroy do |record|                  # before_destroy do |record|
                    delete_all_has_many_dependencies(record,  #   delete_all_has_many_dependencies(record,
                      "#{reflection.name}",                   #     "posts",
                      #{reflection.class_name},               #     Post,
                      %@#{dependent_conditions}@)             #     %@...@) # this is a string literal like %(...)
                  end                                         # end
1375
                }
1376
              when :nullify
1377
                module_eval %Q{
1378 1379 1380 1381 1382 1383 1384
                  before_destroy do |record|                  # before_destroy do |record|
                    nullify_has_many_dependencies(record,     #   nullify_has_many_dependencies(record,
                      "#{reflection.name}",                   #     "posts",
                      #{reflection.class_name},               #     Post,
                      "#{reflection.primary_key_name}",       #     "user_id",
                      %@#{dependent_conditions}@)             #     %@...@) # this is a string literal like %(...)
                  end                                         # end
1385
                }
1386 1387 1388
              else
                raise ArgumentError, "The :dependent option expects either :destroy, :delete_all, or :nullify (#{reflection.options[:dependent].inspect})"
            end
1389 1390
          end
        end
1391

P
Pratik Naik 已提交
1392 1393
        # Creates before_destroy callback methods that nullify, delete or destroy
        # has_one associated objects, according to the defined :dependent rule.
1394
        def configure_dependency_for_has_one(reflection)
1395 1396 1397
          if reflection.options.include?(:dependent)
            case reflection.options[:dependent]
              when :destroy
1398 1399
                method_name = "has_one_dependent_destroy_for_#{reflection.name}".to_sym
                define_method(method_name) do
1400
                  association = send(reflection.name)
1401 1402 1403
                  association.destroy unless association.nil?
                end
                before_destroy method_name
1404
              when :delete
1405 1406
                method_name = "has_one_dependent_delete_for_#{reflection.name}".to_sym
                define_method(method_name) do
P
Pratik Naik 已提交
1407 1408 1409 1410
                  # Retrieve the associated object and delete it. The retrieval
                  # is necessary because there may be multiple associated objects
                  # with foreign keys pointing to this object, and we only want
                  # to delete the correct one, not all of them.
1411
                  association = send(reflection.name)
1412
                  association.delete unless association.nil?
1413 1414
                end
                before_destroy method_name
1415
              when :nullify
1416 1417
                method_name = "has_one_dependent_nullify_for_#{reflection.name}".to_sym
                define_method(method_name) do
1418 1419
                  association = send(reflection.name)
                  association.update_attribute(reflection.primary_key_name, nil) unless association.nil?
1420 1421
                end
                before_destroy method_name
1422 1423 1424
              else
                raise ArgumentError, "The :dependent option expects either :destroy, :delete or :nullify (#{reflection.options[:dependent].inspect})"
            end
1425 1426 1427
          end
        end

1428 1429 1430 1431
        def configure_dependency_for_belongs_to(reflection)
          if reflection.options.include?(:dependent)
            case reflection.options[:dependent]
              when :destroy
1432 1433
                method_name = "belongs_to_dependent_destroy_for_#{reflection.name}".to_sym
                define_method(method_name) do
1434
                  association = send(reflection.name)
1435 1436
                  association.destroy unless association.nil?
                end
1437
                after_destroy method_name
1438
              when :delete
1439 1440
                method_name = "belongs_to_dependent_delete_for_#{reflection.name}".to_sym
                define_method(method_name) do
1441
                  association = send(reflection.name)
1442
                  association.delete unless association.nil?
1443
                end
1444
                after_destroy method_name
1445 1446 1447 1448 1449 1450
              else
                raise ArgumentError, "The :dependent option expects either :destroy or :delete (#{reflection.options[:dependent].inspect})"
            end
          end
        end

1451 1452 1453 1454 1455 1456 1457 1458
        def delete_all_has_many_dependencies(record, reflection_name, association_class, dependent_conditions)
          association_class.delete_all(dependent_conditions)
        end

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

1459 1460 1461 1462
        mattr_accessor :valid_keys_for_has_many_association
        @@valid_keys_for_has_many_association = [
          :class_name, :table_name, :foreign_key, :primary_key,
          :dependent,
1463
          :select, :conditions, :include, :order, :group, :having, :limit, :offset,
1464 1465 1466 1467 1468
          :as, :through, :source, :source_type,
          :uniq,
          :finder_sql, :counter_sql,
          :before_add, :after_add, :before_remove, :after_remove,
          :extend, :readonly,
1469
          :validate
1470 1471
        ]

1472
        def create_has_many_reflection(association_id, options, &extension)
1473
          options.assert_valid_keys(valid_keys_for_has_many_association)
1474
          options[:extend] = create_extension_modules(association_id, extension, options[:extend])
1475

1476
          create_reflection(:has_many, association_id, options, self)
1477 1478
        end

1479 1480 1481 1482
        mattr_accessor :valid_keys_for_has_one_association
        @@valid_keys_for_has_one_association = [
          :class_name, :foreign_key, :remote, :select, :conditions, :order,
          :include, :dependent, :counter_cache, :extend, :as, :readonly,
1483
          :validate, :primary_key
1484 1485
        ]

1486
        def create_has_one_reflection(association_id, options)
1487
          options.assert_valid_keys(valid_keys_for_has_one_association)
1488
          create_reflection(:has_one, association_id, options, self)
1489
        end
1490

1491 1492
        def create_has_one_through_reflection(association_id, options)
          options.assert_valid_keys(
1493
            :class_name, :foreign_key, :remote, :select, :conditions, :order, :include, :dependent, :counter_cache, :extend, :as, :through, :source, :source_type, :validate
1494 1495 1496
          )
          create_reflection(:has_one, association_id, options, self)
        end
1497

1498 1499 1500 1501
        mattr_accessor :valid_keys_for_belongs_to_association
        @@valid_keys_for_belongs_to_association = [
          :class_name, :foreign_key, :foreign_type, :remote, :select, :conditions,
          :include, :dependent, :counter_cache, :extend, :polymorphic, :readonly,
1502
          :validate
1503 1504
        ]

1505
        def create_belongs_to_reflection(association_id, options)
1506
          options.assert_valid_keys(valid_keys_for_belongs_to_association)
1507 1508 1509 1510 1511 1512 1513 1514
          reflection = create_reflection(:belongs_to, association_id, options, self)

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

          reflection
        end
1515

1516 1517 1518
        mattr_accessor :valid_keys_for_has_and_belongs_to_many_association
        @@valid_keys_for_has_and_belongs_to_many_association = [
          :class_name, :table_name, :join_table, :foreign_key, :association_foreign_key,
1519
          :select, :conditions, :include, :order, :group, :having, :limit, :offset,
1520
          :uniq,
1521
          :finder_sql, :counter_sql, :delete_sql, :insert_sql,
1522 1523 1524 1525 1526
          :before_add, :after_add, :before_remove, :after_remove,
          :extend, :readonly,
          :validate
        ]

1527
        def create_has_and_belongs_to_many_reflection(association_id, options, &extension)
1528
          options.assert_valid_keys(valid_keys_for_has_and_belongs_to_many_association)
1529

1530
          options[:extend] = create_extension_modules(association_id, extension, options[:extend])
1531 1532

          reflection = create_reflection(:has_and_belongs_to_many, association_id, options, self)
1533 1534 1535 1536
          
          if reflection.association_foreign_key == reflection.primary_key_name
            raise HasAndBelongsToManyAssociationForeignKeyNeeded.new(reflection)
          end
1537 1538

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

1540 1541 1542
          reflection
        end

1543
        def reflect_on_included_associations(associations)
1544
          [ associations ].flatten.collect { |association| reflect_on_association(association.to_s.intern) }
1545 1546
        end

1547 1548 1549
        def guard_against_unlimitable_reflections(reflections, options)
          if (options[:offset] || options[:limit]) && !using_limitable_reflections?(reflections)
            raise(
1550
              ConfigurationError,
1551 1552 1553 1554 1555
              "You can not use offset and limit together with has_many or has_and_belongs_to_many associations"
            )
          end
        end

1556
        def select_all_rows(options, join_dependency)
1557
          connection.select_all(
1558
            construct_finder_sql_with_included_associations(options, join_dependency),
1559 1560 1561
            "#{name} Load Including Associations"
          )
        end
1562

1563
        def construct_finder_sql_with_included_associations(options, join_dependency)
1564
          scope = scope(:find)
1565
          sql = "SELECT #{column_aliases(join_dependency)} FROM #{(scope && scope[:from]) || options[:from] || quoted_table_name} "
1566
          sql << join_dependency.join_associations.collect{|join| join.association_join }.join
1567

1568
          add_joins!(sql, options[:joins], scope)
1569
          add_conditions!(sql, options[:conditions], scope)
1570
          add_limited_ids_condition!(sql, options, join_dependency) if !using_limitable_reflections?(join_dependency.reflections) && ((scope && scope[:limit]) || options[:limit])
1571

1572
          add_group!(sql, options[:group], options[:having], scope)
1573
          add_order!(sql, options[:order], scope)
1574
          add_limit!(sql, options, scope) if using_limitable_reflections?(join_dependency.reflections)
1575
          add_lock!(sql, options, scope)
1576

1577 1578
          return sanitize_sql(sql)
        end
1579

1580 1581
        def add_limited_ids_condition!(sql, options, join_dependency)
          unless (id_list = select_limited_ids_list(options, join_dependency)).empty?
1582
            sql << "#{condition_word(sql)} #{connection.quote_table_name table_name}.#{primary_key} IN (#{id_list}) "
1583 1584
          else
            throw :invalid_query
1585 1586
          end
        end
1587

1588
        def select_limited_ids_list(options, join_dependency)
1589 1590
          pk = columns_hash[primary_key]

1591
          connection.select_all(
1592
            construct_finder_sql_for_association_limiting(options, join_dependency),
1593
            "#{name} Load IDs For Limited Eager Loading"
1594
          ).collect { |row| connection.quote(row[primary_key], pk) }.join(", ")
1595
        end
1596

1597
        def construct_finder_sql_for_association_limiting(options, join_dependency)
1598
          scope       = scope(:find)
1599 1600 1601 1602 1603

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

1608 1609 1610 1611 1612
          order = options[:order]
          if scoped_order = (scope && scope[:order])
            order = order ? "#{order}, #{scoped_order}" : scoped_order
          end

1613
          is_distinct = !options[:joins].blank? || include_eager_conditions?(options, tables_from_conditions) || include_eager_order?(options, tables_from_order)
1614
          sql = "SELECT "
1615
          if is_distinct
1616
            sql << connection.distinct("#{connection.quote_table_name table_name}.#{primary_key}", order)
1617 1618 1619
          else
            sql << primary_key
          end
1620
          sql << " FROM #{connection.quote_table_name table_name} "
1621

1622
          if is_distinct
1623
            sql << distinct_join_associations.collect { |assoc| assoc.association_join }.join
1624
            add_joins!(sql, options[:joins], scope)
1625
          end
1626

1627
          add_conditions!(sql, options[:conditions], scope)
1628
          add_group!(sql, options[:group], options[:having], scope)
1629

1630 1631
          if order && is_distinct
            connection.add_order_by_for_association_limiting!(sql, :order => order)
1632 1633
          else
            add_order!(sql, options[:order], scope)
1634
          end
1635

1636
          add_limit!(sql, options, scope)
1637

1638 1639
          return sanitize_sql(sql)
        end
1640

1641 1642 1643 1644 1645
        def tables_in_string(string)
          return [] if string.blank?
          string.scan(/([\.a-zA-Z_]+).?\./).flatten
        end

1646
        def conditions_tables(options)
1647 1648 1649 1650 1651
          # 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
1652
              when Hash  then all << cond.keys
1653 1654 1655
              else            all << cond
            end
          end
1656
          tables_in_string(conditions.join(' '))
1657 1658 1659
        end

        def order_tables(options)
1660
          order = [options[:order], scope(:find, :order) ].join(", ")
1661
          return [] unless order && order.is_a?(String)
1662
          tables_in_string(order)
1663 1664
        end

1665 1666 1667
        def selects_tables(options)
          select = options[:select]
          return [] unless select && select.is_a?(String)
1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680
          tables_in_string(select)
        end

        def joined_tables(options)
          scope = scope(:find)
          joins = options[:joins]
          merged_joins = scope && scope[:joins] && joins ? merge_joins(scope[:joins], joins) : (joins || scope && scope[:joins])
          [table_name] + case merged_joins
          when Symbol, Hash, Array
            if array_of_strings?(merged_joins)
              tables_in_string(merged_joins.join(' '))
            else
              join_dependency = ActiveRecord::Associations::ClassMethods::InnerJoinDependency.new(self, merged_joins, nil)
F
Frederick Cheung 已提交
1681
              join_dependency.join_associations.collect {|join_association| [join_association.aliased_join_table_name, join_association.aliased_table_name]}.flatten.compact
1682 1683 1684 1685
            end
          else
            tables_in_string(merged_joins)
          end
1686 1687
        end

1688
        # Checks if the conditions reference a table other than the current model table
1689 1690
        def include_eager_conditions?(options, tables = nil, joined_tables = nil)
          ((tables || conditions_tables(options)) - (joined_tables || joined_tables(options))).any?
1691
        end
1692

1693
        # Checks if the query order references a table other than the current model's table.
1694 1695
        def include_eager_order?(options, tables = nil, joined_tables = nil)
          ((tables || order_tables(options)) - (joined_tables || joined_tables(options))).any?
1696
        end
1697

1698 1699
        def include_eager_select?(options, joined_tables = nil)
          (selects_tables(options) - (joined_tables || joined_tables(options))).any?
1700 1701
        end

1702
        def references_eager_loaded_tables?(options)
1703 1704
          joined_tables = joined_tables(options)
          include_eager_order?(options, nil, joined_tables) || include_eager_conditions?(options, nil, joined_tables) || include_eager_select?(options, joined_tables)
1705 1706
        end

1707 1708 1709 1710
        def using_limitable_reflections?(reflections)
          reflections.reject { |r| [ :belongs_to, :has_one ].include?(r.macro) }.length.zero?
        end

1711 1712
        def column_aliases(join_dependency)
          join_dependency.joins.collect{|join| join.column_names_with_alias.collect{|column_name, aliased_name|
1713
              "#{connection.quote_table_name join.aliased_table_name}.#{connection.quote_column_name column_name} AS #{aliased_name}"}}.flatten.join(", ")
1714 1715
        end

1716
        def add_association_callbacks(association_name, options)
1717 1718
          callbacks = %w(before_add after_add before_remove after_remove)
          callbacks.each do |callback_name|
1719
            full_callback_name = "#{callback_name}_for_#{association_name}"
1720 1721 1722
            defined_callbacks = options[callback_name.to_sym]
            if options.has_key?(callback_name.to_sym)
              class_inheritable_reader full_callback_name.to_sym
1723 1724 1725
              write_inheritable_attribute(full_callback_name.to_sym, [defined_callbacks].flatten)
            else
              write_inheritable_attribute(full_callback_name.to_sym, [])
1726 1727
            end
          end
1728
        end
1729

1730 1731 1732
        def condition_word(sql)
          sql =~ /where/i ? " AND " : "WHERE "
        end
1733

1734
        def create_extension_modules(association_id, block_extension, extensions)
1735
          if block_extension
1736
            extension_module_name = "#{self.to_s.demodulize}#{association_id.to_s.camelize}AssociationExtension"
1737

1738
            silence_warnings do
1739
              self.parent.const_set(extension_module_name, Module.new(&block_extension))
1740
            end
1741
            Array(extensions).push("#{self.parent}::#{extension_module_name}".constantize)
1742 1743
          else
            Array(extensions)
1744 1745
          end
        end
1746

D
David Heinemeier Hansson 已提交
1747
        class JoinDependency # :nodoc:
1748
          attr_reader :joins, :reflections, :table_aliases
1749

1750
          def initialize(base, associations, joins)
1751
            @joins                 = [JoinBase.new(base, joins)]
1752 1753 1754 1755
            @associations          = associations
            @reflections           = []
            @base_records_hash     = {}
            @base_records_in_order = []
1756 1757
            @table_aliases         = Hash.new { |aliases, table| aliases[table] = 0 }
            @table_aliases[base.table_name] = 1
1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774
            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
1775
              construct(@base_records_hash[primary_id], @associations, join_associations.dup, row)
1776
            end
1777
            remove_duplicate_results!(join_base.active_record, @base_records_in_order, @associations)
1778 1779 1780
            return @base_records_in_order
          end

1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797
          def remove_duplicate_results!(base, records, associations)
            case associations
              when Symbol, String
                reflection = base.reflections[associations]
                if reflection && [:has_many, :has_and_belongs_to_many].include?(reflection.macro)
                  records.each { |record| record.send(reflection.name).target.uniq! }
                end
              when Array
                associations.each do |association|
                  remove_duplicate_results!(base, records, association)
                end
              when Hash
                associations.keys.each do |name|
                  reflection = base.reflections[name]
                  is_collection = [:has_many, :has_and_belongs_to_many].include?(reflection.macro)

                  parent_records = records.map do |record|
1798 1799 1800 1801
                    descendant = record.send(reflection.name)
                    next unless descendant
                    descendant.target.uniq! if is_collection
                    descendant
1802 1803 1804 1805 1806 1807 1808
                  end.flatten.compact

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

1809
          def join_for_table_name(table_name)
1810 1811 1812
            join = (@joins.select{|j|j.aliased_table_name == table_name.gsub(/^\"(.*)\"$/){$1} }.first) rescue nil
            return join unless join.nil?
            @joins.select{|j|j.is_a?(JoinAssociation) && j.aliased_join_table_name == table_name.gsub(/^\"(.*)\"$/){$1} }.first rescue nil
1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827
          end

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

1828 1829 1830 1831 1832 1833 1834 1835
          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
1836
                  @joins << build_join_association(reflection, parent)
1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850
                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

1851 1852 1853 1854 1855
            # overridden in InnerJoinDependency subclass
            def build_join_association(reflection, parent)
              JoinAssociation.new(reflection, self, parent)
            end

1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881
            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
1882

1883 1884
                  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)
1885
                  collection.target.push(association)
1886 1887
                when :has_one
                  return if record.id.to_s != join.parent.record_id(row).to_s
1888
                  return if record.instance_variable_defined?("@#{join.reflection.name}")
1889 1890 1891
                  association = join.instantiate(row) unless row[join.aliased_primary_key].nil?
                  record.send("set_#{join.reflection.name}_target", association)
                when :belongs_to
1892 1893 1894 1895 1896 1897 1898 1899 1900
                  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 已提交
1901
          class JoinBase # :nodoc:
1902
            attr_reader :active_record, :table_joins
1903
            delegate    :table_name, :column_names, :primary_key, :reflections, :sanitize_sql, :to => :active_record
1904

1905
            def initialize(active_record, joins = nil)
1906 1907
              @active_record = active_record
              @cached_record = {}
1908
              @table_joins   = joins
1909 1910 1911 1912 1913 1914 1915
            end

            def aliased_prefix
              "t0"
            end

            def aliased_primary_key
1916
              "#{aliased_prefix}_r0"
1917 1918 1919 1920 1921 1922 1923
            end

            def aliased_table_name
              active_record.table_name
            end

            def column_names_with_alias
1924
              unless defined?(@column_names_with_alias)
1925
                @column_names_with_alias = []
1926

1927
                ([primary_key] + (column_names - [primary_key])).each_with_index do |column_name, i|
1928
                  @column_names_with_alias << [column_name, "#{aliased_prefix}_r#{i}"]
1929 1930
                end
              end
1931 1932

              @column_names_with_alias
1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943
            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)
1944
              @cached_record[record_id(row)] ||= active_record.send(:instantiate, extract_record(row))
1945 1946 1947
            end
          end

D
David Heinemeier Hansson 已提交
1948
          class JoinAssociation < JoinBase # :nodoc:
1949
            attr_reader :reflection, :parent, :aliased_table_name, :aliased_prefix, :aliased_join_table_name, :parent_table_name
1950
            delegate    :options, :klass, :through_reflection, :source_reflection, :to => :reflection
1951 1952

            def initialize(reflection, join_dependency, parent = nil)
1953 1954 1955 1956 1957
              reflection.check_validity!
              if reflection.options[:polymorphic]
                raise EagerLoadPolymorphicError.new(reflection)
              end

1958
              super(reflection.klass)
1959
              @join_dependency    = join_dependency
1960 1961 1962
              @parent             = parent
              @reflection         = reflection
              @aliased_prefix     = "t#{ join_dependency.joins.size }"
1963
              @parent_table_name  = parent.active_record.table_name
1964
              @aliased_table_name = aliased_table_name_for(table_name)
1965

1966 1967
              if reflection.macro == :has_and_belongs_to_many
                @aliased_join_table_name = aliased_table_name_for(reflection.options[:join_table], "_join")
1968
              end
1969

1970
              if [:has_many, :has_one].include?(reflection.macro) && reflection.options[:through]
1971
                @aliased_join_table_name = aliased_table_name_for(reflection.through_reflection.klass.table_name, "_join")
1972
              end
1973 1974 1975
            end

            def association_join
1976
              connection = reflection.active_record.connection
1977
              join = case reflection.macro
1978
                when :has_and_belongs_to_many
1979
                  " #{join_type} %s ON %s.%s = %s.%s " % [
1980
                     table_alias_for(options[:join_table], aliased_join_table_name),
1981
                     connection.quote_table_name(aliased_join_table_name),
1982
                     options[:foreign_key] || reflection.active_record.to_s.foreign_key,
1983
                     connection.quote_table_name(parent.aliased_table_name),
1984
                     reflection.active_record.primary_key] +
1985
                  " #{join_type} %s ON %s.%s = %s.%s " % [
1986
                     table_name_and_alias,
1987 1988
                     connection.quote_table_name(aliased_table_name),
                     klass.primary_key,
1989
                     connection.quote_table_name(aliased_join_table_name),
1990
                     options[:association_foreign_key] || klass.to_s.foreign_key
1991 1992
                     ]
                when :has_many, :has_one
1993
                  case
1994
                    when reflection.options[:through]
1995
                      through_conditions = through_reflection.options[:conditions] ? "AND #{interpolate_sql(sanitize_sql(through_reflection.options[:conditions]))}" : ''
1996 1997 1998 1999

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

2000
                      if through_reflection.options[:as] # has_many :through against a polymorphic join
2001 2002
                        jt_foreign_key = through_reflection.options[:as].to_s + '_id'
                        jt_as_extra = " AND %s.%s = %s" % [
2003 2004
                          connection.quote_table_name(aliased_join_table_name),
                          connection.quote_column_name(through_reflection.options[:as].to_s + '_type'),
2005
                          klass.quote_value(parent.active_record.base_class.name)
2006
                        ]
2007
                      else
2008
                        jt_foreign_key = through_reflection.primary_key_name
2009
                      end
2010

2011 2012
                      case source_reflection.macro
                      when :has_many
2013 2014 2015
                        if source_reflection.options[:as]
                          first_key   = "#{source_reflection.options[:as]}_id"
                          second_key  = options[:foreign_key] || primary_key
2016
                          as_extra    = " AND %s.%s = %s" % [
2017 2018
                            connection.quote_table_name(aliased_table_name),
                            connection.quote_column_name("#{source_reflection.options[:as]}_type"),
2019
                            klass.quote_value(source_reflection.active_record.base_class.name)
2020 2021
                          ]
                        else
2022 2023 2024
                          first_key   = through_reflection.klass.base_class.to_s.foreign_key
                          second_key  = options[:foreign_key] || primary_key
                        end
2025

2026 2027
                        unless through_reflection.klass.descends_from_active_record?
                          jt_sti_extra = " AND %s.%s = %s" % [
2028 2029
                            connection.quote_table_name(aliased_join_table_name),
                            connection.quote_column_name(through_reflection.active_record.inheritance_column),
2030
                            through_reflection.klass.quote_value(through_reflection.klass.sti_name)]
2031 2032 2033 2034 2035 2036
                        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" % [
2037 2038
                            connection.quote_table_name(aliased_join_table_name),
                            connection.quote_column_name(reflection.source_reflection.options[:foreign_type]),
2039
                            klass.quote_value(reflection.options[:source_type])
2040
                          ]
2041
                        else
2042
                          second_key = source_reflection.primary_key_name
2043
                        end
2044
                      end
2045

2046
                      " #{join_type} %s ON (%s.%s = %s.%s%s%s%s) " % [
2047
                        table_alias_for(through_reflection.klass.table_name, aliased_join_table_name),
2048
                        connection.quote_table_name(parent.aliased_table_name),
2049
                        connection.quote_column_name(parent.primary_key),
2050
                        connection.quote_table_name(aliased_join_table_name),
2051
                        connection.quote_column_name(jt_foreign_key),
2052 2053
                        jt_as_extra, jt_source_extra, jt_sti_extra
                      ] +
2054
                      " #{join_type} %s ON (%s.%s = %s.%s%s) " % [
2055
                        table_name_and_alias,
2056
                        connection.quote_table_name(aliased_table_name),
2057
                        connection.quote_column_name(first_key),
2058
                        connection.quote_table_name(aliased_join_table_name),
2059
                        connection.quote_column_name(second_key),
2060 2061 2062
                        as_extra
                      ]

2063
                    when reflection.options[:as] && [:has_many, :has_one].include?(reflection.macro)
2064
                      " #{join_type} %s ON %s.%s = %s.%s AND %s.%s = %s" % [
2065
                        table_name_and_alias,
2066
                        connection.quote_table_name(aliased_table_name),
2067
                        "#{reflection.options[:as]}_id",
2068
                        connection.quote_table_name(parent.aliased_table_name),
2069
                        parent.primary_key,
2070
                        connection.quote_table_name(aliased_table_name),
2071
                        "#{reflection.options[:as]}_type",
2072
                        klass.quote_value(parent.active_record.base_class.name)
2073 2074
                      ]
                    else
2075
                      foreign_key = options[:foreign_key] || reflection.active_record.name.foreign_key
2076
                      " #{join_type} %s ON %s.%s = %s.%s " % [
2077
                        table_name_and_alias,
2078
                        aliased_table_name,
2079
                        foreign_key,
2080
                        parent.aliased_table_name,
2081
                        reflection.options[:primary_key] || parent.primary_key
2082 2083
                      ]
                  end
2084
                when :belongs_to
2085
                  " #{join_type} %s ON %s.%s = %s.%s " % [
2086
                     table_name_and_alias,
2087 2088
                     connection.quote_table_name(aliased_table_name),
                     reflection.klass.primary_key,
2089
                     connection.quote_table_name(parent.aliased_table_name),
2090
                     options[:foreign_key] || reflection.primary_key_name
2091 2092 2093
                    ]
                else
                  ""
2094
              end || ''
2095 2096
              join << %(AND %s) % [
                klass.send(:type_condition, aliased_table_name)] unless klass.descends_from_active_record?
2097 2098 2099 2100 2101

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

2102
              join
2103
            end
2104

2105
            protected
2106

2107
              def aliased_table_name_for(name, suffix = nil)
2108
                if !parent.table_joins.blank? && parent.table_joins.to_s.downcase =~ %r{join(\s+\w+)?\s+#{active_record.connection.quote_table_name name.downcase}\son}
2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123
                  @join_dependency.table_aliases[name] += 1
                end

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

                name
              end
2124

2125 2126 2127
              def pluralize(table_name)
                ActiveRecord::Base.pluralize_table_names ? table_name.to_s.pluralize : table_name
              end
2128

2129
              def table_alias_for(table_name, table_alias)
2130
                 "#{reflection.active_record.connection.quote_table_name(table_name)} #{table_alias if table_name != table_alias}".strip
2131 2132 2133 2134 2135
              end

              def table_name_and_alias
                table_alias_for table_name, @aliased_table_name
              end
2136 2137

              def interpolate_sql(sql)
2138 2139
                instance_eval("%@#{sql.gsub('@', '\@')}@")
              end
2140 2141

            private
2142 2143 2144 2145
              def join_type
                "LEFT OUTER JOIN"
              end
          end
2146 2147 2148 2149 2150 2151 2152 2153 2154
        end

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

          class InnerJoinAssociation < JoinAssociation
2155 2156 2157 2158
            private
              def join_type
                "INNER JOIN"
              end
2159 2160
          end
        end
2161

2162
    end
D
Initial  
David Heinemeier Hansson 已提交
2163
  end
2164
end