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

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

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

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

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

D
David Heinemeier Hansson 已提交
28
  class HasManyThroughSourceAssociationNotFoundError < ActiveRecordError #:nodoc:
29
    def initialize(reflection)
30 31 32
      through_reflection      = reflection.through_reflection
      source_reflection_names = reflection.source_reflection_names
      source_associations     = reflection.through_reflection.klass.reflect_on_all_associations.collect { |a| a.name.inspect }
33
      super("Could not find the source association(s) #{source_reflection_names.collect(&:inspect).to_sentence(:two_words_connector => ' or ', :last_word_connector => ', or ', :locale => :en)} in model #{through_reflection.klass}.  Try 'has_many #{reflection.name.inspect}, :through => #{through_reflection.name.inspect}, :source => <name>'.  Is it one of #{source_associations.to_sentence(:two_words_connector => ' or ', :last_word_connector => ', or ', :locale => :en)}?")
34 35 36
    end
  end

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

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

51 52 53 54 55 56
  class HasManyThroughCantAssociateNewRecords < ActiveRecordError #:nodoc:
    def initialize(owner, reflection)
      super("Cannot associate new records through '#{owner.class.name}##{reflection.name}' on '#{reflection.source_reflection.class_name rescue nil}##{reflection.source_reflection.name rescue nil}'. Both records must have an id in order to create the has_many :through record associating them.")
    end
  end

57 58 59 60 61 62
  class HasManyThroughCantDissociateNewRecords < ActiveRecordError #:nodoc:
    def initialize(owner, reflection)
      super("Cannot dissociate new records through '#{owner.class.name}##{reflection.name}' on '#{reflection.source_reflection.class_name rescue nil}##{reflection.source_reflection.name rescue nil}'. Both records must have an id in order to delete the has_many :through record associating them.")
    end
  end

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

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

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

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

91
    # These classes will be loaded when associations are created.
J
Joshua Peek 已提交
92 93 94 95 96 97 98 99 100 101 102
    # So there is no need to eager load them.
    autoload :AssociationCollection, 'active_record/associations/association_collection'
    autoload :AssociationProxy, 'active_record/associations/association_proxy'
    autoload :BelongsToAssociation, 'active_record/associations/belongs_to_association'
    autoload :BelongsToPolymorphicAssociation, 'active_record/associations/belongs_to_polymorphic_association'
    autoload :HasAndBelongsToManyAssociation, 'active_record/associations/has_and_belongs_to_many_association'
    autoload :HasManyAssociation, 'active_record/associations/has_many_association'
    autoload :HasManyThroughAssociation, 'active_record/associations/has_many_through_association'
    autoload :HasOneAssociation, 'active_record/associations/has_one_association'
    autoload :HasOneThroughAssociation, 'active_record/associations/has_one_through_association'

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

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

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

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

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

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

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

1109 1110
        if reflection.options[:polymorphic]
          association_accessor_methods(reflection, BelongsToPolymorphicAssociation)
1111
        else
1112 1113 1114
          association_accessor_methods(reflection, BelongsToAssociation)
          association_constructor_method(:build,  reflection, BelongsToAssociation)
          association_constructor_method(:create, reflection, BelongsToAssociation)
1115
        end
1116

1117 1118
        add_counter_cache_callbacks(reflection)          if options[:counter_cache]
        add_touch_callbacks(reflection, options[:touch]) if options[:touch]
1119 1120

        configure_dependency_for_belongs_to(reflection)
1121 1122
      end

P
Pratik Naik 已提交
1123 1124 1125
      # Specifies a many-to-many relationship with another class. This associates two classes via an
      # intermediate join table.  Unless the join table is explicitly specified as an option, it is
      # guessed using the lexical order of the class names. So a join between Developer and Project
P
Pratik Naik 已提交
1126 1127
      # 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,
1128
      # and the strings are equal when compared up to the shortest length, then the longer string is considered of higher
P
Pratik Naik 已提交
1129 1130 1131 1132
      # 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 已提交
1133
      #
1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149
      # 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
      #
1150
      # Deprecated: Any additional fields added to the join table will be placed as attributes when pulling records out through
1151
      # +has_and_belongs_to_many+ associations. Records returned from join tables with additional attributes will be marked as
P
Pratik Naik 已提交
1152
      # readonly (because we can't save changes to the additional attributes). It's strongly recommended that you upgrade any
1153
      # associations with attributes to a real join model (see introduction).
D
Initial  
David Heinemeier Hansson 已提交
1154
      #
1155
      # Adds the following methods for retrieval and query:
P
Pratik Naik 已提交
1156 1157 1158
      #
      # [collection(force_reload = false)]
      #   Returns an array of all the associated objects.
1159
      #   An empty array is returned if none are found.
P
Pratik Naik 已提交
1160 1161
      # [collection<<(object, ...)]
      #   Adds one or more objects to the collection by creating associations in the join table
1162
      #   (<tt>collection.push</tt> and <tt>collection.concat</tt> are aliases to this method).
P
Pratik Naik 已提交
1163 1164
      # [collection.delete(object, ...)]
      #   Removes one or more objects from the collection by removing their associations from the join table.
D
Initial  
David Heinemeier Hansson 已提交
1165
      #   This does not destroy the objects.
P
Pratik Naik 已提交
1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179
      # [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
1180
      #   meets the condition that it has to be associated with this object.
P
Pratik Naik 已提交
1181
      #   Uses the same rules as ActiveRecord::Base.find.
P
Pratik Naik 已提交
1182
      # [collection.exists?(...)]
P
Pratik Naik 已提交
1183 1184 1185 1186
      #   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
