base.rb 132.2 KB
Newer Older
1
require 'benchmark'
D
Initial  
David Heinemeier Hansson 已提交
2
require 'yaml'
3
require 'set'
J
José Valim 已提交
4
require 'active_support/benchmarkable'
J
Jeremy Kemper 已提交
5
require 'active_support/dependencies'
6
require 'active_support/time'
J
Jeremy Kemper 已提交
7 8 9 10 11 12 13 14
require 'active_support/core_ext/class/attribute_accessors'
require 'active_support/core_ext/class/delegating_attributes'
require 'active_support/core_ext/class/inheritable_attributes'
require 'active_support/core_ext/array/extract_options'
require 'active_support/core_ext/hash/deep_merge'
require 'active_support/core_ext/hash/indifferent_access'
require 'active_support/core_ext/hash/slice'
require 'active_support/core_ext/string/behavior'
15
require 'active_support/core_ext/object/metaclass'
16
require 'active_support/core_ext/module/delegation'
D
Initial  
David Heinemeier Hansson 已提交
17 18

module ActiveRecord #:nodoc:
P
Pratik Naik 已提交
19
  # Generic Active Record exception class.
20
  class ActiveRecordError < StandardError
D
Initial  
David Heinemeier Hansson 已提交
21
  end
22

P
Pratik Naik 已提交
23
  # Raised when the single-table inheritance mechanism fails to locate the subclass
24
  # (for example due to improper usage of column that +inheritance_column+ points to).
25 26
  class SubclassNotFound < ActiveRecordError #:nodoc:
  end
27

28
  # Raised when an object assigned to an association has an incorrect type.
29
  #
30 31 32
  #   class Ticket < ActiveRecord::Base
  #     has_many :patches
  #   end
33
  #
34 35 36
  #   class Patch < ActiveRecord::Base
  #     belongs_to :ticket
  #   end
37
  #
38 39
  #   # Comments are not patches, this assignment raises AssociationTypeMismatch.
  #   @ticket.patches << Comment.new(:content => "Please attach tests to your patch.")
40
  class AssociationTypeMismatch < ActiveRecordError
D
Initial  
David Heinemeier Hansson 已提交
41
  end
42 43 44

  # Raised when unserialized object's type mismatches one specified for serializable field.
  class SerializationTypeMismatch < ActiveRecordError
D
Initial  
David Heinemeier Hansson 已提交
45
  end
46

P
Pratik Naik 已提交
47
  # Raised when adapter not specified on connection (or configuration file <tt>config/database.yml</tt> misses adapter field).
48
  class AdapterNotSpecified < ActiveRecordError
D
Initial  
David Heinemeier Hansson 已提交
49
  end
50

P
Pratik Naik 已提交
51
  # Raised when Active Record cannot find database adapter specified in <tt>config/database.yml</tt> or programmatically.
52
  class AdapterNotFound < ActiveRecordError
D
Initial  
David Heinemeier Hansson 已提交
53
  end
54

P
Pratik Naik 已提交
55
  # Raised when connection to the database could not been established (for example when <tt>connection=</tt> is given a nil object).
56
  class ConnectionNotEstablished < ActiveRecordError
D
Initial  
David Heinemeier Hansson 已提交
57
  end
58

P
Pratik Naik 已提交
59
  # Raised when Active Record cannot find record by given id or set of ids.
60
  class RecordNotFound < ActiveRecordError
D
Initial  
David Heinemeier Hansson 已提交
61
  end
62 63 64 65

  # Raised by ActiveRecord::Base.save! and ActiveRecord::Base.create! methods when record cannot be
  # saved because record is invalid.
  class RecordNotSaved < ActiveRecordError
66
  end
67 68 69

  # Raised when SQL statement cannot be executed by the database (for example, it's often the case for MySQL when Ruby driver used is too old).
  class StatementInvalid < ActiveRecordError
D
Initial  
David Heinemeier Hansson 已提交
70
  end
71

72 73 74 75 76 77 78 79 80 81 82
  # Parent class for all specific exceptions which wrap database driver exceptions
  # provides access to the original exception also.
  class WrappedDatabaseException < StatementInvalid
    attr_reader :original_exception

    def initialize(message, original_exception)
      super(message)
      @original_exception, = original_exception
    end
  end

83
  # Raised when a record cannot be inserted because it would violate a uniqueness constraint.
84
  class RecordNotUnique < WrappedDatabaseException
85 86
  end

87
  # Raised when a record cannot be inserted or updated because it references a non-existent record.
88
  class InvalidForeignKey < WrappedDatabaseException
89 90
  end

91
  # Raised when number of bind variables in statement given to <tt>:condition</tt> key (for example, when using +find+ method)
92 93
  # does not match number of expected variables.
  #
94
  # For example, in
95
  #
96
  #   Location.find :all, :conditions => ["lat = ? AND lng = ?", 53.7362]
97
  #
98
  # two placeholders are given but only one variable to fill them.
99
  class PreparedStatementInvalid < ActiveRecordError
100
  end
101 102 103 104 105

  # Raised on attempt to save stale record. Record is stale when it's being saved in another query after
  # instantiation, for example, when two users edit the same wiki page and one starts editing and saves
  # the page before the other.
  #
P
Pratik Naik 已提交
106
  # Read more about optimistic locking in ActiveRecord::Locking module RDoc.
107
  class StaleObjectError < ActiveRecordError
108
  end
109 110 111 112

  # Raised when association is being configured improperly or
  # user tries to use offset and limit together with has_many or has_and_belongs_to_many associations.
  class ConfigurationError < ActiveRecordError
113
  end
114 115 116

  # Raised on attempt to update record that is instantiated as read only.
  class ReadOnlyRecord < ActiveRecordError
117
  end
118

P
Pratik Naik 已提交
119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145
  # ActiveRecord::Transactions::ClassMethods.transaction uses this exception
  # to distinguish a deliberate rollback from other exceptional situations.
  # Normally, raising an exception will cause the +transaction+ method to rollback
  # the database transaction *and* pass on the exception. But if you raise an
  # ActiveRecord::Rollback exception, then the database transaction will be rolled back,
  # without passing on the exception.
  #
  # For example, you could do this in your controller to rollback a transaction:
  #
  #   class BooksController < ActionController::Base
  #     def create
  #       Book.transaction do
  #         book = Book.new(params[:book])
  #         book.save!
  #         if today_is_friday?
  #           # The system must fail on Friday so that our support department
  #           # won't be out of job. We silently rollback this transaction
  #           # without telling the user.
  #           raise ActiveRecord::Rollback, "Call tech support!"
  #         end
  #       end
  #       # ActiveRecord::Rollback is the only exception that won't be passed on
  #       # by ActiveRecord::Base.transaction, so this line will still be reached
  #       # even on Friday.
  #       redirect_to root_url
  #     end
  #   end
146
  class Rollback < ActiveRecordError
147
  end
148

P
Pratik Naik 已提交
149
  # Raised when attribute has a name reserved by Active Record (when attribute has name of one of Active Record instance methods).
150
  class DangerousAttributeError < ActiveRecordError
151
  end
152

153 154 155 156
  # Raised when unknown attributes are supplied via mass assignment.
  class UnknownAttributeError < NoMethodError
  end

P
Pratik Naik 已提交
157
  # Raised when an error occurred while doing a mass assignment to an attribute through the
P
Pratik Naik 已提交
158 159 160
  # <tt>attributes=</tt> method. The exception has an +attribute+ property that is the name of the
  # offending attribute.
  class AttributeAssignmentError < ActiveRecordError
161 162 163 164 165 166 167
    attr_reader :exception, :attribute
    def initialize(message, exception, attribute)
      @exception = exception
      @attribute = attribute
      @message = message
    end
  end
168

P
Pratik Naik 已提交
169 170 171 172
  # Raised when there are multiple errors while doing a mass assignment through the +attributes+
  # method. The exception has an +errors+ property that contains an array of AttributeAssignmentError
  # objects, each corresponding to the error while assigning to an attribute.
  class MultiparameterAssignmentErrors < ActiveRecordError
173 174 175 176 177
    attr_reader :errors
    def initialize(errors)
      @errors = errors
    end
  end
178

179
  # Active Record objects don't specify their attributes directly, but rather infer them from the table definition with
D
Initial  
David Heinemeier Hansson 已提交
180 181
  # which they're linked. Adding, removing, and changing attributes and their type is done directly in the database. Any change
  # is instantly reflected in the Active Record objects. The mapping that binds a given Active Record class to a certain
182 183
  # database table will happen automatically in most common cases, but can be overwritten for the uncommon ones.
  #
D
Initial  
David Heinemeier Hansson 已提交
184
  # See the mapping rules in table_name and the full example in link:files/README.html for more insight.
185
  #
D
Initial  
David Heinemeier Hansson 已提交
186
  # == Creation
187
  #
188
  # Active Records accept constructor parameters either in a hash or as a block. The hash method is especially useful when
189
  # you're receiving the data from somewhere else, like an HTTP request. It works like this:
190
  #
191
  #   user = User.new(:name => "David", :occupation => "Code Artist")
D
Initial  
David Heinemeier Hansson 已提交
192
  #   user.name # => "David"
193
  #
D
Initial  
David Heinemeier Hansson 已提交
194
  # You can also use block initialization:
195
  #
D
Initial  
David Heinemeier Hansson 已提交
196 197 198 199
  #   user = User.new do |u|
  #     u.name = "David"
  #     u.occupation = "Code Artist"
  #   end
200
  #
D
Initial  
David Heinemeier Hansson 已提交
201
  # And of course you can just create a bare object and specify the attributes after the fact:
202
  #
D
Initial  
David Heinemeier Hansson 已提交
203 204 205
  #   user = User.new
  #   user.name = "David"
  #   user.occupation = "Code Artist"
206
  #
D
Initial  
David Heinemeier Hansson 已提交
207
  # == Conditions
208
  #
209
  # Conditions can either be specified as a string, array, or hash representing the WHERE-part of an SQL statement.
D
Initial  
David Heinemeier Hansson 已提交
210
  # The array form is to be used when the condition input is tainted and requires sanitization. The string form can
211
  # be used for statements that don't involve tainted data. The hash form works much like the array form, except
212
  # only equality and range is possible. Examples:
213
  #
214
  #   class User < ActiveRecord::Base
D
Initial  
David Heinemeier Hansson 已提交
215
  #     def self.authenticate_unsafely(user_name, password)
216
  #       find(:first, :conditions => "user_name = '#{user_name}' AND password = '#{password}'")
D
Initial  
David Heinemeier Hansson 已提交
217
  #     end
218
  #
D
Initial  
David Heinemeier Hansson 已提交
219
  #     def self.authenticate_safely(user_name, password)
220
  #       find(:first, :conditions => [ "user_name = ? AND password = ?", user_name, password ])
D
Initial  
David Heinemeier Hansson 已提交
221
  #     end
222 223 224 225
  #
  #     def self.authenticate_safely_simply(user_name, password)
  #       find(:first, :conditions => { :user_name => user_name, :password => password })
  #     end
D
Initial  
David Heinemeier Hansson 已提交
226
  #   end
227
  #
228
  # The <tt>authenticate_unsafely</tt> method inserts the parameters directly into the query and is thus susceptible to SQL-injection
229
  # attacks if the <tt>user_name</tt> and +password+ parameters come directly from an HTTP request. The <tt>authenticate_safely</tt>  and
230
  # <tt>authenticate_safely_simply</tt> both will sanitize the <tt>user_name</tt> and +password+ before inserting them in the query,
231
  # which will ensure that an attacker can't escape the query and fake the login (or worse).
232
  #
233
  # When using multiple parameters in the conditions, it can easily become hard to read exactly what the fourth or fifth
234
  # question mark is supposed to represent. In those cases, you can resort to named bind variables instead. That's done by replacing
235 236
  # the question marks with symbols and supplying a hash with values for the matching symbol keys:
  #
237
  #   Company.find(:first, :conditions => [
238
  #     "id = :id AND name = :name AND division = :division AND created_at > :accounting_date",
239 240 241
  #     { :id => 3, :name => "37signals", :division => "First", :accounting_date => '2005-01-01' }
  #   ])
  #
242 243 244 245 246 247
  # Similarly, a simple hash without a statement will generate conditions based on equality with the SQL AND
  # operator. For instance:
  #
  #   Student.find(:all, :conditions => { :first_name => "Harvey", :status => 1 })
  #   Student.find(:all, :conditions => params[:student])
  #
248 249 250
  # A range may be used in the hash to use the SQL BETWEEN operator:
  #
  #   Student.find(:all, :conditions => { :grade => 9..12 })
251
  #
P
Pratik Naik 已提交
252 253 254 255
  # An array may be used in the hash to use the SQL IN operator:
  #
  #   Student.find(:all, :conditions => { :grade => [9,11,12] })
  #
P
Pratik Naik 已提交
256 257 258 259 260 261
  # When joining tables, nested hashes or keys written in the form 'table_name.column_name' can be used to qualify the table name of a
  # particular condition. For instance:
  #
  #   Student.find(:all, :conditions => { :schools => { :type => 'public' }}, :joins => :schools)
  #   Student.find(:all, :conditions => { 'schools.type' => 'public' }, :joins => :schools)
  #
D
Initial  
David Heinemeier Hansson 已提交
262
  # == Overwriting default accessors
263
  #
264 265
  # All column values are automatically available through basic accessors on the Active Record object, but sometimes you
  # want to specialize this behavior. This can be done by overwriting the default accessors (using the same
P
Pratik Naik 已提交
266
  # name as the attribute) and calling <tt>read_attribute(attr_name)</tt> and <tt>write_attribute(attr_name, value)</tt> to actually change things.
D
Initial  
David Heinemeier Hansson 已提交
267
  # Example:
268
  #
D
Initial  
David Heinemeier Hansson 已提交
269 270
  #   class Song < ActiveRecord::Base
  #     # Uses an integer of seconds to hold the length of the song
271
  #
D
Initial  
David Heinemeier Hansson 已提交
272
  #     def length=(minutes)
273
  #       write_attribute(:length, minutes.to_i * 60)
D
Initial  
David Heinemeier Hansson 已提交
274
  #     end
275
  #
D
Initial  
David Heinemeier Hansson 已提交
276
  #     def length
277
  #       read_attribute(:length) / 60
D
Initial  
David Heinemeier Hansson 已提交
278 279
  #     end
  #   end
280
  #
P
Pratik Naik 已提交
281 282
  # You can alternatively use <tt>self[:attribute]=(value)</tt> and <tt>self[:attribute]</tt> instead of <tt>write_attribute(:attribute, value)</tt> and
  # <tt>read_attribute(:attribute)</tt> as a shorter form.
283
  #
284 285 286 287
  # == Attribute query methods
  #
  # In addition to the basic accessors, query methods are also automatically available on the Active Record object.
  # Query methods allow you to test whether an attribute value is present.
288
  #
289 290 291 292 293 294 295 296 297
  # For example, an Active Record User with the <tt>name</tt> attribute has a <tt>name?</tt> method that you can call
  # to determine whether the user has a name:
  #
  #   user = User.new(:name => "David")
  #   user.name? # => true
  #
  #   anonymous = User.new(:name => "")
  #   anonymous.name? # => false
  #
298
  # == Accessing attributes before they have been typecasted
299
  #
300
  # Sometimes you want to be able to read the raw attribute data without having the column-determined typecast run its course first.
P
Pratik Naik 已提交
301
  # That can be done by using the <tt><attribute>_before_type_cast</tt> accessors that all attributes have. For example, if your Account model
P
Pratik Naik 已提交
302
  # has a <tt>balance</tt> attribute, you can call <tt>account.balance_before_type_cast</tt> or <tt>account.id_before_type_cast</tt>.
303 304
  #
  # This is especially useful in validation situations where the user might supply a string for an integer field and you want to display
305
  # the original string back in an error message. Accessing the attribute normally would typecast the string to 0, which isn't what you
306 307
  # want.
  #
308 309
  # == Dynamic attribute-based finders
  #
310
  # Dynamic attribute-based finders are a cleaner way of getting (and/or creating) objects by simple queries without turning to SQL. They work by
D
David Heinemeier Hansson 已提交
311
  # appending the name of an attribute to <tt>find_by_</tt>, <tt>find_last_by_</tt>, or <tt>find_all_by_</tt>, so you get finders like <tt>Person.find_by_user_name</tt>,
P
Pratik Naik 已提交
312
  # <tt>Person.find_all_by_last_name</tt>, and <tt>Payment.find_by_transaction_id</tt>. So instead of writing
313 314
  # <tt>Person.find(:first, :conditions => ["user_name = ?", user_name])</tt>, you just do <tt>Person.find_by_user_name(user_name)</tt>.
  # And instead of writing <tt>Person.find(:all, :conditions => ["last_name = ?", last_name])</tt>, you just do <tt>Person.find_all_by_last_name(last_name)</tt>.
315
  #
316 317
  # It's also possible to use multiple attributes in the same find by separating them with "_and_", so you get finders like
  # <tt>Person.find_by_user_name_and_password</tt> or even <tt>Payment.find_by_purchaser_and_state_and_country</tt>. So instead of writing
318
  # <tt>Person.find(:first, :conditions => ["user_name = ? AND password = ?", user_name, password])</tt>, you just do
319
  # <tt>Person.find_by_user_name_and_password(user_name, password)</tt>.
320
  #
P
Pratik Naik 已提交
321 322
  # It's even possible to use all the additional parameters to find. For example, the full interface for <tt>Payment.find_all_by_amount</tt>
  # is actually <tt>Payment.find_all_by_amount(amount, options)</tt>. And the full interface to <tt>Person.find_by_user_name</tt> is
323
  # actually <tt>Person.find_by_user_name(user_name, options)</tt>. So you could call <tt>Payment.find_all_by_amount(50, :order => "created_on")</tt>.
324
  # Also you may call <tt>Payment.find_last_by_amount(amount, options)</tt> returning the last record matching that amount and options.
325
  #
326
  # The same dynamic finder style can be used to create the object if it doesn't already exist. This dynamic finder is called with
327
  # <tt>find_or_create_by_</tt> and will return the object if it already exists and otherwise creates it, then returns it. Protected attributes won't be set unless they are given in a block. For example:
328 329 330
  #
  #   # No 'Summer' tag exists
  #   Tag.find_or_create_by_name("Summer") # equal to Tag.create(:name => "Summer")
331
  #
332 333 334
  #   # Now the 'Summer' tag does exist
  #   Tag.find_or_create_by_name("Summer") # equal to Tag.find_by_name("Summer")
  #
335 336 337
  #   # Now 'Bob' exist and is an 'admin'
  #   User.find_or_create_by_name('Bob', :age => 40) { |u| u.admin = true }
  #
P
Pratik Naik 已提交
338
  # Use the <tt>find_or_initialize_by_</tt> finder if you want to return a new record without saving it first. Protected attributes won't be set unless they are given in a block. For example:
339 340 341
  #
  #   # No 'Winter' tag exists
  #   winter = Tag.find_or_initialize_by_name("Winter")
342
  #   winter.new_record? # true
343
  #
