active_model_serializers 0.10.0 → 0.10.13

Sign up to get free protection for your applications and to get access to all the features.
Files changed (215) hide show
  1. checksums.yaml +5 -5
  2. data/CHANGELOG.md +239 -2
  3. data/README.md +171 -34
  4. data/lib/action_controller/serialization.rb +23 -3
  5. data/lib/active_model/serializable_resource.rb +2 -0
  6. data/lib/active_model/serializer/adapter/attributes.rb +2 -0
  7. data/lib/active_model/serializer/adapter/base.rb +4 -0
  8. data/lib/active_model/serializer/adapter/json.rb +2 -0
  9. data/lib/active_model/serializer/adapter/json_api.rb +2 -0
  10. data/lib/active_model/serializer/adapter/null.rb +2 -0
  11. data/lib/active_model/serializer/adapter.rb +2 -0
  12. data/lib/active_model/serializer/array_serializer.rb +10 -5
  13. data/lib/active_model/serializer/association.rb +64 -10
  14. data/lib/active_model/serializer/attribute.rb +2 -0
  15. data/lib/active_model/serializer/belongs_to_reflection.rb +6 -3
  16. data/lib/active_model/serializer/collection_serializer.rb +48 -13
  17. data/lib/active_model/serializer/{caching.rb → concerns/caching.rb} +89 -117
  18. data/lib/active_model/serializer/error_serializer.rb +13 -7
  19. data/lib/active_model/serializer/errors_serializer.rb +27 -20
  20. data/lib/active_model/serializer/field.rb +2 -0
  21. data/lib/active_model/serializer/fieldset.rb +3 -1
  22. data/lib/active_model/serializer/has_many_reflection.rb +5 -3
  23. data/lib/active_model/serializer/has_one_reflection.rb +3 -4
  24. data/lib/active_model/serializer/lazy_association.rb +99 -0
  25. data/lib/active_model/serializer/link.rb +23 -0
  26. data/lib/active_model/serializer/lint.rb +136 -130
  27. data/lib/active_model/serializer/null.rb +2 -0
  28. data/lib/active_model/serializer/reflection.rb +130 -65
  29. data/lib/active_model/serializer/version.rb +3 -1
  30. data/lib/active_model/serializer.rb +321 -86
  31. data/lib/active_model_serializers/adapter/attributes.rb +17 -57
  32. data/lib/active_model_serializers/adapter/base.rb +41 -39
  33. data/lib/active_model_serializers/adapter/json.rb +2 -0
  34. data/lib/active_model_serializers/adapter/json_api/deserialization.rb +4 -2
  35. data/lib/active_model_serializers/adapter/json_api/error.rb +2 -0
  36. data/lib/active_model_serializers/adapter/json_api/jsonapi.rb +2 -0
  37. data/lib/active_model_serializers/adapter/json_api/link.rb +3 -1
  38. data/lib/active_model_serializers/adapter/json_api/meta.rb +2 -0
  39. data/lib/active_model_serializers/adapter/json_api/pagination_links.rb +52 -20
  40. data/lib/active_model_serializers/adapter/json_api/relationship.rb +77 -23
  41. data/lib/active_model_serializers/adapter/json_api/resource_identifier.rb +41 -10
  42. data/lib/active_model_serializers/adapter/json_api.rb +84 -65
  43. data/lib/active_model_serializers/adapter/null.rb +2 -0
  44. data/lib/active_model_serializers/adapter.rb +9 -1
  45. data/lib/active_model_serializers/callbacks.rb +2 -0
  46. data/lib/active_model_serializers/deprecate.rb +3 -2
  47. data/lib/active_model_serializers/deserialization.rb +4 -0
  48. data/lib/active_model_serializers/json_pointer.rb +2 -0
  49. data/lib/active_model_serializers/logging.rb +2 -0
  50. data/lib/active_model_serializers/lookup_chain.rb +82 -0
  51. data/lib/active_model_serializers/model/caching.rb +26 -0
  52. data/lib/active_model_serializers/model.rb +111 -28
  53. data/lib/active_model_serializers/railtie.rb +7 -1
  54. data/lib/active_model_serializers/register_jsonapi_renderer.rb +46 -31
  55. data/lib/active_model_serializers/serializable_resource.rb +10 -7
  56. data/lib/active_model_serializers/serialization_context.rb +12 -3
  57. data/lib/active_model_serializers/test/schema.rb +4 -2
  58. data/lib/active_model_serializers/test/serializer.rb +2 -0
  59. data/lib/active_model_serializers/test.rb +2 -0
  60. data/lib/active_model_serializers.rb +35 -10
  61. data/lib/generators/rails/resource_override.rb +3 -1
  62. data/lib/generators/rails/serializer_generator.rb +6 -4
  63. data/lib/grape/active_model_serializers.rb +9 -5
  64. data/lib/grape/formatters/active_model_serializers.rb +21 -2
  65. data/lib/grape/helpers/active_model_serializers.rb +3 -0
  66. data/lib/tasks/rubocop.rake +55 -0
  67. metadata +104 -296
  68. data/.github/ISSUE_TEMPLATE.md +0 -29
  69. data/.github/PULL_REQUEST_TEMPLATE.md +0 -15
  70. data/.gitignore +0 -35
  71. data/.rubocop.yml +0 -104
  72. data/.rubocop_todo.yml +0 -167
  73. data/.simplecov +0 -110
  74. data/.travis.yml +0 -43
  75. data/CONTRIBUTING.md +0 -105
  76. data/Gemfile +0 -53
  77. data/Rakefile +0 -103
  78. data/active_model_serializers.gemspec +0 -66
  79. data/appveyor.yml +0 -24
  80. data/bin/bench +0 -171
  81. data/bin/bench_regression +0 -316
  82. data/bin/serve_benchmark +0 -39
  83. data/docs/ARCHITECTURE.md +0 -126
  84. data/docs/README.md +0 -40
  85. data/docs/STYLE.md +0 -58
  86. data/docs/general/adapters.md +0 -245
  87. data/docs/general/caching.md +0 -52
  88. data/docs/general/configuration_options.md +0 -100
  89. data/docs/general/deserialization.md +0 -100
  90. data/docs/general/getting_started.md +0 -133
  91. data/docs/general/instrumentation.md +0 -40
  92. data/docs/general/key_transforms.md +0 -40
  93. data/docs/general/logging.md +0 -14
  94. data/docs/general/rendering.md +0 -255
  95. data/docs/general/serializers.md +0 -372
  96. data/docs/how-open-source-maintained.jpg +0 -0
  97. data/docs/howto/add_pagination_links.md +0 -139
  98. data/docs/howto/add_root_key.md +0 -51
  99. data/docs/howto/outside_controller_use.md +0 -58
  100. data/docs/howto/passing_arbitrary_options.md +0 -27
  101. data/docs/howto/serialize_poro.md +0 -32
  102. data/docs/howto/test.md +0 -152
  103. data/docs/integrations/ember-and-json-api.md +0 -112
  104. data/docs/integrations/grape.md +0 -19
  105. data/docs/jsonapi/errors.md +0 -56
  106. data/docs/jsonapi/schema/schema.json +0 -366
  107. data/docs/jsonapi/schema.md +0 -151
  108. data/docs/rfcs/0000-namespace.md +0 -106
  109. data/docs/rfcs/template.md +0 -15
  110. data/lib/active_model/serializer/associations.rb +0 -100
  111. data/lib/active_model/serializer/attributes.rb +0 -82
  112. data/lib/active_model/serializer/collection_reflection.rb +0 -7
  113. data/lib/active_model/serializer/configuration.rb +0 -35
  114. data/lib/active_model/serializer/include_tree.rb +0 -111
  115. data/lib/active_model/serializer/links.rb +0 -35
  116. data/lib/active_model/serializer/meta.rb +0 -29
  117. data/lib/active_model/serializer/singular_reflection.rb +0 -7
  118. data/lib/active_model/serializer/type.rb +0 -25
  119. data/lib/active_model_serializers/key_transform.rb +0 -70
  120. data/test/action_controller/adapter_selector_test.rb +0 -53
  121. data/test/action_controller/explicit_serializer_test.rb +0 -134
  122. data/test/action_controller/json/include_test.rb +0 -167
  123. data/test/action_controller/json_api/deserialization_test.rb +0 -112
  124. data/test/action_controller/json_api/errors_test.rb +0 -41
  125. data/test/action_controller/json_api/linked_test.rb +0 -197
  126. data/test/action_controller/json_api/pagination_test.rb +0 -116
  127. data/test/action_controller/json_api/transform_test.rb +0 -181
  128. data/test/action_controller/serialization_scope_name_test.rb +0 -229
  129. data/test/action_controller/serialization_test.rb +0 -469
  130. data/test/active_model_serializers/adapter_for_test.rb +0 -208
  131. data/test/active_model_serializers/json_pointer_test.rb +0 -20
  132. data/test/active_model_serializers/key_transform_test.rb +0 -263
  133. data/test/active_model_serializers/logging_test.rb +0 -77
  134. data/test/active_model_serializers/model_test.rb +0 -9
  135. data/test/active_model_serializers/railtie_test_isolated.rb +0 -63
  136. data/test/active_model_serializers/serialization_context_test_isolated.rb +0 -58
  137. data/test/active_model_serializers/test/schema_test.rb +0 -130
  138. data/test/active_model_serializers/test/serializer_test.rb +0 -62
  139. data/test/active_record_test.rb +0 -9
  140. data/test/adapter/deprecation_test.rb +0 -100
  141. data/test/adapter/json/belongs_to_test.rb +0 -45
  142. data/test/adapter/json/collection_test.rb +0 -90
  143. data/test/adapter/json/has_many_test.rb +0 -45
  144. data/test/adapter/json/transform_test.rb +0 -93
  145. data/test/adapter/json_api/belongs_to_test.rb +0 -155
  146. data/test/adapter/json_api/collection_test.rb +0 -95
  147. data/test/adapter/json_api/errors_test.rb +0 -78
  148. data/test/adapter/json_api/fields_test.rb +0 -87
  149. data/test/adapter/json_api/has_many_embed_ids_test.rb +0 -43
  150. data/test/adapter/json_api/has_many_explicit_serializer_test.rb +0 -96
  151. data/test/adapter/json_api/has_many_test.rb +0 -144
  152. data/test/adapter/json_api/has_one_test.rb +0 -80
  153. data/test/adapter/json_api/json_api_test.rb +0 -35
  154. data/test/adapter/json_api/linked_test.rb +0 -392
  155. data/test/adapter/json_api/links_test.rb +0 -93
  156. data/test/adapter/json_api/pagination_links_test.rb +0 -166
  157. data/test/adapter/json_api/parse_test.rb +0 -137
  158. data/test/adapter/json_api/relationship_test.rb +0 -161
  159. data/test/adapter/json_api/relationships_test.rb +0 -199
  160. data/test/adapter/json_api/resource_identifier_test.rb +0 -85
  161. data/test/adapter/json_api/resource_meta_test.rb +0 -100
  162. data/test/adapter/json_api/toplevel_jsonapi_test.rb +0 -82
  163. data/test/adapter/json_api/transform_test.rb +0 -502
  164. data/test/adapter/json_api/type_test.rb +0 -61
  165. data/test/adapter/json_test.rb +0 -45
  166. data/test/adapter/null_test.rb +0 -23
  167. data/test/adapter/polymorphic_test.rb +0 -171
  168. data/test/adapter_test.rb +0 -67
  169. data/test/array_serializer_test.rb +0 -22
  170. data/test/benchmark/app.rb +0 -65
  171. data/test/benchmark/benchmarking_support.rb +0 -67
  172. data/test/benchmark/bm_caching.rb +0 -119
  173. data/test/benchmark/bm_transform.rb +0 -34
  174. data/test/benchmark/config.ru +0 -3
  175. data/test/benchmark/controllers.rb +0 -84
  176. data/test/benchmark/fixtures.rb +0 -219
  177. data/test/cache_test.rb +0 -485
  178. data/test/collection_serializer_test.rb +0 -110
  179. data/test/fixtures/active_record.rb +0 -78
  180. data/test/fixtures/poro.rb +0 -282
  181. data/test/generators/scaffold_controller_generator_test.rb +0 -24
  182. data/test/generators/serializer_generator_test.rb +0 -57
  183. data/test/grape_test.rb +0 -82
  184. data/test/include_tree/from_include_args_test.rb +0 -26
  185. data/test/include_tree/from_string_test.rb +0 -94
  186. data/test/include_tree/include_args_to_hash_test.rb +0 -64
  187. data/test/lint_test.rb +0 -49
  188. data/test/logger_test.rb +0 -18
  189. data/test/poro_test.rb +0 -9
  190. data/test/serializable_resource_test.rb +0 -83
  191. data/test/serializers/association_macros_test.rb +0 -36
  192. data/test/serializers/associations_test.rb +0 -295
  193. data/test/serializers/attribute_test.rb +0 -151
  194. data/test/serializers/attributes_test.rb +0 -52
  195. data/test/serializers/caching_configuration_test_isolated.rb +0 -170
  196. data/test/serializers/configuration_test.rb +0 -32
  197. data/test/serializers/fieldset_test.rb +0 -14
  198. data/test/serializers/meta_test.rb +0 -196
  199. data/test/serializers/options_test.rb +0 -21
  200. data/test/serializers/read_attribute_for_serialization_test.rb +0 -79
  201. data/test/serializers/root_test.rb +0 -21
  202. data/test/serializers/serialization_test.rb +0 -55
  203. data/test/serializers/serializer_for_test.rb +0 -134
  204. data/test/support/custom_schemas/active_model_serializers/test/schema_test/my/index.json +0 -6
  205. data/test/support/isolated_unit.rb +0 -79
  206. data/test/support/rails5_shims.rb +0 -47
  207. data/test/support/rails_app.rb +0 -45
  208. data/test/support/schemas/active_model_serializers/test/schema_test/my/index.json +0 -6
  209. data/test/support/schemas/active_model_serializers/test/schema_test/my/show.json +0 -6
  210. data/test/support/schemas/custom/show.json +0 -7
  211. data/test/support/schemas/hyper_schema.json +0 -93
  212. data/test/support/schemas/render_using_json_api.json +0 -43
  213. data/test/support/schemas/simple_json_pointers.json +0 -10
  214. data/test/support/serialization_testing.rb +0 -53
  215. data/test/test_helper.rb +0 -57
