base.rb 117.8 KB
Newer Older
D
Initial  
David Heinemeier Hansson 已提交
1
require 'yaml'
2
require 'set'
D
Initial  
David Heinemeier Hansson 已提交
3 4

module ActiveRecord #:nodoc:
P
Pratik Naik 已提交
5
  # Generic Active Record exception class.
6
  class ActiveRecordError < StandardError
D
Initial  
David Heinemeier Hansson 已提交
7
  end
8 9 10

  # Raised when the single-table inheritance mechanism failes to locate the subclass
  # (for example due to improper usage of column that +inheritance_column+ points to).
11 12
  class SubclassNotFound < ActiveRecordError #:nodoc:
  end
13

14
  # Raised when an object assigned to an association has an incorrect type.
15
  #
16 17 18
  #   class Ticket < ActiveRecord::Base
  #     has_many :patches
  #   end
19
  #
20 21 22
  #   class Patch < ActiveRecord::Base
  #     belongs_to :ticket
  #   end
23
  #
24 25
  #   # Comments are not patches, this assignment raises AssociationTypeMismatch.
  #   @ticket.patches << Comment.new(:content => "Please attach tests to your patch.")
26
  class AssociationTypeMismatch < ActiveRecordError
D
Initial  
David Heinemeier Hansson 已提交
27
  end
28 29 30

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

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

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

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

P
Pratik Naik 已提交
45
  # Raised when Active Record cannot find record by given id or set of ids.
46
  class RecordNotFound < ActiveRecordError
D
Initial  
David Heinemeier Hansson 已提交
47
  end
48 49 50 51

  # Raised by ActiveRecord::Base.save! and ActiveRecord::Base.create! methods when record cannot be
  # saved because record is invalid.
  class RecordNotSaved < ActiveRecordError
52
  end
53 54 55

  # 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 已提交
56
  end
57

58
  # Raised when number of bind variables in statement given to <tt>:condition</tt> key (for example, when using +find+ method)
59 60
  # does not match number of expected variables.
  #
61
  # For example, in
62
  #
63
  #   Location.find :all, :conditions => ["lat = ? AND lng = ?", 53.7362]
64
  #
65
  # two placeholders are given but only one variable to fill them.
66
  class PreparedStatementInvalid < ActiveRecordError
67
  end
68 69 70 71 72

  # 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 已提交
73
  # Read more about optimistic locking in ActiveRecord::Locking module RDoc.
74
  class StaleObjectError < ActiveRecordError
75
  end
76 77 78 79

  # 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
80
  end
81 82 83

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

P
Pratik Naik 已提交
86
  # Used by Active Record transaction mechanism to distinguish rollback from other exceptional situations.
87 88
  # You can use it to roll your transaction back explicitly in the block passed to +transaction+ method.
  class Rollback < ActiveRecordError
89
  end
90

P
Pratik Naik 已提交
91
  # Raised when attribute has a name reserved by Active Record (when attribute has name of one of Active Record instance methods).
92
  class DangerousAttributeError < ActiveRecordError
93
  end
94

P
Pratik Naik 已提交
95 96
  # 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.
97 98
  class MissingAttributeError < NoMethodError
  end
99

P
Pratik Naik 已提交
100 101 102 103
  # Raised when an error occured while doing a mass assignment to an attribute through the
  # <tt>attributes=</tt> method. The exception has an +attribute+ property that is the name of the
  # offending attribute.
  class AttributeAssignmentError < ActiveRecordError
104 105 106 107 108 109 110
    attr_reader :exception, :attribute
    def initialize(message, exception, attribute)
      @exception = exception
      @attribute = attribute
      @message = message
    end
  end
111

P
Pratik Naik 已提交
112 113 114 115
  # 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
116 117 118 119 120
    attr_reader :errors
    def initialize(errors)
      @errors = errors
    end
  end
121

122
  # Active Record objects don't specify their attributes directly, but rather infer them from the table definition with
D
Initial  
David Heinemeier Hansson 已提交
123 124
  # 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
125 126
  # database table will happen automatically in most common cases, but can be overwritten for the uncommon ones.
  #
D
Initial  
David Heinemeier Hansson 已提交
127
  # See the mapping rules in table_name and the full example in link:files/README.html for more insight.
128
  #
D
Initial  
David Heinemeier Hansson 已提交
129
  # == Creation
130
  #
131
  # Active Records accept constructor parameters either in a hash or as a block. The hash method is especially useful when
132
  # you're receiving the data from somewhere else, like an HTTP request. It works like this:
133
  #
134
  #   user = User.new(:name => "David", :occupation => "Code Artist")
D
Initial  
David Heinemeier Hansson 已提交
135
  #   user.name # => "David"
136
  #
D
Initial  
David Heinemeier Hansson 已提交
137
  # You can also use block initialization:
138
  #
D
Initial  
David Heinemeier Hansson 已提交
139 140 141 142
  #   user = User.new do |u|
  #     u.name = "David"
  #     u.occupation = "Code Artist"
  #   end
143
  #
D
Initial  
David Heinemeier Hansson 已提交
144
  # And of course you can just create a bare object and specify the attributes after the fact:
145
  #
D
Initial  
David Heinemeier Hansson 已提交
146 147 148
  #   user = User.new
  #   user.name = "David"
  #   user.occupation = "Code Artist"
149
  #
D
Initial  
David Heinemeier Hansson 已提交
150
  # == Conditions
151
  #
152
  # Conditions can either be specified as a string, array, or hash representing the WHERE-part of an SQL statement.
D
Initial  
David Heinemeier Hansson 已提交
153
  # The array form is to be used when the condition input is tainted and requires sanitization. The string form can
154
  # be used for statements that don't involve tainted data. The hash form works much like the array form, except
155
  # only equality and range is possible. Examples:
156
  #
157
  #   class User < ActiveRecord::Base
D
Initial  
David Heinemeier Hansson 已提交
158
  #     def self.authenticate_unsafely(user_name, password)
159
  #       find(:first, :conditions => "user_name = '#{user_name}' AND password = '#{password}'")
D
Initial  
David Heinemeier Hansson 已提交
160
  #     end
161
  #
D
Initial  
David Heinemeier Hansson 已提交
162
  #     def self.authenticate_safely(user_name, password)
163
  #       find(:first, :conditions => [ "user_name = ? AND password = ?", user_name, password ])
D
Initial  
David Heinemeier Hansson 已提交
164
  #     end
165 166 167 168
  #
  #     def self.authenticate_safely_simply(user_name, password)
  #       find(:first, :conditions => { :user_name => user_name, :password => password })
  #     end
D
Initial  
David Heinemeier Hansson 已提交
169
  #   end
170
  #
171
  # The <tt>authenticate_unsafely</tt> method inserts the parameters directly into the query and is thus susceptible to SQL-injection
172
  # attacks if the <tt>user_name</tt> and +password+ parameters come directly from an HTTP request. The <tt>authenticate_safely</tt>  and
173
  # <tt>authenticate_safely_simply</tt> both will sanitize the <tt>user_name</tt> and +password+ before inserting them in the query,
174
  # which will ensure that an attacker can't escape the query and fake the login (or worse).
175
  #
176
  # When using multiple parameters in the conditions, it can easily become hard to read exactly what the fourth or fifth
177
  # question mark is supposed to represent. In those cases, you can resort to named bind variables instead. That's done by replacing
178 179
  # the question marks with symbols and supplying a hash with values for the matching symbol keys:
  #
180
  #   Company.find(:first, :conditions => [
181
  #     "id = :id AND name = :name AND division = :division AND created_at > :accounting_date",
182 183 184
  #     { :id => 3, :name => "37signals", :division => "First", :accounting_date => '2005-01-01' }
  #   ])
  #
185 186 187 188 189 190
  # 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])
  #
191 192 193
  # A range may be used in the hash to use the SQL BETWEEN operator:
  #
  #   Student.find(:all, :conditions => { :grade => 9..12 })
194
  #
P
Pratik Naik 已提交
195 196 197 198
  # An array may be used in the hash to use the SQL IN operator:
  #
  #   Student.find(:all, :conditions => { :grade => [9,11,12] })
  #
D
Initial  
David Heinemeier Hansson 已提交
199
  # == Overwriting default accessors
200
  #
201 202
  # 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 已提交
203
  # 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 已提交
204
  # Example:
205
  #
D
Initial  
David Heinemeier Hansson 已提交
206 207
  #   class Song < ActiveRecord::Base
  #     # Uses an integer of seconds to hold the length of the song
208
  #
D
Initial  
David Heinemeier Hansson 已提交
209
  #     def length=(minutes)
210
  #       write_attribute(:length, minutes.to_i * 60)
D
Initial  
David Heinemeier Hansson 已提交
211
  #     end
212
  #
D
Initial  
David Heinemeier Hansson 已提交
213
  #     def length
214
  #       read_attribute(:length) / 60
D
Initial  
David Heinemeier Hansson 已提交
215 216
  #     end
  #   end
217
  #
P
Pratik Naik 已提交
218 219
  # 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.
220
  #
221 222 223 224
  # == 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.
225
  #
226 227 228 229 230 231 232 233 234
  # 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
  #
235
  # == Accessing attributes before they have been typecasted
236
  #
237
  # 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 已提交
238
  # 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 已提交
239
  # has a <tt>balance</tt> attribute, you can call <tt>account.balance_before_type_cast</tt> or <tt>account.id_before_type_cast</tt>.
240 241
  #
  # This is especially useful in validation situations where the user might supply a string for an integer field and you want to display
242
  # the original string back in an error message. Accessing the attribute normally would typecast the string to 0, which isn't what you
243 244
  # want.
  #
245 246
  # == Dynamic attribute-based finders
  #
247
  # Dynamic attribute-based finders are a cleaner way of getting (and/or creating) objects by simple queries without turning to SQL. They work by
P
Pratik Naik 已提交
248 249
  # appending the name of an attribute to <tt>find_by_</tt> or <tt>find_all_by_</tt>, so you get finders like <tt>Person.find_by_user_name</tt>,
  # <tt>Person.find_all_by_last_name</tt>, and <tt>Payment.find_by_transaction_id</tt>. So instead of writing
250 251
  # <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>.
252
  #
253 254
  # 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
255
  # <tt>Person.find(:first, :conditions => ["user_name = ? AND password = ?", user_name, password])</tt>, you just do
256
  # <tt>Person.find_by_user_name_and_password(user_name, password)</tt>.
257
  #
P
Pratik Naik 已提交
258 259
  # 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
260
  # 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>.
261
  #
262
  # The same dynamic finder style can be used to create the object if it doesn't already exist. This dynamic finder is called with
263
  # <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:
264 265 266
  #
  #   # No 'Summer' tag exists
  #   Tag.find_or_create_by_name("Summer") # equal to Tag.create(:name => "Summer")
267
  #
268 269 270
  #   # Now the 'Summer' tag does exist
  #   Tag.find_or_create_by_name("Summer") # equal to Tag.find_by_name("Summer")
  #
271 272 273 274
  #   # Now 'Bob' exist and is an 'admin'
  #   User.find_or_create_by_name('Bob', :age => 40) { |u| u.admin = true }
  #
  # 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 setted unless they are given in a block. For example:
275 276 277
  #
  #   # No 'Winter' tag exists
  #   winter = Tag.find_or_initialize_by_name("Winter")
278
  #   winter.new_record? # true
279
  #
280 281 282 283 284 285 286
  # 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.
  #
287
  # == Saving arrays, hashes, and other non-mappable objects in text columns
288 289
  #
  # 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+.
290
  # This makes it possible to store arrays, hashes, and other non-mappable objects without doing any additional work. Example:
291
  #
D
Initial  
David Heinemeier Hansson 已提交
292 293 294
  #   class User < ActiveRecord::Base
  #     serialize :preferences
  #   end
295
  #
296
  #   user = User.create(:preferences => { "background" => "black", "display" => large })
D
Initial  
David Heinemeier Hansson 已提交
297
  #   User.find(user.id).preferences # => { "background" => "black", "display" => large }
