base.rb 98.2 KB
Newer Older
D
Initial  
David Heinemeier Hansson 已提交
1
require 'yaml'
2
require 'set'
J
José Valim 已提交
3
require 'active_support/benchmarkable'
J
Jeremy Kemper 已提交
4
require 'active_support/dependencies'
5
require 'active_support/time'
6
require 'active_support/core_ext/class/attribute'
J
Jeremy Kemper 已提交
7 8 9 10 11 12 13 14
require 'active_support/core_ext/class/attribute_accessors'
require 'active_support/core_ext/class/delegating_attributes'
require 'active_support/core_ext/class/inheritable_attributes'
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'
15
require 'active_support/core_ext/kernel/singleton_class'
16
require 'active_support/core_ext/module/delegation'
17
require 'active_support/core_ext/object/duplicable'
18
require 'active_support/core_ext/object/blank'
19 20
require 'arel'
require 'active_record/errors'
D
Initial  
David Heinemeier Hansson 已提交
21 22

module ActiveRecord #:nodoc:
23
  # Active Record objects don't specify their attributes directly, but rather infer them from the table definition with
D
Initial  
David Heinemeier Hansson 已提交
24 25
  # 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 Active Record objects. The mapping that binds a given Active Record class to a certain
26 27
  # database table will happen automatically in most common cases, but can be overwritten for the uncommon ones.
  #
D
Initial  
David Heinemeier Hansson 已提交
28
  # See the mapping rules in table_name and the full example in link:files/README.html for more insight.
29
  #
D
Initial  
David Heinemeier Hansson 已提交
30
  # == Creation
31
  #
32
  # Active Records accept constructor parameters either in a hash or as a block. The hash method is especially useful when
33
  # you're receiving the data from somewhere else, like an HTTP request. It works like this:
34
  #
35
  #   user = User.new(:name => "David", :occupation => "Code Artist")
D
Initial  
David Heinemeier Hansson 已提交
36
  #   user.name # => "David"
37
  #
D
Initial  
David Heinemeier Hansson 已提交
38
  # You can also use block initialization:
39
  #
D
Initial  
David Heinemeier Hansson 已提交
40 41 42 43
  #   user = User.new do |u|
  #     u.name = "David"
  #     u.occupation = "Code Artist"
  #   end
44
  #
D
Initial  
David Heinemeier Hansson 已提交
45
  # And of course you can just create a bare object and specify the attributes after the fact:
46
  #
D
Initial  
David Heinemeier Hansson 已提交
47 48 49
  #   user = User.new
  #   user.name = "David"
  #   user.occupation = "Code Artist"
50
  #
D
Initial  
David Heinemeier Hansson 已提交
51
  # == Conditions
52
  #
53
  # Conditions can either be specified as a string, array, or hash representing the WHERE-part of an SQL statement.
D
Initial  
David Heinemeier Hansson 已提交
54
  # The array form is to be used when the condition input is tainted and requires sanitization. The string form can
55
  # be used for statements that don't involve tainted data. The hash form works much like the array form, except
56
  # only equality and range is possible. Examples:
57
  #
58
  #   class User < ActiveRecord::Base
D
Initial  
David Heinemeier Hansson 已提交
59
  #     def self.authenticate_unsafely(user_name, password)
60
  #       where("user_name = '#{user_name}' AND password = '#{password}'").first
D
Initial  
David Heinemeier Hansson 已提交
61
  #     end
62
  #
D
Initial  
David Heinemeier Hansson 已提交
63
  #     def self.authenticate_safely(user_name, password)
64
  #       where("user_name = ? AND password = ?", user_name, password).first
D
Initial  
David Heinemeier Hansson 已提交
65
  #     end
66 67
  #
  #     def self.authenticate_safely_simply(user_name, password)
68
  #       where(:user_name => user_name, :password => password).first
69
  #     end
D
Initial  
David Heinemeier Hansson 已提交
70
  #   end
71
  #
72
  # The <tt>authenticate_unsafely</tt> method inserts the parameters directly into the query and is thus susceptible to SQL-injection
73
  # attacks if the <tt>user_name</tt> and +password+ parameters come directly from an HTTP request. The <tt>authenticate_safely</tt>  and
74
  # <tt>authenticate_safely_simply</tt> both will sanitize the <tt>user_name</tt> and +password+ before inserting them in the query,
75
  # which will ensure that an attacker can't escape the query and fake the login (or worse).
76
  #
77
  # When using multiple parameters in the conditions, it can easily become hard to read exactly what the fourth or fifth
78
  # question mark is supposed to represent. In those cases, you can resort to named bind variables instead. That's done by replacing
79 80
  # the question marks with symbols and supplying a hash with values for the matching symbol keys:
  #
81
  #   Company.where(
82
  #     "id = :id AND name = :name AND division = :division AND created_at > :accounting_date",
83
  #     { :id => 3, :name => "37signals", :division => "First", :accounting_date => '2005-01-01' }
84
  #   ).first
85
  #
86 87 88
  # Similarly, a simple hash without a statement will generate conditions based on equality with the SQL AND
  # operator. For instance:
  #
89 90
  #   Student.where(:first_name => "Harvey", :status => 1)
  #   Student.where(params[:student])
91
  #
92 93
  # A range may be used in the hash to use the SQL BETWEEN operator:
  #
94
  #   Student.where(:grade => 9..12)
95
  #
P
Pratik Naik 已提交
96 97
  # An array may be used in the hash to use the SQL IN operator:
  #
98
  #   Student.where(:grade => [9,11,12])
P
Pratik Naik 已提交
99
  #
P
Pratik Naik 已提交
100 101 102
  # When joining tables, nested hashes or keys written in the form 'table_name.column_name' can be used to qualify the table name of a
  # particular condition. For instance:
  #
103 104
  #   Student.joins(:schools).where(:schools => { :type => 'public' })
  #   Student.joins(:schools).where('schools.type' => 'public' )
P
Pratik Naik 已提交
105
  #
D
Initial  
David Heinemeier Hansson 已提交
106
  # == Overwriting default accessors
107
  #
108 109
  # 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
P
Pratik Naik 已提交
110
  # name as the attribute) and calling <tt>read_attribute(attr_name)</tt> and <tt>write_attribute(attr_name, value)</tt> to actually change things.
D
Initial  
David Heinemeier Hansson 已提交
111
  # Example:
112
  #
D
Initial  
David Heinemeier Hansson 已提交
113 114
  #   class Song < ActiveRecord::Base
  #     # Uses an integer of seconds to hold the length of the song
115
  #
D
Initial  
David Heinemeier Hansson 已提交
116
  #     def length=(minutes)
117
  #       write_attribute(:length, minutes.to_i * 60)
D
Initial  
David Heinemeier Hansson 已提交
118
  #     end
119
  #
D
Initial  
David Heinemeier Hansson 已提交
120
  #     def length
121
  #       read_attribute(:length) / 60
D
Initial  
David Heinemeier Hansson 已提交
122 123
  #     end
  #   end
124
  #
P
Pratik Naik 已提交
125 126
  # You can alternatively use <tt>self[:attribute]=(value)</tt> and <tt>self[:attribute]</tt> instead of <tt>write_attribute(:attribute, value)</tt> and
  # <tt>read_attribute(:attribute)</tt> as a shorter form.
127
  #
128 129 130 131
  # == 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.
132
  #
133 134 135 136 137 138 139 140 141
  # 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
  #
142
  # == Accessing attributes before they have been typecasted
143
  #
144
  # Sometimes you want to be able to read the raw attribute data without having the column-determined typecast run its course first.
P
Pratik Naik 已提交
145
  # That can be done by using the <tt><attribute>_before_type_cast</tt> accessors that all attributes have. For example, if your Account model
P
Pratik Naik 已提交
146
  # has a <tt>balance</tt> attribute, you can call <tt>account.balance_before_type_cast</tt> or <tt>account.id_before_type_cast</tt>.
147 148
  #
  # This is especially useful in validation situations where the user might supply a string for an integer field and you want to display
149
  # the original string back in an error message. Accessing the attribute normally would typecast the string to 0, which isn't what you
150 151
  # want.
  #
152 153
  # == Dynamic attribute-based finders
  #
154
  # Dynamic attribute-based finders are a cleaner way of getting (and/or creating) objects by simple queries without turning to SQL. They work by
D
David Heinemeier Hansson 已提交
155
  # appending the name of an attribute to <tt>find_by_</tt>, <tt>find_last_by_</tt>, or <tt>find_all_by_</tt>, so you get finders like <tt>Person.find_by_user_name</tt>,
P
Pratik Naik 已提交
156
  # <tt>Person.find_all_by_last_name</tt>, and <tt>Payment.find_by_transaction_id</tt>. So instead of writing
157 158
  # <tt>Person.where(:user_name => user_name).first</tt>, you just do <tt>Person.find_by_user_name(user_name)</tt>.
  # And instead of writing <tt>Person.where(:last_name => last_name).all</tt>, you just do <tt>Person.find_all_by_last_name(last_name)</tt>.
159
  #
160 161
  # It's also possible to use multiple attributes in the same find by separating them with "_and_", so you get finders like
  # <tt>Person.find_by_user_name_and_password</tt> or even <tt>Payment.find_by_purchaser_and_state_and_country</tt>. So instead of writing
162
  # <tt>Person.where(:user_name => user_name, :password => password).first</tt>, you just do
163
  # <tt>Person.find_by_user_name_and_password(user_name, password)</tt>.
164
  #
165 166 167 168
  # It's even possible to call these dynamic finder methods on relations and named scopes. For example :
  #
  #   Payment.order("created_on").find_all_by_amount(50)
  #   Payment.pending.find_last_by_amount(100)
169
  #
170
  # The same dynamic finder style can be used to create the object if it doesn't already exist. This dynamic finder is called with
171
  # <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. For example:
172 173 174
  #
  #   # No 'Summer' tag exists
  #   Tag.find_or_create_by_name("Summer") # equal to Tag.create(:name => "Summer")
175
  #
176 177 178
  #   # Now the 'Summer' tag does exist
  #   Tag.find_or_create_by_name("Summer") # equal to Tag.find_by_name("Summer")
  #
179 180 181
  #   # Now 'Bob' exist and is an 'admin'
  #   User.find_or_create_by_name('Bob', :age => 40) { |u| u.admin = true }
  #
P
Pratik Naik 已提交
182
  # Use the <tt>find_or_initialize_by_</tt> finder if you want to return a new record without saving it first. Protected attributes won't be set unless they are given in a block. For example:
183 184 185
  #
  #   # No 'Winter' tag exists
  #   winter = Tag.find_or_initialize_by_name("Winter")
186
  #   winter.new_record? # true
187
  #
188 189 190 191 192 193 194
  # To find by a subset of the attributes to be used for instantiating a new object, pass a hash instead of
  # a list of parameters. For example:
  #
  #   Tag.find_or_create_by_name(:name => "rails", :creator => current_user)
  #
  # That will either find an existing tag named "rails", or create a new one while setting the user that created it.
  #
195
  # == Saving arrays, hashes, and other non-mappable objects in text columns
196 197
  #
  # Active Record can serialize any object in text columns using YAML. To do so, you must specify this with a call to the class method +serialize+.
198
  # This makes it possible to store arrays, hashes, and other non-mappable objects without doing any additional work. Example:
199
  #
D
Initial  
David Heinemeier Hansson 已提交
200 201 202
  #   class User < ActiveRecord::Base
  #     serialize :preferences
  #   end
203
  #
204
  #   user = User.create(:preferences => { "background" => "black", "display" => large })
D
Initial  
David Heinemeier Hansson 已提交
205
  #   User.find(user.id).preferences # => { "background" => "black", "display" => large }
206
  #
207
  # You can also specify a class option as the second parameter that'll raise an exception if a serialized object is retrieved as a
P
Pratik Naik 已提交
208
  # descendant of a class not in the hierarchy. Example:
209
  #
D
Initial  
David Heinemeier Hansson 已提交
210
  #   class User < ActiveRecord::Base
