1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
|
# frozen_string_literal: true
require 'test_helper'
module ActiveModelSerializers
module Adapter
class JsonApi
class RelationshipTest < ActiveSupport::TestCase
def test_relationship_with_data
expected = {
data: {
id: '1',
type: 'blogs'
}
}
model_attributes = { blog: Blog.new(id: 1) }
relationship_name = :blog
model = new_model(model_attributes)
actual = build_serializer_and_serialize_relationship(model, relationship_name) do
has_one :blog
end
assert_equal(expected, actual)
end
def test_relationship_with_nil_model
expected = { data: nil }
model_attributes = { blog: nil }
relationship_name = :blog
model = new_model(model_attributes)
actual = build_serializer_and_serialize_relationship(model, relationship_name) do
has_one :blog
end
assert_equal(expected, actual)
end
def test_relationship_with_nil_model_and_belongs_to_id_on_self
original_config = ActiveModelSerializers.config.jsonapi_use_foreign_key_on_belongs_to_relationship
ActiveModelSerializers.config.jsonapi_use_foreign_key_on_belongs_to_relationship = true
expected = { data: nil }
model_attributes = { blog: nil }
relationship_name = :blog
model = new_model(model_attributes)
actual = build_serializer_and_serialize_relationship(model, relationship_name) do
belongs_to :blog
end
assert_equal(expected, actual)
ensure
ActiveModelSerializers.config.jsonapi_use_foreign_key_on_belongs_to_relationship = original_config
end
def test_relationship_with_data_array
expected = {
data: [
{
id: '1',
type: 'posts'
},
{
id: '2',
type: 'posts'
}
]
}
model_attributes = { posts: [Post.new(id: 1), Post.new(id: 2)] }
relationship_name = :posts
model = new_model(model_attributes)
actual = build_serializer_and_serialize_relationship(model, relationship_name) do
has_many :posts
end
assert_equal(expected, actual)
end
def test_relationship_data_not_included
expected = { meta: {} }
model_attributes = { blog: :does_not_matter }
relationship_name = :blog
model = new_model(model_attributes)
actual = build_serializer_and_serialize_relationship(model, relationship_name) do
has_one :blog do
include_data false
end
end
assert_equal(expected, actual)
end
def test_relationship_many_links
expected = {
links: {
self: 'a link',
related: 'another link'
}
}
model_attributes = { blog: :does_not_matter }
relationship_name = :blog
model = new_model(model_attributes)
actual = build_serializer_and_serialize_relationship(model, relationship_name) do
has_one :blog do
include_data false
link :self, 'a link'
link :related, 'another link'
end
end
assert_equal(expected, actual)
end
def test_relationship_block_link_with_meta
expected = {
links: {
self: {
href: '1',
meta: { id: 1 }
}
}
}
model_attributes = { blog: Blog.new(id: 1) }
relationship_name = :blog
model = new_model(model_attributes)
actual = build_serializer_and_serialize_relationship(model, relationship_name) do
has_one :blog do
include_data false
link :self do
href object.blog.id.to_s
meta(id: object.blog.id)
end
end
end
assert_equal(expected, actual)
end
def test_relationship_simple_meta
expected = { meta: { id: '1' } }
model_attributes = { blog: Blog.new(id: 1) }
relationship_name = :blog
model = new_model(model_attributes)
actual = build_serializer_and_serialize_relationship(model, relationship_name) do
has_one :blog do
include_data false
meta(id: object.blog.id.to_s)
end
end
assert_equal(expected, actual)
end
def test_relationship_block_meta
expected = {
meta: {
id: 1
}
}
model_attributes = { blog: Blog.new(id: 1) }
relationship_name = :blog
model = new_model(model_attributes)
actual = build_serializer_and_serialize_relationship(model, relationship_name) do
has_one :blog do
include_data false
meta(id: object.blog.id)
end
end
assert_equal(expected, actual)
end
def test_relationship_simple_link
expected = {
data: {
id: '1337',
type: 'bios'
},
links: {
self: '//example.com/link_author/relationships/bio'
}
}
model_attributes = { bio: Bio.new(id: 1337) }
relationship_name = :bio
model = new_model(model_attributes)
actual = build_serializer_and_serialize_relationship(model, relationship_name) do
has_one :bio do
link :self, '//example.com/link_author/relationships/bio'
end
end
assert_equal(expected, actual)
end
def test_relationship_block_link
expected = {
data: { id: '1337', type: 'profiles' },
links: { related: '//example.com/profiles/1337' }
}
model_attributes = { profile: Profile.new(id: 1337) }
relationship_name = :profile
model = new_model(model_attributes)
actual = build_serializer_and_serialize_relationship(model, relationship_name) do
has_one :profile do
id = object.profile.id
link :related do
"//example.com/profiles/#{id}" if id != 123
end
end
end
assert_equal(expected, actual)
end
def test_relationship_with_everything
expected = {
data: [{ id: '1337', type: 'likes' }],
links: {
related: {
href: '//example.com/likes/1337',
meta: { ids: '1337' }
}
},
meta: { liked: true }
}
model_attributes = { likes: [Like.new(id: 1337)] }
relationship_name = :likes
model = new_model(model_attributes)
actual = build_serializer_and_serialize_relationship(model, relationship_name) do
has_many :likes do
link :related do
ids = object.likes.map(&:id).join(',')
href "//example.com/likes/#{ids}"
meta ids: ids
end
meta liked: object.likes.any?
end
end
assert_equal(expected, actual)
end
def test_relationship_nil_link
expected = {
data: { id: '123', type: 'profiles' }
}
model_attributes = { profile: Profile.new(id: 123) }
relationship_name = :profile
model = new_model(model_attributes)
actual = build_serializer_and_serialize_relationship(model, relationship_name) do
has_one :profile do
id = object.profile.id
link :related do
"//example.com/profiles/#{id}" if id != 123
end
end
end
assert_equal(expected, actual)
end
def test_relationship_block_link_href
expected = {
data: [{ id: '1337', type: 'locations' }],
links: {
related: { href: '//example.com/locations/1337' }
}
}
model_attributes = { locations: [Location.new(id: 1337)] }
relationship_name = :locations
model = new_model(model_attributes)
actual = build_serializer_and_serialize_relationship(model, relationship_name) do
has_many :locations do
link :related do
ids = object.locations.map(&:id).join(',')
href "//example.com/locations/#{ids}"
end
end
end
assert_equal(expected, actual)
end
def test_relationship_block_link_href_and_meta
expected = {
data: [{ id: '1337', type: 'posts' }],
links: {
related: {
href: '//example.com/posts/1337',
meta: { ids: '1337' }
}
}
}
model_attributes = { posts: [Post.new(id: 1337, comments: [], author: nil)] }
relationship_name = :posts
model = new_model(model_attributes)
actual = build_serializer_and_serialize_relationship(model, relationship_name) do
has_many :posts do
link :related do
ids = object.posts.map(&:id).join(',')
href "//example.com/posts/#{ids}"
meta ids: ids
end
end
end
assert_equal(expected, actual)
end
def test_relationship_block_link_meta
expected = {
data: [{ id: '1337', type: 'comments' }],
links: {
self: {
meta: { ids: [1] }
}
}
}
model_attributes = { comments: [Comment.new(id: 1337)] }
relationship_name = :comments
model = new_model(model_attributes)
actual = build_serializer_and_serialize_relationship(model, relationship_name) do
has_many :comments do
link :self do
meta ids: [1]
end
end
end
assert_equal(expected, actual)
end
def test_relationship_meta
expected = {
data: [{ id: 'from-serializer-method', type: 'roles' }],
meta: { count: 1 }
}
model_attributes = { roles: [Role.new(id: 'from-record')] }
relationship_name = :roles
model = new_model(model_attributes)
actual = build_serializer_and_serialize_relationship(model, relationship_name) do
has_many :roles do |serializer|
meta count: object.roles.count
serializer.cached_roles
end
def cached_roles
[
Role.new(id: 'from-serializer-method')
]
end
end
assert_equal(expected, actual)
end
def test_relationship_not_including_data
expected = {
links: { self: '//example.com/link_author/relationships/blog' }
}
model_attributes = { blog: Object }
relationship_name = :blog
model = new_model(model_attributes)
model.define_singleton_method(:read_attribute_for_serialization) do |attr|
fail 'should not be called' if attr == :blog
super(attr)
end
assert_nothing_raised do
actual = build_serializer_and_serialize_relationship(model, relationship_name) do
has_one :blog do
link :self, '//example.com/link_author/relationships/blog'
include_data false
end
end
assert_equal(expected, actual)
end
end
def test_relationship_including_data_explicit
expected = {
data: { id: '1337', type: 'authors' },
meta: { name: 'Dan Brown' }
}
model_attributes = { reviewer: Author.new(id: 1337) }
relationship_name = :reviewer
model = new_model(model_attributes)
actual = build_serializer_and_serialize_relationship(model, relationship_name) do
belongs_to :reviewer do
meta name: 'Dan Brown'
include_data true
end
end
assert_equal(expected, actual)
end
private
def build_serializer_and_serialize_relationship(model, relationship_name, &block)
serializer_class = Class.new(ActiveModel::Serializer, &block)
hash = serializable(model, serializer: serializer_class, adapter: :json_api).serializable_hash
hash[:data][:relationships][relationship_name]
end
def new_model(model_attributes)
Class.new(ActiveModelSerializers::Model) do
attributes(*model_attributes.keys)
def self.name
'TestModel'
end
end.new(model_attributes)
end
end
end
end
end
|
