active_model_serializers 0.8.3 → 0.10.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.github/ISSUE_TEMPLATE.md +29 -0
- data/.github/PULL_REQUEST_TEMPLATE.md +15 -0
- data/.gitignore +17 -0
- data/.rubocop.yml +104 -0
- data/.rubocop_todo.yml +167 -0
- data/.simplecov +110 -0
- data/.travis.yml +39 -24
- data/CHANGELOG.md +465 -6
- data/CONTRIBUTING.md +105 -0
- data/Gemfile +50 -1
- data/{MIT-LICENSE.txt → MIT-LICENSE} +3 -2
- data/README.md +102 -590
- data/Rakefile +93 -8
- data/active_model_serializers.gemspec +65 -23
- data/appveyor.yml +24 -0
- data/bin/bench +171 -0
- data/bin/bench_regression +316 -0
- data/bin/serve_benchmark +39 -0
- data/docs/ARCHITECTURE.md +126 -0
- data/docs/README.md +40 -0
- data/docs/STYLE.md +58 -0
- data/docs/general/adapters.md +245 -0
- data/docs/general/caching.md +52 -0
- data/docs/general/configuration_options.md +100 -0
- data/docs/general/deserialization.md +100 -0
- data/docs/general/getting_started.md +133 -0
- data/docs/general/instrumentation.md +40 -0
- data/docs/general/key_transforms.md +40 -0
- data/docs/general/logging.md +14 -0
- data/docs/general/rendering.md +255 -0
- data/docs/general/serializers.md +372 -0
- data/docs/how-open-source-maintained.jpg +0 -0
- data/docs/howto/add_pagination_links.md +139 -0
- data/docs/howto/add_root_key.md +51 -0
- data/docs/howto/outside_controller_use.md +58 -0
- data/docs/howto/passing_arbitrary_options.md +27 -0
- data/docs/howto/serialize_poro.md +32 -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/errors.md +56 -0
- data/docs/jsonapi/schema/schema.json +366 -0
- data/docs/jsonapi/schema.md +151 -0
- data/docs/rfcs/0000-namespace.md +106 -0
- data/docs/rfcs/template.md +15 -0
- data/lib/action_controller/serialization.rb +31 -36
- data/lib/active_model/serializable_resource.rb +11 -0
- data/lib/active_model/serializer/adapter/attributes.rb +15 -0
- data/lib/active_model/serializer/adapter/base.rb +16 -0
- data/lib/active_model/serializer/adapter/json.rb +15 -0
- data/lib/active_model/serializer/adapter/json_api.rb +15 -0
- data/lib/active_model/serializer/adapter/null.rb +15 -0
- data/lib/active_model/serializer/adapter.rb +24 -0
- data/lib/active_model/serializer/array_serializer.rb +9 -0
- data/lib/active_model/serializer/association.rb +19 -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 +333 -0
- data/lib/active_model/serializer/collection_reflection.rb +7 -0
- data/lib/active_model/serializer/collection_serializer.rb +64 -0
- data/lib/active_model/serializer/configuration.rb +35 -0
- data/lib/active_model/serializer/error_serializer.rb +10 -0
- data/lib/active_model/serializer/errors_serializer.rb +27 -0
- data/lib/active_model/serializer/field.rb +90 -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 +35 -0
- data/lib/active_model/serializer/lint.rb +146 -0
- data/lib/active_model/serializer/meta.rb +29 -0
- data/lib/active_model/serializer/null.rb +17 -0
- data/lib/active_model/serializer/reflection.rb +147 -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 +158 -481
- data/lib/active_model_serializers/adapter/attributes.rb +76 -0
- data/lib/active_model_serializers/adapter/base.rb +83 -0
- data/lib/active_model_serializers/adapter/json.rb +21 -0
- data/lib/active_model_serializers/adapter/json_api/deserialization.rb +213 -0
- data/lib/active_model_serializers/adapter/json_api/error.rb +96 -0
- data/lib/active_model_serializers/adapter/json_api/jsonapi.rb +49 -0
- data/lib/active_model_serializers/adapter/json_api/link.rb +83 -0
- data/lib/active_model_serializers/adapter/json_api/meta.rb +37 -0
- data/lib/active_model_serializers/adapter/json_api/pagination_links.rb +62 -0
- data/lib/active_model_serializers/adapter/json_api/relationship.rb +52 -0
- data/lib/active_model_serializers/adapter/json_api/resource_identifier.rb +37 -0
- data/lib/active_model_serializers/adapter/json_api.rb +516 -0
- data/lib/active_model_serializers/adapter/null.rb +9 -0
- data/lib/active_model_serializers/adapter.rb +92 -0
- data/lib/active_model_serializers/callbacks.rb +55 -0
- data/lib/active_model_serializers/deprecate.rb +55 -0
- data/lib/active_model_serializers/deserialization.rb +13 -0
- data/lib/active_model_serializers/json_pointer.rb +14 -0
- data/lib/active_model_serializers/key_transform.rb +70 -0
- data/lib/active_model_serializers/logging.rb +122 -0
- data/lib/active_model_serializers/model.rb +49 -0
- data/lib/active_model_serializers/railtie.rb +46 -0
- data/lib/active_model_serializers/register_jsonapi_renderer.rb +65 -0
- data/lib/active_model_serializers/serializable_resource.rb +81 -0
- data/lib/active_model_serializers/serialization_context.rb +32 -0
- data/lib/active_model_serializers/test/schema.rb +138 -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 +32 -89
- 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 +112 -0
- data/test/action_controller/json_api/errors_test.rb +41 -0
- data/test/action_controller/json_api/linked_test.rb +197 -0
- data/test/action_controller/json_api/pagination_test.rb +116 -0
- data/test/action_controller/json_api/transform_test.rb +181 -0
- data/test/action_controller/serialization_scope_name_test.rb +229 -0
- data/test/action_controller/serialization_test.rb +469 -0
- data/test/active_model_serializers/adapter_for_test.rb +208 -0
- data/test/active_model_serializers/json_pointer_test.rb +20 -0
- data/test/active_model_serializers/key_transform_test.rb +263 -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 +63 -0
- data/test/active_model_serializers/serialization_context_test_isolated.rb +58 -0
- data/test/active_model_serializers/test/schema_test.rb +130 -0
- data/test/active_model_serializers/test/serializer_test.rb +62 -0
- data/test/active_record_test.rb +9 -0
- data/test/adapter/deprecation_test.rb +100 -0
- data/test/adapter/json/belongs_to_test.rb +45 -0
- data/test/adapter/json/collection_test.rb +90 -0
- data/test/adapter/json/has_many_test.rb +45 -0
- data/test/adapter/json/transform_test.rb +93 -0
- data/test/adapter/json_api/belongs_to_test.rb +155 -0
- data/test/adapter/json_api/collection_test.rb +95 -0
- data/test/adapter/json_api/errors_test.rb +78 -0
- data/test/adapter/json_api/fields_test.rb +87 -0
- data/test/adapter/json_api/has_many_embed_ids_test.rb +43 -0
- data/test/adapter/json_api/has_many_explicit_serializer_test.rb +96 -0
- data/test/adapter/json_api/has_many_test.rb +144 -0
- data/test/adapter/json_api/has_one_test.rb +80 -0
- data/test/adapter/json_api/json_api_test.rb +35 -0
- data/test/adapter/json_api/linked_test.rb +392 -0
- data/test/adapter/json_api/links_test.rb +93 -0
- data/test/adapter/json_api/pagination_links_test.rb +166 -0
- data/test/adapter/json_api/parse_test.rb +137 -0
- data/test/adapter/json_api/relationship_test.rb +161 -0
- data/test/adapter/json_api/relationships_test.rb +199 -0
- data/test/adapter/json_api/resource_identifier_test.rb +85 -0
- data/test/adapter/json_api/resource_meta_test.rb +100 -0
- data/test/adapter/json_api/toplevel_jsonapi_test.rb +82 -0
- data/test/adapter/json_api/transform_test.rb +502 -0
- data/test/adapter/json_api/type_test.rb +61 -0
- data/test/adapter/json_test.rb +45 -0
- data/test/adapter/null_test.rb +23 -0
- data/test/adapter/polymorphic_test.rb +171 -0
- data/test/adapter_test.rb +67 -0
- data/test/array_serializer_test.rb +20 -73
- data/test/benchmark/app.rb +65 -0
- data/test/benchmark/benchmarking_support.rb +67 -0
- data/test/benchmark/bm_caching.rb +119 -0
- data/test/benchmark/bm_transform.rb +34 -0
- data/test/benchmark/config.ru +3 -0
- data/test/benchmark/controllers.rb +84 -0
- data/test/benchmark/fixtures.rb +219 -0
- data/test/cache_test.rb +485 -0
- data/test/collection_serializer_test.rb +110 -0
- data/test/fixtures/active_record.rb +78 -0
- data/test/fixtures/poro.rb +282 -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 +49 -0
- data/test/logger_test.rb +18 -0
- data/test/poro_test.rb +9 -0
- data/test/serializable_resource_test.rb +83 -0
- data/test/serializers/association_macros_test.rb +36 -0
- data/test/serializers/associations_test.rb +295 -0
- data/test/serializers/attribute_test.rb +151 -0
- data/test/serializers/attributes_test.rb +52 -0
- data/test/serializers/caching_configuration_test_isolated.rb +170 -0
- data/test/serializers/configuration_test.rb +32 -0
- data/test/serializers/fieldset_test.rb +14 -0
- data/test/serializers/meta_test.rb +196 -0
- data/test/serializers/options_test.rb +21 -0
- data/test/serializers/read_attribute_for_serialization_test.rb +79 -0
- data/test/serializers/root_test.rb +21 -0
- data/test/serializers/serialization_test.rb +55 -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 +79 -0
- data/test/support/rails5_shims.rb +47 -0
- data/test/support/rails_app.rb +45 -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/test_helper.rb +48 -23
- metadata +449 -43
- 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_scope_name_test.rb +0 -67
- 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
data/test/test_fakes.rb
DELETED
@@ -1,217 +0,0 @@
|
|
1
|
-
class BasicActiveModel
|
2
|
-
include ActiveModel::Serializers::JSON
|
3
|
-
def initialize(hash = {})
|
4
|
-
@attributes = hash
|
5
|
-
end
|
6
|
-
|
7
|
-
def serializable_hash(*)
|
8
|
-
@attributes
|
9
|
-
end
|
10
|
-
|
11
|
-
def method_missing(method)
|
12
|
-
if @attributes.key? method
|
13
|
-
@attributes[method]
|
14
|
-
else
|
15
|
-
raise NoMethodError
|
16
|
-
end
|
17
|
-
end
|
18
|
-
end
|
19
|
-
|
20
|
-
class BasicSerializer < ActiveModel::Serializer
|
21
|
-
attributes :name
|
22
|
-
end
|
23
|
-
|
24
|
-
class Model
|
25
|
-
def initialize(hash={})
|
26
|
-
@attributes = hash
|
27
|
-
end
|
28
|
-
|
29
|
-
def read_attribute_for_serialization(name)
|
30
|
-
@attributes[name]
|
31
|
-
end
|
32
|
-
|
33
|
-
def as_json(*)
|
34
|
-
{ :model => "Model" }
|
35
|
-
end
|
36
|
-
end
|
37
|
-
|
38
|
-
class User
|
39
|
-
include ActiveModel::SerializerSupport
|
40
|
-
|
41
|
-
attr_accessor :superuser
|
42
|
-
|
43
|
-
def initialize(hash={})
|
44
|
-
@attributes = hash.merge(:first_name => "Jose", :last_name => "Valim", :password => "oh noes yugive my password")
|
45
|
-
end
|
46
|
-
|
47
|
-
def read_attribute_for_serialization(name)
|
48
|
-
@attributes[name]
|
49
|
-
end
|
50
|
-
|
51
|
-
def super_user?
|
52
|
-
@superuser
|
53
|
-
end
|
54
|
-
end
|
55
|
-
|
56
|
-
class Post < Model
|
57
|
-
def initialize(attributes)
|
58
|
-
super(attributes)
|
59
|
-
self.comments ||= []
|
60
|
-
self.comments_disabled = false
|
61
|
-
self.author = nil
|
62
|
-
end
|
63
|
-
|
64
|
-
attr_accessor :comments, :comments_disabled, :author
|
65
|
-
def active_model_serializer; PostSerializer; end
|
66
|
-
end
|
67
|
-
|
68
|
-
class Comment < Model
|
69
|
-
def active_model_serializer; CommentSerializer; end
|
70
|
-
end
|
71
|
-
|
72
|
-
class UserSerializer < ActiveModel::Serializer
|
73
|
-
attributes :first_name, :last_name
|
74
|
-
|
75
|
-
def serializable_hash
|
76
|
-
attributes.merge(:ok => true).merge(options[:scope])
|
77
|
-
end
|
78
|
-
end
|
79
|
-
|
80
|
-
class UserAttributesWithKeySerializer < ActiveModel::Serializer
|
81
|
-
attributes :first_name => :f_name, :last_name => :l_name
|
82
|
-
|
83
|
-
def serializable_hash
|
84
|
-
attributes.merge(:ok => true).merge(options[:scope])
|
85
|
-
end
|
86
|
-
end
|
87
|
-
|
88
|
-
class UserAttributesWithSomeKeySerializer < ActiveModel::Serializer
|
89
|
-
attributes :first_name, :last_name => :l_name
|
90
|
-
|
91
|
-
def serializable_hash
|
92
|
-
attributes.merge(:ok => true).merge(options[:scope])
|
93
|
-
end
|
94
|
-
end
|
95
|
-
|
96
|
-
class UserAttributesWithUnsymbolizableKeySerializer < ActiveModel::Serializer
|
97
|
-
attributes :first_name, :last_name => :"last-name"
|
98
|
-
|
99
|
-
def serializable_hash
|
100
|
-
attributes.merge(:ok => true).merge(options[:scope])
|
101
|
-
end
|
102
|
-
end
|
103
|
-
|
104
|
-
class DefaultUserSerializer < ActiveModel::Serializer
|
105
|
-
attributes :first_name, :last_name
|
106
|
-
end
|
107
|
-
|
108
|
-
class MyUserSerializer < ActiveModel::Serializer
|
109
|
-
attributes :first_name, :last_name
|
110
|
-
|
111
|
-
def serializable_hash
|
112
|
-
hash = attributes
|
113
|
-
hash = hash.merge(:super_user => true) if object.super_user?
|
114
|
-
hash
|
115
|
-
end
|
116
|
-
end
|
117
|
-
|
118
|
-
class CommentSerializer
|
119
|
-
def initialize(comment, options={})
|
120
|
-
@object = comment
|
121
|
-
end
|
122
|
-
|
123
|
-
attr_reader :object
|
124
|
-
|
125
|
-
def serializable_hash
|
126
|
-
{ :title => @object.read_attribute_for_serialization(:title) }
|
127
|
-
end
|
128
|
-
|
129
|
-
def as_json(options=nil)
|
130
|
-
options ||= {}
|
131
|
-
if options[:root] == false
|
132
|
-
serializable_hash
|
133
|
-
else
|
134
|
-
{ :comment => serializable_hash }
|
135
|
-
end
|
136
|
-
end
|
137
|
-
end
|
138
|
-
|
139
|
-
class PostSerializer < ActiveModel::Serializer
|
140
|
-
attributes :title, :body
|
141
|
-
has_many :comments, :serializer => CommentSerializer
|
142
|
-
end
|
143
|
-
|
144
|
-
class PostWithConditionalCommentsSerializer < ActiveModel::Serializer
|
145
|
-
root :post
|
146
|
-
attributes :title, :body
|
147
|
-
has_many :comments, :serializer => CommentSerializer
|
148
|
-
|
149
|
-
def include_associations!
|
150
|
-
include! :comments unless object.comments_disabled
|
151
|
-
end
|
152
|
-
end
|
153
|
-
|
154
|
-
class PostWithMultipleConditionalsSerializer < ActiveModel::Serializer
|
155
|
-
root :post
|
156
|
-
attributes :title, :body, :author
|
157
|
-
has_many :comments, :serializer => CommentSerializer
|
158
|
-
|
159
|
-
def include_comments?
|
160
|
-
!object.comments_disabled
|
161
|
-
end
|
162
|
-
|
163
|
-
def include_author?
|
164
|
-
scope.super_user?
|
165
|
-
end
|
166
|
-
end
|
167
|
-
|
168
|
-
class Blog < Model
|
169
|
-
attr_accessor :author
|
170
|
-
end
|
171
|
-
|
172
|
-
class AuthorSerializer < ActiveModel::Serializer
|
173
|
-
attributes :first_name, :last_name
|
174
|
-
end
|
175
|
-
|
176
|
-
class BlogSerializer < ActiveModel::Serializer
|
177
|
-
has_one :author, :serializer => AuthorSerializer
|
178
|
-
end
|
179
|
-
|
180
|
-
class BlogWithRootSerializer < BlogSerializer
|
181
|
-
root true
|
182
|
-
end
|
183
|
-
|
184
|
-
class CustomPostSerializer < ActiveModel::Serializer
|
185
|
-
attributes :title
|
186
|
-
end
|
187
|
-
|
188
|
-
class CustomBlog < Blog
|
189
|
-
attr_accessor :public_posts, :public_user
|
190
|
-
end
|
191
|
-
|
192
|
-
class CustomBlogSerializer < ActiveModel::Serializer
|
193
|
-
has_many :public_posts, :key => :posts, :serializer => PostSerializer
|
194
|
-
has_one :public_user, :key => :user, :serializer => UserSerializer
|
195
|
-
end
|
196
|
-
|
197
|
-
class SomeSerializer < ActiveModel::Serializer
|
198
|
-
attributes :some
|
199
|
-
end
|
200
|
-
|
201
|
-
class SomeObject < Struct.new(:some)
|
202
|
-
end
|
203
|
-
|
204
|
-
# Set up some classes for polymorphic testing
|
205
|
-
class Attachment < Model
|
206
|
-
def attachable
|
207
|
-
@attributes[:attachable]
|
208
|
-
end
|
209
|
-
|
210
|
-
def readable
|
211
|
-
@attributes[:readable]
|
212
|
-
end
|
213
|
-
|
214
|
-
def edible
|
215
|
-
@attributes[:edible]
|
216
|
-
end
|
217
|
-
end
|