associations.rb 108.9 KB
Newer Older
J
Jeremy Kemper 已提交
1
require 'active_support/core_ext/module/delegation'
2
require 'active_support/core_ext/enumerable'
3
require 'active_support/core_ext/object/blank'
J
Jeremy Kemper 已提交
4

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

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

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

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

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

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

47
  class HasManyThroughCantAssociateThroughHasOneOrManyReflection < ActiveRecordError #:nodoc:
48 49 50 51
    def initialize(owner, reflection)
      super("Cannot modify association '#{owner.class.name}##{reflection.name}' because the source reflection class '#{reflection.source_reflection.class_name}' is associated to '#{reflection.through_reflection.class_name}' via :#{reflection.source_reflection.macro}.")
    end
  end
52

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

59 60 61 62 63 64
  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

65 66 67 68 69 70
  class HasAndBelongsToManyAssociationWithPrimaryKeyError < ActiveRecordError #:nodoc:
    def initialize(reflection)
      super("Primary key is not allowed in a has_and_belongs_to_many join table (#{reflection.options[:join_table]}).")
    end
  end

71 72 73 74 75 76
  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 已提交
77
  class EagerLoadPolymorphicError < ActiveRecordError #:nodoc:
78
    def initialize(reflection)
79
      super("Can not eagerly load the polymorphic association #{reflection.name.inspect}")
80 81 82
    end
  end

83 84
  class ReadOnlyAssociation < ActiveRecordError #:nodoc:
    def initialize(reflection)
85
      super("Can not add to a has_many :through association.  Try adding to #{reflection.through_reflection.name.inspect}.")
86 87 88
    end
  end

89 90 91 92 93 94 95 96 97
  # This error is raised when trying to destroy a parent instance in a N:1, 1:1 assosications
  # (has_many, has_one) when there is at least 1 child assosociated instance.
  # ex: if @project.tasks.size > 0, DeleteRestrictionError will be raised when trying to destroy @project
  class DeleteRestrictionError < ActiveRecordError #:nodoc:
    def initialize(reflection)
      super("Cannot delete record because of dependent #{reflection.name}")
    end
  end

P
Pratik Naik 已提交
98
  # See ActiveRecord::Associations::ClassMethods for documentation.
D
Initial  
David Heinemeier Hansson 已提交
99
  module Associations # :nodoc:
100
    extend ActiveSupport::Concern
101

102
    # These classes will be loaded when associations are created.
J
Joshua Peek 已提交
103 104 105 106 107 108 109 110 111 112 113
    # 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'

114
    # Clears out the association cache
115 116 117
    def clear_association_cache #:nodoc:
      self.class.reflect_on_all_associations.to_a.each do |assoc|
        instance_variable_set "@#{assoc.name}", nil
118
      end unless self.new_record?
119
    end
120

121 122 123
    private
      # Gets the specified association instance if it responds to :loaded?, nil otherwise.
      def association_instance_get(name)
A
Aaron Patterson 已提交
124 125 126 127 128
        ivar = "@#{name}"
        if instance_variable_defined?(ivar)
          association = instance_variable_get(ivar)
          association if association.respond_to?(:loaded?)
        end
129 130 131 132 133 134 135
      end

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

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

911
        if options[:through]
912
          collection_accessor_methods(reflection, HasManyThroughAssociation)
913 914
        else
          collection_accessor_methods(reflection, HasManyAssociation)
D
Initial  
David Heinemeier Hansson 已提交
915 916 917
        end
      end

P
Pratik Naik 已提交
918 919 920 921 922 923 924 925 926 927 928
      # 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 已提交
929
      #   and saves the associate object.
P
Pratik Naik 已提交
930 931 932 933 934 935 936 937 938 939 940 941
      # [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 已提交
942
      #
P
Pratik Naik 已提交
943 944 945
      # === Example
      #
      # An Account class declares <tt>has_one :beneficiary</tt>, which will add:
946
      # * <tt>Account#beneficiary</tt> (similar to <tt>Beneficiary.find(:first, :conditions => "account_id = #{id}")</tt>)
D
Initial  
David Heinemeier Hansson 已提交
947
      # * <tt>Account#beneficiary=(beneficiary)</tt> (similar to <tt>beneficiary.account_id = account.id; beneficiary.save</tt>)
948 949 950
      # * <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 已提交
