active_model_serializers 0.10.0.rc4 → 0.10.0.rc5

data/test/action_controller/json_api/errors_test.rb

@@ -0,0 +1,41 @@
+require 'test_helper'
+
+module ActionController
+  module Serialization
+    class JsonApi
+      class ErrorsTest < ActionController::TestCase
+        def test_active_model_with_multiple_errors
+          get :render_resource_with_errors
+
+          expected_errors_object =
+            { :errors =>
+              [
+                { :source => { :pointer => '/data/attributes/name' }, :detail => 'cannot be nil' },
+                { :source => { :pointer => '/data/attributes/name' }, :detail => 'must be longer' },
+                { :source => { :pointer => '/data/attributes/id' }, :detail => 'must be a uuid' }
+              ]
+          }.to_json
+          assert_equal json_reponse_body.to_json, expected_errors_object
+        end
+
+        def json_reponse_body
+          JSON.load(@response.body)
+        end
+
+        class ErrorsTestController < ActionController::Base
+          def render_resource_with_errors
+            resource = Profile.new(name: 'Name 1',
+                                   description: 'Description 1',
+                                   comments: 'Comments 1')
+            resource.errors.add(:name, 'cannot be nil')
+            resource.errors.add(:name, 'must be longer')
+            resource.errors.add(:id, 'must be a uuid')
+            render json: resource, adapter: :json_api, serializer: ActiveModel::Serializer::ErrorSerializer
+          end
+        end
+
+        tests ErrorsTestController
+      end
+    end
+  end
+end

data/test/action_controller/json_api/linked_test.rb

@@ -5,6 +5,7 @@ module ActionController
     class JsonApi
       class LinkedTest < ActionController::TestCase
         class LinkedTestController < ActionController::Base
+          require 'active_model_serializers/register_jsonapi_renderer'
           def setup_post
             ActionController::Base.cache_store.clear
             @role1 = Role.new(id: 1, name: 'admin')
@@ -38,49 +39,49 @@ module ActionController
 
           def render_resource_without_include
             setup_post
-            render json: @post, adapter: :json_api
+            render jsonapi: @post
           end
 
           def render_resource_with_include
             setup_post
-            render json: @post, include: [:author], adapter: :json_api
+            render jsonapi: @post, include: [:author]
           end
 
           def render_resource_with_include_of_custom_key_by_original
             setup_post
-            render json: @post, include: [:reviews], adapter: :json_api, serializer: PostWithCustomKeysSerializer
+            render jsonapi: @post, include: [:reviews], serializer: PostWithCustomKeysSerializer
           end
 
           def render_resource_with_nested_include
             setup_post
-            render json: @post, include: [comments: [:author]], adapter: :json_api
+            render jsonapi: @post, include: [comments: [:author]]
           end
 
           def render_resource_with_nested_has_many_include_wildcard
             setup_post
-            render json: @post, include: 'author.*', adapter: :json_api
+            render jsonapi: @post, include: 'author.*'
           end
 
           def render_resource_with_missing_nested_has_many_include
             setup_post
             @post.author = @author2 # author2 has no roles.
-            render json: @post, include: [author: [:roles]], adapter: :json_api
+            render jsonapi: @post, include: [author: [:roles]]
           end
 
           def render_collection_with_missing_nested_has_many_include
             setup_post
             @post.author = @author2
-            render json: [@post, @post2], include: [author: [:roles]], adapter: :json_api
+            render jsonapi: [@post, @post2], include: [author: [:roles]]
           end
 
           def render_collection_without_include
             setup_post
-            render json: [@post], adapter: :json_api
+            render jsonapi: [@post]
           end
 
           def render_collection_with_include
             setup_post
-            render json: [@post], include: 'author, comments', adapter: :json_api
+            render jsonapi: [@post], include: 'author, comments'
           end
         end
 

data/test/action_controller/json_api/pagination_test.rb

@@ -8,8 +8,8 @@ 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'
+        KAMINARI_URI = 'http://test.host/action_controller/serialization/json_api/pagination_test/pagination_test/render_pagination_using_kaminari'.freeze
+        WILL_PAGINATE_URI = 'http://test.host/action_controller/serialization/json_api/pagination_test/pagination_test/render_pagination_using_will_paginate'.freeze
 
         class PaginationTestController < ActionController::Base
           def setup

data/test/action_controller/json_api/transform_test.rb

