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

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

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

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

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

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

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

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

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

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

64 65 66 67 68 69
  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

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

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

P
Pratik Naik 已提交
88
  # See ActiveRecord::Associations::ClassMethods for documentation.
D
Initial  
David Heinemeier Hansson 已提交
89
  module Associations # :nodoc:
90
    extend ActiveSupport::Concern
91

92
    # These classes will be loaded when associations are created.
J
Joshua Peek 已提交
93 94 95 96 97 98 99 100 101 102 103
    # 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'

104
    # Clears out the association cache
105 106 107
    def clear_association_cache #:nodoc:
      self.class.reflect_on_all_associations.to_a.each do |assoc|
        instance_variable_set "@#{assoc.name}", nil
108
      end unless self.new_record?
109
    end
110

111 112 113 114 115 116 117 118 119 120 121 122
    private
      # Gets the specified association instance if it responds to :loaded?, nil otherwise.
      def association_instance_get(name)
        association = instance_variable_get("@#{name}")
        association if association.respond_to?(:loaded?)
      end

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

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

897
        if options[:through]
898
          collection_accessor_methods(reflection, HasManyThroughAssociation)
899 900
        else
          collection_accessor_methods(reflection, HasManyAssociation)
D
Initial  
David Heinemeier Hansson 已提交
901 902 903
        end
      end

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

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

1113 1114
        if reflection.options[:polymorphic]
          association_accessor_methods(reflection, BelongsToPolymorphicAssociation)
1115
        else
1116 1117 1118
          association_accessor_methods(reflection, BelongsToAssociation)
          association_constructor_method(:build,  reflection, BelongsToAssociation)
          association_constructor_method(:create, reflection, BelongsToAssociation)
1119
        end
1120

1121 1122
        add_counter_cache_callbacks(reflection)          if options[:counter_cache]
        add_touch_callbacks(reflection, options[:touch]) if options[:touch]
1123 1124

        configure_dependency_for_belongs_to(reflection)
1125 1126
      end

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

1291 1292
        # Don't use a before_destroy callback since users' before_destroy
        # callbacks will be executed after the association is wiped out.
1293
        old_method = "destroy_without_habtm_shim_for_#{reflection.name}"
1294
        class_eval <<-end_eval unless method_defined?(old_method)
1295 1296 1297 1298 1299
          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
1300 1301
        end_eval

1302
        add_association_callbacks(reflection.name, options)
D
Initial  
David Heinemeier Hansson 已提交
1303 1304 1305
      end

      private
P
Pratik Naik 已提交
1306
        # Generates a join table name from two provided table names.
P
Pratik Naik 已提交
1307
        # The names in the join table names end up in lexicographic order.
P
Pratik Naik 已提交
1308 1309 1310
        #
        #   join_table_name("members", "clubs")         # => "clubs_members"
        #   join_table_name("members", "special_clubs") # => "members_special_clubs"
D
Initial  
David Heinemeier Hansson 已提交
1311 1312 1313 1314 1315 1316 1317 1318 1319
        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
1320

1321 1322
        def association_accessor_methods(reflection, association_proxy_class)
          define_method(reflection.name) do |*params|
1323
            force_reload = params.first unless params.empty?
1324
            association = association_instance_get(reflection.name)
1325

1326
            if association.nil? || force_reload
1327
              association = association_proxy_class.new(self, reflection)
1328
              retval = force_reload ? reflection.klass.uncached { association.reload } : association.reload
1329
              if retval.nil? and association_proxy_class == BelongsToAssociation
1330
                association_instance_set(reflection.name, nil)
1331 1332
                return nil
              end
1333
              association_instance_set(reflection.name, association)
1334
            end
1335 1336

            association.target.nil? ? nil : association
1337 1338
          end

1339
          define_method("loaded_#{reflection.name}?") do
1340
            association = association_instance_get(reflection.name)
1341 1342 1343
            association && association.loaded?
          end

1344
          define_method("#{reflection.name}=") do |new_value|
1345
            association = association_instance_get(reflection.name)
1346

1347
            if association.nil? || association.target != new_value
1348
              association = association_proxy_class.new(self, reflection)
1349
            end
1350

1351 1352
            association.replace(new_value)
            association_instance_set(reflection.name, new_value.nil? ? nil : association)
1353
          end
1354

1355
          define_method("set_#{reflection.name}_target") do |target|
1356
            return if target.nil? and association_proxy_class == BelongsToAssociation
1357
            association = association_proxy_class.new(self, reflection)
1358
            association.target = target
1359
            association_instance_set(reflection.name, association)
1360
          end
1361 1362
        end

1363 1364
        def collection_reader_method(reflection, association_proxy_class)
          define_method(reflection.name) do |*params|
1365
            force_reload = params.first unless params.empty?
1366
            association = association_instance_get(reflection.name)
