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

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

P
Pratik Naik 已提交
361 362
    ##
    # :singleton-method:
363 364 365
    # Accessor for the prefix type that will be prepended to every primary key column name.
    # The options are :table_name and :table_name_with_underscore. If the first is specified,
    # the Product class will look for "productid" instead of "id" as the primary column. If the
366
    # latter is specified, the Product class will look for "product_id" instead of "id". Remember
367
    # that this is a global setting for all Active Records.
368
    cattr_accessor :primary_key_prefix_type, :instance_writer => false
D
Initial  
David Heinemeier Hansson 已提交
369 370
    @@primary_key_prefix_type = nil

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

P
Pratik Naik 已提交
384 385
    ##
    # :singleton-method:
D
Initial  
David Heinemeier Hansson 已提交
386 387
    # Works like +table_name_prefix+, but appends instead of prepends (set to "_basecamp" gives "projects_basecamp",
    # "people_basecamp"). By default, the suffix is the empty string.
388 389
    class_attribute :table_name_suffix, :instance_writer => false
    self.table_name_suffix = ""
D
Initial  
David Heinemeier Hansson 已提交
390

P
Pratik Naik 已提交
391 392
    ##
    # :singleton-method:
393
    # Indicates whether table names should be the pluralized versions of the corresponding class names.
P
Pratik Naik 已提交
394
    # If true, the default table name for a Product class will be +products+. If false, it would just be +product+.
D
Initial  
David Heinemeier Hansson 已提交
395
    # See table_name for the full rules on table/class naming. This is true, by default.
396 397
    class_attribute :pluralize_table_names, :instance_writer => false
    self.pluralize_table_names = true
D
Initial  
David Heinemeier Hansson 已提交
398

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

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

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

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

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

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, &block)
508 509 510
          object.save
          object
        end
D
Initial  
David Heinemeier Hansson 已提交
511 512 513
      end

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

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

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

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

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

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

616
      # Returns a quoted version of the table name, used to construct SQL statements.
P
Pratik Naik 已提交
617 618 619 620
      def quoted_table_name
        @quoted_table_name ||= connection.quote_table_name(table_name)
      end

621
      # Computes the table name, (re)sets it internally, and returns it.
D
David Heinemeier Hansson 已提交
622
      def reset_table_name #:nodoc:
623
        self.table_name = compute_table_name
D
Initial  
David Heinemeier Hansson 已提交
624 625
      end

626
      def full_table_name_prefix #:nodoc:
627 628 629
        (parents.detect{ |p| p.respond_to?(:table_name_prefix) } || self).table_name_prefix
      end

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

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

D
David Heinemeier Hansson 已提交
642
      def reset_sequence_name #:nodoc:
643 644 645
        default = connection.default_sequence_name(table_name, primary_key)
        set_sequence_name(default)
        default
646 647
      end

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

        @relation = Relation.new(self, arel_table)
660 661 662 663 664
      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
665
      # given block.
666 667 668 669 670 671
      #
      #   class Project < ActiveRecord::Base
      #     set_inheritance_column do
      #       original_inheritance_column + "_id"
      #     end
      #   end
672
      def set_inheritance_column(value = nil, &block)
673 674 675 676
        define_attr_method :inheritance_column, value, &block
      end
      alias :inheritance_column= :set_inheritance_column

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

696 697
      # Indicates whether the table associated with this class exists
      def table_exists?
698
        connection.table_exists?(table_name)
699 700
      end

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

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

711 712 713 714 715 716
      # Returns a hash where the keys are column names and the values are
      # default values when instantiating the AR object for this table.
      def column_defaults
        connection_pool.column_defaults[table_name]
      end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

888 889 890
        super
      end

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

P
Pratik Naik 已提交
895
      def arel_table
896
        @arel_table ||= Arel::Table.new(table_name, arel_engine)
897 898
      end

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

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

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

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


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

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

        instance
973
      end
974

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

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

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

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

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

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

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

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

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

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

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

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

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

