Merge pull request #684 from ride/array-serializer

Refactor adapters to implement support for array serialization

lib/active_model/serializer/adapter.rb

@@ -17,13 +17,7 @@ module ActiveModel
       end
 
       def to_json(options = {})
-        result = serializable_hash(options)
+        serializable_hash(options).to_json
-
-        if root = options.fetch(:root, serializer.json_key)
-          result = { root => result }
-        end
-
-        result.to_json
       end
     end
   end

lib/active_model/serializer/adapter/json.rb

@@ -3,18 +3,26 @@ module ActiveModel
     class Adapter
       class Json < Adapter
         def serializable_hash(options = {})
-          @hash = serializer.attributes(options)
+          if serializer.respond_to?(:each)
+            @result = serializer.map{|s| self.class.new(s).serializable_hash }
+          else
+            @result = serializer.attributes(options)
 
-          serializer.each_association do |name, association, options|
+            serializer.each_association do |name, association, opts|
-            if association.respond_to?(:each)
+              if association.respond_to?(:each)
-              array_serializer = association
+                array_serializer = association
-              @hash[name] = array_serializer.map { |item| item.attributes(options) }
+                @result[name] = array_serializer.map { |item| item.attributes(opts) }
-            else
+              else
-              @hash[name] = association.attributes(options)
+                @result[name] = association.attributes(options)
+              end
             end
           end
 
-          @hash
+          if root = options.fetch(:root, serializer.json_key)
+            @result = { root => @result }
+          end
+
+          @result
         end
       end
     end

lib/active_model/serializer/adapter/json_api.rb

@@ -4,22 +4,29 @@ module ActiveModel
       class JsonApi < Adapter
         def initialize(serializer, options = {})
           super
-          serializer.root ||= true
+          serializer.root = true
         end
 
-        def serializable_hash(opts = {})
+        def serializable_hash(options = {})
-          @hash = serializer.attributes
+          @root = (options[:root] || serializer.json_key).to_s.pluralize.to_sym
+          @hash = {}
 
-          serializer.each_association do |name, association, options|
+          if serializer.respond_to?(:each)
-            @hash[:links] ||= {}
+            @hash[@root] = serializer.map{|s| self.class.new(s).serializable_hash[@root] }
-            unless options[:embed] == :ids
+          else
-              @hash[:linked] ||= {}
+            @hash[@root] = serializer.attributes
-            end
 
-            if association.respond_to?(:each)
+            serializer.each_association do |name, association, opts|
-              add_links(name, association, options)
+              @hash[@root][:links] ||= {}
-            else
+              unless options[:embed] == :ids
-              add_link(name, association, options)
+                @hash[:linked] ||= {}
+              end
+
+              if association.respond_to?(:each)
+                add_links(name, association, opts)
+              else
+                add_link(name, association, opts)
+              end
             end
           end
 
@@ -27,8 +34,8 @@ module ActiveModel
         end
 
         def add_links(name, serializers, options)
-          @hash[:links][name] ||= []
+          @hash[@root][:links][name] ||= []
-          @hash[:links][name] += serializers.map(&:id)
+          @hash[@root][:links][name] += serializers.map(&:id)
 
           unless options[:embed] == :ids
             @hash[:linked][name] ||= []
@@ -37,7 +44,7 @@ module ActiveModel
         end
 
         def add_link(name, serializer, options)
-          @hash[:links][name] = serializer.id
+          @hash[@root][:links][name] = serializer.id
 
           unless options[:embed] == :ids
             plural_name = name.to_s.pluralize.to_sym

lib/active_model/serializer/array_serializer.rb

@@ -10,6 +10,14 @@ module ActiveModel
           serializer_class.new(object)
         end
       end
+
+      def json_key
+        @objects.first.json_key if @objects.first
+      end
+
+      def root=(root)
+        @objects.first.root = root if @objects.first
+      end
     end
   end
 end

test/action_controller/serialization_test.rb

@@ -23,6 +23,14 @@ module ActionController
         ensure
           ActiveModel::Serializer.config.adapter = old_adapter
         end
+
+        def render_array_using_implicit_serializer
+          array = [
+            Profile.new({ name: 'Name 1', description: 'Description 1', comments: 'Comments 1' }),
+            Profile.new({ name: 'Name 2', description: 'Description 2', comments: 'Comments 2' })
+          ]
+          render json: array
+        end
       end
 
       tests MyController
@@ -46,7 +54,25 @@ module ActionController
         get :render_using_default_adapter_root
 
         assert_equal 'application/json', @response.content_type
