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

D
Initial  
David Heinemeier Hansson 已提交
6
require 'yaml'
7
require 'set'
J
José Valim 已提交
8
require 'active_support/benchmarkable'
J
Jeremy Kemper 已提交
9
require 'active_support/dependencies'
10
require 'active_support/descendants_tracker'
11
require 'active_support/time'
12
require 'active_support/core_ext/class/attribute'
J
Jeremy Kemper 已提交
13 14
require 'active_support/core_ext/class/attribute_accessors'
require 'active_support/core_ext/class/delegating_attributes'
15
require 'active_support/core_ext/class/attribute'
J
Jeremy Kemper 已提交
16 17 18 19 20
require 'active_support/core_ext/array/extract_options'
require 'active_support/core_ext/hash/deep_merge'
require 'active_support/core_ext/hash/indifferent_access'
require 'active_support/core_ext/hash/slice'
require 'active_support/core_ext/string/behavior'
21
require 'active_support/core_ext/kernel/singleton_class'
22
require 'active_support/core_ext/module/delegation'
23
require 'active_support/core_ext/module/introspection'
24
require 'active_support/core_ext/object/duplicable'
25
require 'active_support/core_ext/object/blank'
26 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 form can
  # be used for statements that don't involve tainted data. The hash form works much like the array form, except
  # only equality and range is possible. Examples:
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 possible to add an exclamation point (!) on the end of the dynamic finders to get them to raise an
181
  # <tt>ActiveRecord::RecordNotFound</tt> error if they do not return any records,
182 183
  # like <tt>Person.find_by_last_name!</tt>.
  #
184
  # It's also possible to use multiple attributes in the same find by separating them with "_and_".
185
  #
186
  #  Person.where(:user_name => user_name, :password => password).first
187
  #  Person.find_by_user_name_and_password(user_name, password) # with dynamic finder
188
  #
189
  # It's even possible to call these dynamic finder methods on relations and named scopes.
190 191 192
  #
  #   Payment.order("created_on").find_all_by_amount(50)
  #   Payment.pending.find_last_by_amount(100)
193
  #
194 195 196 197
  # 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.
198 199 200
  #
  #   # No 'Summer' tag exists
  #   Tag.find_or_create_by_name("Summer") # equal to Tag.create(:name => "Summer")
201
  #
202 203 204
  #   # Now the 'Summer' tag does exist
  #   Tag.find_or_create_by_name("Summer") # equal to Tag.find_by_name("Summer")
  #
205 206 207
  #   # Now 'Bob' exist and is an 'admin'
  #   User.find_or_create_by_name('Bob', :age => 40) { |u| u.admin = true }
  #
208
  # Use the <tt>find_or_initialize_by_</tt> finder if you want to return a new record without
209
  # saving it first. Protected attributes won't be set unless they are given in a block.
210 211 212
  #
  #   # No 'Winter' tag exists
  #   winter = Tag.find_or_initialize_by_name("Winter")
213
  #   winter.persisted? # false
214
  #
215
  # To find by a subset of the attributes to be used for instantiating a new object, pass a hash instead of
216
  # a list of parameters.
217 218 219
  #
  #   Tag.find_or_create_by_name(:name => "rails", :creator => current_user)
  #
220
  # That will either find an existing tag named "rails", or create a new one while setting the
221
  # user that created it.
222
  #
223 224 225 226
  # 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.
  #
227
  #  User.scoped_by_user_name('David')
228
  #
229
  # == Saving arrays, hashes, and other non-mappable objects in text columns
230
  #
231
  # Active Record can serialize any object in text columns using YAML. To do so, you must
232
  # specify this with a call to the class method +serialize+.
233 234
  # This makes it possible to store arrays, hashes, and other non-mappable objects without doing
  # any additional work.
235
  #
D
Initial  
David Heinemeier Hansson 已提交
236 237 238
  #   class User < ActiveRecord::Base
  #     serialize :preferences
  #   end
239
  #
240
  #   user = User.create(:preferences => { "background" => "black", "display" => large })
D
Initial  
David Heinemeier Hansson 已提交
241
  #   User.find(user.id).preferences # => { "background" => "black", "display" => large }
242
  #
