active_model_serializers 0.8.3 → 0.10.0

data/test/adapter/json_api/linked_test.rb

@@ -0,0 +1,392 @@
+require 'test_helper'
+
+NestedPost = Class.new(Model)
+class NestedPostSerializer < ActiveModel::Serializer
+  has_many :nested_posts
+end
+
+module ActiveModelSerializers
+  module Adapter
+    class JsonApi
+      class LinkedTest < ActiveSupport::TestCase
+        def setup
+          @author1 = Author.new(id: 1, name: 'Steve K.')
+          @author2 = Author.new(id: 2, name: 'Tenderlove')
+          @bio1 = Bio.new(id: 1, content: 'AMS Contributor')
+          @bio2 = Bio.new(id: 2, content: 'Rails Contributor')
+          @first_post = Post.new(id: 10, title: 'Hello!!', body: 'Hello, world!!')
+          @second_post = Post.new(id: 20, title: 'New Post', body: 'Body')
+          @third_post = Post.new(id: 30, title: 'Yet Another Post', body: 'Body')
+          @blog = Blog.new({ name: 'AMS Blog' })
+          @first_comment = Comment.new(id: 1, body: 'ZOMG A COMMENT')
+          @second_comment = Comment.new(id: 2, body: 'ZOMG ANOTHER COMMENT')
+          @first_post.blog = @blog
+          @second_post.blog = @blog
+          @third_post.blog = nil
+          @first_post.comments = [@first_comment, @second_comment]
+          @second_post.comments = []
+          @third_post.comments = []
+          @first_post.author = @author1
+          @second_post.author = @author2
+          @third_post.author = @author1
+          @first_comment.post = @first_post
+          @first_comment.author = nil
+          @second_comment.post = @first_post
+          @second_comment.author = nil
+          @author1.posts = [@first_post, @third_post]
+          @author1.bio = @bio1
+          @author1.roles = []
+          @author2.posts = [@second_post]
+          @author2.bio = @bio2
+          @author2.roles = []
+          @bio1.author = @author1
+          @bio2.author = @author2
+        end
+
+        def test_include_multiple_posts_and_linked_array
+          serializer = ActiveModel::Serializer::CollectionSerializer.new([@first_post, @second_post])
+          adapter = ActiveModelSerializers::Adapter::JsonApi.new(
+            serializer,
+            include: [:comments, author: [:bio]]
+          )
+          alt_adapter = ActiveModelSerializers::Adapter::JsonApi.new(
+            serializer,
+            include: [:comments, author: [:bio]]
+          )
+
+          expected = {
+            data: [
+              {
+                id: '10',
+                type: 'posts',
+                attributes: {
+                  title: 'Hello!!',
+                  body: 'Hello, world!!'
+                },
+                relationships: {
+                  comments: { data: [{ type: 'comments', id: '1' }, { type: 'comments', id: '2' }] },
+                  blog: { data: { type: 'blogs', id: '999' } },
+                  author: { data: { type: 'authors', id: '1' } }
+                }
+              },
+              {
+                id: '20',
+                type: 'posts',
+                attributes: {
+                  title: 'New Post',
+                  body: 'Body'
+                },
+                relationships: {
+                  comments: { data: [] },
+                  blog: { data: { type: 'blogs', id: '999' } },
+                  author: { data: { type: 'authors', id: '2' } }
+                }
+              }
+            ],
+            included: [
+              {
+                id: '1',
+                type: 'comments',
+                attributes: {
+                  body: 'ZOMG A COMMENT'
+                },
+                relationships: {
+                  post: { data: { type: 'posts', id: '10' } },
+                  author: { data: nil }
+                }
+              }, {
+                id: '2',
+                type: 'comments',
+                attributes: {
+                  body: 'ZOMG ANOTHER COMMENT'
+                },
+                relationships: {
+                  post: { data: { type: 'posts', id: '10' } },
+                  author: { data: nil }
+                }
+              }, {
+                id: '1',
+                type: 'authors',
+                attributes: {
+                  name: 'Steve K.'
+                },
+                relationships: {
+                  posts: { data: [{ type: 'posts', id: '10' }, { type: 'posts', id: '30' }] },
+                  roles: { data: [] },
+                  bio: { data: { type: 'bios', id: '1' } }
+                }
+              }, {
+                id: '1',
+                type: 'bios',
+                attributes: {
+                  content: 'AMS Contributor',
+                  rating: nil
+                },
+                relationships: {
+                  author: { data: { type: 'authors', id: '1' } }
+                }
+              }, {
+                id: '2',
+                type: 'authors',
+                attributes: {
+                  name: 'Tenderlove'
+                },
+                relationships: {
+                  posts: { data: [{ type: 'posts', id: '20' }] },
+                  roles: { data: [] },
+                  bio: { data: { type: 'bios', id: '2' } }
+                }
+              }, {
+                id: '2',
+                type: 'bios',
+                attributes: {
+                  rating: nil,
+                  content: 'Rails Contributor'
+                },
+                relationships: {
+                  author: { data: { type: 'authors', id: '2' } }
+                }
+              }
+            ]
+          }
+          assert_equal expected, adapter.serializable_hash
+          assert_equal expected, alt_adapter.serializable_hash
+        end
+
+        def test_include_multiple_posts_and_linked
+          serializer = BioSerializer.new @bio1
+          adapter = ActiveModelSerializers::Adapter::JsonApi.new(
+            serializer,
+            include: [author: [:posts]]
+          )
+          alt_adapter = ActiveModelSerializers::Adapter::JsonApi.new(
+            serializer,
+            include: [author: [:posts]]
+          )
+
+          expected = [
+            {
+              id: '1',
+              type: 'authors',
+              attributes: {
+                name: 'Steve K.'
+              },
+              relationships: {
+                posts: { data: [{ type: 'posts', id: '10' }, { type: 'posts', id: '30' }] },
+                roles: { data: [] },
+                bio: { data: { type: 'bios', id: '1' } }
+              }
+            }, {
+              id: '10',
+              type: 'posts',
+              attributes: {
+                title: 'Hello!!',
+                body: 'Hello, world!!'
+              },
+              relationships: {
+                comments: { data: [{ type: 'comments', id: '1' }, { type: 'comments', id: '2' }] },
+                blog: { data: { type: 'blogs', id: '999' } },
+                author: { data: { type: 'authors', id: '1' } }
+              }
+            }, {
+              id: '30',
+              type: 'posts',
+              attributes: {
+                title: 'Yet Another Post',
+                body: 'Body'
+              },
+              relationships: {
+                comments: { data: [] },
+                blog: { data: { type: 'blogs', id: '999' } },
+                author: { data: { type: 'authors', id: '1' } }
+              }
+            }
+          ]
+
+          assert_equal expected, adapter.serializable_hash[:included]
+          assert_equal expected, alt_adapter.serializable_hash[:included]
+        end
+
+        def test_underscore_model_namespace_for_linked_resource_type
+          spammy_post = Post.new(id: 123)
+          spammy_post.related = [Spam::UnrelatedLink.new(id: 456)]
+          serializer = SpammyPostSerializer.new(spammy_post)
+          adapter = ActiveModelSerializers::Adapter::JsonApi.new(serializer)
+          relationships = adapter.serializable_hash[:data][:relationships]
+          expected = {
+            related: {
+              data: [{
+                type: 'spam-unrelated-links',
+                id: '456'
+              }]
+            }
+          }
+          assert_equal expected, relationships
+        end
+
+        def test_multiple_references_to_same_resource
+          serializer = ActiveModel::Serializer::CollectionSerializer.new([@first_comment, @second_comment])
+          adapter = ActiveModelSerializers::Adapter::JsonApi.new(
+            serializer,
+            include: [:post]
+          )
+
+          expected = [
+            {
+              id: '10',
+              type: 'posts',
+              attributes: {
+                title: 'Hello!!',
+                body: 'Hello, world!!'
+              },
+              relationships: {
+                comments: {
+                  data: [{ type: 'comments', id: '1' }, { type: 'comments', id: '2' }]
+                },
+                blog: {
+                  data: { type: 'blogs', id: '999' }
+                },
+                author: {
+                  data: { type: 'authors', id: '1' }
+                }
+              }
+            }
+          ]
+
+          assert_equal expected, adapter.serializable_hash[:included]
+        end
+
+        def test_nil_link_with_specified_serializer
+          @first_post.author = nil
+          serializer = PostPreviewSerializer.new(@first_post)
+          adapter = ActiveModelSerializers::Adapter::JsonApi.new(
+            serializer,
+            include: [:author]
+          )
+
+          expected = {
+            data: {
+              id: '10',
+              type: 'posts',
+              attributes: {
+                title: 'Hello!!',
+                body: 'Hello, world!!'
+              },
+              relationships: {
+                comments: { data: [{ type: 'comments', id: '1' }, { type: 'comments', id: '2' }] },
+                author: { data: nil }
+              }
+            }
+          }
+          assert_equal expected, adapter.serializable_hash
+        end
+      end
+
+      class NoDuplicatesTest < ActiveSupport::TestCase
+        Post = Class.new(::Model)
+        Author = Class.new(::Model)
+
+        class PostSerializer < ActiveModel::Serializer
+          type 'posts'
+          belongs_to :author
+        end
+
+        class AuthorSerializer < ActiveModel::Serializer
+          type 'authors'
+          has_many :posts
+        end
+
+        def setup
+          @author = Author.new(id: 1, posts: [], roles: [], bio: nil)
+          @post1 = Post.new(id: 1, author: @author)
+          @post2 = Post.new(id: 2, author: @author)
+          @author.posts << @post1
+          @author.posts << @post2
+
+          @nestedpost1 = ::NestedPost.new(id: 1, nested_posts: [])
+          @nestedpost2 = ::NestedPost.new(id: 2, nested_posts: [])
+          @nestedpost1.nested_posts << @nestedpost1
+          @nestedpost1.nested_posts << @nestedpost2
+          @nestedpost2.nested_posts << @nestedpost1
+          @nestedpost2.nested_posts << @nestedpost2
+        end
+
+        def test_no_duplicates
+          hash = ActiveModelSerializers::SerializableResource.new(@post1, adapter: :json_api,
+                                                                          include: '*.*')
+                                                             .serializable_hash
+          expected = [
+            {
+              type: 'authors', id: '1',
+              relationships: {
+                posts: {
+                  data: [
+                    { type: 'posts', id: '1' },
+                    { type: 'posts', id: '2' }
+                  ]
+                }
+              }
+            },
+            {
+              type: 'posts', id: '2',
+              relationships: {
+                author: {
+                  data: { type: 'authors', id: '1' }
+                }
+              }
+            }
+          ]
+          assert_equal(expected, hash[:included])
+        end
+
+        def test_no_duplicates_collection
+          hash = ActiveModelSerializers::SerializableResource.new(
+            [@post1, @post2], adapter: :json_api,
+                              include: '*.*')
+                                                             .serializable_hash
+          expected = [
+            {
+              type: 'authors', id: '1',
+              relationships: {
+                posts: {
+                  data: [
+                    { type: 'posts', id: '1' },
+                    { type: 'posts', id: '2' }
+                  ]
+                }
+              }
+            }
+          ]
+          assert_equal(expected, hash[:included])
+        end
+
+        def test_no_duplicates_global
+          hash = ActiveModelSerializers::SerializableResource.new(
+            @nestedpost1,
+            adapter: :json_api,
+            include: '*').serializable_hash
+          expected = [
+            type: 'nested-posts', id: '2',
+            relationships: {
+              :"nested-posts" => {
+                data: [
+                  { type: 'nested-posts', id: '1' },
+                  { type: 'nested-posts', id: '2' }
+                ]
+              }
+            }
+          ]
+          assert_equal(expected, hash[:included])
+        end
+
+        def test_no_duplicates_collection_global
+          hash = ActiveModelSerializers::SerializableResource.new(
+            [@nestedpost1, @nestedpost2],
+            adapter: :json_api,
+            include: '*').serializable_hash
+          assert_nil(hash[:included])
+        end
+      end
+    end
+  end
+end

