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,85 +0,0 @@
1
- require 'test_helper'
2
-
3
- module ActiveModelSerializers
4
- module Adapter
5
- class JsonApi
6
- class ResourceIdentifierTest < ActiveSupport::TestCase
7
- class WithDefinedTypeSerializer < ActiveModel::Serializer
8
- type 'with_defined_type'
9
- end
10
-
11
- class WithDefinedIdSerializer < ActiveModel::Serializer
12
- def id
13
- 'special_id'
14
- end
15
- end
16
-
17
- class FragmentedSerializer < ActiveModel::Serializer; end
18
-
19
- setup do
20
- @model = Author.new(id: 1, name: 'Steve K.')
21
- ActionController::Base.cache_store.clear
22
- end
23
-
24
- def test_defined_type
25
- test_type(WithDefinedTypeSerializer, 'with-defined-type')
26
- end
27
-
28
- def test_singular_type
29
- test_type_inflection(AuthorSerializer, 'author', :singular)
30
- end
31
-
32
- def test_plural_type
33
- test_type_inflection(AuthorSerializer, 'authors', :plural)
34
- end
35
-
36
- def test_id_defined_on_object
37
- test_id(AuthorSerializer, @model.id.to_s)
38
- end
39
-
40
- def test_id_defined_on_serializer
41
- test_id(WithDefinedIdSerializer, 'special_id')
42
- end
43
-
44
- def test_id_defined_on_fragmented
45
- FragmentedSerializer.fragmented(WithDefinedIdSerializer.new(@model))
46
- test_id(FragmentedSerializer, 'special_id')
47
- end
48
-
49
- private
50
-
51
- def test_type_inflection(serializer_class, expected_type, inflection)
52
- original_inflection = ActiveModelSerializers.config.jsonapi_resource_type
53
- ActiveModelSerializers.config.jsonapi_resource_type = inflection
54
- test_type(serializer_class, expected_type)
55
- ensure
56
- ActiveModelSerializers.config.jsonapi_resource_type = original_inflection
57
- end
58
-
59
- def test_type(serializer_class, expected_type)
60
- serializer = serializer_class.new(@model)
61
- resource_identifier = ResourceIdentifier.new(serializer, nil)
62
- expected = {
63
- id: @model.id.to_s,
64
- type: expected_type
65
- }
66
-
67
- assert_equal(expected, resource_identifier.as_json)
68
- end
69
-
70
- def test_id(serializer_class, id)
71
- serializer = serializer_class.new(@model)
72
- resource_identifier = ResourceIdentifier.new(serializer, nil)
73
- inflection = ActiveModelSerializers.config.jsonapi_resource_type
74
- type = @model.class.model_name.send(inflection)
75
- expected = {
76
- id: id,
77
- type: type
78
- }
79
-
80
- assert_equal(expected, resource_identifier.as_json)
81
- end
82
- end
83
- end
84
- end
85
- end
@@ -1,100 +0,0 @@
1
- require 'test_helper'
2
-
3
- module ActiveModel
4
- class Serializer
5
- module Adapter
6
- class JsonApi
7
- class ResourceMetaTest < Minitest::Test
8
- class MetaHashPostSerializer < ActiveModel::Serializer
9
- attributes :id
10
- meta stuff: 'value'
11
- end
12
-
13
- class MetaBlockPostSerializer < ActiveModel::Serializer
14
- attributes :id
15
- meta do
16
- { comments_count: object.comments.count }
17
- end
18
- end
19
-
20
- class MetaBlockPostBlankMetaSerializer < ActiveModel::Serializer
21
- attributes :id
22
- meta do
23
- {}
24
- end
25
- end
26
-
27
- class MetaBlockPostEmptyStringSerializer < ActiveModel::Serializer
28
- attributes :id
29
- meta do
30
- ''
31
- end
32
- end
33
-
34
- def setup
35
- @post = Post.new(id: 1337, comments: [], author: nil)
36
- end
37
-
38
- def test_meta_hash_object_resource
39
- hash = ActiveModelSerializers::SerializableResource.new(
40
- @post,
41
- serializer: MetaHashPostSerializer,
42
- adapter: :json_api
43
- ).serializable_hash
44
- expected = {
45
- stuff: 'value'
46
- }
47
- assert_equal(expected, hash[:data][:meta])
48
- end
49
-
50
- def test_meta_block_object_resource
51
- hash = ActiveModelSerializers::SerializableResource.new(
52
- @post,
53
- serializer: MetaBlockPostSerializer,
54
- adapter: :json_api
55
- ).serializable_hash
56
- expected = {
57
- :"comments-count" => @post.comments.count
58
- }
59
- assert_equal(expected, hash[:data][:meta])
60
- end
61
-
62
- def test_meta_object_resource_in_array
63
- post2 = Post.new(id: 1339, comments: [Comment.new])
64
- posts = [@post, post2]
65
- hash = ActiveModelSerializers::SerializableResource.new(
66
- posts,
67
- each_serializer: MetaBlockPostSerializer,
68
- adapter: :json_api
69
- ).serializable_hash
70
- expected = {
71
- :data => [
72
- { :id => '1337', :type => 'posts', :meta => { :"comments-count" => 0 } },
73
- { :id => '1339', :type => 'posts', :meta => { :"comments-count" => 1 } }
74
- ]
75
- }
76
- assert_equal(expected, hash)
77
- end
78
-
79
- def test_meta_object_blank_omitted
80
- hash = ActiveModelSerializers::SerializableResource.new(
81
- @post,
82
- serializer: MetaBlockPostBlankMetaSerializer,
83
- adapter: :json_api
84
- ).serializable_hash
85
- refute hash[:data].key? :meta
86
- end
87
-
88
- def test_meta_object_empty_string_omitted
89
- hash = ActiveModelSerializers::SerializableResource.new(
90
- @post,
91
- serializer: MetaBlockPostEmptyStringSerializer,
92
- adapter: :json_api
93
- ).serializable_hash
94
- refute hash[:data].key? :meta
95
- end
96
- end
97
- end
98
- end
99
- end
100
- end
@@ -1,82 +0,0 @@
1
- require 'test_helper'
2
-
3
- module ActiveModelSerializers
4
- module Adapter
5
- class JsonApi
6
- class TopLevelJsonApiTest < 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
- end
28
-
29
- def test_toplevel_jsonapi_defaults_to_false
30
- assert_equal config.fetch(:jsonapi_include_toplevel_object), false
31
- end
32
-
33
- def test_disable_toplevel_jsonapi
34
- with_config(jsonapi_include_toplevel_object: false) do
35
- hash = serialize(@post)
36
- assert_nil(hash[:jsonapi])
37
- end
38
- end
39
-
40
- def test_enable_toplevel_jsonapi
41
- with_config(jsonapi_include_toplevel_object: true) do
42
- hash = serialize(@post)
43
- refute_nil(hash[:jsonapi])
44
- end
45
- end
46
-
47
- def test_default_toplevel_jsonapi_version
48
- with_config(jsonapi_include_toplevel_object: true) do
49
- hash = serialize(@post)
50
- assert_equal('1.0', hash[:jsonapi][:version])
51
- end
52
- end
53
-
54
- def test_toplevel_jsonapi_no_meta
55
- with_config(jsonapi_include_toplevel_object: true) do
56
- hash = serialize(@post)
57
- assert_nil(hash[:jsonapi][:meta])
58
- end
59
- end
60
-
61
- def test_toplevel_jsonapi_meta
62
- new_config = {
63
- jsonapi_include_toplevel_object: true,
64
- jsonapi_toplevel_meta: {
65
- 'copyright' => 'Copyright 2015 Example Corp.'
66
- }
67
- }
68
- with_config(new_config) do
69
- hash = serialize(@post)
70
- assert_equal(new_config[:jsonapi_toplevel_meta], hash.fetch(:jsonapi).fetch(:meta))
71
- end
72
- end
73
-
74
- private
75
-
76
- def serialize(resource, options = {})
77
- serializable(resource, { adapter: :json_api }.merge!(options)).serializable_hash
78
- end
79
- end
80
- end
81
- end
82
- end