activerecord 5.0.6 → 6.0.1

Sign up to get free protection for your applications and to get access to all the features.

Potentially problematic release.


This version of activerecord might be problematic. Click here for more details.

Files changed (358) hide show
  1. checksums.yaml +5 -5
  2. data/CHANGELOG.md +638 -2023
  3. data/MIT-LICENSE +3 -1
  4. data/README.rdoc +8 -6
  5. data/examples/performance.rb +31 -29
  6. data/examples/simple.rb +5 -3
  7. data/lib/active_record/aggregations.rb +249 -246
  8. data/lib/active_record/association_relation.rb +24 -13
  9. data/lib/active_record/associations/alias_tracker.rb +24 -33
  10. data/lib/active_record/associations/association.rb +119 -56
  11. data/lib/active_record/associations/association_scope.rb +94 -94
  12. data/lib/active_record/associations/belongs_to_association.rb +58 -42
  13. data/lib/active_record/associations/belongs_to_polymorphic_association.rb +8 -12
  14. data/lib/active_record/associations/builder/association.rb +18 -25
  15. data/lib/active_record/associations/builder/belongs_to.rb +43 -54
  16. data/lib/active_record/associations/builder/collection_association.rb +7 -18
  17. data/lib/active_record/associations/builder/has_and_belongs_to_many.rb +42 -61
  18. data/lib/active_record/associations/builder/has_many.rb +4 -0
  19. data/lib/active_record/associations/builder/has_one.rb +37 -1
  20. data/lib/active_record/associations/builder/singular_association.rb +4 -0
  21. data/lib/active_record/associations/collection_association.rb +80 -252
  22. data/lib/active_record/associations/collection_proxy.rb +158 -121
  23. data/lib/active_record/associations/foreign_association.rb +9 -0
  24. data/lib/active_record/associations/has_many_association.rb +23 -29
  25. data/lib/active_record/associations/has_many_through_association.rb +58 -44
  26. data/lib/active_record/associations/has_one_association.rb +59 -54
  27. data/lib/active_record/associations/has_one_through_association.rb +20 -11
  28. data/lib/active_record/associations/join_dependency/join_association.rb +38 -90
  29. data/lib/active_record/associations/join_dependency/join_base.rb +10 -9
  30. data/lib/active_record/associations/join_dependency/join_part.rb +12 -12
  31. data/lib/active_record/associations/join_dependency.rb +134 -176
  32. data/lib/active_record/associations/preloader/association.rb +84 -125
  33. data/lib/active_record/associations/preloader/through_association.rb +82 -75
  34. data/lib/active_record/associations/preloader.rb +90 -102
  35. data/lib/active_record/associations/singular_association.rb +12 -45
  36. data/lib/active_record/associations/through_association.rb +26 -14
  37. data/lib/active_record/associations.rb +1603 -1592
  38. data/lib/active_record/attribute_assignment.rb +54 -60
  39. data/lib/active_record/attribute_decorators.rb +38 -15
  40. data/lib/active_record/attribute_methods/before_type_cast.rb +12 -7
  41. data/lib/active_record/attribute_methods/dirty.rb +179 -109
  42. data/lib/active_record/attribute_methods/primary_key.rb +86 -91
  43. data/lib/active_record/attribute_methods/query.rb +4 -3
  44. data/lib/active_record/attribute_methods/read.rb +21 -49
  45. data/lib/active_record/attribute_methods/serialization.rb +30 -7
  46. data/lib/active_record/attribute_methods/time_zone_conversion.rb +39 -64
  47. data/lib/active_record/attribute_methods/write.rb +35 -33
  48. data/lib/active_record/attribute_methods.rb +66 -106
  49. data/lib/active_record/attributes.rb +38 -24
  50. data/lib/active_record/autosave_association.rb +53 -32
  51. data/lib/active_record/base.rb +27 -24
  52. data/lib/active_record/callbacks.rb +63 -33
  53. data/lib/active_record/coders/json.rb +2 -0
  54. data/lib/active_record/coders/yaml_column.rb +11 -11
  55. data/lib/active_record/connection_adapters/abstract/connection_pool.rb +553 -321
  56. data/lib/active_record/connection_adapters/abstract/database_limits.rb +23 -5
  57. data/lib/active_record/connection_adapters/abstract/database_statements.rb +213 -94
  58. data/lib/active_record/connection_adapters/abstract/query_cache.rb +59 -28
  59. data/lib/active_record/connection_adapters/abstract/quoting.rb +119 -75
  60. data/lib/active_record/connection_adapters/abstract/savepoints.rb +2 -0
  61. data/lib/active_record/connection_adapters/abstract/schema_creation.rb +33 -27
  62. data/lib/active_record/connection_adapters/abstract/schema_definitions.rb +207 -126
  63. data/lib/active_record/connection_adapters/abstract/schema_dumper.rb +68 -80
  64. data/lib/active_record/connection_adapters/abstract/schema_statements.rb +369 -199
  65. data/lib/active_record/connection_adapters/abstract/transaction.rb +169 -78
  66. data/lib/active_record/connection_adapters/abstract_adapter.rb +363 -202
  67. data/lib/active_record/connection_adapters/abstract_mysql_adapter.rb +405 -551
  68. data/lib/active_record/connection_adapters/column.rb +41 -13
  69. data/lib/active_record/connection_adapters/connection_specification.rb +172 -138
  70. data/lib/active_record/connection_adapters/determine_if_preparable_visitor.rb +11 -4
  71. data/lib/active_record/connection_adapters/mysql/column.rb +8 -31
  72. data/lib/active_record/connection_adapters/mysql/database_statements.rb +143 -49
  73. data/lib/active_record/connection_adapters/mysql/explain_pretty_printer.rb +24 -22
  74. data/lib/active_record/connection_adapters/mysql/quoting.rb +50 -20
  75. data/lib/active_record/connection_adapters/mysql/schema_creation.rb +50 -45
  76. data/lib/active_record/connection_adapters/mysql/schema_definitions.rb +58 -56
  77. data/lib/active_record/connection_adapters/mysql/schema_dumper.rb +70 -36
  78. data/lib/active_record/connection_adapters/mysql/schema_statements.rb +264 -0
  79. data/lib/active_record/connection_adapters/mysql/type_metadata.rb +12 -13
  80. data/lib/active_record/connection_adapters/mysql2_adapter.rb +49 -30
  81. data/lib/active_record/connection_adapters/postgresql/column.rb +22 -7
  82. data/lib/active_record/connection_adapters/postgresql/database_statements.rb +60 -54
  83. data/lib/active_record/connection_adapters/postgresql/explain_pretty_printer.rb +5 -3
  84. data/lib/active_record/connection_adapters/postgresql/oid/array.rb +22 -10
  85. data/lib/active_record/connection_adapters/postgresql/oid/bit.rb +6 -5
  86. data/lib/active_record/connection_adapters/postgresql/oid/bit_varying.rb +2 -0
  87. data/lib/active_record/connection_adapters/postgresql/oid/bytea.rb +2 -0
  88. data/lib/active_record/connection_adapters/postgresql/oid/cidr.rb +3 -1
  89. data/lib/active_record/connection_adapters/postgresql/oid/date.rb +23 -0
  90. data/lib/active_record/connection_adapters/postgresql/oid/date_time.rb +4 -2
  91. data/lib/active_record/connection_adapters/postgresql/oid/decimal.rb +3 -1
  92. data/lib/active_record/connection_adapters/postgresql/oid/enum.rb +5 -3
  93. data/lib/active_record/connection_adapters/postgresql/oid/hstore.rb +19 -17
  94. data/lib/active_record/connection_adapters/postgresql/oid/inet.rb +2 -0
  95. data/lib/active_record/connection_adapters/postgresql/oid/jsonb.rb +3 -11
  96. data/lib/active_record/connection_adapters/postgresql/oid/legacy_point.rb +45 -0
  97. data/lib/active_record/connection_adapters/postgresql/oid/money.rb +7 -5
  98. data/lib/active_record/connection_adapters/postgresql/oid/{json.rb → oid.rb} +6 -1
  99. data/lib/active_record/connection_adapters/postgresql/oid/point.rb +31 -9
  100. data/lib/active_record/connection_adapters/postgresql/oid/range.rb +34 -30
  101. data/lib/active_record/connection_adapters/postgresql/oid/specialized_string.rb +4 -1
  102. data/lib/active_record/connection_adapters/postgresql/oid/type_map_initializer.rb +58 -54
  103. data/lib/active_record/connection_adapters/postgresql/oid/uuid.rb +9 -4
  104. data/lib/active_record/connection_adapters/postgresql/oid/vector.rb +2 -0
  105. data/lib/active_record/connection_adapters/postgresql/oid/xml.rb +2 -0
  106. data/lib/active_record/connection_adapters/postgresql/oid.rb +24 -21
  107. data/lib/active_record/connection_adapters/postgresql/quoting.rb +95 -35
  108. data/lib/active_record/connection_adapters/postgresql/referential_integrity.rb +19 -25
  109. data/lib/active_record/connection_adapters/postgresql/schema_creation.rb +76 -0
  110. data/lib/active_record/connection_adapters/postgresql/schema_definitions.rb +147 -105
  111. data/lib/active_record/connection_adapters/postgresql/schema_dumper.rb +35 -32
  112. data/lib/active_record/connection_adapters/postgresql/schema_statements.rb +380 -300
  113. data/lib/active_record/connection_adapters/postgresql/type_metadata.rb +26 -25
  114. data/lib/active_record/connection_adapters/postgresql/utils.rb +10 -6
  115. data/lib/active_record/connection_adapters/postgresql_adapter.rb +382 -275
  116. data/lib/active_record/connection_adapters/schema_cache.rb +46 -12
  117. data/lib/active_record/connection_adapters/sql_type_metadata.rb +13 -8
  118. data/lib/active_record/connection_adapters/sqlite3/database_statements.rb +120 -0
  119. data/lib/active_record/connection_adapters/sqlite3/explain_pretty_printer.rb +3 -1
  120. data/lib/active_record/connection_adapters/sqlite3/quoting.rb +74 -19
  121. data/lib/active_record/connection_adapters/sqlite3/schema_creation.rb +3 -8
  122. data/lib/active_record/connection_adapters/sqlite3/schema_definitions.rb +19 -0
  123. data/lib/active_record/connection_adapters/sqlite3/schema_dumper.rb +18 -0
  124. data/lib/active_record/connection_adapters/sqlite3/schema_statements.rb +137 -0
  125. data/lib/active_record/connection_adapters/sqlite3_adapter.rb +254 -262
  126. data/lib/active_record/connection_adapters/statement_pool.rb +9 -7
  127. data/lib/active_record/connection_handling.rb +159 -40
  128. data/lib/active_record/core.rb +202 -162
  129. data/lib/active_record/counter_cache.rb +57 -28
  130. data/lib/active_record/database_configurations/database_config.rb +37 -0
  131. data/lib/active_record/database_configurations/hash_config.rb +50 -0
  132. data/lib/active_record/database_configurations/url_config.rb +79 -0
  133. data/lib/active_record/database_configurations.rb +233 -0
  134. data/lib/active_record/define_callbacks.rb +22 -0
  135. data/lib/active_record/dynamic_matchers.rb +87 -86
  136. data/lib/active_record/enum.rb +60 -23
  137. data/lib/active_record/errors.rb +114 -18
  138. data/lib/active_record/explain.rb +4 -3
  139. data/lib/active_record/explain_registry.rb +3 -1
  140. data/lib/active_record/explain_subscriber.rb +9 -4
  141. data/lib/active_record/fixture_set/file.rb +13 -8
  142. data/lib/active_record/fixture_set/model_metadata.rb +33 -0
  143. data/lib/active_record/fixture_set/render_context.rb +17 -0
  144. data/lib/active_record/fixture_set/table_row.rb +153 -0
  145. data/lib/active_record/fixture_set/table_rows.rb +47 -0
  146. data/lib/active_record/fixtures.rb +195 -502
  147. data/lib/active_record/gem_version.rb +4 -2
  148. data/lib/active_record/inheritance.rb +151 -97
  149. data/lib/active_record/insert_all.rb +179 -0
  150. data/lib/active_record/integration.rb +116 -25
  151. data/lib/active_record/internal_metadata.rb +15 -18
  152. data/lib/active_record/legacy_yaml_adapter.rb +4 -2
  153. data/lib/active_record/locking/optimistic.rb +78 -87
  154. data/lib/active_record/locking/pessimistic.rb +18 -6
  155. data/lib/active_record/log_subscriber.rb +48 -29
  156. data/lib/active_record/middleware/database_selector/resolver/session.rb +45 -0
  157. data/lib/active_record/middleware/database_selector/resolver.rb +88 -0
  158. data/lib/active_record/middleware/database_selector.rb +75 -0
  159. data/lib/active_record/migration/command_recorder.rb +143 -97
  160. data/lib/active_record/migration/compatibility.rb +174 -56
  161. data/lib/active_record/migration/join_table.rb +8 -6
  162. data/lib/active_record/migration.rb +367 -300
  163. data/lib/active_record/model_schema.rb +145 -139
  164. data/lib/active_record/nested_attributes.rb +214 -201
  165. data/lib/active_record/no_touching.rb +10 -1
  166. data/lib/active_record/null_relation.rb +13 -34
  167. data/lib/active_record/persistence.rb +442 -72
  168. data/lib/active_record/query_cache.rb +15 -14
  169. data/lib/active_record/querying.rb +36 -23
  170. data/lib/active_record/railtie.rb +128 -36
  171. data/lib/active_record/railties/collection_cache_association_loading.rb +34 -0
  172. data/lib/active_record/railties/console_sandbox.rb +2 -0
  173. data/lib/active_record/railties/controller_runtime.rb +34 -33
  174. data/lib/active_record/railties/databases.rake +309 -177
  175. data/lib/active_record/readonly_attributes.rb +5 -4
  176. data/lib/active_record/reflection.rb +211 -249
  177. data/lib/active_record/relation/batches/batch_enumerator.rb +3 -1
  178. data/lib/active_record/relation/batches.rb +99 -52
  179. data/lib/active_record/relation/calculations.rb +211 -172
  180. data/lib/active_record/relation/delegation.rb +67 -65
  181. data/lib/active_record/relation/finder_methods.rb +208 -247
  182. data/lib/active_record/relation/from_clause.rb +2 -8
  183. data/lib/active_record/relation/merger.rb +78 -61
  184. data/lib/active_record/relation/predicate_builder/array_handler.rb +20 -14
  185. data/lib/active_record/relation/predicate_builder/association_query_value.rb +43 -0
  186. data/lib/active_record/relation/predicate_builder/base_handler.rb +4 -3
  187. data/lib/active_record/relation/predicate_builder/basic_object_handler.rb +6 -4
  188. data/lib/active_record/relation/predicate_builder/polymorphic_array_value.rb +53 -0
  189. data/lib/active_record/relation/predicate_builder/range_handler.rb +7 -18
  190. data/lib/active_record/relation/predicate_builder/relation_handler.rb +6 -0
  191. data/lib/active_record/relation/predicate_builder.rb +86 -104
  192. data/lib/active_record/relation/query_attribute.rb +33 -2
  193. data/lib/active_record/relation/query_methods.rb +458 -329
  194. data/lib/active_record/relation/record_fetch_warning.rb +5 -3
  195. data/lib/active_record/relation/spawn_methods.rb +8 -7
  196. data/lib/active_record/relation/where_clause.rb +111 -95
  197. data/lib/active_record/relation/where_clause_factory.rb +6 -11
  198. data/lib/active_record/relation.rb +429 -318
  199. data/lib/active_record/result.rb +69 -39
  200. data/lib/active_record/runtime_registry.rb +5 -3
  201. data/lib/active_record/sanitization.rb +83 -99
  202. data/lib/active_record/schema.rb +7 -14
  203. data/lib/active_record/schema_dumper.rb +71 -69
  204. data/lib/active_record/schema_migration.rb +15 -5
  205. data/lib/active_record/scoping/default.rb +93 -95
  206. data/lib/active_record/scoping/named.rb +45 -25
  207. data/lib/active_record/scoping.rb +20 -19
  208. data/lib/active_record/secure_token.rb +4 -2
  209. data/lib/active_record/serialization.rb +2 -0
  210. data/lib/active_record/statement_cache.rb +63 -28
  211. data/lib/active_record/store.rb +121 -41
  212. data/lib/active_record/suppressor.rb +4 -1
  213. data/lib/active_record/table_metadata.rb +26 -20
  214. data/lib/active_record/tasks/database_tasks.rb +276 -85
  215. data/lib/active_record/tasks/mysql_database_tasks.rb +54 -90
  216. data/lib/active_record/tasks/postgresql_database_tasks.rb +78 -47
  217. data/lib/active_record/tasks/sqlite_database_tasks.rb +34 -16
  218. data/lib/active_record/test_databases.rb +23 -0
  219. data/lib/active_record/test_fixtures.rb +224 -0
  220. data/lib/active_record/timestamp.rb +70 -35
  221. data/lib/active_record/touch_later.rb +7 -4
  222. data/lib/active_record/transactions.rb +133 -149
  223. data/lib/active_record/translation.rb +3 -1
  224. data/lib/active_record/type/adapter_specific_registry.rb +44 -45
  225. data/lib/active_record/type/date.rb +2 -0
  226. data/lib/active_record/type/date_time.rb +2 -0
  227. data/lib/active_record/type/decimal_without_scale.rb +15 -0
  228. data/lib/active_record/type/hash_lookup_type_map.rb +5 -3
  229. data/lib/active_record/type/internal/timezone.rb +2 -0
  230. data/lib/active_record/type/json.rb +30 -0
  231. data/lib/active_record/type/serialized.rb +16 -8
  232. data/lib/active_record/type/text.rb +11 -0
  233. data/lib/active_record/type/time.rb +2 -1
  234. data/lib/active_record/type/type_map.rb +13 -15
  235. data/lib/active_record/type/unsigned_integer.rb +17 -0
  236. data/lib/active_record/type.rb +23 -17
  237. data/lib/active_record/type_caster/connection.rb +17 -12
  238. data/lib/active_record/type_caster/map.rb +5 -4
  239. data/lib/active_record/type_caster.rb +4 -2
  240. data/lib/active_record/validations/absence.rb +2 -0
  241. data/lib/active_record/validations/associated.rb +3 -1
  242. data/lib/active_record/validations/length.rb +2 -0
  243. data/lib/active_record/validations/presence.rb +4 -2
  244. data/lib/active_record/validations/uniqueness.rb +29 -42
  245. data/lib/active_record/validations.rb +7 -4
  246. data/lib/active_record/version.rb +3 -1
  247. data/lib/active_record.rb +36 -22
  248. data/lib/arel/alias_predication.rb +9 -0
  249. data/lib/arel/attributes/attribute.rb +37 -0
  250. data/lib/arel/attributes.rb +22 -0
  251. data/lib/arel/collectors/bind.rb +24 -0
  252. data/lib/arel/collectors/composite.rb +31 -0
  253. data/lib/arel/collectors/plain_string.rb +20 -0
  254. data/lib/arel/collectors/sql_string.rb +20 -0
  255. data/lib/arel/collectors/substitute_binds.rb +28 -0
  256. data/lib/arel/crud.rb +42 -0
  257. data/lib/arel/delete_manager.rb +18 -0
  258. data/lib/arel/errors.rb +9 -0
  259. data/lib/arel/expressions.rb +29 -0
  260. data/lib/arel/factory_methods.rb +49 -0
  261. data/lib/arel/insert_manager.rb +49 -0
  262. data/lib/arel/math.rb +45 -0
  263. data/lib/arel/nodes/and.rb +32 -0
  264. data/lib/arel/nodes/ascending.rb +23 -0
  265. data/lib/arel/nodes/binary.rb +52 -0
  266. data/lib/arel/nodes/bind_param.rb +36 -0
  267. data/lib/arel/nodes/case.rb +55 -0
  268. data/lib/arel/nodes/casted.rb +50 -0
  269. data/lib/arel/nodes/comment.rb +29 -0
  270. data/lib/arel/nodes/count.rb +12 -0
  271. data/lib/arel/nodes/delete_statement.rb +45 -0
  272. data/lib/arel/nodes/descending.rb +23 -0
  273. data/lib/arel/nodes/equality.rb +18 -0
  274. data/lib/arel/nodes/extract.rb +24 -0
  275. data/lib/arel/nodes/false.rb +16 -0
  276. data/lib/arel/nodes/full_outer_join.rb +8 -0
  277. data/lib/arel/nodes/function.rb +44 -0
  278. data/lib/arel/nodes/grouping.rb +8 -0
  279. data/lib/arel/nodes/in.rb +8 -0
  280. data/lib/arel/nodes/infix_operation.rb +80 -0
  281. data/lib/arel/nodes/inner_join.rb +8 -0
  282. data/lib/arel/nodes/insert_statement.rb +37 -0
  283. data/lib/arel/nodes/join_source.rb +20 -0
  284. data/lib/arel/nodes/matches.rb +18 -0
  285. data/lib/arel/nodes/named_function.rb +23 -0
  286. data/lib/arel/nodes/node.rb +50 -0
  287. data/lib/arel/nodes/node_expression.rb +13 -0
  288. data/lib/arel/nodes/outer_join.rb +8 -0
  289. data/lib/arel/nodes/over.rb +15 -0
  290. data/lib/arel/nodes/regexp.rb +16 -0
  291. data/lib/arel/nodes/right_outer_join.rb +8 -0
  292. data/lib/arel/nodes/select_core.rb +67 -0
  293. data/lib/arel/nodes/select_statement.rb +41 -0
  294. data/lib/arel/nodes/sql_literal.rb +16 -0
  295. data/lib/arel/nodes/string_join.rb +11 -0
  296. data/lib/arel/nodes/table_alias.rb +27 -0
  297. data/lib/arel/nodes/terminal.rb +16 -0
  298. data/lib/arel/nodes/true.rb +16 -0
  299. data/lib/arel/nodes/unary.rb +45 -0
  300. data/lib/arel/nodes/unary_operation.rb +20 -0
  301. data/lib/arel/nodes/unqualified_column.rb +22 -0
  302. data/lib/arel/nodes/update_statement.rb +41 -0
  303. data/lib/arel/nodes/values_list.rb +9 -0
  304. data/lib/arel/nodes/window.rb +126 -0
  305. data/lib/arel/nodes/with.rb +11 -0
  306. data/lib/arel/nodes.rb +68 -0
  307. data/lib/arel/order_predications.rb +13 -0
  308. data/lib/arel/predications.rb +257 -0
  309. data/lib/arel/select_manager.rb +271 -0
  310. data/lib/arel/table.rb +110 -0
  311. data/lib/arel/tree_manager.rb +72 -0
  312. data/lib/arel/update_manager.rb +34 -0
  313. data/lib/arel/visitors/depth_first.rb +204 -0
  314. data/lib/arel/visitors/dot.rb +297 -0
  315. data/lib/arel/visitors/ibm_db.rb +34 -0
  316. data/lib/arel/visitors/informix.rb +62 -0
  317. data/lib/arel/visitors/mssql.rb +157 -0
  318. data/lib/arel/visitors/mysql.rb +83 -0
  319. data/lib/arel/visitors/oracle.rb +159 -0
  320. data/lib/arel/visitors/oracle12.rb +66 -0
  321. data/lib/arel/visitors/postgresql.rb +110 -0
  322. data/lib/arel/visitors/sqlite.rb +39 -0
  323. data/lib/arel/visitors/to_sql.rb +889 -0
  324. data/lib/arel/visitors/visitor.rb +46 -0
  325. data/lib/arel/visitors/where_sql.rb +23 -0
  326. data/lib/arel/visitors.rb +20 -0
  327. data/lib/arel/window_predications.rb +9 -0
  328. data/lib/arel.rb +58 -0
  329. data/lib/rails/generators/active_record/application_record/application_record_generator.rb +27 -0
  330. data/lib/rails/generators/active_record/{model/templates/application_record.rb → application_record/templates/application_record.rb.tt} +0 -0
  331. data/lib/rails/generators/active_record/migration/migration_generator.rb +37 -35
  332. data/lib/rails/generators/active_record/migration/templates/{create_table_migration.rb → create_table_migration.rb.tt} +1 -1
  333. data/lib/rails/generators/active_record/migration/templates/{migration.rb → migration.rb.tt} +4 -2
  334. data/lib/rails/generators/active_record/migration.rb +17 -2
  335. data/lib/rails/generators/active_record/model/model_generator.rb +9 -29
  336. data/lib/rails/generators/active_record/model/templates/{model.rb → model.rb.tt} +10 -1
  337. data/lib/rails/generators/active_record/model/templates/{module.rb → module.rb.tt} +0 -0
  338. data/lib/rails/generators/active_record.rb +7 -5
  339. metadata +133 -50
  340. data/lib/active_record/associations/preloader/belongs_to.rb +0 -17
  341. data/lib/active_record/associations/preloader/collection_association.rb +0 -17
  342. data/lib/active_record/associations/preloader/has_many.rb +0 -17
  343. data/lib/active_record/associations/preloader/has_many_through.rb +0 -19
  344. data/lib/active_record/associations/preloader/has_one.rb +0 -15
  345. data/lib/active_record/associations/preloader/has_one_through.rb +0 -9
  346. data/lib/active_record/associations/preloader/singular_association.rb +0 -20
  347. data/lib/active_record/attribute/user_provided_default.rb +0 -28
  348. data/lib/active_record/attribute.rb +0 -213
  349. data/lib/active_record/attribute_mutation_tracker.rb +0 -70
  350. data/lib/active_record/attribute_set/builder.rb +0 -130
  351. data/lib/active_record/attribute_set.rb +0 -110
  352. data/lib/active_record/collection_cache_key.rb +0 -50
  353. data/lib/active_record/connection_adapters/postgresql/oid/rails_5_1_point.rb +0 -50
  354. data/lib/active_record/railties/jdbcmysql_error.rb +0 -16
  355. data/lib/active_record/relation/predicate_builder/association_query_handler.rb +0 -88
  356. data/lib/active_record/relation/predicate_builder/class_handler.rb +0 -27
  357. data/lib/active_record/relation/predicate_builder/polymorphic_array_handler.rb +0 -57
  358. data/lib/active_record/type/internal/abstract_json.rb +0 -33