1367

1368
            unless association
1369
              association = association_proxy_class.new(self, reflection)
1370
              association_instance_set(reflection.name, association)
D
Initial  
David Heinemeier Hansson 已提交
1371
            end
1372

1373
            reflection.klass.uncached { association.reload } if force_reload
1374

1375 1376
            association
          end
1377 1378

          define_method("#{reflection.name.to_s.singularize}_ids") do
1379
            if send(reflection.name).loaded? || reflection.options[:finder_sql]
1380 1381
              send(reflection.name).map(&:id)
            else
1382 1383 1384
              if reflection.through_reflection && reflection.source_reflection.belongs_to?
                through = reflection.through_reflection
                primary_key = reflection.source_reflection.primary_key_name
1385
                send(through.name).all(:select => "DISTINCT #{through.quoted_table_name}.#{primary_key}").map!(&:"#{primary_key}")
1386
              else
1387
                send(reflection.name).all(:select => "#{reflection.quoted_table_name}.#{reflection.klass.primary_key}").map!(&:id)
1388
              end
1389
            end
1390
          end
1391

1392
        end
D
Initial  
David Heinemeier Hansson 已提交
1393

1394
        def collection_accessor_methods(reflection, association_proxy_class, writer = true)
1395 1396
          collection_reader_method(reflection, association_proxy_class)

1397 1398 1399 1400 1401 1402 1403
          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
1404

1405
            define_method("#{reflection.name.to_s.singularize}_ids=") do |new_value|
1406 1407
              ids = (new_value || []).reject { |nid| nid.blank? }.map(&:to_i)
              send("#{reflection.name}=", reflection.klass.find(ids).index_by(&:id).values_at(*ids))
1408
            end
1409
          end
D
Initial  
David Heinemeier Hansson 已提交
1410
        end
1411

1412 1413
        def association_constructor_method(constructor, reflection, association_proxy_class)
          define_method("#{constructor}_#{reflection.name}") do |*params|
1414 1415
            attributees      = params.first unless params.empty?
            replace_existing = params[1].nil? ? true : params[1]
1416
            association      = association_instance_get(reflection.name)
1417

1418
            unless association
1419
              association = association_proxy_class.new(self, reflection)
1420
              association_instance_set(reflection.name, association)
1421 1422
            end

1423 1424 1425 1426 1427
            if association_proxy_class == HasOneAssociation
              association.send(constructor, attributees, replace_existing)
            else
              association.send(constructor, attributees)
            end
1428 1429
          end
        end
1430

1431 1432 1433 1434 1435 1436
        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)
1437
            association.class.increment_counter(cache_column, association.id) unless association.nil?
1438 1439 1440 1441 1442 1443
          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)
1444
            association.class.decrement_counter(cache_column, association.id) unless association.nil?
1445 1446 1447 1448 1449 1450 1451
          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
1452

1453 1454 1455 1456
        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)
1457

1458 1459 1460 1461 1462 1463 1464 1465 1466 1467
            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

1468
        def find_with_associations(options = {}, join_dependency = nil)
1469
          catch :invalid_query do
1470
            join_dependency ||= JoinDependency.new(self, merge_includes(scope(:find, :include), options[:include]), options[:joins])
1471 1472 1473 1474
            rows = select_all_rows(options, join_dependency)
            return join_dependency.instantiate(rows)
          end
          []
1475
        end
1476

1477 1478 1479
        # Creates before_destroy callback methods that nullify, delete or destroy
        # has_many associated objects, according to the defined :dependent rule.
        #
1480 1481
        # See HasManyAssociation#delete_records.  Dependent associations
        # delete children, otherwise foreign key is set to NULL.
1482 1483 1484 1485 1486
        #
        # The +extra_conditions+ parameter, which is not used within the main
        # Active Record codebase, is meant to allow plugins to define extra
        # finder conditions.
        def configure_dependency_for_has_many(reflection, extra_conditions = nil)
1487 1488 1489
          if reflection.options.include?(:dependent)
            # Add polymorphic type if the :as option is present
            dependent_conditions = []
1490
            dependent_conditions << "#{reflection.primary_key_name} = \#{record.#{reflection.name}.send(:owner_quoted_id)}"
1491
            dependent_conditions << "#{reflection.options[:as]}_type = '#{base_class.name}'" if reflection.options[:as]
1492
            dependent_conditions << sanitize_sql(reflection.options[:conditions], reflection.quoted_table_name) if reflection.options[:conditions]
1493
            dependent_conditions << extra_conditions if extra_conditions
1494
            dependent_conditions = dependent_conditions.collect {|where| "(#{where})" }.join(" AND ")
1495
            dependent_conditions = dependent_conditions.gsub('@', '\@')
1496 1497
            case reflection.options[:dependent]
              when :destroy
