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

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

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

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

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

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

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

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

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

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

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

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

437 438 439 440 441
    # If a query takes longer than these many seconds we log its query plan
    # automatically. nil disables this feature.
    class_attribute :auto_explain_threshold_in_seconds, :instance_writer => false
    self.auto_explain_threshold_in_seconds = nil

442 443 444
    class_attribute :_attr_readonly, :instance_writer => false
    self._attr_readonly = []

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

455 456 457 458 459 460 461 462
      def inherited(child_class) #:nodoc:
        # force attribute methods to be higher in inheritance hierarchy than other generated methods
        child_class.generated_attribute_methods
        child_class.generated_feature_methods
        super
      end

      def generated_feature_methods
463 464 465 466
        @generated_feature_methods ||= begin
          mod = const_set(:GeneratedFeatureMethods, Module.new)
          include mod
          mod
467 468 469
        end
      end

S
Sebastian Martinez 已提交
470
      # Executes a custom SQL query against your database and returns all the results. The results will
471
      # be returned as an array with columns requested encapsulated as attributes of the model you call
S
Sebastian Martinez 已提交
472
      # this method from. If you call <tt>Product.find_by_sql</tt> then the results will be returned in
P
Pratik Naik 已提交
473
      # a Product object with the attributes you specified in the SQL query.
474
      #
475 476
      # 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
477 478
      # table.
      #
S
Sebastian Martinez 已提交
479 480
      # 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,
481
      # MySQL specific terms will lock you to using that particular database engine or require you to
P
Pratik Naik 已提交
482
      # change your call if you switch engines.
483 484
      #
      # ==== Examples
P
Pratik Naik 已提交
485
      #   # A simple SQL query spanning multiple tables
486 487 488 489 490
      #   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 已提交
491
      #   > [#<Post:0x36bff9c @attributes={"title"=>"The Cheap Man Buys Twice"}>, ...]
492
      def find_by_sql(sql, binds = [])
493 494 495
        logging_query_plan do
          connection.select_all(sanitize_sql(sql), "#{name} Load", binds).collect! { |record| instantiate(record) }
        end
D
Initial  
David Heinemeier Hansson 已提交
496
      end
497

498
      # Creates an object (or multiple objects) and saves it to the database, if validations pass.
499 500
      # The resulting object is returned whether the object was saved successfully to the database or not.
      #
S
Sebastian Martinez 已提交
501
      # The +attributes+ parameter can be either be a Hash or an Array of Hashes. These Hashes describe the
502 503
      # attributes on the objects that are to be created.
      #
504 505 506
      # +create+ respects mass-assignment security and accepts either +:as+ or +:without_protection+ options
      # in the +options+ parameter.
      #
507 508 509
      # ==== Examples
      #   # Create a single new object
      #   User.create(:first_name => 'Jamie')
510
      #
511
      #   # Create a single new object using the :admin mass-assignment security role
512 513 514 515 516
      #   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)
      #
517
      #   # Create an Array of new objects
P
Pratik Naik 已提交
518
      #   User.create([{ :first_name => 'Jamie' }, { :first_name => 'Jeremy' }])
519 520 521 522 523 524 525
      #
      #   # 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 已提交
526
      #   User.create([{ :first_name => 'Jamie' }, { :first_name => 'Jeremy' }]) do |u|
527
      #     u.is_admin = false
528
      #   end
529
      def create(attributes = nil, options = {}, &block)
530
        if attributes.is_a?(Array)
531
          attributes.collect { |attr| create(attr, options, &block) }
532
        else
533
          object = new(attributes, options, &block)
534 535 536
          object.save
          object
        end
D
Initial  
David Heinemeier Hansson 已提交
537 538 539
      end

      # Returns the result of an SQL statement that should only include a COUNT(*) in the SELECT part.
540
      # The use of this method should be restricted to complicated SQL queries that can't be executed
S
Sebastian Martinez 已提交
541
      # using the ActiveRecord::Calculations class methods. Look into those before using this.
542
      #
P
Pratik Naik 已提交
543
      # ==== Parameters
544
      #
P
Pratik Naik 已提交
545
      # * +sql+ - An SQL statement which should return a count query from the database, see the example below.
546 547 548
      #
      # ==== Examples
      #
549
      #   Product.count_by_sql "SELECT COUNT(*) FROM sales s, customers c WHERE s.customer_id = c.id"
D
Initial  
David Heinemeier Hansson 已提交
550
      def count_by_sql(sql)
551
        sql = sanitize_conditions(sql)
552
        connection.select_value(sql, "#{name} Count").to_i
D
Initial  
David Heinemeier Hansson 已提交
553
      end
554

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

561 562
      # Returns an array of all the attributes that have been specified as readonly.
      def readonly_attributes
563
        self._attr_readonly
D
Initial  
David Heinemeier Hansson 已提交
564 565
      end

J
Jon Leighton 已提交
566 567 568 569 570 571 572 573
      def deprecated_property_setter(property, value, block) #:nodoc:
        if block
          ActiveSupport::Deprecation.warn(
            "Calling set_#{property} is deprecated. If you need to lazily evaluate " \
            "the #{property}, define your own `self.#{property}` class method. You can use `super` " \
            "to get the default #{property} where you would have called `original_#{property}`."
          )

574
          define_attr_method property, value, false, &block
J
Jon Leighton 已提交
575 576 577 578 579
        else
          ActiveSupport::Deprecation.warn(
            "Calling set_#{property} is deprecated. Please use `self.#{property} = 'the_name'` instead."
          )

580
          define_attr_method property, value, false
J
Jon Leighton 已提交
581 582 583
        end
      end

584 585 586 587 588 589 590 591 592 593
      def deprecated_original_property_getter(property) #:nodoc:
        ActiveSupport::Deprecation.warn("original_#{property} is deprecated. Define self.#{property} and call super instead.")

        if !instance_variable_defined?("@original_#{property}") && respond_to?("reset_#{property}")
          send("reset_#{property}")
        else
          instance_variable_get("@original_#{property}")
        end
      end

594 595
      # 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
596
      # looks like: Reply < Message < ActiveRecord::Base, then Message is used
597 598
      # 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
599
      # English inflections. You can add new inflections in config/initializers/inflections.rb.
D
Initial  
David Heinemeier Hansson 已提交
600
      #
601
      # Nested classes are given table names prefixed by the singular form of
P
Pratik Naik 已提交
602 603 604
      # the parent's table name. Enclosing modules are not considered.
      #
      # ==== Examples
605
      #
606 607 608
      #   class Invoice < ActiveRecord::Base
      #   end
      #
609 610
      #   file                  class               table_name
      #   invoice.rb            Invoice             invoices
611
      #
612 613 614 615 616
      #   class Invoice < ActiveRecord::Base
      #     class Lineitem < ActiveRecord::Base
      #     end
      #   end
      #
617 618 619
      #   file                  class               table_name
      #   invoice.rb            Invoice::Lineitem   invoice_lineitems
      #
620 621 622 623 624
      #   module Invoice
      #     class Lineitem < ActiveRecord::Base
      #     end
      #   end
      #
625 626
      #   file                  class               table_name
      #   invoice/lineitem.rb   Invoice::Lineitem   lineitems
D
Initial  
David Heinemeier Hansson 已提交
627
      #
