active_model_serializers 0.10.0.rc4 → 0.10.0.rc5

Sign up to get free protection for your applications and to get access to all the features.
Files changed (179) 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 +1 -0
  5. data/.rubocop.yml +19 -1
  6. data/.rubocop_todo.yml +30 -103
  7. data/.simplecov +0 -1
  8. data/.travis.yml +20 -8
  9. data/CHANGELOG.md +89 -5
  10. data/CONTRIBUTING.md +54 -179
  11. data/Gemfile +7 -2
  12. data/{LICENSE.txt → MIT-LICENSE} +0 -0
  13. data/README.md +27 -5
  14. data/Rakefile +44 -16
  15. data/active_model_serializers.gemspec +9 -1
  16. data/appveyor.yml +1 -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 +13 -7
  21. data/docs/README.md +5 -1
  22. data/docs/STYLE.md +58 -0
  23. data/docs/general/adapters.md +99 -16
  24. data/docs/general/configuration_options.md +87 -14
  25. data/docs/general/deserialization.md +100 -0
  26. data/docs/general/getting_started.md +35 -0
  27. data/docs/general/instrumentation.md +1 -1
  28. data/docs/general/key_transforms.md +40 -0
  29. data/docs/general/rendering.md +115 -13
  30. data/docs/general/serializers.md +138 -6
  31. data/docs/howto/add_pagination_links.md +36 -18
  32. data/docs/howto/outside_controller_use.md +4 -4
  33. data/docs/howto/passing_arbitrary_options.md +27 -0
  34. data/docs/jsonapi/errors.md +56 -0
  35. data/docs/jsonapi/schema.md +29 -18
  36. data/docs/rfcs/0000-namespace.md +106 -0
  37. data/docs/rfcs/template.md +15 -0
  38. data/lib/action_controller/serialization.rb +10 -19
  39. data/lib/active_model/serializable_resource.rb +4 -65
  40. data/lib/active_model/serializer.rb +73 -18
  41. data/lib/active_model/serializer/adapter.rb +15 -82
  42. data/lib/active_model/serializer/adapter/attributes.rb +5 -56
  43. data/lib/active_model/serializer/adapter/base.rb +5 -47
  44. data/lib/active_model/serializer/adapter/json.rb +6 -12
  45. data/lib/active_model/serializer/adapter/json_api.rb +5 -213
  46. data/lib/active_model/serializer/adapter/null.rb +7 -3
  47. data/lib/active_model/serializer/array_serializer.rb +3 -3
  48. data/lib/active_model/serializer/association.rb +4 -5
  49. data/lib/active_model/serializer/attributes.rb +1 -1
  50. data/lib/active_model/serializer/caching.rb +56 -5
  51. data/lib/active_model/serializer/collection_serializer.rb +30 -13
  52. data/lib/active_model/serializer/configuration.rb +7 -0
  53. data/lib/active_model/serializer/error_serializer.rb +10 -0
  54. data/lib/active_model/serializer/errors_serializer.rb +27 -0
  55. data/lib/active_model/serializer/links.rb +4 -2
  56. data/lib/active_model/serializer/lint.rb +14 -0
  57. data/lib/active_model/serializer/meta.rb +29 -0
  58. data/lib/active_model/serializer/null.rb +17 -0
  59. data/lib/active_model/serializer/reflection.rb +57 -1
  60. data/lib/active_model/serializer/type.rb +1 -1
  61. data/lib/active_model/serializer/version.rb +1 -1
  62. data/lib/active_model_serializers.rb +17 -0
  63. data/lib/active_model_serializers/adapter.rb +92 -0
  64. data/lib/active_model_serializers/adapter/attributes.rb +94 -0
  65. data/lib/active_model_serializers/adapter/base.rb +90 -0
  66. data/lib/active_model_serializers/adapter/json.rb +11 -0
  67. data/lib/active_model_serializers/adapter/json_api.rb +513 -0
  68. data/lib/active_model_serializers/adapter/json_api/deserialization.rb +213 -0
  69. data/lib/active_model_serializers/adapter/json_api/error.rb +96 -0
  70. data/lib/active_model_serializers/adapter/json_api/jsonapi.rb +49 -0
  71. data/lib/active_model_serializers/adapter/json_api/link.rb +83 -0
  72. data/lib/active_model_serializers/adapter/json_api/meta.rb +37 -0
  73. data/lib/active_model_serializers/adapter/json_api/pagination_links.rb +57 -0
  74. data/lib/active_model_serializers/adapter/json_api/relationship.rb +52 -0
  75. data/lib/active_model_serializers/adapter/json_api/resource_identifier.rb +37 -0
  76. data/lib/active_model_serializers/adapter/null.rb +10 -0
  77. data/lib/active_model_serializers/cached_serializer.rb +87 -0
  78. data/lib/active_model_serializers/callbacks.rb +1 -1
  79. data/lib/active_model_serializers/deprecate.rb +55 -0
  80. data/lib/active_model_serializers/deserialization.rb +2 -2
  81. data/lib/active_model_serializers/fragment_cache.rb +118 -0
  82. data/lib/active_model_serializers/json_pointer.rb +14 -0
  83. data/lib/active_model_serializers/key_transform.rb +70 -0
  84. data/lib/active_model_serializers/logging.rb +4 -1
  85. data/lib/active_model_serializers/model.rb +11 -1
  86. data/lib/active_model_serializers/railtie.rb +9 -1
  87. data/lib/active_model_serializers/register_jsonapi_renderer.rb +64 -0
  88. data/lib/active_model_serializers/serializable_resource.rb +81 -0
  89. data/lib/active_model_serializers/serialization_context.rb +24 -2
  90. data/lib/active_model_serializers/test/schema.rb +2 -2
  91. data/lib/grape/formatters/active_model_serializers.rb +1 -1
  92. data/test/action_controller/adapter_selector_test.rb +1 -1
  93. data/test/action_controller/json_api/deserialization_test.rb +56 -3
  94. data/test/action_controller/json_api/errors_test.rb +41 -0
  95. data/test/action_controller/json_api/linked_test.rb +10 -9
  96. data/test/action_controller/json_api/pagination_test.rb +2 -2
  97. data/test/action_controller/json_api/transform_test.rb +180 -0
  98. data/test/action_controller/serialization_scope_name_test.rb +201 -35
  99. data/test/action_controller/serialization_test.rb +39 -7
  100. data/test/active_model_serializers/adapter_for_test.rb +208 -0
  101. data/test/active_model_serializers/cached_serializer_test.rb +80 -0
  102. data/test/active_model_serializers/fragment_cache_test.rb +34 -0
  103. data/test/active_model_serializers/json_pointer_test.rb +20 -0
  104. data/test/active_model_serializers/key_transform_test.rb +263 -0
  105. data/test/active_model_serializers/logging_test.rb +8 -8
  106. data/test/active_model_serializers/railtie_test_isolated.rb +6 -0
  107. data/test/active_model_serializers/serialization_context_test_isolated.rb +58 -0
  108. data/test/adapter/deprecation_test.rb +100 -0
  109. data/test/adapter/json/belongs_to_test.rb +32 -34
  110. data/test/adapter/json/collection_test.rb +73 -75
  111. data/test/adapter/json/has_many_test.rb +36 -38
  112. data/test/adapter/json/transform_test.rb +93 -0
  113. data/test/adapter/json_api/belongs_to_test.rb +127 -129
  114. data/test/adapter/json_api/collection_test.rb +80 -82
  115. data/test/adapter/json_api/errors_test.rb +78 -0
  116. data/test/adapter/json_api/fields_test.rb +68 -70
  117. data/test/adapter/json_api/has_many_embed_ids_test.rb +32 -34
  118. data/test/adapter/json_api/has_many_explicit_serializer_test.rb +75 -77
  119. data/test/adapter/json_api/has_many_test.rb +121 -123
  120. data/test/adapter/json_api/has_one_test.rb +59 -61
  121. data/test/adapter/json_api/json_api_test.rb +28 -30
  122. data/test/adapter/json_api/linked_test.rb +319 -321
  123. data/test/adapter/json_api/links_test.rb +75 -50
  124. data/test/adapter/json_api/pagination_links_test.rb +115 -82
  125. data/test/adapter/json_api/parse_test.rb +114 -116
  126. data/test/adapter/json_api/relationship_test.rb +161 -0
  127. data/test/adapter/json_api/relationships_test.rb +199 -0
  128. data/test/adapter/json_api/resource_identifier_test.rb +85 -0
  129. data/test/adapter/json_api/resource_meta_test.rb +100 -0
  130. data/test/adapter/json_api/toplevel_jsonapi_test.rb +61 -63
  131. data/test/adapter/json_api/transform_test.rb +500 -0
  132. data/test/adapter/json_api/type_test.rb +61 -0
  133. data/test/adapter/json_test.rb +35 -37
  134. data/test/adapter/null_test.rb +13 -15
  135. data/test/adapter/polymorphic_test.rb +72 -0
  136. data/test/adapter_test.rb +27 -29
  137. data/test/array_serializer_test.rb +7 -8
  138. data/test/benchmark/app.rb +65 -0
  139. data/test/benchmark/benchmarking_support.rb +67 -0
  140. data/test/benchmark/bm_caching.rb +117 -0
  141. data/test/benchmark/bm_transform.rb +34 -0
  142. data/test/benchmark/config.ru +3 -0
  143. data/test/benchmark/controllers.rb +77 -0
  144. data/test/benchmark/fixtures.rb +167 -0
  145. data/test/cache_test.rb +388 -0
  146. data/test/collection_serializer_test.rb +10 -0
  147. data/test/fixtures/active_record.rb +12 -0
  148. data/test/fixtures/poro.rb +28 -3
  149. data/test/grape_test.rb +5 -5
  150. data/test/lint_test.rb +9 -0
  151. data/test/serializable_resource_test.rb +59 -3
  152. data/test/serializers/associations_test.rb +8 -8
  153. data/test/serializers/attribute_test.rb +7 -7
  154. data/test/serializers/caching_configuration_test_isolated.rb +170 -0
  155. data/test/serializers/meta_test.rb +74 -6
  156. data/test/serializers/read_attribute_for_serialization_test.rb +79 -0
  157. data/test/serializers/serialization_test.rb +55 -0
  158. data/test/support/isolated_unit.rb +3 -0
  159. data/test/support/rails5_shims.rb +26 -8
  160. data/test/support/rails_app.rb +38 -18
  161. data/test/support/serialization_testing.rb +5 -5
  162. data/test/test_helper.rb +6 -10
  163. metadata +132 -37
  164. data/docs/DESIGN.textile +7 -1
  165. data/lib/active_model/serializer/adapter/cached_serializer.rb +0 -45
  166. data/lib/active_model/serializer/adapter/fragment_cache.rb +0 -111
  167. data/lib/active_model/serializer/adapter/json/fragment_cache.rb +0 -13
  168. data/lib/active_model/serializer/adapter/json_api/deserialization.rb +0 -207
  169. data/lib/active_model/serializer/adapter/json_api/fragment_cache.rb +0 -21
  170. data/lib/active_model/serializer/adapter/json_api/link.rb +0 -44
  171. data/lib/active_model/serializer/adapter/json_api/pagination_links.rb +0 -58
  172. data/test/active_model_serializers/serialization_context_test.rb +0 -18
  173. data/test/adapter/fragment_cache_test.rb +0 -38
  174. data/test/adapter/json_api/resource_type_config_test.rb +0 -71
  175. data/test/serializers/adapter_for_test.rb +0 -166
  176. data/test/serializers/cache_test.rb +0 -209
  177. data/test/support/simplecov.rb +0 -6
  178. data/test/support/stream_capture.rb +0 -50
  179. data/test/support/test_case.rb +0 -19