1187
      #   with +attributes+ and linked to this object through the join table, but has not yet been saved.
P
Pratik Naik 已提交
1188 1189
      # [collection.create(attributes = {})]
      #   Returns a new object of the collection type that has been instantiated
1190
      #   with +attributes+, linked to this object through the join table, and that has already been saved (if it passed the validation).
D
Initial  
David Heinemeier Hansson 已提交
1191
      #
P
Pratik Naik 已提交
1192 1193 1194 1195 1196 1197
      # (+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 已提交
1198 1199 1200
      # * <tt>Developer#projects</tt>
      # * <tt>Developer#projects<<</tt>
      # * <tt>Developer#projects.delete</tt>
1201
      # * <tt>Developer#projects=</tt>
1202
      # * <tt>Developer#project_ids</tt>
1203
      # * <tt>Developer#project_ids=</tt>
D
Initial  
David Heinemeier Hansson 已提交
1204 1205 1206 1207
      # * <tt>Developer#projects.clear</tt>
      # * <tt>Developer#projects.empty?</tt>
      # * <tt>Developer#projects.size</tt>
      # * <tt>Developer#projects.find(id)</tt>
P
Pratik Naik 已提交
1208
      # * <tt>Developer#clients.exists?(...)</tt>
1209 1210
      # * <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 已提交
1211
      # The declaration may include an options hash to specialize the behavior of the association.
1212
      #
P
Pratik Naik 已提交
1213 1214 1215 1216
      # === Options
      #
      # [:class_name]
      #   Specify the class name of the association. Use it only if that name can't be inferred
1217
      #   from the association name. So <tt>has_and_belongs_to_many :projects</tt> will by default be linked to the
P
Pratik Naik 已提交
1218
      #   Project class, but if the real class name is SuperProject, you'll have to specify it with this option.
P
Pratik Naik 已提交
1219 1220 1221 1222 1223 1224
      # [:join_table]
      #   Specify the name of the join table if the default based on lexical order isn't what you want.
      #   <b>WARNING:</b> If you're overwriting the table name of either class, the +table_name+ method
      #   MUST be declared underneath any +has_and_belongs_to_many+ declaration in order to work.
      # [:foreign_key]
      #   Specify the foreign key used for the association. By default this is guessed to be the name
P
Pratik Naik 已提交
1225
      #   of this class in lower-case and "_id" suffixed. So a Person class that makes a +has_and_belongs_to_many+ association
P
Pratik Naik 已提交
1226
      #   to Project will use "person_id" as the default <tt>:foreign_key</tt>.
P
Pratik Naik 已提交
1227
      # [:association_foreign_key]
P
Pratik Naik 已提交
1228 1229 1230 1231
      #   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 已提交
1232 1233
      # [:conditions]
      #   Specify the conditions that the associated object must meet in order to be included as a +WHERE+
1234 1235 1236
      #   SQL fragment, such as <tt>authorized = 1</tt>.  Record creations from the association are scoped if a hash is used.  
      #   <tt>has_many :posts, :conditions => {:published => true}</tt> will create published posts with <tt>@blog.posts.create</tt> 
      #   or <tt>@blog.posts.build</tt>.
P
Pratik Naik 已提交
1237 1238
      # [:order]
      #   Specify the order in which the associated objects are returned as an <tt>ORDER BY</tt> SQL fragment,
1239
      #   such as <tt>last_name, first_name DESC</tt>
P
Pratik Naik 已提交
1240 1241 1242 1243
      # [: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
1244 1245 1246
      # [:counter_sql]
      #   Specify a complete SQL statement to fetch the size of the association. If <tt>:finder_sql</tt> is
      #   specified but not <tt>:counter_sql</tt>, <tt>:counter_sql</tt> will be generated by replacing <tt>SELECT ... FROM</tt> with <tt>SELECT COUNT(*) FROM</tt>.
P
Pratik Naik 已提交
1247 1248
      # [:delete_sql]
      #   Overwrite the default generated SQL statement used to remove links between the associated
P
Pratik Naik 已提交
1249
      #   classes with a manual statement.
P
Pratik Naik 已提交
1250 1251
      # [:insert_sql]
      #   Overwrite the default generated SQL statement used to add links between the associated classes
P
Pratik Naik 已提交
1252
      #   with a manual statement.
P
Pratik Naik 已提交
1253 1254 1255 1256 1257 1258
      # [: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.
1259 1260
      # [:having]
      #   Combined with +:group+ this can be used to filter the records that a <tt>GROUP BY</tt> returns. Uses the <tt>HAVING</tt> SQL-clause.
P
Pratik Naik 已提交
1261 1262 1263 1264 1265 1266
      # [:limit]
      #   An integer determining the limit on the number of rows that should be returned.
      # [:offset]
      #   An integer determining the offset from where the rows should be fetched. So at 5, it would skip the first 4 rows.
      # [:select]
      #   By default, this is <tt>*</tt> as in <tt>SELECT * FROM</tt>, but can be changed if, for example, you want to do a join
1267
      #   but not include the joined columns. Do not forget to include the primary and foreign keys, otherwise it will raise an error.
P
Pratik Naik 已提交
1268 1269 1270 1271
      # [:readonly]
      #   If true, all the associated objects are readonly through the association.
      # [:validate]
      #   If false, don't validate the associated objects when saving the parent object. +true+ by default.
1272 1273
      # [:autosave]
      #   If true, always save any loaded members and destroy members marked for destruction, when saving the parent object. Off by default.
D
Initial  
David Heinemeier Hansson 已提交
1274 1275 1276
      #
      # Option examples:
      #   has_and_belongs_to_many :projects