1498 1499
                method_name = "has_many_dependent_destroy_for_#{reflection.name}".to_sym
                define_method(method_name) do
1500
                  send(reflection.name).each { |o| o.destroy }
1501 1502
                end
                before_destroy method_name
1503
              when :delete_all
1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520
                # before_destroy do |record|
                #   self.class.send(:delete_all_has_many_dependencies,
                #     record,
                #     "posts",
                #     Post,
                #     %@...@) # this is a string literal like %(...)
                #   end
                # end
                module_eval <<-CALLBACK
                  before_destroy do |record|
                    self.class.send(:delete_all_has_many_dependencies,
                      record,
                      "#{reflection.name}",
                      #{reflection.class_name},
                      %@#{dependent_conditions}@)
                  end
                CALLBACK
1521
              when :nullify
1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540
                # before_destroy do |record|
                #   self.class.send(:nullify_has_many_dependencies,
                #     record,
                #     "posts",
                #     Post,
                #     "user_id",
                #     %@...@) # this is a string literal like %(...)
                #   end
                # end
                module_eval <<-CALLBACK
                  before_destroy do |record|
                    self.class.send(:nullify_has_many_dependencies,
                      record,
                      "#{reflection.name}",
                      #{reflection.class_name},
                      "#{reflection.primary_key_name}",
                      %@#{dependent_conditions}@)
                  end
                CALLBACK
1541 1542 1543
              else
                raise ArgumentError, "The :dependent option expects either :destroy, :delete_all, or :nullify (#{reflection.options[:dependent].inspect})"
            end
1544 1545
          end
        end
1546

P
Pratik Naik 已提交
1547 1548
        # Creates before_destroy callback methods that nullify, delete or destroy
        # has_one associated objects, according to the defined :dependent rule.
1549
        def configure_dependency_for_has_one(reflection)
1550 1551 1552
          if reflection.options.include?(:dependent)
            case reflection.options[:dependent]
              when :destroy
1553 1554
                method_name = "has_one_dependent_destroy_for_#{reflection.name}".to_sym
                define_method(method_name) do
1555
                  association = send(reflection.name)
1556 1557 1558
                  association.destroy unless association.nil?
                end
                before_destroy method_name
1559
              when :delete
1560 1561
                method_name = "has_one_dependent_delete_for_#{reflection.name}".to_sym
                define_method(method_name) do
P
Pratik Naik 已提交
1562 1563 1564 1565
                  # Retrieve the associated object and delete it. The retrieval
                  # is necessary because there may be multiple associated objects
                  # with foreign keys pointing to this object, and we only want
                  # to delete the correct one, not all of them.
1566
                  association = send(reflection.name)
1567
                  association.delete unless association.nil?
1568 1569
                end
                before_destroy method_name
1570
              when :nullify
1571 1572
                method_name = "has_one_dependent_nullify_for_#{reflection.name}".to_sym
                define_method(method_name) do
1573 1574
                  association = send(reflection.name)
                  association.update_attribute(reflection.primary_key_name, nil) unless association.nil?
1575 1576
                end
                before_destroy method_name
1577 1578 1579
              else
                raise ArgumentError, "The :dependent option expects either :destroy, :delete or :nullify (#{reflection.options[:dependent].inspect})"
            end
1580 1581 1582
          end
        end

1583 1584 1585 1586
        def configure_dependency_for_belongs_to(reflection)
          if reflection.options.include?(:dependent)
            case reflection.options[:dependent]
              when :destroy
1587 1588
                method_name = "belongs_to_dependent_destroy_for_#{reflection.name}".to_sym
                define_method(method_name) do
1589
                  association = send(reflection.name)
1590 1591
                  association.destroy unless association.nil?
                end
1592
                after_destroy method_name
1593
              when :delete
1594 1595
                method_name = "belongs_to_dependent_delete_for_#{reflection.name}".to_sym
                define_method(method_name) do
1596
                  association = send(reflection.name)
1597
                  association.delete unless association.nil?
1598
                end
1599
                after_destroy method_name
1600 1601 1602 1603 1604 1605
              else
                raise ArgumentError, "The :dependent option expects either :destroy or :delete (#{reflection.options[:dependent].inspect})"
            end
          end
        end

1606 1607 1608 1609 1610 1611 1612 1613
        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

1614 1615 1616 1617
        mattr_accessor :valid_keys_for_has_many_association
        @@valid_keys_for_has_many_association = [
          :class_name, :table_name, :foreign_key, :primary_key,
          :dependent,
1618
          :select, :conditions, :include, :order, :group, :having, :limit, :offset,
1619 1620 1621 1622 1623
          :as, :through, :source, :source_type,
          :uniq,
          :finder_sql, :counter_sql,
          :before_add, :after_add, :before_remove, :after_remove,
          :extend, :readonly,
1624
          :validate, :inverse_of
1625 1626
        ]

1627
        def create_has_many_reflection(association_id, options, &extension)
1628
          options.assert_valid_keys(valid_keys_for_has_many_association)
1629
          options[:extend] = create_extension_modules(association_id, extension, options[:extend])
1630

1631
          create_reflection(:has_many, association_id, options, self)
1632 1633
        end

1634 1635 1636 1637
        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,
1638
          :validate, :primary_key, :inverse_of
1639 1640
        ]

1641
        def create_has_one_reflection(association_id, options)
1642
          options.assert_valid_keys(valid_keys_for_has_one_association)
1643
          create_reflection(:has_one, association_id, options, self)
1644
        end
1645

1646 1647
        def create_has_one_through_reflection(association_id, options)
          options.assert_valid_keys(
1648
            :class_name, :foreign_key, :remote, :select, :conditions, :order, :include, :dependent, :counter_cache, :extend, :as, :through, :source, :source_type, :validate
1649 1650 1651
          )
          create_reflection(:has_one, association_id, options, self)
        end
1652

1653 1654
        mattr_accessor :valid_keys_for_belongs_to_association
        @@valid_keys_for_belongs_to_association = [
1655
          :class_name, :primary_key, :foreign_key, :foreign_type, :remote, :select, :conditions,
1656
          :include, :dependent, :counter_cache, :extend, :polymorphic, :readonly,
1657
          :validate, :touch, :inverse_of
1658 1659
        ]

1660
        def create_belongs_to_reflection(association_id, options)
1661
          options.assert_valid_keys(valid_keys_for_belongs_to_association)
1662 1663 1664 1665 1666 1667 1668 1669
          reflection = create_reflection(:belongs_to, association_id, options, self)

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

          reflection
        end
1670

1671 1672 1673
        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,
1674
          :select, :conditions, :include, :order, :group, :having, :limit, :offset,
1675
          :uniq,
1676
          :finder_sql, :counter_sql, :delete_sql, :insert_sql,
1677 1678 1679 1680 1681
          :before_add, :after_add, :before_remove, :after_remove,
          :extend, :readonly,
          :validate
        ]

