associations.rb 85.4 KB
Newer Older
1
require 'active_support/core_ext/array/wrap'
2
require 'active_support/core_ext/enumerable'
3
require 'active_support/core_ext/module/delegation'
4
require 'active_support/core_ext/object/blank'
5
require 'active_support/core_ext/string/conversions'
6
require 'active_support/core_ext/module/remove_method'
7
require 'active_support/core_ext/class/attribute'
J
Jeremy Kemper 已提交
8

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

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

22
  class HasManyThroughAssociationPolymorphicSourceError < ActiveRecordError #:nodoc:
23
    def initialize(owner_class_name, reflection, source_reflection)
24
      super("Cannot have a has_many :through association '#{owner_class_name}##{reflection.name}' on the polymorphic object '#{source_reflection.class_name}##{source_reflection.name}'.")
25 26
    end
  end
27

28 29 30 31 32 33
  class HasManyThroughAssociationPolymorphicThroughError < ActiveRecordError #:nodoc:
    def initialize(owner_class_name, reflection)
      super("Cannot have a has_many :through association '#{owner_class_name}##{reflection.name}' which goes through the polymorphic association '#{owner_class_name}##{reflection.through_reflection.name}'.")
    end
  end

34 35
  class HasManyThroughAssociationPointlessSourceTypeError < ActiveRecordError #:nodoc:
    def initialize(owner_class_name, reflection, source_reflection)
S
Sebastian Martinez 已提交
36
      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.")
37 38
    end
  end
39

40 41 42 43 44 45
  class HasOneThroughCantAssociateThroughCollection < ActiveRecordError #:nodoc:
    def initialize(owner_class_name, reflection, through_reflection)
      super("Cannot have a has_one :through association '#{owner_class_name}##{reflection.name}' where the :through association '#{owner_class_name}##{through_reflection.name}' is a collection. Specify a has_one or belongs_to association in the :through option instead.")
    end
  end

D
David Heinemeier Hansson 已提交
46
  class HasManyThroughSourceAssociationNotFoundError < ActiveRecordError #:nodoc:
47
    def initialize(reflection)
48 49 50
      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 }
S
Sebastian Martinez 已提交
51
      super("Could not find the source association(s) #{source_reflection_names.collect{ |a| a.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)}?")
52 53 54
    end
  end

55
  class HasManyThroughCantAssociateThroughHasOneOrManyReflection < ActiveRecordError #:nodoc:
56 57 58 59
    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
60

61 62 63 64 65 66
  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

67 68 69 70 71
  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
J
Jon Leighton 已提交
72

73 74 75 76 77
  class HasManyThroughNestedAssociationsAreReadonly < ActiveRecordError #:nodoc
    def initialize(owner, reflection)
      super("Cannot modify association '#{owner.class.name}##{reflection.name}' because it goes through more than one other association.")
    end
  end
78

79 80 81 82 83 84
  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 已提交
85
  class EagerLoadPolymorphicError < ActiveRecordError #:nodoc:
86
    def initialize(reflection)
87
      super("Can not eagerly load the polymorphic association #{reflection.name.inspect}")
88 89 90
    end
  end

91 92
  class ReadOnlyAssociation < ActiveRecordError #:nodoc:
    def initialize(reflection)
S
Sebastian Martinez 已提交
93
      super("Can not add to a has_many :through association. Try adding to #{reflection.through_reflection.name.inspect}.")
94 95 96
    end
  end

97
  # This error is raised when trying to destroy a parent instance in N:1 or 1:1 associations
98
  # (has_many, has_one) when there is at least 1 child associated instance.
99 100
  # ex: if @project.tasks.size > 0, DeleteRestrictionError will be raised when trying to destroy @project
  class DeleteRestrictionError < ActiveRecordError #:nodoc:
101 102
    def initialize(name)
      super("Cannot delete record because of dependent #{name}")
103 104 105
    end
  end

P
Pratik Naik 已提交
106
  # See ActiveRecord::Associations::ClassMethods for documentation.
D
Initial  
David Heinemeier Hansson 已提交
107
  module Associations # :nodoc:
108
    extend ActiveSupport::Concern
109

110
    # These classes will be loaded when associations are created.
J
Joshua Peek 已提交
111
    # So there is no need to eager load them.
112 113 114 115 116 117
    autoload :Association,           'active_record/associations/association'
    autoload :SingularAssociation,   'active_record/associations/singular_association'
    autoload :CollectionAssociation, 'active_record/associations/collection_association'
    autoload :CollectionProxy,       'active_record/associations/collection_proxy'

    autoload :BelongsToAssociation,            'active_record/associations/belongs_to_association'
J
Joshua Peek 已提交
118
    autoload :BelongsToPolymorphicAssociation, 'active_record/associations/belongs_to_polymorphic_association'
119 120 121 122 123 124
    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'
    autoload :ThroughAssociation,              'active_record/associations/through_association'
J
Joshua Peek 已提交
125

126 127 128 129 130 131 132 133 134 135 136
    module Builder #:nodoc:
      autoload :Association,           'active_record/associations/builder/association'
      autoload :SingularAssociation,   'active_record/associations/builder/singular_association'
      autoload :CollectionAssociation, 'active_record/associations/builder/collection_association'

      autoload :BelongsTo,           'active_record/associations/builder/belongs_to'
      autoload :HasOne,              'active_record/associations/builder/has_one'
      autoload :HasMany,             'active_record/associations/builder/has_many'
      autoload :HasAndBelongsToMany, 'active_record/associations/builder/has_and_belongs_to_many'
    end

137 138 139 140
    autoload :Preloader,        'active_record/associations/preloader'
    autoload :JoinDependency,   'active_record/associations/join_dependency'
    autoload :AssociationScope, 'active_record/associations/association_scope'
    autoload :AliasTracker,     'active_record/associations/alias_tracker'
141
    autoload :JoinHelper,       'active_record/associations/join_helper'
J
Joshua Peek 已提交
142

143
    # Clears out the association cache.
144
    def clear_association_cache #:nodoc:
145
      @association_cache.clear if persisted?
146
    end
147

148 149 150
    # :nodoc:
    attr_reader :association_cache

151 152 153
    # Returns the association instance for the given name, instantiating it if it doesn't already exist
    def association(name) #:nodoc:
      association = association_instance_get(name)
154

155 156 157 158
      if association.nil?
        reflection  = self.class.reflect_on_association(name)
        association = reflection.association_class.new(self, reflection)
        association_instance_set(name, association)
159 160
      end

161
      association
162
    end
163

164
    private
165
      # Returns the specified association instance if it responds to :loaded?, nil otherwise.
166
      def association_instance_get(name)
167
        @association_cache[name.to_sym]
168 169 170 171
      end

      # Set the specified association instance.
      def association_instance_set(name, association)
172
        @association_cache[name] = association
173 174
      end

175 176 177 178
    # 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
179
    # options hash. It works much the same way as Ruby's own <tt>attr*</tt>
180
    # methods.
D
Initial  
David Heinemeier Hansson 已提交
181 182 183
    #
    #   class Project < ActiveRecord::Base
    #     belongs_to              :portfolio
184
    #     has_one                 :project_manager
D
Initial  
David Heinemeier Hansson 已提交
185 186 187 188
    #     has_many                :milestones
    #     has_and_belongs_to_many :categories
    #   end
    #
189
    # The project class now has the following methods (and more) to ease the traversal and
190
    # manipulation of its relationships:
191
    # * <tt>Project#portfolio, Project#portfolio=(portfolio), Project#portfolio.nil?</tt>
D
Initial  
David Heinemeier Hansson 已提交
192 193
    # * <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>
A
Akira Matsuda 已提交
194
    #   <tt>Project#milestones.delete(milestone), Project#milestones.find(milestone_id), Project#milestones.all(options),</tt>
D
Initial  
David Heinemeier Hansson 已提交
195 196 197 198
    #   <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>
    #
199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215
    # === Overriding generated methods
    #
    # Association methods are generated in a module that is included into the model class,
    # which allows you to easily override with your own methods and call the original
    # generated method with +super+. For example:
    #
    #   class Car < ActiveRecord::Base
    #     belongs_to :owner
    #     belongs_to :old_owner
    #     def owner=(new_owner)
    #       self.old_owner = self.owner
    #       super
    #     end
    #   end
    #
    # If your model class is <tt>Project</tt>, the module is
    # named <tt>Project::GeneratedFeatureMethods</tt>. The GeneratedFeatureMethods module is
V
Vijay Dev 已提交
216
    # included in the model class immediately after the (anonymous) generated attributes methods
217 218
    # module, meaning an association will override the methods for an attribute with the same name.
    #
219 220
    # === A word of warning
    #
221 222
    # Don't create associations that have the same name as instance methods of
    # <tt>ActiveRecord::Base</tt>. Since the association adds a method with that name to
223
    # its model, it will override the inherited method and break things.
P
Pratik Naik 已提交
224
    # For instance, +attributes+ and +connection+ would be bad choices for association names.
225
    #
226
    # == Auto-generated methods
D
Initial  
David Heinemeier Hansson 已提交
227
    #
228
    # === Singular associations (one-to-one)
229 230 231
    #                                     |            |  belongs_to  |
    #   generated methods                 | belongs_to | :polymorphic | has_one
    #   ----------------------------------+------------+--------------+---------
P
Pratik Naik 已提交
232 233 234 235
    #   other                             |     X      |      X       |    X
    #   other=(other)                     |     X      |      X       |    X
    #   build_other(attributes={})        |     X      |              |    X
    #   create_other(attributes={})       |     X      |              |    X
