base.rb 86.8 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
    cattr_accessor :pluralize_table_names, :instance_writer => false
D
Initial  
David Heinemeier Hansson 已提交
397 398
    @@pluralize_table_names = true

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

J
Jeremy Kemper 已提交
431 432 433 434 435
    # 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 = {}

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

D
Initial  
David Heinemeier Hansson 已提交
439
    class << self # Class methods
440 441
      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 已提交
442
      delegate :find_each, :find_in_batches, :to => :scoped
S
Sebastian Martinez 已提交
443
      delegate :select, :group, :order, :except, :reorder, :limit, :offset, :joins, :where, :preload, :eager_load, :includes, :from, :lock, :readonly, :having, :create_with, :to => :scoped
444
      delegate :count, :average, :minimum, :maximum, :sum, :calculate, :to => :scoped
445

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

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

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

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

536 537
      # Returns an array of all the attributes that have been specified as readonly.
      def readonly_attributes
538
        self._attr_readonly
D
Initial  
David Heinemeier Hansson 已提交
539 540
      end

541 542 543
      # 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 已提交
544
      # class on retrieval or SerializationTypeMismatch will be raised.
D
David Heinemeier Hansson 已提交
545
      #
P
Pratik Naik 已提交
546
      # ==== Parameters
D
David Heinemeier Hansson 已提交
547
      #
P
Pratik Naik 已提交
548 549
      # * +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 已提交
550 551 552
      #
      # ==== Example
      #   # Serialize a preferences attribute
553
      #   class User < ActiveRecord::Base
D
David Heinemeier Hansson 已提交
554 555
      #     serialize :preferences
      #   end
D
Initial  
David Heinemeier Hansson 已提交
556
      def serialize(attr_name, class_name = Object)
557 558 559 560 561 562
        coder = if [:load, :dump].all? { |x| class_name.respond_to?(x) }
                  class_name
                else
                  Coders::YAMLColumn.new(class_name)
                end

563 564 565
        # 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 已提交
566
      end
567

568 569
      # 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
570
      # looks like: Reply < Message < ActiveRecord::Base, then Message is used
571 572
      # 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
573
      # English inflections. You can add new inflections in config/initializers/inflections.rb.
D
Initial  
David Heinemeier Hansson 已提交
574
      #
575
      # Nested classes are given table names prefixed by the singular form of
P
Pratik Naik 已提交
576 577 578
      # the parent's table name. Enclosing modules are not considered.
      #
      # ==== Examples
579 580
      #
      #   class Invoice < ActiveRecord::Base; end;
581 582
      #   file                  class               table_name
      #   invoice.rb            Invoice             invoices
583 584 585 586 587 588 589 590
      #
      #   class Invoice < ActiveRecord::Base; class Lineitem < ActiveRecord::Base; end; end;
      #   file                  class               table_name
      #   invoice.rb            Invoice::Lineitem   invoice_lineitems
      #
      #   module Invoice; class Lineitem < ActiveRecord::Base; end; end;
      #   file                  class               table_name
      #   invoice/lineitem.rb   Invoice::Lineitem   lineitems
D
Initial  
David Heinemeier Hansson 已提交
591
      #
P
Pratik Naik 已提交
592
      # Additionally, the class-level +table_name_prefix+ is prepended and the
S
Sebastian Martinez 已提交
593
      # +table_name_suffix+ is appended. So if you have "myapp_" as a prefix,
594 595 596 597 598
      # 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 已提交
599 600
      #
      #   class Mouse < ActiveRecord::Base
601
      #     set_table_name "mice"
D
Initial  
David Heinemeier Hansson 已提交
602
      #   end
603
      def table_name
604 605 606
        reset_table_name
      end

607
      # Returns a quoted version of the table name, used to construct SQL statements.
P
Pratik Naik 已提交
608 609 610 611
      def quoted_table_name
        @quoted_table_name ||= connection.quote_table_name(table_name)
      end

612
      # Computes the table name, (re)sets it internally, and returns it.
D
David Heinemeier Hansson 已提交
613
      def reset_table_name #:nodoc:
614
        self.table_name = compute_table_name
D
Initial  
David Heinemeier Hansson 已提交
615 616
      end

617
      def full_table_name_prefix #:nodoc:
618 619 620
        (parents.detect{ |p| p.respond_to?(:table_name_prefix) } || self).table_name_prefix
      end

621
      # Defines the column name for use with single table inheritance. Use
N
Neeraj Singh 已提交
622
      # <tt>set_inheritance_column</tt> to set a different value.
D
Initial  
David Heinemeier Hansson 已提交
623
      def inheritance_column
A
Aaron Patterson 已提交
624
        @inheritance_column ||= "type"
D
Initial  
David Heinemeier Hansson 已提交
625 626
      end

S
Sebastian Martinez 已提交
627
      # Lazy-set the sequence name to the connection's default. This method
628
      # is only ever called once since set_sequence_name overrides it.
D
David Heinemeier Hansson 已提交
629
      def sequence_name #:nodoc:
630 631 632
        reset_sequence_name
      end

D
David Heinemeier Hansson 已提交
633
      def reset_sequence_name #:nodoc:
634 635 636
        default = connection.default_sequence_name(table_name, primary_key)
        set_sequence_name(default)
        default
637 638
      end

S
Sebastian Martinez 已提交
639
      # Sets the table name. If the value is nil or false then the value returned by the given
N
Neeraj Singh 已提交
640
      # block is used.
641 642 643 644
      #
      #   class Project < ActiveRecord::Base
      #     set_table_name "project"
      #   end
645
      def set_table_name(value = nil, &block)
646
        @quoted_table_name = nil
647
        define_attr_method :table_name, value, &block
648

649
        @arel_table = Arel::Table.new(table_name, arel_engine)
650
        @relation = Relation.new(self, arel_table)
651 652 653 654 655
      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
656
      # given block.
657 658 659 660 661 662
      #
      #   class Project < ActiveRecord::Base
      #     set_inheritance_column do
      #       original_inheritance_column + "_id"
      #     end
      #   end
663
      def set_inheritance_column(value = nil, &block)
664 665 666 667
        define_attr_method :inheritance_column, value, &block
      end
      alias :inheritance_column= :set_inheritance_column