243
  # You can also specify a class option as the second parameter that'll raise an exception
244
  # if a serialized object is retrieved as a descendant of a class not in the hierarchy.
245
  #
D
Initial  
David Heinemeier Hansson 已提交
246
  #   class User < ActiveRecord::Base
247
  #     serialize :preferences, Hash
D
Initial  
David Heinemeier Hansson 已提交
248
  #   end
249
  #
250
  #   user = User.create(:preferences => %w( one two three ))
D
Initial  
David Heinemeier Hansson 已提交
251
  #   User.find(user.id).preferences    # raises SerializationTypeMismatch
252
  #
253 254 255 256 257 258 259 260 261 262 263
  # 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 已提交
264 265
  # == Single table inheritance
  #
266 267
  # 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>).
268
  # This means that an inheritance looking like this:
D
Initial  
David Heinemeier Hansson 已提交
269 270 271 272 273 274
  #
  #   class Company < ActiveRecord::Base; end
  #   class Firm < Company; end
  #   class Client < Company; end
  #   class PriorityClient < Client; end
  #
275 276
  # 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
277
  # <tt>Company.where(:name => '37signals').first</tt> and it will return a Firm object.
D
Initial  
David Heinemeier Hansson 已提交
278
  #
279 280
  # 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
281
  # for differentiating between them or reloading the right type with find.
282
  #
D
Initial  
David Heinemeier Hansson 已提交
283 284
  # Note, all the attributes for all the cases are kept in the same table. Read more:
  # http://www.martinfowler.com/eaaCatalog/singleTableInheritance.html
285
  #
D
Initial  
David Heinemeier Hansson 已提交
286 287
  # == Connection to multiple databases in different models
  #
288 289 290
  # 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
291
  # ActiveRecord::Base, but resides in a different database, you can just say <tt>Course.establish_connection</tt>
P
Pratik Naik 已提交
292
  # and Course and all of its subclasses will use this connection instead.
D
Initial  
David Heinemeier Hansson 已提交
293
  #
294 295
  # 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
296
  # will go up the class-hierarchy until a connection is found in the connection pool.
D
Initial  
David Heinemeier Hansson 已提交
297 298
  #
  # == Exceptions
299
  #
P
Pratik Naik 已提交
300 301
  # * 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 已提交
302
  #   <tt>:adapter</tt> key.
303
  # * AdapterNotFound - The <tt>:adapter</tt> key used in <tt>establish_connection</tt> specified a
304
  #   non-existent adapter
305
  #   (or a bad spelling of an existing one).
306
  # * AssociationTypeMismatch - The object assigned to the association wasn't of the type
307
  #   specified in the association definition.
P
Pratik Naik 已提交
308
  # * SerializationTypeMismatch - The serialized object wasn't of the class specified as the second parameter.
309
  # * ConnectionNotEstablished+ - No connection has been established. Use <tt>establish_connection</tt>
310
  #   before querying.
P
Pratik Naik 已提交
311 312 313 314 315
  # * 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
316
  #   <tt>attributes=</tt> method. The +errors+ property of this exception contains an array of
317
  #   AttributeAssignmentError
318
  #   objects that should be inspected to determine which attributes triggered the errors.
319
  # * AttributeAssignmentError - An error occurred while doing a mass assignment through the
320
  #   <tt>attributes=</tt> method.
321
  #   You can inspect the +attribute+ property of the exception object to determine which attribute
322
  #   triggered the error.
323
  #
324
  # *Note*: The attributes listed are class-level attributes (accessible from both the class and instance level).
P
Pratik Naik 已提交
325
  # 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 已提交
326 327
  # instances in the current object space.
  class Base
E
Emilio Tagua 已提交
328
    ##
P
Pratik Naik 已提交
329
    # :singleton-method:
330 331
    # 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
332
    # a class and instance level by calling +logger+.
333
    cattr_accessor :logger, :instance_writer => false
J
Jeremy Kemper 已提交
334

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

626
      # Computes the table name, (re)sets it internally, and returns it.
D
David Heinemeier Hansson 已提交
627
      def reset_table_name #:nodoc:
628 629
        return if abstract_class?

630
        self.table_name = compute_table_name