1153
          previous_scope = self.current_scope
1154

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

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

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

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

1180
            scope = relation
1181 1182
          end

1183
          scope = previous_scope.merge(scope) if previous_scope && action == :merge
1184

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

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

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

Or call unscoped with a block:

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

MSG
1208
          end
1209 1210 1211
          with_scope(method_scoping, :overwrite, &block)
        end

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

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

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

1270
        # The @ignore_default_scope flag is used to prevent an infinite recursion situation where
1271
        # a default scope references a scope which has a default scope which references a scope...
1272
        def build_default_scope #:nodoc:
1273 1274
          return if defined?(@ignore_default_scope) && @ignore_default_scope
          @ignore_default_scope = true
1275

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

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

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

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

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

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

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

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

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

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

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

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

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

1444 1445
        alias_method :sanitize_conditions, :sanitize_sql

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

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

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

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

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

          expanded
1480 1481
        end

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

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

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

D
Initial  
David Heinemeier Hansson 已提交
1538
        ensure_proper_type
1539
        set_serialized_attributes
P
Pratik Naik 已提交
1540

1541
        populate_with_current_scope_attributes
1542 1543

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

A
Aaron Patterson 已提交
1545
        yield self if block_given?
1546
        run_callbacks :initialize
D
Initial  
David Heinemeier Hansson 已提交
1547
      end
1548

1549
      # Populate +coder+ with attributes about this record that should be
S
Sebastian Martinez 已提交
1550
      # serialized. The structure of +coder+ defined in this method is
1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564
      # 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 已提交
1565 1566
      # Initialize an empty model object from +coder+. +coder+ must contain
      # the attributes necessary for initializing an empty model object. For
1567 1568 1569 1570 1571 1572 1573 1574 1575 1576
      # example:
      #
      #   class Post < ActiveRecord::Base
      #   end
      #
      #   post = Post.allocate
      #   post.init_with('attributes' => { 'title' => 'hello world' })
      #   post.title # => 'hello world'
      def init_with(coder)
        @attributes = coder['attributes']
A
Aaron Patterson 已提交
1577
        @relation = nil
1578

1579
        set_serialized_attributes
1580

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

        self
1590 1591
      end

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

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

1648
      def quoted_id #:nodoc:
1649
        quote_value(id, column_for_attribute(self.class.primary_key))
1650
      end
1651

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

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

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

1679
        assign_attributes(new_attributes)
1680 1681 1682
      end

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

1712
        attributes = new_attributes.stringify_keys
D
Initial  
David Heinemeier Hansson 已提交
1713
        multi_parameter_attributes = []
1714
        @mass_assignment_options = options
1715 1716

        unless options[:without_protection]
1717
          attributes = sanitize_for_mass_assignment(attributes, mass_assignment_role)
1718
        end
1719

1720
        attributes.each do |k, v|
1721 1722
          if k.include?("(")
            multi_parameter_attributes << [ k, v ]
1723 1724
          elsif respond_to?("#{k}=")
            send("#{k}=", v)
1725
          else
1726
            raise(UnknownAttributeError, "unknown attribute: #{k}")
1727
          end
D
Initial  
David Heinemeier Hansson 已提交
1728
        end
D
David Heinemeier Hansson 已提交
1729

1730
        @mass_assignment_options = nil
D
Initial  
David Heinemeier Hansson 已提交
1731 1732 1733
        assign_multiparameter_attributes(multi_parameter_attributes)
      end

1734
      # Returns a hash of all the attributes with their names as keys and the values of the attributes as values.
1735
      def attributes
1736
        Hash[@attributes.map { |name, _| [name, read_attribute(name)] }]
1737 1738
      end

P
Pratik Naik 已提交
1739
      # Returns an <tt>#inspect</tt>-like string for the value of the
V
Vijay Dev 已提交
1740
      # attribute +attr_name+. String attributes are truncated upto 50
