activerecord_csi 2.3.5.p6

Sign up to get free protection for your applications and to get access to all the features.
Files changed (333) hide show
  1. data/CHANGELOG +5858 -0
  2. data/README +351 -0
  3. data/RUNNING_UNIT_TESTS +36 -0
  4. data/Rakefile +270 -0
  5. data/examples/associations.png +0 -0
  6. data/examples/performance.rb +162 -0
  7. data/install.rb +30 -0
  8. data/lib/active_record/aggregations.rb +261 -0
  9. data/lib/active_record/association_preload.rb +389 -0
  10. data/lib/active_record/associations/association_collection.rb +475 -0
  11. data/lib/active_record/associations/association_proxy.rb +278 -0
  12. data/lib/active_record/associations/belongs_to_association.rb +76 -0
  13. data/lib/active_record/associations/belongs_to_polymorphic_association.rb +53 -0
  14. data/lib/active_record/associations/has_and_belongs_to_many_association.rb +143 -0
  15. data/lib/active_record/associations/has_many_association.rb +122 -0
  16. data/lib/active_record/associations/has_many_through_association.rb +266 -0
  17. data/lib/active_record/associations/has_one_association.rb +133 -0
  18. data/lib/active_record/associations/has_one_through_association.rb +37 -0
  19. data/lib/active_record/associations.rb +2241 -0
  20. data/lib/active_record/attribute_methods.rb +388 -0
  21. data/lib/active_record/autosave_association.rb +364 -0
  22. data/lib/active_record/base.rb +3171 -0
  23. data/lib/active_record/batches.rb +81 -0
  24. data/lib/active_record/calculations.rb +311 -0
  25. data/lib/active_record/callbacks.rb +360 -0
  26. data/lib/active_record/connection_adapters/abstract/connection_pool.rb +371 -0
  27. data/lib/active_record/connection_adapters/abstract/connection_specification.rb +139 -0
  28. data/lib/active_record/connection_adapters/abstract/database_statements.rb +289 -0
  29. data/lib/active_record/connection_adapters/abstract/query_cache.rb +94 -0
  30. data/lib/active_record/connection_adapters/abstract/quoting.rb +69 -0
  31. data/lib/active_record/connection_adapters/abstract/schema_definitions.rb +722 -0
  32. data/lib/active_record/connection_adapters/abstract/schema_statements.rb +434 -0
  33. data/lib/active_record/connection_adapters/abstract_adapter.rb +241 -0
  34. data/lib/active_record/connection_adapters/mysql_adapter.rb +630 -0
  35. data/lib/active_record/connection_adapters/postgresql_adapter.rb +1113 -0
  36. data/lib/active_record/connection_adapters/sqlite3_adapter.rb +34 -0
  37. data/lib/active_record/connection_adapters/sqlite_adapter.rb +453 -0
  38. data/lib/active_record/dirty.rb +183 -0
  39. data/lib/active_record/dynamic_finder_match.rb +41 -0
  40. data/lib/active_record/dynamic_scope_match.rb +25 -0
  41. data/lib/active_record/fixtures.rb +996 -0
  42. data/lib/active_record/i18n_interpolation_deprecation.rb +26 -0
  43. data/lib/active_record/locale/en.yml +58 -0
  44. data/lib/active_record/locking/optimistic.rb +148 -0
  45. data/lib/active_record/locking/pessimistic.rb +55 -0
  46. data/lib/active_record/migration.rb +566 -0
  47. data/lib/active_record/named_scope.rb +192 -0
  48. data/lib/active_record/nested_attributes.rb +392 -0
  49. data/lib/active_record/observer.rb +197 -0
  50. data/lib/active_record/query_cache.rb +33 -0
  51. data/lib/active_record/reflection.rb +320 -0
  52. data/lib/active_record/schema.rb +51 -0
  53. data/lib/active_record/schema_dumper.rb +182 -0
  54. data/lib/active_record/serialization.rb +101 -0
  55. data/lib/active_record/serializers/json_serializer.rb +91 -0
  56. data/lib/active_record/serializers/xml_serializer.rb +357 -0
  57. data/lib/active_record/session_store.rb +326 -0
  58. data/lib/active_record/test_case.rb +66 -0
  59. data/lib/active_record/timestamp.rb +71 -0
  60. data/lib/active_record/transactions.rb +235 -0
  61. data/lib/active_record/validations.rb +1135 -0
  62. data/lib/active_record/version.rb +9 -0
  63. data/lib/active_record.rb +84 -0
  64. data/lib/activerecord.rb +2 -0
  65. data/test/assets/example.log +1 -0
  66. data/test/assets/flowers.jpg +0 -0
  67. data/test/cases/aaa_create_tables_test.rb +24 -0
  68. data/test/cases/active_schema_test_mysql.rb +100 -0
  69. data/test/cases/active_schema_test_postgresql.rb +24 -0
  70. data/test/cases/adapter_test.rb +145 -0
  71. data/test/cases/aggregations_test.rb +167 -0
  72. data/test/cases/ar_schema_test.rb +32 -0
  73. data/test/cases/associations/belongs_to_associations_test.rb +425 -0
  74. data/test/cases/associations/callbacks_test.rb +161 -0
  75. data/test/cases/associations/cascaded_eager_loading_test.rb +131 -0
  76. data/test/cases/associations/eager_load_includes_full_sti_class_test.rb +36 -0
  77. data/test/cases/associations/eager_load_nested_include_test.rb +130 -0
  78. data/test/cases/associations/eager_singularization_test.rb +145 -0
  79. data/test/cases/associations/eager_test.rb +834 -0
  80. data/test/cases/associations/extension_test.rb +62 -0
  81. data/test/cases/associations/habtm_join_table_test.rb +56 -0
  82. data/test/cases/associations/has_and_belongs_to_many_associations_test.rb +822 -0
  83. data/test/cases/associations/has_many_associations_test.rb +1134 -0
  84. data/test/cases/associations/has_many_through_associations_test.rb +346 -0
  85. data/test/cases/associations/has_one_associations_test.rb +330 -0
  86. data/test/cases/associations/has_one_through_associations_test.rb +209 -0
  87. data/test/cases/associations/inner_join_association_test.rb +93 -0
  88. data/test/cases/associations/join_model_test.rb +712 -0
  89. data/test/cases/associations_test.rb +262 -0
  90. data/test/cases/attribute_methods_test.rb +305 -0
  91. data/test/cases/autosave_association_test.rb +1142 -0
  92. data/test/cases/base_test.rb +2154 -0
  93. data/test/cases/batches_test.rb +61 -0
  94. data/test/cases/binary_test.rb +30 -0
  95. data/test/cases/calculations_test.rb +348 -0
  96. data/test/cases/callbacks_observers_test.rb +38 -0
  97. data/test/cases/callbacks_test.rb +438 -0
  98. data/test/cases/class_inheritable_attributes_test.rb +32 -0
  99. data/test/cases/column_alias_test.rb +17 -0
  100. data/test/cases/column_definition_test.rb +70 -0
  101. data/test/cases/connection_pool_test.rb +25 -0
  102. data/test/cases/connection_test_firebird.rb +8 -0
  103. data/test/cases/connection_test_mysql.rb +64 -0
  104. data/test/cases/copy_table_test_sqlite.rb +80 -0
  105. data/test/cases/database_statements_test.rb +12 -0
  106. data/test/cases/datatype_test_postgresql.rb +204 -0
  107. data/test/cases/date_time_test.rb +37 -0
  108. data/test/cases/default_test_firebird.rb +16 -0
  109. data/test/cases/defaults_test.rb +111 -0
  110. data/test/cases/deprecated_finder_test.rb +30 -0
  111. data/test/cases/dirty_test.rb +316 -0
  112. data/test/cases/finder_respond_to_test.rb +76 -0
  113. data/test/cases/finder_test.rb +1066 -0
  114. data/test/cases/fixtures_test.rb +656 -0
  115. data/test/cases/helper.rb +68 -0
  116. data/test/cases/i18n_test.rb +46 -0
  117. data/test/cases/inheritance_test.rb +262 -0
  118. data/test/cases/invalid_date_test.rb +24 -0
  119. data/test/cases/json_serialization_test.rb +205 -0
  120. data/test/cases/lifecycle_test.rb +193 -0
  121. data/test/cases/locking_test.rb +304 -0
  122. data/test/cases/method_scoping_test.rb +704 -0
  123. data/test/cases/migration_test.rb +1523 -0
  124. data/test/cases/migration_test_firebird.rb +124 -0
  125. data/test/cases/mixin_test.rb +96 -0
  126. data/test/cases/modules_test.rb +81 -0
  127. data/test/cases/multiple_db_test.rb +85 -0
  128. data/test/cases/named_scope_test.rb +361 -0
  129. data/test/cases/nested_attributes_test.rb +581 -0
  130. data/test/cases/pk_test.rb +119 -0
  131. data/test/cases/pooled_connections_test.rb +103 -0
  132. data/test/cases/query_cache_test.rb +123 -0
  133. data/test/cases/readonly_test.rb +107 -0
  134. data/test/cases/reflection_test.rb +194 -0
  135. data/test/cases/reload_models_test.rb +22 -0
  136. data/test/cases/repair_helper.rb +50 -0
  137. data/test/cases/reserved_word_test_mysql.rb +176 -0
  138. data/test/cases/sanitize_test.rb +25 -0
  139. data/test/cases/schema_authorization_test_postgresql.rb +75 -0
  140. data/test/cases/schema_dumper_test.rb +211 -0
  141. data/test/cases/schema_test_postgresql.rb +178 -0
  142. data/test/cases/serialization_test.rb +47 -0
  143. data/test/cases/synonym_test_oracle.rb +17 -0
  144. data/test/cases/timestamp_test.rb +75 -0
  145. data/test/cases/transactions_test.rb +522 -0
  146. data/test/cases/unconnected_test.rb +32 -0
  147. data/test/cases/validations_i18n_test.rb +955 -0
  148. data/test/cases/validations_test.rb +1640 -0
  149. data/test/cases/xml_serialization_test.rb +240 -0
  150. data/test/config.rb +5 -0
  151. data/test/connections/jdbc_jdbcderby/connection.rb +18 -0
  152. data/test/connections/jdbc_jdbch2/connection.rb +18 -0
  153. data/test/connections/jdbc_jdbchsqldb/connection.rb +18 -0
  154. data/test/connections/jdbc_jdbcmysql/connection.rb +26 -0
  155. data/test/connections/jdbc_jdbcpostgresql/connection.rb +26 -0
  156. data/test/connections/jdbc_jdbcsqlite3/connection.rb +25 -0
  157. data/test/connections/native_db2/connection.rb +25 -0
  158. data/test/connections/native_firebird/connection.rb +26 -0
  159. data/test/connections/native_frontbase/connection.rb +27 -0
  160. data/test/connections/native_mysql/connection.rb +25 -0
  161. data/test/connections/native_openbase/connection.rb +21 -0
  162. data/test/connections/native_oracle/connection.rb +27 -0
  163. data/test/connections/native_postgresql/connection.rb +25 -0
  164. data/test/connections/native_sqlite/connection.rb +25 -0
  165. data/test/connections/native_sqlite3/connection.rb +25 -0
  166. data/test/connections/native_sqlite3/in_memory_connection.rb +18 -0
  167. data/test/connections/native_sybase/connection.rb +23 -0
  168. data/test/fixtures/accounts.yml +29 -0
  169. data/test/fixtures/all/developers.yml +0 -0
  170. data/test/fixtures/all/people.csv +0 -0
  171. data/test/fixtures/all/tasks.yml +0 -0
  172. data/test/fixtures/author_addresses.yml +5 -0
  173. data/test/fixtures/author_favorites.yml +4 -0
  174. data/test/fixtures/authors.yml +9 -0
  175. data/test/fixtures/binaries.yml +132 -0
  176. data/test/fixtures/books.yml +7 -0
  177. data/test/fixtures/categories/special_categories.yml +9 -0
  178. data/test/fixtures/categories/subsubdir/arbitrary_filename.yml +4 -0
  179. data/test/fixtures/categories.yml +14 -0
  180. data/test/fixtures/categories_ordered.yml +7 -0
  181. data/test/fixtures/categories_posts.yml +23 -0
  182. data/test/fixtures/categorizations.yml +17 -0
  183. data/test/fixtures/clubs.yml +6 -0
  184. data/test/fixtures/comments.yml +59 -0
  185. data/test/fixtures/companies.yml +56 -0
  186. data/test/fixtures/computers.yml +4 -0
  187. data/test/fixtures/courses.yml +7 -0
  188. data/test/fixtures/customers.yml +26 -0
  189. data/test/fixtures/developers.yml +21 -0
  190. data/test/fixtures/developers_projects.yml +17 -0
  191. data/test/fixtures/edges.yml +6 -0
  192. data/test/fixtures/entrants.yml +14 -0
  193. data/test/fixtures/fixture_database.sqlite3 +0 -0
  194. data/test/fixtures/fixture_database_2.sqlite3 +0 -0
  195. data/test/fixtures/fk_test_has_fk.yml +3 -0
  196. data/test/fixtures/fk_test_has_pk.yml +2 -0
  197. data/test/fixtures/funny_jokes.yml +10 -0
  198. data/test/fixtures/items.yml +4 -0
  199. data/test/fixtures/jobs.yml +7 -0
  200. data/test/fixtures/legacy_things.yml +3 -0
  201. data/test/fixtures/mateys.yml +4 -0
  202. data/test/fixtures/member_types.yml +6 -0
  203. data/test/fixtures/members.yml +6 -0
  204. data/test/fixtures/memberships.yml +20 -0
  205. data/test/fixtures/minimalistics.yml +2 -0
  206. data/test/fixtures/mixed_case_monkeys.yml +6 -0
  207. data/test/fixtures/mixins.yml +29 -0
  208. data/test/fixtures/movies.yml +7 -0
  209. data/test/fixtures/naked/csv/accounts.csv +1 -0
  210. data/test/fixtures/naked/yml/accounts.yml +1 -0
  211. data/test/fixtures/naked/yml/companies.yml +1 -0
  212. data/test/fixtures/naked/yml/courses.yml +1 -0
  213. data/test/fixtures/organizations.yml +5 -0
  214. data/test/fixtures/owners.yml +7 -0
  215. data/test/fixtures/parrots.yml +27 -0
  216. data/test/fixtures/parrots_pirates.yml +7 -0
  217. data/test/fixtures/people.yml +15 -0
  218. data/test/fixtures/pets.yml +14 -0
  219. data/test/fixtures/pirates.yml +9 -0
  220. data/test/fixtures/posts.yml +52 -0
  221. data/test/fixtures/price_estimates.yml +7 -0
  222. data/test/fixtures/projects.yml +7 -0
  223. data/test/fixtures/readers.yml +9 -0
  224. data/test/fixtures/references.yml +17 -0
  225. data/test/fixtures/reserved_words/distinct.yml +5 -0
  226. data/test/fixtures/reserved_words/distincts_selects.yml +11 -0
  227. data/test/fixtures/reserved_words/group.yml +14 -0
  228. data/test/fixtures/reserved_words/select.yml +8 -0
  229. data/test/fixtures/reserved_words/values.yml +7 -0
  230. data/test/fixtures/ships.yml +5 -0
  231. data/test/fixtures/sponsors.yml +9 -0
  232. data/test/fixtures/subscribers.yml +7 -0
  233. data/test/fixtures/subscriptions.yml +12 -0
  234. data/test/fixtures/taggings.yml +28 -0
  235. data/test/fixtures/tags.yml +7 -0
  236. data/test/fixtures/tasks.yml +7 -0
  237. data/test/fixtures/topics.yml +42 -0
  238. data/test/fixtures/toys.yml +4 -0
  239. data/test/fixtures/treasures.yml +10 -0
  240. data/test/fixtures/vertices.yml +4 -0
  241. data/test/fixtures/warehouse-things.yml +3 -0
  242. data/test/migrations/broken/100_migration_that_raises_exception.rb +10 -0
  243. data/test/migrations/decimal/1_give_me_big_numbers.rb +15 -0
  244. data/test/migrations/duplicate/1_people_have_last_names.rb +9 -0
  245. data/test/migrations/duplicate/2_we_need_reminders.rb +12 -0
  246. data/test/migrations/duplicate/3_foo.rb +7 -0
  247. data/test/migrations/duplicate/3_innocent_jointable.rb +12 -0
  248. data/test/migrations/duplicate_names/20080507052938_chunky.rb +7 -0
  249. data/test/migrations/duplicate_names/20080507053028_chunky.rb +7 -0
  250. data/test/migrations/interleaved/pass_1/3_innocent_jointable.rb +12 -0
  251. data/test/migrations/interleaved/pass_2/1_people_have_last_names.rb +9 -0
  252. data/test/migrations/interleaved/pass_2/3_innocent_jointable.rb +12 -0
  253. data/test/migrations/interleaved/pass_3/1_people_have_last_names.rb +9 -0
  254. data/test/migrations/interleaved/pass_3/2_i_raise_on_down.rb +8 -0
  255. data/test/migrations/interleaved/pass_3/3_innocent_jointable.rb +12 -0
  256. data/test/migrations/missing/1000_people_have_middle_names.rb +9 -0
  257. data/test/migrations/missing/1_people_have_last_names.rb +9 -0
  258. data/test/migrations/missing/3_we_need_reminders.rb +12 -0
  259. data/test/migrations/missing/4_innocent_jointable.rb +12 -0
  260. data/test/migrations/valid/1_people_have_last_names.rb +9 -0
  261. data/test/migrations/valid/2_we_need_reminders.rb +12 -0
  262. data/test/migrations/valid/3_innocent_jointable.rb +12 -0
  263. data/test/models/author.rb +146 -0
  264. data/test/models/auto_id.rb +4 -0
  265. data/test/models/binary.rb +2 -0
  266. data/test/models/bird.rb +3 -0
  267. data/test/models/book.rb +4 -0
  268. data/test/models/categorization.rb +5 -0
  269. data/test/models/category.rb +34 -0
  270. data/test/models/citation.rb +6 -0
  271. data/test/models/club.rb +13 -0
  272. data/test/models/column_name.rb +3 -0
  273. data/test/models/comment.rb +29 -0
  274. data/test/models/company.rb +171 -0
  275. data/test/models/company_in_module.rb +61 -0
  276. data/test/models/computer.rb +3 -0
  277. data/test/models/contact.rb +16 -0
  278. data/test/models/contract.rb +5 -0
  279. data/test/models/course.rb +3 -0
  280. data/test/models/customer.rb +73 -0
  281. data/test/models/default.rb +2 -0
  282. data/test/models/developer.rb +101 -0
  283. data/test/models/edge.rb +5 -0
  284. data/test/models/entrant.rb +3 -0
  285. data/test/models/essay.rb +3 -0
  286. data/test/models/event.rb +3 -0
  287. data/test/models/guid.rb +2 -0
  288. data/test/models/item.rb +7 -0
  289. data/test/models/job.rb +5 -0
  290. data/test/models/joke.rb +3 -0
  291. data/test/models/keyboard.rb +3 -0
  292. data/test/models/legacy_thing.rb +3 -0
  293. data/test/models/matey.rb +4 -0
  294. data/test/models/member.rb +12 -0
  295. data/test/models/member_detail.rb +5 -0
  296. data/test/models/member_type.rb +3 -0
  297. data/test/models/membership.rb +9 -0
  298. data/test/models/minimalistic.rb +2 -0
  299. data/test/models/mixed_case_monkey.rb +3 -0
  300. data/test/models/movie.rb +5 -0
  301. data/test/models/order.rb +4 -0
  302. data/test/models/organization.rb +6 -0
  303. data/test/models/owner.rb +5 -0
  304. data/test/models/parrot.rb +16 -0
  305. data/test/models/person.rb +16 -0
  306. data/test/models/pet.rb +5 -0
  307. data/test/models/pirate.rb +70 -0
  308. data/test/models/post.rb +100 -0
  309. data/test/models/price_estimate.rb +3 -0
  310. data/test/models/project.rb +30 -0
  311. data/test/models/reader.rb +4 -0
  312. data/test/models/reference.rb +4 -0
  313. data/test/models/reply.rb +46 -0
  314. data/test/models/ship.rb +10 -0
  315. data/test/models/ship_part.rb +5 -0
  316. data/test/models/sponsor.rb +4 -0
  317. data/test/models/subject.rb +4 -0
  318. data/test/models/subscriber.rb +8 -0
  319. data/test/models/subscription.rb +4 -0
  320. data/test/models/tag.rb +7 -0
  321. data/test/models/tagging.rb +10 -0
  322. data/test/models/task.rb +3 -0
  323. data/test/models/topic.rb +80 -0
  324. data/test/models/toy.rb +6 -0
  325. data/test/models/treasure.rb +8 -0
  326. data/test/models/vertex.rb +9 -0
  327. data/test/models/warehouse_thing.rb +5 -0
  328. data/test/schema/mysql_specific_schema.rb +24 -0
  329. data/test/schema/postgresql_specific_schema.rb +114 -0
  330. data/test/schema/schema.rb +493 -0
  331. data/test/schema/schema2.rb +6 -0
  332. data/test/schema/sqlite_specific_schema.rb +25 -0
  333. metadata +420 -0
