base.rb 125.0 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 522
    # 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.
523
    cattr_accessor :default_timezone, :instance_writer => false
524
    @@default_timezone = :local
525

P
Pratik Naik 已提交
526 527
    ##
    # :singleton-method:
528 529
    # Specifies the format to use when dumping the database schema with Rails'
    # Rakefile.  If :sql, the schema is dumped as (potentially database-
530
    # specific) SQL statements.  If :ruby, the schema is dumped as an
531 532 533
    # 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.
534
    cattr_accessor :schema_format , :instance_writer => false
535
    @@schema_format = :ruby
536

P
Pratik Naik 已提交
537 538
    ##
    # :singleton-method:
539 540 541 542
    # Specify whether or not to use timestamps for migration numbers
    cattr_accessor :timestamped_migrations , :instance_writer => false
    @@timestamped_migrations = true

543 544
    # Determine whether to store the full constant name including namespace when using STI
    superclass_delegating_accessor :store_full_sti_class
545
    self.store_full_sti_class = true
546

547 548 549 550
    # Stores the default scope for the class
    class_inheritable_accessor :default_scoping, :instance_writer => false
    self.default_scoping = []

D
Initial  
David Heinemeier Hansson 已提交
551
    class << self # Class methods
552 553 554 555 556 557 558
      def colorize_logging(*args)
        ActiveSupport::Deprecation.warn "ActiveRecord::Base.colorize_logging and " <<
          "config.active_record.colorize_logging are deprecated. Please use " << 
          "Rails::Subscriber.colorize_logging or config.colorize_logging instead", caller
      end
      alias :colorize_logging= :colorize_logging

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

646
        relation = construct_finder_arel(options, current_scoped_methods)
P
Pratik Naik 已提交
647

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

656
      delegate :select, :group, :order, :limit, :joins, :where, :preload, :eager_load, :includes, :from, :lock, :readonly, :having, :to => :scoped
657

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

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

670 671
      # 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>.
672
      def all(*args)
673
        find(:all, *args)
674
      end
675

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

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

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

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

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

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

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

874
        if conditions = construct_conditions(conditions, nil)
875
          relation = relation.where(Arel::SqlLiteral.new(conditions))
E
Emilio Tagua 已提交
876
        end
877

878 879 880 881
        relation = relation.limit(options[:limit]) if options[:limit].present?
        relation = relation.order(options[:order]) if options[:order].present?

        if current_scoped_methods && current_scoped_methods.limit_value.present? && current_scoped_methods.order_values.present?
882 883
          # Only take order from scope if limit is also provided by scope, this
          # is useful for updating a has_many association with a limit.
884
          relation = current_scoped_methods.merge(relation) if current_scoped_methods
885
        else
886
          relation = current_scoped_methods.except(:limit, :order).merge(relation) if current_scoped_methods
887 888
        end

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

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

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

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

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

          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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

P
Pratik Naik 已提交
1365 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
      # 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
1391
      def reset_column_information
1392
        undefine_attribute_methods
1393
        @column_names = @columns = @columns_hash = @content_columns = @dynamic_methods_hash = @inheritance_column = nil
1394
        @active_relation = @active_relation_engine = nil
1395 1396
      end

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

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

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

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

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

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

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

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

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

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

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

1486 1487 1488
        super
      end

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

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

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

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

      def active_relation_engine
1516 1517 1518 1519 1520 1521 1522
        @active_relation_engine ||= begin
          if self == ActiveRecord::Base
            Arel::Table.engine
          else
            connection_handler.connection_pools[name] ? Arel::Sql::Engine.new(self) : superclass.active_relation_engine
          end
        end
1523 1524
      end

D
Initial  
David Heinemeier Hansson 已提交
1525
      private
1526 1527 1528
        # 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 已提交
1529
        def instantiate(record)
1530
          object = find_sti_class(record[inheritance_column]).allocate
1531

1532
          object.send(:initialize_attribute_store, record)
1533
          object.instance_variable_set(:'@attributes_cache', {})
1534

1535 1536
          object.send(:_run_find_callbacks)
          object.send(:_run_initialize_callbacks)
1537

1538
          object
D
Initial  
David Heinemeier Hansson 已提交
1539
        end
1540

1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556
        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

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

1567 1568 1569 1570 1571 1572 1573 1574
        def default_select(qualified)
          if qualified
            quoted_table_name + '.*'
          else
            '*'
          end
        end

1575
        def construct_finder_arel(options = {}, scope = nil)
1576 1577
          validate_find_options(options)

1578
          relation = active_relation.
1579 1580 1581 1582 1583 1584 1585 1586
            joins(options[:joins]).
            where(options[:conditions]).
            select(options[:select]).
            group(options[:group]).
            having(options[:having]).
            order(options[:order]).
            limit(options[:limit]).
            offset(options[:offset]).
1587
            from(options[:from]).
1588
            includes(options[:include])
1589

1590 1591 1592
          relation = relation.where(type_condition) if finder_needs_type_condition?
          relation = relation.lock(options[:lock]) if options[:lock].present?
          relation = relation.readonly(options[:readonly]) if options.has_key?(:readonly)
1593

1594
          relation = scope.merge(relation) if scope
1595
          relation
1596 1597
        end

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

1614
        def construct_order(order, scope)
1615
          orders = []
P
Pratik Naik 已提交
1616

E
Emilio Tagua 已提交
1617 1618
          scoped_order = scope[:order] if scope
          if order
