Nest scope under context option

This commit is contained in:
Adrian Mugnolo and Santiago Pastorino 2014-01-06 15:35:21 -02:00 committed by Santiago Pastorino
parent 8bd2542ed2
commit 0d8ef2b165
9 changed files with 56 additions and 85 deletions

View File

@ -65,7 +65,7 @@ module ActionController
options = default_serializer_options.merge(options) options = default_serializer_options.merge(options)
if serializer = options.fetch(:serializer, ActiveModel::Serializer.serializer_for(resource)) if serializer = options.fetch(:serializer, ActiveModel::Serializer.serializer_for(resource))
options[:scope] = serialization_scope unless options.has_key?(:scope) options[:context] = { scope: serialization_scope }.merge!(options[:context] || {})
options[:resource_name] = controller_name if resource.respond_to?(:to_ary) options[:resource_name] = controller_name if resource.respond_to?(:to_ary)
serializer.new(resource, options) serializer.new(resource, options)

View File

@ -14,15 +14,14 @@ module ActiveModel
def initialize(object, options={}) def initialize(object, options={})
@object = object @object = object
@context = options[:context] @context = options[:context] || {}
@scope = options[:scope]
@root = options.fetch(:root, self.class._root) @root = options.fetch(:root, self.class._root)
@meta_key = options[:meta_key] || :meta @meta_key = options[:meta_key] || :meta
@meta = options[@meta_key] @meta = options[@meta_key]
@each_serializer = options[:each_serializer] @each_serializer = options[:each_serializer]
@resource_name = options[:resource_name] @resource_name = options[:resource_name]
end end
attr_accessor :object, :context, :scope, :root, :meta_key, :meta attr_accessor :object, :context, :root, :meta_key, :meta
def json_key def json_key
if root.nil? if root.nil?
@ -34,7 +33,7 @@ module ActiveModel
def serializer_for(item) def serializer_for(item)
serializer_class = @each_serializer || Serializer.serializer_for(item) || DefaultSerializer serializer_class = @each_serializer || Serializer.serializer_for(item) || DefaultSerializer
serializer_class.new(item, context: context, scope: scope) serializer_class.new(item, context: context)
end end
def serializable_object def serializable_object

View File

@ -103,14 +103,13 @@ end
def initialize(object, options={}) def initialize(object, options={})
@object = object @object = object
@context = options[:context] @context = options[:context] || {}
@scope = options[:scope]
@root = options.fetch(:root, self.class._root) @root = options.fetch(:root, self.class._root)
@meta_key = options[:meta_key] || :meta @meta_key = options[:meta_key] || :meta
@meta = options[@meta_key] @meta = options[@meta_key]
@wrap_in_array = options[:_wrap_in_array] @wrap_in_array = options[:_wrap_in_array]
end end
attr_accessor :object, :context, :scope, :root, :meta_key, :meta attr_accessor :object, :context, :root, :meta_key, :meta
def json_key def json_key
if root == true || root.nil? if root == true || root.nil?
@ -167,7 +166,7 @@ end
def build_serializer(association) def build_serializer(association)
object = send(association.name) object = send(association.name)
association.build_serializer(object, context: context, scope: scope) association.build_serializer(object, context: context)
end end
def serialize(association) def serialize(association)

View File

@ -47,7 +47,7 @@ end
class ProfileSerializer < ActiveModel::Serializer class ProfileSerializer < ActiveModel::Serializer
def description def description
description = object.read_attribute_for_serialization(:description) description = object.read_attribute_for_serialization(:description)
scope ? "#{description} - #{scope}" : description context[:scope] ? "#{description} - #{context[:scope]}" : description
end end
attributes :name, :description attributes :name, :description

View File

