base.rb 89.2 KB
Newer Older
D
Initial  
David Heinemeier Hansson 已提交
1
require 'yaml'
2
require 'set'
3
require 'active_record/deprecated_finders'
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 33
  class ConfigurationError < StandardError #:nodoc:
  end
34 35
  class ReadOnlyRecord < StandardError #:nodoc:
  end
36
  
37 38 39 40 41 42 43 44
  class AttributeAssignmentError < ActiveRecordError #:nodoc:
    attr_reader :exception, :attribute
    def initialize(message, exception, attribute)
      @exception = exception
      @attribute = attribute
      @message = message
    end
  end
45

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

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

D
Initial  
David Heinemeier Hansson 已提交
270
    @@subclasses = {}
271

D
Initial  
David Heinemeier Hansson 已提交
272
    cattr_accessor :configurations
273 274
    @@configurations = {}

275
    # 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 已提交
276 277
    # :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
278
    # that this is a global setting for all Active Records.
D
Initial  
David Heinemeier Hansson 已提交
279 280 281
    cattr_accessor :primary_key_prefix_type
    @@primary_key_prefix_type = nil

282
    # Accessor for the name of the prefix string to prepend to every table name. So if set to "basecamp_", all
283
    # 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 已提交
284 285 286 287 288 289 290 291 292
    # for tables in a shared database. By default, the prefix is the empty string.
    cattr_accessor :table_name_prefix
    @@table_name_prefix = ""

    # Works like +table_name_prefix+, but appends instead of prepends (set to "_basecamp" gives "projects_basecamp",
    # "people_basecamp"). By default, the suffix is the empty string.
    cattr_accessor :table_name_suffix
    @@table_name_suffix = ""

293 294
    # Indicates whether or not table names should be the pluralized versions of the corresponding class names.
    # If true, the default table name for a +Product+ class will be +products+. If false, it would just be +product+.
D
Initial  
David Heinemeier Hansson 已提交
295 296 297 298
    # See table_name for the full rules on table/class naming. This is true, by default.
    cattr_accessor :pluralize_table_names
    @@pluralize_table_names = true

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

305 306 307 308
    # Determines whether to use Time.local (using :local) or Time.utc (using :utc) when pulling dates and times from the database.
    # This is set to :local by default.
    cattr_accessor :default_timezone
    @@default_timezone = :local
309

310
    # Determines whether or not to use a connection for each thread, or a single shared connection for all threads.
311
    # Defaults to false. Set to true if you're writing a threaded application.
312
    cattr_accessor :allow_concurrency
313
    @@allow_concurrency = false
314

315 316 317 318 319 320
    # Determines whether to speed up access by generating optimized reader
    # methods to avoid expensive calls to method_missing when accessing
    # attributes by name. You might want to set this to false in development
    # mode, because the methods would be regenerated on each request.
    cattr_accessor :generate_read_methods
    @@generate_read_methods = true
321 322 323 324 325 326 327 328
    
    # Specifies the format to use when dumping the database schema with Rails'
    # Rakefile.  If :sql, the schema is dumped as (potentially database-
    # specific) SQL statements.  If :ruby, the schema is dumped as an 
    # ActiveRecord::Schema file which can be loaded into any database that
    # supports migrations.  Use :ruby if you want to have different database
    # adapters for, e.g., your development and test environments.
    cattr_accessor :schema_format 
329
    @@schema_format = :ruby
330

D
Initial  
David Heinemeier Hansson 已提交
331
    class << self # Class methods
332
      # Find operates with three different retrieval approaches:
333 334 335 336 337
      #
      # * 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.
338
      # * Find all: This will return all the records matched by the options used. If no records are found, an empty array is returned.
339
      #
340
      # All approaches accept an option hash as their last parameter. The options are:
341
      #
342 343
      # * <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".
344
      # * <tt>:group</tt>: An attribute name by which the result should be grouped. Uses the GROUP BY SQL-clause.
345 346 347
      # * <tt>:limit</tt>: An integer determining the limit on the number of rows that should be returned.
      # * <tt>:offset</tt>: An integer determining the offset from where the rows should be fetched. So at 5, it would skip the first 4 rows.
      # * <tt>:joins</tt>: An SQL fragment for additional joins like "LEFT JOIN comments ON comments.post_id = id". (Rarely needed).
348
      #   The records will be returned read-only since they will have attributes that do not correspond to the table's columns.
349
      #   Pass :readonly => false to override.
350 351
      # * <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.
352 353
      # * <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.
354
      # * <tt>:readonly</tt>: Mark the returned records read-only so they cannot be saved or updated.
355
      #
356
      # Examples for find by id:
D
Initial  
David Heinemeier Hansson 已提交
357 358 359
      #   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)
360
      #   Person.find([1])     # returns an array for objects the object with ID = 1
361 362 363
      #   Person.find(1, :conditions => "administrator = 1", :order => "created_on DESC")
      #
      # Examples for find first:
364
      #   Person.find(:first) # returns the first object fetched by SELECT * FROM people
365 366 367 368
      #   Person.find(:first, :conditions => [ "user_name = ?", user_name])
      #   Person.find(:first, :order => "created_on DESC", :offset => 5)
      #
      # Examples for find all:
369
      #   Person.find(:all) # returns an array of objects for all the rows fetched by SELECT * FROM people
370 371 372
      #   Person.find(:all, :conditions => [ "category IN (?)", categories], :limit => 50)
      #   Person.find(:all, :offset => 10, :limit => 10)
      #   Person.find(:all, :include => [ :account, :friends ])
373
      #   Person.find(:all, :group => "category")
374 375
      def find(*args)
        options = extract_options_from_args!(args)
376 377
        validate_find_options(options)
        set_readonly_option!(options)
378

379
        case args.first
380 381 382
          when :first then find_initial(options)
          when :all   then find_every(options)
          else             find_from_ids(args, options)
D
Initial  
David Heinemeier Hansson 已提交
383 384
        end
      end
385
      
386
      # Works like find(:all), but requires a complete SQL string. Examples:
D
Initial  
David Heinemeier Hansson 已提交
387
      #   Post.find_by_sql "SELECT p.*, c.author FROM posts p, comments c WHERE p.id = c.post_id"
388
      #   Post.find_by_sql ["SELECT * FROM posts WHERE author = ? AND created > ?", author_id, start_date]
D
Initial  
David Heinemeier Hansson 已提交
389
      def find_by_sql(sql)
390
        connection.select_all(sanitize_sql(sql), "#{name} Load").collect! { |record| instantiate(record) }
D
Initial  
David Heinemeier Hansson 已提交
391
      end
392

393 394 395 396
      # Returns true if the given +id+ represents the primary key of a record in the database, false otherwise.
      # Example:
      #   Person.exists?(5)
      def exists?(id)
397
        !find(:first, :conditions => ["#{primary_key} = ?", id]).nil? rescue false
D
Initial  
David Heinemeier Hansson 已提交
398
      end
399

D
Initial  
David Heinemeier Hansson 已提交
400
      # Creates an object, instantly saves it as a record (if the validation permits it), and returns it. If the save
401
      # fails under validations, the unsaved object is still returned.
D
Initial  
David Heinemeier Hansson 已提交
402
      def create(attributes = nil)
403 404 405 406
        if attributes.is_a?(Array)
          attributes.collect { |attr| create(attr) }
        else
          object = new(attributes)
407
          scope(:create).each { |att,value| object.send("#{att}=", value) } if scoped?(:create)
408 409 410
          object.save
          object
        end
D
Initial  
David Heinemeier Hansson 已提交
411 412
      end

413
      # Finds the record from the passed +id+, instantly saves it with the passed +attributes+ (if the validation permits it),
414
      # and returns it. If the save fails under validations, the unsaved object is still returned.
415 416 417 418 419 420 421 422 423 424
      #
      # 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 已提交
425
      def update(id, attributes)
426 427 428 429 430 431 432 433
        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 已提交
434 435
      end

436 437
      # Deletes the record with the given +id+ without instantiating an object first. If an array of ids is provided, all of them
      # are deleted.
438
      def delete(id)
439
        delete_all([ "#{primary_key} IN (?)", id ])
