activerecord 4.2.0 → 5.2.8.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (274) hide show
  1. checksums.yaml +5 -5
  2. data/CHANGELOG.md +640 -928
  3. data/MIT-LICENSE +2 -2
  4. data/README.rdoc +10 -11
  5. data/examples/performance.rb +32 -31
  6. data/examples/simple.rb +5 -4
  7. data/lib/active_record/aggregations.rb +264 -247
  8. data/lib/active_record/association_relation.rb +24 -6
  9. data/lib/active_record/associations/alias_tracker.rb +29 -35
  10. data/lib/active_record/associations/association.rb +87 -41
  11. data/lib/active_record/associations/association_scope.rb +106 -132
  12. data/lib/active_record/associations/belongs_to_association.rb +55 -36
  13. data/lib/active_record/associations/belongs_to_polymorphic_association.rb +8 -8
  14. data/lib/active_record/associations/builder/association.rb +29 -38
  15. data/lib/active_record/associations/builder/belongs_to.rb +77 -30
  16. data/lib/active_record/associations/builder/collection_association.rb +14 -23
  17. data/lib/active_record/associations/builder/has_and_belongs_to_many.rb +50 -39
  18. data/lib/active_record/associations/builder/has_many.rb +6 -4
  19. data/lib/active_record/associations/builder/has_one.rb +13 -6
  20. data/lib/active_record/associations/builder/singular_association.rb +15 -11
  21. data/lib/active_record/associations/collection_association.rb +145 -266
  22. data/lib/active_record/associations/collection_proxy.rb +242 -138
  23. data/lib/active_record/associations/foreign_association.rb +13 -0
  24. data/lib/active_record/associations/has_many_association.rb +35 -75
  25. data/lib/active_record/associations/has_many_through_association.rb +51 -69
  26. data/lib/active_record/associations/has_one_association.rb +39 -24
  27. data/lib/active_record/associations/has_one_through_association.rb +18 -9
  28. data/lib/active_record/associations/join_dependency/join_association.rb +40 -81
  29. data/lib/active_record/associations/join_dependency/join_base.rb +10 -9
  30. data/lib/active_record/associations/join_dependency/join_part.rb +12 -12
  31. data/lib/active_record/associations/join_dependency.rb +134 -154
  32. data/lib/active_record/associations/preloader/association.rb +85 -116
  33. data/lib/active_record/associations/preloader/through_association.rb +85 -74
  34. data/lib/active_record/associations/preloader.rb +83 -93
  35. data/lib/active_record/associations/singular_association.rb +27 -40
  36. data/lib/active_record/associations/through_association.rb +48 -23
  37. data/lib/active_record/associations.rb +1732 -1596
  38. data/lib/active_record/attribute_assignment.rb +58 -182
  39. data/lib/active_record/attribute_decorators.rb +39 -15
  40. data/lib/active_record/attribute_methods/before_type_cast.rb +12 -5
  41. data/lib/active_record/attribute_methods/dirty.rb +94 -125
  42. data/lib/active_record/attribute_methods/primary_key.rb +86 -71
  43. data/lib/active_record/attribute_methods/query.rb +4 -2
  44. data/lib/active_record/attribute_methods/read.rb +45 -63
  45. data/lib/active_record/attribute_methods/serialization.rb +40 -20
  46. data/lib/active_record/attribute_methods/time_zone_conversion.rb +62 -36
  47. data/lib/active_record/attribute_methods/write.rb +31 -46
  48. data/lib/active_record/attribute_methods.rb +170 -117
  49. data/lib/active_record/attributes.rb +201 -74
  50. data/lib/active_record/autosave_association.rb +118 -45
  51. data/lib/active_record/base.rb +60 -48
  52. data/lib/active_record/callbacks.rb +97 -57
  53. data/lib/active_record/coders/json.rb +3 -1
  54. data/lib/active_record/coders/yaml_column.rb +37 -13
  55. data/lib/active_record/collection_cache_key.rb +53 -0
  56. data/lib/active_record/connection_adapters/abstract/connection_pool.rb +712 -284
  57. data/lib/active_record/connection_adapters/abstract/database_limits.rb +10 -5
  58. data/lib/active_record/connection_adapters/abstract/database_statements.rb +254 -87
  59. data/lib/active_record/connection_adapters/abstract/query_cache.rb +72 -22
  60. data/lib/active_record/connection_adapters/abstract/quoting.rb +119 -52
  61. data/lib/active_record/connection_adapters/abstract/savepoints.rb +6 -4
  62. data/lib/active_record/connection_adapters/abstract/schema_creation.rb +67 -46
  63. data/lib/active_record/connection_adapters/abstract/schema_definitions.rb +328 -217
  64. data/lib/active_record/connection_adapters/abstract/schema_dumper.rb +81 -36
  65. data/lib/active_record/connection_adapters/abstract/schema_statements.rb +617 -212
  66. data/lib/active_record/connection_adapters/abstract/transaction.rb +139 -75
  67. data/lib/active_record/connection_adapters/abstract_adapter.rb +332 -191
  68. data/lib/active_record/connection_adapters/abstract_mysql_adapter.rb +567 -563
  69. data/lib/active_record/connection_adapters/column.rb +50 -41
  70. data/lib/active_record/connection_adapters/connection_specification.rb +147 -135
  71. data/lib/active_record/connection_adapters/determine_if_preparable_visitor.rb +33 -0
  72. data/lib/active_record/connection_adapters/mysql/column.rb +27 -0
  73. data/lib/active_record/connection_adapters/mysql/database_statements.rb +140 -0
  74. data/lib/active_record/connection_adapters/mysql/explain_pretty_printer.rb +72 -0
  75. data/lib/active_record/connection_adapters/mysql/quoting.rb +44 -0
  76. data/lib/active_record/connection_adapters/mysql/schema_creation.rb +73 -0
  77. data/lib/active_record/connection_adapters/mysql/schema_definitions.rb +87 -0
  78. data/lib/active_record/connection_adapters/mysql/schema_dumper.rb +80 -0
  79. data/lib/active_record/connection_adapters/mysql/schema_statements.rb +148 -0
  80. data/lib/active_record/connection_adapters/mysql/type_metadata.rb +35 -0
  81. data/lib/active_record/connection_adapters/mysql2_adapter.rb +42 -195
  82. data/lib/active_record/connection_adapters/postgresql/column.rb +35 -11
  83. data/lib/active_record/connection_adapters/postgresql/database_statements.rb +46 -115
  84. data/lib/active_record/connection_adapters/postgresql/explain_pretty_printer.rb +44 -0
  85. data/lib/active_record/connection_adapters/postgresql/oid/array.rb +50 -57
  86. data/lib/active_record/connection_adapters/postgresql/oid/bit.rb +10 -6
  87. data/lib/active_record/connection_adapters/postgresql/oid/bit_varying.rb +2 -0
  88. data/lib/active_record/connection_adapters/postgresql/oid/bytea.rb +5 -2
  89. data/lib/active_record/connection_adapters/postgresql/oid/cidr.rb +5 -1
  90. data/lib/active_record/connection_adapters/postgresql/oid/date.rb +13 -1
  91. data/lib/active_record/connection_adapters/postgresql/oid/date_time.rb +9 -13
  92. data/lib/active_record/connection_adapters/postgresql/oid/decimal.rb +3 -1
  93. data/lib/active_record/connection_adapters/postgresql/oid/enum.rb +7 -3
  94. data/lib/active_record/connection_adapters/postgresql/oid/hstore.rb +31 -19
  95. data/lib/active_record/connection_adapters/postgresql/oid/inet.rb +2 -0
  96. data/lib/active_record/connection_adapters/postgresql/oid/jsonb.rb +3 -11
  97. data/lib/active_record/connection_adapters/postgresql/oid/legacy_point.rb +45 -0
  98. data/lib/active_record/connection_adapters/postgresql/oid/money.rb +7 -9
  99. data/lib/active_record/connection_adapters/postgresql/oid/{integer.rb → oid.rb} +6 -2
  100. data/lib/active_record/connection_adapters/postgresql/oid/point.rb +33 -11
  101. data/lib/active_record/connection_adapters/postgresql/oid/range.rb +52 -34
  102. data/lib/active_record/connection_adapters/postgresql/oid/specialized_string.rb +4 -1
  103. data/lib/active_record/connection_adapters/postgresql/oid/type_map_initializer.rb +65 -51
  104. data/lib/active_record/connection_adapters/postgresql/oid/uuid.rb +5 -3
  105. data/lib/active_record/connection_adapters/postgresql/oid/vector.rb +3 -1
  106. data/lib/active_record/connection_adapters/postgresql/oid/xml.rb +3 -1
  107. data/lib/active_record/connection_adapters/postgresql/oid.rb +23 -25
  108. data/lib/active_record/connection_adapters/postgresql/quoting.rb +107 -47
  109. data/lib/active_record/connection_adapters/postgresql/referential_integrity.rb +27 -14
  110. data/lib/active_record/connection_adapters/postgresql/schema_creation.rb +65 -0
  111. data/lib/active_record/connection_adapters/postgresql/schema_definitions.rb +144 -90
  112. data/lib/active_record/connection_adapters/postgresql/schema_dumper.rb +50 -0
  113. data/lib/active_record/connection_adapters/postgresql/schema_statements.rb +466 -280
  114. data/lib/active_record/connection_adapters/postgresql/type_metadata.rb +39 -0
  115. data/lib/active_record/connection_adapters/postgresql/utils.rb +12 -8
  116. data/lib/active_record/connection_adapters/postgresql_adapter.rb +439 -330
  117. data/lib/active_record/connection_adapters/schema_cache.rb +48 -24
  118. data/lib/active_record/connection_adapters/sql_type_metadata.rb +34 -0
  119. data/lib/active_record/connection_adapters/sqlite3/explain_pretty_printer.rb +21 -0
  120. data/lib/active_record/connection_adapters/sqlite3/quoting.rb +67 -0
  121. data/lib/active_record/connection_adapters/sqlite3/schema_creation.rb +17 -0
  122. data/lib/active_record/connection_adapters/sqlite3/schema_definitions.rb +19 -0
  123. data/lib/active_record/connection_adapters/sqlite3/schema_dumper.rb +18 -0
  124. data/lib/active_record/connection_adapters/sqlite3/schema_statements.rb +106 -0
  125. data/lib/active_record/connection_adapters/sqlite3_adapter.rb +269 -324
  126. data/lib/active_record/connection_adapters/statement_pool.rb +34 -13
  127. data/lib/active_record/connection_handling.rb +40 -27
  128. data/lib/active_record/core.rb +205 -202
  129. data/lib/active_record/counter_cache.rb +80 -37
  130. data/lib/active_record/define_callbacks.rb +22 -0
  131. data/lib/active_record/dynamic_matchers.rb +87 -105
  132. data/lib/active_record/enum.rb +136 -90
  133. data/lib/active_record/errors.rb +180 -52
  134. data/lib/active_record/explain.rb +23 -11
  135. data/lib/active_record/explain_registry.rb +4 -2
  136. data/lib/active_record/explain_subscriber.rb +11 -6
  137. data/lib/active_record/fixture_set/file.rb +35 -9
  138. data/lib/active_record/fixtures.rb +193 -135
  139. data/lib/active_record/gem_version.rb +5 -3
  140. data/lib/active_record/inheritance.rb +148 -112
  141. data/lib/active_record/integration.rb +70 -28
  142. data/lib/active_record/internal_metadata.rb +45 -0
  143. data/lib/active_record/legacy_yaml_adapter.rb +48 -0
  144. data/lib/active_record/locale/en.yml +3 -2
  145. data/lib/active_record/locking/optimistic.rb +92 -98
  146. data/lib/active_record/locking/pessimistic.rb +15 -3
  147. data/lib/active_record/log_subscriber.rb +95 -33
  148. data/lib/active_record/migration/command_recorder.rb +133 -90
  149. data/lib/active_record/migration/compatibility.rb +217 -0
  150. data/lib/active_record/migration/join_table.rb +8 -6
  151. data/lib/active_record/migration.rb +594 -267
  152. data/lib/active_record/model_schema.rb +292 -111
  153. data/lib/active_record/nested_attributes.rb +266 -214
  154. data/lib/active_record/no_touching.rb +8 -2
  155. data/lib/active_record/null_relation.rb +24 -37
  156. data/lib/active_record/persistence.rb +350 -119
  157. data/lib/active_record/query_cache.rb +13 -24
  158. data/lib/active_record/querying.rb +19 -17
  159. data/lib/active_record/railtie.rb +117 -35
  160. data/lib/active_record/railties/console_sandbox.rb +2 -0
  161. data/lib/active_record/railties/controller_runtime.rb +9 -3
  162. data/lib/active_record/railties/databases.rake +160 -174
  163. data/lib/active_record/readonly_attributes.rb +5 -4
  164. data/lib/active_record/reflection.rb +447 -288
  165. data/lib/active_record/relation/batches/batch_enumerator.rb +69 -0
  166. data/lib/active_record/relation/batches.rb +204 -55
  167. data/lib/active_record/relation/calculations.rb +259 -244
  168. data/lib/active_record/relation/delegation.rb +67 -60
  169. data/lib/active_record/relation/finder_methods.rb +290 -253
  170. data/lib/active_record/relation/from_clause.rb +26 -0
  171. data/lib/active_record/relation/merger.rb +91 -68
  172. data/lib/active_record/relation/predicate_builder/array_handler.rb +24 -23
  173. data/lib/active_record/relation/predicate_builder/association_query_value.rb +46 -0
  174. data/lib/active_record/relation/predicate_builder/base_handler.rb +19 -0
  175. data/lib/active_record/relation/predicate_builder/basic_object_handler.rb +20 -0
  176. data/lib/active_record/relation/predicate_builder/polymorphic_array_value.rb +56 -0
  177. data/lib/active_record/relation/predicate_builder/range_handler.rb +42 -0
  178. data/lib/active_record/relation/predicate_builder/relation_handler.rb +7 -1
  179. data/lib/active_record/relation/predicate_builder.rb +118 -92
  180. data/lib/active_record/relation/query_attribute.rb +45 -0
  181. data/lib/active_record/relation/query_methods.rb +446 -389
  182. data/lib/active_record/relation/record_fetch_warning.rb +51 -0
  183. data/lib/active_record/relation/spawn_methods.rb +18 -16
  184. data/lib/active_record/relation/where_clause.rb +186 -0
  185. data/lib/active_record/relation/where_clause_factory.rb +34 -0
  186. data/lib/active_record/relation.rb +287 -339
  187. data/lib/active_record/result.rb +54 -36
  188. data/lib/active_record/runtime_registry.rb +6 -4
  189. data/lib/active_record/sanitization.rb +155 -124
  190. data/lib/active_record/schema.rb +30 -24
  191. data/lib/active_record/schema_dumper.rb +91 -87
  192. data/lib/active_record/schema_migration.rb +19 -19
  193. data/lib/active_record/scoping/default.rb +102 -84
  194. data/lib/active_record/scoping/named.rb +81 -32
  195. data/lib/active_record/scoping.rb +45 -26
  196. data/lib/active_record/secure_token.rb +40 -0
  197. data/lib/active_record/serialization.rb +5 -5
  198. data/lib/active_record/statement_cache.rb +45 -35
  199. data/lib/active_record/store.rb +42 -36
  200. data/lib/active_record/suppressor.rb +61 -0
  201. data/lib/active_record/table_metadata.rb +82 -0
  202. data/lib/active_record/tasks/database_tasks.rb +136 -95
  203. data/lib/active_record/tasks/mysql_database_tasks.rb +59 -89
  204. data/lib/active_record/tasks/postgresql_database_tasks.rb +84 -31
  205. data/lib/active_record/tasks/sqlite_database_tasks.rb +44 -16
  206. data/lib/active_record/timestamp.rb +70 -38
  207. data/lib/active_record/touch_later.rb +64 -0
  208. data/lib/active_record/transactions.rb +208 -123
  209. data/lib/active_record/translation.rb +2 -0
  210. data/lib/active_record/type/adapter_specific_registry.rb +136 -0
  211. data/lib/active_record/type/date.rb +4 -41
  212. data/lib/active_record/type/date_time.rb +4 -38
  213. data/lib/active_record/type/decimal_without_scale.rb +6 -2
  214. data/lib/active_record/type/hash_lookup_type_map.rb +13 -5
  215. data/lib/active_record/type/internal/timezone.rb +17 -0
  216. data/lib/active_record/type/json.rb +30 -0
  217. data/lib/active_record/type/serialized.rb +30 -15
  218. data/lib/active_record/type/text.rb +2 -2
  219. data/lib/active_record/type/time.rb +11 -16
  220. data/lib/active_record/type/type_map.rb +15 -17
  221. data/lib/active_record/type/unsigned_integer.rb +9 -7
  222. data/lib/active_record/type.rb +79 -23
  223. data/lib/active_record/type_caster/connection.rb +33 -0
  224. data/lib/active_record/type_caster/map.rb +23 -0
  225. data/lib/active_record/type_caster.rb +9 -0
  226. data/lib/active_record/validations/absence.rb +25 -0
  227. data/lib/active_record/validations/associated.rb +13 -4
  228. data/lib/active_record/validations/length.rb +26 -0
  229. data/lib/active_record/validations/presence.rb +14 -13
  230. data/lib/active_record/validations/uniqueness.rb +41 -32
  231. data/lib/active_record/validations.rb +38 -35
  232. data/lib/active_record/version.rb +3 -1
  233. data/lib/active_record.rb +36 -21
  234. data/lib/rails/generators/active_record/application_record/application_record_generator.rb +27 -0
  235. data/lib/rails/generators/active_record/application_record/templates/application_record.rb.tt +5 -0
  236. data/lib/rails/generators/active_record/migration/migration_generator.rb +43 -35
  237. data/lib/rails/generators/active_record/migration/templates/{create_table_migration.rb → create_table_migration.rb.tt} +8 -6
  238. data/lib/rails/generators/active_record/migration/templates/{migration.rb → migration.rb.tt} +8 -7
  239. data/lib/rails/generators/active_record/migration.rb +18 -1
  240. data/lib/rails/generators/active_record/model/model_generator.rb +18 -22
  241. data/lib/rails/generators/active_record/model/templates/{model.rb → model.rb.tt} +3 -0
  242. data/lib/rails/generators/active_record.rb +7 -5
  243. metadata +77 -53
  244. data/lib/active_record/associations/preloader/belongs_to.rb +0 -17
  245. data/lib/active_record/associations/preloader/collection_association.rb +0 -24
  246. data/lib/active_record/associations/preloader/has_many.rb +0 -17
  247. data/lib/active_record/associations/preloader/has_many_through.rb +0 -19
  248. data/lib/active_record/associations/preloader/has_one.rb +0 -23
  249. data/lib/active_record/associations/preloader/has_one_through.rb +0 -9
  250. data/lib/active_record/associations/preloader/singular_association.rb +0 -21
  251. data/lib/active_record/attribute.rb +0 -149
  252. data/lib/active_record/attribute_set/builder.rb +0 -86
  253. data/lib/active_record/attribute_set.rb +0 -77
  254. data/lib/active_record/connection_adapters/mysql_adapter.rb +0 -491
  255. data/lib/active_record/connection_adapters/postgresql/array_parser.rb +0 -93
  256. data/lib/active_record/connection_adapters/postgresql/oid/float.rb +0 -21
  257. data/lib/active_record/connection_adapters/postgresql/oid/infinity.rb +0 -13
  258. data/lib/active_record/connection_adapters/postgresql/oid/json.rb +0 -35
  259. data/lib/active_record/connection_adapters/postgresql/oid/time.rb +0 -11
  260. data/lib/active_record/railties/jdbcmysql_error.rb +0 -16
  261. data/lib/active_record/serializers/xml_serializer.rb +0 -193
  262. data/lib/active_record/type/big_integer.rb +0 -13
  263. data/lib/active_record/type/binary.rb +0 -50
  264. data/lib/active_record/type/boolean.rb +0 -30
  265. data/lib/active_record/type/decimal.rb +0 -40
  266. data/lib/active_record/type/decorator.rb +0 -14
  267. data/lib/active_record/type/float.rb +0 -19
  268. data/lib/active_record/type/integer.rb +0 -55
  269. data/lib/active_record/type/mutable.rb +0 -16
  270. data/lib/active_record/type/numeric.rb +0 -36
  271. data/lib/active_record/type/string.rb +0 -36
  272. data/lib/active_record/type/time_value.rb +0 -38
  273. data/lib/active_record/type/value.rb +0 -101
  274. /data/lib/rails/generators/active_record/model/templates/{module.rb → module.rb.tt} +0 -0
