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

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

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

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

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

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

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

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

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

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

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

70 71 72 73 74 75 76 77 78 79 80
  # 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

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

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

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

  # 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 已提交
104
  # Read more about optimistic locking in ActiveRecord::Locking module RDoc.
105
  class StaleObjectError < ActiveRecordError
106
  end
107 108 109 110

  # 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
111
  end
112 113 114

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

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

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

P
Pratik Naik 已提交
151 152
  # Raised when you've tried to access a column which wasn't loaded by your finder.
  # Typically this is because <tt>:select</tt> has been specified.
153 154
  class MissingAttributeError < NoMethodError
  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
P
Pratik Naik 已提交
429 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 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483
    # Contains the database configuration - as is typically stored in config/database.yml -
    # as a Hash.
    #
    # For example, the following database.yml...
    # 
    #   development:
    #     adapter: sqlite3
    #     database: db/development.sqlite3
    #   
    #   production:
    #     adapter: sqlite3
    #     database: db/production.sqlite3
    #
    # ...would result in ActiveRecord::Base.configurations to look like this:
    #
    #   {
    #      'development' => {
    #         'adapter'  => 'sqlite3',
    #         'database' => 'db/development.sqlite3'
    #      },
    #      'production' => {
    #         'adapter'  => 'sqlite3',
    #         'database' => 'db/production.sqlite3'
    #      }
    #   }
484
    cattr_accessor :configurations, :instance_writer => false
485 486
    @@configurations = {}

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

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

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

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

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

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

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

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

551 552 553
    # Determine whether to store the full constant name including namespace when using STI
    superclass_delegating_accessor :store_full_sti_class
    self.store_full_sti_class = false
554

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

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

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

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

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

669 670 671 672 673
      # This is an alias for find(:all).  You can pass in all the same arguments to this method as you can
      # to find(:all)
      def all(*args)
        find(:all, *args)
      end
674

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

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

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

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

P
Pratik Naik 已提交
792 793 794 795 796
      # 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.
797
      #
P
Pratik Naik 已提交
798
      # You can delete multiple rows at once by passing an Array of <tt>id</tt>s.
799
      #
P
Pratik Naik 已提交
800 801 802 803
      # 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.
804 805 806
      #
      # ==== Examples
      #
P
Pratik Naik 已提交
807
      #   # Delete a single row
808
      #   Todo.delete(1)
809
      #
P
Pratik Naik 已提交
810 811
      #   # Delete multiple rows
      #   Todo.delete([2,3,4])
812
      def delete(id)
813
        delete_all([ "#{connection.quote_column_name(primary_key)} IN (?)", id ])
814
      end
815

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

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

870
        scope = scope(:find)
871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886

        select_sql = ""
        add_conditions!(select_sql, conditions, scope)

        if options.has_key?(:limit) || (scope && scope[:limit])
          # Only take order from scope if limit is also provided by scope, this
          # is useful for updating a has_many association with a limit.
          add_order!(select_sql, options[:order], scope)

          add_limit!(select_sql, options, scope)
          sql.concat(connection.limited_update_conditions(select_sql, quoted_table_name, connection.quote_column_name(primary_key)))
        else
          add_order!(select_sql, options[:order], nil)
          sql.concat(select_sql)
        end

887
        connection.update(sql, "#{name} Update")
D
Initial  
David Heinemeier Hansson 已提交
888
      end
889

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

920
      # Deletes the records matching +conditions+ without instantiating the records first, and hence not
P
Pratik Naik 已提交
921
      # calling the +destroy+ method nor invoking callbacks. This is a single SQL DELETE statement that
P
Pratik Naik 已提交
922
      # goes straight to the database, much more efficient than +destroy_all+. Be careful with relations
P
Pratik Naik 已提交
923 924
      # though, in particular <tt>:dependent</tt> rules defined on associations are not honored.  Returns
      # the number of rows affected.
925
      #
P
Pratik Naik 已提交
926
      # ==== Parameters
927
      #
P
Pratik Naik 已提交
928
      # * +conditions+ - Conditions are specified the same way as with +find+ method.
929 930 931
      #
      # ==== Example
      #
P
Pratik Naik 已提交
932 933
      #   Post.delete_all("person_id = 5 AND (category = 'Something' OR category = 'Else')")
      #   Post.delete_all(["person_id = ? AND (category = ? OR category = ?)", 5, 'Something', 'Else'])
934
      #
P
Pratik Naik 已提交
935
      # Both calls delete the affected posts all at once with a single DELETE statement. If you need to destroy dependent
P
Pratik Naik 已提交
936
      # associations or call your <tt>before_*</tt> or +after_destroy+ callbacks, use the +destroy_all+ method instead.
D
Initial  
David Heinemeier Hansson 已提交
937
      def delete_all(conditions = nil)
938
        sql = "DELETE FROM #{quoted_table_name} "
939
        add_conditions!(sql, conditions, scope(:find))
D
Initial  
David Heinemeier Hansson 已提交
940 941 942 943
        connection.delete(sql, "#{name} Delete all")
      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 962 963 964
      # 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 已提交
965
      # ==== Parameters
966
      #
967
      # * +id+ - The id of the object you wish to update a counter on or an Array of ids.
P
Pratik Naik 已提交
968 969
      # * +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.
970
      #
971
      # ==== Examples
972 973
      #
      #   # For the Post with id of 5, decrement the comment_count by 1, and
974
      #   # increment the action_count by 1
975
      #   Post.update_counters 5, :comment_count => -1, :action_count => 1
976
      #   # Executes the following SQL:
977 978 979 980
      #   # UPDATE posts
      #   #    SET comment_count = comment_count - 1,
      #   #        action_count = action_count + 1
      #   #  WHERE id = 5
981 982 983 984 985 986 987
      #
      #   # 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)
988 989 990
      def update_counters(id, counters)
        updates = counters.inject([]) { |list, (counter_name, increment)|
          sign = increment < 0 ? "-" : "+"
991
          list << "#{connection.quote_column_name(counter_name)} = COALESCE(#{connection.quote_column_name(counter_name)}, 0) #{sign} #{increment.abs}"
992
        }.join(", ")
993 994 995 996 997 998 999 1000 1001

        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}")
1002 1003
      end

1004 1005
      # Increment a number field by one, usually representing a count.
      #
1006 1007
      # 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
1008
      # shown it would have to run an SQL query to find how many posts and comments there are.
1009
      #
P
Pratik Naik 已提交
1010
      # ==== Parameters
1011
      #
P
Pratik Naik 已提交
1012 1013
      # * +counter_name+ - The name of the field that should be incremented.
      # * +id+ - The id of the object that should be incremented.
1014 1015 1016 1017 1018
      #
      # ==== 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 已提交
1019
      def increment_counter(counter_name, id)
1020
        update_counters(id, counter_name => 1)
D
Initial  
David Heinemeier Hansson 已提交
1021 1022
      end

1023 1024 1025 1026
      # 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 已提交
1027
      # ==== Parameters
1028
      #
P
Pratik Naik 已提交
1029 1030
      # * +counter_name+ - The name of the field that should be decremented.
      # * +id+ - The id of the object that should be decremented.
1031 1032 1033 1034 1035
      #
      # ==== 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 已提交
1036
      def decrement_counter(counter_name, id)
1037
        update_counters(id, counter_name => -1)
D
Initial  
David Heinemeier Hansson 已提交
1038 1039
      end

P
Pratik Naik 已提交
1040 1041 1042 1043 1044 1045 1046 1047 1048
      # 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 已提交
1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060
      #
      #   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"
1061
      #
P
Pratik Naik 已提交
1062 1063
      # To start from an all-closed default and enable attributes as needed,
      # have a look at +attr_accessible+.
P
Pratik Naik 已提交
1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078
      #
      # 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.
      # 
      # 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 已提交
1079
      def attr_protected(*attributes)
1080
        write_inheritable_attribute(:attr_protected, Set.new(attributes.map {|a| a.to_s}) + (protected_attributes || []))
D
Initial  
David Heinemeier Hansson 已提交
1081
      end
1082

1083
      # Returns an array of all the attributes that have been protected from mass-assignment.
D
Initial  
David Heinemeier Hansson 已提交
1084
      def protected_attributes # :nodoc:
1085
        read_inheritable_attribute(:attr_protected)
D
Initial  
David Heinemeier Hansson 已提交
1086 1087
      end

P
Pratik Naik 已提交
1088 1089 1090 1091
      # 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>
1092
      #
P
Pratik Naik 已提交
1093 1094 1095 1096 1097 1098 1099
      # 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+.
1100 1101
      #
      #   class Customer < ActiveRecord::Base
1102
      #     attr_accessible :name, :nickname
1103 1104
      #   end
      #
1105 1106 1107 1108
      #   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
1109
      #
1110 1111
      #   customer.credit_rating = "Average"
      #   customer.credit_rating # => "Average"
P
Pratik Naik 已提交
1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126
      #
      # 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.
      # 
      # 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 已提交
1127
      def attr_accessible(*attributes)
1128
        write_inheritable_attribute(:attr_accessible, Set.new(attributes.map(&:to_s)) + (accessible_attributes || []))
D
Initial  
David Heinemeier Hansson 已提交
1129
      end
1130

1131
      # Returns an array of all the attributes that have been made accessible to mass-assignment.
D
Initial  
David Heinemeier Hansson 已提交
1132
      def accessible_attributes # :nodoc:
1133
        read_inheritable_attribute(:attr_accessible)
D
Initial  
David Heinemeier Hansson 已提交
1134 1135
      end

1136 1137
       # Attributes listed as readonly can be set for a new record, but will be ignored in database updates afterwards.
       def attr_readonly(*attributes)
1138
         write_inheritable_attribute(:attr_readonly, Set.new(attributes.map(&:to_s)) + (readonly_attributes || []))
1139 1140 1141 1142
       end

       # Returns an array of all the attributes that have been specified as readonly.
       def readonly_attributes
1143
         read_inheritable_attribute(:attr_readonly)
1144
       end
D
David Heinemeier Hansson 已提交
1145

1146 1147 1148
      # 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 已提交
1149
      # class on retrieval or SerializationTypeMismatch will be raised.
