active_model_serializers 0.10.0.rc2 → 0.10.0.rc3

data/test/action_controller/json_api/pagination_test.rb

@@ -0,0 +1,116 @@
+require 'test_helper'
+require 'will_paginate/array'
+require 'kaminari'
+require 'kaminari/hooks'
+::Kaminari::Hooks.init
+
+module ActionController
+  module Serialization
+    class JsonApi
+      class PaginationTest < ActionController::TestCase
+        KAMINARI_URI = 'http://test.host/action_controller/serialization/json_api/pagination_test/pagination_test/render_pagination_using_kaminari'
+        WILL_PAGINATE_URI = 'http://test.host/action_controller/serialization/json_api/pagination_test/pagination_test/render_pagination_using_will_paginate'
+
+        class PaginationTestController < ActionController::Base
+          def setup
+            @array = [
+              Profile.new({ name: 'Name 1', description: 'Description 1', comments: 'Comments 1' }),
+              Profile.new({ name: 'Name 2', description: 'Description 2', comments: 'Comments 2' }),
+              Profile.new({ name: 'Name 3', description: 'Description 3', comments: 'Comments 3' })
+            ]
+          end
+
+          def using_kaminari
+            setup
+            Kaminari.paginate_array(@array).page(params[:page][:number]).per(params[:page][:size])
+          end
+
+          def using_will_paginate
+            setup
+            @array.paginate(page: params[:page][:number], per_page: params[:page][:size])
+          end
+
+          def render_pagination_using_kaminari
+            render json: using_kaminari, adapter: :json_api
+          end
+
+          def render_pagination_using_will_paginate
+            render json: using_will_paginate, adapter: :json_api
+          end
+
+          def render_array_without_pagination_links
+            setup
+            render json: @array, adapter: :json_api
+          end
+        end
+
+        tests PaginationTestController
+
+        def test_render_pagination_links_with_will_paginate
+          expected_links = { 'self' => "#{WILL_PAGINATE_URI}?page%5Bnumber%5D=2&page%5Bsize%5D=1",
+            'first' => "#{WILL_PAGINATE_URI}?page%5Bnumber%5D=1&page%5Bsize%5D=1",
+            'prev' => "#{WILL_PAGINATE_URI}?page%5Bnumber%5D=1&page%5Bsize%5D=1",
+            'next' => "#{WILL_PAGINATE_URI}?page%5Bnumber%5D=3&page%5Bsize%5D=1",
+            'last' => "#{WILL_PAGINATE_URI}?page%5Bnumber%5D=3&page%5Bsize%5D=1" }
+
+          get :render_pagination_using_will_paginate, page: { number: 2, size: 1 }
+          response = JSON.parse(@response.body)
+          assert_equal expected_links, response['links']
+        end
+
+        def test_render_only_last_and_next_pagination_links
+          expected_links = { 'self' => "#{WILL_PAGINATE_URI}?page%5Bnumber%5D=1&page%5Bsize%5D=2",
+            'next' => "#{WILL_PAGINATE_URI}?page%5Bnumber%5D=2&page%5Bsize%5D=2",
+            'last' => "#{WILL_PAGINATE_URI}?page%5Bnumber%5D=2&page%5Bsize%5D=2" }
+          get :render_pagination_using_will_paginate, page: { number: 1, size: 2 }
+          response = JSON.parse(@response.body)
+          assert_equal expected_links, response['links']
+        end
+
+        def test_render_pagination_links_with_kaminari
+          expected_links = { 'self' => "#{KAMINARI_URI}?page%5Bnumber%5D=2&page%5Bsize%5D=1",
+            'first' => "#{KAMINARI_URI}?page%5Bnumber%5D=1&page%5Bsize%5D=1",
+            'prev' => "#{KAMINARI_URI}?page%5Bnumber%5D=1&page%5Bsize%5D=1",
+            'next' => "#{KAMINARI_URI}?page%5Bnumber%5D=3&page%5Bsize%5D=1",
+            'last' => "#{KAMINARI_URI}?page%5Bnumber%5D=3&page%5Bsize%5D=1" }
+          get :render_pagination_using_kaminari, page: { number: 2, size: 1 }
+          response = JSON.parse(@response.body)
+          assert_equal expected_links, response['links']
+        end
+
+        def test_render_only_prev_and_first_pagination_links
+          expected_links = { 'self' => "#{KAMINARI_URI}?page%5Bnumber%5D=3&page%5Bsize%5D=1",
+            'first' => "#{KAMINARI_URI}?page%5Bnumber%5D=1&page%5Bsize%5D=1",
+            'prev' => "#{KAMINARI_URI}?page%5Bnumber%5D=2&page%5Bsize%5D=1" }
+          get :render_pagination_using_kaminari, page: { number: 3, size: 1 }
+          response = JSON.parse(@response.body)
+          assert_equal expected_links, response['links']
+        end
+
+        def test_render_only_last_and_next_pagination_links_with_additional_params
+          expected_links = { 'self' => "#{WILL_PAGINATE_URI}?page%5Bnumber%5D=1&page%5Bsize%5D=2&teste=additional",
+            'next' => "#{WILL_PAGINATE_URI}?page%5Bnumber%5D=2&page%5Bsize%5D=2&teste=additional",
+            'last' => "#{WILL_PAGINATE_URI}?page%5Bnumber%5D=2&page%5Bsize%5D=2&teste=additional" }
+          get :render_pagination_using_will_paginate, page: { number: 1, size: 2 }, teste: 'additional'
+          response = JSON.parse(@response.body)
+          assert_equal expected_links, response['links']
+        end
+
+        def test_render_only_prev_and_first_pagination_links_with_additional_params
+          expected_links = { 'self' => "#{KAMINARI_URI}?page%5Bnumber%5D=3&page%5Bsize%5D=1&teste=additional",
+            'first' => "#{KAMINARI_URI}?page%5Bnumber%5D=1&page%5Bsize%5D=1&teste=additional",
+            'prev' => "#{KAMINARI_URI}?page%5Bnumber%5D=2&page%5Bsize%5D=1&teste=additional" }
+          get :render_pagination_using_kaminari, page: { number: 3, size: 1 }, teste: 'additional'
+          response = JSON.parse(@response.body)
+          assert_equal expected_links, response['links']
+        end
+
+        def test_array_without_pagination_links
+          get :render_array_without_pagination_links, page: { number: 2, size: 1 }
+          response = JSON.parse(@response.body)
+          refute response.key? 'links'
+        end
+      end
+    end
+  end
+end