211
  #     serialize :preferences, Hash
D
Initial  
David Heinemeier Hansson 已提交
212
  #   end
213
  #
214
  #   user = User.create(:preferences => %w( one two three ))
D
Initial  
David Heinemeier Hansson 已提交
215
  #   User.find(user.id).preferences    # raises SerializationTypeMismatch
216
  #
D
Initial  
David Heinemeier Hansson 已提交
217 218
  # == Single table inheritance
  #
219
  # Active Record allows inheritance by storing the name of the class in a column that by default is named "type" (can be changed
D
Initial  
David Heinemeier Hansson 已提交
220 221 222 223 224 225 226
  # by overwriting <tt>Base.inheritance_column</tt>). This means that an inheritance looking like this:
  #
  #   class Company < ActiveRecord::Base; end
  #   class Firm < Company; end
  #   class Client < Company; end
  #   class PriorityClient < Client; end
  #
P
Pratik Naik 已提交
227
  # When you do <tt>Firm.create(:name => "37signals")</tt>, this record will be saved in the companies table with type = "Firm". You can then
228
  # fetch this row again using <tt>Company.where(:name => '37signals').first</tt> and it will return a Firm object.
D
Initial  
David Heinemeier Hansson 已提交
229
  #
230 231 232
  # 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 for differentiating between them or reloading the right type with find.
  #
D
Initial  
David Heinemeier Hansson 已提交
233 234
  # Note, all the attributes for all the cases are kept in the same table. Read more:
  # http://www.martinfowler.com/eaaCatalog/singleTableInheritance.html
235
  #
D
Initial  
David Heinemeier Hansson 已提交
236 237 238
  # == Connection to multiple databases in different models
  #
  # Connections are usually created through ActiveRecord::Base.establish_connection and retrieved by ActiveRecord::Base.connection.
239
  # All classes inheriting from ActiveRecord::Base will use this connection. But you can also set a class-specific connection.
P
Pratik Naik 已提交
240 241
  # For example, if Course is an ActiveRecord::Base, but resides in a different database, you can just say <tt>Course.establish_connection</tt>
  # and Course and all of its subclasses will use this connection instead.
D
Initial  
David Heinemeier Hansson 已提交
242 243 244 245 246
  #
  # 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 will go up the class-hierarchy until a connection is found in the connection pool.
  #
  # == Exceptions
247
  #
P
Pratik Naik 已提交
248 249
  # * 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 已提交
250
  #   <tt>:adapter</tt> key.
P
Pratik Naik 已提交
251
  # * AdapterNotFound - The <tt>:adapter</tt> key used in <tt>establish_connection</tt> specified a non-existent adapter
252
  #   (or a bad spelling of an existing one).
P
Pratik Naik 已提交
253 254 255 256 257 258 259 260 261
  # * AssociationTypeMismatch - The object assigned to the association wasn't of the type specified in the association definition.
  # * SerializationTypeMismatch - The serialized object wasn't of the class specified as the second parameter.
  # * ConnectionNotEstablished+ - No connection has been established. Use <tt>establish_connection</tt> before querying.
  # * 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
  #   <tt>attributes=</tt> method. The +errors+ property of this exception contains an array of AttributeAssignmentError
262
  #   objects that should be inspected to determine which attributes triggered the errors.
P
Pratik Naik 已提交
263
  # * AttributeAssignmentError - An error occurred while doing a mass assignment through the <tt>attributes=</tt> method.
264
  #   You can inspect the +attribute+ property of the exception object to determine which attribute triggered the error.
265
  #
266
  # *Note*: The attributes listed are class-level attributes (accessible from both the class and instance level).
P
Pratik Naik 已提交
267
  # 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 已提交
268 269
  # instances in the current object space.
  class Base
E
Emilio Tagua 已提交
270
    ##
P
Pratik Naik 已提交
271
    # :singleton-method:
D
Initial  
David Heinemeier Hansson 已提交
272 273
    # 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 a class and instance level by calling +logger+.
274
    cattr_accessor :logger, :instance_writer => false
J
Jeremy Kemper 已提交
275

D
Initial  
David Heinemeier Hansson 已提交
276 277 278 279 280
    def self.inherited(child) #:nodoc:
      @@subclasses[self] ||= []
      @@subclasses[self] << child
      super
    end
J
Jeremy Kemper 已提交
281

D
David Heinemeier Hansson 已提交
282
    def self.reset_subclasses #:nodoc:
283
      nonreloadables = []
284
      subclasses.each do |klass|
285
        unless ActiveSupport::Dependencies.autoloaded? klass
286 287 288
          nonreloadables << klass
          next
        end
289 290 291
        klass.instance_variables.each { |var| klass.send(:remove_instance_variable, var) }
        klass.instance_methods(false).each { |m| klass.send :undef_method, m }
      end
292 293
      @@subclasses = {}
      nonreloadables.each { |klass| (@@subclasses[klass.superclass] ||= []) << klass }
294 295
    end

D
Initial  
David Heinemeier Hansson 已提交
296
    @@subclasses = {}
297

P
Pratik Naik 已提交
298 299
    ##
    # :singleton-method:
P
Pratik Naik 已提交
300 301 302 303
    # Contains the database configuration - as is typically stored in config/database.yml -
    # as a Hash.
    #
    # For example, the following database.yml...
E
Emilio Tagua 已提交
304
    #
P
Pratik Naik 已提交
305 306 307
    #   development:
    #     adapter: sqlite3
    #     database: db/development.sqlite3
E
Emilio Tagua 已提交
308
    #
P
Pratik Naik 已提交
309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324
    #   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'
    #      }
    #   }
325
    cattr_accessor :configurations, :instance_writer => false
326 327
    @@configurations = {}

P
Pratik Naik 已提交
328 329
    ##
    # :singleton-method:
330
    # Accessor for the prefix type that will be prepended to every primary key column name. The options are :table_name and
D
Initial  
David Heinemeier Hansson 已提交
331 332
    # :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 latter is specified, the Product class will look for "product_id" instead of "id". Remember
333
    # that this is a global setting for all Active Records.
334
    cattr_accessor :primary_key_prefix_type, :instance_writer => false
D
Initial  
David Heinemeier Hansson 已提交
335 336
    @@primary_key_prefix_type = nil

P
Pratik Naik 已提交
337 338
    ##
    # :singleton-method:
339
    # Accessor for the name of the prefix string to prepend to every table name. So if set to "basecamp_", all
340
    # table names will be named like "basecamp_projects", "basecamp_people", etc. This is a convenient way of creating a namespace
D
Initial  
David Heinemeier Hansson 已提交
341
    # for tables in a shared database. By default, the prefix is the empty string.
342 343 344
    #
    # 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 returns your chosen prefix.
345 346
    class_attribute :table_name_prefix, :instance_writer => false
    self.table_name_prefix = ""
D
Initial  
David Heinemeier Hansson 已提交
347

P
Pratik Naik 已提交
348 349
    ##
    # :singleton-method:
D
Initial  
David Heinemeier Hansson 已提交
350 351
    # 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.
352 353
    class_attribute :table_name_suffix, :instance_writer => false
    self.table_name_suffix = ""
D
Initial  
David Heinemeier Hansson 已提交
354

P
Pratik Naik 已提交
355 356
    ##
    # :singleton-method:
357
    # Indicates whether table names should be the pluralized versions of the corresponding class names.
P
Pratik Naik 已提交
358
    # 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 已提交
359
    # See table_name for the full rules on table/class naming. This is true, by default.
360
    cattr_accessor :pluralize_table_names, :instance_writer => false
D
Initial  
David Heinemeier Hansson 已提交
361 362
    @@pluralize_table_names = true

P
Pratik Naik 已提交
363 364
    ##
    # :singleton-method:
365 366
    # Determines whether to use Time.local (using :local) or Time.utc (using :utc) when pulling dates and times from the database.
    # This is set to :local by default.
367
    cattr_accessor :default_timezone, :instance_writer => false
368
    @@default_timezone = :local
369

P
Pratik Naik 已提交
370 371
    ##
    # :singleton-method:
372 373
    # Specifies the format to use when dumping the database schema with Rails'
    # Rakefile.  If :sql, the schema is dumped as (potentially database-
374
    # specific) SQL statements.  If :ruby, the schema is dumped as an
375 376 377
    # ActiveRecord::Schema file which can be loaded into any database that
    # supports migrations.  Use :ruby if you want to have different database
    # adapters for, e.g., your development and test environments.
378
    cattr_accessor :schema_format , :instance_writer => false
379
    @@schema_format = :ruby
380

P
Pratik Naik 已提交
381 382
    ##
    # :singleton-method:
383
    # Specify whether or not to use timestamps for migration versions
384 385 386
    cattr_accessor :timestamped_migrations , :instance_writer => false
    @@timestamped_migrations = true

387 388
    # Determine whether to store the full constant name including namespace when using STI
    superclass_delegating_accessor :store_full_sti_class
389
    self.store_full_sti_class = true
390

391 392 393 394
    # Stores the default scope for the class
    class_inheritable_accessor :default_scoping, :instance_writer => false
    self.default_scoping = []

D
Initial  
David Heinemeier Hansson 已提交
395
    class << self # Class methods
396 397
      def colorize_logging(*args)
        ActiveSupport::Deprecation.warn "ActiveRecord::Base.colorize_logging and " <<
398
          "config.active_record.colorize_logging are deprecated. Please use " <<
399
          "Rails::LogSubscriber.colorize_logging or config.colorize_logging instead", caller
400 401 402
      end
      alias :colorize_logging= :colorize_logging

403
      delegate :find, :first, :last, :all, :destroy, :destroy_all, :exists?, :delete, :delete_all, :update, :update_all, :to => :scoped
P
Pratik Naik 已提交
404
      delegate :find_each, :find_in_batches, :to => :scoped
405
      delegate :select, :group, :order, :limit, :joins, :where, :preload, :eager_load, :includes, :from, :lock, :readonly, :having, :to => :scoped
406
      delegate :count, :average, :minimum, :maximum, :sum, :calculate, :to => :scoped
407

P
Pratik Naik 已提交
408
      # Executes a custom SQL query against your database and returns all the results.  The results will
409
      # be returned as an array with columns requested encapsulated as attributes of the model you call
P
Pratik Naik 已提交
410 411
      # this method from.  If you call <tt>Product.find_by_sql</tt> then the results will be returned in
      # a Product object with the attributes you specified in the SQL query.
412
      #
413 414
      # 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
415 416
      # table.
      #
P
Pratik Naik 已提交
417
      # The +sql+ parameter is a full SQL query as a string.  It will be called as is, there will be
418 419
      # no database agnostic conversions performed.  This should be a last resort because using, for example,
      # MySQL specific terms will lock you to using that particular database engine or require you to
P
Pratik Naik 已提交
420
      # change your call if you switch engines.
421 422
      #
      # ==== Examples
P
Pratik Naik 已提交
423
      #   # A simple SQL query spanning multiple tables
424 425 426 427 428 429
      #   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]
      #   > [#<Post:0x36bff9c @attributes={"first_name"=>"The Cheap Man Buys Twice"}>, ...]
D
Initial  
David Heinemeier Hansson 已提交
430
      def find_by_sql(sql)
431
        connection.select_all(sanitize_sql(sql), "#{name} Load").collect! { |record| instantiate(record) }
D
Initial  
David Heinemeier Hansson 已提交
432
      end
433

434
      # Creates an object (or multiple objects) and saves it to the database, if validations pass.
435 436 437 438 439 440 441 442
      # The resulting object is returned whether the object was saved successfully to the database or not.
      #
      # The +attributes+ parameter can be either be a Hash or an Array of Hashes.  These Hashes describe the
      # attributes on the objects that are to be created.
      #
      # ==== Examples
      #   # Create a single new object
      #   User.create(:first_name => 'Jamie')
443
      #
444
      #   # Create an Array of new objects