668 669
      # 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
670 671
      # given block. This is required for Oracle and is useful for any
      # database which relies on sequences for primary key generation.
672
      #
673 674 675 676 677
      # 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.
678 679 680 681
      #
      #   class Project < ActiveRecord::Base
      #     set_sequence_name "projectseq"   # default would have been "project_seq"
      #   end
682
      def set_sequence_name(value = nil, &block)
683 684 685 686
        define_attr_method :sequence_name, value, &block
      end
      alias :sequence_name= :set_sequence_name

687 688
      # Indicates whether the table associated with this class exists
      def table_exists?
689
        connection.table_exists?(table_name)
690 691
      end

D
Initial  
David Heinemeier Hansson 已提交
692 693
      # Returns an array of column objects for the table associated with this class.
      def columns
A
Aaron Patterson 已提交
694
        connection_pool.columns[table_name]
D
Initial  
David Heinemeier Hansson 已提交
695
      end
696

697
      # Returns a hash of column objects for the table associated with this class.
D
Initial  
David Heinemeier Hansson 已提交
698
      def columns_hash
A
Aaron Patterson 已提交
699
        connection_pool.columns_hash[table_name]
D
Initial  
David Heinemeier Hansson 已提交
700
      end
701

D
David Heinemeier Hansson 已提交
702
      # Returns an array of column names as strings.
703
      def column_names
704
        @column_names ||= columns.map { |column| column.name }
705
      end
D
Initial  
David Heinemeier Hansson 已提交
706

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

P
Pratik Naik 已提交
727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752
      # 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
753
      def reset_column_information
A
Aaron Patterson 已提交
754
        connection.clear_cache!
755
        undefine_attribute_methods
A
Aaron Patterson 已提交
756 757
        connection_pool.clear_table_cache!(table_name) if table_exists?

758
        @column_names = @content_columns = @dynamic_methods_hash = @inheritance_column = nil
759
        @arel_engine = @relation = nil
760 761
      end

762
      def clear_cache! # :nodoc:
A
Aaron Patterson 已提交
763
        connection_pool.clear_cache!
764 765
      end

766
      def attribute_method?(attribute)
J
José Valim 已提交
767
        super || (table_exists? && column_names.include?(attribute.to_s.sub(/=$/, '')))
768 769
      end

770 771
      # Set the lookup ancestors for ActiveModel.
      def lookup_ancestors #:nodoc:
772 773
        klass = self
        classes = [klass]
774 775
        return classes if klass == ActiveRecord::Base

E
Emilio Tagua 已提交
776
        while klass != klass.base_class
777 778 779 780 781
          classes << klass = klass.superclass
        end
        classes
      end

782 783 784
      # Set the i18n scope to overwrite ActiveModel.
      def i18n_scope #:nodoc:
        :activerecord
D
Initial  
David Heinemeier Hansson 已提交
785
      end
786

787 788 789 790 791 792 793
      # 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 已提交
794 795
      end

796 797 798 799 800
      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 已提交
801
      # Returns a string like 'Post(id:integer, title:string, body:text)'
802
      def inspect
803 804 805 806
        if self == Base
          super
        elsif abstract_class?
          "#{super}(abstract)"
807
        elsif table_exists?
808 809
          attr_list = columns.map { |c| "#{c.name}: #{c.type}" } * ', '
          "#{super}(#{attr_list})"
810 811
        else
          "#{super}(Table doesn't exist)"
812
        end
813 814
      end

815
      def quote_value(value, column = nil) #:nodoc:
816
        connection.quote(value,column)
817 818
      end

819
      # Used to sanitize objects before they're used in an SQL SELECT statement. Delegates to <tt>connection.quote</tt>.
820
      def sanitize(object) #:nodoc:
821
        connection.quote(object)
D
Initial  
David Heinemeier Hansson 已提交
822 823
      end

824 825 826
      # Overwrite the default class equality method to provide support for association proxies.
      def ===(object)
        object.is_a?(self)
827
      end
828

829 830 831 832
      def symbolized_base_class
        @symbolized_base_class ||= base_class.to_s.to_sym
      end

833
      def symbolized_sti_name
834
        @symbolized_sti_name ||= sti_name.present? ? sti_name.to_sym : symbolized_base_class
835 836
      end

837 838 839
      # 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.
840 841 842
      #
      # 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.
843 844 845 846
      def base_class
        class_of_active_record_descendant(self)
      end

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

850
      # Returns whether this class is an abstract class or not.
851
      def abstract_class?
852
        defined?(@abstract_class) && @abstract_class == true
853 854
      end

855
      def respond_to?(method_id, include_private = false)
856 857
        if match = DynamicFinderMatch.match(method_id)
          return true if all_attributes_exists?(match.attribute_names)
858 859
        elsif match = DynamicScopeMatch.match(method_id)
          return true if all_attributes_exists?(match.attribute_names)
860
        end
861

862 863 864
        super
      end

865 866 867 868
      def sti_name
        store_full_sti_class ? name : name.demodulize
      end

P
Pratik Naik 已提交
869
      def arel_table
A
Aaron Patterson 已提交
870
        Arel::Table.new(table_name, arel_engine)
871 872
      end

873 874
      def arel_engine
        @arel_engine ||= begin
875
          if self == ActiveRecord::Base
876
            ActiveRecord::Base
877
          else
878
            connection_handler.connection_pools[name] ? self : superclass.arel_engine
879 880
          end
        end
881 882
      end

883 884 885
      # Returns a scope for this class without taking into account the default_scope.
      #
      #   class Post < ActiveRecord::Base
886 887 888
      #     def self.default_scope
      #       where :published => true
      #     end
889 890 891 892 893 894 895 896 897 898 899 900
      #   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 {
      #     limit(10) # Fires "SELECT * FROM posts LIMIT 10"
      #   }
      #
901 902
      # 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.
903
      #
904 905
      # Post.unscoped.published
      # Post.published
906
      def unscoped #:nodoc:
907 908 909
        block_given? ? relation.scoping { yield } : relation
      end

910
      def before_remove_const #:nodoc:
911
        self.current_scope = nil
912 913
      end

J
Jon Leighton 已提交
914 915 916 917 918 919 920 921 922
      # 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 已提交