@@ -0,0 +1,180 @@
+require 'test_helper'
+
+module ActionController
+  module Serialization
+    class JsonApi
+      class KeyTransformTest < ActionController::TestCase
+        class KeyTransformTestController < ActionController::Base
+          Post = Class.new(::Model)
+          class PostSerializer < ActiveModel::Serializer
+            type 'posts'
+            attributes :title, :body, :publish_at
+            belongs_to :author
+            has_many :top_comments
+
+            link(:post_authors) { 'https://example.com/post_authors' }
+
+            meta do
+              {
+                rating: 5,
+                favorite_count: 10
+              }
+            end
+          end
+
+          Author = Class.new(::Model)
+          class AuthorSerializer < ActiveModel::Serializer
+            type 'authors'
+            attributes :first_name, :last_name
+          end
+
+          TopComment = Class.new(::Model)
+          class TopCommentSerializer < ActiveModel::Serializer
+            type 'top_comments'
+            attributes :body
+            belongs_to :author
+          end
+
+          def setup_post
+            ActionController::Base.cache_store.clear
+            @author = Author.new(id: 1, first_name: 'Bob', last_name: 'Jones')
+            @comment1 = TopComment.new(id: 7, body: 'cool', author: @author)
+            @comment2 = TopComment.new(id: 12, body: 'awesome', author: @author)
+            @post = Post.new(id: 1337, title: 'Title 1', body: 'Body 1',
+                             author: @author, top_comments: [@comment1, @comment2],
+                             publish_at: '2020-03-16T03:55:25.291Z')
+            @comment1.post = @post
+            @comment2.post = @post
+          end
+
+          def render_resource_with_transform
+            setup_post
+            render json: @post, serializer: PostSerializer, adapter: :json_api,
+                   key_transform: :camel
+          end
+
+          def render_resource_with_transform_nil
+            setup_post
+            render json: @post, serializer: PostSerializer, adapter: :json_api,
+                   key_transform: nil
+          end
+
+          def render_resource_with_transform_with_global_config
+            setup_post
+            old_transform = ActiveModelSerializers.config.key_transform
+            ActiveModelSerializers.config.key_transform = :camel_lower
+            render json: @post, serializer: PostSerializer, adapter: :json_api
+            ActiveModelSerializers.config.key_transform = old_transform
+          end
+        end
+
+        tests KeyTransformTestController
+
+        def test_render_resource_with_transform
+          get :render_resource_with_transform
+          response = JSON.parse(@response.body)
+          expected = {
+            'Data' => {
+              'Id' => '1337',
+              'Type' => 'Posts',
+              'Attributes' => {
+                'Title' => 'Title 1',
+                'Body' => 'Body 1',
+                'PublishAt' => '2020-03-16T03:55:25.291Z'
+              },
+              'Relationships' => {
+                'Author' => {
+                  'Data' => {
+                    'Id' => '1',
+                    'Type' => 'Authors'
+                  }
+                },
+                'TopComments' => {
+                  'Data' => [
+                    { 'Id' => '7', 'Type' => 'TopComments' },
+                    { 'Id' => '12', 'Type' => 'TopComments' }
+                  ]
+                }
+              },
+              'Links' => {
+                'PostAuthors' => 'https://example.com/post_authors'
+              },
+              'Meta' => { 'Rating' => 5, 'FavoriteCount' => 10 }
+            }
+          }
+          assert_equal expected, response
+        end
+
+        def test_render_resource_with_transform_nil
+          get :render_resource_with_transform_nil
+          response = JSON.parse(@response.body)
+          expected = {
+            'data' => {
+              'id' => '1337',
+              'type' => 'posts',
+              'attributes' => {
+                'title' => 'Title 1',
+                'body' => 'Body 1',
+                'publish-at' => '2020-03-16T03:55:25.291Z'
+              },
+              'relationships' => {
+                'author' => {
+                  'data' => {
+                    'id' => '1',
+                    'type' => 'authors'
+                  }
+                },
+                'top-comments' => {
+                  'data' => [
+                    { 'id' => '7', 'type' => 'top-comments' },
+                    { 'id' => '12', 'type' => 'top-comments' }
+                  ]
+                }
+              },
+              'links' => {
+                'post-authors' => 'https://example.com/post_authors'
+              },
+              'meta' => { 'rating' => 5, 'favorite-count' => 10 }
+            }
+          }
+          assert_equal expected, response
+        end
+
+        def test_render_resource_with_transform_with_global_config
+          get :render_resource_with_transform_with_global_config
+          response = JSON.parse(@response.body)
+          expected =  {
+            'data' => {
+              'id' => '1337',
+              'type' => 'posts',
+              'attributes' => {
+                'title' => 'Title 1',
+                'body' => 'Body 1',
+                'publishAt' => '2020-03-16T03:55:25.291Z'
+              },
+              'relationships' => {
+                'author' => {
+                  'data' => {
+                    'id' => '1',
+                    'type' => 'authors'
+                  }
+                },
+                'topComments' => {
+                  'data' => [
+                    { 'id' => '7', 'type' => 'topComments' },
+                    { 'id' => '12', 'type' => 'topComments' }
+                  ]
+                }
+              },
+              'links' => {
+                'postAuthors' => 'https://example.com/post_authors'
+              },
+              'meta' => { 'rating' => 5, 'favoriteCount' => 10 }
+            }
+          }
+          assert_equal expected, response
+        end
+      end
+    end
+  end
+end

