base.rb 87.0 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 27
require 'arel'
require 'active_record/errors'
28
require 'active_record/log_subscriber'
D
Initial  
David Heinemeier Hansson 已提交
29 30

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

P
Pratik Naik 已提交
331 332
    ##
    # :singleton-method:
P
Pratik Naik 已提交
333 334 335 336
    # Contains the database configuration - as is typically stored in config/database.yml -
    # as a Hash.
    #
    # For example, the following database.yml...
E
Emilio Tagua 已提交
337
    #
P
Pratik Naik 已提交
338 339 340
    #   development:
    #     adapter: sqlite3
    #     database: db/development.sqlite3
E
Emilio Tagua 已提交
341
    #
P
Pratik Naik 已提交
342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357
    #   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'
    #      }
    #   }
358
    cattr_accessor :configurations, :instance_writer => false
359 360
    @@configurations = {}

P
Pratik Naik 已提交
361 362
    ##
    # :singleton-method:
363 364 365
    # 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
366
    # latter is specified, the Product class will look for "product_id" instead of "id". Remember
367
    # that this is a global setting for all Active Records.
368
    cattr_accessor :primary_key_prefix_type, :instance_writer => false
D
Initial  
David Heinemeier Hansson 已提交
369 370
    @@primary_key_prefix_type = nil

P
Pratik Naik 已提交
371 372
    ##
    # :singleton-method:
373 374 375
    # 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.
376
    # By default, the prefix is the empty string.
377
    #
378 379
    # 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
380
    # returns your chosen prefix.
381 382
    class_attribute :table_name_prefix, :instance_writer => false
    self.table_name_prefix = ""
D
Initial  
David Heinemeier Hansson 已提交
383

P
Pratik Naik 已提交
384 385
    ##
    # :singleton-method:
D
Initial  
David Heinemeier Hansson 已提交
386 387
    # 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.
388 389
    class_attribute :table_name_suffix, :instance_writer => false
    self.table_name_suffix = ""
D
Initial  
David Heinemeier Hansson 已提交
390

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

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

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

P
Pratik Naik 已提交
417 418
    ##
    # :singleton-method:
419
    # Specify whether or not to use timestamps for migration versions
420 421 422
    cattr_accessor :timestamped_migrations , :instance_writer => false
    @@timestamped_migrations = true

423
    # Determine whether to store the full constant name including namespace when using STI
424
    class_attribute :store_full_sti_class
425
    self.store_full_sti_class = true
426

427
    # Stores the default scope for the class
428 429
    class_attribute :default_scopes, :instance_writer => false
    self.default_scopes = []
430

431 432 433 434
    # Boolean flag to prevent infinite recursion when evaluating default scopes
    class_attribute :apply_default_scope, :instance_writer => false
    self.apply_default_scope = true

J
Jeremy Kemper 已提交
435 436 437 438 439
    # Returns a hash of all the attributes that have been specified for serialization as
    # keys and their class restriction as values.
    class_attribute :serialized_attributes
    self.serialized_attributes = {}

440 441 442
    class_attribute :_attr_readonly, :instance_writer => false
    self._attr_readonly = []

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

S
Sebastian Martinez 已提交
450
      # Executes a custom SQL query against your database and returns all the results. The results will
451
      # be returned as an array with columns requested encapsulated as attributes of the model you call
S
Sebastian Martinez 已提交
452
      # this method from. If you call <tt>Product.find_by_sql</tt> then the results will be returned in
P
Pratik Naik 已提交
453
      # a Product object with the attributes you specified in the SQL query.
454
      #
455 456
      # 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
457 458
      # table.
      #
S
Sebastian Martinez 已提交
459 460
      # 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,
461
      # MySQL specific terms will lock you to using that particular database engine or require you to
P
Pratik Naik 已提交
462
      # change your call if you switch engines.
463 464
      #
      # ==== Examples
P
Pratik Naik 已提交
465
      #   # A simple SQL query spanning multiple tables
466 467 468 469 470
      #   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 已提交
471
      #   > [#<Post:0x36bff9c @attributes={"title"=>"The Cheap Man Buys Twice"}>, ...]
472 473
      def find_by_sql(sql, binds = [])
        connection.select_all(sanitize_sql(sql), "#{name} Load", binds).collect! { |record| instantiate(record) }
D
Initial  
David Heinemeier Hansson 已提交
474
      end
475

476
      # Creates an object (or multiple objects) and saves it to the database, if validations pass.
477 478
      # The resulting object is returned whether the object was saved successfully to the database or not.
      #
S
Sebastian Martinez 已提交
479
      # The +attributes+ parameter can be either be a Hash or an Array of Hashes. These Hashes describe the
480 481
      # attributes on the objects that are to be created.
      #
482 483 484
      # +create+ respects mass-assignment security and accepts either +:as+ or +:without_protection+ options
      # in the +options+ parameter.
      #
485 486 487
      # ==== Examples
      #   # Create a single new object
      #   User.create(:first_name => 'Jamie')
488
      #
489
      #   # Create a single new object using the :admin mass-assignment security role
490 491 492 493 494
      #   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)
      #
495
      #   # Create an Array of new objects
P
Pratik Naik 已提交
496
      #   User.create([{ :first_name => 'Jamie' }, { :first_name => 'Jeremy' }])
497 498 499 500 501 502 503
      #
      #   # 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 已提交
504
      #   User.create([{ :first_name => 'Jamie' }, { :first_name => 'Jeremy' }]) do |u|
505
      #     u.is_admin = false
506
      #   end
507
      def create(attributes = nil, options = {}, &block)
508
        if attributes.is_a?(Array)
509
          attributes.collect { |attr| create(attr, options, &block) }
510
        else
511
          object = new(attributes, options)
512
          yield(object) if block_given?
513 514 515
          object.save
          object
        end
D
Initial  
David Heinemeier Hansson 已提交
516 517 518
      end

      # Returns the result of an SQL statement that should only include a COUNT(*) in the SELECT part.
519
      # The use of this method should be restricted to complicated SQL queries that can't be executed
S
Sebastian Martinez 已提交
520
      # using the ActiveRecord::Calculations class methods. Look into those before using this.
521
      #
P
Pratik Naik 已提交
522
      # ==== Parameters
523
      #
P
Pratik Naik 已提交
524
      # * +sql+ - An SQL statement which should return a count query from the database, see the example below.
525 526 527
      #
      # ==== Examples
      #
528
      #   Product.count_by_sql "SELECT COUNT(*) FROM sales s, customers c WHERE s.customer_id = c.id"
D
Initial  
David Heinemeier Hansson 已提交
529
      def count_by_sql(sql)
530
        sql = sanitize_conditions(sql)
531
        connection.select_value(sql, "#{name} Count").to_i
D
Initial  
David Heinemeier Hansson 已提交
532
      end
533

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

540 541
      # Returns an array of all the attributes that have been specified as readonly.
      def readonly_attributes
542
        self._attr_readonly
D
Initial  
David Heinemeier Hansson 已提交
543 544
      end

545 546 547
      # If you have an attribute that needs to be saved to the database as an object, and retrieved as the same object,
      # then specify the name of that attribute using this method and it will be handled automatically.
      # The serialization is done through YAML. If +class_name+ is specified, the serialized object must be of that
P
Pratik Naik 已提交
548
      # class on retrieval or SerializationTypeMismatch will be raised.
D
David Heinemeier Hansson 已提交
549
      #
P
Pratik Naik 已提交
550
      # ==== Parameters