P
Pratik Naik 已提交
1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751
      # 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"'
1752 1753 1754
      def attribute_for_inspect(attr_name)
        value = read_attribute(attr_name)

1755
        if value.is_a?(String) && value.length > 50
1756
          "#{value[0..50]}...".inspect
1757 1758
        elsif value.is_a?(Date) || value.is_a?(Time)
          %("#{value.to_s(:db)}")
1759 1760 1761 1762 1763
        else
          value.inspect
        end
      end

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

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

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

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

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

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

1808 1809
      # Allows sort on objects
      def <=>(other_object)
1810 1811 1812 1813 1814
        if other_object.is_a?(self.class)
          self.to_key <=> other_object.to_key
        else
          nil
        end
1815 1816
      end

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

A
Aaron Patterson 已提交
1836 1837
        @attributes = cloned_attributes

A
Aaron Patterson 已提交
1838 1839
        _run_after_initialize_callbacks if respond_to?(:_run_after_initialize_callbacks)

A
Aaron Patterson 已提交
1840 1841 1842 1843
        @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 已提交
1844

1845
        @aggregation_cache = {}
1846 1847
        @association_cache = {}
        @attributes_cache = {}
1848
        @new_record  = true
A
Aaron Patterson 已提交
1849

A
Aaron Patterson 已提交
1850 1851
        ensure_proper_type
        populate_with_current_scope_attributes
1852
        clear_timestamp_attributes
1853 1854
      end

1855 1856
      # 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.
1857
      def readonly?
1858
        @readonly
1859 1860
      end

1861 1862
      # Marks this record as read only.
      def readonly!
1863 1864
        @readonly = true
      end
1865

1866
      # Returns the contents of the record as a nicely formatted string.
1867
      def inspect
1868 1869 1870 1871 1872 1873 1874 1875 1876 1877
        inspection = if @attributes
                       self.class.column_names.collect { |name|
                         if has_attribute?(name)
                           "#{name}: #{attribute_for_inspect(name)}"
                         end
                       }.compact.join(", ")
                     else
                       "not initialized"
                     end
        "#<#{self.class} #{inspection}>"
1878
      end
1879

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

1895 1896 1897 1898 1899 1900 1901 1902
      def mass_assignment_options
        @mass_assignment_options ||= {}
      end

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

D
Initial  
David Heinemeier Hansson 已提交
1903 1904
    private

1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916
      # Under Ruby 1.9, Array#flatten will call #to_ary (recursively) on each of the elements
      # of the array, and then rescues from the possible NoMethodError. If those elements are
      # ActiveRecord::Base's, then this triggers the various method_missing's that we have,
      # which significantly impacts upon performance.
      #
      # So we can avoid the method_missing hit by explicitly defining #to_ary as nil here.
      #
      # See also http://tenderlovemaking.com/2011/06/28/til-its-ok-to-return-nil-from-to_ary/
      def to_ary # :nodoc:
        nil
      end

A
Aaron Patterson 已提交
1917
      def set_serialized_attributes
1918 1919 1920 1921
        sattrs = self.class.serialized_attributes

        sattrs.each do |key, coder|
          @attributes[key] = coder.load @attributes[key] if @attributes.key?(key)
A
Aaron Patterson 已提交
1922 1923 1924
        end
      end

1925
      # Sets the attribute used for single table inheritance to this class name if this is not the
1926
      # ActiveRecord::Base descendant.
1927 1928
      # 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.
1929
      # No such attribute would be set for objects of the Message class in that example.
D
Initial  
David Heinemeier Hansson 已提交
1930
      def ensure_proper_type
1931 1932 1933
        klass = self.class
        if klass.finder_needs_type_condition?
          write_attribute(klass.inheritance_column, klass.sti_name)
D
Initial  
David Heinemeier Hansson 已提交
1934 1935 1936
        end
      end

1937
      # The primary key and inheritance column can never be set by mass-assignment for security reasons.