data/test/action_controller/serialization_scope_name_test.rb

@@ -1,63 +1,229 @@
 require 'test_helper'
-require 'pathname'
 
-class DefaultScopeNameTest < ActionController::TestCase
-  class UserSerializer < ActiveModel::Serializer
+module SerializationScopeTesting
+  class User < ActiveModelSerializers::Model
+    attr_accessor :id, :name, :admin
     def admin?
-      current_user.admin
+      admin
     end
-    attributes :admin?
   end
+  class Comment < ActiveModelSerializers::Model
+    attr_accessor :id, :body
+  end
+  class Post < ActiveModelSerializers::Model
+    attr_accessor :id, :title, :body, :comments
+  end
+  class PostSerializer < ActiveModel::Serializer
+    attributes :id, :title, :body, :comments
 
-  class UserTestController < ActionController::Base
-    protect_from_forgery
-
-    before_action { request.format = :json }
+    def body
+      "The 'scope' is the 'current_user': #{scope == current_user}"
+    end
 
-    def current_user
-      User.new(id: 1, name: 'Pete', admin: false)
+    def comments
+      if current_user.admin?
+        [Comment.new(id: 1, body: 'Admin')]
+      else
+        [Comment.new(id: 2, body: 'Scoped')]
+      end
     end
 
-    def render_new_user
-      render json: User.new(id: 1, name: 'Pete', admin: false), serializer: UserSerializer, adapter: :json_api
+    def json_key
+      'post'
     end
   end
+  class PostTestController < ActionController::Base
+    attr_accessor :current_user
+    def render_post_by_non_admin
+      self.current_user = User.new(id: 3, name: 'Pete', admin: false)
+      render json: new_post, serializer: serializer, adapter: :json
+    end
 
-  tests UserTestController
+    def render_post_by_admin
+      self.current_user = User.new(id: 3, name: 'Pete', admin: true)
+      render json: new_post, serializer: serializer, adapter: :json
+    end
 
-  def test_default_scope_name
-    get :render_new_user
-    assert_equal '{"data":{"id":"1","type":"users","attributes":{"admin?":false}}}', @response.body
+    private
+
+    def new_post
+      Post.new(id: 4, title: 'Title')
+    end
+
+    def serializer
+      PostSerializer
+    end
   end
-end
+  class PostViewContextSerializer < PostSerializer
+    def body
+      "The 'scope' is the 'view_context': #{scope == view_context}"
+    end
 
-class SerializationScopeNameTest < ActionController::TestCase
-  class AdminUserSerializer < ActiveModel::Serializer
-    def admin?
-      current_admin.admin
+    def comments
+      if view_context.controller.current_user.admin?
+        [Comment.new(id: 1, body: 'Admin')]
+      else
+        [Comment.new(id: 2, body: 'Scoped')]
+      end
+    end
+  end
+  class DefaultScopeTest < ActionController::TestCase
+    tests PostTestController
+
+    def test_default_serialization_scope
+      assert_equal :current_user, @controller._serialization_scope
+    end
+
+    def test_default_serialization_scope_object
+      assert_equal @controller.current_user, @controller.serialization_scope
+    end
+
+    def test_default_scope_non_admin
+      get :render_post_by_non_admin
+      expected_json = {
+        post: {
+          id: 4,
+          title: 'Title',
+          body: "The 'scope' is the 'current_user': true",
+          comments: [
+            { id: 2, body: 'Scoped' }
+          ]
+        }
+      }.to_json
+      assert_equal expected_json, @response.body
+    end
+
+    def test_default_scope_admin
+      get :render_post_by_admin
+      expected_json = {
+        post: {
+          id: 4,
+          title: 'Title',
+          body: "The 'scope' is the 'current_user': true",
+          comments: [
+            { id: 1, body: 'Admin' }
+          ]
+        }
+      }.to_json
+      assert_equal expected_json, @response.body
     end