236
    #   create_other!(attributes={})      |     X      |              |    X
237 238 239
    #
    # ===Collection associations (one-to-many / many-to-many)
    #                                     |       |          | has_many
240
    #   generated methods                 | habtm | has_many | :through
241
    #   ----------------------------------+-------+----------+----------
P
Pratik Naik 已提交
242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258
    #   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
259
    #   others.delete_all                 |   X   |    X     |    X
P
Pratik Naik 已提交
260 261 262 263 264
    #   others.destroy_all                |   X   |    X     |    X
    #   others.find(*args)                |   X   |    X     |    X
    #   others.exists?                    |   X   |    X     |    X
    #   others.uniq                       |   X   |    X     |    X
    #   others.reset                      |   X   |    X     |    X
D
Initial  
David Heinemeier Hansson 已提交
265
    #
266
    # == Cardinality and associations
267
    #
P
Pratik Naik 已提交
268
    # Active Record associations can be used to describe one-to-one, one-to-many and many-to-many
P
Pratik Naik 已提交
269 270
    # 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
271
    # the foreign key.
272 273 274
    #
    # === One-to-one
    #
275
    # Use +has_one+ in the base, and +belongs_to+ in the associated model.
276 277 278 279 280 281 282 283 284 285
    #
    #   class Employee < ActiveRecord::Base
    #     has_one :office
    #   end
    #   class Office < ActiveRecord::Base
    #     belongs_to :employee    # foreign key - employee_id
    #   end
    #
    # === One-to-many
    #
286
    # Use +has_many+ in the base, and +belongs_to+ in the associated model.
287 288 289 290 291
    #
    #   class Manager < ActiveRecord::Base
    #     has_many :employees
    #   end
    #   class Employee < ActiveRecord::Base
292
    #     belongs_to :manager     # foreign key - manager_id
293 294 295 296 297 298
    #   end
    #
    # === Many-to-many
    #
    # There are two ways to build a many-to-many relationship.
    #
299
    # The first way uses a +has_many+ association with the <tt>:through</tt> option and a join model, so
300 301 302 303 304 305 306 307 308 309 310 311 312 313 314
    # 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
    #
315
    # For the second way, use +has_and_belongs_to_many+ in both models. This requires a join table
316 317 318 319 320 321 322 323 324
    # 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
    #
325
    # Choosing which way to build a many-to-many relationship is not always simple.
326
    # If you need to work with the relationship model as its own entity,
327
    # use <tt>has_many :through</tt>. Use +has_and_belongs_to_many+ when working with legacy schemas or when
328 329
    # you never work directly with the relationship itself.
    #
330
    # == Is it a +belongs_to+ or +has_one+ association?
D
Initial  
David Heinemeier Hansson 已提交
331
    #
332
    # Both express a 1-1 relationship. The difference is mostly where to place the foreign
333
    # key, which goes on the table for the class declaring the +belongs_to+ relationship.
D
Initial  
David Heinemeier Hansson 已提交
334
    #
335 336 337
    #   class User < ActiveRecord::Base
    #     # I reference an account.
    #     belongs_to :account
D
Initial  
David Heinemeier Hansson 已提交
338 339
    #   end
    #
340 341 342
    #   class Account < ActiveRecord::Base
    #     # One user references me.
    #     has_one :user
D
Initial  
David Heinemeier Hansson 已提交
343 344 345 346
    #   end
    #
    # The tables for these classes could look something like:
    #
347
    #   CREATE TABLE users (
D
Initial  
David Heinemeier Hansson 已提交
348
    #     id int(11) NOT NULL auto_increment,
349 350
    #     account_id int(11) default NULL,
    #     name varchar default NULL,
D
Initial  
David Heinemeier Hansson 已提交
351 352 353
    #     PRIMARY KEY  (id)
    #   )
    #
354
    #   CREATE TABLE accounts (
D
Initial  
David Heinemeier Hansson 已提交
355 356 357 358 359
    #     id int(11) NOT NULL auto_increment,
    #     name varchar default NULL,
    #     PRIMARY KEY  (id)
    #   )
    #
360 361
    # == Unsaved objects and associations
    #
362 363
    # You can manipulate objects and associations before they are saved to the database, but
    # there is some special behavior you should be aware of, mostly involving the saving of
364
    # associated objects.
365
    #
366
    # You can set the :autosave option on a <tt>has_one</tt>, <tt>belongs_to</tt>,
367 368
    # <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
369
    # _never_ save the members. More details about :autosave option is available at
370
    # autosave_association.rb .
371
    #
372 373
    # === One-to-one associations
    #
374
    # * Assigning an object to a +has_one+ association automatically saves that object and
375
    #   the object being replaced (if there is one), in order to update their foreign
376
    #   keys - except if the parent object is unsaved (<tt>new_record? == true</tt>).
377 378 379
    # * If either of these saves fail (due to one of the objects being invalid), an
    #   <tt>ActiveRecord::RecordNotSaved</tt> exception is raised and the assignment is
    #   cancelled.
380
    # * If you wish to assign an object to a +has_one+ association without saving it,
381 382
    #   use the <tt>build_association</tt> method (documented below). The object being
    #   replaced will still be saved to update its foreign key.
383
    # * Assigning an object to a +belongs_to+ association does not save the object, since
384
    #   the foreign key field belongs on the parent. It does not save the parent either.
385 386 387
    #
    # === Collections
    #
388
    # * Adding an object to a collection (+has_many+ or +has_and_belongs_to_many+) automatically
389 390
    #   saves that object, except if the parent object (the owner of the collection) is not yet
    #   stored in the database.
391
    # * If saving any of the objects being added to a collection (via <tt>push</tt> or similar)
392
    #   fails, then <tt>push</tt> returns +false+.
393 394 395
    # * If saving fails while replacing the collection (via <tt>association=</tt>), an
    #   <tt>ActiveRecord::RecordNotSaved</tt> exception is raised and the assignment is
    #   cancelled.
396
    # * You can add an object to a collection without automatically saving it by using the
397
    #   <tt>collection.build</tt> method (documented below).
398
    # * All unsaved (<tt>new_record? == true</tt>) members of the collection are automatically
399
    #   saved when the parent is saved.
400
    #
401
    # === Association callbacks
402
    #
403
    # Similar to the normal callbacks that hook into the life cycle of an Active Record object,
404
    # you can also define callbacks that get triggered when you add an object to or remove an
405
    # object from an association collection.
406 407 408 409 410 411 412
    #
    #   class Project
    #     has_and_belongs_to_many :developers, :after_add => :evaluate_velocity
    #
    #     def evaluate_velocity(developer)
    #       ...
    #     end
413
    #   end
414 415
    #
    # It's possible to stack callbacks by passing them as an array. Example:
416
    #
417
    #   class Project
418
    #     has_and_belongs_to_many :developers,
419
    #                             :after_add => [:evaluate_velocity, Proc.new { |p, d| p.shipping_date = Time.now}]
420 421
    #   end
    #
422
    # Possible callbacks are: +before_add+, +after_add+, +before_remove+ and +after_remove+.
423
    #
424 425
    # 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
426
    # thrown the object doesn't get removed.
427
    #
428 429
    # === Association extensions
    #
430 431
    # The proxy objects that control the access to associations can be extended through anonymous
    # modules. This is especially beneficial for adding new finders, creators, and other
432
    # factory-type methods that are only used as part of this association.
433 434
    #
    #   class Account < ActiveRecord::Base
435
    #     has_many :people do
436
    #       def find_or_create_by_name(name)
437
    #         first_name, last_name = name.split(" ", 2)
D
David Heinemeier Hansson 已提交
438
    #         find_or_create_by_first_name_and_last_name(first_name, last_name)
439
    #       end
440
    #     end
441 442
    #   end
    #
A
Akira Matsuda 已提交
443
    #   person = Account.first.people.find_or_create_by_name("David Heinemeier Hansson")
444 445 446
    #   person.first_name # => "David"
    #   person.last_name  # => "Heinemeier Hansson"
    #
447 448
    # If you need to share the same extensions between many associations, you can use a named
    # extension module.
449 450 451
    #
    #   module FindOrCreateByNameExtension
    #     def find_or_create_by_name(name)
452
    #       first_name, last_name = name.split(" ", 2)
D
David Heinemeier Hansson 已提交
453
    #       find_or_create_by_first_name_and_last_name(first_name, last_name)
454 455 456 457 458 459 460 461 462 463
    #     end
    #   end
    #
    #   class Account < ActiveRecord::Base
    #     has_many :people, :extend => FindOrCreateByNameExtension
    #   end
    #
    #   class Company < ActiveRecord::Base
    #     has_many :people, :extend => FindOrCreateByNameExtension
    #   end
464
    #
465
    # If you need to use multiple named extension modules, you can specify an array of modules
466
    # with the <tt>:extend</tt> option.
467 468
    # In the case of name conflicts between methods in the modules, methods in modules later
    # in the array supercede those earlier in the array.
469 470 471 472 473
    #
    #   class Account < ActiveRecord::Base
    #     has_many :people, :extend => [FindOrCreateByNameExtension, FindRecentExtension]
    #   end
    #
474
    # Some extensions can only be made to work with knowledge of the association's internals.
475
    # Extensions can access relevant state using the following methods (where +items+ is the
476
    # name of the association):
477
    #
478 479 480
    # * <tt>record.association(:items).owner</tt> - Returns the object the association is part of.
    # * <tt>record.association(:items).reflection</tt> - Returns the reflection object that describes the association.
    # * <tt>record.association(:items).target</tt> - Returns the associated object for +belongs_to+ and +has_one+, or