1619 1620
            orders << order
            orders << scoped_order if scoped_order && scoped_order != order
1621 1622
          elsif scoped_order
            orders << scoped_order
E
Emilio Tagua 已提交
1623
          end
P
Pratik Naik 已提交
1624 1625

          orders.reject {|o| o.blank?}
1626
        end
1627

1628 1629 1630
        def construct_limit(limit, scope)
          limit ||= scope[:limit] if scope
          limit
E
Emilio Tagua 已提交
1631 1632
        end

1633 1634 1635
        def construct_offset(offset, scope)
          offset ||= scope[:offset] if scope
          offset
E
Emilio Tagua 已提交
1636 1637
        end

1638
        def construct_conditions(conditions, scope)
E
Emilio Tagua 已提交
1639 1640 1641 1642 1643 1644
          conditions = [conditions]
          conditions << scope[:conditions] if scope
          conditions << type_condition if finder_needs_type_condition?
          merge_conditions(*conditions)
        end

1645 1646
        # Merges includes so that the result is a valid +include+
        def merge_includes(first, second)
1647
         (Array.wrap(first) + Array.wrap(second)).uniq
1648 1649
        end

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

1663
        def build_association_joins(joins)
1664
          join_dependency = ActiveRecord::Associations::ClassMethods::JoinDependency.new(self, joins, nil)
1665
          relation = active_relation.table
1666
          join_dependency.join_associations.map { |association|
1667
            if (association_relation = association.relation).is_a?(Array)
1668 1669
              [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()
1670
            else
1671
              Arel::InnerJoin.new(relation, association_relation, *association.association_join).joins(relation)
1672 1673 1674 1675
            end
          }.join(" ")
        end

1676 1677 1678 1679
        def array_of_strings?(o)
          o.is_a?(Array) && o.all?{|obj| obj.is_a?(String)}
        end

1680
        def type_condition(table_alias = nil)
1681
          table = Arel::Table.new(table_name, :engine => active_relation_engine, :as => table_alias)
1682 1683 1684 1685

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

1687
          condition.to_sql
D
Initial  
David Heinemeier Hansson 已提交
1688 1689 1690
        end

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

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

1742 1743 1744 1745 1746 1747
        def construct_attributes_from_arguments(attribute_names, arguments)
          attributes = {}
          attribute_names.each_with_index { |name, idx| attributes[name] = arguments[idx] }
          attributes
        end

1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762
        # 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

1763
        def all_attributes_exists?(attribute_names)
1764
          attribute_names = expand_attribute_names_for_aggregates(attribute_names)
1765
          attribute_names.all? { |name| column_methods_hash.include?(name.to_sym) }
1766
        end
1767

1768
        def attribute_condition(quoted_column_name, argument)
1769
          case argument
1770 1771 1772 1773 1774 1775 1776 1777
            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} = ?"
1778 1779 1780
          end
        end

D
Initial  
David Heinemeier Hansson 已提交
1781
      protected
1782
        # Scope parameters to method calls within the block.  Takes a hash of method_name => parameters hash.
1783 1784
        # 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.
1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795
        #
        #   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 已提交
1796
        # In nested scopings, all previous parameters are overwritten by the innermost rule, with the exception of
P
Pratik Naik 已提交
1797 1798 1799 1800 1801
        # <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.
1802 1803 1804 1805
        #
        #   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 已提交
1806
        #         with_scope(:find => { :limit => 10 })
1807 1808 1809 1810 1811 1812 1813 1814 1815
        #           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
        #
1816
        # You can ignore any previous scopings by using the <tt>with_exclusive_scope</tt> method.
1817 1818 1819 1820 1821 1822 1823 1824 1825 1826
        #
        #   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 已提交
1827 1828 1829
        #
        # *Note*: the +:find+ scope also has effect on update and deletion methods,
        # like +update_all+ and +delete_all+.
1830 1831 1832
        def with_scope(method_scoping = {}, action = :merge, &block)
          method_scoping = method_scoping.method_scoping if method_scoping.respond_to?(:method_scoping)

1833 1834 1835 1836 1837 1838
          if method_scoping.is_a?(Hash)
            # 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
1839

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

1842 1843 1844
            if f = method_scoping[:find]
              f.assert_valid_keys(VALID_FIND_OPTIONS)
            end
1845

1846 1847 1848 1849 1850 1851 1852 1853 1854 1855
            relation = construct_finder_arel(method_scoping[:find] || {})

            if current_scoped_methods && current_scoped_methods.create_with_value && method_scoping[:create]
              scope_for_create = case action
              when :merge
                current_scoped_methods.create_with_value.merge(method_scoping[:create])
              when :reverse_merge
                method_scoping[:create].merge(current_scoped_methods.create_with_value)
              else
                method_scoping[:create]
1856
              end
1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874

              relation = relation.create_with(scope_for_create)
            else
              scope_for_create = method_scoping[:create]
              scope_for_create ||= current_scoped_methods.create_with_value if current_scoped_methods
              relation = relation.create_with(scope_for_create) if scope_for_create
            end

            method_scoping = relation
          end

          if current_scoped_methods
            case action
            when :merge
              method_scoping = current_scoped_methods.merge(method_scoping)
            when :reverse_merge
              method_scoping = current_scoped_methods.except(:where).merge(method_scoping)
              method_scoping = method_scoping.merge(current_scoped_methods.only(:where))
1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890
            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 已提交
1891
        def subclasses #:nodoc:
D
Initial  
David Heinemeier Hansson 已提交
1892 1893 1894
          @@subclasses[self] ||= []
          @@subclasses[self] + extra = @@subclasses[self].inject([]) {|list, subclass| list + subclass.subclasses }
        end
1895

1896
        # Sets the default options for the model. The format of the
1897
        # <tt>options</tt> argument is the same as in find.
1898 1899
        #
        #   class Person < ActiveRecord::Base
1900
        #     default_scope :order => 'last_name, first_name'
1901 1902
        #   end
        def default_scope(options = {})
1903
          self.default_scoping << construct_finder_arel(options)
1904 1905
        end

1906
        # Test whether the given method and optional key are scoped.
D
David Heinemeier Hansson 已提交
1907
        def scoped?(method, key = nil) #:nodoc:
1908 1909 1910
          case method
          when :create
            current_scoped_methods.send(:scope_for_create).present? if current_scoped_methods
1911
          end
1912 1913
        end

1914
        def scoped_methods #:nodoc:
1915
          Thread.current[:"#{self}_scoped_methods"] ||= self.default_scoping.dup
1916
        end
1917

D
David Heinemeier Hansson 已提交
1918
        def current_scoped_methods #:nodoc:
1919
          scoped_methods.last
1920
        end
1921

P
Pratik Naik 已提交
1922
        # Returns the class type of the record using the current module as a prefix. So descendants of
1923
        # MyApp::Business::Account would appear as MyApp::Business::AccountSubclass.
D
Initial  
David Heinemeier Hansson 已提交
1924
        def compute_type(type_name)
1925
          modularized_name = type_name_with_module(type_name)
1926 1927 1928 1929 1930 1931
          silence_warnings do
            begin
              class_eval(modularized_name, __FILE__, __LINE__)
            rescue NameError
              class_eval(type_name, __FILE__, __LINE__)
            end
D
Initial  
David Heinemeier Hansson 已提交
1932 1933 1934
          end
        end

P
Pratik Naik 已提交
1935 1936
        # Returns the class descending directly from ActiveRecord::Base or an
        # abstract class, if any, in the inheritance hierarchy.
1937
        def class_of_active_record_descendant(klass)
1938
          if klass.superclass == Base || klass.superclass.abstract_class?
1939
            klass
D
Initial  
David Heinemeier Hansson 已提交
1940 1941 1942
          elsif klass.superclass.nil?
            raise ActiveRecordError, "#{name} doesn't belong in a hierarchy descending from ActiveRecord"
          else
1943
            class_of_active_record_descendant(klass.superclass)
D
Initial  
David Heinemeier Hansson 已提交
1944 1945 1946
          end
        end

P
Pratik Naik 已提交
1947
        # Returns the name of the class descending directly from Active Record in the inheritance hierarchy.
D
David Heinemeier Hansson 已提交
1948
        def class_name_of_active_record_descendant(klass) #:nodoc:
1949
          klass.base_class.name
1950 1951
        end

P
Pratik Naik 已提交
1952
        # Accepts an array, hash, or string of SQL conditions and sanitizes
1953
        # them into a valid SQL fragment for a WHERE clause.
1954 1955 1956
        #   ["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'"
1957
        def sanitize_sql_for_conditions(condition, table_name = self.table_name)
1958 1959
          return nil if condition.blank?

1960 1961
          case condition
            when Array; sanitize_sql_array(condition)
1962
            when Hash;  sanitize_sql_hash_for_conditions(condition, table_name)
1963 1964
            else        condition
          end
1965
        end
1966
        alias_method :sanitize_sql, :sanitize_sql_for_conditions
1967

P
Pratik Naik 已提交
1968
        # Accepts an array, hash, or string of SQL conditions and sanitizes
1969 1970 1971 1972 1973 1974 1975 1976 1977 1978
        # 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

1979 1980 1981 1982 1983
        def aggregate_mapping(reflection)
          mapping = reflection.options[:mapping] || [reflection.name, reflection.name]
          mapping.first.is_a?(Array) ? mapping : [mapping]
        end

P
Pratik Naik 已提交
1984
        # Accepts a hash of SQL conditions and replaces those attributes
1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013
        # 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

2014
        # Sanitizes a hash of attribute/value pairs into SQL conditions for a WHERE clause.
2015 2016 2017 2018
        #   { :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)"
2019 2020
        #   { :age => 13..18 }
        #     # => "age BETWEEN 13 AND 18"
2021 2022
        #   { 'other_records.id' => 7 }
        #     # => "`other_records`.`id` = 7"
2023 2024
        #   { :other_records => { :id => 7 } }
        #     # => "`other_records`.`id` = 7"
2025 2026 2027
        # 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'"
2028
        def sanitize_sql_hash_for_conditions(attrs, default_table_name = self.table_name)
2029 2030
          attrs = expand_hash_conditions_for_aggregates(attrs)

2031
          table = Arel::Table.new(self.table_name, :engine => active_relation_engine, :as => default_table_name)
2032
          builder = PredicateBuilder.new(active_relation_engine)
2033
          builder.build_from_hash(attrs, table).map(&:to_sql).join(' AND ')
2034
        end
2035 2036 2037 2038 2039 2040
        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)
2041
          attrs.map do |attr, value|
2042 2043 2044
            "#{connection.quote_column_name(attr)} = #{quote_bound_value(value)}"
          end.join(', ')
        end
2045

2046
        # Accepts an array of conditions.  The array has each value
P
Pratik Naik 已提交
2047
        # sanitized and interpolated into the SQL statement.