P
Pratik Naik 已提交
628
      # Additionally, the class-level +table_name_prefix+ is prepended and the
S
Sebastian Martinez 已提交
629
      # +table_name_suffix+ is appended. So if you have "myapp_" as a prefix,
630 631 632
      # the table name guess for an Invoice class becomes "myapp_invoices".
      # Invoice::Lineitem becomes "myapp_invoice_lineitems".
      #
633
      # You can also set your own table name explicitly:
D
Initial  
David Heinemeier Hansson 已提交
634 635
      #
      #   class Mouse < ActiveRecord::Base
636
      #     self.table_name = "mice"
D
Initial  
David Heinemeier Hansson 已提交
637
      #   end
638 639 640 641 642 643 644 645 646 647 648
      #
      # Alternatively, you can override the table_name method to define your
      # own computation. (Possibly using <tt>super</tt> to manipulate the default
      # table name.) Example:
      #
      #   class Post < ActiveRecord::Base
      #     def self.table_name
      #       "special_" + super
      #     end
      #   end
      #   Post.table_name # => "special_posts"
649
      def table_name
650 651 652 653
        reset_table_name unless defined?(@table_name)
        @table_name
      end

654 655 656 657
      def original_table_name #:nodoc:
        deprecated_original_property_getter :table_name
      end

658 659 660 661 662 663 664 665 666
      # Sets the table name explicitly. Example:
      #
      #   class Project < ActiveRecord::Base
      #     self.table_name = "project"
      #   end
      #
      # You can also just define your own <tt>self.table_name</tt> method; see
      # the documentation for ActiveRecord::Base#table_name.
      def table_name=(value)
667 668 669 670 671
        @original_table_name = @table_name if defined?(@table_name)
        @table_name          = value
        @quoted_table_name   = nil
        @arel_table          = nil
        @relation            = Relation.new(self, arel_table)
672 673 674
      end

      def set_table_name(value = nil, &block) #:nodoc:
J
Jon Leighton 已提交
675 676 677 678
        deprecated_property_setter :table_name, value, block
        @quoted_table_name = nil
        @arel_table        = nil
        @relation          = Relation.new(self, arel_table)
679 680
      end

681
      # Returns a quoted version of the table name, used to construct SQL statements.
P
Pratik Naik 已提交
682 683 684 685
      def quoted_table_name
        @quoted_table_name ||= connection.quote_table_name(table_name)
      end

686
      # Computes the table name, (re)sets it internally, and returns it.
D
David Heinemeier Hansson 已提交
687
      def reset_table_name #:nodoc:
688 689 690 691 692 693 694
        if superclass.abstract_class?
          self.table_name = superclass.table_name || compute_table_name
        elsif abstract_class?
          self.table_name = superclass == Base ? nil : superclass.table_name
        else
          self.table_name = compute_table_name
        end
D
Initial  
David Heinemeier Hansson 已提交
695 696
      end

697
      def full_table_name_prefix #:nodoc:
698 699 700
        (parents.detect{ |p| p.respond_to?(:table_name_prefix) } || self).table_name_prefix
      end

701
      # The name of the column containing the object's class when Single Table Inheritance is used
D
Initial  
David Heinemeier Hansson 已提交
702
      def inheritance_column
703 704 705
        if self == Base
          'type'
        else
J
Jon Leighton 已提交
706
          (@inheritance_column ||= nil) || superclass.inheritance_column
707 708 709
        end
      end

710 711 712 713
      def original_inheritance_column #:nodoc:
        deprecated_original_property_getter :inheritance_column
      end

714 715
      # Sets the value of inheritance_column
      def inheritance_column=(value)
716 717
        @original_inheritance_column = inheritance_column
        @inheritance_column          = value.to_s
718 719 720
      end

      def set_inheritance_column(value = nil, &block) #:nodoc:
J
Jon Leighton 已提交
721
        deprecated_property_setter :inheritance_column, value, block
D
Initial  
David Heinemeier Hansson 已提交
722 723
      end

724
      def sequence_name
725
        if base_class == self
726 727
          @sequence_name ||= reset_sequence_name
        else
728
          (@sequence_name ||= nil) || base_class.sequence_name
729
        end
730 731
      end

732 733 734 735
      def original_sequence_name #:nodoc:
        deprecated_original_property_getter :sequence_name
      end

D
David Heinemeier Hansson 已提交
736
      def reset_sequence_name #:nodoc:
737
        self.sequence_name = connection.default_sequence_name(table_name, primary_key)
738 739 740 741
      end

      # 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
742 743
      # given block. This is required for Oracle and is useful for any
      # database which relies on sequences for primary key generation.
744
      #
745 746 747 748 749
      # 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.
750 751
      #
      #   class Project < ActiveRecord::Base
752
      #     self.sequence_name = "projectseq"   # default would have been "project_seq"
753
      #   end
754
      def sequence_name=(value)
755 756
        @original_sequence_name = @sequence_name if defined?(@sequence_name)
        @sequence_name          = value.to_s
757 758 759
      end

      def set_sequence_name(value = nil, &block) #:nodoc:
J
Jon Leighton 已提交
760
        deprecated_property_setter :sequence_name, value, block
761 762
      end

763 764
      # Indicates whether the table associated with this class exists
      def table_exists?
765
        connection.schema_cache.table_exists?(table_name)
766 767
      end

D
Initial  
David Heinemeier Hansson 已提交
768 769
      # Returns an array of column objects for the table associated with this class.
      def columns
770
        if defined?(@primary_key)
771
          connection.schema_cache.primary_keys[table_name] ||= primary_key
772 773
        end

774
        connection.schema_cache.columns[table_name]
D
Initial  
David Heinemeier Hansson 已提交
775
      end
776

777
      # Returns a hash of column objects for the table associated with this class.
D
Initial  
David Heinemeier Hansson 已提交
778
      def columns_hash
779
        connection.schema_cache.columns_hash[table_name]
D
Initial  
David Heinemeier Hansson 已提交
780
      end
781

782 783 784
      # 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
785
        connection.schema_cache.column_defaults[table_name]
786 787
      end

D
David Heinemeier Hansson 已提交
788
      # Returns an array of column names as strings.
789
      def column_names
790
        @column_names ||= columns.map { |column| column.name }
791
      end
D
Initial  
David Heinemeier Hansson 已提交
792

793 794
      # 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 已提交
795
      def content_columns
796
        @content_columns ||= columns.reject { |c| c.primary || c.name =~ /(_id|_count)$/ || c.name == inheritance_column }
D
Initial  
David Heinemeier Hansson 已提交
797 798 799 800
      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
801
      # is available.
D
David Heinemeier Hansson 已提交
802
      def column_methods_hash #:nodoc:
803
        @dynamic_methods_hash ||= column_names.inject(Hash.new(false)) do |methods, attr|
804 805 806 807 808
          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 已提交
809 810 811
          methods
        end
      end
812

P
Pratik Naik 已提交
813 814 815 816 817 818 819 820
      # 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
A
Akira Matsuda 已提交
821
      #    def up
P
Pratik Naik 已提交
822 823 824 825 826 827 828 829 830 831 832 833 834
      #      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
      #
A
Akira Matsuda 已提交
835
      #    def down
P
Pratik Naik 已提交
836 837 838
      #      drop_table :job_levels
      #    end
      #  end
