associations.rb 119.5 KB
Newer Older
J
Jeremy Kemper 已提交
1 2
require 'active_support/core_ext/module/delegation'

D
Initial  
David Heinemeier Hansson 已提交
3
module ActiveRecord
4 5 6 7 8 9
  class InverseOfAssociationNotFoundError < ActiveRecordError #:nodoc:
    def initialize(reflection)
      super("Could not find the inverse association for #{reflection.name} (#{reflection.options[:inverse_of].inspect} in #{reflection.class_name})")
    end
  end

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

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

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

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

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

45
  class HasManyThroughCantAssociateThroughHasOneOrManyReflection < ActiveRecordError #:nodoc:
46 47 48 49
    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
50

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

57 58 59 60 61 62
  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

63 64 65 66 67 68
  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 已提交
69
  class EagerLoadPolymorphicError < ActiveRecordError #:nodoc:
70
    def initialize(reflection)
71
      super("Can not eagerly load the polymorphic association #{reflection.name.inspect}")
72 73 74
    end
  end

75 76
  class ReadOnlyAssociation < ActiveRecordError #:nodoc:
    def initialize(reflection)
77
      super("Can not add to a has_many :through association.  Try adding to #{reflection.through_reflection.name.inspect}.")
78 79 80
    end
  end

P
Pratik Naik 已提交
81
  # See ActiveRecord::Associations::ClassMethods for documentation.
D
Initial  
David Heinemeier Hansson 已提交
82
  module Associations # :nodoc:
83
    extend ActiveSupport::Concern
84

85
    # These classes will be loaded when associations are created.
J
Joshua Peek 已提交
86 87 88 89 90 91 92 93 94 95 96
    # 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'

97
    # Clears out the association cache
98 99 100
    def clear_association_cache #:nodoc:
      self.class.reflect_on_all_associations.to_a.each do |assoc|
        instance_variable_set "@#{assoc.name}", nil
101
      end unless self.new_record?
102
    end
103

104 105 106 107 108 109 110 111 112 113 114 115
    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

116 117 118
    # 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 已提交
119 120 121 122
    # methods. Example:
    #
    #   class Project < ActiveRecord::Base
    #     belongs_to              :portfolio
123
    #     has_one                 :project_manager
D
Initial  
David Heinemeier Hansson 已提交
124 125 126 127 128
    #     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:
129
    # * <tt>Project#portfolio, Project#portfolio=(portfolio), Project#portfolio.nil?</tt>
D
Initial  
David Heinemeier Hansson 已提交
130 131
    # * <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>
132
    #   <tt>Project#milestones.delete(milestone), Project#milestones.find(milestone_id), Project#milestones.find(:all, options),</tt>
D
Initial  
David Heinemeier Hansson 已提交
133 134 135 136
    #   <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>
    #
137 138 139 140
    # === 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 已提交
141
    # For instance, +attributes+ and +connection+ would be bad choices for association names.
142
    #
143
    # == Auto-generated methods
D
Initial  
David Heinemeier Hansson 已提交
144
    #
145
    # === Singular associations (one-to-one)
146 147 148
    #                                     |            |  belongs_to  |
    #   generated methods                 | belongs_to | :polymorphic | has_one
    #   ----------------------------------+------------+--------------+---------
P
Pratik Naik 已提交
149 150 151 152 153
    #   other                             |     X      |      X       |    X
    #   other=(other)                     |     X      |      X       |    X
    #   build_other(attributes={})        |     X      |              |    X
    #   create_other(attributes={})       |     X      |              |    X
    #   other.create!(attributes={})      |            |              |    X
154 155 156
    #
    # ===Collection associations (one-to-many / many-to-many)
    #                                     |       |          | has_many
157
    #   generated methods                 | habtm | has_many | :through
158
    #   ----------------------------------+-------+----------+----------
P
Pratik Naik 已提交
159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182
    #   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 已提交
183
    #
184
    # == Cardinality and associations
185
    #
P
Pratik Naik 已提交
186
    # Active Record associations can be used to describe one-to-one, one-to-many and many-to-many
P
Pratik Naik 已提交
187 188
    # 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
189
    # the foreign key.
190 191 192
    #
    # === One-to-one
    #
193
    # Use +has_one+ in the base, and +belongs_to+ in the associated model.
194 195 196 197 198 199 200 201 202 203
    #
    #   class Employee < ActiveRecord::Base
    #     has_one :office
    #   end
    #   class Office < ActiveRecord::Base
    #     belongs_to :employee    # foreign key - employee_id
    #   end
    #
    # === One-to-many
    #
204
    # Use +has_many+ in the base, and +belongs_to+ in the associated model.
205 206 207 208 209
    #
    #   class Manager < ActiveRecord::Base
    #     has_many :employees
    #   end
    #   class Employee < ActiveRecord::Base
210
    #     belongs_to :manager     # foreign key - manager_id
211 212 213 214 215 216
    #   end
    #
    # === Many-to-many
    #
    # There are two ways to build a many-to-many relationship.
    #
217
    # The first way uses a +has_many+ association with the <tt>:through</tt> option and a join model, so
218 219 220 221 222 223 224 225 226 227 228 229 230 231 232
    # 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
    #
233
    # For the second way, use +has_and_belongs_to_many+ in both models. This requires a join table
234 235 236 237 238 239 240 241 242
    # 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
    #
243
    # Choosing which way to build a many-to-many relationship is not always simple.
244
    # If you need to work with the relationship model as its own entity,
245
    # use <tt>has_many :through</tt>. Use +has_and_belongs_to_many+ when working with legacy schemas or when
246 247
    # you never work directly with the relationship itself.
    #
248
    # == Is it a +belongs_to+ or +has_one+ association?
D
Initial  
David Heinemeier Hansson 已提交
249
    #
250 251
    # 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 已提交
252
    #
253 254 255
    #   class User < ActiveRecord::Base
    #     # I reference an account.
    #     belongs_to :account
D
Initial  
David Heinemeier Hansson 已提交
256 257
    #   end
    #
258 259 260
    #   class Account < ActiveRecord::Base
    #     # One user references me.
    #     has_one :user
D
Initial  
David Heinemeier Hansson 已提交
261 262 263 264
    #   end
    #
    # The tables for these classes could look something like:
    #
265
    #   CREATE TABLE users (
D
Initial  
David Heinemeier Hansson 已提交
266
    #     id int(11) NOT NULL auto_increment,
267 268
    #     account_id int(11) default NULL,
    #     name varchar default NULL,
D
Initial  
David Heinemeier Hansson 已提交
269 270 271
    #     PRIMARY KEY  (id)
    #   )
    #
272
    #   CREATE TABLE accounts (
D
Initial  
David Heinemeier Hansson 已提交
273 274 275 276 277
    #     id int(11) NOT NULL auto_increment,
    #     name varchar default NULL,
    #     PRIMARY KEY  (id)
    #   )
    #
278 279
    # == Unsaved objects and associations
    #
280
    # You can manipulate objects and associations before they are saved to the database, but there is some special behavior you should be
281 282
    # aware of, mostly involving the saving of associated objects.
    #
283 284 285 286
    # Unless you set 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. Setting it
    # to +true+ will _always_ save the members, whereas setting it to +false+ will
    # _never_ save the members.
287
    #
288 289
    # === One-to-one associations
    #
290 291 292
    # * 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
293
    #   is cancelled.
P
Pratik Naik 已提交
294
    # * If you wish to assign an object to a +has_one+ association without saving it, use the <tt>association.build</tt> method (documented below).
295
    # * Assigning an object to a +belongs_to+ association does not save the object, since the foreign key field belongs on the parent. It
296
    #   does not save the parent either.
297 298 299
    #
    # === Collections
    #
300
    # * Adding an object to a collection (+has_many+ or +has_and_belongs_to_many+) automatically saves that object, except if the parent object
301
    #   (the owner of the collection) is not yet stored in the database.
P
Pratik Naik 已提交
302 303
    # * 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).
304
    # * All unsaved (<tt>new_record? == true</tt>) members of the collection are automatically saved when the parent is saved.
305
    #
306
    # === Association callbacks
307
    #
308
    # Similar to the normal callbacks that hook into the lifecycle of an Active Record object, you can also define callbacks that get
309
    # triggered when you add an object to or remove an object from an association collection. Example:
310 311 312 313 314 315 316
    #
    #   class Project
    #     has_and_belongs_to_many :developers, :after_add => :evaluate_velocity
    #
    #     def evaluate_velocity(developer)
    #       ...
    #     end
317
    #   end
318 319
    #
    # It's possible to stack callbacks by passing them as an array. Example:
320
    #
321
    #   class Project
322
    #     has_and_belongs_to_many :developers, :after_add => [:evaluate_velocity, Proc.new { |p, d| p.shipping_date = Time.now}]
323 324
    #   end
    #
325
    # Possible callbacks are: +before_add+, +after_add+, +before_remove+ and +after_remove+.
326
    #
327 328
    # 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.
329
    #
330 331
    # === Association extensions
    #
332
    # The proxy objects that control the access to associations can be extended through anonymous modules. This is especially
333
    # beneficial for adding new finders, creators, and other factory-type methods that are only used as part of this association.
334 335 336
    # Example:
    #
    #   class Account < ActiveRecord::Base
337
    #     has_many :people do
338
    #       def find_or_create_by_name(name)
339
    #         first_name, last_name = name.split(" ", 2)
D
David Heinemeier Hansson 已提交
340
    #         find_or_create_by_first_name_and_last_name(first_name, last_name)
341
    #       end
342
    #     end
343 344 345 346 347 348
    #   end
    #
    #   person = Account.find(:first).people.find_or_create_by_name("David Heinemeier Hansson")
    #   person.first_name # => "David"
    #   person.last_name  # => "Heinemeier Hansson"
    #
349 350 351 352
    # 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)
353
    #       first_name, last_name = name.split(" ", 2)
D
David Heinemeier Hansson 已提交
354
    #       find_or_create_by_first_name_and_last_name(first_name, last_name)
