active_model_serializers 0.9.9 → 0.10.0.rc1

data/test/action_controller/serialization_test.rb

@@ -0,0 +1,365 @@
+require 'test_helper'
+
+module ActionController
+  module Serialization
+    class ImplicitSerializerTest < ActionController::TestCase
+      class MyController < ActionController::Base
+        def render_using_implicit_serializer
+          @profile = Profile.new({ name: 'Name 1', description: 'Description 1', comments: 'Comments 1' })
+          render json: @profile
+        end
+
+        def render_using_custom_root
+          @profile = Profile.new({ name: 'Name 1', description: 'Description 1', comments: 'Comments 1' })
+          render json: @profile, root: "custom_root"
+        end
+
+        def render_using_default_adapter_root
+          with_adapter ActiveModel::Serializer::Adapter::JsonApi do
+            # JSON-API adapter sets root by default
+            @profile = Profile.new({ name: 'Name 1', description: 'Description 1', comments: 'Comments 1' })
+            render json: @profile
+          end
+        end
+
+        def render_using_custom_root_in_adapter_with_a_default
+          # JSON-API adapter sets root by default
+          @profile = Profile.new({ name: 'Name 1', description: 'Description 1', comments: 'Comments 1' })
+          render json: @profile, root: "profile", adapter: :json_api
+        end
+
+        def render_array_using_implicit_serializer
+          array = [
+            Profile.new({ name: 'Name 1', description: 'Description 1', comments: 'Comments 1' }),
+            Profile.new({ name: 'Name 2', description: 'Description 2', comments: 'Comments 2' })
+          ]
+          render json: array
+        end
+
+        def render_array_using_implicit_serializer_and_meta
+          with_adapter ActiveModel::Serializer::Adapter::JsonApi do
+
+            @profiles = [
+              Profile.new({ name: 'Name 1', description: 'Description 1', comments: 'Comments 1' })
+            ]
+
+            render json: @profiles, meta: { total: 10 }
+          end
+        end
+
+        def render_object_with_cache_enabled
+          @comment = Comment.new({ id: 1, body: 'ZOMG A COMMENT' })
+          @author  = Author.new(id: 1, name: 'Joao Moura.')
+          @post    = Post.new({ id: 1, title: 'New Post', body: 'Body', comments: [@comment], author: @author })
+
+          generate_cached_serializer(@post)
+
+          @post.title = 'ZOMG a New Post'
+          render json: @post
+        end
+
+        def update_and_render_object_with_cache_enabled
+          @post.updated_at = DateTime.now
+
+          generate_cached_serializer(@post)
+          render json: @post
+        end
+
+        def render_object_expired_with_cache_enabled
+          comment = Comment.new({ id: 1, body: 'ZOMG A COMMENT' })
+          author = Author.new(id: 1, name: 'Joao Moura.')
+          post = Post.new({ id: 1, title: 'New Post', body: 'Body', comments: [comment], author: author })
+
+          generate_cached_serializer(post)
+
+          post.title = 'ZOMG a New Post'
+          sleep 0.1
+          render json: post
+        end
+
+        def render_changed_object_with_cache_enabled
+          comment = Comment.new({ id: 1, body: 'ZOMG A COMMENT' })
+          author = Author.new(id: 1, name: 'Joao Moura.')
+          post = Post.new({ id: 1, title: 'ZOMG a New Post', body: 'Body', comments: [comment], author: author })
+
+          render json: post
+        end
+
+        def render_fragment_changed_object_with_only_cache_enabled
+          author = Author.new(id: 1, name: 'Joao Moura.')
+          role = Role.new({ id: 42, name: 'ZOMG A ROLE', description: 'DESCRIPTION HERE', author: author })
+
+          generate_cached_serializer(role)
+          role.name = 'lol'
+          role.description = 'HUEHUEBRBR'
+
+          render json: role
+        end
+
+        def render_fragment_changed_object_with_except_cache_enabled
+          author = Author.new(id: 1, name: 'Joao Moura.')
+          bio = Bio.new({ id: 42, content: 'ZOMG A ROLE', rating: 5, author: author })
+
+          generate_cached_serializer(bio)
+          bio.content = 'lol'
+          bio.rating = 0
+
+          render json: bio
+        end
+
+        def render_fragment_changed_object_with_relationship
+          comment = Comment.new({ id: 1, body: 'ZOMG A COMMENT' })
+          author = Author.new(id: 1, name: 'Joao Moura.')
+          post = Post.new({ id: 1, title: 'New Post', body: 'Body', comments: [comment], author: author })
+          post2 = Post.new({ id: 1, title: 'New Post2', body: 'Body2', comments: [comment], author: author })
+          like = Like.new({ id: 1, post: post, time: 3.days.ago })
+
+          generate_cached_serializer(like)
+          like.post = post2
+          like.time = DateTime.now.to_s
+
+          render json: like
+        end
+
+        private
+        def generate_cached_serializer(obj)
+          serializer_class = ActiveModel::Serializer.serializer_for(obj)
+          serializer = serializer_class.new(obj)
+          adapter = ActiveModel::Serializer.adapter.new(serializer)
+          adapter.to_json
+        end
+
+        def with_adapter(adapter)
+          old_adapter = ActiveModel::Serializer.config.adapter
+          # JSON-API adapter sets root by default
+          ActiveModel::Serializer.config.adapter = adapter
+          yield
+        ensure
+          ActiveModel::Serializer.config.adapter = old_adapter
+        end
+      end
+
+      tests MyController
+
+      # We just have Null for now, this will change
+      def test_render_using_implicit_serializer
+        get :render_using_implicit_serializer
+
+        expected = {
+          name: "Name 1",
+          description: "Description 1"
+        }
+
+        assert_equal 'application/json', @response.content_type
+        assert_equal expected.to_json, @response.body
+      end
+
+      def test_render_using_custom_root
+        get :render_using_custom_root
+
+        assert_equal 'application/json', @response.content_type
+        assert_equal '{"custom_root":{"name":"Name 1","description":"Description 1"}}', @response.body
+      end
+
+      def test_render_using_default_root
+        get :render_using_default_adapter_root
+
+        expected = {
+          data: {
+            name: "Name 1",
+            description: "Description 1",
+            id: assigns(:profile).id.to_s,
+            type: "profiles"
+          }
+        }
+
+        assert_equal 'application/json', @response.content_type
+        assert_equal expected.to_json, @response.body
+      end
+
+      def test_render_using_custom_root_in_adapter_with_a_default
+        get :render_using_custom_root_in_adapter_with_a_default
+
+        expected = {
+          data: {
+            name: "Name 1",
+            description: "Description 1",
+            id: assigns(:profile).id.to_s,
+            type: "profiles"
+          }
+        }
+
+        assert_equal 'application/json', @response.content_type
+        assert_equal expected.to_json, @response.body
+      end
+
+      def test_render_array_using_implicit_serializer
+        get :render_array_using_implicit_serializer
+        assert_equal 'application/json', @response.content_type
+
+        expected = [
+          {
+            name: 'Name 1',
+            description: 'Description 1',
+          },
+          {
+            name: 'Name 2',
+            description: 'Description 2',
+          }
+        ]
+
+        assert_equal expected.to_json, @response.body
+      end
+
+      def test_render_array_using_implicit_serializer_and_meta
+        get :render_array_using_implicit_serializer_and_meta
+
+        expected = {
+          data: [
+            {
+              name: "Name 1",
+              description: "Description 1",
+              id: assigns(:profiles).first.id.to_s,
+              type: "profiles"
+            }
+          ],
+          meta: {
+            total: 10
+          }
+        }
+
+        assert_equal 'application/json', @response.content_type
+        assert_equal expected.to_json, @response.body
+      end
+
+      def test_render_with_cache_enable
+        ActionController::Base.cache_store.clear
+        get :render_object_with_cache_enabled
+
+        expected = {
+          id: 1,
+          title: 'New Post',
+          body: 'Body',
+          comments: [
+            {
+              id: 1,
+              body: 'ZOMG A COMMENT' }
+          ],
+          blog: {
+            id: 999,
+            name: 'Custom blog'
+          },
+          author: {
+            id: 1,
+            name: 'Joao Moura.'
+          }
+        }
+
+        assert_equal 'application/json', @response.content_type
+        assert_equal expected.to_json, @response.body
+
+        get :render_changed_object_with_cache_enabled
+        assert_equal expected.to_json, @response.body
+
+        ActionController::Base.cache_store.clear
+        get :render_changed_object_with_cache_enabled
+        assert_not_equal expected.to_json, @response.body
+      end
+
+      def test_render_with_cache_enable_and_expired
+        ActionController::Base.cache_store.clear
+        get :render_object_expired_with_cache_enabled
+
+        expected = {
+          id: 1,
+          title: 'ZOMG a New Post',
+          body: 'Body',
+          comments: [
+            {
+              id: 1,
+              body: 'ZOMG A COMMENT' }
+          ],
+          blog: {
+            id: 999,
+            name: 'Custom blog'
+          },
+          author: {
+            id: 1,
+            name: 'Joao Moura.'
+          }
+        }
+
+        assert_equal 'application/json', @response.content_type
+        assert_equal expected.to_json, @response.body
+      end
+
+      def test_render_with_fragment_only_cache_enable
+        ActionController::Base.cache_store.clear
+        get :render_fragment_changed_object_with_only_cache_enabled
+        response = JSON.parse(@response.body)
+
+        assert_equal 'application/json', @response.content_type
+        assert_equal 'ZOMG A ROLE', response["name"]
+        assert_equal 'HUEHUEBRBR', response["description"]
+      end
+
+      def test_render_with_fragment_except_cache_enable
+        ActionController::Base.cache_store.clear
+        get :render_fragment_changed_object_with_except_cache_enabled
+        response = JSON.parse(@response.body)
+
+        assert_equal 'application/json', @response.content_type
+        assert_equal 5, response["rating"]
+        assert_equal 'lol', response["content"]
+      end
+
+      def test_render_fragment_changed_object_with_relationship
+        ActionController::Base.cache_store.clear
+        get :render_fragment_changed_object_with_relationship
+        response = JSON.parse(@response.body)
+
+        expected_return = {
+          "post" => {
+            "id"=>1,
+            "title"=>"New Post",
+            "body"=>"Body"
+          },
+          "id"=>1,
+          "time"=>DateTime.now.to_s
+        }
+
+        assert_equal 'application/json', @response.content_type
+        assert_equal expected_return, response
+      end
+
+      def test_cache_expiration_on_update
+        ActionController::Base.cache_store.clear
+        get :render_object_with_cache_enabled
+
+        expected = {
+          id: 1,
+          title: 'ZOMG a New Post',
+          body: 'Body',
+          comments: [
+            {
+              id: 1,
+              body: 'ZOMG A COMMENT' }
+          ],
+          blog: {
+            id:999,
+            name: "Custom blog"
+          },
+          author: {
+            id: 1,
+            name: 'Joao Moura.'
+          }
+        }
+
+        get :update_and_render_object_with_cache_enabled
+
+        assert_equal 'application/json', @response.content_type
+        assert_equal expected.to_json, @response.body
+      end
+    end
+  end
+end