D
David Heinemeier Hansson 已提交
551
      #
P
Pratik Naik 已提交
552 553
      # * +attr_name+ - The field name that should be serialized.
      # * +class_name+ - Optional, class name that the object type should be equal to.
D
David Heinemeier Hansson 已提交
554 555 556
      #
      # ==== Example
      #   # Serialize a preferences attribute
557
      #   class User < ActiveRecord::Base
D
David Heinemeier Hansson 已提交
558 559
      #     serialize :preferences
      #   end
D
Initial  
David Heinemeier Hansson 已提交
560
      def serialize(attr_name, class_name = Object)
561 562 563 564 565 566
        coder = if [:load, :dump].all? { |x| class_name.respond_to?(x) }
                  class_name
                else
                  Coders::YAMLColumn.new(class_name)
                end

567 568 569
        # merge new serialized attribute and create new hash to ensure that each class in inheritance hierarchy
        # has its own hash of own serialized attributes
        self.serialized_attributes = serialized_attributes.merge(attr_name.to_s => coder)
D
Initial  
David Heinemeier Hansson 已提交
570
      end
571

572 573
      # 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
574
      # looks like: Reply < Message < ActiveRecord::Base, then Message is used
575 576
      # 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
577
      # English inflections. You can add new inflections in config/initializers/inflections.rb.
D
Initial  
David Heinemeier Hansson 已提交
578
      #
579
      # Nested classes are given table names prefixed by the singular form of
P
Pratik Naik 已提交
580 581 582
      # the parent's table name. Enclosing modules are not considered.
      #
      # ==== Examples
583
      #
584 585 586
      #   class Invoice < ActiveRecord::Base
      #   end
      #
587 588
      #   file                  class               table_name
      #   invoice.rb            Invoice             invoices
589
      #
590 591 592 593 594
      #   class Invoice < ActiveRecord::Base
      #     class Lineitem < ActiveRecord::Base
      #     end
      #   end
      #
595 596 597
      #   file                  class               table_name
      #   invoice.rb            Invoice::Lineitem   invoice_lineitems
      #
598 599 600 601 602
      #   module Invoice
      #     class Lineitem < ActiveRecord::Base
      #     end
      #   end
      #
603 604
      #   file                  class               table_name
      #   invoice/lineitem.rb   Invoice::Lineitem   lineitems
D
Initial  
David Heinemeier Hansson 已提交
605
      #
P
Pratik Naik 已提交
606
      # Additionally, the class-level +table_name_prefix+ is prepended and the
S
Sebastian Martinez 已提交
607
      # +table_name_suffix+ is appended. So if you have "myapp_" as a prefix,
608 609 610 611 612
      # the table name guess for an Invoice class becomes "myapp_invoices".
      # Invoice::Lineitem becomes "myapp_invoice_lineitems".
      #
      # You can also overwrite this class method to allow for unguessable
      # links, such as a Mouse class with a link to a "mice" table. Example:
D
Initial  
David Heinemeier Hansson 已提交
613 614
      #
      #   class Mouse < ActiveRecord::Base
615
      #     set_table_name "mice"
D
Initial  
David Heinemeier Hansson 已提交
616
      #   end
617
      def table_name
618 619 620
        reset_table_name
      end

621
      # Returns a quoted version of the table name, used to construct SQL statements.
P
Pratik Naik 已提交
622 623 624 625
      def quoted_table_name
        @quoted_table_name ||= connection.quote_table_name(table_name)
      end

626
      # Computes the table name, (re)sets it internally, and returns it.
D
David Heinemeier Hansson 已提交
627
      def reset_table_name #:nodoc:
628
        self.table_name = compute_table_name
D
Initial  
David Heinemeier Hansson 已提交
629 630
      end

631
      def full_table_name_prefix #:nodoc:
632 633 634
        (parents.detect{ |p| p.respond_to?(:table_name_prefix) } || self).table_name_prefix
      end

635
      # Defines the column name for use with single table inheritance. Use
N
Neeraj Singh 已提交
636
      # <tt>set_inheritance_column</tt> to set a different value.
D
Initial  
David Heinemeier Hansson 已提交
637
      def inheritance_column
A
Aaron Patterson 已提交
638
        @inheritance_column ||= "type"
D
Initial  
David Heinemeier Hansson 已提交
639 640
      end

S
Sebastian Martinez 已提交
641
      # Lazy-set the sequence name to the connection's default. This method
642
      # is only ever called once since set_sequence_name overrides it.
D
David Heinemeier Hansson 已提交
643
      def sequence_name #:nodoc:
644 645 646
        reset_sequence_name
      end

D
David Heinemeier Hansson 已提交
647
      def reset_sequence_name #:nodoc:
648 649 650
        default = connection.default_sequence_name(table_name, primary_key)
        set_sequence_name(default)
        default
651 652
      end

S
Sebastian Martinez 已提交
653
      # Sets the table name. If the value is nil or false then the value returned by the given
N
Neeraj Singh 已提交
654
      # block is used.
655 656 657 658
      #
      #   class Project < ActiveRecord::Base
      #     set_table_name "project"
      #   end
659
      def set_table_name(value = nil, &block)
660
        @quoted_table_name = nil
661
        define_attr_method :table_name, value, &block
662 663

        @relation = Relation.new(self, arel_table)
664 665 666 667 668
      end
      alias :table_name= :set_table_name

      # Sets the name of the inheritance column to use to the given value,
      # or (if the value # is nil or false) to the value returned by the
669
      # given block.
670 671 672 673 674 675
      #
      #   class Project < ActiveRecord::Base
      #     set_inheritance_column do
      #       original_inheritance_column + "_id"
      #     end
      #   end
676
      def set_inheritance_column(value = nil, &block)
677 678 679 680
        define_attr_method :inheritance_column, value, &block
      end
      alias :inheritance_column= :set_inheritance_column

681 682
      # 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
683 684
      # given block. This is required for Oracle and is useful for any
      # database which relies on sequences for primary key generation.
685
      #
686 687 688 689 690
      # 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.
691 692 693 694
      #
      #   class Project < ActiveRecord::Base
      #     set_sequence_name "projectseq"   # default would have been "project_seq"
      #   end
695
      def set_sequence_name(value = nil, &block)
696 697 698 699
        define_attr_method :sequence_name, value, &block
      end
      alias :sequence_name= :set_sequence_name

700 701
      # Indicates whether the table associated with this class exists
      def table_exists?
702
        connection.table_exists?(table_name)
703 704
      end

D
Initial  
David Heinemeier Hansson 已提交
705 706
      # Returns an array of column objects for the table associated with this class.
      def columns
A
Aaron Patterson 已提交
707
        connection_pool.columns[table_name]
D
Initial  
David Heinemeier Hansson 已提交
708
      end
709

710
      # Returns a hash of column objects for the table associated with this class.
D
Initial  
David Heinemeier Hansson 已提交
711
      def columns_hash
A
Aaron Patterson 已提交
712
        connection_pool.columns_hash[table_name]
D
Initial  
David Heinemeier Hansson 已提交
713
      end
714

D
David Heinemeier Hansson 已提交
715
      # Returns an array of column names as strings.
716
      def column_names
717
        @column_names ||= columns.map { |column| column.name }
718
      end
D
Initial  
David Heinemeier Hansson 已提交
719

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

P
Pratik Naik 已提交
740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765
      # 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
      #    def self.up
      #      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
      #
      #    def self.down
      #      drop_table :job_levels
      #    end
      #  end