1938 1939 1940
      def self.attributes_protected_by_default
        default = [ primary_key, inheritance_column ]
        default << 'id' unless primary_key.eql? 'id'
1941
        default
1942 1943
      end

1944 1945
      # Returns a copy of the attributes hash where all the values have been safely quoted for use in
      # an Arel insert/update method.
1946
      def arel_attributes_values(include_primary_key = true, include_readonly_attributes = true, attribute_names = @attributes.keys)
1947 1948 1949 1950
        attrs      = {}
        klass      = self.class
        arel_table = klass.arel_table

1951 1952 1953 1954
        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))
1955

1956 1957
              value = if coder = klass.serialized_attributes[name]
                        coder.dump @attributes[name]
1958 1959 1960 1961 1962 1963 1964 1965
                      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
1966 1967 1968 1969 1970 1971
            end
          end
        end
        attrs
      end

D
Initial  
David Heinemeier Hansson 已提交
1972
      # Quote strings appropriately for SQL statements.
1973
      def quote_value(value, column = nil)
1974
        self.class.connection.quote(value, column)
D
Initial  
David Heinemeier Hansson 已提交
1975 1976 1977 1978 1979 1980
      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
1981 1982
      # 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
1983
      # attribute will be set to nil.
D
Initial  
David Heinemeier Hansson 已提交
1984 1985 1986 1987 1988
      def assign_multiparameter_attributes(pairs)
        execute_callstack_for_multiparameter_attributes(
          extract_callstack_for_multiparameter_attributes(pairs)
        )
      end
1989

1990
      def instantiate_time_object(name, values)
1991
        if self.class.send(:create_time_zone_conversion_attribute?, name, column_for_attribute(name))
1992
          Time.zone.local(*values)
1993
        else
1994
          Time.time_with_datetime_fallback(@@default_timezone, *values)
1995
        end
1996 1997
      end

D
Initial  
David Heinemeier Hansson 已提交
1998
      def execute_callstack_for_multiparameter_attributes(callstack)
1999
        errors = []
2000
        callstack.each do |name, values_with_empty_parameters|
2001
          begin
2002
            send(name + "=", read_value_from_parameter(name, values_with_empty_parameters))
2003
          rescue => ex
2004
            errors << AttributeAssignmentError.new("error on assignment #{values_with_empty_parameters.values.inspect} to #{name}", ex, name)
D
Initial  
David Heinemeier Hansson 已提交
2005 2006
          end
        end
2007 2008 2009
        unless errors.empty?
          raise MultiparameterAssignmentErrors.new(errors), "#{errors.size} error(s) on assignment of multiparameter attributes"
        end
D
Initial  
David Heinemeier Hansson 已提交
2010
      end
2011

2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028
      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)
2029 2030 2031
        # If Date bits were provided but blank, then return nil
        return nil if (1..3).any? {|position| values_hash_from_param[position].blank?}

2032 2033
        set_values = (1..max_position).collect{|position| values_hash_from_param[position] }
        # If Time bits are not there, then default to 0
2034
        (3..5).each {|i| set_values[i] = set_values[i].blank? ? 0 : set_values[i]}
2035 2036 2037 2038
        instantiate_time_object(name, set_values)
      end

      def read_date_parameter_value(name, values_hash_from_param)
2039 2040
        return nil if (1..3).any? {|position| values_hash_from_param[position].blank?}
        set_values = [values_hash_from_param[1], values_hash_from_param[2], values_hash_from_param[3]]
2041 2042
        begin
          Date.new(*set_values)
2043
        rescue ArgumentError # if Date.new raises an exception on an invalid date
2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060
          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 已提交
2061 2062 2063
      def extract_callstack_for_multiparameter_attributes(pairs)
        attributes = { }

2064
        pairs.each do |pair|
D
Initial  
David Heinemeier Hansson 已提交
2065 2066
          multiparameter_name, value = pair
          attribute_name = multiparameter_name.split("(").first