1277
      #   has_and_belongs_to_many :projects, :include => [ :milestones, :manager ]
D
Initial  
David Heinemeier Hansson 已提交
1278 1279
      #   has_and_belongs_to_many :nations, :class_name => "Country"
      #   has_and_belongs_to_many :categories, :join_table => "prods_cats"
1280
      #   has_and_belongs_to_many :categories, :readonly => true
1281
      #   has_and_belongs_to_many :active_projects, :join_table => 'developers_projects', :delete_sql =>
1282
      #   'DELETE FROM developers_projects WHERE active=1 AND developer_id = #{id} AND project_id = #{record.id}'
1283
      def has_and_belongs_to_many(association_id, options = {}, &extension)
1284 1285
        reflection = create_has_and_belongs_to_many_reflection(association_id, options, &extension)
        collection_accessor_methods(reflection, HasAndBelongsToManyAssociation)
D
Initial  
David Heinemeier Hansson 已提交
1286

1287 1288
        # Don't use a before_destroy callback since users' before_destroy
        # callbacks will be executed after the association is wiped out.
1289
        old_method = "destroy_without_habtm_shim_for_#{reflection.name}"
1290
        class_eval <<-end_eval unless method_defined?(old_method)
1291 1292 1293 1294 1295
          alias_method :#{old_method}, :destroy_without_callbacks  # alias_method :destroy_without_habtm_shim_for_posts, :destroy_without_callbacks
          def destroy_without_callbacks                            # def destroy_without_callbacks
            #{reflection.name}.clear                               #   posts.clear
            #{old_method}                                          #   destroy_without_habtm_shim_for_posts
          end                                                      # end
1296 1297
        end_eval

1298
        add_association_callbacks(reflection.name, options)
D
Initial  
David Heinemeier Hansson 已提交
1299 1300 1301
      end

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

1317 1318
        def association_accessor_methods(reflection, association_proxy_class)
          define_method(reflection.name) do |*params|
1319
            force_reload = params.first unless params.empty?
1320
            association = association_instance_get(reflection.name)
1321

1322
            if association.nil? || force_reload
1323
              association = association_proxy_class.new(self, reflection)
1324
              retval = association.reload
1325
              if retval.nil? and association_proxy_class == BelongsToAssociation
1326
                association_instance_set(reflection.name, nil)
1327 1328
                return nil
              end
1329
              association_instance_set(reflection.name, association)
1330
            end
1331 1332

            association.target.nil? ? nil : association
1333 1334
          end

1335
          define_method("loaded_#{reflection.name}?") do
1336
            association = association_instance_get(reflection.name)
1337 1338 1339
            association && association.loaded?
          end

1340
          define_method("#{reflection.name}=") do |new_value|
1341
            association = association_instance_get(reflection.name)
1342

1343
            if association.nil? || association.target != new_value
1344
              association = association_proxy_class.new(self, reflection)
1345
            end
1346

1347 1348
            association.replace(new_value)
            association_instance_set(reflection.name, new_value.nil? ? nil : association)
1349
          end
1350

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

1359 1360
        def collection_reader_method(reflection, association_proxy_class)
          define_method(reflection.name) do |*params|
1361
            force_reload = params.first unless params.empty?
1362
            association = association_instance_get(reflection.name)
1363

1364
            unless association
1365
              association = association_proxy_class.new(self, reflection)
1366
              association_instance_set(reflection.name, association)
D
Initial  
David Heinemeier Hansson 已提交
1367
            end
1368

1369
            association.reload if force_reload
1370

1371 1372
            association
          end
1373 1374

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

1388
        end
D
Initial  
David Heinemeier Hansson 已提交
1389

1390
        def collection_accessor_methods(reflection, association_proxy_class, writer = true)
1391 1392
          collection_reader_method(reflection, association_proxy_class)

1393 1394 1395 1396 1397 1398 1399
          if writer
            define_method("#{reflection.name}=") do |new_value|
              # Loads proxy class instance (defined in collection_reader_method) if not already loaded
              association = send(reflection.name)
              association.replace(new_value)
              association
            end
1400

1401 1402
            define_method("#{reflection.name.to_s.singularize}_ids=") do |new_value|
              ids = (new_value || []).reject { |nid| nid.blank? }
1403
              send("#{reflection.name}=", reflection.klass.find(ids))
1404
            end
1405
          end
D
Initial  
David Heinemeier Hansson 已提交
1406
        end
1407

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

1414
            unless association
1415
              association = association_proxy_class.new(self, reflection)
1416
              association_instance_set(reflection.name, association)
1417 1418
            end

1419 1420 1421 1422 1423
            if association_proxy_class == HasOneAssociation
              association.send(constructor, attributees, replace_existing)
            else
              association.send(constructor, attributees)
            end
1424 1425
          end
        end
1426

1427 1428 1429 1430 1431 1432
        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)
1433
            association.class.increment_counter(cache_column, association.id) unless association.nil?
1434 1435 1436 1437 1438 1439
          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)
1440
            association.class.decrement_counter(cache_column, association.id) unless association.nil?
1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463
          end
          before_destroy(method_name)

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

1464
        def find_with_associations(options = {})
1465
          catch :invalid_query do
1466
            join_dependency = JoinDependency.new(self, merge_includes(scope(:find, :include), options[:include]), options[:joins])
1467 1468 1469 1470
            rows = select_all_rows(options, join_dependency)
            return join_dependency.instantiate(rows)
          end
          []
1471
        end
1472

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