344 345 346 347 348 349 350
  # To find by a subset of the attributes to be used for instantiating a new object, pass a hash instead of
  # a list of parameters. For example:
  #
  #   Tag.find_or_create_by_name(:name => "rails", :creator => current_user)
  #
  # That will either find an existing tag named "rails", or create a new one while setting the user that created it.
  #
351
  # == Saving arrays, hashes, and other non-mappable objects in text columns
352 353
  #
  # Active Record can serialize any object in text columns using YAML. To do so, you must specify this with a call to the class method +serialize+.
354
  # This makes it possible to store arrays, hashes, and other non-mappable objects without doing any additional work. Example:
355
  #
D
Initial  
David Heinemeier Hansson 已提交
356 357 358
  #   class User < ActiveRecord::Base
  #     serialize :preferences
  #   end
359
  #
360
  #   user = User.create(:preferences => { "background" => "black", "display" => large })
D
Initial  
David Heinemeier Hansson 已提交
361
  #   User.find(user.id).preferences # => { "background" => "black", "display" => large }
362
  #
363
  # You can also specify a class option as the second parameter that'll raise an exception if a serialized object is retrieved as a
P
Pratik Naik 已提交
364
  # descendant of a class not in the hierarchy. Example:
365
  #
D
Initial  
David Heinemeier Hansson 已提交
366
  #   class User < ActiveRecord::Base
367
  #     serialize :preferences, Hash
D
Initial  
David Heinemeier Hansson 已提交
368
  #   end
369
  #
370
  #   user = User.create(:preferences => %w( one two three ))
D
Initial  
David Heinemeier Hansson 已提交
371
  #   User.find(user.id).preferences    # raises SerializationTypeMismatch
372
  #
D
Initial  
David Heinemeier Hansson 已提交
373 374
  # == Single table inheritance
  #
375
  # Active Record allows inheritance by storing the name of the class in a column that by default is named "type" (can be changed
D
Initial  
David Heinemeier Hansson 已提交
376 377 378 379 380 381 382
  # by overwriting <tt>Base.inheritance_column</tt>). This means that an inheritance looking like this:
  #
  #   class Company < ActiveRecord::Base; end
  #   class Firm < Company; end
  #   class Client < Company; end
  #   class PriorityClient < Client; end
  #
P
Pratik Naik 已提交
383 384
  # When you do <tt>Firm.create(:name => "37signals")</tt>, this record will be saved in the companies table with type = "Firm". You can then
  # fetch this row again using <tt>Company.find(:first, "name = '37signals'")</tt> and it will return a Firm object.
D
Initial  
David Heinemeier Hansson 已提交
385
  #
386 387 388
  # If you don't have a type column defined in your table, single-table inheritance won't be triggered. In that case, it'll work just
  # like normal subclasses with no special magic for differentiating between them or reloading the right type with find.
  #
D
Initial  
David Heinemeier Hansson 已提交
389 390
  # Note, all the attributes for all the cases are kept in the same table. Read more:
  # http://www.martinfowler.com/eaaCatalog/singleTableInheritance.html
391
  #
D
Initial  
David Heinemeier Hansson 已提交
392 393 394
  # == Connection to multiple databases in different models
  #
  # Connections are usually created through ActiveRecord::Base.establish_connection and retrieved by ActiveRecord::Base.connection.
395
  # All classes inheriting from ActiveRecord::Base will use this connection. But you can also set a class-specific connection.
P
Pratik Naik 已提交
396 397
  # For example, if Course is an ActiveRecord::Base, but resides in a different database, you can just say <tt>Course.establish_connection</tt>
  # and Course and all of its subclasses will use this connection instead.
D
Initial  
David Heinemeier Hansson 已提交
398 399 400 401 402
  #
  # This feature is implemented by keeping a connection pool in ActiveRecord::Base that is a Hash indexed by the class. If a connection is
  # requested, the retrieve_connection method will go up the class-hierarchy until a connection is found in the connection pool.
  #
  # == Exceptions
403
  #
P
Pratik Naik 已提交
404 405
  # * ActiveRecordError - Generic error class and superclass of all other errors raised by Active Record.
  # * AdapterNotSpecified - The configuration hash used in <tt>establish_connection</tt> didn't include an
D
Initial  
David Heinemeier Hansson 已提交
406
  #   <tt>:adapter</tt> key.
P
Pratik Naik 已提交
407
  # * AdapterNotFound - The <tt>:adapter</tt> key used in <tt>establish_connection</tt> specified a non-existent adapter
408
  #   (or a bad spelling of an existing one).
P
Pratik Naik 已提交
409 410 411 412 413 414 415 416 417
  # * AssociationTypeMismatch - The object assigned to the association wasn't of the type specified in the association definition.
  # * SerializationTypeMismatch - The serialized object wasn't of the class specified as the second parameter.
  # * ConnectionNotEstablished+ - No connection has been established. Use <tt>establish_connection</tt> before querying.
  # * RecordNotFound - No record responded to the +find+ method. Either the row with the given ID doesn't exist
  #   or the row didn't meet the additional restrictions. Some +find+ calls do not raise this exception to signal
  #   nothing was found, please check its documentation for further details.
  # * StatementInvalid - The database server rejected the SQL statement. The precise error is added in the message.
  # * MultiparameterAssignmentErrors - Collection of errors that occurred during a mass assignment using the
  #   <tt>attributes=</tt> method. The +errors+ property of this exception contains an array of AttributeAssignmentError
418
  #   objects that should be inspected to determine which attributes triggered the errors.
P
Pratik Naik 已提交
419
  # * AttributeAssignmentError - An error occurred while doing a mass assignment through the <tt>attributes=</tt> method.
420
  #   You can inspect the +attribute+ property of the exception object to determine which attribute triggered the error.
421
  #
422
  # *Note*: The attributes listed are class-level attributes (accessible from both the class and instance level).
P
Pratik Naik 已提交
423
  # So it's possible to assign a logger to the class through <tt>Base.logger=</tt> which will then be used by all
D
Initial  
David Heinemeier Hansson 已提交
424 425
  # instances in the current object space.
  class Base
E
Emilio Tagua 已提交
426
    ##
P
Pratik Naik 已提交
427
    # :singleton-method:
D
Initial  
David Heinemeier Hansson 已提交
428 429
    # Accepts a logger conforming to the interface of Log4r or the default Ruby 1.8+ Logger class, which is then passed
    # on to any new database connections made and which can be retrieved on both a class and instance level by calling +logger+.
430
    cattr_accessor :logger, :instance_writer => false
J
Jeremy Kemper 已提交
431

D
Initial  
David Heinemeier Hansson 已提交
432 433 434 435 436
    def self.inherited(child) #:nodoc:
      @@subclasses[self] ||= []
      @@subclasses[self] << child
      super
    end
J
Jeremy Kemper 已提交
437

D
David Heinemeier Hansson 已提交
438
    def self.reset_subclasses #:nodoc:
439
      nonreloadables = []
440
      subclasses.each do |klass|
441
        unless ActiveSupport::Dependencies.autoloaded? klass
442 443 444
          nonreloadables << klass
          next
        end
445 446 447
        klass.instance_variables.each { |var| klass.send(:remove_instance_variable, var) }
        klass.instance_methods(false).each { |m| klass.send :undef_method, m }
      end
448 449
      @@subclasses = {}
      nonreloadables.each { |klass| (@@subclasses[klass.superclass] ||= []) << klass }
450 451
    end

D
Initial  
David Heinemeier Hansson 已提交
452
    @@subclasses = {}
453

P
Pratik Naik 已提交
454 455
    ##
    # :singleton-method:
P
Pratik Naik 已提交
456 457 458 459
    # Contains the database configuration - as is typically stored in config/database.yml -
    # as a Hash.
    #
    # For example, the following database.yml...
E
Emilio Tagua 已提交
460
    #
P
Pratik Naik 已提交
461 462 463
    #   development:
    #     adapter: sqlite3
    #     database: db/development.sqlite3
E
Emilio Tagua 已提交
464
    #
P
Pratik Naik 已提交
465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480
    #   production:
    #     adapter: sqlite3
    #     database: db/production.sqlite3
    #
    # ...would result in ActiveRecord::Base.configurations to look like this:
    #
    #   {
    #      'development' => {
    #         'adapter'  => 'sqlite3',
    #         'database' => 'db/development.sqlite3'
    #      },
    #      'production' => {
    #         'adapter'  => 'sqlite3',
    #         'database' => 'db/production.sqlite3'
    #      }
    #   }
481
    cattr_accessor :configurations, :instance_writer => false
482 483
    @@configurations = {}

P
Pratik Naik 已提交
484 485
    ##
    # :singleton-method:
486
    # Accessor for the prefix type that will be prepended to every primary key column name. The options are :table_name and
D
Initial  
David Heinemeier Hansson 已提交
487 488
    # :table_name_with_underscore. If the first is specified, the Product class will look for "productid" instead of "id" as
    # the primary column. If the latter is specified, the Product class will look for "product_id" instead of "id". Remember
489
    # that this is a global setting for all Active Records.
490
    cattr_accessor :primary_key_prefix_type, :instance_writer => false
D
Initial  
David Heinemeier Hansson 已提交
491 492
    @@primary_key_prefix_type = nil

P
Pratik Naik 已提交
493 494
    ##
    # :singleton-method:
495
    # Accessor for the name of the prefix string to prepend to every table name. So if set to "basecamp_", all
496
    # table names will be named like "basecamp_projects", "basecamp_people", etc. This is a convenient way of creating a namespace
D
Initial  
David Heinemeier Hansson 已提交
497
    # for tables in a shared database. By default, the prefix is the empty string.
498
    cattr_accessor :table_name_prefix, :instance_writer => false
D
Initial  
David Heinemeier Hansson 已提交
499 500
    @@table_name_prefix = ""

P
Pratik Naik 已提交
501 502
    ##
    # :singleton-method:
D
Initial  
David Heinemeier Hansson 已提交
503 504
    # Works like +table_name_prefix+, but appends instead of prepends (set to "_basecamp" gives "projects_basecamp",
    # "people_basecamp"). By default, the suffix is the empty string.
505
    cattr_accessor :table_name_suffix, :instance_writer => false
D
Initial  
David Heinemeier Hansson 已提交
506 507
    @@table_name_suffix = ""

P
Pratik Naik 已提交
508 509
    ##
    # :singleton-method:
510
    # Indicates whether table names should be the pluralized versions of the corresponding class names.
P
Pratik Naik 已提交
511
    # If true, the default table name for a Product class will be +products+. If false, it would just be +product+.
D
Initial  
David Heinemeier Hansson 已提交
512
    # See table_name for the full rules on table/class naming. This is true, by default.
513
    cattr_accessor :pluralize_table_names, :instance_writer => false
D
Initial  
David Heinemeier Hansson 已提交
514 515
    @@pluralize_table_names = true

P
Pratik Naik 已提交
516 517
    ##
    # :singleton-method:
518
    # Determines whether to use ANSI codes to colorize the logging statements committed by the connection adapter. These colors
519
    # make it much easier to overview things during debugging (when used through a reader like +tail+ and on a black background), but
520
    # may complicate matters if you use software like syslog. This is true, by default.
521
    cattr_accessor :colorize_logging, :instance_writer => false
522 523
    @@colorize_logging = true

P
Pratik Naik 已提交
524 525
    ##
    # :singleton-method:
526 527
    # Determines whether to use Time.local (using :local) or Time.utc (using :utc) when pulling dates and times from the database.
    # This is set to :local by default.
528
    cattr_accessor :default_timezone, :instance_writer => false
529
    @@default_timezone = :local
530

P
Pratik Naik 已提交
531 532
    ##
    # :singleton-method:
533 534
    # Specifies the format to use when dumping the database schema with Rails'
    # Rakefile.  If :sql, the schema is dumped as (potentially database-
535
    # specific) SQL statements.  If :ruby, the schema is dumped as an
536 537 538
    # ActiveRecord::Schema file which can be loaded into any database that
    # supports migrations.  Use :ruby if you want to have different database
    # adapters for, e.g., your development and test environments.
539
    cattr_accessor :schema_format , :instance_writer => false
540
    @@schema_format = :ruby
541

P
Pratik Naik 已提交
542 543
    ##
    # :singleton-method:
544 545 546 547
    # Specify whether or not to use timestamps for migration numbers
    cattr_accessor :timestamped_migrations , :instance_writer => false
    @@timestamped_migrations = true

548 549 550
    # Determine whether to store the full constant name including namespace when using STI
    superclass_delegating_accessor :store_full_sti_class
    self.store_full_sti_class = false
551

552 553 554 555
    # Stores the default scope for the class
    class_inheritable_accessor :default_scoping, :instance_writer => false
    self.default_scoping = []

D
Initial  
David Heinemeier Hansson 已提交
556
    class << self # Class methods
557
      # Find operates with four different retrieval approaches:
558
      #
P
Pratik Naik 已提交
559
      # * Find by id - This can either be a specific id (1), a list of ids (1, 5, 6), or an array of ids ([5, 6, 10]).
560
      #   If no record can be found for all of the listed ids, then RecordNotFound will be raised.
P
Pratik Naik 已提交
561 562 563 564 565 566 567 568 569 570 571 572
      # * Find first - This will return the first record matched by the options used. These options can either be specific
      #   conditions or merely an order. If no record can be matched, +nil+ is returned. Use
      #   <tt>Model.find(:first, *args)</tt> or its shortcut <tt>Model.first(*args)</tt>.
      # * Find last - This will return the last record matched by the options used. These options can either be specific
      #   conditions or merely an order. If no record can be matched, +nil+ is returned. Use
      #   <tt>Model.find(:last, *args)</tt> or its shortcut <tt>Model.last(*args)</tt>.
      # * Find all - This will return all the records matched by the options used.
      #   If no records are found, an empty array is returned. Use
      #   <tt>Model.find(:all, *args)</tt> or its shortcut <tt>Model.all(*args)</tt>.
      #
      # All approaches accept an options hash as their last parameter.
      #
P
Pratik Naik 已提交
573
      # ==== Parameters
P
Pratik Naik 已提交
574
      #
P
Pratik Naik 已提交
575
      # * <tt>:conditions</tt> - An SQL fragment like "administrator = 1", <tt>[ "user_name = ?", username ]</tt>, or <tt>["user_name = :user_name", { :user_name => user_name }]</tt>. See conditions in the intro.
P
Pratik Naik 已提交
576 577
      # * <tt>:order</tt> - An SQL fragment like "created_at DESC, name".
      # * <tt>:group</tt> - An attribute name by which the result should be grouped. Uses the <tt>GROUP BY</tt> SQL-clause.
578
      # * <tt>:having</tt> - 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 已提交
579 580
      # * <tt>:limit</tt> - An integer determining the limit on the number of rows that should be returned.
      # * <tt>:offset</tt> - An integer determining the offset from where the rows should be fetched. So at 5, it would skip rows 0 through 4.
P
Pratik Naik 已提交
581 582 583
      # * <tt>:joins</tt> - Either an SQL fragment for additional joins like "LEFT JOIN comments ON comments.post_id = id" (rarely needed),
      #   named associations in the same form used for the <tt>:include</tt> option, which will perform an <tt>INNER JOIN</tt> on the associated table(s),
      #   or an array containing a mixture of both strings and named associations.
584
      #   If the value is a string, then the records will be returned read-only since they will have attributes that do not correspond to the table's columns.
585
      #   Pass <tt>:readonly => false</tt> to override.
P
Pratik Naik 已提交
586
      # * <tt>:include</tt> - Names associations that should be loaded alongside. The symbols named refer
587
      #   to already defined associations. See eager loading under Associations.
P
Pratik Naik 已提交
588
      # * <tt>:select</tt> - By default, this is "*" as in "SELECT * FROM", but can be changed if you, for example, want to do a join but not
P
Pratik Naik 已提交
589
      #   include the joined columns. Takes a string with the SELECT SQL fragment (e.g. "id, name").
P
Pratik Naik 已提交
590
      # * <tt>:from</tt> - By default, this is the table name of the class, but can be changed to an alternate table name (or even the name
591
      #   of a database view).
P
Pratik Naik 已提交
592 593
      # * <tt>:readonly</tt> - Mark the returned records read-only so they cannot be saved or updated.
      # * <tt>:lock</tt> - An SQL fragment like "FOR UPDATE" or "LOCK IN SHARE MODE".
594
      #   <tt>:lock => true</tt> gives connection's default exclusive lock, usually "FOR UPDATE".
595
      #
P
Pratik Naik 已提交
596 597 598
      # ==== Examples
      #
      #   # find by id
D
Initial  
David Heinemeier Hansson 已提交
599 600 601
      #   Person.find(1)       # returns the object for ID = 1
      #   Person.find(1, 2, 6) # returns an array for objects with IDs in (1, 2, 6)
      #   Person.find([7, 17]) # returns an array for objects with IDs in (7, 17)
602
      #   Person.find([1])     # returns an array for the object with ID = 1
603 604
      #   Person.find(1, :conditions => "administrator = 1", :order => "created_on DESC")
      #
605
      # Note that returned records may not be in the same order as the ids you
606
      # provide since database rows are unordered. Give an explicit <tt>:order</tt>
607 608
      # to ensure the results are sorted.
      #
P
Pratik Naik 已提交
609 610 611
      # ==== Examples
      #
      #   # find first
612
      #   Person.find(:first) # returns the first object fetched by SELECT * FROM people
613
      #   Person.find(:first, :conditions => [ "user_name = ?", user_name])
P
Pratik Naik 已提交
614
      #   Person.find(:first, :conditions => [ "user_name = :u", { :u => user_name }])
615 616
      #   Person.find(:first, :order => "created_on DESC", :offset => 5)
      #
P
Pratik Naik 已提交
617
      #   # find last
618 619 620 621
      #   Person.find(:last) # returns the last object fetched by SELECT * FROM people
      #   Person.find(:last, :conditions => [ "user_name = ?", user_name])
      #   Person.find(:last, :order => "created_on DESC", :offset => 5)
      #
P
Pratik Naik 已提交
622
      #   # find all
623
      #   Person.find(:all) # returns an array of objects for all the rows fetched by SELECT * FROM people
624
      #   Person.find(:all, :conditions => [ "category IN (?)", categories], :limit => 50)
P
Pratik Naik 已提交
625
      #   Person.find(:all, :conditions => { :friends => ["Bob", "Steve", "Fred"] }
626 627
      #   Person.find(:all, :offset => 10, :limit => 10)
      #   Person.find(:all, :include => [ :account, :friends ])
628
      #   Person.find(:all, :group => "category")
629
      #
P
Pratik Naik 已提交
630 631 632
      # Example for find with a lock: Imagine two concurrent transactions:
      # each will read <tt>person.visits == 2</tt>, add 1 to it, and save, resulting
      # in two saves of <tt>person.visits = 3</tt>.  By locking the row, the second
633
      # transaction has to wait until the first is finished; we get the
P
Pratik Naik 已提交
634 635
      # expected <tt>person.visits == 4</tt>.
      #