355 356 357 358 359 360 361 362 363 364
    #     end
    #   end
    #
    #   class Account < ActiveRecord::Base
    #     has_many :people, :extend => FindOrCreateByNameExtension
    #   end
    #
    #   class Company < ActiveRecord::Base
    #     has_many :people, :extend => FindOrCreateByNameExtension
    #   end
365
    #
366
    # If you need to use multiple named extension modules, you can specify an array of modules with the <tt>:extend</tt> option.
367 368 369 370 371 372 373
    # 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
    #
374 375
    # 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:
376
    #
377 378
    # * +proxy_owner+ - Returns the object the association is part of.
    # * +proxy_reflection+ - Returns the reflection object that describes the association.
379
    # * +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+.
380
    #
R
Rick Olson 已提交
381
    # === Association Join Models
382
    #
383 384
    # 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,
385
    # callbacks, and extra attributes on the join model.  Consider the following schema:
386
    #
387 388 389 390
    #   class Author < ActiveRecord::Base
    #     has_many :authorships
    #     has_many :books, :through => :authorships
    #   end
391
    #
392 393 394 395
    #   class Authorship < ActiveRecord::Base
    #     belongs_to :author
    #     belongs_to :book
    #   end
396
    #
397 398 399
    #   @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
400
    #
401
    # You can also go through a +has_many+ association on the join model:
402
    #
403 404 405 406
    #   class Firm < ActiveRecord::Base
    #     has_many   :clients
    #     has_many   :invoices, :through => :clients
    #   end
407
    #
408 409 410 411
    #   class Client < ActiveRecord::Base
    #     belongs_to :firm
    #     has_many   :invoices
    #   end
412
    #
413 414 415 416 417 418 419 420
    #   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.
    #
421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446
    # Similarly you can go through a +has_one+ association on the join model:
    #
    #   class Group < ActiveRecord::Base
    #     has_many   :users
    #     has_many   :avatars, :through => :users
    #   end
    #
    #   class User < ActiveRecord::Base
    #     belongs_to :group
    #     has_one    :avatar
    #   end
    #
    #   class Avatar < ActiveRecord::Base
    #     belongs_to :user
    #   end
    #
    #   @group = Group.first
    #   @group.users.collect { |u| u.avatar }.flatten # select all avatars for all users in the group
    #   @group.avatars                                # selects all avatars by going through the User join model.
    #
    # An important caveat with going through +has_one+ or +has_many+ associations on the join model is that these associations are 
    # *read-only*.  For example, the following would not work following the previous example:
    #
    #   @group.avatars << Avatar.new                # this would work if User belonged_to Avatar rather than the other way around.
    #   @group.avatars.delete(@group.avatars.last)  # so would this
    #
R
Rick Olson 已提交
447
    # === Polymorphic Associations
448 449
    #
    # Polymorphic associations on models are not restricted on what types of models they can be associated with.  Rather, they
450
    # specify an interface that a +has_many+ association must adhere to.
451
    #
R
Rick Olson 已提交
452 453 454
    #   class Asset < ActiveRecord::Base
    #     belongs_to :attachable, :polymorphic => true
    #   end
455
    #
R
Rick Olson 已提交
456
    #   class Post < ActiveRecord::Base
457
    #     has_many :assets, :as => :attachable         # The :as option specifies the polymorphic interface to use.
R
Rick Olson 已提交
458 459 460
    #   end
    #
    #   @asset.attachable = @post
461
    #
R
Rick Olson 已提交
462
    # 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
463
    # an +attachable_id+ integer column and an +attachable_type+ string column.
R
Rick Olson 已提交
464
    #
D
David Heinemeier Hansson 已提交
465
    # Using polymorphic associations in combination with single table inheritance (STI) is a little tricky. In order
466
    # for the associations to work as expected, ensure that you store the base model for the STI models in the
D
David Heinemeier Hansson 已提交
467
    # type column of the polymorphic association. To continue with the asset example above, suppose there are guest posts
468
    # 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 已提交
469 470 471
    #
    #   class Asset < ActiveRecord::Base
    #     belongs_to :attachable, :polymorphic => true
472
    #
D
David Heinemeier Hansson 已提交
473 474 475 476
    #     def attachable_type=(sType)
    #        super(sType.to_s.classify.constantize.base_class.to_s)
    #     end
    #   end
477
    #
D
David Heinemeier Hansson 已提交
478 479 480 481 482
    #   class Post < ActiveRecord::Base
    #     # because we store "Post" in attachable_type now :dependent => :destroy will work
    #     has_many :assets, :as => :attachable, :dependent => :destroy
    #   end
    #
483
    #   class GuestPost < Post
D
David Heinemeier Hansson 已提交
484 485
    #   end
    #
486
    #   class MemberPost < Post
D
David Heinemeier Hansson 已提交
487 488
    #   end
    #
D
Initial  
David Heinemeier Hansson 已提交
489 490 491
    # == Caching
    #
    # All of the methods are built on a simple caching principle that will keep the result of the last query around unless specifically
492
    # 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 已提交
493 494 495 496 497 498 499 500
    # 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
    #
501 502
    # == Eager loading of associations
    #
P
Pratik Naik 已提交
503
    # Eager loading is a way to find objects of a certain class and a number of named associations. This is
504
    # 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 已提交
505
    # triggers 101 database queries. Through the use of eager loading, the 101 queries can be reduced to 2. Example:
506 507 508 509 510 511 512 513
    #
    #   class Post < ActiveRecord::Base
    #     belongs_to :author
    #     has_many   :comments
    #   end
    #
    # Consider the following loop using the class above:
    #
P
Pratik Naik 已提交
514
    #   for post in Post.all
515 516 517
    #     puts "Post:            " + post.title
    #     puts "Written by:      " + post.author.name
    #     puts "Last comment on: " + post.comments.first.created_on
518
    #   end
519 520 521
    #
    # To iterate over these one hundred posts, we'll generate 201 database queries. Let's first just optimize it for retrieving the author:
    #
522
    #   for post in Post.find(:all, :include => :author)
523
    #
P
Pratik Naik 已提交
524 525
    # 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.
526 527 528
    #
    # We can improve upon the situation further by referencing both associations in the finder with:
    #
529
    #   for post in Post.find(:all, :include => [ :author, :comments ])
530
    #
P
Pratik Naik 已提交
531 532
    # 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).
533
    #
534
    # To include a deep hierarchy of associations, use a hash:
535 536 537 538 539 540 541
    #
    #   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 已提交
542 543
    # 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.
544
    #
P
Pratik Naik 已提交
545 546 547 548
    # 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])
549
    #
P
Pratik Naik 已提交
550
    # This 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
P
Pratik Naik 已提交
551 552 553 554 555
    # <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. 
    #
P
Pratik Naik 已提交
556
    # If you do want eager load only some members of an association it is usually more natural to <tt>:include</tt> an association
P
Pratik Naik 已提交
557 558 559 560 561 562 563 564
    # 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)
    #
P
Pratik Naik 已提交
565
    # This will load posts and eager load the +approved_comments+ association, which contains only those comments that have been approved.
566
    #
567 568 569 570 571 572 573 574
    # 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.
    #
575 576
    # 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.
577
    #
P
Pratik Naik 已提交
578
    # Eager loading is supported with polymorphic associations.
579 580 581 582 583
    #
    #   class Address < ActiveRecord::Base
    #     belongs_to :addressable, :polymorphic => true
    #   end
    #
P
Pratik Naik 已提交
584
    # A call that tries to eager load the addressable model
585
    #
P
Pratik Naik 已提交
586
    #   Address.find(:all, :include => :addressable)
587
    #
P
Pratik Naik 已提交
588
    # This will execute one query to load the addresses and load the addressables with one query per addressable type.
P
Pratik Naik 已提交
589 590 591 592
    # 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.
593
    #
594 595
    # == Table Aliasing
    #
P
Pratik Naik 已提交
596
    # 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,
597
    # the standard table name is used.  The second time, the table is aliased as <tt>#{reflection_name}_#{parent_table_name}</tt>.  Indexes are appended
598
    # for any more successive uses of the table name.
599
    #
P
Pratik Naik 已提交
600 601 602 603 604 605
    #   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
606
    #
607
    # Acts as tree example:
608
    #
P
Pratik Naik 已提交
609 610 611 612 613 614 615 616 617
    #   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
618
    #
619
    # Has and Belongs to Many join tables use the same idea, but add a <tt>_join</tt> suffix:
620
    #
P
Pratik Naik 已提交
621 622 623 624 625 626 627 628 629
    #   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
630
    #
631
    # 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:
632
    #
P
Pratik Naik 已提交
633 634 635 636 637
    #   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 ...
638
    #                              INNER JOIN comments ...
639
    #
640
    # Table aliases are automatically truncated according to the maximum length of table identifiers according to the specific database.
641
    #
D
Initial  
David Heinemeier Hansson 已提交
642 643 644 645 646 647 648 649 650 651
    # == 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 已提交
652
    #       class Client < ActiveRecord::Base; end
D
Initial  
David Heinemeier Hansson 已提交
653 654 655
    #     end
    #   end
    #
P
Pratik Naik 已提交
656 657 658
    # 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 已提交
659 660 661 662 663 664 665 666 667 668 669 670 671
    #
    #   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
    #
