diff --git a/CHANGELOG.md b/CHANGELOG.md index f03aa5b2..6c0cc134 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,6 +3,7 @@ Breaking changes: Features: +- [#1633](https://github.com/rails-api/active_model_serializers/pull/1633) Yield 'serializer' to serializer association blocks. (@bf4) - [#1616](https://github.com/rails-api/active_model_serializers/pull/1616) SerializableResource handles no serializer like controller. (@bf4) - [#1618](https://github.com/rails-api/active_model_serializers/issues/1618) Get collection root key for empty collection from explicit serializer option, when possible. (@bf4) diff --git a/docs/general/serializers.md b/docs/general/serializers.md index 23f70720..8c0fca05 100644 --- a/docs/general/serializers.md +++ b/docs/general/serializers.md @@ -48,6 +48,18 @@ has_one :blog, key: :site has_one :maker, virtual_value: { id: 1 } ``` +``ruby +has_one :blog do |serializer| + serializer.cached_blog +end + +def cached_blog + cache_store.fetch("cached_blog:#{object.updated_at}") do + Blog.find(object.blog_id) + end +end +``` + #### ::has_many e.g. diff --git a/lib/active_model/serializer/reflection.rb b/lib/active_model/serializer/reflection.rb index 5257a905..aba75a35 100644 --- a/lib/active_model/serializer/reflection.rb +++ b/lib/active_model/serializer/reflection.rb @@ -56,14 +56,25 @@ module ActiveModel :nil end + # @param serializer [ActiveModel::Serializer] + # @yield [ActiveModel::Serializer] + # @return [:nil, associated resource or resource collection] + # @example + # has_one :blog do |serializer| + # serializer.cached_blog + # end + # + # def cached_blog + # cache_store.fetch("cached_blog:#{object.updated_at}") do + # Blog.find(object.blog_id) + # end + # end def value(serializer) @object = serializer.object @scope = serializer.scope - # Add '@serializer' to binding for use in association block as 'serializer' - @serializer = serializer if block - block_value = instance_eval(&block) + block_value = instance_exec(serializer, &block) if block_value == :nil serializer.read_attribute_for_serialization(name) else @@ -119,7 +130,7 @@ module ActiveModel protected - attr_accessor :object, :scope, :serializer + attr_accessor :object, :scope private diff --git a/test/adapter/json_api/relationships_test.rb b/test/adapter/json_api/relationships_test.rb index bf47a4e5..5fa0de8d 100644 --- a/test/adapter/json_api/relationships_test.rb +++ b/test/adapter/json_api/relationships_test.rb @@ -38,7 +38,7 @@ module ActiveModel end end - has_many :roles do + has_many :roles do |serializer| meta count: object.posts.count serializer.cached_roles end