data/test/adapter/fragment_cache_test.rb

@@ -0,0 +1,27 @@
+require 'test_helper'
+module ActiveModel
+  class Serializer
+    class Adapter
+      class FragmentCacheTest < Minitest::Test
+        def setup
+          @author          = Author.new(name: 'Joao M. D. Moura')
+          @role            = Role.new(name: 'Great Author', description:nil)
+          @role.author     = [@author]
+          @role_serializer = RoleSerializer.new(@role)
+          @role_hash       = FragmentCache.new(RoleSerializer.adapter.new(@role_serializer), @role_serializer, {}, nil)
+        end
+
+        def test_fragment_fetch_with_virtual_attributes
+          expected_result = {
+            id: @role.id,
+            description: @role.description,
+            slug: "#{@role.name}-#{@role.id}",
+            name: @role.name
+          }
+          assert_equal(@role_hash.fetch, expected_result)
+        end
+      end
+    end
+  end
+end
+

data/test/adapter/json/belongs_to_test.rb

@@ -0,0 +1,41 @@
+require 'test_helper'
+
+module ActiveModel
+  class Serializer
+    class Adapter
+      class Json
+        class BelongsToTest < Minitest::Test
+          def setup
+            @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 = []
+            @post.author = @author
+            @comment.post = @post
+            @comment.author = nil
+            @anonymous_post.author = nil
+            @blog = Blog.new(id: 1, name: "My Blog!!")
+            @post.blog = @blog
+            @anonymous_post.blog = nil
+
+            @serializer = CommentSerializer.new(@comment)
+            @adapter = ActiveModel::Serializer::Adapter::Json.new(@serializer)
+            ActionController::Base.cache_store.clear
+          end
+
+          def test_includes_post
+            assert_equal({id: 42, title: 'New Post', body: 'Body'}, @adapter.serializable_hash[:post])
+          end
+
+          def test_include_nil_author
+            serializer = PostSerializer.new(@anonymous_post)
+            adapter = ActiveModel::Serializer::Adapter::Json.new(serializer)
+
+            assert_equal({title: "Hello!!", body: "Hello, world!!", id: 43, comments: [], blog: {id: 999, name: "Custom blog"}, author: nil}, adapter.serializable_hash)
+          end
+        end
+      end
+    end
+  end
+end