481
    #   the collection of associated objects for +has_many+ and +has_and_belongs_to_many+.
482
    #
483 484 485 486 487 488
    # However, inside the actual extension code, you will not have access to the <tt>record</tt> as
    # above. In this case, you can access <tt>proxy_association</tt>. For example,
    # <tt>record.association(:items)</tt> and <tt>record.items.proxy_association</tt> will return
    # the same object, allowing you to make calls like <tt>proxy_association.owner</tt> inside
    # association extensions.
    #
R
Rick Olson 已提交
489
    # === Association Join Models
490
    #
491
    # Has Many associations can be configured with the <tt>:through</tt> option to use an
S
Sebastian Martinez 已提交
492 493 494
    # 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,
    # callbacks, and extra attributes on the join model. Consider the following schema:
495
    #
496 497 498 499
    #   class Author < ActiveRecord::Base
    #     has_many :authorships
    #     has_many :books, :through => :authorships
    #   end
500
    #
501 502 503 504
    #   class Authorship < ActiveRecord::Base
    #     belongs_to :author
    #     belongs_to :book
    #   end
505
    #
A
Akira Matsuda 已提交
506
    #   @author = Author.first
507
    #   @author.authorships.collect { |a| a.book } # selects all books that the author's authorships belong to
508
    #   @author.books                              # selects all books by using the Authorship join model
509
    #
510
    # You can also go through a +has_many+ association on the join model:
511
    #
512 513 514 515
    #   class Firm < ActiveRecord::Base
    #     has_many   :clients
    #     has_many   :invoices, :through => :clients
    #   end
516
    #
517 518 519 520
    #   class Client < ActiveRecord::Base
    #     belongs_to :firm
    #     has_many   :invoices
    #   end
521
    #
522 523 524 525
    #   class Invoice < ActiveRecord::Base
    #     belongs_to :client
    #   end
    #
A
Akira Matsuda 已提交
526
    #   @firm = Firm.first
527
    #   @firm.clients.collect { |c| c.invoices }.flatten # select all invoices for all clients of the firm
528
    #   @firm.invoices                                   # selects all invoices by going through the Client join model
529
    #
530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549
    # 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.
    #
550
    # An important caveat with going through +has_one+ or +has_many+ associations on the
S
Sebastian Martinez 已提交
551
    # join model is that these associations are *read-only*. For example, the following
552
    # would not work following the previous example:
553
    #
554
    #   @group.avatars << Avatar.new   # this would work if User belonged_to Avatar rather than the other way around
555 556
    #   @group.avatars.delete(@group.avatars.last)  # so would this
    #
557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572
    # If you are using a +belongs_to+ on the join model, it is a good idea to set the
    # <tt>:inverse_of</tt> option on the +belongs_to+, which will mean that the following example
    # works correctly (where <tt>tags</tt> is a +has_many+ <tt>:through</tt> association):
    #
    #   @post = Post.first
    #   @tag = @post.tags.build :name => "ruby"
    #   @tag.save
    #
    # The last line ought to save the through record (a <tt>Taggable</tt>). This will only work if the
    # <tt>:inverse_of</tt> is set:
    #
    #   class Taggable < ActiveRecord::Base
    #     belongs_to :post
    #     belongs_to :tag, :inverse_of => :taggings
    #   end
    #
573
    # === Nested Associations
J
Jon Leighton 已提交
574
    #
575 576 577 578 579 580 581 582
    # You can actually specify *any* association with the <tt>:through</tt> option, including an
    # association which has a <tt>:through</tt> option itself. For example:
    #
    #   class Author < ActiveRecord::Base
    #     has_many :posts
    #     has_many :comments, :through => :posts
    #     has_many :commenters, :through => :comments
    #   end
J
Jon Leighton 已提交
583
    #
584 585 586
    #   class Post < ActiveRecord::Base
    #     has_many :comments
    #   end
J
Jon Leighton 已提交
587
    #
588 589 590
    #   class Comment < ActiveRecord::Base
    #     belongs_to :commenter
    #   end
J
Jon Leighton 已提交
591
    #
592 593 594 595 596 597 598 599 600
    #   @author = Author.first
    #   @author.commenters # => People who commented on posts written by the author
    #
    # An equivalent way of setting up this association this would be:
    #
    #   class Author < ActiveRecord::Base
    #     has_many :posts
    #     has_many :commenters, :through => :posts
    #   end
J
Jon Leighton 已提交
601
    #
602 603 604 605
    #   class Post < ActiveRecord::Base
    #     has_many :comments
    #     has_many :commenters, :through => :comments
    #   end
J
Jon Leighton 已提交
606
    #
607 608 609 610 611
    #   class Comment < ActiveRecord::Base
    #     belongs_to :commenter
    #   end
    #
    # When using nested association, you will not be able to modify the association because there
J
Jon Leighton 已提交
612
    # is not enough information to know what modification to make. For example, if you tried to
J
Jon Leighton 已提交
613
    # add a <tt>Commenter</tt> in the example above, there would be no way to tell how to set up the
614 615
    # intermediate <tt>Post</tt> and <tt>Comment</tt> objects.
    #
R
Rick Olson 已提交
616
    # === Polymorphic Associations
617
    #
618
    # Polymorphic associations on models are not restricted on what types of models they
S
Sebastian Martinez 已提交
619
    # can be associated with. Rather, they specify an interface that a +has_many+ association
620
    # must adhere to.
621
    #
R
Rick Olson 已提交
622 623 624
    #   class Asset < ActiveRecord::Base
    #     belongs_to :attachable, :polymorphic => true
    #   end
625
    #
R
Rick Olson 已提交
626
    #   class Post < ActiveRecord::Base
627
    #     has_many :assets, :as => :attachable         # The :as option specifies the polymorphic interface to use.
R
Rick Olson 已提交
628 629 630
    #   end
    #
    #   @asset.attachable = @post
631
    #
632
    # This works by using a type column in addition to a foreign key to specify the associated
S
Sebastian Martinez 已提交
633
    # record. In the Asset example, you'd need an +attachable_id+ integer column and an
634
    # +attachable_type+ string column.
R
Rick Olson 已提交
635
    #
636 637 638
    # Using polymorphic associations in combination with single table inheritance (STI) is
    # a little tricky. In order for the associations to work as expected, ensure that you
    # store the base model for the STI models in the type column of the polymorphic
639
    # association. To continue with the asset example above, suppose there are guest posts
640
    # and member posts that use the posts table for STI. In this case, there must be a +type+
641
    # column in the posts table.
D
David Heinemeier Hansson 已提交
642 643 644
    #
    #   class Asset < ActiveRecord::Base
    #     belongs_to :attachable, :polymorphic => true
645
    #
D
David Heinemeier Hansson 已提交
646 647 648 649
    #     def attachable_type=(sType)
    #        super(sType.to_s.classify.constantize.base_class.to_s)
    #     end
    #   end
650
    #
D
David Heinemeier Hansson 已提交
651 652 653 654 655
    #   class Post < ActiveRecord::Base
    #     # because we store "Post" in attachable_type now :dependent => :destroy will work
    #     has_many :assets, :as => :attachable, :dependent => :destroy
    #   end
    #
656
    #   class GuestPost < Post
D
David Heinemeier Hansson 已提交
657 658
    #   end
    #
659
    #   class MemberPost < Post
D
David Heinemeier Hansson 已提交
660 661
    #   end
    #
D
Initial  
David Heinemeier Hansson 已提交
662 663
    # == Caching
    #
664 665
    # All of the methods are built on a simple caching principle that will keep the result
    # of the last query around unless specifically instructed not to. The cache is even
666 667
    # shared across methods to make it even cheaper to use the macro-added methods without
    # worrying too much about performance at the first go.
D
Initial  
David Heinemeier Hansson 已提交
668 669 670 671 672 673 674
    #
    #   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
    #
675 676
    # == Eager loading of associations
    #
677 678 679
    # Eager loading is a way to find objects of a certain class and a number of named associations.
    # This is 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 triggers 101 database queries. Through the
680
    # use of eager loading, the 101 queries can be reduced to 2.
681 682 683 684 685 686 687 688
    #
    #   class Post < ActiveRecord::Base
    #     belongs_to :author
    #     has_many   :comments
    #   end
    #
    # Consider the following loop using the class above:
    #
689
    #   Post.all.each do |post|
690 691 692
    #     puts "Post:            " + post.title
    #     puts "Written by:      " + post.author.name
    #     puts "Last comment on: " + post.comments.first.created_on
693
    #   end
694
    #
695
    # To iterate over these one hundred posts, we'll generate 201 database queries. Let's
696
    # first just optimize it for retrieving the author:
697
    #
A
Akira Matsuda 已提交
698
    #   Post.includes(:author).each do |post|
699
    #
700 701 702
    # 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
703
    # from 201 to 102.
704 705 706
    #
    # We can improve upon the situation further by referencing both associations in the finder with:
    #
A
Akira Matsuda 已提交
707
    #   Post.includes(:author, :comments).each do |post|
708
    #
709 710
    # 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
711
    # named (except if some of the associations are polymorphic +belongs_to+ - see below).
712
    #
713
    # To include a deep hierarchy of associations, use a hash:
714
    #
A
Akira Matsuda 已提交
715
    #   Post.includes(:author, {:comments => {:author => :gravatar}}).each do |post|
716
    #
717 718
    # 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
719
    # associations you want to load.
720
    #
721 722 723 724
    # 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 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
725
    # cut down on the number of queries in a situation as the one described above.