2048
        #   ["name='%s' and group_id='%s'", "foo'bar", 4]  returns  "name='foo''bar' and group_id='4'"
2049
        def sanitize_sql_array(ary)
2050 2051 2052 2053
          statement, *values = ary
          if values.first.is_a?(Hash) and statement =~ /:\w+/
            replace_named_bind_variables(statement, values.first)
          elsif statement.include?('?')
2054 2055
            replace_bind_variables(statement, values)
          else
2056
            statement % values.collect { |value| connection.quote_string(value.to_s) }
2057
          end
2058 2059
        end

2060 2061
        alias_method :sanitize_conditions, :sanitize_sql

D
David Heinemeier Hansson 已提交
2062
        def replace_bind_variables(statement, values) #:nodoc:
2063
          raise_if_bind_arity_mismatch(statement, statement.count('?'), values.size)
2064
          bound = values.dup
2065
          statement.gsub('?') { quote_bound_value(bound.shift) }
2066 2067
        end

D
David Heinemeier Hansson 已提交
2068
        def replace_named_bind_variables(statement, bind_vars) #:nodoc:
2069 2070 2071 2072
          statement.gsub(/(:?):([a-zA-Z]\w*)/) do
            if $1 == ':' # skip postgresql casts
              $& # return the whole match
            elsif bind_vars.include?(match = $2.to_sym)
2073
              quote_bound_value(bind_vars[match])
2074 2075
            else
              raise PreparedStatementInvalid, "missing value for :#{match} in #{statement}"
2076 2077
            end
          end
2078 2079
        end

2080
        def expand_range_bind_variables(bind_vars) #:nodoc:
2081 2082 2083
          expanded = []

          bind_vars.each do |var|
2084 2085
            next if var.is_a?(Hash)

2086
            if var.is_a?(Range)
2087 2088
              expanded << var.first
              expanded << var.last
2089
            else
2090
              expanded << var
2091
            end
2092
          end
2093 2094

          expanded
2095 2096
        end

D
David Heinemeier Hansson 已提交
2097
        def quote_bound_value(value) #:nodoc:
2098
          if value.respond_to?(:map) && !value.acts_like?(:string)
2099 2100
            if value.respond_to?(:empty?) && value.empty?
              connection.quote(nil)
2101 2102 2103
            else
              value.map { |v| connection.quote(v) }.join(',')
            end
2104 2105
          else
            connection.quote(value)
2106 2107 2108
          end
        end

D
David Heinemeier Hansson 已提交
2109
        def raise_if_bind_arity_mismatch(statement, expected, provided) #:nodoc:
2110 2111 2112
          unless expected == provided
            raise PreparedStatementInvalid, "wrong number of bind variables (#{provided} for #{expected}) in: #{statement}"
          end
2113
        end
2114

2115
        VALID_FIND_OPTIONS = [ :conditions, :include, :joins, :limit, :offset,
2116
                               :order, :select, :readonly, :group, :having, :from, :lock ]
2117

D
David Heinemeier Hansson 已提交
2118
        def validate_find_options(options) #:nodoc:
2119 2120
          options.assert_valid_keys(VALID_FIND_OPTIONS)
        end
2121

D
David Heinemeier Hansson 已提交
2122
        def encode_quoted_value(value) #:nodoc:
2123
          quoted_value = connection.quote(value)
2124 2125
          quoted_value = "'#{quoted_value[1..-2].gsub(/\'/, "\\\\'")}'" if quoted_value.include?("\\\'") # (for ruby mode) "
          quoted_value
2126
        end
D
Initial  
David Heinemeier Hansson 已提交
2127 2128 2129 2130 2131
    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).
2132
      # In both instances, valid attribute keys are determined by the column names of the associated table --
D
Initial  
David Heinemeier Hansson 已提交
2133 2134
      # hence you can't have attributes that aren't part of the table columns.
      def initialize(attributes = nil)
2135
        initialize_attribute_store(attributes_from_column_definition)
2136
        @attributes_cache = {}
D
Initial  
David Heinemeier Hansson 已提交
2137 2138 2139
        @new_record = true
        ensure_proper_type
        self.attributes = attributes unless attributes.nil?
P
Pratik Naik 已提交
2140 2141 2142 2143 2144 2145

        if scope = self.class.send(:current_scoped_methods)
          create_with = scope.scope_for_create
          create_with.each { |att,value| self.send("#{att}=", value) } if create_with
        end

2146
        result = yield self if block_given?
2147
        _run_initialize_callbacks
2148
        result
D
Initial  
David Heinemeier Hansson 已提交
2149
      end
2150

2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165
      # 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)
2166
        initialize_attribute_store(cloned_attributes)
2167 2168 2169 2170 2171 2172 2173
        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 已提交
2174 2175 2176 2177
      # 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 已提交
2178 2179 2180
      # 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 已提交
2181 2182
      #
      #   user = User.find_by_name('Phusion')
2183
      #   user_path(user)  # => "/users/1"
P
Pratik Naik 已提交
2184
      #
P
Pratik Naik 已提交
2185 2186
      # 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 已提交
2187 2188 2189 2190 2191 2192
      #
      #   class User < ActiveRecord::Base
      #     def to_param  # overridden
      #       name
      #     end
      #   end
E
Emilio Tagua 已提交
2193
      #
P
Pratik Naik 已提交
2194
      #   user = User.find_by_name('Phusion')
2195
      #   user_path(user)  # => "/users/Phusion"
