active_model_serializers 0.10.0 → 0.10.5

data/test/action_controller/json/include_test.rb

@@ -4,6 +4,10 @@ module ActionController
   module Serialization
     class Json
       class IncludeTest < ActionController::TestCase
+        INCLUDE_STRING = 'posts.comments'.freeze
+        INCLUDE_HASH = { posts: :comments }.freeze
+        DEEP_INCLUDE = 'posts.comments.author'.freeze
+
         class IncludeTestController < ActionController::Base
           def setup_data
             ActionController::Base.cache_store.clear
@@ -38,17 +42,28 @@ module ActionController
 
           def render_resource_with_include_hash
             setup_data
-            render json: @author, include: { posts: :comments }, adapter: :json
+            render json: @author, include: INCLUDE_HASH, adapter: :json
           end
 
           def render_resource_with_include_string
             setup_data
-            render json: @author, include: 'posts.comments', adapter: :json
+            render json: @author, include: INCLUDE_STRING, adapter: :json
           end
 
           def render_resource_with_deep_include
             setup_data
-            render json: @author, include: 'posts.comments.author', adapter: :json
+            render json: @author, include: DEEP_INCLUDE, adapter: :json
+          end
+
+          def render_without_recursive_relationships
+            # testing recursive includes ('**') can't have any cycles in the
+            # relationships, or we enter an infinite loop.
+            author = Author.new(id: 11, name: 'Jane Doe')
+            post = Post.new(id: 12, title: 'Hello World', body: 'My first post')
+            comment = Comment.new(id: 13, body: 'Commentary')
+            author.posts = [post]
+            post.comments = [comment]
+            render json: author
           end
         end
 
@@ -77,34 +92,90 @@ module ActionController
         def test_render_resource_with_include_hash
           get :render_resource_with_include_hash
           response = JSON.parse(@response.body)
-          expected = {
-            'author' => {
-              'id' => 1,
-              'name' => 'Steve K.',
+
+          assert_equal(expected_include_response, response)
+        end
+
+        def test_render_resource_with_include_string
+          get :render_resource_with_include_string
+
+          response = JSON.parse(@response.body)
+
+          assert_equal(expected_include_response, response)
+        end
+
+        def test_render_resource_with_deep_include
+          get :render_resource_with_deep_include
+
+          response = JSON.parse(@response.body)
+
+          assert_equal(expected_deep_include_response, response)
+        end
+
+        def test_render_with_empty_default_includes
+          with_default_includes '' do
+            get :render_without_include
+            response = JSON.parse(@response.body)
+            expected = {
+              'author' => {
+                'id' => 1,
+                'name' => 'Steve K.'
+              }
+            }
+            assert_equal(expected, response)
+          end
+        end
+
+        def test_render_with_recursive_default_includes
+          with_default_includes '**' do
+            get :render_without_recursive_relationships
+            response = JSON.parse(@response.body)
+
+            expected = {
+              'id' => 11,
+              'name' => 'Jane Doe',
+              'roles' => nil,
+              'bio' => nil,
               'posts' => [
                 {
-                  'id' => 42, 'title' => 'New Post', 'body' => 'Body',
+                  'id' => 12,
+                  'title' => 'Hello World',
+                  'body' => 'My first post',
                   'comments' => [
                     {
-                      'id' => 1, 'body' => 'ZOMG A COMMENT'
-                    },
-                    {
-                      'id' => 2, 'body' => 'ZOMG ANOTHER COMMENT'
+                      'id' => 13,
+                      'body' => 'Commentary',
+                      'post' => nil, # not set to avoid infinite recursion
+                      'author' => nil, # not set to avoid infinite recursion
                     }
-                  ]
+                  ],
+                  'blog' => {
+                    'id' => 999,
+                    'name' => 'Custom blog',
+                    'writer' => nil,
+                    'articles' => nil
+                  },
+                  'author' => nil # not set to avoid infinite recursion
                 }
               ]
             }
-          }
+            assert_equal(expected, response)
+          end
+        end
 