923 924


925 926 927
      # 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.
928 929 930
      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 已提交
931

932 933 934 935 936 937
        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)
938
          else
M
Marcin Raczkowski 已提交
939
            instance = sti_class.allocate.init_with('attributes' => record)
940
            IdentityMap.add(instance)
941
          end
942 943 944 945 946
        else
          instance = sti_class.allocate.init_with('attributes' => record)
        end

        instance
947
      end
948

D
Initial  
David Heinemeier Hansson 已提交
949
      private
J
José Valim 已提交
950 951 952

        def relation #:nodoc:
          @relation ||= Relation.new(self, arel_table)
953 954 955 956 957 958

          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 已提交
959
        end
960

961
        def find_sti_class(type_name)
962
          if type_name.blank? || !columns_hash.include?(inheritance_column)
963 964 965
            self
          else
            begin
966 967 968 969 970
              if store_full_sti_class
                ActiveSupport::Dependencies.constantize(type_name)
              else
                compute_type(type_name)
              end
971 972 973 974 975 976 977 978 979 980
            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

981
        def construct_finder_arel(options = {}, scope = nil)
982
          relation = options.is_a?(Hash) ? unscoped.apply_finder_options(options) : options
983
          relation = scope.merge(relation) if scope
984
          relation
985 986
        end

987 988
        def type_condition(table = arel_table)
          sti_column = table[inheritance_column.to_sym]
989
          sti_names  = ([self] + descendants).map { |model| model.sti_name }
990

991
          sti_column.in(sti_names)
D
Initial  
David Heinemeier Hansson 已提交
992 993 994
        end

        # Guesses the table name, but does not decorate it with prefix and suffix information.
995
        def undecorated_table_name(class_name = base_class.name)
996 997
          table_name = class_name.to_s.demodulize.underscore
          table_name = table_name.pluralize if pluralize_table_names
998
          table_name
D
Initial  
David Heinemeier Hansson 已提交
999 1000
        end

1001 1002 1003 1004 1005 1006 1007 1008
        # 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
1009
              contained += '_'
1010 1011 1012 1013 1014 1015 1016 1017
            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

1018
        # Enables dynamic finders like <tt>User.find_by_user_name(user_name)</tt> and
1019 1020
        # <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.
1021
        #
1022
        # It's even possible to use all the additional parameters to +find+. For example, the
1023
        # full interface for +find_all_by_amount+ is actually <tt>find_all_by_amount(amount, options)</tt>.
1024
        #
1025
        # Each dynamic finder using <tt>scoped_by_*</tt> is also defined in the class after it
1026
        # is first invoked, so that future attempts to use it do not run through method_missing.
1027
        def method_missing(method_id, *arguments, &block)
1028 1029
          if match = DynamicFinderMatch.match(method_id)
            attribute_names = match.attribute_names
1030
            super unless all_attributes_exists?(attribute_names)
1031
            if match.finder?
1032
              options = arguments.extract_options!
1033
              relation = options.any? ? scoped(options) : scoped
1034
              relation.send :find_by_attributes, match, attribute_names, *arguments
1035
            elsif match.instantiator?
1036
              scoped.send :find_or_instantiator_by_attributes, match, attribute_names, *arguments, &block
1037
            end
1038 1039 1040 1041
          elsif match = DynamicScopeMatch.match(method_id)
            attribute_names = match.attribute_names
            super unless all_attributes_exists?(attribute_names)
            if match.scope?
1042
              self.class_eval <<-METHOD, __FILE__, __LINE__ + 1
1043 1044 1045 1046 1047
                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
1048
              METHOD
1049 1050
              send(method_id, *arguments)
            end
1051 1052 1053 1054
          else
            super
          end
        end
D
Initial  
David Heinemeier Hansson 已提交
1055

1056 1057
        # Similar in purpose to +expand_hash_conditions_for_aggregates+.
        def expand_attribute_names_for_aggregates(attribute_names)
1058
          attribute_names.map { |attribute_name|
1059
            unless (aggregation = reflect_on_aggregation(attribute_name.to_sym)).nil?
1060 1061
              aggregate_mapping(aggregation).map do |field_attr, _|
                field_attr.to_sym
1062 1063
              end
            else
1064
              attribute_name.to_sym
1065
            end
1066
          }.flatten
1067 1068
        end

1069
        def all_attributes_exists?(attribute_names)
1070 1071
          (expand_attribute_names_for_aggregates(attribute_names) -
           column_methods_hash.keys).empty?
1072
        end
1073

D
Initial  
David Heinemeier Hansson 已提交
1074
      protected
N
Neeraj Singh 已提交
1075 1076
        # 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
1077
        # <tt>:create</tt> parameters are an attributes hash.
1078 1079 1080
        #
        #   class Article < ActiveRecord::Base
        #     def self.create_with_scope
1081
        #       with_scope(:find => where(:blog_id => 1), :create => { :blog_id => 1 }) do
1082 1083 1084 1085 1086 1087 1088
        #         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 已提交
1089
        # In nested scopings, all previous parameters are overwritten by the innermost rule, with the exception of
1090
        # <tt>where</tt>, <tt>includes</tt>, and <tt>joins</tt> operations in <tt>Relation</tt>, which are merged.
P
Pratik Naik 已提交
1091
        #
1092
        # <tt>joins</tt> operations are uniqued so multiple scopes can join in the same table without table aliasing
S
Sebastian Martinez 已提交
1093
        # problems. If you need to join multiple tables, but still want one of the tables to be uniqued, use the
P
Pratik Naik 已提交
1094
        # array of strings format for your joins.
1095 1096 1097
        #
        #   class Article < ActiveRecord::Base
        #     def self.find_with_scope
1098 1099 1100
        #       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
1101
        #         end
1102 1103
        #         with_scope(:find => where(:author_id => 3)) do
        #           all # => SELECT * from articles WHERE blog_id = 1 AND author_id = 3 LIMIT 1
1104 1105 1106 1107 1108
        #         end
        #       end
        #     end
        #   end
        #
1109
        # You can ignore any previous scopings by using the <tt>with_exclusive_scope</tt> method.
1110 1111 1112
        #
        #   class Article < ActiveRecord::Base
        #     def self.find_with_exclusive_scope