726
    #
727 728
    # 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
729
    # used LEFT OUTER JOIN based strategy. For example
730
    #
E
Emilio Tagua 已提交
731
    #   Post.includes([:author, :comments]).where(['comments.approved = ?', true]).all
732
    #
733
    # This will result in a single SQL query with joins along the lines of:
734
    # <tt>LEFT OUTER JOIN comments ON comments.post_id = posts.id</tt> and
735
    # <tt>LEFT OUTER JOIN authors ON authors.id = posts.author_id</tt>. Note that using conditions
736
    # like this can have unintended consequences.
737 738
    # 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.
739
    # You must disambiguate column references for this fallback to happen, for example
740
    # <tt>:order => "author.name DESC"</tt> will work but <tt>:order => "name DESC"</tt> will not.
P
Pratik Naik 已提交
741
    #
742
    # If you do want eager load only some members of an association it is usually more natural
A
Akira Matsuda 已提交
743
    # to include an association which has conditions defined on it:
P
Pratik Naik 已提交
744 745 746 747 748
    #
    #   class Post < ActiveRecord::Base
    #     has_many :approved_comments, :class_name => 'Comment', :conditions => ['approved = ?', true]
    #   end
    #
A
Akira Matsuda 已提交
749
    #   Post.includes(:approved_comments)
P
Pratik Naik 已提交
750
    #
751
    # This will load posts and eager load the +approved_comments+ association, which contains
752
    # only those comments that have been approved.
753
    #
754
    # If you eager load an association with a specified <tt>:limit</tt> option, it will be ignored,
755
    # returning all the associated objects:
756 757 758 759 760
    #
    #   class Picture < ActiveRecord::Base
    #     has_many :most_recent_comments, :class_name => 'Comment', :order => 'id DESC', :limit => 10
    #   end
    #
A
Akira Matsuda 已提交
761
    #   Picture.includes(:most_recent_comments).first.most_recent_comments # => returns all associated comments.
762
    #
763
    # When eager loaded, conditions are interpolated in the context of the model class, not
S
Sebastian Martinez 已提交
764
    # the model instance. Conditions are lazily interpolated before the actual model exists.
765
    #
P
Pratik Naik 已提交
766
    # Eager loading is supported with polymorphic associations.
767 768 769 770 771
    #
    #   class Address < ActiveRecord::Base
    #     belongs_to :addressable, :polymorphic => true
    #   end
    #
P
Pratik Naik 已提交
772
    # A call that tries to eager load the addressable model
773
    #
A
Akira Matsuda 已提交
774
    #   Address.includes(:addressable)
775
    #
776
    # This will execute one query to load the addresses and load the addressables with one
777
    # query per addressable type.
778 779
    # 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
780
    # the back of the addresses loaded. This is not supported if Active Record has to fallback
781 782
    # to the previous implementation of eager loading and will raise ActiveRecord::EagerLoadPolymorphicError.
    # The reason is that the parent model's type is a column value so its corresponding table
783
    # name cannot be put in the +FROM+/+JOIN+ clauses of that query.
784
    #
785 786
    # == Table Aliasing
    #
787
    # Active Record uses table aliasing in the case that a table is referenced multiple times
S
Sebastian Martinez 已提交
788
    # in a join. If a table is referenced only once, the standard table name is used. The
789
    # second time, the table is aliased as <tt>#{reflection_name}_#{parent_table_name}</tt>.
790
    # Indexes are appended for any more successive uses of the table name.
791
    #
A
Akira Matsuda 已提交
792
    #   Post.joins(:comments)
P
Pratik Naik 已提交
793
    #   # => SELECT ... FROM posts INNER JOIN comments ON ...
A
Akira Matsuda 已提交
794
    #   Post.joins(:special_comments) # STI
P
Pratik Naik 已提交
795
    #   # => SELECT ... FROM posts INNER JOIN comments ON ... AND comments.type = 'SpecialComment'
A
Akira Matsuda 已提交
796
    #   Post.joins(:comments, :special_comments) # special_comments is the reflection name, posts is the parent table name
P
Pratik Naik 已提交
797
    #   # => SELECT ... FROM posts INNER JOIN comments ON ... INNER JOIN comments special_comments_posts
798
    #
799
    # Acts as tree example:
800
    #
A
Akira Matsuda 已提交
801
    #   TreeMixin.joins(:children)
P
Pratik Naik 已提交
802
    #   # => SELECT ... FROM mixins INNER JOIN mixins childrens_mixins ...
A
Akira Matsuda 已提交
803
    #   TreeMixin.joins(:children => :parent)
P
Pratik Naik 已提交
804 805
    #   # => SELECT ... FROM mixins INNER JOIN mixins childrens_mixins ...
    #                               INNER JOIN parents_mixins ...
A
Akira Matsuda 已提交
806
    #   TreeMixin.joins(:children => {:parent => :children})
P
Pratik Naik 已提交
807 808 809
    #   # => SELECT ... FROM mixins INNER JOIN mixins childrens_mixins ...
    #                               INNER JOIN parents_mixins ...
    #                               INNER JOIN mixins childrens_mixins_2
810
    #
811
    # Has and Belongs to Many join tables use the same idea, but add a <tt>_join</tt> suffix:
812
    #
A
Akira Matsuda 已提交
813
    #   Post.joins(:categories)
P
Pratik Naik 已提交
814
    #   # => SELECT ... FROM posts INNER JOIN categories_posts ... INNER JOIN categories ...
A
Akira Matsuda 已提交
815
    #   Post.joins(:categories => :posts)
P
Pratik Naik 已提交
816 817
    #   # => SELECT ... FROM posts INNER JOIN categories_posts ... INNER JOIN categories ...
    #                              INNER JOIN categories_posts posts_categories_join INNER JOIN posts posts_categories
A
Akira Matsuda 已提交
818
    #   Post.joins(:categories => {:posts => :categories})
P
Pratik Naik 已提交
819 820 821
    #   # => 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
822
    #
A
Akira Matsuda 已提交
823
    # If you wish to specify your own custom joins using <tt>joins</tt> method, those table
824
    # names will take precedence over the eager associations:
825
    #
A
Akira Matsuda 已提交
826
    #   Post.joins(:comments).joins("inner join comments ...")
P
Pratik Naik 已提交
827
    #   # => SELECT ... FROM posts INNER JOIN comments_posts ON ... INNER JOIN comments ...
A
Akira Matsuda 已提交
828
    #   Post.joins(:comments, :special_comments).joins("inner join comments ...")
P
Pratik Naik 已提交
829 830
    #   # => SELECT ... FROM posts INNER JOIN comments comments_posts ON ...
    #                              INNER JOIN comments special_comments_posts ...
831
    #                              INNER JOIN comments ...
832
    #
833
    # Table aliases are automatically truncated according to the maximum length of table identifiers
834
    # according to the specific database.
835
    #
D
Initial  
David Heinemeier Hansson 已提交
836 837 838 839 840 841 842 843 844 845
    # == 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 已提交
846
    #       class Client < ActiveRecord::Base; end
D
Initial  
David Heinemeier Hansson 已提交
847 848 849
    #     end
    #   end
    #
850
    # When <tt>Firm#clients</tt> is called, it will in turn call
851
    # <tt>MyApplication::Business::Client.find_all_by_firm_id(firm.id)</tt>.
852
    # If you want to associate with a class in another module scope, this can be done by
853
    # specifying the complete class name.
D
Initial  
David Heinemeier Hansson 已提交
854 855 856 857 858 859 860 861 862 863 864 865 866
    #
    #   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 已提交
867 868
    # == Bi-directional associations
    #
869
    # When you specify an association there is usually an association on the associated model
S
Sebastian Martinez 已提交
870
    # that specifies the same relationship in reverse. For example, with the following models:
P
Pratik Naik 已提交
871 872 873 874 875 876 877 878 879 880 881 882 883 884
    #
    #    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
    #
885
    # The +traps+ association on +Dungeon+ and the +dungeon+ association on +Trap+ are
886
    # the inverse of each other and the inverse of the +dungeon+ association on +EvilWizard+
S
Sebastian Martinez 已提交
887
    # is the +evil_wizard+ association on +Dungeon+ (and vice-versa). By default,
888
    # Active Record doesn't know anything about these inverse relationships and so no object
889
    # loading optimization is possible. For example:
P
Pratik Naik 已提交
890 891 892 893 894 895 896
    #
    #    d = Dungeon.first
    #    t = d.traps.first
    #    d.level == t.dungeon.level # => true
    #    d.level = 10
    #    d.level == t.dungeon.level # => false
    #
897 898
    # The +Dungeon+ instances +d+ and <tt>t.dungeon</tt> in the above example refer to
    # the same object data from the database, but are actually different in-memory copies
S
Sebastian Martinez 已提交
899 900
    # of that data. Specifying the <tt>:inverse_of</tt> option on associations lets you tell
    # Active Record about inverse relationships and it will optimise object loading. For
901
    # example, if we changed our model definitions to:
P
Pratik Naik 已提交
902 903 904 905 906 907 908 909 910 911 912 913 914 915
    #
    #    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
    #
916
    # Then, from our code snippet above, +d+ and <tt>t.dungeon</tt> are actually the same
917
    # in-memory instance and our final <tt>d.level == t.dungeon.level</tt> will return +true+.
P
Pratik Naik 已提交
918 919 920 921 922 923 924
    #
    # 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.
    #
