base.rb 87.6 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
        @arel_table = Arel::Table.new(table_name, arel_engine)
664
        @relation = Relation.new(self, arel_table)
665 666 667 668 669
      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
670
      # given block.
671 672 673 674 675 676
      #
      #   class Project < ActiveRecord::Base
      #     set_inheritance_column do
      #       original_inheritance_column + "_id"
      #     end
      #   end
677
      def set_inheritance_column(value = nil, &block)
678 679 680 681
        define_attr_method :inheritance_column, value, &block
      end
      alias :inheritance_column= :set_inheritance_column

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

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

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

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

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

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

P
Pratik Naik 已提交
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 766
      # 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
767
      def reset_column_information
A
Aaron Patterson 已提交
768
        connection.clear_cache!
769
        undefine_attribute_methods
A
Aaron Patterson 已提交
770 771
        connection_pool.clear_table_cache!(table_name) if table_exists?

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

887 888 889
        super
      end

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

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

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

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

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

J
Jon Leighton 已提交
939 940 941 942 943 944 945 946 947
      # 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 已提交
948 949


950 951 952
      # 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.
953 954 955
      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 已提交
956

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

        instance
972
      end
973

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

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

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

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

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

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

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

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

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

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

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

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

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

1151
          previous_scope = self.current_scope
1152

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

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

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

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

1178
            scope = relation
1179 1180
          end

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

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

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

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

Or call unscoped with a block:

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

P
Pratik Naik 已提交
1363
        # Accepts a hash of SQL conditions and replaces those attributes
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 1391 1392
        # 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

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

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

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

1443 1444
        alias_method :sanitize_conditions, :sanitize_sql

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

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

1464
        def expand_range_bind_variables(bind_vars) #:nodoc:
1465 1466 1467
          expanded = []

          bind_vars.each do |var|
1468 1469
            next if var.is_a?(Hash)

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

          expanded
1479 1480
        end

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

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

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

D
Initial  
David Heinemeier Hansson 已提交
1536
        ensure_proper_type
1537
        set_serialized_attributes
P
Pratik Naik 已提交
1538

1539
        populate_with_current_scope_attributes
1540 1541

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

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

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

1577
        set_serialized_attributes
1578

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

        self
1588 1589
      end

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

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

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

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

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

      # Allows you to set all the attributes at once by passing in a hash with keys
P
Pratik Naik 已提交
1660 1661
      # matching the attribute names (which again matches the column names).
      #
1662 1663 1664 1665 1666
      # If any attributes are protected by either +attr_protected+ or
      # +attr_accessible+ then only settable attributes will be assigned.
      #
      # The +guard_protected_attributes+ argument is now deprecated, use
      # the +assign_attributes+ method if you want to bypass mass-assignment security.
P
Pratik Naik 已提交
1667 1668 1669 1670
      #
      #   class User < ActiveRecord::Base
      #     attr_protected :is_admin
      #   end
E
Emilio Tagua 已提交
1671
      #
P
Pratik Naik 已提交
1672 1673 1674 1675
      #   user = User.new
      #   user.attributes = { :username => 'Phusion', :is_admin => true }
      #   user.username   # => "Phusion"
      #   user.is_admin?  # => false
1676 1677 1678 1679 1680 1681 1682
      def attributes=(new_attributes, guard_protected_attributes = nil)
        unless guard_protected_attributes.nil?
          message = "the use of 'guard_protected_attributes' will be removed from the next major release of rails, " +
                    "if you want to bypass mass-assignment security then look into using assign_attributes"
          ActiveSupport::Deprecation.warn(message)
        end

P
Pratik Naik 已提交
1683
        return unless new_attributes.is_a?(Hash)
1684

1685
        if guard_protected_attributes == false
1686
          assign_attributes(new_attributes, :without_protection => true)
1687 1688
        else
          assign_attributes(new_attributes)
1689 1690 1691 1692
        end
      end

      # Allows you to set all the attributes for a particular mass-assignment
1693 1694
      # security role by passing in a hash of attributes with keys matching
      # the attribute names (which again matches the column names) and the role
1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719
      # 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 = {})
1720 1721
        return unless new_attributes

1722
        attributes = new_attributes.stringify_keys
1723
        role = options[:as] || :default
D
Initial  
David Heinemeier Hansson 已提交
1724 1725

        multi_parameter_attributes = []
1726 1727

        unless options[:without_protection]
1728
          attributes = sanitize_for_mass_assignment(attributes, role)
