base.rb 126.2 KB
Newer Older
D
Initial  
David Heinemeier Hansson 已提交
1
require 'yaml'
2
require 'set'
J
José Valim 已提交
3
require 'active_support/benchmarkable'
J
Jeremy Kemper 已提交
4
require 'active_support/dependencies'
5
require 'active_support/time'
J
Jeremy Kemper 已提交
6 7 8 9 10 11 12 13
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'
14
require 'active_support/core_ext/object/metaclass'
15
require 'active_support/core_ext/module/delegation'
D
Initial  
David Heinemeier Hansson 已提交
16 17

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

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

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

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

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

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

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

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

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

  # 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 已提交
69
  end
70

71 72 73 74
  # Raised when SQL statement is invalid and the application gets a blank result.
  class ThrowResult < ActiveRecordError
  end

75 76 77 78 79 80 81 82 83 84 85
  # 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

86
  # Raised when a record cannot be inserted because it would violate a uniqueness constraint.
87
  class RecordNotUnique < WrappedDatabaseException
88 89
  end

90
  # Raised when a record cannot be inserted or updated because it references a non-existent record.
91
  class InvalidForeignKey < WrappedDatabaseException
92 93
  end

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

  # 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 已提交
109
  # Read more about optimistic locking in ActiveRecord::Locking module RDoc.
110
  class StaleObjectError < ActiveRecordError
111
  end
112 113 114 115

  # 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
116
  end
117 118 119

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

P
Pratik Naik 已提交
122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148
  # 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
149
  class Rollback < ActiveRecordError
150
  end
151

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

156 157 158 159
  # Raised when unknown attributes are supplied via mass assignment.
  class UnknownAttributeError < NoMethodError
  end

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

P
Pratik Naik 已提交
172 173 174 175
  # 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
176 177 178 179 180
    attr_reader :errors
    def initialize(errors)
      @errors = errors
    end
  end
181

182
  # Active Record objects don't specify their attributes directly, but rather infer them from the table definition with
D
Initial  
David Heinemeier Hansson 已提交
183 184
  # 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
185 186
  # database table will happen automatically in most common cases, but can be overwritten for the uncommon ones.
  #
D
Initial  
David Heinemeier Hansson 已提交
187
  # See the mapping rules in table_name and the full example in link:files/README.html for more insight.
188
  #
D
Initial  
David Heinemeier Hansson 已提交
189
  # == Creation
190
  #
191
  # Active Records accept constructor parameters either in a hash or as a block. The hash method is especially useful when
192
  # you're receiving the data from somewhere else, like an HTTP request. It works like this:
193
  #
194
  #   user = User.new(:name => "David", :occupation => "Code Artist")
D
Initial  
David Heinemeier Hansson 已提交
195
  #   user.name # => "David"
196
  #
D
Initial  
David Heinemeier Hansson 已提交
197
  # You can also use block initialization:
198
  #
D
Initial  
David Heinemeier Hansson 已提交
199 200 201 202
  #   user = User.new do |u|
  #     u.name = "David"
  #     u.occupation = "Code Artist"
  #   end
203
  #
D
Initial  
David Heinemeier Hansson 已提交
204
  # And of course you can just create a bare object and specify the attributes after the fact:
205
  #
D
Initial  
David Heinemeier Hansson 已提交
206 207 208
  #   user = User.new
  #   user.name = "David"
  #   user.occupation = "Code Artist"
209
  #
D
Initial  
David Heinemeier Hansson 已提交
210
  # == Conditions
211
  #
212
  # Conditions can either be specified as a string, array, or hash representing the WHERE-part of an SQL statement.
D
Initial  
David Heinemeier Hansson 已提交
213
  # The array form is to be used when the condition input is tainted and requires sanitization. The string form can
214
  # be used for statements that don't involve tainted data. The hash form works much like the array form, except
215
  # only equality and range is possible. Examples:
216
  #
217
  #   class User < ActiveRecord::Base
D
Initial  
David Heinemeier Hansson 已提交
218
  #     def self.authenticate_unsafely(user_name, password)
219
  #       find(:first, :conditions => "user_name = '#{user_name}' AND password = '#{password}'")
D
Initial  
David Heinemeier Hansson 已提交
220
  #     end
221
  #
D
Initial  
David Heinemeier Hansson 已提交
222
  #     def self.authenticate_safely(user_name, password)
223
  #       find(:first, :conditions => [ "user_name = ? AND password = ?", user_name, password ])
D
Initial  
David Heinemeier Hansson 已提交
224
  #     end
225 226 227 228
  #
  #     def self.authenticate_safely_simply(user_name, password)
  #       find(:first, :conditions => { :user_name => user_name, :password => password })
  #     end
D
Initial  
David Heinemeier Hansson 已提交
229
  #   end
230
  #
231
  # The <tt>authenticate_unsafely</tt> method inserts the parameters directly into the query and is thus susceptible to SQL-injection
232
  # attacks if the <tt>user_name</tt> and +password+ parameters come directly from an HTTP request. The <tt>authenticate_safely</tt>  and
233
  # <tt>authenticate_safely_simply</tt> both will sanitize the <tt>user_name</tt> and +password+ before inserting them in the query,
234
  # which will ensure that an attacker can't escape the query and fake the login (or worse).
235
  #
236
  # When using multiple parameters in the conditions, it can easily become hard to read exactly what the fourth or fifth
237
  # question mark is supposed to represent. In those cases, you can resort to named bind variables instead. That's done by replacing
238 239
  # the question marks with symbols and supplying a hash with values for the matching symbol keys:
  #
240
  #   Company.find(:first, :conditions => [
241
  #     "id = :id AND name = :name AND division = :division AND created_at > :accounting_date",
242 243 244
  #     { :id => 3, :name => "37signals", :division => "First", :accounting_date => '2005-01-01' }
  #   ])
  #
245 246 247 248 249 250
  # 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])
  #
251 252 253
  # A range may be used in the hash to use the SQL BETWEEN operator:
  #
  #   Student.find(:all, :conditions => { :grade => 9..12 })
254
  #
P
Pratik Naik 已提交
255 256 257 258
  # 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 已提交
259 260 261 262 263 264
  # 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 已提交
265
  # == Overwriting default accessors
266
  #
267 268
  # 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 已提交
269
  # 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 已提交
270
  # Example:
271
  #
D
Initial  
David Heinemeier Hansson 已提交
272 273
  #   class Song < ActiveRecord::Base
  #     # Uses an integer of seconds to hold the length of the song
274
  #
D
Initial  
David Heinemeier Hansson 已提交
275
  #     def length=(minutes)
276
  #       write_attribute(:length, minutes.to_i * 60)
D
Initial  
David Heinemeier Hansson 已提交
277
  #     end
278
  #
D
Initial  
David Heinemeier Hansson 已提交
279
  #     def length
280
  #       read_attribute(:length) / 60
D
Initial  
David Heinemeier Hansson 已提交
281 282
  #     end
  #   end
283
  #
P
Pratik Naik 已提交
284 285
  # 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.
286
  #
287 288 289 290
  # == 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.
291
  #
292 293 294 295 296 297 298 299 300
  # 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
  #
301
  # == Accessing attributes before they have been typecasted
302
  #
303
  # 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 已提交
304
  # 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 已提交
305
  # has a <tt>balance</tt> attribute, you can call <tt>account.balance_before_type_cast</tt> or <tt>account.id_before_type_cast</tt>.
306 307
  #
  # This is especially useful in validation situations where the user might supply a string for an integer field and you want to display
308
  # the original string back in an error message. Accessing the attribute normally would typecast the string to 0, which isn't what you
309 310
  # want.
  #
311 312
  # == Dynamic attribute-based finders
  #
313
  # 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 已提交
314
  # 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 已提交
315
  # <tt>Person.find_all_by_last_name</tt>, and <tt>Payment.find_by_transaction_id</tt>. So instead of writing
316 317
  # <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>.
318
  #
319 320
  # 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
321
  # <tt>Person.find(:first, :conditions => ["user_name = ? AND password = ?", user_name, password])</tt>, you just do
322
  # <tt>Person.find_by_user_name_and_password(user_name, password)</tt>.
323
  #
P
Pratik Naik 已提交
324 325
  # 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
326
  # 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>.
327
  # Also you may call <tt>Payment.find_last_by_amount(amount, options)</tt> returning the last record matching that amount and options.
328
  #
329
  # The same dynamic finder style can be used to create the object if it doesn't already exist. This dynamic finder is called with
330
  # <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:
331 332 333
  #
  #   # No 'Summer' tag exists
  #   Tag.find_or_create_by_name("Summer") # equal to Tag.create(:name => "Summer")
334
  #
335 336 337
  #   # Now the 'Summer' tag does exist
  #   Tag.find_or_create_by_name("Summer") # equal to Tag.find_by_name("Summer")
  #
338 339 340
  #   # Now 'Bob' exist and is an 'admin'
  #   User.find_or_create_by_name('Bob', :age => 40) { |u| u.admin = true }
  #
P
Pratik Naik 已提交
341
  # 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:
342 343 344
  #
  #   # No 'Winter' tag exists
  #   winter = Tag.find_or_initialize_by_name("Winter")
345
  #   winter.new_record? # true
346
  #
347 348 349 350 351 352 353
  # 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.
  #
354
  # == Saving arrays, hashes, and other non-mappable objects in text columns
355 356
  #
  # 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+.
357
  # This makes it possible to store arrays, hashes, and other non-mappable objects without doing any additional work. Example:
358
  #
D
Initial  
David Heinemeier Hansson 已提交
359 360 361
  #   class User < ActiveRecord::Base
  #     serialize :preferences
  #   end
362
  #
363
  #   user = User.create(:preferences => { "background" => "black", "display" => large })
D
Initial  
David Heinemeier Hansson 已提交
364
  #   User.find(user.id).preferences # => { "background" => "black", "display" => large }
365
  #
366
  # 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 已提交
367
  # descendant of a class not in the hierarchy. Example:
368
  #