766
      def reset_column_information
A
Aaron Patterson 已提交
767
        connection.clear_cache!
768
        undefine_attribute_methods
A
Aaron Patterson 已提交
769 770
        connection_pool.clear_table_cache!(table_name) if table_exists?

771
        @column_names = @content_columns = @dynamic_methods_hash = @inheritance_column = nil
772
        @arel_engine = @relation = nil
773 774
      end

775
      def clear_cache! # :nodoc:
A
Aaron Patterson 已提交
776
        connection_pool.clear_cache!
777 778
      end

779
      def attribute_method?(attribute)
J
José Valim 已提交
780
        super || (table_exists? && column_names.include?(attribute.to_s.sub(/=$/, '')))
781 782
      end

S
Sebastian Martinez 已提交
783 784 785
      # Returns an array of column names as strings if it's not
      # an abstract class and table exists.
      # Otherwise it returns an empty array.
786 787 788 789 790 791 792 793
      def attribute_names
        @attribute_names ||= if !abstract_class? && table_exists?
            column_names
          else
            []
          end
      end

794 795
      # Set the lookup ancestors for ActiveModel.
      def lookup_ancestors #:nodoc:
796 797
        klass = self
        classes = [klass]
798 799
        return classes if klass == ActiveRecord::Base

E
Emilio Tagua 已提交
800
        while klass != klass.base_class
801 802 803 804 805
          classes << klass = klass.superclass
        end
        classes
      end

806 807 808
      # Set the i18n scope to overwrite ActiveModel.
      def i18n_scope #:nodoc:
        :activerecord
D
Initial  
David Heinemeier Hansson 已提交
809
      end
810

811 812 813 814 815 816 817
      # 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 已提交
818 819
      end

820 821 822 823 824
      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 已提交
825
      # Returns a string like 'Post(id:integer, title:string, body:text)'
826
      def inspect
827 828 829 830
        if self == Base
          super
        elsif abstract_class?
          "#{super}(abstract)"
831
        elsif table_exists?
832 833
          attr_list = columns.map { |c| "#{c.name}: #{c.type}" } * ', '
          "#{super}(#{attr_list})"
834 835
        else
          "#{super}(Table doesn't exist)"
836
        end
837 838
      end

839
      def quote_value(value, column = nil) #:nodoc:
840
        connection.quote(value,column)
841 842
      end

843
      # Used to sanitize objects before they're used in an SQL SELECT statement. Delegates to <tt>connection.quote</tt>.
844
      def sanitize(object) #:nodoc:
845
        connection.quote(object)
D
Initial  
David Heinemeier Hansson 已提交
846 847
      end

848 849 850
      # Overwrite the default class equality method to provide support for association proxies.
      def ===(object)
        object.is_a?(self)
851
      end
852

853 854 855 856
      def symbolized_base_class
        @symbolized_base_class ||= base_class.to_s.to_sym
      end

857
      def symbolized_sti_name
858
        @symbolized_sti_name ||= sti_name.present? ? sti_name.to_sym : symbolized_base_class
859 860
      end

861 862 863
      # 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.
864 865 866
      #
      # 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.
867 868 869 870
      def base_class
        class_of_active_record_descendant(self)
      end

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

874
      # Returns whether this class is an abstract class or not.
875
      def abstract_class?
876
        defined?(@abstract_class) && @abstract_class == true
877 878
      end

879
      def respond_to?(method_id, include_private = false)
880 881
        if match = DynamicFinderMatch.match(method_id)
          return true if all_attributes_exists?(match.attribute_names)
882 883
        elsif match = DynamicScopeMatch.match(method_id)
          return true if all_attributes_exists?(match.attribute_names)
884
        end
885

886 887 888
        super
      end

889 890 891 892
      def sti_name
        store_full_sti_class ? name : name.demodulize
      end

P
Pratik Naik 已提交
893
      def arel_table
A
Aaron Patterson 已提交
894
        Arel::Table.new(table_name, arel_engine)
895 896
      end

897 898
      def arel_engine
        @arel_engine ||= begin
899
          if self == ActiveRecord::Base
900
            ActiveRecord::Base
901
          else
902
            connection_handler.connection_pools[name] ? self : superclass.arel_engine
903 904
          end
        end
905 906
      end

907 908 909
      # Returns a scope for this class without taking into account the default_scope.
      #
      #   class Post < ActiveRecord::Base
910 911 912
      #     def self.default_scope
      #       where :published => true
      #     end
913 914 915 916 917 918 919 920 921
      #   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 {
922
      #     Post.limit(10) # Fires "SELECT * FROM posts LIMIT 10"
923 924
      #   }
      #
925 926
      # 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.
927
      #
928 929
      # Post.unscoped.published
      # Post.published
930
      def unscoped #:nodoc:
931 932 933
        block_given? ? relation.scoping { yield } : relation
      end

934
      def before_remove_const #:nodoc:
935
        self.current_scope = nil
936 937
      end

J
Jon Leighton 已提交
938 939 940 941 942 943 944 945 946
      # Specifies how the record is loaded by +Marshal+.
      #
      # +_load+ sets an instance variable for each key in the hash it takes as input.
      # Override this method if you require more complex marshalling.
      def _load(data)
        record = allocate
        record.init_with(Marshal.load(data))
        record
      end
J
José Valim 已提交
947 948


949 950 951
      # 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.
952 953 954
      def instantiate(record)
        sti_class = find_sti_class(record[inheritance_column])
        record_id = sti_class.primary_key && record[sti_class.primary_key]
M
Marcin Raczkowski 已提交
955

956 957 958 959 960 961
        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)
962
          else
M
Marcin Raczkowski 已提交
963
            instance = sti_class.allocate.init_with('attributes' => record)
964
            IdentityMap.add(instance)
965
          end
966 967 968 969 970
        else
          instance = sti_class.allocate.init_with('attributes' => record)
        end

        instance
971
      end
972

D
Initial  
David Heinemeier Hansson 已提交
973
      private
J
José Valim 已提交
974 975 976

        def relation #:nodoc:
          @relation ||= Relation.new(self, arel_table)
977 978 979 980 981 982

          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 已提交
983
        end
984

985
        def find_sti_class(type_name)
986
          if type_name.blank? || !columns_hash.include?(inheritance_column)
987 988 989
            self
          else
            begin
990 991 992 993 994
              if store_full_sti_class
                ActiveSupport::Dependencies.constantize(type_name)
              else
                compute_type(type_name)
              end
995 996 997 998 999 1000 1001 1002 1003 1004
            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

1005
        def construct_finder_arel(options = {}, scope = nil)
1006
          relation = options.is_a?(Hash) ? unscoped.apply_finder_options(options) : options
1007
          relation = scope.merge(relation) if scope
1008
          relation
1009 1010
        end

1011 1012
        def type_condition(table = arel_table)
          sti_column = table[inheritance_column.to_sym]
1013
          sti_names  = ([self] + descendants).map { |model| model.sti_name }
1014

1015
          sti_column.in(sti_names)
D
Initial  
David Heinemeier Hansson 已提交
1016 1017 1018
        end

        # Guesses the table name, but does not decorate it with prefix and suffix information.
1019
        def undecorated_table_name(class_name = base_class.name)
1020 1021
          table_name = class_name.to_s.demodulize.underscore
          table_name = table_name.pluralize if pluralize_table_names
1022
          table_name
D
Initial  
David Heinemeier Hansson 已提交
1023 1024
        end