P
Pratik Naik 已提交
445
      #   User.create([{ :first_name => 'Jamie' }, { :first_name => 'Jeremy' }])
446 447 448 449 450 451 452
      #
      #   # 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 已提交
453
      #   User.create([{ :first_name => 'Jamie' }, { :first_name => 'Jeremy' }]) do |u|
454
      #     u.is_admin = false
455
      #   end
456
      def create(attributes = nil, &block)
457
        if attributes.is_a?(Array)
458
          attributes.collect { |attr| create(attr, &block) }
459 460
        else
          object = new(attributes)
461
          yield(object) if block_given?
462 463 464
          object.save
          object
        end
D
Initial  
David Heinemeier Hansson 已提交
465 466 467
      end

      # Returns the result of an SQL statement that should only include a COUNT(*) in the SELECT part.
468
      # The use of this method should be restricted to complicated SQL queries that can't be executed
469 470
      # using the ActiveRecord::Calculations class methods.  Look into those before using this.
      #
P
Pratik Naik 已提交
471
      # ==== Parameters
472
      #
P
Pratik Naik 已提交
473
      # * +sql+ - An SQL statement which should return a count query from the database, see the example below.
474 475 476
      #
      # ==== Examples
      #
477
      #   Product.count_by_sql "SELECT COUNT(*) FROM sales s, customers c WHERE s.customer_id = c.id"
D
Initial  
David Heinemeier Hansson 已提交
478
      def count_by_sql(sql)
479
        sql = sanitize_conditions(sql)
480
        connection.select_value(sql, "#{name} Count").to_i
D
Initial  
David Heinemeier Hansson 已提交
481
      end
482

483 484 485
      # Resets one or more counter caches to their correct value using an SQL
      # count query.  This is useful when adding new counter caches, or if the
      # counter has been corrupted or modified directly by SQL.
486 487 488
      #
      # ==== Parameters
      #
489 490
      # * +id+ - The id of the object you wish to reset a counter on.
      # * +counters+ - One or more counter names to reset
491 492
      #
      # ==== Examples
493 494 495 496 497 498 499 500
      #
      #   # For Post with id #1 records reset the comments_count
      #   Post.reset_counters(1, :comments)
      def reset_counters(id, *counters)
        object = find(id)
        counters.each do |association|
          child_class = reflect_on_association(association).klass
          counter_name = child_class.reflect_on_association(self.name.downcase.to_sym).counter_cache_column
501 502 503 504 505

          connection.update("UPDATE #{quoted_table_name} SET #{connection.quote_column_name(counter_name)} = #{object.send(association).count} WHERE #{connection.quote_column_name(primary_key)} = #{quote_value(object.id)}", "#{name} UPDATE")
        end
      end

506 507 508 509 510 511
      # A generic "counter updater" implementation, intended primarily to be
      # used by increment_counter and decrement_counter, but which may also
      # be useful on its own. It simply does a direct SQL update for the record
      # with the given ID, altering the given hash of counters by the amount
      # given by the corresponding value:
      #
P
Pratik Naik 已提交
512
      # ==== Parameters
513
      #
514
      # * +id+ - The id of the object you wish to update a counter on or an Array of ids.
P
Pratik Naik 已提交
515 516
      # * +counters+ - An Array of Hashes containing the names of the fields
      #   to update as keys and the amount to update the field by as values.
517
      #
518
      # ==== Examples
519 520
      #
      #   # For the Post with id of 5, decrement the comment_count by 1, and
521
      #   # increment the action_count by 1
522
      #   Post.update_counters 5, :comment_count => -1, :action_count => 1
523
      #   # Executes the following SQL:
524 525 526 527
      #   # UPDATE posts
      #   #    SET comment_count = comment_count - 1,
      #   #        action_count = action_count + 1
      #   #  WHERE id = 5
528 529 530 531 532 533 534
      #
      #   # For the Posts with id of 10 and 15, increment the comment_count by 1
      #   Post.update_counters [10, 15], :comment_count => 1
      #   # Executes the following SQL:
      #   # UPDATE posts
      #   #    SET comment_count = comment_count + 1,
      #   #  WHERE id IN (10, 15)
535 536 537
      def update_counters(id, counters)
        updates = counters.inject([]) { |list, (counter_name, increment)|
          sign = increment < 0 ? "-" : "+"
538
          list << "#{connection.quote_column_name(counter_name)} = COALESCE(#{connection.quote_column_name(counter_name)}, 0) #{sign} #{increment.abs}"
539
        }.join(", ")
540 541 542 543 544 545 546 547 548

        if id.is_a?(Array)
          ids_list = id.map {|i| quote_value(i)}.join(', ')
          condition = "IN  (#{ids_list})"
        else
          condition = "= #{quote_value(id)}"
        end

        update_all(updates, "#{connection.quote_column_name(primary_key)} #{condition}")
549 550
      end

551 552
      # Increment a number field by one, usually representing a count.
      #
553 554
      # This is used for caching aggregate values, so that they don't need to be computed every time.
      # For example, a DiscussionBoard may cache post_count and comment_count otherwise every time the board is
555
      # shown it would have to run an SQL query to find how many posts and comments there are.
556
      #
P
Pratik Naik 已提交
557
      # ==== Parameters
558
      #
P
Pratik Naik 已提交
559 560
      # * +counter_name+ - The name of the field that should be incremented.
      # * +id+ - The id of the object that should be incremented.
561 562 563 564 565
      #
      # ==== Examples
      #
      #   # Increment the post_count column for the record with an id of 5
      #   DiscussionBoard.increment_counter(:post_count, 5)
D
Initial  
David Heinemeier Hansson 已提交
566
      def increment_counter(counter_name, id)
567
        update_counters(id, counter_name => 1)
D
Initial  
David Heinemeier Hansson 已提交
568 569
      end

570 571 572 573
      # Decrement a number field by one, usually representing a count.
      #
      # This works the same as increment_counter but reduces the column value by 1 instead of increasing it.
      #
P
Pratik Naik 已提交
574
      # ==== Parameters
575
      #
P
Pratik Naik 已提交
576 577
      # * +counter_name+ - The name of the field that should be decremented.
      # * +id+ - The id of the object that should be decremented.
578 579 580 581 582
      #
      # ==== Examples
      #
      #   # Decrement the post_count column for the record with an id of 5
      #   DiscussionBoard.decrement_counter(:post_count, 5)
D
Initial  
David Heinemeier Hansson 已提交
583
      def decrement_counter(counter_name, id)
584
        update_counters(id, counter_name => -1)
D
Initial  
David Heinemeier Hansson 已提交
585 586
      end

P
Pratik Naik 已提交
587 588 589 590 591 592 593 594 595
      # Attributes named in this macro are protected from mass-assignment,
      # such as <tt>new(attributes)</tt>,
      # <tt>update_attributes(attributes)</tt>, or
      # <tt>attributes=(attributes)</tt>.
      #
      # Mass-assignment to these attributes will simply be ignored, to assign
      # to them you can use direct writer methods. This is meant to protect
      # sensitive attributes from being overwritten by malicious users
      # tampering with URLs or forms.
D
Initial  
David Heinemeier Hansson 已提交
596 597 598 599 600 601 602 603 604 605 606 607
      #
      #   class Customer < ActiveRecord::Base
      #     attr_protected :credit_rating
      #   end
      #
      #   customer = Customer.new("name" => David, "credit_rating" => "Excellent")
      #   customer.credit_rating # => nil
      #   customer.attributes = { "description" => "Jolly fellow", "credit_rating" => "Superb" }
      #   customer.credit_rating # => nil
      #
      #   customer.credit_rating = "Average"
      #   customer.credit_rating # => "Average"
608
      #
P
Pratik Naik 已提交
609 610
      # To start from an all-closed default and enable attributes as needed,
      # have a look at +attr_accessible+.
P
Pratik Naik 已提交
611 612 613 614
      #
      # If the access logic of your application is richer you can use <tt>Hash#except</tt>
      # or <tt>Hash#slice</tt> to sanitize the hash of parameters before they are
      # passed to Active Record.
615
      #
P
Pratik Naik 已提交
616 617 618 619 620 621 622 623 624 625
      # For example, it could be the case that the list of protected attributes
      # for a given model depends on the role of the user:
      #
      #   # Assumes plan_id is not protected because it depends on the role.
      #   params[:account] = params[:account].except(:plan_id) unless admin?
      #   @account.update_attributes(params[:account])
      #
      # Note that +attr_protected+ is still applied to the received hash. Thus,
      # with this technique you can at most _extend_ the list of protected
      # attributes for a particular mass-assignment call.
D
Initial  
David Heinemeier Hansson 已提交
626
      def attr_protected(*attributes)
627
        write_inheritable_attribute(:attr_protected, Set.new(attributes.map {|a| a.to_s}) + (protected_attributes || []))
D
Initial  
David Heinemeier Hansson 已提交
628
      end
629

630
      # Returns an array of all the attributes that have been protected from mass-assignment.
D
Initial  
David Heinemeier Hansson 已提交
631
      def protected_attributes # :nodoc:
632
        read_inheritable_attribute(:attr_protected)
D
Initial  
David Heinemeier Hansson 已提交
633 634
      end

P
Pratik Naik 已提交
635 636 637 638
      # Specifies a white list of model attributes that can be set via
      # mass-assignment, such as <tt>new(attributes)</tt>,
      # <tt>update_attributes(attributes)</tt>, or
      # <tt>attributes=(attributes)</tt>
639
      #
P
Pratik Naik 已提交
640 641 642 643 644 645 646
      # This is the opposite of the +attr_protected+ macro: Mass-assignment
      # will only set attributes in this list, to assign to the rest of
      # attributes you can use direct writer methods. This is meant to protect
      # sensitive attributes from being overwritten by malicious users
      # tampering with URLs or forms. If you'd rather start from an all-open
      # default and restrict attributes as needed, have a look at
      # +attr_protected+.
647 648
      #
      #   class Customer < ActiveRecord::Base
649
      #     attr_accessible :name, :nickname
650 651
      #   end
      #
652 653 654 655
      #   customer = Customer.new(:name => "David", :nickname => "Dave", :credit_rating => "Excellent")
      #   customer.credit_rating # => nil
      #   customer.attributes = { :name => "Jolly fellow", :credit_rating => "Superb" }
      #   customer.credit_rating # => nil
656
      #
657 658
      #   customer.credit_rating = "Average"
      #   customer.credit_rating # => "Average"
P
Pratik Naik 已提交
659 660 661 662
      #
      # If the access logic of your application is richer you can use <tt>Hash#except</tt>
      # or <tt>Hash#slice</tt> to sanitize the hash of parameters before they are
      # passed to Active Record.
663
      #
P
Pratik Naik 已提交
664 665 666 667 668 669 670 671 672 673
      # For example, it could be the case that the list of accessible attributes
      # for a given model depends on the role of the user:
      #
      #   # Assumes plan_id is accessible because it depends on the role.
      #   params[:account] = params[:account].except(:plan_id) unless admin?
      #   @account.update_attributes(params[:account])
      #
      # Note that +attr_accessible+ is still applied to the received hash. Thus,
      # with this technique you can at most _narrow_ the list of accessible
      # attributes for a particular mass-assignment call.
D
Initial  
David Heinemeier Hansson 已提交
674
      def attr_accessible(*attributes)
675
        write_inheritable_attribute(:attr_accessible, Set.new(attributes.map(&:to_s)) + (accessible_attributes || []))
D
Initial  
David Heinemeier Hansson 已提交
676
      end
677

678
      # Returns an array of all the attributes that have been made accessible to mass-assignment.
D
Initial  
David Heinemeier Hansson 已提交
679
      def accessible_attributes # :nodoc:
680
        read_inheritable_attribute(:attr_accessible)
D
Initial  
David Heinemeier Hansson 已提交
681 682
      end

683 684
       # Attributes listed as readonly can be set for a new record, but will be ignored in database updates afterwards.
       def attr_readonly(*attributes)
