active_model_serializers 0.8.3 → 0.10.0.rc4

data/test/adapter/json_api/belongs_to_test.rb

@@ -0,0 +1,157 @@
+require 'test_helper'
+
+module ActiveModel
+  class Serializer
+    module Adapter
+      class JsonApi
+        class BelongsToTest < ActiveSupport::TestCase
+          def setup
+            @author = Author.new(id: 1, name: 'Steve K.')
+            @author.bio = nil
+            @author.roles = []
+            @blog = Blog.new(id: 23, name: 'AMS Blog')
+            @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]
+            @post.blog = @blog
+            @anonymous_post.comments = []
+            @anonymous_post.blog = nil
+            @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 = []
+
+            @serializer = CommentSerializer.new(@comment)
+            @adapter = ActiveModel::Serializer::Adapter::JsonApi.new(@serializer)
+            ActionController::Base.cache_store.clear
+          end
+
+          def test_includes_post_id
+            expected = { data: { type: 'posts', id: '42' } }
+
+            assert_equal(expected, @adapter.serializable_hash[:data][:relationships][:post])
+          end
+
+          def test_includes_linked_post
+            @adapter = ActiveModel::Serializer::Adapter::JsonApi.new(@serializer, include: [:post])
+            expected = [{
+              id: '42',
+              type: 'posts',
+              attributes: {
+                title: 'New Post',
+                body: 'Body',
+              },
+              relationships: {
+                comments: { data: [{ type: 'comments', id: '1' }] },
+                blog: { data: { type: 'blogs', id: '999' } },
+                author: { data: { type: 'authors', id: '1' } }
+              }
+            }]
+            assert_equal expected, @adapter.serializable_hash[:included]
+          end
+
+          def test_limiting_linked_post_fields
+            @adapter = ActiveModel::Serializer::Adapter::JsonApi.new(@serializer, include: [:post], fields: { post: [:title, :comments, :blog, :author] })
+            expected = [{
+              id: '42',
+              type: 'posts',
+              attributes: {
+                title: 'New Post'
+              },
+              relationships: {
+                comments: { data: [{ type: 'comments', id: '1' }] },
+                blog: { data: { type: 'blogs', id: '999' } },
+                author: { data: { type: 'authors', id: '1' } }
+              }
+            }]
+            assert_equal expected, @adapter.serializable_hash[:included]
+          end
+
+          def test_include_nil_author
+            serializer = PostSerializer.new(@anonymous_post)
+            adapter = ActiveModel::Serializer::Adapter::JsonApi.new(serializer)
+
+            assert_equal({ comments: { data: [] }, blog: { data: { type: 'blogs', id: '999' } }, author: { data: nil } }, adapter.serializable_hash[:data][:relationships])
+          end
+
+          def test_include_type_for_association_when_different_than_name
+            serializer = BlogSerializer.new(@blog)
+            adapter = ActiveModel::Serializer::Adapter::JsonApi.new(serializer)
+            relationships = adapter.serializable_hash[:data][:relationships]
+            expected = {
+              writer: {
+                data: {
+                  type: 'authors',
+                  id: '1'
+                }
+              },
+              articles: {
+                data: [
+                  {
+                    type: 'posts',
+                    id: '42'
+                  },
+                  {
+                    type: 'posts',
+                    id: '43'
+                  }
+                ]
+              }
+            }
+            assert_equal expected, relationships
+          end
+
+          def test_include_linked_resources_with_type_name
+            serializer = BlogSerializer.new(@blog)
+            adapter = ActiveModel::Serializer::Adapter::JsonApi.new(serializer, include: [:writer, :articles])
+            linked = adapter.serializable_hash[:included]
+            expected = [
+              {
+                id: '1',
+                type: 'authors',
+                attributes: {
+                  name: 'Steve K.'
+                },
+                relationships: {
+                  posts: { data: [] },
+                  roles: { data: [] },
+                  bio: { data: nil }
+                }
+              }, {
+                id: '42',
+                type: 'posts',
+                attributes: {
+                  title: 'New Post',
+                  body: 'Body'
+                },
+                relationships: {
+                  comments: { data: [{ type: 'comments', id: '1' }] },
+                  blog: { data: { type: 'blogs', id: '999' } },
+                  author: { data: { type: 'authors', id: '1' } }
+                }
+              }, {
+                id: '43',
+                type: 'posts',
+                attributes: {
+                  title: 'Hello!!',
+                  body: 'Hello, world!!'
+                },
+                relationships: {
+                  comments: { data: [] },
+                  blog: { data: { type: 'blogs', id: '999' } },
+                  author: { data: nil }
+                }
+              }
+            ]
+            assert_equal expected, linked
+          end
+        end
+      end
+    end
+  end
+end

data/test/adapter/json_api/collection_test.rb