D
Initial  
David Heinemeier Hansson 已提交
369
  #   class User < ActiveRecord::Base
370
  #     serialize :preferences, Hash
D
Initial  
David Heinemeier Hansson 已提交
371
  #   end
372
  #
373
  #   user = User.create(:preferences => %w( one two three ))
D
Initial  
David Heinemeier Hansson 已提交
374
  #   User.find(user.id).preferences    # raises SerializationTypeMismatch
375
  #
D
Initial  
David Heinemeier Hansson 已提交
376 377
  # == Single table inheritance
  #
378
  # 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 已提交
379 380 381 382 383 384 385
  # 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 已提交
386 387
  # 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 已提交
388
  #
389 390 391
  # 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 已提交
392 393
  # Note, all the attributes for all the cases are kept in the same table. Read more:
  # http://www.martinfowler.com/eaaCatalog/singleTableInheritance.html
394
  #
D
Initial  
David Heinemeier Hansson 已提交
395 396 397
  # == Connection to multiple databases in different models
  #
  # Connections are usually created through ActiveRecord::Base.establish_connection and retrieved by ActiveRecord::Base.connection.
398
  # All classes inheriting from ActiveRecord::Base will use this connection. But you can also set a class-specific connection.
P
Pratik Naik 已提交
399 400
  # 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 已提交
401 402 403 404 405
  #
  # 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
406
  #
P
Pratik Naik 已提交
407 408
  # * 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 已提交
409
  #   <tt>:adapter</tt> key.
P
Pratik Naik 已提交
410
  # * AdapterNotFound - The <tt>:adapter</tt> key used in <tt>establish_connection</tt> specified a non-existent adapter
411
  #   (or a bad spelling of an existing one).
P
Pratik Naik 已提交
412 413 414 415 416 417 418 419 420
  # * 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
421
  #   objects that should be inspected to determine which attributes triggered the errors.
P
Pratik Naik 已提交
422
  # * AttributeAssignmentError - An error occurred while doing a mass assignment through the <tt>attributes=</tt> method.
423
  #   You can inspect the +attribute+ property of the exception object to determine which attribute triggered the error.
424
  #
425
  # *Note*: The attributes listed are class-level attributes (accessible from both the class and instance level).
P
Pratik Naik 已提交
426
  # 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 已提交
427 428
  # instances in the current object space.
  class Base
E
Emilio Tagua 已提交
429
    ##
P
Pratik Naik 已提交
430
    # :singleton-method:
D
Initial  
David Heinemeier Hansson 已提交
431 432
    # 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+.
433
    cattr_accessor :logger, :instance_writer => false
J
Jeremy Kemper 已提交
434

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

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

D
Initial  
David Heinemeier Hansson 已提交
455
    @@subclasses = {}
456

P
Pratik Naik 已提交
457 458
    ##
    # :singleton-method:
P
Pratik Naik 已提交
459 460 461 462
    # Contains the database configuration - as is typically stored in config/database.yml -
    # as a Hash.
    #
    # For example, the following database.yml...
E
Emilio Tagua 已提交
463
    #
P
Pratik Naik 已提交
464 465 466
    #   development:
    #     adapter: sqlite3
    #     database: db/development.sqlite3
E
Emilio Tagua 已提交
467
    #
P
Pratik Naik 已提交
468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483
    #   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'
    #      }
    #   }
484
    cattr_accessor :configurations, :instance_writer => false
485 486
    @@configurations = {}

P
Pratik Naik 已提交
487 488
    ##
    # :singleton-method:
489
    # 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 已提交
490 491
    # :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
492
    # that this is a global setting for all Active Records.
493
    cattr_accessor :primary_key_prefix_type, :instance_writer => false
D
Initial  
David Heinemeier Hansson 已提交
494 495
    @@primary_key_prefix_type = nil

P
Pratik Naik 已提交
496 497
    ##
    # :singleton-method:
498
    # Accessor for the name of the prefix string to prepend to every table name. So if set to "basecamp_", all
499
    # 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 已提交
500
    # for tables in a shared database. By default, the prefix is the empty string.
501
    cattr_accessor :table_name_prefix, :instance_writer => false
D
Initial  
David Heinemeier Hansson 已提交
502 503
    @@table_name_prefix = ""

P
Pratik Naik 已提交
504 505
    ##
    # :singleton-method:
D
Initial  
David Heinemeier Hansson 已提交
506 507
    # 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.
508
    cattr_accessor :table_name_suffix, :instance_writer => false
D
Initial  
David Heinemeier Hansson 已提交
509 510
    @@table_name_suffix = ""

P
Pratik Naik 已提交
511 512
    ##
    # :singleton-method:
513
    # Indicates whether table names should be the pluralized versions of the corresponding class names.
P
Pratik Naik 已提交
514
    # 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 已提交
515
    # See table_name for the full rules on table/class naming. This is true, by default.
516
    cattr_accessor :pluralize_table_names, :instance_writer => false
D
Initial  
David Heinemeier Hansson 已提交
517 518
    @@pluralize_table_names = true

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

P
Pratik Naik 已提交
527 528
    ##
    # :singleton-method:
529 530
    # 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.
531
    cattr_accessor :default_timezone, :instance_writer => false
532
    @@default_timezone = :local
533

P
Pratik Naik 已提交
534 535
    ##
    # :singleton-method:
536 537
    # Specifies the format to use when dumping the database schema with Rails'
    # Rakefile.  If :sql, the schema is dumped as (potentially database-
538
    # specific) SQL statements.  If :ruby, the schema is dumped as an
539 540 541
    # 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.
542
    cattr_accessor :schema_format , :instance_writer => false
543
    @@schema_format = :ruby
544

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

551 552 553
    # 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
554

555 556 557 558
    # Stores the default scope for the class
    class_inheritable_accessor :default_scoping, :instance_writer => false
    self.default_scoping = []

D
Initial  
David Heinemeier Hansson 已提交
559
    class << self # Class methods
560
      # Find operates with four different retrieval approaches:
561
      #
P
Pratik Naik 已提交
562
      # * 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]).
563
      #   If no record can be found for all of the listed ids, then RecordNotFound will be raised.
P
Pratik Naik 已提交
564 565 566 567 568 569 570 571 572 573 574 575
      # * 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 已提交
576
      # ==== Parameters
P
Pratik Naik 已提交
577
      #
P
Pratik Naik 已提交
578
      # * <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 已提交
579 580
      # * <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.
581
      # * <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 已提交
582 583
      # * <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 已提交
584 585 586
      # * <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.
587
      #   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.
588
      #   Pass <tt>:readonly => false</tt> to override.
P
Pratik Naik 已提交
589
      # * <tt>:include</tt> - Names associations that should be loaded alongside. The symbols named refer
590
      #   to already defined associations. See eager loading under Associations.
P
Pratik Naik 已提交
591
      # * <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 已提交
592
      #   include the joined columns. Takes a string with the SELECT SQL fragment (e.g. "id, name").
P
Pratik Naik 已提交
593
      # * <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
594
      #   of a database view).
P
Pratik Naik 已提交
595 596
      # * <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".
597
      #   <tt>:lock => true</tt> gives connection's default exclusive lock, usually "FOR UPDATE".
598
      #
P
Pratik Naik 已提交
599 600 601
      # ==== Examples
      #
      #   # find by id
D
Initial  
David Heinemeier Hansson 已提交
602 603 604
      #   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)
605
      #   Person.find([1])     # returns an array for the object with ID = 1
606 607
      #   Person.find(1, :conditions => "administrator = 1", :order => "created_on DESC")
      #
608
      # Note that returned records may not be in the same order as the ids you
609
      # provide since database rows are unordered. Give an explicit <tt>:order</tt>
610 611
      # to ensure the results are sorted.
      #
P
Pratik Naik 已提交
612 613 614
      # ==== Examples
      #
      #   # find first
615
      #   Person.find(:first) # returns the first object fetched by SELECT * FROM people
616
      #   Person.find(:first, :conditions => [ "user_name = ?", user_name])
P
Pratik Naik 已提交
617
      #   Person.find(:first, :conditions => [ "user_name = :u", { :u => user_name }])
618 619
      #   Person.find(:first, :order => "created_on DESC", :offset => 5)
      #
P
Pratik Naik 已提交
620
      #   # find last
621 622 623 624
      #   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 已提交
625
      #   # find all
626
      #   Person.find(:all) # returns an array of objects for all the rows fetched by SELECT * FROM people
627
      #   Person.find(:all, :conditions => [ "category IN (?)", categories], :limit => 50)
P
Pratik Naik 已提交
628
      #   Person.find(:all, :conditions => { :friends => ["Bob", "Steve", "Fred"] }
629 630
      #   Person.find(:all, :offset => 10, :limit => 10)
      #   Person.find(:all, :include => [ :account, :friends ])
631
      #   Person.find(:all, :group => "category")
632
      #
P
Pratik Naik 已提交
633 634 635
      # 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
636
      # transaction has to wait until the first is finished; we get the
P
Pratik Naik 已提交
637 638
      # expected <tt>person.visits == 4</tt>.
      #
639 640 641 642 643
      #   Person.transaction do
      #     person = Person.find(1, :lock => true)
      #     person.visits += 1
      #     person.save!
      #   end
644
      def find(*args)
645
        options = args.extract_options!
646
        set_readonly_option!(options)
647

648
        relation = construct_finder_arel(options)
P
Pratik Naik 已提交
649

650
        case args.first
P
Pratik Naik 已提交
651 652
        when :first, :last, :all
          relation.send(args.first)
P
Pratik Naik 已提交
653
        else
P
Pratik Naik 已提交
654
          relation.find(*args)
D
Initial  
David Heinemeier Hansson 已提交
655 656
        end
      end
657

P
Pratik Naik 已提交
658
      delegate :select, :group, :order, :limit, :joins, :where, :preload, :eager_load, :from, :lock, :readonly, :having, :to => :scoped
659

P
Pratik Naik 已提交
660 661
      # 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>.
662 663 664
      def first(*args)
        find(:first, *args)
      end
665