data/test/action_controller/serialization_scope_name_test.rb

@@ -4,8 +4,10 @@ require 'pathname'
 class DefaultScopeNameTest < ActionController::TestCase
   class UserSerializer < ActiveModel::Serializer
     attributes :admin?
-    def admin?
-      current_user.admin
+    ActiveModelSerializers.silence_warnings do
+      def admin?
+        current_user.admin
+      end
     end
   end
 
@@ -23,7 +25,7 @@ class DefaultScopeNameTest < ActionController::TestCase
     end
   end
 
- tests UserTestController
+  tests UserTestController
 
   def test_default_scope_name
     get :render_new_user
@@ -34,8 +36,10 @@ end
 class SerializationScopeNameTest < ActionController::TestCase
   class AdminUserSerializer < ActiveModel::Serializer
     attributes :admin?
-    def admin?
-      current_admin.admin
+    ActiveModelSerializers.silence_warnings do
+      def admin?
+        current_admin.admin
+      end
     end
   end
 
@@ -60,4 +64,4 @@ class SerializationScopeNameTest < ActionController::TestCase
     get :render_new_user
     assert_equal '{"data":{"id":"1","type":"users","attributes":{"admin?":true}}}', @response.body
   end
-end
+end

data/test/action_controller/serialization_test.rb

@@ -3,73 +3,51 @@ require 'test_helper'
 module ActionController
   module Serialization
     class ImplicitSerializerTest < ActionController::TestCase
+      include ActiveSupport::Testing::Stream
       class ImplicitSerializationTestController < ActionController::Base
         def render_using_implicit_serializer
-          @profile = Profile.new({ name: 'Name 1', description: 'Description 1', comments: 'Comments 1' })
+          @profile = Profile.new(name: 'Name 1', description: 'Description 1', comments: 'Comments 1')
           render json: @profile
         end
 
-        def render_using_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
-          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
+        def render_using_default_adapter_root
+          @profile = Profile.new(name: 'Name 1', description: 'Description 1', comments: 'Comments 1')
+          render json: @profile
         end
 
-        def render_using_default_adapter_root
-          with_adapter ActiveModel::Serializer::Adapter::JsonApi do
-            # JSON-API adapter sets root by default
-            @profile = Profile.new({ name: 'Name 1', description: 'Description 1', comments: 'Comments 1' })
-            render json: @profile
-          end
+        def render_array_using_custom_root
+          @profile = Profile.new(name: 'Name 1', description: 'Description 1', comments: 'Comments 1')
+          render json: [@profile], root: 'custom_root'
         end
 
