associations.rb 94.7 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'
8
require 'active_record/associations/class_methods/join_dependency'
J
Jeremy Kemper 已提交
9

D
Initial  
David Heinemeier Hansson 已提交
10
module ActiveRecord
11
  class InverseOfAssociationNotFoundError < ActiveRecordError #:nodoc:
12 13
    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})")
14 15 16
    end
  end

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

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

29 30 31 32 33 34
  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

35 36 37 38 39
  class HasManyThroughAssociationPointlessSourceTypeError < ActiveRecordError #:nodoc:
    def initialize(owner_class_name, reflection, source_reflection)
      super("Cannot have a has_many :through association '#{owner_class_name}##{reflection.name}' with a :source_type option if the '#{reflection.through_reflection.class_name}##{source_reflection.name}' is not polymorphic.  Try removing :source_type on your association.")
    end
  end
40

41 42 43 44 45 46
  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 已提交
47
  class HasManyThroughSourceAssociationNotFoundError < ActiveRecordError #:nodoc:
48
    def initialize(reflection)
49 50 51
      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 }
52
      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)}?")
53 54 55
    end
  end

56
  class HasManyThroughSourceAssociationMacroError < ActiveRecordError #:nodoc:
57
    def initialize(reflection)
58 59 60
      through_reflection = reflection.through_reflection
      source_reflection  = reflection.source_reflection
      super("Invalid source reflection macro :#{source_reflection.macro}#{" :through" if source_reflection.options[:through]} for has_many #{reflection.name.inspect}, :through => #{through_reflection.name.inspect}.  Use :source to specify the source reflection.")
61 62 63
    end
  end

64
  class HasManyThroughCantAssociateThroughHasOneOrManyReflection < ActiveRecordError #:nodoc:
65 66 67 68
    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
69

70 71 72 73 74 75
  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

76 77 78 79 80 81
  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

82 83 84 85 86 87
  class HasAndBelongsToManyAssociationWithPrimaryKeyError < ActiveRecordError #:nodoc:
    def initialize(reflection)
      super("Primary key is not allowed in a has_and_belongs_to_many join table (#{reflection.options[:join_table]}).")
    end
  end

88 89 90 91 92 93
  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 已提交
94
  class EagerLoadPolymorphicError < ActiveRecordError #:nodoc:
95
    def initialize(reflection)
96
      super("Can not eagerly load the polymorphic association #{reflection.name.inspect}")
97 98 99
    end
  end

100 101
  class ReadOnlyAssociation < ActiveRecordError #:nodoc:
    def initialize(reflection)
102
      super("Can not add to a has_many :through association.  Try adding to #{reflection.through_reflection.name.inspect}.")
103 104 105
    end
  end

106
  # This error is raised when trying to destroy a parent instance in N:1 or 1:1 associations
107
  # (has_many, has_one) when there is at least 1 child associated instance.
108 109 110 111 112 113 114
  # ex: if @project.tasks.size > 0, DeleteRestrictionError will be raised when trying to destroy @project
  class DeleteRestrictionError < ActiveRecordError #:nodoc:
    def initialize(reflection)
      super("Cannot delete record because of dependent #{reflection.name}")
    end
  end

P
Pratik Naik 已提交
115
  # See ActiveRecord::Associations::ClassMethods for documentation.
D
Initial  
David Heinemeier Hansson 已提交
116
  module Associations # :nodoc:
117
    extend ActiveSupport::Concern
118

119
    # These classes will be loaded when associations are created.
J
Joshua Peek 已提交
120 121 122
    # So there is no need to eager load them.
    autoload :AssociationCollection, 'active_record/associations/association_collection'
    autoload :AssociationProxy, 'active_record/associations/association_proxy'
123 124
    autoload :HasAssociation, 'active_record/associations/has_association'
    autoload :ThroughAssociation, 'active_record/associations/through_association'
J
Joshua Peek 已提交
125 126 127 128 129 130 131 132
    autoload :BelongsToAssociation, 'active_record/associations/belongs_to_association'
    autoload :BelongsToPolymorphicAssociation, 'active_record/associations/belongs_to_polymorphic_association'
    autoload :HasAndBelongsToManyAssociation, 'active_record/associations/has_and_belongs_to_many_association'
    autoload :HasManyAssociation, 'active_record/associations/has_many_association'
    autoload :HasManyThroughAssociation, 'active_record/associations/has_many_through_association'
    autoload :HasOneAssociation, 'active_record/associations/has_one_association'
    autoload :HasOneThroughAssociation, 'active_record/associations/has_one_through_association'

133
    # Clears out the association cache.
134 135 136
    def clear_association_cache #:nodoc:
      self.class.reflect_on_all_associations.to_a.each do |assoc|
        instance_variable_set "@#{assoc.name}", nil
137
      end if self.persisted?
138
    end
139

140
    private
141
      # Returns the specified association instance if it responds to :loaded?, nil otherwise.
142
      def association_instance_get(name)
A
Aaron Patterson 已提交
143 144 145 146 147
        ivar = "@#{name}"
        if instance_variable_defined?(ivar)
          association = instance_variable_get(ivar)
          association if association.respond_to?(:loaded?)
        end
148 149 150 151 152 153 154
      end

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

155 156 157 158
    # 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
159
    # options hash. It works much the same way as Ruby's own <tt>attr*</tt>
160
    # methods.
D
Initial  
David Heinemeier Hansson 已提交
161 162 163
    #
    #   class Project < ActiveRecord::Base
    #     belongs_to              :portfolio
164
    #     has_one                 :project_manager
D
Initial  
David Heinemeier Hansson 已提交
165 166 167 168
    #     has_many                :milestones
    #     has_and_belongs_to_many :categories
    #   end
    #
169
    # The project class now has the following methods (and more) to ease the traversal and
170
    # manipulation of its relationships:
171
    # * <tt>Project#portfolio, Project#portfolio=(portfolio), Project#portfolio.nil?</tt>
D
Initial  
David Heinemeier Hansson 已提交
172 173
    # * <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>
174
    #   <tt>Project#milestones.delete(milestone), Project#milestones.find(milestone_id), Project#milestones.find(:all, options),</tt>
D
Initial  
David Heinemeier Hansson 已提交
175 176 177 178
    #   <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>
    #
179 180
    # === A word of warning
    #
181 182
    # 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
183
    # its model, it will override the inherited method and break things.
P
Pratik Naik 已提交
184
    # For instance, +attributes+ and +connection+ would be bad choices for association names.
185
    #
186
    # == Auto-generated methods
D
Initial  
David Heinemeier Hansson 已提交
187
    #
188
    # === Singular associations (one-to-one)
189 190 191
    #                                     |            |  belongs_to  |
    #   generated methods                 | belongs_to | :polymorphic | has_one
    #   ----------------------------------+------------+--------------+---------
P
Pratik Naik 已提交
192 193 194 195 196
    #   other                             |     X      |      X       |    X
    #   other=(other)                     |     X      |      X       |    X
    #   build_other(attributes={})        |     X      |              |    X
    #   create_other(attributes={})       |     X      |              |    X
    #   other.create!(attributes={})      |            |              |    X
197 198 199
    #
    # ===Collection associations (one-to-many / many-to-many)
    #                                     |       |          | has_many
200
    #   generated methods                 | habtm | has_many | :through
201
    #   ----------------------------------+-------+----------+----------
P
Pratik Naik 已提交
202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225
    #   others                            |   X   |    X     |    X
    #   others=(other,other,...)          |   X   |    X     |    X
    #   other_ids                         |   X   |    X     |    X
    #   other_ids=(id,id,...)             |   X   |    X     |    X
    #   others<<                          |   X   |    X     |    X
    #   others.push                       |   X   |    X     |    X
    #   others.concat                     |   X   |    X     |    X
    #   others.build(attributes={})       |   X   |    X     |    X
    #   others.create(attributes={})      |   X   |    X     |    X
    #   others.create!(attributes={})     |   X   |    X     |    X
    #   others.size                       |   X   |    X     |    X
    #   others.length                     |   X   |    X     |    X
    #   others.count                      |   X   |    X     |    X
    #   others.sum(args*,&block)          |   X   |    X     |    X
    #   others.empty?                     |   X   |    X     |    X
    #   others.clear                      |   X   |    X     |    X
    #   others.delete(other,other,...)    |   X   |    X     |    X
    #   others.delete_all                 |   X   |    X     |
    #   others.destroy_all                |   X   |    X     |    X
    #   others.find(*args)                |   X   |    X     |    X
    #   others.find_first                 |   X   |          |
    #   others.exists?                    |   X   |    X     |    X
    #   others.uniq                       |   X   |    X     |    X
    #   others.reset                      |   X   |    X     |    X
D
Initial  
David Heinemeier Hansson 已提交
226
    #
227
    # == Cardinality and associations
228
    #
P
Pratik Naik 已提交
229
    # Active Record associations can be used to describe one-to-one, one-to-many and many-to-many
P
Pratik Naik 已提交
230 231
    # 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
232
    # the foreign key.
233 234 235
    #
    # === One-to-one
    #
236
    # Use +has_one+ in the base, and +belongs_to+ in the associated model.
237 238 239 240 241 242 243 244 245 246
    #
    #   class Employee < ActiveRecord::Base
    #     has_one :office
    #   end
    #   class Office < ActiveRecord::Base
    #     belongs_to :employee    # foreign key - employee_id
    #   end
    #
    # === One-to-many
    #
247
    # Use +has_many+ in the base, and +belongs_to+ in the associated model.
248 249 250 251 252
    #
    #   class Manager < ActiveRecord::Base
    #     has_many :employees
    #   end
    #   class Employee < ActiveRecord::Base
253
    #     belongs_to :manager     # foreign key - manager_id
254 255 256 257 258 259
    #   end
    #
    # === Many-to-many
    #
    # There are two ways to build a many-to-many relationship.
    #
260
    # The first way uses a +has_many+ association with the <tt>:through</tt> option and a join model, so
261 262 263 264 265 266 267 268 269 270 271 272 273 274 275
    # 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
    #
276
    # For the second way, use +has_and_belongs_to_many+ in both models. This requires a join table