@@ -1,37 +1,35 @@
1
1
  require 'test_helper'
2
2
 
3
- module ActiveModel
4
- class Serializer
5
- module Adapter
6
- class JsonApiTest < ActiveSupport::TestCase
7
- def setup
8
- ActionController::Base.cache_store.clear
9
- @author = Author.new(id: 1, name: 'Steve K.')
10
- @post = Post.new(id: 1, title: 'New Post', body: 'Body')
11
- @first_comment = Comment.new(id: 1, body: 'ZOMG A COMMENT')
12
- @second_comment = Comment.new(id: 2, body: 'ZOMG ANOTHER COMMENT')
13
- @post.comments = [@first_comment, @second_comment]
14
- @first_comment.post = @post
15
- @second_comment.post = @post
16
- @post.author = @author
17
- @blog = Blog.new(id: 1, name: 'My Blog!!')
18
- @post.blog = @blog
19
- end
3
+ module ActiveModelSerializers
4
+ module Adapter
5
+ class JsonApiTest < ActiveSupport::TestCase
6
+ def setup
7
+ ActionController::Base.cache_store.clear
8
+ @author = Author.new(id: 1, name: 'Steve K.')
9
+ @post = Post.new(id: 1, title: 'New Post', body: 'Body')
10
+ @first_comment = Comment.new(id: 1, body: 'ZOMG A COMMENT')
11
+ @second_comment = Comment.new(id: 2, body: 'ZOMG ANOTHER COMMENT')
12
+ @post.comments = [@first_comment, @second_comment]
13
+ @first_comment.post = @post
14
+ @second_comment.post = @post
15
+ @post.author = @author
16
+ @blog = Blog.new(id: 1, name: 'My Blog!!')
17
+ @post.blog = @blog
18
+ end
20
19
 