@@ -1,7 +1,9 @@
1
- require 'active_support/core_ext/enumerable'
2
- require 'active_support/core_ext/string/conversions'
3
- require 'active_support/core_ext/module/remove_method'
4
- require 'active_record/errors'
1
+ # frozen_string_literal: true
2
+
3
+ require "active_support/core_ext/enumerable"
4
+ require "active_support/core_ext/string/conversions"
5
+ require "active_support/core_ext/module/remove_method"
6
+ require "active_record/errors"
5
7
 
6
8
  module ActiveRecord
7
9
  class AssociationNotFoundError < ConfigurationError #:nodoc:
@@ -90,13 +92,23 @@ module ActiveRecord
90
92
  through_reflection = reflection.through_reflection
91
93
  source_reflection_names = reflection.source_reflection_names
92
94
  source_associations = reflection.through_reflection.klass._reflections.keys
93
- 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)}?")
95
+ super("Could not find the source association(s) #{source_reflection_names.collect(&:inspect).to_sentence(two_words_connector: ' or ', last_word_connector: ', or ')} 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 ')}?")
94
96
  else
95
97
  super("Could not find the source association(s).")
96
98
  end
97
99
  end
98
100
  end
99
101
 
102
+ class HasManyThroughOrderError < ActiveRecordError #:nodoc:
103
+ def initialize(owner_class_name = nil, reflection = nil, through_reflection = nil)
104
+ if owner_class_name && reflection && through_reflection
105
+ super("Cannot have a has_many :through association '#{owner_class_name}##{reflection.name}' which goes through '#{owner_class_name}##{through_reflection.name}' before the through association is defined.")
106
+ else
107
+ super("Cannot have a has_many :through association before the through association is defined.")
108
+ end
109
+ end
110
+ end
111
+
100
112
  class ThroughCantAssociateThroughHasOneOrManyReflection < ActiveRecordError #:nodoc:
101
113
  def initialize(owner = nil, reflection = nil)
102
114
  if owner && reflection
@@ -107,30 +119,25 @@ module ActiveRecord
107
119
  end
108
120
  end
109
121
 
110
- class HasManyThroughCantAssociateThroughHasOneOrManyReflection < ThroughCantAssociateThroughHasOneOrManyReflection #:nodoc:
111
- end
122
+ class AmbiguousSourceReflectionForThroughAssociation < ActiveRecordError # :nodoc:
123
+ def initialize(klass, macro, association_name, options, possible_sources)
124
+ example_options = options.dup
125
+ example_options[:source] = possible_sources.first
112
126
 
113
- class HasOneThroughCantAssociateThroughHasOneOrManyReflection < ThroughCantAssociateThroughHasOneOrManyReflection #:nodoc:
127
+ super("Ambiguous source reflection for through association. Please " \
128
+ "specify a :source directive on your declaration like:\n" \
129
+ "\n" \
130
+ " class #{klass} < ActiveRecord::Base\n" \
131
+ " #{macro} :#{association_name}, #{example_options}\n" \
132
+ " end"
133
+ )
134
+ end
114
135
  end
115
136
 
116
- class HasManyThroughCantAssociateNewRecords < ActiveRecordError #:nodoc:
117
- def initialize(owner = nil, reflection = nil)
118
- if owner && reflection
119
- 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.")
120
- else
121
- super("Cannot associate new records.")
122
- end
123
- end
137
+ class HasManyThroughCantAssociateThroughHasOneOrManyReflection < ThroughCantAssociateThroughHasOneOrManyReflection #:nodoc:
124
138
  end
125
139
 
126
- class HasManyThroughCantDissociateNewRecords < ActiveRecordError #:nodoc:
127
- def initialize(owner = nil, reflection = nil)
128
- if owner && reflection
129
- 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.")
130
- else
131
- super("Cannot dissociate new records.")
132
- end
133
- end
140
+ class HasOneThroughCantAssociateThroughHasOneOrManyReflection < ThroughCantAssociateThroughHasOneOrManyReflection #:nodoc:
134
141
  end
135
142
 
136
143
  class ThroughNestedAssociationsAreReadonly < ActiveRecordError #:nodoc:
@@ -162,16 +169,6 @@ module ActiveRecord
162
169
  end
163
170
  end
164
171
 
165
- class ReadOnlyAssociation < ActiveRecordError #:nodoc:
166
- def initialize(reflection = nil)
167
- if reflection
168
- super("Cannot add to a has_many :through association. Try adding to #{reflection.through_reflection.name.inspect}.")
169
- else
170
- super("Read-only reflection error.")
171
- end
172
- end
173
- end
174
-
175
172
  # This error is raised when trying to destroy a parent instance in N:1 or 1:1 associations
176
173
  # (has_many, has_one) when there is at least 1 child associated instance.
177
174
  # ex: if @project.tasks.size > 0, DeleteRestrictionError will be raised when trying to destroy @project
@@ -200,14 +197,14 @@ module ActiveRecord
200
197
  autoload :ThroughAssociation
201
198
 
202
199
  module Builder #:nodoc:
203
- autoload :Association, 'active_record/associations/builder/association'
204
- autoload :SingularAssociation, 'active_record/associations/builder/singular_association'
205
- autoload :CollectionAssociation, 'active_record/associations/builder/collection_association'
200
+ autoload :Association, "active_record/associations/builder/association"
201
+ autoload :SingularAssociation, "active_record/associations/builder/singular_association"
202
+ autoload :CollectionAssociation, "active_record/associations/builder/collection_association"
206
203
 
207
- autoload :BelongsTo, 'active_record/associations/builder/belongs_to'
208
- autoload :HasOne, 'active_record/associations/builder/has_one'
209
- autoload :HasMany, 'active_record/associations/builder/has_many'
210
- autoload :HasAndBelongsToMany, 'active_record/associations/builder/has_and_belongs_to_many'
204
+ autoload :BelongsTo, "active_record/associations/builder/belongs_to"
205
+ autoload :HasOne, "active_record/associations/builder/has_one"
206
+ autoload :HasMany, "active_record/associations/builder/has_many"
207
+ autoload :HasAndBelongsToMany, "active_record/associations/builder/has_and_belongs_to_many"
211
208
  end
212
209
 
213
210
  eager_autoload do
@@ -244,7 +241,7 @@ module ActiveRecord
244
241
  association
245
242
  end
246
243
 
247
- def association_cached?(name) # :nodoc
244
+ def association_cached?(name) # :nodoc:
248
245
  @association_cache.key?(name)
249
246
  end
250
247
 
@@ -260,16 +257,16 @@ module ActiveRecord
260
257
 
261
258
  private
262
259
  # Clears out the association cache.
263
- def clear_association_cache # :nodoc:
260
+ def clear_association_cache
264
261
  @association_cache.clear if persisted?
265
262
  end
266
263
 
267
- def init_internals # :nodoc:
264
+ def init_internals
268
265
  @association_cache = {}
269
266
  super
270
267
  end
271
268
 
272
- # Returns the specified association instance if it exists, nil otherwise.
269
+ # Returns the specified association instance if it exists, +nil+ otherwise.
273
270
  def association_instance_get(name)
274
271
  @association_cache[name]
275
272
  end
@@ -279,1576 +276,1590 @@ module ActiveRecord
279
276
  @association_cache[name] = association
280
277
  end
281
278
 