1113
        #       with_scope(:find => where(:blog_id => 1).limit(1)) do
1114
        #         with_exclusive_scope(:find => limit(10)) do
1115
        #           all # => SELECT * from articles LIMIT 10
1116 1117 1118 1119
        #         end
        #       end
        #     end
        #   end
P
Pratik Naik 已提交
1120
        #
N
Neeraj Singh 已提交
1121
        # *Note*: the +:find+ scope also has effect on update and deletion methods, like +update_all+ and +delete_all+.
1122 1123 1124 1125
        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)

1126
          previous_scope = self.current_scope
1127

1128
          if scope.is_a?(Hash)
1129
            # Dup first and second level of hash (method and params).
1130 1131 1132
            scope = scope.dup
            scope.each do |method, params|
              scope[method] = params.dup unless params == true
1133
            end
1134

1135 1136
            scope.assert_valid_keys([ :find, :create ])
            relation = construct_finder_arel(scope[:find] || {})
1137
            relation.default_scoped = true unless action == :overwrite
1138

1139
            if previous_scope && previous_scope.create_with_value && scope[:create]
1140
              scope_for_create = if action == :merge
1141
                previous_scope.create_with_value.merge(scope[:create])
1142
              else
1143
                scope[:create]
1144
              end
1145 1146 1147

              relation = relation.create_with(scope_for_create)
            else
1148 1149
              scope_for_create = scope[:create]
              scope_for_create ||= previous_scope.create_with_value if previous_scope
1150 1151 1152
              relation = relation.create_with(scope_for_create) if scope_for_create
            end

1153
            scope = relation
1154 1155
          end

1156
          scope = previous_scope.merge(scope) if previous_scope && action == :merge
1157

1158
          self.current_scope = scope
1159 1160 1161
          begin
            yield
          ensure
1162
            self.current_scope = previous_scope
1163 1164 1165 1166 1167
          end
        end

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

1172 1173 1174 1175 1176 1177 1178 1179 1180
  User.unscoped.where(:active => true)

Or call unscoped with a block:

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

MSG
1181
          end
1182 1183 1184
          with_scope(method_scoping, :overwrite, &block)
        end

1185
        def current_scope #:nodoc:
1186
          Thread.current[:"#{self}_current_scope"]
1187 1188 1189 1190 1191 1192
        end

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

1193
        # Use this macro in your model to set a default scope for all operations on
1194
        # the model.
1195
        #
1196 1197
        #   class Article < ActiveRecord::Base
        #     default_scope where(:published => true)
1198
        #   end
1199
        #
1200
        #   Article.all # => SELECT * FROM articles WHERE published = true
1201 1202
        #
        # The <tt>default_scope</tt> is also applied while creating/building a record. It is not
1203 1204
        # applied while updating a record.
        #
1205 1206
        #   Article.new.published    # => true
        #   Article.create.published # => true
1207
        #
1208 1209 1210 1211 1212 1213 1214 1215 1216
        # 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.)
        #
1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229
        # 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.
        #
1230 1231
        # If you need to do more complex things with a default scope, you can alternatively
        # define it as a class method:
1232
        #
1233 1234 1235 1236
        #   class Article < ActiveRecord::Base
        #     def self.default_scope
        #       # Should return a scope, you can call 'super' here etc.
        #     end
1237 1238
        #   end
        def default_scope(scope = {})
1239
          scope = Proc.new if block_given?
1240
          self.default_scopes = default_scopes + [scope]
1241
        end
1242

1243 1244
        def build_default_scope #:nodoc:
          if method(:default_scope).owner != Base.singleton_class
1245 1246
            # Use relation.scoping to ensure we ignore whatever the current value of
            # self.current_scope may be.
1247 1248 1249 1250 1251
            relation.scoping { default_scope }
          elsif default_scopes.any?
            default_scopes.inject(relation) do |default_scope, scope|
              if scope.is_a?(Hash)
                default_scope.apply_finder_options(scope)
1252 1253
              elsif !scope.is_a?(Relation) && scope.respond_to?(:call)
                default_scope.merge(scope.call)
1254 1255 1256 1257 1258
              else
                default_scope.merge(scope)
              end
            end
          end
1259 1260
        end

P
Pratik Naik 已提交
1261
        # Returns the class type of the record using the current module as a prefix. So descendants of
1262
        # MyApp::Business::Account would appear as MyApp::Business::AccountSubclass.
D
Initial  
David Heinemeier Hansson 已提交
1263
        def compute_type(type_name)
1264 1265 1266
          if type_name.match(/^::/)
            # If the type is prefixed with a scope operator then we assume that
            # the type_name is an absolute reference.
1267
            ActiveSupport::Dependencies.constantize(type_name)
1268 1269 1270 1271 1272 1273 1274 1275
          else
            # Build a list of candidates to search for
            candidates = []
            name.scan(/::|$/) { candidates.unshift "#{$`}::#{type_name}" }
            candidates << type_name

            candidates.each do |candidate|
              begin
1276
                constant = ActiveSupport::Dependencies.constantize(candidate)
1277
                return constant if candidate == constant.to_s
1278 1279 1280
              rescue NameError => e
                # We don't want to swallow NoMethodError < NameError errors
                raise e unless e.instance_of?(NameError)
1281 1282
              rescue ArgumentError
              end
1283
            end
1284 1285

            raise NameError, "uninitialized constant #{candidates.first}"
D
Initial  
David Heinemeier Hansson 已提交
1286 1287 1288
          end
        end

P
Pratik Naik 已提交
1289 1290
        # Returns the class descending directly from ActiveRecord::Base or an
        # abstract class, if any, in the inheritance hierarchy.
1291
        def class_of_active_record_descendant(klass)
1292
          if klass.superclass == Base || klass.superclass.abstract_class?
1293
            klass
D
Initial  
David Heinemeier Hansson 已提交
1294 1295 1296
          elsif klass.superclass.nil?
            raise ActiveRecordError, "#{name} doesn't belong in a hierarchy descending from ActiveRecord"
          else
1297
            class_of_active_record_descendant(klass.superclass)
D
Initial  
David Heinemeier Hansson 已提交
1298 1299 1300
          end
        end

