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

module ActiveRecord #:nodoc:
  class ActiveRecordError < StandardError #:nodoc:
  end
8 9
  class SubclassNotFound < ActiveRecordError #:nodoc:
  end
D
Initial  
David Heinemeier Hansson 已提交
10 11 12 13 14 15 16 17 18 19 20 21 22 23
  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
24 25
  class RecordNotSaved < ActiveRecordError #:nodoc:
  end
D
Initial  
David Heinemeier Hansson 已提交
26 27
  class StatementInvalid < ActiveRecordError #:nodoc:
  end
28 29
  class PreparedStatementInvalid < ActiveRecordError #:nodoc:
  end
30 31
  class StaleObjectError < ActiveRecordError #:nodoc:
  end
32
  class ConfigurationError < ActiveRecordError #:nodoc:
33
  end
34
  class ReadOnlyRecord < ActiveRecordError #:nodoc:
35
  end
36 37
  class Rollback < ActiveRecordError #:nodoc:
  end
38 39
  class ProtectedAttributeAssignmentError < ActiveRecordError #:nodoc:
  end
40
  class DangerousAttributeError < ActiveRecordError #:nodoc:
41
  end
42

43 44 45 46 47
  # Raised when you've tried to access a column, which wasn't
  # loaded by your finder.  Typically this is because :select
  # has been specified
  class MissingAttributeError < NoMethodError
  end
48

49 50 51 52 53 54 55 56
  class AttributeAssignmentError < ActiveRecordError #:nodoc:
    attr_reader :exception, :attribute
    def initialize(message, exception, attribute)
      @exception = exception
      @attribute = attribute
      @message = message
    end
  end
57

58 59 60 61 62 63
  class MultiparameterAssignmentErrors < ActiveRecordError #:nodoc:
    attr_reader :errors
    def initialize(errors)
      @errors = errors
    end
  end
64

65
  # Active Record objects don't specify their attributes directly, but rather infer them from the table definition with
D
Initial  
David Heinemeier Hansson 已提交
66 67
  # 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
68 69
  # database table will happen automatically in most common cases, but can be overwritten for the uncommon ones.
  #
D
Initial  
David Heinemeier Hansson 已提交
70
  # See the mapping rules in table_name and the full example in link:files/README.html for more insight.
71
  #
D
Initial  
David Heinemeier Hansson 已提交
72
  # == Creation
73
  #
74
  # 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 已提交
75
  # you're receiving the data from somewhere else, like a HTTP request. It works like this:
76
  #
77
  #   user = User.new(:name => "David", :occupation => "Code Artist")
D
Initial  
David Heinemeier Hansson 已提交
78
  #   user.name # => "David"
79
  #
D
Initial  
David Heinemeier Hansson 已提交
80
  # You can also use block initialization:
81
  #
D
Initial  
David Heinemeier Hansson 已提交
82 83 84 85
  #   user = User.new do |u|
  #     u.name = "David"
  #     u.occupation = "Code Artist"
  #   end
86
  #
D
Initial  
David Heinemeier Hansson 已提交
87
  # And of course you can just create a bare object and specify the attributes after the fact:
88
  #
D
Initial  
David Heinemeier Hansson 已提交
89 90 91
  #   user = User.new
  #   user.name = "David"
  #   user.occupation = "Code Artist"
92
  #
D
Initial  
David Heinemeier Hansson 已提交
93
  # == Conditions
94
  #
95
  # Conditions can either be specified as a string, array, or hash representing the WHERE-part of an SQL statement.
D
Initial  
David Heinemeier Hansson 已提交
96
  # The array form is to be used when the condition input is tainted and requires sanitization. The string form can
97
  # be used for statements that don't involve tainted data. The hash form works much like the array form, except
98
  # only equality and range is possible. Examples:
99
  #
100
  #   class User < ActiveRecord::Base
D
Initial  
David Heinemeier Hansson 已提交
101
  #     def self.authenticate_unsafely(user_name, password)
102
  #       find(:first, :conditions => "user_name = '#{user_name}' AND password = '#{password}'")
D
Initial  
David Heinemeier Hansson 已提交
103
  #     end
104
  #
D
Initial  
David Heinemeier Hansson 已提交
105
  #     def self.authenticate_safely(user_name, password)
106
  #       find(:first, :conditions => [ "user_name = ? AND password = ?", user_name, password ])
D
Initial  
David Heinemeier Hansson 已提交
107
  #     end
108 109 110 111
  #
  #     def self.authenticate_safely_simply(user_name, password)
  #       find(:first, :conditions => { :user_name => user_name, :password => password })
  #     end
D
Initial  
David Heinemeier Hansson 已提交
112
  #   end
113
  #
114
  # The <tt>authenticate_unsafely</tt> method inserts the parameters directly into the query and is thus susceptible to SQL-injection
115 116 117
  # 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).
118
  #
119
  # When using multiple parameters in the conditions, it can easily become hard to read exactly what the fourth or fifth
120
  # question mark is supposed to represent. In those cases, you can resort to named bind variables instead. That's done by replacing
121 122
  # the question marks with symbols and supplying a hash with values for the matching symbol keys:
  #
123 124
  #   Company.find(:first, [
  #     "id = :id AND name = :name AND division = :division AND created_at > :accounting_date",
125 126 127
  #     { :id => 3, :name => "37signals", :division => "First", :accounting_date => '2005-01-01' }
  #   ])
  #
128 129 130 131 132 133
  # 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])
  #
134 135 136
  # A range may be used in the hash to use the SQL BETWEEN operator:
  #
  #   Student.find(:all, :conditions => { :grade => 9..12 })
137
  #
D
Initial  
David Heinemeier Hansson 已提交
138
  # == Overwriting default accessors
139
  #
D
Initial  
David Heinemeier Hansson 已提交
140 141 142 143
  # 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:
144
  #
D
Initial  
David Heinemeier Hansson 已提交
145 146
  #   class Song < ActiveRecord::Base
  #     # Uses an integer of seconds to hold the length of the song
147
  #
D
Initial  
David Heinemeier Hansson 已提交
148
  #     def length=(minutes)
149
  #       write_attribute(:length, minutes * 60)
D
Initial  
David Heinemeier Hansson 已提交
150
  #     end
151
  #
D
Initial  
David Heinemeier Hansson 已提交
152
  #     def length
153
  #       read_attribute(:length) / 60
D
Initial  
David Heinemeier Hansson 已提交
154 155
  #     end
  #   end
156
  #
157
  # You can alternatively use self[:attribute]=(value) and self[:attribute] instead of write_attribute(:attribute, value) and
158 159
  # read_attribute(:attribute) as a shorter form.
  #
160
  # == Accessing attributes before they have been typecasted
161
  #
162
  # Sometimes you want to be able to read the raw attribute data without having the column-determined typecast run its course first.
163
  # That can be done by using the <attribute>_before_type_cast accessors that all attributes have. For example, if your Account model
164
  # has a balance attribute, you can call account.balance_before_type_cast or account.id_before_type_cast.
165 166
  #
  # This is especially useful in validation situations where the user might supply a string for an integer field and you want to display
167
  # the original string back in an error message. Accessing the attribute normally would typecast the string to 0, which isn't what you
168 169
  # want.
  #
170 171
  # == Dynamic attribute-based finders
  #
172
  # Dynamic attribute-based finders are a cleaner way of getting (and/or creating) objects by simple queries without turning to SQL. They work by
173
  # 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,
174 175
  # 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>.
176
  # 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>.
177
  #
178 179
  # 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
180
  # <tt>Person.find(:first, ["user_name = ? AND password = ?", user_name, password])</tt>, you just do
181
  # <tt>Person.find_by_user_name_and_password(user_name, password)</tt>.
182
  #
183 184 185
  # 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>.
186
  #
187 188 189 190 191 192 193 194 195
  # 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")
  #
196 197 198 199
  # 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")
200
  #   winter.new_record? # true
201
  #
202 203 204 205 206 207 208
  # To find by a subset of the attributes to be used for instantiating a new object, pass a hash instead of
  # a list of parameters. For example:
  #
  #   Tag.find_or_create_by_name(:name => "rails", :creator => current_user)
  #
  # That will either find an existing tag named "rails", or create a new one while setting the user that created it.
  #
209
  # == Saving arrays, hashes, and other non-mappable objects in text columns
210 211
  #
  # 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+.
212
  # This makes it possible to store arrays, hashes, and other non-mappable objects without doing any additional work. Example:
213
  #
D
Initial  
David Heinemeier Hansson 已提交
214 215 216
  #   class User < ActiveRecord::Base
  #     serialize :preferences
  #   end
217
  #
218
  #   user = User.create(:preferences => { "background" => "black", "display" => large })
D
Initial  
David Heinemeier Hansson 已提交
219
  #   User.find(user.id).preferences # => { "background" => "black", "display" => large }
220
  #
221
  # 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 已提交
222
  # descendent of a class not in the hierarchy. Example:
223
  #
D
Initial  
David Heinemeier Hansson 已提交
224
  #   class User < ActiveRecord::Base
225
  #     serialize :preferences, Hash
D
Initial  
David Heinemeier Hansson 已提交
226
  #   end
227
  #
228
  #   user = User.create(:preferences => %w( one two three ))
D
Initial  
David Heinemeier Hansson 已提交
229
  #   User.find(user.id).preferences    # raises SerializationTypeMismatch
230
  #
D
Initial  
David Heinemeier Hansson 已提交
231 232
  # == Single table inheritance
  #
233
  # 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 已提交
234 235 236 237 238 239 240
  # 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
  #
241 242
  # 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 已提交
243
  #
244 245 246
  # 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 已提交
247 248
  # Note, all the attributes for all the cases are kept in the same table. Read more:
  # http://www.martinfowler.com/eaaCatalog/singleTableInheritance.html
249
  #