277 278 279 280 281 282 283 284 285
    # 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
    #
286
    # Choosing which way to build a many-to-many relationship is not always simple.
287
    # If you need to work with the relationship model as its own entity,
288
    # use <tt>has_many :through</tt>. Use +has_and_belongs_to_many+ when working with legacy schemas or when
289 290
    # you never work directly with the relationship itself.
    #
291
    # == Is it a +belongs_to+ or +has_one+ association?
D
Initial  
David Heinemeier Hansson 已提交
292
    #
293
    # Both express a 1-1 relationship. The difference is mostly where to place the foreign
294
    # key, which goes on the table for the class declaring the +belongs_to+ relationship.
D
Initial  
David Heinemeier Hansson 已提交
295
    #
296 297 298
    #   class User < ActiveRecord::Base
    #     # I reference an account.
    #     belongs_to :account
D
Initial  
David Heinemeier Hansson 已提交
299 300
    #   end
    #
301 302 303
    #   class Account < ActiveRecord::Base
    #     # One user references me.
    #     has_one :user
D
Initial  
David Heinemeier Hansson 已提交
304 305 306 307
    #   end
    #
    # The tables for these classes could look something like:
    #
308
    #   CREATE TABLE users (
D
Initial  
David Heinemeier Hansson 已提交
309
    #     id int(11) NOT NULL auto_increment,
310 311
    #     account_id int(11) default NULL,
    #     name varchar default NULL,
D
Initial  
David Heinemeier Hansson 已提交
312 313 314
    #     PRIMARY KEY  (id)
    #   )
    #
315
    #   CREATE TABLE accounts (
D
Initial  
David Heinemeier Hansson 已提交
316 317 318 319 320
    #     id int(11) NOT NULL auto_increment,
    #     name varchar default NULL,
    #     PRIMARY KEY  (id)
    #   )
    #
321 322
    # == Unsaved objects and associations
    #
323 324
    # 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
325
    # associated objects.
326
    #
327
    # You can set the :autosave option on a <tt>has_one</tt>, <tt>belongs_to</tt>,
328 329
    # <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
330
    # _never_ save the members. More details about :autosave option is available at
331
    # autosave_association.rb .
332
    #
333 334
    # === One-to-one associations
    #
335 336
    # * Assigning an object to a +has_one+ association automatically saves that object and
    # the object being replaced (if there is one), in order to update their primary
337
    # keys - except if the parent object is unsaved (<tt>new_record? == true</tt>).
338
    # * If either of these saves fail (due to one of the objects being invalid) the assignment
339
    # statement returns +false+ and the assignment is cancelled.
340
    # * If you wish to assign an object to a +has_one+ association without saving it,
341
    # use the <tt>association.build</tt> method (documented below).
342
    # * Assigning an object to a +belongs_to+ association does not save the object, since
343
    # the foreign key field belongs on the parent. It does not save the parent either.
344 345 346
    #
    # === Collections
    #
347 348
    # * Adding an object to a collection (+has_many+ or +has_and_belongs_to_many+) automatically
    # saves that object, except if the parent object (the owner of the collection) is not yet
349
    # stored in the database.
350
    # * If saving any of the objects being added to a collection (via <tt>push</tt> or similar)
351
    # fails, then <tt>push</tt> returns +false+.
352
    # * You can add an object to a collection without automatically saving it by using the
353
    # <tt>collection.build</tt> method (documented below).
354
    # * All unsaved (<tt>new_record? == true</tt>) members of the collection are automatically
355
    # saved when the parent is saved.
356
    #
357
    # === Association callbacks
358
    #
359
    # Similar to the normal callbacks that hook into the life cycle of an Active Record object,
360
    # you can also define callbacks that get triggered when you add an object to or remove an
361
    # object from an association collection.
362 363 364 365 366 367 368
    #
    #   class Project
    #     has_and_belongs_to_many :developers, :after_add => :evaluate_velocity
    #
    #     def evaluate_velocity(developer)
    #       ...
    #     end
369
    #   end
370 371
    #
    # It's possible to stack callbacks by passing them as an array. Example:
372
    #
373
    #   class Project
374
    #     has_and_belongs_to_many :developers,
375
    #                             :after_add => [:evaluate_velocity, Proc.new { |p, d| p.shipping_date = Time.now}]
376 377
    #   end
    #
378
    # Possible callbacks are: +before_add+, +after_add+, +before_remove+ and +after_remove+.
379
    #
380 381
    # 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
382
    # thrown the object doesn't get removed.
383
    #
384 385
    # === Association extensions
    #
386 387
    # 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
388
    # factory-type methods that are only used as part of this association.
389 390
    #
    #   class Account < ActiveRecord::Base
391
    #     has_many :people do
392
    #       def find_or_create_by_name(name)
393
    #         first_name, last_name = name.split(" ", 2)
D
David Heinemeier Hansson 已提交
394
    #         find_or_create_by_first_name_and_last_name(first_name, last_name)
395
    #       end
396
    #     end
397 398 399 400 401 402
    #   end
    #
    #   person = Account.find(:first).people.find_or_create_by_name("David Heinemeier Hansson")
    #   person.first_name # => "David"
    #   person.last_name  # => "Heinemeier Hansson"
    #
403 404
    # If you need to share the same extensions between many associations, you can use a named
    # extension module.
405 406 407
    #
    #   module FindOrCreateByNameExtension
    #     def find_or_create_by_name(name)
408
    #       first_name, last_name = name.split(" ", 2)
D
David Heinemeier Hansson 已提交
409
    #       find_or_create_by_first_name_and_last_name(first_name, last_name)
410 411 412 413 414 415 416 417 418 419
    #     end
    #   end
    #
    #   class Account < ActiveRecord::Base
    #     has_many :people, :extend => FindOrCreateByNameExtension
    #   end
    #
    #   class Company < ActiveRecord::Base
    #     has_many :people, :extend => FindOrCreateByNameExtension
    #   end
420
    #
421
    # If you need to use multiple named extension modules, you can specify an array of modules
422
    # with the <tt>:extend</tt> option.
423 424
    # In the case of name conflicts between methods in the modules, methods in modules later
    # in the array supercede those earlier in the array.
425 426 427 428 429
    #
    #   class Account < ActiveRecord::Base
    #     has_many :people, :extend => [FindOrCreateByNameExtension, FindRecentExtension]
    #   end
    #
430 431
    # Some extensions can only be made to work with knowledge of the association proxy's internals.
    # Extensions can access relevant state using accessors on the association proxy:
432
    #
433 434
    # * +proxy_owner+ - Returns the object the association is part of.
    # * +proxy_reflection+ - Returns the reflection object that describes the association.
435
    # * +proxy_target+ - Returns the associated object for +belongs_to+ and +has_one+, or
436
    #   the collection of associated objects for +has_many+ and +has_and_belongs_to_many+.
437
    #
R
Rick Olson 已提交
438
    # === Association Join Models
439
    #
440 441
    # Has Many associations can be configured with the <tt>:through</tt> option to use an
    # explicit join model to retrieve the data.  This operates similarly to a
442
    # +has_and_belongs_to_many+ association.  The advantage is that you're able to add validations,
443
    # callbacks, and extra attributes on the join model.  Consider the following schema:
444
    #
445 446 447 448
    #   class Author < ActiveRecord::Base
    #     has_many :authorships
    #     has_many :books, :through => :authorships
    #   end
449
    #
450 451 452 453
    #   class Authorship < ActiveRecord::Base
    #     belongs_to :author
    #     belongs_to :book
    #   end
454
    #
455
    #   @author = Author.find :first
456
    #   @author.authorships.collect { |a| a.book } # selects all books that the author's authorships belong to
457
    #   @author.books                              # selects all books by using the Authorship join model
458
    #
459
    # You can also go through a +has_many+ association on the join model:
460
    #
461 462 463 464
    #   class Firm < ActiveRecord::Base
    #     has_many   :clients
    #     has_many   :invoices, :through => :clients
    #   end
465
    #
466 467 468 469
    #   class Client < ActiveRecord::Base
    #     belongs_to :firm
    #     has_many   :invoices
    #   end
470
    #
471 472 473 474 475 476
    #   class Invoice < ActiveRecord::Base
    #     belongs_to :client
    #   end
    #
    #   @firm = Firm.find :first
    #   @firm.clients.collect { |c| c.invoices }.flatten # select all invoices for all clients of the firm
477
    #   @firm.invoices                                   # selects all invoices by going through the Client join model
478
    #
479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498
    # 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.
    #
499 500
    # An important caveat with going through +has_one+ or +has_many+ associations on the
    # join model is that these associations are *read-only*.  For example, the following
501
    # would not work following the previous example:
502
    #
503
    #   @group.avatars << Avatar.new   # this would work if User belonged_to Avatar rather than the other way around
504 505
    #   @group.avatars.delete(@group.avatars.last)  # so would this
    #
R
Rick Olson 已提交
506
    # === Polymorphic Associations
507
    #
508 509
    # Polymorphic associations on models are not restricted on what types of models they
    # can be associated with.  Rather, they specify an interface that a +has_many+ association
510
    # must adhere to.
511
    #
R
Rick Olson 已提交
512 513 514
    #   class Asset < ActiveRecord::Base
    #     belongs_to :attachable, :polymorphic => true
    #   end
515
    #
R
Rick Olson 已提交
516
    #   class Post < ActiveRecord::Base
517
    #     has_many :assets, :as => :attachable         # The :as option specifies the polymorphic interface to use.
R
Rick Olson 已提交
518 519 520
    #   end
    #
    #   @asset.attachable = @post
521
    #
522 523
    # This works by using a type column in addition to a foreign key to specify the associated
    # record.  In the Asset example, you'd need an +attachable_id+ integer column and an
524
    # +attachable_type+ string column.
R
Rick Olson 已提交
525
    #
526 527 528
    # 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
529
    # association. To continue with the asset example above, suppose there are guest posts
530
    # and member posts that use the posts table for STI. In this case, there must be a +type+
531
    # column in the posts table.
D
David Heinemeier Hansson 已提交
532 533 534
    #
    #   class Asset < ActiveRecord::Base
    #     belongs_to :attachable, :polymorphic => true
