base.rb 91.8 KB
Newer Older
1
require 'base64'
D
Initial  
David Heinemeier Hansson 已提交
2
require 'yaml'
3
require 'set'
4
require 'active_record/deprecated_finders'
D
Initial  
David Heinemeier Hansson 已提交
5 6 7 8

module ActiveRecord #:nodoc:
  class ActiveRecordError < StandardError #:nodoc:
  end
9 10
  class SubclassNotFound < ActiveRecordError #:nodoc:
  end
D
Initial  
David Heinemeier Hansson 已提交
11 12 13 14 15 16 17 18 19 20 21 22 23 24
  class AssociationTypeMismatch < ActiveRecordError #:nodoc:
  end
  class SerializationTypeMismatch < ActiveRecordError #:nodoc:
  end
  class AdapterNotSpecified < ActiveRecordError # :nodoc:
  end
  class AdapterNotFound < ActiveRecordError # :nodoc:
  end
  class ConnectionNotEstablished < ActiveRecordError #:nodoc:
  end
  class ConnectionFailed < ActiveRecordError #:nodoc:
  end
  class RecordNotFound < ActiveRecordError #:nodoc:
  end
25 26
  class RecordNotSaved < ActiveRecordError #:nodoc:
  end
D
Initial  
David Heinemeier Hansson 已提交
27 28
  class StatementInvalid < ActiveRecordError #:nodoc:
  end
29 30
  class PreparedStatementInvalid < ActiveRecordError #:nodoc:
  end
31 32
  class StaleObjectError < ActiveRecordError #:nodoc:
  end
33 34
  class ConfigurationError < StandardError #:nodoc:
  end
35 36
  class ReadOnlyRecord < StandardError #:nodoc:
  end
37
  
38 39 40 41 42 43 44 45
  class AttributeAssignmentError < ActiveRecordError #:nodoc:
    attr_reader :exception, :attribute
    def initialize(message, exception, attribute)
      @exception = exception
      @attribute = attribute
      @message = message
    end
  end
46

47 48 49 50 51 52
  class MultiparameterAssignmentErrors < ActiveRecordError #:nodoc:
    attr_reader :errors
    def initialize(errors)
      @errors = errors
    end
  end
53

54
  # Active Record objects don't specify their attributes directly, but rather infer them from the table definition with
D
Initial  
David Heinemeier Hansson 已提交
55 56
  # 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
57 58
  # database table will happen automatically in most common cases, but can be overwritten for the uncommon ones.
  #
D
Initial  
David Heinemeier Hansson 已提交
59
  # See the mapping rules in table_name and the full example in link:files/README.html for more insight.
60
  #
D
Initial  
David Heinemeier Hansson 已提交
61
  # == Creation
62
  #
63
  # Active Records accept constructor parameters either in a hash or as a block. The hash method is especially useful when
D
Initial  
David Heinemeier Hansson 已提交
64
  # you're receiving the data from somewhere else, like a HTTP request. It works like this:
65
  #
66
  #   user = User.new(:name => "David", :occupation => "Code Artist")
D
Initial  
David Heinemeier Hansson 已提交
67
  #   user.name # => "David"
68
  #
D
Initial  
David Heinemeier Hansson 已提交
69
  # You can also use block initialization:
70
  #
D
Initial  
David Heinemeier Hansson 已提交
71 72 73 74
  #   user = User.new do |u|
  #     u.name = "David"
  #     u.occupation = "Code Artist"
  #   end
75
  #
D
Initial  
David Heinemeier Hansson 已提交
76
  # And of course you can just create a bare object and specify the attributes after the fact:
77
  #
D
Initial  
David Heinemeier Hansson 已提交
78 79 80
  #   user = User.new
  #   user.name = "David"
  #   user.occupation = "Code Artist"
81
  #
D
Initial  
David Heinemeier Hansson 已提交
82
  # == Conditions
83
  #
84
  # Conditions can either be specified as a string, array, or hash representing the WHERE-part of an SQL statement.
D
Initial  
David Heinemeier Hansson 已提交
85
  # The array form is to be used when the condition input is tainted and requires sanitization. The string form can
86 87
  # be used for statements that don't involve tainted data. The hash form works much like the array form, except
  # only equality is possible. Examples:
88
  #
89
  #   class User < ActiveRecord::Base
D
Initial  
David Heinemeier Hansson 已提交
90
  #     def self.authenticate_unsafely(user_name, password)
91
  #       find(:first, :conditions => "user_name = '#{user_name}' AND password = '#{password}'")
D
Initial  
David Heinemeier Hansson 已提交
92
  #     end
93
  #
D
Initial  
David Heinemeier Hansson 已提交
94
  #     def self.authenticate_safely(user_name, password)
95
  #       find(:first, :conditions => [ "user_name = ? AND password = ?", user_name, password ])
D
Initial  
David Heinemeier Hansson 已提交
96
  #     end
97 98 99 100
  #
  #     def self.authenticate_safely_simply(user_name, password)
  #       find(:first, :conditions => { :user_name => user_name, :password => password })
  #     end
D
Initial  
David Heinemeier Hansson 已提交
101
  #   end
102
  #
103
  # The <tt>authenticate_unsafely</tt> method inserts the parameters directly into the query and is thus susceptible to SQL-injection
104 105 106
  # attacks if the <tt>user_name</tt> and +password+ parameters come directly from a HTTP request. The <tt>authenticate_safely</tt>  and
  # <tt>authenticate_safely_simply</tt> both will sanitize the <tt>user_name</tt> and +password+ before inserting them in the query, 
  # which will ensure that an attacker can't escape the query and fake the login (or worse).
107
  #
108
  # When using multiple parameters in the conditions, it can easily become hard to read exactly what the fourth or fifth
109
  # question mark is supposed to represent. In those cases, you can resort to named bind variables instead. That's done by replacing
110 111
  # the question marks with symbols and supplying a hash with values for the matching symbol keys:
  #
112 113
  #   Company.find(:first, [
  #     "id = :id AND name = :name AND division = :division AND created_at > :accounting_date",
114 115 116
  #     { :id => 3, :name => "37signals", :division => "First", :accounting_date => '2005-01-01' }
  #   ])
  #
117 118 119 120 121 122 123
  # 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])
  #
  #
D
Initial  
David Heinemeier Hansson 已提交
124
  # == Overwriting default accessors
125
  #
D
Initial  
David Heinemeier Hansson 已提交
126 127 128 129
  # All column values are automatically available through basic accessors on the Active Record object, but some times you
  # want to specialize this behavior. This can be done by either by overwriting the default accessors (using the same
  # name as the attribute) calling read_attribute(attr_name) and write_attribute(attr_name, value) to actually change things.
  # Example:
130
  #
D
Initial  
David Heinemeier Hansson 已提交
131 132
  #   class Song < ActiveRecord::Base
  #     # Uses an integer of seconds to hold the length of the song
133
  #
D
Initial  
David Heinemeier Hansson 已提交
134
  #     def length=(minutes)
135
  #       write_attribute(:length, minutes * 60)
D
Initial  
David Heinemeier Hansson 已提交
136
  #     end
137
  #
D
Initial  
David Heinemeier Hansson 已提交
138
  #     def length
139
  #       read_attribute(:length) / 60
D
Initial  
David Heinemeier Hansson 已提交
140 141
  #     end
  #   end
142
  #
143 144 145
  # You can alternatively use self[:attribute]=(value) and self[:attribute] instead of write_attribute(:attribute, vaule) and
  # read_attribute(:attribute) as a shorter form.
  #
146
  # == Accessing attributes before they have been typecasted
147
  #
148
  # Sometimes you want to be able to read the raw attribute data without having the column-determined typecast run its course first.
149
  # That can be done by using the <attribute>_before_type_cast accessors that all attributes have. For example, if your Account model
150
  # has a balance attribute, you can call account.balance_before_type_cast or account.id_before_type_cast.
151 152
  #
  # This is especially useful in validation situations where the user might supply a string for an integer field and you want to display
153
  # the original string back in an error message. Accessing the attribute normally would typecast the string to 0, which isn't what you
154 155
  # want.
  #
156 157
  # == Dynamic attribute-based finders
  #
158
  # Dynamic attribute-based finders are a cleaner way of getting (and/or creating) objects by simple queries without turning to SQL. They work by
159
  # appending the name of an attribute to <tt>find_by_</tt> or <tt>find_all_by_</tt>, so you get finders like Person.find_by_user_name,
160 161
  # Person.find_all_by_last_name, Payment.find_by_transaction_id. So instead of writing
  # <tt>Person.find(:first, ["user_name = ?", user_name])</tt>, you just do <tt>Person.find_by_user_name(user_name)</tt>.
162
  # And instead of writing <tt>Person.find(:all, ["last_name = ?", last_name])</tt>, you just do <tt>Person.find_all_by_last_name(last_name)</tt>.
163
  #
164 165
  # 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
166
  # <tt>Person.find(:first, ["user_name = ? AND password = ?", user_name, password])</tt>, you just do
167
  # <tt>Person.find_by_user_name_and_password(user_name, password)</tt>.
168
  #
169 170 171
  # It's even possible to use all the additional parameters to find. For example, the full interface for Payment.find_all_by_amount
  # is actually Payment.find_all_by_amount(amount, options). And the full interface to Person.find_by_user_name is
  # actually Person.find_by_user_name(user_name, options). So you could call <tt>Payment.find_all_by_amount(50, :order => "created_on")</tt>.
172
  #
173 174 175 176 177 178 179 180 181
  # The same dynamic finder style can be used to create the object if it doesn't already exist. This dynamic finder is called with
  # <tt>find_or_create_by_</tt> and will return the object if it already exists and otherwise creates it, then returns it. Example:
  #
  #   # No 'Summer' tag exists
  #   Tag.find_or_create_by_name("Summer") # equal to Tag.create(:name => "Summer")
  #   
  #   # Now the 'Summer' tag does exist
  #   Tag.find_or_create_by_name("Summer") # equal to Tag.find_by_name("Summer")
  #
182 183 184 185
  # Use the <tt>find_or_initialize_by_</tt> finder if you want to return a new record without saving it first. Example:
  #
  #   # No 'Winter' tag exists
  #   winter = Tag.find_or_initialize_by_name("Winter")
186
  #   winter.new_record? # true
187
  #
188
  # == Saving arrays, hashes, and other non-mappable objects in text columns
189 190
  #
  # 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+.
191
  # This makes it possible to store arrays, hashes, and other non-mappable objects without doing any additional work. Example:
192
  #
D
Initial  
David Heinemeier Hansson 已提交
193 194 195
  #   class User < ActiveRecord::Base
  #     serialize :preferences
  #   end
196
  #
197
  #   user = User.create(:preferences => { "background" => "black", "display" => large })
D
Initial  
David Heinemeier Hansson 已提交
198
  #   User.find(user.id).preferences # => { "background" => "black", "display" => large }
199
  #
200
  # 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 已提交
201
  # descendent of a class not in the hierarchy. Example:
202
  #
D
Initial  
David Heinemeier Hansson 已提交
203
  #   class User < ActiveRecord::Base
204
  #     serialize :preferences, Hash
D
Initial  
David Heinemeier Hansson 已提交
205
  #   end
206
  #
207
  #   user = User.create(:preferences => %w( one two three ))
