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.
Files changed (113) hide show
  1. checksums.yaml +5 -5
  2. data/CHANGELOG.md +679 -9
  3. data/MIT-LICENSE +3 -2
  4. data/README.md +195 -753
  5. data/lib/action_controller/serialization.rb +45 -49
  6. data/lib/active_model/serializable_resource.rb +13 -0
  7. data/lib/active_model/serializer.rb +369 -212
  8. data/lib/active_model/serializer/adapter.rb +26 -0
  9. data/lib/active_model/serializer/adapter/attributes.rb +17 -0
  10. data/lib/active_model/serializer/adapter/base.rb +20 -0
  11. data/lib/active_model/serializer/adapter/json.rb +17 -0
  12. data/lib/active_model/serializer/adapter/json_api.rb +17 -0
  13. data/lib/active_model/serializer/adapter/null.rb +17 -0
  14. data/lib/active_model/serializer/array_serializer.rb +14 -0
  15. data/lib/active_model/serializer/association.rb +73 -0
  16. data/lib/active_model/serializer/attribute.rb +27 -0
  17. data/lib/active_model/serializer/belongs_to_reflection.rb +13 -0
  18. data/lib/active_model/serializer/collection_serializer.rb +90 -0
  19. data/lib/active_model/serializer/concerns/caching.rb +305 -0
  20. data/lib/active_model/serializer/error_serializer.rb +16 -0
  21. data/lib/active_model/serializer/errors_serializer.rb +34 -0
  22. data/lib/active_model/serializer/field.rb +92 -0
  23. data/lib/active_model/serializer/fieldset.rb +33 -0
  24. data/lib/active_model/serializer/has_many_reflection.rb +12 -0
  25. data/lib/active_model/serializer/has_one_reflection.rb +9 -0
  26. data/lib/active_model/serializer/lazy_association.rb +99 -0
  27. data/lib/active_model/serializer/link.rb +23 -0
  28. data/lib/active_model/serializer/lint.rb +152 -0
  29. data/lib/active_model/serializer/null.rb +19 -0
  30. data/lib/active_model/serializer/reflection.rb +212 -0
  31. data/lib/active_model/serializer/version.rb +3 -1
  32. data/lib/active_model_serializers.rb +60 -17
  33. data/lib/active_model_serializers/adapter.rb +100 -0
  34. data/lib/active_model_serializers/adapter/attributes.rb +36 -0
  35. data/lib/active_model_serializers/adapter/base.rb +85 -0
  36. data/lib/active_model_serializers/adapter/json.rb +23 -0
  37. data/lib/active_model_serializers/adapter/json_api.rb +535 -0
  38. data/lib/active_model_serializers/adapter/json_api/deserialization.rb +215 -0
  39. data/lib/active_model_serializers/adapter/json_api/error.rb +98 -0
  40. data/lib/active_model_serializers/adapter/json_api/jsonapi.rb +51 -0
  41. data/lib/active_model_serializers/adapter/json_api/link.rb +85 -0
  42. data/lib/active_model_serializers/adapter/json_api/meta.rb +39 -0
  43. data/lib/active_model_serializers/adapter/json_api/pagination_links.rb +90 -0
  44. data/lib/active_model_serializers/adapter/json_api/relationship.rb +106 -0
  45. data/lib/active_model_serializers/adapter/json_api/resource_identifier.rb +68 -0
  46. data/lib/active_model_serializers/adapter/null.rb +11 -0
  47. data/lib/active_model_serializers/callbacks.rb +57 -0
  48. data/lib/active_model_serializers/deprecate.rb +56 -0
  49. data/lib/active_model_serializers/deserialization.rb +17 -0
  50. data/lib/active_model_serializers/json_pointer.rb +16 -0
  51. data/lib/active_model_serializers/logging.rb +124 -0
  52. data/lib/active_model_serializers/lookup_chain.rb +82 -0
  53. data/lib/active_model_serializers/model.rb +132 -0
  54. data/lib/active_model_serializers/model/caching.rb +25 -0
  55. data/lib/active_model_serializers/railtie.rb +52 -0
  56. data/lib/active_model_serializers/register_jsonapi_renderer.rb +80 -0
  57. data/lib/active_model_serializers/serializable_resource.rb +84 -0
  58. data/lib/active_model_serializers/serialization_context.rb +41 -0
  59. data/lib/active_model_serializers/test.rb +9 -0
  60. data/lib/active_model_serializers/test/schema.rb +140 -0
  61. data/lib/active_model_serializers/test/serializer.rb +127 -0
  62. data/lib/generators/rails/USAGE +6 -0
  63. data/lib/{active_model/serializer/generators → generators/rails}/resource_override.rb +3 -4
  64. data/lib/{active_model/serializer/generators/serializer → generators/rails}/serializer_generator.rb +6 -5
  65. data/lib/{active_model/serializer/generators/serializer/templates/serializer.rb → generators/rails/templates/serializer.rb.erb} +0 -0
  66. data/lib/grape/active_model_serializers.rb +18 -0
  67. data/lib/grape/formatters/active_model_serializers.rb +34 -0
  68. data/lib/grape/helpers/active_model_serializers.rb +19 -0
  69. data/lib/tasks/rubocop.rake +55 -0
  70. metadata +315 -99
  71. data/CONTRIBUTING.md +0 -20
  72. data/DESIGN.textile +0 -586
  73. data/lib/action_controller/serialization_test_case.rb +0 -79
  74. data/lib/active_model/array_serializer.rb +0 -65
  75. data/lib/active_model/default_serializer.rb +0 -32
  76. data/lib/active_model/serializable.rb +0 -40
  77. data/lib/active_model/serializer/associations.rb +0 -102
  78. data/lib/active_model/serializer/config.rb +0 -31
  79. data/lib/active_model/serializer/generators/serializer/USAGE +0 -9
  80. data/lib/active_model/serializer/generators/serializer/scaffold_controller_generator.rb +0 -14
  81. data/lib/active_model/serializer/generators/serializer/templates/controller.rb +0 -93
  82. data/lib/active_model/serializer/railtie.rb +0 -10
  83. data/lib/active_model/serializer_support.rb +0 -5
  84. data/test/fixtures/active_record.rb +0 -92
  85. data/test/fixtures/poro.rb +0 -75
  86. data/test/integration/action_controller/serialization_test.rb +0 -287
  87. data/test/integration/action_controller/serialization_test_case_test.rb +0 -61
  88. data/test/integration/active_record/active_record_test.rb +0 -77
  89. data/test/integration/generators/resource_generator_test.rb +0 -26
  90. data/test/integration/generators/scaffold_controller_generator_test.rb +0 -64
  91. data/test/integration/generators/serializer_generator_test.rb +0 -41
  92. data/test/test_app.rb +0 -11
  93. data/test/test_helper.rb +0 -24
  94. data/test/unit/active_model/array_serializer/except_test.rb +0 -18
  95. data/test/unit/active_model/array_serializer/key_format_test.rb +0 -18
  96. data/test/unit/active_model/array_serializer/meta_test.rb +0 -53
  97. data/test/unit/active_model/array_serializer/only_test.rb +0 -18
  98. data/test/unit/active_model/array_serializer/root_test.rb +0 -102
  99. data/test/unit/active_model/array_serializer/scope_test.rb +0 -24
  100. data/test/unit/active_model/array_serializer/serialization_test.rb +0 -199
  101. data/test/unit/active_model/default_serializer_test.rb +0 -13
  102. data/test/unit/active_model/serializer/associations/build_serializer_test.rb +0 -21
  103. data/test/unit/active_model/serializer/associations_test.rb +0 -19
  104. data/test/unit/active_model/serializer/attributes_test.rb +0 -41
  105. data/test/unit/active_model/serializer/config_test.rb +0 -88
  106. data/test/unit/active_model/serializer/filter_test.rb +0 -69
  107. data/test/unit/active_model/serializer/has_many_test.rb +0 -230
  108. data/test/unit/active_model/serializer/has_one_test.rb +0 -207
  109. data/test/unit/active_model/serializer/key_format_test.rb +0 -25
  110. data/test/unit/active_model/serializer/meta_test.rb +0 -39
  111. data/test/unit/active_model/serializer/options_test.rb +0 -15
  112. data/test/unit/active_model/serializer/root_test.rb +0 -117
  113. data/test/unit/active_model/serializer/scope_test.rb +0 -49
