active_model_serializers 0.8.3 → 0.10.0.rc4
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.gitignore +6 -0
- data/.rubocop.yml +86 -0
- data/.rubocop_todo.yml +240 -0
- data/.simplecov +111 -0
- data/.travis.yml +33 -22
- data/CHANGELOG.md +358 -6
- data/CONTRIBUTING.md +220 -0
- data/Gemfile +46 -1
- data/{MIT-LICENSE.txt → LICENSE.txt} +3 -2
- data/README.md +81 -591
- data/Rakefile +68 -11
- data/active_model_serializers.gemspec +57 -23
- data/appveyor.yml +27 -0
- data/docs/ARCHITECTURE.md +120 -0
- data/docs/DESIGN.textile +8 -0
- data/docs/README.md +35 -0
- data/docs/general/adapters.md +162 -0
- data/docs/general/caching.md +52 -0
- data/docs/general/configuration_options.md +27 -0
- data/docs/general/getting_started.md +98 -0
- data/docs/general/instrumentation.md +40 -0
- data/docs/general/logging.md +14 -0
- data/docs/general/rendering.md +153 -0
- data/docs/general/serializers.md +207 -0
- data/docs/how-open-source-maintained.jpg +0 -0
- data/docs/howto/add_pagination_links.md +121 -0
- data/docs/howto/add_root_key.md +51 -0
- data/docs/howto/outside_controller_use.md +58 -0
- data/docs/howto/test.md +152 -0
- data/docs/integrations/ember-and-json-api.md +112 -0
- data/docs/integrations/grape.md +19 -0
- data/docs/jsonapi/schema/schema.json +366 -0
- data/docs/jsonapi/schema.md +140 -0
- data/lib/action_controller/serialization.rb +41 -37
- data/lib/active_model/serializable_resource.rb +72 -0
- data/lib/active_model/serializer/adapter/attributes.rb +66 -0
- data/lib/active_model/serializer/adapter/base.rb +58 -0
- data/lib/active_model/serializer/adapter/cached_serializer.rb +45 -0
- data/lib/active_model/serializer/adapter/fragment_cache.rb +111 -0
- data/lib/active_model/serializer/adapter/json/fragment_cache.rb +13 -0
- data/lib/active_model/serializer/adapter/json.rb +21 -0
- data/lib/active_model/serializer/adapter/json_api/deserialization.rb +207 -0
- data/lib/active_model/serializer/adapter/json_api/fragment_cache.rb +21 -0
- data/lib/active_model/serializer/adapter/json_api/link.rb +44 -0
- data/lib/active_model/serializer/adapter/json_api/pagination_links.rb +58 -0
- data/lib/active_model/serializer/adapter/json_api.rb +223 -0
- data/lib/active_model/serializer/adapter/null.rb +11 -0
- data/lib/active_model/serializer/adapter.rb +91 -0
- data/lib/active_model/serializer/array_serializer.rb +9 -0
- data/lib/active_model/serializer/association.rb +20 -0
- data/lib/active_model/serializer/associations.rb +87 -220
- data/lib/active_model/serializer/attribute.rb +25 -0
- data/lib/active_model/serializer/attributes.rb +82 -0
- data/lib/active_model/serializer/belongs_to_reflection.rb +10 -0
- data/lib/active_model/serializer/caching.rb +100 -0
- data/lib/active_model/serializer/collection_reflection.rb +7 -0
- data/lib/active_model/serializer/collection_serializer.rb +47 -0
- data/lib/active_model/serializer/configuration.rb +28 -0
- data/lib/active_model/serializer/field.rb +56 -0
- data/lib/active_model/serializer/fieldset.rb +31 -0
- data/lib/active_model/serializer/has_many_reflection.rb +10 -0
- data/lib/active_model/serializer/has_one_reflection.rb +10 -0
- data/lib/active_model/serializer/include_tree.rb +111 -0
- data/lib/active_model/serializer/links.rb +33 -0
- data/lib/active_model/serializer/lint.rb +142 -0
- data/lib/active_model/serializer/reflection.rb +91 -0
- data/lib/active_model/serializer/singular_reflection.rb +7 -0
- data/lib/active_model/serializer/type.rb +25 -0
- data/lib/active_model/{serializers → serializer}/version.rb +1 -1
- data/lib/active_model/serializer.rb +99 -479
- data/lib/active_model_serializers/callbacks.rb +55 -0
- data/lib/active_model_serializers/deserialization.rb +13 -0
- data/lib/active_model_serializers/logging.rb +119 -0
- data/lib/active_model_serializers/model.rb +39 -0
- data/lib/active_model_serializers/railtie.rb +38 -0
- data/lib/active_model_serializers/serialization_context.rb +10 -0
- data/lib/active_model_serializers/test/schema.rb +103 -0
- data/lib/active_model_serializers/test/serializer.rb +125 -0
- data/lib/active_model_serializers/test.rb +7 -0
- data/lib/active_model_serializers.rb +20 -92
- 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 +8 -0
- data/lib/grape/active_model_serializers.rb +14 -0
- data/lib/grape/formatters/active_model_serializers.rb +15 -0
- data/lib/grape/helpers/active_model_serializers.rb +16 -0
- data/test/action_controller/adapter_selector_test.rb +53 -0
- data/test/action_controller/explicit_serializer_test.rb +134 -0
- data/test/action_controller/json/include_test.rb +167 -0
- data/test/action_controller/json_api/deserialization_test.rb +59 -0
- data/test/action_controller/json_api/linked_test.rb +196 -0
- data/test/action_controller/json_api/pagination_test.rb +116 -0
- data/test/{serialization_scope_name_test.rb → action_controller/serialization_scope_name_test.rb} +11 -15
- data/test/action_controller/serialization_test.rb +435 -0
- data/test/active_model_serializers/logging_test.rb +77 -0
- data/test/active_model_serializers/model_test.rb +9 -0
- data/test/active_model_serializers/railtie_test_isolated.rb +57 -0
- data/test/active_model_serializers/serialization_context_test.rb +18 -0
- data/test/active_model_serializers/test/schema_test.rb +128 -0
- data/test/active_model_serializers/test/serializer_test.rb +63 -0
- data/test/active_record_test.rb +9 -0
- data/test/adapter/fragment_cache_test.rb +38 -0
- data/test/adapter/json/belongs_to_test.rb +47 -0
- data/test/adapter/json/collection_test.rb +92 -0
- data/test/adapter/json/has_many_test.rb +47 -0
- data/test/adapter/json_api/belongs_to_test.rb +157 -0
- data/test/adapter/json_api/collection_test.rb +97 -0
- data/test/adapter/json_api/fields_test.rb +89 -0
- data/test/adapter/json_api/has_many_embed_ids_test.rb +45 -0
- data/test/adapter/json_api/has_many_explicit_serializer_test.rb +98 -0
- data/test/adapter/json_api/has_many_test.rb +145 -0
- data/test/adapter/json_api/has_one_test.rb +81 -0
- data/test/adapter/json_api/json_api_test.rb +37 -0
- data/test/adapter/json_api/linked_test.rb +394 -0
- data/test/adapter/json_api/links_test.rb +68 -0
- data/test/adapter/json_api/pagination_links_test.rb +115 -0
- data/test/adapter/json_api/parse_test.rb +139 -0
- data/test/adapter/json_api/resource_type_config_test.rb +71 -0
- data/test/adapter/json_api/toplevel_jsonapi_test.rb +84 -0
- data/test/adapter/json_test.rb +47 -0
- data/test/adapter/null_test.rb +25 -0
- data/test/adapter_test.rb +42 -0
- data/test/array_serializer_test.rb +36 -73
- data/test/collection_serializer_test.rb +100 -0
- data/test/fixtures/active_record.rb +56 -0
- data/test/fixtures/poro.rb +229 -0
- data/test/generators/scaffold_controller_generator_test.rb +24 -0
- data/test/generators/serializer_generator_test.rb +57 -0
- data/test/grape_test.rb +82 -0
- data/test/include_tree/from_include_args_test.rb +26 -0
- data/test/include_tree/from_string_test.rb +94 -0
- data/test/include_tree/include_args_to_hash_test.rb +64 -0
- data/test/lint_test.rb +40 -0
- data/test/logger_test.rb +18 -0
- data/test/poro_test.rb +9 -0
- data/test/serializable_resource_test.rb +27 -0
- data/test/serializers/adapter_for_test.rb +166 -0
- data/test/serializers/association_macros_test.rb +36 -0
- data/test/serializers/associations_test.rb +267 -0
- data/test/serializers/attribute_test.rb +123 -0
- data/test/serializers/attributes_test.rb +52 -0
- data/test/serializers/cache_test.rb +209 -0
- data/test/serializers/configuration_test.rb +32 -0
- data/test/serializers/fieldset_test.rb +14 -0
- data/test/serializers/meta_test.rb +130 -0
- data/test/serializers/options_test.rb +21 -0
- data/test/serializers/root_test.rb +21 -0
- data/test/serializers/serializer_for_test.rb +134 -0
- data/test/support/custom_schemas/active_model_serializers/test/schema_test/my/index.json +6 -0
- data/test/support/isolated_unit.rb +77 -0
- data/test/support/rails5_shims.rb +29 -0
- data/test/support/rails_app.rb +25 -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 +53 -0
- data/test/support/simplecov.rb +6 -0
- data/test/support/stream_capture.rb +50 -0
- data/test/support/test_case.rb +19 -0
- data/test/test_helper.rb +55 -24
- metadata +358 -42
- data/DESIGN.textile +0 -586
- data/Gemfile.edge +0 -9
- data/bench/perf.rb +0 -43
- data/cruft.md +0 -19
- data/lib/active_model/array_serializer.rb +0 -104
- data/lib/active_record/serializer_override.rb +0 -16
- data/lib/generators/resource_override.rb +0 -13
- data/lib/generators/serializer/USAGE +0 -9
- data/lib/generators/serializer/serializer_generator.rb +0 -42
- data/lib/generators/serializer/templates/serializer.rb +0 -19
- data/test/association_test.rb +0 -592
- data/test/caching_test.rb +0 -96
- data/test/generators_test.rb +0 -85
- data/test/no_serialization_scope_test.rb +0 -34
- data/test/serialization_test.rb +0 -392
- data/test/serializer_support_test.rb +0 -51
- data/test/serializer_test.rb +0 -1465
- data/test/test_fakes.rb +0 -217
@@ -0,0 +1,166 @@
|
|
1
|
+
module ActiveModel
|
2
|
+
class Serializer
|
3
|
+
class AdapterForTest < ActiveSupport::TestCase
|
4
|
+
UnknownAdapterError = ::ActiveModel::Serializer::Adapter::UnknownAdapterError
|
5
|
+
|
6
|
+
def setup
|
7
|
+
@previous_adapter = ActiveModelSerializers.config.adapter
|
8
|
+
end
|
9
|
+
|
10
|
+
def teardown
|
11
|
+
ActiveModelSerializers.config.adapter = @previous_adapter
|
12
|
+
end
|
13
|
+
|
14
|
+
def test_returns_default_adapter
|
15
|
+
adapter = ActiveModel::Serializer.adapter
|
16
|
+
assert_equal ActiveModel::Serializer::Adapter::Attributes, adapter
|
17
|
+
end
|
18
|
+
|
19
|
+
def test_overwrite_adapter_with_symbol
|
20
|
+
ActiveModelSerializers.config.adapter = :null
|
21
|
+
|
22
|
+
adapter = ActiveModel::Serializer.adapter
|
23
|
+
assert_equal ActiveModel::Serializer::Adapter::Null, adapter
|
24
|
+
ensure
|
25
|
+
ActiveModelSerializers.config.adapter = @previous_adapter
|
26
|
+
end
|
27
|
+
|
28
|
+
def test_overwrite_adapter_with_class
|
29
|
+
ActiveModelSerializers.config.adapter = ActiveModel::Serializer::Adapter::Null
|
30
|
+
|
31
|
+
adapter = ActiveModel::Serializer.adapter
|
32
|
+
assert_equal ActiveModel::Serializer::Adapter::Null, adapter
|
33
|
+
end
|
34
|
+
|
35
|
+
def test_raises_exception_if_invalid_symbol_given
|
36
|
+
ActiveModelSerializers.config.adapter = :unknown
|
37
|
+
|
38
|
+
assert_raises UnknownAdapterError do
|
39
|
+
ActiveModel::Serializer.adapter
|
40
|
+
end
|
41
|
+
end
|
42
|
+
|
43
|
+
def test_raises_exception_if_it_does_not_know_hot_to_infer_adapter
|
44
|
+
ActiveModelSerializers.config.adapter = 42
|
45
|
+
|
46
|
+
assert_raises UnknownAdapterError do
|
47
|
+
ActiveModel::Serializer.adapter
|
48
|
+
end
|
49
|
+
end
|
50
|
+
|
51
|
+
def test_adapter_class_for_known_adapter
|
52
|
+
klass = ActiveModel::Serializer::Adapter.adapter_class(:json_api)
|
53
|
+
assert_equal ActiveModel::Serializer::Adapter::JsonApi, klass
|
54
|
+
end
|
55
|
+
|
56
|
+
def test_adapter_class_for_unknown_adapter
|
57
|
+
assert_raises UnknownAdapterError do
|
58
|
+
ActiveModel::Serializer::Adapter.adapter_class(:json_simple)
|
59
|
+
end
|
60
|
+
end
|
61
|
+
|
62
|
+
def test_adapter_map
|
63
|
+
expected_adapter_map = {
|
64
|
+
'null'.freeze => ActiveModel::Serializer::Adapter::Null,
|
65
|
+
'json'.freeze => ActiveModel::Serializer::Adapter::Json,
|
66
|
+
'attributes'.freeze => ActiveModel::Serializer::Adapter::Attributes,
|
67
|
+
'json_api'.freeze => ActiveModel::Serializer::Adapter::JsonApi
|
68
|
+
}
|
69
|
+
actual = ActiveModel::Serializer::Adapter.adapter_map
|
70
|
+
assert_equal actual, expected_adapter_map
|
71
|
+
end
|
72
|
+
|
73
|
+
def test_adapters
|
74
|
+
assert_equal ActiveModel::Serializer::Adapter.adapters.sort, [
|
75
|
+
'attributes'.freeze,
|
76
|
+
'json'.freeze,
|
77
|
+
'json_api'.freeze,
|
78
|
+
'null'.freeze
|
79
|
+
]
|
80
|
+
end
|
81
|
+
|
82
|
+
def test_lookup_adapter_by_string_name
|
83
|
+
assert_equal ActiveModel::Serializer::Adapter.lookup('json'.freeze), ActiveModel::Serializer::Adapter::Json
|
84
|
+
end
|
85
|
+
|
86
|
+
def test_lookup_adapter_by_symbol_name
|
87
|
+
assert_equal ActiveModel::Serializer::Adapter.lookup(:json), ActiveModel::Serializer::Adapter::Json
|
88
|
+
end
|
89
|
+
|
90
|
+
def test_lookup_adapter_by_class
|
91
|
+
klass = ActiveModel::Serializer::Adapter::Json
|
92
|
+
assert_equal ActiveModel::Serializer::Adapter.lookup(klass), klass
|
93
|
+
end
|
94
|
+
|
95
|
+
def test_lookup_adapter_from_environment_registers_adapter
|
96
|
+
ActiveModel::Serializer::Adapter.const_set(:AdapterFromEnvironment, Class.new)
|
97
|
+
klass = ::ActiveModel::Serializer::Adapter::AdapterFromEnvironment
|
98
|
+
name = 'adapter_from_environment'.freeze
|
99
|
+
assert_equal ActiveModel::Serializer::Adapter.lookup(name), klass
|
100
|
+
assert ActiveModel::Serializer::Adapter.adapters.include?(name)
|
101
|
+
ensure
|
102
|
+
ActiveModel::Serializer::Adapter.adapter_map.delete(name)
|
103
|
+
ActiveModel::Serializer::Adapter.send(:remove_const, :AdapterFromEnvironment)
|
104
|
+
end
|
105
|
+
|
106
|
+
def test_lookup_adapter_for_unknown_name
|
107
|
+
assert_raises UnknownAdapterError do
|
108
|
+
ActiveModel::Serializer::Adapter.lookup(:json_simple)
|
109
|
+
end
|
110
|
+
end
|
111
|
+
|
112
|
+
def test_adapter
|
113
|
+
assert_equal ActiveModelSerializers.config.adapter, :attributes
|
114
|
+
assert_equal ActiveModel::Serializer.adapter, ActiveModel::Serializer::Adapter::Attributes
|
115
|
+
end
|
116
|
+
|
117
|
+
def test_register_adapter
|
118
|
+
new_adapter_name = :foo
|
119
|
+
new_adapter_klass = Class.new
|
120
|
+
ActiveModel::Serializer::Adapter.register(new_adapter_name, new_adapter_klass)
|
121
|
+
assert ActiveModel::Serializer::Adapter.adapters.include?('foo'.freeze)
|
122
|
+
assert ActiveModel::Serializer::Adapter.lookup(:foo), new_adapter_klass
|
123
|
+
ensure
|
124
|
+
ActiveModel::Serializer::Adapter.adapter_map.delete(new_adapter_name.to_s)
|
125
|
+
end
|
126
|
+
|
127
|
+
def test_inherited_adapter_hooks_register_adapter
|
128
|
+
Object.const_set(:MyAdapter, Class.new)
|
129
|
+
my_adapter = MyAdapter
|
130
|
+
ActiveModel::Serializer::Adapter::Base.inherited(my_adapter)
|
131
|
+
assert_equal ActiveModel::Serializer::Adapter.lookup(:my_adapter), my_adapter
|
132
|
+
ensure
|
133
|
+
ActiveModel::Serializer::Adapter.adapter_map.delete('my_adapter'.freeze)
|
134
|
+
Object.send(:remove_const, :MyAdapter)
|
135
|
+
end
|
136
|
+
|
137
|
+
def test_inherited_adapter_hooks_register_namespaced_adapter
|
138
|
+
Object.const_set(:MyNamespace, Module.new)
|
139
|
+
MyNamespace.const_set(:MyAdapter, Class.new)
|
140
|
+
my_adapter = MyNamespace::MyAdapter
|
141
|
+
ActiveModel::Serializer::Adapter::Base.inherited(my_adapter)
|
142
|
+
assert_equal ActiveModel::Serializer::Adapter.lookup(:'my_namespace/my_adapter'), my_adapter
|
143
|
+
ensure
|
144
|
+
ActiveModel::Serializer::Adapter.adapter_map.delete('my_namespace/my_adapter'.freeze)
|
145
|
+
MyNamespace.send(:remove_const, :MyAdapter)
|
146
|
+
Object.send(:remove_const, :MyNamespace)
|
147
|
+
end
|
148
|
+
|
149
|
+
def test_inherited_adapter_hooks_register_subclass_of_registered_adapter
|
150
|
+
Object.const_set(:MyAdapter, Class.new)
|
151
|
+
my_adapter = MyAdapter
|
152
|
+
Object.const_set(:MySubclassedAdapter, Class.new(MyAdapter))
|
153
|
+
my_subclassed_adapter = MySubclassedAdapter
|
154
|
+
ActiveModel::Serializer::Adapter::Base.inherited(my_adapter)
|
155
|
+
ActiveModel::Serializer::Adapter::Base.inherited(my_subclassed_adapter)
|
156
|
+
assert_equal ActiveModel::Serializer::Adapter.lookup(:my_adapter), my_adapter
|
157
|
+
assert_equal ActiveModel::Serializer::Adapter.lookup(:my_subclassed_adapter), my_subclassed_adapter
|
158
|
+
ensure
|
159
|
+
ActiveModel::Serializer::Adapter.adapter_map.delete('my_adapter'.freeze)
|
160
|
+
ActiveModel::Serializer::Adapter.adapter_map.delete('my_subclassed_adapter'.freeze)
|
161
|
+
Object.send(:remove_const, :MyAdapter)
|
162
|
+
Object.send(:remove_const, :MySubclassedAdapter)
|
163
|
+
end
|
164
|
+
end
|
165
|
+
end
|
166
|
+
end
|
@@ -0,0 +1,36 @@
|
|
1
|
+
require 'test_helper'
|
2
|
+
|
3
|
+
module ActiveModel
|
4
|
+
class Serializer
|
5
|
+
class AssociationMacrosTest < ActiveSupport::TestCase
|
6
|
+
AuthorSummarySerializer = Class.new
|
7
|
+
class AssociationsTestSerializer < Serializer
|
8
|
+
belongs_to :author, serializer: AuthorSummarySerializer
|
9
|
+
has_many :comments
|
10
|
+
has_one :category
|
11
|
+
end
|
12
|
+
|
13
|
+
def before_setup
|
14
|
+
@reflections = AssociationsTestSerializer._reflections
|
15
|
+
end
|
16
|
+
|
17
|
+
def test_has_one_defines_reflection
|
18
|
+
has_one_reflection = HasOneReflection.new(:category, {})
|
19
|
+
|
20
|
+
assert_includes(@reflections, has_one_reflection)
|
21
|
+
end
|
22
|
+
|
23
|
+
def test_has_many_defines_reflection
|
24
|
+
has_many_reflection = HasManyReflection.new(:comments, {})
|
25
|
+
|
26
|
+
assert_includes(@reflections, has_many_reflection)
|
27
|
+
end
|
28
|
+
|
29
|
+
def test_belongs_to_defines_reflection
|
30
|
+
belongs_to_reflection = BelongsToReflection.new(:author, serializer: AuthorSummarySerializer)
|
31
|
+
|
32
|
+
assert_includes(@reflections, belongs_to_reflection)
|
33
|
+
end
|
34
|
+
end
|
35
|
+
end
|
36
|
+
end
|
@@ -0,0 +1,267 @@
|
|
1
|
+
require 'test_helper'
|
2
|
+
|
3
|
+
module ActiveModel
|
4
|
+
class Serializer
|
5
|
+
class AssociationsTest < ActiveSupport::TestCase
|
6
|
+
def setup
|
7
|
+
@author = Author.new(name: 'Steve K.')
|
8
|
+
@author.bio = nil
|
9
|
+
@author.roles = []
|
10
|
+
@blog = Blog.new({ name: 'AMS Blog' })
|
11
|
+
@post = Post.new({ title: 'New Post', body: 'Body' })
|
12
|
+
@tag = Tag.new({ name: '#hashtagged' })
|
13
|
+
@comment = Comment.new({ id: 1, body: 'ZOMG A COMMENT' })
|
14
|
+
@post.comments = [@comment]
|
15
|
+
@post.tags = [@tag]
|
16
|
+
@post.blog = @blog
|
17
|
+
@comment.post = @post
|
18
|
+
@comment.author = nil
|
19
|
+
@post.author = @author
|
20
|
+
@author.posts = [@post]
|
21
|
+
|
22
|
+
@post_serializer = PostSerializer.new(@post, { custom_options: true })
|
23
|
+
@author_serializer = AuthorSerializer.new(@author)
|
24
|
+
@comment_serializer = CommentSerializer.new(@comment)
|
25
|
+
end
|
26
|
+
|
27
|
+
def test_has_many_and_has_one
|
28
|
+
@author_serializer.associations.each do |association|
|
29
|
+
key = association.key
|
30
|
+
serializer = association.serializer
|
31
|
+
options = association.options
|
32
|
+
|
33
|
+
case key
|
34
|
+
when :posts
|
35
|
+
assert_equal({}, options)
|
36
|
+
assert_kind_of(ActiveModelSerializers.config.collection_serializer, serializer)
|
37
|
+
when :bio
|
38
|
+
assert_equal({}, options)
|
39
|
+
assert_nil serializer
|
40
|
+
when :roles
|
41
|
+
assert_equal({}, options)
|
42
|
+
assert_kind_of(ActiveModelSerializers.config.collection_serializer, serializer)
|
43
|
+
else
|
44
|
+
flunk "Unknown association: #{key}"
|
45
|
+
end
|
46
|
+
end
|
47
|
+
end
|
48
|
+
|
49
|
+
def test_has_many_with_no_serializer
|
50
|
+
PostWithTagsSerializer.new(@post).associations.each do |association|
|
51
|
+
key = association.key
|
52
|
+
serializer = association.serializer
|
53
|
+
options = association.options
|
54
|
+
|
55
|
+
assert_equal :tags, key
|
56
|
+
assert_nil serializer
|
57
|
+
assert_equal [{ name: '#hashtagged' }].to_json, options[:virtual_value].to_json
|
58
|
+
end
|
59
|
+
end
|
60
|
+
|
61
|
+
def test_serializer_options_are_passed_into_associations_serializers
|
62
|
+
association = @post_serializer
|
63
|
+
.associations
|
64
|
+
.detect { |assoc| assoc.key == :comments }
|
65
|
+
|
66
|
+
assert association.serializer.first.custom_options[:custom_options]
|
67
|
+
end
|
68
|
+
|
69
|
+
def test_belongs_to
|
70
|
+
@comment_serializer.associations.each do |association|
|
71
|
+
key = association.key
|
72
|
+
serializer = association.serializer
|
73
|
+
|
74
|
+
case key
|
75
|
+
when :post
|
76
|
+
assert_kind_of(PostSerializer, serializer)
|
77
|
+
when :author
|
78
|
+
assert_nil serializer
|
79
|
+
else
|
80
|
+
flunk "Unknown association: #{key}"
|
81
|
+
end
|
82
|
+
|
83
|
+
assert_equal({}, association.options)
|
84
|
+
end
|
85
|
+
end
|
86
|
+
|
87
|
+
def test_belongs_to_with_custom_method
|
88
|
+
assert(
|
89
|
+
@post_serializer.associations.any? do |association|
|
90
|
+
association.key == :blog
|
91
|
+
end
|
92
|
+
)
|
93
|
+
end
|
94
|
+
|
95
|
+
def test_associations_inheritance
|
96
|
+
inherited_klass = Class.new(PostSerializer)
|
97
|
+
|
98
|
+
assert_equal(PostSerializer._reflections, inherited_klass._reflections)
|
99
|
+
end
|
100
|
+
|
101
|
+
def test_associations_inheritance_with_new_association
|
102
|
+
inherited_klass = Class.new(PostSerializer) do
|
103
|
+
has_many :top_comments, serializer: CommentSerializer
|
104
|
+
end
|
105
|
+
|
106
|
+
assert(
|
107
|
+
PostSerializer._reflections.all? do |reflection|
|
108
|
+
inherited_klass._reflections.include?(reflection)
|
109
|
+
end
|
110
|
+
)
|
111
|
+
|
112
|
+
assert(
|
113
|
+
inherited_klass._reflections.any? do |reflection|
|
114
|
+
reflection.name == :top_comments
|
115
|
+
end
|
116
|
+
)
|
117
|
+
end
|
118
|
+
|
119
|
+
def test_associations_custom_keys
|
120
|
+
serializer = PostWithCustomKeysSerializer.new(@post)
|
121
|
+
|
122
|
+
expected_association_keys = serializer.associations.map(&:key)
|
123
|
+
|
124
|
+
assert expected_association_keys.include? :reviews
|
125
|
+
assert expected_association_keys.include? :writer
|
126
|
+
assert expected_association_keys.include? :site
|
127
|
+
end
|
128
|
+
|
129
|
+
class InlineAssociationTestPostSerializer < ActiveModel::Serializer
|
130
|
+
has_many :comments
|
131
|
+
has_many :comments, key: :last_comments do
|
132
|
+
object.comments.last(1)
|
133
|
+
end
|
134
|
+
end
|
135
|
+
|
136
|
+
def test_virtual_attribute_block
|
137
|
+
comment1 = ::ARModels::Comment.create!(contents: 'first comment')
|
138
|
+
comment2 = ::ARModels::Comment.create!(contents: 'last comment')
|
139
|
+
post = ::ARModels::Post.create!(
|
140
|
+
title: 'inline association test',
|
141
|
+
body: 'etc',
|
142
|
+
comments: [comment1, comment2]
|
143
|
+
)
|
144
|
+
actual = serializable(post, adapter: :attributes, serializer: InlineAssociationTestPostSerializer).as_json
|
145
|
+
expected = {
|
146
|
+
:comments => [
|
147
|
+
{ :id => 1, :contents => 'first comment' },
|
148
|
+
{ :id => 2, :contents => 'last comment' }
|
149
|
+
],
|
150
|
+
:last_comments => [
|
151
|
+
{ :id => 2, :contents => 'last comment' }
|
152
|
+
]
|
153
|
+
}
|
154
|
+
|
155
|
+
assert_equal expected, actual
|
156
|
+
ensure
|
157
|
+
::ARModels::Post.delete_all
|
158
|
+
::ARModels::Comment.delete_all
|
159
|
+
end
|
160
|
+
|
161
|
+
class NamespacedResourcesTest < ActiveSupport::TestCase
|
162
|
+
class ResourceNamespace
|
163
|
+
Post = Class.new(::Model)
|
164
|
+
Comment = Class.new(::Model)
|
165
|
+
Author = Class.new(::Model)
|
166
|
+
Description = Class.new(::Model)
|
167
|
+
class PostSerializer < ActiveModel::Serializer
|
168
|
+
has_many :comments
|
169
|
+
belongs_to :author
|
170
|
+
has_one :description
|
171
|
+
end
|
172
|
+
CommentSerializer = Class.new(ActiveModel::Serializer)
|
173
|
+
AuthorSerializer = Class.new(ActiveModel::Serializer)
|
174
|
+
DescriptionSerializer = Class.new(ActiveModel::Serializer)
|
175
|
+
end
|
176
|
+
|
177
|
+
def setup
|
178
|
+
@comment = ResourceNamespace::Comment.new
|
179
|
+
@author = ResourceNamespace::Author.new
|
180
|
+
@description = ResourceNamespace::Description.new
|
181
|
+
@post = ResourceNamespace::Post.new(comments: [@comment],
|
182
|
+
author: @author,
|
183
|
+
description: @description)
|
184
|
+
@post_serializer = ResourceNamespace::PostSerializer.new(@post)
|
185
|
+
end
|
186
|
+
|
187
|
+
def test_associations_namespaced_resources
|
188
|
+
@post_serializer.associations.each do |association|
|
189
|
+
case association.key
|
190
|
+
when :comments
|
191
|
+
assert_instance_of(ResourceNamespace::CommentSerializer, association.serializer.first)
|
192
|
+
when :author
|
193
|
+
assert_instance_of(ResourceNamespace::AuthorSerializer, association.serializer)
|
194
|
+
when :description
|
195
|
+
assert_instance_of(ResourceNamespace::DescriptionSerializer, association.serializer)
|
196
|
+
else
|
197
|
+
flunk "Unknown association: #{key}"
|
198
|
+
end
|
199
|
+
end
|
200
|
+
end
|
201
|
+
end
|
202
|
+
|
203
|
+
class NestedSerializersTest < ActiveSupport::TestCase
|
204
|
+
Post = Class.new(::Model)
|
205
|
+
Comment = Class.new(::Model)
|
206
|
+
Author = Class.new(::Model)
|
207
|
+
Description = Class.new(::Model)
|
208
|
+
class PostSerializer < ActiveModel::Serializer
|
209
|
+
has_many :comments
|
210
|
+
CommentSerializer = Class.new(ActiveModel::Serializer)
|
211
|
+
belongs_to :author
|
212
|
+
AuthorSerializer = Class.new(ActiveModel::Serializer)
|
213
|
+
has_one :description
|
214
|
+
DescriptionSerializer = Class.new(ActiveModel::Serializer)
|
215
|
+
end
|
216
|
+
|
217
|
+
def setup
|
218
|
+
@comment = Comment.new
|
219
|
+
@author = Author.new
|
220
|
+
@description = Description.new
|
221
|
+
@post = Post.new(comments: [@comment],
|
222
|
+
author: @author,
|
223
|
+
description: @description)
|
224
|
+
@post_serializer = PostSerializer.new(@post)
|
225
|
+
end
|
226
|
+
|
227
|
+
def test_associations_namespaced_resources
|
228
|
+
@post_serializer.associations.each do |association|
|
229
|
+
case association.key
|
230
|
+
when :comments
|
231
|
+
assert_instance_of(PostSerializer::CommentSerializer, association.serializer.first)
|
232
|
+
when :author
|
233
|
+
assert_instance_of(PostSerializer::AuthorSerializer, association.serializer)
|
234
|
+
when :description
|
235
|
+
assert_instance_of(PostSerializer::DescriptionSerializer, association.serializer)
|
236
|
+
else
|
237
|
+
flunk "Unknown association: #{key}"
|
238
|
+
end
|
239
|
+
end
|
240
|
+
end
|
241
|
+
|
242
|
+
def test_conditional_associations
|
243
|
+
serializer = Class.new(ActiveModel::Serializer) do
|
244
|
+
belongs_to :if_assoc_included, if: :true
|
245
|
+
belongs_to :if_assoc_excluded, if: :false
|
246
|
+
belongs_to :unless_assoc_included, unless: :false
|
247
|
+
belongs_to :unless_assoc_excluded, unless: :true
|
248
|
+
|
249
|
+
def true
|
250
|
+
true
|
251
|
+
end
|
252
|
+
|
253
|
+
def false
|
254
|
+
false
|
255
|
+
end
|
256
|
+
end
|
257
|
+
|
258
|
+
model = ::Model.new
|
259
|
+
hash = serializable(model, serializer: serializer).serializable_hash
|
260
|
+
expected = { if_assoc_included: nil, unless_assoc_included: nil }
|
261
|
+
|
262
|
+
assert_equal(expected, hash)
|
263
|
+
end
|
264
|
+
end
|
265
|
+
end
|
266
|
+
end
|
267
|
+
end
|
@@ -0,0 +1,123 @@
|
|
1
|
+
require 'test_helper'
|
2
|
+
|
3
|
+
module ActiveModel
|
4
|
+
class Serializer
|
5
|
+
class AttributeTest < ActiveSupport::TestCase
|
6
|
+
def setup
|
7
|
+
@blog = Blog.new(id: 1, name: 'AMS Hints', type: 'stuff')
|
8
|
+
@blog_serializer = AlternateBlogSerializer.new(@blog)
|
9
|
+
end
|
10
|
+
|
11
|
+
def test_attributes_definition
|
12
|
+
assert_equal([:id, :title],
|
13
|
+
@blog_serializer.class._attributes)
|
14
|
+
end
|
15
|
+
|
16
|
+
def test_json_serializable_hash
|
17
|
+
adapter = ActiveModel::Serializer::Adapter::Json.new(@blog_serializer)
|
18
|
+
assert_equal({ blog: { id: 1, title: 'AMS Hints' } }, adapter.serializable_hash)
|
19
|
+
end
|
20
|
+
|
21
|
+
def test_attribute_inheritance_with_key
|
22
|
+
inherited_klass = Class.new(AlternateBlogSerializer)
|
23
|
+
blog_serializer = inherited_klass.new(@blog)
|
24
|
+
adapter = ActiveModel::Serializer::Adapter::Attributes.new(blog_serializer)
|
25
|
+
assert_equal({ :id => 1, :title => 'AMS Hints' }, adapter.serializable_hash)
|
26
|
+
end
|
27
|
+
|
28
|
+
def test_multiple_calls_with_the_same_attribute
|
29
|
+
serializer_class = Class.new(ActiveModel::Serializer) do
|
30
|
+
attribute :title
|
31
|
+
attribute :title
|
32
|
+
end
|
33
|
+
|
34
|
+
assert_equal([:title], serializer_class._attributes)
|
35
|
+
end
|
36
|
+
|
37
|
+
def test_id_attribute_override
|
38
|
+
serializer = Class.new(ActiveModel::Serializer) do
|
39
|
+
attribute :name, key: :id
|
40
|
+
end
|
41
|
+
|
42
|
+
adapter = ActiveModel::Serializer::Adapter::Json.new(serializer.new(@blog))
|
43
|
+
assert_equal({ blog: { id: 'AMS Hints' } }, adapter.serializable_hash)
|
44
|
+
end
|
45
|
+
|
46
|
+
def test_object_attribute_override
|
47
|
+
serializer = Class.new(ActiveModel::Serializer) do
|
48
|
+
attribute :name, key: :object
|
49
|
+
end
|
50
|
+
|
51
|
+
adapter = ActiveModel::Serializer::Adapter::Json.new(serializer.new(@blog))
|
52
|
+
assert_equal({ blog: { object: 'AMS Hints' } }, adapter.serializable_hash)
|
53
|
+
end
|
54
|
+
|
55
|
+
def test_type_attribute
|
56
|
+
attribute_serializer = Class.new(ActiveModel::Serializer) do
|
57
|
+
attribute :id, key: :type
|
58
|
+
end
|
59
|
+
attributes_serializer = Class.new(ActiveModel::Serializer) do
|
60
|
+
attributes :type
|
61
|
+
end
|
62
|
+
|
63
|
+
adapter = ActiveModel::Serializer::Adapter::Json.new(attribute_serializer.new(@blog))
|
64
|
+
assert_equal({ blog: { type: 1 } }, adapter.serializable_hash)
|
65
|
+
|
66
|
+
adapter = ActiveModel::Serializer::Adapter::Json.new(attributes_serializer.new(@blog))
|
67
|
+
assert_equal({ blog: { type: 'stuff' } }, adapter.serializable_hash)
|
68
|
+
end
|
69
|
+
|
70
|
+
def test_id_attribute_override_before
|
71
|
+
serializer = Class.new(ActiveModel::Serializer) do
|
72
|
+
def id
|
73
|
+
'custom'
|
74
|
+
end
|
75
|
+
|
76
|
+
attribute :id
|
77
|
+
end
|
78
|
+
|
79
|
+
hash = ActiveModel::SerializableResource.new(@blog, adapter: :json, serializer: serializer).serializable_hash
|
80
|
+
|
81
|
+
assert_equal('custom', hash[:blog][:id])
|
82
|
+
end
|
83
|
+
|
84
|
+
PostWithVirtualAttribute = Class.new(::Model)
|
85
|
+
class PostWithVirtualAttributeSerializer < ActiveModel::Serializer
|
86
|
+
attribute :name do
|
87
|
+
"#{object.first_name} #{object.last_name}"
|
88
|
+
end
|
89
|
+
end
|
90
|
+
|
91
|
+
def test_virtual_attribute_block
|
92
|
+
post = PostWithVirtualAttribute.new(first_name: 'Lucas', last_name: 'Hosseini')
|
93
|
+
hash = serializable(post).serializable_hash
|
94
|
+
expected = { name: 'Lucas Hosseini' }
|
95
|
+
|
96
|
+
assert_equal(expected, hash)
|
97
|
+
end
|
98
|
+
|
99
|
+
def test_conditional_attributes
|
100
|
+
serializer = Class.new(ActiveModel::Serializer) do
|
101
|
+
attribute :if_attribute_included, if: :true
|
102
|
+
attribute :if_attribute_excluded, if: :false
|
103
|
+
attribute :unless_attribute_included, unless: :false
|
104
|
+
attribute :unless_attribute_excluded, unless: :true
|
105
|
+
|
106
|
+
def true
|
107
|
+
true
|
108
|
+
end
|
109
|
+
|
110
|
+
def false
|
111
|
+
false
|
112
|
+
end
|
113
|
+
end
|
114
|
+
|
115
|
+
model = ::Model.new
|
116
|
+
hash = serializable(model, serializer: serializer).serializable_hash
|
117
|
+
expected = { if_attribute_included: nil, unless_attribute_included: nil }
|
118
|
+
|
119
|
+
assert_equal(expected, hash)
|
120
|
+
end
|
121
|
+
end
|
122
|
+
end
|
123
|
+
end
|
@@ -0,0 +1,52 @@
|
|
1
|
+
require 'test_helper'
|
2
|
+
|
3
|
+
module ActiveModel
|
4
|
+
class Serializer
|
5
|
+
class AttributesTest < ActiveSupport::TestCase
|
6
|
+
def setup
|
7
|
+
@profile = Profile.new({ name: 'Name 1', description: 'Description 1', comments: 'Comments 1' })
|
8
|
+
@profile_serializer = ProfileSerializer.new(@profile)
|
9
|
+
@comment = Comment.new(id: 1, body: 'ZOMG!!', date: '2015')
|
10
|
+
@serializer_klass = Class.new(CommentSerializer)
|
11
|
+
@serializer_klass_with_new_attributes = Class.new(CommentSerializer) do
|
12
|
+
attributes :date, :likes
|
13
|
+
end
|
14
|
+
end
|
15
|
+
|
16
|
+
def test_attributes_definition
|
17
|
+
assert_equal([:name, :description],
|
18
|
+
@profile_serializer.class._attributes)
|
19
|
+
end
|
20
|
+
|
21
|
+
def test_attributes_inheritance_definition
|
22
|
+
assert_equal([:id, :body], @serializer_klass._attributes)
|
23
|
+
end
|
24
|
+
|
25
|
+
def test_attributes_inheritance
|
26
|
+
serializer = @serializer_klass.new(@comment)
|
27
|
+
assert_equal({ id: 1, body: 'ZOMG!!' },
|
28
|
+
serializer.attributes)
|
29
|
+
end
|
30
|
+
|
31
|
+
def test_attribute_inheritance_with_new_attribute_definition
|
32
|
+
assert_equal([:id, :body, :date, :likes], @serializer_klass_with_new_attributes._attributes)
|
33
|
+
assert_equal([:id, :body], CommentSerializer._attributes)
|
34
|
+
end
|
35
|
+
|
36
|
+
def test_attribute_inheritance_with_new_attribute
|
37
|
+
serializer = @serializer_klass_with_new_attributes.new(@comment)
|
38
|
+
assert_equal({ id: 1, body: 'ZOMG!!', date: '2015', likes: nil },
|
39
|
+
serializer.attributes)
|
40
|
+
end
|
41
|
+
|
42
|
+
def test_multiple_calls_with_the_same_attribute
|
43
|
+
serializer_class = Class.new(ActiveModel::Serializer) do
|
44
|
+
attributes :id, :title
|
45
|
+
attributes :id, :title, :title, :body
|
46
|
+
end
|
47
|
+
|
48
|
+
assert_equal([:id, :title, :body], serializer_class._attributes)
|
49
|
+
end
|
50
|
+
end
|
51
|
+
end
|
52
|
+
end
|