@@ -0,0 +1,97 @@
+require 'test_helper'
+
+module ActiveModel
+  class Serializer
+    module Adapter
+      class JsonApi
+        class CollectionTest < ActiveSupport::TestCase
+          def setup
+            @author = Author.new(id: 1, name: 'Steve K.')
+            @author.bio = nil
+            @blog = Blog.new(id: 23, name: 'AMS Blog')
+            @first_post = Post.new(id: 1, title: 'Hello!!', body: 'Hello, world!!')
+            @second_post = Post.new(id: 2, title: 'New Post', body: 'Body')
+            @first_post.comments = []
+            @second_post.comments = []
+            @first_post.blog = @blog
+            @second_post.blog = nil
+            @first_post.author = @author
+            @second_post.author = @author
+            @author.posts = [@first_post, @second_post]
+
+            @serializer = CollectionSerializer.new([@first_post, @second_post])
+            @adapter = ActiveModel::Serializer::Adapter::JsonApi.new(@serializer)
+            ActionController::Base.cache_store.clear
+          end
+
+          def test_include_multiple_posts
+            expected = [
+              {
+                id: '1',
+                type: 'posts',
+                attributes: {
+                  title: 'Hello!!',
+                  body: 'Hello, world!!'
+                },
+                relationships: {
+                  comments: { data: [] },
+                  blog: { data: { type: 'blogs', id: '999' } },
+                  author: { data: { type: 'authors', id: '1' } }
+                }
+              },
+              {
+                id: '2',
+                type: 'posts',
+                attributes: {
+                  title: 'New Post',
+                  body: 'Body'
+                },
+                relationships: {
+                  comments: { data: [] },
+                  blog: { data: { type: 'blogs', id: '999' } },
+                  author: { data: { type: 'authors', id: '1' } }
+                }
+              }
+            ]
+
+            assert_equal(expected, @adapter.serializable_hash[:data])
+          end
+
+          def test_limiting_fields
+            actual = ActiveModel::SerializableResource.new(
+              [@first_post, @second_post], adapter: :json_api,
+                                           fields: { posts: %w(title comments blog author) })
+                     .serializable_hash
+            expected = [
+              {
+                id: '1',
+                type: 'posts',
+                attributes: {
+                  title: 'Hello!!'
+                },
+                relationships: {
+                  comments: { data: [] },
+                  blog: { data: { type: 'blogs', id: '999' } },
+                  author: { data: { type: 'authors', id: '1' } }
+                }
+              },
+              {
+                id: '2',
+                type: 'posts',
+                attributes: {
+                  title: 'New Post'
+                },
+                relationships: {
+                  comments: { data: [] },
+                  blog: { data: { type: 'blogs', id: '999' } },
+                  author: { data: { type: 'authors', id: '1' } }
+                }
+              }
+            ]
+            assert_equal(expected, actual[:data])
+          end
+        end
+      end
+    end
+  end
+end

data/test/adapter/json_api/fields_test.rb

@@ -0,0 +1,89 @@
+require 'test_helper'
+
+module ActiveModel
+  class Serializer
+    module Adapter
+      class JsonApi
+        class FieldsTest < ActiveSupport::TestCase
+          Post = Class.new(::Model)
+          class PostSerializer < ActiveModel::Serializer
+            type 'posts'
+            attributes :title, :body
+            belongs_to :author
+            has_many :comments
+          end
+
+          Author = Class.new(::Model)
+          class AuthorSerializer < ActiveModel::Serializer
+            type 'authors'
+            attributes :name, :birthday
+          end
+
+          Comment = Class.new(::Model)
+          class CommentSerializer < ActiveModel::Serializer
+            type 'comments'
+            attributes :body
+            belongs_to :author
+          end
+
+          def setup
+            @author = Author.new(id: 1, name: 'Lucas', birthday: '10.01.1990')
+            @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])
+            @comment1.post = @post
+            @comment2.post = @post
+          end
+
+          def test_fields_attributes
+            fields = { posts: [:title] }
+            hash = serializable(@post, adapter: :json_api, fields: fields).serializable_hash
+            expected = {
+              title: 'Title 1'
+            }
+
+            assert_equal(expected, hash[:data][:attributes])
+          end
+
+          def test_fields_relationships
+            fields = { posts: [:author] }
+            hash = serializable(@post, adapter: :json_api, fields: fields).serializable_hash
+            expected = {
+              author: {
+                data: {
+                  type: 'authors',
+                  id: '1'
+                }
+              }
+            }
+
+            assert_equal(expected, hash[:data][:relationships])
+          end
+
+          def test_fields_included
+            fields = { posts: [:author], comments: [:body] }
+            hash = serializable(@post, adapter: :json_api, fields: fields, include: 'comments').serializable_hash
+            expected = [
+              {
+                type: 'comments',
+                id: '7',
+                attributes: {
+                  body: 'cool'
+                }
+              }, {
+                type: 'comments',
+                id: '12',
+                attributes: {
+                  body: 'awesome'
+                }
+              }
+            ]
+
+            assert_equal(expected, hash[:included])
+          end
+        end
+      end
+    end
+  end
+end