P
Pratik Naik 已提交
672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725
    # == Bi-directional associations
    #
    # When you specify an association there is usually an association on the associated model that specifies the same
    # relationship in reverse.  For example, with the following models:
    #
    #    class Dungeon < ActiveRecord::Base
    #      has_many :traps
    #      has_one :evil_wizard
    #    end
    #
    #    class Trap < ActiveRecord::Base
    #      belongs_to :dungeon
    #    end
    #
    #    class EvilWizard < ActiveRecord::Base
    #      belongs_to :dungeon
    #    end
    #
    # The +traps+ association on +Dungeon+ and the the +dungeon+ association on +Trap+ are the inverse of each other and the
    # inverse of the +dungeon+ association on +EvilWizard+ is the +evil_wizard+ association on +Dungeon+ (and vice-versa).  By default,
    # +ActiveRecord+ doesn't do know anything about these inverse relationships and so no object loading optimisation is possible.  For example:
    #
    #    d = Dungeon.first
    #    t = d.traps.first
    #    d.level == t.dungeon.level # => true
    #    d.level = 10
    #    d.level == t.dungeon.level # => false
    #
    # The +Dungeon+ instances +d+ and <tt>t.dungeon</tt> in the above example refer to the same object data from the database, but are 
    # actually different in-memory copies of that data.  Specifying the <tt>:inverse_of</tt> option on associations lets you tell
    # +ActiveRecord+ about inverse relationships and it will optimise object loading.  For example, if we changed our model definitions to:
    #
    #    class Dungeon < ActiveRecord::Base
    #      has_many :traps, :inverse_of => :dungeon
    #      has_one :evil_wizard, :inverse_of => :dungeon
    #    end
    #
    #    class Trap < ActiveRecord::Base
    #      belongs_to :dungeon, :inverse_of => :traps
    #    end
    #
    #    class EvilWizard < ActiveRecord::Base
    #      belongs_to :dungeon, :inverse_of => :evil_wizard
    #    end
    #
    # Then, from our code snippet above, +d+ and <tt>t.dungeon</tt> are actually the same in-memory instance and our final <tt>d.level == t.dungeon.level</tt>
    # will return +true+.
    #
    # There are limitations to <tt>:inverse_of</tt> support:
    #
    # * does not work with <tt>:through</tt> associations.
    # * does not work with <tt>:polymorphic</tt> associations.
    # * for +belongs_to+ associations +has_many+ inverse associations are ignored.
    #
726
    # == Type safety with <tt>ActiveRecord::AssociationTypeMismatch</tt>
D
Initial  
David Heinemeier Hansson 已提交
727 728
    #
    # If you attempt to assign an object to an association that doesn't match the inferred or specified <tt>:class_name</tt>, you'll
729
    # get an <tt>ActiveRecord::AssociationTypeMismatch</tt>.
D
Initial  
David Heinemeier Hansson 已提交
730 731 732
    #
    # == Options
    #
733
    # 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 已提交
734 735
    # possible.
    module ClassMethods
P
Pratik Naik 已提交
736 737 738 739 740
      # 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 已提交
741
      #   An empty array is returned if none are found.
P
Pratik Naik 已提交
742 743 744 745
      # [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+.
746 747
      #   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 已提交
748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763
      # [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 已提交
764
      # [collection.exists?(...)]
P
Pratik Naik 已提交
765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781
      #   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 已提交
782
      #
P
Pratik Naik 已提交
783 784
      # 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 已提交
785 786
      # * <tt>Firm#clients<<</tt>
      # * <tt>Firm#clients.delete</tt>
787
      # * <tt>Firm#clients=</tt>
788
      # * <tt>Firm#client_ids</tt>
789
      # * <tt>Firm#client_ids=</tt>
D
Initial  
David Heinemeier Hansson 已提交
790 791 792
      # * <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>)
793
      # * <tt>Firm#clients.find</tt> (similar to <tt>Client.find(id, :conditions => "firm_id = #{id}")</tt>)
P
Pratik Naik 已提交
794
      # * <tt>Firm#clients.exists?(:name => 'ACME')</tt> (similar to <tt>Client.exists?(:name => 'ACME', :firm_id => firm.id)</tt>)
D
Initial  
David Heinemeier Hansson 已提交
795
      # * <tt>Firm#clients.build</tt> (similar to <tt>Client.new("firm_id" => id)</tt>)
D
David Heinemeier Hansson 已提交
796
      # * <tt>Firm#clients.create</tt> (similar to <tt>c = Client.new("firm_id" => id); c.save; c</tt>)
D
Initial  
David Heinemeier Hansson 已提交
797
      # The declaration can also include an options hash to specialize the behavior of the association.
798
      #
P
Pratik Naik 已提交
799 800 801
      # === Supported options
      # [:class_name]
      #   Specify the class name of the association. Use it only if that name can't be inferred
P
Pratik Naik 已提交
802 803
      #   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 已提交
804 805
      # [:conditions]
      #   Specify the conditions that the associated objects must meet in order to be included as a +WHERE+
806 807 808
      #   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 已提交
809 810
      # [:order]
      #   Specify the order in which the associated objects are returned as an <tt>ORDER BY</tt> SQL fragment,
P
Pratik Naik 已提交
811
      #   such as <tt>last_name, first_name DESC</tt>.
P
Pratik Naik 已提交
812 813
      # [:foreign_key]
      #   Specify the foreign key used for the association. By default this is guessed to be the name
P
Pratik Naik 已提交
814 815
      #   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 已提交
816 817 818 819
      # [: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 已提交
820 821 822 823
      #   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 已提交
824 825
      # [:finder_sql]
      #   Specify a complete SQL statement to fetch the association. This is a good way to go for complex
D
David Heinemeier Hansson 已提交
826
      #   associations that depend on multiple tables. Note: When this option is used, +find_in_collection+ is _not_ added.
P
Pratik Naik 已提交
827 828
      # [:counter_sql]
      #   Specify a complete SQL statement to fetch the size of the association. If <tt>:finder_sql</tt> is
829
      #   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 已提交
830 831 832 833 834 835
      # [: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.
836 837
      # [: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 已提交
838 839 840 841 842 843
      # [: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
844
      #   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 已提交
845 846 847 848
      # [: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>
849
      #   are ignored, as the association uses the source reflection. You can only use a <tt>:through</tt> query through a <tt>belongs_to</tt>
850
      #   <tt>has_one</tt> or <tt>has_many</tt> association on the join model.
P
Pratik Naik 已提交
851 852
      # [:source]
      #   Specifies the source association name used by <tt>has_many :through</tt> queries.  Only use it if the name cannot be
853
      #   inferred from the association.  <tt>has_many :subscribers, :through => :subscriptions</tt> will look for either <tt>:subscribers</tt> or
P
Pratik Naik 已提交
854
      #   <tt>:subscriber</tt> on Subscription, unless a <tt>:source</tt> is given.
P
Pratik Naik 已提交
855 856
      # [:source_type]
      #   Specifies type of the source association used by <tt>has_many :through</tt> queries where the source
857
      #   association is a polymorphic +belongs_to+.
P
Pratik Naik 已提交
858 859 860 861 862 863
      # [: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.
864 865
      # [:autosave]
      #   If true, always save any loaded members and destroy members marked for destruction, when saving the parent object. Off by default.
P
Pratik Naik 已提交
866 867 868 869
      # [:inverse_of]
      #   Specifies the name of the <tt>belongs_to</tt> association on the associated object that is the inverse of this <tt>has_many</tt> 
      #   association.  Does not work in combination with <tt>:through</tt> or <tt>:as</tt> options.  
      #   See ActiveRecord::Associations::ClassMethods's overview on Bi-directional assocations for more detail.
870
      #
D
Initial  
David Heinemeier Hansson 已提交
871 872
      # Option examples:
      #   has_many :comments, :order => "posted_on"
873
      #   has_many :comments, :include => :author
D
Initial  
David Heinemeier Hansson 已提交
874
      #   has_many :people, :class_name => "Person", :conditions => "deleted = 0", :order => "name"
875 876
      #   has_many :tracks, :order => "position", :dependent => :destroy
      #   has_many :comments, :dependent => :nullify
R
Rick Olson 已提交
877
      #   has_many :tags, :as => :taggable
878
      #   has_many :reports, :readonly => true
879
      #   has_many :subscribers, :through => :subscriptions, :source => :user
D
Initial  
David Heinemeier Hansson 已提交
880 881 882 883 884
      #   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'
885
      def has_many(association_id, options = {}, &extension)
886 887
        reflection = create_has_many_reflection(association_id, options, &extension)
        configure_dependency_for_has_many(reflection)
888 889
        add_association_callbacks(reflection.name, reflection.options)

890
        if options[:through]
891
          collection_accessor_methods(reflection, HasManyThroughAssociation)
892 893
        else
          collection_accessor_methods(reflection, HasManyAssociation)
D
Initial  
David Heinemeier Hansson 已提交
894 895 896
        end
      end

P
Pratik Naik 已提交
897 898 899 900 901 902 903 904 905 906 907
      # 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 已提交
908
      #   and saves the associate object.
P
Pratik Naik 已提交
909 910 911 912 913 914 915 916 917 918 919 920
      # [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 已提交
921
      #
P
Pratik Naik 已提交
922 923 924
      # === Example
      #
      # An Account class declares <tt>has_one :beneficiary</tt>, which will add:
925
      # * <tt>Account#beneficiary</tt> (similar to <tt>Beneficiary.find(:first, :conditions => "account_id = #{id}")</tt>)
D
Initial  
David Heinemeier Hansson 已提交
926
      # * <tt>Account#beneficiary=(beneficiary)</tt> (similar to <tt>beneficiary.account_id = account.id; beneficiary.save</tt>)
927 928 929
      # * <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 已提交
930 931
      # === Options
      #
D
Initial  
David Heinemeier Hansson 已提交
932
      # The declaration can also include an options hash to specialize the behavior of the association.
933
      #
D
Initial  
David Heinemeier Hansson 已提交
934
      # Options are:
P
Pratik Naik 已提交
935 936
      # [:class_name]
      #   Specify the class name of the association. Use it only if that name can't be inferred
P
Pratik Naik 已提交
937 938
      #   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 已提交
939 940
      # [:conditions]
      #   Specify the conditions that the associated object must meet in order to be included as a +WHERE+
941
      #   SQL fragment, such as <tt>rank = 5</tt>.
P
Pratik Naik 已提交
942 943
      # [:order]
      #   Specify the order in which the associated objects are returned as an <tt>ORDER BY</tt> SQL fragment,
P
Pratik Naik 已提交
944
      #   such as <tt>last_name, first_name DESC</tt>.
P
Pratik Naik 已提交
945 946
      # [:dependent]
      #   If set to <tt>:destroy</tt>, the associated object is destroyed when this object is. If set to
947 948
      #   <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 已提交