636 637 638 639 640
      #   Person.transaction do
      #     person = Person.find(1, :lock => true)
      #     person.visits += 1
      #     person.save!
      #   end
641
      def find(*args)
642
        options = args.extract_options!
643 644
        validate_find_options(options)
        set_readonly_option!(options)
645

646
        case args.first
647
          when :first then find_initial(options)
648
          when :last  then find_last(options)
649 650
          when :all   then find_every(options)
          else             find_from_ids(args, options)
D
Initial  
David Heinemeier Hansson 已提交
651 652
        end
      end
653

654
      delegate :select, :group, :order, :limit, :joins, :where, :preload, :eager_load, :to => :scoped
655

P
Pratik Naik 已提交
656 657
      # A convenience wrapper for <tt>find(:first, *args)</tt>. You can pass in all the
      # same arguments to this method as you can to <tt>find(:first)</tt>.
658 659 660
      def first(*args)
        find(:first, *args)
      end
661

P
Pratik Naik 已提交
662 663
      # A convenience wrapper for <tt>find(:last, *args)</tt>. You can pass in all the
      # same arguments to this method as you can to <tt>find(:last)</tt>.
664 665 666
      def last(*args)
        find(:last, *args)
      end
667

E
Emilio Tagua 已提交
668 669
      # Returns an ActiveRecord::Relation object. You can pass in all the same arguments to this method as you can
      # to find(:all).
670
      def all(*args)
671 672
        options = args.extract_options!

673
        if options.empty? && !scoped?(:find)
674
          arel_table
675
        else
676
          construct_finder_arel_with_includes(options)
677
        end
678
      end
679

P
Pratik Naik 已提交
680
      # Executes a custom SQL query against your database and returns all the results.  The results will
681
      # be returned as an array with columns requested encapsulated as attributes of the model you call
P
Pratik Naik 已提交
682 683
      # this method from.  If you call <tt>Product.find_by_sql</tt> then the results will be returned in
      # a Product object with the attributes you specified in the SQL query.
684
      #
685 686
      # If you call a complicated SQL query which spans multiple tables the columns specified by the
      # SELECT will be attributes of the model, whether or not they are columns of the corresponding
687 688
      # table.
      #
P
Pratik Naik 已提交
689
      # The +sql+ parameter is a full SQL query as a string.  It will be called as is, there will be
690 691
      # no database agnostic conversions performed.  This should be a last resort because using, for example,
      # MySQL specific terms will lock you to using that particular database engine or require you to
P
Pratik Naik 已提交
692
      # change your call if you switch engines.
693 694
      #
      # ==== Examples
P
Pratik Naik 已提交
695
      #   # A simple SQL query spanning multiple tables
696 697 698 699 700 701
      #   Post.find_by_sql "SELECT p.title, c.author FROM posts p, comments c WHERE p.id = c.post_id"
      #   > [#<Post:0x36bff9c @attributes={"title"=>"Ruby Meetup", "first_name"=>"Quentin"}>, ...]
      #
      #   # You can use the same string replacement techniques as you can with ActiveRecord#find
      #   Post.find_by_sql ["SELECT title FROM posts WHERE author = ? AND created > ?", author_id, start_date]
      #   > [#<Post:0x36bff9c @attributes={"first_name"=>"The Cheap Man Buys Twice"}>, ...]
D
Initial  
David Heinemeier Hansson 已提交
702
      def find_by_sql(sql)
703
        connection.select_all(sanitize_sql(sql), "#{name} Load").collect! { |record| instantiate(record) }
D
Initial  
David Heinemeier Hansson 已提交
704
      end
705

P
Pratik Naik 已提交
706
      # Returns true if a record exists in the table that matches the +id+ or
707
      # conditions given, or false otherwise. The argument can take five forms:
P
Pratik Naik 已提交
708 709 710 711 712 713 714 715
      #
      # * Integer - Finds the record with this primary key.
      # * String - Finds the record with a primary key corresponding to this
      #   string (such as <tt>'5'</tt>).
      # * Array - Finds the record that matches these +find+-style conditions
      #   (such as <tt>['color = ?', 'red']</tt>).
      # * Hash - Finds the record that matches these +find+-style conditions
      #   (such as <tt>{:color => 'red'}</tt>).
716
      # * No args - Returns false if the table is empty, true otherwise.
717
      #
P
Pratik Naik 已提交
718 719
      # For more information about specifying conditions as a Hash or Array,
      # see the Conditions section in the introduction to ActiveRecord::Base.
720
      #
P
Pratik Naik 已提交
721 722 723
      # Note: You can't pass in a condition as a string (like <tt>name =
      # 'Jamie'</tt>), since it would be sanitized and then queried against
      # the primary key column, like <tt>id = 'name = \'Jamie\''</tt>.
724 725
      #
      # ==== Examples
726
      #   Person.exists?(5)
727
      #   Person.exists?('5')
728
      #   Person.exists?(:name => "David")
729
      #   Person.exists?(['name LIKE ?', "%#{query}%"])
730 731
      #   Person.exists?
      def exists?(id_or_conditions = {})
732 733 734
        find_initial(
          :select => "#{quoted_table_name}.#{primary_key}",
          :conditions => expand_id_conditions(id_or_conditions)) ? true : false
D
Initial  
David Heinemeier Hansson 已提交
735
      end
736

737
      # Creates an object (or multiple objects) and saves it to the database, if validations pass.
738 739 740 741 742 743 744 745
      # The resulting object is returned whether the object was saved successfully to the database or not.
      #
      # The +attributes+ parameter can be either be a Hash or an Array of Hashes.  These Hashes describe the
      # attributes on the objects that are to be created.
      #
      # ==== Examples
      #   # Create a single new object
      #   User.create(:first_name => 'Jamie')
746
      #
747
      #   # Create an Array of new objects
P
Pratik Naik 已提交
748
      #   User.create([{ :first_name => 'Jamie' }, { :first_name => 'Jeremy' }])
749 750 751 752 753 754 755
      #
      #   # Create a single object and pass it into a block to set other attributes.
      #   User.create(:first_name => 'Jamie') do |u|
      #     u.is_admin = false
      #   end
      #
      #   # Creating an Array of new objects using a block, where the block is executed for each object:
P
Pratik Naik 已提交
756
      #   User.create([{ :first_name => 'Jamie' }, { :first_name => 'Jeremy' }]) do |u|
757
      #     u.is_admin = false
758
      #   end
759
      def create(attributes = nil, &block)
760
        if attributes.is_a?(Array)
761
          attributes.collect { |attr| create(attr, &block) }
762 763
        else
          object = new(attributes)
764
          yield(object) if block_given?
765 766 767
          object.save
          object
        end
D
Initial  
David Heinemeier Hansson 已提交
768 769
      end

770 771
      # Updates an object (or multiple objects) and saves it to the database, if validations pass.
      # The resulting object is returned whether the object was saved successfully to the database or not.
772
      #
P
Pratik Naik 已提交
773
      # ==== Parameters
774
      #
P
Pratik Naik 已提交
775
      # * +id+ - This should be the id or an array of ids to be updated.
P
Pratik Naik 已提交
776
      # * +attributes+ - This should be a hash of attributes to be set on the object, or an array of hashes.
777 778 779 780
      #
      # ==== Examples
      #
      #   # Updating one record:
P
Pratik Naik 已提交
781
      #   Person.update(15, :user_name => 'Samuel', :group => 'expert')
782
      #
783
      #   # Updating multiple records:
P
Pratik Naik 已提交
784
      #   people = { 1 => { "first_name" => "David" }, 2 => { "first_name" => "Jeremy" } }
785
      #   Person.update(people.keys, people.values)
D
Initial  
David Heinemeier Hansson 已提交
786
      def update(id, attributes)
787 788
        if id.is_a?(Array)
          idx = -1
789
          id.collect { |one_id| idx += 1; update(one_id, attributes[idx]) }
790 791 792 793 794
        else
          object = find(id)
          object.update_attributes(attributes)
          object
        end
D
Initial  
David Heinemeier Hansson 已提交
795 796
      end

P
Pratik Naik 已提交
797 798 799 800 801
      # Deletes the row with a primary key matching the +id+ argument, using a
      # SQL +DELETE+ statement, and returns the number of rows deleted. Active
      # Record objects are not instantiated, so the object's callbacks are not
      # executed, including any <tt>:dependent</tt> association options or
      # Observer methods.
802
      #
P
Pratik Naik 已提交
803
      # You can delete multiple rows at once by passing an Array of <tt>id</tt>s.
804
      #
P
Pratik Naik 已提交
805 806 807 808
      # Note: Although it is often much faster than the alternative,
      # <tt>#destroy</tt>, skipping callbacks might bypass business logic in
      # your application that ensures referential integrity or performs other
      # essential jobs.
809 810 811
      #
      # ==== Examples
      #
P
Pratik Naik 已提交
812
      #   # Delete a single row
813
      #   Todo.delete(1)
814
      #
P
Pratik Naik 已提交
815 816
      #   # Delete multiple rows
      #   Todo.delete([2,3,4])
817
      def delete(id)
818
        delete_all([ "#{connection.quote_column_name(primary_key)} IN (?)", id ])
819
      end
820

821 822 823
      # Destroy an object (or multiple objects) that has the given id, the object is instantiated first,
      # therefore all callbacks and filters are fired off before the object is deleted.  This method is
      # less efficient than ActiveRecord#delete but allows cleanup methods and other actions to be run.
824 825
      #
      # This essentially finds the object (or multiple objects) with the given id, creates a new object
826 827
      # from the attributes, and then calls destroy on it.
      #
P
Pratik Naik 已提交
828
      # ==== Parameters
829
      #
P
Pratik Naik 已提交
830
      # * +id+ - Can be either an Integer or an Array of Integers.
831 832 833 834 835
      #
      # ==== Examples
      #
      #   # Destroy a single object
      #   Todo.destroy(1)
836
      #
837 838 839
      #   # Destroy multiple objects
      #   todos = [1,2,3]
      #   Todo.destroy(todos)
840
      def destroy(id)
841 842 843 844 845
        if id.is_a?(Array)
          id.map { |one_id| destroy(one_id) }
        else
          find(id).destroy
        end
846 847
      end

848
      # Updates all records with details given if they match a set of conditions supplied, limits and order can
P
Pratik Naik 已提交
849
      # also be supplied. This method constructs a single SQL UPDATE statement and sends it straight to the
P
Pratik Naik 已提交
850 851
      # database. It does not instantiate the involved models and it does not trigger Active Record callbacks
      # or validations.
852
      #
P
Pratik Naik 已提交
853
      # ==== Parameters
854
      #
P
Pratik Naik 已提交
855 856
      # * +updates+ - A string, array, or hash representing the SET part of an SQL statement.
      # * +conditions+ - A string, array, or hash representing the WHERE part of an SQL statement. See conditions in the intro.
P
Pratik Naik 已提交
857
      # * +options+ - Additional options are <tt>:limit</tt> and <tt>:order</tt>, see the examples for usage.
858 859 860
      #
      # ==== Examples
      #
P
Pratik Naik 已提交
861 862
      #   # Update all customers with the given attributes
      #   Customer.update_all :wants_email => true
863
      #
P
Pratik Naik 已提交
864 865
      #   # Update all books with 'Rails' in their title
      #   Book.update_all "author = 'David'", "title LIKE '%Rails%'"
866
      #
P
Pratik Naik 已提交
867
      #   # Update all avatars migrated more than a week ago
P
Pratik Naik 已提交
868
      #   Avatar.update_all ['migrated_at = ?', Time.now.utc], ['migrated_at > ?', 1.week.ago]
P
Pratik Naik 已提交
869 870 871
      #
      #   # Update all books that match our conditions, but limit it to 5 ordered by date
      #   Book.update_all "author = 'David'", "title LIKE '%Rails%'", :order => 'created_at', :limit => 5
872
      def update_all(updates, conditions = nil, options = {})
873
        scope = scope(:find)
874

875
        relation = arel_table
E
Emilio Tagua 已提交
876 877

        if conditions = construct_conditions(conditions, scope)
878
          relation = relation.where(Arel::SqlLiteral.new(conditions))
E
Emilio Tagua 已提交
879
        end
880

881
        relation = if options.has_key?(:limit) || (scope && scope[:limit])
882 883
          # Only take order from scope if limit is also provided by scope, this
          # is useful for updating a has_many association with a limit.
884
          relation.order(construct_order(options[:order], scope)).limit(construct_limit(options[:limit], scope))
885
        else
886
          relation.order(options[:order])
887 888
        end

889
        relation.update(sanitize_sql_for_assignment(updates))
D
Initial  
David Heinemeier Hansson 已提交
890
      end
891

P
Pratik Naik 已提交
892 893 894 895 896 897 898 899 900 901 902 903 904 905
      # Destroys the records matching +conditions+ by instantiating each
      # record and calling its +destroy+ method. Each object's callbacks are
      # executed (including <tt>:dependent</tt> association options and
      # +before_destroy+/+after_destroy+ Observer methods). Returns the
      # collection of objects that were destroyed; each will be frozen, to
      # reflect that no changes should be made (since they can't be
      # persisted).
      #
      # Note: Instantiation, callback execution, and deletion of each
      # record can be time consuming when you're removing many records at
      # once. It generates at least one SQL +DELETE+ query per record (or
      # possibly more, to enforce your callbacks). If you want to delete many
      # rows quickly, without concern for their associations or callbacks, use
      # +delete_all+ instead.
906
      #
P
Pratik Naik 已提交
907
      # ==== Parameters
908
      #
P
Pratik Naik 已提交
909 910 911 912
      # * +conditions+ - A string, array, or hash that specifies which records
      #   to destroy. If omitted, all records are destroyed. See the
      #   Conditions section in the introduction to ActiveRecord::Base for
      #   more information.
913
      #
P
Pratik Naik 已提交
914
      # ==== Examples
915
      #
P
Pratik Naik 已提交
916
      #   Person.destroy_all("last_login < '2004-04-04'")
P
Pratik Naik 已提交
917
      #   Person.destroy_all(:status => "inactive")
D
Initial  
David Heinemeier Hansson 已提交
918
      def destroy_all(conditions = nil)
919
        find(:all, :conditions => conditions).each { |object| object.destroy }
D
Initial  
David Heinemeier Hansson 已提交
920
      end
921

922
      # Deletes the records matching +conditions+ without instantiating the records first, and hence not
P
Pratik Naik 已提交
923
      # calling the +destroy+ method nor invoking callbacks. This is a single SQL DELETE statement that
P
Pratik Naik 已提交
924
      # goes straight to the database, much more efficient than +destroy_all+. Be careful with relations
P
Pratik Naik 已提交
925 926
      # though, in particular <tt>:dependent</tt> rules defined on associations are not honored.  Returns
      # the number of rows affected.
927
      #
P
Pratik Naik 已提交
928
      # ==== Parameters
929
      #
P
Pratik Naik 已提交
930
      # * +conditions+ - Conditions are specified the same way as with +find+ method.
931 932 933
      #
      # ==== Example
      #
P
Pratik Naik 已提交
934 935
      #   Post.delete_all("person_id = 5 AND (category = 'Something' OR category = 'Else')")
      #   Post.delete_all(["person_id = ? AND (category = ? OR category = ?)", 5, 'Something', 'Else'])
936
      #
P
Pratik Naik 已提交
937
      # Both calls delete the affected posts all at once with a single DELETE statement. If you need to destroy dependent
P
Pratik Naik 已提交
938
      # associations or call your <tt>before_*</tt> or +after_destroy+ callbacks, use the +destroy_all+ method instead.
D
Initial  
David Heinemeier Hansson 已提交
939
      def delete_all(conditions = nil)
940
        if conditions
941
          arel_table.where(Arel::SqlLiteral.new(construct_conditions(conditions, scope(:find)))).delete
942 943 944
        else
          arel_table.delete
        end
D
Initial  
David Heinemeier Hansson 已提交
945 946 947
      end

      # Returns the result of an SQL statement that should only include a COUNT(*) in the SELECT part.
948
      # The use of this method should be restricted to complicated SQL queries that can't be executed
949 950
      # using the ActiveRecord::Calculations class methods.  Look into those before using this.
      #
P
Pratik Naik 已提交
951
      # ==== Parameters
952
      #
P
Pratik Naik 已提交
953
      # * +sql+ - An SQL statement which should return a count query from the database, see the example below.
954 955 956
      #
      # ==== Examples
      #
957
      #   Product.count_by_sql "SELECT COUNT(*) FROM sales s, customers c WHERE s.customer_id = c.id"
D
Initial  
David Heinemeier Hansson 已提交
958
      def count_by_sql(sql)
959
        sql = sanitize_conditions(sql)
960
        connection.select_value(sql, "#{name} Count").to_i
D
Initial  
David Heinemeier Hansson 已提交
961
      end
962

963 964 965
      # Resets one or more counter caches to their correct value using an SQL
      # count query.  This is useful when adding new counter caches, or if the
      # counter has been corrupted or modified directly by SQL.
966 967 968
      #
      # ==== Parameters
      #
969 970
      # * +id+ - The id of the object you wish to reset a counter on.
      # * +counters+ - One or more counter names to reset
971 972
      #
      # ==== Examples
973 974 975 976 977 978 979 980
      #
      #   # For Post with id #1 records reset the comments_count
      #   Post.reset_counters(1, :comments)
      def reset_counters(id, *counters)
        object = find(id)
        counters.each do |association|
          child_class = reflect_on_association(association).klass
          counter_name = child_class.reflect_on_association(self.name.downcase.to_sym).counter_cache_column
981 982 983 984 985

          connection.update("UPDATE #{quoted_table_name} SET #{connection.quote_column_name(counter_name)} = #{object.send(association).count} WHERE #{connection.quote_column_name(primary_key)} = #{quote_value(object.id)}", "#{name} UPDATE")
        end
      end

986 987 988 989 990 991
      # A generic "counter updater" implementation, intended primarily to be
      # used by increment_counter and decrement_counter, but which may also
      # be useful on its own. It simply does a direct SQL update for the record
      # with the given ID, altering the given hash of counters by the amount
      # given by the corresponding value:
      #
P
Pratik Naik 已提交
992
      # ==== Parameters
993
      #
994
      # * +id+ - The id of the object you wish to update a counter on or an Array of ids.
P
Pratik Naik 已提交
995 996
      # * +counters+ - An Array of Hashes containing the names of the fields
      #   to update as keys and the amount to update the field by as values.
997
      #
998
      # ==== Examples
999 1000
      #
      #   # For the Post with id of 5, decrement the comment_count by 1, and
1001
      #   # increment the action_count by 1
1002
      #   Post.update_counters 5, :comment_count => -1, :action_count => 1
1003
      #   # Executes the following SQL:
1004 1005 1006 1007
      #   # UPDATE posts
      #   #    SET comment_count = comment_count - 1,
      #   #        action_count = action_count + 1
      #   #  WHERE id = 5
1008 1009 1010 1011 1012 1013 1014
      #
      #   # For the Posts with id of 10 and 15, increment the comment_count by 1
      #   Post.update_counters [10, 15], :comment_count => 1
      #   # Executes the following SQL:
      #   # UPDATE posts
      #   #    SET comment_count = comment_count + 1,
      #   #  WHERE id IN (10, 15)