D
Initial  
David Heinemeier Hansson 已提交
631 632
      end

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

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

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

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

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

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

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

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

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

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

718 719 720 721 722 723
      # 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 已提交
724
      # Returns an array of column names as strings.
725
      def column_names
726
        @column_names ||= columns.map { |column| column.name }
727
      end
D
Initial  
David Heinemeier Hansson 已提交
728

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

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

780
        @column_names = @content_columns = @dynamic_methods_hash = @inheritance_column = nil
781
        @arel_engine = @relation = nil
782 783
      end

784
      def clear_cache! # :nodoc:
A
Aaron Patterson 已提交
785
        connection_pool.clear_cache!
786 787
      end

788
      def attribute_method?(attribute)
J
José Valim 已提交
789
        super || (table_exists? && column_names.include?(attribute.to_s.sub(/=$/, '')))
790 791
      end

S
Sebastian Martinez 已提交
792 793 794
      # Returns an array of column names as strings if it's not
      # an abstract class and table exists.
      # Otherwise it returns an empty array.
795 796 797 798 799 800 801 802
      def attribute_names
        @attribute_names ||= if !abstract_class? && table_exists?
            column_names
          else
            []
          end
      end

803 804
      # Set the lookup ancestors for ActiveModel.
      def lookup_ancestors #:nodoc:
805 806
        klass = self
        classes = [klass]
807 808
        return classes if klass == ActiveRecord::Base

E
Emilio Tagua 已提交
809
        while klass != klass.base_class
810 811 812 813 814
          classes << klass = klass.superclass
        end
        classes
      end

815 816 817
      # Set the i18n scope to overwrite ActiveModel.
      def i18n_scope #:nodoc:
        :activerecord
D
Initial  
David Heinemeier Hansson 已提交
818
      end
819

820 821 822 823 824 825 826
      # 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 已提交
827 828
      end

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

848
      def quote_value(value, column = nil) #:nodoc:
849
        connection.quote(value,column)
850 851
      end

852
      # Used to sanitize objects before they're used in an SQL SELECT statement. Delegates to <tt>connection.quote</tt>.
853
      def sanitize(object) #:nodoc:
854
        connection.quote(object)
D
Initial  
David Heinemeier Hansson 已提交
855 856
      end

857 858 859
      # Overwrite the default class equality method to provide support for association proxies.
      def ===(object)
        object.is_a?(self)
860
      end
861

862 863 864 865
      def symbolized_base_class
        @symbolized_base_class ||= base_class.to_s.to_sym
      end

866
      def symbolized_sti_name
867
        @symbolized_sti_name ||= sti_name.present? ? sti_name.to_sym : symbolized_base_class
868 869
      end

870 871 872
      # 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.
873 874 875
      #
      # 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.
876 877 878 879
      def base_class
        class_of_active_record_descendant(self)
      end

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

883
      # Returns whether this class is an abstract class or not.
884
      def abstract_class?
885
        defined?(@abstract_class) && @abstract_class == true
886 887
      end

888
      def respond_to?(method_id, include_private = false)
889 890
        if match = DynamicFinderMatch.match(method_id)
          return true if all_attributes_exists?(match.attribute_names)
891 892
        elsif match = DynamicScopeMatch.match(method_id)
          return true if all_attributes_exists?(match.attribute_names)
893
        end
894

895 896 897
        super
      end

898 899 900 901
      def sti_name
        store_full_sti_class ? name : name.demodulize
      end

P
Pratik Naik 已提交
902
      def arel_table
903
        @arel_table ||= Arel::Table.new(table_name, arel_engine)
904 905
      end

906 907
      def arel_engine
        @arel_engine ||= begin
908
          if self == ActiveRecord::Base
909
            ActiveRecord::Base
910
          else
911
            connection_handler.connection_pools[name] ? self : superclass.arel_engine
912 913
          end
        end
914 915
      end

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

943
      def before_remove_const #:nodoc:
944
        self.current_scope = nil
945 946
      end

947 948 949
      # 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.
950 951 952
      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 已提交
953

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

        instance
969
      end
970

D
Initial  
David Heinemeier Hansson 已提交
971
      private
J
José Valim 已提交
972 973 974

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

          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 已提交
981
        end