949 950
      # [:foreign_key]
      #   Specify the foreign key used for the association. By default this is guessed to be the name
P
Pratik Naik 已提交
951 952
      #   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 已提交
953 954 955 956 957 958 959 960
      # [: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
961
      #   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 已提交
962 963
      # [:through]
      #   Specifies a Join Model through which to perform the query.  Options for <tt>:class_name</tt> and <tt>:foreign_key</tt>
964 965
      #   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 已提交
966 967
      # [:source]
      #   Specifies the source association name used by <tt>has_one :through</tt> queries.  Only use it if the name cannot be
968
      #   inferred from the association.  <tt>has_one :favorite, :through => :favorites</tt> will look for a
969
      #   <tt>:favorite</tt> on Favorite, unless a <tt>:source</tt> is given.
P
Pratik Naik 已提交
970 971
      # [:source_type]
      #   Specifies type of the source association used by <tt>has_one :through</tt> queries where the source
972
      #   association is a polymorphic +belongs_to+.
P
Pratik Naik 已提交
973 974 975 976
      # [: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.
977 978
      # [:autosave]
      #   If true, always save the associated object or destroy it if marked for destruction, when saving the parent object. Off by default.
P
Pratik Naik 已提交
979 980 981 982
      # [:inverse_of]
      #   Specifies the name of the <tt>belongs_to</tt> association on the associated object that is the inverse of this <tt>has_one</tt> 
      #   association.  Does not work in combination with <tt>:through</tt> or <tt>:as</tt> options.  
      #   See ActiveRecord::Associations::ClassMethods's overview on Bi-directional assocations for more detail.
983
      #
D
Initial  
David Heinemeier Hansson 已提交
984
      # Option examples:
985
      #   has_one :credit_card, :dependent => :destroy  # destroys the associated credit card
986
      #   has_one :credit_card, :dependent => :nullify  # updates the associated records foreign key value to NULL rather than destroying it
D
Initial  
David Heinemeier Hansson 已提交
987 988
      #   has_one :last_comment, :class_name => "Comment", :order => "posted_on"
      #   has_one :project_manager, :class_name => "Person", :conditions => "role = 'project_manager'"
989
      #   has_one :attachment, :as => :attachable
990
      #   has_one :boss, :readonly => :true
991 992
      #   has_one :club, :through => :membership
      #   has_one :primary_address, :through => :addressables, :conditions => ["addressable.primary = ?", true], :source => :addressable
D
Initial  
David Heinemeier Hansson 已提交
993
      def has_one(association_id, options = {})
994 995 996 997 998 999 1000 1001 1002 1003
        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 已提交
1004 1005
      end

P
Pratik Naik 已提交
1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019
      # 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
1020
      #   with +attributes+ and linked to this object through a foreign key, but has not yet been saved.
P
Pratik Naik 已提交
1021 1022 1023 1024 1025 1026 1027
      # [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 已提交
1028
      #
P
Pratik Naik 已提交
1029 1030 1031
      # === Example
      #
      # A Post class declares <tt>belongs_to :author</tt>, which will add:
D
Initial  
David Heinemeier Hansson 已提交
1032 1033 1034
      # * <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 已提交
1035 1036
      # * <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 已提交
1037
      # The declaration can also include an options hash to specialize the behavior of the association.
1038
      #
P
Pratik Naik 已提交
1039 1040 1041 1042
      # === Options
      #
      # [:class_name]
      #   Specify the class name of the association. Use it only if that name can't be inferred
P
Pratik Naik 已提交
1043 1044
      #   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 已提交
1045 1046
      # [:conditions]
      #   Specify the conditions that the associated object must meet in order to be included as a +WHERE+
1047
      #   SQL fragment, such as <tt>authorized = 1</tt>.
P
Pratik Naik 已提交
1048 1049
      # [: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
1050
      #   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 已提交
1051 1052
      # [:foreign_key]
      #   Specify the foreign key used for the association. By default this is guessed to be the name
P
Pratik Naik 已提交
1053 1054 1055
      #   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".
1056 1057
      # [:primary_key]
      #   Specify the method that returns the primary key of associated object used for the association. By default this is id.
P
Pratik Naik 已提交
1058 1059
      # [:dependent]
      #   If set to <tt>:destroy</tt>, the associated object is destroyed when this object is. If set to
1060 1061 1062
      #   <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 已提交
1063 1064
      # [:counter_cache]
      #   Caches the number of belonging objects on the associate class through the use of +increment_counter+
1065
      #   and +decrement_counter+. The counter cache is incremented when an object of this class is created and decremented when it's
P
Pratik Naik 已提交
1066 1067
      #   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
1068
      #   a column name instead of a +true+/+false+ value to this option (e.g., <tt>:counter_cache => :my_custom_counter</tt>.)
P
Pratik Naik 已提交
1069
      #   Note: Specifying a counter cache will add it to that model's list of readonly attributes using +attr_readonly+.
P
Pratik Naik 已提交
1070 1071 1072 1073
      # [: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+.
1074
      #   Note: If you've enabled the counter cache, then you may want to add the counter cache attribute
P
Pratik Naik 已提交
1075
      #   to the +attr_readonly+ list in the associated classes (e.g. <tt>class Post; attr_readonly :comments_count; end</tt>).
P
Pratik Naik 已提交
1076 1077 1078 1079
      # [: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.
1080 1081
      # [:autosave]
      #   If true, always save the associated object or destroy it if marked for destruction, when saving the parent object. Off by default.
1082 1083 1084
      # [:touch]
      #   If true, the associated object will be touched (the updated_at/on attributes set to now) when this record is either saved or
      #   destroyed. If you specify a symbol, that attribute will be updated with the current time instead of the updated_at/on attribute.
P
Pratik Naik 已提交
1085 1086 1087 1088
      # [:inverse_of]
      #   Specifies the name of the <tt>has_one</tt> or <tt>has_many</tt> association on the associated object that is the inverse of this <tt>belongs_to</tt> 
      #   association.  Does not work in combination with the <tt>:polymorphic</tt> options.  
      #   See ActiveRecord::Associations::ClassMethods's overview on Bi-directional assocations for more detail.
D
Initial  
David Heinemeier Hansson 已提交
1089 1090 1091
      #
      # Option examples:
      #   belongs_to :firm, :foreign_key => "client_of"
1092
      #   belongs_to :person, :primary_key => "name", :foreign_key => "person_name"
D
Initial  
David Heinemeier Hansson 已提交
1093
      #   belongs_to :author, :class_name => "Person", :foreign_key => "author_id"
1094
      #   belongs_to :valid_coupon, :class_name => "Coupon", :foreign_key => "coupon_id",
D
Initial  
David Heinemeier Hansson 已提交
1095
      #              :conditions => 'discounts > #{payments_count}'
R
Rick Olson 已提交
1096
      #   belongs_to :attachable, :polymorphic => true
1097
      #   belongs_to :project, :readonly => true
1098
      #   belongs_to :post, :counter_cache => true
1099 1100
      #   belongs_to :company, :touch => true
      #   belongs_to :company, :touch => :employees_last_updated_at
1101
      def belongs_to(association_id, options = {})
1102
        reflection = create_belongs_to_reflection(association_id, options)
1103

1104 1105
        if reflection.options[:polymorphic]
          association_accessor_methods(reflection, BelongsToPolymorphicAssociation)
1106
        else
1107 1108 1109
          association_accessor_methods(reflection, BelongsToAssociation)
          association_constructor_method(:build,  reflection, BelongsToAssociation)
          association_constructor_method(:create, reflection, BelongsToAssociation)
1110
        end
1111

1112 1113
        add_counter_cache_callbacks(reflection)          if options[:counter_cache]
        add_touch_callbacks(reflection, options[:touch]) if options[:touch]
1114 1115

        configure_dependency_for_belongs_to(reflection)
1116 1117
      end

P
Pratik Naik 已提交
1118 1119 1120
      # 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 已提交
1121 1122
      # 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,
1123
      # and the strings are equal when compared up to the shortest length, then the longer string is considered of higher
P
Pratik Naik 已提交
1124 1125 1126 1127
      # 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 已提交
1128
      #
1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144
      # 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
      #
1145
      # Deprecated: Any additional fields added to the join table will be placed as attributes when pulling records out through
1146
      # +has_and_belongs_to_many+ associations. Records returned from join tables with additional attributes will be marked as
P
Pratik Naik 已提交
1147
      # readonly (because we can't save changes to the additional attributes). It's strongly recommended that you upgrade any
1148
      # associations with attributes to a real join model (see introduction).
D
Initial  
David Heinemeier Hansson 已提交
1149
      #
1150
      # Adds the following methods for retrieval and query:
P
Pratik Naik 已提交
1151 1152 1153
      #
      # [collection(force_reload = false)]
      #   Returns an array of all the associated objects.
1154
      #   An empty array is returned if none are found.
P
Pratik Naik 已提交
1155 1156
      # [collection<<(object, ...)]
      #   Adds one or more objects to the collection by creating associations in the join table
1157
      #   (<tt>collection.push</tt> and <tt>collection.concat</tt> are aliases to this method).
P
Pratik Naik 已提交
1158 1159
      # [collection.delete(object, ...)]
      #   Removes one or more objects from the collection by removing their associations from the join table.
D
Initial  
David Heinemeier Hansson 已提交
1160
      #   This does not destroy the objects.
P
Pratik Naik 已提交
1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174
      # [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
1175
      #   meets the condition that it has to be associated with this object.
P
Pratik Naik 已提交
1176
      #   Uses the same rules as ActiveRecord::Base.find.
P
Pratik Naik 已提交
1177
      # [collection.exists?(...)]
P
Pratik Naik 已提交
1178 1179 1180 1181
      #   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
1182
      #   with +attributes+ and linked to this object through the join table, but has not yet been saved.
P
Pratik Naik 已提交
1183 1184
      # [collection.create(attributes = {})]
      #   Returns a new object of the collection type that has been instantiated
1185
      #   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 已提交
1186
      #
P
Pratik Naik 已提交
1187 1188 1189 1190 1191 1192
      # (+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 已提交