data/test/adapter/json_api/has_many_embed_ids_test.rb

@@ -0,0 +1,45 @@
+require 'test_helper'
+
+module ActiveModel
+  class Serializer
+    module Adapter
+      class JsonApi
+        class HasManyEmbedIdsTest < ActiveSupport::TestCase
+          def setup
+            @author = Author.new(name: 'Steve K.')
+            @author.bio = nil
+            @author.roles = nil
+            @first_post = Post.new(id: 1, title: 'Hello!!', body: 'Hello, world!!')
+            @second_post = Post.new(id: 2, title: 'New Post', body: 'Body')
+            @author.posts = [@first_post, @second_post]
+            @first_post.author = @author
+            @second_post.author = @author
+            @first_post.comments = []
+            @second_post.comments = []
+            @blog = Blog.new(id: 23, name: 'AMS Blog')
+            @first_post.blog = @blog
+            @second_post.blog = nil
+
+            @serializer = AuthorSerializer.new(@author)
+            @adapter = ActiveModel::Serializer::Adapter::JsonApi.new(@serializer)
+          end
+
+          def test_includes_comment_ids
+            expected = {
+              data: [
+                { type: 'posts', id: '1' },
+                { type: 'posts', id: '2' }
+              ]
+            }
+
+            assert_equal(expected, @adapter.serializable_hash[:data][:relationships][:posts])
+          end
+
+          def test_no_includes_linked_comments
+            assert_nil @adapter.serializable_hash[:linked]
+          end
+        end
+      end
+    end
+  end
+end

data/test/adapter/json_api/has_many_explicit_serializer_test.rb

@@ -0,0 +1,98 @@
+require 'test_helper'
+
+module ActiveModel
+  class Serializer
+    module Adapter
+      class JsonApi
+        # Test 'has_many :assocs, serializer: AssocXSerializer'
+        class HasManyExplicitSerializerTest < ActiveSupport::TestCase
+          def setup
+            @post = Post.new(title: 'New Post', body: 'Body')
+            @author = Author.new(name: 'Jane Blogger')
+            @author.posts = [@post]
+            @post.author = @author
+            @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
+            @first_comment.author = nil
+            @second_comment.post = @post
+            @second_comment.author = nil
+            @blog = Blog.new(id: 23, name: 'AMS Blog')
+            @post.blog = @blog
+
+            @serializer = PostPreviewSerializer.new(@post)
+            @adapter = ActiveModel::Serializer::Adapter::JsonApi.new(
+              @serializer,
+              include: [:comments, :author]
+            )
+          end
+
+          def test_includes_comment_ids
+            expected = {
+              data: [
+                { type: 'comments', id: '1' },
+                { type: 'comments', id: '2' }
+              ]
+            }
+
+            assert_equal(expected, @adapter.serializable_hash[:data][:relationships][:comments])
+          end
+
+          def test_includes_linked_data
+            # If CommentPreviewSerializer is applied correctly the body text will not be present in the output
+            expected = [
+              {
+                id: '1',
+                type: 'comments',
+                relationships: {
+                  post: { data: { type: 'posts', id: @post.id.to_s } }
+                }
+              },
+              {
+                id: '2',
+                type: 'comments',
+                relationships: {
+                  post: { data: { type: 'posts', id: @post.id.to_s } }
+                }
+              },
+              {
+                id: @author.id.to_s,
+                type: 'authors',
+                relationships: {
+                  posts: { data: [{ type: 'posts', id: @post.id.to_s }] }
+                }
+              }
+            ]
+
+            assert_equal(expected, @adapter.serializable_hash[:included])
+          end
+
+          def test_includes_author_id
+            expected = {
+              data: { type: 'authors', id: @author.id.to_s }
+            }
+
+            assert_equal(expected, @adapter.serializable_hash[:data][:relationships][:author])
+          end
+
+          def test_explicit_serializer_with_null_resource
+            @post.author = nil
+
+            expected = { data: nil }
+
+            assert_equal(expected, @adapter.serializable_hash[:data][:relationships][:author])
+          end
+
+          def test_explicit_serializer_with_null_collection
+            @post.comments = []
+
+            expected = { data: [] }
+
+            assert_equal(expected, @adapter.serializable_hash[:data][:relationships][:comments])
+          end
+        end
+      end
+    end
+  end
+end

data/test/adapter/json_api/has_many_test.rb