298
  #
299
  # You can also specify a class option as the second parameter that'll raise an exception if a serialized object is retrieved as a
D
Initial  
David Heinemeier Hansson 已提交
300
  # descendent of a class not in the hierarchy. Example:
301
  #
D
Initial  
David Heinemeier Hansson 已提交
302
  #   class User < ActiveRecord::Base
303
  #     serialize :preferences, Hash
D
Initial  
David Heinemeier Hansson 已提交
304
  #   end
305
  #
306
  #   user = User.create(:preferences => %w( one two three ))
D
Initial  
David Heinemeier Hansson 已提交
307
  #   User.find(user.id).preferences    # raises SerializationTypeMismatch
308
  #
D
Initial  
David Heinemeier Hansson 已提交
309 310
  # == Single table inheritance
  #
311
  # 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 已提交
312 313 314 315 316 317 318
  # 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 已提交
319 320
  # 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 已提交
321
  #
322 323 324
  # 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 已提交
325 326
  # Note, all the attributes for all the cases are kept in the same table. Read more:
  # http://www.martinfowler.com/eaaCatalog/singleTableInheritance.html
327
  #
D
Initial  
David Heinemeier Hansson 已提交
328 329 330
  # == Connection to multiple databases in different models
  #
  # Connections are usually created through ActiveRecord::Base.establish_connection and retrieved by ActiveRecord::Base.connection.
331
  # All classes inheriting from ActiveRecord::Base will use this connection. But you can also set a class-specific connection.
P
Pratik Naik 已提交
332 333
  # 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 已提交
334 335 336 337 338
  #
  # 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
339
  #
P
Pratik Naik 已提交
340 341
  # * 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 已提交
342
  #   <tt>:adapter</tt> key.
P
Pratik Naik 已提交
343
  # * AdapterNotFound - The <tt>:adapter</tt> key used in <tt>establish_connection</tt> specified a non-existent adapter
344
  #   (or a bad spelling of an existing one).
P
Pratik Naik 已提交
345 346 347 348 349 350 351 352 353
  # * 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
354
  #   objects that should be inspected to determine which attributes triggered the errors.
P
Pratik Naik 已提交
355
  # * AttributeAssignmentError - An error occurred while doing a mass assignment through the <tt>attributes=</tt> method.
356
  #   You can inspect the +attribute+ property of the exception object to determine which attribute triggered the error.
357
  #
358
  # *Note*: The attributes listed are class-level attributes (accessible from both the class and instance level).
P
Pratik Naik 已提交
359
  # 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 已提交
360 361 362 363
  # instances in the current object space.
  class Base
    # 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+.
364
    cattr_accessor :logger, :instance_writer => false
J
Jeremy Kemper 已提交
365

D
Initial  
David Heinemeier Hansson 已提交
366 367 368 369 370
    def self.inherited(child) #:nodoc:
      @@subclasses[self] ||= []
      @@subclasses[self] << child
      super
    end
J
Jeremy Kemper 已提交
371

D
David Heinemeier Hansson 已提交
372
    def self.reset_subclasses #:nodoc:
373
      nonreloadables = []
374
      subclasses.each do |klass|
375
        unless ActiveSupport::Dependencies.autoloaded? klass
376 377 378
          nonreloadables << klass
          next
        end
379 380 381
        klass.instance_variables.each { |var| klass.send(:remove_instance_variable, var) }
        klass.instance_methods(false).each { |m| klass.send :undef_method, m }
      end
382 383
      @@subclasses = {}
      nonreloadables.each { |klass| (@@subclasses[klass.superclass] ||= []) << klass }
384 385
    end

D
Initial  
David Heinemeier Hansson 已提交
386
    @@subclasses = {}
387

388
    cattr_accessor :configurations, :instance_writer => false
389 390
    @@configurations = {}

391
    # 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 已提交
392 393
    # :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
394
    # that this is a global setting for all Active Records.
395
    cattr_accessor :primary_key_prefix_type, :instance_writer => false
D
Initial  
David Heinemeier Hansson 已提交
396 397
    @@primary_key_prefix_type = nil

398
    # Accessor for the name of the prefix string to prepend to every table name. So if set to "basecamp_", all
399
    # 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 已提交
400
    # for tables in a shared database. By default, the prefix is the empty string.
401
    cattr_accessor :table_name_prefix, :instance_writer => false
D
Initial  
David Heinemeier Hansson 已提交
402 403 404 405
    @@table_name_prefix = ""

    # 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.
406
    cattr_accessor :table_name_suffix, :instance_writer => false
D
Initial  
David Heinemeier Hansson 已提交
407 408
    @@table_name_suffix = ""

409
    # Indicates whether table names should be the pluralized versions of the corresponding class names.
P
Pratik Naik 已提交
410
    # 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 已提交
411
    # See table_name for the full rules on table/class naming. This is true, by default.
412
    cattr_accessor :pluralize_table_names, :instance_writer => false
D
Initial  
David Heinemeier Hansson 已提交
413 414
    @@pluralize_table_names = true

415
    # Determines whether to use ANSI codes to colorize the logging statements committed by the connection adapter. These colors
416
    # make it much easier to overview things during debugging (when used through a reader like +tail+ and on a black background), but
417
    # may complicate matters if you use software like syslog. This is true, by default.
418
    cattr_accessor :colorize_logging, :instance_writer => false
419 420
    @@colorize_logging = true

421 422
    # 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.
423
    cattr_accessor :default_timezone, :instance_writer => false
424
    @@default_timezone = :local
425

426
    # Determines whether to use a connection for each thread, or a single shared connection for all threads.
427 428 429
    # Defaults to false. If you're writing a threaded application, set to true
    # and periodically call verify_active_connections! to clear out connections
    # assigned to stale threads.
430
    cattr_accessor :allow_concurrency, :instance_writer => false
431
    @@allow_concurrency = false
432

433 434
    # Specifies the format to use when dumping the database schema with Rails'
    # Rakefile.  If :sql, the schema is dumped as (potentially database-
435
    # specific) SQL statements.  If :ruby, the schema is dumped as an
436 437 438
    # 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.
439
    cattr_accessor :schema_format , :instance_writer => false
440
    @@schema_format = :ruby
441

442 443 444
    # 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
445

D
Initial  
David Heinemeier Hansson 已提交
446
    class << self # Class methods
447
      # Find operates with four different retrieval approaches:
448
      #
P
Pratik Naik 已提交
449
      # * 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]).
450
      #   If no record can be found for all of the listed ids, then RecordNotFound will be raised.
P
Pratik Naik 已提交
451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471
      # * 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.
      #
      # ==== Attributes
      #
      # * <tt>:conditions</tt> - An SQL fragment like "administrator = 1" or <tt>[ "user_name = ?", username ]</tt>. See conditions in the intro.
      # * <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.
      # * <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.
      # * <tt>:joins</tt> - Either an SQL fragment for additional joins like "LEFT JOIN comments ON comments.post_id = id" (rarely needed)
      #   or 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).
472
      #   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.
473
      #   Pass <tt>:readonly => false</tt> to override.
P
Pratik Naik 已提交
474
      # * <tt>:include</tt> - Names associations that should be loaded alongside. The symbols named refer
475
      #   to already defined associations. See eager loading under Associations.
P
Pratik Naik 已提交
476
      # * <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
477
      #   include the joined columns.
P
Pratik Naik 已提交
478
      # * <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
479
      #   of a database view).
P
Pratik Naik 已提交
480 481
      # * <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".
482
      #   <tt>:lock => true</tt> gives connection's default exclusive lock, usually "FOR UPDATE".
483
      #
P
Pratik Naik 已提交
484 485 486
      # ==== Examples
      #
      #   # find by id
D
Initial  
David Heinemeier Hansson 已提交
487 488 489
      #   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)
490
      #   Person.find([1])     # returns an array for the object with ID = 1
491 492
      #   Person.find(1, :conditions => "administrator = 1", :order => "created_on DESC")
      #
493
      # Note that returned records may not be in the same order as the ids you
494
      # provide since database rows are unordered. Give an explicit <tt>:order</tt>
495 496
      # to ensure the results are sorted.
      #
P
Pratik Naik 已提交
497 498 499
      # ==== Examples
      #
      #   # find first
500
      #   Person.find(:first) # returns the first object fetched by SELECT * FROM people
501 502 503
      #   Person.find(:first, :conditions => [ "user_name = ?", user_name])
      #   Person.find(:first, :order => "created_on DESC", :offset => 5)
      #
P
Pratik Naik 已提交
504
      #   # find last
505 506 507 508
      #   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 已提交
509
      #   # find all
510
      #   Person.find(:all) # returns an array of objects for all the rows fetched by SELECT * FROM people
511
      #   Person.find(:all, :conditions => [ "category IN (?)", categories], :limit => 50)
P
Pratik Naik 已提交
512
      #   Person.find(:all, :conditions => { :friends => ["Bob", "Steve", "Fred"] }
513 514
      #   Person.find(:all, :offset => 10, :limit => 10)
      #   Person.find(:all, :include => [ :account, :friends ])
515
      #   Person.find(:all, :group => "category")
516
      #
P
Pratik Naik 已提交
517 518 519
      # 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
520
      # transaction has to wait until the first is finished; we get the
P
Pratik Naik 已提交
521 522
      # expected <tt>person.visits == 4</tt>.
      #
523 524 525 526 527
      #   Person.transaction do
      #     person = Person.find(1, :lock => true)
      #     person.visits += 1
      #     person.save!
      #   end
528
      def find(*args)
529
        options = args.extract_options!
530 531
        validate_find_options(options)
        set_readonly_option!(options)
532

533
        case args.first
534
          when :first then find_initial(options)
535
          when :last  then find_last(options)
536 537
          when :all   then find_every(options)
          else             find_from_ids(args, options)
D
Initial  
David Heinemeier Hansson 已提交
538 539
        end
      end
540

P
Pratik Naik 已提交
541 542
      # 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>.
543 544 545
      def first(*args)
        find(:first, *args)
      end
546

P
Pratik Naik 已提交
547 548
      # 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>.
549 550 551
      def last(*args)
        find(:last, *args)
      end
552

553 554 555 556 557
      # 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
558

P
Pratik Naik 已提交
559
      # Executes a custom SQL query against your database and returns all the results.  The results will
560 561
      # be returned as an array with columns requested encapsulated as attributes of the model you call
      # this method from.  If you call +Product.find_by_sql+ then the results will be returned in a Product
562 563
      # object with the attributes you specified in the SQL query.
      #
564 565
      # 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
566 567
      # table.
      #
P
Pratik Naik 已提交
568
      # The +sql+ parameter is a full SQL query as a string.  It will be called as is, there will be
569 570
      # 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
571 572 573
      # change your call if you switch engines
      #
      # ==== Examples
P
Pratik Naik 已提交
574
      #   # A simple SQL query spanning multiple tables
575 576 577 578 579 580
      #   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 已提交
581
      def find_by_sql(sql)
582
        connection.select_all(sanitize_sql(sql), "#{name} Load").collect! { |record| instantiate(record) }
D
Initial  
David Heinemeier Hansson 已提交
583
      end
584

585 586
      # Checks whether a record exists in the database that matches conditions given.  These conditions
      # can either be a single integer representing a primary key id to be found, or a condition to be
587 588
      # matched like using ActiveRecord#find.
      #
589 590
      # The +id_or_conditions+ parameter can be an Integer or a String if you want to search the primary key
      # column of the table for a matching id, or if you're looking to match against a condition you can use
591 592
      # an Array or a Hash.
      #
593
      # Possible gotcha: You can't pass in a condition as a string e.g. "name = 'Jamie'", this would be
594 595 596
      # sanitized and then queried against the primary key column as "id = 'name = \'Jamie"
      #
      # ==== Examples
597
      #   Person.exists?(5)
598
      #   Person.exists?('5')
599
      #   Person.exists?(:name => "David")
600 601
      #   Person.exists?(['name LIKE ?', "%#{query}%"])
      def exists?(id_or_conditions)