P
Pratik Naik 已提交
1524 1525
        # Creates before_destroy callback methods that nullify, delete or destroy
        # has_one associated objects, according to the defined :dependent rule.
1526
        def configure_dependency_for_has_one(reflection)
1527 1528 1529
          if reflection.options.include?(:dependent)
            case reflection.options[:dependent]
              when :destroy
1530 1531
                method_name = "has_one_dependent_destroy_for_#{reflection.name}".to_sym
                define_method(method_name) do
1532
                  association = send(reflection.name)
1533 1534 1535
                  association.destroy unless association.nil?
                end
                before_destroy method_name
1536
              when :delete
1537 1538
                method_name = "has_one_dependent_delete_for_#{reflection.name}".to_sym
                define_method(method_name) do
P
Pratik Naik 已提交
1539 1540 1541 1542
                  # Retrieve the associated object and delete it. The retrieval
                  # is necessary because there may be multiple associated objects
                  # with foreign keys pointing to this object, and we only want
                  # to delete the correct one, not all of them.
1543
                  association = send(reflection.name)
1544
                  association.delete unless association.nil?
1545 1546
                end
                before_destroy method_name
1547
              when :nullify
1548 1549
                method_name = "has_one_dependent_nullify_for_#{reflection.name}".to_sym
                define_method(method_name) do
1550 1551
                  association = send(reflection.name)
                  association.update_attribute(reflection.primary_key_name, nil) unless association.nil?
1552 1553
                end
                before_destroy method_name
1554 1555 1556
              else
                raise ArgumentError, "The :dependent option expects either :destroy, :delete or :nullify (#{reflection.options[:dependent].inspect})"
            end
1557 1558 1559
          end
        end

1560 1561 1562 1563
        def configure_dependency_for_belongs_to(reflection)
          if reflection.options.include?(:dependent)
            case reflection.options[:dependent]
              when :destroy
1564 1565
                method_name = "belongs_to_dependent_destroy_for_#{reflection.name}".to_sym
                define_method(method_name) do
1566
                  association = send(reflection.name)
1567 1568
                  association.destroy unless association.nil?
                end
1569
                after_destroy method_name
1570
              when :delete
1571 1572
                method_name = "belongs_to_dependent_delete_for_#{reflection.name}".to_sym
                define_method(method_name) do
1573
                  association = send(reflection.name)
1574
                  association.delete unless association.nil?
1575
                end
1576
                after_destroy method_name
1577 1578 1579 1580 1581 1582
              else
                raise ArgumentError, "The :dependent option expects either :destroy or :delete (#{reflection.options[:dependent].inspect})"
            end
          end
        end

1583 1584 1585 1586 1587 1588 1589 1590
        def delete_all_has_many_dependencies(record, reflection_name, association_class, dependent_conditions)
          association_class.delete_all(dependent_conditions)
        end

        def nullify_has_many_dependencies(record, reflection_name, association_class, primary_key_name, dependent_conditions)
          association_class.update_all("#{primary_key_name} = NULL", dependent_conditions)
        end

1591 1592 1593 1594
        mattr_accessor :valid_keys_for_has_many_association
        @@valid_keys_for_has_many_association = [
          :class_name, :table_name, :foreign_key, :primary_key,
          :dependent,
1595
          :select, :conditions, :include, :order, :group, :having, :limit, :offset,
1596 1597 1598 1599 1600
          :as, :through, :source, :source_type,
          :uniq,
          :finder_sql, :counter_sql,
          :before_add, :after_add, :before_remove, :after_remove,
          :extend, :readonly,
1601
          :validate, :inverse_of
1602 1603
        ]

1604
        def create_has_many_reflection(association_id, options, &extension)
1605
          options.assert_valid_keys(valid_keys_for_has_many_association)
1606
          options[:extend] = create_extension_modules(association_id, extension, options[:extend])
1607

1608
          create_reflection(:has_many, association_id, options, self)
1609 1610
        end

1611 1612 1613 1614
        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,
1615
          :validate, :primary_key, :inverse_of
1616 1617
        ]

1618
        def create_has_one_reflection(association_id, options)
1619
          options.assert_valid_keys(valid_keys_for_has_one_association)
1620
          create_reflection(:has_one, association_id, options, self)
1621
        end
1622

1623 1624
        def create_has_one_through_reflection(association_id, options)
          options.assert_valid_keys(
1625
            :class_name, :foreign_key, :remote, :select, :conditions, :order, :include, :dependent, :counter_cache, :extend, :as, :through, :source, :source_type, :validate
1626 1627 1628
          )
          create_reflection(:has_one, association_id, options, self)
        end
1629

1630 1631
        mattr_accessor :valid_keys_for_belongs_to_association
        @@valid_keys_for_belongs_to_association = [
1632
          :class_name, :primary_key, :foreign_key, :foreign_type, :remote, :select, :conditions,
1633
          :include, :dependent, :counter_cache, :extend, :polymorphic, :readonly,
1634
          :validate, :touch, :inverse_of
1635 1636
        ]

1637
        def create_belongs_to_reflection(association_id, options)
1638
          options.assert_valid_keys(valid_keys_for_belongs_to_association)
1639 1640 1641 1642 1643 1644 1645 1646
          reflection = create_reflection(:belongs_to, association_id, options, self)

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

          reflection
        end
1647

1648 1649 1650
        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,
1651
          :select, :conditions, :include, :order, :group, :having, :limit, :offset,
1652
          :uniq,
1653
          :finder_sql, :counter_sql, :delete_sql, :insert_sql,
1654 1655 1656 1657 1658
          :before_add, :after_add, :before_remove, :after_remove,
          :extend, :readonly,
          :validate
        ]