685
         write_inheritable_attribute(:attr_readonly, Set.new(attributes.map(&:to_s)) + (readonly_attributes || []))
686 687 688 689
       end

       # Returns an array of all the attributes that have been specified as readonly.
       def readonly_attributes
690
         read_inheritable_attribute(:attr_readonly) || []
691
       end
D
David Heinemeier Hansson 已提交
692

693 694 695
      # If you have an attribute that needs to be saved to the database as an object, and retrieved as the same object,
      # then specify the name of that attribute using this method and it will be handled automatically.
      # The serialization is done through YAML. If +class_name+ is specified, the serialized object must be of that
P
Pratik Naik 已提交
696
      # class on retrieval or SerializationTypeMismatch will be raised.
D
David Heinemeier Hansson 已提交
697
      #
P
Pratik Naik 已提交
698
      # ==== Parameters
D
David Heinemeier Hansson 已提交
699
      #
P
Pratik Naik 已提交
700 701
      # * +attr_name+ - The field name that should be serialized.
      # * +class_name+ - Optional, class name that the object type should be equal to.
D
David Heinemeier Hansson 已提交
702 703 704 705 706 707
      #
      # ==== Example
      #   # Serialize a preferences attribute
      #   class User
      #     serialize :preferences
      #   end
D
Initial  
David Heinemeier Hansson 已提交
708
      def serialize(attr_name, class_name = Object)
709
        serialized_attributes[attr_name.to_s] = class_name
D
Initial  
David Heinemeier Hansson 已提交
710
      end
711

D
Initial  
David Heinemeier Hansson 已提交
712 713
      # Returns a hash of all the attributes that have been specified for serialization as keys and their class restriction as values.
      def serialized_attributes
714
        read_inheritable_attribute(:attr_serialized) or write_inheritable_attribute(:attr_serialized, {})
D
Initial  
David Heinemeier Hansson 已提交
715 716 717
      end

      # Guesses the table name (in forced lower-case) based on the name of the class in the inheritance hierarchy descending
P
Pratik Naik 已提交
718
      # directly from ActiveRecord::Base. So if the hierarchy looks like: Reply < Message < ActiveRecord::Base, then Message is used
719
      # to guess the table name even when called on Reply. The rules used to do the guess are handled by the Inflector class
720
      # in Active Support, which knows almost all common English inflections. You can add new inflections in config/initializers/inflections.rb.
D
Initial  
David Heinemeier Hansson 已提交
721
      #
722
      # Nested classes are given table names prefixed by the singular form of
P
Pratik Naik 已提交
723 724 725
      # the parent's table name. Enclosing modules are not considered.
      #
      # ==== Examples
726 727
      #
      #   class Invoice < ActiveRecord::Base; end;
728 729
      #   file                  class               table_name
      #   invoice.rb            Invoice             invoices
730 731 732 733 734 735 736 737
      #
      #   class Invoice < ActiveRecord::Base; class Lineitem < ActiveRecord::Base; end; end;
      #   file                  class               table_name
      #   invoice.rb            Invoice::Lineitem   invoice_lineitems
      #
      #   module Invoice; class Lineitem < ActiveRecord::Base; end; end;
      #   file                  class               table_name
      #   invoice/lineitem.rb   Invoice::Lineitem   lineitems
D
Initial  
David Heinemeier Hansson 已提交
738
      #
P
Pratik Naik 已提交
739 740
      # Additionally, the class-level +table_name_prefix+ is prepended and the
      # +table_name_suffix+ is appended.  So if you have "myapp_" as a prefix,
741 742 743 744 745
      # the table name guess for an Invoice class becomes "myapp_invoices".
      # Invoice::Lineitem becomes "myapp_invoice_lineitems".
      #
      # You can also overwrite this class method to allow for unguessable
      # links, such as a Mouse class with a link to a "mice" table. Example:
D
Initial  
David Heinemeier Hansson 已提交
746 747
      #
      #   class Mouse < ActiveRecord::Base
748
      #     set_table_name "mice"
D
Initial  
David Heinemeier Hansson 已提交
749
      #   end
750
      def table_name
751 752 753
        reset_table_name
      end

P
Pratik Naik 已提交
754 755 756 757
      def quoted_table_name
        @quoted_table_name ||= connection.quote_table_name(table_name)
      end

D
David Heinemeier Hansson 已提交
758
      def reset_table_name #:nodoc:
759 760 761 762 763 764 765 766 767 768 769 770 771
        base = base_class

        name =
          # STI subclasses always use their superclass' table.
          unless self == base
            base.table_name
          else
            # 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
              contained << '_'
            end
772
            name = "#{full_table_name_prefix}#{contained}#{undecorated_table_name(base.name)}#{table_name_suffix}"
773 774
          end

P
Pratik Naik 已提交
775
        @quoted_table_name = nil
D
David Heinemeier Hansson 已提交
776
        set_table_name(name)
777
        name
D
Initial  
David Heinemeier Hansson 已提交
778 779
      end

780
      def full_table_name_prefix #:nodoc:
781 782 783
        (parents.detect{ |p| p.respond_to?(:table_name_prefix) } || self).table_name_prefix
      end

784 785
      # Defines the column name for use with single table inheritance
      # -- can be set in subclasses like so: self.inheritance_column = "type_id"
D
Initial  
David Heinemeier Hansson 已提交
786
      def inheritance_column
787
        @inheritance_column ||= "type".freeze
D
Initial  
David Heinemeier Hansson 已提交
788 789
      end

790 791
      # Lazy-set the sequence name to the connection's default.  This method
      # is only ever called once since set_sequence_name overrides it.
D
David Heinemeier Hansson 已提交
792
      def sequence_name #:nodoc:
793 794 795
        reset_sequence_name
      end

D
David Heinemeier Hansson 已提交
796
      def reset_sequence_name #:nodoc:
797 798 799
        default = connection.default_sequence_name(table_name, primary_key)
        set_sequence_name(default)
        default
800 801
      end

802
      # Sets the table name to use to the given value, or (if the value
803
      # is nil or false) to the value returned by the given block.
804 805 806 807
      #
      #   class Project < ActiveRecord::Base
      #     set_table_name "project"
      #   end
808
      def set_table_name(value = nil, &block)
809 810 811 812 813 814
        define_attr_method :table_name, value, &block
      end
      alias :table_name= :set_table_name

      # Sets the name of the inheritance column to use to the given value,
      # or (if the value # is nil or false) to the value returned by the
815
      # given block.
816 817 818 819 820 821
      #
      #   class Project < ActiveRecord::Base
      #     set_inheritance_column do
      #       original_inheritance_column + "_id"
      #     end
      #   end
822
      def set_inheritance_column(value = nil, &block)
823 824 825 826
        define_attr_method :inheritance_column, value, &block
      end
      alias :inheritance_column= :set_inheritance_column

827 828
      # 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
829 830
      # given block. This is required for Oracle and is useful for any
      # database which relies on sequences for primary key generation.
831
      #
832 833 834 835 836
      # 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.
837 838 839 840
      #
      #   class Project < ActiveRecord::Base
      #     set_sequence_name "projectseq"   # default would have been "project_seq"
      #   end
841
      def set_sequence_name(value = nil, &block)
842 843 844 845
        define_attr_method :sequence_name, value, &block
      end
      alias :sequence_name= :set_sequence_name

D
Initial  
David Heinemeier Hansson 已提交
846 847 848
      # Turns the +table_name+ back into a class name following the reverse rules of +table_name+.
      def class_name(table_name = table_name) # :nodoc:
        # remove any prefix and/or suffix from the table name
849 850 851
        class_name = table_name[table_name_prefix.length..-(table_name_suffix.length + 1)].camelize
        class_name = class_name.singularize if pluralize_table_names
        class_name
D
Initial  
David Heinemeier Hansson 已提交
852 853
      end

854 855
      # Indicates whether the table associated with this class exists
      def table_exists?
856
        connection.table_exists?(table_name)
857 858
      end

D
Initial  
David Heinemeier Hansson 已提交
859 860
      # Returns an array of column objects for the table associated with this class.
      def columns
861
        unless defined?(@columns) && @columns
862
          @columns = connection.columns(table_name, "#{name} Columns")
863
          @columns.each { |column| column.primary = column.name == primary_key }
864 865
        end
        @columns
D
Initial  
David Heinemeier Hansson 已提交
866
      end
867

868
      # Returns a hash of column objects for the table associated with this class.
D
Initial  
David Heinemeier Hansson 已提交
869 870 871
      def columns_hash
        @columns_hash ||= columns.inject({}) { |hash, column| hash[column.name] = column; hash }
      end
872

D
David Heinemeier Hansson 已提交
873
      # Returns an array of column names as strings.
874
      def column_names
875
        @column_names ||= columns.map { |column| column.name }
876
      end
D
Initial  
David Heinemeier Hansson 已提交
877

878 879
      # 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 已提交
880
      def content_columns
881
        @content_columns ||= columns.reject { |c| c.primary || c.name =~ /(_id|_count)$/ || c.name == inheritance_column }
D
Initial  
David Heinemeier Hansson 已提交
882 883 884 885
      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
886
      # is available.
D
David Heinemeier Hansson 已提交
887
      def column_methods_hash #:nodoc:
888
        @dynamic_methods_hash ||= column_names.inject(Hash.new(false)) do |methods, attr|
889 890 891 892 893
          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 已提交
894 895 896
          methods
        end
      end
897

P
Pratik Naik 已提交
898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923
      # Resets all the cached information about columns, which will cause them
      # to be reloaded on the next request.
      #
      # The most common usage pattern for this method is probably in a migration,
      # when just after creating a table you want to populate it with some default
      # values, eg:
      #
      #  class CreateJobLevels < ActiveRecord::Migration
      #    def self.up
      #      create_table :job_levels do |t|
      #        t.integer :id
      #        t.string :name
      #
      #        t.timestamps
      #      end
      #
      #      JobLevel.reset_column_information
      #      %w{assistant executive manager director}.each do |type|
      #        JobLevel.create(:name => type)
      #      end
      #    end
      #
      #    def self.down
      #      drop_table :job_levels
      #    end
      #  end
924
      def reset_column_information
925
        undefine_attribute_methods
926
        @column_names = @columns = @columns_hash = @content_columns = @dynamic_methods_hash = @inheritance_column = nil
P
Pratik Naik 已提交
927
        @arel_engine = @unscoped = @arel_table = nil
928 929
      end

930
      def reset_column_information_and_inheritable_attributes_for_all_subclasses#:nodoc:
931 932
        subclasses.each { |klass| klass.reset_inheritable_attributes; klass.reset_column_information }
      end
D
Initial  
David Heinemeier Hansson 已提交
933

934 935
      # Set the lookup ancestors for ActiveModel.
      def lookup_ancestors #:nodoc:
936 937
        klass = self
        classes = [klass]
E
Emilio Tagua 已提交
938
        while klass != klass.base_class
939 940 941 942 943
          classes << klass = klass.superclass
        end
        classes
      rescue
        # OPTIMIZE this rescue is to fix this test: ./test/cases/reflection_test.rb:56:in `test_human_name_for_column'
P
Pratik Naik 已提交
944
        # Apparently the method base_class causes some trouble.
945 946 947 948
        # It now works for sure.
        [self]
      end

949 950 951
      # Set the i18n scope to overwrite ActiveModel.
      def i18n_scope #:nodoc:
        :activerecord
D
Initial  
David Heinemeier Hansson 已提交
952
      end
953

954 955 956 957 958 959 960
      # 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 已提交
961 962
      end

963 964 965 966 967
      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

968
      # Returns a string like 'Post id:integer, title:string, body:text'
969
      def inspect
970 971 972 973
        if self == Base
          super
        elsif abstract_class?
          "#{super}(abstract)"
974
        elsif table_exists?
975 976
          attr_list = columns.map { |c| "#{c.name}: #{c.type}" } * ', '
          "#{super}(#{attr_list})"
977 978
        else
          "#{super}(Table doesn't exist)"
979
        end
980 981
      end