282
- # \Associations are a set of macro-like class methods for tying objects together through
283
- # foreign keys. They express relationships like "Project has one Project Manager"
284
- # or "Project belongs to a Portfolio". Each macro adds a number of methods to the
285
- # class which are specialized according to the collection or association symbol and the
286
- # options hash. It works much the same way as Ruby's own <tt>attr*</tt>
287
- # methods.
288
- #
289
- # class Project < ActiveRecord::Base
290
- # belongs_to :portfolio
291
- # has_one :project_manager
292
- # has_many :milestones
293
- # has_and_belongs_to_many :categories
294
- # end
295
- #
296
- # The project class now has the following methods (and more) to ease the traversal and
297
- # manipulation of its relationships:
298
- # * <tt>Project#portfolio, Project#portfolio=(portfolio), Project#portfolio.nil?</tt>
299
- # * <tt>Project#project_manager, Project#project_manager=(project_manager), Project#project_manager.nil?,</tt>
300
- # * <tt>Project#milestones.empty?, Project#milestones.size, Project#milestones, Project#milestones<<(milestone),</tt>
301
- # <tt>Project#milestones.delete(milestone), Project#milestones.destroy(milestone), Project#milestones.find(milestone_id),</tt>
302
- # <tt>Project#milestones.build, Project#milestones.create</tt>
303
- # * <tt>Project#categories.empty?, Project#categories.size, Project#categories, Project#categories<<(category1),</tt>
304
- # <tt>Project#categories.delete(category1), Project#categories.destroy(category1)</tt>
305
- #
306
- # === A word of warning
307
- #
308
- # Don't create associations that have the same name as instance methods of
309
- # ActiveRecord::Base. Since the association adds a method with that name to
310
- # its model, it will override the inherited method and break things.
311
- # For instance, +attributes+ and +connection+ would be bad choices for association names.
312
- #
313
- # == Auto-generated methods
314
- # See also Instance Public methods below for more details.
315
- #
316
- # === Singular associations (one-to-one)
317
- # | | belongs_to |
318
- # generated methods | belongs_to | :polymorphic | has_one
319
- # ----------------------------------+------------+--------------+---------
320
- # other | X | X | X
321
- # other=(other) | X | X | X
322
- # build_other(attributes={}) | X | | X
323
- # create_other(attributes={}) | X | | X
324
- # create_other!(attributes={}) | X | | X
325
- # reload_other | X | X | X
326
- #
327
- # === Collection associations (one-to-many / many-to-many)
328
- # | | | has_many
329
- # generated methods | habtm | has_many | :through
330
- # ----------------------------------+-------+----------+----------
331
- # others | X | X | X
332
- # others=(other,other,...) | X | X | X
333
- # other_ids | X | X | X
334
- # other_ids=(id,id,...) | X | X | X
335
- # others<< | X | X | X
336
- # others.push | X | X | X
337
- # others.concat | X | X | X
338
- # others.build(attributes={}) | X | X | X
339
- # others.create(attributes={}) | X | X | X
340
- # others.create!(attributes={}) | X | X | X
341
- # others.size | X | X | X
342
- # others.length | X | X | X
343
- # others.count | X | X | X
344
- # others.sum(*args) | X | X | X
345
- # others.empty? | X | X | X
346
- # others.clear | X | X | X
347
- # others.delete(other,other,...) | X | X | X
348
- # others.delete_all | X | X | X
349
- # others.destroy(other,other,...) | X | X | X
350
- # others.destroy_all | X | X | X
351
- # others.find(*args) | X | X | X
352
- # others.exists? | X | X | X
353
- # others.distinct | X | X | X
354
- # others.reset | X | X | X
355
- # others.reload | X | X | X
356
- #
357
- # === Overriding generated methods
358
- #
359
- # Association methods are generated in a module that is included into the model class,
360
- # which allows you to easily override with your own methods and call the original
361
- # generated method with +super+. For example:
362
- #
363
- # class Car < ActiveRecord::Base
364
- # belongs_to :owner
365
- # belongs_to :old_owner
366
- # def owner=(new_owner)
367
- # self.old_owner = self.owner
368
- # super
369
- # end
370
- # end
371
- #
372
- # If your model class is <tt>Project</tt>, the module is
373
- # named <tt>Project::GeneratedAssociationMethods</tt>. The +GeneratedAssociationMethods+ module is
374
- # included in the model class immediately after the (anonymous) generated attributes methods
375
- # module, meaning an association will override the methods for an attribute with the same name.
376
- #
377
- # == Cardinality and associations
378
- #
379
- # Active Record associations can be used to describe one-to-one, one-to-many and many-to-many
380
- # relationships between models. Each model uses an association to describe its role in
381
- # the relation. The #belongs_to association is always used in the model that has
382
- # the foreign key.
383
- #
384
- # === One-to-one
385
- #
386
- # Use #has_one in the base, and #belongs_to in the associated model.
387
- #
388
- # class Employee < ActiveRecord::Base
389
- # has_one :office
390
- # end
391
- # class Office < ActiveRecord::Base
392
- # belongs_to :employee # foreign key - employee_id
393
- # end
394
- #
395
- # === One-to-many
396
- #
397
- # Use #has_many in the base, and #belongs_to in the associated model.
398
- #
399
- # class Manager < ActiveRecord::Base
400
- # has_many :employees
401
- # end
402
- # class Employee < ActiveRecord::Base
403
- # belongs_to :manager # foreign key - manager_id
404
- # end
405
- #
406
- # === Many-to-many
407
- #
408
- # There are two ways to build a many-to-many relationship.
409
- #
410
- # The first way uses a #has_many association with the <tt>:through</tt> option and a join model, so
411
- # there are two stages of associations.
412
- #
413
- # class Assignment < ActiveRecord::Base
414
- # belongs_to :programmer # foreign key - programmer_id
415
- # belongs_to :project # foreign key - project_id
416
- # end
417
- # class Programmer < ActiveRecord::Base
418
- # has_many :assignments
419
- # has_many :projects, through: :assignments
420
- # end
421
- # class Project < ActiveRecord::Base
422
- # has_many :assignments
423
- # has_many :programmers, through: :assignments
424
- # end
425
- #
426
- # For the second way, use #has_and_belongs_to_many in both models. This requires a join table
427
- # that has no corresponding model or primary key.
428
- #
429
- # class Programmer < ActiveRecord::Base
430
- # has_and_belongs_to_many :projects # foreign keys in the join table
431
- # end
432
- # class Project < ActiveRecord::Base
433
- # has_and_belongs_to_many :programmers # foreign keys in the join table
434
- # end
435
- #
436
- # Choosing which way to build a many-to-many relationship is not always simple.
437
- # If you need to work with the relationship model as its own entity,
438
- # use #has_many <tt>:through</tt>. Use #has_and_belongs_to_many when working with legacy schemas or when
439
- # you never work directly with the relationship itself.
440
- #
441
- # == Is it a #belongs_to or #has_one association?
442
- #
443
- # Both express a 1-1 relationship. The difference is mostly where to place the foreign
444
- # key, which goes on the table for the class declaring the #belongs_to relationship.
445
- #
446
- # class User < ActiveRecord::Base
447
- # # I reference an account.
448
- # belongs_to :account
449
- # end
450
- #
451
- # class Account < ActiveRecord::Base
452
- # # One user references me.
453
- # has_one :user
454
- # end
455
- #
456
- # The tables for these classes could look something like:
457
- #
458
- # CREATE TABLE users (
459
- # id int NOT NULL auto_increment,
460
- # account_id int default NULL,
461
- # name varchar default NULL,
462
- # PRIMARY KEY (id)
463
- # )
464
- #
465
- # CREATE TABLE accounts (
466
- # id int NOT NULL auto_increment,
467
- # name varchar default NULL,
468
- # PRIMARY KEY (id)
469
- # )
470
- #
471
- # == Unsaved objects and associations
472
- #
473
- # You can manipulate objects and associations before they are saved to the database, but
474
- # there is some special behavior you should be aware of, mostly involving the saving of
475
- # associated objects.
476
- #
477
- # You can set the <tt>:autosave</tt> option on a #has_one, #belongs_to,
478
- # #has_many, or #has_and_belongs_to_many association. Setting it
479
- # to +true+ will _always_ save the members, whereas setting it to +false+ will
480
- # _never_ save the members. More details about <tt>:autosave</tt> option is available at
481
- # AutosaveAssociation.
482
- #
483
- # === One-to-one associations
484
- #
485
- # * Assigning an object to a #has_one association automatically saves that object and
486
- # the object being replaced (if there is one), in order to update their foreign
487
- # keys - except if the parent object is unsaved (<tt>new_record? == true</tt>).
488
- # * If either of these saves fail (due to one of the objects being invalid), an
489
- # ActiveRecord::RecordNotSaved exception is raised and the assignment is
490
- # cancelled.
491
- # * If you wish to assign an object to a #has_one association without saving it,
492
- # use the <tt>#build_association</tt> method (documented below). The object being
493
- # replaced will still be saved to update its foreign key.
494
- # * Assigning an object to a #belongs_to association does not save the object, since
495
- # the foreign key field belongs on the parent. It does not save the parent either.
496
- #
497
- # === Collections
498
- #
499
- # * Adding an object to a collection (#has_many or #has_and_belongs_to_many) automatically
500
- # saves that object, except if the parent object (the owner of the collection) is not yet
501
- # stored in the database.
502
- # * If saving any of the objects being added to a collection (via <tt>push</tt> or similar)
503
- # fails, then <tt>push</tt> returns +false+.
504
- # * If saving fails while replacing the collection (via <tt>association=</tt>), an
505
- # ActiveRecord::RecordNotSaved exception is raised and the assignment is
506
- # cancelled.
507
- # * You can add an object to a collection without automatically saving it by using the
508
- # <tt>collection.build</tt> method (documented below).
509
- # * All unsaved (<tt>new_record? == true</tt>) members of the collection are automatically
510
- # saved when the parent is saved.
511
- #
512
- # == Customizing the query
513
- #
514
- # \Associations are built from <tt>Relation</tt> objects, and you can use the Relation syntax
515
- # to customize them. For example, to add a condition:
516
- #
517
- # class Blog < ActiveRecord::Base
518
- # has_many :published_posts, -> { where(published: true) }, class_name: 'Post'
519
- # end
520
- #
521
- # Inside the <tt>-> { ... }</tt> block you can use all of the usual Relation methods.
522
- #
523
- # === Accessing the owner object
524
- #
525
- # Sometimes it is useful to have access to the owner object when building the query. The owner
526
- # is passed as a parameter to the block. For example, the following association would find all
527
- # events that occur on the user's birthday:
528
- #
529
- # class User < ActiveRecord::Base
530
- # has_many :birthday_events, ->(user) { where(starts_on: user.birthday) }, class_name: 'Event'
531
- # end
532
- #
533
- # Note: Joining, eager loading and preloading of these associations is not fully possible.
534
- # These operations happen before instance creation and the scope will be called with a +nil+ argument.
535
- # This can lead to unexpected behavior and is deprecated.
536
- #
537
- # == Association callbacks
538
- #
539
- # Similar to the normal callbacks that hook into the life cycle of an Active Record object,
540
- # you can also define callbacks that get triggered when you add an object to or remove an
541
- # object from an association collection.
542
- #
543
- # class Project
544
- # has_and_belongs_to_many :developers, after_add: :evaluate_velocity
545
- #
546
- # def evaluate_velocity(developer)
547
- # ...
548
- # end
549
- # end
550
- #
551
- # It's possible to stack callbacks by passing them as an array. Example:
552
- #
553
- # class Project
554
- # has_and_belongs_to_many :developers,
555
- # after_add: [:evaluate_velocity, Proc.new { |p, d| p.shipping_date = Time.now}]
556
- # end
557
- #
558
- # Possible callbacks are: +before_add+, +after_add+, +before_remove+ and +after_remove+.
559
- #
560
- # If any of the +before_add+ callbacks throw an exception, the object will not be
561
- # added to the collection.
562
- #
563
- # Similarly, if any of the +before_remove+ callbacks throw an exception, the object
564
- # will not be removed from the collection.
565
- #
566
- # == Association extensions
567
- #
568
- # The proxy objects that control the access to associations can be extended through anonymous
569
- # modules. This is especially beneficial for adding new finders, creators, and other
570
- # factory-type methods that are only used as part of this association.
571
- #
572
- # class Account < ActiveRecord::Base
573
- # has_many :people do
574
- # def find_or_create_by_name(name)
575
- # first_name, last_name = name.split(" ", 2)
576
- # find_or_create_by(first_name: first_name, last_name: last_name)
577
- # end
578
- # end
579
- # end
580
- #
581
- # person = Account.first.people.find_or_create_by_name("David Heinemeier Hansson")
582
- # person.first_name # => "David"
583
- # person.last_name # => "Heinemeier Hansson"
584
- #
585
- # If you need to share the same extensions between many associations, you can use a named
586
- # extension module.
587
- #
588
- # module FindOrCreateByNameExtension
589
- # def find_or_create_by_name(name)
590
- # first_name, last_name = name.split(" ", 2)
591
- # find_or_create_by(first_name: first_name, last_name: last_name)
592
- # end
593
- # end
594
- #
595
- # class Account < ActiveRecord::Base
596
- # has_many :people, -> { extending FindOrCreateByNameExtension }
597
- # end
598
- #
599
- # class Company < ActiveRecord::Base
600
- # has_many :people, -> { extending FindOrCreateByNameExtension }
601
- # end
602
- #
603
- # Some extensions can only be made to work with knowledge of the association's internals.
604
- # Extensions can access relevant state using the following methods (where +items+ is the
605
- # name of the association):
606
- #
607
- # * <tt>record.association(:items).owner</tt> - Returns the object the association is part of.
608
- # * <tt>record.association(:items).reflection</tt> - Returns the reflection object that describes the association.
609
- # * <tt>record.association(:items).target</tt> - Returns the associated object for #belongs_to and #has_one, or
610
- # the collection of associated objects for #has_many and #has_and_belongs_to_many.
611
- #
612
- # However, inside the actual extension code, you will not have access to the <tt>record</tt> as
613
- # above. In this case, you can access <tt>proxy_association</tt>. For example,
614
- # <tt>record.association(:items)</tt> and <tt>record.items.proxy_association</tt> will return
615
- # the same object, allowing you to make calls like <tt>proxy_association.owner</tt> inside
616
- # association extensions.
617
- #
618
- # == Association Join Models
619
- #
620
- # Has Many associations can be configured with the <tt>:through</tt> option to use an
621
- # explicit join model to retrieve the data. This operates similarly to a
622
- # #has_and_belongs_to_many association. The advantage is that you're able to add validations,
623
- # callbacks, and extra attributes on the join model. Consider the following schema:
624
- #
625
- # class Author < ActiveRecord::Base
626
- # has_many :authorships
627
- # has_many :books, through: :authorships
628
- # end
629
- #
630
- # class Authorship < ActiveRecord::Base
631
- # belongs_to :author
632
- # belongs_to :book
633
- # end
634
- #
635
- # @author = Author.first
636
- # @author.authorships.collect { |a| a.book } # selects all books that the author's authorships belong to
637
- # @author.books # selects all books by using the Authorship join model
638
- #
639
- # You can also go through a #has_many association on the join model:
640
- #
641
- # class Firm < ActiveRecord::Base
642
- # has_many :clients
643
- # has_many :invoices, through: :clients
644
- # end
645
- #
646
- # class Client < ActiveRecord::Base
647
- # belongs_to :firm
648
- # has_many :invoices
649
- # end
650
- #
651
- # class Invoice < ActiveRecord::Base
652
- # belongs_to :client
653
- # end
654
- #
655
- # @firm = Firm.first
656
- # @firm.clients.flat_map { |c| c.invoices } # select all invoices for all clients of the firm
657
- # @firm.invoices # selects all invoices by going through the Client join model
658
- #
659
- # Similarly you can go through a #has_one association on the join model:
660
- #
661
- # class Group < ActiveRecord::Base
662
- # has_many :users
663
- # has_many :avatars, through: :users
664
- # end
665
- #
666
- # class User < ActiveRecord::Base
667
- # belongs_to :group
668
- # has_one :avatar
669
- # end
670
- #
671
- # class Avatar < ActiveRecord::Base
672
- # belongs_to :user
673
- # end
674
- #
675
- # @group = Group.first
676
- # @group.users.collect { |u| u.avatar }.compact # select all avatars for all users in the group
677
- # @group.avatars # selects all avatars by going through the User join model.
678
- #
679
- # An important caveat with going through #has_one or #has_many associations on the
680
- # join model is that these associations are *read-only*. For example, the following
681
- # would not work following the previous example:
682
- #
683
- # @group.avatars << Avatar.new # this would work if User belonged_to Avatar rather than the other way around
684
- # @group.avatars.delete(@group.avatars.last) # so would this
685
- #
686
- # == Setting Inverses
687
- #
688
- # If you are using a #belongs_to on the join model, it is a good idea to set the
689
- # <tt>:inverse_of</tt> option on the #belongs_to, which will mean that the following example
690
- # works correctly (where <tt>tags</tt> is a #has_many <tt>:through</tt> association):
691
- #
692
- # @post = Post.first
693
- # @tag = @post.tags.build name: "ruby"
694
- # @tag.save
695
- #
696
- # The last line ought to save the through record (a <tt>Tagging</tt>). This will only work if the
697
- # <tt>:inverse_of</tt> is set:
698
- #
699
- # class Tagging < ActiveRecord::Base
700
- # belongs_to :post
701
- # belongs_to :tag, inverse_of: :taggings
702
- # end
703
- #
704
- # If you do not set the <tt>:inverse_of</tt> record, the association will
705
- # do its best to match itself up with the correct inverse. Automatic
706
- # inverse detection only works on #has_many, #has_one, and
707
- # #belongs_to associations.
708
- #
709
- # Extra options on the associations, as defined in the
710
- # <tt>AssociationReflection::INVALID_AUTOMATIC_INVERSE_OPTIONS</tt> constant, will
711
- # also prevent the association's inverse from being found automatically.
712
- #
713
- # The automatic guessing of the inverse association uses a heuristic based
714
- # on the name of the class, so it may not work for all associations,
715
- # especially the ones with non-standard names.
716
- #
717
- # You can turn off the automatic detection of inverse associations by setting
718
- # the <tt>:inverse_of</tt> option to <tt>false</tt> like so:
719
- #
720
- # class Tagging < ActiveRecord::Base
721
- # belongs_to :tag, inverse_of: false
722
- # end
723
- #
724
- # == Nested \Associations
725
- #
726
- # You can actually specify *any* association with the <tt>:through</tt> option, including an
727
- # association which has a <tt>:through</tt> option itself. For example:
728
- #
729
- # class Author < ActiveRecord::Base
730
- # has_many :posts
731
- # has_many :comments, through: :posts
732
- # has_many :commenters, through: :comments
733
- # end
734
- #
735
- # class Post < ActiveRecord::Base
736
- # has_many :comments
737
- # end
738
- #
739
- # class Comment < ActiveRecord::Base
740
- # belongs_to :commenter
741
- # end
742
- #
743
- # @author = Author.first
744
- # @author.commenters # => People who commented on posts written by the author
745
- #
746
- # An equivalent way of setting up this association this would be:
747
- #
748
- # class Author < ActiveRecord::Base
749
- # has_many :posts
750
- # has_many :commenters, through: :posts
751
- # end
752
- #
753
- # class Post < ActiveRecord::Base
754
- # has_many :comments
755
- # has_many :commenters, through: :comments
756
- # end
757
- #
758
- # class Comment < ActiveRecord::Base
759
- # belongs_to :commenter
760
- # end
761
- #
762
- # When using a nested association, you will not be able to modify the association because there
763
- # is not enough information to know what modification to make. For example, if you tried to
764
- # add a <tt>Commenter</tt> in the example above, there would be no way to tell how to set up the
765
- # intermediate <tt>Post</tt> and <tt>Comment</tt> objects.
766
- #
767
- # == Polymorphic \Associations
768
- #
769
- # Polymorphic associations on models are not restricted on what types of models they
770
- # can be associated with. Rather, they specify an interface that a #has_many association
771
- # must adhere to.
772
- #
773
- # class Asset < ActiveRecord::Base
774
- # belongs_to :attachable, polymorphic: true
775
- # end
776
- #
777
- # class Post < ActiveRecord::Base
778
- # has_many :assets, as: :attachable # The :as option specifies the polymorphic interface to use.
779
- # end
780
- #
781
- # @asset.attachable = @post
782
- #
783
- # This works by using a type column in addition to a foreign key to specify the associated
784
- # record. In the Asset example, you'd need an +attachable_id+ integer column and an
785
- # +attachable_type+ string column.
786
- #
787
- # Using polymorphic associations in combination with single table inheritance (STI) is
788
- # a little tricky. In order for the associations to work as expected, ensure that you
789
- # store the base model for the STI models in the type column of the polymorphic
790
- # association. To continue with the asset example above, suppose there are guest posts
791
- # and member posts that use the posts table for STI. In this case, there must be a +type+
792
- # column in the posts table.
793
- #
794
- # Note: The <tt>attachable_type=</tt> method is being called when assigning an +attachable+.
795
- # The +class_name+ of the +attachable+ is passed as a String.
796
- #
797
- # class Asset < ActiveRecord::Base
798
- # belongs_to :attachable, polymorphic: true
799
- #
800
- # def attachable_type=(class_name)
801
- # super(class_name.constantize.base_class.to_s)
802
- # end
803
- # end
804
- #
805
- # class Post < ActiveRecord::Base
806
- # # because we store "Post" in attachable_type now dependent: :destroy will work
807
- # has_many :assets, as: :attachable, dependent: :destroy
808
- # end
809
- #
810
- # class GuestPost < Post
811
- # end
812
- #
813
- # class MemberPost < Post
814
- # end
815
- #
816
- # == Caching
817
- #
818
- # All of the methods are built on a simple caching principle that will keep the result
819
- # of the last query around unless specifically instructed not to. The cache is even
820
- # shared across methods to make it even cheaper to use the macro-added methods without
821
- # worrying too much about performance at the first go.
822
- #
823
- # project.milestones # fetches milestones from the database
824
- # project.milestones.size # uses the milestone cache
825
- # project.milestones.empty? # uses the milestone cache
826
- # project.milestones(true).size # fetches milestones from the database
827
- # project.milestones # uses the milestone cache
828
- #
829
- # == Eager loading of associations
830
- #
831
- # Eager loading is a way to find objects of a certain class and a number of named associations.
832
- # It is one of the easiest ways to prevent the dreaded N+1 problem in which fetching 100
833
- # posts that each need to display their author triggers 101 database queries. Through the
834
- # use of eager loading, the number of queries will be reduced from 101 to 2.
835
- #
836
- # class Post < ActiveRecord::Base
837
- # belongs_to :author
838
- # has_many :comments
839
- # end
840
- #
841
- # Consider the following loop using the class above:
842
- #
843
- # Post.all.each do |post|
844
- # puts "Post: " + post.title
845
- # puts "Written by: " + post.author.name
846
- # puts "Last comment on: " + post.comments.first.created_on
847
- # end
848
- #
849
- # To iterate over these one hundred posts, we'll generate 201 database queries. Let's
850
- # first just optimize it for retrieving the author:
851
- #
852
- # Post.includes(:author).each do |post|
853
- #
854
- # This references the name of the #belongs_to association that also used the <tt>:author</tt>
855
- # symbol. After loading the posts, find will collect the +author_id+ from each one and load
856
- # all the referenced authors with one query. Doing so will cut down the number of queries
857
- # from 201 to 102.
858
- #
859
- # We can improve upon the situation further by referencing both associations in the finder with:
860
- #
861
- # Post.includes(:author, :comments).each do |post|
862
- #
863
- # This will load all comments with a single query. This reduces the total number of queries
864
- # to 3. In general, the number of queries will be 1 plus the number of associations
865
- # named (except if some of the associations are polymorphic #belongs_to - see below).
866
- #
867
- # To include a deep hierarchy of associations, use a hash:
868
- #
869
- # Post.includes(:author, { comments: { author: :gravatar } }).each do |post|
870
- #
871
- # The above code will load all the comments and all of their associated
872
- # authors and gravatars. You can mix and match any combination of symbols,
873
- # arrays, and hashes to retrieve the associations you want to load.
874
- #
875
- # All of this power shouldn't fool you into thinking that you can pull out huge amounts
876
- # of data with no performance penalty just because you've reduced the number of queries.
877
- # The database still needs to send all the data to Active Record and it still needs to
878
- # be processed. So it's no catch-all for performance problems, but it's a great way to
879
- # cut down on the number of queries in a situation as the one described above.
880
- #
881
- # Since only one table is loaded at a time, conditions or orders cannot reference tables
882
- # other than the main one. If this is the case, Active Record falls back to the previously
883
- # used LEFT OUTER JOIN based strategy. For example:
884
- #
885
- # Post.includes([:author, :comments]).where(['comments.approved = ?', true])
886
- #
887
- # This will result in a single SQL query with joins along the lines of:
888
- # <tt>LEFT OUTER JOIN comments ON comments.post_id = posts.id</tt> and
889
- # <tt>LEFT OUTER JOIN authors ON authors.id = posts.author_id</tt>. Note that using conditions
890
- # like this can have unintended consequences.
891
- # In the above example posts with no approved comments are not returned at all, because
892
- # the conditions apply to the SQL statement as a whole and not just to the association.
893
- #
894
- # You must disambiguate column references for this fallback to happen, for example
895
- # <tt>order: "author.name DESC"</tt> will work but <tt>order: "name DESC"</tt> will not.
896
- #
897
- # If you want to load all posts (including posts with no approved comments) then write
898
- # your own LEFT OUTER JOIN query using ON
899
- #
900
- # Post.joins("LEFT OUTER JOIN comments ON comments.post_id = posts.id AND comments.approved = '1'")
901
- #
902
- # In this case it is usually more natural to include an association which has conditions defined on it:
903
- #
904
- # class Post < ActiveRecord::Base
905
- # has_many :approved_comments, -> { where(approved: true) }, class_name: 'Comment'
906
- # end
907
- #
908
- # Post.includes(:approved_comments)
909
- #
910
- # This will load posts and eager load the +approved_comments+ association, which contains
911
- # only those comments that have been approved.
912
- #
913
- # If you eager load an association with a specified <tt>:limit</tt> option, it will be ignored,
914
- # returning all the associated objects:
915
- #
916
- # class Picture < ActiveRecord::Base
917
- # has_many :most_recent_comments, -> { order('id DESC').limit(10) }, class_name: 'Comment'
918
- # end
919
- #
920
- # Picture.includes(:most_recent_comments).first.most_recent_comments # => returns all associated comments.
921
- #
922
- # Eager loading is supported with polymorphic associations.
923
- #
924
- # class Address < ActiveRecord::Base
925
- # belongs_to :addressable, polymorphic: true
926
- # end
927
- #
928
- # A call that tries to eager load the addressable model
929
- #
930
- # Address.includes(:addressable)
931
- #
932
- # This will execute one query to load the addresses and load the addressables with one
933
- # query per addressable type.
934
- # For example if all the addressables are either of class Person or Company then a total
935
- # of 3 queries will be executed. The list of addressable types to load is determined on
936
- # the back of the addresses loaded. This is not supported if Active Record has to fallback
937
- # to the previous implementation of eager loading and will raise ActiveRecord::EagerLoadPolymorphicError.
938
- # The reason is that the parent model's type is a column value so its corresponding table
939
- # name cannot be put in the +FROM+/+JOIN+ clauses of that query.
940
- #
941
- # == Table Aliasing
942
- #
943
- # Active Record uses table aliasing in the case that a table is referenced multiple times
944
- # in a join. If a table is referenced only once, the standard table name is used. The
945
- # second time, the table is aliased as <tt>#{reflection_name}_#{parent_table_name}</tt>.
946
- # Indexes are appended for any more successive uses of the table name.
947
- #
948
- # Post.joins(:comments)
949
- # # => SELECT ... FROM posts INNER JOIN comments ON ...
950
- # Post.joins(:special_comments) # STI
951
- # # => SELECT ... FROM posts INNER JOIN comments ON ... AND comments.type = 'SpecialComment'
952
- # Post.joins(:comments, :special_comments) # special_comments is the reflection name, posts is the parent table name
953
- # # => SELECT ... FROM posts INNER JOIN comments ON ... INNER JOIN comments special_comments_posts
954
- #
955
- # Acts as tree example:
956
- #
957
- # TreeMixin.joins(:children)
958
- # # => SELECT ... FROM mixins INNER JOIN mixins childrens_mixins ...
959
- # TreeMixin.joins(children: :parent)
960
- # # => SELECT ... FROM mixins INNER JOIN mixins childrens_mixins ...
961
- # INNER JOIN parents_mixins ...
962
- # TreeMixin.joins(children: {parent: :children})
963
- # # => SELECT ... FROM mixins INNER JOIN mixins childrens_mixins ...
964
- # INNER JOIN parents_mixins ...
965
- # INNER JOIN mixins childrens_mixins_2
966
- #
967
- # Has and Belongs to Many join tables use the same idea, but add a <tt>_join</tt> suffix:
968
- #
969
- # Post.joins(:categories)
970
- # # => SELECT ... FROM posts INNER JOIN categories_posts ... INNER JOIN categories ...
971
- # Post.joins(categories: :posts)
972
- # # => SELECT ... FROM posts INNER JOIN categories_posts ... INNER JOIN categories ...
973
- # INNER JOIN categories_posts posts_categories_join INNER JOIN posts posts_categories
974
- # Post.joins(categories: {posts: :categories})
975
- # # => SELECT ... FROM posts INNER JOIN categories_posts ... INNER JOIN categories ...
976
- # INNER JOIN categories_posts posts_categories_join INNER JOIN posts posts_categories
977
- # INNER JOIN categories_posts categories_posts_join INNER JOIN categories categories_posts_2
978
- #
979
- # If you wish to specify your own custom joins using ActiveRecord::QueryMethods#joins method, those table
980
- # names will take precedence over the eager associations:
981
- #
982
- # Post.joins(:comments).joins("inner join comments ...")
983
- # # => SELECT ... FROM posts INNER JOIN comments_posts ON ... INNER JOIN comments ...
984
- # Post.joins(:comments, :special_comments).joins("inner join comments ...")
985
- # # => SELECT ... FROM posts INNER JOIN comments comments_posts ON ...
986
- # INNER JOIN comments special_comments_posts ...
987
- # INNER JOIN comments ...
988
- #
989
- # Table aliases are automatically truncated according to the maximum length of table identifiers
990
- # according to the specific database.
991
- #
992
- # == Modules
993
- #
994
- # By default, associations will look for objects within the current module scope. Consider:
995
- #
996
- # module MyApplication
997
- # module Business
998
- # class Firm < ActiveRecord::Base
999
- # has_many :clients
1000
- # end
1001
- #
1002
- # class Client < ActiveRecord::Base; end
1003
- # end
1004
- # end
1005
- #
1006
- # When <tt>Firm#clients</tt> is called, it will in turn call
1007
- # <tt>MyApplication::Business::Client.find_all_by_firm_id(firm.id)</tt>.
1008
- # If you want to associate with a class in another module scope, this can be done by
1009
- # specifying the complete class name.
1010
- #
1011
- # module MyApplication
1012
- # module Business
1013
- # class Firm < ActiveRecord::Base; end
1014
- # end
1015
- #
1016
- # module Billing
1017
- # class Account < ActiveRecord::Base
1018
- # belongs_to :firm, class_name: "MyApplication::Business::Firm"
1019
- # end
1020
- # end
1021
- # end
1022
- #
1023
- # == Bi-directional associations
1024
- #
1025
- # When you specify an association there is usually an association on the associated model
1026
- # that specifies the same relationship in reverse. For example, with the following models:
1027
- #
1028
- # class Dungeon < ActiveRecord::Base
1029
- # has_many :traps
1030
- # has_one :evil_wizard
1031
- # end
1032
- #
1033
- # class Trap < ActiveRecord::Base
1034
- # belongs_to :dungeon
1035
- # end
1036
- #
1037
- # class EvilWizard < ActiveRecord::Base
1038
- # belongs_to :dungeon
1039
- # end
1040
- #
1041
- # The +traps+ association on +Dungeon+ and the +dungeon+ association on +Trap+ are
1042
- # the inverse of each other and the inverse of the +dungeon+ association on +EvilWizard+
1043
- # is the +evil_wizard+ association on +Dungeon+ (and vice-versa). By default,
1044
- # Active Record can guess the inverse of the association based on the name
1045
- # of the class. The result is the following:
1046
- #
1047
- # d = Dungeon.first
1048
- # t = d.traps.first
1049
- # d.object_id == t.dungeon.object_id # => true
1050
- #
1051
- # The +Dungeon+ instances +d+ and <tt>t.dungeon</tt> in the above example refer to
1052
- # the same in-memory instance since the association matches the name of the class.
1053
- # The result would be the same if we added +:inverse_of+ to our model definitions:
1054
- #
1055
- # class Dungeon < ActiveRecord::Base
1056
- # has_many :traps, inverse_of: :dungeon
1057
- # has_one :evil_wizard, inverse_of: :dungeon
1058
- # end
1059
- #
1060
- # class Trap < ActiveRecord::Base
1061
- # belongs_to :dungeon, inverse_of: :traps
1062
- # end
1063
- #
1064
- # class EvilWizard < ActiveRecord::Base
1065
- # belongs_to :dungeon, inverse_of: :evil_wizard
1066
- # end
1067
- #
1068
- # There are limitations to <tt>:inverse_of</tt> support:
1069
- #
1070
- # * does not work with <tt>:through</tt> associations.
1071
- # * does not work with <tt>:polymorphic</tt> associations.
1072
- # * for #belongs_to associations #has_many inverse associations are ignored.
1073
- #
1074
- # For more information, see the documentation for the +:inverse_of+ option.
1075
- #
1076
- # == Deleting from associations
1077
- #
1078
- # === Dependent associations
1079
- #
1080
- # #has_many, #has_one and #belongs_to associations support the <tt>:dependent</tt> option.
1081
- # This allows you to specify that associated records should be deleted when the owner is
1082
- # deleted.
1083
- #
1084
- # For example:
1085
- #
1086
- # class Author
1087
- # has_many :posts, dependent: :destroy
1088
- # end
1089
- # Author.find(1).destroy # => Will destroy all of the author's posts, too
1090
- #
1091
- # The <tt>:dependent</tt> option can have different values which specify how the deletion
1092
- # is done. For more information, see the documentation for this option on the different
1093
- # specific association types. When no option is given, the behavior is to do nothing
1094
- # with the associated records when destroying a record.
1095
- #
1096
- # Note that <tt>:dependent</tt> is implemented using Rails' callback
1097
- # system, which works by processing callbacks in order. Therefore, other
1098
- # callbacks declared either before or after the <tt>:dependent</tt> option
1099
- # can affect what it does.
1100
- #
1101
- # Note that <tt>:dependent</tt> option is ignored for #has_one <tt>:through</tt> associations.
1102
- #
1103
- # === Delete or destroy?
1104
- #
1105
- # #has_many and #has_and_belongs_to_many associations have the methods <tt>destroy</tt>,
1106
- # <tt>delete</tt>, <tt>destroy_all</tt> and <tt>delete_all</tt>.
1107
- #
1108
- # For #has_and_belongs_to_many, <tt>delete</tt> and <tt>destroy</tt> are the same: they
1109
- # cause the records in the join table to be removed.
1110
- #
1111
- # For #has_many, <tt>destroy</tt> and <tt>destroy_all</tt> will always call the <tt>destroy</tt> method of the
1112
- # record(s) being removed so that callbacks are run. However <tt>delete</tt> and <tt>delete_all</tt> will either
1113
- # do the deletion according to the strategy specified by the <tt>:dependent</tt> option, or
1114
- # if no <tt>:dependent</tt> option is given, then it will follow the default strategy.
1115
- # The default strategy is to do nothing (leave the foreign keys with the parent ids set), except for
1116
- # #has_many <tt>:through</tt>, where the default strategy is <tt>delete_all</tt> (delete
1117
- # the join records, without running their callbacks).
1118
- #
1119
- # There is also a <tt>clear</tt> method which is the same as <tt>delete_all</tt>, except that
1120
- # it returns the association rather than the records which have been deleted.
1121
- #
1122
- # === What gets deleted?
1123
- #
1124
- # There is a potential pitfall here: #has_and_belongs_to_many and #has_many <tt>:through</tt>
1125
- # associations have records in join tables, as well as the associated records. So when we
1126
- # call one of these deletion methods, what exactly should be deleted?
1127
- #
1128
- # The answer is that it is assumed that deletion on an association is about removing the
1129
- # <i>link</i> between the owner and the associated object(s), rather than necessarily the
1130
- # associated objects themselves. So with #has_and_belongs_to_many and #has_many
1131
- # <tt>:through</tt>, the join records will be deleted, but the associated records won't.
1132
- #
1133
- # This makes sense if you think about it: if you were to call <tt>post.tags.delete(Tag.find_by(name: 'food'))</tt>
1134
- # you would want the 'food' tag to be unlinked from the post, rather than for the tag itself
1135
- # to be removed from the database.
1136
- #
1137
- # However, there are examples where this strategy doesn't make sense. For example, suppose
1138
- # a person has many projects, and each project has many tasks. If we deleted one of a person's
1139
- # tasks, we would probably not want the project to be deleted. In this scenario, the delete method
1140
- # won't actually work: it can only be used if the association on the join model is a
1141
- # #belongs_to. In other situations you are expected to perform operations directly on
1142
- # either the associated records or the <tt>:through</tt> association.
1143
- #
1144
- # With a regular #has_many there is no distinction between the "associated records"
1145
- # and the "link", so there is only one choice for what gets deleted.
1146
- #
1147
- # With #has_and_belongs_to_many and #has_many <tt>:through</tt>, if you want to delete the
1148
- # associated records themselves, you can always do something along the lines of
1149
- # <tt>person.tasks.each(&:destroy)</tt>.
1150
- #
1151
- # == Type safety with ActiveRecord::AssociationTypeMismatch
1152
- #
1153
- # If you attempt to assign an object to an association that doesn't match the inferred
1154
- # or specified <tt>:class_name</tt>, you'll get an ActiveRecord::AssociationTypeMismatch.
1155
- #
1156
- # == Options
1157
- #
1158
- # All of the association macros can be specialized through options. This makes cases
1159
- # more complex than the simple and guessable ones possible.
1160
- module ClassMethods
1161
- # Specifies a one-to-many association. The following methods for retrieval and query of
1162
- # collections of associated objects will be added:
1163
- #
1164
- # +collection+ is a placeholder for the symbol passed as the +name+ argument, so
1165
- # <tt>has_many :clients</tt> would add among others <tt>clients.empty?</tt>.
1166
- #
1167
- # [collection]
1168
- # Returns a Relation of all the associated objects.
1169
- # An empty Relation is returned if none are found.
1170
- # [collection<<(object, ...)]
1171
- # Adds one or more objects to the collection by setting their foreign keys to the collection's primary key.
1172
- # Note that this operation instantly fires update SQL without waiting for the save or update call on the
1173
- # parent object, unless the parent object is a new record.
1174
- # This will also run validations and callbacks of associated object(s).
1175
- # [collection.delete(object, ...)]
1176
- # Removes one or more objects from the collection by setting their foreign keys to +NULL+.
1177
- # Objects will be in addition destroyed if they're associated with <tt>dependent: :destroy</tt>,
1178
- # and deleted if they're associated with <tt>dependent: :delete_all</tt>.
1179
- #
1180
- # If the <tt>:through</tt> option is used, then the join records are deleted (rather than
1181
- # nullified) by default, but you can specify <tt>dependent: :destroy</tt> or
1182
- # <tt>dependent: :nullify</tt> to override this.
1183
- # [collection.destroy(object, ...)]
1184
- # Removes one or more objects from the collection by running <tt>destroy</tt> on
1185
- # each record, regardless of any dependent option, ensuring callbacks are run.
1186
- #
1187
- # If the <tt>:through</tt> option is used, then the join records are destroyed
1188
- # instead, not the objects themselves.
1189
- # [collection=objects]
1190
- # Replaces the collections content by deleting and adding objects as appropriate. If the <tt>:through</tt>
1191
- # option is true callbacks in the join models are triggered except destroy callbacks, since deletion is
1192
- # direct by default. You can specify <tt>dependent: :destroy</tt> or
1193
- # <tt>dependent: :nullify</tt> to override this.
1194
- # [collection_singular_ids]
1195
- # Returns an array of the associated objects' ids
1196
- # [collection_singular_ids=ids]
1197
- # Replace the collection with the objects identified by the primary keys in +ids+. This
1198
- # method loads the models and calls <tt>collection=</tt>. See above.
1199
- # [collection.clear]
1200
- # Removes every object from the collection. This destroys the associated objects if they
1201
- # are associated with <tt>dependent: :destroy</tt>, deletes them directly from the
1202
- # database if <tt>dependent: :delete_all</tt>, otherwise sets their foreign keys to +NULL+.
1203
- # If the <tt>:through</tt> option is true no destroy callbacks are invoked on the join models.
1204
- # Join models are directly deleted.
1205
- # [collection.empty?]
1206
- # Returns +true+ if there are no associated objects.
1207
- # [collection.size]
1208
- # Returns the number of associated objects.
1209
- # [collection.find(...)]
1210
- # Finds an associated object according to the same rules as ActiveRecord::FinderMethods#find.
1211
- # [collection.exists?(...)]
1212
- # Checks whether an associated object with the given conditions exists.
1213
- # Uses the same rules as ActiveRecord::FinderMethods#exists?.
1214
- # [collection.build(attributes = {}, ...)]
1215
- # Returns one or more new objects of the collection type that have been instantiated
1216
- # with +attributes+ and linked to this object through a foreign key, but have not yet
1217
- # been saved.
1218
- # [collection.create(attributes = {})]
1219
- # Returns a new object of the collection type that has been instantiated
1220
- # with +attributes+, linked to this object through a foreign key, and that has already
1221
- # been saved (if it passed the validation). *Note*: This only works if the base model
1222
- # already exists in the DB, not if it is a new (unsaved) record!
1223
- # [collection.create!(attributes = {})]
1224
- # Does the same as <tt>collection.create</tt>, but raises ActiveRecord::RecordInvalid
1225
- # if the record is invalid.
1226
- # [collection.reload]
1227
- # Returns a Relation of all of the associated objects, forcing a database read.
1228
- # An empty Relation is returned if none are found.
1229
- #
1230
- # === Example
1231
- #
1232
- # A <tt>Firm</tt> class declares <tt>has_many :clients</tt>, which will add:
1233
- # * <tt>Firm#clients</tt> (similar to <tt>Client.where(firm_id: id)</tt>)
1234
- # * <tt>Firm#clients<<</tt>
1235
- # * <tt>Firm#clients.delete</tt>
1236
- # * <tt>Firm#clients.destroy</tt>
1237
- # * <tt>Firm#clients=</tt>
1238
- # * <tt>Firm#client_ids</tt>
1239
- # * <tt>Firm#client_ids=</tt>
1240
- # * <tt>Firm#clients.clear</tt>
1241
- # * <tt>Firm#clients.empty?</tt> (similar to <tt>firm.clients.size == 0</tt>)
1242
- # * <tt>Firm#clients.size</tt> (similar to <tt>Client.count "firm_id = #{id}"</tt>)
1243
- # * <tt>Firm#clients.find</tt> (similar to <tt>Client.where(firm_id: id).find(id)</tt>)
1244
- # * <tt>Firm#clients.exists?(name: 'ACME')</tt> (similar to <tt>Client.exists?(name: 'ACME', firm_id: firm.id)</tt>)
1245
- # * <tt>Firm#clients.build</tt> (similar to <tt>Client.new("firm_id" => id)</tt>)
1246
- # * <tt>Firm#clients.create</tt> (similar to <tt>c = Client.new("firm_id" => id); c.save; c</tt>)
1247
- # * <tt>Firm#clients.create!</tt> (similar to <tt>c = Client.new("firm_id" => id); c.save!</tt>)
1248
- # * <tt>Firm#clients.reload</tt>
1249
- # The declaration can also include an +options+ hash to specialize the behavior of the association.
1250
- #
1251
- # === Scopes
1252
- #
1253
- # You can pass a second argument +scope+ as a callable (i.e. proc or
1254
- # lambda) to retrieve a specific set of records or customize the generated
1255
- # query when you access the associated collection.
1256
- #
1257
- # Scope examples:
1258
- # has_many :comments, -> { where(author_id: 1) }
1259
- # has_many :employees, -> { joins(:address) }
1260
- # has_many :posts, ->(post) { where("max_post_length > ?", post.length) }
1261
- #
1262
- # === Extensions
1263
- #
1264
- # The +extension+ argument allows you to pass a block into a has_many
1265
- # association. This is useful for adding new finders, creators and other
1266
- # factory-type methods to be used as part of the association.
1267
- #
1268
- # Extension examples:
1269
- # has_many :employees do
1270
- # def find_or_create_by_name(name)
1271
- # first_name, last_name = name.split(" ", 2)
1272
- # find_or_create_by(first_name: first_name, last_name: last_name)
279
+ # \Associations are a set of macro-like class methods for tying objects together through
280
+ # foreign keys. They express relationships like "Project has one Project Manager"
281
+ # or "Project belongs to a Portfolio". Each macro adds a number of methods to the
282
+ # class which are specialized according to the collection or association symbol and the
283
+ # options hash. It works much the same way as Ruby's own <tt>attr*</tt>
284
+ # methods.
285
+ #
286
+ # class Project < ActiveRecord::Base
287
+ # belongs_to :portfolio
288
+ # has_one :project_manager
289
+ # has_many :milestones
290
+ # has_and_belongs_to_many :categories
291
+ # end
292
+ #
293
+ # The project class now has the following methods (and more) to ease the traversal and
294
+ # manipulation of its relationships:
295
+ # * <tt>Project#portfolio</tt>, <tt>Project#portfolio=(portfolio)</tt>, <tt>Project#reload_portfolio</tt>
296
+ # * <tt>Project#project_manager</tt>, <tt>Project#project_manager=(project_manager)</tt>, <tt>Project#reload_project_manager</tt>
297
+ # * <tt>Project#milestones.empty?</tt>, <tt>Project#milestones.size</tt>, <tt>Project#milestones</tt>, <tt>Project#milestones<<(milestone)</tt>,
298
+ # <tt>Project#milestones.delete(milestone)</tt>, <tt>Project#milestones.destroy(milestone)</tt>, <tt>Project#milestones.find(milestone_id)</tt>,
299
+ # <tt>Project#milestones.build</tt>, <tt>Project#milestones.create</tt>
300
+ # * <tt>Project#categories.empty?</tt>, <tt>Project#categories.size</tt>, <tt>Project#categories</tt>, <tt>Project#categories<<(category1)</tt>,
301
+ # <tt>Project#categories.delete(category1)</tt>, <tt>Project#categories.destroy(category1)</tt>
302
+ #
303
+ # === A word of warning
304
+ #
305
+ # Don't create associations that have the same name as {instance methods}[rdoc-ref:ActiveRecord::Core] of
306
+ # <tt>ActiveRecord::Base</tt>. Since the association adds a method with that name to
307
+ # its model, using an association with the same name as one provided by <tt>ActiveRecord::Base</tt> will override the method inherited through <tt>ActiveRecord::Base</tt> and will break things.
308
+ # For instance, +attributes+ and +connection+ would be bad choices for association names, because those names already exist in the list of <tt>ActiveRecord::Base</tt> instance methods.
309
+ #
310
+ # == Auto-generated methods
311
+ # See also Instance Public methods below for more details.
312
+ #
313
+ # === Singular associations (one-to-one)
314
+ # | | belongs_to |
315
+ # generated methods | belongs_to | :polymorphic | has_one
316
+ # ----------------------------------+------------+--------------+---------
317
+ # other | X | X | X
318
+ # other=(other) | X | X | X
319
+ # build_other(attributes={}) | X | | X
320
+ # create_other(attributes={}) | X | | X
321
+ # create_other!(attributes={}) | X | | X
322
+ # reload_other | X | X | X
323
+ #
324
+ # === Collection associations (one-to-many / many-to-many)
325
+ # | | | has_many
326
+ # generated methods | habtm | has_many | :through
327
+ # ----------------------------------+-------+----------+----------
328
+ # others | X | X | X
329
+ # others=(other,other,...) | X | X | X
330
+ # other_ids | X | X | X
331
+ # other_ids=(id,id,...) | X | X | X
332
+ # others<< | X | X | X
333
+ # others.push | X | X | X
334
+ # others.concat | X | X | X
335
+ # others.build(attributes={}) | X | X | X
336
+ # others.create(attributes={}) | X | X | X
337
+ # others.create!(attributes={}) | X | X | X
338
+ # others.size | X | X | X
339
+ # others.length | X | X | X
340
+ # others.count | X | X | X
341
+ # others.sum(*args) | X | X | X
342
+ # others.empty? | X | X | X
343
+ # others.clear | X | X | X
344
+ # others.delete(other,other,...) | X | X | X
345
+ # others.delete_all | X | X | X
346
+ # others.destroy(other,other,...) | X | X | X
347
+ # others.destroy_all | X | X | X
348
+ # others.find(*args) | X | X | X
349
+ # others.exists? | X | X | X
350
+ # others.distinct | X | X | X
351
+ # others.reset | X | X | X
352
+ # others.reload | X | X | X
353
+ #
354
+ # === Overriding generated methods
355
+ #
356
+ # Association methods are generated in a module included into the model
357
+ # class, making overrides easy. The original generated method can thus be
358
+ # called with +super+:
359
+ #
360
+ # class Car < ActiveRecord::Base
361
+ # belongs_to :owner
362
+ # belongs_to :old_owner
363
+ #
364
+ # def owner=(new_owner)
365
+ # self.old_owner = self.owner
366
+ # super
1273
367
  # end