@@ -1,266 +1,283 @@
1
+ # frozen_string_literal: true
2
+
1
3
  module ActiveRecord
2
- # = Active Record Aggregations
3
- module Aggregations # :nodoc:
4
+ # See ActiveRecord::Aggregations::ClassMethods for documentation
5
+ module Aggregations
4
6
  extend ActiveSupport::Concern
5
7
 
6
- def clear_aggregation_cache #:nodoc:
7
- @aggregation_cache.clear if persisted?
8
+ def initialize_dup(*) # :nodoc:
9
+ @aggregation_cache = {}
10
+ super
8
11
  end
9
12
 
10
- # Active Record implements aggregation through a macro-like class method called +composed_of+
11
- # for representing attributes as value objects. It expresses relationships like "Account [is]
12
- # composed of Money [among other things]" or "Person [is] composed of [an] address". Each call
13
- # to the macro adds a description of how the value objects are created from the attributes of
14
- # the entity object (when the entity is initialized either as a new object or from finding an
15
- # existing object) and how it can be turned back into attributes (when the entity is saved to
16
- # the database).
17
- #
18
- # class Customer < ActiveRecord::Base
19
- # composed_of :balance, class_name: "Money", mapping: %w(balance amount)
20
- # composed_of :address, mapping: [ %w(address_street street), %w(address_city city) ]
21
- # end
22
- #
23
- # The customer class now has the following methods to manipulate the value objects:
24
- # * <tt>Customer#balance, Customer#balance=(money)</tt>
25
- # * <tt>Customer#address, Customer#address=(address)</tt>
26
- #
27
- # These methods will operate with value objects like the ones described below:
28
- #
29
- # class Money
30
- # include Comparable
31
- # attr_reader :amount, :currency
32
- # EXCHANGE_RATES = { "USD_TO_DKK" => 6 }
33
- #
34
- # def initialize(amount, currency = "USD")
35
- # @amount, @currency = amount, currency
36
- # end
37
- #
38
- # def exchange_to(other_currency)
39
- # exchanged_amount = (amount * EXCHANGE_RATES["#{currency}_TO_#{other_currency}"]).floor
40
- # Money.new(exchanged_amount, other_currency)
41
- # end
42
- #
43
- # def ==(other_money)
44
- # amount == other_money.amount && currency == other_money.currency
45
- # end
46
- #
47
- # def <=>(other_money)
48
- # if currency == other_money.currency
49
- # amount <=> other_money.amount
50
- # else
51
- # amount <=> other_money.exchange_to(currency).amount
52
- # end
53
- # end
54
- # end
55
- #
56
- # class Address
57
- # attr_reader :street, :city
58
- # def initialize(street, city)
59
- # @street, @city = street, city
60
- # end
61
- #
62
- # def close_to?(other_address)
63
- # city == other_address.city
64
- # end
65
- #
66
- # def ==(other_address)
67
- # city == other_address.city && street == other_address.street
68
- # end
69
- # end
70
- #
71
- # Now it's possible to access attributes from the database through the value objects instead. If
72
- # you choose to name the composition the same as the attribute's name, it will be the only way to
73
- # access that attribute. That's the case with our +balance+ attribute. You interact with the value
74
- # objects just like you would with any other attribute:
75
- #
76
- # customer.balance = Money.new(20) # sets the Money value object and the attribute
77
- # customer.balance # => Money value object
78
- # customer.balance.exchange_to("DKK") # => Money.new(120, "DKK")
79
- # customer.balance > Money.new(10) # => true
80
- # customer.balance == Money.new(20) # => true
81
- # customer.balance < Money.new(5) # => false
82
- #
83
- # Value objects can also be composed of multiple attributes, such as the case of Address. The order
84
- # of the mappings will determine the order of the parameters.
85
- #
86
- # customer.address_street = "Hyancintvej"
87
- # customer.address_city = "Copenhagen"
88
- # customer.address # => Address.new("Hyancintvej", "Copenhagen")
89
- #
90
- # customer.address_street = "Vesterbrogade"
91
- # customer.address # => Address.new("Hyancintvej", "Copenhagen")
92
- # customer.clear_aggregation_cache
93
- # customer.address # => Address.new("Vesterbrogade", "Copenhagen")
94
- #
95
- # customer.address = Address.new("May Street", "Chicago")
96
- # customer.address_street # => "May Street"
97
- # customer.address_city # => "Chicago"
98
- #
99
- # == Writing value objects
100
- #
101
- # Value objects are immutable and interchangeable objects that represent a given value, such as
102
- # a Money object representing $5. Two Money objects both representing $5 should be equal (through
103
- # methods such as <tt>==</tt> and <tt><=></tt> from Comparable if ranking makes sense). This is
104
- # unlike entity objects where equality is determined by identity. An entity class such as Customer can
105
- # easily have two different objects that both have an address on Hyancintvej. Entity identity is
106
- # determined by object or relational unique identifiers (such as primary keys). Normal
107
- # ActiveRecord::Base classes are entity objects.
108
- #
109
- # It's also important to treat the value objects as immutable. Don't allow the Money object to have
110
- # its amount changed after creation. Create a new Money object with the new value instead. The
111
- # Money#exchange_to method is an example of this. It returns a new value object instead of changing
112
- # its own values. Active Record won't persist value objects that have been changed through means
113
- # other than the writer method.
114
- #
115
- # The immutable requirement is enforced by Active Record by freezing any object assigned as a value
116
- # object. Attempting to change it afterwards will result in a RuntimeError.
117
- #
118
- # Read more about value objects on http://c2.com/cgi/wiki?ValueObject and on the dangers of not
119
- # keeping value objects immutable on http://c2.com/cgi/wiki?ValueObjectsShouldBeImmutable
120
- #
121
- # == Custom constructors and converters
122
- #
123
- # By default value objects are initialized by calling the <tt>new</tt> constructor of the value
124
- # class passing each of the mapped attributes, in the order specified by the <tt>:mapping</tt>
125
- # option, as arguments. If the value class doesn't support this convention then +composed_of+ allows
126
- # a custom constructor to be specified.
127
- #
128
- # When a new value is assigned to the value object, the default assumption is that the new value
129
- # is an instance of the value class. Specifying a custom converter allows the new value to be automatically
130
- # converted to an instance of value class if necessary.
131
- #
132
- # For example, the NetworkResource model has +network_address+ and +cidr_range+ attributes that should be
133
- # aggregated using the NetAddr::CIDR value class (http://www.ruby-doc.org/gems/docs/n/netaddr-1.5.0/NetAddr/CIDR.html).
134
- # The constructor for the value class is called +create+ and it expects a CIDR address string as a parameter.
135
- # New values can be assigned to the value object using either another NetAddr::CIDR object, a string
136
- # or an array. The <tt>:constructor</tt> and <tt>:converter</tt> options can be used to meet
137
- # these requirements:
138
- #
139
- # class NetworkResource < ActiveRecord::Base
140
- # composed_of :cidr,
141
- # class_name: 'NetAddr::CIDR',
142
- # mapping: [ %w(network_address network), %w(cidr_range bits) ],
143
- # allow_nil: true,
144
- # constructor: Proc.new { |network_address, cidr_range| NetAddr::CIDR.create("#{network_address}/#{cidr_range}") },
145
- # converter: Proc.new { |value| NetAddr::CIDR.create(value.is_a?(Array) ? value.join('/') : value) }
146
- # end
147
- #
148
- # # This calls the :constructor
149
- # network_resource = NetworkResource.new(network_address: '192.168.0.1', cidr_range: 24)
150
- #
151
- # # These assignments will both use the :converter
152
- # network_resource.cidr = [ '192.168.2.1', 8 ]
153
- # network_resource.cidr = '192.168.0.1/24'
154
- #
155
- # # This assignment won't use the :converter as the value is already an instance of the value class
156
- # network_resource.cidr = NetAddr::CIDR.create('192.168.2.1/8')
157
- #
158
- # # Saving and then reloading will use the :constructor on reload
159
- # network_resource.save
160
- # network_resource.reload
161
- #
162
- # == Finding records by a value object
163
- #
164
- # Once a +composed_of+ relationship is specified for a model, records can be loaded from the database
165
- # by specifying an instance of the value object in the conditions hash. The following example
166
- # finds all customers with +balance_amount+ equal to 20 and +balance_currency+ equal to "USD":
167
- #
168
- # Customer.where(balance: Money.new(20, "USD"))
169
- #
170
- module ClassMethods
171
- # Adds reader and writer methods for manipulating a value object:
172
- # <tt>composed_of :address</tt> adds <tt>address</tt> and <tt>address=(new_address)</tt> methods.
173
- #
174
- # Options are:
175
- # * <tt>:class_name</tt> - Specifies the class name of the association. Use it only if that name
176
- # can't be inferred from the part id. So <tt>composed_of :address</tt> will by default be linked
177
- # to the Address class, but if the real class name is CompanyAddress, you'll have to specify it
178
- # with this option.
179
- # * <tt>:mapping</tt> - Specifies the mapping of entity attributes to attributes of the value
180
- # object. Each mapping is represented as an array where the first item is the name of the
181
- # entity attribute and the second item is the name of the attribute in the value object. The
182
- # order in which mappings are defined determines the order in which attributes are sent to the
183
- # value class constructor.
184
- # * <tt>:allow_nil</tt> - Specifies that the value object will not be instantiated when all mapped
185
- # attributes are +nil+. Setting the value object to +nil+ has the effect of writing +nil+ to all
186
- # mapped attributes.
187
- # This defaults to +false+.
188
- # * <tt>:constructor</tt> - A symbol specifying the name of the constructor method or a Proc that
189
- # is called to initialize the value object. The constructor is passed all of the mapped attributes,
190
- # in the order that they are defined in the <tt>:mapping option</tt>, as arguments and uses them
191
- # to instantiate a <tt>:class_name</tt> object.
192
- # The default is <tt>:new</tt>.
193
- # * <tt>:converter</tt> - A symbol specifying the name of a class method of <tt>:class_name</tt>
194
- # or a Proc that is called when a new value is assigned to the value object. The converter is
195
- # passed the single value that is used in the assignment and is only called if the new value is
196
- # not an instance of <tt>:class_name</tt>. If <tt>:allow_nil</tt> is set to true, the converter
197
- # can return nil to skip the assignment.
198
- #
199
- # Option examples:
200
- # composed_of :temperature, mapping: %w(reading celsius)
201
- # composed_of :balance, class_name: "Money", mapping: %w(balance amount),
202
- # converter: Proc.new { |balance| balance.to_money }
203
- # composed_of :address, mapping: [ %w(address_street street), %w(address_city city) ]
204
- # composed_of :gps_location
205
- # composed_of :gps_location, allow_nil: true
206
- # composed_of :ip_address,
207
- # class_name: 'IPAddr',
208
- # mapping: %w(ip to_i),
209
- # constructor: Proc.new { |ip| IPAddr.new(ip, Socket::AF_INET) },
210
- # converter: Proc.new { |ip| ip.is_a?(Integer) ? IPAddr.new(ip, Socket::AF_INET) : IPAddr.new(ip.to_s) }
211
- #
212
- def composed_of(part_id, options = {})
213
- options.assert_valid_keys(:class_name, :mapping, :allow_nil, :constructor, :converter)
13
+ def reload(*) # :nodoc:
14
+ clear_aggregation_cache
15
+ super
16
+ end
214
17
 