925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991
    # == Deleting from associations
    #
    # === Dependent associations
    #
    # +has_many+, +has_one+ and +belongs_to+ associations support the <tt>:dependent</tt> option.
    # This allows you to specify that associated records should be deleted when the owner is
    # deleted.
    #
    # For example:
    #
    #     class Author
    #       has_many :posts, :dependent => :destroy
    #     end
    #     Author.find(1).destroy # => Will destroy all of the author's posts, too
    #
    # The <tt>:dependent</tt> option can have different values which specify how the deletion
    # is done. For more information, see the documentation for this option on the different
    # specific association types.
    #
    # === Delete or destroy?
    #
    # +has_many+ and +has_and_belongs_to_many+ associations have the methods <tt>destroy</tt>,
    # <tt>delete</tt>, <tt>destroy_all</tt> and <tt>delete_all</tt>.
    #
    # For +has_and_belongs_to_many+, <tt>delete</tt> and <tt>destroy</tt> are the same: they
    # cause the records in the join table to be removed.
    #
    # For +has_many+, <tt>destroy</tt> will always call the <tt>destroy</tt> method of the
    # record(s) being removed so that callbacks are run. However <tt>delete</tt> will either
    # do the deletion according to the strategy specified by the <tt>:dependent</tt> option, or
    # if no <tt>:dependent</tt> option is given, then it will follow the default strategy.
    # The default strategy is <tt>:nullify</tt> (set the foreign keys to <tt>nil</tt>), except for
    # +has_many+ <tt>:through</tt>, where the default strategy is <tt>delete_all</tt> (delete
    # the join records, without running their callbacks).
    #
    # There is also a <tt>clear</tt> method which is the same as <tt>delete_all</tt>, except that
    # it returns the association rather than the records which have been deleted.
    #
    # === What gets deleted?
    #
    # There is a potential pitfall here: +has_and_belongs_to_many+ and +has_many+ <tt>:through</tt>
    # associations have records in join tables, as well as the associated records. So when we
    # call one of these deletion methods, what exactly should be deleted?
    #
    # The answer is that it is assumed that deletion on an association is about removing the
    # <i>link</i> between the owner and the associated object(s), rather than necessarily the
    # associated objects themselves. So with +has_and_belongs_to_many+ and +has_many+
    # <tt>:through</tt>, the join records will be deleted, but the associated records won't.
    #
    # This makes sense if you think about it: if you were to call <tt>post.tags.delete(Tag.find_by_name('food'))</tt>
    # you would want the 'food' tag to be unlinked from the post, rather than for the tag itself
    # to be removed from the database.
    #
    # However, there are examples where this strategy doesn't make sense. For example, suppose
    # a person has many projects, and each project has many tasks. If we deleted one of a person's
    # tasks, we would probably not want the project to be deleted. In this scenario, the delete method
    # won't actually work: it can only be used if the association on the join model is a
    # +belongs_to+. In other situations you are expected to perform operations directly on
    # either the associated records or the <tt>:through</tt> association.
    #
    # With a regular +has_many+ there is no distinction between the "associated records"
    # and the "link", so there is only one choice for what gets deleted.
    #
    # With +has_and_belongs_to_many+ and +has_many+ <tt>:through</tt>, if you want to delete the
    # associated records themselves, you can always do something along the lines of
    # <tt>person.tasks.each(&:destroy)</tt>.
    #
992
    # == Type safety with <tt>ActiveRecord::AssociationTypeMismatch</tt>
D
Initial  
David Heinemeier Hansson 已提交
993
    #
994
    # If you attempt to assign an object to an association that doesn't match the inferred
995
    # or specified <tt>:class_name</tt>, you'll get an <tt>ActiveRecord::AssociationTypeMismatch</tt>.
D
Initial  
David Heinemeier Hansson 已提交
996 997 998
    #
    # == Options
    #
999
    # All of the association macros can be specialized through options. This makes cases
1000
    # more complex than the simple and guessable ones possible.
D
Initial  
David Heinemeier Hansson 已提交
1001
    module ClassMethods
P
Pratik Naik 已提交
1002 1003 1004 1005 1006
      # 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 已提交
1007
      #   An empty array is returned if none are found.
P
Pratik Naik 已提交
1008 1009
      # [collection<<(object, ...)]
      #   Adds one or more objects to the collection by setting their foreign keys to the collection's primary key.
1010
      #   Note that this operation instantly fires update sql without waiting for the save or update call on the
1011
      #   parent object.
P
Pratik Naik 已提交
1012 1013
      # [collection.delete(object, ...)]
      #   Removes one or more objects from the collection by setting their foreign keys to +NULL+.
1014 1015
      #   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>.
1016 1017 1018 1019
      #
      #   If the <tt>:through</tt> option is used, then the join records are deleted (rather than
      #   nullified) by default, but you can specify <tt>:dependent => :destroy</tt> or
      #   <tt>:dependent => :nullify</tt> to override this.
P
Pratik Naik 已提交
1020
      # [collection=objects]
1021 1022 1023
      #   Replaces the collections content by deleting and adding objects as appropriate. If the <tt>:through</tt>
      #   option is true callbacks in the join models are triggered except destroy callbacks, since deletion is
      #   direct.
P
Pratik Naik 已提交
1024 1025 1026
      # [collection_singular_ids]
      #   Returns an array of the associated objects' ids
      # [collection_singular_ids=ids]
1027 1028
      #   Replace the collection with the objects identified by the primary keys in +ids+. This
      #   method loads the models and calls <tt>collection=</tt>. See above.
P
Pratik Naik 已提交
1029 1030 1031 1032
      # [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+.
1033 1034
      #   If the <tt>:through</tt> option is true no destroy callbacks are invoked on the join models.
      #   Join models are directly deleted.
P
Pratik Naik 已提交
1035 1036 1037 1038 1039 1040
      # [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 已提交
1041
      # [collection.exists?(...)]
P
Pratik Naik 已提交
1042 1043 1044 1045 1046
      #   Checks whether an associated object with the given conditions exists.
      #   Uses the same rules as ActiveRecord::Base.exists?.
      # [collection.build(attributes = {}, ...)]
      #   Returns one or more new objects of the collection type that have been instantiated
      #   with +attributes+ and linked to this object through a foreign key, but have not yet
P
Pratik Naik 已提交
1047
      #   been saved.
P
Pratik Naik 已提交
1048 1049 1050
      # [collection.create(attributes = {})]
      #   Returns a new object of the collection type that has been instantiated
      #   with +attributes+, linked to this object through a foreign key, and that has already
P
Pratik Naik 已提交
1051 1052
      #   been saved (if it passed the validation). *Note*: This only works if the base model
      #   already exists in the DB, not if it is a new (unsaved) record!
P
Pratik Naik 已提交
1053 1054 1055 1056 1057
      #
      # (*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 已提交
1058
      #
P
Pratik Naik 已提交
1059
      # Example: A Firm class declares <tt>has_many :clients</tt>, which will add:
A
Akira Matsuda 已提交
1060
      # * <tt>Firm#clients</tt> (similar to <tt>Clients.all :conditions => ["firm_id = ?", id]</tt>)
D
Initial  
David Heinemeier Hansson 已提交
1061 1062
      # * <tt>Firm#clients<<</tt>
      # * <tt>Firm#clients.delete</tt>
1063
      # * <tt>Firm#clients=</tt>
1064
      # * <tt>Firm#client_ids</tt>
1065
      # * <tt>Firm#client_ids=</tt>
D
Initial  
David Heinemeier Hansson 已提交
1066 1067 1068
      # * <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>)
1069
      # * <tt>Firm#clients.find</tt> (similar to <tt>Client.find(id, :conditions => "firm_id = #{id}")</tt>)
P
Pratik Naik 已提交
1070
      # * <tt>Firm#clients.exists?(:name => 'ACME')</tt> (similar to <tt>Client.exists?(:name => 'ACME', :firm_id => firm.id)</tt>)
D
Initial  
David Heinemeier Hansson 已提交
1071
      # * <tt>Firm#clients.build</tt> (similar to <tt>Client.new("firm_id" => id)</tt>)
D
David Heinemeier Hansson 已提交
1072
      # * <tt>Firm#clients.create</tt> (similar to <tt>c = Client.new("firm_id" => id); c.save; c</tt>)
D
Initial  
David Heinemeier Hansson 已提交
1073
      # The declaration can also include an options hash to specialize the behavior of the association.
1074
      #
1075
      # === Options
P
Pratik Naik 已提交
1076 1077
      # [:class_name]
      #   Specify the class name of the association. Use it only if that name can't be inferred
1078 1079
      #   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
1080
      #   specify it with this option.
P
Pratik Naik 已提交
1081 1082
      # [:conditions]
      #   Specify the conditions that the associated objects must meet in order to be included as a +WHERE+
S
Sebastian Martinez 已提交
1083
      #   SQL fragment, such as <tt>price > 5 AND name LIKE 'B%'</tt>. Record creations from
1084 1085
      #   the association are scoped if a hash is used.
      #   <tt>has_many :posts, :conditions => {:published => true}</tt> will create published
1086
      #   posts with <tt>@blog.posts.create</tt> or <tt>@blog.posts.build</tt>.
P
Pratik Naik 已提交
1087 1088
      # [:order]
      #   Specify the order in which the associated objects are returned as an <tt>ORDER BY</tt> SQL fragment,
P
Pratik Naik 已提交
1089
      #   such as <tt>last_name, first_name DESC</tt>.
P
Pratik Naik 已提交
1090 1091
      # [:foreign_key]
      #   Specify the foreign key used for the association. By default this is guessed to be the name
1092
      #   of this class in lower-case and "_id" suffixed. So a Person class that makes a +has_many+
