Merge pull request #958 from joaomdmoura/spliting-json-adapter

Splitting json adapter into two

Author: joaomdmoura

lib/action_controller/serialization.rb

@@ -6,7 +6,7 @@ module Serialization
 
     include ActionController::Renderers
 
-    ADAPTER_OPTION_KEYS = [:include, :fields, :root, :adapter]
+    ADAPTER_OPTION_KEYS = [:include, :fields, :adapter]
 
     included do
       class_attribute :_serialization_scope

lib/active_model/serializer.rb

@@ -145,14 +145,6 @@ def self.adapter
       adapter_class
     end
 
-    def self._root
-      @@root ||= false
-    end
-
-    def self._root=(root)
-      @@root = root
-    end
-
     def self.root_name
       name.demodulize.underscore.sub(/_serializer$/, '') if name
     end
@@ -162,7 +154,7 @@ def self.root_name
     def initialize(object, options = {})
       @object     = object
       @options    = options
-      @root       = options[:root] || (self.class._root ? self.class.root_name : false)
+      @root       = options[:root]
       @meta       = options[:meta]
       @meta_key   = options[:meta_key]
       @scope      = options[:scope]
@@ -176,11 +168,7 @@ def initialize(object, options = {})
     end
 
     def json_key
-      if root == true || root.nil?
-        self.class.root_name
-      else
-        root
-      end
+      self.class.root_name
     end
 
     def id

lib/active_model/serializer/adapter.rb

@@ -5,6 +5,7 @@ class Serializer
     class Adapter
       extend ActiveSupport::Autoload
       autoload :Json
+      autoload :FlattenJson
       autoload :Null
       autoload :JsonApi
 
@@ -21,7 +22,8 @@ def serializable_hash(options = {})
 
       def as_json(options = {})
         hash = serializable_hash(options)
-        include_meta(hash)
+        include_meta(hash) unless self.class == FlattenJson
+        hash
       end
 
       def self.create(resource, options = {})
@@ -48,7 +50,7 @@ def cache_check(serializer)
             yield
           end
         elsif is_fragment_cached?
-          FragmentCache.new(self, @cached_serializer, @options, @root).fetch
+          FragmentCache.new(self, @cached_serializer, @options).fetch
         else
           yield
         end
@@ -82,11 +84,11 @@ def meta_key
       end
 
       def root
-        @options.fetch(:root) { serializer.json_key }
+        serializer.json_key.to_sym if serializer.json_key
       end
 
       def include_meta(json)
-        json[meta_key] = meta if meta && root
+        json[meta_key] = meta if meta
         json
       end
     end

lib/active_model/serializer/adapter/flatten_json.rb

@@ -0,0 +1,12 @@
+module ActiveModel
+  class Serializer
+    class Adapter
+      class FlattenJson < Json
+        def serializable_hash(options = {})
+          super
+          @result
+        end
+      end
+    end
+  end
+end

lib/active_model/serializer/adapter/fragment_cache.rb

@@ -5,8 +5,7 @@ class FragmentCache
 
         attr_reader :serializer
 
-        def initialize(adapter, serializer, options, root)
-          @root       = root
+        def initialize(adapter, serializer, options)
           @options    = options
           @adapter    = adapter
           @serializer = serializer

lib/active_model/serializer/adapter/json.rb

@@ -6,7 +6,7 @@ class Adapter
       class Json < Adapter
         def serializable_hash(options = {})
           if serializer.respond_to?(:each)
-            @result = serializer.map{|s| self.class.new(s).serializable_hash }
+            @result = serializer.map{|s| FlattenJson.new(s).serializable_hash }
           else
             @hash = {}
 
@@ -37,16 +37,13 @@ def serializable_hash(options = {})
             @result = @core.merge @hash
           end
 
-          if root
-            @result = { root => @result }
-          else
-            @result
-          end
+          { root => @result }
+        end
+
+        def fragment_cache(cached_hash, non_cached_hash)
+          Json::FragmentCache.new().fragment_cache(cached_hash, non_cached_hash)
         end
-      end
 
-      def fragment_cache(cached_hash, non_cached_hash)
-        Json::FragmentCache.new().fragment_cache(cached_hash, non_cached_hash)
       end
     end
   end

lib/active_model/serializer/adapter/json_api.rb

@@ -6,7 +6,6 @@ class Adapter
       class JsonApi < Adapter
         def initialize(serializer, options = {})
           super
-          serializer.root = true
           @hash = { data: [] }
 
           if fields = options.delete(:fields)

lib/active_model/serializer/array_serializer.rb

@@ -7,9 +7,8 @@ class ArraySerializer
       attr_reader :meta, :meta_key
 
       def initialize(objects, options = {})