D
Initial  
David Heinemeier Hansson 已提交
250 251 252
  # == Connection to multiple databases in different models
  #
  # Connections are usually created through ActiveRecord::Base.establish_connection and retrieved by ActiveRecord::Base.connection.
253
  # All classes inheriting from ActiveRecord::Base will use this connection. But you can also set a class-specific connection.
D
Initial  
David Heinemeier Hansson 已提交
254 255 256 257 258 259 260
  # 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
261
  #
D
Initial  
David Heinemeier Hansson 已提交
262
  # * +ActiveRecordError+ -- generic error class and superclass of all other errors raised by Active Record
263
  # * +AdapterNotSpecified+ -- the configuration hash used in <tt>establish_connection</tt> didn't include a
D
Initial  
David Heinemeier Hansson 已提交
264
  #   <tt>:adapter</tt> key.
265
  # * +AdapterNotFound+ -- the <tt>:adapter</tt> key used in <tt>establish_connection</tt> specified an non-existent adapter
266 267 268
  #   (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 已提交
269
  # * +ConnectionNotEstablished+ -- no connection has been established. Use <tt>establish_connection</tt> before querying.
270
  # * +RecordNotFound+ -- no record responded to the find* method.
D
Initial  
David Heinemeier Hansson 已提交
271 272 273
  #   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.
274 275
  # * +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+
276 277 278
  #   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.
279
  #
280
  # *Note*: The attributes listed are class-level attributes (accessible from both the class and instance level).
D
Initial  
David Heinemeier Hansson 已提交
281 282 283 284 285
  # 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+.
286
    cattr_accessor :logger, :instance_writer => false
J
Jeremy Kemper 已提交
287

D
Initial  
David Heinemeier Hansson 已提交
288 289 290 291 292
    def self.inherited(child) #:nodoc:
      @@subclasses[self] ||= []
      @@subclasses[self] << child
      super
    end
J
Jeremy Kemper 已提交
293

D
David Heinemeier Hansson 已提交
294
    def self.reset_subclasses #:nodoc:
295
      nonreloadables = []
296
      subclasses.each do |klass|
297
        unless Dependencies.autoloaded? klass
298 299 300
          nonreloadables << klass
          next
        end
301 302 303
        klass.instance_variables.each { |var| klass.send(:remove_instance_variable, var) }
        klass.instance_methods(false).each { |m| klass.send :undef_method, m }
      end
304 305
      @@subclasses = {}
      nonreloadables.each { |klass| (@@subclasses[klass.superclass] ||= []) << klass }
306 307
    end

D
Initial  
David Heinemeier Hansson 已提交
308
    @@subclasses = {}
309

310
    cattr_accessor :configurations, :instance_writer => false
311 312
    @@configurations = {}

313
    # 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 已提交
314 315
    # :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
316
    # that this is a global setting for all Active Records.
317
    cattr_accessor :primary_key_prefix_type, :instance_writer => false
D
Initial  
David Heinemeier Hansson 已提交
318 319
    @@primary_key_prefix_type = nil

320
    # Accessor for the name of the prefix string to prepend to every table name. So if set to "basecamp_", all
321
    # 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 已提交
322
    # for tables in a shared database. By default, the prefix is the empty string.
323
    cattr_accessor :table_name_prefix, :instance_writer => false
D
Initial  
David Heinemeier Hansson 已提交
324 325 326 327
    @@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.
328
    cattr_accessor :table_name_suffix, :instance_writer => false
D
Initial  
David Heinemeier Hansson 已提交
329 330
    @@table_name_suffix = ""

331
    # Indicates whether table names should be the pluralized versions of the corresponding class names.
332
    # 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 已提交
333
    # See table_name for the full rules on table/class naming. This is true, by default.
334
    cattr_accessor :pluralize_table_names, :instance_writer => false
D
Initial  
David Heinemeier Hansson 已提交
335 336
    @@pluralize_table_names = true

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

343 344
    # 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.
345
    cattr_accessor :default_timezone, :instance_writer => false
346
    @@default_timezone = :local
347

348
    # Determines whether to use a connection for each thread, or a single shared connection for all threads.
349
    # Defaults to false. Set to true if you're writing a threaded application.
350
    cattr_accessor :allow_concurrency, :instance_writer => false
351
    @@allow_concurrency = false
352

353 354 355 356 357 358
    # 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.
359
    cattr_accessor :schema_format , :instance_writer => false
360
    @@schema_format = :ruby
361

362 363 364 365 366
    # Determines whether to raise an exception on mass-assignment to protected
    # attribute. Defaults to true.
    cattr_accessor :whiny_protected_attributes, :instance_writer => false
    @@whiny_protected_attributes = true

D
Initial  
David Heinemeier Hansson 已提交
367
    class << self # Class methods
368
      # Find operates with three different retrieval approaches:
369 370 371 372 373
      #
      # * 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.
374
      # * Find all: This will return all the records matched by the options used. If no records are found, an empty array is returned.
375
      #
376
      # All approaches accept an option hash as their last parameter. The options are:
377
      #
378 379
      # * <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".
380
      # * <tt>:group</tt>: An attribute name by which the result should be grouped. Uses the GROUP BY SQL-clause.
381
      # * <tt>:limit</tt>: An integer determining the limit on the number of rows that should be returned.
382
      # * <tt>:offset</tt>: An integer determining the offset from where the rows should be fetched. So at 5, it would skip rows 0 through 4.
383
      # * <tt>:joins</tt>: An SQL fragment for additional joins like "LEFT JOIN comments ON comments.post_id = id". (Rarely needed).
384
      #   The records will be returned read-only since they will have attributes that do not correspond to the table's columns.
385
      #   Pass :readonly => false to override.
386 387
      # * <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.
388 389
      # * <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.
390 391
      # * <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). 
392
      # * <tt>:readonly</tt>: Mark the returned records read-only so they cannot be saved or updated.
393 394
      # * <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".
395
      #
396
      # Examples for find by id:
D
Initial  
David Heinemeier Hansson 已提交
397 398 399
      #   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)
400
      #   Person.find([1])     # returns an array for objects the object with ID = 1
401 402
      #   Person.find(1, :conditions => "administrator = 1", :order => "created_on DESC")
      #
403 404 405 406
      # Note that returned records may not be in the same order as the ids you
      # provide since database rows are unordered. Give an explicit :order
      # to ensure the results are sorted.
      #
407
      # Examples for find first:
408
      #   Person.find(:first) # returns the first object fetched by SELECT * FROM people
409 410 411 412
      #   Person.find(:first, :conditions => [ "user_name = ?", user_name])
      #   Person.find(:first, :order => "created_on DESC", :offset => 5)
      #
      # Examples for find all:
413
      #   Person.find(:all) # returns an array of objects for all the rows fetched by SELECT * FROM people
414 415 416
      #   Person.find(:all, :conditions => [ "category IN (?)", categories], :limit => 50)
      #   Person.find(:all, :offset => 10, :limit => 10)
      #   Person.find(:all, :include => [ :account, :friends ])
417
      #   Person.find(:all, :group => "category")
418 419 420 421 422 423 424 425 426 427 428
      #
      # 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
429
      def find(*args)
430
        options = args.extract_options!
431 432
        validate_find_options(options)
        set_readonly_option!(options)
433

434
        case args.first
435 436 437
          when :first then find_initial(options)
          when :all   then find_every(options)
          else             find_from_ids(args, options)
D
Initial  
David Heinemeier Hansson 已提交
438 439
        end
      end
440
      
441
      # Works like find(:all), but requires a complete SQL string. Examples:
D
Initial  
David Heinemeier Hansson 已提交
442
      #   Post.find_by_sql "SELECT p.*, c.author FROM posts p, comments c WHERE p.id = c.post_id"
443
      #   Post.find_by_sql ["SELECT * FROM posts WHERE author = ? AND created > ?", author_id, start_date]
D
Initial  
David Heinemeier Hansson 已提交
444
      def find_by_sql(sql)
445
        connection.select_all(sanitize_sql(sql), "#{name} Load").collect! { |record| instantiate(record) }
D
Initial  
David Heinemeier Hansson 已提交
446
      end
447

448
      # Returns true if the given +id+ represents the primary key of a record in the database, false otherwise.
449
      # You can also pass a set of SQL conditions. 
450 451
      # Example:
      #   Person.exists?(5)
452
      #   Person.exists?('5')
453
      #   Person.exists?(:name => "David")
454 455
      #   Person.exists?(['name LIKE ?', "%#{query}%"])
      def exists?(id_or_conditions)
456
        !find(:first, :select => "#{table_name}.#{primary_key}", :conditions => expand_id_conditions(id_or_conditions)).nil?
457 458
      rescue ActiveRecord::ActiveRecordError
        false
D
Initial  
David Heinemeier Hansson 已提交
459
      end
460

D
Initial  
David Heinemeier Hansson 已提交
461
      # Creates an object, instantly saves it as a record (if the validation permits it), and returns it. If the save
462
      # fails under validations, the unsaved object is still returned.
D
Initial  
David Heinemeier Hansson 已提交
463
      def create(attributes = nil)
464 465 466 467 468 469 470
        if attributes.is_a?(Array)
          attributes.collect { |attr| create(attr) }
        else
          object = new(attributes)
          object.save
          object
        end
D
Initial  
David Heinemeier Hansson 已提交
471 472
      end

473
      # Finds the record from the passed +id+, instantly saves it with the passed +attributes+ (if the validation permits it),
474
      # and returns it. If the save fails under validations, the unsaved object is still returned.
475 476 477 478 479 480 481 482 483 484
      #
      # 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 已提交
485
      def update(id, attributes)
486 487 488 489 490 491 492 493
        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 已提交
494 495
      end

496 497
      # Deletes the record with the given +id+ without instantiating an object first. If an array of ids is provided, all of them
      # are deleted.
498
      def delete(id)
499
        delete_all([ "#{connection.quote_column_name(primary_key)} IN (?)", id ])
