active_model_serializers 0.8.3 → 0.10.0

data/test/adapter/json_api/errors_test.rb

@@ -0,0 +1,78 @@
+require 'test_helper'
+
+module ActiveModelSerializers
+  module Adapter
+    class JsonApi < Base
+      class ErrorsTest < Minitest::Test
+        include ActiveModel::Serializer::Lint::Tests
+
+        def setup
+          @resource = ModelWithErrors.new
+        end
+
+        def test_active_model_with_error
+          options = {
+              serializer: ActiveModel::Serializer::ErrorSerializer,
+              adapter: :json_api
+          }
+
+          @resource.errors.add(:name, 'cannot be nil')
+
+          serializable_resource = ActiveModelSerializers::SerializableResource.new(@resource, options)
+          assert_equal serializable_resource.serializer_instance.attributes, {}
+          assert_equal serializable_resource.serializer_instance.object, @resource
+
+          expected_errors_object =
+            { :errors =>
+              [
+                {
+                  source: { pointer: '/data/attributes/name' },
+                  detail: 'cannot be nil'
+                }
+              ]
+          }
+          assert_equal serializable_resource.as_json, expected_errors_object
+        end
+
+        def test_active_model_with_multiple_errors
+          options = {
+              serializer: ActiveModel::Serializer::ErrorSerializer,
+              adapter: :json_api
+          }
+
+          @resource.errors.add(:name, 'cannot be nil')
+          @resource.errors.add(:name, 'must be longer')
+          @resource.errors.add(:id, 'must be a uuid')
+
+          serializable_resource = ActiveModelSerializers::SerializableResource.new(@resource, options)
+          assert_equal serializable_resource.serializer_instance.attributes, {}
+          assert_equal serializable_resource.serializer_instance.object, @resource
+
+          expected_errors_object =
+            { :errors =>
+              [
+                { :source => { :pointer => '/data/attributes/name' }, :detail => 'cannot be nil' },
+                { :source => { :pointer => '/data/attributes/name' }, :detail => 'must be longer' },
+                { :source => { :pointer => '/data/attributes/id' }, :detail => 'must be a uuid' }
+              ]
+          }
+          assert_equal serializable_resource.as_json, expected_errors_object
+        end
+
+        # see http://jsonapi.org/examples/
+        def test_parameter_source_type_error
+          parameter = 'auther'
+          error_source = ActiveModelSerializers::Adapter::JsonApi::Error.error_source(:parameter, parameter)
+          assert_equal({ parameter: parameter }, error_source)
+        end
+
+        def test_unknown_source_type_error
+          value = 'auther'
+          assert_raises(ActiveModelSerializers::Adapter::JsonApi::Error::UnknownSourceTypeError) do
+            ActiveModelSerializers::Adapter::JsonApi::Error.error_source(:hyper, value)
+          end
+        end
+      end
+    end
+  end
+end

data/test/adapter/json_api/fields_test.rb

@@ -0,0 +1,87 @@
+require 'test_helper'
+
+module ActiveModelSerializers
+  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

data/test/adapter/json_api/has_many_embed_ids_test.rb

@@ -0,0 +1,43 @@
+require 'test_helper'
+
+module ActiveModelSerializers
+  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 = ActiveModelSerializers::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

data/test/adapter/json_api/has_many_explicit_serializer_test.rb

@@ -0,0 +1,96 @@
+require 'test_helper'
+
+module ActiveModelSerializers
+  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 = ActiveModelSerializers::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

data/test/adapter/json_api/has_many_test.rb

@@ -0,0 +1,144 @@
+require 'test_helper'
+
+module ActiveModelSerializers
+  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 = ActiveModelSerializers::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 = ActiveModelSerializers::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 = ActiveModelSerializers::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 = ActiveModelSerializers::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 = ActiveModelSerializers::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 = ActiveModelSerializers::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 = ActiveModelSerializers::Adapter::JsonApi.new(serializer)
+
+          assert_equal({
+            data: {
+              id: '1',
+              type: 'virtual-values',
+              relationships: {
+                maker: { data: { type: 'makers', id: '1' } },
+                reviews: { data: [{ type: 'reviews', id: '1' },
+                                  { type: 'reviews', id: '2' }] }
+              }
+            }
+          }, adapter.serializable_hash)
+        end
+      end
+    end
+  end
+end

data/test/adapter/json_api/has_one_test.rb

@@ -0,0 +1,80 @@
+require 'test_helper'
+
+module ActiveModelSerializers
+  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 = ActiveModelSerializers::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 = ActiveModelSerializers::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 = ActiveModelSerializers::Adapter::JsonApi.new(serializer)
+
+          expected = {
+            data: {
+              id: '1',
+              type: 'virtual-values',
+              relationships: {
+                maker: { data: { type: 'makers', id: '1' } },
+                reviews: { data: [{ type: 'reviews', id: '1' },
+                                  { type: 'reviews', id: '2' }] }
+              }
+            }
+          }
+
+          assert_equal(expected, adapter.serializable_hash)
+        end
+      end
+    end
+  end
+end

data/test/adapter/json_api/json_api_test.rb

@@ -0,0 +1,35 @@
+require 'test_helper'
+
+module ActiveModelSerializers
+  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 = ActiveModelSerializers::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