P
Pratik Naik 已提交
1301
        # Accepts an array, hash, or string of SQL conditions and sanitizes
1302
        # them into a valid SQL fragment for a WHERE clause.
1303 1304 1305
        #   ["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'"
1306
        def sanitize_sql_for_conditions(condition, table_name = self.table_name)
1307 1308
          return nil if condition.blank?

1309 1310
          case condition
            when Array; sanitize_sql_array(condition)
1311
            when Hash;  sanitize_sql_hash_for_conditions(condition, table_name)
1312 1313
            else        condition
          end
1314
        end
1315
        alias_method :sanitize_sql, :sanitize_sql_for_conditions
1316

P
Pratik Naik 已提交
1317
        # Accepts an array, hash, or string of SQL conditions and sanitizes
1318 1319 1320 1321 1322 1323 1324 1325 1326 1327
        # 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

1328 1329 1330 1331 1332
        def aggregate_mapping(reflection)
          mapping = reflection.options[:mapping] || [reflection.name, reflection.name]
          mapping.first.is_a?(Array) ? mapping : [mapping]
        end

P
Pratik Naik 已提交
1333
        # Accepts a hash of SQL conditions and replaces those attributes
1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362
        # 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

1363
        # Sanitizes a hash of attribute/value pairs into SQL conditions for a WHERE clause.
1364 1365 1366 1367
        #   { :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)"
1368 1369
        #   { :age => 13..18 }
        #     # => "age BETWEEN 13 AND 18"
1370 1371
        #   { 'other_records.id' => 7 }
        #     # => "`other_records`.`id` = 7"
1372 1373
        #   { :other_records => { :id => 7 } }
        #     # => "`other_records`.`id` = 7"
1374 1375 1376
        # 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'"
1377
        def sanitize_sql_hash_for_conditions(attrs, default_table_name = self.table_name)
1378 1379
          attrs = expand_hash_conditions_for_aggregates(attrs)

1380
          table = Arel::Table.new(table_name).alias(default_table_name)
1381 1382 1383 1384
          viz = Arel::Visitors.for(arel_engine)
          PredicateBuilder.build_from_hash(arel_engine, attrs, table).map { |b|
            viz.accept b
          }.join(' AND ')
1385
        end
1386 1387 1388 1389 1390 1391
        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)
1392
          attrs.map do |attr, value|
1393 1394 1395
            "#{connection.quote_column_name(attr)} = #{quote_bound_value(value)}"
          end.join(', ')
        end
1396

S
Sebastian Martinez 已提交
1397
        # Accepts an array of conditions. The array has each value
P
Pratik Naik 已提交
1398
        # sanitized and interpolated into the SQL statement.
1399
        #   ["name='%s' and group_id='%s'", "foo'bar", 4]  returns  "name='foo''bar' and group_id='4'"
1400
        def sanitize_sql_array(ary)
1401
          statement, *values = ary
1402
          if values.first.is_a?(Hash) && statement =~ /:\w+/
1403 1404
            replace_named_bind_variables(statement, values.first)
          elsif statement.include?('?')
1405
            replace_bind_variables(statement, values)
1406 1407
          elsif statement.blank?
            statement
1408
          else
1409
            statement % values.collect { |value| connection.quote_string(value.to_s) }
1410
          end
1411 1412
        end

1413 1414
        alias_method :sanitize_conditions, :sanitize_sql

D
David Heinemeier Hansson 已提交
1415
        def replace_bind_variables(statement, values) #:nodoc:
1416
          raise_if_bind_arity_mismatch(statement, statement.count('?'), values.size)
1417
          bound = values.dup
C
Comron Sattari 已提交
1418 1419
          c = connection
          statement.gsub('?') { quote_bound_value(bound.shift, c) }
1420 1421
        end

D
David Heinemeier Hansson 已提交
1422
        def replace_named_bind_variables(statement, bind_vars) #:nodoc:
1423 1424 1425 1426
          statement.gsub(/(:?):([a-zA-Z]\w*)/) do
            if $1 == ':' # skip postgresql casts
              $& # return the whole match
            elsif bind_vars.include?(match = $2.to_sym)
1427
              quote_bound_value(bind_vars[match])
1428 1429
            else
              raise PreparedStatementInvalid, "missing value for :#{match} in #{statement}"
1430 1431
            end
          end
1432 1433
        end

1434
        def expand_range_bind_variables(bind_vars) #:nodoc:
1435 1436 1437
          expanded = []

          bind_vars.each do |var|
1438 1439
            next if var.is_a?(Hash)

1440
            if var.is_a?(Range)
1441 1442
              expanded << var.first
              expanded << var.last
1443
            else
1444
              expanded << var
1445
            end
1446
          end
1447 1448

          expanded
1449 1450
        end

C
Comron Sattari 已提交
1451
        def quote_bound_value(value, c = connection) #:nodoc:
1452
          if value.respond_to?(:map) && !value.acts_like?(:string)
1453
            if value.respond_to?(:empty?) && value.empty?
C
Comron Sattari 已提交
1454
              c.quote(nil)
1455
            else
C
Comron Sattari 已提交
1456
              value.map { |v| c.quote(v) }.join(',')
1457
            end
1458
          else
C
Comron Sattari 已提交
1459
            c.quote(value)
1460 1461 1462
          end
        end

D
David Heinemeier Hansson 已提交
1463
        def raise_if_bind_arity_mismatch(statement, expected, provided) #:nodoc:
1464 1465 1466
          unless expected == provided
            raise PreparedStatementInvalid, "wrong number of bind variables (#{provided} for #{expected}) in: #{statement}"
          end
1467
        end
1468

D
David Heinemeier Hansson 已提交
1469
        def encode_quoted_value(value) #:nodoc:
1470
          quoted_value = connection.quote(value)
1471 1472
          quoted_value = "'#{quoted_value[1..-2].gsub(/\'/, "\\\\'")}'" if quoted_value.include?("\\\'") # (for ruby mode) "
          quoted_value
1473
        end
D
Initial  
David Heinemeier Hansson 已提交
1474 1475 1476 1477 1478
    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).
1479
      # In both instances, valid attribute keys are determined by the column names of the associated table --
