base.rb 90.1 KB
Newer Older
1 2 3 4 5
begin
  require 'psych'
rescue LoadError
end

D
Initial  
David Heinemeier Hansson 已提交
6
require 'yaml'
7
require 'set'
J
José Valim 已提交
8
require 'active_support/benchmarkable'
J
Jeremy Kemper 已提交
9
require 'active_support/dependencies'
10
require 'active_support/descendants_tracker'
11
require 'active_support/time'
12
require 'active_support/core_ext/class/attribute'
J
Jeremy Kemper 已提交
13 14
require 'active_support/core_ext/class/attribute_accessors'
require 'active_support/core_ext/class/delegating_attributes'
15
require 'active_support/core_ext/class/attribute'
J
Jeremy Kemper 已提交
16 17 18 19 20
require 'active_support/core_ext/array/extract_options'
require 'active_support/core_ext/hash/deep_merge'
require 'active_support/core_ext/hash/indifferent_access'
require 'active_support/core_ext/hash/slice'
require 'active_support/core_ext/string/behavior'
21
require 'active_support/core_ext/kernel/singleton_class'
22
require 'active_support/core_ext/module/delegation'
23
require 'active_support/core_ext/module/introspection'
24
require 'active_support/core_ext/object/duplicable'
25
require 'active_support/core_ext/object/blank'
26
require 'active_support/deprecation'
27 28
require 'arel'
require 'active_record/errors'
29
require 'active_record/log_subscriber'
D
Initial  
David Heinemeier Hansson 已提交
30 31

module ActiveRecord #:nodoc:
32
  # = Active Record
33
  #
34 35 36
  # Active Record objects don't specify their attributes directly, but rather infer them from
  # the table definition with 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
37
  # Active Record objects. The mapping that binds a given Active Record class to a certain
38 39
  # database table will happen automatically in most common cases, but can be overwritten for the uncommon ones.
  #
40
  # See the mapping rules in table_name and the full example in link:files/activerecord/README_rdoc.html for more insight.
41
  #
D
Initial  
David Heinemeier Hansson 已提交
42
  # == Creation
43
  #
44 45
  # Active Records accept constructor parameters either in a hash or as a block. The hash
  # method is especially useful when you're receiving the data from somewhere else, like an
46
  # HTTP request. It works like this:
47
  #
48
  #   user = User.new(:name => "David", :occupation => "Code Artist")
D
Initial  
David Heinemeier Hansson 已提交
49
  #   user.name # => "David"
50
  #
D
Initial  
David Heinemeier Hansson 已提交
51
  # You can also use block initialization:
52
  #
D
Initial  
David Heinemeier Hansson 已提交
53 54 55 56
  #   user = User.new do |u|
  #     u.name = "David"
  #     u.occupation = "Code Artist"
  #   end
57
  #
D
Initial  
David Heinemeier Hansson 已提交
58
  # And of course you can just create a bare object and specify the attributes after the fact:
59
  #
D
Initial  
David Heinemeier Hansson 已提交
60 61 62
  #   user = User.new
  #   user.name = "David"
  #   user.occupation = "Code Artist"
63
  #
D
Initial  
David Heinemeier Hansson 已提交
64
  # == Conditions
65
  #
66
  # Conditions can either be specified as a string, array, or hash representing the WHERE-part of an SQL statement.
67 68 69
  # The array form is to be used when the condition input is tainted and requires sanitization. The string form can
  # be used for statements that don't involve tainted data. The hash form works much like the array form, except
  # only equality and range is possible. Examples:
70
  #
71
  #   class User < ActiveRecord::Base
D
Initial  
David Heinemeier Hansson 已提交
72
  #     def self.authenticate_unsafely(user_name, password)
73
  #       where("user_name = '#{user_name}' AND password = '#{password}'").first
D
Initial  
David Heinemeier Hansson 已提交
74
  #     end
75
  #
D
Initial  
David Heinemeier Hansson 已提交
76
  #     def self.authenticate_safely(user_name, password)
77
  #       where("user_name = ? AND password = ?", user_name, password).first
D
Initial  
David Heinemeier Hansson 已提交
78
  #     end
79 80
  #
  #     def self.authenticate_safely_simply(user_name, password)
81
  #       where(:user_name => user_name, :password => password).first
82
  #     end
D
Initial  
David Heinemeier Hansson 已提交
83
  #   end
84
  #
85 86
  # The <tt>authenticate_unsafely</tt> method inserts the parameters directly into the query
  # and is thus susceptible to SQL-injection attacks if the <tt>user_name</tt> and +password+
S
Sebastian Martinez 已提交
87
  # parameters come directly from an HTTP request. The <tt>authenticate_safely</tt> and
88 89
  # <tt>authenticate_safely_simply</tt> both will sanitize the <tt>user_name</tt> and +password+
  # before inserting them in the query, which will ensure that an attacker can't escape the
90
  # query and fake the login (or worse).
91
  #
92 93 94
  # When using multiple parameters in the conditions, it can easily become hard to read exactly
  # what the fourth or fifth question mark is supposed to represent. In those cases, you can
  # resort to named bind variables instead. That's done by replacing the question marks with
95
  # symbols and supplying a hash with values for the matching symbol keys:
96
  #
97
  #   Company.where(
98
  #     "id = :id AND name = :name AND division = :division AND created_at > :accounting_date",
99
  #     { :id => 3, :name => "37signals", :division => "First", :accounting_date => '2005-01-01' }
100
  #   ).first
101
  #
102 103 104
  # Similarly, a simple hash without a statement will generate conditions based on equality with the SQL AND
  # operator. For instance:
  #
105 106
  #   Student.where(:first_name => "Harvey", :status => 1)
  #   Student.where(params[:student])
107
  #
108 109
  # A range may be used in the hash to use the SQL BETWEEN operator:
  #
110
  #   Student.where(:grade => 9..12)
111
  #
P
Pratik Naik 已提交
112 113
  # An array may be used in the hash to use the SQL IN operator:
  #
114
  #   Student.where(:grade => [9,11,12])
P
Pratik Naik 已提交
115
  #
116
  # When joining tables, nested hashes or keys written in the form 'table_name.column_name'
117
  # can be used to qualify the table name of a particular condition. For instance:
P
Pratik Naik 已提交
118
  #
119 120
  #   Student.joins(:schools).where(:schools => { :category => 'public' })
  #   Student.joins(:schools).where('schools.category' => 'public' )
P
Pratik Naik 已提交
121
  #
D
Initial  
David Heinemeier Hansson 已提交
122
  # == Overwriting default accessors
123
  #
124 125 126 127
  # All column values are automatically available through basic accessors on the Active Record
  # object, but sometimes you want to specialize this behavior. This can be done by overwriting
  # the default accessors (using the same name as the attribute) and calling
  # <tt>read_attribute(attr_name)</tt> and <tt>write_attribute(attr_name, value)</tt> to actually
128
  # change things.
129
  #
D
Initial  
David Heinemeier Hansson 已提交
130 131
  #   class Song < ActiveRecord::Base
  #     # Uses an integer of seconds to hold the length of the song
132
  #
D
Initial  
David Heinemeier Hansson 已提交
133
  #     def length=(minutes)
134
  #       write_attribute(:length, minutes.to_i * 60)
D
Initial  
David Heinemeier Hansson 已提交
135
  #     end
136
  #
D
Initial  
David Heinemeier Hansson 已提交
137
  #     def length
138
  #       read_attribute(:length) / 60
D
Initial  
David Heinemeier Hansson 已提交
139 140
  #     end
  #   end
141
  #
142
  # You can alternatively use <tt>self[:attribute]=(value)</tt> and <tt>self[:attribute]</tt>
143
  # instead of <tt>write_attribute(:attribute, value)</tt> and <tt>read_attribute(:attribute)</tt>.
144
  #
145 146 147 148
  # == Attribute query methods
  #
  # In addition to the basic accessors, query methods are also automatically available on the Active Record object.
  # Query methods allow you to test whether an attribute value is present.
149
  #
150 151 152 153 154 155 156 157 158
  # For example, an Active Record User with the <tt>name</tt> attribute has a <tt>name?</tt> method that you can call
  # to determine whether the user has a name:
  #
  #   user = User.new(:name => "David")
  #   user.name? # => true
  #
  #   anonymous = User.new(:name => "")
  #   anonymous.name? # => false
  #
159
  # == Accessing attributes before they have been typecasted
160
  #
161 162 163
  # Sometimes you want to be able to read the raw attribute data without having the column-determined
  # typecast run its course first. That can be done by using the <tt><attribute>_before_type_cast</tt>
  # accessors that all attributes have. For example, if your Account model has a <tt>balance</tt> attribute,
164
  # you can call <tt>account.balance_before_type_cast</tt> or <tt>account.id_before_type_cast</tt>.
165
  #
166 167
  # This is especially useful in validation situations where the user might supply a string for an
  # integer field and you want to display the original string back in an error message. Accessing the
168
  # attribute normally would typecast the string to 0, which isn't what you want.
169
  #
170 171
  # == Dynamic attribute-based finders
  #
172 173 174 175 176
  # Dynamic attribute-based finders are a cleaner way of getting (and/or creating) objects
  # by simple queries without turning to SQL. They work by appending the name of an attribute
  # to <tt>find_by_</tt>, <tt>find_last_by_</tt>, or <tt>find_all_by_</tt> and thus produces finders
  # like <tt>Person.find_by_user_name</tt>, <tt>Person.find_all_by_last_name</tt>, and
  # <tt>Payment.find_by_transaction_id</tt>. Instead of writing
177
  # <tt>Person.where(:user_name => user_name).first</tt>, you just do <tt>Person.find_by_user_name(user_name)</tt>.
178
  # And instead of writing <tt>Person.where(:last_name => last_name).all</tt>, you just do
179
  # <tt>Person.find_all_by_last_name(last_name)</tt>.
180
  #
181
  # It's possible to add an exclamation point (!) on the end of the dynamic finders to get them to raise an
182
  # <tt>ActiveRecord::RecordNotFound</tt> error if they do not return any records,
183 184
  # like <tt>Person.find_by_last_name!</tt>.
  #
185
  # It's also possible to use multiple attributes in the same find by separating them with "_and_".
186
  #
187
  #  Person.where(:user_name => user_name, :password => password).first
188
  #  Person.find_by_user_name_and_password(user_name, password) # with dynamic finder
189
  #
190
  # It's even possible to call these dynamic finder methods on relations and named scopes.
191 192 193
  #
  #   Payment.order("created_on").find_all_by_amount(50)
  #   Payment.pending.find_last_by_amount(100)
194
  #
195 196 197 198
  # 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. Protected attributes won't be set
  # unless they are given in a block.
199 200 201
  #
  #   # No 'Summer' tag exists
  #   Tag.find_or_create_by_name("Summer") # equal to Tag.create(:name => "Summer")
202
  #
203 204 205
  #   # Now the 'Summer' tag does exist
  #   Tag.find_or_create_by_name("Summer") # equal to Tag.find_by_name("Summer")
  #
206 207 208
  #   # Now 'Bob' exist and is an 'admin'
  #   User.find_or_create_by_name('Bob', :age => 40) { |u| u.admin = true }
  #
209
  # Use the <tt>find_or_initialize_by_</tt> finder if you want to return a new record without
210
  # saving it first. Protected attributes won't be set unless they are given in a block.
211 212 213
  #
  #   # No 'Winter' tag exists
  #   winter = Tag.find_or_initialize_by_name("Winter")
214
  #   winter.persisted? # false
215
  #
216
  # To find by a subset of the attributes to be used for instantiating a new object, pass a hash instead of
217
  # a list of parameters.
218 219 220
  #
  #   Tag.find_or_create_by_name(:name => "rails", :creator => current_user)
  #
221
  # That will either find an existing tag named "rails", or create a new one while setting the
222
  # user that created it.
223
  #
224 225 226 227
  # Just like <tt>find_by_*</tt>, you can also use <tt>scoped_by_*</tt> to retrieve data. The good thing about
  # using this feature is that the very first time result is returned using <tt>method_missing</tt> technique
  # but after that the method is declared on the class. Henceforth <tt>method_missing</tt> will not be hit.
  #
228
  #  User.scoped_by_user_name('David')
229
  #
230
  # == Saving arrays, hashes, and other non-mappable objects in text columns
231
  #
232
  # Active Record can serialize any object in text columns using YAML. To do so, you must
233
  # specify this with a call to the class method +serialize+.
