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,10 +0,0 @@
1
- module ActiveModel
2
- class Railtie < Rails::Railtie
3
- initializer 'generators' do |app|
4
- app.load_generators
5
- require 'active_model/serializer/generators/serializer/serializer_generator'
6
- require 'active_model/serializer/generators/serializer/scaffold_controller_generator'
7
- require 'active_model/serializer/generators/resource_override'
8
- end
9
- end
10
- end
@@ -1,5 +0,0 @@
1
- module ActiveModel
2
- module SerializerSupport
3
- alias read_attribute_for_serialization send
4
- end
5
- end
@@ -1,92 +0,0 @@
1
- require 'active_record'
2
-
3
- ActiveRecord::Base.establish_connection(
4
- :adapter => 'sqlite3',
5
- :database => ':memory:'
6
- )
7
-
8
- ActiveRecord::Schema.define do
9
- create_table :ar_posts, force: true do |t|
10
- t.string :title
11
- t.text :body
12
- t.belongs_to :ar_section, index: true
13
- t.timestamps
14
- end
15
-
16
- create_table :ar_comments, force: true do |t|
17
- t.text :body
18
- t.belongs_to :ar_post, index: true
19
- t.timestamps
20
- end
21
-
22
- create_table :ar_tags, force: true do |t|
23
- t.string :name
24
- end
25
-
26
- create_table :ar_sections, force: true do |t|
27
- t.string :name
28
- end
29
-
30
- create_table :ar_posts_tags, force: true do |t|
31
- t.references :ar_post, :ar_tag, index: true
32
- end
33
-
34
- create_table :ar_comments_tags, force: true do |t|
35
- t.references :ar_comment, :ar_tag, index: true
36
- end
37
- end
38
-
39
- class ARPost < ActiveRecord::Base
40
- has_many :ar_comments, class_name: 'ARComment'
41
- has_and_belongs_to_many :ar_tags, class_name: 'ARTag', join_table: :ar_posts_tags
42
- belongs_to :ar_section, class_name: 'ARSection'
43
- end
44
-
45
- class ARComment < ActiveRecord::Base
46
- belongs_to :ar_post, class_name: 'ARPost'
47
- has_and_belongs_to_many :ar_tags, class_name: 'ARTag', join_table: :ar_comments_tags
48
- end
49
-
50
- class ARTag < ActiveRecord::Base
51
- end
52
-
53
- class ARSection < ActiveRecord::Base
54
- end
55
-
56
- class ARPostSerializer < ActiveModel::Serializer
57
- attributes :title, :body
58
-
59
- has_many :ar_comments, :ar_tags
60
- has_one :ar_section
61
- end
62
-
63
- class ARCommentSerializer < ActiveModel::Serializer
64
- attributes :body
65
-
66
- has_many :ar_tags
67
- end
68
-
69
- class ARTagSerializer < ActiveModel::Serializer
70
- attributes :name
71
- end
72
-
73
- class ARSectionSerializer < ActiveModel::Serializer
74
- attributes 'name'
75
- end
76
-
77
- ARPost.create(title: 'New post',
78
- body: 'A body!!!',
79
- ar_section: ARSection.create(name: 'ruby')).tap do |post|
80
-
81
- short_tag = post.ar_tags.create(name: 'short')
82
- whiny_tag = post.ar_tags.create(name: 'whiny')
83
- happy_tag = ARTag.create(name: 'happy')
84
-
85
- post.ar_comments.create(body: 'what a dumb post').tap do |comment|
86
- comment.ar_tags.concat happy_tag, whiny_tag
87
- end
88
-
89
- post.ar_comments.create(body: 'i liked it').tap do |comment|
90
- comment.ar_tags.concat happy_tag, short_tag
91
- end
92
- end
@@ -1,75 +0,0 @@
1
- class Model
2
- def initialize(hash={})
3
- @attributes = hash
4
- end
5
-
6
- def read_attribute_for_serialization(name)
7
- if name == :id || name == 'id'
8
- object_id
9
- else
10
- @attributes[name]
11
- end
12
- end
13
- end
14
-
15
-
16
- ###
17
- ## Models
18
- ###
19
- class User < Model
20
- def profile
21
- @profile ||= Profile.new(name: 'N1', description: 'D1')
22
- end
23
- end
24
-
25
- class Profile < Model
26
- end
27
-
28
- class Post < Model
29
- def comments
30
- @comments ||= [Comment.new(content: 'C1'),
31
- Comment.new(content: 'C2')]
32
- end
33
- end
34
-
35
- class Comment < Model
36
- end
37
-
38
- class WebLog < Model
39
- end
40
-
41
- ###
42
- ## Serializers
43
- ###
44
- class UserSerializer < ActiveModel::Serializer
45
- attributes :name, :email
46
-
47
- has_one :profile
48
- end
49
-
50
- class ProfileSerializer < ActiveModel::Serializer
51
- def description
52
- description = object.read_attribute_for_serialization(:description)
53
- scope ? "#{description} - #{scope}" : description
54
- end
55
-
56
- attributes :name, :description
57
- end
58
-
59
- class PostSerializer < ActiveModel::Serializer
60
- attributes :title, :body
61
-
62
- has_many :comments
63
- end
64
-
65
- class CommentSerializer < ActiveModel::Serializer
66
- attributes :content
67
- end
68
-
69
- class WebLogSerializer < ActiveModel::Serializer
70
- attributes :name, :display_name
71
- end
72
-
73
- class WebLogLowerCamelSerializer < WebLogSerializer
74
- format_keys :lower_camel
75
- end
@@ -1,287 +0,0 @@
1
- require 'test_helper'
2
-
3
- module ActionController
4
- module Serialization
5
- class ImplicitSerializerTest < ActionController::TestCase
6
- class MyController < ActionController::Base
7
- def render_using_implicit_serializer
8
- render json: Profile.new({ name: 'Name 1', description: 'Description 1', comments: 'Comments 1' })
9
- end
10
- end
11
-
12
- tests MyController
13
-
14
- def test_render_using_implicit_serializer
15
- get :render_using_implicit_serializer
16
- assert_equal 'application/json', @response.content_type
17
- assert_equal '{"profile":{"name":"Name 1","description":"Description 1"}}', @response.body
18
- end
19
- end
20
-
21
- class ImplicitSerializerScopeTest < ActionController::TestCase
22
- class MyController < ActionController::Base
23
- def render_using_implicit_serializer_and_scope
24
- render json: Profile.new({ name: 'Name 1', description: 'Description 1', comments: 'Comments 1' })
25
- end
26
-
27
- private
28
-
29
- def current_user
30
- 'current_user'
31
- end
32
- end
33
-
34
- tests MyController
35
-
36
- def test_render_using_implicit_serializer_and_scope
37
- get :render_using_implicit_serializer_and_scope
38
- assert_equal 'application/json', @response.content_type
39
- assert_equal '{"profile":{"name":"Name 1","description":"Description 1 - current_user"}}', @response.body
40
- end
41
- end
42
-
43
- class DefaultOptionsForSerializerScopeTest < ActionController::TestCase
44
- class MyController < ActionController::Base
45
- def default_serializer_options
46
- { scope: current_admin }
47
- end
48
-
49
- def render_using_scope_set_in_default_serializer_options
50
- render json: Profile.new({ name: 'Name 1', description: 'Description 1', comments: 'Comments 1' })
51
- end
52
-
53
- private
54
-
55
- def current_user
56
- 'current_user'
57
- end
58
-
59
- def current_admin
60
- 'current_admin'
61
- end
62
- end
63
-
64
- tests MyController
65
-
66
- def test_render_using_scope_set_in_default_serializer_options
67
- get :render_using_scope_set_in_default_serializer_options
68
- assert_equal 'application/json', @response.content_type
69
- assert_equal '{"profile":{"name":"Name 1","description":"Description 1 - current_admin"}}', @response.body
70
- end
71
- end
72
-
73
- class ExplicitSerializerScopeTest < ActionController::TestCase
74
- class MyController < ActionController::Base
75
- def render_using_implicit_serializer_and_explicit_scope
76
- render json: Profile.new({ name: 'Name 1', description: 'Description 1', comments: 'Comments 1' }), scope: current_admin
77
- end
78
-
79
- private
80
-
81
- def current_user
82
- 'current_user'
83
- end
84
-
85
- def current_admin
86
- 'current_admin'
87
- end
88
- end
89
-
90
- tests MyController
91
-
92
- def test_render_using_implicit_serializer_and_explicit_scope
93
- get :render_using_implicit_serializer_and_explicit_scope
94
- assert_equal 'application/json', @response.content_type
95
- assert_equal '{"profile":{"name":"Name 1","description":"Description 1 - current_admin"}}', @response.body
96
- end
97
- end
98
-
99
- class OverridingSerializationScopeTest < ActionController::TestCase
100
- class MyController < ActionController::Base
101
- def render_overriding_serialization_scope
102
- render json: Profile.new({ name: 'Name 1', description: 'Description 1', comments: 'Comments 1' })
103
- end
104
-
105
- private
106
-
107
- def current_user
108
- 'current_user'
109
- end
110
-
111
- def serialization_scope
112
- 'current_admin'
113
- end
114
- end
115
-
116
- tests MyController
117
-
118
- def test_render_overriding_serialization_scope
119
- get :render_overriding_serialization_scope
120
- assert_equal 'application/json', @response.content_type
121
- assert_equal '{"profile":{"name":"Name 1","description":"Description 1 - current_admin"}}', @response.body
122
- end
123
- end
124
-
125
- class CallingSerializationScopeTest < ActionController::TestCase
126
- class MyController < ActionController::Base
127
- def render_calling_serialization_scope
128
- render json: Profile.new({ name: 'Name 1', description: 'Description 1', comments: 'Comments 1' })
129
- end
130
-
131
- private
132
-
133
- def current_user
134
- 'current_user'
135
- end
136
-
137
- serialization_scope :current_user
138
- end
139
-
140
- tests MyController
141
-
142
- def test_render_calling_serialization_scope
143
- get :render_calling_serialization_scope
144
- assert_equal 'application/json', @response.content_type
145
- assert_equal '{"profile":{"name":"Name 1","description":"Description 1 - current_user"}}', @response.body
146
- end
147
- end
148
-
149
- class JSONDumpSerializerTest < ActionController::TestCase
150
- class MyController < ActionController::Base
151
- def render_using_json_dump
152
- render json: JSON.dump(hello: 'world')
153
- end
154
- end
155
-
156
- tests MyController
157
-
158
- def test_render_using_json_dump
159
- get :render_using_json_dump
160
- assert_equal 'application/json', @response.content_type
161
- assert_equal '{"hello":"world"}', @response.body
162
- end
163
- end
164
-
165
- class RailsSerializerTest < ActionController::TestCase
166
- class MyController < ActionController::Base
167
- def render_using_rails_behavior
168
- render json: [Profile.new({ name: 'Name 1', description: 'Description 1', comments: 'Comments 1' })], serializer: false
169
- end
170
- end
171
-
172
- tests MyController
173
-
174
- def test_render_using_rails_behavior
175
- get :render_using_rails_behavior
176
- assert_equal 'application/json', @response.content_type
177
- assert_equal '[{"attributes":{"name":"Name 1","description":"Description 1","comments":"Comments 1"}}]', @response.body
178
- end
179
- end
180
-
181
- class ArraySerializerTest < ActionController::TestCase
182
- class MyController < ActionController::Base
183
- def render_array
184
- render json: [Profile.new({ name: 'Name 1', description: 'Description 1', comments: 'Comments 1' })]
185
- end
186
- end
187
-
188
- tests MyController
189
-
190
- def test_render_array
191
- get :render_array
192
- assert_equal 'application/json', @response.content_type
193
- assert_equal '{"my":[{"name":"Name 1","description":"Description 1"}]}', @response.body
194
- end
195
- end
196
-
197
- class LowerCamelArraySerializerTest < ActionController::TestCase
198
- class WebLogController < ActionController::Base
199
- def render_array
200
- render json: [WebLog.new({name: 'Name 1', display_name: 'Display Name 1'}), WebLog.new({name: 'Name 2', display_name: 'Display Name 2'})], each_serializer: WebLogLowerCamelSerializer
201
- end
202
- end
203
-
204
- tests WebLogController
205
-
206
- def test_render_array
207
- get :render_array
208
- assert_equal 'application/json', @response.content_type
209
- assert_equal '{"webLog":[{"name":"Name 1","displayName":"Display Name 1"},{"name":"Name 2","displayName":"Display Name 2"}]}', @response.body
210
- end
211
- end
212
-
213
- class LowerCamelWoRootSerializerTest < ActionController::TestCase
214
- class WebLogController < ActionController::Base
215
- def render_without_root
216
- render json: WebLog.new({name: 'Name 1', display_name: 'Display Name 1'}),
217
- root: false,
218
- serializer: WebLogLowerCamelSerializer
219
- end
220
- end
221
-
222
- tests WebLogController
223
-
224
- def test_render_without_root
225
- get :render_without_root
226
- assert_equal 'application/json', @response.content_type
227
- assert_equal '{"name":"Name 1","displayName":"Display Name 1"}', @response.body
228
- end
229
- end
230
-
231
- class LowerCamelArrayWoRootSerializerTest < ActionController::TestCase
232
- class WebLogController < ActionController::Base
233
- def render_array_without_root
234
- render json: [WebLog.new({name: 'Name 1', display_name: 'Display Name 1'}),
235
- WebLog.new({name: 'Name 2', display_name: 'Display Name 2'})],
236
- root: false,
237
- each_serializer: WebLogLowerCamelSerializer
238
- end
239
- end
240
-
241
- tests WebLogController
242
-
243
- def test_render_array_without_root
244
- get :render_array_without_root
245
- assert_equal 'application/json', @response.content_type
246
- assert_equal '[{"name":"Name 1","displayName":"Display Name 1"},{"name":"Name 2","displayName":"Display Name 2"}]', @response.body
247
- end
248
- end
249
-
250
- class ArrayEmbedingSerializerTest < ActionController::TestCase
251
- def setup
252
- super
253
- @association = UserSerializer._associations[:profile]
254
- @old_association = @association.dup
255
- end
256
-
257
- def teardown
258
- super
259
- UserSerializer._associations[:profile] = @old_association
260
- end
261
-
262
- class MyController < ActionController::Base
263
- def initialize(*)
264
- super
265
- @user = User.new({ name: 'Name 1', email: 'mail@server.com', gender: 'M' })
266
- end
267
- attr_reader :user
268
-
269
- def render_array_embeding_in_root
270
- render json: [@user]
271
- end
272
- end
273
-
274
- tests MyController
275
-
276
- def test_render_array_embeding_in_root
277
- @association.embed = :ids
278
- @association.embed_in_root = true
279
-
280
- get :render_array_embeding_in_root
281
- assert_equal 'application/json', @response.content_type
282
-
283
- assert_equal("{\"my\":[{\"name\":\"Name 1\",\"email\":\"mail@server.com\",\"profile_id\":#{@controller.user.profile.object_id}}],\"profiles\":[{\"name\":\"N1\",\"description\":\"D1\"}]}", @response.body)
284
- end
285
- end
286
- end
287
- end