D
Initial  
David Heinemeier Hansson 已提交
208
  #   User.find(user.id).preferences    # raises SerializationTypeMismatch
209
  #
D
Initial  
David Heinemeier Hansson 已提交
210 211
  # == Single table inheritance
  #
212
  # Active Record allows inheritance by storing the name of the class in a column that by default is called "type" (can be changed
D
Initial  
David Heinemeier Hansson 已提交
213 214 215 216 217 218 219
  # 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
  #
220 221
  # When you do Firm.create(:name => "37signals"), this record will be saved in the companies table with type = "Firm". You can then
  # fetch this row again using Company.find(:first, "name = '37signals'") and it will return a Firm object.
D
Initial  
David Heinemeier Hansson 已提交
222
  #
223 224 225
  # 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 已提交
226 227
  # Note, all the attributes for all the cases are kept in the same table. Read more:
  # http://www.martinfowler.com/eaaCatalog/singleTableInheritance.html
228
  #
D
Initial  
David Heinemeier Hansson 已提交
229 230 231
  # == Connection to multiple databases in different models
  #
  # Connections are usually created through ActiveRecord::Base.establish_connection and retrieved by ActiveRecord::Base.connection.
232
  # All classes inheriting from ActiveRecord::Base will use this connection. But you can also set a class-specific connection.
D
Initial  
David Heinemeier Hansson 已提交
233 234 235 236 237 238 239
  # For example, if Course is a ActiveRecord::Base, but resides in a different database you can just say Course.establish_connection
  # and Course *and all its subclasses* will use this connection instead.
  #
  # 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
240
  #
D
Initial  
David Heinemeier Hansson 已提交
241
  # * +ActiveRecordError+ -- generic error class and superclass of all other errors raised by Active Record
242
  # * +AdapterNotSpecified+ -- the configuration hash used in <tt>establish_connection</tt> didn't include a
D
Initial  
David Heinemeier Hansson 已提交
243
  #   <tt>:adapter</tt> key.
244
  # * +AdapterNotFound+ -- the <tt>:adapter</tt> key used in <tt>establish_connection</tt> specified an non-existent adapter
245 246 247
  #   (or a bad spelling of an existing one).
  # * +AssociationTypeMismatch+ -- the object assigned to the association wasn't of the type specified in the association definition.
  # * +SerializationTypeMismatch+ -- the object serialized wasn't of the class specified as the second parameter.
D
Initial  
David Heinemeier Hansson 已提交
248
  # * +ConnectionNotEstablished+ -- no connection has been established. Use <tt>establish_connection</tt> before querying.
249
  # * +RecordNotFound+ -- no record responded to the find* method.
D
Initial  
David Heinemeier Hansson 已提交
250 251 252
  #   Either the row with the given ID doesn't exist or the row didn't meet the additional restrictions.
  # * +StatementInvalid+ -- the database server rejected the SQL statement. The precise error is added in the  message.
  #   Either the record with the given ID doesn't exist or the record didn't meet the additional restrictions.
253 254
  # * +MultiparameterAssignmentErrors+ -- collection of errors that occurred during a mass assignment using the
  #   +attributes=+ method. The +errors+ property of this exception contains an array of +AttributeAssignmentError+
255 256 257
  #   objects that should be inspected to determine which attributes triggered the errors.
  # * +AttributeAssignmentError+ -- an error occurred while doing a mass assignment through the +attributes=+ method.
  #   You can inspect the +attribute+ property of the exception object to determine which attribute triggered the error.
258
  #
259
  # *Note*: The attributes listed are class-level attributes (accessible from both the class and instance level).
D
Initial  
David Heinemeier Hansson 已提交
260 261 262 263 264 265
  # So it's possible to assign a logger to the class through Base.logger= which will then be used by all
  # 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+.
    cattr_accessor :logger
266
    
267
    include Reloadable::Deprecated
268
    
D
Initial  
David Heinemeier Hansson 已提交
269 270 271 272 273
    def self.inherited(child) #:nodoc:
      @@subclasses[self] ||= []
      @@subclasses[self] << child
      super
    end
274
    
D
David Heinemeier Hansson 已提交
275
    def self.reset_subclasses #:nodoc:
276
      nonreloadables = []
277
      subclasses.each do |klass|
278
        unless Dependencies.autoloaded? klass
279 280 281
          nonreloadables << klass
          next
        end
282 283 284
        klass.instance_variables.each { |var| klass.send(:remove_instance_variable, var) }
        klass.instance_methods(false).each { |m| klass.send :undef_method, m }
      end
285 286
      @@subclasses = {}
      nonreloadables.each { |klass| (@@subclasses[klass.superclass] ||= []) << klass }
287 288
    end

D
Initial  
David Heinemeier Hansson 已提交
289
    @@subclasses = {}
290

D
Initial  
David Heinemeier Hansson 已提交
291
    cattr_accessor :configurations
292 293
    @@configurations = {}

294
    # 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 已提交
295 296
    # :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
297
    # that this is a global setting for all Active Records.
D
Initial  
David Heinemeier Hansson 已提交
298 299 300
    cattr_accessor :primary_key_prefix_type
    @@primary_key_prefix_type = nil

301
    # Accessor for the name of the prefix string to prepend to every table name. So if set to "basecamp_", all
302
    # 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 已提交
303 304 305 306 307 308 309 310 311
    # for tables in a shared database. By default, the prefix is the empty string.
    cattr_accessor :table_name_prefix
    @@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.
    cattr_accessor :table_name_suffix
    @@table_name_suffix = ""

312 313
    # Indicates whether or not table names should be the pluralized versions of the corresponding class names.
    # 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 已提交
314 315 316 317
    # See table_name for the full rules on table/class naming. This is true, by default.
    cattr_accessor :pluralize_table_names
    @@pluralize_table_names = true

318
    # Determines whether or not to use ANSI codes to colorize the logging statements committed by the connection adapter. These colors
319
    # make it much easier to overview things during debugging (when used through a reader like +tail+ and on a black background), but
320 321 322 323
    # may complicate matters if you use software like syslog. This is true, by default.
    cattr_accessor :colorize_logging
    @@colorize_logging = true

324 325 326 327
    # 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.
    cattr_accessor :default_timezone
    @@default_timezone = :local
328

329
    # Determines whether or not to use a connection for each thread, or a single shared connection for all threads.
330
    # Defaults to false. Set to true if you're writing a threaded application.
331
    cattr_accessor :allow_concurrency
332
    @@allow_concurrency = false
333

334 335 336 337 338 339
    # Determines whether to speed up access by generating optimized reader
    # methods to avoid expensive calls to method_missing when accessing
    # attributes by name. You might want to set this to false in development
    # mode, because the methods would be regenerated on each request.
    cattr_accessor :generate_read_methods
    @@generate_read_methods = true
340 341 342 343 344 345 346 347
    
    # Specifies the format to use when dumping the database schema with Rails'
    # Rakefile.  If :sql, the schema is dumped as (potentially database-
    # specific) SQL statements.  If :ruby, the schema is dumped as an 
    # 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.
    cattr_accessor :schema_format 
348
    @@schema_format = :ruby
349

D
Initial  
David Heinemeier Hansson 已提交
350
    class << self # Class methods
351
      # Find operates with three different retrieval approaches:
352 353 354 355 356
      #
      # * 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]).
      #   If no record can be found for all of the listed ids, then RecordNotFound will be raised.
      # * 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 matched, nil is returned.
357
      # * Find all: This will return all the records matched by the options used. If no records are found, an empty array is returned.
358
      #
359
      # All approaches accept an option hash as their last parameter. The options are:
360
      #
361 362
      # * <tt>:conditions</tt>: An SQL fragment like "administrator = 1" or [ "user_name = ?", username ]. See conditions in the intro.
      # * <tt>:order</tt>: An SQL fragment like "created_at DESC, name".
363
      # * <tt>:group</tt>: An attribute name by which the result should be grouped. Uses the GROUP BY SQL-clause.
364 365 366
      # * <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 the first 4 rows.
      # * <tt>:joins</tt>: An SQL fragment for additional joins like "LEFT JOIN comments ON comments.post_id = id". (Rarely needed).
367
      #   The records will be returned read-only since they will have attributes that do not correspond to the table's columns.
368
      #   Pass :readonly => false to override.
369 370
      # * <tt>:include</tt>: Names associations that should be loaded alongside using LEFT OUTER JOINs. The symbols named refer
      #   to already defined associations. See eager loading under Associations.
371 372
      # * <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
      #   include the joined columns.
373 374
      # * <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
      #   of a database view). 
375
      # * <tt>:readonly</tt>: Mark the returned records read-only so they cannot be saved or updated.
376 377
      # * <tt>:lock</tt>: An SQL fragment like "FOR UPDATE" or "LOCK IN SHARE MODE".
      #   :lock => true gives connection's default exclusive lock, usually "FOR UPDATE".
378
      #
379
      # Examples for find by id:
D
Initial  
David Heinemeier Hansson 已提交
380 381 382
      #   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)
383
      #   Person.find([1])     # returns an array for objects the object with ID = 1
384 385 386
      #   Person.find(1, :conditions => "administrator = 1", :order => "created_on DESC")
      #
      # Examples for find first:
387
      #   Person.find(:first) # returns the first object fetched by SELECT * FROM people
388 389 390 391
      #   Person.find(:first, :conditions => [ "user_name = ?", user_name])
      #   Person.find(:first, :order => "created_on DESC", :offset => 5)
      #
      # Examples for find all:
392
      #   Person.find(:all) # returns an array of objects for all the rows fetched by SELECT * FROM people
393 394 395
      #   Person.find(:all, :conditions => [ "category IN (?)", categories], :limit => 50)
      #   Person.find(:all, :offset => 10, :limit => 10)
      #   Person.find(:all, :include => [ :account, :friends ])
396
      #   Person.find(:all, :group => "category")
397 398 399 400 401 402 403 404 405 406 407
      #
      # Example for find with a lock. Imagine two concurrent transactions:
      # each will read person.visits == 2, add 1 to it, and save, resulting
      # in two saves of person.visits = 3.  By locking the row, the second
      # transaction has to wait until the first is finished; we get the
      # expected person.visits == 4.
      #   Person.transaction do
      #     person = Person.find(1, :lock => true)
      #     person.visits += 1
      #     person.save!
      #   end
408 409
      def find(*args)
        options = extract_options_from_args!(args)
410 411
        validate_find_options(options)
        set_readonly_option!(options)
412

413
        case args.first
414 415 416
          when :first then find_initial(options)
          when :all   then find_every(options)
          else             find_from_ids(args, options)
D
Initial  
David Heinemeier Hansson 已提交
417 418
        end
      end
419
      
420
      # Works like find(:all), but requires a complete SQL string. Examples:
D
Initial  
David Heinemeier Hansson 已提交
421
      #   Post.find_by_sql "SELECT p.*, c.author FROM posts p, comments c WHERE p.id = c.post_id"
422
      #   Post.find_by_sql ["SELECT * FROM posts WHERE author = ? AND created > ?", author_id, start_date]
D
Initial  
David Heinemeier Hansson 已提交
423
      def find_by_sql(sql)
424
        connection.select_all(sanitize_sql(sql), "#{name} Load").collect! { |record| instantiate(record) }