839
      def reset_column_information
A
Aaron Patterson 已提交
840
        connection.clear_cache!
841
        undefine_attribute_methods
842
        connection.schema_cache.clear_table_cache!(table_name) if table_exists?
A
Aaron Patterson 已提交
843

844
        @column_names = @content_columns = @dynamic_methods_hash = @inheritance_column = nil
845
        @arel_engine = @relation = nil
846 847
      end

848
      def clear_cache! # :nodoc:
849
        connection.schema_cache.clear!
850 851
      end

852
      def attribute_method?(attribute)
J
José Valim 已提交
853
        super || (table_exists? && column_names.include?(attribute.to_s.sub(/=$/, '')))
854 855
      end

S
Sebastian Martinez 已提交
856 857 858
      # Returns an array of column names as strings if it's not
      # an abstract class and table exists.
      # Otherwise it returns an empty array.
859 860 861 862 863 864 865 866
      def attribute_names
        @attribute_names ||= if !abstract_class? && table_exists?
            column_names
          else
            []
          end
      end

867 868
      # Set the lookup ancestors for ActiveModel.
      def lookup_ancestors #:nodoc:
869 870
        klass = self
        classes = [klass]
871 872
        return classes if klass == ActiveRecord::Base

E
Emilio Tagua 已提交
873
        while klass != klass.base_class
874 875 876 877 878
          classes << klass = klass.superclass
        end
        classes
      end

879 880 881
      # Set the i18n scope to overwrite ActiveModel.
      def i18n_scope #:nodoc:
        :activerecord
D
Initial  
David Heinemeier Hansson 已提交
882
      end
883

884 885 886 887 888 889 890
      # 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 已提交
891 892
      end

893 894 895 896 897
      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 已提交
898
      # Returns a string like 'Post(id:integer, title:string, body:text)'
899
      def inspect
900 901 902 903
        if self == Base
          super
        elsif abstract_class?
          "#{super}(abstract)"
904
        elsif table_exists?
905 906
          attr_list = columns.map { |c| "#{c.name}: #{c.type}" } * ', '
          "#{super}(#{attr_list})"
907 908
        else
          "#{super}(Table doesn't exist)"
909
        end
910 911
      end

912
      def quote_value(value, column = nil) #:nodoc:
913
        connection.quote(value,column)
914 915
      end

916
      # Used to sanitize objects before they're used in an SQL SELECT statement. Delegates to <tt>connection.quote</tt>.
917
      def sanitize(object) #:nodoc:
918
        connection.quote(object)
D
Initial  
David Heinemeier Hansson 已提交
919 920
      end

921 922 923
      # Overwrite the default class equality method to provide support for association proxies.
      def ===(object)
        object.is_a?(self)
924
      end
925

926 927 928 929
      def symbolized_base_class
        @symbolized_base_class ||= base_class.to_s.to_sym
      end

930
      def symbolized_sti_name
931
        @symbolized_sti_name ||= sti_name.present? ? sti_name.to_sym : symbolized_base_class
932 933
      end

934 935 936
      # 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.
937 938 939
      #
      # 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.
940 941 942 943
      def base_class
        class_of_active_record_descendant(self)
      end

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

947
      # Returns whether this class is an abstract class or not.
948
      def abstract_class?
949
        defined?(@abstract_class) && @abstract_class == true
950 951
      end

952
      def respond_to?(method_id, include_private = false)
953 954
        if match = DynamicFinderMatch.match(method_id)
          return true if all_attributes_exists?(match.attribute_names)
955 956
        elsif match = DynamicScopeMatch.match(method_id)
          return true if all_attributes_exists?(match.attribute_names)
957
        end
958

959 960 961
        super
      end

962 963 964 965
      def sti_name
        store_full_sti_class ? name : name.demodulize
      end

P
Pratik Naik 已提交
966
      def arel_table
967
        @arel_table ||= Arel::Table.new(table_name, arel_engine)
968 969
      end

970 971
      def arel_engine
        @arel_engine ||= begin
972
          if self == ActiveRecord::Base
973
            ActiveRecord::Base
974
          else
975
            connection_handler.connection_pools[name] ? self : superclass.arel_engine
976 977
          end
        end
978 979
      end

980 981 982
      # Returns a scope for this class without taking into account the default_scope.
      #
      #   class Post < ActiveRecord::Base
983 984 985
      #     def self.default_scope
      #       where :published => true
      #     end
986 987 988 989 990 991 992 993 994
      #   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 {
995
      #     Post.limit(10) # Fires "SELECT * FROM posts LIMIT 10"
996 997
      #   }
      #
998 999
      # 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.
1000
      #
1001 1002
      # Post.unscoped.published
      # Post.published
1003
      def unscoped #:nodoc:
1004 1005 1006
        block_given? ? relation.scoping { yield } : relation
      end

1007
      def before_remove_const #:nodoc:
1008
        self.current_scope = nil
1009 1010
      end

1011 1012 1013
      # 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.
1014 1015
      def instantiate(record)
        sti_class = find_sti_class(record[inheritance_column])
1016
        record_id = sti_class.primary_key && record[sti_class.primary_key]
M
Marcin Raczkowski 已提交
1017

1018 1019 1020 1021 1022 1023
        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)
1024
          else
M
Marcin Raczkowski 已提交
1025
            instance = sti_class.allocate.init_with('attributes' => record)
1026
            IdentityMap.add(instance)
1027
          end
1028 1029 1030 1031 1032
        else
          instance = sti_class.allocate.init_with('attributes' => record)
        end

        instance
1033
      end
1034

D
Initial  
David Heinemeier Hansson 已提交
1035
      private
J
José Valim 已提交
1036 1037 1038

        def relation #:nodoc:
          @relation ||= Relation.new(self, arel_table)
1039 1040 1041 1042 1043 1044

          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 已提交
1045
        end
1046

1047
        def find_sti_class(type_name)
1048
          if type_name.blank? || !columns_hash.include?(inheritance_column)
1049 1050 1051
            self
          else
            begin
1052 1053 1054 1055 1056
              if store_full_sti_class
                ActiveSupport::Dependencies.constantize(type_name)
              else
                compute_type(type_name)
              end
1057 1058 1059 1060 1061 1062 1063 1064 1065 1066
            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

1067
        def construct_finder_arel(options = {}, scope = nil)
1068
          relation = options.is_a?(Hash) ? unscoped.apply_finder_options(options) : options
1069
          relation = scope.merge(relation) if scope
1070
          relation
1071 1072
        end

1073 1074
        def type_condition(table = arel_table)
          sti_column = table[inheritance_column.to_sym]
1075
          sti_names  = ([self] + descendants).map { |model| model.sti_name }
1076

1077
          sti_column.in(sti_names)
D
Initial  
David Heinemeier Hansson 已提交
1078 1079 1080
        end

        # Guesses the table name, but does not decorate it with prefix and suffix information.
1081
        def undecorated_table_name(class_name = base_class.name)
1082 1083
          table_name = class_name.to_s.demodulize.underscore
          table_name = table_name.pluralize if pluralize_table_names
1084
          table_name
D
Initial  
David Heinemeier Hansson 已提交
1085 1086
        end

1087 1088 1089 1090 1091 1092 1093 1094
        # 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
1095
              contained += '_'