951 952
      # === Options
      #
D
Initial  
David Heinemeier Hansson 已提交
953
      # The declaration can also include an options hash to specialize the behavior of the association.
954
      #
D
Initial  
David Heinemeier Hansson 已提交
955
      # Options are:
P
Pratik Naik 已提交
956 957
      # [:class_name]
      #   Specify the class name of the association. Use it only if that name can't be inferred
P
Pratik Naik 已提交
958 959
      #   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 已提交
960 961
      # [:conditions]
      #   Specify the conditions that the associated object must meet in order to be included as a +WHERE+
962 963 964
      #   SQL fragment, such as <tt>rank = 5</tt>. Record creation from the association is scoped if a hash
      #   is used. <tt>has_one :account, :conditions => {:enabled => true}</tt> will create an enabled account with <tt>@company.create_account</tt>
      #   or <tt>@company.build_account</tt>.
P
Pratik Naik 已提交
965 966
      # [:order]
      #   Specify the order in which the associated objects are returned as an <tt>ORDER BY</tt> SQL fragment,
P
Pratik Naik 已提交
967
      #   such as <tt>last_name, first_name DESC</tt>.
P
Pratik Naik 已提交
968 969
      # [:dependent]
      #   If set to <tt>:destroy</tt>, the associated object is destroyed when this object is. If set to
970 971
      #   <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 已提交
972 973
      # [:foreign_key]
      #   Specify the foreign key used for the association. By default this is guessed to be the name
P
Pratik Naik 已提交
974 975
      #   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 已提交
976 977 978 979 980 981 982 983
      # [: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
984
      #   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 已提交
985 986
      # [:through]
      #   Specifies a Join Model through which to perform the query.  Options for <tt>:class_name</tt> and <tt>:foreign_key</tt>
987
      #   are ignored, as the association uses the source reflection. You can only use a <tt>:through</tt> query through a
988
      #   <tt>has_one</tt> or <tt>belongs_to</tt> association on the join model.
P
Pratik Naik 已提交
989 990
      # [:source]
      #   Specifies the source association name used by <tt>has_one :through</tt> queries.  Only use it if the name cannot be
991
      #   inferred from the association.  <tt>has_one :favorite, :through => :favorites</tt> will look for a
992
      #   <tt>:favorite</tt> on Favorite, unless a <tt>:source</tt> is given.
P
Pratik Naik 已提交
993 994
      # [:source_type]
      #   Specifies type of the source association used by <tt>has_one :through</tt> queries where the source
995
      #   association is a polymorphic +belongs_to+.
P
Pratik Naik 已提交
996 997 998 999
      # [: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.
1000 1001
      # [: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 已提交
1002
      # [:inverse_of]
E
Emilio Tagua 已提交
1003 1004
      #   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.
P
Pratik Naik 已提交
1005
      #   See ActiveRecord::Associations::ClassMethods's overview on Bi-directional assocations for more detail.
1006
      #
D
Initial  
David Heinemeier Hansson 已提交
1007
      # Option examples:
1008
      #   has_one :credit_card, :dependent => :destroy  # destroys the associated credit card
1009
      #   has_one :credit_card, :dependent => :nullify  # updates the associated records foreign key value to NULL rather than destroying it
D
Initial  
David Heinemeier Hansson 已提交
1010 1011
      #   has_one :last_comment, :class_name => "Comment", :order => "posted_on"
      #   has_one :project_manager, :class_name => "Person", :conditions => "role = 'project_manager'"
1012
      #   has_one :attachment, :as => :attachable
1013
      #   has_one :boss, :readonly => :true
1014 1015
      #   has_one :club, :through => :membership
      #   has_one :primary_address, :through => :addressables, :conditions => ["addressable.primary = ?", true], :source => :addressable
D
Initial  
David Heinemeier Hansson 已提交
1016
      def has_one(association_id, options = {})
1017 1018 1019 1020 1021 1022 1023 1024 1025 1026
        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 已提交
1027 1028
      end

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

1126 1127
        if reflection.options[:polymorphic]
          association_accessor_methods(reflection, BelongsToPolymorphicAssociation)
1128
        else
1129 1130 1131
          association_accessor_methods(reflection, BelongsToAssociation)
          association_constructor_method(:build,  reflection, BelongsToAssociation)
          association_constructor_method(:create, reflection, BelongsToAssociation)