P
Pratik Naik 已提交
666 667
      # 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>.
668 669 670
      def last(*args)
        find(:last, *args)
      end
671

672 673
      # A convenience wrapper for <tt>find(:all, *args)</tt>. You can pass in all the
      # same arguments to this method as you can to <tt>find(:all)</tt>.
674
      def all(*args)
675
        find(:all, *args)
676
      end
677

P
Pratik Naik 已提交
678
      # Executes a custom SQL query against your database and returns all the results.  The results will
679
      # be returned as an array with columns requested encapsulated as attributes of the model you call
P
Pratik Naik 已提交
680 681
      # 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.
682
      #
683 684
      # 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
685 686
      # table.
      #
P
Pratik Naik 已提交
687
      # The +sql+ parameter is a full SQL query as a string.  It will be called as is, there will be
688 689
      # 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 已提交
690
      # change your call if you switch engines.
691 692
      #
      # ==== Examples
P
Pratik Naik 已提交
693
      #   # A simple SQL query spanning multiple tables
694 695 696 697 698 699
      #   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 已提交
700
      def find_by_sql(sql)
701
        connection.select_all(sanitize_sql(sql), "#{name} Load").collect! { |record| instantiate(record) }
D
Initial  
David Heinemeier Hansson 已提交
702
      end
703

P
Pratik Naik 已提交
704
      # Returns true if a record exists in the table that matches the +id+ or
705
      # conditions given, or false otherwise. The argument can take five forms:
P
Pratik Naik 已提交
706 707 708 709 710 711 712 713
      #
      # * 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>).
714
      # * No args - Returns false if the table is empty, true otherwise.
715
      #
P
Pratik Naik 已提交
716 717
      # For more information about specifying conditions as a Hash or Array,
      # see the Conditions section in the introduction to ActiveRecord::Base.
718
      #
P
Pratik Naik 已提交
719 720 721
      # 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>.
722 723
      #
      # ==== Examples
724
      #   Person.exists?(5)
725
      #   Person.exists?('5')
726
      #   Person.exists?(:name => "David")
727
      #   Person.exists?(['name LIKE ?', "%#{query}%"])
728
      #   Person.exists?
729 730 731 732 733 734 735
      def exists?(id_or_conditions = nil)
        case id_or_conditions
        when Array, Hash
          where(id_or_conditions).exists?
        else
          scoped.exists?(id_or_conditions)
        end
D
Initial  
David Heinemeier Hansson 已提交
736
      end
737

738
      # Creates an object (or multiple objects) and saves it to the database, if validations pass.
739 740 741 742 743 744 745 746
      # 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')
747
      #
748
      #   # Create an Array of new objects
P
Pratik Naik 已提交
749
      #   User.create([{ :first_name => 'Jamie' }, { :first_name => 'Jeremy' }])
750 751 752 753 754 755 756
      #
      #   # 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 已提交
757
      #   User.create([{ :first_name => 'Jamie' }, { :first_name => 'Jeremy' }]) do |u|
758
      #     u.is_admin = false
759
      #   end
760
      def create(attributes = nil, &block)
761
        if attributes.is_a?(Array)
762
          attributes.collect { |attr| create(attr, &block) }
763 764
        else
          object = new(attributes)
765
          yield(object) if block_given?
766 767 768
          object.save
          object
        end
D
Initial  
David Heinemeier Hansson 已提交
769 770
      end

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

P
Pratik Naik 已提交
798 799 800 801 802
      # 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.
803
      #
P
Pratik Naik 已提交
804
      # You can delete multiple rows at once by passing an Array of <tt>id</tt>s.
805
      #
P
Pratik Naik 已提交
806 807 808 809
      # 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.
810 811 812
      #
      # ==== Examples
      #
P
Pratik Naik 已提交
813
      #   # Delete a single row
814
      #   Todo.delete(1)
815
      #
P
Pratik Naik 已提交
816 817
      #   # Delete multiple rows
      #   Todo.delete([2,3,4])
818
      def delete(id_or_array)
819
        active_relation.where(construct_conditions(nil, scope(:find))).delete(id_or_array)
820
      end
821

822 823 824
      # 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.
825 826
      #
      # This essentially finds the object (or multiple objects) with the given id, creates a new object
827 828
      # from the attributes, and then calls destroy on it.
      #
P
Pratik Naik 已提交
829
      # ==== Parameters
830
      #
P
Pratik Naik 已提交
831
      # * +id+ - Can be either an Integer or an Array of Integers.
832 833 834 835 836
      #
      # ==== Examples
      #
      #   # Destroy a single object
      #   Todo.destroy(1)
837
      #
838 839 840
      #   # Destroy multiple objects
      #   todos = [1,2,3]
      #   Todo.destroy(todos)
841
      def destroy(id)
842 843 844 845 846
        if id.is_a?(Array)
          id.map { |one_id| destroy(one_id) }
        else
          find(id).destroy
        end
847 848
      end

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

876
        relation = active_relation
E
Emilio Tagua 已提交
877 878

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

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

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

P
Pratik Naik 已提交
893 894 895 896 897 898 899 900 901 902 903 904 905 906
      # 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.
907
      #
P
Pratik Naik 已提交
908
      # ==== Parameters
909
      #
P
Pratik Naik 已提交
910 911 912 913
      # * +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.
914
      #
P
Pratik Naik 已提交
915
      # ==== Examples
916
      #
P
Pratik Naik 已提交
917
      #   Person.destroy_all("last_login < '2004-04-04'")
P
Pratik Naik 已提交
918
      #   Person.destroy_all(:status => "inactive")
D
Initial  
David Heinemeier Hansson 已提交
919
      def destroy_all(conditions = nil)
P
Pratik Naik 已提交
920
        where(conditions).destroy_all
D
Initial  
David Heinemeier Hansson 已提交
921
      end
922

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

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

960 961 962
      # 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.
963 964 965
      #
      # ==== Parameters
      #
966 967
      # * +id+ - The id of the object you wish to reset a counter on.
      # * +counters+ - One or more counter names to reset
968 969
      #
      # ==== Examples
970 971 972 973 974 975 976 977
      #
      #   # 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
978 979 980 981 982

          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

983 984 985 986 987 988
      # 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 已提交
989
      # ==== Parameters
990
      #
991
      # * +id+ - The id of the object you wish to update a counter on or an Array of ids.
P
Pratik Naik 已提交
992 993
      # * +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.
994
      #
995
      # ==== Examples
996 997
      #
      #   # For the Post with id of 5, decrement the comment_count by 1, and
998
      #   # increment the action_count by 1
999
      #   Post.update_counters 5, :comment_count => -1, :action_count => 1
1000
      #   # Executes the following SQL:
1001 1002 1003 1004
      #   # UPDATE posts
      #   #    SET comment_count = comment_count - 1,
      #   #        action_count = action_count + 1
      #   #  WHERE id = 5
1005 1006 1007 1008 1009 1010 1011
      #
      #   # 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)
1012 1013 1014
      def update_counters(id, counters)
        updates = counters.inject([]) { |list, (counter_name, increment)|
          sign = increment < 0 ? "-" : "+"
1015
          list << "#{connection.quote_column_name(counter_name)} = COALESCE(#{connection.quote_column_name(counter_name)}, 0) #{sign} #{increment.abs}"
1016
        }.join(", ")
1017 1018 1019 1020 1021 1022 1023 1024 1025

        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}")
1026 1027
      end

1028 1029
      # Increment a number field by one, usually representing a count.
      #
1030 1031
      # 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
1032
      # shown it would have to run an SQL query to find how many posts and comments there are.
1033
      #
P
Pratik Naik 已提交
1034
      # ==== Parameters
1035
      #
P
Pratik Naik 已提交
1036 1037
      # * +counter_name+ - The name of the field that should be incremented.
      # * +id+ - The id of the object that should be incremented.
1038 1039 1040 1041 1042
      #
      # ==== 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 已提交
1043
      def increment_counter(counter_name, id)
1044
        update_counters(id, counter_name => 1)
D
Initial  
David Heinemeier Hansson 已提交
1045 1046
      end

1047 1048 1049 1050
      # 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 已提交
1051
      # ==== Parameters
1052
      #
P
Pratik Naik 已提交
1053 1054
      # * +counter_name+ - The name of the field that should be decremented.
      # * +id+ - The id of the object that should be decremented.
1055 1056 1057 1058 1059
      #
      # ==== 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 已提交
1060
      def decrement_counter(counter_name, id)
1061
        update_counters(id, counter_name => -1)
D
Initial  
David Heinemeier Hansson 已提交
1062 1063
      end

P
Pratik Naik 已提交
1064 1065 1066 1067 1068 1069 1070 1071 1072
      # 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 已提交
1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084
      #
      #   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"
1085
      #
P
Pratik Naik 已提交
1086 1087
      # To start from an all-closed default and enable attributes as needed,
      # have a look at +attr_accessible+.
P
Pratik Naik 已提交
1088 1089 1090 1091
      #
      # 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.
1092
      #
P
Pratik Naik 已提交
1093 1094 1095 1096 1097 1098 1099 1100 1101 1102
      # 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 已提交
1103
      def attr_protected(*attributes)
1104
        write_inheritable_attribute(:attr_protected, Set.new(attributes.map {|a| a.to_s}) + (protected_attributes || []))
D
Initial  
David Heinemeier Hansson 已提交
1105
      end
1106

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

P
Pratik Naik 已提交
1112 1113 1114 1115
      # 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>
1116
      #
P
Pratik Naik 已提交
1117 1118 1119 1120 1121 1122 1123
      # 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+.
1124 1125
      #
      #   class Customer < ActiveRecord::Base
1126
      #     attr_accessible :name, :nickname
1127 1128
      #   end
      #
1129 1130 1131 1132
      #   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
1133
      #
1134 1135
      #   customer.credit_rating = "Average"
      #   customer.credit_rating # => "Average"
P
Pratik Naik 已提交
1136 1137 1138 1139
      #
      # 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.
1140
      #
