active_model_serializers 0.8.3 → 0.9.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +31 -5
- data/CONTRIBUTING.md +20 -0
- data/DESIGN.textile +4 -4
- data/{MIT-LICENSE.txt → MIT-LICENSE} +0 -0
- data/README.md +395 -95
- data/lib/action_controller/serialization.rb +50 -12
- data/lib/action_controller/serialization_test_case.rb +79 -0
- data/lib/active_model/array_serializer.rb +46 -78
- data/lib/active_model/default_serializer.rb +32 -0
- data/lib/active_model/serializable/utils.rb +16 -0
- data/lib/active_model/serializable.rb +62 -0
- data/lib/active_model/serializer/association/has_many.rb +39 -0
- data/lib/active_model/serializer/association/has_one.rb +25 -0
- data/lib/active_model/serializer/association.rb +58 -0
- data/lib/active_model/serializer/config.rb +31 -0
- data/lib/active_model/serializer/generators/resource_override.rb +13 -0
- data/lib/{generators → active_model/serializer/generators}/serializer/USAGE +0 -0
- data/lib/active_model/serializer/generators/serializer/scaffold_controller_generator.rb +14 -0
- data/lib/active_model/serializer/generators/serializer/serializer_generator.rb +37 -0
- data/lib/active_model/serializer/generators/serializer/templates/controller.rb +93 -0
- data/lib/active_model/serializer/generators/serializer/templates/serializer.rb +8 -0
- data/lib/active_model/serializer/railtie.rb +18 -0
- data/lib/active_model/{serializers → serializer}/version.rb +1 -1
- data/lib/active_model/serializer.rb +209 -422
- data/lib/active_model/serializer_support.rb +5 -0
- data/lib/active_model_serializers.rb +12 -87
- data/test/fixtures/active_record.rb +92 -0
- data/test/fixtures/poro.rb +184 -0
- data/test/fixtures/template.html.erb +1 -0
- data/test/integration/action_controller/namespaced_serialization_test.rb +96 -0
- data/test/integration/action_controller/serialization_test.rb +303 -0
- data/test/integration/action_controller/serialization_test_case_test.rb +71 -0
- data/test/integration/active_record/active_record_test.rb +77 -0
- data/test/integration/generators/resource_generator_test.rb +26 -0
- data/test/integration/generators/scaffold_controller_generator_test.rb +64 -0
- data/test/integration/generators/serializer_generator_test.rb +41 -0
- data/test/test_app.rb +14 -0
- data/test/test_helper.rb +10 -18
- data/test/tmp/app/serializers/account_serializer.rb +3 -0
- data/test/unit/active_model/array_serializer/except_test.rb +18 -0
- data/test/unit/active_model/array_serializer/key_format_test.rb +18 -0
- data/test/unit/active_model/array_serializer/meta_test.rb +53 -0
- data/test/unit/active_model/array_serializer/only_test.rb +18 -0
- data/test/unit/active_model/array_serializer/root_test.rb +102 -0
- data/test/unit/active_model/array_serializer/scope_test.rb +24 -0
- data/test/unit/active_model/array_serializer/serialization_test.rb +199 -0
- data/test/unit/active_model/default_serializer_test.rb +13 -0
- data/test/unit/active_model/serializer/associations/build_serializer_test.rb +36 -0
- data/test/unit/active_model/serializer/associations_test.rb +19 -0
- data/test/unit/active_model/serializer/attributes_test.rb +57 -0
- data/test/unit/active_model/serializer/config_test.rb +91 -0
- data/test/unit/active_model/serializer/filter_test.rb +69 -0
- data/test/unit/active_model/serializer/has_many_polymorphic_test.rb +189 -0
- data/test/unit/active_model/serializer/has_many_test.rb +265 -0
- data/test/unit/active_model/serializer/has_one_and_has_many_test.rb +27 -0
- data/test/unit/active_model/serializer/has_one_polymorphic_test.rb +196 -0
- data/test/unit/active_model/serializer/has_one_test.rb +239 -0
- data/test/unit/active_model/serializer/key_format_test.rb +25 -0
- data/test/unit/active_model/serializer/meta_test.rb +39 -0
- data/test/unit/active_model/serializer/options_test.rb +34 -0
- data/test/unit/active_model/serializer/root_test.rb +117 -0
- data/test/unit/active_model/serializer/scope_test.rb +49 -0
- data/test/unit/active_model/serializer/url_helpers_test.rb +35 -0
- metadata +104 -63
- data/.gitignore +0 -18
- data/.travis.yml +0 -28
- data/Gemfile +0 -4
- data/Gemfile.edge +0 -9
- data/Rakefile +0 -18
- data/active_model_serializers.gemspec +0 -24
- data/bench/perf.rb +0 -43
- data/cruft.md +0 -19
- data/lib/active_model/serializer/associations.rb +0 -233
- data/lib/active_record/serializer_override.rb +0 -16
- data/lib/generators/resource_override.rb +0 -13
- data/lib/generators/serializer/serializer_generator.rb +0 -42
- data/lib/generators/serializer/templates/serializer.rb +0 -19
- data/test/array_serializer_test.rb +0 -75
- 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
@@ -1,515 +1,302 @@
|
|
1
|
-
require
|
2
|
-
require
|
3
|
-
require '
|
4
|
-
require '
|
1
|
+
require 'active_model/array_serializer'
|
2
|
+
require 'active_model/serializable'
|
3
|
+
require 'active_model/serializer/association'
|
4
|
+
require 'active_model/serializer/config'
|
5
|
+
|
6
|
+
require 'thread'
|
5
7
|
|
6
8
|
module ActiveModel
|
7
|
-
# Active Model Serializer
|
8
|
-
#
|
9
|
-
# Provides a basic serializer implementation that allows you to easily
|
10
|
-
# control how a given object is going to be serialized. On initialization,
|
11
|
-
# it expects two objects as arguments, a resource and options. For example,
|
12
|
-
# one may do in a controller:
|
13
|
-
#
|
14
|
-
# PostSerializer.new(@post, :scope => current_user).to_json
|
15
|
-
#
|
16
|
-
# The object to be serialized is the +@post+ and the current user is passed
|
17
|
-
# in for authorization purposes.
|
18
|
-
#
|
19
|
-
# We use the scope to check if a given attribute should be serialized or not.
|
20
|
-
# For example, some attributes may only be returned if +current_user+ is the
|
21
|
-
# author of the post:
|
22
|
-
#
|
23
|
-
# class PostSerializer < ActiveModel::Serializer
|
24
|
-
# attributes :title, :body
|
25
|
-
# has_many :comments
|
26
|
-
#
|
27
|
-
# private
|
28
|
-
#
|
29
|
-
# def attributes
|
30
|
-
# hash = super
|
31
|
-
# hash.merge!(:email => post.email) if author?
|
32
|
-
# hash
|
33
|
-
# end
|
34
|
-
#
|
35
|
-
# def author?
|
36
|
-
# post.author == scope
|
37
|
-
# end
|
38
|
-
# end
|
39
|
-
#
|
40
9
|
class Serializer
|
41
|
-
|
42
|
-
|
43
|
-
INCLUDE_METHODS = {}
|
44
|
-
INSTRUMENT = { :serialize => :"serialize.serializer", :associations => :"associations.serializer" }
|
10
|
+
include Serializable
|
45
11
|
|
46
|
-
|
47
|
-
attr_reader :source, :association
|
12
|
+
@mutex = Mutex.new
|
48
13
|
|
49
|
-
|
50
|
-
|
14
|
+
class << self
|
15
|
+
def inherited(base)
|
16
|
+
base._root = _root
|
17
|
+
base._attributes = (_attributes || []).dup
|
18
|
+
base._associations = (_associations || {}).dup
|
51
19
|
end
|
52
20
|
|
53
|
-
def
|
54
|
-
|
21
|
+
def setup
|
22
|
+
@mutex.synchronize do
|
23
|
+
yield CONFIG
|
24
|
+
end
|
55
25
|
end
|
56
|
-
end
|
57
|
-
|
58
|
-
class_attribute :_attributes
|
59
|
-
self._attributes = {}
|
60
|
-
|
61
|
-
class_attribute :_associations
|
62
|
-
self._associations = {}
|
63
|
-
|
64
|
-
class_attribute :_root
|
65
|
-
class_attribute :_embed
|
66
|
-
self._embed = :objects
|
67
|
-
class_attribute :_root_embed
|
68
26
|
|
69
|
-
|
70
|
-
|
27
|
+
EMBED_IN_ROOT_OPTIONS = [
|
28
|
+
:include,
|
29
|
+
:embed_in_root,
|
30
|
+
:embed_in_root_key,
|
31
|
+
:embed_namespace
|
32
|
+
].freeze
|
71
33
|
|
72
|
-
|
73
|
-
|
74
|
-
|
75
|
-
|
34
|
+
def embed(type, options={})
|
35
|
+
CONFIG.embed = type
|
36
|
+
if EMBED_IN_ROOT_OPTIONS.any? { |opt| options[opt].present? }
|
37
|
+
CONFIG.embed_in_root = true
|
38
|
+
end
|
39
|
+
if options[:embed_in_root_key].present?
|
40
|
+
CONFIG.embed_in_root_key = options[:embed_in_root_key]
|
41
|
+
end
|
42
|
+
ActiveSupport::Deprecation.warn <<-WARN
|
43
|
+
** Notice: embed is deprecated. **
|
44
|
+
The use of .embed method on a Serializer will be soon removed, as this should have a global scope and not a class scope.
|
45
|
+
Please use the global .setup method instead:
|
46
|
+
ActiveModel::Serializer.setup do |config|
|
47
|
+
config.embed = :#{type}
|
48
|
+
config.embed_in_root = #{CONFIG.embed_in_root || false}
|
49
|
+
end
|
50
|
+
WARN
|
76
51
|
end
|
77
52
|
|
78
|
-
|
79
|
-
|
80
|
-
|
81
|
-
|
53
|
+
def format_keys(format)
|
54
|
+
@key_format = format
|
55
|
+
end
|
56
|
+
attr_reader :key_format
|
82
57
|
|
83
|
-
|
84
|
-
|
85
|
-
|
58
|
+
def serializer_for(resource, options = {})
|
59
|
+
if resource.respond_to?(:each)
|
60
|
+
if Object.constants.include?(:ArraySerializer)
|
61
|
+
::ArraySerializer
|
86
62
|
else
|
87
|
-
|
63
|
+
ArraySerializer
|
88
64
|
end
|
65
|
+
else
|
66
|
+
_const_get build_serializer_class(resource, options)
|
89
67
|
end
|
90
68
|
end
|
91
69
|
|
92
|
-
|
93
|
-
|
94
|
-
|
95
|
-
attr = attr.keys[0] if attr.is_a? Hash
|
96
|
-
|
97
|
-
unless method_defined?(attr)
|
98
|
-
define_method attr do
|
99
|
-
object.read_attribute_for_serialization(attr.to_sym)
|
100
|
-
end
|
101
|
-
end
|
102
|
-
|
103
|
-
define_include_method attr
|
70
|
+
attr_accessor :_root, :_attributes, :_associations
|
71
|
+
alias root _root=
|
72
|
+
alias root= _root=
|
104
73
|
|
105
|
-
|
106
|
-
|
107
|
-
|
108
|
-
|
109
|
-
define_method :_fast_attributes do
|
110
|
-
raise NameError
|
74
|
+
def root_name
|
75
|
+
if name
|
76
|
+
root_name = name.demodulize.underscore.sub(/_serializer$/, '')
|
77
|
+
CONFIG.plural_default_root ? root_name.pluralize : root_name
|
111
78
|
end
|
112
|
-
|
113
79
|
end
|
114
80
|
|
115
|
-
def
|
116
|
-
options = attrs.extract_options!
|
117
|
-
self._associations = _associations.dup
|
118
|
-
|
81
|
+
def attributes(*attrs)
|
119
82
|
attrs.each do |attr|
|
120
|
-
|
121
|
-
define_method attr do
|
122
|
-
object.send attr
|
123
|
-
end
|
124
|
-
end
|
83
|
+
striped_attr = strip_attribute attr
|
125
84
|
|
126
|
-
|
85
|
+
@_attributes << striped_attr
|
127
86
|
|
128
|
-
|
87
|
+
define_method striped_attr do
|
88
|
+
object.read_attribute_for_serialization attr
|
89
|
+
end unless method_defined?(attr)
|
129
90
|
end
|
130
91
|
end
|
131
92
|
|
132
|
-
def
|
133
|
-
|
134
|
-
|
135
|
-
INCLUDE_METHODS[name] = method
|
136
|
-
|
137
|
-
unless method_defined?(method)
|
138
|
-
define_method method do
|
139
|
-
true
|
140
|
-
end
|
141
|
-
end
|
93
|
+
def has_one(*attrs)
|
94
|
+
associate(Association::HasOne, *attrs)
|
142
95
|
end
|
143
96
|
|
144
|
-
# Defines an association in the object should be rendered.
|
145
|
-
#
|
146
|
-
# The serializer object should implement the association name
|
147
|
-
# as a method which should return an array when invoked. If a method
|
148
|
-
# with the association name does not exist, the association name is
|
149
|
-
# dispatched to the serialized object.
|
150
97
|
def has_many(*attrs)
|
151
|
-
associate(
|
152
|
-
end
|
153
|
-
|
154
|
-
# Defines an association in the object should be rendered.
|
155
|
-
#
|
156
|
-
# The serializer object should implement the association name
|
157
|
-
# as a method which should return an object when invoked. If a method
|
158
|
-
# with the association name does not exist, the association name is
|
159
|
-
# dispatched to the serialized object.
|
160
|
-
def has_one(*attrs)
|
161
|
-
associate(Associations::HasOne, attrs)
|
98
|
+
associate(Association::HasMany, *attrs)
|
162
99
|
end
|
163
100
|
|
164
|
-
|
165
|
-
# can be used to generate clients for the serialized output.
|
166
|
-
#
|
167
|
-
# The schema hash has two keys: +attributes+ and +associations+.
|
168
|
-
#
|
169
|
-
# The +attributes+ hash looks like this:
|
170
|
-
#
|
171
|
-
# { :name => :string, :age => :integer }
|
172
|
-
#
|
173
|
-
# The +associations+ hash looks like this:
|
174
|
-
# { :posts => { :has_many => :posts } }
|
175
|
-
#
|
176
|
-
# If :key is used:
|
177
|
-
#
|
178
|
-
# class PostsSerializer < ActiveModel::Serializer
|
179
|
-
# has_many :posts, :key => :my_posts
|
180
|
-
# end
|
181
|
-
#
|
182
|
-
# the hash looks like this:
|
183
|
-
#
|
184
|
-
# { :my_posts => { :has_many => :posts }
|
185
|
-
#
|
186
|
-
# This information is extracted from the serializer's model class,
|
187
|
-
# which is provided by +SerializerClass.model_class+.
|
188
|
-
#
|
189
|
-
# The schema method uses the +columns_hash+ and +reflect_on_association+
|
190
|
-
# methods, provided by default by ActiveRecord. You can implement these
|
191
|
-
# methods on your custom models if you want the serializer's schema method
|
192
|
-
# to work.
|
193
|
-
#
|
194
|
-
# TODO: This is currently coupled to Active Record. We need to
|
195
|
-
# figure out a way to decouple those two.
|
196
|
-
def schema
|
197
|
-
klass = model_class
|
198
|
-
columns = klass.columns_hash
|
199
|
-
|
200
|
-
attrs = {}
|
201
|
-
_attributes.each do |name, key|
|
202
|
-
if column = columns[name.to_s]
|
203
|
-
attrs[key] = column.type
|
204
|
-
else
|
205
|
-
# Computed attribute (method on serializer or model). We cannot
|
206
|
-
# infer the type, so we put nil, unless specified in the attribute declaration
|
207
|
-
if name != key
|
208
|
-
attrs[name] = key
|
209
|
-
else
|
210
|
-
attrs[key] = nil
|
211
|
-
end
|
212
|
-
end
|
213
|
-
end
|
214
|
-
|
215
|
-
associations = {}
|
216
|
-
_associations.each do |attr, association_class|
|
217
|
-
association = association_class.new(attr, self)
|
101
|
+
private
|
218
102
|
|
219
|
-
|
220
|
-
|
221
|
-
associations[association.key] = { model_association.macro => model_association.name }
|
222
|
-
else
|
223
|
-
# Computed association. We could infer has_many vs. has_one from
|
224
|
-
# the association class, but that would make it different from
|
225
|
-
# real associations, which read has_one vs. belongs_to from the
|
226
|
-
# model.
|
227
|
-
associations[association.key] = nil
|
228
|
-
end
|
229
|
-
end
|
103
|
+
def strip_attribute(attr)
|
104
|
+
symbolized = attr.is_a?(Symbol)
|
230
105
|
|
231
|
-
|
106
|
+
attr = attr.to_s.gsub(/\?\Z/, '')
|
107
|
+
attr = attr.to_sym if symbolized
|
108
|
+
attr
|
232
109
|
end
|
233
110
|
|
234
|
-
|
235
|
-
|
236
|
-
|
111
|
+
def build_serializer_class(resource, options)
|
112
|
+
"".tap do |klass_name|
|
113
|
+
klass_name << "#{options[:namespace]}::" if options[:namespace]
|
114
|
+
klass_name << options[:prefix].to_s.classify if options[:prefix]
|
115
|
+
klass_name << "#{resource.class.name}Serializer"
|
116
|
+
end
|
237
117
|
end
|
238
118
|
|
239
|
-
|
240
|
-
|
241
|
-
# embed :objects # Embed associations as full objects
|
242
|
-
# embed :ids # Embed only the association ids
|
243
|
-
# embed :ids, :include => true # Embed the association ids and include objects in the root
|
244
|
-
#
|
245
|
-
def embed(type, options={})
|
246
|
-
self._embed = type
|
247
|
-
self._root_embed = true if options[:include]
|
248
|
-
end
|
119
|
+
def associate(klass, *attrs)
|
120
|
+
options = attrs.extract_options!
|
249
121
|
|
250
|
-
|
251
|
-
|
252
|
-
|
253
|
-
|
254
|
-
alias_method :root=, :root
|
255
|
-
|
256
|
-
# Used internally to create a new serializer object based on controller
|
257
|
-
# settings and options for a given resource. These settings are typically
|
258
|
-
# set during the request lifecycle or by the controller class, and should
|
259
|
-
# not be manually defined for this method.
|
260
|
-
def build_json(controller, resource, options)
|
261
|
-
default_options = controller.send(:default_serializer_options) || {}
|
262
|
-
options = default_options.merge(options || {})
|
263
|
-
|
264
|
-
serializer = options.delete(:serializer) ||
|
265
|
-
(resource.respond_to?(:active_model_serializer) &&
|
266
|
-
resource.active_model_serializer)
|
267
|
-
|
268
|
-
return serializer unless serializer
|
269
|
-
|
270
|
-
if resource.respond_to?(:to_ary)
|
271
|
-
unless serializer <= ActiveModel::ArraySerializer
|
272
|
-
raise ArgumentError.new("#{serializer.name} is not an ArraySerializer. " +
|
273
|
-
"You may want to use the :each_serializer option instead.")
|
274
|
-
end
|
122
|
+
attrs.each do |attr|
|
123
|
+
define_method attr do
|
124
|
+
object.send attr
|
125
|
+
end unless method_defined?(attr)
|
275
126
|
|
276
|
-
|
277
|
-
# the serializer for an Array is ActiveModel::ArraySerializer
|
278
|
-
options[:root] ||= serializer.root || controller.controller_name
|
279
|
-
end
|
127
|
+
@_associations[attr] = klass.new(attr, options)
|
280
128
|
end
|
281
|
-
|
282
|
-
options[:scope] = controller.serialization_scope unless options.has_key?(:scope)
|
283
|
-
options[:scope_name] = controller._serialization_scope
|
284
|
-
options[:url_options] = controller.url_options
|
285
|
-
|
286
|
-
serializer.new(resource, options)
|
287
129
|
end
|
288
130
|
end
|
289
131
|
|
290
|
-
attr_reader :object, :options
|
291
|
-
|
292
132
|
def initialize(object, options={})
|
293
|
-
@object
|
294
|
-
|
295
|
-
|
296
|
-
|
297
|
-
|
298
|
-
|
299
|
-
|
300
|
-
|
133
|
+
@object = object
|
134
|
+
@scope = options[:scope]
|
135
|
+
@root = options.fetch(:root, self.class._root)
|
136
|
+
@polymorphic = options.fetch(:polymorphic, false)
|
137
|
+
@meta_key = options[:meta_key] || :meta
|
138
|
+
@meta = options[@meta_key]
|
139
|
+
@wrap_in_array = options[:_wrap_in_array]
|
140
|
+
@only = options[:only] ? Array(options[:only]) : nil
|
141
|
+
@except = options[:except] ? Array(options[:except]) : nil
|
142
|
+
@key_format = options[:key_format]
|
143
|
+
@context = options[:context]
|
144
|
+
@namespace = options[:namespace]
|
301
145
|
end
|
146
|
+
attr_accessor :object, :scope, :root, :meta_key, :meta, :key_format, :context, :polymorphic
|
302
147
|
|
303
|
-
def
|
304
|
-
|
305
|
-
|
306
|
-
class_name = self.class.name.demodulize.underscore.sub(/_serializer$/, '').to_sym unless self.class.name.blank?
|
307
|
-
|
308
|
-
if self._root == true
|
309
|
-
class_name
|
148
|
+
def json_key
|
149
|
+
key = if root == true || root.nil?
|
150
|
+
self.class.root_name
|
310
151
|
else
|
311
|
-
|
152
|
+
root
|
312
153
|
end
|
313
|
-
end
|
314
154
|
|
315
|
-
|
316
|
-
@options[:url_options] || {}
|
155
|
+
key_format == :lower_camel && key.present? ? key.camelize(:lower) : key
|
317
156
|
end
|
318
157
|
|
319
|
-
def
|
320
|
-
|
321
|
-
|
322
|
-
|
323
|
-
def include_meta(hash)
|
324
|
-
hash[meta_key] = @options[:meta] if @options.has_key?(:meta)
|
158
|
+
def attributes
|
159
|
+
filter(self.class._attributes.dup).each_with_object({}) do |name, hash|
|
160
|
+
hash[name] = send(name)
|
161
|
+
end
|
325
162
|
end
|
326
163
|
|
327
|
-
def
|
328
|
-
|
329
|
-
|
330
|
-
|
164
|
+
def associations
|
165
|
+
associations = self.class._associations
|
166
|
+
included_associations = filter(associations.keys)
|
167
|
+
associations.each_with_object({}) do |(name, association), hash|
|
168
|
+
if included_associations.include? name
|
169
|
+
if association.embed_ids?
|
170
|
+
ids = serialize_ids association
|
171
|
+
if association.embed_namespace?
|
172
|
+
hash = hash[association.embed_namespace] ||= {}
|
173
|
+
hash[association.key] = ids
|
174
|
+
else
|
175
|
+
hash[association.key] = ids
|
176
|
+
end
|
177
|
+
elsif association.embed_objects?
|
178
|
+
if association.embed_namespace?
|
179
|
+
hash = hash[association.embed_namespace] ||= {}
|
180
|
+
end
|
181
|
+
hash[association.embedded_key] = serialize association
|
182
|
+
end
|
331
183
|
end
|
332
|
-
else
|
333
|
-
super
|
334
184
|
end
|
335
185
|
end
|
336
186
|
|
337
|
-
|
338
|
-
|
339
|
-
|
340
|
-
|
341
|
-
|
342
|
-
@options[:hash] = hash = {}
|
343
|
-
@options[:unique_values] = {}
|
344
|
-
|
345
|
-
hash.merge!(root => serializable_hash)
|
346
|
-
include_meta hash
|
347
|
-
hash
|
187
|
+
def filter(keys)
|
188
|
+
if @only
|
189
|
+
keys & @only
|
190
|
+
elsif @except
|
191
|
+
keys - @except
|
348
192
|
else
|
349
|
-
|
193
|
+
keys
|
350
194
|
end
|
351
195
|
end
|
352
196
|
|
353
|
-
|
354
|
-
|
355
|
-
|
356
|
-
|
357
|
-
|
358
|
-
|
197
|
+
def embedded_in_root_associations
|
198
|
+
associations = self.class._associations
|
199
|
+
included_associations = filter(associations.keys)
|
200
|
+
associations.each_with_object({}) do |(name, association), hash|
|
201
|
+
if included_associations.include? name
|
202
|
+
association_serializer = build_serializer(association)
|
203
|
+
# we must do this always because even if the current association is not
|
204
|
+
# embeded in root, it might have its own associations that are embeded in root
|
205
|
+
hash.merge!(association_serializer.embedded_in_root_associations) {|key, oldval, newval| [newval, oldval].flatten }
|
206
|
+
|
207
|
+
if association.embed_in_root?
|
208
|
+
if association.embed_in_root_key?
|
209
|
+
hash = hash[association.embed_in_root_key] ||= {}
|
210
|
+
end
|
211
|
+
|
212
|
+
serialized_data = association_serializer.serializable_object
|
213
|
+
key = association.root_key
|
214
|
+
if hash.has_key?(key)
|
215
|
+
hash[key].concat(serialized_data).uniq!
|
216
|
+
else
|
217
|
+
hash[key] = serialized_data
|
218
|
+
end
|
219
|
+
end
|
359
220
|
end
|
360
|
-
else
|
361
|
-
_serializable_hash
|
362
221
|
end
|
363
222
|
end
|
364
223
|
|
365
|
-
def
|
366
|
-
|
367
|
-
|
368
|
-
end
|
224
|
+
def build_serializer(association)
|
225
|
+
object = send(association.name)
|
226
|
+
association.build_serializer(object, association_options_for_serializer(association))
|
369
227
|
end
|
370
228
|
|
371
|
-
def
|
372
|
-
|
373
|
-
|
374
|
-
send INCLUDE_METHODS[name]
|
375
|
-
end
|
229
|
+
def association_options_for_serializer(association)
|
230
|
+
prefix = association.options[:prefix]
|
231
|
+
namespace = association.options[:namespace] || @namespace || self.namespace
|
376
232
|
|
377
|
-
|
378
|
-
|
379
|
-
|
380
|
-
# passed in is the same as the current options hash, use the current
|
381
|
-
# unique values.
|
382
|
-
#
|
383
|
-
# TODO: Should passing in a Hash even be public API here?
|
384
|
-
unique_values =
|
385
|
-
if hash = options[:hash]
|
386
|
-
if @options[:hash] == hash
|
387
|
-
@options[:unique_values] ||= {}
|
388
|
-
else
|
389
|
-
{}
|
390
|
-
end
|
391
|
-
else
|
392
|
-
hash = @options[:hash]
|
393
|
-
@options[:unique_values] ||= {}
|
394
|
-
end
|
395
|
-
|
396
|
-
node = options[:node] ||= @node
|
397
|
-
value = options[:value]
|
398
|
-
|
399
|
-
if options[:include] == nil
|
400
|
-
if @options.key?(:include)
|
401
|
-
options[:include] = @options[:include].include?(name)
|
402
|
-
elsif @options.include?(:exclude)
|
403
|
-
options[:include] = !@options[:exclude].include?(name)
|
404
|
-
end
|
233
|
+
{ scope: scope }.tap do |opts|
|
234
|
+
opts[:namespace] = namespace if namespace
|
235
|
+
opts[:prefix] = prefix if prefix
|
405
236
|
end
|
237
|
+
end
|
406
238
|
|
407
|
-
|
408
|
-
|
409
|
-
klass
|
410
|
-
elsif value.respond_to?(:to_ary)
|
411
|
-
Associations::HasMany
|
412
|
-
else
|
413
|
-
Associations::HasOne
|
414
|
-
end
|
415
|
-
|
416
|
-
association = association_class.new(name, self, options)
|
417
|
-
|
418
|
-
if association.embed_ids?
|
419
|
-
node[association.key] = association.serialize_ids
|
420
|
-
|
421
|
-
if association.embed_in_root? && hash.nil?
|
422
|
-
raise IncludeError.new(self.class, association.name)
|
423
|
-
elsif association.embed_in_root? && association.embeddable?
|
424
|
-
merge_association hash, association.root, association.serializables, unique_values
|
425
|
-
end
|
426
|
-
elsif association.embed_objects?
|
427
|
-
node[association.key] = association.serialize
|
428
|
-
end
|
239
|
+
def serialize(association)
|
240
|
+
build_serializer(association).serializable_object
|
429
241
|
end
|
430
242
|
|
431
|
-
|
432
|
-
|
433
|
-
|
434
|
-
|
435
|
-
|
436
|
-
|
437
|
-
# a unique list of all of the objects that are already in the Array. This
|
438
|
-
# avoids the need to scan through the Array looking for entries every time
|
439
|
-
# we want to merge a new list of values.
|
440
|
-
def merge_association(hash, key, serializables, unique_values)
|
441
|
-
already_serialized = (unique_values[key] ||= {})
|
442
|
-
serializable_hashes = (hash[key] ||= [])
|
443
|
-
|
444
|
-
serializables.each do |serializable|
|
445
|
-
unless already_serialized.include? serializable.object
|
446
|
-
already_serialized[serializable.object] = true
|
447
|
-
serializable_hashes << serializable.serializable_hash
|
448
|
-
end
|
243
|
+
def serialize_ids(association)
|
244
|
+
associated_data = send(association.name)
|
245
|
+
if associated_data.respond_to?(:to_ary)
|
246
|
+
associated_data.map { |elem| serialize_id(elem, association) }
|
247
|
+
else
|
248
|
+
serialize_id(associated_data, association) if associated_data
|
449
249
|
end
|
450
250
|
end
|
451
251
|
|
452
|
-
|
453
|
-
|
454
|
-
def attributes
|
455
|
-
_fast_attributes
|
456
|
-
rescue NameError
|
457
|
-
method = "def _fast_attributes\n"
|
458
|
-
|
459
|
-
method << " h = {}\n"
|
460
|
-
|
461
|
-
_attributes.each do |name,key|
|
462
|
-
method << " h[:\"#{key}\"] = read_attribute_for_serialization(:\"#{name}\") if include?(:\"#{name}\")\n"
|
463
|
-
end
|
464
|
-
method << " h\nend"
|
465
|
-
|
466
|
-
self.class.class_eval method
|
467
|
-
_fast_attributes
|
252
|
+
def key_format
|
253
|
+
@key_format || self.class.key_format || CONFIG.key_format
|
468
254
|
end
|
469
255
|
|
470
|
-
|
471
|
-
|
472
|
-
|
256
|
+
def format_key(key)
|
257
|
+
if key_format == :lower_camel
|
258
|
+
key.to_s.camelize(:lower)
|
259
|
+
else
|
260
|
+
key
|
261
|
+
end
|
473
262
|
end
|
474
263
|
|
475
|
-
|
476
|
-
|
477
|
-
|
478
|
-
|
479
|
-
|
480
|
-
|
481
|
-
|
482
|
-
end
|
264
|
+
def convert_keys(hash)
|
265
|
+
Hash[hash.map do |k,v|
|
266
|
+
key = if k.is_a?(Symbol)
|
267
|
+
format_key(k).to_sym
|
268
|
+
else
|
269
|
+
format_key(k)
|
270
|
+
end
|
483
271
|
|
484
|
-
|
485
|
-
|
272
|
+
[key ,v]
|
273
|
+
end]
|
486
274
|
end
|
487
275
|
|
488
|
-
|
489
|
-
|
276
|
+
attr_writer :serialization_options
|
277
|
+
def serialization_options
|
278
|
+
@serialization_options || {}
|
490
279
|
end
|
491
280
|
|
492
|
-
|
493
|
-
|
494
|
-
|
495
|
-
|
496
|
-
|
281
|
+
def serializable_object(options={})
|
282
|
+
self.serialization_options = options
|
283
|
+
return @wrap_in_array ? [] : nil if @object.nil?
|
284
|
+
hash = attributes
|
285
|
+
hash.merge! associations
|
286
|
+
hash = convert_keys(hash) if key_format.present?
|
287
|
+
hash = { :type => type_name(@object), type_name(@object) => hash } if @polymorphic
|
288
|
+
@wrap_in_array ? [hash] : hash
|
497
289
|
end
|
498
|
-
|
290
|
+
alias_method :serializable_hash, :serializable_object
|
499
291
|
|
500
|
-
|
501
|
-
|
502
|
-
|
503
|
-
# for ArraySerializer.
|
504
|
-
class DefaultSerializer
|
505
|
-
attr_reader :object, :options
|
506
|
-
|
507
|
-
def initialize(object, options={})
|
508
|
-
@object, @options = object, options
|
292
|
+
def serialize_id(elem, association)
|
293
|
+
id = elem.read_attribute_for_serialization(association.embed_key)
|
294
|
+
association.polymorphic? ? { id: id, type: type_name(elem) } : id
|
509
295
|
end
|
510
296
|
|
511
|
-
def
|
512
|
-
|
297
|
+
def type_name(elem)
|
298
|
+
elem.class.to_s.demodulize.underscore.to_sym
|
513
299
|
end
|
514
300
|
end
|
301
|
+
|
515
302
|
end
|