D
Initial  
David Heinemeier Hansson 已提交
425
      end
426

427
      # Returns true if the given +id+ represents the primary key of a record in the database, false otherwise.
428
      # You can also pass a set of SQL conditions. 
429 430
      # Example:
      #   Person.exists?(5)
431
      #   Person.exists?('5')
432
      #   Person.exists?(:name => "David")
433 434 435 436 437
      #   Person.exists?(['name LIKE ?', "%#{query}%"])
      def exists?(id_or_conditions)
        !find(:first, :conditions => expand_id_conditions(id_or_conditions)).nil?
      rescue ActiveRecord::ActiveRecordError
        false
D
Initial  
David Heinemeier Hansson 已提交
438
      end
439

D
Initial  
David Heinemeier Hansson 已提交
440
      # Creates an object, instantly saves it as a record (if the validation permits it), and returns it. If the save
441
      # fails under validations, the unsaved object is still returned.
D
Initial  
David Heinemeier Hansson 已提交
442
      def create(attributes = nil)
443 444 445 446
        if attributes.is_a?(Array)
          attributes.collect { |attr| create(attr) }
        else
          object = new(attributes)
447
          scope(:create).each { |att,value| object.send("#{att}=", value) } if scoped?(:create)
448 449 450
          object.save
          object
        end
D
Initial  
David Heinemeier Hansson 已提交
451 452
      end

453
      # Finds the record from the passed +id+, instantly saves it with the passed +attributes+ (if the validation permits it),
454
      # and returns it. If the save fails under validations, the unsaved object is still returned.
455 456 457 458 459 460 461 462 463 464
      #
      # The arguments may also be given as arrays in which case the update method is called for each pair of +id+ and 
      # +attributes+ and an array of objects is returned.
      #
      # Example of updating one record:
      #   Person.update(15, {:user_name => 'Samuel', :group => 'expert'})
      # 
      # Example of updating multiple records:
      #   people = { 1 => { "first_name" => "David" }, 2 => { "first_name" => "Jeremy"} } 	
      #   Person.update(people.keys, people.values)
D
Initial  
David Heinemeier Hansson 已提交
465
      def update(id, attributes)
466 467 468 469 470 471 472 473
        if id.is_a?(Array)
          idx = -1
          id.collect { |id| idx += 1; update(id, attributes[idx]) }
        else
          object = find(id)
          object.update_attributes(attributes)
          object
        end
D
Initial  
David Heinemeier Hansson 已提交
474 475
      end

476 477
      # Deletes the record with the given +id+ without instantiating an object first. If an array of ids is provided, all of them
      # are deleted.
478
      def delete(id)
479
        delete_all([ "#{primary_key} IN (?)", id ])
480
      end
481

482
      # Destroys the record with the given +id+ by instantiating the object and calling #destroy (all the callbacks are the triggered).
483
      # If an array of ids is provided, all of them are destroyed.
484
      def destroy(id)
485
        id.is_a?(Array) ? id.each { |id| destroy(id) } : find(id).destroy
486 487
      end

488
      # Updates all records with the SET-part of an SQL update statement in +updates+ and returns an integer with the number of rows updated.
489
      # A subset of the records can be selected by specifying +conditions+. Example:
D
Initial  
David Heinemeier Hansson 已提交
490 491
      #   Billing.update_all "category = 'authorized', approved = 1", "author = 'David'"
      def update_all(updates, conditions = nil)
492
        sql  = "UPDATE #{table_name} SET #{sanitize_sql(updates)} "
493
        add_conditions!(sql, conditions, scope(:find))
494
        connection.update(sql, "#{name} Update")
D
Initial  
David Heinemeier Hansson 已提交
495
      end
496

497
      # Destroys the objects for all the records that match the +condition+ by instantiating each object and calling
D
Initial  
David Heinemeier Hansson 已提交
498 499 500
      # the destroy method. Example:
      #   Person.destroy_all "last_login < '2004-04-04'"
      def destroy_all(conditions = nil)
501
        find(:all, :conditions => conditions).each { |object| object.destroy }
D
Initial  
David Heinemeier Hansson 已提交
502
      end
503

504
      # Deletes all the records that match the +condition+ without instantiating the objects first (and hence not
D
Initial  
David Heinemeier Hansson 已提交
505
      # calling the destroy method). Example:
506
      #   Post.delete_all "person_id = 5 AND (category = 'Something' OR category = 'Else')"
D
Initial  
David Heinemeier Hansson 已提交
507 508
      def delete_all(conditions = nil)
        sql = "DELETE FROM #{table_name} "
509
        add_conditions!(sql, conditions, scope(:find))
D
Initial  
David Heinemeier Hansson 已提交
510 511 512 513
        connection.delete(sql, "#{name} Delete all")
      end

      # Returns the result of an SQL statement that should only include a COUNT(*) in the SELECT part.
514
      #   Product.count_by_sql "SELECT COUNT(*) FROM sales s, customers c WHERE s.customer_id = c.id"
D
Initial  
David Heinemeier Hansson 已提交
515
      def count_by_sql(sql)
516
        sql = sanitize_conditions(sql)
517
        connection.select_value(sql, "#{name} Count").to_i
D
Initial  
David Heinemeier Hansson 已提交
518
      end
519 520

      # Increments the specified counter by one. So <tt>DiscussionBoard.increment_counter("post_count",
D
Initial  
David Heinemeier Hansson 已提交
521
      # discussion_board_id)</tt> would increment the "post_count" counter on the board responding to discussion_board_id.
522
      # This is used for caching aggregate values, so that they don't need to be computed every time. Especially important
D
Initial  
David Heinemeier Hansson 已提交
523 524 525
      # for looping over a collection where each element require a number of aggregate values. Like the DiscussionBoard
      # that needs to list both the number of posts and comments.
      def increment_counter(counter_name, id)
526
        update_all "#{counter_name} = #{counter_name} + 1", "#{primary_key} = #{quote_value(id)}"
D
Initial  
David Heinemeier Hansson 已提交
527 528 529 530
      end

      # Works like increment_counter, but decrements instead.
      def decrement_counter(counter_name, id)
531
        update_all "#{counter_name} = #{counter_name} - 1", "#{primary_key} = #{quote_value(id)}"
D
Initial  
David Heinemeier Hansson 已提交
532 533
      end

D
David Heinemeier Hansson 已提交
534

535
      # Attributes named in this macro are protected from mass-assignment, such as <tt>new(attributes)</tt> and
D
Initial  
David Heinemeier Hansson 已提交
536
      # <tt>attributes=(attributes)</tt>. Their assignment will simply be ignored. Instead, you can use the direct writer
537
      # methods to do assignment. This is meant to protect sensitive attributes from being overwritten by URL/form hackers. Example:
D
Initial  
David Heinemeier Hansson 已提交
538 539 540 541 542 543 544 545 546 547 548 549 550
      #
      #   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"
      def attr_protected(*attributes)
551
        write_inheritable_array("attr_protected", attributes - (protected_attributes || []))
D
Initial  
David Heinemeier Hansson 已提交
552
      end
553

554
      # Returns an array of all the attributes that have been protected from mass-assignment.
D
Initial  
David Heinemeier Hansson 已提交
555 556 557 558
      def protected_attributes # :nodoc:
        read_inheritable_attribute("attr_protected")
      end

559
      # If this macro is used, only those attributes named in it will be accessible for mass-assignment, such as
D
Initial  
David Heinemeier Hansson 已提交
560 561 562 563
      # <tt>new(attributes)</tt> and <tt>attributes=(attributes)</tt>. This is the more conservative choice for mass-assignment
      # protection. If you'd rather start from an all-open default and restrict attributes as needed, have a look at
      # attr_protected.
      def attr_accessible(*attributes)
564
        write_inheritable_array("attr_accessible", attributes - (accessible_attributes || []))
D
Initial  
David Heinemeier Hansson 已提交
565
      end
566

567
      # Returns an array of all the attributes that have been made accessible to mass-assignment.
D
Initial  
David Heinemeier Hansson 已提交
568 569 570 571
      def accessible_attributes # :nodoc:
        read_inheritable_attribute("attr_accessible")
      end

D
David Heinemeier Hansson 已提交
572

D
Initial  
David Heinemeier Hansson 已提交
573 574
      # Specifies that the attribute by the name of +attr_name+ should be serialized before saving to the database and unserialized
      # after loading from the database. The serialization is done through YAML. If +class_name+ is specified, the serialized
575
      # object must be of that class on retrieval or +SerializationTypeMismatch+ will be raised.
D
Initial  
David Heinemeier Hansson 已提交
576
      def serialize(attr_name, class_name = Object)
577
        serialized_attributes[attr_name.to_s] = class_name
D
Initial  
David Heinemeier Hansson 已提交
578
      end
579

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

D
David Heinemeier Hansson 已提交
585

D
Initial  
David Heinemeier Hansson 已提交
586 587
      # Guesses the table name (in forced lower-case) based on the name of the class in the inheritance hierarchy descending
      # directly from ActiveRecord. So if the hierarchy looks like: Reply < Message < ActiveRecord, then Message is used
588 589
      # to guess the table name from even when called on Reply. The rules used to do the guess are handled by the Inflector class
      # in Active Support, which knows almost all common English inflections (report a bug if your inflection isn't covered).
D
Initial  
David Heinemeier Hansson 已提交
590
      #
591 592 593 594 595
      # Nested classes are given table names prefixed by the singular form of
      # the parent's table name. Example:
      #   file                  class               table_name
      #   invoice.rb            Invoice             invoices
      #   invoice/lineitem.rb   Invoice::Lineitem   invoice_lineitems
D
Initial  
David Heinemeier Hansson 已提交
596
      #
597 598 599 600 601 602 603
      # Additionally, the class-level table_name_prefix is prepended and the
      # table_name_suffix is appended.  So if you have "myapp_" as a prefix,
      # 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 已提交
604 605
      #
      #   class Mouse < ActiveRecord::Base
606
      #     set_table_name "mice"
D
Initial  
David Heinemeier Hansson 已提交
607
      #   end
608
      def table_name
609 610 611
        reset_table_name
      end

D
David Heinemeier Hansson 已提交
612
      def reset_table_name #:nodoc:
613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628
        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 已提交
629
        set_table_name(name)
630
        name
D
Initial  
David Heinemeier Hansson 已提交
631 632
      end

633
      # Defines the primary key field -- can be overridden in subclasses. Overwriting will negate any effect of the
D
Initial  
David Heinemeier Hansson 已提交
634 635
      # primary_key_prefix_type setting, though.
      def primary_key
636 637 638
        reset_primary_key
      end

D
David Heinemeier Hansson 已提交
639
      def reset_primary_key #:nodoc:
640
        key = 'id'
D
Initial  
David Heinemeier Hansson 已提交
641 642
        case primary_key_prefix_type
          when :table_name
643
            key = Inflector.foreign_key(base_class.name, false)
D
Initial  
David Heinemeier Hansson 已提交
644
          when :table_name_with_underscore
645
            key = Inflector.foreign_key(base_class.name)
D
Initial  
David Heinemeier Hansson 已提交
646
        end
647 648
        set_primary_key(key)
        key
D
Initial  
David Heinemeier Hansson 已提交
649 650 651 652 653 654 655
      end

      # Defines the column name for use with single table inheritance -- can be overridden in subclasses.
      def inheritance_column
        "type"
      end