982

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

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

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

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

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

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

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

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

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

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

1149
          previous_scope = self.current_scope
1150

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

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

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

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

1176
            scope = relation
1177 1178
          end

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

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

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

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

Or call unscoped with a block:

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

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

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

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

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

1266
        def build_default_scope #:nodoc:
1267 1268 1269 1270
          if method(:default_scope).owner != Base.singleton_class
            evaluate_default_scope { default_scope }
          elsif default_scopes.any?
            evaluate_default_scope do
1271 1272 1273 1274 1275 1276 1277 1278
              default_scopes.inject(relation) do |default_scope, scope|
                if scope.is_a?(Hash)
                  default_scope.apply_finder_options(scope)
                elsif !scope.is_a?(Relation) && scope.respond_to?(:call)
                  default_scope.merge(scope.call)
                else
                  default_scope.merge(scope)
                end
1279 1280
              end
            end
1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299
          end
        end

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

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

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

          begin
            self.ignore_default_scope = true
            yield
1300 1301
          ensure
            self.ignore_default_scope = false
1302
          end
1303 1304
        end

P
Pratik Naik 已提交
1305
        # Returns the class type of the record using the current module as a prefix. So descendants of
1306
        # MyApp::Business::Account would appear as MyApp::Business::AccountSubclass.
D
Initial  
David Heinemeier Hansson 已提交
1307
        def compute_type(type_name)
1308 1309 1310
          if type_name.match(/^::/)
            # If the type is prefixed with a scope operator then we assume that
            # the type_name is an absolute reference.
1311
            ActiveSupport::Dependencies.constantize(type_name)
1312 1313 1314 1315 1316 1317 1318 1319
          else
            # Build a list of candidates to search for
            candidates = []
            name.scan(/::|$/) { candidates.unshift "#{$`}::#{type_name}" }
            candidates << type_name

            candidates.each do |candidate|
              begin
1320
                constant = ActiveSupport::Dependencies.constantize(candidate)
1321
                return constant if candidate == constant.to_s
1322 1323 1324
              rescue NameError => e
                # We don't want to swallow NoMethodError < NameError errors
                raise e unless e.instance_of?(NameError)
1325
              end
1326
            end
1327 1328

            raise NameError, "uninitialized constant #{candidates.first}"
D
Initial  
David Heinemeier Hansson 已提交
1329 1330 1331
          end
        end

P
Pratik Naik 已提交
1332 1333
        # Returns the class descending directly from ActiveRecord::Base or an
        # abstract class, if any, in the inheritance hierarchy.
1334
        def class_of_active_record_descendant(klass)
1335
          if klass == Base || klass.superclass == Base || klass.superclass.abstract_class?
1336
            klass
D
Initial  
David Heinemeier Hansson 已提交
1337 1338 1339
          elsif klass.superclass.nil?
            raise ActiveRecordError, "#{name} doesn't belong in a hierarchy descending from ActiveRecord"
          else
1340
            class_of_active_record_descendant(klass.superclass)
D
Initial  
David Heinemeier Hansson 已提交
1341 1342 1343
          end
        end

P
Pratik Naik 已提交
1344
        # Accepts an array, hash, or string of SQL conditions and sanitizes
1345
        # them into a valid SQL fragment for a WHERE clause.
1346 1347 1348
        #   ["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'"
1349
        def sanitize_sql_for_conditions(condition, table_name = self.table_name)
1350 1351
          return nil if condition.blank?

1352 1353
          case condition
            when Array; sanitize_sql_array(condition)
1354
            when Hash;  sanitize_sql_hash_for_conditions(condition, table_name)
1355 1356
            else        condition
          end
1357
        end
1358
        alias_method :sanitize_sql, :sanitize_sql_for_conditions
1359

P
Pratik Naik 已提交
1360
        # Accepts an array, hash, or string of SQL conditions and sanitizes
1361 1362 1363 1364 1365 1366 1367 1368 1369 1370
        # 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

1371 1372 1373 1374 1375
        def aggregate_mapping(reflection)
          mapping = reflection.options[:mapping] || [reflection.name, reflection.name]
          mapping.first.is_a?(Array) ? mapping : [mapping]
        end

