Skip to content

Commit b892415

Browse files
committed
Remove remaining fragmented cache class
1 parent 253205b commit b892415

File tree

4 files changed

+51
-85
lines changed

4 files changed

+51
-85
lines changed

lib/active_model/serializer.rb

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -194,10 +194,6 @@ def json_key
194194
def read_attribute_for_serialization(attr)
195195
if respond_to?(attr)
196196
send(attr)
197-
elsif self.class._fragmented
198-
# Attribute method wasn't available on this (fragment cached) serializer,
199-
# so read it from the original serializer it was based on.
200-
self.class._fragmented.read_attribute_for_serialization(attr)
201197
else
202198
object.read_attribute_for_serialization(attr)
203199
end

lib/active_model/serializer/caching.rb

Lines changed: 38 additions & 70 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@ module Caching
77
included do
88
with_options instance_writer: false, instance_reader: false do |serializer|
99
serializer.class_attribute :_cache # @api private : the cache store
10-
serializer.class_attribute :_fragmented # @api private : Used ONLY by FragmentedSerializer to reference original serializer
1110
serializer.class_attribute :_cache_key # @api private : when present, is first item in cache_key. Ignored if the serializable object defines #cache_key.
1211
serializer.class_attribute :_cache_only # @api private : when fragment caching, whitelists fetch_attributes. Cannot combine with except
1312
serializer.class_attribute :_cache_except # @api private : when fragment caching, blacklists fetch_attributes. Cannot combine with only
@@ -69,12 +68,15 @@ def _skip_digest?
6968
_cache_options && _cache_options[:skip_digest]
7069
end
7170

72-
def cached_attributes
73-
_cache_only ? _cache_only : _attributes - _cache_except
74-
end
75-
76-
def non_cached_attributes
77-
_attributes - cached_attributes
71+
def fragmented_attributes
72+
cached = _cache_only ? _cache_only : _attributes - _cache_except
73+
cached = cached.map! {|field| _attributes_keys.fetch(field, field) }
74+
non_cached = _attributes - cached
75+
non_cached = non_cached.map! {|field| _attributes_keys.fetch(field, field) }
76+
{
77+
cached: cached,
78+
non_cached: non_cached
79+
}
7880
end
7981

8082
# Enables a serializer to be automatically cached
@@ -205,13 +207,13 @@ def fetch_attributes(fields, cached_attributes, adapter_instance)
205207
key = cache_key(adapter_instance)
206208
cached_attributes.fetch(key) do
207209
self.class.cache_store.fetch(key, self.class._cache_options) do
208-
attributes(fields)
210+
attributes(fields, true)
209211
end
210212
end
211213
elsif self.class.fragment_cache_enabled?
212-
fetch_fragment_cache(adapter_instance)
214+
fetch_attributes_fragment(adapter_instance)
213215
else
214-
attributes(fields)
216+
attributes(fields, true)
215217
end
216218
end
217219

@@ -225,74 +227,40 @@ def fetch(adapter_instance, cache_options = self.class._cache_options)
225227
end
226228
end
227229

228-
# 1. Create a CachedSerializer from the serializer class
229-
# 2. Serialize the above two with the given adapter
230-
# 3. Pass their serializations to the adapter +::fragment_cache+
231-
#
232-
# It will split the serializer into two, one that will be cached and one that will not
233-
#
234-
# Given a resource name
235-
# 1. Dynamically creates a CachedSerializer
236-
# for a given class 'name'
237-
# 2. Call
238-
# CachedSerializer.cache(serializer._cache_options)
239-
# CachedSerializer._fragmented = serializer
240-
# 3. Build a hash keyed to the +cached+ and +non_cached+ serializers
241-
# 4. Call +cached_attributes+ on the serializer class and the above hash
242-
# 5. Return the hash
243-
#
244-
# @example
245-
# When +name+ is <tt>User::Admin</tt>
246-
# creates the Serializer classes (if they don't exist).
247-
# CachedUser_AdminSerializer
248-
#
249-
# Given a hash of its cached and non-cached serializers
250-
# 1. Determine cached attributes from serializer class options
251-
# 2. Add cached attributes to cached Serializer
252-
# 3. Add non-cached attributes to non-cached Serializer
253-
def fetch_fragment_cache(adapter_instance)
230+
# 1. Determine cached fields from serializer class options
231+
# 2. Get non_cached_fields and fetch cache_fields
232+
# 3. Merge the two hashes using adapter_instance#fragment_cache
233+
def fetch_attributes_fragment(adapter_instance)
254234
self.class._cache_options ||= {}
255235
self.class._cache_options[:key] = self.class._cache_key if self.class._cache_key
236+
options = { include_directive: ActiveModel::Serializer.include_directive_from_options({})}
237+
fields = self.class.fragmented_attributes
238+
239+
non_cached_fields = fields[:non_cached].dup
240+
non_cached_hash = attributes(non_cached_fields, true)
241+
(non_cached_fields - non_cached_hash.keys).each do |missing_field|
242+
# TODO: use _attributes_keys?
243+
# gets any other associations, etc.
244+
non_cached_hash[missing_field] = read_attribute_for_serialization(missing_field)
245+
end
256246

