activerecord 3.2.22.5 → 5.2.8

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

Potentially problematic release.


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

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