234 235
  # This makes it possible to store arrays, hashes, and other non-mappable objects without doing
  # any additional work.
236
  #
D
Initial  
David Heinemeier Hansson 已提交
237 238 239
  #   class User < ActiveRecord::Base
  #     serialize :preferences
  #   end
240
  #
241
  #   user = User.create(:preferences => { "background" => "black", "display" => large })
D
Initial  
David Heinemeier Hansson 已提交
242
  #   User.find(user.id).preferences # => { "background" => "black", "display" => large }
243
  #
244
  # You can also specify a class option as the second parameter that'll raise an exception
245
  # if a serialized object is retrieved as a descendant of a class not in the hierarchy.
246
  #
D
Initial  
David Heinemeier Hansson 已提交
247
  #   class User < ActiveRecord::Base
248
  #     serialize :preferences, Hash
D
Initial  
David Heinemeier Hansson 已提交
249
  #   end
250
  #
251
  #   user = User.create(:preferences => %w( one two three ))
D
Initial  
David Heinemeier Hansson 已提交
252
  #   User.find(user.id).preferences    # raises SerializationTypeMismatch
253
  #
254 255 256 257 258 259 260 261 262 263 264
  # When you specify a class option, the default value for that attribute will be a new
  # instance of that class.
  #
  #   class User < ActiveRecord::Base
  #     serialize :preferences, OpenStruct
  #   end
  #
  #   user = User.new
  #   user.preferences.theme_color = "red"
  #
  #
D
Initial  
David Heinemeier Hansson 已提交
265 266
  # == Single table inheritance
  #
267 268
  # Active Record allows inheritance by storing the name of the class in a column that by
  # default is named "type" (can be changed by overwriting <tt>Base.inheritance_column</tt>).
269
  # This means that an inheritance looking like this:
D
Initial  
David Heinemeier Hansson 已提交
270 271 272 273 274 275
  #
  #   class Company < ActiveRecord::Base; end
  #   class Firm < Company; end
  #   class Client < Company; end
  #   class PriorityClient < Client; end
  #
276 277
  # When you do <tt>Firm.create(:name => "37signals")</tt>, this record will be saved in
  # the companies table with type = "Firm". You can then fetch this row again using
278
  # <tt>Company.where(:name => '37signals').first</tt> and it will return a Firm object.
D
Initial  
David Heinemeier Hansson 已提交
279
  #
280 281
  # 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
282
  # for differentiating between them or reloading the right type with find.
283
  #
D
Initial  
David Heinemeier Hansson 已提交
284 285
  # Note, all the attributes for all the cases are kept in the same table. Read more:
  # http://www.martinfowler.com/eaaCatalog/singleTableInheritance.html
286
  #
D
Initial  
David Heinemeier Hansson 已提交
287 288
  # == Connection to multiple databases in different models
  #
289 290 291
  # Connections are usually created through ActiveRecord::Base.establish_connection and retrieved
  # by ActiveRecord::Base.connection. All classes inheriting from ActiveRecord::Base will use this
  # connection. But you can also set a class-specific connection. For example, if Course is an
292
  # ActiveRecord::Base, but resides in a different database, you can just say <tt>Course.establish_connection</tt>
P
Pratik Naik 已提交
293
  # and Course and all of its subclasses will use this connection instead.
D
Initial  
David Heinemeier Hansson 已提交
294
  #
295 296
  # 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
297
  # will go up the class-hierarchy until a connection is found in the connection pool.
D
Initial  
David Heinemeier Hansson 已提交
298 299
  #
  # == Exceptions
300
  #
P
Pratik Naik 已提交
301 302
  # * ActiveRecordError - Generic error class and superclass of all other errors raised by Active Record.
  # * AdapterNotSpecified - The configuration hash used in <tt>establish_connection</tt> didn't include an
D
Initial  
David Heinemeier Hansson 已提交
303
  #   <tt>:adapter</tt> key.
304
  # * AdapterNotFound - The <tt>:adapter</tt> key used in <tt>establish_connection</tt> specified a
305
  #   non-existent adapter
306
  #   (or a bad spelling of an existing one).
307
  # * AssociationTypeMismatch - The object assigned to the association wasn't of the type
308
  #   specified in the association definition.
P
Pratik Naik 已提交
309
  # * SerializationTypeMismatch - The serialized object wasn't of the class specified as the second parameter.
310
  # * ConnectionNotEstablished+ - No connection has been established. Use <tt>establish_connection</tt>
311
  #   before querying.
P
Pratik Naik 已提交
312 313 314 315 316
  # * RecordNotFound - No record responded to the +find+ method. Either the row with the given ID doesn't exist
  #   or the row didn't meet the additional restrictions. Some +find+ calls do not raise this exception to signal
  #   nothing was found, please check its documentation for further details.
  # * StatementInvalid - The database server rejected the SQL statement. The precise error is added in the message.
  # * MultiparameterAssignmentErrors - Collection of errors that occurred during a mass assignment using the
317
  #   <tt>attributes=</tt> method. The +errors+ property of this exception contains an array of
318
  #   AttributeAssignmentError
319
  #   objects that should be inspected to determine which attributes triggered the errors.
320
  # * AttributeAssignmentError - An error occurred while doing a mass assignment through the
321
  #   <tt>attributes=</tt> method.
322
  #   You can inspect the +attribute+ property of the exception object to determine which attribute
323
  #   triggered the error.
324
  #
325
  # *Note*: The attributes listed are class-level attributes (accessible from both the class and instance level).
P
Pratik Naik 已提交
326
  # So it's possible to assign a logger to the class through <tt>Base.logger=</tt> which will then be used by all
D
Initial  
David Heinemeier Hansson 已提交
327 328
  # instances in the current object space.
  class Base
E
Emilio Tagua 已提交
329
    ##
P
Pratik Naik 已提交
330
    # :singleton-method:
331 332
    # 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
333
    # a class and instance level by calling +logger+.
334
    cattr_accessor :logger, :instance_writer => false
J
Jeremy Kemper 已提交
335

P
Pratik Naik 已提交
336 337
    ##
    # :singleton-method:
P
Pratik Naik 已提交
338 339 340 341
    # Contains the database configuration - as is typically stored in config/database.yml -
    # as a Hash.
    #
    # For example, the following database.yml...
E
Emilio Tagua 已提交
342
    #
P
Pratik Naik 已提交
343 344 345
    #   development:
    #     adapter: sqlite3
    #     database: db/development.sqlite3
E
Emilio Tagua 已提交
346
    #
P
Pratik Naik 已提交
347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362
    #   production:
    #     adapter: sqlite3
    #     database: db/production.sqlite3
    #
    # ...would result in ActiveRecord::Base.configurations to look like this:
    #
    #   {
    #      'development' => {
    #         'adapter'  => 'sqlite3',
    #         'database' => 'db/development.sqlite3'
    #      },
    #      'production' => {
    #         'adapter'  => 'sqlite3',
    #         'database' => 'db/production.sqlite3'
    #      }
    #   }
363
    cattr_accessor :configurations, :instance_writer => false
364 365
    @@configurations = {}

P
Pratik Naik 已提交
366 367
    ##
    # :singleton-method:
368 369 370
    # Accessor for the prefix type that will be prepended to every primary key column name.
    # The options are :table_name and :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
371
    # latter is specified, the Product class will look for "product_id" instead of "id". Remember
372
    # that this is a global setting for all Active Records.
373
    cattr_accessor :primary_key_prefix_type, :instance_writer => false
D
Initial  
David Heinemeier Hansson 已提交
374 375
    @@primary_key_prefix_type = nil

P
Pratik Naik 已提交
376 377
    ##
    # :singleton-method:
378 379 380
    # Accessor for the name of the prefix string to prepend to every table name. So if set
    # to "basecamp_", all table names will be named like "basecamp_projects", "basecamp_people",
    # etc. This is a convenient way of creating a namespace for tables in a shared database.
381
    # By default, the prefix is the empty string.
382
    #
383 384
    # If you are organising your models within modules you can add a prefix to the models within
    # a namespace by defining a singleton method in the parent module called table_name_prefix which
385
    # returns your chosen prefix.
386 387
    class_attribute :table_name_prefix, :instance_writer => false
    self.table_name_prefix = ""
D
Initial  
David Heinemeier Hansson 已提交
388

P
Pratik Naik 已提交
389 390
    ##
    # :singleton-method:
D
Initial  
David Heinemeier Hansson 已提交
391 392
    # 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.
393 394
    class_attribute :table_name_suffix, :instance_writer => false
    self.table_name_suffix = ""
D
Initial  
David Heinemeier Hansson 已提交
395

P
Pratik Naik 已提交
396 397
    ##
    # :singleton-method:
398
    # Indicates whether table names should be the pluralized versions of the corresponding class names.
P
Pratik Naik 已提交
399
    # 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 已提交
400
    # See table_name for the full rules on table/class naming. This is true, by default.
401 402
    class_attribute :pluralize_table_names, :instance_writer => false
    self.pluralize_table_names = true
D
Initial  
David Heinemeier Hansson 已提交
403

P
Pratik Naik 已提交
404 405
    ##
    # :singleton-method:
406
    # Determines whether to use Time.local (using :local) or Time.utc (using :utc) when pulling
407
    # dates and times from the database. This is set to :local by default.
408
    cattr_accessor :default_timezone, :instance_writer => false
409
    @@default_timezone = :local
410

P
Pratik Naik 已提交
411 412
    ##
    # :singleton-method:
413
    # Specifies the format to use when dumping the database schema with Rails'
S
Sebastian Martinez 已提交
414 415
    # Rakefile. If :sql, the schema is dumped as (potentially database-
    # specific) SQL statements. If :ruby, the schema is dumped as an
416
    # ActiveRecord::Schema file which can be loaded into any database that
S
Sebastian Martinez 已提交
417
    # supports migrations. Use :ruby if you want to have different database
418
    # adapters for, e.g., your development and test environments.
419
    cattr_accessor :schema_format , :instance_writer => false
420
    @@schema_format = :ruby
421

P
Pratik Naik 已提交
422 423
    ##
    # :singleton-method:
424
    # Specify whether or not to use timestamps for migration versions
425 426 427
    cattr_accessor :timestamped_migrations , :instance_writer => false
    @@timestamped_migrations = true

428
    # Determine whether to store the full constant name including namespace when using STI
429
    class_attribute :store_full_sti_class
430
    self.store_full_sti_class = true
431

432
    # Stores the default scope for the class
433 434
    class_attribute :default_scopes, :instance_writer => false
    self.default_scopes = []
435

436 437 438
    class_attribute :_attr_readonly, :instance_writer => false
    self._attr_readonly = []

D
Initial  
David Heinemeier Hansson 已提交
439
    class << self # Class methods
440
      delegate :find, :first, :first!, :last, :last!, :all, :exists?, :any?, :many?, :to => :scoped
441
      delegate :first_or_create, :first_or_create!, :first_or_initialize, :to => :scoped
442
      delegate :destroy, :destroy_all, :delete, :delete_all, :update, :update_all, :to => :scoped
P
Pratik Naik 已提交
443
      delegate :find_each, :find_in_batches, :to => :scoped
444 445 446
      delegate :select, :group, :order, :except, :reorder, :limit, :offset, :joins,
               :where, :preload, :eager_load, :includes, :from, :lock, :readonly,
               :having, :create_with, :uniq, :to => :scoped
447
      delegate :count, :average, :minimum, :maximum, :sum, :calculate, :pluck, :to => :scoped
448

449 450 451 452 453 454 455 456
      def inherited(child_class) #:nodoc:
        # force attribute methods to be higher in inheritance hierarchy than other generated methods
        child_class.generated_attribute_methods
        child_class.generated_feature_methods
        super
      end

      def generated_feature_methods
457 458 459 460
        @generated_feature_methods ||= begin
          mod = const_set(:GeneratedFeatureMethods, Module.new)
          include mod
          mod
461 462 463
        end
      end

S
Sebastian Martinez 已提交
464
      # Executes a custom SQL query against your database and returns all the results. The results will
465
      # be returned as an array with columns requested encapsulated as attributes of the model you call
S
Sebastian Martinez 已提交
466
      # this method from. If you call <tt>Product.find_by_sql</tt> then the results will be returned in
P
Pratik Naik 已提交
467
      # a Product object with the attributes you specified in the SQL query.
468
      #
469 470
      # If you call a complicated SQL query which spans multiple tables the columns specified by the
      # SELECT will be attributes of the model, whether or not they are columns of the corresponding