535
    #
D
David Heinemeier Hansson 已提交
536 537 538 539
    #     def attachable_type=(sType)
    #        super(sType.to_s.classify.constantize.base_class.to_s)
    #     end
    #   end
540
    #
D
David Heinemeier Hansson 已提交
541 542 543 544 545
    #   class Post < ActiveRecord::Base
    #     # because we store "Post" in attachable_type now :dependent => :destroy will work
    #     has_many :assets, :as => :attachable, :dependent => :destroy
    #   end
    #
546
    #   class GuestPost < Post
D
David Heinemeier Hansson 已提交
547 548
    #   end
    #
549
    #   class MemberPost < Post
D
David Heinemeier Hansson 已提交
550 551
    #   end
    #
D
Initial  
David Heinemeier Hansson 已提交
552 553
    # == Caching
    #
554 555
    # 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
556 557
    # 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 已提交
558 559 560 561 562 563 564
    #
    #   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
    #
565 566
    # == Eager loading of associations
    #
567 568 569
    # 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
570
    # use of eager loading, the 101 queries can be reduced to 2.
571 572 573 574 575 576 577 578
    #
    #   class Post < ActiveRecord::Base
    #     belongs_to :author
    #     has_many   :comments
    #   end
    #
    # Consider the following loop using the class above:
    #
P
Pratik Naik 已提交
579
    #   for post in Post.all
580 581 582
    #     puts "Post:            " + post.title
    #     puts "Written by:      " + post.author.name
    #     puts "Last comment on: " + post.comments.first.created_on
583
    #   end
584
    #
585
    # To iterate over these one hundred posts, we'll generate 201 database queries. Let's
586
    # first just optimize it for retrieving the author:
587
    #
588
    #   for post in Post.find(:all, :include => :author)
589
    #
590 591 592
    # 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
593
    # from 201 to 102.
594 595 596
    #
    # We can improve upon the situation further by referencing both associations in the finder with:
    #
597
    #   for post in Post.find(:all, :include => [ :author, :comments ])
598
    #
599 600
    # 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
601
    # named (except if some of the associations are polymorphic +belongs_to+ - see below).
602
    #
603
    # To include a deep hierarchy of associations, use a hash:
604 605 606
    #
    #   for post in Post.find(:all, :include => [ :author, { :comments => { :author => :gravatar } } ])
    #
607 608
    # 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
609
    # associations you want to load.
610
    #
611 612 613 614
    # 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
615
    # cut down on the number of queries in a situation as the one described above.
616
    #
617 618
    # 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
619
    # used LEFT OUTER JOIN based strategy. For example
620
    #
E
Emilio Tagua 已提交
621
    #   Post.includes([:author, :comments]).where(['comments.approved = ?', true]).all
622
    #
623
    # This will result in a single SQL query with joins along the lines of:
624
    # <tt>LEFT OUTER JOIN comments ON comments.post_id = posts.id</tt> and
625
    # <tt>LEFT OUTER JOIN authors ON authors.id = posts.author_id</tt>. Note that using conditions
626
    # like this can have unintended consequences.
627 628
    # 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.
629
    # You must disambiguate column references for this fallback to happen, for example
630
    # <tt>:order => "author.name DESC"</tt> will work but <tt>:order => "name DESC"</tt> will not.
P
Pratik Naik 已提交
631
    #
632
    # If you do want eager load only some members of an association it is usually more natural
633
    # to <tt>:include</tt> an association which has conditions defined on it:
P
Pratik Naik 已提交
634 635 636 637 638 639 640
    #
    #   class Post < ActiveRecord::Base
    #     has_many :approved_comments, :class_name => 'Comment', :conditions => ['approved = ?', true]
    #   end
    #
    #   Post.find(:all, :include => :approved_comments)
    #
641
    # This will load posts and eager load the +approved_comments+ association, which contains
642
    # only those comments that have been approved.
643
    #
644
    # If you eager load an association with a specified <tt>:limit</tt> option, it will be ignored,
645
    # returning all the associated objects:
646 647 648 649 650 651 652
    #
    #   class Picture < ActiveRecord::Base
    #     has_many :most_recent_comments, :class_name => 'Comment', :order => 'id DESC', :limit => 10
    #   end
    #
    #   Picture.find(:first, :include => :most_recent_comments).most_recent_comments # => returns all associated comments.
    #
653
    # When eager loaded, conditions are interpolated in the context of the model class, not
654
    # the model instance.  Conditions are lazily interpolated before the actual model exists.
655
    #
P
Pratik Naik 已提交
656
    # Eager loading is supported with polymorphic associations.
657 658 659 660 661
    #
    #   class Address < ActiveRecord::Base
    #     belongs_to :addressable, :polymorphic => true
    #   end
    #
P
Pratik Naik 已提交
662
    # A call that tries to eager load the addressable model
663
    #
P
Pratik Naik 已提交
664
    #   Address.find(:all, :include => :addressable)
665
    #
666
    # This will execute one query to load the addresses and load the addressables with one
667
    # query per addressable type.
668 669
    # 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
670
    # the back of the addresses loaded. This is not supported if Active Record has to fallback
671 672
    # 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
673
    # name cannot be put in the +FROM+/+JOIN+ clauses of that query.
674
    #
675 676
    # == Table Aliasing
    #
677 678 679
    # Active Record uses table aliasing in the case that a table is referenced multiple times
    # in a join.  If a table is referenced only once, the standard table name is used.  The
    # second time, the table is aliased as <tt>#{reflection_name}_#{parent_table_name}</tt>.
680
    # Indexes are appended for any more successive uses of the table name.
681
    #
P
Pratik Naik 已提交
682 683 684 685 686 687
    #   Post.find :all, :joins => :comments
    #   # => SELECT ... FROM posts INNER JOIN comments ON ...
    #   Post.find :all, :joins => :special_comments # STI
    #   # => SELECT ... FROM posts INNER JOIN comments ON ... AND comments.type = 'SpecialComment'
    #   Post.find :all, :joins => [:comments, :special_comments] # special_comments is the reflection name, posts is the parent table name
    #   # => SELECT ... FROM posts INNER JOIN comments ON ... INNER JOIN comments special_comments_posts
688
    #
689
    # Acts as tree example:
690
    #
P
Pratik Naik 已提交
691 692 693 694 695 696 697 698 699
    #   TreeMixin.find :all, :joins => :children
    #   # => SELECT ... FROM mixins INNER JOIN mixins childrens_mixins ...
    #   TreeMixin.find :all, :joins => {:children => :parent}
    #   # => SELECT ... FROM mixins INNER JOIN mixins childrens_mixins ...
    #                               INNER JOIN parents_mixins ...
    #   TreeMixin.find :all, :joins => {:children => {:parent => :children}}
    #   # => SELECT ... FROM mixins INNER JOIN mixins childrens_mixins ...
    #                               INNER JOIN parents_mixins ...
    #                               INNER JOIN mixins childrens_mixins_2
700
    #
701
    # Has and Belongs to Many join tables use the same idea, but add a <tt>_join</tt> suffix:
702
    #
P
Pratik Naik 已提交
703 704 705 706 707 708 709 710 711
    #   Post.find :all, :joins => :categories
    #   # => SELECT ... FROM posts INNER JOIN categories_posts ... INNER JOIN categories ...
    #   Post.find :all, :joins => {:categories => :posts}
    #   # => SELECT ... FROM posts INNER JOIN categories_posts ... INNER JOIN categories ...
    #                              INNER JOIN categories_posts posts_categories_join INNER JOIN posts posts_categories
    #   Post.find :all, :joins => {:categories => {:posts => :categories}}
    #   # => SELECT ... FROM posts INNER JOIN categories_posts ... INNER JOIN categories ...
    #                              INNER JOIN categories_posts posts_categories_join INNER JOIN posts posts_categories
    #                              INNER JOIN categories_posts categories_posts_join INNER JOIN categories categories_posts_2
712
    #
713
    # If you wish to specify your own custom joins using a <tt>:joins</tt> option, those table
714
    # names will take precedence over the eager associations:
715
    #
P
Pratik Naik 已提交
716 717 718 719 720
    #   Post.find :all, :joins => :comments, :joins => "inner join comments ..."
    #   # => SELECT ... FROM posts INNER JOIN comments_posts ON ... INNER JOIN comments ...
    #   Post.find :all, :joins => [:comments, :special_comments], :joins => "inner join comments ..."
    #   # => SELECT ... FROM posts INNER JOIN comments comments_posts ON ...
    #                              INNER JOIN comments special_comments_posts ...
721
    #                              INNER JOIN comments ...
722
    #
723
    # Table aliases are automatically truncated according to the maximum length of table identifiers
724
    # according to the specific database.
725
    #
D
Initial  
David Heinemeier Hansson 已提交
726 727 728 729 730 731 732 733 734 735
    # == 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 已提交
736
    #       class Client < ActiveRecord::Base; end
D
Initial  
David Heinemeier Hansson 已提交
737 738 739
    #     end
    #   end
    #
740
    # When <tt>Firm#clients</tt> is called, it will in turn call
741
    # <tt>MyApplication::Business::Client.find_all_by_firm_id(firm.id)</tt>.
742
    # If you want to associate with a class in another module scope, this can be done by
743
    # specifying the complete class name.
D
Initial  
David Heinemeier Hansson 已提交
744 745 746 747 748 749 750 751 752 753 754 755 756
    #
    #   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 已提交
757 758
    # == Bi-directional associations
    #
759
    # When you specify an association there is usually an association on the associated model
760
    # that specifies the same relationship in reverse.  For example, with the following models:
P
Pratik Naik 已提交
761 762 763 764 765 766 767 768 769 770 771 772 773 774
    #
    #    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
    #
775 776
    # The +traps+ association on +Dungeon+ and the the +dungeon+ association on +Trap+ are
    # the inverse of each other and the inverse of the +dungeon+ association on +EvilWizard+
777
    # is the +evil_wizard+ association on +Dungeon+ (and vice-versa).  By default,
778
    # Active Record doesn't know anything about these inverse relationships and so no object