D
David Heinemeier Hansson 已提交
1150
      #
P
Pratik Naik 已提交
1151
      # ==== Parameters
D
David Heinemeier Hansson 已提交
1152
      #
P
Pratik Naik 已提交
1153 1154
      # * +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 已提交
1155 1156 1157 1158 1159 1160
      #
      # ==== Example
      #   # Serialize a preferences attribute
      #   class User
      #     serialize :preferences
      #   end
D
Initial  
David Heinemeier Hansson 已提交
1161
      def serialize(attr_name, class_name = Object)
1162
        serialized_attributes[attr_name.to_s] = class_name
D
Initial  
David Heinemeier Hansson 已提交
1163
      end
1164

D
Initial  
David Heinemeier Hansson 已提交
1165 1166
      # Returns a hash of all the attributes that have been specified for serialization as keys and their class restriction as values.
      def serialized_attributes
1167
        read_inheritable_attribute(:attr_serialized) or write_inheritable_attribute(:attr_serialized, {})
D
Initial  
David Heinemeier Hansson 已提交
1168 1169 1170
      end

      # Guesses the table name (in forced lower-case) based on the name of the class in the inheritance hierarchy descending
P
Pratik Naik 已提交
1171
      # directly from ActiveRecord::Base. So if the hierarchy looks like: Reply < Message < ActiveRecord::Base, then Message is used
1172
      # to guess the table name even when called on Reply. The rules used to do the guess are handled by the Inflector class
1173
      # 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 已提交
1174
      #
1175
      # Nested classes are given table names prefixed by the singular form of
P
Pratik Naik 已提交
1176 1177 1178
      # the parent's table name. Enclosing modules are not considered.
      #
      # ==== Examples
1179 1180
      #
      #   class Invoice < ActiveRecord::Base; end;
1181 1182
      #   file                  class               table_name
      #   invoice.rb            Invoice             invoices
1183 1184 1185 1186 1187 1188 1189 1190
      #
      #   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 已提交
1191
      #
P
Pratik Naik 已提交
1192 1193
      # Additionally, the class-level +table_name_prefix+ is prepended and the
      # +table_name_suffix+ is appended.  So if you have "myapp_" as a prefix,
1194 1195 1196 1197 1198
      # 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 已提交
1199 1200
      #
      #   class Mouse < ActiveRecord::Base
1201
      #     set_table_name "mice"
D
Initial  
David Heinemeier Hansson 已提交
1202
      #   end
1203
      def table_name
1204 1205 1206
        reset_table_name
      end

D
David Heinemeier Hansson 已提交
1207
      def reset_table_name #:nodoc:
1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223
        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 已提交
1224
        set_table_name(name)
1225
        name
D
Initial  
David Heinemeier Hansson 已提交
1226 1227
      end

1228
      # Defines the primary key field -- can be overridden in subclasses. Overwriting will negate any effect of the
D
Initial  
David Heinemeier Hansson 已提交
1229 1230
      # primary_key_prefix_type setting, though.
      def primary_key
1231 1232 1233
        reset_primary_key
      end

D
David Heinemeier Hansson 已提交
1234
      def reset_primary_key #:nodoc:
1235 1236 1237 1238 1239 1240
        key = get_primary_key(base_class.name)
        set_primary_key(key)
        key
      end

      def get_primary_key(base_name) #:nodoc:
1241
        key = 'id'
D
Initial  
David Heinemeier Hansson 已提交
1242 1243
        case primary_key_prefix_type
          when :table_name
1244
            key = base_name.to_s.foreign_key(false)
D
Initial  
David Heinemeier Hansson 已提交
1245
          when :table_name_with_underscore
1246
            key = base_name.to_s.foreign_key
D
Initial  
David Heinemeier Hansson 已提交
1247
        end
1248
        key
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 primary key column to use to the given value,
      # or (if the value is nil or false) to the value returned by the given
1282
      # block.
1283 1284 1285 1286
      #
      #   class Project < ActiveRecord::Base
      #     set_primary_key "sysid"
      #   end
1287
      def set_primary_key(value = nil, &block)
1288 1289 1290 1291 1292 1293
        define_attr_method :primary_key, value, &block
      end
      alias :primary_key= :set_primary_key

      # 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
1294
      # given block.
1295 1296 1297 1298 1299 1300
      #
      #   class Project < ActiveRecord::Base
      #     set_inheritance_column do
      #       original_inheritance_column + "_id"
      #     end
      #   end
1301
      def set_inheritance_column(value = nil, &block)
1302 1303 1304 1305
        define_attr_method :inheritance_column, value, &block
      end
      alias :inheritance_column= :set_inheritance_column

1306 1307
      # 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
1308 1309
      # given block. This is required for Oracle and is useful for any
      # database which relies on sequences for primary key generation.
1310
      #
1311 1312 1313 1314 1315
      # 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.
1316 1317 1318 1319
      #
      #   class Project < ActiveRecord::Base
      #     set_sequence_name "projectseq"   # default would have been "project_seq"
      #   end
1320
      def set_sequence_name(value = nil, &block)
1321 1322 1323 1324
        define_attr_method :sequence_name, value, &block
      end
      alias :sequence_name= :set_sequence_name

D
Initial  
David Heinemeier Hansson 已提交
1325 1326 1327
      # 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
1328 1329 1330
        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 已提交
1331 1332
      end

1333 1334
      # Indicates whether the table associated with this class exists
      def table_exists?
1335
        connection.table_exists?(table_name)
1336 1337
      end

D
Initial  
David Heinemeier Hansson 已提交
1338 1339
      # Returns an array of column objects for the table associated with this class.
      def columns
1340
        unless defined?(@columns) && @columns
1341
          @columns = connection.columns(table_name, "#{name} Columns")
1342
          @columns.each { |column| column.primary = column.name == primary_key }
1343 1344
        end
        @columns
D
Initial  
David Heinemeier Hansson 已提交
1345
      end
1346

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

D
David Heinemeier Hansson 已提交
1352
      # Returns an array of column names as strings.
1353
      def column_names
1354
        @column_names ||= columns.map { |column| column.name }
1355
      end
D
Initial  
David Heinemeier Hansson 已提交
1356

1357 1358
      # 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 已提交
1359
      def content_columns
1360
        @content_columns ||= columns.reject { |c| c.primary || c.name =~ /(_id|_count)$/ || c.name == inheritance_column }
D
Initial  
David Heinemeier Hansson 已提交
1361 1362 1363 1364
      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
1365
      # is available.
D
David Heinemeier Hansson 已提交
1366
      def column_methods_hash #:nodoc:
1367
        @dynamic_methods_hash ||= column_names.inject(Hash.new(false)) do |methods, attr|
1368 1369 1370 1371 1372
          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 已提交
1373 1374 1375
          methods
        end
      end
1376

P
Pratik Naik 已提交
1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402
      # 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
1403
      def reset_column_information
1404 1405
        generated_methods.each { |name| undef_method(name) }
        @column_names = @columns = @columns_hash = @content_columns = @dynamic_methods_hash = @generated_methods = @inheritance_column = nil
1406 1407
      end

1408
      def reset_column_information_and_inheritable_attributes_for_all_subclasses#:nodoc:
1409 1410
        subclasses.each { |klass| klass.reset_inheritable_attributes; klass.reset_column_information }
      end
D
Initial  
David Heinemeier Hansson 已提交
1411

1412
      def self_and_descendants_from_active_record#nodoc:
1413 1414 1415 1416 1417 1418 1419 1420
        klass = self
        classes = [klass]
        while klass != klass.base_class  
          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 已提交
1421
        # Apparently the method base_class causes some trouble.
1422 1423 1424 1425
        # It now works for sure.
        [self]
      end

D
Initial  
David Heinemeier Hansson 已提交
1426 1427
      # Transforms attribute key names into a more humane format, such as "First name" instead of "first_name". Example:
      #   Person.human_attribute_name("first_name") # => "First name"
P
Pratik Naik 已提交
1428
      # This used to be deprecated in favor of humanize, but is now preferred, because it automatically uses the I18n
1429 1430 1431
      # module now.
      # Specify +options+ with additional translating options.
      def human_attribute_name(attribute_key_name, options = {})
1432
        defaults = self_and_descendants_from_active_record.map do |klass|
1433 1434 1435 1436 1437 1438 1439
          :"#{klass.name.underscore}.#{attribute_key_name}"
        end
        defaults << options[:default] if options[:default]
        defaults.flatten!
        defaults << attribute_key_name.humanize
        options[:count] ||= 1
        I18n.translate(defaults.shift, options.merge(:default => defaults, :scope => [:activerecord, :attributes]))
D
Initial  
David Heinemeier Hansson 已提交
1440
      end
I
Iain Hecker 已提交
1441 1442

      # Transform the modelname into a more humane format, using I18n.
1443
      # By default, it will underscore then humanize the class name (BlogPost.human_name #=> "Blog post").
I
Iain Hecker 已提交
1444 1445 1446
      # Default scope of the translation is activerecord.models
      # Specify +options+ with additional translating options.
      def human_name(options = {})
1447
        defaults = self_and_descendants_from_active_record.map do |klass|
I
Iain Hecker 已提交
1448
          :"#{klass.name.underscore}"
1449 1450
        end
        defaults << self.name.underscore.humanize
I
Iain Hecker 已提交
1451
        I18n.translate(defaults.shift, {:scope => [:activerecord, :models], :count => 1, :default => defaults}.merge(options))
D
Initial  
David Heinemeier Hansson 已提交
1452
      end
1453

1454 1455 1456 1457 1458 1459 1460
      # 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 已提交
1461 1462
      end

1463 1464 1465 1466 1467
      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

1468
      # Returns a string like 'Post id:integer, title:string, body:text'
1469
      def inspect
1470 1471 1472 1473
        if self == Base
          super
        elsif abstract_class?
          "#{super}(abstract)"
1474
        elsif table_exists?
1475 1476
          attr_list = columns.map { |c| "#{c.name}: #{c.type}" } * ', '
          "#{super}(#{attr_list})"
1477 1478
        else
          "#{super}(Table doesn't exist)"
1479
        end
1480 1481
      end

1482
      def quote_value(value, column = nil) #:nodoc:
1483
        connection.quote(value,column)
1484 1485
      end

1486
      # Used to sanitize objects before they're used in an SQL SELECT statement. Delegates to <tt>connection.quote</tt>.
1487
      def sanitize(object) #:nodoc:
1488
        connection.quote(object)
D
Initial  
David Heinemeier Hansson 已提交
1489 1490
      end

1491
      # Log and benchmark multiple statements in a single block. Example:
D
Initial  
David Heinemeier Hansson 已提交
1492 1493 1494 1495
      #
      #   Project.benchmark("Creating project") do
      #     project = Project.create("name" => "stuff")
      #     project.create_manager("name" => "David")
1496
      #     project.milestones << Milestone.find(:all)
D
Initial  
David Heinemeier Hansson 已提交
1497
      #   end
1498
      #
1499 1500 1501
      # The benchmark is only recorded if the current level of the logger is less than or equal to the <tt>log_level</tt>,
      # which makes it easy to include benchmarking statements in production software that will remain inexpensive because
      # the benchmark will only be conducted if the log level is low enough.
1502
      #
1503
      # The logging of the multiple statements is turned off unless <tt>use_silence</tt> is set to false.
1504
      def benchmark(title, log_level = Logger::DEBUG, use_silence = true)
1505
        if logger && logger.level <= log_level
1506
          result = nil
J
Jeremy Kemper 已提交
1507 1508
          ms = Benchmark.ms { result = use_silence ? silence { yield } : yield }
          logger.add(log_level, '%s (%.1fms)' % [title, ms])
1509 1510 1511 1512
          result
        else
          yield
        end
1513
      end
1514

1515 1516
      # Silences the logger for the duration of the block.
      def silence
1517 1518 1519
        old_logger_level, logger.level = logger.level, Logger::ERROR if logger
        yield
      ensure
1520
        logger.level = old_logger_level if logger
D
Initial  
David Heinemeier Hansson 已提交
1521
      end
1522

1523 1524 1525
      # Overwrite the default class equality method to provide support for association proxies.
      def ===(object)
        object.is_a?(self)
1526
      end
1527

1528 1529 1530 1531 1532 1533 1534
      # 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 已提交
1535
      # Set this to true if this is an abstract class (see <tt>abstract_class?</tt>).
1536 1537 1538 1539 1540
      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?
1541
        defined?(@abstract_class) && @abstract_class == true
1542 1543
      end

1544
      def respond_to?(method_id, include_private = false)
1545 1546
        if match = DynamicFinderMatch.match(method_id)
          return true if all_attributes_exists?(match.attribute_names)
1547 1548
        elsif match = DynamicScopeMatch.match(method_id)
          return true if all_attributes_exists?(match.attribute_names)
1549
        end
1550

1551 1552 1553
        super
      end

1554 1555 1556 1557
      def sti_name
        store_full_sti_class ? name : name.demodulize
      end

1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571
      # 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

D
Initial  
David Heinemeier Hansson 已提交
1572
      private
1573
        def find_initial(options)
1574
          options.update(:limit => 1)
1575 1576
          find_every(options).first
        end
1577

1578 1579 1580 1581 1582 1583 1584 1585 1586 1587
        def find_last(options)
          order = options[:order]

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

          if scoped?(:find, :order)
1588 1589 1590
            scope = scope(:find)
            original_scoped_order = scope[:order]
            scope[:order] = reverse_sql_order(original_scoped_order)
1591
          end
1592

1593 1594 1595 1596 1597
          begin
            find_initial(options.merge({ :order => order }))
          ensure
            scope[:order] = original_scoped_order if original_scoped_order
          end
1598 1599 1600
        end

        def reverse_sql_order(order_query)
1601
          order_query.to_s.split(/,/).each { |s|
1602 1603 1604 1605
            if s.match(/\s(asc|ASC)$/)
              s.gsub!(/\s(asc|ASC)$/, ' DESC')
            elsif s.match(/\s(desc|DESC)$/)
              s.gsub!(/\s(desc|DESC)$/, ' ASC')
1606
            else
1607 1608 1609 1610
              s.concat(' DESC')
            end
          }.join(',')
        end
1611

1612
        def find_every(options)
1613 1614 1615 1616 1617 1618 1619 1620 1621 1622
          include_associations = merge_includes(scope(:find, :include), options[:include])

          if include_associations.any? && references_eager_loaded_tables?(options)
            records = find_with_associations(options)
          else
            records = find_by_sql(construct_finder_sql(options))
            if include_associations.any?
              preload_associations(records, include_associations)
            end
          end
1623 1624 1625 1626 1627

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

          records
        end
1628

1629
        def find_from_ids(ids, options)
1630
          expects_array = ids.first.kind_of?(Array)
1631
          return ids.first if expects_array && ids.first.empty?
1632

1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644
          ids = ids.flatten.compact.uniq

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

1646 1647
        def find_one(id, options)
          conditions = " AND (#{sanitize_sql(options[:conditions])})" if options[:conditions]
1648
          options.update :conditions => "#{quoted_table_name}.#{connection.quote_column_name(primary_key)} = #{quote_value(id,columns_hash[primary_key])}#{conditions}"
1649

1650 1651 1652 1653
          # Use find_every(options).first since the primary key condition
          # already ensures we have a single record. Using find_initial adds
          # a superfluous :limit => 1.
          if result = find_every(options).first
1654 1655 1656 1657 1658
            result
          else
            raise RecordNotFound, "Couldn't find #{name} with ID=#{id}#{conditions}"
          end
        end
1659

1660 1661
        def find_some(ids, options)
          conditions = " AND (#{sanitize_sql(options[:conditions])})" if options[:conditions]
1662
          ids_list   = ids.map { |id| quote_value(id,columns_hash[primary_key]) }.join(',')
1663
          options.update :conditions => "#{quoted_table_name}.#{connection.quote_column_name(primary_key)} IN (#{ids_list})#{conditions}"
1664 1665 1666

          result = find_every(options)

1667
          # Determine expected size from limit and offset, not just ids.size.
1668 1669 1670 1671 1672 1673
          expected_size =
            if options[:limit] && ids.size > options[:limit]
              options[:limit]
            else
              ids.size
            end
1674 1675 1676 1677 1678

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

          if result.size == expected_size
1681 1682
            result
          else
1683
            raise RecordNotFound, "Couldn't find all #{name.pluralize} with IDs (#{ids_list})#{conditions} (found #{result.size} results, but was looking for #{expected_size})"
1684 1685 1686
          end
        end

1687 1688 1689
        # 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 已提交
1690
        def instantiate(record)
1691
          object =
1692
            if subclass_name = record[inheritance_column]
1693
              # No type given.
1694 1695
              if subclass_name.empty?
                allocate
1696

1697
              else
1698 1699
                # Ignore type if no column is present since it was probably
                # pulled in from a sloppy join.
1700
                unless columns_hash.include?(inheritance_column)
1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712
                  allocate

                else
                  begin
                    compute_type(subclass_name).allocate
                  rescue NameError
                    raise SubclassNotFound,
                      "The single-table inheritance mechanism failed to locate the subclass: '#{record[inheritance_column]}'. " +
                      "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 #{self.to_s}.inheritance_column to use another column for that information."
                  end
1713 1714 1715 1716
                end
              end
            else
              allocate
1717
            end
1718

D
Initial  
David Heinemeier Hansson 已提交
1719
          object.instance_variable_set("@attributes", record)
1720
          object.instance_variable_set("@attributes_cache", Hash.new)
1721 1722 1723 1724 1725 1726 1727 1728 1729

          if object.respond_to_without_attributes?(:after_find)
            object.send(:callback, :after_find)
          end

          if object.respond_to_without_attributes?(:after_initialize)
            object.send(:callback, :after_initialize)
          end

1730
          object
D
Initial  
David Heinemeier Hansson 已提交
1731
        end
1732

1733 1734
        # 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 已提交
1735
        def type_name_with_module(type_name)
1736 1737 1738 1739 1740
          if store_full_sti_class
            type_name
          else
            (/^::/ =~ type_name) ? type_name : "#{parent.name}::#{type_name}"
          end
D
Initial  
David Heinemeier Hansson 已提交
1741 1742
        end

1743 1744 1745 1746 1747 1748 1749 1750
        def default_select(qualified)
          if qualified
            quoted_table_name + '.*'
          else
            '*'
          end
        end

1751
        def construct_finder_sql(options)
1752
          scope = scope(:find)
1753
          sql  = "SELECT #{options[:select] || (scope && scope[:select]) || default_select(options[:joins] || (scope && scope[:joins]))} "
1754
          sql << "FROM #{options[:from]  || (scope && scope[:from]) || quoted_table_name} "
1755

1756
          add_joins!(sql, options[:joins], scope)
1757
          add_conditions!(sql, options[:conditions], scope)
1758

1759
          add_group!(sql, options[:group], options[:having], scope)
1760
          add_order!(sql, options[:order], scope)
1761
          add_limit!(sql, options, scope)
1762
          add_lock!(sql, options, scope)
1763

1764
          sql
1765
        end
1766

1767 1768
        # Merges includes so that the result is a valid +include+
        def merge_includes(first, second)
1769
         (safe_to_array(first) + safe_to_array(second)).uniq
1770 1771
        end

1772 1773 1774 1775 1776 1777 1778 1779 1780
        def merge_joins(*joins)
          if joins.any?{|j| j.is_a?(String) || array_of_strings?(j) }
            joins = joins.collect do |join|
              join = [join] if join.is_a?(String)
              unless array_of_strings?(join)
                join_dependency = ActiveRecord::Associations::ClassMethods::InnerJoinDependency.new(self, join, nil)
                join = join_dependency.join_associations.collect { |assoc| assoc.association_join }
              end
              join
1781
            end
1782
            joins.flatten.map{|j| j.strip}.uniq
1783
          else
1784
            joins.collect{|j| safe_to_array(j)}.flatten.uniq
1785 1786 1787
          end
        end

1788
        # Object#to_a is deprecated, though it does have the desired behavior
1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799
        def safe_to_array(o)
          case o
          when NilClass
            []
          when Array
            o
          else
            [o]
          end
        end