@ -43,7 +43,7 @@ module ActionController
class DefaultOptionsForSerializerScopeTest < ActionController::TestCase class DefaultOptionsForSerializerScopeTest < ActionController::TestCase
class MyController < ActionController::Base class MyController < ActionController::Base
def default_serializer_options def default_serializer_options
{ scope: current_admin } { context: { scope: current_admin } }
end end
def render_using_scope_set_in_default_serializer_options def render_using_scope_set_in_default_serializer_options
@ -73,7 +73,7 @@ module ActionController
class ExplicitSerializerScopeTest < ActionController::TestCase class ExplicitSerializerScopeTest < ActionController::TestCase
class MyController < ActionController::Base class MyController < ActionController::Base
def render_using_implicit_serializer_and_explicit_scope def render_using_implicit_serializer_and_explicit_scope
render json: Profile.new({ name: 'Name 1', description: 'Description 1', comments: 'Comments 1' }), scope: current_admin render json: Profile.new({ name: 'Name 1', description: 'Description 1', comments: 'Comments 1' }), context: { scope: current_admin }
end end
private private

View File

@ -15,5 +15,24 @@ module ActiveModel
assert_equal(2, serializer.context.b) assert_equal(2, serializer.context.b)
end end
end end
class ScopeTest < ActiveModel::TestCase
def test_array_serializer_pass_context_to_item_serializers
array = [Profile.new({ name: 'Name 1', description: 'Description 1', comments: 'Comments 1' }),
Profile.new({ name: 'Name 2', description: 'Description 2', comments: 'Comments 2' })]
serializer = ArraySerializer.new(array, context: { scope: current_user })
expected = [{ name: 'Name 1', description: 'Description 1 - user' },
{ name: 'Name 2', description: 'Description 2 - user' }]
assert_equal expected, serializer.serializable_array
end
private
def current_user
'user'
end
end
end end
end end

View File

@ -1,24 +0,0 @@
require 'test_helper'
module ActiveModel
class ArraySerializer
class ScopeTest < ActiveModel::TestCase
def test_array_serializer_pass_options_to_items_serializers
array = [Profile.new({ name: 'Name 1', description: 'Description 1', comments: 'Comments 1' }),
Profile.new({ name: 'Name 2', description: 'Description 2', comments: 'Comments 2' })]
serializer = ArraySerializer.new(array, scope: current_user)
expected = [{ name: 'Name 1', description: 'Description 1 - user' },
{ name: 'Name 2', description: 'Description 2 - user' }]
assert_equal expected, serializer.serializable_array
end
private
def current_user
'user'
end
end
end
end

View File

@ -15,5 +15,32 @@ module ActiveModel
assert_equal(2, serializer.context.b) assert_equal(2, serializer.context.b)
end end
end end
class ContextAssociationTest < ActiveModel::TestCase
def setup
@association = UserSerializer._associations[:profile]
@old_association = @association.dup
@user = User.new({ name: 'Name 1', email: 'mail@server.com', gender: 'M' })
@user_serializer = UserSerializer.new(@user, context: { admin: true })
end
def teardown
UserSerializer._associations[:profile] = @old_association
end
def test_context_passed_through
@association.serializer_class = Class.new(ActiveModel::Serializer) do
def name
context[:admin] ? 'Admin' : 'User'
end
attributes :name
end
assert_equal({
name: 'Name 1', email: 'mail@server.com', profile: { name: 'Admin' }
}, @user_serializer.serializable_hash)
end
end
end end
end end

View File

@ -1,49 +0,0 @@
require 'test_helper'
module ActiveModel
class Serializer
class ScopeTest < ActiveModel::TestCase
def setup
@serializer = ProfileSerializer.new(nil, scope: current_user)
end
def test_scope
assert_equal('user', @serializer.scope)
end
private
def current_user
'user'
end
end
class NestedScopeTest < ActiveModel::TestCase
def setup
@association = UserSerializer._associations[:profile]
@old_association = @association.dup
@user = User.new({ name: 'Name 1', email: 'mail@server.com', gender: 'M' })
@user_serializer = UserSerializer.new(@user, scope: 'user')
end
def teardown
UserSerializer._associations[:profile] = @old_association
end
def test_scope_passed_through
@association.serializer_class = Class.new(ActiveModel::Serializer) do
def name
scope
end
attributes :name
end
assert_equal({
name: 'Name 1', email: 'mail@server.com', profile: { name: 'user' }
}, @user_serializer.serializable_hash)
end
end
end
end