D
Initial  
David Heinemeier Hansson 已提交
1480
      # hence you can't have attributes that aren't part of the table columns.
1481 1482 1483 1484 1485 1486 1487 1488
      #
      # +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')
      #
1489
      #   # Instantiates a single new object using the :admin mass-assignment security role
1490 1491 1492 1493 1494
      #   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 = {})
1495
        @attributes = attributes_from_column_definition
1496
        @association_cache = {}
1497
        @aggregation_cache = {}
1498
        @attributes_cache = {}
1499
        @new_record = true
1500
        @readonly = false
1501 1502
        @destroyed = false
        @marked_for_destruction = false
1503 1504
        @previously_changed = {}
        @changed_attributes = {}
1505

D
Initial  
David Heinemeier Hansson 已提交
1506
        ensure_proper_type
1507
        set_serialized_attributes
P
Pratik Naik 已提交
1508

1509
        populate_with_current_scope_attributes
1510 1511

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

1513
        result = yield self if block_given?
1514
        run_callbacks :initialize
1515
        result
D
Initial  
David Heinemeier Hansson 已提交
1516
      end
1517

1518
      # Populate +coder+ with attributes about this record that should be
S
Sebastian Martinez 已提交
1519
      # serialized. The structure of +coder+ defined in this method is
1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533
      # 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 已提交
1534 1535
      # Initialize an empty model object from +coder+. +coder+ must contain
      # the attributes necessary for initializing an empty model object. For
1536 1537 1538 1539 1540 1541 1542 1543 1544 1545
      # 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']
1546

1547
        set_serialized_attributes
1548

1549
        @attributes_cache, @previously_changed, @changed_attributes = {}, {}, {}
1550
        @association_cache = {}
1551
        @aggregation_cache = {}
1552
        @readonly = @destroyed = @marked_for_destruction = false
1553
        @new_record = false
1554 1555
        run_callbacks :find
        run_callbacks :initialize
M
Marcin Raczkowski 已提交
1556 1557

        self
1558 1559
      end

J
Jon Leighton 已提交
1560 1561 1562 1563 1564 1565 1566 1567 1568 1569
      # 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 已提交
1570 1571 1572 1573
      # 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 已提交
1574
      # For example, suppose that you have a User model, and that you have a
1575
      # <tt>resources :users</tt> route. Normally, +user_path+ will
P
Pratik Naik 已提交
1576
      # construct a path with the user object's 'id' in it:
P
Pratik Naik 已提交
1577 1578
      #
      #   user = User.find_by_name('Phusion')
1579
      #   user_path(user)  # => "/users/1"
P
Pratik Naik 已提交
1580
      #
P
Pratik Naik 已提交
1581 1582
      # 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 已提交
1583 1584 1585 1586 1587 1588
      #
      #   class User < ActiveRecord::Base
      #     def to_param  # overridden
      #       name
      #     end
      #   end
E
Emilio Tagua 已提交
1589
      #
P
Pratik Naik 已提交
1590
      #   user = User.find_by_name('Phusion')
1591
      #   user_path(user)  # => "/users/Phusion"
1592
      def to_param
1593
        # We can't use alias_method here, because method 'id' optimizes itself on the fly.
1594
        id && id.to_s # Be sure to stringify the id for routes
1595
      end
1596

P
Pratik Naik 已提交
1597 1598 1599
      # Returns a cache key that can be used to identify this record.
      #
      # ==== Examples
1600 1601 1602 1603 1604
      #
      #   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
1605
        case
1606
        when new_record?
J
Jeremy Kemper 已提交
1607 1608 1609
          "#{self.class.model_name.cache_key}/new"
        when timestamp = self[:updated_at]
          "#{self.class.model_name.cache_key}/#{id}-#{timestamp.to_s(:number)}"
1610
        else
J
Jeremy Kemper 已提交
1611
          "#{self.class.model_name.cache_key}/#{id}"
1612 1613
        end
      end
1614

1615
      def quoted_id #:nodoc:
1616
        quote_value(id, column_for_attribute(self.class.primary_key))
1617
      end
1618

1619 1620 1621 1622 1623
      # Returns true if the given attribute is in the attributes hash
      def has_attribute?(attr_name)
        @attributes.has_key?(attr_name.to_s)
      end

1624
      # Returns an array of names for the attributes available on this object.
1625
      def attribute_names
1626
        @attributes.keys
D
Initial  
David Heinemeier Hansson 已提交
1627 1628 1629
      end

      # Allows you to set all the attributes at once by passing in a hash with keys
P
Pratik Naik 已提交
1630 1631
      # matching the attribute names (which again matches the column names).
      #
1632 1633 1634 1635 1636
      # 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 已提交
1637 1638 1639 1640
      #
      #   class User < ActiveRecord::Base
      #     attr_protected :is_admin
      #   end
E
Emilio Tagua 已提交
1641
      #
P
Pratik Naik 已提交
1642 1643 1644 1645
      #   user = User.new
      #   user.attributes = { :username => 'Phusion', :is_admin => true }
      #   user.username   # => "Phusion"
      #   user.is_admin?  # => false
1646 1647 1648 1649 1650 1651 1652
      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 已提交
1653
        return unless new_attributes.is_a?(Hash)
1654 1655

        guard_protected_attributes ||= true
1656 1657 1658 1659 1660 1661 1662 1663
        if guard_protected_attributes
          assign_attributes(new_attributes)
        else
          assign_attributes(new_attributes, :without_protection => true)
        end
      end

      # Allows you to set all the attributes for a particular mass-assignment
1664 1665
      # security role by passing in a hash of attributes with keys matching
      # the attribute names (which again matches the column names) and the role
1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690
      # 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 = {})
1691
        attributes = new_attributes.stringify_keys
1692
        role = options[:as] || :default
D
Initial  
David Heinemeier Hansson 已提交
1693 1694

        multi_parameter_attributes = []
1695 1696

        unless options[:without_protection]
1697
          attributes = sanitize_for_mass_assignment(attributes, role)
1698
        end
1699

1700
        attributes.each do |k, v|
1701 1702
          if k.include?("(")
            multi_parameter_attributes << [ k, v ]
J
José Valim 已提交
1703 1704
          elsif respond_to?("#{k}=")
            send("#{k}=", v)