2067
          attributes[attribute_name] = {} unless attributes.include?(attribute_name)
D
Initial  
David Heinemeier Hansson 已提交
2068

2069
          parameter_value = value.empty? ? nil : type_cast_attribute_value(multiparameter_name, value)
2070
          attributes[attribute_name][find_parameter_position(multiparameter_name)] ||= parameter_value
D
Initial  
David Heinemeier Hansson 已提交
2071 2072
        end

2073
        attributes
D
Initial  
David Heinemeier Hansson 已提交
2074
      end
2075

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

D
Initial  
David Heinemeier Hansson 已提交
2080
      def find_parameter_position(multiparameter_name)
2081
        multiparameter_name.scan(/\(([0-9]*).*\)/).first.first.to_i
D
Initial  
David Heinemeier Hansson 已提交
2082
      end
2083

D
Initial  
David Heinemeier Hansson 已提交
2084 2085
      # Returns a comma-separated pair list, like "key1 = val1, key2 = val2".
      def comma_pair_list(hash)
2086
        hash.map { |k,v| "#{k} = #{v}" }.join(", ")
D
Initial  
David Heinemeier Hansson 已提交
2087 2088
      end

2089
      def quote_columns(quoter, hash)
2090
        Hash[hash.map { |name, value| [quoter.quote_column_name(name), value] }]
D
Initial  
David Heinemeier Hansson 已提交
2091 2092
      end

2093 2094
      def quoted_comma_pair_list(quoter, hash)
        comma_pair_list(quote_columns(quoter, hash))
D
Initial  
David Heinemeier Hansson 已提交
2095 2096
      end

2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108
      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

2109
      def populate_with_current_scope_attributes
2110 2111
        return unless self.class.scope_attributes?

2112
        self.class.scope_attributes.each do |att,value|
2113
          send("#{att}=", value) if respond_to?("#{att}=")
2114 2115
        end
      end
2116

2117
      # Clear attributes and changed_attributes
2118
      def clear_timestamp_attributes
2119 2120 2121
        all_timestamp_attributes_in_model.each do |attribute_name|
          self[attribute_name] = nil
          changed_attributes.delete(attribute_name)
2122 2123
        end
      end
D
Initial  
David Heinemeier Hansson 已提交
2124
  end
J
Joshua Peek 已提交
2125 2126

  Base.class_eval do
2127
    include ActiveRecord::Persistence
J
Joshua Peek 已提交
2128
    extend ActiveModel::Naming
J
Joshua Peek 已提交
2129
    extend QueryCache::ClassMethods
J
José Valim 已提交
2130
    extend ActiveSupport::Benchmarkable
2131
    extend ActiveSupport::DescendantsTracker
J
José Valim 已提交
2132

2133
    include ActiveModel::Conversion
J
Joshua Peek 已提交
2134
    include Validations
2135
    extend CounterCache
J
Joshua Peek 已提交
2136 2137
    include Locking::Optimistic, Locking::Pessimistic
    include AttributeMethods
J
Joshua Peek 已提交
2138
    include AttributeMethods::Read, AttributeMethods::Write, AttributeMethods::BeforeTypeCast, AttributeMethods::Query
2139
    include AttributeMethods::PrimaryKey
J
Joshua Peek 已提交
2140 2141
    include AttributeMethods::TimeZoneConversion
    include AttributeMethods::Dirty
2142
    include ActiveModel::MassAssignmentSecurity
2143
    include Callbacks, ActiveModel::Observing, Timestamp
J
Jon Leighton 已提交
2144
    include Associations, NamedScope
M
Marcin Raczkowski 已提交
2145
    include IdentityMap
2146
    include ActiveModel::SecurePassword
2147 2148 2149 2150

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

2153
    NilClass.add_whiner(self) if NilClass.respond_to?(:add_whiner)
2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164

    # 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 已提交
2165
  end
2166
end
2167

2168
ActiveSupport.run_load_hooks(:active_record, ActiveRecord::Base)