-        def render_using_custom_root_in_adapter_with_a_default
-          # JSON-API adapter sets root by default
-          @profile = Profile.new({ name: 'Name 1', description: 'Description 1', comments: 'Comments 1' })
-          render json: @profile, root: "profile", adapter: :json_api
+        def render_array_that_is_empty_using_custom_root
+          render json: [], root: 'custom_root'
         end
 
-        def render_array_using_custom_root_and_meta
-          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
+        def render_object_using_custom_root
+          @profile = Profile.new(name: 'Name 1', description: 'Description 1', comments: 'Comments 1')
+          render json: @profile, root: 'custom_root'
         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' })
+            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
 
         def render_array_using_implicit_serializer_and_meta
-          with_adapter ActiveModel::Serializer::Adapter::JsonApi do
-
-            @profiles = [
-              Profile.new({ name: 'Name 1', description: 'Description 1', comments: 'Comments 1' })
-            ]
-
-            render json: @profiles, meta: { total: 10 }
-          end
+          @profiles = [
+            Profile.new(name: 'Name 1', description: 'Description 1', comments: 'Comments 1')
+          ]
+          render json: @profiles, meta: { total: 10 }
         end
 
         def render_object_with_cache_enabled
-          @comment = Comment.new({ id: 1, body: 'ZOMG A COMMENT' })
+          @comment = Comment.new(id: 1, body: 'ZOMG A COMMENT')
           @author  = Author.new(id: 1, name: 'Joao Moura.')
-          @post    = Post.new({ id: 1, title: 'New Post', body: 'Body', comments: [@comment], author: @author })
+          @post    = Post.new(id: 1, title: 'New Post', body: 'Body', comments: [@comment], author: @author)
 
           generate_cached_serializer(@post)
 
@@ -77,17 +55,25 @@ module ActionController
           render json: @post
         end
 
+        def render_json_object_without_serializer
+          render json: { error: 'Result is Invalid' }
+        end
+
+        def render_json_array_object_without_serializer
+          render json: [{ error: 'Result is Invalid' }]
+        end
+
         def update_and_render_object_with_cache_enabled
-          @post.updated_at = DateTime.now
+          @post.updated_at = Time.now
 
           generate_cached_serializer(@post)
           render json: @post
         end
 
         def render_object_expired_with_cache_enabled
-          comment = Comment.new({ id: 1, body: 'ZOMG A COMMENT' })
+          comment = Comment.new(id: 1, body: 'ZOMG A COMMENT')
           author = Author.new(id: 1, name: 'Joao Moura.')
-          post = Post.new({ id: 1, title: 'New Post', body: 'Body', comments: [comment], author: author })
+          post = Post.new(id: 1, title: 'New Post', body: 'Body', comments: [comment], author: author)
 
           generate_cached_serializer(post)
 
@@ -97,16 +83,16 @@ module ActionController
         end
 
         def render_changed_object_with_cache_enabled
-          comment = Comment.new({ id: 1, body: 'ZOMG A COMMENT' })
+          comment = Comment.new(id: 1, body: 'ZOMG A COMMENT')
           author = Author.new(id: 1, name: 'Joao Moura.')
-          post = Post.new({ id: 1, title: 'ZOMG a New Post', body: 'Body', comments: [comment], author: author })
+          post = Post.new(id: 1, title: 'ZOMG a New Post', body: 'Body', comments: [comment], author: author)
 
           render json: post
         end
 
         def render_fragment_changed_object_with_only_cache_enabled
           author = Author.new(id: 1, name: 'Joao Moura.')
-          role = Role.new({ id: 42, name: 'ZOMG A ROLE', description: 'DESCRIPTION HERE', author: author })
+          role = Role.new(id: 42, name: 'ZOMG A ROLE', description: 'DESCRIPTION HERE', author: author)
 
           generate_cached_serializer(role)
           role.name = 'lol'
@@ -117,7 +103,7 @@ module ActionController
 
         def render_fragment_changed_object_with_except_cache_enabled
           author = Author.new(id: 1, name: 'Joao Moura.')
-          bio = Bio.new({ id: 42, content: 'ZOMG A ROLE', rating: 5, author: author })
+          bio = Bio.new(id: 42, content: 'ZOMG A ROLE', rating: 5, author: author)
 
           generate_cached_serializer(bio)
           bio.content = 'lol'