-    attributes :admin?
   end
+  class SerializationScopeTest < ActionController::TestCase
+    class PostViewContextTestController < PostTestController
+      serialization_scope :view_context
+
+      private
+
+      def serializer
+        PostViewContextSerializer
+      end
+    end
+    tests PostViewContextTestController
 
-  class AdminUserTestController < ActionController::Base
-    protect_from_forgery
+    def test_defined_serialization_scope
+      assert_equal :view_context, @controller._serialization_scope
+    end
 
-    serialization_scope :current_admin
-    before_action { request.format = :json }
+    def test_defined_serialization_scope_object
+      assert_equal @controller.view_context.class, @controller.serialization_scope.class
+    end
 
-    def current_admin
-      User.new(id: 2, name: 'Bob', admin: true)
+    def test_serialization_scope_non_admin
+      get :render_post_by_non_admin
+      expected_json = {
+        post: {
+          id: 4,
+          title: 'Title',
+          body: "The 'scope' is the 'view_context': true",
+          comments: [
+            { id: 2, body: 'Scoped' }
+          ]
+        }
+      }.to_json
+      assert_equal expected_json, @response.body
     end
 
-    def render_new_user
-      render json: User.new(id: 1, name: 'Pete', admin: false), serializer: AdminUserSerializer, adapter: :json_api
+    def test_serialization_scope_admin
+      get :render_post_by_admin
+      expected_json = {
+        post: {
+          id: 4,
+          title: 'Title',
+          body: "The 'scope' is the 'view_context': true",
+          comments: [
+            { id: 1, body: 'Admin' }
+          ]
+        }
+      }.to_json
+      assert_equal expected_json, @response.body
     end
   end
+  class NilSerializationScopeTest < ActionController::TestCase
+    class PostViewContextTestController < ActionController::Base
+      serialization_scope nil
 
-  tests AdminUserTestController
+      attr_accessor :current_user
 
-  def test_override_scope_name_with_controller
-    get :render_new_user
-    assert_equal '{"data":{"id":"1","type":"users","attributes":{"admin?":true}}}', @response.body
+      def render_post_with_no_scope
+        self.current_user = User.new(id: 3, name: 'Pete', admin: false)
+        render json: new_post, serializer: PostSerializer, adapter: :json
+      end
+
+      def render_post_with_passed_in_scope
+        self.current_user = User.new(id: 3, name: 'Pete', admin: false)
+        render json: new_post, serializer: PostSerializer, adapter: :json, scope: current_user, scope_name: :current_user
+      end
+
+      def render_post_with_passed_in_scope_without_scope_name
+        self.current_user = User.new(id: 3, name: 'Pete', admin: false)
+        render json: new_post, serializer: PostSerializer, adapter: :json, scope: current_user
+      end
+
+      private
+
+      def new_post
+        Post.new(id: 4, title: 'Title')
+      end
+    end
+    tests PostViewContextTestController
+
+    def test_nil_serialization_scope
+      assert_nil @controller._serialization_scope
+    end
+
+    def test_nil_serialization_scope_object
+      assert_nil @controller.serialization_scope
+    end
+
+    def test_nil_scope
+      exception_matcher = /current_user/
+      exception = assert_raises(NameError) do
+        get :render_post_with_no_scope
+      end
+      assert_match exception_matcher, exception.message
+    end
+
+    def test_serialization_scope_is_and_nil_scope_passed_in_current_user
+      get :render_post_with_passed_in_scope
+      expected_json = {
+        post: {
+          id: 4,
+          title: 'Title',
+          body: "The 'scope' is the 'current_user': true",
+          comments: [
+            { id: 2, body: 'Scoped' }
+          ]
+        }
+      }.to_json
+      assert_equal expected_json, @response.body
+    end
+
+    def test_serialization_scope_is_nil_and_scope_passed_in_current_user_without_scope_name
+      exception_matcher = /current_user/
+      exception = assert_raises(NameError) do
+        get :render_post_with_passed_in_scope_without_scope_name
+      end
+      assert_match exception_matcher, exception.message
+    end
   end
 end