-        options.merge!(root: nil)
-
-        @objects = objects.map do |object|
+        @resource = objects
+        @objects  = objects.map do |object|
           serializer_class = options.fetch(
             :serializer,
             ActiveModel::Serializer.serializer_for(object)
@@ -21,7 +20,11 @@ def initialize(objects, options = {})
       end
 
       def json_key
-        @objects.first.json_key if @objects.first
+        if @objects.first
+          @objects.first.json_key.pluralize
+        else
+          @resource.name.downcase.pluralize if @resource.try(:name)
+        end
       end
 
       def root=(root)

lib/active_model/serializer/configuration.rb

@@ -6,7 +6,7 @@ module Configuration
 
       included do |base|
         base.config.array_serializer = ActiveModel::Serializer::ArraySerializer
-        base.config.adapter = :json
+        base.config.adapter = :flatten_json
       end
     end
   end

lib/active_model/serializer/fieldset.rb

@@ -12,8 +12,8 @@ def fields
       end
 
       def fields_for(serializer)
-        key = serializer.json_key || serializer.class.root_name
-        fields[key.to_sym]
+        key = serializer.json_key
+        fields[key.to_sym] || fields[key.pluralize.to_sym]
       end
 
     private

test/action_controller/explicit_serializer_test.rb

@@ -77,12 +77,10 @@ def test_render_array_using_explicit_serializer
         get :render_array_using_explicit_serializer
         assert_equal 'application/json', @response.content_type
 
-        expected = {
-          'paginated' => [
-            { 'name' => 'Name 1' },
-            { 'name' => 'Name 2' }
-          ]
-        }
+        expected = [
+          { 'name' => 'Name 1' },
+          { 'name' => 'Name 2' }
+        ]
 
         assert_equal expected.to_json, @response.body
       end

test/action_controller/serialization_test.rb

@@ -10,13 +10,17 @@ def render_using_implicit_serializer
         end
 
         def render_using_custom_root
-          @profile = Profile.new({ name: 'Name 1', description: 'Description 1', comments: 'Comments 1' })
-          render json: @profile, root: "custom_root"
+          with_adapter ActiveModel::Serializer::Adapter::Json do
+            @profile = Profile.new({ name: 'Name 1', description: 'Description 1', comments: 'Comments 1' })
+            render json: @profile, root: "custom_root"
+          end
         end
 
         def render_using_custom_root_and_meta
-          @profile = Profile.new({ name: 'Name 1', description: 'Description 1', comments: 'Comments 1' })
-          render json: @profile, root: "custom_root", meta: { total: 10 }
+          with_adapter ActiveModel::Serializer::Adapter::Json do
+            @profile = Profile.new({ name: 'Name 1', description: 'Description 1', comments: 'Comments 1' })
+            render json: @profile, root: "custom_root", meta: { total: 10 }
+          end
         end
 
         def render_using_default_adapter_root
@@ -34,11 +38,13 @@ def render_using_custom_root_in_adapter_with_a_default
         end
 
         def render_array_using_custom_root_and_meta
-          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, root: "custom_root", meta: { total: 10 }
+          with_adapter ActiveModel::Serializer::Adapter::Json do
+            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, root: "custom_root", meta: { total: 10 }
+          end
         end
 
         def render_array_using_implicit_serializer
@@ -167,20 +173,6 @@ def test_render_using_implicit_serializer
         assert_equal expected.to_json, @response.body
       end
 
-      def test_render_using_custom_root
-        get :render_using_custom_root
-
-        assert_equal 'application/json', @response.content_type
-        assert_equal '{"custom_root":{"name":"Name 1","description":"Description 1"}}', @response.body
-      end
-
-      def test_render_using_custom_root_and_meta
-        get :render_using_custom_root_and_meta
-
-        assert_equal 'application/json', @response.content_type
-        assert_equal '{"custom_root":{"name":"Name 1","description":"Description 1"},"meta":{"total":10}}', @response.body
-      end
-
       def test_render_using_default_root
         get :render_using_default_adapter_root
 
@@ -217,25 +209,6 @@ def test_render_using_custom_root_in_adapter_with_a_default
         assert_equal expected.to_json, @response.body
       end
 
-      def test_render_array_using_custom_root_and_meta
-        get :render_array_using_custom_root_and_meta
-        assert_equal 'application/json', @response.content_type
-
-        expected = { custom_root: [
-          {
-            name: 'Name 1',
-            description: 'Description 1',
-          },
-          {
-            name: 'Name 2',
-            description: 'Description 2',
-          }],
-          meta: { total: 10 }
-        }
-
-        assert_equal expected.to_json, @response.body
-      end
-
       def test_render_array_using_implicit_serializer
         get :render_array_using_implicit_serializer
         assert_equal 'application/json', @response.content_type

test/adapter/fragment_cache_test.rb

@@ -8,7 +8,7 @@ def setup
           @role            = Role.new(name: 'Great Author', description:nil)
           @role.author     = [@author]
           @role_serializer = RoleSerializer.new(@role)
-          @role_hash       = FragmentCache.new(RoleSerializer.adapter.new(@role_serializer), @role_serializer, {}, nil)
+          @role_hash       = FragmentCache.new(RoleSerializer.adapter.new(@role_serializer), @role_serializer, {})
         end
 
         def test_fragment_fetch_with_virtual_attributes

test/adapter/json/belongs_to_test.rb

@@ -25,21 +25,21 @@ def setup
           end
 
           def test_includes_post
-            assert_equal({id: 42, title: 'New Post', body: 'Body'}, @adapter.serializable_hash[:post])
+            assert_equal({id: 42, title: 'New Post', body: 'Body'}, @adapter.serializable_hash[:comment][:post])
           end
 
           def test_include_nil_author
             serializer = PostSerializer.new(@anonymous_post)
             adapter = ActiveModel::Serializer::Adapter::Json.new(serializer)
 
-            assert_equal({title: "Hello!!", body: "Hello, world!!", id: 43, comments: [], blog: {id: 999, name: "Custom blog"}, author: nil}, adapter.serializable_hash)
+            assert_equal({post: {title: "Hello!!", body: "Hello, world!!", id: 43, comments: [], blog: {id: 999, name: "Custom blog"}, author: nil}}, adapter.serializable_hash)
           end
 
           def test_include_nil_author_with_specified_serializer
             serializer = PostPreviewSerializer.new(@anonymous_post)
             adapter = ActiveModel::Serializer::Adapter::Json.new(serializer)
 
-            assert_equal({title: "Hello!!", body: "Hello, world!!", id: 43, comments: [], author: nil}, adapter.serializable_hash)
+            assert_equal({posts: {title: "Hello!!", body: "Hello, world!!", id: 43, comments: [], author: nil}}, adapter.serializable_hash)
           end
         end
       end

test/adapter/json/collection_test.rb

@@ -28,16 +28,16 @@ def test_with_serializer_option
             @serializer = ArraySerializer.new([@blog], serializer: CustomBlogSerializer)
             @adapter = ActiveModel::Serializer::Adapter::Json.new(@serializer)
 
-            expected = [{
+            expected = {custom_blogs:[{
               id: 1,
               special_attribute: "Special",
               articles: [{id: 1,title: "Hello!!", body: "Hello, world!!"}, {id: 2, title: "New Post", body: "Body"}]
-            }]
+            }]}
             assert_equal expected, @adapter.serializable_hash
           end
 
           def test_include_multiple_posts
-            expected = [{
+            expected = { posts: [{
               title: "Hello!!",
               body: "Hello, world!!",
               id: 1,
@@ -63,7 +63,7 @@ def test_include_multiple_posts
                 id: 999,
                 name: "Custom blog"
               }
-            }]
+            }]}
             assert_equal expected, @adapter.serializable_hash
           end
         end