656 657
      # 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 已提交
658
      def sequence_name #:nodoc:
659 660 661
        reset_sequence_name
      end

D
David Heinemeier Hansson 已提交
662
      def reset_sequence_name #:nodoc:
663 664 665
        default = connection.default_sequence_name(table_name, primary_key)
        set_sequence_name(default)
        default
666 667
      end

668
      # Sets the table name to use to the given value, or (if the value
669
      # is nil or false) to the value returned by the given block.
670 671 672 673 674 675
      #
      # Example:
      #
      #   class Project < ActiveRecord::Base
      #     set_table_name "project"
      #   end
676
      def set_table_name(value = nil, &block)
677 678 679 680 681 682
        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
683
      # block.
684 685 686 687 688 689
      #
      # Example:
      #
      #   class Project < ActiveRecord::Base
      #     set_primary_key "sysid"
      #   end
690
      def set_primary_key(value = nil, &block)
691 692 693 694 695 696
        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
697
      # given block.
698 699 700 701 702 703 704 705
      #
      # Example:
      #
      #   class Project < ActiveRecord::Base
      #     set_inheritance_column do
      #       original_inheritance_column + "_id"
      #     end
      #   end
706
      def set_inheritance_column(value = nil, &block)
707 708 709 710
        define_attr_method :inheritance_column, value, &block
      end
      alias :inheritance_column= :set_inheritance_column

711 712
      # 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
713 714
      # given block. This is required for Oracle and is useful for any
      # database which relies on sequences for primary key generation.
715
      #
716 717 718 719 720
      # 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.
721 722 723 724 725 726
      #
      # Example:
      #
      #   class Project < ActiveRecord::Base
      #     set_sequence_name "projectseq"   # default would have been "project_seq"
      #   end
727
      def set_sequence_name(value = nil, &block)
728 729 730 731
        define_attr_method :sequence_name, value, &block
      end
      alias :sequence_name= :set_sequence_name

D
Initial  
David Heinemeier Hansson 已提交
732 733 734
      # 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
735 736 737
        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 已提交
738 739
      end

740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755
      # Indicates whether the table associated with this class exists
      def table_exists?
        if connection.respond_to?(:tables)
          connection.tables.include? table_name
        else
          # if the connection adapter hasn't implemented tables, there are two crude tests that can be
          # used - see if getting column info raises an error, or if the number of columns returned is zero
          begin
            reset_column_information
            columns.size > 0
          rescue ActiveRecord::StatementInvalid
            false
          end          
        end
      end

D
Initial  
David Heinemeier Hansson 已提交
756 757
      # Returns an array of column objects for the table associated with this class.
      def columns
758 759 760 761 762
        unless @columns
          @columns = connection.columns(table_name, "#{name} Columns")
          @columns.each {|column| column.primary = column.name == primary_key}
        end
        @columns
D
Initial  
David Heinemeier Hansson 已提交
763
      end
764

D
Initial  
David Heinemeier Hansson 已提交
765 766 767 768
      # Returns an array of column objects for the table associated with this class.
      def columns_hash
        @columns_hash ||= columns.inject({}) { |hash, column| hash[column.name] = column; hash }
      end
769

D
David Heinemeier Hansson 已提交
770
      # Returns an array of column names as strings.
771
      def column_names
772
        @column_names ||= columns.map { |column| column.name }
773
      end
D
Initial  
David Heinemeier Hansson 已提交
774

775 776
      # 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 已提交
777
      def content_columns
778
        @content_columns ||= columns.reject { |c| c.primary || c.name =~ /(_id|_count)$/ || c.name == inheritance_column }
D
Initial  
David Heinemeier Hansson 已提交
779 780 781 782
      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
783
      # is available.
D
David Heinemeier Hansson 已提交
784
      def column_methods_hash #:nodoc:
785
        @dynamic_methods_hash ||= column_names.inject(Hash.new(false)) do |methods, attr|
786 787 788 789 790
          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 已提交
791 792 793
          methods
        end
      end
794

795
      # Contains the names of the generated reader methods.
D
David Heinemeier Hansson 已提交
796
      def read_methods #:nodoc:
797
        @read_methods ||= Set.new
798
      end
799

800
      # Resets all the cached information about columns, which will cause them to be reloaded on the next request.
801
      def reset_column_information
802
        read_methods.each { |name| undef_method(name) }
803
        @column_names = @columns = @columns_hash = @content_columns = @dynamic_methods_hash = @read_methods = nil
804 805
      end

806
      def reset_column_information_and_inheritable_attributes_for_all_subclasses#:nodoc:
807 808
        subclasses.each { |klass| klass.reset_inheritable_attributes; klass.reset_column_information }
      end
D
Initial  
David Heinemeier Hansson 已提交
809 810 811

      # 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"
812 813
      # Deprecated in favor of just calling "first_name".humanize
      def human_attribute_name(attribute_key_name) #:nodoc:
814
        attribute_key_name.humanize
D
Initial  
David Heinemeier Hansson 已提交
815
      end
816

D
Initial  
David Heinemeier Hansson 已提交
817
      def descends_from_active_record? # :nodoc:
818
        superclass == Base || !columns_hash.include?(inheritance_column)
D
Initial  
David Heinemeier Hansson 已提交
819 820
      end

821 822

      def quote_value(value, column = nil) #:nodoc:
823
        connection.quote(value,column)
824 825
      end

826 827 828 829 830
      def quote(value, column = nil) #:nodoc:
        connection.quote(value, column)
      end
      deprecate :quote

831
      # Used to sanitize objects before they're used in an SELECT SQL-statement. Delegates to <tt>connection.quote</tt>.
832
      def sanitize(object) #:nodoc:
833
        connection.quote(object)
D
Initial  
David Heinemeier Hansson 已提交
834 835
      end

836
      # Log and benchmark multiple statements in a single block. Example:
D
Initial  
David Heinemeier Hansson 已提交
837 838 839 840
      #
      #   Project.benchmark("Creating project") do
      #     project = Project.create("name" => "stuff")
      #     project.create_manager("name" => "David")
841
      #     project.milestones << Milestone.find(:all)
D
Initial  
David Heinemeier Hansson 已提交
842
      #   end
843
      #
844 845 846 847
      # The benchmark is only recorded if the current level of the logger matches 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.
      #
848
      # The logging of the multiple statements is turned off unless <tt>use_silence</tt> is set to false.
849 850
      def benchmark(title, log_level = Logger::DEBUG, use_silence = true)
        if logger && logger.level == log_level
851 852
          result = nil
          seconds = Benchmark.realtime { result = use_silence ? silence { yield } : yield }
853
          logger.add(log_level, "#{title} (#{'%.5f' % seconds})")
854 855 856 857
          result
        else
          yield
        end
858
      end
859

860 861
      # Silences the logger for the duration of the block.
      def silence
862 863 864
        old_logger_level, logger.level = logger.level, Logger::ERROR if logger
        yield
      ensure
865
        logger.level = old_logger_level if logger
D
Initial  
David Heinemeier Hansson 已提交
866
      end
867 868

      # Scope parameters to method calls within the block.  Takes a hash of method_name => parameters hash.
869
      # method_name may be :find or :create. :find parameters may include the <tt>:conditions</tt>, <tt>:joins</tt>,
870
      # <tt>:include</tt>, <tt>:offset</tt>, <tt>:limit</tt>, and <tt>:readonly</tt> options. :create parameters are an attributes hash.
871
      #
872
      #   Article.with_scope(:find => { :conditions => "blog_id = 1" }, :create => { :blog_id => 1 }) do
873
      #     Article.find(1) # => SELECT * from articles WHERE blog_id = 1 AND id = 1
874
      #     a = Article.create(1)
875
      #     a.blog_id # => 1
876
      #   end
877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899
      #
      # In nested scopings, all previous parameters are overwritten by inner rule
      # except :conditions in :find, that are merged as hash.
      #
      #   Article.with_scope(:find => { :conditions => "blog_id = 1", :limit => 1 }, :create => { :blog_id => 1 }) do
      #     Article.with_scope(:find => { :limit => 10})
      #       Article.find(:all) # => SELECT * from articles WHERE blog_id = 1 LIMIT 10
      #     end
      #     Article.with_scope(:find => { :conditions => "author_id = 3" })
      #       Article.find(:all) # => SELECT * from articles WHERE blog_id = 1 AND author_id = 3 LIMIT 1
      #     end
      #   end
      #
      # You can ignore any previous scopings by using <tt>with_exclusive_scope</tt> method.
      #
      #   Article.with_scope(:find => { :conditions => "blog_id = 1", :limit => 1 }) do
      #     Article.with_exclusive_scope(:find => { :limit => 10 })
      #       Article.find(:all) # => SELECT * from articles LIMIT 10
      #     end
      #   end
      def with_scope(method_scoping = {}, action = :merge, &block)
        method_scoping = method_scoping.method_scoping if method_scoping.respond_to?(:method_scoping)

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

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

908
        if f = method_scoping[:find]
909
          f.assert_valid_keys([ :conditions, :joins, :select, :include, :from, :offset, :limit, :order, :readonly, :lock ])
910 911
          f[:readonly] = true if !f[:joins].blank? && !f.has_key?(:readonly)
        end
912

913 914 915 916 917
        # 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
918
                if method == :find
919
                  (hash[method].keys + params.keys).uniq.each do |key|
920 921
                    merge = hash[method][key] && params[key] # merge if both scopes have the same key
                    if key == :conditions && merge
922
                      hash[method][key] = [params[key], hash[method][key]].collect{ |sql| "( %s )" % sanitize_sql(sql) }.join(" AND ")
923 924
                    elsif key == :include && merge
                      hash[method][key] = merge_includes(hash[method][key], params[key]).uniq
925 926 927 928 929 930 931 932 933 934 935 936 937 938 939
                    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
940

941 942
        begin
          yield
943
        ensure
944 945 946 947
          self.scoped_methods.pop
        end
      end

D
David Heinemeier Hansson 已提交
948
      # Works like with_scope, but discards any nested properties.
949 950
      def with_exclusive_scope(method_scoping = {}, &block)
        with_scope(method_scoping, :overwrite, &block)
951
      end
D
Initial  
David Heinemeier Hansson 已提交
952

953 954 955
      # Overwrite the default class equality method to provide support for association proxies.
      def ===(object)
        object.is_a?(self)
956
      end      
957 958

      # Deprecated 
D
David Heinemeier Hansson 已提交
959
      def threaded_connections #:nodoc:
960 961 962 963
        allow_concurrency
      end

      # Deprecated 
D
David Heinemeier Hansson 已提交
964
      def threaded_connections=(value) #:nodoc:
965 966 967
        self.allow_concurrency = value
      end

968 969 970 971 972 973 974
      # 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

975 976 977 978 979 980 981 982 983
      # Set this to true if this is an abstract class (see #abstract_class?).
      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?
        abstract_class == true
      end

D
Initial  
David Heinemeier Hansson 已提交
984
      private