@@ -127,25 +113,21 @@ module ActionController
         end
 
         def render_fragment_changed_object_with_relationship
-          comment = Comment.new({ id: 1, body: 'ZOMG A COMMENT' })
-          author = Author.new(id: 1, name: 'Joao Moura.')
-          post = Post.new({ id: 1, title: 'New Post', body: 'Body', comments: [comment], author: author })
-          post2 = Post.new({ id: 1, title: 'New Post2', body: 'Body2', comments: [comment], author: author })
-          like = Like.new({ id: 1, post: post, time: 3.days.ago })
+          comment = Comment.new(id: 1, body: 'ZOMG A COMMENT')
+          comment2 = Comment.new(id: 1, body: 'ZOMG AN UPDATED-BUT-NOT-CACHE-EXPIRED COMMENT')
+          like = Like.new(id: 1, likeable: comment, time: 3.days.ago)
 
           generate_cached_serializer(like)
-          like.post = post2
-          like.time = DateTime.now.to_s
+          like.likable = comment2
+          like.time = Time.zone.now.to_s
 
           render json: like
         end
 
         private
+
         def generate_cached_serializer(obj)
-          serializer_class = ActiveModel::Serializer.serializer_for(obj)
-          serializer = serializer_class.new(obj)
-          adapter = ActiveModel::Serializer.adapter.new(serializer)
-          adapter.to_json
+          ActiveModel::SerializableResource.new(obj).to_json
         end
 
         def with_adapter(adapter)
@@ -165,8 +147,8 @@ module ActionController
         get :render_using_implicit_serializer
 
         expected = {
-          name: "Name 1",
-          description: "Description 1"
+          name: 'Name 1',
+          description: 'Description 1'
         }
 
         assert_equal 'application/json', @response.content_type
@@ -174,15 +156,16 @@ module ActionController
       end
 
       def test_render_using_default_root
-        get :render_using_default_adapter_root
-
+        with_adapter :json_api do
+          get :render_using_default_adapter_root
+        end
         expected = {
           data: {
             id: assigns(:profile).id.to_s,
-            type: "profiles",
+            type: 'profiles',
             attributes: {
-              name: "Name 1",
-              description: "Description 1"
+              name: 'Name 1',
+              description: 'Description 1'
             }
           }
         }
@@ -191,24 +174,51 @@ module ActionController
         assert_equal expected.to_json, @response.body
       end
 
-      def test_render_using_custom_root_in_adapter_with_a_default
-        get :render_using_custom_root_in_adapter_with_a_default
+      def test_render_array_using_custom_root
+        with_adapter :json do
+          get :render_array_using_custom_root
+        end
+        expected = { custom_roots: [{ name: 'Name 1', description: 'Description 1' }] }
+        assert_equal 'application/json', @response.content_type
+        assert_equal expected.to_json, @response.body
+      end
 
-        expected = {
-          data: {
-            id: assigns(:profile).id.to_s,
-            type: "profiles",
-            attributes: {
-              name: "Name 1",
-              description: "Description 1"
-            }
-          }
-        }
+      def test_render_array_that_is_empty_using_custom_root
+        with_adapter :json do
+          get :render_array_that_is_empty_using_custom_root
+        end
+
+        expected = { custom_roots: [] }
+        assert_equal 'application/json', @response.content_type
+        assert_equal expected.to_json, @response.body
+      end
+
+      def test_render_object_using_custom_root
+        with_adapter :json do
+          get :render_object_using_custom_root
+        end
 
+        expected = { custom_root: { name: 'Name 1', description: 'Description 1' } }
         assert_equal 'application/json', @response.content_type
         assert_equal expected.to_json, @response.body
       end
 
+      def test_render_json_object_without_serializer
+        get :render_json_object_without_serializer
+
+        assert_equal 'application/json', @response.content_type
+        expected_body = { error: 'Result is Invalid' }
+        assert_equal expected_body.to_json, @response.body
+      end
+
+      def test_render_json_array_object_without_serializer
+        get :render_json_array_object_without_serializer
+
+        assert_equal 'application/json', @response.content_type
+        expected_body = [{ error: 'Result is Invalid' }]
+        assert_equal expected_body.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
@@ -216,11 +226,11 @@ module ActionController
         expected = [
           {
             name: 'Name 1',
-            description: 'Description 1',
+            description: 'Description 1'
           },
           {
             name: 'Name 2',
-            description: 'Description 2',
+            description: 'Description 2'
           }
         ]
 