1274
368
  # end
1275
369
  #
1276
- # === Options
1277
- # [:class_name]
1278
- # Specify the class name of the association. Use it only if that name can't be inferred
1279
- # from the association name. So <tt>has_many :products</tt> will by default be linked
1280
- # to the +Product+ class, but if the real class name is +SpecialProduct+, you'll have to
1281
- # specify it with this option.
1282
- # [:foreign_key]
1283
- # Specify the foreign key used for the association. By default this is guessed to be the name
1284
- # of this class in lower-case and "_id" suffixed. So a Person class that makes a #has_many
1285
- # association will use "person_id" as the default <tt>:foreign_key</tt>.
1286
- # [:foreign_type]
1287
- # Specify the column used to store the associated object's type, if this is a polymorphic
1288
- # association. By default this is guessed to be the name of the polymorphic association
1289
- # specified on "as" option with a "_type" suffix. So a class that defines a
1290
- # <tt>has_many :tags, as: :taggable</tt> association will use "taggable_type" as the
1291
- # default <tt>:foreign_type</tt>.
1292
- # [:primary_key]
1293
- # Specify the name of the column to use as the primary key for the association. By default this is +id+.
1294
- # [:dependent]
1295
- # Controls what happens to the associated objects when
1296
- # their owner is destroyed. Note that these are implemented as
1297
- # callbacks, and Rails executes callbacks in order. Therefore, other
1298
- # similar callbacks may affect the <tt>:dependent</tt> behavior, and the
1299
- # <tt>:dependent</tt> behavior may affect other callbacks.
1300
- #
1301
- # * <tt>:destroy</tt> causes all the associated objects to also be destroyed.
1302
- # * <tt>:delete_all</tt> causes all the associated objects to be deleted directly from the database (so callbacks will not be executed).
1303
- # * <tt>:nullify</tt> causes the foreign keys to be set to +NULL+. Callbacks are not executed.
1304
- # * <tt>:restrict_with_exception</tt> causes an exception to be raised if there are any associated records.
1305
- # * <tt>:restrict_with_error</tt> causes an error to be added to the owner if there are any associated objects.
1306
- #
1307
- # If using with the <tt>:through</tt> option, the association on the join model must be
1308
- # a #belongs_to, and the records which get deleted are the join records, rather than
1309
- # the associated records.
1310
- # [:counter_cache]
1311
- # This option can be used to configure a custom named <tt>:counter_cache.</tt> You only need this option,
1312
- # when you customized the name of your <tt>:counter_cache</tt> on the #belongs_to association.
1313
- # [:as]
1314
- # Specifies a polymorphic interface (See #belongs_to).
1315
- # [:through]
1316
- # Specifies an association through which to perform the query. This can be any other type
1317
- # of association, including other <tt>:through</tt> associations. Options for <tt>:class_name</tt>,
1318
- # <tt>:primary_key</tt> and <tt>:foreign_key</tt> are ignored, as the association uses the
1319
- # source reflection.
1320
- #
1321
- # If the association on the join model is a #belongs_to, the collection can be modified
1322
- # and the records on the <tt>:through</tt> model will be automatically created and removed
1323
- # as appropriate. Otherwise, the collection is read-only, so you should manipulate the
1324
- # <tt>:through</tt> association directly.
1325
- #
1326
- # If you are going to modify the association (rather than just read from it), then it is
1327
- # a good idea to set the <tt>:inverse_of</tt> option on the source association on the
1328
- # join model. This allows associated records to be built which will automatically create
1329
- # the appropriate join model records when they are saved. (See the 'Association Join Models'
1330
- # section above.)
1331
- # [:source]
1332
- # Specifies the source association name used by #has_many <tt>:through</tt> queries.
1333
- # Only use it if the name cannot be inferred from the association.
1334
- # <tt>has_many :subscribers, through: :subscriptions</tt> will look for either <tt>:subscribers</tt> or
1335
- # <tt>:subscriber</tt> on Subscription, unless a <tt>:source</tt> is given.
1336
- # [:source_type]
1337
- # Specifies type of the source association used by #has_many <tt>:through</tt> queries where the source
1338
- # association is a polymorphic #belongs_to.
1339
- # [:validate]
1340
- # When set to +true+, validates new objects added to association when saving the parent object. +true+ by default.
1341
- # If you want to ensure associated objects are revalidated on every update, use +validates_associated+.
1342
- # [:autosave]
1343
- # If true, always save the associated objects or destroy them if marked for destruction,
1344
- # when saving the parent object. If false, never save or destroy the associated objects.
1345
- # By default, only save associated objects that are new records. This option is implemented as a
1346
- # +before_save+ callback. Because callbacks are run in the order they are defined, associated objects
1347
- # may need to be explicitly saved in any user-defined +before_save+ callbacks.
1348
- #
1349
- # Note that NestedAttributes::ClassMethods#accepts_nested_attributes_for sets
1350
- # <tt>:autosave</tt> to <tt>true</tt>.
1351
- # [:inverse_of]
1352
- # Specifies the name of the #belongs_to association on the associated object
1353
- # that is the inverse of this #has_many association. Does not work in combination
1354
- # with <tt>:through</tt> or <tt>:as</tt> options.
1355
- # See ActiveRecord::Associations::ClassMethods's overview on Bi-directional associations for more detail.
1356
- # [:extend]
1357
- # Specifies a module or array of modules that will be extended into the association object returned.
1358
- # Useful for defining methods on associations, especially when they should be shared between multiple
1359
- # association objects.
1360
- #
1361
- # Option examples:
1362
- # has_many :comments, -> { order("posted_on") }
1363
- # has_many :comments, -> { includes(:author) }
1364
- # has_many :people, -> { where(deleted: false).order("name") }, class_name: "Person"
1365
- # has_many :tracks, -> { order("position") }, dependent: :destroy
1366
- # has_many :comments, dependent: :nullify
1367
- # has_many :tags, as: :taggable
1368
- # has_many :reports, -> { readonly }
1369
- # has_many :subscribers, through: :subscriptions, source: :user
1370
- def has_many(name, scope = nil, options = {}, &extension)
1371
- reflection = Builder::HasMany.build(self, name, scope, options, &extension)
1372
- Reflection.add_reflection self, name, reflection
1373
- end
1374
-
1375
- # Specifies a one-to-one association with another class. This method should only be used
1376
- # if the other class contains the foreign key. If the current class contains the foreign key,
1377
- # then you should use #belongs_to instead. See also ActiveRecord::Associations::ClassMethods's overview
1378
- # on when to use #has_one and when to use #belongs_to.
1379
- #
1380
- # The following methods for retrieval and query of a single associated object will be added:
1381
- #
1382
- # +association+ is a placeholder for the symbol passed as the +name+ argument, so
1383
- # <tt>has_one :manager</tt> would add among others <tt>manager.nil?</tt>.
1384
- #
1385
- # [association]
1386
- # Returns the associated object. +nil+ is returned if none is found.
1387
- # [association=(associate)]
1388
- # Assigns the associate object, extracts the primary key, sets it as the foreign key,
1389
- # and saves the associate object. To avoid database inconsistencies, permanently deletes an existing
1390
- # associated object when assigning a new one, even if the new one isn't saved to database.
1391
- # [build_association(attributes = {})]
1392
- # Returns a new object of the associated type that has been instantiated
1393
- # with +attributes+ and linked to this object through a foreign key, but has not
1394
- # yet been saved.
1395
- # [create_association(attributes = {})]
1396
- # Returns a new object of the associated type that has been instantiated
1397
- # with +attributes+, linked to this object through a foreign key, and that
1398
- # has already been saved (if it passed the validation).
1399
- # [create_association!(attributes = {})]
1400
- # Does the same as <tt>create_association</tt>, but raises ActiveRecord::RecordInvalid
1401
- # if the record is invalid.
1402
- # [reload_association]
1403
- # Returns the associated object, forcing a database read.
1404
- #
1405
- # === Example
1406
- #
1407
- # An Account class declares <tt>has_one :beneficiary</tt>, which will add:
1408
- # * <tt>Account#beneficiary</tt> (similar to <tt>Beneficiary.where(account_id: id).first</tt>)
1409
- # * <tt>Account#beneficiary=(beneficiary)</tt> (similar to <tt>beneficiary.account_id = account.id; beneficiary.save</tt>)
1410
- # * <tt>Account#build_beneficiary</tt> (similar to <tt>Beneficiary.new("account_id" => id)</tt>)
1411
- # * <tt>Account#create_beneficiary</tt> (similar to <tt>b = Beneficiary.new("account_id" => id); b.save; b</tt>)
1412
- # * <tt>Account#create_beneficiary!</tt> (similar to <tt>b = Beneficiary.new("account_id" => id); b.save!; b</tt>)
1413
- # * <tt>Account#reload_beneficiary</tt>
1414
- #
1415
- # === Scopes
1416
- #
1417
- # You can pass a second argument +scope+ as a callable (i.e. proc or
1418
- # lambda) to retrieve a specific record or customize the generated query
1419
- # when you access the associated object.
1420
- #
1421
- # Scope examples:
1422
- # has_one :author, -> { where(comment_id: 1) }
1423
- # has_one :employer, -> { joins(:company) }
1424
- # has_one :dob, ->(dob) { where("Date.new(2000, 01, 01) > ?", dob) }
1425
- #
1426
- # === Options
1427
- #
1428
- # The declaration can also include an +options+ hash to specialize the behavior of the association.
1429
- #
1430
- # Options are:
1431
- # [:class_name]
1432
- # Specify the class name of the association. Use it only if that name can't be inferred
1433
- # from the association name. So <tt>has_one :manager</tt> will by default be linked to the Manager class, but
1434
- # if the real class name is Person, you'll have to specify it with this option.
1435
- # [:dependent]
1436
- # Controls what happens to the associated object when
1437
- # its owner is destroyed:
1438
- #
1439
- # * <tt>:destroy</tt> causes the associated object to also be destroyed
1440
- # * <tt>:delete</tt> causes the associated object to be deleted directly from the database (so callbacks will not execute)
1441
- # * <tt>:nullify</tt> causes the foreign key to be set to +NULL+. Callbacks are not executed.
1442
- # * <tt>:restrict_with_exception</tt> causes an exception to be raised if there is an associated record
1443
- # * <tt>:restrict_with_error</tt> causes an error to be added to the owner if there is an associated object
1444
- #
1445
- # Note that <tt>:dependent</tt> option is ignored when using <tt>:through</tt> option.
1446
- # [:foreign_key]
1447
- # Specify the foreign key used for the association. By default this is guessed to be the name
1448
- # of this class in lower-case and "_id" suffixed. So a Person class that makes a #has_one association
1449
- # will use "person_id" as the default <tt>:foreign_key</tt>.
1450
- # [:foreign_type]
1451
- # Specify the column used to store the associated object's type, if this is a polymorphic
1452
- # association. By default this is guessed to be the name of the polymorphic association
1453
- # specified on "as" option with a "_type" suffix. So a class that defines a
1454
- # <tt>has_one :tag, as: :taggable</tt> association will use "taggable_type" as the
1455
- # default <tt>:foreign_type</tt>.
1456
- # [:primary_key]
1457
- # Specify the method that returns the primary key used for the association. By default this is +id+.
1458
- # [:as]
1459
- # Specifies a polymorphic interface (See #belongs_to).
1460
- # [:through]
1461
- # Specifies a Join Model through which to perform the query. Options for <tt>:class_name</tt>,
1462
- # <tt>:primary_key</tt>, and <tt>:foreign_key</tt> are ignored, as the association uses the
1463
- # source reflection. You can only use a <tt>:through</tt> query through a #has_one
1464
- # or #belongs_to association on the join model.
1465
- # [:source]
1466
- # Specifies the source association name used by #has_one <tt>:through</tt> queries.
1467
- # Only use it if the name cannot be inferred from the association.
1468
- # <tt>has_one :favorite, through: :favorites</tt> will look for a
1469
- # <tt>:favorite</tt> on Favorite, unless a <tt>:source</tt> is given.
1470
- # [:source_type]
1471
- # Specifies type of the source association used by #has_one <tt>:through</tt> queries where the source
1472
- # association is a polymorphic #belongs_to.
1473
- # [:validate]
1474
- # When set to +true+, validates new objects added to association when saving the parent object. +false+ by default.
1475
- # If you want to ensure associated objects are revalidated on every update, use +validates_associated+.
1476
- # [:autosave]
1477
- # If true, always save the associated object or destroy it if marked for destruction,
1478
- # when saving the parent object. If false, never save or destroy the associated object.
1479
- # By default, only save the associated object if it's a new record.
1480
- #
1481
- # Note that NestedAttributes::ClassMethods#accepts_nested_attributes_for sets
1482
- # <tt>:autosave</tt> to <tt>true</tt>.
1483
- # [:inverse_of]
1484
- # Specifies the name of the #belongs_to association on the associated object
1485
- # that is the inverse of this #has_one association. Does not work in combination
1486
- # with <tt>:through</tt> or <tt>:as</tt> options.
1487
- # See ActiveRecord::Associations::ClassMethods's overview on Bi-directional associations for more detail.
1488
- # [:required]
1489
- # When set to +true+, the association will also have its presence validated.
1490
- # This will validate the association itself, not the id. You can use
1491
- # +:inverse_of+ to avoid an extra query during validation.
1492
- #
1493
- # Option examples:
1494
- # has_one :credit_card, dependent: :destroy # destroys the associated credit card
1495
- # has_one :credit_card, dependent: :nullify # updates the associated records foreign
1496
- # # key value to NULL rather than destroying it
1497
- # has_one :last_comment, -> { order('posted_on') }, class_name: "Comment"
1498
- # has_one :project_manager, -> { where(role: 'project_manager') }, class_name: "Person"
1499
- # has_one :attachment, as: :attachable
1500
- # has_one :boss, -> { readonly }
1501
- # has_one :club, through: :membership
1502
- # has_one :primary_address, -> { where(primary: true) }, through: :addressables, source: :addressable
1503
- # has_one :credit_card, required: true
1504
- def has_one(name, scope = nil, options = {})
1505
- reflection = Builder::HasOne.build(self, name, scope, options)
1506
- Reflection.add_reflection self, name, reflection
1507
- end
1508
-
1509
- # Specifies a one-to-one association with another class. This method should only be used
1510
- # if this class contains the foreign key. If the other class contains the foreign key,
1511
- # then you should use #has_one instead. See also ActiveRecord::Associations::ClassMethods's overview
1512
- # on when to use #has_one and when to use #belongs_to.
1513
- #
1514
- # Methods will be added for retrieval and query for a single associated object, for which
1515
- # this object holds an id:
1516
- #
1517
- # +association+ is a placeholder for the symbol passed as the +name+ argument, so
1518
- # <tt>belongs_to :author</tt> would add among others <tt>author.nil?</tt>.
1519
- #
1520
- # [association]
1521
- # Returns the associated object. +nil+ is returned if none is found.
1522
- # [association=(associate)]
1523
- # Assigns the associate object, extracts the primary key, and sets it as the foreign key.
1524
- # [build_association(attributes = {})]
1525
- # Returns a new object of the associated type that has been instantiated
1526
- # with +attributes+ and linked to this object through a foreign key, but has not yet been saved.
1527
- # [create_association(attributes = {})]
1528
- # Returns a new object of the associated type that has been instantiated
1529
- # with +attributes+, linked to this object through a foreign key, and that
1530
- # has already been saved (if it passed the validation).
1531
- # [create_association!(attributes = {})]
1532
- # Does the same as <tt>create_association</tt>, but raises ActiveRecord::RecordInvalid
1533
- # if the record is invalid.
1534
- # [reload_association]
1535
- # Returns the associated object, forcing a database read.
1536
- #
1537
- # === Example
1538
- #
1539
- # A Post class declares <tt>belongs_to :author</tt>, which will add:
1540
- # * <tt>Post#author</tt> (similar to <tt>Author.find(author_id)</tt>)
1541
- # * <tt>Post#author=(author)</tt> (similar to <tt>post.author_id = author.id</tt>)
1542
- # * <tt>Post#build_author</tt> (similar to <tt>post.author = Author.new</tt>)
1543
- # * <tt>Post#create_author</tt> (similar to <tt>post.author = Author.new; post.author.save; post.author</tt>)
1544
- # * <tt>Post#create_author!</tt> (similar to <tt>post.author = Author.new; post.author.save!; post.author</tt>)
1545
- # * <tt>Post#reload_author</tt>
1546
- # The declaration can also include an +options+ hash to specialize the behavior of the association.
1547
- #
1548
- # === Scopes
1549
- #
1550
- # You can pass a second argument +scope+ as a callable (i.e. proc or
1551
- # lambda) to retrieve a specific record or customize the generated query
1552
- # when you access the associated object.
1553
- #
1554
- # Scope examples:
1555
- # belongs_to :firm, -> { where(id: 2) }
1556
- # belongs_to :user, -> { joins(:friends) }
1557
- # belongs_to :level, ->(level) { where("game_level > ?", level.current) }
1558
- #
1559
- # === Options
1560
- #
1561
- # [:class_name]
1562
- # Specify the class name of the association. Use it only if that name can't be inferred
1563
- # from the association name. So <tt>belongs_to :author</tt> will by default be linked to the Author class, but
1564
- # if the real class name is Person, you'll have to specify it with this option.
1565
- # [:foreign_key]
1566
- # Specify the foreign key used for the association. By default this is guessed to be the name
1567
- # of the association with an "_id" suffix. So a class that defines a <tt>belongs_to :person</tt>
1568
- # association will use "person_id" as the default <tt>:foreign_key</tt>. Similarly,
1569
- # <tt>belongs_to :favorite_person, class_name: "Person"</tt> will use a foreign key
1570
- # of "favorite_person_id".
1571
- # [:foreign_type]
1572
- # Specify the column used to store the associated object's type, if this is a polymorphic
1573
- # association. By default this is guessed to be the name of the association with a "_type"
1574
- # suffix. So a class that defines a <tt>belongs_to :taggable, polymorphic: true</tt>
1575
- # association will use "taggable_type" as the default <tt>:foreign_type</tt>.
1576
- # [:primary_key]
1577
- # Specify the method that returns the primary key of associated object used for the association.
1578
- # By default this is id.
1579
- # [:dependent]
1580
- # If set to <tt>:destroy</tt>, the associated object is destroyed when this object is. If set to
1581
- # <tt>:delete</tt>, the associated object is deleted *without* calling its destroy method.
1582
- # This option should not be specified when #belongs_to is used in conjunction with
1583
- # a #has_many relationship on another class because of the potential to leave
1584
- # orphaned records behind.
1585
- # [:counter_cache]
1586
- # Caches the number of belonging objects on the associate class through the use of CounterCache::ClassMethods#increment_counter
1587
- # and CounterCache::ClassMethods#decrement_counter. The counter cache is incremented when an object of this
1588
- # class is created and decremented when it's destroyed. This requires that a column
1589
- # named <tt>#{table_name}_count</tt> (such as +comments_count+ for a belonging Comment class)
1590
- # is used on the associate class (such as a Post class) - that is the migration for
1591
- # <tt>#{table_name}_count</tt> is created on the associate class (such that <tt>Post.comments_count</tt> will
1592
- # return the count cached, see note below). You can also specify a custom counter
1593
- # cache column by providing a column name instead of a +true+/+false+ value to this
1594
- # option (e.g., <tt>counter_cache: :my_custom_counter</tt>.)
1595
- # Note: Specifying a counter cache will add it to that model's list of readonly attributes
1596
- # using +attr_readonly+.
1597
- # [:polymorphic]
1598
- # Specify this association is a polymorphic association by passing +true+.
1599
- # Note: If you've enabled the counter cache, then you may want to add the counter cache attribute
1600
- # to the +attr_readonly+ list in the associated classes (e.g. <tt>class Post; attr_readonly :comments_count; end</tt>).
1601
- # [:validate]
1602
- # When set to +true+, validates new objects added to association when saving the parent object. +false+ by default.
1603
- # If you want to ensure associated objects are revalidated on every update, use +validates_associated+.
1604
- # [:autosave]
1605
- # If true, always save the associated object or destroy it if marked for destruction, when
1606
- # saving the parent object.
1607
- # If false, never save or destroy the associated object.
1608
- # By default, only save the associated object if it's a new record.
1609
- #
1610
- # Note that NestedAttributes::ClassMethods#accepts_nested_attributes_for
1611
- # sets <tt>:autosave</tt> to <tt>true</tt>.
1612
- # [:touch]
1613
- # If true, the associated object will be touched (the updated_at/on attributes set to current time)
1614
- # when this record is either saved or destroyed. If you specify a symbol, that attribute
1615
- # will be updated with the current time in addition to the updated_at/on attribute.
1616
- # Please note that with touching no validation is performed and only the +after_touch+,
1617
- # +after_commit+ and +after_rollback+ callbacks are executed.
1618
- # [:inverse_of]
1619
- # Specifies the name of the #has_one or #has_many association on the associated
1620
- # object that is the inverse of this #belongs_to association. Does not work in
1621
- # combination with the <tt>:polymorphic</tt> options.
1622
- # See ActiveRecord::Associations::ClassMethods's overview on Bi-directional associations for more detail.
1623
- # [:optional]
1624
- # When set to +true+, the association will not have its presence validated.
1625
- # [:required]
1626
- # When set to +true+, the association will also have its presence validated.
1627
- # This will validate the association itself, not the id. You can use
1628
- # +:inverse_of+ to avoid an extra query during validation.
1629
- # NOTE: <tt>required</tt> is set to <tt>true</tt> by default and is deprecated. If
1630
- # you don't want to have association presence validated, use <tt>optional: true</tt>.
1631
- #
1632
- # Option examples:
1633
- # belongs_to :firm, foreign_key: "client_of"
1634
- # belongs_to :person, primary_key: "name", foreign_key: "person_name"
1635
- # belongs_to :author, class_name: "Person", foreign_key: "author_id"
1636
- # belongs_to :valid_coupon, ->(o) { where "discounts > ?", o.payments_count },
1637
- # class_name: "Coupon", foreign_key: "coupon_id"
1638
- # belongs_to :attachable, polymorphic: true
1639
- # belongs_to :project, -> { readonly }
1640
- # belongs_to :post, counter_cache: true
1641
- # belongs_to :comment, touch: true
1642
- # belongs_to :company, touch: :employees_last_updated_at
1643
- # belongs_to :user, optional: true
1644
- def belongs_to(name, scope = nil, options = {})
1645
- reflection = Builder::BelongsTo.build(self, name, scope, options)
1646
- Reflection.add_reflection self, name, reflection
1647
- end
1648
-
1649
- # Specifies a many-to-many relationship with another class. This associates two classes via an
1650
- # intermediate join table. Unless the join table is explicitly specified as an option, it is
1651
- # guessed using the lexical order of the class names. So a join between Developer and Project
1652
- # will give the default join table name of "developers_projects" because "D" precedes "P" alphabetically.
1653
- # Note that this precedence is calculated using the <tt><</tt> operator for String. This
1654
- # means that if the strings are of different lengths, and the strings are equal when compared
1655
- # up to the shortest length, then the longer string is considered of higher
1656
- # lexical precedence than the shorter one. For example, one would expect the tables "paper_boxes" and "papers"
1657
- # to generate a join table name of "papers_paper_boxes" because of the length of the name "paper_boxes",
1658
- # but it in fact generates a join table name of "paper_boxes_papers". Be aware of this caveat, and use the
1659
- # custom <tt>:join_table</tt> option if you need to.
1660
- # If your tables share a common prefix, it will only appear once at the beginning. For example,
1661
- # the tables "catalog_categories" and "catalog_products" generate a join table name of "catalog_categories_products".
1662
- #
1663
- # The join table should not have a primary key or a model associated with it. You must manually generate the
1664
- # join table with a migration such as this:
1665
- #
1666
- # class CreateDevelopersProjectsJoinTable < ActiveRecord::Migration[5.0]
1667
- # def change
1668
- # create_join_table :developers, :projects
370
+ # The association methods module is included immediately after the
371
+ # generated attributes methods module, meaning an association will
372
+ # override the methods for an attribute with the same name.
373
+ #
374
+ # == Cardinality and associations
375
+ #
376
+ # Active Record associations can be used to describe one-to-one, one-to-many and many-to-many
377
+ # relationships between models. Each model uses an association to describe its role in
378
+ # the relation. The #belongs_to association is always used in the model that has
379
+ # the foreign key.
380
+ #
381
+ # === One-to-one
382
+ #
383
+ # Use #has_one in the base, and #belongs_to in the associated model.
384
+ #
385
+ # class Employee < ActiveRecord::Base
386
+ # has_one :office
387
+ # end
388
+ # class Office < ActiveRecord::Base
389
+ # belongs_to :employee # foreign key - employee_id
390
+ # end
391
+ #
392
+ # === One-to-many
393
+ #
394
+ # Use #has_many in the base, and #belongs_to in the associated model.
395
+ #
396
+ # class Manager < ActiveRecord::Base
397
+ # has_many :employees
398
+ # end
399
+ # class Employee < ActiveRecord::Base
400
+ # belongs_to :manager # foreign key - manager_id
401
+ # end
402
+ #
403
+ # === Many-to-many
404
+ #
405
+ # There are two ways to build a many-to-many relationship.
406
+ #
407
+ # The first way uses a #has_many association with the <tt>:through</tt> option and a join model, so
408
+ # there are two stages of associations.
409
+ #
410
+ # class Assignment < ActiveRecord::Base
411
+ # belongs_to :programmer # foreign key - programmer_id
412
+ # belongs_to :project # foreign key - project_id
413
+ # end
414
+ # class Programmer < ActiveRecord::Base
415
+ # has_many :assignments
416
+ # has_many :projects, through: :assignments
417
+ # end
418
+ # class Project < ActiveRecord::Base
419
+ # has_many :assignments
420
+ # has_many :programmers, through: :assignments
421
+ # end
422
+ #
423
+ # For the second way, use #has_and_belongs_to_many in both models. This requires a join table
424
+ # that has no corresponding model or primary key.
425
+ #
426
+ # class Programmer < ActiveRecord::Base
427
+ # has_and_belongs_to_many :projects # foreign keys in the join table
428
+ # end
429
+ # class Project < ActiveRecord::Base
430
+ # has_and_belongs_to_many :programmers # foreign keys in the join table
431
+ # end
432
+ #
433
+ # Choosing which way to build a many-to-many relationship is not always simple.
434
+ # If you need to work with the relationship model as its own entity,
435
+ # use #has_many <tt>:through</tt>. Use #has_and_belongs_to_many when working with legacy schemas or when
436
+ # you never work directly with the relationship itself.
437
+ #
438
+ # == Is it a #belongs_to or #has_one association?
439
+ #
440
+ # Both express a 1-1 relationship. The difference is mostly where to place the foreign
441
+ # key, which goes on the table for the class declaring the #belongs_to relationship.
442
+ #
443
+ # class User < ActiveRecord::Base
444
+ # # I reference an account.
445
+ # belongs_to :account
446
+ # end
447
+ #
448
+ # class Account < ActiveRecord::Base
449
+ # # One user references me.
450
+ # has_one :user
451
+ # end
452
+ #
453
+ # The tables for these classes could look something like:
454
+ #
455
+ # CREATE TABLE users (
456
+ # id bigint NOT NULL auto_increment,
457
+ # account_id bigint default NULL,
458
+ # name varchar default NULL,
459
+ # PRIMARY KEY (id)
460
+ # )
461
+ #
462
+ # CREATE TABLE accounts (
463
+ # id bigint NOT NULL auto_increment,
464
+ # name varchar default NULL,
465
+ # PRIMARY KEY (id)
466
+ # )
467
+ #
468
+ # == Unsaved objects and associations
469
+ #
470
+ # You can manipulate objects and associations before they are saved to the database, but
471
+ # there is some special behavior you should be aware of, mostly involving the saving of
472
+ # associated objects.
473
+ #
474
+ # You can set the <tt>:autosave</tt> option on a #has_one, #belongs_to,
475
+ # #has_many, or #has_and_belongs_to_many association. Setting it
476
+ # to +true+ will _always_ save the members, whereas setting it to +false+ will
477
+ # _never_ save the members. More details about <tt>:autosave</tt> option is available at
478
+ # AutosaveAssociation.
479
+ #
480
+ # === One-to-one associations
481
+ #
482
+ # * Assigning an object to a #has_one association automatically saves that object and
483
+ # the object being replaced (if there is one), in order to update their foreign
484
+ # keys - except if the parent object is unsaved (<tt>new_record? == true</tt>).
485
+ # * If either of these saves fail (due to one of the objects being invalid), an
486
+ # ActiveRecord::RecordNotSaved exception is raised and the assignment is
487
+ # cancelled.
488
+ # * If you wish to assign an object to a #has_one association without saving it,
489
+ # use the <tt>#build_association</tt> method (documented below). The object being
490
+ # replaced will still be saved to update its foreign key.
491
+ # * Assigning an object to a #belongs_to association does not save the object, since
492
+ # the foreign key field belongs on the parent. It does not save the parent either.
493
+ #
494
+ # === Collections
495
+ #
496
+ # * Adding an object to a collection (#has_many or #has_and_belongs_to_many) automatically
497
+ # saves that object, except if the parent object (the owner of the collection) is not yet
498
+ # stored in the database.
499
+ # * If saving any of the objects being added to a collection (via <tt>push</tt> or similar)
500
+ # fails, then <tt>push</tt> returns +false+.
501
+ # * If saving fails while replacing the collection (via <tt>association=</tt>), an
502
+ # ActiveRecord::RecordNotSaved exception is raised and the assignment is
503
+ # cancelled.
504
+ # * You can add an object to a collection without automatically saving it by using the
505
+ # <tt>collection.build</tt> method (documented below).
506
+ # * All unsaved (<tt>new_record? == true</tt>) members of the collection are automatically
507
+ # saved when the parent is saved.
508
+ #
509
+ # == Customizing the query
510
+ #
511
+ # \Associations are built from <tt>Relation</tt> objects, and you can use the Relation syntax
512
+ # to customize them. For example, to add a condition:
513
+ #
514
+ # class Blog < ActiveRecord::Base
515
+ # has_many :published_posts, -> { where(published: true) }, class_name: 'Post'
516
+ # end
517
+ #
518
+ # Inside the <tt>-> { ... }</tt> block you can use all of the usual Relation methods.
519
+ #
520
+ # === Accessing the owner object
521
+ #
522
+ # Sometimes it is useful to have access to the owner object when building the query. The owner
523
+ # is passed as a parameter to the block. For example, the following association would find all
524
+ # events that occur on the user's birthday:
525
+ #
526
+ # class User < ActiveRecord::Base
527
+ # has_many :birthday_events, ->(user) { where(starts_on: user.birthday) }, class_name: 'Event'
528
+ # end
529
+ #
530
+ # Note: Joining, eager loading and preloading of these associations is not possible.
531
+ # These operations happen before instance creation and the scope will be called with a +nil+ argument.
532
+ #
533
+ # == Association callbacks
534
+ #
535
+ # Similar to the normal callbacks that hook into the life cycle of an Active Record object,
536
+ # you can also define callbacks that get triggered when you add an object to or remove an
537
+ # object from an association collection.
538
+ #
539
+ # class Project
540
+ # has_and_belongs_to_many :developers, after_add: :evaluate_velocity
541
+ #
542
+ # def evaluate_velocity(developer)
543
+ # ...
544
+ # end
545
+ # end
546
+ #
547
+ # It's possible to stack callbacks by passing them as an array. Example:
548
+ #
549
+ # class Project
550
+ # has_and_belongs_to_many :developers,
551
+ # after_add: [:evaluate_velocity, Proc.new { |p, d| p.shipping_date = Time.now}]
552
+ # end
553
+ #
554
+ # Possible callbacks are: +before_add+, +after_add+, +before_remove+ and +after_remove+.
555
+ #
556
+ # If any of the +before_add+ callbacks throw an exception, the object will not be
557
+ # added to the collection.
558
+ #
559
+ # Similarly, if any of the +before_remove+ callbacks throw an exception, the object
560
+ # will not be removed from the collection.
561
+ #
562
+ # == Association extensions
563
+ #
564
+ # The proxy objects that control the access to associations can be extended through anonymous
565
+ # modules. This is especially beneficial for adding new finders, creators, and other
566
+ # factory-type methods that are only used as part of this association.
567
+ #
568
+ # class Account < ActiveRecord::Base
569
+ # has_many :people do
570
+ # def find_or_create_by_name(name)
571
+ # first_name, last_name = name.split(" ", 2)
572
+ # find_or_create_by(first_name: first_name, last_name: last_name)
573
+ # end
1669
574
  # end