1729
        end
1730

1731
        attributes.each do |k, v|
1732 1733
          if k.include?("(")
            multi_parameter_attributes << [ k, v ]
J
José Valim 已提交
1734 1735
          elsif respond_to?("#{k}=")
            send("#{k}=", v)
1736
          else
J
José Valim 已提交
1737
            raise(UnknownAttributeError, "unknown attribute: #{k}")
1738
          end
D
Initial  
David Heinemeier Hansson 已提交
1739
        end
D
David Heinemeier Hansson 已提交
1740

D
Initial  
David Heinemeier Hansson 已提交
1741 1742 1743
        assign_multiparameter_attributes(multi_parameter_attributes)
      end

1744
      # Returns a hash of all the attributes with their names as keys and the values of the attributes as values.
1745
      def attributes
1746
        Hash[@attributes.map { |name, _| [name, read_attribute(name)] }]
1747 1748
      end

P
Pratik Naik 已提交
1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761
      # 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"'
1762 1763 1764
      def attribute_for_inspect(attr_name)
        value = read_attribute(attr_name)

1765
        if value.is_a?(String) && value.length > 50
1766
          "#{value[0..50]}...".inspect
1767 1768
        elsif value.is_a?(Date) || value.is_a?(Time)
          %("#{value.to_s(:db)}")
1769 1770 1771 1772 1773
        else
          value.inspect
        end
      end

D
Initial  
David Heinemeier Hansson 已提交
1774
      # Returns true if the specified +attribute+ has been set by the user or by a database load and is neither
1775
      # nil nor empty? (the latter only applies to objects that respond to empty?, most notably Strings).
D
Initial  
David Heinemeier Hansson 已提交
1776
      def attribute_present?(attribute)
1777
        !_read_attribute(attribute).blank?
D
Initial  
David Heinemeier Hansson 已提交
1778 1779 1780 1781
      end

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

1785
      # Returns true if +comparison_object+ is the same exact object, or +comparison_object+
X
Xavier Noria 已提交
1786 1787 1788 1789 1790 1791 1792 1793
      # 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 已提交
1794
      def ==(comparison_object)
1795
        comparison_object.equal?(self) ||
1796 1797 1798
          comparison_object.instance_of?(self.class) &&
          id.present? &&
          comparison_object.id == id
D
Initial  
David Heinemeier Hansson 已提交
1799 1800 1801 1802
      end

      # Delegates to ==
      def eql?(comparison_object)
E
Emilio Tagua 已提交
1803
        self == comparison_object
D
Initial  
David Heinemeier Hansson 已提交
1804
      end
1805

D
Initial  
David Heinemeier Hansson 已提交
1806 1807 1808
      # 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
1809
        id.hash
D
Initial  
David Heinemeier Hansson 已提交
1810 1811
      end

1812
      # Freeze the attributes hash such that associations are still accessible, even on destroyed records.
1813
      def freeze
1814
        @attributes.freeze; self
1815
      end
1816

1817
      # Returns +true+ if the attributes hash has been frozen.
1818 1819 1820
      def frozen?
        @attributes.frozen?
      end
1821

A
Aaron Patterson 已提交
1822 1823 1824 1825 1826 1827 1828 1829 1830
      # 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 已提交
1831
      # Duped objects have no id assigned and are treated as new records. Note
A
Aaron Patterson 已提交
1832 1833
      # 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 已提交
1834 1835
      # specific and is therefore left to the application to implement according
      # to its need.
1836
      # The dup method does not preserve the timestamps (created|updated)_(at|on).
A
Aaron Patterson 已提交
1837
      def initialize_dup(other)
A
Aaron Patterson 已提交
1838 1839 1840
        cloned_attributes = other.clone_attributes(:read_attribute_before_type_cast)
        cloned_attributes.delete(self.class.primary_key)

A
Aaron Patterson 已提交
1841 1842
        @attributes = cloned_attributes

A
Aaron Patterson 已提交
1843 1844
        _run_after_initialize_callbacks if respond_to?(:_run_after_initialize_callbacks)

A
Aaron Patterson 已提交
1845 1846 1847 1848
        @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 已提交
1849

1850
        @aggregation_cache = {}
1851 1852
        @association_cache = {}
        @attributes_cache = {}
1853
        @new_record  = true
A
Aaron Patterson 已提交
1854

A
Aaron Patterson 已提交
1855 1856
        ensure_proper_type
        populate_with_current_scope_attributes