1132
        end
1133

1134 1135
        add_counter_cache_callbacks(reflection)          if options[:counter_cache]
        add_touch_callbacks(reflection, options[:touch]) if options[:touch]
1136 1137

        configure_dependency_for_belongs_to(reflection)
1138 1139
      end

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

1304 1305
        # Don't use a before_destroy callback since users' before_destroy
        # callbacks will be executed after the association is wiped out.
1306
        old_method = "destroy_without_habtm_shim_for_#{reflection.name}"
1307
        class_eval <<-end_eval unless method_defined?(old_method)
1308 1309 1310 1311 1312
          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
1313 1314
        end_eval

1315
        add_association_callbacks(reflection.name, options)
D
Initial  
David Heinemeier Hansson 已提交
1316 1317 1318
      end

      private
P
Pratik Naik 已提交
1319
        # Generates a join table name from two provided table names.
P
Pratik Naik 已提交
1320
        # The names in the join table names end up in lexicographic order.
P
Pratik Naik 已提交
1321 1322 1323
        #
        #   join_table_name("members", "clubs")         # => "clubs_members"
        #   join_table_name("members", "special_clubs") # => "members_special_clubs"
D
Initial  
David Heinemeier Hansson 已提交
1324 1325 1326 1327 1328 1329 1330 1331 1332
        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
1333

1334 1335
        def association_accessor_methods(reflection, association_proxy_class)
          define_method(reflection.name) do |*params|
1336
            force_reload = params.first unless params.empty?
1337
            association = association_instance_get(reflection.name)
1338

1339
            if association.nil? || force_reload
1340
              association = association_proxy_class.new(self, reflection)
1341
              retval = force_reload ? reflection.klass.uncached { association.reload } : association.reload
1342
              if retval.nil? and association_proxy_class == BelongsToAssociation
1343
                association_instance_set(reflection.name, nil)
1344 1345
                return nil
              end
1346
              association_instance_set(reflection.name, association)
1347
            end
1348 1349

            association.target.nil? ? nil : association
1350 1351
          end

1352
          define_method("loaded_#{reflection.name}?") do
1353
            association = association_instance_get(reflection.name)
1354 1355 1356
            association && association.loaded?
          end

1357
          define_method("#{reflection.name}=") do |new_value|
1358
            association = association_instance_get(reflection.name)
1359

1360
            if association.nil? || association.target != new_value
1361
              association = association_proxy_class.new(self, reflection)
1362
            end
1363

1364 1365
            association.replace(new_value)
            association_instance_set(reflection.name, new_value.nil? ? nil : association)
1366
          end
1367

1368
          define_method("set_#{reflection.name}_target") do |target|
1369
            return if target.nil? and association_proxy_class == BelongsToAssociation
1370
            association = association_proxy_class.new(self, reflection)
1371
            association.target = target
1372
            association_instance_set(reflection.name, association)
1373
          end
1374 1375
        end

1376 1377
        def collection_reader_method(reflection, association_proxy_class)
          define_method(reflection.name) do |*params|
1378
            force_reload = params.first unless params.empty?
1379
            association = association_instance_get(reflection.name)
1380

1381
            unless association
1382
              association = association_proxy_class.new(self, reflection)
1383
              association_instance_set(reflection.name, association)
D
Initial  
David Heinemeier Hansson 已提交
1384
            end
1385

1386
            reflection.klass.uncached { association.reload } if force_reload
1387

1388 1389
            association
          end
1390 1391

          define_method("#{reflection.name.to_s.singularize}_ids") do
1392
            if send(reflection.name).loaded? || reflection.options[:finder_sql]
1393 1394
              send(reflection.name).map(&:id)
            else
1395 1396 1397
              if reflection.through_reflection && reflection.source_reflection.belongs_to?
                through = reflection.through_reflection
                primary_key = reflection.source_reflection.primary_key_name
1398
                send(through.name).select("DISTINCT #{through.quoted_table_name}.#{primary_key}").map!(&:"#{primary_key}")
1399
              else
1400
                send(reflection.name).select("#{reflection.quoted_table_name}.#{reflection.klass.primary_key}").map!(&:id)
1401
              end
1402
            end
1403
          end
1404

1405
        end
D
Initial  
David Heinemeier Hansson 已提交
1406