471 472
      # table.
      #
S
Sebastian Martinez 已提交
473 474
      # The +sql+ parameter is a full SQL query as a string. It will be called as is, there will be
      # no database agnostic conversions performed. This should be a last resort because using, for example,
475
      # MySQL specific terms will lock you to using that particular database engine or require you to
P
Pratik Naik 已提交
476
      # change your call if you switch engines.
477 478
      #
      # ==== Examples
P
Pratik Naik 已提交
479
      #   # A simple SQL query spanning multiple tables
480 481 482 483 484
      #   Post.find_by_sql "SELECT p.title, c.author FROM posts p, comments c WHERE p.id = c.post_id"
      #   > [#<Post:0x36bff9c @attributes={"title"=>"Ruby Meetup", "first_name"=>"Quentin"}>, ...]
      #
      #   # You can use the same string replacement techniques as you can with ActiveRecord#find
      #   Post.find_by_sql ["SELECT title FROM posts WHERE author = ? AND created > ?", author_id, start_date]
M
mjy 已提交
485
      #   > [#<Post:0x36bff9c @attributes={"title"=>"The Cheap Man Buys Twice"}>, ...]
486 487
      def find_by_sql(sql, binds = [])
        connection.select_all(sanitize_sql(sql), "#{name} Load", binds).collect! { |record| instantiate(record) }
D
Initial  
David Heinemeier Hansson 已提交
488
      end
489

490
      # Creates an object (or multiple objects) and saves it to the database, if validations pass.
491 492
      # The resulting object is returned whether the object was saved successfully to the database or not.
      #
S
Sebastian Martinez 已提交
493
      # The +attributes+ parameter can be either be a Hash or an Array of Hashes. These Hashes describe the
494 495
      # attributes on the objects that are to be created.
      #
496 497 498
      # +create+ respects mass-assignment security and accepts either +:as+ or +:without_protection+ options
      # in the +options+ parameter.
      #
499 500 501
      # ==== Examples
      #   # Create a single new object
      #   User.create(:first_name => 'Jamie')
502
      #
503
      #   # Create a single new object using the :admin mass-assignment security role
504 505 506 507 508
      #   User.create({ :first_name => 'Jamie', :is_admin => true }, :as => :admin)
      #
      #   # Create a single new object bypassing mass-assignment security
      #   User.create({ :first_name => 'Jamie', :is_admin => true }, :without_protection => true)
      #
509
      #   # Create an Array of new objects
P
Pratik Naik 已提交
510
      #   User.create([{ :first_name => 'Jamie' }, { :first_name => 'Jeremy' }])
511 512 513 514 515 516 517
      #
      #   # Create a single object and pass it into a block to set other attributes.
      #   User.create(:first_name => 'Jamie') do |u|
      #     u.is_admin = false
      #   end
      #
      #   # Creating an Array of new objects using a block, where the block is executed for each object:
P
Pratik Naik 已提交
518
      #   User.create([{ :first_name => 'Jamie' }, { :first_name => 'Jeremy' }]) do |u|
519
      #     u.is_admin = false
520
      #   end
521
      def create(attributes = nil, options = {}, &block)
522
        if attributes.is_a?(Array)
523
          attributes.collect { |attr| create(attr, options, &block) }
524
        else
525
          object = new(attributes, options, &block)
526 527 528
          object.save
          object
        end
D
Initial  
David Heinemeier Hansson 已提交
529 530 531
      end

      # Returns the result of an SQL statement that should only include a COUNT(*) in the SELECT part.
532
      # The use of this method should be restricted to complicated SQL queries that can't be executed
S
Sebastian Martinez 已提交
533
      # using the ActiveRecord::Calculations class methods. Look into those before using this.
534
      #
P
Pratik Naik 已提交
535
      # ==== Parameters
536
      #
P
Pratik Naik 已提交
537
      # * +sql+ - An SQL statement which should return a count query from the database, see the example below.
538 539 540
      #
      # ==== Examples
      #
541
      #   Product.count_by_sql "SELECT COUNT(*) FROM sales s, customers c WHERE s.customer_id = c.id"
D
Initial  
David Heinemeier Hansson 已提交
542
      def count_by_sql(sql)
543
        sql = sanitize_conditions(sql)
544
        connection.select_value(sql, "#{name} Count").to_i
D
Initial  
David Heinemeier Hansson 已提交
545
      end
546

N
Neeraj Singh 已提交
547 548
      # Attributes listed as readonly will be used to create a new record but update operations will
      # ignore these fields.
549
      def attr_readonly(*attributes)
550
        self._attr_readonly = Set.new(attributes.map { |a| a.to_s }) + (self._attr_readonly || [])
D
Initial  
David Heinemeier Hansson 已提交
551
      end
552

553 554
      # Returns an array of all the attributes that have been specified as readonly.
      def readonly_attributes
555
        self._attr_readonly
D
Initial  
David Heinemeier Hansson 已提交
556 557
      end

J
Jon Leighton 已提交
558 559 560 561 562 563 564 565
      def deprecated_property_setter(property, value, block) #:nodoc:
        if block
          ActiveSupport::Deprecation.warn(
            "Calling set_#{property} is deprecated. If you need to lazily evaluate " \
            "the #{property}, define your own `self.#{property}` class method. You can use `super` " \
            "to get the default #{property} where you would have called `original_#{property}`."
          )

566
          define_attr_method property, value, false, &block
J
Jon Leighton 已提交
567 568 569 570 571
        else
          ActiveSupport::Deprecation.warn(
            "Calling set_#{property} is deprecated. Please use `self.#{property} = 'the_name'` instead."
          )

572
          define_attr_method property, value, false
J
Jon Leighton 已提交
573 574 575
        end
      end

576 577 578 579 580 581 582 583 584 585
      def deprecated_original_property_getter(property) #:nodoc:
        ActiveSupport::Deprecation.warn("original_#{property} is deprecated. Define self.#{property} and call super instead.")

        if !instance_variable_defined?("@original_#{property}") && respond_to?("reset_#{property}")
          send("reset_#{property}")
        else
          instance_variable_get("@original_#{property}")
        end
      end

586 587
      # Guesses the table name (in forced lower-case) based on the name of the class in the
      # inheritance hierarchy descending directly from ActiveRecord::Base. So if the hierarchy
588
      # looks like: Reply < Message < ActiveRecord::Base, then Message is used
589 590
      # to guess the table name 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
591
      # English inflections. You can add new inflections in config/initializers/inflections.rb.
D
Initial  
David Heinemeier Hansson 已提交
592
      #
593
      # Nested classes are given table names prefixed by the singular form of
P
Pratik Naik 已提交
594 595 596
      # the parent's table name. Enclosing modules are not considered.
      #
      # ==== Examples
597
      #
598 599 600
      #   class Invoice < ActiveRecord::Base
      #   end
      #
601 602
      #   file                  class               table_name
      #   invoice.rb            Invoice             invoices
603
      #
604 605 606 607 608
      #   class Invoice < ActiveRecord::Base
      #     class Lineitem < ActiveRecord::Base
      #     end
      #   end
      #
609 610 611
      #   file                  class               table_name
      #   invoice.rb            Invoice::Lineitem   invoice_lineitems
      #
612 613 614 615 616
      #   module Invoice
      #     class Lineitem < ActiveRecord::Base
      #     end
      #   end
      #
617 618
      #   file                  class               table_name
      #   invoice/lineitem.rb   Invoice::Lineitem   lineitems
D
Initial  
David Heinemeier Hansson 已提交
619
      #
P
Pratik Naik 已提交
620
      # Additionally, the class-level +table_name_prefix+ is prepended and the
S
Sebastian Martinez 已提交
621
      # +table_name_suffix+ is appended. So if you have "myapp_" as a prefix,
622 623 624
      # the table name guess for an Invoice class becomes "myapp_invoices".
      # Invoice::Lineitem becomes "myapp_invoice_lineitems".
      #
625
      # You can also set your own table name explicitly:
D
Initial  
David Heinemeier Hansson 已提交
626 627
      #
      #   class Mouse < ActiveRecord::Base
628
      #     self.table_name = "mice"
D
Initial  
David Heinemeier Hansson 已提交
629
      #   end
630 631 632 633 634 635 636 637 638 639 640
      #
      # Alternatively, you can override the table_name method to define your
      # own computation. (Possibly using <tt>super</tt> to manipulate the default
      # table name.) Example:
      #
      #   class Post < ActiveRecord::Base
      #     def self.table_name
      #       "special_" + super
      #     end
      #   end
      #   Post.table_name # => "special_posts"
641
      def table_name
642 643 644 645
        reset_table_name unless defined?(@table_name)
        @table_name
      end

646 647 648 649
      def original_table_name #:nodoc:
        deprecated_original_property_getter :table_name
      end

650 651 652 653 654 655 656 657 658
      # Sets the table name explicitly. Example:
      #
      #   class Project < ActiveRecord::Base
      #     self.table_name = "project"
      #   end
      #
      # You can also just define your own <tt>self.table_name</tt> method; see
      # the documentation for ActiveRecord::Base#table_name.
      def table_name=(value)
659 660 661 662 663
        @original_table_name = @table_name if defined?(@table_name)
        @table_name          = value
        @quoted_table_name   = nil
        @arel_table          = nil
        @relation            = Relation.new(self, arel_table)
664 665 666
      end

      def set_table_name(value = nil, &block) #:nodoc:
J
Jon Leighton 已提交
667 668 669 670
        deprecated_property_setter :table_name, value, block
        @quoted_table_name = nil
        @arel_table        = nil
        @relation          = Relation.new(self, arel_table)
671 672
      end

673
      # Returns a quoted version of the table name, used to construct SQL statements.
P
Pratik Naik 已提交
674 675 676 677
      def quoted_table_name
        @quoted_table_name ||= connection.quote_table_name(table_name)
      end

678
      # Computes the table name, (re)sets it internally, and returns it.
D
David Heinemeier Hansson 已提交
679
      def reset_table_name #:nodoc:
680 681 682 683 684 685 686
        if superclass.abstract_class?
          self.table_name = superclass.table_name || compute_table_name
        elsif abstract_class?
          self.table_name = superclass == Base ? nil : superclass.table_name
        else
          self.table_name = compute_table_name
        end
D
Initial  
David Heinemeier Hansson 已提交
687 688
      end

689
      def full_table_name_prefix #:nodoc:
690 691 692
        (parents.detect{ |p| p.respond_to?(:table_name_prefix) } || self).table_name_prefix
      end

693
      # The name of the column containing the object's class when Single Table Inheritance is used
D
Initial  
David Heinemeier Hansson 已提交
694
      def inheritance_column
695 696 697
        if self == Base
          'type'
        else
J
Jon Leighton 已提交
698
          (@inheritance_column ||= nil) || superclass.inheritance_column
699 700 701
        end
      end

702 703 704 705
      def original_inheritance_column #:nodoc:
        deprecated_original_property_getter :inheritance_column
      end

706 707
      # Sets the value of inheritance_column
      def inheritance_column=(value)
708 709
        @original_inheritance_column = inheritance_column
        @inheritance_column          = value.to_s
710 711 712
      end

      def set_inheritance_column(value = nil, &block) #:nodoc:
J
Jon Leighton 已提交
713
        deprecated_property_setter :inheritance_column, value, block
D
Initial  
David Heinemeier Hansson 已提交
714 715
      end

716 717 718 719 720 721
      def sequence_name
        if superclass == Base
          @sequence_name ||= reset_sequence_name
        else
          (@sequence_name ||= nil) || superclass.sequence_name
        end
722 723
      end

724 725 726 727
      def original_sequence_name #:nodoc:
        deprecated_original_property_getter :sequence_name
      end

D
David Heinemeier Hansson 已提交
728
      def reset_sequence_name #:nodoc:
729
        self.sequence_name = connection.default_sequence_name(table_name, primary_key)
730 731 732 733
      end

      # 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
734 735
      # given block. This is required for Oracle and is useful for any
      # database which relies on sequences for primary key generation.
736
      #
737 738 739 740 741
      # 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.
742 743
      #
      #   class Project < ActiveRecord::Base
744
      #     self.sequence_name = "projectseq"   # default would have been "project_seq"
745
      #   end
746
      def sequence_name=(value)
747 748
        @original_sequence_name = @sequence_name if defined?(@sequence_name)
        @sequence_name          = value.to_s
749 750 751
      end

      def set_sequence_name(value = nil, &block) #:nodoc:
J
Jon Leighton 已提交
752
        deprecated_property_setter :sequence_name, value, block
753 754
      end

755 756
      # Indicates whether the table associated with this class exists
      def table_exists?
757
        connection.table_exists?(table_name)
758 759
      end

D
Initial  
David Heinemeier Hansson 已提交
760 761
      # Returns an array of column objects for the table associated with this class.
      def columns
762
        if defined?(@primary_key)
763
          connection.schema_cache.primary_keys[table_name] ||= primary_key
764 765
        end

766
        connection.schema_cache.columns[table_name]
D
Initial  
David Heinemeier Hansson 已提交
767
      end
768

769
      # Returns a hash of column objects for the table associated with this class.
D
Initial  
David Heinemeier Hansson 已提交
770
      def columns_hash
771
        connection.schema_cache.columns_hash[table_name]
D
Initial  
David Heinemeier Hansson 已提交
772
      end
773

774 775 776
      # Returns a hash where the keys are column names and the values are
      # default values when instantiating the AR object for this table.
      def column_defaults
777
        connection.schema_cache.column_defaults[table_name]
778 779
      end

D
David Heinemeier Hansson 已提交
780
      # Returns an array of column names as strings.
781
      def column_names
782
        @column_names ||= columns.map { |column| column.name }
783
      end
D
Initial  
David Heinemeier Hansson 已提交
784

785 786
      # 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 已提交
787
      def content_columns
788
        @content_columns ||= columns.reject { |c| c.primary || c.name =~ /(_id|_count)$/ || c.name == inheritance_column }
D
Initial  
David Heinemeier Hansson 已提交
789 790 791 792
      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
793
      # is available.
D
David Heinemeier Hansson 已提交
794
      def column_methods_hash #:nodoc:
795
        @dynamic_methods_hash ||= column_names.inject(Hash.new(false)) do |methods, attr|
796 797 798 799 800
          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 已提交
801 802 803
          methods
        end
      end
804

P
Pratik Naik 已提交
805 806 807 808 809 810 811 812
      # Resets all the cached information about columns, which will cause them
      # to be reloaded on the next request.
      #
      # The most common usage pattern for this method is probably in a migration,
      # when just after creating a table you want to populate it with some default
      # values, eg:
      #
      #  class CreateJobLevels < ActiveRecord::Migration
A
Akira Matsuda 已提交
813
      #    def up
P
Pratik Naik 已提交
814 815 816 817 818 819 820 821 822 823 824 825 826
      #      create_table :job_levels do |t|
      #        t.integer :id
      #        t.string :name
      #
      #        t.timestamps
      #      end
      #
      #      JobLevel.reset_column_information
      #      %w{assistant executive manager director}.each do |type|
      #        JobLevel.create(:name => type)
      #      end
      #    end
      #
A
Akira Matsuda 已提交
827
      #    def down
P
Pratik Naik 已提交
828 829 830
      #      drop_table :job_levels
      #    end
      #  end
831
      def reset_column_information
A
Aaron Patterson 已提交
832
        connection.clear_cache!
833
        undefine_attribute_methods
834
        connection.schema_cache.clear_table_cache!(table_name) if table_exists?
A
Aaron Patterson 已提交
835

836
        @column_names = @content_columns = @dynamic_methods_hash = @inheritance_column = nil
837
        @arel_engine = @relation = nil
838 839
      end

840
      def clear_cache! # :nodoc:
841
        connection.schema_cache.clear!
842 843
      end

844
      def attribute_method?(attribute)
J
José Valim 已提交
845
        super || (table_exists? && column_names.include?(attribute.to_s.sub(/=$/, '')))
846 847
      end

S
Sebastian Martinez 已提交
848 849 850
      # Returns an array of column names as strings if it's not
      # an abstract class and table exists.
      # Otherwise it returns an empty array.
851 852 853 854 855 856 857 858
      def attribute_names
        @attribute_names ||= if !abstract_class? && table_exists?
            column_names
          else
            []
          end
      end

859 860
      # Set the lookup ancestors for ActiveModel.
      def lookup_ancestors #:nodoc:
861 862
        klass = self
        classes = [klass]
863 864
        return classes if klass == ActiveRecord::Base

E
Emilio Tagua 已提交
865
        while klass != klass.base_class
866 867 868 869 870
          classes << klass = klass.superclass
        end
        classes
      end

871 872 873
      # Set the i18n scope to overwrite ActiveModel.
      def i18n_scope #:nodoc:
        :activerecord
D
Initial  
David Heinemeier Hansson 已提交
874
      end
875

876 877 878 879 880 881 882
      # True if this isn't a concrete subclass needing a STI type condition.
      def descends_from_active_record?
        if superclass.abstract_class?
          superclass.descends_from_active_record?
        else
          superclass == Base || !columns_hash.include?(inheritance_column)
        end
D
Initial  
David Heinemeier Hansson 已提交
883 884
      end

885 886 887 888 889
      def finder_needs_type_condition? #:nodoc:
        # This is like this because benchmarking justifies the strange :false stuff
        :true == (@finder_needs_type_condition ||= descends_from_active_record? ? :false : :true)
      end

A
Akira Matsuda 已提交
890
      # Returns a string like 'Post(id:integer, title:string, body:text)'
891
      def inspect
892 893 894 895
        if self == Base
          super
        elsif abstract_class?
          "#{super}(abstract)"
896
        elsif table_exists?
897 898
          attr_list = columns.map { |c| "#{c.name}: #{c.type}" } * ', '
          "#{super}(#{attr_list})"
899 900
        else
          "#{super}(Table doesn't exist)"
901
        end
902 903
      end

904
      def quote_value(value, column = nil) #:nodoc:
905
        connection.quote(value,column)
906 907
      end

908
      # Used to sanitize objects before they're used in an SQL SELECT statement. Delegates to <tt>connection.quote</tt>.
909
      def sanitize(object) #:nodoc:
910
        connection.quote(object)
D
Initial  
David Heinemeier Hansson 已提交
911 912
      end

913 914 915
      # Overwrite the default class equality method to provide support for association proxies.
      def ===(object)
        object.is_a?(self)
916
      end
917

918 919 920 921
      def symbolized_base_class
        @symbolized_base_class ||= base_class.to_s.to_sym
      end

922
      def symbolized_sti_name
923
        @symbolized_sti_name ||= sti_name.present? ? sti_name.to_sym : symbolized_base_class
924 925
      end

926 927 928
      # 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.
929 930 931
      #
      # If B < A and C < B and if A is an abstract_class then both B.base_class
      # and C.base_class would return B as the answer since A is an abstract_class.
932 933 934 935
      def base_class
        class_of_active_record_descendant(self)
      end

P
Pratik Naik 已提交
936
      # Set this to true if this is an abstract class (see <tt>abstract_class?</tt>).
937 938
      attr_accessor :abstract_class

939
      # Returns whether this class is an abstract class or not.
940
      def abstract_class?
941
        defined?(@abstract_class) && @abstract_class == true
942 943
      end

944
      def respond_to?(method_id, include_private = false)
945 946
        if match = DynamicFinderMatch.match(method_id)
          return true if all_attributes_exists?(match.attribute_names)
947 948
        elsif match = DynamicScopeMatch.match(method_id)
          return true if all_attributes_exists?(match.attribute_names)
949
        end
950

951 952 953
        super
      end

954 955 956 957
      def sti_name
        store_full_sti_class ? name : name.demodulize
      end

P
Pratik Naik 已提交
958
      def arel_table
959
        @arel_table ||= Arel::Table.new(table_name, arel_engine)
960 961
      end

962 963
      def arel_engine
        @arel_engine ||= begin
964
          if self == ActiveRecord::Base
965
            ActiveRecord::Base
966
          else
967
            connection_handler.connection_pools[name] ? self : superclass.arel_engine
968 969
          end
        end
970 971
      end

972 973 974
      # Returns a scope for this class without taking into account the default_scope.
      #
      #   class Post < ActiveRecord::Base
975 976 977
      #     def self.default_scope
      #       where :published => true
      #     end
978 979 980 981 982 983 984 985 986
      #   end
      #
      #   Post.all          # Fires "SELECT * FROM posts WHERE published = true"
      #   Post.unscoped.all # Fires "SELECT * FROM posts"
      #
      # This method also accepts a block meaning that all queries inside the block will
      # not use the default_scope:
      #
      #   Post.unscoped {
987
      #     Post.limit(10) # Fires "SELECT * FROM posts LIMIT 10"
988 989
      #   }
      #
990 991
      # It is recommended to use block form of unscoped because chaining unscoped with <tt>scope</tt>
      # does not work. Assuming that <tt>published</tt> is a <tt>scope</tt> following two statements are same.
992
      #
993 994
      # Post.unscoped.published
      # Post.published
995
      def unscoped #:nodoc:
996 997 998
        block_given? ? relation.scoping { yield } : relation
      end

999
      def before_remove_const #:nodoc:
1000
        self.current_scope = nil
1001 1002
      end

1003 1004 1005
      # 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.
1006 1007
      def instantiate(record)
        sti_class = find_sti_class(record[inheritance_column])
1008
        record_id = sti_class.primary_key && record[sti_class.primary_key]
M
Marcin Raczkowski 已提交
1009

1010 1011 1012 1013 1014 1015
        if ActiveRecord::IdentityMap.enabled? && record_id
          if (column = sti_class.columns_hash[sti_class.primary_key]) && column.number?
            record_id = record_id.to_i
          end
          if instance = IdentityMap.get(sti_class, record_id)
            instance.reinit_with('attributes' => record)
1016
          else
M
Marcin Raczkowski 已提交
1017
            instance = sti_class.allocate.init_with('attributes' => record)
1018
            IdentityMap.add(instance)
1019
          end
1020 1021 1022 1023 1024
        else
          instance = sti_class.allocate.init_with('attributes' => record)
        end

        instance
1025
      end
1026

D
Initial  
David Heinemeier Hansson 已提交
1027
      private
J
José Valim 已提交
1028 1029 1030

        def relation #:nodoc:
          @relation ||= Relation.new(self, arel_table)
1031 1032 1033 1034 1035 1036

          if finder_needs_type_condition?
            @relation.where(type_condition).create_with(inheritance_column.to_sym => sti_name)
          else
            @relation
          end
D
Initial  
David Heinemeier Hansson 已提交
1037
        end
1038

1039
        def find_sti_class(type_name)
1040
          if type_name.blank? || !columns_hash.include?(inheritance_column)
1041 1042 1043
            self
          else
            begin
1044 1045 1046 1047 1048
              if store_full_sti_class
                ActiveSupport::Dependencies.constantize(type_name)
              else
                compute_type(type_name)
              end
1049 1050 1051 1052 1053 1054 1055 1056 1057 1058
            rescue NameError
              raise SubclassNotFound,
                "The single-table inheritance mechanism failed to locate the subclass: '#{type_name}'. " +
                "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 #{name}.inheritance_column to use another column for that information."
            end
          end
        end

1059
        def construct_finder_arel(options = {}, scope = nil)
1060
          relation = options.is_a?(Hash) ? unscoped.apply_finder_options(options) : options
1061
          relation = scope.merge(relation) if scope
1062
          relation
1063 1064
        end

1065 1066
        def type_condition(table = arel_table)
          sti_column = table[inheritance_column.to_sym]
1067
          sti_names  = ([self] + descendants).map { |model| model.sti_name }
1068

1069
          sti_column.in(sti_names)
D
Initial  
David Heinemeier Hansson 已提交
1070 1071 1072
        end

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

1079 1080 1081 1082 1083 1084 1085 1086
        # Computes and returns a table name according to default conventions.
        def compute_table_name
          base = base_class
          if self == base
            # Nested classes are prefixed with singular parent table name.
            if parent < ActiveRecord::Base && !parent.abstract_class?
              contained = parent.table_name
              contained = contained.singularize if parent.pluralize_table_names
1087
              contained += '_'
1088 1089 1090 1091 1092 1093 1094 1095
            end
            "#{full_table_name_prefix}#{contained}#{undecorated_table_name(name)}#{table_name_suffix}"
          else
            # STI subclasses always use their superclass' table.
            base.table_name
          end
        end

1096
        # Enables dynamic finders like <tt>User.find_by_user_name(user_name)</tt> and
1097 1098
        # <tt>User.scoped_by_user_name(user_name). Refer to Dynamic attribute-based finders
        # section at the top of this file for more detailed information.