-          assert_equal(expected, response)
+        def test_render_with_includes_overrides_default_includes
+          with_default_includes '' do
+            get :render_resource_with_include_hash
+            response = JSON.parse(@response.body)
+
+            assert_equal(expected_include_response, response)
+          end
         end
 
-        def test_render_resource_with_include_string
-          get :render_resource_with_include_string
+        private
 
-          response = JSON.parse(@response.body)
-          expected = {
+        def expected_include_response
+          {
             'author' => {
               'id' => 1,
               'name' => 'Steve K.',
@@ -123,15 +194,10 @@ module ActionController
               ]
             }
           }
-
-          assert_equal(expected, response)
         end
 
-        def test_render_resource_with_deep_include
-          get :render_resource_with_deep_include
-
-          response = JSON.parse(@response.body)
-          expected = {
+        def expected_deep_include_response
+          {
             'author' => {
               'id' => 1,
               'name' => 'Steve K.',
@@ -158,8 +224,21 @@ module ActionController
               ]
             }
           }
+        end
 
-          assert_equal(expected, response)
+        def with_default_includes(include_directive)
+          original = ActiveModelSerializers.config.default_includes
+          ActiveModelSerializers.config.default_includes = include_directive
+          clear_include_directive_cache
+          yield
+        ensure
+          ActiveModelSerializers.config.default_includes = original
+          clear_include_directive_cache
+        end
+
+        def clear_include_directive_cache
+          ActiveModelSerializers
+            .instance_variable_set(:@default_include_directive, nil)
         end
       end
     end

data/test/action_controller/json_api/errors_test.rb

@@ -7,18 +7,17 @@ module ActionController
         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' }
-              ]
+          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
+          assert_equal json_response_body.to_json, expected_errors_object
         end
 
-        def json_reponse_body
+        def json_response_body
           JSON.load(@response.body)
         end
 

data/test/action_controller/json_api/fields_test.rb

@@ -0,0 +1,66 @@
+require 'test_helper'
+
+module ActionController
+  module Serialization
+    class JsonApi
+      class FieldsTest < ActionController::TestCase
+        class FieldsTestController < ActionController::Base
+          class AuthorWithName < Author
+            attributes :first_name, :last_name
+          end
+          class AuthorWithNameSerializer < AuthorSerializer
+            type 'authors'
+          end
+          class PostWithPublishAt < Post
+            attributes :publish_at
+          end
+          class PostWithPublishAtSerializer < ActiveModel::Serializer
+            type 'posts'
+            attributes :title, :body, :publish_at
+            belongs_to :author
+            has_many :comments
+          end
+
+          def setup_post
+            ActionController::Base.cache_store.clear
+            @author = AuthorWithName.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 = PostWithPublishAt.new(id: 1337, title: 'Title 1', body: 'Body 1',
+                                          author: @author, comments: [@comment1, @comment2],
+                                          publish_at: '2020-03-16T03:55:25.291Z')
+            @comment1.post = @post
+            @comment2.post = @post
+          end
+
+          def render_fields_works_on_relationships
+            setup_post
+            render json: @post, serializer: PostWithPublishAtSerializer, adapter: :json_api, fields: { posts: [:author] }
+          end
+        end
+
+        tests FieldsTestController
+
+        test 'fields works on relationships' do
+          get :render_fields_works_on_relationships
+          response = JSON.parse(@response.body)
+          expected = {
+            'data' => {
+              'id' => '1337',
+              'type' => 'posts',
+              'relationships' => {
+                'author' => {
+                  'data' => {
+                    'id' => '1',
+                    'type' => 'authors'
+                  }
+                }
+              }
+            }
+          }
+          assert_equal expected, response
+        end
+      end
+    end
+  end
+end

data/test/action_controller/json_api/linked_test.rb