500
      end
501

502
      # Destroys the record with the given +id+ by instantiating the object and calling #destroy (all the callbacks are the triggered).
503
      # If an array of ids is provided, all of them are destroyed.
504
      def destroy(id)
505
        id.is_a?(Array) ? id.each { |id| destroy(id) } : find(id).destroy
506 507
      end

508
      # Updates all records with the SET-part of an SQL update statement in +updates+ and returns an integer with the number of rows updated.
509
      # A subset of the records can be selected by specifying +conditions+. Example:
D
Initial  
David Heinemeier Hansson 已提交
510
      #   Billing.update_all "category = 'authorized', approved = 1", "author = 'David'"
511 512 513 514
      #
      # Optional :order and :limit options may be given as the third parameter,
      # but their behavior is database-specific.
      def update_all(updates, conditions = nil, options = {})
515
        sql  = "UPDATE #{table_name} SET #{sanitize_sql_for_assignment(updates)} "
516 517 518 519
        scope = scope(:find)
        add_conditions!(sql, conditions, scope)
        add_order!(sql, options[:order], scope)
        add_limit!(sql, options, scope)
520
        connection.update(sql, "#{name} Update")
D
Initial  
David Heinemeier Hansson 已提交
521
      end
522

523
      # Destroys the objects for all the records that match the +condition+ by instantiating each object and calling
D
Initial  
David Heinemeier Hansson 已提交
524 525 526
      # the destroy method. Example:
      #   Person.destroy_all "last_login < '2004-04-04'"
      def destroy_all(conditions = nil)
527
        find(:all, :conditions => conditions).each { |object| object.destroy }
D
Initial  
David Heinemeier Hansson 已提交
528
      end
529

530
      # Deletes all the records that match the +condition+ without instantiating the objects first (and hence not
D
Initial  
David Heinemeier Hansson 已提交
531
      # calling the destroy method). Example:
532
      #   Post.delete_all "person_id = 5 AND (category = 'Something' OR category = 'Else')"
D
Initial  
David Heinemeier Hansson 已提交
533 534
      def delete_all(conditions = nil)
        sql = "DELETE FROM #{table_name} "
535
        add_conditions!(sql, conditions, scope(:find))
D
Initial  
David Heinemeier Hansson 已提交
536 537 538 539
        connection.delete(sql, "#{name} Delete all")
      end

      # Returns the result of an SQL statement that should only include a COUNT(*) in the SELECT part.
540 541 542 543 544 545 546 547 548
      # The use of this method should be restricted to complicated SQL queries that can't be executed 
      # using the ActiveRecord::Calculations class methods.  Look into those before using this.
      #
      # ==== Options
      # 
      # +sql+: An SQL statement which should return a count query from the database, see the example below
      #
      # ==== Examples
      #
549
      #   Product.count_by_sql "SELECT COUNT(*) FROM sales s, customers c WHERE s.customer_id = c.id"
D
Initial  
David Heinemeier Hansson 已提交
550
      def count_by_sql(sql)
551
        sql = sanitize_conditions(sql)
552
        connection.select_value(sql, "#{name} Count").to_i
D
Initial  
David Heinemeier Hansson 已提交
553
      end
554

555 556 557 558 559 560 561 562 563 564 565 566 567 568
      # A generic "counter updater" implementation, intended primarily to be
      # used by increment_counter and decrement_counter, but which may also
      # be useful on its own. It simply does a direct SQL update for the record
      # with the given ID, altering the given hash of counters by the amount
      # given by the corresponding value:
      #
      #   Post.update_counters 5, :comment_count => -1, :action_count => 1
      #   # UPDATE posts
      #   #    SET comment_count = comment_count - 1,
      #   #        action_count = action_count + 1
      #   #  WHERE id = 5
      def update_counters(id, counters)
        updates = counters.inject([]) { |list, (counter_name, increment)|
          sign = increment < 0 ? "-" : "+"
569
          list << "#{connection.quote_column_name(counter_name)} = #{connection.quote_column_name(counter_name)} #{sign} #{increment.abs}"
570
        }.join(", ")
571
        update_all(updates, "#{connection.quote_column_name(primary_key)} = #{quote_value(id)}")
572 573
      end

574 575 576 577 578 579 580 581 582 583 584 585 586 587 588
      # Increment a number field by one, usually representing a count.
      #
      # This is used for caching aggregate values, so that they don't need to be computed every time. 
      # For example, a DiscussionBoard may cache post_count and comment_count otherwise every time the board is 
      # shown it would have to run a SQL query to find how many posts and comments there are.
      #
      # ==== Options
      #
      # +counter_name+  The name of the field that should be incremented
      # +id+            The id of the object that should be incremented
      #
      # ==== Examples
      #
      #   # Increment the post_count column for the record with an id of 5
      #   DiscussionBoard.increment_counter(:post_count, 5)
D
Initial  
David Heinemeier Hansson 已提交
589
      def increment_counter(counter_name, id)
590
        update_counters(id, counter_name => 1)
D
Initial  
David Heinemeier Hansson 已提交
591 592
      end

593 594 595 596 597 598 599 600 601 602 603 604 605
      # Decrement a number field by one, usually representing a count.
      #
      # This works the same as increment_counter but reduces the column value by 1 instead of increasing it.
      #
      # ==== Options
      #
      # +counter_name+  The name of the field that should be decremented
      # +id+            The id of the object that should be decremented
      #
      # ==== Examples
      #
      #   # Decrement the post_count column for the record with an id of 5
      #   DiscussionBoard.decrement_counter(:post_count, 5)
D
Initial  
David Heinemeier Hansson 已提交
606
      def decrement_counter(counter_name, id)
607
        update_counters(id, counter_name => -1)
D
Initial  
David Heinemeier Hansson 已提交
608 609
      end

D
David Heinemeier Hansson 已提交
610

611
      # Attributes named in this macro are protected from mass-assignment, such as <tt>new(attributes)</tt> and
D
Initial  
David Heinemeier Hansson 已提交
612
      # <tt>attributes=(attributes)</tt>. Their assignment will simply be ignored. Instead, you can use the direct writer
613
      # methods to do assignment. This is meant to protect sensitive attributes from being overwritten by URL/form hackers. Example:
D
Initial  
David Heinemeier Hansson 已提交
614 615 616 617 618 619 620 621 622 623 624 625 626
      #
      #   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)
627
        write_inheritable_array("attr_protected", attributes - (protected_attributes || []))
D
Initial  
David Heinemeier Hansson 已提交
628
      end
629

630
      # Returns an array of all the attributes that have been protected from mass-assignment.
D
Initial  
David Heinemeier Hansson 已提交
631 632 633 634
      def protected_attributes # :nodoc:
        read_inheritable_attribute("attr_protected")
      end

635
      # If this macro is used, only those attributes named in it will be accessible for mass-assignment, such as
D
Initial  
David Heinemeier Hansson 已提交
636 637 638 639
      # <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)
640
        write_inheritable_array("attr_accessible", attributes - (accessible_attributes || []))
D
Initial  
David Heinemeier Hansson 已提交
641
      end
642

643
      # Returns an array of all the attributes that have been made accessible to mass-assignment.
D
Initial  
David Heinemeier Hansson 已提交
644 645 646 647
      def accessible_attributes # :nodoc:
        read_inheritable_attribute("attr_accessible")
      end

648 649 650 651 652 653 654 655 656
       # Attributes listed as readonly can be set for a new record, but will be ignored in database updates afterwards.
       def attr_readonly(*attributes)
         write_inheritable_array("attr_readonly", attributes - (readonly_attributes || []))
       end

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

D
David Heinemeier Hansson 已提交
658 659 660 661 662 663 664 665 666 667 668 669 670 671 672
      # If you have an attribute that needs to be saved to the database as an object, and retrieved as the same object, 
      # then specify the name of that attribute using this method and it will be handled automatically.  
      # The serialization is done through YAML. If +class_name+ is specified, the serialized object must be of that 
      # class on retrieval or +SerializationTypeMismatch+ will be raised.
      #
      # ==== Options
      #
      # +attr_name+   The field name that should be serialized
      # +class_name+  Optional, class name that the object should be equal to
      #
      # ==== Example
      #   # Serialize a preferences attribute
      #   class User
      #     serialize :preferences
      #   end
D
Initial  
David Heinemeier Hansson 已提交
673
      def serialize(attr_name, class_name = Object)
674
        serialized_attributes[attr_name.to_s] = class_name
D
Initial  
David Heinemeier Hansson 已提交
675
      end
676

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

D
David Heinemeier Hansson 已提交
682

D
Initial  
David Heinemeier Hansson 已提交
683 684
      # 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
685 686
      # 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 已提交
687
      #
688 689 690 691 692
      # 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 已提交
693
      #
694 695 696 697 698 699 700
      # 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 已提交
701 702
      #
      #   class Mouse < ActiveRecord::Base
703
      #     set_table_name "mice"
D
Initial  
David Heinemeier Hansson 已提交
704
      #   end
705
      def table_name
706 707 708
        reset_table_name
      end

D
David Heinemeier Hansson 已提交
709
      def reset_table_name #:nodoc:
710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725
        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 已提交
726
        set_table_name(name)
727
        name
D
Initial  
David Heinemeier Hansson 已提交
728 729
      end

730
      # Defines the primary key field -- can be overridden in subclasses. Overwriting will negate any effect of the
D
Initial  
David Heinemeier Hansson 已提交
731 732
      # primary_key_prefix_type setting, though.
      def primary_key
733 734 735
        reset_primary_key
      end

D
David Heinemeier Hansson 已提交
736
      def reset_primary_key #:nodoc:
737
        key = 'id'
D
Initial  
David Heinemeier Hansson 已提交
738 739
        case primary_key_prefix_type
          when :table_name
740
            key = Inflector.foreign_key(base_class.name, false)