1015 1016 1017
      def update_counters(id, counters)
        updates = counters.inject([]) { |list, (counter_name, increment)|
          sign = increment < 0 ? "-" : "+"
1018
          list << "#{connection.quote_column_name(counter_name)} = COALESCE(#{connection.quote_column_name(counter_name)}, 0) #{sign} #{increment.abs}"
1019
        }.join(", ")
1020 1021 1022 1023 1024 1025 1026 1027 1028

        if id.is_a?(Array)
          ids_list = id.map {|i| quote_value(i)}.join(', ')
          condition = "IN  (#{ids_list})"
        else
          condition = "= #{quote_value(id)}"
        end

        update_all(updates, "#{connection.quote_column_name(primary_key)} #{condition}")
1029 1030
      end

1031 1032
      # Increment a number field by one, usually representing a count.
      #
1033 1034
      # This is used for caching aggregate values, so that they don't need to be computed every time.
      # For example, a DiscussionBoard may cache post_count and comment_count otherwise every time the board is
1035
      # shown it would have to run an SQL query to find how many posts and comments there are.
1036
      #
P
Pratik Naik 已提交
1037
      # ==== Parameters
1038
      #
P
Pratik Naik 已提交
1039 1040
      # * +counter_name+ - The name of the field that should be incremented.
      # * +id+ - The id of the object that should be incremented.
1041 1042 1043 1044 1045
      #
      # ==== Examples
      #
      #   # Increment the post_count column for the record with an id of 5
      #   DiscussionBoard.increment_counter(:post_count, 5)
D
Initial  
David Heinemeier Hansson 已提交
1046
      def increment_counter(counter_name, id)
1047
        update_counters(id, counter_name => 1)
D
Initial  
David Heinemeier Hansson 已提交
1048 1049
      end

1050 1051 1052 1053
      # Decrement a number field by one, usually representing a count.
      #
      # This works the same as increment_counter but reduces the column value by 1 instead of increasing it.
      #
P
Pratik Naik 已提交
1054
      # ==== Parameters
1055
      #
P
Pratik Naik 已提交
1056 1057
      # * +counter_name+ - The name of the field that should be decremented.
      # * +id+ - The id of the object that should be decremented.
1058 1059 1060 1061 1062
      #
      # ==== Examples
      #
      #   # Decrement the post_count column for the record with an id of 5
      #   DiscussionBoard.decrement_counter(:post_count, 5)
D
Initial  
David Heinemeier Hansson 已提交
1063
      def decrement_counter(counter_name, id)
1064
        update_counters(id, counter_name => -1)
D
Initial  
David Heinemeier Hansson 已提交
1065 1066
      end

P
Pratik Naik 已提交
1067 1068 1069 1070 1071 1072 1073 1074 1075
      # Attributes named in this macro are protected from mass-assignment,
      # such as <tt>new(attributes)</tt>,
      # <tt>update_attributes(attributes)</tt>, or
      # <tt>attributes=(attributes)</tt>.
      #
      # Mass-assignment to these attributes will simply be ignored, to assign
      # to them you can use direct writer methods. This is meant to protect
      # sensitive attributes from being overwritten by malicious users
      # tampering with URLs or forms.
D
Initial  
David Heinemeier Hansson 已提交
1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087
      #
      #   class Customer < ActiveRecord::Base
      #     attr_protected :credit_rating
      #   end
      #
      #   customer = Customer.new("name" => David, "credit_rating" => "Excellent")
      #   customer.credit_rating # => nil
      #   customer.attributes = { "description" => "Jolly fellow", "credit_rating" => "Superb" }
      #   customer.credit_rating # => nil
      #
      #   customer.credit_rating = "Average"
      #   customer.credit_rating # => "Average"
1088
      #
P
Pratik Naik 已提交
1089 1090
      # To start from an all-closed default and enable attributes as needed,
      # have a look at +attr_accessible+.
P
Pratik Naik 已提交
1091 1092 1093 1094
      #
      # If the access logic of your application is richer you can use <tt>Hash#except</tt>
      # or <tt>Hash#slice</tt> to sanitize the hash of parameters before they are
      # passed to Active Record.
1095
      #
P
Pratik Naik 已提交
1096 1097 1098 1099 1100 1101 1102 1103 1104 1105
      # For example, it could be the case that the list of protected attributes
      # for a given model depends on the role of the user:
      #
      #   # Assumes plan_id is not protected because it depends on the role.
      #   params[:account] = params[:account].except(:plan_id) unless admin?
      #   @account.update_attributes(params[:account])
      #
      # Note that +attr_protected+ is still applied to the received hash. Thus,
      # with this technique you can at most _extend_ the list of protected
      # attributes for a particular mass-assignment call.
D
Initial  
David Heinemeier Hansson 已提交
1106
      def attr_protected(*attributes)
1107
        write_inheritable_attribute(:attr_protected, Set.new(attributes.map {|a| a.to_s}) + (protected_attributes || []))
D
Initial  
David Heinemeier Hansson 已提交
1108
      end
1109

1110
      # Returns an array of all the attributes that have been protected from mass-assignment.
D
Initial  
David Heinemeier Hansson 已提交
1111
      def protected_attributes # :nodoc:
1112
        read_inheritable_attribute(:attr_protected)
D
Initial  
David Heinemeier Hansson 已提交
1113 1114
      end

P
Pratik Naik 已提交
1115 1116 1117 1118
      # Specifies a white list of model attributes that can be set via
      # mass-assignment, such as <tt>new(attributes)</tt>,
      # <tt>update_attributes(attributes)</tt>, or
      # <tt>attributes=(attributes)</tt>
1119
      #
P
Pratik Naik 已提交
1120 1121 1122 1123 1124 1125 1126
      # This is the opposite of the +attr_protected+ macro: Mass-assignment
      # will only set attributes in this list, to assign to the rest of
      # attributes you can use direct writer methods. This is meant to protect
      # sensitive attributes from being overwritten by malicious users
      # tampering with URLs or forms. If you'd rather start from an all-open
      # default and restrict attributes as needed, have a look at
      # +attr_protected+.
1127 1128
      #
      #   class Customer < ActiveRecord::Base
1129
      #     attr_accessible :name, :nickname
1130 1131
      #   end
      #
1132 1133 1134 1135
      #   customer = Customer.new(:name => "David", :nickname => "Dave", :credit_rating => "Excellent")
      #   customer.credit_rating # => nil
      #   customer.attributes = { :name => "Jolly fellow", :credit_rating => "Superb" }
      #   customer.credit_rating # => nil
1136
      #
1137 1138
      #   customer.credit_rating = "Average"
      #   customer.credit_rating # => "Average"
P
Pratik Naik 已提交
1139 1140 1141 1142
      #
      # If the access logic of your application is richer you can use <tt>Hash#except</tt>
      # or <tt>Hash#slice</tt> to sanitize the hash of parameters before they are
      # passed to Active Record.
1143
      #
P
Pratik Naik 已提交
1144 1145 1146 1147 1148 1149 1150 1151 1152 1153
      # For example, it could be the case that the list of accessible attributes
      # for a given model depends on the role of the user:
      #
      #   # Assumes plan_id is accessible because it depends on the role.
      #   params[:account] = params[:account].except(:plan_id) unless admin?
      #   @account.update_attributes(params[:account])
      #
      # Note that +attr_accessible+ is still applied to the received hash. Thus,
      # with this technique you can at most _narrow_ the list of accessible
      # attributes for a particular mass-assignment call.
D
Initial  
David Heinemeier Hansson 已提交
1154
      def attr_accessible(*attributes)
1155
        write_inheritable_attribute(:attr_accessible, Set.new(attributes.map(&:to_s)) + (accessible_attributes || []))
D
Initial  
David Heinemeier Hansson 已提交
1156
      end
1157

1158
      # Returns an array of all the attributes that have been made accessible to mass-assignment.
D
Initial  
David Heinemeier Hansson 已提交
1159
      def accessible_attributes # :nodoc:
1160
        read_inheritable_attribute(:attr_accessible)
D
Initial  
David Heinemeier Hansson 已提交
1161 1162
      end

1163 1164
       # Attributes listed as readonly can be set for a new record, but will be ignored in database updates afterwards.
       def attr_readonly(*attributes)
1165
         write_inheritable_attribute(:attr_readonly, Set.new(attributes.map(&:to_s)) + (readonly_attributes || []))
1166 1167 1168 1169
       end

       # Returns an array of all the attributes that have been specified as readonly.
       def readonly_attributes
1170
         read_inheritable_attribute(:attr_readonly) || []
1171
       end
D
David Heinemeier Hansson 已提交
1172

1173 1174 1175
      # If you have an attribute that needs to be saved to the database as an object, and retrieved as the same object,
      # then specify the name of that attribute using this method and it will be handled automatically.
      # The serialization is done through YAML. If +class_name+ is specified, the serialized object must be of that
P
Pratik Naik 已提交
1176
      # class on retrieval or SerializationTypeMismatch will be raised.
D
David Heinemeier Hansson 已提交
1177
      #
P
Pratik Naik 已提交
1178
      # ==== Parameters
D
David Heinemeier Hansson 已提交
1179
      #
P
Pratik Naik 已提交
1180 1181
      # * +attr_name+ - The field name that should be serialized.
      # * +class_name+ - Optional, class name that the object type should be equal to.
D
David Heinemeier Hansson 已提交
1182 1183 1184 1185 1186 1187
      #
      # ==== Example
      #   # Serialize a preferences attribute
      #   class User
      #     serialize :preferences
      #   end
D
Initial  
David Heinemeier Hansson 已提交
1188
      def serialize(attr_name, class_name = Object)
1189
        serialized_attributes[attr_name.to_s] = class_name
D
Initial  
David Heinemeier Hansson 已提交
1190
      end
1191

D
Initial  
David Heinemeier Hansson 已提交
1192 1193
      # Returns a hash of all the attributes that have been specified for serialization as keys and their class restriction as values.
      def serialized_attributes
1194
        read_inheritable_attribute(:attr_serialized) or write_inheritable_attribute(:attr_serialized, {})
D
Initial  
David Heinemeier Hansson 已提交
1195 1196 1197
      end

      # Guesses the table name (in forced lower-case) based on the name of the class in the inheritance hierarchy descending
P
Pratik Naik 已提交
1198
      # directly from ActiveRecord::Base. So if the hierarchy looks like: Reply < Message < ActiveRecord::Base, then Message is used
1199
      # to guess the table name even when called on Reply. The rules used to do the guess are handled by the Inflector class
1200
      # in Active Support, which knows almost all common English inflections. You can add new inflections in config/initializers/inflections.rb.
D
Initial  
David Heinemeier Hansson 已提交
1201
      #
1202
      # Nested classes are given table names prefixed by the singular form of
P
Pratik Naik 已提交
1203 1204 1205
      # the parent's table name. Enclosing modules are not considered.
      #
      # ==== Examples
1206 1207
      #
      #   class Invoice < ActiveRecord::Base; end;
1208 1209
      #   file                  class               table_name
      #   invoice.rb            Invoice             invoices
1210 1211 1212 1213 1214 1215 1216 1217
      #
      #   class Invoice < ActiveRecord::Base; class Lineitem < ActiveRecord::Base; end; end;
      #   file                  class               table_name
      #   invoice.rb            Invoice::Lineitem   invoice_lineitems
      #
      #   module Invoice; class Lineitem < ActiveRecord::Base; end; end;
      #   file                  class               table_name
      #   invoice/lineitem.rb   Invoice::Lineitem   lineitems
D
Initial  
David Heinemeier Hansson 已提交
1218
      #
P
Pratik Naik 已提交
1219 1220
      # Additionally, the class-level +table_name_prefix+ is prepended and the
      # +table_name_suffix+ is appended.  So if you have "myapp_" as a prefix,
1221 1222 1223 1224 1225
      # the table name guess for an Invoice class becomes "myapp_invoices".
      # Invoice::Lineitem becomes "myapp_invoice_lineitems".
      #
      # You can also overwrite this class method to allow for unguessable
      # links, such as a Mouse class with a link to a "mice" table. Example:
D
Initial  
David Heinemeier Hansson 已提交
1226 1227
      #
      #   class Mouse < ActiveRecord::Base
1228
      #     set_table_name "mice"
D
Initial  
David Heinemeier Hansson 已提交
1229
      #   end
1230
      def table_name
1231 1232 1233
        reset_table_name
      end

D
David Heinemeier Hansson 已提交
1234
      def reset_table_name #:nodoc:
1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250
        base = base_class

        name =
          # STI subclasses always use their superclass' table.
          unless self == base
            base.table_name
          else
            # Nested classes are prefixed with singular parent table name.
            if parent < ActiveRecord::Base && !parent.abstract_class?
              contained = parent.table_name
              contained = contained.singularize if parent.pluralize_table_names
              contained << '_'
            end
            name = "#{table_name_prefix}#{contained}#{undecorated_table_name(base.name)}#{table_name_suffix}"
          end

D
David Heinemeier Hansson 已提交
1251
        set_table_name(name)
1252
        name
D
Initial  
David Heinemeier Hansson 已提交
1253 1254
      end

1255 1256
      # Defines the column name for use with single table inheritance
      # -- can be set in subclasses like so: self.inheritance_column = "type_id"
D
Initial  
David Heinemeier Hansson 已提交
1257
      def inheritance_column
1258
        @inheritance_column ||= "type".freeze
D
Initial  
David Heinemeier Hansson 已提交
1259 1260
      end

1261 1262
      # Lazy-set the sequence name to the connection's default.  This method
      # is only ever called once since set_sequence_name overrides it.
D
David Heinemeier Hansson 已提交
1263
      def sequence_name #:nodoc:
1264 1265 1266
        reset_sequence_name
      end

D
David Heinemeier Hansson 已提交
1267
      def reset_sequence_name #:nodoc:
1268 1269 1270
        default = connection.default_sequence_name(table_name, primary_key)
        set_sequence_name(default)
        default
1271 1272
      end

1273
      # Sets the table name to use to the given value, or (if the value
1274
      # is nil or false) to the value returned by the given block.
1275 1276 1277 1278
      #
      #   class Project < ActiveRecord::Base
      #     set_table_name "project"
      #   end
1279
      def set_table_name(value = nil, &block)
1280 1281 1282 1283 1284 1285
        define_attr_method :table_name, value, &block
      end
      alias :table_name= :set_table_name

      # Sets the name of the inheritance column to use to the given value,
      # or (if the value # is nil or false) to the value returned by the
1286
      # given block.
1287 1288 1289 1290 1291 1292
      #
      #   class Project < ActiveRecord::Base
      #     set_inheritance_column do
      #       original_inheritance_column + "_id"
      #     end
      #   end
1293
      def set_inheritance_column(value = nil, &block)
1294 1295 1296 1297
        define_attr_method :inheritance_column, value, &block
      end
      alias :inheritance_column= :set_inheritance_column

1298 1299
      # Sets the name of the sequence to use when generating ids to the given
      # value, or (if the value is nil or false) to the value returned by the
1300 1301
      # given block. This is required for Oracle and is useful for any
      # database which relies on sequences for primary key generation.
1302
      #
1303 1304 1305 1306 1307
      # If a sequence name is not explicitly set when using Oracle or Firebird,
      # it will default to the commonly used pattern of: #{table_name}_seq
      #
      # If a sequence name is not explicitly set when using PostgreSQL, it
      # will discover the sequence corresponding to your primary key for you.
1308 1309 1310 1311
      #
      #   class Project < ActiveRecord::Base
      #     set_sequence_name "projectseq"   # default would have been "project_seq"
      #   end
1312
      def set_sequence_name(value = nil, &block)
1313 1314 1315 1316
        define_attr_method :sequence_name, value, &block
      end
      alias :sequence_name= :set_sequence_name

D
Initial  
David Heinemeier Hansson 已提交
1317 1318 1319
      # Turns the +table_name+ back into a class name following the reverse rules of +table_name+.
      def class_name(table_name = table_name) # :nodoc:
        # remove any prefix and/or suffix from the table name
1320 1321 1322
        class_name = table_name[table_name_prefix.length..-(table_name_suffix.length + 1)].camelize
        class_name = class_name.singularize if pluralize_table_names
        class_name
D
Initial  
David Heinemeier Hansson 已提交
1323 1324
      end

1325 1326
      # Indicates whether the table associated with this class exists
      def table_exists?
1327
        connection.table_exists?(table_name)
1328 1329
      end

D
Initial  
David Heinemeier Hansson 已提交
1330 1331
      # Returns an array of column objects for the table associated with this class.
      def columns
1332
        unless defined?(@columns) && @columns
1333
          @columns = connection.columns(table_name, "#{name} Columns")
1334
          @columns.each { |column| column.primary = column.name == primary_key }
1335 1336
        end
        @columns
D
Initial  
David Heinemeier Hansson 已提交
1337
      end
1338

1339
      # Returns a hash of column objects for the table associated with this class.
D
Initial  
David Heinemeier Hansson 已提交
1340 1341 1342
      def columns_hash
        @columns_hash ||= columns.inject({}) { |hash, column| hash[column.name] = column; hash }
      end
1343

D
David Heinemeier Hansson 已提交
1344
      # Returns an array of column names as strings.
1345
      def column_names
1346
        @column_names ||= columns.map { |column| column.name }
1347
      end
D
Initial  
David Heinemeier Hansson 已提交
1348

1349 1350
      # Returns an array of column objects where the primary id, all columns ending in "_id" or "_count",
      # and columns used for single table inheritance have been removed.
D
Initial  
David Heinemeier Hansson 已提交
1351
      def content_columns
1352
        @content_columns ||= columns.reject { |c| c.primary || c.name =~ /(_id|_count)$/ || c.name == inheritance_column }
D
Initial  
David Heinemeier Hansson 已提交
1353 1354 1355 1356
      end

      # Returns a hash of all the methods added to query each of the columns in the table with the name of the method as the key
      # and true as the value. This makes it possible to do O(1) lookups in respond_to? to check if a given method for attribute
1357
      # is available.
D
David Heinemeier Hansson 已提交
1358
      def column_methods_hash #:nodoc:
1359
        @dynamic_methods_hash ||= column_names.inject(Hash.new(false)) do |methods, attr|
1360 1361 1362 1363 1364
          attr_name = attr.to_s
          methods[attr.to_sym]       = attr_name
          methods["#{attr}=".to_sym] = attr_name
          methods["#{attr}?".to_sym] = attr_name
          methods["#{attr}_before_type_cast".to_sym] = attr_name
D
Initial  
David Heinemeier Hansson 已提交
1365 1366 1367
          methods
        end
      end
1368

P
Pratik Naik 已提交
1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394
      # Resets all the cached information about columns, which will cause them
      # to be reloaded on the next request.
      #
      # The most common usage pattern for this method is probably in a migration,
      # when just after creating a table you want to populate it with some default
      # values, eg:
      #
      #  class CreateJobLevels < ActiveRecord::Migration
      #    def self.up
      #      create_table :job_levels do |t|
      #        t.integer :id
      #        t.string :name
      #
      #        t.timestamps
      #      end
      #
      #      JobLevel.reset_column_information
      #      %w{assistant executive manager director}.each do |type|
      #        JobLevel.create(:name => type)
      #      end
      #    end
      #
      #    def self.down
      #      drop_table :job_levels
      #    end
      #  end