602 603
        connection.select_all(
          construct_finder_sql(
604 605
            :select     => "#{quoted_table_name}.#{primary_key}",
            :conditions => expand_id_conditions(id_or_conditions),
606
            :limit      => 1
607
          ),
608 609
          "#{name} Exists"
        ).size > 0
D
Initial  
David Heinemeier Hansson 已提交
610
      end
611

612
      # Creates an object (or multiple objects) and saves it to the database, if validations pass.
613 614 615 616 617 618 619 620
      # 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')
621
      #
622
      #   # Create an Array of new objects
P
Pratik Naik 已提交
623
      #   User.create([{ :first_name => 'Jamie' }, { :first_name => 'Jeremy' }])
624 625 626 627 628 629 630
      #
      #   # 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 已提交
631
      #   User.create([{ :first_name => 'Jamie' }, { :first_name => 'Jeremy' }]) do |u|
632
      #     u.is_admin = false
633
      #   end
634
      def create(attributes = nil, &block)
635
        if attributes.is_a?(Array)
636
          attributes.collect { |attr| create(attr, &block) }
637 638
        else
          object = new(attributes)
639
          yield(object) if block_given?
640 641 642
          object.save
          object
        end
D
Initial  
David Heinemeier Hansson 已提交
643 644
      end

645 646
      # 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.
647
      #
P
Pratik Naik 已提交
648
      # ==== Attributes
649
      #
P
Pratik Naik 已提交
650 651
      # * +id+ - This should be the id or an array of ids to be updated.
      # * +attributes+ - This should be a Hash of attributes to be set on the object, or an array of Hashes.
652 653 654 655
      #
      # ==== Examples
      #
      #   # Updating one record:
P
Pratik Naik 已提交
656
      #   Person.update(15, { :user_name => 'Samuel', :group => 'expert' })
657
      #
658
      #   # Updating multiple records:
P
Pratik Naik 已提交
659
      #   people = { 1 => { "first_name" => "David" }, 2 => { "first_name" => "Jeremy" } }
660
      #   Person.update(people.keys, people.values)
D
Initial  
David Heinemeier Hansson 已提交
661
      def update(id, attributes)
662 663
        if id.is_a?(Array)
          idx = -1
664
          id.collect { |one_id| idx += 1; update(one_id, attributes[idx]) }
665 666 667 668 669
        else
          object = find(id)
          object.update_attributes(attributes)
          object
        end
D
Initial  
David Heinemeier Hansson 已提交
670 671
      end

672 673 674
      # Delete an object (or multiple objects) where the +id+ given matches the primary_key.  A SQL +DELETE+ command
      # is executed on the database which means that no callbacks are fired off running this.  This is an efficient method
      # of deleting records that don't need cleaning up after or other actions to be taken.
675
      #
676 677
      # Objects are _not_ instantiated with this method.
      #
P
Pratik Naik 已提交
678
      # ==== Attributes
679
      #
P
Pratik Naik 已提交
680
      # * +id+ - Can be either an Integer or an Array of Integers.
681 682 683 684 685
      #
      # ==== Examples
      #
      #   # Delete a single object
      #   Todo.delete(1)
686
      #
687 688 689
      #   # Delete multiple objects
      #   todos = [1,2,3]
      #   Todo.delete(todos)
690
      def delete(id)
691
        delete_all([ "#{connection.quote_column_name(primary_key)} IN (?)", id ])
692
      end
693

694 695 696
      # 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.
697 698
      #
      # This essentially finds the object (or multiple objects) with the given id, creates a new object
699 700
      # from the attributes, and then calls destroy on it.
      #
P
Pratik Naik 已提交
701
      # ==== Attributes
702
      #
P
Pratik Naik 已提交
703
      # * +id+ - Can be either an Integer or an Array of Integers.
704 705 706 707 708
      #
      # ==== Examples
      #
      #   # Destroy a single object
      #   Todo.destroy(1)
709
      #
710 711 712
      #   # Destroy multiple objects
      #   todos = [1,2,3]
      #   Todo.destroy(todos)
713
      def destroy(id)
714 715 716 717 718
        if id.is_a?(Array)
          id.map { |one_id| destroy(one_id) }
        else
          find(id).destroy
        end
719 720
      end

721 722
      # Updates all records with details given if they match a set of conditions supplied, limits and order can
      # also be supplied.
723
      #
P
Pratik Naik 已提交
724
      # ==== Attributes
725
      #
P
Pratik Naik 已提交
726 727 728 729
      # * +updates+ - A String of column and value pairs that will be set on any records that match conditions.
      # * +conditions+ - An SQL fragment like "administrator = 1" or [ "user_name = ?", username ].
      #   See conditions in the intro for more info.
      # * +options+ - Additional options are <tt>:limit</tt> and/or <tt>:order</tt>, see the examples for usage.
730 731 732 733 734
      #
      # ==== Examples
      #
      #   # Update all billing objects with the 3 different attributes given
      #   Billing.update_all( "category = 'authorized', approved = 1, author = 'David'" )
735
      #
736 737 738 739
      #   # Update records that match our conditions
      #   Billing.update_all( "author = 'David'", "title LIKE '%Rails%'" )
      #
      #   # Update records that match our conditions but limit it to 5 ordered by date
740
      #   Billing.update_all( "author = 'David'", "title LIKE '%Rails%'",
741
      #                         :order => 'created_at', :limit => 5 )
742
      def update_all(updates, conditions = nil, options = {})
743
        sql  = "UPDATE #{quoted_table_name} SET #{sanitize_sql_for_assignment(updates)} "
744 745
        scope = scope(:find)
        add_conditions!(sql, conditions, scope)
746 747
        add_order!(sql, options[:order], nil)
        add_limit!(sql, options, nil)
748
        connection.update(sql, "#{name} Update")
D
Initial  
David Heinemeier Hansson 已提交
749
      end
750

751 752 753 754 755
      # Destroys the records matching +conditions+ by instantiating each record and calling the destroy method.
      # This means at least 2*N database queries to destroy N records, so avoid destroy_all if you are deleting
      # many records. If you want to simply delete records without worrying about dependent associations or
      # callbacks, use the much faster +delete_all+ method instead.
      #
P
Pratik Naik 已提交
756
      # ==== Attributes
757
      #
P
Pratik Naik 已提交
758
      # * +conditions+ - Conditions are specified the same way as with +find+ method.
759 760 761
      #
      # ==== Example
      #
D
Initial  
David Heinemeier Hansson 已提交
762
      #   Person.destroy_all "last_login < '2004-04-04'"
763 764 765
      #
      # This loads and destroys each person one by one, including its dependent associations and before_ and
      # after_destroy callbacks.
D
Initial  
David Heinemeier Hansson 已提交
766
      def destroy_all(conditions = nil)
767
        find(:all, :conditions => conditions).each { |object| object.destroy }
D
Initial  
David Heinemeier Hansson 已提交
768
      end
769

770 771 772 773
      # Deletes the records matching +conditions+ without instantiating the records first, and hence not
      # calling the destroy method and invoking callbacks. This is a single SQL query, much more efficient
      # than destroy_all.
      #
P
Pratik Naik 已提交
774
      # ==== Attributes
775
      #
P
Pratik Naik 已提交
776
      # * +conditions+ - Conditions are specified the same way as with +find+ method.
777 778 779
      #
      # ==== Example
      #
780
      #   Post.delete_all "person_id = 5 AND (category = 'Something' OR category = 'Else')"
781 782 783
      #
      # This deletes the affected posts all at once with a single DELETE query. If you need to destroy dependent
      # associations or call your before_ or after_destroy callbacks, use the +destroy_all+ method instead.
D
Initial  
David Heinemeier Hansson 已提交
784
      def delete_all(conditions = nil)
785
        sql = "DELETE FROM #{quoted_table_name} "
786
        add_conditions!(sql, conditions, scope(:find))
D
Initial  
David Heinemeier Hansson 已提交
787 788 789 790
        connection.delete(sql, "#{name} Delete all")
      end

      # Returns the result of an SQL statement that should only include a COUNT(*) in the SELECT part.
791
      # The use of this method should be restricted to complicated SQL queries that can't be executed
792 793
      # using the ActiveRecord::Calculations class methods.  Look into those before using this.
      #
P
Pratik Naik 已提交
794
      # ==== Attributes
795
      #
P
Pratik Naik 已提交
796
      # * +sql+ - An SQL statement which should return a count query from the database, see the example below.
797 798 799
      #
      # ==== Examples
      #
800
      #   Product.count_by_sql "SELECT COUNT(*) FROM sales s, customers c WHERE s.customer_id = c.id"
D
Initial  
David Heinemeier Hansson 已提交
801
      def count_by_sql(sql)
802
        sql = sanitize_conditions(sql)
803
        connection.select_value(sql, "#{name} Count").to_i
D
Initial  
David Heinemeier Hansson 已提交
804
      end
805

806 807 808 809 810 811
      # 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 已提交
812
      # ==== Attributes
813
      #
P
Pratik Naik 已提交
814 815 816
      # * +id+ - The id of the object you wish to update a counter on.
      # * +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.
817
      #
818
      # ==== Examples
819 820
      #
      #   # For the Post with id of 5, decrement the comment_count by 1, and
821
      #   # increment the action_count by 1
822
      #   Post.update_counters 5, :comment_count => -1, :action_count => 1
823
      #   # Executes the following SQL:
824 825 826 827 828 829 830
      #   # UPDATE posts
      #   #    SET comment_count = comment_count - 1,
      #   #        action_count = action_count + 1
      #   #  WHERE id = 5
      def update_counters(id, counters)
        updates = counters.inject([]) { |list, (counter_name, increment)|
          sign = increment < 0 ? "-" : "+"
831
          list << "#{connection.quote_column_name(counter_name)} = #{connection.quote_column_name(counter_name)} #{sign} #{increment.abs}"
832
        }.join(", ")
833
        update_all(updates, "#{connection.quote_column_name(primary_key)} = #{quote_value(id)}")
834 835
      end

836 837
      # Increment a number field by one, usually representing a count.
      #
838 839
      # 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
840
      # shown it would have to run an SQL query to find how many posts and comments there are.
841
      #
P
Pratik Naik 已提交
842
      # ==== Attributes
843
      #
P
Pratik Naik 已提交
844 845
      # * +counter_name+ - The name of the field that should be incremented.
      # * +id+ - The id of the object that should be incremented.
846 847 848 849 850
      #
      # ==== 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 已提交
851
      def increment_counter(counter_name, id)
852
        update_counters(id, counter_name => 1)
D
Initial  
David Heinemeier Hansson 已提交
853 854
      end

855 856 857 858
      # 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 已提交
859
      # ==== Attributes
860
      #
P
Pratik Naik 已提交
861 862
      # * +counter_name+ - The name of the field that should be decremented.
      # * +id+ - The id of the object that should be decremented.
863 864 865 866 867
      #
      # ==== 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 已提交
868
      def decrement_counter(counter_name, id)
869
        update_counters(id, counter_name => -1)
D
Initial  
David Heinemeier Hansson 已提交
870 871
      end

D
David Heinemeier Hansson 已提交
872

P
Pratik Naik 已提交
873 874 875 876 877 878 879 880 881
      # 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 已提交
882 883 884 885 886 887 888 889 890 891 892 893
      #
      #   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"
894
      #
P
Pratik Naik 已提交
895 896
      # To start from an all-closed default and enable attributes as needed,
      # have a look at +attr_accessible+.
D
Initial  
David Heinemeier Hansson 已提交
897
      def attr_protected(*attributes)
898
        write_inheritable_attribute("attr_protected", Set.new(attributes.map(&:to_s)) + (protected_attributes || []))
D
Initial  
David Heinemeier Hansson 已提交
899
      end
900

901
      # Returns an array of all the attributes that have been protected from mass-assignment.
D
Initial  
David Heinemeier Hansson 已提交
902 903 904 905
      def protected_attributes # :nodoc:
        read_inheritable_attribute("attr_protected")
      end

