Add support for wildcard includes + improve perfs on JsonApi includes.

Author: beauby

CHANGELOG.md

@@ -22,6 +22,7 @@ Features:
   * adds FlattenJSON as default adapter [@joaomdmoura]
   * adds support for `pagination links` at top level of JsonApi adapter [@bacarini]
   * adds extended format for `include` option to JsonApi adapter [@beauby]
+  * adds support for wildcards in `include` option [@beauby]
 
 Fixes:
 

lib/active_model/serializer.rb

@@ -1,11 +1,11 @@
 require 'thread_safe'
 require 'active_model/serializer/adapter'
 require 'active_model/serializer/array_serializer'
+require 'active_model/serializer/include_tree'
 require 'active_model/serializer/associations'
 require 'active_model/serializer/configuration'
 require 'active_model/serializer/fieldset'
 require 'active_model/serializer/lint'
-require 'active_model/serializer/utils'
 
 module ActiveModel
   class Serializer

lib/active_model/serializer/adapter/attributes.rb

@@ -2,6 +2,11 @@ module ActiveModel
   class Serializer
     module Adapter
       class Attributes < Base
+        def initialize(serializer, options = {})
+          super
+          @include_tree = IncludeTree.from_include_args(options[:include] || '*')
+        end
+
         def serializable_hash(options = nil)
           options ||= {}
           if serializer.respond_to?(:each)
@@ -13,7 +18,7 @@ def serializable_hash(options = nil)
               serializer.attributes(options)
             end
 
-            serializer.associations.each do |association|
+            serializer.associations(@include_tree).each do |association|
               serializer = association.serializer
               association_options = association.options
 

lib/active_model/serializer/adapter/json_api.rb

@@ -8,7 +8,8 @@ class JsonApi < Base
 
         def initialize(serializer, options = {})
           super
-          @included = ActiveModel::Serializer::Utils.include_args_to_hash(instance_options[:include])
+          @include_tree = IncludeTree.from_include_args(options[:include])
+
           fields = options.delete(:fields)
           if fields
             @fieldset = ActiveModel::Serializer::Fieldset.new(fields, serializer.json_key)
@@ -19,10 +20,11 @@ def initialize(serializer, options = {})
 
         def serializable_hash(options = nil)
           options ||= {}
+
           if serializer.respond_to?(:each)
-            serializable_hash_for_collection(serializer, options)
+            serializable_hash_for_collection(options)
           else
-            serializable_hash_for_single_resource(serializer, options)
+            serializable_hash_for_single_resource(options)
           end
         end
 
@@ -34,10 +36,10 @@ def fragment_cache(cached_hash, non_cached_hash)
         private
 
         ActiveModel.silence_warnings do
-          attr_reader :included, :fieldset
+          attr_reader :fieldset
         end
 
-        def serializable_hash_for_collection(serializer, options)
+        def serializable_hash_for_collection(options)
           hash = { data: [] }
           serializer.each do |s|
             result = self.class.new(s, instance_options.merge(fieldset: fieldset)).serializable_hash(options)
@@ -57,10 +59,10 @@ def serializable_hash_for_collection(serializer, options)
           hash
         end
 
-        def serializable_hash_for_single_resource(serializer, options)
+        def serializable_hash_for_single_resource(options)
           primary_data = primary_data_for(serializer, options)
           relationships = relationships_for(serializer)
-          included = included_for(serializer)
+          included = included_resources(@include_tree)
           hash = { data: primary_data }
           hash[:data][:relationships] = relationships if relationships.any?
           hash[:included] = included if included.any?
@@ -123,37 +125,37 @@ def relationship_value_for(serializer, options = {})
         end
 
         def relationships_for(serializer)
-          Hash[serializer.associations.map { |association| [association.key, { data: relationship_value_for(association.serializer, association.options) }] }]
+          serializer.associations.each_with_object({}) do |association, hash|
+            hash[association.key] = { data: relationship_value_for(association.serializer, association.options) }
+          end
         end
 
-        def included_for(serializer)
-          included.flat_map { |inc|
-            association = serializer.associations.find { |assoc| assoc.key == inc.first }
-            _included_for(association.serializer, inc.second) if association
-          }.uniq
+        def included_resources(include_tree)
+          included = []
+
+          serializer.associations(include_tree).each do |association|
+            add_included_resources_for(association.serializer, include_tree[association.key], included)
+          end
+
+          included
         end
 
-        def _included_for(serializer, includes)
+        def add_included_resources_for(serializer, include_tree, included)
           if serializer.respond_to?(:each)
-            serializer.flat_map { |s| _included_for(s, includes) }.uniq
+            serializer.each { |s| add_included_resources_for(s, include_tree, included) }
           else
-            return [] unless serializer && serializer.object
+            return unless serializer && serializer.object
 
             primary_data = primary_data_for(serializer, instance_options)
             relationships = relationships_for(serializer)
             primary_data[:relationships] = relationships if relationships.any?
 
-            included = [primary_data]
+            return if included.include?(primary_data)
+            included.push(primary_data)
 
