mirror of
https://github.com/ditkrg/active_model_serializers.git
synced 2026-01-23 06:16:50 +00:00
51424963da
Squashed commits: Add Logging Generates logging when renders a serializer. Tunning performance on notify_active_support - Use yield over block.call - Freeze the event name string Organize the logger architeture * Keep only the `ActiveModel::Serializer.logger` to follow the same public API we have for example to config, like `ActiveModel::Serializer.config.adapter` and remove the `ActiveModelSerializers.logger` API. * Define the logger on the load of the AMS, following the Rails convention on Railties [1], [2] and [3]. This way on non Rails apps we have a default logger and on Rails apps we will use the `Rails.logger` the same way that Active Job do [4]. [1]:2ad9afe4ff/activejob/lib/active_job/railtie.rb (L9-L11)[2]:2ad9afe4ff/activerecord/lib/active_record/railtie.rb (L75-L77)[3]:2ad9afe4ff/actionview/lib/action_view/railtie.rb (L19-L21)[4]:2ad9afe4ff/activejob/lib/active_job/logging.rb (L10-L11)Performance tunning on LogSubscriber#render Move the definition of locals to inside the `info` block this way the code is executed only when the logger is called. Remove not needed check on SerializableResource Use SerializableResource on ActionController integration On the ActionController was using a adapter, and since the instrumentation is made on the SerializableResource we need to use the SerializableResource over the adapter directly. Otherwise the logger is not called on a Rails app. Use SerializableResource on the ActionController, since this is the main interface to create and call a serializer. Using always the SerializableResource we can keep the adapter code more easy to mantain since no Adapter will need to call the instrumentation, only the SerializableResource care about this. Add docs about logging Add a CHANGELOG entry Keep the ActiveModelSerializers.logger Better wording on Logging docs [ci skip] Add doc about instrumentation [ci skip] Use ActiveModel::Callbacks on the SerializableResource
102 lines
2.8 KiB
Ruby
102 lines
2.8 KiB
Ruby
require 'set'
|
|
module ActiveModel
|
|
class SerializableResource
|
|
ADAPTER_OPTION_KEYS = Set.new([:include, :fields, :adapter, :meta, :meta_key, :links])
|
|
extend ActiveModel::Callbacks
|
|
|
|
define_model_callbacks :render
|
|
|
|
around_render do |_, block, _|
|
|
notify_active_support do
|
|
block.call
|
|
end
|
|
end
|
|
|
|
# Primary interface to composing a resource with a serializer and adapter.
|
|
# @return the serializable_resource, ready for #as_json/#to_json/#serializable_hash.
|
|
def initialize(resource, options = {})
|
|
@resource = resource
|
|
@adapter_opts, @serializer_opts =
|
|
options.partition { |k, _| ADAPTER_OPTION_KEYS.include? k }.map { |h| Hash[h] }
|
|
end
|
|
|
|
def serializable_hash(*args)
|
|
run_callbacks :render do
|
|
adapter.serializable_hash(*args)
|
|
end
|
|
end
|
|
|
|
def as_json(*args)
|
|
run_callbacks :render do
|
|
adapter.as_json(*args)
|
|
end
|
|
end
|
|
|
|
def to_json(*args)
|
|
run_callbacks :render do
|
|
adapter.to_json(*args)
|
|
end
|
|
end
|
|
|
|
def serialization_scope=(scope)
|
|
serializer_opts[:scope] = scope
|
|
end
|
|
|
|
def serialization_scope
|
|
serializer_opts[:scope]
|
|
end
|
|
|
|
def serialization_scope_name=(scope_name)
|
|
serializer_opts[:scope_name] = scope_name
|
|
end
|
|
|
|
def adapter
|
|
@adapter ||= ActiveModel::Serializer::Adapter.create(serializer_instance, adapter_opts)
|
|
end
|
|
alias_method :adapter_instance, :adapter
|
|
|
|
def serializer_instance
|
|
@serializer_instance ||= serializer.new(resource, serializer_opts)
|
|
end
|
|
|
|
# Get serializer either explicitly :serializer or implicitly from resource
|
|
# Remove :serializer key from serializer_opts
|
|
# Replace :serializer key with :each_serializer if present
|
|
def serializer
|
|
@serializer ||=
|
|
begin
|
|
@serializer = serializer_opts.delete(:serializer)
|
|
@serializer ||= ActiveModel::Serializer.serializer_for(resource)
|
|
|
|
if serializer_opts.key?(:each_serializer)
|
|
serializer_opts[:serializer] = serializer_opts.delete(:each_serializer)
|
|
end
|
|
@serializer
|
|
end
|
|
end
|
|
alias_method :serializer_class, :serializer
|
|
|
|
# True when no explicit adapter given, or explicit appear is truthy (non-nil)
|
|
# False when explicit adapter is falsy (nil or false)
|
|
def use_adapter?
|
|
!(adapter_opts.key?(:adapter) && !adapter_opts[:adapter])
|
|
end
|
|
|
|
def serializer?
|
|
use_adapter? && !!(serializer)
|
|
end
|
|
|
|
protected
|
|
|
|
attr_reader :resource, :adapter_opts, :serializer_opts
|
|
|
|
def notify_active_support
|
|
event_name = 'render.active_model_serializers'.freeze
|
|
payload = { serializer: serializer, adapter: adapter }
|
|
ActiveSupport::Notifications.instrument(event_name, payload) do
|
|
yield
|
|
end
|
|
end
|
|
end
|
|
end
|