active_model_serializers 0.8.3 → 0.10.0.rc4

data/test/adapter/json_api/has_one_test.rb

@@ -0,0 +1,81 @@
+require 'test_helper'
+
+module ActiveModel
+  class Serializer
+    module Adapter
+      class JsonApi
+        class HasOneTest < ActiveSupport::TestCase
+          def setup
+            @author = Author.new(id: 1, name: 'Steve K.')
+            @bio = Bio.new(id: 43, content: 'AMS Contributor')
+            @author.bio = @bio
+            @bio.author = @author
+            @post = Post.new(id: 42, title: 'New Post', body: 'Body')
+            @anonymous_post = Post.new(id: 43, title: 'Hello!!', body: 'Hello, world!!')
+            @comment = Comment.new(id: 1, body: 'ZOMG A COMMENT')
+            @post.comments = [@comment]
+            @anonymous_post.comments = []
+            @comment.post = @post
+            @comment.author = nil
+            @post.author = @author
+            @anonymous_post.author = nil
+            @blog = Blog.new(id: 1, name: 'My Blog!!')
+            @blog.writer = @author
+            @blog.articles = [@post, @anonymous_post]
+            @author.posts = []
+            @author.roles = []
+
+            @virtual_value = VirtualValue.new(id: 1)
+
+            @serializer = AuthorSerializer.new(@author)
+            @adapter = ActiveModel::Serializer::Adapter::JsonApi.new(@serializer, include: [:bio, :posts])
+          end
+
+          def test_includes_bio_id
+            expected = { data: { type: 'bios', id: '43' } }
+
+            assert_equal(expected, @adapter.serializable_hash[:data][:relationships][:bio])
+          end
+
+          def test_includes_linked_bio
+            @adapter = ActiveModel::Serializer::Adapter::JsonApi.new(@serializer, include: [:bio])
+
+            expected = [
+              {
+                id: '43',
+                type: 'bios',
+                attributes: {
+                  content: 'AMS Contributor',
+                  rating: nil
+                },
+                relationships: {
+                  author: { data: { type: 'authors', id: '1' } }
+                }
+              }
+            ]
+
+            assert_equal(expected, @adapter.serializable_hash[:included])
+          end
+
+          def test_has_one_with_virtual_value
+            serializer = VirtualValueSerializer.new(@virtual_value)
+            adapter = ActiveModel::Serializer::Adapter::JsonApi.new(serializer)
+
+            expected = {
+              data: {
+                id: '1',
+                type: 'virtual_values',
+                relationships: {
+                  maker: { data: { id: 1 } },
+                  reviews: { data: [{ id: 1 }, { id: 2 }] }
+                }
+              }
+            }
+
+            assert_equal(expected, adapter.serializable_hash)
+          end
+        end
+      end
+    end
+  end
+end

data/test/adapter/json_api/json_api_test.rb

@@ -0,0 +1,37 @@
+require 'test_helper'
+
+module ActiveModel
+  class Serializer
+    module Adapter
+      class JsonApiTest < ActiveSupport::TestCase
+        def setup
+          ActionController::Base.cache_store.clear
+          @author = Author.new(id: 1, name: 'Steve K.')
+          @post = Post.new(id: 1, title: 'New Post', body: 'Body')
+          @first_comment = Comment.new(id: 1, body: 'ZOMG A COMMENT')
+          @second_comment = Comment.new(id: 2, body: 'ZOMG ANOTHER COMMENT')
+          @post.comments = [@first_comment, @second_comment]
+          @first_comment.post = @post
+          @second_comment.post = @post
+          @post.author = @author
+          @blog = Blog.new(id: 1, name: 'My Blog!!')
+          @post.blog = @blog
+        end
+
+        def test_custom_keys
+          serializer = PostWithCustomKeysSerializer.new(@post)
+          adapter = ActiveModel::Serializer::Adapter::JsonApi.new(serializer)
+
+          assert_equal({
+            reviews: { data: [
+                        { type: 'comments', id: '1' },
+                        { type: 'comments', id: '2' }
+                    ] },
+            writer: { data: { type: 'authors', id: '1' } },
+            site: { data: { type: 'blogs', id: '1' } }
+            }, adapter.serializable_hash[:data][:relationships])
+        end
+      end
+    end
+  end
+end

data/test/adapter/json_api/linked_test.rb