1670
575
  # end
1671
576
  #
1672
- # It's also a good idea to add indexes to each of those columns to speed up the joins process.
1673
- # However, in MySQL it is advised to add a compound index for both of the columns as MySQL only
1674
- # uses one index per table during the lookup.
1675
- #
1676
- # Adds the following methods for retrieval and query:
1677
- #
1678
- # +collection+ is a placeholder for the symbol passed as the +name+ argument, so
1679
- # <tt>has_and_belongs_to_many :categories</tt> would add among others <tt>categories.empty?</tt>.
1680
- #
1681
- # [collection]
1682
- # Returns a Relation of all the associated objects.
1683
- # An empty Relation is returned if none are found.
1684
- # [collection<<(object, ...)]
1685
- # Adds one or more objects to the collection by creating associations in the join table
1686
- # (<tt>collection.push</tt> and <tt>collection.concat</tt> are aliases to this method).
1687
- # Note that this operation instantly fires update SQL without waiting for the save or update call on the
1688
- # parent object, unless the parent object is a new record.
1689
- # [collection.delete(object, ...)]
1690
- # Removes one or more objects from the collection by removing their associations from the join table.
1691
- # This does not destroy the objects.
1692
- # [collection.destroy(object, ...)]
1693
- # Removes one or more objects from the collection by running destroy on each association in the join table, overriding any dependent option.
1694
- # This does not destroy the objects.
1695
- # [collection=objects]
1696
- # Replaces the collection's content by deleting and adding objects as appropriate.
1697
- # [collection_singular_ids]
1698
- # Returns an array of the associated objects' ids.
1699
- # [collection_singular_ids=ids]
1700
- # Replace the collection by the objects identified by the primary keys in +ids+.
1701
- # [collection.clear]
1702
- # Removes every object from the collection. This does not destroy the objects.
1703
- # [collection.empty?]
1704
- # Returns +true+ if there are no associated objects.
1705
- # [collection.size]
1706
- # Returns the number of associated objects.
1707
- # [collection.find(id)]
1708
- # Finds an associated object responding to the +id+ and that
1709
- # meets the condition that it has to be associated with this object.
1710
- # Uses the same rules as ActiveRecord::FinderMethods#find.
1711
- # [collection.exists?(...)]
1712
- # Checks whether an associated object with the given conditions exists.
1713
- # Uses the same rules as ActiveRecord::FinderMethods#exists?.
1714
- # [collection.build(attributes = {})]
1715
- # Returns a new object of the collection type that has been instantiated
1716
- # with +attributes+ and linked to this object through the join table, but has not yet been saved.
1717
- # [collection.create(attributes = {})]
1718
- # Returns a new object of the collection type that has been instantiated
1719
- # with +attributes+, linked to this object through the join table, and that has already been
1720
- # saved (if it passed the validation).
1721
- # [collection.reload]
1722
- # Returns a Relation of all of the associated objects, forcing a database read.
1723
- # An empty Relation is returned if none are found.
1724
- #
1725
- # === Example
1726
- #
1727
- # A Developer class declares <tt>has_and_belongs_to_many :projects</tt>, which will add:
1728
- # * <tt>Developer#projects</tt>
1729
- # * <tt>Developer#projects<<</tt>
1730
- # * <tt>Developer#projects.delete</tt>
1731
- # * <tt>Developer#projects.destroy</tt>
1732
- # * <tt>Developer#projects=</tt>
1733
- # * <tt>Developer#project_ids</tt>
1734
- # * <tt>Developer#project_ids=</tt>
1735
- # * <tt>Developer#projects.clear</tt>
1736
- # * <tt>Developer#projects.empty?</tt>
1737
- # * <tt>Developer#projects.size</tt>
1738
- # * <tt>Developer#projects.find(id)</tt>
1739
- # * <tt>Developer#projects.exists?(...)</tt>
1740
- # * <tt>Developer#projects.build</tt> (similar to <tt>Project.new("developer_id" => id)</tt>)
1741
- # * <tt>Developer#projects.create</tt> (similar to <tt>c = Project.new("developer_id" => id); c.save; c</tt>)
1742
- # * <tt>Developer#projects.reload</tt>
1743
- # The declaration may include an +options+ hash to specialize the behavior of the association.
1744
- #
1745
- # === Scopes
1746
- #
1747
- # You can pass a second argument +scope+ as a callable (i.e. proc or
1748
- # lambda) to retrieve a specific set of records or customize the generated
1749
- # query when you access the associated collection.
1750
- #
1751
- # Scope examples:
1752
- # has_and_belongs_to_many :projects, -> { includes(:milestones, :manager) }
1753
- # has_and_belongs_to_many :categories, ->(category) {
1754
- # where("default_category = ?", category.name)
1755
- # }
1756
- #
1757
- # === Extensions
1758
- #
1759
- # The +extension+ argument allows you to pass a block into a
1760
- # has_and_belongs_to_many association. This is useful for adding new
1761
- # finders, creators and other factory-type methods to be used as part of
1762
- # the association.
1763
- #
1764
- # Extension examples:
1765
- # has_and_belongs_to_many :contractors do
577
+ # person = Account.first.people.find_or_create_by_name("David Heinemeier Hansson")
578
+ # person.first_name # => "David"
579
+ # person.last_name # => "Heinemeier Hansson"
580
+ #
581
+ # If you need to share the same extensions between many associations, you can use a named
582
+ # extension module.
583
+ #
584
+ # module FindOrCreateByNameExtension
1766
585
  # def find_or_create_by_name(name)
1767
586
  # first_name, last_name = name.split(" ", 2)
1768
587
  # find_or_create_by(first_name: first_name, last_name: last_name)
1769
588
  # end
1770
589
  # end
1771
590
  #