440
      end
441

442
      # Destroys the record with the given +id+ by instantiating the object and calling #destroy (all the callbacks are the triggered).
443
      # If an array of ids is provided, all of them are destroyed.
444
      def destroy(id)
445
        id.is_a?(Array) ? id.each { |id| destroy(id) } : find(id).destroy
446 447
      end

448
      # Updates all records with the SET-part of an SQL update statement in +updates+ and returns an integer with the number of rows updated.
449
      # A subset of the records can be selected by specifying +conditions+. Example:
D
Initial  
David Heinemeier Hansson 已提交
450 451
      #   Billing.update_all "category = 'authorized', approved = 1", "author = 'David'"
      def update_all(updates, conditions = nil)
452
        sql  = "UPDATE #{table_name} SET #{sanitize_sql(updates)} "
453
        add_conditions!(sql, conditions, scope(:find))
454
        connection.update(sql, "#{name} Update")
D
Initial  
David Heinemeier Hansson 已提交
455
      end
456

457
      # Destroys the objects for all the records that match the +condition+ by instantiating each object and calling
D
Initial  
David Heinemeier Hansson 已提交
458 459 460
      # the destroy method. Example:
      #   Person.destroy_all "last_login < '2004-04-04'"
      def destroy_all(conditions = nil)
461
        find(:all, :conditions => conditions).each { |object| object.destroy }
D
Initial  
David Heinemeier Hansson 已提交
462
      end
463

464
      # Deletes all the records that match the +condition+ without instantiating the objects first (and hence not
D
Initial  
David Heinemeier Hansson 已提交
465
      # calling the destroy method). Example:
466
      #   Post.delete_all "person_id = 5 AND (category = 'Something' OR category = 'Else')"
D
Initial  
David Heinemeier Hansson 已提交
467 468
      def delete_all(conditions = nil)
        sql = "DELETE FROM #{table_name} "
469
        add_conditions!(sql, conditions, scope(:find))
D
Initial  
David Heinemeier Hansson 已提交
470 471 472 473
        connection.delete(sql, "#{name} Delete all")
      end

      # Returns the result of an SQL statement that should only include a COUNT(*) in the SELECT part.
474
      #   Product.count_by_sql "SELECT COUNT(*) FROM sales s, customers c WHERE s.customer_id = c.id"
D
Initial  
David Heinemeier Hansson 已提交
475
      def count_by_sql(sql)
476
        sql = sanitize_conditions(sql)
477
        connection.select_value(sql, "#{name} Count").to_i
D
Initial  
David Heinemeier Hansson 已提交
478
      end
479 480

      # Increments the specified counter by one. So <tt>DiscussionBoard.increment_counter("post_count",
D
Initial  
David Heinemeier Hansson 已提交
481
      # discussion_board_id)</tt> would increment the "post_count" counter on the board responding to discussion_board_id.
482
      # This is used for caching aggregate values, so that they don't need to be computed every time. Especially important
D
Initial  
David Heinemeier Hansson 已提交
483 484 485
      # for looping over a collection where each element require a number of aggregate values. Like the DiscussionBoard
      # that needs to list both the number of posts and comments.
      def increment_counter(counter_name, id)
486
        update_all "#{counter_name} = #{counter_name} + 1", "#{primary_key} = #{quote(id)}"
D
Initial  
David Heinemeier Hansson 已提交
487 488 489 490
      end

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

D
David Heinemeier Hansson 已提交
494

495
      # Attributes named in this macro are protected from mass-assignment, such as <tt>new(attributes)</tt> and
D
Initial  
David Heinemeier Hansson 已提交
496
      # <tt>attributes=(attributes)</tt>. Their assignment will simply be ignored. Instead, you can use the direct writer
497
      # methods to do assignment. This is meant to protect sensitive attributes from being overwritten by URL/form hackers. Example:
D
Initial  
David Heinemeier Hansson 已提交
498 499 500 501 502 503 504 505 506 507 508 509 510
      #
      #   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)
511
        write_inheritable_array("attr_protected", attributes - (protected_attributes || []))
D
Initial  
David Heinemeier Hansson 已提交
512
      end
513

514
      # Returns an array of all the attributes that have been protected from mass-assignment.
D
Initial  
David Heinemeier Hansson 已提交
515 516 517 518
      def protected_attributes # :nodoc:
        read_inheritable_attribute("attr_protected")
      end

519
      # If this macro is used, only those attributes named in it will be accessible for mass-assignment, such as
D
Initial  
David Heinemeier Hansson 已提交
520 521 522 523
      # <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)
524
        write_inheritable_array("attr_accessible", attributes - (accessible_attributes || []))
D
Initial  
David Heinemeier Hansson 已提交
525
      end
526

527
      # Returns an array of all the attributes that have been made accessible to mass-assignment.
D
Initial  
David Heinemeier Hansson 已提交
528 529 530 531
      def accessible_attributes # :nodoc:
        read_inheritable_attribute("attr_accessible")
      end

D
David Heinemeier Hansson 已提交
532

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

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

D
David Heinemeier Hansson 已提交
545

D
Initial  
David Heinemeier Hansson 已提交
546 547
      # 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
548 549
      # 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 已提交
550 551 552 553 554 555 556 557
      #
      # Additionally, the class-level table_name_prefix is prepended to the table_name and the table_name_suffix is appended.
      # So if you have "myapp_" as a prefix, the table name guess for an Account class becomes "myapp_accounts".
      #
      # 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:
      #
      #   class Mouse < ActiveRecord::Base
D
David Heinemeier Hansson 已提交
558
      #      set_table_name "mice"
D
Initial  
David Heinemeier Hansson 已提交
559
      #   end
560
      def table_name
561 562 563
        reset_table_name
      end

D
David Heinemeier Hansson 已提交
564
      def reset_table_name #:nodoc:
565
        name = "#{table_name_prefix}#{undecorated_table_name(base_class.name)}#{table_name_suffix}"
D
David Heinemeier Hansson 已提交
566
        set_table_name(name)
567
        name
D
Initial  
David Heinemeier Hansson 已提交
568 569
      end

570
      # Defines the primary key field -- can be overridden in subclasses. Overwriting will negate any effect of the
D
Initial  
David Heinemeier Hansson 已提交
571 572
      # primary_key_prefix_type setting, though.
      def primary_key
573 574 575
        reset_primary_key
      end

D
David Heinemeier Hansson 已提交
576
      def reset_primary_key #:nodoc:
577
        key = 'id'
D
Initial  
David Heinemeier Hansson 已提交
578 579
        case primary_key_prefix_type
          when :table_name
580
            key = Inflector.foreign_key(base_class.name, false)
D
Initial  
David Heinemeier Hansson 已提交
581
          when :table_name_with_underscore
582
            key = Inflector.foreign_key(base_class.name)
D
Initial  
David Heinemeier Hansson 已提交
583
        end
584 585
        set_primary_key(key)
        key
D
Initial  
David Heinemeier Hansson 已提交
586 587 588 589 590 591 592
      end

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

593 594
      # 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 已提交
595
      def sequence_name #:nodoc:
596 597 598
        reset_sequence_name
      end

D
David Heinemeier Hansson 已提交
599
      def reset_sequence_name #:nodoc:
600 601 602
        default = connection.default_sequence_name(table_name, primary_key)
        set_sequence_name(default)
        default
603 604
      end

605
      # Sets the table name to use to the given value, or (if the value
606
      # is nil or false) to the value returned by the given block.
607 608 609 610 611 612
      #
      # Example:
      #
      #   class Project < ActiveRecord::Base
      #     set_table_name "project"
      #   end
613
      def set_table_name(value = nil, &block)
614 615 616 617 618 619
        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
620
      # block.
621 622 623 624 625 626
      #
      # Example:
      #
      #   class Project < ActiveRecord::Base
      #     set_primary_key "sysid"
      #   end
627
      def set_primary_key(value = nil, &block)
628 629 630 631 632 633
        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
634
      # given block.
635 636 637 638 639 640 641 642
      #
      # Example:
      #
      #   class Project < ActiveRecord::Base
      #     set_inheritance_column do
      #       original_inheritance_column + "_id"
      #     end
      #   end