1093
      #   association will use "person_id" as the default <tt>:foreign_key</tt>.
P
Pratik Naik 已提交
1094 1095 1096 1097
      # [: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
S
Sebastian Martinez 已提交
1098 1099
      #   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
1100
      #   objects' foreign keys are set to +NULL+ *without* calling their +save+ callbacks. If set to
1101 1102
      #   <tt>:restrict</tt> this object raises an <tt>ActiveRecord::DeleteRestrictionError</tt> exception and
      #   cannot be deleted if it has any associated objects.
1103
      #
1104 1105 1106
      #   If using with the <tt>:through</tt> option, the association on the join model must be
      #   a +belongs_to+, and the records which get deleted are the join records, rather than
      #   the associated records.
1107
      #
P
Pratik Naik 已提交
1108 1109
      # [:finder_sql]
      #   Specify a complete SQL statement to fetch the association. This is a good way to go for complex
1110 1111
      #   associations that depend on multiple tables. May be supplied as a string or a proc where interpolation is
      #   required. Note: When this option is used, +find_in_collection+
1112
      #   is _not_ added.
P
Pratik Naik 已提交
1113 1114
      # [:counter_sql]
      #   Specify a complete SQL statement to fetch the size of the association. If <tt>:finder_sql</tt> is
1115
      #   specified but not <tt>:counter_sql</tt>, <tt>:counter_sql</tt> will be generated by
1116
      #   replacing <tt>SELECT ... FROM</tt> with <tt>SELECT COUNT(*) FROM</tt>.
P
Pratik Naik 已提交
1117 1118 1119 1120 1121 1122
      # [: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.
1123
      # [:having]
1124
      #   Combined with +:group+ this can be used to filter the records that a <tt>GROUP BY</tt>
1125
      #   returns. Uses the <tt>HAVING</tt> SQL-clause.
P
Pratik Naik 已提交
1126 1127 1128
      # [:limit]
      #   An integer determining the limit on the number of rows that should be returned.
      # [:offset]
1129
      #   An integer determining the offset from where the rows should be fetched. So at 5,
1130
      #   it would skip the first 4 rows.
P
Pratik Naik 已提交
1131
      # [:select]
1132 1133
      #   By default, this is <tt>*</tt> as in <tt>SELECT * FROM</tt>, but can be changed if
      #   you, for example, want to do a join but not include the joined columns. Do not forget
1134
      #   to include the primary and foreign keys, otherwise it will raise an error.
P
Pratik Naik 已提交
1135 1136 1137
      # [:as]
      #   Specifies a polymorphic interface (See <tt>belongs_to</tt>).
      # [:through]
1138 1139
      #   Specifies an association through which to perform the query. This can be any other type
      #   of association, including other <tt>:through</tt> associations. Options for <tt>:class_name</tt>,
1140
      #   <tt>:primary_key</tt> and <tt>:foreign_key</tt> are ignored, as the association uses the
1141
      #   source reflection.
1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152
      #
      #   If the association on the join model is a +belongs_to+, the collection can be modified
      #   and the records on the <tt>:through</tt> model will be automatically created and removed
      #   as appropriate. Otherwise, the collection is read-only, so you should manipulate the
      #   <tt>:through</tt> association directly.
      #
      #   If you are going to modify the association (rather than just read from it), then it is
      #   a good idea to set the <tt>:inverse_of</tt> option on the source association on the
      #   join model. This allows associated records to be built which will automatically create
      #   the appropriate join model records when they are saved. (See the 'Association Join Models'
      #   section above.)
P
Pratik Naik 已提交
1153
      # [:source]
1154 1155
      #   Specifies the source association name used by <tt>has_many :through</tt> queries.
      #   Only use it if the name cannot be inferred from the association.
1156
      #   <tt>has_many :subscribers, :through => :subscriptions</tt> will look for either <tt>:subscribers</tt> or
P
Pratik Naik 已提交
1157
      #   <tt>:subscriber</tt> on Subscription, unless a <tt>:source</tt> is given.
P
Pratik Naik 已提交
1158 1159
      # [:source_type]
      #   Specifies type of the source association used by <tt>has_many :through</tt> queries where the source
1160
      #   association is a polymorphic +belongs_to+.
P
Pratik Naik 已提交
1161 1162 1163 1164 1165
      # [: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]
1166
      #   If +false+, don't validate the associated objects when saving the parent object. true by default.
1167
      # [:autosave]
1168
      #   If true, always save the associated objects or destroy them if marked for destruction,
1169
      #   when saving the parent object. If false, never save or destroy the associated objects.
1170
      #   By default, only save associated objects that are new records.
P
Pratik Naik 已提交
1171
      # [:inverse_of]
1172 1173
      #   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
1174
      #   with <tt>:through</tt> or <tt>:as</tt> options.
1175
      #   See ActiveRecord::Associations::ClassMethods's overview on Bi-directional associations for more detail.
1176
      #
D
Initial  
David Heinemeier Hansson 已提交
1177 1178
      # Option examples:
      #   has_many :comments, :order => "posted_on"
1179
      #   has_many :comments, :include => :author
D
Initial  
David Heinemeier Hansson 已提交
1180
      #   has_many :people, :class_name => "Person", :conditions => "deleted = 0", :order => "name"
1181 1182
      #   has_many :tracks, :order => "position", :dependent => :destroy
      #   has_many :comments, :dependent => :nullify
R
Rick Olson 已提交
1183
      #   has_many :tags, :as => :taggable
1184
      #   has_many :reports, :readonly => true
1185
      #   has_many :subscribers, :through => :subscriptions, :source => :user
1186 1187 1188 1189 1190 1191 1192 1193
      #   has_many :subscribers, :class_name => "Person", :finder_sql => Proc.new {
      #       %Q{
      #         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
      #       }
      #   }
1194 1195
      def has_many(name, options = {}, &extension)
        Builder::HasMany.build(self, name, options, &extension)
D
Initial  
David Heinemeier Hansson 已提交
1196 1197
      end

P
Pratik Naik 已提交
1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208
      # 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 已提交
1209
      #   and saves the associate object.
P
Pratik Naik 已提交
1210 1211 1212
      # [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
1213
      #   yet been saved.
P
Pratik Naik 已提交
1214 1215 1216 1217
      # [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).
1218 1219 1220
      # [create_association!(attributes = {})]
      #   Does the same as <tt>create_association</tt>, but raises <tt>ActiveRecord::RecordInvalid</tt>
      #   if the record is invalid.
P
Pratik Naik 已提交
1221 1222 1223
      #
      # (+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 已提交
1224
      #
P
Pratik Naik 已提交
1225 1226 1227
      # === Example
      #
      # An Account class declares <tt>has_one :beneficiary</tt>, which will add:
A
Akira Matsuda 已提交
1228
      # * <tt>Account#beneficiary</tt> (similar to <tt>Beneficiary.first(:conditions => "account_id = #{id}")</tt>)
D
Initial  
David Heinemeier Hansson 已提交
1229
      # * <tt>Account#beneficiary=(beneficiary)</tt> (similar to <tt>beneficiary.account_id = account.id; beneficiary.save</tt>)
1230 1231
      # * <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>)
1232
      # * <tt>Account#create_beneficiary!</tt> (similar to <tt>b = Beneficiary.new("account_id" => id); b.save!; b</tt>)
1233
      #
P
Pratik Naik 已提交
1234 1235
      # === Options
      #
D
Initial  
David Heinemeier Hansson 已提交
1236
      # The declaration can also include an options hash to specialize the behavior of the association.
1237
      #
D
Initial  
David Heinemeier Hansson 已提交
1238
      # Options are:
P
Pratik Naik 已提交
1239 1240
      # [:class_name]
      #   Specify the class name of the association. Use it only if that name can't be inferred
P
Pratik Naik 已提交
1241 1242
      #   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 已提交
1243 1244
      # [:conditions]
      #   Specify the conditions that the associated object must meet in order to be included as a +WHERE+
1245
      #   SQL fragment, such as <tt>rank = 5</tt>. Record creation from the association is scoped if a hash
1246
      #   is used. <tt>has_one :account, :conditions => {:enabled => true}</tt> will create
1247
      #   an enabled account with <tt>@company.create_account</tt> or <tt>@company.build_account</tt>.
P
Pratik Naik 已提交
1248 1249
      # [:order]
      #   Specify the order in which the associated objects are returned as an <tt>ORDER BY</tt> SQL fragment,
P
Pratik Naik 已提交
1250
      #   such as <tt>last_name, first_name DESC</tt>.
P
Pratik Naik 已提交
1251 1252
      # [:dependent]
      #   If set to <tt>:destroy</tt>, the associated object is destroyed when this object is. If set to
1253 1254
      #   <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+.
1255 1256
      #   Also, association is assigned. If set to <tt>:restrict</tt> this object raises an
      #   <tt>ActiveRecord::DeleteRestrictionError</tt> exception and cannot be deleted if it has any associated object.
P
Pratik Naik 已提交
1257 1258
      # [:foreign_key]
      #   Specify the foreign key used for the association. By default this is guessed to be the name
1259
      #   of this class in lower-case and "_id" suffixed. So a Person class that makes a +has_one+ association
1260
      #   will use "person_id" as the default <tt>:foreign_key</tt>.
P
Pratik Naik 已提交
1261 1262 1263 1264 1265 1266 1267
      # [: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]
1268 1269
      #   By default, this is <tt>*</tt> as in <tt>SELECT * FROM</tt>, but can be changed if, for example,
      #   you want to do a join but not include the joined columns. Do not forget to include the