1772
- # === Options
1773
- #
1774
- # [:class_name]
1775
- # Specify the class name of the association. Use it only if that name can't be inferred
1776
- # from the association name. So <tt>has_and_belongs_to_many :projects</tt> will by default be linked to the
1777
- # Project class, but if the real class name is SuperProject, you'll have to specify it with this option.
1778
- # [:join_table]
1779
- # Specify the name of the join table if the default based on lexical order isn't what you want.
1780
- # <b>WARNING:</b> If you're overwriting the table name of either class, the +table_name+ method
1781
- # MUST be declared underneath any #has_and_belongs_to_many declaration in order to work.
1782
- # [:foreign_key]
1783
- # Specify the foreign key used for the association. By default this is guessed to be the name
1784
- # of this class in lower-case and "_id" suffixed. So a Person class that makes
1785
- # a #has_and_belongs_to_many association to Project will use "person_id" as the
1786
- # default <tt>:foreign_key</tt>.
1787
- # [:association_foreign_key]
1788
- # Specify the foreign key used for the association on the receiving side of the association.
1789
- # By default this is guessed to be the name of the associated class in lower-case and "_id" suffixed.
1790
- # So if a Person class makes a #has_and_belongs_to_many association to Project,
1791
- # the association will use "project_id" as the default <tt>:association_foreign_key</tt>.
1792
- # [:validate]
1793
- # When set to +true+, validates new objects added to association when saving the parent object. +true+ by default.
1794
- # If you want to ensure associated objects are revalidated on every update, use +validates_associated+.
1795
- # [:autosave]
1796
- # If true, always save the associated objects or destroy them if marked for destruction, when
1797
- # saving the parent object.
1798
- # If false, never save or destroy the associated objects.
1799
- # By default, only save associated objects that are new records.
1800
- #
1801
- # Note that NestedAttributes::ClassMethods#accepts_nested_attributes_for sets
1802
- # <tt>:autosave</tt> to <tt>true</tt>.
1803
- #
1804
- # Option examples:
1805
- # has_and_belongs_to_many :projects
1806
- # has_and_belongs_to_many :projects, -> { includes(:milestones, :manager) }
1807
- # has_and_belongs_to_many :nations, class_name: "Country"
1808
- # has_and_belongs_to_many :categories, join_table: "prods_cats"
1809
- # has_and_belongs_to_many :categories, -> { readonly }
1810
- def has_and_belongs_to_many(name, scope = nil, options = {}, &extension)
1811
- if scope.is_a?(Hash)
1812
- options = scope
1813
- scope = nil
591
+ # class Account < ActiveRecord::Base
592
+ # has_many :people, -> { extending FindOrCreateByNameExtension }
593
+ # end
594
+ #
595
+ # class Company < ActiveRecord::Base
596
+ # has_many :people, -> { extending FindOrCreateByNameExtension }
597
+ # end
598
+ #
599
+ # Some extensions can only be made to work with knowledge of the association's internals.
600
+ # Extensions can access relevant state using the following methods (where +items+ is the
601
+ # name of the association):
602
+ #
603
+ # * <tt>record.association(:items).owner</tt> - Returns the object the association is part of.
604
+ # * <tt>record.association(:items).reflection</tt> - Returns the reflection object that describes the association.
605
+ # * <tt>record.association(:items).target</tt> - Returns the associated object for #belongs_to and #has_one, or
606
+ # the collection of associated objects for #has_many and #has_and_belongs_to_many.
607
+ #
608
+ # However, inside the actual extension code, you will not have access to the <tt>record</tt> as
609
+ # above. In this case, you can access <tt>proxy_association</tt>. For example,
610
+ # <tt>record.association(:items)</tt> and <tt>record.items.proxy_association</tt> will return
611
+ # the same object, allowing you to make calls like <tt>proxy_association.owner</tt> inside
612
+ # association extensions.
613
+ #
614
+ # == Association Join Models
615
+ #
616
+ # Has Many associations can be configured with the <tt>:through</tt> option to use an
617
+ # explicit join model to retrieve the data. This operates similarly to a
618
+ # #has_and_belongs_to_many association. The advantage is that you're able to add validations,
619
+ # callbacks, and extra attributes on the join model. Consider the following schema:
620
+ #
621
+ # class Author < ActiveRecord::Base
622
+ # has_many :authorships
623
+ # has_many :books, through: :authorships
624
+ # end
625
+ #
626
+ # class Authorship < ActiveRecord::Base
627
+ # belongs_to :author
628
+ # belongs_to :book
629
+ # end
630
+ #
631
+ # @author = Author.first
632
+ # @author.authorships.collect { |a| a.book } # selects all books that the author's authorships belong to
633
+ # @author.books # selects all books by using the Authorship join model
634
+ #
635
+ # You can also go through a #has_many association on the join model:
636
+ #
637
+ # class Firm < ActiveRecord::Base
638
+ # has_many :clients
639
+ # has_many :invoices, through: :clients
640
+ # end
641
+ #
642
+ # class Client < ActiveRecord::Base
643
+ # belongs_to :firm
644
+ # has_many :invoices
645
+ # end
646
+ #
647
+ # class Invoice < ActiveRecord::Base
648
+ # belongs_to :client
649
+ # end
650
+ #
651
+ # @firm = Firm.first
652
+ # @firm.clients.flat_map { |c| c.invoices } # select all invoices for all clients of the firm
653
+ # @firm.invoices # selects all invoices by going through the Client join model
654
+ #
655
+ # Similarly you can go through a #has_one association on the join model:
656
+ #
657
+ # class Group < ActiveRecord::Base
658
+ # has_many :users
659
+ # has_many :avatars, through: :users
660
+ # end
661
+ #
662
+ # class User < ActiveRecord::Base
663
+ # belongs_to :group
664
+ # has_one :avatar
665
+ # end
666
+ #
667
+ # class Avatar < ActiveRecord::Base
668
+ # belongs_to :user
669
+ # end
670
+ #
671
+ # @group = Group.first
672
+ # @group.users.collect { |u| u.avatar }.compact # select all avatars for all users in the group
673
+ # @group.avatars # selects all avatars by going through the User join model.
674
+ #
675
+ # An important caveat with going through #has_one or #has_many associations on the
676
+ # join model is that these associations are *read-only*. For example, the following
677
+ # would not work following the previous example:
678
+ #
679
+ # @group.avatars << Avatar.new # this would work if User belonged_to Avatar rather than the other way around
680
+ # @group.avatars.delete(@group.avatars.last) # so would this
681
+ #
682
+ # == Setting Inverses
683
+ #
684
+ # If you are using a #belongs_to on the join model, it is a good idea to set the
685
+ # <tt>:inverse_of</tt> option on the #belongs_to, which will mean that the following example
686
+ # works correctly (where <tt>tags</tt> is a #has_many <tt>:through</tt> association):
687
+ #
688
+ # @post = Post.first
689
+ # @tag = @post.tags.build name: "ruby"
690
+ # @tag.save
691
+ #
692
+ # The last line ought to save the through record (a <tt>Tagging</tt>). This will only work if the
693
+ # <tt>:inverse_of</tt> is set:
694
+ #
695
+ # class Tagging < ActiveRecord::Base
696
+ # belongs_to :post
697
+ # belongs_to :tag, inverse_of: :taggings
698
+ # end
699
+ #
700
+ # If you do not set the <tt>:inverse_of</tt> record, the association will
701
+ # do its best to match itself up with the correct inverse. Automatic
702
+ # inverse detection only works on #has_many, #has_one, and
703
+ # #belongs_to associations.
704
+ #
705
+ # Extra options on the associations, as defined in the
706
+ # <tt>AssociationReflection::INVALID_AUTOMATIC_INVERSE_OPTIONS</tt>
707
+ # constant, or a custom scope, will also prevent the association's inverse
708
+ # from being found automatically.
709
+ #
710
+ # The automatic guessing of the inverse association uses a heuristic based
711
+ # on the name of the class, so it may not work for all associations,
712
+ # especially the ones with non-standard names.
713
+ #
714
+ # You can turn off the automatic detection of inverse associations by setting
715
+ # the <tt>:inverse_of</tt> option to <tt>false</tt> like so:
716
+ #
717
+ # class Tagging < ActiveRecord::Base
718
+ # belongs_to :tag, inverse_of: false
719
+ # end
720
+ #
721
+ # == Nested \Associations
722
+ #
723
+ # You can actually specify *any* association with the <tt>:through</tt> option, including an
724
+ # association which has a <tt>:through</tt> option itself. For example:
725
+ #
726
+ # class Author < ActiveRecord::Base
727
+ # has_many :posts
728
+ # has_many :comments, through: :posts
729
+ # has_many :commenters, through: :comments
730
+ # end
731
+ #
732
+ # class Post < ActiveRecord::Base
733
+ # has_many :comments
734
+ # end
735
+ #
736
+ # class Comment < ActiveRecord::Base
737
+ # belongs_to :commenter
738
+ # end
739
+ #
740
+ # @author = Author.first
741
+ # @author.commenters # => People who commented on posts written by the author
742
+ #
743
+ # An equivalent way of setting up this association this would be:
744
+ #
745
+ # class Author < ActiveRecord::Base
746
+ # has_many :posts
747
+ # has_many :commenters, through: :posts
748
+ # end
749
+ #
750
+ # class Post < ActiveRecord::Base
751
+ # has_many :comments
752
+ # has_many :commenters, through: :comments
753
+ # end
754
+ #
755
+ # class Comment < ActiveRecord::Base
756
+ # belongs_to :commenter
757
+ # end
758
+ #
759
+ # When using a nested association, you will not be able to modify the association because there
760
+ # is not enough information to know what modification to make. For example, if you tried to
761
+ # add a <tt>Commenter</tt> in the example above, there would be no way to tell how to set up the
762
+ # intermediate <tt>Post</tt> and <tt>Comment</tt> objects.
763
+ #
764
+ # == Polymorphic \Associations
765
+ #
766
+ # Polymorphic associations on models are not restricted on what types of models they
767
+ # can be associated with. Rather, they specify an interface that a #has_many association
768
+ # must adhere to.
769
+ #
770
+ # class Asset < ActiveRecord::Base
771
+ # belongs_to :attachable, polymorphic: true
772
+ # end
773
+ #
774
+ # class Post < ActiveRecord::Base
775
+ # has_many :assets, as: :attachable # The :as option specifies the polymorphic interface to use.
776
+ # end
777
+ #
778
+ # @asset.attachable = @post
779
+ #
780
+ # This works by using a type column in addition to a foreign key to specify the associated
781
+ # record. In the Asset example, you'd need an +attachable_id+ integer column and an
782
+ # +attachable_type+ string column.
783
+ #
784
+ # Using polymorphic associations in combination with single table inheritance (STI) is
785
+ # a little tricky. In order for the associations to work as expected, ensure that you
786
+ # store the base model for the STI models in the type column of the polymorphic
787
+ # association. To continue with the asset example above, suppose there are guest posts
788
+ # and member posts that use the posts table for STI. In this case, there must be a +type+
789
+ # column in the posts table.
790
+ #
791
+ # Note: The <tt>attachable_type=</tt> method is being called when assigning an +attachable+.
792
+ # The +class_name+ of the +attachable+ is passed as a String.
793
+ #
794
+ # class Asset < ActiveRecord::Base
795
+ # belongs_to :attachable, polymorphic: true
796
+ #
797
+ # def attachable_type=(class_name)
798
+ # super(class_name.constantize.base_class.to_s)
799
+ # end
800
+ # end
801
+ #
802
+ # class Post < ActiveRecord::Base
803
+ # # because we store "Post" in attachable_type now dependent: :destroy will work
804
+ # has_many :assets, as: :attachable, dependent: :destroy
805
+ # end
806
+ #
807
+ # class GuestPost < Post
808
+ # end
809
+ #
810
+ # class MemberPost < Post
811
+ # end
812
+ #
813
+ # == Caching
814
+ #
815
+ # All of the methods are built on a simple caching principle that will keep the result
816
+ # of the last query around unless specifically instructed not to. The cache is even
817
+ # shared across methods to make it even cheaper to use the macro-added methods without
818
+ # worrying too much about performance at the first go.
819
+ #
820
+ # project.milestones # fetches milestones from the database
821
+ # project.milestones.size # uses the milestone cache
822
+ # project.milestones.empty? # uses the milestone cache
823
+ # project.milestones.reload.size # fetches milestones from the database
824
+ # project.milestones # uses the milestone cache
825
+ #
826
+ # == Eager loading of associations
827
+ #
828
+ # Eager loading is a way to find objects of a certain class and a number of named associations.
829
+ # It is one of the easiest ways to prevent the dreaded N+1 problem in which fetching 100
830
+ # posts that each need to display their author triggers 101 database queries. Through the
831
+ # use of eager loading, the number of queries will be reduced from 101 to 2.
832
+ #
833
+ # class Post < ActiveRecord::Base
834
+ # belongs_to :author
835
+ # has_many :comments
836
+ # end
837
+ #
838
+ # Consider the following loop using the class above:
839
+ #
840
+ # Post.all.each do |post|
841
+ # puts "Post: " + post.title
842
+ # puts "Written by: " + post.author.name
843
+ # puts "Last comment on: " + post.comments.first.created_on
844
+ # end
845
+ #
846
+ # To iterate over these one hundred posts, we'll generate 201 database queries. Let's
847
+ # first just optimize it for retrieving the author:
848
+ #
849
+ # Post.includes(:author).each do |post|
850
+ #
851
+ # This references the name of the #belongs_to association that also used the <tt>:author</tt>
852
+ # symbol. After loading the posts, +find+ will collect the +author_id+ from each one and load
853
+ # all of the referenced authors with one query. Doing so will cut down the number of queries
854
+ # from 201 to 102.
855
+ #
856
+ # We can improve upon the situation further by referencing both associations in the finder with:
857
+ #
858
+ # Post.includes(:author, :comments).each do |post|
859
+ #
860
+ # This will load all comments with a single query. This reduces the total number of queries
861
+ # to 3. In general, the number of queries will be 1 plus the number of associations
862
+ # named (except if some of the associations are polymorphic #belongs_to - see below).
863
+ #
864
+ # To include a deep hierarchy of associations, use a hash:
865
+ #
866
+ # Post.includes(:author, { comments: { author: :gravatar } }).each do |post|
867
+ #
868
+ # The above code will load all the comments and all of their associated
869
+ # authors and gravatars. You can mix and match any combination of symbols,
870
+ # arrays, and hashes to retrieve the associations you want to load.
871
+ #
872
+ # All of this power shouldn't fool you into thinking that you can pull out huge amounts
873
+ # of data with no performance penalty just because you've reduced the number of queries.
874
+ # The database still needs to send all the data to Active Record and it still needs to
875
+ # be processed. So it's no catch-all for performance problems, but it's a great way to
876
+ # cut down on the number of queries in a situation as the one described above.
877
+ #
878
+ # Since only one table is loaded at a time, conditions or orders cannot reference tables
879
+ # other than the main one. If this is the case, Active Record falls back to the previously
880
+ # used <tt>LEFT OUTER JOIN</tt> based strategy. For example:
881
+ #
882
+ # Post.includes([:author, :comments]).where(['comments.approved = ?', true])
883
+ #
884
+ # This will result in a single SQL query with joins along the lines of:
885
+ # <tt>LEFT OUTER JOIN comments ON comments.post_id = posts.id</tt> and
886
+ # <tt>LEFT OUTER JOIN authors ON authors.id = posts.author_id</tt>. Note that using conditions
887
+ # like this can have unintended consequences.
888
+ # In the above example, posts with no approved comments are not returned at all because
889
+ # the conditions apply to the SQL statement as a whole and not just to the association.
890
+ #
891
+ # You must disambiguate column references for this fallback to happen, for example
892
+ # <tt>order: "author.name DESC"</tt> will work but <tt>order: "name DESC"</tt> will not.
893
+ #
894
+ # If you want to load all posts (including posts with no approved comments), then write
895
+ # your own <tt>LEFT OUTER JOIN</tt> query using <tt>ON</tt>:
896
+ #
897
+ # Post.joins("LEFT OUTER JOIN comments ON comments.post_id = posts.id AND comments.approved = '1'")
898
+ #
899
+ # In this case, it is usually more natural to include an association which has conditions defined on it:
900
+ #
901
+ # class Post < ActiveRecord::Base
902
+ # has_many :approved_comments, -> { where(approved: true) }, class_name: 'Comment'
903
+ # end
904
+ #
905
+ # Post.includes(:approved_comments)
906
+ #
907
+ # This will load posts and eager load the +approved_comments+ association, which contains
908
+ # only those comments that have been approved.
909
+ #
910
+ # If you eager load an association with a specified <tt>:limit</tt> option, it will be ignored,
911
+ # returning all the associated objects:
912
+ #
913
+ # class Picture < ActiveRecord::Base
914
+ # has_many :most_recent_comments, -> { order('id DESC').limit(10) }, class_name: 'Comment'
915
+ # end
916
+ #
917
+ # Picture.includes(:most_recent_comments).first.most_recent_comments # => returns all associated comments.
918
+ #
919
+ # Eager loading is supported with polymorphic associations.
920
+ #
921
+ # class Address < ActiveRecord::Base
922
+ # belongs_to :addressable, polymorphic: true
923
+ # end
924
+ #
925
+ # A call that tries to eager load the addressable model
926
+ #
927
+ # Address.includes(:addressable)
928
+ #
929
+ # This will execute one query to load the addresses and load the addressables with one
930
+ # query per addressable type.
931
+ # For example, if all the addressables are either of class Person or Company, then a total
932
+ # of 3 queries will be executed. The list of addressable types to load is determined on
933
+ # the back of the addresses loaded. This is not supported if Active Record has to fallback
934
+ # to the previous implementation of eager loading and will raise ActiveRecord::EagerLoadPolymorphicError.
935
+ # The reason is that the parent model's type is a column value so its corresponding table
936
+ # name cannot be put in the +FROM+/+JOIN+ clauses of that query.
937
+ #
938
+ # == Table Aliasing
939
+ #
940
+ # Active Record uses table aliasing in the case that a table is referenced multiple times
941
+ # in a join. If a table is referenced only once, the standard table name is used. The
942
+ # second time, the table is aliased as <tt>#{reflection_name}_#{parent_table_name}</tt>.
943
+ # Indexes are appended for any more successive uses of the table name.
944
+ #
945
+ # Post.joins(:comments)
946
+ # # => SELECT ... FROM posts INNER JOIN comments ON ...
947
+ # Post.joins(:special_comments) # STI
948
+ # # => SELECT ... FROM posts INNER JOIN comments ON ... AND comments.type = 'SpecialComment'
949
+ # Post.joins(:comments, :special_comments) # special_comments is the reflection name, posts is the parent table name
950
+ # # => SELECT ... FROM posts INNER JOIN comments ON ... INNER JOIN comments special_comments_posts
951
+ #
952
+ # Acts as tree example:
953
+ #
954
+ # TreeMixin.joins(:children)
955
+ # # => SELECT ... FROM mixins INNER JOIN mixins childrens_mixins ...
956
+ # TreeMixin.joins(children: :parent)
957
+ # # => SELECT ... FROM mixins INNER JOIN mixins childrens_mixins ...
958
+ # INNER JOIN parents_mixins ...
959
+ # TreeMixin.joins(children: {parent: :children})
960
+ # # => SELECT ... FROM mixins INNER JOIN mixins childrens_mixins ...
961
+ # INNER JOIN parents_mixins ...
962
+ # INNER JOIN mixins childrens_mixins_2
963
+ #
964
+ # Has and Belongs to Many join tables use the same idea, but add a <tt>_join</tt> suffix:
965
+ #
966
+ # Post.joins(:categories)
967
+ # # => SELECT ... FROM posts INNER JOIN categories_posts ... INNER JOIN categories ...
968
+ # Post.joins(categories: :posts)
969
+ # # => SELECT ... FROM posts INNER JOIN categories_posts ... INNER JOIN categories ...
970
+ # INNER JOIN categories_posts posts_categories_join INNER JOIN posts posts_categories
971
+ # Post.joins(categories: {posts: :categories})
972
+ # # => SELECT ... FROM posts INNER JOIN categories_posts ... INNER JOIN categories ...
973
+ # INNER JOIN categories_posts posts_categories_join INNER JOIN posts posts_categories
974
+ # INNER JOIN categories_posts categories_posts_join INNER JOIN categories categories_posts_2
975
+ #
976
+ # If you wish to specify your own custom joins using ActiveRecord::QueryMethods#joins method, those table
977
+ # names will take precedence over the eager associations:
978
+ #
979
+ # Post.joins(:comments).joins("inner join comments ...")
980
+ # # => SELECT ... FROM posts INNER JOIN comments_posts ON ... INNER JOIN comments ...
981
+ # Post.joins(:comments, :special_comments).joins("inner join comments ...")
982
+ # # => SELECT ... FROM posts INNER JOIN comments comments_posts ON ...
983
+ # INNER JOIN comments special_comments_posts ...
984
+ # INNER JOIN comments ...
985
+ #
986
+ # Table aliases are automatically truncated according to the maximum length of table identifiers
987
+ # according to the specific database.
988
+ #
989
+ # == Modules
990
+ #
991
+ # By default, associations will look for objects within the current module scope. Consider:
992
+ #
993
+ # module MyApplication
994
+ # module Business
995
+ # class Firm < ActiveRecord::Base
996
+ # has_many :clients
997
+ # end
998
+ #
999
+ # class Client < ActiveRecord::Base; end
1000
+ # end
1001
+ # end
1002
+ #
1003
+ # When <tt>Firm#clients</tt> is called, it will in turn call
1004
+ # <tt>MyApplication::Business::Client.find_all_by_firm_id(firm.id)</tt>.
1005
+ # If you want to associate with a class in another module scope, this can be done by
1006
+ # specifying the complete class name.
1007
+ #
1008
+ # module MyApplication
1009
+ # module Business
1010
+ # class Firm < ActiveRecord::Base; end
1011
+ # end
1012
+ #
1013
+ # module Billing
1014
+ # class Account < ActiveRecord::Base
1015
+ # belongs_to :firm, class_name: "MyApplication::Business::Firm"
1016
+ # end
1017
+ # end
1018
+ # end
1019
+ #
1020
+ # == Bi-directional associations
1021
+ #
1022
+ # When you specify an association, there is usually an association on the associated model
1023
+ # that specifies the same relationship in reverse. For example, with the following models:
1024
+ #
1025
+ # class Dungeon < ActiveRecord::Base
1026
+ # has_many :traps
1027
+ # has_one :evil_wizard
1028
+ # end
1029
+ #
1030
+ # class Trap < ActiveRecord::Base
1031
+ # belongs_to :dungeon
1032
+ # end
1033
+ #
1034
+ # class EvilWizard < ActiveRecord::Base
1035
+ # belongs_to :dungeon
1036
+ # end
1037
+ #
1038
+ # The +traps+ association on +Dungeon+ and the +dungeon+ association on +Trap+ are
1039
+ # the inverse of each other, and the inverse of the +dungeon+ association on +EvilWizard+
1040
+ # is the +evil_wizard+ association on +Dungeon+ (and vice-versa). By default,
1041
+ # Active Record can guess the inverse of the association based on the name
1042
+ # of the class. The result is the following:
1043
+ #
1044
+ # d = Dungeon.first
1045
+ # t = d.traps.first
1046
+ # d.object_id == t.dungeon.object_id # => true
1047
+ #
1048
+ # The +Dungeon+ instances +d+ and <tt>t.dungeon</tt> in the above example refer to
1049
+ # the same in-memory instance since the association matches the name of the class.
1050
+ # The result would be the same if we added +:inverse_of+ to our model definitions:
1051
+ #
1052
+ # class Dungeon < ActiveRecord::Base
1053
+ # has_many :traps, inverse_of: :dungeon
1054
+ # has_one :evil_wizard, inverse_of: :dungeon
1055
+ # end
1056
+ #
1057
+ # class Trap < ActiveRecord::Base
1058
+ # belongs_to :dungeon, inverse_of: :traps
1059
+ # end
1060
+ #
1061
+ # class EvilWizard < ActiveRecord::Base
1062
+ # belongs_to :dungeon, inverse_of: :evil_wizard
1063
+ # end
1064
+ #
1065
+ # For more information, see the documentation for the +:inverse_of+ option.
1066
+ #
1067
+ # == Deleting from associations
1068
+ #
1069
+ # === Dependent associations
1070
+ #
1071
+ # #has_many, #has_one, and #belongs_to associations support the <tt>:dependent</tt> option.
1072
+ # This allows you to specify that associated records should be deleted when the owner is
1073
+ # deleted.
1074
+ #
1075
+ # For example:
1076
+ #
1077
+ # class Author
1078
+ # has_many :posts, dependent: :destroy
1079
+ # end
1080
+ # Author.find(1).destroy # => Will destroy all of the author's posts, too
1081
+ #
1082
+ # The <tt>:dependent</tt> option can have different values which specify how the deletion
1083
+ # is done. For more information, see the documentation for this option on the different
1084
+ # specific association types. When no option is given, the behavior is to do nothing
1085
+ # with the associated records when destroying a record.
1086
+ #
1087
+ # Note that <tt>:dependent</tt> is implemented using Rails' callback
1088
+ # system, which works by processing callbacks in order. Therefore, other
1089
+ # callbacks declared either before or after the <tt>:dependent</tt> option
1090
+ # can affect what it does.
1091
+ #
1092
+ # Note that <tt>:dependent</tt> option is ignored for #has_one <tt>:through</tt> associations.
1093
+ #
1094
+ # === Delete or destroy?
1095
+ #
1096
+ # #has_many and #has_and_belongs_to_many associations have the methods <tt>destroy</tt>,
1097
+ # <tt>delete</tt>, <tt>destroy_all</tt> and <tt>delete_all</tt>.
1098
+ #
1099
+ # For #has_and_belongs_to_many, <tt>delete</tt> and <tt>destroy</tt> are the same: they
1100
+ # cause the records in the join table to be removed.
1101
+ #
1102
+ # For #has_many, <tt>destroy</tt> and <tt>destroy_all</tt> will always call the <tt>destroy</tt> method of the
1103
+ # record(s) being removed so that callbacks are run. However <tt>delete</tt> and <tt>delete_all</tt> will either
1104
+ # do the deletion according to the strategy specified by the <tt>:dependent</tt> option, or
1105
+ # if no <tt>:dependent</tt> option is given, then it will follow the default strategy.
1106
+ # The default strategy is to do nothing (leave the foreign keys with the parent ids set), except for
1107
+ # #has_many <tt>:through</tt>, where the default strategy is <tt>delete_all</tt> (delete
1108
+ # the join records, without running their callbacks).
1109
+ #
1110
+ # There is also a <tt>clear</tt> method which is the same as <tt>delete_all</tt>, except that
1111
+ # it returns the association rather than the records which have been deleted.
1112
+ #
1113
+ # === What gets deleted?
1114
+ #
1115
+ # There is a potential pitfall here: #has_and_belongs_to_many and #has_many <tt>:through</tt>
1116
+ # associations have records in join tables, as well as the associated records. So when we
1117
+ # call one of these deletion methods, what exactly should be deleted?
1118
+ #
1119
+ # The answer is that it is assumed that deletion on an association is about removing the
1120
+ # <i>link</i> between the owner and the associated object(s), rather than necessarily the
1121
+ # associated objects themselves. So with #has_and_belongs_to_many and #has_many
1122
+ # <tt>:through</tt>, the join records will be deleted, but the associated records won't.
1123
+ #
1124
+ # This makes sense if you think about it: if you were to call <tt>post.tags.delete(Tag.find_by(name: 'food'))</tt>
1125
+ # you would want the 'food' tag to be unlinked from the post, rather than for the tag itself
1126
+ # to be removed from the database.
1127
+ #
1128
+ # However, there are examples where this strategy doesn't make sense. For example, suppose
1129
+ # a person has many projects, and each project has many tasks. If we deleted one of a person's
1130
+ # tasks, we would probably not want the project to be deleted. In this scenario, the delete method
1131
+ # won't actually work: it can only be used if the association on the join model is a
1132
+ # #belongs_to. In other situations you are expected to perform operations directly on
1133
+ # either the associated records or the <tt>:through</tt> association.
1134
+ #
1135
+ # With a regular #has_many there is no distinction between the "associated records"
1136
+ # and the "link", so there is only one choice for what gets deleted.
1137
+ #
1138
+ # With #has_and_belongs_to_many and #has_many <tt>:through</tt>, if you want to delete the
1139
+ # associated records themselves, you can always do something along the lines of
1140
+ # <tt>person.tasks.each(&:destroy)</tt>.
1141
+ #
1142
+ # == Type safety with ActiveRecord::AssociationTypeMismatch
1143
+ #
1144
+ # If you attempt to assign an object to an association that doesn't match the inferred
1145
+ # or specified <tt>:class_name</tt>, you'll get an ActiveRecord::AssociationTypeMismatch.
1146
+ #
1147
+ # == Options
1148
+ #
1149
+ # All of the association macros can be specialized through options. This makes cases
1150
+ # more complex than the simple and guessable ones possible.
1151
+ module ClassMethods
1152
+ # Specifies a one-to-many association. The following methods for retrieval and query of
1153
+ # collections of associated objects will be added:
1154
+ #
1155
+ # +collection+ is a placeholder for the symbol passed as the +name+ argument, so
1156
+ # <tt>has_many :clients</tt> would add among others <tt>clients.empty?</tt>.
1157
+ #
1158
+ # [collection]
1159
+ # Returns a Relation of all the associated objects.
1160
+ # An empty Relation is returned if none are found.
1161
+ # [collection<<(object, ...)]
1162
+ # Adds one or more objects to the collection by setting their foreign keys to the collection's primary key.
1163
+ # Note that this operation instantly fires update SQL without waiting for the save or update call on the
1164
+ # parent object, unless the parent object is a new record.
1165
+ # This will also run validations and callbacks of associated object(s).
1166
+ # [collection.delete(object, ...)]
1167
+ # Removes one or more objects from the collection by setting their foreign keys to +NULL+.
1168
+ # Objects will be in addition destroyed if they're associated with <tt>dependent: :destroy</tt>,
1169
+ # and deleted if they're associated with <tt>dependent: :delete_all</tt>.
1170
+ #
1171
+ # If the <tt>:through</tt> option is used, then the join records are deleted (rather than
1172
+ # nullified) by default, but you can specify <tt>dependent: :destroy</tt> or
1173
+ # <tt>dependent: :nullify</tt> to override this.
1174
+ # [collection.destroy(object, ...)]
1175
+ # Removes one or more objects from the collection by running <tt>destroy</tt> on
1176
+ # each record, regardless of any dependent option, ensuring callbacks are run.
1177
+ #
1178
+ # If the <tt>:through</tt> option is used, then the join records are destroyed
1179
+ # instead, not the objects themselves.
1180
+ # [collection=objects]
1181
+ # Replaces the collections content by deleting and adding objects as appropriate. If the <tt>:through</tt>
1182
+ # option is true callbacks in the join models are triggered except destroy callbacks, since deletion is
1183
+ # direct by default. You can specify <tt>dependent: :destroy</tt> or
1184
+ # <tt>dependent: :nullify</tt> to override this.
1185
+ # [collection_singular_ids]
1186
+ # Returns an array of the associated objects' ids
1187
+ # [collection_singular_ids=ids]
1188
+ # Replace the collection with the objects identified by the primary keys in +ids+. This
1189
+ # method loads the models and calls <tt>collection=</tt>. See above.
1190
+ # [collection.clear]
1191
+ # Removes every object from the collection. This destroys the associated objects if they
1192
+ # are associated with <tt>dependent: :destroy</tt>, deletes them directly from the
1193
+ # database if <tt>dependent: :delete_all</tt>, otherwise sets their foreign keys to +NULL+.
1194
+ # If the <tt>:through</tt> option is true no destroy callbacks are invoked on the join models.
1195
+ # Join models are directly deleted.
1196
+ # [collection.empty?]
1197
+ # Returns +true+ if there are no associated objects.
1198
+ # [collection.size]
1199
+ # Returns the number of associated objects.
1200
+ # [collection.find(...)]
1201
+ # Finds an associated object according to the same rules as ActiveRecord::FinderMethods#find.
1202
+ # [collection.exists?(...)]
1203
+ # Checks whether an associated object with the given conditions exists.
1204
+ # Uses the same rules as ActiveRecord::FinderMethods#exists?.
1205
+ # [collection.build(attributes = {}, ...)]
1206
+ # Returns one or more new objects of the collection type that have been instantiated
1207
+ # with +attributes+ and linked to this object through a foreign key, but have not yet
1208
+ # been saved.
1209
+ # [collection.create(attributes = {})]
1210
+ # Returns a new object of the collection type that has been instantiated
1211
+ # with +attributes+, linked to this object through a foreign key, and that has already
1212
+ # been saved (if it passed the validation). *Note*: This only works if the base model
1213
+ # already exists in the DB, not if it is a new (unsaved) record!
1214
+ # [collection.create!(attributes = {})]
1215
+ # Does the same as <tt>collection.create</tt>, but raises ActiveRecord::RecordInvalid
1216
+ # if the record is invalid.
1217
+ # [collection.reload]
1218
+ # Returns a Relation of all of the associated objects, forcing a database read.
1219
+ # An empty Relation is returned if none are found.
1220
+ #
1221
+ # === Example
1222
+ #
1223
+ # A <tt>Firm</tt> class declares <tt>has_many :clients</tt>, which will add:
1224
+ # * <tt>Firm#clients</tt> (similar to <tt>Client.where(firm_id: id)</tt>)
1225
+ # * <tt>Firm#clients<<</tt>
1226
+ # * <tt>Firm#clients.delete</tt>
1227
+ # * <tt>Firm#clients.destroy</tt>
1228
+ # * <tt>Firm#clients=</tt>
1229
+ # * <tt>Firm#client_ids</tt>
1230
+ # * <tt>Firm#client_ids=</tt>
1231
+ # * <tt>Firm#clients.clear</tt>
1232
+ # * <tt>Firm#clients.empty?</tt> (similar to <tt>firm.clients.size == 0</tt>)
1233
+ # * <tt>Firm#clients.size</tt> (similar to <tt>Client.count "firm_id = #{id}"</tt>)
1234
+ # * <tt>Firm#clients.find</tt> (similar to <tt>Client.where(firm_id: id).find(id)</tt>)
1235
+ # * <tt>Firm#clients.exists?(name: 'ACME')</tt> (similar to <tt>Client.exists?(name: 'ACME', firm_id: firm.id)</tt>)
1236
+ # * <tt>Firm#clients.build</tt> (similar to <tt>Client.new(firm_id: id)</tt>)
1237
+ # * <tt>Firm#clients.create</tt> (similar to <tt>c = Client.new(firm_id: id); c.save; c</tt>)
1238
+ # * <tt>Firm#clients.create!</tt> (similar to <tt>c = Client.new(firm_id: id); c.save!</tt>)
1239
+ # * <tt>Firm#clients.reload</tt>
1240
+ # The declaration can also include an +options+ hash to specialize the behavior of the association.
1241
+ #
1242
+ # === Scopes
1243
+ #
1244
+ # You can pass a second argument +scope+ as a callable (i.e. proc or
1245
+ # lambda) to retrieve a specific set of records or customize the generated
1246
+ # query when you access the associated collection.
1247
+ #
1248
+ # Scope examples:
1249
+ # has_many :comments, -> { where(author_id: 1) }
1250
+ # has_many :employees, -> { joins(:address) }
1251
+ # has_many :posts, ->(blog) { where("max_post_length > ?", blog.max_post_length) }
1252
+ #
1253
+ # === Extensions
1254
+ #
1255
+ # The +extension+ argument allows you to pass a block into a has_many
1256
+ # association. This is useful for adding new finders, creators and other
1257
+ # factory-type methods to be used as part of the association.
1258
+ #
1259
+ # Extension examples:
1260
+ # has_many :employees do
1261
+ # def find_or_create_by_name(name)
1262
+ # first_name, last_name = name.split(" ", 2)
1263
+ # find_or_create_by(first_name: first_name, last_name: last_name)
1264
+ # end
1265
+ # end
1266
+ #
1267
+ # === Options
1268
+ # [:class_name]
1269
+ # Specify the class name of the association. Use it only if that name can't be inferred
1270
+ # from the association name. So <tt>has_many :products</tt> will by default be linked
1271
+ # to the +Product+ class, but if the real class name is +SpecialProduct+, you'll have to
1272
+ # specify it with this option.
1273
+ # [:foreign_key]
1274
+ # Specify the foreign key used for the association. By default this is guessed to be the name
1275
+ # of this class in lower-case and "_id" suffixed. So a Person class that makes a #has_many
1276
+ # association will use "person_id" as the default <tt>:foreign_key</tt>.
1277
+ #
1278
+ # If you are going to modify the association (rather than just read from it), then it is
1279
+ # a good idea to set the <tt>:inverse_of</tt> option.
1280
+ # [:foreign_type]
1281
+ # Specify the column used to store the associated object's type, if this is a polymorphic
1282
+ # association. By default this is guessed to be the name of the polymorphic association
1283
+ # specified on "as" option with a "_type" suffix. So a class that defines a
1284
+ # <tt>has_many :tags, as: :taggable</tt> association will use "taggable_type" as the
1285
+ # default <tt>:foreign_type</tt>.
1286
+ # [:primary_key]
1287
+ # Specify the name of the column to use as the primary key for the association. By default this is +id+.
1288
+ # [:dependent]
1289
+ # Controls what happens to the associated objects when
1290
+ # their owner is destroyed. Note that these are implemented as
1291
+ # callbacks, and Rails executes callbacks in order. Therefore, other
1292
+ # similar callbacks may affect the <tt>:dependent</tt> behavior, and the
1293
+ # <tt>:dependent</tt> behavior may affect other callbacks.
1294
+ #
1295
+ # * <tt>:destroy</tt> causes all the associated objects to also be destroyed.
1296
+ # * <tt>:delete_all</tt> causes all the associated objects to be deleted directly from the database (so callbacks will not be executed).
1297
+ # * <tt>:nullify</tt> causes the foreign keys to be set to +NULL+. Polymorphic type will also be nullified
1298
+ # on polymorphic associations. Callbacks are not executed.
1299
+ # * <tt>:restrict_with_exception</tt> causes an <tt>ActiveRecord::DeleteRestrictionError</tt> exception to be raised if there are any associated records.
1300
+ # * <tt>:restrict_with_error</tt> causes an error to be added to the owner if there are any associated objects.
1301
+ #
1302
+ # If using with the <tt>:through</tt> option, the association on the join model must be
1303
+ # a #belongs_to, and the records which get deleted are the join records, rather than
1304
+ # the associated records.
1305
+ #
1306
+ # If using <tt>dependent: :destroy</tt> on a scoped association, only the scoped objects are destroyed.
1307
+ # For example, if a Post model defines
1308
+ # <tt>has_many :comments, -> { where published: true }, dependent: :destroy</tt> and <tt>destroy</tt> is
1309
+ # called on a post, only published comments are destroyed. This means that any unpublished comments in the
1310
+ # database would still contain a foreign key pointing to the now deleted post.
1311
+ # [:counter_cache]
1312
+ # This option can be used to configure a custom named <tt>:counter_cache.</tt> You only need this option,
1313
+ # when you customized the name of your <tt>:counter_cache</tt> on the #belongs_to association.
1314
+ # [:as]
1315
+ # Specifies a polymorphic interface (See #belongs_to).
1316
+ # [:through]
1317
+ # Specifies an association through which to perform the query. This can be any other type
1318
+ # of association, including other <tt>:through</tt> associations. Options for <tt>:class_name</tt>,
1319
+ # <tt>:primary_key</tt> and <tt>:foreign_key</tt> are ignored, as the association uses the
1320
+ # source reflection.
1321
+ #
1322
+ # If the association on the join model is a #belongs_to, the collection can be modified
1323
+ # and the records on the <tt>:through</tt> model will be automatically created and removed
1324
+ # as appropriate. Otherwise, the collection is read-only, so you should manipulate the
1325
+ # <tt>:through</tt> association directly.
1326
+ #
1327
+ # If you are going to modify the association (rather than just read from it), then it is
1328
+ # a good idea to set the <tt>:inverse_of</tt> option on the source association on the
1329
+ # join model. This allows associated records to be built which will automatically create
1330
+ # the appropriate join model records when they are saved. (See the 'Association Join Models'
1331
+ # section above.)
1332
+ # [:source]
1333
+ # Specifies the source association name used by #has_many <tt>:through</tt> queries.
1334
+ # Only use it if the name cannot be inferred from the association.
1335
+ # <tt>has_many :subscribers, through: :subscriptions</tt> will look for either <tt>:subscribers</tt> or
1336
+ # <tt>:subscriber</tt> on Subscription, unless a <tt>:source</tt> is given.
1337
+ # [:source_type]
1338
+ # Specifies type of the source association used by #has_many <tt>:through</tt> queries where the source
1339
+ # association is a polymorphic #belongs_to.
1340
+ # [:validate]
1341
+ # When set to +true+, validates new objects added to association when saving the parent object. +true+ by default.
1342
+ # If you want to ensure associated objects are revalidated on every update, use +validates_associated+.
1343
+ # [:autosave]
1344
+ # If true, always save the associated objects or destroy them if marked for destruction,
1345
+ # when saving the parent object. If false, never save or destroy the associated objects.
1346
+ # By default, only save associated objects that are new records. This option is implemented as a
1347
+ # +before_save+ callback. Because callbacks are run in the order they are defined, associated objects
1348
+ # may need to be explicitly saved in any user-defined +before_save+ callbacks.
1349
+ #
1350
+ # Note that NestedAttributes::ClassMethods#accepts_nested_attributes_for sets
1351
+ # <tt>:autosave</tt> to <tt>true</tt>.
1352
+ # [:inverse_of]
1353
+ # Specifies the name of the #belongs_to association on the associated object
1354
+ # that is the inverse of this #has_many association.
1355
+ # See ActiveRecord::Associations::ClassMethods's overview on Bi-directional associations for more detail.
1356
+ # [:extend]
1357
+ # Specifies a module or array of modules that will be extended into the association object returned.
1358
+ # Useful for defining methods on associations, especially when they should be shared between multiple
1359
+ # association objects.
1360
+ #
1361
+ # Option examples:
1362
+ # has_many :comments, -> { order("posted_on") }
1363
+ # has_many :comments, -> { includes(:author) }
1364
+ # has_many :people, -> { where(deleted: false).order("name") }, class_name: "Person"
1365
+ # has_many :tracks, -> { order("position") }, dependent: :destroy
1366
+ # has_many :comments, dependent: :nullify
1367
+ # has_many :tags, as: :taggable
1368
+ # has_many :reports, -> { readonly }
1369
+ # has_many :subscribers, through: :subscriptions, source: :user
1370
+ def has_many(name, scope = nil, **options, &extension)
1371
+ reflection = Builder::HasMany.build(self, name, scope, options, &extension)
1372
+ Reflection.add_reflection self, name, reflection
1814
1373
  end