1096 1097 1098 1099 1100 1101 1102 1103
            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

1104
        # Enables dynamic finders like <tt>User.find_by_user_name(user_name)</tt> and
1105 1106
        # <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.
1107
        #
1108
        # It's even possible to use all the additional parameters to +find+. For example, the
1109
        # full interface for +find_all_by_amount+ is actually <tt>find_all_by_amount(amount, options)</tt>.
1110
        #
1111
        # Each dynamic finder using <tt>scoped_by_*</tt> is also defined in the class after it
1112
        # is first invoked, so that future attempts to use it do not run through method_missing.
1113
        def method_missing(method_id, *arguments, &block)
1114
          if match = (DynamicFinderMatch.match(method_id) || DynamicScopeMatch.match(method_id))
1115
            attribute_names = match.attribute_names
1116
            super unless all_attributes_exists?(attribute_names)
1117 1118 1119 1120 1121
            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
1122
            if match.respond_to?(:scope?) && match.scope?
1123
              self.class_eval <<-METHOD, __FILE__, __LINE__ + 1
1124 1125 1126 1127 1128
                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
1129
              METHOD
1130
              send(method_id, *arguments)
1131 1132 1133 1134 1135 1136
            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
1137
            end
1138 1139 1140 1141
          else
            super
          end
        end
D
Initial  
David Heinemeier Hansson 已提交
1142

1143 1144
        # Similar in purpose to +expand_hash_conditions_for_aggregates+.
        def expand_attribute_names_for_aggregates(attribute_names)
1145
          attribute_names.map { |attribute_name|
1146
            unless (aggregation = reflect_on_aggregation(attribute_name.to_sym)).nil?
1147 1148
              aggregate_mapping(aggregation).map do |field_attr, _|
                field_attr.to_sym
1149 1150
              end
            else
1151
              attribute_name.to_sym
1152
            end
1153
          }.flatten
1154 1155
        end

1156
        def all_attributes_exists?(attribute_names)
1157 1158
          (expand_attribute_names_for_aggregates(attribute_names) -
           column_methods_hash.keys).empty?
1159
        end
1160

D
Initial  
David Heinemeier Hansson 已提交
1161
      protected
N
Neeraj Singh 已提交
1162 1163
        # 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
1164
        # <tt>:create</tt> parameters are an attributes hash.
1165 1166 1167
        #
        #   class Article < ActiveRecord::Base
        #     def self.create_with_scope
1168
        #       with_scope(:find => where(:blog_id => 1), :create => { :blog_id => 1 }) do
1169 1170 1171 1172 1173 1174 1175
        #         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 已提交
1176
        # In nested scopings, all previous parameters are overwritten by the innermost rule, with the exception of
1177
        # <tt>where</tt>, <tt>includes</tt>, and <tt>joins</tt> operations in <tt>Relation</tt>, which are merged.
P
Pratik Naik 已提交
1178
        #
1179
        # <tt>joins</tt> operations are uniqued so multiple scopes can join in the same table without table aliasing
S
Sebastian Martinez 已提交
1180
        # problems. If you need to join multiple tables, but still want one of the tables to be uniqued, use the
P
Pratik Naik 已提交
1181
        # array of strings format for your joins.
1182 1183 1184
        #
        #   class Article < ActiveRecord::Base
        #     def self.find_with_scope
1185 1186 1187
        #       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
1188
        #         end
1189 1190
        #         with_scope(:find => where(:author_id => 3)) do
        #           all # => SELECT * from articles WHERE blog_id = 1 AND author_id = 3 LIMIT 1
1191 1192 1193 1194 1195
        #         end
        #       end
        #     end
        #   end
        #
1196
        # You can ignore any previous scopings by using the <tt>with_exclusive_scope</tt> method.
1197 1198 1199
        #
        #   class Article < ActiveRecord::Base
        #     def self.find_with_exclusive_scope
1200
        #       with_scope(:find => where(:blog_id => 1).limit(1)) do
1201
        #         with_exclusive_scope(:find => limit(10)) do
1202
        #           all # => SELECT * from articles LIMIT 10
1203 1204 1205 1206
        #         end
        #       end
        #     end
        #   end
P
Pratik Naik 已提交
1207
        #
N
Neeraj Singh 已提交
1208
        # *Note*: the +:find+ scope also has effect on update and deletion methods, like +update_all+ and +delete_all+.
1209 1210 1211 1212
        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)

1213
          previous_scope = self.current_scope
1214

1215
          if scope.is_a?(Hash)
1216
            # Dup first and second level of hash (method and params).
1217 1218 1219
            scope = scope.dup
            scope.each do |method, params|
              scope[method] = params.dup unless params == true
1220
            end
1221

1222 1223
            scope.assert_valid_keys([ :find, :create ])
            relation = construct_finder_arel(scope[:find] || {})
1224
            relation.default_scoped = true unless action == :overwrite
1225

1226
            if previous_scope && previous_scope.create_with_value && scope[:create]
1227
              scope_for_create = if action == :merge
1228
                previous_scope.create_with_value.merge(scope[:create])
1229
              else
1230
                scope[:create]
1231
              end
1232 1233 1234

              relation = relation.create_with(scope_for_create)
            else
1235 1236
              scope_for_create = scope[:create]
              scope_for_create ||= previous_scope.create_with_value if previous_scope
1237 1238 1239
              relation = relation.create_with(scope_for_create) if scope_for_create
            end

1240
            scope = relation
1241 1242
          end

1243
          scope = previous_scope.merge(scope) if previous_scope && action == :merge
1244

1245
          self.current_scope = scope
1246 1247 1248
          begin
            yield
          ensure
1249
            self.current_scope = previous_scope
1250 1251 1252 1253 1254
          end
        end

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

1259 1260 1261 1262 1263 1264 1265 1266 1267
  User.unscoped.where(:active => true)

Or call unscoped with a block:

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

MSG
1268
          end
1269 1270 1271
          with_scope(method_scoping, :overwrite, &block)
        end

1272
        def current_scope #:nodoc:
1273
          Thread.current["#{self}_current_scope"]
1274 1275 1276
        end

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

1280
        # Use this macro in your model to set a default scope for all operations on
1281
        # the model.
1282
        #
1283 1284
        #   class Article < ActiveRecord::Base
        #     default_scope where(:published => true)
1285
        #   end
1286
        #
1287
        #   Article.all # => SELECT * FROM articles WHERE published = true
1288 1289
        #
        # The <tt>default_scope</tt> is also applied while creating/building a record. It is not
1290 1291
        # applied while updating a record.
        #
1292 1293
        #   Article.new.published    # => true
        #   Article.create.published # => true
1294
        #
1295 1296 1297 1298 1299 1300 1301 1302 1303
        # 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.)
        #
1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316
        # 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.
        #
1317 1318
        # If you need to do more complex things with a default scope, you can alternatively
        # define it as a class method:
1319
        #
1320 1321 1322 1323
        #   class Article < ActiveRecord::Base
        #     def self.default_scope
        #       # Should return a scope, you can call 'super' here etc.
        #     end
1324 1325
        #   end
        def default_scope(scope = {})
1326
          scope = Proc.new if block_given?
1327
          self.default_scopes = default_scopes + [scope]
1328
        end
1329

1330
        def build_default_scope #:nodoc:
1331 1332 1333 1334
          if method(:default_scope).owner != Base.singleton_class
            evaluate_default_scope { default_scope }
          elsif default_scopes.any?
            evaluate_default_scope do
1335 1336 1337 1338 1339 1340 1341 1342
              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
1343 1344
              end
            end
1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363
          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
1364 1365
          ensure
            self.ignore_default_scope = false
1366
          end
1367 1368
        end

P
Pratik Naik 已提交
1369
        # Returns the class type of the record using the current module as a prefix. So descendants of
1370
        # MyApp::Business::Account would appear as MyApp::Business::AccountSubclass.
D
Initial  
David Heinemeier Hansson 已提交
1371
        def compute_type(type_name)
1372 1373 1374
          if type_name.match(/^::/)
            # If the type is prefixed with a scope operator then we assume that
            # the type_name is an absolute reference.
1375
            ActiveSupport::Dependencies.constantize(type_name)
1376 1377 1378 1379 1380 1381 1382 1383
          else
            # Build a list of candidates to search for
            candidates = []
            name.scan(/::|$/) { candidates.unshift "#{$`}::#{type_name}" }
            candidates << type_name

            candidates.each do |candidate|
              begin
1384
                constant = ActiveSupport::Dependencies.constantize(candidate)
1385
                return constant if candidate == constant.to_s
1386 1387 1388
              rescue NameError => e
                # We don't want to swallow NoMethodError < NameError errors
                raise e unless e.instance_of?(NameError)
1389
              end
1390
            end
1391 1392

            raise NameError, "uninitialized constant #{candidates.first}"
D
Initial  
David Heinemeier Hansson 已提交
1393 1394 1395
          end
        end

P
Pratik Naik 已提交
1396 1397
        # Returns the class descending directly from ActiveRecord::Base or an
        # abstract class, if any, in the inheritance hierarchy.
1398
        def class_of_active_record_descendant(klass)
1399
          if klass == Base || klass.superclass == Base || klass.superclass.abstract_class?
1400
            klass
D
Initial  
David Heinemeier Hansson 已提交
1401 1402 1403
          elsif klass.superclass.nil?
            raise ActiveRecordError, "#{name} doesn't belong in a hierarchy descending from ActiveRecord"
          else
1404
            class_of_active_record_descendant(klass.superclass)
D
Initial  
David Heinemeier Hansson 已提交
1405 1406 1407
          end
        end

P
Pratik Naik 已提交
1408
        # Accepts an array, hash, or string of SQL conditions and sanitizes
1409
        # them into a valid SQL fragment for a WHERE clause.
1410 1411 1412
        #   ["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'"
1413
        def sanitize_sql_for_conditions(condition, table_name = self.table_name)
1414 1415
          return nil if condition.blank?

1416
          case condition
1417 1418 1419
          when Array; sanitize_sql_array(condition)
          when Hash;  sanitize_sql_hash_for_conditions(condition, table_name)
          else        condition
1420
          end
1421
        end
1422
        alias_method :sanitize_sql, :sanitize_sql_for_conditions
1423

P
Pratik Naik 已提交
1424
        # Accepts an array, hash, or string of SQL conditions and sanitizes
1425 1426 1427 1428 1429 1430 1431 1432 1433 1434
        # 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

1435 1436 1437 1438 1439
        def aggregate_mapping(reflection)
          mapping = reflection.options[:mapping] || [reflection.name, reflection.name]
          mapping.first.is_a?(Array) ? mapping : [mapping]
        end

P
Pratik Naik 已提交
1440
        # Accepts a hash of SQL conditions and replaces those attributes
1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469
        # 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

1470
        # Sanitizes a hash of attribute/value pairs into SQL conditions for a WHERE clause.
1471 1472 1473 1474
        #   { :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)"
1475 1476
        #   { :age => 13..18 }
        #     # => "age BETWEEN 13 AND 18"
1477 1478
        #   { 'other_records.id' => 7 }
        #     # => "`other_records`.`id` = 7"
1479 1480
        #   { :other_records => { :id => 7 } }
        #     # => "`other_records`.`id` = 7"
1481 1482 1483
        # 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'"
1484
        def sanitize_sql_hash_for_conditions(attrs, default_table_name = self.table_name)
1485 1486
          attrs = expand_hash_conditions_for_aggregates(attrs)

1487
          table = Arel::Table.new(table_name).alias(default_table_name)
1488
          PredicateBuilder.build_from_hash(arel_engine, attrs, table).map { |b|
1489
            connection.visitor.accept b
1490
          }.join(' AND ')
1491
        end
1492 1493 1494 1495 1496 1497
        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)
1498
          attrs.map do |attr, value|
1499 1500 1501
            "#{connection.quote_column_name(attr)} = #{quote_bound_value(value)}"
          end.join(', ')
        end
1502

S
Sebastian Martinez 已提交
1503
        # Accepts an array of conditions. The array has each value
P
Pratik Naik 已提交
1504
        # sanitized and interpolated into the SQL statement.
1505
        #   ["name='%s' and group_id='%s'", "foo'bar", 4]  returns  "name='foo''bar' and group_id='4'"
1506
        def sanitize_sql_array(ary)
1507
          statement, *values = ary
1508
          if values.first.is_a?(Hash) && statement =~ /:\w+/
1509 1510
            replace_named_bind_variables(statement, values.first)
          elsif statement.include?('?')
1511
            replace_bind_variables(statement, values)
1512 1513
          elsif statement.blank?
            statement
1514
          else
1515
            statement % values.collect { |value| connection.quote_string(value.to_s) }
1516
          end
1517 1518
        end

1519 1520
        alias_method :sanitize_conditions, :sanitize_sql

D
David Heinemeier Hansson 已提交
1521
        def replace_bind_variables(statement, values) #:nodoc:
1522
          raise_if_bind_arity_mismatch(statement, statement.count('?'), values.size)
1523
          bound = values.dup
C
Comron Sattari 已提交
1524 1525
          c = connection
          statement.gsub('?') { quote_bound_value(bound.shift, c) }
1526 1527
        end

D
David Heinemeier Hansson 已提交
1528
        def replace_named_bind_variables(statement, bind_vars) #:nodoc:
1529 1530 1531 1532
          statement.gsub(/(:?):([a-zA-Z]\w*)/) do
            if $1 == ':' # skip postgresql casts
              $& # return the whole match
            elsif bind_vars.include?(match = $2.to_sym)
1533
              quote_bound_value(bind_vars[match])
1534 1535
            else
              raise PreparedStatementInvalid, "missing value for :#{match} in #{statement}"
1536 1537
            end
          end
1538 1539
        end

1540
        def expand_range_bind_variables(bind_vars) #:nodoc:
1541 1542 1543
          expanded = []

          bind_vars.each do |var|
1544 1545
            next if var.is_a?(Hash)

1546
            if var.is_a?(Range)
1547 1548
              expanded << var.first
              expanded << var.last
1549
            else
1550
              expanded << var
1551
            end
1552
          end
1553 1554

          expanded
1555 1556
        end

C
Comron Sattari 已提交
1557
        def quote_bound_value(value, c = connection) #:nodoc:
1558
          if value.respond_to?(:map) && !value.acts_like?(:string)
1559
            if value.respond_to?(:empty?) && value.empty?
C
Comron Sattari 已提交
1560
              c.quote(nil)