1407
        def collection_accessor_methods(reflection, association_proxy_class, writer = true)
1408 1409
          collection_reader_method(reflection, association_proxy_class)

1410 1411 1412 1413 1414 1415 1416
          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
1417

1418
            define_method("#{reflection.name.to_s.singularize}_ids=") do |new_value|
1419 1420
              ids = (new_value || []).reject { |nid| nid.blank? }.map(&:to_i)
              send("#{reflection.name}=", reflection.klass.find(ids).index_by(&:id).values_at(*ids))
1421
            end
1422
          end
D
Initial  
David Heinemeier Hansson 已提交
1423
        end
1424

1425 1426
        def association_constructor_method(constructor, reflection, association_proxy_class)
          define_method("#{constructor}_#{reflection.name}") do |*params|
1427 1428
            attributees      = params.first unless params.empty?
            replace_existing = params[1].nil? ? true : params[1]
1429
            association      = association_instance_get(reflection.name)
1430

1431
            unless association
1432
              association = association_proxy_class.new(self, reflection)
1433
              association_instance_set(reflection.name, association)
1434 1435
            end

1436 1437 1438 1439 1440
            if association_proxy_class == HasOneAssociation
              association.send(constructor, attributees, replace_existing)
            else
              association.send(constructor, attributees)
            end
1441 1442
          end
        end
1443

1444 1445 1446 1447 1448 1449
        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)
1450
            association.class.increment_counter(cache_column, association.id) unless association.nil?
1451 1452 1453 1454 1455 1456
          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)
1457
            association.class.decrement_counter(cache_column, association.id) unless association.nil?
1458 1459 1460 1461 1462 1463 1464
          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
1465

1466 1467 1468 1469
        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)
1470

1471 1472 1473 1474 1475 1476 1477 1478 1479 1480
            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

1481 1482
        # Creates before_destroy callback methods that nullify, delete or destroy
        # has_many associated objects, according to the defined :dependent rule.
1483 1484
        # If the association is marked as :dependent => :restrict, create a callback
        # that prevents deleting entirely.
1485
        #
1486 1487
        # See HasManyAssociation#delete_records.  Dependent associations
        # delete children, otherwise foreign key is set to NULL.
1488 1489 1490 1491
        # See HasManyAssociation#delete_records. Dependent associations
        # delete children if the option is set to :destroy or :delete_all, set the
        # foreign key to NULL if the option is set to :nullify, and do not touch the
        # child records if the option is set to :restrict.
1492 1493 1494 1495
        #
        # The +extra_conditions+ parameter, which is not used within the main
        # Active Record codebase, is meant to allow plugins to define extra
        # finder conditions.
1496
        def configure_dependency_for_has_many(reflection, extra_conditions = nil)
1497 1498 1499
          if reflection.options.include?(:dependent)
            case reflection.options[:dependent]
              when :destroy
1500 1501
                method_name = "has_many_dependent_destroy_for_#{reflection.name}".to_sym
                define_method(method_name) do
1502
                  send(reflection.name).each { |o| o.destroy }
1503 1504
                end
                before_destroy method_name
1505
              when :delete_all
1506 1507 1508 1509 1510
                before_destroy do |record|
                  self.class.send(:delete_all_has_many_dependencies,
                  record,
                  reflection.name,
                  reflection.klass,
1511
                  reflection.dependent_conditions(record, self.class, extra_conditions))
1512
                end
1513
              when :nullify
1514 1515 1516 1517 1518 1519
                before_destroy do |record|
                  self.class.send(:nullify_has_many_dependencies,
                  record,
                  reflection.name,
                  reflection.klass,
                  reflection.primary_key_name,
1520
                  reflection.dependent_conditions(record, self.class, extra_conditions))
1521 1522 1523 1524 1525 1526
                end
              when :restrict
                method_name = "has_many_dependent_restrict_for_#{reflection.name}".to_sym
                define_method(method_name) do
                  unless send(reflection.name).empty?
                    raise DeleteRestrictionError.new(reflection)
1527
                  end
1528 1529
                end
                before_destroy method_name
1530
              else
1531
                raise ArgumentError, "The :dependent option expects either :destroy, :delete_all, :nullify or :restrict (#{reflection.options[:dependent].inspect})"
1532
            end
1533 1534
          end
        end
1535