643
      def set_inheritance_column(value = nil, &block)
644 645 646 647
        define_attr_method :inheritance_column, value, &block
      end
      alias :inheritance_column= :set_inheritance_column

648 649
      # 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
650 651
      # given block. This is required for Oracle and is useful for any
      # database which relies on sequences for primary key generation.
652
      #
653 654 655 656 657
      # 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.
658 659 660 661 662 663
      #
      # Example:
      #
      #   class Project < ActiveRecord::Base
      #     set_sequence_name "projectseq"   # default would have been "project_seq"
      #   end
664
      def set_sequence_name(value = nil, &block)
665 666 667 668
        define_attr_method :sequence_name, value, &block
      end
      alias :sequence_name= :set_sequence_name

D
Initial  
David Heinemeier Hansson 已提交
669 670 671
      # 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
672 673 674
        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 已提交
675 676
      end

677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692
      # 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 已提交
693 694
      # Returns an array of column objects for the table associated with this class.
      def columns
695 696 697 698 699
        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 已提交
700
      end
701

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

D
David Heinemeier Hansson 已提交
707
      # Returns an array of column names as strings.
708
      def column_names
709
        @column_names ||= columns.map { |column| column.name }
710
      end
D
Initial  
David Heinemeier Hansson 已提交
711

712 713
      # 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 已提交
714
      def content_columns
715
        @content_columns ||= columns.reject { |c| c.primary || c.name =~ /(_id|_count)$/ || c.name == inheritance_column }
D
Initial  
David Heinemeier Hansson 已提交
716 717 718 719
      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
720
      # is available.
D
David Heinemeier Hansson 已提交
721
      def column_methods_hash #:nodoc:
722
        @dynamic_methods_hash ||= column_names.inject(Hash.new(false)) do |methods, attr|
723 724 725 726 727
          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 已提交
728 729 730
          methods
        end
      end
731

732
      # Contains the names of the generated reader methods.
D
David Heinemeier Hansson 已提交
733
      def read_methods #:nodoc:
734
        @read_methods ||= Set.new
735
      end
736

737
      # Resets all the cached information about columns, which will cause them to be reloaded on the next request.
738
      def reset_column_information
739
        read_methods.each { |name| undef_method(name) }
740
        @column_names = @columns = @columns_hash = @content_columns = @dynamic_methods_hash = @read_methods = nil
741 742
      end

743
      def reset_column_information_and_inheritable_attributes_for_all_subclasses#:nodoc:
744 745
        subclasses.each { |klass| klass.reset_inheritable_attributes; klass.reset_column_information }
      end
D
Initial  
David Heinemeier Hansson 已提交
746 747 748

      # 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"
749 750
      # Deprecated in favor of just calling "first_name".humanize
      def human_attribute_name(attribute_key_name) #:nodoc:
751
        attribute_key_name.humanize
D
Initial  
David Heinemeier Hansson 已提交
752
      end
753

D
Initial  
David Heinemeier Hansson 已提交
754
      def descends_from_active_record? # :nodoc:
755
        superclass == Base || !columns_hash.include?(inheritance_column)
D
Initial  
David Heinemeier Hansson 已提交
756 757
      end

758
      def quote(object) #:nodoc:
759 760 761 762
        connection.quote(object)
      end

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

767
      # Log and benchmark multiple statements in a single block. Example:
D
Initial  
David Heinemeier Hansson 已提交
768 769 770 771
      #
      #   Project.benchmark("Creating project") do
      #     project = Project.create("name" => "stuff")
      #     project.create_manager("name" => "David")
772
      #     project.milestones << Milestone.find(:all)
D
Initial  
David Heinemeier Hansson 已提交
773
      #   end
774
      #
775 776 777 778
      # 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.
      #
779
      # The logging of the multiple statements is turned off unless <tt>use_silence</tt> is set to false.
780 781
      def benchmark(title, log_level = Logger::DEBUG, use_silence = true)
        if logger && logger.level == log_level
782 783
          result = nil
          seconds = Benchmark.realtime { result = use_silence ? silence { yield } : yield }
784
          logger.add(log_level, "#{title} (#{'%.5f' % seconds})")
785 786 787 788
          result
        else
          yield
        end
789
      end
790

791 792
      # Silences the logger for the duration of the block.
      def silence
793 794 795
        old_logger_level, logger.level = logger.level, Logger::ERROR if logger
        yield
      ensure
796
        logger.level = old_logger_level if logger
D
Initial  
David Heinemeier Hansson 已提交
797
      end
798 799

      # Scope parameters to method calls within the block.  Takes a hash of method_name => parameters hash.
800
      # method_name may be :find or :create. :find parameters may include the <tt>:conditions</tt>, <tt>:joins</tt>,
801
      # <tt>:include</tt>, <tt>:offset</tt>, <tt>:limit</tt>, and <tt>:readonly</tt> options. :create parameters are an attributes hash.
802
      #
803
      #   Article.with_scope(:find => { :conditions => "blog_id = 1" }, :create => { :blog_id => 1 }) do
804
      #     Article.find(1) # => SELECT * from articles WHERE blog_id = 1 AND id = 1
805
      #     a = Article.create(1)
806
      #     a.blog_id # => 1
807
      #   end
808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830
      #
      # In nested scopings, all previous parameters are overwritten by inner rule
      # except :conditions in :find, that are merged as hash.
      #
      #   Article.with_scope(:find => { :conditions => "blog_id = 1", :limit => 1 }, :create => { :blog_id => 1 }) do
      #     Article.with_scope(:find => { :limit => 10})
      #       Article.find(:all) # => SELECT * from articles WHERE blog_id = 1 LIMIT 10
      #     end
      #     Article.with_scope(:find => { :conditions => "author_id = 3" })
      #       Article.find(:all) # => SELECT * from articles WHERE blog_id = 1 AND author_id = 3 LIMIT 1
      #     end
      #   end
      #
      # You can ignore any previous scopings by using <tt>with_exclusive_scope</tt> method.
      #
      #   Article.with_scope(:find => { :conditions => "blog_id = 1", :limit => 1 }) do
      #     Article.with_exclusive_scope(:find => { :limit => 10 })
      #       Article.find(:all) # => SELECT * from articles LIMIT 10
      #     end
      #   end
      def with_scope(method_scoping = {}, action = :merge, &block)
        method_scoping = method_scoping.method_scoping if method_scoping.respond_to?(:method_scoping)

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

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

839
        if f = method_scoping[:find]
840
          f.assert_valid_keys([ :conditions, :joins, :select, :include, :from, :offset, :limit, :readonly ])
841 842
          f[:readonly] = true if !f[:joins].blank? && !f.has_key?(:readonly)
        end
843

844 845 846 847 848
        # 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
849
                if method == :find
850
                  (hash[method].keys + params.keys).uniq.each do |key|
851 852
                    merge = hash[method][key] && params[key] # merge if both scopes have the same key
                    if key == :conditions && merge
853
                      hash[method][key] = [params[key], hash[method][key]].collect{ |sql| "( %s )" % sanitize_sql(sql) }.join(" AND ")
854 855
                    elsif key == :include && merge
                      hash[method][key] = merge_includes(hash[method][key], params[key]).uniq
856 857 858 859 860 861 862 863 864 865 866 867 868 869 870
                    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
871

872 873 874 875 876 877 878
        begin
          yield
        ensure 
          self.scoped_methods.pop
        end
      end

D
David Heinemeier Hansson 已提交
879
      # Works like with_scope, but discards any nested properties.
880 881
      def with_exclusive_scope(method_scoping = {}, &block)
        with_scope(method_scoping, :overwrite, &block)
882
      end
D
Initial  
David Heinemeier Hansson 已提交
883

884 885 886
      # Overwrite the default class equality method to provide support for association proxies.
      def ===(object)
        object.is_a?(self)
887
      end      
888 889

      # Deprecated 
D
David Heinemeier Hansson 已提交
890
      def threaded_connections #:nodoc:
891 892 893 894
        allow_concurrency
      end

      # Deprecated 
D
David Heinemeier Hansson 已提交
895
      def threaded_connections=(value) #:nodoc:
896 897 898
        self.allow_concurrency = value
      end

899 900 901 902 903 904 905
      # 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

906 907 908 909 910 911 912 913 914
      # 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 已提交
915
      private
916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949
        def find_initial(options)
          options.update(:limit => 1) unless options[:include]
          find_every(options).first
        end
           
        def find_every(options)
          records = scoped?(:find, :include) || options[:include] ?
            find_with_associations(options) : 
            find_by_sql(construct_finder_sql(options))

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

          records
        end
 
        def find_from_ids(ids, options)
          expects_array = ids.first.kind_of?(Array)       
          return ids.first if expects_array && ids.first.empty?
        
          ids = ids.flatten.compact.uniq

          case ids.size
            when 0
              raise RecordNotFound, "Couldn't find #{name} without an ID"
            when 1
              result = find_one(ids.first, options)
              expects_array ? [ result ] : result
            else
              find_some(ids, options)
          end
        end
      
        def find_one(id, options)
          conditions = " AND (#{sanitize_sql(options[:conditions])})" if options[:conditions]
950
          options.update :conditions => "#{table_name}.#{primary_key} = #{sanitize(id)}#{conditions}"
951 952 953 954 955 956 957 958 959 960 961

          if result = find_initial(options)
            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]
          ids_list   = ids.map { |id| sanitize(id) }.join(',')
962
          options.update :conditions => "#{table_name}.#{primary_key} IN (#{ids_list})#{conditions}"
963 964 965 966 967 968 969 970 971 972

          result = find_every(options)

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

D
Initial  
David Heinemeier Hansson 已提交
973 974 975
        # 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.
        def instantiate(record)
976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993
          object = 
            if subclass_name = record[inheritance_column]
              if subclass_name.empty?
                allocate
              else
                require_association_class(subclass_name)
                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
              end
            else
              allocate
994
            end
995

D
Initial  
David Heinemeier Hansson 已提交
996
          object.instance_variable_set("@attributes", record)
997
          object
D
Initial  
David Heinemeier Hansson 已提交
998
        end
999

1000 1001
        # 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 已提交
1002
        def type_name_with_module(type_name)
1003
          "#{self.name.sub(/(::)?[^:]+$/, '')}#{$1}#{type_name}"
D
Initial  
David Heinemeier Hansson 已提交
1004 1005
        end

1006
        def construct_finder_sql(options)
1007 1008 1009
          scope = scope(:find)
          sql  = "SELECT #{(scope && scope[:select]) || options[:select] || '*'} "
          sql << "FROM #{(scope && scope[:from]) || options[:from] || table_name} "
1010

1011 1012
          add_joins!(sql, options, scope)
          add_conditions!(sql, options[:conditions], scope)
1013

1014
          sql << " GROUP BY #{options[:group]} " if options[:group]
1015
          sql << " ORDER BY #{options[:order]} " if options[:order]
1016

1017
          add_limit!(sql, options, scope)
1018

1019
          sql
1020
        end
1021

1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038
        # Merges includes so that the result is a valid +include+
        def merge_includes(first, second)
         safe_to_array(first) + safe_to_array(second)
        end

        # Object#to_a is deprecated, though it does have the desired behaviour
        def safe_to_array(o)
          case o
          when NilClass
            []
          when Array
            o
          else
            [o]
          end
        end

1039 1040 1041
        # The optional scope argument is for the current :find scope.
        def add_limit!(sql, options, scope = nil)
          if scope ||= scope(:find)
1042 1043 1044
            options[:limit]  ||= scope[:limit]
            options[:offset] ||= scope[:offset]
          end
1045
          connection.add_limit_offset!(sql, options)
1046
        end
1047

1048 1049 1050
        # The optional scope argument is for the current :find scope.
        def add_joins!(sql, options, scope = nil)
          scope ||= scope(:find)
1051
          join = (scope && scope[:joins]) || options[:joins]
1052 1053
          sql << " #{join} " if join
        end
1054

1055
        # Adds a sanitized version of +conditions+ to the +sql+ string. Note that the passed-in +sql+ string is changed.
1056 1057 1058
        # The optional scope argument is for the current :find scope.
        def add_conditions!(sql, conditions, scope = nil)
          scope  ||= scope(:find)
1059 1060
          segments = []
          segments << sanitize_sql(scope[:conditions]) if scope && scope[:conditions]
1061 1062 1063 1064
          segments << sanitize_sql(conditions) unless conditions.nil?
          segments << type_condition unless descends_from_active_record?        
          segments.compact!
          sql << "WHERE (#{segments.join(") AND (")}) " unless segments.empty?
D
Initial  
David Heinemeier Hansson 已提交
1065
        end
1066

D
Initial  
David Heinemeier Hansson 已提交
1067
        def type_condition
1068 1069 1070
          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}' "
1071
          end
1072 1073

          " (#{type_condition}) "
D
Initial  
David Heinemeier Hansson 已提交
1074 1075 1076
        end

        # Guesses the table name, but does not decorate it with prefix and suffix information.
1077
        def undecorated_table_name(class_name = base_class.name)
D
Initial  
David Heinemeier Hansson 已提交
1078 1079
          table_name = Inflector.underscore(Inflector.demodulize(class_name))
          table_name = Inflector.pluralize(table_name) if pluralize_table_names
1080
          table_name
D
Initial  
David Heinemeier Hansson 已提交
1081 1082
        end

1083 1084
        # 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])
1085
        # respectively. Also works for find(:all), but using find_all_by_amount(50) that are turned into find(:all, :conditions => ["amount = ?", 50]).
1086
        #
1087 1088
        # 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).
1089
        def method_missing(method_id, *arguments)
1090
          if match = /find_(all_by|by)_([_a-zA-Z]\w*)/.match(method_id.to_s)
1091
            finder, deprecated_finder = determine_finder(match), determine_deprecated_finder(match)
1092

1093 1094
            attribute_names = extract_attribute_names_from_match(match)
            super unless all_attributes_exists?(attribute_names)
1095

1096
            conditions = construct_conditions_from_arguments(attribute_names, arguments)
1097

1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114
            case extra_options = arguments[attribute_names.size]
              when nil
                options = { :conditions => conditions }
                set_readonly_option!(options)
                send(finder, options)

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

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

1117
              else
1118
                send(deprecated_finder, conditions, *arguments[attribute_names.length..-1]) # deprecated API
1119
            end
1120 1121 1122 1123
          elsif match = /find_or_create_by_([_a-zA-Z]\w*)/.match(method_id.to_s)
            attribute_names = extract_attribute_names_from_match(match)
            super unless all_attributes_exists?(attribute_names)

1124 1125 1126
            options = { :conditions => construct_conditions_from_arguments(attribute_names, arguments) }
            set_readonly_option!(options)
            find_initial(options) || create(construct_attributes_from_arguments(attribute_names, arguments))
1127 1128 1129 1130
          else
            super
          end
        end
D
Initial  
David Heinemeier Hansson 已提交
1131

1132
        def determine_finder(match)
1133 1134 1135 1136 1137
          match.captures.first == 'all_by' ? :find_every : :find_initial
        end

        def determine_deprecated_finder(match)
          match.captures.first == 'all_by' ? :find_all : :find_first
1138 1139 1140 1141 1142 1143 1144 1145
        end

        def extract_attribute_names_from_match(match)
          match.captures.last.split('_and_')
        end

        def construct_conditions_from_arguments(attribute_names, arguments)
          conditions = []
1146
          attribute_names.each_with_index { |name, idx| conditions << "#{table_name}.#{connection.quote_column_name(name)} #{attribute_condition(arguments[idx])} " }
1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159
          [ conditions.join(" AND "), *arguments[0...attribute_names.length] ]
        end
        
        def construct_attributes_from_arguments(attribute_names, arguments)
          attributes = {}
          attribute_names.each_with_index { |name, idx| attributes[name] = arguments[idx] }
          attributes
        end

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

1160 1161 1162 1163 1164 1165 1166 1167
        def attribute_condition(argument)
          case argument
            when nil   then "IS ?"
            when Array then "IN (?)"
            else            "= ?"
          end
        end

1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187
        # 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