215
- name = part_id.id2name
216
- class_name = options[:class_name] || name.camelize
217
- mapping = options[:mapping] || [ name, name ]
218
- mapping = [ mapping ] unless mapping.first.is_a?(Array)
219
- allow_nil = options[:allow_nil] || false
220
- constructor = options[:constructor] || :new
221
- converter = options[:converter]
18
+ private
222
19
 
223
- reader_method(name, class_name, mapping, allow_nil, constructor)
224
- writer_method(name, class_name, mapping, allow_nil, converter)
20
+ def clear_aggregation_cache
21
+ @aggregation_cache.clear if persisted?
22
+ end
225
23
 
226
- reflection = ActiveRecord::Reflection.create(:composed_of, part_id, nil, options, self)
227
- Reflection.add_aggregate_reflection self, part_id, reflection
24
+ def init_internals
25
+ @aggregation_cache = {}
26
+ super
228
27
  end
229
28
 
230
- private
231
- def reader_method(name, class_name, mapping, allow_nil, constructor)
232
- define_method(name) do
233
- if @aggregation_cache[name].nil? && (!allow_nil || mapping.any? {|key, _| !_read_attribute(key).nil? })
234
- attrs = mapping.collect {|key, _| _read_attribute(key)}
235
- object = constructor.respond_to?(:call) ?
236
- constructor.call(*attrs) :
237
- class_name.constantize.send(constructor, *attrs)
238
- @aggregation_cache[name] = object
239
- end
240
- @aggregation_cache[name]
241
- end
29
+ # Active Record implements aggregation through a macro-like class method called #composed_of
30
+ # for representing attributes as value objects. It expresses relationships like "Account [is]
31
+ # composed of Money [among other things]" or "Person [is] composed of [an] address". Each call
32
+ # to the macro adds a description of how the value objects are created from the attributes of
33
+ # the entity object (when the entity is initialized either as a new object or from finding an
34
+ # existing object) and how it can be turned back into attributes (when the entity is saved to
35
+ # the database).
36
+ #
37
+ # class Customer < ActiveRecord::Base
38
+ # composed_of :balance, class_name: "Money", mapping: %w(balance amount)
39
+ # composed_of :address, mapping: [ %w(address_street street), %w(address_city city) ]
40
+ # end
41
+ #
42
+ # The customer class now has the following methods to manipulate the value objects:
43
+ # * <tt>Customer#balance, Customer#balance=(money)</tt>
44
+ # * <tt>Customer#address, Customer#address=(address)</tt>
45
+ #
46
+ # These methods will operate with value objects like the ones described below:
47
+ #
48
+ # class Money
49
+ # include Comparable
50
+ # attr_reader :amount, :currency
51
+ # EXCHANGE_RATES = { "USD_TO_DKK" => 6 }
52
+ #
53
+ # def initialize(amount, currency = "USD")
54
+ # @amount, @currency = amount, currency
55
+ # end
56
+ #
57
+ # def exchange_to(other_currency)
58
+ # exchanged_amount = (amount * EXCHANGE_RATES["#{currency}_TO_#{other_currency}"]).floor
59
+ # Money.new(exchanged_amount, other_currency)
60
+ # end
61
+ #
62
+ # def ==(other_money)
63
+ # amount == other_money.amount && currency == other_money.currency
64
+ # end
65
+ #
66
+ # def <=>(other_money)
67
+ # if currency == other_money.currency
68
+ # amount <=> other_money.amount
69
+ # else
70
+ # amount <=> other_money.exchange_to(currency).amount
71
+ # end
72
+ # end
73
+ # end
74
+ #
75
+ # class Address
76
+ # attr_reader :street, :city
77
+ # def initialize(street, city)
78
+ # @street, @city = street, city
79
+ # end
80
+ #
81
+ # def close_to?(other_address)
82
+ # city == other_address.city
83
+ # end
84
+ #
85
+ # def ==(other_address)
86
+ # city == other_address.city && street == other_address.street
87
+ # end
88
+ # end
89
+ #
90
+ # Now it's possible to access attributes from the database through the value objects instead. If
91
+ # you choose to name the composition the same as the attribute's name, it will be the only way to
92
+ # access that attribute. That's the case with our +balance+ attribute. You interact with the value
93
+ # objects just like you would with any other attribute:
94
+ #
95
+ # customer.balance = Money.new(20) # sets the Money value object and the attribute
96
+ # customer.balance # => Money value object
97
+ # customer.balance.exchange_to("DKK") # => Money.new(120, "DKK")
98
+ # customer.balance > Money.new(10) # => true
99
+ # customer.balance == Money.new(20) # => true
100
+ # customer.balance < Money.new(5) # => false
101
+ #
102
+ # Value objects can also be composed of multiple attributes, such as the case of Address. The order
103
+ # of the mappings will determine the order of the parameters.
104
+ #
105
+ # customer.address_street = "Hyancintvej"
106
+ # customer.address_city = "Copenhagen"
107
+ # customer.address # => Address.new("Hyancintvej", "Copenhagen")
108
+ #
109
+ # customer.address = Address.new("May Street", "Chicago")
110
+ # customer.address_street # => "May Street"
111
+ # customer.address_city # => "Chicago"
112
+ #
113
+ # == Writing value objects
114
+ #
115
+ # Value objects are immutable and interchangeable objects that represent a given value, such as
116
+ # a Money object representing $5. Two Money objects both representing $5 should be equal (through
117
+ # methods such as <tt>==</tt> and <tt><=></tt> from Comparable if ranking makes sense). This is
118
+ # unlike entity objects where equality is determined by identity. An entity class such as Customer can
119
+ # easily have two different objects that both have an address on Hyancintvej. Entity identity is
120
+ # determined by object or relational unique identifiers (such as primary keys). Normal
121
+ # ActiveRecord::Base classes are entity objects.
122
+ #
123
+ # It's also important to treat the value objects as immutable. Don't allow the Money object to have
124
+ # its amount changed after creation. Create a new Money object with the new value instead. The
125
+ # <tt>Money#exchange_to</tt> method is an example of this. It returns a new value object instead of changing
126
+ # its own values. Active Record won't persist value objects that have been changed through means
127
+ # other than the writer method.
128
+ #
129
+ # The immutable requirement is enforced by Active Record by freezing any object assigned as a value
130
+ # object. Attempting to change it afterwards will result in a +RuntimeError+.
131
+ #
132
+ # Read more about value objects on http://c2.com/cgi/wiki?ValueObject and on the dangers of not
133
+ # keeping value objects immutable on http://c2.com/cgi/wiki?ValueObjectsShouldBeImmutable
134
+ #
135
+ # == Custom constructors and converters
136
+ #
137
+ # By default value objects are initialized by calling the <tt>new</tt> constructor of the value
138
+ # class passing each of the mapped attributes, in the order specified by the <tt>:mapping</tt>
139
+ # option, as arguments. If the value class doesn't support this convention then #composed_of allows
140
+ # a custom constructor to be specified.
141
+ #
142
+ # When a new value is assigned to the value object, the default assumption is that the new value
143
+ # is an instance of the value class. Specifying a custom converter allows the new value to be automatically
144
+ # converted to an instance of value class if necessary.
145
+ #
146
+ # For example, the +NetworkResource+ model has +network_address+ and +cidr_range+ attributes that should be
147
+ # aggregated using the +NetAddr::CIDR+ value class (http://www.rubydoc.info/gems/netaddr/1.5.0/NetAddr/CIDR).
148
+ # The constructor for the value class is called +create+ and it expects a CIDR address string as a parameter.
149
+ # New values can be assigned to the value object using either another +NetAddr::CIDR+ object, a string
150
+ # or an array. The <tt>:constructor</tt> and <tt>:converter</tt> options can be used to meet
151
+ # these requirements:
152
+ #
153
+ # class NetworkResource < ActiveRecord::Base
154
+ # composed_of :cidr,
155
+ # class_name: 'NetAddr::CIDR',
156
+ # mapping: [ %w(network_address network), %w(cidr_range bits) ],
157
+ # allow_nil: true,
158
+ # constructor: Proc.new { |network_address, cidr_range| NetAddr::CIDR.create("#{network_address}/#{cidr_range}") },
159
+ # converter: Proc.new { |value| NetAddr::CIDR.create(value.is_a?(Array) ? value.join('/') : value) }
160
+ # end
161
+ #
162
+ # # This calls the :constructor
163
+ # network_resource = NetworkResource.new(network_address: '192.168.0.1', cidr_range: 24)
164
+ #
165
+ # # These assignments will both use the :converter
166
+ # network_resource.cidr = [ '192.168.2.1', 8 ]
167
+ # network_resource.cidr = '192.168.0.1/24'
168
+ #
169
+ # # This assignment won't use the :converter as the value is already an instance of the value class
170
+ # network_resource.cidr = NetAddr::CIDR.create('192.168.2.1/8')
171
+ #
172
+ # # Saving and then reloading will use the :constructor on reload
173
+ # network_resource.save
174
+ # network_resource.reload
175
+ #
176
+ # == Finding records by a value object
177
+ #
178
+ # Once a #composed_of relationship is specified for a model, records can be loaded from the database
179
+ # by specifying an instance of the value object in the conditions hash. The following example
180
+ # finds all customers with +address_street+ equal to "May Street" and +address_city+ equal to "Chicago":
181
+ #
182
+ # Customer.where(address: Address.new("May Street", "Chicago"))
183
+ #
184
+ module ClassMethods
185
+ # Adds reader and writer methods for manipulating a value object:
186
+ # <tt>composed_of :address</tt> adds <tt>address</tt> and <tt>address=(new_address)</tt> methods.
187
+ #
188
+ # Options are:
189
+ # * <tt>:class_name</tt> - Specifies the class name of the association. Use it only if that name
190
+ # can't be inferred from the part id. So <tt>composed_of :address</tt> will by default be linked
191
+ # to the Address class, but if the real class name is +CompanyAddress+, you'll have to specify it
192
+ # with this option.
193
+ # * <tt>:mapping</tt> - Specifies the mapping of entity attributes to attributes of the value
194
+ # object. Each mapping is represented as an array where the first item is the name of the
195
+ # entity attribute and the second item is the name of the attribute in the value object. The
196
+ # order in which mappings are defined determines the order in which attributes are sent to the
197
+ # value class constructor.
198
+ # * <tt>:allow_nil</tt> - Specifies that the value object will not be instantiated when all mapped
199
+ # attributes are +nil+. Setting the value object to +nil+ has the effect of writing +nil+ to all
200
+ # mapped attributes.
201
+ # This defaults to +false+.
202
+ # * <tt>:constructor</tt> - A symbol specifying the name of the constructor method or a Proc that
203
+ # is called to initialize the value object. The constructor is passed all of the mapped attributes,
204
+ # in the order that they are defined in the <tt>:mapping option</tt>, as arguments and uses them
205
+ # to instantiate a <tt>:class_name</tt> object.
206
+ # The default is <tt>:new</tt>.
207
+ # * <tt>:converter</tt> - A symbol specifying the name of a class method of <tt>:class_name</tt>
208
+ # or a Proc that is called when a new value is assigned to the value object. The converter is
209
+ # passed the single value that is used in the assignment and is only called if the new value is
210
+ # not an instance of <tt>:class_name</tt>. If <tt>:allow_nil</tt> is set to true, the converter
211
+ # can return +nil+ to skip the assignment.
212
+ #
213
+ # Option examples:
214
+ # composed_of :temperature, mapping: %w(reading celsius)
215
+ # composed_of :balance, class_name: "Money", mapping: %w(balance amount)
216
+ # composed_of :address, mapping: [ %w(address_street street), %w(address_city city) ]
217
+ # composed_of :gps_location
218
+ # composed_of :gps_location, allow_nil: true
219
+ # composed_of :ip_address,
220
+ # class_name: 'IPAddr',
221
+ # mapping: %w(ip to_i),
222
+ # constructor: Proc.new { |ip| IPAddr.new(ip, Socket::AF_INET) },
223
+ # converter: Proc.new { |ip| ip.is_a?(Integer) ? IPAddr.new(ip, Socket::AF_INET) : IPAddr.new(ip.to_s) }
224
+ #
225
+ def composed_of(part_id, options = {})
226
+ options.assert_valid_keys(:class_name, :mapping, :allow_nil, :constructor, :converter)
227
+
228
+ name = part_id.id2name
229
+ class_name = options[:class_name] || name.camelize
230
+ mapping = options[:mapping] || [ name, name ]
231
+ mapping = [ mapping ] unless mapping.first.is_a?(Array)
232
+ allow_nil = options[:allow_nil] || false
233
+ constructor = options[:constructor] || :new
234
+ converter = options[:converter]
235
+
236
+ reader_method(name, class_name, mapping, allow_nil, constructor)
237
+ writer_method(name, class_name, mapping, allow_nil, converter)
238
+
239
+ reflection = ActiveRecord::Reflection.create(:composed_of, part_id, nil, options, self)
240
+ Reflection.add_aggregate_reflection self, part_id, reflection
242
241
  end