P
Pratik Naik 已提交
906 907 908 909
      # 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>
910
      #
P
Pratik Naik 已提交
911 912 913 914 915 916 917
      # 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+.
918 919
      #
      #   class Customer < ActiveRecord::Base
920
      #     attr_accessible :name, :nickname
921 922
      #   end
      #
923 924 925 926
      #   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
927
      #
928 929
      #   customer.credit_rating = "Average"
      #   customer.credit_rating # => "Average"
D
Initial  
David Heinemeier Hansson 已提交
930
      def attr_accessible(*attributes)
931
        write_inheritable_attribute("attr_accessible", Set.new(attributes.map(&:to_s)) + (accessible_attributes || []))
D
Initial  
David Heinemeier Hansson 已提交
932
      end
933

934
      # Returns an array of all the attributes that have been made accessible to mass-assignment.
D
Initial  
David Heinemeier Hansson 已提交
935 936 937 938
      def accessible_attributes # :nodoc:
        read_inheritable_attribute("attr_accessible")
      end

939 940
       # Attributes listed as readonly can be set for a new record, but will be ignored in database updates afterwards.
       def attr_readonly(*attributes)
941
         write_inheritable_attribute("attr_readonly", Set.new(attributes.map(&:to_s)) + (readonly_attributes || []))
942 943 944 945 946 947
       end

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

949 950 951
      # 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 已提交
952
      # class on retrieval or SerializationTypeMismatch will be raised.
D
David Heinemeier Hansson 已提交
953
      #
P
Pratik Naik 已提交
954
      # ==== Attributes
D
David Heinemeier Hansson 已提交
955
      #
P
Pratik Naik 已提交
956 957
      # * +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 已提交
958 959 960 961 962 963
      #
      # ==== Example
      #   # Serialize a preferences attribute
      #   class User
      #     serialize :preferences
      #   end
D
Initial  
David Heinemeier Hansson 已提交
964
      def serialize(attr_name, class_name = Object)
965
        serialized_attributes[attr_name.to_s] = class_name
D
Initial  
David Heinemeier Hansson 已提交
966
      end
967

D
Initial  
David Heinemeier Hansson 已提交
968 969
      # Returns a hash of all the attributes that have been specified for serialization as keys and their class restriction as values.
      def serialized_attributes
970
        read_inheritable_attribute("attr_serialized") or write_inheritable_attribute("attr_serialized", {})
D
Initial  
David Heinemeier Hansson 已提交
971 972
      end

D
David Heinemeier Hansson 已提交
973

D
Initial  
David Heinemeier Hansson 已提交
974
      # Guesses the table name (in forced lower-case) based on the name of the class in the inheritance hierarchy descending
P
Pratik Naik 已提交
975
      # directly from ActiveRecord::Base. So if the hierarchy looks like: Reply < Message < ActiveRecord::Base, then Message is used
976
      # to guess the table name even when called on Reply. The rules used to do the guess are handled by the Inflector class
977
      # 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 已提交
978
      #
979
      # Nested classes are given table names prefixed by the singular form of
P
Pratik Naik 已提交
980 981 982
      # the parent's table name. Enclosing modules are not considered.
      #
      # ==== Examples
983 984
      #
      #   class Invoice < ActiveRecord::Base; end;
985 986
      #   file                  class               table_name
      #   invoice.rb            Invoice             invoices
987 988 989 990 991 992 993 994
      #
      #   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 已提交
995
      #
P
Pratik Naik 已提交
996 997
      # Additionally, the class-level +table_name_prefix+ is prepended and the
      # +table_name_suffix+ is appended.  So if you have "myapp_" as a prefix,
998 999 1000 1001 1002
      # 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 已提交
1003 1004
      #
      #   class Mouse < ActiveRecord::Base
1005
      #     set_table_name "mice"
D
Initial  
David Heinemeier Hansson 已提交
1006
      #   end
1007
      def table_name
1008 1009 1010
        reset_table_name
      end

D
David Heinemeier Hansson 已提交
1011
      def reset_table_name #:nodoc:
1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027
        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 已提交
1028
        set_table_name(name)
1029
        name
D
Initial  
David Heinemeier Hansson 已提交
1030 1031
      end

1032
      # Defines the primary key field -- can be overridden in subclasses. Overwriting will negate any effect of the
D
Initial  
David Heinemeier Hansson 已提交
1033 1034
      # primary_key_prefix_type setting, though.
      def primary_key
1035 1036 1037
        reset_primary_key
      end

D
David Heinemeier Hansson 已提交
1038
      def reset_primary_key #:nodoc:
1039 1040 1041 1042 1043 1044
        key = get_primary_key(base_class.name)
        set_primary_key(key)
        key
      end

      def get_primary_key(base_name) #:nodoc:
1045
        key = 'id'
D
Initial  
David Heinemeier Hansson 已提交
1046 1047
        case primary_key_prefix_type
          when :table_name
1048
            key = base_name.to_s.foreign_key(false)
D
Initial  
David Heinemeier Hansson 已提交
1049
          when :table_name_with_underscore
1050
            key = base_name.to_s.foreign_key
D
Initial  
David Heinemeier Hansson 已提交
1051
        end
1052
        key
D
Initial  
David Heinemeier Hansson 已提交
1053 1054
      end

1055 1056
      # 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 已提交
1057
      def inheritance_column
1058
        @inheritance_column ||= "type".freeze
D
Initial  
David Heinemeier Hansson 已提交
1059 1060
      end

1061 1062
      # 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 已提交
1063
      def sequence_name #:nodoc:
1064 1065 1066
        reset_sequence_name
      end

D
David Heinemeier Hansson 已提交
1067
      def reset_sequence_name #:nodoc:
1068 1069 1070
        default = connection.default_sequence_name(table_name, primary_key)
        set_sequence_name(default)
        default
1071 1072
      end

1073
      # Sets the table name to use to the given value, or (if the value
1074
      # is nil or false) to the value returned by the given block.
1075 1076 1077 1078
      #
      #   class Project < ActiveRecord::Base
      #     set_table_name "project"
      #   end
1079
      def set_table_name(value = nil, &block)
1080 1081 1082 1083 1084 1085
        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
1086
      # block.
1087 1088 1089 1090
      #
      #   class Project < ActiveRecord::Base
      #     set_primary_key "sysid"
      #   end
1091
      def set_primary_key(value = nil, &block)
1092 1093 1094 1095 1096 1097
        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
1098
      # given block.
1099 1100 1101 1102 1103 1104
      #
      #   class Project < ActiveRecord::Base
      #     set_inheritance_column do
      #       original_inheritance_column + "_id"
      #     end
      #   end
1105
      def set_inheritance_column(value = nil, &block)
1106 1107 1108 1109
        define_attr_method :inheritance_column, value, &block
      end
      alias :inheritance_column= :set_inheritance_column

1110 1111
      # 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
1112 1113
      # given block. This is required for Oracle and is useful for any
      # database which relies on sequences for primary key generation.
1114
      #
1115 1116 1117 1118 1119
      # 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.
1120 1121 1122 1123
      #
      #   class Project < ActiveRecord::Base
      #     set_sequence_name "projectseq"   # default would have been "project_seq"
      #   end
1124
      def set_sequence_name(value = nil, &block)
1125 1126 1127 1128
        define_attr_method :sequence_name, value, &block
      end
      alias :sequence_name= :set_sequence_name

D
Initial  
David Heinemeier Hansson 已提交
1129 1130 1131
      # 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
1132 1133 1134
        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 已提交
1135 1136
      end

1137 1138
      # Indicates whether the table associated with this class exists
      def table_exists?
1139
        connection.table_exists?(table_name)
1140 1141
      end

D
Initial  
David Heinemeier Hansson 已提交
1142 1143
      # Returns an array of column objects for the table associated with this class.
      def columns
1144
        unless defined?(@columns) && @columns
1145
          @columns = connection.columns(table_name, "#{name} Columns")
1146
          @columns.each { |column| column.primary = column.name == primary_key }
1147 1148
        end
        @columns
D
Initial  
David Heinemeier Hansson 已提交
1149
      end
1150

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

D
David Heinemeier Hansson 已提交
1156
      # Returns an array of column names as strings.
1157
      def column_names
1158
        @column_names ||= columns.map { |column| column.name }
1159
      end
D
Initial  
David Heinemeier Hansson 已提交
1160

1161 1162
      # 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 已提交
1163
      def content_columns
1164
        @content_columns ||= columns.reject { |c| c.primary || c.name =~ /(_id|_count)$/ || c.name == inheritance_column }
D
Initial  
David Heinemeier Hansson 已提交
1165 1166 1167 1168
      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
1169
      # is available.
D
David Heinemeier Hansson 已提交
1170
      def column_methods_hash #:nodoc:
1171
        @dynamic_methods_hash ||= column_names.inject(Hash.new(false)) do |methods, attr|
1172 1173 1174 1175 1176
          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 已提交
1177 1178 1179
          methods
        end
      end
1180

1181
      # Resets all the cached information about columns, which will cause them to be reloaded on the next request.
1182
      def reset_column_information
1183 1184
        generated_methods.each { |name| undef_method(name) }
        @column_names = @columns = @columns_hash = @content_columns = @dynamic_methods_hash = @generated_methods = @inheritance_column = nil
1185 1186
      end

1187
      def reset_column_information_and_inheritable_attributes_for_all_subclasses#:nodoc:
1188 1189
        subclasses.each { |klass| klass.reset_inheritable_attributes; klass.reset_column_information }
      end
D
Initial  
David Heinemeier Hansson 已提交
1190 1191 1192

      # 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"
1193 1194
      # Deprecated in favor of just calling "first_name".humanize
      def human_attribute_name(attribute_key_name) #:nodoc:
1195
        attribute_key_name.humanize
D
Initial  
David Heinemeier Hansson 已提交
1196
      end
1197

1198 1199 1200 1201 1202 1203 1204
      # 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 已提交
1205 1206
      end

1207 1208 1209 1210 1211
      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

1212
      # Returns a string like 'Post id:integer, title:string, body:text'
1213
      def inspect
1214 1215 1216 1217
        if self == Base
          super
        elsif abstract_class?
          "#{super}(abstract)"
1218
        elsif table_exists?
1219 1220
          attr_list = columns.map { |c| "#{c.name}: #{c.type}" } * ', '
          "#{super}(#{attr_list})"
1221 1222
        else
          "#{super}(Table doesn't exist)"
1223
        end
1224 1225
      end

1226 1227

      def quote_value(value, column = nil) #:nodoc:
1228
        connection.quote(value,column)
1229 1230
      end

1231
      # Used to sanitize objects before they're used in an SQL SELECT statement. Delegates to <tt>connection.quote</tt>.
1232
      def sanitize(object) #:nodoc:
1233
        connection.quote(object)
D
Initial  
David Heinemeier Hansson 已提交
1234 1235
      end

1236
      # Log and benchmark multiple statements in a single block. Example:
D
Initial  
David Heinemeier Hansson 已提交
1237 1238 1239 1240
      #
      #   Project.benchmark("Creating project") do
      #     project = Project.create("name" => "stuff")
      #     project.create_manager("name" => "David")
1241
      #     project.milestones << Milestone.find(:all)
D
Initial  
David Heinemeier Hansson 已提交
1242
      #   end
1243
      #
1244 1245 1246
      # 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.
1247
      #
1248
      # The logging of the multiple statements is turned off unless <tt>use_silence</tt> is set to false.
1249
      def benchmark(title, log_level = Logger::DEBUG, use_silence = true)
1250
        if logger && logger.level <= log_level
1251 1252
          result = nil
          seconds = Benchmark.realtime { result = use_silence ? silence { yield } : yield }
1253
          logger.add(log_level, "#{title} (#{'%.5f' % seconds})")
1254 1255 1256 1257
          result
        else
          yield
        end
1258
      end
1259

1260 1261
      # Silences the logger for the duration of the block.
      def silence
1262 1263 1264
        old_logger_level, logger.level = logger.level, Logger::ERROR if logger
        yield
      ensure