-            includes.each do |inc|
-              association = serializer.associations.find { |assoc| assoc.key == inc.first }
-              if association
-                included.concat(_included_for(association.serializer, inc.second))
-                included.uniq!
-              end
+            serializer.associations(include_tree).each do |association|
+              add_included_resources_for(association.serializer, include_tree[association.key], included)
             end
-
-            included
           end
         end
 

lib/active_model/serializer/associations.rb

@@ -10,6 +10,8 @@ class Serializer
     module Associations
       extend ActiveSupport::Concern
 
+      DEFAULT_INCLUDE_TREE = ActiveModel::Serializer::IncludeTree.from_string('*')
+
       included do |base|
         class << base
           attr_accessor :_reflections
@@ -82,13 +84,15 @@ def associate(reflection)
         end
       end
 
+      # @param [IncludeTree] include_tree (defaults to all associations when not provided)
       # @return [Enumerator<Association>]
       #
-      def associations
+      def associations(include_tree = DEFAULT_INCLUDE_TREE)
         return unless object
 
         Enumerator.new do |y|
           self.class._reflections.each do |reflection|
+            next unless include_tree.key?(reflection.name)
             y.yield reflection.build_association(self, instance_options)
           end
         end

lib/active_model/serializer/include_tree.rb

@@ -0,0 +1,75 @@
+module ActiveModel
+  class Serializer
+    class IncludeTree
+      module Parsing
+        module_function
+
+        def include_string_to_hash(included)
+          included.delete(' ').split(',').reduce({}) do |hash, path|
+            include_tree = path.split('.').reverse_each.reduce({}) { |a, e| { e.to_sym => a } }
+            hash.deep_merge!(include_tree)
+          end
+        end
+
+        def include_args_to_hash(included)
+          case included
+          when Symbol
+            { included => {} }
+          when Hash
+            included.each_with_object({}) { |(key, value), hash|
+              hash[key] = include_args_to_hash(value)
+            }
+          when Array
+            included.reduce({}) { |a, e| a.merge!(include_args_to_hash(e)) }
+          when String
+            include_string_to_hash(included)
+          else
+            {}
+          end
+        end
+      end
+
+      # Builds an IncludeTree from a comma separated list of dot separated paths (JSON API format).
+      # @example `'posts.author, posts.comments.upvotes, posts.comments.author'`
+      #
+      # @param [String] included
+      # @return [IncludeTree]
+      #
+      def self.from_string(included)
+        new(Parsing.include_string_to_hash(included))
+      end
+
+      # Translates the arguments passed to the include option into an IncludeTree.
+      # The format can be either a String (see #from_string), an Array of Symbols and Hashes, or a mix of both.
+      # @example `posts: [:author, comments: [:author, :upvotes]]`
+      #
+      # @param [Symbol, Hash, Array, String] included
+      # @return [IncludeTree]
+      #
+      def self.from_include_args(included)
+        new(Parsing.include_args_to_hash(included))
+      end
+
+      # @param [Hash] hash
+      def initialize(hash = {})
+        @hash = hash
+      end
+
+      def key?(key)
+        @hash.key?(key) || @hash.key?(:*) || @hash.key?(:**)
+      end
+
+      def [](key)
+        # TODO(beauby): Adopt a lazy caching strategy for generating subtrees.
+        case
+        when @hash.key?(key)
+          self.class.new(@hash[key])
+        when @hash.key?(:*)
+          self.class.new(@hash[:*])
+        when @hash.key?(:**)
+          self.class.new(:** => {})
+        end
+      end
+    end
+  end
+end

lib/active_model/serializer/utils.rb

@@ -51,9 +51,9 @@ def render_resource_with_nested_include
             render json: @post, include: [comments: [:author]], adapter: :json_api
           end
 
-          def render_resource_with_nested_has_many_include
+          def render_resource_with_nested_has_many_include_wildcard
             setup_post
-            render json: @post, include: 'author.roles', adapter: :json_api
+            render json: @post, include: 'author.*', adapter: :json_api
           end
 
           def render_resource_with_missing_nested_has_many_include
@@ -96,7 +96,7 @@ def test_render_resource_with_include
         end
 
         def test_render_resource_with_nested_has_many_include
-          get :render_resource_with_nested_has_many_include
+          get :render_resource_with_nested_has_many_include_wildcard
           response = JSON.parse(@response.body)
           expected_linked = [
             {

test/action_controller/json_api/linked_test.rb

@@ -0,0 +1,26 @@
+require 'test_helper'
+
+module ActiveModel
+  class Serializer
+    class IncludeTree
+      class FromStringTest < Minitest::Test
+        def test_simple_array
+          input = [:comments, :author]
+          actual = ActiveModel::Serializer::IncludeTree.from_include_args(input)
+          assert(actual.key?(:author))
+          assert(actual.key?(:comments))
+        end
+
+        def test_nested_array
+          input = [:comments, posts: [:author, comments: [:author]]]
+          actual = ActiveModel::Serializer::IncludeTree.from_include_args(input)
+          assert(actual.key?(:posts))
+          assert(actual[:posts].key?(:author))
+          assert(actual[:posts].key?(:comments))
+          assert(actual[:posts][:comments].key?(:author))
+          assert(actual.key?(:comments))
+        end
+      end
+    end
+  end
+end