2196
      def to_param
2197
        # We can't use alias_method here, because method 'id' optimizes itself on the fly.
2198
        (id = self.id) ? id.to_s : nil # Be sure to stringify the id for routes
2199
      end
2200

P
Pratik Naik 已提交
2201 2202 2203
      # Returns a cache key that can be used to identify this record.
      #
      # ==== Examples
2204 2205 2206 2207 2208
      #
      #   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
2209
        case
2210
        when new_record?
J
Jeremy Kemper 已提交
2211 2212 2213
          "#{self.class.model_name.cache_key}/new"
        when timestamp = self[:updated_at]
          "#{self.class.model_name.cache_key}/#{id}-#{timestamp.to_s(:number)}"
2214
        else
J
Jeremy Kemper 已提交
2215
          "#{self.class.model_name.cache_key}/#{id}"
2216 2217
        end
      end
2218

2219
      def quoted_id #:nodoc:
2220
        quote_value(id, column_for_attribute(self.class.primary_key))
2221
      end
2222

2223
      # Returns true if this object hasn't been saved yet -- that is, a record for the object doesn't exist yet; otherwise, returns false.
2224
      def new_record?
2225
        @new_record || false
2226
      end
2227

2228 2229 2230 2231 2232
      # Returns true if this object has been destroyed, otherwise returns false.
      def destroyed?
        @destroyed || false
      end

P
Pratik Naik 已提交
2233 2234
      # :call-seq:
      #   save(perform_validation = true)
2235
      #
P
Pratik Naik 已提交
2236 2237 2238 2239 2240 2241 2242 2243
      # 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 已提交
2244
      # ActiveRecord::Validations for more information.
P
Pratik Naik 已提交
2245 2246 2247 2248
      #
      # 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 已提交
2249
      # details.
D
Initial  
David Heinemeier Hansson 已提交
2250 2251 2252
      def save
        create_or_update
      end
2253

P
Pratik Naik 已提交
2254 2255 2256 2257 2258 2259 2260
      # 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 已提交
2261
      # for more information.
P
Pratik Naik 已提交
2262 2263 2264 2265
      #
      # 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 已提交
2266
      # ActiveRecord::Callbacks for further details.
2267
      def save!
2268
        create_or_update || raise(RecordNotSaved)
2269
      end
2270

P
Pratik Naik 已提交
2271 2272 2273
      # 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.
2274
      #
P
Pratik Naik 已提交
2275 2276 2277 2278 2279 2280
      # 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>.
2281 2282
      def delete
        self.class.delete(id) unless new_record?
2283
        @destroyed = true
2284 2285 2286
        freeze
      end

D
Initial  
David Heinemeier Hansson 已提交
2287 2288 2289
      # 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
2290
        unless new_record?
2291
          self.class.active_relation.where(self.class.active_relation[self.class.primary_key].eq(id)).delete_all
D
Initial  
David Heinemeier Hansson 已提交
2292 2293
        end

2294
        @destroyed = true
D
Initial  
David Heinemeier Hansson 已提交
2295 2296 2297
        freeze
      end

2298
      # Returns an instance of the specified +klass+ with the attributes of the current record. This is mostly useful in relation to
2299
      # single-table inheritance structures where you want a subclass to appear as the superclass. This can be used along with record
2300
      # identification in Action Pack to allow, say, <tt>Client < Company</tt> to do something like render <tt>:partial => @client.becomes(Company)</tt>
2301 2302 2303 2304 2305
      # 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 已提交
2306 2307 2308 2309 2310
        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
2311 2312
      end

2313 2314 2315
      # 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 已提交
2316
      def update_attribute(name, value)
2317
        send(name.to_s + '=', value)
2318
        save(false)
2319 2320
      end

2321
      # Updates all the attributes from the passed-in Hash and saves the record. If the object is invalid, the saving will
2322
      # fail and false will be returned.
2323
      def update_attributes(attributes)
2324
        self.attributes = attributes
2325
        save
D
Initial  
David Heinemeier Hansson 已提交
2326
      end
2327

2328 2329 2330 2331 2332
      # 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 已提交
2333

P
Pratik Naik 已提交
2334 2335 2336
      # 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+.
2337
      def increment(attribute, by = 1)
2338
        self[attribute] ||= 0
2339
        self[attribute] += by
2340 2341
        self
      end
2342

P
Pratik Naik 已提交
2343 2344 2345 2346
      # 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.
2347 2348
      def increment!(attribute, by = 1)
        increment(attribute, by).update_attribute(attribute, self[attribute])
2349 2350
      end

P
Pratik Naik 已提交
2351 2352 2353
      # 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+.
2354
      def decrement(attribute, by = 1)
2355
        self[attribute] ||= 0
2356
        self[attribute] -= by
2357 2358 2359
        self
      end

P
Pratik Naik 已提交
2360 2361 2362 2363
      # 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.
2364 2365
      def decrement!(attribute, by = 1)
        decrement(attribute, by).update_attribute(attribute, self[attribute])
2366
      end
2367

P
Pratik Naik 已提交
2368 2369 2370 2371
      # 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+.
2372
      def toggle(attribute)
2373
        self[attribute] = !send("#{attribute}?")
2374 2375 2376
        self
      end

P
Pratik Naik 已提交
2377 2378 2379 2380
      # 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.
2381 2382 2383 2384
      def toggle!(attribute)
        toggle(attribute).update_attribute(attribute, self[attribute])
      end