21
- def test_custom_keys
22
- serializer = PostWithCustomKeysSerializer.new(@post)
23
- adapter = ActiveModel::Serializer::Adapter::JsonApi.new(serializer)
20
+ def test_custom_keys
21
+ serializer = PostWithCustomKeysSerializer.new(@post)
22
+ adapter = ActiveModelSerializers::Adapter::JsonApi.new(serializer)
24
23
 
25
- assert_equal({
26
- reviews: { data: [
27
- { type: 'comments', id: '1' },
28
- { type: 'comments', id: '2' }
29
- ] },
30
- writer: { data: { type: 'authors', id: '1' } },
31
- site: { data: { type: 'blogs', id: '1' } }
32
- }, adapter.serializable_hash[:data][:relationships])
33
- end
24
+ assert_equal({
25
+ reviews: { data: [
26
+ { type: 'comments', id: '1' },
27
+ { type: 'comments', id: '2' }
28
+ ] },
29
+ writer: { data: { type: 'authors', id: '1' } },
30
+ site: { data: { type: 'blogs', id: '1' } }
31
+ }, adapter.serializable_hash[:data][:relationships])
34
32
  end
35
33
  end
36
34
  end
37
- end
35
+ end
@@ -5,168 +5,106 @@ class NestedPostSerializer < ActiveModel::Serializer
5
5
  has_many :nested_posts
6
6
  end
7
7
 