D
Initial  
David Heinemeier Hansson 已提交
741
          when :table_name_with_underscore
742
            key = Inflector.foreign_key(base_class.name)
D
Initial  
David Heinemeier Hansson 已提交
743
        end
744 745
        set_primary_key(key)
        key
D
Initial  
David Heinemeier Hansson 已提交
746 747
      end

748 749
      # Defines the column name for use with single table inheritance
      # -- can be set in subclasses like so: self.inheritance_column = "type_id"
D
Initial  
David Heinemeier Hansson 已提交
750
      def inheritance_column
751
        @inheritance_column ||= "type".freeze
D
Initial  
David Heinemeier Hansson 已提交
752 753
      end

754 755
      # 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 已提交
756
      def sequence_name #:nodoc:
757 758 759
        reset_sequence_name
      end

D
David Heinemeier Hansson 已提交
760
      def reset_sequence_name #:nodoc:
761 762 763
        default = connection.default_sequence_name(table_name, primary_key)
        set_sequence_name(default)
        default
764 765
      end

766
      # Sets the table name to use to the given value, or (if the value
767
      # is nil or false) to the value returned by the given block.
768 769 770 771 772 773
      #
      # Example:
      #
      #   class Project < ActiveRecord::Base
      #     set_table_name "project"
      #   end
774
      def set_table_name(value = nil, &block)
775 776 777 778 779 780
        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
781
      # block.
782 783 784 785 786 787
      #
      # Example:
      #
      #   class Project < ActiveRecord::Base
      #     set_primary_key "sysid"
      #   end
788
      def set_primary_key(value = nil, &block)
789 790 791 792 793 794
        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
795
      # given block.
796 797 798 799 800 801 802 803
      #
      # Example:
      #
      #   class Project < ActiveRecord::Base
      #     set_inheritance_column do
      #       original_inheritance_column + "_id"
      #     end
      #   end
804
      def set_inheritance_column(value = nil, &block)
805 806 807 808
        define_attr_method :inheritance_column, value, &block
      end
      alias :inheritance_column= :set_inheritance_column

809 810
      # 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
811 812
      # given block. This is required for Oracle and is useful for any
      # database which relies on sequences for primary key generation.
813
      #
814 815 816 817 818
      # 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.
819 820 821 822 823 824
      #
      # Example:
      #
      #   class Project < ActiveRecord::Base
      #     set_sequence_name "projectseq"   # default would have been "project_seq"
      #   end
825
      def set_sequence_name(value = nil, &block)
826 827 828 829
        define_attr_method :sequence_name, value, &block
      end
      alias :sequence_name= :set_sequence_name

D
Initial  
David Heinemeier Hansson 已提交
830 831 832
      # 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
833 834 835
        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 已提交
836 837
      end

838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853
      # 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 已提交
854 855
      # Returns an array of column objects for the table associated with this class.
      def columns
856 857 858 859 860
        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 已提交
861
      end
862

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

D
David Heinemeier Hansson 已提交
868
      # Returns an array of column names as strings.
869
      def column_names
870
        @column_names ||= columns.map { |column| column.name }
871
      end
D
Initial  
David Heinemeier Hansson 已提交
872

873 874
      # 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 已提交
875
      def content_columns
876
        @content_columns ||= columns.reject { |c| c.primary || c.name =~ /(_id|_count)$/ || c.name == inheritance_column }
D
Initial  
David Heinemeier Hansson 已提交
877 878 879 880
      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
881
      # is available.
D
David Heinemeier Hansson 已提交
882
      def column_methods_hash #:nodoc:
883
        @dynamic_methods_hash ||= column_names.inject(Hash.new(false)) do |methods, attr|
884 885 886 887 888
          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 已提交
889 890 891
          methods
        end
      end
892

893
      # Resets all the cached information about columns, which will cause them to be reloaded on the next request.
894
      def reset_column_information
895 896
        generated_methods.each { |name| undef_method(name) }
        @column_names = @columns = @columns_hash = @content_columns = @dynamic_methods_hash = @generated_methods = @inheritance_column = nil
897 898
      end

899
      def reset_column_information_and_inheritable_attributes_for_all_subclasses#:nodoc:
900 901
        subclasses.each { |klass| klass.reset_inheritable_attributes; klass.reset_column_information }
      end
D
Initial  
David Heinemeier Hansson 已提交
902 903 904

      # 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"
905 906
      # Deprecated in favor of just calling "first_name".humanize
      def human_attribute_name(attribute_key_name) #:nodoc:
907
        attribute_key_name.humanize
D
Initial  
David Heinemeier Hansson 已提交
908
      end
909

910 911 912 913 914 915 916
      # True if this isn't a concrete subclass needing a STI type condition.
      def descends_from_active_record?
        if superclass.abstract_class?
          superclass.descends_from_active_record?
        else
          superclass == Base || !columns_hash.include?(inheritance_column)
        end
D
Initial  
David Heinemeier Hansson 已提交
917 918
      end

919 920 921 922 923
      def finder_needs_type_condition? #:nodoc:
        # This is like this because benchmarking justifies the strange :false stuff
        :true == (@finder_needs_type_condition ||= descends_from_active_record? ? :false : :true)
      end

924
      # Returns a string like 'Post id:integer, title:string, body:text'
925
      def inspect
926 927 928 929
        if self == Base
          super
        elsif abstract_class?
          "#{super}(abstract)"
930
        elsif table_exists?
931 932
          attr_list = columns.map { |c| "#{c.name}: #{c.type}" } * ', '
          "#{super}(#{attr_list})"
933 934
        else
          "#{super}(Table doesn't exist)"
935
        end
936 937
      end

938 939

      def quote_value(value, column = nil) #:nodoc:
940
        connection.quote(value,column)
941 942 943
      end

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

948
      # Log and benchmark multiple statements in a single block. Example:
D
Initial  
David Heinemeier Hansson 已提交
949 950 951 952
      #
      #   Project.benchmark("Creating project") do
      #     project = Project.create("name" => "stuff")
      #     project.create_manager("name" => "David")
953
      #     project.milestones << Milestone.find(:all)
D
Initial  
David Heinemeier Hansson 已提交
954
      #   end
955
      #
956 957 958 959
      # 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.
      #
960
      # The logging of the multiple statements is turned off unless <tt>use_silence</tt> is set to false.
961 962
      def benchmark(title, log_level = Logger::DEBUG, use_silence = true)
        if logger && logger.level == log_level
963 964
          result = nil
          seconds = Benchmark.realtime { result = use_silence ? silence { yield } : yield }
965
          logger.add(log_level, "#{title} (#{'%.5f' % seconds})")
966 967 968 969
          result
        else
          yield
        end
970
      end
971

972 973
      # Silences the logger for the duration of the block.
      def silence
974 975 976
        old_logger_level, logger.level = logger.level, Logger::ERROR if logger
        yield
      ensure
977
        logger.level = old_logger_level if logger
D
Initial  
David Heinemeier Hansson 已提交
978
      end
979

980 981 982
      # Overwrite the default class equality method to provide support for association proxies.
      def ===(object)
        object.is_a?(self)
983
      end      
984

985 986 987 988 989 990 991
      # 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

992 993 994 995 996 997 998 999 1000
      # 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 已提交
1001
      private
1002 1003 1004 1005
        def find_initial(options)
          options.update(:limit => 1) unless options[:include]
          find_every(options).first
        end
1006

1007 1008 1009 1010 1011 1012 1013 1014 1015
        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
1016

1017
        def find_from_ids(ids, options)
1018
          expects_array = ids.first.kind_of?(Array)
1019
          return ids.first if expects_array && ids.first.empty?
1020

1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035
          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]
1036
          options.update :conditions => "#{table_name}.#{connection.quote_column_name(primary_key)} = #{quote_value(id,columns_hash[primary_key])}#{conditions}"
1037

1038 1039 1040 1041
          # 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
1042 1043 1044 1045 1046 1047 1048 1049
            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]
1050
          ids_list   = ids.map { |id| quote_value(id,columns_hash[primary_key]) }.join(',')
1051
          options.update :conditions => "#{table_name}.#{connection.quote_column_name(primary_key)} IN (#{ids_list})#{conditions}"
1052 1053 1054

          result = find_every(options)

1055
          # Determine expected size from limit and offset, not just ids.size.
1056 1057 1058 1059 1060 1061
          expected_size =
            if options[:limit] && ids.size > options[:limit]
              options[:limit]
            else
              ids.size
            end
1062 1063 1064 1065 1066

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

          if result.size == expected_size
1069 1070
            result
          else
1071
            raise RecordNotFound, "Couldn't find all #{name.pluralize} with IDs (#{ids_list})#{conditions} (found #{result.size} results, but was looking for #{expected_size})"
1072 1073 1074
          end
        end

1075 1076 1077
        # 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 已提交
1078
        def instantiate(record)
1079
          object =
1080
            if subclass_name = record[inheritance_column]
1081
              # No type given.
1082 1083
              if subclass_name.empty?
                allocate
1084

1085
              else
1086 1087
                # Ignore type if no column is present since it was probably
                # pulled in from a sloppy join.
1088
                unless columns_hash.include?(inheritance_column)
1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100
                  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
1101 1102 1103 1104
                end
              end
            else
              allocate
1105
            end
1106

D
Initial  
David Heinemeier Hansson 已提交
1107
          object.instance_variable_set("@attributes", record)
1108
          object.instance_variable_set("@attributes_cache", Hash.new)
1109 1110 1111 1112 1113 1114 1115 1116 1117

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

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

1118
          object
D
Initial  
David Heinemeier Hansson 已提交
1119
        end
1120

1121 1122
        # 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 已提交
1123
        def type_name_with_module(type_name)
1124
          (/^::/ =~ type_name) ? type_name : "#{parent.name}::#{type_name}"
D
Initial  
David Heinemeier Hansson 已提交
1125 1126
        end