P
Pratik Naik 已提交
1536 1537
        # Creates before_destroy callback methods that nullify, delete or destroy
        # has_one associated objects, according to the defined :dependent rule.
1538 1539
        # If the association is marked as :dependent => :restrict, create a callback
        # that prevents deleting entirely.
1540
        def configure_dependency_for_has_one(reflection)
1541
          if reflection.options.include?(:dependent)
A
Aaron Patterson 已提交
1542 1543 1544 1545 1546
            name = reflection.options[:dependent]
            method_name = :"has_one_dependent_#{name}_for_#{reflection.name}"

            case name
              when :destroy, :delete
1547 1548 1549 1550 1551 1552
                class_eval <<-eoruby, __FILE__, __LINE__ + 1
                  def #{method_name}
                    association = #{reflection.name}
                    association.#{name} if association
                  end
                eoruby
1553
              when :nullify
1554 1555 1556 1557 1558 1559
                class_eval <<-eoruby, __FILE__, __LINE__ + 1
                  def #{method_name}
                    association = #{reflection.name}
                    association.update_attribute(#{reflection.primary_key_name.inspect}, nil) if association
                  end
                eoruby
1560 1561 1562 1563 1564 1565 1566 1567
              when :restrict
                method_name = "has_one_dependent_restrict_for_#{reflection.name}".to_sym
                define_method(method_name) do
                  unless send(reflection.name).nil?
                    raise DeleteRestrictionError.new(reflection)
                  end
                end
                before_destroy method_name
1568
              else
1569
                raise ArgumentError, "The :dependent option expects either :destroy, :delete, :nullify or :restrict (#{reflection.options[:dependent].inspect})"
1570
            end
A
Aaron Patterson 已提交
1571 1572

            before_destroy method_name
1573 1574 1575
          end
        end

1576 1577
        def configure_dependency_for_belongs_to(reflection)
          if reflection.options.include?(:dependent)
1578 1579 1580 1581 1582 1583 1584
            name = reflection.options[:dependent]

            unless [:destroy, :delete].include?(name)
              raise ArgumentError, "The :dependent option expects either :destroy or :delete (#{reflection.options[:dependent].inspect})"
            end

            method_name = :"belongs_to_dependent_#{name}_for_#{reflection.name}"
1585 1586 1587 1588 1589 1590
            class_eval <<-eoruby, __FILE__, __LINE__ + 1
              def #{method_name}
                association = #{reflection.name}
                association.#{name} if association
              end
            eoruby
1591
            after_destroy method_name
1592 1593 1594
          end
        end

1595 1596 1597 1598 1599 1600 1601 1602
        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

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

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

1620
          create_reflection(:has_many, association_id, options, self)
1621 1622
        end

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

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

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

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

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

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

          reflection
        end
1659

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

1671
        def create_has_and_belongs_to_many_reflection(association_id, options, &extension)
1672
          options.assert_valid_keys(valid_keys_for_has_and_belongs_to_many_association)
1673
          options[:extend] = create_extension_modules(association_id, extension, options[:extend])
1674 1675

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

1677 1678 1679
          if reflection.association_foreign_key == reflection.primary_key_name
            raise HasAndBelongsToManyAssociationForeignKeyNeeded.new(reflection)
          end
1680

1681
          reflection.options[:join_table] ||= join_table_name(undecorated_table_name(self.to_s), undecorated_table_name(reflection.class_name))
1682 1683 1684
          if connection.supports_primary_key? && (connection.primary_key(reflection.options[:join_table]) rescue false)
             raise HasAndBelongsToManyAssociationWithPrimaryKeyError.new(reflection)
          end
1685

1686 1687 1688
          reflection
        end

1689
        def add_association_callbacks(association_name, options)
1690 1691
          callbacks = %w(before_add after_add before_remove after_remove)
          callbacks.each do |callback_name|
1692
            full_callback_name = "#{callback_name}_for_#{association_name}"
1693 1694 1695
            defined_callbacks = options[callback_name.to_sym]
            if options.has_key?(callback_name.to_sym)
              class_inheritable_reader full_callback_name.to_sym
1696 1697 1698
              write_inheritable_attribute(full_callback_name.to_sym, [defined_callbacks].flatten)
            else
              write_inheritable_attribute(full_callback_name.to_sym, [])
1699 1700
            end
          end
1701
        end
1702

1703
        def create_extension_modules(association_id, block_extension, extensions)
1704
          if block_extension
1705
            extension_module_name = "#{self.to_s.demodulize}#{association_id.to_s.camelize}AssociationExtension"
1706

1707
            silence_warnings do
1708
              self.parent.const_set(extension_module_name, Module.new(&block_extension))
1709
            end
1710
            Array(extensions).push("#{self.parent}::#{extension_module_name}".constantize)
1711 1712
          else
            Array(extensions)
1713 1714
          end
        end
1715

D
David Heinemeier Hansson 已提交
1716
        class JoinDependency # :nodoc:
1717
          attr_reader :joins, :reflections, :table_aliases
1718

1719
          def initialize(base, associations, joins)
1720
            @joins                 = [JoinBase.new(base, joins)]
1721 1722 1723 1724
            @associations          = associations
            @reflections           = []
            @base_records_hash     = {}
            @base_records_in_order = []
1725 1726
            @table_aliases         = Hash.new { |aliases, table| aliases[table] = 0 }
            @table_aliases[base.table_name] = 1
1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743
            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
1744
              construct(@base_records_hash[primary_id], @associations, join_associations.dup, row)
1745
            end
1746
            remove_duplicate_results!(join_base.active_record, @base_records_in_order, @associations)
1747 1748 1749
            return @base_records_in_order
          end

1750 1751 1752 1753
          def remove_duplicate_results!(base, records, associations)
            case associations
              when Symbol, String
                reflection = base.reflections[associations]
1754
                if reflection && reflection.collection?
1755 1756 1757 1758 1759 1760 1761 1762 1763 1764
                  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]

