active_model_serializers 0.9.0 → 0.10.12
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +5 -5
- data/CHANGELOG.md +679 -9
- data/MIT-LICENSE +3 -2
- data/README.md +195 -753
- data/lib/action_controller/serialization.rb +45 -49
- data/lib/active_model/serializable_resource.rb +13 -0
- data/lib/active_model/serializer.rb +369 -212
- data/lib/active_model/serializer/adapter.rb +26 -0
- data/lib/active_model/serializer/adapter/attributes.rb +17 -0
- data/lib/active_model/serializer/adapter/base.rb +20 -0
- data/lib/active_model/serializer/adapter/json.rb +17 -0
- data/lib/active_model/serializer/adapter/json_api.rb +17 -0
- data/lib/active_model/serializer/adapter/null.rb +17 -0
- data/lib/active_model/serializer/array_serializer.rb +14 -0
- data/lib/active_model/serializer/association.rb +73 -0
- data/lib/active_model/serializer/attribute.rb +27 -0
- data/lib/active_model/serializer/belongs_to_reflection.rb +13 -0
- data/lib/active_model/serializer/collection_serializer.rb +90 -0
- data/lib/active_model/serializer/concerns/caching.rb +305 -0
- data/lib/active_model/serializer/error_serializer.rb +16 -0
- data/lib/active_model/serializer/errors_serializer.rb +34 -0
- data/lib/active_model/serializer/field.rb +92 -0
- data/lib/active_model/serializer/fieldset.rb +33 -0
- data/lib/active_model/serializer/has_many_reflection.rb +12 -0
- data/lib/active_model/serializer/has_one_reflection.rb +9 -0
- data/lib/active_model/serializer/lazy_association.rb +99 -0
- data/lib/active_model/serializer/link.rb +23 -0
- data/lib/active_model/serializer/lint.rb +152 -0
- data/lib/active_model/serializer/null.rb +19 -0
- data/lib/active_model/serializer/reflection.rb +212 -0
- data/lib/active_model/serializer/version.rb +3 -1
- data/lib/active_model_serializers.rb +60 -17
- data/lib/active_model_serializers/adapter.rb +100 -0
- data/lib/active_model_serializers/adapter/attributes.rb +36 -0
- data/lib/active_model_serializers/adapter/base.rb +85 -0
- data/lib/active_model_serializers/adapter/json.rb +23 -0
- data/lib/active_model_serializers/adapter/json_api.rb +535 -0
- data/lib/active_model_serializers/adapter/json_api/deserialization.rb +215 -0
- data/lib/active_model_serializers/adapter/json_api/error.rb +98 -0
- data/lib/active_model_serializers/adapter/json_api/jsonapi.rb +51 -0
- data/lib/active_model_serializers/adapter/json_api/link.rb +85 -0
- data/lib/active_model_serializers/adapter/json_api/meta.rb +39 -0
- data/lib/active_model_serializers/adapter/json_api/pagination_links.rb +90 -0
- data/lib/active_model_serializers/adapter/json_api/relationship.rb +106 -0
- data/lib/active_model_serializers/adapter/json_api/resource_identifier.rb +68 -0
- data/lib/active_model_serializers/adapter/null.rb +11 -0
- data/lib/active_model_serializers/callbacks.rb +57 -0
- data/lib/active_model_serializers/deprecate.rb +56 -0
- data/lib/active_model_serializers/deserialization.rb +17 -0
- data/lib/active_model_serializers/json_pointer.rb +16 -0
- data/lib/active_model_serializers/logging.rb +124 -0
- data/lib/active_model_serializers/lookup_chain.rb +82 -0
- data/lib/active_model_serializers/model.rb +132 -0
- data/lib/active_model_serializers/model/caching.rb +25 -0
- data/lib/active_model_serializers/railtie.rb +52 -0
- data/lib/active_model_serializers/register_jsonapi_renderer.rb +80 -0
- data/lib/active_model_serializers/serializable_resource.rb +84 -0
- data/lib/active_model_serializers/serialization_context.rb +41 -0
- data/lib/active_model_serializers/test.rb +9 -0
- data/lib/active_model_serializers/test/schema.rb +140 -0
- data/lib/active_model_serializers/test/serializer.rb +127 -0
- data/lib/generators/rails/USAGE +6 -0
- data/lib/{active_model/serializer/generators → generators/rails}/resource_override.rb +3 -4
- data/lib/{active_model/serializer/generators/serializer → generators/rails}/serializer_generator.rb +6 -5
- data/lib/{active_model/serializer/generators/serializer/templates/serializer.rb → generators/rails/templates/serializer.rb.erb} +0 -0
- data/lib/grape/active_model_serializers.rb +18 -0
- data/lib/grape/formatters/active_model_serializers.rb +34 -0
- data/lib/grape/helpers/active_model_serializers.rb +19 -0
- data/lib/tasks/rubocop.rake +55 -0
- metadata +315 -99
- data/CONTRIBUTING.md +0 -20
- data/DESIGN.textile +0 -586
- data/lib/action_controller/serialization_test_case.rb +0 -79
- data/lib/active_model/array_serializer.rb +0 -65
- data/lib/active_model/default_serializer.rb +0 -32
- data/lib/active_model/serializable.rb +0 -40
- data/lib/active_model/serializer/associations.rb +0 -102
- data/lib/active_model/serializer/config.rb +0 -31
- data/lib/active_model/serializer/generators/serializer/USAGE +0 -9
- data/lib/active_model/serializer/generators/serializer/scaffold_controller_generator.rb +0 -14
- data/lib/active_model/serializer/generators/serializer/templates/controller.rb +0 -93
- data/lib/active_model/serializer/railtie.rb +0 -10
- data/lib/active_model/serializer_support.rb +0 -5
- data/test/fixtures/active_record.rb +0 -92
- data/test/fixtures/poro.rb +0 -75
- data/test/integration/action_controller/serialization_test.rb +0 -287
- data/test/integration/action_controller/serialization_test_case_test.rb +0 -61
- data/test/integration/active_record/active_record_test.rb +0 -77
- data/test/integration/generators/resource_generator_test.rb +0 -26
- data/test/integration/generators/scaffold_controller_generator_test.rb +0 -64
- data/test/integration/generators/serializer_generator_test.rb +0 -41
- data/test/test_app.rb +0 -11
- data/test/test_helper.rb +0 -24
- data/test/unit/active_model/array_serializer/except_test.rb +0 -18
- data/test/unit/active_model/array_serializer/key_format_test.rb +0 -18
- data/test/unit/active_model/array_serializer/meta_test.rb +0 -53
- data/test/unit/active_model/array_serializer/only_test.rb +0 -18
- data/test/unit/active_model/array_serializer/root_test.rb +0 -102
- data/test/unit/active_model/array_serializer/scope_test.rb +0 -24
- data/test/unit/active_model/array_serializer/serialization_test.rb +0 -199
- data/test/unit/active_model/default_serializer_test.rb +0 -13
- data/test/unit/active_model/serializer/associations/build_serializer_test.rb +0 -21
- data/test/unit/active_model/serializer/associations_test.rb +0 -19
- data/test/unit/active_model/serializer/attributes_test.rb +0 -41
- data/test/unit/active_model/serializer/config_test.rb +0 -88
- data/test/unit/active_model/serializer/filter_test.rb +0 -69
- data/test/unit/active_model/serializer/has_many_test.rb +0 -230
- data/test/unit/active_model/serializer/has_one_test.rb +0 -207
- data/test/unit/active_model/serializer/key_format_test.rb +0 -25
- data/test/unit/active_model/serializer/meta_test.rb +0 -39
- data/test/unit/active_model/serializer/options_test.rb +0 -15
- data/test/unit/active_model/serializer/root_test.rb +0 -117
- data/test/unit/active_model/serializer/scope_test.rb +0 -49
@@ -1,39 +0,0 @@
|
|
1
|
-
require 'test_helper'
|
2
|
-
|
3
|
-
module ActiveModel
|
4
|
-
class Serializer
|
5
|
-
class MetaTest < Minitest::Test
|
6
|
-
def setup
|
7
|
-
@profile = Profile.new({ name: 'Name 1', description: 'Description 1', comments: 'Comments 1' })
|
8
|
-
end
|
9
|
-
|
10
|
-
def test_meta
|
11
|
-
profile_serializer = ProfileSerializer.new(@profile, root: 'profile', meta: { total: 10 })
|
12
|
-
|
13
|
-
assert_equal({
|
14
|
-
'profile' => {
|
15
|
-
name: 'Name 1',
|
16
|
-
description: 'Description 1'
|
17
|
-
},
|
18
|
-
meta: {
|
19
|
-
total: 10
|
20
|
-
}
|
21
|
-
}, profile_serializer.as_json)
|
22
|
-
end
|
23
|
-
|
24
|
-
def test_meta_using_meta_key
|
25
|
-
profile_serializer = ProfileSerializer.new(@profile, root: 'profile', meta_key: :my_meta, my_meta: { total: 10 })
|
26
|
-
|
27
|
-
assert_equal({
|
28
|
-
'profile' => {
|
29
|
-
name: 'Name 1',
|
30
|
-
description: 'Description 1'
|
31
|
-
},
|
32
|
-
my_meta: {
|
33
|
-
total: 10
|
34
|
-
}
|
35
|
-
}, profile_serializer.as_json)
|
36
|
-
end
|
37
|
-
end
|
38
|
-
end
|
39
|
-
end
|
@@ -1,15 +0,0 @@
|
|
1
|
-
require 'test_helper'
|
2
|
-
|
3
|
-
module ActiveModel
|
4
|
-
class Serializer
|
5
|
-
class OptionsTest < Minitest::Test
|
6
|
-
def setup
|
7
|
-
@serializer = ProfileSerializer.new(nil, context: {foo: :bar})
|
8
|
-
end
|
9
|
-
|
10
|
-
def test_custom_options_are_accessible_from_serializer
|
11
|
-
assert_equal({foo: :bar}, @serializer.context)
|
12
|
-
end
|
13
|
-
end
|
14
|
-
end
|
15
|
-
end
|
@@ -1,117 +0,0 @@
|
|
1
|
-
require 'test_helper'
|
2
|
-
|
3
|
-
module ActiveModel
|
4
|
-
class Serializer
|
5
|
-
class RootAsOptionTest < Minitest::Test
|
6
|
-
def setup
|
7
|
-
@old_root = ProfileSerializer._root
|
8
|
-
@profile = Profile.new({ name: 'Name 1', description: 'Description 1', comments: 'Comments 1' })
|
9
|
-
@serializer = ProfileSerializer.new(@profile, root: :initialize)
|
10
|
-
ProfileSerializer._root = true
|
11
|
-
end
|
12
|
-
|
13
|
-
def teardown
|
14
|
-
ProfileSerializer._root = @old_root
|
15
|
-
end
|
16
|
-
|
17
|
-
def test_root_is_not_displayed_using_serializable_hash
|
18
|
-
assert_equal({
|
19
|
-
name: 'Name 1', description: 'Description 1'
|
20
|
-
}, @serializer.serializable_hash)
|
21
|
-
end
|
22
|
-
|
23
|
-
def test_root_using_as_json
|
24
|
-
assert_equal({
|
25
|
-
initialize: {
|
26
|
-
name: 'Name 1', description: 'Description 1'
|
27
|
-
}
|
28
|
-
}, @serializer.as_json)
|
29
|
-
end
|
30
|
-
|
31
|
-
def test_root_from_serializer_name
|
32
|
-
@serializer = ProfileSerializer.new(@profile)
|
33
|
-
|
34
|
-
assert_equal({
|
35
|
-
'profile' => {
|
36
|
-
name: 'Name 1', description: 'Description 1'
|
37
|
-
}
|
38
|
-
}, @serializer.as_json)
|
39
|
-
end
|
40
|
-
|
41
|
-
def test_root_as_argument_takes_precedence
|
42
|
-
assert_equal({
|
43
|
-
argument: {
|
44
|
-
name: 'Name 1', description: 'Description 1'
|
45
|
-
}
|
46
|
-
}, @serializer.as_json(root: :argument))
|
47
|
-
end
|
48
|
-
|
49
|
-
def test_using_false_root_in_initializer_takes_precedence
|
50
|
-
ProfileSerializer._root = 'root'
|
51
|
-
@serializer = ProfileSerializer.new(@profile, root: false)
|
52
|
-
|
53
|
-
assert_equal({
|
54
|
-
name: 'Name 1', description: 'Description 1'
|
55
|
-
}, @serializer.as_json)
|
56
|
-
end
|
57
|
-
|
58
|
-
def test_root_inheritance
|
59
|
-
ProfileSerializer._root = 'profile'
|
60
|
-
|
61
|
-
inherited_serializer_klass = Class.new(ProfileSerializer)
|
62
|
-
inherited_serializer_klass._root = 'inherited_profile'
|
63
|
-
|
64
|
-
another_inherited_serializer_klass = Class.new(ProfileSerializer)
|
65
|
-
|
66
|
-
assert_equal('inherited_profile',
|
67
|
-
inherited_serializer_klass._root)
|
68
|
-
assert_equal('profile',
|
69
|
-
another_inherited_serializer_klass._root)
|
70
|
-
end
|
71
|
-
end
|
72
|
-
|
73
|
-
class RootInSerializerTest < Minitest::Test
|
74
|
-
def setup
|
75
|
-
@old_root = ProfileSerializer._root
|
76
|
-
ProfileSerializer._root = :in_serializer
|
77
|
-
profile = Profile.new({ name: 'Name 1', description: 'Description 1', comments: 'Comments 1' })
|
78
|
-
@serializer = ProfileSerializer.new(profile)
|
79
|
-
@rooted_serializer = ProfileSerializer.new(profile, root: :initialize)
|
80
|
-
end
|
81
|
-
|
82
|
-
def teardown
|
83
|
-
ProfileSerializer._root = @old_root
|
84
|
-
end
|
85
|
-
|
86
|
-
def test_root_is_not_displayed_using_serializable_hash
|
87
|
-
assert_equal({
|
88
|
-
name: 'Name 1', description: 'Description 1'
|
89
|
-
}, @serializer.serializable_hash)
|
90
|
-
end
|
91
|
-
|
92
|
-
def test_root_using_as_json
|
93
|
-
assert_equal({
|
94
|
-
in_serializer: {
|
95
|
-
name: 'Name 1', description: 'Description 1'
|
96
|
-
}
|
97
|
-
}, @serializer.as_json)
|
98
|
-
end
|
99
|
-
|
100
|
-
def test_root_in_initializer_takes_precedence
|
101
|
-
assert_equal({
|
102
|
-
initialize: {
|
103
|
-
name: 'Name 1', description: 'Description 1'
|
104
|
-
}
|
105
|
-
}, @rooted_serializer.as_json)
|
106
|
-
end
|
107
|
-
|
108
|
-
def test_root_as_argument_takes_precedence
|
109
|
-
assert_equal({
|
110
|
-
argument: {
|
111
|
-
name: 'Name 1', description: 'Description 1'
|
112
|
-
}
|
113
|
-
}, @rooted_serializer.as_json(root: :argument))
|
114
|
-
end
|
115
|
-
end
|
116
|
-
end
|
117
|
-
end
|
@@ -1,49 +0,0 @@
|
|
1
|
-
require 'test_helper'
|
2
|
-
|
3
|
-
module ActiveModel
|
4
|
-
class Serializer
|
5
|
-
class ScopeTest < Minitest::Test
|
6
|
-
def setup
|
7
|
-
@serializer = ProfileSerializer.new(nil, scope: current_user)
|
8
|
-
end
|
9
|
-
|
10
|
-
def test_scope
|
11
|
-
assert_equal('user', @serializer.scope)
|
12
|
-
end
|
13
|
-
|
14
|
-
private
|
15
|
-
|
16
|
-
def current_user
|
17
|
-
'user'
|
18
|
-
end
|
19
|
-
end
|
20
|
-
|
21
|
-
class NestedScopeTest < Minitest::Test
|
22
|
-
def setup
|
23
|
-
@association = UserSerializer._associations[:profile]
|
24
|
-
@old_association = @association.dup
|
25
|
-
@user = User.new({ name: 'Name 1', email: 'mail@server.com', gender: 'M' })
|
26
|
-
@user_serializer = UserSerializer.new(@user, scope: 'user')
|
27
|
-
end
|
28
|
-
|
29
|
-
def teardown
|
30
|
-
UserSerializer._associations[:profile] = @old_association
|
31
|
-
end
|
32
|
-
|
33
|
-
def test_scope_passed_through
|
34
|
-
@association.serializer_from_options = Class.new(Serializer) do
|
35
|
-
def name
|
36
|
-
scope
|
37
|
-
end
|
38
|
-
|
39
|
-
attributes :name
|
40
|
-
end
|
41
|
-
|
42
|
-
assert_equal({
|
43
|
-
name: 'Name 1', email: 'mail@server.com', profile: { name: 'user' }
|
44
|
-
}, @user_serializer.serializable_hash)
|
45
|
-
end
|
46
|
-
end
|
47
|
-
|
48
|
-
end
|
49
|
-
end
|