779
    # loading optimisation is possible.  For example:
P
Pratik Naik 已提交
780 781 782 783 784 785 786
    #
    #    d = Dungeon.first
    #    t = d.traps.first
    #    d.level == t.dungeon.level # => true
    #    d.level = 10
    #    d.level == t.dungeon.level # => false
    #
787 788
    # 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
789
    # of that data.  Specifying the <tt>:inverse_of</tt> option on associations lets you tell
790
    # Active Record about inverse relationships and it will optimise object loading.  For
791
    # example, if we changed our model definitions to:
P
Pratik Naik 已提交
792 793 794 795 796 797 798 799 800 801 802 803 804 805
    #
    #    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
    #
806
    # Then, from our code snippet above, +d+ and <tt>t.dungeon</tt> are actually the same
807
    # in-memory instance and our final <tt>d.level == t.dungeon.level</tt> will return +true+.
P
Pratik Naik 已提交
808 809 810 811 812 813 814
    #
    # 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.
    #
815
    # == Type safety with <tt>ActiveRecord::AssociationTypeMismatch</tt>
D
Initial  
David Heinemeier Hansson 已提交
816
    #
817
    # If you attempt to assign an object to an association that doesn't match the inferred
818
    # or specified <tt>:class_name</tt>, you'll get an <tt>ActiveRecord::AssociationTypeMismatch</tt>.
D
Initial  
David Heinemeier Hansson 已提交
819 820 821
    #
    # == Options
    #
822
    # All of the association macros can be specialized through options. This makes cases
823
    # more complex than the simple and guessable ones possible.
D
Initial  
David Heinemeier Hansson 已提交
824
    module ClassMethods
P
Pratik Naik 已提交
825 826 827 828 829
      # 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 已提交
830
      #   An empty array is returned if none are found.
P
Pratik Naik 已提交
831 832
      # [collection<<(object, ...)]
      #   Adds one or more objects to the collection by setting their foreign keys to the collection's primary key.
833
      #   Note that this operation instantly fires update sql without waiting for the save or update call on the
834
      #   parent object.
P
Pratik Naik 已提交
835 836
      # [collection.delete(object, ...)]
      #   Removes one or more objects from the collection by setting their foreign keys to +NULL+.
837 838
      #   Objects will be in addition destroyed if they're associated with <tt>:dependent => :destroy</tt>,
      #   and deleted if they're associated with <tt>:dependent => :delete_all</tt>.
P
Pratik Naik 已提交
839
      # [collection=objects]
840 841 842
      #   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 已提交
843 844 845
      # [collection_singular_ids]
      #   Returns an array of the associated objects' ids
      # [collection_singular_ids=ids]
846 847
      #   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 已提交
848 849 850 851
      # [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+.
852 853
      #   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 已提交
854 855 856 857 858 859
      # [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 已提交
860
      # [collection.exists?(...)]
P
Pratik Naik 已提交
861 862 863 864 865
      #   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 已提交
866
      #   been saved.
P
Pratik Naik 已提交
867 868 869
      # [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 已提交
870 871
      #   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 已提交
872 873 874 875 876
      #
      # (*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 已提交
877
      #
P
Pratik Naik 已提交
878 879
      # Example: A Firm class declares <tt>has_many :clients</tt>, which will add:
      # * <tt>Firm#clients</tt> (similar to <tt>Clients.find :all, :conditions => ["firm_id = ?", id]</tt>)
D
Initial  
David Heinemeier Hansson 已提交
880 881
      # * <tt>Firm#clients<<</tt>
      # * <tt>Firm#clients.delete</tt>
882
      # * <tt>Firm#clients=</tt>
883
      # * <tt>Firm#client_ids</tt>
884
      # * <tt>Firm#client_ids=</tt>
D
Initial  
David Heinemeier Hansson 已提交
885 886 887
      # * <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>)
888
      # * <tt>Firm#clients.find</tt> (similar to <tt>Client.find(id, :conditions => "firm_id = #{id}")</tt>)
P
Pratik Naik 已提交
889
      # * <tt>Firm#clients.exists?(:name => 'ACME')</tt> (similar to <tt>Client.exists?(:name => 'ACME', :firm_id => firm.id)</tt>)
D
Initial  
David Heinemeier Hansson 已提交
890
      # * <tt>Firm#clients.build</tt> (similar to <tt>Client.new("firm_id" => id)</tt>)
D
David Heinemeier Hansson 已提交
891
      # * <tt>Firm#clients.create</tt> (similar to <tt>c = Client.new("firm_id" => id); c.save; c</tt>)
D
Initial  
David Heinemeier Hansson 已提交
892
      # The declaration can also include an options hash to specialize the behavior of the association.
893
      #
P
Pratik Naik 已提交
894 895 896
      # === Supported options
      # [:class_name]
      #   Specify the class name of the association. Use it only if that name can't be inferred
897 898
      #   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
899
      #   specify it with this option.
P
Pratik Naik 已提交
900 901
      # [:conditions]
      #   Specify the conditions that the associated objects must meet in order to be included as a +WHERE+
902 903 904
      #   SQL fragment, such as <tt>price > 5 AND name LIKE 'B%'</tt>.  Record creations from
      #   the association are scoped if a hash is used.
      #   <tt>has_many :posts, :conditions => {:published => true}</tt> will create published
905
      #   posts with <tt>@blog.posts.create</tt> or <tt>@blog.posts.build</tt>.
P
Pratik Naik 已提交
906 907
      # [:order]
      #   Specify the order in which the associated objects are returned as an <tt>ORDER BY</tt> SQL fragment,
P
Pratik Naik 已提交
908
      #   such as <tt>last_name, first_name DESC</tt>.
P
Pratik Naik 已提交
909 910
      # [:foreign_key]
      #   Specify the foreign key used for the association. By default this is guessed to be the name
911
      #   of this class in lower-case and "_id" suffixed. So a Person class that makes a +has_many+
912
      #   association will use "person_id" as the default <tt>:foreign_key</tt>.
P
Pratik Naik 已提交
913 914 915 916
      # [:primary_key]
      #   Specify the method that returns the primary key used for the association. By default this is +id+.
      # [:dependent]
      #   If set to <tt>:destroy</tt> all the associated objects are destroyed
P
Pratik Naik 已提交
917 918
      #   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
919 920 921 922 923
      #   objects' foreign keys are set to +NULL+ *without* calling their +save+ callbacks. If set to
      #   <tt>:restrict</tt> this object cannot be deleted if it has any associated object.
      #
      #   *Warning:* This option is ignored when used with <tt>:through</tt> option.
      #
P
Pratik Naik 已提交
924 925
      # [:finder_sql]
      #   Specify a complete SQL statement to fetch the association. This is a good way to go for complex
926
      #   associations that depend on multiple tables. Note: When this option is used, +find_in_collection+
927
      #   is _not_ added.
P
Pratik Naik 已提交
928 929
      # [:counter_sql]
      #   Specify a complete SQL statement to fetch the size of the association. If <tt>:finder_sql</tt> is
930
      #   specified but not <tt>:counter_sql</tt>, <tt>:counter_sql</tt> will be generated by
931
      #   replacing <tt>SELECT ... FROM</tt> with <tt>SELECT COUNT(*) FROM</tt>.
P
Pratik Naik 已提交
932 933 934 935 936 937
      # [: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.
938
      # [:having]
939
      #   Combined with +:group+ this can be used to filter the records that a <tt>GROUP BY</tt>
940
      #   returns. Uses the <tt>HAVING</tt> SQL-clause.
P
Pratik Naik 已提交
941 942 943
      # [:limit]
      #   An integer determining the limit on the number of rows that should be returned.
      # [:offset]
944
      #   An integer determining the offset from where the rows should be fetched. So at 5,
945
      #   it would skip the first 4 rows.
P
Pratik Naik 已提交
946
      # [:select]
947 948
      #   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
949
      #   to include the primary and foreign keys, otherwise it will raise an error.
P
Pratik Naik 已提交
950 951 952
      # [:as]
      #   Specifies a polymorphic interface (See <tt>belongs_to</tt>).
      # [:through]
953 954 955 956 957
      #   Specifies a join model through which to perform the query.  Options for <tt>:class_name</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>belongs_to</tt>, <tt>has_one</tt>
      #   or <tt>has_many</tt> association on the join model. The collection of join models
      #   can be managed via the collection API. For example, new join models are created for
958
      #   newly associated objects, and if some are gone their rows are deleted (directly,
959
      #   no destroy callbacks are triggered).
P
Pratik Naik 已提交
960
      # [:source]
961 962
      #   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.
963
      #   <tt>has_many :subscribers, :through => :subscriptions</tt> will look for either <tt>:subscribers</tt> or
P
Pratik Naik 已提交
964
      #   <tt>:subscriber</tt> on Subscription, unless a <tt>:source</tt> is given.
P
Pratik Naik 已提交
965 966
      # [:source_type]
      #   Specifies type of the source association used by <tt>has_many :through</tt> queries where the source
967
      #   association is a polymorphic +belongs_to+.
P
Pratik Naik 已提交
968 969 970 971 972
      # [: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]
973
      #   If +false+, don't validate the associated objects when saving the parent object. true by default.
974
      # [:autosave]
975
      #   If true, always save the associated objects or destroy them if marked for destruction,
976
      #   when saving the parent object. If false, never save or destroy the associated objects.
977
      #   By default, only save associated objects that are new records.
P
Pratik Naik 已提交
978
      # [:inverse_of]
979 980
      #   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
981
      #   with <tt>:through</tt> or <tt>:as</tt> options.
982
      #   See ActiveRecord::Associations::ClassMethods's overview on Bi-directional associations for more detail.
983
      #
D
Initial  
David Heinemeier Hansson 已提交
984 985
      # Option examples:
      #   has_many :comments, :order => "posted_on"
986
      #   has_many :comments, :include => :author
D
Initial  
David Heinemeier Hansson 已提交
987
      #   has_many :people, :class_name => "Person", :conditions => "deleted = 0", :order => "name"
988 989
      #   has_many :tracks, :order => "position", :dependent => :destroy
      #   has_many :comments, :dependent => :nullify