1188
          sing.send :alias_method, "original_#{name}", name
1189 1190 1191
          if block_given?
            sing.send :define_method, name, &block
          else
1192 1193 1194 1195
            # 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
1196 1197
        end

D
Initial  
David Heinemeier Hansson 已提交
1198
      protected
D
David Heinemeier Hansson 已提交
1199
        def subclasses #:nodoc:
D
Initial  
David Heinemeier Hansson 已提交
1200 1201 1202
          @@subclasses[self] ||= []
          @@subclasses[self] + extra = @@subclasses[self].inject([]) {|list, subclass| list + subclass.subclasses }
        end
1203 1204

        # Test whether the given method and optional key are scoped.
D
David Heinemeier Hansson 已提交
1205
        def scoped?(method, key = nil) #:nodoc:
1206 1207 1208
          if current_scoped_methods && (scope = current_scoped_methods[method])
            !key || scope.has_key?(key)
          end
1209 1210 1211
        end

        # Retrieve the scope for the given method and optional key.
D
David Heinemeier Hansson 已提交
1212
        def scope(method, key = nil) #:nodoc:
1213
          if current_scoped_methods && (scope = current_scoped_methods[method])
1214 1215 1216 1217
            key ? scope[key] : scope
          end
        end

1218 1219 1220
        def thread_safe_scoped_methods #:nodoc:
          scoped_methods = (Thread.current[:scoped_methods] ||= {})
          scoped_methods[self] ||= []
1221
        end
1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233
        
        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 已提交
1234
        def current_scoped_methods #:nodoc:
1235
          scoped_methods.last
1236
        end
1237

1238 1239
        # 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 已提交
1240
        def compute_type(type_name)
1241
          modularized_name = type_name_with_module(type_name)
1242
          begin
1243 1244
            instance_eval(modularized_name)
          rescue NameError => e
1245
            instance_eval(type_name)
D
Initial  
David Heinemeier Hansson 已提交
1246 1247 1248
          end
        end

1249 1250
        # Returns the class descending directly from ActiveRecord in the inheritance hierarchy.
        def class_of_active_record_descendant(klass)
1251
          if klass.superclass == Base || klass.superclass.abstract_class?
1252
            klass
D
Initial  
David Heinemeier Hansson 已提交
1253 1254 1255
          elsif klass.superclass.nil?
            raise ActiveRecordError, "#{name} doesn't belong in a hierarchy descending from ActiveRecord"
          else
1256
            class_of_active_record_descendant(klass.superclass)
D
Initial  
David Heinemeier Hansson 已提交
1257 1258 1259
          end
        end

1260
        # Returns the name of the class descending directly from ActiveRecord in the inheritance hierarchy.
D
David Heinemeier Hansson 已提交
1261
        def class_name_of_active_record_descendant(klass) #:nodoc:
1262
          klass.base_class.name
1263 1264
        end

1265 1266 1267 1268 1269
        # Accepts an array or string.  The string is returned untouched, but the array has each value
        # sanitized and interpolated into the sql statement.
        #   ["name='%s' and group_id='%s'", "foo'bar", 4]  returns  "name='foo''bar' and group_id='4'"
        def sanitize_sql(ary)
          return ary unless ary.is_a?(Array)
1270

1271 1272 1273 1274
          statement, *values = ary
          if values.first.is_a?(Hash) and statement =~ /:\w+/
            replace_named_bind_variables(statement, values.first)
          elsif statement.include?('?')
1275 1276
            replace_bind_variables(statement, values)
          else
1277
            statement % values.collect { |value| connection.quote_string(value.to_s) }
1278
          end
1279 1280
        end

1281 1282
        alias_method :sanitize_conditions, :sanitize_sql

D
David Heinemeier Hansson 已提交
1283
        def replace_bind_variables(statement, values) #:nodoc:
1284
          raise_if_bind_arity_mismatch(statement, statement.count('?'), values.size)
1285
          bound = values.dup
1286
          statement.gsub('?') { quote_bound_value(bound.shift) }
1287 1288
        end

D
David Heinemeier Hansson 已提交
1289
        def replace_named_bind_variables(statement, bind_vars) #:nodoc:
1290 1291
          statement.gsub(/:(\w+)/) do
            match = $1.to_sym
1292
            if bind_vars.include?(match)
1293
              quote_bound_value(bind_vars[match])
1294 1295
            else
              raise PreparedStatementInvalid, "missing value for :#{match} in #{statement}"
1296 1297
            end
          end
1298 1299
        end

D
David Heinemeier Hansson 已提交
1300
        def quote_bound_value(value) #:nodoc:
1301 1302 1303 1304
          if (value.respond_to?(:map) && !value.is_a?(String))
            value.map { |v| connection.quote(v) }.join(',')
          else
            connection.quote(value)
1305 1306 1307
          end
        end

D
David Heinemeier Hansson 已提交
1308
        def raise_if_bind_arity_mismatch(statement, expected, provided) #:nodoc:
1309 1310 1311
          unless expected == provided
            raise PreparedStatementInvalid, "wrong number of bind variables (#{provided} for #{expected}) in: #{statement}"
          end
1312
        end
1313

D
David Heinemeier Hansson 已提交
1314
        def extract_options_from_args!(args) #:nodoc:
1315
          args.last.is_a?(Hash) ? args.pop : {}
1316
        end
1317

1318 1319 1320
        VALID_FIND_OPTIONS = [ :conditions, :include, :joins, :limit, :offset,
                               :order, :select, :readonly, :group, :from      ]
        
D
David Heinemeier Hansson 已提交
1321
        def validate_find_options(options) #:nodoc:
1322 1323 1324
          options.assert_valid_keys(VALID_FIND_OPTIONS)
        end
        
D
David Heinemeier Hansson 已提交
1325
        def set_readonly_option!(options) #:nodoc:
1326 1327 1328 1329 1330
          # Inherit :readonly from finder scope if set.  Otherwise,
          # if :joins is not blank then :readonly defaults to true.
          unless options.has_key?(:readonly)
            if scoped?(:find, :readonly)
              options[:readonly] = scope(:find, :readonly)
1331
            elsif !options[:joins].blank? && !options[:select]
1332 1333 1334
              options[:readonly] = true
            end
          end
D
Initial  
David Heinemeier Hansson 已提交
1335
        end
1336

D
David Heinemeier Hansson 已提交
1337
        def encode_quoted_value(value) #:nodoc:
1338
          quoted_value = connection.quote(value)
1339 1340
          quoted_value = "'#{quoted_value[1..-2].gsub(/\'/, "\\\\'")}'" if quoted_value.include?("\\\'") # (for ruby mode) " 
          quoted_value 
1341
        end
D
Initial  
David Heinemeier Hansson 已提交
1342 1343 1344 1345 1346
    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).
1347
      # In both instances, valid attribute keys are determined by the column names of the associated table --
D
Initial  
David Heinemeier Hansson 已提交
1348 1349 1350 1351 1352 1353 1354 1355
      # hence you can't have attributes that aren't part of the table columns.
      def initialize(attributes = nil)
        @attributes = attributes_from_column_definition
        @new_record = true
        ensure_proper_type
        self.attributes = attributes unless attributes.nil?
        yield self if block_given?
      end
1356

1357 1358
      # 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 已提交
1359
      def id
1360
        attr_name = self.class.primary_key
1361
        column = column_for_attribute(attr_name)
1362
        define_read_method(:id, attr_name, column) if self.class.generate_read_methods
1363
        read_attribute(attr_name)
D
Initial  
David Heinemeier Hansson 已提交
1364
      end
1365

1366 1367
      # Enables Active Record objects to be used as URL parameters in Action Pack automatically.
      alias_method :to_param, :id
1368

1369
      def id_before_type_cast #:nodoc:
1370 1371 1372
        read_attribute_before_type_cast(self.class.primary_key)
      end

1373
      def quoted_id #:nodoc:
1374
        quote(id, column_for_attribute(self.class.primary_key))
1375
      end
1376

D
Initial  
David Heinemeier Hansson 已提交
1377 1378 1379 1380
      # Sets the primary ID.
      def id=(value)
        write_attribute(self.class.primary_key, value)
      end