1025 1026 1027 1028 1029 1030 1031 1032
        # 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
1033
              contained += '_'
1034 1035 1036 1037 1038 1039 1040 1041
            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

1042
        # Enables dynamic finders like <tt>User.find_by_user_name(user_name)</tt> and
1043 1044
        # <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.
1045
        #
1046
        # It's even possible to use all the additional parameters to +find+. For example, the
1047
        # full interface for +find_all_by_amount+ is actually <tt>find_all_by_amount(amount, options)</tt>.
1048
        #
1049
        # Each dynamic finder using <tt>scoped_by_*</tt> is also defined in the class after it
1050
        # is first invoked, so that future attempts to use it do not run through method_missing.
1051
        def method_missing(method_id, *arguments, &block)
1052 1053
          if match = DynamicFinderMatch.match(method_id)
            attribute_names = match.attribute_names
1054
            super unless all_attributes_exists?(attribute_names)
1055
            if match.finder?
1056
              options = arguments.extract_options!
1057
              relation = options.any? ? scoped(options) : scoped
1058
              relation.send :find_by_attributes, match, attribute_names, *arguments
1059
            elsif match.instantiator?
1060
              scoped.send :find_or_instantiator_by_attributes, match, attribute_names, *arguments, &block
1061
            end
1062 1063 1064 1065
          elsif match = DynamicScopeMatch.match(method_id)
            attribute_names = match.attribute_names
            super unless all_attributes_exists?(attribute_names)
            if match.scope?
1066
              self.class_eval <<-METHOD, __FILE__, __LINE__ + 1
1067 1068 1069 1070 1071
                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
1072
              METHOD
1073 1074
              send(method_id, *arguments)
            end
1075 1076 1077 1078
          else
            super
          end
        end
D
Initial  
David Heinemeier Hansson 已提交
1079

1080 1081
        # Similar in purpose to +expand_hash_conditions_for_aggregates+.
        def expand_attribute_names_for_aggregates(attribute_names)
1082
          attribute_names.map { |attribute_name|
1083
            unless (aggregation = reflect_on_aggregation(attribute_name.to_sym)).nil?
1084 1085
              aggregate_mapping(aggregation).map do |field_attr, _|
                field_attr.to_sym
1086 1087
              end
            else
1088
              attribute_name.to_sym
1089
            end
1090
          }.flatten
1091 1092
        end

1093
        def all_attributes_exists?(attribute_names)
1094 1095
          (expand_attribute_names_for_aggregates(attribute_names) -
           column_methods_hash.keys).empty?
1096
        end
1097

D
Initial  
David Heinemeier Hansson 已提交
1098
      protected
N
Neeraj Singh 已提交
1099 1100
        # 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
1101
        # <tt>:create</tt> parameters are an attributes hash.
1102 1103 1104
        #
        #   class Article < ActiveRecord::Base
        #     def self.create_with_scope
1105
        #       with_scope(:find => where(:blog_id => 1), :create => { :blog_id => 1 }) do
1106 1107 1108 1109 1110 1111 1112
        #         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 已提交
1113
        # In nested scopings, all previous parameters are overwritten by the innermost rule, with the exception of
1114
        # <tt>where</tt>, <tt>includes</tt>, and <tt>joins</tt> operations in <tt>Relation</tt>, which are merged.
P
Pratik Naik 已提交
1115
        #
1116
        # <tt>joins</tt> operations are uniqued so multiple scopes can join in the same table without table aliasing
S
Sebastian Martinez 已提交
1117
        # problems. If you need to join multiple tables, but still want one of the tables to be uniqued, use the
P
Pratik Naik 已提交
1118
        # array of strings format for your joins.
1119 1120 1121
        #
        #   class Article < ActiveRecord::Base
        #     def self.find_with_scope
1122 1123 1124
        #       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
1125
        #         end
1126 1127
        #         with_scope(:find => where(:author_id => 3)) do
        #           all # => SELECT * from articles WHERE blog_id = 1 AND author_id = 3 LIMIT 1
1128 1129 1130 1131 1132
        #         end
        #       end
        #     end
        #   end
        #
1133
        # You can ignore any previous scopings by using the <tt>with_exclusive_scope</tt> method.
1134 1135 1136
        #
        #   class Article < ActiveRecord::Base
        #     def self.find_with_exclusive_scope
1137
        #       with_scope(:find => where(:blog_id => 1).limit(1)) do
1138
        #         with_exclusive_scope(:find => limit(10)) do
1139
        #           all # => SELECT * from articles LIMIT 10
1140 1141 1142 1143
        #         end
        #       end
        #     end
        #   end
P
Pratik Naik 已提交
1144
        #
N
Neeraj Singh 已提交
1145
        # *Note*: the +:find+ scope also has effect on update and deletion methods, like +update_all+ and +delete_all+.
1146 1147 1148 1149
        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)

1150
          previous_scope = self.current_scope
1151

1152
          if scope.is_a?(Hash)
1153
            # Dup first and second level of hash (method and params).
1154 1155 1156
            scope = scope.dup
            scope.each do |method, params|
              scope[method] = params.dup unless params == true
1157
            end
1158

1159 1160
            scope.assert_valid_keys([ :find, :create ])
            relation = construct_finder_arel(scope[:find] || {})
1161
            relation.default_scoped = true unless action == :overwrite
1162

1163
            if previous_scope && previous_scope.create_with_value && scope[:create]
1164
              scope_for_create = if action == :merge
1165
                previous_scope.create_with_value.merge(scope[:create])
1166
              else
1167
                scope[:create]
1168
              end
1169 1170 1171

              relation = relation.create_with(scope_for_create)
            else
1172 1173
              scope_for_create = scope[:create]
              scope_for_create ||= previous_scope.create_with_value if previous_scope
1174 1175 1176
              relation = relation.create_with(scope_for_create) if scope_for_create
            end

1177
            scope = relation
1178 1179
          end

1180
          scope = previous_scope.merge(scope) if previous_scope && action == :merge
1181

1182
          self.current_scope = scope
1183 1184 1185
          begin
            yield
          ensure
1186
            self.current_scope = previous_scope
1187 1188 1189 1190 1191
          end
        end

        # Works like with_scope, but discards any nested properties.
        def with_exclusive_scope(method_scoping = {}, &block)
1192
          if method_scoping.values.any? { |e| e.is_a?(ActiveRecord::Relation) }
1193 1194
            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:
1195

1196 1197 1198 1199 1200 1201 1202 1203 1204
  User.unscoped.where(:active => true)

Or call unscoped with a block:

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

MSG
1205
          end
1206 1207 1208
          with_scope(method_scoping, :overwrite, &block)
        end

1209
        def current_scope #:nodoc:
1210
          Thread.current[:"#{self}_current_scope"]
1211 1212 1213 1214 1215 1216
        end

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

1217
        # Use this macro in your model to set a default scope for all operations on
1218
        # the model.
1219
        #
1220 1221
        #   class Article < ActiveRecord::Base
        #     default_scope where(:published => true)
1222
        #   end
1223
        #
1224
        #   Article.all # => SELECT * FROM articles WHERE published = true
1225 1226
        #
        # The <tt>default_scope</tt> is also applied while creating/building a record. It is not
1227 1228
        # applied while updating a record.
        #
1229 1230
        #   Article.new.published    # => true
        #   Article.create.published # => true
1231
        #
1232 1233 1234 1235 1236 1237 1238 1239 1240
        # 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.)
        #
1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253
        # 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.
        #