@@ -0,0 +1,394 @@
+require 'test_helper'
+
+NestedPost = Class.new(Model)
+class NestedPostSerializer < ActiveModel::Serializer
+  has_many :nested_posts
+end
+
+module ActiveModel
+  class Serializer
+    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 = CollectionSerializer.new([@first_post, @second_post])
+            adapter = ActiveModel::Serializer::Adapter::JsonApi.new(
+              serializer,
+              include: [:comments, author: [:bio]]
+            )
+            alt_adapter = ActiveModel::Serializer::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 = ActiveModel::Serializer::Adapter::JsonApi.new(
+              serializer,
+              include: [author: [:posts]]
+            )
+            alt_adapter = ActiveModel::Serializer::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 = ActiveModel::Serializer::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 = CollectionSerializer.new([@first_comment, @second_comment])
+            adapter = ActiveModel::Serializer::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 = ActiveModel::Serializer::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 = ActiveModel::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 = ActiveModel::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 = ActiveModel::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 = ActiveModel::SerializableResource.new(
+              [@nestedpost1, @nestedpost2],
+              adapter: :json_api,
+              include: '*').serializable_hash
+            assert_nil(hash[:included])
+          end
+        end
+      end
+    end
+  end
+end

data/test/adapter/json_api/links_test.rb

@@ -0,0 +1,68 @@
+require 'test_helper'
+
+module ActiveModel
+  class Serializer
+    module Adapter
+      class JsonApi
+        class LinksTest < ActiveSupport::TestCase
+          LinkAuthor = Class.new(::Model)
+          class LinkAuthorSerializer < ActiveModel::Serializer
+            link :self do
+              href "//example.com/link_author/#{object.id}"
+              meta stuff: 'value'
+            end
+
+            link :other, '//example.com/resource'
+
+            link :yet_another do
+              "//example.com/resource/#{object.id}"
+            end
+          end
+
+          def setup
+            @post = Post.new(id: 1337, comments: [], author: nil)
+            @author = LinkAuthor.new(id: 1337)
+          end
+
+          def test_toplevel_links
+            hash = ActiveModel::SerializableResource.new(
+              @post,
+              adapter: :json_api,
+              links: {
+                self: {
+                  href: '//example.com/posts',
+                  meta: {
+                    stuff: 'value'
+                  }
+                }
+              }).serializable_hash
+            expected = {
+              self: {
+                href: '//example.com/posts',
+                meta: {
+                  stuff: 'value'
+                }
+              }
+            }
+            assert_equal(expected, hash[:links])
+          end
+
+          def test_resource_links
+            hash = serializable(@author, adapter: :json_api).serializable_hash
+            expected = {
+              self: {
+                href: '//example.com/link_author/1337',
+                meta: {
+                  stuff: 'value'
+                }
+              },
+              other: '//example.com/resource',
+              yet_another: '//example.com/resource/1337'
+            }
+            assert_equal(expected, hash[:data][:links])
+          end
+        end
+      end
+    end
+  end
+end

data/test/adapter/json_api/pagination_links_test.rb

@@ -0,0 +1,115 @@
+require 'test_helper'
+require 'will_paginate/array'
+require 'kaminari'
+require 'kaminari/hooks'
+::Kaminari::Hooks.init
+
+module ActiveModel
+  class Serializer
+    module Adapter
+      class JsonApi
+        class PaginationLinksTest < ActiveSupport::TestCase
+          URI = 'http://example.com'
+
+          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' })
+            ]
+          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)
+            @options = {}
+            @options[:serialization_context] = context
+          end
+
+          def load_adapter(paginated_collection, options = {})
+            options = options.merge(adapter: :json_api)
+            ActiveModel::SerializableResource.new(paginated_collection, options)
+          end
+
+          def using_kaminari
+            Kaminari.paginate_array(@array).page(2).per(1)
+          end
+
+          def using_will_paginate
+            @array.paginate(page: 2, per_page: 1)
+          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' } }
+              ]
+            }
+          end
+
+          def links
+            {
+              links: {
+                self: "#{URI}?page%5Bnumber%5D=2&page%5Bsize%5D=1",
+                first: "#{URI}?page%5Bnumber%5D=1&page%5Bsize%5D=1",
+                prev: "#{URI}?page%5Bnumber%5D=1&page%5Bsize%5D=1",
+                next: "#{URI}?page%5Bnumber%5D=3&page%5Bsize%5D=1",
+                last: "#{URI}?page%5Bnumber%5D=3&page%5Bsize%5D=1"
+              }
+            }
+          end
+
+          def expected_response_without_pagination_links
+            data
+          end
+
+          def expected_response_with_pagination_links
+            {}.tap do |hash|
+              hash[:data] = [data.values.flatten.second]
+              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.second]
+              hash.merge! links: new_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(@options)
+          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(@options)
+          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(@options)
+          end
+
+          def test_not_showing_pagination_links
+            adapter = load_adapter(@array)
+
+            assert_equal expected_response_without_pagination_links, adapter.serializable_hash
+          end
+        end
+      end
+    end
+  end
+end