P
Pratik Naik 已提交
1141 1142 1143 1144 1145 1146 1147 1148 1149 1150
      # 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 已提交
1151
      def attr_accessible(*attributes)
1152
        write_inheritable_attribute(:attr_accessible, Set.new(attributes.map(&:to_s)) + (accessible_attributes || []))
D
Initial  
David Heinemeier Hansson 已提交
1153
      end
1154

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

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

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

1170 1171 1172
      # 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 已提交
1173
      # class on retrieval or SerializationTypeMismatch will be raised.
D
David Heinemeier Hansson 已提交
1174
      #
P
Pratik Naik 已提交
1175
      # ==== Parameters
D
David Heinemeier Hansson 已提交
1176
      #
P
Pratik Naik 已提交
1177 1178
      # * +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 已提交
1179 1180 1181 1182 1183 1184
      #
      # ==== Example
      #   # Serialize a preferences attribute
      #   class User
      #     serialize :preferences
      #   end
D
Initial  
David Heinemeier Hansson 已提交
1185
      def serialize(attr_name, class_name = Object)
1186
        serialized_attributes[attr_name.to_s] = class_name
D
Initial  
David Heinemeier Hansson 已提交
1187
      end
1188

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

      # Guesses the table name (in forced lower-case) based on the name of the class in the inheritance hierarchy descending
P
Pratik Naik 已提交
1195
      # directly from ActiveRecord::Base. So if the hierarchy looks like: Reply < Message < ActiveRecord::Base, then Message is used
1196
      # to guess the table name even when called on Reply. The rules used to do the guess are handled by the Inflector class
1197
      # 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 已提交
1198
      #
1199
      # Nested classes are given table names prefixed by the singular form of
P
Pratik Naik 已提交
1200 1201 1202
      # the parent's table name. Enclosing modules are not considered.
      #
      # ==== Examples
1203 1204
      #
      #   class Invoice < ActiveRecord::Base; end;
1205 1206
      #   file                  class               table_name
      #   invoice.rb            Invoice             invoices
1207 1208 1209 1210 1211 1212 1213 1214
      #
      #   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 已提交
1215
      #
P
Pratik Naik 已提交
1216 1217
      # Additionally, the class-level +table_name_prefix+ is prepended and the
      # +table_name_suffix+ is appended.  So if you have "myapp_" as a prefix,
1218 1219 1220 1221 1222
      # 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 已提交
1223 1224
      #
      #   class Mouse < ActiveRecord::Base
1225
      #     set_table_name "mice"
D
Initial  
David Heinemeier Hansson 已提交
1226
      #   end
1227
      def table_name
1228 1229 1230
        reset_table_name
      end

D
David Heinemeier Hansson 已提交
1231
      def reset_table_name #:nodoc:
1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247
        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 已提交
1248
        set_table_name(name)
1249
        name
D
Initial  
David Heinemeier Hansson 已提交
1250 1251
      end

1252 1253
      # 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 已提交
1254
      def inheritance_column
1255
        @inheritance_column ||= "type".freeze
D
Initial  
David Heinemeier Hansson 已提交
1256 1257
      end

1258 1259
      # 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 已提交
1260
      def sequence_name #:nodoc:
1261 1262 1263
        reset_sequence_name
      end

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

1270
      # Sets the table name to use to the given value, or (if the value
1271
      # is nil or false) to the value returned by the given block.
1272 1273 1274 1275
      #
      #   class Project < ActiveRecord::Base
      #     set_table_name "project"
      #   end
1276
      def set_table_name(value = nil, &block)
1277 1278 1279 1280 1281 1282
        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
1283
      # given block.
1284 1285 1286 1287 1288 1289
      #
      #   class Project < ActiveRecord::Base
      #     set_inheritance_column do
      #       original_inheritance_column + "_id"
      #     end
      #   end
1290
      def set_inheritance_column(value = nil, &block)
1291 1292 1293 1294
        define_attr_method :inheritance_column, value, &block
      end
      alias :inheritance_column= :set_inheritance_column

1295 1296
      # 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
1297 1298
      # given block. This is required for Oracle and is useful for any
      # database which relies on sequences for primary key generation.
1299
      #
1300 1301 1302 1303 1304
      # 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.
1305 1306 1307 1308
      #
      #   class Project < ActiveRecord::Base
      #     set_sequence_name "projectseq"   # default would have been "project_seq"
      #   end
1309
      def set_sequence_name(value = nil, &block)
1310 1311 1312 1313
        define_attr_method :sequence_name, value, &block
      end
      alias :sequence_name= :set_sequence_name

D
Initial  
David Heinemeier Hansson 已提交
1314 1315 1316
      # 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
1317 1318 1319
        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 已提交
1320 1321
      end

1322 1323
      # Indicates whether the table associated with this class exists
      def table_exists?
1324
        connection.table_exists?(table_name)
1325 1326
      end

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

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

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

1346 1347
      # 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 已提交
1348
      def content_columns
1349
        @content_columns ||= columns.reject { |c| c.primary || c.name =~ /(_id|_count)$/ || c.name == inheritance_column }
D
Initial  
David Heinemeier Hansson 已提交
1350 1351 1352 1353
      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
1354
      # is available.
D
David Heinemeier Hansson 已提交
1355
      def column_methods_hash #:nodoc:
1356
        @dynamic_methods_hash ||= column_names.inject(Hash.new(false)) do |methods, attr|
1357 1358 1359 1360 1361
          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 已提交
1362 1363 1364
          methods
        end
      end
1365

P
Pratik Naik 已提交
1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391
      # 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
1392
      def reset_column_information
1393
        undefine_attribute_methods
1394
        @column_names = @columns = @columns_hash = @content_columns = @dynamic_methods_hash = @inheritance_column = nil
1395
        @active_relation = @active_relation_engine = nil
1396 1397
      end

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

1402 1403
      # Set the lookup ancestors for ActiveModel.
      def lookup_ancestors #:nodoc:
1404 1405
        klass = self
        classes = [klass]
E
Emilio Tagua 已提交
1406
        while klass != klass.base_class
1407 1408 1409 1410 1411
          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 已提交
1412
        # Apparently the method base_class causes some trouble.
1413 1414 1415 1416
        # It now works for sure.
        [self]
      end

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

1422 1423 1424 1425 1426 1427 1428
      # 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 已提交
1429 1430
      end

1431 1432 1433 1434 1435
      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

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

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

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

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

1464 1465 1466 1467 1468 1469 1470
      # 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 已提交
1471
      # Set this to true if this is an abstract class (see <tt>abstract_class?</tt>).
1472 1473 1474 1475 1476
      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?
1477
        defined?(@abstract_class) && @abstract_class == true
1478 1479
      end

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

1487 1488 1489
        super
      end

1490 1491 1492 1493
      def sti_name
        store_full_sti_class ? name : name.demodulize
      end

1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507
      # 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

1508 1509
      def active_relation
        @active_relation ||= Relation.new(self, active_relation_table)
1510 1511
      end

1512 1513 1514 1515 1516 1517
      def active_relation_table(table_name_alias = nil)
        Arel::Table.new(table_name, :as => table_name_alias)
      end

      def active_relation_engine
        @active_relation_engine ||= Arel::Sql::Engine.new(self)
1518 1519
      end

D
Initial  
David Heinemeier Hansson 已提交
1520
      private
1521 1522 1523
        # 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 已提交
1524
        def instantiate(record)
1525
          object = find_sti_class(record[inheritance_column]).allocate
1526

1527
          object.send(:initialize_attribute_store, record)
1528
          object.instance_variable_set(:'@attributes_cache', {})
1529

1530 1531
          object.send(:_run_find_callbacks)
          object.send(:_run_initialize_callbacks)
1532

1533
          object
D
Initial  
David Heinemeier Hansson 已提交
1534
        end
1535

1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551
        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

1552 1553
        # 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 已提交
1554
        def type_name_with_module(type_name)
1555 1556 1557 1558 1559
          if store_full_sti_class
            type_name
          else
            (/^::/ =~ type_name) ? type_name : "#{parent.name}::#{type_name}"
          end
D
Initial  
David Heinemeier Hansson 已提交
1560 1561
        end

1562 1563 1564 1565 1566 1567 1568 1569
        def default_select(qualified)
          if qualified
            quoted_table_name + '.*'
          else
            '*'
          end
        end

1570
        def construct_finder_arel(options = {}, scope = scope(:find))
1571 1572
          validate_find_options(options)

1573
          relation = active_relation.
1574
            joins(construct_join(options[:joins], scope)).
1575
            where(construct_conditions(options[:conditions], scope)).
1576
            select(options[:select] || (scope && scope[:select]) || default_select(options[:joins] || (scope && scope[:joins]))).
P
Pratik Naik 已提交
1577 1578
            group(options[:group] || (scope && scope[:group])).
            having(options[:having] || (scope && scope[:having])).
1579 1580
            order(construct_order(options[:order], scope)).
            limit(construct_limit(options[:limit], scope)).
1581 1582
            offset(construct_offset(options[:offset], scope)).
            from(options[:from])
1583

1584
          include_associations = merge_includes(scope && scope[:include], options[:include])
1585 1586 1587 1588 1589 1590 1591 1592 1593

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

1594 1595 1596 1597 1598
          lock = (scope && scope[:lock]) || options[:lock]
          relation = relation.lock if lock.present?

          relation = relation.readonly if options[:readonly]

1599 1600 1601
          relation
        end

1602
        def construct_join(joins, scope)
E
Emilio Tagua 已提交
1603 1604 1605 1606 1607 1608
          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
1609
              build_association_joins(merged_joins)
E
Emilio Tagua 已提交
1610 1611 1612
            end
          when String
            " #{merged_joins} "
1613 1614
          else
            ""
E
Emilio Tagua 已提交
1615 1616 1617
          end
        end

1618
        def construct_order(order, scope)
1619
          orders = []
P
Pratik Naik 已提交
1620

E
Emilio Tagua 已提交
1621 1622
          scoped_order = scope[:order] if scope
          if order
1623 1624
            orders << order
            orders << scoped_order if scoped_order && scoped_order != order