1561
            else
C
Comron Sattari 已提交
1562
              value.map { |v| c.quote(v) }.join(',')
1563
            end
1564
          else
C
Comron Sattari 已提交
1565
            c.quote(value)
1566 1567 1568
          end
        end

D
David Heinemeier Hansson 已提交
1569
        def raise_if_bind_arity_mismatch(statement, expected, provided) #:nodoc:
1570 1571 1572
          unless expected == provided
            raise PreparedStatementInvalid, "wrong number of bind variables (#{provided} for #{expected}) in: #{statement}"
          end
1573
        end
1574

D
David Heinemeier Hansson 已提交
1575
        def encode_quoted_value(value) #:nodoc:
1576
          quoted_value = connection.quote(value)
1577 1578
          quoted_value = "'#{quoted_value[1..-2].gsub(/\'/, "\\\\'")}'" if quoted_value.include?("\\\'") # (for ruby mode) "
          quoted_value
1579
        end
D
Initial  
David Heinemeier Hansson 已提交
1580 1581 1582 1583 1584
    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).
1585
      # In both instances, valid attribute keys are determined by the column names of the associated table --
D
Initial  
David Heinemeier Hansson 已提交
1586
      # hence you can't have attributes that aren't part of the table columns.
1587 1588 1589 1590 1591 1592 1593 1594
      #
      # +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')
      #
1595
      #   # Instantiates a single new object using the :admin mass-assignment security role
1596 1597 1598 1599 1600
      #   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 = {})
1601
        @attributes = attributes_from_column_definition
1602
        @association_cache = {}
1603
        @aggregation_cache = {}
1604
        @attributes_cache = {}
1605
        @new_record = true
1606
        @readonly = false
1607 1608
        @destroyed = false
        @marked_for_destruction = false
1609 1610
        @previously_changed = {}
        @changed_attributes = {}
A
Aaron Patterson 已提交
1611
        @relation = nil
1612

D
Initial  
David Heinemeier Hansson 已提交
1613
        ensure_proper_type
1614
        set_serialized_attributes
P
Pratik Naik 已提交
1615

1616
        populate_with_current_scope_attributes
1617 1618

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

A
Aaron Patterson 已提交
1620
        yield self if block_given?
1621
        run_callbacks :initialize
D
Initial  
David Heinemeier Hansson 已提交
1622
      end
1623

1624
      # Populate +coder+ with attributes about this record that should be
S
Sebastian Martinez 已提交
1625
      # serialized. The structure of +coder+ defined in this method is
1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639
      # 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 已提交
1640 1641
      # Initialize an empty model object from +coder+. +coder+ must contain
      # the attributes necessary for initializing an empty model object. For
1642 1643 1644 1645 1646 1647 1648 1649 1650 1651
      # 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 已提交
1652
        @relation = nil
1653

1654
        set_serialized_attributes
1655

1656
        @attributes_cache, @previously_changed, @changed_attributes = {}, {}, {}
1657
        @association_cache = {}
1658
        @aggregation_cache = {}
1659
        @readonly = @destroyed = @marked_for_destruction = false
1660
        @new_record = false
1661 1662
        run_callbacks :find
        run_callbacks :initialize
M
Marcin Raczkowski 已提交
1663 1664

        self
1665 1666
      end

P
Pratik Naik 已提交
1667 1668 1669 1670
      # 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 已提交
1671
      # For example, suppose that you have a User model, and that you have a
1672
      # <tt>resources :users</tt> route. Normally, +user_path+ will
P
Pratik Naik 已提交
1673
      # construct a path with the user object's 'id' in it:
P
Pratik Naik 已提交
1674 1675
      #
      #   user = User.find_by_name('Phusion')
1676
      #   user_path(user)  # => "/users/1"
P
Pratik Naik 已提交
1677
      #
P
Pratik Naik 已提交
1678 1679
      # 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 已提交
1680 1681 1682 1683 1684 1685
      #
      #   class User < ActiveRecord::Base
      #     def to_param  # overridden
      #       name
      #     end
      #   end
E
Emilio Tagua 已提交
1686
      #
P
Pratik Naik 已提交
1687
      #   user = User.find_by_name('Phusion')
1688
      #   user_path(user)  # => "/users/Phusion"
1689
      def to_param
1690
        # We can't use alias_method here, because method 'id' optimizes itself on the fly.
1691
        id && id.to_s # Be sure to stringify the id for routes
1692
      end
1693

P
Pratik Naik 已提交
1694 1695 1696
      # Returns a cache key that can be used to identify this record.
      #
      # ==== Examples
1697 1698 1699 1700 1701
      #
      #   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
1702
        case
1703
        when new_record?
J
Jeremy Kemper 已提交
1704 1705
          "#{self.class.model_name.cache_key}/new"
        when timestamp = self[:updated_at]
1706 1707
          timestamp = timestamp.utc.to_s(:number)
          "#{self.class.model_name.cache_key}/#{id}-#{timestamp}"
1708
        else
J
Jeremy Kemper 已提交
1709
          "#{self.class.model_name.cache_key}/#{id}"
1710 1711
        end
      end
1712

1713
      def quoted_id #:nodoc:
1714
        quote_value(id, column_for_attribute(self.class.primary_key))
1715
      end
1716

1717 1718 1719 1720 1721
      # Returns true if the given attribute is in the attributes hash
      def has_attribute?(attr_name)
        @attributes.has_key?(attr_name.to_s)
      end

1722
      # Returns an array of names for the attributes available on this object.
1723
      def attribute_names
1724
        @attributes.keys
D
Initial  
David Heinemeier Hansson 已提交
1725 1726 1727
      end

      # Allows you to set all the attributes at once by passing in a hash with keys
P
Pratik Naik 已提交
1728 1729
      # matching the attribute names (which again matches the column names).
      #
1730 1731 1732
      # If any attributes are protected by either +attr_protected+ or
      # +attr_accessible+ then only settable attributes will be assigned.
      #
P
Pratik Naik 已提交
1733 1734 1735
      #   class User < ActiveRecord::Base
      #     attr_protected :is_admin
      #   end
E
Emilio Tagua 已提交
1736
      #
P
Pratik Naik 已提交
1737 1738 1739 1740
      #   user = User.new
      #   user.attributes = { :username => 'Phusion', :is_admin => true }
      #   user.username   # => "Phusion"
      #   user.is_admin?  # => false
1741
      def attributes=(new_attributes)
P
Pratik Naik 已提交
1742
        return unless new_attributes.is_a?(Hash)
1743

1744
        assign_attributes(new_attributes)
1745 1746 1747
      end

      # Allows you to set all the attributes for a particular mass-assignment
1748 1749
      # security role by passing in a hash of attributes with keys matching
      # the attribute names (which again matches the column names) and the role
1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774
      # 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 = {})
1775 1776
        return unless new_attributes

1777
        attributes = new_attributes.stringify_keys
D
Initial  
David Heinemeier Hansson 已提交
1778
        multi_parameter_attributes = []
1779
        @mass_assignment_options = options
1780 1781

        unless options[:without_protection]
1782
          attributes = sanitize_for_mass_assignment(attributes, mass_assignment_role)
1783
        end
1784

1785
        attributes.each do |k, v|
1786 1787
          if k.include?("(")
            multi_parameter_attributes << [ k, v ]