R
Rick Olson 已提交
990
      #   has_many :tags, :as => :taggable
991
      #   has_many :reports, :readonly => true
992
      #   has_many :subscribers, :through => :subscriptions, :source => :user
D
Initial  
David Heinemeier Hansson 已提交
993 994 995 996 997
      #   has_many :subscribers, :class_name => "Person", :finder_sql =>
      #       'SELECT DISTINCT people.* ' +
      #       'FROM people p, post_subscriptions ps ' +
      #       'WHERE ps.post_id = #{id} AND ps.person_id = p.id ' +
      #       'ORDER BY p.first_name'
998
      def has_many(association_id, options = {}, &extension)
999 1000
        reflection = create_has_many_reflection(association_id, options, &extension)
        configure_dependency_for_has_many(reflection)
1001 1002
        add_association_callbacks(reflection.name, reflection.options)

1003
        if options[:through]
1004
          collection_accessor_methods(reflection, HasManyThroughAssociation)
1005 1006
        else
          collection_accessor_methods(reflection, HasManyAssociation)
D
Initial  
David Heinemeier Hansson 已提交
1007 1008 1009
        end
      end

P
Pratik Naik 已提交
1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020
      # 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 已提交
1021
      #   and saves the associate object.
P
Pratik Naik 已提交
1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033
      # [build_association(attributes = {})]
      #   Returns a new object of the associated type that has been instantiated
      #   with +attributes+ and linked to this object through a foreign key, but has not
      #   yet been saved. <b>Note:</b> This ONLY works if an association already exists.
      #   It will NOT work if the association is +nil+.
      # [create_association(attributes = {})]
      #   Returns a new object of the associated type that has been instantiated
      #   with +attributes+, linked to this object through a foreign key, and that
      #   has already been saved (if it passed the validation).
      #
      # (+association+ is replaced with the symbol passed as the first argument, so
      # <tt>has_one :manager</tt> would add among others <tt>manager.nil?</tt>.)
D
Initial  
David Heinemeier Hansson 已提交
1034
      #
P
Pratik Naik 已提交
1035 1036 1037
      # === Example
      #
      # An Account class declares <tt>has_one :beneficiary</tt>, which will add:
1038
      # * <tt>Account#beneficiary</tt> (similar to <tt>Beneficiary.find(:first, :conditions => "account_id = #{id}")</tt>)
D
Initial  
David Heinemeier Hansson 已提交
1039
      # * <tt>Account#beneficiary=(beneficiary)</tt> (similar to <tt>beneficiary.account_id = account.id; beneficiary.save</tt>)
1040 1041 1042
      # * <tt>Account#build_beneficiary</tt> (similar to <tt>Beneficiary.new("account_id" => id)</tt>)
      # * <tt>Account#create_beneficiary</tt> (similar to <tt>b = Beneficiary.new("account_id" => id); b.save; b</tt>)
      #
P
Pratik Naik 已提交
1043 1044
      # === Options
      #
D
Initial  
David Heinemeier Hansson 已提交
1045
      # The declaration can also include an options hash to specialize the behavior of the association.
1046
      #
D
Initial  
David Heinemeier Hansson 已提交
1047
      # Options are:
P
Pratik Naik 已提交
1048 1049
      # [:class_name]
      #   Specify the class name of the association. Use it only if that name can't be inferred
P
Pratik Naik 已提交
1050 1051
      #   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 已提交
1052 1053
      # [:conditions]
      #   Specify the conditions that the associated object must meet in order to be included as a +WHERE+
1054
      #   SQL fragment, such as <tt>rank = 5</tt>. Record creation from the association is scoped if a hash
1055
      #   is used. <tt>has_one :account, :conditions => {:enabled => true}</tt> will create
1056
      #   an enabled account with <tt>@company.create_account</tt> or <tt>@company.build_account</tt>.
P
Pratik Naik 已提交
1057 1058
      # [:order]
      #   Specify the order in which the associated objects are returned as an <tt>ORDER BY</tt> SQL fragment,
P
Pratik Naik 已提交
1059
      #   such as <tt>last_name, first_name DESC</tt>.
P
Pratik Naik 已提交
1060 1061
      # [:dependent]
      #   If set to <tt>:destroy</tt>, the associated object is destroyed when this object is. If set to
1062 1063
      #   <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+.
1064
      #   Also, association is assigned.
P
Pratik Naik 已提交
1065 1066
      # [:foreign_key]
      #   Specify the foreign key used for the association. By default this is guessed to be the name
1067
      #   of this class in lower-case and "_id" suffixed. So a Person class that makes a +has_one+ association
1068
      #   will use "person_id" as the default <tt>:foreign_key</tt>.
P
Pratik Naik 已提交
1069 1070 1071 1072 1073 1074 1075
      # [: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]
1076 1077
      #   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
1078
      #   primary and foreign keys, otherwise it will raise an error.
P
Pratik Naik 已提交
1079
      # [:through]
1080 1081 1082
      #   Specifies a Join Model through which to perform the query.  Options for <tt>:class_name</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>
1083
      #   association on the join model.
P
Pratik Naik 已提交
1084
      # [:source]
1085 1086
      #   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.
1087
      #   <tt>has_one :favorite, :through => :favorites</tt> will look for a
1088
      #   <tt>:favorite</tt> on Favorite, unless a <tt>:source</tt> is given.
P
Pratik Naik 已提交
1089 1090
      # [:source_type]
      #   Specifies type of the source association used by <tt>has_one :through</tt> queries where the source
1091
      #   association is a polymorphic +belongs_to+.
P
Pratik Naik 已提交
1092 1093 1094
      # [:readonly]
      #   If true, the associated object is readonly through the association.
      # [:validate]
1095
      #   If +false+, don't validate the associated object when saving the parent object. +false+ by default.
1096
      # [:autosave]
1097
      #   If true, always save the associated object or destroy it if marked for destruction,
1098
      #   when saving the parent object. If false, never save or destroy the associated object.
1099
      #   By default, only save the associated object if it's a new record.
P
Pratik Naik 已提交
1100
      # [:inverse_of]
1101 1102
      #   Specifies the name of the <tt>belongs_to</tt> association on the associated object
      #   that is the inverse of this <tt>has_one</tt> association.  Does not work in combination
1103
      #   with <tt>:through</tt> or <tt>:as</tt> options.
1104
      #   See ActiveRecord::Associations::ClassMethods's overview on Bi-directional associations for more detail.
1105
      #
D
Initial  
David Heinemeier Hansson 已提交
1106
      # Option examples:
1107
      #   has_one :credit_card, :dependent => :destroy  # destroys the associated credit card
1108
      #   has_one :credit_card, :dependent => :nullify  # updates the associated records foreign
1109
      #                                                 # key value to NULL rather than destroying it
D
Initial  
David Heinemeier Hansson 已提交
1110 1111
      #   has_one :last_comment, :class_name => "Comment", :order => "posted_on"
      #   has_one :project_manager, :class_name => "Person", :conditions => "role = 'project_manager'"
1112
      #   has_one :attachment, :as => :attachable
1113
      #   has_one :boss, :readonly => :true
1114 1115
      #   has_one :club, :through => :membership
      #   has_one :primary_address, :through => :addressables, :conditions => ["addressable.primary = ?", true], :source => :addressable
D
Initial  
David Heinemeier Hansson 已提交
1116
      def has_one(association_id, options = {})
1117 1118 1119 1120 1121 1122 1123 1124 1125 1126
        if options[:through]
          reflection = create_has_one_through_reflection(association_id, options)
          association_accessor_methods(reflection, ActiveRecord::Associations::HasOneThroughAssociation)
        else
          reflection = create_has_one_reflection(association_id, options)
          association_accessor_methods(reflection, HasOneAssociation)
          association_constructor_method(:build,  reflection, HasOneAssociation)
          association_constructor_method(:create, reflection, HasOneAssociation)
          configure_dependency_for_has_one(reflection)
        end
D
Initial  
David Heinemeier Hansson 已提交
1127 1128
      end

P
Pratik Naik 已提交
1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142
      # 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
1143
      #   with +attributes+ and linked to this object through a foreign key, but has not yet been saved.
P
Pratik Naik 已提交
1144 1145 1146 1147 1148 1149 1150
      # [create_association(attributes = {})]
      #   Returns a new object of the associated type that has been instantiated
      #   with +attributes+, linked to this object through a foreign key, and that
      #   has already been saved (if it passed the validation).
      #
      # (+association+ is replaced with the symbol passed as the first argument, so
      # <tt>belongs_to :author</tt> would add among others <tt>author.nil?</tt>.)
D
Initial  
David Heinemeier Hansson 已提交
1151
      #
P
Pratik Naik 已提交
1152 1153 1154
      # === Example
      #
      # A Post class declares <tt>belongs_to :author</tt>, which will add:
D
Initial  
David Heinemeier Hansson 已提交
1155 1156
      # * <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 已提交
1157 1158
      # * <tt>Post#build_author</tt> (similar to <tt>post.author = Author.new</tt>)
      # * <tt>Post#create_author</tt> (similar to <tt>post.author = Author.new; post.author.save; post.author</tt>)
D
Initial  
David Heinemeier Hansson 已提交
1159
      # The declaration can also include an options hash to specialize the behavior of the association.
1160
      #
P
Pratik Naik 已提交
1161 1162 1163 1164
      # === Options
      #
      # [:class_name]
      #   Specify the class name of the association. Use it only if that name can't be inferred
P
Pratik Naik 已提交
1165 1166
      #   from the association name. So <tt>has_one :author</tt> will by default be linked to the Author class, but
      #   if the real class name is Person, you'll have to specify it with this option.
P
Pratik Naik 已提交
1167 1168
      # [:conditions]
      #   Specify the conditions that the associated object must meet in order to be included as a +WHERE+
1169
      #   SQL fragment, such as <tt>authorized = 1</tt>.
P
Pratik Naik 已提交
1170
      # [:select]
1171 1172
      #   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
1173
      #   forget to include the primary and foreign keys, otherwise it will raise an error.
P
Pratik Naik 已提交
1174 1175
      # [:foreign_key]
      #   Specify the foreign key used for the association. By default this is guessed to be the name
