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

Adding cache support to version 0.10.0

Browse Source 
It's a new implementation of cache based on ActiveSupport::Cache.
The implementation abstracts the cache in Adapter class on a
private method called cached_object, this method is intended
to be used on Adapters inside serializable_hash method in order
to cache each instance of the object that will be returned by
the serializer.

Some of its features are:
- A different syntax. (no longer need the cache_key method).
- An options argument that have the same arguments of ActiveSupport::Cache::Store, plus a key option that will be the prefix of the object cache on a pattern "#{key}-#{object.id}".
- It cache the objects individually and not the whole Serializer return, re-using it in different requests (as a show and a index method for example.)
This commit is contained in:
Joao Moura
2014-10-20 21:38:20 -02:00
committed by João Moura
parent 42644544e1
commit 8a432ad2b3
17 changed files with 265 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
test/action_controller/json_api_linked_test.rb
View File

@@ -5,6 +5,7 @@ module ActionController
class JsonApiLinkedTest < ActionController::TestCase
class MyController < ActionController::Base
def setup_post
ActionController::Base.cache_store.clear
@role1 = Role.new(id: 1, name: 'admin')
@role2 = Role.new(id: 2, name: 'colab')
@author = Author.new(id: 1, name: 'Steve K.')

96
test/action_controller/serialization_test.rb
View File

@@ -46,9 +46,48 @@ module ActionController
Profile.new({ name: 'Name 1', description: 'Description 1', comments: 'Comments 1' })
]
render json: array, meta: { total: 10 }
ensure
ensure
ActiveModel::Serializer.config.adapter = old_adapter
end
def render_object_with_cache_enabled
comment = Comment.new({ id: 1, body: 'ZOMG A COMMENT' })
author = Author.new(id: 1, name: 'Joao Moura.')
post = Post.new({ id: 1, title: 'New Post', blog:nil, body: 'Body', comments: [comment], author: author })
generate_cached_serializer(post)
post.title = 'ZOMG a New Post'
render json: post
end
def render_object_expired_with_cache_enabled
comment = Comment.new({ id: 1, body: 'ZOMG A COMMENT' })
author = Author.new(id: 1, name: 'Joao Moura.')
post = Post.new({ id: 1, title: 'New Post', blog:nil, body: 'Body', comments: [comment], author: author })
generate_cached_serializer(post)
post.title = 'ZOMG a New Post'
sleep 0.05
render json: post
end
def render_changed_object_with_cache_enabled
comment = Comment.new({ id: 1, body: 'ZOMG A COMMENT' })
author = Author.new(id: 1, name: 'Joao Moura.')
post = Post.new({ id: 1, title: 'ZOMG a New Post', blog:nil, body: 'Body', comments: [comment], author: author })
render json: post
end
private
def generate_cached_serializer(obj)
serializer_class = ActiveModel::Serializer.serializer_for(obj)
serializer = serializer_class.new(obj)
adapter = ActiveModel::Serializer.adapter.new(serializer)
adapter.to_json
end
end
tests MyController
@@ -106,6 +145,61 @@ module ActionController
assert_equal 'application/json', @response.content_type
assert_equal '{"profiles":[{"name":"Name 1","description":"Description 1"}],"meta":{"total":10}}', @response.body
end
def test_render_with_cache_enable
ActionController::Base.cache_store.clear
get :render_object_with_cache_enabled
expected = {
id: 1,
title: 'New Post',
body: 'Body',
comments: [
{
id: 1,
body: 'ZOMG A COMMENT' }
],
blog: nil,
author: {
id: 1,
name: 'Joao Moura.'
}
}
assert_equal 'application/json', @response.content_type
assert_equal expected.to_json, @response.body
get :render_changed_object_with_cache_enabled
assert_equal expected.to_json, @response.body
ActionController::Base.cache_store.clear
get :render_changed_object_with_cache_enabled
assert_not_equal expected.to_json, @response.body
end
def test_render_with_cache_enable_and_expired
ActionController::Base.cache_store.clear
get :render_object_expired_with_cache_enabled
expected = {
id: 1,
title: 'ZOMG a New Post',
body: 'Body',
comments: [
{
id: 1,
body: 'ZOMG A COMMENT' }
],
blog: nil,
author: {
id: 1,
name: 'Joao Moura.'
}
}
assert_equal 'application/json', @response.content_type
assert_equal expected.to_json, @response.body
end
end
end
end

1
test/adapter/json/belongs_to_test.rb
View File

@@ -21,6 +21,7 @@ module ActiveModel
@serializer = CommentSerializer.new(@comment)
@adapter = ActiveModel::Serializer::Adapter::Json.new(@serializer)
ActionController::Base.cache_store.clear
end
def test_includes_post

1
test/adapter/json/collection_test.rb
View File

@@ -19,6 +19,7 @@ module ActiveModel
@serializer = ArraySerializer.new([@first_post, @second_post])
@adapter = ActiveModel::Serializer::Adapter::Json.new(@serializer)
ActionController::Base.cache_store.clear
end
def test_include_multiple_posts

1
test/adapter/json_api/belongs_to_test.rb
View File