1254 1255
        # If you need to do more complex things with a default scope, you can alternatively
        # define it as a class method:
1256
        #
1257 1258 1259 1260
        #   class Article < ActiveRecord::Base
        #     def self.default_scope
        #       # Should return a scope, you can call 'super' here etc.
        #     end
1261 1262
        #   end
        def default_scope(scope = {})
1263
          scope = Proc.new if block_given?
1264
          self.default_scopes = default_scopes + [scope]
1265
        end
1266

1267 1268
        # The apply_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...
1269
        def build_default_scope #:nodoc:
1270 1271 1272
          return unless apply_default_scope
          self.apply_default_scope = false

1273
          if method(:default_scope).owner != Base.singleton_class
1274
            default_scope
1275 1276 1277 1278
          elsif default_scopes.any?
            default_scopes.inject(relation) do |default_scope, scope|
              if scope.is_a?(Hash)
                default_scope.apply_finder_options(scope)
1279 1280
              elsif !scope.is_a?(Relation) && scope.respond_to?(:call)
                default_scope.merge(scope.call)
1281 1282 1283 1284 1285
              else
                default_scope.merge(scope)
              end
            end
          end
1286 1287
        ensure
          self.apply_default_scope = true
1288 1289
        end

P
Pratik Naik 已提交
1290
        # Returns the class type of the record using the current module as a prefix. So descendants of
1291
        # MyApp::Business::Account would appear as MyApp::Business::AccountSubclass.
D
Initial  
David Heinemeier Hansson 已提交
1292
        def compute_type(type_name)
1293 1294 1295
          if type_name.match(/^::/)
            # If the type is prefixed with a scope operator then we assume that
            # the type_name is an absolute reference.
1296
            ActiveSupport::Dependencies.constantize(type_name)
1297 1298 1299 1300 1301 1302 1303 1304
          else
            # Build a list of candidates to search for
            candidates = []
            name.scan(/::|$/) { candidates.unshift "#{$`}::#{type_name}" }
            candidates << type_name

            candidates.each do |candidate|
              begin
1305
                constant = ActiveSupport::Dependencies.constantize(candidate)
1306
                return constant if candidate == constant.to_s
1307 1308 1309
              rescue NameError => e
                # We don't want to swallow NoMethodError < NameError errors
                raise e unless e.instance_of?(NameError)
1310
              end
1311
            end
1312 1313

            raise NameError, "uninitialized constant #{candidates.first}"
D
Initial  
David Heinemeier Hansson 已提交
1314 1315 1316
          end
        end

P
Pratik Naik 已提交
1317 1318
        # Returns the class descending directly from ActiveRecord::Base or an
        # abstract class, if any, in the inheritance hierarchy.
1319
        def class_of_active_record_descendant(klass)
1320
          if klass.superclass == Base || klass.superclass.abstract_class?
1321
            klass
D
Initial  
David Heinemeier Hansson 已提交
1322 1323 1324
          elsif klass.superclass.nil?
            raise ActiveRecordError, "#{name} doesn't belong in a hierarchy descending from ActiveRecord"
          else
1325
            class_of_active_record_descendant(klass.superclass)
D
Initial  
David Heinemeier Hansson 已提交
1326 1327 1328
          end
        end

P
Pratik Naik 已提交
1329
        # Accepts an array, hash, or string of SQL conditions and sanitizes
1330
        # them into a valid SQL fragment for a WHERE clause.
1331 1332 1333
        #   ["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'"
1334
        def sanitize_sql_for_conditions(condition, table_name = self.table_name)
1335 1336
          return nil if condition.blank?

1337 1338
          case condition
            when Array; sanitize_sql_array(condition)
1339
            when Hash;  sanitize_sql_hash_for_conditions(condition, table_name)
1340 1341
            else        condition
          end
1342
        end
1343
        alias_method :sanitize_sql, :sanitize_sql_for_conditions
1344

P
Pratik Naik 已提交
1345
        # Accepts an array, hash, or string of SQL conditions and sanitizes
1346 1347 1348 1349 1350 1351 1352 1353 1354 1355
        # 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

1356 1357 1358 1359 1360
        def aggregate_mapping(reflection)
          mapping = reflection.options[:mapping] || [reflection.name, reflection.name]
          mapping.first.is_a?(Array) ? mapping : [mapping]
        end

P
Pratik Naik 已提交
1361
        # Accepts a hash of SQL conditions and replaces those attributes
1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390
        # 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

1391
        # Sanitizes a hash of attribute/value pairs into SQL conditions for a WHERE clause.
1392 1393 1394 1395
        #   { :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)"
1396 1397
        #   { :age => 13..18 }
        #     # => "age BETWEEN 13 AND 18"
1398 1399
        #   { 'other_records.id' => 7 }
        #     # => "`other_records`.`id` = 7"
1400 1401
        #   { :other_records => { :id => 7 } }
        #     # => "`other_records`.`id` = 7"
1402 1403 1404
        # 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'"
1405
        def sanitize_sql_hash_for_conditions(attrs, default_table_name = self.table_name)
1406 1407
          attrs = expand_hash_conditions_for_aggregates(attrs)

1408
          table = Arel::Table.new(table_name).alias(default_table_name)
1409 1410 1411 1412
          viz = Arel::Visitors.for(arel_engine)
          PredicateBuilder.build_from_hash(arel_engine, attrs, table).map { |b|
            viz.accept b
          }.join(' AND ')
1413
        end
1414 1415 1416 1417 1418 1419
        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)
1420
          attrs.map do |attr, value|
1421 1422 1423
            "#{connection.quote_column_name(attr)} = #{quote_bound_value(value)}"
          end.join(', ')
        end
1424

S
Sebastian Martinez 已提交
1425
        # Accepts an array of conditions. The array has each value
P
Pratik Naik 已提交
1426
        # sanitized and interpolated into the SQL statement.
1427
        #   ["name='%s' and group_id='%s'", "foo'bar", 4]  returns  "name='foo''bar' and group_id='4'"
1428
        def sanitize_sql_array(ary)
1429
          statement, *values = ary
1430
          if values.first.is_a?(Hash) && statement =~ /:\w+/
1431 1432
            replace_named_bind_variables(statement, values.first)
          elsif statement.include?('?')
1433
            replace_bind_variables(statement, values)
1434 1435
          elsif statement.blank?
            statement
1436
          else
1437
            statement % values.collect { |value| connection.quote_string(value.to_s) }
1438
          end
1439 1440
        end

1441 1442
        alias_method :sanitize_conditions, :sanitize_sql

D
David Heinemeier Hansson 已提交
1443
        def replace_bind_variables(statement, values) #:nodoc:
1444
          raise_if_bind_arity_mismatch(statement, statement.count('?'), values.size)
1445
          bound = values.dup
C
Comron Sattari 已提交
1446 1447
          c = connection
          statement.gsub('?') { quote_bound_value(bound.shift, c) }
1448 1449
        end

D
David Heinemeier Hansson 已提交
1450
        def replace_named_bind_variables(statement, bind_vars) #:nodoc:
1451 1452 1453 1454
          statement.gsub(/(:?):([a-zA-Z]\w*)/) do
            if $1 == ':' # skip postgresql casts
              $& # return the whole match
            elsif bind_vars.include?(match = $2.to_sym)
1455
              quote_bound_value(bind_vars[match])
1456 1457
            else
              raise PreparedStatementInvalid, "missing value for :#{match} in #{statement}"
1458 1459
            end
          end