@@ -3,9 +3,8 @@ require 'test_helper'
 module ActionController
   module Serialization
     class JsonApi
-      class LinkedTest < ActionController::TestCase
+      class LinkedTest < ActionDispatch::IntegrationTest
         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')
@@ -39,62 +38,68 @@ module ActionController
 
           def render_resource_without_include
             setup_post
-            render jsonapi: @post
+            render json: @post
           end
 
           def render_resource_with_include
             setup_post
-            render jsonapi: @post, include: [:author]
+            render json: @post, adapter: :json_api, include: [:author]
           end
 
           def render_resource_with_include_of_custom_key_by_original
             setup_post
-            render jsonapi: @post, include: [:reviews], serializer: PostWithCustomKeysSerializer
+            render json: @post, adapter: :json_api, include: [:reviews], serializer: PostWithCustomKeysSerializer
           end
 
           def render_resource_with_nested_include
             setup_post
-            render jsonapi: @post, include: [comments: [:author]]
+            render json: @post, adapter: :json_api, include: [comments: [:author]]
           end
 
           def render_resource_with_nested_has_many_include_wildcard
             setup_post
-            render jsonapi: @post, include: 'author.*'
+            render json: @post, adapter: :json_api, include: 'author.*'
           end
 
           def render_resource_with_missing_nested_has_many_include
             setup_post
             @post.author = @author2 # author2 has no roles.
-            render jsonapi: @post, include: [author: [:roles]]
+            render json: @post, adapter: :json_api, include: [author: [:roles]]
           end
 
           def render_collection_with_missing_nested_has_many_include
             setup_post
             @post.author = @author2
-            render jsonapi: [@post, @post2], include: [author: [:roles]]
+            render json: [@post, @post2], adapter: :json_api, include: [author: [:roles]]
           end
 
           def render_collection_without_include
             setup_post
-            render jsonapi: [@post]
+            render json: [@post], adapter: :json_api
           end
 
           def render_collection_with_include
             setup_post
-            render jsonapi: [@post], include: 'author, comments'
+            render json: [@post], adapter: :json_api, include: 'author, comments'
           end
         end
 
-        tests LinkedTestController
+        setup do
+          @routes = Rails.application.routes.draw do
+            ActiveSupport::Deprecation.silence do
+              match ':action', to: LinkedTestController, via: [:get, :post]
+            end
+          end
+        end
 
         def test_render_resource_without_include
-          get :render_resource_without_include
+          get '/render_resource_without_include'
           response = JSON.parse(@response.body)
           refute response.key? 'included'
         end
 
         def test_render_resource_with_include
-          get :render_resource_with_include
+          get '/render_resource_with_include'
           response = JSON.parse(@response.body)
           assert response.key? 'included'
           assert_equal 1, response['included'].size
@@ -102,7 +107,7 @@ module ActionController
         end
 
         def test_render_resource_with_nested_has_many_include
