Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100755 1376 lines (1217 sloc) 63.697 kB
db045db @dhh Initial
dhh authored
1 require 'yaml'
abc895b @dhh Added new Base.find API and deprecated find_all, find_first. Added pr…
dhh authored
2 require 'active_record/deprecated_finders'
db045db @dhh Initial
dhh authored
3
4 module ActiveRecord #:nodoc:
5 class ActiveRecordError < StandardError #:nodoc:
6 end
605bc77 @dhh Added a better exception for when a type column is used in a table wi…
dhh authored
7 class SubclassNotFound < ActiveRecordError #:nodoc:
8 end
db045db @dhh Initial
dhh authored
9 class AssociationTypeMismatch < ActiveRecordError #:nodoc:
10 end
11 class SerializationTypeMismatch < ActiveRecordError #:nodoc:
12 end
13 class AdapterNotSpecified < ActiveRecordError # :nodoc:
14 end
15 class AdapterNotFound < ActiveRecordError # :nodoc:
16 end
17 class ConnectionNotEstablished < ActiveRecordError #:nodoc:
18 end
19 class ConnectionFailed < ActiveRecordError #:nodoc:
20 end
21 class RecordNotFound < ActiveRecordError #:nodoc:
22 end
23 class StatementInvalid < ActiveRecordError #:nodoc:
24 end
554597d @dhh Added named bind-style variable interpolation #281 [Michael Koziarski]
dhh authored
25 class PreparedStatementInvalid < ActiveRecordError #:nodoc:
26 end
fbf9281 @dhh Added automated optimistic locking if the field lock_version is prese…
dhh authored
27 class StaleObjectError < ActiveRecordError #:nodoc:
28 end
db045db @dhh Initial
dhh authored
29
d2fefbe @dhh Added MultiparameterAssignmentErrors and AttributeAssignmentError exc…
dhh authored
30 class AttributeAssignmentError < ActiveRecordError #:nodoc:
31 attr_reader :exception, :attribute
32 def initialize(message, exception, attribute)
33 @exception = exception
34 @attribute = attribute
35 @message = message
36 end
37 end
38
39 class MultiparameterAssignmentErrors < ActiveRecordError #:nodoc:
40 attr_reader :errors
41 def initialize(errors)
42 @errors = errors
43 end
44 end
45
db045db @dhh Initial
dhh authored
46 # Active Record objects doesn't specify their attributes directly, but rather infer them from the table definition with
47 # which they're linked. Adding, removing, and changing attributes and their type is done directly in the database. Any change
48 # is instantly reflected in the Active Record objects. The mapping that binds a given Active Record class to a certain
49 # database table will happen automatically in most common cases, but can be overwritten for the uncommon ones.
50 #
51 # See the mapping rules in table_name and the full example in link:files/README.html for more insight.
52 #
53 # == Creation
54 #
55 # Active Records accepts constructor parameters either in a hash or as a block. The hash method is especially useful when
56 # you're receiving the data from somewhere else, like a HTTP request. It works like this:
57 #
58 # user = User.new("name" => "David", "occupation" => "Code Artist")
59 # user.name # => "David"
60 #
61 # You can also use block initialization:
62 #
63 # user = User.new do |u|
64 # u.name = "David"
65 # u.occupation = "Code Artist"
66 # end
67 #
68 # And of course you can just create a bare object and specify the attributes after the fact:
69 #
70 # user = User.new
71 # user.name = "David"
72 # user.occupation = "Code Artist"
73 #
74 # == Conditions
75 #
76 # Conditions can either be specified as a string or an array representing the WHERE-part of an SQL statement.
77 # The array form is to be used when the condition input is tainted and requires sanitization. The string form can
78 # be used for statements that doesn't involve tainted data. Examples:
79 #
80 # User < ActiveRecord::Base
81 # def self.authenticate_unsafely(user_name, password)
82 # find_first("user_name = '#{user_name}' AND password = '#{password}'")
83 # end
84 #
85 # def self.authenticate_safely(user_name, password)
3e7d191 @dhh Added bind-style variable interpolation for the condition arrays that…
dhh authored
86 # find_first([ "user_name = ? AND password = ?", user_name, password ])
db045db @dhh Initial
dhh authored
87 # end
88 # end
89 #
2575b3b @dhh Added extra words of caution for guarding against SQL-injection attacks
dhh authored
90 # The <tt>authenticate_unsafely</tt> method inserts the parameters directly into the query and is thus susceptible to SQL-injection
91 # attacks if the <tt>user_name</tt> and +password+ parameters come directly from a HTTP request. The <tt>authenticate_safely</tt> method,
92 # on the other hand, will sanitize the <tt>user_name</tt> and +password+ before inserting them in the query, which will ensure that
db045db @dhh Initial
dhh authored
93 # 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
94 #
5cd38ca @dhh Added documentation about named bind variables
dhh authored
95 # When using multiple parameters in the conditions, it can easily become hard to read exactly what the fourth or fifth
96 # question mark is supposed to represent. In those cases, you can resort to named bind variables instead. That's done by replacing
97 # the question marks with symbols and supplying a hash with values for the matching symbol keys:
98 #
99 # Company.find_first([
100 # "id = :id AND name = :name AND division = :division AND created_at > :accounting_date",
101 # { :id => 3, :name => "37signals", :division => "First", :accounting_date => '2005-01-01' }
102 # ])
103 #
db045db @dhh Initial
dhh authored
104 # == Overwriting default accessors
105 #
106 # All column values are automatically available through basic accessors on the Active Record object, but some times you
107 # want to specialize this behavior. This can be done by either by overwriting the default accessors (using the same
108 # name as the attribute) calling read_attribute(attr_name) and write_attribute(attr_name, value) to actually change things.
109 # Example:
110 #
111 # class Song < ActiveRecord::Base
112 # # Uses an integer of seconds to hold the length of the song
113 #
114 # def length=(minutes)
115 # write_attribute("length", minutes * 60)
116 # end
117 #
118 # def length
119 # read_attribute("length") / 60
120 # end
121 # end
122 #
4eab375 @dhh Finished polishing API docs
dhh authored
123 # == Accessing attributes before they have been type casted
124 #
125 # Some times you want to be able to read the raw attribute data without having the column-determined type cast run its course first.
126 # That can be done by using the <attribute>_before_type_cast accessors that all attributes have. For example, if your Account model
127 # has a balance attribute, you can call account.balance_before_type_cast or account.id_before_type_cast.
128 #
129 # This is especially useful in validation situations where the user might supply a string for an integer field and you want to display
130 # the original string back in an error message. Accessing the attribute normally would type cast the string to 0, which isn't what you
131 # want.
132 #
ac8fd7d @dhh Added dynamic attribute-based finders as a cleaner way of getting obj…
dhh authored
133 # == Dynamic attribute-based finders
134 #
135 # Dynamic attribute-based finders are a cleaner way of getting objects by simple queries without turning to SQL. They work by
136 # appending the name of an attribute to <tt>find_by_</tt>, so you get finders like <tt>Person.find_by_user_name, Payment.find_by_transaction_id</tt>.
137 # So instead of writing <tt>Person.find_first(["user_name = ?", user_name])</tt>, you just do <tt>Person.find_by_user_name(user_name)</tt>.
138 #
139 # It's also possible to use multiple attributes in the same find by separating them with "_and_", so you get finders like
140 # <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
141 # <tt>Person.find_first(["user_name = ? AND password = ?", user_name, password])</tt>, you just do
142 # <tt>Person.find_by_user_name_and_password(user_name, password)</tt>.
569f2ea @dhh Added the possibility of specifying the remaining options for find_fi…
dhh authored
143 #
144 # It's even possible to use all the additional parameters to find_first and find_all. For example, the full interface for Payment.find_all_by_amount
145 # is actually Payment.find_all_by_amount(amount, orderings = nil, limit = nil, joins = nil). And the full interface to Person.find_by_user_name is
146 # actually Person.find_by_user_name(user_name, orderings = nil)
959f362 @dhh Added find_all style to the new dynamic finders
dhh authored
147 #
098fa94 @dhh Fixed documentation snafus #575, #576, #577, #585
dhh authored
148 # == Saving arrays, hashes, and other non-mappable objects in text columns
db045db @dhh Initial
dhh authored
149 #
150 # 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+.
151 # This makes it possible to store arrays, hashes, and other non-mappeable objects without doing any additional work. Example:
152 #
153 # class User < ActiveRecord::Base
154 # serialize :preferences
155 # end
156 #
157 # user = User.create("preferences" => { "background" => "black", "display" => large })
158 # User.find(user.id).preferences # => { "background" => "black", "display" => large }
159 #
66f44e6 @dhh Updated documentation for serialize
dhh authored
160 # You can also specify an class option as the second parameter that'll raise an exception if a serialized object is retrieved as a
db045db @dhh Initial
dhh authored
161 # descendent of a class not in the hierarchy. Example:
162 #
163 # class User < ActiveRecord::Base
66f44e6 @dhh Updated documentation for serialize
dhh authored
164 # serialize :preferences, Hash
db045db @dhh Initial
dhh authored
165 # end
166 #
167 # user = User.create("preferences" => %w( one two three ))
168 # User.find(user.id).preferences # raises SerializationTypeMismatch
169 #
170 # == Single table inheritance
171 #
172 # Active Record allows inheritance by storing the name of the class in a column that by default is called "type" (can be changed
173 # by overwriting <tt>Base.inheritance_column</tt>). This means that an inheritance looking like this:
174 #
175 # class Company < ActiveRecord::Base; end
176 # class Firm < Company; end
177 # class Client < Company; end
178 # class PriorityClient < Client; end
179 #
e9426d2 @dhh Optimized the SQL used to generate has_and_belongs_to_many queries by…
dhh authored
180 # When you do Firm.create("name" => "37signals"), this record will be saved in the companies table with type = "Firm". You can then
db045db @dhh Initial
dhh authored
181 # fetch this row again using Company.find_first "name = '37signals'" and it will return a Firm object.
182 #
f033833 @dhh Improving documentation...
dhh authored
183 # 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
184 # like normal subclasses with no special magic for differentiating between them or reloading the right type with find.
185 #
db045db @dhh Initial
dhh authored
186 # Note, all the attributes for all the cases are kept in the same table. Read more:
187 # http://www.martinfowler.com/eaaCatalog/singleTableInheritance.html
188 #
189 # == Connection to multiple databases in different models
190 #
191 # Connections are usually created through ActiveRecord::Base.establish_connection and retrieved by ActiveRecord::Base.connection.
192 # All classes inheriting from ActiveRecord::Base will use this connection. But you can also set a class-specific connection.
193 # For example, if Course is a ActiveRecord::Base, but resides in a different database you can just say Course.establish_connection
194 # and Course *and all its subclasses* will use this connection instead.
195 #
196 # This feature is implemented by keeping a connection pool in ActiveRecord::Base that is a Hash indexed by the class. If a connection is
197 # requested, the retrieve_connection method will go up the class-hierarchy until a connection is found in the connection pool.
198 #
199 # == Exceptions
200 #
201 # * +ActiveRecordError+ -- generic error class and superclass of all other errors raised by Active Record
202 # * +AdapterNotSpecified+ -- the configuration hash used in <tt>establish_connection</tt> didn't include a
203 # <tt>:adapter</tt> key.
098fa94 @dhh Fixed documentation snafus #575, #576, #577, #585
dhh authored
204 # * +AdapterNotSpecified+ -- the <tt>:adapter</tt> key used in <tt>establish_connection</tt> specified an non-existent adapter
db045db @dhh Initial
dhh authored
205 # (or a bad spelling of an existing one).
206 # * +AssociationTypeMismatch+ -- the object assigned to the association wasn't of the type specified in the association definition.
66f44e6 @dhh Updated documentation for serialize
dhh authored
207 # * +SerializationTypeMismatch+ -- the object serialized wasn't of the class specified as the second parameter.
db045db @dhh Initial
dhh authored
208 # * +ConnectionNotEstablished+ -- no connection has been established. Use <tt>establish_connection</tt> before querying.
209 # * +RecordNotFound+ -- no record responded to the find* method.
210 # Either the row with the given ID doesn't exist or the row didn't meet the additional restrictions.
211 # * +StatementInvalid+ -- the database server rejected the SQL statement. The precise error is added in the message.
212 # Either the record with the given ID doesn't exist or the record didn't meet the additional restrictions.
d2fefbe @dhh Added MultiparameterAssignmentErrors and AttributeAssignmentError exc…
dhh authored
213 # * +MultiparameterAssignmentErrors+ -- collection of errors that occurred during a mass assignment using the
214 # +attributes=+ method. The +errors+ property of this exception contains an array of +AttributeAssignmentError+
215 # objects that should be inspected to determine which attributes triggered the errors.
216 # * +AttributeAssignmentError+ -- an error occurred while doing a mass assignment through the +attributes=+ method.
217 # You can inspect the +attribute+ property of the exception object to determine which attribute triggered the error.
db045db @dhh Initial
dhh authored
218 # *Note*: The attributes listed are class-level attributes (accessible from both the class and instance level).
219 # So it's possible to assign a logger to the class through Base.logger= which will then be used by all
220 # instances in the current object space.
221 class Base
222 include ClassInheritableAttributes
223
224 # Accepts a logger conforming to the interface of Log4r or the default Ruby 1.8+ Logger class, which is then passed
225 # on to any new database connections made and which can be retrieved on both a class and instance level by calling +logger+.
226 cattr_accessor :logger
227
228 # Returns the connection currently associated with the class. This can
229 # also be used to "borrow" the connection to do database work unrelated
230 # to any of the specific Active Records.
231 def self.connection
232 retrieve_connection
233 end
234
235 # Returns the connection currently associated with the class. This can
236 # also be used to "borrow" the connection to do database work that isn't
237 # easily done without going straight to SQL.
238 def connection
239 self.class.connection
240 end
241
242 def self.inherited(child) #:nodoc:
243 @@subclasses[self] ||= []
244 @@subclasses[self] << child
245 super
246 end
247
248 @@subclasses = {}
8e1f1ee @dhh Moved require_association to associations.rb and added methods for re…
dhh authored
249
db045db @dhh Initial
dhh authored
250 cattr_accessor :configurations
251 @@primary_key_prefix_type = {}
252
253 # Accessor for the prefix type that will be prepended to every primary key column name. The options are :table_name and
254 # :table_name_with_underscore. If the first is specified, the Product class will look for "productid" instead of "id" as
255 # the primary column. If the latter is specified, the Product class will look for "product_id" instead of "id". Remember
256 # that this is a global setting for all Active Records.
257 cattr_accessor :primary_key_prefix_type
258 @@primary_key_prefix_type = nil
259
260 # 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
261 # 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
262 # for tables in a shared database. By default, the prefix is the empty string.
263 cattr_accessor :table_name_prefix
264 @@table_name_prefix = ""
265
266 # Works like +table_name_prefix+, but appends instead of prepends (set to "_basecamp" gives "projects_basecamp",
267 # "people_basecamp"). By default, the suffix is the empty string.
268 cattr_accessor :table_name_suffix
269 @@table_name_suffix = ""
270
271 # Indicate whether or not table names should be the pluralized versions of the corresponding class names.
272 # If true, this the default table name for a +Product+ class will be +products+. If false, it would just be +product+.
273 # See table_name for the full rules on table/class naming. This is true, by default.
274 cattr_accessor :pluralize_table_names
275 @@pluralize_table_names = true
276
911614d @dhh Added ActiveRecord::Base.colorize_logging to control whether to use c…
dhh authored
277 # Determines whether or not to use ANSI codes to colorize the logging statements committed by the connection adapter. These colors
278 # makes it much easier to overview things during debugging (when used through a reader like +tail+ and on a black background), but
279 # may complicate matters if you use software like syslog. This is true, by default.
280 cattr_accessor :colorize_logging
281 @@colorize_logging = true
282
60de8c1 @dhh Added Base.default_timezone accessor that determines whether to use T…
dhh authored
283 # Determines whether to use Time.local (using :local) or Time.utc (using :utc) when pulling dates and times from the database.
284 # This is set to :local by default.
285 cattr_accessor :default_timezone
286 @@default_timezone = :local
287
db045db @dhh Initial
dhh authored
288 class << self # Class methods
289 # Returns objects for the records responding to either a specific id (1), a list of ids (1, 5, 6) or an array of ids.
290 # If only one ID is specified, that object is returned directly. If more than one ID is specified, an array is returned.
291 # Examples:
292 # Person.find(1) # returns the object for ID = 1
293 # Person.find(1, 2, 6) # returns an array for objects with IDs in (1, 2, 6)
294 # Person.find([7, 17]) # returns an array for objects with IDs in (7, 17)
57ed93e @dhh Fixed that Base#find will return an array if given an array -- regard…
dhh authored
295 # Person.find([1]) # returns an array for objects the object with ID = 1
6bd672e @dhh Added that Base#find takes an optional options hash, including :condi…
dhh authored
296 #
297 # The last argument may be a Hash of find options. Currently, +conditions+ is the only option, behaving the same as with +find_all+.
569f2ea @dhh Added the possibility of specifying the remaining options for find_fi…
dhh authored
298 # Person.find(1, :conditions => "associate_id = 5"
299 # Person.find(1, 2, 6, :conditions => "status = 'active'"
300 # Person.find([7, 17], :conditions => ["sanitize_me = ?", "bare'quote"]
5cd38ca @dhh Added documentation about named bind variables
dhh authored
301 # Person.find(25, :conditions => ["name = :name AND age = :age", { :name => "Mary", :age => 22 }]
6bd672e @dhh Added that Base#find takes an optional options hash, including :condi…
dhh authored
302 #
db045db @dhh Initial
dhh authored
303 # +RecordNotFound+ is raised if no record can be found.
6bd672e @dhh Added that Base#find takes an optional options hash, including :condi…
dhh authored
304 def find(*args)
305 options = extract_options_from_args!(args)
db045db @dhh Initial
dhh authored
306
abc895b @dhh Added new Base.find API and deprecated find_all, find_first. Added pr…
dhh authored
307 case args.first
308 when :first
309 find(:all, options.merge({ :limit => 1 })).first
310 when :all
311 options[:include] ? find_with_associations(options) : find_by_sql(construct_finder_sql(options))
db045db @dhh Initial
dhh authored
312 else
abc895b @dhh Added new Base.find API and deprecated find_all, find_first. Added pr…
dhh authored
313 expects_array = args.first.kind_of?(Array)
314 conditions = " AND #{sanitize_sql(options[:conditions])}" if options[:conditions]
315
316 ids = args.flatten.compact.uniq
317 case ids.size
318 when 0
319 raise RecordNotFound, "Couldn't find #{name} without an ID#{conditions}"
320 when 1
9e799e7 @dhh Prefix primary key with table name so it works as part of a joined fetch
dhh authored
321 if result = find(:first, options.merge({ :conditions => "#{table_name}.#{primary_key} = #{sanitize(ids.first)}#{conditions}" }))
abc895b @dhh Added new Base.find API and deprecated find_all, find_first. Added pr…
dhh authored
322 return expects_array ? [ result ] : result
323 else
324 raise RecordNotFound, "Couldn't find #{name} with ID=#{ids.first}#{conditions}"
325 end
326 else
327 # Find multiple ids
328 ids_list = ids.map { |id| sanitize(id) }.join(',')
9e799e7 @dhh Prefix primary key with table name so it works as part of a joined fetch
dhh authored
329 result = find(:all, options.merge({ :conditions => "#{table_name}.#{primary_key} IN (#{ids_list})#{conditions}", :order => primary_key }))
abc895b @dhh Added new Base.find API and deprecated find_all, find_first. Added pr…
dhh authored
330 if result.size == ids.size
331 return result
332 else
333 raise RecordNotFound, "Couldn't find all #{name.pluralize} with IDs (#{ids_list})#{conditions}"
334 end
6bd672e @dhh Added that Base#find takes an optional options hash, including :condi…
dhh authored
335 end
db045db @dhh Initial
dhh authored
336 end
337 end
338
a775cb1 @dhh Added the option for sanitizing find_by_sql and the offset parts in r…
dhh authored
339 # Works like find_all, but requires a complete SQL string. Examples:
db045db @dhh Initial
dhh authored
340 # Post.find_by_sql "SELECT p.*, c.author FROM posts p, comments c WHERE p.id = c.post_id"
a775cb1 @dhh Added the option for sanitizing find_by_sql and the offset parts in r…
dhh authored
341 # Post.find_by_sql ["SELECT * FROM posts WHERE author = ? AND created > ?", author_id, start_date]
db045db @dhh Initial
dhh authored
342 def find_by_sql(sql)
6bd672e @dhh Added that Base#find takes an optional options hash, including :condi…
dhh authored
343 connection.select_all(sanitize_sql(sql), "#{name} Load").inject([]) { |objects, record| objects << instantiate(record) }
db045db @dhh Initial
dhh authored
344 end
345
abc895b @dhh Added new Base.find API and deprecated find_all, find_first. Added pr…
dhh authored
346 # Returns true if the given +id+ represents the primary key of a record in the database, false otherwise.
347 # Example:
348 # Person.exists?(5)
349 def exists?(id)
350 !find_first("#{primary_key} = #{sanitize(id)}").nil? rescue false
db045db @dhh Initial
dhh authored
351 end
abc895b @dhh Added new Base.find API and deprecated find_all, find_first. Added pr…
dhh authored
352
db045db @dhh Initial
dhh authored
353 # Creates an object, instantly saves it as a record (if the validation permits it), and returns it. If the save
354 # fail under validations, the unsaved object is still returned.
355 def create(attributes = nil)
efa81da @dhh Added the option of supplying an array of ids and attributes to Base#…
dhh authored
356 if attributes.is_a?(Array)
357 attributes.collect { |attr| create(attr) }
358 else
359 object = new(attributes)
360 object.save
361 object
362 end
db045db @dhh Initial
dhh authored
363 end
364
365 # Finds the record from the passed +id+, instantly saves it with the passed +attributes+ (if the validation permits it),
366 # and returns it. If the save fail under validations, the unsaved object is still returned.
367 def update(id, attributes)
efa81da @dhh Added the option of supplying an array of ids and attributes to Base#…
dhh authored
368 if id.is_a?(Array)
369 idx = -1
370 id.collect { |id| idx += 1; update(id, attributes[idx]) }
371 else
372 object = find(id)
373 object.update_attributes(attributes)
374 object
375 end
db045db @dhh Initial
dhh authored
376 end
377
efa81da @dhh Added the option of supplying an array of ids and attributes to Base#…
dhh authored
378 # Deletes the record with the given +id+ without instantiating an object first. If an array of ids is provided, all of them
379 # are deleted.
648b8fd @dhh Added Base.destroy and Base.delete to remove records without holding …
dhh authored
380 def delete(id)
efa81da @dhh Added the option of supplying an array of ids and attributes to Base#…
dhh authored
381 delete_all([ "#{primary_key} IN (?)", id ])
648b8fd @dhh Added Base.destroy and Base.delete to remove records without holding …
dhh authored
382 end
383
384 # Destroys the record with the given +id+ by instantiating the object and calling #destroy (all the callbacks are the triggered).
efa81da @dhh Added the option of supplying an array of ids and attributes to Base#…
dhh authored
385 # If an array of ids is provided, all of them are destroyed.
648b8fd @dhh Added Base.destroy and Base.delete to remove records without holding …
dhh authored
386 def destroy(id)
efa81da @dhh Added the option of supplying an array of ids and attributes to Base#…
dhh authored
387 id.is_a?(Array) ? id.each { |id| destroy(id) } : find(id).destroy
648b8fd @dhh Added Base.destroy and Base.delete to remove records without holding …
dhh authored
388 end
389
69cb942 @dhh Changed the interface on AbstractAdapter to require that adapters ret…
dhh authored
390 # Updates all records with the SET-part of an SQL update statement in +updates+ and returns an integer with the number of rows updates.
391 # A subset of the records can be selected by specifying +conditions+. Example:
db045db @dhh Initial
dhh authored
392 # Billing.update_all "category = 'authorized', approved = 1", "author = 'David'"
393 def update_all(updates, conditions = nil)
566a369 @dhh Added that update_all calls sanitize_sql on its updates argument, so …
dhh authored
394 sql = "UPDATE #{table_name} SET #{sanitize_sql(updates)} "
db045db @dhh Initial
dhh authored
395 add_conditions!(sql, conditions)
69cb942 @dhh Changed the interface on AbstractAdapter to require that adapters ret…
dhh authored
396 return connection.update(sql, "#{name} Update")
db045db @dhh Initial
dhh authored
397 end
0d2db8a @dhh Added Base.update_collection that can update an array of id/attribute…
dhh authored
398
db045db @dhh Initial
dhh authored
399 # Destroys the objects for all the records that matches the +condition+ by instantiating each object and calling
400 # the destroy method. Example:
401 # Person.destroy_all "last_login < '2004-04-04'"
402 def destroy_all(conditions = nil)
403 find_all(conditions).each { |object| object.destroy }
404 end
405
406 # Deletes all the records that matches the +condition+ without instantiating the objects first (and hence not
407 # calling the destroy method). Example:
408 # Post.destroy_all "person_id = 5 AND (category = 'Something' OR category = 'Else')"
409 def delete_all(conditions = nil)
410 sql = "DELETE FROM #{table_name} "
411 add_conditions!(sql, conditions)
412 connection.delete(sql, "#{name} Delete all")
413 end
414
415 # Returns the number of records that meets the +conditions+. Zero is returned if no records match. Example:
416 # Product.count "sales > 1"
06a6133 @dhh Added a join parameter as the third argument to Base.find_first and a…
dhh authored
417 def count(conditions = nil, joins = nil)
ad24c6d @dhh Fixed pagination to work with joins #1034 [scott@sigkill.org]
dhh authored
418 tbl_var_name = joins ? table_name[0,1].downcase : ""
06a6133 @dhh Added a join parameter as the third argument to Base.find_first and a…
dhh authored
419 sql = "SELECT COUNT(*) FROM #{table_name} #{tbl_var_name} "
420 sql << ", #{joins} " if joins
db045db @dhh Initial
dhh authored
421 add_conditions!(sql, conditions)
422 count_by_sql(sql)
423 end
424
425 # Returns the result of an SQL statement that should only include a COUNT(*) in the SELECT part.
426 # Product.count "SELECT COUNT(*) FROM sales s, customers c WHERE s.customer_id = c.id"
427 def count_by_sql(sql)
a775cb1 @dhh Added the option for sanitizing find_by_sql and the offset parts in r…
dhh authored
428 sql = sanitize_conditions(sql)
7b37c77 @dhh Fixed counter_sql when no records exist in database for PostgreSQL (w…
dhh authored
429 rows = connection.select_one(sql, "#{name} Count")
430
431 if rows.nil?
432 return 0
433 else
434 count = rows.values.first
435 return count ? count.to_i : 0
436 end
db045db @dhh Initial
dhh authored
437 end
438
439 # Increments the specified counter by one. So <tt>DiscussionBoard.increment_counter("post_count",
440 # discussion_board_id)</tt> would increment the "post_count" counter on the board responding to discussion_board_id.
441 # This is used for caching aggregate values, so that they doesn't need to be computed every time. Especially important
442 # for looping over a collection where each element require a number of aggregate values. Like the DiscussionBoard
443 # that needs to list both the number of posts and comments.
444 def increment_counter(counter_name, id)
4940383 @dhh Fixed value quoting in all generated SQL statements, so that integers…
dhh authored
445 update_all "#{counter_name} = #{counter_name} + 1", "#{primary_key} = #{quote(id)}"
db045db @dhh Initial
dhh authored
446 end
447
448 # Works like increment_counter, but decrements instead.
449 def decrement_counter(counter_name, id)
4940383 @dhh Fixed value quoting in all generated SQL statements, so that integers…
dhh authored
450 update_all "#{counter_name} = #{counter_name} - 1", "#{primary_key} = #{quote(id)}"
db045db @dhh Initial
dhh authored
451 end
452
453 # Attributes named in this macro are protected from mass-assignment, such as <tt>new(attributes)</tt> and
454 # <tt>attributes=(attributes)</tt>. Their assignment will simply be ignored. Instead, you can use the direct writer
455 # methods to do assignment. This is meant to protect sensitive attributes to be overwritten by URL/form hackers. Example:
456 #
457 # class Customer < ActiveRecord::Base
458 # attr_protected :credit_rating
459 # end
460 #
461 # customer = Customer.new("name" => David, "credit_rating" => "Excellent")
462 # customer.credit_rating # => nil
463 # customer.attributes = { "description" => "Jolly fellow", "credit_rating" => "Superb" }
464 # customer.credit_rating # => nil
465 #
466 # customer.credit_rating = "Average"
467 # customer.credit_rating # => "Average"
468 def attr_protected(*attributes)
469 write_inheritable_array("attr_protected", attributes)
470 end
471
098fa94 @dhh Fixed documentation snafus #575, #576, #577, #585
dhh authored
472 # Returns an array of all the attributes that have been protected from mass-assignment.
db045db @dhh Initial
dhh authored
473 def protected_attributes # :nodoc:
474 read_inheritable_attribute("attr_protected")
475 end
476
477 # If this macro is used, only those attributed named in it will be accessible for mass-assignment, such as
478 # <tt>new(attributes)</tt> and <tt>attributes=(attributes)</tt>. This is the more conservative choice for mass-assignment
479 # protection. If you'd rather start from an all-open default and restrict attributes as needed, have a look at
480 # attr_protected.
481 def attr_accessible(*attributes)
482 write_inheritable_array("attr_accessible", attributes)
483 end
484
098fa94 @dhh Fixed documentation snafus #575, #576, #577, #585
dhh authored
485 # Returns an array of all the attributes that have been made accessible to mass-assignment.
db045db @dhh Initial
dhh authored
486 def accessible_attributes # :nodoc:
487 read_inheritable_attribute("attr_accessible")
488 end
489
490 # Specifies that the attribute by the name of +attr_name+ should be serialized before saving to the database and unserialized
491 # after loading from the database. The serialization is done through YAML. If +class_name+ is specified, the serialized
098fa94 @dhh Fixed documentation snafus #575, #576, #577, #585
dhh authored
492 # object must be of that class on retrieval or +SerializationTypeMismatch+ will be raised.
db045db @dhh Initial
dhh authored
493 def serialize(attr_name, class_name = Object)
494 write_inheritable_attribute("attr_serialized", serialized_attributes.update(attr_name.to_s => class_name))
495 end
496
497 # Returns a hash of all the attributes that have been specified for serialization as keys and their class restriction as values.
498 def serialized_attributes
499 read_inheritable_attribute("attr_serialized") || { }
500 end
501
502 # Guesses the table name (in forced lower-case) based on the name of the class in the inheritance hierarchy descending
503 # directly from ActiveRecord. So if the hierarchy looks like: Reply < Message < ActiveRecord, then Message is used
4eab375 @dhh Finished polishing API docs
dhh authored
504 # to guess the table name from even when called on Reply. The rules used to do the guess are handled by the Inflector class
505 # in Active Support, which knows almost all common English inflections (report a bug if your inflection isn't covered).
db045db @dhh Initial
dhh authored
506 #
507 # Additionally, the class-level table_name_prefix is prepended to the table_name and the table_name_suffix is appended.
508 # So if you have "myapp_" as a prefix, the table name guess for an Account class becomes "myapp_accounts".
509 #
510 # You can also overwrite this class method to allow for unguessable links, such as a Mouse class with a link to a
511 # "mice" table. Example:
512 #
513 # class Mouse < ActiveRecord::Base
9982578 @dhh Doc fix #805
dhh authored
514 # set_table_name "mice"
db045db @dhh Initial
dhh authored
515 # end
dcc4868 @dhh Fixed that Base.table_name would expect a parameter when used in has_…
dhh authored
516 def table_name
517 table_name_prefix + undecorated_table_name(class_name_of_active_record_descendant(self)) + table_name_suffix
db045db @dhh Initial
dhh authored
518 end
519
098fa94 @dhh Fixed documentation snafus #575, #576, #577, #585
dhh authored
520 # Defines the primary key field -- can be overridden in subclasses. Overwriting will negate any effect of the
db045db @dhh Initial
dhh authored
521 # primary_key_prefix_type setting, though.
522 def primary_key
523 case primary_key_prefix_type
524 when :table_name
525 Inflector.foreign_key(class_name_of_active_record_descendant(self), false)
526 when :table_name_with_underscore
527 Inflector.foreign_key(class_name_of_active_record_descendant(self))
528 else
529 "id"
530 end
531 end
532
533 # Defines the column name for use with single table inheritance -- can be overridden in subclasses.
534 def inheritance_column
535 "type"
536 end
537
1aa82b3 @dhh Added keyword-style approach to defining the custom relational bindin…
dhh authored
538 # Sets the table name to use to the given value, or (if the value
4eab375 @dhh Finished polishing API docs
dhh authored
539 # 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
540 #
541 # Example:
542 #
543 # class Project < ActiveRecord::Base
544 # set_table_name "project"
545 # end
546 def set_table_name( value=nil, &block )
547 define_attr_method :table_name, value, &block
548 end
549 alias :table_name= :set_table_name
550
551 # Sets the name of the primary key column to use to the given value,
552 # or (if the value is nil or false) to the value returned by the given
4eab375 @dhh Finished polishing API docs
dhh authored
553 # block.
1aa82b3 @dhh Added keyword-style approach to defining the custom relational bindin…
dhh authored
554 #
555 # Example:
556 #
557 # class Project < ActiveRecord::Base
558 # set_primary_key "sysid"
559 # end
560 def set_primary_key( value=nil, &block )
561 define_attr_method :primary_key, value, &block
562 end
563 alias :primary_key= :set_primary_key
564
565 # Sets the name of the inheritance column to use to the given value,
566 # or (if the value # is nil or false) to the value returned by the
4eab375 @dhh Finished polishing API docs
dhh authored
567 # given block.
1aa82b3 @dhh Added keyword-style approach to defining the custom relational bindin…
dhh authored
568 #
569 # Example:
570 #
571 # class Project < ActiveRecord::Base
572 # set_inheritance_column do
573 # original_inheritance_column + "_id"
574 # end
575 # end
576 def set_inheritance_column( value=nil, &block )
577 define_attr_method :inheritance_column, value, &block
578 end
579 alias :inheritance_column= :set_inheritance_column
580
db045db @dhh Initial
dhh authored
581 # Turns the +table_name+ back into a class name following the reverse rules of +table_name+.
582 def class_name(table_name = table_name) # :nodoc:
583 # remove any prefix and/or suffix from the table name
584 class_name = Inflector.camelize(table_name[table_name_prefix.length..-(table_name_suffix.length + 1)])
585 class_name = Inflector.singularize(class_name) if pluralize_table_names
586 return class_name
587 end
588
589 # Returns an array of column objects for the table associated with this class.
590 def columns
591 @columns ||= connection.columns(table_name, "#{name} Columns")
592 end
593
594 # Returns an array of column objects for the table associated with this class.
595 def columns_hash
596 @columns_hash ||= columns.inject({}) { |hash, column| hash[column.name] = column; hash }
597 end
598
599 # Returns an array of columns objects where the primary id, all columns ending in "_id" or "_count",
600 # and columns used for single table inheritance has been removed.
601 def content_columns
602 @content_columns ||= columns.reject { |c| c.name == primary_key || c.name =~ /(_id|_count)$/ || c.name == inheritance_column }
603 end
604
605 # 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
606 # 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
607 # is available.
608 def column_methods_hash
609 @dynamic_methods_hash ||= columns_hash.keys.inject(Hash.new(false)) do |methods, attr|
610 methods[attr.to_sym] = true
611 methods["#{attr}=".to_sym] = true
612 methods["#{attr}?".to_sym] = true
dad37cf @dhh FormHelper should only use *_before_type_cast if they available on th…
dhh authored
613 methods["#{attr}_before_type_cast".to_sym] = true
db045db @dhh Initial
dhh authored
614 methods
615 end
616 end
1314f48 @dhh Added methods for resetting the cached information on classes that yo…
dhh authored
617
618 # Resets all the cached information about columns, which will cause they to be reloaded on the next request.
619 def reset_column_information
620 @columns = @columns_hash = @content_columns = @dynamic_methods_hash = nil
621 end
622
4eab375 @dhh Finished polishing API docs
dhh authored
623 def reset_column_information_and_inheritable_attributes_for_all_subclasses#:nodoc:
1314f48 @dhh Added methods for resetting the cached information on classes that yo…
dhh authored
624 subclasses.each { |klass| klass.reset_inheritable_attributes; klass.reset_column_information }
625 end
db045db @dhh Initial
dhh authored
626
627 # Transforms attribute key names into a more humane format, such as "First name" instead of "first_name". Example:
628 # Person.human_attribute_name("first_name") # => "First name"
4eab375 @dhh Finished polishing API docs
dhh authored
629 # Deprecated in favor of just calling "first_name".humanize
630 def human_attribute_name(attribute_key_name) #:nodoc:
1f7e72f @dhh Made human_attribute_name(attribute_key_name) use Inflector.humanize
dhh authored
631 attribute_key_name.humanize
db045db @dhh Initial
dhh authored
632 end
633
634 def descends_from_active_record? # :nodoc:
605bc77 @dhh Added a better exception for when a type column is used in a table wi…
dhh authored
635 superclass == Base || !columns_hash.has_key?(inheritance_column)
db045db @dhh Initial
dhh authored
636 end
637
4eab375 @dhh Finished polishing API docs
dhh authored
638 def quote(object) #:nodoc:
4940383 @dhh Fixed value quoting in all generated SQL statements, so that integers…
dhh authored
639 connection.quote(object)
640 end
641
642 # Used to sanitize objects before they're used in an SELECT SQL-statement. Delegates to <tt>connection.quote</tt>.
4eab375 @dhh Finished polishing API docs
dhh authored
643 def sanitize(object) #:nodoc:
4940383 @dhh Fixed value quoting in all generated SQL statements, so that integers…
dhh authored
644 connection.quote(object)
db045db @dhh Initial
dhh authored
645 end
646
647 # Used to aggregate logging and benchmark, so you can measure and represent multiple statements in a single block.
648 # Usage (hides all the SQL calls for the individual actions and calculates total runtime for them all):
649 #
650 # Project.benchmark("Creating project") do
651 # project = Project.create("name" => "stuff")
652 # project.create_manager("name" => "David")
653 # project.milestones << Milestone.find_all
654 # end
655 def benchmark(title)
656 result = nil
c00bf5f @dhh Fixed the verbosity of using the AR store
dhh authored
657 bm = Benchmark.measure { result = silence { yield } }
aec31cd @dhh Fixed Base.silence/benchmark to only log if a logger has been configu…
dhh authored
658 logger.info "#{title} (#{sprintf("%f", bm.real)})" if logger
c00bf5f @dhh Fixed the verbosity of using the AR store
dhh authored
659 return result
660 end
661
662 # Silences the logger for the duration of the block.
663 def silence
664 result = nil
908e9a1 @dhh Fixed that Base.silence should restore the old logger level when done…
dhh authored
665 old_logger_level = logger.level if logger
aec31cd @dhh Fixed Base.silence/benchmark to only log if a logger has been configu…
dhh authored
666 logger.level = Logger::ERROR if logger
c00bf5f @dhh Fixed the verbosity of using the AR store
dhh authored
667 result = yield
908e9a1 @dhh Fixed that Base.silence should restore the old logger level when done…
dhh authored
668 logger.level = old_logger_level if logger
db045db @dhh Initial
dhh authored
669 return result
670 end
671
97849de @dhh Fixed that association proxies would fail === tests like PremiumSubsc…
dhh authored
672 # Overwrite the default class equality method to provide support for association proxies.
673 def ===(object)
674 object.is_a?(self)
675 end
676
db045db @dhh Initial
dhh authored
677 private
678 # Finder methods must instantiate through this method to work with the single-table inheritance model
679 # that makes it possible to create objects of different types from the same table.
680 def instantiate(record)
605bc77 @dhh Added a better exception for when a type column is used in a table wi…
dhh authored
681 require_association_class(record[inheritance_column])
682
683 begin
684 object = record_with_type?(record) ? compute_type(record[inheritance_column]).allocate : allocate
685 rescue NameError
686 raise(
687 SubclassNotFound,
688 "The single-table inheritance mechanism failed to locate the subclass: '#{record[inheritance_column]}'. " +
689 "This error is raised because the column '#{inheritance_column}' is reserved for storing the class in case of inheritance. " +
690 "Please rename this column if you didn't intend it to be used for storing the inheritance class " +
691 "or overwrite #{self.to_s}.inheritance_column to use another column for that information."
692 )
693 end
694
db045db @dhh Initial
dhh authored
695 object.instance_variable_set("@attributes", record)
696 return object
697 end
698
699 # Returns true if the +record+ has a single table inheritance column and is using it.
700 def record_with_type?(record)
701 record.include?(inheritance_column) && !record[inheritance_column].nil? &&
702 !record[inheritance_column].empty?
703 end
704
705 # Returns the name of the type of the record using the current module as a prefix. So descendents of
706 # MyApp::Business::Account would be appear as "MyApp::Business::AccountSubclass".
707 def type_name_with_module(type_name)
708 self.name =~ /::/ ? self.name.scan(/(.*)::/).first.first + "::" + type_name : type_name
709 end
710
abc895b @dhh Added new Base.find API and deprecated find_all, find_first. Added pr…
dhh authored
711 def construct_finder_sql(options)
712 sql = "SELECT * FROM #{table_name} "
713 sql << "#{options[:joins]} " if options[:joins]
714 add_conditions!(sql, options[:conditions])
715 sql << "ORDER BY #{options[:order]} " if options[:order]
efb55d1 @dhh Allow order, conditions, and joins in finds that include associations
dhh authored
716 add_limit!(sql, options)
717
718 return sql
719 end
abc895b @dhh Added new Base.find API and deprecated find_all, find_first. Added pr…
dhh authored
720
efb55d1 @dhh Allow order, conditions, and joins in finds that include associations
dhh authored
721 def add_limit!(sql, options)
abc895b @dhh Added new Base.find API and deprecated find_all, find_first. Added pr…
dhh authored
722 if options[:limit] && options[:offset]
723 connection.add_limit_with_offset!(sql, options[:limit].to_i, options[:offset].to_i)
724 elsif options[:limit]
725 connection.add_limit_without_offset!(sql, options[:limit].to_i)
726 end
727 end
728
db045db @dhh Initial
dhh authored
729 # Adds a sanitized version of +conditions+ to the +sql+ string. Note that it's the passed +sql+ string is changed.
730 def add_conditions!(sql, conditions)
6bd672e @dhh Added that Base#find takes an optional options hash, including :condi…
dhh authored
731 sql << "WHERE #{sanitize_sql(conditions)} " unless conditions.nil?
db045db @dhh Initial
dhh authored
732 sql << (conditions.nil? ? "WHERE " : " AND ") + type_condition unless descends_from_active_record?
733 end
734
735 def type_condition
fdd2681 @dhh Made eager loading work with inheritance hierarchies #1065 [Ryan Carver]
dhh authored
736 type_condition = subclasses.inject("#{table_name}.#{inheritance_column} = '#{name.demodulize}' ") do |condition, subclass|
737 condition << "OR #{table_name}.#{inheritance_column} = '#{subclass.name.demodulize}' "
738 end
739
ff1db4d @dhh Qualify the ids used such that eager loading can avoid ambigious keys
dhh authored
740 return " (#{type_condition}) "
db045db @dhh Initial
dhh authored
741 end
742
743 # Guesses the table name, but does not decorate it with prefix and suffix information.
744 def undecorated_table_name(class_name = class_name_of_active_record_descendant(self))
745 table_name = Inflector.underscore(Inflector.demodulize(class_name))
746 table_name = Inflector.pluralize(table_name) if pluralize_table_names
747 return table_name
748 end
749
ac8fd7d @dhh Added dynamic attribute-based finders as a cleaner way of getting obj…
dhh authored
750 # Enables dynamic finders like find_by_user_name(user_name) and find_by_user_name_and_password(user_name, password) that are turned into
959f362 @dhh Added find_all style to the new dynamic finders
dhh authored
751 # find_first(["user_name = ?", user_name]) and find_first(["user_name = ? AND password = ?", user_name, password]) respectively. Also works
752 # for find_all, but using find_all_by_amount(50) that are turned into find_all(["amount = ?", 50]).
569f2ea @dhh Added the possibility of specifying the remaining options for find_fi…
dhh authored
753 #
754 # It's even possible to use all the additional parameters to find_first and find_all. For example, the full interface for find_all_by_amount
755 # is actually find_all_by_amount(amount, orderings = nil, limit = nil, joins = nil).
ac8fd7d @dhh Added dynamic attribute-based finders as a cleaner way of getting obj…
dhh authored
756 def method_missing(method_id, *arguments)
757 method_name = method_id.id2name
758
06b8936 @dhh Fixed that find_by_* would fail when column names had numbers #670 [d…
dhh authored
759 if method_name =~ /find_(all_by|by)_([_a-z][_a-z\d]*)/
959f362 @dhh Added find_all style to the new dynamic finders
dhh authored
760 finder, attributes = ($1 == "all_by" ? :find_all : :find_first), $2.split("_and_")
ac8fd7d @dhh Added dynamic attribute-based finders as a cleaner way of getting obj…
dhh authored
761 attributes.each { |attr_name| super unless column_methods_hash[attr_name.intern] }
93ec130 @dhh Fixed that the dynamic finders didnt treat nil as a "IS NULL" but rat…
dhh authored
762
763 attr_index = -1
28edbca @dhh Fixed that the dynamic finder like find_all_by_something_boolean(fals…
dhh authored
764 conditions = attributes.collect { |attr_name| attr_index += 1; "#{attr_name} #{arguments[attr_index].nil? ? "IS" : "="} ? " }.join(" AND ")
569f2ea @dhh Added the possibility of specifying the remaining options for find_fi…
dhh authored
765 send(finder, [conditions, *arguments[0...attributes.length]], *arguments[attributes.length..-1])
ac8fd7d @dhh Added dynamic attribute-based finders as a cleaner way of getting obj…
dhh authored
766 else
767 super
768 end
769 end
db045db @dhh Initial
dhh authored
770
4eab375 @dhh Finished polishing API docs
dhh authored
771 # Defines an "attribute" method (like #inheritance_column or
772 # #table_name). A new (class) method will be created with the
773 # given name. If a value is specified, the new method will
774 # return that value (as a string). Otherwise, the given block
775 # will be used to compute the value of the method.
776 #
777 # The original method will be aliased, with the new name being
778 # prefixed with "original_". This allows the new method to
779 # access the original value.
780 #
781 # Example:
782 #
783 # class A < ActiveRecord::Base
784 # define_attr_method :primary_key, "sysid"
785 # define_attr_method( :inheritance_column ) do
786 # original_inheritance_column + "_id"
787 # end
788 # end
789 def define_attr_method(name, value=nil, &block)
790 sing = class << self; self; end
791 block = proc { value.to_s } if value
792 sing.send( :alias_method, "original_#{name}", name )
793 sing.send( :define_method, name, &block )
794 end
795
db045db @dhh Initial
dhh authored
796 protected
797 def subclasses
798 @@subclasses[self] ||= []
799 @@subclasses[self] + extra = @@subclasses[self].inject([]) {|list, subclass| list + subclass.subclasses }
800 end
801
802 # Returns the class type of the record using the current module as a prefix. So descendents of
803 # MyApp::Business::Account would be appear as MyApp::Business::AccountSubclass.
804 def compute_type(type_name)
805 type_name_with_module(type_name).split("::").inject(Object) do |final_type, part|
806 final_type = final_type.const_get(part)
807 end
808 end
809
810 # Returns the name of the class descending directly from ActiveRecord in the inheritance hierarchy.
811 def class_name_of_active_record_descendant(klass)
812 if klass.superclass == Base
813 return klass.name
814 elsif klass.superclass.nil?
815 raise ActiveRecordError, "#{name} doesn't belong in a hierarchy descending from ActiveRecord"
816 else
817 class_name_of_active_record_descendant(klass.superclass)
818 end
819 end
820
6bd672e @dhh Added that Base#find takes an optional options hash, including :condi…
dhh authored
821 # Accepts an array or string. The string is returned untouched, but the array has each value
822 # sanitized and interpolated into the sql statement.
823 # ["name='%s' and group_id='%s'", "foo'bar", 4] returns "name='foo''bar' and group_id='4'"
824 def sanitize_sql(ary)
825 return ary unless ary.is_a?(Array)
3e7d191 @dhh Added bind-style variable interpolation for the condition arrays that…
dhh authored
826
6bd672e @dhh Added that Base#find takes an optional options hash, including :condi…
dhh authored
827 statement, *values = ary
828 if values.first.is_a?(Hash) and statement =~ /:\w+/
829 replace_named_bind_variables(statement, values.first)
830 elsif statement.include?('?')
554597d @dhh Added named bind-style variable interpolation #281 [Michael Koziarski]
dhh authored
831 replace_bind_variables(statement, values)
832 else
4940383 @dhh Fixed value quoting in all generated SQL statements, so that integers…
dhh authored
833 statement % values.collect { |value| connection.quote_string(value.to_s) }
554597d @dhh Added named bind-style variable interpolation #281 [Michael Koziarski]
dhh authored
834 end
3e7d191 @dhh Added bind-style variable interpolation for the condition arrays that…
dhh authored
835 end
836
6bd672e @dhh Added that Base#find takes an optional options hash, including :condi…
dhh authored
837 alias_method :sanitize_conditions, :sanitize_sql
838
3e7d191 @dhh Added bind-style variable interpolation for the condition arrays that…
dhh authored
839 def replace_bind_variables(statement, values)
9322168 @dhh Restored bind arity checking #412 [bitsweat]
dhh authored
840 raise_if_bind_arity_mismatch(statement, statement.count('?'), values.size)
6bd672e @dhh Added that Base#find takes an optional options hash, including :condi…
dhh authored
841 bound = values.dup
872ddaf @dhh Added bind-named arrays for interpolating a group of ids or strings i…
dhh authored
842 statement.gsub('?') { quote_bound_value(bound.shift) }
554597d @dhh Added named bind-style variable interpolation #281 [Michael Koziarski]
dhh authored
843 end
844
6bd672e @dhh Added that Base#find takes an optional options hash, including :condi…
dhh authored
845 def replace_named_bind_variables(statement, bind_vars)
9322168 @dhh Restored bind arity checking #412 [bitsweat]
dhh authored
846 raise_if_bind_arity_mismatch(statement, statement.scan(/:(\w+)/).uniq.size, bind_vars.size)
6bd672e @dhh Added that Base#find takes an optional options hash, including :condi…
dhh authored
847 statement.gsub(/:(\w+)/) do
848 match = $1.to_sym
849 if bind_vars.has_key?(match)
872ddaf @dhh Added bind-named arrays for interpolating a group of ids or strings i…
dhh authored
850 quote_bound_value(bind_vars[match])
6bd672e @dhh Added that Base#find takes an optional options hash, including :condi…
dhh authored
851 else
852 raise PreparedStatementInvalid, "missing value for :#{match} in #{statement}"
554597d @dhh Added named bind-style variable interpolation #281 [Michael Koziarski]
dhh authored
853 end
854 end
9322168 @dhh Restored bind arity checking #412 [bitsweat]
dhh authored
855 end
856
872ddaf @dhh Added bind-named arrays for interpolating a group of ids or strings i…
dhh authored
857 def quote_bound_value(value)
858 case value
859 when Array
860 value.map { |v| connection.quote(v) }.join(',')
861 else
862 connection.quote(value)
863 end
864 end
865
9322168 @dhh Restored bind arity checking #412 [bitsweat]
dhh authored
866 def raise_if_bind_arity_mismatch(statement, expected, provided)
867 unless expected == provided
868 raise PreparedStatementInvalid, "wrong number of bind variables (#{provided} for #{expected}) in: #{statement}"
869 end
6bd672e @dhh Added that Base#find takes an optional options hash, including :condi…
dhh authored
870 end
554597d @dhh Added named bind-style variable interpolation #281 [Michael Koziarski]
dhh authored
871
6bd672e @dhh Added that Base#find takes an optional options hash, including :condi…
dhh authored
872 def extract_options_from_args!(args)
873 if args.last.is_a?(Hash) then args.pop else {} end
db045db @dhh Initial
dhh authored
874 end
aaf9a45 @dhh Added Base.validate_uniqueness thatv alidates whether the value of th…
dhh authored
875
876 def encode_quoted_value(value)
877 quoted_value = connection.quote(value)
878 quoted_value = "'#{quoted_value[1..-2].gsub(/\'/, "\\\\'")}'" if quoted_value.include?("\\\'")
879 quoted_value
880 end
db045db @dhh Initial
dhh authored
881 end
882
883 public
884 # New objects can be instantiated as either empty (pass no construction parameter) or pre-set with
885 # attributes but not yet saved (pass a hash with key names matching the associated table column names).
886 # In both instances, valid attribute keys are determined by the column names of the associated table --
887 # hence you can't have attributes that aren't part of the table columns.
888 def initialize(attributes = nil)
889 @attributes = attributes_from_column_definition
890 @new_record = true
891 ensure_proper_type
892 self.attributes = attributes unless attributes.nil?
893 yield self if block_given?
894 end
895
896 # Every Active Record class must use "id" as their primary ID. This getter overwrites the native
897 # id method, which isn't being used in this context.
898 def id
899 read_attribute(self.class.primary_key)
900 end
901
ce23862 @dhh Added alias_method :to_param, :id to Base, such that Active Record ob…
dhh authored
902 # Enables Active Record objects to be used as URL parameters in Action Pack automatically.
903 alias_method :to_param, :id
904
4eab375 @dhh Finished polishing API docs
dhh authored
905 def id_before_type_cast #:nodoc:
3e5a880 @dhh Switched strategy on the id_before_type_cast problem and just did an …
dhh authored
906 read_attribute_before_type_cast(self.class.primary_key)
907 end
908
4eab375 @dhh Finished polishing API docs
dhh authored
909 def quoted_id #:nodoc:
4940383 @dhh Fixed value quoting in all generated SQL statements, so that integers…
dhh authored
910 quote(id, self.class.columns_hash[self.class.primary_key])
911 end
912
db045db @dhh Initial
dhh authored
913 # Sets the primary ID.
914 def id=(value)
915 write_attribute(self.class.primary_key, value)
916 end
917
918 # Returns true if this object hasn't been saved yet -- that is, a record for the object doesn't exist yet.
919 def new_record?
920 @new_record
921 end
922
923 # * No record exists: Creates a new record with values matching those of the object attributes.
924 # * A record does exist: Updates the record with values matching those of the object attributes.
925 def save
926 create_or_update
927 end
928
929 # Deletes the record in the database and freezes this instance to reflect that no changes should
930 # be made (since they can't be persisted).
931 def destroy
932 unless new_record?
933 connection.delete(
934 "DELETE FROM #{self.class.table_name} " +
4940383 @dhh Fixed value quoting in all generated SQL statements, so that integers…
dhh authored
935 "WHERE #{self.class.primary_key} = #{quote(id)}",
db045db @dhh Initial
dhh authored
936 "#{self.class.name} Destroy"
937 )
938 end
939
940 freeze
941 end
942
943 # Returns a clone of the record that hasn't been assigned an id yet and is treated as a new record.
944 def clone
431e21c @dhh Fixed Base#clone for use with PostgreSQL #565 [hanson@surgery.wisc.edu]
dhh authored
945 attrs = self.attributes
a3298e5 @dhh Small indent
dhh authored
946 attrs.delete(self.class.primary_key)
431e21c @dhh Fixed Base#clone for use with PostgreSQL #565 [hanson@surgery.wisc.edu]
dhh authored
947 cloned_record = self.class.new(attrs)
db045db @dhh Initial
dhh authored
948 cloned_record
949 end
950
951 # Updates a single attribute and saves the record. This is especially useful for boolean flags on existing records.
d678997 @dhh Base#update_attribute isnt subject to validation
dhh authored
952 # Note: This method is overwritten by the Validation module that'll make sure that updates made with this method
953 # doesn't get subjected to validation checks. Hence, attributes can be updated even if the full object isn't valid.
db045db @dhh Initial
dhh authored
954 def update_attribute(name, value)
393e98a @dhh Fixed Base#update_attribute to be indifferent to whether a string or …
dhh authored
955 self[name] = value
d1abe80 @dhh Added Base#toggle(attribute) and Base#toggle!(attribute) that makes i…
dhh authored
956 save
604a094 @dhh Added Base#update_attributes that'll accept a hash of attributes and …
dhh authored
957 end
958
d678997 @dhh Base#update_attribute isnt subject to validation
dhh authored
959 # Updates all the attributes in from the passed hash and saves the record. If the object is invalid, the saving will
960 # fail and false will be returned.
604a094 @dhh Added Base#update_attributes that'll accept a hash of attributes and …
dhh authored
961 def update_attributes(attributes)
3bef4c2 @dhh Made Base#update_attributes actually work
dhh authored
962 self.attributes = attributes
604a094 @dhh Added Base#update_attributes that'll accept a hash of attributes and …
dhh authored
963 return save
db045db @dhh Initial
dhh authored
964 end
965
d1abe80 @dhh Added Base#toggle(attribute) and Base#toggle!(attribute) that makes i…
dhh authored
966 # Initializes the +attribute+ to zero if nil and adds one. Only makes sense for number-based attributes. Returns self.
967 def increment(attribute)
968 self[attribute] ||= 0
969 self[attribute] += 1
970 self
971 end
972
973 # Increments the +attribute+ and saves the record.
974 def increment!(attribute)
975 increment(attribute).update_attribute(attribute, self[attribute])
976 end
977
978 # Initializes the +attribute+ to zero if nil and subtracts one. Only makes sense for number-based attributes. Returns self.
979 def decrement(attribute)
980 self[attribute] ||= 0
981 self[attribute] -= 1
982 self
983 end
984
985 # Decrements the +attribute+ and saves the record.
986 def decrement!(attribute)
987 decrement(attribute).update_attribute(attribute, self[attribute])
988 end
989
990 # Turns an +attribute+ that's currently true into false and vice versa. Returns self.
991 def toggle(attribute)
992 self[attribute] = quote(!send("#{attribute}?", column_for_attribute(attribute)))
993 self
994 end
995
996 # Toggles the +attribute+ and saves the record.
997 def toggle!(attribute)
998 toggle(attribute).update_attribute(attribute, self[attribute])
999 end
1000
3ff5c58 @dhh Added Base#reload that reloads the attributes of an object from the d…
dhh authored
1001 # Reloads the attributes of this object from the database.
1002 def reload
1003 clear_association_cache
1004 @attributes.update(self.class.find(self.id).instance_variable_get('@attributes'))
1005 return self
1006 end
1007
db045db @dhh Initial
dhh authored
1008 # Returns the value of attribute identified by <tt>attr_name</tt> after it has been type cast (for example,
1009 # "2004-12-12" in a data column is cast to a date object, like Date.new(2004, 12, 12)).
1010 # (Alias for the protected read_attribute method).
1011 def [](attr_name)
d1abe80 @dhh Added Base#toggle(attribute) and Base#toggle!(attribute) that makes i…
dhh authored
1012 read_attribute(attr_name.to_s)
db045db @dhh Initial
dhh authored
1013 end
1014
1015 # Updates the attribute identified by <tt>attr_name</tt> with the specified +value+.
1016 # (Alias for the protected write_attribute method).
1017 def []= (attr_name, value)
d1abe80 @dhh Added Base#toggle(attribute) and Base#toggle!(attribute) that makes i…
dhh authored
1018 write_attribute(attr_name.to_s, value)
db045db @dhh Initial
dhh authored
1019 end
1020
1021 # Allows you to set all the attributes at once by passing in a hash with keys
1022 # matching the attribute names (which again matches the column names). Sensitive attributes can be protected
1023 # from this form of mass-assignment by using the +attr_protected+ macro. Or you can alternatively
1024 # specify which attributes *can* be accessed in with the +attr_accessible+ macro. Then all the
1025 # attributes not included in that won't be allowed to be mass-assigned.
1026 def attributes=(attributes)
1027 return if attributes.nil?
2bfaa05 @dhh Fixed that symbols can be used on attribute assignment, like page.ema…
dhh authored
1028 attributes.stringify_keys!
db045db @dhh Initial
dhh authored
1029
1030 multi_parameter_attributes = []
1031 remove_attributes_protected_from_mass_assignment(attributes).each do |k, v|
1032 k.include?("(") ? multi_parameter_attributes << [ k, v ] : send(k + "=", v)
1033 end
1034 assign_multiparameter_attributes(multi_parameter_attributes)
1035 end
1036
b067bf7 @dhh Added Base#attributes that returns a hash of all the attributes with …
dhh authored
1037 # Returns a hash of all the attributes with their names as keys and clones of their objects as values.
1038 def attributes
1039 self.attribute_names.inject({}) do |attributes, name|
1040 begin
1041 attributes[name] = read_attribute(name).clone
55cb8c8 @dhh Fixed that Active Record objects with float attribute could not be cl…
dhh authored
1042 rescue TypeError, NoMethodError
b067bf7 @dhh Added Base#attributes that returns a hash of all the attributes with …
dhh authored
1043 attributes[name] = read_attribute(name)
1044 end
1045 attributes
1046 end
1047 end
1048
db045db @dhh Initial
dhh authored
1049 # Returns true if the specified +attribute+ has been set by the user or by a database load and is neither
1050 # nil nor empty? (the latter only applies to objects that responds to empty?, most notably Strings).
1051 def attribute_present?(attribute)
1052 is_empty = read_attribute(attribute).respond_to?("empty?") ? read_attribute(attribute).empty? : false
1053 @attributes.include?(attribute) && !@attributes[attribute].nil? && !is_empty
1054 end
1055
1056 # Returns an array of names for the attributes available on this object sorted alphabetically.
1057 def attribute_names
1058 @attributes.keys.sort
1059 end
1060
1061 # Returns the column object for the named attribute.
1062 def column_for_attribute(name)
d1abe80 @dhh Added Base#toggle(attribute) and Base#toggle!(attribute) that makes i…
dhh authored
1063 self.class.columns_hash[name.to_s]
db045db @dhh Initial
dhh authored
1064 end
1065
823554e @dhh Added support for associating unsaved objects #402 [Tim Bates]
dhh authored
1066 # Returns true if the +comparison_object+ is the same object, or is of the same type and has the same id.
db045db @dhh Initial
dhh authored
1067 def ==(comparison_object)
823554e @dhh Added support for associating unsaved objects #402 [Tim Bates]
dhh authored
1068 comparison_object.equal?(self) or (comparison_object.instance_of?(self.class) and comparison_object.id == id)
db045db @dhh Initial
dhh authored
1069 end
1070
1071 # Delegates to ==
1072 def eql?(comparison_object)
1073 self == (comparison_object)
1074 end
1075
1076 # Delegates to id in order to allow two records of the same type and id to work with something like:
1077 # [ Person.find(1), Person.find(2), Person.find(3) ] & [ Person.find(1), Person.find(4) ] # => [ Person.find(1) ]
1078 def hash
cfef86c @dhh Fixed bug in Base#hash method that would treat records with the same …
dhh authored
1079 id.hash
db045db @dhh Initial
dhh authored
1080 end
1081
1082 # For checking respond_to? without searching the attributes (which is faster).
1083 alias_method :respond_to_without_attributes?, :respond_to?
1084
1085 # A Person object with a name attribute can ask person.respond_to?("name"), person.respond_to?("name="), and
1086 # person.respond_to?("name?") which will all return true.
846f0d5 @dhh Fixed that the overwritten respond_to? method didn't take two paramet…
dhh authored
1087 def respond_to?(method, include_priv = false)
1088 self.class.column_methods_hash[method.to_sym] || respond_to_without_attributes?(method, include_priv)
db045db @dhh Initial
dhh authored
1089 end
d82f73e @dhh Abolished ActionController::Base.require_or_load in favor of require_…
dhh authored
1090
db045db @dhh Initial
dhh authored
1091 private
1092 def create_or_update
1093 if new_record? then create else update end
823554e @dhh Added support for associating unsaved objects #402 [Tim Bates]
dhh authored
1094 return true
db045db @dhh Initial
dhh authored
1095 end
1096
1097 # Updates the associated record with values matching those of the instant attributes.
1098 def update
1099 connection.update(
1100 "UPDATE #{self.class.table_name} " +
9a248a8 @dhh Dont include the primary key in updates -- its unneeded and SQL Serve…
dhh authored
1101 "SET #{quoted_comma_pair_list(connection, attributes_with_quotes(false))} " +
4940383 @dhh Fixed value quoting in all generated SQL statements, so that integers…
dhh authored
1102 "WHERE #{self.class.primary_key} = #{quote(id)}",
db045db @dhh Initial
dhh authored
1103 "#{self.class.name} Update"
1104 )
1105 end
1106
1107 # Creates a new record with values matching those of the instant attributes.
1108 def create
1109 self.id = connection.insert(
1110 "INSERT INTO #{self.class.table_name} " +
1111 "(#{quoted_column_names.join(', ')}) " +
1112 "VALUES(#{attributes_with_quotes.values.join(', ')})",
1113 "#{self.class.name} Create",
1114 self.class.primary_key, self.id
1115 )
1116
1117 @new_record = false
1118 end
1119
1120 # Sets the attribute used for single table inheritance to this class name if this is not the ActiveRecord descendant.
1121 # Considering the hierarchy Reply < Message < ActiveRecord, this makes it possible to do Reply.new without having to
1122 # set Reply[Reply.inheritance_column] = "Reply" yourself. No such attribute would be set for objects of the
1123 # Message class in that example.
1124 def ensure_proper_type
1125 unless self.class.descends_from_active_record?
1126 write_attribute(self.class.inheritance_column, Inflector.demodulize(self.class.name))
1127 end
1128 end
1129
1130 # Allows access to the object attributes, which are held in the @attributes hash, as were
1131 # they first-class methods. So a Person class with a name attribute can use Person#name and
1132 # Person#name= and never directly use the attributes hash -- except for multiple assigns with
1133 # ActiveRecord#attributes=. A Milestone class can also ask Milestone#completed? to test that
1134 # the completed attribute is not nil or 0.
1135 #
1136 # It's also possible to instantiate related objects, so a Client class belonging to the clients
1137 # table with a master_id foreign key can instantiate master through Client#master.
1138 def method_missing(method_id, *arguments)
1139 method_name = method_id.id2name
daf3e92 @dhh Added a db2 adapter that only depends on the Ruby/DB2 bindings (http:…
dhh authored
1140
db045db @dhh Initial
dhh authored
1141 if method_name =~ read_method? && @attributes.include?($1)
1142 return read_attribute($1)
7b5ed66 @dhh Added respondence to *_before_type_cast for all attributes to return …
dhh authored
1143 elsif method_name =~ read_untyped_method? && @attributes.include?($1)
1144 return read_attribute_before_type_cast($1)
db045db @dhh Initial
dhh authored
1145 elsif method_name =~ write_method? && @attributes.include?($1)
1146 write_attribute($1, arguments[0])
1147 elsif method_name =~ query_method? && @attributes.include?($1)
1148 return query_attribute($1)
1149 else
1150 super
1151 end
1152 end
1153
7b5ed66 @dhh Added respondence to *_before_type_cast for all attributes to return …
dhh authored
1154 def read_method?() /^([a-zA-Z][-_\w]*)[^=?]*$/ end
1155 def read_untyped_method?() /^([a-zA-Z][-_\w]*)_before_type_cast$/ end
1156 def write_method?() /^([a-zA-Z][-_\w]*)=.*$/ end
1157 def query_method?() /^([a-zA-Z][-_\w]*)\?$/ end
db045db @dhh Initial
dhh authored
1158
7b5ed66 @dhh Added respondence to *_before_type_cast for all attributes to return …
dhh authored
1159 # Returns the value of attribute identified by <tt>attr_name</tt> after it has been type cast (for example,
db045db @dhh Initial
dhh authored
1160 # "2004-12-12" in a data column is cast to a date object, like Date.new(2004, 12, 12)).
4eab375 @dhh Finished polishing API docs
dhh authored
1161 def read_attribute(attr_name)
db045db @dhh Initial
dhh authored
1162 if @attributes.keys.include? attr_name
1163 if column = column_for_attribute(attr_name)
7b5ed66 @dhh Added respondence to *_before_type_cast for all attributes to return …
dhh authored
1164 unserializable_attribute?(attr_name, column) ?
db045db @dhh Initial
dhh authored
1165 unserialize_attribute(attr_name) : column.type_cast(@attributes[attr_name])
7b5ed66 @dhh Added respondence to *_before_type_cast for all attributes to return …
dhh authored
1166 else
1167 @attributes[attr_name]
db045db @dhh Initial
dhh authored
1168 end
1169 else
1170 nil
1171 end
1172 end
1173
7b5ed66 @dhh Added respondence to *_before_type_cast for all attributes to return …
dhh authored
1174 def read_attribute_before_type_cast(attr_name)
1175 @attributes[attr_name]
1176 end
1177
db045db @dhh Initial
dhh authored
1178 # Returns true if the attribute is of a text column and marked for serialization.
1179 def unserializable_attribute?(attr_name, column)
daf3e92 @dhh Added a db2 adapter that only depends on the Ruby/DB2 bindings (http:…
dhh authored
1180 @attributes[attr_name] && [:text, :string].include?(column.send(:type)) && @attributes[attr_name].is_a?(String) && self.class.serialized_attributes[attr_name]
db045db @dhh Initial
dhh authored
1181 end
1182
1183 # Returns the unserialized object of the attribute.
1184 def unserialize_attribute(attr_name)
1185 unserialized_object = object_from_yaml(@attributes[attr_name])
1186
1187 if unserialized_object.is_a?(self.class.serialized_attributes[attr_name])
1188 @attributes[attr_name] = unserialized_object
1189 else
1190 raise(
1191 SerializationTypeMismatch,
1192 "#{attr_name} was supposed to be a #{self.class.serialized_attributes[attr_name]}, " +
1193 "but was a #{unserialized_object.class.to_s}"
1194 )
1195 end
1196 end
1197
1198 # Updates the attribute identified by <tt>attr_name</tt> with the specified +value+. Empty strings for fixnum and float
1199 # columns are turned into nil.
4eab375 @dhh Finished polishing API docs
dhh authored
1200 def write_attribute(attr_name, value)
db045db @dhh Initial
dhh authored
1201 @attributes[attr_name] = empty_string_for_number_column?(attr_name, value) ? nil : value
1202 end
1203
1204 def empty_string_for_number_column?(attr_name, value)
1205 column = column_for_attribute(attr_name)
1206 column && (column.klass == Fixnum || column.klass == Float) && value == ""
1207 end
1208
1209 def query_attribute(attr_name)
1210 attribute = @attributes[attr_name]
1211 if attribute.kind_of?(Fixnum) && attribute == 0
1212 false
1213 elsif attribute.kind_of?(String) && attribute == "0"
1214 false
1215 elsif attribute.kind_of?(String) && attribute.empty?
1216 false
1217 elsif attribute.nil?
1218 false
1219 elsif attribute == false
1220 false
1221 elsif attribute == "f"
1222 false
1223 elsif attribute == "false"
1224 false
1225 else
1226 true
1227 end
1228 end
1229
1230 def remove_attributes_protected_from_mass_assignment(attributes)
1231 if self.class.accessible_attributes.nil? && self.class.protected_attributes.nil?
95454bf @dhh Added mass-assignment protection for the inheritance column -- regard…
dhh authored
1232 attributes.reject { |key, value| attributes_protected_by_default.include?(key) }
db045db @dhh Initial
dhh authored
1233 elsif self.class.protected_attributes.nil?
95454bf @dhh Added mass-assignment protection for the inheritance column -- regard…
dhh authored
1234 attributes.reject { |key, value| !self.class.accessible_attributes.include?(key.intern) || attributes_protected_by_default.include?(key) }
db045db @dhh Initial
dhh authored
1235 elsif self.class.accessible_attributes.nil?
95454bf @dhh Added mass-assignment protection for the inheritance column -- regard…
dhh authored
1236 attributes.reject { |key, value| self.class.protected_attributes.include?(key.intern) || attributes_protected_by_default.include?(key) }
db045db @dhh Initial
dhh authored
1237 end
1238 end
1239
95454bf @dhh Added mass-assignment protection for the inheritance column -- regard…
dhh authored
1240 # The primary key and inheritance column can never be set by mass-assignment for security reasons.
1241 def attributes_protected_by_default
1242 [ self.class.primary_key, self.class.inheritance_column ]
1243 end
1244
db045db @dhh Initial
dhh authored
1245 # Returns copy of the attributes hash where all the values have been safely quoted for use in
1246 # an SQL statement.
9a248a8 @dhh Dont include the primary key in updates -- its unneeded and SQL Serve…
dhh authored
1247 def attributes_with_quotes(include_primary_key = true)
db045db @dhh Initial
dhh authored
1248 columns_hash = self.class.columns_hash
b29c01e @dhh Added that has_and_belongs_to_many associations with additional attri…
dhh authored
1249
dabf906 @dhh Added type conversion before saving a record, so string-based values …
dhh authored
1250 attrs_quoted = attributes.inject({}) do |attrs_quoted, pair|
9a248a8 @dhh Dont include the primary key in updates -- its unneeded and SQL Serve…
dhh authored
1251 attrs_quoted[pair.first] = quote(pair.last, columns_hash[pair.first]) unless !include_primary_key && pair.first == self.class.primary_key
db045db @dhh Initial
dhh authored
1252 attrs_quoted
1253 end
b29c01e @dhh Added that has_and_belongs_to_many associations with additional attri…
dhh authored
1254
1255 attrs_quoted.delete_if { |key, value| !self.class.columns_hash.keys.include?(key) }
db045db @dhh Initial
dhh authored
1256 end
1257
1258 # Quote strings appropriately for SQL statements.
1259 def quote(value, column = nil)
1260 connection.quote(value, column)
1261 end
1262
1263 # Interpolate custom sql string in instance context.
1264 # Optional record argument is meant for custom insert_sql.
1265 def interpolate_sql(sql, record = nil)
1266 instance_eval("%(#{sql})")
1267 end
1268
1269 # Initializes the attributes array with keys matching the columns from the linked table and
1270 # the values matching the corresponding default value of that column, so
1271 # that a new instance, or one populated from a passed-in Hash, still has all the attributes
1272 # that instances loaded from the database would.
1273 def attributes_from_column_definition
1274 connection.columns(self.class.table_name, "#{self.class.name} Columns").inject({}) do |attributes, column|
3e5a880 @dhh Switched strategy on the id_before_type_cast problem and just did an …
dhh authored
1275 attributes[column.name] = column.default unless column.name == self.class.primary_key
db045db @dhh Initial
dhh authored
1276 attributes
1277 end
1278 end
1279
1280 # Instantiates objects for all attribute classes that needs more than one constructor parameter. This is done
1281 # by calling new on the column type or aggregation type (through composed_of) object with these parameters.
1282 # So having the pairs written_on(1) = "2004", written_on(2) = "6", written_on(3) = "24", will instantiate
1283 # written_on (a date type) with Date.new("2004", "6", "24"). You can also specify a typecast character in the
098fa94 @dhh Fixed documentation snafus #575, #576, #577, #585
dhh authored
1284 # parentheses to have the parameters typecasted before they're used in the constructor. Use i for Fixnum, f for Float,
db045db @dhh Initial
dhh authored
1285 # s for String, and a for Array. If all the values for a given attribute is empty, the attribute will be set to nil.
1286 def assign_multiparameter_attributes(pairs)
1287 execute_callstack_for_multiparameter_attributes(
1288 extract_callstack_for_multiparameter_attributes(pairs)
1289 )
1290 end
1291
1292 # Includes an ugly hack for Time.local instead of Time.new because the latter is reserved by Time itself.
1293 def execute_callstack_for_multiparameter_attributes(callstack)
d2fefbe @dhh Added MultiparameterAssignmentErrors and AttributeAssignmentError exc…
dhh authored
1294 errors = []
db045db @dhh Initial
dhh authored
1295 callstack.each do |name, values|
1296 klass = (self.class.reflect_on_aggregation(name) || column_for_attribute(name)).klass
1297 if values.empty?
1298 send(name + "=", nil)
1299 else
d2fefbe @dhh Added MultiparameterAssignmentErrors and AttributeAssignmentError exc…
dhh authored
1300 begin
1301 send(name + "=", Time == klass ? klass.local(*values) : klass.new(*values))
1302 rescue => ex
1303 errors << AttributeAssignmentError.new("error on assignment #{values.inspect} to #{name}", ex, name)
1304 end
db045db @dhh Initial
dhh authored
1305 end
1306 end
d2fefbe @dhh Added MultiparameterAssignmentErrors and AttributeAssignmentError exc…
dhh authored
1307 unless errors.empty?
1308 raise MultiparameterAssignmentErrors.new(errors), "#{errors.size} error(s) on assignment of multiparameter attributes"
1309 end
db045db @dhh Initial
dhh authored
1310 end
1311
1312 def extract_callstack_for_multiparameter_attributes(pairs)
1313 attributes = { }
1314
1315 for pair in pairs
1316 multiparameter_name, value = pair
1317 attribute_name = multiparameter_name.split("(").first
1318 attributes[attribute_name] = [] unless attributes.include?(attribute_name)
1319
1320 unless value.empty?
1321 attributes[attribute_name] <<
b29c01e @dhh Added that has_and_belongs_to_many associations with additional attri…
dhh authored
1322 [ find_parameter_position(multiparameter_name), type_cast_attribute_value(multiparameter_name, value) ]
db045db @dhh Initial
dhh authored
1323 end
1324 end
1325
1326 attributes.each { |name, values| attributes[name] = values.sort_by{ |v| v.first }.collect { |v| v.last } }
1327 end
1328
1329 def type_cast_attribute_value(multiparameter_name, value)
1330 multiparameter_name =~ /\([0-9]*([a-z])\)/ ? value.send("to_" + $1) : value
1331 end
1332
1333 def find_parameter_position(multiparameter_name)
1334 multiparameter_name.scan(/\(([0-9]*).*\)/).first.first
1335 end
1336
1337 # Returns a comma-separated pair list, like "key1 = val1, key2 = val2".
1338 def comma_pair_list(hash)
1339 hash.inject([]) { |list, pair| list << "#{pair.first} = #{pair.last}" }.join(", ")
1340 end
1341
1342 def quoted_column_names(attributes = attributes_with_quotes)
1343 attributes.keys.collect { |column_name| connection.quote_column_name(column_name) }
1344 end
1345
1346 def quote_columns(column_quoter, hash)
b29c01e @dhh Added that has_and_belongs_to_many associations with additional attri…
dhh authored
1347 hash.inject({}) do |list, pair|
db045db @dhh Initial
dhh authored
1348 list[column_quoter.quote_column_name(pair.first)] = pair.last
1349 list
b29c01e @dhh Added that has_and_belongs_to_many associations with additional attri…
dhh authored
1350 end
db045db @dhh Initial
dhh authored
1351 end
1352
1353 def quoted_comma_pair_list(column_quoter, hash)
1354 comma_pair_list(quote_columns(column_quoter, hash))
1355 end
1356
1357 def object_from_yaml(string)
b40d3c9 @dhh Replaced === checks with is_a? checks #502, #82 [Marcel Molina]
dhh authored
1358 return string unless string.is_a?(String)
db045db @dhh Initial
dhh authored
1359 if has_yaml_encoding_header?(string)
1360 begin
1361 YAML::load(string)
1362 rescue Object
1363 # Apparently wasn't YAML anyway
1364 string
1365 end
1366 else
1367 string
1368 end
1369 end
1370
1371 def has_yaml_encoding_header?(string)
1372 string[0..3] == "--- "
1373 end
1374 end
1aa82b3 @dhh Added keyword-style approach to defining the custom relational bindin…
dhh authored
1375 end
Something went wrong with that request. Please try again.