1788 1789
          elsif respond_to?("#{k}=")
            send("#{k}=", v)
1790
          else
1791
            raise(UnknownAttributeError, "unknown attribute: #{k}")
1792
          end
D
Initial  
David Heinemeier Hansson 已提交
1793
        end
D
David Heinemeier Hansson 已提交
1794

1795
        @mass_assignment_options = nil
D
Initial  
David Heinemeier Hansson 已提交
1796 1797 1798
        assign_multiparameter_attributes(multi_parameter_attributes)
      end

1799
      # Returns a hash of all the attributes with their names as keys and the values of the attributes as values.
1800
      def attributes
1801
        Hash[@attributes.map { |name, _| [name, read_attribute(name)] }]
1802 1803
      end

P
Pratik Naik 已提交
1804
      # Returns an <tt>#inspect</tt>-like string for the value of the
V
Vijay Dev 已提交
1805
      # attribute +attr_name+. String attributes are truncated upto 50
P
Pratik Naik 已提交
1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816
      # 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"'
1817 1818 1819
      def attribute_for_inspect(attr_name)
        value = read_attribute(attr_name)

1820
        if value.is_a?(String) && value.length > 50
1821
          "#{value[0..50]}...".inspect
1822 1823
        elsif value.is_a?(Date) || value.is_a?(Time)
          %("#{value.to_s(:db)}")
1824 1825 1826 1827 1828
        else
          value.inspect
        end
      end

D
Initial  
David Heinemeier Hansson 已提交
1829
      # Returns true if the specified +attribute+ has been set by the user or by a database load and is neither
1830
      # nil nor empty? (the latter only applies to objects that respond to empty?, most notably Strings).
D
Initial  
David Heinemeier Hansson 已提交
1831
      def attribute_present?(attribute)
1832
        value = read_attribute(attribute)
1833
        !value.nil? || (value.respond_to?(:empty?) && !value.empty?)
D
Initial  
David Heinemeier Hansson 已提交
1834 1835 1836 1837
      end

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

1841
      # Returns true if +comparison_object+ is the same exact object, or +comparison_object+
X
Xavier Noria 已提交
1842 1843 1844 1845 1846 1847 1848 1849
      # 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 已提交
1850
      def ==(comparison_object)
1851
        super ||
1852 1853 1854
          comparison_object.instance_of?(self.class) &&
          id.present? &&
          comparison_object.id == id
D
Initial  
David Heinemeier Hansson 已提交
1855
      end
1856
      alias :eql? :==
1857

D
Initial  
David Heinemeier Hansson 已提交
1858 1859 1860
      # 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
1861
        id.hash
D
Initial  
David Heinemeier Hansson 已提交
1862 1863
      end

1864
      # Freeze the attributes hash such that associations are still accessible, even on destroyed records.
1865
      def freeze
1866
        @attributes.freeze; self
1867
      end
1868

1869
      # Returns +true+ if the attributes hash has been frozen.
1870 1871 1872
      def frozen?
        @attributes.frozen?
      end
1873

1874 1875
      # Allows sort on objects
      def <=>(other_object)
1876 1877 1878 1879 1880
        if other_object.is_a?(self.class)
          self.to_key <=> other_object.to_key
        else
          nil
        end
1881 1882
      end

A
Aaron Patterson 已提交
1883 1884 1885 1886 1887 1888 1889 1890 1891
      # 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 已提交
1892
      # Duped objects have no id assigned and are treated as new records. Note
A
Aaron Patterson 已提交
1893 1894
      # 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 已提交
1895 1896
      # specific and is therefore left to the application to implement according
      # to its need.
1897
      # The dup method does not preserve the timestamps (created|updated)_(at|on).
A
Aaron Patterson 已提交
1898
      def initialize_dup(other)
A
Aaron Patterson 已提交
1899 1900 1901
        cloned_attributes = other.clone_attributes(:read_attribute_before_type_cast)
        cloned_attributes.delete(self.class.primary_key)

A
Aaron Patterson 已提交
1902 1903
        @attributes = cloned_attributes

A
Aaron Patterson 已提交
1904 1905
        _run_after_initialize_callbacks if respond_to?(:_run_after_initialize_callbacks)

A
Aaron Patterson 已提交
1906 1907 1908 1909
        @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 已提交
1910

1911
        @aggregation_cache = {}
1912 1913
        @association_cache = {}
        @attributes_cache = {}
1914
        @new_record  = true
A
Aaron Patterson 已提交
1915

A
Aaron Patterson 已提交
1916 1917
        ensure_proper_type
        populate_with_current_scope_attributes
1918
        super
1919 1920
      end

1921 1922
      # 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.
1923
      def readonly?
1924
        @readonly
1925 1926
      end

1927 1928
      # Marks this record as read only.
      def readonly!
1929 1930
        @readonly = true
      end
1931

1932
      # Returns the contents of the record as a nicely formatted string.
1933
      def inspect
1934 1935 1936 1937 1938 1939 1940 1941 1942 1943
        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}>"
1944
      end
1945

1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965
      # Hackery to accomodate Syck. Remove for 4.0.
      def to_yaml(opts = {}) #:nodoc:
        if YAML.const_defined?(:ENGINE) && !YAML::ENGINE.syck?
          super
        else
          coder = {}
          encode_with(coder)
          YAML.quick_emit(self, opts) do |out|
            out.map(taguri, to_yaml_style) do |map|
              coder.each { |k, v| map.add(k, v) }
            end
          end
        end
      end

      # Hackery to accomodate Syck. Remove for 4.0.
      def yaml_initialize(tag, coder) #:nodoc:
        init_with(coder)
      end

1966 1967
    protected
      def clone_attributes(reader_method = :read_attribute, attributes = {})
1968 1969
        attribute_names.each do |name|
          attributes[name] = clone_attribute_value(reader_method, name)
1970
        end
1971
        attributes
1972 1973 1974 1975 1976 1977 1978 1979 1980
      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

1981 1982 1983 1984 1985 1986 1987 1988
      def mass_assignment_options
        @mass_assignment_options ||= {}
      end

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

D
Initial  
David Heinemeier Hansson 已提交
1989 1990
    private

1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002
      # 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

2003
      # Sets the attribute used for single table inheritance to this class name if this is not the
2004
      # ActiveRecord::Base descendant.
2005 2006
      # 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.
2007
      # No such attribute would be set for objects of the Message class in that example.
D
Initial  
David Heinemeier Hansson 已提交
2008
      def ensure_proper_type
2009 2010 2011
        klass = self.class
        if klass.finder_needs_type_condition?
          write_attribute(klass.inheritance_column, klass.sti_name)
D
Initial  
David Heinemeier Hansson 已提交
2012 2013 2014
        end
      end

2015
      # The primary key and inheritance column can never be set by mass-assignment for security reasons.
2016
      def self.attributes_protected_by_default
2017 2018
        default = [ primary_key, inheritance_column ]
        default << 'id' unless primary_key.eql? 'id'
2019
        default
2020 2021
      end

2022 2023
      # Returns a copy of the attributes hash where all the values have been safely quoted for use in
      # an Arel insert/update method.
2024
      def arel_attributes_values(include_primary_key = true, include_readonly_attributes = true, attribute_names = @attributes.keys)
