active_model_serializers 0.10.6 → 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 +114 -1
  3. data/README.md +21 -24
  4. data/lib/action_controller/serialization.rb +11 -1
  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 +2 -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 +2 -0
  13. data/lib/active_model/serializer/association.rb +2 -0
  14. data/lib/active_model/serializer/attribute.rb +2 -0
  15. data/lib/active_model/serializer/belongs_to_reflection.rb +2 -0
  16. data/lib/active_model/serializer/collection_serializer.rb +17 -5
  17. data/lib/active_model/serializer/concerns/caching.rb +7 -2
  18. data/lib/active_model/serializer/error_serializer.rb +2 -0
  19. data/lib/active_model/serializer/errors_serializer.rb +2 -0
  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 +2 -0
  23. data/lib/active_model/serializer/has_one_reflection.rb +2 -0
  24. data/lib/active_model/serializer/lazy_association.rb +6 -2
  25. data/lib/active_model/serializer/link.rb +23 -0
  26. data/lib/active_model/serializer/lint.rb +2 -0
  27. data/lib/active_model/serializer/null.rb +2 -0
  28. data/lib/active_model/serializer/reflection.rb +10 -5
  29. data/lib/active_model/serializer/version.rb +3 -1
  30. data/lib/active_model/serializer.rb +37 -19
  31. data/lib/active_model_serializers/adapter/attributes.rb +23 -0
  32. data/lib/active_model_serializers/adapter/base.rb +2 -0
  33. data/lib/active_model_serializers/adapter/json.rb +2 -0
  34. data/lib/active_model_serializers/adapter/json_api/deserialization.rb +3 -1
  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 +2 -0
  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 +45 -20
  40. data/lib/active_model_serializers/adapter/json_api/relationship.rb +18 -4
  41. data/lib/active_model_serializers/adapter/json_api/resource_identifier.rb +33 -25
  42. data/lib/active_model_serializers/adapter/json_api.rb +14 -9
  43. data/lib/active_model_serializers/adapter/null.rb +2 -0
  44. data/lib/active_model_serializers/adapter.rb +3 -1
  45. data/lib/active_model_serializers/callbacks.rb +2 -0
  46. data/lib/active_model_serializers/deprecate.rb +2 -0
  47. data/lib/active_model_serializers/deserialization.rb +2 -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 +2 -0
  51. data/lib/active_model_serializers/model/caching.rb +26 -0
  52. data/lib/active_model_serializers/model.rb +2 -0
  53. data/lib/active_model_serializers/railtie.rb +4 -0
  54. data/lib/active_model_serializers/register_jsonapi_renderer.rb +2 -0
  55. data/lib/active_model_serializers/serializable_resource.rb +4 -2
  56. data/lib/active_model_serializers/serialization_context.rb +2 -0
  57. data/lib/active_model_serializers/test/schema.rb +2 -0
  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 +21 -11
  61. data/lib/generators/rails/resource_override.rb +2 -0
  62. data/lib/generators/rails/serializer_generator.rb +2 -0
  63. data/lib/grape/active_model_serializers.rb +2 -0
  64. data/lib/grape/formatters/active_model_serializers.rb +2 -0
  65. data/lib/grape/helpers/active_model_serializers.rb +2 -0
  66. data/lib/tasks/rubocop.rake +2 -0
  67. metadata +43 -298
  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 -105
  72. data/.simplecov +0 -110
  73. data/.travis.yml +0 -55
  74. data/CODE_OF_CONDUCT.md +0 -74
  75. data/CONTRIBUTING.md +0 -105
  76. data/Gemfile +0 -56
  77. data/Rakefile +0 -74
  78. data/active_model_serializers.gemspec +0 -63
  79. data/appveyor.yml +0 -30
  80. data/bin/bench +0 -171
  81. data/bin/bench_regression +0 -316
  82. data/bin/rubocop +0 -38
  83. data/bin/serve_benchmark +0 -39
  84. data/docs/README.md +0 -41
  85. data/docs/STYLE.md +0 -58
  86. data/docs/general/adapters.md +0 -263
  87. data/docs/general/caching.md +0 -58
  88. data/docs/general/configuration_options.md +0 -169
  89. data/docs/general/deserialization.md +0 -100
  90. data/docs/general/fields.md +0 -31
  91. data/docs/general/getting_started.md +0 -133
  92. data/docs/general/instrumentation.md +0 -40
  93. data/docs/general/key_transforms.md +0 -40
  94. data/docs/general/logging.md +0 -21
  95. data/docs/general/rendering.md +0 -293
  96. data/docs/general/serializers.md +0 -480
  97. data/docs/how-open-source-maintained.jpg +0 -0
  98. data/docs/howto/add_pagination_links.md +0 -138
  99. data/docs/howto/add_relationship_links.md +0 -140
  100. data/docs/howto/add_root_key.md +0 -55
  101. data/docs/howto/grape_integration.md +0 -42
  102. data/docs/howto/outside_controller_use.md +0 -66
  103. data/docs/howto/passing_arbitrary_options.md +0 -27
  104. data/docs/howto/serialize_poro.md +0 -73
  105. data/docs/howto/test.md +0 -154
  106. data/docs/howto/upgrade_from_0_8_to_0_10.md +0 -265
  107. data/docs/integrations/ember-and-json-api.md +0 -147
  108. data/docs/integrations/grape.md +0 -19
  109. data/docs/jsonapi/errors.md +0 -56
  110. data/docs/jsonapi/schema/schema.json +0 -366
  111. data/docs/jsonapi/schema.md +0 -151
  112. data/docs/rfcs/0000-namespace.md +0 -106
  113. data/docs/rfcs/template.md +0 -15
  114. data/test/action_controller/adapter_selector_test.rb +0 -62
  115. data/test/action_controller/explicit_serializer_test.rb +0 -135
  116. data/test/action_controller/json/include_test.rb +0 -246
  117. data/test/action_controller/json_api/deserialization_test.rb +0 -112
  118. data/test/action_controller/json_api/errors_test.rb +0 -40
  119. data/test/action_controller/json_api/fields_test.rb +0 -66
  120. data/test/action_controller/json_api/linked_test.rb +0 -202
  121. data/test/action_controller/json_api/pagination_test.rb +0 -116
  122. data/test/action_controller/json_api/transform_test.rb +0 -189
  123. data/test/action_controller/lookup_proc_test.rb +0 -49
  124. data/test/action_controller/namespace_lookup_test.rb +0 -232
  125. data/test/action_controller/serialization_scope_name_test.rb +0 -235
  126. data/test/action_controller/serialization_test.rb +0 -472
  127. data/test/active_model_serializers/adapter_for_test.rb +0 -208
  128. data/test/active_model_serializers/json_pointer_test.rb +0 -22
  129. data/test/active_model_serializers/logging_test.rb +0 -77
  130. data/test/active_model_serializers/model_test.rb +0 -142
  131. data/test/active_model_serializers/railtie_test_isolated.rb +0 -68
  132. data/test/active_model_serializers/register_jsonapi_renderer_test_isolated.rb +0 -161
  133. data/test/active_model_serializers/serialization_context_test_isolated.rb +0 -71
  134. data/test/active_model_serializers/test/schema_test.rb +0 -131
  135. data/test/active_model_serializers/test/serializer_test.rb +0 -62
  136. data/test/active_record_test.rb +0 -9
  137. data/test/adapter/attributes_test.rb +0 -40
  138. data/test/adapter/deprecation_test.rb +0 -100
  139. data/test/adapter/json/belongs_to_test.rb +0 -45
  140. data/test/adapter/json/collection_test.rb +0 -104
  141. data/test/adapter/json/has_many_test.rb +0 -53
  142. data/test/adapter/json/transform_test.rb +0 -93
  143. data/test/adapter/json_api/belongs_to_test.rb +0 -155
  144. data/test/adapter/json_api/collection_test.rb +0 -96
  145. data/test/adapter/json_api/errors_test.rb +0 -76
  146. data/test/adapter/json_api/fields_test.rb +0 -96
  147. data/test/adapter/json_api/has_many_embed_ids_test.rb +0 -43
  148. data/test/adapter/json_api/has_many_explicit_serializer_test.rb +0 -96
  149. data/test/adapter/json_api/has_many_test.rb +0 -173
  150. data/test/adapter/json_api/has_one_test.rb +0 -80
  151. data/test/adapter/json_api/include_data_if_sideloaded_test.rb +0 -183
  152. data/test/adapter/json_api/json_api_test.rb +0 -33
  153. data/test/adapter/json_api/linked_test.rb +0 -413
  154. data/test/adapter/json_api/links_test.rb +0 -95
  155. data/test/adapter/json_api/pagination_links_test.rb +0 -193
  156. data/test/adapter/json_api/parse_test.rb +0 -137
  157. data/test/adapter/json_api/relationship_test.rb +0 -397
  158. data/test/adapter/json_api/resource_identifier_test.rb +0 -110
  159. data/test/adapter/json_api/resource_meta_test.rb +0 -100
  160. data/test/adapter/json_api/toplevel_jsonapi_test.rb +0 -82
  161. data/test/adapter/json_api/transform_test.rb +0 -512
  162. data/test/adapter/json_api/type_test.rb +0 -61
  163. data/test/adapter/json_test.rb +0 -46
  164. data/test/adapter/null_test.rb +0 -22
  165. data/test/adapter/polymorphic_test.rb +0 -171
  166. data/test/adapter_test.rb +0 -67
  167. data/test/array_serializer_test.rb +0 -22
  168. data/test/benchmark/app.rb +0 -65
  169. data/test/benchmark/benchmarking_support.rb +0 -67
  170. data/test/benchmark/bm_active_record.rb +0 -81
  171. data/test/benchmark/bm_adapter.rb +0 -38
  172. data/test/benchmark/bm_caching.rb +0 -119
  173. data/test/benchmark/bm_lookup_chain.rb +0 -83
  174. data/test/benchmark/bm_transform.rb +0 -45
  175. data/test/benchmark/config.ru +0 -3
  176. data/test/benchmark/controllers.rb +0 -83
  177. data/test/benchmark/fixtures.rb +0 -219
  178. data/test/cache_test.rb +0 -651
  179. data/test/collection_serializer_test.rb +0 -123
  180. data/test/fixtures/active_record.rb +0 -113
  181. data/test/fixtures/poro.rb +0 -225
  182. data/test/generators/scaffold_controller_generator_test.rb +0 -24
  183. data/test/generators/serializer_generator_test.rb +0 -75
  184. data/test/grape_test.rb +0 -196
  185. data/test/lint_test.rb +0 -49
  186. data/test/logger_test.rb +0 -20
  187. data/test/poro_test.rb +0 -9
  188. data/test/serializable_resource_test.rb +0 -79
  189. data/test/serializers/association_macros_test.rb +0 -37
  190. data/test/serializers/associations_test.rb +0 -424
  191. data/test/serializers/attribute_test.rb +0 -153
  192. data/test/serializers/attributes_test.rb +0 -52
  193. data/test/serializers/caching_configuration_test_isolated.rb +0 -170
  194. data/test/serializers/configuration_test.rb +0 -32
  195. data/test/serializers/fieldset_test.rb +0 -14
  196. data/test/serializers/meta_test.rb +0 -202
  197. data/test/serializers/options_test.rb +0 -32
  198. data/test/serializers/read_attribute_for_serialization_test.rb +0 -79
  199. data/test/serializers/reflection_test.rb +0 -427
  200. data/test/serializers/root_test.rb +0 -21
  201. data/test/serializers/serialization_test.rb +0 -55
  202. data/test/serializers/serializer_for_test.rb +0 -136
  203. data/test/serializers/serializer_for_with_namespace_test.rb +0 -88
  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 -82
  206. data/test/support/rails5_shims.rb +0 -53
  207. data/test/support/rails_app.rb +0 -38
  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 -71
  215. data/test/test_helper.rb +0 -70