data/test/adapter/json_api/links_test.rb

@@ -0,0 +1,93 @@
+require 'test_helper'
+
+module ActiveModelSerializers
+  module Adapter
+    class JsonApi
+      class LinksTest < ActiveSupport::TestCase
+        LinkAuthor = Class.new(::Model)
+        class LinkAuthorSerializer < ActiveModel::Serializer
+          link :self do
+            href "http://example.com/link_author/#{object.id}"
+            meta stuff: 'value'
+          end
+          link(:author) { link_author_url(object.id) }
+          link(:link_authors) { url_for(controller: 'link_authors', action: 'index', only_path: false) }
+          link(:posts) { link_author_posts_url(object.id) }
+          link :resource, 'http://example.com/resource'
+          link :yet_another do
+            "http://example.com/resource/#{object.id}"
+          end
+        end
+
+        def setup
+          Rails.application.routes.draw do
+            resources :link_authors do
+              resources :posts
+            end
+          end
+          @post = Post.new(id: 1337, comments: [], author: nil)
+          @author = LinkAuthor.new(id: 1337, posts: [@post])
+        end
+
+        def test_toplevel_links
+          hash = ActiveModelSerializers::SerializableResource.new(
+            @post,
+            adapter: :json_api,
+            links: {
+              self: {
+                href: 'http://example.com/posts',
+                meta: {
+                  stuff: 'value'
+                }
+              }
+            }).serializable_hash
+          expected = {
+            self: {
+              href: 'http://example.com/posts',
+              meta: {
+                stuff: 'value'
+              }
+            }
+          }
+          assert_equal(expected, hash[:links])
+        end
+
+        def test_nil_toplevel_links
+          hash = ActiveModelSerializers::SerializableResource.new(
+            @post,
+            adapter: :json_api,
+            links: nil
+          ).serializable_hash
+          refute hash.key?(:links), 'No links key to be output'
+        end
+
+        def test_nil_toplevel_links_json_adapter
+          hash = ActiveModelSerializers::SerializableResource.new(
+            @post,
+            adapter: :json,
+            links: nil
+          ).serializable_hash
+          refute hash.key?(:links), 'No links key to be output'
+        end
+
+        def test_resource_links
+          hash = serializable(@author, adapter: :json_api).serializable_hash
+          expected = {
+            self: {
+              href: 'http://example.com/link_author/1337',
+              meta: {
+                stuff: 'value'
+              }
+            },
+            author: 'http://example.com/link_authors/1337',
+            :"link-authors" => 'http://example.com/link_authors',
+            resource: 'http://example.com/resource',
+            posts: 'http://example.com/link_authors/1337/posts',
+            :"yet-another" => 'http://example.com/resource/1337'
+          }
+          assert_equal(expected, hash[:data][:links])
+        end
+      end
+    end
+  end
+end