2385
      # Reloads the attributes of this object from the database.
2386 2387 2388 2389
      # 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)
2390
        clear_aggregation_cache
2391
        clear_association_cache
2392
        _attributes.update(self.class.find(self.id, options).instance_variable_get('@attributes'))
2393
        @attributes_cache = {}
2394
        self
2395 2396
      end

2397
      # Returns the value of the attribute identified by <tt>attr_name</tt> after it has been typecast (for example,
D
Initial  
David Heinemeier Hansson 已提交
2398 2399
      # "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).
2400
      def [](attr_name)
2401
        read_attribute(attr_name)
D
Initial  
David Heinemeier Hansson 已提交
2402
      end
2403

D
Initial  
David Heinemeier Hansson 已提交
2404 2405
      # Updates the attribute identified by <tt>attr_name</tt> with the specified +value+.
      # (Alias for the protected write_attribute method).
2406
      def []=(attr_name, value)
2407
        write_attribute(attr_name, value)
D
Initial  
David Heinemeier Hansson 已提交
2408 2409 2410
      end

      # Allows you to set all the attributes at once by passing in a hash with keys
P
Pratik Naik 已提交
2411 2412 2413 2414 2415 2416
      # 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
2417
      # attributes not included in that won't be allowed to be mass-assigned.
P
Pratik Naik 已提交
2418 2419 2420 2421
      #
      #   class User < ActiveRecord::Base
      #     attr_protected :is_admin
      #   end
E
Emilio Tagua 已提交
2422
      #
P
Pratik Naik 已提交
2423 2424 2425 2426
      #   user = User.new
      #   user.attributes = { :username => 'Phusion', :is_admin => true }
      #   user.username   # => "Phusion"
      #   user.is_admin?  # => false
E
Emilio Tagua 已提交
2427
      #
P
Pratik Naik 已提交
2428 2429
      #   user.send(:attributes=, { :username => 'Phusion', :is_admin => true }, false)
      #   user.is_admin?  # => true
2430
      def attributes=(new_attributes, guard_protected_attributes = true)
D
David Heinemeier Hansson 已提交
2431 2432
        return if new_attributes.nil?
        attributes = new_attributes.dup
2433
        attributes.stringify_keys!
D
Initial  
David Heinemeier Hansson 已提交
2434 2435

        multi_parameter_attributes = []
2436
        attributes = remove_attributes_protected_from_mass_assignment(attributes) if guard_protected_attributes
2437

2438
        attributes.each do |k, v|
2439 2440 2441 2442 2443
          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 已提交
2444
        end
D
David Heinemeier Hansson 已提交
2445

D
Initial  
David Heinemeier Hansson 已提交
2446 2447 2448
        assign_multiparameter_attributes(multi_parameter_attributes)
      end

2449
      # Returns a hash of all the attributes with their names as keys and the values of the attributes as values.
2450
      def attributes
2451 2452
        self.attribute_names.inject({}) do |attrs, name|
          attrs[name] = read_attribute(name)
2453
          attrs
2454
        end
2455 2456
      end

P
Pratik Naik 已提交
2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469
      # 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"'
2470 2471 2472
      def attribute_for_inspect(attr_name)
        value = read_attribute(attr_name)

2473
        if value.is_a?(String) && value.length > 50
2474
          "#{value[0..50]}...".inspect
2475 2476
        elsif value.is_a?(Date) || value.is_a?(Time)
          %("#{value.to_s(:db)}")
2477 2478 2479 2480 2481
        else
          value.inspect
        end
      end

D
Initial  
David Heinemeier Hansson 已提交
2482
      # Returns true if the specified +attribute+ has been set by the user or by a database load and is neither
2483
      # nil nor empty? (the latter only applies to objects that respond to empty?, most notably Strings).
D
Initial  
David Heinemeier Hansson 已提交
2484
      def attribute_present?(attribute)
2485
        value = read_attribute(attribute)
2486
        !value.blank?
D
Initial  
David Heinemeier Hansson 已提交
2487 2488 2489 2490
      end

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

2494
      # 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 已提交
2495
      def ==(comparison_object)
2496
        comparison_object.equal?(self) ||
2497 2498
          (comparison_object.instance_of?(self.class) &&
            comparison_object.id == id &&
2499
            !comparison_object.new_record?)
D
Initial  
David Heinemeier Hansson 已提交
2500 2501 2502 2503 2504 2505
      end

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

D
Initial  
David Heinemeier Hansson 已提交
2507 2508 2509
      # 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
2510
        id.hash
D
Initial  
David Heinemeier Hansson 已提交
2511 2512
      end

2513
      # Freeze the attributes hash such that associations are still accessible, even on destroyed records.
2514
      def freeze
2515
        @attributes.freeze; self
2516
      end
2517

2518
      # Returns +true+ if the attributes hash has been frozen.
2519 2520 2521
      def frozen?
        @attributes.frozen?
      end
2522

2523 2524 2525 2526 2527 2528 2529
      # Returns duplicated record with unfreezed attributes.
      def dup
        obj = super
        obj.instance_variable_set('@attributes', instance_variable_get('@attributes').dup)
        obj
      end

2530 2531
      # 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.
2532
      def readonly?
2533
        defined?(@readonly) && @readonly == true
2534 2535
      end

2536 2537
      # Marks this record as read only.
      def readonly!
2538 2539
        @readonly = true
      end
2540

2541
      # Returns the contents of the record as a nicely formatted string.
2542
      def inspect