1193 1194 1195
      # * <tt>Developer#projects</tt>
      # * <tt>Developer#projects<<</tt>
      # * <tt>Developer#projects.delete</tt>
1196
      # * <tt>Developer#projects=</tt>
1197
      # * <tt>Developer#project_ids</tt>
1198
      # * <tt>Developer#project_ids=</tt>
D
Initial  
David Heinemeier Hansson 已提交
1199 1200 1201 1202
      # * <tt>Developer#projects.clear</tt>
      # * <tt>Developer#projects.empty?</tt>
      # * <tt>Developer#projects.size</tt>
      # * <tt>Developer#projects.find(id)</tt>
P
Pratik Naik 已提交
1203
      # * <tt>Developer#clients.exists?(...)</tt>
1204 1205
      # * <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 已提交
1206
      # The declaration may include an options hash to specialize the behavior of the association.
1207
      #
P
Pratik Naik 已提交
1208 1209 1210 1211
      # === Options
      #
      # [:class_name]
      #   Specify the class name of the association. Use it only if that name can't be inferred
1212
      #   from the association name. So <tt>has_and_belongs_to_many :projects</tt> will by default be linked to the
P
Pratik Naik 已提交
1213
      #   Project class, but if the real class name is SuperProject, you'll have to specify it with this option.
P
Pratik Naik 已提交
1214 1215 1216 1217 1218 1219
      # [: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 已提交
1220
      #   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 已提交
1221
      #   to Project will use "person_id" as the default <tt>:foreign_key</tt>.
P
Pratik Naik 已提交
1222
      # [:association_foreign_key]
P
Pratik Naik 已提交
1223 1224 1225 1226
      #   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 已提交
1227 1228
      # [:conditions]
      #   Specify the conditions that the associated object must meet in order to be included as a +WHERE+
1229 1230 1231
      #   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 已提交
1232 1233
      # [:order]
      #   Specify the order in which the associated objects are returned as an <tt>ORDER BY</tt> SQL fragment,
1234
      #   such as <tt>last_name, first_name DESC</tt>
P
Pratik Naik 已提交
1235 1236 1237 1238
      # [: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
1239 1240 1241
      # [: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 已提交
1242 1243
      # [:delete_sql]
      #   Overwrite the default generated SQL statement used to remove links between the associated
P
Pratik Naik 已提交
1244
      #   classes with a manual statement.
P
Pratik Naik 已提交
1245 1246
      # [:insert_sql]
      #   Overwrite the default generated SQL statement used to add links between the associated classes
P
Pratik Naik 已提交
1247
      #   with a manual statement.
P
Pratik Naik 已提交
1248 1249 1250 1251 1252 1253
      # [: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.
1254 1255
      # [: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 已提交
1256 1257 1258 1259 1260 1261
      # [: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
1262
      #   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 已提交
1263 1264 1265 1266
      # [: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.
1267 1268
      # [: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 已提交
1269 1270 1271
      #
      # Option examples:
      #   has_and_belongs_to_many :projects
1272
      #   has_and_belongs_to_many :projects, :include => [ :milestones, :manager ]
D
Initial  
David Heinemeier Hansson 已提交
1273 1274
      #   has_and_belongs_to_many :nations, :class_name => "Country"
      #   has_and_belongs_to_many :categories, :join_table => "prods_cats"
1275
      #   has_and_belongs_to_many :categories, :readonly => true
1276
      #   has_and_belongs_to_many :active_projects, :join_table => 'developers_projects', :delete_sql =>
1277
      #   'DELETE FROM developers_projects WHERE active=1 AND developer_id = #{id} AND project_id = #{record.id}'
1278
      def has_and_belongs_to_many(association_id, options = {}, &extension)
1279 1280
        reflection = create_has_and_belongs_to_many_reflection(association_id, options, &extension)
        collection_accessor_methods(reflection, HasAndBelongsToManyAssociation)
D
Initial  
David Heinemeier Hansson 已提交
1281

1282 1283
        # Don't use a before_destroy callback since users' before_destroy
        # callbacks will be executed after the association is wiped out.
1284
        old_method = "destroy_without_habtm_shim_for_#{reflection.name}"
1285
        class_eval <<-end_eval unless method_defined?(old_method)
1286 1287 1288 1289 1290
          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
1291 1292
        end_eval

1293
        add_association_callbacks(reflection.name, options)
D
Initial  
David Heinemeier Hansson 已提交
1294 1295 1296
      end

      private
P
Pratik Naik 已提交
1297
        # Generates a join table name from two provided table names.
P
Pratik Naik 已提交
1298
        # The names in the join table names end up in lexicographic order.
P
Pratik Naik 已提交
1299 1300 1301
        #
        #   join_table_name("members", "clubs")         # => "clubs_members"
        #   join_table_name("members", "special_clubs") # => "members_special_clubs"
D
Initial  
David Heinemeier Hansson 已提交
1302 1303 1304 1305 1306 1307 1308 1309 1310
        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
1311

1312 1313
        def association_accessor_methods(reflection, association_proxy_class)
          define_method(reflection.name) do |*params|
1314
            force_reload = params.first unless params.empty?
1315
            association = association_instance_get(reflection.name)
1316

1317
            if association.nil? || force_reload
1318
              association = association_proxy_class.new(self, reflection)
1319
              retval = association.reload
1320
              if retval.nil? and association_proxy_class == BelongsToAssociation
1321
                association_instance_set(reflection.name, nil)
1322 1323
                return nil
              end
1324
              association_instance_set(reflection.name, association)
1325
            end
1326 1327

            association.target.nil? ? nil : association
1328 1329
          end

1330
          define_method("loaded_#{reflection.name}?") do
1331
            association = association_instance_get(reflection.name)
1332 1333 1334
            association && association.loaded?
          end

1335
          define_method("#{reflection.name}=") do |new_value|
1336
            association = association_instance_get(reflection.name)
1337

1338
            if association.nil? || association.target != new_value
1339
              association = association_proxy_class.new(self, reflection)
1340
            end
1341

1342 1343
            association.replace(new_value)
            association_instance_set(reflection.name, new_value.nil? ? nil : association)
1344
          end
1345

1346
          define_method("set_#{reflection.name}_target") do |target|
1347
            return if target.nil? and association_proxy_class == BelongsToAssociation
1348
            association = association_proxy_class.new(self, reflection)
1349
            association.target = target
1350
            association_instance_set(reflection.name, association)
1351
          end
1352 1353
        end

1354 1355
        def collection_reader_method(reflection, association_proxy_class)
          define_method(reflection.name) do |*params|
1356
            force_reload = params.first unless params.empty?
1357
            association = association_instance_get(reflection.name)
1358

1359
            unless association
1360
              association = association_proxy_class.new(self, reflection)
1361
              association_instance_set(reflection.name, association)
D
Initial  
David Heinemeier Hansson 已提交
1362
            end
1363

1364
            association.reload if force_reload
1365

1366 1367
            association
          end
1368 1369

          define_method("#{reflection.name.to_s.singularize}_ids") do
1370
            if send(reflection.name).loaded? || reflection.options[:finder_sql]
1371 1372
              send(reflection.name).map(&:id)
            else
1373 1374 1375
              if reflection.through_reflection && reflection.source_reflection.belongs_to?
                through = reflection.through_reflection
                primary_key = reflection.source_reflection.primary_key_name
1376
                send(through.name).all(:select => "DISTINCT #{through.quoted_table_name}.#{primary_key}").map!(&:"#{primary_key}")
1377
              else
1378
                send(reflection.name).all(:select => "#{reflection.quoted_table_name}.#{reflection.klass.primary_key}").map!(&:id)
1379
              end
1380
            end
1381
          end
1382

1383
        end
D
Initial  
David Heinemeier Hansson 已提交
1384

1385
        def collection_accessor_methods(reflection, association_proxy_class, writer = true)
1386 1387
          collection_reader_method(reflection, association_proxy_class)

1388 1389 1390 1391 1392 1393 1394
          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
1395

1396 1397
            define_method("#{reflection.name.to_s.singularize}_ids=") do |new_value|
              ids = (new_value || []).reject { |nid| nid.blank? }
1398
              send("#{reflection.name}=", reflection.klass.find(ids))
1399
            end
1400
          end
D
Initial  
David Heinemeier Hansson 已提交
1401
        end
1402

1403 1404
        def association_constructor_method(constructor, reflection, association_proxy_class)
          define_method("#{constructor}_#{reflection.name}") do |*params|
1405 1406
            attributees      = params.first unless params.empty?
            replace_existing = params[1].nil? ? true : params[1]
1407
            association      = association_instance_get(reflection.name)
1408

1409
            unless association
1410
              association = association_proxy_class.new(self, reflection)
1411
              association_instance_set(reflection.name, association)
1412 1413
            end

1414 1415 1416 1417 1418
            if association_proxy_class == HasOneAssociation
              association.send(constructor, attributees, replace_existing)
            else
              association.send(constructor, attributees)
            end
1419 1420
          end
        end
1421

1422 1423 1424 1425 1426 1427
        def add_counter_cache_callbacks(reflection)
          cache_column = reflection.counter_cache_column

          method_name = "belongs_to_counter_cache_after_create_for_#{reflection.name}".to_sym
          define_method(method_name) do
            association = send(reflection.name)
1428
            association.class.increment_counter(cache_column, association.id) unless association.nil?
1429 1430 1431 1432 1433 1434
          end
          after_create(method_name)

          method_name = "belongs_to_counter_cache_before_destroy_for_#{reflection.name}".to_sym
          define_method(method_name) do
            association = send(reflection.name)
1435
            association.class.decrement_counter(cache_column, association.id) unless association.nil?
1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458
          end
          before_destroy(method_name)

          module_eval(
            "#{reflection.class_name}.send(:attr_readonly,\"#{cache_column}\".intern) if defined?(#{reflection.class_name}) && #{reflection.class_name}.respond_to?(:attr_readonly)"
          )
        end
        
        def add_touch_callbacks(reflection, touch_attribute)
          method_name = "belongs_to_touch_after_save_or_destroy_for_#{reflection.name}".to_sym
          define_method(method_name) do
            association = send(reflection.name)
            
            if touch_attribute == true
              association.touch unless association.nil?
            else
              association.touch(touch_attribute) unless association.nil?
            end
          end
          after_save(method_name)
          after_destroy(method_name)
        end

