active_model_serializers 0.8.3 → 0.10.0.rc1

data/test/adapter/json_api/collection_test.rb

@@ -0,0 +1,89 @@
+require 'test_helper'
+
+module ActiveModel
+  class Serializer
+    class Adapter
+      class JsonApi
+        class CollectionTest < Minitest::Test
+          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 = ArraySerializer.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",
+                title: "Hello!!",
+                body: "Hello, world!!",
+                links: {
+                  comments: { linkage: [] },
+                  blog: { linkage: { type: "blogs", id: "999" } },
+                  author: { linkage: { type: "authors", id: "1" } }
+                }
+              },
+              {
+                id: "2",
+                type: "posts",
+                title: "New Post",
+                body: "Body",
+                links: {
+                  comments: { linkage: [] },
+                  blog: { linkage: { type: "blogs", id: "999" } },
+                  author: { linkage: { type: "authors", id: "1" } }
+                }
+              }
+            ]
+
+            assert_equal(expected, @adapter.serializable_hash[:data])
+          end
+
+          def test_limiting_fields
+            @adapter = ActiveModel::Serializer::Adapter::JsonApi.new(@serializer, fields: ['title'])
+
+            expected = [
+              {
+                id: "1",
+                type: "posts",
+                title: "Hello!!",
+                links: {
+                  comments: { linkage: [] },
+                  blog: { linkage: { type: "blogs", id: "999" } },
+                  author: { linkage: { type: "authors", id: "1" } }
+                }
+              },
+              {
+                id: "2",
+                type: "posts",
+                title: "New Post",
+                links: {
+                  comments: { linkage: [] },
+                  blog: { linkage: { type: "blogs", id: "999" } },
+                  author: { linkage: { type: "authors", id: "1" } }
+                }
+              }
+            ]
+
+            assert_equal(expected, @adapter.serializable_hash[:data])
+          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
+    class Adapter
+      class JsonApi
+        class HasManyEmbedIdsTest < Minitest::Test
+          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 = {
+              linkage: [
+                { type: "posts", id: "1"},
+                { type: "posts", id: "2"}
+              ]
+            }
+
+            assert_equal(expected, @adapter.serializable_hash[:data][:links][: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
+    class Adapter
+      class JsonApi
+        # Test 'has_many :assocs, serializer: AssocXSerializer'
+        class HasManyExplicitSerializerTest < Minitest::Test
+          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 = {
+              linkage: [
+                { type: 'comments', id: '1' },
+                { type: 'comments', id: '2' }
+              ]
+            }
+
+            assert_equal(expected, @adapter.serializable_hash[:data][:links][: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',
+                links: {
+                  post: { linkage: { type: 'posts', id: @post.id.to_s } }
+                }
+              },
+              {
+                id: '2',
+                type: 'comments',
+                links: {
+                  post: { linkage: { type: 'posts', id: @post.id.to_s } }
+                }
+              },
+              {
+                id: @author.id.to_s,
+                type: "authors",
+                links: {
+                  posts: { linkage: [ {type: "posts", id: @post.id.to_s } ] }
+                }
+              }
+            ]
+
+            assert_equal(expected, @adapter.serializable_hash[:included])
+          end
+
+          def test_includes_author_id
+            expected = {
+              linkage: { type: "authors", id: @author.id.to_s }
+            }
+
+            assert_equal(expected, @adapter.serializable_hash[:data][:links][:author])
+          end
+
+          def test_explicit_serializer_with_null_resource
+            @post.author = nil
+
+            expected = { linkage: nil }
+
+            assert_equal(expected, @adapter.serializable_hash[:data][:links][:author])
+          end
+
+          def test_explicit_serializer_with_null_collection
+            @post.comments = []
+
+            expected = { linkage: [] }
+
+            assert_equal(expected, @adapter.serializable_hash[:data][:links][:comments])
+          end
+        end
+      end
+    end
+  end
+end

data/test/adapter/json_api/has_many_test.rb

@@ -0,0 +1,106 @@
+require 'test_helper'
+
+module ActiveModel
+  class Serializer
+    class Adapter
+      class JsonApi
+        class HasManyTest < Minitest::Test
+          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
+
+            @serializer = PostSerializer.new(@post)
+            @adapter = ActiveModel::Serializer::Adapter::JsonApi.new(@serializer)
+          end
+
+          def test_includes_comment_ids
+            expected = { linkage: [ { type: "comments", id: "1" }, { type: "comments", id: "2" } ] }
+
+            assert_equal(expected, @adapter.serializable_hash[:data][:links][:comments])
+          end
+
+          def test_includes_linked_comments
+            @adapter = ActiveModel::Serializer::Adapter::JsonApi.new(@serializer, include: 'comments')
+            expected = [{
+              id: "1",
+              type: "comments",
+              body: 'ZOMG A COMMENT',
+              links: {
+                post: { linkage: { type: "posts", id: "1" } },
+                author: { linkage: nil }
+              }
+            }, {
+              id: "2",
+              type: "comments",
+              body: 'ZOMG ANOTHER COMMENT',
+              links: {
+                post: { linkage: { type: "posts", id: "1" } },
+                author: { linkage: 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]})
+            expected = [{
+              id: "1",
+              type: "comments",
+              links: {
+                post: { linkage: { type: "posts", id: "1" } },
+                author: { linkage: nil }
+              }
+            }, {
+              id: "2",
+              type: "comments",
+              links: {
+                post: { linkage: { type: "posts", id: "1" } },
+                author: { linkage: 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][:links][:articles]
+            expected = {
+              linkage: [{
+                type: "posts",
+                id: "1"
+              }]
+            }
+            assert_equal expected, actual
+          end
+        end
+      end
+    end
+  end
+end

data/test/adapter/json_api/has_one_test.rb

@@ -0,0 +1,59 @@
+require 'test_helper'
+
+module ActiveModel
+  class Serializer
+    class Adapter
+      class JsonApi
+        class HasOneTest < Minitest::Test
+          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 = []
+
+            @serializer = AuthorSerializer.new(@author)
+            @adapter = ActiveModel::Serializer::Adapter::JsonApi.new(@serializer, include: 'bio,posts')
+          end
+
+          def test_includes_bio_id
+            expected = { linkage: { type: "bios", id: "43" } }
+
+            assert_equal(expected, @adapter.serializable_hash[:data][:links][:bio])
+          end
+
+          def test_includes_linked_bio
+            @adapter = ActiveModel::Serializer::Adapter::JsonApi.new(@serializer, include: 'bio')
+
+            expected = [
+              {
+                id: "43",
+                rating: nil,
+                type: "bios",
+                content:"AMS Contributor",
+                links: {
+                  author: { linkage: { type: "authors", id: "1" } }
+                }
+              }
+            ]
+
+            assert_equal(expected, @adapter.serializable_hash[:included])
+          end
+        end
+      end
+    end
+  end
+end

data/test/adapter/json_api/linked_test.rb

@@ -0,0 +1,257 @@
+require 'test_helper'
+module ActiveModel
+  class Serializer
+    class Adapter
+      class JsonApi
+        class LinkedTest < Minitest::Test
+          def setup
+            ActionController::Base.cache_store.clear
+            @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 = ArraySerializer.new([@first_post, @second_post])
+            adapter = ActiveModel::Serializer::Adapter::JsonApi.new(
+              serializer,
+              include: ['author', 'author.bio', 'comments']
+            )
+            alt_adapter = ActiveModel::Serializer::Adapter::JsonApi.new(
+              serializer,
+              include: 'author,author.bio,comments'
+            )
+
+            expected = {
+              data: [
+                {
+                  id: "10",
+                  title: "Hello!!",
+                  body: "Hello, world!!",
+                  type: "posts",
+                  links: {
+                    comments: { linkage: [ { type: "comments", id: '1' }, { type: "comments", id: '2' } ] },
+                    blog: { linkage: { type: "blogs", id: "999" } },
+                    author: { linkage: { type: "authors", id: "1" } }
+                  }
+                },
+                {
+                  id: "20",
+                  title: "New Post",
+                  body: "Body",
+                  type: "posts",
+                  links: {
+                    comments: { linkage: [] },
+                    blog: { linkage: { type: "blogs", id: "999" } },
+                    author: { linkage: { type: "authors", id: "2" } }
+                  }
+                }
+              ],
+              included: [
+                {
+                  id: "1",
+                  body: "ZOMG A COMMENT",
+                  type: "comments",
+                  links: {
+                    post: { linkage: { type: "posts", id: "10" } },
+                    author: { linkage: nil }
+                  }
+                }, {
+                  id: "2",
+                  body: "ZOMG ANOTHER COMMENT",
+                  type: "comments",
+                  links: {
+                    post: { linkage: { type: "posts", id: "10" } },
+                    author: { linkage: nil }
+                  }
+                }, {
+                  id: "1",
+                  name: "Steve K.",
+                  type: "authors",
+                  links: {
+                    posts: { linkage: [ { type: "posts", id: "10" }, { type: "posts", id: "30" } ] },
+                    roles: { linkage: [] },
+                    bio: { linkage: { type: "bios", id: "1" } }
+                  }
+                }, {
+                  id: "1",
+                  rating: nil,
+                  type: "bios",
+                  content: "AMS Contributor",
+                  links: {
+                    author: { linkage: { type: "authors", id: "1" } }
+                  }
+                }, {
+                  id: "2",
+                  name: "Tenderlove",
+                  type: "authors",
+                  links: {
+                    posts: { linkage: [ { type: "posts", id:"20" } ] },
+                    roles: { linkage: [] },
+                    bio: { linkage: { type: "bios", id: "2" } }
+                  }
+                }, {
+                  id: "2",
+                  rating: nil,
+                  type: "bios",
+                  content: "Rails Contributor",
+                  links: {
+                    author: { linkage: { 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', 'author.posts']
+            )
+            alt_adapter = ActiveModel::Serializer::Adapter::JsonApi.new(
+              serializer,
+              include: 'author,author.posts'
+            )
+
+            expected = [
+              {
+                id: "1",
+                type: "authors",
+                name: "Steve K.",
+                links: {
+                  posts: { linkage: [ { type: "posts", id: "10"}, { type: "posts", id: "30" }] },
+                  roles: { linkage: [] },
+                  bio: { linkage: { type: "bios", id: "1" }}
+                }
+              }, {
+                id: "10",
+                type: "posts",
+                title: "Hello!!",
+                body: "Hello, world!!",
+                links: {
+                  comments: { linkage: [ { type: "comments", id: "1"}, { type: "comments", id: "2" }] },
+                  blog: { linkage: { type: "blogs", id: "999" } },
+                  author: { linkage: { type: "authors", id: "1" } }
+                }
+              }, {
+                id: "30",
+                type: "posts",
+                title: "Yet Another Post",
+                body: "Body",
+                links: {
+                  comments: { linkage: [] },
+                  blog: { linkage: { type: "blogs", id: "999" } },
+                  author: { linkage: { type: "authors", id: "1" } }
+                }
+              }
+            ]
+
+            assert_equal expected, adapter.serializable_hash[:included]
+            assert_equal expected, alt_adapter.serializable_hash[:included]
+          end
+
+          def test_ignore_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)
+            links = adapter.serializable_hash[:data][:links]
+            expected = {
+              related: {
+                linkage: [{
+                  type: 'unrelated_links',
+                  id: '456'
+                }]
+              }
+            }
+            assert_equal expected, links
+          end
+
+          def test_multiple_references_to_same_resource
+            serializer = ArraySerializer.new([@first_comment, @second_comment])
+            adapter = ActiveModel::Serializer::Adapter::JsonApi.new(
+              serializer,
+              include: ['post']
+            )
+
+            expected = [
+              {
+                id: "10",
+                title: "Hello!!",
+                body: "Hello, world!!",
+                type: "posts",
+                links: {
+                  comments: {
+                    linkage: [{type: "comments", id: "1"}, {type: "comments", id: "2"}]
+                  },
+                  blog: {
+                    linkage: {type: "blogs", id: "999"}
+                  },
+                  author: {
+                    linkage: {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",
+                title: "Hello!!",
+                body: "Hello, world!!",
+                type: "posts",
+                links: {
+                  comments: { linkage: [ { type: "comments", id: '1' }, { type: "comments", id: '2' } ] },
+                  author: { linkage: nil }
+                }
+              }
+            }
+            assert_equal expected, adapter.serializable_hash
+          end
+        end
+      end
+    end
+  end
+end

data/test/adapter/json_test.rb

@@ -0,0 +1,34 @@
+require 'test_helper'
+
+module ActiveModel
+  class Serializer
+    class Adapter
+      class JsonTest < Minitest::Test
+        def setup
+          ActionController::Base.cache_store.clear
+          @author = Author.new(id: 1, name: 'Steve K.')
+          @post = Post.new(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
+
+          @serializer = PostSerializer.new(@post)
+          @adapter = ActiveModel::Serializer::Adapter::Json.new(@serializer)
+        end
+
+        def test_has_many
+          assert_equal([
+                         {id: 1, body: 'ZOMG A COMMENT'},
+                         {id: 2, body: 'ZOMG ANOTHER COMMENT'}
+                       ], @adapter.serializable_hash[:comments])
+        end
+      end
+    end
+  end
+end
+