985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018
        def find_initial(options)
          options.update(:limit => 1) unless options[:include]
          find_every(options).first
        end
           
        def find_every(options)
          records = scoped?(:find, :include) || options[:include] ?
            find_with_associations(options) : 
            find_by_sql(construct_finder_sql(options))

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

          records
        end
 
        def find_from_ids(ids, options)
          expects_array = ids.first.kind_of?(Array)       
          return ids.first if expects_array && ids.first.empty?
        
          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
      
        def find_one(id, options)
          conditions = " AND (#{sanitize_sql(options[:conditions])})" if options[:conditions]
1019
          options.update :conditions => "#{table_name}.#{primary_key} = #{quote_value(id,columns_hash[primary_key])}#{conditions}"
1020

1021 1022 1023 1024
          # 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
1025 1026 1027 1028 1029 1030 1031 1032
            result
          else
            raise RecordNotFound, "Couldn't find #{name} with ID=#{id}#{conditions}"
          end
        end
      
        def find_some(ids, options)
          conditions = " AND (#{sanitize_sql(options[:conditions])})" if options[:conditions]
1033
          ids_list   = ids.map { |id| quote_value(id,columns_hash[primary_key]) }.join(',')
1034
          options.update :conditions => "#{table_name}.#{primary_key} IN (#{ids_list})#{conditions}"
1035 1036 1037 1038 1039 1040 1041 1042 1043 1044

          result = find_every(options)

          if result.size == ids.size
            result
          else
            raise RecordNotFound, "Couldn't find all #{name.pluralize} with IDs (#{ids_list})#{conditions}"
          end
        end

1045 1046 1047
        # 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 已提交
1048
        def instantiate(record)
1049
          object =
1050
            if subclass_name = record[inheritance_column]
1051
              # No type given.
1052 1053
              if subclass_name.empty?
                allocate
1054

1055 1056
              else
                require_association_class(subclass_name)
1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072

                # Ignore type if no column is present since it was probably
                # pulled in from a sloppy join.
                unless self.columns_hash.include?(inheritance_column)
                  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
1073 1074 1075 1076
                end
              end
            else
              allocate
1077
            end
1078

D
Initial  
David Heinemeier Hansson 已提交
1079
          object.instance_variable_set("@attributes", record)
1080
          object
D
Initial  
David Heinemeier Hansson 已提交
1081
        end
1082

1083 1084
        # 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 已提交
1085
        def type_name_with_module(type_name)
1086
          (/^::/ =~ type_name) ? type_name : "#{parent.name}::#{type_name}"
D
Initial  
David Heinemeier Hansson 已提交
1087 1088
        end

1089
        def construct_finder_sql(options)
1090 1091
          scope = scope(:find)
          sql  = "SELECT #{(scope && scope[:select]) || options[:select] || '*'} "
1092
          sql << "FROM #{(scope && scope[:from]) || options[:from] || table_name} "
1093

1094 1095
          add_joins!(sql, options, scope)
          add_conditions!(sql, options[:conditions], scope)
1096

1097
          sql << " GROUP BY #{options[:group]} " if options[:group]
1098

1099
          add_order!(sql, options[:order])
1100
          add_limit!(sql, options, scope)
1101
          add_lock!(sql, options, scope)
1102

1103
          sql
1104
        end
1105

1106 1107
        # Merges includes so that the result is a valid +include+
        def merge_includes(first, second)
1108
         (safe_to_array(first) + safe_to_array(second)).uniq
1109 1110
        end

1111
        # Object#to_a is deprecated, though it does have the desired behavior
1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122
        def safe_to_array(o)
          case o
          when NilClass
            []
          when Array
            o
          else
            [o]
          end
        end

1123 1124 1125 1126 1127 1128 1129 1130 1131
        def add_order!(sql, order)
          if order
            sql << " ORDER BY #{order}"
            sql << ", #{scope(:find, :order)}" if scoped?(:find, :order)
          else
            sql << " ORDER BY #{scope(:find, :order)}" if scoped?(:find, :order)
          end
        end

1132
        # The optional scope argument is for the current :find scope.
1133 1134
        def add_limit!(sql, options, scope = :auto)
          scope = scope(:find) if :auto == scope
1135
          options = options.reverse_merge(:limit => scope[:limit], :offset => scope[:offset]) if scope
1136
          connection.add_limit_offset!(sql, options)
1137
        end
1138

1139 1140 1141 1142 1143 1144 1145 1146
        # The optional scope argument is for the current :find scope.
        # The :lock option has precedence over a scoped :lock.
        def add_lock!(sql, options, scope = :auto)
          scope = scope(:find) if :auto == :scope
          options = options.reverse_merge(:lock => scope[:lock]) if scope
          connection.add_lock!(sql, options)
        end

1147
        # The optional scope argument is for the current :find scope.
1148 1149
        def add_joins!(sql, options, scope = :auto)
          scope = scope(:find) if :auto == scope
1150
          join = (scope && scope[:joins]) || options[:joins]
1151 1152
          sql << " #{join} " if join
        end
1153

1154
        # Adds a sanitized version of +conditions+ to the +sql+ string. Note that the passed-in +sql+ string is changed.
1155
        # The optional scope argument is for the current :find scope.
1156 1157
        def add_conditions!(sql, conditions, scope = :auto)
          scope = scope(:find) if :auto == scope
1158 1159
          segments = []
          segments << sanitize_sql(scope[:conditions]) if scope && scope[:conditions]
