active_model_serializers 0.8.3 → 0.10.0.rc2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (82) hide show
  1. checksums.yaml +4 -4
  2. data/.gitignore +3 -0
  3. data/.travis.yml +18 -20
  4. data/CHANGELOG.md +8 -67
  5. data/CONTRIBUTING.md +31 -0
  6. data/Gemfile +14 -1
  7. data/{MIT-LICENSE.txt → LICENSE.txt} +3 -2
  8. data/README.md +169 -495
  9. data/Rakefile +6 -12
  10. data/active_model_serializers.gemspec +21 -19
  11. data/lib/action_controller/serialization.rb +36 -27
  12. data/lib/active_model/serializer/adapter/flatten_json.rb +12 -0
  13. data/lib/active_model/serializer/adapter/fragment_cache.rb +78 -0
  14. data/lib/active_model/serializer/adapter/json/fragment_cache.rb +15 -0
  15. data/lib/active_model/serializer/adapter/json.rb +50 -0
  16. data/lib/active_model/serializer/adapter/json_api/fragment_cache.rb +23 -0
  17. data/lib/active_model/serializer/adapter/json_api.rb +156 -0
  18. data/lib/active_model/serializer/adapter/null.rb +11 -0
  19. data/lib/active_model/serializer/adapter.rb +96 -0
  20. data/lib/active_model/serializer/array_serializer.rb +35 -0
  21. data/lib/active_model/serializer/configuration.rb +13 -0
  22. data/lib/active_model/serializer/fieldset.rb +40 -0
  23. data/lib/active_model/serializer/railtie.rb +8 -0
  24. data/lib/active_model/{serializers → serializer}/version.rb +1 -1
  25. data/lib/active_model/serializer.rb +177 -440
  26. data/lib/active_model_serializers.rb +10 -86
  27. data/lib/generators/serializer/USAGE +0 -3
  28. data/lib/generators/serializer/resource_override.rb +12 -0
  29. data/lib/generators/serializer/serializer_generator.rb +1 -6
  30. data/lib/generators/serializer/templates/serializer.rb +2 -13
  31. data/test/action_controller/adapter_selector_test.rb +53 -0
  32. data/test/action_controller/explicit_serializer_test.rb +134 -0
  33. data/test/action_controller/json_api_linked_test.rb +179 -0
  34. data/test/action_controller/rescue_from_test.rb +32 -0
  35. data/test/{serialization_scope_name_test.rb → action_controller/serialization_scope_name_test.rb} +7 -11
  36. data/test/action_controller/serialization_test.rb +383 -0
  37. data/test/adapter/fragment_cache_test.rb +27 -0
  38. data/test/adapter/json/belongs_to_test.rb +48 -0
  39. data/test/adapter/json/collection_test.rb +73 -0
  40. data/test/adapter/json/has_many_test.rb +36 -0
  41. data/test/adapter/json_api/belongs_to_test.rb +157 -0
  42. data/test/adapter/json_api/collection_test.rb +96 -0
  43. data/test/adapter/json_api/has_many_embed_ids_test.rb +45 -0
  44. data/test/adapter/json_api/has_many_explicit_serializer_test.rb +98 -0
  45. data/test/adapter/json_api/has_many_test.rb +110 -0
  46. data/test/adapter/json_api/has_one_test.rb +61 -0
  47. data/test/adapter/json_api/linked_test.rb +283 -0
  48. data/test/adapter/json_test.rb +34 -0
  49. data/test/adapter/null_test.rb +25 -0
  50. data/test/adapter_test.rb +43 -0
  51. data/test/array_serializer_test.rb +31 -63
  52. data/test/fixtures/poro.rb +230 -0
  53. data/test/generators/scaffold_controller_generator_test.rb +24 -0
  54. data/test/{generators_test.rb → generators/serializer_generator_test.rb} +2 -36
  55. data/test/serializers/adapter_for_test.rb +50 -0
  56. data/test/serializers/associations_test.rb +127 -0
  57. data/test/serializers/attribute_test.rb +38 -0
  58. data/test/serializers/attributes_test.rb +63 -0
  59. data/test/serializers/cache_test.rb +138 -0
  60. data/test/serializers/configuration_test.rb +15 -0
  61. data/test/serializers/fieldset_test.rb +26 -0
  62. data/test/serializers/meta_test.rb +107 -0
  63. data/test/serializers/options_test.rb +21 -0
  64. data/test/serializers/serializer_for_test.rb +65 -0
  65. data/test/serializers/urls_test.rb +26 -0
  66. data/test/test_helper.rb +28 -16
  67. metadata +109 -43
  68. data/DESIGN.textile +0 -586
  69. data/Gemfile.edge +0 -9
  70. data/bench/perf.rb +0 -43
  71. data/cruft.md +0 -19
  72. data/lib/active_model/array_serializer.rb +0 -104
  73. data/lib/active_model/serializer/associations.rb +0 -233
  74. data/lib/active_record/serializer_override.rb +0 -16
  75. data/lib/generators/resource_override.rb +0 -13
  76. data/test/association_test.rb +0 -592
  77. data/test/caching_test.rb +0 -96
  78. data/test/no_serialization_scope_test.rb +0 -34
  79. data/test/serialization_test.rb +0 -392
  80. data/test/serializer_support_test.rb +0 -51
  81. data/test/serializer_test.rb +0 -1465
  82. data/test/test_fakes.rb +0 -217