1099
        #
1100
        # It's even possible to use all the additional parameters to +find+. For example, the
1101
        # full interface for +find_all_by_amount+ is actually <tt>find_all_by_amount(amount, options)</tt>.
1102
        #
1103
        # Each dynamic finder using <tt>scoped_by_*</tt> is also defined in the class after it
1104
        # is first invoked, so that future attempts to use it do not run through method_missing.
1105
        def method_missing(method_id, *arguments, &block)
1106
          if match = (DynamicFinderMatch.match(method_id) || DynamicScopeMatch.match(method_id))
1107
            attribute_names = match.attribute_names
1108
            super unless all_attributes_exists?(attribute_names)
1109 1110 1111 1112 1113
            if arguments.size < attribute_names.size
              method_trace = "#{__FILE__}:#{__LINE__}:in `#{method_id}'"
              backtrace = [method_trace] + caller
              raise ArgumentError, "wrong number of arguments (#{arguments.size} for #{attribute_names.size})", backtrace
            end
1114
            if match.respond_to?(:scope?) && match.scope?
1115
              self.class_eval <<-METHOD, __FILE__, __LINE__ + 1
1116 1117 1118 1119 1120
                def self.#{method_id}(*args)                                    # def self.scoped_by_user_name_and_password(*args)
                  attributes = Hash[[:#{attribute_names.join(',:')}].zip(args)] #   attributes = Hash[[:user_name, :password].zip(args)]
                                                                                #
                  scoped(:conditions => attributes)                             #   scoped(:conditions => attributes)
                end                                                             # end
1121
              METHOD
1122
              send(method_id, *arguments)
1123 1124 1125 1126 1127 1128
            elsif match.finder?
              options = arguments.extract_options!
              relation = options.any? ? scoped(options) : scoped
              relation.send :find_by_attributes, match, attribute_names, *arguments, &block
            elsif match.instantiator?
              scoped.send :find_or_instantiator_by_attributes, match, attribute_names, *arguments, &block
1129
            end
1130 1131 1132 1133
          else
            super
          end
        end
D
Initial  
David Heinemeier Hansson 已提交
1134

1135 1136
        # Similar in purpose to +expand_hash_conditions_for_aggregates+.
        def expand_attribute_names_for_aggregates(attribute_names)
1137
          attribute_names.map { |attribute_name|
1138
            unless (aggregation = reflect_on_aggregation(attribute_name.to_sym)).nil?
1139 1140
              aggregate_mapping(aggregation).map do |field_attr, _|
                field_attr.to_sym
1141 1142
              end
            else
1143
              attribute_name.to_sym
1144
            end
1145
          }.flatten
1146 1147
        end

1148
        def all_attributes_exists?(attribute_names)
1149 1150
          (expand_attribute_names_for_aggregates(attribute_names) -
           column_methods_hash.keys).empty?
1151
        end
1152

D
Initial  
David Heinemeier Hansson 已提交
1153
      protected
N
Neeraj Singh 已提交
1154 1155
        # with_scope lets you apply options to inner block incrementally. It takes a hash and the keys must be
        # <tt>:find</tt> or <tt>:create</tt>. <tt>:find</tt> parameter is <tt>Relation</tt> while
1156
        # <tt>:create</tt> parameters are an attributes hash.
1157 1158 1159
        #
        #   class Article < ActiveRecord::Base
        #     def self.create_with_scope
1160
        #       with_scope(:find => where(:blog_id => 1), :create => { :blog_id => 1 }) do
1161 1162 1163 1164 1165 1166 1167
        #         find(1) # => SELECT * from articles WHERE blog_id = 1 AND id = 1
        #         a = create(1)
        #         a.blog_id # => 1
        #       end
        #     end
        #   end
        #
D
David Heinemeier Hansson 已提交
1168
        # In nested scopings, all previous parameters are overwritten by the innermost rule, with the exception of
1169
        # <tt>where</tt>, <tt>includes</tt>, and <tt>joins</tt> operations in <tt>Relation</tt>, which are merged.
P
Pratik Naik 已提交
1170
        #
1171
        # <tt>joins</tt> operations are uniqued so multiple scopes can join in the same table without table aliasing
S
Sebastian Martinez 已提交
1172
        # problems. If you need to join multiple tables, but still want one of the tables to be uniqued, use the
P
Pratik Naik 已提交
1173
        # array of strings format for your joins.
1174 1175 1176
        #
        #   class Article < ActiveRecord::Base
        #     def self.find_with_scope
1177 1178 1179
        #       with_scope(:find => where(:blog_id => 1).limit(1), :create => { :blog_id => 1 }) do
        #         with_scope(:find => limit(10)) do
        #           all # => SELECT * from articles WHERE blog_id = 1 LIMIT 10
1180
        #         end
1181 1182
        #         with_scope(:find => where(:author_id => 3)) do
        #           all # => SELECT * from articles WHERE blog_id = 1 AND author_id = 3 LIMIT 1
1183 1184 1185 1186 1187
        #         end
        #       end
        #     end
        #   end
        #
1188
        # You can ignore any previous scopings by using the <tt>with_exclusive_scope</tt> method.
1189 1190 1191
        #
        #   class Article < ActiveRecord::Base
        #     def self.find_with_exclusive_scope
1192
        #       with_scope(:find => where(:blog_id => 1).limit(1)) do
1193
        #         with_exclusive_scope(:find => limit(10)) do
1194
        #           all # => SELECT * from articles LIMIT 10
1195 1196 1197 1198
        #         end
        #       end
        #     end
        #   end
P
Pratik Naik 已提交
1199
        #
N
Neeraj Singh 已提交
1200
        # *Note*: the +:find+ scope also has effect on update and deletion methods, like +update_all+ and +delete_all+.
1201 1202 1203 1204
        def with_scope(scope = {}, action = :merge, &block)
          # If another Active Record class has been passed in, get its current scope
          scope = scope.current_scope if !scope.is_a?(Relation) && scope.respond_to?(:current_scope)

1205
          previous_scope = self.current_scope
1206

1207
          if scope.is_a?(Hash)
1208
            # Dup first and second level of hash (method and params).
1209 1210 1211
            scope = scope.dup
            scope.each do |method, params|
              scope[method] = params.dup unless params == true
1212
            end
1213

1214 1215
            scope.assert_valid_keys([ :find, :create ])
            relation = construct_finder_arel(scope[:find] || {})
1216
            relation.default_scoped = true unless action == :overwrite
1217

1218
            if previous_scope && previous_scope.create_with_value && scope[:create]
1219
              scope_for_create = if action == :merge
1220
                previous_scope.create_with_value.merge(scope[:create])
1221
              else
1222
                scope[:create]
1223
              end
1224 1225 1226

              relation = relation.create_with(scope_for_create)
            else
1227 1228
              scope_for_create = scope[:create]
              scope_for_create ||= previous_scope.create_with_value if previous_scope
1229 1230 1231
              relation = relation.create_with(scope_for_create) if scope_for_create
            end

1232
            scope = relation
1233 1234
          end

1235
          scope = previous_scope.merge(scope) if previous_scope && action == :merge
1236

1237
          self.current_scope = scope
1238 1239 1240
          begin
            yield
          ensure
1241
            self.current_scope = previous_scope
1242 1243 1244 1245 1246
          end
        end

        # Works like with_scope, but discards any nested properties.
        def with_exclusive_scope(method_scoping = {}, &block)
1247
          if method_scoping.values.any? { |e| e.is_a?(ActiveRecord::Relation) }
1248 1249
            raise ArgumentError, <<-MSG
New finder API can not be used with_exclusive_scope. You can either call unscoped to get an anonymous scope not bound to the default_scope:
1250

1251 1252 1253 1254 1255 1256 1257 1258 1259
  User.unscoped.where(:active => true)

Or call unscoped with a block:

  User.unscoped do
    User.where(:active => true).all
  end

MSG
1260
          end
1261 1262 1263
          with_scope(method_scoping, :overwrite, &block)
        end

1264
        def current_scope #:nodoc:
1265
          Thread.current["#{self}_current_scope"]
1266 1267 1268
        end

        def current_scope=(scope) #:nodoc:
1269
          Thread.current["#{self}_current_scope"] = scope
1270 1271
        end

1272
        # Use this macro in your model to set a default scope for all operations on
1273
        # the model.
1274
        #
1275 1276
        #   class Article < ActiveRecord::Base
        #     default_scope where(:published => true)
1277
        #   end
1278
        #
1279
        #   Article.all # => SELECT * FROM articles WHERE published = true
1280 1281
        #
        # The <tt>default_scope</tt> is also applied while creating/building a record. It is not
1282 1283
        # applied while updating a record.
        #
1284 1285
        #   Article.new.published    # => true
        #   Article.create.published # => true
1286
        #
1287 1288 1289 1290 1291 1292 1293 1294 1295
        # You can also use <tt>default_scope</tt> with a block, in order to have it lazily evaluated:
        #
        #   class Article < ActiveRecord::Base
        #     default_scope { where(:published_at => Time.now - 1.week) }
        #   end
        #
        # (You can also pass any object which responds to <tt>call</tt> to the <tt>default_scope</tt>
        # macro, and it will be called when building the default scope.)
        #
1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308
        # If you use multiple <tt>default_scope</tt> declarations in your model then they will
        # be merged together:
        #
        #   class Article < ActiveRecord::Base
        #     default_scope where(:published => true)
        #     default_scope where(:rating => 'G')
        #   end
        #
        #   Article.all # => SELECT * FROM articles WHERE published = true AND rating = 'G'
        #
        # This is also the case with inheritance and module includes where the parent or module
        # defines a <tt>default_scope</tt> and the child or including class defines a second one.
        #
1309 1310
        # If you need to do more complex things with a default scope, you can alternatively
        # define it as a class method:
1311
        #
1312 1313 1314 1315
        #   class Article < ActiveRecord::Base
        #     def self.default_scope
        #       # Should return a scope, you can call 'super' here etc.
        #     end
1316 1317
        #   end
        def default_scope(scope = {})
1318
          scope = Proc.new if block_given?
1319
          self.default_scopes = default_scopes + [scope]
1320
        end
1321

1322
        def build_default_scope #:nodoc:
1323 1324 1325 1326
          if method(:default_scope).owner != Base.singleton_class
            evaluate_default_scope { default_scope }
          elsif default_scopes.any?
            evaluate_default_scope do
1327 1328 1329 1330 1331 1332 1333 1334
              default_scopes.inject(relation) do |default_scope, scope|
                if scope.is_a?(Hash)
                  default_scope.apply_finder_options(scope)
                elsif !scope.is_a?(Relation) && scope.respond_to?(:call)
                  default_scope.merge(scope.call)
                else
                  default_scope.merge(scope)
                end
1335 1336
              end
            end
1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355
          end
        end

        def ignore_default_scope? #:nodoc:
          Thread.current["#{self}_ignore_default_scope"]
        end

        def ignore_default_scope=(ignore) #:nodoc:
          Thread.current["#{self}_ignore_default_scope"] = ignore
        end

        # The ignore_default_scope flag is used to prevent an infinite recursion situation where
        # a default scope references a scope which has a default scope which references a scope...
        def evaluate_default_scope
          return if ignore_default_scope?

          begin
            self.ignore_default_scope = true
            yield
1356 1357
          ensure
            self.ignore_default_scope = false
1358
          end
1359 1360
        end

P
Pratik Naik 已提交
1361
        # Returns the class type of the record using the current module as a prefix. So descendants of
1362
        # MyApp::Business::Account would appear as MyApp::Business::AccountSubclass.
D
Initial  
David Heinemeier Hansson 已提交
1363
        def compute_type(type_name)
1364 1365 1366
          if type_name.match(/^::/)
            # If the type is prefixed with a scope operator then we assume that
            # the type_name is an absolute reference.
1367
            ActiveSupport::Dependencies.constantize(type_name)
1368 1369 1370 1371 1372 1373 1374 1375
          else
            # Build a list of candidates to search for
            candidates = []
            name.scan(/::|$/) { candidates.unshift "#{$`}::#{type_name}" }
            candidates << type_name

            candidates.each do |candidate|
              begin
1376
                constant = ActiveSupport::Dependencies.constantize(candidate)
1377
                return constant if candidate == constant.to_s
1378 1379 1380
              rescue NameError => e
                # We don't want to swallow NoMethodError < NameError errors
                raise e unless e.instance_of?(NameError)
1381
              end
1382
            end
1383 1384

            raise NameError, "uninitialized constant #{candidates.first}"
D
Initial  
David Heinemeier Hansson 已提交
1385 1386 1387
          end
        end

P
Pratik Naik 已提交
1388 1389
        # Returns the class descending directly from ActiveRecord::Base or an
        # abstract class, if any, in the inheritance hierarchy.
1390
        def class_of_active_record_descendant(klass)
1391
          if klass == Base || klass.superclass == Base || klass.superclass.abstract_class?
1392
            klass
D
Initial  
David Heinemeier Hansson 已提交
1393 1394 1395
          elsif klass.superclass.nil?
            raise ActiveRecordError, "#{name} doesn't belong in a hierarchy descending from ActiveRecord"
          else
1396
            class_of_active_record_descendant(klass.superclass)
D
Initial  
David Heinemeier Hansson 已提交
1397 1398 1399
          end
        end

P
Pratik Naik 已提交
1400
        # Accepts an array, hash, or string of SQL conditions and sanitizes
1401
        # them into a valid SQL fragment for a WHERE clause.
1402 1403 1404
        #   ["name='%s' and group_id='%s'", "foo'bar", 4]  returns  "name='foo''bar' and group_id='4'"
        #   { :name => "foo'bar", :group_id => 4 }  returns "name='foo''bar' and group_id='4'"
        #   "name='foo''bar' and group_id='4'" returns "name='foo''bar' and group_id='4'"
1405
        def sanitize_sql_for_conditions(condition, table_name = self.table_name)
1406 1407
          return nil if condition.blank?

1408
          case condition
1409 1410 1411
          when Array; sanitize_sql_array(condition)
          when Hash;  sanitize_sql_hash_for_conditions(condition, table_name)
          else        condition
1412
          end
1413
        end
1414
        alias_method :sanitize_sql, :sanitize_sql_for_conditions
1415

P
Pratik Naik 已提交
1416
        # Accepts an array, hash, or string of SQL conditions and sanitizes
1417 1418 1419 1420 1421 1422 1423 1424 1425 1426
        # them into a valid SQL fragment for a SET clause.
        #   { :name => nil, :group_id => 4 }  returns "name = NULL , group_id='4'"
        def sanitize_sql_for_assignment(assignments)
          case assignments
            when Array; sanitize_sql_array(assignments)
            when Hash;  sanitize_sql_hash_for_assignment(assignments)
            else        assignments
          end
        end

1427 1428 1429 1430 1431
        def aggregate_mapping(reflection)
          mapping = reflection.options[:mapping] || [reflection.name, reflection.name]
          mapping.first.is_a?(Array) ? mapping : [mapping]
        end

P
Pratik Naik 已提交
1432
        # Accepts a hash of SQL conditions and replaces those attributes
1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461
        # that correspond to a +composed_of+ relationship with their expanded
        # aggregate attribute values.
        # Given:
        #     class Person < ActiveRecord::Base
        #       composed_of :address, :class_name => "Address",
        #         :mapping => [%w(address_street street), %w(address_city city)]
        #     end
        # Then:
        #     { :address => Address.new("813 abc st.", "chicago") }
        #       # => { :address_street => "813 abc st.", :address_city => "chicago" }
        def expand_hash_conditions_for_aggregates(attrs)
          expanded_attrs = {}
          attrs.each do |attr, value|
            unless (aggregation = reflect_on_aggregation(attr.to_sym)).nil?
              mapping = aggregate_mapping(aggregation)
              mapping.each do |field_attr, aggregate_attr|
                if mapping.size == 1 && !value.respond_to?(aggregate_attr)
                  expanded_attrs[field_attr] = value
                else
                  expanded_attrs[field_attr] = value.send(aggregate_attr)
                end
              end
            else
              expanded_attrs[attr] = value
            end
          end
          expanded_attrs
        end

1462
        # Sanitizes a hash of attribute/value pairs into SQL conditions for a WHERE clause.
1463 1464 1465 1466
        #   { :name => "foo'bar", :group_id => 4 }
        #     # => "name='foo''bar' and group_id= 4"
        #   { :status => nil, :group_id => [1,2,3] }
        #     # => "status IS NULL and group_id IN (1,2,3)"
1467 1468
        #   { :age => 13..18 }
        #     # => "age BETWEEN 13 AND 18"
1469 1470
        #   { 'other_records.id' => 7 }
        #     # => "`other_records`.`id` = 7"
1471 1472
        #   { :other_records => { :id => 7 } }
        #     # => "`other_records`.`id` = 7"
1473 1474 1475
        # And for value objects on a composed_of relationship:
        #   { :address => Address.new("123 abc st.", "chicago") }
        #     # => "address_street='123 abc st.' and address_city='chicago'"
1476
        def sanitize_sql_hash_for_conditions(attrs, default_table_name = self.table_name)
1477 1478
          attrs = expand_hash_conditions_for_aggregates(attrs)

1479
          table = Arel::Table.new(table_name).alias(default_table_name)
1480
          PredicateBuilder.build_from_hash(arel_engine, attrs, table).map { |b|
1481
            connection.visitor.accept b
1482
          }.join(' AND ')
1483
        end
1484 1485 1486 1487 1488 1489
        alias_method :sanitize_sql_hash, :sanitize_sql_hash_for_conditions

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

S
Sebastian Martinez 已提交
1495
        # Accepts an array of conditions. The array has each value
P
Pratik Naik 已提交
1496
        # sanitized and interpolated into the SQL statement.
1497
        #   ["name='%s' and group_id='%s'", "foo'bar", 4]  returns  "name='foo''bar' and group_id='4'"
1498
        def sanitize_sql_array(ary)
1499
          statement, *values = ary
1500
          if values.first.is_a?(Hash) && statement =~ /:\w+/
1501 1502
            replace_named_bind_variables(statement, values.first)
          elsif statement.include?('?')
1503
            replace_bind_variables(statement, values)
1504 1505
          elsif statement.blank?
            statement
1506
          else
1507
            statement % values.collect { |value| connection.quote_string(value.to_s) }
1508
          end
1509 1510
        end

1511 1512
        alias_method :sanitize_conditions, :sanitize_sql

D
David Heinemeier Hansson 已提交
1513
        def replace_bind_variables(statement, values) #:nodoc:
1514
          raise_if_bind_arity_mismatch(statement, statement.count('?'), values.size)
1515
          bound = values.dup
C
Comron Sattari 已提交
1516 1517
          c = connection
          statement.gsub('?') { quote_bound_value(bound.shift, c) }
1518 1519
        end

D
David Heinemeier Hansson 已提交
1520
        def replace_named_bind_variables(statement, bind_vars) #:nodoc:
1521 1522 1523 1524
          statement.gsub(/(:?):([a-zA-Z]\w*)/) do
            if $1 == ':' # skip postgresql casts
              $& # return the whole match
            elsif bind_vars.include?(match = $2.to_sym)
1525
              quote_bound_value(bind_vars[match])
1526 1527
            else
              raise PreparedStatementInvalid, "missing value for :#{match} in #{statement}"
1528 1529
            end
          end
1530 1531
        end

1532
        def expand_range_bind_variables(bind_vars) #:nodoc:
1533 1534 1535
          expanded = []

          bind_vars.each do |var|
1536 1537
            next if var.is_a?(Hash)

1538
            if var.is_a?(Range)
1539 1540
              expanded << var.first
              expanded << var.last
1541
            else
1542
              expanded << var
1543
            end
1544
          end
1545 1546

          expanded
1547 1548
        end

C
Comron Sattari 已提交
1549
        def quote_bound_value(value, c = connection) #:nodoc:
1550
          if value.respond_to?(:map) && !value.acts_like?(:string)
1551
            if value.respond_to?(:empty?) && value.empty?
C
Comron Sattari 已提交
1552
              c.quote(nil)
1553
            else
C
Comron Sattari 已提交
1554
              value.map { |v| c.quote(v) }.join(',')
1555
            end
1556
          else
C
Comron Sattari 已提交
1557
            c.quote(value)
1558 1559 1560
          end
        end

D
David Heinemeier Hansson 已提交
1561
        def raise_if_bind_arity_mismatch(statement, expected, provided) #:nodoc:
1562 1563 1564
          unless expected == provided
            raise PreparedStatementInvalid, "wrong number of bind variables (#{provided} for #{expected}) in: #{statement}"
          end
1565
        end
1566

D
David Heinemeier Hansson 已提交
1567
        def encode_quoted_value(value) #:nodoc:
1568
          quoted_value = connection.quote(value)
1569 1570
          quoted_value = "'#{quoted_value[1..-2].gsub(/\'/, "\\\\'")}'" if quoted_value.include?("\\\'") # (for ruby mode) "
          quoted_value
1571
        end
D
Initial  
David Heinemeier Hansson 已提交
1572 1573 1574 1575 1576
    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).
1577
      # In both instances, valid attribute keys are determined by the column names of the associated table --
D
Initial  
David Heinemeier Hansson 已提交
1578
      # hence you can't have attributes that aren't part of the table columns.
1579 1580 1581 1582 1583 1584 1585 1586
      #
      # +initialize+ respects mass-assignment security and accepts either +:as+ or +:without_protection+ options
      # in the +options+ parameter.
      #
      # ==== Examples
      #   # Instantiates a single new object
      #   User.new(:first_name => 'Jamie')
      #
1587
      #   # Instantiates a single new object using the :admin mass-assignment security role
1588 1589 1590 1591 1592
      #   User.new({ :first_name => 'Jamie', :is_admin => true }, :as => :admin)
      #
      #   # Instantiates a single new object bypassing mass-assignment security
      #   User.new({ :first_name => 'Jamie', :is_admin => true }, :without_protection => true)
      def initialize(attributes = nil, options = {})
1593
        @attributes = attributes_from_column_definition
1594
        @association_cache = {}
1595
        @aggregation_cache = {}
1596
        @attributes_cache = {}
1597
        @new_record = true
1598
        @readonly = false
1599 1600
        @destroyed = false
        @marked_for_destruction = false
1601 1602
        @previously_changed = {}
        @changed_attributes = {}
A
Aaron Patterson 已提交
1603
        @relation = nil
1604

D
Initial  
David Heinemeier Hansson 已提交
1605
        ensure_proper_type
1606
        set_serialized_attributes
P
Pratik Naik 已提交
1607

1608
        populate_with_current_scope_attributes
1609 1610

        assign_attributes(attributes, options) if attributes
P
Pratik Naik 已提交
1611

A
Aaron Patterson 已提交
1612
        yield self if block_given?
1613
        run_callbacks :initialize
D
Initial  
David Heinemeier Hansson 已提交
1614
      end
1615

1616
      # Populate +coder+ with attributes about this record that should be
S
Sebastian Martinez 已提交
1617
      # serialized. The structure of +coder+ defined in this method is
1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631
      # guaranteed to match the structure of +coder+ passed to the +init_with+
      # method.
      #
      # Example:
      #
      #   class Post < ActiveRecord::Base
      #   end
      #   coder = {}
      #   Post.new.encode_with(coder)
      #   coder # => { 'id' => nil, ... }
      def encode_with(coder)
        coder['attributes'] = attributes
      end

S
Sebastian Martinez 已提交
1632 1633
      # Initialize an empty model object from +coder+. +coder+ must contain
      # the attributes necessary for initializing an empty model object. For
1634 1635 1636 1637 1638 1639 1640 1641 1642 1643
      # example:
      #
      #   class Post < ActiveRecord::Base
      #   end
      #
      #   post = Post.allocate
      #   post.init_with('attributes' => { 'title' => 'hello world' })
      #   post.title # => 'hello world'
      def init_with(coder)
        @attributes = coder['attributes']
A
Aaron Patterson 已提交
1644
        @relation = nil
1645

1646
        set_serialized_attributes
1647

1648
        @attributes_cache, @previously_changed, @changed_attributes = {}, {}, {}
1649
        @association_cache = {}
1650
        @aggregation_cache = {}
1651
        @readonly = @destroyed = @marked_for_destruction = false
1652
        @new_record = false
1653 1654
        run_callbacks :find
        run_callbacks :initialize
M
Marcin Raczkowski 已提交
1655 1656

        self
1657 1658
      end

P
Pratik Naik 已提交
1659 1660 1661 1662
      # Returns a String, which Action Pack uses for constructing an URL to this
      # object. The default implementation returns this record's id as a String,
      # or nil if this record's unsaved.
      #
P
Pratik Naik 已提交
1663
      # For example, suppose that you have a User model, and that you have a
1664
      # <tt>resources :users</tt> route. Normally, +user_path+ will
P
Pratik Naik 已提交
1665
      # construct a path with the user object's 'id' in it:
P
Pratik Naik 已提交
1666 1667
      #
      #   user = User.find_by_name('Phusion')
1668
      #   user_path(user)  # => "/users/1"
P
Pratik Naik 已提交
1669
      #
P
Pratik Naik 已提交
1670 1671
      # You can override +to_param+ in your model to make +user_path+ construct
      # a path using the user's name instead of the user's id:
P
Pratik Naik 已提交
1672 1673 1674 1675 1676 1677
      #
      #   class User < ActiveRecord::Base
      #     def to_param  # overridden
      #       name
      #     end
      #   end
E
Emilio Tagua 已提交
1678
      #
P
Pratik Naik 已提交
1679
      #   user = User.find_by_name('Phusion')
1680
      #   user_path(user)  # => "/users/Phusion"
1681
      def to_param
1682
        # We can't use alias_method here, because method 'id' optimizes itself on the fly.
1683
        id && id.to_s # Be sure to stringify the id for routes
1684
      end
1685

P
Pratik Naik 已提交
1686 1687 1688
      # Returns a cache key that can be used to identify this record.
      #
      # ==== Examples
1689 1690 1691 1692 1693
      #
      #   Product.new.cache_key     # => "products/new"
      #   Product.find(5).cache_key # => "products/5" (updated_at not available)
      #   Person.find(5).cache_key  # => "people/5-20071224150000" (updated_at available)
      def cache_key
1694
        case
1695
        when new_record?
J
Jeremy Kemper 已提交
1696 1697
          "#{self.class.model_name.cache_key}/new"
        when timestamp = self[:updated_at]
1698 1699
          timestamp = timestamp.utc.to_s(:number)
          "#{self.class.model_name.cache_key}/#{id}-#{timestamp}"
1700
        else
J
Jeremy Kemper 已提交
1701
          "#{self.class.model_name.cache_key}/#{id}"
1702 1703
        end
      end
1704

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

1709 1710 1711 1712 1713
      # Returns true if the given attribute is in the attributes hash
      def has_attribute?(attr_name)
        @attributes.has_key?(attr_name.to_s)
      end

1714
      # Returns an array of names for the attributes available on this object.
1715
      def attribute_names
1716
        @attributes.keys
D
Initial  
David Heinemeier Hansson 已提交
1717 1718 1719
      end

      # Allows you to set all the attributes at once by passing in a hash with keys
P
Pratik Naik 已提交
1720 1721
      # matching the attribute names (which again matches the column names).
      #
1722 1723 1724
      # If any attributes are protected by either +attr_protected+ or
      # +attr_accessible+ then only settable attributes will be assigned.
      #
P
Pratik Naik 已提交
1725 1726 1727
      #   class User < ActiveRecord::Base
      #     attr_protected :is_admin
      #   end
E
Emilio Tagua 已提交
1728
      #
P
Pratik Naik 已提交
1729 1730 1731 1732
      #   user = User.new
      #   user.attributes = { :username => 'Phusion', :is_admin => true }
      #   user.username   # => "Phusion"
      #   user.is_admin?  # => false
1733
      def attributes=(new_attributes)
P
Pratik Naik 已提交
1734
        return unless new_attributes.is_a?(Hash)
1735

1736
        assign_attributes(new_attributes)
1737 1738 1739
      end

      # Allows you to set all the attributes for a particular mass-assignment
1740 1741
      # security role by passing in a hash of attributes with keys matching
      # the attribute names (which again matches the column names) and the role
1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766
      # name using the :as option.
      #
      # To bypass mass-assignment security you can use the :without_protection => true
      # option.
      #
      #   class User < ActiveRecord::Base
      #     attr_accessible :name
      #     attr_accessible :name, :is_admin, :as => :admin
      #   end
      #
      #   user = User.new
      #   user.assign_attributes({ :name => 'Josh', :is_admin => true })
      #   user.name       # => "Josh"
      #   user.is_admin?  # => false
      #
      #   user = User.new
      #   user.assign_attributes({ :name => 'Josh', :is_admin => true }, :as => :admin)
      #   user.name       # => "Josh"
      #   user.is_admin?  # => true
      #
      #   user = User.new
      #   user.assign_attributes({ :name => 'Josh', :is_admin => true }, :without_protection => true)
      #   user.name       # => "Josh"
      #   user.is_admin?  # => true
      def assign_attributes(new_attributes, options = {})
1767 1768
        return unless new_attributes

1769
        attributes = new_attributes.stringify_keys
D
Initial  
David Heinemeier Hansson 已提交
1770
        multi_parameter_attributes = []
1771
        @mass_assignment_options = options
1772 1773

        unless options[:without_protection]
1774
          attributes = sanitize_for_mass_assignment(attributes, mass_assignment_role)
1775
        end
1776

1777
        attributes.each do |k, v|
1778 1779
          if k.include?("(")
            multi_parameter_attributes << [ k, v ]
1780 1781
          elsif respond_to?("#{k}=")
            send("#{k}=", v)
1782
          else
1783
            raise(UnknownAttributeError, "unknown attribute: #{k}")
1784
          end
D
Initial  
David Heinemeier Hansson 已提交
1785
        end
D
David Heinemeier Hansson 已提交
1786

1787
        @mass_assignment_options = nil
D
Initial  
David Heinemeier Hansson 已提交
1788 1789 1790
        assign_multiparameter_attributes(multi_parameter_attributes)
      end

1791
      # Returns a hash of all the attributes with their names as keys and the values of the attributes as values.
1792
      def attributes
1793
        Hash[@attributes.map { |name, _| [name, read_attribute(name)] }]
1794 1795
      end

P
Pratik Naik 已提交
1796
      # Returns an <tt>#inspect</tt>-like string for the value of the
V
Vijay Dev 已提交
1797
      # attribute +attr_name+. String attributes are truncated upto 50
P
Pratik Naik 已提交
1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808
      # characters, and Date and Time attributes are returned in the
      # <tt>:db</tt> format. Other attributes return the value of
      # <tt>#inspect</tt> without modification.
      #
      #   person = Person.create!(:name => "David Heinemeier Hansson " * 3)
      #
      #   person.attribute_for_inspect(:name)
      #   # => '"David Heinemeier Hansson David Heinemeier Hansson D..."'
      #
      #   person.attribute_for_inspect(:created_at)
      #   # => '"2009-01-12 04:48:57"'
1809 1810 1811
      def attribute_for_inspect(attr_name)
        value = read_attribute(attr_name)

1812
        if value.is_a?(String) && value.length > 50
1813
          "#{value[0..50]}...".inspect
1814 1815
        elsif value.is_a?(Date) || value.is_a?(Time)
          %("#{value.to_s(:db)}")
1816 1817 1818 1819 1820
        else
          value.inspect
        end
      end

D
Initial  
David Heinemeier Hansson 已提交
1821
      # Returns true if the specified +attribute+ has been set by the user or by a database load and is neither
1822
      # nil nor empty? (the latter only applies to objects that respond to empty?, most notably Strings).
D
Initial  
David Heinemeier Hansson 已提交
1823
      def attribute_present?(attribute)
1824
        value = read_attribute(attribute)
1825
        !value.nil? || (value.respond_to?(:empty?) && !value.empty?)
D
Initial  
David Heinemeier Hansson 已提交
1826 1827 1828 1829
      end

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

1833
      # Returns true if +comparison_object+ is the same exact object, or +comparison_object+
X
Xavier Noria 已提交
1834 1835 1836 1837 1838 1839 1840 1841
      # is of the same type and +self+ has an ID and it is equal to +comparison_object.id+.
      #
      # Note that new records are different from any other record by definition, unless the
      # other record is the receiver itself. Besides, if you fetch existing records with
      # +select+ and leave the ID out, you're on your own, this predicate will return false.
      #
      # Note also that destroying a record preserves its ID in the model instance, so deleted
      # models are still comparable.
D
Initial  
David Heinemeier Hansson 已提交
1842
      def ==(comparison_object)
1843
        super ||
1844 1845 1846
          comparison_object.instance_of?(self.class) &&
          id.present? &&
          comparison_object.id == id
D
Initial  
David Heinemeier Hansson 已提交
1847
      end
1848
      alias :eql? :==
1849

D
Initial  
David Heinemeier Hansson 已提交
1850 1851 1852
      # 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
1853
        id.hash
D
Initial  
David Heinemeier Hansson 已提交
1854 1855
      end

1856
      # Freeze the attributes hash such that associations are still accessible, even on destroyed records.
1857
      def freeze
1858
        @attributes.freeze; self
1859
      end
1860

1861
      # Returns +true+ if the attributes hash has been frozen.
1862 1863 1864
      def frozen?
        @attributes.frozen?
      end
1865

1866 1867
      # Allows sort on objects
      def <=>(other_object)
1868 1869 1870 1871 1872
        if other_object.is_a?(self.class)
          self.to_key <=> other_object.to_key
        else
          nil
        end
1873 1874
      end

A
Aaron Patterson 已提交
1875 1876 1877 1878 1879 1880 1881 1882 1883
      # Backport dup from 1.9 so that initialize_dup() gets called
      unless Object.respond_to?(:initialize_dup)
        def dup # :nodoc:
          copy = super
          copy.initialize_dup(self)
          copy
        end
      end

A
Aaron Patterson 已提交
1884
      # Duped objects have no id assigned and are treated as new records. Note
A
Aaron Patterson 已提交
1885 1886
      # that this is a "shallow" copy as it copies the object's attributes
      # only, not its associations. The extent of a "deep" copy is application
A
Aaron Patterson 已提交
1887 1888
      # specific and is therefore left to the application to implement according
      # to its need.
1889
      # The dup method does not preserve the timestamps (created|updated)_(at|on).
A
Aaron Patterson 已提交
1890
      def initialize_dup(other)
A
Aaron Patterson 已提交
1891 1892 1893
        cloned_attributes = other.clone_attributes(:read_attribute_before_type_cast)
        cloned_attributes.delete(self.class.primary_key)

A
Aaron Patterson 已提交
1894 1895
        @attributes = cloned_attributes

A
Aaron Patterson 已提交
1896 1897
        _run_after_initialize_callbacks if respond_to?(:_run_after_initialize_callbacks)

A
Aaron Patterson 已提交
1898 1899 1900 1901
        @changed_attributes = {}
        attributes_from_column_definition.each do |attr, orig_value|
          @changed_attributes[attr] = orig_value if field_changed?(attr, orig_value, @attributes[attr])
        end
A
Aaron Patterson 已提交
1902

1903
        @aggregation_cache = {}
1904 1905
        @association_cache = {}
        @attributes_cache = {}
1906
        @new_record  = true
A
Aaron Patterson 已提交
1907

A
Aaron Patterson 已提交
1908 1909
        ensure_proper_type
        populate_with_current_scope_attributes
1910
        super
1911 1912
      end

1913 1914
      # Returns +true+ if the record is read only. Records loaded through joins with piggy-back
      # attributes will be marked as read only since they cannot be saved.
1915
      def readonly?
1916
        @readonly
1917 1918
      end

1919 1920
      # Marks this record as read only.
      def readonly!
1921 1922
        @readonly = true
      end
1923

1924
      # Returns the contents of the record as a nicely formatted string.
1925
      def inspect
1926 1927 1928 1929 1930 1931 1932 1933 1934 1935
        inspection = if @attributes
                       self.class.column_names.collect { |name|
                         if has_attribute?(name)
                           "#{name}: #{attribute_for_inspect(name)}"
                         end
                       }.compact.join(", ")
                     else
                       "not initialized"
                     end
        "#<#{self.class} #{inspection}>"
1936
      end
1937

1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957
      # Hackery to accomodate Syck. Remove for 4.0.
      def to_yaml(opts = {}) #:nodoc:
        if YAML.const_defined?(:ENGINE) && !YAML::ENGINE.syck?
          super
        else
          coder = {}
          encode_with(coder)
          YAML.quick_emit(self, opts) do |out|
            out.map(taguri, to_yaml_style) do |map|
              coder.each { |k, v| map.add(k, v) }
            end
          end
        end
      end

      # Hackery to accomodate Syck. Remove for 4.0.
      def yaml_initialize(tag, coder) #:nodoc:
        init_with(coder)
      end

1958 1959
    protected
      def clone_attributes(reader_method = :read_attribute, attributes = {})
1960 1961
        attribute_names.each do |name|
          attributes[name] = clone_attribute_value(reader_method, name)
1962
        end
1963
        attributes
1964 1965 1966 1967 1968 1969 1970 1971 1972
      end

      def clone_attribute_value(reader_method, attribute_name)
        value = send(reader_method, attribute_name)
        value.duplicable? ? value.clone : value
      rescue TypeError, NoMethodError
        value
      end

1973 1974 1975 1976 1977 1978 1979 1980
      def mass_assignment_options
        @mass_assignment_options ||= {}
      end

      def mass_assignment_role
        mass_assignment_options[:as] || :default
      end

D
Initial  
David Heinemeier Hansson 已提交
1981 1982
    private

1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994
      # Under Ruby 1.9, Array#flatten will call #to_ary (recursively) on each of the elements
      # of the array, and then rescues from the possible NoMethodError. If those elements are
      # ActiveRecord::Base's, then this triggers the various method_missing's that we have,
      # which significantly impacts upon performance.
      #
      # So we can avoid the method_missing hit by explicitly defining #to_ary as nil here.
      #
      # See also http://tenderlovemaking.com/2011/06/28/til-its-ok-to-return-nil-from-to_ary/
      def to_ary # :nodoc:
        nil
      end

1995
      # Sets the attribute used for single table inheritance to this class name if this is not the
1996
      # ActiveRecord::Base descendant.
1997 1998
      # Considering the hierarchy Reply < Message < ActiveRecord::Base, this makes it possible to
      # do Reply.new without having to set <tt>Reply[Reply.inheritance_column] = "Reply"</tt> yourself.
1999
      # No such attribute would be set for objects of the Message class in that example.
D
Initial  
David Heinemeier Hansson 已提交
2000
      def ensure_proper_type
2001 2002 2003
        klass = self.class
        if klass.finder_needs_type_condition?
          write_attribute(klass.inheritance_column, klass.sti_name)
D
Initial  
David Heinemeier Hansson 已提交
2004 2005 2006
        end
      end

2007
      # The primary key and inheritance column can never be set by mass-assignment for security reasons.
2008
      def self.attributes_protected_by_default
2009 2010
        default = [ primary_key, inheritance_column ]
        default << 'id' unless primary_key.eql? 'id'
2011
        default
2012 2013
      end

2014 2015
      # Returns a copy of the attributes hash where all the values have been safely quoted for use in
      # an Arel insert/update method.
2016
      def arel_attributes_values(include_primary_key = true, include_readonly_attributes = true, attribute_names = @attributes.keys)
2017 2018 2019 2020
        attrs      = {}
        klass      = self.class
        arel_table = klass.arel_table

2021 2022 2023 2024
        attribute_names.each do |name|
          if (column = column_for_attribute(name)) && (include_primary_key || !column.primary)

            if include_readonly_attributes || (!include_readonly_attributes && !self.class.readonly_attributes.include?(name))
2025

J
Jon Leighton 已提交
2026 2027
              value = if klass.serialized_attributes.include?(name)
                        @attributes[name].serialized_value
2028 2029 2030 2031 2032 2033 2034 2035
                      else
                        # FIXME: we need @attributes to be used consistently.
                        # If the values stored in @attributes were already type
                        # casted, this code could be simplified
                        read_attribute(name)
                      end

              attrs[arel_table[name]] = value
2036 2037 2038 2039 2040 2041
            end
          end
        end
        attrs
      end

D
Initial  
David Heinemeier Hansson 已提交
2042
      # Quote strings appropriately for SQL statements.
2043
      def quote_value(value, column = nil)
2044
        self.class.connection.quote(value, column)
D
Initial  
David Heinemeier Hansson 已提交
2045 2046 2047 2048 2049 2050
      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
2051 2052
      # parentheses to have the parameters typecasted before they're used in the constructor. Use i for Fixnum,
      # f for Float, s for String, and a for Array. If all the values for a given attribute are empty, the
2053
      # attribute will be set to nil.
D
Initial  
David Heinemeier Hansson 已提交
2054 2055 2056 2057 2058
      def assign_multiparameter_attributes(pairs)
        execute_callstack_for_multiparameter_attributes(
          extract_callstack_for_multiparameter_attributes(pairs)
        )
      end
2059

2060
      def instantiate_time_object(name, values)
2061
        if self.class.send(:create_time_zone_conversion_attribute?, name, column_for_attribute(name))
2062
          Time.zone.local(*values)
2063
        else
2064
          Time.time_with_datetime_fallback(@@default_timezone, *values)
2065
        end
2066 2067
      end

D
Initial  
David Heinemeier Hansson 已提交
2068
      def execute_callstack_for_multiparameter_attributes(callstack)
2069
        errors = []
2070
        callstack.each do |name, values_with_empty_parameters|
2071
          begin
2072
            send(name + "=", read_value_from_parameter(name, values_with_empty_parameters))
2073
          rescue => ex
2074
            errors << AttributeAssignmentError.new("error on assignment #{values_with_empty_parameters.values.inspect} to #{name}", ex, name)
D
Initial  
David Heinemeier Hansson 已提交
2075 2076
          end
        end
2077 2078 2079
        unless errors.empty?
          raise MultiparameterAssignmentErrors.new(errors), "#{errors.size} error(s) on assignment of multiparameter attributes"
        end
D
Initial  
David Heinemeier Hansson 已提交
2080
      end
2081

2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098
      def read_value_from_parameter(name, values_hash_from_param)
        klass = (self.class.reflect_on_aggregation(name.to_sym) || column_for_attribute(name)).klass
        if values_hash_from_param.values.all?{|v|v.nil?}
          nil
        elsif klass == Time
          read_time_parameter_value(name, values_hash_from_param)
        elsif klass == Date
          read_date_parameter_value(name, values_hash_from_param)
        else
          read_other_parameter_value(klass, name, values_hash_from_param)
        end
      end

      def read_time_parameter_value(name, values_hash_from_param)
        # If Date bits were not provided, error
        raise "Missing Parameter" if [1,2,3].any?{|position| !values_hash_from_param.has_key?(position)}
        max_position = extract_max_param_for_multiparameter_attributes(values_hash_from_param, 6)
2099 2100 2101
        # If Date bits were provided but blank, then return nil
        return nil if (1..3).any? {|position| values_hash_from_param[position].blank?}

2102 2103
        set_values = (1..max_position).collect{|position| values_hash_from_param[position] }
        # If Time bits are not there, then default to 0
2104
        (3..5).each {|i| set_values[i] = set_values[i].blank? ? 0 : set_values[i]}
2105 2106 2107 2108
        instantiate_time_object(name, set_values)
      end

      def read_date_parameter_value(name, values_hash_from_param)
2109 2110
        return nil if (1..3).any? {|position| values_hash_from_param[position].blank?}
        set_values = [values_hash_from_param[1], values_hash_from_param[2], values_hash_from_param[3]]
2111 2112
        begin
          Date.new(*set_values)
2113
        rescue ArgumentError # if Date.new raises an exception on an invalid date
2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130
          instantiate_time_object(name, set_values).to_date # we instantiate Time object and convert it back to a date thus using Time's logic in handling invalid dates
        end
      end

      def read_other_parameter_value(klass, name, values_hash_from_param)
        max_position = extract_max_param_for_multiparameter_attributes(values_hash_from_param)
        values = (1..max_position).collect do |position|
          raise "Missing Parameter" if !values_hash_from_param.has_key?(position)
          values_hash_from_param[position]
        end
        klass.new(*values)
      end

      def extract_max_param_for_multiparameter_attributes(values_hash_from_param, upper_cap = 100)
        [values_hash_from_param.keys.max,upper_cap].min
      end

D
Initial  
David Heinemeier Hansson 已提交
2131 2132 2133
      def extract_callstack_for_multiparameter_attributes(pairs)
        attributes = { }

2134
        pairs.each do |pair|
D
Initial  
David Heinemeier Hansson 已提交
2135 2136
          multiparameter_name, value = pair
          attribute_name = multiparameter_name.split("(").first
2137
          attributes[attribute_name] = {} unless attributes.include?(attribute_name)
D
Initial  
David Heinemeier Hansson 已提交
2138

2139
          parameter_value = value.empty? ? nil : type_cast_attribute_value(multiparameter_name, value)
2140
          attributes[attribute_name][find_parameter_position(multiparameter_name)] ||= parameter_value
D
Initial  
David Heinemeier Hansson 已提交
2141 2142
        end

2143
        attributes
D
Initial  
David Heinemeier Hansson 已提交
2144
      end
2145

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

D
Initial  
David Heinemeier Hansson 已提交
2150
      def find_parameter_position(multiparameter_name)
2151
        multiparameter_name.scan(/\(([0-9]*).*\)/).first.first.to_i
D
Initial  
David Heinemeier Hansson 已提交
2152
      end
2153

D
Initial  
David Heinemeier Hansson 已提交
2154 2155
      # Returns a comma-separated pair list, like "key1 = val1, key2 = val2".
      def comma_pair_list(hash)
2156
        hash.map { |k,v| "#{k} = #{v}" }.join(", ")
D
Initial  
David Heinemeier Hansson 已提交
2157 2158
      end

2159
      def quote_columns(quoter, hash)
2160
        Hash[hash.map { |name, value| [quoter.quote_column_name(name), value] }]
D
Initial  
David Heinemeier Hansson 已提交
2161 2162
      end

2163 2164
      def quoted_comma_pair_list(quoter, hash)
        comma_pair_list(quote_columns(quoter, hash))
D
Initial  
David Heinemeier Hansson 已提交
2165 2166
      end

2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178
      def convert_number_column_value(value)
        if value == false
          0
        elsif value == true
          1
        elsif value.is_a?(String) && value.blank?
          nil
        else
          value
        end
      end

2179
      def populate_with_current_scope_attributes
2180 2181
        return unless self.class.scope_attributes?

2182
        self.class.scope_attributes.each do |att,value|
2183
          send("#{att}=", value) if respond_to?("#{att}=")
2184 2185
        end
      end
J
Joshua Peek 已提交
2186

2187
    include ActiveRecord::Persistence
J
Joshua Peek 已提交
2188
    extend ActiveModel::Naming
J
Joshua Peek 已提交
2189
    extend QueryCache::ClassMethods
J
José Valim 已提交
2190
    extend ActiveSupport::Benchmarkable
2191
    extend ActiveSupport::DescendantsTracker
J
José Valim 已提交
2192

2193
    include ActiveModel::Conversion
J
Joshua Peek 已提交
2194
    include Validations
2195
    extend CounterCache
J
Joshua Peek 已提交
2196 2197
    include Locking::Optimistic, Locking::Pessimistic
    include AttributeMethods
J
Joshua Peek 已提交
2198
    include AttributeMethods::Read, AttributeMethods::Write, AttributeMethods::BeforeTypeCast, AttributeMethods::Query
2199
    include AttributeMethods::PrimaryKey
J
Joshua Peek 已提交
2200 2201
    include AttributeMethods::TimeZoneConversion
    include AttributeMethods::Dirty
2202
    include AttributeMethods::Serialization
2203
    include AttributeMethods::DeprecatedUnderscoreRead
2204
    include ActiveModel::MassAssignmentSecurity
2205
    include Callbacks, ActiveModel::Observing, Timestamp
J
Jon Leighton 已提交
2206
    include Associations, NamedScope
M
Marcin Raczkowski 已提交
2207
    include IdentityMap
2208
    include ActiveModel::SecurePassword
2209 2210 2211 2212

    # AutosaveAssociation needs to be included before Transactions, because we want
    # #save_with_autosave_associations to be wrapped inside a transaction.
    include AutosaveAssociation, NestedAttributes
2213
    include Aggregations, Transactions, Reflection, Serialization, Store
2214

2215
    NilClass.add_whiner(self) if NilClass.respond_to?(:add_whiner)
2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226

    # Returns the value of the attribute identified by <tt>attr_name</tt> after it has been typecast (for example,
    # "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).
    alias [] read_attribute

    # Updates the attribute identified by <tt>attr_name</tt> with the specified +value+.
    # (Alias for the protected write_attribute method).
    alias []= write_attribute

    public :[], :[]=
J
Joshua Peek 已提交
2227
  end
2228
end
2229

2230
require 'active_record/connection_adapters/abstract/connection_specification'
2231
ActiveSupport.run_load_hooks(:active_record, ActiveRecord::Base)