active_model_serializers/test/adapter/json_api/transform_test.rb

# frozen_string_literal: true

require 'test_helper'

module ActiveModelSerializers
  module Adapter
    class JsonApi
      class KeyCaseTest < ActiveSupport::TestCase
        class Post < ::Model
          attributes :title, :body, :publish_at
          associations :author, :comments
        end
        class Author < ::Model
          attributes :first_name, :last_name
        end
        class Comment < ::Model
          attributes :body
          associations :author, :post
        end

        class PostSerializer < ActiveModel::Serializer
          type 'posts'
          attributes :title, :body, :publish_at
          belongs_to :author
          has_many :comments

          link(:self) { post_url(object.id) }
          link(:post_authors) { post_authors_url(object.id) }
          link(:subscriber_comments) { post_comments_url(object.id) }

          meta do
            {
              rating: 5,
              favorite_count: 10
            }
          end
        end

        class AuthorSerializer < ActiveModel::Serializer
          type 'authors'
          attributes :first_name, :last_name
        end

        class CommentSerializer < ActiveModel::Serializer
          type 'comments'
          attributes :body
          belongs_to :author
        end

        def mock_request(transform = nil)
          context = Minitest::Mock.new
          context.expect(:request_url, URI)
          context.expect(:query_parameters, {})
          context.expect(:url_helpers, Rails.application.routes.url_helpers)
          @options = {}
          @options[:key_transform] = transform if transform
          @options[:serialization_context] = context
        end

        def setup
          Rails.application.routes.draw do
            resources :posts do
              resources :authors
              resources :comments
            end
          end
          @publish_at = 1.day.from_now
          @author = Author.new(id: 1, first_name: 'Bob', last_name: 'Jones')
          @comment1 = Comment.new(id: 7, body: 'cool', author: @author)
          @comment2 = Comment.new(id: 12, body: 'awesome', author: @author)
          @post = Post.new(id: 1337, title: 'Title 1', body: 'Body 1',
                           author: @author, comments: [@comment1, @comment2],
                           publish_at: @publish_at)
          @comment1.post = @post
          @comment2.post = @post
        end

        def test_success_document_transform_default
          mock_request
          serializer = PostSerializer.new(@post)
          adapter = ActiveModelSerializers::Adapter::JsonApi.new(serializer, @options)
          result = adapter.serializable_hash
          assert_equal({
                         data: {
                           id: '1337',
                           type: 'posts',
                           attributes: {
                             title: 'Title 1',
                             body: 'Body 1',
                             :"publish-at" => @publish_at
                           },
                           relationships: {
                             author: {
                               data: { id: '1', type: 'authors' }
                             },
                             comments: {
                               data: [
                                 { id: '7', type: 'comments' },
                                 { id: '12', type: 'comments' }
                               ]
                             }
                           },
                           links: {
                             self: 'http://example.com/posts/1337',
                             :"post-authors" => 'http://example.com/posts/1337/authors',
                             :"subscriber-comments" => 'http://example.com/posts/1337/comments'
                           },
                           meta: { rating: 5, :"favorite-count" => 10 }
                         }
                       }, result)
        end

        def test_success_document_transform_global_config
          mock_request
          result = with_config(key_transform: :camel_lower) do
            serializer = PostSerializer.new(@post)
            adapter = ActiveModelSerializers::Adapter::JsonApi.new(serializer, @options)
            adapter.serializable_hash
          end
          assert_equal({
                         data: {
                           id: '1337',
                           type: 'posts',
                           attributes: {
                             title: 'Title 1',
                             body: 'Body 1',
                             publishAt: @publish_at
                           },
                           relationships: {
                             author: {
                               data: { id: '1', type: 'authors' }
                             },
                             comments: {
                               data: [
                                 { id: '7', type: 'comments' },
                                 { id: '12', type: 'comments' }
                               ]
                             }
                           },
                           links: {
                             self: 'http://example.com/posts/1337',
                             postAuthors: 'http://example.com/posts/1337/authors',
                             subscriberComments: 'http://example.com/posts/1337/comments'
                           },
                           meta: { rating: 5, favoriteCount: 10 }
                         }
                       }, result)
        end

        def test_success_doc_transform_serialization_ctx_overrides_global
          mock_request(:camel)
          result = with_config(key_transform: :camel_lower) do
            serializer = PostSerializer.new(@post)
            adapter = ActiveModelSerializers::Adapter::JsonApi.new(serializer, @options)
            adapter.serializable_hash
          end
          assert_equal({
                         Data: {
                           Id: '1337',
                           Type: 'Posts',
                           Attributes: {
                             Title: 'Title 1',
                             Body: 'Body 1',
                             PublishAt: @publish_at
                           },
                           Relationships: {
                             Author: {
                               Data: { Id: '1', Type: 'Authors' }
                             },
                             Comments: {
                               Data: [
                                 { Id: '7', Type: 'Comments' },
                                 { Id: '12', Type: 'Comments' }
                               ]
                             }
                           },
                           Links: {
                             Self: 'http://example.com/posts/1337',
                             PostAuthors: 'http://example.com/posts/1337/authors',
                             SubscriberComments: 'http://example.com/posts/1337/comments'
                           },
                           Meta: { Rating: 5, FavoriteCount: 10 }
                         }
                       }, result)
        end

        def test_success_document_transform_dash
          mock_request(:dash)
          serializer = PostSerializer.new(@post)
          adapter = ActiveModelSerializers::Adapter::JsonApi.new(serializer, @options)
          result = adapter.serializable_hash
          assert_equal({
                         data: {
                           id: '1337',
                           type: 'posts',
                           attributes: {
                             title: 'Title 1',
                             body: 'Body 1',
                             :"publish-at" => @publish_at
                           },
                           relationships: {
                             author: {
                               data: { id: '1', type: 'authors' }
                             },
                             comments: {
                               data: [
                                 { id: '7', type: 'comments' },
                                 { id: '12', type: 'comments' }
                               ]
                             }
                           },
                           links: {
                             self: 'http://example.com/posts/1337',
                             :"post-authors" => 'http://example.com/posts/1337/authors',
                             :"subscriber-comments" => 'http://example.com/posts/1337/comments'
                           },
                           meta: { rating: 5, :"favorite-count" => 10 }
                         }
                       }, result)
        end

        def test_success_document_transform_unaltered
          mock_request(:unaltered)
          serializer = PostSerializer.new(@post)
          adapter = ActiveModelSerializers::Adapter::JsonApi.new(serializer, @options)
          result = adapter.serializable_hash
          assert_equal({
                         data: {
                           id: '1337',
                           type: 'posts',
                           attributes: {
                             title: 'Title 1',
                             body: 'Body 1',
                             publish_at: @publish_at
                           },
                           relationships: {
                             author: {
                               data: { id: '1', type: 'authors' }
                             },
                             comments: {
                               data: [
                                 { id: '7', type: 'comments' },
                                 { id: '12', type: 'comments' }
                               ]
                             }
                           },
                           links: {
                             self: 'http://example.com/posts/1337',
                             post_authors: 'http://example.com/posts/1337/authors',
                             subscriber_comments: 'http://example.com/posts/1337/comments'
                           },
                           meta: { rating: 5, favorite_count: 10 }
                         }
                       }, result)
        end

        def test_success_document_transform_undefined
          mock_request(:zoot)
          serializer = PostSerializer.new(@post)
          adapter = ActiveModelSerializers::Adapter::JsonApi.new(serializer, @options)
          exception = assert_raises NoMethodError do
            adapter.serializable_hash
          end
          assert_match(/undefined method.*zoot/, exception.message)
        end

        def test_success_document_transform_camel
          mock_request(:camel)
          serializer = PostSerializer.new(@post)
          adapter = ActiveModelSerializers::Adapter::JsonApi.new(serializer, @options)
          result = adapter.serializable_hash
          assert_equal({
                         Data: {
                           Id: '1337',
                           Type: 'Posts',
                           Attributes: {
                             Title: 'Title 1',
                             Body: 'Body 1',
                             PublishAt: @publish_at
                           },
                           Relationships: {
                             Author: {
                               Data: { Id: '1', Type: 'Authors' }
                             },
                             Comments: {
                               Data: [
                                 { Id: '7', Type: 'Comments' },
                                 { Id: '12', Type: 'Comments' }
                               ]
                             }
                           },
                           Links: {
                             Self: 'http://example.com/posts/1337',
                             PostAuthors: 'http://example.com/posts/1337/authors',
                             SubscriberComments: 'http://example.com/posts/1337/comments'
                           },
                           Meta: { Rating: 5, FavoriteCount: 10 }
                         }
                       }, result)
        end

        def test_success_document_transform_camel_lower
          mock_request(:camel_lower)
          serializer = PostSerializer.new(@post)
          adapter = ActiveModelSerializers::Adapter::JsonApi.new(serializer, @options)
          result = adapter.serializable_hash
          assert_equal({
                         data: {
                           id: '1337',
                           type: 'posts',
                           attributes: {
                             title: 'Title 1',
                             body: 'Body 1',
                             publishAt: @publish_at
                           },
                           relationships: {
                             author: {
                               data: { id: '1', type: 'authors' }
                             },
                             comments: {
                               data: [
                                 { id: '7', type: 'comments' },
                                 { id: '12', type: 'comments' }
                               ]
                             }
                           },
                           links: {
                             self: 'http://example.com/posts/1337',
                             postAuthors: 'http://example.com/posts/1337/authors',
                             subscriberComments: 'http://example.com/posts/1337/comments'
                           },
                           meta: { rating: 5, favoriteCount: 10 }
                         }
                       }, result)
        end

        def test_error_document_transform_default
          mock_request
          resource = ModelWithErrors.new
          resource.errors.add(:published_at, 'must be in the future')
          resource.errors.add(:title, 'must be longer')
          serializer = ActiveModel::Serializer::ErrorSerializer.new(resource)
          adapter = ActiveModelSerializers::Adapter::JsonApi.new(serializer, @options)
          result = adapter.serializable_hash
          expected_errors_object = {
            errors: [
              {
                source: { pointer: '/data/attributes/published-at' },
                detail: 'must be in the future'
              },
              {
                source: { pointer: '/data/attributes/title' },
                detail: 'must be longer'
              }
            ]
          }
          assert_equal expected_errors_object, result
        end

        def test_error_document_transform_global_config
          mock_request
          result = with_config(key_transform: :camel) do
            resource = ModelWithErrors.new
            resource.errors.add(:published_at, 'must be in the future')
            resource.errors.add(:title, 'must be longer')
            serializer = ActiveModel::Serializer::ErrorSerializer.new(resource)
            adapter = ActiveModelSerializers::Adapter::JsonApi.new(serializer, @options)
            adapter.serializable_hash
          end
          expected_errors_object = {
            Errors: [
              {
                Source: { Pointer: '/data/attributes/PublishedAt' },
                Detail: 'must be in the future'
              },
              {
                Source: { Pointer: '/data/attributes/Title' },
                Detail: 'must be longer'
              }
            ]
          }
          assert_equal expected_errors_object, result
        end

        def test_error_document_transform_serialization_ctx_overrides_global
          mock_request(:camel)
          result = with_config(key_transform: :camel_lower) do
            resource = ModelWithErrors.new
            resource.errors.add(:published_at, 'must be in the future')
            resource.errors.add(:title, 'must be longer')
            serializer = ActiveModel::Serializer::ErrorSerializer.new(resource)
            adapter = ActiveModelSerializers::Adapter::JsonApi.new(serializer, @options)
            adapter.serializable_hash
          end
          expected_errors_object = {
            Errors: [
              {
                Source: { Pointer: '/data/attributes/PublishedAt' },
                Detail: 'must be in the future'
              },
              {
                Source: { Pointer: '/data/attributes/Title' },
                Detail: 'must be longer'
              }
            ]
          }
          assert_equal expected_errors_object, result
        end

        def test_error_document_transform_dash
          mock_request(:dash)

          resource = ModelWithErrors.new
          resource.errors.add(:published_at, 'must be in the future')
          resource.errors.add(:title, 'must be longer')

          serializer = ActiveModel::Serializer::ErrorSerializer.new(resource)
          adapter = ActiveModelSerializers::Adapter::JsonApi.new(serializer, @options)
          result = adapter.serializable_hash

          expected_errors_object = {
            errors: [
              {
                source: { pointer: '/data/attributes/published-at' },
                detail: 'must be in the future'
              },
              {
                source: { pointer: '/data/attributes/title' },
                detail: 'must be longer'
              }
            ]
          }
          assert_equal expected_errors_object, result
        end

        def test_error_document_transform_unaltered
          mock_request(:unaltered)

          resource = ModelWithErrors.new
          resource.errors.add(:published_at, 'must be in the future')
          resource.errors.add(:title, 'must be longer')

          serializer = ActiveModel::Serializer::ErrorSerializer.new(resource)
          adapter = ActiveModelSerializers::Adapter::JsonApi.new(serializer, @options)
          result = adapter.serializable_hash

          expected_errors_object = {
            errors: [
              { source: { pointer: '/data/attributes/published_at' }, detail: 'must be in the future' },
              { source: { pointer: '/data/attributes/title' }, detail: 'must be longer' }
            ]
          }
          assert_equal expected_errors_object, result
        end

        def test_error_document_transform_undefined
          mock_request(:krazy)

          resource = ModelWithErrors.new
          resource.errors.add(:published_at, 'must be in the future')
          resource.errors.add(:title, 'must be longer')

          serializer = ActiveModel::Serializer::ErrorSerializer.new(resource)
          adapter = ActiveModelSerializers::Adapter::JsonApi.new(serializer, @options)

          exception = assert_raises NoMethodError do
            adapter.serializable_hash
          end
          assert_match(/undefined method.*krazy/, exception.message)
        end

        def test_error_document_transform_camel
          mock_request(:camel)

          resource = ModelWithErrors.new
          resource.errors.add(:published_at, 'must be in the future')
          resource.errors.add(:title, 'must be longer')

          serializer = ActiveModel::Serializer::ErrorSerializer.new(resource)
          adapter = ActiveModelSerializers::Adapter::JsonApi.new(serializer, @options)
          result = adapter.serializable_hash

          expected_errors_object = {
            Errors: [
              { Source: { Pointer: '/data/attributes/PublishedAt' }, Detail: 'must be in the future' },
              { Source: { Pointer: '/data/attributes/Title' }, Detail: 'must be longer' }
            ]
          }
          assert_equal expected_errors_object, result
        end

        def test_error_document_transform_camel_lower
          mock_request(:camel_lower)

          resource = ModelWithErrors.new
          resource.errors.add(:published_at, 'must be in the future')
          resource.errors.add(:title, 'must be longer')

          serializer = ActiveModel::Serializer::ErrorSerializer.new(resource)
          adapter = ActiveModelSerializers::Adapter::JsonApi.new(serializer, @options)
          result = adapter.serializable_hash

          expected_errors_object = {
            errors: [
              { source: { pointer: '/data/attributes/publishedAt' }, detail: 'must be in the future' },
              { source: { pointer: '/data/attributes/title' }, detail: 'must be longer' }
            ]
          }
          assert_equal expected_errors_object, result
        end
      end
    end
  end
end