1160 1161 1162 1163
          segments << sanitize_sql(conditions) unless conditions.nil?
          segments << type_condition unless descends_from_active_record?        
          segments.compact!
          sql << "WHERE (#{segments.join(") AND (")}) " unless segments.empty?
D
Initial  
David Heinemeier Hansson 已提交
1164
        end
1165

D
Initial  
David Heinemeier Hansson 已提交
1166
        def type_condition
1167 1168 1169
          quoted_inheritance_column = connection.quote_column_name(inheritance_column)
          type_condition = subclasses.inject("#{table_name}.#{quoted_inheritance_column} = '#{name.demodulize}' ") do |condition, subclass|
            condition << "OR #{table_name}.#{quoted_inheritance_column} = '#{subclass.name.demodulize}' "
1170
          end
1171 1172

          " (#{type_condition}) "
D
Initial  
David Heinemeier Hansson 已提交
1173 1174 1175
        end

        # Guesses the table name, but does not decorate it with prefix and suffix information.
1176
        def undecorated_table_name(class_name = base_class.name)
D
Initial  
David Heinemeier Hansson 已提交
1177 1178
          table_name = Inflector.underscore(Inflector.demodulize(class_name))
          table_name = Inflector.pluralize(table_name) if pluralize_table_names
1179
          table_name
D
Initial  
David Heinemeier Hansson 已提交
1180 1181
        end

1182 1183
        # 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])
1184
        # respectively. Also works for find(:all), but using find_all_by_amount(50) that are turned into find(:all, :conditions => ["amount = ?", 50]).
1185
        #
1186 1187
        # 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).
1188
        def method_missing(method_id, *arguments)
1189
          if match = /find_(all_by|by)_([_a-zA-Z]\w*)/.match(method_id.to_s)
1190
            finder, deprecated_finder = determine_finder(match), determine_deprecated_finder(match)
1191

1192 1193
            attribute_names = extract_attribute_names_from_match(match)
            super unless all_attributes_exists?(attribute_names)
1194

1195
            conditions = construct_conditions_from_arguments(attribute_names, arguments)
1196

1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213
            case extra_options = arguments[attribute_names.size]
              when nil
                options = { :conditions => conditions }
                set_readonly_option!(options)
                send(finder, options)

              when Hash
                finder_options = extra_options.merge(:conditions => conditions)
                validate_find_options(finder_options)
                set_readonly_option!(finder_options)

                if extra_options[:conditions]
                  with_scope(:find => { :conditions => extra_options[:conditions] }) do
                    send(finder, finder_options)
                  end
                else
                  send(finder, finder_options)
1214
                end
1215

1216
              else
1217
                send(deprecated_finder, conditions, *arguments[attribute_names.length..-1]) # deprecated API
1218
            end
1219 1220
          elsif match = /find_or_(initialize|create)_by_([_a-zA-Z]\w*)/.match(method_id.to_s)
            instantiator = determine_instantiator(match)
1221 1222 1223
            attribute_names = extract_attribute_names_from_match(match)
            super unless all_attributes_exists?(attribute_names)

1224 1225
            options = { :conditions => construct_conditions_from_arguments(attribute_names, arguments) }
            set_readonly_option!(options)
1226
            find_initial(options) || send(instantiator, construct_attributes_from_arguments(attribute_names, arguments))
1227 1228 1229 1230
          else
            super
          end
        end
D
Initial  
David Heinemeier Hansson 已提交
1231

1232
        def determine_finder(match)
1233 1234 1235 1236 1237
          match.captures.first == 'all_by' ? :find_every : :find_initial
        end

        def determine_deprecated_finder(match)
          match.captures.first == 'all_by' ? :find_all : :find_first
1238 1239
        end

1240 1241 1242 1243
        def determine_instantiator(match)
          match.captures.first == 'initialize' ? :new : :create
        end

1244 1245 1246 1247 1248 1249
        def extract_attribute_names_from_match(match)
          match.captures.last.split('_and_')
        end

        def construct_conditions_from_arguments(attribute_names, arguments)
          conditions = []
1250
          attribute_names.each_with_index { |name, idx| conditions << "#{table_name}.#{connection.quote_column_name(name)} #{attribute_condition(arguments[idx])} " }
1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263
          [ conditions.join(" AND "), *arguments[0...attribute_names.length] ]
        end
        
        def construct_attributes_from_arguments(attribute_names, arguments)
          attributes = {}
          attribute_names.each_with_index { |name, idx| attributes[name] = arguments[idx] }
          attributes
        end

        def all_attributes_exists?(attribute_names)
          attribute_names.all? { |name| column_methods_hash.include?(name.to_sym) }
        end

1264 1265 1266 1267 1268 1269 1270 1271
        def attribute_condition(argument)
          case argument
            when nil   then "IS ?"
            when Array then "IN (?)"
            else            "= ?"
          end
        end

1272 1273 1274 1275 1276 1277 1278 1279 1280
        # 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
            else construct_conditions_from_arguments([primary_key], [id_or_conditions])
          end
        end


1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300
        # Defines an "attribute" method (like #inheritance_column or
        # #table_name). A new (class) method will be created with the
        # 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
1301
          sing.send :alias_method, "original_#{name}", name
1302 1303 1304
          if block_given?
            sing.send :define_method, name, &block
          else
1305 1306 1307 1308
            # 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
1309 1310
        end

D
Initial  
David Heinemeier Hansson 已提交
1311
      protected
D
David Heinemeier Hansson 已提交
1312
        def subclasses #:nodoc:
D
Initial  
David Heinemeier Hansson 已提交
1313 1314 1315
          @@subclasses[self] ||= []
          @@subclasses[self] + extra = @@subclasses[self].inject([]) {|list, subclass| list + subclass.subclasses }
        end
1316 1317

        # Test whether the given method and optional key are scoped.
D
David Heinemeier Hansson 已提交
1318
        def scoped?(method, key = nil) #:nodoc:
1319 1320 1321
          if current_scoped_methods && (scope = current_scoped_methods[method])
            !key || scope.has_key?(key)
          end
1322 1323 1324
        end

        # Retrieve the scope for the given method and optional key.
D
David Heinemeier Hansson 已提交
1325
        def scope(method, key = nil) #:nodoc:
1326
          if current_scoped_methods && (scope = current_scoped_methods[method])
1327 1328 1329 1330
            key ? scope[key] : scope
          end
        end

1331 1332 1333
        def thread_safe_scoped_methods #:nodoc:
          scoped_methods = (Thread.current[:scoped_methods] ||= {})
          scoped_methods[self] ||= []
1334
        end
1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346
        
        def single_threaded_scoped_methods #:nodoc:
          @scoped_methods ||= []
        end
        
        # 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
        
D
David Heinemeier Hansson 已提交
1347
        def current_scoped_methods #:nodoc:
1348
          scoped_methods.last
1349
        end
1350

1351 1352
        # 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 已提交
1353
        def compute_type(type_name)
1354
          modularized_name = type_name_with_module(type_name)
1355
          begin
1356 1357
            instance_eval(modularized_name)
          rescue NameError => e
1358
            instance_eval(type_name)
D
Initial  
David Heinemeier Hansson 已提交
1359 1360 1361
          end
        end

1362 1363
        # Returns the class descending directly from ActiveRecord in the inheritance hierarchy.
        def class_of_active_record_descendant(klass)
1364
          if klass.superclass == Base || klass.superclass.abstract_class?
1365
            klass
D
Initial  
David Heinemeier Hansson 已提交
1366 1367 1368
          elsif klass.superclass.nil?
            raise ActiveRecordError, "#{name} doesn't belong in a hierarchy descending from ActiveRecord"
          else
1369
            class_of_active_record_descendant(klass.superclass)
D
Initial  
David Heinemeier Hansson 已提交
1370 1371 1372
          end
        end

1373
        # Returns the name of the class descending directly from ActiveRecord in the inheritance hierarchy.
D
David Heinemeier Hansson 已提交
1374
        def class_name_of_active_record_descendant(klass) #:nodoc:
1375
          klass.base_class.name
1376 1377
        end

1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393
        #Accepts an array, hash, or string of sql conditions and 
        #deals with them accordingly
        #   ["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'"
        def sanitize_sql(condition)
          return sanitize_sql_array(condition) if condition.is_a?(Array)
          return sanitize_sql_hash(condition) if condition.is_a?(Hash)
          condition
        end
        
        # Accepts a hash of conditions.  The hash has each key/value or attribute/value pair
        # sanitized and interpolated into the sql statement.
        #   { :name => "foo'bar", :group_id => 4 }  returns "name='foo''bar' and group_id= 4"
        def sanitize_sql_hash(hash)
          hash.collect { |attrib, value|
1394
            "#{table_name}.#{connection.quote_column_name(attrib)} = #{quote_value(value)}"
1395 1396 1397 1398
          }.join(" AND ")
        end
        
        # Accepts an array of conditions.  The array has each value
1399 1400
        # sanitized and interpolated into the sql statement.
        #   ["name='%s' and group_id='%s'", "foo'bar", 4]  returns  "name='foo''bar' and group_id='4'"
1401
        def sanitize_sql_array(ary)
1402 1403 1404 1405
          statement, *values = ary
          if values.first.is_a?(Hash) and statement =~ /:\w+/
            replace_named_bind_variables(statement, values.first)
          elsif statement.include?('?')
1406 1407
            replace_bind_variables(statement, values)
          else
1408
            statement % values.collect { |value| connection.quote_string(value.to_s) }
1409
          end
1410 1411
        end

1412 1413
        alias_method :sanitize_conditions, :sanitize_sql

D
David Heinemeier Hansson 已提交
1414
        def replace_bind_variables(statement, values) #:nodoc:
1415
          raise_if_bind_arity_mismatch(statement, statement.count('?'), values.size)
1416
          bound = values.dup
1417
          statement.gsub('?') { quote_bound_value(bound.shift) }
1418 1419
        end

D
David Heinemeier Hansson 已提交
1420
        def replace_named_bind_variables(statement, bind_vars) #:nodoc:
1421 1422
          statement.gsub(/:(\w+)/) do
            match = $1.to_sym
1423
            if bind_vars.include?(match)
1424
              quote_bound_value(bind_vars[match])
1425 1426
            else
              raise PreparedStatementInvalid, "missing value for :#{match} in #{statement}"
1427 1428
            end
          end
1429 1430
        end

D
David Heinemeier Hansson 已提交
1431
        def quote_bound_value(value) #:nodoc:
1432 1433 1434
          if value.respond_to?(:map) && !value.is_a?(String)
            if value.respond_to?(:empty?) && value.empty?
              connection.quote(nil)
1435 1436 1437
            else
              value.map { |v| connection.quote(v) }.join(',')
            end
1438 1439
          else
            connection.quote(value)
1440 1441 1442
          end
        end

D
David Heinemeier Hansson 已提交
1443
        def raise_if_bind_arity_mismatch(statement, expected, provided) #:nodoc:
1444 1445 1446
          unless expected == provided
            raise PreparedStatementInvalid, "wrong number of bind variables (#{provided} for #{expected}) in: #{statement}"
          end
1447
        end
1448

D
David Heinemeier Hansson 已提交
1449
        def extract_options_from_args!(args) #:nodoc:
1450
          args.last.is_a?(Hash) ? args.pop : {}
1451
        end
1452

1453
        VALID_FIND_OPTIONS = [ :conditions, :include, :joins, :limit, :offset,
1454 1455
                               :order, :select, :readonly, :group, :from, :lock ]

D
David Heinemeier Hansson 已提交
1456
        def validate_find_options(options) #:nodoc:
1457 1458
          options.assert_valid_keys(VALID_FIND_OPTIONS)
        end
1459

D
David Heinemeier Hansson 已提交
1460
        def set_readonly_option!(options) #:nodoc:
1461 1462 1463 1464 1465
          # Inherit :readonly from finder scope if set.  Otherwise,
          # if :joins is not blank then :readonly defaults to true.
          unless options.has_key?(:readonly)
            if scoped?(:find, :readonly)
              options[:readonly] = scope(:find, :readonly)
1466
            elsif !options[:joins].blank? && !options[:select]
1467 1468 1469
              options[:readonly] = true
            end
          end
D
Initial  
David Heinemeier Hansson 已提交
1470
        end
1471

D
David Heinemeier Hansson 已提交
1472
        def encode_quoted_value(value) #:nodoc:
1473
          quoted_value = connection.quote(value)
1474 1475
          quoted_value = "'#{quoted_value[1..-2].gsub(/\'/, "\\\\'")}'" if quoted_value.include?("\\\'") # (for ruby mode) " 
          quoted_value 
1476
        end
D
Initial  
David Heinemeier Hansson 已提交
1477 1478 1479 1480 1481
    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).
1482
      # In both instances, valid attribute keys are determined by the column names of the associated table --
D
Initial  
David Heinemeier Hansson 已提交
1483 1484 1485 1486 1487 1488 1489 1490
      # hence you can't have attributes that aren't part of the table columns.
      def initialize(attributes = nil)
        @attributes = attributes_from_column_definition
        @new_record = true
        ensure_proper_type
        self.attributes = attributes unless attributes.nil?
        yield self if block_given?
      end
1491

1492 1493
      # 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 已提交
1494
      def id
1495
        attr_name = self.class.primary_key
1496
        column = column_for_attribute(attr_name)
1497
        define_read_method(:id, attr_name, column) if self.class.generate_read_methods
1498
        read_attribute(attr_name)
D
Initial  
David Heinemeier Hansson 已提交
1499
      end
1500

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

1507
      def id_before_type_cast #:nodoc:
1508 1509 1510
        read_attribute_before_type_cast(self.class.primary_key)
      end

1511
      def quoted_id #:nodoc:
1512
        quote_value(id, column_for_attribute(self.class.primary_key))
1513
      end
1514

D
Initial  
David Heinemeier Hansson 已提交
1515 1516 1517 1518
      # Sets the primary ID.
      def id=(value)
        write_attribute(self.class.primary_key, value)
      end
1519

D
Initial  
David Heinemeier Hansson 已提交
1520
      # Returns true if this object hasn't been saved yet -- that is, a record for the object doesn't exist yet.
1521
      def new_record?
1522
        @new_record
1523
      end
1524

D
Initial  
David Heinemeier Hansson 已提交
1525 1526 1527
      # * 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.
      def save
1528
        raise ReadOnlyRecord if readonly?
D
Initial  
David Heinemeier Hansson 已提交
1529 1530
        create_or_update
      end
1531 1532 1533 1534
      
      # Attempts to save the record, but instead of just returning false if it couldn't happen, it raises a 
      # RecordNotSaved exception
      def save!
1535
        save || raise(RecordNotSaved)
1536
      end
1537

D
Initial  
David Heinemeier Hansson 已提交
1538 1539 1540
      # 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
1541
        unless new_record?
1542 1543 1544 1545
          connection.delete <<-end_sql, "#{self.class.name} Destroy"
            DELETE FROM #{self.class.table_name}
            WHERE #{self.class.primary_key} = #{quoted_id}
          end_sql
D
Initial  
David Heinemeier Hansson 已提交
1546 1547 1548 1549 1550
        end

        freeze
      end

J
Jeremy Kemper 已提交
1551 1552 1553 1554 1555
      # 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 已提交
1556
      def clone
1557
        attrs = self.attributes_before_type_cast
D
David Heinemeier Hansson 已提交
1558
        attrs.delete(self.class.primary_key)
1559 1560 1561
        self.class.new do |record|
          record.send :instance_variable_set, '@attributes', attrs
        end
D
Initial  
David Heinemeier Hansson 已提交
1562
      end
1563

D
Initial  
David Heinemeier Hansson 已提交
1564
      # Updates a single attribute and saves the record. This is especially useful for boolean flags on existing records.
1565 1566
      # Note: This method is overwritten by the Validation module that'll make sure that updates made with this method
      # doesn't get subjected to validation checks. Hence, attributes can be updated even if the full object isn't valid.
D
Initial  
David Heinemeier Hansson 已提交
1567
      def update_attribute(name, value)
1568
        send(name.to_s + '=', value)
1569
        save
1570 1571
      end

1572
      # Updates all the attributes from the passed-in Hash and saves the record. If the object is invalid, the saving will
1573
      # fail and false will be returned.
1574
      def update_attributes(attributes)
1575
        self.attributes = attributes
1576
        save
D
Initial  
David Heinemeier Hansson 已提交
1577 1578
      end

1579 1580 1581 1582 1583 1584
      # Initializes the +attribute+ to zero if nil and adds one. Only makes sense for number-based attributes. Returns self.
      def increment(attribute)
        self[attribute] ||= 0
        self[attribute] += 1
        self
      end
1585

1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601
      # Increments the +attribute+ and saves the record.
      def increment!(attribute)
        increment(attribute).update_attribute(attribute, self[attribute])
      end

      # Initializes the +attribute+ to zero if nil and subtracts one. Only makes sense for number-based attributes. Returns self.
      def decrement(attribute)
        self[attribute] ||= 0
        self[attribute] -= 1
        self
      end

      # Decrements the +attribute+ and saves the record.
      def decrement!(attribute)
        decrement(attribute).update_attribute(attribute, self[attribute])
      end
1602

1603 1604
      # Turns an +attribute+ that's currently true into false and vice versa. Returns self.
      def toggle(attribute)