1176 1177 1178
      #   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
1179
      #   of "favorite_person_id".
1180 1181 1182 1183 1184
      # [: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>.
1185
      # [:primary_key]
1186
      #   Specify the method that returns the primary key of associated object used for the association.
1187
      #   By default this is id.
P
Pratik Naik 已提交
1188 1189
      # [:dependent]
      #   If set to <tt>:destroy</tt>, the associated object is destroyed when this object is. If set to
1190 1191
      #   <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
1192
      #   a <tt>has_many</tt> relationship on another class because of the potential to leave
1193
      #   orphaned records behind.
P
Pratik Naik 已提交
1194 1195
      # [:counter_cache]
      #   Caches the number of belonging objects on the associate class through the use of +increment_counter+
1196 1197
      #   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
1198
      #   named <tt>#{table_name}_count</tt> (such as +comments_count+ for a belonging Comment class)
1199 1200
      #   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
1201
      #   option (e.g., <tt>:counter_cache => :my_custom_counter</tt>.)
1202
      #   Note: Specifying a counter cache will add it to that model's list of readonly attributes
1203
      #   using +attr_readonly+.
P
Pratik Naik 已提交
1204 1205 1206 1207
      # [: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+.
1208
      #   Note: If you've enabled the counter cache, then you may want to add the counter cache attribute
P
Pratik Naik 已提交
1209
      #   to the +attr_readonly+ list in the associated classes (e.g. <tt>class Post; attr_readonly :comments_count; end</tt>).
P
Pratik Naik 已提交
1210 1211 1212
      # [:readonly]
      #   If true, the associated object is readonly through the association.
      # [:validate]
1213
      #   If +false+, don't validate the associated objects when saving the parent object. +false+ by default.
1214
      # [:autosave]
1215
      #   If true, always save the associated object or destroy it if marked for destruction, when
1216
      #   saving the parent object.
1217 1218
      #   If false, never save or destroy the associated object.
      #   By default, only save the associated object if it's a new record.
1219
      # [:touch]
1220 1221
      #   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
1222
      #   will be updated with the current time instead of the updated_at/on attribute.
P
Pratik Naik 已提交
1223
      # [:inverse_of]
1224 1225
      #   Specifies the name of the <tt>has_one</tt> or <tt>has_many</tt> association on the associated
      #   object that is the inverse of this <tt>belongs_to</tt> association.  Does not work in
1226
      #   combination with the <tt>:polymorphic</tt> options.
1227
      #   See ActiveRecord::Associations::ClassMethods's overview on Bi-directional associations for more detail.
D
Initial  
David Heinemeier Hansson 已提交
1228 1229 1230
      #
      # Option examples:
      #   belongs_to :firm, :foreign_key => "client_of"
1231
      #   belongs_to :person, :primary_key => "name", :foreign_key => "person_name"
D
Initial  
David Heinemeier Hansson 已提交
1232
      #   belongs_to :author, :class_name => "Person", :foreign_key => "author_id"
1233
      #   belongs_to :valid_coupon, :class_name => "Coupon", :foreign_key => "coupon_id",
D
Initial  
David Heinemeier Hansson 已提交
1234
      #              :conditions => 'discounts > #{payments_count}'
R
Rick Olson 已提交
1235
      #   belongs_to :attachable, :polymorphic => true
1236
      #   belongs_to :project, :readonly => true
1237
      #   belongs_to :post, :counter_cache => true
1238 1239
      #   belongs_to :company, :touch => true
      #   belongs_to :company, :touch => :employees_last_updated_at
1240
      def belongs_to(association_id, options = {})
1241
        reflection = create_belongs_to_reflection(association_id, options)
1242

1243 1244
        if reflection.options[:polymorphic]
          association_accessor_methods(reflection, BelongsToPolymorphicAssociation)
1245
        else
1246 1247 1248
          association_accessor_methods(reflection, BelongsToAssociation)
          association_constructor_method(:build,  reflection, BelongsToAssociation)
          association_constructor_method(:create, reflection, BelongsToAssociation)
1249
        end
1250

1251 1252
        add_counter_cache_callbacks(reflection)          if options[:counter_cache]
        add_touch_callbacks(reflection, options[:touch]) if options[:touch]
1253 1254

        configure_dependency_for_belongs_to(reflection)
1255 1256
      end

P
Pratik Naik 已提交
1257 1258 1259
      # Specifies a many-to-many relationship with another class. This associates two classes via an
      # intermediate join table.  Unless the join table is explicitly specified as an option, it is
      # guessed using the lexical order of the class names. So a join between Developer and Project
1260 1261 1262
      # will give the default join table name of "developers_projects" because "D" outranks "P".
      # Note that this precedence is calculated using the <tt><</tt> operator for String.  This
      # means that if the strings are of different lengths, and the strings are equal when compared
1263
      # up to the shortest length, then the longer string is considered of higher
P
Pratik Naik 已提交
1264 1265 1266 1267
      # lexical precedence than the shorter one.  For example, one would expect the tables "paper_boxes" and "papers"
      # to generate a join table name of "papers_paper_boxes" because of the length of the name "paper_boxes",
      # but it in fact generates a join table name of "paper_boxes_papers".  Be aware of this caveat, and use the
      # custom <tt>:join_table</tt> option if you need to.
D
Initial  
David Heinemeier Hansson 已提交
1268
      #
1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284
      # The join table should not have a primary key or a model associated with it. You must manually generate the
      # join table with a migration such as this:
      #
      #   class CreateDevelopersProjectsJoinTable < ActiveRecord::Migration
      #     def self.up
      #       create_table :developers_projects, :id => false do |t|
      #         t.integer :developer_id
      #         t.integer :project_id
      #       end
      #     end
      #
      #     def self.down
      #       drop_table :developers_projects
      #     end
      #   end
      #
1285 1286 1287
      # Deprecated: Any additional fields added to the join table will be placed as attributes when
      # pulling records out through +has_and_belongs_to_many+ associations. Records returned from join
      # tables with additional attributes will be marked as readonly (because we can't save changes
1288
      # to the additional attributes). It's strongly recommended that you upgrade any
1289
      # associations with attributes to a real join model (see introduction).
D
Initial  
David Heinemeier Hansson 已提交
1290
      #
1291
      # Adds the following methods for retrieval and query:
P
Pratik Naik 已提交
1292 1293 1294
      #
      # [collection(force_reload = false)]
      #   Returns an array of all the associated objects.
1295
      #   An empty array is returned if none are found.
P
Pratik Naik 已提交
1296 1297
      # [collection<<(object, ...)]
      #   Adds one or more objects to the collection by creating associations in the join table
1298
      #   (<tt>collection.push</tt> and <tt>collection.concat</tt> are aliases to this method).
1299
      #   Note that this operation instantly fires update sql without waiting for the save or update call on the
1300
      #   parent object.
P
Pratik Naik 已提交
1301 1302
      # [collection.delete(object, ...)]
      #   Removes one or more objects from the collection by removing their associations from the join table.
D
Initial  
David Heinemeier Hansson 已提交
1303
      #   This does not destroy the objects.
P
Pratik Naik 已提交
1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317
      # [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
1318
      #   meets the condition that it has to be associated with this object.
P
Pratik Naik 已提交
1319
      #   Uses the same rules as ActiveRecord::Base.find.
P
Pratik Naik 已提交
1320
      # [collection.exists?(...)]
P
Pratik Naik 已提交
1321 1322 1323 1324
      #   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
1325
      #   with +attributes+ and linked to this object through the join table, but has not yet been saved.
P
Pratik Naik 已提交
1326 1327
      # [collection.create(attributes = {})]
      #   Returns a new object of the collection type that has been instantiated
1328
      #   with +attributes+, linked to this object through the join table, and that has already been
1329
      #   saved (if it passed the validation).
D
Initial  
David Heinemeier Hansson 已提交
1330
      #
P
Pratik Naik 已提交
1331 1332 1333 1334 1335 1336
      # (+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 已提交
1337 1338 1339
      # * <tt>Developer#projects</tt>
      # * <tt>Developer#projects<<</tt>
      # * <tt>Developer#projects.delete</tt>
1340
      # * <tt>Developer#projects=</tt>
1341
      # * <tt>Developer#project_ids</tt>
1342
      # * <tt>Developer#project_ids=</tt>
D
Initial  
David Heinemeier Hansson 已提交
1343 1344 1345 1346
      # * <tt>Developer#projects.clear</tt>
      # * <tt>Developer#projects.empty?</tt>
      # * <tt>Developer#projects.size</tt>
      # * <tt>Developer#projects.find(id)</tt>
1347
      # * <tt>Developer#projects.exists?(...)</tt>
1348 1349
      # * <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 已提交
1350
      # The declaration may include an options hash to specialize the behavior of the association.
1351
      #
P
Pratik Naik 已提交
1352 1353 1354 1355
      # === Options
      #
      # [:class_name]
      #   Specify the class name of the association. Use it only if that name can't be inferred
1356
      #   from the association name. So <tt>has_and_belongs_to_many :projects</tt> will by default be linked to the
P
Pratik Naik 已提交
1357
      #   Project class, but if the real class name is SuperProject, you'll have to specify it with this option.
P
Pratik Naik 已提交
1358 1359 1360 1361 1362 1363
      # [: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
1364 1365
      #   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
1366
      #   default <tt>:foreign_key</tt>.
P
Pratik Naik 已提交
1367
      # [:association_foreign_key]
P
Pratik Naik 已提交
1368 1369 1370 1371
      #   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 已提交
1372 1373
      # [:conditions]
      #   Specify the conditions that the associated object must meet in order to be included as a +WHERE+
1374
      #   SQL fragment, such as <tt>authorized = 1</tt>.  Record creations from the association are
1375
      #   scoped if a hash is used.
1376
      #   <tt>has_many :posts, :conditions => {:published => true}</tt> will create published posts with <tt>@blog.posts.create</tt>
1377
      #   or <tt>@blog.posts.build</tt>.
P
Pratik Naik 已提交
1378 1379
      # [:order]
      #   Specify the order in which the associated objects are returned as an <tt>ORDER BY</tt> SQL fragment,