1460 1461
        end

1462
        def expand_range_bind_variables(bind_vars) #:nodoc:
1463 1464 1465
          expanded = []

          bind_vars.each do |var|
1466 1467
            next if var.is_a?(Hash)

1468
            if var.is_a?(Range)
1469 1470
              expanded << var.first
              expanded << var.last
1471
            else
1472
              expanded << var
1473
            end
1474
          end
1475 1476

          expanded
1477 1478
        end

C
Comron Sattari 已提交
1479
        def quote_bound_value(value, c = connection) #:nodoc:
1480
          if value.respond_to?(:map) && !value.acts_like?(:string)
1481
            if value.respond_to?(:empty?) && value.empty?
C
Comron Sattari 已提交
1482
              c.quote(nil)
1483
            else
C
Comron Sattari 已提交
1484
              value.map { |v| c.quote(v) }.join(',')
1485
            end
1486
          else
C
Comron Sattari 已提交
1487
            c.quote(value)
1488 1489 1490
          end
        end

D
David Heinemeier Hansson 已提交
1491
        def raise_if_bind_arity_mismatch(statement, expected, provided) #:nodoc:
1492 1493 1494
          unless expected == provided
            raise PreparedStatementInvalid, "wrong number of bind variables (#{provided} for #{expected}) in: #{statement}"
          end
1495
        end
1496

D
David Heinemeier Hansson 已提交
1497
        def encode_quoted_value(value) #:nodoc:
1498
          quoted_value = connection.quote(value)
1499 1500
          quoted_value = "'#{quoted_value[1..-2].gsub(/\'/, "\\\\'")}'" if quoted_value.include?("\\\'") # (for ruby mode) "
          quoted_value
1501
        end
D
Initial  
David Heinemeier Hansson 已提交
1502 1503 1504 1505 1506
    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).
1507
      # In both instances, valid attribute keys are determined by the column names of the associated table --
D
Initial  
David Heinemeier Hansson 已提交
1508
      # hence you can't have attributes that aren't part of the table columns.
1509 1510 1511 1512 1513 1514 1515 1516
      #
      # +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')
      #
1517
      #   # Instantiates a single new object using the :admin mass-assignment security role
1518 1519 1520 1521 1522
      #   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 = {})
1523
        @attributes = attributes_from_column_definition
1524
        @association_cache = {}
1525
        @aggregation_cache = {}
1526
        @attributes_cache = {}
1527
        @new_record = true
1528
        @readonly = false
1529 1530
        @destroyed = false
        @marked_for_destruction = false
1531 1532
        @previously_changed = {}
        @changed_attributes = {}
1533

D
Initial  
David Heinemeier Hansson 已提交
1534
        ensure_proper_type
1535
        set_serialized_attributes
P
Pratik Naik 已提交
1536

1537
        populate_with_current_scope_attributes
1538 1539

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

1541
        result = yield self if block_given?
1542
        run_callbacks :initialize
1543
        result
D
Initial  
David Heinemeier Hansson 已提交
1544
      end
1545

1546
      # Populate +coder+ with attributes about this record that should be
S
Sebastian Martinez 已提交
1547
      # serialized. The structure of +coder+ defined in this method is
1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561
      # 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 已提交
1562 1563
      # Initialize an empty model object from +coder+. +coder+ must contain
      # the attributes necessary for initializing an empty model object. For
1564 1565 1566 1567 1568 1569 1570 1571 1572 1573
      # 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']
1574

1575
        set_serialized_attributes
1576

1577
        @attributes_cache, @previously_changed, @changed_attributes = {}, {}, {}
1578
        @association_cache = {}
1579
        @aggregation_cache = {}
1580
        @readonly = @destroyed = @marked_for_destruction = false
1581
        @new_record = false
1582 1583
        run_callbacks :find
        run_callbacks :initialize
M
Marcin Raczkowski 已提交
1584 1585

        self
1586 1587
      end

J
Jon Leighton 已提交
1588 1589 1590 1591 1592 1593 1594 1595 1596 1597
      # Specifies how the record is dumped by +Marshal+.
      #
      # +_dump+ emits a marshalled hash which has been passed to +encode_with+. Override this
      # method if you require more complex marshalling.
      def _dump(level)
        dump = {}
        encode_with(dump)
        Marshal.dump(dump)
      end

P
Pratik Naik 已提交
1598 1599 1600 1601
      # 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 已提交
1602
      # For example, suppose that you have a User model, and that you have a
1603
      # <tt>resources :users</tt> route. Normally, +user_path+ will
P
Pratik Naik 已提交
1604
      # construct a path with the user object's 'id' in it:
P
Pratik Naik 已提交
1605 1606
      #
      #   user = User.find_by_name('Phusion')
1607
      #   user_path(user)  # => "/users/1"
P
Pratik Naik 已提交
1608
      #
P
Pratik Naik 已提交
1609 1610
      # 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 已提交
1611 1612 1613 1614 1615 1616
      #
      #   class User < ActiveRecord::Base
      #     def to_param  # overridden
      #       name
      #     end
      #   end
E
Emilio Tagua 已提交
1617
      #
P
Pratik Naik 已提交
1618
      #   user = User.find_by_name('Phusion')
1619
      #   user_path(user)  # => "/users/Phusion"
1620
      def to_param
1621
        # We can't use alias_method here, because method 'id' optimizes itself on the fly.
1622
        id && id.to_s # Be sure to stringify the id for routes
1623
      end
1624

P
Pratik Naik 已提交
1625 1626 1627
      # Returns a cache key that can be used to identify this record.
      #
      # ==== Examples
1628 1629 1630 1631 1632
      #
      #   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
1633
        case
1634
        when new_record?
J
Jeremy Kemper 已提交
1635 1636 1637
          "#{self.class.model_name.cache_key}/new"
        when timestamp = self[:updated_at]
          "#{self.class.model_name.cache_key}/#{id}-#{timestamp.to_s(:number)}"
1638
        else
J
Jeremy Kemper 已提交
1639
          "#{self.class.model_name.cache_key}/#{id}"
1640 1641
        end
      end
1642

1643
      def quoted_id #:nodoc:
1644
        quote_value(id, column_for_attribute(self.class.primary_key))
1645
      end
1646

1647 1648 1649 1650 1651
      # Returns true if the given attribute is in the attributes hash
      def has_attribute?(attr_name)
        @attributes.has_key?(attr_name.to_s)
      end

1652
      # Returns an array of names for the attributes available on this object.
1653
      def attribute_names
1654
        @attributes.keys
D
Initial  
David Heinemeier Hansson 已提交
1655 1656 1657
      end

      # Allows you to set all the attributes at once by passing in a hash with keys
P
Pratik Naik 已提交
1658 1659
      # matching the attribute names (which again matches the column names).
      #
1660 1661 1662
      # If any attributes are protected by either +attr_protected+ or
      # +attr_accessible+ then only settable attributes will be assigned.
      #
P
Pratik Naik 已提交
1663 1664 1665
      #   class User < ActiveRecord::Base
      #     attr_protected :is_admin
      #   end
E
Emilio Tagua 已提交
1666
      #
P
Pratik Naik 已提交
1667 1668 1669 1670
      #   user = User.new
      #   user.attributes = { :username => 'Phusion', :is_admin => true }
      #   user.username   # => "Phusion"
      #   user.is_admin?  # => false
1671
      def attributes=(new_attributes)
P
Pratik Naik 已提交
1672
        return unless new_attributes.is_a?(Hash)