982
      def quote_value(value, column = nil) #:nodoc:
983
        connection.quote(value,column)
984 985
      end

986
      # Used to sanitize objects before they're used in an SQL SELECT statement. Delegates to <tt>connection.quote</tt>.
987
      def sanitize(object) #:nodoc:
988
        connection.quote(object)
D
Initial  
David Heinemeier Hansson 已提交
989 990
      end

991 992 993
      # Overwrite the default class equality method to provide support for association proxies.
      def ===(object)
        object.is_a?(self)
994
      end
995

996 997 998 999 1000 1001 1002
      # 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.
      def base_class
        class_of_active_record_descendant(self)
      end

P
Pratik Naik 已提交
1003
      # Set this to true if this is an abstract class (see <tt>abstract_class?</tt>).
1004 1005 1006 1007 1008
      attr_accessor :abstract_class

      # Returns whether this class is a base AR class.  If A is a base class and
      # B descends from A, then B.base_class will return B.
      def abstract_class?
1009
        defined?(@abstract_class) && @abstract_class == true
1010 1011
      end

1012
      def respond_to?(method_id, include_private = false)
1013 1014
        if match = DynamicFinderMatch.match(method_id)
          return true if all_attributes_exists?(match.attribute_names)
1015 1016
        elsif match = DynamicScopeMatch.match(method_id)
          return true if all_attributes_exists?(match.attribute_names)
1017
        end
1018

1019 1020 1021
        super
      end

1022 1023 1024 1025
      def sti_name
        store_full_sti_class ? name : name.demodulize
      end

1026 1027 1028
      def unscoped
        @unscoped ||= Relation.new(self, arel_table)
        finder_needs_type_condition? ? @unscoped.where(type_condition) : @unscoped
1029 1030
      end

P
Pratik Naik 已提交
1031 1032
      def arel_table
        @arel_table ||= Arel::Table.new(table_name, :engine => arel_engine)
1033 1034
      end

1035 1036
      def arel_engine
        @arel_engine ||= begin
1037 1038 1039
          if self == ActiveRecord::Base
            Arel::Table.engine
          else
1040
            connection_handler.connection_pools[name] ? Arel::Sql::Engine.new(self) : superclass.arel_engine
1041 1042
          end
        end
1043 1044
      end

D
Initial  
David Heinemeier Hansson 已提交
1045
      private
1046 1047 1048
        # 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.
D
Initial  
David Heinemeier Hansson 已提交
1049
        def instantiate(record)
1050
          object = find_sti_class(record[inheritance_column]).allocate
1051

1052
          object.instance_variable_set(:'@attributes', record)
1053
          object.instance_variable_set(:'@attributes_cache', {})
A
Aaron Patterson 已提交
1054
          object.instance_variable_set(:@new_record, false)
1055 1056 1057
          object.instance_variable_set(:@readonly, false)
          object.instance_variable_set(:@destroyed, false)
          object.instance_variable_set(:@marked_for_destruction, false)
1058 1059
          object.instance_variable_set(:@previously_changed, {})
          object.instance_variable_set(:@changed_attributes, {})
1060

1061 1062
          object.send(:_run_find_callbacks)
          object.send(:_run_initialize_callbacks)
1063

1064
          object
D
Initial  
David Heinemeier Hansson 已提交
1065
        end
1066

1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082
        def find_sti_class(type_name)
          if type_name.blank? || !columns_hash.include?(inheritance_column)
            self
          else
            begin
              compute_type(type_name)
            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

1083
        def construct_finder_arel(options = {}, scope = nil)
1084
          relation = options.is_a?(Hash) ? unscoped.apply_finder_options(options) : unscoped.merge(options)
1085
          relation = scope.merge(relation) if scope
1086
          relation
1087 1088
        end

1089
        def type_condition
1090
          sti_column = arel_table[inheritance_column]
1091 1092
          condition = sti_column.eq(sti_name)
          subclasses.each{|subclass| condition = condition.or(sti_column.eq(subclass.sti_name)) }
1093

1094
          condition
D
Initial  
David Heinemeier Hansson 已提交
1095 1096 1097
        end

        # Guesses the table name, but does not decorate it with prefix and suffix information.
1098
        def undecorated_table_name(class_name = base_class.name)
1099 1100
          table_name = class_name.to_s.demodulize.underscore
          table_name = table_name.pluralize if pluralize_table_names
1101
          table_name
D
Initial  
David Heinemeier Hansson 已提交
1102 1103
        end

P
Pratik Naik 已提交
1104
        # Enables dynamic finders like <tt>find_by_user_name(user_name)</tt> and <tt>find_by_user_name_and_password(user_name, password)</tt>
P
Pratik Naik 已提交
1105 1106
        # that are turned into <tt>where(:user_name => user_name).first</tt> and <tt>where(:user_name => user_name, :password => :password).first</tt>
        # respectively. Also works for <tt>all</tt> by using <tt>find_all_by_amount(50)</tt> that is turned into <tt>where(:amount => 50).all</tt>.
1107
        #
P
Pratik Naik 已提交
1108 1109
        # It's even possible to use all the additional parameters to +find+. For example, the full interface for +find_all_by_amount+
        # is actually <tt>find_all_by_amount(amount, options)</tt>.
1110
        #
1111
        # Each dynamic finder, scope or initializer/creator is also defined in the class after it is first invoked, so that future
1112
        # attempts to use it do not run through method_missing.
1113
        def method_missing(method_id, *arguments, &block)
1114 1115
          if match = DynamicFinderMatch.match(method_id)
            attribute_names = match.attribute_names
1116
            super unless all_attributes_exists?(attribute_names)
1117
            if match.finder?
1118
              options = arguments.extract_options!
1119
              relation = options.any? ? construct_finder_arel(options, current_scoped_methods) : scoped
1120
              relation.send :find_by_attributes, match, attribute_names, *arguments
1121
            elsif match.instantiator?
1122
              scoped.send :find_or_instantiator_by_attributes, match, attribute_names, *arguments, &block
1123
            end
1124 1125 1126 1127
          elsif match = DynamicScopeMatch.match(method_id)
            attribute_names = match.attribute_names
            super unless all_attributes_exists?(attribute_names)
            if match.scope?
1128
              self.class_eval <<-METHOD, __FILE__, __LINE__ + 1
1129 1130 1131 1132 1133
                def self.#{method_id}(*args)                        # def self.scoped_by_user_name_and_password(*args)
                  options = args.extract_options!                   #   options = args.extract_options!
                  attributes = construct_attributes_from_arguments( #   attributes = construct_attributes_from_arguments(
                    [:#{attribute_names.join(',:')}], args          #     [:user_name, :password], args
                  )                                                 #   )
E
Emilio Tagua 已提交
1134
                                                                    #
1135 1136
                  scoped(:conditions => attributes)                 #   scoped(:conditions => attributes)
                end                                                 # end
1137
              METHOD
1138 1139
              send(method_id, *arguments)
            end
1140 1141 1142 1143
          else
            super
          end
        end
D
Initial  
David Heinemeier Hansson 已提交
1144

1145 1146 1147 1148 1149 1150
        def construct_attributes_from_arguments(attribute_names, arguments)
          attributes = {}
          attribute_names.each_with_index { |name, idx| attributes[name] = arguments[idx] }
          attributes
        end

1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165
        # Similar in purpose to +expand_hash_conditions_for_aggregates+.
        def expand_attribute_names_for_aggregates(attribute_names)
          expanded_attribute_names = []
          attribute_names.each do |attribute_name|
            unless (aggregation = reflect_on_aggregation(attribute_name.to_sym)).nil?
              aggregate_mapping(aggregation).each do |field_attr, aggregate_attr|
                expanded_attribute_names << field_attr
              end
            else
              expanded_attribute_names << attribute_name
            end
          end
          expanded_attribute_names
        end

1166
        def all_attributes_exists?(attribute_names)
1167
          attribute_names = expand_attribute_names_for_aggregates(attribute_names)
1168
          attribute_names.all? { |name| column_methods_hash.include?(name.to_sym) }
1169
        end
1170

1171
        def attribute_condition(quoted_column_name, argument)
1172
          case argument
1173 1174 1175 1176 1177 1178 1179 1180
            when nil   then "#{quoted_column_name} IS ?"
            when Array, ActiveRecord::Associations::AssociationCollection, ActiveRecord::NamedScope::Scope then "#{quoted_column_name} IN (?)"
            when Range then if argument.exclude_end?
                              "#{quoted_column_name} >= ? AND #{quoted_column_name} < ?"
                            else
                              "#{quoted_column_name} BETWEEN ? AND ?"
                            end
            else            "#{quoted_column_name} = ?"
1181 1182 1183
          end
        end

D
Initial  
David Heinemeier Hansson 已提交
1184
      protected
1185
        # Scope parameters to method calls within the block.  Takes a hash of method_name => parameters hash.
1186 1187
        # method_name may be <tt>:find</tt> or <tt>:create</tt>. <tt>:find</tt> parameter is <tt>Relation</tt> while
        # <tt>:create</tt> parameters are an attributes hash.
1188 1189 1190
        #
        #   class Article < ActiveRecord::Base
        #     def self.create_with_scope
1191
        #       with_scope(:find => where(:blog_id => 1), :create => { :blog_id => 1 }) do
1192 1193 1194 1195 1196 1197 1198
        #         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 已提交
1199
        # In nested scopings, all previous parameters are overwritten by the innermost rule, with the exception of
1200
        # <tt>where</tt>, <tt>includes</tt>, and <tt>joins</tt> operations in <tt>Relation</tt>, which are merged.
P
Pratik Naik 已提交
1201
        #
1202
        # <tt>joins</tt> operations are uniqued so multiple scopes can join in the same table without table aliasing
P
Pratik Naik 已提交
1203 1204
        # problems.  If you need to join multiple tables, but still want one of the tables to be uniqued, use the
        # array of strings format for your joins.
1205 1206 1207
        #
        #   class Article < ActiveRecord::Base
        #     def self.find_with_scope
1208 1209 1210
        #       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
1211
        #         end
1212 1213
        #         with_scope(:find => where(:author_id => 3)) do
        #           all # => SELECT * from articles WHERE blog_id = 1 AND author_id = 3 LIMIT 1
1214 1215 1216 1217 1218
        #         end
        #       end
        #     end
        #   end
        #
1219
        # You can ignore any previous scopings by using the <tt>with_exclusive_scope</tt> method.
1220 1221 1222
        #
        #   class Article < ActiveRecord::Base
        #     def self.find_with_exclusive_scope
1223 1224 1225
        #       with_scope(:find => where(:blog_id => 1).limit(1)) do
        #         with_exclusive_scope(:find => limit(10))
        #           all # => SELECT * from articles LIMIT 10
1226 1227 1228 1229
        #         end
        #       end
        #     end
        #   end
P
Pratik Naik 已提交
1230 1231 1232
        #
        # *Note*: the +:find+ scope also has effect on update and deletion methods,
        # like +update_all+ and +delete_all+.
1233 1234 1235
        def with_scope(method_scoping = {}, action = :merge, &block)
          method_scoping = method_scoping.method_scoping if method_scoping.respond_to?(:method_scoping)

1236 1237 1238 1239 1240 1241
          if method_scoping.is_a?(Hash)
            # Dup first and second level of hash (method and params).
            method_scoping = method_scoping.inject({}) do |hash, (method, params)|
              hash[method] = (params == true) ? params : params.dup
              hash
            end
1242

1243 1244 1245 1246
            method_scoping.assert_valid_keys([ :find, :create ])
            relation = construct_finder_arel(method_scoping[:find] || {})

            if current_scoped_methods && current_scoped_methods.create_with_value && method_scoping[:create]
1247
              scope_for_create = if action == :merge
1248 1249 1250
                current_scoped_methods.create_with_value.merge(method_scoping[:create])
              else
                method_scoping[:create]
1251
              end
1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262

              relation = relation.create_with(scope_for_create)
            else
              scope_for_create = method_scoping[:create]
              scope_for_create ||= current_scoped_methods.create_with_value if current_scoped_methods
              relation = relation.create_with(scope_for_create) if scope_for_create
            end

            method_scoping = relation
          end

1263
          method_scoping = current_scoped_methods.merge(method_scoping) if current_scoped_methods && action ==  :merge
1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277

          self.scoped_methods << method_scoping
          begin
            yield
          ensure
            self.scoped_methods.pop
          end
        end

        # Works like with_scope, but discards any nested properties.
        def with_exclusive_scope(method_scoping = {}, &block)
          with_scope(method_scoping, :overwrite, &block)
        end

1278
        # Returns a list of all subclasses of this class, meaning all descendants.
1279
        def subclasses
D
Initial  
David Heinemeier Hansson 已提交
1280
          @@subclasses[self] ||= []
1281
          @@subclasses[self] + @@subclasses[self].inject([]) {|list, subclass| list + subclass.subclasses }
D
Initial  
David Heinemeier Hansson 已提交
1282
        end
1283

1284 1285
        public :subclasses

1286
        # Sets the default options for the model. The format of the
1287
        # <tt>options</tt> argument is the same as in find.
1288 1289
        #
        #   class Person < ActiveRecord::Base
1290
        #     default_scope order('last_name, first_name')
1291 1292
        #   end
        def default_scope(options = {})
1293
          self.default_scoping << construct_finder_arel(options)
1294 1295
        end

1296
        def scoped_methods #:nodoc:
1297 1298
          key = :"#{self}_scoped_methods"
          Thread.current[key] = Thread.current[key].presence || self.default_scoping.dup
1299
        end
1300

D
David Heinemeier Hansson 已提交
1301
        def current_scoped_methods #:nodoc:
1302
          scoped_methods.last
1303
        end
1304

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

            candidates.each do |candidate|
              begin
                constant = candidate.constantize
                return constant if candidate == constant.to_s
              rescue NameError
              rescue ArgumentError
              end
1325
            end
1326 1327

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

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

P
Pratik Naik 已提交
1343
        # Returns the name of the class descending directly from Active Record in the inheritance hierarchy.
D
David Heinemeier Hansson 已提交
1344
        def class_name_of_active_record_descendant(klass) #:nodoc:
1345
          klass.base_class.name
1346 1347
        end

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

1356 1357
          case condition
            when Array; sanitize_sql_array(condition)
1358
            when Hash;  sanitize_sql_hash_for_conditions(condition, table_name)
1359 1360
            else        condition
          end
1361
        end
1362
        alias_method :sanitize_sql, :sanitize_sql_for_conditions
1363

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

1375 1376 1377 1378 1379
        def aggregate_mapping(reflection)
          mapping = reflection.options[:mapping] || [reflection.name, reflection.name]
          mapping.first.is_a?(Array) ? mapping : [mapping]
        end

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

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

1427 1428
          table = Arel::Table.new(self.table_name, :engine => arel_engine, :as => default_table_name)
          builder = PredicateBuilder.new(arel_engine)
1429
          builder.build_from_hash(attrs, table).map(&:to_sql).join(' AND ')
1430
        end
1431 1432 1433 1434 1435 1436
        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)