1381

D
Initial  
David Heinemeier Hansson 已提交
1382 1383 1384 1385
      # Returns true if this object hasn't been saved yet -- that is, a record for the object doesn't exist yet.
      def new_record?
        @new_record
      end
1386

D
Initial  
David Heinemeier Hansson 已提交
1387 1388 1389
      # * 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
1390
        raise ReadOnlyRecord if readonly?
D
Initial  
David Heinemeier Hansson 已提交
1391 1392
        create_or_update
      end
1393 1394 1395 1396
      
      # Attempts to save the record, but instead of just returning false if it couldn't happen, it raises a 
      # RecordNotSaved exception
      def save!
1397
        save || raise(RecordNotSaved)
1398
      end
1399

D
Initial  
David Heinemeier Hansson 已提交
1400 1401 1402 1403
      # 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
        unless new_record?
1404 1405 1406 1407
          connection.delete <<-end_sql, "#{self.class.name} Destroy"
            DELETE FROM #{self.class.table_name}
            WHERE #{self.class.primary_key} = #{quoted_id}
          end_sql
D
Initial  
David Heinemeier Hansson 已提交
1408 1409 1410 1411 1412
        end

        freeze
      end

J
Jeremy Kemper 已提交
1413 1414 1415 1416 1417
      # 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 已提交
1418
      def clone
1419
        attrs = self.attributes_before_type_cast
D
David Heinemeier Hansson 已提交
1420
        attrs.delete(self.class.primary_key)
1421 1422 1423
        self.class.new do |record|
          record.send :instance_variable_set, '@attributes', attrs
        end
D
Initial  
David Heinemeier Hansson 已提交
1424
      end
1425

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

1434
      # Updates all the attributes from the passed-in Hash and saves the record. If the object is invalid, the saving will
1435
      # fail and false will be returned.
1436
      def update_attributes(attributes)
1437
        self.attributes = attributes
1438
        save
D
Initial  
David Heinemeier Hansson 已提交
1439 1440
      end

1441 1442 1443 1444 1445 1446
      # 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
1447

1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463
      # 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
1464

1465 1466
      # Turns an +attribute+ that's currently true into false and vice versa. Returns self.
      def toggle(attribute)
1467
        self[attribute] = !send("#{attribute}?")
1468 1469 1470 1471 1472 1473 1474 1475
        self
      end

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

1476 1477
      # Reloads the attributes of this object from the database.
      def reload
1478
        clear_aggregation_cache
1479 1480
        clear_association_cache
        @attributes.update(self.class.find(self.id).instance_variable_get('@attributes'))
1481
        self
1482 1483
      end

1484
      # Returns the value of the attribute identified by <tt>attr_name</tt> after it has been typecast (for example,
D
Initial  
David Heinemeier Hansson 已提交
1485 1486
      # "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).
1487
      def [](attr_name)
1488
        read_attribute(attr_name)
D
Initial  
David Heinemeier Hansson 已提交
1489
      end
1490

D
Initial  
David Heinemeier Hansson 已提交
1491 1492
      # Updates the attribute identified by <tt>attr_name</tt> with the specified +value+.
      # (Alias for the protected write_attribute method).
1493
      def []=(attr_name, value)
1494
        write_attribute(attr_name, value)
D
Initial  
David Heinemeier Hansson 已提交
1495 1496 1497 1498 1499 1500 1501
      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 已提交
1502 1503 1504
      def attributes=(new_attributes)
        return if new_attributes.nil?
        attributes = new_attributes.dup
1505
        attributes.stringify_keys!
D
Initial  
David Heinemeier Hansson 已提交
1506 1507

        multi_parameter_attributes = []
1508
        remove_attributes_protected_from_mass_assignment(attributes).each do |k, v|
D
Initial  
David Heinemeier Hansson 已提交
1509 1510
          k.include?("(") ? multi_parameter_attributes << [ k, v ] : send(k + "=", v)
        end
D
David Heinemeier Hansson 已提交
1511

D
Initial  
David Heinemeier Hansson 已提交
1512 1513 1514
        assign_multiparameter_attributes(multi_parameter_attributes)
      end

D
David Heinemeier Hansson 已提交
1515

1516
      # Returns a hash of all the attributes with their names as keys and clones of their objects as values.
1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534
      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
1535 1536 1537 1538 1539
      end

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

D
Initial  
David Heinemeier Hansson 已提交
1542
      # Returns true if the specified +attribute+ has been set by the user or by a database load and is neither
1543
      # nil nor empty? (the latter only applies to objects that respond to empty?, most notably Strings).
D
Initial  
David Heinemeier Hansson 已提交
1544
      def attribute_present?(attribute)
1545 1546
        value = read_attribute(attribute)
        !value.blank? or value == 0
D
Initial  
David Heinemeier Hansson 已提交
1547 1548
      end

1549 1550 1551 1552 1553
      # 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 已提交
1554 1555 1556 1557 1558 1559 1560
      # 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)
1561
        self.class.columns_hash[name.to_s]
D
Initial  
David Heinemeier Hansson 已提交
1562
      end
1563

1564
      # 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 已提交
1565
      def ==(comparison_object)
1566 1567 1568 1569
        comparison_object.equal?(self) ||
          (comparison_object.instance_of?(self.class) && 
            comparison_object.id == id && 
            !comparison_object.new_record?)
D
Initial  
David Heinemeier Hansson 已提交
1570 1571 1572 1573 1574 1575
      end

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

D
Initial  
David Heinemeier Hansson 已提交
1577 1578 1579
      # 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
1580
        id.hash
D
Initial  
David Heinemeier Hansson 已提交
1581 1582 1583 1584 1585 1586 1587
      end

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

      # A Person object with a name attribute can ask person.respond_to?("name"), person.respond_to?("name="), and
      # person.respond_to?("name?") which will all return true.
1588
      def respond_to?(method, include_priv = false)
1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599
        if attr_name = self.class.column_methods_hash[method.to_sym]
          return true if @attributes.include?(attr_name) || attr_name == self.class.primary_key
          return false if self.class.read_methods.include?(attr_name)
        elsif @attributes.include?(method_name = method.to_s)
          return true
        elsif md = /(=|\?|_before_type_cast)$/.match(method_name)
          return true if @attributes.include?(md.pre_match)
        end
        # super must be called at the end of the method, because the inherited respond_to?
        # would return true for generated readers, even if the attribute wasn't present
        super
D
Initial  
David Heinemeier Hansson 已提交
1600
      end
1601

1602 1603
      # Just freeze the attributes hash, such that associations are still accessible even on destroyed records.
      def freeze
1604
        @attributes.freeze; self
1605
      end
1606

1607 1608 1609
      def frozen?
        @attributes.frozen?
      end
1610

D
David Heinemeier Hansson 已提交
1611
      # 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.
1612 1613 1614 1615
      def readonly?
        @readonly == true
      end

D
David Heinemeier Hansson 已提交
1616
      def readonly! #:nodoc:
1617 1618
        @readonly = true
      end
1619

1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641
      # Builds an XML document to represent the model.   Some configuration is
      # availble through +options+, however more complicated cases should use 
      # Builder.
      #
      # By default the generated XML document will include the processing 
      # instruction and all object's attributes.  For example:
      #    
      #   <?xml version="1.0" encoding="UTF-8"?>
      #   <topic>
      #     <title>The First Topic</title>
      #     <author-name>David</author-name>
      #     <id type="integer">1</id>
      #     <approved type="boolean">false</approved>
      #     <replies-count type="integer">0</replies-count>
      #     <bonus-time type="datetime">2000-01-01T08:28:00+12:00</bonus-time>
      #     <written-on type="datetime">2003-07-16T09:28:00+1200</written-on>
      #     <content>Have a nice day</content>
      #     <author-email-address>david@loudthinking.com</author-email-address>
      #     <parent-id></parent-id>
      #     <last-read type="date">2004-04-15</last-read>
      #   </topic>
      #
1642
      # This behaviour can be controlled with :only, :except, and :skip_instruct 
1643 1644
      # for instance:
      #
1645
      #   topic.to_xml(:skip_instruct => true, :except => [ :id, bonus_time, :written_on, replies_count ])