1459
        def find_with_associations(options = {})
1460
          catch :invalid_query do
1461
            join_dependency = JoinDependency.new(self, merge_includes(scope(:find, :include), options[:include]), options[:joins])
1462 1463 1464 1465
            rows = select_all_rows(options, join_dependency)
            return join_dependency.instantiate(rows)
          end
          []
1466
        end
1467

1468 1469 1470
        # Creates before_destroy callback methods that nullify, delete or destroy
        # has_many associated objects, according to the defined :dependent rule.
        #
1471 1472
        # See HasManyAssociation#delete_records.  Dependent associations
        # delete children, otherwise foreign key is set to NULL.
1473 1474 1475 1476 1477
        #
        # 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)
1478 1479 1480 1481 1482
          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]
1483
            dependent_conditions << sanitize_sql(reflection.options[:conditions], reflection.quoted_table_name) if reflection.options[:conditions]
1484
            dependent_conditions << extra_conditions if extra_conditions
1485
            dependent_conditions = dependent_conditions.collect {|where| "(#{where})" }.join(" AND ")
1486
            dependent_conditions = dependent_conditions.gsub('@', '\@')
1487 1488
            case reflection.options[:dependent]
              when :destroy
1489 1490
                method_name = "has_many_dependent_destroy_for_#{reflection.name}".to_sym
                define_method(method_name) do
1491
                  send(reflection.name).each { |o| o.destroy }
1492 1493
                end
                before_destroy method_name
1494
              when :delete_all
1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511
                # before_destroy do |record|
                #   self.class.send(:delete_all_has_many_dependencies,
                #     record,
                #     "posts",
                #     Post,
                #     %@...@) # this is a string literal like %(...)
                #   end
                # end
                module_eval <<-CALLBACK
                  before_destroy do |record|
                    self.class.send(:delete_all_has_many_dependencies,
                      record,
                      "#{reflection.name}",
                      #{reflection.class_name},
                      %@#{dependent_conditions}@)
                  end
                CALLBACK
1512
              when :nullify
1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531
                # before_destroy do |record|
                #   self.class.send(:nullify_has_many_dependencies,
                #     record,
                #     "posts",
                #     Post,
                #     "user_id",
                #     %@...@) # this is a string literal like %(...)
                #   end
                # end
                module_eval <<-CALLBACK
                  before_destroy do |record|
                    self.class.send(:nullify_has_many_dependencies,
                      record,
                      "#{reflection.name}",
                      #{reflection.class_name},
                      "#{reflection.primary_key_name}",
                      %@#{dependent_conditions}@)
                  end
                CALLBACK
1532 1533 1534
              else
                raise ArgumentError, "The :dependent option expects either :destroy, :delete_all, or :nullify (#{reflection.options[:dependent].inspect})"
            end
1535 1536
          end
        end
1537

P
Pratik Naik 已提交
1538 1539
        # Creates before_destroy callback methods that nullify, delete or destroy
        # has_one associated objects, according to the defined :dependent rule.
1540
        def configure_dependency_for_has_one(reflection)
1541 1542 1543
          if reflection.options.include?(:dependent)
            case reflection.options[:dependent]
              when :destroy
1544 1545
                method_name = "has_one_dependent_destroy_for_#{reflection.name}".to_sym
                define_method(method_name) do
1546
                  association = send(reflection.name)
1547 1548 1549
                  association.destroy unless association.nil?
                end
                before_destroy method_name
1550
              when :delete
1551 1552
                method_name = "has_one_dependent_delete_for_#{reflection.name}".to_sym
                define_method(method_name) do
P
Pratik Naik 已提交
1553 1554 1555 1556
                  # 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.
1557
                  association = send(reflection.name)
1558
                  association.delete unless association.nil?
1559 1560
                end
                before_destroy method_name
1561
              when :nullify
1562 1563
                method_name = "has_one_dependent_nullify_for_#{reflection.name}".to_sym
                define_method(method_name) do
1564 1565
                  association = send(reflection.name)
                  association.update_attribute(reflection.primary_key_name, nil) unless association.nil?
1566 1567
                end
                before_destroy method_name
1568 1569 1570
              else
                raise ArgumentError, "The :dependent option expects either :destroy, :delete or :nullify (#{reflection.options[:dependent].inspect})"
            end
1571 1572 1573
          end
        end

1574 1575 1576 1577
        def configure_dependency_for_belongs_to(reflection)
          if reflection.options.include?(:dependent)
            case reflection.options[:dependent]
              when :destroy
1578 1579
                method_name = "belongs_to_dependent_destroy_for_#{reflection.name}".to_sym
                define_method(method_name) do
1580
                  association = send(reflection.name)
1581 1582
                  association.destroy unless association.nil?
                end
1583
                after_destroy method_name
1584
              when :delete
1585 1586
                method_name = "belongs_to_dependent_delete_for_#{reflection.name}".to_sym
                define_method(method_name) do
1587
                  association = send(reflection.name)
1588
                  association.delete unless association.nil?
1589
                end
1590
                after_destroy method_name
1591 1592 1593 1594 1595 1596
              else
                raise ArgumentError, "The :dependent option expects either :destroy or :delete (#{reflection.options[:dependent].inspect})"
            end
          end
        end

1597 1598 1599 1600 1601 1602 1603 1604
        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

1605 1606 1607 1608
        mattr_accessor :valid_keys_for_has_many_association
        @@valid_keys_for_has_many_association = [
          :class_name, :table_name, :foreign_key, :primary_key,
          :dependent,
1609
          :select, :conditions, :include, :order, :group, :having, :limit, :offset,
1610 1611 1612 1613 1614
          :as, :through, :source, :source_type,
          :uniq,
          :finder_sql, :counter_sql,
          :before_add, :after_add, :before_remove, :after_remove,
          :extend, :readonly,
1615
          :validate, :inverse_of
1616 1617
        ]

1618
        def create_has_many_reflection(association_id, options, &extension)
1619
          options.assert_valid_keys(valid_keys_for_has_many_association)
1620
          options[:extend] = create_extension_modules(association_id, extension, options[:extend])
1621

1622
          create_reflection(:has_many, association_id, options, self)
1623 1624
        end

1625 1626 1627 1628
        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,
1629
          :validate, :primary_key, :inverse_of
1630 1631
        ]

1632
        def create_has_one_reflection(association_id, options)
1633
          options.assert_valid_keys(valid_keys_for_has_one_association)
1634
          create_reflection(:has_one, association_id, options, self)
1635
        end
1636

1637 1638
        def create_has_one_through_reflection(association_id, options)
          options.assert_valid_keys(
1639
            :class_name, :foreign_key, :remote, :select, :conditions, :order, :include, :dependent, :counter_cache, :extend, :as, :through, :source, :source_type, :validate
1640 1641 1642
          )
          create_reflection(:has_one, association_id, options, self)
        end
1643

1644 1645
        mattr_accessor :valid_keys_for_belongs_to_association
        @@valid_keys_for_belongs_to_association = [
1646
          :class_name, :primary_key, :foreign_key, :foreign_type, :remote, :select, :conditions,
1647
          :include, :dependent, :counter_cache, :extend, :polymorphic, :readonly,
1648
          :validate, :touch, :inverse_of
1649 1650
        ]

1651
        def create_belongs_to_reflection(association_id, options)
1652
          options.assert_valid_keys(valid_keys_for_belongs_to_association)
1653 1654 1655 1656 1657 1658 1659 1660
          reflection = create_reflection(:belongs_to, association_id, options, self)

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

          reflection
        end
1661

1662 1663 1664
        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,
1665
          :select, :conditions, :include, :order, :group, :having, :limit, :offset,
1666
          :uniq,
1667
          :finder_sql, :counter_sql, :delete_sql, :insert_sql,
1668 1669 1670 1671 1672
          :before_add, :after_add, :before_remove, :after_remove,
          :extend, :readonly,
          :validate
        ]

1673
        def create_has_and_belongs_to_many_reflection(association_id, options, &extension)
1674
          options.assert_valid_keys(valid_keys_for_has_and_belongs_to_many_association)
1675

1676
          options[:extend] = create_extension_modules(association_id, extension, options[:extend])
1677 1678

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

1680 1681 1682
          if reflection.association_foreign_key == reflection.primary_key_name
            raise HasAndBelongsToManyAssociationForeignKeyNeeded.new(reflection)
          end
1683

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

1686 1687 1688
          reflection
        end

1689
        def reflect_on_included_associations(associations)
1690
          [ associations ].flatten.collect { |association| reflect_on_association(association.to_s.intern) }
1691 1692
        end

1693 1694 1695 1696 1697 1698 1699 1700 1701
        def guard_against_unlimitable_reflections(reflections, options)
          if (options[:offset] || options[:limit]) && !using_limitable_reflections?(reflections)
            raise(
              ConfigurationError,
              "You can not use offset and limit together with has_many or has_and_belongs_to_many associations"
            )
          end
        end

1702
        def select_all_rows(options, join_dependency)
1703
          connection.select_all(
1704
            construct_finder_sql_with_included_associations(options, join_dependency),
1705 1706 1707
            "#{name} Load Including Associations"
          )
        end
1708

1709
        def construct_finder_sql_with_included_associations(options, join_dependency)
1710
          scope = scope(:find)
1711
          sql = "SELECT #{column_aliases(join_dependency)} FROM #{(scope && scope[:from]) || options[:from] || quoted_table_name} "
1712
          sql << join_dependency.join_associations.collect{|join| join.association_join }.join
1713

1714
          add_joins!(sql, options[:joins], scope)
1715
          add_conditions!(sql, options[:conditions], scope)
1716
          add_limited_ids_condition!(sql, options, join_dependency) if !using_limitable_reflections?(join_dependency.reflections) && ((scope && scope[:limit]) || options[:limit])