-          get :render_resource_with_nested_has_many_include_wildcard
+          get '/render_resource_with_nested_has_many_include_wildcard'
           response = JSON.parse(@response.body)
           expected_linked = [
             {
@@ -144,7 +149,7 @@ module ActionController
         end
 
         def test_render_resource_with_include_of_custom_key_by_original
-          get :render_resource_with_include_of_custom_key_by_original
+          get '/render_resource_with_include_of_custom_key_by_original'
           response = JSON.parse(@response.body)
           assert response.key? 'included'
 
@@ -156,39 +161,39 @@ module ActionController
         end
 
         def test_render_resource_with_nested_include
-          get :render_resource_with_nested_include
+          get '/render_resource_with_nested_include'
           response = JSON.parse(@response.body)
           assert response.key? 'included'
           assert_equal 3, response['included'].size
         end
 
         def test_render_collection_without_include
-          get :render_collection_without_include
+          get '/render_collection_without_include'
           response = JSON.parse(@response.body)
           refute response.key? 'included'
         end
 
         def test_render_collection_with_include
-          get :render_collection_with_include
+          get '/render_collection_with_include'
           response = JSON.parse(@response.body)
           assert response.key? 'included'
         end
 
         def test_render_resource_with_nested_attributes_even_when_missing_associations
-          get :render_resource_with_missing_nested_has_many_include
+          get '/render_resource_with_missing_nested_has_many_include'
           response = JSON.parse(@response.body)
           assert response.key? 'included'
-          refute has_type?(response['included'], 'roles')
+          refute include_type?(response['included'], 'roles')
         end
 
         def test_render_collection_with_missing_nested_has_many_include
-          get :render_collection_with_missing_nested_has_many_include
+          get '/render_collection_with_missing_nested_has_many_include'
           response = JSON.parse(@response.body)
           assert response.key? 'included'
-          assert has_type?(response['included'], 'roles')
+          assert include_type?(response['included'], 'roles')
         end
 
-        def has_type?(collection, value)
+        def include_type?(collection, value)
           collection.detect { |i| i['type'] == value }
         end
       end

data/test/action_controller/json_api/pagination_test.rb

@@ -14,9 +14,9 @@ module ActionController
         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' })
+              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
 
@@ -48,10 +48,10 @@ module ActionController
 
         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" }
+                             '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)
@@ -60,8 +60,8 @@ module ActionController
 
         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" }
+                             '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']
@@ -69,10 +69,10 @@ module ActionController
 
         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" }
+                             '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']
@@ -80,8 +80,8 @@ module ActionController
 
         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" }
+                             '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']
@@ -89,8 +89,8 @@ module ActionController
 
         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" }
+                             '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']
@@ -98,8 +98,8 @@ module ActionController
 
         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" }
+                             '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']

data/test/action_controller/json_api/transform_test.rb

@@ -5,7 +5,17 @@ module ActionController
     class JsonApi
       class KeyTransformTest < ActionController::TestCase
         class KeyTransformTestController < ActionController::Base
-          Post = Class.new(::Model)
+          class Post < ::Model
+            attributes :title, :body, :publish_at
+            associations :author, :top_comments
+          end
+          class Author < ::Model
+            attributes :first_name, :last_name
+          end
+          class TopComment < ::Model
+            attributes :body
+            associations :author, :post
+          end
           class PostSerializer < ActiveModel::Serializer
             type 'posts'
             attributes :title, :body, :publish_at
@@ -22,13 +32,11 @@ module ActionController
             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

data/test/action_controller/lookup_proc_test.rb

@@ -0,0 +1,49 @@
+require 'test_helper'
+
+module ActionController
+  module Serialization
+    class LookupProcTest < ActionController::TestCase
+      module Api
+        module V3
+          class PostCustomSerializer < ActiveModel::Serializer
+            attributes :title, :body
+
+            belongs_to :author
+          end
+
+          class AuthorCustomSerializer < ActiveModel::Serializer
+            attributes :name
+          end
+
+          class LookupProcTestController < ActionController::Base
+            def implicit_namespaced_serializer
+              author = Author.new(name: 'Bob')
+              post = Post.new(title: 'New Post', body: 'Body', author: author)
+
+              render json: post
+            end
+          end
+        end
+      end
+
+      tests Api::V3::LookupProcTestController
+
+      test 'implicitly uses namespaced serializer' do
+        controller_namespace = lambda do |resource_class, _parent_serializer_class, namespace|
+          "#{namespace}::#{resource_class}CustomSerializer" if namespace
+        end
+
+        with_prepended_lookup(controller_namespace) do
+          get :implicit_namespaced_serializer
+
+          assert_serializer Api::V3::PostCustomSerializer
+
+          expected = { 'title' => 'New Post', 'body' => 'Body', 'author' => { 'name' => 'Bob' } }
+          actual = JSON.parse(@response.body)
+
+          assert_equal expected, actual
+        end
+      end
+    end
+  end
+end