1682
        def create_has_and_belongs_to_many_reflection(association_id, options, &extension)
1683
          options.assert_valid_keys(valid_keys_for_has_and_belongs_to_many_association)
1684
          options[:extend] = create_extension_modules(association_id, extension, options[:extend])
1685 1686

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

1688 1689 1690
          if reflection.association_foreign_key == reflection.primary_key_name
            raise HasAndBelongsToManyAssociationForeignKeyNeeded.new(reflection)
          end
1691

1692
          reflection.options[:join_table] ||= join_table_name(undecorated_table_name(self.to_s), undecorated_table_name(reflection.class_name))
1693 1694 1695
          if connection.supports_primary_key? && (connection.primary_key(reflection.options[:join_table]) rescue false)
             raise HasAndBelongsToManyAssociationWithPrimaryKeyError.new(reflection)
          end
1696

1697 1698 1699
          reflection
        end

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

1707
        def construct_finder_arel_with_included_associations(options, join_dependency)
1708
          scope = scope(:find)
1709

1710
          relation = arel_table((scope && scope[:from]) || options[:from])
1711

1712
          for association in join_dependency.join_associations
1713
            relation = association.join_relation(relation)
1714
          end
1715

1716 1717 1718 1719
          relation = relation.joins(construct_join(options[:joins], scope)).
            select(column_aliases(join_dependency)).
            group(construct_group(options[:group], options[:having], scope)).
            order(construct_order(options[:order], scope)).
1720
            where(construct_conditions(options[:conditions], scope))
1721

1722
          relation = relation.where(construct_arel_limited_ids_condition(options, join_dependency)) if !using_limitable_reflections?(join_dependency.reflections) && ((scope && scope[:limit]) || options[:limit])
1723
          relation = relation.limit(construct_limit(options[:limit], scope)) if using_limitable_reflections?(join_dependency.reflections)
1724

1725 1726 1727 1728
          relation
        end

        def construct_finder_sql_with_included_associations(options, join_dependency)
1729
          construct_finder_arel_with_included_associations(options, join_dependency).to_sql
1730
        end
1731

1732 1733
        def construct_arel_limited_ids_condition(options, join_dependency)
          if (ids_array = select_limited_ids_array(options, join_dependency)).empty?
1734
            throw :invalid_query
1735
          else
J
Jeremy Kemper 已提交
1736
            Arel::Predicates::In.new(
1737 1738 1739
              Arel::SqlLiteral.new("#{connection.quote_table_name table_name}.#{primary_key}"),
              ids_array
            )
1740 1741 1742
          end
        end

1743
        def select_limited_ids_array(options, join_dependency)