@@ -0,0 +1,145 @@
+require 'test_helper'
+
+module ActiveModel
+  class Serializer
+    module Adapter
+      class JsonApi
+        class HasManyTest < ActiveSupport::TestCase
+          def setup
+            ActionController::Base.cache_store.clear
+            @author = Author.new(id: 1, name: 'Steve K.')
+            @author.posts = []
+            @author.bio = nil
+            @post = Post.new(id: 1, title: 'New Post', body: 'Body')
+            @post_without_comments = Post.new(id: 2, title: 'Second Post', body: 'Second')
+            @first_comment = Comment.new(id: 1, body: 'ZOMG A COMMENT')
+            @first_comment.author = nil
+            @second_comment = Comment.new(id: 2, body: 'ZOMG ANOTHER COMMENT')
+            @second_comment.author = nil
+            @post.comments = [@first_comment, @second_comment]
+            @post_without_comments.comments = []
+            @first_comment.post = @post
+            @second_comment.post = @post
+            @post.author = @author
+            @post_without_comments.author = nil
+            @blog = Blog.new(id: 1, name: 'My Blog!!')
+            @blog.writer = @author
+            @blog.articles = [@post]
+            @post.blog = @blog
+            @post_without_comments.blog = nil
+            @tag = Tag.new(id: 1, name: '#hash_tag')
+            @post.tags = [@tag]
+            @serializer = PostSerializer.new(@post)
+            @adapter = ActiveModel::Serializer::Adapter::JsonApi.new(@serializer)
+
+            @virtual_value = VirtualValue.new(id: 1)
+          end
+
+          def test_includes_comment_ids
+            expected = { data: [{ type: 'comments', id: '1' }, { type: 'comments', id: '2' }] }
+
+            assert_equal(expected, @adapter.serializable_hash[:data][:relationships][:comments])
+          end
+
+          def test_includes_linked_comments
+            @adapter = ActiveModel::Serializer::Adapter::JsonApi.new(@serializer, include: [:comments])
+            expected = [{
+              id: '1',
+              type: 'comments',
+              attributes: {
+                body: 'ZOMG A COMMENT'
+              },
+              relationships: {
+                post: { data: { type: 'posts', id: '1' } },
+                author: { data: nil }
+              }
+            }, {
+              id: '2',
+              type: 'comments',
+              attributes: {
+                body: 'ZOMG ANOTHER COMMENT'
+              },
+              relationships: {
+                post: { data: { type: 'posts', id: '1' } },
+                author: { data: nil }
+              }
+            }]
+            assert_equal expected, @adapter.serializable_hash[:included]
+          end
+
+          def test_limit_fields_of_linked_comments
+            @adapter = ActiveModel::Serializer::Adapter::JsonApi.new(@serializer, include: [:comments], fields: { comment: [:id, :post, :author] })
+            expected = [{
+              id: '1',
+              type: 'comments',
+              relationships: {
+                post: { data: { type: 'posts', id: '1' } },
+                author: { data: nil }
+              }
+            }, {
+              id: '2',
+              type: 'comments',
+              relationships: {
+                post: { data: { type: 'posts', id: '1' } },
+                author: { data: nil }
+              }
+            }]
+            assert_equal expected, @adapter.serializable_hash[:included]
+          end
+
+          def test_no_include_linked_if_comments_is_empty
+            serializer = PostSerializer.new(@post_without_comments)
+            adapter = ActiveModel::Serializer::Adapter::JsonApi.new(serializer)
+
+            assert_nil adapter.serializable_hash[:linked]
+          end
+
+          def test_include_type_for_association_when_different_than_name
+            serializer = BlogSerializer.new(@blog)
+            adapter = ActiveModel::Serializer::Adapter::JsonApi.new(serializer)
+            actual = adapter.serializable_hash[:data][:relationships][:articles]
+
+            expected = {
+              data: [{
+                type: 'posts',
+                id: '1'
+              }]
+            }
+            assert_equal expected, actual
+          end
+
+          def test_has_many_with_no_serializer
+            serializer = PostWithTagsSerializer.new(@post)
+            adapter = ActiveModel::Serializer::Adapter::JsonApi.new(serializer)
+
+            assert_equal({
+              data: {
+                id: '1',
+                type: 'posts',
+                relationships: {
+                  tags: { data: [@tag.as_json] }
+                }
+              }
+            }, adapter.serializable_hash)
+          end
+
+          def test_has_many_with_virtual_value
+            serializer = VirtualValueSerializer.new(@virtual_value)
+            adapter = ActiveModel::Serializer::Adapter::JsonApi.new(serializer)
+
+            assert_equal({
+              data: {
+                id: '1',
+                type: 'virtual_values',
+                relationships: {
+                  maker: { data: { id: 1 } },
+                  reviews: { data: [{ id: 1 }, { id: 2 }] }
+                }
+              }
+            }, adapter.serializable_hash)
+          end
+        end
+      end
+    end
+  end
+end