1265
        logger.level = old_logger_level if logger
D
Initial  
David Heinemeier Hansson 已提交
1266
      end
1267

1268 1269 1270
      # Overwrite the default class equality method to provide support for association proxies.
      def ===(object)
        object.is_a?(self)
1271
      end
1272

1273 1274 1275 1276 1277 1278 1279
      # 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 已提交
1280
      # Set this to true if this is an abstract class (see <tt>abstract_class?</tt>).
1281 1282 1283 1284 1285
      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?
1286
        defined?(@abstract_class) && @abstract_class == true
1287 1288
      end

1289 1290 1291 1292 1293 1294 1295
      def respond_to?(method_id, include_private = false)
        if match = matches_dynamic_finder?(method_id) || matches_dynamic_finder_with_initialize_or_create?(method_id)
          return true if all_attributes_exists?(extract_attribute_names_from_match(match))
        end
        super
      end

1296 1297 1298 1299
      def sti_name
        store_full_sti_class ? name : name.demodulize
      end

D
Initial  
David Heinemeier Hansson 已提交
1300
      private
1301
        def find_initial(options)
1302
          options.update(:limit => 1)
1303 1304
          find_every(options).first
        end
1305

1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318
        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)
            scoped_order = reverse_sql_order(scope(:find, :order))
            scoped_methods.select { |s| s[:find].update(:order => scoped_order) }
          end
1319

1320 1321 1322 1323 1324 1325 1326 1327 1328
          find_initial(options.merge({ :order => order }))
        end

        def reverse_sql_order(order_query)
          reversed_query = order_query.split(/,/).each { |s|
            if s.match(/\s(asc|ASC)$/)
              s.gsub!(/\s(asc|ASC)$/, ' DESC')
            elsif s.match(/\s(desc|DESC)$/)
              s.gsub!(/\s(desc|DESC)$/, ' ASC')
1329
            elsif !s.match(/\s(asc|ASC|desc|DESC)$/)
1330 1331 1332 1333
              s.concat(' DESC')
            end
          }.join(',')
        end
1334

1335
        def find_every(options)
1336 1337 1338 1339 1340 1341 1342 1343 1344 1345
          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
1346 1347 1348 1349 1350

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

          records
        end
1351

1352
        def find_from_ids(ids, options)
1353
          expects_array = ids.first.kind_of?(Array)
1354
          return ids.first if expects_array && ids.first.empty?
1355

1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367
          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
1368

1369 1370
        def find_one(id, options)
          conditions = " AND (#{sanitize_sql(options[:conditions])})" if options[:conditions]
1371
          options.update :conditions => "#{quoted_table_name}.#{connection.quote_column_name(primary_key)} = #{quote_value(id,columns_hash[primary_key])}#{conditions}"
1372

1373 1374 1375 1376
          # 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
1377 1378 1379 1380 1381
            result
          else
            raise RecordNotFound, "Couldn't find #{name} with ID=#{id}#{conditions}"
          end
        end
1382

1383 1384
        def find_some(ids, options)
          conditions = " AND (#{sanitize_sql(options[:conditions])})" if options[:conditions]
1385
          ids_list   = ids.map { |id| quote_value(id,columns_hash[primary_key]) }.join(',')
1386
          options.update :conditions => "#{quoted_table_name}.#{connection.quote_column_name(primary_key)} IN (#{ids_list})#{conditions}"
1387 1388 1389

          result = find_every(options)

1390
          # Determine expected size from limit and offset, not just ids.size.
1391 1392 1393 1394 1395 1396
          expected_size =
            if options[:limit] && ids.size > options[:limit]
              options[:limit]
            else
              ids.size
            end
1397 1398 1399 1400 1401

          # 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
1402 1403

          if result.size == expected_size
1404 1405
            result
          else
1406
            raise RecordNotFound, "Couldn't find all #{name.pluralize} with IDs (#{ids_list})#{conditions} (found #{result.size} results, but was looking for #{expected_size})"
1407 1408 1409
          end
        end

1410 1411 1412
        # 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 已提交
1413
        def instantiate(record)
1414
          object =
1415
            if subclass_name = record[inheritance_column]
1416
              # No type given.
1417 1418
              if subclass_name.empty?
                allocate
1419

1420
              else
1421 1422
                # Ignore type if no column is present since it was probably
                # pulled in from a sloppy join.
1423
                unless columns_hash.include?(inheritance_column)
1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435
                  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
1436 1437 1438 1439
                end
              end
            else
              allocate
1440
            end
1441

D
Initial  
David Heinemeier Hansson 已提交
1442
          object.instance_variable_set("@attributes", record)
1443
          object.instance_variable_set("@attributes_cache", Hash.new)
1444 1445 1446 1447 1448 1449 1450 1451 1452

          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

1453
          object
D
Initial  
David Heinemeier Hansson 已提交
1454
        end
1455

1456 1457
        # 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 已提交
1458
        def type_name_with_module(type_name)
1459 1460 1461 1462 1463
          if store_full_sti_class
            type_name
          else
            (/^::/ =~ type_name) ? type_name : "#{parent.name}::#{type_name}"
          end
D
Initial  
David Heinemeier Hansson 已提交
1464 1465
        end

1466
        def construct_finder_sql(options)
1467
          scope = scope(:find)
1468
          sql  = "SELECT #{options[:select] || (scope && scope[:select]) || (options[:joins] && quoted_table_name + '.*') || '*'} "
1469
          sql << "FROM #{(scope && scope[:from]) || options[:from] || quoted_table_name} "
1470

1471 1472
          add_joins!(sql, options, scope)
          add_conditions!(sql, options[:conditions], scope)
1473

1474
          add_group!(sql, options[:group], scope)
1475
          add_order!(sql, options[:order], scope)
1476
          add_limit!(sql, options, scope)
1477
          add_lock!(sql, options, scope)
1478

1479
          sql
1480
        end
1481

1482 1483
        # Merges includes so that the result is a valid +include+
        def merge_includes(first, second)
1484
         (safe_to_array(first) + safe_to_array(second)).uniq
1485 1486
        end

1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500
        # 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

1501
        # Object#to_a is deprecated, though it does have the desired behavior
1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512
        def safe_to_array(o)
          case o
          when NilClass
            []
          when Array
            o
          else
            [o]
          end
        end

1513 1514 1515
        def add_order!(sql, order, scope = :auto)
          scope = scope(:find) if :auto == scope
          scoped_order = scope[:order] if scope
1516 1517
          if order
            sql << " ORDER BY #{order}"
1518
            sql << ", #{scoped_order}" if scoped_order
1519
          else
1520
            sql << " ORDER BY #{scoped_order}" if scoped_order
1521 1522
          end
        end
1523

1524
        def add_group!(sql, group, scope = :auto)
1525 1526
          if group
            sql << " GROUP BY #{group}"
1527 1528 1529 1530 1531 1532
          else
            scope = scope(:find) if :auto == scope
            if scope && (scoped_group = scope[:group])
              sql << " GROUP BY #{scoped_group}"
            end
          end
1533
        end
1534

1535
        # The optional scope argument is for the current <tt>:find</tt> scope.
1536 1537
        def add_limit!(sql, options, scope = :auto)
          scope = scope(:find) if :auto == scope
1538 1539 1540 1541 1542 1543

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

1544
          connection.add_limit_offset!(sql, options)
1545
        end
1546

1547 1548
        # 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>.
1549
        def add_lock!(sql, options, scope = :auto)
1550
          scope = scope(:find) if :auto == scope
1551 1552 1553 1554
          options = options.reverse_merge(:lock => scope[:lock]) if scope
          connection.add_lock!(sql, options)
        end

1555
        # The optional scope argument is for the current <tt>:find</tt> scope.
1556 1557
        def add_joins!(sql, options, scope = :auto)
          scope = scope(:find) if :auto == scope
1558 1559 1560 1561 1562 1563 1564 1565
          [(scope && scope[:joins]), options[:joins]].each do |join|
            case join
            when Symbol, Hash, Array
              join_dependency = ActiveRecord::Associations::ClassMethods::InnerJoinDependency.new(self, join, nil)
              sql << " #{join_dependency.join_associations.collect { |assoc| assoc.association_join }.join} "
            else
              sql << " #{join} "
            end
1566
          end
1567
        end
1568

1569
        # Adds a sanitized version of +conditions+ to the +sql+ string. Note that the passed-in +sql+ string is changed.
1570
        # The optional scope argument is for the current <tt>:find</tt> scope.
1571 1572
        def add_conditions!(sql, conditions, scope = :auto)
          scope = scope(:find) if :auto == scope
1573 1574 1575 1576 1577
          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 已提交
1578
        end
1579

D
Initial  
David Heinemeier Hansson 已提交
1580
        def type_condition
1581
          quoted_inheritance_column = connection.quote_column_name(inheritance_column)
1582 1583
          type_condition = subclasses.inject("#{quoted_table_name}.#{quoted_inheritance_column} = '#{sti_name}' ") do |condition, subclass|
            condition << "OR #{quoted_table_name}.#{quoted_inheritance_column} = '#{subclass.sti_name}' "
1584
          end
1585 1586

          " (#{type_condition}) "
D
Initial  
David Heinemeier Hansson 已提交
1587 1588 1589
        end

        # Guesses the table name, but does not decorate it with prefix and suffix information.
1590
        def undecorated_table_name(class_name = base_class.name)
1591 1592
          table_name = class_name.to_s.demodulize.underscore
          table_name = table_name.pluralize if pluralize_table_names
1593
          table_name
D
Initial  
David Heinemeier Hansson 已提交
1594 1595
        end

1596 1597
        # Enables dynamic finders like find_by_user_name(user_name) and find_by_user_name_and_password(user_name, password) that are turned into
        # find(:first, :conditions => ["user_name = ?", user_name]) and  find(:first, :conditions => ["user_name = ? AND password = ?", user_name, password])
1598
        # respectively. Also works for find(:all) by using find_all_by_amount(50) that is turned into find(:all, :conditions => ["amount = ?", 50]).
1599
        #
1600 1601
        # It's even possible to use all the additional parameters to find. For example, the full interface for find_all_by_amount
        # is actually find_all_by_amount(amount, options).
1602
        #
1603
        # This also enables you to initialize a record if it is not found, such as find_or_initialize_by_amount(amount)
1604
        # or find_or_create_by_user_and_password(user, password).
1605 1606 1607
        #
        # Each dynamic finder or initializer/creator is also defined in the class after it is first invoked, so that future
        # attempts to use it do not run through method_missing.
1608
        def method_missing(method_id, *arguments)
1609
          if match = matches_dynamic_finder?(method_id)
1610
            finder = determine_finder(match)
1611

1612 1613
            attribute_names = extract_attribute_names_from_match(match)
            super unless all_attributes_exists?(attribute_names)
1614