2543
        attributes_as_nice_string = self.class.column_names.collect { |name|
2544 2545 2546 2547
          if has_attribute?(name) || new_record?
            "#{name}: #{attribute_for_inspect(name)}"
          end
        }.compact.join(", ")
2548
        "#<#{self.class} #{attributes_as_nice_string}>"
2549
      end
2550

2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565
    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 已提交
2566 2567
    private
      def create_or_update
2568
        raise ReadOnlyRecord if readonly?
2569 2570
        result = new_record? ? create : update
        result != false
D
Initial  
David Heinemeier Hansson 已提交
2571 2572
      end

2573
      # Updates the associated record with values matching those of the instance attributes.
2574
      # Returns the number of affected rows.
2575
      def update(attribute_names = @attributes.keys)
2576 2577
        attributes_with_values = arel_attributes_values(false, false, attribute_names)
        return 0 if attributes_with_values.empty?
2578
        self.class.active_relation.where(self.class.active_relation[self.class.primary_key].eq(id)).update(attributes_with_values)
D
Initial  
David Heinemeier Hansson 已提交
2579 2580
      end

2581 2582
      # Creates a record with values matching those of the instance attributes
      # and returns its id.
D
Initial  
David Heinemeier Hansson 已提交
2583
      def create
2584
        if self.id.nil? && connection.prefetch_primary_key?(self.class.table_name)
2585 2586
          self.id = connection.next_sequence_value(self.class.sequence_name)
        end
2587

E
Emilio Tagua 已提交
2588 2589 2590
        attributes_values = arel_attributes_values

        new_id = if attributes_values.empty?
2591
          self.class.active_relation.insert connection.empty_insert_statement_value
2592
        else
2593
          self.class.active_relation.insert attributes_values
2594 2595
        end

2596
        self.id ||= new_id
2597

D
Initial  
David Heinemeier Hansson 已提交
2598
        @new_record = false
2599
        id
D
Initial  
David Heinemeier Hansson 已提交
2600 2601
      end

P
Pratik Naik 已提交
2602
      # Sets the attribute used for single table inheritance to this class name if this is not the ActiveRecord::Base descendant.
P
Pratik Naik 已提交
2603 2604
      # 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 已提交
2605 2606 2607
      # Message class in that example.
      def ensure_proper_type
        unless self.class.descends_from_active_record?
2608
          write_attribute(self.class.inheritance_column, self.class.sti_name)
D
Initial  
David Heinemeier Hansson 已提交
2609 2610 2611 2612
        end
      end

      def remove_attributes_protected_from_mass_assignment(attributes)
2613 2614 2615 2616
        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?
2617
            attributes.reject { |key, value| !self.class.accessible_attributes.include?(key.gsub(/\(.+/, "")) || attributes_protected_by_default.include?(key.gsub(/\(.+/, "")) }
2618
          elsif self.class.accessible_attributes.nil?
2619
            attributes.reject { |key, value| self.class.protected_attributes.include?(key.gsub(/\(.+/,"")) || attributes_protected_by_default.include?(key.gsub(/\(.+/, "")) }
2620 2621 2622 2623 2624 2625 2626
          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?
2627
          log_protected_attribute_removal(removed_attributes)
D
Initial  
David Heinemeier Hansson 已提交
2628
        end
2629 2630

        safe_attributes
D
Initial  
David Heinemeier Hansson 已提交
2631
      end
2632

2633 2634 2635
      # Removes attributes which have been marked as readonly.
      def remove_readonly_attributes(attributes)
        unless self.class.readonly_attributes.nil?
2636
          attributes.delete_if { |key, value| self.class.readonly_attributes.include?(key.gsub(/\(.+/,"")) }
2637 2638 2639 2640
        else
          attributes
        end
      end
D
Initial  
David Heinemeier Hansson 已提交
2641

2642
      def log_protected_attribute_removal(*attributes)
2643 2644 2645
        if logger
          logger.debug "WARNING: Can't mass-assign these protected attributes: #{attributes.join(', ')}"
        end
2646 2647
      end

2648 2649
      # The primary key and inheritance column can never be set by mass-assignment for security reasons.
      def attributes_protected_by_default
2650 2651 2652
        default = [ self.class.primary_key, self.class.inheritance_column ]
        default << 'id' unless self.class.primary_key.eql? 'id'
        default
2653 2654
      end

2655
      # Returns a copy of the attributes hash where all the values have been safely quoted for use in
2656
      # an SQL statement.
2657
      def attributes_with_quotes(include_primary_key = true, include_readonly_attributes = true, attribute_names = @attributes.keys)
2658
        quoted = {}
2659
        connection = self.class.connection
2660
        attribute_names.each do |name|
2661 2662 2663 2664 2665 2666 2667 2668 2669
          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)
2670
          end
D
Initial  
David Heinemeier Hansson 已提交
2671
        end
2672
        include_readonly_attributes ? quoted : remove_readonly_attributes(quoted)
D
Initial  
David Heinemeier Hansson 已提交
2673
      end
2674

2675 2676
      # Returns a copy of the attributes hash where all the values have been safely quoted for use in
      # an Arel insert/update method.
2677 2678 2679 2680 2681 2682
      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))
2683 2684 2685
              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))
2686 2687
                value = value.to_yaml
              end
2688
              attrs[self.class.active_relation[name]] = value
2689 2690 2691 2692 2693 2694
            end
          end
        end
        attrs
      end

D
Initial  
David Heinemeier Hansson 已提交
2695
      # Quote strings appropriately for SQL statements.