1659
        def create_has_and_belongs_to_many_reflection(association_id, options, &extension)
1660
          options.assert_valid_keys(valid_keys_for_has_and_belongs_to_many_association)
1661
          options[:extend] = create_extension_modules(association_id, extension, options[:extend])
1662 1663

          reflection = create_reflection(:has_and_belongs_to_many, association_id, options, self)
1664 1665
          reflection.options[:join_table] ||= join_table_name(undecorated_table_name(self.to_s), undecorated_table_name(reflection.class_name))

1666 1667 1668
          if reflection.association_foreign_key == reflection.primary_key_name
            raise HasAndBelongsToManyAssociationForeignKeyNeeded.new(reflection)
          end
1669

1670 1671 1672 1673
          if connection.supports_primary_key? &&
             (connection.primary_key(reflection.options[:join_table]) rescue false)
             raise HasAndBelongsToManyAssociationWithPrimaryKeyError.new(reflection)
          end
1674

1675 1676 1677
          reflection
        end

1678
        def reflect_on_included_associations(associations)
1679
          [ associations ].flatten.collect { |association| reflect_on_association(association.to_s.intern) }
1680 1681
        end

1682
        def select_all_rows(options, join_dependency)
1683
          connection.select_all(
1684
            construct_finder_sql_with_included_associations(options, join_dependency),
1685 1686 1687
            "#{name} Load Including Associations"
          )
        end
1688

1689
        def construct_finder_sql_with_included_associations(options, join_dependency)
1690
          scope = scope(:find)
1691
          sql = "SELECT #{column_aliases(join_dependency)} FROM #{(scope && scope[:from]) || options[:from] || quoted_table_name} "
1692
          sql << join_dependency.join_associations.collect{|join| join.association_join }.join
1693

1694
          add_joins!(sql, options[:joins], scope)
1695
          add_conditions!(sql, options[:conditions], scope)
1696
          add_limited_ids_condition!(sql, options, join_dependency) if !using_limitable_reflections?(join_dependency.reflections) && ((scope && scope[:limit]) || options[:limit])
1697

1698
          add_group!(sql, options[:group], options[:having], scope)
1699
          add_order!(sql, options[:order], scope)
1700
          add_limit!(sql, options, scope) if using_limitable_reflections?(join_dependency.reflections)
1701
          add_lock!(sql, options, scope)
1702

1703 1704
          return sanitize_sql(sql)
        end
1705

1706 1707
        def add_limited_ids_condition!(sql, options, join_dependency)
          unless (id_list = select_limited_ids_list(options, join_dependency)).empty?
1708
            sql << "#{condition_word(sql)} #{connection.quote_table_name table_name}.#{primary_key} IN (#{id_list}) "
1709 1710
          else
            throw :invalid_query
1711 1712
          end
        end
1713

1714
        def select_limited_ids_list(options, join_dependency)
1715 1716
          pk = columns_hash[primary_key]

1717
          connection.select_all(
1718
            construct_finder_sql_for_association_limiting(options, join_dependency),
1719
            "#{name} Load IDs For Limited Eager Loading"
1720
          ).collect { |row| connection.quote(row[primary_key], pk) }.join(", ")
1721
        end
1722

1723
        def construct_finder_sql_for_association_limiting(options, join_dependency)
1724
          scope       = scope(:find)
1725 1726 1727 1728 1729

          # Only join tables referenced in order or conditions since this is particularly slow on the pre-query.
          tables_from_conditions = conditions_tables(options)
          tables_from_order      = order_tables(options)
          all_tables             = tables_from_conditions + tables_from_order
1730 1731 1732 1733
          distinct_join_associations = all_tables.uniq.map{|table|
            join_dependency.joins_for_table_name(table)
          }.flatten.compact.uniq

1734 1735 1736 1737 1738
          order = options[:order]
          if scoped_order = (scope && scope[:order])
            order = order ? "#{order}, #{scoped_order}" : scoped_order
          end

1739
          is_distinct = !options[:joins].blank? || include_eager_conditions?(options, tables_from_conditions) || include_eager_order?(options, tables_from_order)
1740
          sql = "SELECT "
1741
          if is_distinct
1742
            sql << connection.distinct("#{connection.quote_table_name table_name}.#{primary_key}", order)
1743 1744 1745
          else
            sql << primary_key
          end
1746
          sql << " FROM #{connection.quote_table_name table_name} "
1747

1748
          if is_distinct
1749
            sql << distinct_join_associations.collect { |assoc| assoc.association_join }.join
1750
            add_joins!(sql, options[:joins], scope)
1751
          end
1752

1753
          add_conditions!(sql, options[:conditions], scope)
1754
          add_group!(sql, options[:group], options[:having], scope)
1755

1756 1757
          if order && is_distinct
            connection.add_order_by_for_association_limiting!(sql, :order => order)
1758 1759
          else
            add_order!(sql, options[:order], scope)
1760
          end
1761

1762
          add_limit!(sql, options, scope)
1763

1764 1765
          return sanitize_sql(sql)
        end
1766

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

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

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

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

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

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

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

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

1836 1837
        def include_eager_select?(options, joined_tables = nil)
          (selects_tables(options) - (joined_tables || joined_tables(options))).any?
1838 1839
        end

1840
        def references_eager_loaded_tables?(options)
1841 1842
          joined_tables = joined_tables(options)
          include_eager_order?(options, nil, joined_tables) || include_eager_conditions?(options, nil, joined_tables) || include_eager_select?(options, joined_tables)
1843 1844
        end

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

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

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

1868 1869 1870
        def condition_word(sql)
          sql =~ /where/i ? " AND " : "WHERE "
        end