test/adapter/json/has_many_test.rb

@@ -26,7 +26,7 @@ def test_has_many
             assert_equal([
                            {id: 1, body: 'ZOMG A COMMENT'},
                            {id: 2, body: 'ZOMG ANOTHER COMMENT'}
-                         ], @adapter.serializable_hash[:comments])
+                         ], @adapter.serializable_hash[:post][:comments])
           end
         end
       end

test/adapter/json_api/collection_test.rb

@@ -86,7 +86,6 @@ def test_limiting_fields
                 }
               }
             ]
-
             assert_equal(expected, @adapter.serializable_hash[:data])
           end
 

test/adapter/json_test.rb

@@ -25,7 +25,7 @@ def test_has_many
           assert_equal([
                          {id: 1, body: 'ZOMG A COMMENT'},
                          {id: 2, body: 'ZOMG ANOTHER COMMENT'}
-                       ], @adapter.serializable_hash[:comments])
+                       ], @adapter.serializable_hash[:post][:comments])
         end
       end
     end

test/adapter_test.rb

@@ -31,7 +31,7 @@ def test_adapter_class_for_unknown_adapter
 
       def test_create_adapter
         adapter = ActiveModel::Serializer::Adapter.create(@serializer)
-        assert_equal ActiveModel::Serializer::Adapter::Json, adapter.class
+        assert_equal ActiveModel::Serializer::Adapter::FlattenJson, adapter.class
       end
 
       def test_create_adapter_with_override