2025 2026 2027 2028
        attrs      = {}
        klass      = self.class
        arel_table = klass.arel_table

2029 2030 2031
        attribute_names.each do |name|
          if (column = column_for_attribute(name)) && (include_primary_key || !column.primary)

2032
            if include_readonly_attributes || !self.class.readonly_attributes.include?(name)
2033

J
Jon Leighton 已提交
2034 2035
              value = if klass.serialized_attributes.include?(name)
                        @attributes[name].serialized_value
2036 2037 2038 2039 2040 2041 2042 2043
                      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
2044 2045 2046
            end
          end
        end
2047

2048 2049 2050
        attrs
      end

D
Initial  
David Heinemeier Hansson 已提交
2051
      # Quote strings appropriately for SQL statements.
2052
      def quote_value(value, column = nil)
2053
        self.class.connection.quote(value, column)
D
Initial  
David Heinemeier Hansson 已提交
2054 2055 2056 2057 2058 2059
      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
2060 2061
      # 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
2062
      # attribute will be set to nil.
D
Initial  
David Heinemeier Hansson 已提交
2063 2064 2065 2066 2067
      def assign_multiparameter_attributes(pairs)
        execute_callstack_for_multiparameter_attributes(
          extract_callstack_for_multiparameter_attributes(pairs)
        )
      end
2068

2069
      def instantiate_time_object(name, values)
2070
        if self.class.send(:create_time_zone_conversion_attribute?, name, column_for_attribute(name))
2071
          Time.zone.local(*values)
2072
        else
2073
          Time.time_with_datetime_fallback(@@default_timezone, *values)
2074
        end
2075 2076
      end

D
Initial  
David Heinemeier Hansson 已提交
2077
      def execute_callstack_for_multiparameter_attributes(callstack)
2078
        errors = []
2079
        callstack.each do |name, values_with_empty_parameters|
2080
          begin
2081
            send(name + "=", read_value_from_parameter(name, values_with_empty_parameters))
2082
          rescue => ex
2083
            errors << AttributeAssignmentError.new("error on assignment #{values_with_empty_parameters.values.inspect} to #{name}", ex, name)
D
Initial  
David Heinemeier Hansson 已提交
2084 2085
          end
        end
2086 2087 2088
        unless errors.empty?
          raise MultiparameterAssignmentErrors.new(errors), "#{errors.size} error(s) on assignment of multiparameter attributes"
        end
D
Initial  
David Heinemeier Hansson 已提交
2089
      end
2090

2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107
      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)
2108 2109 2110
        # If Date bits were provided but blank, then return nil
        return nil if (1..3).any? {|position| values_hash_from_param[position].blank?}

2111 2112
        set_values = (1..max_position).collect{|position| values_hash_from_param[position] }
        # If Time bits are not there, then default to 0
2113
        (3..5).each {|i| set_values[i] = set_values[i].blank? ? 0 : set_values[i]}
2114 2115 2116 2117
        instantiate_time_object(name, set_values)
      end

      def read_date_parameter_value(name, values_hash_from_param)
2118 2119
        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]]
2120 2121
        begin
          Date.new(*set_values)
2122
        rescue ArgumentError # if Date.new raises an exception on an invalid date
2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139
          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 已提交
2140 2141 2142
      def extract_callstack_for_multiparameter_attributes(pairs)
        attributes = { }

2143
        pairs.each do |pair|
D
Initial  
David Heinemeier Hansson 已提交
2144 2145
          multiparameter_name, value = pair
          attribute_name = multiparameter_name.split("(").first
2146
          attributes[attribute_name] = {} unless attributes.include?(attribute_name)
D
Initial  
David Heinemeier Hansson 已提交
2147

2148
          parameter_value = value.empty? ? nil : type_cast_attribute_value(multiparameter_name, value)
2149
          attributes[attribute_name][find_parameter_position(multiparameter_name)] ||= parameter_value
D
Initial  
David Heinemeier Hansson 已提交
2150 2151
        end

2152
        attributes
D
Initial  
David Heinemeier Hansson 已提交
2153
      end
2154

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

D
Initial  
David Heinemeier Hansson 已提交
2159
      def find_parameter_position(multiparameter_name)
2160
        multiparameter_name.scan(/\(([0-9]*).*\)/).first.first.to_i
D
Initial  
David Heinemeier Hansson 已提交
2161
      end
2162

D
Initial  
David Heinemeier Hansson 已提交
2163 2164
      # Returns a comma-separated pair list, like "key1 = val1, key2 = val2".
      def comma_pair_list(hash)
2165
        hash.map { |k,v| "#{k} = #{v}" }.join(", ")
D
Initial  
David Heinemeier Hansson 已提交
2166 2167
      end

2168
      def quote_columns(quoter, hash)
2169
        Hash[hash.map { |name, value| [quoter.quote_column_name(name), value] }]
D
Initial  
David Heinemeier Hansson 已提交
2170 2171
      end

2172 2173
      def quoted_comma_pair_list(quoter, hash)
        comma_pair_list(quote_columns(quoter, hash))
D
Initial  
David Heinemeier Hansson 已提交
2174 2175
      end

2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187
      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

2188
      def populate_with_current_scope_attributes
2189 2190
        return unless self.class.scope_attributes?

2191
        self.class.scope_attributes.each do |att,value|
2192
          send("#{att}=", value) if respond_to?("#{att}=")
2193 2194
        end
      end
J
Joshua Peek 已提交
2195

2196
    include ActiveRecord::Persistence
J
Joshua Peek 已提交
2197
    extend ActiveModel::Naming
J
Joshua Peek 已提交
2198
    extend QueryCache::ClassMethods
J
José Valim 已提交
2199
    extend ActiveSupport::Benchmarkable
2200
    extend ActiveSupport::DescendantsTracker
J
José Valim 已提交
2201

2202
    include ActiveModel::Conversion
J
Joshua Peek 已提交
2203
    include Validations
2204
    extend CounterCache
J
Joshua Peek 已提交
2205 2206
    include Locking::Optimistic, Locking::Pessimistic
    include AttributeMethods
J
Joshua Peek 已提交
2207
    include AttributeMethods::Read, AttributeMethods::Write, AttributeMethods::BeforeTypeCast, AttributeMethods::Query
2208
    include AttributeMethods::PrimaryKey
J
Joshua Peek 已提交
2209 2210
    include AttributeMethods::TimeZoneConversion
    include AttributeMethods::Dirty
2211
    include AttributeMethods::Serialization
2212
    include AttributeMethods::DeprecatedUnderscoreRead
2213
    include ActiveModel::MassAssignmentSecurity
2214
    include Callbacks, ActiveModel::Observing, Timestamp
J
Jon Leighton 已提交
2215
    include Associations, NamedScope
M
Marcin Raczkowski 已提交
2216
    include IdentityMap
2217
    include ActiveModel::SecurePassword
2218
    extend Explain
2219 2220 2221 2222

    # AutosaveAssociation needs to be included before Transactions, because we want
    # #save_with_autosave_associations to be wrapped inside a transaction.
    include AutosaveAssociation, NestedAttributes
2223
    include Aggregations, Transactions, Reflection, Serialization, Store
2224

2225 2226 2227 2228 2229 2230 2231 2232 2233 2234
    # 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 已提交
2235
  end
2236
end
2237

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