active_model_serializers 0.8.3 → 0.10.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (232) hide show
  1. checksums.yaml +4 -4
  2. data/.github/ISSUE_TEMPLATE.md +29 -0
  3. data/.github/PULL_REQUEST_TEMPLATE.md +15 -0
  4. data/.gitignore +17 -0
  5. data/.rubocop.yml +104 -0
  6. data/.rubocop_todo.yml +167 -0
  7. data/.simplecov +110 -0
  8. data/.travis.yml +39 -24
  9. data/CHANGELOG.md +465 -6
  10. data/CONTRIBUTING.md +105 -0
  11. data/Gemfile +50 -1
  12. data/{MIT-LICENSE.txt → MIT-LICENSE} +3 -2
  13. data/README.md +102 -590
  14. data/Rakefile +93 -8
  15. data/active_model_serializers.gemspec +65 -23
  16. data/appveyor.yml +24 -0
  17. data/bin/bench +171 -0
  18. data/bin/bench_regression +316 -0
  19. data/bin/serve_benchmark +39 -0
  20. data/docs/ARCHITECTURE.md +126 -0
  21. data/docs/README.md +40 -0
  22. data/docs/STYLE.md +58 -0
  23. data/docs/general/adapters.md +245 -0
  24. data/docs/general/caching.md +52 -0
  25. data/docs/general/configuration_options.md +100 -0
  26. data/docs/general/deserialization.md +100 -0
  27. data/docs/general/getting_started.md +133 -0
  28. data/docs/general/instrumentation.md +40 -0
  29. data/docs/general/key_transforms.md +40 -0
  30. data/docs/general/logging.md +14 -0
  31. data/docs/general/rendering.md +255 -0
  32. data/docs/general/serializers.md +372 -0
  33. data/docs/how-open-source-maintained.jpg +0 -0
  34. data/docs/howto/add_pagination_links.md +139 -0
  35. data/docs/howto/add_root_key.md +51 -0
  36. data/docs/howto/outside_controller_use.md +58 -0
  37. data/docs/howto/passing_arbitrary_options.md +27 -0
  38. data/docs/howto/serialize_poro.md +32 -0
  39. data/docs/howto/test.md +152 -0
  40. data/docs/integrations/ember-and-json-api.md +112 -0
  41. data/docs/integrations/grape.md +19 -0
  42. data/docs/jsonapi/errors.md +56 -0
  43. data/docs/jsonapi/schema/schema.json +366 -0
  44. data/docs/jsonapi/schema.md +151 -0
  45. data/docs/rfcs/0000-namespace.md +106 -0
  46. data/docs/rfcs/template.md +15 -0
  47. data/lib/action_controller/serialization.rb +31 -36
  48. data/lib/active_model/serializable_resource.rb +11 -0
  49. data/lib/active_model/serializer/adapter/attributes.rb +15 -0
  50. data/lib/active_model/serializer/adapter/base.rb +16 -0
  51. data/lib/active_model/serializer/adapter/json.rb +15 -0
  52. data/lib/active_model/serializer/adapter/json_api.rb +15 -0
  53. data/lib/active_model/serializer/adapter/null.rb +15 -0
  54. data/lib/active_model/serializer/adapter.rb +24 -0
  55. data/lib/active_model/serializer/array_serializer.rb +9 -0
  56. data/lib/active_model/serializer/association.rb +19 -0
  57. data/lib/active_model/serializer/associations.rb +87 -220
  58. data/lib/active_model/serializer/attribute.rb +25 -0
  59. data/lib/active_model/serializer/attributes.rb +82 -0
  60. data/lib/active_model/serializer/belongs_to_reflection.rb +10 -0
  61. data/lib/active_model/serializer/caching.rb +333 -0
  62. data/lib/active_model/serializer/collection_reflection.rb +7 -0
  63. data/lib/active_model/serializer/collection_serializer.rb +64 -0
  64. data/lib/active_model/serializer/configuration.rb +35 -0
  65. data/lib/active_model/serializer/error_serializer.rb +10 -0
  66. data/lib/active_model/serializer/errors_serializer.rb +27 -0
  67. data/lib/active_model/serializer/field.rb +90 -0
  68. data/lib/active_model/serializer/fieldset.rb +31 -0
  69. data/lib/active_model/serializer/has_many_reflection.rb +10 -0
  70. data/lib/active_model/serializer/has_one_reflection.rb +10 -0
  71. data/lib/active_model/serializer/include_tree.rb +111 -0
  72. data/lib/active_model/serializer/links.rb +35 -0
  73. data/lib/active_model/serializer/lint.rb +146 -0
  74. data/lib/active_model/serializer/meta.rb +29 -0
  75. data/lib/active_model/serializer/null.rb +17 -0
  76. data/lib/active_model/serializer/reflection.rb +147 -0
  77. data/lib/active_model/serializer/singular_reflection.rb +7 -0
  78. data/lib/active_model/serializer/type.rb +25 -0
  79. data/lib/active_model/{serializers → serializer}/version.rb +1 -1
  80. data/lib/active_model/serializer.rb +158 -481
  81. data/lib/active_model_serializers/adapter/attributes.rb +76 -0
  82. data/lib/active_model_serializers/adapter/base.rb +83 -0
  83. data/lib/active_model_serializers/adapter/json.rb +21 -0
  84. data/lib/active_model_serializers/adapter/json_api/deserialization.rb +213 -0
  85. data/lib/active_model_serializers/adapter/json_api/error.rb +96 -0
  86. data/lib/active_model_serializers/adapter/json_api/jsonapi.rb +49 -0
  87. data/lib/active_model_serializers/adapter/json_api/link.rb +83 -0
  88. data/lib/active_model_serializers/adapter/json_api/meta.rb +37 -0
  89. data/lib/active_model_serializers/adapter/json_api/pagination_links.rb +62 -0
  90. data/lib/active_model_serializers/adapter/json_api/relationship.rb +52 -0
  91. data/lib/active_model_serializers/adapter/json_api/resource_identifier.rb +37 -0
  92. data/lib/active_model_serializers/adapter/json_api.rb +516 -0
  93. data/lib/active_model_serializers/adapter/null.rb +9 -0
  94. data/lib/active_model_serializers/adapter.rb +92 -0
  95. data/lib/active_model_serializers/callbacks.rb +55 -0
  96. data/lib/active_model_serializers/deprecate.rb +55 -0
  97. data/lib/active_model_serializers/deserialization.rb +13 -0
  98. data/lib/active_model_serializers/json_pointer.rb +14 -0
  99. data/lib/active_model_serializers/key_transform.rb +70 -0
  100. data/lib/active_model_serializers/logging.rb +122 -0
  101. data/lib/active_model_serializers/model.rb +49 -0
  102. data/lib/active_model_serializers/railtie.rb +46 -0
  103. data/lib/active_model_serializers/register_jsonapi_renderer.rb +65 -0
  104. data/lib/active_model_serializers/serializable_resource.rb +81 -0
  105. data/lib/active_model_serializers/serialization_context.rb +32 -0
  106. data/lib/active_model_serializers/test/schema.rb +138 -0
  107. data/lib/active_model_serializers/test/serializer.rb +125 -0
  108. data/lib/active_model_serializers/test.rb +7 -0
  109. data/lib/active_model_serializers.rb +32 -89
  110. data/lib/generators/rails/USAGE +6 -0
  111. data/lib/generators/rails/resource_override.rb +10 -0
  112. data/lib/generators/rails/serializer_generator.rb +36 -0
  113. data/lib/generators/rails/templates/serializer.rb.erb +8 -0
  114. data/lib/grape/active_model_serializers.rb +14 -0
  115. data/lib/grape/formatters/active_model_serializers.rb +15 -0
  116. data/lib/grape/helpers/active_model_serializers.rb +16 -0
  117. data/test/action_controller/adapter_selector_test.rb +53 -0
  118. data/test/action_controller/explicit_serializer_test.rb +134 -0
  119. data/test/action_controller/json/include_test.rb +167 -0
  120. data/test/action_controller/json_api/deserialization_test.rb +112 -0
  121. data/test/action_controller/json_api/errors_test.rb +41 -0
  122. data/test/action_controller/json_api/linked_test.rb +197 -0
  123. data/test/action_controller/json_api/pagination_test.rb +116 -0
  124. data/test/action_controller/json_api/transform_test.rb +181 -0
  125. data/test/action_controller/serialization_scope_name_test.rb +229 -0
  126. data/test/action_controller/serialization_test.rb +469 -0
  127. data/test/active_model_serializers/adapter_for_test.rb +208 -0
  128. data/test/active_model_serializers/json_pointer_test.rb +20 -0
  129. data/test/active_model_serializers/key_transform_test.rb +263 -0
  130. data/test/active_model_serializers/logging_test.rb +77 -0
  131. data/test/active_model_serializers/model_test.rb +9 -0
  132. data/test/active_model_serializers/railtie_test_isolated.rb +63 -0
  133. data/test/active_model_serializers/serialization_context_test_isolated.rb +58 -0
  134. data/test/active_model_serializers/test/schema_test.rb +130 -0
  135. data/test/active_model_serializers/test/serializer_test.rb +62 -0
  136. data/test/active_record_test.rb +9 -0
  137. data/test/adapter/deprecation_test.rb +100 -0
  138. data/test/adapter/json/belongs_to_test.rb +45 -0
  139. data/test/adapter/json/collection_test.rb +90 -0
  140. data/test/adapter/json/has_many_test.rb +45 -0
  141. data/test/adapter/json/transform_test.rb +93 -0
  142. data/test/adapter/json_api/belongs_to_test.rb +155 -0
  143. data/test/adapter/json_api/collection_test.rb +95 -0
  144. data/test/adapter/json_api/errors_test.rb +78 -0
  145. data/test/adapter/json_api/fields_test.rb +87 -0
  146. data/test/adapter/json_api/has_many_embed_ids_test.rb +43 -0
  147. data/test/adapter/json_api/has_many_explicit_serializer_test.rb +96 -0
  148. data/test/adapter/json_api/has_many_test.rb +144 -0
  149. data/test/adapter/json_api/has_one_test.rb +80 -0
  150. data/test/adapter/json_api/json_api_test.rb +35 -0
  151. data/test/adapter/json_api/linked_test.rb +392 -0
  152. data/test/adapter/json_api/links_test.rb +93 -0
  153. data/test/adapter/json_api/pagination_links_test.rb +166 -0
  154. data/test/adapter/json_api/parse_test.rb +137 -0
  155. data/test/adapter/json_api/relationship_test.rb +161 -0
  156. data/test/adapter/json_api/relationships_test.rb +199 -0
  157. data/test/adapter/json_api/resource_identifier_test.rb +85 -0
  158. data/test/adapter/json_api/resource_meta_test.rb +100 -0
  159. data/test/adapter/json_api/toplevel_jsonapi_test.rb +82 -0
  160. data/test/adapter/json_api/transform_test.rb +502 -0
  161. data/test/adapter/json_api/type_test.rb +61 -0
  162. data/test/adapter/json_test.rb +45 -0
  163. data/test/adapter/null_test.rb +23 -0
  164. data/test/adapter/polymorphic_test.rb +171 -0
  165. data/test/adapter_test.rb +67 -0
  166. data/test/array_serializer_test.rb +20 -73
  167. data/test/benchmark/app.rb +65 -0
  168. data/test/benchmark/benchmarking_support.rb +67 -0
  169. data/test/benchmark/bm_caching.rb +119 -0
  170. data/test/benchmark/bm_transform.rb +34 -0
  171. data/test/benchmark/config.ru +3 -0
  172. data/test/benchmark/controllers.rb +84 -0
  173. data/test/benchmark/fixtures.rb +219 -0
  174. data/test/cache_test.rb +485 -0
  175. data/test/collection_serializer_test.rb +110 -0
  176. data/test/fixtures/active_record.rb +78 -0
  177. data/test/fixtures/poro.rb +282 -0
  178. data/test/generators/scaffold_controller_generator_test.rb +24 -0
  179. data/test/generators/serializer_generator_test.rb +57 -0
  180. data/test/grape_test.rb +82 -0
  181. data/test/include_tree/from_include_args_test.rb +26 -0
  182. data/test/include_tree/from_string_test.rb +94 -0
  183. data/test/include_tree/include_args_to_hash_test.rb +64 -0
  184. data/test/lint_test.rb +49 -0
  185. data/test/logger_test.rb +18 -0
  186. data/test/poro_test.rb +9 -0
  187. data/test/serializable_resource_test.rb +83 -0
  188. data/test/serializers/association_macros_test.rb +36 -0
  189. data/test/serializers/associations_test.rb +295 -0
  190. data/test/serializers/attribute_test.rb +151 -0
  191. data/test/serializers/attributes_test.rb +52 -0
  192. data/test/serializers/caching_configuration_test_isolated.rb +170 -0
  193. data/test/serializers/configuration_test.rb +32 -0
  194. data/test/serializers/fieldset_test.rb +14 -0
  195. data/test/serializers/meta_test.rb +196 -0
  196. data/test/serializers/options_test.rb +21 -0
  197. data/test/serializers/read_attribute_for_serialization_test.rb +79 -0
  198. data/test/serializers/root_test.rb +21 -0
  199. data/test/serializers/serialization_test.rb +55 -0
  200. data/test/serializers/serializer_for_test.rb +134 -0
  201. data/test/support/custom_schemas/active_model_serializers/test/schema_test/my/index.json +6 -0
  202. data/test/support/isolated_unit.rb +79 -0
  203. data/test/support/rails5_shims.rb +47 -0
  204. data/test/support/rails_app.rb +45 -0
  205. data/test/support/schemas/active_model_serializers/test/schema_test/my/index.json +6 -0
  206. data/test/support/schemas/active_model_serializers/test/schema_test/my/show.json +6 -0
  207. data/test/support/schemas/custom/show.json +7 -0
  208. data/test/support/schemas/hyper_schema.json +93 -0
  209. data/test/support/schemas/render_using_json_api.json +43 -0
  210. data/test/support/schemas/simple_json_pointers.json +10 -0
  211. data/test/support/serialization_testing.rb +53 -0
  212. data/test/test_helper.rb +48 -23
  213. metadata +449 -43
  214. data/DESIGN.textile +0 -586
  215. data/Gemfile.edge +0 -9
  216. data/bench/perf.rb +0 -43
  217. data/cruft.md +0 -19
  218. data/lib/active_model/array_serializer.rb +0 -104
  219. data/lib/active_record/serializer_override.rb +0 -16
  220. data/lib/generators/resource_override.rb +0 -13
  221. data/lib/generators/serializer/USAGE +0 -9
  222. data/lib/generators/serializer/serializer_generator.rb +0 -42
  223. data/lib/generators/serializer/templates/serializer.rb +0 -19
  224. data/test/association_test.rb +0 -592
  225. data/test/caching_test.rb +0 -96
  226. data/test/generators_test.rb +0 -85
  227. data/test/no_serialization_scope_test.rb +0 -34
  228. data/test/serialization_scope_name_test.rb +0 -67
  229. data/test/serialization_test.rb +0 -392
  230. data/test/serializer_support_test.rb +0 -51
  231. data/test/serializer_test.rb +0 -1465
  232. data/test/test_fakes.rb +0 -217