@@ -28,6 +28,7 @@ module ActiveModel
@serializer = CommentSerializer.new(@comment)
@adapter = ActiveModel::Serializer::Adapter::JsonApi.new(@serializer)
ActionController::Base.cache_store.clear
end
def test_includes_post_id

1
test/adapter/json_api/collection_test.rb
View File

@@ -21,6 +21,7 @@ module ActiveModel
@serializer = ArraySerializer.new([@first_post, @second_post])
@adapter = ActiveModel::Serializer::Adapter::JsonApi.new(@serializer)
ActionController::Base.cache_store.clear
end
def test_include_multiple_posts

1
test/adapter/json_api/has_many_test.rb
View File

@@ -6,6 +6,7 @@ module ActiveModel
class JsonApi
class HasManyTest < Minitest::Test
def setup
ActionController::Base.cache_store.clear
@author = Author.new(id: 1, name: 'Steve K.')
@author.posts = []
@author.bio = nil

13
test/fixtures/poro.rb vendored
View File

@@ -3,6 +3,14 @@ class Model
@attributes = hash
end
def cache_key
"#{self.class.name.downcase}/#{self.id}-#{self.updated_at}"
end
def updated_at
@attributes[:updated_at] ||= DateTime.now.to_time.to_i
end
def read_attribute_for_serialization(name)
if name == :id || name == 'id'
id
@@ -55,7 +63,8 @@ module Spam; end
Spam::UnrelatedLink = Class.new(Model)
PostSerializer = Class.new(ActiveModel::Serializer) do
attributes :title, :body, :id
cache key:'post', expires_in: 0.05
attributes :id, :title, :body
has_many :comments
belongs_to :blog
@@ -77,6 +86,7 @@ SpammyPostSerializer = Class.new(ActiveModel::Serializer) do
end
CommentSerializer = Class.new(ActiveModel::Serializer) do
cache expires_in: 1.day
attributes :id, :body
belongs_to :post
@@ -84,6 +94,7 @@ CommentSerializer = Class.new(ActiveModel::Serializer) do
end
AuthorSerializer = Class.new(ActiveModel::Serializer) do
cache key:'writer'
attributes :id, :name
has_many :posts, embed: :ids

62
test/serializers/cache_test.rb Normal file
View File

@@ -0,0 +1,62 @@
require 'test_helper'
module ActiveModel
class Serializer
class CacheTest < Minitest::Test
def setup
@post = Post.new({ title: 'New Post', body: 'Body' })
@comment = Comment.new({ id: 1, body: 'ZOMG A COMMENT' })
@author = Author.new(name: 'Joao M. D. Moura')
@role = Role.new(name: 'Great Author')
@author.posts = [@post]
@author.roles = [@role]
@author.bio = nil
@post.comments = [@comment]
@post.author = @author
@comment.post = @post
@comment.author = @author
@post_serializer = PostSerializer.new(@post)
@author_serializer = AuthorSerializer.new(@author)
@comment_serializer = CommentSerializer.new(@comment)
end
def test_cache_definition
assert_equal(ActionController::Base.cache_store, @post_serializer.class._cache)
assert_equal(ActionController::Base.cache_store, @author_serializer.class._cache)
assert_equal(ActionController::Base.cache_store, @comment_serializer.class._cache)
end
def test_cache_key_definition
assert_equal('post', @post_serializer.class._cache_key)
assert_equal('writer', @author_serializer.class._cache_key)
assert_equal(nil, @comment_serializer.class._cache_key)
end
def test_cache_key_interpolation_with_updated_at
author = render_object_with_cache_without_cache_key(@author)
assert_equal(nil, ActionController::Base.cache_store.fetch(@author.cache_key))
assert_equal(author, ActionController::Base.cache_store.fetch("#{@author_serializer.class._cache_key}/#{@author_serializer.object.id}-#{@author_serializer.object.updated_at}").to_json)
end
def test_default_cache_key_fallback
comment = render_object_with_cache_without_cache_key(@comment)
assert_equal(comment, ActionController::Base.cache_store.fetch(@comment.cache_key).to_json)
end
def test_cache_options_definition
assert_equal({expires_in: 0.05}, @post_serializer.class._cache_options)
assert_equal(nil, @author_serializer.class._cache_options)
assert_equal({expires_in: 1.day}, @comment_serializer.class._cache_options)
end
private
def render_object_with_cache_without_cache_key(obj)
serializer_class = ActiveModel::Serializer.serializer_for(obj)
serializer = serializer_class.new(obj)
adapter = ActiveModel::Serializer.adapter.new(serializer)
adapter.to_json
end
end
end
end

12
test/test_helper.rb
View File

@@ -1,13 +1,21 @@
require "bundler/setup"
require 'bundler/setup'
require 'rails'
require 'action_controller'
require 'action_controller/test_case'
require "active_support/json"
require 'action_controller/railtie'
require 'active_support/json'
require 'minitest/autorun'
# Ensure backward compatibility with Minitest 4
Minitest::Test = MiniTest::Unit::TestCase unless defined?(Minitest::Test)
class Foo < Rails::Application
if Rails.version.to_s.start_with? '4'
config.action_controller.perform_caching = true
ActionController::Base.cache_store = :memory_store
end
end
require "active_model_serializers"
require 'fixtures/poro'