1857
        clear_timestamp_attributes
1858 1859
      end

1860 1861
      # 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.
1862
      def readonly?
1863
        @readonly
1864 1865
      end

1866 1867
      # Marks this record as read only.
      def readonly!
1868 1869
        @readonly = true
      end
1870

1871
      # Returns the contents of the record as a nicely formatted string.
1872
      def inspect
1873
        attributes_as_nice_string = self.class.column_names.collect { |name|
1874
          if has_attribute?(name)
1875 1876 1877
            "#{name}: #{attribute_for_inspect(name)}"
          end
        }.compact.join(", ")
1878
        "#<#{self.class} #{attributes_as_nice_string}>"
1879
      end
1880

1881 1882
    protected
      def clone_attributes(reader_method = :read_attribute, attributes = {})
1883 1884
        attribute_names.each do |name|
          attributes[name] = clone_attribute_value(reader_method, name)
1885
        end
1886
        attributes
1887 1888 1889 1890 1891 1892 1893 1894 1895
      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 已提交
1896 1897
    private

A
Aaron Patterson 已提交
1898 1899 1900 1901 1902 1903 1904
      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

1905
      # Sets the attribute used for single table inheritance to this class name if this is not the
1906
      # ActiveRecord::Base descendant.
1907 1908
      # 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.
1909
      # No such attribute would be set for objects of the Message class in that example.
D
Initial  
David Heinemeier Hansson 已提交
1910 1911
      def ensure_proper_type
        unless self.class.descends_from_active_record?
1912
          write_attribute(self.class.inheritance_column, self.class.sti_name)
D
Initial  
David Heinemeier Hansson 已提交
1913 1914 1915
        end
      end

1916
      # The primary key and inheritance column can never be set by mass-assignment for security reasons.
1917 1918 1919
      def self.attributes_protected_by_default
        default = [ primary_key, inheritance_column ]
        default << 'id' unless primary_key.eql? 'id'
1920
        default
1921 1922
      end

1923 1924
      # Returns a copy of the attributes hash where all the values have been safely quoted for use in
      # an Arel insert/update method.
1925
      def arel_attributes_values(include_primary_key = true, include_readonly_attributes = true, attribute_names = @attributes.keys)
1926 1927 1928 1929
        attrs      = {}
        klass      = self.class
        arel_table = klass.arel_table

1930 1931 1932 1933
        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))
1934

1935 1936
              value = if coder = klass.serialized_attributes[name]
                        coder.dump @attributes[name]
1937 1938 1939 1940 1941 1942 1943 1944
                      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
1945 1946 1947 1948 1949 1950
            end
          end
        end
        attrs
      end

D
Initial  
David Heinemeier Hansson 已提交
1951
      # Quote strings appropriately for SQL statements.
1952
      def quote_value(value, column = nil)
1953
        self.class.connection.quote(value, column)
D
Initial  
David Heinemeier Hansson 已提交
1954 1955 1956 1957 1958 1959
      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
1960 1961
      # 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
1962
      # attribute will be set to nil.
D
Initial  
David Heinemeier Hansson 已提交
1963 1964 1965 1966 1967
      def assign_multiparameter_attributes(pairs)
        execute_callstack_for_multiparameter_attributes(
          extract_callstack_for_multiparameter_attributes(pairs)
        )
      end
1968

1969
      def instantiate_time_object(name, values)
1970
        if self.class.send(:create_time_zone_conversion_attribute?, name, column_for_attribute(name))
1971
          Time.zone.local(*values)
1972
        else
1973
          Time.time_with_datetime_fallback(@@default_timezone, *values)
1974
        end
1975 1976
      end

D
Initial  
David Heinemeier Hansson 已提交
1977
      def execute_callstack_for_multiparameter_attributes(callstack)
1978
        errors = []
1979
        callstack.each do |name, values_with_empty_parameters|
1980
          begin
1981
            send(name + "=", read_value_from_parameter(name, values_with_empty_parameters))
1982
          rescue => ex
1983
            errors << AttributeAssignmentError.new("error on assignment #{values_with_empty_parameters.values.inspect} to #{name}", ex, name)
D
Initial  
David Heinemeier Hansson 已提交
1984 1985
          end
        end
1986 1987 1988
        unless errors.empty?
          raise MultiparameterAssignmentErrors.new(errors), "#{errors.size} error(s) on assignment of multiparameter attributes"
        end