1744
          connection.select_all(
1745
            construct_finder_sql_for_association_limiting(options, join_dependency),
1746
            "#{name} Load IDs For Limited Eager Loading"
1747
          ).collect { |row| row[primary_key] }
1748
        end
1749

1750
        def construct_finder_sql_for_association_limiting(options, join_dependency)
E
Emilio Tagua 已提交
1751
          scope = scope(:find)
1752

1753
          relation = arel_table(options[:from])
1754

1755
          for association in join_dependency.join_associations
1756
            relation = association.join_relation(relation)
1757
          end
1758

1759
          relation = relation.joins(construct_join(options[:joins], scope)).
1760
            where(construct_conditions(options[:conditions], scope)).
1761 1762 1763 1764 1765
            group(construct_group(options[:group], options[:having], scope)).
            order(construct_order(options[:order], scope)).
            limit(construct_limit(options[:limit], scope)).
            offset(construct_limit(options[:offset], scope)).
            select(connection.distinct("#{connection.quote_table_name table_name}.#{primary_key}", construct_order(options[:order], scope(:find)).join(",")))
1766

1767
          relation.to_sql
1768
        end
1769

1770 1771
        def tables_in_string(string)
          return [] if string.blank?
1772
          string.scan(/([a-zA-Z_][\.\w]+).?\./).flatten
1773 1774
        end

1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786
        def tables_in_hash(hash)
          return [] if hash.blank?
          tables = hash.map do |key, value|
            if value.is_a?(Hash)
              key.to_s
            else
              tables_in_string(key) if key.is_a?(String)
            end
          end
          tables.flatten.compact
        end

1787
        def conditions_tables(options)
1788 1789 1790 1791
          # look in both sets of conditions
          conditions = [scope(:find, :conditions), options[:conditions]].inject([]) do |all, cond|
            case cond
              when nil   then all
1792 1793 1794
              when Array then all << tables_in_string(cond.first)
              when Hash  then all << tables_in_hash(cond)
              else            all << tables_in_string(cond)
1795 1796
            end
          end
1797
          conditions.flatten
1798 1799 1800
        end

        def order_tables(options)
1801
          order = [options[:order], scope(:find, :order) ].join(", ")
1802
          return [] unless order && order.is_a?(String)
1803
          tables_in_string(order)
1804 1805
        end

1806 1807 1808
        def selects_tables(options)
          select = options[:select]
          return [] unless select && select.is_a?(String)
1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820
          tables_in_string(select)
        end

        def joined_tables(options)
          scope = scope(:find)
          joins = options[:joins]
          merged_joins = scope && scope[:joins] && joins ? merge_joins(scope[:joins], joins) : (joins || scope && scope[:joins])
          [table_name] + case merged_joins
          when Symbol, Hash, Array
            if array_of_strings?(merged_joins)
              tables_in_string(merged_joins.join(' '))
            else
1821
              join_dependency = ActiveRecord::Associations::ClassMethods::JoinDependency.new(self, merged_joins, nil)
F
Frederick Cheung 已提交
1822
              join_dependency.join_associations.collect {|join_association| [join_association.aliased_join_table_name, join_association.aliased_table_name]}.flatten.compact
1823 1824 1825 1826
            end
          else
            tables_in_string(merged_joins)
          end
1827 1828
        end

1829
        # Checks if the conditions reference a table other than the current model table
1830 1831
        def include_eager_conditions?(options, tables = nil, joined_tables = nil)
          ((tables || conditions_tables(options)) - (joined_tables || joined_tables(options))).any?
1832
        end
1833

1834
        # Checks if the query order references a table other than the current model's table.
1835 1836
        def include_eager_order?(options, tables = nil, joined_tables = nil)
          ((tables || order_tables(options)) - (joined_tables || joined_tables(options))).any?
1837
        end
1838

1839 1840
        def include_eager_select?(options, joined_tables = nil)
          (selects_tables(options) - (joined_tables || joined_tables(options))).any?
1841 1842
        end

1843
        def references_eager_loaded_tables?(options)
1844 1845
          joined_tables = joined_tables(options)
          include_eager_order?(options, nil, joined_tables) || include_eager_conditions?(options, nil, joined_tables) || include_eager_select?(options, joined_tables)
1846 1847
        end

1848 1849 1850 1851
        def using_limitable_reflections?(reflections)
          reflections.reject { |r| [ :belongs_to, :has_one ].include?(r.macro) }.length.zero?
        end

1852 1853
        def column_aliases(join_dependency)
          join_dependency.joins.collect{|join| join.column_names_with_alias.collect{|column_name, aliased_name|
1854
              "#{connection.quote_table_name join.aliased_table_name}.#{connection.quote_column_name column_name} AS #{aliased_name}"}}.flatten.join(", ")
1855 1856
        end

1857
        def add_association_callbacks(association_name, options)
1858 1859
          callbacks = %w(before_add after_add before_remove after_remove)
          callbacks.each do |callback_name|