1673

1674
        assign_attributes(new_attributes)
1675 1676 1677
      end

      # Allows you to set all the attributes for a particular mass-assignment
1678 1679
      # security role by passing in a hash of attributes with keys matching
      # the attribute names (which again matches the column names) and the role
1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704
      # 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 = {})
1705 1706
        return unless new_attributes

1707
        attributes = new_attributes.stringify_keys
1708
        role = options[:as] || :default
D
Initial  
David Heinemeier Hansson 已提交
1709 1710

        multi_parameter_attributes = []
1711 1712

        unless options[:without_protection]
1713
          attributes = sanitize_for_mass_assignment(attributes, role)
1714
        end
1715

1716
        attributes.each do |k, v|
1717 1718
          if k.include?("(")
            multi_parameter_attributes << [ k, v ]
J
José Valim 已提交
1719 1720
          elsif respond_to?("#{k}=")
            send("#{k}=", v)
1721
          else
J
José Valim 已提交
1722
            raise(UnknownAttributeError, "unknown attribute: #{k}")
1723
          end
D
Initial  
David Heinemeier Hansson 已提交
1724
        end
D
David Heinemeier Hansson 已提交
1725

D
Initial  
David Heinemeier Hansson 已提交
1726 1727 1728
        assign_multiparameter_attributes(multi_parameter_attributes)
      end

1729
      # Returns a hash of all the attributes with their names as keys and the values of the attributes as values.
1730
      def attributes
1731
        Hash[@attributes.map { |name, _| [name, read_attribute(name)] }]
1732 1733
      end

P
Pratik Naik 已提交
1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746
      # Returns an <tt>#inspect</tt>-like string for the value of the
      # attribute +attr_name+. String attributes are elided after 50
      # 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"'
1747 1748 1749
      def attribute_for_inspect(attr_name)
        value = read_attribute(attr_name)

1750
        if value.is_a?(String) && value.length > 50
1751
          "#{value[0..50]}...".inspect
1752 1753
        elsif value.is_a?(Date) || value.is_a?(Time)
          %("#{value.to_s(:db)}")
1754 1755 1756 1757 1758
        else
          value.inspect
        end
      end

D
Initial  
David Heinemeier Hansson 已提交
1759
      # Returns true if the specified +attribute+ has been set by the user or by a database load and is neither
1760
      # nil nor empty? (the latter only applies to objects that respond to empty?, most notably Strings).
D
Initial  
David Heinemeier Hansson 已提交
1761
      def attribute_present?(attribute)
1762
        !_read_attribute(attribute).blank?
D
Initial  
David Heinemeier Hansson 已提交
1763 1764 1765 1766
      end

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

1770
      # Returns true if +comparison_object+ is the same exact object, or +comparison_object+
X
Xavier Noria 已提交
1771 1772 1773 1774 1775 1776 1777 1778
      # 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 已提交
1779
      def ==(comparison_object)
1780
        comparison_object.equal?(self) ||
1781 1782 1783
          comparison_object.instance_of?(self.class) &&
          id.present? &&
          comparison_object.id == id
D
Initial  
David Heinemeier Hansson 已提交
1784 1785 1786 1787
      end

      # Delegates to ==
      def eql?(comparison_object)
E
Emilio Tagua 已提交
1788
        self == comparison_object
D
Initial  
David Heinemeier Hansson 已提交
1789
      end
1790

D
Initial  
David Heinemeier Hansson 已提交
1791 1792 1793
      # 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
1794
        id.hash
D
Initial  
David Heinemeier Hansson 已提交
1795 1796
      end

1797
      # Freeze the attributes hash such that associations are still accessible, even on destroyed records.
1798
      def freeze
1799
        @attributes.freeze; self
1800
      end
1801

1802
      # Returns +true+ if the attributes hash has been frozen.
1803 1804 1805
      def frozen?
        @attributes.frozen?
      end
1806

A
Aaron Patterson 已提交
1807 1808 1809 1810 1811 1812 1813 1814 1815
      # 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 已提交
1816
      # Duped objects have no id assigned and are treated as new records. Note
A
Aaron Patterson 已提交
1817 1818
      # 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 已提交
1819 1820
      # specific and is therefore left to the application to implement according
      # to its need.
1821
      # The dup method does not preserve the timestamps (created|updated)_(at|on).
A
Aaron Patterson 已提交
1822
      def initialize_dup(other)
A
Aaron Patterson 已提交
1823 1824 1825
        cloned_attributes = other.clone_attributes(:read_attribute_before_type_cast)
        cloned_attributes.delete(self.class.primary_key)

A
Aaron Patterson 已提交
1826 1827
        @attributes = cloned_attributes

A
Aaron Patterson 已提交
1828 1829
        _run_after_initialize_callbacks if respond_to?(:_run_after_initialize_callbacks)

A
Aaron Patterson 已提交
1830 1831 1832 1833
        @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 已提交
1834

1835
        @aggregation_cache = {}
1836 1837
        @association_cache = {}
        @attributes_cache = {}
1838
        @new_record  = true
A
Aaron Patterson 已提交
1839

A
Aaron Patterson 已提交
1840 1841
        ensure_proper_type
        populate_with_current_scope_attributes
1842
        clear_timestamp_attributes
1843 1844
      end

1845 1846
      # 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.
1847
      def readonly?
1848
        @readonly
1849 1850
      end

1851 1852
      # Marks this record as read only.
      def readonly!
1853 1854
        @readonly = true
      end
1855

1856
      # Returns the contents of the record as a nicely formatted string.
1857
      def inspect
1858 1859 1860 1861 1862 1863 1864 1865 1866 1867
        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}>"
1868
      end
1869

1870 1871
    protected
      def clone_attributes(reader_method = :read_attribute, attributes = {})
1872 1873
        attribute_names.each do |name|
          attributes[name] = clone_attribute_value(reader_method, name)
1874
        end
1875
        attributes
1876 1877 1878 1879 1880 1881 1882 1883 1884
      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

D
Initial  
David Heinemeier Hansson 已提交
1885 1886
    private

A
Aaron Patterson 已提交
1887 1888 1889 1890 1891 1892 1893
      def set_serialized_attributes
        (@attributes.keys & self.class.serialized_attributes.keys).each do |key|
          coder = self.class.serialized_attributes[key]
          @attributes[key] = coder.load @attributes[key]
        end
      end

1894
      # Sets the attribute used for single table inheritance to this class name if this is not the
1895
      # ActiveRecord::Base descendant.
1896 1897
      # 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.
1898
      # No such attribute would be set for objects of the Message class in that example.
D
Initial  
David Heinemeier Hansson 已提交
1899 1900
      def ensure_proper_type
        unless self.class.descends_from_active_record?
1901
          write_attribute(self.class.inheritance_column, self.class.sti_name)
D
Initial  
David Heinemeier Hansson 已提交
1902 1903 1904
        end
      end

1905
      # The primary key and inheritance column can never be set by mass-assignment for security reasons.
1906 1907 1908
      def self.attributes_protected_by_default
        default = [ primary_key, inheritance_column ]
        default << 'id' unless primary_key.eql? 'id'
1909
        default
1910 1911
      end

1912 1913
      # Returns a copy of the attributes hash where all the values have been safely quoted for use in
      # an Arel insert/update method.
1914
      def arel_attributes_values(include_primary_key = true, include_readonly_attributes = true, attribute_names = @attributes.keys)