1800 1801 1802 1803
        def array_of_strings?(o)
          o.is_a?(Array) && o.all?{|obj| obj.is_a?(String)}
        end

1804 1805 1806
        def add_order!(sql, order, scope = :auto)
          scope = scope(:find) if :auto == scope
          scoped_order = scope[:order] if scope
1807 1808
          if order
            sql << " ORDER BY #{order}"
1809 1810 1811
            if scoped_order && scoped_order != order
              sql << ", #{scoped_order}"
            end
1812
          else
1813
            sql << " ORDER BY #{scoped_order}" if scoped_order
1814 1815
          end
        end
1816

1817
        def add_group!(sql, group, having, scope = :auto)
1818 1819
          if group
            sql << " GROUP BY #{group}"
1820
            sql << " HAVING #{sanitize_sql_for_conditions(having)}" if having
1821 1822 1823 1824
          else
            scope = scope(:find) if :auto == scope
            if scope && (scoped_group = scope[:group])
              sql << " GROUP BY #{scoped_group}"
1825
              sql << " HAVING #{sanitize_sql_for_conditions(scope[:having])}" if scope[:having]
1826 1827
            end
          end
1828
        end
1829

1830
        # The optional scope argument is for the current <tt>:find</tt> scope.
1831 1832
        def add_limit!(sql, options, scope = :auto)
          scope = scope(:find) if :auto == scope
1833 1834 1835 1836 1837 1838

          if scope
            options[:limit] ||= scope[:limit]
            options[:offset] ||= scope[:offset]
          end

1839
          connection.add_limit_offset!(sql, options)
1840
        end
1841

1842 1843
        # The optional scope argument is for the current <tt>:find</tt> scope.
        # The <tt>:lock</tt> option has precedence over a scoped <tt>:lock</tt>.
1844
        def add_lock!(sql, options, scope = :auto)
1845
          scope = scope(:find) if :auto == scope
1846 1847 1848 1849
          options = options.reverse_merge(:lock => scope[:lock]) if scope
          connection.add_lock!(sql, options)
        end

1850
        # The optional scope argument is for the current <tt>:find</tt> scope.
1851
        def add_joins!(sql, joins, scope = :auto)
1852
          scope = scope(:find) if :auto == scope
1853 1854 1855
          merged_joins = scope && scope[:joins] && joins ? merge_joins(scope[:joins], joins) : (joins || scope && scope[:joins])
          case merged_joins
          when Symbol, Hash, Array
1856 1857 1858 1859 1860 1861
            if array_of_strings?(merged_joins)
              sql << merged_joins.join(' ') + " "
            else
              join_dependency = ActiveRecord::Associations::ClassMethods::InnerJoinDependency.new(self, merged_joins, nil)
              sql << " #{join_dependency.join_associations.collect { |assoc| assoc.association_join }.join} "
            end
1862 1863
          when String
            sql << " #{merged_joins} "
1864
          end
1865
        end
1866

1867
        # Adds a sanitized version of +conditions+ to the +sql+ string. Note that the passed-in +sql+ string is changed.
1868
        # The optional scope argument is for the current <tt>:find</tt> scope.
1869 1870
        def add_conditions!(sql, conditions, scope = :auto)
          scope = scope(:find) if :auto == scope
1871 1872 1873 1874 1875
          conditions = [conditions]
          conditions << scope[:conditions] if scope
          conditions << type_condition if finder_needs_type_condition?
          merged_conditions = merge_conditions(*conditions)
          sql << "WHERE #{merged_conditions} " unless merged_conditions.blank?
D
Initial  
David Heinemeier Hansson 已提交
1876
        end
1877

1878 1879
        def type_condition(table_alias=nil)
          quoted_table_alias = self.connection.quote_table_name(table_alias || table_name)
1880
          quoted_inheritance_column = connection.quote_column_name(inheritance_column)
1881 1882
          type_condition = subclasses.inject("#{quoted_table_alias}.#{quoted_inheritance_column} = '#{sti_name}' ") do |condition, subclass|
            condition << "OR #{quoted_table_alias}.#{quoted_inheritance_column} = '#{subclass.sti_name}' "
1883
          end
1884 1885

          " (#{type_condition}) "
D
Initial  
David Heinemeier Hansson 已提交
1886 1887 1888
        end

        # Guesses the table name, but does not decorate it with prefix and suffix information.
1889
        def undecorated_table_name(class_name = base_class.name)
1890 1891
          table_name = class_name.to_s.demodulize.underscore
          table_name = table_name.pluralize if pluralize_table_names
1892
          table_name
D
Initial  
David Heinemeier Hansson 已提交
1893 1894
        end

P
Pratik Naik 已提交
1895 1896 1897 1898
        # Enables dynamic finders like <tt>find_by_user_name(user_name)</tt> and <tt>find_by_user_name_and_password(user_name, password)</tt>
        # that are turned into <tt>find(:first, :conditions => ["user_name = ?", user_name])</tt> and
        # <tt>find(:first, :conditions => ["user_name = ? AND password = ?", user_name, password])</tt> respectively. Also works for
        # <tt>find(:all)</tt> by using <tt>find_all_by_amount(50)</tt> that is turned into <tt>find(:all, :conditions => ["amount = ?", 50])</tt>.
1899
        #
P
Pratik Naik 已提交
1900 1901
        # 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>.
1902
        #
1903 1904 1905 1906 1907
        # 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
1908
        # attempts to use it do not run through method_missing.
1909
        def method_missing(method_id, *arguments, &block)
1910 1911
          if match = DynamicFinderMatch.match(method_id)
            attribute_names = match.attribute_names
1912
            super unless all_attributes_exists?(attribute_names)
1913 1914
            if match.finder?
              finder = match.finder
1915
              bang = match.bang?
1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933
              # def self.find_by_login_and_activated(*args)
              #   options = args.extract_options!
              #   attributes = construct_attributes_from_arguments(
              #     [:login,:activated],
              #     args
              #   )
              #   finder_options = { :conditions => attributes }
              #   validate_find_options(options)
              #   set_readonly_option!(options)
              #
              #   if options[:conditions]
              #     with_scope(:find => finder_options) do
              #       find(:first, options)
              #     end
              #   else
              #     find(:first, options.merge(finder_options))
              #   end
              # end
