Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 1896 lines (1712 sloc) 84.916 kB
db045db @dhh Initial
dhh authored
1 require 'yaml'
aabf909 @jeremy Correct reader method generation for primary key attribute: handle ca…
jeremy authored
2 require 'set'
a15e02d @josevalim Unify benchmark APIs.
josevalim authored
3 require 'active_support/benchmarkable'
f5d720f @jeremy Opt in to Dependencies
jeremy authored
4 require 'active_support/dependencies'
033e0a0 @josevalim ActiveRecord and ActionPack now use the new descendants implementation.
josevalim authored
5 require 'active_support/descendants_tracker'
5f222c5 @jeremy Remove 'core' fluff. Hookable ActiveSupport.load_all!
jeremy authored
6 require 'active_support/time'
bab1f91 @phs table_name_prefix and table_name_suffix are class_attributes instead …
phs authored
7 require 'active_support/core_ext/class/attribute'
e8550ee @jeremy Cherry-pick core extensions
jeremy authored
8 require 'active_support/core_ext/class/attribute_accessors'
9 require 'active_support/core_ext/class/delegating_attributes'
10 require 'active_support/core_ext/class/inheritable_attributes'
11 require 'active_support/core_ext/array/extract_options'
12 require 'active_support/core_ext/hash/deep_merge'
13 require 'active_support/core_ext/hash/indifferent_access'
14 require 'active_support/core_ext/hash/slice'
15 require 'active_support/core_ext/string/behavior'
89978f1 @fxn moves Object#singleton_class to Kernel#singleton_class to match Ruby …
fxn authored
16 require 'active_support/core_ext/kernel/singleton_class'
a7fd564 @lifo Add Model.select/group/order/limit/joins/conditions/preload/eager_loa…
lifo authored
17 require 'active_support/core_ext/module/delegation'
4a8c880 @fxn refactors AR::Base#reset_table_name
fxn authored
18 require 'active_support/core_ext/module/introspection'
105f9b8 @fxn adds missing requires for Object#duplicable?
fxn authored
19 require 'active_support/core_ext/object/duplicable'
76f024a @fxn adds missing requires for Object#blank? and Object#present?
fxn authored
20 require 'active_support/core_ext/object/blank'
39d6f9e @wycats Make many parts of Rails lazy. In order to facilitate this,
wycats authored
21 require 'arel'
22 require 'active_record/errors'
6788db8 @josevalim Move Rails::LogSubscriber to ActiveSupport::LogSubscriber, allowing f…
josevalim authored
23 require 'active_record/log_subscriber'
db045db @dhh Initial
dhh authored
24
25 module ActiveRecord #:nodoc:
4ad6103 @rizwanreza Adds title and basic description where needed.
rizwanreza authored
26 # = Active Record
27 #
2948910 Misc doc fixes (typos/grammar/etc.). Closes #2430.
Marcel Molina authored
28 # Active Record objects don't specify their attributes directly, but rather infer them from the table definition with
db045db @dhh Initial
dhh authored
29 # which they're linked. Adding, removing, and changing attributes and their type is done directly in the database. Any change
30 # is instantly reflected in the Active Record objects. The mapping that binds a given Active Record class to a certain
6e39c9e @jeremy r1614@asus: jeremy | 2005-07-03 08:01:08 -0700
jeremy authored
31 # database table will happen automatically in most common cases, but can be overwritten for the uncommon ones.
32 #
db045db @dhh Initial
dhh authored
33 # See the mapping rules in table_name and the full example in link:files/README.html for more insight.
6e39c9e @jeremy r1614@asus: jeremy | 2005-07-03 08:01:08 -0700
jeremy authored
34 #
db045db @dhh Initial
dhh authored
35 # == Creation
6e39c9e @jeremy r1614@asus: jeremy | 2005-07-03 08:01:08 -0700
jeremy authored
36 #
2948910 Misc doc fixes (typos/grammar/etc.). Closes #2430.
Marcel Molina authored
37 # Active Records accept constructor parameters either in a hash or as a block. The hash method is especially useful when
7143d80 Smattering of grammatical fixes to documentation. Closes #10083 [BobS…
Marcel Molina authored
38 # you're receiving the data from somewhere else, like an HTTP request. It works like this:
6e39c9e @jeremy r1614@asus: jeremy | 2005-07-03 08:01:08 -0700
jeremy authored
39 #
0591c53 @dhh Made the dynamic finders use the new find API and updated the example…
dhh authored
40 # user = User.new(:name => "David", :occupation => "Code Artist")
db045db @dhh Initial
dhh authored
41 # user.name # => "David"
6e39c9e @jeremy r1614@asus: jeremy | 2005-07-03 08:01:08 -0700
jeremy authored
42 #
db045db @dhh Initial
dhh authored
43 # You can also use block initialization:
6e39c9e @jeremy r1614@asus: jeremy | 2005-07-03 08:01:08 -0700
jeremy authored
44 #
db045db @dhh Initial
dhh authored
45 # user = User.new do |u|
46 # u.name = "David"
47 # u.occupation = "Code Artist"
48 # end
6e39c9e @jeremy r1614@asus: jeremy | 2005-07-03 08:01:08 -0700
jeremy authored
49 #
db045db @dhh Initial
dhh authored
50 # And of course you can just create a bare object and specify the attributes after the fact:
6e39c9e @jeremy r1614@asus: jeremy | 2005-07-03 08:01:08 -0700
jeremy authored
51 #
db045db @dhh Initial
dhh authored
52 # user = User.new
53 # user.name = "David"
54 # user.occupation = "Code Artist"
6e39c9e @jeremy r1614@asus: jeremy | 2005-07-03 08:01:08 -0700
jeremy authored
55 #
db045db @dhh Initial
dhh authored
56 # == Conditions
6e39c9e @jeremy r1614@asus: jeremy | 2005-07-03 08:01:08 -0700
jeremy authored
57 #
c5ec16e @dhh Added simple hash conditions to find that'll just convert hash to an …
dhh authored
58 # Conditions can either be specified as a string, array, or hash representing the WHERE-part of an SQL statement.
db045db @dhh Initial
dhh authored
59 # The array form is to be used when the condition input is tainted and requires sanitization. The string form can
c5ec16e @dhh Added simple hash conditions to find that'll just convert hash to an …
dhh authored
60 # be used for statements that don't involve tainted data. The hash form works much like the array form, except
2876707 @jeremy Pass a range in :conditions to use the SQL BETWEEN operator. Closes #…
jeremy authored
61 # only equality and range is possible. Examples:
6e39c9e @jeremy r1614@asus: jeremy | 2005-07-03 08:01:08 -0700
jeremy authored
62 #
48052d7 @jeremy to_xml fixes, features, and speedup. Closes #4989.
jeremy authored
63 # class User < ActiveRecord::Base
db045db @dhh Initial
dhh authored
64 # def self.authenticate_unsafely(user_name, password)
2c27e3d @lifo Some doc updates reflecting the new query API
lifo authored
65 # where("user_name = '#{user_name}' AND password = '#{password}'").first
db045db @dhh Initial
dhh authored
66 # end
6e39c9e @jeremy r1614@asus: jeremy | 2005-07-03 08:01:08 -0700
jeremy authored
67 #
db045db @dhh Initial
dhh authored
68 # def self.authenticate_safely(user_name, password)
2c27e3d @lifo Some doc updates reflecting the new query API
lifo authored
69 # where("user_name = ? AND password = ?", user_name, password).first
db045db @dhh Initial
dhh authored
70 # end
c5ec16e @dhh Added simple hash conditions to find that'll just convert hash to an …
dhh authored
71 #
72 # def self.authenticate_safely_simply(user_name, password)
2c27e3d @lifo Some doc updates reflecting the new query API
lifo authored
73 # where(:user_name => user_name, :password => password).first
c5ec16e @dhh Added simple hash conditions to find that'll just convert hash to an …
dhh authored
74 # end
db045db @dhh Initial
dhh authored
75 # end
6e39c9e @jeremy r1614@asus: jeremy | 2005-07-03 08:01:08 -0700
jeremy authored
76 #
2575b3b @dhh Added extra words of caution for guarding against SQL-injection attacks
dhh authored
77 # The <tt>authenticate_unsafely</tt> method inserts the parameters directly into the query and is thus susceptible to SQL-injection
7143d80 Smattering of grammatical fixes to documentation. Closes #10083 [BobS…
Marcel Molina authored
78 # attacks if the <tt>user_name</tt> and +password+ parameters come directly from an HTTP request. The <tt>authenticate_safely</tt> and
7367325 @jeremy Document Active Record exceptions. Closes #10444.
jeremy authored
79 # <tt>authenticate_safely_simply</tt> both will sanitize the <tt>user_name</tt> and +password+ before inserting them in the query,
c5ec16e @dhh Added simple hash conditions to find that'll just convert hash to an …
dhh authored
80 # which will ensure that an attacker can't escape the query and fake the login (or worse).
2575b3b @dhh Added extra words of caution for guarding against SQL-injection attacks
dhh authored
81 #
5cd38ca @dhh Added documentation about named bind variables
dhh authored
82 # When using multiple parameters in the conditions, it can easily become hard to read exactly what the fourth or fifth
6e39c9e @jeremy r1614@asus: jeremy | 2005-07-03 08:01:08 -0700
jeremy authored
83 # question mark is supposed to represent. In those cases, you can resort to named bind variables instead. That's done by replacing
5cd38ca @dhh Added documentation about named bind variables
dhh authored
84 # the question marks with symbols and supplying a hash with values for the matching symbol keys:
85 #
2c27e3d @lifo Some doc updates reflecting the new query API
lifo authored
86 # Company.where(
6e39c9e @jeremy r1614@asus: jeremy | 2005-07-03 08:01:08 -0700
jeremy authored
87 # "id = :id AND name = :name AND division = :division AND created_at > :accounting_date",
5cd38ca @dhh Added documentation about named bind variables
dhh authored
88 # { :id => 3, :name => "37signals", :division => "First", :accounting_date => '2005-01-01' }
2c27e3d @lifo Some doc updates reflecting the new query API
lifo authored
89 # ).first
5cd38ca @dhh Added documentation about named bind variables
dhh authored
90 #
c5ec16e @dhh Added simple hash conditions to find that'll just convert hash to an …
dhh authored
91 # Similarly, a simple hash without a statement will generate conditions based on equality with the SQL AND
92 # operator. For instance:
93 #
2c27e3d @lifo Some doc updates reflecting the new query API
lifo authored
94 # Student.where(:first_name => "Harvey", :status => 1)
95 # Student.where(params[:student])
c5ec16e @dhh Added simple hash conditions to find that'll just convert hash to an …
dhh authored
96 #
2876707 @jeremy Pass a range in :conditions to use the SQL BETWEEN operator. Closes #…
jeremy authored
97 # A range may be used in the hash to use the SQL BETWEEN operator:
98 #
2c27e3d @lifo Some doc updates reflecting the new query API
lifo authored
99 # Student.where(:grade => 9..12)
c5ec16e @dhh Added simple hash conditions to find that'll just convert hash to an …
dhh authored
100 #
aa4af60 @lifo Improve documentation.
lifo authored
101 # An array may be used in the hash to use the SQL IN operator:
102 #
2c27e3d @lifo Some doc updates reflecting the new query API
lifo authored
103 # Student.where(:grade => [9,11,12])
aa4af60 @lifo Improve documentation.
lifo authored
104 #
e033b5d @lifo Merge docrails
lifo authored
105 # When joining tables, nested hashes or keys written in the form 'table_name.column_name' can be used to qualify the table name of a
106 # particular condition. For instance:
107 #
2c27e3d @lifo Some doc updates reflecting the new query API
lifo authored
108 # Student.joins(:schools).where(:schools => { :type => 'public' })
109 # Student.joins(:schools).where('schools.type' => 'public' )
e033b5d @lifo Merge docrails
lifo authored
110 #
db045db @dhh Initial
dhh authored
111 # == Overwriting default accessors
6e39c9e @jeremy r1614@asus: jeremy | 2005-07-03 08:01:08 -0700
jeremy authored
112 #
7143d80 Smattering of grammatical fixes to documentation. Closes #10083 [BobS…
Marcel Molina authored
113 # All column values are automatically available through basic accessors on the Active Record object, but sometimes you
114 # want to specialize this behavior. This can be done by overwriting the default accessors (using the same
98dc582 @lifo Merge docrails.
lifo authored
115 # name as the attribute) and calling <tt>read_attribute(attr_name)</tt> and <tt>write_attribute(attr_name, value)</tt> to actually change things.
db045db @dhh Initial
dhh authored
116 # Example:
6e39c9e @jeremy r1614@asus: jeremy | 2005-07-03 08:01:08 -0700
jeremy authored
117 #
db045db @dhh Initial
dhh authored
118 # class Song < ActiveRecord::Base
119 # # Uses an integer of seconds to hold the length of the song
6e39c9e @jeremy r1614@asus: jeremy | 2005-07-03 08:01:08 -0700
jeremy authored
120 #
db045db @dhh Initial
dhh authored
121 # def length=(minutes)
64092de @fxn Improve documentation coverage and markup
fxn authored
122 # write_attribute(:length, minutes.to_i * 60)
db045db @dhh Initial
dhh authored
123 # end
6e39c9e @jeremy r1614@asus: jeremy | 2005-07-03 08:01:08 -0700
jeremy authored
124 #
db045db @dhh Initial
dhh authored
125 # def length
0591c53 @dhh Made the dynamic finders use the new find API and updated the example…
dhh authored
126 # read_attribute(:length) / 60
db045db @dhh Initial
dhh authored
127 # end
128 # end
6e39c9e @jeremy r1614@asus: jeremy | 2005-07-03 08:01:08 -0700
jeremy authored
129 #
98dc582 @lifo Merge docrails.
lifo authored
130 # You can alternatively use <tt>self[:attribute]=(value)</tt> and <tt>self[:attribute]</tt> instead of <tt>write_attribute(:attribute, value)</tt> and
131 # <tt>read_attribute(:attribute)</tt> as a shorter form.
0591c53 @dhh Made the dynamic finders use the new find API and updated the example…
dhh authored
132 #
e4d845e Document automatically generated predicate methods for attributes. Cl…
Marcel Molina authored
133 # == Attribute query methods
134 #
135 # In addition to the basic accessors, query methods are also automatically available on the Active Record object.
136 # Query methods allow you to test whether an attribute value is present.
7367325 @jeremy Document Active Record exceptions. Closes #10444.
jeremy authored
137 #
e4d845e Document automatically generated predicate methods for attributes. Cl…
Marcel Molina authored
138 # For example, an Active Record User with the <tt>name</tt> attribute has a <tt>name?</tt> method that you can call
139 # to determine whether the user has a name:
140 #
141 # user = User.new(:name => "David")
142 # user.name? # => true
143 #
144 # anonymous = User.new(:name => "")
145 # anonymous.name? # => false
146 #
2948910 Misc doc fixes (typos/grammar/etc.). Closes #2430.
Marcel Molina authored
147 # == Accessing attributes before they have been typecasted
4eab375 @dhh Finished polishing API docs
dhh authored
148 #
2948910 Misc doc fixes (typos/grammar/etc.). Closes #2430.
Marcel Molina authored
149 # Sometimes you want to be able to read the raw attribute data without having the column-determined typecast run its course first.
dc4eec1 @lifo Merge docrails:
lifo authored
150 # That can be done by using the <tt><attribute>_before_type_cast</tt> accessors that all attributes have. For example, if your Account model
98dc582 @lifo Merge docrails.
lifo authored
151 # has a <tt>balance</tt> attribute, you can call <tt>account.balance_before_type_cast</tt> or <tt>account.id_before_type_cast</tt>.
4eab375 @dhh Finished polishing API docs
dhh authored
152 #
153 # This is especially useful in validation situations where the user might supply a string for an integer field and you want to display
2948910 Misc doc fixes (typos/grammar/etc.). Closes #2430.
Marcel Molina authored
154 # the original string back in an error message. Accessing the attribute normally would typecast the string to 0, which isn't what you
4eab375 @dhh Finished polishing API docs
dhh authored
155 # want.
156 #
ac8fd7d @dhh Added dynamic attribute-based finders as a cleaner way of getting obj…
dhh authored
157 # == Dynamic attribute-based finders
158 #
a5a82d9 @dhh Added extension capabilities to has_many and has_and_belongs_to_many …
dhh authored
159 # Dynamic attribute-based finders are a cleaner way of getting (and/or creating) objects by simple queries without turning to SQL. They work by
6dc9173 @dhh Missing doc updates
dhh authored
160 # appending the name of an attribute to <tt>find_by_</tt>, <tt>find_last_by_</tt>, or <tt>find_all_by_</tt>, so you get finders like <tt>Person.find_by_user_name</tt>,
98dc582 @lifo Merge docrails.
lifo authored
161 # <tt>Person.find_all_by_last_name</tt>, and <tt>Payment.find_by_transaction_id</tt>. So instead of writing
2c27e3d @lifo Some doc updates reflecting the new query API
lifo authored
162 # <tt>Person.where(:user_name => user_name).first</tt>, you just do <tt>Person.find_by_user_name(user_name)</tt>.
163 # And instead of writing <tt>Person.where(:last_name => last_name).all</tt>, you just do <tt>Person.find_all_by_last_name(last_name)</tt>.
6e39c9e @jeremy r1614@asus: jeremy | 2005-07-03 08:01:08 -0700
jeremy authored
164 #
ac8fd7d @dhh Added dynamic attribute-based finders as a cleaner way of getting obj…
dhh authored
165 # It's also possible to use multiple attributes in the same find by separating them with "_and_", so you get finders like
166 # <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
2c27e3d @lifo Some doc updates reflecting the new query API
lifo authored
167 # <tt>Person.where(:user_name => user_name, :password => password).first</tt>, you just do
ac8fd7d @dhh Added dynamic attribute-based finders as a cleaner way of getting obj…
dhh authored
168 # <tt>Person.find_by_user_name_and_password(user_name, password)</tt>.
6e39c9e @jeremy r1614@asus: jeremy | 2005-07-03 08:01:08 -0700
jeremy authored
169 #
2c27e3d @lifo Some doc updates reflecting the new query API
lifo authored
170 # It's even possible to call these dynamic finder methods on relations and named scopes. For example :
171 #
172 # Payment.order("created_on").find_all_by_amount(50)
173 # Payment.pending.find_last_by_amount(100)
959f362 @dhh Added find_all style to the new dynamic finders
dhh authored
174 #
a5a82d9 @dhh Added extension capabilities to has_many and has_and_belongs_to_many …
dhh authored
175 # The same dynamic finder style can be used to create the object if it doesn't already exist. This dynamic finder is called with
5c47ceb @NZKoz Typo fix in documentation from [9090] References #11422
NZKoz authored
176 # <tt>find_or_create_by_</tt> and will return the object if it already exists and otherwise creates it, then returns it. Protected attributes won't be set unless they are given in a block. For example:
a5a82d9 @dhh Added extension capabilities to has_many and has_and_belongs_to_many …
dhh authored
177 #
178 # # No 'Summer' tag exists
179 # Tag.find_or_create_by_name("Summer") # equal to Tag.create(:name => "Summer")
7367325 @jeremy Document Active Record exceptions. Closes #10444.
jeremy authored
180 #
a5a82d9 @dhh Added extension capabilities to has_many and has_and_belongs_to_many …
dhh authored
181 # # Now the 'Summer' tag does exist
182 # Tag.find_or_create_by_name("Summer") # equal to Tag.find_by_name("Summer")
183 #
c10b225 @dhh Fixed that ActiveRecord#Base.find_or_create/initialize would not hono…
dhh authored
184 # # Now 'Bob' exist and is an 'admin'
185 # User.find_or_create_by_name('Bob', :age => 40) { |u| u.admin = true }
186 #
0432d15 @lifo Merge with docrails.
lifo authored
187 # Use the <tt>find_or_initialize_by_</tt> finder if you want to return a new record without saving it first. Protected attributes won't be set unless they are given in a block. For example:
d19e464 @sstephenson Added find_or_initialize_by_X which works like find_or_create_by_X bu…
sstephenson authored
188 #
189 # # No 'Winter' tag exists
190 # winter = Tag.find_or_initialize_by_name("Winter")
85fbb22 @dhh Backed out of new_record? to new? transformation as it would screw up…
dhh authored
191 # winter.new_record? # true
d19e464 @sstephenson Added find_or_initialize_by_X which works like find_or_create_by_X bu…
sstephenson authored
192 #
14cc8d2 @jeremy find_or_create_by_* takes a hash so you can create with more attribut…
jeremy authored
193 # To find by a subset of the attributes to be used for instantiating a new object, pass a hash instead of
194 # a list of parameters. For example:
195 #
196 # Tag.find_or_create_by_name(:name => "rails", :creator => current_user)
197 #
198 # That will either find an existing tag named "rails", or create a new one while setting the user that created it.
199 #
098fa94 @dhh Fixed documentation snafus #575, #576, #577, #585
dhh authored
200 # == Saving arrays, hashes, and other non-mappable objects in text columns
6e39c9e @jeremy r1614@asus: jeremy | 2005-07-03 08:01:08 -0700
jeremy authored
201 #
202 # 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+.
2948910 Misc doc fixes (typos/grammar/etc.). Closes #2430.
Marcel Molina authored
203 # This makes it possible to store arrays, hashes, and other non-mappable objects without doing any additional work. Example:
6e39c9e @jeremy r1614@asus: jeremy | 2005-07-03 08:01:08 -0700
jeremy authored
204 #
db045db @dhh Initial
dhh authored
205 # class User < ActiveRecord::Base
206 # serialize :preferences
207 # end
6e39c9e @jeremy r1614@asus: jeremy | 2005-07-03 08:01:08 -0700
jeremy authored
208 #
ca2eb16 Fix syntax error in documentation. Closes #4679. [mislav@nippur.irb.hr]
Marcel Molina authored
209 # user = User.create(:preferences => { "background" => "black", "display" => large })
db045db @dhh Initial
dhh authored
210 # User.find(user.id).preferences # => { "background" => "black", "display" => large }
6e39c9e @jeremy r1614@asus: jeremy | 2005-07-03 08:01:08 -0700
jeremy authored
211 #
2948910 Misc doc fixes (typos/grammar/etc.). Closes #2430.
Marcel Molina authored
212 # You can also specify a class option as the second parameter that'll raise an exception if a serialized object is retrieved as a
39e1ac6 @lifo Merge docrails
lifo authored
213 # descendant of a class not in the hierarchy. Example:
6e39c9e @jeremy r1614@asus: jeremy | 2005-07-03 08:01:08 -0700
jeremy authored
214 #
db045db @dhh Initial
dhh authored
215 # class User < ActiveRecord::Base
66f44e6 @dhh Updated documentation for serialize
dhh authored
216 # serialize :preferences, Hash
db045db @dhh Initial
dhh authored
217 # end
6e39c9e @jeremy r1614@asus: jeremy | 2005-07-03 08:01:08 -0700
jeremy authored
218 #
0591c53 @dhh Made the dynamic finders use the new find API and updated the example…
dhh authored
219 # user = User.create(:preferences => %w( one two three ))
db045db @dhh Initial
dhh authored
220 # User.find(user.id).preferences # raises SerializationTypeMismatch
6e39c9e @jeremy r1614@asus: jeremy | 2005-07-03 08:01:08 -0700
jeremy authored
221 #
db045db @dhh Initial
dhh authored
222 # == Single table inheritance
223 #
7143d80 Smattering of grammatical fixes to documentation. Closes #10083 [BobS…
Marcel Molina authored
224 # Active Record allows inheritance by storing the name of the class in a column that by default is named "type" (can be changed
db045db @dhh Initial
dhh authored
225 # by overwriting <tt>Base.inheritance_column</tt>). This means that an inheritance looking like this:
226 #
227 # class Company < ActiveRecord::Base; end
228 # class Firm < Company; end
229 # class Client < Company; end
230 # class PriorityClient < Client; end
231 #
98dc582 @lifo Merge docrails.
lifo authored
232 # When you do <tt>Firm.create(:name => "37signals")</tt>, this record will be saved in the companies table with type = "Firm". You can then
2c27e3d @lifo Some doc updates reflecting the new query API
lifo authored
233 # fetch this row again using <tt>Company.where(:name => '37signals').first</tt> and it will return a Firm object.
db045db @dhh Initial
dhh authored
234 #
f033833 @dhh Improving documentation...
dhh authored
235 # 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
236 # like normal subclasses with no special magic for differentiating between them or reloading the right type with find.
237 #
db045db @dhh Initial
dhh authored
238 # Note, all the attributes for all the cases are kept in the same table. Read more:
239 # http://www.martinfowler.com/eaaCatalog/singleTableInheritance.html
6e39c9e @jeremy r1614@asus: jeremy | 2005-07-03 08:01:08 -0700
jeremy authored
240 #
db045db @dhh Initial
dhh authored
241 # == Connection to multiple databases in different models
242 #
243 # Connections are usually created through ActiveRecord::Base.establish_connection and retrieved by ActiveRecord::Base.connection.
6e39c9e @jeremy r1614@asus: jeremy | 2005-07-03 08:01:08 -0700
jeremy authored
244 # All classes inheriting from ActiveRecord::Base will use this connection. But you can also set a class-specific connection.
98dc582 @lifo Merge docrails.
lifo authored
245 # For example, if Course is an ActiveRecord::Base, but resides in a different database, you can just say <tt>Course.establish_connection</tt>
246 # and Course and all of its subclasses will use this connection instead.
db045db @dhh Initial
dhh authored
247 #
248 # This feature is implemented by keeping a connection pool in ActiveRecord::Base that is a Hash indexed by the class. If a connection is
249 # requested, the retrieve_connection method will go up the class-hierarchy until a connection is found in the connection pool.
250 #
251 # == Exceptions
6e39c9e @jeremy r1614@asus: jeremy | 2005-07-03 08:01:08 -0700
jeremy authored
252 #
dc4eec1 @lifo Merge docrails:
lifo authored
253 # * ActiveRecordError - Generic error class and superclass of all other errors raised by Active Record.
254 # * AdapterNotSpecified - The configuration hash used in <tt>establish_connection</tt> didn't include an
db045db @dhh Initial
dhh authored
255 # <tt>:adapter</tt> key.
dc4eec1 @lifo Merge docrails:
lifo authored
256 # * AdapterNotFound - The <tt>:adapter</tt> key used in <tt>establish_connection</tt> specified a non-existent adapter
6e39c9e @jeremy r1614@asus: jeremy | 2005-07-03 08:01:08 -0700
jeremy authored
257 # (or a bad spelling of an existing one).
dc4eec1 @lifo Merge docrails:
lifo authored
258 # * AssociationTypeMismatch - The object assigned to the association wasn't of the type specified in the association definition.
259 # * SerializationTypeMismatch - The serialized object wasn't of the class specified as the second parameter.
260 # * ConnectionNotEstablished+ - No connection has been established. Use <tt>establish_connection</tt> before querying.
261 # * RecordNotFound - No record responded to the +find+ method. Either the row with the given ID doesn't exist
262 # or the row didn't meet the additional restrictions. Some +find+ calls do not raise this exception to signal
263 # nothing was found, please check its documentation for further details.
264 # * StatementInvalid - The database server rejected the SQL statement. The precise error is added in the message.
265 # * MultiparameterAssignmentErrors - Collection of errors that occurred during a mass assignment using the
266 # <tt>attributes=</tt> method. The +errors+ property of this exception contains an array of AttributeAssignmentError
d2fefbe @dhh Added MultiparameterAssignmentErrors and AttributeAssignmentError exc…
dhh authored
267 # objects that should be inspected to determine which attributes triggered the errors.
dc4eec1 @lifo Merge docrails:
lifo authored
268 # * AttributeAssignmentError - An error occurred while doing a mass assignment through the <tt>attributes=</tt> method.
d2fefbe @dhh Added MultiparameterAssignmentErrors and AttributeAssignmentError exc…
dhh authored
269 # You can inspect the +attribute+ property of the exception object to determine which attribute triggered the error.
5707027 @dhh Added better exception error when unknown column types are used with …
dhh authored
270 #
6e39c9e @jeremy r1614@asus: jeremy | 2005-07-03 08:01:08 -0700
jeremy authored
271 # *Note*: The attributes listed are class-level attributes (accessible from both the class and instance level).
dc4eec1 @lifo Merge docrails:
lifo authored
272 # So it's possible to assign a logger to the class through <tt>Base.logger=</tt> which will then be used by all
db045db @dhh Initial
dhh authored
273 # instances in the current object space.
274 class Base
0905396 @miloops construct_finder_sql now use Arel
miloops authored
275 ##
dbbae5e @lifo Merge with docrails
lifo authored
276 # :singleton-method:
db045db @dhh Initial
dhh authored
277 # Accepts a logger conforming to the interface of Log4r or the default Ruby 1.8+ Logger class, which is then passed
278 # on to any new database connections made and which can be retrieved on both a class and instance level by calling +logger+.
1a11bff @technoweenie Don't create instance writer methods for class attributes. Closes #7…
technoweenie authored
279 cattr_accessor :logger, :instance_writer => false
e694114 @jeremy Deprecation: removed Reloadable.
jeremy authored
280
dbbae5e @lifo Merge with docrails
lifo authored
281 ##
282 # :singleton-method:
a293278 @lifo Merge docrails
lifo authored
283 # Contains the database configuration - as is typically stored in config/database.yml -
284 # as a Hash.
285 #
286 # For example, the following database.yml...
0905396 @miloops construct_finder_sql now use Arel
miloops authored
287 #
a293278 @lifo Merge docrails
lifo authored
288 # development:
289 # adapter: sqlite3
290 # database: db/development.sqlite3
0905396 @miloops construct_finder_sql now use Arel
miloops authored
291 #
a293278 @lifo Merge docrails
lifo authored
292 # production:
293 # adapter: sqlite3
294 # database: db/production.sqlite3
295 #
296 # ...would result in ActiveRecord::Base.configurations to look like this:
297 #
298 # {
299 # 'development' => {
300 # 'adapter' => 'sqlite3',
301 # 'database' => 'db/development.sqlite3'
302 # },
303 # 'production' => {
304 # 'adapter' => 'sqlite3',
305 # 'database' => 'db/production.sqlite3'
306 # }
307 # }
1a11bff @technoweenie Don't create instance writer methods for class attributes. Closes #7…
technoweenie authored
308 cattr_accessor :configurations, :instance_writer => false
c4a3634 @jeremy Corrected @@configurations typo. #1410 [david@ruppconsulting.com]
jeremy authored
309 @@configurations = {}
310
dbbae5e @lifo Merge with docrails
lifo authored
311 ##
312 # :singleton-method:
6e39c9e @jeremy r1614@asus: jeremy | 2005-07-03 08:01:08 -0700
jeremy authored
313 # Accessor for the prefix type that will be prepended to every primary key column name. The options are :table_name and
db045db @dhh Initial
dhh authored
314 # :table_name_with_underscore. If the first is specified, the Product class will look for "productid" instead of "id" as
315 # the primary column. If the latter is specified, the Product class will look for "product_id" instead of "id". Remember
6e39c9e @jeremy r1614@asus: jeremy | 2005-07-03 08:01:08 -0700
jeremy authored
316 # that this is a global setting for all Active Records.
1a11bff @technoweenie Don't create instance writer methods for class attributes. Closes #7…
technoweenie authored
317 cattr_accessor :primary_key_prefix_type, :instance_writer => false
db045db @dhh Initial
dhh authored
318 @@primary_key_prefix_type = nil
319
dbbae5e @lifo Merge with docrails
lifo authored
320 ##
321 # :singleton-method:
6e39c9e @jeremy r1614@asus: jeremy | 2005-07-03 08:01:08 -0700
jeremy authored
322 # Accessor for the name of the prefix string to prepend to every table name. So if set to "basecamp_", all
098fa94 @dhh Fixed documentation snafus #575, #576, #577, #585
dhh authored
323 # table names will be named like "basecamp_projects", "basecamp_people", etc. This is a convenient way of creating a namespace
db045db @dhh Initial
dhh authored
324 # for tables in a shared database. By default, the prefix is the empty string.
67d1cec @pixeltrix Add the ability to specify table_name_prefix on individual modules
pixeltrix authored
325 #
326 # If you are organising your models within modules you can add a prefix to the models within a namespace by defining
327 # a singleton method in the parent module called table_name_prefix which returns your chosen prefix.
bab1f91 @phs table_name_prefix and table_name_suffix are class_attributes instead …
phs authored
328 class_attribute :table_name_prefix, :instance_writer => false
329 self.table_name_prefix = ""
db045db @dhh Initial
dhh authored
330
dbbae5e @lifo Merge with docrails
lifo authored
331 ##
332 # :singleton-method:
db045db @dhh Initial
dhh authored
333 # Works like +table_name_prefix+, but appends instead of prepends (set to "_basecamp" gives "projects_basecamp",
334 # "people_basecamp"). By default, the suffix is the empty string.
bab1f91 @phs table_name_prefix and table_name_suffix are class_attributes instead …
phs authored
335 class_attribute :table_name_suffix, :instance_writer => false
336 self.table_name_suffix = ""
db045db @dhh Initial
dhh authored
337
dbbae5e @lifo Merge with docrails
lifo authored
338 ##
339 # :singleton-method:
84a14f2 @jeremy Raise ProtectedAttributeAssignmentError in development and test envir…
jeremy authored
340 # Indicates whether table names should be the pluralized versions of the corresponding class names.
98dc582 @lifo Merge docrails.
lifo authored
341 # If true, the default table name for a Product class will be +products+. If false, it would just be +product+.
db045db @dhh Initial
dhh authored
342 # See table_name for the full rules on table/class naming. This is true, by default.
1a11bff @technoweenie Don't create instance writer methods for class attributes. Closes #7…
technoweenie authored
343 cattr_accessor :pluralize_table_names, :instance_writer => false
db045db @dhh Initial
dhh authored
344 @@pluralize_table_names = true
345
dbbae5e @lifo Merge with docrails
lifo authored
346 ##
347 # :singleton-method:
60de8c1 @dhh Added Base.default_timezone accessor that determines whether to use T…
dhh authored
348 # Determines whether to use Time.local (using :local) or Time.utc (using :utc) when pulling dates and times from the database.
349 # This is set to :local by default.
1a11bff @technoweenie Don't create instance writer methods for class attributes. Closes #7…
technoweenie authored
350 cattr_accessor :default_timezone, :instance_writer => false
60de8c1 @dhh Added Base.default_timezone accessor that determines whether to use T…
dhh authored
351 @@default_timezone = :local
d8641ca @jeremy CHANGED DEFAULT: set ActiveRecord::Base.allow_concurrency to false. …
jeremy authored
352
dbbae5e @lifo Merge with docrails
lifo authored
353 ##
354 # :singleton-method:
24c3599 @sstephenson Support using different database adapters for development and test wi…
sstephenson authored
355 # Specifies the format to use when dumping the database schema with Rails'
356 # Rakefile. If :sql, the schema is dumped as (potentially database-
7367325 @jeremy Document Active Record exceptions. Closes #10444.
jeremy authored
357 # specific) SQL statements. If :ruby, the schema is dumped as an
24c3599 @sstephenson Support using different database adapters for development and test wi…
sstephenson authored
358 # ActiveRecord::Schema file which can be loaded into any database that
359 # supports migrations. Use :ruby if you want to have different database
360 # adapters for, e.g., your development and test environments.
1a11bff @technoweenie Don't create instance writer methods for class attributes. Closes #7…
technoweenie authored
361 cattr_accessor :schema_format , :instance_writer => false
660952e @dhh CHANGED DEFAULT: ActiveRecord::Base.schema_format is now :ruby by def…
dhh authored
362 @@schema_format = :ruby
3b0e1d9 @josh Prefer string core_ext inflector methods over directly accessing Infl…
josh authored
363
dbbae5e @lifo Merge with docrails
lifo authored
364 ##
365 # :singleton-method:
155f0be @rizwanreza Changes migration number to version due to ambiguity. [#3065 state:co…
rizwanreza authored
366 # Specify whether or not to use timestamps for migration versions
bbab639 @nikz Set config.active_record.timestamped_migrations = false to have migra…
nikz authored
367 cattr_accessor :timestamped_migrations , :instance_writer => false
368 @@timestamped_migrations = true
369
bca8751 @divoxx Add ActiveRecord option to store the full class name on STI's type co…
divoxx authored
370 # Determine whether to store the full constant name including namespace when using STI
371 superclass_delegating_accessor :store_full_sti_class
1459c8c @dhh Changed ActiveRecord::Base.store_full_sti_class to be true by default…
dhh authored
372 self.store_full_sti_class = true
3b0e1d9 @josh Prefer string core_ext inflector methods over directly accessing Infl…
josh authored
373
2530d0e @lifo Added default_scope to Base [#1381 state:committed] (Paweł Kondzior)
lifo authored
374 # Stores the default scope for the class
375 class_inheritable_accessor :default_scoping, :instance_writer => false
376 self.default_scoping = []
377
db045db @dhh Initial
dhh authored
378 class << self # Class methods
8d78a82 @josevalim Deprecate ActiveRecord::Base.colorize_logging.
josevalim authored
379 def colorize_logging(*args)
380 ActiveSupport::Deprecation.warn "ActiveRecord::Base.colorize_logging and " <<
39d6f9e @wycats Make many parts of Rails lazy. In order to facilitate this,
wycats authored
381 "config.active_record.colorize_logging are deprecated. Please use " <<
f0523f7 @sikachu Rename Rails::Subscriber to Rails::LogSubscriber
sikachu authored
382 "Rails::LogSubscriber.colorize_logging or config.colorize_logging instead", caller
8d78a82 @josevalim Deprecate ActiveRecord::Base.colorize_logging.
josevalim authored
383 end
384 alias :colorize_logging= :colorize_logging
385
8d31c9f @lifo Move update and update_all to Relation
lifo authored
386 delegate :find, :first, :last, :all, :destroy, :destroy_all, :exists?, :delete, :delete_all, :update, :update_all, :to => :scoped
dc3cc6c @lifo Move batch finders to Relation
lifo authored
387 delegate :find_each, :find_in_batches, :to => :scoped
6f5f23a @lifo Add Relation#includes to be an equivalent of current finder option :i…
lifo authored
388 delegate :select, :group, :order, :limit, :joins, :where, :preload, :eager_load, :includes, :from, :lock, :readonly, :having, :to => :scoped
9465b84 @lifo Rename CalculationMethods to Calculations and get rid of the old Calc…
lifo authored
389 delegate :count, :average, :minimum, :maximum, :sum, :calculate, :to => :scoped
a7fd564 @lifo Add Model.select/group/order/limit/joins/conditions/preload/eager_loa…
lifo authored
390
98dc582 @lifo Merge docrails.
lifo authored
391 # Executes a custom SQL query against your database and returns all the results. The results will
7367325 @jeremy Document Active Record exceptions. Closes #10444.
jeremy authored
392 # be returned as an array with columns requested encapsulated as attributes of the model you call
a293278 @lifo Merge docrails
lifo authored
393 # this method from. If you call <tt>Product.find_by_sql</tt> then the results will be returned in
394 # a Product object with the attributes you specified in the SQL query.
edf32ce More complete documentation for find_by_sql. Closes #7912 [fearoffish]
Marcel Molina authored
395 #
7367325 @jeremy Document Active Record exceptions. Closes #10444.
jeremy authored
396 # If you call a complicated SQL query which spans multiple tables the columns specified by the
397 # SELECT will be attributes of the model, whether or not they are columns of the corresponding
edf32ce More complete documentation for find_by_sql. Closes #7912 [fearoffish]
Marcel Molina authored
398 # table.
399 #
98dc582 @lifo Merge docrails.
lifo authored
400 # The +sql+ parameter is a full SQL query as a string. It will be called as is, there will be
7367325 @jeremy Document Active Record exceptions. Closes #10444.
jeremy authored
401 # no database agnostic conversions performed. This should be a last resort because using, for example,
402 # MySQL specific terms will lock you to using that particular database engine or require you to
a293278 @lifo Merge docrails
lifo authored
403 # change your call if you switch engines.
edf32ce More complete documentation for find_by_sql. Closes #7912 [fearoffish]
Marcel Molina authored
404 #
405 # ==== Examples
98dc582 @lifo Merge docrails.
lifo authored
406 # # A simple SQL query spanning multiple tables
edf32ce More complete documentation for find_by_sql. Closes #7912 [fearoffish]
Marcel Molina authored
407 # Post.find_by_sql "SELECT p.title, c.author FROM posts p, comments c WHERE p.id = c.post_id"
408 # > [#<Post:0x36bff9c @attributes={"title"=>"Ruby Meetup", "first_name"=>"Quentin"}>, ...]
409 #
410 # # You can use the same string replacement techniques as you can with ActiveRecord#find
411 # Post.find_by_sql ["SELECT title FROM posts WHERE author = ? AND created > ?", author_id, start_date]
412 # > [#<Post:0x36bff9c @attributes={"first_name"=>"The Cheap Man Buys Twice"}>, ...]
db045db @dhh Initial
dhh authored
413 def find_by_sql(sql)
6e3d2a7 @jeremy Revert "Performance: freeze cached rows instead of duping"
jeremy authored
414 connection.select_all(sanitize_sql(sql), "#{name} Load").collect! { |record| instantiate(record) }
db045db @dhh Initial
dhh authored
415 end
6e39c9e @jeremy r1614@asus: jeremy | 2005-07-03 08:01:08 -0700
jeremy authored
416
7367325 @jeremy Document Active Record exceptions. Closes #10444.
jeremy authored
417 # Creates an object (or multiple objects) and saves it to the database, if validations pass.
a23bea7 Document API for create's attributes parameter and provide examples. …
Marcel Molina authored
418 # The resulting object is returned whether the object was saved successfully to the database or not.
419 #
420 # The +attributes+ parameter can be either be a Hash or an Array of Hashes. These Hashes describe the
421 # attributes on the objects that are to be created.
422 #
423 # ==== Examples
424 # # Create a single new object
425 # User.create(:first_name => 'Jamie')
dd120ed @dhh Added block-setting of attributes for Base.create like Base.new alrea…
dhh authored
426 #
a23bea7 Document API for create's attributes parameter and provide examples. …
Marcel Molina authored
427 # # Create an Array of new objects
dc4eec1 @lifo Merge docrails:
lifo authored
428 # User.create([{ :first_name => 'Jamie' }, { :first_name => 'Jeremy' }])
dd120ed @dhh Added block-setting of attributes for Base.create like Base.new alrea…
dhh authored
429 #
430 # # Create a single object and pass it into a block to set other attributes.
431 # User.create(:first_name => 'Jamie') do |u|
432 # u.is_admin = false
433 # end
434 #
435 # # Creating an Array of new objects using a block, where the block is executed for each object:
dc4eec1 @lifo Merge docrails:
lifo authored
436 # User.create([{ :first_name => 'Jamie' }, { :first_name => 'Jeremy' }]) do |u|
dd120ed @dhh Added block-setting of attributes for Base.create like Base.new alrea…
dhh authored
437 # u.is_admin = false
3b0e1d9 @josh Prefer string core_ext inflector methods over directly accessing Infl…
josh authored
438 # end
dd120ed @dhh Added block-setting of attributes for Base.create like Base.new alrea…
dhh authored
439 def create(attributes = nil, &block)
efa81da @dhh Added the option of supplying an array of ids and attributes to Base#…
dhh authored
440 if attributes.is_a?(Array)
dd120ed @dhh Added block-setting of attributes for Base.create like Base.new alrea…
dhh authored
441 attributes.collect { |attr| create(attr, &block) }
efa81da @dhh Added the option of supplying an array of ids and attributes to Base#…
dhh authored
442 else
443 object = new(attributes)
dd120ed @dhh Added block-setting of attributes for Base.create like Base.new alrea…
dhh authored
444 yield(object) if block_given?
efa81da @dhh Added the option of supplying an array of ids and attributes to Base#…
dhh authored
445 object.save
446 object
447 end
db045db @dhh Initial
dhh authored
448 end
449
450 # Returns the result of an SQL statement that should only include a COUNT(*) in the SELECT part.
7367325 @jeremy Document Active Record exceptions. Closes #10444.
jeremy authored
451 # The use of this method should be restricted to complicated SQL queries that can't be executed
ee614d6 Add documentation caveat about when to use count_by_sql. Closes #8090…
Marcel Molina authored
452 # using the ActiveRecord::Calculations class methods. Look into those before using this.
453 #
a293278 @lifo Merge docrails
lifo authored
454 # ==== Parameters
7367325 @jeremy Document Active Record exceptions. Closes #10444.
jeremy authored
455 #
dc4eec1 @lifo Merge docrails:
lifo authored
456 # * +sql+ - An SQL statement which should return a count query from the database, see the example below.
ee614d6 Add documentation caveat about when to use count_by_sql. Closes #8090…
Marcel Molina authored
457 #
458 # ==== Examples
459 #
e17bf81 @jamis Fix typo in count_by_sql documentation #1969 [Alexey Verkhovsky]
jamis authored
460 # Product.count_by_sql "SELECT COUNT(*) FROM sales s, customers c WHERE s.customer_id = c.id"
db045db @dhh Initial
dhh authored
461 def count_by_sql(sql)
a775cb1 @dhh Added the option for sanitizing find_by_sql and the offset parts in r…
dhh authored
462 sql = sanitize_conditions(sql)
caaf40d @dhh Added AbstractAdapter#select_value and AbstractAdapter#select_values …
dhh authored
463 connection.select_value(sql, "#{name} Count").to_i
db045db @dhh Initial
dhh authored
464 end
6e39c9e @jeremy r1614@asus: jeremy | 2005-07-03 08:01:08 -0700
jeremy authored
465
98dc582 @lifo Merge docrails.
lifo authored
466 # Attributes named in this macro are protected from mass-assignment,
467 # such as <tt>new(attributes)</tt>,
468 # <tt>update_attributes(attributes)</tt>, or
469 # <tt>attributes=(attributes)</tt>.
470 #
471 # Mass-assignment to these attributes will simply be ignored, to assign
472 # to them you can use direct writer methods. This is meant to protect
473 # sensitive attributes from being overwritten by malicious users
474 # tampering with URLs or forms.
db045db @dhh Initial
dhh authored
475 #
476 # class Customer < ActiveRecord::Base
477 # attr_protected :credit_rating
478 # end
479 #
480 # customer = Customer.new("name" => David, "credit_rating" => "Excellent")
481 # customer.credit_rating # => nil
482 # customer.attributes = { "description" => "Jolly fellow", "credit_rating" => "Superb" }
483 # customer.credit_rating # => nil
484 #
485 # customer.credit_rating = "Average"
486 # customer.credit_rating # => "Average"
d761ac4 Add docs explaining how to protect all attributes using attr_accessib…
Marcel Molina authored
487 #
98dc582 @lifo Merge docrails.
lifo authored
488 # To start from an all-closed default and enable attributes as needed,
489 # have a look at +attr_accessible+.
e033b5d @lifo Merge docrails
lifo authored
490 #
491 # If the access logic of your application is richer you can use <tt>Hash#except</tt>
492 # or <tt>Hash#slice</tt> to sanitize the hash of parameters before they are
493 # passed to Active Record.
31c8353 @miloops Don't use local vars before testing its conditional.
miloops authored
494 #
e033b5d @lifo Merge docrails
lifo authored
495 # For example, it could be the case that the list of protected attributes
496 # for a given model depends on the role of the user:
497 #
498 # # Assumes plan_id is not protected because it depends on the role.
499 # params[:account] = params[:account].except(:plan_id) unless admin?
500 # @account.update_attributes(params[:account])
501 #
502 # Note that +attr_protected+ is still applied to the received hash. Thus,
503 # with this technique you can at most _extend_ the list of protected
504 # attributes for a particular mass-assignment call.
db045db @dhh Initial
dhh authored
505 def attr_protected(*attributes)
b6bac73 Merge commit 'origin/master'
Yehuda Katz + Carl Lerche authored
506 write_inheritable_attribute(:attr_protected, Set.new(attributes.map {|a| a.to_s}) + (protected_attributes || []))
db045db @dhh Initial
dhh authored
507 end
6e39c9e @jeremy r1614@asus: jeremy | 2005-07-03 08:01:08 -0700
jeremy authored
508
098fa94 @dhh Fixed documentation snafus #575, #576, #577, #585
dhh authored
509 # Returns an array of all the attributes that have been protected from mass-assignment.
db045db @dhh Initial
dhh authored
510 def protected_attributes # :nodoc:
288e947 @clemens Some performance goodness for inheritable attributes.
clemens authored
511 read_inheritable_attribute(:attr_protected)
db045db @dhh Initial
dhh authored
512 end
513
98dc582 @lifo Merge docrails.
lifo authored
514 # Specifies a white list of model attributes that can be set via
515 # mass-assignment, such as <tt>new(attributes)</tt>,
516 # <tt>update_attributes(attributes)</tt>, or
517 # <tt>attributes=(attributes)</tt>
f770b82 Enhance explanation with more examples for attr_accessible macro. Clo…
Marcel Molina authored
518 #
98dc582 @lifo Merge docrails.
lifo authored
519 # This is the opposite of the +attr_protected+ macro: Mass-assignment
520 # will only set attributes in this list, to assign to the rest of
521 # attributes you can use direct writer methods. This is meant to protect
522 # sensitive attributes from being overwritten by malicious users
523 # tampering with URLs or forms. If you'd rather start from an all-open
524 # default and restrict attributes as needed, have a look at
525 # +attr_protected+.
d761ac4 Add docs explaining how to protect all attributes using attr_accessib…
Marcel Molina authored
526 #
527 # class Customer < ActiveRecord::Base
f770b82 Enhance explanation with more examples for attr_accessible macro. Clo…
Marcel Molina authored
528 # attr_accessible :name, :nickname
d761ac4 Add docs explaining how to protect all attributes using attr_accessib…
Marcel Molina authored
529 # end
530 #
f770b82 Enhance explanation with more examples for attr_accessible macro. Clo…
Marcel Molina authored
531 # customer = Customer.new(:name => "David", :nickname => "Dave", :credit_rating => "Excellent")
532 # customer.credit_rating # => nil
533 # customer.attributes = { :name => "Jolly fellow", :credit_rating => "Superb" }
534 # customer.credit_rating # => nil
d761ac4 Add docs explaining how to protect all attributes using attr_accessib…
Marcel Molina authored
535 #
f770b82 Enhance explanation with more examples for attr_accessible macro. Clo…
Marcel Molina authored
536 # customer.credit_rating = "Average"
537 # customer.credit_rating # => "Average"
e033b5d @lifo Merge docrails
lifo authored
538 #
539 # If the access logic of your application is richer you can use <tt>Hash#except</tt>
540 # or <tt>Hash#slice</tt> to sanitize the hash of parameters before they are
541 # passed to Active Record.
31c8353 @miloops Don't use local vars before testing its conditional.
miloops authored
542 #
e033b5d @lifo Merge docrails
lifo authored
543 # For example, it could be the case that the list of accessible attributes
544 # for a given model depends on the role of the user:
545 #
546 # # Assumes plan_id is accessible because it depends on the role.
547 # params[:account] = params[:account].except(:plan_id) unless admin?
548 # @account.update_attributes(params[:account])
549 #
550 # Note that +attr_accessible+ is still applied to the received hash. Thus,
551 # with this technique you can at most _narrow_ the list of accessible
552 # attributes for a particular mass-assignment call.
db045db @dhh Initial
dhh authored
553 def attr_accessible(*attributes)
288e947 @clemens Some performance goodness for inheritable attributes.
clemens authored
554 write_inheritable_attribute(:attr_accessible, Set.new(attributes.map(&:to_s)) + (accessible_attributes || []))
db045db @dhh Initial
dhh authored
555 end
6e39c9e @jeremy r1614@asus: jeremy | 2005-07-03 08:01:08 -0700
jeremy authored
556
098fa94 @dhh Fixed documentation snafus #575, #576, #577, #585
dhh authored
557 # Returns an array of all the attributes that have been made accessible to mass-assignment.
db045db @dhh Initial
dhh authored
558 def accessible_attributes # :nodoc:
288e947 @clemens Some performance goodness for inheritable attributes.
clemens authored
559 read_inheritable_attribute(:attr_accessible)
db045db @dhh Initial
dhh authored
560 end
561
66d05f5 @technoweenie Add attr_readonly to specify columns that are skipped during a normal…
technoweenie authored
562 # Attributes listed as readonly can be set for a new record, but will be ignored in database updates afterwards.
563 def attr_readonly(*attributes)
288e947 @clemens Some performance goodness for inheritable attributes.
clemens authored
564 write_inheritable_attribute(:attr_readonly, Set.new(attributes.map(&:to_s)) + (readonly_attributes || []))
66d05f5 @technoweenie Add attr_readonly to specify columns that are skipped during a normal…
technoweenie authored
565 end
566
567 # Returns an array of all the attributes that have been specified as readonly.
568 def readonly_attributes
5b61168 @miloops Added arel_attributes_values methods, refactored locking and AR#updat…
miloops authored
569 read_inheritable_attribute(:attr_readonly) || []
66d05f5 @technoweenie Add attr_readonly to specify columns that are skipped during a normal…
technoweenie authored
570 end
c450a36 @dhh Doc fixes
dhh authored
571
7367325 @jeremy Document Active Record exceptions. Closes #10444.
jeremy authored
572 # If you have an attribute that needs to be saved to the database as an object, and retrieved as the same object,
573 # then specify the name of that attribute using this method and it will be handled automatically.
574 # The serialization is done through YAML. If +class_name+ is specified, the serialized object must be of that
98dc582 @lifo Merge docrails.
lifo authored
575 # class on retrieval or SerializationTypeMismatch will be raised.
1a0cdf7 @dhh Docfix (closes #8096)
dhh authored
576 #
a293278 @lifo Merge docrails
lifo authored
577 # ==== Parameters
1a0cdf7 @dhh Docfix (closes #8096)
dhh authored
578 #
dc4eec1 @lifo Merge docrails:
lifo authored
579 # * +attr_name+ - The field name that should be serialized.
580 # * +class_name+ - Optional, class name that the object type should be equal to.
1a0cdf7 @dhh Docfix (closes #8096)
dhh authored
581 #
582 # ==== Example
583 # # Serialize a preferences attribute
584 # class User
585 # serialize :preferences
586 # end
db045db @dhh Initial
dhh authored
587 def serialize(attr_name, class_name = Object)
6e39c9e @jeremy r1614@asus: jeremy | 2005-07-03 08:01:08 -0700
jeremy authored
588 serialized_attributes[attr_name.to_s] = class_name
db045db @dhh Initial
dhh authored
589 end
6e39c9e @jeremy r1614@asus: jeremy | 2005-07-03 08:01:08 -0700
jeremy authored
590
db045db @dhh Initial
dhh authored
591 # Returns a hash of all the attributes that have been specified for serialization as keys and their class restriction as values.
592 def serialized_attributes
288e947 @clemens Some performance goodness for inheritable attributes.
clemens authored
593 read_inheritable_attribute(:attr_serialized) or write_inheritable_attribute(:attr_serialized, {})
db045db @dhh Initial
dhh authored
594 end
595
596 # Guesses the table name (in forced lower-case) based on the name of the class in the inheritance hierarchy descending
98dc582 @lifo Merge docrails.
lifo authored
597 # directly from ActiveRecord::Base. So if the hierarchy looks like: Reply < Message < ActiveRecord::Base, then Message is used
d64832c Give examples for what tables should be called for models inside a mo…
Marcel Molina authored
598 # to guess the table name even when called on Reply. The rules used to do the guess are handled by the Inflector class
7143d80 Smattering of grammatical fixes to documentation. Closes #10083 [BobS…
Marcel Molina authored
599 # in Active Support, which knows almost all common English inflections. You can add new inflections in config/initializers/inflections.rb.
db045db @dhh Initial
dhh authored
600 #
14101c7 @jeremy Nested classes are given table names prefixed by the singular form of…
jeremy authored
601 # Nested classes are given table names prefixed by the singular form of
98dc582 @lifo Merge docrails.
lifo authored
602 # the parent's table name. Enclosing modules are not considered.
603 #
604 # ==== Examples
d64832c Give examples for what tables should be called for models inside a mo…
Marcel Molina authored
605 #
606 # class Invoice < ActiveRecord::Base; end;
14101c7 @jeremy Nested classes are given table names prefixed by the singular form of…
jeremy authored
607 # file class table_name
608 # invoice.rb Invoice invoices
d64832c Give examples for what tables should be called for models inside a mo…
Marcel Molina authored
609 #
610 # class Invoice < ActiveRecord::Base; class Lineitem < ActiveRecord::Base; end; end;
611 # file class table_name
612 # invoice.rb Invoice::Lineitem invoice_lineitems
613 #
614 # module Invoice; class Lineitem < ActiveRecord::Base; end; end;
615 # file class table_name
616 # invoice/lineitem.rb Invoice::Lineitem lineitems
db045db @dhh Initial
dhh authored
617 #
98dc582 @lifo Merge docrails.
lifo authored
618 # Additionally, the class-level +table_name_prefix+ is prepended and the
619 # +table_name_suffix+ is appended. So if you have "myapp_" as a prefix,
14101c7 @jeremy Nested classes are given table names prefixed by the singular form of…
jeremy authored
620 # the table name guess for an Invoice class becomes "myapp_invoices".
621 # Invoice::Lineitem becomes "myapp_invoice_lineitems".
622 #
623 # You can also overwrite this class method to allow for unguessable
624 # links, such as a Mouse class with a link to a "mice" table. Example:
db045db @dhh Initial
dhh authored
625 #
626 # class Mouse < ActiveRecord::Base
14101c7 @jeremy Nested classes are given table names prefixed by the singular form of…
jeremy authored
627 # set_table_name "mice"
db045db @dhh Initial
dhh authored
628 # end
dcc4868 @dhh Fixed that Base.table_name would expect a parameter when used in has_…
dhh authored
629 def table_name
d736568 Speed up the setting of table_name. Closes #2428.
Marcel Molina authored
630 reset_table_name
631 end
632
8d82bef @tchandy Documentation for #quoted_table_name method
tchandy authored
633 # Returns a quoted version of the table name, used to construct SQL statements.
798d282 @lifo Cache quoted_table_name
lifo authored
634 def quoted_table_name
635 @quoted_table_name ||= connection.quote_table_name(table_name)
636 end
637
4a8c880 @fxn refactors AR::Base#reset_table_name
fxn authored
638 # Computes the table name, (re)sets it internally, and returns it.
fed7d33 @dhh Fixed documentation
dhh authored
639 def reset_table_name #:nodoc:
4a8c880 @fxn refactors AR::Base#reset_table_name
fxn authored
640 self.table_name = compute_table_name
db045db @dhh Initial
dhh authored
641 end
642
5f7bc47 @wycats Rename modularized_table_name_prefix to full_table_name_prefix [#4032…
wycats authored
643 def full_table_name_prefix #:nodoc:
67d1cec @pixeltrix Add the ability to specify table_name_prefix on individual modules
pixeltrix authored
644 (parents.detect{ |p| p.respond_to?(:table_name_prefix) } || self).table_name_prefix
645 end
646
9d2da04 @jeremy Cache inheritance_column. Closes #6592.
jeremy authored
647 # Defines the column name for use with single table inheritance
648 # -- can be set in subclasses like so: self.inheritance_column = "type_id"
db045db @dhh Initial
dhh authored
649 def inheritance_column
9d2da04 @jeremy Cache inheritance_column. Closes #6592.
jeremy authored
650 @inheritance_column ||= "type".freeze
db045db @dhh Initial
dhh authored
651 end
652
7c8f3ed @jeremy r4325@asus: jeremy | 2005-11-12 03:57:46 -0800
jeremy authored
653 # Lazy-set the sequence name to the connection's default. This method
654 # is only ever called once since set_sequence_name overrides it.
fed7d33 @dhh Fixed documentation
dhh authored
655 def sequence_name #:nodoc:
7c8f3ed @jeremy r4325@asus: jeremy | 2005-11-12 03:57:46 -0800
jeremy authored
656 reset_sequence_name
657 end
658
fed7d33 @dhh Fixed documentation
dhh authored
659 def reset_sequence_name #:nodoc:
7c8f3ed @jeremy r4325@asus: jeremy | 2005-11-12 03:57:46 -0800
jeremy authored
660 default = connection.default_sequence_name(table_name, primary_key)
661 set_sequence_name(default)
662 default
14ea312 @dhh Made Oracle a first-class connection adapter by adhering closer to id…
dhh authored
663 end
664
1aa82b3 @dhh Added keyword-style approach to defining the custom relational bindin…
dhh authored
665 # Sets the table name to use to the given value, or (if the value
4eab375 @dhh Finished polishing API docs
dhh authored
666 # is nil or false) to the value returned by the given block.
1aa82b3 @dhh Added keyword-style approach to defining the custom relational bindin…
dhh authored
667 #
668 # class Project < ActiveRecord::Base
669 # set_table_name "project"
670 # end
c9c1852 @dhh Making ActiveRecord faster [skaes]
dhh authored
671 def set_table_name(value = nil, &block)
47c9a35 @spastorino Reset quoted_table_name after set_table_name [#4568 state:resolved]
spastorino authored
672 @quoted_table_name = nil
1aa82b3 @dhh Added keyword-style approach to defining the custom relational bindin…
dhh authored
673 define_attr_method :table_name, value, &block
674 end
675 alias :table_name= :set_table_name
676
677 # Sets the name of the inheritance column to use to the given value,
678 # or (if the value # is nil or false) to the value returned by the
4eab375 @dhh Finished polishing API docs
dhh authored
679 # given block.
1aa82b3 @dhh Added keyword-style approach to defining the custom relational bindin…
dhh authored
680 #
681 # class Project < ActiveRecord::Base
682 # set_inheritance_column do
683 # original_inheritance_column + "_id"
684 # end
685 # end
c9c1852 @dhh Making ActiveRecord faster [skaes]
dhh authored
686 def set_inheritance_column(value = nil, &block)
1aa82b3 @dhh Added keyword-style approach to defining the custom relational bindin…
dhh authored
687 define_attr_method :inheritance_column, value, &block
688 end
689 alias :inheritance_column= :set_inheritance_column
690
14ea312 @dhh Made Oracle a first-class connection adapter by adhering closer to id…
dhh authored
691 # Sets the name of the sequence to use when generating ids to the given
692 # value, or (if the value is nil or false) to the value returned by the
7117fdb @jeremy r3616@asus: jeremy | 2005-09-26 23:09:28 -0700
jeremy authored
693 # given block. This is required for Oracle and is useful for any
694 # database which relies on sequences for primary key generation.
14ea312 @dhh Made Oracle a first-class connection adapter by adhering closer to id…
dhh authored
695 #
2076dca @jeremy r3095@asus: jeremy | 2005-11-15 22:40:51 -0800
jeremy authored
696 # If a sequence name is not explicitly set when using Oracle or Firebird,
697 # it will default to the commonly used pattern of: #{table_name}_seq
698 #
699 # If a sequence name is not explicitly set when using PostgreSQL, it
700 # will discover the sequence corresponding to your primary key for you.
14ea312 @dhh Made Oracle a first-class connection adapter by adhering closer to id…
dhh authored
701 #
702 # class Project < ActiveRecord::Base
703 # set_sequence_name "projectseq" # default would have been "project_seq"
704 # end
c9c1852 @dhh Making ActiveRecord faster [skaes]
dhh authored
705 def set_sequence_name(value = nil, &block)
14ea312 @dhh Made Oracle a first-class connection adapter by adhering closer to id…
dhh authored
706 define_attr_method :sequence_name, value, &block
707 end
708 alias :sequence_name= :set_sequence_name
709
db045db @dhh Initial
dhh authored
710 # Turns the +table_name+ back into a class name following the reverse rules of +table_name+.
711 def class_name(table_name = table_name) # :nodoc:
712 # remove any prefix and/or suffix from the table name
81737fc @jeremy r1613@asus: jeremy | 2005-07-03 07:04:53 -0700
jeremy authored
713 class_name = table_name[table_name_prefix.length..-(table_name_suffix.length + 1)].camelize
714 class_name = class_name.singularize if pluralize_table_names
715 class_name
db045db @dhh Initial
dhh authored
716 end
717
816f37a @dhh Added migration support to SQL Server adapter (please someone do the …
dhh authored
718 # Indicates whether the table associated with this class exists
719 def table_exists?
8877ab5 @tarmo Added AbstractAdapter#table_exists? and made AbstractAdapter#table im…
tarmo authored
720 connection.table_exists?(table_name)
816f37a @dhh Added migration support to SQL Server adapter (please someone do the …
dhh authored
721 end
722
db045db @dhh Initial
dhh authored
723 # Returns an array of column objects for the table associated with this class.
724 def columns
8b5f4e4 @jeremy Ruby 1.9 compat: fix warnings, shadowed block vars, and unitialized i…
jeremy authored
725 unless defined?(@columns) && @columns
c0899bc Add convenience predicate methods on Column class. In partial fullfil…
Marcel Molina authored
726 @columns = connection.columns(table_name, "#{name} Columns")
8b5f4e4 @jeremy Ruby 1.9 compat: fix warnings, shadowed block vars, and unitialized i…
jeremy authored
727 @columns.each { |column| column.primary = column.name == primary_key }
c0899bc Add convenience predicate methods on Column class. In partial fullfil…
Marcel Molina authored
728 end
729 @columns
db045db @dhh Initial
dhh authored
730 end
6e39c9e @jeremy r1614@asus: jeremy | 2005-07-03 08:01:08 -0700
jeremy authored
731
3b4450b @NZKoz Docs fix for columns_hash [bradediger]
NZKoz authored
732 # Returns a hash of column objects for the table associated with this class.
db045db @dhh Initial
dhh authored
733 def columns_hash
734 @columns_hash ||= columns.inject({}) { |hash, column| hash[column.name] = column; hash }
735 end
d0bd3b5 @jeremy Return PostgreSQL columns in the order they are declared #1374 (perlg…
jeremy authored
736
fed7d33 @dhh Fixed documentation
dhh authored
737 # Returns an array of column names as strings.
49d0f0c @dhh Speeded up eager loading a whole bunch
dhh authored
738 def column_names
d0bd3b5 @jeremy Return PostgreSQL columns in the order they are declared #1374 (perlg…
jeremy authored
739 @column_names ||= columns.map { |column| column.name }
49d0f0c @dhh Speeded up eager loading a whole bunch
dhh authored
740 end
db045db @dhh Initial
dhh authored
741
2948910 Misc doc fixes (typos/grammar/etc.). Closes #2430.
Marcel Molina authored
742 # Returns an array of column objects where the primary id, all columns ending in "_id" or "_count",
743 # and columns used for single table inheritance have been removed.
db045db @dhh Initial
dhh authored
744 def content_columns
c0899bc Add convenience predicate methods on Column class. In partial fullfil…
Marcel Molina authored
745 @content_columns ||= columns.reject { |c| c.primary || c.name =~ /(_id|_count)$/ || c.name == inheritance_column }
db045db @dhh Initial
dhh authored
746 end
747
748 # 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
749 # 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
6e39c9e @jeremy r1614@asus: jeremy | 2005-07-03 08:01:08 -0700
jeremy authored
750 # is available.
fed7d33 @dhh Fixed documentation
dhh authored
751 def column_methods_hash #:nodoc:
d0bd3b5 @jeremy Return PostgreSQL columns in the order they are declared #1374 (perlg…
jeremy authored
752 @dynamic_methods_hash ||= column_names.inject(Hash.new(false)) do |methods, attr|
3ab3a70 @jeremy Clarify semantics of ActiveRecord::Base#respond_to? Closes #2560.
jeremy authored
753 attr_name = attr.to_s
754 methods[attr.to_sym] = attr_name
755 methods["#{attr}=".to_sym] = attr_name
756 methods["#{attr}?".to_sym] = attr_name
757 methods["#{attr}_before_type_cast".to_sym] = attr_name
db045db @dhh Initial
dhh authored
758 methods
759 end
760 end
6e39c9e @jeremy r1614@asus: jeremy | 2005-07-03 08:01:08 -0700
jeremy authored
761
a293278 @lifo Merge docrails
lifo authored
762 # Resets all the cached information about columns, which will cause them
763 # to be reloaded on the next request.
764 #
765 # The most common usage pattern for this method is probably in a migration,
766 # when just after creating a table you want to populate it with some default
767 # values, eg:
768 #
769 # class CreateJobLevels < ActiveRecord::Migration
770 # def self.up
771 # create_table :job_levels do |t|
772 # t.integer :id
773 # t.string :name
774 #
775 # t.timestamps
776 # end
777 #
778 # JobLevel.reset_column_information
779 # %w{assistant executive manager director}.each do |type|
780 # JobLevel.create(:name => type)
781 # end
782 # end
783 #
784 # def self.down
785 # drop_table :job_levels
786 # end
787 # end
1314f48 @dhh Added methods for resetting the cached information on classes that yo…
dhh authored
788 def reset_column_information
e129c56 @josh Wrap up attribute method reset concerns in 'undefine_attribute_methods'
josh authored
789 undefine_attribute_methods
d2c4b3b @lifo Rename Model.engine to active_relation_engine. Cache arel_table and t…
lifo authored
790 @column_names = @columns = @columns_hash = @content_columns = @dynamic_methods_hash = @inheritance_column = nil
6e3bee6 @lifo Cache Model.arel_table
lifo authored
791 @arel_engine = @unscoped = @arel_table = nil
1314f48 @dhh Added methods for resetting the cached information on classes that yo…
dhh authored
792 end
793
4eab375 @dhh Finished polishing API docs
dhh authored
794 def reset_column_information_and_inheritable_attributes_for_all_subclasses#:nodoc:
033e0a0 @josevalim ActiveRecord and ActionPack now use the new descendants implementation.
josevalim authored
795 descendants.each { |klass| klass.reset_inheritable_attributes; klass.reset_column_information }
1314f48 @dhh Added methods for resetting the cached information on classes that yo…
dhh authored
796 end
db045db @dhh Initial
dhh authored
797
ce48b31 @spastorino Makes validates_acceptance_of to not override database fields [#4460 …
spastorino authored
798 def attribute_method?(attribute)
209ab7e @josevalim Fix failing test.
josevalim authored
799 super || (table_exists? && column_names.include?(attribute.to_s.sub(/=$/, '')))
ce48b31 @spastorino Makes validates_acceptance_of to not override database fields [#4460 …
spastorino authored
800 end
801
e714b49 @josevalim Move validator, human_name and human_attribute_name to ActiveModel, r…
josevalim authored
802 # Set the lookup ancestors for ActiveModel.
803 def lookup_ancestors #:nodoc:
ffeab4e Cleaned up ActiveRecord i18n scoping
Iain Hecker authored
804 klass = self
805 classes = [klass]
0905396 @miloops construct_finder_sql now use Arel
miloops authored
806 while klass != klass.base_class
ffeab4e Cleaned up ActiveRecord i18n scoping
Iain Hecker authored
807 classes << klass = klass.superclass
808 end
809 classes
810 rescue
811 # OPTIMIZE this rescue is to fix this test: ./test/cases/reflection_test.rb:56:in `test_human_name_for_column'
e033b5d @lifo Merge docrails
lifo authored
812 # Apparently the method base_class causes some trouble.
ffeab4e Cleaned up ActiveRecord i18n scoping
Iain Hecker authored
813 # It now works for sure.
814 [self]
815 end
816
e714b49 @josevalim Move validator, human_name and human_attribute_name to ActiveModel, r…
josevalim authored
817 # Set the i18n scope to overwrite ActiveModel.
818 def i18n_scope #:nodoc:
819 :activerecord
db045db @dhh Initial
dhh authored
820 end
6e39c9e @jeremy r1614@asus: jeremy | 2005-07-03 08:01:08 -0700
jeremy authored
821
06afb8c @jeremy Subclasses of an abstract class work with single-table inheritance. R…
jeremy authored
822 # True if this isn't a concrete subclass needing a STI type condition.
823 def descends_from_active_record?
824 if superclass.abstract_class?
825 superclass.descends_from_active_record?
826 else
827 superclass == Base || !columns_hash.include?(inheritance_column)
828 end
db045db @dhh Initial
dhh authored
829 end
830
b4ec990 @NZKoz Cache the descends_from_activerecord? call to speed up query generati…
NZKoz authored
831 def finder_needs_type_condition? #:nodoc:
832 # This is like this because benchmarking justifies the strange :false stuff
833 :true == (@finder_needs_type_condition ||= descends_from_active_record? ? :false : :true)
834 end
835
d0360a4 @jeremy Base.inspect handles Base itself and abstract_class? Don't use #<Foo…
jeremy authored
836 # Returns a string like 'Post id:integer, title:string, body:text'
52a9e50 @dhh Added ActiveRecord::Base.inspect to return a column-view like #<Post …
dhh authored
837 def inspect
d0360a4 @jeremy Base.inspect handles Base itself and abstract_class? Don't use #<Foo…
jeremy authored
838 if self == Base
839 super
840 elsif abstract_class?
841 "#{super}(abstract)"
bb94ce9 @NZKoz Let inspect on AR classes work when the table doesn't exist. Closes #…
NZKoz authored
842 elsif table_exists?
d0360a4 @jeremy Base.inspect handles Base itself and abstract_class? Don't use #<Foo…
jeremy authored
843 attr_list = columns.map { |c| "#{c.name}: #{c.type}" } * ', '
844 "#{super}(#{attr_list})"
bb94ce9 @NZKoz Let inspect on AR classes work when the table doesn't exist. Closes #…
NZKoz authored
845 else
846 "#{super}(Table doesn't exist)"
d0360a4 @jeremy Base.inspect handles Base itself and abstract_class? Don't use #<Foo…
jeremy authored
847 end
52a9e50 @dhh Added ActiveRecord::Base.inspect to return a column-view like #<Post …
dhh authored
848 end
849
b445ab9 @NZKoz Rename quote to quote_value so the name can be used in AR models. #36…
NZKoz authored
850 def quote_value(value, column = nil) #:nodoc:
b2c0ddf Add support for FrontBase (http://www.frontbase.com/) with a new adap…
Marcel Molina authored
851 connection.quote(value,column)
4940383 @dhh Fixed value quoting in all generated SQL statements, so that integers…
dhh authored
852 end
853
7143d80 Smattering of grammatical fixes to documentation. Closes #10083 [BobS…
Marcel Molina authored
854 # Used to sanitize objects before they're used in an SQL SELECT statement. Delegates to <tt>connection.quote</tt>.
4eab375 @dhh Finished polishing API docs
dhh authored
855 def sanitize(object) #:nodoc:
4940383 @dhh Fixed value quoting in all generated SQL statements, so that integers…
dhh authored
856 connection.quote(object)
db045db @dhh Initial
dhh authored
857 end
858
97849de @dhh Fixed that association proxies would fail === tests like PremiumSubsc…
dhh authored
859 # Overwrite the default class equality method to provide support for association proxies.
860 def ===(object)
861 object.is_a?(self)
7367325 @jeremy Document Active Record exceptions. Closes #10444.
jeremy authored
862 end
b840e4e Deprecated ActiveRecord::Base.threaded_connection in favor of ActiveR…
Marcel Molina authored
863
d2f4750 @jamis Add AR::Base.base_class for querying the ancestor AR::Base subclass […
jamis authored
864 # Returns the base AR subclass that this class descends from. If A
865 # extends AR::Base, A.base_class will return A. If B descends from A
866 # through some arbitrarily deep hierarchy, B.base_class will return A.
867 def base_class
868 class_of_active_record_descendant(self)
869 end
870
98dc582 @lifo Merge docrails.
lifo authored
871 # Set this to true if this is an abstract class (see <tt>abstract_class?</tt>).
def7460 @technoweenie Added Base.abstract_class? that marks which classes are not part of t…
technoweenie authored
872 attr_accessor :abstract_class
873
874 # Returns whether this class is a base AR class. If A is a base class and
875 # B descends from A, then B.base_class will return B.
876 def abstract_class?
8b5f4e4 @jeremy Ruby 1.9 compat: fix warnings, shadowed block vars, and unitialized i…
jeremy authored
877 defined?(@abstract_class) && @abstract_class == true
def7460 @technoweenie Added Base.abstract_class? that marks which classes are not part of t…
technoweenie authored
878 end
879
4f39382 @lifo Ensure that respond_to? considers dynamic finder methods. Closes #115…
lifo authored
880 def respond_to?(method_id, include_private = false)
143f5fb @joshsusser refactor dynamic finder name matching into its own class
joshsusser authored
881 if match = DynamicFinderMatch.match(method_id)
882 return true if all_attributes_exists?(match.attribute_names)
66ee589 @yaroslav Introduce dynamic scopes for ActiveRecord: you can now use class meth…
yaroslav authored
883 elsif match = DynamicScopeMatch.match(method_id)
884 return true if all_attributes_exists?(match.attribute_names)
4f39382 @lifo Ensure that respond_to? considers dynamic finder methods. Closes #115…
lifo authored
885 end
c3aa2bc @Manfred Ensure nested with_scope merges conditions inside out [#2193 state:re…
Manfred authored
886
4f39382 @lifo Ensure that respond_to? considers dynamic finder methods. Closes #115…
lifo authored
887 super
888 end
889
72483c0 @technoweenie Add ActiveRecord::Base.sti_name that checks ActiveRecord::Base#store_…
technoweenie authored
890 def sti_name
891 store_full_sti_class ? name : name.demodulize
892 end
893
cd90dcb @lifo Rename Model.active_relation to Model.unscoped
lifo authored
894 def unscoped
895 @unscoped ||= Relation.new(self, arel_table)
896 finder_needs_type_condition? ? @unscoped.where(type_condition) : @unscoped
f4a2356 @miloops Added ActiveRecord::Base#(where|join|project|group|order|take|skip) m…
miloops authored
897 end
898
6e3bee6 @lifo Cache Model.arel_table
lifo authored
899 def arel_table
900 @arel_table ||= Arel::Table.new(table_name, :engine => arel_engine)
d2c4b3b @lifo Rename Model.engine to active_relation_engine. Cache arel_table and t…
lifo authored
901 end
902
5a52523 @lifo Rename active_relation_engine -> arel_engine and active_relation_tabl…
lifo authored
903 def arel_engine
904 @arel_engine ||= begin
a115b5d @lifo Ensure using proper engine for Arel::Table
lifo authored
905 if self == ActiveRecord::Base
906 Arel::Table.engine
907 else
5a52523 @lifo Rename active_relation_engine -> arel_engine and active_relation_tabl…
lifo authored
908 connection_handler.connection_pools[name] ? Arel::Sql::Engine.new(self) : superclass.arel_engine
a115b5d @lifo Ensure using proper engine for Arel::Table
lifo authored
909 end
910 end
77c23b2 @lifo Use PredicateBuilder for sql hash sanitization
lifo authored
911 end
912
db045db @dhh Initial
dhh authored
913 private
4b4dd54 @jeremy Clashing type columns due to a sloppy join shouldn't wreck single-tab…
jeremy authored
914 # Finder methods must instantiate through this method to work with the
915 # single-table inheritance model that makes it possible to create
916 # objects of different types from the same table.
db045db @dhh Initial
dhh authored
917 def instantiate(record)
3fc2d1e @jeremy Extract class-finder method from instantiate
jeremy authored
918 object = find_sti_class(record[inheritance_column]).allocate
605bc77 @dhh Added a better exception for when a type column is used in a table wi…
dhh authored
919
6d30002 @lifo Revert "Refactoring attributes/types" [#3348 state:open]
lifo authored
920 object.instance_variable_set(:'@attributes', record)
3fc2d1e @jeremy Extract class-finder method from instantiate
jeremy authored
921 object.instance_variable_set(:'@attributes_cache', {})
115230e @tenderlove cleaning up some test warnings
tenderlove authored
922 object.instance_variable_set(:@new_record, false)
5de3698 @tenderlove cleaning up many more warnings in activerecord [#4180 state:resolved]
tenderlove authored
923 object.instance_variable_set(:@readonly, false)
924 object.instance_variable_set(:@destroyed, false)
925 object.instance_variable_set(:@marked_for_destruction, false)
8c3e46c @tenderlove clean up more warnings, remove unnecessary methods, fix eval line num…
tenderlove authored
926 object.instance_variable_set(:@previously_changed, {})
927 object.instance_variable_set(:@changed_attributes, {})
55efae2 @jeremy Performance: absorb instantiate and initialize_with_callbacks into th…
jeremy authored
928
4f37b97 @josevalim Changed ActiveRecord to use new callbacks and speed up observers by o…
josevalim authored
929 object.send(:_run_find_callbacks)
930 object.send(:_run_initialize_callbacks)
55efae2 @jeremy Performance: absorb instantiate and initialize_with_callbacks into th…
jeremy authored
931
81737fc @jeremy r1613@asus: jeremy | 2005-07-03 07:04:53 -0700
jeremy authored
932 object
db045db @dhh Initial
dhh authored
933 end
81737fc @jeremy r1613@asus: jeremy | 2005-07-03 07:04:53 -0700
jeremy authored
934
3fc2d1e @jeremy Extract class-finder method from instantiate
jeremy authored
935 def find_sti_class(type_name)
936 if type_name.blank? || !columns_hash.include?(inheritance_column)
937 self
938 else
939 begin
940 compute_type(type_name)
941 rescue NameError
942 raise SubclassNotFound,
943 "The single-table inheritance mechanism failed to locate the subclass: '#{type_name}'. " +
944 "This error is raised because the column '#{inheritance_column}' is reserved for storing the class in case of inheritance. " +
945 "Please rename this column if you didn't intend it to be used for storing the inheritance class " +
946 "or overwrite #{name}.inheritance_column to use another column for that information."
947 end
948 end
949 end
950
bed9179 @lifo Make scopes use relations under the hood
lifo authored
951 def construct_finder_arel(options = {}, scope = nil)
8ff2fb6 @lifo Make default_scope work with Relations
lifo authored
952 relation = options.is_a?(Hash) ? unscoped.apply_finder_options(options) : unscoped.merge(options)
bed9179 @lifo Make scopes use relations under the hood
lifo authored
953 relation = scope.merge(relation) if scope
6b67df7 @miloops Revert "Revert "Add readonly support for relations.""
miloops authored
954 relation
19d2ff8 @miloops Calculations now use Arel to construct the query.
miloops authored
955 end
956
2d0bc08 @lifo Make type_condition return Arel predicate and not a string condition
lifo authored
957 def type_condition
5a52523 @lifo Rename active_relation_engine -> arel_engine and active_relation_tabl…
lifo authored
958 sti_column = arel_table[inheritance_column]
d200d08 @lifo Use arel for building the STI type condition
lifo authored
959 condition = sti_column.eq(sti_name)
033e0a0 @josevalim ActiveRecord and ActionPack now use the new descendants implementation.
josevalim authored
960 descendants.each { |subclass| condition = condition.or(sti_column.eq(subclass.sti_name)) }
6e39c9e @jeremy r1614@asus: jeremy | 2005-07-03 08:01:08 -0700
jeremy authored
961
2d0bc08 @lifo Make type_condition return Arel predicate and not a string condition
lifo authored
962 condition
db045db @dhh Initial
dhh authored
963 end
964
965 # Guesses the table name, but does not decorate it with prefix and suffix information.
def7460 @technoweenie Added Base.abstract_class? that marks which classes are not part of t…
technoweenie authored
966 def undecorated_table_name(class_name = base_class.name)
3b0e1d9 @josh Prefer string core_ext inflector methods over directly accessing Infl…
josh authored
967 table_name = class_name.to_s.demodulize.underscore
968 table_name = table_name.pluralize if pluralize_table_names
6e39c9e @jeremy r1614@asus: jeremy | 2005-07-03 08:01:08 -0700
jeremy authored
969 table_name
db045db @dhh Initial
dhh authored
970 end
971
4a8c880 @fxn refactors AR::Base#reset_table_name
fxn authored
972 # Computes and returns a table name according to default conventions.
973 def compute_table_name
974 base = base_class
975 if self == base
976 # Nested classes are prefixed with singular parent table name.
977 if parent < ActiveRecord::Base && !parent.abstract_class?
978 contained = parent.table_name
979 contained = contained.singularize if parent.pluralize_table_names
980 contained << '_'
981 end
982 "#{full_table_name_prefix}#{contained}#{undecorated_table_name(name)}#{table_name_suffix}"
983 else
984 # STI subclasses always use their superclass' table.
985 base.table_name
986 end
987 end
988
39e1ac6 @lifo Merge docrails
lifo authored
989 # Enables dynamic finders like <tt>find_by_user_name(user_name)</tt> and <tt>find_by_user_name_and_password(user_name, password)</tt>
1efc8ed @lifo Fix dynamic finder docs
lifo authored
990 # that are turned into <tt>where(:user_name => user_name).first</tt> and <tt>where(:user_name => user_name, :password => :password).first</tt>
991 # respectively. Also works for <tt>all</tt> by using <tt>find_all_by_amount(50)</tt> that is turned into <tt>where(:amount => 50).all</tt>.
2a30594 @technoweenie documentation project patches, closes #7342, #7319, #7316, #7190 [jer…
technoweenie authored
992 #
39e1ac6 @lifo Merge docrails
lifo authored
993 # It's even possible to use all the additional parameters to +find+. For example, the full interface for +find_all_by_amount+
994 # is actually <tt>find_all_by_amount(amount, options)</tt>.
4a1388a Define dynamic finders as real methods after first usage. Close #9317
Tobias Lütke authored
995 #
66ee589 @yaroslav Introduce dynamic scopes for ActiveRecord: you can now use class meth…
yaroslav authored
996 # Each dynamic finder, scope or initializer/creator is also defined in the class after it is first invoked, so that future
4a1388a Define dynamic finders as real methods after first usage. Close #9317
Tobias Lütke authored
997 # attempts to use it do not run through method_missing.
8a77c4a Fixed issue where block is not called on the very first invocation of…
Ken Miller authored
998 def method_missing(method_id, *arguments, &block)
143f5fb @joshsusser refactor dynamic finder name matching into its own class
joshsusser authored
999 if match = DynamicFinderMatch.match(method_id)
1000 attribute_names = match.attribute_names
a5a82d9 @dhh Added extension capabilities to has_many and has_and_belongs_to_many …
dhh authored
1001 super unless all_attributes_exists?(attribute_names)
143f5fb @joshsusser refactor dynamic finder name matching into its own class
joshsusser authored
1002 if match.finder?
8829d6e @lifo Make Model.find_by_* and Model.find_all_by_* use relations and remove…
lifo authored
1003 options = arguments.extract_options!
bed9179 @lifo Make scopes use relations under the hood
lifo authored
1004 relation = options.any? ? construct_finder_arel(options, current_scoped_methods) : scoped
8829d6e @lifo Make Model.find_by_* and Model.find_all_by_* use relations and remove…
lifo authored
1005 relation.send :find_by_attributes, match, attribute_names, *arguments
143f5fb @joshsusser refactor dynamic finder name matching into its own class
joshsusser authored
1006 elsif match.instantiator?
85770ec @lifo Make Model.find_or_create_by_* and find_or_initialize_by_* use relati…
lifo authored
1007 scoped.send :find_or_instantiator_by_attributes, match, attribute_names, *arguments, &block
143f5fb @joshsusser refactor dynamic finder name matching into its own class
joshsusser authored
1008 end
66ee589 @yaroslav Introduce dynamic scopes for ActiveRecord: you can now use class meth…
yaroslav authored
1009 elsif match = DynamicScopeMatch.match(method_id)
1010 attribute_names = match.attribute_names
1011 super unless all_attributes_exists?(attribute_names)
1012 if match.scope?
13e00ce @spastorino fix stack trace lines on class_eval
spastorino authored
1013 self.class_eval <<-METHOD, __FILE__, __LINE__ + 1
66ee589 @yaroslav Introduce dynamic scopes for ActiveRecord: you can now use class meth…
yaroslav authored
1014 def self.#{method_id}(*args) # def self.scoped_by_user_name_and_password(*args)
1015 options = args.extract_options! # options = args.extract_options!
1016 attributes = construct_attributes_from_arguments( # attributes = construct_attributes_from_arguments(
1017 [:#{attribute_names.join(',:')}], args # [:user_name, :password], args
1018 ) # )
0905396 @miloops construct_finder_sql now use Arel
miloops authored
1019 #
66ee589 @yaroslav Introduce dynamic scopes for ActiveRecord: you can now use class meth…
yaroslav authored
1020 scoped(:conditions => attributes) # scoped(:conditions => attributes)
1021 end # end
13e00ce @spastorino fix stack trace lines on class_eval
spastorino authored
1022 METHOD
66ee589 @yaroslav Introduce dynamic scopes for ActiveRecord: you can now use class meth…
yaroslav authored
1023 send(method_id, *arguments)
1024 end
ac8fd7d @dhh Added dynamic attribute-based finders as a cleaner way of getting obj…
dhh authored
1025 else
1026 super
1027 end
1028 end
db045db @dhh Initial
dhh authored
1029
a5a82d9 @dhh Added extension capabilities to has_many and has_and_belongs_to_many …
dhh authored
1030 def construct_attributes_from_arguments(attribute_names, arguments)
1031 attributes = {}
1032 attribute_names.each_with_index { |name, idx| attributes[name] = arguments[idx] }
1033 attributes
1034 end
1035
abdf546 @jeremy Support aggregations in finder conditions. Closes #10572.
jeremy authored
1036 # Similar in purpose to +expand_hash_conditions_for_aggregates+.
1037 def expand_attribute_names_for_aggregates(attribute_names)
1038 expanded_attribute_names = []
1039 attribute_names.each do |attribute_name|
1040 unless (aggregation = reflect_on_aggregation(attribute_name.to_sym)).nil?
1041 aggregate_mapping(aggregation).each do |field_attr, aggregate_attr|
1042 expanded_attribute_names << field_attr
1043 end
1044 else
1045 expanded_attribute_names << attribute_name
1046 end
1047 end
1048 expanded_attribute_names
1049 end
1050
a5a82d9 @dhh Added extension capabilities to has_many and has_and_belongs_to_many …
dhh authored
1051 def all_attributes_exists?(attribute_names)
abdf546 @jeremy Support aggregations in finder conditions. Closes #10572.
jeremy authored
1052 attribute_names = expand_attribute_names_for_aggregates(attribute_names)
a5a82d9 @dhh Added extension capabilities to has_many and has_and_belongs_to_many …
dhh authored
1053 attribute_names.all? { |name| column_methods_hash.include?(name.to_sym) }
7367325 @jeremy Document Active Record exceptions. Closes #10444.
jeremy authored
1054 end
a5a82d9 @dhh Added extension capabilities to has_many and has_and_belongs_to_many …
dhh authored
1055
db045db @dhh Initial
dhh authored
1056 protected
1edd21b @jeremy with_scope is protected. Closes #8524.
jeremy authored
1057 # Scope parameters to method calls within the block. Takes a hash of method_name => parameters hash.
2c27e3d @lifo Some doc updates reflecting the new query API
lifo authored
1058 # method_name may be <tt>:find</tt> or <tt>:create</tt>. <tt>:find</tt> parameter is <tt>Relation</tt> while
1059 # <tt>:create</tt> parameters are an attributes hash.
1edd21b @jeremy with_scope is protected. Closes #8524.
jeremy authored
1060 #
1061 # class Article < ActiveRecord::Base
1062 # def self.create_with_scope
2c27e3d @lifo Some doc updates reflecting the new query API
lifo authored
1063 # with_scope(:find => where(:blog_id => 1), :create => { :blog_id => 1 }) do
1edd21b @jeremy with_scope is protected. Closes #8524.
jeremy authored
1064 # find(1) # => SELECT * from articles WHERE blog_id = 1 AND id = 1
1065 # a = create(1)
1066 # a.blog_id # => 1
1067 # end
1068 # end
1069 # end
1070 #
b0391d1 @dhh Docfix (closes #8674)
dhh authored
1071 # In nested scopings, all previous parameters are overwritten by the innermost rule, with the exception of
2c27e3d @lifo Some doc updates reflecting the new query API
lifo authored
1072 # <tt>where</tt>, <tt>includes</tt>, and <tt>joins</tt> operations in <tt>Relation</tt>, which are merged.
39e1ac6 @lifo Merge docrails
lifo authored
1073 #
2c27e3d @lifo Some doc updates reflecting the new query API
lifo authored
1074 # <tt>joins</tt> operations are uniqued so multiple scopes can join in the same table without table aliasing
39e1ac6 @lifo Merge docrails
lifo authored
1075 # problems. If you need to join multiple tables, but still want one of the tables to be uniqued, use the
1076 # array of strings format for your joins.
1edd21b @jeremy with_scope is protected. Closes #8524.
jeremy authored
1077 #
1078 # class Article < ActiveRecord::Base
1079 # def self.find_with_scope
2c27e3d @lifo Some doc updates reflecting the new query API
lifo authored
1080 # with_scope(:find => where(:blog_id => 1).limit(1), :create => { :blog_id => 1 }) do
1081 # with_scope(:find => limit(10)) do
1082 # all # => SELECT * from articles WHERE blog_id = 1 LIMIT 10
1edd21b @jeremy with_scope is protected. Closes #8524.
jeremy authored
1083 # end
2c27e3d @lifo Some doc updates reflecting the new query API
lifo authored
1084 # with_scope(:find => where(:author_id => 3)) do
1085 # all # => SELECT * from articles WHERE blog_id = 1 AND author_id = 3 LIMIT 1
1edd21b @jeremy with_scope is protected. Closes #8524.
jeremy authored
1086 # end
1087 # end
1088 # end
1089 # end
1090 #
7143d80 Smattering of grammatical fixes to documentation. Closes #10083 [BobS…
Marcel Molina authored
1091 # You can ignore any previous scopings by using the <tt>with_exclusive_scope</tt> method.
1edd21b @jeremy with_scope is protected. Closes #8524.
jeremy authored
1092 #
1093 # class Article < ActiveRecord::Base
1094 # def self.find_with_exclusive_scope
2c27e3d @lifo Some doc updates reflecting the new query API
lifo authored
1095 # with_scope(:find => where(:blog_id => 1).limit(1)) do
1096 # with_exclusive_scope(:find => limit(10))
1097 # all # => SELECT * from articles LIMIT 10
1edd21b @jeremy with_scope is protected. Closes #8524.
jeremy authored
1098 # end
1099 # end
1100 # end
1101 # end
a293278 @lifo Merge docrails
lifo authored
1102 #
1103 # *Note*: the +:find+ scope also has effect on update and deletion methods,
1104 # like +update_all+ and +delete_all+.
1edd21b @jeremy with_scope is protected. Closes #8524.
jeremy authored
1105 def with_scope(method_scoping = {}, action = :merge, &block)
1106 method_scoping = method_scoping.method_scoping if method_scoping.respond_to?(:method_scoping)
1107
bed9179 @lifo Make scopes use relations under the hood
lifo authored
1108 if method_scoping.is_a?(Hash)
1109 # Dup first and second level of hash (method and params).
1110 method_scoping = method_scoping.inject({}) do |hash, (method, params)|
1111 hash[method] = (params == true) ? params : params.dup
1112 hash
1113 end
1edd21b @jeremy with_scope is protected. Closes #8524.
jeremy authored
1114
bed9179 @lifo Make scopes use relations under the hood
lifo authored
1115 method_scoping.assert_valid_keys([ :find, :create ])
1116 relation = construct_finder_arel(method_scoping[:find] || {})
1117
1118 if current_scoped_methods && current_scoped_methods.create_with_value && method_scoping[:create]
1b78a3f @lifo with_scope no longer needs :reverse_merge
lifo authored
1119 scope_for_create = if action == :merge
bed9179 @lifo Make scopes use relations under the hood
lifo authored
1120 current_scoped_methods.create_with_value.merge(method_scoping[:create])
1121 else
1122 method_scoping[:create]
1edd21b @jeremy with_scope is protected. Closes #8524.
jeremy authored
1123 end
bed9179 @lifo Make scopes use relations under the hood
lifo authored
1124
1125 relation = relation.create_with(scope_for_create)
1126 else
1127 scope_for_create = method_scoping[:create]
1128 scope_for_create ||= current_scoped_methods.create_with_value if current_scoped_methods
1129 relation = relation.create_with(scope_for_create) if scope_for_create
1130 end
1131
1132 method_scoping = relation
1133 end
1134
1b78a3f @lifo with_scope no longer needs :reverse_merge
lifo authored
1135 method_scoping = current_scoped_methods.merge(method_scoping) if current_scoped_methods && action == :merge
1edd21b @jeremy with_scope is protected. Closes #8524.
jeremy authored
1136
1137 self.scoped_methods << method_scoping