P
Pratik Naik 已提交
1376
        # Accepts a hash of SQL conditions and replaces those attributes
1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405
        # 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

1406
        # Sanitizes a hash of attribute/value pairs into SQL conditions for a WHERE clause.
1407 1408 1409 1410
        #   { :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)"
1411 1412
        #   { :age => 13..18 }
        #     # => "age BETWEEN 13 AND 18"
1413 1414
        #   { 'other_records.id' => 7 }
        #     # => "`other_records`.`id` = 7"
1415 1416
        #   { :other_records => { :id => 7 } }
        #     # => "`other_records`.`id` = 7"
1417 1418 1419
        # 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'"
1420
        def sanitize_sql_hash_for_conditions(attrs, default_table_name = self.table_name)
1421 1422
          attrs = expand_hash_conditions_for_aggregates(attrs)

1423
          table = Arel::Table.new(table_name).alias(default_table_name)
1424
          PredicateBuilder.build_from_hash(arel_engine, attrs, table).map { |b|
1425
            connection.visitor.accept b
1426
          }.join(' AND ')
1427
        end
1428 1429 1430 1431 1432 1433
        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)
1434
          attrs.map do |attr, value|
1435 1436 1437
            "#{connection.quote_column_name(attr)} = #{quote_bound_value(value)}"
          end.join(', ')
        end
1438

S
Sebastian Martinez 已提交
1439
        # Accepts an array of conditions. The array has each value
P
Pratik Naik 已提交
1440
        # sanitized and interpolated into the SQL statement.
1441
        #   ["name='%s' and group_id='%s'", "foo'bar", 4]  returns  "name='foo''bar' and group_id='4'"
1442
        def sanitize_sql_array(ary)
1443
          statement, *values = ary
1444
          if values.first.is_a?(Hash) && statement =~ /:\w+/
1445 1446
            replace_named_bind_variables(statement, values.first)
          elsif statement.include?('?')
1447
            replace_bind_variables(statement, values)
1448 1449
          elsif statement.blank?
            statement
1450
          else
1451
            statement % values.collect { |value| connection.quote_string(value.to_s) }
1452
          end
1453 1454
        end

1455 1456
        alias_method :sanitize_conditions, :sanitize_sql

D
David Heinemeier Hansson 已提交
1457
        def replace_bind_variables(statement, values) #:nodoc:
1458
          raise_if_bind_arity_mismatch(statement, statement.count('?'), values.size)
1459
          bound = values.dup
C
Comron Sattari 已提交
1460 1461
          c = connection
          statement.gsub('?') { quote_bound_value(bound.shift, c) }
1462 1463
        end

D
David Heinemeier Hansson 已提交
1464
        def replace_named_bind_variables(statement, bind_vars) #:nodoc:
1465 1466 1467 1468
          statement.gsub(/(:?):([a-zA-Z]\w*)/) do
            if $1 == ':' # skip postgresql casts
              $& # return the whole match
            elsif bind_vars.include?(match = $2.to_sym)
1469
              quote_bound_value(bind_vars[match])
1470 1471
            else
              raise PreparedStatementInvalid, "missing value for :#{match} in #{statement}"
1472 1473
            end
          end
1474 1475
        end

1476
        def expand_range_bind_variables(bind_vars) #:nodoc:
1477 1478 1479
          expanded = []

          bind_vars.each do |var|
1480 1481
            next if var.is_a?(Hash)

1482
            if var.is_a?(Range)
1483 1484
              expanded << var.first
              expanded << var.last
1485
            else
1486
              expanded << var
1487
            end
1488
          end
1489 1490

          expanded
1491 1492
        end

C
Comron Sattari 已提交
1493
        def quote_bound_value(value, c = connection) #:nodoc:
1494
          if value.respond_to?(:map) && !value.acts_like?(:string)
1495
            if value.respond_to?(:empty?) && value.empty?
C
Comron Sattari 已提交
1496
              c.quote(nil)
1497
            else
C
Comron Sattari 已提交
1498
              value.map { |v| c.quote(v) }.join(',')
1499
            end
1500
          else
C
Comron Sattari 已提交
1501
            c.quote(value)
1502 1503 1504
          end
        end