1625 1626
          elsif scoped_order
            orders << scoped_order
E
Emilio Tagua 已提交
1627
          end
P
Pratik Naik 已提交
1628 1629

          orders.reject {|o| o.blank?}
1630
        end
1631

1632 1633 1634
        def construct_limit(limit, scope)
          limit ||= scope[:limit] if scope
          limit
E
Emilio Tagua 已提交
1635 1636
        end

1637 1638 1639
        def construct_offset(offset, scope)
          offset ||= scope[:offset] if scope
          offset
E
Emilio Tagua 已提交
1640 1641
        end

1642
        def construct_conditions(conditions, scope)
E
Emilio Tagua 已提交
1643 1644 1645 1646 1647 1648
          conditions = [conditions]
          conditions << scope[:conditions] if scope
          conditions << type_condition if finder_needs_type_condition?
          merge_conditions(*conditions)
        end

1649 1650
        # Merges includes so that the result is a valid +include+
        def merge_includes(first, second)
1651
         (Array.wrap(first) + Array.wrap(second)).uniq
1652 1653
        end

1654 1655 1656 1657
        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)
1658
              join = build_association_joins(join) unless array_of_strings?(join)
1659
              join
1660
            end
1661
            joins.flatten.map{|j| j.strip}.uniq
1662
          else
1663
            joins.collect{|j| Array.wrap(j)}.flatten.uniq
1664 1665 1666
          end
        end

1667
        def build_association_joins(joins)
1668
          join_dependency = ActiveRecord::Associations::ClassMethods::JoinDependency.new(self, joins, nil)
1669
          relation = active_relation.relation
1670
          join_dependency.join_associations.map { |association|
1671 1672 1673
            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()
1674
            else
1675
              Arel::InnerJoin.new(relation, association_relation, association.association_join).joins(relation)
1676 1677 1678 1679
            end
          }.join(" ")
        end

1680 1681 1682 1683
        def array_of_strings?(o)
          o.is_a?(Array) && o.all?{|obj| obj.is_a?(String)}
        end

1684
        def type_condition(table_alias = nil)
1685
          table = Arel::Table.new(table_name, :engine => active_relation_engine, :as => table_alias)
1686 1687 1688 1689

          sti_column = table[inheritance_column]
          condition = sti_column.eq(sti_name)
          subclasses.each{|subclass| condition = condition.or(sti_column.eq(subclass.sti_name)) }
1690

1691
          condition.to_sql
D
Initial  
David Heinemeier Hansson 已提交
1692 1693 1694
        end

        # Guesses the table name, but does not decorate it with prefix and suffix information.
1695
        def undecorated_table_name(class_name = base_class.name)
1696 1697
          table_name = class_name.to_s.demodulize.underscore
          table_name = table_name.pluralize if pluralize_table_names
1698
          table_name
D
Initial  
David Heinemeier Hansson 已提交
1699 1700
        end

P
Pratik Naik 已提交
1701
        # 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 已提交
1702 1703
        # 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>.
1704
        #
P
Pratik Naik 已提交
1705 1706
        # 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>.
1707
        #
1708 1709 1710 1711 1712
        # 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
1713
        # attempts to use it do not run through method_missing.
1714
        def method_missing(method_id, *arguments, &block)
1715 1716
          if match = DynamicFinderMatch.match(method_id)
            attribute_names = match.attribute_names
1717
            super unless all_attributes_exists?(attribute_names)
1718
            if match.finder?
1719
              options = arguments.extract_options!
1720
              relation = options.any? ? construct_finder_arel(options) : scoped
1721
              relation.send :find_by_attributes, match, attribute_names, *arguments
1722
            elsif match.instantiator?
1723
              scoped.send :find_or_instantiator_by_attributes, match, attribute_names, *arguments, &block
1724
            end
1725 1726 1727 1728 1729 1730 1731 1732 1733 1734
          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 已提交
1735
                                                                    #
1736 1737 1738 1739 1740
                  scoped(:conditions => attributes)                 #   scoped(:conditions => attributes)
                end                                                 # end
              }, __FILE__, __LINE__
              send(method_id, *arguments)
            end
1741 1742 1743 1744
          else
            super
          end
        end
D
Initial  
David Heinemeier Hansson 已提交
1745

1746 1747 1748 1749 1750 1751
        def construct_attributes_from_arguments(attribute_names, arguments)
          attributes = {}
          attribute_names.each_with_index { |name, idx| attributes[name] = arguments[idx] }
          attributes
        end

1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766
        # 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

1767
        def all_attributes_exists?(attribute_names)
1768
          attribute_names = expand_attribute_names_for_aggregates(attribute_names)
1769
          attribute_names.all? { |name| column_methods_hash.include?(name.to_sym) }
1770
        end
1771

1772
        def attribute_condition(quoted_column_name, argument)
1773
          case argument
1774 1775 1776 1777 1778 1779 1780 1781
            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} = ?"
1782 1783 1784
          end
        end

D
Initial  
David Heinemeier Hansson 已提交
1785
      protected
1786
        # Scope parameters to method calls within the block.  Takes a hash of method_name => parameters hash.
1787 1788
        # 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.
1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799
        #
        #   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 已提交
1800
        # In nested scopings, all previous parameters are overwritten by the innermost rule, with the exception of
P
Pratik Naik 已提交
1801 1802 1803 1804 1805
        # <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.
1806 1807 1808 1809
        #
        #   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 已提交
1810
        #         with_scope(:find => { :limit => 10 })
1811 1812 1813 1814 1815 1816 1817 1818 1819
        #           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
        #
1820
        # You can ignore any previous scopings by using the <tt>with_exclusive_scope</tt> method.
1821 1822 1823 1824 1825 1826 1827 1828 1829 1830
        #
        #   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 已提交
1831 1832 1833
        #
        # *Note*: the +:find+ scope also has effect on update and deletion methods,
        # like +update_all+ and +delete_all+.
1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845
        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]
1846
            f.assert_valid_keys(VALID_FIND_OPTIONS)
1847 1848 1849 1850
            set_readonly_option! f
          end

          # Merge scopings
1851
          if [:merge, :reverse_merge].include?(action) && current_scoped_methods
1852 1853 1854 1855 1856 1857 1858
            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
1859 1860 1861 1862 1863
                        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
1864
                      elsif key == :include && merge
1865
                        hash[method][key] = merge_includes(hash[method][key], params[key]).uniq
1866 1867
                      elsif key == :joins && merge
                        hash[method][key] = merge_joins(params[key], hash[method][key])
1868 1869 1870 1871 1872
                      else
                        hash[method][key] = hash[method][key] || params[key]
                      end
                    end
                  else
1873 1874 1875 1876 1877
                    if action == :reverse_merge
                      hash[method] = hash[method].merge(params)
                    else
                      hash[method] = params.merge(hash[method])
                    end
1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898
                  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 已提交
1899
        def subclasses #:nodoc:
D
Initial  
David Heinemeier Hansson 已提交
1900 1901 1902
          @@subclasses[self] ||= []
          @@subclasses[self] + extra = @@subclasses[self].inject([]) {|list, subclass| list + subclass.subclasses }
        end
1903

1904
        # Sets the default options for the model. The format of the
1905
        # <tt>options</tt> argument is the same as in find.
1906 1907
        #
        #   class Person < ActiveRecord::Base
1908
        #     default_scope :order => 'last_name, first_name'
1909 1910
        #   end
        def default_scope(options = {})
1911
          self.default_scoping << { :find => options, :create => options[:conditions].is_a?(Hash) ? options[:conditions] : {} }
1912 1913
        end

1914
        # Test whether the given method and optional key are scoped.
D
David Heinemeier Hansson 已提交
1915
        def scoped?(method, key = nil) #:nodoc:
1916
          if current_scoped_methods && (scope = current_scoped_methods[method])
1917
            !key || !scope[key].nil?
1918
          end
1919 1920 1921
        end

        # Retrieve the scope for the given method and optional key.
D
David Heinemeier Hansson 已提交
1922
        def scope(method, key = nil) #:nodoc:
1923
          if current_scoped_methods && (scope = current_scoped_methods[method])
1924 1925 1926 1927
            key ? scope[key] : scope
          end
        end

1928
        def scoped_methods #:nodoc:
1929
          Thread.current[:"#{self}_scoped_methods"] ||= self.default_scoping.dup
1930
        end
1931

D
David Heinemeier Hansson 已提交
1932
        def current_scoped_methods #:nodoc:
1933
          scoped_methods.last
1934
        end
1935

P
Pratik Naik 已提交
1936
        # Returns the class type of the record using the current module as a prefix. So descendants of
1937
        # MyApp::Business::Account would appear as MyApp::Business::AccountSubclass.
D
Initial  
David Heinemeier Hansson 已提交
1938
        def compute_type(type_name)
1939
          modularized_name = type_name_with_module(type_name)
1940 1941 1942 1943 1944 1945
          silence_warnings do
            begin
              class_eval(modularized_name, __FILE__, __LINE__)
            rescue NameError
              class_eval(type_name, __FILE__, __LINE__)
            end
D
Initial  
David Heinemeier Hansson 已提交
1946 1947 1948
          end
        end

P
Pratik Naik 已提交
1949 1950
        # Returns the class descending directly from ActiveRecord::Base or an
        # abstract class, if any, in the inheritance hierarchy.
1951
        def class_of_active_record_descendant(klass)
1952
          if klass.superclass == Base || klass.superclass.abstract_class?
1953
            klass
D
Initial  
David Heinemeier Hansson 已提交
1954 1955 1956
          elsif klass.superclass.nil?
            raise ActiveRecordError, "#{name} doesn't belong in a hierarchy descending from ActiveRecord"
          else
1957
            class_of_active_record_descendant(klass.superclass)
D
Initial  
David Heinemeier Hansson 已提交
1958 1959 1960
          end
        end

P
Pratik Naik 已提交
1961
        # Returns the name of the class descending directly from Active Record in the inheritance hierarchy.