1705
          else
J
José Valim 已提交
1706
            raise(UnknownAttributeError, "unknown attribute: #{k}")
1707
          end
D
Initial  
David Heinemeier Hansson 已提交
1708
        end
D
David Heinemeier Hansson 已提交
1709

D
Initial  
David Heinemeier Hansson 已提交
1710 1711 1712
        assign_multiparameter_attributes(multi_parameter_attributes)
      end

1713
      # Returns a hash of all the attributes with their names as keys and the values of the attributes as values.
1714
      def attributes
1715
        Hash[@attributes.map { |name, _| [name, read_attribute(name)] }]
1716 1717
      end

P
Pratik Naik 已提交
1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730
      # 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"'
1731 1732 1733
      def attribute_for_inspect(attr_name)
        value = read_attribute(attr_name)

1734
        if value.is_a?(String) && value.length > 50
1735
          "#{value[0..50]}...".inspect
1736 1737
        elsif value.is_a?(Date) || value.is_a?(Time)
          %("#{value.to_s(:db)}")
1738 1739 1740 1741 1742
        else
          value.inspect
        end
      end

D
Initial  
David Heinemeier Hansson 已提交
1743
      # Returns true if the specified +attribute+ has been set by the user or by a database load and is neither
1744
      # nil nor empty? (the latter only applies to objects that respond to empty?, most notably Strings).
D
Initial  
David Heinemeier Hansson 已提交
1745
      def attribute_present?(attribute)
1746
        !_read_attribute(attribute).blank?
D
Initial  
David Heinemeier Hansson 已提交
1747 1748 1749 1750
      end

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

1754
      # Returns true if +comparison_object+ is the same exact object, or +comparison_object+
X
Xavier Noria 已提交
1755 1756 1757 1758 1759 1760 1761 1762
      # 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 已提交
1763
      def ==(comparison_object)
1764
        comparison_object.equal?(self) ||
1765 1766 1767
          comparison_object.instance_of?(self.class) &&
          id.present? &&
          comparison_object.id == id
D
Initial  
David Heinemeier Hansson 已提交
1768 1769 1770 1771
      end

      # Delegates to ==
      def eql?(comparison_object)
E
Emilio Tagua 已提交
1772
        self == comparison_object
D
Initial  
David Heinemeier Hansson 已提交
1773
      end
1774

D
Initial  
David Heinemeier Hansson 已提交
1775 1776 1777
      # 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
1778
        id.hash
D
Initial  
David Heinemeier Hansson 已提交
1779 1780
      end

1781
      # Freeze the attributes hash such that associations are still accessible, even on destroyed records.
1782
      def freeze
1783
        @attributes.freeze; self
1784
      end
1785

1786
      # Returns +true+ if the attributes hash has been frozen.
1787 1788 1789
      def frozen?
        @attributes.frozen?
      end
1790

A
Aaron Patterson 已提交
1791 1792 1793 1794 1795 1796 1797 1798 1799
      # 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 已提交
1800
      # Duped objects have no id assigned and are treated as new records. Note
A
Aaron Patterson 已提交
1801 1802
      # 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 已提交
1803 1804
      # specific and is therefore left to the application to implement according
      # to its need.
1805
      # The dup method does not preserve the timestamps (created|updated)_(at|on).
A
Aaron Patterson 已提交
1806
      def initialize_dup(other)
A
Aaron Patterson 已提交
1807 1808 1809
        cloned_attributes = other.clone_attributes(:read_attribute_before_type_cast)
        cloned_attributes.delete(self.class.primary_key)

A
Aaron Patterson 已提交
1810 1811
        @attributes = cloned_attributes

A
Aaron Patterson 已提交
1812 1813
        _run_after_initialize_callbacks if respond_to?(:_run_after_initialize_callbacks)

A
Aaron Patterson 已提交
1814 1815 1816 1817
        @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 已提交
1818

1819
        @aggregation_cache = {}
1820 1821
        @association_cache = {}
        @attributes_cache = {}
1822
        @new_record  = true
A
Aaron Patterson 已提交
1823

A
Aaron Patterson 已提交
1824 1825
        ensure_proper_type
        populate_with_current_scope_attributes
1826
        clear_timestamp_attributes
1827 1828
      end

1829 1830
      # 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.
1831
      def readonly?
1832
        @readonly
1833 1834
      end

1835 1836
      # Marks this record as read only.
      def readonly!
1837 1838
        @readonly = true
      end
1839

1840
      # Returns the contents of the record as a nicely formatted string.
1841
      def inspect
1842
        attributes_as_nice_string = self.class.column_names.collect { |name|
1843
          if has_attribute?(name)
1844 1845 1846
            "#{name}: #{attribute_for_inspect(name)}"
          end
        }.compact.join(", ")
1847
        "#<#{self.class} #{attributes_as_nice_string}>"
1848
      end
1849

1850 1851
    protected
      def clone_attributes(reader_method = :read_attribute, attributes = {})
1852 1853
        attribute_names.each do |name|
          attributes[name] = clone_attribute_value(reader_method, name)
1854
        end
1855
        attributes
1856 1857 1858 1859 1860 1861 1862 1863 1864
      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 已提交
1865 1866
    private

A
Aaron Patterson 已提交
1867 1868 1869 1870 1871 1872 1873
      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

1874
      # Sets the attribute used for single table inheritance to this class name if this is not the
1875
      # ActiveRecord::Base descendant.
1876 1877
      # 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.
1878
      # No such attribute would be set for objects of the Message class in that example.
D
Initial  
David Heinemeier Hansson 已提交
1879 1880
      def ensure_proper_type
        unless self.class.descends_from_active_record?
1881
          write_attribute(self.class.inheritance_column, self.class.sti_name)
D
Initial  
David Heinemeier Hansson 已提交
1882 1883 1884
        end
      end

1885
      # The primary key and inheritance column can never be set by mass-assignment for security reasons.
1886 1887 1888
      def self.attributes_protected_by_default
        default = [ primary_key, inheritance_column ]
        default << 'id' unless primary_key.eql? 'id'
1889
        default
1890 1891
      end

1892 1893
      # Returns a copy of the attributes hash where all the values have been safely quoted for use in
      # an Arel insert/update method.
