activerecord_csi 2.3.5.p6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
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,2241 @@
1
+ module ActiveRecord
2
+ class HasManyThroughAssociationNotFoundError < ActiveRecordError #:nodoc:
3
+ def initialize(owner_class_name, reflection)
4
+ super("Could not find the association #{reflection.options[:through].inspect} in model #{owner_class_name}")
5
+ end
6
+ end
7
+
8
+ class HasManyThroughAssociationPolymorphicError < ActiveRecordError #:nodoc:
9
+ def initialize(owner_class_name, reflection, source_reflection)
10
+ super("Cannot have a has_many :through association '#{owner_class_name}##{reflection.name}' on the polymorphic object '#{source_reflection.class_name}##{source_reflection.name}'.")
11
+ end
12
+ end
13
+
14
+ class HasManyThroughAssociationPointlessSourceTypeError < ActiveRecordError #:nodoc:
15
+ def initialize(owner_class_name, reflection, source_reflection)
16
+ super("Cannot have a has_many :through association '#{owner_class_name}##{reflection.name}' with a :source_type option if the '#{reflection.through_reflection.class_name}##{source_reflection.name}' is not polymorphic. Try removing :source_type on your association.")
17
+ end
18
+ end
19
+
20
+ class HasManyThroughSourceAssociationNotFoundError < ActiveRecordError #:nodoc:
21
+ def initialize(reflection)
22
+ through_reflection = reflection.through_reflection
23
+ source_reflection_names = reflection.source_reflection_names
24
+ source_associations = reflection.through_reflection.klass.reflect_on_all_associations.collect { |a| a.name.inspect }
25
+ super("Could not find the source association(s) #{source_reflection_names.collect(&:inspect).to_sentence(:two_words_connector => ' or ', :last_word_connector => ', or ', :locale => :en)} in model #{through_reflection.klass}. Try 'has_many #{reflection.name.inspect}, :through => #{through_reflection.name.inspect}, :source => <name>'. Is it one of #{source_associations.to_sentence(:two_words_connector => ' or ', :last_word_connector => ', or ', :locale => :en)}?")
26
+ end
27
+ end
28
+
29
+ class HasManyThroughSourceAssociationMacroError < ActiveRecordError #:nodoc:
30
+ def initialize(reflection)
31
+ through_reflection = reflection.through_reflection
32
+ source_reflection = reflection.source_reflection
33
+ super("Invalid source reflection macro :#{source_reflection.macro}#{" :through" if source_reflection.options[:through]} for has_many #{reflection.name.inspect}, :through => #{through_reflection.name.inspect}. Use :source to specify the source reflection.")
34
+ end
35
+ end
36
+
37
+ class HasManyThroughCantAssociateThroughHasOneOrManyReflection < ActiveRecordError #:nodoc:
38
+ def initialize(owner, reflection)
39
+ super("Cannot modify association '#{owner.class.name}##{reflection.name}' because the source reflection class '#{reflection.source_reflection.class_name}' is associated to '#{reflection.through_reflection.class_name}' via :#{reflection.source_reflection.macro}.")
40
+ end
41
+ end
42
+ HasManyThroughCantAssociateThroughHasManyReflection = ActiveSupport::Deprecation::DeprecatedConstantProxy.new('ActiveRecord::HasManyThroughCantAssociateThroughHasManyReflection', 'ActiveRecord::HasManyThroughCantAssociateThroughHasOneOrManyReflection')
43
+
44
+ class HasManyThroughCantAssociateNewRecords < ActiveRecordError #:nodoc:
45
+ def initialize(owner, reflection)
46
+ super("Cannot associate new records through '#{owner.class.name}##{reflection.name}' on '#{reflection.source_reflection.class_name rescue nil}##{reflection.source_reflection.name rescue nil}'. Both records must have an id in order to create the has_many :through record associating them.")
47
+ end
48
+ end
49
+
50
+ class HasManyThroughCantDissociateNewRecords < ActiveRecordError #:nodoc:
51
+ def initialize(owner, reflection)
52
+ super("Cannot dissociate new records through '#{owner.class.name}##{reflection.name}' on '#{reflection.source_reflection.class_name rescue nil}##{reflection.source_reflection.name rescue nil}'. Both records must have an id in order to delete the has_many :through record associating them.")
53
+ end
54
+ end
55
+
56
+ class HasAndBelongsToManyAssociationForeignKeyNeeded < ActiveRecordError #:nodoc:
57
+ def initialize(reflection)
58
+ super("Cannot create self referential has_and_belongs_to_many association on '#{reflection.class_name rescue nil}##{reflection.name rescue nil}'. :association_foreign_key cannot be the same as the :foreign_key.")
59
+ end
60
+ end
61
+
62
+ class EagerLoadPolymorphicError < ActiveRecordError #:nodoc:
63
+ def initialize(reflection)
64
+ super("Can not eagerly load the polymorphic association #{reflection.name.inspect}")
65
+ end
66
+ end
67
+
68
+ class ReadOnlyAssociation < ActiveRecordError #:nodoc:
69
+ def initialize(reflection)
70
+ super("Can not add to a has_many :through association. Try adding to #{reflection.through_reflection.name.inspect}.")
71
+ end
72
+ end
73
+
74
+ # See ActiveRecord::Associations::ClassMethods for documentation.
75
+ module Associations # :nodoc:
76
+ # These classes will be loaded when associations are created.
77
+ # So there is no need to eager load them.
78
+ autoload :AssociationCollection, 'active_record/associations/association_collection'
79
+ autoload :AssociationProxy, 'active_record/associations/association_proxy'
80
+ autoload :BelongsToAssociation, 'active_record/associations/belongs_to_association'
81
+ autoload :BelongsToPolymorphicAssociation, 'active_record/associations/belongs_to_polymorphic_association'
82
+ autoload :HasAndBelongsToManyAssociation, 'active_record/associations/has_and_belongs_to_many_association'
83
+ autoload :HasManyAssociation, 'active_record/associations/has_many_association'
84
+ autoload :HasManyThroughAssociation, 'active_record/associations/has_many_through_association'
85
+ autoload :HasOneAssociation, 'active_record/associations/has_one_association'
86
+ autoload :HasOneThroughAssociation, 'active_record/associations/has_one_through_association'
87
+
88
+ def self.included(base)
89
+ base.extend(ClassMethods)
90
+ end
91
+
92
+ # Clears out the association cache
93
+ def clear_association_cache #:nodoc:
94
+ self.class.reflect_on_all_associations.to_a.each do |assoc|
95
+ instance_variable_set "@#{assoc.name}", nil
96
+ end unless self.new_record?
97
+ end
98
+
99
+ private
100
+ # Gets the specified association instance if it responds to :loaded?, nil otherwise.
101
+ def association_instance_get(name)
102
+ association = instance_variable_get("@#{name}")
103
+ association if association.respond_to?(:loaded?)
104
+ end
105
+
106
+ # Set the specified association instance.
107
+ def association_instance_set(name, association)
108
+ instance_variable_set("@#{name}", association)
109
+ end
110
+
111
+ # Associations are a set of macro-like class methods for tying objects together through foreign keys. They express relationships like
112
+ # "Project has one Project Manager" or "Project belongs to a Portfolio". Each macro adds a number of methods to the class which are
113
+ # specialized according to the collection or association symbol and the options hash. It works much the same way as Ruby's own <tt>attr*</tt>
114
+ # methods. Example:
115
+ #
116
+ # class Project < ActiveRecord::Base
117
+ # belongs_to :portfolio
118
+ # has_one :project_manager
119
+ # has_many :milestones
120
+ # has_and_belongs_to_many :categories
121
+ # end
122
+ #
123
+ # The project class now has the following methods (and more) to ease the traversal and manipulation of its relationships:
124
+ # * <tt>Project#portfolio, Project#portfolio=(portfolio), Project#portfolio.nil?</tt>
125
+ # * <tt>Project#project_manager, Project#project_manager=(project_manager), Project#project_manager.nil?,</tt>
126
+ # * <tt>Project#milestones.empty?, Project#milestones.size, Project#milestones, Project#milestones<<(milestone),</tt>
127
+ # <tt>Project#milestones.delete(milestone), Project#milestones.find(milestone_id), Project#milestones.find(:all, options),</tt>
128
+ # <tt>Project#milestones.build, Project#milestones.create</tt>
129
+ # * <tt>Project#categories.empty?, Project#categories.size, Project#categories, Project#categories<<(category1),</tt>
130
+ # <tt>Project#categories.delete(category1)</tt>
131
+ #
132
+ # === A word of warning
133
+ #
134
+ # Don't create associations that have the same name as instance methods of ActiveRecord::Base. Since the association
135
+ # adds a method with that name to its model, it will override the inherited method and break things.
136
+ # For instance, +attributes+ and +connection+ would be bad choices for association names.
137
+ #
138
+ # == Auto-generated methods
139
+ #
140
+ # === Singular associations (one-to-one)
141
+ # | | belongs_to |
142
+ # generated methods | belongs_to | :polymorphic | has_one
143
+ # ----------------------------------+------------+--------------+---------
144
+ # other | X | X | X
145
+ # other=(other) | X | X | X
146
+ # build_other(attributes={}) | X | | X
147
+ # create_other(attributes={}) | X | | X
148
+ # other.create!(attributes={}) | | | X
149
+ #
150
+ # ===Collection associations (one-to-many / many-to-many)
151
+ # | | | has_many
152
+ # generated methods | habtm | has_many | :through
153
+ # ----------------------------------+-------+----------+----------
154
+ # others | X | X | X
155
+ # others=(other,other,...) | X | X | X
156
+ # other_ids | X | X | X
157
+ # other_ids=(id,id,...) | X | X | X
158
+ # others<< | X | X | X
159
+ # others.push | X | X | X
160
+ # others.concat | X | X | X
161
+ # others.build(attributes={}) | X | X | X
162
+ # others.create(attributes={}) | X | X | X
163
+ # others.create!(attributes={}) | X | X | X
164
+ # others.size | X | X | X
165
+ # others.length | X | X | X
166
+ # others.count | X | X | X
167
+ # others.sum(args*,&block) | X | X | X
168
+ # others.empty? | X | X | X
169
+ # others.clear | X | X | X
170
+ # others.delete(other,other,...) | X | X | X
171
+ # others.delete_all | X | X |
172
+ # others.destroy_all | X | X | X
173
+ # others.find(*args) | X | X | X
174
+ # others.find_first | X | |
175
+ # others.exists? | X | X | X
176
+ # others.uniq | X | X | X
177
+ # others.reset | X | X | X
178
+ #
179
+ # == Cardinality and associations
180
+ #
181
+ # Active Record associations can be used to describe one-to-one, one-to-many and many-to-many
182
+ # relationships between models. Each model uses an association to describe its role in
183
+ # the relation. The +belongs_to+ association is always used in the model that has
184
+ # the foreign key.
185
+ #
186
+ # === One-to-one
187
+ #
188
+ # Use +has_one+ in the base, and +belongs_to+ in the associated model.
189
+ #
190
+ # class Employee < ActiveRecord::Base
191
+ # has_one :office
192
+ # end
193
+ # class Office < ActiveRecord::Base
194
+ # belongs_to :employee # foreign key - employee_id
195
+ # end
196
+ #
197
+ # === One-to-many
198
+ #
199
+ # Use +has_many+ in the base, and +belongs_to+ in the associated model.
200
+ #
201
+ # class Manager < ActiveRecord::Base
202
+ # has_many :employees
203
+ # end
204
+ # class Employee < ActiveRecord::Base
205
+ # belongs_to :manager # foreign key - manager_id
206
+ # end
207
+ #
208
+ # === Many-to-many
209
+ #
210
+ # There are two ways to build a many-to-many relationship.
211
+ #
212
+ # The first way uses a +has_many+ association with the <tt>:through</tt> option and a join model, so
213
+ # there are two stages of associations.
214
+ #
215
+ # class Assignment < ActiveRecord::Base
216
+ # belongs_to :programmer # foreign key - programmer_id
217
+ # belongs_to :project # foreign key - project_id
218
+ # end
219
+ # class Programmer < ActiveRecord::Base
220
+ # has_many :assignments
221
+ # has_many :projects, :through => :assignments
222
+ # end
223
+ # class Project < ActiveRecord::Base
224
+ # has_many :assignments
225
+ # has_many :programmers, :through => :assignments
226
+ # end
227
+ #
228
+ # For the second way, use +has_and_belongs_to_many+ in both models. This requires a join table
229
+ # that has no corresponding model or primary key.
230
+ #
231
+ # class Programmer < ActiveRecord::Base
232
+ # has_and_belongs_to_many :projects # foreign keys in the join table
233
+ # end
234
+ # class Project < ActiveRecord::Base
235
+ # has_and_belongs_to_many :programmers # foreign keys in the join table
236
+ # end
237
+ #
238
+ # Choosing which way to build a many-to-many relationship is not always simple.
239
+ # If you need to work with the relationship model as its own entity,
240
+ # use <tt>has_many :through</tt>. Use +has_and_belongs_to_many+ when working with legacy schemas or when
241
+ # you never work directly with the relationship itself.
242
+ #
243
+ # == Is it a +belongs_to+ or +has_one+ association?
244
+ #
245
+ # Both express a 1-1 relationship. The difference is mostly where to place the foreign key, which goes on the table for the class
246
+ # declaring the +belongs_to+ relationship. Example:
247
+ #
248
+ # class User < ActiveRecord::Base
249
+ # # I reference an account.
250
+ # belongs_to :account
251
+ # end
252
+ #
253
+ # class Account < ActiveRecord::Base
254
+ # # One user references me.
255
+ # has_one :user
256
+ # end
257
+ #
258
+ # The tables for these classes could look something like:
259
+ #
260
+ # CREATE TABLE users (
261
+ # id int(11) NOT NULL auto_increment,
262
+ # account_id int(11) default NULL,
263
+ # name varchar default NULL,
264
+ # PRIMARY KEY (id)
265
+ # )
266
+ #
267
+ # CREATE TABLE accounts (
268
+ # id int(11) NOT NULL auto_increment,
269
+ # name varchar default NULL,
270
+ # PRIMARY KEY (id)
271
+ # )
272
+ #
273
+ # == Unsaved objects and associations
274
+ #
275
+ # You can manipulate objects and associations before they are saved to the database, but there is some special behavior you should be
276
+ # aware of, mostly involving the saving of associated objects.
277
+ #
278
+ # Unless you set the :autosave option on a <tt>has_one</tt>, <tt>belongs_to</tt>,
279
+ # <tt>has_many</tt>, or <tt>has_and_belongs_to_many</tt> association. Setting it
280
+ # to +true+ will _always_ save the members, whereas setting it to +false+ will
281
+ # _never_ save the members.
282
+ #
283
+ # === One-to-one associations
284
+ #
285
+ # * Assigning an object to a +has_one+ association automatically saves that object and the object being replaced (if there is one), in
286
+ # order to update their primary keys - except if the parent object is unsaved (<tt>new_record? == true</tt>).
287
+ # * If either of these saves fail (due to one of the objects being invalid) the assignment statement returns +false+ and the assignment
288
+ # is cancelled.
289
+ # * If you wish to assign an object to a +has_one+ association without saving it, use the <tt>association.build</tt> method (documented below).
290
+ # * Assigning an object to a +belongs_to+ association does not save the object, since the foreign key field belongs on the parent. It
291
+ # does not save the parent either.
292
+ #
293
+ # === Collections
294
+ #
295
+ # * Adding an object to a collection (+has_many+ or +has_and_belongs_to_many+) automatically saves that object, except if the parent object
296
+ # (the owner of the collection) is not yet stored in the database.
297
+ # * If saving any of the objects being added to a collection (via <tt>push</tt> or similar) fails, then <tt>push</tt> returns +false+.
298
+ # * You can add an object to a collection without automatically saving it by using the <tt>collection.build</tt> method (documented below).
299
+ # * All unsaved (<tt>new_record? == true</tt>) members of the collection are automatically saved when the parent is saved.
300
+ #
301
+ # === Association callbacks
302
+ #
303
+ # Similar to the normal callbacks that hook into the lifecycle of an Active Record object, you can also define callbacks that get
304
+ # triggered when you add an object to or remove an object from an association collection. Example:
305
+ #
306
+ # class Project
307
+ # has_and_belongs_to_many :developers, :after_add => :evaluate_velocity
308
+ #
309
+ # def evaluate_velocity(developer)
310
+ # ...
311
+ # end
312
+ # end
313
+ #
314
+ # It's possible to stack callbacks by passing them as an array. Example:
315
+ #
316
+ # class Project
317
+ # has_and_belongs_to_many :developers, :after_add => [:evaluate_velocity, Proc.new { |p, d| p.shipping_date = Time.now}]
318
+ # end
319
+ #
320
+ # Possible callbacks are: +before_add+, +after_add+, +before_remove+ and +after_remove+.
321
+ #
322
+ # Should any of the +before_add+ callbacks throw an exception, the object does not get added to the collection. Same with
323
+ # the +before_remove+ callbacks; if an exception is thrown the object doesn't get removed.
324
+ #
325
+ # === Association extensions
326
+ #
327
+ # The proxy objects that control the access to associations can be extended through anonymous modules. This is especially
328
+ # beneficial for adding new finders, creators, and other factory-type methods that are only used as part of this association.
329
+ # Example:
330
+ #
331
+ # class Account < ActiveRecord::Base
332
+ # has_many :people do
333
+ # def find_or_create_by_name(name)
334
+ # first_name, last_name = name.split(" ", 2)
335
+ # find_or_create_by_first_name_and_last_name(first_name, last_name)
336
+ # end
337
+ # end
338
+ # end
339
+ #
340
+ # person = Account.find(:first).people.find_or_create_by_name("David Heinemeier Hansson")
341
+ # person.first_name # => "David"
342
+ # person.last_name # => "Heinemeier Hansson"
343
+ #
344
+ # If you need to share the same extensions between many associations, you can use a named extension module. Example:
345
+ #
346
+ # module FindOrCreateByNameExtension
347
+ # def find_or_create_by_name(name)
348
+ # first_name, last_name = name.split(" ", 2)
349
+ # find_or_create_by_first_name_and_last_name(first_name, last_name)
350
+ # end
351
+ # end
352
+ #
353
+ # class Account < ActiveRecord::Base
354
+ # has_many :people, :extend => FindOrCreateByNameExtension
355
+ # end
356
+ #
357
+ # class Company < ActiveRecord::Base
358
+ # has_many :people, :extend => FindOrCreateByNameExtension
359
+ # end
360
+ #
361
+ # If you need to use multiple named extension modules, you can specify an array of modules with the <tt>:extend</tt> option.
362
+ # In the case of name conflicts between methods in the modules, methods in modules later in the array supercede
363
+ # those earlier in the array. Example:
364
+ #
365
+ # class Account < ActiveRecord::Base
366
+ # has_many :people, :extend => [FindOrCreateByNameExtension, FindRecentExtension]
367
+ # end
368
+ #
369
+ # Some extensions can only be made to work with knowledge of the association proxy's internals.
370
+ # Extensions can access relevant state using accessors on the association proxy:
371
+ #
372
+ # * +proxy_owner+ - Returns the object the association is part of.
373
+ # * +proxy_reflection+ - Returns the reflection object that describes the association.
374
+ # * +proxy_target+ - Returns the associated object for +belongs_to+ and +has_one+, or the collection of associated objects for +has_many+ and +has_and_belongs_to_many+.
375
+ #
376
+ # === Association Join Models
377
+ #
378
+ # Has Many associations can be configured with the <tt>:through</tt> option to use an explicit join model to retrieve the data. This
379
+ # operates similarly to a +has_and_belongs_to_many+ association. The advantage is that you're able to add validations,
380
+ # callbacks, and extra attributes on the join model. Consider the following schema:
381
+ #
382
+ # class Author < ActiveRecord::Base
383
+ # has_many :authorships
384
+ # has_many :books, :through => :authorships
385
+ # end
386
+ #
387
+ # class Authorship < ActiveRecord::Base
388
+ # belongs_to :author
389
+ # belongs_to :book
390
+ # end
391
+ #
392
+ # @author = Author.find :first
393
+ # @author.authorships.collect { |a| a.book } # selects all books that the author's authorships belong to.
394
+ # @author.books # selects all books by using the Authorship join model
395
+ #
396
+ # You can also go through a +has_many+ association on the join model:
397
+ #
398
+ # class Firm < ActiveRecord::Base
399
+ # has_many :clients
400
+ # has_many :invoices, :through => :clients
401
+ # end
402
+ #
403
+ # class Client < ActiveRecord::Base
404
+ # belongs_to :firm
405
+ # has_many :invoices
406
+ # end
407
+ #
408
+ # class Invoice < ActiveRecord::Base
409
+ # belongs_to :client
410
+ # end
411
+ #
412
+ # @firm = Firm.find :first
413
+ # @firm.clients.collect { |c| c.invoices }.flatten # select all invoices for all clients of the firm
414
+ # @firm.invoices # selects all invoices by going through the Client join model.
415
+ #
416
+ # Similarly you can go through a +has_one+ association on the join model:
417
+ #
418
+ # class Group < ActiveRecord::Base
419
+ # has_many :users
420
+ # has_many :avatars, :through => :users
421
+ # end
422
+ #
423
+ # class User < ActiveRecord::Base
424
+ # belongs_to :group
425
+ # has_one :avatar
426
+ # end
427
+ #
428
+ # class Avatar < ActiveRecord::Base
429
+ # belongs_to :user
430
+ # end
431
+ #
432
+ # @group = Group.first
433
+ # @group.users.collect { |u| u.avatar }.flatten # select all avatars for all users in the group
434
+ # @group.avatars # selects all avatars by going through the User join model.
435
+ #
436
+ # An important caveat with going through +has_one+ or +has_many+ associations on the join model is that these associations are
437
+ # *read-only*. For example, the following would not work following the previous example:
438
+ #
439
+ # @group.avatars << Avatar.new # this would work if User belonged_to Avatar rather than the other way around.
440
+ # @group.avatars.delete(@group.avatars.last) # so would this
441
+ #
442
+ # === Polymorphic Associations
443
+ #
444
+ # Polymorphic associations on models are not restricted on what types of models they can be associated with. Rather, they
445
+ # specify an interface that a +has_many+ association must adhere to.
446
+ #
447
+ # class Asset < ActiveRecord::Base
448
+ # belongs_to :attachable, :polymorphic => true
449
+ # end
450
+ #
451
+ # class Post < ActiveRecord::Base
452
+ # has_many :assets, :as => :attachable # The :as option specifies the polymorphic interface to use.
453
+ # end
454
+ #
455
+ # @asset.attachable = @post
456
+ #
457
+ # This works by using a type column in addition to a foreign key to specify the associated record. In the Asset example, you'd need
458
+ # an +attachable_id+ integer column and an +attachable_type+ string column.
459
+ #
460
+ # Using polymorphic associations in combination with single table inheritance (STI) is a little tricky. In order
461
+ # for the associations to work as expected, ensure that you store the base model for the STI models in the
462
+ # type column of the polymorphic association. To continue with the asset example above, suppose there are guest posts
463
+ # and member posts that use the posts table for STI. In this case, there must be a +type+ column in the posts table.
464
+ #
465
+ # class Asset < ActiveRecord::Base
466
+ # belongs_to :attachable, :polymorphic => true
467
+ #
468
+ # def attachable_type=(sType)
469
+ # super(sType.to_s.classify.constantize.base_class.to_s)
470
+ # end
471
+ # end
472
+ #
473
+ # class Post < ActiveRecord::Base
474
+ # # because we store "Post" in attachable_type now :dependent => :destroy will work
475
+ # has_many :assets, :as => :attachable, :dependent => :destroy
476
+ # end
477
+ #
478
+ # class GuestPost < Post
479
+ # end
480
+ #
481
+ # class MemberPost < Post
482
+ # end
483
+ #
484
+ # == Caching
485
+ #
486
+ # All of the methods are built on a simple caching principle that will keep the result of the last query around unless specifically
487
+ # instructed not to. The cache is even shared across methods to make it even cheaper to use the macro-added methods without
488
+ # worrying too much about performance at the first go. Example:
489
+ #
490
+ # project.milestones # fetches milestones from the database
491
+ # project.milestones.size # uses the milestone cache
492
+ # project.milestones.empty? # uses the milestone cache
493
+ # project.milestones(true).size # fetches milestones from the database
494
+ # project.milestones # uses the milestone cache
495
+ #
496
+ # == Eager loading of associations
497
+ #
498
+ # Eager loading is a way to find objects of a certain class and a number of named associations. This is
499
+ # one of the easiest ways of to prevent the dreaded 1+N problem in which fetching 100 posts that each need to display their author
500
+ # triggers 101 database queries. Through the use of eager loading, the 101 queries can be reduced to 2. Example:
501
+ #
502
+ # class Post < ActiveRecord::Base
503
+ # belongs_to :author
504
+ # has_many :comments
505
+ # end
506
+ #
507
+ # Consider the following loop using the class above:
508
+ #
509
+ # for post in Post.all
510
+ # puts "Post: " + post.title
511
+ # puts "Written by: " + post.author.name
512
+ # puts "Last comment on: " + post.comments.first.created_on
513
+ # end
514
+ #
515
+ # To iterate over these one hundred posts, we'll generate 201 database queries. Let's first just optimize it for retrieving the author:
516
+ #
517
+ # for post in Post.find(:all, :include => :author)
518
+ #
519
+ # This references the name of the +belongs_to+ association that also used the <tt>:author</tt> symbol. After loading the posts, find
520
+ # will collect the +author_id+ from each one and load all the referenced authors with one query. Doing so will cut down the number of queries from 201 to 102.
521
+ #
522
+ # We can improve upon the situation further by referencing both associations in the finder with:
523
+ #
524
+ # for post in Post.find(:all, :include => [ :author, :comments ])
525
+ #
526
+ # This will load all comments with a single query. This reduces the total number of queries to 3. More generally the number of queries
527
+ # will be 1 plus the number of associations named (except if some of the associations are polymorphic +belongs_to+ - see below).
528
+ #
529
+ # To include a deep hierarchy of associations, use a hash:
530
+ #
531
+ # for post in Post.find(:all, :include => [ :author, { :comments => { :author => :gravatar } } ])
532
+ #
533
+ # That'll grab not only all the comments but all their authors and gravatar pictures. You can mix and match
534
+ # symbols, arrays and hashes in any combination to describe the associations you want to load.
535
+ #
536
+ # All of this power shouldn't fool you into thinking that you can pull out huge amounts of data with no performance penalty just because you've reduced
537
+ # the number of queries. The database still needs to send all the data to Active Record and it still needs to be processed. So it's no
538
+ # catch-all for performance problems, but it's a great way to cut down on the number of queries in a situation as the one described above.
539
+ #
540
+ # Since only one table is loaded at a time, conditions or orders cannot reference tables other than the main one. If this is the case
541
+ # Active Record falls back to the previously used LEFT OUTER JOIN based strategy. For example
542
+ #
543
+ # Post.find(:all, :include => [ :author, :comments ], :conditions => ['comments.approved = ?', true])
544
+ #
545
+ # will result in a single SQL query with joins along the lines of: <tt>LEFT OUTER JOIN comments ON comments.post_id = posts.id</tt> and
546
+ # <tt>LEFT OUTER JOIN authors ON authors.id = posts.author_id</tt>. Note that using conditions like this can have unintended consequences.
547
+ # In the above example posts with no approved comments are not returned at all, because the conditions apply to the SQL statement as a whole
548
+ # and not just to the association. You must disambiguate column references for this fallback to happen, for example
549
+ # <tt>:order => "author.name DESC"</tt> will work but <tt>:order => "name DESC"</tt> will not.
550
+ #
551
+ # If you do want eagerload only some members of an association it is usually more natural to <tt>:include</tt> an association
552
+ # which has conditions defined on it:
553
+ #
554
+ # class Post < ActiveRecord::Base
555
+ # has_many :approved_comments, :class_name => 'Comment', :conditions => ['approved = ?', true]
556
+ # end
557
+ #
558
+ # Post.find(:all, :include => :approved_comments)
559
+ #
560
+ # will load posts and eager load the +approved_comments+ association, which contains only those comments that have been approved.
561
+ #
562
+ # If you eager load an association with a specified <tt>:limit</tt> option, it will be ignored, returning all the associated objects:
563
+ #
564
+ # class Picture < ActiveRecord::Base
565
+ # has_many :most_recent_comments, :class_name => 'Comment', :order => 'id DESC', :limit => 10
566
+ # end
567
+ #
568
+ # Picture.find(:first, :include => :most_recent_comments).most_recent_comments # => returns all associated comments.
569
+ #
570
+ # When eager loaded, conditions are interpolated in the context of the model class, not the model instance. Conditions are lazily interpolated
571
+ # before the actual model exists.
572
+ #
573
+ # Eager loading is supported with polymorphic associations.
574
+ #
575
+ # class Address < ActiveRecord::Base
576
+ # belongs_to :addressable, :polymorphic => true
577
+ # end
578
+ #
579
+ # A call that tries to eager load the addressable model
580
+ #
581
+ # Address.find(:all, :include => :addressable)
582
+ #
583
+ # will execute one query to load the addresses and load the addressables with one query per addressable type.
584
+ # For example if all the addressables are either of class Person or Company then a total of 3 queries will be executed. The list of
585
+ # addressable types to load is determined on the back of the addresses loaded. This is not supported if Active Record has to fallback
586
+ # to the previous implementation of eager loading and will raise ActiveRecord::EagerLoadPolymorphicError. The reason is that the parent
587
+ # model's type is a column value so its corresponding table name cannot be put in the +FROM+/+JOIN+ clauses of that query.
588
+ #
589
+ # == Table Aliasing
590
+ #
591
+ # Active Record uses table aliasing in the case that a table is referenced multiple times in a join. If a table is referenced only once,
592
+ # the standard table name is used. The second time, the table is aliased as <tt>#{reflection_name}_#{parent_table_name}</tt>. Indexes are appended
593
+ # for any more successive uses of the table name.
594
+ #
595
+ # Post.find :all, :joins => :comments
596
+ # # => SELECT ... FROM posts INNER JOIN comments ON ...
597
+ # Post.find :all, :joins => :special_comments # STI
598
+ # # => SELECT ... FROM posts INNER JOIN comments ON ... AND comments.type = 'SpecialComment'
599
+ # Post.find :all, :joins => [:comments, :special_comments] # special_comments is the reflection name, posts is the parent table name
600
+ # # => SELECT ... FROM posts INNER JOIN comments ON ... INNER JOIN comments special_comments_posts
601
+ #
602
+ # Acts as tree example:
603
+ #
604
+ # TreeMixin.find :all, :joins => :children
605
+ # # => SELECT ... FROM mixins INNER JOIN mixins childrens_mixins ...
606
+ # TreeMixin.find :all, :joins => {:children => :parent}
607
+ # # => SELECT ... FROM mixins INNER JOIN mixins childrens_mixins ...
608
+ # INNER JOIN parents_mixins ...
609
+ # TreeMixin.find :all, :joins => {:children => {:parent => :children}}
610
+ # # => SELECT ... FROM mixins INNER JOIN mixins childrens_mixins ...
611
+ # INNER JOIN parents_mixins ...
612
+ # INNER JOIN mixins childrens_mixins_2
613
+ #
614
+ # Has and Belongs to Many join tables use the same idea, but add a <tt>_join</tt> suffix:
615
+ #
616
+ # Post.find :all, :joins => :categories
617
+ # # => SELECT ... FROM posts INNER JOIN categories_posts ... INNER JOIN categories ...
618
+ # Post.find :all, :joins => {:categories => :posts}
619
+ # # => SELECT ... FROM posts INNER JOIN categories_posts ... INNER JOIN categories ...
620
+ # INNER JOIN categories_posts posts_categories_join INNER JOIN posts posts_categories
621
+ # Post.find :all, :joins => {:categories => {:posts => :categories}}
622
+ # # => SELECT ... FROM posts INNER JOIN categories_posts ... INNER JOIN categories ...
623
+ # INNER JOIN categories_posts posts_categories_join INNER JOIN posts posts_categories
624
+ # INNER JOIN categories_posts categories_posts_join INNER JOIN categories categories_posts_2
625
+ #
626
+ # If you wish to specify your own custom joins using a <tt>:joins</tt> option, those table names will take precedence over the eager associations:
627
+ #
628
+ # Post.find :all, :joins => :comments, :joins => "inner join comments ..."
629
+ # # => SELECT ... FROM posts INNER JOIN comments_posts ON ... INNER JOIN comments ...
630
+ # Post.find :all, :joins => [:comments, :special_comments], :joins => "inner join comments ..."
631
+ # # => SELECT ... FROM posts INNER JOIN comments comments_posts ON ...
632
+ # INNER JOIN comments special_comments_posts ...
633
+ # INNER JOIN comments ...
634
+ #
635
+ # Table aliases are automatically truncated according to the maximum length of table identifiers according to the specific database.
636
+ #
637
+ # == Modules
638
+ #
639
+ # By default, associations will look for objects within the current module scope. Consider:
640
+ #
641
+ # module MyApplication
642
+ # module Business
643
+ # class Firm < ActiveRecord::Base
644
+ # has_many :clients
645
+ # end
646
+ #
647
+ # class Client < ActiveRecord::Base; end
648
+ # end
649
+ # end
650
+ #
651
+ # When <tt>Firm#clients</tt> is called, it will in turn call <tt>MyApplication::Business::Client.find_all_by_firm_id(firm.id)</tt>.
652
+ # If you want to associate with a class in another module scope, this can be done by specifying the complete class name.
653
+ # Example:
654
+ #
655
+ # module MyApplication
656
+ # module Business
657
+ # class Firm < ActiveRecord::Base; end
658
+ # end
659
+ #
660
+ # module Billing
661
+ # class Account < ActiveRecord::Base
662
+ # belongs_to :firm, :class_name => "MyApplication::Business::Firm"
663
+ # end
664
+ # end
665
+ # end
666
+ #
667
+ # == Type safety with <tt>ActiveRecord::AssociationTypeMismatch</tt>
668
+ #
669
+ # If you attempt to assign an object to an association that doesn't match the inferred or specified <tt>:class_name</tt>, you'll
670
+ # get an <tt>ActiveRecord::AssociationTypeMismatch</tt>.
671
+ #
672
+ # == Options
673
+ #
674
+ # All of the association macros can be specialized through options. This makes cases more complex than the simple and guessable ones
675
+ # possible.
676
+ module ClassMethods
677
+ # Specifies a one-to-many association. The following methods for retrieval and query of
678
+ # collections of associated objects will be added:
679
+ #
680
+ # [collection(force_reload = false)]
681
+ # Returns an array of all the associated objects.
682
+ # An empty array is returned if none are found.
683
+ # [collection<<(object, ...)]
684
+ # Adds one or more objects to the collection by setting their foreign keys to the collection's primary key.
685
+ # [collection.delete(object, ...)]
686
+ # Removes one or more objects from the collection by setting their foreign keys to +NULL+.
687
+ # Objects will be in addition destroyed if they're associated with <tt>:dependent => :destroy</tt>,
688
+ # and deleted if they're associated with <tt>:dependent => :delete_all</tt>.
689
+ # [collection=objects]
690
+ # Replaces the collections content by deleting and adding objects as appropriate.
691
+ # [collection_singular_ids]
692
+ # Returns an array of the associated objects' ids
693
+ # [collection_singular_ids=ids]
694
+ # Replace the collection with the objects identified by the primary keys in +ids+
695
+ # [collection.clear]
696
+ # Removes every object from the collection. This destroys the associated objects if they
697
+ # are associated with <tt>:dependent => :destroy</tt>, deletes them directly from the
698
+ # database if <tt>:dependent => :delete_all</tt>, otherwise sets their foreign keys to +NULL+.
699
+ # [collection.empty?]
700
+ # Returns +true+ if there are no associated objects.
701
+ # [collection.size]
702
+ # Returns the number of associated objects.
703
+ # [collection.find(...)]
704
+ # Finds an associated object according to the same rules as ActiveRecord::Base.find.
705
+ # [collection.exists?(...)]
706
+ # Checks whether an associated object with the given conditions exists.
707
+ # Uses the same rules as ActiveRecord::Base.exists?.
708
+ # [collection.build(attributes = {}, ...)]
709
+ # Returns one or more new objects of the collection type that have been instantiated
710
+ # with +attributes+ and linked to this object through a foreign key, but have not yet
711
+ # been saved. <b>Note:</b> This only works if an associated object already exists, not if
712
+ # it's +nil+!
713
+ # [collection.create(attributes = {})]
714
+ # Returns a new object of the collection type that has been instantiated
715
+ # with +attributes+, linked to this object through a foreign key, and that has already
716
+ # been saved (if it passed the validation). <b>Note:</b> This only works if an associated
717
+ # object already exists, not if it's +nil+!
718
+ #
719
+ # (*Note*: +collection+ is replaced with the symbol passed as the first argument, so
720
+ # <tt>has_many :clients</tt> would add among others <tt>clients.empty?</tt>.)
721
+ #
722
+ # === Example
723
+ #
724
+ # Example: A Firm class declares <tt>has_many :clients</tt>, which will add:
725
+ # * <tt>Firm#clients</tt> (similar to <tt>Clients.find :all, :conditions => ["firm_id = ?", id]</tt>)
726
+ # * <tt>Firm#clients<<</tt>
727
+ # * <tt>Firm#clients.delete</tt>
728
+ # * <tt>Firm#clients=</tt>
729
+ # * <tt>Firm#client_ids</tt>
730
+ # * <tt>Firm#client_ids=</tt>
731
+ # * <tt>Firm#clients.clear</tt>
732
+ # * <tt>Firm#clients.empty?</tt> (similar to <tt>firm.clients.size == 0</tt>)
733
+ # * <tt>Firm#clients.size</tt> (similar to <tt>Client.count "firm_id = #{id}"</tt>)
734
+ # * <tt>Firm#clients.find</tt> (similar to <tt>Client.find(id, :conditions => "firm_id = #{id}")</tt>)
735
+ # * <tt>Firm#clients.exists?(:name => 'ACME')</tt> (similar to <tt>Client.exists?(:name => 'ACME', :firm_id => firm.id)</tt>)
736
+ # * <tt>Firm#clients.build</tt> (similar to <tt>Client.new("firm_id" => id)</tt>)
737
+ # * <tt>Firm#clients.create</tt> (similar to <tt>c = Client.new("firm_id" => id); c.save; c</tt>)
738
+ # The declaration can also include an options hash to specialize the behavior of the association.
739
+ #
740
+ # === Supported options
741
+ # [:class_name]
742
+ # Specify the class name of the association. Use it only if that name can't be inferred
743
+ # from the association name. So <tt>has_many :products</tt> will by default be linked to the Product class, but
744
+ # if the real class name is SpecialProduct, you'll have to specify it with this option.
745
+ # [:conditions]
746
+ # Specify the conditions that the associated objects must meet in order to be included as a +WHERE+
747
+ # SQL fragment, such as <tt>price > 5 AND name LIKE 'B%'</tt>. Record creations from the association are scoped if a hash
748
+ # is used. <tt>has_many :posts, :conditions => {:published => true}</tt> will create published posts with <tt>@blog.posts.create</tt>
749
+ # or <tt>@blog.posts.build</tt>.
750
+ # [:order]
751
+ # Specify the order in which the associated objects are returned as an <tt>ORDER BY</tt> SQL fragment,
752
+ # such as <tt>last_name, first_name DESC</tt>.
753
+ # [:foreign_key]
754
+ # Specify the foreign key used for the association. By default this is guessed to be the name
755
+ # of this class in lower-case and "_id" suffixed. So a Person class that makes a +has_many+ association will use "person_id"
756
+ # as the default <tt>:foreign_key</tt>.
757
+ # [:primary_key]
758
+ # Specify the method that returns the primary key used for the association. By default this is +id+.
759
+ # [:dependent]
760
+ # If set to <tt>:destroy</tt> all the associated objects are destroyed
761
+ # alongside this object by calling their +destroy+ method. If set to <tt>:delete_all</tt> all associated
762
+ # objects are deleted *without* calling their +destroy+ method. If set to <tt>:nullify</tt> all associated
763
+ # objects' foreign keys are set to +NULL+ *without* calling their +save+ callbacks. *Warning:* This option is ignored when also using
764
+ # the <tt>:through</tt> option.
765
+ # [:finder_sql]
766
+ # Specify a complete SQL statement to fetch the association. This is a good way to go for complex
767
+ # associations that depend on multiple tables. Note: When this option is used, +find_in_collection+ is _not_ added.
768
+ # [:counter_sql]
769
+ # Specify a complete SQL statement to fetch the size of the association. If <tt>:finder_sql</tt> is
770
+ # specified but not <tt>:counter_sql</tt>, <tt>:counter_sql</tt> will be generated by replacing <tt>SELECT ... FROM</tt> with <tt>SELECT COUNT(*) FROM</tt>.
771
+ # [:extend]
772
+ # Specify a named module for extending the proxy. See "Association extensions".
773
+ # [:include]
774
+ # Specify second-order associations that should be eager loaded when the collection is loaded.
775
+ # [:group]
776
+ # An attribute name by which the result should be grouped. Uses the <tt>GROUP BY</tt> SQL-clause.
777
+ # [:having]
778
+ # 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.
779
+ # [:limit]
780
+ # An integer determining the limit on the number of rows that should be returned.
781
+ # [:offset]
782
+ # An integer determining the offset from where the rows should be fetched. So at 5, it would skip the first 4 rows.
783
+ # [:select]
784
+ # By default, this is <tt>*</tt> as in <tt>SELECT * FROM</tt>, but can be changed if you, for example, want to do a join
785
+ # but not include the joined columns. Do not forget to include the primary and foreign keys, otherwise it will raise an error.
786
+ # [:as]
787
+ # Specifies a polymorphic interface (See <tt>belongs_to</tt>).
788
+ # [:through]
789
+ # Specifies a Join Model through which to perform the query. Options for <tt>:class_name</tt> and <tt>:foreign_key</tt>
790
+ # are ignored, as the association uses the source reflection. You can only use a <tt>:through</tt> query through a <tt>belongs_to</tt>
791
+ # <tt>has_one</tt> or <tt>has_many</tt> association on the join model.
792
+ # [:source]
793
+ # Specifies the source association name used by <tt>has_many :through</tt> queries. Only use it if the name cannot be
794
+ # inferred from the association. <tt>has_many :subscribers, :through => :subscriptions</tt> will look for either <tt>:subscribers</tt> or
795
+ # <tt>:subscriber</tt> on Subscription, unless a <tt>:source</tt> is given.
796
+ # [:source_type]
797
+ # Specifies type of the source association used by <tt>has_many :through</tt> queries where the source
798
+ # association is a polymorphic +belongs_to+.
799
+ # [:uniq]
800
+ # If true, duplicates will be omitted from the collection. Useful in conjunction with <tt>:through</tt>.
801
+ # [:readonly]
802
+ # If true, all the associated objects are readonly through the association.
803
+ # [:validate]
804
+ # If false, don't validate the associated objects when saving the parent object. true by default.
805
+ # [:autosave]
806
+ # If true, always save any loaded members and destroy members marked for destruction, when saving the parent object. Off by default.
807
+ #
808
+ # Option examples:
809
+ # has_many :comments, :order => "posted_on"
810
+ # has_many :comments, :include => :author
811
+ # has_many :people, :class_name => "Person", :conditions => "deleted = 0", :order => "name"
812
+ # has_many :tracks, :order => "position", :dependent => :destroy
813
+ # has_many :comments, :dependent => :nullify
814
+ # has_many :tags, :as => :taggable
815
+ # has_many :reports, :readonly => true
816
+ # has_many :subscribers, :through => :subscriptions, :source => :user
817
+ # has_many :subscribers, :class_name => "Person", :finder_sql =>
818
+ # 'SELECT DISTINCT people.* ' +
819
+ # 'FROM people p, post_subscriptions ps ' +
820
+ # 'WHERE ps.post_id = #{id} AND ps.person_id = p.id ' +
821
+ # 'ORDER BY p.first_name'
822
+ def has_many(association_id, options = {}, &extension)
823
+ reflection = create_has_many_reflection(association_id, options, &extension)
824
+ configure_dependency_for_has_many(reflection)
825
+ add_association_callbacks(reflection.name, reflection.options)
826
+
827
+ if options[:through]
828
+ collection_accessor_methods(reflection, HasManyThroughAssociation)
829
+ else
830
+ collection_accessor_methods(reflection, HasManyAssociation)
831
+ end
832
+ end
833
+
834
+ # Specifies a one-to-one association with another class. This method should only be used
835
+ # if the other class contains the foreign key. If the current class contains the foreign key,
836
+ # then you should use +belongs_to+ instead. See also ActiveRecord::Associations::ClassMethods's overview
837
+ # on when to use has_one and when to use belongs_to.
838
+ #
839
+ # The following methods for retrieval and query of a single associated object will be added:
840
+ #
841
+ # [association(force_reload = false)]
842
+ # Returns the associated object. +nil+ is returned if none is found.
843
+ # [association=(associate)]
844
+ # Assigns the associate object, extracts the primary key, sets it as the foreign key,
845
+ # and saves the associate object.
846
+ # [build_association(attributes = {})]
847
+ # Returns a new object of the associated type that has been instantiated
848
+ # with +attributes+ and linked to this object through a foreign key, but has not
849
+ # yet been saved. <b>Note:</b> This ONLY works if an association already exists.
850
+ # It will NOT work if the association is +nil+.
851
+ # [create_association(attributes = {})]
852
+ # Returns a new object of the associated type that has been instantiated
853
+ # with +attributes+, linked to this object through a foreign key, and that
854
+ # has already been saved (if it passed the validation).
855
+ #
856
+ # (+association+ is replaced with the symbol passed as the first argument, so
857
+ # <tt>has_one :manager</tt> would add among others <tt>manager.nil?</tt>.)
858
+ #
859
+ # === Example
860
+ #
861
+ # An Account class declares <tt>has_one :beneficiary</tt>, which will add:
862
+ # * <tt>Account#beneficiary</tt> (similar to <tt>Beneficiary.find(:first, :conditions => "account_id = #{id}")</tt>)
863
+ # * <tt>Account#beneficiary=(beneficiary)</tt> (similar to <tt>beneficiary.account_id = account.id; beneficiary.save</tt>)
864
+ # * <tt>Account#build_beneficiary</tt> (similar to <tt>Beneficiary.new("account_id" => id)</tt>)
865
+ # * <tt>Account#create_beneficiary</tt> (similar to <tt>b = Beneficiary.new("account_id" => id); b.save; b</tt>)
866
+ #
867
+ # === Options
868
+ #
869
+ # The declaration can also include an options hash to specialize the behavior of the association.
870
+ #
871
+ # Options are:
872
+ # [:class_name]
873
+ # Specify the class name of the association. Use it only if that name can't be inferred
874
+ # from the association name. So <tt>has_one :manager</tt> will by default be linked to the Manager class, but
875
+ # if the real class name is Person, you'll have to specify it with this option.
876
+ # [:conditions]
877
+ # Specify the conditions that the associated object must meet in order to be included as a +WHERE+
878
+ # SQL fragment, such as <tt>rank = 5</tt>. Record creation from the association is scoped if a hash
879
+ # is used. <tt>has_one :account, :conditions => {:enabled => true}</tt> will create an enabled account with <tt>@company.create_account</tt>
880
+ # or <tt>@company.build_account</tt>.
881
+ # [:order]
882
+ # Specify the order in which the associated objects are returned as an <tt>ORDER BY</tt> SQL fragment,
883
+ # such as <tt>last_name, first_name DESC</tt>.
884
+ # [:dependent]
885
+ # If set to <tt>:destroy</tt>, the associated object is destroyed when this object is. If set to
886
+ # <tt>:delete</tt>, the associated object is deleted *without* calling its destroy method. If set to <tt>:nullify</tt>, the associated
887
+ # object's foreign key is set to +NULL+. Also, association is assigned.
888
+ # [:foreign_key]
889
+ # Specify the foreign key used for the association. By default this is guessed to be the name
890
+ # of this class in lower-case and "_id" suffixed. So a Person class that makes a +has_one+ association will use "person_id"
891
+ # as the default <tt>:foreign_key</tt>.
892
+ # [:primary_key]
893
+ # Specify the method that returns the primary key used for the association. By default this is +id+.
894
+ # [:include]
895
+ # Specify second-order associations that should be eager loaded when this object is loaded.
896
+ # [:as]
897
+ # Specifies a polymorphic interface (See <tt>belongs_to</tt>).
898
+ # [:select]
899
+ # By default, this is <tt>*</tt> as in <tt>SELECT * FROM</tt>, but can be changed if, for example, you want to do a join
900
+ # but not include the joined columns. Do not forget to include the primary and foreign keys, otherwise it will raise an error.
901
+ # [:through]
902
+ # Specifies a Join Model through which to perform the query. Options for <tt>:class_name</tt> and <tt>:foreign_key</tt>
903
+ # are ignored, as the association uses the source reflection. You can only use a <tt>:through</tt> query through a
904
+ # <tt>has_one</tt> or <tt>belongs_to</tt> association on the join model.
905
+ # [:source]
906
+ # Specifies the source association name used by <tt>has_one :through</tt> queries. Only use it if the name cannot be
907
+ # inferred from the association. <tt>has_one :favorite, :through => :favorites</tt> will look for a
908
+ # <tt>:favorite</tt> on Favorite, unless a <tt>:source</tt> is given.
909
+ # [:source_type]
910
+ # Specifies type of the source association used by <tt>has_one :through</tt> queries where the source
911
+ # association is a polymorphic +belongs_to+.
912
+ # [:readonly]
913
+ # If true, the associated object is readonly through the association.
914
+ # [:validate]
915
+ # If false, don't validate the associated object when saving the parent object. +false+ by default.
916
+ # [:autosave]
917
+ # If true, always save the associated object or destroy it if marked for destruction, when saving the parent object. Off by default.
918
+ #
919
+ # Option examples:
920
+ # has_one :credit_card, :dependent => :destroy # destroys the associated credit card
921
+ # has_one :credit_card, :dependent => :nullify # updates the associated records foreign key value to NULL rather than destroying it
922
+ # has_one :last_comment, :class_name => "Comment", :order => "posted_on"
923
+ # has_one :project_manager, :class_name => "Person", :conditions => "role = 'project_manager'"
924
+ # has_one :attachment, :as => :attachable
925
+ # has_one :boss, :readonly => :true
926
+ # has_one :club, :through => :membership
927
+ # has_one :primary_address, :through => :addressables, :conditions => ["addressable.primary = ?", true], :source => :addressable
928
+ def has_one(association_id, options = {})
929
+ if options[:through]
930
+ reflection = create_has_one_through_reflection(association_id, options)
931
+ association_accessor_methods(reflection, ActiveRecord::Associations::HasOneThroughAssociation)
932
+ else
933
+ reflection = create_has_one_reflection(association_id, options)
934
+ association_accessor_methods(reflection, HasOneAssociation)
935
+ association_constructor_method(:build, reflection, HasOneAssociation)
936
+ association_constructor_method(:create, reflection, HasOneAssociation)
937
+ configure_dependency_for_has_one(reflection)
938
+ end
939
+ end
940
+
941
+ # Specifies a one-to-one association with another class. This method should only be used
942
+ # if this class contains the foreign key. If the other class contains the foreign key,
943
+ # then you should use +has_one+ instead. See also ActiveRecord::Associations::ClassMethods's overview
944
+ # on when to use +has_one+ and when to use +belongs_to+.
945
+ #
946
+ # Methods will be added for retrieval and query for a single associated object, for which
947
+ # this object holds an id:
948
+ #
949
+ # [association(force_reload = false)]
950
+ # Returns the associated object. +nil+ is returned if none is found.
951
+ # [association=(associate)]
952
+ # Assigns the associate object, extracts the primary key, and sets it as the foreign key.
953
+ # [build_association(attributes = {})]
954
+ # Returns a new object of the associated type that has been instantiated
955
+ # with +attributes+ and linked to this object through a foreign key, but has not yet been saved.
956
+ # [create_association(attributes = {})]
957
+ # Returns a new object of the associated type that has been instantiated
958
+ # with +attributes+, linked to this object through a foreign key, and that
959
+ # has already been saved (if it passed the validation).
960
+ #
961
+ # (+association+ is replaced with the symbol passed as the first argument, so
962
+ # <tt>belongs_to :author</tt> would add among others <tt>author.nil?</tt>.)
963
+ #
964
+ # === Example
965
+ #
966
+ # A Post class declares <tt>belongs_to :author</tt>, which will add:
967
+ # * <tt>Post#author</tt> (similar to <tt>Author.find(author_id)</tt>)
968
+ # * <tt>Post#author=(author)</tt> (similar to <tt>post.author_id = author.id</tt>)
969
+ # * <tt>Post#author?</tt> (similar to <tt>post.author == some_author</tt>)
970
+ # * <tt>Post#build_author</tt> (similar to <tt>post.author = Author.new</tt>)
971
+ # * <tt>Post#create_author</tt> (similar to <tt>post.author = Author.new; post.author.save; post.author</tt>)
972
+ # The declaration can also include an options hash to specialize the behavior of the association.
973
+ #
974
+ # === Options
975
+ #
976
+ # [:class_name]
977
+ # Specify the class name of the association. Use it only if that name can't be inferred
978
+ # from the association name. So <tt>has_one :author</tt> will by default be linked to the Author class, but
979
+ # if the real class name is Person, you'll have to specify it with this option.
980
+ # [:conditions]
981
+ # Specify the conditions that the associated object must meet in order to be included as a +WHERE+
982
+ # SQL fragment, such as <tt>authorized = 1</tt>.
983
+ # [:select]
984
+ # By default, this is <tt>*</tt> as in <tt>SELECT * FROM</tt>, but can be changed if, for example, you want to do a join
985
+ # but not include the joined columns. Do not forget to include the primary and foreign keys, otherwise it will raise an error.
986
+ # [:foreign_key]
987
+ # Specify the foreign key used for the association. By default this is guessed to be the name
988
+ # of the association with an "_id" suffix. So a class that defines a <tt>belongs_to :person</tt> association will use
989
+ # "person_id" as the default <tt>:foreign_key</tt>. Similarly, <tt>belongs_to :favorite_person, :class_name => "Person"</tt>
990
+ # will use a foreign key of "favorite_person_id".
991
+ # [:primary_key]
992
+ # Specify the method that returns the primary key of associated object used for the association. By default this is id.
993
+ # [:dependent]
994
+ # If set to <tt>:destroy</tt>, the associated object is destroyed when this object is. If set to
995
+ # <tt>:delete</tt>, the associated object is deleted *without* calling its destroy method. This option should not be specified when
996
+ # <tt>belongs_to</tt> is used in conjunction with a <tt>has_many</tt> relationship on another class because of the potential to leave
997
+ # orphaned records behind.
998
+ # [:counter_cache]
999
+ # Caches the number of belonging objects on the associate class through the use of +increment_counter+
1000
+ # and +decrement_counter+. The counter cache is incremented when an object of this class is created and decremented when it's
1001
+ # destroyed. This requires that a column named <tt>#{table_name}_count</tt> (such as +comments_count+ for a belonging Comment class)
1002
+ # is used on the associate class (such as a Post class). You can also specify a custom counter cache column by providing
1003
+ # a column name instead of a +true+/+false+ value to this option (e.g., <tt>:counter_cache => :my_custom_counter</tt>.)
1004
+ # Note: Specifying a counter cache will add it to that model's list of readonly attributes using +attr_readonly+.
1005
+ # [:include]
1006
+ # Specify second-order associations that should be eager loaded when this object is loaded.
1007
+ # [:polymorphic]
1008
+ # Specify this association is a polymorphic association by passing +true+.
1009
+ # Note: If you've enabled the counter cache, then you may want to add the counter cache attribute
1010
+ # to the +attr_readonly+ list in the associated classes (e.g. <tt>class Post; attr_readonly :comments_count; end</tt>).
1011
+ # [:readonly]
1012
+ # If true, the associated object is readonly through the association.
1013
+ # [:validate]
1014
+ # If false, don't validate the associated objects when saving the parent object. +false+ by default.
1015
+ # [:autosave]
1016
+ # If true, always save the associated object or destroy it if marked for destruction, when saving the parent object. Off by default.
1017
+ # [:touch]
1018
+ # If true, the associated object will be touched (the updated_at/on attributes set to now) when this record is either saved or
1019
+ # destroyed. If you specify a symbol, that attribute will be updated with the current time instead of the updated_at/on attribute.
1020
+ #
1021
+ # Option examples:
1022
+ # belongs_to :firm, :foreign_key => "client_of"
1023
+ # belongs_to :person, :primary_key => "name", :foreign_key => "person_name"
1024
+ # belongs_to :author, :class_name => "Person", :foreign_key => "author_id"
1025
+ # belongs_to :valid_coupon, :class_name => "Coupon", :foreign_key => "coupon_id",
1026
+ # :conditions => 'discounts > #{payments_count}'
1027
+ # belongs_to :attachable, :polymorphic => true
1028
+ # belongs_to :project, :readonly => true
1029
+ # belongs_to :post, :counter_cache => true
1030
+ # belongs_to :company, :touch => true
1031
+ # belongs_to :company, :touch => :employees_last_updated_at
1032
+ def belongs_to(association_id, options = {})
1033
+ reflection = create_belongs_to_reflection(association_id, options)
1034
+
1035
+ if reflection.options[:polymorphic]
1036
+ association_accessor_methods(reflection, BelongsToPolymorphicAssociation)
1037
+ else
1038
+ association_accessor_methods(reflection, BelongsToAssociation)
1039
+ association_constructor_method(:build, reflection, BelongsToAssociation)
1040
+ association_constructor_method(:create, reflection, BelongsToAssociation)
1041
+ end
1042
+
1043
+ add_counter_cache_callbacks(reflection) if options[:counter_cache]
1044
+ add_touch_callbacks(reflection, options[:touch]) if options[:touch]
1045
+
1046
+ configure_dependency_for_belongs_to(reflection)
1047
+ end
1048
+
1049
+ # Specifies a many-to-many relationship with another class. This associates two classes via an
1050
+ # intermediate join table. Unless the join table is explicitly specified as an option, it is
1051
+ # guessed using the lexical order of the class names. So a join between Developer and Project
1052
+ # will give the default join table name of "developers_projects" because "D" outranks "P". Note that this precedence
1053
+ # is calculated using the <tt><</tt> operator for String. This means that if the strings are of different lengths,
1054
+ # and the strings are equal when compared up to the shortest length, then the longer string is considered of higher
1055
+ # lexical precedence than the shorter one. For example, one would expect the tables "paper_boxes" and "papers"
1056
+ # to generate a join table name of "papers_paper_boxes" because of the length of the name "paper_boxes",
1057
+ # but it in fact generates a join table name of "paper_boxes_papers". Be aware of this caveat, and use the
1058
+ # custom <tt>:join_table</tt> option if you need to.
1059
+ #
1060
+ # The join table should not have a primary key or a model associated with it. You must manually generate the
1061
+ # join table with a migration such as this:
1062
+ #
1063
+ # class CreateDevelopersProjectsJoinTable < ActiveRecord::Migration
1064
+ # def self.up
1065
+ # create_table :developers_projects, :id => false do |t|
1066
+ # t.integer :developer_id
1067
+ # t.integer :project_id
1068
+ # end
1069
+ # end
1070
+ #
1071
+ # def self.down
1072
+ # drop_table :developers_projects
1073
+ # end
1074
+ # end
1075
+ #
1076
+ # Deprecated: Any additional fields added to the join table will be placed as attributes when pulling records out through
1077
+ # +has_and_belongs_to_many+ associations. Records returned from join tables with additional attributes will be marked as
1078
+ # readonly (because we can't save changes to the additional attributes). It's strongly recommended that you upgrade any
1079
+ # associations with attributes to a real join model (see introduction).
1080
+ #
1081
+ # Adds the following methods for retrieval and query:
1082
+ #
1083
+ # [collection(force_reload = false)]
1084
+ # Returns an array of all the associated objects.
1085
+ # An empty array is returned if none are found.
1086
+ # [collection<<(object, ...)]
1087
+ # Adds one or more objects to the collection by creating associations in the join table
1088
+ # (<tt>collection.push</tt> and <tt>collection.concat</tt> are aliases to this method).
1089
+ # [collection.delete(object, ...)]
1090
+ # Removes one or more objects from the collection by removing their associations from the join table.
1091
+ # This does not destroy the objects.
1092
+ # [collection=objects]
1093
+ # Replaces the collection's content by deleting and adding objects as appropriate.
1094
+ # [collection_singular_ids]
1095
+ # Returns an array of the associated objects' ids.
1096
+ # [collection_singular_ids=ids]
1097
+ # Replace the collection by the objects identified by the primary keys in +ids+.
1098
+ # [collection.clear]
1099
+ # Removes every object from the collection. This does not destroy the objects.
1100
+ # [collection.empty?]
1101
+ # Returns +true+ if there are no associated objects.
1102
+ # [collection.size]
1103
+ # Returns the number of associated objects.
1104
+ # [collection.find(id)]
1105
+ # Finds an associated object responding to the +id+ and that
1106
+ # meets the condition that it has to be associated with this object.
1107
+ # Uses the same rules as ActiveRecord::Base.find.
1108
+ # [collection.exists?(...)]
1109
+ # Checks whether an associated object with the given conditions exists.
1110
+ # Uses the same rules as ActiveRecord::Base.exists?.
1111
+ # [collection.build(attributes = {})]
1112
+ # Returns a new object of the collection type that has been instantiated
1113
+ # with +attributes+ and linked to this object through the join table, but has not yet been saved.
1114
+ # [collection.create(attributes = {})]
1115
+ # Returns a new object of the collection type that has been instantiated
1116
+ # with +attributes+, linked to this object through the join table, and that has already been saved (if it passed the validation).
1117
+ #
1118
+ # (+collection+ is replaced with the symbol passed as the first argument, so
1119
+ # <tt>has_and_belongs_to_many :categories</tt> would add among others <tt>categories.empty?</tt>.)
1120
+ #
1121
+ # === Example
1122
+ #
1123
+ # A Developer class declares <tt>has_and_belongs_to_many :projects</tt>, which will add:
1124
+ # * <tt>Developer#projects</tt>
1125
+ # * <tt>Developer#projects<<</tt>
1126
+ # * <tt>Developer#projects.delete</tt>
1127
+ # * <tt>Developer#projects=</tt>
1128
+ # * <tt>Developer#project_ids</tt>
1129
+ # * <tt>Developer#project_ids=</tt>
1130
+ # * <tt>Developer#projects.clear</tt>
1131
+ # * <tt>Developer#projects.empty?</tt>
1132
+ # * <tt>Developer#projects.size</tt>
1133
+ # * <tt>Developer#projects.find(id)</tt>
1134
+ # * <tt>Developer#clients.exists?(...)</tt>
1135
+ # * <tt>Developer#projects.build</tt> (similar to <tt>Project.new("project_id" => id)</tt>)
1136
+ # * <tt>Developer#projects.create</tt> (similar to <tt>c = Project.new("project_id" => id); c.save; c</tt>)
1137
+ # The declaration may include an options hash to specialize the behavior of the association.
1138
+ #
1139
+ # === Options
1140
+ #
1141
+ # [:class_name]
1142
+ # Specify the class name of the association. Use it only if that name can't be inferred
1143
+ # from the association name. So <tt>has_and_belongs_to_many :projects</tt> will by default be linked to the
1144
+ # Project class, but if the real class name is SuperProject, you'll have to specify it with this option.
1145
+ # [:join_table]
1146
+ # Specify the name of the join table if the default based on lexical order isn't what you want.
1147
+ # <b>WARNING:</b> If you're overwriting the table name of either class, the +table_name+ method
1148
+ # MUST be declared underneath any +has_and_belongs_to_many+ declaration in order to work.
1149
+ # [:foreign_key]
1150
+ # Specify the foreign key used for the association. By default this is guessed to be the name
1151
+ # of this class in lower-case and "_id" suffixed. So a Person class that makes a +has_and_belongs_to_many+ association
1152
+ # to Project will use "person_id" as the default <tt>:foreign_key</tt>.
1153
+ # [:association_foreign_key]
1154
+ # Specify the foreign key used for the association on the receiving side of the association.
1155
+ # By default this is guessed to be the name of the associated class in lower-case and "_id" suffixed.
1156
+ # So if a Person class makes a +has_and_belongs_to_many+ association to Project,
1157
+ # the association will use "project_id" as the default <tt>:association_foreign_key</tt>.
1158
+ # [:conditions]
1159
+ # Specify the conditions that the associated object must meet in order to be included as a +WHERE+
1160
+ # SQL fragment, such as <tt>authorized = 1</tt>. Record creations from the association are scoped if a hash is used.
1161
+ # <tt>has_many :posts, :conditions => {:published => true}</tt> will create published posts with <tt>@blog.posts.create</tt>
1162
+ # or <tt>@blog.posts.build</tt>.
1163
+ # [:order]
1164
+ # Specify the order in which the associated objects are returned as an <tt>ORDER BY</tt> SQL fragment,
1165
+ # such as <tt>last_name, first_name DESC</tt>
1166
+ # [:uniq]
1167
+ # If true, duplicate associated objects will be ignored by accessors and query methods.
1168
+ # [:finder_sql]
1169
+ # Overwrite the default generated SQL statement used to fetch the association with a manual statement
1170
+ # [:counter_sql]
1171
+ # Specify a complete SQL statement to fetch the size of the association. If <tt>:finder_sql</tt> is
1172
+ # specified but not <tt>:counter_sql</tt>, <tt>:counter_sql</tt> will be generated by replacing <tt>SELECT ... FROM</tt> with <tt>SELECT COUNT(*) FROM</tt>.
1173
+ # [:delete_sql]
1174
+ # Overwrite the default generated SQL statement used to remove links between the associated
1175
+ # classes with a manual statement.
1176
+ # [:insert_sql]
1177
+ # Overwrite the default generated SQL statement used to add links between the associated classes
1178
+ # with a manual statement.
1179
+ # [:extend]
1180
+ # Anonymous module for extending the proxy, see "Association extensions".
1181
+ # [:include]
1182
+ # Specify second-order associations that should be eager loaded when the collection is loaded.
1183
+ # [:group]
1184
+ # An attribute name by which the result should be grouped. Uses the <tt>GROUP BY</tt> SQL-clause.
1185
+ # [:having]
1186
+ # 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.
1187
+ # [:limit]
1188
+ # An integer determining the limit on the number of rows that should be returned.
1189
+ # [:offset]
1190
+ # An integer determining the offset from where the rows should be fetched. So at 5, it would skip the first 4 rows.
1191
+ # [:select]
1192
+ # By default, this is <tt>*</tt> as in <tt>SELECT * FROM</tt>, but can be changed if, for example, you want to do a join
1193
+ # but not include the joined columns. Do not forget to include the primary and foreign keys, otherwise it will raise an error.
1194
+ # [:readonly]
1195
+ # If true, all the associated objects are readonly through the association.
1196
+ # [:validate]
1197
+ # If false, don't validate the associated objects when saving the parent object. +true+ by default.
1198
+ # [:autosave]
1199
+ # If true, always save any loaded members and destroy members marked for destruction, when saving the parent object. Off by default.
1200
+ #
1201
+ # Option examples:
1202
+ # has_and_belongs_to_many :projects
1203
+ # has_and_belongs_to_many :projects, :include => [ :milestones, :manager ]
1204
+ # has_and_belongs_to_many :nations, :class_name => "Country"
1205
+ # has_and_belongs_to_many :categories, :join_table => "prods_cats"
1206
+ # has_and_belongs_to_many :categories, :readonly => true
1207
+ # has_and_belongs_to_many :active_projects, :join_table => 'developers_projects', :delete_sql =>
1208
+ # 'DELETE FROM developers_projects WHERE active=1 AND developer_id = #{id} AND project_id = #{record.id}'
1209
+ def has_and_belongs_to_many(association_id, options = {}, &extension)
1210
+ reflection = create_has_and_belongs_to_many_reflection(association_id, options, &extension)
1211
+ collection_accessor_methods(reflection, HasAndBelongsToManyAssociation)
1212
+
1213
+ # Don't use a before_destroy callback since users' before_destroy
1214
+ # callbacks will be executed after the association is wiped out.
1215
+ old_method = "destroy_without_habtm_shim_for_#{reflection.name}"
1216
+ class_eval <<-end_eval unless method_defined?(old_method)
1217
+ alias_method :#{old_method}, :destroy_without_callbacks # alias_method :destroy_without_habtm_shim_for_posts, :destroy_without_callbacks
1218
+ def destroy_without_callbacks # def destroy_without_callbacks
1219
+ #{reflection.name}.clear # posts.clear
1220
+ #{old_method} # destroy_without_habtm_shim_for_posts
1221
+ end # end
1222
+ end_eval
1223
+
1224
+ add_association_callbacks(reflection.name, options)
1225
+ end
1226
+
1227
+ private
1228
+ # Generates a join table name from two provided table names.
1229
+ # The names in the join table namesme end up in lexicographic order.
1230
+ #
1231
+ # join_table_name("members", "clubs") # => "clubs_members"
1232
+ # join_table_name("members", "special_clubs") # => "members_special_clubs"
1233
+ def join_table_name(first_table_name, second_table_name)
1234
+ if first_table_name < second_table_name
1235
+ join_table = "#{first_table_name}_#{second_table_name}"
1236
+ else
1237
+ join_table = "#{second_table_name}_#{first_table_name}"
1238
+ end
1239
+
1240
+ table_name_prefix + join_table + table_name_suffix
1241
+ end
1242
+
1243
+ def association_accessor_methods(reflection, association_proxy_class)
1244
+ define_method(reflection.name) do |*params|
1245
+ force_reload = params.first unless params.empty?
1246
+ association = association_instance_get(reflection.name)
1247
+
1248
+ if association.nil? || force_reload
1249
+ association = association_proxy_class.new(self, reflection)
1250
+ retval = association.reload
1251
+ if retval.nil? and association_proxy_class == BelongsToAssociation
1252
+ association_instance_set(reflection.name, nil)
1253
+ return nil
1254
+ end
1255
+ association_instance_set(reflection.name, association)
1256
+ end
1257
+
1258
+ association.target.nil? ? nil : association
1259
+ end
1260
+
1261
+ define_method("loaded_#{reflection.name}?") do
1262
+ association = association_instance_get(reflection.name)
1263
+ association && association.loaded?
1264
+ end
1265
+
1266
+ define_method("#{reflection.name}=") do |new_value|
1267
+ association = association_instance_get(reflection.name)
1268
+
1269
+ if association.nil? || association.target != new_value
1270
+ association = association_proxy_class.new(self, reflection)
1271
+ end
1272
+
1273
+ if association_proxy_class == HasOneThroughAssociation
1274
+ association.create_through_record(new_value)
1275
+ if new_record?
1276
+ association_instance_set(reflection.name, new_value.nil? ? nil : association)
1277
+ else
1278
+ self.send(reflection.name, new_value)
1279
+ end
1280
+ else
1281
+ association.replace(new_value)
1282
+ association_instance_set(reflection.name, new_value.nil? ? nil : association)
1283
+ end
1284
+ end
1285
+
1286
+ define_method("set_#{reflection.name}_target") do |target|
1287
+ return if target.nil? and association_proxy_class == BelongsToAssociation
1288
+ association = association_proxy_class.new(self, reflection)
1289
+ association.target = target
1290
+ association_instance_set(reflection.name, association)
1291
+ end
1292
+ end
1293
+
1294
+ def collection_reader_method(reflection, association_proxy_class)
1295
+ define_method(reflection.name) do |*params|
1296
+ force_reload = params.first unless params.empty?
1297
+ association = association_instance_get(reflection.name)
1298
+
1299
+ unless association
1300
+ association = association_proxy_class.new(self, reflection)
1301
+ association_instance_set(reflection.name, association)
1302
+ end
1303
+
1304
+ association.reload if force_reload
1305
+
1306
+ association
1307
+ end
1308
+
1309
+ define_method("#{reflection.name.to_s.singularize}_ids") do
1310
+ if send(reflection.name).loaded? || reflection.options[:finder_sql]
1311
+ send(reflection.name).map(&:id)
1312
+ else
1313
+ send(reflection.name).all(:select => "#{reflection.quoted_table_name}.#{reflection.klass.primary_key}").map(&:id)
1314
+ end
1315
+ end
1316
+ end
1317
+
1318
+ def collection_accessor_methods(reflection, association_proxy_class, writer = true)
1319
+ collection_reader_method(reflection, association_proxy_class)
1320
+
1321
+ if writer
1322
+ define_method("#{reflection.name}=") do |new_value|
1323
+ # Loads proxy class instance (defined in collection_reader_method) if not already loaded
1324
+ association = send(reflection.name)
1325
+ association.replace(new_value)
1326
+ association
1327
+ end
1328
+
1329
+ define_method("#{reflection.name.to_s.singularize}_ids=") do |new_value|
1330
+ ids = (new_value || []).reject { |nid| nid.blank? }.map(&:to_i)
1331
+ send("#{reflection.name}=", reflection.klass.find(ids).index_by(&:id).values_at(*ids))
1332
+ end
1333
+ end
1334
+ end
1335
+
1336
+ def association_constructor_method(constructor, reflection, association_proxy_class)
1337
+ define_method("#{constructor}_#{reflection.name}") do |*params|
1338
+ attributees = params.first unless params.empty?
1339
+ replace_existing = params[1].nil? ? true : params[1]
1340
+ association = association_instance_get(reflection.name)
1341
+
1342
+ unless association
1343
+ association = association_proxy_class.new(self, reflection)
1344
+ association_instance_set(reflection.name, association)
1345
+ end
1346
+
1347
+ if association_proxy_class == HasOneAssociation
1348
+ association.send(constructor, attributees, replace_existing)
1349
+ else
1350
+ association.send(constructor, attributees)
1351
+ end
1352
+ end
1353
+ end
1354
+
1355
+ def add_counter_cache_callbacks(reflection)
1356
+ cache_column = reflection.counter_cache_column
1357
+
1358
+ method_name = "belongs_to_counter_cache_after_create_for_#{reflection.name}".to_sym
1359
+ define_method(method_name) do
1360
+ association = send(reflection.name)
1361
+ association.class.increment_counter(cache_column, association.id) unless association.nil?
1362
+ end
1363
+ after_create(method_name)
1364
+
1365
+ method_name = "belongs_to_counter_cache_before_destroy_for_#{reflection.name}".to_sym
1366
+ define_method(method_name) do
1367
+ association = send(reflection.name)
1368
+ association.class.decrement_counter(cache_column, association.id) unless association.nil?
1369
+ end
1370
+ before_destroy(method_name)
1371
+
1372
+ module_eval(
1373
+ "#{reflection.class_name}.send(:attr_readonly,\"#{cache_column}\".intern) if defined?(#{reflection.class_name}) && #{reflection.class_name}.respond_to?(:attr_readonly)"
1374
+ )
1375
+ end
1376
+
1377
+ def add_touch_callbacks(reflection, touch_attribute)
1378
+ method_name = "belongs_to_touch_after_save_or_destroy_for_#{reflection.name}".to_sym
1379
+ define_method(method_name) do
1380
+ association = send(reflection.name)
1381
+
1382
+ if touch_attribute == true
1383
+ association.touch unless association.nil?
1384
+ else
1385
+ association.touch(touch_attribute) unless association.nil?
1386
+ end
1387
+ end
1388
+ after_save(method_name)
1389
+ after_destroy(method_name)
1390
+ end
1391
+
1392
+ def find_with_associations(options = {})
1393
+ catch :invalid_query do
1394
+ join_dependency = JoinDependency.new(self, merge_includes(scope(:find, :include), options[:include]), options[:joins])
1395
+ rows = select_all_rows(options, join_dependency)
1396
+ return join_dependency.instantiate(rows)
1397
+ end
1398
+ []
1399
+ end
1400
+
1401
+ # Creates before_destroy callback methods that nullify, delete or destroy
1402
+ # has_many associated objects, according to the defined :dependent rule.
1403
+ #
1404
+ # See HasManyAssociation#delete_records. Dependent associations
1405
+ # delete children, otherwise foreign key is set to NULL.
1406
+ #
1407
+ # The +extra_conditions+ parameter, which is not used within the main
1408
+ # Active Record codebase, is meant to allow plugins to define extra
1409
+ # finder conditions.
1410
+ def configure_dependency_for_has_many(reflection, extra_conditions = nil)
1411
+ if reflection.options.include?(:dependent)
1412
+ # Add polymorphic type if the :as option is present
1413
+ dependent_conditions = []
1414
+ dependent_conditions << "#{reflection.primary_key_name} = \#{record.#{reflection.name}.send(:owner_quoted_id)}"
1415
+ dependent_conditions << "#{reflection.options[:as]}_type = '#{base_class.name}'" if reflection.options[:as]
1416
+ dependent_conditions << sanitize_sql(reflection.options[:conditions], reflection.quoted_table_name) if reflection.options[:conditions]
1417
+ dependent_conditions << extra_conditions if extra_conditions
1418
+ dependent_conditions = dependent_conditions.collect {|where| "(#{where})" }.join(" AND ")
1419
+ dependent_conditions = dependent_conditions.gsub('@', '\@')
1420
+ case reflection.options[:dependent]
1421
+ when :destroy
1422
+ method_name = "has_many_dependent_destroy_for_#{reflection.name}".to_sym
1423
+ define_method(method_name) do
1424
+ send(reflection.name).each { |o| o.destroy }
1425
+ end
1426
+ before_destroy method_name
1427
+ when :delete_all
1428
+ module_eval %Q{
1429
+ before_destroy do |record| # before_destroy do |record|
1430
+ delete_all_has_many_dependencies(record, # delete_all_has_many_dependencies(record,
1431
+ "#{reflection.name}", # "posts",
1432
+ #{reflection.class_name}, # Post,
1433
+ %@#{dependent_conditions}@) # %@...@) # this is a string literal like %(...)
1434
+ end # end
1435
+ }
1436
+ when :nullify
1437
+ module_eval %Q{
1438
+ before_destroy do |record| # before_destroy do |record|
1439
+ nullify_has_many_dependencies(record, # nullify_has_many_dependencies(record,
1440
+ "#{reflection.name}", # "posts",
1441
+ #{reflection.class_name}, # Post,
1442
+ "#{reflection.primary_key_name}", # "user_id",
1443
+ %@#{dependent_conditions}@) # %@...@) # this is a string literal like %(...)
1444
+ end # end
1445
+ }
1446
+ else
1447
+ raise ArgumentError, "The :dependent option expects either :destroy, :delete_all, or :nullify (#{reflection.options[:dependent].inspect})"
1448
+ end
1449
+ end
1450
+ end
1451
+
1452
+ # Creates before_destroy callback methods that nullify, delete or destroy
1453
+ # has_one associated objects, according to the defined :dependent rule.
1454
+ def configure_dependency_for_has_one(reflection)
1455
+ if reflection.options.include?(:dependent)
1456
+ case reflection.options[:dependent]
1457
+ when :destroy
1458
+ method_name = "has_one_dependent_destroy_for_#{reflection.name}".to_sym
1459
+ define_method(method_name) do
1460
+ association = send(reflection.name)
1461
+ association.destroy unless association.nil?
1462
+ end
1463
+ before_destroy method_name
1464
+ when :delete
1465
+ method_name = "has_one_dependent_delete_for_#{reflection.name}".to_sym
1466
+ define_method(method_name) do
1467
+ # Retrieve the associated object and delete it. The retrieval
1468
+ # is necessary because there may be multiple associated objects
1469
+ # with foreign keys pointing to this object, and we only want
1470
+ # to delete the correct one, not all of them.
1471
+ association = send(reflection.name)
1472
+ association.delete unless association.nil?
1473
+ end
1474
+ before_destroy method_name
1475
+ when :nullify
1476
+ method_name = "has_one_dependent_nullify_for_#{reflection.name}".to_sym
1477
+ define_method(method_name) do
1478
+ association = send(reflection.name)
1479
+ association.update_attribute(reflection.primary_key_name, nil) unless association.nil?
1480
+ end
1481
+ before_destroy method_name
1482
+ else
1483
+ raise ArgumentError, "The :dependent option expects either :destroy, :delete or :nullify (#{reflection.options[:dependent].inspect})"
1484
+ end
1485
+ end
1486
+ end
1487
+
1488
+ def configure_dependency_for_belongs_to(reflection)
1489
+ if reflection.options.include?(:dependent)
1490
+ case reflection.options[:dependent]
1491
+ when :destroy
1492
+ method_name = "belongs_to_dependent_destroy_for_#{reflection.name}".to_sym
1493
+ define_method(method_name) do
1494
+ association = send(reflection.name)
1495
+ association.destroy unless association.nil?
1496
+ end
1497
+ after_destroy method_name
1498
+ when :delete
1499
+ method_name = "belongs_to_dependent_delete_for_#{reflection.name}".to_sym
1500
+ define_method(method_name) do
1501
+ association = send(reflection.name)
1502
+ association.delete unless association.nil?
1503
+ end
1504
+ after_destroy method_name
1505
+ else
1506
+ raise ArgumentError, "The :dependent option expects either :destroy or :delete (#{reflection.options[:dependent].inspect})"
1507
+ end
1508
+ end
1509
+ end
1510
+
1511
+ def delete_all_has_many_dependencies(record, reflection_name, association_class, dependent_conditions)
1512
+ association_class.delete_all(dependent_conditions)
1513
+ end
1514
+
1515
+ def nullify_has_many_dependencies(record, reflection_name, association_class, primary_key_name, dependent_conditions)
1516
+ association_class.update_all("#{primary_key_name} = NULL", dependent_conditions)
1517
+ end
1518
+
1519
+ mattr_accessor :valid_keys_for_has_many_association
1520
+ @@valid_keys_for_has_many_association = [
1521
+ :class_name, :table_name, :foreign_key, :primary_key,
1522
+ :dependent,
1523
+ :select, :conditions, :include, :order, :group, :having, :limit, :offset,
1524
+ :as, :through, :source, :source_type,
1525
+ :uniq,
1526
+ :finder_sql, :counter_sql,
1527
+ :before_add, :after_add, :before_remove, :after_remove,
1528
+ :extend, :readonly,
1529
+ :validate
1530
+ ]
1531
+
1532
+ def create_has_many_reflection(association_id, options, &extension)
1533
+ options.assert_valid_keys(valid_keys_for_has_many_association)
1534
+ options[:extend] = create_extension_modules(association_id, extension, options[:extend])
1535
+
1536
+ create_reflection(:has_many, association_id, options, self)
1537
+ end
1538
+
1539
+ mattr_accessor :valid_keys_for_has_one_association
1540
+ @@valid_keys_for_has_one_association = [
1541
+ :class_name, :foreign_key, :remote, :select, :conditions, :order,
1542
+ :include, :dependent, :counter_cache, :extend, :as, :readonly,
1543
+ :validate, :primary_key
1544
+ ]
1545
+
1546
+ def create_has_one_reflection(association_id, options)
1547
+ options.assert_valid_keys(valid_keys_for_has_one_association)
1548
+ create_reflection(:has_one, association_id, options, self)
1549
+ end
1550
+
1551
+ def create_has_one_through_reflection(association_id, options)
1552
+ options.assert_valid_keys(
1553
+ :class_name, :foreign_key, :remote, :select, :conditions, :order, :include, :dependent, :counter_cache, :extend, :as, :through, :source, :source_type, :validate
1554
+ )
1555
+ create_reflection(:has_one, association_id, options, self)
1556
+ end
1557
+
1558
+ mattr_accessor :valid_keys_for_belongs_to_association
1559
+ @@valid_keys_for_belongs_to_association = [
1560
+ :class_name, :primary_key, :foreign_key, :foreign_type, :remote, :select, :conditions,
1561
+ :include, :dependent, :counter_cache, :extend, :polymorphic, :readonly,
1562
+ :validate, :touch
1563
+ ]
1564
+
1565
+ def create_belongs_to_reflection(association_id, options)
1566
+ options.assert_valid_keys(valid_keys_for_belongs_to_association)
1567
+ reflection = create_reflection(:belongs_to, association_id, options, self)
1568
+
1569
+ if options[:polymorphic]
1570
+ reflection.options[:foreign_type] ||= reflection.class_name.underscore + "_type"
1571
+ end
1572
+
1573
+ reflection
1574
+ end
1575
+
1576
+ mattr_accessor :valid_keys_for_has_and_belongs_to_many_association
1577
+ @@valid_keys_for_has_and_belongs_to_many_association = [
1578
+ :class_name, :table_name, :join_table, :foreign_key, :association_foreign_key,
1579
+ :select, :conditions, :include, :order, :group, :having, :limit, :offset,
1580
+ :uniq,
1581
+ :finder_sql, :counter_sql, :delete_sql, :insert_sql,
1582
+ :before_add, :after_add, :before_remove, :after_remove,
1583
+ :extend, :readonly,
1584
+ :validate
1585
+ ]
1586
+
1587
+ def create_has_and_belongs_to_many_reflection(association_id, options, &extension)
1588
+ options.assert_valid_keys(valid_keys_for_has_and_belongs_to_many_association)
1589
+
1590
+ options[:extend] = create_extension_modules(association_id, extension, options[:extend])
1591
+
1592
+ reflection = create_reflection(:has_and_belongs_to_many, association_id, options, self)
1593
+
1594
+ if reflection.association_foreign_key == reflection.primary_key_name
1595
+ raise HasAndBelongsToManyAssociationForeignKeyNeeded.new(reflection)
1596
+ end
1597
+
1598
+ reflection.options[:join_table] ||= join_table_name(undecorated_table_name(self.to_s), undecorated_table_name(reflection.class_name))
1599
+
1600
+ reflection
1601
+ end
1602
+
1603
+ def reflect_on_included_associations(associations)
1604
+ [ associations ].flatten.collect { |association| reflect_on_association(association.to_s.intern) }
1605
+ end
1606
+
1607
+ def guard_against_unlimitable_reflections(reflections, options)
1608
+ if (options[:offset] || options[:limit]) && !using_limitable_reflections?(reflections)
1609
+ raise(
1610
+ ConfigurationError,
1611
+ "You can not use offset and limit together with has_many or has_and_belongs_to_many associations"
1612
+ )
1613
+ end
1614
+ end
1615
+
1616
+ def select_all_rows(options, join_dependency)
1617
+ connection.select_all(
1618
+ construct_finder_sql_with_included_associations(options, join_dependency),
1619
+ "#{name} Load Including Associations"
1620
+ )
1621
+ end
1622
+
1623
+ def construct_finder_sql_with_included_associations(options, join_dependency)
1624
+ scope = scope(:find)
1625
+ sql = "SELECT #{column_aliases(join_dependency)} FROM #{(scope && scope[:from]) || options[:from] || quoted_table_name} "
1626
+ sql << join_dependency.join_associations.collect{|join| join.association_join }.join
1627
+
1628
+ add_joins!(sql, options[:joins], scope)
1629
+ add_conditions!(sql, options[:conditions], scope)
1630
+ add_limited_ids_condition!(sql, options, join_dependency) if !using_limitable_reflections?(join_dependency.reflections) && ((scope && scope[:limit]) || options[:limit])
1631
+
1632
+ add_group!(sql, options[:group], options[:having], scope)
1633
+ add_order!(sql, options[:order], scope)
1634
+ add_limit!(sql, options, scope) if using_limitable_reflections?(join_dependency.reflections)
1635
+ add_lock!(sql, options, scope)
1636
+
1637
+ return sanitize_sql(sql)
1638
+ end
1639
+
1640
+ def add_limited_ids_condition!(sql, options, join_dependency)
1641
+ unless (id_list = select_limited_ids_list(options, join_dependency)).empty?
1642
+ sql << "#{condition_word(sql)} #{connection.quote_table_name table_name}.#{primary_key} IN (#{id_list}) "
1643
+ else
1644
+ throw :invalid_query
1645
+ end
1646
+ end
1647
+
1648
+ def select_limited_ids_list(options, join_dependency)
1649
+ pk = columns_hash[primary_key]
1650
+
1651
+ connection.select_all(
1652
+ construct_finder_sql_for_association_limiting(options, join_dependency),
1653
+ "#{name} Load IDs For Limited Eager Loading"
1654
+ ).collect { |row| connection.quote(row[primary_key], pk) }.join(", ")
1655
+ end
1656
+
1657
+ def construct_finder_sql_for_association_limiting(options, join_dependency)
1658
+ scope = scope(:find)
1659
+
1660
+ # Only join tables referenced in order or conditions since this is particularly slow on the pre-query.
1661
+ tables_from_conditions = conditions_tables(options)
1662
+ tables_from_order = order_tables(options)
1663
+ all_tables = tables_from_conditions + tables_from_order
1664
+ distinct_join_associations = all_tables.uniq.map{|table|
1665
+ join_dependency.joins_for_table_name(table)
1666
+ }.flatten.compact.uniq
1667
+
1668
+ order = options[:order]
1669
+ if scoped_order = (scope && scope[:order])
1670
+ order = order ? "#{order}, #{scoped_order}" : scoped_order
1671
+ end
1672
+
1673
+ is_distinct = !options[:joins].blank? || include_eager_conditions?(options, tables_from_conditions) || include_eager_order?(options, tables_from_order)
1674
+ sql = "SELECT "
1675
+ if is_distinct
1676
+ sql << connection.distinct("#{connection.quote_table_name table_name}.#{primary_key}", order)
1677
+ else
1678
+ sql << primary_key
1679
+ end
1680
+ sql << " FROM #{connection.quote_table_name table_name} "
1681
+
1682
+ if is_distinct
1683
+ sql << distinct_join_associations.collect { |assoc| assoc.association_join }.join
1684
+ add_joins!(sql, options[:joins], scope)
1685
+ end
1686
+
1687
+ add_conditions!(sql, options[:conditions], scope)
1688
+ add_group!(sql, options[:group], options[:having], scope)
1689
+
1690
+ if order && is_distinct
1691
+ connection.add_order_by_for_association_limiting!(sql, :order => order)
1692
+ else
1693
+ add_order!(sql, options[:order], scope)
1694
+ end
1695
+
1696
+ add_limit!(sql, options, scope)
1697
+
1698
+ return sanitize_sql(sql)
1699
+ end
1700
+
1701
+ def tables_in_string(string)
1702
+ return [] if string.blank?
1703
+ string.scan(/([\.a-zA-Z_]+).?\./).flatten
1704
+ end
1705
+
1706
+ def tables_in_hash(hash)
1707
+ return [] if hash.blank?
1708
+ tables = hash.map do |key, value|
1709
+ if value.is_a?(Hash)
1710
+ key.to_s
1711
+ else
1712
+ tables_in_string(key) if key.is_a?(String)
1713
+ end
1714
+ end
1715
+ tables.flatten.compact
1716
+ end
1717
+
1718
+ def conditions_tables(options)
1719
+ # look in both sets of conditions
1720
+ conditions = [scope(:find, :conditions), options[:conditions]].inject([]) do |all, cond|
1721
+ case cond
1722
+ when nil then all
1723
+ when Array then all << tables_in_string(cond.first)
1724
+ when Hash then all << tables_in_hash(cond)
1725
+ else all << tables_in_string(cond)
1726
+ end
1727
+ end
1728
+ conditions.flatten
1729
+ end
1730
+
1731
+ def order_tables(options)
1732
+ order = [options[:order], scope(:find, :order) ].join(", ")
1733
+ return [] unless order && order.is_a?(String)
1734
+ tables_in_string(order)
1735
+ end
1736
+
1737
+ def selects_tables(options)
1738
+ select = options[:select]
1739
+ return [] unless select && select.is_a?(String)
1740
+ tables_in_string(select)
1741
+ end
1742
+
1743
+ def joined_tables(options)
1744
+ scope = scope(:find)
1745
+ joins = options[:joins]
1746
+ merged_joins = scope && scope[:joins] && joins ? merge_joins(scope[:joins], joins) : (joins || scope && scope[:joins])
1747
+ [table_name] + case merged_joins
1748
+ when Symbol, Hash, Array
1749
+ if array_of_strings?(merged_joins)
1750
+ tables_in_string(merged_joins.join(' '))
1751
+ else
1752
+ join_dependency = ActiveRecord::Associations::ClassMethods::InnerJoinDependency.new(self, merged_joins, nil)
1753
+ join_dependency.join_associations.collect {|join_association| [join_association.aliased_join_table_name, join_association.aliased_table_name]}.flatten.compact
1754
+ end
1755
+ else
1756
+ tables_in_string(merged_joins)
1757
+ end
1758
+ end
1759
+
1760
+ # Checks if the conditions reference a table other than the current model table
1761
+ def include_eager_conditions?(options, tables = nil, joined_tables = nil)
1762
+ ((tables || conditions_tables(options)) - (joined_tables || joined_tables(options))).any?
1763
+ end
1764
+
1765
+ # Checks if the query order references a table other than the current model's table.
1766
+ def include_eager_order?(options, tables = nil, joined_tables = nil)
1767
+ ((tables || order_tables(options)) - (joined_tables || joined_tables(options))).any?
1768
+ end
1769
+
1770
+ def include_eager_select?(options, joined_tables = nil)
1771
+ (selects_tables(options) - (joined_tables || joined_tables(options))).any?
1772
+ end
1773
+
1774
+ def references_eager_loaded_tables?(options)
1775
+ joined_tables = joined_tables(options)
1776
+ include_eager_order?(options, nil, joined_tables) || include_eager_conditions?(options, nil, joined_tables) || include_eager_select?(options, joined_tables)
1777
+ end
1778
+
1779
+ def using_limitable_reflections?(reflections)
1780
+ reflections.reject { |r| [ :belongs_to, :has_one ].include?(r.macro) }.length.zero?
1781
+ end
1782
+
1783
+ def column_aliases(join_dependency)
1784
+ join_dependency.joins.collect{|join| join.column_names_with_alias.collect{|column_name, aliased_name|
1785
+ "#{connection.quote_table_name join.aliased_table_name}.#{connection.quote_column_name column_name} AS #{aliased_name}"}}.flatten.join(", ")
1786
+ end
1787
+
1788
+ def add_association_callbacks(association_name, options)
1789
+ callbacks = %w(before_add after_add before_remove after_remove)
1790
+ callbacks.each do |callback_name|
1791
+ full_callback_name = "#{callback_name}_for_#{association_name}"
1792
+ defined_callbacks = options[callback_name.to_sym]
1793
+ if options.has_key?(callback_name.to_sym)
1794
+ class_inheritable_reader full_callback_name.to_sym
1795
+ write_inheritable_attribute(full_callback_name.to_sym, [defined_callbacks].flatten)
1796
+ else
1797
+ write_inheritable_attribute(full_callback_name.to_sym, [])
1798
+ end
1799
+ end
1800
+ end
1801
+
1802
+ def condition_word(sql)
1803
+ sql =~ /where/i ? " AND " : "WHERE "
1804
+ end
1805
+
1806
+ def create_extension_modules(association_id, block_extension, extensions)
1807
+ if block_extension
1808
+ extension_module_name = "#{self.to_s.demodulize}#{association_id.to_s.camelize}AssociationExtension"
1809
+
1810
+ silence_warnings do
1811
+ self.parent.const_set(extension_module_name, Module.new(&block_extension))
1812
+ end
1813
+ Array(extensions).push("#{self.parent}::#{extension_module_name}".constantize)
1814
+ else
1815
+ Array(extensions)
1816
+ end
1817
+ end
1818
+
1819
+ class JoinDependency # :nodoc:
1820
+ attr_reader :joins, :reflections, :table_aliases
1821
+
1822
+ def initialize(base, associations, joins)
1823
+ @joins = [JoinBase.new(base, joins)]
1824
+ @associations = associations
1825
+ @reflections = []
1826
+ @base_records_hash = {}
1827
+ @base_records_in_order = []
1828
+ @table_aliases = Hash.new { |aliases, table| aliases[table] = 0 }
1829
+ @table_aliases[base.table_name] = 1
1830
+ build(associations)
1831
+ end
1832
+
1833
+ def join_associations
1834
+ @joins[1..-1].to_a
1835
+ end
1836
+
1837
+ def join_base
1838
+ @joins[0]
1839
+ end
1840
+
1841
+ def instantiate(rows)
1842
+ rows.each_with_index do |row, i|
1843
+ primary_id = join_base.record_id(row)
1844
+ unless @base_records_hash[primary_id]
1845
+ @base_records_in_order << (@base_records_hash[primary_id] = join_base.instantiate(row))
1846
+ end
1847
+ construct(@base_records_hash[primary_id], @associations, join_associations.dup, row)
1848
+ end
1849
+ remove_duplicate_results!(join_base.active_record, @base_records_in_order, @associations)
1850
+ return @base_records_in_order
1851
+ end
1852
+
1853
+ def remove_duplicate_results!(base, records, associations)
1854
+ case associations
1855
+ when Symbol, String
1856
+ reflection = base.reflections[associations]
1857
+ if reflection && [:has_many, :has_and_belongs_to_many].include?(reflection.macro)
1858
+ records.each { |record| record.send(reflection.name).target.uniq! }
1859
+ end
1860
+ when Array
1861
+ associations.each do |association|
1862
+ remove_duplicate_results!(base, records, association)
1863
+ end
1864
+ when Hash
1865
+ associations.keys.each do |name|
1866
+ reflection = base.reflections[name]
1867
+ is_collection = [:has_many, :has_and_belongs_to_many].include?(reflection.macro)
1868
+
1869
+ parent_records = records.map do |record|
1870
+ descendant = record.send(reflection.name)
1871
+ next unless descendant
1872
+ descendant.target.uniq! if is_collection
1873
+ descendant
1874
+ end.flatten.compact
1875
+
1876
+ remove_duplicate_results!(reflection.klass, parent_records, associations[name]) unless parent_records.empty?
1877
+ end
1878
+ end
1879
+ end
1880
+
1881
+ def join_for_table_name(table_name)
1882
+ join = (@joins.select{|j|j.aliased_table_name == table_name.gsub(/^\"(.*)\"$/){$1} }.first) rescue nil
1883
+ return join unless join.nil?
1884
+ @joins.select{|j|j.is_a?(JoinAssociation) && j.aliased_join_table_name == table_name.gsub(/^\"(.*)\"$/){$1} }.first rescue nil
1885
+ end
1886
+
1887
+ def joins_for_table_name(table_name)
1888
+ join = join_for_table_name(table_name)
1889
+ result = nil
1890
+ if join && join.is_a?(JoinAssociation)
1891
+ result = [join]
1892
+ if join.parent && join.parent.is_a?(JoinAssociation)
1893
+ result = joins_for_table_name(join.parent.aliased_table_name) +
1894
+ result
1895
+ end
1896
+ end
1897
+ result
1898
+ end
1899
+
1900
+ protected
1901
+ def build(associations, parent = nil)
1902
+ parent ||= @joins.last
1903
+ case associations
1904
+ when Symbol, String
1905
+ reflection = parent.reflections[associations.to_s.intern] or
1906
+ raise ConfigurationError, "Association named '#{ associations }' was not found; perhaps you misspelled it?"
1907
+ @reflections << reflection
1908
+ @joins << build_join_association(reflection, parent)
1909
+ when Array
1910
+ associations.each do |association|
1911
+ build(association, parent)
1912
+ end
1913
+ when Hash
1914
+ associations.keys.sort{|a,b|a.to_s<=>b.to_s}.each do |name|
1915
+ build(name, parent)
1916
+ build(associations[name])
1917
+ end
1918
+ else
1919
+ raise ConfigurationError, associations.inspect
1920
+ end
1921
+ end
1922
+
1923
+ # overridden in InnerJoinDependency subclass
1924
+ def build_join_association(reflection, parent)
1925
+ JoinAssociation.new(reflection, self, parent)
1926
+ end
1927
+
1928
+ def construct(parent, associations, joins, row)
1929
+ case associations
1930
+ when Symbol, String
1931
+ join = joins.detect{|j| j.reflection.name.to_s == associations.to_s && j.parent_table_name == parent.class.table_name }
1932
+ raise(ConfigurationError, "No such association") if join.nil?
1933
+
1934
+ joins.delete(join)
1935
+ construct_association(parent, join, row)
1936
+ when Array
1937
+ associations.each do |association|
1938
+ construct(parent, association, joins, row)
1939
+ end
1940
+ when Hash
1941
+ associations.keys.sort{|a,b|a.to_s<=>b.to_s}.each do |name|
1942
+ join = joins.detect{|j| j.reflection.name.to_s == name.to_s && j.parent_table_name == parent.class.table_name }
1943
+ raise(ConfigurationError, "No such association") if join.nil?
1944
+
1945
+ association = construct_association(parent, join, row)
1946
+ joins.delete(join)
1947
+ construct(association, associations[name], joins, row) if association
1948
+ end
1949
+ else
1950
+ raise ConfigurationError, associations.inspect
1951
+ end
1952
+ end
1953
+
1954
+ def construct_association(record, join, row)
1955
+ case join.reflection.macro
1956
+ when :has_many, :has_and_belongs_to_many
1957
+ collection = record.send(join.reflection.name)
1958
+ collection.loaded
1959
+
1960
+ return nil if record.id.to_s != join.parent.record_id(row).to_s or row[join.aliased_primary_key].nil?
1961
+ association = join.instantiate(row)
1962
+ collection.target.push(association)
1963
+ when :has_one
1964
+ return if record.id.to_s != join.parent.record_id(row).to_s
1965
+ return if record.instance_variable_defined?("@#{join.reflection.name}")
1966
+ association = join.instantiate(row) unless row[join.aliased_primary_key].nil?
1967
+ record.send("set_#{join.reflection.name}_target", association)
1968
+ when :belongs_to
1969
+ return if record.id.to_s != join.parent.record_id(row).to_s or row[join.aliased_primary_key].nil?
1970
+ association = join.instantiate(row)
1971
+ record.send("set_#{join.reflection.name}_target", association)
1972
+ else
1973
+ raise ConfigurationError, "unknown macro: #{join.reflection.macro}"
1974
+ end
1975
+ return association
1976
+ end
1977
+
1978
+ class JoinBase # :nodoc:
1979
+ attr_reader :active_record, :table_joins
1980
+ delegate :table_name, :column_names, :primary_key, :reflections, :sanitize_sql, :to => :active_record
1981
+
1982
+ def initialize(active_record, joins = nil)
1983
+ @active_record = active_record
1984
+ @cached_record = {}
1985
+ @table_joins = joins
1986
+ end
1987
+
1988
+ def aliased_prefix
1989
+ "t0"
1990
+ end
1991
+
1992
+ def aliased_primary_key
1993
+ "#{aliased_prefix}_r0"
1994
+ end
1995
+
1996
+ def aliased_table_name
1997
+ active_record.table_name
1998
+ end
1999
+
2000
+ def column_names_with_alias
2001
+ unless defined?(@column_names_with_alias)
2002
+ @column_names_with_alias = []
2003
+
2004
+ ([primary_key] + (column_names - [primary_key])).each_with_index do |column_name, i|
2005
+ @column_names_with_alias << [column_name, "#{aliased_prefix}_r#{i}"]
2006
+ end
2007
+ end
2008
+
2009
+ @column_names_with_alias
2010
+ end
2011
+
2012
+ def extract_record(row)
2013
+ column_names_with_alias.inject({}){|record, (cn, an)| record[cn] = row[an]; record}
2014
+ end
2015
+
2016
+ def record_id(row)
2017
+ row[aliased_primary_key]
2018
+ end
2019
+
2020
+ def instantiate(row)
2021
+ @cached_record[record_id(row)] ||= active_record.send(:instantiate, extract_record(row))
2022
+ end
2023
+ end
2024
+
2025
+ class JoinAssociation < JoinBase # :nodoc:
2026
+ attr_reader :reflection, :parent, :aliased_table_name, :aliased_prefix, :aliased_join_table_name, :parent_table_name
2027
+ delegate :options, :klass, :through_reflection, :source_reflection, :to => :reflection
2028
+
2029
+ def initialize(reflection, join_dependency, parent = nil)
2030
+ reflection.check_validity!
2031
+ if reflection.options[:polymorphic]
2032
+ raise EagerLoadPolymorphicError.new(reflection)
2033
+ end
2034
+
2035
+ super(reflection.klass)
2036
+ @join_dependency = join_dependency
2037
+ @parent = parent
2038
+ @reflection = reflection
2039
+ @aliased_prefix = "t#{ join_dependency.joins.size }"
2040
+ @parent_table_name = parent.active_record.table_name
2041
+ @aliased_table_name = aliased_table_name_for(table_name)
2042
+
2043
+ if reflection.macro == :has_and_belongs_to_many
2044
+ @aliased_join_table_name = aliased_table_name_for(reflection.options[:join_table], "_join")
2045
+ end
2046
+
2047
+ if [:has_many, :has_one].include?(reflection.macro) && reflection.options[:through]
2048
+ @aliased_join_table_name = aliased_table_name_for(reflection.through_reflection.klass.table_name, "_join")
2049
+ end
2050
+ end
2051
+
2052
+ def association_join
2053
+ connection = reflection.active_record.connection
2054
+ join = case reflection.macro
2055
+ when :has_and_belongs_to_many
2056
+ " #{join_type} %s ON %s.%s = %s.%s " % [
2057
+ table_alias_for(options[:join_table], aliased_join_table_name),
2058
+ connection.quote_table_name(aliased_join_table_name),
2059
+ options[:foreign_key] || reflection.active_record.to_s.foreign_key,
2060
+ connection.quote_table_name(parent.aliased_table_name),
2061
+ reflection.active_record.primary_key] +
2062
+ " #{join_type} %s ON %s.%s = %s.%s " % [
2063
+ table_name_and_alias,
2064
+ connection.quote_table_name(aliased_table_name),
2065
+ klass.primary_key,
2066
+ connection.quote_table_name(aliased_join_table_name),
2067
+ options[:association_foreign_key] || klass.to_s.foreign_key
2068
+ ]
2069
+ when :has_many, :has_one
2070
+ case
2071
+ when reflection.options[:through]
2072
+ through_conditions = through_reflection.options[:conditions] ? "AND #{interpolate_sql(sanitize_sql(through_reflection.options[:conditions]))}" : ''
2073
+
2074
+ jt_foreign_key = jt_as_extra = jt_source_extra = jt_sti_extra = nil
2075
+ first_key = second_key = as_extra = nil
2076
+
2077
+ if through_reflection.options[:as] # has_many :through against a polymorphic join
2078
+ jt_foreign_key = through_reflection.options[:as].to_s + '_id'
2079
+ jt_as_extra = " AND %s.%s = %s" % [
2080
+ connection.quote_table_name(aliased_join_table_name),
2081
+ connection.quote_column_name(through_reflection.options[:as].to_s + '_type'),
2082
+ klass.quote_value(parent.active_record.base_class.name)
2083
+ ]
2084
+ else
2085
+ jt_foreign_key = through_reflection.primary_key_name
2086
+ end
2087
+
2088
+ case source_reflection.macro
2089
+ when :has_many
2090
+ if source_reflection.options[:as]
2091
+ first_key = "#{source_reflection.options[:as]}_id"
2092
+ second_key = options[:foreign_key] || primary_key
2093
+ as_extra = " AND %s.%s = %s" % [
2094
+ connection.quote_table_name(aliased_table_name),
2095
+ connection.quote_column_name("#{source_reflection.options[:as]}_type"),
2096
+ klass.quote_value(source_reflection.active_record.base_class.name)
2097
+ ]
2098
+ else
2099
+ first_key = through_reflection.klass.base_class.to_s.foreign_key
2100
+ second_key = options[:foreign_key] || primary_key
2101
+ end
2102
+
2103
+ unless through_reflection.klass.descends_from_active_record?
2104
+ jt_sti_extra = " AND %s.%s = %s" % [
2105
+ connection.quote_table_name(aliased_join_table_name),
2106
+ connection.quote_column_name(through_reflection.active_record.inheritance_column),
2107
+ through_reflection.klass.quote_value(through_reflection.klass.sti_name)]
2108
+ end
2109
+ when :belongs_to
2110
+ first_key = primary_key
2111
+ if reflection.options[:source_type]
2112
+ second_key = source_reflection.association_foreign_key
2113
+ jt_source_extra = " AND %s.%s = %s" % [
2114
+ connection.quote_table_name(aliased_join_table_name),
2115
+ connection.quote_column_name(reflection.source_reflection.options[:foreign_type]),
2116
+ klass.quote_value(reflection.options[:source_type])
2117
+ ]
2118
+ else
2119
+ second_key = source_reflection.primary_key_name
2120
+ end
2121
+ end
2122
+
2123
+ " #{join_type} %s ON (%s.%s = %s.%s%s%s%s) " % [
2124
+ table_alias_for(through_reflection.klass.table_name, aliased_join_table_name),
2125
+ connection.quote_table_name(parent.aliased_table_name),
2126
+ connection.quote_column_name(parent.primary_key),
2127
+ connection.quote_table_name(aliased_join_table_name),
2128
+ connection.quote_column_name(jt_foreign_key),
2129
+ jt_as_extra, jt_source_extra, jt_sti_extra
2130
+ ] +
2131
+ " #{join_type} %s ON (%s.%s = %s.%s%s) " % [
2132
+ table_name_and_alias,
2133
+ connection.quote_table_name(aliased_table_name),
2134
+ connection.quote_column_name(first_key),
2135
+ connection.quote_table_name(aliased_join_table_name),
2136
+ connection.quote_column_name(second_key),
2137
+ as_extra
2138
+ ]
2139
+
2140
+ when reflection.options[:as] && [:has_many, :has_one].include?(reflection.macro)
2141
+ " #{join_type} %s ON %s.%s = %s.%s AND %s.%s = %s" % [
2142
+ table_name_and_alias,
2143
+ connection.quote_table_name(aliased_table_name),
2144
+ "#{reflection.options[:as]}_id",
2145
+ connection.quote_table_name(parent.aliased_table_name),
2146
+ parent.primary_key,
2147
+ connection.quote_table_name(aliased_table_name),
2148
+ "#{reflection.options[:as]}_type",
2149
+ klass.quote_value(parent.active_record.base_class.name)
2150
+ ]
2151
+ else
2152
+ foreign_key = options[:foreign_key] || reflection.active_record.name.foreign_key
2153
+ " #{join_type} %s ON %s.%s = %s.%s " % [
2154
+ table_name_and_alias,
2155
+ aliased_table_name,
2156
+ foreign_key,
2157
+ parent.aliased_table_name,
2158
+ reflection.options[:primary_key] || parent.primary_key
2159
+ ]
2160
+ end
2161
+ when :belongs_to
2162
+ " #{join_type} %s ON %s.%s = %s.%s " % [
2163
+ table_name_and_alias,
2164
+ connection.quote_table_name(aliased_table_name),
2165
+ reflection.klass.primary_key,
2166
+ connection.quote_table_name(parent.aliased_table_name),
2167
+ options[:foreign_key] || reflection.primary_key_name
2168
+ ]
2169
+ else
2170
+ ""
2171
+ end || ''
2172
+ join << %(AND %s) % [
2173
+ klass.send(:type_condition, aliased_table_name)] unless klass.descends_from_active_record?
2174
+
2175
+ [through_reflection, reflection].each do |ref|
2176
+ join << "AND #{interpolate_sql(sanitize_sql(ref.options[:conditions], aliased_table_name))} " if ref && ref.options[:conditions]
2177
+ end
2178
+
2179
+ join
2180
+ end
2181
+
2182
+ protected
2183
+
2184
+ def aliased_table_name_for(name, suffix = nil)
2185
+ if !parent.table_joins.blank? && parent.table_joins.to_s.downcase =~ %r{join(\s+\w+)?\s+#{active_record.connection.quote_table_name name.downcase}\son}
2186
+ @join_dependency.table_aliases[name] += 1
2187
+ end
2188
+
2189
+ unless @join_dependency.table_aliases[name].zero?
2190
+ # if the table name has been used, then use an alias
2191
+ name = active_record.connection.table_alias_for "#{pluralize(reflection.name)}_#{parent_table_name}#{suffix}"
2192
+ table_index = @join_dependency.table_aliases[name]
2193
+ @join_dependency.table_aliases[name] += 1
2194
+ name = name[0..active_record.connection.table_alias_length-3] + "_#{table_index+1}" if table_index > 0
2195
+ else
2196
+ @join_dependency.table_aliases[name] += 1
2197
+ end
2198
+
2199
+ name
2200
+ end
2201
+
2202
+ def pluralize(table_name)
2203
+ ActiveRecord::Base.pluralize_table_names ? table_name.to_s.pluralize : table_name
2204
+ end
2205
+
2206
+ def table_alias_for(table_name, table_alias)
2207
+ "#{reflection.active_record.connection.quote_table_name(table_name)} #{table_alias if table_name != table_alias}".strip
2208
+ end
2209
+
2210
+ def table_name_and_alias
2211
+ table_alias_for table_name, @aliased_table_name
2212
+ end
2213
+
2214
+ def interpolate_sql(sql)
2215
+ instance_eval("%@#{sql.gsub('@', '\@')}@")
2216
+ end
2217
+
2218
+ private
2219
+ def join_type
2220
+ "LEFT OUTER JOIN"
2221
+ end
2222
+ end
2223
+ end
2224
+
2225
+ class InnerJoinDependency < JoinDependency # :nodoc:
2226
+ protected
2227
+ def build_join_association(reflection, parent)
2228
+ InnerJoinAssociation.new(reflection, self, parent)
2229
+ end
2230
+
2231
+ class InnerJoinAssociation < JoinAssociation
2232
+ private
2233
+ def join_type
2234
+ "INNER JOIN"
2235
+ end
2236
+ end
2237
+ end
2238
+
2239
+ end
2240
+ end
2241
+ end