1934 1935 1936
              self.class_eval %{
                def self.#{method_id}(*args)
                  options = args.extract_options!
1937 1938 1939 1940
                  attributes = construct_attributes_from_arguments(
                    [:#{attribute_names.join(',:')}],
                    args
                  )
1941 1942 1943 1944
                  finder_options = { :conditions => attributes }
                  validate_find_options(options)
                  set_readonly_option!(options)

1945
                  #{'result = ' if bang}if options[:conditions]
1946
                    with_scope(:find => finder_options) do
1947
                      find(:#{finder}, options)
1948 1949
                    end
                  else
1950
                    find(:#{finder}, options.merge(finder_options))
1951
                  end
J
Jeremy Kemper 已提交
1952
                  #{'result || raise(RecordNotFound, "Couldn\'t find #{name} with #{attributes.to_a.collect { |pair| pair.join(\' = \') }.join(\', \')}")' if bang}
1953
                end
1954 1955 1956 1957
              }, __FILE__, __LINE__
              send(method_id, *arguments)
            elsif match.instantiator?
              instantiator = match.instantiator
1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982
              # def self.find_or_create_by_user_id(*args)
              #   guard_protected_attributes = false
              #
              #   if args[0].is_a?(Hash)
              #     guard_protected_attributes = true
              #     attributes = args[0].with_indifferent_access
              #     find_attributes = attributes.slice(*[:user_id])
              #   else
              #     find_attributes = attributes = construct_attributes_from_arguments([:user_id], args)
              #   end
              #
              #   options = { :conditions => find_attributes }
              #   set_readonly_option!(options)
              #
              #   record = find(:first, options)
              #
              #   if record.nil?
              #     record = self.new { |r| r.send(:attributes=, attributes, guard_protected_attributes) }
              #     yield(record) if block_given?
              #     record.save
              #     record
              #   else
              #     record
              #   end
              # end
1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993
              self.class_eval %{
                def self.#{method_id}(*args)
                  guard_protected_attributes = false

                  if args[0].is_a?(Hash)
                    guard_protected_attributes = true
                    attributes = args[0].with_indifferent_access
                    find_attributes = attributes.slice(*[:#{attribute_names.join(',:')}])
                  else
                    find_attributes = attributes = construct_attributes_from_arguments([:#{attribute_names.join(',:')}], args)
                  end
1994

1995 1996
                  options = { :conditions => find_attributes }
                  set_readonly_option!(options)
1997

1998
                  record = find(:first, options)
1999

2000
                  if record.nil?
2001 2002 2003 2004 2005 2006 2007
                    record = self.new { |r| r.send(:attributes=, attributes, guard_protected_attributes) }
                    #{'yield(record) if block_given?'}
                    #{'record.save' if instantiator == :create}
                    record
                  else
                    record
                  end
2008
                end
2009
              }, __FILE__, __LINE__
2010
              send(method_id, *arguments, &block)
2011
            end
2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027
          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
                  )                                                 #   )
                                                                    # 
                  scoped(:conditions => attributes)                 #   scoped(:conditions => attributes)
                end                                                 # end
              }, __FILE__, __LINE__
              send(method_id, *arguments)
            end
2028 2029 2030 2031
          else
            super
          end
        end
D
Initial  
David Heinemeier Hansson 已提交
2032

2033 2034 2035 2036 2037 2038
        def construct_attributes_from_arguments(attribute_names, arguments)
          attributes = {}
          attribute_names.each_with_index { |name, idx| attributes[name] = arguments[idx] }
          attributes
        end

2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053
        # 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

2054
        def all_attributes_exists?(attribute_names)
2055
          attribute_names = expand_attribute_names_for_aggregates(attribute_names)
2056
          attribute_names.all? { |name| column_methods_hash.include?(name.to_sym) }
2057
        end
2058

2059
        def attribute_condition(quoted_column_name, argument)
2060
          case argument
2061 2062 2063 2064 2065 2066 2067 2068
            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} = ?"
2069 2070 2071
          end
        end

2072 2073 2074 2075
        # Interpret Array and Hash as conditions and anything else as an id.
        def expand_id_conditions(id_or_conditions)
          case id_or_conditions
            when Array, Hash then id_or_conditions
2076
            else sanitize_sql(primary_key => id_or_conditions)
2077 2078 2079
          end
        end

P
Pratik Naik 已提交
2080 2081
        # Defines an "attribute" method (like +inheritance_column+ or
        # +table_name+). A new (class) method will be created with the
2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098
        # given name. If a value is specified, the new method will
        # return that value (as a string). Otherwise, the given block
        # will be used to compute the value of the method.
        #
        # The original method will be aliased, with the new name being
        # prefixed with "original_". This allows the new method to
        # access the original value.
        #
        # Example:
        #
        #   class A < ActiveRecord::Base
        #     define_attr_method :primary_key, "sysid"
        #     define_attr_method( :inheritance_column ) do
        #       original_inheritance_column + "_id"
        #     end
        #   end
        def define_attr_method(name, value=nil, &block)
2099
          sing = metaclass
2100
          sing.send :alias_method, "original_#{name}", name
2101 2102 2103
          if block_given?
            sing.send :define_method, name, &block
          else
2104 2105 2106 2107
            # use eval instead of a block to work around a memory leak in dev
            # mode in fcgi
            sing.class_eval "def #{name}; #{value.to_s.inspect}; end"
          end
2108 2109
        end

D
Initial  
David Heinemeier Hansson 已提交
2110
      protected
2111
        # Scope parameters to method calls within the block.  Takes a hash of method_name => parameters hash.
2112 2113
        # 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.
2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124
        #
        #   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 已提交
2125
        # In nested scopings, all previous parameters are overwritten by the innermost rule, with the exception of
P
Pratik Naik 已提交
2126 2127 2128 2129 2130
        # <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.
2131 2132 2133 2134
        #
        #   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 已提交
2135
        #         with_scope(:find => { :limit => 10 })
2136 2137 2138 2139 2140 2141 2142 2143 2144
        #           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
        #
2145
        # You can ignore any previous scopings by using the <tt>with_exclusive_scope</tt> method.
2146 2147 2148 2149 2150 2151 2152 2153 2154 2155
        #
        #   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 已提交
2156 2157 2158
        #
        # *Note*: the +:find+ scope also has effect on update and deletion methods,
        # like +update_all+ and +delete_all+.
2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170
        def with_scope(method_scoping = {}, action = :merge, &block)
          method_scoping = method_scoping.method_scoping if method_scoping.respond_to?(:method_scoping)

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

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

          if f = method_scoping[:find]
2171
            f.assert_valid_keys(VALID_FIND_OPTIONS)
2172 2173 2174 2175
            set_readonly_option! f
          end

          # Merge scopings
2176
          if [:merge, :reverse_merge].include?(action) && current_scoped_methods
2177 2178 2179 2180 2181 2182 2183
            method_scoping = current_scoped_methods.inject(method_scoping) do |hash, (method, params)|
              case hash[method]
                when Hash
                  if method == :find
                    (hash[method].keys + params.keys).uniq.each do |key|
                      merge = hash[method][key] && params[key] # merge if both scopes have the same key
                      if key == :conditions && merge
2184 2185 2186 2187 2188
                        if params[key].is_a?(Hash) && hash[method][key].is_a?(Hash)
                          hash[method][key] = merge_conditions(hash[method][key].deep_merge(params[key]))
                        else
                          hash[method][key] = merge_conditions(params[key], hash[method][key])
                        end
2189
                      elsif key == :include && merge
2190
                        hash[method][key] = merge_includes(hash[method][key], params[key]).uniq
2191 2192
                      elsif key == :joins && merge
                        hash[method][key] = merge_joins(params[key], hash[method][key])
2193 2194 2195 2196 2197
                      else
                        hash[method][key] = hash[method][key] || params[key]
                      end
                    end
                  else
2198 2199 2200 2201 2202
                    if action == :reverse_merge
                      hash[method] = hash[method].merge(params)
                    else
                      hash[method] = params.merge(hash[method])
                    end
2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223
                  end
                else
                  hash[method] = params
              end
              hash
            end
          end

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

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

D
David Heinemeier Hansson 已提交
2224
        def subclasses #:nodoc:
D
Initial  
David Heinemeier Hansson 已提交
2225 2226 2227
          @@subclasses[self] ||= []
          @@subclasses[self] + extra = @@subclasses[self].inject([]) {|list, subclass| list + subclass.subclasses }
        end
2228

2229
        # Sets the default options for the model. The format of the
2230
        # <tt>options</tt> argument is the same as in find.
2231 2232
        #
        #   class Person < ActiveRecord::Base
2233
        #     default_scope :order => 'last_name, first_name'
2234 2235
        #   end
        def default_scope(options = {})
2236
          self.default_scoping << { :find => options, :create => options[:conditions].is_a?(Hash) ? options[:conditions] : {} }
2237 2238
        end

2239
        # Test whether the given method and optional key are scoped.
D
David Heinemeier Hansson 已提交
2240
        def scoped?(method, key = nil) #:nodoc:
2241
          if current_scoped_methods && (scope = current_scoped_methods[method])
2242
            !key || !scope[key].nil?
2243
          end
2244 2245 2246
        end

        # Retrieve the scope for the given method and optional key.
D
David Heinemeier Hansson 已提交
2247
        def scope(method, key = nil) #:nodoc:
2248
          if current_scoped_methods && (scope = current_scoped_methods[method])
2249 2250 2251 2252
            key ? scope[key] : scope
          end
        end

2253
        def scoped_methods #:nodoc:
2254
          Thread.current[:"#{self}_scoped_methods"] ||= self.default_scoping.dup
2255
        end
2256

D
David Heinemeier Hansson 已提交
2257
        def current_scoped_methods #:nodoc:
2258
          scoped_methods.last
2259
        end
2260

P
Pratik Naik 已提交
2261
        # Returns the class type of the record using the current module as a prefix. So descendants of
2262
        # MyApp::Business::Account would appear as MyApp::Business::AccountSubclass.
D
Initial  
David Heinemeier Hansson 已提交
2263
        def compute_type(type_name)
2264
          modularized_name = type_name_with_module(type_name)
2265 2266 2267 2268 2269 2270
          silence_warnings do
            begin
              class_eval(modularized_name, __FILE__, __LINE__)
            rescue NameError
              class_eval(type_name, __FILE__, __LINE__)
            end
D
Initial  
David Heinemeier Hansson 已提交
2271 2272 2273
          end
        end

P
Pratik Naik 已提交
2274 2275
        # Returns the class descending directly from ActiveRecord::Base or an
        # abstract class, if any, in the inheritance hierarchy.
2276
        def class_of_active_record_descendant(klass)
2277
          if klass.superclass == Base || klass.superclass.abstract_class?
2278
            klass
D
Initial  
David Heinemeier Hansson 已提交
2279 2280 2281
          elsif klass.superclass.nil?
            raise ActiveRecordError, "#{name} doesn't belong in a hierarchy descending from ActiveRecord"
          else
2282
            class_of_active_record_descendant(klass.superclass)
D
Initial  
David Heinemeier Hansson 已提交
2283 2284 2285
          end
        end

P
Pratik Naik 已提交
2286
        # Returns the name of the class descending directly from Active Record in the inheritance hierarchy.
D
David Heinemeier Hansson 已提交
2287
        def class_name_of_active_record_descendant(klass) #:nodoc:
2288
          klass.base_class.name
2289 2290
        end

P
Pratik Naik 已提交
2291
        # Accepts an array, hash, or string of SQL conditions and sanitizes
2292
        # them into a valid SQL fragment for a WHERE clause.
2293 2294 2295
        #   ["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'"
2296
        def sanitize_sql_for_conditions(condition, table_name = quoted_table_name)
2297 2298
          return nil if condition.blank?

2299 2300
          case condition
            when Array; sanitize_sql_array(condition)
2301
            when Hash;  sanitize_sql_hash_for_conditions(condition, table_name)
2302 2303
            else        condition
          end
2304
        end
2305
        alias_method :sanitize_sql, :sanitize_sql_for_conditions
2306

P
Pratik Naik 已提交
2307
        # Accepts an array, hash, or string of SQL conditions and sanitizes
2308 2309 2310 2311 2312 2313 2314 2315 2316 2317
        # 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

2318 2319 2320 2321 2322
        def aggregate_mapping(reflection)
          mapping = reflection.options[:mapping] || [reflection.name, reflection.name]
          mapping.first.is_a?(Array) ? mapping : [mapping]
        end

P
Pratik Naik 已提交
2323
        # Accepts a hash of SQL conditions and replaces those attributes
2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352
        # 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

2353
        # Sanitizes a hash of attribute/value pairs into SQL conditions for a WHERE clause.
2354 2355 2356 2357
        #   { :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)"
2358 2359
        #   { :age => 13..18 }
        #     # => "age BETWEEN 13 AND 18"
2360 2361
        #   { 'other_records.id' => 7 }
        #     # => "`other_records`.`id` = 7"
2362 2363
        #   { :other_records => { :id => 7 } }
        #     # => "`other_records`.`id` = 7"
2364 2365 2366
        # 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'"
2367
        def sanitize_sql_hash_for_conditions(attrs, table_name = quoted_table_name)
2368 2369
          attrs = expand_hash_conditions_for_aggregates(attrs)

2370
          conditions = attrs.map do |attr, value|
2371 2372 2373 2374 2375 2376 2377 2378
            unless value.is_a?(Hash)
              attr = attr.to_s

              # Extract table name from qualified attribute names.
              if attr.include?('.')
                table_name, attr = attr.split('.', 2)
                table_name = connection.quote_table_name(table_name)
              end
2379

2380
              attribute_condition("#{table_name}.#{connection.quote_column_name(attr)}", value)
2381
            else
2382
              sanitize_sql_hash_for_conditions(value, connection.quote_table_name(attr.to_s))
2383
            end
2384 2385
          end.join(' AND ')

2386
          replace_bind_variables(conditions, expand_range_bind_variables(attrs.values))
2387
        end
2388 2389 2390 2391 2392 2393
        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)
2394
          attrs.map do |attr, value|
2395 2396 2397
            "#{connection.quote_column_name(attr)} = #{quote_bound_value(value)}"
          end.join(', ')
        end
2398

2399
        # Accepts an array of conditions.  The array has each value
P
Pratik Naik 已提交
2400
        # sanitized and interpolated into the SQL statement.
2401
        #   ["name='%s' and group_id='%s'", "foo'bar", 4]  returns  "name='foo''bar' and group_id='4'"
2402
        def sanitize_sql_array(ary)
2403 2404 2405 2406
          statement, *values = ary
          if values.first.is_a?(Hash) and statement =~ /:\w+/
            replace_named_bind_variables(statement, values.first)
          elsif statement.include?('?')
2407 2408
            replace_bind_variables(statement, values)
          else
2409
            statement % values.collect { |value| connection.quote_string(value.to_s) }
2410
          end
2411 2412
        end

2413 2414
        alias_method :sanitize_conditions, :sanitize_sql

D
David Heinemeier Hansson 已提交
2415
        def replace_bind_variables(statement, values) #:nodoc:
2416
          raise_if_bind_arity_mismatch(statement, statement.count('?'), values.size)
2417
          bound = values.dup
2418
          statement.gsub('?') { quote_bound_value(bound.shift) }
2419 2420
        end

D
David Heinemeier Hansson 已提交
2421
        def replace_named_bind_variables(statement, bind_vars) #:nodoc:
2422 2423 2424 2425
          statement.gsub(/(:?):([a-zA-Z]\w*)/) do
            if $1 == ':' # skip postgresql casts
              $& # return the whole match
            elsif bind_vars.include?(match = $2.to_sym)
2426
              quote_bound_value(bind_vars[match])
2427 2428
            else
              raise PreparedStatementInvalid, "missing value for :#{match} in #{statement}"
2429 2430
            end
          end
2431 2432
        end

2433
        def expand_range_bind_variables(bind_vars) #:nodoc:
2434 2435 2436
          expanded = []

          bind_vars.each do |var|
2437 2438
            next if var.is_a?(Hash)

2439
            if var.is_a?(Range)
2440 2441
              expanded << var.first
              expanded << var.last
2442
            else
2443
              expanded << var
2444
            end
2445
          end
2446 2447

          expanded
2448 2449
        end

D
David Heinemeier Hansson 已提交
2450
        def quote_bound_value(value) #:nodoc:
2451
          if value.respond_to?(:map) && !value.acts_like?(:string)
2452 2453
            if value.respond_to?(:empty?) && value.empty?
              connection.quote(nil)
2454 2455 2456
            else
              value.map { |v| connection.quote(v) }.join(',')
            end
2457 2458
          else
            connection.quote(value)
2459 2460 2461
          end
        end

D
David Heinemeier Hansson 已提交
2462
        def raise_if_bind_arity_mismatch(statement, expected, provided) #:nodoc:
2463 2464 2465
          unless expected == provided
            raise PreparedStatementInvalid, "wrong number of bind variables (#{provided} for #{expected}) in: #{statement}"
          end
2466
        end
2467

2468
        VALID_FIND_OPTIONS = [ :conditions, :include, :joins, :limit, :offset,
2469
                               :order, :select, :readonly, :group, :having, :from, :lock ]
2470

D
David Heinemeier Hansson 已提交
2471
        def validate_find_options(options) #:nodoc:
2472 2473
          options.assert_valid_keys(VALID_FIND_OPTIONS)
        end
2474

D
David Heinemeier Hansson 已提交
2475
        def set_readonly_option!(options) #:nodoc:
2476 2477 2478
          # Inherit :readonly from finder scope if set.  Otherwise,
          # if :joins is not blank then :readonly defaults to true.
          unless options.has_key?(:readonly)
J
Jeremy Kemper 已提交
2479 2480
            if scoped_readonly = scope(:find, :readonly)
              options[:readonly] = scoped_readonly
2481
            elsif !options[:joins].blank? && !options[:select]
2482 2483 2484
              options[:readonly] = true
            end
          end
D
Initial  
David Heinemeier Hansson 已提交
2485
        end
2486

D
David Heinemeier Hansson 已提交
2487
        def encode_quoted_value(value) #:nodoc:
2488
          quoted_value = connection.quote(value)
2489 2490
          quoted_value = "'#{quoted_value[1..-2].gsub(/\'/, "\\\\'")}'" if quoted_value.include?("\\\'") # (for ruby mode) "
          quoted_value
2491
        end
D
Initial  
David Heinemeier Hansson 已提交
2492 2493 2494 2495 2496
    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).
2497
      # In both instances, valid attribute keys are determined by the column names of the associated table --
D
Initial  
David Heinemeier Hansson 已提交
2498 2499 2500
      # hence you can't have attributes that aren't part of the table columns.
      def initialize(attributes = nil)
        @attributes = attributes_from_column_definition
2501
        @attributes_cache = {}
D
Initial  
David Heinemeier Hansson 已提交
2502 2503 2504
        @new_record = true
        ensure_proper_type
        self.attributes = attributes unless attributes.nil?
2505
        self.class.send(:scope, :create).each { |att,value| self.send("#{att}=", value) } if self.class.send(:scoped?, :create)
2506 2507 2508
        result = yield self if block_given?
        callback(:after_initialize) if respond_to_without_attributes?(:after_initialize)
        result
D
Initial  
David Heinemeier Hansson 已提交
2509
      end
2510

2511 2512
      # A model instance's primary key is always available as model.id
      # whether you name it the default 'id' or set it to something else.
D
Initial  
David Heinemeier Hansson 已提交
2513
      def id
2514
        attr_name = self.class.primary_key
2515
        column = column_for_attribute(attr_name)
2516

2517 2518 2519 2520
        self.class.send(:define_read_method, :id, attr_name, column)
        # now that the method exists, call it
        self.send attr_name.to_sym

D
Initial  
David Heinemeier Hansson 已提交
2521
      end
2522

P
Pratik Naik 已提交
2523 2524 2525 2526
      # 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 已提交
2527 2528 2529
      # 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 已提交
2530 2531
      #
      #   user = User.find_by_name('Phusion')
2532
      #   user_path(user)  # => "/users/1"
P
Pratik Naik 已提交
2533
      #
P
Pratik Naik 已提交
2534 2535
      # 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 已提交
2536 2537 2538 2539 2540 2541 2542 2543
      #
      #   class User < ActiveRecord::Base
      #     def to_param  # overridden
      #       name
      #     end
      #   end
      #   
      #   user = User.find_by_name('Phusion')
2544
      #   user_path(user)  # => "/users/Phusion"
2545
      def to_param
2546
        # We can't use alias_method here, because method 'id' optimizes itself on the fly.
2547
        (id = self.id) ? id.to_s : nil # Be sure to stringify the id for routes
2548
      end
Y
Yehuda Katz 已提交
2549

P
Pratik Naik 已提交
2550 2551 2552
      # Returns a cache key that can be used to identify this record.
      #
      # ==== Examples
2553 2554 2555 2556 2557
      #
      #   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
2558
        case
2559
        when new_record?
J
Jeremy Kemper 已提交
2560 2561 2562
          "#{self.class.model_name.cache_key}/new"
        when timestamp = self[:updated_at]
          "#{self.class.model_name.cache_key}/#{id}-#{timestamp.to_s(:number)}"
2563
        else
J
Jeremy Kemper 已提交
2564
          "#{self.class.model_name.cache_key}/#{id}"
2565 2566
        end
      end
2567

2568
      def id_before_type_cast #:nodoc:
2569 2570 2571
        read_attribute_before_type_cast(self.class.primary_key)
      end

2572
      def quoted_id #:nodoc:
2573
        quote_value(id, column_for_attribute(self.class.primary_key))
2574
      end
2575

D
Initial  
David Heinemeier Hansson 已提交
2576 2577 2578 2579
      # Sets the primary ID.
      def id=(value)
        write_attribute(self.class.primary_key, value)
      end
2580

2581
      # Returns true if this object hasn't been saved yet -- that is, a record for the object doesn't exist yet; otherwise, returns false.
2582
      def new_record?
2583
        @new_record || false
2584
      end
2585

P
Pratik Naik 已提交
2586 2587
      # :call-seq:
      #   save(perform_validation = true)
2588
      #
P
Pratik Naik 已提交
2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602
      # 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
      # ActiveRecord::Validations for more information. 
      #
      # 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
      # details. 
D
Initial  
David Heinemeier Hansson 已提交
2603 2604 2605
      def save
        create_or_update
      end
2606

P
Pratik Naik 已提交
2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619
      # 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
      # for more information. 
      #
      # 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
      # ActiveRecord::Callbacks for further details. 
2620
      def save!
2621
        create_or_update || raise(RecordNotSaved)
2622
      end
2623

P
Pratik Naik 已提交
2624 2625 2626
      # 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.
2627
      #
P
Pratik Naik 已提交
2628 2629 2630 2631 2632 2633
      # 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>.
2634 2635 2636 2637 2638
      def delete
        self.class.delete(id) unless new_record?
        freeze
      end

D
Initial  
David Heinemeier Hansson 已提交
2639 2640 2641
      # 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
2642
        unless new_record?
2643 2644 2645 2646 2647
          connection.delete(
            "DELETE FROM #{self.class.quoted_table_name} " +
            "WHERE #{connection.quote_column_name(self.class.primary_key)} = #{quoted_id}",
            "#{self.class.name} Destroy"
          )
D
Initial  
David Heinemeier Hansson 已提交
2648 2649 2650 2651 2652
        end

        freeze
      end

J
Jeremy Kemper 已提交
2653 2654 2655 2656 2657
      # Returns a clone of the record that hasn't been assigned an id yet and
      # is treated as a new record.  Note that this is a "shallow" clone:
      # 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.
D
Initial  
David Heinemeier Hansson 已提交
2658
      def clone
2659
        attrs = clone_attributes(:read_attribute_before_type_cast)
D
David Heinemeier Hansson 已提交
2660
        attrs.delete(self.class.primary_key)
2661 2662 2663
        record = self.class.new
        record.send :instance_variable_set, '@attributes', attrs
        record
D
Initial  
David Heinemeier Hansson 已提交
2664
      end
2665

2666
      # Returns an instance of the specified +klass+ with the attributes of the current record. This is mostly useful in relation to
2667
      # single-table inheritance structures where you want a subclass to appear as the superclass. This can be used along with record
2668
      # identification in Action Pack to allow, say, <tt>Client < Company</tt> to do something like render <tt>:partial => @client.becomes(Company)</tt>
2669 2670 2671 2672 2673
      # 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 已提交
2674 2675 2676 2677 2678
        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
2679 2680
      end

2681 2682 2683
      # 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 已提交
2684
      def update_attribute(name, value)
2685
        send(name.to_s + '=', value)
2686
        save(false)
2687 2688
      end

2689
      # Updates all the attributes from the passed-in Hash and saves the record. If the object is invalid, the saving will
2690
      # fail and false will be returned.
2691
      def update_attributes(attributes)
2692
        self.attributes = attributes
2693
        save
D
Initial  
David Heinemeier Hansson 已提交
2694
      end
2695

2696 2697 2698 2699 2700
      # 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 已提交
2701

P
Pratik Naik 已提交
2702 2703 2704
      # 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+.
2705
      def increment(attribute, by = 1)
2706
        self[attribute] ||= 0
2707
        self[attribute] += by
2708 2709
        self
      end
2710

P
Pratik Naik 已提交
2711 2712 2713 2714
      # 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.
2715 2716
      def increment!(attribute, by = 1)
        increment(attribute, by).update_attribute(attribute, self[attribute])
2717 2718
      end

P
Pratik Naik 已提交
2719 2720 2721
      # 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+.
2722
      def decrement(attribute, by = 1)
2723
        self[attribute] ||= 0
2724
        self[attribute] -= by
2725 2726 2727
        self
      end

P
Pratik Naik 已提交
2728 2729 2730 2731
      # 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.
2732 2733
      def decrement!(attribute, by = 1)
        decrement(attribute, by).update_attribute(attribute, self[attribute])
2734
      end
2735

P
Pratik Naik 已提交
2736 2737 2738 2739
      # 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+.
2740
      def toggle(attribute)
2741
        self[attribute] = !send("#{attribute}?")
2742 2743 2744
        self
      end

P
Pratik Naik 已提交
2745 2746 2747 2748
      # 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.
2749 2750 2751 2752
      def toggle!(attribute)
        toggle(attribute).update_attribute(attribute, self[attribute])
      end

2753
      # Reloads the attributes of this object from the database.
2754 2755 2756 2757
      # 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)
2758
        clear_aggregation_cache
2759
        clear_association_cache
2760
        @attributes.update(self.class.find(self.id, options).instance_variable_get('@attributes'))
2761
        @attributes_cache = {}
2762
        self
2763 2764
      end

2765
      # Returns the value of the attribute identified by <tt>attr_name</tt> after it has been typecast (for example,
D
Initial  
David Heinemeier Hansson 已提交
2766 2767
      # "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).
2768
      def [](attr_name)
2769
        read_attribute(attr_name)
D
Initial  
David Heinemeier Hansson 已提交
2770
      end
2771

D
Initial  
David Heinemeier Hansson 已提交
2772 2773
      # Updates the attribute identified by <tt>attr_name</tt> with the specified +value+.
      # (Alias for the protected write_attribute method).
2774
      def []=(attr_name, value)
2775
        write_attribute(attr_name, value)
D
Initial  
David Heinemeier Hansson 已提交
2776 2777 2778
      end

      # Allows you to set all the attributes at once by passing in a hash with keys
P
Pratik Naik 已提交
2779 2780 2781 2782 2783 2784
      # 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
2785
      # attributes not included in that won't be allowed to be mass-assigned.
P
Pratik Naik 已提交
2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797
      #
      #   class User < ActiveRecord::Base
      #     attr_protected :is_admin
      #   end
      #   
      #   user = User.new
      #   user.attributes = { :username => 'Phusion', :is_admin => true }
      #   user.username   # => "Phusion"
      #   user.is_admin?  # => false
      #   
      #   user.send(:attributes=, { :username => 'Phusion', :is_admin => true }, false)
      #   user.is_admin?  # => true
2798
      def attributes=(new_attributes, guard_protected_attributes = true)
D
David Heinemeier Hansson 已提交
2799 2800
        return if new_attributes.nil?
        attributes = new_attributes.dup
2801
        attributes.stringify_keys!
D
Initial  
David Heinemeier Hansson 已提交
2802 2803

        multi_parameter_attributes = []
2804
        attributes = remove_attributes_protected_from_mass_assignment(attributes) if guard_protected_attributes
2805

2806
        attributes.each do |k, v|
2807 2808 2809 2810 2811
          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 已提交
2812
        end
D
David Heinemeier Hansson 已提交
2813

D
Initial  
David Heinemeier Hansson 已提交
2814 2815 2816
        assign_multiparameter_attributes(multi_parameter_attributes)
      end

2817
      # Returns a hash of all the attributes with their names as keys and the values of the attributes as values.
2818
      def attributes
2819 2820
        self.attribute_names.inject({}) do |attrs, name|
          attrs[name] = read_attribute(name)
2821
          attrs
2822
        end
2823 2824
      end

2825
      # Returns a hash of attributes before typecasting and deserialization.
2826
      def attributes_before_type_cast
2827
        self.attribute_names.inject({}) do |attrs, name|
2828
          attrs[name] = read_attribute_before_type_cast(name)
2829
          attrs
2830
        end
2831 2832
      end

P
Pratik Naik 已提交
2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845
      # 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"'
2846 2847 2848
      def attribute_for_inspect(attr_name)
        value = read_attribute(attr_name)

2849
        if value.is_a?(String) && value.length > 50
2850
          "#{value[0..50]}...".inspect
2851 2852
        elsif value.is_a?(Date) || value.is_a?(Time)
          %("#{value.to_s(:db)}")
2853 2854 2855 2856 2857
        else
          value.inspect
        end
      end

D
Initial  
David Heinemeier Hansson 已提交
2858
      # Returns true if the specified +attribute+ has been set by the user or by a database load and is neither
2859
      # nil nor empty? (the latter only applies to objects that respond to empty?, most notably Strings).
D
Initial  
David Heinemeier Hansson 已提交
2860
      def attribute_present?(attribute)
2861
        value = read_attribute(attribute)
2862
        !value.blank?
D
Initial  
David Heinemeier Hansson 已提交
2863 2864
      end

2865 2866 2867 2868 2869
      # Returns true if the given attribute is in the attributes hash
      def has_attribute?(attr_name)
        @attributes.has_key?(attr_name.to_s)
      end

D
Initial  
David Heinemeier Hansson 已提交
2870 2871 2872 2873 2874 2875 2876
      # Returns an array of names for the attributes available on this object sorted alphabetically.
      def attribute_names
        @attributes.keys.sort
      end

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

2880
      # 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 已提交
2881
      def ==(comparison_object)
2882
        comparison_object.equal?(self) ||
2883 2884
          (comparison_object.instance_of?(self.class) &&
            comparison_object.id == id &&
2885
            !comparison_object.new_record?)
D
Initial  
David Heinemeier Hansson 已提交
2886 2887 2888 2889 2890 2891
      end

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

D
Initial  
David Heinemeier Hansson 已提交
2893 2894 2895
      # 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
2896
        id.hash
D
Initial  
David Heinemeier Hansson 已提交
2897 2898
      end

2899
      # Freeze the attributes hash such that associations are still accessible, even on destroyed records.
2900
      def freeze
2901
        @attributes.freeze; self
2902
      end
2903

2904
      # Returns +true+ if the attributes hash has been frozen.
2905 2906 2907
      def frozen?
        @attributes.frozen?
      end
2908

2909 2910 2911 2912 2913 2914 2915
      # Returns duplicated record with unfreezed attributes.
      def dup
        obj = super
        obj.instance_variable_set('@attributes', instance_variable_get('@attributes').dup)
        obj
      end

2916 2917
      # 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.
2918
      def readonly?
2919
        defined?(@readonly) && @readonly == true
2920 2921
      end

2922 2923
      # Marks this record as read only.
      def readonly!
2924 2925
        @readonly = true
      end
2926

2927
      # Returns the contents of the record as a nicely formatted string.
2928
      def inspect
2929
        attributes_as_nice_string = self.class.column_names.collect { |name|
2930 2931 2932 2933
          if has_attribute?(name) || new_record?
            "#{name}: #{attribute_for_inspect(name)}"
          end
        }.compact.join(", ")
2934
        "#<#{self.class} #{attributes_as_nice_string}>"
2935
      end
2936

D
Initial  
David Heinemeier Hansson 已提交
2937 2938
    private
      def create_or_update
2939
        raise ReadOnlyRecord if readonly?
2940 2941
        result = new_record? ? create : update
        result != false
D
Initial  
David Heinemeier Hansson 已提交
2942 2943
      end

2944
      # Updates the associated record with values matching those of the instance attributes.
2945
      # Returns the number of affected rows.
2946 2947
      def update(attribute_names = @attributes.keys)
        quoted_attributes = attributes_with_quotes(false, false, attribute_names)
2948
        return 0 if quoted_attributes.empty?
D
Initial  
David Heinemeier Hansson 已提交
2949
        connection.update(
2950
          "UPDATE #{self.class.quoted_table_name} " +
2951
          "SET #{quoted_comma_pair_list(connection, quoted_attributes)} " +
2952
          "WHERE #{connection.quote_column_name(self.class.primary_key)} = #{quote_value(id)}",
D
Initial  
David Heinemeier Hansson 已提交
2953 2954 2955 2956
          "#{self.class.name} Update"
        )
      end

2957 2958
      # Creates a record with values matching those of the instance attributes
      # and returns its id.
D
Initial  
David Heinemeier Hansson 已提交
2959
      def create
2960
        if self.id.nil? && connection.prefetch_primary_key?(self.class.table_name)
2961 2962
          self.id = connection.next_sequence_value(self.class.sequence_name)
        end
2963

2964 2965 2966 2967 2968
        quoted_attributes = attributes_with_quotes

        statement = if quoted_attributes.empty?
          connection.empty_insert_statement(self.class.table_name)
        else
2969
          "INSERT INTO #{self.class.quoted_table_name} " +
D
Initial  
David Heinemeier Hansson 已提交
2970
          "(#{quoted_column_names.join(', ')}) " +
2971 2972 2973 2974 2975
          "VALUES(#{quoted_attributes.values.join(', ')})"
        end

        self.id = connection.insert(statement, "#{self.class.name} Create",
          self.class.primary_key, self.id, self.class.sequence_name)
2976

D
Initial  
David Heinemeier Hansson 已提交
2977
        @new_record = false
2978
        id
D
Initial  
David Heinemeier Hansson 已提交
2979 2980
      end

P
Pratik Naik 已提交
2981
      # Sets the attribute used for single table inheritance to this class name if this is not the ActiveRecord::Base descendant.
P
Pratik Naik 已提交
2982 2983
      # 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 已提交
2984 2985 2986
      # Message class in that example.
      def ensure_proper_type
        unless self.class.descends_from_active_record?
2987
          write_attribute(self.class.inheritance_column, self.class.sti_name)
D
Initial  
David Heinemeier Hansson 已提交
2988 2989 2990
        end
      end

2991
      def convert_number_column_value(value)
2992 2993 2994 2995 2996 2997 2998 2999
        if value == false
          0
        elsif value == true
          1
        elsif value.is_a?(String) && value.blank?
          nil
        else
          value
3000
        end
D
Initial  
David Heinemeier Hansson 已提交
3001 3002 3003
      end

      def remove_attributes_protected_from_mass_assignment(attributes)
3004 3005 3006 3007
        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?
3008
            attributes.reject { |key, value| !self.class.accessible_attributes.include?(key.gsub(/\(.+/, "")) || attributes_protected_by_default.include?(key.gsub(/\(.+/, "")) }
3009
          elsif self.class.accessible_attributes.nil?
3010
            attributes.reject { |key, value| self.class.protected_attributes.include?(key.gsub(/\(.+/,"")) || attributes_protected_by_default.include?(key.gsub(/\(.+/, "")) }
3011 3012 3013 3014 3015 3016 3017
          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?
3018
          log_protected_attribute_removal(removed_attributes)
D
Initial  
David Heinemeier Hansson 已提交
3019
        end
3020 3021

        safe_attributes
D
Initial  
David Heinemeier Hansson 已提交
3022
      end
3023

3024 3025 3026
      # Removes attributes which have been marked as readonly.
      def remove_readonly_attributes(attributes)
        unless self.class.readonly_attributes.nil?
3027
          attributes.delete_if { |key, value| self.class.readonly_attributes.include?(key.gsub(/\(.+/,"")) }
3028 3029 3030 3031
        else
          attributes
        end
      end
D
Initial  
David Heinemeier Hansson 已提交
3032

3033 3034 3035 3036
      def log_protected_attribute_removal(*attributes)
        logger.debug "WARNING: Can't mass-assign these protected attributes: #{attributes.join(', ')}"
      end

3037 3038
      # The primary key and inheritance column can never be set by mass-assignment for security reasons.
      def attributes_protected_by_default
3039 3040 3041
        default = [ self.class.primary_key, self.class.inheritance_column ]
        default << 'id' unless self.class.primary_key.eql? 'id'
        default
3042 3043
      end

3044
      # Returns a copy of the attributes hash where all the values have been safely quoted for use in
3045
      # an SQL statement.
3046
      def attributes_with_quotes(include_primary_key = true, include_readonly_attributes = true, attribute_names = @attributes.keys)
3047
        quoted = {}
3048
        connection = self.class.connection
3049
        attribute_names.each do |name|
3050 3051 3052 3053 3054 3055 3056 3057 3058
          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)
3059
          end
D
Initial  
David Heinemeier Hansson 已提交
3060
        end
3061
        include_readonly_attributes ? quoted : remove_readonly_attributes(quoted)
D
Initial  
David Heinemeier Hansson 已提交
3062
      end
3063

D
Initial  
David Heinemeier Hansson 已提交
3064
      # Quote strings appropriately for SQL statements.
3065
      def quote_value(value, column = nil)
3066
        self.class.connection.quote(value, column)
D
Initial  
David Heinemeier Hansson 已提交
3067 3068
      end

P
Pratik Naik 已提交
3069
      # Interpolate custom SQL string in instance context.
D
Initial  
David Heinemeier Hansson 已提交
3070 3071
      # Optional record argument is meant for custom insert_sql.
      def interpolate_sql(sql, record = nil)
3072
        instance_eval("%@#{sql.gsub('@', '\@')}@")
D
Initial  
David Heinemeier Hansson 已提交
3073 3074 3075 3076 3077 3078 3079
      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
3080
        self.class.columns.inject({}) do |attributes, column|
3081
          attributes[column.name] = column.default unless column.name == self.class.primary_key
D
Initial  
David Heinemeier Hansson 已提交
3082 3083 3084 3085 3086 3087 3088 3089
          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
3090
      # parentheses to have the parameters typecasted before they're used in the constructor. Use i for Fixnum, f for Float,
3091
      # 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 已提交
3092 3093 3094 3095 3096
      def assign_multiparameter_attributes(pairs)
        execute_callstack_for_multiparameter_attributes(
          extract_callstack_for_multiparameter_attributes(pairs)
        )
      end
3097

3098
      def instantiate_time_object(name, values)
3099
        if self.class.send(:create_time_zone_conversion_attribute?, name, column_for_attribute(name))
3100
          Time.zone.local(*values)
3101
        else
3102
          Time.time_with_datetime_fallback(@@default_timezone, *values)
3103
        end
3104 3105
      end

D
Initial  
David Heinemeier Hansson 已提交
3106
      def execute_callstack_for_multiparameter_attributes(callstack)
3107
        errors = []
D
Initial  
David Heinemeier Hansson 已提交
3108
        callstack.each do |name, values|
3109 3110 3111 3112 3113
          begin
            klass = (self.class.reflect_on_aggregation(name.to_sym) || column_for_attribute(name)).klass
            if values.empty?
              send(name + "=", nil)
            else
3114
              value = if Time == klass
3115
                instantiate_time_object(name, values)
3116 3117 3118 3119
              elsif Date == klass
                begin
                  Date.new(*values)
                rescue ArgumentError => ex # if Date.new raises an exception on an invalid date
3120
                  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
3121 3122 3123 3124 3125 3126
                end
              else
                klass.new(*values)
              end

              send(name + "=", value)
3127
            end
3128 3129
          rescue => ex
            errors << AttributeAssignmentError.new("error on assignment #{values.inspect} to #{name}", ex, name)
D
Initial  
David Heinemeier Hansson 已提交
3130 3131
          end
        end
3132 3133 3134
        unless errors.empty?
          raise MultiparameterAssignmentErrors.new(errors), "#{errors.size} error(s) on assignment of multiparameter attributes"
        end
D
Initial  
David Heinemeier Hansson 已提交
3135
      end
3136

D
Initial  
David Heinemeier Hansson 已提交
3137 3138 3139 3140 3141 3142 3143 3144 3145
      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)

          unless value.empty?
3146
            attributes[attribute_name] <<
3147
              [ find_parameter_position(multiparameter_name), type_cast_attribute_value(multiparameter_name, value) ]
D
Initial  
David Heinemeier Hansson 已提交
3148 3149 3150 3151 3152
          end
        end

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

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

D
Initial  
David Heinemeier Hansson 已提交
3158 3159 3160
      def find_parameter_position(multiparameter_name)
        multiparameter_name.scan(/\(([0-9]*).*\)/).first.first
      end
3161

D
Initial  
David Heinemeier Hansson 已提交
3162 3163 3164 3165 3166 3167
      # 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

      def quoted_column_names(attributes = attributes_with_quotes)
3168
        connection = self.class.connection
3169
        attributes.keys.collect do |column_name|
3170
          connection.quote_column_name(column_name)
3171
        end
D
Initial  
David Heinemeier Hansson 已提交
3172 3173
      end

3174 3175 3176 3177
      def self.quoted_table_name
        self.connection.quote_table_name(self.table_name)
      end

3178 3179 3180 3181
      def quote_columns(quoter, hash)
        hash.inject({}) do |quoted, (name, value)|
          quoted[quoter.quote_column_name(name)] = value
          quoted
3182
        end
D
Initial  
David Heinemeier Hansson 已提交
3183 3184
      end

3185 3186
      def quoted_comma_pair_list(quoter, hash)
        comma_pair_list(quote_columns(quoter, hash))
D
Initial  
David Heinemeier Hansson 已提交
3187 3188 3189
      end

      def object_from_yaml(string)
3190
        return string unless string.is_a?(String) && string =~ /^---/
3191
        YAML::load(string) rescue string
D
Initial  
David Heinemeier Hansson 已提交
3192
      end
3193 3194

      def clone_attributes(reader_method = :read_attribute, attributes = {})
3195 3196 3197
        self.attribute_names.inject(attributes) do |attrs, name|
          attrs[name] = clone_attribute_value(reader_method, name)
          attrs
3198 3199 3200 3201 3202
        end
      end

      def clone_attribute_value(reader_method, attribute_name)
        value = send(reader_method, attribute_name)
3203
        value.duplicable? ? value.clone : value
3204 3205 3206
      rescue TypeError, NoMethodError
        value
      end
D
Initial  
David Heinemeier Hansson 已提交
3207
  end
J
Joshua Peek 已提交
3208 3209

  Base.class_eval do
J
Joshua Peek 已提交
3210
    extend ActiveModel::Naming
J
Joshua Peek 已提交
3211
    extend QueryCache::ClassMethods
J
Joshua Peek 已提交
3212 3213 3214 3215
    include Validations
    include Locking::Optimistic, Locking::Pessimistic
    include AttributeMethods
    include Dirty
3216
    include Callbacks, ActiveModel::Observing, Timestamp
J
Joshua Peek 已提交
3217
    include Associations, AssociationPreload, NamedScope
J
Joshua Peek 已提交
3218
    include ActiveModel::Conversion
3219 3220 3221 3222 3223

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

3224
    include Aggregations, Transactions, Reflection, Batches, Calculations, Serialization
J
Joshua Peek 已提交
3225
  end
3226
end
3227 3228 3229

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