1815
1374
 
1816
- habtm_reflection = ActiveRecord::Reflection::HasAndBelongsToManyReflection.new(name, scope, options, self)
1375
+ # Specifies a one-to-one association with another class. This method should only be used
1376
+ # if the other class contains the foreign key. If the current class contains the foreign key,
1377
+ # then you should use #belongs_to instead. See also ActiveRecord::Associations::ClassMethods's overview
1378
+ # on when to use #has_one and when to use #belongs_to.
1379
+ #
1380
+ # The following methods for retrieval and query of a single associated object will be added:
1381
+ #
1382
+ # +association+ is a placeholder for the symbol passed as the +name+ argument, so
1383
+ # <tt>has_one :manager</tt> would add among others <tt>manager.nil?</tt>.
1384
+ #
1385
+ # [association]
1386
+ # Returns the associated object. +nil+ is returned if none is found.
1387
+ # [association=(associate)]
1388
+ # Assigns the associate object, extracts the primary key, sets it as the foreign key,
1389
+ # and saves the associate object. To avoid database inconsistencies, permanently deletes an existing
1390
+ # associated object when assigning a new one, even if the new one isn't saved to database.
1391
+ # [build_association(attributes = {})]
1392
+ # Returns a new object of the associated type that has been instantiated
1393
+ # with +attributes+ and linked to this object through a foreign key, but has not
1394
+ # yet been saved.
1395
+ # [create_association(attributes = {})]
1396
+ # Returns a new object of the associated type that has been instantiated
1397
+ # with +attributes+, linked to this object through a foreign key, and that
1398
+ # has already been saved (if it passed the validation).
1399
+ # [create_association!(attributes = {})]
1400
+ # Does the same as <tt>create_association</tt>, but raises ActiveRecord::RecordInvalid
1401
+ # if the record is invalid.
1402
+ # [reload_association]
1403
+ # Returns the associated object, forcing a database read.
1404
+ #
1405
+ # === Example
1406
+ #
1407
+ # An Account class declares <tt>has_one :beneficiary</tt>, which will add:
1408
+ # * <tt>Account#beneficiary</tt> (similar to <tt>Beneficiary.where(account_id: id).first</tt>)
1409
+ # * <tt>Account#beneficiary=(beneficiary)</tt> (similar to <tt>beneficiary.account_id = account.id; beneficiary.save</tt>)
1410
+ # * <tt>Account#build_beneficiary</tt> (similar to <tt>Beneficiary.new(account_id: id)</tt>)
1411
+ # * <tt>Account#create_beneficiary</tt> (similar to <tt>b = Beneficiary.new(account_id: id); b.save; b</tt>)
1412
+ # * <tt>Account#create_beneficiary!</tt> (similar to <tt>b = Beneficiary.new(account_id: id); b.save!; b</tt>)
1413
+ # * <tt>Account#reload_beneficiary</tt>
1414
+ #
1415
+ # === Scopes
1416
+ #
1417
+ # You can pass a second argument +scope+ as a callable (i.e. proc or
1418
+ # lambda) to retrieve a specific record or customize the generated query
1419
+ # when you access the associated object.
1420
+ #
1421
+ # Scope examples:
1422
+ # has_one :author, -> { where(comment_id: 1) }
1423
+ # has_one :employer, -> { joins(:company) }
1424
+ # has_one :latest_post, ->(blog) { where("created_at > ?", blog.enabled_at) }
1425
+ #
1426
+ # === Options
1427
+ #
1428
+ # The declaration can also include an +options+ hash to specialize the behavior of the association.
1429
+ #
1430
+ # Options are:
1431
+ # [:class_name]
1432
+ # Specify the class name of the association. Use it only if that name can't be inferred
1433
+ # from the association name. So <tt>has_one :manager</tt> will by default be linked to the Manager class, but
1434
+ # if the real class name is Person, you'll have to specify it with this option.
1435
+ # [:dependent]
1436
+ # Controls what happens to the associated object when
1437
+ # its owner is destroyed:
1438
+ #
1439
+ # * <tt>:destroy</tt> causes the associated object to also be destroyed
1440
+ # * <tt>:delete</tt> causes the associated object to be deleted directly from the database (so callbacks will not execute)
1441
+ # * <tt>:nullify</tt> causes the foreign key to be set to +NULL+. Polymorphic type column is also nullified
1442
+ # on polymorphic associations. Callbacks are not executed.
1443
+ # * <tt>:restrict_with_exception</tt> causes an <tt>ActiveRecord::DeleteRestrictionError</tt> exception to be raised if there is an associated record
1444
+ # * <tt>:restrict_with_error</tt> causes an error to be added to the owner if there is an associated object
1445
+ #
1446
+ # Note that <tt>:dependent</tt> option is ignored when using <tt>:through</tt> option.
1447
+ # [:foreign_key]
1448
+ # Specify the foreign key used for the association. By default this is guessed to be the name
1449
+ # of this class in lower-case and "_id" suffixed. So a Person class that makes a #has_one association
1450
+ # will use "person_id" as the default <tt>:foreign_key</tt>.
1451
+ #
1452
+ # If you are going to modify the association (rather than just read from it), then it is
1453
+ # a good idea to set the <tt>:inverse_of</tt> option.
1454
+ # [:foreign_type]
1455
+ # Specify the column used to store the associated object's type, if this is a polymorphic
1456
+ # association. By default this is guessed to be the name of the polymorphic association
1457
+ # specified on "as" option with a "_type" suffix. So a class that defines a
1458
+ # <tt>has_one :tag, as: :taggable</tt> association will use "taggable_type" as the
1459
+ # default <tt>:foreign_type</tt>.
1460
+ # [:primary_key]
1461
+ # Specify the method that returns the primary key used for the association. By default this is +id+.
1462
+ # [:as]
1463
+ # Specifies a polymorphic interface (See #belongs_to).
1464
+ # [:through]
1465
+ # Specifies a Join Model through which to perform the query. Options for <tt>:class_name</tt>,
1466
+ # <tt>:primary_key</tt>, and <tt>:foreign_key</tt> are ignored, as the association uses the
1467
+ # source reflection. You can only use a <tt>:through</tt> query through a #has_one
1468
+ # or #belongs_to association on the join model.
1469
+ #
1470
+ # If you are going to modify the association (rather than just read from it), then it is
1471
+ # a good idea to set the <tt>:inverse_of</tt> option.
1472
+ # [:source]
1473
+ # Specifies the source association name used by #has_one <tt>:through</tt> queries.
1474
+ # Only use it if the name cannot be inferred from the association.
1475
+ # <tt>has_one :favorite, through: :favorites</tt> will look for a
1476
+ # <tt>:favorite</tt> on Favorite, unless a <tt>:source</tt> is given.
1477
+ # [:source_type]
1478
+ # Specifies type of the source association used by #has_one <tt>:through</tt> queries where the source
1479
+ # association is a polymorphic #belongs_to.
1480
+ # [:validate]
1481
+ # When set to +true+, validates new objects added to association when saving the parent object. +false+ by default.
1482
+ # If you want to ensure associated objects are revalidated on every update, use +validates_associated+.
1483
+ # [:autosave]
1484
+ # If true, always save the associated object or destroy it if marked for destruction,
1485
+ # when saving the parent object. If false, never save or destroy the associated object.
1486
+ # By default, only save the associated object if it's a new record.
1487
+ #
1488
+ # Note that NestedAttributes::ClassMethods#accepts_nested_attributes_for sets
1489
+ # <tt>:autosave</tt> to <tt>true</tt>.
1490
+ # [:inverse_of]
1491
+ # Specifies the name of the #belongs_to association on the associated object
1492
+ # that is the inverse of this #has_one association.
1493
+ # See ActiveRecord::Associations::ClassMethods's overview on Bi-directional associations for more detail.
1494
+ # [:required]
1495
+ # When set to +true+, the association will also have its presence validated.
1496
+ # This will validate the association itself, not the id. You can use
1497
+ # +:inverse_of+ to avoid an extra query during validation.
1498
+ #
1499
+ # Option examples:
1500
+ # has_one :credit_card, dependent: :destroy # destroys the associated credit card
1501
+ # has_one :credit_card, dependent: :nullify # updates the associated records foreign
1502
+ # # key value to NULL rather than destroying it
1503
+ # has_one :last_comment, -> { order('posted_on') }, class_name: "Comment"
1504
+ # has_one :project_manager, -> { where(role: 'project_manager') }, class_name: "Person"
1505
+ # has_one :attachment, as: :attachable
1506
+ # has_one :boss, -> { readonly }
1507
+ # has_one :club, through: :membership
1508
+ # has_one :primary_address, -> { where(primary: true) }, through: :addressables, source: :addressable
1509
+ # has_one :credit_card, required: true
1510
+ def has_one(name, scope = nil, **options)
1511
+ reflection = Builder::HasOne.build(self, name, scope, options)
1512
+ Reflection.add_reflection self, name, reflection
1513
+ end
1817
1514
 