8
- module ActiveModel
9
- class Serializer
10
- module Adapter
11
- class JsonApi
12
- class LinkedTest < ActiveSupport::TestCase
13
- def setup
14
- @author1 = Author.new(id: 1, name: 'Steve K.')
15
- @author2 = Author.new(id: 2, name: 'Tenderlove')
16
- @bio1 = Bio.new(id: 1, content: 'AMS Contributor')
17
- @bio2 = Bio.new(id: 2, content: 'Rails Contributor')
18
- @first_post = Post.new(id: 10, title: 'Hello!!', body: 'Hello, world!!')
19
- @second_post = Post.new(id: 20, title: 'New Post', body: 'Body')
20
- @third_post = Post.new(id: 30, title: 'Yet Another Post', body: 'Body')
21
- @blog = Blog.new({ name: 'AMS Blog' })
22
- @first_comment = Comment.new(id: 1, body: 'ZOMG A COMMENT')
23
- @second_comment = Comment.new(id: 2, body: 'ZOMG ANOTHER COMMENT')
24
- @first_post.blog = @blog
25
- @second_post.blog = @blog
26
- @third_post.blog = nil
27
- @first_post.comments = [@first_comment, @second_comment]
28
- @second_post.comments = []
29
- @third_post.comments = []
30
- @first_post.author = @author1
31
- @second_post.author = @author2
32
- @third_post.author = @author1
33
- @first_comment.post = @first_post
34
- @first_comment.author = nil
35
- @second_comment.post = @first_post
36
- @second_comment.author = nil
37
- @author1.posts = [@first_post, @third_post]
38
- @author1.bio = @bio1
39
- @author1.roles = []
40
- @author2.posts = [@second_post]
41
- @author2.bio = @bio2
42
- @author2.roles = []
43
- @bio1.author = @author1
44
- @bio2.author = @author2
45
- end
8
+ module ActiveModelSerializers
9
+ module Adapter
10
+ class JsonApi
11
+ class LinkedTest < ActiveSupport::TestCase
12
+ def setup
13
+ @author1 = Author.new(id: 1, name: 'Steve K.')
14
+ @author2 = Author.new(id: 2, name: 'Tenderlove')
15
+ @bio1 = Bio.new(id: 1, content: 'AMS Contributor')
16
+ @bio2 = Bio.new(id: 2, content: 'Rails Contributor')
17
+ @first_post = Post.new(id: 10, title: 'Hello!!', body: 'Hello, world!!')
18
+ @second_post = Post.new(id: 20, title: 'New Post', body: 'Body')
19
+ @third_post = Post.new(id: 30, title: 'Yet Another Post', body: 'Body')
20
+ @blog = Blog.new({ name: 'AMS Blog' })
21
+ @first_comment = Comment.new(id: 1, body: 'ZOMG A COMMENT')
22
+ @second_comment = Comment.new(id: 2, body: 'ZOMG ANOTHER COMMENT')
23
+ @first_post.blog = @blog
24
+ @second_post.blog = @blog
25
+ @third_post.blog = nil
26
+ @first_post.comments = [@first_comment, @second_comment]
27
+ @second_post.comments = []
28
+ @third_post.comments = []
29
+ @first_post.author = @author1
30
+ @second_post.author = @author2
31
+ @third_post.author = @author1
32
+ @first_comment.post = @first_post
33
+ @first_comment.author = nil
34
+ @second_comment.post = @first_post
35
+ @second_comment.author = nil
36
+ @author1.posts = [@first_post, @third_post]
37
+ @author1.bio = @bio1
38
+ @author1.roles = []
39
+ @author2.posts = [@second_post]
40
+ @author2.bio = @bio2
41
+ @author2.roles = []
42
+ @bio1.author = @author1
43
+ @bio2.author = @author2
44
+ end
46
45
 
47
- def test_include_multiple_posts_and_linked_array
48
- serializer = CollectionSerializer.new([@first_post, @second_post])
49
- adapter = ActiveModel::Serializer::Adapter::JsonApi.new(
50
- serializer,
51
- include: [:comments, author: [:bio]]
52
- )
53
- alt_adapter = ActiveModel::Serializer::Adapter::JsonApi.new(
54
- serializer,
55
- include: [:comments, author: [:bio]]
56
- )
46
+ def test_include_multiple_posts_and_linked_array
47
+ serializer = ActiveModel::Serializer::CollectionSerializer.new([@first_post, @second_post])
48
+ adapter = ActiveModelSerializers::Adapter::JsonApi.new(
49
+ serializer,
50
+ include: [:comments, author: [:bio]]
51
+ )
52
+ alt_adapter = ActiveModelSerializers::Adapter::JsonApi.new(
53
+ serializer,
54
+ include: [:comments, author: [:bio]]
55
+ )
57
56
 