J
Jeremy Kemper 已提交
1765 1766 1767
                  parent_records = []
                  records.each do |record|
                    if descendant = record.send(reflection.name)
1768
                      if reflection.collection?
J
Jeremy Kemper 已提交
1769 1770 1771 1772 1773 1774
                        parent_records.concat descendant.target.uniq
                      else
                        parent_records << descendant
                      end
                    end
                  end
1775

1776
                  remove_duplicate_results!(reflection.klass, parent_records, associations[name]) unless parent_records.empty?
1777 1778 1779 1780
                end
            end
          end

1781 1782 1783 1784 1785 1786 1787 1788
          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
1789
                  @joins << build_join_association(reflection, parent)
1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803
                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

1804 1805 1806 1807
            def build_join_association(reflection, parent)
              JoinAssociation.new(reflection, self, parent)
            end

1808 1809 1810
            def construct(parent, associations, joins, row)
              case associations
                when Symbol, String
1811 1812 1813 1814
                  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)
1815 1816 1817 1818 1819 1820 1821
                  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|
1822 1823 1824 1825 1826
                    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)
1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838
                    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
1839

1840 1841
                  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)
1842
                  collection.target.push(association)
1843
                  collection.__send__(:set_inverse_instance, association, record)
1844 1845
                when :has_one
                  return if record.id.to_s != join.parent.record_id(row).to_s
1846
                  return if record.instance_variable_defined?("@#{join.reflection.name}")
1847
                  association = join.instantiate(row) unless row[join.aliased_primary_key].nil?
1848
                  set_target_and_inverse(join, association, record)
1849
                when :belongs_to
1850 1851
                  return if record.id.to_s != join.parent.record_id(row).to_s or row[join.aliased_primary_key].nil?
                  association = join.instantiate(row)
1852
                  set_target_and_inverse(join, association, record)
1853 1854 1855 1856 1857 1858
                else
                  raise ConfigurationError, "unknown macro: #{join.reflection.macro}"
              end
              return association
            end

1859 1860 1861 1862 1863
            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 已提交
1864
          class JoinBase # :nodoc:
1865
            attr_reader :active_record, :table_joins
1866
            delegate    :table_name, :column_names, :primary_key, :reflections, :sanitize_sql, :arel_engine, :to => :active_record
1867

1868
            def initialize(active_record, joins = nil)
1869 1870
              @active_record = active_record
              @cached_record = {}
1871
              @table_joins   = joins
1872 1873 1874 1875 1876 1877 1878
            end

            def aliased_prefix
              "t0"
            end

            def aliased_primary_key
1879
              "#{aliased_prefix}_r0"
1880 1881 1882 1883 1884 1885 1886
            end

            def aliased_table_name
              active_record.table_name
            end

            def column_names_with_alias