1437
          attrs.map do |attr, value|
1438 1439 1440
            "#{connection.quote_column_name(attr)} = #{quote_bound_value(value)}"
          end.join(', ')
        end
1441

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

1456 1457
        alias_method :sanitize_conditions, :sanitize_sql

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

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

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

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

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

          expanded
1491 1492
        end

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

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

D
David Heinemeier Hansson 已提交
1511
        def encode_quoted_value(value) #:nodoc:
1512
          quoted_value = connection.quote(value)
1513 1514
          quoted_value = "'#{quoted_value[1..-2].gsub(/\'/, "\\\\'")}'" if quoted_value.include?("\\\'") # (for ruby mode) "
          quoted_value
1515
        end
D
Initial  
David Heinemeier Hansson 已提交
1516 1517 1518 1519 1520
    end

    public
      # New objects can be instantiated as either empty (pass no construction parameter) or pre-set with
      # attributes but not yet saved (pass a hash with key names matching the associated table column names).
1521
      # In both instances, valid attribute keys are determined by the column names of the associated table --
D
Initial  
David Heinemeier Hansson 已提交
1522 1523
      # hence you can't have attributes that aren't part of the table columns.
      def initialize(attributes = nil)
1524
        @attributes = attributes_from_column_definition
1525
        @attributes_cache = {}
D
Initial  
David Heinemeier Hansson 已提交
1526
        @new_record = true
1527
        @readonly = false
1528 1529
        @destroyed = false
        @marked_for_destruction = false
1530 1531
        @previously_changed = {}
        @changed_attributes = {}
1532

D
Initial  
David Heinemeier Hansson 已提交
1533
        ensure_proper_type
P
Pratik Naik 已提交
1534 1535 1536 1537 1538

        if scope = self.class.send(:current_scoped_methods)
          create_with = scope.scope_for_create
          create_with.each { |att,value| self.send("#{att}=", value) } if create_with
        end
1539
        self.attributes = attributes unless attributes.nil?
P
Pratik Naik 已提交
1540

1541
        result = yield self if block_given?
1542
        _run_initialize_callbacks
1543
        result
D
Initial  
David Heinemeier Hansson 已提交
1544
      end
1545

1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560
      # Cloned objects have no id assigned and are treated as new records. Note that this is a "shallow" clone
      # as it copies the object's attributes only, not its associations. The extent of a "deep" clone is
      # application specific and is therefore left to the application to implement according to its need.
      def initialize_copy(other)
        # Think the assertion which fails if the after_initialize callback goes at the end of the method is wrong. The
        # deleted clone method called new which therefore called the after_initialize callback. It then went on to copy
        # over the attributes. But if it's copying the attributes afterwards then it hasn't finished initializing right?
        # For example in the test suite the topic model's after_initialize method sets the author_email_address to
        # test@test.com. I would have thought this would mean that all cloned models would have an author email address
        # of test@test.com. However the test_clone test method seems to test that this is not the case. As a result the
        # after_initialize callback has to be run *before* the copying of the atrributes rather than afterwards in order
        # for all tests to pass. This makes no sense to me.
        callback(:after_initialize) if respond_to_without_attributes?(:after_initialize)
        cloned_attributes = other.clone_attributes(:read_attribute_before_type_cast)
        cloned_attributes.delete(self.class.primary_key)
1561
        @attributes = cloned_attributes
1562 1563 1564 1565
        clear_aggregation_cache
        @attributes_cache = {}
        @new_record = true
        ensure_proper_type
1566 1567 1568 1569 1570

        if scope = self.class.send(:current_scoped_methods)
          create_with = scope.scope_for_create
          create_with.each { |att,value| self.send("#{att}=", value) } if create_with
        end
1571 1572
      end

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

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

1618
      def quoted_id #:nodoc:
1619
        quote_value(id, column_for_attribute(self.class.primary_key))
1620
      end
1621

1622
      # Returns true if this object hasn't been saved yet -- that is, a record for the object doesn't exist yet; otherwise, returns false.
1623
      def new_record?
1624
        @new_record
1625
      end
1626

1627 1628
      # Returns true if this object has been destroyed, otherwise returns false.
      def destroyed?
1629
        @destroyed
1630 1631
      end

1632 1633 1634 1635 1636
      # Returns if the record is persisted, i.e. it's not a new record and it was not destroyed.
      def persisted?
        !(new_record? || destroyed?)
      end

P
Pratik Naik 已提交
1637
      # :call-seq:
1638
      #   save(options)
1639
      #
P
Pratik Naik 已提交
1640 1641 1642 1643 1644
      # Saves the model.
      #
      # If the model is new a record gets created in the database, otherwise
      # the existing record gets updated.
      #
1645 1646 1647
      # By default, save always run validations. If any of them fail the action
      # is cancelled and +save+ returns +false+. However, if you supply
      # :validate => false, validations are bypassed altogether. See
E
Emilio Tagua 已提交
1648
      # ActiveRecord::Validations for more information.
P
Pratik Naik 已提交
1649 1650 1651 1652
      #
      # There's a series of callbacks associated with +save+. If any of the
      # <tt>before_*</tt> callbacks return +false+ the action is cancelled and
      # +save+ returns +false+. See ActiveRecord::Callbacks for further
E
Emilio Tagua 已提交
1653
      # details.
D
Initial  
David Heinemeier Hansson 已提交
1654 1655 1656
      def save
        create_or_update
      end
1657

P
Pratik Naik 已提交
1658 1659 1660 1661 1662 1663 1664
      # Saves the model.
      #
      # If the model is new a record gets created in the database, otherwise
      # the existing record gets updated.
      #
      # With <tt>save!</tt> validations always run. If any of them fail
      # ActiveRecord::RecordInvalid gets raised. See ActiveRecord::Validations
E
Emilio Tagua 已提交
1665
      # for more information.
P
Pratik Naik 已提交
1666 1667 1668 1669
      #
      # There's a series of callbacks associated with <tt>save!</tt>. If any of
      # the <tt>before_*</tt> callbacks return +false+ the action is cancelled
      # and <tt>save!</tt> raises ActiveRecord::RecordNotSaved. See
E
Emilio Tagua 已提交
1670
      # ActiveRecord::Callbacks for further details.
1671
      def save!
1672
        create_or_update || raise(RecordNotSaved)
1673
      end
1674

P
Pratik Naik 已提交
1675 1676 1677
      # Deletes the record in the database and freezes this instance to
      # reflect that no changes should be made (since they can't be
      # persisted). Returns the frozen instance.
1678
      #
P
Pratik Naik 已提交
1679 1680 1681 1682 1683 1684
      # The row is simply removed with a SQL +DELETE+ statement on the
      # record's primary key, and no callbacks are executed.
      #
      # To enforce the object's +before_destroy+ and +after_destroy+
      # callbacks, Observer methods, or any <tt>:dependent</tt> association
      # options, use <tt>#destroy</tt>.
1685
      def delete
1686
        self.class.delete(id) if persisted?
1687
        @destroyed = true
1688 1689 1690
        freeze
      end

D
Initial  
David Heinemeier Hansson 已提交
1691 1692 1693
      # Deletes the record in the database and freezes this instance to reflect that no changes should
      # be made (since they can't be persisted).
      def destroy
1694
        if persisted?
1695
          self.class.unscoped.where(self.class.arel_table[self.class.primary_key].eq(id)).delete_all
D
Initial  
David Heinemeier Hansson 已提交
1696 1697
        end

1698
        @destroyed = true
D
Initial  
David Heinemeier Hansson 已提交
1699 1700 1701
        freeze
      end

1702
      # Returns an instance of the specified +klass+ with the attributes of the current record. This is mostly useful in relation to
1703
      # single-table inheritance structures where you want a subclass to appear as the superclass. This can be used along with record
1704
      # identification in Action Pack to allow, say, <tt>Client < Company</tt> to do something like render <tt>:partial => @client.becomes(Company)</tt>
1705 1706 1707 1708 1709
      # to render that instance using the companies/company partial instead of clients/client.
      #
      # Note: The new instance will share a link to the same attributes as the original class. So any change to the attributes in either
      # instance will affect the other.
      def becomes(klass)
J
Jeremy Kemper 已提交
1710 1711 1712 1713
        became = klass.new
        became.instance_variable_set("@attributes", @attributes)
        became.instance_variable_set("@attributes_cache", @attributes_cache)
        became.instance_variable_set("@new_record", new_record?)
1714
        became.instance_variable_set("@destroyed", destroyed?)
J
Jeremy Kemper 已提交
1715
        became
1716 1717
      end

1718 1719 1720
      # Updates a single attribute and saves the record without going through the normal validation procedure.
      # This is especially useful for boolean flags on existing records. The regular +update_attribute+ method
      # in Base is replaced with this when the validations module is mixed in, which it is by default.
D
Initial  
David Heinemeier Hansson 已提交
1721
      def update_attribute(name, value)