58
- expected = {
59
- data: [
60
- {
61
- id: '10',
62
- type: 'posts',
63
- attributes: {
64
- title: 'Hello!!',
65
- body: 'Hello, world!!'
66
- },
67
- relationships: {
68
- comments: { data: [{ type: 'comments', id: '1' }, { type: 'comments', id: '2' }] },
69
- blog: { data: { type: 'blogs', id: '999' } },
70
- author: { data: { type: 'authors', id: '1' } }
71
- }
57
+ expected = {
58
+ data: [
59
+ {
60
+ id: '10',
61
+ type: 'posts',
62
+ attributes: {
63
+ title: 'Hello!!',
64
+ body: 'Hello, world!!'
72
65
  },
73
- {
74
- id: '20',
75
- type: 'posts',
76
- attributes: {
77
- title: 'New Post',
78
- body: 'Body'
79
- },
80
- relationships: {
81
- comments: { data: [] },
82
- blog: { data: { type: 'blogs', id: '999' } },
83
- author: { data: { type: 'authors', id: '2' } }
84
- }
66
+ relationships: {
67
+ comments: { data: [{ type: 'comments', id: '1' }, { type: 'comments', id: '2' }] },
68
+ blog: { data: { type: 'blogs', id: '999' } },
69
+ author: { data: { type: 'authors', id: '1' } }
85
70
  }
86
- ],
87
- included: [
88
- {
89
- id: '1',
90
- type: 'comments',
91
- attributes: {
92
- body: 'ZOMG A COMMENT'
93
- },
94
- relationships: {
95
- post: { data: { type: 'posts', id: '10' } },
96
- author: { data: nil }
97
- }
98
- }, {
99
- id: '2',
100
- type: 'comments',
101
- attributes: {
102
- body: 'ZOMG ANOTHER COMMENT',
103
- },
104
- relationships: {
105
- post: { data: { type: 'posts', id: '10' } },
106
- author: { data: nil }
107
- }
108
- }, {
109
- id: '1',
110
- type: 'authors',
111
- attributes: {
112
- name: 'Steve K.'
113
- },
114
- relationships: {
115
- posts: { data: [{ type: 'posts', id: '10' }, { type: 'posts', id: '30' }] },
116
- roles: { data: [] },
117
- bio: { data: { type: 'bios', id: '1' } }
118
- }
119
- }, {
120
- id: '1',
121
- type: 'bios',
122
- attributes: {
123
- content: 'AMS Contributor',
124
- rating: nil
125
- },
126
- relationships: {
127
- author: { data: { type: 'authors', id: '1' } }
128
- }
129
- }, {
130
- id: '2',
131
- type: 'authors',
132
- attributes: {
133
- name: 'Tenderlove'
134
- },
135
- relationships: {
136
- posts: { data: [{ type: 'posts', id: '20' }] },
137
- roles: { data: [] },
138
- bio: { data: { type: 'bios', id: '2' } }
139
- }
140
- }, {
141
- id: '2',
142
- type: 'bios',
143
- attributes: {
144
- rating: nil,
145
- content: 'Rails Contributor',
146
- },
147
- relationships: {
148
- author: { data: { type: 'authors', id: '2' } }
149
- }
71
+ },
72
+ {
73
+ id: '20',
74
+ type: 'posts',
75
+ attributes: {
76
+ title: 'New Post',
77
+ body: 'Body'
78
+ },
79
+ relationships: {
80
+ comments: { data: [] },
81
+ blog: { data: { type: 'blogs', id: '999' } },
82
+ author: { data: { type: 'authors', id: '2' } }
150
83
  }
151
- ]
152
- }
153
- assert_equal expected, adapter.serializable_hash
154
- assert_equal expected, alt_adapter.serializable_hash
155
- end
156
-
157
- def test_include_multiple_posts_and_linked
158
- serializer = BioSerializer.new @bio1
159
- adapter = ActiveModel::Serializer::Adapter::JsonApi.new(
160
- serializer,
161
- include: [author: [:posts]]
162
- )
163
- alt_adapter = ActiveModel::Serializer::Adapter::JsonApi.new(
164
- serializer,
165
- include: [author: [:posts]]
166
- )
167
-
168
- expected = [
84
+ }
85
+ ],
86
+ included: [
169
87
  {
88
+ id: '1',
89
+ type: 'comments',
90
+ attributes: {
91
+ body: 'ZOMG A COMMENT'
92
+ },
93
+ relationships: {
94
+ post: { data: { type: 'posts', id: '10' } },
95
+ author: { data: nil }
96
+ }
97
+ }, {
98
+ id: '2',
99
+ type: 'comments',
100
+ attributes: {
101
+ body: 'ZOMG ANOTHER COMMENT'
102
+ },
103
+ relationships: {
104
+ post: { data: { type: 'posts', id: '10' } },
105
+ author: { data: nil }
106
+ }
107
+ }, {
170
108
  id: '1',
171
109
  type: 'authors',
172
110
  attributes: {
@@ -178,215 +116,275 @@ module ActiveModel
178
116
  bio: { data: { type: 'bios', id: '1' } }
179
117
  }
180
118
  }, {
181
- id: '10',
182
- type: 'posts',
119
+ id: '1',
120
+ type: 'bios',
183
121
  attributes: {
184
- title: 'Hello!!',
185
- body: 'Hello, world!!'
122
+ content: 'AMS Contributor',
123
+ rating: nil
186
124
  },
187
125
  relationships: {
188
- comments: { data: [{ type: 'comments', id: '1' }, { type: 'comments', id: '2' }] },
189
- blog: { data: { type: 'blogs', id: '999' } },
190
126
  author: { data: { type: 'authors', id: '1' } }
191
127
  }
192
128
  }, {
193
- id: '30',
194
- type: 'posts',
129
+ id: '2',
130
+ type: 'authors',
195
131
  attributes: {
196
- title: 'Yet Another Post',
197
- body: 'Body'
132
+ name: 'Tenderlove'
198
133
  },
199
134
  relationships: {
200
- comments: { data: [] },
201
- blog: { data: { type: 'blogs', id: '999' } },
202
- author: { data: { type: 'authors', id: '1' } }
135
+ posts: { data: [{ type: 'posts', id: '20' }] },
136
+ roles: { data: [] },
137
+ bio: { data: { type: 'bios', id: '2' } }
138
+ }
139
+ }, {
140
+ id: '2',
141
+ type: 'bios',
142
+ attributes: {
143
+ rating: nil,
144
+ content: 'Rails Contributor'
145
+ },
146
+ relationships: {
147
+ author: { data: { type: 'authors', id: '2' } }
203
148
  }
204
149
  }
205
150
  ]
151
+ }
152
+ assert_equal expected, adapter.serializable_hash
153
+ assert_equal expected, alt_adapter.serializable_hash
154
+ end
206
155
 
207
- assert_equal expected, adapter.serializable_hash[:included]
208
- assert_equal expected, alt_adapter.serializable_hash[:included]
209
- end
156
+ def test_include_multiple_posts_and_linked
157
+ serializer = BioSerializer.new @bio1
158
+ adapter = ActiveModelSerializers::Adapter::JsonApi.new(
159
+ serializer,
160
+ include: [author: [:posts]]
161
+ )
162
+ alt_adapter = ActiveModelSerializers::Adapter::JsonApi.new(
163
+ serializer,
164
+ include: [author: [:posts]]
165
+ )
210
166
 
211
- def test_underscore_model_namespace_for_linked_resource_type
212
- spammy_post = Post.new(id: 123)
213
- spammy_post.related = [Spam::UnrelatedLink.new(id: 456)]
214
- serializer = SpammyPostSerializer.new(spammy_post)
215
- adapter = ActiveModel::Serializer::Adapter::JsonApi.new(serializer)
216
- relationships = adapter.serializable_hash[:data][:relationships]
217
- expected = {
218
- related: {
219
- data: [{
220
- type: 'spam_unrelated_links',
221
- id: '456'
222
- }]
167
+ expected = [
168
+ {
169
+ id: '1',
170
+ type: 'authors',
171
+ attributes: {
172
+ name: 'Steve K.'
173
+ },
174
+ relationships: {
175
+ posts: { data: [{ type: 'posts', id: '10' }, { type: 'posts', id: '30' }] },
176
+ roles: { data: [] },
177
+ bio: { data: { type: 'bios', id: '1' } }
178
+ }
179
+ }, {
180
+ id: '10',
181
+ type: 'posts',
182
+ attributes: {
183
+ title: 'Hello!!',
184
+ body: 'Hello, world!!'
185
+ },
186
+ relationships: {
187
+ comments: { data: [{ type: 'comments', id: '1' }, { type: 'comments', id: '2' }] },
188
+ blog: { data: { type: 'blogs', id: '999' } },
189
+ author: { data: { type: 'authors', id: '1' } }
190
+ }
191
+ }, {
192
+ id: '30',
193
+ type: 'posts',
194
+ attributes: {
195
+ title: 'Yet Another Post',
196
+ body: 'Body'
197
+ },
198
+ relationships: {
199
+ comments: { data: [] },
200
+ blog: { data: { type: 'blogs', id: '999' } },
201
+ author: { data: { type: 'authors', id: '1' } }
223
202
  }
224
203
  }
225
- assert_equal expected, relationships
226
- end
204
+ ]
227
205
 
228
- def test_multiple_references_to_same_resource
229
- serializer = CollectionSerializer.new([@first_comment, @second_comment])
230
- adapter = ActiveModel::Serializer::Adapter::JsonApi.new(
231
- serializer,
232
- include: [:post]
233
- )
206
+ assert_equal expected, adapter.serializable_hash[:included]
207
+ assert_equal expected, alt_adapter.serializable_hash[:included]
208
+ end
234
209
 
235
- expected = [
236
- {
237
- id: '10',
238
- type: 'posts',
239
- attributes: {
240
- title: 'Hello!!',
241
- body: 'Hello, world!!'
210
+ def test_underscore_model_namespace_for_linked_resource_type
211
+ spammy_post = Post.new(id: 123)
212
+ spammy_post.related = [Spam::UnrelatedLink.new(id: 456)]
213
+ serializer = SpammyPostSerializer.new(spammy_post)
214
+ adapter = ActiveModelSerializers::Adapter::JsonApi.new(serializer)
215
+ relationships = adapter.serializable_hash[:data][:relationships]
216
+ expected = {
217
+ related: {
218
+ data: [{
219
+ type: 'spam-unrelated-links',
220
+ id: '456'
221
+ }]
222
+ }
223
+ }
224
+ assert_equal expected, relationships
225
+ end
226
+
227
+ def test_multiple_references_to_same_resource
228
+ serializer = ActiveModel::Serializer::CollectionSerializer.new([@first_comment, @second_comment])
229
+ adapter = ActiveModelSerializers::Adapter::JsonApi.new(
230
+ serializer,
231
+ include: [:post]
232
+ )
233
+
234
+ expected = [
235
+ {
236
+ id: '10',
237
+ type: 'posts',
238
+ attributes: {
239
+ title: 'Hello!!',
240
+ body: 'Hello, world!!'
241
+ },
242
+ relationships: {
243
+ comments: {
244
+ data: [{ type: 'comments', id: '1' }, { type: 'comments', id: '2' }]
242
245
  },
243
- relationships: {
244
- comments: {
245
- data: [{ type: 'comments', id: '1' }, { type: 'comments', id: '2' }]
246
- },
247
- blog: {
248
- data: { type: 'blogs', id: '999' }
249
- },
250
- author: {
251
- data: { type: 'authors', id: '1' }
252
- }
246
+ blog: {
247
+ data: { type: 'blogs', id: '999' }
248
+ },
249
+ author: {
250
+ data: { type: 'authors', id: '1' }
253
251
  }
254
252
  }
255
- ]
253
+ }
254
+ ]
256
255
 
257
- assert_equal expected, adapter.serializable_hash[:included]
258
- end
256
+ assert_equal expected, adapter.serializable_hash[:included]
257
+ end
259
258
 
260
- def test_nil_link_with_specified_serializer
261
- @first_post.author = nil
262
- serializer = PostPreviewSerializer.new(@first_post)
263
- adapter = ActiveModel::Serializer::Adapter::JsonApi.new(
264
- serializer,
265
- include: [:author]
266
- )
259
+ def test_nil_link_with_specified_serializer
260
+ @first_post.author = nil
261
+ serializer = PostPreviewSerializer.new(@first_post)
262
+ adapter = ActiveModelSerializers::Adapter::JsonApi.new(
263
+ serializer,
264
+ include: [:author]
265
+ )
267
266
 
268
- expected = {
269
- data: {
270
- id: '10',
271
- type: 'posts',
272
- attributes: {
273
- title: 'Hello!!',
274
- body: 'Hello, world!!'
275
- },
276
- relationships: {
277
- comments: { data: [{ type: 'comments', id: '1' }, { type: 'comments', id: '2' }] },
278
- author: { data: nil }
279
- }
267
+ expected = {
268
+ data: {
269
+ id: '10',
270
+ type: 'posts',
271
+ attributes: {
272
+ title: 'Hello!!',
273
+ body: 'Hello, world!!'
274
+ },
275
+ relationships: {
276
+ comments: { data: [{ type: 'comments', id: '1' }, { type: 'comments', id: '2' }] },
277
+ author: { data: nil }
280
278
  }
281
279
  }
282
- assert_equal expected, adapter.serializable_hash
283
- end
280
+ }
281
+ assert_equal expected, adapter.serializable_hash
284
282
  end
283
+ end
285
284
 
286
- class NoDuplicatesTest < ActiveSupport::TestCase
287
- Post = Class.new(::Model)
288
- Author = Class.new(::Model)
285
+ class NoDuplicatesTest < ActiveSupport::TestCase
286
+ Post = Class.new(::Model)
287
+ Author = Class.new(::Model)
289
288
 
290
- class PostSerializer < ActiveModel::Serializer
291
- type 'posts'
292
- belongs_to :author
293
- end
289
+ class PostSerializer < ActiveModel::Serializer
290
+ type 'posts'
291
+ belongs_to :author
292
+ end
294
293
 
295
- class AuthorSerializer < ActiveModel::Serializer
296
- type 'authors'
297
- has_many :posts
298
- end
294
+ class AuthorSerializer < ActiveModel::Serializer
295
+ type 'authors'
296
+ has_many :posts
297
+ end
299
298
 
300
- def setup
301
- @author = Author.new(id: 1, posts: [], roles: [], bio: nil)
302
- @post1 = Post.new(id: 1, author: @author)
303
- @post2 = Post.new(id: 2, author: @author)
304
- @author.posts << @post1
305
- @author.posts << @post2
299
+ def setup
300
+ @author = Author.new(id: 1, posts: [], roles: [], bio: nil)
301
+ @post1 = Post.new(id: 1, author: @author)
302
+ @post2 = Post.new(id: 2, author: @author)
303
+ @author.posts << @post1
304
+ @author.posts << @post2
306
305
 
307
- @nestedpost1 = ::NestedPost.new(id: 1, nested_posts: [])
308
- @nestedpost2 = ::NestedPost.new(id: 2, nested_posts: [])
309
- @nestedpost1.nested_posts << @nestedpost1
310
- @nestedpost1.nested_posts << @nestedpost2
311
- @nestedpost2.nested_posts << @nestedpost1
312
- @nestedpost2.nested_posts << @nestedpost2
313
- end
306
+ @nestedpost1 = ::NestedPost.new(id: 1, nested_posts: [])
307
+ @nestedpost2 = ::NestedPost.new(id: 2, nested_posts: [])
308
+ @nestedpost1.nested_posts << @nestedpost1
309
+ @nestedpost1.nested_posts << @nestedpost2
310
+ @nestedpost2.nested_posts << @nestedpost1
311
+ @nestedpost2.nested_posts << @nestedpost2
312
+ end
314
313
 
315
- def test_no_duplicates
316
- hash = ActiveModel::SerializableResource.new(@post1, adapter: :json_api,
317
- include: '*.*')
318
- .serializable_hash
319
- expected = [
320
- {
321
- type: 'authors', id: '1',
322
- relationships: {
323
- posts: {
324
- data: [
325
- { type: 'posts', id: '1' },
326
- { type: 'posts', id: '2' }
327
- ]
328
- }
329
- }
330
- },
331
- {
332
- type: 'posts', id: '2',
333
- relationships: {
334
- author: {
335
- data: { type: 'authors', id: '1' }
336
- }
314
+ def test_no_duplicates
315
+ hash = ActiveModelSerializers::SerializableResource.new(@post1, adapter: :json_api,
316
+ include: '*.*')
317
+ .serializable_hash
318
+ expected = [
319
+ {
320
+ type: 'authors', id: '1',
321
+ relationships: {
322
+ posts: {
323
+ data: [
324
+ { type: 'posts', id: '1' },
325
+ { type: 'posts', id: '2' }
326
+ ]
337
327
  }
338
328
  }
339
- ]
340
- assert_equal(expected, hash[:included])
341
- end
342
-
343
- def test_no_duplicates_collection
344
- hash = ActiveModel::SerializableResource.new(
345
- [@post1, @post2], adapter: :json_api,
346
- include: '*.*')
347
- .serializable_hash
348
- expected = [
349
- {
350
- type: 'authors', id: '1',
351
- relationships: {
352
- posts: {
353
- data: [
354
- { type: 'posts', id: '1' },
355
- { type: 'posts', id: '2' }
356
- ]
357
- }
329
+ },
330
+ {
331
+ type: 'posts', id: '2',
332
+ relationships: {
333
+ author: {
334
+ data: { type: 'authors', id: '1' }
358
335
  }
359
336
  }
360
- ]
361
- assert_equal(expected, hash[:included])
362
- end
337
+ }
338
+ ]
339
+ assert_equal(expected, hash[:included])
340
+ end
363
341
 
364
- def test_no_duplicates_global
365
- hash = ActiveModel::SerializableResource.new(
366
- @nestedpost1,
367
- adapter: :json_api,
368
- include: '*').serializable_hash
369
- expected = [
370
- type: 'nested_posts', id: '2',
342
+ def test_no_duplicates_collection
343
+ hash = ActiveModelSerializers::SerializableResource.new(
344
+ [@post1, @post2], adapter: :json_api,
345
+ include: '*.*')
346
+ .serializable_hash
347
+ expected = [
348
+ {
349
+ type: 'authors', id: '1',
371
350
  relationships: {
372
- nested_posts: {
351
+ posts: {
373
352
  data: [
374
- { type: 'nested_posts', id: '1' },
375
- { type: 'nested_posts', id: '2' }
353
+ { type: 'posts', id: '1' },
354
+ { type: 'posts', id: '2' }
376
355
  ]
377
356
  }
378
357
  }
379
- ]
380
- assert_equal(expected, hash[:included])
381
- end
358
+ }
359
+ ]
360
+ assert_equal(expected, hash[:included])
361
+ end
362
+
363
+ def test_no_duplicates_global
364
+ hash = ActiveModelSerializers::SerializableResource.new(
365
+ @nestedpost1,
366
+ adapter: :json_api,
367
+ include: '*').serializable_hash
368
+ expected = [
369
+ type: 'nested-posts', id: '2',
370
+ relationships: {
371
+ :"nested-posts" => {
372
+ data: [
373
+ { type: 'nested-posts', id: '1' },
374
+ { type: 'nested-posts', id: '2' }
375
+ ]
376
+ }
377
+ }
378
+ ]
379
+ assert_equal(expected, hash[:included])
380
+ end
382
381
 
383
- def test_no_duplicates_collection_global
384
- hash = ActiveModel::SerializableResource.new(
385
- [@nestedpost1, @nestedpost2],
386
- adapter: :json_api,
387
- include: '*').serializable_hash
388
- assert_nil(hash[:included])
389
- end
382
+ def test_no_duplicates_collection_global
383
+ hash = ActiveModelSerializers::SerializableResource.new(
384
+ [@nestedpost1, @nestedpost2],
385
+ adapter: :json_api,
386
+ include: '*').serializable_hash
387
+ assert_nil(hash[:included])
390
388
  end
391
389
  end
392
390
  end