Merge pull request #2094 from bf4/move_association_concern_to_association

Move association serialization to association

Author: bf4

lib/active_model/serializer.rb

@@ -379,9 +379,8 @@ def associations(include_directive = ActiveModelSerializers.default_include_dire
     def serializable_hash(adapter_options = nil, options = {}, adapter_instance = self.class.serialization_adapter_instance)
       adapter_options ||= {}
       options[:include_directive] ||= ActiveModel::Serializer.include_directive_from_options(adapter_options)
-      cached_attributes = adapter_options[:cached_attributes] ||= {}
-      resource = fetch_attributes(options[:fields], cached_attributes, adapter_instance)
-      relationships = resource_relationships(adapter_options, options, adapter_instance)
+      resource = attributes_hash(adapter_options, options, adapter_instance)
+      relationships = associations_hash(adapter_options, options, adapter_instance)
       resource.merge(relationships)
     end
     alias to_hash serializable_hash
@@ -413,34 +412,28 @@ def read_attribute_for_serialization(attr)
     end
 
     # @api private
-    def resource_relationships(adapter_options, options, adapter_instance)
+    def attributes_hash(_adapter_options, options, adapter_instance)
+      if self.class.cache_enabled?
+        fetch_attributes(options[:fields], options[:cached_attributes] || {}, adapter_instance)
+      elsif self.class.fragment_cache_enabled?
+        fetch_attributes_fragment(adapter_instance, options[:cached_attributes] || {})
+      else
+        attributes(options[:fields], true)
+      end
+    end
+
+    # @api private
+    def associations_hash(adapter_options, options, adapter_instance)
       relationships = {}
       include_directive = options.fetch(:include_directive)
       associations(include_directive).each do |association|
         adapter_opts = adapter_options.merge(include_directive: include_directive[association.key])
-        relationships[association.key] ||= relationship_value_for(association, adapter_opts, adapter_instance)
+        relationships[association.key] ||= association.serializable_hash(adapter_opts, adapter_instance)
       end
 
       relationships
     end
 
-    # @api private
-    def relationship_value_for(association, adapter_options, adapter_instance)
-      return association.options[:virtual_value] if association.options[:virtual_value]
-      association_serializer = association.serializer
-      association_object = association_serializer && association_serializer.object
-      return unless association_object
-
-      relationship_value = association_serializer.serializable_hash(adapter_options, {}, adapter_instance)
-
-      if association.options[:polymorphic] && relationship_value
-        polymorphic_type = association_object.class.name.underscore
-        relationship_value = { type: polymorphic_type, polymorphic_type.to_sym => relationship_value }
-      end
-
-      relationship_value
-    end
-
     protected
 
     attr_accessor :instance_options

lib/active_model/serializer/association.rb

@@ -29,6 +29,22 @@ def links
       def meta
         options[:meta]
       end
+
+      # @api private
+      def serializable_hash(adapter_options, adapter_instance)
+        return options[:virtual_value] if options[:virtual_value]
+        object = serializer && serializer.object
+        return unless object
+
+        serialization = serializer.serializable_hash(adapter_options, {}, adapter_instance)
+
+        if options[:polymorphic] && serialization
+          polymorphic_type = object.class.name.underscore
+          serialization = { type: polymorphic_type, polymorphic_type.to_sym => serialization }
+        end
+
+        serialization
+      end
     end
   end
 end

lib/active_model/serializer/concerns/caching.rb

@@ -170,6 +170,7 @@ def fragment_cache_enabled?
 
         # Read cache from cache_store
         # @return [Hash]
+        # Used in CollectionSerializer to set :cached_attributes
         def cache_read_multi(collection_serializer, adapter_instance, include_directive)
           return {} if ActiveModelSerializers.config.cache_store.blank?
 
@@ -215,23 +216,17 @@ def object_cache_key(serializer, adapter_instance)
 
       ### INSTANCE METHODS
       def fetch_attributes(fields, cached_attributes, adapter_instance)
-        if serializer_class.cache_enabled?
-          key = cache_key(adapter_instance)
-          cached_attributes.fetch(key) do
-            serializer_class.cache_store.fetch(key, serializer_class._cache_options) do
-              attributes(fields, true)
-            end
+        key = cache_key(adapter_instance)
+        cached_attributes.fetch(key) do
+          fetch(adapter_instance, serializer_class._cache_options, key) do
+            attributes(fields, true)
           end
-        elsif serializer_class.fragment_cache_enabled?
-          fetch_attributes_fragment(adapter_instance, cached_attributes)
-        else
-          attributes(fields, true)
         end
       end
 
-      def fetch(adapter_instance, cache_options = serializer_class._cache_options)
+      def fetch(adapter_instance, cache_options = serializer_class._cache_options, key = cache_key(adapter_instance))
         if serializer_class.cache_store
-          serializer_class.cache_store.fetch(cache_key(adapter_instance), cache_options) do
+          serializer_class.cache_store.fetch(key, cache_options) do
             yield
           end
         else
@@ -242,7 +237,6 @@ def fetch(adapter_instance, cache_options = serializer_class._cache_options)
       # 1. Determine cached fields from serializer class options
       # 2. Get non_cached_fields and fetch cache_fields
       # 3. Merge the two hashes using adapter_instance#fragment_cache
-      # rubocop:disable Metrics/AbcSize
       def fetch_attributes_fragment(adapter_instance, cached_attributes = {})
         serializer_class._cache_options ||= {}
         serializer_class._cache_options[:key] = serializer_class._cache_key if serializer_class._cache_key
@@ -251,22 +245,21 @@ def fetch_attributes_fragment(adapter_instance, cached_attributes = {})
         non_cached_fields = fields[:non_cached].dup
         non_cached_hash = attributes(non_cached_fields, true)
         include_directive = JSONAPI::IncludeDirective.new(non_cached_fields - non_cached_hash.keys)
-        non_cached_hash.merge! resource_relationships({}, { include_directive: include_directive }, adapter_instance)
+        non_cached_hash.merge! associations_hash({}, { include_directive: include_directive }, adapter_instance)
 
         cached_fields = fields[:cached].dup
         key = cache_key(adapter_instance)
         cached_hash =
           cached_attributes.fetch(key) do
-            serializer_class.cache_store.fetch(key, serializer_class._cache_options) do
+            fetch(adapter_instance, serializer_class._cache_options, key) do
               hash = attributes(cached_fields, true)
               include_directive = JSONAPI::IncludeDirective.new(cached_fields - hash.keys)
-              hash.merge! resource_relationships({}, { include_directive: include_directive }, adapter_instance)
+              hash.merge! associations_hash({}, { include_directive: include_directive }, adapter_instance)
             end
           end
         # Merge both results
         adapter_instance.fragment_cache(cached_hash, non_cached_hash)
       end
-      # rubocop:enable Metrics/AbcSize
 
       def cache_key(adapter_instance)
         return @cache_key if defined?(@cache_key)