1894
      def arel_attributes_values(include_primary_key = true, include_readonly_attributes = true, attribute_names = @attributes.keys)
1895 1896 1897 1898
        attrs      = {}
        klass      = self.class
        arel_table = klass.arel_table

1899 1900 1901 1902
        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))
1903

1904 1905
              value = if coder = klass.serialized_attributes[name]
                        coder.dump @attributes[name]
1906 1907 1908 1909 1910 1911 1912 1913
                      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
1914 1915 1916 1917 1918 1919
            end
          end
        end
        attrs
      end

D
Initial  
David Heinemeier Hansson 已提交
1920
      # Quote strings appropriately for SQL statements.
1921
      def quote_value(value, column = nil)
1922
        self.class.connection.quote(value, column)
D
Initial  
David Heinemeier Hansson 已提交
1923 1924 1925 1926 1927 1928
      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
1929 1930
      # 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
1931
      # attribute will be set to nil.
D
Initial  
David Heinemeier Hansson 已提交
1932 1933 1934 1935 1936
      def assign_multiparameter_attributes(pairs)
        execute_callstack_for_multiparameter_attributes(
          extract_callstack_for_multiparameter_attributes(pairs)
        )
      end
1937

1938
      def instantiate_time_object(name, values)
1939
        if self.class.send(:create_time_zone_conversion_attribute?, name, column_for_attribute(name))
1940
          Time.zone.local(*values)
1941
        else
1942
          Time.time_with_datetime_fallback(@@default_timezone, *values)
1943
        end
1944 1945
      end

D
Initial  
David Heinemeier Hansson 已提交
1946
      def execute_callstack_for_multiparameter_attributes(callstack)
1947
        errors = []
1948
        callstack.each do |name, values_with_empty_parameters|
1949
          begin
1950
            send(name + "=", read_value_from_parameter(name, values_with_empty_parameters))
1951
          rescue => ex
1952
            errors << AttributeAssignmentError.new("error on assignment #{values_with_empty_parameters.values.inspect} to #{name}", ex, name)
D
Initial  
David Heinemeier Hansson 已提交
1953 1954
          end
        end
1955 1956 1957
        unless errors.empty?
          raise MultiparameterAssignmentErrors.new(errors), "#{errors.size} error(s) on assignment of multiparameter attributes"
        end
D
Initial  
David Heinemeier Hansson 已提交
1958
      end
1959

1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005
      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 已提交
2006 2007 2008 2009 2010 2011
      def extract_callstack_for_multiparameter_attributes(pairs)
        attributes = { }

        for pair in pairs
          multiparameter_name, value = pair
          attribute_name = multiparameter_name.split("(").first
2012
          attributes[attribute_name] = {} unless attributes.include?(attribute_name)
D
Initial  
David Heinemeier Hansson 已提交
2013

2014
          parameter_value = value.empty? ? nil : type_cast_attribute_value(multiparameter_name, value)
2015
          attributes[attribute_name][find_parameter_position(multiparameter_name)] ||= parameter_value
D
Initial  
David Heinemeier Hansson 已提交
2016 2017
        end

2018
        attributes
D
Initial  
David Heinemeier Hansson 已提交
2019
      end
2020

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

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

D
Initial  
David Heinemeier Hansson 已提交
2029 2030
      # Returns a comma-separated pair list, like "key1 = val1, key2 = val2".
      def comma_pair_list(hash)
2031
        hash.map { |k,v| "#{k} = #{v}" }.join(", ")
D
Initial  
David Heinemeier Hansson 已提交
2032 2033
      end

2034
      def quote_columns(quoter, hash)
2035
        Hash[hash.map { |name, value| [quoter.quote_column_name(name), value] }]
D
Initial  
David Heinemeier Hansson 已提交
2036 2037
      end

2038 2039
      def quoted_comma_pair_list(quoter, hash)
        comma_pair_list(quote_columns(quoter, hash))
D
Initial  
David Heinemeier Hansson 已提交
2040 2041
      end

2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053
      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

2054
      def populate_with_current_scope_attributes
2055 2056
        self.class.scoped.scope_for_create.each do |att,value|
          respond_to?("#{att}=") && send("#{att}=", value)
2057 2058
        end
      end
2059

2060
      # Clear attributes and changed_attributes
2061
      def clear_timestamp_attributes
2062 2063 2064
        all_timestamp_attributes_in_model.each do |attribute_name|
          self[attribute_name] = nil
          changed_attributes.delete(attribute_name)
2065 2066
        end
      end
D
Initial  
David Heinemeier Hansson 已提交
2067
  end
J
Joshua Peek 已提交
2068 2069

  Base.class_eval do
2070
    include ActiveRecord::Persistence
J
Joshua Peek 已提交
2071
    extend ActiveModel::Naming
J
Joshua Peek 已提交
2072
    extend QueryCache::ClassMethods
J
José Valim 已提交
2073
    extend ActiveSupport::Benchmarkable
2074
    extend ActiveSupport::DescendantsTracker
J
José Valim 已提交
2075

2076
    include ActiveModel::Conversion
J
Joshua Peek 已提交
2077
    include Validations
2078
    extend CounterCache
J
Joshua Peek 已提交
2079 2080
    include Locking::Optimistic, Locking::Pessimistic
    include AttributeMethods
J
Joshua Peek 已提交
2081
    include AttributeMethods::Read, AttributeMethods::Write, AttributeMethods::BeforeTypeCast, AttributeMethods::Query
2082
    include AttributeMethods::PrimaryKey
J
Joshua Peek 已提交
2083 2084
    include AttributeMethods::TimeZoneConversion
    include AttributeMethods::Dirty
2085
    include ActiveModel::MassAssignmentSecurity
2086
    include Callbacks, ActiveModel::Observing, Timestamp
J
Jon Leighton 已提交
2087
    include Associations, NamedScope
M
Marcin Raczkowski 已提交
2088
    include IdentityMap
2089
    include ActiveModel::SecurePassword
2090 2091 2092 2093

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

2096
    NilClass.add_whiner(self) if NilClass.respond_to?(:add_whiner)
2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107

    # 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 已提交
2108
  end
2109
end
2110 2111 2112

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