activerecord 5.0.7.2 → 5.1.0.beta1

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