-        assert_equal '{"profile":{"name":"Name 1","description":"Description 1"}}', @response.body
+        assert_equal '{"profiles":{"name":"Name 1","description":"Description 1"}}', @response.body
+      end
+
+      def test_render_array_using_implicit_serializer
+        get :render_array_using_implicit_serializer
+        assert_equal 'application/json', @response.content_type
+
+        expected = [
+          {
+            name: 'Name 1',
+            description: 'Description 1',
+          },
+          {
+            name: 'Name 2',
+            description: 'Description 2',
+          }
+        ]
+
+        assert_equal expected.to_json, @response.body
       end
     end
   end

test/adapter/json/collection_test.rb

@@ -0,0 +1,28 @@
+require 'test_helper'
+
+module ActiveModel
+  class Serializer
+    class Adapter
+      class Json
+        class Collection < Minitest::Test
+          def setup
+            @first_post = Post.new(id: 1, title: 'Hello!!', body: 'Hello, world!!')
+            @second_post = Post.new(id: 2, title: 'New Post', body: 'Body')
+            @first_post.comments = []
+            @second_post.comments = []
+
+            @serializer = ArraySerializer.new([@first_post, @second_post])
+            @adapter = ActiveModel::Serializer::Adapter::Json.new(@serializer)
+          end
+
+          def test_include_multiple_posts
+            assert_equal([
+                           {title: "Hello!!", body: "Hello, world!!", id: 1, comments: []},
+                           {title: "New Post", body: "Body", id: 2, comments: []}
+                         ], @adapter.serializable_hash)
+          end
+        end
+      end
+    end
+  end
+end

test/adapter/json_api/belongs_to_test.rb

@@ -16,7 +16,7 @@ module ActiveModel
           end
 
           def test_includes_post_id
-            assert_equal(42, @adapter.serializable_hash[:links][:post])
+            assert_equal(42, @adapter.serializable_hash[:comments][:links][:post])
           end
 
           def test_includes_linked_post

test/adapter/json_api/collection_test.rb

@@ -0,0 +1,28 @@
+require 'test_helper'
+
+module ActiveModel
+  class Serializer
+    class Adapter
+      class JsonApi
+        class Collection < Minitest::Test
+          def setup
+            @first_post = Post.new(id: 1, title: 'Hello!!', body: 'Hello, world!!')
+            @second_post = Post.new(id: 2, title: 'New Post', body: 'Body')
+            @first_post.comments = []
+            @second_post.comments = []
+
+            @serializer = ArraySerializer.new([@first_post, @second_post])
+            @adapter = ActiveModel::Serializer::Adapter::JsonApi.new(@serializer)
+          end
+
+          def test_include_multiple_posts
+            assert_equal([
+                           {title: "Hello!!", body: "Hello, world!!", id: 1, links: {comments: []}},
+                           {title: "New Post", body: "Body", id: 2, links: {comments: []}}
+                         ], @adapter.serializable_hash[:posts])
+          end
+        end
+      end
+    end
+  end
+end

test/adapter/json_api/has_many_embed_ids.rb

@@ -18,7 +18,7 @@ module ActiveModel
           end
 
           def test_includes_comment_ids
-            assert_equal([1, 2], @adapter.serializable_hash[:links][:posts])
+            assert_equal([1, 2], @adapter.serializable_hash[:authors][:links][:posts])
           end
 
           def test_no_includes_linked_comments

test/adapter/json_api/has_many_test.rb

@@ -18,7 +18,7 @@ module ActiveModel
           end
 
           def test_includes_comment_ids
-            assert_equal([1, 2], @adapter.serializable_hash[:links][:comments])
+            assert_equal([1, 2], @adapter.serializable_hash[:posts][:links][:comments])
           end
 
           def test_includes_linked_comments

test/array_serializer_test.rb

@@ -5,7 +5,7 @@ module ActiveModel
     class ArraySerializerTest < Minitest::Test
       def setup
         @comment = Comment.new
-        @post= Post.new
+        @post = Post.new
         @serializer = ArraySerializer.new([@comment, @post])
       end
 
@@ -13,7 +13,7 @@ module ActiveModel
         assert_respond_to @serializer, :each
       end
 
-      def test_each_object_should_be_serializer_with_appropriate_serializer
+      def test_each_object_should_be_serialized_with_appropriate_serializer
         serializers =  @serializer.to_a
 
         assert_kind_of CommentSerializer, serializers.first