1380
      #   such as <tt>last_name, first_name DESC</tt>
P
Pratik Naik 已提交
1381 1382 1383 1384
      # [: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
1385 1386
      # [:counter_sql]
      #   Specify a complete SQL statement to fetch the size of the association. If <tt>:finder_sql</tt> is
1387
      #   specified but not <tt>:counter_sql</tt>, <tt>:counter_sql</tt> will be generated by
1388
      #   replacing <tt>SELECT ... FROM</tt> with <tt>SELECT COUNT(*) FROM</tt>.
P
Pratik Naik 已提交
1389 1390
      # [:delete_sql]
      #   Overwrite the default generated SQL statement used to remove links between the associated
P
Pratik Naik 已提交
1391
      #   classes with a manual statement.
P
Pratik Naik 已提交
1392 1393
      # [:insert_sql]
      #   Overwrite the default generated SQL statement used to add links between the associated classes
P
Pratik Naik 已提交
1394
      #   with a manual statement.
P
Pratik Naik 已提交
1395 1396 1397 1398 1399 1400
      # [: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.
1401
      # [:having]
1402
      #   Combined with +:group+ this can be used to filter the records that a <tt>GROUP BY</tt> returns.
1403
      #   Uses the <tt>HAVING</tt> SQL-clause.
P
Pratik Naik 已提交
1404 1405 1406
      # [:limit]
      #   An integer determining the limit on the number of rows that should be returned.
      # [:offset]
1407
      #   An integer determining the offset from where the rows should be fetched. So at 5,
1408
      #   it would skip the first 4 rows.
P
Pratik Naik 已提交
1409
      # [:select]
1410 1411
      #   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
1412
      #   and foreign keys, otherwise it will raise an error.
P
Pratik Naik 已提交
1413 1414 1415
      # [:readonly]
      #   If true, all the associated objects are readonly through the association.
      # [:validate]
1416
      #   If +false+, don't validate the associated objects when saving the parent object. +true+ by default.
1417
      # [:autosave]
1418
      #   If true, always save the associated objects or destroy them if marked for destruction, when
1419
      #   saving the parent object.
1420 1421
      #   If false, never save or destroy the associated objects.
      #   By default, only save associated objects that are new records.
D
Initial  
David Heinemeier Hansson 已提交
1422 1423 1424
      #
      # Option examples:
      #   has_and_belongs_to_many :projects
1425
      #   has_and_belongs_to_many :projects, :include => [ :milestones, :manager ]
D
Initial  
David Heinemeier Hansson 已提交
1426 1427
      #   has_and_belongs_to_many :nations, :class_name => "Country"
      #   has_and_belongs_to_many :categories, :join_table => "prods_cats"
1428
      #   has_and_belongs_to_many :categories, :readonly => true
1429
      #   has_and_belongs_to_many :active_projects, :join_table => 'developers_projects', :delete_sql =>
1430
      #   'DELETE FROM developers_projects WHERE active=1 AND developer_id = #{id} AND project_id = #{record.id}'
1431
      def has_and_belongs_to_many(association_id, options = {}, &extension)
1432 1433
        reflection = create_has_and_belongs_to_many_reflection(association_id, options, &extension)
        collection_accessor_methods(reflection, HasAndBelongsToManyAssociation)
D
Initial  
David Heinemeier Hansson 已提交
1434

1435 1436
        # Don't use a before_destroy callback since users' before_destroy
        # callbacks will be executed after the association is wiped out.
1437 1438 1439 1440
        include Module.new {
          class_eval <<-RUBY, __FILE__, __LINE__ + 1
            def destroy                     # def destroy
              #{reflection.name}.clear      #   posts.clear
1441
              super                         #   super
1442 1443 1444
            end                             # end
          RUBY
        }
1445

1446
        add_association_callbacks(reflection.name, options)
D
Initial  
David Heinemeier Hansson 已提交
1447 1448 1449
      end

      private
P
Pratik Naik 已提交
1450
        # Generates a join table name from two provided table names.
P
Pratik Naik 已提交
1451
        # The names in the join table names end up in lexicographic order.
P
Pratik Naik 已提交
1452 1453 1454
        #
        #   join_table_name("members", "clubs")         # => "clubs_members"
        #   join_table_name("members", "special_clubs") # => "members_special_clubs"
D
Initial  
David Heinemeier Hansson 已提交
1455 1456 1457 1458 1459 1460 1461 1462 1463
        def join_table_name(first_table_name, second_table_name)
          if first_table_name < second_table_name
            join_table = "#{first_table_name}_#{second_table_name}"
          else
            join_table = "#{second_table_name}_#{first_table_name}"
          end

          table_name_prefix + join_table + table_name_suffix
        end
1464

1465
        def association_accessor_methods(reflection, association_proxy_class)
1466
          redefine_method(reflection.name) do |*params|
1467
            force_reload = params.first unless params.empty?
1468
            association = association_instance_get(reflection.name)
1469

1470
            if association.nil? || force_reload || association.stale_target?
1471
              association = association_proxy_class.new(self, reflection)
1472
              retval = force_reload ? reflection.klass.uncached { association.reload } : association.reload
1473
              if retval.nil? and association_proxy_class == BelongsToAssociation
1474
                association_instance_set(reflection.name, nil)
1475 1476
                return nil
              end
1477
              association_instance_set(reflection.name, association)
1478
            end
1479 1480

            association.target.nil? ? nil : association
1481 1482
          end

1483
          redefine_method("loaded_#{reflection.name}?") do
1484
            association = association_instance_get(reflection.name)
1485 1486
            association && association.loaded?
          end
1487

1488
          redefine_method("#{reflection.name}=") do |new_value|
1489
            association = association_instance_get(reflection.name)
1490

1491
            if association.nil? || association.target != new_value
1492
              association = association_proxy_class.new(self, reflection)
1493
            end
1494

1495 1496
            association.replace(new_value)
            association_instance_set(reflection.name, new_value.nil? ? nil : association)
1497
          end
1498

1499
          redefine_method("set_#{reflection.name}_target") do |target|
1500
            return if target.nil? and association_proxy_class == BelongsToAssociation
1501
            association = association_proxy_class.new(self, reflection)
1502
            association.target = target
1503
            association_instance_set(reflection.name, association)
1504
          end
1505 1506
        end

1507
        def collection_reader_method(reflection, association_proxy_class)
1508
          redefine_method(reflection.name) do |*params|
1509
            force_reload = params.first unless params.empty?
1510
            association = association_instance_get(reflection.name)
1511

1512
            unless association
1513
              association = association_proxy_class.new(self, reflection)
1514
              association_instance_set(reflection.name, association)
D
Initial  
David Heinemeier Hansson 已提交
1515
            end
1516

1517 1518 1519 1520 1521
            if force_reload
              reflection.klass.uncached { association.reload }
            elsif association.stale_target?
              association.reload
            end
1522

1523 1524
            association
          end
1525

1526
          redefine_method("#{reflection.name.to_s.singularize}_ids") do
1527
            if send(reflection.name).loaded? || reflection.options[:finder_sql]
1528
              send(reflection.name).map { |r| r.id }
1529
            else
1530
              send(reflection.name).select("#{reflection.quoted_table_name}.#{reflection.klass.primary_key}").except(:includes).map! { |r| r.id }
1531
            end
1532
          end
1533
        end
D
Initial  
David Heinemeier Hansson 已提交
1534

1535
        def collection_accessor_methods(reflection, association_proxy_class, writer = true)
1536 1537
          collection_reader_method(reflection, association_proxy_class)

1538
          if writer
1539
            redefine_method("#{reflection.name}=") do |new_value|
1540 1541 1542 1543 1544
              # Loads proxy class instance (defined in collection_reader_method) if not already loaded
              association = send(reflection.name)
              association.replace(new_value)
              association
            end
J
José Valim 已提交
1545

1546
            redefine_method("#{reflection.name.to_s.singularize}_ids=") do |new_value|
J
José Valim 已提交
1547
              pk_column = reflection.primary_key_column
1548
              ids = (new_value || []).reject { |nid| nid.blank? }
J
José Valim 已提交
1549
              ids.map!{ |i| pk_column.type_cast(i) }
1550
              send("#{reflection.name}=", reflection.klass.find(ids).index_by{ |r| r.id }.values_at(*ids))
1551
            end
1552
          end
D
Initial  
David Heinemeier Hansson 已提交
1553
        end
1554

1555
        def association_constructor_method(constructor, reflection, association_proxy_class)
1556
          redefine_method("#{constructor}_#{reflection.name}") do |*params|
1557 1558
            attributees      = params.first unless params.empty?
            replace_existing = params[1].nil? ? true : params[1]
1559
            association      = association_instance_get(reflection.name)
1560

1561
            unless association
1562
              association = association_proxy_class.new(self, reflection)
1563
              association_instance_set(reflection.name, association)
1564 1565
            end

1566 1567 1568 1569 1570
            if association_proxy_class == HasOneAssociation
              association.send(constructor, attributees, replace_existing)
            else
              association.send(constructor, attributees)
            end
1571 1572
          end
        end
1573

1574 1575 1576 1577 1578 1579
        def add_counter_cache_callbacks(reflection)
          cache_column = reflection.counter_cache_column

          method_name = "belongs_to_counter_cache_after_create_for_#{reflection.name}".to_sym
          define_method(method_name) do
            association = send(reflection.name)
1580
            association.class.increment_counter(cache_column, association.id) unless association.nil?
1581 1582 1583 1584 1585 1586
          end
          after_create(method_name)

          method_name = "belongs_to_counter_cache_before_destroy_for_#{reflection.name}".to_sym
          define_method(method_name) do
            association = send(reflection.name)
1587
            association.class.decrement_counter(cache_column, association.id) unless association.nil?
1588 1589 1590 1591
          end
          before_destroy(method_name)

          module_eval(
1592
            "#{reflection.class_name}.send(:attr_readonly,\"#{cache_column}\".intern) if defined?(#{reflection.class_name}) && #{reflection.class_name}.respond_to?(:attr_readonly)", __FILE__, __LINE__
1593 1594
          )
        end