@@ -1,155 +0,0 @@
1
- require 'test_helper'
2
-
3
- module ActiveModelSerializers
4
- module Adapter
5
- class JsonApi
6
- class BelongsToTest < ActiveSupport::TestCase
7
- def setup
8
- @author = Author.new(id: 1, name: 'Steve K.')
9
- @author.bio = nil
10
- @author.roles = []
11
- @blog = Blog.new(id: 23, name: 'AMS Blog')
12
- @post = Post.new(id: 42, title: 'New Post', body: 'Body')
13
- @anonymous_post = Post.new(id: 43, title: 'Hello!!', body: 'Hello, world!!')
14
- @comment = Comment.new(id: 1, body: 'ZOMG A COMMENT')
15
- @post.comments = [@comment]
16
- @post.blog = @blog
17
- @anonymous_post.comments = []
18
- @anonymous_post.blog = nil
19
- @comment.post = @post
20
- @comment.author = nil
21
- @post.author = @author
22
- @anonymous_post.author = nil
23
- @blog = Blog.new(id: 1, name: 'My Blog!!')
24
- @blog.writer = @author
25
- @blog.articles = [@post, @anonymous_post]
26
- @author.posts = []
27
-
28
- @serializer = CommentSerializer.new(@comment)
29
- @adapter = ActiveModelSerializers::Adapter::JsonApi.new(@serializer)
30
- ActionController::Base.cache_store.clear
31
- end
32
-
33
- def test_includes_post_id
34
- expected = { data: { type: 'posts', id: '42' } }
35
-
36
- assert_equal(expected, @adapter.serializable_hash[:data][:relationships][:post])
37
- end
38
-
39
- def test_includes_linked_post
40
- @adapter = ActiveModelSerializers::Adapter::JsonApi.new(@serializer, include: [:post])
41
- expected = [{
42
- id: '42',
43
- type: 'posts',
44
- attributes: {
45
- title: 'New Post',
46
- body: 'Body'
47
- },
48
- relationships: {
49
- comments: { data: [{ type: 'comments', id: '1' }] },
50
- blog: { data: { type: 'blogs', id: '999' } },
51
- author: { data: { type: 'authors', id: '1' } }
52
- }
53
- }]
54
- assert_equal expected, @adapter.serializable_hash[:included]
55
- end
56
-
57
- def test_limiting_linked_post_fields
58
- @adapter = ActiveModelSerializers::Adapter::JsonApi.new(@serializer, include: [:post], fields: { post: [:title, :comments, :blog, :author] })
59
- expected = [{
60
- id: '42',
61
- type: 'posts',
62
- attributes: {
63
- title: 'New Post'
64
- },
65
- relationships: {
66
- comments: { data: [{ type: 'comments', id: '1' }] },
67
- blog: { data: { type: 'blogs', id: '999' } },
68
- author: { data: { type: 'authors', id: '1' } }
69
- }
70
- }]
71
- assert_equal expected, @adapter.serializable_hash[:included]
72
- end
73
-
74
- def test_include_nil_author
75
- serializer = PostSerializer.new(@anonymous_post)
76
- adapter = ActiveModelSerializers::Adapter::JsonApi.new(serializer)
77
-
78
- assert_equal({ comments: { data: [] }, blog: { data: { type: 'blogs', id: '999' } }, author: { data: nil } }, adapter.serializable_hash[:data][:relationships])
79
- end
80
-
81
- def test_include_type_for_association_when_different_than_name
82
- serializer = BlogSerializer.new(@blog)
83
- adapter = ActiveModelSerializers::Adapter::JsonApi.new(serializer)
84
- relationships = adapter.serializable_hash[:data][:relationships]
85
- expected = {
86
- writer: {
87
- data: {
88
- type: 'authors',
89
- id: '1'
90
- }
91
- },
92
- articles: {
93
- data: [
94
- {
95
- type: 'posts',
96
- id: '42'
97
- },
98
- {
99
- type: 'posts',
100
- id: '43'
101
- }
102
- ]
103
- }
104
- }
105
- assert_equal expected, relationships
106
- end
107
-
108
- def test_include_linked_resources_with_type_name
109
- serializer = BlogSerializer.new(@blog)
110
- adapter = ActiveModelSerializers::Adapter::JsonApi.new(serializer, include: [:writer, :articles])
111
- linked = adapter.serializable_hash[:included]
112
- expected = [
113
- {
114
- id: '1',
115
- type: 'authors',
116
- attributes: {
117
- name: 'Steve K.'
118
- },
119
- relationships: {
120
- posts: { data: [] },
121
- roles: { data: [] },
122
- bio: { data: nil }
123
- }
124
- }, {
125
- id: '42',
126
- type: 'posts',
127
- attributes: {
128
- title: 'New Post',
129
- body: 'Body'
130
- },
131
- relationships: {
132
- comments: { data: [{ type: 'comments', id: '1' }] },
133
- blog: { data: { type: 'blogs', id: '999' } },
134
- author: { data: { type: 'authors', id: '1' } }
135
- }
136
- }, {
137
- id: '43',
138
- type: 'posts',
139
- attributes: {
140
- title: 'Hello!!',
141
- body: 'Hello, world!!'
142
- },
143
- relationships: {
144
- comments: { data: [] },
145
- blog: { data: { type: 'blogs', id: '999' } },
146
- author: { data: nil }
147
- }
148
- }
149
- ]
150
- assert_equal expected, linked
151
- end
152
- end
153
- end
154
- end
155
- end
@@ -1,95 +0,0 @@
1
- require 'test_helper'
2
-
3
- module ActiveModelSerializers
4
- module Adapter
5
- class JsonApi
6
- class CollectionTest < ActiveSupport::TestCase
7
- def setup
8
- @author = Author.new(id: 1, name: 'Steve K.')
9
- @author.bio = nil
10
- @blog = Blog.new(id: 23, name: 'AMS Blog')
11
- @first_post = Post.new(id: 1, title: 'Hello!!', body: 'Hello, world!!')
12
- @second_post = Post.new(id: 2, title: 'New Post', body: 'Body')
13
- @first_post.comments = []
14
- @second_post.comments = []
15
- @first_post.blog = @blog
16
- @second_post.blog = nil
17
- @first_post.author = @author
18
- @second_post.author = @author
19
- @author.posts = [@first_post, @second_post]
20
-
21
- @serializer = ActiveModel::Serializer::CollectionSerializer.new([@first_post, @second_post])
22
- @adapter = ActiveModelSerializers::Adapter::JsonApi.new(@serializer)
23
- ActionController::Base.cache_store.clear
24
- end
25
-
26
- def test_include_multiple_posts
27
- expected = [
28
- {
29
- id: '1',
30
- type: 'posts',
31
- attributes: {
32
- title: 'Hello!!',
33
- body: 'Hello, world!!'
34
- },
35
- relationships: {
36
- comments: { data: [] },
37
- blog: { data: { type: 'blogs', id: '999' } },
38
- author: { data: { type: 'authors', id: '1' } }
39
- }
40
- },
41
- {
42
- id: '2',
43
- type: 'posts',
44
- attributes: {
45
- title: 'New Post',
46
- body: 'Body'
47
- },
48
- relationships: {
49
- comments: { data: [] },
50
- blog: { data: { type: 'blogs', id: '999' } },
51
- author: { data: { type: 'authors', id: '1' } }
52
- }
53
- }
54
- ]
55
-
56
- assert_equal(expected, @adapter.serializable_hash[:data])
57
- end
58
-
59
- def test_limiting_fields
60
- actual = ActiveModelSerializers::SerializableResource.new(
61
- [@first_post, @second_post], adapter: :json_api,
62
- fields: { posts: %w(title comments blog author) })
63
- .serializable_hash
64
- expected = [
65
- {
66
- id: '1',
67
- type: 'posts',
68
- attributes: {
69
- title: 'Hello!!'
70
- },
71
- relationships: {
72
- comments: { data: [] },
73
- blog: { data: { type: 'blogs', id: '999' } },
74
- author: { data: { type: 'authors', id: '1' } }
75
- }
76
- },
77
- {
78
- id: '2',
79
- type: 'posts',
80
- attributes: {
81
- title: 'New Post'
82
- },
83
- relationships: {
84
- comments: { data: [] },
85
- blog: { data: { type: 'blogs', id: '999' } },
86
- author: { data: { type: 'authors', id: '1' } }
87
- }
88
- }
89
- ]
90
- assert_equal(expected, actual[:data])
91
- end
92
- end
93
- end
94
- end
95
- end
@@ -1,78 +0,0 @@
1
- require 'test_helper'
2
-
3
- module ActiveModelSerializers
4
- module Adapter
5
- class JsonApi < Base
6
- class ErrorsTest < Minitest::Test
7
- include ActiveModel::Serializer::Lint::Tests
8
-
9
- def setup
10
- @resource = ModelWithErrors.new
11
- end
12
-
13
- def test_active_model_with_error
14
- options = {
15
- serializer: ActiveModel::Serializer::ErrorSerializer,
16
- adapter: :json_api
17
- }
18
-
19
- @resource.errors.add(:name, 'cannot be nil')
20
-
21
- serializable_resource = ActiveModelSerializers::SerializableResource.new(@resource, options)
22
- assert_equal serializable_resource.serializer_instance.attributes, {}
23
- assert_equal serializable_resource.serializer_instance.object, @resource
24
-
25
- expected_errors_object =
26
- { :errors =>
27
- [
28
- {
29
- source: { pointer: '/data/attributes/name' },
30
- detail: 'cannot be nil'
31
- }
32
- ]
33
- }
34
- assert_equal serializable_resource.as_json, expected_errors_object
35
- end
36
-
37
- def test_active_model_with_multiple_errors
38
- options = {
39
- serializer: ActiveModel::Serializer::ErrorSerializer,
40
- adapter: :json_api
41
- }
42
-
43
- @resource.errors.add(:name, 'cannot be nil')
44
- @resource.errors.add(:name, 'must be longer')
45
- @resource.errors.add(:id, 'must be a uuid')
46
-
47
- serializable_resource = ActiveModelSerializers::SerializableResource.new(@resource, options)
48
- assert_equal serializable_resource.serializer_instance.attributes, {}
49
- assert_equal serializable_resource.serializer_instance.object, @resource
50
-
51
- expected_errors_object =
52
- { :errors =>
53
- [
54
- { :source => { :pointer => '/data/attributes/name' }, :detail => 'cannot be nil' },
55
- { :source => { :pointer => '/data/attributes/name' }, :detail => 'must be longer' },
56
- { :source => { :pointer => '/data/attributes/id' }, :detail => 'must be a uuid' }
57
- ]
58
- }
59
- assert_equal serializable_resource.as_json, expected_errors_object
60
- end
61
-
62
- # see http://jsonapi.org/examples/
63
- def test_parameter_source_type_error
64
- parameter = 'auther'
65
- error_source = ActiveModelSerializers::Adapter::JsonApi::Error.error_source(:parameter, parameter)
66
- assert_equal({ parameter: parameter }, error_source)
67
- end
68
-
69
- def test_unknown_source_type_error
70
- value = 'auther'
71
- assert_raises(ActiveModelSerializers::Adapter::JsonApi::Error::UnknownSourceTypeError) do
72
- ActiveModelSerializers::Adapter::JsonApi::Error.error_source(:hyper, value)
73
- end
74
- end
75
- end
76
- end
77
- end
78
- end
@@ -1,87 +0,0 @@
1
- require 'test_helper'
2
-
3
- module ActiveModelSerializers
4
- module Adapter
5
- class JsonApi
6
- class FieldsTest < ActiveSupport::TestCase
7
- Post = Class.new(::Model)
8
- class PostSerializer < ActiveModel::Serializer
9
- type 'posts'
10
- attributes :title, :body
11
- belongs_to :author
12
- has_many :comments
13
- end
14
-
15
- Author = Class.new(::Model)
16
- class AuthorSerializer < ActiveModel::Serializer
17
- type 'authors'
18
- attributes :name, :birthday
19
- end
20
-
21
- Comment = Class.new(::Model)
22
- class CommentSerializer < ActiveModel::Serializer
23
- type 'comments'
24
- attributes :body
25
- belongs_to :author
26
- end
27
-
28
- def setup
29
- @author = Author.new(id: 1, name: 'Lucas', birthday: '10.01.1990')
30
- @comment1 = Comment.new(id: 7, body: 'cool', author: @author)
31
- @comment2 = Comment.new(id: 12, body: 'awesome', author: @author)
32
- @post = Post.new(id: 1337, title: 'Title 1', body: 'Body 1',
33
- author: @author, comments: [@comment1, @comment2])
34
- @comment1.post = @post
35
- @comment2.post = @post
36
- end
37
-
38
- def test_fields_attributes
39
- fields = { posts: [:title] }
40
- hash = serializable(@post, adapter: :json_api, fields: fields).serializable_hash
41
- expected = {
42
- title: 'Title 1'
43
- }
44
-
45
- assert_equal(expected, hash[:data][:attributes])
46
- end
47
-
48
- def test_fields_relationships
49
- fields = { posts: [:author] }
50
- hash = serializable(@post, adapter: :json_api, fields: fields).serializable_hash
51
- expected = {
52
- author: {
53
- data: {
54
- type: 'authors',
55
- id: '1'
56
- }
57
- }
58
- }
59
-
60
- assert_equal(expected, hash[:data][:relationships])
61
- end
62
-
63
- def test_fields_included
64
- fields = { posts: [:author], comments: [:body] }
65
- hash = serializable(@post, adapter: :json_api, fields: fields, include: 'comments').serializable_hash
66
- expected = [
67
- {
68
- type: 'comments',
69
- id: '7',
70
- attributes: {
71
- body: 'cool'
72
- }
73
- }, {
74
- type: 'comments',
75
- id: '12',
76
- attributes: {
77
- body: 'awesome'
78
- }
79
- }
80
- ]
81
-
82
- assert_equal(expected, hash[:included])
83
- end
84
- end
85
- end
86
- end
87
- end
@@ -1,43 +0,0 @@
1
- require 'test_helper'
2
-
3
- module ActiveModelSerializers
4
- module Adapter
5
- class JsonApi
6
- class HasManyEmbedIdsTest < ActiveSupport::TestCase
7
- def setup
8
- @author = Author.new(name: 'Steve K.')
9
- @author.bio = nil
10
- @author.roles = nil
11
- @first_post = Post.new(id: 1, title: 'Hello!!', body: 'Hello, world!!')
12
- @second_post = Post.new(id: 2, title: 'New Post', body: 'Body')
13
- @author.posts = [@first_post, @second_post]
14
- @first_post.author = @author
15
- @second_post.author = @author
16
- @first_post.comments = []
17
- @second_post.comments = []
18
- @blog = Blog.new(id: 23, name: 'AMS Blog')
19
- @first_post.blog = @blog
20
- @second_post.blog = nil
21
-
22
- @serializer = AuthorSerializer.new(@author)
23
- @adapter = ActiveModelSerializers::Adapter::JsonApi.new(@serializer)
24
- end
25
-
26
- def test_includes_comment_ids
27
- expected = {
28
- data: [
29
- { type: 'posts', id: '1' },
30
- { type: 'posts', id: '2' }
31
- ]
32
- }
33
-
34
- assert_equal(expected, @adapter.serializable_hash[:data][:relationships][:posts])
35
- end
36
-
37
- def test_no_includes_linked_comments
38
- assert_nil @adapter.serializable_hash[:linked]
39
- end
40
- end
41
- end
42
- end
43
- end
@@ -1,96 +0,0 @@
1
- require 'test_helper'
2
-
3
- module ActiveModelSerializers
4
- module Adapter
5
- class JsonApi
6
- # Test 'has_many :assocs, serializer: AssocXSerializer'
7
- class HasManyExplicitSerializerTest < ActiveSupport::TestCase
8
- def setup
9
- @post = Post.new(title: 'New Post', body: 'Body')
10
- @author = Author.new(name: 'Jane Blogger')
11
- @author.posts = [@post]
12
- @post.author = @author
13
- @first_comment = Comment.new(id: 1, body: 'ZOMG A COMMENT')
14
- @second_comment = Comment.new(id: 2, body: 'ZOMG ANOTHER COMMENT')
15
- @post.comments = [@first_comment, @second_comment]
16
- @first_comment.post = @post
17
- @first_comment.author = nil
18
- @second_comment.post = @post
19
- @second_comment.author = nil
20
- @blog = Blog.new(id: 23, name: 'AMS Blog')
21
- @post.blog = @blog
22
-
23
- @serializer = PostPreviewSerializer.new(@post)
24
- @adapter = ActiveModelSerializers::Adapter::JsonApi.new(
25
- @serializer,
26
- include: [:comments, :author]
27
- )
28
- end
29
-
30
- def test_includes_comment_ids
31
- expected = {
32
- data: [
33
- { type: 'comments', id: '1' },
34
- { type: 'comments', id: '2' }
35
- ]
36
- }
37
-
38
- assert_equal(expected, @adapter.serializable_hash[:data][:relationships][:comments])
39
- end
40
-
41
- def test_includes_linked_data
42
- # If CommentPreviewSerializer is applied correctly the body text will not be present in the output
43
- expected = [
44
- {
45
- id: '1',
46
- type: 'comments',
47
- relationships: {
48
- post: { data: { type: 'posts', id: @post.id.to_s } }
49
- }
50
- },
51
- {
52
- id: '2',
53
- type: 'comments',
54
- relationships: {
55
- post: { data: { type: 'posts', id: @post.id.to_s } }
56
- }
57
- },
58
- {
59
- id: @author.id.to_s,
60
- type: 'authors',
61
- relationships: {
62
- posts: { data: [{ type: 'posts', id: @post.id.to_s }] }
63
- }
64
- }
65
- ]
66
-
67
- assert_equal(expected, @adapter.serializable_hash[:included])
68
- end
69
-
70
- def test_includes_author_id
71
- expected = {
72
- data: { type: 'authors', id: @author.id.to_s }
73
- }
74
-
75
- assert_equal(expected, @adapter.serializable_hash[:data][:relationships][:author])
76
- end
77
-
78
- def test_explicit_serializer_with_null_resource
79
- @post.author = nil
80
-
81
- expected = { data: nil }
82
-
83
- assert_equal(expected, @adapter.serializable_hash[:data][:relationships][:author])
84
- end
85
-
86
- def test_explicit_serializer_with_null_collection
87
- @post.comments = []
88
-
89
- expected = { data: [] }
90
-
91
- assert_equal(expected, @adapter.serializable_hash[:data][:relationships][:comments])
92
- end
93
- end
94
- end
95
- end
96
- end
@@ -1,144 +0,0 @@
1
- require 'test_helper'
2
-
3
- module ActiveModelSerializers
4
- module Adapter
5
- class JsonApi
6
- class HasManyTest < ActiveSupport::TestCase
7
- def setup
8
- ActionController::Base.cache_store.clear
9
- @author = Author.new(id: 1, name: 'Steve K.')
10
- @author.posts = []
11
- @author.bio = nil
12
- @post = Post.new(id: 1, title: 'New Post', body: 'Body')
13
- @post_without_comments = Post.new(id: 2, title: 'Second Post', body: 'Second')
14
- @first_comment = Comment.new(id: 1, body: 'ZOMG A COMMENT')
15
- @first_comment.author = nil
16
- @second_comment = Comment.new(id: 2, body: 'ZOMG ANOTHER COMMENT')
17
- @second_comment.author = nil
18
- @post.comments = [@first_comment, @second_comment]
19
- @post_without_comments.comments = []
20
- @first_comment.post = @post
21
- @second_comment.post = @post
22
- @post.author = @author
23
- @post_without_comments.author = nil
24
- @blog = Blog.new(id: 1, name: 'My Blog!!')
25
- @blog.writer = @author
26
- @blog.articles = [@post]
27
- @post.blog = @blog
28
- @post_without_comments.blog = nil
29
- @tag = Tag.new(id: 1, name: '#hash_tag')
30
- @post.tags = [@tag]
31
- @serializer = PostSerializer.new(@post)
32
- @adapter = ActiveModelSerializers::Adapter::JsonApi.new(@serializer)
33
-
34
- @virtual_value = VirtualValue.new(id: 1)
35
- end
36
-
37
- def test_includes_comment_ids
38
- expected = { data: [{ type: 'comments', id: '1' }, { type: 'comments', id: '2' }] }
39
-
40
- assert_equal(expected, @adapter.serializable_hash[:data][:relationships][:comments])
41
- end
42
-
43
- def test_includes_linked_comments
44
- @adapter = ActiveModelSerializers::Adapter::JsonApi.new(@serializer, include: [:comments])
45
- expected = [{
46
- id: '1',
47
- type: 'comments',
48
- attributes: {
49
- body: 'ZOMG A COMMENT'
50
- },
51
- relationships: {
52
- post: { data: { type: 'posts', id: '1' } },
53
- author: { data: nil }
54
- }
55
- }, {
56
- id: '2',
57
- type: 'comments',
58
- attributes: {
59
- body: 'ZOMG ANOTHER COMMENT'
60
- },
61
- relationships: {
62
- post: { data: { type: 'posts', id: '1' } },
63
- author: { data: nil }
64
- }
65
- }]
66
- assert_equal expected, @adapter.serializable_hash[:included]
67
- end
68
-
69
- def test_limit_fields_of_linked_comments
70
- @adapter = ActiveModelSerializers::Adapter::JsonApi.new(@serializer, include: [:comments], fields: { comment: [:id, :post, :author] })
71
- expected = [{
72
- id: '1',
73
- type: 'comments',
74
- relationships: {
75
- post: { data: { type: 'posts', id: '1' } },
76
- author: { data: nil }
77
- }
78
- }, {
79
- id: '2',
80
- type: 'comments',
81
- relationships: {
82
- post: { data: { type: 'posts', id: '1' } },
83
- author: { data: nil }
84
- }
85
- }]
86
- assert_equal expected, @adapter.serializable_hash[:included]
87
- end
88
-
89
- def test_no_include_linked_if_comments_is_empty
90
- serializer = PostSerializer.new(@post_without_comments)
91
- adapter = ActiveModelSerializers::Adapter::JsonApi.new(serializer)
92
-
93
- assert_nil adapter.serializable_hash[:linked]
94
- end
95
-
96
- def test_include_type_for_association_when_different_than_name
97
- serializer = BlogSerializer.new(@blog)
98
- adapter = ActiveModelSerializers::Adapter::JsonApi.new(serializer)
99
- actual = adapter.serializable_hash[:data][:relationships][:articles]
100
-
101
- expected = {
102
- data: [{
103
- type: 'posts',
104
- id: '1'
105
- }]
106
- }
107
- assert_equal expected, actual
108
- end
109
-
110
- def test_has_many_with_no_serializer
111
- serializer = PostWithTagsSerializer.new(@post)
112
- adapter = ActiveModelSerializers::Adapter::JsonApi.new(serializer)
113
-
114
- assert_equal({
115
- data: {
116
- id: '1',
117
- type: 'posts',
118
- relationships: {
119
- tags: { data: [@tag.as_json] }
120
- }
121
- }
122
- }, adapter.serializable_hash)
123
- end
124
-
125
- def test_has_many_with_virtual_value
126
- serializer = VirtualValueSerializer.new(@virtual_value)
127
- adapter = ActiveModelSerializers::Adapter::JsonApi.new(serializer)
128
-
129
- assert_equal({
130
- data: {
131
- id: '1',
132
- type: 'virtual-values',
133
- relationships: {
134
- maker: { data: { type: 'makers', id: '1' } },
135
- reviews: { data: [{ type: 'reviews', id: '1' },
136
- { type: 'reviews', id: '2' }] }
137
- }
138
- }
139
- }, adapter.serializable_hash)
140
- end
141
- end
142
- end
143
- end
144
- end