1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680
      #
      #   <topic>
      #     <title>The First Topic</title>
      #     <author-name>David</author-name>
      #     <approved type="boolean">false</approved>
      #     <content>Have a nice day</content>
      #     <author-email-address>david@loudthinking.com</author-email-address>
      #     <parent-id></parent-id>
      #     <last-read type="date">2004-04-15</last-read>
      #   </topic>
      # 
      # To include first level associations use :include
      #
      #   firm.to_xml :include => [ :account, :clients ]
      #
      #   <?xml version="1.0" encoding="UTF-8"?>
      #   <firm>
      #     <id type="integer">1</id>
      #     <rating type="integer">1</rating>
      #     <name>37signals</name>
      #     <clients>
      #       <client>
      #         <rating type="integer">1</rating>
      #         <name>Summit</name>
      #       </client>
      #       <client>
      #         <rating type="integer">1</rating>
      #         <name>Microsoft</name>
      #       </client>
      #     </clients>
      #     <account>
      #       <id type="integer">1</id>
      #       <credit-limit type="integer">50</credit-limit>
      #     </account>
      #   </firm>
1681
      def to_xml(options = {})
1682
        options[:root]    ||= self.class.to_s.underscore
D
David Heinemeier Hansson 已提交
1683
        options[:except]    = Array(options[:except]) << self.class.inheritance_column unless options[:only] # skip type column
1684
        root_only_or_except = { :only => options[:only], :except => options[:except] }
1685

1686
        attributes_for_xml = attributes(root_only_or_except)
1687 1688
        
        if include_associations = options.delete(:include)
1689 1690 1691 1692 1693
          include_has_options = include_associations.is_a?(Hash)
          
          for association in include_has_options ? include_associations.keys : Array(include_associations)
            association_options = include_has_options ? include_associations[association] : root_only_or_except

1694 1695 1696 1697 1698
            case self.class.reflect_on_association(association).macro
              when :has_many, :has_and_belongs_to_many
                records = send(association).to_a
                unless records.empty?
                  attributes_for_xml[association] = records.collect do |record| 
1699
                    record.attributes(association_options)
1700 1701 1702 1703
                  end
                end
              when :has_one, :belongs_to
                if record = send(association)
1704
                  attributes_for_xml[association] = record.attributes(association_options)
1705 1706 1707 1708
                end
            end
          end
        end
1709

1710
        attributes_for_xml.to_xml(options)
1711
      end
1712

D
Initial  
David Heinemeier Hansson 已提交
1713 1714 1715 1716 1717
    private
      def create_or_update
        if new_record? then create else update end
      end

1718
      # Updates the associated record with values matching those of the instance attributes.
D
Initial  
David Heinemeier Hansson 已提交
1719 1720 1721
      def update
        connection.update(
          "UPDATE #{self.class.table_name} " +
1722
          "SET #{quoted_comma_pair_list(connection, attributes_with_quotes(false))} " +
1723
          "WHERE #{self.class.primary_key} = #{quote(id)}",
D
Initial  
David Heinemeier Hansson 已提交
1724 1725
          "#{self.class.name} Update"
        )
1726 1727
        
        return true
D
Initial  
David Heinemeier Hansson 已提交
1728 1729
      end

1730
      # Creates a new record with values matching those of the instance attributes.
D
Initial  
David Heinemeier Hansson 已提交
1731
      def create
1732
        if self.id.nil? && connection.prefetch_primary_key?(self.class.table_name)
1733 1734 1735
          self.id = connection.next_sequence_value(self.class.sequence_name)
        end

D
Initial  
David Heinemeier Hansson 已提交
1736 1737 1738 1739 1740
        self.id = connection.insert(
          "INSERT INTO #{self.class.table_name} " +
          "(#{quoted_column_names.join(', ')}) " +
          "VALUES(#{attributes_with_quotes.values.join(', ')})",
          "#{self.class.name} Create",
1741
          self.class.primary_key, self.id, self.class.sequence_name
D
Initial  
David Heinemeier Hansson 已提交
1742
        )
1743

D
Initial  
David Heinemeier Hansson 已提交
1744
        @new_record = false
1745 1746
        
        return true
D
Initial  
David Heinemeier Hansson 已提交
1747 1748
      end

1749
      # Sets the attribute used for single table inheritance to this class name if this is not the ActiveRecord descendent.
1750 1751
      # 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 已提交
1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762
      # 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

      # Allows access to the object attributes, which are held in the @attributes hash, as were
      # they first-class methods. So a Person class with a name attribute can use Person#name and
      # Person#name= and never directly use the attributes hash -- except for multiple assigns with
      # ActiveRecord#attributes=. A Milestone class can also ask Milestone#completed? to test that
1763
      # the completed attribute is not nil or 0.
D
Initial  
David Heinemeier Hansson 已提交
1764 1765 1766
      #
      # It's also possible to instantiate related objects, so a Client class belonging to the clients
      # table with a master_id foreign key can instantiate master through Client#master.
1767 1768
      def method_missing(method_id, *args, &block)
        method_name = method_id.to_s
1769 1770 1771
        if @attributes.include?(method_name) or
            (md = /\?$/.match(method_name) and
            @attributes.include?(method_name = md.pre_match))
1772
          define_read_methods if self.class.read_methods.empty? && self.class.generate_read_methods
1773
          md ? query_attribute(method_name) : read_attribute(method_name)
1774 1775
        elsif self.class.primary_key.to_s == method_name
          id
1776
        elsif md = /(=|_before_type_cast)$/.match(method_name)
1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787
          attribute_name, method_type = md.pre_match, md.to_s
          if @attributes.include?(attribute_name)
            case method_type
              when '='
                write_attribute(attribute_name, args.first)
              when '_before_type_cast'
                read_attribute_before_type_cast(attribute_name)
            end
          else
            super
          end
D
Initial  
David Heinemeier Hansson 已提交
1788 1789 1790 1791 1792
        else
          super
        end
      end

1793
      # Returns the value of the attribute identified by <tt>attr_name</tt> after it has been typecast (for example,
D
Initial  
David Heinemeier Hansson 已提交
1794
      # "2004-12-12" in a data column is cast to a date object, like Date.new(2004, 12, 12)).
1795
      def read_attribute(attr_name)
1796
        attr_name = attr_name.to_s
1797
        if !(value = @attributes[attr_name]).nil?
D
Initial  
David Heinemeier Hansson 已提交
1798
          if column = column_for_attribute(attr_name)
1799 1800 1801
            if unserializable_attribute?(attr_name, column)
              unserialize_attribute(attr_name)
            else
1802
              column.type_cast(value)
1803
            end
1804
          else
1805
            value
D
Initial  
David Heinemeier Hansson 已提交
1806 1807 1808 1809 1810 1811
          end
        else
          nil
        end
      end

1812 1813 1814 1815
      def read_attribute_before_type_cast(attr_name)
        @attributes[attr_name]
      end

1816 1817 1818 1819 1820
      # Called on first read access to any given column and generates reader
      # methods for all columns in the columns_hash if
      # ActiveRecord::Base.generate_read_methods is set to true.
      def define_read_methods
        self.class.columns_hash.each do |name, column|
1821 1822 1823
          unless self.class.serialized_attributes[name]
            define_read_method(name.to_sym, name, column) unless respond_to_without_attributes?(name)
            define_question_method(name)     unless respond_to_without_attributes?("#{name}?")
1824 1825 1826 1827
          end
        end
      end

1828
      # Define an attribute reader method.  Cope with nil column.
1829
      def define_read_method(symbol, attr_name, column)
1830
        cast_code = column.type_cast_code('v') if column
1831
        access_code = cast_code ? "(v=@attributes['#{attr_name}']) && #{cast_code}" : "@attributes['#{attr_name}']"
1832
        
1833
        unless attr_name.to_s == self.class.primary_key.to_s
1834
          access_code = access_code.insert(0, "raise NoMethodError, 'missing attribute: #{attr_name}', caller unless @attributes.has_key?('#{attr_name}'); ")
1835
          self.class.read_methods << attr_name