D
David Heinemeier Hansson 已提交
1962
        def class_name_of_active_record_descendant(klass) #:nodoc:
1963
          klass.base_class.name
1964 1965
        end

P
Pratik Naik 已提交
1966
        # Accepts an array, hash, or string of SQL conditions and sanitizes
1967
        # them into a valid SQL fragment for a WHERE clause.
1968 1969 1970
        #   ["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'"
1971
        def sanitize_sql_for_conditions(condition, table_name = self.table_name)
1972 1973
          return nil if condition.blank?

1974 1975
          case condition
            when Array; sanitize_sql_array(condition)
1976
            when Hash;  sanitize_sql_hash_for_conditions(condition, table_name)
1977 1978
            else        condition
          end
1979
        end
1980
        alias_method :sanitize_sql, :sanitize_sql_for_conditions
1981

P
Pratik Naik 已提交
1982
        # Accepts an array, hash, or string of SQL conditions and sanitizes
1983 1984 1985 1986 1987 1988 1989 1990 1991 1992
        # 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

1993 1994 1995 1996 1997
        def aggregate_mapping(reflection)
          mapping = reflection.options[:mapping] || [reflection.name, reflection.name]
          mapping.first.is_a?(Array) ? mapping : [mapping]
        end

P
Pratik Naik 已提交
1998
        # Accepts a hash of SQL conditions and replaces those attributes
1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027
        # 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

2028
        # Sanitizes a hash of attribute/value pairs into SQL conditions for a WHERE clause.
2029 2030 2031 2032
        #   { :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)"
2033 2034
        #   { :age => 13..18 }
        #     # => "age BETWEEN 13 AND 18"
2035 2036
        #   { 'other_records.id' => 7 }
        #     # => "`other_records`.`id` = 7"
2037 2038
        #   { :other_records => { :id => 7 } }
        #     # => "`other_records`.`id` = 7"
2039 2040 2041
        # 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'"
2042
        def sanitize_sql_hash_for_conditions(attrs, default_table_name = self.table_name)
2043 2044
          attrs = expand_hash_conditions_for_aggregates(attrs)

2045 2046
          table = Arel::Table.new(default_table_name, active_relation_engine)
          builder = PredicateBuilder.new(active_relation_engine)
2047
          builder.build_from_hash(attrs, table).map(&:to_sql).join(' AND ')
2048
        end
2049 2050 2051 2052 2053 2054
        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)
2055
          attrs.map do |attr, value|
2056 2057 2058
            "#{connection.quote_column_name(attr)} = #{quote_bound_value(value)}"
          end.join(', ')
        end
2059

2060
        # Accepts an array of conditions.  The array has each value
P
Pratik Naik 已提交
2061
        # sanitized and interpolated into the SQL statement.
2062
        #   ["name='%s' and group_id='%s'", "foo'bar", 4]  returns  "name='foo''bar' and group_id='4'"
2063
        def sanitize_sql_array(ary)
2064 2065 2066 2067
          statement, *values = ary
          if values.first.is_a?(Hash) and statement =~ /:\w+/
            replace_named_bind_variables(statement, values.first)
          elsif statement.include?('?')
2068 2069
            replace_bind_variables(statement, values)
          else
2070
            statement % values.collect { |value| connection.quote_string(value.to_s) }
2071
          end
2072 2073
        end

2074 2075
        alias_method :sanitize_conditions, :sanitize_sql

D
David Heinemeier Hansson 已提交
2076
        def replace_bind_variables(statement, values) #:nodoc:
2077
          raise_if_bind_arity_mismatch(statement, statement.count('?'), values.size)
2078
          bound = values.dup
2079
          statement.gsub('?') { quote_bound_value(bound.shift) }
2080 2081
        end

D
David Heinemeier Hansson 已提交
2082
        def replace_named_bind_variables(statement, bind_vars) #:nodoc:
2083 2084 2085 2086
          statement.gsub(/(:?):([a-zA-Z]\w*)/) do
            if $1 == ':' # skip postgresql casts
              $& # return the whole match
            elsif bind_vars.include?(match = $2.to_sym)
2087
              quote_bound_value(bind_vars[match])
2088 2089
            else
              raise PreparedStatementInvalid, "missing value for :#{match} in #{statement}"
2090 2091
            end
          end
2092 2093
        end

2094
        def expand_range_bind_variables(bind_vars) #:nodoc:
2095 2096 2097
          expanded = []

          bind_vars.each do |var|
2098 2099
            next if var.is_a?(Hash)

2100
            if var.is_a?(Range)
2101 2102
              expanded << var.first
              expanded << var.last
2103
            else
2104
              expanded << var
2105
            end
2106
          end
2107 2108

          expanded
2109 2110
        end

D
David Heinemeier Hansson 已提交
2111
        def quote_bound_value(value) #:nodoc:
2112
          if value.respond_to?(:map) && !value.acts_like?(:string)
2113 2114
            if value.respond_to?(:empty?) && value.empty?
              connection.quote(nil)
2115 2116 2117
            else
              value.map { |v| connection.quote(v) }.join(',')
            end
2118 2119
          else
            connection.quote(value)
2120 2121 2122
          end
        end

D
David Heinemeier Hansson 已提交
2123
        def raise_if_bind_arity_mismatch(statement, expected, provided) #:nodoc:
2124 2125 2126
          unless expected == provided
            raise PreparedStatementInvalid, "wrong number of bind variables (#{provided} for #{expected}) in: #{statement}"
          end
2127
        end
2128

2129
        VALID_FIND_OPTIONS = [ :conditions, :include, :joins, :limit, :offset,
2130
                               :order, :select, :readonly, :group, :having, :from, :lock ]
2131

D
David Heinemeier Hansson 已提交
2132
        def validate_find_options(options) #:nodoc:
2133 2134
          options.assert_valid_keys(VALID_FIND_OPTIONS)
        end
2135

D
David Heinemeier Hansson 已提交
2136
        def set_readonly_option!(options) #:nodoc:
2137 2138 2139
          # 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 已提交
2140 2141
            if scoped_readonly = scope(:find, :readonly)
              options[:readonly] = scoped_readonly
2142
            elsif !options[:joins].blank? && !options[:select]
2143 2144 2145
              options[:readonly] = true
            end
          end
D
Initial  
David Heinemeier Hansson 已提交
2146
        end
2147

D
David Heinemeier Hansson 已提交
2148
        def encode_quoted_value(value) #:nodoc:
2149
          quoted_value = connection.quote(value)
2150 2151
          quoted_value = "'#{quoted_value[1..-2].gsub(/\'/, "\\\\'")}'" if quoted_value.include?("\\\'") # (for ruby mode) "
          quoted_value
2152
        end
D
Initial  
David Heinemeier Hansson 已提交
2153 2154 2155 2156 2157
    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).
2158
      # In both instances, valid attribute keys are determined by the column names of the associated table --
D
Initial  
David Heinemeier Hansson 已提交
2159 2160
      # hence you can't have attributes that aren't part of the table columns.
      def initialize(attributes = nil)
2161
        initialize_attribute_store(attributes_from_column_definition)
2162
        @attributes_cache = {}
D
Initial  
David Heinemeier Hansson 已提交
2163 2164 2165
        @new_record = true
        ensure_proper_type
        self.attributes = attributes unless attributes.nil?
2166
        self.class.send(:scope, :create).each { |att,value| self.send("#{att}=", value) } if self.class.send(:scoped?, :create)
2167
        result = yield self if block_given?
2168
        _run_initialize_callbacks
2169
        result
D
Initial  
David Heinemeier Hansson 已提交
2170
      end
2171

2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186
      # 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)
2187
        initialize_attribute_store(cloned_attributes)
2188 2189 2190 2191 2192 2193 2194
        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 已提交
2195 2196 2197 2198
      # 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 已提交
2199 2200 2201
      # 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 已提交
2202 2203
      #
      #   user = User.find_by_name('Phusion')
2204
      #   user_path(user)  # => "/users/1"
P
Pratik Naik 已提交
2205
      #
P
Pratik Naik 已提交
2206 2207
      # 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 已提交
2208 2209 2210 2211 2212 2213
      #
      #   class User < ActiveRecord::Base
      #     def to_param  # overridden
      #       name
      #     end
      #   end
E
Emilio Tagua 已提交
2214
      #
P
Pratik Naik 已提交
2215
      #   user = User.find_by_name('Phusion')
2216
      #   user_path(user)  # => "/users/Phusion"
2217
      def to_param
2218
        # We can't use alias_method here, because method 'id' optimizes itself on the fly.
2219
        (id = self.id) ? id.to_s : nil # Be sure to stringify the id for routes
2220
      end
2221

P
Pratik Naik 已提交
2222 2223 2224
      # Returns a cache key that can be used to identify this record.
      #
      # ==== Examples
2225 2226 2227 2228 2229
      #
      #   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
2230
        case
2231
        when new_record?
J
Jeremy Kemper 已提交
2232 2233 2234
          "#{self.class.model_name.cache_key}/new"
        when timestamp = self[:updated_at]
          "#{self.class.model_name.cache_key}/#{id}-#{timestamp.to_s(:number)}"
2235
        else
J
Jeremy Kemper 已提交
2236
          "#{self.class.model_name.cache_key}/#{id}"
2237 2238
        end
      end
2239

2240
      def quoted_id #:nodoc:
2241
        quote_value(id, column_for_attribute(self.class.primary_key))
2242
      end
2243

2244
      # Returns true if this object hasn't been saved yet -- that is, a record for the object doesn't exist yet; otherwise, returns false.
2245
      def new_record?
2246
        @new_record || false
2247
      end
2248

2249 2250 2251 2252 2253
      # Returns true if this object has been destroyed, otherwise returns false.
      def destroyed?
        @destroyed || false
      end

P
Pratik Naik 已提交
2254 2255
      # :call-seq:
      #   save(perform_validation = true)
2256
      #
P
Pratik Naik 已提交
2257 2258 2259 2260 2261 2262 2263 2264
      # 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 已提交
2265
      # ActiveRecord::Validations for more information.