243
242
 
244
- def writer_method(name, class_name, mapping, allow_nil, converter)
245
- define_method("#{name}=") do |part|
246
- klass = class_name.constantize
247
- if part.is_a?(Hash)
248
- part = klass.new(*part.values)
243
+ private
244
+ def reader_method(name, class_name, mapping, allow_nil, constructor)
245
+ define_method(name) do
246
+ if @aggregation_cache[name].nil? && (!allow_nil || mapping.any? { |key, _| !_read_attribute(key).nil? })
247
+ attrs = mapping.collect { |key, _| _read_attribute(key) }
248
+ object = constructor.respond_to?(:call) ?
249
+ constructor.call(*attrs) :
250
+ class_name.constantize.send(constructor, *attrs)
251
+ @aggregation_cache[name] = object
252
+ end
253
+ @aggregation_cache[name]
249
254
  end
255
+ end
250
256
 
251
- unless part.is_a?(klass) || converter.nil? || part.nil?
252
- part = converter.respond_to?(:call) ? converter.call(part) : klass.send(converter, part)
253
- end
257
+ def writer_method(name, class_name, mapping, allow_nil, converter)
258
+ define_method("#{name}=") do |part|
259
+ klass = class_name.constantize
260
+
261
+ unless part.is_a?(klass) || converter.nil? || part.nil?
262
+ part = converter.respond_to?(:call) ? converter.call(part) : klass.send(converter, part)
263
+ end
264
+
265
+ hash_from_multiparameter_assignment = part.is_a?(Hash) &&
266
+ part.each_key.all? { |k| k.is_a?(Integer) }
267
+ if hash_from_multiparameter_assignment
268
+ raise ArgumentError unless part.size == part.each_key.max
269
+ part = klass.new(*part.sort.map(&:last))
270
+ end
254
271
 