1818
- builder = Builder::HasAndBelongsToMany.new name, self, options
1515
+ # Specifies a one-to-one association with another class. This method should only be used
1516
+ # if this class contains the foreign key. If the other class contains the foreign key,
1517
+ # then you should use #has_one instead. See also ActiveRecord::Associations::ClassMethods's overview
1518
+ # on when to use #has_one and when to use #belongs_to.
1519
+ #
1520
+ # Methods will be added for retrieval and query for a single associated object, for which
1521
+ # this object holds an id:
1522
+ #
1523
+ # +association+ is a placeholder for the symbol passed as the +name+ argument, so
1524
+ # <tt>belongs_to :author</tt> would add among others <tt>author.nil?</tt>.
1525
+ #
1526
+ # [association]
1527
+ # Returns the associated object. +nil+ is returned if none is found.
1528
+ # [association=(associate)]
1529
+ # Assigns the associate object, extracts the primary key, and sets it as the foreign key.
1530
+ # No modification or deletion of existing records takes place.
1531
+ # [build_association(attributes = {})]
1532
+ # Returns a new object of the associated type that has been instantiated
1533
+ # with +attributes+ and linked to this object through a foreign key, but has not yet been saved.
1534
+ # [create_association(attributes = {})]
1535
+ # Returns a new object of the associated type that has been instantiated
1536
+ # with +attributes+, linked to this object through a foreign key, and that
1537
+ # has already been saved (if it passed the validation).
1538
+ # [create_association!(attributes = {})]
1539
+ # Does the same as <tt>create_association</tt>, but raises ActiveRecord::RecordInvalid
1540
+ # if the record is invalid.
1541
+ # [reload_association]
1542
+ # Returns the associated object, forcing a database read.
1543
+ #
1544
+ # === Example
1545
+ #
1546
+ # A Post class declares <tt>belongs_to :author</tt>, which will add:
1547
+ # * <tt>Post#author</tt> (similar to <tt>Author.find(author_id)</tt>)
1548
+ # * <tt>Post#author=(author)</tt> (similar to <tt>post.author_id = author.id</tt>)
1549
+ # * <tt>Post#build_author</tt> (similar to <tt>post.author = Author.new</tt>)
1550
+ # * <tt>Post#create_author</tt> (similar to <tt>post.author = Author.new; post.author.save; post.author</tt>)
1551
+ # * <tt>Post#create_author!</tt> (similar to <tt>post.author = Author.new; post.author.save!; post.author</tt>)
1552
+ # * <tt>Post#reload_author</tt>
1553
+ # The declaration can also include an +options+ hash to specialize the behavior of the association.
1554
+ #
1555
+ # === Scopes
1556
+ #
1557
+ # You can pass a second argument +scope+ as a callable (i.e. proc or
1558
+ # lambda) to retrieve a specific record or customize the generated query
1559
+ # when you access the associated object.
1560
+ #
1561
+ # Scope examples:
1562
+ # belongs_to :firm, -> { where(id: 2) }
1563
+ # belongs_to :user, -> { joins(:friends) }
1564
+ # belongs_to :level, ->(game) { where("game_level > ?", game.current_level) }
1565
+ #
1566
+ # === Options
1567
+ #
1568
+ # [:class_name]
1569
+ # Specify the class name of the association. Use it only if that name can't be inferred
1570
+ # from the association name. So <tt>belongs_to :author</tt> will by default be linked to the Author class, but
1571
+ # if the real class name is Person, you'll have to specify it with this option.
1572
+ # [:foreign_key]
1573
+ # Specify the foreign key used for the association. By default this is guessed to be the name
1574
+ # of the association with an "_id" suffix. So a class that defines a <tt>belongs_to :person</tt>
1575
+ # association will use "person_id" as the default <tt>:foreign_key</tt>. Similarly,
1576
+ # <tt>belongs_to :favorite_person, class_name: "Person"</tt> will use a foreign key
1577
+ # of "favorite_person_id".
1578
+ #
1579
+ # If you are going to modify the association (rather than just read from it), then it is
1580
+ # a good idea to set the <tt>:inverse_of</tt> option.
1581
+ # [:foreign_type]
1582
+ # Specify the column used to store the associated object's type, if this is a polymorphic
1583
+ # association. By default this is guessed to be the name of the association with a "_type"
1584
+ # suffix. So a class that defines a <tt>belongs_to :taggable, polymorphic: true</tt>
1585
+ # association will use "taggable_type" as the default <tt>:foreign_type</tt>.
1586
+ # [:primary_key]
1587
+ # Specify the method that returns the primary key of associated object used for the association.
1588
+ # By default this is +id+.
1589
+ # [:dependent]
1590
+ # If set to <tt>:destroy</tt>, the associated object is destroyed when this object is. If set to
1591
+ # <tt>:delete</tt>, the associated object is deleted *without* calling its destroy method.
1592
+ # This option should not be specified when #belongs_to is used in conjunction with
1593
+ # a #has_many relationship on another class because of the potential to leave
1594
+ # orphaned records behind.
1595
+ # [:counter_cache]
1596
+ # Caches the number of belonging objects on the associate class through the use of CounterCache::ClassMethods#increment_counter
1597
+ # and CounterCache::ClassMethods#decrement_counter. The counter cache is incremented when an object of this
1598
+ # class is created and decremented when it's destroyed. This requires that a column
1599
+ # named <tt>#{table_name}_count</tt> (such as +comments_count+ for a belonging Comment class)
1600
+ # is used on the associate class (such as a Post class) - that is the migration for
1601
+ # <tt>#{table_name}_count</tt> is created on the associate class (such that <tt>Post.comments_count</tt> will
1602
+ # return the count cached, see note below). You can also specify a custom counter
1603
+ # cache column by providing a column name instead of a +true+/+false+ value to this
1604
+ # option (e.g., <tt>counter_cache: :my_custom_counter</tt>.)
1605
+ # Note: Specifying a counter cache will add it to that model's list of readonly attributes
1606
+ # using +attr_readonly+.
1607
+ # [:polymorphic]
1608
+ # Specify this association is a polymorphic association by passing +true+.
1609
+ # Note: If you've enabled the counter cache, then you may want to add the counter cache attribute
1610
+ # to the +attr_readonly+ list in the associated classes (e.g. <tt>class Post; attr_readonly :comments_count; end</tt>).
1611
+ # [:validate]
1612
+ # When set to +true+, validates new objects added to association when saving the parent object. +false+ by default.
1613
+ # If you want to ensure associated objects are revalidated on every update, use +validates_associated+.
1614
+ # [:autosave]
1615
+ # If true, always save the associated object or destroy it if marked for destruction, when
1616
+ # saving the parent object.
1617
+ # If false, never save or destroy the associated object.
1618
+ # By default, only save the associated object if it's a new record.
1619
+ #
1620
+ # Note that NestedAttributes::ClassMethods#accepts_nested_attributes_for
1621
+ # sets <tt>:autosave</tt> to <tt>true</tt>.
1622
+ # [:touch]
1623
+ # If true, the associated object will be touched (the updated_at/on attributes set to current time)
1624
+ # when this record is either saved or destroyed. If you specify a symbol, that attribute
1625
+ # will be updated with the current time in addition to the updated_at/on attribute.
1626
+ # Please note that with touching no validation is performed and only the +after_touch+,
1627
+ # +after_commit+ and +after_rollback+ callbacks are executed.
1628
+ # [:inverse_of]
1629
+ # Specifies the name of the #has_one or #has_many association on the associated
1630
+ # object that is the inverse of this #belongs_to association.
1631
+ # See ActiveRecord::Associations::ClassMethods's overview on Bi-directional associations for more detail.
1632
+ # [:optional]
1633
+ # When set to +true+, the association will not have its presence validated.
1634
+ # [:required]
1635
+ # When set to +true+, the association will also have its presence validated.
1636
+ # This will validate the association itself, not the id. You can use
1637
+ # +:inverse_of+ to avoid an extra query during validation.
1638
+ # NOTE: <tt>required</tt> is set to <tt>true</tt> by default and is deprecated. If
1639
+ # you don't want to have association presence validated, use <tt>optional: true</tt>.
1640
+ # [:default]
1641
+ # Provide a callable (i.e. proc or lambda) to specify that the association should
1642
+ # be initialized with a particular record before validation.
1643
+ #
1644
+ # Option examples:
1645
+ # belongs_to :firm, foreign_key: "client_of"
1646
+ # belongs_to :person, primary_key: "name", foreign_key: "person_name"
1647
+ # belongs_to :author, class_name: "Person", foreign_key: "author_id"
1648
+ # belongs_to :valid_coupon, ->(o) { where "discounts > ?", o.payments_count },
1649
+ # class_name: "Coupon", foreign_key: "coupon_id"
1650
+ # belongs_to :attachable, polymorphic: true
1651
+ # belongs_to :project, -> { readonly }
1652
+ # belongs_to :post, counter_cache: true
1653
+ # belongs_to :comment, touch: true
1654
+ # belongs_to :company, touch: :employees_last_updated_at
1655
+ # belongs_to :user, optional: true
1656
+ # belongs_to :account, default: -> { company.account }
1657
+ def belongs_to(name, scope = nil, **options)
1658
+ reflection = Builder::BelongsTo.build(self, name, scope, options)
1659
+ Reflection.add_reflection self, name, reflection
1660
+ end
1819
1661
 
1820
- join_model = builder.through_model
1662
+ # Specifies a many-to-many relationship with another class. This associates two classes via an
1663
+ # intermediate join table. Unless the join table is explicitly specified as an option, it is
1664
+ # guessed using the lexical order of the class names. So a join between Developer and Project
1665
+ # will give the default join table name of "developers_projects" because "D" precedes "P" alphabetically.
1666
+ # Note that this precedence is calculated using the <tt><</tt> operator for String. This
1667
+ # means that if the strings are of different lengths, and the strings are equal when compared
1668
+ # up to the shortest length, then the longer string is considered of higher
1669
+ # lexical precedence than the shorter one. For example, one would expect the tables "paper_boxes" and "papers"
1670
+ # to generate a join table name of "papers_paper_boxes" because of the length of the name "paper_boxes",
1671
+ # but it in fact generates a join table name of "paper_boxes_papers". Be aware of this caveat, and use the
1672
+ # custom <tt>:join_table</tt> option if you need to.
1673
+ # If your tables share a common prefix, it will only appear once at the beginning. For example,
1674
+ # the tables "catalog_categories" and "catalog_products" generate a join table name of "catalog_categories_products".
1675
+ #
1676
+ # The join table should not have a primary key or a model associated with it. You must manually generate the
1677
+ # join table with a migration such as this:
1678
+ #
1679
+ # class CreateDevelopersProjectsJoinTable < ActiveRecord::Migration[5.0]
1680
+ # def change
1681
+ # create_join_table :developers, :projects
1682
+ # end
1683
+ # end
1684
+ #
1685
+ # It's also a good idea to add indexes to each of those columns to speed up the joins process.
1686
+ # However, in MySQL it is advised to add a compound index for both of the columns as MySQL only
1687
+ # uses one index per table during the lookup.
1688
+ #
1689
+ # Adds the following methods for retrieval and query:
1690
+ #
1691
+ # +collection+ is a placeholder for the symbol passed as the +name+ argument, so
1692
+ # <tt>has_and_belongs_to_many :categories</tt> would add among others <tt>categories.empty?</tt>.
1693
+ #
1694
+ # [collection]
1695
+ # Returns a Relation of all the associated objects.
1696
+ # An empty Relation is returned if none are found.
1697
+ # [collection<<(object, ...)]
1698
+ # Adds one or more objects to the collection by creating associations in the join table
1699
+ # (<tt>collection.push</tt> and <tt>collection.concat</tt> are aliases to this method).
1700
+ # Note that this operation instantly fires update SQL without waiting for the save or update call on the
1701
+ # parent object, unless the parent object is a new record.
1702
+ # [collection.delete(object, ...)]
1703
+ # Removes one or more objects from the collection by removing their associations from the join table.
1704
+ # This does not destroy the objects.
1705
+ # [collection.destroy(object, ...)]
1706
+ # Removes one or more objects from the collection by running destroy on each association in the join table, overriding any dependent option.
1707
+ # This does not destroy the objects.
1708
+ # [collection=objects]
1709
+ # Replaces the collection's content by deleting and adding objects as appropriate.
1710
+ # [collection_singular_ids]
1711
+ # Returns an array of the associated objects' ids.
1712
+ # [collection_singular_ids=ids]
1713
+ # Replace the collection by the objects identified by the primary keys in +ids+.
1714
+ # [collection.clear]
1715
+ # Removes every object from the collection. This does not destroy the objects.
1716
+ # [collection.empty?]
1717
+ # Returns +true+ if there are no associated objects.
1718
+ # [collection.size]
1719
+ # Returns the number of associated objects.
1720
+ # [collection.find(id)]
1721
+ # Finds an associated object responding to the +id+ and that
1722
+ # meets the condition that it has to be associated with this object.
1723
+ # Uses the same rules as ActiveRecord::FinderMethods#find.
1724
+ # [collection.exists?(...)]
1725
+ # Checks whether an associated object with the given conditions exists.
1726
+ # Uses the same rules as ActiveRecord::FinderMethods#exists?.
1727
+ # [collection.build(attributes = {})]
1728
+ # Returns a new object of the collection type that has been instantiated
1729
+ # with +attributes+ and linked to this object through the join table, but has not yet been saved.
1730
+ # [collection.create(attributes = {})]
1731
+ # Returns a new object of the collection type that has been instantiated
1732
+ # with +attributes+, linked to this object through the join table, and that has already been
1733
+ # saved (if it passed the validation).
1734
+ # [collection.reload]
1735
+ # Returns a Relation of all of the associated objects, forcing a database read.
1736
+ # An empty Relation is returned if none are found.
1737
+ #
1738
+ # === Example
1739
+ #
1740
+ # A Developer class declares <tt>has_and_belongs_to_many :projects</tt>, which will add:
1741
+ # * <tt>Developer#projects</tt>
1742
+ # * <tt>Developer#projects<<</tt>
1743
+ # * <tt>Developer#projects.delete</tt>
1744
+ # * <tt>Developer#projects.destroy</tt>
1745
+ # * <tt>Developer#projects=</tt>
1746
+ # * <tt>Developer#project_ids</tt>
1747
+ # * <tt>Developer#project_ids=</tt>
1748
+ # * <tt>Developer#projects.clear</tt>
1749
+ # * <tt>Developer#projects.empty?</tt>
1750
+ # * <tt>Developer#projects.size</tt>
1751
+ # * <tt>Developer#projects.find(id)</tt>
1752
+ # * <tt>Developer#projects.exists?(...)</tt>
1753
+ # * <tt>Developer#projects.build</tt> (similar to <tt>Project.new(developer_id: id)</tt>)
1754
+ # * <tt>Developer#projects.create</tt> (similar to <tt>c = Project.new(developer_id: id); c.save; c</tt>)
1755
+ # * <tt>Developer#projects.reload</tt>
1756
+ # The declaration may include an +options+ hash to specialize the behavior of the association.
1757
+ #
1758
+ # === Scopes
1759
+ #
1760
+ # You can pass a second argument +scope+ as a callable (i.e. proc or
1761
+ # lambda) to retrieve a specific set of records or customize the generated
1762
+ # query when you access the associated collection.
1763
+ #
1764
+ # Scope examples:
1765
+ # has_and_belongs_to_many :projects, -> { includes(:milestones, :manager) }
1766
+ # has_and_belongs_to_many :categories, ->(post) {
1767
+ # where("default_category = ?", post.default_category)
1768
+ # }
1769
+ #
1770
+ # === Extensions
1771
+ #
1772
+ # The +extension+ argument allows you to pass a block into a
1773
+ # has_and_belongs_to_many association. This is useful for adding new
1774
+ # finders, creators and other factory-type methods to be used as part of
1775
+ # the association.
1776
+ #
1777
+ # Extension examples:
1778
+ # has_and_belongs_to_many :contractors do
1779
+ # def find_or_create_by_name(name)
1780
+ # first_name, last_name = name.split(" ", 2)
1781
+ # find_or_create_by(first_name: first_name, last_name: last_name)
1782
+ # end
1783
+ # end
1784
+ #
1785
+ # === Options
1786
+ #
1787
+ # [:class_name]
1788
+ # Specify the class name of the association. Use it only if that name can't be inferred
1789
+ # from the association name. So <tt>has_and_belongs_to_many :projects</tt> will by default be linked to the
1790
+ # Project class, but if the real class name is SuperProject, you'll have to specify it with this option.
1791
+ # [:join_table]
1792
+ # Specify the name of the join table if the default based on lexical order isn't what you want.
1793
+ # <b>WARNING:</b> If you're overwriting the table name of either class, the +table_name+ method
1794
+ # MUST be declared underneath any #has_and_belongs_to_many declaration in order to work.
1795
+ # [:foreign_key]
1796
+ # Specify the foreign key used for the association. By default this is guessed to be the name
1797
+ # of this class in lower-case and "_id" suffixed. So a Person class that makes
1798
+ # a #has_and_belongs_to_many association to Project will use "person_id" as the
1799
+ # default <tt>:foreign_key</tt>.
1800
+ #
1801
+ # If you are going to modify the association (rather than just read from it), then it is
1802
+ # a good idea to set the <tt>:inverse_of</tt> option.
1803
+ # [:association_foreign_key]
1804
+ # Specify the foreign key used for the association on the receiving side of the association.
1805
+ # By default this is guessed to be the name of the associated class in lower-case and "_id" suffixed.
1806
+ # So if a Person class makes a #has_and_belongs_to_many association to Project,
1807
+ # the association will use "project_id" as the default <tt>:association_foreign_key</tt>.
1808
+ # [:validate]
1809
+ # When set to +true+, validates new objects added to association when saving the parent object. +true+ by default.
1810
+ # If you want to ensure associated objects are revalidated on every update, use +validates_associated+.
1811
+ # [:autosave]
1812
+ # If true, always save the associated objects or destroy them if marked for destruction, when
1813
+ # saving the parent object.
1814
+ # If false, never save or destroy the associated objects.
1815
+ # By default, only save associated objects that are new records.
1816
+ #
1817
+ # Note that NestedAttributes::ClassMethods#accepts_nested_attributes_for sets
1818
+ # <tt>:autosave</tt> to <tt>true</tt>.
1819
+ #
1820
+ # Option examples:
1821
+ # has_and_belongs_to_many :projects
1822
+ # has_and_belongs_to_many :projects, -> { includes(:milestones, :manager) }
1823
+ # has_and_belongs_to_many :nations, class_name: "Country"
1824
+ # has_and_belongs_to_many :categories, join_table: "prods_cats"
1825
+ # has_and_belongs_to_many :categories, -> { readonly }
1826
+ def has_and_belongs_to_many(name, scope = nil, **options, &extension)
1827
+ habtm_reflection = ActiveRecord::Reflection::HasAndBelongsToManyReflection.new(name, scope, options, self)
1821
1828
 
1822
- const_set join_model.name, join_model
1823
- private_constant join_model.name
1829
+ builder = Builder::HasAndBelongsToMany.new name, self, options
1824
1830
 
1825
- middle_reflection = builder.middle_reflection join_model
1831
+ join_model = builder.through_model
1826
1832
 
1827
- Builder::HasMany.define_callbacks self, middle_reflection
1828
- Reflection.add_reflection self, middle_reflection.name, middle_reflection
1829
- middle_reflection.parent_reflection = habtm_reflection
1833
+ const_set join_model.name, join_model
1834
+ private_constant join_model.name
1830
1835
 
1831
- include Module.new {
1832
- class_eval <<-RUBY, __FILE__, __LINE__ + 1
1833
- def destroy_associations
1834
- association(:#{middle_reflection.name}).delete_all(:delete_all)
1835
- association(:#{name}).reset
1836
- super
1837
- end
1838
- RUBY
1839
- }
1836
+ middle_reflection = builder.middle_reflection join_model
1840
1837
 
1841
- hm_options = {}
1842
- hm_options[:through] = middle_reflection.name
1843
- hm_options[:source] = join_model.right_reflection.name
1838
+ Builder::HasMany.define_callbacks self, middle_reflection
1839
+ Reflection.add_reflection self, middle_reflection.name, middle_reflection
1840
+ middle_reflection.parent_reflection = habtm_reflection
1844
1841
 
1845
- [:before_add, :after_add, :before_remove, :after_remove, :autosave, :validate, :join_table, :class_name, :extend].each do |k|
1846
- hm_options[k] = options[k] if options.key? k
1847
- end
1842
+ include Module.new {
1843
+ class_eval <<-RUBY, __FILE__, __LINE__ + 1
1844
+ def destroy_associations
1845
+ association(:#{middle_reflection.name}).delete_all(:delete_all)
1846
+ association(:#{name}).reset
1847
+ super
1848
+ end
1849
+ RUBY
1850
+ }
1848
1851
 
1849
- has_many name, scope, hm_options, &extension
1850
- self._reflections[name.to_s].parent_reflection = habtm_reflection
1852
+ hm_options = {}
1853
+ hm_options[:through] = middle_reflection.name
1854
+ hm_options[:source] = join_model.right_reflection.name
1855
+
1856
+ [:before_add, :after_add, :before_remove, :after_remove, :autosave, :validate, :join_table, :class_name, :extend].each do |k|
1857
+ hm_options[k] = options[k] if options.key? k
1858
+ end
1859
+
1860
+ has_many name, scope, hm_options, &extension
1861
+ _reflections[name.to_s].parent_reflection = habtm_reflection
1862
+ end
1851
1863
  end
1852
- end
1853
1864
  end
1854
1865
  end