1270
      #   primary and foreign keys, otherwise it will raise an error.
P
Pratik Naik 已提交
1271
      # [:through]
S
Sebastian Martinez 已提交
1272
      #   Specifies a Join Model through which to perform the query. Options for <tt>:class_name</tt>,
1273 1274 1275
      #   <tt>:primary_key</tt>, and <tt>:foreign_key</tt> are ignored, as the association uses the
      #   source reflection. You can only use a <tt>:through</tt> query through a <tt>has_one</tt>
      #   or <tt>belongs_to</tt> association on the join model.
P
Pratik Naik 已提交
1276
      # [:source]
1277 1278
      #   Specifies the source association name used by <tt>has_one :through</tt> queries.
      #   Only use it if the name cannot be inferred from the association.
1279
      #   <tt>has_one :favorite, :through => :favorites</tt> will look for a
1280
      #   <tt>:favorite</tt> on Favorite, unless a <tt>:source</tt> is given.
P
Pratik Naik 已提交
1281 1282
      # [:source_type]
      #   Specifies type of the source association used by <tt>has_one :through</tt> queries where the source
1283
      #   association is a polymorphic +belongs_to+.
P
Pratik Naik 已提交
1284 1285 1286
      # [:readonly]
      #   If true, the associated object is readonly through the association.
      # [:validate]
1287
      #   If +false+, don't validate the associated object when saving the parent object. +false+ by default.
1288
      # [:autosave]
1289
      #   If true, always save the associated object or destroy it if marked for destruction,
1290
      #   when saving the parent object. If false, never save or destroy the associated object.
1291
      #   By default, only save the associated object if it's a new record.
P
Pratik Naik 已提交
1292
      # [:inverse_of]
1293
      #   Specifies the name of the <tt>belongs_to</tt> association on the associated object
S
Sebastian Martinez 已提交
1294
      #   that is the inverse of this <tt>has_one</tt> association. Does not work in combination
1295
      #   with <tt>:through</tt> or <tt>:as</tt> options.
1296
      #   See ActiveRecord::Associations::ClassMethods's overview on Bi-directional associations for more detail.
1297
      #
D
Initial  
David Heinemeier Hansson 已提交
1298
      # Option examples:
1299
      #   has_one :credit_card, :dependent => :destroy  # destroys the associated credit card
1300
      #   has_one :credit_card, :dependent => :nullify  # updates the associated records foreign
1301
      #                                                 # key value to NULL rather than destroying it
D
Initial  
David Heinemeier Hansson 已提交
1302 1303
      #   has_one :last_comment, :class_name => "Comment", :order => "posted_on"
      #   has_one :project_manager, :class_name => "Person", :conditions => "role = 'project_manager'"
1304
      #   has_one :attachment, :as => :attachable
1305
      #   has_one :boss, :readonly => :true
1306 1307
      #   has_one :club, :through => :membership
      #   has_one :primary_address, :through => :addressables, :conditions => ["addressable.primary = ?", true], :source => :addressable
1308 1309
      def has_one(name, options = {})
        Builder::HasOne.build(self, name, options)
D
Initial  
David Heinemeier Hansson 已提交
1310 1311
      end

P
Pratik Naik 已提交
1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325
      # 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
1326
      #   with +attributes+ and linked to this object through a foreign key, but has not yet been saved.
P
Pratik Naik 已提交
1327 1328 1329 1330
      # [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).
1331 1332 1333
      # [create_association!(attributes = {})]
      #   Does the same as <tt>create_association</tt>, but raises <tt>ActiveRecord::RecordInvalid</tt>
      #   if the record is invalid.
P
Pratik Naik 已提交
1334 1335 1336
      #
      # (+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 已提交
1337
      #
P
Pratik Naik 已提交
1338 1339 1340
      # === Example
      #
      # A Post class declares <tt>belongs_to :author</tt>, which will add:
D
Initial  
David Heinemeier Hansson 已提交
1341 1342
      # * <tt>Post#author</tt> (similar to <tt>Author.find(author_id)</tt>)
      # * <tt>Post#author=(author)</tt> (similar to <tt>post.author_id = author.id</tt>)
D
David Heinemeier Hansson 已提交
1343 1344
      # * <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>)
1345
      # * <tt>Post#create_author!</tt> (similar to <tt>post.author = Author.new; post.author.save!; post.author</tt>)
D
Initial  
David Heinemeier Hansson 已提交
1346
      # The declaration can also include an options hash to specialize the behavior of the association.
1347
      #
P
Pratik Naik 已提交
1348 1349 1350 1351
      # === Options
      #
      # [:class_name]
      #   Specify the class name of the association. Use it only if that name can't be inferred
1352
      #   from the association name. So <tt>belongs_to :author</tt> will by default be linked to the Author class, but
P
Pratik Naik 已提交
1353
      #   if the real class name is Person, you'll have to specify it with this option.
P
Pratik Naik 已提交
1354 1355
      # [:conditions]
      #   Specify the conditions that the associated object must meet in order to be included as a +WHERE+
1356
      #   SQL fragment, such as <tt>authorized = 1</tt>.
P
Pratik Naik 已提交
1357
      # [:select]
1358 1359
      #   By default, this is <tt>*</tt> as in <tt>SELECT * FROM</tt>, but can be changed
      #   if, for example, you want to do a join but not include the joined columns. Do not
1360
      #   forget to include the primary and foreign keys, otherwise it will raise an error.
P
Pratik Naik 已提交
1361 1362
      # [:foreign_key]
      #   Specify the foreign key used for the association. By default this is guessed to be the name
1363 1364 1365
      #   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
1366
      #   of "favorite_person_id".
1367 1368 1369 1370 1371
      # [:foreign_type]
      #   Specify the column used to store the associated object's type, if this is a polymorphic
      #   association. By default this is guessed to be the name of the association with a "_type"
      #   suffix. So a class that defines a <tt>belongs_to :taggable, :polymorphic => true</tt>
      #   association will use "taggable_type" as the default <tt>:foreign_type</tt>.
1372
      # [:primary_key]
1373
      #   Specify the method that returns the primary key of associated object used for the association.
1374
      #   By default this is id.
P
Pratik Naik 已提交
1375 1376
      # [:dependent]
      #   If set to <tt>:destroy</tt>, the associated object is destroyed when this object is. If set to
1377 1378
      #   <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
1379
      #   a <tt>has_many</tt> relationship on another class because of the potential to leave
1380
      #   orphaned records behind.
P
Pratik Naik 已提交
1381 1382
      # [:counter_cache]
      #   Caches the number of belonging objects on the associate class through the use of +increment_counter+
1383 1384
      #   and +decrement_counter+. The counter cache is incremented when an object of this
      #   class is created and decremented when it's destroyed. This requires that a column
1385
      #   named <tt>#{table_name}_count</tt> (such as +comments_count+ for a belonging Comment class)
1386 1387
      #   is used on the associate class (such as a Post class). You can also specify a custom counter
      #   cache column by providing a column name instead of a +true+/+false+ value to this
1388
      #   option (e.g., <tt>:counter_cache => :my_custom_counter</tt>.)
1389
      #   Note: Specifying a counter cache will add it to that model's list of readonly attributes
1390
      #   using +attr_readonly+.
P
Pratik Naik 已提交
1391 1392 1393 1394
      # [: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+.
1395
      #   Note: If you've enabled the counter cache, then you may want to add the counter cache attribute
P
Pratik Naik 已提交
1396
      #   to the +attr_readonly+ list in the associated classes (e.g. <tt>class Post; attr_readonly :comments_count; end</tt>).
P
Pratik Naik 已提交
1397 1398 1399
      # [:readonly]
      #   If true, the associated object is readonly through the association.
      # [:validate]
1400
      #   If +false+, don't validate the associated objects when saving the parent object. +false+ by default.
1401
      # [:autosave]
1402
      #   If true, always save the associated object or destroy it if marked for destruction, when
1403
      #   saving the parent object.
1404 1405
      #   If false, never save or destroy the associated object.
      #   By default, only save the associated object if it's a new record.
1406
      # [:touch]
1407 1408
      #   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
1409
      #   will be updated with the current time in addition to the updated_at/on attribute.
P
Pratik Naik 已提交
1410
      # [:inverse_of]
1411
      #   Specifies the name of the <tt>has_one</tt> or <tt>has_many</tt> association on the associated
S
Sebastian Martinez 已提交
1412
      #   object that is the inverse of this <tt>belongs_to</tt> association. Does not work in
1413
      #   combination with the <tt>:polymorphic</tt> options.
1414
      #   See ActiveRecord::Associations::ClassMethods's overview on Bi-directional associations for more detail.
D
Initial  
David Heinemeier Hansson 已提交
1415 1416 1417
      #
      # Option examples:
      #   belongs_to :firm, :foreign_key => "client_of"
1418
      #   belongs_to :person, :primary_key => "name", :foreign_key => "person_name"
D
Initial  
David Heinemeier Hansson 已提交
1419
      #   belongs_to :author, :class_name => "Person", :foreign_key => "author_id"
1420
      #   belongs_to :valid_coupon, :class_name => "Coupon", :foreign_key => "coupon_id",
D
Initial  
David Heinemeier Hansson 已提交
1421
      #              :conditions => 'discounts > #{payments_count}'
R
Rick Olson 已提交
1422
      #   belongs_to :attachable, :polymorphic => true
1423
      #   belongs_to :project, :readonly => true
1424
      #   belongs_to :post, :counter_cache => true