255
- if part.nil? && allow_nil
256
- mapping.each { |key, _| self[key] = nil }
257
- @aggregation_cache[name] = nil
258
- else
259
- mapping.each { |key, value| self[key] = part.send(value) }
260
- @aggregation_cache[name] = part.freeze
272
+ if part.nil? && allow_nil
273
+ mapping.each { |key, _| self[key] = nil }
274
+ @aggregation_cache[name] = nil
275
+ else
276
+ mapping.each { |key, value| self[key] = part.send(value) }
277
+ @aggregation_cache[name] = part.freeze
278
+ end
261
279
  end
262
280
  end
263
- end
264
- end
281
+ end
265
282
  end
266
283
  end
@@ -1,7 +1,9 @@
1
+ # frozen_string_literal: true
2
+
1
3
  module ActiveRecord
2
4
  class AssociationRelation < Relation
3
- def initialize(klass, table, association)
4
- super(klass, table)
5
+ def initialize(klass, association)
6
+ super(klass)
5
7
  @association = association
6
8
  end
7
9
 
@@ -10,13 +12,29 @@ module ActiveRecord
10
12
  end
11
13
 
12
14
  def ==(other)
13
- other == to_a
15
+ other == records
14
16
  end
15
17
 
16
- private
18
+ def build(*args, &block)
19
+ scoping { @association.build(*args, &block) }
20
+ end
21
+ alias new build
22
+
23
+ def create(*args, &block)
24
+ scoping { @association.create(*args, &block) }
25
+ end
17
26
 
18
- def exec_queries
19
- super.each { |r| @association.set_inverse_instance r }
27
+ def create!(*args, &block)
28
+ scoping { @association.create!(*args, &block) }
20
29
  end
30
+
31
+ private
32
+
33
+ def exec_queries
34
+ super do |record|
35
+ @association.set_inverse_instance_from_queries(record)
36
+ yield record if block_given?
37
+ end
38
+ end
21
39
  end
22
40
  end