1722
        send("#{name}=", value)
1723
        save(:validate => false)
1724 1725
      end

1726
      # Updates all the attributes from the passed-in Hash and saves the record. If the object is invalid, the saving will
1727
      # fail and false will be returned.
1728
      def update_attributes(attributes)
1729
        self.attributes = attributes
1730
        save
D
Initial  
David Heinemeier Hansson 已提交
1731
      end
1732

1733 1734 1735 1736 1737
      # Updates an object just like Base.update_attributes but calls save! instead of save so an exception is raised if the record is invalid.
      def update_attributes!(attributes)
        self.attributes = attributes
        save!
      end
D
Initial  
David Heinemeier Hansson 已提交
1738

P
Pratik Naik 已提交
1739 1740 1741
      # Initializes +attribute+ to zero if +nil+ and adds the value passed as +by+ (default is 1).
      # The increment is performed directly on the underlying attribute, no setter is invoked.
      # Only makes sense for number-based attributes. Returns +self+.
1742
      def increment(attribute, by = 1)
1743
        self[attribute] ||= 0
1744
        self[attribute] += by
1745 1746
        self
      end
1747

P
Pratik Naik 已提交
1748 1749 1750 1751
      # Wrapper around +increment+ that saves the record. This method differs from
      # its non-bang version in that it passes through the attribute setter.
      # Saving is not subjected to validation checks. Returns +true+ if the
      # record could be saved.
1752 1753
      def increment!(attribute, by = 1)
        increment(attribute, by).update_attribute(attribute, self[attribute])
1754 1755
      end

P
Pratik Naik 已提交
1756 1757 1758
      # Initializes +attribute+ to zero if +nil+ and subtracts the value passed as +by+ (default is 1).
      # The decrement is performed directly on the underlying attribute, no setter is invoked.
      # Only makes sense for number-based attributes. Returns +self+.
1759
      def decrement(attribute, by = 1)
1760
        self[attribute] ||= 0
1761
        self[attribute] -= by
1762 1763 1764
        self
      end

P
Pratik Naik 已提交
1765 1766 1767 1768
      # Wrapper around +decrement+ that saves the record. This method differs from
      # its non-bang version in that it passes through the attribute setter.
      # Saving is not subjected to validation checks. Returns +true+ if the
      # record could be saved.
1769 1770
      def decrement!(attribute, by = 1)
        decrement(attribute, by).update_attribute(attribute, self[attribute])
1771
      end
1772

P
Pratik Naik 已提交
1773 1774 1775 1776
      # Assigns to +attribute+ the boolean opposite of <tt>attribute?</tt>. So
      # if the predicate returns +true+ the attribute will become +false+. This
      # method toggles directly the underlying value without calling any setter.
      # Returns +self+.
1777
      def toggle(attribute)
1778
        self[attribute] = !send("#{attribute}?")
1779 1780 1781
        self
      end

P
Pratik Naik 已提交
1782 1783 1784 1785
      # Wrapper around +toggle+ that saves the record. This method differs from
      # its non-bang version in that it passes through the attribute setter.
      # Saving is not subjected to validation checks. Returns +true+ if the
      # record could be saved.
1786 1787 1788 1789
      def toggle!(attribute)
        toggle(attribute).update_attribute(attribute, self[attribute])
      end

1790
      # Reloads the attributes of this object from the database.
1791 1792 1793 1794
      # The optional options argument is passed to find when reloading so you
      # may do e.g. record.reload(:lock => true) to reload the same record with
      # an exclusive row lock.
      def reload(options = nil)
1795
        clear_aggregation_cache
1796
        clear_association_cache
1797
        @attributes.update(self.class.send(:with_exclusive_scope) { self.class.find(self.id, options) }.instance_variable_get('@attributes'))
1798
        @attributes_cache = {}
1799
        self
1800 1801
      end

1802 1803 1804 1805 1806 1807 1808 1809 1810 1811
      # Returns true if the given attribute is in the attributes hash
      def has_attribute?(attr_name)
        @attributes.has_key?(attr_name.to_s)
      end

      # Returns an array of names for the attributes available on this object sorted alphabetically.
      def attribute_names
        @attributes.keys.sort
      end

1812
      # Returns the value of the attribute identified by <tt>attr_name</tt> after it has been typecast (for example,
D
Initial  
David Heinemeier Hansson 已提交
1813 1814
      # "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).
1815
      def [](attr_name)
1816
        read_attribute(attr_name)
D
Initial  
David Heinemeier Hansson 已提交
1817
      end
1818

D
Initial  
David Heinemeier Hansson 已提交
1819 1820
      # Updates the attribute identified by <tt>attr_name</tt> with the specified +value+.
      # (Alias for the protected write_attribute method).
1821
      def []=(attr_name, value)
1822
        write_attribute(attr_name, value)
D
Initial  
David Heinemeier Hansson 已提交
1823 1824 1825
      end

      # Allows you to set all the attributes at once by passing in a hash with keys
P
Pratik Naik 已提交
1826 1827 1828 1829 1830 1831
      # matching the attribute names (which again matches the column names).
      #
      # If +guard_protected_attributes+ is true (the default), then sensitive
      # attributes can be protected from this form of mass-assignment by using
      # the +attr_protected+ macro. Or you can alternatively specify which
      # attributes *can* be accessed with the +attr_accessible+ macro. Then all the
1832
      # attributes not included in that won't be allowed to be mass-assigned.
P
Pratik Naik 已提交
1833 1834 1835 1836
      #
      #   class User < ActiveRecord::Base
      #     attr_protected :is_admin
      #   end
E
Emilio Tagua 已提交
1837
      #
P
Pratik Naik 已提交
1838 1839 1840 1841
      #   user = User.new
      #   user.attributes = { :username => 'Phusion', :is_admin => true }
      #   user.username   # => "Phusion"
      #   user.is_admin?  # => false
E
Emilio Tagua 已提交
1842
      #
P
Pratik Naik 已提交
1843 1844
      #   user.send(:attributes=, { :username => 'Phusion', :is_admin => true }, false)
      #   user.is_admin?  # => true
1845
      def attributes=(new_attributes, guard_protected_attributes = true)
D
David Heinemeier Hansson 已提交
1846
        return if new_attributes.nil?
1847
        attributes = new_attributes.stringify_keys
D
Initial  
David Heinemeier Hansson 已提交
1848 1849

        multi_parameter_attributes = []
1850
        attributes = remove_attributes_protected_from_mass_assignment(attributes) if guard_protected_attributes
1851

1852
        attributes.each do |k, v|
1853 1854 1855 1856 1857
          if k.include?("(")
            multi_parameter_attributes << [ k, v ]
          else
            respond_to?(:"#{k}=") ? send(:"#{k}=", v) : raise(UnknownAttributeError, "unknown attribute: #{k}")
          end
D
Initial  
David Heinemeier Hansson 已提交
1858
        end
D
David Heinemeier Hansson 已提交
1859

D
Initial  
David Heinemeier Hansson 已提交
1860 1861 1862
        assign_multiparameter_attributes(multi_parameter_attributes)
      end

1863
      # Returns a hash of all the attributes with their names as keys and the values of the attributes as values.
1864
      def attributes
1865 1866 1867
        attrs = {}
        attribute_names.each { |name| attrs[name] = read_attribute(name) }
        attrs
1868 1869
      end

P
Pratik Naik 已提交
1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882
      # Returns an <tt>#inspect</tt>-like string for the value of the
      # attribute +attr_name+. String attributes are elided after 50
      # characters, and Date and Time attributes are returned in the
      # <tt>:db</tt> format. Other attributes return the value of
      # <tt>#inspect</tt> without modification.
      #
      #   person = Person.create!(:name => "David Heinemeier Hansson " * 3)
      #
      #   person.attribute_for_inspect(:name)
      #   # => '"David Heinemeier Hansson David Heinemeier Hansson D..."'
      #
      #   person.attribute_for_inspect(:created_at)
      #   # => '"2009-01-12 04:48:57"'
1883 1884 1885
      def attribute_for_inspect(attr_name)
        value = read_attribute(attr_name)

1886
        if value.is_a?(String) && value.length > 50
1887
          "#{value[0..50]}...".inspect
1888 1889
        elsif value.is_a?(Date) || value.is_a?(Time)
          %("#{value.to_s(:db)}")
1890 1891 1892 1893 1894
        else
          value.inspect
        end
      end

D
Initial  
David Heinemeier Hansson 已提交
1895
      # Returns true if the specified +attribute+ has been set by the user or by a database load and is neither
1896
      # nil nor empty? (the latter only applies to objects that respond to empty?, most notably Strings).
D
Initial  
David Heinemeier Hansson 已提交
1897
      def attribute_present?(attribute)
1898
        value = read_attribute(attribute)
1899
        !value.blank?
D
Initial  
David Heinemeier Hansson 已提交
1900 1901 1902 1903
      end

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

1907
      # Returns true if the +comparison_object+ is the same object, or is of the same type and has the same id.
D
Initial  
David Heinemeier Hansson 已提交
1908
      def ==(comparison_object)
1909
        comparison_object.equal?(self) ||
1910
          (comparison_object.instance_of?(self.class) &&
1911
            comparison_object.id == id && !comparison_object.new_record?)
D
Initial  
David Heinemeier Hansson 已提交
1912 1913 1914 1915 1916 1917
      end

      # Delegates to ==
      def eql?(comparison_object)
        self == (comparison_object)
      end
1918

D
Initial  
David Heinemeier Hansson 已提交
1919 1920 1921
      # 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
1922
        id.hash
D
Initial  
David Heinemeier Hansson 已提交
1923 1924
      end

1925
      # Freeze the attributes hash such that associations are still accessible, even on destroyed records.
1926
      def freeze
1927
        @attributes.freeze; self
1928
      end
1929

1930
      # Returns +true+ if the attributes hash has been frozen.
1931 1932 1933
      def frozen?
        @attributes.frozen?
      end
1934

1935 1936 1937
      # Returns duplicated record with unfreezed attributes.
      def dup
        obj = super
1938
        obj.instance_variable_set('@attributes', @attributes.dup)
1939 1940 1941
        obj
      end

1942 1943
      # 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.
1944
      def readonly?
1945
        @readonly
1946 1947
      end

1948 1949
      # Marks this record as read only.
      def readonly!
1950 1951
        @readonly = true
      end
1952

1953
      # Returns the contents of the record as a nicely formatted string.
1954
      def inspect
1955
        attributes_as_nice_string = self.class.column_names.collect { |name|
1956 1957 1958 1959
          if has_attribute?(name) || new_record?
            "#{name}: #{attribute_for_inspect(name)}"
          end
        }.compact.join(", ")
1960
        "#<#{self.class} #{attributes_as_nice_string}>"
1961
      end
1962

1963 1964
    protected
      def clone_attributes(reader_method = :read_attribute, attributes = {})
1965 1966
        attribute_names.each do |name|
          attributes[name] = clone_attribute_value(reader_method, name)
1967
        end
1968
        attributes
1969 1970 1971 1972 1973 1974 1975 1976 1977
      end

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

D
Initial  
David Heinemeier Hansson 已提交
1978 1979
    private
      def create_or_update
1980
        raise ReadOnlyRecord if readonly?
1981 1982
        result = new_record? ? create : update
        result != false
D
Initial  
David Heinemeier Hansson 已提交
1983 1984
      end

1985
      # Updates the associated record with values matching those of the instance attributes.
1986
      # Returns the number of affected rows.
1987
      def update(attribute_names = @attributes.keys)
1988 1989
        attributes_with_values = arel_attributes_values(false, false, attribute_names)
        return 0 if attributes_with_values.empty?
1990
        self.class.unscoped.where(self.class.arel_table[self.class.primary_key].eq(id)).arel.update(attributes_with_values)
D
Initial  
David Heinemeier Hansson 已提交
1991 1992
      end

1993 1994
      # Creates a record with values matching those of the instance attributes
      # and returns its id.