1595

1596
        def add_touch_callbacks(reflection, touch_attribute)
1597 1598
          method_name = :"belongs_to_touch_after_save_or_destroy_for_#{reflection.name}"
          redefine_method(method_name) do
1599
            association = send(reflection.name)
1600

1601 1602 1603 1604 1605 1606 1607
            if touch_attribute == true
              association.touch unless association.nil?
            else
              association.touch(touch_attribute) unless association.nil?
            end
          end
          after_save(method_name)
1608
          after_touch(method_name)
1609 1610 1611
          after_destroy(method_name)
        end

1612 1613 1614
        # Creates before_destroy callback methods that nullify, delete or destroy
        # has_many associated objects, according to the defined :dependent rule.
        #
1615 1616 1617
        # See HasManyAssociation#delete_records for more information. In general
        #  - delete children if the option is set to :destroy or :delete_all
        #  - set the foreign key to NULL if the option is set to :nullify
1618
        #  - do not delete the parent record if there is any child record if the
1619
        #    option is set to :restrict
1620
        def configure_dependency_for_has_many(reflection)
1621 1622 1623
          if reflection.options[:dependent]
            method_name = "has_many_dependent_for_#{reflection.name}"

1624
            case reflection.options[:dependent]
1625 1626 1627
            when :destroy, :delete_all, :nullify
              define_method(method_name) do
                if reflection.options[:dependent] == :destroy
1628 1629 1630 1631 1632 1633 1634 1635 1636 1637
                  send(reflection.name).each do |o|
                    # No point in executing the counter update since we're going to destroy the parent anyway
                    counter_method = ('belongs_to_counter_cache_before_destroy_for_' + self.class.name.downcase).to_sym
                    if(o.respond_to? counter_method) then
                      class << o
                        self
                      end.send(:define_method, counter_method, Proc.new {})
                    end
                    o.destroy
                  end
1638
                end
1639

1640 1641
                # AssociationProxy#delete_all looks at the :dependent option and acts accordingly
                send(reflection.name).delete_all
1642 1643 1644 1645 1646
              end
            when :restrict
              define_method(method_name) do
                unless send(reflection.name).empty?
                  raise DeleteRestrictionError.new(reflection)
1647
                end
1648 1649 1650
              end
            else
              raise ArgumentError, "The :dependent option expects either :destroy, :delete_all, :nullify or :restrict (#{reflection.options[:dependent].inspect})"
1651
            end
1652 1653

            before_destroy method_name
1654 1655
          end
        end
1656

P
Pratik Naik 已提交
1657 1658
        # Creates before_destroy callback methods that nullify, delete or destroy
        # has_one associated objects, according to the defined :dependent rule.
1659 1660
        # If the association is marked as :dependent => :restrict, create a callback
        # that prevents deleting entirely.
1661
        def configure_dependency_for_has_one(reflection)
1662
          if reflection.options.include?(:dependent)
A
Aaron Patterson 已提交
1663 1664 1665 1666 1667
            name = reflection.options[:dependent]
            method_name = :"has_one_dependent_#{name}_for_#{reflection.name}"

            case name
              when :destroy, :delete
1668 1669 1670 1671 1672 1673
                class_eval <<-eoruby, __FILE__, __LINE__ + 1
                  def #{method_name}
                    association = #{reflection.name}
                    association.#{name} if association
                  end
                eoruby
1674
              when :nullify
1675 1676 1677
                class_eval <<-eoruby, __FILE__, __LINE__ + 1
                  def #{method_name}
                    association = #{reflection.name}
1678
                    association.update_attribute(#{reflection.foreign_key.inspect}, nil) if association
1679 1680
                  end
                eoruby
1681 1682 1683 1684 1685 1686 1687 1688
              when :restrict
                method_name = "has_one_dependent_restrict_for_#{reflection.name}".to_sym
                define_method(method_name) do
                  unless send(reflection.name).nil?
                    raise DeleteRestrictionError.new(reflection)
                  end
                end
                before_destroy method_name
1689
              else
1690
                raise ArgumentError, "The :dependent option expects either :destroy, :delete, :nullify or :restrict (#{reflection.options[:dependent].inspect})"
1691
            end
A
Aaron Patterson 已提交
1692 1693

            before_destroy method_name
1694 1695 1696
          end
        end

1697 1698
        def configure_dependency_for_belongs_to(reflection)
          if reflection.options.include?(:dependent)
1699 1700 1701 1702 1703 1704 1705
            name = reflection.options[:dependent]

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

            method_name = :"belongs_to_dependent_#{name}_for_#{reflection.name}"
1706 1707 1708 1709 1710 1711
            class_eval <<-eoruby, __FILE__, __LINE__ + 1
              def #{method_name}
                association = #{reflection.name}
                association.#{name} if association
              end
            eoruby
1712
            after_destroy method_name
1713 1714 1715
          end
        end

1716 1717 1718 1719
        mattr_accessor :valid_keys_for_has_many_association
        @@valid_keys_for_has_many_association = [
          :class_name, :table_name, :foreign_key, :primary_key,
          :dependent,
1720
          :select, :conditions, :include, :order, :group, :having, :limit, :offset,
1721 1722 1723 1724 1725
          :as, :through, :source, :source_type,
          :uniq,
          :finder_sql, :counter_sql,
          :before_add, :after_add, :before_remove, :after_remove,
          :extend, :readonly,
1726
          :validate, :inverse_of
1727 1728
        ]

1729
        def create_has_many_reflection(association_id, options, &extension)
1730
          options.assert_valid_keys(valid_keys_for_has_many_association)
1731
          options[:extend] = create_extension_modules(association_id, extension, options[:extend])
1732

1733
          create_reflection(:has_many, association_id, options, self)
1734 1735
        end

1736 1737 1738 1739
        mattr_accessor :valid_keys_for_has_one_association
        @@valid_keys_for_has_one_association = [
          :class_name, :foreign_key, :remote, :select, :conditions, :order,
          :include, :dependent, :counter_cache, :extend, :as, :readonly,
1740
          :validate, :primary_key, :inverse_of
1741 1742
        ]

1743
        def create_has_one_reflection(association_id, options)
1744
          options.assert_valid_keys(valid_keys_for_has_one_association)
1745
          create_reflection(:has_one, association_id, options, self)
1746
        end
1747

1748 1749
        def create_has_one_through_reflection(association_id, options)
          options.assert_valid_keys(
1750
            :class_name, :foreign_key, :remote, :select, :conditions, :order, :include, :dependent, :counter_cache, :extend, :as, :through, :source, :source_type, :validate
1751 1752 1753
          )
          create_reflection(:has_one, association_id, options, self)
        end
1754

1755 1756
        mattr_accessor :valid_keys_for_belongs_to_association
        @@valid_keys_for_belongs_to_association = [
1757
          :class_name, :primary_key, :foreign_key, :foreign_type, :remote, :select, :conditions,
1758
          :include, :dependent, :counter_cache, :extend, :polymorphic, :readonly,
1759
          :validate, :touch, :inverse_of
1760 1761
        ]

1762
        def create_belongs_to_reflection(association_id, options)
1763
          options.assert_valid_keys(valid_keys_for_belongs_to_association)
1764 1765 1766 1767 1768 1769 1770 1771
          reflection = create_reflection(:belongs_to, association_id, options, self)

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

          reflection
        end
1772

1773 1774 1775
        mattr_accessor :valid_keys_for_has_and_belongs_to_many_association
        @@valid_keys_for_has_and_belongs_to_many_association = [
          :class_name, :table_name, :join_table, :foreign_key, :association_foreign_key,
1776
          :select, :conditions, :include, :order, :group, :having, :limit, :offset,
1777
          :uniq,
1778
          :finder_sql, :counter_sql, :delete_sql, :insert_sql,
1779 1780 1781 1782 1783
          :before_add, :after_add, :before_remove, :after_remove,
          :extend, :readonly,
          :validate
        ]

1784
        def create_has_and_belongs_to_many_reflection(association_id, options, &extension)
1785
          options.assert_valid_keys(valid_keys_for_has_and_belongs_to_many_association)
1786
          options[:extend] = create_extension_modules(association_id, extension, options[:extend])
1787 1788

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

1790
          if reflection.association_foreign_key == reflection.foreign_key
1791 1792
            raise HasAndBelongsToManyAssociationForeignKeyNeeded.new(reflection)
          end
1793

1794
          reflection.options[:join_table] ||= join_table_name(undecorated_table_name(self.to_s), undecorated_table_name(reflection.class_name))
1795 1796 1797
          if connection.supports_primary_key? && (connection.primary_key(reflection.options[:join_table]) rescue false)
             raise HasAndBelongsToManyAssociationWithPrimaryKeyError.new(reflection)
          end
1798

1799 1800 1801
          reflection
        end

1802
        def add_association_callbacks(association_name, options)
1803 1804
          callbacks = %w(before_add after_add before_remove after_remove)
          callbacks.each do |callback_name|
1805
            full_callback_name = "#{callback_name}_for_#{association_name}"
1806
            defined_callbacks = options[callback_name.to_sym]
1807 1808 1809 1810 1811 1812

            full_callback_value = options.has_key?(callback_name.to_sym) ? [defined_callbacks].flatten : []

            # TODO : why do i need method_defined? I think its because of the inheritance chain
            class_attribute full_callback_name.to_sym unless method_defined?(full_callback_name)
            self.send("#{full_callback_name}=", full_callback_value)
1813
          end
1814
        end
1815

1816
        def create_extension_modules(association_id, block_extension, extensions)
1817
          if block_extension
1818
            extension_module_name = "#{self.to_s.demodulize}#{association_id.to_s.camelize}AssociationExtension"
1819

1820
            silence_warnings do
1821
              self.parent.const_set(extension_module_name, Module.new(&block_extension))
1822
            end
1823
            Array.wrap(extensions).push("#{self.parent}::#{extension_module_name}".constantize)
1824
          else
1825
            Array.wrap(extensions)
1826 1827 1828
          end
        end
    end
D
Initial  
David Heinemeier Hansson 已提交
1829
  end
1830
end