data/test/adapter/json/collection_test.rb

@@ -0,0 +1,59 @@
+require 'test_helper'
+
+module ActiveModel
+  class Serializer
+    class Adapter
+      class Json
+        class Collection < Minitest::Test
+          def setup
+            @author = Author.new(id: 1, name: 'Steve K.')
+            @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.author = @author
+            @second_post.author = @author
+            @blog = Blog.new(id: 1, name: "My Blog!!")
+            @first_post.blog = @blog
+            @second_post.blog = nil
+
+            @serializer = ArraySerializer.new([@first_post, @second_post])
+            @adapter = ActiveModel::Serializer::Adapter::Json.new(@serializer)
+            ActionController::Base.cache_store.clear
+          end
+
+          def test_include_multiple_posts
+            expected = [{
+              title: "Hello!!",
+              body: "Hello, world!!",
+              id: 1,
+              comments: [],
+              author: {
+                id: 1,
+                name: "Steve K."
+              },
+              blog: {
+                id: 999,
+                name: "Custom blog"
+              }
+            }, {
+              title: "New Post",
+              body: "Body",
+              id: 2,
+              comments: [],
+              author: {
+                id: 1,
+                name: "Steve K."
+              },
+              blog: {
+                id: 999,
+                name: "Custom blog"
+              }
+            }]
+            assert_equal expected, @adapter.serializable_hash
+          end
+        end
+      end
+    end
+  end
+end