1615
            self.class_eval %{
1616
              def self.#{method_id}(*args)
1617
                options = args.extract_options!
1618 1619 1620
                attributes = construct_attributes_from_arguments([:#{attribute_names.join(',:')}], args)
                finder_options = { :conditions => attributes }
                validate_find_options(options)
1621 1622
                set_readonly_option!(options)

1623 1624 1625
                if options[:conditions]
                  with_scope(:find => finder_options) do
                    ActiveSupport::Deprecation.silence { send(:#{finder}, options) }
1626 1627
                  end
                else
1628
                  ActiveSupport::Deprecation.silence { send(:#{finder}, options.merge(finder_options)) }
1629
                end
1630
              end
1631
            }, __FILE__, __LINE__
1632
            send(method_id, *arguments)
1633
          elsif match = matches_dynamic_finder_with_initialize_or_create?(method_id)
1634
            instantiator = determine_instantiator(match)
1635 1636 1637
            attribute_names = extract_attribute_names_from_match(match)
            super unless all_attributes_exists?(attribute_names)

1638
            self.class_eval %{
1639
              def self.#{method_id}(*args)
1640
                guard_protected_attributes = false
1641

1642
                if args[0].is_a?(Hash)
1643
                  guard_protected_attributes = true
1644 1645 1646 1647 1648
                  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
1649

1650 1651
                options = { :conditions => find_attributes }
                set_readonly_option!(options)
1652

1653
                record = find_initial(options)
1654

1655 1656 1657
                 if record.nil?
                  record = self.new { |r| r.send(:attributes=, attributes, guard_protected_attributes) }
                  #{'yield(record) if block_given?'}
1658 1659 1660
                  #{'record.save' if instantiator == :create}
                  record
                else
1661
                  record
1662
                end
1663
              end
1664
            }, __FILE__, __LINE__
1665
            send(method_id, *arguments)
1666 1667 1668 1669
          else
            super
          end
        end
D
Initial  
David Heinemeier Hansson 已提交
1670

1671 1672 1673 1674 1675 1676 1677 1678
        def matches_dynamic_finder?(method_id)
          /^find_(all_by|by)_([_a-zA-Z]\w*)$/.match(method_id.to_s)
        end

        def matches_dynamic_finder_with_initialize_or_create?(method_id)
          /^find_or_(initialize|create)_by_([_a-zA-Z]\w*)$/.match(method_id.to_s)
        end

1679
        def determine_finder(match)
1680 1681 1682
          match.captures.first == 'all_by' ? :find_every : :find_initial
        end

1683 1684 1685 1686
        def determine_instantiator(match)
          match.captures.first == 'initialize' ? :new : :create
        end

1687 1688 1689 1690 1691 1692 1693 1694 1695 1696
        def extract_attribute_names_from_match(match)
          match.captures.last.split('_and_')
        end

        def construct_attributes_from_arguments(attribute_names, arguments)
          attributes = {}
          attribute_names.each_with_index { |name, idx| attributes[name] = arguments[idx] }
          attributes
        end

1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711
        # 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

1712
        def all_attributes_exists?(attribute_names)
1713
          attribute_names = expand_attribute_names_for_aggregates(attribute_names)
1714
          attribute_names.all? { |name| column_methods_hash.include?(name.to_sym) }
1715
        end
1716

1717 1718 1719
        def attribute_condition(argument)
          case argument
            when nil   then "IS ?"
1720
            when Array, ActiveRecord::Associations::AssociationCollection then "IN (?)"
1721
            when Range then "BETWEEN ? AND ?"
1722 1723 1724 1725
            else            "= ?"
          end
        end

1726 1727 1728 1729
        # 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
1730
            else sanitize_sql(primary_key => id_or_conditions)
1731 1732 1733 1734
          end
        end


P
Pratik Naik 已提交
1735 1736
        # Defines an "attribute" method (like +inheritance_column+ or
        # +table_name+). A new (class) method will be created with the
1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754
        # 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)
          sing = class << self; self; end
1755
          sing.send :alias_method, "original_#{name}", name
1756 1757 1758
          if block_given?
            sing.send :define_method, name, &block
          else
1759 1760 1761 1762
            # 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
1763 1764
        end

D
Initial  
David Heinemeier Hansson 已提交
1765
      protected
1766
        # Scope parameters to method calls within the block.  Takes a hash of method_name => parameters hash.
1767 1768
        # 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.
1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779
        #
        #   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 已提交
1780
        # In nested scopings, all previous parameters are overwritten by the innermost rule, with the exception of
1781
        # <tt>:conditions</tt> and <tt>:include</tt> options in <tt>:find</tt>, which are merged.
1782 1783 1784 1785
        #
        #   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 已提交
1786
        #         with_scope(:find => { :limit => 10 })
1787 1788 1789 1790 1791 1792 1793 1794 1795
        #           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
        #
1796
        # You can ignore any previous scopings by using the <tt>with_exclusive_scope</tt> method.
1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818
        #
        #   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
        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]
1819
            f.assert_valid_keys(VALID_FIND_OPTIONS)
1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831
            set_readonly_option! f
          end

          # Merge scopings
          if action == :merge && current_scoped_methods
            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
1832
                        hash[method][key] = merge_conditions(params[key], hash[method][key])
1833
                      elsif key == :include && merge
1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862
                        hash[method][key] = merge_includes(hash[method][key], params[key]).uniq
                      else
                        hash[method][key] = hash[method][key] || params[key]
                      end
                    end
                  else
                    hash[method] = params.merge(hash[method])
                  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 已提交
1863
        def subclasses #:nodoc:
D
Initial  
David Heinemeier Hansson 已提交
1864 1865 1866
          @@subclasses[self] ||= []
          @@subclasses[self] + extra = @@subclasses[self].inject([]) {|list, subclass| list + subclass.subclasses }
        end
1867 1868

        # Test whether the given method and optional key are scoped.
D
David Heinemeier Hansson 已提交
1869
        def scoped?(method, key = nil) #:nodoc:
1870 1871 1872
          if current_scoped_methods && (scope = current_scoped_methods[method])
            !key || scope.has_key?(key)
          end
1873 1874 1875
        end

        # Retrieve the scope for the given method and optional key.
D
David Heinemeier Hansson 已提交
1876
        def scope(method, key = nil) #:nodoc:
1877
          if current_scoped_methods && (scope = current_scoped_methods[method])
1878 1879 1880 1881
            key ? scope[key] : scope
          end
        end

1882 1883 1884
        def thread_safe_scoped_methods #:nodoc:
          scoped_methods = (Thread.current[:scoped_methods] ||= {})
          scoped_methods[self] ||= []
1885
        end
1886

1887 1888 1889
        def single_threaded_scoped_methods #:nodoc:
          @scoped_methods ||= []
        end
1890

1891 1892 1893 1894 1895 1896
        # pick up the correct scoped_methods version from @@allow_concurrency
        if @@allow_concurrency
          alias_method :scoped_methods, :thread_safe_scoped_methods
        else
          alias_method :scoped_methods, :single_threaded_scoped_methods
        end
1897

D
David Heinemeier Hansson 已提交
1898
        def current_scoped_methods #:nodoc:
1899
          scoped_methods.last
1900
        end
1901

1902 1903
        # Returns the class type of the record using the current module as a prefix. So descendents of
        # MyApp::Business::Account would appear as MyApp::Business::AccountSubclass.
D
Initial  
David Heinemeier Hansson 已提交
1904
        def compute_type(type_name)
1905
          modularized_name = type_name_with_module(type_name)
1906
          begin
1907 1908 1909
            class_eval(modularized_name, __FILE__, __LINE__)
          rescue NameError
            class_eval(type_name, __FILE__, __LINE__)
D
Initial  
David Heinemeier Hansson 已提交
1910 1911 1912
          end
        end

P
Pratik Naik 已提交
1913
        # Returns the class descending directly from Active Record in the inheritance hierarchy.
1914
        def class_of_active_record_descendant(klass)
1915
          if klass.superclass == Base || klass.superclass.abstract_class?
1916
            klass
D
Initial  
David Heinemeier Hansson 已提交
1917 1918 1919
          elsif klass.superclass.nil?
            raise ActiveRecordError, "#{name} doesn't belong in a hierarchy descending from ActiveRecord"
          else
1920
            class_of_active_record_descendant(klass.superclass)
D
Initial  
David Heinemeier Hansson 已提交
1921 1922 1923
          end
        end

P
Pratik Naik 已提交
1924
        # Returns the name of the class descending directly from Active Record in the inheritance hierarchy.
D
David Heinemeier Hansson 已提交
1925
        def class_name_of_active_record_descendant(klass) #:nodoc:
1926
          klass.base_class.name
1927 1928
        end

P
Pratik Naik 已提交
1929
        # Accepts an array, hash, or string of SQL conditions and sanitizes
1930
        # them into a valid SQL fragment for a WHERE clause.
1931 1932 1933
        #   ["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'"
1934
        def sanitize_sql_for_conditions(condition)
1935 1936
          return nil if condition.blank?

1937 1938
          case condition
            when Array; sanitize_sql_array(condition)
1939
            when Hash;  sanitize_sql_hash_for_conditions(condition)
1940 1941
            else        condition
          end
1942
        end
1943
        alias_method :sanitize_sql, :sanitize_sql_for_conditions
1944

P
Pratik Naik 已提交
1945
        # Accepts an array, hash, or string of SQL conditions and sanitizes
1946 1947 1948 1949 1950 1951 1952 1953 1954 1955
        # 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

1956 1957 1958 1959 1960
        def aggregate_mapping(reflection)
          mapping = reflection.options[:mapping] || [reflection.name, reflection.name]
          mapping.first.is_a?(Array) ? mapping : [mapping]
        end

P
Pratik Naik 已提交
1961
        # Accepts a hash of SQL conditions and replaces those attributes
1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990
        # 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

1991
        # Sanitizes a hash of attribute/value pairs into SQL conditions for a WHERE clause.
1992 1993 1994 1995
        #   { :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)"
1996 1997
        #   { :age => 13..18 }
        #     # => "age BETWEEN 13 AND 18"
1998 1999
        #   { 'other_records.id' => 7 }
        #     # => "`other_records`.`id` = 7"
2000 2001 2002
        # 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'"
2003
        def sanitize_sql_hash_for_conditions(attrs)
2004 2005
          attrs = expand_hash_conditions_for_aggregates(attrs)

2006
          conditions = attrs.map do |attr, value|
2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017
            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)
            else
              table_name = quoted_table_name
            end

            "#{table_name}.#{connection.quote_column_name(attr)} #{attribute_condition(value)}"
2018 2019
          end.join(' AND ')

2020
          replace_bind_variables(conditions, expand_range_bind_variables(attrs.values))
2021
        end
2022 2023 2024 2025 2026 2027
        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)
2028
          attrs.map do |attr, value|
2029 2030 2031
            "#{connection.quote_column_name(attr)} = #{quote_bound_value(value)}"
          end.join(', ')
        end
2032

2033
        # Accepts an array of conditions.  The array has each value
P
Pratik Naik 已提交
2034
        # sanitized and interpolated into the SQL statement.
2035
        #   ["name='%s' and group_id='%s'", "foo'bar", 4]  returns  "name='foo''bar' and group_id='4'"
2036
        def sanitize_sql_array(ary)
2037 2038 2039 2040
          statement, *values = ary
          if values.first.is_a?(Hash) and statement =~ /:\w+/
            replace_named_bind_variables(statement, values.first)
          elsif statement.include?('?')
2041 2042
            replace_bind_variables(statement, values)
          else
2043
            statement % values.collect { |value| connection.quote_string(value.to_s) }
2044
          end
2045 2046
        end

2047 2048
        alias_method :sanitize_conditions, :sanitize_sql

D
David Heinemeier Hansson 已提交
2049
        def replace_bind_variables(statement, values) #:nodoc:
2050
          raise_if_bind_arity_mismatch(statement, statement.count('?'), values.size)
2051
          bound = values.dup
2052
          statement.gsub('?') { quote_bound_value(bound.shift) }
2053 2054
        end

D
David Heinemeier Hansson 已提交
2055
        def replace_named_bind_variables(statement, bind_vars) #:nodoc:
2056
          statement.gsub(/:([a-zA-Z]\w*)/) do
2057
            match = $1.to_sym
2058
            if bind_vars.include?(match)
2059
              quote_bound_value(bind_vars[match])
2060 2061
            else
              raise PreparedStatementInvalid, "missing value for :#{match} in #{statement}"
2062 2063
            end
          end
2064 2065
        end

2066
        def expand_range_bind_variables(bind_vars) #:nodoc:
2067 2068 2069
          expanded = []

          bind_vars.each do |var|
2070
            if var.is_a?(Range)
2071 2072
              expanded << var.first
              expanded << var.last
2073
            else
2074
              expanded << var
2075
            end
2076
          end
2077 2078

          expanded
2079 2080
        end

D
David Heinemeier Hansson 已提交
2081
        def quote_bound_value(value) #:nodoc:
2082 2083 2084
          if value.respond_to?(:map) && !value.is_a?(String)
            if value.respond_to?(:empty?) && value.empty?
              connection.quote(nil)
2085 2086 2087
            else
              value.map { |v| connection.quote(v) }.join(',')
            end
2088 2089
          else
            connection.quote(value)
2090 2091 2092
          end
        end

D
David Heinemeier Hansson 已提交
2093
        def raise_if_bind_arity_mismatch(statement, expected, provided) #:nodoc:
2094 2095 2096
          unless expected == provided
            raise PreparedStatementInvalid, "wrong number of bind variables (#{provided} for #{expected}) in: #{statement}"
          end
2097
        end
2098

2099
        VALID_FIND_OPTIONS = [ :conditions, :include, :joins, :limit, :offset,
2100 2101
                               :order, :select, :readonly, :group, :from, :lock ]

D
David Heinemeier Hansson 已提交
2102
        def validate_find_options(options) #:nodoc:
2103 2104
          options.assert_valid_keys(VALID_FIND_OPTIONS)
        end
2105

D
David Heinemeier Hansson 已提交
2106
        def set_readonly_option!(options) #:nodoc:
2107 2108 2109
          # 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 已提交
2110 2111
            if scoped_readonly = scope(:find, :readonly)
              options[:readonly] = scoped_readonly
2112
            elsif !options[:joins].blank? && !options[:select]
2113 2114 2115
              options[:readonly] = true
            end
          end
D
Initial  
David Heinemeier Hansson 已提交
2116
        end
2117

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

2142 2143
      # 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 已提交
2144
      def id
2145
        attr_name = self.class.primary_key
2146
        column = column_for_attribute(attr_name)
2147

2148 2149 2150 2151
        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 已提交
2152
      end
2153

2154
      # Enables Active Record objects to be used as URL parameters in Action Pack automatically.
2155
      def to_param
2156
        # We can't use alias_method here, because method 'id' optimizes itself on the fly.
2157
        (id = self.id) ? id.to_s : nil # Be sure to stringify the id for routes
2158
      end
2159

P
Pratik Naik 已提交
2160 2161 2162
      # Returns a cache key that can be used to identify this record.
      #
      # ==== Examples
2163 2164 2165 2166 2167
      #
      #   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
2168
        case
2169 2170 2171 2172 2173 2174 2175 2176
        when new_record?
          "#{self.class.name.tableize}/new"
        when self[:updated_at]
          "#{self.class.name.tableize}/#{id}-#{updated_at.to_s(:number)}"
        else
          "#{self.class.name.tableize}/#{id}"
        end
      end
2177

2178
      def id_before_type_cast #:nodoc:
2179 2180 2181
        read_attribute_before_type_cast(self.class.primary_key)
      end

2182
      def quoted_id #:nodoc:
2183
        quote_value(id, column_for_attribute(self.class.primary_key))
2184
      end
2185

D
Initial  
David Heinemeier Hansson 已提交
2186 2187 2188 2189
      # Sets the primary ID.
      def id=(value)
        write_attribute(self.class.primary_key, value)
      end
2190

D
Initial  
David Heinemeier Hansson 已提交
2191
      # Returns true if this object hasn't been saved yet -- that is, a record for the object doesn't exist yet.
2192
      def new_record?
2193
        defined?(@new_record) && @new_record
2194
      end
2195

D
Initial  
David Heinemeier Hansson 已提交
2196 2197
      # * No record exists: Creates a new record with values matching those of the object attributes.
      # * A record does exist: Updates the record with values matching those of the object attributes.
2198 2199 2200 2201
      #
      # Note: If your model specifies any validations then the method declaration dynamically
      # changes to:
      #   save(perform_validation=true)
2202
      # Calling save(false) saves the model without running validations.
2203
      # See ActiveRecord::Validations for more information.
D
Initial  
David Heinemeier Hansson 已提交
2204 2205 2206
      def save
        create_or_update
      end
2207 2208

      # Attempts to save the record, but instead of just returning false if it couldn't happen, it raises a
2209 2210
      # RecordNotSaved exception
      def save!
2211
        create_or_update || raise(RecordNotSaved)
2212
      end
2213

D
Initial  
David Heinemeier Hansson 已提交
2214 2215 2216
      # 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
2217
        unless new_record?
2218
          connection.delete <<-end_sql, "#{self.class.name} Destroy"
2219
            DELETE FROM #{self.class.quoted_table_name}
2220
            WHERE #{connection.quote_column_name(self.class.primary_key)} = #{quoted_id}
2221
          end_sql
D
Initial  
David Heinemeier Hansson 已提交
2222 2223 2224 2225 2226
        end

        freeze
      end

J
Jeremy Kemper 已提交
2227 2228 2229 2230 2231
      # 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 已提交
2232
      def clone
2233
        attrs = clone_attributes(:read_attribute_before_type_cast)
D
David Heinemeier Hansson 已提交
2234
        attrs.delete(self.class.primary_key)
2235 2236 2237
        record = self.class.new
        record.send :instance_variable_set, '@attributes', attrs
        record
D
Initial  
David Heinemeier Hansson 已提交
2238
      end
2239

2240
      # Returns an instance of the specified +klass+ with the attributes of the current record. This is mostly useful in relation to
2241
      # single-table inheritance structures where you want a subclass to appear as the superclass. This can be used along with record
2242
      # identification in Action Pack to allow, say, <tt>Client < Company</tt> to do something like render <tt>:partial => @client.becomes(Company)</tt>
2243 2244 2245 2246 2247 2248 2249
      # 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)
        returning klass.new do |became|
          became.instance_variable_set("@attributes", @attributes)
D
David Heinemeier Hansson 已提交
2250
          became.instance_variable_set("@attributes_cache", @attributes_cache)
2251 2252 2253 2254
          became.instance_variable_set("@new_record", new_record?)
        end
      end

2255 2256 2257
      # 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 已提交
2258
      def update_attribute(name, value)
2259
        send(name.to_s + '=', value)
2260
        save(false)
2261 2262
      end

2263
      # Updates all the attributes from the passed-in Hash and saves the record. If the object is invalid, the saving will
2264
      # fail and false will be returned.
2265
      def update_attributes(attributes)
2266
        self.attributes = attributes
2267
        save
D
Initial  
David Heinemeier Hansson 已提交
2268
      end
2269

2270 2271 2272 2273 2274
      # 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 已提交
2275

P
Pratik Naik 已提交
2276 2277 2278
      # 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+.
2279
      def increment(attribute, by = 1)
2280
        self[attribute] ||= 0
2281
        self[attribute] += by
2282 2283
        self
      end
2284

P
Pratik Naik 已提交
2285 2286 2287 2288
      # 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.
2289 2290
      def increment!(attribute, by = 1)
        increment(attribute, by).update_attribute(attribute, self[attribute])
2291 2292
      end

P
Pratik Naik 已提交
2293 2294 2295
      # 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+.
2296
      def decrement(attribute, by = 1)
2297
        self[attribute] ||= 0
2298
        self[attribute] -= by
2299 2300 2301
        self
      end

P
Pratik Naik 已提交
2302 2303 2304 2305
      # 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.
2306 2307
      def decrement!(attribute, by = 1)
        decrement(attribute, by).update_attribute(attribute, self[attribute])
2308
      end
2309

P
Pratik Naik 已提交
2310 2311 2312 2313
      # 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+.
2314
      def toggle(attribute)
2315
        self[attribute] = !send("#{attribute}?")
2316 2317 2318
        self
      end

P
Pratik Naik 已提交
2319 2320 2321 2322
      # 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.
2323 2324 2325 2326
      def toggle!(attribute)
        toggle(attribute).update_attribute(attribute, self[attribute])
      end

2327
      # Reloads the attributes of this object from the database.
2328 2329 2330 2331
      # 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)
2332
        clear_aggregation_cache
2333
        clear_association_cache
2334
        @attributes.update(self.class.find(self.id, options).instance_variable_get('@attributes'))
2335
        @attributes_cache = {}
2336
        self
2337 2338
      end

2339
      # Returns the value of the attribute identified by <tt>attr_name</tt> after it has been typecast (for example,
D
Initial  
David Heinemeier Hansson 已提交
2340 2341
      # "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).
2342
      def [](attr_name)
2343
        read_attribute(attr_name)
D
Initial  
David Heinemeier Hansson 已提交
2344
      end
2345

D
Initial  
David Heinemeier Hansson 已提交
2346 2347
      # Updates the attribute identified by <tt>attr_name</tt> with the specified +value+.
      # (Alias for the protected write_attribute method).
2348
      def []=(attr_name, value)
2349
        write_attribute(attr_name, value)
D
Initial  
David Heinemeier Hansson 已提交
2350 2351 2352 2353 2354
      end

      # Allows you to set all the attributes at once by passing in a hash with keys
      # matching the attribute names (which again matches the column names). Sensitive attributes can be protected
      # from this form of mass-assignment by using the +attr_protected+ macro. Or you can alternatively
2355
      # specify which attributes *can* be accessed with the +attr_accessible+ macro. Then all the
2356
      # attributes not included in that won't be allowed to be mass-assigned.
2357
      def attributes=(new_attributes, guard_protected_attributes = true)
D
David Heinemeier Hansson 已提交
2358 2359
        return if new_attributes.nil?
        attributes = new_attributes.dup
2360
        attributes.stringify_keys!
D
Initial  
David Heinemeier Hansson 已提交
2361 2362

        multi_parameter_attributes = []
2363
        attributes = remove_attributes_protected_from_mass_assignment(attributes) if guard_protected_attributes
2364

2365
        attributes.each do |k, v|
D
Initial  
David Heinemeier Hansson 已提交
2366 2367
          k.include?("(") ? multi_parameter_attributes << [ k, v ] : send(k + "=", v)
        end
D
David Heinemeier Hansson 已提交
2368

D
Initial  
David Heinemeier Hansson 已提交
2369 2370 2371
        assign_multiparameter_attributes(multi_parameter_attributes)
      end

D
David Heinemeier Hansson 已提交
2372

2373
      # Returns a hash of all the attributes with their names as keys and the values of the attributes as values.
2374
      def attributes
2375 2376
        self.attribute_names.inject({}) do |attrs, name|
          attrs[name] = read_attribute(name)
2377
          attrs
2378
        end
2379 2380
      end

2381
      # Returns a hash of attributes before typecasting and deserialization.
2382
      def attributes_before_type_cast
2383
        self.attribute_names.inject({}) do |attrs, name|
2384
          attrs[name] = read_attribute_before_type_cast(name)
2385
          attrs
2386
        end
2387 2388
      end

2389 2390 2391 2392
      # Format attributes nicely for inspect.
      def attribute_for_inspect(attr_name)
        value = read_attribute(attr_name)

2393
        if value.is_a?(String) && value.length > 50
2394
          "#{value[0..50]}...".inspect
2395 2396
        elsif value.is_a?(Date) || value.is_a?(Time)
          %("#{value.to_s(:db)}")
2397 2398 2399 2400 2401
        else
          value.inspect
        end
      end

D
Initial  
David Heinemeier Hansson 已提交
2402
      # Returns true if the specified +attribute+ has been set by the user or by a database load and is neither
2403
      # nil nor empty? (the latter only applies to objects that respond to empty?, most notably Strings).
D
Initial  
David Heinemeier Hansson 已提交
2404
      def attribute_present?(attribute)
2405
        value = read_attribute(attribute)
2406
        !value.blank?
D
Initial  
David Heinemeier Hansson 已提交
2407 2408
      end

2409 2410 2411 2412 2413
      # 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 已提交
2414 2415 2416 2417 2418 2419 2420
      # 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)
2421
        self.class.columns_hash[name.to_s]
D
Initial  
David Heinemeier Hansson 已提交
2422
      end
2423

2424
      # 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 已提交
2425
      def ==(comparison_object)
2426
        comparison_object.equal?(self) ||
2427 2428
          (comparison_object.instance_of?(self.class) &&
            comparison_object.id == id &&
2429
            !comparison_object.new_record?)
D
Initial  
David Heinemeier Hansson 已提交
2430 2431 2432 2433 2434 2435
      end

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

D
Initial  
David Heinemeier Hansson 已提交
2437 2438 2439
      # 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
2440
        id.hash
D
Initial  
David Heinemeier Hansson 已提交
2441 2442
      end

2443
      # Freeze the attributes hash such that associations are still accessible, even on destroyed records.
2444
      def freeze
2445
        @attributes.freeze; self
2446
      end
2447

2448
      # Returns +true+ if the attributes hash has been frozen.
2449 2450 2451
      def frozen?
        @attributes.frozen?
      end
2452

2453 2454
      # 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.
2455
      def readonly?
2456
        defined?(@readonly) && @readonly == true
2457 2458
      end

2459 2460
      # Marks this record as read only.
      def readonly!
2461 2462
        @readonly = true
      end
2463

2464
      # Returns the contents of the record as a nicely formatted string.
2465
      def inspect
2466
        attributes_as_nice_string = self.class.column_names.collect { |name|
2467 2468 2469 2470
          if has_attribute?(name) || new_record?
            "#{name}: #{attribute_for_inspect(name)}"
          end
        }.compact.join(", ")
2471
        "#<#{self.class} #{attributes_as_nice_string}>"
2472
      end
2473

D
Initial  
David Heinemeier Hansson 已提交
2474 2475
    private
      def create_or_update
2476
        raise ReadOnlyRecord if readonly?
2477 2478
        result = new_record? ? create : update
        result != false
D
Initial  
David Heinemeier Hansson 已提交
2479 2480
      end

2481
      # Updates the associated record with values matching those of the instance attributes.
2482
      # Returns the number of affected rows.
2483 2484
      def update(attribute_names = @attributes.keys)
        quoted_attributes = attributes_with_quotes(false, false, attribute_names)
2485
        return 0 if quoted_attributes.empty?
D
Initial  
David Heinemeier Hansson 已提交
2486
        connection.update(
2487
          "UPDATE #{self.class.quoted_table_name} " +
2488
          "SET #{quoted_comma_pair_list(connection, quoted_attributes)} " +
2489
          "WHERE #{connection.quote_column_name(self.class.primary_key)} = #{quote_value(id)}",
D
Initial  
David Heinemeier Hansson 已提交
2490 2491 2492 2493
          "#{self.class.name} Update"
        )
      end

2494 2495
      # Creates a record with values matching those of the instance attributes
      # and returns its id.
D
Initial  
David Heinemeier Hansson 已提交
2496
      def create
2497
        if self.id.nil? && connection.prefetch_primary_key?(self.class.table_name)
2498 2499
          self.id = connection.next_sequence_value(self.class.sequence_name)
        end
2500

2501 2502 2503 2504 2505
        quoted_attributes = attributes_with_quotes

        statement = if quoted_attributes.empty?
          connection.empty_insert_statement(self.class.table_name)
        else
2506
          "INSERT INTO #{self.class.quoted_table_name} " +
D
Initial  
David Heinemeier Hansson 已提交
2507
          "(#{quoted_column_names.join(', ')}) " +
2508 2509 2510 2511 2512
          "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)
2513

D
Initial  
David Heinemeier Hansson 已提交
2514
        @new_record = false
2515
        id
D
Initial  
David Heinemeier Hansson 已提交
2516 2517
      end

P
Pratik Naik 已提交
2518 2519 2520
      # Sets the attribute used for single table inheritance to this class name if this is not the ActiveRecord::Base descendent.
      # 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 已提交
2521 2522 2523
      # Message class in that example.
      def ensure_proper_type
        unless self.class.descends_from_active_record?
2524
          write_attribute(self.class.inheritance_column, self.class.sti_name)
D
Initial  
David Heinemeier Hansson 已提交
2525 2526 2527
        end
      end

2528 2529
      def convert_number_column_value(value)
        case value
2530 2531 2532
          when FalseClass; 0
          when TrueClass;  1
          when '';         nil
2533 2534
          else value
        end
D
Initial  
David Heinemeier Hansson 已提交
2535 2536 2537
      end

      def remove_attributes_protected_from_mass_assignment(attributes)
2538 2539 2540 2541
        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?
2542
            attributes.reject { |key, value| !self.class.accessible_attributes.include?(key.gsub(/\(.+/, "")) || attributes_protected_by_default.include?(key.gsub(/\(.+/, "")) }
2543
          elsif self.class.accessible_attributes.nil?
2544
            attributes.reject { |key, value| self.class.protected_attributes.include?(key.gsub(/\(.+/,"")) || attributes_protected_by_default.include?(key.gsub(/\(.+/, "")) }
2545 2546 2547 2548 2549 2550 2551
          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?
2552
          logger.debug "WARNING: Can't mass-assign these protected attributes: #{removed_attributes.join(', ')}"
D
Initial  
David Heinemeier Hansson 已提交
2553
        end
2554 2555

        safe_attributes
D
Initial  
David Heinemeier Hansson 已提交
2556
      end
2557

2558 2559 2560
      # Removes attributes which have been marked as readonly.
      def remove_readonly_attributes(attributes)
        unless self.class.readonly_attributes.nil?
2561
          attributes.delete_if { |key, value| self.class.readonly_attributes.include?(key.gsub(/\(.+/,"")) }
2562 2563 2564 2565
        else
          attributes
        end
      end
D
Initial  
David Heinemeier Hansson 已提交
2566

2567 2568
      # The primary key and inheritance column can never be set by mass-assignment for security reasons.
      def attributes_protected_by_default
2569 2570 2571
        default = [ self.class.primary_key, self.class.inheritance_column ]
        default << 'id' unless self.class.primary_key.eql? 'id'
        default
2572 2573
      end

2574
      # Returns a copy of the attributes hash where all the values have been safely quoted for use in
2575
      # an SQL statement.
2576
      def attributes_with_quotes(include_primary_key = true, include_readonly_attributes = true, attribute_names = @attributes.keys)
2577
        quoted = {}
2578
        connection = self.class.connection
2579
        attribute_names.each do |name|
2580
          if column = column_for_attribute(name)
2581
            quoted[name] = connection.quote(read_attribute(name), column) unless !include_primary_key && column.primary
2582
          end
D
Initial  
David Heinemeier Hansson 已提交
2583
        end
2584
        include_readonly_attributes ? quoted : remove_readonly_attributes(quoted)
D
Initial  
David Heinemeier Hansson 已提交
2585
      end
2586

D
Initial  
David Heinemeier Hansson 已提交
2587
      # Quote strings appropriately for SQL statements.
2588
      def quote_value(value, column = nil)
2589
        self.class.connection.quote(value, column)
D
Initial  
David Heinemeier Hansson 已提交
2590 2591
      end

P
Pratik Naik 已提交
2592
      # Interpolate custom SQL string in instance context.
D
Initial  
David Heinemeier Hansson 已提交
2593 2594
      # Optional record argument is meant for custom insert_sql.
      def interpolate_sql(sql, record = nil)
2595
        instance_eval("%@#{sql.gsub('@', '\@')}@")
D
Initial  
David Heinemeier Hansson 已提交
2596 2597 2598 2599 2600 2601 2602
      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
2603
        self.class.columns.inject({}) do |attributes, column|
2604
          attributes[column.name] = column.default unless column.name == self.class.primary_key
D
Initial  
David Heinemeier Hansson 已提交
2605 2606 2607 2608 2609 2610 2611 2612
          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
2613
      # parentheses to have the parameters typecasted before they're used in the constructor. Use i for Fixnum, f for Float,
2614
      # 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 已提交
2615 2616 2617 2618 2619
      def assign_multiparameter_attributes(pairs)
        execute_callstack_for_multiparameter_attributes(
          extract_callstack_for_multiparameter_attributes(pairs)
        )
      end
2620

2621
      def instantiate_time_object(name, values)
2622
        if self.class.time_zone_aware_attributes && !self.class.skip_time_zone_conversion_for_attributes.include?(name.to_sym)
2623
          Time.zone.local(*values)
2624
        else
2625
          Time.time_with_datetime_fallback(@@default_timezone, *values)
2626
        end
2627 2628
      end

D
Initial  
David Heinemeier Hansson 已提交
2629
      def execute_callstack_for_multiparameter_attributes(callstack)
2630
        errors = []
D
Initial  
David Heinemeier Hansson 已提交
2631
        callstack.each do |name, values|
2632
          klass = (self.class.reflect_on_aggregation(name.to_sym) || column_for_attribute(name)).klass
D
Initial  
David Heinemeier Hansson 已提交
2633 2634 2635
          if values.empty?
            send(name + "=", nil)
          else
2636
            begin
2637
              value = if Time == klass
2638
                instantiate_time_object(name, values)
2639 2640 2641 2642
              elsif Date == klass
                begin
                  Date.new(*values)
                rescue ArgumentError => ex # if Date.new raises an exception on an invalid date
2643
                  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
2644 2645 2646 2647 2648 2649
                end
              else
                klass.new(*values)
              end

              send(name + "=", value)
2650 2651 2652
            rescue => ex
              errors << AttributeAssignmentError.new("error on assignment #{values.inspect} to #{name}", ex, name)
            end
D
Initial  
David Heinemeier Hansson 已提交
2653 2654
          end
        end
2655 2656 2657
        unless errors.empty?
          raise MultiparameterAssignmentErrors.new(errors), "#{errors.size} error(s) on assignment of multiparameter attributes"
        end
D
Initial  
David Heinemeier Hansson 已提交
2658
      end
2659

D
Initial  
David Heinemeier Hansson 已提交
2660 2661 2662 2663 2664 2665 2666 2667 2668
      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?
2669
            attributes[attribute_name] <<
2670
              [ find_parameter_position(multiparameter_name), type_cast_attribute_value(multiparameter_name, value) ]
D
Initial  
David Heinemeier Hansson 已提交
2671 2672 2673 2674 2675
          end
        end

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

D
Initial  
David Heinemeier Hansson 已提交
2677 2678 2679
      def type_cast_attribute_value(multiparameter_name, value)
        multiparameter_name =~ /\([0-9]*([a-z])\)/ ? value.send("to_" + $1) : value
      end
2680

D
Initial  
David Heinemeier Hansson 已提交
2681 2682 2683
      def find_parameter_position(multiparameter_name)
        multiparameter_name.scan(/\(([0-9]*).*\)/).first.first
      end
2684

D
Initial  
David Heinemeier Hansson 已提交
2685 2686 2687 2688 2689 2690
      # 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)
2691
        connection = self.class.connection
2692
        attributes.keys.collect do |column_name|
2693
          connection.quote_column_name(column_name)
2694
        end
D
Initial  
David Heinemeier Hansson 已提交
2695 2696
      end

2697 2698 2699 2700
      def self.quoted_table_name
        self.connection.quote_table_name(self.table_name)
      end

2701 2702 2703 2704
      def quote_columns(quoter, hash)
        hash.inject({}) do |quoted, (name, value)|
          quoted[quoter.quote_column_name(name)] = value
          quoted
2705
        end
D
Initial  
David Heinemeier Hansson 已提交
2706 2707
      end

2708 2709
      def quoted_comma_pair_list(quoter, hash)
        comma_pair_list(quote_columns(quoter, hash))
D
Initial  
David Heinemeier Hansson 已提交
2710 2711 2712
      end

      def object_from_yaml(string)
2713
        return string unless string.is_a?(String)
2714
        YAML::load(string) rescue string
D
Initial  
David Heinemeier Hansson 已提交
2715
      end
2716 2717

      def clone_attributes(reader_method = :read_attribute, attributes = {})
2718 2719 2720
        self.attribute_names.inject(attributes) do |attrs, name|
          attrs[name] = clone_attribute_value(reader_method, name)
          attrs
2721 2722 2723 2724 2725
        end
      end

      def clone_attribute_value(reader_method, attribute_name)
        value = send(reader_method, attribute_name)
2726
        value.duplicable? ? value.clone : value
2727 2728 2729
      rescue TypeError, NoMethodError
        value
      end
D
Initial  
David Heinemeier Hansson 已提交
2730
  end
2731
end