1860
            full_callback_name = "#{callback_name}_for_#{association_name}"
1861 1862 1863
            defined_callbacks = options[callback_name.to_sym]
            if options.has_key?(callback_name.to_sym)
              class_inheritable_reader full_callback_name.to_sym
1864 1865 1866
              write_inheritable_attribute(full_callback_name.to_sym, [defined_callbacks].flatten)
            else
              write_inheritable_attribute(full_callback_name.to_sym, [])
1867 1868
            end
          end
1869
        end
1870

1871
        def create_extension_modules(association_id, block_extension, extensions)
1872
          if block_extension
1873
            extension_module_name = "#{self.to_s.demodulize}#{association_id.to_s.camelize}AssociationExtension"
1874

1875
            silence_warnings do
1876
              self.parent.const_set(extension_module_name, Module.new(&block_extension))
1877
            end
1878
            Array(extensions).push("#{self.parent}::#{extension_module_name}".constantize)
1879 1880
          else
            Array(extensions)
1881 1882
          end
        end
1883

D
David Heinemeier Hansson 已提交
1884
        class JoinDependency # :nodoc:
1885
          attr_reader :joins, :reflections, :table_aliases
1886

1887
          def initialize(base, associations, joins)
1888
            @joins                 = [JoinBase.new(base, joins)]
1889 1890 1891 1892
            @associations          = associations
            @reflections           = []
            @base_records_hash     = {}
            @base_records_in_order = []
1893 1894
            @table_aliases         = Hash.new { |aliases, table| aliases[table] = 0 }
            @table_aliases[base.table_name] = 1
1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911
            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
1912
              construct(@base_records_hash[primary_id], @associations, join_associations.dup, row)
1913
            end
1914
            remove_duplicate_results!(join_base.active_record, @base_records_in_order, @associations)
1915 1916 1917
            return @base_records_in_order
          end

1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933
          def remove_duplicate_results!(base, records, associations)
            case associations
              when Symbol, String
                reflection = base.reflections[associations]
                if reflection && [:has_many, :has_and_belongs_to_many].include?(reflection.macro)
                  records.each { |record| record.send(reflection.name).target.uniq! }
                end
              when Array
                associations.each do |association|
                  remove_duplicate_results!(base, records, association)
                end
              when Hash
                associations.keys.each do |name|
                  reflection = base.reflections[name]
                  is_collection = [:has_many, :has_and_belongs_to_many].include?(reflection.macro)

J
Jeremy Kemper 已提交
1934 1935 1936 1937 1938 1939 1940 1941 1942 1943
                  parent_records = []
                  records.each do |record|
                    if descendant = record.send(reflection.name)
                      if is_collection
                        parent_records.concat descendant.target.uniq
                      else
                        parent_records << descendant
                      end
                    end
                  end
1944

1945
                  remove_duplicate_results!(reflection.klass, parent_records, associations[name]) unless parent_records.empty?
1946 1947 1948 1949
                end
            end
          end

1950 1951 1952 1953 1954 1955 1956 1957
          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
1958
                  @joins << build_join_association(reflection, parent)
1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972
                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

1973 1974 1975 1976
            def build_join_association(reflection, parent)
              JoinAssociation.new(reflection, self, parent)
            end

1977 1978 1979
            def construct(parent, associations, joins, row)
              case associations
                when Symbol, String
1980 1981 1982 1983
                  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)
1984 1985 1986 1987 1988 1989 1990
                  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|
1991 1992 1993 1994 1995
                    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)
1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007
                    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
2008

2009 2010
                  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)
2011
                  collection.target.push(association)
2012
                  collection.__send__(:set_inverse_instance, association, record)
2013 2014
                when :has_one
                  return if record.id.to_s != join.parent.record_id(row).to_s
2015
                  return if record.instance_variable_defined?("@#{join.reflection.name}")
2016
                  association = join.instantiate(row) unless row[join.aliased_primary_key].nil?
2017
                  set_target_and_inverse(join, association, record)
2018
                when :belongs_to
2019 2020
                  return if record.id.to_s != join.parent.record_id(row).to_s or row[join.aliased_primary_key].nil?
                  association = join.instantiate(row)
2021
                  set_target_and_inverse(join, association, record)
2022 2023 2024 2025 2026 2027
                else
                  raise ConfigurationError, "unknown macro: #{join.reflection.macro}"
              end
              return association
            end

2028 2029 2030 2031 2032
            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 已提交
2033
          class JoinBase # :nodoc:
2034
            attr_reader :active_record, :table_joins
2035
            delegate    :table_name, :column_names, :primary_key, :reflections, :sanitize_sql, :to => :active_record
2036

2037
            def initialize(active_record, joins = nil)
2038 2039
              @active_record = active_record
              @cached_record = {}