1915 1916 1917 1918
        attrs      = {}
        klass      = self.class
        arel_table = klass.arel_table

1919 1920 1921 1922
        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))
1923

1924 1925
              value = if coder = klass.serialized_attributes[name]
                        coder.dump @attributes[name]
1926 1927 1928 1929 1930 1931 1932 1933
                      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
1934 1935 1936 1937 1938 1939
            end
          end
        end
        attrs
      end

D
Initial  
David Heinemeier Hansson 已提交
1940
      # Quote strings appropriately for SQL statements.
1941
      def quote_value(value, column = nil)
1942
        self.class.connection.quote(value, column)
D
Initial  
David Heinemeier Hansson 已提交
1943 1944 1945 1946 1947 1948
      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
1949 1950
      # 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
1951
      # attribute will be set to nil.
D
Initial  
David Heinemeier Hansson 已提交
1952 1953 1954 1955 1956
      def assign_multiparameter_attributes(pairs)
        execute_callstack_for_multiparameter_attributes(
          extract_callstack_for_multiparameter_attributes(pairs)
        )
      end
1957

1958
      def instantiate_time_object(name, values)
1959
        if self.class.send(:create_time_zone_conversion_attribute?, name, column_for_attribute(name))
1960
          Time.zone.local(*values)
1961
        else
1962
          Time.time_with_datetime_fallback(@@default_timezone, *values)
1963
        end
1964 1965
      end

D
Initial  
David Heinemeier Hansson 已提交
1966
      def execute_callstack_for_multiparameter_attributes(callstack)
1967
        errors = []
1968
        callstack.each do |name, values_with_empty_parameters|
1969
          begin
1970
            send(name + "=", read_value_from_parameter(name, values_with_empty_parameters))
1971
          rescue => ex
1972
            errors << AttributeAssignmentError.new("error on assignment #{values_with_empty_parameters.values.inspect} to #{name}", ex, name)
D
Initial  
David Heinemeier Hansson 已提交
1973 1974
          end
        end
1975 1976 1977
        unless errors.empty?
          raise MultiparameterAssignmentErrors.new(errors), "#{errors.size} error(s) on assignment of multiparameter attributes"
        end
D
Initial  
David Heinemeier Hansson 已提交
1978
      end
1979

1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007
      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)
        set_values = (1..max_position).collect{|position| values_hash_from_param[position] }
        # If Date bits were provided but blank, then default to 1
        # If Time bits are not there, then default to 0
        [1,1,1,0,0,0].each_with_index{|v,i| set_values[i] = set_values[i].blank? ? v : set_values[i]}
        instantiate_time_object(name, set_values)
      end

      def read_date_parameter_value(name, values_hash_from_param)
        set_values = (1..3).collect{|position| values_hash_from_param[position].blank? ? 1 : values_hash_from_param[position]}
        begin
          Date.new(*set_values)
2008
        rescue ArgumentError # if Date.new raises an exception on an invalid date
2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025
          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 已提交
2026 2027 2028
      def extract_callstack_for_multiparameter_attributes(pairs)
        attributes = { }

2029
        pairs.each do |pair|
D
Initial  
David Heinemeier Hansson 已提交
2030 2031
          multiparameter_name, value = pair
          attribute_name = multiparameter_name.split("(").first
2032
          attributes[attribute_name] = {} unless attributes.include?(attribute_name)
D
Initial  
David Heinemeier Hansson 已提交
2033

2034
          parameter_value = value.empty? ? nil : type_cast_attribute_value(multiparameter_name, value)
2035
          attributes[attribute_name][find_parameter_position(multiparameter_name)] ||= parameter_value
D
Initial  
David Heinemeier Hansson 已提交
2036 2037
        end

2038
        attributes
D
Initial  
David Heinemeier Hansson 已提交
2039
      end
2040

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

D
Initial  
David Heinemeier Hansson 已提交
2045
      def find_parameter_position(multiparameter_name)
2046
        multiparameter_name.scan(/\(([0-9]*).*\)/).first.first.to_i
D
Initial  
David Heinemeier Hansson 已提交
2047
      end
2048

D
Initial  
David Heinemeier Hansson 已提交
2049 2050
      # Returns a comma-separated pair list, like "key1 = val1, key2 = val2".
      def comma_pair_list(hash)
2051
        hash.map { |k,v| "#{k} = #{v}" }.join(", ")
D
Initial  
David Heinemeier Hansson 已提交
2052 2053
      end

2054
      def quote_columns(quoter, hash)
2055
        Hash[hash.map { |name, value| [quoter.quote_column_name(name), value] }]
D
Initial  
David Heinemeier Hansson 已提交
2056 2057
      end

2058 2059
      def quoted_comma_pair_list(quoter, hash)
        comma_pair_list(quote_columns(quoter, hash))
D
Initial  
David Heinemeier Hansson 已提交
2060 2061
      end

2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073
      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

2074
      def populate_with_current_scope_attributes
2075 2076
        self.class.scoped.scope_for_create.each do |att,value|
          respond_to?("#{att}=") && send("#{att}=", value)
2077 2078
        end
      end
2079

2080
      # Clear attributes and changed_attributes
2081
      def clear_timestamp_attributes
2082 2083 2084
        all_timestamp_attributes_in_model.each do |attribute_name|
          self[attribute_name] = nil
          changed_attributes.delete(attribute_name)
2085 2086
        end
      end
D
Initial  
David Heinemeier Hansson 已提交
2087
  end
J
Joshua Peek 已提交
2088 2089

  Base.class_eval do
2090
    include ActiveRecord::Persistence
J
Joshua Peek 已提交
2091
    extend ActiveModel::Naming
J
Joshua Peek 已提交
2092
    extend QueryCache::ClassMethods
J
José Valim 已提交
2093
    extend ActiveSupport::Benchmarkable
2094
    extend ActiveSupport::DescendantsTracker
J
José Valim 已提交
2095

2096
    include ActiveModel::Conversion
J
Joshua Peek 已提交
2097
    include Validations
2098
    extend CounterCache
J
Joshua Peek 已提交
2099 2100
    include Locking::Optimistic, Locking::Pessimistic
    include AttributeMethods
J
Joshua Peek 已提交
2101
    include AttributeMethods::Read, AttributeMethods::Write, AttributeMethods::BeforeTypeCast, AttributeMethods::Query
2102
    include AttributeMethods::PrimaryKey
J
Joshua Peek 已提交
2103 2104
    include AttributeMethods::TimeZoneConversion
    include AttributeMethods::Dirty
2105
    include ActiveModel::MassAssignmentSecurity
2106
    include Callbacks, ActiveModel::Observing, Timestamp
J
Jon Leighton 已提交
2107
    include Associations, NamedScope
M
Marcin Raczkowski 已提交
2108
    include IdentityMap
2109
    include ActiveModel::SecurePassword
2110 2111 2112 2113

    # AutosaveAssociation needs to be included before Transactions, because we want
    # #save_with_autosave_associations to be wrapped inside a transaction.
    include AutosaveAssociation, NestedAttributes
P
Pratik Naik 已提交
2114
    include Aggregations, Transactions, Reflection, Serialization
2115

2116
    NilClass.add_whiner(self) if NilClass.respond_to?(:add_whiner)
2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127

    # 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 已提交
2128
  end
2129
end
2130 2131 2132

# TODO: Remove this and make it work with LAZY flag
require 'active_record/connection_adapters/abstract_adapter'
2133
ActiveSupport.run_load_hooks(:active_record, ActiveRecord::Base)