1127
        def construct_finder_sql(options)
1128
          scope = scope(:find)
1129
          sql  = "SELECT #{(scope && scope[:select]) || options[:select] || (options[:joins] && table_name + '.*') || '*'} "
1130
          sql << "FROM #{(scope && scope[:from]) || options[:from] || table_name} "
1131

1132 1133
          add_joins!(sql, options, scope)
          add_conditions!(sql, options[:conditions], scope)
1134

1135
          add_group!(sql, options[:group], scope)
1136
          add_order!(sql, options[:order], scope)
1137
          add_limit!(sql, options, scope)
1138
          add_lock!(sql, options, scope)
1139

1140
          sql
1141
        end
1142

1143 1144
        # Merges includes so that the result is a valid +include+
        def merge_includes(first, second)
1145
         (safe_to_array(first) + safe_to_array(second)).uniq
1146 1147
        end

1148
        # Object#to_a is deprecated, though it does have the desired behavior
1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159
        def safe_to_array(o)
          case o
          when NilClass
            []
          when Array
            o
          else
            [o]
          end
        end

1160 1161 1162
        def add_order!(sql, order, scope = :auto)
          scope = scope(:find) if :auto == scope
          scoped_order = scope[:order] if scope
1163 1164
          if order
            sql << " ORDER BY #{order}"
1165
            sql << ", #{scoped_order}" if scoped_order
1166
          else
1167
            sql << " ORDER BY #{scoped_order}" if scoped_order
1168 1169
          end
        end
1170

1171
        def add_group!(sql, group, scope = :auto)
1172 1173
          if group
            sql << " GROUP BY #{group}"
1174 1175 1176 1177 1178 1179
          else
            scope = scope(:find) if :auto == scope
            if scope && (scoped_group = scope[:group])
              sql << " GROUP BY #{scoped_group}"
            end
          end
1180
        end
1181

1182
        # The optional scope argument is for the current :find scope.
1183 1184
        def add_limit!(sql, options, scope = :auto)
          scope = scope(:find) if :auto == scope
1185 1186 1187 1188 1189 1190

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

1191
          connection.add_limit_offset!(sql, options)
1192
        end
1193

1194 1195 1196
        # 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)
1197
          scope = scope(:find) if :auto == scope
1198 1199 1200 1201
          options = options.reverse_merge(:lock => scope[:lock]) if scope
          connection.add_lock!(sql, options)
        end

1202
        # The optional scope argument is for the current :find scope.
1203 1204
        def add_joins!(sql, options, scope = :auto)
          scope = scope(:find) if :auto == scope
1205
          join = (scope && scope[:joins]) || options[:joins]
1206 1207
          sql << " #{join} " if join
        end
1208

1209
        # Adds a sanitized version of +conditions+ to the +sql+ string. Note that the passed-in +sql+ string is changed.
1210
        # The optional scope argument is for the current :find scope.
1211 1212
        def add_conditions!(sql, conditions, scope = :auto)
          scope = scope(:find) if :auto == scope
1213
          segments = []
1214 1215
          segments << sanitize_sql(scope[:conditions]) if scope && !scope[:conditions].blank?
          segments << sanitize_sql(conditions) unless conditions.blank?
1216 1217 1218
          segments << type_condition if finder_needs_type_condition?
          segments.delete_if{|s| s.blank?}
          sql << "WHERE (#{segments.join(") AND (")}) " unless segments.empty?
D
Initial  
David Heinemeier Hansson 已提交
1219
        end
1220

D
Initial  
David Heinemeier Hansson 已提交
1221
        def type_condition
1222 1223 1224
          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}' "
1225
          end
1226 1227

          " (#{type_condition}) "
D
Initial  
David Heinemeier Hansson 已提交
1228 1229 1230
        end

        # Guesses the table name, but does not decorate it with prefix and suffix information.
1231
        def undecorated_table_name(class_name = base_class.name)
D
Initial  
David Heinemeier Hansson 已提交
1232 1233
          table_name = Inflector.underscore(Inflector.demodulize(class_name))
          table_name = Inflector.pluralize(table_name) if pluralize_table_names
1234
          table_name
D
Initial  
David Heinemeier Hansson 已提交
1235 1236
        end

1237 1238
        # 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])
1239
        # respectively. Also works for find(:all), but using find_all_by_amount(50) that are turned into find(:all, :conditions => ["amount = ?", 50]).
1240
        #
1241 1242
        # 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).
1243 1244 1245
        #
        # This also enables you to initialize a record if it is not found, such as find_or_initialize_by_amount(amount) 
        # or find_or_create_by_user_and_password(user, password).
1246 1247 1248
        #
        # Each dynamic finder or initializer/creator is also defined in the class after it is first invoked, so that future
        # attempts to use it do not run through method_missing.
1249
        def method_missing(method_id, *arguments)
1250
          if match = /^find_(all_by|by)_([_a-zA-Z]\w*)$/.match(method_id.to_s)
1251
            finder = determine_finder(match)
1252

1253 1254
            attribute_names = extract_attribute_names_from_match(match)
            super unless all_attributes_exists?(attribute_names)
1255