1425 1426
      #   belongs_to :company, :touch => true
      #   belongs_to :company, :touch => :employees_last_updated_at
1427 1428
      def belongs_to(name, options = {})
        Builder::BelongsTo.build(self, name, options)
1429 1430
      end

P
Pratik Naik 已提交
1431
      # Specifies a many-to-many relationship with another class. This associates two classes via an
S
Sebastian Martinez 已提交
1432
      # intermediate join table. Unless the join table is explicitly specified as an option, it is
P
Pratik Naik 已提交
1433
      # guessed using the lexical order of the class names. So a join between Developer and Project
1434
      # will give the default join table name of "developers_projects" because "D" outranks "P".
S
Sebastian Martinez 已提交
1435
      # Note that this precedence is calculated using the <tt><</tt> operator for String. This
1436
      # means that if the strings are of different lengths, and the strings are equal when compared
1437
      # up to the shortest length, then the longer string is considered of higher
S
Sebastian Martinez 已提交
1438
      # lexical precedence than the shorter one. For example, one would expect the tables "paper_boxes" and "papers"
P
Pratik Naik 已提交
1439
      # to generate a join table name of "papers_paper_boxes" because of the length of the name "paper_boxes",
S
Sebastian Martinez 已提交
1440
      # but it in fact generates a join table name of "paper_boxes_papers". Be aware of this caveat, and use the
P
Pratik Naik 已提交
1441
      # custom <tt>:join_table</tt> option if you need to.
D
Initial  
David Heinemeier Hansson 已提交
1442
      #
1443 1444 1445 1446
      # 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
1447
      #     def change
1448 1449 1450 1451 1452 1453 1454
      #       create_table :developers_projects, :id => false do |t|
      #         t.integer :developer_id
      #         t.integer :project_id
      #       end
      #     end
      #   end
      #
1455 1456 1457 1458
      # It's also a good idea to add indexes to each of those columns to speed up the joins process.
      # However, in MySQL it is advised to add a compound index for both of the columns as MySQL only
      # uses one index per table during the lookup.
      #
1459
      # Adds the following methods for retrieval and query:
P
Pratik Naik 已提交
1460 1461 1462
      #
      # [collection(force_reload = false)]
      #   Returns an array of all the associated objects.
1463
      #   An empty array is returned if none are found.
P
Pratik Naik 已提交
1464 1465
      # [collection<<(object, ...)]
      #   Adds one or more objects to the collection by creating associations in the join table
1466
      #   (<tt>collection.push</tt> and <tt>collection.concat</tt> are aliases to this method).
1467
      #   Note that this operation instantly fires update sql without waiting for the save or update call on the
1468
      #   parent object.
P
Pratik Naik 已提交
1469 1470
      # [collection.delete(object, ...)]
      #   Removes one or more objects from the collection by removing their associations from the join table.
D
Initial  
David Heinemeier Hansson 已提交
1471
      #   This does not destroy the objects.
P
Pratik Naik 已提交
1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485
      # [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
1486
      #   meets the condition that it has to be associated with this object.
P
Pratik Naik 已提交
1487
      #   Uses the same rules as ActiveRecord::Base.find.
P
Pratik Naik 已提交
1488
      # [collection.exists?(...)]
P
Pratik Naik 已提交
1489 1490 1491 1492
      #   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
1493
      #   with +attributes+ and linked to this object through the join table, but has not yet been saved.
P
Pratik Naik 已提交
1494 1495
      # [collection.create(attributes = {})]
      #   Returns a new object of the collection type that has been instantiated
1496
      #   with +attributes+, linked to this object through the join table, and that has already been
1497
      #   saved (if it passed the validation).
D
Initial  
David Heinemeier Hansson 已提交
1498
      #
P
Pratik Naik 已提交
1499 1500 1501 1502 1503 1504
      # (+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 已提交
1505 1506 1507
      # * <tt>Developer#projects</tt>
      # * <tt>Developer#projects<<</tt>
      # * <tt>Developer#projects.delete</tt>
1508
      # * <tt>Developer#projects=</tt>
1509
      # * <tt>Developer#project_ids</tt>
1510
      # * <tt>Developer#project_ids=</tt>
D
Initial  
David Heinemeier Hansson 已提交
1511 1512 1513 1514
      # * <tt>Developer#projects.clear</tt>
      # * <tt>Developer#projects.empty?</tt>
      # * <tt>Developer#projects.size</tt>
      # * <tt>Developer#projects.find(id)</tt>
1515
      # * <tt>Developer#projects.exists?(...)</tt>
1516 1517
      # * <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 已提交
1518
      # The declaration may include an options hash to specialize the behavior of the association.
1519
      #
P
Pratik Naik 已提交
1520 1521 1522 1523
      # === Options
      #
      # [:class_name]
      #   Specify the class name of the association. Use it only if that name can't be inferred
1524
      #   from the association name. So <tt>has_and_belongs_to_many :projects</tt> will by default be linked to the
P
Pratik Naik 已提交
1525
      #   Project class, but if the real class name is SuperProject, you'll have to specify it with this option.
P
Pratik Naik 已提交
1526 1527 1528 1529 1530 1531
      # [: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
1532 1533
      #   of this class in lower-case and "_id" suffixed. So a Person class that makes
      #   a +has_and_belongs_to_many+ association to Project will use "person_id" as the
1534
      #   default <tt>:foreign_key</tt>.
P
Pratik Naik 已提交
1535
      # [:association_foreign_key]
P
Pratik Naik 已提交
1536 1537 1538 1539
      #   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 已提交
1540 1541
      # [:conditions]
      #   Specify the conditions that the associated object must meet in order to be included as a +WHERE+
S
Sebastian Martinez 已提交
1542
      #   SQL fragment, such as <tt>authorized = 1</tt>. Record creations from the association are
1543
      #   scoped if a hash is used.
1544
      #   <tt>has_many :posts, :conditions => {:published => true}</tt> will create published posts with <tt>@blog.posts.create</tt>
1545
      #   or <tt>@blog.posts.build</tt>.
P
Pratik Naik 已提交
1546 1547
      # [:order]
      #   Specify the order in which the associated objects are returned as an <tt>ORDER BY</tt> SQL fragment,
1548
      #   such as <tt>last_name, first_name DESC</tt>
P
Pratik Naik 已提交
1549 1550 1551 1552
      # [: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
1553 1554
      # [:counter_sql]
      #   Specify a complete SQL statement to fetch the size of the association. If <tt>:finder_sql</tt> is
1555
      #   specified but not <tt>:counter_sql</tt>, <tt>:counter_sql</tt> will be generated by
1556
      #   replacing <tt>SELECT ... FROM</tt> with <tt>SELECT COUNT(*) FROM</tt>.
P
Pratik Naik 已提交
1557 1558
      # [:delete_sql]
      #   Overwrite the default generated SQL statement used to remove links between the associated
P
Pratik Naik 已提交
1559
      #   classes with a manual statement.
P
Pratik Naik 已提交
1560 1561
      # [:insert_sql]
      #   Overwrite the default generated SQL statement used to add links between the associated classes
P
Pratik Naik 已提交
1562
      #   with a manual statement.
P
Pratik Naik 已提交
1563 1564 1565 1566 1567 1568
      # [: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.
1569
      # [:having]
1570
      #   Combined with +:group+ this can be used to filter the records that a <tt>GROUP BY</tt> returns.
1571
      #   Uses the <tt>HAVING</tt> SQL-clause.
P
Pratik Naik 已提交
1572 1573 1574
      # [:limit]
      #   An integer determining the limit on the number of rows that should be returned.
      # [:offset]
1575
      #   An integer determining the offset from where the rows should be fetched. So at 5,
1576
      #   it would skip the first 4 rows.
P
Pratik Naik 已提交
1577
      # [:select]
1578 1579
      #   By default, this is <tt>*</tt> as in <tt>SELECT * FROM</tt>, but can be changed if, for example,
      #   you want to do a join but not include the joined columns. Do not forget to include the primary
1580
      #   and foreign keys, otherwise it will raise an error.
P
Pratik Naik 已提交
1581 1582 1583
      # [:readonly]
      #   If true, all the associated objects are readonly through the association.
      # [:validate]
1584
      #   If +false+, don't validate the associated objects when saving the parent object. +true+ by default.
1585
      # [:autosave]
1586
      #   If true, always save the associated objects or destroy them if marked for destruction, when
1587
      #   saving the parent object.
1588 1589
      #   If false, never save or destroy the associated objects.
      #   By default, only save associated objects that are new records.
D
Initial  
David Heinemeier Hansson 已提交
1590 1591 1592
      #
      # Option examples:
      #   has_and_belongs_to_many :projects
1593
      #   has_and_belongs_to_many :projects, :include => [ :milestones, :manager ]
D
Initial  
David Heinemeier Hansson 已提交
1594 1595
      #   has_and_belongs_to_many :nations, :class_name => "Country"
      #   has_and_belongs_to_many :categories, :join_table => "prods_cats"
1596
      #   has_and_belongs_to_many :categories, :readonly => true
1597
      #   has_and_belongs_to_many :active_projects, :join_table => 'developers_projects', :delete_sql =>
1598
      #   "DELETE FROM developers_projects WHERE active=1 AND developer_id = #{id} AND project_id = #{record.id}"
1599 1600
      def has_and_belongs_to_many(name, options = {}, &extension)
        Builder::HasAndBelongsToMany.build(self, name, options, &extension)
D
Initial  
David Heinemeier Hansson 已提交
1601
      end
1602
    end
D
Initial  
David Heinemeier Hansson 已提交
1603
  end
1604
end