1871

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

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

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

1888
          def initialize(base, associations, joins)
1889
            @joins                 = [JoinBase.new(base, joins)]
1890 1891 1892 1893
            @associations          = associations
            @reflections           = []
            @base_records_hash     = {}
            @base_records_in_order = []
1894 1895
            @table_aliases         = Hash.new { |aliases, table| aliases[table] = 0 }
            @table_aliases[base.table_name] = 1
1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912
            build(associations)
          end

          def join_associations
            @joins[1..-1].to_a
          end

          def join_base
            @joins[0]
          end

          def instantiate(rows)
            rows.each_with_index do |row, i|
              primary_id = join_base.record_id(row)
              unless @base_records_hash[primary_id]
                @base_records_in_order << (@base_records_hash[primary_id] = join_base.instantiate(row))
              end
1913
              construct(@base_records_hash[primary_id], @associations, join_associations.dup, row)
1914
            end
1915
            remove_duplicate_results!(join_base.active_record, @base_records_in_order, @associations)
1916 1917 1918
            return @base_records_in_order
          end

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

                  parent_records = records.map do |record|
1936 1937 1938 1939
                    descendant = record.send(reflection.name)
                    next unless descendant
                    descendant.target.uniq! if is_collection
                    descendant
1940 1941
                  end.flatten.compact

1942
                  remove_duplicate_results!(reflection.klass, parent_records, associations[name]) unless parent_records.empty?
1943 1944 1945 1946
                end
            end
          end

1947
          def join_for_table_name(table_name)