D
David Heinemeier Hansson 已提交
1505
        def raise_if_bind_arity_mismatch(statement, expected, provided) #:nodoc:
1506 1507 1508
          unless expected == provided
            raise PreparedStatementInvalid, "wrong number of bind variables (#{provided} for #{expected}) in: #{statement}"
          end
1509
        end
1510

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

D
Initial  
David Heinemeier Hansson 已提交
1549
        ensure_proper_type
1550
        set_serialized_attributes
P
Pratik Naik 已提交
1551

1552
        populate_with_current_scope_attributes
1553 1554

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

A
Aaron Patterson 已提交
1556
        yield self if block_given?
1557
        run_callbacks :initialize
D
Initial  
David Heinemeier Hansson 已提交
1558
      end
1559

1560
      # Populate +coder+ with attributes about this record that should be
S
Sebastian Martinez 已提交
1561
      # serialized. The structure of +coder+ defined in this method is
1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575
      # 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 已提交
1576 1577
      # Initialize an empty model object from +coder+. +coder+ must contain
      # the attributes necessary for initializing an empty model object. For
1578 1579 1580 1581 1582 1583 1584 1585 1586 1587
      # 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 已提交
1588
        @relation = nil
1589

1590
        set_serialized_attributes
1591

1592
        @attributes_cache, @previously_changed, @changed_attributes = {}, {}, {}
1593
        @association_cache = {}
1594
        @aggregation_cache = {}
1595
        @readonly = @destroyed = @marked_for_destruction = false
1596
        @new_record = false
1597 1598
        run_callbacks :find
        run_callbacks :initialize
M
Marcin Raczkowski 已提交
1599 1600

        self
1601 1602
      end

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

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

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

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

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

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

1680
        assign_attributes(new_attributes)
1681 1682 1683
      end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

A
Aaron Patterson 已提交
1851 1852
        ensure_proper_type
        populate_with_current_scope_attributes
1853
        super
1854 1855
      end

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

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

1867
      # Returns the contents of the record as a nicely formatted string.
1868
      def inspect
1869 1870 1871 1872 1873 1874 1875 1876 1877 1878
        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}>"
1879
      end
1880

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

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

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

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

D
Initial  
David Heinemeier Hansson 已提交
1904 1905
    private

1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917
      # 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 已提交
1918
      def set_serialized_attributes
1919 1920 1921 1922
        sattrs = self.class.serialized_attributes

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

2113
        self.class.scope_attributes.each do |att,value|
2114
          send("#{att}=", value) if respond_to?("#{att}=")
2115 2116
        end
      end
D
Initial  
David Heinemeier Hansson 已提交
2117
  end
J
Joshua Peek 已提交
2118 2119

  Base.class_eval do
2120
    include ActiveRecord::Persistence
J
Joshua Peek 已提交
2121
    extend ActiveModel::Naming
J
Joshua Peek 已提交
2122
    extend QueryCache::ClassMethods
J
José Valim 已提交
2123
    extend ActiveSupport::Benchmarkable
2124
    extend ActiveSupport::DescendantsTracker
J
José Valim 已提交
2125

2126
    include ActiveModel::Conversion
J
Joshua Peek 已提交
2127
    include Validations
2128
    extend CounterCache
J
Joshua Peek 已提交
2129 2130
    include Locking::Optimistic, Locking::Pessimistic
    include AttributeMethods
J
Joshua Peek 已提交
2131
    include AttributeMethods::Read, AttributeMethods::Write, AttributeMethods::BeforeTypeCast, AttributeMethods::Query
2132
    include AttributeMethods::PrimaryKey
J
Joshua Peek 已提交
2133 2134
    include AttributeMethods::TimeZoneConversion
    include AttributeMethods::Dirty
2135
    include ActiveModel::MassAssignmentSecurity
2136
    include Callbacks, ActiveModel::Observing, Timestamp
J
Jon Leighton 已提交
2137
    include Associations, NamedScope
M
Marcin Raczkowski 已提交
2138
    include IdentityMap
2139
    include ActiveModel::SecurePassword
2140 2141 2142 2143

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

2146
    NilClass.add_whiner(self) if NilClass.respond_to?(:add_whiner)
2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157

    # 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 已提交
2158
  end
2159
end
2160

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