1887
              unless defined?(@column_names_with_alias)
1888
                @column_names_with_alias = []
1889

1890
                ([primary_key] + (column_names - [primary_key])).each_with_index do |column_name, i|
1891
                  @column_names_with_alias << [column_name, "#{aliased_prefix}_r#{i}"]
1892 1893
                end
              end
1894 1895

              @column_names_with_alias
1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906
            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)
1907
              @cached_record[record_id(row)] ||= active_record.send(:instantiate, extract_record(row))
1908 1909 1910
            end
          end

D
David Heinemeier Hansson 已提交
1911
          class JoinAssociation < JoinBase # :nodoc:
1912
            attr_reader :reflection, :parent, :aliased_table_name, :aliased_prefix, :aliased_join_table_name, :parent_table_name
1913
            delegate    :options, :klass, :through_reflection, :source_reflection, :to => :reflection
1914 1915

            def initialize(reflection, join_dependency, parent = nil)
1916 1917 1918 1919 1920
              reflection.check_validity!
              if reflection.options[:polymorphic]
                raise EagerLoadPolymorphicError.new(reflection)
              end

1921
              super(reflection.klass)
1922
              @join_dependency    = join_dependency
1923 1924 1925
              @parent             = parent
              @reflection         = reflection
              @aliased_prefix     = "t#{ join_dependency.joins.size }"
1926
              @parent_table_name  = parent.active_record.table_name
1927
              @aliased_table_name = aliased_table_name_for(table_name)
1928
              @join               = nil
1929

1930 1931
              if reflection.macro == :has_and_belongs_to_many
                @aliased_join_table_name = aliased_table_name_for(reflection.options[:join_table], "_join")
1932
              end
1933

1934
              if [:has_many, :has_one].include?(reflection.macro) && reflection.options[:through]
1935
                @aliased_join_table_name = aliased_table_name_for(reflection.through_reflection.klass.table_name, "_join")
1936
              end
1937 1938 1939
            end

            def association_join
1940
              return @join if @join
1941

1942 1943
              aliased_table = Arel::Table.new(table_name, :as => @aliased_table_name, :engine => arel_engine)
              parent_table = Arel::Table.new(parent.table_name, :as => parent.aliased_table_name, :engine => arel_engine)
1944

1945
              @join = case reflection.macro
1946
              when :has_and_belongs_to_many
1947
                join_table = Arel::Table.new(options[:join_table], :as => aliased_join_table_name, :engine => arel_engine)
1948 1949 1950 1951 1952 1953 1954 1955 1956
                fk = options[:foreign_key] || reflection.active_record.to_s.foreign_key
                klass_fk = options[:association_foreign_key] || klass.to_s.foreign_key

                [
                  join_table[fk].eq(parent_table[reflection.active_record.primary_key]),
                  aliased_table[klass.primary_key].eq(join_table[klass_fk])
                ]
              when :has_many, :has_one
                if reflection.options[:through]
1957
                  join_table = Arel::Table.new(through_reflection.klass.table_name, :as => aliased_join_table_name, :engine => arel_engine)
1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973
                  jt_foreign_key = jt_as_extra = jt_source_extra = jt_sti_extra = nil
                  first_key = second_key = as_extra = nil

                  if through_reflection.options[:as] # has_many :through against a polymorphic join
                    jt_foreign_key = through_reflection.options[:as].to_s + '_id'
                    jt_as_extra = join_table[through_reflection.options[:as].to_s + '_type'].eq(parent.active_record.base_class.name)
                  else
                    jt_foreign_key = through_reflection.primary_key_name
                  end

                  case source_reflection.macro
                  when :has_many
                    if source_reflection.options[:as]
                      first_key   = "#{source_reflection.options[:as]}_id"
                      second_key  = options[:foreign_key] || primary_key
                      as_extra    = aliased_table["#{source_reflection.options[:as]}_type"].eq(source_reflection.active_record.base_class.name)
E
Emilio Tagua 已提交
1974
                    else
1975 1976
                      first_key   = through_reflection.klass.base_class.to_s.foreign_key
                      second_key  = options[:foreign_key] || primary_key
E
Emilio Tagua 已提交
1977 1978
                    end

