active_model_serializers 0.8.3 → 0.10.0

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'.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
+            @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, params: { 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, params: { 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, params: { 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, params: { 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, params: { 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, params: { 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, params: { page: { number: 2, size: 1 } }
+          response = JSON.parse(@response.body)
+          refute response.key? 'links'
+        end
+      end
+    end
+  end
+end

data/test/action_controller/json_api/transform_test.rb

@@ -0,0 +1,181 @@
+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
+            old_transform = ActiveModelSerializers.config.key_transform
+            setup_post
+            ActiveModelSerializers.config.key_transform = :camel_lower
+            render json: @post, serializer: PostSerializer, adapter: :json_api
+          ensure
+            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

@@ -0,0 +1,229 @@
+require 'test_helper'
+
+module SerializationScopeTesting
+  class User < ActiveModelSerializers::Model
+    attr_accessor :id, :name, :admin
+    def admin?
+      admin
+    end
+  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
+
+    def body
+      "The 'scope' is the 'current_user': #{scope == current_user}"
+    end
+
+    def comments
+      if current_user.admin?
+        [Comment.new(id: 1, body: 'Admin')]
+      else
+        [Comment.new(id: 2, body: 'Scoped')]
+      end
+    end
+
+    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
+
+    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
+
+    private
+
+    def new_post
+      Post.new(id: 4, title: 'Title')
+    end
+
+    def serializer
+      PostSerializer
+    end
+  end
+  class PostViewContextSerializer < PostSerializer
+    def body
+      "The 'scope' is the 'view_context': #{scope == view_context}"
+    end
+
+    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
+  end
+  class SerializationScopeTest < ActionController::TestCase
+    class PostViewContextTestController < PostTestController
+      serialization_scope :view_context
+
+      private
+
+      def serializer
+        PostViewContextSerializer
+      end
+    end
+    tests PostViewContextTestController
+
+    def test_defined_serialization_scope
+      assert_equal :view_context, @controller._serialization_scope
+    end
+
+    def test_defined_serialization_scope_object
+      assert_equal @controller.view_context.class, @controller.serialization_scope.class
+    end
+
+    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 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
+
+      attr_accessor :current_user
+
+      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