1605
        self[attribute] = !send("#{attribute}?")
1606 1607 1608 1609 1610 1611 1612 1613
        self
      end

      # Toggles the +attribute+ and saves the record.
      def toggle!(attribute)
        toggle(attribute).update_attribute(attribute, self[attribute])
      end

1614
      # Reloads the attributes of this object from the database.
1615 1616 1617 1618
      # 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)
1619
        clear_aggregation_cache
1620
        clear_association_cache
1621
        @attributes.update(self.class.find(self.id, options).instance_variable_get('@attributes'))
1622
        self
1623 1624
      end

1625
      # Returns the value of the attribute identified by <tt>attr_name</tt> after it has been typecast (for example,
D
Initial  
David Heinemeier Hansson 已提交
1626 1627
      # "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).
1628
      def [](attr_name)
1629
        read_attribute(attr_name)
D
Initial  
David Heinemeier Hansson 已提交
1630
      end
1631

D
Initial  
David Heinemeier Hansson 已提交
1632 1633
      # Updates the attribute identified by <tt>attr_name</tt> with the specified +value+.
      # (Alias for the protected write_attribute method).
1634
      def []=(attr_name, value)
1635
        write_attribute(attr_name, value)
D
Initial  
David Heinemeier Hansson 已提交
1636 1637 1638 1639 1640 1641 1642
      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
      # specify which attributes *can* be accessed in with the +attr_accessible+ macro. Then all the
      # attributes not included in that won't be allowed to be mass-assigned.
D
David Heinemeier Hansson 已提交
1643 1644 1645
      def attributes=(new_attributes)
        return if new_attributes.nil?
        attributes = new_attributes.dup
1646
        attributes.stringify_keys!
D
Initial  
David Heinemeier Hansson 已提交
1647 1648

        multi_parameter_attributes = []
1649
        remove_attributes_protected_from_mass_assignment(attributes).each do |k, v|
D
Initial  
David Heinemeier Hansson 已提交
1650 1651
          k.include?("(") ? multi_parameter_attributes << [ k, v ] : send(k + "=", v)
        end
D
David Heinemeier Hansson 已提交
1652

D
Initial  
David Heinemeier Hansson 已提交
1653 1654 1655
        assign_multiparameter_attributes(multi_parameter_attributes)
      end

D
David Heinemeier Hansson 已提交
1656

1657
      # Returns a hash of all the attributes with their names as keys and clones of their objects as values.
1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675
      def attributes(options = nil)
        attributes = clone_attributes :read_attribute
        
        if options.nil?
          attributes
        else
          if except = options[:except]
            except = Array(except).collect { |attribute| attribute.to_s }
            except.each { |attribute_name| attributes.delete(attribute_name) }
            attributes
          elsif only = options[:only]
            only = Array(only).collect { |attribute| attribute.to_s }
            attributes.delete_if { |key, value| !only.include?(key) }
            attributes
          else
            raise ArgumentError, "Options does not specify :except or :only (#{options.keys.inspect})"
          end
        end
1676 1677 1678 1679 1680
      end

      # Returns a hash of cloned attributes before typecasting and deserialization.
      def attributes_before_type_cast
        clone_attributes :read_attribute_before_type_cast
1681 1682
      end

D
Initial  
David Heinemeier Hansson 已提交
1683
      # Returns true if the specified +attribute+ has been set by the user or by a database load and is neither
1684
      # nil nor empty? (the latter only applies to objects that respond to empty?, most notably Strings).
D
Initial  
David Heinemeier Hansson 已提交
1685
      def attribute_present?(attribute)
1686 1687
        value = read_attribute(attribute)
        !value.blank? or value == 0
D
Initial  
David Heinemeier Hansson 已提交
1688 1689
      end

1690 1691 1692 1693 1694
      # 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 已提交
1695 1696 1697 1698 1699 1700 1701
      # 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)
1702
        self.class.columns_hash[name.to_s]
D
Initial  
David Heinemeier Hansson 已提交
1703
      end
1704

1705
      # 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 已提交
1706
      def ==(comparison_object)
1707 1708
        comparison_object.equal?(self) ||
          (comparison_object.instance_of?(self.class) && 
1709
            comparison_object.id == id && 
1710
            !comparison_object.new_record?)
D
Initial  
David Heinemeier Hansson 已提交
1711 1712 1713 1714 1715 1716
      end

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

D
Initial  
David Heinemeier Hansson 已提交
1718 1719 1720
      # 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
1721
        id.hash
D
Initial  
David Heinemeier Hansson 已提交
1722 1723 1724 1725 1726 1727 1728
      end

      # For checking respond_to? without searching the attributes (which is faster).
      alias_method :respond_to_without_attributes?, :respond_to?

      # A Person object with a name attribute can ask person.respond_to?("name"), person.respond_to?("name="), and
      # person.respond_to?("name?") which will all return true.
1729
      def respond_to?(method, include_priv = false)
1730
        if @attributes.nil?
1731
          return super
1732
        elsif attr_name = self.class.column_methods_hash[method.to_sym]
1733 1734 1735 1736
          return true if @attributes.include?(attr_name) || attr_name == self.class.primary_key
          return false if self.class.read_methods.include?(attr_name)
        elsif @attributes.include?(method_name = method.to_s)
          return true
1737
        elsif md = self.class.match_attribute_method?(method.to_s)
1738 1739 1740 1741 1742
          return true if @attributes.include?(md.pre_match)
        end
        # super must be called at the end of the method, because the inherited respond_to?
        # would return true for generated readers, even if the attribute wasn't present
        super
D
Initial  
David Heinemeier Hansson 已提交
1743
      end
1744

1745 1746
      # Just freeze the attributes hash, such that associations are still accessible even on destroyed records.
      def freeze
1747
        @attributes.freeze; self
1748
      end
1749

1750 1751 1752
      def frozen?
        @attributes.frozen?
      end
1753

D
David Heinemeier Hansson 已提交
1754
      # Records loaded through joins with piggy-back attributes will be marked as read only as they cannot be saved and return true to this query.
1755 1756 1757 1758
      def readonly?
        @readonly == true
      end

D
David Heinemeier Hansson 已提交
1759
      def readonly! #:nodoc:
1760 1761
        @readonly = true
      end
1762

1763

D
Initial  
David Heinemeier Hansson 已提交
1764 1765
    private
      def create_or_update
1766
        if new_record? then create else update end
1767
        true
D
Initial  
David Heinemeier Hansson 已提交
1768 1769
      end

1770
      # Updates the associated record with values matching those of the instance attributes.
1771
      # Returns the number of affected rows.
D
Initial  
David Heinemeier Hansson 已提交
1772 1773 1774
      def update
        connection.update(
          "UPDATE #{self.class.table_name} " +
1775
          "SET #{quoted_comma_pair_list(connection, attributes_with_quotes(false))} " +
1776
          "WHERE #{self.class.primary_key} = #{quote_value(id)}",
D
Initial  
David Heinemeier Hansson 已提交
1777 1778 1779 1780
          "#{self.class.name} Update"
        )
      end

1781 1782
      # Creates a record with values matching those of the instance attributes
      # and returns its id.
D
Initial  
David Heinemeier Hansson 已提交
1783
      def create
1784
        if self.id.nil? && connection.prefetch_primary_key?(self.class.table_name)
1785 1786
          self.id = connection.next_sequence_value(self.class.sequence_name)
        end
1787

D
Initial  
David Heinemeier Hansson 已提交
1788 1789 1790 1791 1792
        self.id = connection.insert(
          "INSERT INTO #{self.class.table_name} " +
          "(#{quoted_column_names.join(', ')}) " +
          "VALUES(#{attributes_with_quotes.values.join(', ')})",
          "#{self.class.name} Create",
1793
          self.class.primary_key, self.id, self.class.sequence_name
D
Initial  
David Heinemeier Hansson 已提交
1794
        )
1795

D
Initial  
David Heinemeier Hansson 已提交
1796
        @new_record = false
1797
        id
D
Initial  
David Heinemeier Hansson 已提交
1798 1799
      end

1800
      # Sets the attribute used for single table inheritance to this class name if this is not the ActiveRecord descendent.
1801 1802
      # Considering the hierarchy Reply < Message < ActiveRecord, this makes it possible to do Reply.new without having to
      # set Reply[Reply.inheritance_column] = "Reply" yourself. No such attribute would be set for objects of the
D
Initial  
David Heinemeier Hansson 已提交
1803 1804 1805 1806 1807 1808 1809
      # Message class in that example.
      def ensure_proper_type
        unless self.class.descends_from_active_record?
          write_attribute(self.class.inheritance_column, Inflector.demodulize(self.class.name))
        end
      end

1810

D
Initial  
David Heinemeier Hansson 已提交
1811 1812 1813 1814
      # Allows access to the object attributes, which are held in the @attributes hash, as were
      # they first-class methods. So a Person class with a name attribute can use Person#name and
      # Person#name= and never directly use the attributes hash -- except for multiple assigns with
      # ActiveRecord#attributes=. A Milestone class can also ask Milestone#completed? to test that
1815
      # the completed attribute is not nil or 0.
D
Initial  
David Heinemeier Hansson 已提交
1816 1817 1818
      #
      # It's also possible to instantiate related objects, so a Client class belonging to the clients
      # table with a master_id foreign key can instantiate master through Client#master.
1819 1820
      def method_missing(method_id, *args, &block)
        method_name = method_id.to_s
1821 1822
        if @attributes.include?(method_name) or
            (md = /\?$/.match(method_name) and
1823 1824
            @attributes.include?(query_method_name = md.pre_match) and
            method_name = query_method_name)
1825
          define_read_methods if self.class.read_methods.empty? && self.class.generate_read_methods
1826
          md ? query_attribute(method_name) : read_attribute(method_name)
1827 1828
        elsif self.class.primary_key.to_s == method_name
          id
1829
        elsif md = self.class.match_attribute_method?(method_name)
1830 1831
          attribute_name, method_type = md.pre_match, md.to_s
          if @attributes.include?(attribute_name)
1832
            __send__("attribute#{method_type}", attribute_name, *args, &block)
1833 1834 1835
          else
            super
          end
D
Initial  
David Heinemeier Hansson 已提交
1836 1837 1838 1839 1840
        else
          super
        end
      end

1841
      # Returns the value of the attribute identified by <tt>attr_name</tt> after it has been typecast (for example,
D
Initial  
David Heinemeier Hansson 已提交
1842
      # "2004-12-12" in a data column is cast to a date object, like Date.new(2004, 12, 12)).
1843
      def read_attribute(attr_name)
1844
        attr_name = attr_name.to_s
1845
        if !(value = @attributes[attr_name]).nil?
D
Initial  
David Heinemeier Hansson 已提交
1846
          if column = column_for_attribute(attr_name)
1847 1848 1849
            if unserializable_attribute?(attr_name, column)
              unserialize_attribute(attr_name)
            else
1850
              column.type_cast(value)
1851
            end
1852
          else
1853
            value
D
Initial  
David Heinemeier Hansson 已提交
1854 1855 1856 1857 1858 1859
          end
        else
          nil
        end
      end

1860 1861 1862 1863
      def read_attribute_before_type_cast(attr_name)
        @attributes[attr_name]
      end