2040
              @table_joins   = joins
2041 2042 2043 2044 2045 2046 2047
            end

            def aliased_prefix
              "t0"
            end

            def aliased_primary_key
2048
              "#{aliased_prefix}_r0"
2049 2050 2051 2052 2053 2054 2055
            end

            def aliased_table_name
              active_record.table_name
            end

            def column_names_with_alias
2056
              unless defined?(@column_names_with_alias)
2057
                @column_names_with_alias = []
2058

2059
                ([primary_key] + (column_names - [primary_key])).each_with_index do |column_name, i|
2060
                  @column_names_with_alias << [column_name, "#{aliased_prefix}_r#{i}"]
2061 2062
                end
              end
2063 2064

              @column_names_with_alias
2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075
            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)
2076
              @cached_record[record_id(row)] ||= active_record.send(:instantiate, extract_record(row))
2077 2078 2079
            end
          end

D
David Heinemeier Hansson 已提交
2080
          class JoinAssociation < JoinBase # :nodoc:
2081
            attr_reader :reflection, :parent, :aliased_table_name, :aliased_prefix, :aliased_join_table_name, :parent_table_name
2082
            delegate    :options, :klass, :through_reflection, :source_reflection, :to => :reflection
2083 2084

            def initialize(reflection, join_dependency, parent = nil)
2085 2086 2087 2088 2089
              reflection.check_validity!
              if reflection.options[:polymorphic]
                raise EagerLoadPolymorphicError.new(reflection)
              end

2090
              super(reflection.klass)
2091
              @join_dependency    = join_dependency
2092 2093 2094
              @parent             = parent
              @reflection         = reflection
              @aliased_prefix     = "t#{ join_dependency.joins.size }"
2095
              @parent_table_name  = parent.active_record.table_name
2096
              @aliased_table_name = aliased_table_name_for(table_name)
2097
              @join               = nil
2098

2099 2100
              if reflection.macro == :has_and_belongs_to_many
                @aliased_join_table_name = aliased_table_name_for(reflection.options[:join_table], "_join")
2101
              end
2102

2103
              if [:has_many, :has_one].include?(reflection.macro) && reflection.options[:through]
2104
                @aliased_join_table_name = aliased_table_name_for(reflection.through_reflection.klass.table_name, "_join")
2105
              end
2106 2107 2108
            end

            def association_join
2109
              return @join if @join
2110
              connection = reflection.active_record.connection
2111
              @join = case reflection.macro
2112
                when :has_and_belongs_to_many
2113
                  ["%s.%s = %s.%s " % [
2114
                     connection.quote_table_name(aliased_join_table_name),
2115
                     options[:foreign_key] || reflection.active_record.to_s.foreign_key,
2116
                     connection.quote_table_name(parent.aliased_table_name),
2117 2118
                     reflection.active_record.primary_key],
                  "%s.%s = %s.%s " % [
2119 2120
                     connection.quote_table_name(aliased_table_name),
                     klass.primary_key,
2121
                     connection.quote_table_name(aliased_join_table_name),
2122
                     options[:association_foreign_key] || klass.to_s.foreign_key
2123
                     ]
2124
                  ]
2125
                when :has_many, :has_one
E
Emilio Tagua 已提交
2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141
                  if reflection.options[:through]
                    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 = " AND %s.%s = %s" % [
                        connection.quote_table_name(aliased_join_table_name),
                        connection.quote_column_name(through_reflection.options[:as].to_s + '_type'),
                        klass.quote_value(parent.active_record.base_class.name)
                      ]
                    else
                      jt_foreign_key = through_reflection.primary_key_name
                    end

                    case source_reflection.macro
2142
                      when :has_many
2143 2144 2145
                        if source_reflection.options[:as]
                          first_key   = "#{source_reflection.options[:as]}_id"
                          second_key  = options[:foreign_key] || primary_key
2146
                          as_extra    = " AND %s.%s = %s" % [
2147 2148
                            connection.quote_table_name(aliased_table_name),
                            connection.quote_column_name("#{source_reflection.options[:as]}_type"),
2149
                            klass.quote_value(source_reflection.active_record.base_class.name)
2150 2151
                          ]
                        else
2152 2153 2154
                          first_key   = through_reflection.klass.base_class.to_s.foreign_key
                          second_key  = options[:foreign_key] || primary_key
                        end
2155

2156 2157
                        unless through_reflection.klass.descends_from_active_record?
                          jt_sti_extra = " AND %s.%s = %s" % [
2158 2159
                            connection.quote_table_name(aliased_join_table_name),
                            connection.quote_column_name(through_reflection.active_record.inheritance_column),
2160
                            through_reflection.klass.quote_value(through_reflection.klass.sti_name)]
