4 module ActiveRecord
#:nodoc:
5 # Generic Active Record exception class.
6 class ActiveRecordError
< StandardError
9 # Raised when the single-table inheritance mechanism fails to locate the subclass
10 # (for example due to improper usage of column that +inheritance_column+ points to).
11 class SubclassNotFound
< ActiveRecordError
#:nodoc:
14 # Raised when an object assigned to an association has an incorrect type.
16 # class Ticket < ActiveRecord::Base
20 # class Patch < ActiveRecord::Base
24 # # Comments are not patches, this assignment raises AssociationTypeMismatch.
25 # @ticket.patches << Comment.new(:content => "Please attach tests to your patch.")
26 class AssociationTypeMismatch
< ActiveRecordError
29 # Raised when unserialized object's type mismatches one specified for serializable field.
30 class SerializationTypeMismatch
< ActiveRecordError
33 # Raised when adapter not specified on connection (or configuration file <tt>config/database.yml</tt> misses adapter field).
34 class AdapterNotSpecified
< ActiveRecordError
37 # Raised when Active Record cannot find database adapter specified in <tt>config/database.yml</tt> or programmatically.
38 class AdapterNotFound
< ActiveRecordError
41 # Raised when connection to the database could not been established (for example when <tt>connection=</tt> is given a nil object).
42 class ConnectionNotEstablished
< ActiveRecordError
45 # Raised when Active Record cannot find record by given id or set of ids.
46 class RecordNotFound
< ActiveRecordError
49 # Raised by ActiveRecord::Base.save! and ActiveRecord::Base.create! methods when record cannot be
50 # saved because record is invalid.
51 class RecordNotSaved
< ActiveRecordError
54 # Raised when SQL statement cannot be executed by the database (for example, it's often the case for MySQL when Ruby driver used is too old).
55 class StatementInvalid
< ActiveRecordError
58 # Raised when number of bind variables in statement given to <tt>:condition</tt> key (for example, when using +find+ method)
59 # does not match number of expected variables.
63 # Location.find :all, :conditions => ["lat = ? AND lng = ?", 53.7362]
65 # two placeholders are given but only one variable to fill them.
66 class PreparedStatementInvalid
< ActiveRecordError
69 # Raised on attempt to save stale record. Record is stale when it's being saved in another query after
70 # instantiation, for example, when two users edit the same wiki page and one starts editing and saves
71 # the page before the other.
73 # Read more about optimistic locking in ActiveRecord::Locking module RDoc.
74 class StaleObjectError
< ActiveRecordError
77 # Raised when association is being configured improperly or
78 # user tries to use offset and limit together with has_many or has_and_belongs_to_many associations.
79 class ConfigurationError
< ActiveRecordError
82 # Raised on attempt to update record that is instantiated as read only.
83 class ReadOnlyRecord
< ActiveRecordError
86 # ActiveRecord::Transactions::ClassMethods.transaction uses this exception
87 # to distinguish a deliberate rollback from other exceptional situations.
88 # Normally, raising an exception will cause the +transaction+ method to rollback
89 # the database transaction *and* pass on the exception. But if you raise an
90 # ActiveRecord::Rollback exception, then the database transaction will be rolled back,
91 # without passing on the exception.
93 # For example, you could do this in your controller to rollback a transaction:
95 # class BooksController < ActionController::Base
98 # book = Book.new(params[:book])
100 # if today_is_friday?
101 # # The system must fail on Friday so that our support department
102 # # won't be out of job. We silently rollback this transaction
103 # # without telling the user.
104 # raise ActiveRecord::Rollback, "Call tech support!"
107 # # ActiveRecord::Rollback is the only exception that won't be passed on
108 # # by ActiveRecord::Base.transaction, so this line will still be reached
110 # redirect_to root_url
113 class Rollback
< ActiveRecordError
116 # Raised when attribute has a name reserved by Active Record (when attribute has name of one of Active Record instance methods).
117 class DangerousAttributeError
< ActiveRecordError
120 # Raised when you've tried to access a column which wasn't loaded by your finder.
121 # Typically this is because <tt>:select</tt> has been specified.
122 class MissingAttributeError
< NoMethodError
125 # Raised when unknown attributes are supplied via mass assignment.
126 class UnknownAttributeError
< NoMethodError
129 # Raised when an error occurred while doing a mass assignment to an attribute through the
130 # <tt>attributes=</tt> method. The exception has an +attribute+ property that is the name of the
131 # offending attribute.
132 class AttributeAssignmentError
< ActiveRecordError
133 attr_reader
:exception, :attribute
134 def initialize(message
, exception
, attribute
)
135 @exception = exception
136 @attribute = attribute
141 # Raised when there are multiple errors while doing a mass assignment through the +attributes+
142 # method. The exception has an +errors+ property that contains an array of AttributeAssignmentError
143 # objects, each corresponding to the error while assigning to an attribute.
144 class MultiparameterAssignmentErrors
< ActiveRecordError
146 def initialize(errors
)
151 # Active Record objects don't specify their attributes directly, but rather infer them from the table definition with
152 # which they're linked. Adding, removing, and changing attributes and their type is done directly in the database. Any change
153 # is instantly reflected in the Active Record objects. The mapping that binds a given Active Record class to a certain
154 # database table will happen automatically in most common cases, but can be overwritten for the uncommon ones.
156 # See the mapping rules in table_name and the full example in link:files/README.html for more insight.
160 # Active Records accept constructor parameters either in a hash or as a block. The hash method is especially useful when
161 # you're receiving the data from somewhere else, like an HTTP request. It works like this:
163 # user = User.new(:name => "David", :occupation => "Code Artist")
164 # user.name # => "David"
166 # You can also use block initialization:
168 # user = User.new do |u|
170 # u.occupation = "Code Artist"
173 # And of course you can just create a bare object and specify the attributes after the fact:
176 # user.name = "David"
177 # user.occupation = "Code Artist"
181 # Conditions can either be specified as a string, array, or hash representing the WHERE-part of an SQL statement.
182 # The array form is to be used when the condition input is tainted and requires sanitization. The string form can
183 # be used for statements that don't involve tainted data. The hash form works much like the array form, except
184 # only equality and range is possible. Examples:
186 # class User < ActiveRecord::Base
187 # def self.authenticate_unsafely(user_name, password)
188 # find(:first, :conditions => "user_name = '#{user_name}' AND password = '#{password}'")
191 # def self.authenticate_safely(user_name, password)
192 # find(:first, :conditions => [ "user_name = ? AND password = ?", user_name, password ])
195 # def self.authenticate_safely_simply(user_name, password)
196 # find(:first, :conditions => { :user_name => user_name, :password => password })
200 # The <tt>authenticate_unsafely</tt> method inserts the parameters directly into the query and is thus susceptible to SQL-injection
201 # attacks if the <tt>user_name</tt> and +password+ parameters come directly from an HTTP request. The <tt>authenticate_safely</tt> and
202 # <tt>authenticate_safely_simply</tt> both will sanitize the <tt>user_name</tt> and +password+ before inserting them in the query,
203 # which will ensure that an attacker can't escape the query and fake the login (or worse).
205 # When using multiple parameters in the conditions, it can easily become hard to read exactly what the fourth or fifth
206 # question mark is supposed to represent. In those cases, you can resort to named bind variables instead. That's done by replacing
207 # the question marks with symbols and supplying a hash with values for the matching symbol keys:
209 # Company.find(:first, :conditions => [
210 # "id = :id AND name = :name AND division = :division AND created_at > :accounting_date",
211 # { :id => 3, :name => "37signals", :division => "First", :accounting_date => '2005-01-01' }
214 # Similarly, a simple hash without a statement will generate conditions based on equality with the SQL AND
215 # operator. For instance:
217 # Student.find(:all, :conditions => { :first_name => "Harvey", :status => 1 })
218 # Student.find(:all, :conditions => params[:student])
220 # A range may be used in the hash to use the SQL BETWEEN operator:
222 # Student.find(:all, :conditions => { :grade => 9..12 })
224 # An array may be used in the hash to use the SQL IN operator:
226 # Student.find(:all, :conditions => { :grade => [9,11,12] })
228 # == Overwriting default accessors
230 # All column values are automatically available through basic accessors on the Active Record object, but sometimes you
231 # want to specialize this behavior. This can be done by overwriting the default accessors (using the same
232 # name as the attribute) and calling <tt>read_attribute(attr_name)</tt> and <tt>write_attribute(attr_name, value)</tt> to actually change things.
235 # class Song < ActiveRecord::Base
236 # # Uses an integer of seconds to hold the length of the song
238 # def length=(minutes)
239 # write_attribute(:length, minutes.to_i * 60)
243 # read_attribute(:length) / 60
247 # You can alternatively use <tt>self[:attribute]=(value)</tt> and <tt>self[:attribute]</tt> instead of <tt>write_attribute(:attribute, value)</tt> and
248 # <tt>read_attribute(:attribute)</tt> as a shorter form.
250 # == Attribute query methods
252 # In addition to the basic accessors, query methods are also automatically available on the Active Record object.
253 # Query methods allow you to test whether an attribute value is present.
255 # For example, an Active Record User with the <tt>name</tt> attribute has a <tt>name?</tt> method that you can call
256 # to determine whether the user has a name:
258 # user = User.new(:name => "David")
259 # user.name? # => true
261 # anonymous = User.new(:name => "")
262 # anonymous.name? # => false
264 # == Accessing attributes before they have been typecasted
266 # Sometimes you want to be able to read the raw attribute data without having the column-determined typecast run its course first.
267 # That can be done by using the <tt><attribute>_before_type_cast</tt> accessors that all attributes have. For example, if your Account model
268 # has a <tt>balance</tt> attribute, you can call <tt>account.balance_before_type_cast</tt> or <tt>account.id_before_type_cast</tt>.
270 # This is especially useful in validation situations where the user might supply a string for an integer field and you want to display
271 # the original string back in an error message. Accessing the attribute normally would typecast the string to 0, which isn't what you
274 # == Dynamic attribute-based finders
276 # Dynamic attribute-based finders are a cleaner way of getting (and/or creating) objects by simple queries without turning to SQL. They work by
277 # 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>,
278 # <tt>Person.find_all_by_last_name</tt>, and <tt>Payment.find_by_transaction_id</tt>. So instead of writing
279 # <tt>Person.find(:first, :conditions => ["user_name = ?", user_name])</tt>, you just do <tt>Person.find_by_user_name(user_name)</tt>.
280 # And instead of writing <tt>Person.find(:all, :conditions => ["last_name = ?", last_name])</tt>, you just do <tt>Person.find_all_by_last_name(last_name)</tt>.
282 # It's also possible to use multiple attributes in the same find by separating them with "_and_", so you get finders like
283 # <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
284 # <tt>Person.find(:first, :conditions => ["user_name = ? AND password = ?", user_name, password])</tt>, you just do
285 # <tt>Person.find_by_user_name_and_password(user_name, password)</tt>.
287 # It's even possible to use all the additional parameters to find. For example, the full interface for <tt>Payment.find_all_by_amount</tt>
288 # is actually <tt>Payment.find_all_by_amount(amount, options)</tt>. And the full interface to <tt>Person.find_by_user_name</tt> is
289 # actually <tt>Person.find_by_user_name(user_name, options)</tt>. So you could call <tt>Payment.find_all_by_amount(50, :order => "created_on")</tt>.
290 # Also you may call <tt>Payment.find_last_by_amount(amount, options)</tt> returning the last record matching that amount and options.
292 # The same dynamic finder style can be used to create the object if it doesn't already exist. This dynamic finder is called with
293 # <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:
295 # # No 'Summer' tag exists
296 # Tag.find_or_create_by_name("Summer") # equal to Tag.create(:name => "Summer")
298 # # Now the 'Summer' tag does exist
299 # Tag.find_or_create_by_name("Summer") # equal to Tag.find_by_name("Summer")
301 # # Now 'Bob' exist and is an 'admin'
302 # User.find_or_create_by_name('Bob', :age => 40) { |u| u.admin = true }
304 # 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:
306 # # No 'Winter' tag exists
307 # winter = Tag.find_or_initialize_by_name("Winter")
308 # winter.new_record? # true
310 # To find by a subset of the attributes to be used for instantiating a new object, pass a hash instead of
311 # a list of parameters. For example:
313 # Tag.find_or_create_by_name(:name => "rails", :creator => current_user)
315 # That will either find an existing tag named "rails", or create a new one while setting the user that created it.
317 # == Saving arrays, hashes, and other non-mappable objects in text columns
319 # 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+.
320 # This makes it possible to store arrays, hashes, and other non-mappable objects without doing any additional work. Example:
322 # class User < ActiveRecord::Base
323 # serialize :preferences
326 # user = User.create(:preferences => { "background" => "black", "display" => large })
327 # User.find(user.id).preferences # => { "background" => "black", "display" => large }
329 # You can also specify a class option as the second parameter that'll raise an exception if a serialized object is retrieved as a
330 # descendant of a class not in the hierarchy. Example:
332 # class User < ActiveRecord::Base
333 # serialize :preferences, Hash
336 # user = User.create(:preferences => %w( one two three ))
337 # User.find(user.id).preferences # raises SerializationTypeMismatch
339 # == Single table inheritance
341 # Active Record allows inheritance by storing the name of the class in a column that by default is named "type" (can be changed
342 # by overwriting <tt>Base.inheritance_column</tt>). This means that an inheritance looking like this:
344 # class Company < ActiveRecord::Base; end
345 # class Firm < Company; end
346 # class Client < Company; end
347 # class PriorityClient < Client; end
349 # When you do <tt>Firm.create(:name => "37signals")</tt>, this record will be saved in the companies table with type = "Firm". You can then
350 # fetch this row again using <tt>Company.find(:first, "name = '37signals'")</tt> and it will return a Firm object.
352 # 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
353 # like normal subclasses with no special magic for differentiating between them or reloading the right type with find.
355 # Note, all the attributes for all the cases are kept in the same table. Read more:
356 # http://www.martinfowler.com/eaaCatalog/singleTableInheritance.html
358 # == Connection to multiple databases in different models
360 # Connections are usually created through ActiveRecord::Base.establish_connection and retrieved by ActiveRecord::Base.connection.
361 # All classes inheriting from ActiveRecord::Base will use this connection. But you can also set a class-specific connection.
362 # For example, if Course is an ActiveRecord::Base, but resides in a different database, you can just say <tt>Course.establish_connection</tt>
363 # and Course and all of its subclasses will use this connection instead.
365 # This feature is implemented by keeping a connection pool in ActiveRecord::Base that is a Hash indexed by the class. If a connection is
366 # requested, the retrieve_connection method will go up the class-hierarchy until a connection is found in the connection pool.
370 # * ActiveRecordError - Generic error class and superclass of all other errors raised by Active Record.
371 # * AdapterNotSpecified - The configuration hash used in <tt>establish_connection</tt> didn't include an
372 # <tt>:adapter</tt> key.
373 # * AdapterNotFound - The <tt>:adapter</tt> key used in <tt>establish_connection</tt> specified a non-existent adapter
374 # (or a bad spelling of an existing one).
375 # * AssociationTypeMismatch - The object assigned to the association wasn't of the type specified in the association definition.
376 # * SerializationTypeMismatch - The serialized object wasn't of the class specified as the second parameter.
377 # * ConnectionNotEstablished+ - No connection has been established. Use <tt>establish_connection</tt> before querying.
378 # * RecordNotFound - No record responded to the +find+ method. Either the row with the given ID doesn't exist
379 # or the row didn't meet the additional restrictions. Some +find+ calls do not raise this exception to signal
380 # nothing was found, please check its documentation for further details.
381 # * StatementInvalid - The database server rejected the SQL statement. The precise error is added in the message.
382 # * MultiparameterAssignmentErrors - Collection of errors that occurred during a mass assignment using the
383 # <tt>attributes=</tt> method. The +errors+ property of this exception contains an array of AttributeAssignmentError
384 # objects that should be inspected to determine which attributes triggered the errors.
385 # * AttributeAssignmentError - An error occurred while doing a mass assignment through the <tt>attributes=</tt> method.
386 # You can inspect the +attribute+ property of the exception object to determine which attribute triggered the error.
388 # *Note*: The attributes listed are class-level attributes (accessible from both the class and instance level).
389 # So it's possible to assign a logger to the class through <tt>Base.logger=</tt> which will then be used by all
390 # instances in the current object space.
394 # Accepts a logger conforming to the interface of Log4r or the default Ruby 1.8+ Logger class, which is then passed
395 # on to any new database connections made and which can be retrieved on both a class and instance level by calling +logger+.
396 cattr_accessor
:logger, :instance_writer => false
398 def self.inherited(child
) #:nodoc:
399 @
@subclasses[self] ||= []
400 @
@subclasses[self] << child
404 def self.reset_subclasses
#:nodoc:
406 subclasses
.each
do |klass
|
407 unless ActiveSupport
::Dependencies.autoloaded
? klass
408 nonreloadables
<< klass
411 klass
.instance_variables
.each
{ |var
| klass
.send(:remove_instance_variable, var
) }
412 klass
.instance_methods(false).each
{ |m
| klass
.send
:undef_method, m
}
415 nonreloadables
.each
{ |klass
| (@
@subclasses[klass
.superclass
] ||= []) << klass
}
422 # Contains the database configuration - as is typically stored in config/database.yml -
425 # For example, the following database.yml...
429 # database: db/development.sqlite3
433 # database: db/production.sqlite3
435 # ...would result in ActiveRecord::Base.configurations to look like this:
439 # 'adapter' => 'sqlite3',
440 # 'database' => 'db/development.sqlite3'
443 # 'adapter' => 'sqlite3',
444 # 'database' => 'db/production.sqlite3'
447 cattr_accessor
:configurations, :instance_writer => false
448 @
@configurations = {}
452 # Accessor for the prefix type that will be prepended to every primary key column name. The options are :table_name and
453 # :table_name_with_underscore. If the first is specified, the Product class will look for "productid" instead of "id" as
454 # the primary column. If the latter is specified, the Product class will look for "product_id" instead of "id". Remember
455 # that this is a global setting for all Active Records.
456 cattr_accessor
:primary_key_prefix_type, :instance_writer => false
457 @
@primary_key_prefix_type = nil
461 # Accessor for the name of the prefix string to prepend to every table name. So if set to "basecamp_", all
462 # table names will be named like "basecamp_projects", "basecamp_people", etc. This is a convenient way of creating a namespace
463 # for tables in a shared database. By default, the prefix is the empty string.
464 cattr_accessor
:table_name_prefix, :instance_writer => false
465 @
@table_name_prefix = ""
469 # Works like +table_name_prefix+, but appends instead of prepends (set to "_basecamp" gives "projects_basecamp",
470 # "people_basecamp"). By default, the suffix is the empty string.
471 cattr_accessor
:table_name_suffix, :instance_writer => false
472 @
@table_name_suffix = ""
476 # Indicates whether table names should be the pluralized versions of the corresponding class names.
477 # If true, the default table name for a Product class will be +products+. If false, it would just be +product+.
478 # See table_name for the full rules on table/class naming. This is true, by default.
479 cattr_accessor
:pluralize_table_names, :instance_writer => false
480 @
@pluralize_table_names = true
484 # Determines whether to use ANSI codes to colorize the logging statements committed by the connection adapter. These colors
485 # make it much easier to overview things during debugging (when used through a reader like +tail+ and on a black background), but
486 # may complicate matters if you use software like syslog. This is true, by default.
487 cattr_accessor
:colorize_logging, :instance_writer => false
488 @
@colorize_logging = true
492 # Determines whether to use Time.local (using :local) or Time.utc (using :utc) when pulling dates and times from the database.
493 # This is set to :local by default.
494 cattr_accessor
:default_timezone, :instance_writer => false
495 @
@default_timezone = :local
499 # Specifies the format to use when dumping the database schema with Rails'
500 # Rakefile. If :sql, the schema is dumped as (potentially database-
501 # specific) SQL statements. If :ruby, the schema is dumped as an
502 # ActiveRecord::Schema file which can be loaded into any database that
503 # supports migrations. Use :ruby if you want to have different database
504 # adapters for, e.g., your development and test environments.
505 cattr_accessor
:schema_format , :instance_writer => false
506 @
@schema_format = :ruby
510 # Specify whether or not to use timestamps for migration numbers
511 cattr_accessor
:timestamped_migrations , :instance_writer => false
512 @
@timestamped_migrations = true
514 # Determine whether to store the full constant name including namespace when using STI
515 superclass_delegating_accessor
:store_full_sti_class
516 self.store_full_sti_class
= false
518 # Stores the default scope for the class
519 class_inheritable_accessor
:default_scoping, :instance_writer => false
520 self.default_scoping
= []
522 class << self # Class methods
523 # Find operates with four different retrieval approaches:
525 # * Find by id - This can either be a specific id (1), a list of ids (1, 5, 6), or an array of ids ([5, 6, 10]).
526 # If no record can be found for all of the listed ids, then RecordNotFound will be raised.
527 # * Find first - This will return the first record matched by the options used. These options can either be specific
528 # conditions or merely an order. If no record can be matched, +nil+ is returned. Use
529 # <tt>Model.find(:first, *args)</tt> or its shortcut <tt>Model.first(*args)</tt>.
530 # * Find last - This will return the last record matched by the options used. These options can either be specific
531 # conditions or merely an order. If no record can be matched, +nil+ is returned. Use
532 # <tt>Model.find(:last, *args)</tt> or its shortcut <tt>Model.last(*args)</tt>.
533 # * Find all - This will return all the records matched by the options used.
534 # If no records are found, an empty array is returned. Use
535 # <tt>Model.find(:all, *args)</tt> or its shortcut <tt>Model.all(*args)</tt>.
537 # All approaches accept an options hash as their last parameter.
541 # * <tt>:conditions</tt> - An SQL fragment like "administrator = 1", <tt>[ "user_name = ?", username ]</tt>, or <tt>["user_name = :user_name", { :user_name => user_name }]</tt>. See conditions in the intro.
542 # * <tt>:order</tt> - An SQL fragment like "created_at DESC, name".
543 # * <tt>:group</tt> - An attribute name by which the result should be grouped. Uses the <tt>GROUP BY</tt> SQL-clause.
544 # * <tt>:having</tt> - Combined with +:group+ this can be used to filter the records that a <tt>GROUP BY</tt> returns. Uses the <tt>HAVING</tt> SQL-clause.
545 # * <tt>:limit</tt> - An integer determining the limit on the number of rows that should be returned.
546 # * <tt>:offset</tt> - An integer determining the offset from where the rows should be fetched. So at 5, it would skip rows 0 through 4.
547 # * <tt>:joins</tt> - Either an SQL fragment for additional joins like "LEFT JOIN comments ON comments.post_id = id" (rarely needed),
548 # named associations in the same form used for the <tt>:include</tt> option, which will perform an <tt>INNER JOIN</tt> on the associated table(s),
549 # or an array containing a mixture of both strings and named associations.
550 # If the value is a string, then the records will be returned read-only since they will have attributes that do not correspond to the table's columns.
551 # Pass <tt>:readonly => false</tt> to override.
552 # * <tt>:include</tt> - Names associations that should be loaded alongside. The symbols named refer
553 # to already defined associations. See eager loading under Associations.
554 # * <tt>:select</tt> - By default, this is "*" as in "SELECT * FROM", but can be changed if you, for example, want to do a join but not
555 # include the joined columns. Takes a string with the SELECT SQL fragment (e.g. "id, name").
556 # * <tt>:from</tt> - By default, this is the table name of the class, but can be changed to an alternate table name (or even the name
557 # of a database view).
558 # * <tt>:readonly</tt> - Mark the returned records read-only so they cannot be saved or updated.
559 # * <tt>:lock</tt> - An SQL fragment like "FOR UPDATE" or "LOCK IN SHARE MODE".
560 # <tt>:lock => true</tt> gives connection's default exclusive lock, usually "FOR UPDATE".
565 # Person.find(1) # returns the object for ID = 1
566 # Person.find(1, 2, 6) # returns an array for objects with IDs in (1, 2, 6)
567 # Person.find([7, 17]) # returns an array for objects with IDs in (7, 17)
568 # Person.find([1]) # returns an array for the object with ID = 1
569 # Person.find(1, :conditions => "administrator = 1", :order => "created_on DESC")
571 # Note that returned records may not be in the same order as the ids you
572 # provide since database rows are unordered. Give an explicit <tt>:order</tt>
573 # to ensure the results are sorted.
578 # Person.find(:first) # returns the first object fetched by SELECT * FROM people
579 # Person.find(:first, :conditions => [ "user_name = ?", user_name])
580 # Person.find(:first, :conditions => [ "user_name = :u", { :u => user_name }])
581 # Person.find(:first, :order => "created_on DESC", :offset => 5)
584 # Person.find(:last) # returns the last object fetched by SELECT * FROM people
585 # Person.find(:last, :conditions => [ "user_name = ?", user_name])
586 # Person.find(:last, :order => "created_on DESC", :offset => 5)
589 # Person.find(:all) # returns an array of objects for all the rows fetched by SELECT * FROM people
590 # Person.find(:all, :conditions => [ "category IN (?)", categories], :limit => 50)
591 # Person.find(:all, :conditions => { :friends => ["Bob", "Steve", "Fred"] }
592 # Person.find(:all, :offset => 10, :limit => 10)
593 # Person.find(:all, :include => [ :account, :friends ])
594 # Person.find(:all, :group => "category")
596 # Example for find with a lock: Imagine two concurrent transactions:
597 # each will read <tt>person.visits == 2</tt>, add 1 to it, and save, resulting
598 # in two saves of <tt>person.visits = 3</tt>. By locking the row, the second
599 # transaction has to wait until the first is finished; we get the
600 # expected <tt>person.visits == 4</tt>.
602 # Person.transaction do
603 # person = Person.find(1, :lock => true)
608 options
= args
.extract_options
!
609 validate_find_options(options
)
610 set_readonly_option
!(options
)
613 when :first then find_initial(options
)
614 when :last then find_last(options
)
615 when :all then find_every(options
)
616 else find_from_ids(args
, options
)
620 # A convenience wrapper for <tt>find(:first, *args)</tt>. You can pass in all the
621 # same arguments to this method as you can to <tt>find(:first)</tt>.
626 # A convenience wrapper for <tt>find(:last, *args)</tt>. You can pass in all the
627 # same arguments to this method as you can to <tt>find(:last)</tt>.
632 # This is an alias for find(:all). You can pass in all the same arguments to this method as you can
638 # Executes a custom SQL query against your database and returns all the results. The results will
639 # be returned as an array with columns requested encapsulated as attributes of the model you call
640 # this method from. If you call <tt>Product.find_by_sql</tt> then the results will be returned in
641 # a Product object with the attributes you specified in the SQL query.
643 # If you call a complicated SQL query which spans multiple tables the columns specified by the
644 # SELECT will be attributes of the model, whether or not they are columns of the corresponding
647 # The +sql+ parameter is a full SQL query as a string. It will be called as is, there will be
648 # no database agnostic conversions performed. This should be a last resort because using, for example,
649 # MySQL specific terms will lock you to using that particular database engine or require you to
650 # change your call if you switch engines.
653 # # A simple SQL query spanning multiple tables
654 # Post.find_by_sql "SELECT p.title, c.author FROM posts p, comments c WHERE p.id = c.post_id"
655 # > [#<Post:0x36bff9c @attributes={"title"=>"Ruby Meetup", "first_name"=>"Quentin"}>, ...]
657 # # You can use the same string replacement techniques as you can with ActiveRecord#find
658 # Post.find_by_sql ["SELECT title FROM posts WHERE author = ? AND created > ?", author_id, start_date]
659 # > [#<Post:0x36bff9c @attributes={"first_name"=>"The Cheap Man Buys Twice"}>, ...]
661 connection
.select_all(sanitize_sql(sql
), "#{name} Load").collect
! { |record
| instantiate(record
) }
664 # Returns true if a record exists in the table that matches the +id+ or
665 # conditions given, or false otherwise. The argument can take five forms:
667 # * Integer - Finds the record with this primary key.
668 # * String - Finds the record with a primary key corresponding to this
669 # string (such as <tt>'5'</tt>).
670 # * Array - Finds the record that matches these +find+-style conditions
671 # (such as <tt>['color = ?', 'red']</tt>).
672 # * Hash - Finds the record that matches these +find+-style conditions
673 # (such as <tt>{:color => 'red'}</tt>).
674 # * No args - Returns false if the table is empty, true otherwise.
676 # For more information about specifying conditions as a Hash or Array,
677 # see the Conditions section in the introduction to ActiveRecord::Base.
679 # Note: You can't pass in a condition as a string (like <tt>name =
680 # 'Jamie'</tt>), since it would be sanitized and then queried against
681 # the primary key column, like <tt>id = 'name = \'Jamie\''</tt>.
685 # Person.exists?('5')
686 # Person.exists?(:name => "David")
687 # Person.exists?(['name LIKE ?', "%#{query}%"])
689 def exists
?(id_or_conditions
= {})
690 connection
.select_all(
691 construct_finder_sql(
692 :select => "#{quoted_table_name}.#{primary_key}",
693 :conditions => expand_id_conditions(id_or_conditions
),
700 # Creates an object (or multiple objects) and saves it to the database, if validations pass.
701 # The resulting object is returned whether the object was saved successfully to the database or not.
703 # The +attributes+ parameter can be either be a Hash or an Array of Hashes. These Hashes describe the
704 # attributes on the objects that are to be created.
707 # # Create a single new object
708 # User.create(:first_name => 'Jamie')
710 # # Create an Array of new objects
711 # User.create([{ :first_name => 'Jamie' }, { :first_name => 'Jeremy' }])
713 # # Create a single object and pass it into a block to set other attributes.
714 # User.create(:first_name => 'Jamie') do |u|
718 # # Creating an Array of new objects using a block, where the block is executed for each object:
719 # User.create([{ :first_name => 'Jamie' }, { :first_name => 'Jeremy' }]) do |u|
722 def create(attributes
= nil, &block
)
723 if attributes
.is_a
?(Array
)
724 attributes
.collect
{ |attr
| create(attr
, &block
) }
726 object
= new(attributes
)
727 yield(object
) if block_given
?
733 # Updates an object (or multiple objects) and saves it to the database, if validations pass.
734 # The resulting object is returned whether the object was saved successfully to the database or not.
738 # * +id+ - This should be the id or an array of ids to be updated.
739 # * +attributes+ - This should be a Hash of attributes to be set on the object, or an array of Hashes.
743 # # Updating one record:
744 # Person.update(15, { :user_name => 'Samuel', :group => 'expert' })
746 # # Updating multiple records:
747 # people = { 1 => { "first_name" => "David" }, 2 => { "first_name" => "Jeremy" } }
748 # Person.update(people.keys, people.values)
749 def update(id
, attributes
)
752 id
.collect
{ |one_id
| idx
+= 1; update(one_id
, attributes
[idx
]) }
755 object
.update_attributes(attributes
)
760 # Deletes the row with a primary key matching the +id+ argument, using a
761 # SQL +DELETE+ statement, and returns the number of rows deleted. Active
762 # Record objects are not instantiated, so the object's callbacks are not
763 # executed, including any <tt>:dependent</tt> association options or
766 # You can delete multiple rows at once by passing an Array of <tt>id</tt>s.
768 # Note: Although it is often much faster than the alternative,
769 # <tt>#destroy</tt>, skipping callbacks might bypass business logic in
770 # your application that ensures referential integrity or performs other
775 # # Delete a single row
778 # # Delete multiple rows
779 # Todo.delete([2,3,4])
781 delete_all([ "#{connection.quote_column_name(primary_key)} IN (?)", id
])
784 # Destroy an object (or multiple objects) that has the given id, the object is instantiated first,
785 # therefore all callbacks and filters are fired off before the object is deleted. This method is
786 # less efficient than ActiveRecord#delete but allows cleanup methods and other actions to be run.
788 # This essentially finds the object (or multiple objects) with the given id, creates a new object
789 # from the attributes, and then calls destroy on it.
793 # * +id+ - Can be either an Integer or an Array of Integers.
797 # # Destroy a single object
800 # # Destroy multiple objects
802 # Todo.destroy(todos)
805 id
.map
{ |one_id
| destroy(one_id
) }
811 # Updates all records with details given if they match a set of conditions supplied, limits and order can
812 # also be supplied. This method constructs a single SQL UPDATE statement and sends it straight to the
813 # database. It does not instantiate the involved models and it does not trigger Active Record callbacks.
817 # * +updates+ - A string of column and value pairs that will be set on any records that match conditions. This creates the SET clause of the generated SQL.
818 # * +conditions+ - An SQL fragment like "administrator = 1" or [ "user_name = ?", username ]. See conditions in the intro for more info.
819 # * +options+ - Additional options are <tt>:limit</tt> and <tt>:order</tt>, see the examples for usage.
823 # # Update all billing objects with the 3 different attributes given
824 # Billing.update_all( "category = 'authorized', approved = 1, author = 'David'" )
826 # # Update records that match our conditions
827 # Billing.update_all( "author = 'David'", "title LIKE '%Rails%'" )
829 # # Update records that match our conditions but limit it to 5 ordered by date
830 # Billing.update_all( "author = 'David'", "title LIKE '%Rails%'",
831 # :order => 'created_at', :limit => 5 )
832 def update_all(updates
, conditions
= nil, options
= {})
833 sql
= "UPDATE #{quoted_table_name} SET #{sanitize_sql_for_assignment(updates)} "
838 add_conditions
!(select_sql
, conditions
, scope
)
840 if options
.has_key
?(:limit) || (scope
&& scope
[:limit])
841 # Only take order from scope if limit is also provided by scope, this
842 # is useful for updating a has_many association with a limit.
843 add_order
!(select_sql
, options
[:order], scope
)
845 add_limit
!(select_sql
, options
, scope
)
846 sql
.concat(connection
.limited_update_conditions(select_sql
, quoted_table_name
, connection
.quote_column_name(primary_key
)))
848 add_order
!(select_sql
, options
[:order], nil)
849 sql
.concat(select_sql
)
852 connection
.update(sql
, "#{name} Update")
855 # Destroys the records matching +conditions+ by instantiating each
856 # record and calling its +destroy+ method. Each object's callbacks are
857 # executed (including <tt>:dependent</tt> association options and
858 # +before_destroy+/+after_destroy+ Observer methods). Returns the
859 # collection of objects that were destroyed; each will be frozen, to
860 # reflect that no changes should be made (since they can't be
863 # Note: Instantiation, callback execution, and deletion of each
864 # record can be time consuming when you're removing many records at
865 # once. It generates at least one SQL +DELETE+ query per record (or
866 # possibly more, to enforce your callbacks). If you want to delete many
867 # rows quickly, without concern for their associations or callbacks, use
868 # +delete_all+ instead.
872 # * +conditions+ - A string, array, or hash that specifies which records
873 # to destroy. If omitted, all records are destroyed. See the
874 # Conditions section in the introduction to ActiveRecord::Base for
879 # Person.destroy_all("last_login < '2004-04-04'")
880 # Person.destroy_all(:status => "inactive")
881 def destroy_all(conditions
= nil)
882 find(:all, :conditions => conditions
).each
{ |object
| object
.destroy
}
885 # Deletes the records matching +conditions+ without instantiating the records first, and hence not
886 # calling the +destroy+ method nor invoking callbacks. This is a single SQL DELETE statement that
887 # goes straight to the database, much more efficient than +destroy_all+. Be careful with relations
888 # though, in particular <tt>:dependent</tt> rules defined on associations are not honored. Returns
889 # the number of rows affected.
893 # * +conditions+ - Conditions are specified the same way as with +find+ method.
897 # Post.delete_all("person_id = 5 AND (category = 'Something' OR category = 'Else')")
898 # Post.delete_all(["person_id = ? AND (category = ? OR category = ?)", 5, 'Something', 'Else'])
900 # Both calls delete the affected posts all at once with a single DELETE statement. If you need to destroy dependent
901 # associations or call your <tt>before_*</tt> or +after_destroy+ callbacks, use the +destroy_all+ method instead.
902 def delete_all(conditions
= nil)
903 sql
= "DELETE FROM #{quoted_table_name} "
904 add_conditions
!(sql
, conditions
, scope(:find))
905 connection
.delete(sql
, "#{name} Delete all")
908 # Returns the result of an SQL statement that should only include a COUNT(*) in the SELECT part.
909 # The use of this method should be restricted to complicated SQL queries that can't be executed
910 # using the ActiveRecord::Calculations class methods. Look into those before using this.
914 # * +sql+ - An SQL statement which should return a count query from the database, see the example below.
918 # Product.count_by_sql "SELECT COUNT(*) FROM sales s, customers c WHERE s.customer_id = c.id"
919 def count_by_sql(sql
)
920 sql
= sanitize_conditions(sql
)
921 connection
.select_value(sql
, "#{name} Count").to_i
924 # A generic "counter updater" implementation, intended primarily to be
925 # used by increment_counter and decrement_counter, but which may also
926 # be useful on its own. It simply does a direct SQL update for the record
927 # with the given ID, altering the given hash of counters by the amount
928 # given by the corresponding value:
932 # * +id+ - The id of the object you wish to update a counter on or an Array of ids.
933 # * +counters+ - An Array of Hashes containing the names of the fields
934 # to update as keys and the amount to update the field by as values.
938 # # For the Post with id of 5, decrement the comment_count by 1, and
939 # # increment the action_count by 1
940 # Post.update_counters 5, :comment_count => -1, :action_count => 1
941 # # Executes the following SQL:
943 # # SET comment_count = comment_count - 1,
944 # # action_count = action_count + 1
947 # # For the Posts with id of 10 and 15, increment the comment_count by 1
948 # Post.update_counters [10, 15], :comment_count => 1
949 # # Executes the following SQL:
951 # # SET comment_count = comment_count + 1,
952 # # WHERE id IN (10, 15)
953 def update_counters(id
, counters
)
954 updates
= counters
.inject([]) { |list
, (counter_name
, increment
)|
955 sign
= increment
< 0 ? "-" : "+"
956 list
<< "#{connection.quote_column_name(counter_name)} = COALESCE(#{connection.quote_column_name(counter_name)}, 0) #{sign} #{increment.abs}"
960 ids_list
= id
.map
{|i
| quote_value(i
)}.join(', ')
961 condition
= "IN (#{ids_list})"
963 condition
= "= #{quote_value(id)}"
966 update_all(updates
, "#{connection.quote_column_name(primary_key)} #{condition}")
969 # Increment a number field by one, usually representing a count.
971 # This is used for caching aggregate values, so that they don't need to be computed every time.
972 # For example, a DiscussionBoard may cache post_count and comment_count otherwise every time the board is
973 # shown it would have to run an SQL query to find how many posts and comments there are.
977 # * +counter_name+ - The name of the field that should be incremented.
978 # * +id+ - The id of the object that should be incremented.
982 # # Increment the post_count column for the record with an id of 5
983 # DiscussionBoard.increment_counter(:post_count, 5)
984 def increment_counter(counter_name
, id
)
985 update_counters(id
, counter_name
=> 1)
988 # Decrement a number field by one, usually representing a count.
990 # This works the same as increment_counter but reduces the column value by 1 instead of increasing it.
994 # * +counter_name+ - The name of the field that should be decremented.
995 # * +id+ - The id of the object that should be decremented.
999 # # Decrement the post_count column for the record with an id of 5
1000 # DiscussionBoard.decrement_counter(:post_count, 5)
1001 def decrement_counter(counter_name
, id
)
1002 update_counters(id
, counter_name
=> -1)
1005 # Attributes named in this macro are protected from mass-assignment,
1006 # such as <tt>new(attributes)</tt>,
1007 # <tt>update_attributes(attributes)</tt>, or
1008 # <tt>attributes=(attributes)</tt>.
1010 # Mass-assignment to these attributes will simply be ignored, to assign
1011 # to them you can use direct writer methods. This is meant to protect
1012 # sensitive attributes from being overwritten by malicious users
1013 # tampering with URLs or forms.
1015 # class Customer < ActiveRecord::Base
1016 # attr_protected :credit_rating
1019 # customer = Customer.new("name" => David, "credit_rating" => "Excellent")
1020 # customer.credit_rating # => nil
1021 # customer.attributes = { "description" => "Jolly fellow", "credit_rating" => "Superb" }
1022 # customer.credit_rating # => nil
1024 # customer.credit_rating = "Average"
1025 # customer.credit_rating # => "Average"
1027 # To start from an all-closed default and enable attributes as needed,
1028 # have a look at +attr_accessible+.
1029 def attr_protected(*attributes
)
1030 write_inheritable_attribute(:attr_protected, Set
.new(attributes
.map(&:to_s)) + (protected_attributes
|| []))
1033 # Returns an array of all the attributes that have been protected from mass-assignment.
1034 def protected_attributes
# :nodoc:
1035 read_inheritable_attribute(:attr_protected)
1038 # Specifies a white list of model attributes that can be set via
1039 # mass-assignment, such as <tt>new(attributes)</tt>,
1040 # <tt>update_attributes(attributes)</tt>, or
1041 # <tt>attributes=(attributes)</tt>
1043 # This is the opposite of the +attr_protected+ macro: Mass-assignment
1044 # will only set attributes in this list, to assign to the rest of
1045 # attributes you can use direct writer methods. This is meant to protect
1046 # sensitive attributes from being overwritten by malicious users
1047 # tampering with URLs or forms. If you'd rather start from an all-open
1048 # default and restrict attributes as needed, have a look at
1051 # class Customer < ActiveRecord::Base
1052 # attr_accessible :name, :nickname
1055 # customer = Customer.new(:name => "David", :nickname => "Dave", :credit_rating => "Excellent")
1056 # customer.credit_rating # => nil
1057 # customer.attributes = { :name => "Jolly fellow", :credit_rating => "Superb" }
1058 # customer.credit_rating # => nil
1060 # customer.credit_rating = "Average"
1061 # customer.credit_rating # => "Average"
1062 def attr_accessible(*attributes
)
1063 write_inheritable_attribute(:attr_accessible, Set
.new(attributes
.map(&:to_s)) + (accessible_attributes
|| []))
1066 # Returns an array of all the attributes that have been made accessible to mass-assignment.
1067 def accessible_attributes
# :nodoc:
1068 read_inheritable_attribute(:attr_accessible)
1071 # Attributes listed as readonly can be set for a new record, but will be ignored in database updates afterwards.
1072 def attr_readonly(*attributes
)
1073 write_inheritable_attribute(:attr_readonly, Set
.new(attributes
.map(&:to_s)) + (readonly_attributes
|| []))
1076 # Returns an array of all the attributes that have been specified as readonly.
1077 def readonly_attributes
1078 read_inheritable_attribute(:attr_readonly)
1081 # If you have an attribute that needs to be saved to the database as an object, and retrieved as the same object,
1082 # then specify the name of that attribute using this method and it will be handled automatically.
1083 # The serialization is done through YAML. If +class_name+ is specified, the serialized object must be of that
1084 # class on retrieval or SerializationTypeMismatch will be raised.
1088 # * +attr_name+ - The field name that should be serialized.
1089 # * +class_name+ - Optional, class name that the object type should be equal to.
1092 # # Serialize a preferences attribute
1094 # serialize :preferences
1096 def serialize(attr_name
, class_name
= Object
)
1097 serialized_attributes
[attr_name
.to_s
] = class_name
1100 # Returns a hash of all the attributes that have been specified for serialization as keys and their class restriction as values.
1101 def serialized_attributes
1102 read_inheritable_attribute(:attr_serialized) or write_inheritable_attribute(:attr_serialized, {})
1105 # Guesses the table name (in forced lower-case) based on the name of the class in the inheritance hierarchy descending
1106 # directly from ActiveRecord::Base. So if the hierarchy looks like: Reply < Message < ActiveRecord::Base, then Message is used
1107 # to guess the table name even when called on Reply. The rules used to do the guess are handled by the Inflector class
1108 # in Active Support, which knows almost all common English inflections. You can add new inflections in config/initializers/inflections.rb.
1110 # Nested classes are given table names prefixed by the singular form of
1111 # the parent's table name. Enclosing modules are not considered.
1115 # class Invoice < ActiveRecord::Base; end;
1116 # file class table_name
1117 # invoice.rb Invoice invoices
1119 # class Invoice < ActiveRecord::Base; class Lineitem < ActiveRecord::Base; end; end;
1120 # file class table_name
1121 # invoice.rb Invoice::Lineitem invoice_lineitems
1123 # module Invoice; class Lineitem < ActiveRecord::Base; end; end;
1124 # file class table_name
1125 # invoice/lineitem.rb Invoice::Lineitem lineitems
1127 # Additionally, the class-level +table_name_prefix+ is prepended and the
1128 # +table_name_suffix+ is appended. So if you have "myapp_" as a prefix,
1129 # the table name guess for an Invoice class becomes "myapp_invoices".
1130 # Invoice::Lineitem becomes "myapp_invoice_lineitems".
1132 # You can also overwrite this class method to allow for unguessable
1133 # links, such as a Mouse class with a link to a "mice" table. Example:
1135 # class Mouse < ActiveRecord::Base
1136 # set_table_name "mice"
1142 def reset_table_name
#:nodoc:
1146 # STI subclasses always use their superclass' table.
1150 # Nested classes are prefixed with singular parent table name.
1151 if parent
< ActiveRecord
::Base && !parent
.abstract_class
?
1152 contained
= parent
.table_name
1153 contained
= contained
.singularize
if parent
.pluralize_table_names
1156 name
= "#{table_name_prefix}#{contained}#{undecorated_table_name(base.name)}#{table_name_suffix}"
1159 set_table_name(name
)
1163 # Defines the primary key field -- can be overridden in subclasses. Overwriting will negate any effect of the
1164 # primary_key_prefix_type setting, though.
1169 def reset_primary_key
#:nodoc:
1170 key
= get_primary_key(base_class
.name
)
1171 set_primary_key(key
)
1175 def get_primary_key(base_name
) #:nodoc:
1177 case primary_key_prefix_type
1179 key
= base_name
.to_s
.foreign_key(false)
1180 when :table_name_with_underscore
1181 key
= base_name
.to_s
.foreign_key
1186 # Defines the column name for use with single table inheritance
1187 # -- can be set in subclasses like so: self.inheritance_column = "type_id"
1188 def inheritance_column
1189 @inheritance_column ||= "type".freeze
1192 # Lazy-set the sequence name to the connection's default. This method
1193 # is only ever called once since set_sequence_name overrides it.
1194 def sequence_name
#:nodoc:
1198 def reset_sequence_name
#:nodoc:
1199 default
= connection
.default_sequence_name(table_name
, primary_key
)
1200 set_sequence_name(default
)
1204 # Sets the table name to use to the given value, or (if the value
1205 # is nil or false) to the value returned by the given block.
1207 # class Project < ActiveRecord::Base
1208 # set_table_name "project"
1210 def set_table_name(value
= nil, &block
)
1211 define_attr_method
:table_name, value
, &block
1213 alias :table_name= :set_table_name
1215 # Sets the name of the primary key column to use to the given value,
1216 # or (if the value is nil or false) to the value returned by the given
1219 # class Project < ActiveRecord::Base
1220 # set_primary_key "sysid"
1222 def set_primary_key(value
= nil, &block
)
1223 define_attr_method
:primary_key, value
, &block
1225 alias :primary_key= :set_primary_key
1227 # Sets the name of the inheritance column to use to the given value,
1228 # or (if the value # is nil or false) to the value returned by the
1231 # class Project < ActiveRecord::Base
1232 # set_inheritance_column do
1233 # original_inheritance_column + "_id"
1236 def set_inheritance_column(value
= nil, &block
)
1237 define_attr_method
:inheritance_column, value
, &block
1239 alias :inheritance_column= :set_inheritance_column
1241 # Sets the name of the sequence to use when generating ids to the given
1242 # value, or (if the value is nil or false) to the value returned by the
1243 # given block. This is required for Oracle and is useful for any
1244 # database which relies on sequences for primary key generation.
1246 # If a sequence name is not explicitly set when using Oracle or Firebird,
1247 # it will default to the commonly used pattern of: #{table_name}_seq
1249 # If a sequence name is not explicitly set when using PostgreSQL, it
1250 # will discover the sequence corresponding to your primary key for you.
1252 # class Project < ActiveRecord::Base
1253 # set_sequence_name "projectseq" # default would have been "project_seq"
1255 def set_sequence_name(value
= nil, &block
)
1256 define_attr_method
:sequence_name, value
, &block
1258 alias :sequence_name= :set_sequence_name
1260 # Turns the +table_name+ back into a class name following the reverse rules of +table_name+.
1261 def class_name(table_name
= table_name
) # :nodoc:
1262 # remove any prefix and/or suffix from the table name
1263 class_name
= table_name
[table_name_prefix
.length
..-(table_name_suffix
.length
+ 1)].camelize
1264 class_name
= class_name
.singularize
if pluralize_table_names
1268 # Indicates whether the table associated with this class exists
1270 connection
.table_exists
?(table_name
)
1273 # Returns an array of column objects for the table associated with this class.
1275 unless defined?(@columns) && @columns
1276 @columns = connection
.columns(table_name
, "#{name} Columns")
1277 @columns.each
{ |column
| column
.primary
= column
.name
== primary_key
}
1282 # Returns a hash of column objects for the table associated with this class.
1284 @columns_hash ||= columns
.inject({}) { |hash
, column
| hash
[column
.name
] = column
; hash
}
1287 # Returns an array of column names as strings.
1289 @column_names ||= columns
.map
{ |column
| column
.name
}
1292 # Returns an array of column objects where the primary id, all columns ending in "_id" or "_count",
1293 # and columns used for single table inheritance have been removed.
1295 @content_columns ||= columns
.reject
{ |c
| c
.primary
|| c
.name
=~
/(_id|_count)$/ || c
.name
== inheritance_column
}
1298 # 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
1299 # 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
1301 def column_methods_hash
#:nodoc:
1302 @dynamic_methods_hash ||= column_names
.inject(Hash
.new(false)) do |methods
, attr
|
1303 attr_name
= attr
.to_s
1304 methods
[attr
.to_sym
] = attr_name
1305 methods
["#{attr}=".to_sym
] = attr_name
1306 methods
["#{attr}?".to_sym
] = attr_name
1307 methods
["#{attr}_before_type_cast".to_sym
] = attr_name
1312 # Resets all the cached information about columns, which will cause them
1313 # to be reloaded on the next request.
1315 # The most common usage pattern for this method is probably in a migration,
1316 # when just after creating a table you want to populate it with some default
1319 # class CreateJobLevels < ActiveRecord::Migration
1321 # create_table :job_levels do |t|
1328 # JobLevel.reset_column_information
1329 # %w{assistant executive manager director}.each do |type|
1330 # JobLevel.create(:name => type)
1335 # drop_table :job_levels
1338 def reset_column_information
1339 generated_methods
.each
{ |name
| undef_method(name
) }
1340 @column_names = @columns = @columns_hash = @content_columns = @dynamic_methods_hash = @generated_methods = @inheritance_column = nil
1343 def reset_column_information_and_inheritable_attributes_for_all_subclasses
#:nodoc:
1344 subclasses
.each
{ |klass
| klass
.reset_inheritable_attributes
; klass
.reset_column_information
}
1347 def self_and_descendants_from_active_record
#nodoc:
1350 while klass
!= klass
.base_class
1351 classes
<< klass
= klass
.superclass
1355 # OPTIMIZE this rescue is to fix this test: ./test/cases/reflection_test.rb:56:in `test_human_name_for_column'
1356 # Appearantly the method base_class causes some trouble.
1357 # It now works for sure.
1361 # Transforms attribute key names into a more humane format, such as "First name" instead of "first_name". Example:
1362 # Person.human_attribute_name("first_name") # => "First name"
1363 # This used to be depricated in favor of humanize, but is now preferred, because it automatically uses the I18n
1365 # Specify +options+ with additional translating options.
1366 def human_attribute_name(attribute_key_name
, options
= {})
1367 defaults
= self_and_descendants_from_active_record
.map
do |klass
|
1368 :"#{klass.name.underscore}.#{attribute_key_name}"
1370 defaults
<< options
[:default] if options
[:default]
1372 defaults
<< attribute_key_name
.humanize
1373 options
[:count] ||= 1
1374 I18n
.translate(defaults
.shift
, options
.merge(:default => defaults
, :scope => [:activerecord, :attributes]))
1377 # Transform the modelname into a more humane format, using I18n.
1378 # Defaults to the basic humanize method.
1379 # Default scope of the translation is activerecord.models
1380 # Specify +options+ with additional translating options.
1381 def human_name(options
= {})
1382 defaults
= self_and_descendants_from_active_record
.map
do |klass
|
1383 :"#{klass.name.underscore}"
1385 defaults
<< self.name
.humanize
1386 I18n
.translate(defaults
.shift
, {:scope => [:activerecord, :models], :count => 1, :default => defaults
}.merge(options
))
1389 # True if this isn't a concrete subclass needing a STI type condition.
1390 def descends_from_active_record
?
1391 if superclass
.abstract_class
?
1392 superclass
.descends_from_active_record
?
1394 superclass
== Base
|| !columns_hash
.include?(inheritance_column
)
1398 def finder_needs_type_condition
? #:nodoc:
1399 # This is like this because benchmarking justifies the strange :false stuff
1400 :true == (@finder_needs_type_condition ||= descends_from_active_record
? ? :false : :true)
1403 # Returns a string like 'Post id:integer, title:string, body:text'
1407 elsif abstract_class
?
1408 "#{super}(abstract)"
1410 attr_list
= columns
.map
{ |c
| "#{c.name}: #{c.type}" } * ', '
1411 "#{super}(#{attr_list})"
1413 "#{super}(Table doesn't exist)"
1417 def quote_value(value
, column
= nil) #:nodoc:
1418 connection
.quote(value
,column
)
1421 # Used to sanitize objects before they're used in an SQL SELECT statement. Delegates to <tt>connection.quote</tt>.
1422 def sanitize(object
) #:nodoc:
1423 connection
.quote(object
)
1426 # Log and benchmark multiple statements in a single block. Example:
1428 # Project.benchmark("Creating project") do
1429 # project = Project.create("name" => "stuff")
1430 # project.create_manager("name" => "David")
1431 # project.milestones << Milestone.find(:all)
1434 # The benchmark is only recorded if the current level of the logger is less than or equal to the <tt>log_level</tt>,
1435 # which makes it easy to include benchmarking statements in production software that will remain inexpensive because
1436 # the benchmark will only be conducted if the log level is low enough.
1438 # The logging of the multiple statements is turned off unless <tt>use_silence</tt> is set to false.
1439 def benchmark(title
, log_level
= Logger
::DEBUG, use_silence
= true)
1440 if logger
&& logger
.level
<= log_level
1442 ms
= Benchmark
.ms
{ result
= use_silence
? silence
{ yield } : yield }
1443 logger
.add(log_level
, '%s (%.1fms)' % [title
, ms
])
1450 # Silences the logger for the duration of the block.
1452 old_logger_level
, logger
.level
= logger
.level
, Logger
::ERROR if logger
1455 logger
.level
= old_logger_level
if logger
1458 # Overwrite the default class equality method to provide support for association proxies.
1463 # Returns the base AR subclass that this class descends from. If A
1464 # extends AR::Base, A.base_class will return A. If B descends from A
1465 # through some arbitrarily deep hierarchy, B.base_class will return A.
1467 class_of_active_record_descendant(self)
1470 # Set this to true if this is an abstract class (see <tt>abstract_class?</tt>).
1471 attr_accessor
:abstract_class
1473 # Returns whether this class is a base AR class. If A is a base class and
1474 # B descends from A, then B.base_class will return B.
1476 defined?(@abstract_class) && @abstract_class == true
1479 def respond_to
?(method_id
, include_private
= false)
1480 if match
= DynamicFinderMatch
.match(method_id
)
1481 return true if all_attributes_exists
?(match
.attribute_names
)
1482 elsif match
= DynamicScopeMatch
.match(method_id
)
1483 return true if all_attributes_exists
?(match
.attribute_names
)
1490 store_full_sti_class
? name
: name
.demodulize
1493 # Merges conditions so that the result is a valid +condition+
1494 def merge_conditions(*conditions
)
1497 conditions
.each
do |condition
|
1498 unless condition
.blank
?
1499 sql
= sanitize_sql(condition
)
1500 segments
<< sql
unless sql
.blank
?
1504 "(#{segments.join(') AND (')})" unless segments
.empty
?
1508 def find_initial(options
)
1509 options
.update(:limit => 1)
1510 find_every(options
).first
1513 def find_last(options
)
1514 order
= options
[:order]
1517 order
= reverse_sql_order(order
)
1518 elsif !scoped
?(:find, :order)
1519 order
= "#{table_name}.#{primary_key} DESC"
1522 if scoped
?(:find, :order)
1523 scope
= scope(:find)
1524 original_scoped_order
= scope
[:order]
1525 scope
[:order] = reverse_sql_order(original_scoped_order
)
1529 find_initial(options
.merge({ :order => order
}))
1531 scope
[:order] = original_scoped_order
if original_scoped_order
1535 def reverse_sql_order(order_query
)
1536 reversed_query
= order_query
.to_s
.split(/,/).each
{ |s
|
1537 if s
.match(/\s(asc|ASC)$/)
1538 s
.gsub
!(/\s(asc|ASC)$/, ' DESC')
1539 elsif s
.match(/\s(desc|DESC)$/)
1540 s
.gsub
!(/\s(desc|DESC)$/, ' ASC')
1541 elsif !s
.match(/\s(asc|ASC|desc|DESC)$/)
1547 def find_every(options
)
1548 include_associations
= merge_includes(scope(:find, :include), options
[:include])
1550 if include_associations
.any
? && references_eager_loaded_tables
?(options
)
1551 records
= find_with_associations(options
)
1553 records
= find_by_sql(construct_finder_sql(options
))
1554 if include_associations
.any
?
1555 preload_associations(records
, include_associations
)
1559 records
.each
{ |record
| record
.readonly
! } if options
[:readonly]
1564 def find_from_ids(ids
, options
)
1565 expects_array
= ids
.first
.kind_of
?(Array
)
1566 return ids
.first
if expects_array
&& ids
.first
.empty
?
1568 ids
= ids
.flatten
.compact
.uniq
1572 raise RecordNotFound
, "Couldn't find #{name} without an ID"
1574 result
= find_one(ids
.first
, options
)
1575 expects_array
? [ result
] : result
1577 find_some(ids
, options
)
1581 def find_one(id
, options
)
1582 conditions
= " AND (#{sanitize_sql(options[:conditions])})" if options
[:conditions]
1583 options
.update
:conditions => "#{quoted_table_name}.#{connection.quote_column_name(primary_key)} = #{quote_value(id,columns_hash[primary_key])}#{conditions}"
1585 # Use find_every(options).first since the primary key condition
1586 # already ensures we have a single record. Using find_initial adds
1587 # a superfluous :limit => 1.
1588 if result
= find_every(options
).first
1591 raise RecordNotFound
, "Couldn't find #{name} with ID=#{id}#{conditions}"
1595 def find_some(ids
, options
)
1596 conditions
= " AND (#{sanitize_sql(options[:conditions])})" if options
[:conditions]
1597 ids_list
= ids
.map
{ |id
| quote_value(id
,columns_hash
[primary_key
]) }.join(',')
1598 options
.update
:conditions => "#{quoted_table_name}.#{connection.quote_column_name(primary_key)} IN (#{ids_list})#{conditions}"
1600 result
= find_every(options
)
1602 # Determine expected size from limit and offset, not just ids.size.
1604 if options
[:limit] && ids
.size
> options
[:limit]
1610 # 11 ids with limit 3, offset 9 should give 2 results.
1611 if options
[:offset] && (ids
.size
- options
[:offset] < expected_size
)
1612 expected_size
= ids
.size
- options
[:offset]
1615 if result
.size
== expected_size
1618 raise RecordNotFound
, "Couldn't find all #{name.pluralize} with IDs (#{ids_list})#{conditions} (found #{result.size} results, but was looking for #{expected_size})"
1622 # Finder methods must instantiate through this method to work with the
1623 # single-table inheritance model that makes it possible to create
1624 # objects of different types from the same table.
1625 def instantiate(record
)
1627 if subclass_name
= record
[inheritance_column
]
1629 if subclass_name
.empty
?
1633 # Ignore type if no column is present since it was probably
1634 # pulled in from a sloppy join.
1635 unless columns_hash
.include?(inheritance_column
)
1640 compute_type(subclass_name
).allocate
1642 raise SubclassNotFound
,
1643 "The single-table inheritance mechanism failed to locate the subclass: '#{record[inheritance_column]}'. " +
1644 "This error is raised because the column '#{inheritance_column}' is reserved for storing the class in case of inheritance. " +
1645 "Please rename this column if you didn't intend it to be used for storing the inheritance class " +
1646 "or overwrite #{self.to_s}.inheritance_column to use another column for that information."
1654 object
.instance_variable_set("@attributes", record
)
1655 object
.instance_variable_set("@attributes_cache", Hash
.new
)
1657 if object
.respond_to_without_attributes
?(:after_find)
1658 object
.send(:callback, :after_find)
1661 if object
.respond_to_without_attributes
?(:after_initialize)
1662 object
.send(:callback, :after_initialize)
1668 # Nest the type name in the same module as this class.
1669 # Bar is "MyApp::Business::Bar" relative to MyApp::Business::Foo
1670 def type_name_with_module(type_name
)
1671 if store_full_sti_class
1674 (/^::/ =~ type_name
) ? type_name
: "#{parent.name}::#{type_name}"
1678 def default_select(qualified
)
1680 quoted_table_name
+ '.*'
1686 def construct_finder_sql(options
)
1687 scope
= scope(:find)
1688 sql
= "SELECT #{options[:select] || (scope && scope[:select]) || default_select(options[:joins] || (scope && scope[:joins]))} "
1689 sql
<< "FROM #{options[:from] || (scope && scope[:from]) || quoted_table_name} "
1691 add_joins
!(sql
, options
[:joins], scope
)
1692 add_conditions
!(sql
, options
[:conditions], scope
)
1694 add_group
!(sql
, options
[:group], options
[:having], scope
)
1695 add_order
!(sql
, options
[:order], scope
)
1696 add_limit
!(sql
, options
, scope
)
1697 add_lock
!(sql
, options
, scope
)
1702 # Merges includes so that the result is a valid +include+
1703 def merge_includes(first
, second
)
1704 (safe_to_array(first
) + safe_to_array(second
)).uniq
1707 def merge_joins(*joins
)
1708 if joins
.any
?{|j
| j
.is_a
?(String
) || array_of_strings
?(j
) }
1709 joins
= joins
.collect
do |join
|
1710 join
= [join
] if join
.is_a
?(String
)
1711 unless array_of_strings
?(join
)
1712 join_dependency
= ActiveRecord
::Associations::ClassMethods::InnerJoinDependency.new(self, join
, nil)
1713 join
= join_dependency
.join_associations
.collect
{ |assoc
| assoc
.association_join
}
1717 joins
.flatten
.map
{|j
| j
.strip
}.uniq
1719 joins
.collect
{|j
| safe_to_array(j
)}.flatten
.uniq
1723 # Object#to_a is deprecated, though it does have the desired behavior
1724 def safe_to_array(o
)
1735 def array_of_strings
?(o
)
1736 o
.is_a
?(Array
) && o
.all
?{|obj
| obj
.is_a
?(String
)}
1739 def add_order
!(sql
, order
, scope
= :auto)
1740 scope
= scope(:find) if :auto == scope
1741 scoped_order
= scope
[:order] if scope
1743 sql
<< " ORDER BY #{order}"
1744 if scoped_order
&& scoped_order
!= order
1745 sql
<< ", #{scoped_order}"
1748 sql
<< " ORDER BY #{scoped_order}" if scoped_order
1752 def add_group
!(sql
, group
, having
, scope
= :auto)
1754 sql
<< " GROUP BY #{group}"
1755 sql
<< " HAVING #{sanitize_sql_for_conditions(having)}" if having
1757 scope
= scope(:find) if :auto == scope
1758 if scope
&& (scoped_group
= scope
[:group])
1759 sql
<< " GROUP BY #{scoped_group}"
1760 sql
<< " HAVING #{sanitize_sql_for_conditions(scope[:having])}" if scope
[:having]
1765 # The optional scope argument is for the current <tt>:find</tt> scope.
1766 def add_limit
!(sql
, options
, scope
= :auto)
1767 scope
= scope(:find) if :auto == scope
1770 options
[:limit] ||= scope
[:limit]
1771 options
[:offset] ||= scope
[:offset]
1774 connection
.add_limit_offset
!(sql
, options
)
1777 # The optional scope argument is for the current <tt>:find</tt> scope.
1778 # The <tt>:lock</tt> option has precedence over a scoped <tt>:lock</tt>.
1779 def add_lock
!(sql
, options
, scope
= :auto)
1780 scope
= scope(:find) if :auto == scope
1781 options
= options
.reverse_merge(:lock => scope
[:lock]) if scope
1782 connection
.add_lock
!(sql
, options
)
1785 # The optional scope argument is for the current <tt>:find</tt> scope.
1786 def add_joins
!(sql
, joins
, scope
= :auto)
1787 scope
= scope(:find) if :auto == scope
1788 merged_joins
= scope
&& scope
[:joins] && joins
? merge_joins(scope
[:joins], joins
) : (joins
|| scope
&& scope
[:joins])
1790 when Symbol
, Hash
, Array
1791 if array_of_strings
?(merged_joins
)
1792 sql
<< merged_joins
.join(' ') + " "
1794 join_dependency
= ActiveRecord
::Associations::ClassMethods::InnerJoinDependency.new(self, merged_joins
, nil)
1795 sql
<< " #{join_dependency.join_associations.collect { |assoc| assoc.association_join }.join} "
1798 sql
<< " #{merged_joins} "
1802 # Adds a sanitized version of +conditions+ to the +sql+ string. Note that the passed-in +sql+ string is changed.
1803 # The optional scope argument is for the current <tt>:find</tt> scope.
1804 def add_conditions
!(sql
, conditions
, scope
= :auto)
1805 scope
= scope(:find) if :auto == scope
1806 conditions
= [conditions
]
1807 conditions
<< scope
[:conditions] if scope
1808 conditions
<< type_condition
if finder_needs_type_condition
?
1809 merged_conditions
= merge_conditions(*conditions
)
1810 sql
<< "WHERE #{merged_conditions} " unless merged_conditions
.blank
?
1813 def type_condition(table_alias
=nil)
1814 quoted_table_alias
= self.connection
.quote_table_name(table_alias
|| table_name
)
1815 quoted_inheritance_column
= connection
.quote_column_name(inheritance_column
)
1816 type_condition
= subclasses
.inject("#{quoted_table_alias}.#{quoted_inheritance_column} = '#{sti_name}' ") do |condition
, subclass
|
1817 condition
<< "OR #{quoted_table_alias}.#{quoted_inheritance_column} = '#{subclass.sti_name}' "
1820 " (#{type_condition}) "
1823 # Guesses the table name, but does not decorate it with prefix and suffix information.
1824 def undecorated_table_name(class_name
= base_class
.name
)
1825 table_name
= class_name
.to_s
.demodulize
.underscore
1826 table_name
= table_name
.pluralize
if pluralize_table_names
1830 # Enables dynamic finders like <tt>find_by_user_name(user_name)</tt> and <tt>find_by_user_name_and_password(user_name, password)</tt>
1831 # that are turned into <tt>find(:first, :conditions => ["user_name = ?", user_name])</tt> and
1832 # <tt>find(:first, :conditions => ["user_name = ? AND password = ?", user_name, password])</tt> respectively. Also works for
1833 # <tt>find(:all)</tt> by using <tt>find_all_by_amount(50)</tt> that is turned into <tt>find(:all, :conditions => ["amount = ?", 50])</tt>.
1835 # It's even possible to use all the additional parameters to +find+. For example, the full interface for +find_all_by_amount+
1836 # is actually <tt>find_all_by_amount(amount, options)</tt>.
1838 # Also enables dynamic scopes like scoped_by_user_name(user_name) and scoped_by_user_name_and_password(user_name, password) that
1839 # are turned into scoped(:conditions => ["user_name = ?", user_name]) and scoped(:conditions => ["user_name = ? AND password = ?", user_name, password])
1842 # Each dynamic finder, scope or initializer/creator is also defined in the class after it is first invoked, so that future
1843 # attempts to use it do not run through method_missing.
1844 def method_missing(method_id
, *arguments
, &block
)
1845 if match
= DynamicFinderMatch
.match(method_id
)
1846 attribute_names
= match
.attribute_names
1847 super unless all_attributes_exists
?(attribute_names
)
1849 finder
= match
.finder
1851 # def self.find_by_login_and_activated(*args)
1852 # options = args.extract_options!
1853 # attributes = construct_attributes_from_arguments(
1854 # [:login,:activated],
1857 # finder_options = { :conditions => attributes }
1858 # validate_find_options(options)
1859 # set_readonly_option!(options)
1861 # if options[:conditions]
1862 # with_scope(:find => finder_options) do
1863 # find(:first, options)
1866 # find(:first, options.merge(finder_options))
1870 def self.#{method_id}(*args)
1871 options = args.extract_options!
1872 attributes = construct_attributes_from_arguments(
1873 [:#{attribute_names.join(',:')}],
1876 finder_options = { :conditions => attributes }
1877 validate_find_options(options)
1878 set_readonly_option!(options)
1880 #{'result = ' if bang}if options[:conditions]
1881 with_scope(:find => finder_options) do
1882 find(:#{finder}, options)
1885 find(:#{finder}, options.merge(finder_options))
1887 #{'result || raise(RecordNotFound, "Couldn\'t find #{name} with #{attributes.to_a.collect {|pair| "#{pair.first} = #{pair.second}"}.join(\', \')}")' if bang}
1889 }, __FILE__, __LINE__
1890 send(method_id, *arguments)
1891 elsif match.instantiator?
1892 instantiator = match.instantiator
1893 # def self.find_or_create_by_user_id(*args)
1894 # guard_protected_attributes = false
1896 # if args[0].is_a?(Hash)
1897 # guard_protected_attributes = true
1898 # attributes = args[0].with_indifferent_access
1899 # find_attributes = attributes.slice(*[:user_id])
1901 # find_attributes = attributes = construct_attributes_from_arguments([:user_id], args)
1904 # options = { :conditions => find_attributes }
1905 # set_readonly_option!(options)
1907 # record = find(:first, options)
1910 # record = self.new { |r| r.send(:attributes=, attributes, guard_protected_attributes) }
1911 # yield(record) if block_given?
1919 def self.#{method_id}(*args)
1920 guard_protected_attributes = false
1922 if args[0].is_a?(Hash)
1923 guard_protected_attributes = true
1924 attributes = args[0].with_indifferent_access
1925 find_attributes = attributes.slice(*[:#{attribute_names.join(',:')}])
1927 find_attributes = attributes = construct_attributes_from_arguments([:#{attribute_names.join(',:')}], args)
1930 options = { :conditions => find_attributes }
1931 set_readonly_option!(options)
1933 record = find(:first, options)
1936 record = self.new { |r| r.send(:attributes=, attributes, guard_protected_attributes) }
1937 #{'yield(record) if block_given?'}
1938 #{'record.save' if instantiator == :create}
1944 }, __FILE__, __LINE__
1945 send(method_id, *arguments, &block)
1947 elsif match = DynamicScopeMatch.match(method_id)
1948 attribute_names = match.attribute_names
1949 super unless all_attributes_exists?(attribute_names)
1952 def self.#{method_id}(*args) # def self.scoped_by_user_name_and_password(*args)
1953 options = args.extract_options! # options = args.extract_options!
1954 attributes = construct_attributes_from_arguments( # attributes = construct_attributes_from_arguments(
1955 [:#{attribute_names.join(',:')}], args # [:user_name, :password], args
1958 scoped(:conditions => attributes) # scoped(:conditions => attributes)
1960 }, __FILE__, __LINE__
1961 send(method_id, *arguments)
1968 def construct_attributes_from_arguments(attribute_names, arguments)
1970 attribute_names.each_with_index { |name, idx| attributes[name] = arguments[idx] }
1974 # Similar in purpose to +expand_hash_conditions_for_aggregates+.
1975 def expand_attribute_names_for_aggregates(attribute_names)
1976 expanded_attribute_names = []
1977 attribute_names.each do |attribute_name|
1978 unless (aggregation = reflect_on_aggregation(attribute_name.to_sym)).nil?
1979 aggregate_mapping(aggregation).each do |field_attr, aggregate_attr|
1980 expanded_attribute_names << field_attr
1983 expanded_attribute_names << attribute_name
1986 expanded_attribute_names
1989 def all_attributes_exists?(attribute_names)
1990 attribute_names = expand_attribute_names_for_aggregates(attribute_names)
1991 attribute_names.all? { |name| column_methods_hash.include?(name.to_sym) }
1994 def attribute_condition(quoted_column_name, argument)
1996 when nil then "#{quoted_column_name} IS ?"
1997 when Array, ActiveRecord::Associations::AssociationCollection, ActiveRecord::NamedScope::Scope then "#{quoted_column_name} IN (?)"
1998 when Range then if argument.exclude_end?
1999 "#{quoted_column_name} >= ? AND #{quoted_column_name} < ?"
2001 "#{quoted_column_name} BETWEEN ? AND ?"
2003 else "#{quoted_column_name} = ?"
2007 # Interpret Array and Hash as conditions and anything else as an id.
2008 def expand_id_conditions(id_or_conditions)
2009 case id_or_conditions
2010 when Array, Hash then id_or_conditions
2011 else sanitize_sql(primary_key => id_or_conditions)
2015 # Defines an "attribute" method (like +inheritance_column+ or
2016 # +table_name+). A new (class) method will be created with the
2017 # given name. If a value is specified, the new method will
2018 # return that value (as a string). Otherwise, the given block
2019 # will be used to compute the value of the method.
2021 # The original method will be aliased, with the new name being
2022 # prefixed with "original_". This allows the new method to
2023 # access the original value.
2027 # class A < ActiveRecord::Base
2028 # define_attr_method :primary_key, "sysid"
2029 # define_attr_method( :inheritance_column ) do
2030 # original_inheritance_column + "_id"
2033 def define_attr_method(name, value=nil, &block)
2034 sing = class << self; self; end
2035 sing.send :alias_method, "original_#{name}", name
2037 sing.send :define_method, name, &block
2039 # use eval instead of a block to work around a memory leak in dev
2041 sing.class_eval "def #{name}; #{value.to_s.inspect}; end"
2046 # Scope parameters to method calls within the block. Takes a hash of method_name => parameters hash.
2047 # method_name may be <tt>:find</tt> or <tt>:create</tt>. <tt>:find</tt> parameters may include the <tt>:conditions</tt>, <tt>:joins</tt>,
2048 # <tt>:include</tt>, <tt>:offset</tt>, <tt>:limit</tt>, and <tt>:readonly</tt> options. <tt>:create</tt> parameters are an attributes hash.
2050 # class Article < ActiveRecord::Base
2051 # def self.create_with_scope
2052 # with_scope(:find => { :conditions => "blog_id = 1" }, :create => { :blog_id => 1 }) do
2053 # find(1) # => SELECT * from articles WHERE blog_id = 1 AND id = 1
2060 # In nested scopings, all previous parameters are overwritten by the innermost rule, with the exception of
2061 # <tt>:conditions</tt>, <tt>:include</tt>, and <tt>:joins</tt> options in <tt>:find</tt>, which are merged.
2063 # <tt>:joins</tt> options are uniqued so multiple scopes can join in the same table without table aliasing
2064 # problems. If you need to join multiple tables, but still want one of the tables to be uniqued, use the
2065 # array of strings format for your joins.
2067 # class Article < ActiveRecord::Base
2068 # def self.find_with_scope
2069 # with_scope(:find => { :conditions => "blog_id = 1", :limit => 1 }, :create => { :blog_id => 1 }) do
2070 # with_scope(:find => { :limit => 10 })
2071 # find(:all) # => SELECT * from articles WHERE blog_id = 1 LIMIT 10
2073 # with_scope(:find => { :conditions => "author_id = 3" })
2074 # find(:all) # => SELECT * from articles WHERE blog_id = 1 AND author_id = 3 LIMIT 1
2080 # You can ignore any previous scopings by using the <tt>with_exclusive_scope</tt> method.
2082 # class Article < ActiveRecord::Base
2083 # def self.find_with_exclusive_scope
2084 # with_scope(:find => { :conditions => "blog_id = 1", :limit => 1 }) do
2085 # with_exclusive_scope(:find => { :limit => 10 })
2086 # find(:all) # => SELECT * from articles LIMIT 10
2092 # *Note*: the +:find+ scope also has effect on update and deletion methods,
2093 # like +update_all+ and +delete_all+.
2094 def with_scope(method_scoping = {}, action = :merge, &block)
2095 method_scoping = method_scoping.method_scoping if method_scoping.respond_to?(:method_scoping)
2097 # Dup first and second level of hash (method and params).
2098 method_scoping = method_scoping.inject({}) do |hash, (method, params)|
2099 hash[method] = (params == true) ? params : params.dup
2103 method_scoping.assert_valid_keys([ :find, :create ])
2105 if f = method_scoping[:find]
2106 f.assert_valid_keys(VALID_FIND_OPTIONS)
2107 set_readonly_option! f
2111 if [:merge, :reverse_merge].include?(action) && current_scoped_methods
2112 method_scoping = current_scoped_methods.inject(method_scoping) do |hash, (method, params)|
2116 (hash[method].keys + params.keys).uniq.each do |key|
2117 merge = hash[method][key] && params[key] # merge if both scopes have the same key
2118 if key == :conditions && merge
2119 if params[key].is_a?(Hash) && hash[method][key].is_a?(Hash)
2120 hash[method][key] = merge_conditions(hash[method][key].deep_merge(params[key]))
2122 hash[method][key] = merge_conditions(params[key], hash[method][key])
2124 elsif key == :include && merge
2125 hash[method][key] = merge_includes(hash[method][key], params[key]).uniq
2126 elsif key == :joins && merge
2127 hash[method][key] = merge_joins(params[key], hash[method][key])
2129 hash[method][key] = hash[method][key] || params[key]
2133 if action == :reverse_merge
2134 hash[method] = hash[method].merge(params)
2136 hash[method] = params.merge(hash[method])
2140 hash[method] = params
2146 self.scoped_methods << method_scoping
2150 self.scoped_methods.pop
2154 # Works like with_scope, but discards any nested properties.
2155 def with_exclusive_scope(method_scoping = {}, &block)
2156 with_scope(method_scoping, :overwrite, &block)
2159 def subclasses #:nodoc:
2160 @@subclasses[self] ||= []
2161 @@subclasses[self] + extra = @@subclasses[self].inject([]) {|list, subclass| list + subclass.subclasses }
2164 # Sets the default options for the model. The format of the
2165 # <tt>options</tt> argument is the same as in find.
2167 # class Person < ActiveRecord::Base
2168 # default_scope :order => 'last_name, first_name'
2170 def default_scope(options = {})
2171 self.default_scoping << { :find => options, :create => (options.is_a?(Hash) && options.has_key?(:conditions)) ? options[:conditions] : {} }
2174 # Test whether the given method and optional key are scoped.
2175 def scoped?(method, key = nil) #:nodoc:
2176 if current_scoped_methods && (scope = current_scoped_methods[method])
2177 !key || !scope[key].nil?
2181 # Retrieve the scope for the given method and optional key.
2182 def scope(method, key = nil) #:nodoc:
2183 if current_scoped_methods && (scope = current_scoped_methods[method])
2184 key ? scope[key] : scope
2188 def scoped_methods #:nodoc:
2189 Thread.current[:"#{self}_scoped_methods"] ||= self.default_scoping.dup
2192 def current_scoped_methods #:nodoc:
2196 # Returns the class type of the record using the current module as a prefix. So descendants of
2197 # MyApp::Business::Account would appear as MyApp::Business::AccountSubclass.
2198 def compute_type(type_name)
2199 modularized_name = type_name_with_module(type_name)
2202 class_eval(modularized_name, __FILE__, __LINE__)
2204 class_eval(type_name, __FILE__, __LINE__)
2209 # Returns the class descending directly from ActiveRecord::Base or an
2210 # abstract class, if any, in the inheritance hierarchy.
2211 def class_of_active_record_descendant(klass)
2212 if klass.superclass == Base || klass.superclass.abstract_class?
2214 elsif klass.superclass.nil?
2215 raise ActiveRecordError, "#{name} doesn't belong in a hierarchy descending from ActiveRecord"
2217 class_of_active_record_descendant(klass.superclass)
2221 # Returns the name of the class descending directly from Active Record in the inheritance hierarchy.
2222 def class_name_of_active_record_descendant(klass) #:nodoc:
2223 klass.base_class.name
2226 # Accepts an array, hash, or string of SQL conditions and sanitizes
2227 # them into a valid SQL fragment for a WHERE clause.
2228 # ["name='%s' and group_id='%s'", "foo'bar", 4] returns "name='foo''bar' and group_id='4'"
2229 # { :name => "foo'bar", :group_id => 4 } returns "name='foo''bar' and group_id='4'"
2230 # "name='foo''bar' and group_id='4'" returns "name='foo''bar' and group_id='4'"
2231 def sanitize_sql_for_conditions(condition)
2232 return nil if condition.blank?
2235 when Array; sanitize_sql_array(condition)
2236 when Hash; sanitize_sql_hash_for_conditions(condition)
2240 alias_method :sanitize_sql, :sanitize_sql_for_conditions
2242 # Accepts an array, hash, or string of SQL conditions and sanitizes
2243 # them into a valid SQL fragment for a SET clause.
2244 # { :name => nil, :group_id => 4 } returns "name = NULL , group_id='4'"
2245 def sanitize_sql_for_assignment(assignments)
2247 when Array; sanitize_sql_array(assignments)
2248 when Hash; sanitize_sql_hash_for_assignment(assignments)
2253 def aggregate_mapping(reflection)
2254 mapping = reflection.options[:mapping] || [reflection.name, reflection.name]
2255 mapping.first.is_a?(Array) ? mapping : [mapping]
2258 # Accepts a hash of SQL conditions and replaces those attributes
2259 # that correspond to a +composed_of+ relationship with their expanded
2260 # aggregate attribute values.
2262 # class Person < ActiveRecord::Base
2263 # composed_of :address, :class_name => "Address",
2264 # :mapping => [%w(address_street street), %w(address_city city)]
2267 # { :address => Address.new("813 abc st.", "chicago") }
2268 # # => { :address_street => "813 abc st.", :address_city => "chicago" }
2269 def expand_hash_conditions_for_aggregates(attrs)
2271 attrs.each do |attr, value|
2272 unless (aggregation = reflect_on_aggregation(attr.to_sym)).nil?
2273 mapping = aggregate_mapping(aggregation)
2274 mapping.each do |field_attr, aggregate_attr|
2275 if mapping.size == 1 && !value.respond_to?(aggregate_attr)
2276 expanded_attrs[field_attr] = value
2278 expanded_attrs[field_attr] = value.send(aggregate_attr)
2282 expanded_attrs[attr] = value
2288 # Sanitizes a hash of attribute/value pairs into SQL conditions for a WHERE clause.
2289 # { :name => "foo'bar", :group_id => 4 }
2290 # # => "name='foo''bar' and group_id= 4"
2291 # { :status => nil, :group_id => [1,2,3] }
2292 # # => "status IS NULL and group_id IN (1,2,3)"
2293 # { :age => 13..18 }
2294 # # => "age BETWEEN 13 AND 18"
2295 # { 'other_records.id' => 7 }
2296 # # => "`other_records`.`id` = 7"
2297 # { :other_records => { :id => 7 } }
2298 # # => "`other_records`.`id` = 7"
2299 # And for value objects on a composed_of relationship:
2300 # { :address => Address.new("123 abc st.", "chicago") }
2301 # # => "address_street='123 abc st.' and address_city='chicago'"
2302 def sanitize_sql_hash_for_conditions(attrs, table_name = quoted_table_name)
2303 attrs = expand_hash_conditions_for_aggregates(attrs)
2305 conditions = attrs.map do |attr, value|
2306 unless value.is_a?(Hash)
2309 # Extract table name from qualified attribute names.
2310 if attr.include?('.')
2311 table_name, attr = attr.split('.', 2)
2312 table_name = connection.quote_table_name(table_name)
2315 attribute_condition("#{table_name}.#{connection.quote_column_name(attr)}", value)
2317 sanitize_sql_hash_for_conditions(value, connection.quote_table_name(attr.to_s))
2321 replace_bind_variables(conditions, expand_range_bind_variables(attrs.values))
2323 alias_method :sanitize_sql_hash, :sanitize_sql_hash_for_conditions
2325 # Sanitizes a hash of attribute/value pairs into SQL conditions for a SET clause.
2326 # { :status => nil, :group_id => 1 }
2327 # # => "status = NULL , group_id = 1"
2328 def sanitize_sql_hash_for_assignment(attrs)
2329 attrs.map do |attr, value|
2330 "#{connection.quote_column_name(attr)} = #{quote_bound_value(value)}"
2334 # Accepts an array of conditions. The array has each value
2335 # sanitized and interpolated into the SQL statement.
2336 # ["name='%s' and group_id='%s'", "foo'bar", 4] returns "name='foo''bar' and group_id='4'"
2337 def sanitize_sql_array(ary)
2338 statement, *values = ary
2339 if values.first.is_a?(Hash) and statement =~ /:\w+/
2340 replace_named_bind_variables(statement, values.first)
2341 elsif statement.include?('?')
2342 replace_bind_variables(statement, values)
2344 statement % values.collect { |value| connection.quote_string(value.to_s) }
2348 alias_method :sanitize_conditions, :sanitize_sql
2350 def replace_bind_variables(statement, values) #:nodoc:
2351 raise_if_bind_arity_mismatch(statement, statement.count('?'), values.size)
2353 statement.gsub('?') { quote_bound_value(bound.shift) }
2356 def replace_named_bind_variables(statement, bind_vars) #:nodoc:
2357 statement.gsub(/(:?):([a-zA-Z]\w*)/) do
2358 if $1 == ':' # skip postgresql casts
2359 $& # return the whole match
2360 elsif bind_vars.include?(match = $2.to_sym)
2361 quote_bound_value(bind_vars[match])
2363 raise PreparedStatementInvalid, "missing value for :#{match} in #{statement}"
2368 def expand_range_bind_variables(bind_vars) #:nodoc:
2371 bind_vars.each do |var|
2372 next if var.is_a?(Hash)
2375 expanded << var.first
2376 expanded << var.last
2385 def quote_bound_value(value) #:nodoc:
2386 if value.respond_to?(:map) && !value.acts_like?(:string)
2387 if value.respond_to?(:empty?) && value.empty?
2388 connection.quote(nil)
2390 value.map { |v| connection.quote(v) }.join(',')
2393 connection.quote(value)
2397 def raise_if_bind_arity_mismatch(statement, expected, provided) #:nodoc:
2398 unless expected == provided
2399 raise PreparedStatementInvalid, "wrong number of bind variables (#{provided} for #{expected}) in: #{statement}"
2403 VALID_FIND_OPTIONS = [ :conditions, :include, :joins, :limit, :offset,
2404 :order, :select, :readonly, :group, :having, :from, :lock ]
2406 def validate_find_options(options) #:nodoc:
2407 options.assert_valid_keys(VALID_FIND_OPTIONS)
2410 def set_readonly_option!(options) #:nodoc:
2411 # Inherit :readonly from finder scope if set. Otherwise,
2412 # if :joins is not blank then :readonly defaults to true.
2413 unless options.has_key?(:readonly)
2414 if scoped_readonly = scope(:find, :readonly)
2415 options[:readonly] = scoped_readonly
2416 elsif !options[:joins].blank? && !options[:select]
2417 options[:readonly] = true
2422 def encode_quoted_value(value) #:nodoc:
2423 quoted_value = connection.quote(value)
2424 quoted_value = "'#{quoted_value[1..-2].gsub(/\'/, "\\\\'")}'" if quoted_value.include?("\\\'") # (for ruby mode) "
2430 # New objects can be instantiated as either empty (pass no construction parameter) or pre-set with
2431 # attributes but not yet saved (pass a hash with key names matching the associated table column names).
2432 # In both instances, valid attribute keys are determined by the column names of the associated table --
2433 # hence you can't have attributes that aren't part of the table columns.
2434 def initialize(attributes = nil)
2435 @attributes = attributes_from_column_definition
2436 @attributes_cache = {}
2439 self.attributes = attributes unless attributes.nil?
2440 self.class.send(:scope, :create).each { |att,value| self.send("#{att}=", value) } if self.class.send(:scoped?, :create)
2441 result = yield self if block_given?
2442 callback(:after_initialize) if respond_to_without_attributes?(:after_initialize)
2446 # A model instance's primary key is always available as model.id
2447 # whether you name it the default 'id' or set it to something else.
2449 attr_name = self.class.primary_key
2450 column = column_for_attribute(attr_name)
2452 self.class.send(:define_read_method, :id, attr_name, column)
2453 # now that the method exists, call it
2454 self.send attr_name.to_sym
2458 # Returns a String, which Action Pack uses for constructing an URL to this
2459 # object. The default implementation returns this record's id as a String,
2460 # or nil if this record's unsaved.
2462 # For example, suppose that you have a User model, and that you have a
2463 # <tt>map.resources :users</tt> route. Normally, +user_path+ will
2464 # construct a path with the user object's 'id' in it:
2466 # user = User.find_by_name('Phusion')
2467 # user_path(user) # => "/users/1"
2469 # You can override +to_param+ in your model to make +user_path+ construct
2470 # a path using the user's name instead of the user's id:
2472 # class User < ActiveRecord::Base
2473 # def to_param # overridden
2478 # user = User.find_by_name('Phusion')
2479 # user_path(user) # => "/users/Phusion"
2481 # We can't use alias_method here, because method 'id' optimizes itself on the fly.
2482 (id = self.id) ? id.to_s : nil # Be sure to stringify the id for routes
2485 # Returns a cache key that can be used to identify this record.
2489 # Product.new.cache_key # => "products/new"
2490 # Product.find(5).cache_key # => "products/5" (updated_at not available)
2491 # Person.find(5).cache_key # => "people/5-20071224150000" (updated_at available)
2495 "#{self.class.model_name.cache_key}/new"
2496 when timestamp = self[:updated_at]
2497 "#{self.class.model_name.cache_key}/#{id}-#{timestamp.to_s(:number)}"
2499 "#{self.class.model_name.cache_key}/#{id}"
2503 def id_before_type_cast #:nodoc:
2504 read_attribute_before_type_cast(self.class.primary_key)
2507 def quoted_id #:nodoc:
2508 quote_value(id, column_for_attribute(self.class.primary_key))
2511 # Sets the primary ID.
2513 write_attribute(self.class.primary_key, value)
2516 # Returns true if this object hasn't been saved yet -- that is, a record for the object doesn't exist yet; otherwise, returns false.
2518 @new_record || false
2522 # save(perform_validation = true)
2526 # If the model is new a record gets created in the database, otherwise
2527 # the existing record gets updated.
2529 # If +perform_validation+ is true validations run. If any of them fail
2530 # the action is cancelled and +save+ returns +false+. If the flag is
2531 # false validations are bypassed altogether. See
2532 # ActiveRecord::Validations for more information.
2534 # There's a series of callbacks associated with +save+. If any of the
2535 # <tt>before_*</tt> callbacks return +false+ the action is cancelled and
2536 # +save+ returns +false+. See ActiveRecord::Callbacks for further
2544 # If the model is new a record gets created in the database, otherwise
2545 # the existing record gets updated.
2547 # With <tt>save!</tt> validations always run. If any of them fail
2548 # ActiveRecord::RecordInvalid gets raised. See ActiveRecord::Validations
2549 # for more information.
2551 # There's a series of callbacks associated with <tt>save!</tt>. If any of
2552 # the <tt>before_*</tt> callbacks return +false+ the action is cancelled
2553 # and <tt>save!</tt> raises ActiveRecord::RecordNotSaved. See
2554 # ActiveRecord::Callbacks for further details.
2556 create_or_update || raise(RecordNotSaved)
2559 # Deletes the record in the database and freezes this instance to
2560 # reflect that no changes should be made (since they can't be
2561 # persisted). Returns the frozen instance.
2563 # The row is simply removed with a SQL +DELETE+ statement on the
2564 # record's primary key, and no callbacks are executed.
2566 # To enforce the object's +before_destroy+ and +after_destroy+
2567 # callbacks, Observer methods, or any <tt>:dependent</tt> association
2568 # options, use <tt>#destroy</tt>.
2570 self.class.delete(id) unless new_record?
2574 # Deletes the record in the database and freezes this instance to reflect that no changes should
2575 # be made (since they can't be persisted).
2579 "DELETE FROM #{self.class.quoted_table_name} " +
2580 "WHERE #{connection.quote_column_name(self.class.primary_key)} = #{quoted_id}",
2581 "#{self.class.name} Destroy"
2588 # Returns a clone of the record that hasn't been assigned an id yet and
2589 # is treated as a new record. Note that this is a "shallow" clone:
2590 # it copies the object's attributes only, not its associations.
2591 # The extent of a "deep" clone is application-specific and is therefore
2592 # left to the application to implement according to its need.
2594 attrs = clone_attributes(:read_attribute_before_type_cast)
2595 attrs.delete(self.class.primary_key)
2596 record = self.class.new
2597 record.send :instance_variable_set, '@attributes', attrs
2601 # Returns an instance of the specified +klass+ with the attributes of the current record. This is mostly useful in relation to
2602 # single-table inheritance structures where you want a subclass to appear as the superclass. This can be used along with record
2603 # identification in Action Pack to allow, say, <tt>Client < Company</tt> to do something like render <tt>:partial => @client.becomes(Company)</tt>
2604 # to render that instance using the companies/company partial instead of clients/client.
2606 # Note: The new instance will share a link to the same attributes as the original class. So any change to the attributes in either
2607 # instance will affect the other.
2609 returning klass.new do |became|
2610 became.instance_variable_set("@attributes", @attributes)
2611 became.instance_variable_set("@attributes_cache", @attributes_cache)
2612 became.instance_variable_set("@new_record", new_record?)
2616 # Updates a single attribute and saves the record without going through the normal validation procedure.
2617 # This is especially useful for boolean flags on existing records. The regular +update_attribute+ method
2618 # in Base is replaced with this when the validations module is mixed in, which it is by default.
2619 def update_attribute(name, value)
2620 send(name.to_s + '=', value)
2624 # Updates all the attributes from the passed-in Hash and saves the record. If the object is invalid, the saving will
2625 # fail and false will be returned.
2626 def update_attributes(attributes)
2627 self.attributes = attributes
2631 # Updates an object just like Base.update_attributes but calls save! instead of save so an exception is raised if the record is invalid.
2632 def update_attributes!(attributes)
2633 self.attributes = attributes
2637 # Initializes +attribute+ to zero if +nil+ and adds the value passed as +by+ (default is 1).
2638 # The increment is performed directly on the underlying attribute, no setter is invoked.
2639 # Only makes sense for number-based attributes. Returns +self+.
2640 def increment(attribute, by = 1)
2641 self[attribute] ||= 0
2642 self[attribute] += by
2646 # Wrapper around +increment+ that saves the record. This method differs from
2647 # its non-bang version in that it passes through the attribute setter.
2648 # Saving is not subjected to validation checks. Returns +true+ if the
2649 # record could be saved.
2650 def increment!(attribute, by = 1)
2651 increment(attribute, by).update_attribute(attribute, self[attribute])
2654 # Initializes +attribute+ to zero if +nil+ and subtracts the value passed as +by+ (default is 1).
2655 # The decrement is performed directly on the underlying attribute, no setter is invoked.
2656 # Only makes sense for number-based attributes. Returns +self+.
2657 def decrement(attribute, by = 1)
2658 self[attribute] ||= 0
2659 self[attribute] -= by
2663 # Wrapper around +decrement+ that saves the record. This method differs from
2664 # its non-bang version in that it passes through the attribute setter.
2665 # Saving is not subjected to validation checks. Returns +true+ if the
2666 # record could be saved.
2667 def decrement!(attribute, by = 1)
2668 decrement(attribute, by).update_attribute(attribute, self[attribute])
2671 # Assigns to +attribute+ the boolean opposite of <tt>attribute?</tt>. So
2672 # if the predicate returns +true+ the attribute will become +false+. This
2673 # method toggles directly the underlying value without calling any setter.
2675 def toggle(attribute)
2676 self[attribute] = !send("#{attribute}?")
2680 # Wrapper around +toggle+ that saves the record. This method differs from
2681 # its non-bang version in that it passes through the attribute setter.
2682 # Saving is not subjected to validation checks. Returns +true+ if the
2683 # record could be saved.
2684 def toggle!(attribute)
2685 toggle(attribute).update_attribute(attribute, self[attribute])
2688 # Reloads the attributes of this object from the database.
2689 # The optional options argument is passed to find when reloading so you
2690 # may do e.g. record.reload(:lock => true) to reload the same record with
2691 # an exclusive row lock.
2692 def reload(options = nil)
2693 clear_aggregation_cache
2694 clear_association_cache
2695 @attributes.update(self.class.find(self.id, options).instance_variable_get('@attributes'))
2696 @attributes_cache = {}
2700 # Returns the value of the attribute identified by <tt>attr_name</tt> after it has been typecast (for example,
2701 # "2004-12-12" in a data column is cast to a date object, like Date.new(2004, 12, 12)).
2702 # (Alias for the protected read_attribute method).
2704 read_attribute(attr_name)
2707 # Updates the attribute identified by <tt>attr_name</tt> with the specified +value+.
2708 # (Alias for the protected write_attribute method).
2709 def []=(attr_name, value)
2710 write_attribute(attr_name, value)
2713 # Allows you to set all the attributes at once by passing in a hash with keys
2714 # matching the attribute names (which again matches the column names).
2716 # If +guard_protected_attributes+ is true (the default), then sensitive
2717 # attributes can be protected from this form of mass-assignment by using
2718 # the +attr_protected+ macro. Or you can alternatively specify which
2719 # attributes *can* be accessed with the +attr_accessible+ macro. Then all the
2720 # attributes not included in that won't be allowed to be mass-assigned.
2722 # class User < ActiveRecord::Base
2723 # attr_protected :is_admin
2727 # user.attributes = { :username => 'Phusion', :is_admin => true }
2728 # user.username # => "Phusion"
2729 # user.is_admin? # => false
2731 # user.send(:attributes=, { :username => 'Phusion', :is_admin => true }, false)
2732 # user.is_admin? # => true
2733 def attributes=(new_attributes, guard_protected_attributes = true)
2734 return if new_attributes.nil?
2735 attributes = new_attributes.dup
2736 attributes.stringify_keys!
2738 multi_parameter_attributes = []
2739 attributes = remove_attributes_protected_from_mass_assignment(attributes) if guard_protected_attributes
2741 attributes.each do |k, v|
2743 multi_parameter_attributes << [ k, v ]
2745 respond_to?(:"#{k}=") ? send(:"#{k}=", v) : raise(UnknownAttributeError, "unknown attribute: #{k}")
2749 assign_multiparameter_attributes(multi_parameter_attributes)
2752 # Returns a hash of all the attributes with their names as keys and the values of the attributes as values.
2754 self.attribute_names.inject({}) do |attrs, name|
2755 attrs[name] = read_attribute(name)
2760 # Returns a hash of attributes before typecasting and deserialization.
2761 def attributes_before_type_cast
2762 self.attribute_names.inject({}) do |attrs, name|
2763 attrs[name] = read_attribute_before_type_cast(name)
2768 # Returns an <tt>#inspect</tt>-like string for the value of the
2769 # attribute +attr_name+. String attributes are elided after 50
2770 # characters, and Date and Time attributes are returned in the
2771 # <tt>:db</tt> format. Other attributes return the value of
2772 # <tt>#inspect</tt> without modification.
2774 # person = Person.create!(:name => "David Heinemeier Hansson " * 3)
2776 # person.attribute_for_inspect(:name)
2777 # # => '"David Heinemeier Hansson David Heinemeier Hansson D..."'
2779 # person.attribute_for_inspect(:created_at)
2780 # # => '"2009-01-12 04:48:57"'
2781 def attribute_for_inspect(attr_name)
2782 value = read_attribute(attr_name)
2784 if value.is_a?(String) && value.length > 50
2785 "#{value[0..50]}...".inspect
2786 elsif value.is_a?(Date) || value.is_a?(Time)
2787 %("#{value.to_s(:db)}")
2793 # Returns true if the specified +attribute+ has been set by the user or by a database load and is neither
2794 # nil nor empty? (the latter only applies to objects that respond to empty?, most notably Strings).
2795 def attribute_present?(attribute)
2796 value = read_attribute(attribute)
2800 # Returns true if the given attribute is in the attributes hash
2801 def has_attribute?(attr_name)
2802 @attributes.has_key?(attr_name.to_s)
2805 # Returns an array of names for the attributes available on this object sorted alphabetically.
2807 @attributes.keys.sort
2810 # Returns the column object for the named attribute.
2811 def column_for_attribute(name)
2812 self.class.columns_hash[name.to_s]
2815 # Returns true if the +comparison_object+ is the same object, or is of the same type and has the same id.
2816 def ==(comparison_object)
2817 comparison_object.equal?(self) ||
2818 (comparison_object.instance_of?(self.class) &&
2819 comparison_object.id == id &&
2820 !comparison_object.new_record?)
2824 def eql?(comparison_object)
2825 self == (comparison_object)
2828 # Delegates to id in order to allow two records of the same type and id to work with something like:
2829 # [ Person.find(1), Person.find(2), Person.find(3) ] & [ Person.find(1), Person.find(4) ] # => [ Person.find(1) ]
2834 # Freeze the attributes hash such that associations are still accessible, even on destroyed records.
2836 @attributes.freeze; self
2839 # Returns +true+ if the attributes hash has been frozen.
2844 # Returns +true+ if the record is read only. Records loaded through joins with piggy-back
2845 # attributes will be marked as read only since they cannot be saved.
2847 defined?(@readonly) && @readonly == true
2850 # Marks this record as read only.
2855 # Returns the contents of the record as a nicely formatted string.
2857 attributes_as_nice_string = self.class.column_names.collect { |name|
2858 if has_attribute?(name) || new_record?
2859 "#{name}: #{attribute_for_inspect(name)}"
2861 }.compact.join(", ")
2862 "#<#{self.class} #{attributes_as_nice_string}>"
2866 def create_or_update
2867 raise ReadOnlyRecord if readonly?
2868 result = new_record? ? create : update
2872 # Updates the associated record with values matching those of the instance attributes.
2873 # Returns the number of affected rows.
2874 def update(attribute_names = @attributes.keys)
2875 quoted_attributes = attributes_with_quotes(false, false, attribute_names)
2876 return 0 if quoted_attributes.empty?
2878 "UPDATE #{self.class.quoted_table_name} " +
2879 "SET #{quoted_comma_pair_list(connection, quoted_attributes)} " +
2880 "WHERE #{connection.quote_column_name(self.class.primary_key)} = #{quote_value(id)}",
2881 "#{self.class.name} Update"
2885 # Creates a record with values matching those of the instance attributes
2886 # and returns its id.
2888 if self.id.nil? && connection.prefetch_primary_key?(self.class.table_name)
2889 self.id = connection.next_sequence_value(self.class.sequence_name)
2892 quoted_attributes = attributes_with_quotes
2894 statement = if quoted_attributes.empty?
2895 connection.empty_insert_statement(self.class.table_name)
2897 "INSERT INTO #{self.class.quoted_table_name} " +
2898 "(#{quoted_column_names.join(', ')}) " +
2899 "VALUES(#{quoted_attributes.values.join(', ')})"
2902 self.id = connection.insert(statement, "#{self.class.name} Create",
2903 self.class.primary_key, self.id, self.class.sequence_name)
2909 # Sets the attribute used for single table inheritance to this class name if this is not the ActiveRecord::Base descendant.
2910 # Considering the hierarchy Reply < Message < ActiveRecord::Base, this makes it possible to do Reply.new without having to
2911 # set <tt>Reply[Reply.inheritance_column] = "Reply"</tt> yourself. No such attribute would be set for objects of the
2912 # Message class in that example.
2913 def ensure_proper_type
2914 unless self.class.descends_from_active_record?
2915 write_attribute(self.class.inheritance_column, self.class.sti_name)
2919 def convert_number_column_value(value)
2924 elsif value.is_a?(String) && value.blank?
2931 def remove_attributes_protected_from_mass_assignment(attributes)
2933 if self.class.accessible_attributes.nil? && self.class.protected_attributes.nil?
2934 attributes.reject { |key, value| attributes_protected_by_default.include?(key.gsub(/\(.+/, "")) }
2935 elsif self.class.protected_attributes.nil?
2936 attributes.reject { |key, value| !self.class.accessible_attributes.include?(key.gsub(/\(.+/, "")) || attributes_protected_by_default.include?(key.gsub(/\(.+/, "")) }
2937 elsif self.class.accessible_attributes.nil?
2938 attributes.reject { |key, value| self.class.protected_attributes.include?(key.gsub(/\(.+/,"")) || attributes_protected_by_default.include?(key.gsub(/\(.+/, "")) }
2940 raise "Declare either attr_protected or attr_accessible for #{self.class}, but not both."
2943 removed_attributes = attributes.keys - safe_attributes.keys
2945 if removed_attributes.any?
2946 log_protected_attribute_removal(removed_attributes)
2952 # Removes attributes which have been marked as readonly.
2953 def remove_readonly_attributes(attributes)
2954 unless self.class.readonly_attributes.nil?
2955 attributes.delete_if { |key, value| self.class.readonly_attributes.include?(key.gsub(/\(.+/,"")) }
2961 def log_protected_attribute_removal(*attributes)
2962 logger.debug "WARNING: Can't mass-assign these protected attributes: #{attributes.join(', ')}"
2965 # The primary key and inheritance column can never be set by mass-assignment for security reasons.
2966 def attributes_protected_by_default
2967 default = [ self.class.primary_key, self.class.inheritance_column ]
2968 default << 'id' unless self.class.primary_key.eql? 'id'
2972 # Returns a copy of the attributes hash where all the values have been safely quoted for use in
2974 def attributes_with_quotes(include_primary_key = true, include_readonly_attributes = true, attribute_names = @attributes.keys)
2976 connection = self.class.connection
2977 attribute_names.each do |name|
2978 if (column = column_for_attribute(name)) && (include_primary_key || !column.primary)
2979 value = read_attribute(name)
2981 # We need explicit to_yaml because quote() does not properly convert Time/Date fields to YAML.
2982 if value && self.class.serialized_attributes.has_key?(name) && (value.acts_like?(:date) || value.acts_like?(:time))
2983 value = value.to_yaml
2986 quoted[name] = connection.quote(value, column)
2989 include_readonly_attributes ? quoted : remove_readonly_attributes(quoted)
2992 # Quote strings appropriately for SQL statements.
2993 def quote_value(value, column = nil)
2994 self.class.connection.quote(value, column)
2997 # Interpolate custom SQL string in instance context.
2998 # Optional record argument is meant for custom insert_sql.
2999 def interpolate_sql(sql, record = nil)
3000 instance_eval("%@#{sql.gsub('@', '\@')}@")
3003 # Initializes the attributes array with keys matching the columns from the linked table and
3004 # the values matching the corresponding default value of that column, so
3005 # that a new instance, or one populated from a passed-in Hash, still has all the attributes
3006 # that instances loaded from the database would.
3007 def attributes_from_column_definition
3008 self.class.columns.inject({}) do |attributes, column|
3009 attributes[column.name] = column.default unless column.name == self.class.primary_key
3014 # Instantiates objects for all attribute classes that needs more than one constructor parameter. This is done
3015 # by calling new on the column type or aggregation type (through composed_of) object with these parameters.
3016 # So having the pairs written_on(1) = "2004", written_on(2) = "6", written_on(3) = "24", will instantiate
3017 # written_on (a date type) with Date.new("2004", "6", "24"). You can also specify a typecast character in the
3018 # parentheses to have the parameters typecasted before they're used in the constructor. Use i for Fixnum, f for Float,
3019 # s for String, and a for Array. If all the values for a given attribute are empty, the attribute will be set to nil.
3020 def assign_multiparameter_attributes(pairs)
3021 execute_callstack_for_multiparameter_attributes(
3022 extract_callstack_for_multiparameter_attributes(pairs)
3026 def instantiate_time_object(name, values)
3027 if self.class.send(:create_time_zone_conversion_attribute?, name, column_for_attribute(name))
3028 Time.zone.local(*values)
3030 Time.time_with_datetime_fallback(@@default_timezone, *values)
3034 def execute_callstack_for_multiparameter_attributes(callstack)
3036 callstack.each do |name, values|
3037 klass = (self.class.reflect_on_aggregation(name.to_sym) || column_for_attribute(name)).klass
3039 send(name + "=", nil)
3042 value = if Time == klass
3043 instantiate_time_object(name, values)
3047 rescue ArgumentError => ex # if Date.new raises an exception on an invalid date
3048 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
3054 send(name + "=", value)
3056 errors << AttributeAssignmentError.new("error on assignment #{values.inspect} to #{name}", ex, name)
3060 unless errors.empty?
3061 raise MultiparameterAssignmentErrors.new(errors), "#{errors.size} error(s) on assignment of multiparameter attributes"
3065 def extract_callstack_for_multiparameter_attributes(pairs)
3069 multiparameter_name, value = pair
3070 attribute_name = multiparameter_name.split("(").first
3071 attributes[attribute_name] = [] unless attributes.include?(attribute_name)
3074 attributes[attribute_name] <<
3075 [ find_parameter_position(multiparameter_name), type_cast_attribute_value(multiparameter_name, value) ]
3079 attributes.each { |name, values| attributes[name] = values.sort_by{ |v| v.first }.collect { |v| v.last } }
3082 def type_cast_attribute_value(multiparameter_name, value)
3083 multiparameter_name =~ /\([0-9]*([a-z])\)/ ? value.send("to_" + $1) : value
3086 def find_parameter_position(multiparameter_name)
3087 multiparameter_name.scan(/\(([0-9]*).*\)/).first.first
3090 # Returns a comma-separated pair list, like "key1 = val1, key2 = val2".
3091 def comma_pair_list(hash)
3092 hash.inject([]) { |list, pair| list << "#{pair.first} = #{pair.last}" }.join(", ")
3095 def quoted_column_names(attributes = attributes_with_quotes)
3096 connection = self.class.connection
3097 attributes.keys.collect do |column_name|
3098 connection.quote_column_name(column_name)
3102 def self.quoted_table_name
3103 self.connection.quote_table_name(self.table_name)
3106 def quote_columns(quoter, hash)
3107 hash.inject({}) do |quoted, (name, value)|
3108 quoted[quoter.quote_column_name(name)] = value
3113 def quoted_comma_pair_list(quoter, hash)
3114 comma_pair_list(quote_columns(quoter, hash))
3117 def object_from_yaml(string)
3118 return string unless string.is_a?(String) && string =~ /^---/
3119 YAML::load(string) rescue string
3122 def clone_attributes(reader_method = :read_attribute, attributes = {})
3123 self.attribute_names.inject(attributes) do |attrs, name|
3124 attrs[name] = clone_attribute_value(reader_method, name)
3129 def clone_attribute_value(reader_method, attribute_name)
3130 value = send(reader_method, attribute_name)
3131 value.duplicable? ? value.clone : value
3132 rescue TypeError, NoMethodError
3138 extend QueryCache::ClassMethods
3140 include Locking::Optimistic, Locking::Pessimistic
3141 include AttributeMethods
3143 include Callbacks, Observing, Timestamp
3144 include Associations, AssociationPreload, NamedScope
3146 # AutosaveAssociation needs to be included before Transactions, because we want
3147 # #save_with_autosave_associations to be wrapped inside a transaction.
3148 include AutosaveAssociation, NestedAttributes
3150 include Aggregations, Transactions, Reflection, Batches, Calculations, Serialization
3154 # TODO: Remove this and make it work with LAZY flag
3155 require 'active_record/connection_adapters/abstract_adapter'