1395
      def reset_column_information
1396
        undefine_attribute_methods
1397
        @arel_table = @column_names = @columns = @columns_hash = @content_columns = @dynamic_methods_hash = @inheritance_column = nil
1398 1399
      end

1400
      def reset_column_information_and_inheritable_attributes_for_all_subclasses#:nodoc:
1401 1402
        subclasses.each { |klass| klass.reset_inheritable_attributes; klass.reset_column_information }
      end
D
Initial  
David Heinemeier Hansson 已提交
1403

1404 1405
      # Set the lookup ancestors for ActiveModel.
      def lookup_ancestors #:nodoc:
1406 1407
        klass = self
        classes = [klass]
E
Emilio Tagua 已提交
1408
        while klass != klass.base_class
1409 1410 1411 1412 1413
          classes << klass = klass.superclass
        end
        classes
      rescue
        # OPTIMIZE this rescue is to fix this test: ./test/cases/reflection_test.rb:56:in `test_human_name_for_column'
P
Pratik Naik 已提交
1414
        # Apparently the method base_class causes some trouble.
1415 1416 1417 1418
        # It now works for sure.
        [self]
      end

1419 1420 1421
      # Set the i18n scope to overwrite ActiveModel.
      def i18n_scope #:nodoc:
        :activerecord
D
Initial  
David Heinemeier Hansson 已提交
1422
      end
1423

1424 1425 1426 1427 1428 1429 1430
      # True if this isn't a concrete subclass needing a STI type condition.
      def descends_from_active_record?
        if superclass.abstract_class?
          superclass.descends_from_active_record?
        else
          superclass == Base || !columns_hash.include?(inheritance_column)
        end
D
Initial  
David Heinemeier Hansson 已提交
1431 1432
      end

1433 1434 1435 1436 1437
      def finder_needs_type_condition? #:nodoc:
        # This is like this because benchmarking justifies the strange :false stuff
        :true == (@finder_needs_type_condition ||= descends_from_active_record? ? :false : :true)
      end

1438
      # Returns a string like 'Post id:integer, title:string, body:text'
1439
      def inspect
1440 1441 1442 1443
        if self == Base
          super
        elsif abstract_class?
          "#{super}(abstract)"
1444
        elsif table_exists?
1445 1446
          attr_list = columns.map { |c| "#{c.name}: #{c.type}" } * ', '
          "#{super}(#{attr_list})"
1447 1448
        else
          "#{super}(Table doesn't exist)"
1449
        end
1450 1451
      end

1452
      def quote_value(value, column = nil) #:nodoc:
1453
        connection.quote(value,column)
1454 1455
      end

1456
      # Used to sanitize objects before they're used in an SQL SELECT statement. Delegates to <tt>connection.quote</tt>.
1457
      def sanitize(object) #:nodoc:
1458
        connection.quote(object)
D
Initial  
David Heinemeier Hansson 已提交
1459 1460
      end

1461 1462 1463
      # Overwrite the default class equality method to provide support for association proxies.
      def ===(object)
        object.is_a?(self)
1464
      end
1465

1466 1467 1468 1469 1470 1471 1472
      # Returns the base AR subclass that this class descends from. If A
      # extends AR::Base, A.base_class will return A. If B descends from A
      # through some arbitrarily deep hierarchy, B.base_class will return A.
      def base_class
        class_of_active_record_descendant(self)
      end

P
Pratik Naik 已提交
1473
      # Set this to true if this is an abstract class (see <tt>abstract_class?</tt>).
1474 1475 1476 1477 1478
      attr_accessor :abstract_class

      # Returns whether this class is a base AR class.  If A is a base class and
      # B descends from A, then B.base_class will return B.
      def abstract_class?
1479
        defined?(@abstract_class) && @abstract_class == true
1480 1481
      end

1482
      def respond_to?(method_id, include_private = false)
1483 1484
        if match = DynamicFinderMatch.match(method_id)
          return true if all_attributes_exists?(match.attribute_names)
1485 1486
        elsif match = DynamicScopeMatch.match(method_id)
          return true if all_attributes_exists?(match.attribute_names)
1487
        end
1488

1489 1490 1491
        super
      end

1492 1493 1494 1495
      def sti_name
        store_full_sti_class ? name : name.demodulize
      end

1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509
      # Merges conditions so that the result is a valid +condition+
      def merge_conditions(*conditions)
        segments = []

        conditions.each do |condition|
          unless condition.blank?
            sql = sanitize_sql(condition)
            segments << sql unless sql.blank?
          end
        end

        "(#{segments.join(') AND (')})" unless segments.empty?
      end

1510
      def arel_table(table = nil)
1511
        Relation.new(self, Arel::Table.new(table || table_name))
1512 1513
      end

D
Initial  
David Heinemeier Hansson 已提交
1514
      private
1515
        def find_initial(options)
1516
          options.update(:limit => 1)
1517 1518
          find_every(options).first
        end
1519

1520 1521 1522 1523 1524 1525 1526 1527 1528 1529
        def find_last(options)
          order = options[:order]

          if order
            order = reverse_sql_order(order)
          elsif !scoped?(:find, :order)
            order = "#{table_name}.#{primary_key} DESC"
          end

          if scoped?(:find, :order)
1530 1531 1532
            scope = scope(:find)
            original_scoped_order = scope[:order]
            scope[:order] = reverse_sql_order(original_scoped_order)
1533
          end
1534

1535 1536 1537 1538 1539
          begin
            find_initial(options.merge({ :order => order }))
          ensure
            scope[:order] = original_scoped_order if original_scoped_order
          end
1540 1541 1542
        end

        def reverse_sql_order(order_query)
1543
          order_query.to_s.split(/,/).each { |s|
1544 1545 1546 1547
            if s.match(/\s(asc|ASC)$/)
              s.gsub!(/\s(asc|ASC)$/, ' DESC')
            elsif s.match(/\s(desc|DESC)$/)
              s.gsub!(/\s(desc|DESC)$/, ' ASC')
1548
            else
1549 1550 1551 1552
              s.concat(' DESC')
            end
          }.join(',')
        end
1553

1554
        def find_every(options)
1555 1556 1557 1558 1559 1560 1561 1562 1563 1564
          include_associations = merge_includes(scope(:find, :include), options[:include])

          if include_associations.any? && references_eager_loaded_tables?(options)
            records = find_with_associations(options)
          else
            records = find_by_sql(construct_finder_sql(options))
            if include_associations.any?
              preload_associations(records, include_associations)
            end
          end
1565 1566 1567 1568 1569

          records.each { |record| record.readonly! } if options[:readonly]

          records
        end
1570

1571
        def find_from_ids(ids, options)
1572
          expects_array = ids.first.kind_of?(Array)
1573
          return ids.first if expects_array && ids.first.empty?
1574

1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586
          ids = ids.flatten.compact.uniq

          case ids.size
            when 0
              raise RecordNotFound, "Couldn't find #{name} without an ID"
            when 1
              result = find_one(ids.first, options)
              expects_array ? [ result ] : result
            else
              find_some(ids, options)
          end
        end
1587

1588 1589
        def find_one(id, options)
          conditions = " AND (#{sanitize_sql(options[:conditions])})" if options[:conditions]
1590
          options.update :conditions => "#{quoted_table_name}.#{connection.quote_column_name(primary_key)} = #{quote_value(id,columns_hash[primary_key])}#{conditions}"
1591

1592 1593 1594 1595
          # Use find_every(options).first since the primary key condition
          # already ensures we have a single record. Using find_initial adds
          # a superfluous :limit => 1.
          if result = find_every(options).first
1596 1597 1598 1599 1600
            result
          else
            raise RecordNotFound, "Couldn't find #{name} with ID=#{id}#{conditions}"
          end
        end
1601

1602 1603
        def find_some(ids, options)
          conditions = " AND (#{sanitize_sql(options[:conditions])})" if options[:conditions]
1604
          ids_list   = ids.map { |id| quote_value(id,columns_hash[primary_key]) }.join(',')
1605
          options.update :conditions => "#{quoted_table_name}.#{connection.quote_column_name(primary_key)} IN (#{ids_list})#{conditions}"
1606 1607 1608

          result = find_every(options)

1609
          # Determine expected size from limit and offset, not just ids.size.
1610 1611 1612 1613 1614 1615
          expected_size =
            if options[:limit] && ids.size > options[:limit]
              options[:limit]
            else
              ids.size
            end
1616 1617 1618 1619 1620

          # 11 ids with limit 3, offset 9 should give 2 results.
          if options[:offset] && (ids.size - options[:offset] < expected_size)
            expected_size = ids.size - options[:offset]
          end
1621 1622

          if result.size == expected_size
1623 1624
            result
          else
1625
            raise RecordNotFound, "Couldn't find all #{name.pluralize} with IDs (#{ids_list})#{conditions} (found #{result.size} results, but was looking for #{expected_size})"
1626 1627 1628
          end
        end

1629 1630 1631
        # Finder methods must instantiate through this method to work with the
        # single-table inheritance model that makes it possible to create
        # objects of different types from the same table.
D
Initial  
David Heinemeier Hansson 已提交
1632
        def instantiate(record)
1633
          object = find_sti_class(record[inheritance_column]).allocate
1634

1635
          object.send(:initialize_attribute_store, record)
1636
          object.instance_variable_set(:'@attributes_cache', {})
1637

1638 1639
          object.send(:_run_find_callbacks)
          object.send(:_run_initialize_callbacks)
1640

1641
          object
D
Initial  
David Heinemeier Hansson 已提交
1642
        end
1643

1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659
        def find_sti_class(type_name)
          if type_name.blank? || !columns_hash.include?(inheritance_column)
            self
          else
            begin
              compute_type(type_name)
            rescue NameError
              raise SubclassNotFound,
                "The single-table inheritance mechanism failed to locate the subclass: '#{type_name}'. " +
                "This error is raised because the column '#{inheritance_column}' is reserved for storing the class in case of inheritance. " +
                "Please rename this column if you didn't intend it to be used for storing the inheritance class " +
                "or overwrite #{name}.inheritance_column to use another column for that information."
            end
          end
        end

1660 1661
        # Nest the type name in the same module as this class.
        # Bar is "MyApp::Business::Bar" relative to MyApp::Business::Foo
D
Initial  
David Heinemeier Hansson 已提交
1662
        def type_name_with_module(type_name)
1663 1664 1665 1666 1667
          if store_full_sti_class
            type_name
          else
            (/^::/ =~ type_name) ? type_name : "#{parent.name}::#{type_name}"
          end
D
Initial  
David Heinemeier Hansson 已提交
1668 1669
        end

1670 1671 1672 1673 1674 1675 1676 1677
        def default_select(qualified)
          if qualified
            quoted_table_name + '.*'
          else
            '*'
          end
        end

1678
        def construct_finder_arel(options = {}, scope = scope(:find))
E
Emilio Tagua 已提交
1679
          # TODO add lock to Arel
1680 1681
          validate_find_options(options)

1682
          relation = arel_table(options[:from]).
1683
            joins(construct_join(options[:joins], scope)).
1684
            where(construct_conditions(options[:conditions], scope)).
1685 1686 1687 1688 1689
            select(options[:select] || (scope && scope[:select]) || default_select(options[:joins] || (scope && scope[:joins]))).
            group(construct_group(options[:group], options[:having], scope)).
            order(construct_order(options[:order], scope)).
            limit(construct_limit(options[:limit], scope)).
            offset(construct_offset(options[:offset], scope))
1690 1691 1692 1693

          relation = relation.readonly if options[:readonly]

          relation
1694 1695
        end

1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710
        def construct_finder_arel_with_includes(options = {})
          relation = construct_finder_arel(options)
          include_associations = merge_includes(scope(:find, :include), options[:include])

          if include_associations.any?
            if references_eager_loaded_tables?(options)
              relation = relation.eager_load(include_associations)
            else
              relation = relation.preload(include_associations)
            end
          end

          relation
        end

1711
        def construct_finder_sql(options, scope = scope(:find))
1712
          construct_finder_arel(options, scope).to_sql
E
Emilio Tagua 已提交
1713
        end
1714

1715
        def construct_join(joins, scope)
E
Emilio Tagua 已提交
1716 1717 1718 1719 1720 1721
          merged_joins = scope && scope[:joins] && joins ? merge_joins(scope[:joins], joins) : (joins || scope && scope[:joins])
          case merged_joins
          when Symbol, Hash, Array
            if array_of_strings?(merged_joins)
              merged_joins.join(' ') + " "
            else
1722
              build_association_joins(merged_joins)
E
Emilio Tagua 已提交
1723 1724 1725
            end
          when String
            " #{merged_joins} "
1726 1727
          else
            ""
E
Emilio Tagua 已提交
1728 1729 1730
          end
        end

1731
        def construct_group(group, having, scope)
E
Emilio Tagua 已提交
1732 1733 1734 1735
          sql = ''
          if group
            sql << group.to_s
            sql << " HAVING #{sanitize_sql_for_conditions(having)}" if having
1736 1737 1738
          elsif scope && (scoped_group = scope[:group])
            sql << scoped_group.to_s
            sql << " HAVING #{sanitize_sql_for_conditions(scope[:having])}" if scope[:having]
E
Emilio Tagua 已提交
1739 1740 1741
          end
          sql
        end
1742

1743
        def construct_order(order, scope)
1744
          orders = []
E
Emilio Tagua 已提交
1745 1746
          scoped_order = scope[:order] if scope
          if order
1747 1748
            orders << order
            orders << scoped_order if scoped_order && scoped_order != order
1749 1750
          elsif scoped_order
            orders << scoped_order
E
Emilio Tagua 已提交
1751
          end
1752
          orders
1753
        end
1754

1755 1756 1757
        def construct_limit(limit, scope)
          limit ||= scope[:limit] if scope
          limit
E
Emilio Tagua 已提交
1758 1759
        end

1760 1761 1762
        def construct_offset(offset, scope)
          offset ||= scope[:offset] if scope
          offset
E
Emilio Tagua 已提交
1763 1764
        end

1765
        def construct_conditions(conditions, scope)
E
Emilio Tagua 已提交
1766 1767 1768 1769 1770 1771
          conditions = [conditions]
          conditions << scope[:conditions] if scope
          conditions << type_condition if finder_needs_type_condition?
          merge_conditions(*conditions)
        end

1772 1773
        # Merges includes so that the result is a valid +include+
        def merge_includes(first, second)
1774
         (safe_to_array(first) + safe_to_array(second)).uniq
1775 1776
        end

1777 1778 1779 1780
        def merge_joins(*joins)
          if joins.any?{|j| j.is_a?(String) || array_of_strings?(j) }
            joins = joins.collect do |join|
              join = [join] if join.is_a?(String)
1781
              join = build_association_joins(join) unless array_of_strings?(join)
1782
              join
1783
            end
1784
            joins.flatten.map{|j| j.strip}.uniq
1785
          else
1786
            joins.collect{|j| safe_to_array(j)}.flatten.uniq
1787 1788 1789
          end
        end

1790
        def build_association_joins(joins)
1791
          join_dependency = ActiveRecord::Associations::ClassMethods::JoinDependency.new(self, joins, nil)
1792
          relation = arel_table.relation
1793
          join_dependency.join_associations.map { |association|
1794 1795 1796
            if (association_relation = association.relation).is_a?(Array)
              [Arel::InnerJoin.new(relation, association_relation.first, association.association_join.first).joins(relation),
              Arel::InnerJoin.new(relation, association_relation.last, association.association_join.last).joins(relation)].join()
1797
            else
1798
              Arel::InnerJoin.new(relation, association_relation, association.association_join).joins(relation)
1799 1800 1801 1802
            end
          }.join(" ")
        end

1803
        # Object#to_a is deprecated, though it does have the desired behavior
1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814
        def safe_to_array(o)
          case o
          when NilClass
            []
          when Array
            o
          else
            [o]
          end
        end

1815 1816 1817 1818
        def array_of_strings?(o)
          o.is_a?(Array) && o.all?{|obj| obj.is_a?(String)}
        end

1819 1820
        # The optional scope argument is for the current <tt>:find</tt> scope.
        # The <tt>:lock</tt> option has precedence over a scoped <tt>:lock</tt>.
1821
        def add_lock!(sql, options, scope = :auto)
1822
          scope = scope(:find) if :auto == scope
1823 1824 1825 1826
          options = options.reverse_merge(:lock => scope[:lock]) if scope
          connection.add_lock!(sql, options)
        end

1827 1828
        def type_condition(table_alias=nil)
          quoted_table_alias = self.connection.quote_table_name(table_alias || table_name)
1829
          quoted_inheritance_column = connection.quote_column_name(inheritance_column)
E
Emilio Tagua 已提交
1830
          type_condition = subclasses.inject("#{quoted_table_alias}.#{quoted_inheritance_column} = '#{sti_name}' " ) do |condition, subclass|
1831
            condition << "OR #{quoted_table_alias}.#{quoted_inheritance_column} = '#{subclass.sti_name}' "
1832
          end
1833 1834

          " (#{type_condition}) "
D
Initial  
David Heinemeier Hansson 已提交
1835 1836 1837
        end

        # Guesses the table name, but does not decorate it with prefix and suffix information.
1838
        def undecorated_table_name(class_name = base_class.name)
1839 1840
          table_name = class_name.to_s.demodulize.underscore
          table_name = table_name.pluralize if pluralize_table_names
1841
          table_name
D
Initial  
David Heinemeier Hansson 已提交
1842 1843
        end

P
Pratik Naik 已提交
1844
        # Enables dynamic finders like <tt>find_by_user_name(user_name)</tt> and <tt>find_by_user_name_and_password(user_name, password)</tt>
P
Pratik Naik 已提交
1845 1846
        # that are turned into <tt>where(:user_name => user_name).first</tt> and <tt>where(:user_name => user_name, :password => :password).first</tt>
        # respectively. Also works for <tt>all</tt> by using <tt>find_all_by_amount(50)</tt> that is turned into <tt>where(:amount => 50).all</tt>.
1847
        #
P
Pratik Naik 已提交
1848 1849
        # It's even possible to use all the additional parameters to +find+. For example, the full interface for +find_all_by_amount+
        # is actually <tt>find_all_by_amount(amount, options)</tt>.
1850
        #
1851 1852 1853 1854 1855
        # Also enables dynamic scopes like scoped_by_user_name(user_name) and scoped_by_user_name_and_password(user_name, password) that
        # are turned into scoped(:conditions => ["user_name = ?", user_name]) and scoped(:conditions => ["user_name = ? AND password = ?", user_name, password])
        # respectively.
        #
        # Each dynamic finder, scope or initializer/creator is also defined in the class after it is first invoked, so that future
1856
        # attempts to use it do not run through method_missing.
1857
        def method_missing(method_id, *arguments, &block)