P
Pratik Naik 已提交
2266 2267 2268 2269
      #
      # 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 已提交
2270
      # details.
D
Initial  
David Heinemeier Hansson 已提交
2271 2272 2273
      def save
        create_or_update
      end
2274

P
Pratik Naik 已提交
2275 2276 2277 2278 2279 2280 2281
      # 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 已提交
2282
      # for more information.
P
Pratik Naik 已提交
2283 2284 2285 2286
      #
      # 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 已提交
2287
      # ActiveRecord::Callbacks for further details.
2288
      def save!
2289
        create_or_update || raise(RecordNotSaved)
2290
      end
2291

P
Pratik Naik 已提交
2292 2293 2294
      # 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.
2295
      #
P
Pratik Naik 已提交
2296 2297 2298 2299 2300 2301
      # 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>.
2302 2303
      def delete
        self.class.delete(id) unless new_record?
2304
        @destroyed = true
2305 2306 2307
        freeze
      end

D
Initial  
David Heinemeier Hansson 已提交
2308 2309 2310
      # 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
2311
        unless new_record?
2312
          self.class.active_relation.where(self.class.active_relation[self.class.primary_key].eq(id)).delete_all
D
Initial  
David Heinemeier Hansson 已提交
2313 2314
        end

2315
        @destroyed = true
D
Initial  
David Heinemeier Hansson 已提交
2316 2317 2318
        freeze
      end

2319
      # Returns an instance of the specified +klass+ with the attributes of the current record. This is mostly useful in relation to
2320
      # single-table inheritance structures where you want a subclass to appear as the superclass. This can be used along with record
2321
      # identification in Action Pack to allow, say, <tt>Client < Company</tt> to do something like render <tt>:partial => @client.becomes(Company)</tt>
2322 2323 2324 2325 2326
      # 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 已提交
2327 2328 2329 2330 2331
        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
2332 2333
      end

2334 2335 2336
      # 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 已提交
2337
      def update_attribute(name, value)
2338
        send(name.to_s + '=', value)
2339
        save(false)
2340 2341
      end

2342
      # Updates all the attributes from the passed-in Hash and saves the record. If the object is invalid, the saving will
2343
      # fail and false will be returned.
2344
      def update_attributes(attributes)
2345
        self.attributes = attributes
2346
        save
D
Initial  
David Heinemeier Hansson 已提交
2347
      end
2348

2349 2350 2351 2352 2353
      # 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 已提交
2354

P
Pratik Naik 已提交
2355 2356 2357
      # 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+.
2358
      def increment(attribute, by = 1)
2359
        self[attribute] ||= 0
2360
        self[attribute] += by
2361 2362
        self
      end
2363

P
Pratik Naik 已提交
2364 2365 2366 2367
      # 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.
2368 2369
      def increment!(attribute, by = 1)
        increment(attribute, by).update_attribute(attribute, self[attribute])
2370 2371
      end

P
Pratik Naik 已提交
2372 2373 2374
      # 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+.
2375
      def decrement(attribute, by = 1)
2376
        self[attribute] ||= 0
2377
        self[attribute] -= by
2378 2379 2380
        self
      end

P
Pratik Naik 已提交
2381 2382 2383 2384
      # 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.
2385 2386
      def decrement!(attribute, by = 1)
        decrement(attribute, by).update_attribute(attribute, self[attribute])
2387
      end
2388

P
Pratik Naik 已提交
2389 2390 2391 2392
      # 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+.
2393
      def toggle(attribute)
2394
        self[attribute] = !send("#{attribute}?")
2395 2396 2397
        self
      end

P
Pratik Naik 已提交
2398 2399 2400 2401
      # 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.
2402 2403 2404 2405
      def toggle!(attribute)
        toggle(attribute).update_attribute(attribute, self[attribute])
      end

2406
      # Reloads the attributes of this object from the database.
2407 2408 2409 2410
      # 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)
2411
        clear_aggregation_cache
2412
        clear_association_cache
2413
        _attributes.update(self.class.find(self.id, options).instance_variable_get('@attributes'))
2414
        @attributes_cache = {}
2415
        self
2416 2417
      end

2418
      # Returns the value of the attribute identified by <tt>attr_name</tt> after it has been typecast (for example,
D
Initial  
David Heinemeier Hansson 已提交
2419 2420
      # "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).
2421
      def [](attr_name)
2422
        read_attribute(attr_name)
D
Initial  
David Heinemeier Hansson 已提交
2423
      end
2424

D
Initial  
David Heinemeier Hansson 已提交
2425 2426
      # Updates the attribute identified by <tt>attr_name</tt> with the specified +value+.
      # (Alias for the protected write_attribute method).
2427
      def []=(attr_name, value)
2428
        write_attribute(attr_name, value)
D
Initial  
David Heinemeier Hansson 已提交
2429 2430 2431
      end

      # Allows you to set all the attributes at once by passing in a hash with keys
P
Pratik Naik 已提交
2432 2433 2434 2435 2436 2437
      # 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
2438
      # attributes not included in that won't be allowed to be mass-assigned.
P
Pratik Naik 已提交
2439 2440 2441 2442
      #
      #   class User < ActiveRecord::Base
      #     attr_protected :is_admin
      #   end
E
Emilio Tagua 已提交
2443
      #
P
Pratik Naik 已提交
2444 2445 2446 2447
      #   user = User.new
      #   user.attributes = { :username => 'Phusion', :is_admin => true }
      #   user.username   # => "Phusion"
      #   user.is_admin?  # => false
E
Emilio Tagua 已提交
2448
      #
P
Pratik Naik 已提交
2449 2450
      #   user.send(:attributes=, { :username => 'Phusion', :is_admin => true }, false)
      #   user.is_admin?  # => true
2451
      def attributes=(new_attributes, guard_protected_attributes = true)
D
David Heinemeier Hansson 已提交
2452 2453
        return if new_attributes.nil?
        attributes = new_attributes.dup
2454
        attributes.stringify_keys!
D
Initial  
David Heinemeier Hansson 已提交
2455 2456

        multi_parameter_attributes = []
2457
        attributes = remove_attributes_protected_from_mass_assignment(attributes) if guard_protected_attributes
2458

2459
        attributes.each do |k, v|
2460 2461 2462 2463 2464
          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 已提交
2465
        end
D
David Heinemeier Hansson 已提交
2466

D
Initial  
David Heinemeier Hansson 已提交
2467 2468 2469
        assign_multiparameter_attributes(multi_parameter_attributes)
      end

2470
      # Returns a hash of all the attributes with their names as keys and the values of the attributes as values.
2471
      def attributes
2472 2473
        self.attribute_names.inject({}) do |attrs, name|
          attrs[name] = read_attribute(name)
2474
          attrs
2475
        end
2476 2477
      end

P
Pratik Naik 已提交
2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490
      # 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"'
2491 2492 2493
      def attribute_for_inspect(attr_name)
        value = read_attribute(attr_name)

2494
        if value.is_a?(String) && value.length > 50
2495
          "#{value[0..50]}...".inspect
2496 2497
        elsif value.is_a?(Date) || value.is_a?(Time)
          %("#{value.to_s(:db)}")
2498 2499 2500 2501 2502
        else
          value.inspect
        end
      end

D
Initial  
David Heinemeier Hansson 已提交
2503
      # Returns true if the specified +attribute+ has been set by the user or by a database load and is neither
2504
      # nil nor empty? (the latter only applies to objects that respond to empty?, most notably Strings).
D
Initial  
David Heinemeier Hansson 已提交
2505
      def attribute_present?(attribute)
2506
        value = read_attribute(attribute)
2507
        !value.blank?
D
Initial  
David Heinemeier Hansson 已提交
2508 2509 2510 2511
      end

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

2515
      # 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 已提交
2516
      def ==(comparison_object)
2517
        comparison_object.equal?(self) ||
2518 2519
          (comparison_object.instance_of?(self.class) &&
            comparison_object.id == id &&
2520
            !comparison_object.new_record?)
D
Initial  
David Heinemeier Hansson 已提交
2521 2522 2523 2524 2525 2526
      end

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

D
Initial  
David Heinemeier Hansson 已提交
2528 2529 2530
      # 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
2531
        id.hash
D
Initial  
David Heinemeier Hansson 已提交
2532 2533
      end

2534
      # Freeze the attributes hash such that associations are still accessible, even on destroyed records.
2535
      def freeze
2536
        @attributes.freeze; self
2537
      end
2538

2539
      # Returns +true+ if the attributes hash has been frozen.
2540 2541 2542
      def frozen?
        @attributes.frozen?
      end
2543

2544 2545 2546 2547 2548 2549 2550
      # Returns duplicated record with unfreezed attributes.
      def dup
        obj = super
        obj.instance_variable_set('@attributes', instance_variable_get('@attributes').dup)
        obj
      end

2551 2552
      # 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.
2553
      def readonly?
2554
        defined?(@readonly) && @readonly == true
2555 2556
      end

2557 2558
      # Marks this record as read only.
      def readonly!
2559 2560
        @readonly = true
      end
2561

2562
      # Returns the contents of the record as a nicely formatted string.
2563
      def inspect
2564
        attributes_as_nice_string = self.class.column_names.collect { |name|
2565 2566 2567 2568
          if has_attribute?(name) || new_record?
            "#{name}: #{attribute_for_inspect(name)}"
          end
        }.compact.join(", ")
2569
        "#<#{self.class} #{attributes_as_nice_string}>"
2570
      end
2571

2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586
    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 已提交
2587 2588
    private
      def create_or_update
2589
        raise ReadOnlyRecord if readonly?
2590 2591
        result = new_record? ? create : update
        result != false
D
Initial  
David Heinemeier Hansson 已提交
2592 2593
      end

2594
      # Updates the associated record with values matching those of the instance attributes.
2595
      # Returns the number of affected rows.
2596
      def update(attribute_names = @attributes.keys)
2597 2598
        attributes_with_values = arel_attributes_values(false, false, attribute_names)
        return 0 if attributes_with_values.empty?