2696
      def quote_value(value, column = nil)
2697
        self.class.connection.quote(value, column)
D
Initial  
David Heinemeier Hansson 已提交
2698 2699
      end

P
Pratik Naik 已提交
2700
      # Interpolate custom SQL string in instance context.
D
Initial  
David Heinemeier Hansson 已提交
2701 2702
      # Optional record argument is meant for custom insert_sql.
      def interpolate_sql(sql, record = nil)
2703
        instance_eval("%@#{sql.gsub('@', '\@')}@")
D
Initial  
David Heinemeier Hansson 已提交
2704 2705 2706 2707 2708 2709 2710
      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
2711
        self.class.columns.inject({}) do |attributes, column|
2712
          attributes[column.name] = column.default unless column.name == self.class.primary_key
D
Initial  
David Heinemeier Hansson 已提交
2713 2714 2715 2716 2717 2718 2719 2720
          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
2721
      # parentheses to have the parameters typecasted before they're used in the constructor. Use i for Fixnum, f for Float,
2722
      # 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 已提交
2723 2724 2725 2726 2727
      def assign_multiparameter_attributes(pairs)
        execute_callstack_for_multiparameter_attributes(
          extract_callstack_for_multiparameter_attributes(pairs)
        )
      end
2728

2729
      def instantiate_time_object(name, values)
2730
        if self.class.send(:time_zone_aware?, name)
2731
          Time.zone.local(*values)
2732
        else
2733
          Time.time_with_datetime_fallback(@@default_timezone, *values)
2734
        end
2735 2736
      end

D
Initial  
David Heinemeier Hansson 已提交
2737
      def execute_callstack_for_multiparameter_attributes(callstack)
2738
        errors = []
2739
        callstack.each do |name, values_with_empty_parameters|
2740 2741
          begin
            klass = (self.class.reflect_on_aggregation(name.to_sym) || column_for_attribute(name)).klass
2742 2743 2744 2745
            # 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?)

2746 2747 2748
            if values.empty?
              send(name + "=", nil)
            else
2749

2750
              value = if Time == klass
2751
                instantiate_time_object(name, values)
2752 2753
              elsif Date == klass
                begin
2754
                  values = values_with_empty_parameters.collect do |v| v.nil? ? 1 : v end
2755 2756
                  Date.new(*values)
                rescue ArgumentError => ex # if Date.new raises an exception on an invalid date
2757
                  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
2758 2759 2760 2761 2762 2763
                end
              else
                klass.new(*values)
              end

              send(name + "=", value)
2764
            end
2765 2766
          rescue => ex
            errors << AttributeAssignmentError.new("error on assignment #{values.inspect} to #{name}", ex, name)
D
Initial  
David Heinemeier Hansson 已提交
2767 2768
          end
        end
2769 2770 2771
        unless errors.empty?
          raise MultiparameterAssignmentErrors.new(errors), "#{errors.size} error(s) on assignment of multiparameter attributes"
        end
D
Initial  
David Heinemeier Hansson 已提交
2772
      end
2773

D
Initial  
David Heinemeier Hansson 已提交
2774 2775 2776 2777 2778 2779 2780 2781
      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)

2782 2783
          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 已提交
2784 2785 2786 2787
        end

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

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

D
Initial  
David Heinemeier Hansson 已提交
2793 2794 2795
      def find_parameter_position(multiparameter_name)
        multiparameter_name.scan(/\(([0-9]*).*\)/).first.first
      end
2796

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

2802 2803 2804 2805
      def self.quoted_table_name
        self.connection.quote_table_name(self.table_name)
      end

2806 2807 2808 2809
      def quote_columns(quoter, hash)
        hash.inject({}) do |quoted, (name, value)|
          quoted[quoter.quote_column_name(name)] = value
          quoted
2810
        end
D
Initial  
David Heinemeier Hansson 已提交
2811 2812
      end

2813 2814
      def quoted_comma_pair_list(quoter, hash)
        comma_pair_list(quote_columns(quoter, hash))
D
Initial  
David Heinemeier Hansson 已提交
2815 2816 2817
      end

  end
J
Joshua Peek 已提交
2818 2819

  Base.class_eval do
J
Joshua Peek 已提交
2820
    extend ActiveModel::Naming
J
Joshua Peek 已提交
2821
    extend QueryCache::ClassMethods
J
José Valim 已提交
2822 2823
    extend ActiveSupport::Benchmarkable

J
Joshua Peek 已提交
2824 2825 2826
    include Validations
    include Locking::Optimistic, Locking::Pessimistic
    include AttributeMethods
J
Joshua Peek 已提交
2827
    include AttributeMethods::Read, AttributeMethods::Write, AttributeMethods::BeforeTypeCast, AttributeMethods::Query
2828
    include AttributeMethods::PrimaryKey
J
Joshua Peek 已提交
2829 2830
    include AttributeMethods::TimeZoneConversion
    include AttributeMethods::Dirty
2831
    include Attributes, Types
2832
    include Callbacks, ActiveModel::Observing, Timestamp
J
Joshua Peek 已提交
2833
    include Associations, AssociationPreload, NamedScope
J
Joshua Peek 已提交
2834
    include ActiveModel::Conversion
2835 2836 2837 2838 2839

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

2840
    include Aggregations, Transactions, Reflection, Batches, Calculations, Serialization
2841

J
Joshua Peek 已提交
2842
  end
2843
end
2844 2845 2846

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