mirror of
https://github.com/ditkrg/active_model_serializers.git
synced 2026-01-24 14:56:50 +00:00
Clean up meta handling.
This commit is contained in:
parent
207c85f0fd
commit
701404f757
@ -9,6 +9,7 @@ require 'active_model/serializer/configuration'
|
|||||||
require 'active_model/serializer/fieldset'
|
require 'active_model/serializer/fieldset'
|
||||||
require 'active_model/serializer/lint'
|
require 'active_model/serializer/lint'
|
||||||
require 'active_model/serializer/links'
|
require 'active_model/serializer/links'
|
||||||
|
require 'active_model/serializer/meta'
|
||||||
require 'active_model/serializer/type'
|
require 'active_model/serializer/type'
|
||||||
|
|
||||||
# ActiveModel::Serializer is an abstract class that is
|
# ActiveModel::Serializer is an abstract class that is
|
||||||
@ -20,26 +21,10 @@ module ActiveModel
|
|||||||
include Attributes
|
include Attributes
|
||||||
include Caching
|
include Caching
|
||||||
include Links
|
include Links
|
||||||
|
include Meta
|
||||||
include Type
|
include Type
|
||||||
require 'active_model/serializer/adapter'
|
require 'active_model/serializer/adapter'
|
||||||
|
|
||||||
with_options instance_writer: false, instance_reader: false do |serializer|
|
|
||||||
serializer.class_attribute :_meta # @api private : meta definition, @see Serializer#meta
|
|
||||||
end
|
|
||||||
|
|
||||||
# Register a meta attribute for the corresponding resource.
|
|
||||||
#
|
|
||||||
# @param [Hash] hash Optional hash
|
|
||||||
# @param [Block] block Optional block
|
|
||||||
def self.meta(hash = nil, &block)
|
|
||||||
self._meta =
|
|
||||||
if !block.nil?
|
|
||||||
block
|
|
||||||
else
|
|
||||||
hash
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
# @param resource [ActiveRecord::Base, ActiveModelSerializers::Model]
|
# @param resource [ActiveRecord::Base, ActiveModelSerializers::Model]
|
||||||
# @return [ActiveModel::Serializer]
|
# @return [ActiveModel::Serializer]
|
||||||
# Preferentially returns
|
# Preferentially returns
|
||||||
@ -145,14 +130,6 @@ module ActiveModel
|
|||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
def meta
|
|
||||||
if self.class._meta.respond_to?(:call)
|
|
||||||
instance_eval(&self.class._meta)
|
|
||||||
else
|
|
||||||
self.class._meta
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
protected
|
protected
|
||||||
|
|
||||||
attr_accessor :instance_options
|
attr_accessor :instance_options
|
||||||
|
|||||||
@ -6,6 +6,7 @@ module ActiveModel
|
|||||||
autoload :PaginationLinks
|
autoload :PaginationLinks
|
||||||
autoload :FragmentCache
|
autoload :FragmentCache
|
||||||
autoload :Link
|
autoload :Link
|
||||||
|
autoload :Meta
|
||||||
autoload :Deserialization
|
autoload :Deserialization
|
||||||
|
|
||||||
# TODO: if we like this abstraction and other API objects to it,
|
# TODO: if we like this abstraction and other API objects to it,
|
||||||
@ -157,7 +158,7 @@ module ActiveModel
|
|||||||
links = links_for(serializer)
|
links = links_for(serializer)
|
||||||
resource_object[:links] = links if links.any?
|
resource_object[:links] = links if links.any?
|
||||||
|
|
||||||
meta = serializer.meta
|
meta = meta_for(serializer)
|
||||||
resource_object[:meta] = meta unless meta.nil?
|
resource_object[:meta] = meta unless meta.nil?
|
||||||
|
|
||||||
resource_object
|
resource_object
|
||||||
@ -220,6 +221,10 @@ module ActiveModel
|
|||||||
def pagination_links_for(serializer, options)
|
def pagination_links_for(serializer, options)
|
||||||
JsonApi::PaginationLinks.new(serializer.object, options[:serialization_context]).serializable_hash(options)
|
JsonApi::PaginationLinks.new(serializer.object, options[:serialization_context]).serializable_hash(options)
|
||||||
end
|
end
|
||||||
|
|
||||||
|
def meta_for(serializer)
|
||||||
|
Meta.new(serializer).as_json
|
||||||
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
29
lib/active_model/serializer/adapter/json_api/meta.rb
Normal file
29
lib/active_model/serializer/adapter/json_api/meta.rb
Normal file
@ -0,0 +1,29 @@
|
|||||||
|
module ActiveModel
|
||||||
|
class Serializer
|
||||||
|
module Adapter
|
||||||
|
class JsonApi
|
||||||
|
class Meta
|
||||||
|
def initialize(serializer)
|
||||||
|
@object = serializer.object
|
||||||
|
@scope = serializer.scope
|
||||||
|
|
||||||
|
# Use the return value of the block unless it is nil.
|
||||||
|
if serializer._meta.respond_to?(:call)
|
||||||
|
@value = instance_eval(&serializer._meta)
|
||||||
|
else
|
||||||
|
@value = serializer._meta
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
def as_json
|
||||||
|
@value
|
||||||
|
end
|
||||||
|
|
||||||
|
protected
|
||||||
|
|
||||||
|
attr_reader :object, :scope
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
29
lib/active_model/serializer/meta.rb
Normal file
29
lib/active_model/serializer/meta.rb
Normal file
@ -0,0 +1,29 @@
|
|||||||
|
module ActiveModel
|
||||||
|
class Serializer
|
||||||
|
module Meta
|
||||||
|
extend ActiveSupport::Concern
|
||||||
|
|
||||||
|
included do
|
||||||
|
with_options instance_writer: false, instance_reader: true do |serializer|
|
||||||
|
serializer.class_attribute :_meta # @api private
|
||||||
|
end
|
||||||
|
|
||||||
|
extend ActiveSupport::Autoload
|
||||||
|
end
|
||||||
|
|
||||||
|
module ClassMethods
|
||||||
|
# Set the JSON API meta attribute of a serializer.
|
||||||
|
# @example
|
||||||
|
# class AdminAuthorSerializer < ActiveModel::Serializer
|
||||||
|
# meta { stuff: 'value' }
|
||||||
|
# @example
|
||||||
|
# meta do
|
||||||
|
# { comment_count: object.comments.count }
|
||||||
|
# end
|
||||||
|
def meta(value = nil, &block)
|
||||||
|
self._meta = block || value
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
Loading…
Reference in New Issue
Block a user