D
Initial  
David Heinemeier Hansson 已提交
1989
      end
1990

1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036
      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)
        rescue ArgumentError => ex # if Date.new raises an exception on an invalid date
          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 已提交
2037 2038 2039
      def extract_callstack_for_multiparameter_attributes(pairs)
        attributes = { }

2040
        pairs.each do |pair|
D
Initial  
David Heinemeier Hansson 已提交
2041 2042
          multiparameter_name, value = pair
          attribute_name = multiparameter_name.split("(").first
2043
          attributes[attribute_name] = {} unless attributes.include?(attribute_name)
D
Initial  
David Heinemeier Hansson 已提交
2044

2045
          parameter_value = value.empty? ? nil : type_cast_attribute_value(multiparameter_name, value)
2046
          attributes[attribute_name][find_parameter_position(multiparameter_name)] ||= parameter_value
D
Initial  
David Heinemeier Hansson 已提交
2047 2048
        end

2049
        attributes
D
Initial  
David Heinemeier Hansson 已提交
2050
      end
2051

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

D
Initial  
David Heinemeier Hansson 已提交
2056
      def find_parameter_position(multiparameter_name)
2057
        multiparameter_name.scan(/\(([0-9]*).*\)/).first.first.to_i
D
Initial  
David Heinemeier Hansson 已提交
2058
      end
2059

D
Initial  
David Heinemeier Hansson 已提交
2060 2061
      # Returns a comma-separated pair list, like "key1 = val1, key2 = val2".
      def comma_pair_list(hash)
2062
        hash.map { |k,v| "#{k} = #{v}" }.join(", ")
D
Initial  
David Heinemeier Hansson 已提交
2063 2064
      end

2065
      def quote_columns(quoter, hash)
2066
        Hash[hash.map { |name, value| [quoter.quote_column_name(name), value] }]
D
Initial  
David Heinemeier Hansson 已提交
2067 2068
      end

2069 2070
      def quoted_comma_pair_list(quoter, hash)
        comma_pair_list(quote_columns(quoter, hash))
D
Initial  
David Heinemeier Hansson 已提交
2071 2072
      end

2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084
      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

2085
      def populate_with_current_scope_attributes
2086 2087
        self.class.scoped.scope_for_create.each do |att,value|
          respond_to?("#{att}=") && send("#{att}=", value)
2088 2089
        end
      end
2090

2091
      # Clear attributes and changed_attributes
2092
      def clear_timestamp_attributes
2093 2094 2095
        all_timestamp_attributes_in_model.each do |attribute_name|
          self[attribute_name] = nil
          changed_attributes.delete(attribute_name)
2096 2097
        end
      end
D
Initial  
David Heinemeier Hansson 已提交
2098
  end
J
Joshua Peek 已提交
2099 2100

  Base.class_eval do
2101
    include ActiveRecord::Persistence
J
Joshua Peek 已提交
2102
    extend ActiveModel::Naming
J
Joshua Peek 已提交
2103
    extend QueryCache::ClassMethods
J
José Valim 已提交
2104
    extend ActiveSupport::Benchmarkable
2105
    extend ActiveSupport::DescendantsTracker
J
José Valim 已提交
2106

2107
    include ActiveModel::Conversion
J
Joshua Peek 已提交
2108
    include Validations
2109
    extend CounterCache
J
Joshua Peek 已提交
2110 2111
    include Locking::Optimistic, Locking::Pessimistic
    include AttributeMethods
J
Joshua Peek 已提交
2112
    include AttributeMethods::Read, AttributeMethods::Write, AttributeMethods::BeforeTypeCast, AttributeMethods::Query
2113
    include AttributeMethods::PrimaryKey
J
Joshua Peek 已提交
2114 2115
    include AttributeMethods::TimeZoneConversion
    include AttributeMethods::Dirty
2116
    include ActiveModel::MassAssignmentSecurity
2117
    include Callbacks, ActiveModel::Observing, Timestamp
J
Jon Leighton 已提交
2118
    include Associations, NamedScope
M
Marcin Raczkowski 已提交
2119
    include IdentityMap
2120
    include ActiveModel::SecurePassword
2121 2122 2123 2124

    # 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 已提交
2125
    include Aggregations, Transactions, Reflection, Serialization
2126

2127
    NilClass.add_whiner(self) if NilClass.respond_to?(:add_whiner)
2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138

    # 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 已提交
2139
  end
2140
end
2141 2142 2143

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