agi_active_model_serializers 0.10.7
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.github/ISSUE_TEMPLATE.md +29 -0
- data/.github/PULL_REQUEST_TEMPLATE.md +15 -0
- data/.gitignore +35 -0
- data/.rubocop.yml +102 -0
- data/.simplecov +110 -0
- data/.travis.yml +51 -0
- data/CHANGELOG.md +612 -0
- data/CODE_OF_CONDUCT.md +74 -0
- data/CONTRIBUTING.md +105 -0
- data/Gemfile +56 -0
- data/MIT-LICENSE +22 -0
- data/README.md +307 -0
- data/Rakefile +103 -0
- data/active_model_serializers.gemspec +63 -0
- data/appveyor.yml +24 -0
- data/bin/bench +171 -0
- data/bin/bench_regression +316 -0
- data/bin/serve_benchmark +39 -0
- data/docs/README.md +41 -0
- data/docs/STYLE.md +58 -0
- data/docs/general/adapters.md +247 -0
- data/docs/general/caching.md +58 -0
- data/docs/general/configuration_options.md +169 -0
- data/docs/general/deserialization.md +100 -0
- data/docs/general/fields.md +31 -0
- data/docs/general/getting_started.md +133 -0
- data/docs/general/instrumentation.md +40 -0
- data/docs/general/key_transforms.md +40 -0
- data/docs/general/logging.md +14 -0
- data/docs/general/rendering.md +279 -0
- data/docs/general/serializers.md +461 -0
- data/docs/how-open-source-maintained.jpg +0 -0
- data/docs/howto/add_pagination_links.md +138 -0
- data/docs/howto/add_relationship_links.md +137 -0
- data/docs/howto/add_root_key.md +55 -0
- data/docs/howto/grape_integration.md +42 -0
- data/docs/howto/outside_controller_use.md +65 -0
- data/docs/howto/passing_arbitrary_options.md +27 -0
- data/docs/howto/serialize_poro.md +32 -0
- data/docs/howto/test.md +154 -0
- data/docs/howto/upgrade_from_0_8_to_0_10.md +265 -0
- data/docs/integrations/ember-and-json-api.md +144 -0
- data/docs/integrations/grape.md +19 -0
- data/docs/jsonapi/errors.md +56 -0
- data/docs/jsonapi/schema.md +151 -0
- data/docs/jsonapi/schema/schema.json +366 -0
- data/docs/rfcs/0000-namespace.md +106 -0
- data/docs/rfcs/template.md +15 -0
- data/lib/action_controller/serialization.rb +66 -0
- data/lib/active_model/serializable_resource.rb +11 -0
- data/lib/active_model/serializer.rb +231 -0
- data/lib/active_model/serializer/adapter.rb +24 -0
- data/lib/active_model/serializer/adapter/attributes.rb +15 -0
- data/lib/active_model/serializer/adapter/base.rb +18 -0
- data/lib/active_model/serializer/adapter/json.rb +15 -0
- data/lib/active_model/serializer/adapter/json_api.rb +15 -0
- data/lib/active_model/serializer/adapter/null.rb +15 -0
- data/lib/active_model/serializer/array_serializer.rb +12 -0
- data/lib/active_model/serializer/association.rb +34 -0
- data/lib/active_model/serializer/attribute.rb +25 -0
- data/lib/active_model/serializer/belongs_to_reflection.rb +7 -0
- data/lib/active_model/serializer/collection_reflection.rb +7 -0
- data/lib/active_model/serializer/collection_serializer.rb +87 -0
- data/lib/active_model/serializer/concerns/associations.rb +102 -0
- data/lib/active_model/serializer/concerns/attributes.rb +82 -0
- data/lib/active_model/serializer/concerns/caching.rb +292 -0
- data/lib/active_model/serializer/concerns/configuration.rb +59 -0
- data/lib/active_model/serializer/concerns/links.rb +35 -0
- data/lib/active_model/serializer/concerns/meta.rb +29 -0
- data/lib/active_model/serializer/concerns/type.rb +25 -0
- data/lib/active_model/serializer/error_serializer.rb +14 -0
- data/lib/active_model/serializer/errors_serializer.rb +32 -0
- data/lib/active_model/serializer/field.rb +90 -0
- data/lib/active_model/serializer/fieldset.rb +31 -0
- data/lib/active_model/serializer/has_many_reflection.rb +7 -0
- data/lib/active_model/serializer/has_one_reflection.rb +7 -0
- data/lib/active_model/serializer/lint.rb +150 -0
- data/lib/active_model/serializer/null.rb +17 -0
- data/lib/active_model/serializer/reflection.rb +163 -0
- data/lib/active_model/serializer/singular_reflection.rb +7 -0
- data/lib/active_model/serializer/version.rb +5 -0
- data/lib/active_model_serializers.rb +53 -0
- data/lib/active_model_serializers/adapter.rb +98 -0
- data/lib/active_model_serializers/adapter/attributes.rb +13 -0
- data/lib/active_model_serializers/adapter/base.rb +83 -0
- data/lib/active_model_serializers/adapter/json.rb +21 -0
- data/lib/active_model_serializers/adapter/json_api.rb +517 -0
- data/lib/active_model_serializers/adapter/json_api/deserialization.rb +213 -0
- data/lib/active_model_serializers/adapter/json_api/error.rb +96 -0
- data/lib/active_model_serializers/adapter/json_api/jsonapi.rb +49 -0
- data/lib/active_model_serializers/adapter/json_api/link.rb +83 -0
- data/lib/active_model_serializers/adapter/json_api/meta.rb +37 -0
- data/lib/active_model_serializers/adapter/json_api/pagination_links.rb +69 -0
- data/lib/active_model_serializers/adapter/json_api/relationship.rb +63 -0
- data/lib/active_model_serializers/adapter/json_api/resource_identifier.rb +51 -0
- data/lib/active_model_serializers/adapter/null.rb +9 -0
- data/lib/active_model_serializers/callbacks.rb +55 -0
- data/lib/active_model_serializers/deprecate.rb +54 -0
- data/lib/active_model_serializers/deserialization.rb +15 -0
- data/lib/active_model_serializers/json_pointer.rb +14 -0
- data/lib/active_model_serializers/logging.rb +122 -0
- data/lib/active_model_serializers/lookup_chain.rb +80 -0
- data/lib/active_model_serializers/model.rb +71 -0
- data/lib/active_model_serializers/railtie.rb +48 -0
- data/lib/active_model_serializers/register_jsonapi_renderer.rb +78 -0
- data/lib/active_model_serializers/serializable_resource.rb +82 -0
- data/lib/active_model_serializers/serialization_context.rb +39 -0
- data/lib/active_model_serializers/test.rb +7 -0
- data/lib/active_model_serializers/test/schema.rb +138 -0
- data/lib/active_model_serializers/test/serializer.rb +125 -0
- data/lib/generators/rails/USAGE +6 -0
- data/lib/generators/rails/resource_override.rb +10 -0
- data/lib/generators/rails/serializer_generator.rb +36 -0
- data/lib/generators/rails/templates/serializer.rb.erb +15 -0
- data/lib/grape/active_model_serializers.rb +16 -0
- data/lib/grape/formatters/active_model_serializers.rb +32 -0
- data/lib/grape/helpers/active_model_serializers.rb +17 -0
- data/test/action_controller/adapter_selector_test.rb +53 -0
- data/test/action_controller/explicit_serializer_test.rb +135 -0
- data/test/action_controller/json/include_test.rb +246 -0
- data/test/action_controller/json_api/deserialization_test.rb +112 -0
- data/test/action_controller/json_api/errors_test.rb +40 -0
- data/test/action_controller/json_api/fields_test.rb +66 -0
- data/test/action_controller/json_api/linked_test.rb +202 -0
- data/test/action_controller/json_api/pagination_test.rb +116 -0
- data/test/action_controller/json_api/transform_test.rb +189 -0
- data/test/action_controller/lookup_proc_test.rb +49 -0
- data/test/action_controller/namespace_lookup_test.rb +232 -0
- data/test/action_controller/serialization_scope_name_test.rb +229 -0
- data/test/action_controller/serialization_test.rb +472 -0
- data/test/active_model_serializers/adapter_for_test.rb +208 -0
- data/test/active_model_serializers/json_pointer_test.rb +22 -0
- data/test/active_model_serializers/logging_test.rb +77 -0
- data/test/active_model_serializers/model_test.rb +69 -0
- data/test/active_model_serializers/railtie_test_isolated.rb +63 -0
- data/test/active_model_serializers/register_jsonapi_renderer_test_isolated.rb +161 -0
- data/test/active_model_serializers/serialization_context_test_isolated.rb +71 -0
- data/test/active_model_serializers/test/schema_test.rb +131 -0
- data/test/active_model_serializers/test/serializer_test.rb +62 -0
- data/test/active_record_test.rb +9 -0
- data/test/adapter/attributes_test.rb +43 -0
- data/test/adapter/deprecation_test.rb +100 -0
- data/test/adapter/json/belongs_to_test.rb +45 -0
- data/test/adapter/json/collection_test.rb +104 -0
- data/test/adapter/json/has_many_test.rb +45 -0
- data/test/adapter/json/transform_test.rb +93 -0
- data/test/adapter/json_api/belongs_to_test.rb +155 -0
- data/test/adapter/json_api/collection_test.rb +96 -0
- data/test/adapter/json_api/errors_test.rb +76 -0
- data/test/adapter/json_api/fields_test.rb +96 -0
- data/test/adapter/json_api/has_many_embed_ids_test.rb +43 -0
- data/test/adapter/json_api/has_many_explicit_serializer_test.rb +96 -0
- data/test/adapter/json_api/has_many_test.rb +165 -0
- data/test/adapter/json_api/has_one_test.rb +80 -0
- data/test/adapter/json_api/include_data_if_sideloaded_test.rb +168 -0
- data/test/adapter/json_api/json_api_test.rb +33 -0
- data/test/adapter/json_api/linked_test.rb +413 -0
- data/test/adapter/json_api/links_test.rb +95 -0
- data/test/adapter/json_api/pagination_links_test.rb +193 -0
- data/test/adapter/json_api/parse_test.rb +137 -0
- data/test/adapter/json_api/relationship_test.rb +397 -0
- data/test/adapter/json_api/resource_identifier_test.rb +110 -0
- data/test/adapter/json_api/resource_meta_test.rb +100 -0
- data/test/adapter/json_api/toplevel_jsonapi_test.rb +82 -0
- data/test/adapter/json_api/transform_test.rb +512 -0
- data/test/adapter/json_api/type_test.rb +61 -0
- data/test/adapter/json_test.rb +46 -0
- data/test/adapter/null_test.rb +22 -0
- data/test/adapter/polymorphic_test.rb +171 -0
- data/test/adapter_test.rb +67 -0
- data/test/array_serializer_test.rb +22 -0
- data/test/benchmark/app.rb +65 -0
- data/test/benchmark/benchmarking_support.rb +67 -0
- data/test/benchmark/bm_active_record.rb +81 -0
- data/test/benchmark/bm_adapter.rb +38 -0
- data/test/benchmark/bm_caching.rb +119 -0
- data/test/benchmark/bm_lookup_chain.rb +83 -0
- data/test/benchmark/bm_transform.rb +45 -0
- data/test/benchmark/config.ru +3 -0
- data/test/benchmark/controllers.rb +83 -0
- data/test/benchmark/fixtures.rb +219 -0
- data/test/cache_test.rb +595 -0
- data/test/collection_serializer_test.rb +123 -0
- data/test/fixtures/active_record.rb +113 -0
- data/test/fixtures/poro.rb +232 -0
- data/test/generators/scaffold_controller_generator_test.rb +24 -0
- data/test/generators/serializer_generator_test.rb +74 -0
- data/test/grape_test.rb +178 -0
- data/test/lint_test.rb +49 -0
- data/test/logger_test.rb +20 -0
- data/test/poro_test.rb +9 -0
- data/test/serializable_resource_test.rb +79 -0
- data/test/serializers/association_macros_test.rb +37 -0
- data/test/serializers/associations_test.rb +383 -0
- data/test/serializers/attribute_test.rb +153 -0
- data/test/serializers/attributes_test.rb +52 -0
- data/test/serializers/caching_configuration_test_isolated.rb +170 -0
- data/test/serializers/configuration_test.rb +32 -0
- data/test/serializers/fieldset_test.rb +14 -0
- data/test/serializers/meta_test.rb +202 -0
- data/test/serializers/options_test.rb +32 -0
- data/test/serializers/read_attribute_for_serialization_test.rb +79 -0
- data/test/serializers/root_test.rb +21 -0
- data/test/serializers/serialization_test.rb +55 -0
- data/test/serializers/serializer_for_test.rb +136 -0
- data/test/serializers/serializer_for_with_namespace_test.rb +88 -0
- data/test/support/custom_schemas/active_model_serializers/test/schema_test/my/index.json +6 -0
- data/test/support/isolated_unit.rb +82 -0
- data/test/support/rails5_shims.rb +53 -0
- data/test/support/rails_app.rb +36 -0
- data/test/support/schemas/active_model_serializers/test/schema_test/my/index.json +6 -0
- data/test/support/schemas/active_model_serializers/test/schema_test/my/show.json +6 -0
- data/test/support/schemas/custom/show.json +7 -0
- data/test/support/schemas/hyper_schema.json +93 -0
- data/test/support/schemas/render_using_json_api.json +43 -0
- data/test/support/schemas/simple_json_pointers.json +10 -0
- data/test/support/serialization_testing.rb +71 -0
- data/test/test_helper.rb +58 -0
- metadata +602 -0
@@ -0,0 +1,76 @@
|
|
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
|
+
source: { pointer: '/data/attributes/name' },
|
29
|
+
detail: 'cannot be nil'
|
30
|
+
}
|
31
|
+
]
|
32
|
+
}
|
33
|
+
assert_equal serializable_resource.as_json, expected_errors_object
|
34
|
+
end
|
35
|
+
|
36
|
+
def test_active_model_with_multiple_errors
|
37
|
+
options = {
|
38
|
+
serializer: ActiveModel::Serializer::ErrorSerializer,
|
39
|
+
adapter: :json_api
|
40
|
+
}
|
41
|
+
|
42
|
+
@resource.errors.add(:name, 'cannot be nil')
|
43
|
+
@resource.errors.add(:name, 'must be longer')
|
44
|
+
@resource.errors.add(:id, 'must be a uuid')
|
45
|
+
|
46
|
+
serializable_resource = ActiveModelSerializers::SerializableResource.new(@resource, options)
|
47
|
+
assert_equal serializable_resource.serializer_instance.attributes, {}
|
48
|
+
assert_equal serializable_resource.serializer_instance.object, @resource
|
49
|
+
|
50
|
+
expected_errors_object = {
|
51
|
+
errors: [
|
52
|
+
{ source: { pointer: '/data/attributes/name' }, detail: 'cannot be nil' },
|
53
|
+
{ source: { pointer: '/data/attributes/name' }, detail: 'must be longer' },
|
54
|
+
{ source: { pointer: '/data/attributes/id' }, detail: 'must be a uuid' }
|
55
|
+
]
|
56
|
+
}
|
57
|
+
assert_equal serializable_resource.as_json, expected_errors_object
|
58
|
+
end
|
59
|
+
|
60
|
+
# see http://jsonapi.org/examples/
|
61
|
+
def test_parameter_source_type_error
|
62
|
+
parameter = 'auther'
|
63
|
+
error_source = ActiveModelSerializers::Adapter::JsonApi::Error.error_source(:parameter, parameter)
|
64
|
+
assert_equal({ parameter: parameter }, error_source)
|
65
|
+
end
|
66
|
+
|
67
|
+
def test_unknown_source_type_error
|
68
|
+
value = 'auther'
|
69
|
+
assert_raises(ActiveModelSerializers::Adapter::JsonApi::Error::UnknownSourceTypeError) do
|
70
|
+
ActiveModelSerializers::Adapter::JsonApi::Error.error_source(:hyper, value)
|
71
|
+
end
|
72
|
+
end
|
73
|
+
end
|
74
|
+
end
|
75
|
+
end
|
76
|
+
end
|
@@ -0,0 +1,96 @@
|
|
1
|
+
require 'test_helper'
|
2
|
+
|
3
|
+
module ActiveModelSerializers
|
4
|
+
module Adapter
|
5
|
+
class JsonApi
|
6
|
+
class FieldsTest < ActiveSupport::TestCase
|
7
|
+
class Post < ::Model
|
8
|
+
attributes :title, :body
|
9
|
+
associations :author, :comments
|
10
|
+
end
|
11
|
+
class Author < ::Model
|
12
|
+
attributes :name, :birthday
|
13
|
+
end
|
14
|
+
class Comment < ::Model
|
15
|
+
attributes :body
|
16
|
+
associations :author, :post
|
17
|
+
end
|
18
|
+
|
19
|
+
class PostSerializer < ActiveModel::Serializer
|
20
|
+
type 'posts'
|
21
|
+
attributes :title, :body
|
22
|
+
belongs_to :author
|
23
|
+
has_many :comments
|
24
|
+
end
|
25
|
+
|
26
|
+
class AuthorSerializer < ActiveModel::Serializer
|
27
|
+
type 'authors'
|
28
|
+
attributes :name, :birthday
|
29
|
+
end
|
30
|
+
|
31
|
+
class CommentSerializer < ActiveModel::Serializer
|
32
|
+
type 'comments'
|
33
|
+
attributes :body
|
34
|
+
belongs_to :author
|
35
|
+
end
|
36
|
+
|
37
|
+
def setup
|
38
|
+
@author = Author.new(id: 1, name: 'Lucas', birthday: '10.01.1990')
|
39
|
+
@comment1 = Comment.new(id: 7, body: 'cool', author: @author)
|
40
|
+
@comment2 = Comment.new(id: 12, body: 'awesome', author: @author)
|
41
|
+
@post = Post.new(id: 1337, title: 'Title 1', body: 'Body 1',
|
42
|
+
author: @author, comments: [@comment1, @comment2])
|
43
|
+
@comment1.post = @post
|
44
|
+
@comment2.post = @post
|
45
|
+
end
|
46
|
+
|
47
|
+
def test_fields_attributes
|
48
|
+
fields = { posts: [:title] }
|
49
|
+
hash = serializable(@post, adapter: :json_api, fields: fields).serializable_hash
|
50
|
+
expected = {
|
51
|
+
title: 'Title 1'
|
52
|
+
}
|
53
|
+
|
54
|
+
assert_equal(expected, hash[:data][:attributes])
|
55
|
+
end
|
56
|
+
|
57
|
+
def test_fields_relationships
|
58
|
+
fields = { posts: [:author] }
|
59
|
+
hash = serializable(@post, adapter: :json_api, fields: fields).serializable_hash
|
60
|
+
expected = {
|
61
|
+
author: {
|
62
|
+
data: {
|
63
|
+
type: 'authors',
|
64
|
+
id: '1'
|
65
|
+
}
|
66
|
+
}
|
67
|
+
}
|
68
|
+
|
69
|
+
assert_equal(expected, hash[:data][:relationships])
|
70
|
+
end
|
71
|
+
|
72
|
+
def test_fields_included
|
73
|
+
fields = { posts: [:author], comments: [:body] }
|
74
|
+
hash = serializable(@post, adapter: :json_api, fields: fields, include: 'comments').serializable_hash
|
75
|
+
expected = [
|
76
|
+
{
|
77
|
+
type: 'comments',
|
78
|
+
id: '7',
|
79
|
+
attributes: {
|
80
|
+
body: 'cool'
|
81
|
+
}
|
82
|
+
}, {
|
83
|
+
type: 'comments',
|
84
|
+
id: '12',
|
85
|
+
attributes: {
|
86
|
+
body: 'awesome'
|
87
|
+
}
|
88
|
+
}
|
89
|
+
]
|
90
|
+
|
91
|
+
assert_equal(expected, hash[:included])
|
92
|
+
end
|
93
|
+
end
|
94
|
+
end
|
95
|
+
end
|
96
|
+
end
|
@@ -0,0 +1,43 @@
|
|
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
|
@@ -0,0 +1,96 @@
|
|
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
|
@@ -0,0 +1,165 @@
|
|
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
|
+
test 'relationships can be whitelisted via fields' do
|
44
|
+
@adapter = ActiveModelSerializers::Adapter::JsonApi.new(@serializer, fields: { posts: [:author] })
|
45
|
+
result = @adapter.serializable_hash
|
46
|
+
expected = {
|
47
|
+
data: {
|
48
|
+
id: '1',
|
49
|
+
type: 'posts',
|
50
|
+
relationships: {
|
51
|
+
author: {
|
52
|
+
data: {
|
53
|
+
id: '1',
|
54
|
+
type: 'authors'
|
55
|
+
}
|
56
|
+
}
|
57
|
+
}
|
58
|
+
}
|
59
|
+
}
|
60
|
+
|
61
|
+
assert_equal expected, result
|
62
|
+
end
|
63
|
+
|
64
|
+
def test_includes_linked_comments
|
65
|
+
@adapter = ActiveModelSerializers::Adapter::JsonApi.new(@serializer, include: [:comments])
|
66
|
+
expected = [{
|
67
|
+
id: '1',
|
68
|
+
type: 'comments',
|
69
|
+
attributes: {
|
70
|
+
body: 'ZOMG A COMMENT'
|
71
|
+
},
|
72
|
+
relationships: {
|
73
|
+
post: { data: { type: 'posts', id: '1' } },
|
74
|
+
author: { data: nil }
|
75
|
+
}
|
76
|
+
}, {
|
77
|
+
id: '2',
|
78
|
+
type: 'comments',
|
79
|
+
attributes: {
|
80
|
+
body: 'ZOMG ANOTHER COMMENT'
|
81
|
+
},
|
82
|
+
relationships: {
|
83
|
+
post: { data: { type: 'posts', id: '1' } },
|
84
|
+
author: { data: nil }
|
85
|
+
}
|
86
|
+
}]
|
87
|
+
assert_equal expected, @adapter.serializable_hash[:included]
|
88
|
+
end
|
89
|
+
|
90
|
+
def test_limit_fields_of_linked_comments
|
91
|
+
@adapter = ActiveModelSerializers::Adapter::JsonApi.new(@serializer, include: [:comments], fields: { comment: [:id, :post, :author] })
|
92
|
+
expected = [{
|
93
|
+
id: '1',
|
94
|
+
type: 'comments',
|
95
|
+
relationships: {
|
96
|
+
post: { data: { type: 'posts', id: '1' } },
|
97
|
+
author: { data: nil }
|
98
|
+
}
|
99
|
+
}, {
|
100
|
+
id: '2',
|
101
|
+
type: 'comments',
|
102
|
+
relationships: {
|
103
|
+
post: { data: { type: 'posts', id: '1' } },
|
104
|
+
author: { data: nil }
|
105
|
+
}
|
106
|
+
}]
|
107
|
+
assert_equal expected, @adapter.serializable_hash[:included]
|
108
|
+
end
|
109
|
+
|
110
|
+
def test_no_include_linked_if_comments_is_empty
|
111
|
+
serializer = PostSerializer.new(@post_without_comments)
|
112
|
+
adapter = ActiveModelSerializers::Adapter::JsonApi.new(serializer)
|
113
|
+
|
114
|
+
assert_nil adapter.serializable_hash[:linked]
|
115
|
+
end
|
116
|
+
|
117
|
+
def test_include_type_for_association_when_different_than_name
|
118
|
+
serializer = BlogSerializer.new(@blog)
|
119
|
+
adapter = ActiveModelSerializers::Adapter::JsonApi.new(serializer)
|
120
|
+
actual = adapter.serializable_hash[:data][:relationships][:articles]
|
121
|
+
|
122
|
+
expected = {
|
123
|
+
data: [{
|
124
|
+
type: 'posts',
|
125
|
+
id: '1'
|
126
|
+
}]
|
127
|
+
}
|
128
|
+
assert_equal expected, actual
|
129
|
+
end
|
130
|
+
|
131
|
+
def test_has_many_with_no_serializer
|
132
|
+
serializer = PostWithTagsSerializer.new(@post)
|
133
|
+
adapter = ActiveModelSerializers::Adapter::JsonApi.new(serializer)
|
134
|
+
|
135
|
+
assert_equal({
|
136
|
+
data: {
|
137
|
+
id: '1',
|
138
|
+
type: 'posts',
|
139
|
+
relationships: {
|
140
|
+
tags: { data: [@tag.as_json] }
|
141
|
+
}
|
142
|
+
}
|
143
|
+
}, adapter.serializable_hash)
|
144
|
+
end
|
145
|
+
|
146
|
+
def test_has_many_with_virtual_value
|
147
|
+
serializer = VirtualValueSerializer.new(@virtual_value)
|
148
|
+
adapter = ActiveModelSerializers::Adapter::JsonApi.new(serializer)
|
149
|
+
|
150
|
+
assert_equal({
|
151
|
+
data: {
|
152
|
+
id: '1',
|
153
|
+
type: 'virtual-values',
|
154
|
+
relationships: {
|
155
|
+
maker: { data: { type: 'makers', id: '1' } },
|
156
|
+
reviews: { data: [{ type: 'reviews', id: '1' },
|
157
|
+
{ type: 'reviews', id: '2' }] }
|
158
|
+
}
|
159
|
+
}
|
160
|
+
}, adapter.serializable_hash)
|
161
|
+
end
|
162
|
+
end
|
163
|
+
end
|
164
|
+
end
|
165
|
+
end
|