1858 1859
          if match = DynamicFinderMatch.match(method_id)
            attribute_names = match.attribute_names
1860
            super unless all_attributes_exists?(attribute_names)
1861
            if match.finder?
1862 1863 1864
              options = arguments.extract_options!
              relation = options.any? ? construct_finder_arel_with_includes(options) : scoped
              relation.send :find_by_attributes, match, attribute_names, *arguments
1865
            elsif match.instantiator?
1866
              scoped.send :find_or_instantiator_by_attributes, match, attribute_names, *arguments, &block
1867
            end
1868 1869 1870 1871 1872 1873 1874 1875 1876 1877
          elsif match = DynamicScopeMatch.match(method_id)
            attribute_names = match.attribute_names
            super unless all_attributes_exists?(attribute_names)
            if match.scope?
              self.class_eval %{
                def self.#{method_id}(*args)                        # def self.scoped_by_user_name_and_password(*args)
                  options = args.extract_options!                   #   options = args.extract_options!
                  attributes = construct_attributes_from_arguments( #   attributes = construct_attributes_from_arguments(
                    [:#{attribute_names.join(',:')}], args          #     [:user_name, :password], args
                  )                                                 #   )
E
Emilio Tagua 已提交
1878
                                                                    #
1879 1880 1881 1882 1883
                  scoped(:conditions => attributes)                 #   scoped(:conditions => attributes)
                end                                                 # end
              }, __FILE__, __LINE__
              send(method_id, *arguments)
            end
1884 1885 1886 1887
          else
            super
          end
        end
D
Initial  
David Heinemeier Hansson 已提交
1888

1889 1890 1891 1892 1893 1894
        def construct_attributes_from_arguments(attribute_names, arguments)
          attributes = {}
          attribute_names.each_with_index { |name, idx| attributes[name] = arguments[idx] }
          attributes
        end

1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909
        # Similar in purpose to +expand_hash_conditions_for_aggregates+.
        def expand_attribute_names_for_aggregates(attribute_names)
          expanded_attribute_names = []
          attribute_names.each do |attribute_name|
            unless (aggregation = reflect_on_aggregation(attribute_name.to_sym)).nil?
              aggregate_mapping(aggregation).each do |field_attr, aggregate_attr|
                expanded_attribute_names << field_attr
              end
            else
              expanded_attribute_names << attribute_name
            end
          end
          expanded_attribute_names
        end

1910
        def all_attributes_exists?(attribute_names)
1911
          attribute_names = expand_attribute_names_for_aggregates(attribute_names)
1912
          attribute_names.all? { |name| column_methods_hash.include?(name.to_sym) }
1913
        end
1914

1915
        def attribute_condition(quoted_column_name, argument)
1916
          case argument
1917 1918 1919 1920 1921 1922 1923 1924
            when nil   then "#{quoted_column_name} IS ?"
            when Array, ActiveRecord::Associations::AssociationCollection, ActiveRecord::NamedScope::Scope then "#{quoted_column_name} IN (?)"
            when Range then if argument.exclude_end?
                              "#{quoted_column_name} >= ? AND #{quoted_column_name} < ?"
                            else
                              "#{quoted_column_name} BETWEEN ? AND ?"
                            end
            else            "#{quoted_column_name} = ?"
1925 1926 1927
          end
        end

1928 1929 1930 1931
        # Interpret Array and Hash as conditions and anything else as an id.
        def expand_id_conditions(id_or_conditions)
          case id_or_conditions
            when Array, Hash then id_or_conditions
1932
            else sanitize_sql(primary_key => id_or_conditions)
1933 1934 1935
          end
        end

D
Initial  
David Heinemeier Hansson 已提交
1936
      protected
1937
        # Scope parameters to method calls within the block.  Takes a hash of method_name => parameters hash.
1938 1939
        # method_name may be <tt>:find</tt> or <tt>:create</tt>. <tt>:find</tt> parameters may include the <tt>:conditions</tt>, <tt>:joins</tt>,
        # <tt>:include</tt>, <tt>:offset</tt>, <tt>:limit</tt>, and <tt>:readonly</tt> options. <tt>:create</tt> parameters are an attributes hash.
1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950
        #
        #   class Article < ActiveRecord::Base
        #     def self.create_with_scope
        #       with_scope(:find => { :conditions => "blog_id = 1" }, :create => { :blog_id => 1 }) do
        #         find(1) # => SELECT * from articles WHERE blog_id = 1 AND id = 1
        #         a = create(1)
        #         a.blog_id # => 1
        #       end
        #     end
        #   end
        #
D
David Heinemeier Hansson 已提交
1951
        # In nested scopings, all previous parameters are overwritten by the innermost rule, with the exception of
P
Pratik Naik 已提交
1952 1953 1954 1955 1956
        # <tt>:conditions</tt>, <tt>:include</tt>, and <tt>:joins</tt> options in <tt>:find</tt>, which are merged.
        #
        # <tt>:joins</tt> options are uniqued so multiple scopes can join in the same table without table aliasing
        # problems.  If you need to join multiple tables, but still want one of the tables to be uniqued, use the
        # array of strings format for your joins.
1957 1958 1959 1960
        #
        #   class Article < ActiveRecord::Base
        #     def self.find_with_scope
        #       with_scope(:find => { :conditions => "blog_id = 1", :limit => 1 }, :create => { :blog_id => 1 }) do
P
Pratik Naik 已提交
1961
        #         with_scope(:find => { :limit => 10 })
1962 1963 1964 1965 1966 1967 1968 1969 1970
        #           find(:all) # => SELECT * from articles WHERE blog_id = 1 LIMIT 10
        #         end
        #         with_scope(:find => { :conditions => "author_id = 3" })
        #           find(:all) # => SELECT * from articles WHERE blog_id = 1 AND author_id = 3 LIMIT 1
        #         end
        #       end
        #     end
        #   end
        #
1971
        # You can ignore any previous scopings by using the <tt>with_exclusive_scope</tt> method.
1972 1973 1974 1975 1976 1977 1978 1979 1980 1981
        #
        #   class Article < ActiveRecord::Base
        #     def self.find_with_exclusive_scope
        #       with_scope(:find => { :conditions => "blog_id = 1", :limit => 1 }) do
        #         with_exclusive_scope(:find => { :limit => 10 })
        #           find(:all) # => SELECT * from articles LIMIT 10
        #         end
        #       end
        #     end
        #   end
P
Pratik Naik 已提交
1982 1983 1984
        #
        # *Note*: the +:find+ scope also has effect on update and deletion methods,
        # like +update_all+ and +delete_all+.
1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996
        def with_scope(method_scoping = {}, action = :merge, &block)
          method_scoping = method_scoping.method_scoping if method_scoping.respond_to?(:method_scoping)

          # Dup first and second level of hash (method and params).
          method_scoping = method_scoping.inject({}) do |hash, (method, params)|
            hash[method] = (params == true) ? params : params.dup
            hash
          end

          method_scoping.assert_valid_keys([ :find, :create ])

          if f = method_scoping[:find]
1997
            f.assert_valid_keys(VALID_FIND_OPTIONS)
1998 1999 2000 2001
            set_readonly_option! f
          end

          # Merge scopings
2002
          if [:merge, :reverse_merge].include?(action) && current_scoped_methods
2003 2004 2005 2006 2007 2008 2009
            method_scoping = current_scoped_methods.inject(method_scoping) do |hash, (method, params)|
              case hash[method]
                when Hash
                  if method == :find
                    (hash[method].keys + params.keys).uniq.each do |key|
                      merge = hash[method][key] && params[key] # merge if both scopes have the same key
                      if key == :conditions && merge
2010 2011 2012 2013 2014
                        if params[key].is_a?(Hash) && hash[method][key].is_a?(Hash)
                          hash[method][key] = merge_conditions(hash[method][key].deep_merge(params[key]))
                        else
                          hash[method][key] = merge_conditions(params[key], hash[method][key])
                        end
2015
                      elsif key == :include && merge
2016
                        hash[method][key] = merge_includes(hash[method][key], params[key]).uniq
2017 2018
                      elsif key == :joins && merge
                        hash[method][key] = merge_joins(params[key], hash[method][key])
2019 2020 2021 2022 2023
                      else
                        hash[method][key] = hash[method][key] || params[key]
                      end
                    end
                  else
2024 2025 2026 2027 2028
                    if action == :reverse_merge
                      hash[method] = hash[method].merge(params)
                    else
                      hash[method] = params.merge(hash[method])
                    end
2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049
                  end
                else
                  hash[method] = params
              end
              hash
            end
          end

          self.scoped_methods << method_scoping
          begin
            yield
          ensure
            self.scoped_methods.pop
          end
        end

        # Works like with_scope, but discards any nested properties.
        def with_exclusive_scope(method_scoping = {}, &block)
          with_scope(method_scoping, :overwrite, &block)
        end

D
David Heinemeier Hansson 已提交
2050
        def subclasses #:nodoc:
D
Initial  
David Heinemeier Hansson 已提交
2051 2052 2053
          @@subclasses[self] ||= []
          @@subclasses[self] + extra = @@subclasses[self].inject([]) {|list, subclass| list + subclass.subclasses }
        end
2054

2055
        # Sets the default options for the model. The format of the
2056
        # <tt>options</tt> argument is the same as in find.
2057 2058
        #
        #   class Person < ActiveRecord::Base
2059
        #     default_scope :order => 'last_name, first_name'
2060 2061
        #   end
        def default_scope(options = {})
2062
          self.default_scoping << { :find => options, :create => options[:conditions].is_a?(Hash) ? options[:conditions] : {} }
2063 2064
        end

2065
        # Test whether the given method and optional key are scoped.
D
David Heinemeier Hansson 已提交
2066
        def scoped?(method, key = nil) #:nodoc:
2067
          if current_scoped_methods && (scope = current_scoped_methods[method])
2068
            !key || !scope[key].nil?
2069
          end
2070 2071 2072
        end

        # Retrieve the scope for the given method and optional key.
D
David Heinemeier Hansson 已提交
2073
        def scope(method, key = nil) #:nodoc:
2074
          if current_scoped_methods && (scope = current_scoped_methods[method])
2075 2076 2077 2078
            key ? scope[key] : scope
          end
        end

2079
        def scoped_methods #:nodoc:
2080
          Thread.current[:"#{self}_scoped_methods"] ||= self.default_scoping.dup
2081
        end
2082

D
David Heinemeier Hansson 已提交
2083
        def current_scoped_methods #:nodoc:
2084
          scoped_methods.last
2085
        end
2086

P
Pratik Naik 已提交
2087
        # Returns the class type of the record using the current module as a prefix. So descendants of
2088
        # MyApp::Business::Account would appear as MyApp::Business::AccountSubclass.
D
Initial  
David Heinemeier Hansson 已提交
2089
        def compute_type(type_name)
2090
          modularized_name = type_name_with_module(type_name)
2091 2092 2093 2094 2095 2096
          silence_warnings do
            begin
              class_eval(modularized_name, __FILE__, __LINE__)
            rescue NameError
              class_eval(type_name, __FILE__, __LINE__)
            end
D
Initial  
David Heinemeier Hansson 已提交
2097 2098 2099
          end
        end

P
Pratik Naik 已提交
2100 2101
        # Returns the class descending directly from ActiveRecord::Base or an
        # abstract class, if any, in the inheritance hierarchy.
2102
        def class_of_active_record_descendant(klass)
2103
          if klass.superclass == Base || klass.superclass.abstract_class?
2104
            klass
D
Initial  
David Heinemeier Hansson 已提交
2105 2106 2107
          elsif klass.superclass.nil?
            raise ActiveRecordError, "#{name} doesn't belong in a hierarchy descending from ActiveRecord"
          else
2108
            class_of_active_record_descendant(klass.superclass)
D
Initial  
David Heinemeier Hansson 已提交
2109 2110 2111
          end
        end

P
Pratik Naik 已提交
2112
        # Returns the name of the class descending directly from Active Record in the inheritance hierarchy.
D
David Heinemeier Hansson 已提交
2113
        def class_name_of_active_record_descendant(klass) #:nodoc:
2114
          klass.base_class.name
2115 2116
        end

P
Pratik Naik 已提交
2117
        # Accepts an array, hash, or string of SQL conditions and sanitizes
2118
        # them into a valid SQL fragment for a WHERE clause.
2119 2120 2121
        #   ["name='%s' and group_id='%s'", "foo'bar", 4]  returns  "name='foo''bar' and group_id='4'"
        #   { :name => "foo'bar", :group_id => 4 }  returns "name='foo''bar' and group_id='4'"
        #   "name='foo''bar' and group_id='4'" returns "name='foo''bar' and group_id='4'"
2122
        def sanitize_sql_for_conditions(condition, table_name = quoted_table_name)
2123 2124
          return nil if condition.blank?

2125 2126
          case condition
            when Array; sanitize_sql_array(condition)
2127
            when Hash;  sanitize_sql_hash_for_conditions(condition, table_name)
2128 2129
            else        condition
          end
2130
        end
2131
        alias_method :sanitize_sql, :sanitize_sql_for_conditions
2132

P
Pratik Naik 已提交
2133
        # Accepts an array, hash, or string of SQL conditions and sanitizes
2134 2135 2136 2137 2138 2139 2140 2141 2142 2143
        # them into a valid SQL fragment for a SET clause.
        #   { :name => nil, :group_id => 4 }  returns "name = NULL , group_id='4'"
        def sanitize_sql_for_assignment(assignments)
          case assignments
            when Array; sanitize_sql_array(assignments)
            when Hash;  sanitize_sql_hash_for_assignment(assignments)
            else        assignments
          end
        end

2144 2145 2146 2147 2148
        def aggregate_mapping(reflection)
          mapping = reflection.options[:mapping] || [reflection.name, reflection.name]
          mapping.first.is_a?(Array) ? mapping : [mapping]
        end

P
Pratik Naik 已提交
2149
        # Accepts a hash of SQL conditions and replaces those attributes
2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178
        # that correspond to a +composed_of+ relationship with their expanded
        # aggregate attribute values.
        # Given:
        #     class Person < ActiveRecord::Base
        #       composed_of :address, :class_name => "Address",
        #         :mapping => [%w(address_street street), %w(address_city city)]
        #     end
        # Then:
        #     { :address => Address.new("813 abc st.", "chicago") }
        #       # => { :address_street => "813 abc st.", :address_city => "chicago" }
        def expand_hash_conditions_for_aggregates(attrs)
          expanded_attrs = {}
          attrs.each do |attr, value|
            unless (aggregation = reflect_on_aggregation(attr.to_sym)).nil?
              mapping = aggregate_mapping(aggregation)
              mapping.each do |field_attr, aggregate_attr|
                if mapping.size == 1 && !value.respond_to?(aggregate_attr)
                  expanded_attrs[field_attr] = value
                else
                  expanded_attrs[field_attr] = value.send(aggregate_attr)
                end
              end
            else
              expanded_attrs[attr] = value
            end
          end
          expanded_attrs
        end

2179
        # Sanitizes a hash of attribute/value pairs into SQL conditions for a WHERE clause.
2180 2181 2182 2183
        #   { :name => "foo'bar", :group_id => 4 }
        #     # => "name='foo''bar' and group_id= 4"
        #   { :status => nil, :group_id => [1,2,3] }
        #     # => "status IS NULL and group_id IN (1,2,3)"
2184 2185
        #   { :age => 13..18 }
        #     # => "age BETWEEN 13 AND 18"
2186 2187
        #   { 'other_records.id' => 7 }
        #     # => "`other_records`.`id` = 7"
2188 2189
        #   { :other_records => { :id => 7 } }
        #     # => "`other_records`.`id` = 7"
2190 2191 2192
        # And for value objects on a composed_of relationship:
        #   { :address => Address.new("123 abc st.", "chicago") }
        #     # => "address_street='123 abc st.' and address_city='chicago'"
2193
        def sanitize_sql_hash_for_conditions(attrs, default_table_name = quoted_table_name)
2194 2195
          attrs = expand_hash_conditions_for_aggregates(attrs)

2196
          conditions = attrs.map do |attr, value|
2197 2198
            table_name = default_table_name

2199 2200 2201 2202 2203
            unless value.is_a?(Hash)
              attr = attr.to_s

              # Extract table name from qualified attribute names.
              if attr.include?('.')
2204 2205 2206 2207
                attr_table_name, attr = attr.split('.', 2)
                attr_table_name = connection.quote_table_name(attr_table_name)
              else
                attr_table_name = table_name
2208
              end
2209

2210
              attribute_condition("#{attr_table_name}.#{connection.quote_column_name(attr)}", value)
2211
            else
2212
              sanitize_sql_hash_for_conditions(value, connection.quote_table_name(attr.to_s))
2213
            end
2214 2215
          end.join(' AND ')

2216
          replace_bind_variables(conditions, expand_range_bind_variables(attrs.values))
2217
        end
2218 2219 2220 2221 2222 2223
        alias_method :sanitize_sql_hash, :sanitize_sql_hash_for_conditions

        # Sanitizes a hash of attribute/value pairs into SQL conditions for a SET clause.
        #   { :status => nil, :group_id => 1 }
        #     # => "status = NULL , group_id = 1"
        def sanitize_sql_hash_for_assignment(attrs)
2224
          attrs.map do |attr, value|
2225 2226 2227
            "#{connection.quote_column_name(attr)} = #{quote_bound_value(value)}"
          end.join(', ')
        end
2228

2229
        # Accepts an array of conditions.  The array has each value
P
Pratik Naik 已提交
2230
        # sanitized and interpolated into the SQL statement.
2231
        #   ["name='%s' and group_id='%s'", "foo'bar", 4]  returns  "name='foo''bar' and group_id='4'"
2232
        def sanitize_sql_array(ary)
2233 2234 2235 2236
          statement, *values = ary
          if values.first.is_a?(Hash) and statement =~ /:\w+/
            replace_named_bind_variables(statement, values.first)
          elsif statement.include?('?')
2237 2238
            replace_bind_variables(statement, values)
          else
2239
            statement % values.collect { |value| connection.quote_string(value.to_s) }
2240
          end
2241 2242
        end

2243 2244
        alias_method :sanitize_conditions, :sanitize_sql

D
David Heinemeier Hansson 已提交
2245
        def replace_bind_variables(statement, values) #:nodoc:
2246
          raise_if_bind_arity_mismatch(statement, statement.count('?'), values.size)
2247
          bound = values.dup
2248
          statement.gsub('?') { quote_bound_value(bound.shift) }
2249 2250
        end

D
David Heinemeier Hansson 已提交
2251
        def replace_named_bind_variables(statement, bind_vars) #:nodoc:
2252 2253 2254 2255
          statement.gsub(/(:?):([a-zA-Z]\w*)/) do
            if $1 == ':' # skip postgresql casts
              $& # return the whole match
            elsif bind_vars.include?(match = $2.to_sym)
2256
              quote_bound_value(bind_vars[match])
2257 2258
            else
              raise PreparedStatementInvalid, "missing value for :#{match} in #{statement}"
2259 2260
            end
          end
2261 2262
        end

2263
        def expand_range_bind_variables(bind_vars) #:nodoc:
2264 2265 2266
          expanded = []

          bind_vars.each do |var|
2267 2268
            next if var.is_a?(Hash)

2269
            if var.is_a?(Range)
2270 2271
              expanded << var.first
              expanded << var.last
2272
            else
2273
              expanded << var
2274
            end
2275
          end
2276 2277

          expanded
2278 2279
        end

D
David Heinemeier Hansson 已提交
2280
        def quote_bound_value(value) #:nodoc:
2281
          if value.respond_to?(:map) && !value.acts_like?(:string)
2282 2283
            if value.respond_to?(:empty?) && value.empty?
              connection.quote(nil)
2284 2285 2286
            else
              value.map { |v| connection.quote(v) }.join(',')
            end
2287 2288
          else
            connection.quote(value)
2289 2290 2291
          end
        end

D
David Heinemeier Hansson 已提交
2292
        def raise_if_bind_arity_mismatch(statement, expected, provided) #:nodoc:
2293 2294 2295
          unless expected == provided
            raise PreparedStatementInvalid, "wrong number of bind variables (#{provided} for #{expected}) in: #{statement}"
          end
2296
        end
2297

2298
        VALID_FIND_OPTIONS = [ :conditions, :include, :joins, :limit, :offset,
2299
                               :order, :select, :readonly, :group, :having, :from, :lock ]
2300

D
David Heinemeier Hansson 已提交
2301
        def validate_find_options(options) #:nodoc:
2302 2303
          options.assert_valid_keys(VALID_FIND_OPTIONS)
        end
2304

D
David Heinemeier Hansson 已提交
2305
        def set_readonly_option!(options) #:nodoc:
2306 2307 2308
          # Inherit :readonly from finder scope if set.  Otherwise,
          # if :joins is not blank then :readonly defaults to true.
          unless options.has_key?(:readonly)
J
Jeremy Kemper 已提交
2309 2310
            if scoped_readonly = scope(:find, :readonly)
              options[:readonly] = scoped_readonly
2311
            elsif !options[:joins].blank? && !options[:select]
2312 2313 2314
              options[:readonly] = true
            end
          end
D
Initial  
David Heinemeier Hansson 已提交
2315
        end
2316

D
David Heinemeier Hansson 已提交
2317
        def encode_quoted_value(value) #:nodoc:
2318
          quoted_value = connection.quote(value)
2319 2320
          quoted_value = "'#{quoted_value[1..-2].gsub(/\'/, "\\\\'")}'" if quoted_value.include?("\\\'") # (for ruby mode) "
          quoted_value
2321
        end
D
Initial  
David Heinemeier Hansson 已提交
2322 2323 2324 2325 2326
    end

    public
      # New objects can be instantiated as either empty (pass no construction parameter) or pre-set with
      # attributes but not yet saved (pass a hash with key names matching the associated table column names).
2327
      # In both instances, valid attribute keys are determined by the column names of the associated table --
D
Initial  
David Heinemeier Hansson 已提交
2328 2329
      # hence you can't have attributes that aren't part of the table columns.
      def initialize(attributes = nil)
2330
        initialize_attribute_store(attributes_from_column_definition)
2331
        @attributes_cache = {}
D
Initial  
David Heinemeier Hansson 已提交
2332 2333 2334
        @new_record = true
        ensure_proper_type
        self.attributes = attributes unless attributes.nil?
2335
        self.class.send(:scope, :create).each { |att,value| self.send("#{att}=", value) } if self.class.send(:scoped?, :create)
2336
        result = yield self if block_given?
2337
        _run_initialize_callbacks
2338
        result
D
Initial  
David Heinemeier Hansson 已提交
2339
      end
2340

2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355
      # Cloned objects have no id assigned and are treated as new records. Note that this is a "shallow" clone
      # as it copies the object's attributes only, not its associations. The extent of a "deep" clone is
      # application specific and is therefore left to the application to implement according to its need.
      def initialize_copy(other)
        # Think the assertion which fails if the after_initialize callback goes at the end of the method is wrong. The
        # deleted clone method called new which therefore called the after_initialize callback. It then went on to copy
        # over the attributes. But if it's copying the attributes afterwards then it hasn't finished initializing right?
        # For example in the test suite the topic model's after_initialize method sets the author_email_address to
        # test@test.com. I would have thought this would mean that all cloned models would have an author email address
        # of test@test.com. However the test_clone test method seems to test that this is not the case. As a result the
        # after_initialize callback has to be run *before* the copying of the atrributes rather than afterwards in order
        # for all tests to pass. This makes no sense to me.
        callback(:after_initialize) if respond_to_without_attributes?(:after_initialize)
        cloned_attributes = other.clone_attributes(:read_attribute_before_type_cast)
        cloned_attributes.delete(self.class.primary_key)
2356
        initialize_attribute_store(cloned_attributes)
2357 2358 2359 2360 2361 2362 2363
        clear_aggregation_cache
        @attributes_cache = {}
        @new_record = true
        ensure_proper_type
        self.class.send(:scope, :create).each { |att, value| self.send("#{att}=", value) } if self.class.send(:scoped?, :create)
      end

P
Pratik Naik 已提交
2364 2365 2366 2367
      # Returns a String, which Action Pack uses for constructing an URL to this
      # object. The default implementation returns this record's id as a String,
      # or nil if this record's unsaved.
      #
P
Pratik Naik 已提交
2368 2369 2370
      # For example, suppose that you have a User model, and that you have a
      # <tt>map.resources :users</tt> route. Normally, +user_path+ will
      # construct a path with the user object's 'id' in it:
P
Pratik Naik 已提交
2371 2372
      #
      #   user = User.find_by_name('Phusion')
2373
      #   user_path(user)  # => "/users/1"
P
Pratik Naik 已提交
2374
      #
P
Pratik Naik 已提交
2375 2376
      # You can override +to_param+ in your model to make +user_path+ construct
      # a path using the user's name instead of the user's id:
P
Pratik Naik 已提交
2377 2378 2379 2380 2381 2382
      #
      #   class User < ActiveRecord::Base
      #     def to_param  # overridden
      #       name
      #     end
      #   end
E
Emilio Tagua 已提交
2383
      #
P
Pratik Naik 已提交
2384
      #   user = User.find_by_name('Phusion')
2385
      #   user_path(user)  # => "/users/Phusion"
2386
      def to_param
2387
        # We can't use alias_method here, because method 'id' optimizes itself on the fly.
2388
        (id = self.id) ? id.to_s : nil # Be sure to stringify the id for routes
2389
      end
2390

P
Pratik Naik 已提交
2391 2392 2393
      # Returns a cache key that can be used to identify this record.
      #
      # ==== Examples
2394 2395 2396 2397 2398
      #
      #   Product.new.cache_key     # => "products/new"
      #   Product.find(5).cache_key # => "products/5" (updated_at not available)
      #   Person.find(5).cache_key  # => "people/5-20071224150000" (updated_at available)
      def cache_key
2399
        case
2400
        when new_record?
J
Jeremy Kemper 已提交
2401 2402 2403
          "#{self.class.model_name.cache_key}/new"
        when timestamp = self[:updated_at]
          "#{self.class.model_name.cache_key}/#{id}-#{timestamp.to_s(:number)}"
2404
        else
J
Jeremy Kemper 已提交
2405
          "#{self.class.model_name.cache_key}/#{id}"
2406 2407
        end
      end
2408

2409
      def quoted_id #:nodoc:
2410
        quote_value(id, column_for_attribute(self.class.primary_key))
2411
      end
2412

2413
      # Returns true if this object hasn't been saved yet -- that is, a record for the object doesn't exist yet; otherwise, returns false.
2414
      def new_record?
2415
        @new_record || false
2416
      end
2417

2418 2419 2420 2421 2422
      # Returns true if this object has been destroyed, otherwise returns false.
      def destroyed?
        @destroyed || false
      end

P
Pratik Naik 已提交
2423 2424
      # :call-seq:
      #   save(perform_validation = true)
2425
      #
P
Pratik Naik 已提交
2426 2427 2428 2429 2430 2431 2432 2433
      # Saves the model.
      #
      # If the model is new a record gets created in the database, otherwise
      # the existing record gets updated.
      #
      # If +perform_validation+ is true validations run. If any of them fail
      # the action is cancelled and +save+ returns +false+. If the flag is
      # false validations are bypassed altogether. See
E
Emilio Tagua 已提交
2434
      # ActiveRecord::Validations for more information.
P
Pratik Naik 已提交
2435 2436 2437 2438
      #
      # There's a series of callbacks associated with +save+. If any of the
      # <tt>before_*</tt> callbacks return +false+ the action is cancelled and
      # +save+ returns +false+. See ActiveRecord::Callbacks for further
E
Emilio Tagua 已提交
2439
      # details.
D
Initial  
David Heinemeier Hansson 已提交
2440 2441 2442
      def save
        create_or_update
      end
2443

P
Pratik Naik 已提交
2444 2445 2446 2447 2448 2449 2450
      # Saves the model.
      #
      # If the model is new a record gets created in the database, otherwise
      # the existing record gets updated.
      #
      # With <tt>save!</tt> validations always run. If any of them fail
      # ActiveRecord::RecordInvalid gets raised. See ActiveRecord::Validations
E
Emilio Tagua 已提交
2451
      # for more information.
P
Pratik Naik 已提交
2452 2453 2454 2455
      #
      # There's a series of callbacks associated with <tt>save!</tt>. If any of
      # the <tt>before_*</tt> callbacks return +false+ the action is cancelled
      # and <tt>save!</tt> raises ActiveRecord::RecordNotSaved. See
E
Emilio Tagua 已提交
2456
      # ActiveRecord::Callbacks for further details.
2457
      def save!
2458
        create_or_update || raise(RecordNotSaved)
2459
      end
2460

P
Pratik Naik 已提交
2461 2462 2463
      # Deletes the record in the database and freezes this instance to
      # reflect that no changes should be made (since they can't be
      # persisted). Returns the frozen instance.
2464
      #
P
Pratik Naik 已提交
2465 2466 2467 2468 2469 2470
      # The row is simply removed with a SQL +DELETE+ statement on the
      # record's primary key, and no callbacks are executed.
      #
      # To enforce the object's +before_destroy+ and +after_destroy+
      # callbacks, Observer methods, or any <tt>:dependent</tt> association
      # options, use <tt>#destroy</tt>.
2471 2472
      def delete
        self.class.delete(id) unless new_record?
2473
        @destroyed = true
2474 2475 2476
        freeze
      end

D
Initial  
David Heinemeier Hansson 已提交
2477 2478 2479
      # Deletes the record in the database and freezes this instance to reflect that no changes should
      # be made (since they can't be persisted).
      def destroy
2480
        unless new_record?
2481
          self.class.arel_table.where(self.class.arel_table[self.class.primary_key].eq(id)).delete
D
Initial  
David Heinemeier Hansson 已提交
2482 2483
        end

2484
        @destroyed = true
D
Initial  
David Heinemeier Hansson 已提交
2485 2486 2487
        freeze
      end

2488
      # Returns an instance of the specified +klass+ with the attributes of the current record. This is mostly useful in relation to
2489
      # single-table inheritance structures where you want a subclass to appear as the superclass. This can be used along with record
2490
      # identification in Action Pack to allow, say, <tt>Client < Company</tt> to do something like render <tt>:partial => @client.becomes(Company)</tt>
2491 2492 2493 2494 2495
      # to render that instance using the companies/company partial instead of clients/client.
      #
      # Note: The new instance will share a link to the same attributes as the original class. So any change to the attributes in either
      # instance will affect the other.
      def becomes(klass)
J
Jeremy Kemper 已提交
2496 2497 2498 2499 2500
        became = klass.new
        became.instance_variable_set("@attributes", @attributes)
        became.instance_variable_set("@attributes_cache", @attributes_cache)
        became.instance_variable_set("@new_record", new_record?)
        became
2501 2502
      end

2503 2504 2505
      # Updates a single attribute and saves the record without going through the normal validation procedure.
      # This is especially useful for boolean flags on existing records. The regular +update_attribute+ method
      # in Base is replaced with this when the validations module is mixed in, which it is by default.
D
Initial  
David Heinemeier Hansson 已提交
2506
      def update_attribute(name, value)
2507
        send(name.to_s + '=', value)
2508
        save(false)
2509 2510
      end

2511
      # Updates all the attributes from the passed-in Hash and saves the record. If the object is invalid, the saving will
2512
      # fail and false will be returned.
2513
      def update_attributes(attributes)
2514
        self.attributes = attributes
2515
        save
D
Initial  
David Heinemeier Hansson 已提交
2516
      end
2517

2518 2519 2520 2521 2522
      # Updates an object just like Base.update_attributes but calls save! instead of save so an exception is raised if the record is invalid.
      def update_attributes!(attributes)
        self.attributes = attributes
        save!
      end
D
Initial  
David Heinemeier Hansson 已提交
2523

P
Pratik Naik 已提交
2524 2525 2526
      # Initializes +attribute+ to zero if +nil+ and adds the value passed as +by+ (default is 1).
      # The increment is performed directly on the underlying attribute, no setter is invoked.
      # Only makes sense for number-based attributes. Returns +self+.
2527
      def increment(attribute, by = 1)
2528
        self[attribute] ||= 0
2529
        self[attribute] += by
2530 2531
        self
      end
2532

P
Pratik Naik 已提交
2533 2534 2535 2536
      # Wrapper around +increment+ that saves the record. This method differs from
      # its non-bang version in that it passes through the attribute setter.
      # Saving is not subjected to validation checks. Returns +true+ if the
      # record could be saved.
2537 2538
      def increment!(attribute, by = 1)
        increment(attribute, by).update_attribute(attribute, self[attribute])
2539 2540
      end

P
Pratik Naik 已提交
2541 2542 2543
      # Initializes +attribute+ to zero if +nil+ and subtracts the value passed as +by+ (default is 1).
      # The decrement is performed directly on the underlying attribute, no setter is invoked.
      # Only makes sense for number-based attributes. Returns +self+.
2544
      def decrement(attribute, by = 1)
2545
        self[attribute] ||= 0
2546
        self[attribute] -= by
2547 2548 2549
        self
      end

P
Pratik Naik 已提交
2550 2551 2552 2553
      # Wrapper around +decrement+ that saves the record. This method differs from
      # its non-bang version in that it passes through the attribute setter.
      # Saving is not subjected to validation checks. Returns +true+ if the
      # record could be saved.
2554 2555
      def decrement!(attribute, by = 1)
        decrement(attribute, by).update_attribute(attribute, self[attribute])
2556
      end
2557

P
Pratik Naik 已提交
2558 2559 2560 2561
      # Assigns to +attribute+ the boolean opposite of <tt>attribute?</tt>. So
      # if the predicate returns +true+ the attribute will become +false+. This
      # method toggles directly the underlying value without calling any setter.
      # Returns +self+.
2562
      def toggle(attribute)
2563
        self[attribute] = !send("#{attribute}?")
2564 2565 2566
        self
      end

P
Pratik Naik 已提交
2567 2568 2569 2570
      # Wrapper around +toggle+ that saves the record. This method differs from
      # its non-bang version in that it passes through the attribute setter.
      # Saving is not subjected to validation checks. Returns +true+ if the
      # record could be saved.
2571 2572 2573 2574
      def toggle!(attribute)
        toggle(attribute).update_attribute(attribute, self[attribute])
      end

2575
      # Reloads the attributes of this object from the database.
2576 2577 2578 2579
      # The optional options argument is passed to find when reloading so you
      # may do e.g. record.reload(:lock => true) to reload the same record with
      # an exclusive row lock.
      def reload(options = nil)
2580
        clear_aggregation_cache
2581
        clear_association_cache
2582
        _attributes.update(self.class.find(self.id, options).instance_variable_get('@attributes'))
2583
        @attributes_cache = {}
2584
        self
2585 2586
      end

2587
      # Returns the value of the attribute identified by <tt>attr_name</tt> after it has been typecast (for example,
D
Initial  
David Heinemeier Hansson 已提交
2588 2589
      # "2004-12-12" in a data column is cast to a date object, like Date.new(2004, 12, 12)).
      # (Alias for the protected read_attribute method).
2590
      def [](attr_name)
2591
        read_attribute(attr_name)
D
Initial  
David Heinemeier Hansson 已提交
2592
      end
2593

D
Initial  
David Heinemeier Hansson 已提交
2594 2595
      # Updates the attribute identified by <tt>attr_name</tt> with the specified +value+.
      # (Alias for the protected write_attribute method).
2596
      def []=(attr_name, value)
2597
        write_attribute(attr_name, value)
D
Initial  
David Heinemeier Hansson 已提交
2598 2599 2600
      end

      # Allows you to set all the attributes at once by passing in a hash with keys
P
Pratik Naik 已提交
2601 2602 2603 2604 2605 2606
      # matching the attribute names (which again matches the column names).
      #
      # If +guard_protected_attributes+ is true (the default), then sensitive
      # attributes can be protected from this form of mass-assignment by using
      # the +attr_protected+ macro. Or you can alternatively specify which
      # attributes *can* be accessed with the +attr_accessible+ macro. Then all the
2607
      # attributes not included in that won't be allowed to be mass-assigned.
P
Pratik Naik 已提交
2608 2609 2610 2611
      #
      #   class User < ActiveRecord::Base
      #     attr_protected :is_admin
      #   end
E
Emilio Tagua 已提交
2612
      #
P
Pratik Naik 已提交
2613 2614 2615 2616
      #   user = User.new
      #   user.attributes = { :username => 'Phusion', :is_admin => true }
      #   user.username   # => "Phusion"
      #   user.is_admin?  # => false
E
Emilio Tagua 已提交
2617
      #
P
Pratik Naik 已提交
2618 2619
      #   user.send(:attributes=, { :username => 'Phusion', :is_admin => true }, false)
      #   user.is_admin?  # => true
2620
      def attributes=(new_attributes, guard_protected_attributes = true)
D
David Heinemeier Hansson 已提交
2621 2622
        return if new_attributes.nil?
        attributes = new_attributes.dup
2623
        attributes.stringify_keys!
D
Initial  
David Heinemeier Hansson 已提交
2624 2625

        multi_parameter_attributes = []
2626
        attributes = remove_attributes_protected_from_mass_assignment(attributes) if guard_protected_attributes
2627

2628
        attributes.each do |k, v|
2629 2630 2631 2632 2633
          if k.include?("(")
            multi_parameter_attributes << [ k, v ]
          else
            respond_to?(:"#{k}=") ? send(:"#{k}=", v) : raise(UnknownAttributeError, "unknown attribute: #{k}")
          end
D
Initial  
David Heinemeier Hansson 已提交
2634
        end
D
David Heinemeier Hansson 已提交
2635

D
Initial  
David Heinemeier Hansson 已提交
2636 2637 2638
        assign_multiparameter_attributes(multi_parameter_attributes)
      end

2639
      # Returns a hash of all the attributes with their names as keys and the values of the attributes as values.
2640
      def attributes
2641 2642
        self.attribute_names.inject({}) do |attrs, name|
          attrs[name] = read_attribute(name)
2643
          attrs
2644
        end
2645 2646
      end

P
Pratik Naik 已提交
2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659
      # Returns an <tt>#inspect</tt>-like string for the value of the
      # attribute +attr_name+. String attributes are elided after 50
      # characters, and Date and Time attributes are returned in the
      # <tt>:db</tt> format. Other attributes return the value of
      # <tt>#inspect</tt> without modification.
      #
      #   person = Person.create!(:name => "David Heinemeier Hansson " * 3)
      #
      #   person.attribute_for_inspect(:name)
      #   # => '"David Heinemeier Hansson David Heinemeier Hansson D..."'
      #
      #   person.attribute_for_inspect(:created_at)
      #   # => '"2009-01-12 04:48:57"'
2660 2661 2662
      def attribute_for_inspect(attr_name)
        value = read_attribute(attr_name)

2663
        if value.is_a?(String) && value.length > 50
2664
          "#{value[0..50]}...".inspect
2665 2666
        elsif value.is_a?(Date) || value.is_a?(Time)
          %("#{value.to_s(:db)}")
2667 2668 2669 2670 2671
        else
          value.inspect
        end
      end

D
Initial  
David Heinemeier Hansson 已提交
2672
      # Returns true if the specified +attribute+ has been set by the user or by a database load and is neither
2673
      # nil nor empty? (the latter only applies to objects that respond to empty?, most notably Strings).
D
Initial  
David Heinemeier Hansson 已提交
2674
      def attribute_present?(attribute)
2675
        value = read_attribute(attribute)
2676
        !value.blank?
D
Initial  
David Heinemeier Hansson 已提交
2677 2678 2679 2680
      end

      # Returns the column object for the named attribute.
      def column_for_attribute(name)
2681
        self.class.columns_hash[name.to_s]
D
Initial  
David Heinemeier Hansson 已提交
2682
      end
2683

2684
      # Returns true if the +comparison_object+ is the same object, or is of the same type and has the same id.
D
Initial  
David Heinemeier Hansson 已提交
2685
      def ==(comparison_object)
2686
        comparison_object.equal?(self) ||
2687 2688
          (comparison_object.instance_of?(self.class) &&
            comparison_object.id == id &&
2689
            !comparison_object.new_record?)
D
Initial  
David Heinemeier Hansson 已提交
2690 2691 2692 2693 2694 2695
      end

      # Delegates to ==
      def eql?(comparison_object)
        self == (comparison_object)
      end
2696

D
Initial  
David Heinemeier Hansson 已提交
2697 2698 2699
      # Delegates to id in order to allow two records of the same type and id to work with something like:
      #   [ Person.find(1), Person.find(2), Person.find(3) ] & [ Person.find(1), Person.find(4) ] # => [ Person.find(1) ]
      def hash
2700
        id.hash
D
Initial  
David Heinemeier Hansson 已提交
2701 2702
      end

2703
      # Freeze the attributes hash such that associations are still accessible, even on destroyed records.
2704
      def freeze
2705
        @attributes.freeze; self
2706
      end
2707

2708
      # Returns +true+ if the attributes hash has been frozen.
2709 2710 2711
      def frozen?
        @attributes.frozen?
      end
2712

2713 2714 2715 2716 2717 2718 2719
      # Returns duplicated record with unfreezed attributes.
      def dup
        obj = super
        obj.instance_variable_set('@attributes', instance_variable_get('@attributes').dup)
        obj
      end

2720 2721
      # Returns +true+ if the record is read only. Records loaded through joins with piggy-back
      # attributes will be marked as read only since they cannot be saved.
2722
      def readonly?
2723
        defined?(@readonly) && @readonly == true
2724 2725
      end

2726 2727
      # Marks this record as read only.
      def readonly!
2728 2729
        @readonly = true
      end
2730

2731
      # Returns the contents of the record as a nicely formatted string.
2732
      def inspect
2733
        attributes_as_nice_string = self.class.column_names.collect { |name|
2734 2735 2736 2737
          if has_attribute?(name) || new_record?
            "#{name}: #{attribute_for_inspect(name)}"
          end
        }.compact.join(", ")
2738
        "#<#{self.class} #{attributes_as_nice_string}>"
2739
      end
2740

2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755
    protected
      def clone_attributes(reader_method = :read_attribute, attributes = {})
        self.attribute_names.inject(attributes) do |attrs, name|
          attrs[name] = clone_attribute_value(reader_method, name)
          attrs
        end
      end

      def clone_attribute_value(reader_method, attribute_name)
        value = send(reader_method, attribute_name)
        value.duplicable? ? value.clone : value
      rescue TypeError, NoMethodError
        value
      end

D
Initial  
David Heinemeier Hansson 已提交
2756 2757
    private
      def create_or_update
2758
        raise ReadOnlyRecord if readonly?
2759 2760
        result = new_record? ? create : update
        result != false
D
Initial  
David Heinemeier Hansson 已提交
2761 2762
      end

2763
      # Updates the associated record with values matching those of the instance attributes.
2764
      # Returns the number of affected rows.
2765
      def update(attribute_names = @attributes.keys)
2766 2767
        attributes_with_values = arel_attributes_values(false, false, attribute_names)
        return 0 if attributes_with_values.empty?
2768
        self.class.arel_table.where(self.class.arel_table[self.class.primary_key].eq(id)).update(attributes_with_values)
D
Initial  
David Heinemeier Hansson 已提交
2769 2770
      end

2771 2772
      # Creates a record with values matching those of the instance attributes
      # and returns its id.
D
Initial  
David Heinemeier Hansson 已提交
2773
      def create
2774
        if self.id.nil? && connection.prefetch_primary_key?(self.class.table_name)
2775 2776
          self.id = connection.next_sequence_value(self.class.sequence_name)
        end
2777

E
Emilio Tagua 已提交
2778 2779 2780
        attributes_values = arel_attributes_values

        new_id = if attributes_values.empty?
2781
          self.class.arel_table.insert connection.empty_insert_statement_value
2782
        else
2783
          self.class.arel_table.insert attributes_values
2784 2785
        end

2786
        self.id ||= new_id
2787

D
Initial  
David Heinemeier Hansson 已提交
2788
        @new_record = false
2789
        id
D
Initial  
David Heinemeier Hansson 已提交
2790 2791
      end

P
Pratik Naik 已提交
2792
      # Sets the attribute used for single table inheritance to this class name if this is not the ActiveRecord::Base descendant.
P
Pratik Naik 已提交
2793 2794
      # Considering the hierarchy Reply < Message < ActiveRecord::Base, this makes it possible to do Reply.new without having to
      # set <tt>Reply[Reply.inheritance_column] = "Reply"</tt> yourself. No such attribute would be set for objects of the
D
Initial  
David Heinemeier Hansson 已提交
2795 2796 2797
      # Message class in that example.
      def ensure_proper_type
        unless self.class.descends_from_active_record?
2798
          write_attribute(self.class.inheritance_column, self.class.sti_name)
D
Initial  
David Heinemeier Hansson 已提交
2799 2800 2801 2802
        end
      end

      def remove_attributes_protected_from_mass_assignment(attributes)
2803 2804 2805 2806
        safe_attributes =
          if self.class.accessible_attributes.nil? && self.class.protected_attributes.nil?
            attributes.reject { |key, value| attributes_protected_by_default.include?(key.gsub(/\(.+/, "")) }
          elsif self.class.protected_attributes.nil?
2807
            attributes.reject { |key, value| !self.class.accessible_attributes.include?(key.gsub(/\(.+/, "")) || attributes_protected_by_default.include?(key.gsub(/\(.+/, "")) }
2808
          elsif self.class.accessible_attributes.nil?
2809
            attributes.reject { |key, value| self.class.protected_attributes.include?(key.gsub(/\(.+/,"")) || attributes_protected_by_default.include?(key.gsub(/\(.+/, "")) }
2810 2811 2812 2813 2814 2815 2816
          else
            raise "Declare either attr_protected or attr_accessible for #{self.class}, but not both."
          end

        removed_attributes = attributes.keys - safe_attributes.keys

        if removed_attributes.any?
2817
          log_protected_attribute_removal(removed_attributes)
D
Initial  
David Heinemeier Hansson 已提交
2818
        end
2819 2820

        safe_attributes
D
Initial  
David Heinemeier Hansson 已提交
2821
      end
2822

2823 2824 2825
      # Removes attributes which have been marked as readonly.
      def remove_readonly_attributes(attributes)
        unless self.class.readonly_attributes.nil?
2826
          attributes.delete_if { |key, value| self.class.readonly_attributes.include?(key.gsub(/\(.+/,"")) }
2827 2828 2829 2830
        else
          attributes
        end
      end
D
Initial  
David Heinemeier Hansson 已提交
2831

2832
      def log_protected_attribute_removal(*attributes)
2833 2834 2835
        if logger
          logger.debug "WARNING: Can't mass-assign these protected attributes: #{attributes.join(', ')}"
        end
2836 2837
      end

2838 2839
      # The primary key and inheritance column can never be set by mass-assignment for security reasons.
      def attributes_protected_by_default
2840 2841 2842
        default = [ self.class.primary_key, self.class.inheritance_column ]
        default << 'id' unless self.class.primary_key.eql? 'id'
        default
2843 2844
      end

2845
      # Returns a copy of the attributes hash where all the values have been safely quoted for use in
2846
      # an SQL statement.
2847
      def attributes_with_quotes(include_primary_key = true, include_readonly_attributes = true, attribute_names = @attributes.keys)
2848
        quoted = {}
2849
        connection = self.class.connection
2850
        attribute_names.each do |name|
2851 2852 2853 2854 2855 2856 2857 2858 2859
          if (column = column_for_attribute(name)) && (include_primary_key || !column.primary)
            value = read_attribute(name)

            # We need explicit to_yaml because quote() does not properly convert Time/Date fields to YAML.
            if value && self.class.serialized_attributes.has_key?(name) && (value.acts_like?(:date) || value.acts_like?(:time))
              value = value.to_yaml
            end

            quoted[name] = connection.quote(value, column)
2860
          end
D
Initial  
David Heinemeier Hansson 已提交
2861
        end
2862
        include_readonly_attributes ? quoted : remove_readonly_attributes(quoted)
D
Initial  
David Heinemeier Hansson 已提交
2863
      end
2864

2865 2866
      # Returns a copy of the attributes hash where all the values have been safely quoted for use in
      # an Arel insert/update method.
2867 2868 2869 2870 2871 2872
      def arel_attributes_values(include_primary_key = true, include_readonly_attributes = true, attribute_names = @attributes.keys)
        attrs = {}
        attribute_names.each do |name|
          if (column = column_for_attribute(name)) && (include_primary_key || !column.primary)

            if include_readonly_attributes || (!include_readonly_attributes && !self.class.readonly_attributes.include?(name))
2873 2874 2875
              value = read_attribute(name)

              if value && ((self.class.serialized_attributes.has_key?(name) && (value.acts_like?(:date) || value.acts_like?(:time))) || value.is_a?(Hash) || value.is_a?(Array))
2876 2877
                value = value.to_yaml
              end
2878
              attrs[self.class.arel_table[name]] = value
2879 2880 2881 2882 2883 2884
            end
          end
        end
        attrs
      end

D
Initial  
David Heinemeier Hansson 已提交
2885
      # Quote strings appropriately for SQL statements.
2886
      def quote_value(value, column = nil)
2887
        self.class.connection.quote(value, column)
D
Initial  
David Heinemeier Hansson 已提交
2888 2889
      end

P
Pratik Naik 已提交
2890
      # Interpolate custom SQL string in instance context.
D
Initial  
David Heinemeier Hansson 已提交
2891 2892
      # Optional record argument is meant for custom insert_sql.
      def interpolate_sql(sql, record = nil)
2893
        instance_eval("%@#{sql.gsub('@', '\@')}@")
D
Initial  
David Heinemeier Hansson 已提交
2894 2895 2896 2897 2898 2899 2900
      end

      # Initializes the attributes array with keys matching the columns from the linked table and
      # the values matching the corresponding default value of that column, so
      # that a new instance, or one populated from a passed-in Hash, still has all the attributes
      # that instances loaded from the database would.
      def attributes_from_column_definition
2901
        self.class.columns.inject({}) do |attributes, column|
2902
          attributes[column.name] = column.default unless column.name == self.class.primary_key
D
Initial  
David Heinemeier Hansson 已提交
2903 2904 2905 2906 2907 2908 2909 2910
          attributes
        end
      end

      # Instantiates objects for all attribute classes that needs more than one constructor parameter. This is done
      # by calling new on the column type or aggregation type (through composed_of) object with these parameters.
      # So having the pairs written_on(1) = "2004", written_on(2) = "6", written_on(3) = "24", will instantiate
      # written_on (a date type) with Date.new("2004", "6", "24"). You can also specify a typecast character in the
2911
      # parentheses to have the parameters typecasted before they're used in the constructor. Use i for Fixnum, f for Float,
2912
      # s for String, and a for Array. If all the values for a given attribute are empty, the attribute will be set to nil.
D
Initial  
David Heinemeier Hansson 已提交
2913 2914 2915 2916 2917
      def assign_multiparameter_attributes(pairs)
        execute_callstack_for_multiparameter_attributes(
          extract_callstack_for_multiparameter_attributes(pairs)
        )
      end
2918

2919
      def instantiate_time_object(name, values)
2920
        if self.class.send(:time_zone_aware?, name)
2921
          Time.zone.local(*values)
2922
        else
2923
          Time.time_with_datetime_fallback(@@default_timezone, *values)
2924
        end
2925 2926
      end

D
Initial  
David Heinemeier Hansson 已提交
2927
      def execute_callstack_for_multiparameter_attributes(callstack)
2928
        errors = []
2929
        callstack.each do |name, values_with_empty_parameters|
2930 2931
          begin
            klass = (self.class.reflect_on_aggregation(name.to_sym) || column_for_attribute(name)).klass
2932 2933 2934 2935
            # in order to allow a date to be set without a year, we must keep the empty values.
            # Otherwise, we wouldn't be able to distinguish it from a date with an empty day.
            values = values_with_empty_parameters.reject(&:nil?)

2936 2937 2938
            if values.empty?
              send(name + "=", nil)
            else
2939

2940
              value = if Time == klass
2941
                instantiate_time_object(name, values)
2942 2943
              elsif Date == klass
                begin
2944
                  values = values_with_empty_parameters.collect do |v| v.nil? ? 1 : v end
2945 2946
                  Date.new(*values)
                rescue ArgumentError => ex # if Date.new raises an exception on an invalid date
2947
                  instantiate_time_object(name, values).to_date # we instantiate Time object and convert it back to a date thus using Time's logic in handling invalid dates
2948 2949 2950 2951 2952 2953
                end
              else
                klass.new(*values)
              end

              send(name + "=", value)
2954
            end
2955 2956
          rescue => ex
            errors << AttributeAssignmentError.new("error on assignment #{values.inspect} to #{name}", ex, name)
D
Initial  
David Heinemeier Hansson 已提交
2957 2958
          end
        end
2959 2960 2961
        unless errors.empty?
          raise MultiparameterAssignmentErrors.new(errors), "#{errors.size} error(s) on assignment of multiparameter attributes"
        end
D
Initial  
David Heinemeier Hansson 已提交
2962
      end
2963

D
Initial  
David Heinemeier Hansson 已提交
2964 2965 2966 2967 2968 2969 2970 2971
      def extract_callstack_for_multiparameter_attributes(pairs)
        attributes = { }

        for pair in pairs
          multiparameter_name, value = pair
          attribute_name = multiparameter_name.split("(").first
          attributes[attribute_name] = [] unless attributes.include?(attribute_name)

2972 2973
          parameter_value = value.empty? ? nil : type_cast_attribute_value(multiparameter_name, value)
          attributes[attribute_name] << [ find_parameter_position(multiparameter_name), parameter_value ]
D
Initial  
David Heinemeier Hansson 已提交
2974 2975 2976 2977
        end

        attributes.each { |name, values| attributes[name] = values.sort_by{ |v| v.first }.collect { |v| v.last } }
      end
2978

D
Initial  
David Heinemeier Hansson 已提交
2979
      def type_cast_attribute_value(multiparameter_name, value)
2980
        multiparameter_name =~ /\([0-9]*([if])\)/ ? value.send("to_" + $1) : value
D
Initial  
David Heinemeier Hansson 已提交
2981
      end
2982

D
Initial  
David Heinemeier Hansson 已提交
2983 2984 2985
      def find_parameter_position(multiparameter_name)
        multiparameter_name.scan(/\(([0-9]*).*\)/).first.first
      end
2986

D
Initial  
David Heinemeier Hansson 已提交
2987 2988 2989 2990 2991
      # Returns a comma-separated pair list, like "key1 = val1, key2 = val2".
      def comma_pair_list(hash)
        hash.inject([]) { |list, pair| list << "#{pair.first} = #{pair.last}" }.join(", ")
      end

2992 2993 2994 2995
      def self.quoted_table_name
        self.connection.quote_table_name(self.table_name)
      end

2996 2997 2998 2999
      def quote_columns(quoter, hash)
        hash.inject({}) do |quoted, (name, value)|
          quoted[quoter.quote_column_name(name)] = value
          quoted
3000
        end
D
Initial  
David Heinemeier Hansson 已提交
3001 3002
      end

3003 3004
      def quoted_comma_pair_list(quoter, hash)
        comma_pair_list(quote_columns(quoter, hash))
D
Initial  
David Heinemeier Hansson 已提交
3005 3006 3007
      end

  end
J
Joshua Peek 已提交
3008 3009

  Base.class_eval do
J
Joshua Peek 已提交
3010
    extend ActiveModel::Naming
J
Joshua Peek 已提交
3011
    extend QueryCache::ClassMethods
J
José Valim 已提交
3012 3013
    extend ActiveSupport::Benchmarkable

J
Joshua Peek 已提交
3014 3015 3016
    include Validations
    include Locking::Optimistic, Locking::Pessimistic
    include AttributeMethods
J
Joshua Peek 已提交
3017
    include AttributeMethods::Read, AttributeMethods::Write, AttributeMethods::BeforeTypeCast, AttributeMethods::Query
3018
    include AttributeMethods::PrimaryKey
J
Joshua Peek 已提交
3019 3020
    include AttributeMethods::TimeZoneConversion
    include AttributeMethods::Dirty
3021
    include Attributes, Types
3022
    include Callbacks, ActiveModel::Observing, Timestamp
J
Joshua Peek 已提交
3023
    include Associations, AssociationPreload, NamedScope
J
Joshua Peek 已提交
3024
    include ActiveModel::Conversion
3025 3026 3027 3028 3029

    # AutosaveAssociation needs to be included before Transactions, because we want
    # #save_with_autosave_associations to be wrapped inside a transaction.
    include AutosaveAssociation, NestedAttributes

3030
    include Aggregations, Transactions, Reflection, Batches, Calculations, Serialization
3031

J
Joshua Peek 已提交
3032
  end
3033
end
3034 3035 3036

# TODO: Remove this and make it work with LAZY flag
require 'active_record/connection_adapters/abstract_adapter'