activerecord 3.2.22.5 → 5.2.8

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