2006-06-02 20:01:08 -04:00
require 'base64'
2004-11-23 20:04:44 -05:00
require 'yaml'
2005-11-02 12:30:59 -05:00
require 'set'
2004-11-23 20:04:44 -05:00
module ActiveRecord #:nodoc:
class ActiveRecordError < StandardError #:nodoc:
end
2004-12-14 07:32:29 -05:00
class SubclassNotFound < ActiveRecordError #:nodoc:
end
2004-11-23 20:04:44 -05:00
class AssociationTypeMismatch < ActiveRecordError #:nodoc:
end
class SerializationTypeMismatch < ActiveRecordError #:nodoc:
end
class AdapterNotSpecified < ActiveRecordError # :nodoc:
end
class AdapterNotFound < ActiveRecordError # :nodoc:
end
class ConnectionNotEstablished < ActiveRecordError #:nodoc:
end
class ConnectionFailed < ActiveRecordError #:nodoc:
end
class RecordNotFound < ActiveRecordError #:nodoc:
end
2006-02-28 15:37:21 -05:00
class RecordNotSaved < ActiveRecordError #:nodoc:
end
2004-11-23 20:04:44 -05:00
class StatementInvalid < ActiveRecordError #:nodoc:
end
2004-12-08 05:38:10 -05:00
class PreparedStatementInvalid < ActiveRecordError #:nodoc:
end
2004-12-31 14:38:04 -05:00
class StaleObjectError < ActiveRecordError #:nodoc:
end
2007-10-05 20:25:07 -04:00
class ConfigurationError < ActiveRecordError #:nodoc:
2005-07-11 02:09:08 -04:00
end
2007-10-05 20:25:07 -04:00
class ReadOnlyRecord < ActiveRecordError #:nodoc:
2005-10-14 20:19:56 -04:00
end
2007-10-05 20:25:07 -04:00
class Rollback < ActiveRecordError #:nodoc:
end
2007-10-07 15:43:19 -04:00
class ProtectedAttributeAssignmentError < ActiveRecordError #:nodoc:
end
2007-10-05 20:25:07 -04:00
class DangerousAttributeError < ActiveRecordError #:nodoc:
2007-05-17 21:02:08 -04:00
end
2007-10-07 15:43:19 -04:00
2007-08-14 04:53:02 -04:00
# Raised when you've tried to access a column, which wasn't
# loaded by your finder. Typically this is because :select
# has been specified
class MissingAttributeError < NoMethodError
end
2007-05-17 22:11:43 -04:00
2005-03-06 09:11:26 -05:00
class AttributeAssignmentError < ActiveRecordError #:nodoc:
attr_reader :exception , :attribute
def initialize ( message , exception , attribute )
@exception = exception
@attribute = attribute
@message = message
end
end
2005-07-03 04:32:43 -04:00
2005-03-06 09:11:26 -05:00
class MultiparameterAssignmentErrors < ActiveRecordError #:nodoc:
attr_reader :errors
def initialize ( errors )
@errors = errors
end
end
2005-07-03 04:32:43 -04:00
2005-10-10 23:55:49 -04:00
# Active Record objects don't specify their attributes directly, but rather infer them from the table definition with
2004-11-23 20:04:44 -05:00
# which they're linked. Adding, removing, and changing attributes and their type is done directly in the database. Any change
# is instantly reflected in the Active Record objects. The mapping that binds a given Active Record class to a certain
2005-07-03 04:32:43 -04:00
# database table will happen automatically in most common cases, but can be overwritten for the uncommon ones.
#
2004-11-23 20:04:44 -05:00
# See the mapping rules in table_name and the full example in link:files/README.html for more insight.
2005-07-03 04:32:43 -04:00
#
2004-11-23 20:04:44 -05:00
# == Creation
2005-07-03 04:32:43 -04:00
#
2005-10-10 23:55:49 -04:00
# Active Records accept constructor parameters either in a hash or as a block. The hash method is especially useful when
2004-11-23 20:04:44 -05:00
# you're receiving the data from somewhere else, like a HTTP request. It works like this:
2005-07-03 04:32:43 -04:00
#
2005-04-17 13:16:24 -04:00
# user = User.new(:name => "David", :occupation => "Code Artist")
2004-11-23 20:04:44 -05:00
# user.name # => "David"
2005-07-03 04:32:43 -04:00
#
2004-11-23 20:04:44 -05:00
# You can also use block initialization:
2005-07-03 04:32:43 -04:00
#
2004-11-23 20:04:44 -05:00
# user = User.new do |u|
# u.name = "David"
# u.occupation = "Code Artist"
# end
2005-07-03 04:32:43 -04:00
#
2004-11-23 20:04:44 -05:00
# And of course you can just create a bare object and specify the attributes after the fact:
2005-07-03 04:32:43 -04:00
#
2004-11-23 20:04:44 -05:00
# user = User.new
# user.name = "David"
# user.occupation = "Code Artist"
2005-07-03 04:32:43 -04:00
#
2004-11-23 20:04:44 -05:00
# == Conditions
2005-07-03 04:32:43 -04:00
#
2006-06-03 18:15:06 -04:00
# Conditions can either be specified as a string, array, or hash representing the WHERE-part of an SQL statement.
2004-11-23 20:04:44 -05:00
# The array form is to be used when the condition input is tainted and requires sanitization. The string form can
2006-06-03 18:15:06 -04:00
# be used for statements that don't involve tainted data. The hash form works much like the array form, except
2007-01-10 05:13:18 -05:00
# only equality and range is possible. Examples:
2005-07-03 04:32:43 -04:00
#
2006-06-02 20:01:08 -04:00
# class User < ActiveRecord::Base
2004-11-23 20:04:44 -05:00
# def self.authenticate_unsafely(user_name, password)
2005-06-26 07:25:32 -04:00
# find(:first, :conditions => "user_name = '#{user_name}' AND password = '#{password}'")
2004-11-23 20:04:44 -05:00
# end
2005-07-03 04:32:43 -04:00
#
2004-11-23 20:04:44 -05:00
# def self.authenticate_safely(user_name, password)
2005-06-26 07:25:32 -04:00
# find(:first, :conditions => [ "user_name = ? AND password = ?", user_name, password ])
2004-11-23 20:04:44 -05:00
# end
2006-06-03 18:15:06 -04:00
#
# def self.authenticate_safely_simply(user_name, password)
# find(:first, :conditions => { :user_name => user_name, :password => password })
# end
2004-11-23 20:04:44 -05:00
# end
2005-07-03 04:32:43 -04:00
#
2004-12-06 13:08:35 -05:00
# The <tt>authenticate_unsafely</tt> method inserts the parameters directly into the query and is thus susceptible to SQL-injection
2006-06-03 18:15:06 -04:00
# attacks if the <tt>user_name</tt> and +password+ parameters come directly from a HTTP request. The <tt>authenticate_safely</tt> and
# <tt>authenticate_safely_simply</tt> both will sanitize the <tt>user_name</tt> and +password+ before inserting them in the query,
# which will ensure that an attacker can't escape the query and fake the login (or worse).
2004-12-06 13:08:35 -05:00
#
2005-03-27 07:04:07 -05:00
# When using multiple parameters in the conditions, it can easily become hard to read exactly what the fourth or fifth
2005-07-03 04:32:43 -04:00
# question mark is supposed to represent. In those cases, you can resort to named bind variables instead. That's done by replacing
2005-03-27 07:04:07 -05:00
# the question marks with symbols and supplying a hash with values for the matching symbol keys:
#
2005-07-03 04:32:43 -04:00
# Company.find(:first, [
# "id = :id AND name = :name AND division = :division AND created_at > :accounting_date",
2005-03-27 07:04:07 -05:00
# { :id => 3, :name => "37signals", :division => "First", :accounting_date => '2005-01-01' }
# ])
#
2006-06-03 18:15:06 -04:00
# Similarly, a simple hash without a statement will generate conditions based on equality with the SQL AND
# operator. For instance:
#
# Student.find(:all, :conditions => { :first_name => "Harvey", :status => 1 })
# Student.find(:all, :conditions => params[:student])
#
2007-01-10 05:13:18 -05:00
# A range may be used in the hash to use the SQL BETWEEN operator:
#
# Student.find(:all, :conditions => { :grade => 9..12 })
2006-06-03 18:15:06 -04:00
#
2004-11-23 20:04:44 -05:00
# == Overwriting default accessors
2005-07-03 04:32:43 -04:00
#
2004-11-23 20:04:44 -05:00
# All column values are automatically available through basic accessors on the Active Record object, but some times you
# want to specialize this behavior. This can be done by either by overwriting the default accessors (using the same
# name as the attribute) calling read_attribute(attr_name) and write_attribute(attr_name, value) to actually change things.
# Example:
2005-07-03 04:32:43 -04:00
#
2004-11-23 20:04:44 -05:00
# class Song < ActiveRecord::Base
# # Uses an integer of seconds to hold the length of the song
2005-07-03 04:32:43 -04:00
#
2004-11-23 20:04:44 -05:00
# def length=(minutes)
2005-04-17 13:16:24 -04:00
# write_attribute(:length, minutes * 60)
2004-11-23 20:04:44 -05:00
# end
2005-07-03 04:32:43 -04:00
#
2004-11-23 20:04:44 -05:00
# def length
2005-04-17 13:16:24 -04:00
# read_attribute(:length) / 60
2004-11-23 20:04:44 -05:00
# end
# end
2005-07-03 04:32:43 -04:00
#
2007-09-28 10:18:47 -04:00
# You can alternatively use self[:attribute]=(value) and self[:attribute] instead of write_attribute(:attribute, value) and
2005-04-17 13:16:24 -04:00
# read_attribute(:attribute) as a shorter form.
#
2005-10-10 23:55:49 -04:00
# == Accessing attributes before they have been typecasted
2005-02-23 18:51:34 -05:00
#
2005-10-10 23:55:49 -04:00
# Sometimes you want to be able to read the raw attribute data without having the column-determined typecast run its course first.
2005-02-23 18:51:34 -05:00
# That can be done by using the <attribute>_before_type_cast accessors that all attributes have. For example, if your Account model
2005-07-03 04:32:43 -04:00
# has a balance attribute, you can call account.balance_before_type_cast or account.id_before_type_cast.
2005-02-23 18:51:34 -05:00
#
# This is especially useful in validation situations where the user might supply a string for an integer field and you want to display
2005-10-10 23:55:49 -04:00
# the original string back in an error message. Accessing the attribute normally would typecast the string to 0, which isn't what you
2005-02-23 18:51:34 -05:00
# want.
#
2005-01-02 08:31:00 -05:00
# == Dynamic attribute-based finders
#
2005-11-04 14:39:50 -05:00
# Dynamic attribute-based finders are a cleaner way of getting (and/or creating) objects by simple queries without turning to SQL. They work by
2005-06-25 07:47:37 -04:00
# appending the name of an attribute to <tt>find_by_</tt> or <tt>find_all_by_</tt>, so you get finders like Person.find_by_user_name,
2005-07-03 04:32:43 -04:00
# Person.find_all_by_last_name, Payment.find_by_transaction_id. So instead of writing
# <tt>Person.find(:first, ["user_name = ?", user_name])</tt>, you just do <tt>Person.find_by_user_name(user_name)</tt>.
2005-06-25 07:47:37 -04:00
# And instead of writing <tt>Person.find(:all, ["last_name = ?", last_name])</tt>, you just do <tt>Person.find_all_by_last_name(last_name)</tt>.
2005-07-03 04:32:43 -04:00
#
2005-01-02 08:31:00 -05:00
# It's also possible to use multiple attributes in the same find by separating them with "_and_", so you get finders like
# <tt>Person.find_by_user_name_and_password</tt> or even <tt>Payment.find_by_purchaser_and_state_and_country</tt>. So instead of writing
2005-07-03 04:32:43 -04:00
# <tt>Person.find(:first, ["user_name = ? AND password = ?", user_name, password])</tt>, you just do
2005-01-02 08:31:00 -05:00
# <tt>Person.find_by_user_name_and_password(user_name, password)</tt>.
2005-07-03 04:32:43 -04:00
#
2005-04-17 13:16:24 -04:00
# It's even possible to use all the additional parameters to find. For example, the full interface for Payment.find_all_by_amount
# is actually Payment.find_all_by_amount(amount, options). And the full interface to Person.find_by_user_name is
# actually Person.find_by_user_name(user_name, options). So you could call <tt>Payment.find_all_by_amount(50, :order => "created_on")</tt>.
2005-01-02 08:51:00 -05:00
#
2005-11-04 14:39:50 -05:00
# The same dynamic finder style can be used to create the object if it doesn't already exist. This dynamic finder is called with
# <tt>find_or_create_by_</tt> and will return the object if it already exists and otherwise creates it, then returns it. Example:
#
# # No 'Summer' tag exists
# Tag.find_or_create_by_name("Summer") # equal to Tag.create(:name => "Summer")
#
# # Now the 'Summer' tag does exist
# Tag.find_or_create_by_name("Summer") # equal to Tag.find_by_name("Summer")
#
2006-06-20 18:48:52 -04:00
# Use the <tt>find_or_initialize_by_</tt> finder if you want to return a new record without saving it first. Example:
#
# # No 'Winter' tag exists
# winter = Tag.find_or_initialize_by_name("Winter")
2006-09-05 14:54:24 -04:00
# winter.new_record? # true
2006-06-20 18:48:52 -04:00
#
2007-03-13 21:08:45 -04:00
# To find by a subset of the attributes to be used for instantiating a new object, pass a hash instead of
# a list of parameters. For example:
#
# Tag.find_or_create_by_name(:name => "rails", :creator => current_user)
#
# That will either find an existing tag named "rails", or create a new one while setting the user that created it.
#
2005-02-07 09:15:53 -05:00
# == Saving arrays, hashes, and other non-mappable objects in text columns
2005-07-03 04:32:43 -04:00
#
# 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+.
2005-10-10 23:55:49 -04:00
# This makes it possible to store arrays, hashes, and other non-mappable objects without doing any additional work. Example:
2005-07-03 04:32:43 -04:00
#
2004-11-23 20:04:44 -05:00
# class User < ActiveRecord::Base
# serialize :preferences
# end
2005-07-03 04:32:43 -04:00
#
2006-04-26 17:29:10 -04:00
# user = User.create(:preferences => { "background" => "black", "display" => large })
2004-11-23 20:04:44 -05:00
# User.find(user.id).preferences # => { "background" => "black", "display" => large }
2005-07-03 04:32:43 -04:00
#
2005-10-10 23:55:49 -04:00
# You can also specify a class option as the second parameter that'll raise an exception if a serialized object is retrieved as a
2004-11-23 20:04:44 -05:00
# descendent of a class not in the hierarchy. Example:
2005-07-03 04:32:43 -04:00
#
2004-11-23 20:04:44 -05:00
# class User < ActiveRecord::Base
2005-01-25 15:00:20 -05:00
# serialize :preferences, Hash
2004-11-23 20:04:44 -05:00
# end
2005-07-03 04:32:43 -04:00
#
2005-04-17 13:16:24 -04:00
# user = User.create(:preferences => %w( one two three ))
2004-11-23 20:04:44 -05:00
# User.find(user.id).preferences # raises SerializationTypeMismatch
2005-07-03 04:32:43 -04:00
#
2004-11-23 20:04:44 -05:00
# == Single table inheritance
#
2005-07-03 04:32:43 -04:00
# Active Record allows inheritance by storing the name of the class in a column that by default is called "type" (can be changed
2004-11-23 20:04:44 -05:00
# by overwriting <tt>Base.inheritance_column</tt>). This means that an inheritance looking like this:
#
# class Company < ActiveRecord::Base; end
# class Firm < Company; end
# class Client < Company; end
# class PriorityClient < Client; end
#
2005-04-17 13:16:24 -04:00
# When you do Firm.create(:name => "37signals"), this record will be saved in the companies table with type = "Firm". You can then
# fetch this row again using Company.find(:first, "name = '37signals'") and it will return a Firm object.
2004-11-23 20:04:44 -05:00
#
2004-12-16 11:56:30 -05:00
# If you don't have a type column defined in your table, single-table inheritance won't be triggered. In that case, it'll work just
# like normal subclasses with no special magic for differentiating between them or reloading the right type with find.
#
2004-11-23 20:04:44 -05:00
# Note, all the attributes for all the cases are kept in the same table. Read more:
# http://www.martinfowler.com/eaaCatalog/singleTableInheritance.html
2005-07-03 04:32:43 -04:00
#
2004-11-23 20:04:44 -05:00
# == Connection to multiple databases in different models
#
# Connections are usually created through ActiveRecord::Base.establish_connection and retrieved by ActiveRecord::Base.connection.
2005-07-03 04:32:43 -04:00
# All classes inheriting from ActiveRecord::Base will use this connection. But you can also set a class-specific connection.
2004-11-23 20:04:44 -05:00
# For example, if Course is a ActiveRecord::Base, but resides in a different database you can just say Course.establish_connection
# and Course *and all its subclasses* will use this connection instead.
#
# This feature is implemented by keeping a connection pool in ActiveRecord::Base that is a Hash indexed by the class. If a connection is
# requested, the retrieve_connection method will go up the class-hierarchy until a connection is found in the connection pool.
#
# == Exceptions
2005-07-03 04:32:43 -04:00
#
2004-11-23 20:04:44 -05:00
# * +ActiveRecordError+ -- generic error class and superclass of all other errors raised by Active Record
2005-07-03 04:32:43 -04:00
# * +AdapterNotSpecified+ -- the configuration hash used in <tt>establish_connection</tt> didn't include a
2004-11-23 20:04:44 -05:00
# <tt>:adapter</tt> key.
2005-07-22 02:27:07 -04:00
# * +AdapterNotFound+ -- the <tt>:adapter</tt> key used in <tt>establish_connection</tt> specified an non-existent adapter
2005-07-03 04:32:43 -04:00
# (or a bad spelling of an existing one).
# * +AssociationTypeMismatch+ -- the object assigned to the association wasn't of the type specified in the association definition.
# * +SerializationTypeMismatch+ -- the object serialized wasn't of the class specified as the second parameter.
2004-11-23 20:04:44 -05:00
# * +ConnectionNotEstablished+ -- no connection has been established. Use <tt>establish_connection</tt> before querying.
2005-07-03 04:32:43 -04:00
# * +RecordNotFound+ -- no record responded to the find* method.
2004-11-23 20:04:44 -05:00
# Either the row with the given ID doesn't exist or the row didn't meet the additional restrictions.
# * +StatementInvalid+ -- the database server rejected the SQL statement. The precise error is added in the message.
# Either the record with the given ID doesn't exist or the record didn't meet the additional restrictions.
2005-07-03 04:32:43 -04:00
# * +MultiparameterAssignmentErrors+ -- collection of errors that occurred during a mass assignment using the
# +attributes=+ method. The +errors+ property of this exception contains an array of +AttributeAssignmentError+
2005-03-06 09:11:26 -05:00
# objects that should be inspected to determine which attributes triggered the errors.
# * +AttributeAssignmentError+ -- an error occurred while doing a mass assignment through the +attributes=+ method.
# You can inspect the +attribute+ property of the exception object to determine which attribute triggered the error.
2005-09-11 05:41:24 -04:00
#
2005-07-03 04:32:43 -04:00
# *Note*: The attributes listed are class-level attributes (accessible from both the class and instance level).
2004-11-23 20:04:44 -05:00
# So it's possible to assign a logger to the class through Base.logger= which will then be used by all
# instances in the current object space.
class Base
# Accepts a logger conforming to the interface of Log4r or the default Ruby 1.8+ Logger class, which is then passed
# on to any new database connections made and which can be retrieved on both a class and instance level by calling +logger+.
2007-01-27 20:31:31 -05:00
cattr_accessor :logger , :instance_writer = > false
2007-09-13 20:25:59 -04:00
2004-11-23 20:04:44 -05:00
def self . inherited ( child ) #:nodoc:
@@subclasses [ self ] || = [ ]
@@subclasses [ self ] << child
super
end
2007-09-13 20:25:59 -04:00
2006-03-27 22:06:40 -05:00
def self . reset_subclasses #:nodoc:
2005-10-15 16:49:04 -04:00
nonreloadables = [ ]
2005-10-15 14:21:27 -04:00
subclasses . each do | klass |
2006-08-08 17:21:04 -04:00
unless Dependencies . autoloaded? klass
2005-10-15 16:49:04 -04:00
nonreloadables << klass
next
end
2005-10-15 14:21:27 -04:00
klass . instance_variables . each { | var | klass . send ( :remove_instance_variable , var ) }
klass . instance_methods ( false ) . each { | m | klass . send :undef_method , m }
end
2005-10-15 16:49:04 -04:00
@@subclasses = { }
nonreloadables . each { | klass | ( @@subclasses [ klass . superclass ] || = [ ] ) << klass }
2005-09-20 06:33:26 -04:00
end
2004-11-23 20:04:44 -05:00
@@subclasses = { }
2005-06-12 09:32:06 -04:00
2007-01-27 20:31:31 -05:00
cattr_accessor :configurations , :instance_writer = > false
2005-06-12 09:32:06 -04:00
@@configurations = { }
2005-07-03 04:32:43 -04:00
# Accessor for the prefix type that will be prepended to every primary key column name. The options are :table_name and
2004-11-23 20:04:44 -05:00
# :table_name_with_underscore. If the first is specified, the Product class will look for "productid" instead of "id" as
# the primary column. If the latter is specified, the Product class will look for "product_id" instead of "id". Remember
2005-07-03 04:32:43 -04:00
# that this is a global setting for all Active Records.
2007-01-27 20:31:31 -05:00
cattr_accessor :primary_key_prefix_type , :instance_writer = > false
2004-11-23 20:04:44 -05:00
@@primary_key_prefix_type = nil
2005-07-03 04:32:43 -04:00
# Accessor for the name of the prefix string to prepend to every table name. So if set to "basecamp_", all
2005-02-07 09:15:53 -05:00
# table names will be named like "basecamp_projects", "basecamp_people", etc. This is a convenient way of creating a namespace
2004-11-23 20:04:44 -05:00
# for tables in a shared database. By default, the prefix is the empty string.
2007-01-27 20:31:31 -05:00
cattr_accessor :table_name_prefix , :instance_writer = > false
2004-11-23 20:04:44 -05:00
@@table_name_prefix = " "
# Works like +table_name_prefix+, but appends instead of prepends (set to "_basecamp" gives "projects_basecamp",
# "people_basecamp"). By default, the suffix is the empty string.
2007-01-27 20:31:31 -05:00
cattr_accessor :table_name_suffix , :instance_writer = > false
2004-11-23 20:04:44 -05:00
@@table_name_suffix = " "
2007-10-07 15:43:19 -04:00
# Indicates whether table names should be the pluralized versions of the corresponding class names.
2005-10-10 23:55:49 -04:00
# If true, the default table name for a +Product+ class will be +products+. If false, it would just be +product+.
2004-11-23 20:04:44 -05:00
# See table_name for the full rules on table/class naming. This is true, by default.
2007-01-27 20:31:31 -05:00
cattr_accessor :pluralize_table_names , :instance_writer = > false
2004-11-23 20:04:44 -05:00
@@pluralize_table_names = true
2007-10-07 15:43:19 -04:00
# Determines whether to use ANSI codes to colorize the logging statements committed by the connection adapter. These colors
2005-10-10 23:55:49 -04:00
# make it much easier to overview things during debugging (when used through a reader like +tail+ and on a black background), but
2005-03-06 12:18:34 -05:00
# may complicate matters if you use software like syslog. This is true, by default.
2007-01-27 20:31:31 -05:00
cattr_accessor :colorize_logging , :instance_writer = > false
2005-03-06 12:18:34 -05:00
@@colorize_logging = true
2004-12-28 12:30:17 -05:00
# Determines whether to use Time.local (using :local) or Time.utc (using :utc) when pulling dates and times from the database.
# This is set to :local by default.
2007-01-27 20:31:31 -05:00
cattr_accessor :default_timezone , :instance_writer = > false
2004-12-28 12:30:17 -05:00
@@default_timezone = :local
2006-03-01 17:04:30 -05:00
2007-10-07 15:43:19 -04:00
# Determines whether to use a connection for each thread, or a single shared connection for all threads.
2006-03-01 17:04:30 -05:00
# Defaults to false. Set to true if you're writing a threaded application.
2007-01-27 20:31:31 -05:00
cattr_accessor :allow_concurrency , :instance_writer = > false
2006-03-13 12:28:55 -05:00
@@allow_concurrency = false
2006-03-01 17:04:30 -05:00
2005-10-13 00:12:32 -04:00
# Specifies the format to use when dumping the database schema with Rails'
# Rakefile. If :sql, the schema is dumped as (potentially database-
# specific) SQL statements. If :ruby, the schema is dumped as an
# ActiveRecord::Schema file which can be loaded into any database that
# supports migrations. Use :ruby if you want to have different database
# adapters for, e.g., your development and test environments.
2007-01-27 20:31:31 -05:00
cattr_accessor :schema_format , :instance_writer = > false
2006-02-26 19:23:49 -05:00
@@schema_format = :ruby
2005-10-06 20:53:05 -04:00
2007-10-07 15:43:19 -04:00
# Determines whether to raise an exception on mass-assignment to protected
# attribute. Defaults to true.
cattr_accessor :whiny_protected_attributes , :instance_writer = > false
@@whiny_protected_attributes = true
2004-11-23 20:04:44 -05:00
class << self # Class methods
2005-10-10 23:55:49 -04:00
# Find operates with three different retrieval approaches:
2005-04-18 01:03:56 -04:00
#
# * 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]).
# If no record can be found for all of the listed ids, then RecordNotFound will be raised.
# * Find first: This will return the first record matched by the options used. These options can either be specific
# conditions or merely an order. If no record can matched, nil is returned.
2005-04-18 16:10:11 -04:00
# * Find all: This will return all the records matched by the options used. If no records are found, an empty array is returned.
2005-04-18 01:03:56 -04:00
#
2005-10-10 23:55:49 -04:00
# All approaches accept an option hash as their last parameter. The options are:
2005-04-18 01:03:56 -04:00
#
2005-04-18 10:39:36 -04:00
# * <tt>:conditions</tt>: An SQL fragment like "administrator = 1" or [ "user_name = ?", username ]. See conditions in the intro.
# * <tt>:order</tt>: An SQL fragment like "created_at DESC, name".
2005-11-10 11:36:01 -05:00
# * <tt>:group</tt>: An attribute name by which the result should be grouped. Uses the GROUP BY SQL-clause.
2005-04-18 10:39:36 -04:00
# * <tt>:limit</tt>: An integer determining the limit on the number of rows that should be returned.
2007-05-18 15:06:54 -04:00
# * <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.
2005-04-18 10:39:36 -04:00
# * <tt>:joins</tt>: An SQL fragment for additional joins like "LEFT JOIN comments ON comments.post_id = id". (Rarely needed).
2005-10-14 20:19:56 -04:00
# The records will be returned read-only since they will have attributes that do not correspond to the table's columns.
2005-10-20 10:53:04 -04:00
# Pass :readonly => false to override.
2005-04-18 10:39:36 -04:00
# * <tt>:include</tt>: Names associations that should be loaded alongside using LEFT OUTER JOINs. The symbols named refer
# to already defined associations. See eager loading under Associations.
2005-07-14 03:18:26 -04:00
# * <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
# include the joined columns.
2006-08-09 11:11:18 -04:00
# * <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
# of a database view).
2005-10-14 20:19:56 -04:00
# * <tt>:readonly</tt>: Mark the returned records read-only so they cannot be saved or updated.
2006-06-19 18:48:51 -04:00
# * <tt>:lock</tt>: An SQL fragment like "FOR UPDATE" or "LOCK IN SHARE MODE".
# :lock => true gives connection's default exclusive lock, usually "FOR UPDATE".
2005-04-18 01:03:56 -04:00
#
2005-04-18 10:39:36 -04:00
# Examples for find by id:
2004-11-23 20:04:44 -05:00
# Person.find(1) # returns the object for ID = 1
# Person.find(1, 2, 6) # returns an array for objects with IDs in (1, 2, 6)
# Person.find([7, 17]) # returns an array for objects with IDs in (7, 17)
2004-12-15 06:55:43 -05:00
# Person.find([1]) # returns an array for objects the object with ID = 1
2005-04-18 10:39:36 -04:00
# Person.find(1, :conditions => "administrator = 1", :order => "created_on DESC")
#
2007-03-06 04:33:08 -05:00
# Note that returned records may not be in the same order as the ids you
# provide since database rows are unordered. Give an explicit :order
# to ensure the results are sorted.
#
2005-04-18 10:39:36 -04:00
# Examples for find first:
2005-04-18 16:10:11 -04:00
# Person.find(:first) # returns the first object fetched by SELECT * FROM people
2005-04-18 10:39:36 -04:00
# Person.find(:first, :conditions => [ "user_name = ?", user_name])
# Person.find(:first, :order => "created_on DESC", :offset => 5)
#
# Examples for find all:
2005-04-18 16:10:11 -04:00
# Person.find(:all) # returns an array of objects for all the rows fetched by SELECT * FROM people
2005-04-18 10:39:36 -04:00
# Person.find(:all, :conditions => [ "category IN (?)", categories], :limit => 50)
# Person.find(:all, :offset => 10, :limit => 10)
# Person.find(:all, :include => [ :account, :friends ])
2005-11-10 11:36:01 -05:00
# Person.find(:all, :group => "category")
2006-06-19 18:48:51 -04:00
#
# Example for find with a lock. Imagine two concurrent transactions:
# each will read person.visits == 2, add 1 to it, and save, resulting
# in two saves of person.visits = 3. By locking the row, the second
# transaction has to wait until the first is finished; we get the
# expected person.visits == 4.
# Person.transaction do
# person = Person.find(1, :lock => true)
# person.visits += 1
# person.save!
# end
2005-01-01 14:50:23 -05:00
def find ( * args )
2007-07-24 12:48:57 -04:00
options = args . extract_options!
2006-03-27 18:28:19 -05:00
validate_find_options ( options )
set_readonly_option! ( options )
2005-10-14 20:19:56 -04:00
2005-04-03 06:52:05 -04:00
case args . first
2006-03-27 18:28:19 -05:00
when :first then find_initial ( options )
when :all then find_every ( options )
else find_from_ids ( args , options )
2004-11-23 20:04:44 -05:00
end
end
2006-03-27 18:28:19 -05:00
2005-06-26 07:25:32 -04:00
# Works like find(:all), but requires a complete SQL string. Examples:
2004-11-23 20:04:44 -05:00
# Post.find_by_sql "SELECT p.*, c.author FROM posts p, comments c WHERE p.id = c.post_id"
2004-12-07 16:14:20 -05:00
# Post.find_by_sql ["SELECT * FROM posts WHERE author = ? AND created > ?", author_id, start_date]
2004-11-23 20:04:44 -05:00
def find_by_sql ( sql )
2005-07-03 04:32:43 -04:00
connection . select_all ( sanitize_sql ( sql ) , " #{ name } Load " ) . collect! { | record | instantiate ( record ) }
2004-11-23 20:04:44 -05:00
end
2005-07-03 04:32:43 -04:00
2005-04-03 06:52:05 -04:00
# Returns true if the given +id+ represents the primary key of a record in the database, false otherwise.
2006-08-03 13:16:43 -04:00
# You can also pass a set of SQL conditions.
2005-04-03 06:52:05 -04:00
# Example:
# Person.exists?(5)
2006-08-03 18:06:33 -04:00
# Person.exists?('5')
2006-08-03 13:16:43 -04:00
# Person.exists?(:name => "David")
2006-08-03 18:06:33 -04:00
# Person.exists?(['name LIKE ?', "%#{query}%"])
def exists? ( id_or_conditions )
2007-08-04 20:57:43 -04:00
! find ( :first , :select = > " #{ table_name } . #{ primary_key } " , :conditions = > expand_id_conditions ( id_or_conditions ) ) . nil?
2006-08-03 18:06:33 -04:00
rescue ActiveRecord :: ActiveRecordError
false
2004-11-23 20:04:44 -05:00
end
2005-04-03 06:52:05 -04:00
2004-11-23 20:04:44 -05:00
# Creates an object, instantly saves it as a record (if the validation permits it), and returns it. If the save
2005-10-10 23:55:49 -04:00
# fails under validations, the unsaved object is still returned.
2004-11-23 20:04:44 -05:00
def create ( attributes = nil )
2005-01-25 07:45:01 -05:00
if attributes . is_a? ( Array )
attributes . collect { | attr | create ( attr ) }
else
object = new ( attributes )
object . save
object
end
2004-11-23 20:04:44 -05:00
end
2005-07-03 04:32:43 -04:00
# Finds the record from the passed +id+, instantly saves it with the passed +attributes+ (if the validation permits it),
2005-10-10 23:55:49 -04:00
# and returns it. If the save fails under validations, the unsaved object is still returned.
2006-02-25 18:33:08 -05:00
#
# The arguments may also be given as arrays in which case the update method is called for each pair of +id+ and
# +attributes+ and an array of objects is returned.
#
# Example of updating one record:
# Person.update(15, {:user_name => 'Samuel', :group => 'expert'})
#
# Example of updating multiple records:
# people = { 1 => { "first_name" => "David" }, 2 => { "first_name" => "Jeremy"} }
# Person.update(people.keys, people.values)
2004-11-23 20:04:44 -05:00
def update ( id , attributes )
2005-01-25 07:45:01 -05:00
if id . is_a? ( Array )
idx = - 1
id . collect { | id | idx += 1 ; update ( id , attributes [ idx ] ) }
else
object = find ( id )
object . update_attributes ( attributes )
object
end
2004-11-23 20:04:44 -05:00
end
2005-01-25 07:45:01 -05:00
# Deletes the record with the given +id+ without instantiating an object first. If an array of ids is provided, all of them
# are deleted.
2004-12-17 16:36:13 -05:00
def delete ( id )
2007-03-08 22:23:37 -05:00
delete_all ( [ " #{ connection . quote_column_name ( primary_key ) } IN (?) " , id ] )
2004-12-17 16:36:13 -05:00
end
2005-07-03 04:32:43 -04:00
2004-12-17 16:36:13 -05:00
# Destroys the record with the given +id+ by instantiating the object and calling #destroy (all the callbacks are the triggered).
2005-01-25 07:45:01 -05:00
# If an array of ids is provided, all of them are destroyed.
2004-12-17 16:36:13 -05:00
def destroy ( id )
2005-01-25 07:45:01 -05:00
id . is_a? ( Array ) ? id . each { | id | destroy ( id ) } : find ( id ) . destroy
2004-12-17 16:36:13 -05:00
end
2005-10-10 23:55:49 -04:00
# Updates all records with the SET-part of an SQL update statement in +updates+ and returns an integer with the number of rows updated.
2004-12-19 11:21:55 -05:00
# A subset of the records can be selected by specifying +conditions+. Example:
2004-11-23 20:04:44 -05:00
# Billing.update_all "category = 'authorized', approved = 1", "author = 'David'"
2007-03-17 11:48:47 -04:00
#
# Optional :order and :limit options may be given as the third parameter,
# but their behavior is database-specific.
def update_all ( updates , conditions = nil , options = { } )
2007-01-28 10:12:54 -05:00
sql = " UPDATE #{ table_name } SET #{ sanitize_sql_for_assignment ( updates ) } "
2007-03-17 11:48:47 -04:00
scope = scope ( :find )
add_conditions! ( sql , conditions , scope )
add_order! ( sql , options [ :order ] , scope )
add_limit! ( sql , options , scope )
2005-07-03 04:32:43 -04:00
connection . update ( sql , " #{ name } Update " )
2004-11-23 20:04:44 -05:00
end
2005-01-24 09:13:10 -05:00
2005-10-10 23:55:49 -04:00
# Destroys the objects for all the records that match the +condition+ by instantiating each object and calling
2004-11-23 20:04:44 -05:00
# the destroy method. Example:
# Person.destroy_all "last_login < '2004-04-04'"
def destroy_all ( conditions = nil )
2005-06-26 07:25:32 -04:00
find ( :all , :conditions = > conditions ) . each { | object | object . destroy }
2004-11-23 20:04:44 -05:00
end
2005-07-03 04:32:43 -04:00
2005-10-10 23:55:49 -04:00
# Deletes all the records that match the +condition+ without instantiating the objects first (and hence not
2004-11-23 20:04:44 -05:00
# calling the destroy method). Example:
2005-11-14 02:41:17 -05:00
# Post.delete_all "person_id = 5 AND (category = 'Something' OR category = 'Else')"
2004-11-23 20:04:44 -05:00
def delete_all ( conditions = nil )
2007-10-16 01:06:33 -04:00
sql = " DELETE FROM #{ quoted_table_name } "
2006-03-27 18:28:19 -05:00
add_conditions! ( sql , conditions , scope ( :find ) )
2004-11-23 20:04:44 -05:00
connection . delete ( sql , " #{ name } Delete all " )
end
# Returns the result of an SQL statement that should only include a COUNT(*) in the SELECT part.
2007-05-06 01:10:19 -04:00
# The use of this method should be restricted to complicated SQL queries that can't be executed
# using the ActiveRecord::Calculations class methods. Look into those before using this.
#
# ==== Options
#
# +sql+: An SQL statement which should return a count query from the database, see the example below
#
# ==== Examples
#
2005-08-14 04:20:51 -04:00
# Product.count_by_sql "SELECT COUNT(*) FROM sales s, customers c WHERE s.customer_id = c.id"
2004-11-23 20:04:44 -05:00
def count_by_sql ( sql )
2004-12-07 16:14:20 -05:00
sql = sanitize_conditions ( sql )
2005-09-24 15:50:57 -04:00
connection . select_value ( sql , " #{ name } Count " ) . to_i
2004-11-23 20:04:44 -05:00
end
2005-07-03 04:32:43 -04:00
2007-02-07 11:10:40 -05:00
# A generic "counter updater" implementation, intended primarily to be
# used by increment_counter and decrement_counter, but which may also
# be useful on its own. It simply does a direct SQL update for the record
# with the given ID, altering the given hash of counters by the amount
# given by the corresponding value:
#
# Post.update_counters 5, :comment_count => -1, :action_count => 1
# # UPDATE posts
# # SET comment_count = comment_count - 1,
# # action_count = action_count + 1
# # WHERE id = 5
def update_counters ( id , counters )
updates = counters . inject ( [ ] ) { | list , ( counter_name , increment ) |
sign = increment < 0 ? " - " : " + "
2007-03-08 22:23:37 -05:00
list << " #{ connection . quote_column_name ( counter_name ) } = #{ connection . quote_column_name ( counter_name ) } #{ sign } #{ increment . abs } "
2007-02-07 11:10:40 -05:00
} . join ( " , " )
2007-03-08 22:23:37 -05:00
update_all ( updates , " #{ connection . quote_column_name ( primary_key ) } = #{ quote_value ( id ) } " )
2007-02-07 11:10:40 -05:00
end
2007-05-06 01:08:05 -04:00
# Increment a number field by one, usually representing a count.
#
# This is used for caching aggregate values, so that they don't need to be computed every time.
# For example, a DiscussionBoard may cache post_count and comment_count otherwise every time the board is
# shown it would have to run a SQL query to find how many posts and comments there are.
#
# ==== Options
#
# +counter_name+ The name of the field that should be incremented
# +id+ The id of the object that should be incremented
#
# ==== Examples
#
# # Increment the post_count column for the record with an id of 5
# DiscussionBoard.increment_counter(:post_count, 5)
2004-11-23 20:04:44 -05:00
def increment_counter ( counter_name , id )
2007-02-07 11:10:40 -05:00
update_counters ( id , counter_name = > 1 )
2004-11-23 20:04:44 -05:00
end
2007-05-06 01:06:26 -04:00
# Decrement a number field by one, usually representing a count.
#
# This works the same as increment_counter but reduces the column value by 1 instead of increasing it.
#
# ==== Options
#
# +counter_name+ The name of the field that should be decremented
# +id+ The id of the object that should be decremented
#
# ==== Examples
#
# # Decrement the post_count column for the record with an id of 5
# DiscussionBoard.decrement_counter(:post_count, 5)
2004-11-23 20:04:44 -05:00
def decrement_counter ( counter_name , id )
2007-02-07 11:10:40 -05:00
update_counters ( id , counter_name = > - 1 )
2004-11-23 20:04:44 -05:00
end
2006-03-05 16:37:12 -05:00
2005-07-03 04:32:43 -04:00
# Attributes named in this macro are protected from mass-assignment, such as <tt>new(attributes)</tt> and
2004-11-23 20:04:44 -05:00
# <tt>attributes=(attributes)</tt>. Their assignment will simply be ignored. Instead, you can use the direct writer
2005-10-10 23:55:49 -04:00
# methods to do assignment. This is meant to protect sensitive attributes from being overwritten by URL/form hackers. Example:
2004-11-23 20:04:44 -05:00
#
# class Customer < ActiveRecord::Base
# attr_protected :credit_rating
# end
#
# customer = Customer.new("name" => David, "credit_rating" => "Excellent")
# customer.credit_rating # => nil
# customer.attributes = { "description" => "Jolly fellow", "credit_rating" => "Superb" }
# customer.credit_rating # => nil
#
# customer.credit_rating = "Average"
# customer.credit_rating # => "Average"
def attr_protected ( * attributes )
2005-10-12 15:59:13 -04:00
write_inheritable_array ( " attr_protected " , attributes - ( protected_attributes || [ ] ) )
2004-11-23 20:04:44 -05:00
end
2005-07-03 04:32:43 -04:00
2005-02-07 09:15:53 -05:00
# Returns an array of all the attributes that have been protected from mass-assignment.
2004-11-23 20:04:44 -05:00
def protected_attributes # :nodoc:
read_inheritable_attribute ( " attr_protected " )
end
2005-10-10 23:55:49 -04:00
# If this macro is used, only those attributes named in it will be accessible for mass-assignment, such as
2004-11-23 20:04:44 -05:00
# <tt>new(attributes)</tt> and <tt>attributes=(attributes)</tt>. This is the more conservative choice for mass-assignment
# protection. If you'd rather start from an all-open default and restrict attributes as needed, have a look at
# attr_protected.
def attr_accessible ( * attributes )
2005-10-12 15:59:13 -04:00
write_inheritable_array ( " attr_accessible " , attributes - ( accessible_attributes || [ ] ) )
2004-11-23 20:04:44 -05:00
end
2005-07-03 04:32:43 -04:00
2005-02-07 09:15:53 -05:00
# Returns an array of all the attributes that have been made accessible to mass-assignment.
2004-11-23 20:04:44 -05:00
def accessible_attributes # :nodoc:
read_inheritable_attribute ( " attr_accessible " )
end
2007-09-30 03:09:44 -04:00
# Attributes listed as readonly can be set for a new record, but will be ignored in database updates afterwards.
def attr_readonly ( * attributes )
write_inheritable_array ( " attr_readonly " , attributes - ( readonly_attributes || [ ] ) )
end
# Returns an array of all the attributes that have been specified as readonly.
def readonly_attributes
read_inheritable_attribute ( " attr_readonly " )
end
2006-03-05 16:37:12 -05:00
2007-06-23 13:52:50 -04:00
# If you have an attribute that needs to be saved to the database as an object, and retrieved as the same object,
# then specify the name of that attribute using this method and it will be handled automatically.
# The serialization is done through YAML. If +class_name+ is specified, the serialized object must be of that
# class on retrieval or +SerializationTypeMismatch+ will be raised.
#
# ==== Options
#
# +attr_name+ The field name that should be serialized
# +class_name+ Optional, class name that the object should be equal to
#
# ==== Example
# # Serialize a preferences attribute
# class User
# serialize :preferences
# end
2004-11-23 20:04:44 -05:00
def serialize ( attr_name , class_name = Object )
2005-07-03 04:32:43 -04:00
serialized_attributes [ attr_name . to_s ] = class_name
2004-11-23 20:04:44 -05:00
end
2005-07-03 04:32:43 -04:00
2004-11-23 20:04:44 -05:00
# Returns a hash of all the attributes that have been specified for serialization as keys and their class restriction as values.
def serialized_attributes
2005-07-03 04:32:43 -04:00
read_inheritable_attribute ( " attr_serialized " ) or write_inheritable_attribute ( " attr_serialized " , { } )
2004-11-23 20:04:44 -05:00
end
2006-03-05 16:37:12 -05:00
2004-11-23 20:04:44 -05:00
# Guesses the table name (in forced lower-case) based on the name of the class in the inheritance hierarchy descending
# directly from ActiveRecord. So if the hierarchy looks like: Reply < Message < ActiveRecord, then Message is used
2005-02-23 18:51:34 -05:00
# to guess the table name from even when called on Reply. The rules used to do the guess are handled by the Inflector class
# in Active Support, which knows almost all common English inflections (report a bug if your inflection isn't covered).
2004-11-23 20:04:44 -05:00
#
2006-08-16 05:46:43 -04:00
# Nested classes are given table names prefixed by the singular form of
# the parent's table name. Example:
# file class table_name
# invoice.rb Invoice invoices
# invoice/lineitem.rb Invoice::Lineitem invoice_lineitems
2004-11-23 20:04:44 -05:00
#
2006-08-16 05:46:43 -04:00
# Additionally, the class-level table_name_prefix is prepended and the
# table_name_suffix is appended. So if you have "myapp_" as a prefix,
# the table name guess for an Invoice class becomes "myapp_invoices".
# Invoice::Lineitem becomes "myapp_invoice_lineitems".
#
# You can also overwrite this class method to allow for unguessable
# links, such as a Mouse class with a link to a "mice" table. Example:
2004-11-23 20:04:44 -05:00
#
# class Mouse < ActiveRecord::Base
2006-08-16 05:46:43 -04:00
# set_table_name "mice"
2004-11-23 20:04:44 -05:00
# end
2004-12-22 08:00:15 -05:00
def table_name
2005-10-10 14:59:56 -04:00
reset_table_name
end
2006-03-27 22:06:40 -05:00
def reset_table_name #:nodoc:
2006-08-25 11:25:08 -04:00
base = base_class
name =
# STI subclasses always use their superclass' table.
unless self == base
base . table_name
else
# Nested classes are prefixed with singular parent table name.
if parent < ActiveRecord :: Base && ! parent . abstract_class?
contained = parent . table_name
contained = contained . singularize if parent . pluralize_table_names
contained << '_'
end
name = " #{ table_name_prefix } #{ contained } #{ undecorated_table_name ( base . name ) } #{ table_name_suffix } "
end
2006-03-05 16:37:12 -05:00
set_table_name ( name )
2005-10-10 14:59:56 -04:00
name
2004-11-23 20:04:44 -05:00
end
2005-02-07 09:15:53 -05:00
# Defines the primary key field -- can be overridden in subclasses. Overwriting will negate any effect of the
2004-11-23 20:04:44 -05:00
# primary_key_prefix_type setting, though.
def primary_key
2005-10-06 19:19:55 -04:00
reset_primary_key
end
2006-03-27 22:06:40 -05:00
def reset_primary_key #:nodoc:
2005-10-06 19:19:55 -04:00
key = 'id'
2004-11-23 20:04:44 -05:00
case primary_key_prefix_type
when :table_name
2006-03-15 21:46:01 -05:00
key = Inflector . foreign_key ( base_class . name , false )
2004-11-23 20:04:44 -05:00
when :table_name_with_underscore
2006-03-15 21:46:01 -05:00
key = Inflector . foreign_key ( base_class . name )
2004-11-23 20:04:44 -05:00
end
2005-10-06 19:19:55 -04:00
set_primary_key ( key )
key
2004-11-23 20:04:44 -05:00
end
2006-11-09 14:31:31 -05:00
# Defines the column name for use with single table inheritance
# -- can be set in subclasses like so: self.inheritance_column = "type_id"
2004-11-23 20:04:44 -05:00
def inheritance_column
2006-11-09 14:31:31 -05:00
@inheritance_column || = " type " . freeze
2004-11-23 20:04:44 -05:00
end
2005-11-12 06:59:54 -05:00
# Lazy-set the sequence name to the connection's default. This method
# is only ever called once since set_sequence_name overrides it.
2006-03-27 22:06:40 -05:00
def sequence_name #:nodoc:
2005-11-12 06:59:54 -05:00
reset_sequence_name
end
2006-03-27 22:06:40 -05:00
def reset_sequence_name #:nodoc:
2005-11-12 06:59:54 -05:00
default = connection . default_sequence_name ( table_name , primary_key )
set_sequence_name ( default )
default
2005-07-24 10:01:35 -04:00
end
2005-02-07 09:26:57 -05:00
# Sets the table name to use to the given value, or (if the value
2005-02-23 18:51:34 -05:00
# is nil or false) to the value returned by the given block.
2005-02-07 09:26:57 -05:00
#
# Example:
#
# class Project < ActiveRecord::Base
# set_table_name "project"
# end
2006-03-27 18:28:19 -05:00
def set_table_name ( value = nil , & block )
2005-02-07 09:26:57 -05:00
define_attr_method :table_name , value , & block
end
alias :table_name = :set_table_name
# Sets the name of the primary key column to use to the given value,
# or (if the value is nil or false) to the value returned by the given
2005-02-23 18:51:34 -05:00
# block.
2005-02-07 09:26:57 -05:00
#
# Example:
#
# class Project < ActiveRecord::Base
# set_primary_key "sysid"
# end
2006-03-27 18:28:19 -05:00
def set_primary_key ( value = nil , & block )
2005-02-07 09:26:57 -05:00
define_attr_method :primary_key , value , & block
end
alias :primary_key = :set_primary_key
# Sets the name of the inheritance column to use to the given value,
# or (if the value # is nil or false) to the value returned by the
2005-02-23 18:51:34 -05:00
# given block.
2005-02-07 09:26:57 -05:00
#
# Example:
#
# class Project < ActiveRecord::Base
# set_inheritance_column do
# original_inheritance_column + "_id"
# end
# end
2006-03-27 18:28:19 -05:00
def set_inheritance_column ( value = nil , & block )
2005-02-07 09:26:57 -05:00
define_attr_method :inheritance_column , value , & block
end
alias :inheritance_column = :set_inheritance_column
2005-07-24 10:01:35 -04:00
# Sets the name of the sequence to use when generating ids to the given
# value, or (if the value is nil or false) to the value returned by the
2005-10-15 23:45:39 -04:00
# given block. This is required for Oracle and is useful for any
# database which relies on sequences for primary key generation.
2005-07-24 10:01:35 -04:00
#
2005-11-16 03:16:54 -05:00
# If a sequence name is not explicitly set when using Oracle or Firebird,
# it will default to the commonly used pattern of: #{table_name}_seq
#
# If a sequence name is not explicitly set when using PostgreSQL, it
# will discover the sequence corresponding to your primary key for you.
2005-07-24 10:01:35 -04:00
#
# Example:
#
# class Project < ActiveRecord::Base
# set_sequence_name "projectseq" # default would have been "project_seq"
# end
2006-03-27 18:28:19 -05:00
def set_sequence_name ( value = nil , & block )
2005-07-24 10:01:35 -04:00
define_attr_method :sequence_name , value , & block
end
alias :sequence_name = :set_sequence_name
2004-11-23 20:04:44 -05:00
# Turns the +table_name+ back into a class name following the reverse rules of +table_name+.
def class_name ( table_name = table_name ) # :nodoc:
# remove any prefix and/or suffix from the table name
2005-07-03 04:32:39 -04:00
class_name = table_name [ table_name_prefix . length .. - ( table_name_suffix . length + 1 ) ] . camelize
class_name = class_name . singularize if pluralize_table_names
class_name
2004-11-23 20:04:44 -05:00
end
2005-10-28 03:40:28 -04:00
# Indicates whether the table associated with this class exists
def table_exists?
if connection . respond_to? ( :tables )
connection . tables . include? table_name
else
# if the connection adapter hasn't implemented tables, there are two crude tests that can be
# used - see if getting column info raises an error, or if the number of columns returned is zero
begin
reset_column_information
columns . size > 0
rescue ActiveRecord :: StatementInvalid
false
end
end
end
2004-11-23 20:04:44 -05:00
# Returns an array of column objects for the table associated with this class.
def columns
2005-10-06 19:19:55 -04:00
unless @columns
@columns = connection . columns ( table_name , " #{ name } Columns " )
@columns . each { | column | column . primary = column . name == primary_key }
end
@columns
2004-11-23 20:04:44 -05:00
end
2005-07-03 04:32:43 -04:00
2006-12-27 15:41:55 -05:00
# Returns a hash of column objects for the table associated with this class.
2004-11-23 20:04:44 -05:00
def columns_hash
@columns_hash || = columns . inject ( { } ) { | hash , column | hash [ column . name ] = column ; hash }
end
2005-06-12 02:56:51 -04:00
2006-03-27 22:06:40 -05:00
# Returns an array of column names as strings.
2005-04-18 14:49:34 -04:00
def column_names
2005-06-12 02:56:51 -04:00
@column_names || = columns . map { | column | column . name }
2005-04-18 14:49:34 -04:00
end
2004-11-23 20:04:44 -05:00
2005-10-10 23:55:49 -04:00
# Returns an array of column objects where the primary id, all columns ending in "_id" or "_count",
# and columns used for single table inheritance have been removed.
2004-11-23 20:04:44 -05:00
def content_columns
2005-10-06 19:19:55 -04:00
@content_columns || = columns . reject { | c | c . primary || c . name =~ / (_id|_count)$ / || c . name == inheritance_column }
2004-11-23 20:04:44 -05:00
end
# Returns a hash of all the methods added to query each of the columns in the table with the name of the method as the key
# and true as the value. This makes it possible to do O(1) lookups in respond_to? to check if a given method for attribute
2005-07-03 04:32:43 -04:00
# is available.
2006-03-27 22:06:40 -05:00
def column_methods_hash #:nodoc:
2005-06-12 02:56:51 -04:00
@dynamic_methods_hash || = column_names . inject ( Hash . new ( false ) ) do | methods , attr |
2005-10-22 12:43:39 -04:00
attr_name = attr . to_s
methods [ attr . to_sym ] = attr_name
methods [ " #{ attr } = " . to_sym ] = attr_name
methods [ " #{ attr } ? " . to_sym ] = attr_name
methods [ " #{ attr } _before_type_cast " . to_sym ] = attr_name
2004-11-23 20:04:44 -05:00
methods
end
end
2005-07-03 04:32:43 -04:00
2005-10-10 23:55:49 -04:00
# Resets all the cached information about columns, which will cause them to be reloaded on the next request.
2004-12-12 12:49:38 -05:00
def reset_column_information
2007-08-14 04:53:02 -04:00
generated_methods . each { | name | undef_method ( name ) }
@column_names = @columns = @columns_hash = @content_columns = @dynamic_methods_hash = @generated_methods = @inheritance_column = nil
2004-12-12 12:49:38 -05:00
end
2005-02-23 18:51:34 -05:00
def reset_column_information_and_inheritable_attributes_for_all_subclasses #:nodoc:
2004-12-12 12:49:38 -05:00
subclasses . each { | klass | klass . reset_inheritable_attributes ; klass . reset_column_information }
end
2004-11-23 20:04:44 -05:00
# Transforms attribute key names into a more humane format, such as "First name" instead of "first_name". Example:
# Person.human_attribute_name("first_name") # => "First name"
2005-02-23 18:51:34 -05:00
# Deprecated in favor of just calling "first_name".humanize
def human_attribute_name ( attribute_key_name ) #:nodoc:
2005-01-17 14:58:02 -05:00
attribute_key_name . humanize
2004-11-23 20:04:44 -05:00
end
2005-07-03 04:32:43 -04:00
2007-01-22 23:19:16 -05:00
# True if this isn't a concrete subclass needing a STI type condition.
def descends_from_active_record?
if superclass . abstract_class?
superclass . descends_from_active_record?
else
superclass == Base || ! columns_hash . include? ( inheritance_column )
end
2004-11-23 20:04:44 -05:00
end
2007-10-03 01:31:36 -04:00
def finder_needs_type_condition? #:nodoc:
# This is like this because benchmarking justifies the strange :false stuff
:true == ( @finder_needs_type_condition || = descends_from_active_record? ? :false : :true )
end
2007-05-31 13:31:33 -04:00
# Returns a string like 'Post id:integer, title:string, body:text'
2007-04-21 13:35:09 -04:00
def inspect
2007-05-31 13:31:33 -04:00
if self == Base
super
elsif abstract_class?
" #{ super } (abstract) "
2007-08-05 20:18:50 -04:00
elsif table_exists?
2007-05-31 13:31:33 -04:00
attr_list = columns . map { | c | " #{ c . name } : #{ c . type } " } * ', '
" #{ super } ( #{ attr_list } ) "
2007-08-05 20:18:50 -04:00
else
" #{ super } (Table doesn't exist) "
2007-05-31 13:31:33 -04:00
end
2007-04-21 13:35:09 -04:00
end
2006-09-04 19:41:13 -04:00
def quote_value ( value , column = nil ) #:nodoc:
2006-04-27 18:39:45 -04:00
connection . quote ( value , column )
2004-12-07 09:48:53 -05:00
end
# Used to sanitize objects before they're used in an SELECT SQL-statement. Delegates to <tt>connection.quote</tt>.
2005-02-23 18:51:34 -05:00
def sanitize ( object ) #:nodoc:
2004-12-07 09:48:53 -05:00
connection . quote ( object )
2004-11-23 20:04:44 -05:00
end
2005-09-06 13:47:31 -04:00
# Log and benchmark multiple statements in a single block. Example:
2004-11-23 20:04:44 -05:00
#
# Project.benchmark("Creating project") do
# project = Project.create("name" => "stuff")
# project.create_manager("name" => "David")
2005-06-26 07:25:32 -04:00
# project.milestones << Milestone.find(:all)
2004-11-23 20:04:44 -05:00
# end
2005-09-06 12:48:18 -04:00
#
2005-09-06 13:47:31 -04:00
# The benchmark is only recorded if the current level of the logger matches the <tt>log_level</tt>, which makes it
# easy to include benchmarking statements in production software that will remain inexpensive because the benchmark
# will only be conducted if the log level is low enough.
#
2005-10-10 23:55:49 -04:00
# The logging of the multiple statements is turned off unless <tt>use_silence</tt> is set to false.
2005-09-06 13:47:31 -04:00
def benchmark ( title , log_level = Logger :: DEBUG , use_silence = true )
if logger && logger . level == log_level
2005-09-06 12:48:18 -04:00
result = nil
seconds = Benchmark . realtime { result = use_silence ? silence { yield } : yield }
2005-09-06 13:47:31 -04:00
logger . add ( log_level , " #{ title } ( #{ '%.5f' % seconds } ) " )
2005-09-06 12:48:18 -04:00
result
else
yield
end
2005-02-16 20:23:41 -05:00
end
2005-07-03 04:32:39 -04:00
2005-02-16 20:23:41 -05:00
# Silences the logger for the duration of the block.
def silence
2005-07-03 04:32:39 -04:00
old_logger_level , logger . level = logger . level , Logger :: ERROR if logger
yield
ensure
2005-04-13 01:16:52 -04:00
logger . level = old_logger_level if logger
2004-11-23 20:04:44 -05:00
end
2005-11-06 05:18:51 -05:00
2005-01-23 10:19:33 -05:00
# Overwrite the default class equality method to provide support for association proxies.
def === ( object )
object . is_a? ( self )
2005-07-22 16:05:42 -04:00
end
2005-10-12 18:37:28 -04:00
2006-01-20 15:43:40 -05:00
# Returns the base AR subclass that this class descends from. If A
# extends AR::Base, A.base_class will return A. If B descends from A
# through some arbitrarily deep hierarchy, B.base_class will return A.
def base_class
class_of_active_record_descendant ( self )
end
2006-03-15 21:46:01 -05:00
# Set this to true if this is an abstract class (see #abstract_class?).
attr_accessor :abstract_class
# Returns whether this class is a base AR class. If A is a base class and
# B descends from A, then B.base_class will return B.
def abstract_class?
abstract_class == true
end
2004-11-23 20:04:44 -05:00
private
2006-03-27 18:28:19 -05:00
def find_initial ( options )
options . update ( :limit = > 1 ) unless options [ :include ]
find_every ( options ) . first
end
2006-11-05 16:27:51 -05:00
2006-03-27 18:28:19 -05:00
def find_every ( options )
records = scoped? ( :find , :include ) || options [ :include ] ?
find_with_associations ( options ) :
find_by_sql ( construct_finder_sql ( options ) )
records . each { | record | record . readonly! } if options [ :readonly ]
records
end
2006-11-05 16:27:51 -05:00
2006-03-27 18:28:19 -05:00
def find_from_ids ( ids , options )
2006-11-05 16:27:51 -05:00
expects_array = ids . first . kind_of? ( Array )
2006-03-27 18:28:19 -05:00
return ids . first if expects_array && ids . first . empty?
2006-11-05 16:27:51 -05:00
2006-03-27 18:28:19 -05:00
ids = ids . flatten . compact . uniq
case ids . size
when 0
raise RecordNotFound , " Couldn't find #{ name } without an ID "
when 1
result = find_one ( ids . first , options )
expects_array ? [ result ] : result
else
find_some ( ids , options )
end
end
def find_one ( id , options )
conditions = " AND ( #{ sanitize_sql ( options [ :conditions ] ) } ) " if options [ :conditions ]
2007-10-16 01:06:33 -04:00
options . update :conditions = > " #{ quoted_table_name } . #{ connection . quote_column_name ( primary_key ) } = #{ quote_value ( id , columns_hash [ primary_key ] ) } #{ conditions } "
2006-03-27 18:28:19 -05:00
2006-07-07 13:34:45 -04:00
# Use find_every(options).first since the primary key condition
# already ensures we have a single record. Using find_initial adds
# a superfluous :limit => 1.
if result = find_every ( options ) . first
2006-03-27 18:28:19 -05:00
result
else
raise RecordNotFound , " Couldn't find #{ name } with ID= #{ id } #{ conditions } "
end
end
def find_some ( ids , options )
conditions = " AND ( #{ sanitize_sql ( options [ :conditions ] ) } ) " if options [ :conditions ]
2006-09-04 19:41:13 -04:00
ids_list = ids . map { | id | quote_value ( id , columns_hash [ primary_key ] ) } . join ( ',' )
2007-10-16 01:06:33 -04:00
options . update :conditions = > " #{ quoted_table_name } . #{ connection . quote_column_name ( primary_key ) } IN ( #{ ids_list } ) #{ conditions } "
2006-03-27 18:28:19 -05:00
result = find_every ( options )
2007-05-31 13:15:56 -04:00
# Determine expected size from limit and offset, not just ids.size.
2007-05-25 17:56:21 -04:00
expected_size =
if options [ :limit ] && ids . size > options [ :limit ]
options [ :limit ]
else
ids . size
end
2007-05-31 13:15:56 -04:00
# 11 ids with limit 3, offset 9 should give 2 results.
if options [ :offset ] && ( ids . size - options [ :offset ] < expected_size )
expected_size = ids . size - options [ :offset ]
end
2007-05-25 17:56:21 -04:00
if result . size == expected_size
2006-03-27 18:28:19 -05:00
result
else
2007-05-25 17:56:21 -04:00
raise RecordNotFound , " Couldn't find all #{ name . pluralize } with IDs ( #{ ids_list } ) #{ conditions } (found #{ result . size } results, but was looking for #{ expected_size } ) "
2006-03-27 18:28:19 -05:00
end
end
2006-08-23 23:36:48 -04:00
# Finder methods must instantiate through this method to work with the
# single-table inheritance model that makes it possible to create
# objects of different types from the same table.
2004-11-23 20:04:44 -05:00
def instantiate ( record )
2006-08-23 23:36:48 -04:00
object =
2005-10-09 18:26:54 -04:00
if subclass_name = record [ inheritance_column ]
2006-08-23 23:36:48 -04:00
# No type given.
2005-10-09 18:26:54 -04:00
if subclass_name . empty?
allocate
2006-08-23 23:36:48 -04:00
2005-10-09 18:26:54 -04:00
else
2006-08-23 23:36:48 -04:00
# Ignore type if no column is present since it was probably
# pulled in from a sloppy join.
2006-11-09 14:31:31 -05:00
unless columns_hash . include? ( inheritance_column )
2006-08-23 23:36:48 -04:00
allocate
else
begin
compute_type ( subclass_name ) . allocate
rescue NameError
raise SubclassNotFound ,
" The single-table inheritance mechanism failed to locate the subclass: ' #{ record [ inheritance_column ] } '. " +
" This error is raised because the column ' #{ inheritance_column } ' is reserved for storing the class in case of inheritance. " +
" Please rename this column if you didn't intend it to be used for storing the inheritance class " +
" or overwrite #{ self . to_s } .inheritance_column to use another column for that information. "
end
2005-10-09 18:26:54 -04:00
end
end
else
allocate
2005-07-03 04:32:39 -04:00
end
2004-12-14 07:32:29 -05:00
2004-11-23 20:04:44 -05:00
object . instance_variable_set ( " @attributes " , record )
2007-08-14 04:53:02 -04:00
object . instance_variable_set ( " @attributes_cache " , Hash . new )
2007-08-30 21:56:39 -04:00
if object . respond_to_without_attributes? ( :after_find )
object . send ( :callback , :after_find )
end
if object . respond_to_without_attributes? ( :after_initialize )
object . send ( :callback , :after_initialize )
end
2005-07-03 04:32:39 -04:00
object
2004-11-23 20:04:44 -05:00
end
2005-07-03 04:32:39 -04:00
2006-02-22 13:44:14 -05:00
# Nest the type name in the same module as this class.
# Bar is "MyApp::Business::Bar" relative to MyApp::Business::Foo
2004-11-23 20:04:44 -05:00
def type_name_with_module ( type_name )
2006-04-06 12:06:38 -04:00
( / ^:: / =~ type_name ) ? type_name : " #{ parent . name } :: #{ type_name } "
2004-11-23 20:04:44 -05:00
end
2005-04-03 06:52:05 -04:00
def construct_finder_sql ( options )
2006-03-27 18:28:19 -05:00
scope = scope ( :find )
2007-10-16 01:06:33 -04:00
sql = " SELECT #{ ( scope && scope [ :select ] ) || options [ :select ] || ( options [ :joins ] && quoted_table_name + '.*' ) || '*' } "
sql << " FROM #{ ( scope && scope [ :from ] ) || options [ :from ] || quoted_table_name } "
2005-12-02 23:29:55 -05:00
2006-03-27 18:28:19 -05:00
add_joins! ( sql , options , scope )
add_conditions! ( sql , options [ :conditions ] , scope )
2005-12-02 23:29:55 -05:00
2007-08-21 17:58:38 -04:00
add_group! ( sql , options [ :group ] , scope )
2006-11-07 14:06:35 -05:00
add_order! ( sql , options [ :order ] , scope )
2006-03-27 18:28:19 -05:00
add_limit! ( sql , options , scope )
2006-06-19 18:48:51 -04:00
add_lock! ( sql , options , scope )
2005-12-02 23:29:55 -05:00
2005-07-03 04:32:43 -04:00
sql
2005-04-03 08:06:23 -04:00
end
2005-04-03 06:52:05 -04:00
2006-03-27 01:19:31 -05:00
# Merges includes so that the result is a valid +include+
def merge_includes ( first , second )
2006-06-03 17:11:48 -04:00
( safe_to_array ( first ) + safe_to_array ( second ) ) . uniq
2006-03-27 01:19:31 -05:00
end
2006-06-02 20:01:08 -04:00
# Object#to_a is deprecated, though it does have the desired behavior
2006-03-27 01:19:31 -05:00
def safe_to_array ( o )
case o
when NilClass
[ ]
when Array
o
else
[ o ]
end
end
2006-11-07 14:06:35 -05:00
def add_order! ( sql , order , scope = :auto )
scope = scope ( :find ) if :auto == scope
scoped_order = scope [ :order ] if scope
2006-04-26 02:37:04 -04:00
if order
sql << " ORDER BY #{ order } "
2006-11-07 14:06:35 -05:00
sql << " , #{ scoped_order } " if scoped_order
2006-04-26 02:37:04 -04:00
else
2006-11-07 14:06:35 -05:00
sql << " ORDER BY #{ scoped_order } " if scoped_order
2006-04-26 02:37:04 -04:00
end
end
2007-08-21 17:58:38 -04:00
2007-09-13 19:13:34 -04:00
def add_group! ( sql , group , scope = :auto )
2007-08-21 17:58:38 -04:00
if group
sql << " GROUP BY #{ group } "
2007-09-13 19:13:34 -04:00
else
scope = scope ( :find ) if :auto == scope
if scope && ( scoped_group = scope [ :group ] )
sql << " GROUP BY #{ scoped_group } "
end
end
2007-08-21 17:58:38 -04:00
end
2006-04-26 02:37:04 -04:00
2006-04-01 18:15:35 -05:00
# The optional scope argument is for the current :find scope.
2006-04-03 12:09:47 -04:00
def add_limit! ( sql , options , scope = :auto )
scope = scope ( :find ) if :auto == scope
2007-09-13 19:13:34 -04:00
if scope
options [ :limit ] || = scope [ :limit ]
options [ :offset ] || = scope [ :offset ]
end
2005-07-01 13:20:04 -04:00
connection . add_limit_offset! ( sql , options )
2005-04-03 06:52:05 -04:00
end
2005-11-06 05:18:51 -05:00
2006-06-19 18:48:51 -04:00
# The optional scope argument is for the current :find scope.
# The :lock option has precedence over a scoped :lock.
def add_lock! ( sql , options , scope = :auto )
2007-01-12 05:18:11 -05:00
scope = scope ( :find ) if :auto == scope
2006-06-19 18:48:51 -04:00
options = options . reverse_merge ( :lock = > scope [ :lock ] ) if scope
connection . add_lock! ( sql , options )
end
2006-04-01 18:15:35 -05:00
# The optional scope argument is for the current :find scope.
2006-04-03 12:09:47 -04:00
def add_joins! ( sql , options , scope = :auto )
scope = scope ( :find ) if :auto == scope
2006-03-27 18:28:19 -05:00
join = ( scope && scope [ :joins ] ) || options [ :joins ]
2005-07-22 16:05:42 -04:00
sql << " #{ join } " if join
end
2005-11-06 05:18:51 -05:00
2005-10-10 23:55:49 -04:00
# Adds a sanitized version of +conditions+ to the +sql+ string. Note that the passed-in +sql+ string is changed.
2006-04-01 18:15:35 -05:00
# The optional scope argument is for the current :find scope.
2006-04-03 12:09:47 -04:00
def add_conditions! ( sql , conditions , scope = :auto )
scope = scope ( :find ) if :auto == scope
2006-03-27 18:28:19 -05:00
segments = [ ]
2007-05-25 20:35:49 -04:00
segments << sanitize_sql ( scope [ :conditions ] ) if scope && ! scope [ :conditions ] . blank?
segments << sanitize_sql ( conditions ) unless conditions . blank?
2007-10-03 01:31:36 -04:00
segments << type_condition if finder_needs_type_condition?
segments . delete_if { | s | s . blank? }
sql << " WHERE ( #{ segments . join ( " ) AND ( " ) } ) " unless segments . empty?
2004-11-23 20:04:44 -05:00
end
2005-07-03 04:32:43 -04:00
2004-11-23 20:04:44 -05:00
def type_condition
2005-11-16 03:16:54 -05:00
quoted_inheritance_column = connection . quote_column_name ( inheritance_column )
2007-10-16 01:06:33 -04:00
type_condition = subclasses . inject ( " #{ quoted_table_name } . #{ quoted_inheritance_column } = ' #{ name . demodulize } ' " ) do | condition , subclass |
condition << " OR #{ quoted_table_name } . #{ quoted_inheritance_column } = ' #{ subclass . name . demodulize } ' "
2005-04-10 11:49:49 -04:00
end
2005-07-03 04:32:43 -04:00
" ( #{ type_condition } ) "
2004-11-23 20:04:44 -05:00
end
# Guesses the table name, but does not decorate it with prefix and suffix information.
2006-03-15 21:46:01 -05:00
def undecorated_table_name ( class_name = base_class . name )
2004-11-23 20:04:44 -05:00
table_name = Inflector . underscore ( Inflector . demodulize ( class_name ) )
table_name = Inflector . pluralize ( table_name ) if pluralize_table_names
2005-07-03 04:32:43 -04:00
table_name
2004-11-23 20:04:44 -05:00
end
2005-07-03 04:32:43 -04:00
# Enables dynamic finders like find_by_user_name(user_name) and find_by_user_name_and_password(user_name, password) that are turned into
# find(:first, :conditions => ["user_name = ?", user_name]) and find(:first, :conditions => ["user_name = ? AND password = ?", user_name, password])
2005-06-26 07:25:32 -04:00
# respectively. Also works for find(:all), but using find_all_by_amount(50) that are turned into find(:all, :conditions => ["amount = ?", 50]).
2005-07-03 04:32:43 -04:00
#
2005-04-17 13:16:24 -04:00
# It's even possible to use all the additional parameters to find. For example, the full interface for find_all_by_amount
# is actually find_all_by_amount(amount, options).
2007-03-27 10:04:06 -04:00
#
# This also enables you to initialize a record if it is not found, such as find_or_initialize_by_amount(amount)
# or find_or_create_by_user_and_password(user, password).
2007-09-18 06:04:11 -04:00
#
# Each dynamic finder or initializer/creator is also defined in the class after it is first invoked, so that future
# attempts to use it do not run through method_missing.
2005-01-02 08:31:00 -05:00
def method_missing ( method_id , * arguments )
2006-12-27 15:35:19 -05:00
if match = / ^find_(all_by|by)_([_a-zA-Z] \ w*)$ / . match ( method_id . to_s )
2007-06-11 03:45:56 -04:00
finder = determine_finder ( match )
2005-01-02 08:31:00 -05:00
2005-11-04 14:39:50 -05:00
attribute_names = extract_attribute_names_from_match ( match )
super unless all_attributes_exists? ( attribute_names )
2005-01-24 08:02:50 -05:00
2007-09-18 06:04:11 -04:00
self . class_eval %{
def self . #{method_id}(*args)
options = args . last . is_a? ( Hash ) ? args . pop : { }
attributes = construct_attributes_from_arguments ( [ : #{attribute_names.join(',:')}], args)
finder_options = { :conditions = > attributes }
validate_find_options ( options )
2006-03-27 18:28:19 -05:00
set_readonly_option! ( options )
2007-09-18 06:04:11 -04:00
if options [ :conditions ]
with_scope ( :find = > finder_options ) do
ActiveSupport :: Deprecation . silence { send ( : #{finder}, options) }
2006-03-27 18:28:19 -05:00
end
else
2007-09-18 06:04:11 -04:00
ActiveSupport :: Deprecation . silence { send ( : #{finder}, options.merge(finder_options)) }
2006-01-22 04:34:41 -05:00
end
2007-09-18 06:04:11 -04:00
end
2007-10-10 15:11:50 -04:00
} , __FILE__ , __LINE__
2007-09-18 06:04:11 -04:00
send ( method_id , * arguments )
2006-12-27 15:35:19 -05:00
elsif match = / ^find_or_(initialize|create)_by_([_a-zA-Z] \ w*)$ / . match ( method_id . to_s )
2006-06-20 18:48:52 -04:00
instantiator = determine_instantiator ( match )
2005-11-04 14:39:50 -05:00
attribute_names = extract_attribute_names_from_match ( match )
super unless all_attributes_exists? ( attribute_names )
2007-09-18 06:04:11 -04:00
self . class_eval %{
def self . #{method_id}(*args)
if args [ 0 ] . is_a? ( Hash )
attributes = args [ 0 ] . with_indifferent_access
find_attributes = attributes . slice ( * [ : #{attribute_names.join(',:')}])
else
find_attributes = attributes = construct_attributes_from_arguments ( [ : #{attribute_names.join(',:')}], args)
end
2007-10-10 15:11:50 -04:00
2007-09-18 06:04:11 -04:00
options = { :conditions = > find_attributes }
set_readonly_option! ( options )
2006-11-05 16:27:51 -05:00
2007-10-10 15:11:50 -04:00
record = find_initial ( options )
if record . nil?
record = self . new { | r | r . send ( :attributes = , attributes , false ) }
#{'record.save' if instantiator == :create}
record
else
record
end
2007-09-18 06:04:11 -04:00
end
2007-10-10 15:11:50 -04:00
} , __FILE__ , __LINE__
2007-09-18 06:04:11 -04:00
send ( method_id , * arguments )
2005-01-02 08:31:00 -05:00
else
super
end
end
2004-11-23 20:04:44 -05:00
2005-11-04 14:39:50 -05:00
def determine_finder ( match )
2006-03-27 18:28:19 -05:00
match . captures . first == 'all_by' ? :find_every : :find_initial
end
2006-06-20 18:48:52 -04:00
def determine_instantiator ( match )
match . captures . first == 'initialize' ? :new : :create
end
2005-11-04 14:39:50 -05:00
def extract_attribute_names_from_match ( match )
match . captures . last . split ( '_and_' )
end
def construct_attributes_from_arguments ( attribute_names , arguments )
attributes = { }
attribute_names . each_with_index { | name , idx | attributes [ name ] = arguments [ idx ] }
attributes
end
def all_attributes_exists? ( attribute_names )
attribute_names . all? { | name | column_methods_hash . include? ( name . to_sym ) }
2007-08-14 04:53:02 -04:00
end
2005-11-04 14:39:50 -05:00
2005-05-02 01:34:27 -04:00
def attribute_condition ( argument )
case argument
when nil then " IS ? "
2007-06-26 22:56:11 -04:00
when Array , ActiveRecord :: Associations :: AssociationCollection then " IN (?) "
2007-01-10 05:13:18 -05:00
when Range then " BETWEEN ? AND ? "
2005-05-02 01:34:27 -04:00
else " = ? "
end
end
2006-08-03 18:06:33 -04:00
# Interpret Array and Hash as conditions and anything else as an id.
def expand_id_conditions ( id_or_conditions )
case id_or_conditions
when Array , Hash then id_or_conditions
2006-11-05 16:27:51 -05:00
else sanitize_sql ( primary_key = > id_or_conditions )
2006-08-03 18:06:33 -04:00
end
end
2005-02-23 18:51:34 -05:00
# Defines an "attribute" method (like #inheritance_column or
# #table_name). A new (class) method will be created with the
# given name. If a value is specified, the new method will
# return that value (as a string). Otherwise, the given block
# will be used to compute the value of the method.
#
# The original method will be aliased, with the new name being
# prefixed with "original_". This allows the new method to
# access the original value.
#
# Example:
#
# class A < ActiveRecord::Base
# define_attr_method :primary_key, "sysid"
# define_attr_method( :inheritance_column ) do
# original_inheritance_column + "_id"
# end
# end
def define_attr_method ( name , value = nil , & block )
sing = class << self ; self ; end
2005-10-14 11:04:57 -04:00
sing . send :alias_method , " original_ #{ name } " , name
2005-11-12 06:59:54 -05:00
if block_given?
sing . send :define_method , name , & block
else
2005-10-14 11:04:57 -04:00
# use eval instead of a block to work around a memory leak in dev
# mode in fcgi
sing . class_eval " def #{ name } ; #{ value . to_s . inspect } ; end "
end
2005-02-23 18:51:34 -05:00
end
2004-11-23 20:04:44 -05:00
protected
2007-05-30 17:40:55 -04:00
# Scope parameters to method calls within the block. Takes a hash of method_name => parameters hash.
# method_name may be :find or :create. :find parameters may include the <tt>:conditions</tt>, <tt>:joins</tt>,
# <tt>:include</tt>, <tt>:offset</tt>, <tt>:limit</tt>, and <tt>:readonly</tt> options. :create parameters are an attributes hash.
#
# class Article < ActiveRecord::Base
# def self.create_with_scope
# with_scope(:find => { :conditions => "blog_id = 1" }, :create => { :blog_id => 1 }) do
# find(1) # => SELECT * from articles WHERE blog_id = 1 AND id = 1
# a = create(1)
# a.blog_id # => 1
# end
# end
# end
#
2007-06-23 13:34:41 -04:00
# In nested scopings, all previous parameters are overwritten by the innermost rule, with the exception of
# :conditions and :include options in :find, which are merged.
2007-05-30 17:40:55 -04:00
#
# class Article < ActiveRecord::Base
# def self.find_with_scope
# with_scope(:find => { :conditions => "blog_id = 1", :limit => 1 }, :create => { :blog_id => 1 }) do
# with_scope(:find => { :limit => 10})
# find(:all) # => SELECT * from articles WHERE blog_id = 1 LIMIT 10
# end
# with_scope(:find => { :conditions => "author_id = 3" })
# find(:all) # => SELECT * from articles WHERE blog_id = 1 AND author_id = 3 LIMIT 1
# end
# end
# end
# end
#
# You can ignore any previous scopings by using <tt>with_exclusive_scope</tt> method.
#
# class Article < ActiveRecord::Base
# def self.find_with_exclusive_scope
# with_scope(:find => { :conditions => "blog_id = 1", :limit => 1 }) do
# with_exclusive_scope(:find => { :limit => 10 })
# find(:all) # => SELECT * from articles LIMIT 10
# end
# end
# end
# end
def with_scope ( method_scoping = { } , action = :merge , & block )
method_scoping = method_scoping . method_scoping if method_scoping . respond_to? ( :method_scoping )
# Dup first and second level of hash (method and params).
method_scoping = method_scoping . inject ( { } ) do | hash , ( method , params ) |
hash [ method ] = ( params == true ) ? params : params . dup
hash
end
method_scoping . assert_valid_keys ( [ :find , :create ] )
if f = method_scoping [ :find ]
2007-08-21 17:58:38 -04:00
f . assert_valid_keys ( [ :conditions , :joins , :select , :include , :from , :offset , :limit , :order , :group , :readonly , :lock ] )
2007-05-30 17:40:55 -04:00
set_readonly_option! f
end
# Merge scopings
if action == :merge && current_scoped_methods
method_scoping = current_scoped_methods . inject ( method_scoping ) do | hash , ( method , params ) |
case hash [ method ]
when Hash
if method == :find
( hash [ method ] . keys + params . keys ) . uniq . each do | key |
merge = hash [ method ] [ key ] && params [ key ] # merge if both scopes have the same key
if key == :conditions && merge
hash [ method ] [ key ] = [ params [ key ] , hash [ method ] [ key ] ] . collect { | sql | " ( %s ) " % sanitize_sql ( sql ) } . join ( " AND " )
elsif key == :include && merge
hash [ method ] [ key ] = merge_includes ( hash [ method ] [ key ] , params [ key ] ) . uniq
else
hash [ method ] [ key ] = hash [ method ] [ key ] || params [ key ]
end
end
else
hash [ method ] = params . merge ( hash [ method ] )
end
else
hash [ method ] = params
end
hash
end
end
self . scoped_methods << method_scoping
begin
yield
ensure
self . scoped_methods . pop
end
end
# Works like with_scope, but discards any nested properties.
def with_exclusive_scope ( method_scoping = { } , & block )
with_scope ( method_scoping , :overwrite , & block )
end
2006-03-27 22:06:40 -05:00
def subclasses #:nodoc:
2004-11-23 20:04:44 -05:00
@@subclasses [ self ] || = [ ]
@@subclasses [ self ] + extra = @@subclasses [ self ] . inject ( [ ] ) { | list , subclass | list + subclass . subclasses }
end
2005-11-06 05:18:51 -05:00
# Test whether the given method and optional key are scoped.
2006-03-27 22:06:40 -05:00
def scoped? ( method , key = nil ) #:nodoc:
2006-03-27 18:28:19 -05:00
if current_scoped_methods && ( scope = current_scoped_methods [ method ] )
! key || scope . has_key? ( key )
end
2005-11-06 05:18:51 -05:00
end
# Retrieve the scope for the given method and optional key.
2006-03-27 22:06:40 -05:00
def scope ( method , key = nil ) #:nodoc:
2006-03-27 18:28:19 -05:00
if current_scoped_methods && ( scope = current_scoped_methods [ method ] )
2005-11-06 05:18:51 -05:00
key ? scope [ key ] : scope
end
end
2006-03-13 12:28:55 -05:00
def thread_safe_scoped_methods #:nodoc:
scoped_methods = ( Thread . current [ :scoped_methods ] || = { } )
scoped_methods [ self ] || = [ ]
2005-07-22 16:05:42 -04:00
end
2006-03-13 12:28:55 -05:00
def single_threaded_scoped_methods #:nodoc:
@scoped_methods || = [ ]
end
# pick up the correct scoped_methods version from @@allow_concurrency
if @@allow_concurrency
alias_method :scoped_methods , :thread_safe_scoped_methods
else
alias_method :scoped_methods , :single_threaded_scoped_methods
end
2006-03-27 22:06:40 -05:00
def current_scoped_methods #:nodoc:
2006-02-26 15:12:09 -05:00
scoped_methods . last
2005-07-22 16:05:42 -04:00
end
2005-11-06 05:18:51 -05:00
2005-10-10 23:55:49 -04:00
# Returns the class type of the record using the current module as a prefix. So descendents of
# MyApp::Business::Account would appear as MyApp::Business::AccountSubclass.
2004-11-23 20:04:44 -05:00
def compute_type ( type_name )
2006-03-27 20:48:59 -05:00
modularized_name = type_name_with_module ( type_name )
2006-02-22 13:44:14 -05:00
begin
2006-12-19 14:23:56 -05:00
class_eval ( modularized_name , __FILE__ , __LINE__ )
rescue NameError
class_eval ( type_name , __FILE__ , __LINE__ )
2004-11-23 20:04:44 -05:00
end
end
2006-01-20 15:43:40 -05:00
# Returns the class descending directly from ActiveRecord in the inheritance hierarchy.
def class_of_active_record_descendant ( klass )
2006-12-19 14:47:21 -05:00
if klass . superclass == Base || klass . superclass . abstract_class?
2006-01-20 15:43:40 -05:00
klass
2004-11-23 20:04:44 -05:00
elsif klass . superclass . nil?
raise ActiveRecordError , " #{ name } doesn't belong in a hierarchy descending from ActiveRecord "
else
2006-01-20 15:43:40 -05:00
class_of_active_record_descendant ( klass . superclass )
2004-11-23 20:04:44 -05:00
end
end
2006-01-20 15:43:40 -05:00
# Returns the name of the class descending directly from ActiveRecord in the inheritance hierarchy.
2006-03-27 22:06:40 -05:00
def class_name_of_active_record_descendant ( klass ) #:nodoc:
2006-03-15 21:46:01 -05:00
klass . base_class . name
2006-01-20 15:43:40 -05:00
end
2006-11-05 16:27:51 -05:00
# Accepts an array, hash, or string of sql conditions and sanitizes
2007-01-28 10:12:54 -05:00
# them into a valid SQL fragment for a WHERE clause.
2006-06-03 18:15:06 -04:00
# ["name='%s' and group_id='%s'", "foo'bar", 4] returns "name='foo''bar' and group_id='4'"
# { :name => "foo'bar", :group_id => 4 } returns "name='foo''bar' and group_id='4'"
# "name='foo''bar' and group_id='4'" returns "name='foo''bar' and group_id='4'"
2007-01-28 10:12:54 -05:00
def sanitize_sql_for_conditions ( condition )
2006-11-05 16:27:51 -05:00
case condition
when Array ; sanitize_sql_array ( condition )
2007-01-28 10:12:54 -05:00
when Hash ; sanitize_sql_hash_for_conditions ( condition )
2006-11-05 16:27:51 -05:00
else condition
end
2006-06-03 18:15:06 -04:00
end
2007-01-28 10:12:54 -05:00
alias_method :sanitize_sql , :sanitize_sql_for_conditions
2006-11-05 16:27:51 -05:00
2007-01-28 10:12:54 -05:00
# Accepts an array, hash, or string of sql conditions and sanitizes
# them into a valid SQL fragment for a SET clause.
# { :name => nil, :group_id => 4 } returns "name = NULL , group_id='4'"
def sanitize_sql_for_assignment ( assignments )
case assignments
when Array ; sanitize_sql_array ( assignments )
when Hash ; sanitize_sql_hash_for_assignment ( assignments )
else assignments
end
end
# Sanitizes a hash of attribute/value pairs into SQL conditions for a WHERE clause.
2006-11-05 16:27:51 -05:00
# { :name => "foo'bar", :group_id => 4 }
# # => "name='foo''bar' and group_id= 4"
# { :status => nil, :group_id => [1,2,3] }
# # => "status IS NULL and group_id IN (1,2,3)"
2007-01-10 05:13:18 -05:00
# { :age => 13..18 }
# # => "age BETWEEN 13 AND 18"
2007-01-28 10:12:54 -05:00
def sanitize_sql_hash_for_conditions ( attrs )
2006-11-05 16:27:51 -05:00
conditions = attrs . map do | attr , value |
2007-10-16 01:06:33 -04:00
" #{ quoted_table_name } . #{ connection . quote_column_name ( attr ) } #{ attribute_condition ( value ) } "
2006-11-05 16:27:51 -05:00
end . join ( ' AND ' )
2007-01-10 05:13:18 -05:00
replace_bind_variables ( conditions , expand_range_bind_variables ( attrs . values ) )
2006-06-03 18:15:06 -04:00
end
2007-01-28 10:12:54 -05:00
alias_method :sanitize_sql_hash , :sanitize_sql_hash_for_conditions
# Sanitizes a hash of attribute/value pairs into SQL conditions for a SET clause.
# { :status => nil, :group_id => 1 }
# # => "status = NULL , group_id = 1"
def sanitize_sql_hash_for_assignment ( attrs )
conditions = attrs . map do | attr , value |
" #{ connection . quote_column_name ( attr ) } = #{ quote_bound_value ( value ) } "
end . join ( ', ' )
end
2006-11-05 16:27:51 -05:00
2006-06-03 18:15:06 -04:00
# Accepts an array of conditions. The array has each value
2005-01-01 14:50:23 -05:00
# sanitized and interpolated into the sql statement.
# ["name='%s' and group_id='%s'", "foo'bar", 4] returns "name='foo''bar' and group_id='4'"
2006-06-03 18:15:06 -04:00
def sanitize_sql_array ( ary )
2005-01-01 14:50:23 -05:00
statement , * values = ary
if values . first . is_a? ( Hash ) and statement =~ / : \ w+ /
replace_named_bind_variables ( statement , values . first )
elsif statement . include? ( '?' )
2004-12-08 05:38:10 -05:00
replace_bind_variables ( statement , values )
else
2004-12-07 09:48:53 -05:00
statement % values . collect { | value | connection . quote_string ( value . to_s ) }
2004-12-08 05:38:10 -05:00
end
2004-12-07 05:37:50 -05:00
end
2005-01-01 14:50:23 -05:00
alias_method :sanitize_conditions , :sanitize_sql
2006-03-27 22:06:40 -05:00
def replace_bind_variables ( statement , values ) #:nodoc:
2005-01-02 07:45:53 -05:00
raise_if_bind_arity_mismatch ( statement , statement . count ( '?' ) , values . size )
2005-01-01 14:50:23 -05:00
bound = values . dup
2005-01-24 06:57:22 -05:00
statement . gsub ( '?' ) { quote_bound_value ( bound . shift ) }
2004-12-08 05:38:10 -05:00
end
2006-03-27 22:06:40 -05:00
def replace_named_bind_variables ( statement , bind_vars ) #:nodoc:
2005-01-01 14:50:23 -05:00
statement . gsub ( / :( \ w+) / ) do
match = $1 . to_sym
2005-07-03 04:32:39 -04:00
if bind_vars . include? ( match )
2005-01-24 06:57:22 -05:00
quote_bound_value ( bind_vars [ match ] )
2005-01-01 14:50:23 -05:00
else
raise PreparedStatementInvalid , " missing value for : #{ match } in #{ statement } "
2004-12-08 05:38:10 -05:00
end
end
2005-01-02 07:45:53 -05:00
end
2007-01-10 05:13:18 -05:00
def expand_range_bind_variables ( bind_vars ) #:nodoc:
bind_vars . each_with_index do | var , index |
bind_vars [ index , 1 ] = [ var . first , var . last ] if var . is_a? ( Range )
end
bind_vars
end
2006-03-27 22:06:40 -05:00
def quote_bound_value ( value ) #:nodoc:
2006-05-31 21:43:20 -04:00
if value . respond_to? ( :map ) && ! value . is_a? ( String )
if value . respond_to? ( :empty? ) && value . empty?
connection . quote ( nil )
2006-05-31 20:43:02 -04:00
else
value . map { | v | connection . quote ( v ) } . join ( ',' )
end
2005-06-16 06:13:37 -04:00
else
connection . quote ( value )
2005-01-24 06:57:22 -05:00
end
end
2006-03-27 22:06:40 -05:00
def raise_if_bind_arity_mismatch ( statement , expected , provided ) #:nodoc:
2005-01-02 07:45:53 -05:00
unless expected == provided
raise PreparedStatementInvalid , " wrong number of bind variables ( #{ provided } for #{ expected } ) in: #{ statement } "
end
2005-01-01 14:50:23 -05:00
end
2004-12-08 05:38:10 -05:00
2006-03-27 18:28:19 -05:00
VALID_FIND_OPTIONS = [ :conditions , :include , :joins , :limit , :offset ,
2006-06-19 18:48:51 -04:00
:order , :select , :readonly , :group , :from , :lock ]
2006-03-27 22:06:40 -05:00
def validate_find_options ( options ) #:nodoc:
2006-03-27 18:28:19 -05:00
options . assert_valid_keys ( VALID_FIND_OPTIONS )
end
2006-06-19 18:48:51 -04:00
2006-03-27 22:06:40 -05:00
def set_readonly_option! ( options ) #:nodoc:
2006-03-27 18:28:19 -05:00
# Inherit :readonly from finder scope if set. Otherwise,
# if :joins is not blank then :readonly defaults to true.
unless options . has_key? ( :readonly )
2007-09-13 04:20:08 -04:00
if scoped_readonly = scope ( :find , :readonly )
options [ :readonly ] = scoped_readonly
2006-03-30 17:27:32 -05:00
elsif ! options [ :joins ] . blank? && ! options [ :select ]
2006-03-27 18:28:19 -05:00
options [ :readonly ] = true
end
end
2004-11-23 20:04:44 -05:00
end
2005-07-03 04:32:43 -04:00
2006-03-27 22:06:40 -05:00
def encode_quoted_value ( value ) #:nodoc:
2004-12-10 11:02:11 -05:00
quoted_value = connection . quote ( value )
2005-10-22 12:43:39 -04:00
quoted_value = " ' #{ quoted_value [ 1 .. - 2 ] . gsub ( / \ ' / , " \\ \\ ' " ) } ' " if quoted_value . include? ( " \\ \' " ) # (for ruby mode) "
quoted_value
2004-12-10 11:02:11 -05:00
end
2004-11-23 20:04:44 -05:00
end
public
# New objects can be instantiated as either empty (pass no construction parameter) or pre-set with
# attributes but not yet saved (pass a hash with key names matching the associated table column names).
2005-07-03 04:32:43 -04:00
# In both instances, valid attribute keys are determined by the column names of the associated table --
2004-11-23 20:04:44 -05:00
# hence you can't have attributes that aren't part of the table columns.
def initialize ( attributes = nil )
@attributes = attributes_from_column_definition
2007-08-14 04:53:02 -04:00
@attributes_cache = { }
2004-11-23 20:04:44 -05:00
@new_record = true
ensure_proper_type
self . attributes = attributes unless attributes . nil?
2007-01-12 16:14:36 -05:00
self . class . send ( :scope , :create ) . each { | att , value | self . send ( " #{ att } = " , value ) } if self . class . send ( :scoped? , :create )
2007-08-30 21:56:39 -04:00
result = yield self if block_given?
callback ( :after_initialize ) if respond_to_without_attributes? ( :after_initialize )
result
2004-11-23 20:04:44 -05:00
end
2005-07-03 04:32:43 -04:00
2005-11-02 12:30:59 -05:00
# A model instance's primary key is always available as model.id
# whether you name it the default 'id' or set it to something else.
2004-11-23 20:04:44 -05:00
def id
2005-10-06 20:53:05 -04:00
attr_name = self . class . primary_key
2005-11-02 12:30:59 -05:00
column = column_for_attribute ( attr_name )
2007-05-25 16:55:05 -04:00
2007-08-14 04:53:02 -04:00
self . class . send ( :define_read_method , :id , attr_name , column )
# now that the method exists, call it
self . send attr_name . to_sym
2004-11-23 20:04:44 -05:00
end
2005-07-03 04:32:43 -04:00
2005-03-20 10:45:36 -05:00
# Enables Active Record objects to be used as URL parameters in Action Pack automatically.
2006-06-05 11:41:24 -04:00
def to_param
2006-06-19 12:45:34 -04:00
# We can't use alias_method here, because method 'id' optimizes itself on the fly.
2006-07-02 23:57:31 -04:00
( id = self . id ) ? id . to_s : nil # Be sure to stringify the id for routes
2006-06-05 11:41:24 -04:00
end
2005-07-03 04:32:43 -04:00
2005-02-23 18:51:34 -05:00
def id_before_type_cast #:nodoc:
2004-12-20 08:32:09 -05:00
read_attribute_before_type_cast ( self . class . primary_key )
end
2005-02-23 18:51:34 -05:00
def quoted_id #:nodoc:
2006-09-04 19:41:13 -04:00
quote_value ( id , column_for_attribute ( self . class . primary_key ) )
2004-12-07 09:48:53 -05:00
end
2005-07-03 04:32:39 -04:00
2004-11-23 20:04:44 -05:00
# Sets the primary ID.
def id = ( value )
write_attribute ( self . class . primary_key , value )
end
2005-07-03 04:32:43 -04:00
2004-11-23 20:04:44 -05:00
# Returns true if this object hasn't been saved yet -- that is, a record for the object doesn't exist yet.
2006-09-05 14:48:10 -04:00
def new_record?
2006-09-05 14:54:24 -04:00
@new_record
2006-09-05 14:48:10 -04:00
end
2005-07-03 04:32:43 -04:00
2004-11-23 20:04:44 -05:00
# * No record exists: Creates a new record with values matching those of the object attributes.
# * A record does exist: Updates the record with values matching those of the object attributes.
def save
create_or_update
end
2006-02-28 15:37:21 -05:00
# Attempts to save the record, but instead of just returning false if it couldn't happen, it raises a
# RecordNotSaved exception
def save!
2006-10-01 23:21:32 -04:00
create_or_update || raise ( RecordNotSaved )
2006-02-28 15:37:21 -05:00
end
2005-07-03 04:32:43 -04:00
2004-11-23 20:04:44 -05:00
# Deletes the record in the database and freezes this instance to reflect that no changes should
# be made (since they can't be persisted).
def destroy
2006-09-05 14:54:24 -04:00
unless new_record?
2005-07-03 04:32:47 -04:00
connection . delete <<-end_sql, "#{self.class.name} Destroy"
2007-10-16 01:06:33 -04:00
DELETE FROM #{self.class.quoted_table_name}
2007-03-08 22:23:37 -05:00
WHERE #{connection.quote_column_name(self.class.primary_key)} = #{quoted_id}
2005-07-03 04:32:47 -04:00
end_sql
2004-11-23 20:04:44 -05:00
end
freeze
end
2005-11-10 13:53:31 -05:00
# Returns a clone of the record that hasn't been assigned an id yet and
# is treated as a new record. Note that this is a "shallow" clone:
# it copies the object's attributes only, not its associations.
# The extent of a "deep" clone is application-specific and is therefore
# left to the application to implement according to its need.
2004-11-23 20:04:44 -05:00
def clone
2005-05-19 12:39:50 -04:00
attrs = self . attributes_before_type_cast
2005-02-14 19:03:18 -05:00
attrs . delete ( self . class . primary_key )
2007-10-08 02:21:38 -04:00
record = self . class . new
record . send :instance_variable_set , '@attributes' , attrs
record
2004-11-23 20:04:44 -05:00
end
2005-05-19 12:39:50 -04:00
2004-11-23 20:04:44 -05:00
# Updates a single attribute and saves the record. This is especially useful for boolean flags on existing records.
2004-12-18 06:17:22 -05:00
# Note: This method is overwritten by the Validation module that'll make sure that updates made with this method
2007-09-22 14:17:53 -04:00
# aren't subjected to validation checks. Hence, attributes can be updated even if the full object isn't valid.
2004-11-23 20:04:44 -05:00
def update_attribute ( name , value )
2005-09-26 17:55:37 -04:00
send ( name . to_s + '=' , value )
2005-01-05 21:31:35 -05:00
save
2004-12-17 16:51:14 -05:00
end
2005-10-10 23:55:49 -04:00
# Updates all the attributes from the passed-in Hash and saves the record. If the object is invalid, the saving will
2004-12-18 06:17:22 -05:00
# fail and false will be returned.
2004-12-17 16:51:14 -05:00
def update_attributes ( attributes )
2004-12-17 20:27:57 -05:00
self . attributes = attributes
2005-07-03 04:32:43 -04:00
save
2004-11-23 20:04:44 -05:00
end
2006-10-08 21:52:24 -04:00
# Updates an object just like Base.update_attributes but calls save! instead of save so an exception is raised if the record is invalid.
def update_attributes! ( attributes )
self . attributes = attributes
save!
end
2004-11-23 20:04:44 -05:00
2005-01-05 21:31:35 -05:00
# Initializes the +attribute+ to zero if nil and adds one. Only makes sense for number-based attributes. Returns self.
def increment ( attribute )
self [ attribute ] || = 0
self [ attribute ] += 1
self
end
2005-07-03 04:32:43 -04:00
2005-01-05 21:31:35 -05:00
# Increments the +attribute+ and saves the record.
def increment! ( attribute )
increment ( attribute ) . update_attribute ( attribute , self [ attribute ] )
end
# Initializes the +attribute+ to zero if nil and subtracts one. Only makes sense for number-based attributes. Returns self.
def decrement ( attribute )
self [ attribute ] || = 0
self [ attribute ] -= 1
self
end
# Decrements the +attribute+ and saves the record.
def decrement! ( attribute )
decrement ( attribute ) . update_attribute ( attribute , self [ attribute ] )
end
2005-07-03 04:32:43 -04:00
2005-01-05 21:31:35 -05:00
# Turns an +attribute+ that's currently true into false and vice versa. Returns self.
def toggle ( attribute )
2005-10-06 00:15:14 -04:00
self [ attribute ] = ! send ( " #{ attribute } ? " )
2005-01-05 21:31:35 -05:00
self
end
# Toggles the +attribute+ and saves the record.
def toggle! ( attribute )
toggle ( attribute ) . update_attribute ( attribute , self [ attribute ] )
end
2005-01-10 18:49:57 -05:00
# Reloads the attributes of this object from the database.
2006-06-19 21:58:36 -04:00
# The optional options argument is passed to find when reloading so you
# may do e.g. record.reload(:lock => true) to reload the same record with
# an exclusive row lock.
def reload ( options = nil )
2005-12-07 23:46:57 -05:00
clear_aggregation_cache
2005-01-10 18:49:57 -05:00
clear_association_cache
2006-06-19 21:58:36 -04:00
@attributes . update ( self . class . find ( self . id , options ) . instance_variable_get ( '@attributes' ) )
2007-08-14 04:53:02 -04:00
@attributes_cache = { }
2005-07-03 04:32:43 -04:00
self
2005-01-10 18:49:57 -05:00
end
2005-10-10 23:55:49 -04:00
# Returns the value of the attribute identified by <tt>attr_name</tt> after it has been typecast (for example,
2004-11-23 20:04:44 -05:00
# "2004-12-12" in a data column is cast to a date object, like Date.new(2004, 12, 12)).
# (Alias for the protected read_attribute method).
2005-07-03 04:32:43 -04:00
def [] ( attr_name )
2005-09-02 04:31:11 -04:00
read_attribute ( attr_name )
2004-11-23 20:04:44 -05:00
end
2005-07-03 04:32:43 -04:00
2004-11-23 20:04:44 -05:00
# Updates the attribute identified by <tt>attr_name</tt> with the specified +value+.
# (Alias for the protected write_attribute method).
2005-07-03 04:32:43 -04:00
def []= ( attr_name , value )
2005-09-02 04:31:11 -04:00
write_attribute ( attr_name , value )
2004-11-23 20:04:44 -05:00
end
# Allows you to set all the attributes at once by passing in a hash with keys
# matching the attribute names (which again matches the column names). Sensitive attributes can be protected
# from this form of mass-assignment by using the +attr_protected+ macro. Or you can alternatively
# specify which attributes *can* be accessed in with the +attr_accessible+ macro. Then all the
2007-10-10 15:11:50 -04:00
# attributes not included in that won't be allowed to be mass-assigned.
def attributes = ( new_attributes , guard_protected_attributes = true )
2006-02-25 19:41:01 -05:00
return if new_attributes . nil?
attributes = new_attributes . dup
2005-03-10 09:44:01 -05:00
attributes . stringify_keys!
2004-11-23 20:04:44 -05:00
multi_parameter_attributes = [ ]
2007-10-10 15:11:50 -04:00
attributes = remove_attributes_protected_from_mass_assignment ( attributes ) if guard_protected_attributes
attributes . each do | k , v |
2004-11-23 20:04:44 -05:00
k . include? ( " ( " ) ? multi_parameter_attributes << [ k , v ] : send ( k + " = " , v )
end
2006-02-25 19:41:01 -05:00
2004-11-23 20:04:44 -05:00
assign_multiparameter_attributes ( multi_parameter_attributes )
end
2006-02-25 19:41:01 -05:00
2005-01-10 19:45:26 -05:00
# Returns a hash of all the attributes with their names as keys and clones of their objects as values.
2006-03-09 19:25:29 -05:00
def attributes ( options = nil )
attributes = clone_attributes :read_attribute
if options . nil?
attributes
else
if except = options [ :except ]
except = Array ( except ) . collect { | attribute | attribute . to_s }
except . each { | attribute_name | attributes . delete ( attribute_name ) }
attributes
elsif only = options [ :only ]
only = Array ( only ) . collect { | attribute | attribute . to_s }
attributes . delete_if { | key , value | ! only . include? ( key ) }
attributes
else
raise ArgumentError , " Options does not specify :except or :only ( #{ options . keys . inspect } ) "
end
end
2005-05-19 12:39:50 -04:00
end
# Returns a hash of cloned attributes before typecasting and deserialization.
def attributes_before_type_cast
clone_attributes :read_attribute_before_type_cast
2005-01-10 19:45:26 -05:00
end
2007-05-17 22:11:43 -04:00
# Format attributes nicely for inspect.
def attribute_for_inspect ( attr_name )
value = read_attribute ( attr_name )
2007-05-18 03:24:03 -04:00
if value . is_a? ( String ) && value . length > 50
%( " #{ value [ 0 .. 50 ] } ..." )
elsif value . is_a? ( Date ) || value . is_a? ( Time )
%( " #{ value . to_s ( :db ) } " )
2007-05-17 22:11:43 -04:00
else
value . inspect
end
end
2004-11-23 20:04:44 -05:00
# Returns true if the specified +attribute+ has been set by the user or by a database load and is neither
2005-10-10 23:55:49 -04:00
# nil nor empty? (the latter only applies to objects that respond to empty?, most notably Strings).
2004-11-23 20:04:44 -05:00
def attribute_present? ( attribute )
2005-07-03 04:33:03 -04:00
value = read_attribute ( attribute )
2007-01-23 00:10:21 -05:00
! value . blank?
2004-11-23 20:04:44 -05:00
end
2005-10-22 12:43:39 -04:00
# Returns true if the given attribute is in the attributes hash
def has_attribute? ( attr_name )
@attributes . has_key? ( attr_name . to_s )
end
2004-11-23 20:04:44 -05:00
# Returns an array of names for the attributes available on this object sorted alphabetically.
def attribute_names
@attributes . keys . sort
end
# Returns the column object for the named attribute.
def column_for_attribute ( name )
2005-01-05 21:31:35 -05:00
self . class . columns_hash [ name . to_s ]
2004-11-23 20:04:44 -05:00
end
2005-07-03 04:32:43 -04:00
2005-01-15 12:45:16 -05:00
# Returns true if the +comparison_object+ is the same object, or is of the same type and has the same id.
2004-11-23 20:04:44 -05:00
def == ( comparison_object )
2005-09-09 04:54:02 -04:00
comparison_object . equal? ( self ) ||
( comparison_object . instance_of? ( self . class ) &&
2006-07-05 10:22:24 -04:00
comparison_object . id == id &&
2006-09-05 14:54:24 -04:00
! comparison_object . new_record? )
2004-11-23 20:04:44 -05:00
end
# Delegates to ==
def eql? ( comparison_object )
self == ( comparison_object )
end
2005-07-03 04:32:43 -04:00
2004-11-23 20:04:44 -05:00
# Delegates to id in order to allow two records of the same type and id to work with something like:
# [ Person.find(1), Person.find(2), Person.find(3) ] & [ Person.find(1), Person.find(4) ] # => [ Person.find(1) ]
def hash
2005-03-30 09:25:29 -05:00
id . hash
2004-11-23 20:04:44 -05:00
end
2005-05-02 12:46:30 -04:00
# Just freeze the attributes hash, such that associations are still accessible even on destroyed records.
def freeze
2005-08-14 04:58:53 -04:00
@attributes . freeze ; self
2005-05-02 12:46:30 -04:00
end
2005-07-03 04:32:43 -04:00
2005-05-02 12:46:30 -04:00
def frozen?
@attributes . frozen?
end
2005-07-03 04:32:43 -04:00
2006-03-27 22:06:40 -05:00
# Records loaded through joins with piggy-back attributes will be marked as read only as they cannot be saved and return true to this query.
2005-10-14 20:19:56 -04:00
def readonly?
@readonly == true
end
2006-03-27 22:06:40 -05:00
def readonly! #:nodoc:
2005-10-14 20:19:56 -04:00
@readonly = true
end
2006-03-09 16:12:28 -05:00
2007-05-17 22:11:43 -04:00
# Nice pretty inspect.
def inspect
2007-05-18 03:24:03 -04:00
attributes_as_nice_string = self . class . column_names . collect { | name |
2007-06-11 01:02:42 -04:00
if has_attribute? ( name ) || new_record?
" #{ name } : #{ attribute_for_inspect ( name ) } "
end
} . compact . join ( " , " )
2007-05-18 03:24:03 -04:00
" # < #{ self . class } #{ attributes_as_nice_string } > "
2007-05-17 22:11:43 -04:00
end
2005-10-14 20:19:56 -04:00
2004-11-23 20:04:44 -05:00
private
def create_or_update
2006-10-01 23:21:32 -04:00
raise ReadOnlyRecord if readonly?
2006-10-04 11:43:31 -04:00
result = new_record? ? create : update
result != false
2004-11-23 20:04:44 -05:00
end
2005-10-10 23:55:49 -04:00
# Updates the associated record with values matching those of the instance attributes.
2006-07-31 23:35:04 -04:00
# Returns the number of affected rows.
2004-11-23 20:04:44 -05:00
def update
2007-10-05 20:49:58 -04:00
quoted_attributes = attributes_with_quotes ( false , false )
return 0 if quoted_attributes . empty?
2004-11-23 20:04:44 -05:00
connection . update (
2007-10-16 01:06:33 -04:00
" UPDATE #{ self . class . quoted_table_name } " +
2007-10-05 20:49:58 -04:00
" SET #{ quoted_comma_pair_list ( connection , quoted_attributes ) } " +
2007-03-08 22:23:37 -05:00
" WHERE #{ connection . quote_column_name ( self . class . primary_key ) } = #{ quote_value ( id ) } " ,
2004-11-23 20:04:44 -05:00
" #{ self . class . name } Update "
)
end
2006-07-31 23:35:04 -04:00
# Creates a record with values matching those of the instance attributes
# and returns its id.
2004-11-23 20:04:44 -05:00
def create
2005-12-21 01:16:42 -05:00
if self . id . nil? && connection . prefetch_primary_key? ( self . class . table_name )
2005-11-16 03:16:54 -05:00
self . id = connection . next_sequence_value ( self . class . sequence_name )
end
2006-07-31 23:35:04 -04:00
2007-10-05 20:49:58 -04:00
quoted_attributes = attributes_with_quotes
statement = if quoted_attributes . empty?
connection . empty_insert_statement ( self . class . table_name )
else
2007-10-16 01:06:33 -04:00
" INSERT INTO #{ self . class . quoted_table_name } " +
2004-11-23 20:04:44 -05:00
" ( #{ quoted_column_names . join ( ', ' ) } ) " +
2007-10-05 20:49:58 -04:00
" VALUES( #{ quoted_attributes . values . join ( ', ' ) } ) "
end
self . id = connection . insert ( statement , " #{ self . class . name } Create " ,
self . class . primary_key , self . id , self . class . sequence_name )
2005-07-03 04:32:43 -04:00
2004-11-23 20:04:44 -05:00
@new_record = false
2006-07-31 23:35:04 -04:00
id
2004-11-23 20:04:44 -05:00
end
2005-10-10 23:55:49 -04:00
# Sets the attribute used for single table inheritance to this class name if this is not the ActiveRecord descendent.
2005-07-03 04:32:43 -04:00
# Considering the hierarchy Reply < Message < ActiveRecord, this makes it possible to do Reply.new without having to
# set Reply[Reply.inheritance_column] = "Reply" yourself. No such attribute would be set for objects of the
2004-11-23 20:04:44 -05:00
# Message class in that example.
def ensure_proper_type
unless self . class . descends_from_active_record?
write_attribute ( self . class . inheritance_column , Inflector . demodulize ( self . class . name ) )
end
end
2005-10-06 20:53:05 -04:00
def convert_number_column_value ( value )
case value
2007-09-13 19:13:34 -04:00
when FalseClass ; 0
when TrueClass ; 1
when '' ; nil
2005-10-06 20:53:05 -04:00
else value
end
2004-11-23 20:04:44 -05:00
end
def remove_attributes_protected_from_mass_assignment ( attributes )
2007-10-07 15:43:19 -04:00
safe_attributes =
if self . class . accessible_attributes . nil? && self . class . protected_attributes . nil?
attributes . reject { | key , value | attributes_protected_by_default . include? ( key . gsub ( / \ (.+ / , " " ) ) }
elsif self . class . protected_attributes . nil?
attributes . reject { | key , value | ! self . class . accessible_attributes . include? ( key . gsub ( / \ (.+ / , " " ) . intern ) || attributes_protected_by_default . include? ( key . gsub ( / \ (.+ / , " " ) ) }
elsif self . class . accessible_attributes . nil?
attributes . reject { | key , value | self . class . protected_attributes . include? ( key . gsub ( / \ (.+ / , " " ) . intern ) || attributes_protected_by_default . include? ( key . gsub ( / \ (.+ / , " " ) ) }
else
raise " Declare either attr_protected or attr_accessible for #{ self . class } , but not both. "
end
removed_attributes = attributes . keys - safe_attributes . keys
if removed_attributes . any?
error_message = " Can't mass-assign these protected attributes: #{ removed_attributes . join ( ', ' ) } "
if self . class . whiny_protected_attributes
raise ProtectedAttributeAssignmentError , error_message
else
logger . error error_message
end
2004-11-23 20:04:44 -05:00
end
2007-10-07 15:43:19 -04:00
safe_attributes
2004-11-23 20:04:44 -05:00
end
2007-10-07 15:43:19 -04:00
2007-09-30 03:09:44 -04:00
# Removes attributes which have been marked as readonly.
def remove_readonly_attributes ( attributes )
unless self . class . readonly_attributes . nil?
attributes . delete_if { | key , value | self . class . readonly_attributes . include? ( key . gsub ( / \ (.+ / , " " ) . intern ) }
else
attributes
end
end
2004-11-23 20:04:44 -05:00
2005-01-23 12:24:54 -05:00
# The primary key and inheritance column can never be set by mass-assignment for security reasons.
def attributes_protected_by_default
2005-10-12 15:59:13 -04:00
default = [ self . class . primary_key , self . class . inheritance_column ]
default << 'id' unless self . class . primary_key . eql? 'id'
default
2005-01-23 12:24:54 -05:00
end
2004-11-23 20:04:44 -05:00
# Returns copy of the attributes hash where all the values have been safely quoted for use in
2005-07-03 04:32:43 -04:00
# an SQL statement.
2007-09-30 03:09:44 -04:00
def attributes_with_quotes ( include_primary_key = true , include_readonly_attributes = true )
quoted = attributes . inject ( { } ) do | quoted , ( name , value ) |
2005-06-12 02:56:51 -04:00
if column = column_for_attribute ( name )
2006-09-04 19:41:13 -04:00
quoted [ name ] = quote_value ( value , column ) unless ! include_primary_key && column . primary
2005-06-12 02:56:51 -04:00
end
quoted
2004-11-23 20:04:44 -05:00
end
2007-09-30 03:09:44 -04:00
include_readonly_attributes ? quoted : remove_readonly_attributes ( quoted )
2004-11-23 20:04:44 -05:00
end
2005-06-12 02:56:51 -04:00
2004-11-23 20:04:44 -05:00
# Quote strings appropriately for SQL statements.
2006-09-04 19:41:13 -04:00
def quote_value ( value , column = nil )
2005-07-03 04:32:17 -04:00
self . class . connection . quote ( value , column )
2004-11-23 20:04:44 -05:00
end
# Interpolate custom sql string in instance context.
# Optional record argument is meant for custom insert_sql.
def interpolate_sql ( sql , record = nil )
2005-10-14 19:28:35 -04:00
instance_eval ( " %@ #{ sql . gsub ( '@' , '\@' ) } @ " )
2004-11-23 20:04:44 -05:00
end
# Initializes the attributes array with keys matching the columns from the linked table and
# the values matching the corresponding default value of that column, so
# that a new instance, or one populated from a passed-in Hash, still has all the attributes
# that instances loaded from the database would.
def attributes_from_column_definition
2005-09-08 08:21:36 -04:00
self . class . columns . inject ( { } ) do | attributes , column |
2004-12-20 08:32:09 -05:00
attributes [ column . name ] = column . default unless column . name == self . class . primary_key
2004-11-23 20:04:44 -05:00
attributes
end
end
# Instantiates objects for all attribute classes that needs more than one constructor parameter. This is done
# by calling new on the column type or aggregation type (through composed_of) object with these parameters.
# So having the pairs written_on(1) = "2004", written_on(2) = "6", written_on(3) = "24", will instantiate
# written_on (a date type) with Date.new("2004", "6", "24"). You can also specify a typecast character in the
2005-02-07 09:15:53 -05:00
# parentheses to have the parameters typecasted before they're used in the constructor. Use i for Fixnum, f for Float,
2004-11-23 20:04:44 -05:00
# s for String, and a for Array. If all the values for a given attribute is empty, the attribute will be set to nil.
def assign_multiparameter_attributes ( pairs )
execute_callstack_for_multiparameter_attributes (
extract_callstack_for_multiparameter_attributes ( pairs )
)
end
2005-07-03 04:32:43 -04:00
2004-11-23 20:04:44 -05:00
# Includes an ugly hack for Time.local instead of Time.new because the latter is reserved by Time itself.
def execute_callstack_for_multiparameter_attributes ( callstack )
2005-03-06 09:11:26 -05:00
errors = [ ]
2004-11-23 20:04:44 -05:00
callstack . each do | name , values |
2006-04-06 12:16:29 -04:00
klass = ( self . class . reflect_on_aggregation ( name . to_sym ) || column_for_attribute ( name ) ) . klass
2004-11-23 20:04:44 -05:00
if values . empty?
send ( name + " = " , nil )
else
2005-03-06 09:11:26 -05:00
begin
2006-08-05 16:50:26 -04:00
send ( name + " = " , Time == klass ? ( @@default_timezone == :utc ? klass . utc ( * values ) : klass . local ( * values ) ) : klass . new ( * values ) )
2005-03-06 09:11:26 -05:00
rescue = > ex
errors << AttributeAssignmentError . new ( " error on assignment #{ values . inspect } to #{ name } " , ex , name )
end
2004-11-23 20:04:44 -05:00
end
end
2005-03-06 09:11:26 -05:00
unless errors . empty?
raise MultiparameterAssignmentErrors . new ( errors ) , " #{ errors . size } error(s) on assignment of multiparameter attributes "
end
2004-11-23 20:04:44 -05:00
end
2005-07-03 04:32:43 -04:00
2004-11-23 20:04:44 -05:00
def extract_callstack_for_multiparameter_attributes ( pairs )
attributes = { }
for pair in pairs
multiparameter_name , value = pair
attribute_name = multiparameter_name . split ( " ( " ) . first
attributes [ attribute_name ] = [ ] unless attributes . include? ( attribute_name )
unless value . empty?
2005-07-03 04:32:43 -04:00
attributes [ attribute_name ] <<
2005-01-24 06:39:23 -05:00
[ find_parameter_position ( multiparameter_name ) , type_cast_attribute_value ( multiparameter_name , value ) ]
2004-11-23 20:04:44 -05:00
end
end
attributes . each { | name , values | attributes [ name ] = values . sort_by { | v | v . first } . collect { | v | v . last } }
end
2005-07-03 04:32:43 -04:00
2004-11-23 20:04:44 -05:00
def type_cast_attribute_value ( multiparameter_name , value )
multiparameter_name =~ / \ ([0-9]*([a-z]) \ ) / ? value . send ( " to_ " + $1 ) : value
end
2005-07-03 04:32:43 -04:00
2004-11-23 20:04:44 -05:00
def find_parameter_position ( multiparameter_name )
multiparameter_name . scan ( / \ (([0-9]*).* \ ) / ) . first . first
end
2005-07-03 04:32:43 -04:00
2004-11-23 20:04:44 -05:00
# Returns a comma-separated pair list, like "key1 = val1, key2 = val2".
def comma_pair_list ( hash )
hash . inject ( [ ] ) { | list , pair | list << " #{ pair . first } = #{ pair . last } " } . join ( " , " )
end
def quoted_column_names ( attributes = attributes_with_quotes )
2005-07-03 04:32:12 -04:00
attributes . keys . collect do | column_name |
self . class . connection . quote_column_name ( column_name )
end
2004-11-23 20:04:44 -05:00
end
2007-10-16 01:06:33 -04:00
def self . quoted_table_name
self . connection . quote_table_name ( self . table_name )
end
2005-07-03 04:32:12 -04:00
def quote_columns ( quoter , hash )
hash . inject ( { } ) do | quoted , ( name , value ) |
quoted [ quoter . quote_column_name ( name ) ] = value
quoted
2005-01-24 06:39:23 -05:00
end
2004-11-23 20:04:44 -05:00
end
2005-07-03 04:32:12 -04:00
def quoted_comma_pair_list ( quoter , hash )
comma_pair_list ( quote_columns ( quoter , hash ) )
2004-11-23 20:04:44 -05:00
end
def object_from_yaml ( string )
2005-01-20 09:40:11 -05:00
return string unless string . is_a? ( String )
2005-09-27 05:25:17 -04:00
YAML :: load ( string ) rescue string
2004-11-23 20:04:44 -05:00
end
2005-05-19 12:39:50 -04:00
def clone_attributes ( reader_method = :read_attribute , attributes = { } )
self . attribute_names . inject ( attributes ) do | attributes , name |
attributes [ name ] = clone_attribute_value ( reader_method , name )
attributes
end
end
def clone_attribute_value ( reader_method , attribute_name )
value = send ( reader_method , attribute_name )
2007-10-15 03:13:40 -04:00
value . duplicable? ? value . clone : value
2005-05-19 12:39:50 -04:00
rescue TypeError , NoMethodError
value
end
2004-11-23 20:04:44 -05:00
end
2006-06-19 18:48:51 -04:00
end