@@ -1,392 +0,0 @@
1
- require 'test_helper'
2
- require 'pathname'
3
-
4
- class RenderJsonTest < ActionController::TestCase
5
- class JsonRenderable
6
- def as_json(options={})
7
- hash = { :a => :b, :c => :d, :e => :f }
8
- hash.except!(*options[:except]) if options[:except]
9
- hash
10
- end
11
-
12
- def to_json(options = {})
13
- super :except => [:c, :e]
14
- end
15
- end
16
-
17
- class JsonSerializer
18
- def initialize(object, options={})
19
- @object, @options = object, options
20
- end
21
-
22
- def as_json(*)
23
- hash = { :object => serializable_hash, :scope => @options[:scope].as_json }
24
- hash.merge!(:options => true) if @options[:options]
25
- hash.merge!(:check_defaults => true) if @options[:check_defaults]
26
- hash
27
- end
28
-
29
- def serializable_hash
30
- @object.as_json
31
- end
32
- end
33
-
34
- class JsonSerializable
35
- def initialize(skip=false)
36
- @skip = skip
37
- end
38
-
39
- def active_model_serializer
40
- JsonSerializer unless @skip
41
- end
42
-
43
- def as_json(*)
44
- { :serializable_object => true }
45
- end
46
- end
47
-
48
- class CustomSerializer
49
- def initialize(*)
50
- end
51
-
52
- def as_json(*)
53
- { :hello => true }
54
- end
55
- end
56
-
57
- class AnotherCustomSerializer
58
- def initialize(*)
59
- end
60
-
61
- def as_json(*)
62
- { :rails => 'rocks' }
63
- end
64
- end
65
-
66
- class DummyCustomSerializer < ActiveModel::Serializer
67
- attributes :id
68
- end
69
-
70
- class HypermediaSerializable
71
- def active_model_serializer
72
- HypermediaSerializer
73
- end
74
- end
75
-
76
- class HypermediaSerializer < ActiveModel::Serializer
77
- def as_json(*)
78
- { :link => hypermedia_url }
79
- end
80
- end
81
-
82
- class CustomArraySerializer < ActiveModel::ArraySerializer
83
- self.root = "items"
84
- end
85
-
86
- class TestController < ActionController::Base
87
- serialization_scope :current_user
88
- attr_reader :current_user
89
-
90
- def self.controller_path
91
- 'test'
92
- end
93
-
94
- def render_json_nil
95
- render :json => nil
96
- end
97
-
98
- def render_json_render_to_string
99
- render :text => render_to_string(:json => '[]')
100
- end
101
-
102
- def render_json_hello_world
103
- render :json => ActiveSupport::JSON.encode(:hello => 'world')
104
- end
105
-
106
- def render_json_hello_world_with_status
107
- render :json => ActiveSupport::JSON.encode(:hello => 'world'), :status => 401
108
- end
109
-
110
- def render_json_hello_world_with_callback
111
- render :json => ActiveSupport::JSON.encode(:hello => 'world'), :callback => 'alert'
112
- end
113
-
114
- def render_json_with_custom_content_type
115
- render :json => ActiveSupport::JSON.encode(:hello => 'world'), :content_type => 'text/javascript'
116
- end
117
-
118
- def render_symbol_json
119
- render :json => ActiveSupport::JSON.encode(:hello => 'world')
120
- end
121
-
122
- def render_json_nil_with_custom_serializer
123
- render :json => nil, :serializer => DummyCustomSerializer
124
- end
125
-
126
-
127
- def render_json_with_extra_options
128
- render :json => JsonRenderable.new, :except => [:c, :e]
129
- end
130
-
131
- def render_json_without_options
132
- render :json => JsonRenderable.new
133
- end
134
-
135
- def render_json_with_serializer
136
- @current_user = Struct.new(:as_json).new(:current_user => true)
137
- render :json => JsonSerializable.new
138
- end
139
-
140
- def render_json_with_serializer_and_implicit_root
141
- @current_user = Struct.new(:as_json).new(:current_user => true)
142
- render :json => [JsonSerializable.new]
143
- end
144
-
145
- def render_json_with_serializer_and_options
146
- @current_user = Struct.new(:as_json).new(:current_user => true)
147
- render :json => JsonSerializable.new, :options => true
148
- end
149
-
150
- def render_json_with_serializer_and_scope_option
151
- @current_user = Struct.new(:as_json).new(:current_user => true)
152
- scope = Struct.new(:as_json).new(:current_user => false)
153
- render :json => JsonSerializable.new, :scope => scope
154
- end
155
-
156
- def render_json_with_serializer_api_but_without_serializer
157
- @current_user = Struct.new(:as_json).new(:current_user => true)
158
- render :json => JsonSerializable.new(true)
159
- end
160
-
161
- # To specify a custom serializer for an object, use :serializer.
162
- def render_json_with_custom_serializer
163
- render :json => Object.new, :serializer => CustomSerializer
164
- end
165
-
166
- # To specify a custom serializer for each item in the Array, use :each_serializer.
167
- def render_json_array_with_custom_serializer
168
- render :json => [Object.new], :each_serializer => CustomSerializer
169
- end
170
-
171
- def render_json_array_with_wrong_option
172
- render :json => [Object.new], :serializer => CustomSerializer
173
- end
174
-
175
- def render_json_with_links
176
- render :json => HypermediaSerializable.new
177
- end
178
-
179
- def render_json_array_with_no_root
180
- render :json => [], :root => false
181
- end
182
-
183
- def render_json_empty_array
184
- render :json => []
185
- end
186
-
187
- def render_json_array_with_custom_array_serializer
188
- render :json => [], :serializer => CustomArraySerializer
189
- end
190
-
191
-
192
- private
193
- def default_serializer_options
194
- defaults = {}
195
- defaults.merge!(:check_defaults => true) if params[:check_defaults]
196
- defaults.merge!(:root => :awesome) if params[:check_default_root]
197
- defaults.merge!(:scope => :current_admin) if params[:check_default_scope]
198
- defaults.merge!(:serializer => AnotherCustomSerializer) if params[:check_default_serializer]
199
- defaults.merge!(:each_serializer => AnotherCustomSerializer) if params[:check_default_each_serializer]
200
- defaults
201
- end
202
- end
203
-
204
- tests TestController
205
-
206
- def setup
207
- # enable a logger so that (e.g.) the benchmarking stuff runs, so we can get
208
- # a more accurate simulation of what happens in "real life".
209
- super
210
- @controller.logger = Logger.new(nil)
211
-
212
- @request.host = "www.nextangle.com"
213
- end
214
-
215
- def test_render_json_nil
216
- get :render_json_nil
217
- assert_equal 'null', @response.body
218
- assert_equal 'application/json', @response.content_type
219
- end
220
-
221
- def test_render_json_render_to_string
222
- get :render_json_render_to_string
223
- assert_equal '[]', @response.body
224
- end
225
-
226
- def test_render_json_nil_with_custom_serializer
227
- get :render_json_nil_with_custom_serializer
228
- assert_equal "{\"dummy_custom\":null}", @response.body
229
- end
230
-
231
- def test_render_json
232
- get :render_json_hello_world
233
- assert_equal '{"hello":"world"}', @response.body
234
- assert_equal 'application/json', @response.content_type
235
- end
236
-
237
- def test_render_json_with_status
238
- get :render_json_hello_world_with_status
239
- assert_equal '{"hello":"world"}', @response.body
240
- assert_equal 401, @response.status
241
- end
242
-
243
- def test_render_json_with_callback
244
- get :render_json_hello_world_with_callback
245
- assert_equal 'alert({"hello":"world"})', @response.body
246
- # For JSONP, Rails 3 uses application/json, but Rails 4 uses text/javascript
247
- assert_match %r(application/json|text/javascript), @response.content_type.to_s
248
- end
249
-
250
- def test_render_json_with_custom_content_type
251
- get :render_json_with_custom_content_type
252
- assert_equal '{"hello":"world"}', @response.body
253
- assert_equal 'text/javascript', @response.content_type
254
- end
255
-
256
- def test_render_symbol_json
257
- get :render_symbol_json
258
- assert_equal '{"hello":"world"}', @response.body
259
- assert_equal 'application/json', @response.content_type
260
- end
261
-
262
- def test_render_json_forwards_extra_options
263
- get :render_json_with_extra_options
264
- assert_equal '{"a":"b"}', @response.body
265
- assert_equal 'application/json', @response.content_type
266
- end
267
-
268
- def test_render_json_calls_to_json_from_object
269
- get :render_json_without_options
270
- assert_equal '{"a":"b"}', @response.body
271
- end
272
-
273
- def test_render_json_with_serializer
274
- get :render_json_with_serializer
275
- assert_match '"scope":{"current_user":true}', @response.body
276
- assert_match '"object":{"serializable_object":true}', @response.body
277
- end
278
-
279
- def test_render_json_with_serializer_checking_defaults
280
- get :render_json_with_serializer, :check_defaults => true
281
- assert_match '"scope":{"current_user":true}', @response.body
282
- assert_match '"object":{"serializable_object":true}', @response.body
283
- assert_match '"check_defaults":true', @response.body
284
- end
285
-
286
- def test_render_json_with_serializer_checking_default_serailizer
287
- get :render_json_with_serializer, :check_default_serializer => true
288
- assert_match '{"rails":"rocks"}', @response.body
289
- end
290
-
291
- def test_render_json_with_serializer_checking_default_scope
292
- get :render_json_with_serializer, :check_default_scope => true
293
- assert_match '"scope":"current_admin"', @response.body
294
- end
295
-
296
- def test_render_json_with_serializer_and_implicit_root
297
- get :render_json_with_serializer_and_implicit_root
298
- assert_match '"test":[{"serializable_object":true}]', @response.body
299
- end
300
-
301
- def test_render_json_with_serializer_and_implicit_root_checking_default_each_serailizer
302
- get :render_json_with_serializer_and_implicit_root, :check_default_each_serializer => true
303
- assert_match '"test":[{"rails":"rocks"}]', @response.body
304
- end
305
-
306
- def test_render_json_with_serializer_and_options
307
- get :render_json_with_serializer_and_options
308
- assert_match '"scope":{"current_user":true}', @response.body
309
- assert_match '"object":{"serializable_object":true}', @response.body
310
- assert_match '"options":true', @response.body
311
- end
312
-
313
- def test_render_json_with_serializer_and_scope_option
314
- get :render_json_with_serializer_and_scope_option
315
- assert_match '"scope":{"current_user":false}', @response.body
316
- end
317
-
318
- def test_render_json_with_serializer_and_scope_option_checking_default_scope
319
- get :render_json_with_serializer_and_scope_option, :check_default_scope => true
320
- assert_match '"scope":{"current_user":false}', @response.body
321
- end
322
-
323
- def test_render_json_with_serializer_api_but_without_serializer
324
- get :render_json_with_serializer_api_but_without_serializer
325
- assert_match '{"serializable_object":true}', @response.body
326
- end
327
-
328
- def test_render_json_with_custom_serializer
329
- get :render_json_with_custom_serializer
330
- assert_match '{"hello":true}', @response.body
331
- end
332
-
333
- def test_render_json_with_custom_serializer_checking_default_serailizer
334
- get :render_json_with_custom_serializer, :check_default_serializer => true
335
- assert_match '{"hello":true}', @response.body
336
- end
337
-
338
- def test_render_json_array_with_custom_serializer
339
- get :render_json_array_with_custom_serializer
340
- assert_match '{"test":[{"hello":true}]}', @response.body
341
- end
342
-
343
- def test_render_json_array_with_wrong_option
344
- assert_raise ArgumentError do
345
- get :render_json_array_with_wrong_option
346
- end
347
- end
348
-
349
- def test_render_json_array_with_custom_serializer_checking_default_each_serailizer
350
- get :render_json_array_with_custom_serializer, :check_default_each_serializer => true
351
- assert_match '{"test":[{"hello":true}]}', @response.body
352
- end
353
-
354
- def test_render_json_with_links
355
- get :render_json_with_links
356
- assert_match '{"link":"http://www.nextangle.com/hypermedia"}', @response.body
357
- end
358
-
359
- def test_render_json_array_with_no_root
360
- get :render_json_array_with_no_root
361
- assert_equal '[]', @response.body
362
- end
363
-
364
- def test_render_json_array_with_no_root_checking_default_root
365
- get :render_json_array_with_no_root, :check_default_root => true
366
- assert_equal '[]', @response.body
367
- end
368
-
369
- def test_render_json_empty_array
370
- get :render_json_empty_array
371
- assert_equal '{"test":[]}', @response.body
372
- end
373
-
374
- def test_render_json_empty_array_checking_default_root
375
- get :render_json_empty_array, :check_default_root => true
376
- assert_equal '{"awesome":[]}', @response.body
377
- end
378
-
379
- def test_render_json_empty_array_with_array_serializer_root_false
380
- ActiveModel::ArraySerializer.root = false
381
- get :render_json_empty_array
382
- assert_equal '[]', @response.body
383
- ensure # teardown
384
- ActiveModel::ArraySerializer.root = nil
385
- end
386
-
387
- def test_render_json_array_with_custom_array_serializer
388
- get :render_json_array_with_custom_array_serializer
389
- assert_equal '{"items":[]}', @response.body
390
- end
391
-
392
- end
@@ -1,51 +0,0 @@
1
- require "test_helper"
2
-
3
- class RandomModel
4
- include ActiveModel::SerializerSupport
5
- end
6
-
7
- class OtherRandomModel
8
- include ActiveModel::SerializerSupport
9
- end
10
-
11
- class OtherRandomModelSerializer
12
- end
13
-
14
- class RandomModelCollection
15
- include ActiveModel::ArraySerializerSupport
16
- end
17
-
18
- module ActiveRecord
19
- class Relation
20
- end
21
- end
22
-
23
- module Mongoid
24
- class Criteria
25
- end
26
- end
27
-
28
- class SerializerSupportTest < ActiveModel::TestCase
29
- test "it returns nil if no serializer exists" do
30
- assert_equal nil, RandomModel.new.active_model_serializer
31
- end
32
-
33
- test "it returns a deducted serializer if it exists exists" do
34
- assert_equal OtherRandomModelSerializer, OtherRandomModel.new.active_model_serializer
35
- end
36
-
37
- test "it returns ArraySerializer for a collection" do
38
- assert_equal ActiveModel::ArraySerializer, RandomModelCollection.new.active_model_serializer
39
- end
40
-
41
- test "it automatically includes array_serializer in active_record/relation" do
42
- ActiveSupport.run_load_hooks(:active_record)
43
- assert_equal ActiveModel::ArraySerializer, ActiveRecord::Relation.new.active_model_serializer
44
- end
45
-
46
- test "it automatically includes array_serializer in mongoid/criteria" do
47
- ActiveSupport.run_load_hooks(:mongoid)
48
- assert_equal ActiveModel::ArraySerializer, Mongoid::Criteria.new.active_model_serializer
49
- end
50
- end
51
-