@@ -0,0 +1,3171 @@
1
+ require 'yaml'
2
+ require 'set'
3
+
4
+ module ActiveRecord #:nodoc:
5
+ # Generic Active Record exception class.
6
+ class ActiveRecordError < StandardError
7
+ end
8
+
9
+ # Raised when the single-table inheritance mechanism fails to locate the subclass
10
+ # (for example due to improper usage of column that +inheritance_column+ points to).
11
+ class SubclassNotFound < ActiveRecordError #:nodoc:
12
+ end
13
+
14
+ # Raised when an object assigned to an association has an incorrect type.
15
+ #
16
+ # class Ticket < ActiveRecord::Base
17
+ # has_many :patches
18
+ # end
19
+ #
20
+ # class Patch < ActiveRecord::Base
21
+ # belongs_to :ticket
22
+ # end
23
+ #
24
+ # # Comments are not patches, this assignment raises AssociationTypeMismatch.
25
+ # @ticket.patches << Comment.new(:content => "Please attach tests to your patch.")
26
+ class AssociationTypeMismatch < ActiveRecordError
27
+ end
28
+
29
+ # Raised when unserialized object's type mismatches one specified for serializable field.
30
+ class SerializationTypeMismatch < ActiveRecordError
31
+ end
32
+
33
+ # Raised when adapter not specified on connection (or configuration file <tt>config/database.yml</tt> misses adapter field).
34
+ class AdapterNotSpecified < ActiveRecordError
35
+ end
36
+
37
+ # Raised when Active Record cannot find database adapter specified in <tt>config/database.yml</tt> or programmatically.
38
+ class AdapterNotFound < ActiveRecordError
39
+ end
40
+
41
+ # Raised when connection to the database could not been established (for example when <tt>connection=</tt> is given a nil object).
42
+ class ConnectionNotEstablished < ActiveRecordError
43
+ end
44
+
45
+ # Raised when Active Record cannot find record by given id or set of ids.
46
+ class RecordNotFound < ActiveRecordError
47
+ end
48
+
49
+ # Raised by ActiveRecord::Base.save! and ActiveRecord::Base.create! methods when record cannot be
50
+ # saved because record is invalid.
51
+ class RecordNotSaved < ActiveRecordError
52
+ end
53
+
54
+ # Raised when SQL statement cannot be executed by the database (for example, it's often the case for MySQL when Ruby driver used is too old).
55
+ class StatementInvalid < ActiveRecordError
56
+ end
57
+
58
+ # Raised when number of bind variables in statement given to <tt>:condition</tt> key (for example, when using +find+ method)
59
+ # does not match number of expected variables.
60
+ #
61
+ # For example, in
62
+ #
63
+ # Location.find :all, :conditions => ["lat = ? AND lng = ?", 53.7362]
64
+ #
65
+ # two placeholders are given but only one variable to fill them.
66
+ class PreparedStatementInvalid < ActiveRecordError
67
+ end
68
+
69
+ # Raised on attempt to save stale record. Record is stale when it's being saved in another query after
70
+ # instantiation, for example, when two users edit the same wiki page and one starts editing and saves
71
+ # the page before the other.
72
+ #
73
+ # Read more about optimistic locking in ActiveRecord::Locking module RDoc.
74
+ class StaleObjectError < ActiveRecordError
75
+ end
76
+
77
+ # Raised when association is being configured improperly or
78
+ # user tries to use offset and limit together with has_many or has_and_belongs_to_many associations.
79
+ class ConfigurationError < ActiveRecordError
80
+ end
81
+
82
+ # Raised on attempt to update record that is instantiated as read only.
83
+ class ReadOnlyRecord < ActiveRecordError
84
+ end
85
+
86
+ # ActiveRecord::Transactions::ClassMethods.transaction uses this exception
87
+ # to distinguish a deliberate rollback from other exceptional situations.
88
+ # Normally, raising an exception will cause the +transaction+ method to rollback
89
+ # the database transaction *and* pass on the exception. But if you raise an
90
+ # ActiveRecord::Rollback exception, then the database transaction will be rolled back,
91
+ # without passing on the exception.
92
+ #
93
+ # For example, you could do this in your controller to rollback a transaction:
94
+ #
95
+ # class BooksController < ActionController::Base
96
+ # def create
97
+ # Book.transaction do
98
+ # book = Book.new(params[:book])
99
+ # book.save!
100
+ # if today_is_friday?
101
+ # # The system must fail on Friday so that our support department
102
+ # # won't be out of job. We silently rollback this transaction
103
+ # # without telling the user.
104
+ # raise ActiveRecord::Rollback, "Call tech support!"
105
+ # end
106
+ # end
107
+ # # ActiveRecord::Rollback is the only exception that won't be passed on
108
+ # # by ActiveRecord::Base.transaction, so this line will still be reached
109
+ # # even on Friday.
110
+ # redirect_to root_url
111
+ # end
112
+ # end
113
+ class Rollback < ActiveRecordError
114
+ end
115
+
116
+ # Raised when attribute has a name reserved by Active Record (when attribute has name of one of Active Record instance methods).
117
+ class DangerousAttributeError < ActiveRecordError
118
+ end
119
+
120
+ # Raised when you've tried to access a column which wasn't loaded by your finder.
121
+ # Typically this is because <tt>:select</tt> has been specified.
122
+ class MissingAttributeError < NoMethodError
123
+ end
124
+
125
+ # Raised when unknown attributes are supplied via mass assignment.
126
+ class UnknownAttributeError < NoMethodError
127
+ end
128
+
129
+ # Raised when an error occurred while doing a mass assignment to an attribute through the
130
+ # <tt>attributes=</tt> method. The exception has an +attribute+ property that is the name of the
131
+ # offending attribute.
132
+ class AttributeAssignmentError < ActiveRecordError
133
+ attr_reader :exception, :attribute
134
+ def initialize(message, exception, attribute)
135
+ @exception = exception
136
+ @attribute = attribute
137
+ @message = message
138
+ end
139
+ end
140
+
141
+ # Raised when there are multiple errors while doing a mass assignment through the +attributes+
142
+ # method. The exception has an +errors+ property that contains an array of AttributeAssignmentError
143
+ # objects, each corresponding to the error while assigning to an attribute.
144
+ class MultiparameterAssignmentErrors < ActiveRecordError
145
+ attr_reader :errors
146
+ def initialize(errors)
147
+ @errors = errors
148
+ end
149
+ end
150
+
151
+ # Active Record objects don't specify their attributes directly, but rather infer them from the table definition with
152
+ # which they're linked. Adding, removing, and changing attributes and their type is done directly in the database. Any change
153
+ # is instantly reflected in the Active Record objects. The mapping that binds a given Active Record class to a certain
154
+ # database table will happen automatically in most common cases, but can be overwritten for the uncommon ones.
155
+ #
156
+ # See the mapping rules in table_name and the full example in link:files/README.html for more insight.
157
+ #
158
+ # == Creation
159
+ #
160
+ # Active Records accept constructor parameters either in a hash or as a block. The hash method is especially useful when
161
+ # you're receiving the data from somewhere else, like an HTTP request. It works like this:
162
+ #
163
+ # user = User.new(:name => "David", :occupation => "Code Artist")
164
+ # user.name # => "David"
165
+ #
166
+ # You can also use block initialization:
167
+ #
168
+ # user = User.new do |u|
169
+ # u.name = "David"
170
+ # u.occupation = "Code Artist"
171
+ # end
172
+ #
173
+ # And of course you can just create a bare object and specify the attributes after the fact:
174
+ #
175
+ # user = User.new
176
+ # user.name = "David"
177
+ # user.occupation = "Code Artist"
178
+ #
179
+ # == Conditions
180
+ #
181
+ # Conditions can either be specified as a string, array, or hash representing the WHERE-part of an SQL statement.
182
+ # The array form is to be used when the condition input is tainted and requires sanitization. The string form can
183
+ # be used for statements that don't involve tainted data. The hash form works much like the array form, except
184
+ # only equality and range is possible. Examples:
185
+ #
186
+ # class User < ActiveRecord::Base
187
+ # def self.authenticate_unsafely(user_name, password)
188
+ # find(:first, :conditions => "user_name = '#{user_name}' AND password = '#{password}'")
189
+ # end
190
+ #
191
+ # def self.authenticate_safely(user_name, password)
192
+ # find(:first, :conditions => [ "user_name = ? AND password = ?", user_name, password ])
193
+ # end
194
+ #
195
+ # def self.authenticate_safely_simply(user_name, password)
196
+ # find(:first, :conditions => { :user_name => user_name, :password => password })
197
+ # end
198
+ # end
199
+ #
200
+ # The <tt>authenticate_unsafely</tt> method inserts the parameters directly into the query and is thus susceptible to SQL-injection
201
+ # attacks if the <tt>user_name</tt> and +password+ parameters come directly from an HTTP request. The <tt>authenticate_safely</tt> and
202
+ # <tt>authenticate_safely_simply</tt> both will sanitize the <tt>user_name</tt> and +password+ before inserting them in the query,
203
+ # which will ensure that an attacker can't escape the query and fake the login (or worse).
204
+ #
205
+ # When using multiple parameters in the conditions, it can easily become hard to read exactly what the fourth or fifth
206
+ # question mark is supposed to represent. In those cases, you can resort to named bind variables instead. That's done by replacing
207
+ # the question marks with symbols and supplying a hash with values for the matching symbol keys:
208
+ #
209
+ # Company.find(:first, :conditions => [
210
+ # "id = :id AND name = :name AND division = :division AND created_at > :accounting_date",
211
+ # { :id => 3, :name => "37signals", :division => "First", :accounting_date => '2005-01-01' }
212
+ # ])
213
+ #
214
+ # Similarly, a simple hash without a statement will generate conditions based on equality with the SQL AND
215
+ # operator. For instance:
216
+ #
217
+ # Student.find(:all, :conditions => { :first_name => "Harvey", :status => 1 })
218
+ # Student.find(:all, :conditions => params[:student])
219
+ #
220
+ # A range may be used in the hash to use the SQL BETWEEN operator:
221
+ #
222
+ # Student.find(:all, :conditions => { :grade => 9..12 })
223
+ #
224
+ # An array may be used in the hash to use the SQL IN operator:
225
+ #
226
+ # Student.find(:all, :conditions => { :grade => [9,11,12] })
227
+ #
228
+ # == Overwriting default accessors
229
+ #
230
+ # All column values are automatically available through basic accessors on the Active Record object, but sometimes you
231
+ # want to specialize this behavior. This can be done by overwriting the default accessors (using the same
232
+ # name as the attribute) and calling <tt>read_attribute(attr_name)</tt> and <tt>write_attribute(attr_name, value)</tt> to actually change things.
233
+ # Example:
234
+ #
235
+ # class Song < ActiveRecord::Base
236
+ # # Uses an integer of seconds to hold the length of the song
237
+ #
238
+ # def length=(minutes)
239
+ # write_attribute(:length, minutes.to_i * 60)
240
+ # end
241
+ #
242
+ # def length
243
+ # read_attribute(:length) / 60
244
+ # end
245
+ # end
246
+ #
247
+ # You can alternatively use <tt>self[:attribute]=(value)</tt> and <tt>self[:attribute]</tt> instead of <tt>write_attribute(:attribute, value)</tt> and
248
+ # <tt>read_attribute(:attribute)</tt> as a shorter form.
249
+ #
250
+ # == Attribute query methods
251
+ #
252
+ # In addition to the basic accessors, query methods are also automatically available on the Active Record object.
253
+ # Query methods allow you to test whether an attribute value is present.
254
+ #
255
+ # For example, an Active Record User with the <tt>name</tt> attribute has a <tt>name?</tt> method that you can call
256
+ # to determine whether the user has a name:
257
+ #
258
+ # user = User.new(:name => "David")
259
+ # user.name? # => true
260
+ #
261
+ # anonymous = User.new(:name => "")
262
+ # anonymous.name? # => false
263
+ #
264
+ # == Accessing attributes before they have been typecasted
265
+ #
266
+ # Sometimes you want to be able to read the raw attribute data without having the column-determined typecast run its course first.
267
+ # That can be done by using the <tt><attribute>_before_type_cast</tt> accessors that all attributes have. For example, if your Account model
268
+ # has a <tt>balance</tt> attribute, you can call <tt>account.balance_before_type_cast</tt> or <tt>account.id_before_type_cast</tt>.
269
+ #
270
+ # This is especially useful in validation situations where the user might supply a string for an integer field and you want to display
271
+ # the original string back in an error message. Accessing the attribute normally would typecast the string to 0, which isn't what you
272
+ # want.
273
+ #
274
+ # == Dynamic attribute-based finders
275
+ #
276
+ # Dynamic attribute-based finders are a cleaner way of getting (and/or creating) objects by simple queries without turning to SQL. They work by
277
+ # appending the name of an attribute to <tt>find_by_</tt>, <tt>find_last_by_</tt>, or <tt>find_all_by_</tt>, so you get finders like <tt>Person.find_by_user_name</tt>,
278
+ # <tt>Person.find_all_by_last_name</tt>, and <tt>Payment.find_by_transaction_id</tt>. So instead of writing
279
+ # <tt>Person.find(:first, :conditions => ["user_name = ?", user_name])</tt>, you just do <tt>Person.find_by_user_name(user_name)</tt>.
280
+ # And instead of writing <tt>Person.find(:all, :conditions => ["last_name = ?", last_name])</tt>, you just do <tt>Person.find_all_by_last_name(last_name)</tt>.
281
+ #
282
+ # It's also possible to use multiple attributes in the same find by separating them with "_and_", so you get finders like
283
+ # <tt>Person.find_by_user_name_and_password</tt> or even <tt>Payment.find_by_purchaser_and_state_and_country</tt>. So instead of writing
284
+ # <tt>Person.find(:first, :conditions => ["user_name = ? AND password = ?", user_name, password])</tt>, you just do
285
+ # <tt>Person.find_by_user_name_and_password(user_name, password)</tt>.
286
+ #
287
+ # It's even possible to use all the additional parameters to find. For example, the full interface for <tt>Payment.find_all_by_amount</tt>
288
+ # is actually <tt>Payment.find_all_by_amount(amount, options)</tt>. And the full interface to <tt>Person.find_by_user_name</tt> is
289
+ # actually <tt>Person.find_by_user_name(user_name, options)</tt>. So you could call <tt>Payment.find_all_by_amount(50, :order => "created_on")</tt>.
290
+ # Also you may call <tt>Payment.find_last_by_amount(amount, options)</tt> returning the last record matching that amount and options.
291
+ #
292
+ # The same dynamic finder style can be used to create the object if it doesn't already exist. This dynamic finder is called with
293
+ # <tt>find_or_create_by_</tt> and will return the object if it already exists and otherwise creates it, then returns it. Protected attributes won't be set unless they are given in a block. For example:
294
+ #
295
+ # # No 'Summer' tag exists
296
+ # Tag.find_or_create_by_name("Summer") # equal to Tag.create(:name => "Summer")
297
+ #
298
+ # # Now the 'Summer' tag does exist
299
+ # Tag.find_or_create_by_name("Summer") # equal to Tag.find_by_name("Summer")
300
+ #
301
+ # # Now 'Bob' exist and is an 'admin'
302
+ # User.find_or_create_by_name('Bob', :age => 40) { |u| u.admin = true }
303
+ #
304
+ # Use the <tt>find_or_initialize_by_</tt> finder if you want to return a new record without saving it first. Protected attributes won't be set unless they are given in a block. For example:
305
+ #
306
+ # # No 'Winter' tag exists
307
+ # winter = Tag.find_or_initialize_by_name("Winter")
308
+ # winter.new_record? # true
309
+ #
310
+ # To find by a subset of the attributes to be used for instantiating a new object, pass a hash instead of
311
+ # a list of parameters. For example:
312
+ #
313
+ # Tag.find_or_create_by_name(:name => "rails", :creator => current_user)
314
+ #
315
+ # That will either find an existing tag named "rails", or create a new one while setting the user that created it.
316
+ #
317
+ # == Saving arrays, hashes, and other non-mappable objects in text columns
318
+ #
319
+ # Active Record can serialize any object in text columns using YAML. To do so, you must specify this with a call to the class method +serialize+.
320
+ # This makes it possible to store arrays, hashes, and other non-mappable objects without doing any additional work. Example:
321
+ #
322
+ # class User < ActiveRecord::Base
323
+ # serialize :preferences
324
+ # end
325
+ #
326
+ # user = User.create(:preferences => { "background" => "black", "display" => large })
327
+ # User.find(user.id).preferences # => { "background" => "black", "display" => large }
328
+ #
329
+ # You can also specify a class option as the second parameter that'll raise an exception if a serialized object is retrieved as a
330
+ # descendant of a class not in the hierarchy. Example:
331
+ #
332
+ # class User < ActiveRecord::Base
333
+ # serialize :preferences, Hash
334
+ # end
335
+ #
336
+ # user = User.create(:preferences => %w( one two three ))
337
+ # User.find(user.id).preferences # raises SerializationTypeMismatch
338
+ #
339
+ # == Single table inheritance
340
+ #
341
+ # Active Record allows inheritance by storing the name of the class in a column that by default is named "type" (can be changed
342
+ # by overwriting <tt>Base.inheritance_column</tt>). This means that an inheritance looking like this:
343
+ #
344
+ # class Company < ActiveRecord::Base; end
345
+ # class Firm < Company; end
346
+ # class Client < Company; end
347
+ # class PriorityClient < Client; end
348
+ #
349
+ # When you do <tt>Firm.create(:name => "37signals")</tt>, this record will be saved in the companies table with type = "Firm". You can then
350
+ # fetch this row again using <tt>Company.find(:first, "name = '37signals'")</tt> and it will return a Firm object.
351
+ #
352
+ # If you don't have a type column defined in your table, single-table inheritance won't be triggered. In that case, it'll work just
353
+ # like normal subclasses with no special magic for differentiating between them or reloading the right type with find.
354
+ #
355
+ # Note, all the attributes for all the cases are kept in the same table. Read more:
356
+ # http://www.martinfowler.com/eaaCatalog/singleTableInheritance.html
357
+ #
358
+ # == Connection to multiple databases in different models
359
+ #
360
+ # Connections are usually created through ActiveRecord::Base.establish_connection and retrieved by ActiveRecord::Base.connection.
361
+ # All classes inheriting from ActiveRecord::Base will use this connection. But you can also set a class-specific connection.
362
+ # For example, if Course is an ActiveRecord::Base, but resides in a different database, you can just say <tt>Course.establish_connection</tt>
363
+ # and Course and all of its subclasses will use this connection instead.
364
+ #
365
+ # This feature is implemented by keeping a connection pool in ActiveRecord::Base that is a Hash indexed by the class. If a connection is
366
+ # requested, the retrieve_connection method will go up the class-hierarchy until a connection is found in the connection pool.
367
+ #
368
+ # == Exceptions
369
+ #
370
+ # * ActiveRecordError - Generic error class and superclass of all other errors raised by Active Record.
371
+ # * AdapterNotSpecified - The configuration hash used in <tt>establish_connection</tt> didn't include an
372
+ # <tt>:adapter</tt> key.
373
+ # * AdapterNotFound - The <tt>:adapter</tt> key used in <tt>establish_connection</tt> specified a non-existent adapter
374
+ # (or a bad spelling of an existing one).
375
+ # * AssociationTypeMismatch - The object assigned to the association wasn't of the type specified in the association definition.
376
+ # * SerializationTypeMismatch - The serialized object wasn't of the class specified as the second parameter.
377
+ # * ConnectionNotEstablished+ - No connection has been established. Use <tt>establish_connection</tt> before querying.
378
+ # * RecordNotFound - No record responded to the +find+ method. Either the row with the given ID doesn't exist
379
+ # or the row didn't meet the additional restrictions. Some +find+ calls do not raise this exception to signal
380
+ # nothing was found, please check its documentation for further details.
381
+ # * StatementInvalid - The database server rejected the SQL statement. The precise error is added in the message.
382
+ # * MultiparameterAssignmentErrors - Collection of errors that occurred during a mass assignment using the
383
+ # <tt>attributes=</tt> method. The +errors+ property of this exception contains an array of AttributeAssignmentError
384
+ # objects that should be inspected to determine which attributes triggered the errors.
385
+ # * AttributeAssignmentError - An error occurred while doing a mass assignment through the <tt>attributes=</tt> method.
386
+ # You can inspect the +attribute+ property of the exception object to determine which attribute triggered the error.
387
+ #
388
+ # *Note*: The attributes listed are class-level attributes (accessible from both the class and instance level).
389
+ # So it's possible to assign a logger to the class through <tt>Base.logger=</tt> which will then be used by all
390
+ # instances in the current object space.
391
+ class Base
392
+ ##
393
+ # :singleton-method:
394
+ # Accepts a logger conforming to the interface of Log4r or the default Ruby 1.8+ Logger class, which is then passed
395
+ # on to any new database connections made and which can be retrieved on both a class and instance level by calling +logger+.
396
+ cattr_accessor :logger, :instance_writer => false
397
+
398
+ def self.inherited(child) #:nodoc:
399
+ @@subclasses[self] ||= []
400
+ @@subclasses[self] << child
401
+ super
402
+ end
403
+
404
+ def self.reset_subclasses #:nodoc:
405
+ nonreloadables = []
406
+ subclasses.each do |klass|
407
+ unless ActiveSupport::Dependencies.autoloaded? klass
408
+ nonreloadables << klass
409
+ next
410
+ end
411
+ klass.instance_variables.each { |var| klass.send(:remove_instance_variable, var) }
412
+ klass.instance_methods(false).each { |m| klass.send :undef_method, m }
413
+ end
414
+ @@subclasses = {}
415
+ nonreloadables.each { |klass| (@@subclasses[klass.superclass] ||= []) << klass }
416
+ end
417
+
418
+ @@subclasses = {}
419
+
420
+ ##
421
+ # :singleton-method:
422
+ # Contains the database configuration - as is typically stored in config/database.yml -
423
+ # as a Hash.
424
+ #
425
+ # For example, the following database.yml...
426
+ #
427
+ # development:
428
+ # adapter: sqlite3
429
+ # database: db/development.sqlite3
430
+ #
431
+ # production:
432
+ # adapter: sqlite3
433
+ # database: db/production.sqlite3
434
+ #
435
+ # ...would result in ActiveRecord::Base.configurations to look like this:
436
+ #
437
+ # {
438
+ # 'development' => {
439
+ # 'adapter' => 'sqlite3',
440
+ # 'database' => 'db/development.sqlite3'
441
+ # },
442
+ # 'production' => {
443
+ # 'adapter' => 'sqlite3',
444
+ # 'database' => 'db/production.sqlite3'
445
+ # }
446
+ # }
447
+ cattr_accessor :configurations, :instance_writer => false
448
+ @@configurations = {}
449
+
450
+ ##
451
+ # :singleton-method:
452
+ # Accessor for the prefix type that will be prepended to every primary key column name. The options are :table_name and
453
+ # :table_name_with_underscore. If the first is specified, the Product class will look for "productid" instead of "id" as
454
+ # the primary column. If the latter is specified, the Product class will look for "product_id" instead of "id". Remember
455
+ # that this is a global setting for all Active Records.
456
+ cattr_accessor :primary_key_prefix_type, :instance_writer => false
457
+ @@primary_key_prefix_type = nil
458
+
459
+ ##
460
+ # :singleton-method:
461
+ # Accessor for the name of the prefix string to prepend to every table name. So if set to "basecamp_", all
462
+ # table names will be named like "basecamp_projects", "basecamp_people", etc. This is a convenient way of creating a namespace
463
+ # for tables in a shared database. By default, the prefix is the empty string.
464
+ cattr_accessor :table_name_prefix, :instance_writer => false
465
+ @@table_name_prefix = ""
466
+
467
+ ##
468
+ # :singleton-method:
469
+ # Works like +table_name_prefix+, but appends instead of prepends (set to "_basecamp" gives "projects_basecamp",
470
+ # "people_basecamp"). By default, the suffix is the empty string.
471
+ cattr_accessor :table_name_suffix, :instance_writer => false
472
+ @@table_name_suffix = ""
473
+
474
+ ##
475
+ # :singleton-method:
476
+ # Indicates whether table names should be the pluralized versions of the corresponding class names.
477
+ # If true, the default table name for a Product class will be +products+. If false, it would just be +product+.
478
+ # See table_name for the full rules on table/class naming. This is true, by default.
479
+ cattr_accessor :pluralize_table_names, :instance_writer => false
480
+ @@pluralize_table_names = true
481
+
482
+ ##
483
+ # :singleton-method:
484
+ # Determines whether to use ANSI codes to colorize the logging statements committed by the connection adapter. These colors
485
+ # make it much easier to overview things during debugging (when used through a reader like +tail+ and on a black background), but
486
+ # may complicate matters if you use software like syslog. This is true, by default.
487
+ cattr_accessor :colorize_logging, :instance_writer => false
488
+ @@colorize_logging = true
489
+
490
+ ##
491
+ # :singleton-method:
492
+ # Determines whether to use Time.local (using :local) or Time.utc (using :utc) when pulling dates and times from the database.
493
+ # This is set to :local by default.
494
+ cattr_accessor :default_timezone, :instance_writer => false
495
+ @@default_timezone = :local
496
+
497
+ ##
498
+ # :singleton-method:
499
+ # Specifies the format to use when dumping the database schema with Rails'
500
+ # Rakefile. If :sql, the schema is dumped as (potentially database-
501
+ # specific) SQL statements. If :ruby, the schema is dumped as an
502
+ # ActiveRecord::Schema file which can be loaded into any database that
503
+ # supports migrations. Use :ruby if you want to have different database
504
+ # adapters for, e.g., your development and test environments.
505
+ cattr_accessor :schema_format , :instance_writer => false
506
+ @@schema_format = :ruby
507
+
508
+ ##
509
+ # :singleton-method:
510
+ # Specify whether or not to use timestamps for migration numbers
511
+ cattr_accessor :timestamped_migrations , :instance_writer => false
512
+ @@timestamped_migrations = true
513
+
514
+ # Determine whether to store the full constant name including namespace when using STI
515
+ superclass_delegating_accessor :store_full_sti_class
516
+ self.store_full_sti_class = false
517
+
518
+ # Stores the default scope for the class
519
+ class_inheritable_accessor :default_scoping, :instance_writer => false
520
+ self.default_scoping = []
521
+
522
+ class << self # Class methods
523
+ # Find operates with four different retrieval approaches:
524
+ #
525
+ # * Find by id - This can either be a specific id (1), a list of ids (1, 5, 6), or an array of ids ([5, 6, 10]).
526
+ # If no record can be found for all of the listed ids, then RecordNotFound will be raised.
527
+ # * Find first - This will return the first record matched by the options used. These options can either be specific
528
+ # conditions or merely an order. If no record can be matched, +nil+ is returned. Use
529
+ # <tt>Model.find(:first, *args)</tt> or its shortcut <tt>Model.first(*args)</tt>.
530
+ # * Find last - This will return the last record matched by the options used. These options can either be specific
531
+ # conditions or merely an order. If no record can be matched, +nil+ is returned. Use
532
+ # <tt>Model.find(:last, *args)</tt> or its shortcut <tt>Model.last(*args)</tt>.
533
+ # * Find all - This will return all the records matched by the options used.
534
+ # If no records are found, an empty array is returned. Use
535
+ # <tt>Model.find(:all, *args)</tt> or its shortcut <tt>Model.all(*args)</tt>.
536
+ #
537
+ # All approaches accept an options hash as their last parameter.
538
+ #
539
+ # ==== Parameters
540
+ #
541
+ # * <tt>:conditions</tt> - An SQL fragment like "administrator = 1", <tt>[ "user_name = ?", username ]</tt>, or <tt>["user_name = :user_name", { :user_name => user_name }]</tt>. See conditions in the intro.
542
+ # * <tt>:order</tt> - An SQL fragment like "created_at DESC, name".
543
+ # * <tt>:group</tt> - An attribute name by which the result should be grouped. Uses the <tt>GROUP BY</tt> SQL-clause.
544
+ # * <tt>:having</tt> - Combined with +:group+ this can be used to filter the records that a <tt>GROUP BY</tt> returns. Uses the <tt>HAVING</tt> SQL-clause.
545
+ # * <tt>:limit</tt> - An integer determining the limit on the number of rows that should be returned.
546
+ # * <tt>:offset</tt> - An integer determining the offset from where the rows should be fetched. So at 5, it would skip rows 0 through 4.
547
+ # * <tt>:joins</tt> - Either an SQL fragment for additional joins like "LEFT JOIN comments ON comments.post_id = id" (rarely needed),
548
+ # named associations in the same form used for the <tt>:include</tt> option, which will perform an <tt>INNER JOIN</tt> on the associated table(s),
549
+ # or an array containing a mixture of both strings and named associations.
550
+ # If the value is a string, then the records will be returned read-only since they will have attributes that do not correspond to the table's columns.
551
+ # Pass <tt>:readonly => false</tt> to override.
552
+ # * <tt>:include</tt> - Names associations that should be loaded alongside. The symbols named refer
553
+ # to already defined associations. See eager loading under Associations.
554
+ # * <tt>:select</tt> - By default, this is "*" as in "SELECT * FROM", but can be changed if you, for example, want to do a join but not
555
+ # include the joined columns. Takes a string with the SELECT SQL fragment (e.g. "id, name").
556
+ # * <tt>:from</tt> - By default, this is the table name of the class, but can be changed to an alternate table name (or even the name
557
+ # of a database view).
558
+ # * <tt>:readonly</tt> - Mark the returned records read-only so they cannot be saved or updated.
559
+ # * <tt>:lock</tt> - An SQL fragment like "FOR UPDATE" or "LOCK IN SHARE MODE".
560
+ # <tt>:lock => true</tt> gives connection's default exclusive lock, usually "FOR UPDATE".
561
+ #
562
+ # ==== Examples
563
+ #
564
+ # # find by id
565
+ # Person.find(1) # returns the object for ID = 1
566
+ # Person.find(1, 2, 6) # returns an array for objects with IDs in (1, 2, 6)
567
+ # Person.find([7, 17]) # returns an array for objects with IDs in (7, 17)
568
+ # Person.find([1]) # returns an array for the object with ID = 1
569
+ # Person.find(1, :conditions => "administrator = 1", :order => "created_on DESC")
570
+ #
571
+ # Note that returned records may not be in the same order as the ids you
572
+ # provide since database rows are unordered. Give an explicit <tt>:order</tt>
573
+ # to ensure the results are sorted.
574
+ #
575
+ # ==== Examples
576
+ #
577
+ # # find first
578
+ # Person.find(:first) # returns the first object fetched by SELECT * FROM people
579
+ # Person.find(:first, :conditions => [ "user_name = ?", user_name])
580
+ # Person.find(:first, :conditions => [ "user_name = :u", { :u => user_name }])
581
+ # Person.find(:first, :order => "created_on DESC", :offset => 5)
582
+ #
583
+ # # find last
584
+ # Person.find(:last) # returns the last object fetched by SELECT * FROM people
585
+ # Person.find(:last, :conditions => [ "user_name = ?", user_name])
586
+ # Person.find(:last, :order => "created_on DESC", :offset => 5)
587
+ #
588
+ # # find all
589
+ # Person.find(:all) # returns an array of objects for all the rows fetched by SELECT * FROM people
590
+ # Person.find(:all, :conditions => [ "category IN (?)", categories], :limit => 50)
591
+ # Person.find(:all, :conditions => { :friends => ["Bob", "Steve", "Fred"] }
592
+ # Person.find(:all, :offset => 10, :limit => 10)
593
+ # Person.find(:all, :include => [ :account, :friends ])
594
+ # Person.find(:all, :group => "category")
595
+ #
596
+ # Example for find with a lock: Imagine two concurrent transactions:
597
+ # each will read <tt>person.visits == 2</tt>, add 1 to it, and save, resulting
598
+ # in two saves of <tt>person.visits = 3</tt>. By locking the row, the second
599
+ # transaction has to wait until the first is finished; we get the
600
+ # expected <tt>person.visits == 4</tt>.
601
+ #
602
+ # Person.transaction do
603
+ # person = Person.find(1, :lock => true)
604
+ # person.visits += 1
605
+ # person.save!
606
+ # end
607
+ def find(*args)
608
+ options = args.extract_options!
609
+ validate_find_options(options)
610
+ set_readonly_option!(options)
611
+
612
+ case args.first
613
+ when :first then find_initial(options)
614
+ when :last then find_last(options)
615
+ when :all then find_every(options)
616
+ else find_from_ids(args, options)
617
+ end
618
+ end
619
+
620
+ # A convenience wrapper for <tt>find(:first, *args)</tt>. You can pass in all the
621
+ # same arguments to this method as you can to <tt>find(:first)</tt>.
622
+ def first(*args)
623
+ find(:first, *args)
624
+ end
625
+
626
+ # A convenience wrapper for <tt>find(:last, *args)</tt>. You can pass in all the
627
+ # same arguments to this method as you can to <tt>find(:last)</tt>.
628
+ def last(*args)
629
+ find(:last, *args)
630
+ end
631
+
632
+ # This is an alias for find(:all). You can pass in all the same arguments to this method as you can
633
+ # to find(:all)
634
+ def all(*args)
635
+ find(:all, *args)
636
+ end
637
+
638
+ # Executes a custom SQL query against your database and returns all the results. The results will
639
+ # be returned as an array with columns requested encapsulated as attributes of the model you call
640
+ # this method from. If you call <tt>Product.find_by_sql</tt> then the results will be returned in
641
+ # a Product object with the attributes you specified in the SQL query.
642
+ #
643
+ # If you call a complicated SQL query which spans multiple tables the columns specified by the
644
+ # SELECT will be attributes of the model, whether or not they are columns of the corresponding
645
+ # table.
646
+ #
647
+ # The +sql+ parameter is a full SQL query as a string. It will be called as is, there will be
648
+ # no database agnostic conversions performed. This should be a last resort because using, for example,
649
+ # MySQL specific terms will lock you to using that particular database engine or require you to
650
+ # change your call if you switch engines.
651
+ #
652
+ # ==== Examples
653
+ # # A simple SQL query spanning multiple tables
654
+ # Post.find_by_sql "SELECT p.title, c.author FROM posts p, comments c WHERE p.id = c.post_id"
655
+ # > [#<Post:0x36bff9c @attributes={"title"=>"Ruby Meetup", "first_name"=>"Quentin"}>, ...]
656
+ #
657
+ # # You can use the same string replacement techniques as you can with ActiveRecord#find
658
+ # Post.find_by_sql ["SELECT title FROM posts WHERE author = ? AND created > ?", author_id, start_date]
659
+ # > [#<Post:0x36bff9c @attributes={"first_name"=>"The Cheap Man Buys Twice"}>, ...]
660
+ def find_by_sql(sql)
661
+ connection.select_all(sanitize_sql(sql), "#{name} Load").collect! { |record| instantiate(record) }
662
+ end
663
+
664
+ # Returns true if a record exists in the table that matches the +id+ or
665
+ # conditions given, or false otherwise. The argument can take five forms:
666
+ #
667
+ # * Integer - Finds the record with this primary key.
668
+ # * String - Finds the record with a primary key corresponding to this
669
+ # string (such as <tt>'5'</tt>).
670
+ # * Array - Finds the record that matches these +find+-style conditions
671
+ # (such as <tt>['color = ?', 'red']</tt>).
672
+ # * Hash - Finds the record that matches these +find+-style conditions
673
+ # (such as <tt>{:color => 'red'}</tt>).
674
+ # * No args - Returns false if the table is empty, true otherwise.
675
+ #
676
+ # For more information about specifying conditions as a Hash or Array,
677
+ # see the Conditions section in the introduction to ActiveRecord::Base.
678
+ #
679
+ # Note: You can't pass in a condition as a string (like <tt>name =
680
+ # 'Jamie'</tt>), since it would be sanitized and then queried against
681
+ # the primary key column, like <tt>id = 'name = \'Jamie\''</tt>.
682
+ #
683
+ # ==== Examples
684
+ # Person.exists?(5)
685
+ # Person.exists?('5')
686
+ # Person.exists?(:name => "David")
687
+ # Person.exists?(['name LIKE ?', "%#{query}%"])
688
+ # Person.exists?
689
+ def exists?(id_or_conditions = {})
690
+ find_initial(
691
+ :select => "#{quoted_table_name}.#{primary_key}",
692
+ :conditions => expand_id_conditions(id_or_conditions)) ? true : false
693
+ end
694
+
695
+ # Creates an object (or multiple objects) and saves it to the database, if validations pass.
696
+ # The resulting object is returned whether the object was saved successfully to the database or not.
697
+ #
698
+ # The +attributes+ parameter can be either be a Hash or an Array of Hashes. These Hashes describe the
699
+ # attributes on the objects that are to be created.
700
+ #
701
+ # ==== Examples
702
+ # # Create a single new object
703
+ # User.create(:first_name => 'Jamie')
704
+ #
705
+ # # Create an Array of new objects
706
+ # User.create([{ :first_name => 'Jamie' }, { :first_name => 'Jeremy' }])
707
+ #
708
+ # # Create a single object and pass it into a block to set other attributes.
709
+ # User.create(:first_name => 'Jamie') do |u|
710
+ # u.is_admin = false
711
+ # end
712
+ #
713
+ # # Creating an Array of new objects using a block, where the block is executed for each object:
714
+ # User.create([{ :first_name => 'Jamie' }, { :first_name => 'Jeremy' }]) do |u|
715
+ # u.is_admin = false
716
+ # end
717
+ def create(attributes = nil, &block)
718
+ if attributes.is_a?(Array)
719
+ attributes.collect { |attr| create(attr, &block) }
720
+ else
721
+ object = new(attributes)
722
+ yield(object) if block_given?
723
+ object.save
724
+ object
725
+ end
726
+ end
727
+
728
+ # Updates an object (or multiple objects) and saves it to the database, if validations pass.
729
+ # The resulting object is returned whether the object was saved successfully to the database or not.
730
+ #
731
+ # ==== Parameters
732
+ #
733
+ # * +id+ - This should be the id or an array of ids to be updated.
734
+ # * +attributes+ - This should be a hash of attributes to be set on the object, or an array of hashes.
735
+ #
736
+ # ==== Examples
737
+ #
738
+ # # Updating one record:
739
+ # Person.update(15, :user_name => 'Samuel', :group => 'expert')
740
+ #
741
+ # # Updating multiple records:
742
+ # people = { 1 => { "first_name" => "David" }, 2 => { "first_name" => "Jeremy" } }
743
+ # Person.update(people.keys, people.values)
744
+ def update(id, attributes)
745
+ if id.is_a?(Array)
746
+ idx = -1
747
+ id.collect { |one_id| idx += 1; update(one_id, attributes[idx]) }
748
+ else
749
+ object = find(id)
750
+ object.update_attributes(attributes)
751
+ object
752
+ end
753
+ end
754
+
755
+ # Deletes the row with a primary key matching the +id+ argument, using a
756
+ # SQL +DELETE+ statement, and returns the number of rows deleted. Active
757
+ # Record objects are not instantiated, so the object's callbacks are not
758
+ # executed, including any <tt>:dependent</tt> association options or
759
+ # Observer methods.
760
+ #
761
+ # You can delete multiple rows at once by passing an Array of <tt>id</tt>s.
762
+ #
763
+ # Note: Although it is often much faster than the alternative,
764
+ # <tt>#destroy</tt>, skipping callbacks might bypass business logic in
765
+ # your application that ensures referential integrity or performs other
766
+ # essential jobs.
767
+ #
768
+ # ==== Examples
769
+ #
770
+ # # Delete a single row
771
+ # Todo.delete(1)
772
+ #
773
+ # # Delete multiple rows
774
+ # Todo.delete([2,3,4])
775
+ def delete(id)
776
+ delete_all([ "#{connection.quote_column_name(primary_key)} IN (?)", id ])
777
+ end
778
+
779
+ # Destroy an object (or multiple objects) that has the given id, the object is instantiated first,
780
+ # therefore all callbacks and filters are fired off before the object is deleted. This method is
781
+ # less efficient than ActiveRecord#delete but allows cleanup methods and other actions to be run.
782
+ #
783
+ # This essentially finds the object (or multiple objects) with the given id, creates a new object
784
+ # from the attributes, and then calls destroy on it.
785
+ #
786
+ # ==== Parameters
787
+ #
788
+ # * +id+ - Can be either an Integer or an Array of Integers.
789
+ #
790
+ # ==== Examples
791
+ #
792
+ # # Destroy a single object
793
+ # Todo.destroy(1)
794
+ #
795
+ # # Destroy multiple objects
796
+ # todos = [1,2,3]
797
+ # Todo.destroy(todos)
798
+ def destroy(id)
799
+ if id.is_a?(Array)
800
+ id.map { |one_id| destroy(one_id) }
801
+ else
802
+ find(id).destroy
803
+ end
804
+ end
805
+
806
+ # Updates all records with details given if they match a set of conditions supplied, limits and order can
807
+ # also be supplied. This method constructs a single SQL UPDATE statement and sends it straight to the
808
+ # database. It does not instantiate the involved models and it does not trigger Active Record callbacks.
809
+ #
810
+ # ==== Parameters
811
+ #
812
+ # * +updates+ - A string of column and value pairs that will be set on any records that match conditions. This creates the SET clause of the generated SQL.
813
+ # * +conditions+ - An SQL fragment like "administrator = 1" or [ "user_name = ?", username ]. See conditions in the intro for more info.
814
+ # * +options+ - Additional options are <tt>:limit</tt> and <tt>:order</tt>, see the examples for usage.
815
+ #
816
+ # ==== Examples
817
+ #
818
+ # # Update all billing objects with the 3 different attributes given
819
+ # Billing.update_all( "category = 'authorized', approved = 1, author = 'David'" )
820
+ #
821
+ # # Update records that match our conditions
822
+ # Billing.update_all( "author = 'David'", "title LIKE '%Rails%'" )
823
+ #
824
+ # # Update records that match our conditions but limit it to 5 ordered by date
825
+ # Billing.update_all( "author = 'David'", "title LIKE '%Rails%'",
826
+ # :order => 'created_at', :limit => 5 )
827
+ def update_all(updates, conditions = nil, options = {})
828
+ sql = "UPDATE #{quoted_table_name} SET #{sanitize_sql_for_assignment(updates)} "
829
+
830
+ scope = scope(:find)
831
+
832
+ select_sql = ""
833
+ add_conditions!(select_sql, conditions, scope)
834
+
835
+ if options.has_key?(:limit) || (scope && scope[:limit])
836
+ # Only take order from scope if limit is also provided by scope, this
837
+ # is useful for updating a has_many association with a limit.
838
+ add_order!(select_sql, options[:order], scope)
839
+
840
+ add_limit!(select_sql, options, scope)
841
+ sql.concat(connection.limited_update_conditions(select_sql, quoted_table_name, connection.quote_column_name(primary_key)))
842
+ else
843
+ add_order!(select_sql, options[:order], nil)
844
+ sql.concat(select_sql)
845
+ end
846
+
847
+ connection.update(sql, "#{name} Update")
848
+ end
849
+
850
+ # Destroys the records matching +conditions+ by instantiating each
851
+ # record and calling its +destroy+ method. Each object's callbacks are
852
+ # executed (including <tt>:dependent</tt> association options and
853
+ # +before_destroy+/+after_destroy+ Observer methods). Returns the
854
+ # collection of objects that were destroyed; each will be frozen, to
855
+ # reflect that no changes should be made (since they can't be
856
+ # persisted).
857
+ #
858
+ # Note: Instantiation, callback execution, and deletion of each
859
+ # record can be time consuming when you're removing many records at
860
+ # once. It generates at least one SQL +DELETE+ query per record (or
861
+ # possibly more, to enforce your callbacks). If you want to delete many
862
+ # rows quickly, without concern for their associations or callbacks, use
863
+ # +delete_all+ instead.
864
+ #
865
+ # ==== Parameters
866
+ #
867
+ # * +conditions+ - A string, array, or hash that specifies which records
868
+ # to destroy. If omitted, all records are destroyed. See the
869
+ # Conditions section in the introduction to ActiveRecord::Base for
870
+ # more information.
871
+ #
872
+ # ==== Examples
873
+ #
874
+ # Person.destroy_all("last_login < '2004-04-04'")
875
+ # Person.destroy_all(:status => "inactive")
876
+ def destroy_all(conditions = nil)
877
+ find(:all, :conditions => conditions).each { |object| object.destroy }
878
+ end
879
+
880
+ # Deletes the records matching +conditions+ without instantiating the records first, and hence not
881
+ # calling the +destroy+ method nor invoking callbacks. This is a single SQL DELETE statement that
882
+ # goes straight to the database, much more efficient than +destroy_all+. Be careful with relations
883
+ # though, in particular <tt>:dependent</tt> rules defined on associations are not honored. Returns
884
+ # the number of rows affected.
885
+ #
886
+ # ==== Parameters
887
+ #
888
+ # * +conditions+ - Conditions are specified the same way as with +find+ method.
889
+ #
890
+ # ==== Example
891
+ #
892
+ # Post.delete_all("person_id = 5 AND (category = 'Something' OR category = 'Else')")
893
+ # Post.delete_all(["person_id = ? AND (category = ? OR category = ?)", 5, 'Something', 'Else'])
894
+ #
895
+ # Both calls delete the affected posts all at once with a single DELETE statement. If you need to destroy dependent
896
+ # associations or call your <tt>before_*</tt> or +after_destroy+ callbacks, use the +destroy_all+ method instead.
897
+ def delete_all(conditions = nil)
898
+ sql = "DELETE FROM #{quoted_table_name} "
899
+ add_conditions!(sql, conditions, scope(:find))
900
+ connection.delete(sql, "#{name} Delete all")
901
+ end
902
+
903
+ # Returns the result of an SQL statement that should only include a COUNT(*) in the SELECT part.
904
+ # The use of this method should be restricted to complicated SQL queries that can't be executed
905
+ # using the ActiveRecord::Calculations class methods. Look into those before using this.
906
+ #
907
+ # ==== Parameters
908
+ #
909
+ # * +sql+ - An SQL statement which should return a count query from the database, see the example below.
910
+ #
911
+ # ==== Examples
912
+ #
913
+ # Product.count_by_sql "SELECT COUNT(*) FROM sales s, customers c WHERE s.customer_id = c.id"
914
+ def count_by_sql(sql)
915
+ sql = sanitize_conditions(sql)
916
+ connection.select_value(sql, "#{name} Count").to_i
917
+ end
918
+
919
+ # A generic "counter updater" implementation, intended primarily to be
920
+ # used by increment_counter and decrement_counter, but which may also
921
+ # be useful on its own. It simply does a direct SQL update for the record
922
+ # with the given ID, altering the given hash of counters by the amount
923
+ # given by the corresponding value:
924
+ #
925
+ # ==== Parameters
926
+ #
927
+ # * +id+ - The id of the object you wish to update a counter on or an Array of ids.
928
+ # * +counters+ - An Array of Hashes containing the names of the fields
929
+ # to update as keys and the amount to update the field by as values.
930
+ #
931
+ # ==== Examples
932
+ #
933
+ # # For the Post with id of 5, decrement the comment_count by 1, and
934
+ # # increment the action_count by 1
935
+ # Post.update_counters 5, :comment_count => -1, :action_count => 1
936
+ # # Executes the following SQL:
937
+ # # UPDATE posts
938
+ # # SET comment_count = comment_count - 1,
939
+ # # action_count = action_count + 1
940
+ # # WHERE id = 5
941
+ #
942
+ # # For the Posts with id of 10 and 15, increment the comment_count by 1
943
+ # Post.update_counters [10, 15], :comment_count => 1
944
+ # # Executes the following SQL:
945
+ # # UPDATE posts
946
+ # # SET comment_count = comment_count + 1,
947
+ # # WHERE id IN (10, 15)
948
+ def update_counters(id, counters)
949
+ updates = counters.inject([]) { |list, (counter_name, increment)|
950
+ sign = increment < 0 ? "-" : "+"
951
+ list << "#{connection.quote_column_name(counter_name)} = COALESCE(#{connection.quote_column_name(counter_name)}, 0) #{sign} #{increment.abs}"
952
+ }.join(", ")
953
+
954
+ if id.is_a?(Array)
955
+ ids_list = id.map {|i| quote_value(i)}.join(', ')
956
+ condition = "IN (#{ids_list})"
957
+ else
958
+ condition = "= #{quote_value(id)}"
959
+ end
960
+
961
+ update_all(updates, "#{connection.quote_column_name(primary_key)} #{condition}")
962
+ end
963
+
964
+ # Increment a number field by one, usually representing a count.
965
+ #
966
+ # This is used for caching aggregate values, so that they don't need to be computed every time.
967
+ # For example, a DiscussionBoard may cache post_count and comment_count otherwise every time the board is
968
+ # shown it would have to run an SQL query to find how many posts and comments there are.
969
+ #
970
+ # ==== Parameters
971
+ #
972
+ # * +counter_name+ - The name of the field that should be incremented.
973
+ # * +id+ - The id of the object that should be incremented.
974
+ #
975
+ # ==== Examples
976
+ #
977
+ # # Increment the post_count column for the record with an id of 5
978
+ # DiscussionBoard.increment_counter(:post_count, 5)
979
+ def increment_counter(counter_name, id)
980
+ update_counters(id, counter_name => 1)
981
+ end
982
+
983
+ # Decrement a number field by one, usually representing a count.
984
+ #
985
+ # This works the same as increment_counter but reduces the column value by 1 instead of increasing it.
986
+ #
987
+ # ==== Parameters
988
+ #
989
+ # * +counter_name+ - The name of the field that should be decremented.
990
+ # * +id+ - The id of the object that should be decremented.
991
+ #
992
+ # ==== Examples
993
+ #
994
+ # # Decrement the post_count column for the record with an id of 5
995
+ # DiscussionBoard.decrement_counter(:post_count, 5)
996
+ def decrement_counter(counter_name, id)
997
+ update_counters(id, counter_name => -1)
998
+ end
999
+
1000
+ # Attributes named in this macro are protected from mass-assignment,
1001
+ # such as <tt>new(attributes)</tt>,
1002
+ # <tt>update_attributes(attributes)</tt>, or
1003
+ # <tt>attributes=(attributes)</tt>.
1004
+ #
1005
+ # Mass-assignment to these attributes will simply be ignored, to assign
1006
+ # to them you can use direct writer methods. This is meant to protect
1007
+ # sensitive attributes from being overwritten by malicious users
1008
+ # tampering with URLs or forms.
1009
+ #
1010
+ # class Customer < ActiveRecord::Base
1011
+ # attr_protected :credit_rating
1012
+ # end
1013
+ #
1014
+ # customer = Customer.new("name" => David, "credit_rating" => "Excellent")
1015
+ # customer.credit_rating # => nil
1016
+ # customer.attributes = { "description" => "Jolly fellow", "credit_rating" => "Superb" }
1017
+ # customer.credit_rating # => nil
1018
+ #
1019
+ # customer.credit_rating = "Average"
1020
+ # customer.credit_rating # => "Average"
1021
+ #
1022
+ # To start from an all-closed default and enable attributes as needed,
1023
+ # have a look at +attr_accessible+.
1024
+ def attr_protected(*attributes)
1025
+ write_inheritable_attribute(:attr_protected, Set.new(attributes.map(&:to_s)) + (protected_attributes || []))
1026
+ end
1027
+
1028
+ # Returns an array of all the attributes that have been protected from mass-assignment.
1029
+ def protected_attributes # :nodoc:
1030
+ read_inheritable_attribute(:attr_protected)
1031
+ end
1032
+
1033
+ # Specifies a white list of model attributes that can be set via
1034
+ # mass-assignment, such as <tt>new(attributes)</tt>,
1035
+ # <tt>update_attributes(attributes)</tt>, or
1036
+ # <tt>attributes=(attributes)</tt>
1037
+ #
1038
+ # This is the opposite of the +attr_protected+ macro: Mass-assignment
1039
+ # will only set attributes in this list, to assign to the rest of
1040
+ # attributes you can use direct writer methods. This is meant to protect
1041
+ # sensitive attributes from being overwritten by malicious users
1042
+ # tampering with URLs or forms. If you'd rather start from an all-open
1043
+ # default and restrict attributes as needed, have a look at
1044
+ # +attr_protected+.
1045
+ #
1046
+ # class Customer < ActiveRecord::Base
1047
+ # attr_accessible :name, :nickname
1048
+ # end
1049
+ #
1050
+ # customer = Customer.new(:name => "David", :nickname => "Dave", :credit_rating => "Excellent")
1051
+ # customer.credit_rating # => nil
1052
+ # customer.attributes = { :name => "Jolly fellow", :credit_rating => "Superb" }
1053
+ # customer.credit_rating # => nil
1054
+ #
1055
+ # customer.credit_rating = "Average"
1056
+ # customer.credit_rating # => "Average"
1057
+ def attr_accessible(*attributes)
1058
+ write_inheritable_attribute(:attr_accessible, Set.new(attributes.map(&:to_s)) + (accessible_attributes || []))
1059
+ end
1060
+
1061
+ # Returns an array of all the attributes that have been made accessible to mass-assignment.
1062
+ def accessible_attributes # :nodoc:
1063
+ read_inheritable_attribute(:attr_accessible)
1064
+ end
1065
+
1066
+ # Attributes listed as readonly can be set for a new record, but will be ignored in database updates afterwards.
1067
+ def attr_readonly(*attributes)
1068
+ write_inheritable_attribute(:attr_readonly, Set.new(attributes.map(&:to_s)) + (readonly_attributes || []))
1069
+ end
1070
+
1071
+ # Returns an array of all the attributes that have been specified as readonly.
1072
+ def readonly_attributes
1073
+ read_inheritable_attribute(:attr_readonly)
1074
+ end
1075
+
1076
+ # If you have an attribute that needs to be saved to the database as an object, and retrieved as the same object,
1077
+ # then specify the name of that attribute using this method and it will be handled automatically.
1078
+ # The serialization is done through YAML. If +class_name+ is specified, the serialized object must be of that
1079
+ # class on retrieval or SerializationTypeMismatch will be raised.
1080
+ #
1081
+ # ==== Parameters
1082
+ #
1083
+ # * +attr_name+ - The field name that should be serialized.
1084
+ # * +class_name+ - Optional, class name that the object type should be equal to.
1085
+ #
1086
+ # ==== Example
1087
+ # # Serialize a preferences attribute
1088
+ # class User
1089
+ # serialize :preferences
1090
+ # end
1091
+ def serialize(attr_name, class_name = Object)
1092
+ serialized_attributes[attr_name.to_s] = class_name
1093
+ end
1094
+
1095
+ # Returns a hash of all the attributes that have been specified for serialization as keys and their class restriction as values.
1096
+ def serialized_attributes
1097
+ read_inheritable_attribute(:attr_serialized) or write_inheritable_attribute(:attr_serialized, {})
1098
+ end
1099
+
1100
+ # Guesses the table name (in forced lower-case) based on the name of the class in the inheritance hierarchy descending
1101
+ # directly from ActiveRecord::Base. So if the hierarchy looks like: Reply < Message < ActiveRecord::Base, then Message is used
1102
+ # to guess the table name even when called on Reply. The rules used to do the guess are handled by the Inflector class
1103
+ # in Active Support, which knows almost all common English inflections. You can add new inflections in config/initializers/inflections.rb.
1104
+ #
1105
+ # Nested classes are given table names prefixed by the singular form of
1106
+ # the parent's table name. Enclosing modules are not considered.
1107
+ #
1108
+ # ==== Examples
1109
+ #
1110
+ # class Invoice < ActiveRecord::Base; end;
1111
+ # file class table_name
1112
+ # invoice.rb Invoice invoices
1113
+ #
1114
+ # class Invoice < ActiveRecord::Base; class Lineitem < ActiveRecord::Base; end; end;
1115
+ # file class table_name
1116
+ # invoice.rb Invoice::Lineitem invoice_lineitems
1117
+ #
1118
+ # module Invoice; class Lineitem < ActiveRecord::Base; end; end;
1119
+ # file class table_name
1120
+ # invoice/lineitem.rb Invoice::Lineitem lineitems
1121
+ #
1122
+ # Additionally, the class-level +table_name_prefix+ is prepended and the
1123
+ # +table_name_suffix+ is appended. So if you have "myapp_" as a prefix,
1124
+ # the table name guess for an Invoice class becomes "myapp_invoices".
1125
+ # Invoice::Lineitem becomes "myapp_invoice_lineitems".
1126
+ #
1127
+ # You can also overwrite this class method to allow for unguessable
1128
+ # links, such as a Mouse class with a link to a "mice" table. Example:
1129
+ #
1130
+ # class Mouse < ActiveRecord::Base
1131
+ # set_table_name "mice"
1132
+ # end
1133
+ def table_name
1134
+ reset_table_name
1135
+ end
1136
+
1137
+ def reset_table_name #:nodoc:
1138
+ base = base_class
1139
+
1140
+ name =
1141
+ # STI subclasses always use their superclass' table.
1142
+ unless self == base
1143
+ base.table_name
1144
+ else
1145
+ # Nested classes are prefixed with singular parent table name.
1146
+ if parent < ActiveRecord::Base && !parent.abstract_class?
1147
+ contained = parent.table_name
1148
+ contained = contained.singularize if parent.pluralize_table_names
1149
+ contained << '_'
1150
+ end
1151
+ name = "#{table_name_prefix}#{contained}#{undecorated_table_name(base.name)}#{table_name_suffix}"
1152
+ end
1153
+
1154
+ set_table_name(name)
1155
+ name
1156
+ end
1157
+
1158
+ # Defines the primary key field -- can be overridden in subclasses. Overwriting will negate any effect of the
1159
+ # primary_key_prefix_type setting, though.
1160
+ def primary_key
1161
+ reset_primary_key
1162
+ end
1163
+
1164
+ def reset_primary_key #:nodoc:
1165
+ key = get_primary_key(base_class.name)
1166
+ set_primary_key(key)
1167
+ key
1168
+ end
1169
+
1170
+ def get_primary_key(base_name) #:nodoc:
1171
+ key = 'id'
1172
+ case primary_key_prefix_type
1173
+ when :table_name
1174
+ key = base_name.to_s.foreign_key(false)
1175
+ when :table_name_with_underscore
1176
+ key = base_name.to_s.foreign_key
1177
+ end
1178
+ key
1179
+ end
1180
+
1181
+ # Defines the column name for use with single table inheritance
1182
+ # -- can be set in subclasses like so: self.inheritance_column = "type_id"
1183
+ def inheritance_column
1184
+ @inheritance_column ||= "type".freeze
1185
+ end
1186
+
1187
+ # Lazy-set the sequence name to the connection's default. This method
1188
+ # is only ever called once since set_sequence_name overrides it.
1189
+ def sequence_name #:nodoc:
1190
+ reset_sequence_name
1191
+ end
1192
+
1193
+ def reset_sequence_name #:nodoc:
1194
+ default = connection.default_sequence_name(table_name, primary_key)
1195
+ set_sequence_name(default)
1196
+ default
1197
+ end
1198
+
1199
+ # Sets the table name to use to the given value, or (if the value
1200
+ # is nil or false) to the value returned by the given block.
1201
+ #
1202
+ # class Project < ActiveRecord::Base
1203
+ # set_table_name "project"
1204
+ # end
1205
+ def set_table_name(value = nil, &block)
1206
+ define_attr_method :table_name, value, &block
1207
+ end
1208
+ alias :table_name= :set_table_name
1209
+
1210
+ # Sets the name of the primary key column to use to the given value,
1211
+ # or (if the value is nil or false) to the value returned by the given
1212
+ # block.
1213
+ #
1214
+ # class Project < ActiveRecord::Base
1215
+ # set_primary_key "sysid"
1216
+ # end
1217
+ def set_primary_key(value = nil, &block)
1218
+ define_attr_method :primary_key, value, &block
1219
+ end
1220
+ alias :primary_key= :set_primary_key
1221
+
1222
+ # Sets the name of the inheritance column to use to the given value,
1223
+ # or (if the value # is nil or false) to the value returned by the
1224
+ # given block.
1225
+ #
1226
+ # class Project < ActiveRecord::Base
1227
+ # set_inheritance_column do
1228
+ # original_inheritance_column + "_id"
1229
+ # end
1230
+ # end
1231
+ def set_inheritance_column(value = nil, &block)
1232
+ define_attr_method :inheritance_column, value, &block
1233
+ end
1234
+ alias :inheritance_column= :set_inheritance_column
1235
+
1236
+ # Sets the name of the sequence to use when generating ids to the given
1237
+ # value, or (if the value is nil or false) to the value returned by the
1238
+ # given block. This is required for Oracle and is useful for any
1239
+ # database which relies on sequences for primary key generation.
1240
+ #
1241
+ # If a sequence name is not explicitly set when using Oracle or Firebird,
1242
+ # it will default to the commonly used pattern of: #{table_name}_seq
1243
+ #
1244
+ # If a sequence name is not explicitly set when using PostgreSQL, it
1245
+ # will discover the sequence corresponding to your primary key for you.
1246
+ #
1247
+ # class Project < ActiveRecord::Base
1248
+ # set_sequence_name "projectseq" # default would have been "project_seq"
1249
+ # end
1250
+ def set_sequence_name(value = nil, &block)
1251
+ define_attr_method :sequence_name, value, &block
1252
+ end
1253
+ alias :sequence_name= :set_sequence_name
1254
+
1255
+ # Turns the +table_name+ back into a class name following the reverse rules of +table_name+.
1256
+ def class_name(table_name = table_name) # :nodoc:
1257
+ # remove any prefix and/or suffix from the table name
1258
+ class_name = table_name[table_name_prefix.length..-(table_name_suffix.length + 1)].camelize
1259
+ class_name = class_name.singularize if pluralize_table_names
1260
+ class_name
1261
+ end
1262
+
1263
+ # Indicates whether the table associated with this class exists
1264
+ def table_exists?
1265
+ connection.table_exists?(table_name)
1266
+ end
1267
+
1268
+ # Returns an array of column objects for the table associated with this class.
1269
+ def columns
1270
+ unless defined?(@columns) && @columns
1271
+ @columns = connection.columns(table_name, "#{name} Columns")
1272
+ @columns.each { |column| column.primary = column.name == primary_key }
1273
+ end
1274
+ @columns
1275
+ end
1276
+
1277
+ # Returns a hash of column objects for the table associated with this class.
1278
+ def columns_hash
1279
+ @columns_hash ||= columns.inject({}) { |hash, column| hash[column.name] = column; hash }
1280
+ end
1281
+
1282
+ # Returns an array of column names as strings.
1283
+ def column_names
1284
+ @column_names ||= columns.map { |column| column.name }
1285
+ end
1286
+
1287
+ # Returns an array of column objects where the primary id, all columns ending in "_id" or "_count",
1288
+ # and columns used for single table inheritance have been removed.
1289
+ def content_columns
1290
+ @content_columns ||= columns.reject { |c| c.primary || c.name =~ /(_id|_count)$/ || c.name == inheritance_column }
1291
+ end
1292
+
1293
+ # 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
1294
+ # 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
1295
+ # is available.
1296
+ def column_methods_hash #:nodoc:
1297
+ @dynamic_methods_hash ||= column_names.inject(Hash.new(false)) do |methods, attr|
1298
+ attr_name = attr.to_s
1299
+ methods[attr.to_sym] = attr_name
1300
+ methods["#{attr}=".to_sym] = attr_name
1301
+ methods["#{attr}?".to_sym] = attr_name
1302
+ methods["#{attr}_before_type_cast".to_sym] = attr_name
1303
+ methods
1304
+ end
1305
+ end
1306
+
1307
+ # Resets all the cached information about columns, which will cause them
1308
+ # to be reloaded on the next request.
1309
+ #
1310
+ # The most common usage pattern for this method is probably in a migration,
1311
+ # when just after creating a table you want to populate it with some default
1312
+ # values, eg:
1313
+ #
1314
+ # class CreateJobLevels < ActiveRecord::Migration
1315
+ # def self.up
1316
+ # create_table :job_levels do |t|
1317
+ # t.integer :id
1318
+ # t.string :name
1319
+ #
1320
+ # t.timestamps
1321
+ # end
1322
+ #
1323
+ # JobLevel.reset_column_information
1324
+ # %w{assistant executive manager director}.each do |type|
1325
+ # JobLevel.create(:name => type)
1326
+ # end
1327
+ # end
1328
+ #
1329
+ # def self.down
1330
+ # drop_table :job_levels
1331
+ # end
1332
+ # end
1333
+ def reset_column_information
1334
+ generated_methods.each { |name| undef_method(name) }
1335
+ @column_names = @columns = @columns_hash = @content_columns = @dynamic_methods_hash = @generated_methods = @inheritance_column = nil
1336
+ end
1337
+
1338
+ def reset_column_information_and_inheritable_attributes_for_all_subclasses#:nodoc:
1339
+ subclasses.each { |klass| klass.reset_inheritable_attributes; klass.reset_column_information }
1340
+ end
1341
+
1342
+ def self_and_descendants_from_active_record#nodoc:
1343
+ klass = self
1344
+ classes = [klass]
1345
+ while klass != klass.base_class
1346
+ classes << klass = klass.superclass
1347
+ end
1348
+ classes
1349
+ rescue
1350
+ # OPTIMIZE this rescue is to fix this test: ./test/cases/reflection_test.rb:56:in `test_human_name_for_column'
1351
+ # Appearantly the method base_class causes some trouble.
1352
+ # It now works for sure.
1353
+ [self]
1354
+ end
1355
+
1356
+ # Transforms attribute key names into a more humane format, such as "First name" instead of "first_name". Example:
1357
+ # Person.human_attribute_name("first_name") # => "First name"
1358
+ # This used to be depricated in favor of humanize, but is now preferred, because it automatically uses the I18n
1359
+ # module now.
1360
+ # Specify +options+ with additional translating options.
1361
+ def human_attribute_name(attribute_key_name, options = {})
1362
+ defaults = self_and_descendants_from_active_record.map do |klass|
1363
+ :"#{klass.name.underscore}.#{attribute_key_name}"
1364
+ end
1365
+ defaults << options[:default] if options[:default]
1366
+ defaults.flatten!
1367
+ defaults << attribute_key_name.to_s.humanize
1368
+ options[:count] ||= 1
1369
+ I18n.translate(defaults.shift, options.merge(:default => defaults, :scope => [:activerecord, :attributes]))
1370
+ end
1371
+
1372
+ # Transform the modelname into a more humane format, using I18n.
1373
+ # Defaults to the basic humanize method.
1374
+ # Default scope of the translation is activerecord.models
1375
+ # Specify +options+ with additional translating options.
1376
+ def human_name(options = {})
1377
+ defaults = self_and_descendants_from_active_record.map do |klass|
1378
+ :"#{klass.name.underscore}"
1379
+ end
1380
+ defaults << self.name.humanize
1381
+ I18n.translate(defaults.shift, {:scope => [:activerecord, :models], :count => 1, :default => defaults}.merge(options))
1382
+ end
1383
+
1384
+ # True if this isn't a concrete subclass needing a STI type condition.
1385
+ def descends_from_active_record?
1386
+ if superclass.abstract_class?
1387
+ superclass.descends_from_active_record?
1388
+ else
1389
+ superclass == Base || !columns_hash.include?(inheritance_column)
1390
+ end
1391
+ end
1392
+
1393
+ def finder_needs_type_condition? #:nodoc:
1394
+ # This is like this because benchmarking justifies the strange :false stuff
1395
+ :true == (@finder_needs_type_condition ||= descends_from_active_record? ? :false : :true)
1396
+ end
1397
+
1398
+ # Returns a string like 'Post id:integer, title:string, body:text'
1399
+ def inspect
1400
+ if self == Base
1401
+ super
1402
+ elsif abstract_class?
1403
+ "#{super}(abstract)"
1404
+ elsif table_exists?
1405
+ attr_list = columns.map { |c| "#{c.name}: #{c.type}" } * ', '
1406
+ "#{super}(#{attr_list})"
1407
+ else
1408
+ "#{super}(Table doesn't exist)"
1409
+ end
1410
+ end
1411
+
1412
+ def quote_value(value, column = nil) #:nodoc:
1413
+ connection.quote(value,column)
1414
+ end
1415
+
1416
+ # Used to sanitize objects before they're used in an SQL SELECT statement. Delegates to <tt>connection.quote</tt>.
1417
+ def sanitize(object) #:nodoc:
1418
+ connection.quote(object)
1419
+ end
1420
+
1421
+ # Log and benchmark multiple statements in a single block. Example:
1422
+ #
1423
+ # Project.benchmark("Creating project") do
1424
+ # project = Project.create("name" => "stuff")
1425
+ # project.create_manager("name" => "David")
1426
+ # project.milestones << Milestone.find(:all)
1427
+ # end
1428
+ #
1429
+ # The benchmark is only recorded if the current level of the logger is less than or equal to the <tt>log_level</tt>,
1430
+ # which makes it easy to include benchmarking statements in production software that will remain inexpensive because
1431
+ # the benchmark will only be conducted if the log level is low enough.
1432
+ #
1433
+ # The logging of the multiple statements is turned off unless <tt>use_silence</tt> is set to false.
1434
+ def benchmark(title, log_level = Logger::DEBUG, use_silence = true)
1435
+ if logger && logger.level <= log_level
1436
+ result = nil
1437
+ ms = Benchmark.ms { result = use_silence ? silence { yield } : yield }
1438
+ logger.add(log_level, '%s (%.1fms)' % [title, ms])
1439
+ result
1440
+ else
1441
+ yield
1442
+ end
1443
+ end
1444
+
1445
+ # Silences the logger for the duration of the block.
1446
+ def silence
1447
+ old_logger_level, logger.level = logger.level, Logger::ERROR if logger
1448
+ yield
1449
+ ensure
1450
+ logger.level = old_logger_level if logger
1451
+ end
1452
+
1453
+ # Overwrite the default class equality method to provide support for association proxies.
1454
+ def ===(object)
1455
+ object.is_a?(self)
1456
+ end
1457
+
1458
+ # Returns the base AR subclass that this class descends from. If A
1459
+ # extends AR::Base, A.base_class will return A. If B descends from A
1460
+ # through some arbitrarily deep hierarchy, B.base_class will return A.
1461
+ def base_class
1462
+ class_of_active_record_descendant(self)
1463
+ end
1464
+
1465
+ # Set this to true if this is an abstract class (see <tt>abstract_class?</tt>).
1466
+ attr_accessor :abstract_class
1467
+
1468
+ # Returns whether this class is a base AR class. If A is a base class and
1469
+ # B descends from A, then B.base_class will return B.
1470
+ def abstract_class?
1471
+ defined?(@abstract_class) && @abstract_class == true
1472
+ end
1473
+
1474
+ def respond_to?(method_id, include_private = false)
1475
+ if match = DynamicFinderMatch.match(method_id)
1476
+ return true if all_attributes_exists?(match.attribute_names)
1477
+ elsif match = DynamicScopeMatch.match(method_id)
1478
+ return true if all_attributes_exists?(match.attribute_names)
1479
+ end
1480
+
1481
+ super
1482
+ end
1483
+
1484
+ def sti_name
1485
+ store_full_sti_class ? name : name.demodulize
1486
+ end
1487
+
1488
+ # Merges conditions so that the result is a valid +condition+
1489
+ def merge_conditions(*conditions)
1490
+ segments = []
1491
+
1492
+ conditions.each do |condition|
1493
+ unless condition.blank?
1494
+ sql = sanitize_sql(condition)
1495
+ segments << sql unless sql.blank?
1496
+ end
1497
+ end
1498
+
1499
+ "(#{segments.join(') AND (')})" unless segments.empty?
1500
+ end
1501
+
1502
+ private
1503
+ def find_initial(options)
1504
+ options.update(:limit => 1)
1505
+ find_every(options).first
1506
+ end
1507
+
1508
+ def find_last(options)
1509
+ order = options[:order]
1510
+
1511
+ if order
1512
+ order = reverse_sql_order(order)
1513
+ elsif !scoped?(:find, :order)
1514
+ order = "#{table_name}.#{primary_key} DESC"
1515
+ end
1516
+
1517
+ if scoped?(:find, :order)
1518
+ scope = scope(:find)
1519
+ original_scoped_order = scope[:order]
1520
+ scope[:order] = reverse_sql_order(original_scoped_order)
1521
+ end
1522
+
1523
+ begin
1524
+ find_initial(options.merge({ :order => order }))
1525
+ ensure
1526
+ scope[:order] = original_scoped_order if original_scoped_order
1527
+ end
1528
+ end
1529
+
1530
+ def reverse_sql_order(order_query)
1531
+ reversed_query = order_query.to_s.split(/,/).each { |s|
1532
+ if s.match(/\s(asc|ASC)$/)
1533
+ s.gsub!(/\s(asc|ASC)$/, ' DESC')
1534
+ elsif s.match(/\s(desc|DESC)$/)
1535
+ s.gsub!(/\s(desc|DESC)$/, ' ASC')
1536
+ elsif !s.match(/\s(asc|ASC|desc|DESC)$/)
1537
+ s.concat(' DESC')
1538
+ end
1539
+ }.join(',')
1540
+ end
1541
+
1542
+ def find_every(options)
1543
+ include_associations = merge_includes(scope(:find, :include), options[:include])
1544
+
1545
+ if include_associations.any? && references_eager_loaded_tables?(options)
1546
+ records = find_with_associations(options)
1547
+ else
1548
+ records = find_by_sql(construct_finder_sql(options))
1549
+ if include_associations.any?
1550
+ preload_associations(records, include_associations)
1551
+ end
1552
+ end
1553
+
1554
+ records.each { |record| record.readonly! } if options[:readonly]
1555
+
1556
+ records
1557
+ end
1558
+
1559
+ def find_from_ids(ids, options)
1560
+ expects_array = ids.first.kind_of?(Array)
1561
+ return ids.first if expects_array && ids.first.empty?
1562
+
1563
+ ids = ids.flatten.compact.uniq
1564
+
1565
+ case ids.size
1566
+ when 0
1567
+ raise RecordNotFound, "Couldn't find #{name} without an ID"
1568
+ when 1
1569
+ result = find_one(ids.first, options)
1570
+ expects_array ? [ result ] : result
1571
+ else
1572
+ find_some(ids, options)
1573
+ end
1574
+ end
1575
+
1576
+ def find_one(id, options)
1577
+ conditions = " AND (#{sanitize_sql(options[:conditions])})" if options[:conditions]
1578
+ options.update :conditions => "#{quoted_table_name}.#{connection.quote_column_name(primary_key)} = #{quote_value(id,columns_hash[primary_key])}#{conditions}"
1579
+
1580
+ # Use find_every(options).first since the primary key condition
1581
+ # already ensures we have a single record. Using find_initial adds
1582
+ # a superfluous :limit => 1.
1583
+ if result = find_every(options).first
1584
+ result
1585
+ else
1586
+ raise RecordNotFound, "Couldn't find #{name} with ID=#{id}#{conditions}"
1587
+ end
1588
+ end
1589
+
1590
+ def find_some(ids, options)
1591
+ conditions = " AND (#{sanitize_sql(options[:conditions])})" if options[:conditions]
1592
+ ids_list = ids.map { |id| quote_value(id,columns_hash[primary_key]) }.join(',')
1593
+ options.update :conditions => "#{quoted_table_name}.#{connection.quote_column_name(primary_key)} IN (#{ids_list})#{conditions}"
1594
+
1595
+ result = find_every(options)
1596
+
1597
+ # Determine expected size from limit and offset, not just ids.size.
1598
+ expected_size =
1599
+ if options[:limit] && ids.size > options[:limit]
1600
+ options[:limit]
1601
+ else
1602
+ ids.size
1603
+ end
1604
+
1605
+ # 11 ids with limit 3, offset 9 should give 2 results.
1606
+ if options[:offset] && (ids.size - options[:offset] < expected_size)
1607
+ expected_size = ids.size - options[:offset]
1608
+ end
1609
+
1610
+ if result.size == expected_size
1611
+ result
1612
+ else
1613
+ raise RecordNotFound, "Couldn't find all #{name.pluralize} with IDs (#{ids_list})#{conditions} (found #{result.size} results, but was looking for #{expected_size})"
1614
+ end
1615
+ end
1616
+
1617
+ # Finder methods must instantiate through this method to work with the
1618
+ # single-table inheritance model that makes it possible to create
1619
+ # objects of different types from the same table.
1620
+ def instantiate(record)
1621
+ object =
1622
+ if subclass_name = record[inheritance_column]
1623
+ # No type given.
1624
+ if subclass_name.empty?
1625
+ allocate
1626
+
1627
+ else
1628
+ # Ignore type if no column is present since it was probably
1629
+ # pulled in from a sloppy join.
1630
+ unless columns_hash.include?(inheritance_column)
1631
+ allocate
1632
+
1633
+ else
1634
+ begin
1635
+ compute_type(subclass_name).allocate
1636
+ rescue NameError
1637
+ raise SubclassNotFound,
1638
+ "The single-table inheritance mechanism failed to locate the subclass: '#{record[inheritance_column]}'. " +
1639
+ "This error is raised because the column '#{inheritance_column}' is reserved for storing the class in case of inheritance. " +
1640
+ "Please rename this column if you didn't intend it to be used for storing the inheritance class " +
1641
+ "or overwrite #{self.to_s}.inheritance_column to use another column for that information."
1642
+ end
1643
+ end
1644
+ end
1645
+ else
1646
+ allocate
1647
+ end
1648
+
1649
+ object.instance_variable_set("@attributes", record)
1650
+ object.instance_variable_set("@attributes_cache", Hash.new)
1651
+
1652
+ if object.respond_to_without_attributes?(:after_find)
1653
+ object.send(:callback, :after_find)
1654
+ end
1655
+
1656
+ if object.respond_to_without_attributes?(:after_initialize)
1657
+ object.send(:callback, :after_initialize)
1658
+ end
1659
+
1660
+ object
1661
+ end
1662
+
1663
+ # Nest the type name in the same module as this class.
1664
+ # Bar is "MyApp::Business::Bar" relative to MyApp::Business::Foo
1665
+ def type_name_with_module(type_name)
1666
+ if store_full_sti_class
1667
+ type_name
1668
+ else
1669
+ (/^::/ =~ type_name) ? type_name : "#{parent.name}::#{type_name}"
1670
+ end
1671
+ end
1672
+
1673
+ def default_select(qualified)
1674
+ if qualified
1675
+ quoted_table_name + '.*'
1676
+ else
1677
+ '*'
1678
+ end
1679
+ end
1680
+
1681
+ def construct_finder_sql(options)
1682
+ scope = scope(:find)
1683
+ sql = "SELECT #{options[:select] || (scope && scope[:select]) || default_select(options[:joins] || (scope && scope[:joins]))} "
1684
+ sql << "FROM #{options[:from] || (scope && scope[:from]) || quoted_table_name} "
1685
+
1686
+ add_joins!(sql, options[:joins], scope)
1687
+ add_conditions!(sql, options[:conditions], scope)
1688
+
1689
+ add_group!(sql, options[:group], options[:having], scope)
1690
+ add_order!(sql, options[:order], scope)
1691
+ add_limit!(sql, options, scope)
1692
+ add_lock!(sql, options, scope)
1693
+
1694
+ sql
1695
+ end
1696
+
1697
+ # Merges includes so that the result is a valid +include+
1698
+ def merge_includes(first, second)
1699
+ (safe_to_array(first) + safe_to_array(second)).uniq
1700
+ end
1701
+
1702
+ def merge_joins(*joins)
1703
+ if joins.any?{|j| j.is_a?(String) || array_of_strings?(j) }
1704
+ joins = joins.collect do |join|
1705
+ join = [join] if join.is_a?(String)
1706
+ unless array_of_strings?(join)
1707
+ join_dependency = ActiveRecord::Associations::ClassMethods::InnerJoinDependency.new(self, join, nil)
1708
+ join = join_dependency.join_associations.collect { |assoc| assoc.association_join }
1709
+ end
1710
+ join
1711
+ end
1712
+ joins.flatten.map{|j| j.strip}.uniq
1713
+ else
1714
+ joins.collect{|j| safe_to_array(j)}.flatten.uniq
1715
+ end
1716
+ end
1717
+
1718
+ # Object#to_a is deprecated, though it does have the desired behavior
1719
+ def safe_to_array(o)
1720
+ case o
1721
+ when NilClass
1722
+ []
1723
+ when Array
1724
+ o
1725
+ else
1726
+ [o]
1727
+ end
1728
+ end
1729
+
1730
+ def array_of_strings?(o)
1731
+ o.is_a?(Array) && o.all?{|obj| obj.is_a?(String)}
1732
+ end
1733
+
1734
+ def add_order!(sql, order, scope = :auto)
1735
+ scope = scope(:find) if :auto == scope
1736
+ scoped_order = scope[:order] if scope
1737
+ if order
1738
+ sql << " ORDER BY #{order}"
1739
+ if scoped_order && scoped_order != order
1740
+ sql << ", #{scoped_order}"
1741
+ end
1742
+ else
1743
+ sql << " ORDER BY #{scoped_order}" if scoped_order
1744
+ end
1745
+ end
1746
+
1747
+ def add_group!(sql, group, having, scope = :auto)
1748
+ if group
1749
+ sql << " GROUP BY #{group}"
1750
+ sql << " HAVING #{sanitize_sql_for_conditions(having)}" if having
1751
+ else
1752
+ scope = scope(:find) if :auto == scope
1753
+ if scope && (scoped_group = scope[:group])
1754
+ sql << " GROUP BY #{scoped_group}"
1755
+ sql << " HAVING #{sanitize_sql_for_conditions(scope[:having])}" if scope[:having]
1756
+ end
1757
+ end
1758
+ end
1759
+
1760
+ # The optional scope argument is for the current <tt>:find</tt> scope.
1761
+ def add_limit!(sql, options, scope = :auto)
1762
+ scope = scope(:find) if :auto == scope
1763
+
1764
+ if scope
1765
+ options[:limit] ||= scope[:limit]
1766
+ options[:offset] ||= scope[:offset]
1767
+ end
1768
+
1769
+ connection.add_limit_offset!(sql, options)
1770
+ end
1771
+
1772
+ # The optional scope argument is for the current <tt>:find</tt> scope.
1773
+ # The <tt>:lock</tt> option has precedence over a scoped <tt>:lock</tt>.
1774
+ def add_lock!(sql, options, scope = :auto)
1775
+ scope = scope(:find) if :auto == scope
1776
+ options = options.reverse_merge(:lock => scope[:lock]) if scope
1777
+ connection.add_lock!(sql, options)
1778
+ end
1779
+
1780
+ # The optional scope argument is for the current <tt>:find</tt> scope.
1781
+ def add_joins!(sql, joins, scope = :auto)
1782
+ scope = scope(:find) if :auto == scope
1783
+ merged_joins = scope && scope[:joins] && joins ? merge_joins(scope[:joins], joins) : (joins || scope && scope[:joins])
1784
+ case merged_joins
1785
+ when Symbol, Hash, Array
1786
+ if array_of_strings?(merged_joins)
1787
+ sql << merged_joins.join(' ') + " "
1788
+ else
1789
+ join_dependency = ActiveRecord::Associations::ClassMethods::InnerJoinDependency.new(self, merged_joins, nil)
1790
+ sql << " #{join_dependency.join_associations.collect { |assoc| assoc.association_join }.join} "
1791
+ end
1792
+ when String
1793
+ sql << " #{merged_joins} "
1794
+ end
1795
+ end
1796
+
1797
+ # Adds a sanitized version of +conditions+ to the +sql+ string. Note that the passed-in +sql+ string is changed.
1798
+ # The optional scope argument is for the current <tt>:find</tt> scope.
1799
+ def add_conditions!(sql, conditions, scope = :auto)
1800
+ scope = scope(:find) if :auto == scope
1801
+ conditions = [conditions]
1802
+ conditions << scope[:conditions] if scope
1803
+ conditions << type_condition if finder_needs_type_condition?
1804
+ merged_conditions = merge_conditions(*conditions)
1805
+ sql << "WHERE #{merged_conditions} " unless merged_conditions.blank?
1806
+ end
1807
+
1808
+ def type_condition(table_alias=nil)
1809
+ quoted_table_alias = self.connection.quote_table_name(table_alias || table_name)
1810
+ quoted_inheritance_column = connection.quote_column_name(inheritance_column)
1811
+ type_condition = subclasses.inject("#{quoted_table_alias}.#{quoted_inheritance_column} = '#{sti_name}' ") do |condition, subclass|
1812
+ condition << "OR #{quoted_table_alias}.#{quoted_inheritance_column} = '#{subclass.sti_name}' "
1813
+ end
1814
+
1815
+ " (#{type_condition}) "
1816
+ end
1817
+
1818
+ # Guesses the table name, but does not decorate it with prefix and suffix information.
1819
+ def undecorated_table_name(class_name = base_class.name)
1820
+ table_name = class_name.to_s.demodulize.underscore
1821
+ table_name = table_name.pluralize if pluralize_table_names
1822
+ table_name
1823
+ end
1824
+
1825
+ # Enables dynamic finders like <tt>find_by_user_name(user_name)</tt> and <tt>find_by_user_name_and_password(user_name, password)</tt>
1826
+ # that are turned into <tt>find(:first, :conditions => ["user_name = ?", user_name])</tt> and
1827
+ # <tt>find(:first, :conditions => ["user_name = ? AND password = ?", user_name, password])</tt> respectively. Also works for
1828
+ # <tt>find(:all)</tt> by using <tt>find_all_by_amount(50)</tt> that is turned into <tt>find(:all, :conditions => ["amount = ?", 50])</tt>.
1829
+ #
1830
+ # It's even possible to use all the additional parameters to +find+. For example, the full interface for +find_all_by_amount+
1831
+ # is actually <tt>find_all_by_amount(amount, options)</tt>.
1832
+ #
1833
+ # Also enables dynamic scopes like scoped_by_user_name(user_name) and scoped_by_user_name_and_password(user_name, password) that
1834
+ # are turned into scoped(:conditions => ["user_name = ?", user_name]) and scoped(:conditions => ["user_name = ? AND password = ?", user_name, password])
1835
+ # respectively.
1836
+ #
1837
+ # Each dynamic finder, scope or initializer/creator is also defined in the class after it is first invoked, so that future
1838
+ # attempts to use it do not run through method_missing.
1839
+ def method_missing(method_id, *arguments, &block)
1840
+ if match = DynamicFinderMatch.match(method_id)
1841
+ attribute_names = match.attribute_names
1842
+ super unless all_attributes_exists?(attribute_names)
1843
+ if match.finder?
1844
+ finder = match.finder
1845
+ bang = match.bang?
1846
+ # def self.find_by_login_and_activated(*args)
1847
+ # options = args.extract_options!
1848
+ # attributes = construct_attributes_from_arguments(
1849
+ # [:login,:activated],
1850
+ # args
1851
+ # )
1852
+ # finder_options = { :conditions => attributes }
1853
+ # validate_find_options(options)
1854
+ # set_readonly_option!(options)
1855
+ #
1856
+ # if options[:conditions]
1857
+ # with_scope(:find => finder_options) do
1858
+ # find(:first, options)
1859
+ # end
1860
+ # else
1861
+ # find(:first, options.merge(finder_options))
1862
+ # end
1863
+ # end
1864
+ self.class_eval %{
1865
+ def self.#{method_id}(*args)
1866
+ options = if args.length > #{attribute_names.size}
1867
+ args.extract_options!
1868
+ else
1869
+ {}
1870
+ end
1871
+ attributes = construct_attributes_from_arguments(
1872
+ [:#{attribute_names.join(',:')}],
1873
+ args
1874
+ )
1875
+ finder_options = { :conditions => attributes }
1876
+ validate_find_options(options)
1877
+ set_readonly_option!(options)
1878
+
1879
+ #{'result = ' if bang}if options[:conditions]
1880
+ with_scope(:find => finder_options) do
1881
+ find(:#{finder}, options)
1882
+ end
1883
+ else
1884
+ find(:#{finder}, options.merge(finder_options))
1885
+ end
1886
+ #{'result || raise(RecordNotFound, "Couldn\'t find #{name} with #{attributes.to_a.collect {|pair| "#{pair.first} = #{pair.second}"}.join(\', \')}")' if bang}
1887
+ end
1888
+ }, __FILE__, __LINE__
1889
+ send(method_id, *arguments)
1890
+ elsif match.instantiator?
1891
+ instantiator = match.instantiator
1892
+ # def self.find_or_create_by_user_id(*args)
1893
+ # guard_protected_attributes = false
1894
+ #
1895
+ # if args[0].is_a?(Hash)
1896
+ # guard_protected_attributes = true
1897
+ # attributes = args[0].with_indifferent_access
1898
+ # find_attributes = attributes.slice(*[:user_id])
1899
+ # else
1900
+ # find_attributes = attributes = construct_attributes_from_arguments([:user_id], args)
1901
+ # end
1902
+ #
1903
+ # options = { :conditions => find_attributes }
1904
+ # set_readonly_option!(options)
1905
+ #
1906
+ # record = find(:first, options)
1907
+ #
1908
+ # if record.nil?
1909
+ # record = self.new { |r| r.send(:attributes=, attributes, guard_protected_attributes) }
1910
+ # yield(record) if block_given?
1911
+ # record.save
1912
+ # record
1913
+ # else
1914
+ # record
1915
+ # end
1916
+ # end
1917
+ self.class_eval %{
1918
+ def self.#{method_id}(*args)
1919
+ guard_protected_attributes = false
1920
+
1921
+ if args[0].is_a?(Hash)
1922
+ guard_protected_attributes = true
1923
+ attributes = args[0].with_indifferent_access
1924
+ find_attributes = attributes.slice(*[:#{attribute_names.join(',:')}])
1925
+ else
1926
+ find_attributes = attributes = construct_attributes_from_arguments([:#{attribute_names.join(',:')}], args)
1927
+ end
1928
+
1929
+ options = { :conditions => find_attributes }
1930
+ set_readonly_option!(options)
1931
+
1932
+ record = find(:first, options)
1933
+
1934
+ if record.nil?
1935
+ record = self.new { |r| r.send(:attributes=, attributes, guard_protected_attributes) }
1936
+ #{'yield(record) if block_given?'}
1937
+ #{'record.save' if instantiator == :create}
1938
+ record
1939
+ else
1940
+ record
1941
+ end
1942
+ end
1943
+ }, __FILE__, __LINE__
1944
+ send(method_id, *arguments, &block)
1945
+ end
1946
+ elsif match = DynamicScopeMatch.match(method_id)
1947
+ attribute_names = match.attribute_names
1948
+ super unless all_attributes_exists?(attribute_names)
1949
+ if match.scope?
1950
+ self.class_eval %{
1951
+ def self.#{method_id}(*args) # def self.scoped_by_user_name_and_password(*args)
1952
+ options = args.extract_options! # options = args.extract_options!
1953
+ attributes = construct_attributes_from_arguments( # attributes = construct_attributes_from_arguments(
1954
+ [:#{attribute_names.join(',:')}], args # [:user_name, :password], args
1955
+ ) # )
1956
+ #
1957
+ scoped(:conditions => attributes) # scoped(:conditions => attributes)
1958
+ end # end
1959
+ }, __FILE__, __LINE__
1960
+ send(method_id, *arguments)
1961
+ end
1962
+ else
1963
+ super
1964
+ end
1965
+ end
1966
+
1967
+ def construct_attributes_from_arguments(attribute_names, arguments)
1968
+ attributes = {}
1969
+ attribute_names.each_with_index { |name, idx| attributes[name] = arguments[idx] }
1970
+ attributes
1971
+ end
1972
+
1973
+ # Similar in purpose to +expand_hash_conditions_for_aggregates+.
1974
+ def expand_attribute_names_for_aggregates(attribute_names)
1975
+ expanded_attribute_names = []
1976
+ attribute_names.each do |attribute_name|
1977
+ unless (aggregation = reflect_on_aggregation(attribute_name.to_sym)).nil?
1978
+ aggregate_mapping(aggregation).each do |field_attr, aggregate_attr|
1979
+ expanded_attribute_names << field_attr
1980
+ end
1981
+ else
1982
+ expanded_attribute_names << attribute_name
1983
+ end
1984
+ end
1985
+ expanded_attribute_names
1986
+ end
1987
+
1988
+ def all_attributes_exists?(attribute_names)
1989
+ attribute_names = expand_attribute_names_for_aggregates(attribute_names)
1990
+ attribute_names.all? { |name| column_methods_hash.include?(name.to_sym) }
1991
+ end
1992
+
1993
+ def attribute_condition(quoted_column_name, argument)
1994
+ case argument
1995
+ when nil then "#{quoted_column_name} IS ?"
1996
+ when Array, ActiveRecord::Associations::AssociationCollection, ActiveRecord::NamedScope::Scope then "#{quoted_column_name} IN (?)"
1997
+ when Range then if argument.exclude_end?
1998
+ "#{quoted_column_name} >= ? AND #{quoted_column_name} < ?"
1999
+ else
2000
+ "#{quoted_column_name} BETWEEN ? AND ?"
2001
+ end
2002
+ else "#{quoted_column_name} = ?"
2003
+ end
2004
+ end
2005
+
2006
+ # Interpret Array and Hash as conditions and anything else as an id.
2007
+ def expand_id_conditions(id_or_conditions)
2008
+ case id_or_conditions
2009
+ when Array, Hash then id_or_conditions
2010
+ else sanitize_sql(primary_key => id_or_conditions)
2011
+ end
2012
+ end
2013
+
2014
+ # Defines an "attribute" method (like +inheritance_column+ or
2015
+ # +table_name+). A new (class) method will be created with the
2016
+ # given name. If a value is specified, the new method will
2017
+ # return that value (as a string). Otherwise, the given block
2018
+ # will be used to compute the value of the method.
2019
+ #
2020
+ # The original method will be aliased, with the new name being
2021
+ # prefixed with "original_". This allows the new method to
2022
+ # access the original value.
2023
+ #
2024
+ # Example:
2025
+ #
2026
+ # class A < ActiveRecord::Base
2027
+ # define_attr_method :primary_key, "sysid"
2028
+ # define_attr_method( :inheritance_column ) do
2029
+ # original_inheritance_column + "_id"
2030
+ # end
2031
+ # end
2032
+ def define_attr_method(name, value=nil, &block)
2033
+ sing = class << self; self; end
2034
+ sing.send :alias_method, "original_#{name}", name
2035
+ if block_given?
2036
+ sing.send :define_method, name, &block
2037
+ else
2038
+ # use eval instead of a block to work around a memory leak in dev
2039
+ # mode in fcgi
2040
+ sing.class_eval "def #{name}; #{value.to_s.inspect}; end"
2041
+ end
2042
+ end
2043
+
2044
+ protected
2045
+ # Scope parameters to method calls within the block. Takes a hash of method_name => parameters hash.
2046
+ # method_name may be <tt>:find</tt> or <tt>:create</tt>. <tt>:find</tt> parameters may include the <tt>:conditions</tt>, <tt>:joins</tt>,
2047
+ # <tt>:include</tt>, <tt>:offset</tt>, <tt>:limit</tt>, and <tt>:readonly</tt> options. <tt>:create</tt> parameters are an attributes hash.
2048
+ #
2049
+ # class Article < ActiveRecord::Base
2050
+ # def self.create_with_scope
2051
+ # with_scope(:find => { :conditions => "blog_id = 1" }, :create => { :blog_id => 1 }) do
2052
+ # find(1) # => SELECT * from articles WHERE blog_id = 1 AND id = 1
2053
+ # a = create(1)
2054
+ # a.blog_id # => 1
2055
+ # end
2056
+ # end
2057
+ # end
2058
+ #
2059
+ # In nested scopings, all previous parameters are overwritten by the innermost rule, with the exception of
2060
+ # <tt>:conditions</tt>, <tt>:include</tt>, and <tt>:joins</tt> options in <tt>:find</tt>, which are merged.
2061
+ #
2062
+ # <tt>:joins</tt> options are uniqued so multiple scopes can join in the same table without table aliasing
2063
+ # problems. If you need to join multiple tables, but still want one of the tables to be uniqued, use the
2064
+ # array of strings format for your joins.
2065
+ #
2066
+ # class Article < ActiveRecord::Base
2067
+ # def self.find_with_scope
2068
+ # with_scope(:find => { :conditions => "blog_id = 1", :limit => 1 }, :create => { :blog_id => 1 }) do
2069
+ # with_scope(:find => { :limit => 10 })
2070
+ # find(:all) # => SELECT * from articles WHERE blog_id = 1 LIMIT 10
2071
+ # end
2072
+ # with_scope(:find => { :conditions => "author_id = 3" })
2073
+ # find(:all) # => SELECT * from articles WHERE blog_id = 1 AND author_id = 3 LIMIT 1
2074
+ # end
2075
+ # end
2076
+ # end
2077
+ # end
2078
+ #
2079
+ # You can ignore any previous scopings by using the <tt>with_exclusive_scope</tt> method.
2080
+ #
2081
+ # class Article < ActiveRecord::Base
2082
+ # def self.find_with_exclusive_scope
2083
+ # with_scope(:find => { :conditions => "blog_id = 1", :limit => 1 }) do
2084
+ # with_exclusive_scope(:find => { :limit => 10 })
2085
+ # find(:all) # => SELECT * from articles LIMIT 10
2086
+ # end
2087
+ # end
2088
+ # end
2089
+ # end
2090
+ #
2091
+ # *Note*: the +:find+ scope also has effect on update and deletion methods,
2092
+ # like +update_all+ and +delete_all+.
2093
+ def with_scope(method_scoping = {}, action = :merge, &block)
2094
+ method_scoping = method_scoping.method_scoping if method_scoping.respond_to?(:method_scoping)
2095
+
2096
+ # Dup first and second level of hash (method and params).
2097
+ method_scoping = method_scoping.inject({}) do |hash, (method, params)|
2098
+ hash[method] = (params == true) ? params : params.dup
2099
+ hash
2100
+ end
2101
+
2102
+ method_scoping.assert_valid_keys([ :find, :create ])
2103
+
2104
+ if f = method_scoping[:find]
2105
+ f.assert_valid_keys(VALID_FIND_OPTIONS)
2106
+ set_readonly_option! f
2107
+ end
2108
+
2109
+ # Merge scopings
2110
+ if [:merge, :reverse_merge].include?(action) && current_scoped_methods
2111
+ method_scoping = current_scoped_methods.inject(method_scoping) do |hash, (method, params)|
2112
+ case hash[method]
2113
+ when Hash
2114
+ if method == :find
2115
+ (hash[method].keys + params.keys).uniq.each do |key|
2116
+ merge = hash[method][key] && params[key] # merge if both scopes have the same key
2117
+ if key == :conditions && merge
2118
+ if params[key].is_a?(Hash) && hash[method][key].is_a?(Hash)
2119
+ hash[method][key] = merge_conditions(hash[method][key].deep_merge(params[key]))
2120
+ else
2121
+ hash[method][key] = merge_conditions(params[key], hash[method][key])
2122
+ end
2123
+ elsif key == :include && merge
2124
+ hash[method][key] = merge_includes(hash[method][key], params[key]).uniq
2125
+ elsif key == :joins && merge
2126
+ hash[method][key] = merge_joins(params[key], hash[method][key])
2127
+ else
2128
+ hash[method][key] = hash[method][key] || params[key]
2129
+ end
2130
+ end
2131
+ else
2132
+ if action == :reverse_merge
2133
+ hash[method] = hash[method].merge(params)
2134
+ else
2135
+ hash[method] = params.merge(hash[method])
2136
+ end
2137
+ end
2138
+ else
2139
+ hash[method] = params
2140
+ end
2141
+ hash
2142
+ end
2143
+ end
2144
+
2145
+ self.scoped_methods << method_scoping
2146
+ begin
2147
+ yield
2148
+ ensure
2149
+ self.scoped_methods.pop
2150
+ end
2151
+ end
2152
+
2153
+ # Works like with_scope, but discards any nested properties.
2154
+ def with_exclusive_scope(method_scoping = {}, &block)
2155
+ with_scope(method_scoping, :overwrite, &block)
2156
+ end
2157
+
2158
+ def subclasses #:nodoc:
2159
+ @@subclasses[self] ||= []
2160
+ @@subclasses[self] + extra = @@subclasses[self].inject([]) {|list, subclass| list + subclass.subclasses }
2161
+ end
2162
+
2163
+ # Sets the default options for the model. The format of the
2164
+ # <tt>options</tt> argument is the same as in find.
2165
+ #
2166
+ # class Person < ActiveRecord::Base
2167
+ # default_scope :order => 'last_name, first_name'
2168
+ # end
2169
+ def default_scope(options = {})
2170
+ self.default_scoping << { :find => options, :create => options[:conditions].is_a?(Hash) ? options[:conditions] : {} }
2171
+ end
2172
+
2173
+ # Test whether the given method and optional key are scoped.
2174
+ def scoped?(method, key = nil) #:nodoc:
2175
+ if current_scoped_methods && (scope = current_scoped_methods[method])
2176
+ !key || !scope[key].nil?
2177
+ end
2178
+ end
2179
+
2180
+ # Retrieve the scope for the given method and optional key.
2181
+ def scope(method, key = nil) #:nodoc:
2182
+ if current_scoped_methods && (scope = current_scoped_methods[method])
2183
+ key ? scope[key] : scope
2184
+ end
2185
+ end
2186
+
2187
+ def scoped_methods #:nodoc:
2188
+ Thread.current[:"#{self}_scoped_methods"] ||= self.default_scoping.dup
2189
+ end
2190
+
2191
+ def current_scoped_methods #:nodoc:
2192
+ scoped_methods.last
2193
+ end
2194
+
2195
+ # Returns the class type of the record using the current module as a prefix. So descendants of
2196
+ # MyApp::Business::Account would appear as MyApp::Business::AccountSubclass.
2197
+ def compute_type(type_name)
2198
+ modularized_name = type_name_with_module(type_name)
2199
+ silence_warnings do
2200
+ begin
2201
+ class_eval(modularized_name, __FILE__, __LINE__)
2202
+ rescue NameError
2203
+ class_eval(type_name, __FILE__, __LINE__)
2204
+ end
2205
+ end
2206
+ end
2207
+
2208
+ # Returns the class descending directly from ActiveRecord::Base or an
2209
+ # abstract class, if any, in the inheritance hierarchy.
2210
+ def class_of_active_record_descendant(klass)
2211
+ if klass.superclass == Base || klass.superclass.abstract_class?
2212
+ klass
2213
+ elsif klass.superclass.nil?
2214
+ raise ActiveRecordError, "#{name} doesn't belong in a hierarchy descending from ActiveRecord"
2215
+ else
2216
+ class_of_active_record_descendant(klass.superclass)
2217
+ end
2218
+ end
2219
+
2220
+ # Returns the name of the class descending directly from Active Record in the inheritance hierarchy.
2221
+ def class_name_of_active_record_descendant(klass) #:nodoc:
2222
+ klass.base_class.name
2223
+ end
2224
+
2225
+ # Accepts an array, hash, or string of SQL conditions and sanitizes
2226
+ # them into a valid SQL fragment for a WHERE clause.
2227
+ # ["name='%s' and group_id='%s'", "foo'bar", 4] returns "name='foo''bar' and group_id='4'"
2228
+ # { :name => "foo'bar", :group_id => 4 } returns "name='foo''bar' and group_id='4'"
2229
+ # "name='foo''bar' and group_id='4'" returns "name='foo''bar' and group_id='4'"
2230
+ def sanitize_sql_for_conditions(condition, table_name = quoted_table_name)
2231
+ return nil if condition.blank?
2232
+
2233
+ case condition
2234
+ when Array; sanitize_sql_array(condition)
2235
+ when Hash; sanitize_sql_hash_for_conditions(condition, table_name)
2236
+ else condition
2237
+ end
2238
+ end
2239
+ alias_method :sanitize_sql, :sanitize_sql_for_conditions
2240
+
2241
+ # Accepts an array, hash, or string of SQL conditions and sanitizes
2242
+ # them into a valid SQL fragment for a SET clause.
2243
+ # { :name => nil, :group_id => 4 } returns "name = NULL , group_id='4'"
2244
+ def sanitize_sql_for_assignment(assignments)
2245
+ case assignments
2246
+ when Array; sanitize_sql_array(assignments)
2247
+ when Hash; sanitize_sql_hash_for_assignment(assignments)
2248
+ else assignments
2249
+ end
2250
+ end
2251
+
2252
+ def aggregate_mapping(reflection)
2253
+ mapping = reflection.options[:mapping] || [reflection.name, reflection.name]
2254
+ mapping.first.is_a?(Array) ? mapping : [mapping]
2255
+ end
2256
+
2257
+ # Accepts a hash of SQL conditions and replaces those attributes
2258
+ # that correspond to a +composed_of+ relationship with their expanded
2259
+ # aggregate attribute values.
2260
+ # Given:
2261
+ # class Person < ActiveRecord::Base
2262
+ # composed_of :address, :class_name => "Address",
2263
+ # :mapping => [%w(address_street street), %w(address_city city)]
2264
+ # end
2265
+ # Then:
2266
+ # { :address => Address.new("813 abc st.", "chicago") }
2267
+ # # => { :address_street => "813 abc st.", :address_city => "chicago" }
2268
+ def expand_hash_conditions_for_aggregates(attrs)
2269
+ expanded_attrs = {}
2270
+ attrs.each do |attr, value|
2271
+ unless (aggregation = reflect_on_aggregation(attr.to_sym)).nil?
2272
+ mapping = aggregate_mapping(aggregation)
2273
+ mapping.each do |field_attr, aggregate_attr|
2274
+ if mapping.size == 1 && !value.respond_to?(aggregate_attr)
2275
+ expanded_attrs[field_attr] = value
2276
+ else
2277
+ expanded_attrs[field_attr] = value.send(aggregate_attr)
2278
+ end
2279
+ end
2280
+ else
2281
+ expanded_attrs[attr] = value
2282
+ end
2283
+ end
2284
+ expanded_attrs
2285
+ end
2286
+
2287
+ # Sanitizes a hash of attribute/value pairs into SQL conditions for a WHERE clause.
2288
+ # { :name => "foo'bar", :group_id => 4 }
2289
+ # # => "name='foo''bar' and group_id= 4"
2290
+ # { :status => nil, :group_id => [1,2,3] }
2291
+ # # => "status IS NULL and group_id IN (1,2,3)"
2292
+ # { :age => 13..18 }
2293
+ # # => "age BETWEEN 13 AND 18"
2294
+ # { 'other_records.id' => 7 }
2295
+ # # => "`other_records`.`id` = 7"
2296
+ # { :other_records => { :id => 7 } }
2297
+ # # => "`other_records`.`id` = 7"
2298
+ # And for value objects on a composed_of relationship:
2299
+ # { :address => Address.new("123 abc st.", "chicago") }
2300
+ # # => "address_street='123 abc st.' and address_city='chicago'"
2301
+ def sanitize_sql_hash_for_conditions(attrs, default_table_name = quoted_table_name, top_level = true)
2302
+ attrs = expand_hash_conditions_for_aggregates(attrs)
2303
+
2304
+ return '1 = 2' if !top_level && attrs.is_a?(Hash) && attrs.empty?
2305
+
2306
+ conditions = attrs.map do |attr, value|
2307
+ table_name = default_table_name
2308
+
2309
+ unless value.is_a?(Hash)
2310
+ attr = attr.to_s
2311
+
2312
+ # Extract table name from qualified attribute names.
2313
+ if attr.include?('.')
2314
+ attr_table_name, attr = attr.split('.', 2)
2315
+ attr_table_name = connection.quote_table_name(attr_table_name)
2316
+ else
2317
+ attr_table_name = table_name
2318
+ end
2319
+
2320
+ attribute_condition("#{attr_table_name}.#{connection.quote_column_name(attr)}", value)
2321
+ else
2322
+ sanitize_sql_hash_for_conditions(value, connection.quote_table_name(attr.to_s))
2323
+ end
2324
+ end.join(' AND ')
2325
+
2326
+ replace_bind_variables(conditions, expand_range_bind_variables(attrs.values))
2327
+ end
2328
+ alias_method :sanitize_sql_hash, :sanitize_sql_hash_for_conditions
2329
+
2330
+ # Sanitizes a hash of attribute/value pairs into SQL conditions for a SET clause.
2331
+ # { :status => nil, :group_id => 1 }
2332
+ # # => "status = NULL , group_id = 1"
2333
+ def sanitize_sql_hash_for_assignment(attrs)
2334
+ attrs.map do |attr, value|
2335
+ "#{connection.quote_column_name(attr)} = #{quote_bound_value(value)}"
2336
+ end.join(', ')
2337
+ end
2338
+
2339
+ # Accepts an array of conditions. The array has each value
2340
+ # sanitized and interpolated into the SQL statement.
2341
+ # ["name='%s' and group_id='%s'", "foo'bar", 4] returns "name='foo''bar' and group_id='4'"
2342
+ def sanitize_sql_array(ary)
2343
+ statement, *values = ary
2344
+ if values.first.is_a?(Hash) and statement =~ /:\w+/
2345
+ replace_named_bind_variables(statement, values.first)
2346
+ elsif statement.include?('?')
2347
+ replace_bind_variables(statement, values)
2348
+ else
2349
+ statement % values.collect { |value| connection.quote_string(value.to_s) }
2350
+ end
2351
+ end
2352
+
2353
+ alias_method :sanitize_conditions, :sanitize_sql
2354
+
2355
+ def replace_bind_variables(statement, values) #:nodoc:
2356
+ raise_if_bind_arity_mismatch(statement, statement.count('?'), values.size)
2357
+ bound = values.dup
2358
+ statement.gsub('?') { quote_bound_value(bound.shift) }
2359
+ end
2360
+
2361
+ def replace_named_bind_variables(statement, bind_vars) #:nodoc:
2362
+ statement.gsub(/(:?):([a-zA-Z]\w*)/) do
2363
+ if $1 == ':' # skip postgresql casts
2364
+ $& # return the whole match
2365
+ elsif bind_vars.include?(match = $2.to_sym)
2366
+ quote_bound_value(bind_vars[match])
2367
+ else
2368
+ raise PreparedStatementInvalid, "missing value for :#{match} in #{statement}"
2369
+ end
2370
+ end
2371
+ end
2372
+
2373
+ def expand_range_bind_variables(bind_vars) #:nodoc:
2374
+ expanded = []
2375
+
2376
+ bind_vars.each do |var|
2377
+ next if var.is_a?(Hash)
2378
+
2379
+ if var.is_a?(Range)
2380
+ expanded << var.first
2381
+ expanded << var.last
2382
+ else
2383
+ expanded << var
2384
+ end
2385
+ end
2386
+
2387
+ expanded
2388
+ end
2389
+
2390
+ def quote_bound_value(value) #:nodoc:
2391
+ if value.respond_to?(:map) && !value.acts_like?(:string)
2392
+ if value.respond_to?(:empty?) && value.empty?
2393
+ connection.quote(nil)
2394
+ else
2395
+ value.map { |v| connection.quote(v) }.join(',')
2396
+ end
2397
+ else
2398
+ connection.quote(value)
2399
+ end
2400
+ end
2401
+
2402
+ def raise_if_bind_arity_mismatch(statement, expected, provided) #:nodoc:
2403
+ unless expected == provided
2404
+ raise PreparedStatementInvalid, "wrong number of bind variables (#{provided} for #{expected}) in: #{statement}"
2405
+ end
2406
+ end
2407
+
2408
+ VALID_FIND_OPTIONS = [ :conditions, :include, :joins, :limit, :offset,
2409
+ :order, :select, :readonly, :group, :having, :from, :lock ]
2410
+
2411
+ def validate_find_options(options) #:nodoc:
2412
+ options.assert_valid_keys(VALID_FIND_OPTIONS)
2413
+ end
2414
+
2415
+ def set_readonly_option!(options) #:nodoc:
2416
+ # Inherit :readonly from finder scope if set. Otherwise,
2417
+ # if :joins is not blank then :readonly defaults to true.
2418
+ unless options.has_key?(:readonly)
2419
+ if scoped_readonly = scope(:find, :readonly)
2420
+ options[:readonly] = scoped_readonly
2421
+ elsif !options[:joins].blank? && !options[:select]
2422
+ options[:readonly] = true
2423
+ end
2424
+ end
2425
+ end
2426
+
2427
+ def encode_quoted_value(value) #:nodoc:
2428
+ quoted_value = connection.quote(value)
2429
+ quoted_value = "'#{quoted_value[1..-2].gsub(/\'/, "\\\\'")}'" if quoted_value.include?("\\\'") # (for ruby mode) "
2430
+ quoted_value
2431
+ end
2432
+ end
2433
+
2434
+ public
2435
+ # New objects can be instantiated as either empty (pass no construction parameter) or pre-set with
2436
+ # attributes but not yet saved (pass a hash with key names matching the associated table column names).
2437
+ # In both instances, valid attribute keys are determined by the column names of the associated table --
2438
+ # hence you can't have attributes that aren't part of the table columns.
2439
+ def initialize(attributes = nil)
2440
+ @attributes = attributes_from_column_definition
2441
+ @attributes_cache = {}
2442
+ @new_record = true
2443
+ ensure_proper_type
2444
+ self.attributes = attributes unless attributes.nil?
2445
+ self.class.send(:scope, :create).each { |att,value| self.send("#{att}=", value) } if self.class.send(:scoped?, :create)
2446
+ result = yield self if block_given?
2447
+ callback(:after_initialize) if respond_to_without_attributes?(:after_initialize)
2448
+ result
2449
+ end
2450
+
2451
+ # A model instance's primary key is always available as model.id
2452
+ # whether you name it the default 'id' or set it to something else.
2453
+ def id
2454
+ attr_name = self.class.primary_key
2455
+ column = column_for_attribute(attr_name)
2456
+
2457
+ self.class.send(:define_read_method, :id, attr_name, column)
2458
+ # now that the method exists, call it
2459
+ self.send attr_name.to_sym
2460
+
2461
+ end
2462
+
2463
+ # Returns a String, which Action Pack uses for constructing an URL to this
2464
+ # object. The default implementation returns this record's id as a String,
2465
+ # or nil if this record's unsaved.
2466
+ #
2467
+ # For example, suppose that you have a User model, and that you have a
2468
+ # <tt>map.resources :users</tt> route. Normally, +user_path+ will
2469
+ # construct a path with the user object's 'id' in it:
2470
+ #
2471
+ # user = User.find_by_name('Phusion')
2472
+ # user_path(user) # => "/users/1"
2473
+ #
2474
+ # You can override +to_param+ in your model to make +user_path+ construct
2475
+ # a path using the user's name instead of the user's id:
2476
+ #
2477
+ # class User < ActiveRecord::Base
2478
+ # def to_param # overridden
2479
+ # name
2480
+ # end
2481
+ # end
2482
+ #
2483
+ # user = User.find_by_name('Phusion')
2484
+ # user_path(user) # => "/users/Phusion"
2485
+ def to_param
2486
+ # We can't use alias_method here, because method 'id' optimizes itself on the fly.
2487
+ (id = self.id) ? id.to_s : nil # Be sure to stringify the id for routes
2488
+ end
2489
+
2490
+ # Returns a cache key that can be used to identify this record.
2491
+ #
2492
+ # ==== Examples
2493
+ #
2494
+ # Product.new.cache_key # => "products/new"
2495
+ # Product.find(5).cache_key # => "products/5" (updated_at not available)
2496
+ # Person.find(5).cache_key # => "people/5-20071224150000" (updated_at available)
2497
+ def cache_key
2498
+ case
2499
+ when new_record?
2500
+ "#{self.class.model_name.cache_key}/new"
2501
+ when timestamp = self[:updated_at]
2502
+ "#{self.class.model_name.cache_key}/#{id}-#{timestamp.to_s(:number)}"
2503
+ else
2504
+ "#{self.class.model_name.cache_key}/#{id}"
2505
+ end
2506
+ end
2507
+
2508
+ def id_before_type_cast #:nodoc:
2509
+ read_attribute_before_type_cast(self.class.primary_key)
2510
+ end
2511
+
2512
+ def quoted_id #:nodoc:
2513
+ quote_value(id, column_for_attribute(self.class.primary_key))
2514
+ end
2515
+
2516
+ # Sets the primary ID.
2517
+ def id=(value)
2518
+ write_attribute(self.class.primary_key, value)
2519
+ end
2520
+
2521
+ # Returns true if this object hasn't been saved yet -- that is, a record for the object doesn't exist yet; otherwise, returns false.
2522
+ def new_record?
2523
+ @new_record || false
2524
+ end
2525
+
2526
+ # :call-seq:
2527
+ # save(perform_validation = true)
2528
+ #
2529
+ # Saves the model.
2530
+ #
2531
+ # If the model is new a record gets created in the database, otherwise
2532
+ # the existing record gets updated.
2533
+ #
2534
+ # If +perform_validation+ is true validations run. If any of them fail
2535
+ # the action is cancelled and +save+ returns +false+. If the flag is
2536
+ # false validations are bypassed altogether. See
2537
+ # ActiveRecord::Validations for more information.
2538
+ #
2539
+ # There's a series of callbacks associated with +save+. If any of the
2540
+ # <tt>before_*</tt> callbacks return +false+ the action is cancelled and
2541
+ # +save+ returns +false+. See ActiveRecord::Callbacks for further
2542
+ # details.
2543
+ def save
2544
+ create_or_update
2545
+ end
2546
+
2547
+ # Saves the model.
2548
+ #
2549
+ # If the model is new a record gets created in the database, otherwise
2550
+ # the existing record gets updated.
2551
+ #
2552
+ # With <tt>save!</tt> validations always run. If any of them fail
2553
+ # ActiveRecord::RecordInvalid gets raised. See ActiveRecord::Validations
2554
+ # for more information.
2555
+ #
2556
+ # There's a series of callbacks associated with <tt>save!</tt>. If any of
2557
+ # the <tt>before_*</tt> callbacks return +false+ the action is cancelled
2558
+ # and <tt>save!</tt> raises ActiveRecord::RecordNotSaved. See
2559
+ # ActiveRecord::Callbacks for further details.
2560
+ def save!
2561
+ create_or_update || raise(RecordNotSaved)
2562
+ end
2563
+
2564
+ # Deletes the record in the database and freezes this instance to
2565
+ # reflect that no changes should be made (since they can't be
2566
+ # persisted). Returns the frozen instance.
2567
+ #
2568
+ # The row is simply removed with a SQL +DELETE+ statement on the
2569
+ # record's primary key, and no callbacks are executed.
2570
+ #
2571
+ # To enforce the object's +before_destroy+ and +after_destroy+
2572
+ # callbacks, Observer methods, or any <tt>:dependent</tt> association
2573
+ # options, use <tt>#destroy</tt>.
2574
+ def delete
2575
+ self.class.delete(id) unless new_record?
2576
+ @destroyed = true
2577
+ freeze
2578
+ end
2579
+
2580
+ # Deletes the record in the database and freezes this instance to reflect that no changes should
2581
+ # be made (since they can't be persisted).
2582
+ def destroy
2583
+ unless new_record?
2584
+ connection.delete(
2585
+ "DELETE FROM #{self.class.quoted_table_name} " +
2586
+ "WHERE #{connection.quote_column_name(self.class.primary_key)} = #{quoted_id}",
2587
+ "#{self.class.name} Destroy"
2588
+ )
2589
+ end
2590
+
2591
+ @destroyed = true
2592
+ freeze
2593
+ end
2594
+
2595
+ # Returns a clone of the record that hasn't been assigned an id yet and
2596
+ # is treated as a new record. Note that this is a "shallow" clone:
2597
+ # it copies the object's attributes only, not its associations.
2598
+ # The extent of a "deep" clone is application-specific and is therefore
2599
+ # left to the application to implement according to its need.
2600
+ def clone
2601
+ attrs = clone_attributes(:read_attribute_before_type_cast)
2602
+ attrs.delete(self.class.primary_key)
2603
+ record = self.class.new
2604
+ record.send :instance_variable_set, '@attributes', attrs
2605
+ record
2606
+ end
2607
+
2608
+ # Returns an instance of the specified +klass+ with the attributes of the current record. This is mostly useful in relation to
2609
+ # single-table inheritance structures where you want a subclass to appear as the superclass. This can be used along with record
2610
+ # identification in Action Pack to allow, say, <tt>Client < Company</tt> to do something like render <tt>:partial => @client.becomes(Company)</tt>
2611
+ # to render that instance using the companies/company partial instead of clients/client.
2612
+ #
2613
+ # Note: The new instance will share a link to the same attributes as the original class. So any change to the attributes in either
2614
+ # instance will affect the other.
2615
+ def becomes(klass)
2616
+ returning klass.new do |became|
2617
+ became.instance_variable_set("@attributes", @attributes)
2618
+ became.instance_variable_set("@attributes_cache", @attributes_cache)
2619
+ became.instance_variable_set("@new_record", new_record?)
2620
+ end
2621
+ end
2622
+
2623
+ # Updates a single attribute and saves the record without going through the normal validation procedure.
2624
+ # This is especially useful for boolean flags on existing records. The regular +update_attribute+ method
2625
+ # in Base is replaced with this when the validations module is mixed in, which it is by default.
2626
+ def update_attribute(name, value)
2627
+ send(name.to_s + '=', value)
2628
+ save(false)
2629
+ end
2630
+
2631
+ # Updates all the attributes from the passed-in Hash and saves the record. If the object is invalid, the saving will
2632
+ # fail and false will be returned.
2633
+ def update_attributes(attributes)
2634
+ self.attributes = attributes
2635
+ save
2636
+ end
2637
+
2638
+ # Updates an object just like Base.update_attributes but calls save! instead of save so an exception is raised if the record is invalid.
2639
+ def update_attributes!(attributes)
2640
+ self.attributes = attributes
2641
+ save!
2642
+ end
2643
+
2644
+ # Initializes +attribute+ to zero if +nil+ and adds the value passed as +by+ (default is 1).
2645
+ # The increment is performed directly on the underlying attribute, no setter is invoked.
2646
+ # Only makes sense for number-based attributes. Returns +self+.
2647
+ def increment(attribute, by = 1)
2648
+ self[attribute] ||= 0
2649
+ self[attribute] += by
2650
+ self
2651
+ end
2652
+
2653
+ # Wrapper around +increment+ that saves the record. This method differs from
2654
+ # its non-bang version in that it passes through the attribute setter.
2655
+ # Saving is not subjected to validation checks. Returns +true+ if the
2656
+ # record could be saved.
2657
+ def increment!(attribute, by = 1)
2658
+ increment(attribute, by).update_attribute(attribute, self[attribute])
2659
+ end
2660
+
2661
+ # Initializes +attribute+ to zero if +nil+ and subtracts the value passed as +by+ (default is 1).
2662
+ # The decrement is performed directly on the underlying attribute, no setter is invoked.
2663
+ # Only makes sense for number-based attributes. Returns +self+.
2664
+ def decrement(attribute, by = 1)
2665
+ self[attribute] ||= 0
2666
+ self[attribute] -= by
2667
+ self
2668
+ end
2669
+
2670
+ # Wrapper around +decrement+ that saves the record. This method differs from
2671
+ # its non-bang version in that it passes through the attribute setter.
2672
+ # Saving is not subjected to validation checks. Returns +true+ if the
2673
+ # record could be saved.
2674
+ def decrement!(attribute, by = 1)
2675
+ decrement(attribute, by).update_attribute(attribute, self[attribute])
2676
+ end
2677
+
2678
+ # Assigns to +attribute+ the boolean opposite of <tt>attribute?</tt>. So
2679
+ # if the predicate returns +true+ the attribute will become +false+. This
2680
+ # method toggles directly the underlying value without calling any setter.
2681
+ # Returns +self+.
2682
+ def toggle(attribute)
2683
+ self[attribute] = !send("#{attribute}?")
2684
+ self
2685
+ end
2686
+
2687
+ # Wrapper around +toggle+ that saves the record. This method differs from
2688
+ # its non-bang version in that it passes through the attribute setter.
2689
+ # Saving is not subjected to validation checks. Returns +true+ if the
2690
+ # record could be saved.
2691
+ def toggle!(attribute)
2692
+ toggle(attribute).update_attribute(attribute, self[attribute])
2693
+ end
2694
+
2695
+ # Reloads the attributes of this object from the database.
2696
+ # The optional options argument is passed to find when reloading so you
2697
+ # may do e.g. record.reload(:lock => true) to reload the same record with
2698
+ # an exclusive row lock.
2699
+ def reload(options = nil)
2700
+ clear_aggregation_cache
2701
+ clear_association_cache
2702
+ @attributes.update(self.class.find(self.id, options).instance_variable_get('@attributes'))
2703
+ @attributes_cache = {}
2704
+ self
2705
+ end
2706
+
2707
+ # Returns the value of the attribute identified by <tt>attr_name</tt> after it has been typecast (for example,
2708
+ # "2004-12-12" in a data column is cast to a date object, like Date.new(2004, 12, 12)).
2709
+ # (Alias for the protected read_attribute method).
2710
+ def [](attr_name)
2711
+ read_attribute(attr_name)
2712
+ end
2713
+
2714
+ # Updates the attribute identified by <tt>attr_name</tt> with the specified +value+.
2715
+ # (Alias for the protected write_attribute method).
2716
+ def []=(attr_name, value)
2717
+ write_attribute(attr_name, value)
2718
+ end
2719
+
2720
+ # Allows you to set all the attributes at once by passing in a hash with keys
2721
+ # matching the attribute names (which again matches the column names).
2722
+ #
2723
+ # If +guard_protected_attributes+ is true (the default), then sensitive
2724
+ # attributes can be protected from this form of mass-assignment by using
2725
+ # the +attr_protected+ macro. Or you can alternatively specify which
2726
+ # attributes *can* be accessed with the +attr_accessible+ macro. Then all the
2727
+ # attributes not included in that won't be allowed to be mass-assigned.
2728
+ #
2729
+ # class User < ActiveRecord::Base
2730
+ # attr_protected :is_admin
2731
+ # end
2732
+ #
2733
+ # user = User.new
2734
+ # user.attributes = { :username => 'Phusion', :is_admin => true }
2735
+ # user.username # => "Phusion"
2736
+ # user.is_admin? # => false
2737
+ #
2738
+ # user.send(:attributes=, { :username => 'Phusion', :is_admin => true }, false)
2739
+ # user.is_admin? # => true
2740
+ def attributes=(new_attributes, guard_protected_attributes = true)
2741
+ return if new_attributes.nil?
2742
+ attributes = new_attributes.dup
2743
+ attributes.stringify_keys!
2744
+
2745
+ multi_parameter_attributes = []
2746
+ attributes = remove_attributes_protected_from_mass_assignment(attributes) if guard_protected_attributes
2747
+
2748
+ attributes.each do |k, v|
2749
+ if k.include?("(")
2750
+ multi_parameter_attributes << [ k, v ]
2751
+ else
2752
+ respond_to?(:"#{k}=") ? send(:"#{k}=", v) : raise(UnknownAttributeError, "unknown attribute: #{k}")
2753
+ end
2754
+ end
2755
+
2756
+ assign_multiparameter_attributes(multi_parameter_attributes)
2757
+ end
2758
+
2759
+ # Returns a hash of all the attributes with their names as keys and the values of the attributes as values.
2760
+ def attributes
2761
+ self.attribute_names.inject({}) do |attrs, name|
2762
+ attrs[name] = read_attribute(name)
2763
+ attrs
2764
+ end
2765
+ end
2766
+
2767
+ # Returns a hash of attributes before typecasting and deserialization.
2768
+ def attributes_before_type_cast
2769
+ self.attribute_names.inject({}) do |attrs, name|
2770
+ attrs[name] = read_attribute_before_type_cast(name)
2771
+ attrs
2772
+ end
2773
+ end
2774
+
2775
+ # Returns an <tt>#inspect</tt>-like string for the value of the
2776
+ # attribute +attr_name+. String attributes are elided after 50
2777
+ # characters, and Date and Time attributes are returned in the
2778
+ # <tt>:db</tt> format. Other attributes return the value of
2779
+ # <tt>#inspect</tt> without modification.
2780
+ #
2781
+ # person = Person.create!(:name => "David Heinemeier Hansson " * 3)
2782
+ #
2783
+ # person.attribute_for_inspect(:name)
2784
+ # # => '"David Heinemeier Hansson David Heinemeier Hansson D..."'
2785
+ #
2786
+ # person.attribute_for_inspect(:created_at)
2787
+ # # => '"2009-01-12 04:48:57"'
2788
+ def attribute_for_inspect(attr_name)
2789
+ value = read_attribute(attr_name)
2790
+
2791
+ if value.is_a?(String) && value.length > 50
2792
+ "#{value[0..50]}...".inspect
2793
+ elsif value.is_a?(Date) || value.is_a?(Time)
2794
+ %("#{value.to_s(:db)}")
2795
+ else
2796
+ value.inspect
2797
+ end
2798
+ end
2799
+
2800
+ # Returns true if the specified +attribute+ has been set by the user or by a database load and is neither
2801
+ # nil nor empty? (the latter only applies to objects that respond to empty?, most notably Strings).
2802
+ def attribute_present?(attribute)
2803
+ value = read_attribute(attribute)
2804
+ !value.blank?
2805
+ end
2806
+
2807
+ # Returns true if the given attribute is in the attributes hash
2808
+ def has_attribute?(attr_name)
2809
+ @attributes.has_key?(attr_name.to_s)
2810
+ end
2811
+
2812
+ # Returns an array of names for the attributes available on this object sorted alphabetically.
2813
+ def attribute_names
2814
+ @attributes.keys.sort
2815
+ end
2816
+
2817
+ # Returns the column object for the named attribute.
2818
+ def column_for_attribute(name)
2819
+ self.class.columns_hash[name.to_s]
2820
+ end
2821
+
2822
+ # Returns true if the +comparison_object+ is the same object, or is of the same type and has the same id.
2823
+ def ==(comparison_object)
2824
+ comparison_object.equal?(self) ||
2825
+ (comparison_object.instance_of?(self.class) &&
2826
+ comparison_object.id == id &&
2827
+ !comparison_object.new_record?)
2828
+ end
2829
+
2830
+ # Delegates to ==
2831
+ def eql?(comparison_object)
2832
+ self == (comparison_object)
2833
+ end
2834
+
2835
+ # Delegates to id in order to allow two records of the same type and id to work with something like:
2836
+ # [ Person.find(1), Person.find(2), Person.find(3) ] & [ Person.find(1), Person.find(4) ] # => [ Person.find(1) ]
2837
+ def hash
2838
+ id.hash
2839
+ end
2840
+
2841
+ # Freeze the attributes hash such that associations are still accessible, even on destroyed records.
2842
+ def freeze
2843
+ @attributes.freeze; self
2844
+ end
2845
+
2846
+ # Returns +true+ if the attributes hash has been frozen.
2847
+ def frozen?
2848
+ @attributes.frozen?
2849
+ end
2850
+
2851
+ # Returns +true+ if the record has been destroyed.
2852
+ def destroyed?
2853
+ @destroyed
2854
+ end
2855
+
2856
+ # Returns +true+ if the record is read only. Records loaded through joins with piggy-back
2857
+ # attributes will be marked as read only since they cannot be saved.
2858
+ def readonly?
2859
+ defined?(@readonly) && @readonly == true
2860
+ end
2861
+
2862
+ # Marks this record as read only.
2863
+ def readonly!
2864
+ @readonly = true
2865
+ end
2866
+
2867
+ # Returns the contents of the record as a nicely formatted string.
2868
+ def inspect
2869
+ attributes_as_nice_string = self.class.column_names.collect { |name|
2870
+ if has_attribute?(name) || new_record?
2871
+ "#{name}: #{attribute_for_inspect(name)}"
2872
+ end
2873
+ }.compact.join(", ")
2874
+ "#<#{self.class} #{attributes_as_nice_string}>"
2875
+ end
2876
+
2877
+ private
2878
+ def create_or_update
2879
+ raise ReadOnlyRecord if readonly?
2880
+ result = new_record? ? create : update
2881
+ result != false
2882
+ end
2883
+
2884
+ # Updates the associated record with values matching those of the instance attributes.
2885
+ # Returns the number of affected rows.
2886
+ def update(attribute_names = @attributes.keys)
2887
+ quoted_attributes = attributes_with_quotes(false, false, attribute_names)
2888
+ return 0 if quoted_attributes.empty?
2889
+ connection.update(
2890
+ "UPDATE #{self.class.quoted_table_name} " +
2891
+ "SET #{quoted_comma_pair_list(connection, quoted_attributes)} " +
2892
+ "WHERE #{connection.quote_column_name(self.class.primary_key)} = #{quote_value(id)}",
2893
+ "#{self.class.name} Update"
2894
+ )
2895
+ end
2896
+
2897
+ # Creates a record with values matching those of the instance attributes
2898
+ # and returns its id.
2899
+ def create
2900
+ if self.id.nil? && connection.prefetch_primary_key?(self.class.table_name)
2901
+ self.id = connection.next_sequence_value(self.class.sequence_name)
2902
+ end
2903
+
2904
+ quoted_attributes = attributes_with_quotes
2905
+
2906
+ statement = if quoted_attributes.empty?
2907
+ connection.empty_insert_statement(self.class.table_name)
2908
+ else
2909
+ "INSERT INTO #{self.class.quoted_table_name} " +
2910
+ "(#{quoted_column_names.join(', ')}) " +
2911
+ "VALUES(#{quoted_attributes.values.join(', ')})"
2912
+ end
2913
+
2914
+ self.id = connection.insert(statement, "#{self.class.name} Create",
2915
+ self.class.primary_key, self.id, self.class.sequence_name)
2916
+
2917
+ @new_record = false
2918
+ id
2919
+ end
2920
+
2921
+ # Sets the attribute used for single table inheritance to this class name if this is not the ActiveRecord::Base descendant.
2922
+ # Considering the hierarchy Reply < Message < ActiveRecord::Base, this makes it possible to do Reply.new without having to
2923
+ # set <tt>Reply[Reply.inheritance_column] = "Reply"</tt> yourself. No such attribute would be set for objects of the
2924
+ # Message class in that example.
2925
+ def ensure_proper_type
2926
+ unless self.class.descends_from_active_record?
2927
+ write_attribute(self.class.inheritance_column, self.class.sti_name)
2928
+ end
2929
+ end
2930
+
2931
+ def convert_number_column_value(value)
2932
+ if value == false
2933
+ 0
2934
+ elsif value == true
2935
+ 1
2936
+ elsif value.is_a?(String) && value.blank?
2937
+ nil
2938
+ else
2939
+ value
2940
+ end
2941
+ end
2942
+
2943
+ def remove_attributes_protected_from_mass_assignment(attributes)
2944
+ safe_attributes =
2945
+ if self.class.accessible_attributes.nil? && self.class.protected_attributes.nil?
2946
+ attributes.reject { |key, value| attributes_protected_by_default.include?(key.gsub(/\(.+/, "")) }
2947
+ elsif self.class.protected_attributes.nil?
2948
+ attributes.reject { |key, value| !self.class.accessible_attributes.include?(key.gsub(/\(.+/, "")) || attributes_protected_by_default.include?(key.gsub(/\(.+/, "")) }
2949
+ elsif self.class.accessible_attributes.nil?
2950
+ attributes.reject { |key, value| self.class.protected_attributes.include?(key.gsub(/\(.+/,"")) || attributes_protected_by_default.include?(key.gsub(/\(.+/, "")) }
2951
+ else
2952
+ raise "Declare either attr_protected or attr_accessible for #{self.class}, but not both."
2953
+ end
2954
+
2955
+ removed_attributes = attributes.keys - safe_attributes.keys
2956
+
2957
+ if removed_attributes.any?
2958
+ log_protected_attribute_removal(removed_attributes)
2959
+ end
2960
+
2961
+ safe_attributes
2962
+ end
2963
+
2964
+ # Removes attributes which have been marked as readonly.
2965
+ def remove_readonly_attributes(attributes)
2966
+ unless self.class.readonly_attributes.nil?
2967
+ attributes.delete_if { |key, value| self.class.readonly_attributes.include?(key.gsub(/\(.+/,"")) }
2968
+ else
2969
+ attributes
2970
+ end
2971
+ end
2972
+
2973
+ def log_protected_attribute_removal(*attributes)
2974
+ logger.debug "WARNING: Can't mass-assign these protected attributes: #{attributes.join(', ')}"
2975
+ end
2976
+
2977
+ # The primary key and inheritance column can never be set by mass-assignment for security reasons.
2978
+ def attributes_protected_by_default
2979
+ default = [ self.class.primary_key, self.class.inheritance_column ]
2980
+ default << 'id' unless self.class.primary_key.eql? 'id'
2981
+ default
2982
+ end
2983
+
2984
+ # Returns a copy of the attributes hash where all the values have been safely quoted for use in
2985
+ # an SQL statement.
2986
+ def attributes_with_quotes(include_primary_key = true, include_readonly_attributes = true, attribute_names = @attributes.keys)
2987
+ quoted = {}
2988
+ connection = self.class.connection
2989
+ attribute_names.each do |name|
2990
+ if (column = column_for_attribute(name)) && (include_primary_key || !column.primary)
2991
+ value = read_attribute(name)
2992
+
2993
+ # We need explicit to_yaml because quote() does not properly convert Time/Date fields to YAML.
2994
+ if value && self.class.serialized_attributes.has_key?(name) && (value.acts_like?(:date) || value.acts_like?(:time))
2995
+ value = value.to_yaml
2996
+ end
2997
+
2998
+ quoted[name] = connection.quote(value, column)
2999
+ end
3000
+ end
3001
+ include_readonly_attributes ? quoted : remove_readonly_attributes(quoted)
3002
+ end
3003
+
3004
+ # Quote strings appropriately for SQL statements.
3005
+ def quote_value(value, column = nil)
3006
+ self.class.connection.quote(value, column)
3007
+ end
3008
+
3009
+ # Interpolate custom SQL string in instance context.
3010
+ # Optional record argument is meant for custom insert_sql.
3011
+ def interpolate_sql(sql, record = nil)
3012
+ instance_eval("%@#{sql.gsub('@', '\@')}@")
3013
+ end
3014
+
3015
+ # Initializes the attributes array with keys matching the columns from the linked table and
3016
+ # the values matching the corresponding default value of that column, so
3017
+ # that a new instance, or one populated from a passed-in Hash, still has all the attributes
3018
+ # that instances loaded from the database would.
3019
+ def attributes_from_column_definition
3020
+ self.class.columns.inject({}) do |attributes, column|
3021
+ attributes[column.name] = column.default unless column.name == self.class.primary_key
3022
+ attributes
3023
+ end
3024
+ end
3025
+
3026
+ # Instantiates objects for all attribute classes that needs more than one constructor parameter. This is done
3027
+ # by calling new on the column type or aggregation type (through composed_of) object with these parameters.
3028
+ # So having the pairs written_on(1) = "2004", written_on(2) = "6", written_on(3) = "24", will instantiate
3029
+ # written_on (a date type) with Date.new("2004", "6", "24"). You can also specify a typecast character in the
3030
+ # parentheses to have the parameters typecasted before they're used in the constructor. Use i for Fixnum, f for Float,
3031
+ # s for String, and a for Array. If all the values for a given attribute are empty, the attribute will be set to nil.
3032
+ def assign_multiparameter_attributes(pairs)
3033
+ execute_callstack_for_multiparameter_attributes(
3034
+ extract_callstack_for_multiparameter_attributes(pairs)
3035
+ )
3036
+ end
3037
+
3038
+ def instantiate_time_object(name, values)
3039
+ if self.class.send(:create_time_zone_conversion_attribute?, name, column_for_attribute(name))
3040
+ Time.zone.local(*values)
3041
+ else
3042
+ Time.time_with_datetime_fallback(@@default_timezone, *values)
3043
+ end
3044
+ end
3045
+
3046
+ def execute_callstack_for_multiparameter_attributes(callstack)
3047
+ errors = []
3048
+ callstack.each do |name, values_with_empty_parameters|
3049
+ begin
3050
+ klass = (self.class.reflect_on_aggregation(name.to_sym) || column_for_attribute(name)).klass
3051
+ # in order to allow a date to be set without a year, we must keep the empty values.
3052
+ # Otherwise, we wouldn't be able to distinguish it from a date with an empty day.
3053
+ values = values_with_empty_parameters.reject(&:nil?)
3054
+
3055
+ if values.empty?
3056
+ send(name + "=", nil)
3057
+ else
3058
+
3059
+ value = if Time == klass
3060
+ instantiate_time_object(name, values)
3061
+ elsif Date == klass
3062
+ begin
3063
+ values = values_with_empty_parameters.collect do |v| v.nil? ? 1 : v end
3064
+ Date.new(*values)
3065
+ rescue ArgumentError => ex # if Date.new raises an exception on an invalid date
3066
+ instantiate_time_object(name, values).to_date # we instantiate Time object and convert it back to a date thus using Time's logic in handling invalid dates
3067
+ end
3068
+ else
3069
+ klass.new(*values)
3070
+ end
3071
+
3072
+ send(name + "=", value)
3073
+ end
3074
+ rescue => ex
3075
+ errors << AttributeAssignmentError.new("error on assignment #{values.inspect} to #{name}", ex, name)
3076
+ end
3077
+ end
3078
+ unless errors.empty?
3079
+ raise MultiparameterAssignmentErrors.new(errors), "#{errors.size} error(s) on assignment of multiparameter attributes"
3080
+ end
3081
+ end
3082
+
3083
+ def extract_callstack_for_multiparameter_attributes(pairs)
3084
+ attributes = { }
3085
+
3086
+ for pair in pairs
3087
+ multiparameter_name, value = pair
3088
+ attribute_name = multiparameter_name.split("(").first
3089
+ attributes[attribute_name] = [] unless attributes.include?(attribute_name)
3090
+
3091
+ parameter_value = value.empty? ? nil : type_cast_attribute_value(multiparameter_name, value)
3092
+ attributes[attribute_name] << [ find_parameter_position(multiparameter_name), parameter_value ]
3093
+ end
3094
+
3095
+ attributes.each { |name, values| attributes[name] = values.sort_by{ |v| v.first }.collect { |v| v.last } }
3096
+ end
3097
+
3098
+ def type_cast_attribute_value(multiparameter_name, value)
3099
+ multiparameter_name =~ /\([0-9]*([if])\)/ ? value.send("to_" + $1) : value
3100
+ end
3101
+
3102
+ def find_parameter_position(multiparameter_name)
3103
+ multiparameter_name.scan(/\(([0-9]*).*\)/).first.first
3104
+ end
3105
+
3106
+ # Returns a comma-separated pair list, like "key1 = val1, key2 = val2".
3107
+ def comma_pair_list(hash)
3108
+ hash.inject([]) { |list, pair| list << "#{pair.first} = #{pair.last}" }.join(", ")
3109
+ end
3110
+
3111
+ def quoted_column_names(attributes = attributes_with_quotes)
3112
+ connection = self.class.connection
3113
+ attributes.keys.collect do |column_name|
3114
+ connection.quote_column_name(column_name)
3115
+ end
3116
+ end
3117
+
3118
+ def self.quoted_table_name
3119
+ self.connection.quote_table_name(self.table_name)
3120
+ end
3121
+
3122
+ def quote_columns(quoter, hash)
3123
+ hash.inject({}) do |quoted, (name, value)|
3124
+ quoted[quoter.quote_column_name(name)] = value
3125
+ quoted
3126
+ end
3127
+ end
3128
+
3129
+ def quoted_comma_pair_list(quoter, hash)
3130
+ comma_pair_list(quote_columns(quoter, hash))
3131
+ end
3132
+
3133
+ def object_from_yaml(string)
3134
+ return string unless string.is_a?(String) && string =~ /^---/
3135
+ YAML::load(string) rescue string
3136
+ end
3137
+
3138
+ def clone_attributes(reader_method = :read_attribute, attributes = {})
3139
+ self.attribute_names.inject(attributes) do |attrs, name|
3140
+ attrs[name] = clone_attribute_value(reader_method, name)
3141
+ attrs
3142
+ end
3143
+ end
3144
+
3145
+ def clone_attribute_value(reader_method, attribute_name)
3146
+ value = send(reader_method, attribute_name)
3147
+ value.duplicable? ? value.clone : value
3148
+ rescue TypeError, NoMethodError
3149
+ value
3150
+ end
3151
+ end
3152
+
3153
+ Base.class_eval do
3154
+ extend QueryCache::ClassMethods
3155
+ include Validations
3156
+ include Locking::Optimistic, Locking::Pessimistic
3157
+ include AttributeMethods
3158
+ include Dirty
3159
+ include Callbacks, Observing, Timestamp
3160
+ include Associations, AssociationPreload, NamedScope
3161
+
3162
+ # AutosaveAssociation needs to be included before Transactions, because we want
3163
+ # #save_with_autosave_associations to be wrapped inside a transaction.
3164
+ include AutosaveAssociation, NestedAttributes
3165
+
3166
+ include Aggregations, Transactions, Reflection, Batches, Calculations, Serialization
3167
+ end
3168
+ end
3169
+
3170
+ # TODO: Remove this and make it work with LAZY flag
3171
+ require 'active_record/connection_adapters/abstract_adapter'