ditkrg/active_model_serializers
5
0
Fork 0
mirror of https://github.com/ditkrg/active_model_serializers.git synced 2026-01-25 15:23:06 +00:00
Code Issues Packages Projects Releases Wiki Activity

Consolidate and simplify caching code

Browse Source
This commit is contained in:
Benjamin Fleischer
2016-03-30 22:39:54 -05:00
parent e2ded594d3
commit 1e10c20ac0
9 changed files with 283 additions and 360 deletions
Download Patch File Download Diff File Expand all files Collapse all files

80
test/active_model_serializers/cached_serializer_test.rb
View File

@@ -1,80 +0,0 @@
require 'test_helper'
module ActiveModelSerializers
module Adapter
class CachedSerializerTest < ActiveSupport::TestCase
def test_cached_false_without_cache_store
cached_serializer = build do |serializer|
serializer._cache = nil
end
refute cached_serializer.cached?
end
def test_cached_true_with_cache_store_and_without_cache_only_and_cache_except
cached_serializer = build do |serializer|
serializer._cache = Object
end
assert cached_serializer.cached?
end
def test_cached_false_with_cache_store_and_with_cache_only
cached_serializer = build do |serializer|
serializer._cache = Object
serializer._cache_only = [:name]
end
refute cached_serializer.cached?
end
def test_cached_false_with_cache_store_and_with_cache_except
cached_serializer = build do |serializer|
serializer._cache = Object
serializer._cache_except = [:content]
end
refute cached_serializer.cached?
end
def test_fragment_cached_false_without_cache_store
cached_serializer = build do |serializer|
serializer._cache = nil
serializer._cache_only = [:name]
end
refute cached_serializer.fragment_cached?
end
def test_fragment_cached_true_with_cache_store_and_cache_only
cached_serializer = build do |serializer|
serializer._cache = Object
serializer._cache_only = [:name]
end
assert cached_serializer.fragment_cached?
end
def test_fragment_cached_true_with_cache_store_and_cache_except
cached_serializer = build do |serializer|
serializer._cache = Object
serializer._cache_except = [:content]
end
assert cached_serializer.fragment_cached?
end
def test_fragment_cached_false_with_cache_store_and_cache_except_and_cache_only
cached_serializer = build do |serializer|
serializer._cache = Object
serializer._cache_except = [:content]
serializer._cache_only = [:name]
end
refute cached_serializer.fragment_cached?
end
private
def build
serializer = Class.new(ActiveModel::Serializer)
serializer._cache_key = nil
serializer._cache_options = nil
yield serializer if block_given?
serializer_instance = serializer.new(Object)
CachedSerializer.new(serializer_instance)
end
end
end
end

34
test/active_model_serializers/fragment_cache_test.rb
View File

@@ -1,34 +0,0 @@
require 'test_helper'
module ActiveModelSerializers
class FragmentCacheTest < ActiveSupport::TestCase
def setup
super
@spam = Spam::UnrelatedLink.new(id: 'spam-id-1')
@author = Author.new(name: 'Joao M. D. Moura')
@role = Role.new(name: 'Great Author', description: nil)
@role.author = [@author]
@role_serializer = RoleSerializer.new(@role)
@spam_serializer = Spam::UnrelatedLinkSerializer.new(@spam)
adapter = ActiveModelSerializers::Adapter.configured_adapter
@role_hash = FragmentCache.new(adapter.new(@role_serializer), @role_serializer, {})
@spam_hash = FragmentCache.new(adapter.new(@spam_serializer), @spam_serializer, {})
end
def test_fragment_fetch_with_virtual_attributes
expected_result = {
id: @role.id,
description: @role.description,
slug: "#{@role.name}-#{@role.id}",
name: @role.name
}
assert_equal(@role_hash.fetch, expected_result)
end
def test_fragment_fetch_with_namespaced_object
expected_result = {
id: @spam.id
}
assert_equal(@spam_hash.fetch, expected_result)
end
end
end

109
test/cache_test.rb
View File