data/test/adapter/json/has_many_test.rb

@@ -0,0 +1,36 @@
+require 'test_helper'
+
+module ActiveModel
+  class Serializer
+    class Adapter
+      class Json
+        class HasManyTestTest < 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]
+            @post.author = @author
+            @first_comment.post = @post
+            @second_comment.post = @post
+            @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
+end
+

data/test/adapter/json_api/belongs_to_test.rb

@@ -0,0 +1,147 @@
+require 'test_helper'
+
+module ActiveModel
+  class Serializer
+    class Adapter
+      class JsonApi
+        class BelongsToTest < Minitest::Test
+          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 = { linkage: { type: "posts", id: "42" } }
+
+            assert_equal(expected, @adapter.serializable_hash[:data][:links][:post])
+          end
+
+          def test_includes_linked_post
+            @adapter = ActiveModel::Serializer::Adapter::JsonApi.new(@serializer, include: 'post')
+            expected = [{
+              id: "42",
+              type: "posts",
+              title: 'New Post',
+              body: 'Body',
+              links: {
+                comments: { linkage: [ { type: "comments", id: "1" } ] },
+                blog: { linkage: { type: "blogs", id: "999" } },
+                author: { linkage: { 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]})
+            expected = [{
+              id: "42",
+              type: "posts",
+              title: 'New Post',
+              links: {
+                comments: { linkage: [ { type: "comments", id: "1" } ] },
+                blog: { linkage: { type: "blogs", id: "999" } },
+                author: { linkage: { 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: { linkage: [] }, blog: { linkage: { type: "blogs", id: "999" } }, author: { linkage: nil }}, adapter.serializable_hash[:data][:links])
+          end
+
+          def test_include_type_for_association_when_different_than_name
+            serializer = BlogSerializer.new(@blog)
+            adapter = ActiveModel::Serializer::Adapter::JsonApi.new(serializer)
+            links = adapter.serializable_hash[:data][:links]
+            expected = {
+              writer: {
+                linkage: {
+                  type: "authors",
+                  id: "1"
+                }
+              },
+              articles: {
+                linkage: [
+                  {
+                    type: "posts",
+                    id: "42"
+                  },
+                  {
+                    type: "posts",
+                    id: "43"
+                  }
+                ]
+              }
+            }
+            assert_equal expected, links
+          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",
+                name: "Steve K.",
+                links: {
+                  posts: { linkage: [] },
+                  roles: { linkage: [] },
+                  bio: { linkage: nil }
+                }
+              },{
+                id: "42",
+                type: "posts",
+                title: "New Post",
+                body: "Body",
+                links: {
+                  comments: { linkage: [ { type: "comments", id: "1" } ] },
+                  blog: { linkage: { type: "blogs", id: "999" } },
+                  author: { linkage: { type: "authors", id: "1" } }
+                }
+              }, {
+                id: "43",
+                type: "posts",
+                title: "Hello!!",
+                body: "Hello, world!!",
+                links: {
+                  comments: { linkage: [] },
+                  blog: { linkage: { type: "blogs", id: "999" } },
+                  author: { linkage: nil }
+                }
+              }
+            ]
+            assert_equal expected, linked
+          end
+        end
+      end
+    end
+  end
+end