257-
cached_serializer = _get_or_create_fragment_cached_serializer
258-
cached_hash = ActiveModelSerializers::SerializableResource.new(
259-
object,
260-
serializer: cached_serializer,
261-
adapter: adapter_instance.class
262-
).serializable_hash
263-
264-
fields = self.class.non_cached_attributes
265-
non_cached_hash = attributes(fields, true)
247+
cached_fields = fields[:cached].dup
248+
key = cache_key(adapter_instance)
249+
cached_hash =
250+
self.class.cache_store.fetch(key, self.class._cache_options) do
251+
hash = attributes(cached_fields, true)
252+
(cached_fields - hash.keys).each do |missing_field|
253+
# TODO: use _attributes_keys?
254+
# gets any other associations, etc.
255+
hash[missing_field] = read_attribute_for_serialization(missing_field)
256+
end
257+
hash
258+
end
266259

267260
# Merge both results
268261
adapter_instance.fragment_cache(cached_hash, non_cached_hash)
269262
end
270263

271-
def _get_or_create_fragment_cached_serializer
272-
serializer_class_name = self.class.name.gsub('::'.freeze, '_'.freeze)
273-
cached_serializer_name = "Cached#{serializer_class_name}"
274-
if Object.const_defined?(cached_serializer_name)
275-
cached_serializer = Object.const_get(cached_serializer_name)
276-
# HACK: Test concern in production code :(
277-
# But it's better than running all the cached fragment serializer
278-
# code multiple times.
279-
if Rails.env == 'test'.freeze
280-
Object.send(:remove_const, cached_serializer_name)
281-
return _get_or_create_fragment_cached_serializer
282-
end
283-
return cached_serializer
284-
end
285-
cached_serializer = Object.const_set(cached_serializer_name, Class.new(ActiveModel::Serializer))
286-
cached_serializer.cache(self.class._cache_options)
287-
cached_serializer.type(self.class._type)
288-
cached_serializer._fragmented = self
289-
self.class.cached_attributes.each do |attribute|
290-
options = self.class._attributes_keys[attribute] || {}
291-
cached_serializer.attribute(attribute, options)
292-
end
293-
cached_serializer
294-
end
295-
296264
def cache_key(adapter_instance)
297265
return @cache_key if defined?(@cache_key)
298266

test/adapter/json_api/resource_identifier_test.rb

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,13 @@ def id
1414
end
1515
end
1616

17-
class FragmentedSerializer < ActiveModel::Serializer; end
17+
class FragmentedSerializer < ActiveModel::Serializer
18+
cache only: :id
19+
20+
def id
21+
'special_id'
22+
end
23+
end
1824

1925
setup do
2026
@model = Author.new(id: 1, name: 'Steve K.')
@@ -42,7 +48,6 @@ def test_id_defined_on_serializer
4248
end
4349

4450
def test_id_defined_on_fragmented
45-
FragmentedSerializer._fragmented = WithDefinedIdSerializer.new(@model)
4651
test_id(FragmentedSerializer, 'special_id')
4752
end
4853

test/cache_test.rb

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ def test_error_is_raised_if_cache_key_is_not_defined_on_object_or_passed_as_cach
117117
e = assert_raises ActiveModel::Serializer::UndefinedCacheKey do
118118
render_object_with_cache(article)
119119
end
120-
assert_match(/ActiveModelSerializers::CacheTest::Article must define #cache_key, or the 'key:' option must be passed into 'CachedActiveModelSerializers_CacheTest_ArticleSerializer.cache'/, e.message)
120+
assert_match(/ActiveModelSerializers::CacheTest::Article must define #cache_key, or the 'key:' option must be passed into 'ActiveModelSerializers::CacheTest::ArticleSerializer.cache'/, e.message)
121121
end
122122

123123
def test_cache_options_definition
@@ -438,31 +438,28 @@ def test_fragment_fetch_with_virtual_attributes
438438
@role = Role.new(name: 'Great Author', description: nil)
439439
@role.author = [@author]
440440
@role_serializer = RoleSerializer.new(@role)
441-
@role_hash = @role_serializer.fetch_fragment_cache(ActiveModelSerializers::Adapter.configured_adapter.new(@role_serializer))
441+
adapter_instance = ActiveModelSerializers::Adapter.configured_adapter.new(@role_serializer)
442+
@role_hash = @role_serializer.fetch_attributes_fragment(adapter_instance)
442443

443444
expected_result = {
444445
id: @role.id,
445446
description: @role.description,
446447
slug: "#{@role.name}-#{@role.id}",
447448
name: @role.name
448449
}
450+
449451
assert_equal(@role_hash, expected_result)
450-
ensure
451-
fragmented_serializer = @role_serializer
452-
Object.send(:remove_const, fragmented_serializer._get_or_create_fragment_cached_serializer.name)
453452
end
454453

455454
def test_fragment_fetch_with_namespaced_object
456455
@spam = Spam::UnrelatedLink.new(id: 'spam-id-1')
457456
@spam_serializer = Spam::UnrelatedLinkSerializer.new(@spam)
458-
@spam_hash = @spam_serializer.fetch_fragment_cache(ActiveModelSerializers::Adapter.configured_adapter.new(@spam_serializer))
457+
adapter_instance = ActiveModelSerializers::Adapter.configured_adapter.new(@spam_serializer)
458+
@spam_hash = @spam_serializer.fetch_attributes_fragment(adapter_instance)
459459
expected_result = {
460460
id: @spam.id
461461
}
462462
assert_equal(@spam_hash, expected_result)
463-
ensure
464-
fragmented_serializer = @spam_serializer
465-
Object.send(:remove_const, fragmented_serializer._get_or_create_fragment_cached_serializer.name)
466463
end
467464

468465
private

0 commit comments

Comments
 (0)