@@ -114,7 +114,7 @@ module ActiveModelSerializers
def test_error_is_raised_if_cache_key_is_not_defined_on_object_or_passed_as_cache_option
article = Article.new(title: 'Must Read')
e = assert_raises ActiveModelSerializers::CachedSerializer::UndefinedCacheKey do
e = assert_raises ActiveModel::Serializer::UndefinedCacheKey do
render_object_with_cache(article)
end
assert_match(/ActiveModelSerializers::CacheTest::Article must define #cache_key, or the 'key:' option must be passed into 'CachedActiveModelSerializers_CacheTest_ArticleSerializer.cache'/, e.message)
@@ -252,11 +252,11 @@ module ActiveModelSerializers
attributes_serialization = serializable_alert.as_json
assert_equal expected_cached_attributes, alert.attributes
assert_equal alert.attributes, attributes_serialization
attributes_cache_key = CachedSerializer.new(serializable_alert.adapter.serializer).cache_key(serializable_alert.adapter)
attributes_cache_key = serializable_alert.adapter.serializer.cache_key(serializable_alert.adapter)
assert_equal attributes_serialization, cache_store.fetch(attributes_cache_key)
serializable_alert = serializable(alert, serializer: AlertSerializer, adapter: :json_api)
jsonapi_cache_key = CachedSerializer.new(serializable_alert.adapter.serializer).cache_key(serializable_alert.adapter)
jsonapi_cache_key = serializable_alert.adapter.serializer.cache_key(serializable_alert.adapter)
# Assert cache keys differ
refute_equal attributes_cache_key, jsonapi_cache_key
# Assert (cached) serializations differ
@@ -288,9 +288,9 @@ module ActiveModelSerializers
serializable = ActiveModelSerializers::SerializableResource.new([@comment, @comment])
include_tree = ActiveModel::Serializer::IncludeTree.from_include_args('*')
actual = CachedSerializer.object_cache_keys(serializable.adapter.serializer, serializable.adapter, include_tree)
actual = ActiveModel::Serializer.object_cache_keys(serializable.adapter.serializer, serializable.adapter, include_tree)
assert_equal actual.size, 3
assert_equal 3, actual.size
assert actual.any? { |key| key == "comment/1/#{serializable.adapter.cached_name}" }
assert actual.any? { |key| key =~ %r{post/post-\d+} }
assert actual.any? { |key| key =~ %r{author/author-\d+} }
@@ -365,12 +365,109 @@ module ActiveModelSerializers
assert called
end
def test_cached_false_without_cache_store
cached_serializer = build_cached_serializer do |serializer|
serializer._cache = nil
end
refute cached_serializer.class.cache_enabled?
end
def test_cached_true_with_cache_store_and_without_cache_only_and_cache_except
cached_serializer = build_cached_serializer do |serializer|
serializer._cache = Object
end
assert cached_serializer.class.cache_enabled?
end
def test_cached_false_with_cache_store_and_with_cache_only
cached_serializer = build_cached_serializer do |serializer|
serializer._cache = Object
serializer._cache_only = [:name]
end
refute cached_serializer.class.cache_enabled?
end
def test_cached_false_with_cache_store_and_with_cache_except
cached_serializer = build_cached_serializer do |serializer|
serializer._cache = Object
serializer._cache_except = [:content]
end
refute cached_serializer.class.cache_enabled?
end
def test_fragment_cached_false_without_cache_store
cached_serializer = build_cached_serializer do |serializer|
serializer._cache = nil
serializer._cache_only = [:name]
end
refute cached_serializer.class.fragment_cache_enabled?
end
def test_fragment_cached_true_with_cache_store_and_cache_only
cached_serializer = build_cached_serializer do |serializer|
serializer._cache = Object
serializer._cache_only = [:name]
end
assert cached_serializer.class.fragment_cache_enabled?
end
def test_fragment_cached_true_with_cache_store_and_cache_except
cached_serializer = build_cached_serializer do |serializer|
serializer._cache = Object
serializer._cache_except = [:content]
end
assert cached_serializer.class.fragment_cache_enabled?
end
def test_fragment_cached_false_with_cache_store_and_cache_except_and_cache_only
cached_serializer = build_cached_serializer do |serializer|
serializer._cache = Object
serializer._cache_except = [:content]
serializer._cache_only = [:name]
end
refute cached_serializer.class.fragment_cache_enabled?
end
def test_fragment_fetch_with_virtual_attributes
@author = Author.new(name: 'Joao M. D. Moura')
@role = Role.new(name: 'Great Author', description: nil)
@role.author = [@author]
@role_serializer = RoleSerializer.new(@role)
@role_hash = @role_serializer.fetch_fragment_cache(ActiveModelSerializers::Adapter.configured_adapter.new(@role_serializer))
expected_result = {
id: @role.id,
description: @role.description,
slug: "#{@role.name}-#{@role.id}",
name: @role.name
}
assert_equal(@role_hash, expected_result)
end
def test_fragment_fetch_with_namespaced_object
@spam = Spam::UnrelatedLink.new(id: 'spam-id-1')
@spam_serializer = Spam::UnrelatedLinkSerializer.new(@spam)
@spam_hash = @spam_serializer.fetch_fragment_cache(ActiveModelSerializers::Adapter.configured_adapter.new(@spam_serializer))
expected_result = {
id: @spam.id
}
assert_equal(@spam_hash, expected_result)
end
private
def cache_store
ActiveModelSerializers.config.cache_store
end
def build_cached_serializer
serializer = Class.new(ActiveModel::Serializer)
serializer._cache_key = nil
serializer._cache_options = nil
yield serializer if block_given?
serializer.new(Object)
end
def render_object_with_cache(obj, options = {})
@serializable_resource = serializable(obj, options)
@serializable_resource.serializable_hash
@@ -381,7 +478,7 @@ module ActiveModelSerializers
end
def cached_serialization(serializer)
cache_key = CachedSerializer.new(serializer).cache_key(adapter)
cache_key = serializer.cache_key(adapter)
cache_store.fetch(cache_key)
end
end