@@ -1,592 +0,0 @@
1
- require "test_helper"
2
-
3
- class AssociationTest < ActiveModel::TestCase
4
- def def_serializer(&block)
5
- Class.new(ActiveModel::Serializer, &block)
6
- end
7
-
8
- class Model
9
- def initialize(hash={})
10
- @attributes = hash
11
- end
12
-
13
- def read_attribute_for_serialization(name)
14
- @attributes[name]
15
- end
16
-
17
- def as_json(*)
18
- { :model => "Model" }
19
- end
20
-
21
- def method_missing(meth, *args)
22
- if meth.to_s =~ /^(.*)=$/
23
- @attributes[$1.to_sym] = args[0]
24
- elsif @attributes.key?(meth)
25
- @attributes[meth]
26
- else
27
- super
28
- end
29
- end
30
- end
31
-
32
- def setup
33
- @hash = {}
34
- @root_hash = {}
35
-
36
- @post = Model.new(:title => "New Post", :body => "Body")
37
- @comment = Model.new(:id => 1, :external_id => "COMM001", :body => "ZOMG A COMMENT")
38
- @post.comments = [ @comment ]
39
- @post.comment = @comment
40
-
41
- @comment_serializer_class = def_serializer do
42
- attributes :id, :external_id, :body
43
- end
44
-
45
- @post_serializer_class = def_serializer do
46
- attributes :title, :body
47
- end
48
-
49
- @post_serializer = @post_serializer_class.new(@post, :hash => @root_hash)
50
- end
51
-
52
- def include!(key, options={})
53
- @post_serializer.include! key, {
54
- :embed => :ids,
55
- :include => true,
56
- :node => @hash,
57
- :serializer => @comment_serializer_class
58
- }.merge(options)
59
- end
60
-
61
- def include_bare!(key, options={})
62
- @post_serializer.include! key, {
63
- :node => @hash,
64
- :serializer => @comment_serializer_class
65
- }.merge(options)
66
- end
67
-
68
- class NoDefaults < AssociationTest
69
- def test_include_bang_has_many_associations
70
- include! :comments, :value => @post.comments
71
-
72
- assert_equal({
73
- :comment_ids => [ 1 ]
74
- }, @hash)
75
-
76
- assert_equal({
77
- :comments => [
78
- { :id => 1, :external_id => "COMM001", :body => "ZOMG A COMMENT" }
79
- ]
80
- }, @root_hash)
81
- end
82
-
83
- def test_include_bang_with_embed_false
84
- include! :comments, :value => @post.comments, :embed => false
85
-
86
- assert_equal({}, @hash)
87
- assert_equal({}, @root_hash)
88
- end
89
-
90
- def test_include_bang_with_embed_ids_include_false
91
- include! :comments, :value => @post.comments, :embed => :ids, :include => false
92
-
93
- assert_equal({
94
- :comment_ids => [ 1 ]
95
- }, @hash)
96
-
97
- assert_equal({}, @root_hash)
98
- end
99
-
100
- def test_include_bang_has_one_associations
101
- include! :comment, :value => @post.comment
102
-
103
- assert_equal({
104
- :comment_id => 1
105
- }, @hash)
106
-
107
- assert_equal({
108
- :comments => [{ :id => 1, :external_id => "COMM001", :body => "ZOMG A COMMENT" }]
109
- }, @root_hash)
110
- end
111
- end
112
-
113
- class DefaultsTest < AssociationTest
114
- def test_with_default_has_many
115
- @post_serializer_class.class_eval do
116
- has_many :comments
117
- end
118
-
119
- include! :comments
120
-
121
- assert_equal({
122
- :comment_ids => [ 1 ]
123
- }, @hash)
124
-
125
- assert_equal({
126
- :comments => [
127
- { :id => 1, :external_id => "COMM001", :body => "ZOMG A COMMENT" }
128
- ]
129
- }, @root_hash)
130
- end
131
-
132
- def test_with_default_has_one
133
- @post_serializer_class.class_eval do
134
- has_one :comment
135
- end
136
-
137
- include! :comment
138
-
139
- assert_equal({
140
- :comment_id => 1
141
- }, @hash)
142
-
143
- assert_equal({
144
- :comments => [
145
- { :id => 1, :external_id => "COMM001", :body => "ZOMG A COMMENT" }
146
- ]
147
- }, @root_hash)
148
- end
149
-
150
- def test_with_default_has_many_with_custom_key
151
- @post_serializer_class.class_eval do
152
- has_many :comments, :key => :custom_comments
153
- end
154
-
155
- include! :comments
156
-
157
- assert_equal({
158
- :custom_comments => [ 1 ]
159
- }, @hash)
160
-
161
- assert_equal({
162
- :comments => [
163
- { :id => 1, :external_id => "COMM001", :body => "ZOMG A COMMENT" }
164
- ]
165
- }, @root_hash)
166
- end
167
-
168
- def test_with_default_has_one_with_custom_key
169
- @post_serializer_class.class_eval do
170
- has_one :comment, :key => :custom_comment_id
171
- end
172
-
173
- include! :comment
174
-
175
- assert_equal({
176
- :custom_comment_id => 1
177
- }, @hash)
178
-
179
- assert_equal({
180
- :comments => [
181
- { :id => 1, :external_id => "COMM001", :body => "ZOMG A COMMENT" }
182
- ]
183
- }, @root_hash)
184
- end
185
-
186
- def test_with_default_has_many_with_custom_embed_key
187
- @post_serializer_class.class_eval do
188
- has_many :comments, :embed_key => :external_id
189
- end
190
-
191
- include! :comments
192
-
193
- assert_equal({
194
- :comment_ids => [ "COMM001" ]
195
- }, @hash)
196
-
197
- assert_equal({
198
- :comments => [
199
- { :id => 1, :external_id => "COMM001", :body => "ZOMG A COMMENT" }
200
- ]
201
- }, @root_hash)
202
- end
203
-
204
- def test_with_default_has_one_with_custom_embed_key
205
- @post_serializer_class.class_eval do
206
- has_one :comment, :embed_key => :external_id
207
- end
208
-
209
- include! :comment
210
-
211
- assert_equal({
212
- :comment_id => "COMM001"
213
- }, @hash)
214
-
215
- assert_equal({
216
- :comments => [
217
- { :id => 1, :external_id => "COMM001", :body => "ZOMG A COMMENT" }
218
- ]
219
- }, @root_hash)
220
- end
221
-
222
- def test_with_default_has_many_with_custom_key_and_custom_embed_key
223
- @post_serializer_class.class_eval do
224
- has_many :comments, :key => :custom_comments, :embed_key => :external_id
225
- end
226
-
227
- include! :comments
228
-
229
- assert_equal({
230
- :custom_comments => [ "COMM001" ]
231
- }, @hash)
232
-
233
- assert_equal({
234
- :comments => [
235
- { :id => 1, :external_id => "COMM001", :body => "ZOMG A COMMENT" }
236
- ]
237
- }, @root_hash)
238
- end
239
-
240
- def test_with_default_has_one_with_custom_key_and_custom_embed_key
241
- @post_serializer_class.class_eval do
242
- has_one :comment, :key => :custom_comment, :embed_key => :external_id
243
- end
244
-
245
- include! :comment
246
-
247
- assert_equal({
248
- :custom_comment => "COMM001"
249
- }, @hash)
250
-
251
- assert_equal({
252
- :comments => [
253
- { :id => 1, :external_id => "COMM001", :body => "ZOMG A COMMENT" }
254
- ]
255
- }, @root_hash)
256
- end
257
-
258
- def test_embed_objects_for_has_many_associations
259
- @post_serializer_class.class_eval do
260
- has_many :comments, :embed => :objects
261
- end
262
-
263
- include_bare! :comments
264
-
265
- assert_equal({
266
- :comments => [
267
- { :id => 1, :external_id => "COMM001", :body => "ZOMG A COMMENT" }
268
- ]
269
- }, @hash)
270
-
271
- assert_equal({}, @root_hash)
272
- end
273
-
274
- def test_embed_ids_for_has_many_associations
275
- @post_serializer_class.class_eval do
276
- has_many :comments, :embed => :ids
277
- end
278
-
279
- include_bare! :comments
280
-
281
- assert_equal({
282
- :comment_ids => [ 1 ]
283
- }, @hash)
284
-
285
- assert_equal({}, @root_hash)
286
- end
287
-
288
- def test_embed_false_for_has_many_associations
289
- @post_serializer_class.class_eval do
290
- has_many :comments, :embed => false
291
- end
292
-
293
- include_bare! :comments
294
-
295
- assert_equal({}, @hash)
296
- assert_equal({}, @root_hash)
297
- end
298
-
299
- def test_embed_ids_include_true_for_has_many_associations
300
- @post_serializer_class.class_eval do
301
- has_many :comments, :embed => :ids, :include => true
302
- end
303
-
304
- include_bare! :comments
305
-
306
- assert_equal({
307
- :comment_ids => [ 1 ]
308
- }, @hash)
309
-
310
- assert_equal({
311
- :comments => [
312
- { :id => 1, :external_id => "COMM001", :body => "ZOMG A COMMENT" }
313
- ]
314
- }, @root_hash)
315
- end
316
-
317
- def test_embed_ids_for_has_one_associations
318
- @post_serializer_class.class_eval do
319
- has_one :comment, :embed => :ids
320
- end
321
-
322
- include_bare! :comment
323
-
324
- assert_equal({
325
- :comment_id => 1
326
- }, @hash)
327
-
328
- assert_equal({}, @root_hash)
329
- end
330
-
331
- def test_embed_false_for_has_one_associations
332
- @post_serializer_class.class_eval do
333
- has_one :comment, :embed => false
334
- end
335
-
336
- include_bare! :comment
337
-
338
- assert_equal({}, @hash)
339
- assert_equal({}, @root_hash)
340
- end
341
-
342
- def test_embed_ids_include_true_for_has_one_associations
343
- @post_serializer_class.class_eval do
344
- has_one :comment, :embed => :ids, :include => true
345
- end
346
-
347
- include_bare! :comment
348
-
349
- assert_equal({
350
- :comment_id => 1
351
- }, @hash)
352
-
353
- assert_equal({
354
- :comments => [
355
- { :id => 1, :external_id => "COMM001", :body => "ZOMG A COMMENT" }
356
- ]
357
- }, @root_hash)
358
- end
359
-
360
- def test_embed_ids_include_true_does_not_serialize_multiple_times
361
- @post.recent_comment = @comment
362
-
363
- @post_serializer_class.class_eval do
364
- has_one :comment, :embed => :ids, :include => true
365
- has_one :recent_comment, :embed => :ids, :include => true, :root => :comments
366
- end
367
-
368
- # Count how often the @comment record is serialized.
369
- serialized_times = 0
370
- @comment.class_eval do
371
- define_method :read_attribute_for_serialization, lambda { |name|
372
- serialized_times += 1 if name == :body
373
- super(name)
374
- }
375
- end
376
-
377
- include_bare! :comment
378
- include_bare! :recent_comment
379
-
380
- assert_equal 1, serialized_times
381
- end
382
-
383
- def test_include_with_read_association_id_for_serialization_hook
384
- @post_serializer_class.class_eval do
385
- has_one :comment, :embed => :ids, :include => true
386
- end
387
-
388
- association_name = nil
389
- @post.class_eval do
390
- define_method :read_attribute_for_serialization, lambda { |name|
391
- association_name = name
392
- send(name)
393
- }
394
- define_method :comment_id, lambda {
395
- @attributes[:comment].id
396
- }
397
- end
398
-
399
- include_bare! :comment
400
-
401
- assert_equal({
402
- :comment_id => 1
403
- }, @hash)
404
- end
405
-
406
- def test_include_with_read_association_ids_for_serialization_hook
407
- @post_serializer_class.class_eval do
408
- has_many :comments, :embed => :ids, :include => false
409
- end
410
-
411
- association_name = nil
412
- @post.class_eval do
413
- define_method :read_attribute_for_serialization, lambda { |name|
414
- association_name = name
415
- send(name)
416
- }
417
- define_method :comment_ids, lambda {
418
- @attributes[:comments].map(&:id)
419
- }
420
- end
421
-
422
- include_bare! :comments
423
-
424
- assert_equal({
425
- :comment_ids => [1]
426
- }, @hash)
427
- end
428
- end
429
-
430
- class RecursiveTest < AssociationTest
431
- class BarSerializer < ActiveModel::Serializer; end
432
-
433
- class FooSerializer < ActiveModel::Serializer
434
- root :foos
435
- attributes :id
436
- has_many :bars, :serializer => BarSerializer, :root => :bars, :embed => :ids, :include => true
437
- end
438
-
439
- class BarSerializer < ActiveModel::Serializer
440
- root :bars
441
- attributes :id
442
- has_many :foos, :serializer => FooSerializer, :root => :foos, :embed => :ids, :include => true
443
- end
444
-
445
- class Foo < Model
446
- def active_model_serializer; FooSerializer; end
447
- end
448
-
449
- class Bar < Model
450
- def active_model_serializer; BarSerializer; end
451
- end
452
-
453
- def setup
454
- super
455
-
456
- foo = Foo.new(:id => 1)
457
- bar = Bar.new(:id => 2)
458
-
459
- foo.bars = [ bar ]
460
- bar.foos = [ foo ]
461
-
462
- collection = [ foo ]
463
-
464
- @serializer = collection.active_model_serializer.new(collection, :root => :foos)
465
- end
466
-
467
- def test_mutual_relation_result
468
- assert_equal({
469
- :foos => [{
470
- :bar_ids => [ 2 ],
471
- :id => 1
472
- }],
473
- :bars => [{
474
- :foo_ids => [ 1 ],
475
- :id => 2
476
- }]
477
- }, @serializer.as_json)
478
- end
479
-
480
- def test_mutual_relation_does_not_raise_error
481
- assert_nothing_raised SystemStackError, 'stack level too deep' do
482
- @serializer.as_json
483
- end
484
- end
485
- end
486
-
487
- class InclusionTest < AssociationTest
488
- def setup
489
- super
490
-
491
- comment_serializer_class = @comment_serializer_class
492
-
493
- @post_serializer_class.class_eval do
494
- root :post
495
- embed :ids, :include => true
496
- has_many :comments, :serializer => comment_serializer_class
497
- end
498
- end
499
-
500
- def test_when_it_is_included
501
- post_serializer = @post_serializer_class.new(
502
- @post, :include => [:comments]
503
- )
504
-
505
- json = post_serializer.as_json
506
-
507
- assert_equal({
508
- :post => {
509
- :title => "New Post",
510
- :body => "Body",
511
- :comment_ids => [ 1 ]
512
- },
513
- :comments => [
514
- { :id => 1, :external_id => "COMM001", :body => "ZOMG A COMMENT" }
515
- ]
516
- }, json)
517
- end
518
-
519
- def test_when_it_is_not_included
520
- post_serializer = @post_serializer_class.new(
521
- @post, :include => []
522
- )
523
-
524
- json = post_serializer.as_json
525
-
526
- assert_equal({
527
- :post => {
528
- :title => "New Post",
529
- :body => "Body",
530
- :comment_ids => [ 1 ]
531
- }
532
- }, json)
533
- end
534
-
535
- def test_when_it_is_excluded
536
- post_serializer = @post_serializer_class.new(
537
- @post, :exclude => [:comments]
538
- )
539
-
540
- json = post_serializer.as_json
541
-
542
- assert_equal({
543
- :post => {
544
- :title => "New Post",
545
- :body => "Body",
546
- :comment_ids => [ 1 ]
547
- }
548
- }, json)
549
- end
550
-
551
- def test_when_it_is_not_excluded
552
- post_serializer = @post_serializer_class.new(
553
- @post, :exclude => []
554
- )
555
-
556
- json = post_serializer.as_json
557
-
558
- assert_equal({
559
- :post => {
560
- :title => "New Post",
561
- :body => "Body",
562
- :comment_ids => [ 1 ]
563
- },
564
- :comments => [
565
- { :id => 1, :external_id => "COMM001", :body => "ZOMG A COMMENT" }
566
- ]
567
- }, json)
568
- end
569
- end
570
-
571
- class StringSerializerOption < AssociationTest
572
- class StringSerializer < ActiveModel::Serializer
573
- attributes :id, :body
574
- end
575
-
576
- def test_specifying_serializer_class_as_string
577
- @post_serializer_class.class_eval do
578
- has_many :comments, :embed => :objects
579
- end
580
-
581
- include_bare! :comments, :serializer => "AssociationTest::StringSerializerOption::StringSerializer"
582
-
583
- assert_equal({
584
- :comments => [
585
- { :id => 1, :body => "ZOMG A COMMENT" }
586
- ]
587
- }, @hash)
588
-
589
- assert_equal({}, @root_hash)
590
- end
591
- end
592
- end
data/test/caching_test.rb DELETED
@@ -1,96 +0,0 @@
1
- require "test_helper"
2
-
3
- class CachingTest < ActiveModel::TestCase
4
- class NullStore
5
- def fetch(key)
6
- return store[key] if store[key]
7
-
8
- store[key] = yield
9
- end
10
-
11
- def clear
12
- store.clear
13
- end
14
-
15
- def store
16
- @store ||= {}
17
- end
18
-
19
- def read(key)
20
- store[key]
21
- end
22
- end
23
-
24
- class Programmer
25
- def name
26
- 'Adam'
27
- end
28
-
29
- def skills
30
- %w(ruby)
31
- end
32
-
33
- def read_attribute_for_serialization(name)
34
- send name
35
- end
36
- end
37
-
38
- def test_serializers_have_a_cache_store
39
- ActiveModel::Serializer.cache = NullStore.new
40
-
41
- assert_kind_of NullStore, ActiveModel::Serializer.cache
42
- end
43
-
44
- def test_serializers_can_enable_caching
45
- serializer = Class.new(ActiveModel::Serializer) do
46
- cached true
47
- end
48
-
49
- assert serializer.perform_caching
50
- end
51
-
52
- def test_serializers_use_cache
53
- serializer = Class.new(ActiveModel::Serializer) do
54
- cached true
55
- attributes :name, :skills
56
-
57
- def self.to_s
58
- 'serializer'
59
- end
60
-
61
- def cache_key
62
- object.name
63
- end
64
- end
65
-
66
- serializer.cache = NullStore.new
67
- instance = serializer.new Programmer.new
68
-
69
- instance.to_json
70
-
71
- assert_equal(instance.serializable_hash, serializer.cache.read('serializer/Adam/serializable-hash'))
72
- assert_equal(instance.to_json, serializer.cache.read('serializer/Adam/to-json'))
73
- end
74
-
75
- def test_array_serializer_uses_cache
76
- serializer = Class.new(ActiveModel::ArraySerializer) do
77
- cached true
78
-
79
- def self.to_s
80
- 'array_serializer'
81
- end
82
-
83
- def cache_key
84
- 'cache-key'
85
- end
86
- end
87
-
88
- serializer.cache = NullStore.new
89
- instance = serializer.new [Programmer.new]
90
-
91
- instance.to_json
92
-
93
- assert_equal instance.serializable_array, serializer.cache.read('array_serializer/cache-key/serializable-array')
94
- assert_equal instance.to_json, serializer.cache.read('array_serializer/cache-key/to-json')
95
- end
96
- end