1717

1718
          add_group!(sql, options[:group], options[:having], scope)
1719
          add_order!(sql, options[:order], scope)
1720
          add_limit!(sql, options, scope) if using_limitable_reflections?(join_dependency.reflections)
1721
          add_lock!(sql, options, scope)
1722

1723 1724
          return sanitize_sql(sql)
        end
1725

1726 1727
        def add_limited_ids_condition!(sql, options, join_dependency)
          unless (id_list = select_limited_ids_list(options, join_dependency)).empty?
1728
            sql << "#{condition_word(sql)} #{connection.quote_table_name table_name}.#{primary_key} IN (#{id_list}) "
1729 1730
          else
            throw :invalid_query
1731 1732
          end
        end
1733

1734
        def select_limited_ids_list(options, join_dependency)
1735 1736
          pk = columns_hash[primary_key]

1737
          connection.select_all(
1738
            construct_finder_sql_for_association_limiting(options, join_dependency),
1739
            "#{name} Load IDs For Limited Eager Loading"
1740
          ).collect { |row| connection.quote(row[primary_key], pk) }.join(", ")
1741
        end
1742

1743
        def construct_finder_sql_for_association_limiting(options, join_dependency)
1744
          scope       = scope(:find)
1745 1746 1747 1748 1749

          # 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
1750 1751 1752 1753
          distinct_join_associations = all_tables.uniq.map{|table|
            join_dependency.joins_for_table_name(table)
          }.flatten.compact.uniq

1754 1755 1756 1757 1758
          order = options[:order]
          if scoped_order = (scope && scope[:order])
            order = order ? "#{order}, #{scoped_order}" : scoped_order
          end

1759
          is_distinct = !options[:joins].blank? || include_eager_conditions?(options, tables_from_conditions) || include_eager_order?(options, tables_from_order)
1760
          sql = "SELECT "
1761
          if is_distinct
1762
            sql << connection.distinct("#{connection.quote_table_name table_name}.#{primary_key}", order)
1763 1764 1765
          else
            sql << primary_key
          end
1766
          sql << " FROM #{connection.quote_table_name table_name} "
1767

1768
          if is_distinct
1769
            sql << distinct_join_associations.collect { |assoc| assoc.association_join }.join
1770
            add_joins!(sql, options[:joins], scope)
1771
          end
1772

1773
          add_conditions!(sql, options[:conditions], scope)
1774
          add_group!(sql, options[:group], options[:having], scope)
1775

1776 1777
          if order && is_distinct
            connection.add_order_by_for_association_limiting!(sql, :order => order)
1778 1779
          else
            add_order!(sql, options[:order], scope)
1780
          end
1781

1782
          add_limit!(sql, options, scope)
1783

1784 1785
          return sanitize_sql(sql)
        end
1786

1787 1788
        def tables_in_string(string)
          return [] if string.blank?
1789
          string.scan(/([a-zA-Z_][\.\w]+).?\./).flatten
1790 1791
        end

1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803
        def tables_in_hash(hash)
          return [] if hash.blank?
          tables = hash.map do |key, value|
            if value.is_a?(Hash)
              key.to_s
            else
              tables_in_string(key) if key.is_a?(String)
            end
          end
          tables.flatten.compact
        end

1804
        def conditions_tables(options)
1805 1806 1807 1808
          # look in both sets of conditions
          conditions = [scope(:find, :conditions), options[:conditions]].inject([]) do |all, cond|
            case cond
              when nil   then all
1809 1810 1811
              when Array then all << tables_in_string(cond.first)
              when Hash  then all << tables_in_hash(cond)
              else            all << tables_in_string(cond)
1812 1813
            end
          end
1814
          conditions.flatten
1815 1816 1817
        end

        def order_tables(options)
1818
          order = [options[:order], scope(:find, :order) ].join(", ")
1819
          return [] unless order && order.is_a?(String)
1820
          tables_in_string(order)
1821 1822
        end

1823 1824 1825
        def selects_tables(options)
          select = options[:select]
          return [] unless select && select.is_a?(String)
1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838
          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 已提交
1839
              join_dependency.join_associations.collect {|join_association| [join_association.aliased_join_table_name, join_association.aliased_table_name]}.flatten.compact
1840 1841 1842 1843
            end
          else
            tables_in_string(merged_joins)
          end
1844 1845
        end

1846
        # Checks if the conditions reference a table other than the current model table
1847 1848
        def include_eager_conditions?(options, tables = nil, joined_tables = nil)
          ((tables || conditions_tables(options)) - (joined_tables || joined_tables(options))).any?
1849
        end
1850

1851
        # Checks if the query order references a table other than the current model's table.
1852 1853
        def include_eager_order?(options, tables = nil, joined_tables = nil)
          ((tables || order_tables(options)) - (joined_tables || joined_tables(options))).any?
1854
        end
1855

1856 1857
        def include_eager_select?(options, joined_tables = nil)
          (selects_tables(options) - (joined_tables || joined_tables(options))).any?
1858 1859
        end

1860
        def references_eager_loaded_tables?(options)
1861 1862
          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)
1863 1864
        end

1865 1866 1867 1868
        def using_limitable_reflections?(reflections)
          reflections.reject { |r| [ :belongs_to, :has_one ].include?(r.macro) }.length.zero?
        end

1869 1870
        def column_aliases(join_dependency)
          join_dependency.joins.collect{|join| join.column_names_with_alias.collect{|column_name, aliased_name|
1871
              "#{connection.quote_table_name join.aliased_table_name}.#{connection.quote_column_name column_name} AS #{aliased_name}"}}.flatten.join(", ")
1872 1873
        end

1874
        def add_association_callbacks(association_name, options)
1875 1876
          callbacks = %w(before_add after_add before_remove after_remove)
          callbacks.each do |callback_name|
1877
            full_callback_name = "#{callback_name}_for_#{association_name}"
1878 1879 1880
            defined_callbacks = options[callback_name.to_sym]
            if options.has_key?(callback_name.to_sym)
              class_inheritable_reader full_callback_name.to_sym
1881 1882 1883
              write_inheritable_attribute(full_callback_name.to_sym, [defined_callbacks].flatten)
            else
              write_inheritable_attribute(full_callback_name.to_sym, [])
1884 1885
            end
          end
1886
        end
1887

1888 1889 1890
        def condition_word(sql)
          sql =~ /where/i ? " AND " : "WHERE "
        end
1891

1892
        def create_extension_modules(association_id, block_extension, extensions)
1893
          if block_extension
1894
            extension_module_name = "#{self.to_s.demodulize}#{association_id.to_s.camelize}AssociationExtension"
1895

1896
            silence_warnings do
1897
              self.parent.const_set(extension_module_name, Module.new(&block_extension))
1898
            end
1899
            Array(extensions).push("#{self.parent}::#{extension_module_name}".constantize)
1900 1901
          else
            Array(extensions)
1902 1903
          end
        end
1904

D
David Heinemeier Hansson 已提交
1905
        class JoinDependency # :nodoc:
1906
          attr_reader :joins, :reflections, :table_aliases
1907

1908
          def initialize(base, associations, joins)
1909
            @joins                 = [JoinBase.new(base, joins)]
1910 1911 1912 1913
            @associations          = associations
            @reflections           = []
            @base_records_hash     = {}
            @base_records_in_order = []
1914 1915
            @table_aliases         = Hash.new { |aliases, table| aliases[table] = 0 }
            @table_aliases[base.table_name] = 1
1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932
            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
1933
              construct(@base_records_hash[primary_id], @associations, join_associations.dup, row)
1934
            end
1935
            remove_duplicate_results!(join_base.active_record, @base_records_in_order, @associations)
1936 1937 1938
            return @base_records_in_order
          end

1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955
          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|
1956 1957 1958 1959
                    descendant = record.send(reflection.name)
                    next unless descendant
                    descendant.target.uniq! if is_collection
                    descendant
1960 1961
                  end.flatten.compact

1962
                  remove_duplicate_results!(reflection.klass, parent_records, associations[name]) unless parent_records.empty?
1963 1964 1965 1966
                end
            end
          end

1967
          def join_for_table_name(table_name)
1968 1969 1970
            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
1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985
          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

1986 1987 1988 1989 1990 1991 1992 1993
          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
1994
                  @joins << build_join_association(reflection, parent)
1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008
                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

2009 2010 2011 2012 2013
            # overridden in InnerJoinDependency subclass
            def build_join_association(reflection, parent)
              JoinAssociation.new(reflection, self, parent)
            end

2014 2015 2016
            def construct(parent, associations, joins, row)
              case associations
                when Symbol, String
2017 2018 2019 2020
                  join = joins.detect{|j| j.reflection.name.to_s == associations.to_s && j.parent_table_name == parent.class.table_name }
                  raise(ConfigurationError, "No such association") if join.nil?

                  joins.delete(join)
2021 2022 2023 2024 2025 2026 2027
                  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|
2028 2029 2030 2031 2032
                    join = joins.detect{|j| j.reflection.name.to_s == name.to_s && j.parent_table_name == parent.class.table_name }
                    raise(ConfigurationError, "No such association") if join.nil?

                    association = construct_association(parent, join, row)
                    joins.delete(join)
2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044
                    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
2045

2046 2047
                  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)
2048
                  collection.target.push(association)
2049
                  collection.__send__(:set_inverse_instance, association, record)
2050 2051
                when :has_one
                  return if record.id.to_s != join.parent.record_id(row).to_s
2052
                  return if record.instance_variable_defined?("@#{join.reflection.name}")
2053
                  association = join.instantiate(row) unless row[join.aliased_primary_key].nil?
2054
                  set_target_and_inverse(join, association, record)
2055
                when :belongs_to
2056 2057
                  return if record.id.to_s != join.parent.record_id(row).to_s or row[join.aliased_primary_key].nil?
                  association = join.instantiate(row)
2058
                  set_target_and_inverse(join, association, record)
2059 2060 2061 2062 2063 2064
                else
                  raise ConfigurationError, "unknown macro: #{join.reflection.macro}"
              end
              return association
            end