@@ -228,16 +238,17 @@ module ActionController
       end
 
       def test_render_array_using_implicit_serializer_and_meta
-        get :render_array_using_implicit_serializer_and_meta
-
+        with_adapter :json_api do
+          get :render_array_using_implicit_serializer_and_meta
+        end
         expected = {
           data: [
             {
               id: assigns(:profiles).first.id.to_s,
-              type: "profiles",
+              type: 'profiles',
               attributes: {
-                name: "Name 1",
-                description: "Description 1"
+                name: 'Name 1',
+                description: 'Description 1'
               }
             }
           ],
@@ -251,9 +262,6 @@ module ActionController
       end
 
       def test_render_with_cache_enable
-        ActionController::Base.cache_store.clear
-        get :render_object_with_cache_enabled
-
         expected = {
           id: 1,
           title: 'New Post',
@@ -273,11 +281,16 @@ module ActionController
           }
         }
 
-        assert_equal 'application/json', @response.content_type
-        assert_equal expected.to_json, @response.body
+        ActionController::Base.cache_store.clear
+        Timecop.freeze(Time.zone.now) do
+          get :render_object_with_cache_enabled
 
-        get :render_changed_object_with_cache_enabled
-        assert_equal expected.to_json, @response.body
+          assert_equal 'application/json', @response.content_type
+          assert_equal expected.to_json, @response.body
+
+          get :render_changed_object_with_cache_enabled
+          assert_equal expected.to_json, @response.body
+        end
 
         ActionController::Base.cache_store.clear
         get :render_changed_object_with_cache_enabled
@@ -317,8 +330,8 @@ module ActionController
         response = JSON.parse(@response.body)
 
         assert_equal 'application/json', @response.content_type
-        assert_equal 'ZOMG A ROLE', response["name"]
-        assert_equal 'HUEHUEBRBR', response["description"]
+        assert_equal 'ZOMG A ROLE', response['name']
+        assert_equal 'HUEHUEBRBR', response['description']
       end
 
       def test_render_with_fragment_except_cache_enable
@@ -327,27 +340,29 @@ module ActionController
         response = JSON.parse(@response.body)
 
         assert_equal 'application/json', @response.content_type
-        assert_equal 5, response["rating"]
-        assert_equal 'lol', response["content"]
+        assert_equal 5, response['rating']
+        assert_equal 'lol', response['content']
       end
 
       def test_render_fragment_changed_object_with_relationship
         ActionController::Base.cache_store.clear
-        get :render_fragment_changed_object_with_relationship
-        response = JSON.parse(@response.body)
 
-        expected_return = {
-          "id"=>1,
-          "time"=>DateTime.now.to_s,
-          "post" => {
-            "id"=>1,
-            "title"=>"New Post",
-            "body"=>"Body"
+        Timecop.freeze(Time.zone.now) do
+          get :render_fragment_changed_object_with_relationship
+          response = JSON.parse(@response.body)
+
+          expected_return = {
+            'id' => 1,
+            'time' => Time.zone.now.to_s,
+            'likeable' => {
+              'id' => 1,
+              'body' => 'ZOMG A COMMENT'
+            }
           }
-        }
 
-        assert_equal 'application/json', @response.content_type
-        assert_equal expected_return, response
+          assert_equal 'application/json', @response.content_type
+          assert_equal expected_return, response
+        end
       end
 
       def test_cache_expiration_on_update
@@ -364,8 +379,8 @@ module ActionController
               body: 'ZOMG A COMMENT' }
           ],
           blog: {
-            id:999,
-            name: "Custom blog"
+            id: 999,
+            name: 'Custom blog'
           },
           author: {
             id: 1,
@@ -378,6 +393,28 @@ module ActionController
         assert_equal 'application/json', @response.content_type
         assert_equal expected.to_json, @response.body
       end
+
+      def test_warn_overridding_use_adapter_as_falsy_on_controller_instance
+        controller = Class.new(ImplicitSerializationTestController) {
+          def use_adapter?
+            false
+          end
+        }.new
+        assert_match(/adapter: false/, (capture(:stderr) {
+          controller.get_serializer(Profile.new)
+        }))
+      end
+
+      def test_dont_warn_overridding_use_adapter_as_truthy_on_controller_instance
+        controller = Class.new(ImplicitSerializationTestController) {
+          def use_adapter?
+            true
+          end
+        }.new
+        assert_equal '', (capture(:stderr) {
+          controller.get_serializer(Profile.new)
+        })
+      end
     end
   end
 end