@@ -1,24 +0,0 @@
1
- require 'test_helper'
2
-
3
- module ActiveModel
4
- class ArraySerializer
5
- class ScopeTest < Minitest::Test
6
- def test_array_serializer_pass_options_to_items_serializers
7
- array = [Profile.new({ name: 'Name 1', description: 'Description 1', comments: 'Comments 1' }),
8
- Profile.new({ name: 'Name 2', description: 'Description 2', comments: 'Comments 2' })]
9
- serializer = ArraySerializer.new(array, scope: current_user)
10
-
11
- expected = [{ name: 'Name 1', description: 'Description 1 - user' },
12
- { name: 'Name 2', description: 'Description 2 - user' }]
13
-
14
- assert_equal expected, serializer.serializable_array
15
- end
16
-
17
- private
18
-
19
- def current_user
20
- 'user'
21
- end
22
- end
23
- end
24
- end
@@ -1,199 +0,0 @@
1
- require 'test_helper'
2
-
3
- module ActiveModel
4
- class ArraySerializer
5
- class BasicObjectsSerializationTest < Minitest::Test
6
- def setup
7
- array = [1, 2, 3]
8
- @serializer = Serializer.serializer_for(array).new(array)
9
- end
10
-
11
- def test_serializer_for_array_returns_appropriate_type
12
- assert_kind_of ActiveModel::ArraySerializer, @serializer
13
- end
14
-
15
- def test_array_serializer_serializes_simple_objects
16
- assert_equal [1, 2, 3], @serializer.serializable_array
17
- assert_equal [1, 2, 3], @serializer.as_json
18
- end
19
- end
20
-
21
- class CustomArraySerializerSupport < Minitest::Test
22
- def setup
23
- Object.const_set(:ArraySerializer, Class.new)
24
-
25
- array = [1, 2, 3]
26
- @serializer_class = Serializer.serializer_for(array)
27
- end
28
-
29
- def teardown
30
- Object.send(:remove_const, :ArraySerializer)
31
- end
32
-
33
- def test_serializer_for_array_returns_appropriate_type
34
- assert_equal ::ArraySerializer, @serializer_class
35
- end
36
- end
37
-
38
- class ModelSerializationTest < Minitest::Test
39
- def test_array_serializer_serializes_models
40
- array = [Profile.new({ name: 'Name 1', description: 'Description 1', comments: 'Comments 1' }),
41
- Profile.new({ name: 'Name 2', description: 'Description 2', comments: 'Comments 2' })]
42
- serializer = ArraySerializer.new(array)
43
-
44
- expected = [{ name: 'Name 1', description: 'Description 1' },
45
- { name: 'Name 2', description: 'Description 2' }]
46
-
47
- assert_equal expected, serializer.serializable_array
48
- assert_equal expected, serializer.as_json
49
- end
50
-
51
- def test_array_serializers_each_serializer
52
- array = [::Model.new({ name: 'Name 1', description: 'Description 1', comments: 'Comments 1' }),
53
- ::Model.new({ name: 'Name 2', description: 'Description 2', comments: 'Comments 2' })]
54
- serializer = ArraySerializer.new(array, each_serializer: ProfileSerializer)
55
-
56
- expected = [{ name: 'Name 1', description: 'Description 1' },
57
- { name: 'Name 2', description: 'Description 2' }]
58
-
59
- assert_equal expected, serializer.serializable_array
60
- assert_equal expected, serializer.as_json
61
- end
62
-
63
- def test_associated_objects_of_multiple_instances_embedded_in_root
64
- @association = PostSerializer._associations[:comments]
65
- @old_association = @association.dup
66
-
67
- @association.embed = :ids
68
- @association.embed_in_root = true
69
-
70
- @post1 = Post.new({ title: 'Title 1', body: 'Body 1', date: '1/1/2000' })
71
- @post2 = Post.new({ title: 'Title 2', body: 'Body 2', date: '1/1/2000' })
72
-
73
- class << @post2
74
- attr_writer :comments
75
- end
76
-
77
- @post2.comments = [
78
- Comment.new(content: 'C3'),
79
- Comment.new(content: 'C4')
80
- ]
81
-
82
- @serializer = ArraySerializer.new([@post1, @post2], root: :posts)
83
- assert_equal({
84
- posts: [
85
- {title: "Title 1", body: "Body 1", "comment_ids" => @post1.comments.map(&:object_id) },
86
- {title: "Title 2", body: "Body 2", "comment_ids" => @post2.comments.map(&:object_id) }
87
- ],
88
- comments: [
89
- {content: "C1"},
90
- {content: "C2"},
91
- {content: "C3"},
92
- {content: "C4"}
93
- ]
94
- }, @serializer.as_json)
95
- ensure
96
- PostSerializer._associations[:comments] = @old_association
97
- end
98
-
99
- def test_embed_object_for_has_one_association_with_nil_value
100
- @association = UserSerializer._associations[:profile]
101
- @old_association = @association.dup
102
-
103
- @association.embed = :objects
104
-
105
- @user1 = User.new({ name: 'User 1', email: 'email1@server.com' })
106
- @user2 = User.new({ name: 'User 2', email: 'email2@server.com' })
107
-
108
- class << @user1
109
- def profile
110
- nil
111
- end
112
- end
113
-
114
- class << @user2
115
- def profile
116
- @profile ||= Profile.new(name: 'Name 1', description: 'Desc 1')
117
- end
118
- end
119
-
120
- @serializer = ArraySerializer.new([@user1, @user2]) #, root: :posts)
121
- assert_equal([
122
- { name: "User 1", email: "email1@server.com", profile: nil },
123
- { name: "User 2", email: "email2@server.com", profile: { name: 'Name 1', description: 'Desc 1' } }
124
- ], @serializer.as_json)
125
- ensure
126
- UserSerializer._associations[:profile] = @old_association
127
- end
128
-
129
- def test_embed_object_in_root_for_has_one_association_with_nil_value
130
- @association = UserSerializer._associations[:profile]
131
- @old_association = @association.dup
132
-
133
- @association.embed = :ids
134
- @association.embed_in_root = true
135
-
136
- @user1 = User.new({ name: 'User 1', email: 'email1@server.com' })
137
- @user2 = User.new({ name: 'User 2', email: 'email2@server.com' })
138
-
139
- class << @user1
140
- def profile
141
- nil
142
- end
143
- end
144
-
145
- class << @user2
146
- def profile
147
- @profile ||= Profile.new(name: 'Name 1', description: 'Desc 1')
148
- end
149
- end
150
-
151
- @serializer = ArraySerializer.new([@user1, @user2], root: :users)
152
- assert_equal({
153
- users: [
154
- { name: "User 1", email: "email1@server.com", 'profile_id' => nil },
155
- { name: "User 2", email: "email2@server.com", 'profile_id' => @user2.profile.object_id }
156
- ],
157
- 'profiles' => [
158
- { name: 'Name 1', description: 'Desc 1' }
159
- ]
160
- }, @serializer.as_json)
161
- ensure
162
- UserSerializer._associations[:profile] = @old_association
163
- end
164
-
165
- def test_embed_object_in_root_for_has_one_association_with_all_nil_values
166
- @association = UserSerializer._associations[:profile]
167
- @old_association = @association.dup
168
-
169
- @association.embed = :ids
170
- @association.embed_in_root = true
171
-
172
- @user1 = User.new({ name: 'User 1', email: 'email1@server.com' })
173
- @user2 = User.new({ name: 'User 2', email: 'email2@server.com' })
174
-
175
- class << @user1
176
- def profile
177
- nil
178
- end
179
- end
180
-
181
- class << @user2
182
- def profile
183
- nil
184
- end
185
- end
186
-
187
- @serializer = ArraySerializer.new([@user1, @user2], root: :users)
188
- assert_equal({
189
- users: [
190
- { name: "User 1", email: "email1@server.com", 'profile_id' => nil },
191
- { name: "User 2", email: "email2@server.com", 'profile_id' => nil }
192
- ]
193
- }, @serializer.as_json)
194
- ensure
195
- UserSerializer._associations[:profile] = @old_association
196
- end
197
- end
198
- end
199
- end
@@ -1,13 +0,0 @@
1
- require 'test_helper'
2
-
3
- module ActiveModel
4
- class DefaultSerializer
5
- class Test < Minitest::Test
6
- def test_serialize_objects
7
- assert_equal(nil, DefaultSerializer.new(nil).serializable_object)
8
- assert_equal(1, DefaultSerializer.new(1).serializable_object)
9
- assert_equal('hi', DefaultSerializer.new('hi').serializable_object)
10
- end
11
- end
12
- end
13
- end
@@ -1,21 +0,0 @@
1
- require 'test_helper'
2
-
3
- module ActiveModel
4
- class Serializer
5
- class Association
6
- class BuildSerializerTest < Minitest::Test
7
- def setup
8
- @association = Association::HasOne.new('post', serializer: PostSerializer)
9
- @post = Post.new({ title: 'Title 1', body: 'Body 1', date: '1/1/2000' })
10
- end
11
-
12
- def test_build_serializer_for_array_called_twice
13
- 2.times do
14
- serializer = @association.build_serializer(@post)
15
- assert_instance_of(PostSerializer, serializer)
16
- end
17
- end
18
- end
19
- end
20
- end
21
- end
@@ -1,19 +0,0 @@
1
- require 'test_helper'
2
-
3
- module ActiveModel
4
- class Serializer
5
- class AssociationsTest < Minitest::Test
6
- def test_associations_inheritance
7
- inherited_serializer_klass = Class.new(PostSerializer) do
8
- has_many :users
9
- end
10
- another_inherited_serializer_klass = Class.new(PostSerializer)
11
-
12
- assert_equal([:comments, :users],
13
- inherited_serializer_klass._associations.keys)
14
- assert_equal([:comments],
15
- another_inherited_serializer_klass._associations.keys)
16
- end
17
- end
18
- end
19
- end
@@ -1,41 +0,0 @@
1
- require 'test_helper'
2
-
3
- module ActiveModel
4
- class Serializer
5
- class AttributesTest < Minitest::Test
6
- def setup
7
- @profile = Profile.new({ name: 'Name 1', description: 'Description 1', comments: 'Comments 1' })
8
- @profile_serializer = ProfileSerializer.new(@profile)
9
- end
10
-
11
- def test_attributes_definition
12
- assert_equal([:name, :description],
13
- @profile_serializer.class._attributes)
14
- end
15
-
16
- def test_attributes_serialization_using_serializable_hash
17
- assert_equal({
18
- name: 'Name 1', description: 'Description 1'
19
- }, @profile_serializer.serializable_hash)
20
- end
21
-
22
- def test_attributes_serialization_using_as_json
23
- assert_equal({
24
- 'profile' => { name: 'Name 1', description: 'Description 1' }
25
- }, @profile_serializer.as_json)
26
- end
27
-
28
- def test_attributes_inheritance
29
- inherited_serializer_klass = Class.new(ProfileSerializer) do
30
- attributes :comments
31
- end
32
- another_inherited_serializer_klass = Class.new(ProfileSerializer)
33
-
34
- assert_equal([:name, :description, :comments],
35
- inherited_serializer_klass._attributes)
36
- assert_equal([:name, :description],
37
- another_inherited_serializer_klass._attributes)
38
- end
39
- end
40
- end
41
- end
@@ -1,88 +0,0 @@
1
- require 'test_helper'
2
-
3
- module ActiveModel
4
- class Serializer
5
- class Config
6
- class Test < Minitest::Test
7
- def test_config_const_is_an_instance_of_config
8
- assert_kind_of Config, CONFIG
9
- end
10
-
11
- def test_config_instance
12
- config = Config.new
13
- config.setting1 = 'value1'
14
-
15
- assert_equal 'value1', config.setting1
16
- end
17
-
18
- def test_each_config
19
- config = Config.new
20
- config.setting1 = 'value1'
21
- config.setting2 = 'value2'
22
-
23
- actual = {}
24
-
25
- config.each do |k, v|
26
- actual[k] = v
27
- end
28
-
29
- assert_equal({ 'setting1' => 'value1', 'setting2' => 'value2' }, actual)
30
- end
31
- end
32
-
33
- class ConfigTest < Minitest::Test
34
- def test_setup
35
- Serializer.setup do |config|
36
- config.a = 'v1'
37
- config.b = 'v2'
38
- end
39
-
40
- assert_equal 'v1', CONFIG.a
41
- assert_equal 'v2', CONFIG.b
42
- ensure
43
- CONFIG.clear
44
- end
45
-
46
- def test_config_accessors
47
- Serializer.setup do |config|
48
- config.foo = 'v1'
49
- config.bar = 'v2'
50
- end
51
-
52
- assert_equal 'v1', CONFIG.foo
53
- assert_equal 'v2', CONFIG.bar
54
- ensure
55
- CONFIG.clear
56
- end
57
-
58
- def test_acessor_when_nil
59
- assert_nil CONFIG.foo
60
- CONFIG.foo = 1
61
- assert_equal 1, CONFIG.foo
62
- assert_nil CONFIG.bar
63
- end
64
- end
65
-
66
- class ApplyConfigTest < Minitest::Test
67
- def test_apply_config_to_associations
68
- CONFIG.embed = :ids
69
- CONFIG.embed_in_root = true
70
- CONFIG.key_format = :lower_camel
71
-
72
- association = PostSerializer._associations[:comments]
73
- old_association = association.dup
74
-
75
- association.send :initialize, association.name, association.options
76
-
77
- assert association.embed_ids?
78
- assert !association.embed_objects?
79
- assert association.embed_in_root
80
- assert_equal :lower_camel, association.key_format
81
- ensure
82
- PostSerializer._associations[:comments] = old_association
83
- CONFIG.clear
84
- end
85
- end
86
- end
87
- end
88
- end
@@ -1,69 +0,0 @@
1
- require 'test_helper'
2
-
3
- module ActiveModel
4
- class Serializer
5
- class FilterOptionsTest < Minitest::Test
6
- def setup
7
- @profile = Profile.new({ name: 'Name 1', description: 'Description 1', comments: 'Comments 1' })
8
- end
9
-
10
- def test_only_option
11
- @profile_serializer = ProfileSerializer.new(@profile, only: :name)
12
- assert_equal({
13
- 'profile' => { name: 'Name 1' }
14
- }, @profile_serializer.as_json)
15
- end
16
-
17
- def test_except_option
18
- @profile_serializer = ProfileSerializer.new(@profile, except: :comments)
19
- assert_equal({
20
- 'profile' => { name: 'Name 1', description: 'Description 1' }
21
- }, @profile_serializer.as_json)
22
- end
23
- end
24
-
25
- class FilterAttributesTest < Minitest::Test
26
- def setup
27
- @profile = Profile.new({ name: 'Name 1', description: 'Description 1', comments: 'Comments 1' })
28
- @profile_serializer = ProfileSerializer.new(@profile)
29
- @profile_serializer.instance_eval do
30
- def filter(keys)
31
- keys - [:description]
32
- end
33
- end
34
- end
35
-
36
- def test_filtered_attributes_serialization
37
- assert_equal({
38
- 'profile' => { name: 'Name 1' }
39
- }, @profile_serializer.as_json)
40
- end
41
- end
42
-
43
- class FilterAssociationsTest < Minitest::Test
44
- def setup
45
- @association = PostSerializer._associations[:comments]
46
- @old_association = @association.dup
47
- @association.embed = :ids
48
- @association.embed_in_root = true
49
- @post = Post.new({ title: 'Title 1', body: 'Body 1', date: '1/1/2000' })
50
- @post_serializer = PostSerializer.new(@post)
51
- @post_serializer.instance_eval do
52
- def filter(keys)
53
- keys - [:body, :comments]
54
- end
55
- end
56
- end
57
-
58
- def teardown
59
- PostSerializer._associations[:comments] = @old_association
60
- end
61
-
62
- def test_filtered_associations_serialization
63
- assert_equal({
64
- 'post' => { title: 'Title 1' }
65
- }, @post_serializer.as_json)
66
- end
67
- end
68
- end
69
- end