2599
        self.class.active_relation.where(self.class.active_relation[self.class.primary_key].eq(id)).update(attributes_with_values)
D
Initial  
David Heinemeier Hansson 已提交
2600 2601
      end

2602 2603
      # Creates a record with values matching those of the instance attributes
      # and returns its id.
D
Initial  
David Heinemeier Hansson 已提交
2604
      def create
2605
        if self.id.nil? && connection.prefetch_primary_key?(self.class.table_name)
2606 2607
          self.id = connection.next_sequence_value(self.class.sequence_name)
        end
2608

E
Emilio Tagua 已提交
2609 2610 2611
        attributes_values = arel_attributes_values

        new_id = if attributes_values.empty?
2612
          self.class.active_relation.insert connection.empty_insert_statement_value
2613
        else
2614
          self.class.active_relation.insert attributes_values
2615 2616
        end

2617
        self.id ||= new_id
2618

D
Initial  
David Heinemeier Hansson 已提交
2619
        @new_record = false
2620
        id
D
Initial  
David Heinemeier Hansson 已提交
2621 2622
      end

P
Pratik Naik 已提交
2623
      # Sets the attribute used for single table inheritance to this class name if this is not the ActiveRecord::Base descendant.
P
Pratik Naik 已提交
2624 2625
      # 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 已提交
2626 2627 2628
      # Message class in that example.
      def ensure_proper_type
        unless self.class.descends_from_active_record?
2629
          write_attribute(self.class.inheritance_column, self.class.sti_name)
D
Initial  
David Heinemeier Hansson 已提交
2630 2631 2632 2633
        end
      end

      def remove_attributes_protected_from_mass_assignment(attributes)
2634 2635 2636 2637
        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?
2638
            attributes.reject { |key, value| !self.class.accessible_attributes.include?(key.gsub(/\(.+/, "")) || attributes_protected_by_default.include?(key.gsub(/\(.+/, "")) }
2639
          elsif self.class.accessible_attributes.nil?
2640
            attributes.reject { |key, value| self.class.protected_attributes.include?(key.gsub(/\(.+/,"")) || attributes_protected_by_default.include?(key.gsub(/\(.+/, "")) }
2641 2642 2643 2644 2645 2646 2647
          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?
2648
          log_protected_attribute_removal(removed_attributes)
D
Initial  
David Heinemeier Hansson 已提交
2649
        end
2650 2651

        safe_attributes
D
Initial  
David Heinemeier Hansson 已提交
2652
      end
2653

2654 2655 2656
      # Removes attributes which have been marked as readonly.
      def remove_readonly_attributes(attributes)
        unless self.class.readonly_attributes.nil?
2657
          attributes.delete_if { |key, value| self.class.readonly_attributes.include?(key.gsub(/\(.+/,"")) }
2658 2659 2660 2661
        else
          attributes
        end
      end
D
Initial  
David Heinemeier Hansson 已提交
2662

2663
      def log_protected_attribute_removal(*attributes)
2664 2665 2666
        if logger
          logger.debug "WARNING: Can't mass-assign these protected attributes: #{attributes.join(', ')}"
        end
2667 2668
      end

2669 2670
      # The primary key and inheritance column can never be set by mass-assignment for security reasons.
      def attributes_protected_by_default
2671 2672 2673
        default = [ self.class.primary_key, self.class.inheritance_column ]
        default << 'id' unless self.class.primary_key.eql? 'id'
        default
2674 2675
      end

2676
      # Returns a copy of the attributes hash where all the values have been safely quoted for use in
2677
      # an SQL statement.
2678
      def attributes_with_quotes(include_primary_key = true, include_readonly_attributes = true, attribute_names = @attributes.keys)
2679
        quoted = {}
2680
        connection = self.class.connection
2681
        attribute_names.each do |name|
2682 2683 2684 2685 2686 2687 2688 2689 2690
          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)
2691
          end
D
Initial  
David Heinemeier Hansson 已提交
2692
        end
2693
        include_readonly_attributes ? quoted : remove_readonly_attributes(quoted)
D
Initial  
David Heinemeier Hansson 已提交
2694
      end
2695

2696 2697
      # Returns a copy of the attributes hash where all the values have been safely quoted for use in
      # an Arel insert/update method.
2698 2699 2700 2701 2702 2703
      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))
2704 2705 2706
              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))
2707 2708
                value = value.to_yaml
              end
2709
              attrs[self.class.active_relation[name]] = value
2710 2711 2712 2713 2714 2715
            end
          end
        end
        attrs
      end

D
Initial  
David Heinemeier Hansson 已提交
2716
      # Quote strings appropriately for SQL statements.
2717
      def quote_value(value, column = nil)
2718
        self.class.connection.quote(value, column)
D
Initial  
David Heinemeier Hansson 已提交
2719 2720
      end

P
Pratik Naik 已提交
2721
      # Interpolate custom SQL string in instance context.
D
Initial  
David Heinemeier Hansson 已提交
2722 2723
      # Optional record argument is meant for custom insert_sql.
      def interpolate_sql(sql, record = nil)
2724
        instance_eval("%@#{sql.gsub('@', '\@')}@")
D
Initial  
David Heinemeier Hansson 已提交
2725 2726 2727 2728 2729 2730 2731
      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
2732
        self.class.columns.inject({}) do |attributes, column|
2733
          attributes[column.name] = column.default unless column.name == self.class.primary_key
D
Initial  
David Heinemeier Hansson 已提交
2734 2735 2736 2737 2738 2739 2740 2741
          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
2742
      # parentheses to have the parameters typecasted before they're used in the constructor. Use i for Fixnum, f for Float,
2743
      # 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 已提交
2744 2745 2746 2747 2748
      def assign_multiparameter_attributes(pairs)
        execute_callstack_for_multiparameter_attributes(
          extract_callstack_for_multiparameter_attributes(pairs)
        )
      end
2749

2750
      def instantiate_time_object(name, values)
2751
        if self.class.send(:time_zone_aware?, name)
2752
          Time.zone.local(*values)
2753
        else
2754
          Time.time_with_datetime_fallback(@@default_timezone, *values)
2755
        end
2756 2757
      end

D
Initial  
David Heinemeier Hansson 已提交
2758
      def execute_callstack_for_multiparameter_attributes(callstack)
2759
        errors = []
2760
        callstack.each do |name, values_with_empty_parameters|
2761 2762
          begin
            klass = (self.class.reflect_on_aggregation(name.to_sym) || column_for_attribute(name)).klass
2763 2764 2765 2766
            # 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?)

2767 2768 2769
            if values.empty?
              send(name + "=", nil)
            else
2770

2771
              value = if Time == klass
2772
                instantiate_time_object(name, values)
2773 2774
              elsif Date == klass
                begin
2775
                  values = values_with_empty_parameters.collect do |v| v.nil? ? 1 : v end
2776 2777
                  Date.new(*values)
                rescue ArgumentError => ex # if Date.new raises an exception on an invalid date
2778
                  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
2779 2780 2781 2782 2783 2784
                end
              else
                klass.new(*values)
              end

              send(name + "=", value)
2785
            end
2786 2787
          rescue => ex
            errors << AttributeAssignmentError.new("error on assignment #{values.inspect} to #{name}", ex, name)
D
Initial  
David Heinemeier Hansson 已提交
2788 2789
          end
        end
2790 2791 2792
        unless errors.empty?
          raise MultiparameterAssignmentErrors.new(errors), "#{errors.size} error(s) on assignment of multiparameter attributes"
        end
D
Initial  
David Heinemeier Hansson 已提交
2793
      end
2794

D
Initial  
David Heinemeier Hansson 已提交
2795 2796 2797 2798 2799 2800 2801 2802
      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)

2803 2804
          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 已提交
2805 2806 2807 2808
        end

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

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

D
Initial  
David Heinemeier Hansson 已提交
2814 2815 2816
      def find_parameter_position(multiparameter_name)
        multiparameter_name.scan(/\(([0-9]*).*\)/).first.first
      end
2817

D
Initial  
David Heinemeier Hansson 已提交
2818 2819 2820 2821 2822
      # 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

2823 2824 2825 2826
      def self.quoted_table_name
        self.connection.quote_table_name(self.table_name)
      end

2827 2828 2829 2830
      def quote_columns(quoter, hash)
        hash.inject({}) do |quoted, (name, value)|
          quoted[quoter.quote_column_name(name)] = value
          quoted
2831
        end
D
Initial  
David Heinemeier Hansson 已提交
2832 2833
      end

2834 2835
      def quoted_comma_pair_list(quoter, hash)
        comma_pair_list(quote_columns(quoter, hash))
D
Initial  
David Heinemeier Hansson 已提交
2836 2837 2838
      end

  end
J
Joshua Peek 已提交
2839 2840

  Base.class_eval do
J
Joshua Peek 已提交
2841
    extend ActiveModel::Naming
J
Joshua Peek 已提交
2842
    extend QueryCache::ClassMethods
J
José Valim 已提交
2843 2844
    extend ActiveSupport::Benchmarkable

J
Joshua Peek 已提交
2845 2846 2847
    include Validations
    include Locking::Optimistic, Locking::Pessimistic
    include AttributeMethods
J
Joshua Peek 已提交
2848
    include AttributeMethods::Read, AttributeMethods::Write, AttributeMethods::BeforeTypeCast, AttributeMethods::Query
2849
    include AttributeMethods::PrimaryKey
J
Joshua Peek 已提交
2850 2851
    include AttributeMethods::TimeZoneConversion
    include AttributeMethods::Dirty
2852
    include Attributes, Types
2853
    include Callbacks, ActiveModel::Observing, Timestamp
J
Joshua Peek 已提交
2854
    include Associations, AssociationPreload, NamedScope
J
Joshua Peek 已提交
2855
    include ActiveModel::Conversion
2856 2857 2858 2859 2860

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

2861
    include Aggregations, Transactions, Reflection, Batches, Calculations, Serialization
2862

J
Joshua Peek 已提交
2863
  end
2864
end
2865 2866 2867

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