2065 2066 2067 2068 2069
            def set_target_and_inverse(join, association, record)
              association_proxy = record.send("set_#{join.reflection.name}_target", association)
              association_proxy.__send__(:set_inverse_instance, association, record)
            end

D
David Heinemeier Hansson 已提交
2070
          class JoinBase # :nodoc:
2071
            attr_reader :active_record, :table_joins
2072
            delegate    :table_name, :column_names, :primary_key, :reflections, :sanitize_sql, :to => :active_record
2073

2074
            def initialize(active_record, joins = nil)
2075 2076
              @active_record = active_record
              @cached_record = {}
2077
              @table_joins   = joins
2078 2079 2080 2081 2082 2083 2084
            end

            def aliased_prefix
              "t0"
            end

            def aliased_primary_key
2085
              "#{aliased_prefix}_r0"
2086 2087 2088 2089 2090 2091 2092
            end

            def aliased_table_name
              active_record.table_name
            end

            def column_names_with_alias
2093
              unless defined?(@column_names_with_alias)
2094
                @column_names_with_alias = []
2095

2096
                ([primary_key] + (column_names - [primary_key])).each_with_index do |column_name, i|
2097
                  @column_names_with_alias << [column_name, "#{aliased_prefix}_r#{i}"]
2098 2099
                end
              end
2100 2101

              @column_names_with_alias
2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112
            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)
2113
              @cached_record[record_id(row)] ||= active_record.send(:instantiate, extract_record(row))
2114 2115 2116
            end
          end

D
David Heinemeier Hansson 已提交
2117
          class JoinAssociation < JoinBase # :nodoc:
2118
            attr_reader :reflection, :parent, :aliased_table_name, :aliased_prefix, :aliased_join_table_name, :parent_table_name
2119
            delegate    :options, :klass, :through_reflection, :source_reflection, :to => :reflection
2120 2121

            def initialize(reflection, join_dependency, parent = nil)
2122 2123 2124 2125 2126
              reflection.check_validity!
              if reflection.options[:polymorphic]
                raise EagerLoadPolymorphicError.new(reflection)
              end

2127
              super(reflection.klass)
2128
              @join_dependency    = join_dependency
2129 2130 2131
              @parent             = parent
              @reflection         = reflection
              @aliased_prefix     = "t#{ join_dependency.joins.size }"
2132
              @parent_table_name  = parent.active_record.table_name
2133
              @aliased_table_name = aliased_table_name_for(table_name)
2134

2135 2136
              if reflection.macro == :has_and_belongs_to_many
                @aliased_join_table_name = aliased_table_name_for(reflection.options[:join_table], "_join")
2137
              end
2138

2139
              if [:has_many, :has_one].include?(reflection.macro) && reflection.options[:through]
2140
                @aliased_join_table_name = aliased_table_name_for(reflection.through_reflection.klass.table_name, "_join")
2141
              end
2142 2143 2144
            end

            def association_join
2145
              connection = reflection.active_record.connection
2146
              join = case reflection.macro
2147
                when :has_and_belongs_to_many
2148
                  " #{join_type} %s ON %s.%s = %s.%s " % [
2149
                     table_alias_for(options[:join_table], aliased_join_table_name),
2150
                     connection.quote_table_name(aliased_join_table_name),
2151
                     options[:foreign_key] || reflection.active_record.to_s.foreign_key,
2152
                     connection.quote_table_name(parent.aliased_table_name),
2153
                     reflection.active_record.primary_key] +
2154
                  " #{join_type} %s ON %s.%s = %s.%s " % [
2155
                     table_name_and_alias,
2156 2157
                     connection.quote_table_name(aliased_table_name),
                     klass.primary_key,
2158
                     connection.quote_table_name(aliased_join_table_name),
2159
                     options[:association_foreign_key] || klass.to_s.foreign_key
2160 2161
                     ]
                when :has_many, :has_one
2162
                  case
2163
                    when reflection.options[:through]
2164
                      through_conditions = through_reflection.options[:conditions] ? "AND #{interpolate_sql(sanitize_sql(through_reflection.options[:conditions]))}" : ''
2165 2166 2167 2168

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

2169
                      if through_reflection.options[:as] # has_many :through against a polymorphic join
2170 2171
                        jt_foreign_key = through_reflection.options[:as].to_s + '_id'
                        jt_as_extra = " AND %s.%s = %s" % [
2172 2173
                          connection.quote_table_name(aliased_join_table_name),
                          connection.quote_column_name(through_reflection.options[:as].to_s + '_type'),
2174
                          klass.quote_value(parent.active_record.base_class.name)
2175
                        ]
2176
                      else
2177
                        jt_foreign_key = through_reflection.primary_key_name
2178
                      end
2179

2180 2181
                      case source_reflection.macro
                      when :has_many
2182 2183 2184
                        if source_reflection.options[:as]
                          first_key   = "#{source_reflection.options[:as]}_id"
                          second_key  = options[:foreign_key] || primary_key
2185
                          as_extra    = " AND %s.%s = %s" % [
2186 2187
                            connection.quote_table_name(aliased_table_name),
                            connection.quote_column_name("#{source_reflection.options[:as]}_type"),
2188
                            klass.quote_value(source_reflection.active_record.base_class.name)
2189 2190
                          ]
                        else
2191 2192 2193
                          first_key   = through_reflection.klass.base_class.to_s.foreign_key
                          second_key  = options[:foreign_key] || primary_key
                        end
2194

2195 2196
                        unless through_reflection.klass.descends_from_active_record?
                          jt_sti_extra = " AND %s.%s = %s" % [
2197 2198
                            connection.quote_table_name(aliased_join_table_name),
                            connection.quote_column_name(through_reflection.active_record.inheritance_column),
2199
                            through_reflection.klass.quote_value(through_reflection.klass.sti_name)]
2200 2201 2202 2203 2204 2205
                        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" % [
2206 2207
                            connection.quote_table_name(aliased_join_table_name),
                            connection.quote_column_name(reflection.source_reflection.options[:foreign_type]),
2208
                            klass.quote_value(reflection.options[:source_type])
2209
                          ]
2210
                        else
2211
                          second_key = source_reflection.primary_key_name
2212
                        end
2213
                      end
2214

2215
                      " #{join_type} %s ON (%s.%s = %s.%s%s%s%s) " % [
2216
                        table_alias_for(through_reflection.klass.table_name, aliased_join_table_name),
2217
                        connection.quote_table_name(parent.aliased_table_name),
2218
                        connection.quote_column_name(parent.primary_key),
2219
                        connection.quote_table_name(aliased_join_table_name),
2220
                        connection.quote_column_name(jt_foreign_key),
2221 2222
                        jt_as_extra, jt_source_extra, jt_sti_extra
                      ] +
2223
                      " #{join_type} %s ON (%s.%s = %s.%s%s) " % [
2224
                        table_name_and_alias,
2225
                        connection.quote_table_name(aliased_table_name),
2226
                        connection.quote_column_name(first_key),
2227
                        connection.quote_table_name(aliased_join_table_name),
2228
                        connection.quote_column_name(second_key),
2229 2230 2231
                        as_extra
                      ]

2232
                    when reflection.options[:as] && [:has_many, :has_one].include?(reflection.macro)
2233
                      " #{join_type} %s ON %s.%s = %s.%s AND %s.%s = %s" % [
2234
                        table_name_and_alias,
2235
                        connection.quote_table_name(aliased_table_name),
2236
                        "#{reflection.options[:as]}_id",
2237
                        connection.quote_table_name(parent.aliased_table_name),
2238
                        parent.primary_key,
2239
                        connection.quote_table_name(aliased_table_name),
2240
                        "#{reflection.options[:as]}_type",
2241
                        klass.quote_value(parent.active_record.base_class.name)
2242 2243
                      ]
                    else
2244
                      foreign_key = options[:foreign_key] || reflection.active_record.name.foreign_key
2245
                      " #{join_type} %s ON %s.%s = %s.%s " % [
2246
                        table_name_and_alias,
2247
                        aliased_table_name,
2248
                        foreign_key,
2249
                        parent.aliased_table_name,
2250
                        reflection.options[:primary_key] || parent.primary_key
2251 2252
                      ]
                  end
2253
                when :belongs_to
2254
                  " #{join_type} %s ON %s.%s = %s.%s " % [
2255
                     table_name_and_alias,
2256 2257
                     connection.quote_table_name(aliased_table_name),
                     reflection.klass.primary_key,
2258
                     connection.quote_table_name(parent.aliased_table_name),
2259
                     options[:foreign_key] || reflection.primary_key_name
2260 2261 2262
                    ]
                else
                  ""
2263
              end || ''
2264 2265
              join << %(AND %s) % [
                klass.send(:type_condition, aliased_table_name)] unless klass.descends_from_active_record?
2266 2267

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

2271
              join
2272
            end
2273

2274
            protected
2275

2276
              def aliased_table_name_for(name, suffix = nil)
2277
                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}
2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292
                  @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
2293

2294 2295 2296
              def pluralize(table_name)
                ActiveRecord::Base.pluralize_table_names ? table_name.to_s.pluralize : table_name
              end
2297

2298
              def table_alias_for(table_name, table_alias)
2299
                 "#{reflection.active_record.connection.quote_table_name(table_name)} #{table_alias if table_name != table_alias}".strip
2300 2301 2302 2303 2304
              end

              def table_name_and_alias
                table_alias_for table_name, @aliased_table_name
              end
2305 2306

              def interpolate_sql(sql)
2307 2308
                instance_eval("%@#{sql.gsub('@', '\@')}@")
              end
2309 2310

            private
2311 2312 2313 2314
              def join_type
                "LEFT OUTER JOIN"
              end
          end
2315 2316 2317 2318 2319 2320 2321 2322 2323
        end

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

          class InnerJoinAssociation < JoinAssociation
2324 2325 2326 2327
            private
              def join_type
                "INNER JOIN"
              end
2328 2329
          end
        end
2330

2331
    end
D
Initial  
David Heinemeier Hansson 已提交
2332
  end
2333
end