2161 2162 2163 2164 2165 2166
                        end
                      when :belongs_to
                        first_key = primary_key
                        if reflection.options[:source_type]
                          second_key = source_reflection.association_foreign_key
                          jt_source_extra = " AND %s.%s = %s" % [
2167 2168
                            connection.quote_table_name(aliased_join_table_name),
                            connection.quote_column_name(reflection.source_reflection.options[:foreign_type]),
2169
                            klass.quote_value(reflection.options[:source_type])
2170
                          ]
2171
                        else
2172
                          second_key = source_reflection.primary_key_name
2173
                        end
E
Emilio Tagua 已提交
2174 2175
                    end

2176
                    ["(%s.%s = %s.%s%s%s%s) " % [
E
Emilio Tagua 已提交
2177 2178 2179 2180
                      connection.quote_table_name(parent.aliased_table_name),
                      connection.quote_column_name(parent.primary_key),
                      connection.quote_table_name(aliased_join_table_name),
                      connection.quote_column_name(jt_foreign_key),
2181 2182
                      jt_as_extra, jt_source_extra, jt_sti_extra],
                    "(%s.%s = %s.%s%s) " % [
E
Emilio Tagua 已提交
2183 2184 2185 2186
                      connection.quote_table_name(aliased_table_name),
                      connection.quote_column_name(first_key),
                      connection.quote_table_name(aliased_join_table_name),
                      connection.quote_column_name(second_key),
2187
                      as_extra]
E
Emilio Tagua 已提交
2188 2189
                    ]

2190
                 elsif reflection.options[:as]
2191
                    "%s.%s = %s.%s AND %s.%s = %s" % [
E
Emilio Tagua 已提交
2192 2193 2194 2195 2196 2197 2198 2199 2200 2201
                      connection.quote_table_name(aliased_table_name),
                      "#{reflection.options[:as]}_id",
                      connection.quote_table_name(parent.aliased_table_name),
                      parent.primary_key,
                      connection.quote_table_name(aliased_table_name),
                      "#{reflection.options[:as]}_type",
                      klass.quote_value(parent.active_record.base_class.name)
                    ]
                 else
                    foreign_key = options[:foreign_key] || reflection.active_record.name.foreign_key
2202
                    "%s.%s = %s.%s " % [
E
Emilio Tagua 已提交
2203 2204 2205 2206 2207
                      aliased_table_name,
                      foreign_key,
                      parent.aliased_table_name,
                      reflection.options[:primary_key] || parent.primary_key
                    ]
2208
                  end
2209
                when :belongs_to
2210 2211 2212 2213 2214 2215
                  "%s.%s = %s.%s " % [
                   connection.quote_table_name(aliased_table_name),
                   reflection.klass.primary_key,
                   connection.quote_table_name(parent.aliased_table_name),
                   options[:foreign_key] || reflection.primary_key_name
                  ]
E
Emilio Tagua 已提交
2216
              end
2217
              @join << %(AND %s) % [
2218
                klass.send(:type_condition, aliased_table_name)] unless klass.descends_from_active_record?
2219 2220

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

2224
              @join
2225
            end
2226

2227 2228 2229 2230 2231 2232 2233 2234 2235 2236
            def relation
              if reflection.macro == :has_and_belongs_to_many
                [Arel::Table.new(table_alias_for(options[:join_table], aliased_join_table_name)), Arel::Table.new(table_name_and_alias)]
              elsif reflection.options[:through]
                [Arel::Table.new(table_alias_for(through_reflection.klass.table_name, aliased_join_table_name)), Arel::Table.new(table_name_and_alias)]
              else
                Arel::Table.new(table_name_and_alias)
              end
            end

2237
            def join_relation(joining_relation, join = nil)
2238
              if (relations = relation).is_a?(Array)
2239
                joining_relation.
2240 2241
                  joins(relations.first, Arel::OuterJoin).on(association_join.first).
                  joins(relations.last, Arel::OuterJoin).on(association_join.last)
2242
              else
2243
                joining_relation.joins(relations, Arel::OuterJoin).on(association_join)
2244 2245 2246
              end
            end

2247
            protected
2248

2249
              def aliased_table_name_for(name, suffix = nil)
2250
                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}
2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265
                  @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
2266

2267 2268 2269
              def pluralize(table_name)
                ActiveRecord::Base.pluralize_table_names ? table_name.to_s.pluralize : table_name
              end
2270

2271
              def table_alias_for(table_name, table_alias)
2272
                 "#{table_name} #{table_alias if table_name != table_alias}".strip
2273 2274 2275 2276 2277
              end

              def table_name_and_alias
                table_alias_for table_name, @aliased_table_name
              end
2278 2279

              def interpolate_sql(sql)
2280 2281
                instance_eval("%@#{sql.gsub('@', '\@')}@")
              end
2282
          end
2283
        end
2284
    end
D
Initial  
David Heinemeier Hansson 已提交
2285
  end
2286
end