1864 1865 1866 1867 1868
      # Called on first read access to any given column and generates reader
      # methods for all columns in the columns_hash if
      # ActiveRecord::Base.generate_read_methods is set to true.
      def define_read_methods
        self.class.columns_hash.each do |name, column|
1869 1870 1871
          unless self.class.serialized_attributes[name]
            define_read_method(name.to_sym, name, column) unless respond_to_without_attributes?(name)
            define_question_method(name)     unless respond_to_without_attributes?("#{name}?")
1872 1873 1874 1875
          end
        end
      end

1876
      # Define an attribute reader method.  Cope with nil column.
1877
      def define_read_method(symbol, attr_name, column)
1878
        cast_code = column.type_cast_code('v') if column
1879
        access_code = cast_code ? "(v=@attributes['#{attr_name}']) && #{cast_code}" : "@attributes['#{attr_name}']"
1880
        
1881
        unless attr_name.to_s == self.class.primary_key.to_s
1882
          access_code = access_code.insert(0, "raise NoMethodError, 'missing attribute: #{attr_name}', caller unless @attributes.has_key?('#{attr_name}'); ")
1883
          self.class.read_methods << attr_name
1884 1885 1886 1887 1888 1889 1890 1891
        end
        
        evaluate_read_method attr_name, "def #{symbol}; #{access_code}; end"
      end
      
      # Define an attribute ? method.
      def define_question_method(attr_name)
        unless attr_name.to_s == self.class.primary_key.to_s
1892
          self.class.read_methods << "#{attr_name}?"
1893
        end
1894 1895 1896 1897 1898 1899
        
        evaluate_read_method attr_name, "def #{attr_name}?; query_attribute('#{attr_name}'); end"
      end
      
      # Evaluate the definition for an attribute reader or ? method
      def evaluate_read_method(attr_name, method_definition)
1900
        begin
1901
          self.class.class_eval(method_definition)
1902 1903 1904
        rescue SyntaxError => err
          self.class.read_methods.delete(attr_name)
          if logger
1905
            logger.warn "Exception occurred during reader method compilation."
1906 1907 1908 1909
            logger.warn "Maybe #{attr_name} is not a valid Ruby identifier?"
            logger.warn "#{err.message}"
          end
        end
1910 1911
      end

D
Initial  
David Heinemeier Hansson 已提交
1912 1913
      # Returns true if the attribute is of a text column and marked for serialization.
      def unserializable_attribute?(attr_name, column)
1914
        column.text? && self.class.serialized_attributes[attr_name]
D
Initial  
David Heinemeier Hansson 已提交
1915 1916 1917 1918 1919 1920 1921 1922 1923
      end

      # Returns the unserialized object of the attribute.
      def unserialize_attribute(attr_name)
        unserialized_object = object_from_yaml(@attributes[attr_name])

        if unserialized_object.is_a?(self.class.serialized_attributes[attr_name])
          @attributes[attr_name] = unserialized_object
        else
1924
          raise SerializationTypeMismatch,
1925
            "#{attr_name} was supposed to be a #{self.class.serialized_attributes[attr_name]}, but was a #{unserialized_object.class.to_s}"
D
Initial  
David Heinemeier Hansson 已提交
1926 1927 1928 1929 1930
        end
      end

      # Updates the attribute identified by <tt>attr_name</tt> with the specified +value+. Empty strings for fixnum and float
      # columns are turned into nil.
1931
      def write_attribute(attr_name, value)
1932 1933 1934 1935 1936 1937
        attr_name = attr_name.to_s
        if (column = column_for_attribute(attr_name)) && column.number?
          @attributes[attr_name] = convert_number_column_value(value)
        else
          @attributes[attr_name] = value
        end
D
Initial  
David Heinemeier Hansson 已提交
1938 1939
      end

1940 1941 1942 1943 1944 1945 1946
      def convert_number_column_value(value)
        case value
          when FalseClass: 0
          when TrueClass:  1
          when '':         nil
          else value
        end
D
Initial  
David Heinemeier Hansson 已提交
1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971
      end

      def query_attribute(attr_name)
        attribute = @attributes[attr_name]
        if attribute.kind_of?(Fixnum) && attribute == 0
          false
        elsif attribute.kind_of?(String) && attribute == "0"
          false
        elsif attribute.kind_of?(String) && attribute.empty?
          false
        elsif attribute.nil?
          false
        elsif attribute == false
          false
        elsif attribute == "f"
          false
        elsif attribute == "false"
          false
        else
          true
        end
      end

      def remove_attributes_protected_from_mass_assignment(attributes)
        if self.class.accessible_attributes.nil? && self.class.protected_attributes.nil?
1972
          attributes.reject { |key, value| attributes_protected_by_default.include?(key.gsub(/\(.+/, "")) }
D
Initial  
David Heinemeier Hansson 已提交
1973
        elsif self.class.protected_attributes.nil?
1974
          attributes.reject { |key, value| !self.class.accessible_attributes.include?(key.gsub(/\(.+/, "").intern) || attributes_protected_by_default.include?(key.gsub(/\(.+/, "")) }
D
Initial  
David Heinemeier Hansson 已提交
1975
        elsif self.class.accessible_attributes.nil?
1976
          attributes.reject { |key, value| self.class.protected_attributes.include?(key.gsub(/\(.+/,"").intern) || attributes_protected_by_default.include?(key.gsub(/\(.+/, "")) }
D
Initial  
David Heinemeier Hansson 已提交
1977 1978 1979
        end
      end

1980 1981
      # The primary key and inheritance column can never be set by mass-assignment for security reasons.
      def attributes_protected_by_default
1982 1983 1984
        default = [ self.class.primary_key, self.class.inheritance_column ]
        default << 'id' unless self.class.primary_key.eql? 'id'
        default
1985 1986
      end

D
Initial  
David Heinemeier Hansson 已提交
1987
      # Returns copy of the attributes hash where all the values have been safely quoted for use in
1988
      # an SQL statement.
1989
      def attributes_with_quotes(include_primary_key = true)
1990
        attributes.inject({}) do |quoted, (name, value)|
1991
          if column = column_for_attribute(name)
1992
            quoted[name] = quote_value(value, column) unless !include_primary_key && column.primary
1993 1994
          end
          quoted
D
Initial  
David Heinemeier Hansson 已提交
1995 1996
        end
      end
1997

D
Initial  
David Heinemeier Hansson 已提交
1998
      # Quote strings appropriately for SQL statements.
1999
      def quote_value(value, column = nil)
2000
        self.class.connection.quote(value, column)
D
Initial  
David Heinemeier Hansson 已提交
2001 2002
      end

2003 2004 2005 2006 2007 2008 2009
      # Deprecated, use quote_value
      def quote(value, column = nil)
        self.class.connection.quote(value, column)
      end
      deprecate :quote
      
      
D
Initial  
David Heinemeier Hansson 已提交
2010 2011 2012
      # Interpolate custom sql string in instance context.
      # Optional record argument is meant for custom insert_sql.
      def interpolate_sql(sql, record = nil)
2013
        instance_eval("%@#{sql.gsub('@', '\@')}@")
D
Initial  
David Heinemeier Hansson 已提交
2014 2015 2016 2017 2018 2019 2020
      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
2021
        self.class.columns.inject({}) do |attributes, column|
2022
          attributes[column.name] = column.default unless column.name == self.class.primary_key
D
Initial  
David Heinemeier Hansson 已提交
2023 2024 2025 2026 2027 2028 2029 2030
          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
2031
      # parentheses to have the parameters typecasted before they're used in the constructor. Use i for Fixnum, f for Float,
D
Initial  
David Heinemeier Hansson 已提交
2032 2033 2034 2035 2036 2037
      # s for String, and a for Array. If all the values for a given attribute is empty, the attribute will be set to nil.
      def assign_multiparameter_attributes(pairs)
        execute_callstack_for_multiparameter_attributes(
          extract_callstack_for_multiparameter_attributes(pairs)
        )
      end
2038

D
Initial  
David Heinemeier Hansson 已提交
2039 2040
      # Includes an ugly hack for Time.local instead of Time.new because the latter is reserved by Time itself.
      def execute_callstack_for_multiparameter_attributes(callstack)
2041
        errors = []
D
Initial  
David Heinemeier Hansson 已提交
2042
        callstack.each do |name, values|
2043
          klass = (self.class.reflect_on_aggregation(name.to_sym) || column_for_attribute(name)).klass
D
Initial  
David Heinemeier Hansson 已提交
2044 2045 2046
          if values.empty?
            send(name + "=", nil)
          else
2047
            begin
2048
              send(name + "=", Time == klass ? (@@default_timezone == :utc ? klass.utc(*values) : klass.local(*values)) : klass.new(*values))
2049 2050 2051
            rescue => ex
              errors << AttributeAssignmentError.new("error on assignment #{values.inspect} to #{name}", ex, name)
            end
D
Initial  
David Heinemeier Hansson 已提交
2052 2053
          end
        end
2054 2055 2056
        unless errors.empty?
          raise MultiparameterAssignmentErrors.new(errors), "#{errors.size} error(s) on assignment of multiparameter attributes"
        end
D
Initial  
David Heinemeier Hansson 已提交
2057
      end
2058

D
Initial  
David Heinemeier Hansson 已提交
2059 2060 2061 2062 2063 2064 2065 2066 2067
      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?
2068
            attributes[attribute_name] <<
2069
              [ find_parameter_position(multiparameter_name), type_cast_attribute_value(multiparameter_name, value) ]
D
Initial  
David Heinemeier Hansson 已提交
2070 2071 2072 2073 2074
          end
        end

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

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

D
Initial  
David Heinemeier Hansson 已提交
2080 2081 2082
      def find_parameter_position(multiparameter_name)
        multiparameter_name.scan(/\(([0-9]*).*\)/).first.first
      end
2083

D
Initial  
David Heinemeier Hansson 已提交
2084 2085 2086 2087 2088 2089
      # 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)
2090 2091 2092
        attributes.keys.collect do |column_name|
          self.class.connection.quote_column_name(column_name)
        end
D
Initial  
David Heinemeier Hansson 已提交
2093 2094
      end

2095 2096 2097 2098
      def quote_columns(quoter, hash)
        hash.inject({}) do |quoted, (name, value)|
          quoted[quoter.quote_column_name(name)] = value
          quoted
2099
        end
D
Initial  
David Heinemeier Hansson 已提交
2100 2101
      end

2102 2103
      def quoted_comma_pair_list(quoter, hash)
        comma_pair_list(quote_columns(quoter, hash))
D
Initial  
David Heinemeier Hansson 已提交
2104 2105 2106
      end

      def object_from_yaml(string)
2107
        return string unless string.is_a?(String)
2108
        YAML::load(string) rescue string
D
Initial  
David Heinemeier Hansson 已提交
2109
      end
2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123

      def clone_attributes(reader_method = :read_attribute, attributes = {})
        self.attribute_names.inject(attributes) do |attributes, name|
          attributes[name] = clone_attribute_value(reader_method, name)
          attributes
        end
      end

      def clone_attribute_value(reader_method, attribute_name)
        value = send(reader_method, attribute_name)
        value.clone
      rescue TypeError, NoMethodError
        value
      end
D
Initial  
David Heinemeier Hansson 已提交
2124
  end
2125
end