1948 1949 1950
            join = (@joins.select{|j|j.aliased_table_name == table_name.gsub(/^\"(.*)\"$/){$1} }.first) rescue nil
            return join unless join.nil?
            @joins.select{|j|j.is_a?(JoinAssociation) && j.aliased_join_table_name == table_name.gsub(/^\"(.*)\"$/){$1} }.first rescue nil
1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965
          end

          def joins_for_table_name(table_name)
            join = join_for_table_name(table_name)
            result = nil
            if join && join.is_a?(JoinAssociation)
              result = [join]
              if join.parent && join.parent.is_a?(JoinAssociation)
                result = joins_for_table_name(join.parent.aliased_table_name) +
                         result
              end
            end
            result
          end

1966 1967 1968 1969 1970 1971 1972 1973
          protected
            def build(associations, parent = nil)
              parent ||= @joins.last
              case associations
                when Symbol, String
                  reflection = parent.reflections[associations.to_s.intern] or
                  raise ConfigurationError, "Association named '#{ associations }' was not found; perhaps you misspelled it?"
                  @reflections << reflection
1974
                  @joins << build_join_association(reflection, parent)
1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988
                when Array
                  associations.each do |association|
                    build(association, parent)
                  end
                when Hash
                  associations.keys.sort{|a,b|a.to_s<=>b.to_s}.each do |name|
                    build(name, parent)
                    build(associations[name])
                  end
                else
                  raise ConfigurationError, associations.inspect
              end
            end

1989 1990 1991 1992 1993
            # overridden in InnerJoinDependency subclass
            def build_join_association(reflection, parent)
              JoinAssociation.new(reflection, self, parent)
            end

1994 1995 1996
            def construct(parent, associations, joins, row)
              case associations
                when Symbol, String
1997 1998 1999 2000
                  join = joins.detect{|j| j.reflection.name.to_s == associations.to_s && j.parent_table_name == parent.class.table_name }
                  raise(ConfigurationError, "No such association") if join.nil?

                  joins.delete(join)
2001 2002 2003 2004 2005 2006 2007
                  construct_association(parent, join, row)
                when Array
                  associations.each do |association|
                    construct(parent, association, joins, row)
                  end
                when Hash
                  associations.keys.sort{|a,b|a.to_s<=>b.to_s}.each do |name|
2008 2009 2010 2011 2012
                    join = joins.detect{|j| j.reflection.name.to_s == name.to_s && j.parent_table_name == parent.class.table_name }
                    raise(ConfigurationError, "No such association") if join.nil?

                    association = construct_association(parent, join, row)
                    joins.delete(join)
2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024
                    construct(association, associations[name], joins, row) if association
                  end
                else
                  raise ConfigurationError, associations.inspect
              end
            end

            def construct_association(record, join, row)
              case join.reflection.macro
                when :has_many, :has_and_belongs_to_many
                  collection = record.send(join.reflection.name)
                  collection.loaded
2025

2026 2027
                  return nil if record.id.to_s != join.parent.record_id(row).to_s or row[join.aliased_primary_key].nil?
                  association = join.instantiate(row)
2028
                  collection.target.push(association)
2029
                  collection.__send__(:set_inverse_instance, association, record)
2030 2031
                when :has_one
                  return if record.id.to_s != join.parent.record_id(row).to_s
2032
                  return if record.instance_variable_defined?("@#{join.reflection.name}")
2033
                  association = join.instantiate(row) unless row[join.aliased_primary_key].nil?
2034
                  set_target_and_inverse(join, association, record)
2035
                when :belongs_to
2036 2037
                  return if record.id.to_s != join.parent.record_id(row).to_s or row[join.aliased_primary_key].nil?
                  association = join.instantiate(row)
2038
                  set_target_and_inverse(join, association, record)
2039 2040 2041 2042 2043 2044
                else
                  raise ConfigurationError, "unknown macro: #{join.reflection.macro}"
              end
              return association
            end

2045 2046 2047 2048 2049
            def set_target_and_inverse(join, association, record)
              association_proxy = record.send("set_#{join.reflection.name}_target", association)
              association_proxy.__send__(:set_inverse_instance, association, record)
            end

D
David Heinemeier Hansson 已提交
2050
          class JoinBase # :nodoc:
2051
            attr_reader :active_record, :table_joins
2052
            delegate    :table_name, :column_names, :primary_key, :reflections, :sanitize_sql, :to => :active_record
2053

2054
            def initialize(active_record, joins = nil)
2055 2056
              @active_record = active_record
              @cached_record = {}
2057
              @table_joins   = joins
2058 2059 2060 2061 2062 2063 2064
            end

            def aliased_prefix
              "t0"
            end

            def aliased_primary_key
2065
              "#{aliased_prefix}_r0"
2066 2067 2068 2069 2070 2071 2072
            end

            def aliased_table_name
              active_record.table_name
            end

            def column_names_with_alias
2073
              unless defined?(@column_names_with_alias)
2074
                @column_names_with_alias = []
2075

2076
                ([primary_key] + (column_names - [primary_key])).each_with_index do |column_name, i|
2077
                  @column_names_with_alias << [column_name, "#{aliased_prefix}_r#{i}"]
2078 2079
                end
              end
2080 2081

              @column_names_with_alias
2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092
            end

            def extract_record(row)
              column_names_with_alias.inject({}){|record, (cn, an)| record[cn] = row[an]; record}
            end

            def record_id(row)
              row[aliased_primary_key]
            end

            def instantiate(row)
2093
              @cached_record[record_id(row)] ||= active_record.send(:instantiate, extract_record(row))
2094 2095 2096
            end
          end

D
David Heinemeier Hansson 已提交
2097
          class JoinAssociation < JoinBase # :nodoc:
2098
            attr_reader :reflection, :parent, :aliased_table_name, :aliased_prefix, :aliased_join_table_name, :parent_table_name
2099
            delegate    :options, :klass, :through_reflection, :source_reflection, :to => :reflection
2100 2101

            def initialize(reflection, join_dependency, parent = nil)
2102 2103 2104 2105 2106
              reflection.check_validity!
              if reflection.options[:polymorphic]
                raise EagerLoadPolymorphicError.new(reflection)
              end

2107
              super(reflection.klass)
2108
              @join_dependency    = join_dependency
2109 2110 2111
              @parent             = parent
              @reflection         = reflection
              @aliased_prefix     = "t#{ join_dependency.joins.size }"
2112
              @parent_table_name  = parent.active_record.table_name
2113
              @aliased_table_name = aliased_table_name_for(table_name)
2114

2115 2116
              if reflection.macro == :has_and_belongs_to_many
                @aliased_join_table_name = aliased_table_name_for(reflection.options[:join_table], "_join")
2117
              end
2118

2119
              if [:has_many, :has_one].include?(reflection.macro) && reflection.options[:through]
2120
                @aliased_join_table_name = aliased_table_name_for(reflection.through_reflection.klass.table_name, "_join")
2121
              end
2122 2123 2124
            end

            def association_join
2125
              connection = reflection.active_record.connection
2126
              join = case reflection.macro
2127
                when :has_and_belongs_to_many
2128
                  " #{join_type} %s ON %s.%s = %s.%s " % [
2129
                     table_alias_for(options[:join_table], aliased_join_table_name),
2130
                     connection.quote_table_name(aliased_join_table_name),
2131
                     options[:foreign_key] || reflection.active_record.to_s.foreign_key,
2132
                     connection.quote_table_name(parent.aliased_table_name),
2133
                     reflection.active_record.primary_key] +
2134
                  " #{join_type} %s ON %s.%s = %s.%s " % [
2135
                     table_name_and_alias,
2136 2137
                     connection.quote_table_name(aliased_table_name),
                     klass.primary_key,
2138
                     connection.quote_table_name(aliased_join_table_name),
2139
                     options[:association_foreign_key] || klass.to_s.foreign_key
2140 2141
                     ]
                when :has_many, :has_one
2142
                  case
2143
                    when reflection.options[:through]
2144
                      through_conditions = through_reflection.options[:conditions] ? "AND #{interpolate_sql(sanitize_sql(through_reflection.options[:conditions]))}" : ''
2145 2146 2147 2148

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

2149
                      if through_reflection.options[:as] # has_many :through against a polymorphic join
2150 2151
                        jt_foreign_key = through_reflection.options[:as].to_s + '_id'
                        jt_as_extra = " AND %s.%s = %s" % [
2152 2153
                          connection.quote_table_name(aliased_join_table_name),
                          connection.quote_column_name(through_reflection.options[:as].to_s + '_type'),
2154
                          klass.quote_value(parent.active_record.base_class.name)
2155
                        ]
2156
                      else
2157
                        jt_foreign_key = through_reflection.primary_key_name
2158
                      end
2159

2160 2161
                      case source_reflection.macro
                      when :has_many
2162 2163 2164
                        if source_reflection.options[:as]
                          first_key   = "#{source_reflection.options[:as]}_id"
                          second_key  = options[:foreign_key] || primary_key
2165
                          as_extra    = " AND %s.%s = %s" % [
2166 2167
                            connection.quote_table_name(aliased_table_name),
                            connection.quote_column_name("#{source_reflection.options[:as]}_type"),
2168
                            klass.quote_value(source_reflection.active_record.base_class.name)
2169 2170
                          ]
                        else
2171 2172 2173
                          first_key   = through_reflection.klass.base_class.to_s.foreign_key
                          second_key  = options[:foreign_key] || primary_key
                        end
2174

2175 2176
                        unless through_reflection.klass.descends_from_active_record?
                          jt_sti_extra = " AND %s.%s = %s" % [
2177 2178
                            connection.quote_table_name(aliased_join_table_name),
                            connection.quote_column_name(through_reflection.active_record.inheritance_column),
2179
                            through_reflection.klass.quote_value(through_reflection.klass.sti_name)]
2180 2181 2182 2183 2184 2185
                        end
                      when :belongs_to
                        first_key = primary_key
                        if reflection.options[:source_type]
                          second_key = source_reflection.association_foreign_key
                          jt_source_extra = " AND %s.%s = %s" % [
2186 2187
                            connection.quote_table_name(aliased_join_table_name),
                            connection.quote_column_name(reflection.source_reflection.options[:foreign_type]),
2188
                            klass.quote_value(reflection.options[:source_type])
2189
                          ]
2190
                        else
2191
                          second_key = source_reflection.primary_key_name
2192
                        end
2193
                      end
2194

2195
                      " #{join_type} %s ON (%s.%s = %s.%s%s%s%s) " % [
2196
                        table_alias_for(through_reflection.klass.table_name, aliased_join_table_name),
2197
                        connection.quote_table_name(parent.aliased_table_name),
2198
                        connection.quote_column_name(parent.primary_key),
2199
                        connection.quote_table_name(aliased_join_table_name),
2200
                        connection.quote_column_name(jt_foreign_key),
2201 2202
                        jt_as_extra, jt_source_extra, jt_sti_extra
                      ] +
2203
                      " #{join_type} %s ON (%s.%s = %s.%s%s) " % [
2204
                        table_name_and_alias,
2205
                        connection.quote_table_name(aliased_table_name),
2206
                        connection.quote_column_name(first_key),
2207
                        connection.quote_table_name(aliased_join_table_name),
2208
                        connection.quote_column_name(second_key),
2209 2210 2211
                        as_extra
                      ]

2212
                    when reflection.options[:as] && [:has_many, :has_one].include?(reflection.macro)
2213
                      " #{join_type} %s ON %s.%s = %s.%s AND %s.%s = %s" % [
2214
                        table_name_and_alias,
2215
                        connection.quote_table_name(aliased_table_name),
2216
                        "#{reflection.options[:as]}_id",
2217
                        connection.quote_table_name(parent.aliased_table_name),
2218
                        parent.primary_key,
2219
                        connection.quote_table_name(aliased_table_name),
2220
                        "#{reflection.options[:as]}_type",
2221
                        klass.quote_value(parent.active_record.base_class.name)
2222 2223
                      ]
                    else
2224
                      foreign_key = options[:foreign_key] || reflection.active_record.name.foreign_key
2225
                      " #{join_type} %s ON %s.%s = %s.%s " % [
2226
                        table_name_and_alias,
2227
                        aliased_table_name,
2228
                        foreign_key,
2229
                        parent.aliased_table_name,
2230
                        reflection.options[:primary_key] || parent.primary_key
2231 2232
                      ]
                  end
2233
                when :belongs_to
2234
                  " #{join_type} %s ON %s.%s = %s.%s " % [
2235
                     table_name_and_alias,
2236 2237
                     connection.quote_table_name(aliased_table_name),
                     reflection.klass.primary_key,
2238
                     connection.quote_table_name(parent.aliased_table_name),
2239
                     options[:foreign_key] || reflection.primary_key_name
2240 2241 2242
                    ]
                else
                  ""
2243
              end || ''
2244 2245
              join << %(AND %s) % [
                klass.send(:type_condition, aliased_table_name)] unless klass.descends_from_active_record?
2246 2247

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

2251
              join
2252
            end
2253

2254
            protected
2255

2256
              def aliased_table_name_for(name, suffix = nil)
2257
                if !parent.table_joins.blank? && parent.table_joins.to_s.downcase =~ %r{join(\s+\w+)?\s+#{active_record.connection.quote_table_name name.downcase}\son}
2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272
                  @join_dependency.table_aliases[name] += 1
                end

                unless @join_dependency.table_aliases[name].zero?
                  # if the table name has been used, then use an alias
                  name = active_record.connection.table_alias_for "#{pluralize(reflection.name)}_#{parent_table_name}#{suffix}"
                  table_index = @join_dependency.table_aliases[name]
                  @join_dependency.table_aliases[name] += 1
                  name = name[0..active_record.connection.table_alias_length-3] + "_#{table_index+1}" if table_index > 0
                else
                  @join_dependency.table_aliases[name] += 1
                end

                name
              end
2273

2274 2275 2276
              def pluralize(table_name)
                ActiveRecord::Base.pluralize_table_names ? table_name.to_s.pluralize : table_name
              end
2277

2278
              def table_alias_for(table_name, table_alias)
2279
                 "#{reflection.active_record.connection.quote_table_name(table_name)} #{table_alias if table_name != table_alias}".strip
2280 2281 2282 2283 2284
              end

              def table_name_and_alias
                table_alias_for table_name, @aliased_table_name
              end
2285 2286

              def interpolate_sql(sql)
2287 2288
                instance_eval("%@#{sql.gsub('@', '\@')}@")
              end
2289 2290

            private
2291 2292 2293 2294
              def join_type
                "LEFT OUTER JOIN"
              end
          end
2295 2296 2297 2298 2299 2300 2301 2302 2303
        end

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

          class InnerJoinAssociation < JoinAssociation
2304 2305 2306 2307
            private
              def join_type
                "INNER JOIN"
              end
2308 2309
          end
        end
2310

2311
    end
D
Initial  
David Heinemeier Hansson 已提交
2312
  end
2313
end