@@ -1,95 +0,0 @@
1
- require 'test_helper'
2
-
3
- module ActiveModelSerializers
4
- module Adapter
5
- class JsonApi
6
- class LinksTest < ActiveSupport::TestCase
7
- class LinkAuthor < ::Model; associations :posts end
8
- class LinkAuthorSerializer < ActiveModel::Serializer
9
- link :self do
10
- href "http://example.com/link_author/#{object.id}"
11
- meta stuff: 'value'
12
- end
13
- link(:author) { link_author_url(object.id) }
14
- link(:link_authors) { url_for(controller: 'link_authors', action: 'index', only_path: false) }
15
- link(:posts) { link_author_posts_url(object.id) }
16
- link :resource, 'http://example.com/resource'
17
- link :yet_another do
18
- "http://example.com/resource/#{object.id}"
19
- end
20
- link(:nil) { nil }
21
- end
22
-
23
- def setup
24
- Rails.application.routes.draw do
25
- resources :link_authors do
26
- resources :posts
27
- end
28
- end
29
- @post = Post.new(id: 1337, comments: [], author: nil)
30
- @author = LinkAuthor.new(id: 1337, posts: [@post])
31
- end
32
-
33
- def test_toplevel_links
34
- hash = ActiveModelSerializers::SerializableResource.new(
35
- @post,
36
- adapter: :json_api,
37
- links: {
38
- self: {
39
- href: 'http://example.com/posts',
40
- meta: {
41
- stuff: 'value'
42
- }
43
- }
44
- }
45
- ).serializable_hash
46
- expected = {
47
- self: {
48
- href: 'http://example.com/posts',
49
- meta: {
50
- stuff: 'value'
51
- }
52
- }
53
- }
54
- assert_equal(expected, hash[:links])
55
- end
56
-
57
- def test_nil_toplevel_links
58
- hash = ActiveModelSerializers::SerializableResource.new(
59
- @post,
60
- adapter: :json_api,
61
- links: nil
62
- ).serializable_hash
63
- refute hash.key?(:links), 'No links key to be output'
64
- end
65
-
66
- def test_nil_toplevel_links_json_adapter
67
- hash = ActiveModelSerializers::SerializableResource.new(
68
- @post,
69
- adapter: :json,
70
- links: nil
71
- ).serializable_hash
72
- refute hash.key?(:links), 'No links key to be output'
73
- end
74
-
75
- def test_resource_links
76
- hash = serializable(@author, adapter: :json_api).serializable_hash
77
- expected = {
78
- self: {
79
- href: 'http://example.com/link_author/1337',
80
- meta: {
81
- stuff: 'value'
82
- }
83
- },
84
- author: 'http://example.com/link_authors/1337',
85
- :"link-authors" => 'http://example.com/link_authors',
86
- resource: 'http://example.com/resource',
87
- posts: 'http://example.com/link_authors/1337/posts',
88
- :"yet-another" => 'http://example.com/resource/1337'
89
- }
90
- assert_equal(expected, hash[:data][:links])
91
- end
92
- end
93
- end
94
- end
95
- end
@@ -1,193 +0,0 @@
1
- require 'test_helper'
2
- require 'will_paginate/array'
3
- require 'kaminari'
4
- require 'kaminari/hooks'
5
- ::Kaminari::Hooks.init
6
-
7
- module ActiveModelSerializers
8
- module Adapter
9
- class JsonApi
10
- class PaginationLinksTest < ActiveSupport::TestCase
11
- URI = 'http://example.com'.freeze
12
-
13
- def setup
14
- ActionController::Base.cache_store.clear
15
- @array = [
16
- Profile.new(id: 1, name: 'Name 1', description: 'Description 1', comments: 'Comments 1'),
17
- Profile.new(id: 2, name: 'Name 2', description: 'Description 2', comments: 'Comments 2'),
18
- Profile.new(id: 3, name: 'Name 3', description: 'Description 3', comments: 'Comments 3'),
19
- Profile.new(id: 4, name: 'Name 4', description: 'Description 4', comments: 'Comments 4'),
20
- Profile.new(id: 5, name: 'Name 5', description: 'Description 5', comments: 'Comments 5')
21
- ]
22
- end
23
-
24
- def mock_request(query_parameters = {}, original_url = URI)
25
- context = Minitest::Mock.new
26
- context.expect(:request_url, original_url)
27
- context.expect(:query_parameters, query_parameters)
28
- context.expect(:key_transform, nil)
29
- end
30
-
31
- def load_adapter(paginated_collection, mock_request = nil)
32
- render_options = { adapter: :json_api }
33
- render_options[:serialization_context] = mock_request if mock_request
34
- serializable(paginated_collection, render_options)
35
- end
36
-
37
- def using_kaminari(page = 2)
38
- Kaminari.paginate_array(@array).page(page).per(2)
39
- end
40
-
41
- def using_will_paginate(page = 2)
42
- @array.paginate(page: page, per_page: 2)
43
- end
44
-
45
- def data
46
- {
47
- data: [
48
- { id: '1', type: 'profiles', attributes: { name: 'Name 1', description: 'Description 1' } },
49
- { id: '2', type: 'profiles', attributes: { name: 'Name 2', description: 'Description 2' } },
50
- { id: '3', type: 'profiles', attributes: { name: 'Name 3', description: 'Description 3' } },
51
- { id: '4', type: 'profiles', attributes: { name: 'Name 4', description: 'Description 4' } },
52
- { id: '5', type: 'profiles', attributes: { name: 'Name 5', description: 'Description 5' } }
53
- ]
54
- }
55
- end
56
-
57
- def links
58
- {
59
- links: {
60
- self: "#{URI}?page%5Bnumber%5D=2&page%5Bsize%5D=2",
61
- first: "#{URI}?page%5Bnumber%5D=1&page%5Bsize%5D=2",
62
- prev: "#{URI}?page%5Bnumber%5D=1&page%5Bsize%5D=2",
63
- next: "#{URI}?page%5Bnumber%5D=3&page%5Bsize%5D=2",
64
- last: "#{URI}?page%5Bnumber%5D=3&page%5Bsize%5D=2"
65
- }
66
- }
67
- end
68
-
69
- def last_page_links
70
- {
71
- links: {
72
- self: "#{URI}?page%5Bnumber%5D=3&page%5Bsize%5D=2",
73
- first: "#{URI}?page%5Bnumber%5D=1&page%5Bsize%5D=2",
74
- prev: "#{URI}?page%5Bnumber%5D=2&page%5Bsize%5D=2"
75
- }
76
- }
77
- end
78
-
79
- def expected_response_when_unpaginatable
80
- data
81
- end
82
-
83
- def expected_response_with_pagination_links
84
- {}.tap do |hash|
85
- hash[:data] = data.values.flatten[2..3]
86
- hash.merge! links
87
- end
88
- end
89
-
90
- def expected_response_without_pagination_links
91
- {}.tap do |hash|
92
- hash[:data] = data.values.flatten[2..3]
93
- end
94
- end
95
-
96
- def expected_response_with_pagination_links_and_additional_params
97
- new_links = links[:links].each_with_object({}) { |(key, value), hash| hash[key] = "#{value}&test=test" }
98
- {}.tap do |hash|
99
- hash[:data] = data.values.flatten[2..3]
100
- hash.merge! links: new_links
101
- end
102
- end
103
-
104
- def expected_response_with_last_page_pagination_links
105
- {}.tap do |hash|
106
- hash[:data] = [data.values.flatten.last]
107
- hash.merge! last_page_links
108
- end
109
- end
110
-
111
- def expected_response_with_no_data_pagination_links
112
- {}.tap do |hash|
113
- hash[:data] = []
114
- hash[:links] = {}
115
- end
116
- end
117
-
118
- def test_pagination_links_using_kaminari
119
- adapter = load_adapter(using_kaminari, mock_request)
120
-
121
- assert_equal expected_response_with_pagination_links, adapter.serializable_hash
122
- end
123
-
124
- def test_pagination_links_using_will_paginate
125
- adapter = load_adapter(using_will_paginate, mock_request)
126
-
127
- assert_equal expected_response_with_pagination_links, adapter.serializable_hash
128
- end
129
-
130
- def test_pagination_links_with_additional_params
131
- adapter = load_adapter(using_will_paginate, mock_request(test: 'test'))
132
-
133
- assert_equal expected_response_with_pagination_links_and_additional_params,
134
- adapter.serializable_hash
135
- end
136
-
137
- def test_pagination_links_when_zero_results_kaminari
138
- @array = []
139
-
140
- adapter = load_adapter(using_kaminari(1), mock_request)
141
-
142
- assert_equal expected_response_with_no_data_pagination_links, adapter.serializable_hash
143
- end
144
-
145
- def test_pagination_links_when_zero_results_will_paginate
146
- @array = []
147
-
148
- adapter = load_adapter(using_will_paginate(1), mock_request)
149
-
150
- assert_equal expected_response_with_no_data_pagination_links, adapter.serializable_hash
151
- end
152
-
153
- def test_last_page_pagination_links_using_kaminari
154
- adapter = load_adapter(using_kaminari(3), mock_request)
155
-
156
- assert_equal expected_response_with_last_page_pagination_links, adapter.serializable_hash
157
- end
158
-
159
- def test_last_page_pagination_links_using_will_paginate
160
- adapter = load_adapter(using_will_paginate(3), mock_request)
161
-
162
- assert_equal expected_response_with_last_page_pagination_links, adapter.serializable_hash
163
- end
164
-
165
- def test_not_showing_pagination_links
166
- adapter = load_adapter(@array, mock_request)
167
-
168
- assert_equal expected_response_when_unpaginatable, adapter.serializable_hash
169
- end
170
-
171
- def test_raises_descriptive_error_when_serialization_context_unset
172
- render_options = { adapter: :json_api }
173
- adapter = serializable(using_kaminari, render_options)
174
- exception = assert_raises do
175
- adapter.as_json
176
- end
177
- exception_class = ActiveModelSerializers::Adapter::JsonApi::PaginationLinks::MissingSerializationContextError
178
- assert_equal exception_class, exception.class
179
- assert_match(/CollectionSerializer#paginated\?/, exception.message)
180
- end
181
-
182
- def test_pagination_links_not_present_when_disabled
183
- ActiveModel::Serializer.config.jsonapi_pagination_links_enabled = false
184
- adapter = load_adapter(using_kaminari, mock_request)
185
-
186
- assert_equal expected_response_without_pagination_links, adapter.serializable_hash
187
- ensure
188
- ActiveModel::Serializer.config.jsonapi_pagination_links_enabled = true
189
- end
190
- end
191
- end
192
- end
193
- end
@@ -1,137 +0,0 @@
1
- require 'test_helper'
2
- module ActiveModelSerializers
3
- module Adapter
4
- class JsonApi
5
- module Deserialization
6
- class ParseTest < Minitest::Test
7
- def setup
8
- @hash = {
9
- 'data' => {
10
- 'type' => 'photos',
11
- 'id' => 'zorglub',
12
- 'attributes' => {
13
- 'title' => 'Ember Hamster',
14
- 'src' => 'http://example.com/images/productivity.png'
15
- },
16
- 'relationships' => {
17
- 'author' => {
18
- 'data' => nil
19
- },
20
- 'photographer' => {
21
- 'data' => { 'type' => 'people', 'id' => '9' }
22
- },
23
- 'comments' => {
24
- 'data' => [
25
- { 'type' => 'comments', 'id' => '1' },
26
- { 'type' => 'comments', 'id' => '2' }
27
- ]
28
- }
29
- }
30
- }
31
- }
32
- @params = ActionController::Parameters.new(@hash)
33
- @expected = {
34
- id: 'zorglub',
35
- title: 'Ember Hamster',
36
- src: 'http://example.com/images/productivity.png',
37
- author_id: nil,
38
- photographer_id: '9',
39
- comment_ids: %w(1 2)
40
- }
41
-
42
- @illformed_payloads = [nil,
43
- {},
44
- {
45
- 'data' => nil
46
- }, {
47
- 'data' => { 'attributes' => [] }
48
- }, {
49
- 'data' => { 'relationships' => [] }
50
- }, {
51
- 'data' => {
52
- 'relationships' => { 'rel' => nil }
53
- }
54
- }, {
55
- 'data' => {
56
- 'relationships' => { 'rel' => {} }
57
- }
58
- }]
59
- end
60
-
61
- def test_hash
62
- parsed_hash = ActiveModelSerializers::Adapter::JsonApi::Deserialization.parse!(@hash)
63
- assert_equal(@expected, parsed_hash)
64
- end
65
-
66
- def test_actioncontroller_parameters
67
- assert_equal(false, @params.permitted?)
68
- parsed_hash = ActiveModelSerializers::Adapter::JsonApi::Deserialization.parse!(@params)
69
- assert_equal(@expected, parsed_hash)
70
- end
71
-
72
- def test_illformed_payloads_safe
73
- @illformed_payloads.each do |p|
74
- parsed_hash = ActiveModelSerializers::Adapter::JsonApi::Deserialization.parse(p)
75
- assert_equal({}, parsed_hash)
76
- end
77
- end
78
-
79
- def test_illformed_payloads_unsafe
80
- @illformed_payloads.each do |p|
81
- assert_raises(InvalidDocument) do
82
- ActiveModelSerializers::Adapter::JsonApi::Deserialization.parse!(p)
83
- end
84
- end
85
- end
86
-
87
- def test_filter_fields_only
88
- parsed_hash = ActiveModelSerializers::Adapter::JsonApi::Deserialization.parse!(@hash, only: [:id, :title, :author])
89
- expected = {
90
- id: 'zorglub',
91
- title: 'Ember Hamster',
92
- author_id: nil
93
- }
94
- assert_equal(expected, parsed_hash)
95
- end
96
-
97
- def test_filter_fields_except
98
- parsed_hash = ActiveModelSerializers::Adapter::JsonApi::Deserialization.parse!(@hash, except: [:id, :title, :author])
99
- expected = {
100
- src: 'http://example.com/images/productivity.png',
101
- photographer_id: '9',
102
- comment_ids: %w(1 2)
103
- }
104
- assert_equal(expected, parsed_hash)
105
- end
106
-
107
- def test_keys
108
- parsed_hash = ActiveModelSerializers::Adapter::JsonApi::Deserialization.parse!(@hash, keys: { author: :user, title: :post_title })
109
- expected = {
110
- id: 'zorglub',
111
- post_title: 'Ember Hamster',
112
- src: 'http://example.com/images/productivity.png',
113
- user_id: nil,
114
- photographer_id: '9',
115
- comment_ids: %w(1 2)
116
- }
117
- assert_equal(expected, parsed_hash)
118
- end
119
-
120
- def test_polymorphic
121
- parsed_hash = ActiveModelSerializers::Adapter::JsonApi::Deserialization.parse!(@hash, polymorphic: [:photographer])
122
- expected = {
123
- id: 'zorglub',
124
- title: 'Ember Hamster',
125
- src: 'http://example.com/images/productivity.png',
126
- author_id: nil,
127
- photographer_id: '9',
128
- photographer_type: 'people',
129
- comment_ids: %w(1 2)
130
- }
131
- assert_equal(expected, parsed_hash)
132
- end
133
- end
134
- end
135
- end
136
- end
137
- end