1979 1980 1981 1982 1983 1984 1985 1986 1987 1988
                    unless through_reflection.klass.descends_from_active_record?
                      jt_sti_extra = join_table[through_reflection.active_record.inheritance_column].eq(through_reflection.klass.sti_name)
                    end
                  when :belongs_to
                    first_key = primary_key
                    if reflection.options[:source_type]
                      second_key = source_reflection.association_foreign_key
                      jt_source_extra = join_table[reflection.source_reflection.options[:foreign_type]].eq(reflection.options[:source_type])
                    else
                      second_key = source_reflection.primary_key_name
E
Emilio Tagua 已提交
1989
                    end
1990
                  end
1991 1992 1993 1994

                  [
                    [parent_table[parent.primary_key].eq(join_table[jt_foreign_key]), jt_as_extra, jt_source_extra, jt_sti_extra].reject{|x| x.blank? },
                    aliased_table[first_key].eq(join_table[second_key])
1995
                  ]
1996 1997 1998 1999 2000 2001 2002 2003 2004
                elsif reflection.options[:as]
                  id_rel = aliased_table["#{reflection.options[:as]}_id"].eq(parent_table[parent.primary_key])
                  type_rel = aliased_table["#{reflection.options[:as]}_type"].eq(parent.active_record.base_class.name)
                  [id_rel, type_rel]
                else
                  foreign_key = options[:foreign_key] || reflection.active_record.name.foreign_key
                  [aliased_table[foreign_key].eq(parent_table[reflection.options[:primary_key] || parent.primary_key])]
                end
              when :belongs_to
2005
                [aliased_table[options[:primary_key] || reflection.klass.primary_key].eq(parent_table[options[:foreign_key] || reflection.primary_key_name])]
2006 2007 2008 2009 2010 2011 2012 2013
              end

              unless klass.descends_from_active_record?
                sti_column = aliased_table[klass.inheritance_column]
                sti_condition = sti_column.eq(klass.sti_name)
                klass.send(:subclasses).each {|subclass| sti_condition = sti_condition.or(sti_column.eq(subclass.sti_name)) }

                @join << sti_condition
E
Emilio Tagua 已提交
2014
              end
2015 2016

              [through_reflection, reflection].each do |ref|
2017 2018 2019
                if ref && ref.options[:conditions]
                  @join << interpolate_sql(sanitize_sql(ref.options[:conditions], aliased_table_name))
                end
2020 2021
              end

2022
              @join
2023
            end
2024

2025
            def relation
2026
              aliased = Arel::Table.new(table_name, :as => @aliased_table_name, :engine => arel_engine)
2027

2028
              if reflection.macro == :has_and_belongs_to_many
2029
                [Arel::Table.new(options[:join_table], :as => aliased_join_table_name, :engine => arel_engine), aliased]
2030
              elsif reflection.options[:through]
2031
                [Arel::Table.new(through_reflection.klass.table_name, :as => aliased_join_table_name, :engine => arel_engine), aliased]
2032
              else
2033
                aliased
2034 2035 2036
              end
            end

2037
            def join_relation(joining_relation, join = nil)
2038
              if (relations = relation).is_a?(Array)
2039 2040
                joining_relation.joins(Relation::JoinOperation.new(relations.first, Arel::OuterJoin, association_join.first)).
                  joins(Relation::JoinOperation.new(relations.last, Arel::OuterJoin, association_join.last))
2041
              else
2042
                joining_relation.joins(Relation::JoinOperation.new(relations, Arel::OuterJoin, association_join))
2043 2044 2045
              end
            end

2046
            protected
2047

2048
              def aliased_table_name_for(name, suffix = nil)
2049
                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}
2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064
                  @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
2065

2066 2067 2068
              def pluralize(table_name)
                ActiveRecord::Base.pluralize_table_names ? table_name.to_s.pluralize : table_name
              end
2069

2070
              def table_alias_for(table_name, table_alias)
2071
                 "#{table_name} #{table_alias if table_name != table_alias}".strip
2072 2073 2074 2075 2076
              end

              def table_name_and_alias
                table_alias_for table_name, @aliased_table_name
              end
2077 2078

              def interpolate_sql(sql)
2079 2080
                instance_eval("%@#{sql.gsub('@', '\@')}@")
              end
2081
          end
2082
        end
2083
    end
D
Initial  
David Heinemeier Hansson 已提交
2084
  end
2085
end