D
Initial  
David Heinemeier Hansson 已提交
1995
      def create
1996
        if self.id.nil? && connection.prefetch_primary_key?(self.class.table_name)
1997 1998
          self.id = connection.next_sequence_value(self.class.sequence_name)
        end
1999

E
Emilio Tagua 已提交
2000 2001 2002
        attributes_values = arel_attributes_values

        new_id = if attributes_values.empty?
2003
          self.class.unscoped.insert connection.empty_insert_statement_value
2004
        else
2005
          self.class.unscoped.insert attributes_values
2006 2007
        end

2008
        self.id ||= new_id
2009

D
Initial  
David Heinemeier Hansson 已提交
2010
        @new_record = false
2011
        id
D
Initial  
David Heinemeier Hansson 已提交
2012 2013
      end

P
Pratik Naik 已提交
2014
      # Sets the attribute used for single table inheritance to this class name if this is not the ActiveRecord::Base descendant.
P
Pratik Naik 已提交
2015 2016
      # 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. No such attribute would be set for objects of the
D
Initial  
David Heinemeier Hansson 已提交
2017 2018 2019
      # Message class in that example.
      def ensure_proper_type
        unless self.class.descends_from_active_record?
2020
          write_attribute(self.class.inheritance_column, self.class.sti_name)
D
Initial  
David Heinemeier Hansson 已提交
2021 2022 2023 2024
        end
      end

      def remove_attributes_protected_from_mass_assignment(attributes)
2025 2026 2027 2028
        safe_attributes =
          if self.class.accessible_attributes.nil? && self.class.protected_attributes.nil?
            attributes.reject { |key, value| attributes_protected_by_default.include?(key.gsub(/\(.+/, "")) }
          elsif self.class.protected_attributes.nil?
2029
            attributes.reject { |key, value| !self.class.accessible_attributes.include?(key.gsub(/\(.+/, "")) || attributes_protected_by_default.include?(key.gsub(/\(.+/, "")) }
2030
          elsif self.class.accessible_attributes.nil?
2031
            attributes.reject { |key, value| self.class.protected_attributes.include?(key.gsub(/\(.+/,"")) || attributes_protected_by_default.include?(key.gsub(/\(.+/, "")) }
2032 2033 2034 2035 2036 2037 2038
          else
            raise "Declare either attr_protected or attr_accessible for #{self.class}, but not both."
          end

        removed_attributes = attributes.keys - safe_attributes.keys

        if removed_attributes.any?
2039
          log_protected_attribute_removal(removed_attributes)
D
Initial  
David Heinemeier Hansson 已提交
2040
        end
2041 2042

        safe_attributes
D
Initial  
David Heinemeier Hansson 已提交
2043
      end
2044

2045 2046 2047
      # Removes attributes which have been marked as readonly.
      def remove_readonly_attributes(attributes)
        unless self.class.readonly_attributes.nil?
2048
          attributes.delete_if { |key, value| self.class.readonly_attributes.include?(key.gsub(/\(.+/,"")) }
2049 2050 2051 2052
        else
          attributes
        end
      end
D
Initial  
David Heinemeier Hansson 已提交
2053

2054
      def log_protected_attribute_removal(*attributes)
2055 2056 2057
        if logger
          logger.debug "WARNING: Can't mass-assign these protected attributes: #{attributes.join(', ')}"
        end
2058 2059
      end

2060 2061
      # The primary key and inheritance column can never be set by mass-assignment for security reasons.
      def attributes_protected_by_default
2062 2063 2064
        default = [ self.class.primary_key, self.class.inheritance_column ]
        default << 'id' unless self.class.primary_key.eql? 'id'
        default
2065 2066
      end

2067 2068
      # Returns a copy of the attributes hash where all the values have been safely quoted for use in
      # an Arel insert/update method.
2069 2070 2071 2072 2073 2074
      def arel_attributes_values(include_primary_key = true, include_readonly_attributes = true, attribute_names = @attributes.keys)
        attrs = {}
        attribute_names.each do |name|
          if (column = column_for_attribute(name)) && (include_primary_key || !column.primary)

            if include_readonly_attributes || (!include_readonly_attributes && !self.class.readonly_attributes.include?(name))
2075 2076 2077
              value = read_attribute(name)

              if value && ((self.class.serialized_attributes.has_key?(name) && (value.acts_like?(:date) || value.acts_like?(:time))) || value.is_a?(Hash) || value.is_a?(Array))
2078 2079
                value = value.to_yaml
              end
2080
              attrs[self.class.arel_table[name]] = value
2081 2082 2083 2084 2085 2086
            end
          end
        end
        attrs
      end

D
Initial  
David Heinemeier Hansson 已提交
2087
      # Quote strings appropriately for SQL statements.
2088
      def quote_value(value, column = nil)
2089
        self.class.connection.quote(value, column)
D
Initial  
David Heinemeier Hansson 已提交
2090 2091
      end

P
Pratik Naik 已提交
2092
      # Interpolate custom SQL string in instance context.
D
Initial  
David Heinemeier Hansson 已提交
2093 2094
      # Optional record argument is meant for custom insert_sql.
      def interpolate_sql(sql, record = nil)
2095
        instance_eval("%@#{sql.gsub('@', '\@')}@")
D
Initial  
David Heinemeier Hansson 已提交
2096 2097 2098 2099 2100 2101 2102
      end

      # Initializes the attributes array with keys matching the columns from the linked table and
      # the values matching the corresponding default value of that column, so
      # that a new instance, or one populated from a passed-in Hash, still has all the attributes
      # that instances loaded from the database would.
      def attributes_from_column_definition
2103
        self.class.columns.inject({}) do |attributes, column|
2104
          attributes[column.name] = column.default unless column.name == self.class.primary_key
D
Initial  
David Heinemeier Hansson 已提交
2105 2106 2107 2108 2109 2110 2111 2112
          attributes
        end
      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
2113
      # parentheses to have the parameters typecasted before they're used in the constructor. Use i for Fixnum, f for Float,
2114
      # s for String, and a for Array. If all the values for a given attribute are empty, the attribute will be set to nil.
D
Initial  
David Heinemeier Hansson 已提交
2115 2116 2117 2118 2119
      def assign_multiparameter_attributes(pairs)
        execute_callstack_for_multiparameter_attributes(
          extract_callstack_for_multiparameter_attributes(pairs)
        )
      end
2120

2121
      def instantiate_time_object(name, values)
2122
        if self.class.send(:create_time_zone_conversion_attribute?, name, column_for_attribute(name))
2123
          Time.zone.local(*values)
2124
        else
2125
          Time.time_with_datetime_fallback(@@default_timezone, *values)
2126
        end
2127 2128
      end

D
Initial  
David Heinemeier Hansson 已提交
2129
      def execute_callstack_for_multiparameter_attributes(callstack)
2130
        errors = []
2131
        callstack.each do |name, values_with_empty_parameters|
2132 2133
          begin
            klass = (self.class.reflect_on_aggregation(name.to_sym) || column_for_attribute(name)).klass
2134 2135 2136 2137
            # in order to allow a date to be set without a year, we must keep the empty values.
            # Otherwise, we wouldn't be able to distinguish it from a date with an empty day.
            values = values_with_empty_parameters.reject(&:nil?)

2138 2139 2140
            if values.empty?
              send(name + "=", nil)
            else
2141

2142
              value = if Time == klass
2143
                instantiate_time_object(name, values)
2144 2145
              elsif Date == klass
                begin
2146
                  values = values_with_empty_parameters.collect do |v| v.nil? ? 1 : v end
2147 2148
                  Date.new(*values)
                rescue ArgumentError => ex # if Date.new raises an exception on an invalid date
2149
                  instantiate_time_object(name, values).to_date # we instantiate Time object and convert it back to a date thus using Time's logic in handling invalid dates
2150 2151 2152 2153 2154 2155
                end
              else
                klass.new(*values)
              end

              send(name + "=", value)
2156
            end
2157 2158
          rescue => ex
            errors << AttributeAssignmentError.new("error on assignment #{values.inspect} to #{name}", ex, name)
D
Initial  
David Heinemeier Hansson 已提交
2159 2160
          end
        end
2161 2162 2163
        unless errors.empty?
          raise MultiparameterAssignmentErrors.new(errors), "#{errors.size} error(s) on assignment of multiparameter attributes"
        end
D
Initial  
David Heinemeier Hansson 已提交
2164
      end
2165

D
Initial  
David Heinemeier Hansson 已提交
2166 2167 2168 2169 2170 2171 2172 2173
      def extract_callstack_for_multiparameter_attributes(pairs)
        attributes = { }

        for pair in pairs
          multiparameter_name, value = pair
          attribute_name = multiparameter_name.split("(").first
          attributes[attribute_name] = [] unless attributes.include?(attribute_name)

2174 2175
          parameter_value = value.empty? ? nil : type_cast_attribute_value(multiparameter_name, value)
          attributes[attribute_name] << [ find_parameter_position(multiparameter_name), parameter_value ]
D
Initial  
David Heinemeier Hansson 已提交
2176 2177 2178 2179
        end

        attributes.each { |name, values| attributes[name] = values.sort_by{ |v| v.first }.collect { |v| v.last } }
      end
2180

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

D
Initial  
David Heinemeier Hansson 已提交
2185 2186 2187
      def find_parameter_position(multiparameter_name)
        multiparameter_name.scan(/\(([0-9]*).*\)/).first.first
      end
2188

D
Initial  
David Heinemeier Hansson 已提交
2189 2190
      # Returns a comma-separated pair list, like "key1 = val1, key2 = val2".
      def comma_pair_list(hash)
2191
        hash.map { |k,v| "#{k} = #{v}" }.join(", ")
D
Initial  
David Heinemeier Hansson 已提交
2192 2193
      end

2194 2195 2196 2197
      def quote_columns(quoter, hash)
        hash.inject({}) do |quoted, (name, value)|
          quoted[quoter.quote_column_name(name)] = value
          quoted
2198
        end
D
Initial  
David Heinemeier Hansson 已提交
2199 2200
      end

2201 2202
      def quoted_comma_pair_list(quoter, hash)
        comma_pair_list(quote_columns(quoter, hash))
D
Initial  
David Heinemeier Hansson 已提交
2203 2204
      end

2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220
      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

      def object_from_yaml(string)
        return string unless string.is_a?(String) && string =~ /^---/
        YAML::load(string) rescue string
      end
D
Initial  
David Heinemeier Hansson 已提交
2221
  end
J
Joshua Peek 已提交
2222 2223

  Base.class_eval do
J
Joshua Peek 已提交
2224
    extend ActiveModel::Naming
J
Joshua Peek 已提交
2225
    extend QueryCache::ClassMethods
J
José Valim 已提交
2226 2227
    extend ActiveSupport::Benchmarkable

2228
    include ActiveModel::Conversion
J
Joshua Peek 已提交
2229 2230 2231
    include Validations
    include Locking::Optimistic, Locking::Pessimistic
    include AttributeMethods
J
Joshua Peek 已提交
2232
    include AttributeMethods::Read, AttributeMethods::Write, AttributeMethods::BeforeTypeCast, AttributeMethods::Query
2233
    include AttributeMethods::PrimaryKey
J
Joshua Peek 已提交
2234 2235
    include AttributeMethods::TimeZoneConversion
    include AttributeMethods::Dirty
2236
    include Callbacks, ActiveModel::Observing, Timestamp
J
Joshua Peek 已提交
2237
    include Associations, AssociationPreload, NamedScope
2238 2239 2240 2241

    # AutosaveAssociation needs to be included before Transactions, because we want
    # #save_with_autosave_associations to be wrapped inside a transaction.
    include AutosaveAssociation, NestedAttributes
P
Pratik Naik 已提交
2242
    include Aggregations, Transactions, Reflection, Serialization
2243

2244
    NilClass.add_whiner(self) if NilClass.respond_to?(:add_whiner)
J
Joshua Peek 已提交
2245
  end
2246
end
2247 2248 2249

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