1836 1837 1838 1839 1840 1841 1842 1843
        end
        
        evaluate_read_method attr_name, "def #{symbol}; #{access_code}; end"
      end
      
      # Define an attribute ? method.
      def define_question_method(attr_name)
        unless attr_name.to_s == self.class.primary_key.to_s
1844
          self.class.read_methods << "#{attr_name}?"
1845
        end
1846 1847 1848 1849 1850 1851
        
        evaluate_read_method attr_name, "def #{attr_name}?; query_attribute('#{attr_name}'); end"
      end
      
      # Evaluate the definition for an attribute reader or ? method
      def evaluate_read_method(attr_name, method_definition)
1852
        begin
1853
          self.class.class_eval(method_definition)
1854 1855 1856 1857 1858 1859 1860 1861
        rescue SyntaxError => err
          self.class.read_methods.delete(attr_name)
          if logger
            logger.warn "Exception occured during reader method compilation."
            logger.warn "Maybe #{attr_name} is not a valid Ruby identifier?"
            logger.warn "#{err.message}"
          end
        end
1862 1863
      end

D
Initial  
David Heinemeier Hansson 已提交
1864 1865
      # Returns true if the attribute is of a text column and marked for serialization.
      def unserializable_attribute?(attr_name, column)
1866
        column.text? && self.class.serialized_attributes[attr_name]
D
Initial  
David Heinemeier Hansson 已提交
1867 1868 1869 1870 1871 1872 1873 1874 1875
      end

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

        if unserialized_object.is_a?(self.class.serialized_attributes[attr_name])
          @attributes[attr_name] = unserialized_object
        else
1876
          raise SerializationTypeMismatch,
1877
            "#{attr_name} was supposed to be a #{self.class.serialized_attributes[attr_name]}, but was a #{unserialized_object.class.to_s}"
D
Initial  
David Heinemeier Hansson 已提交
1878 1879 1880 1881 1882
        end
      end

      # Updates the attribute identified by <tt>attr_name</tt> with the specified +value+. Empty strings for fixnum and float
      # columns are turned into nil.
1883
      def write_attribute(attr_name, value)
1884 1885 1886 1887 1888 1889
        attr_name = attr_name.to_s
        if (column = column_for_attribute(attr_name)) && column.number?
          @attributes[attr_name] = convert_number_column_value(value)
        else
          @attributes[attr_name] = value
        end
D
Initial  
David Heinemeier Hansson 已提交
1890 1891
      end

1892 1893 1894 1895 1896 1897 1898
      def convert_number_column_value(value)
        case value
          when FalseClass: 0
          when TrueClass:  1
          when '':         nil
          else value
        end
D
Initial  
David Heinemeier Hansson 已提交
1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923
      end

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

      def remove_attributes_protected_from_mass_assignment(attributes)
        if self.class.accessible_attributes.nil? && self.class.protected_attributes.nil?
1924
          attributes.reject { |key, value| attributes_protected_by_default.include?(key.gsub(/\(.+/, "")) }
D
Initial  
David Heinemeier Hansson 已提交
1925
        elsif self.class.protected_attributes.nil?
1926
          attributes.reject { |key, value| !self.class.accessible_attributes.include?(key.gsub(/\(.+/, "").intern) || attributes_protected_by_default.include?(key.gsub(/\(.+/, "")) }
D
Initial  
David Heinemeier Hansson 已提交
1927
        elsif self.class.accessible_attributes.nil?
1928
          attributes.reject { |key, value| self.class.protected_attributes.include?(key.gsub(/\(.+/,"").intern) || attributes_protected_by_default.include?(key.gsub(/\(.+/, "")) }
D
Initial  
David Heinemeier Hansson 已提交
1929 1930 1931
        end
      end

1932 1933
      # The primary key and inheritance column can never be set by mass-assignment for security reasons.
      def attributes_protected_by_default
1934 1935 1936
        default = [ self.class.primary_key, self.class.inheritance_column ]
        default << 'id' unless self.class.primary_key.eql? 'id'
        default
1937 1938
      end

D
Initial  
David Heinemeier Hansson 已提交
1939
      # Returns copy of the attributes hash where all the values have been safely quoted for use in
1940
      # an SQL statement.
1941
      def attributes_with_quotes(include_primary_key = true)
1942
        attributes.inject({}) do |quoted, (name, value)|
1943
          if column = column_for_attribute(name)
1944
            quoted[name] = quote(value, column) unless !include_primary_key && column.primary
1945 1946
          end
          quoted
D
Initial  
David Heinemeier Hansson 已提交
1947 1948
        end
      end
1949

D
Initial  
David Heinemeier Hansson 已提交
1950 1951
      # Quote strings appropriately for SQL statements.
      def quote(value, column = nil)
1952
        self.class.connection.quote(value, column)
D
Initial  
David Heinemeier Hansson 已提交
1953 1954 1955 1956 1957
      end

      # Interpolate custom sql string in instance context.
      # Optional record argument is meant for custom insert_sql.
      def interpolate_sql(sql, record = nil)
1958
        instance_eval("%@#{sql.gsub('@', '\@')}@")
D
Initial  
David Heinemeier Hansson 已提交
1959 1960 1961 1962 1963 1964 1965
      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
1966
        self.class.columns.inject({}) do |attributes, column|
1967
          attributes[column.name] = column.default unless column.name == self.class.primary_key
D
Initial  
David Heinemeier Hansson 已提交
1968 1969 1970 1971 1972 1973 1974 1975
          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
1976
      # 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 已提交
1977 1978 1979 1980 1981 1982
      # 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
1983

D
Initial  
David Heinemeier Hansson 已提交
1984 1985
      # 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)
1986
        errors = []
D
Initial  
David Heinemeier Hansson 已提交
1987 1988 1989 1990 1991
        callstack.each do |name, values|
          klass = (self.class.reflect_on_aggregation(name) || column_for_attribute(name)).klass
          if values.empty?
            send(name + "=", nil)
          else
1992 1993 1994 1995 1996
            begin
              send(name + "=", Time == klass ? klass.local(*values) : klass.new(*values))
            rescue => ex
              errors << AttributeAssignmentError.new("error on assignment #{values.inspect} to #{name}", ex, name)
            end
D
Initial  
David Heinemeier Hansson 已提交
1997 1998
          end
        end
1999 2000 2001
        unless errors.empty?
          raise MultiparameterAssignmentErrors.new(errors), "#{errors.size} error(s) on assignment of multiparameter attributes"
        end
D
Initial  
David Heinemeier Hansson 已提交
2002
      end
2003

D
Initial  
David Heinemeier Hansson 已提交
2004 2005 2006 2007 2008 2009 2010 2011 2012
      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?
2013
            attributes[attribute_name] <<
2014
              [ find_parameter_position(multiparameter_name), type_cast_attribute_value(multiparameter_name, value) ]
D
Initial  
David Heinemeier Hansson 已提交
2015 2016 2017 2018 2019
          end
        end

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

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

D
Initial  
David Heinemeier Hansson 已提交
2025 2026 2027
      def find_parameter_position(multiparameter_name)
        multiparameter_name.scan(/\(([0-9]*).*\)/).first.first
      end
2028

D
Initial  
David Heinemeier Hansson 已提交
2029 2030 2031 2032 2033 2034
      # 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)
2035 2036 2037
        attributes.keys.collect do |column_name|
          self.class.connection.quote_column_name(column_name)
        end
D
Initial  
David Heinemeier Hansson 已提交
2038 2039
      end

2040 2041 2042 2043
      def quote_columns(quoter, hash)
        hash.inject({}) do |quoted, (name, value)|
          quoted[quoter.quote_column_name(name)] = value
          quoted
2044
        end
D
Initial  
David Heinemeier Hansson 已提交
2045 2046
      end

2047 2048
      def quoted_comma_pair_list(quoter, hash)
        comma_pair_list(quote_columns(quoter, hash))
D
Initial  
David Heinemeier Hansson 已提交
2049 2050 2051
      end

      def object_from_yaml(string)
2052
        return string unless string.is_a?(String)
2053
        YAML::load(string) rescue string
D
Initial  
David Heinemeier Hansson 已提交
2054
      end
2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068

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

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