1256 1257 1258 1259 1260 1261
            self.class_eval %{
              def self.#{method_id}(*args) 
                options = args.last.is_a?(Hash) ? args.pop : {}
                attributes = construct_attributes_from_arguments([:#{attribute_names.join(',:')}], args)
                finder_options = { :conditions => attributes }
                validate_find_options(options)
1262 1263
                set_readonly_option!(options)

1264 1265 1266
                if options[:conditions]
                  with_scope(:find => finder_options) do
                    ActiveSupport::Deprecation.silence { send(:#{finder}, options) }
1267 1268
                  end
                else
1269
                  ActiveSupport::Deprecation.silence { send(:#{finder}, options.merge(finder_options)) }
1270
                end
1271 1272 1273
              end
            }
            send(method_id, *arguments)
1274
          elsif match = /^find_or_(initialize|create)_by_([_a-zA-Z]\w*)$/.match(method_id.to_s)
1275
            instantiator = determine_instantiator(match)
1276 1277 1278
            attribute_names = extract_attribute_names_from_match(match)
            super unless all_attributes_exists?(attribute_names)

1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289
            self.class_eval %{
              def self.#{method_id}(*args) 
                if args[0].is_a?(Hash)
                  attributes = args[0].with_indifferent_access
                  find_attributes = attributes.slice(*[:#{attribute_names.join(',:')}])
                else
                  find_attributes = attributes = construct_attributes_from_arguments([:#{attribute_names.join(',:')}], args)
                end
                
                options = { :conditions => find_attributes }
                set_readonly_option!(options)
1290

1291 1292 1293 1294
                find_initial(options) || send(:#{instantiator}, attributes)
              end
            }
            send(method_id, *arguments)
1295 1296 1297 1298
          else
            super
          end
        end
D
Initial  
David Heinemeier Hansson 已提交
1299

1300
        def determine_finder(match)
1301 1302 1303
          match.captures.first == 'all_by' ? :find_every : :find_initial
        end

1304 1305 1306 1307
        def determine_instantiator(match)
          match.captures.first == 'initialize' ? :new : :create
        end

1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319
        def extract_attribute_names_from_match(match)
          match.captures.last.split('_and_')
        end

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

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

1322 1323 1324
        def attribute_condition(argument)
          case argument
            when nil   then "IS ?"
1325
            when Array, ActiveRecord::Associations::AssociationCollection then "IN (?)"
1326
            when Range then "BETWEEN ? AND ?"
1327 1328 1329 1330
            else            "= ?"
          end
        end

1331 1332 1333 1334
        # 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
1335
            else sanitize_sql(primary_key => id_or_conditions)
1336 1337 1338 1339
          end
        end


1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359
        # 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
1360
          sing.send :alias_method, "original_#{name}", name
1361 1362 1363
          if block_given?
            sing.send :define_method, name, &block
          else
1364 1365 1366 1367
            # 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
1368 1369
        end

D
Initial  
David Heinemeier Hansson 已提交
1370
      protected
1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384
        # Scope parameters to method calls within the block.  Takes a hash of method_name => parameters hash.
        # method_name may be :find or :create. :find parameters may include the <tt>:conditions</tt>, <tt>:joins</tt>,
        # <tt>:include</tt>, <tt>:offset</tt>, <tt>:limit</tt>, and <tt>:readonly</tt> options. :create parameters are an attributes hash.
        #
        #   class Article < ActiveRecord::Base
        #     def self.create_with_scope
        #       with_scope(:find => { :conditions => "blog_id = 1" }, :create => { :blog_id => 1 }) do
        #         find(1) # => SELECT * from articles WHERE blog_id = 1 AND id = 1
        #         a = create(1)
        #         a.blog_id # => 1
        #       end
        #     end
        #   end
        #
D
David Heinemeier Hansson 已提交
1385 1386
        # In nested scopings, all previous parameters are overwritten by the innermost rule, with the exception of
        # :conditions and :include options in :find, which are merged.
1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423
        #
        #   class Article < ActiveRecord::Base
        #     def self.find_with_scope
        #       with_scope(:find => { :conditions => "blog_id = 1", :limit => 1 }, :create => { :blog_id => 1 }) do
        #         with_scope(:find => { :limit => 10})
        #           find(:all) # => SELECT * from articles WHERE blog_id = 1 LIMIT 10
        #         end
        #         with_scope(:find => { :conditions => "author_id = 3" })
        #           find(:all) # => SELECT * from articles WHERE blog_id = 1 AND author_id = 3 LIMIT 1
        #         end
        #       end
        #     end
        #   end
        #
        # You can ignore any previous scopings by using <tt>with_exclusive_scope</tt> method.
        #
        #   class Article < ActiveRecord::Base
        #     def self.find_with_exclusive_scope
        #       with_scope(:find => { :conditions => "blog_id = 1", :limit => 1 }) do
        #         with_exclusive_scope(:find => { :limit => 10 })
        #           find(:all) # => SELECT * from articles LIMIT 10
        #         end
        #       end
        #     end
        #   end
        def with_scope(method_scoping = {}, action = :merge, &block)
          method_scoping = method_scoping.method_scoping if method_scoping.respond_to?(:method_scoping)

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

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

          if f = method_scoping[:find]
1424
            f.assert_valid_keys([ :conditions, :joins, :select, :include, :from, :offset, :limit, :order, :group, :readonly, :lock ])
1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467
            set_readonly_option! f
          end

          # Merge scopings
          if action == :merge && current_scoped_methods
            method_scoping = current_scoped_methods.inject(method_scoping) do |hash, (method, params)|
              case hash[method]
                when Hash
                  if method == :find
                    (hash[method].keys + params.keys).uniq.each do |key|
                      merge = hash[method][key] && params[key] # merge if both scopes have the same key
                      if key == :conditions && merge
                        hash[method][key] = [params[key], hash[method][key]].collect{ |sql| "( %s )" % sanitize_sql(sql) }.join(" AND ")
                      elsif key == :include && merge
                        hash[method][key] = merge_includes(hash[method][key], params[key]).uniq
                      else
                        hash[method][key] = hash[method][key] || params[key]
                      end
                    end
                  else
                    hash[method] = params.merge(hash[method])
                  end
                else
                  hash[method] = params
              end
              hash
            end
          end

          self.scoped_methods << method_scoping

          begin
            yield
          ensure
            self.scoped_methods.pop
          end
        end

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

D
David Heinemeier Hansson 已提交
1468
        def subclasses #:nodoc:
D
Initial  
David Heinemeier Hansson 已提交
1469 1470 1471
          @@subclasses[self] ||= []
          @@subclasses[self] + extra = @@subclasses[self].inject([]) {|list, subclass| list + subclass.subclasses }
        end
1472 1473

        # Test whether the given method and optional key are scoped.
D
David Heinemeier Hansson 已提交
1474
        def scoped?(method, key = nil) #:nodoc:
1475 1476 1477
          if current_scoped_methods && (scope = current_scoped_methods[method])
            !key || scope.has_key?(key)
          end
1478 1479 1480
        end

        # Retrieve the scope for the given method and optional key.
D
David Heinemeier Hansson 已提交
1481
        def scope(method, key = nil) #:nodoc:
1482
          if current_scoped_methods && (scope = current_scoped_methods[method])
1483 1484 1485 1486
            key ? scope[key] : scope
          end
        end

1487 1488 1489
        def thread_safe_scoped_methods #:nodoc:
          scoped_methods = (Thread.current[:scoped_methods] ||= {})
          scoped_methods[self] ||= []
1490
        end
1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502
        
        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 已提交
1503
        def current_scoped_methods #:nodoc:
1504
          scoped_methods.last
1505
        end
1506

1507 1508
        # 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 已提交
1509
        def compute_type(type_name)
1510
          modularized_name = type_name_with_module(type_name)
1511
          begin
1512 1513 1514
            class_eval(modularized_name, __FILE__, __LINE__)
          rescue NameError
            class_eval(type_name, __FILE__, __LINE__)
D
Initial  
David Heinemeier Hansson 已提交
1515 1516 1517
          end
        end

1518 1519
        # Returns the class descending directly from ActiveRecord in the inheritance hierarchy.
        def class_of_active_record_descendant(klass)
1520
          if klass.superclass == Base || klass.superclass.abstract_class?
1521
            klass
D
Initial  
David Heinemeier Hansson 已提交
1522 1523 1524
          elsif klass.superclass.nil?
            raise ActiveRecordError, "#{name} doesn't belong in a hierarchy descending from ActiveRecord"
          else
1525
            class_of_active_record_descendant(klass.superclass)
D
Initial  
David Heinemeier Hansson 已提交
1526 1527 1528
          end
        end

1529
        # Returns the name of the class descending directly from ActiveRecord in the inheritance hierarchy.
D
David Heinemeier Hansson 已提交
1530
        def class_name_of_active_record_descendant(klass) #:nodoc:
1531
          klass.base_class.name
1532 1533
        end

1534
        # Accepts an array, hash, or string of sql conditions and sanitizes
1535
        # them into a valid SQL fragment for a WHERE clause.
1536 1537 1538
        #   ["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'"
1539
        def sanitize_sql_for_conditions(condition)
1540 1541
          case condition
            when Array; sanitize_sql_array(condition)
1542
            when Hash;  sanitize_sql_hash_for_conditions(condition)
1543 1544
            else        condition
          end
1545
        end
1546
        alias_method :sanitize_sql, :sanitize_sql_for_conditions
1547

1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559
        # Accepts an array, hash, or string of sql conditions and sanitizes
        # them into a valid SQL fragment for a SET clause.
        #   { :name => nil, :group_id => 4 }  returns "name = NULL , group_id='4'"
        def sanitize_sql_for_assignment(assignments)
          case assignments
            when Array; sanitize_sql_array(assignments)
            when Hash;  sanitize_sql_hash_for_assignment(assignments)
            else        assignments
          end
        end

        # Sanitizes a hash of attribute/value pairs into SQL conditions for a WHERE clause.
1560 1561 1562 1563
        #   { :name => "foo'bar", :group_id => 4 }
        #     # => "name='foo''bar' and group_id= 4"
        #   { :status => nil, :group_id => [1,2,3] }
        #     # => "status IS NULL and group_id IN (1,2,3)"
1564 1565
        #   { :age => 13..18 }
        #     # => "age BETWEEN 13 AND 18"
1566
        def sanitize_sql_hash_for_conditions(attrs)
1567 1568 1569 1570
          conditions = attrs.map do |attr, value|
            "#{table_name}.#{connection.quote_column_name(attr)} #{attribute_condition(value)}"
          end.join(' AND ')

1571
          replace_bind_variables(conditions, expand_range_bind_variables(attrs.values))
1572
        end
1573 1574 1575 1576 1577 1578 1579 1580 1581 1582
        alias_method :sanitize_sql_hash, :sanitize_sql_hash_for_conditions

        # Sanitizes a hash of attribute/value pairs into SQL conditions for a SET clause.
        #   { :status => nil, :group_id => 1 }
        #     # => "status = NULL , group_id = 1"
        def sanitize_sql_hash_for_assignment(attrs)
          conditions = attrs.map do |attr, value|
            "#{connection.quote_column_name(attr)} = #{quote_bound_value(value)}"
          end.join(', ')
        end
1583

1584
        # Accepts an array of conditions.  The array has each value
1585 1586
        # sanitized and interpolated into the sql statement.
        #   ["name='%s' and group_id='%s'", "foo'bar", 4]  returns  "name='foo''bar' and group_id='4'"
1587
        def sanitize_sql_array(ary)
1588 1589 1590 1591
          statement, *values = ary
          if values.first.is_a?(Hash) and statement =~ /:\w+/
            replace_named_bind_variables(statement, values.first)
          elsif statement.include?('?')
1592 1593
            replace_bind_variables(statement, values)
          else
1594
            statement % values.collect { |value| connection.quote_string(value.to_s) }
1595
          end
1596 1597
        end

1598 1599
        alias_method :sanitize_conditions, :sanitize_sql

D
David Heinemeier Hansson 已提交
1600
        def replace_bind_variables(statement, values) #:nodoc:
1601
          raise_if_bind_arity_mismatch(statement, statement.count('?'), values.size)
1602
          bound = values.dup
1603
          statement.gsub('?') { quote_bound_value(bound.shift) }
1604 1605
        end

D
David Heinemeier Hansson 已提交
1606
        def replace_named_bind_variables(statement, bind_vars) #:nodoc:
1607 1608
          statement.gsub(/:(\w+)/) do
            match = $1.to_sym
1609
            if bind_vars.include?(match)
1610
              quote_bound_value(bind_vars[match])
1611 1612
            else
              raise PreparedStatementInvalid, "missing value for :#{match} in #{statement}"
1613 1614
            end
          end
1615 1616
        end

1617 1618 1619 1620 1621 1622 1623
        def expand_range_bind_variables(bind_vars) #:nodoc:
          bind_vars.each_with_index do |var, index|
            bind_vars[index, 1] = [var.first, var.last] if var.is_a?(Range)
          end
          bind_vars
        end

D
David Heinemeier Hansson 已提交
1624
        def quote_bound_value(value) #:nodoc:
1625 1626 1627
          if value.respond_to?(:map) && !value.is_a?(String)
            if value.respond_to?(:empty?) && value.empty?
              connection.quote(nil)
1628 1629 1630
            else
              value.map { |v| connection.quote(v) }.join(',')
            end
1631 1632
          else
            connection.quote(value)
1633 1634 1635
          end
        end

D
David Heinemeier Hansson 已提交
1636
        def raise_if_bind_arity_mismatch(statement, expected, provided) #:nodoc:
1637 1638 1639
          unless expected == provided
            raise PreparedStatementInvalid, "wrong number of bind variables (#{provided} for #{expected}) in: #{statement}"
          end
1640
        end
1641

1642
        VALID_FIND_OPTIONS = [ :conditions, :include, :joins, :limit, :offset,
1643 1644
                               :order, :select, :readonly, :group, :from, :lock ]

D
David Heinemeier Hansson 已提交
1645
        def validate_find_options(options) #:nodoc:
1646 1647
          options.assert_valid_keys(VALID_FIND_OPTIONS)
        end
1648

D
David Heinemeier Hansson 已提交
1649
        def set_readonly_option!(options) #:nodoc:
1650 1651 1652
          # Inherit :readonly from finder scope if set.  Otherwise,
          # if :joins is not blank then :readonly defaults to true.
          unless options.has_key?(:readonly)
J
Jeremy Kemper 已提交
1653 1654
            if scoped_readonly = scope(:find, :readonly)
              options[:readonly] = scoped_readonly
1655
            elsif !options[:joins].blank? && !options[:select]
1656 1657 1658
              options[:readonly] = true
            end
          end
D
Initial  
David Heinemeier Hansson 已提交
1659
        end
1660

D
David Heinemeier Hansson 已提交
1661
        def encode_quoted_value(value) #:nodoc:
1662
          quoted_value = connection.quote(value)
1663 1664
          quoted_value = "'#{quoted_value[1..-2].gsub(/\'/, "\\\\'")}'" if quoted_value.include?("\\\'") # (for ruby mode) " 
          quoted_value 
1665
        end
D
Initial  
David Heinemeier Hansson 已提交
1666 1667 1668 1669 1670
    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).
1671
      # In both instances, valid attribute keys are determined by the column names of the associated table --
D
Initial  
David Heinemeier Hansson 已提交
1672 1673 1674
      # hence you can't have attributes that aren't part of the table columns.
      def initialize(attributes = nil)
        @attributes = attributes_from_column_definition
1675
        @attributes_cache = {}
D
Initial  
David Heinemeier Hansson 已提交
1676 1677 1678
        @new_record = true
        ensure_proper_type
        self.attributes = attributes unless attributes.nil?
1679
        self.class.send(:scope, :create).each { |att,value| self.send("#{att}=", value) } if self.class.send(:scoped?, :create)
1680 1681 1682
        result = yield self if block_given?
        callback(:after_initialize) if respond_to_without_attributes?(:after_initialize)
        result
D
Initial  
David Heinemeier Hansson 已提交
1683
      end
1684

1685 1686
      # 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 已提交
1687
      def id
1688
        attr_name = self.class.primary_key
1689
        column = column_for_attribute(attr_name)
1690
        
1691 1692 1693 1694
        self.class.send(:define_read_method, :id, attr_name, column)
        # now that the method exists, call it
        self.send attr_name.to_sym

D
Initial  
David Heinemeier Hansson 已提交
1695
      end
1696

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

1703
      def id_before_type_cast #:nodoc:
1704 1705 1706
        read_attribute_before_type_cast(self.class.primary_key)
      end

1707
      def quoted_id #:nodoc:
1708
        quote_value(id, column_for_attribute(self.class.primary_key))
1709
      end
1710

D
Initial  
David Heinemeier Hansson 已提交
1711 1712 1713 1714
      # Sets the primary ID.
      def id=(value)
        write_attribute(self.class.primary_key, value)
      end
1715

D
Initial  
David Heinemeier Hansson 已提交
1716
      # Returns true if this object hasn't been saved yet -- that is, a record for the object doesn't exist yet.
1717
      def new_record?
1718
        @new_record
1719
      end
1720

D
Initial  
David Heinemeier Hansson 已提交
1721 1722 1723 1724 1725
      # * 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
        create_or_update
      end
1726 1727 1728 1729
      
      # Attempts to save the record, but instead of just returning false if it couldn't happen, it raises a 
      # RecordNotSaved exception
      def save!
1730
        create_or_update || raise(RecordNotSaved)
1731
      end
1732

D
Initial  
David Heinemeier Hansson 已提交
1733 1734 1735
      # 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
1736
        unless new_record?
1737 1738
          connection.delete <<-end_sql, "#{self.class.name} Destroy"
            DELETE FROM #{self.class.table_name}
1739
            WHERE #{connection.quote_column_name(self.class.primary_key)} = #{quoted_id}
1740
          end_sql
D
Initial  
David Heinemeier Hansson 已提交
1741 1742 1743 1744 1745
        end

        freeze
      end

J
Jeremy Kemper 已提交
1746 1747 1748 1749 1750
      # 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 已提交
1751
      def clone
1752
        attrs = self.attributes_before_type_cast
D
David Heinemeier Hansson 已提交
1753
        attrs.delete(self.class.primary_key)
1754 1755 1756
        record = self.class.new
        record.send :instance_variable_set, '@attributes', attrs
        record
D
Initial  
David Heinemeier Hansson 已提交
1757
      end
1758

D
Initial  
David Heinemeier Hansson 已提交
1759
      # Updates a single attribute and saves the record. This is especially useful for boolean flags on existing records.
1760
      # Note: This method is overwritten by the Validation module that'll make sure that updates made with this method
1761
      # aren't subjected to validation checks. Hence, attributes can be updated even if the full object isn't valid.
D
Initial  
David Heinemeier Hansson 已提交
1762
      def update_attribute(name, value)
1763
        send(name.to_s + '=', value)
1764
        save
1765 1766
      end

1767
      # Updates all the attributes from the passed-in Hash and saves the record. If the object is invalid, the saving will
1768
      # fail and false will be returned.
1769
      def update_attributes(attributes)
1770
        self.attributes = attributes
1771
        save
D
Initial  
David Heinemeier Hansson 已提交
1772
      end
1773 1774 1775 1776 1777 1778
      
      # Updates an object just like Base.update_attributes but calls save! instead of save so an exception is raised if the record is invalid.
      def update_attributes!(attributes)
        self.attributes = attributes
        save!
      end
D
Initial  
David Heinemeier Hansson 已提交
1779

1780 1781 1782 1783 1784 1785
      # 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
1786

1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802
      # 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
1803

1804 1805
      # Turns an +attribute+ that's currently true into false and vice versa. Returns self.
      def toggle(attribute)
1806
        self[attribute] = !send("#{attribute}?")
1807 1808 1809 1810 1811 1812 1813 1814
        self
      end

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

1815
      # Reloads the attributes of this object from the database.
1816 1817 1818 1819
      # 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)
1820
        clear_aggregation_cache
1821
        clear_association_cache
1822
        @attributes.update(self.class.find(self.id, options).instance_variable_get('@attributes'))
1823
        @attributes_cache = {}
1824
        self
1825 1826
      end

1827
      # Returns the value of the attribute identified by <tt>attr_name</tt> after it has been typecast (for example,
D
Initial  
David Heinemeier Hansson 已提交
1828 1829
      # "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).
1830
      def [](attr_name)
1831
        read_attribute(attr_name)
D
Initial  
David Heinemeier Hansson 已提交
1832
      end
1833

D
Initial  
David Heinemeier Hansson 已提交
1834 1835
      # Updates the attribute identified by <tt>attr_name</tt> with the specified +value+.
      # (Alias for the protected write_attribute method).
1836
      def []=(attr_name, value)
1837
        write_attribute(attr_name, value)
D
Initial  
David Heinemeier Hansson 已提交
1838 1839 1840 1841 1842 1843 1844
      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 已提交
1845 1846 1847
      def attributes=(new_attributes)
        return if new_attributes.nil?
        attributes = new_attributes.dup
1848
        attributes.stringify_keys!
D
Initial  
David Heinemeier Hansson 已提交
1849 1850

        multi_parameter_attributes = []
1851
        remove_attributes_protected_from_mass_assignment(attributes).each do |k, v|
D
Initial  
David Heinemeier Hansson 已提交
1852 1853
          k.include?("(") ? multi_parameter_attributes << [ k, v ] : send(k + "=", v)
        end
D
David Heinemeier Hansson 已提交
1854

D
Initial  
David Heinemeier Hansson 已提交
1855 1856 1857
        assign_multiparameter_attributes(multi_parameter_attributes)
      end

D
David Heinemeier Hansson 已提交
1858

1859
      # Returns a hash of all the attributes with their names as keys and clones of their objects as values.
1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877
      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
1878 1879 1880 1881 1882
      end

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

1885 1886 1887 1888
      # Format attributes nicely for inspect.
      def attribute_for_inspect(attr_name)
        value = read_attribute(attr_name)

1889 1890 1891 1892
        if value.is_a?(String) && value.length > 50
          %("#{value[0..50]}...")
        elsif value.is_a?(Date) || value.is_a?(Time)
          %("#{value.to_s(:db)}")
1893 1894 1895 1896 1897
        else
          value.inspect
        end
      end

D
Initial  
David Heinemeier Hansson 已提交
1898
      # Returns true if the specified +attribute+ has been set by the user or by a database load and is neither
1899
      # nil nor empty? (the latter only applies to objects that respond to empty?, most notably Strings).
D
Initial  
David Heinemeier Hansson 已提交
1900
      def attribute_present?(attribute)
1901
        value = read_attribute(attribute)
1902
        !value.blank?
D
Initial  
David Heinemeier Hansson 已提交
1903 1904
      end

1905 1906 1907 1908 1909
      # 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 已提交
1910 1911 1912 1913 1914 1915 1916
      # 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)
1917
        self.class.columns_hash[name.to_s]
D
Initial  
David Heinemeier Hansson 已提交
1918
      end
1919

1920
      # 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 已提交
1921
      def ==(comparison_object)
1922 1923
        comparison_object.equal?(self) ||
          (comparison_object.instance_of?(self.class) && 
1924
            comparison_object.id == id && 
1925
            !comparison_object.new_record?)
D
Initial  
David Heinemeier Hansson 已提交
1926 1927 1928 1929 1930 1931
      end

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

D
Initial  
David Heinemeier Hansson 已提交
1933 1934 1935
      # 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
1936
        id.hash
D
Initial  
David Heinemeier Hansson 已提交
1937 1938
      end

1939 1940
      # Just freeze the attributes hash, such that associations are still accessible even on destroyed records.
      def freeze
1941
        @attributes.freeze; self
1942
      end
1943

1944 1945 1946
      def frozen?
        @attributes.frozen?
      end
1947

D
David Heinemeier Hansson 已提交
1948
      # 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.
1949 1950 1951 1952
      def readonly?
        @readonly == true
      end

D
David Heinemeier Hansson 已提交
1953
      def readonly! #:nodoc:
1954 1955
        @readonly = true
      end
1956

1957 1958
      # Nice pretty inspect.
      def inspect
1959
        attributes_as_nice_string = self.class.column_names.collect { |name|
1960 1961 1962 1963
          if has_attribute?(name) || new_record?
            "#{name}: #{attribute_for_inspect(name)}"
          end
        }.compact.join(", ")
1964
        "#<#{self.class} #{attributes_as_nice_string}>"
1965
      end
1966

D
Initial  
David Heinemeier Hansson 已提交
1967 1968
    private
      def create_or_update
1969
        raise ReadOnlyRecord if readonly?
1970 1971
        result = new_record? ? create : update
        result != false
D
Initial  
David Heinemeier Hansson 已提交
1972 1973
      end

1974
      # Updates the associated record with values matching those of the instance attributes.
1975
      # Returns the number of affected rows.
D
Initial  
David Heinemeier Hansson 已提交
1976
      def update
1977 1978
        quoted_attributes = attributes_with_quotes(false, false)
        return 0 if quoted_attributes.empty?
D
Initial  
David Heinemeier Hansson 已提交
1979 1980
        connection.update(
          "UPDATE #{self.class.table_name} " +
1981
          "SET #{quoted_comma_pair_list(connection, quoted_attributes)} " +
1982
          "WHERE #{connection.quote_column_name(self.class.primary_key)} = #{quote_value(id)}",
D
Initial  
David Heinemeier Hansson 已提交
1983 1984 1985 1986
          "#{self.class.name} Update"
        )
      end

1987 1988
      # Creates a record with values matching those of the instance attributes
      # and returns its id.
D
Initial  
David Heinemeier Hansson 已提交
1989
      def create
1990
        if self.id.nil? && connection.prefetch_primary_key?(self.class.table_name)
1991 1992
          self.id = connection.next_sequence_value(self.class.sequence_name)
        end
1993

1994 1995 1996 1997 1998
        quoted_attributes = attributes_with_quotes

        statement = if quoted_attributes.empty?
          connection.empty_insert_statement(self.class.table_name)
        else
D
Initial  
David Heinemeier Hansson 已提交
1999 2000
          "INSERT INTO #{self.class.table_name} " +
          "(#{quoted_column_names.join(', ')}) " +
2001 2002 2003 2004 2005
          "VALUES(#{quoted_attributes.values.join(', ')})"
        end

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

D
Initial  
David Heinemeier Hansson 已提交
2007
        @new_record = false
2008
        id
D
Initial  
David Heinemeier Hansson 已提交
2009 2010
      end

2011
      # Sets the attribute used for single table inheritance to this class name if this is not the ActiveRecord descendent.
2012 2013
      # 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 已提交
2014 2015 2016 2017 2018 2019 2020
      # 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

2021 2022
      def convert_number_column_value(value)
        case value
2023 2024 2025
          when FalseClass; 0
          when TrueClass;  1
          when '';         nil
2026 2027
          else value
        end
D
Initial  
David Heinemeier Hansson 已提交
2028 2029 2030
      end

      def remove_attributes_protected_from_mass_assignment(attributes)
2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050
        safe_attributes =
          if self.class.accessible_attributes.nil? && self.class.protected_attributes.nil?
            attributes.reject { |key, value| attributes_protected_by_default.include?(key.gsub(/\(.+/, "")) }
          elsif self.class.protected_attributes.nil?
            attributes.reject { |key, value| !self.class.accessible_attributes.include?(key.gsub(/\(.+/, "").intern) || attributes_protected_by_default.include?(key.gsub(/\(.+/, "")) }
          elsif self.class.accessible_attributes.nil?
            attributes.reject { |key, value| self.class.protected_attributes.include?(key.gsub(/\(.+/,"").intern) || attributes_protected_by_default.include?(key.gsub(/\(.+/, "")) }
          else
            raise "Declare either attr_protected or attr_accessible for #{self.class}, but not both."
          end

        removed_attributes = attributes.keys - safe_attributes.keys

        if removed_attributes.any?
          error_message = "Can't mass-assign these protected attributes: #{removed_attributes.join(', ')}"
          if self.class.whiny_protected_attributes
            raise ProtectedAttributeAssignmentError, error_message
          else
            logger.error error_message
          end
D
Initial  
David Heinemeier Hansson 已提交
2051
        end
2052 2053

        safe_attributes
D
Initial  
David Heinemeier Hansson 已提交
2054
      end
2055

2056 2057 2058 2059 2060 2061 2062 2063
      # Removes attributes which have been marked as readonly.
      def remove_readonly_attributes(attributes)
        unless self.class.readonly_attributes.nil?
          attributes.delete_if { |key, value| self.class.readonly_attributes.include?(key.gsub(/\(.+/,"").intern) }
        else
          attributes
        end
      end
D
Initial  
David Heinemeier Hansson 已提交
2064

2065 2066
      # The primary key and inheritance column can never be set by mass-assignment for security reasons.
      def attributes_protected_by_default
2067 2068 2069
        default = [ self.class.primary_key, self.class.inheritance_column ]
        default << 'id' unless self.class.primary_key.eql? 'id'
        default
2070 2071
      end

D
Initial  
David Heinemeier Hansson 已提交
2072
      # Returns copy of the attributes hash where all the values have been safely quoted for use in
2073
      # an SQL statement.
2074 2075
      def attributes_with_quotes(include_primary_key = true, include_readonly_attributes = true)
        quoted = attributes.inject({}) do |quoted, (name, value)|
2076
          if column = column_for_attribute(name)
2077
            quoted[name] = quote_value(value, column) unless !include_primary_key && column.primary
2078 2079
          end
          quoted
D
Initial  
David Heinemeier Hansson 已提交
2080
        end
2081
        include_readonly_attributes ? quoted : remove_readonly_attributes(quoted)
D
Initial  
David Heinemeier Hansson 已提交
2082
      end
2083

D
Initial  
David Heinemeier Hansson 已提交
2084
      # Quote strings appropriately for SQL statements.
2085
      def quote_value(value, column = nil)
2086
        self.class.connection.quote(value, column)
D
Initial  
David Heinemeier Hansson 已提交
2087 2088 2089 2090 2091
      end

      # Interpolate custom sql string in instance context.
      # Optional record argument is meant for custom insert_sql.
      def interpolate_sql(sql, record = nil)
2092
        instance_eval("%@#{sql.gsub('@', '\@')}@")
D
Initial  
David Heinemeier Hansson 已提交
2093 2094 2095 2096 2097 2098 2099
      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
2100
        self.class.columns.inject({}) do |attributes, column|
2101
          attributes[column.name] = column.default unless column.name == self.class.primary_key
D
Initial  
David Heinemeier Hansson 已提交
2102 2103 2104 2105 2106 2107 2108 2109
          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
2110
      # 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 已提交
2111 2112 2113 2114 2115 2116
      # 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
2117

D
Initial  
David Heinemeier Hansson 已提交
2118 2119
      # 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)
2120
        errors = []
D
Initial  
David Heinemeier Hansson 已提交
2121
        callstack.each do |name, values|
2122
          klass = (self.class.reflect_on_aggregation(name.to_sym) || column_for_attribute(name)).klass
D
Initial  
David Heinemeier Hansson 已提交
2123 2124 2125
          if values.empty?
            send(name + "=", nil)
          else
2126
            begin
2127
              send(name + "=", Time == klass ? (@@default_timezone == :utc ? klass.utc(*values) : klass.local(*values)) : klass.new(*values))
2128 2129 2130
            rescue => ex
              errors << AttributeAssignmentError.new("error on assignment #{values.inspect} to #{name}", ex, name)
            end
D
Initial  
David Heinemeier Hansson 已提交
2131 2132
          end
        end
2133 2134 2135
        unless errors.empty?
          raise MultiparameterAssignmentErrors.new(errors), "#{errors.size} error(s) on assignment of multiparameter attributes"
        end
D
Initial  
David Heinemeier Hansson 已提交
2136
      end
2137

D
Initial  
David Heinemeier Hansson 已提交
2138 2139 2140 2141 2142 2143 2144 2145 2146
      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?
2147
            attributes[attribute_name] <<
2148
              [ find_parameter_position(multiparameter_name), type_cast_attribute_value(multiparameter_name, value) ]
D
Initial  
David Heinemeier Hansson 已提交
2149 2150 2151 2152 2153
          end
        end

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

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

D
Initial  
David Heinemeier Hansson 已提交
2159 2160 2161
      def find_parameter_position(multiparameter_name)
        multiparameter_name.scan(/\(([0-9]*).*\)/).first.first
      end
2162

D
Initial  
David Heinemeier Hansson 已提交
2163 2164 2165 2166 2167 2168
      # 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)
2169 2170 2171
        attributes.keys.collect do |column_name|
          self.class.connection.quote_column_name(column_name)
        end
D
Initial  
David Heinemeier Hansson 已提交
2172 2173
      end

2174 2175 2176 2177
      def quote_columns(quoter, hash)
        hash.inject({}) do |quoted, (name, value)|
          quoted[quoter.quote_column_name(name)] = value
          quoted
2178
        end
D
Initial  
David Heinemeier Hansson 已提交
2179 2180
      end

2181 2182
      def quoted_comma_pair_list(quoter, hash)
        comma_pair_list(quote_columns(quoter, hash))
D
Initial  
David Heinemeier Hansson 已提交
2183 2184 2185
      end

      def object_from_yaml(string)
2186
        return string unless string.is_a?(String)
2187
        YAML::load(string) rescue string
D
Initial  
David Heinemeier Hansson 已提交
2188
      end
2189 2190 2191 2192 2193 2194 2195 2196 2197 2198

      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)
2199 2200 2201 2202 2203 2204 2205

        case value
        when nil, Fixnum, true, false
          value
        else
          value.clone
        end
2206 2207 2208
      rescue TypeError, NoMethodError
        value
      end
D
Initial  
David Heinemeier Hansson 已提交
2209
  end
2210
end