data/test/adapter/json_api/pagination_links_test.rb

@@ -0,0 +1,166 @@
+require 'test_helper'
+require 'will_paginate/array'
+require 'kaminari'
+require 'kaminari/hooks'
+::Kaminari::Hooks.init
+
+module ActiveModelSerializers
+  module Adapter
+    class JsonApi
+      class PaginationLinksTest < ActiveSupport::TestCase
+        URI = 'http://example.com'.freeze
+
+        def setup
+          ActionController::Base.cache_store.clear
+          @array = [
+            Profile.new({ id: 1, name: 'Name 1', description: 'Description 1', comments: 'Comments 1' }),
+            Profile.new({ id: 2, name: 'Name 2', description: 'Description 2', comments: 'Comments 2' }),
+            Profile.new({ id: 3, name: 'Name 3', description: 'Description 3', comments: 'Comments 3' }),
+            Profile.new({ id: 4, name: 'Name 4', description: 'Description 4', comments: 'Comments 4' }),
+            Profile.new({ id: 5, name: 'Name 5', description: 'Description 5', comments: 'Comments 5' })
+          ]
+        end
+
+        def mock_request(query_parameters = {}, original_url = URI)
+          context = Minitest::Mock.new
+          context.expect(:request_url, original_url)
+          context.expect(:query_parameters, query_parameters)
+          context.expect(:key_transform, nil)
+        end
+
+        def load_adapter(paginated_collection, mock_request = nil)
+          render_options = { adapter: :json_api }
+          render_options[:serialization_context] = mock_request if mock_request
+          serializable(paginated_collection, render_options)
+        end
+
+        def using_kaminari(page = 2)
+          Kaminari.paginate_array(@array).page(page).per(2)
+        end
+
+        def using_will_paginate(page = 2)
+          @array.paginate(page: page, per_page: 2)
+        end
+
+        def data
+          { data: [
+              { id: '1', type: 'profiles', attributes: { name: 'Name 1', description: 'Description 1' } },
+              { id: '2', type: 'profiles', attributes: { name: 'Name 2', description: 'Description 2' } },
+              { id: '3', type: 'profiles', attributes: { name: 'Name 3', description: 'Description 3' } },
+              { id: '4', type: 'profiles', attributes: { name: 'Name 4', description: 'Description 4' } },
+              { id: '5', type: 'profiles', attributes: { name: 'Name 5', description: 'Description 5' } }
+            ]
+          }
+        end
+
+        def links
+          {
+            links: {
+              self: "#{URI}?page%5Bnumber%5D=2&page%5Bsize%5D=2",
+              first: "#{URI}?page%5Bnumber%5D=1&page%5Bsize%5D=2",
+              prev: "#{URI}?page%5Bnumber%5D=1&page%5Bsize%5D=2",
+              next: "#{URI}?page%5Bnumber%5D=3&page%5Bsize%5D=2",
+              last: "#{URI}?page%5Bnumber%5D=3&page%5Bsize%5D=2"
+            }
+          }
+        end
+
+        def last_page_links
+          {
+            links: {
+              self: "#{URI}?page%5Bnumber%5D=3&page%5Bsize%5D=2",
+              first: "#{URI}?page%5Bnumber%5D=1&page%5Bsize%5D=2",
+              prev: "#{URI}?page%5Bnumber%5D=2&page%5Bsize%5D=2"
+            }
+          }
+        end
+
+        def expected_response_without_pagination_links
+          data
+        end
+
+        def expected_response_with_pagination_links
+          {}.tap do |hash|
+            hash[:data] = data.values.flatten[2..3]
+            hash.merge! links
+          end
+        end
+
+        def expected_response_with_pagination_links_and_additional_params
+          new_links = links[:links].each_with_object({}) { |(key, value), hash| hash[key] = "#{value}&test=test" }
+          {}.tap do |hash|
+            hash[:data] = data.values.flatten[2..3]
+            hash.merge! links: new_links
+          end
+        end
+
+        def expected_response_with_last_page_pagination_links
+          {}.tap do |hash|
+            hash[:data] = [data.values.flatten.last]
+            hash.merge! last_page_links
+          end
+        end
+
+        def expected_response_with_no_data_pagination_links
+          {}.tap do |hash|
+            hash[:data] = []
+            hash[:links] = {}
+          end
+        end
+
+        def test_pagination_links_using_kaminari
+          adapter = load_adapter(using_kaminari, mock_request)
+
+          assert_equal expected_response_with_pagination_links, adapter.serializable_hash
+        end
+
+        def test_pagination_links_using_will_paginate
+          adapter = load_adapter(using_will_paginate, mock_request)
+
+          assert_equal expected_response_with_pagination_links, adapter.serializable_hash
+        end
+
+        def test_pagination_links_with_additional_params
+          adapter = load_adapter(using_will_paginate, mock_request({ test: 'test' }))
+
+          assert_equal expected_response_with_pagination_links_and_additional_params,
+            adapter.serializable_hash
+        end
+
+        def test_pagination_links_when_zero_results_kaminari
+          @array = []
+
+          adapter = load_adapter(using_kaminari(1), mock_request)
+
+          assert_equal expected_response_with_no_data_pagination_links, adapter.serializable_hash
+        end
+
+        def test_pagination_links_when_zero_results_will_paginate
+          @array = []
+
+          adapter = load_adapter(using_will_paginate(1), mock_request)
+
+          assert_equal expected_response_with_no_data_pagination_links, adapter.serializable_hash
+        end
+
+        def test_last_page_pagination_links_using_kaminari
+          adapter = load_adapter(using_kaminari(3), mock_request)
+
+          assert_equal expected_response_with_last_page_pagination_links, adapter.serializable_hash
+        end
+
+        def test_last_page_pagination_links_using_will_paginate
+          adapter = load_adapter(using_will_paginate(3), mock_request)
+
+          assert_equal expected_response_with_last_page_pagination_links, adapter.serializable_hash
+        end
+
+        def test_not_showing_pagination_links
+          adapter = load_adapter(@array, mock_request)
+
+          assert_equal expected_response_without_pagination_links, adapter.serializable_hash
+        end
+      end
+    end
+  end
+end