active_model_serializers 0.8.3 → 0.10.0.rc2

data/test/adapter/json_api/linked_test.rb

@@ -0,0 +1,283 @@
+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",
+                  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', 'author.posts']
+            )
+            alt_adapter = ActiveModel::Serializer::Adapter::JsonApi.new(
+              serializer,
+              include: 'author,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 = ArraySerializer.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
+      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[:post][:comments])
+        end
+      end
+    end
+  end
+end
+

data/test/adapter/null_test.rb

@@ -0,0 +1,25 @@
+require 'test_helper'
+
+module ActiveModel
+  class Serializer
+    class Adapter
+      class NullTest < Minitest::Test
+        def setup
+          profile = Profile.new({ name: 'Name 1', description: 'Description 1', comments: 'Comments 1' })
+          serializer = ProfileSerializer.new(profile)
+
+          @adapter = Null.new(serializer)
+        end
+
+        def test_serializable_hash
+          assert_equal({}, @adapter.serializable_hash)
+        end
+
+        def test_it_returns_empty_json
+          assert_equal('{}', @adapter.to_json)
+        end
+      end
+    end
+  end
+end
+

data/test/adapter_test.rb

@@ -0,0 +1,43 @@
+require 'test_helper'
+
+module ActiveModel
+  class Serializer
+    class AdapterTest < Minitest::Test
+      def setup
+        profile = Profile.new
+        @serializer = ProfileSerializer.new(profile)
+        @adapter = ActiveModel::Serializer::Adapter.new(@serializer)
+      end
+
+      def test_serializable_hash_is_abstract_method
+        assert_raises(NotImplementedError) do
+          @adapter.serializable_hash(only: [:name])
+        end
+      end
+
+      def test_serializer
+        assert_equal @serializer, @adapter.serializer
+      end
+
+      def test_adapter_class_for_known_adapter
+        klass = ActiveModel::Serializer::Adapter.adapter_class(:json_api)
+        assert_equal ActiveModel::Serializer::Adapter::JsonApi, klass
+      end
+
+      def test_adapter_class_for_unknown_adapter
+        klass = ActiveModel::Serializer::Adapter.adapter_class(:json_simple)
+        assert_nil klass
+      end
+
+      def test_create_adapter
+        adapter = ActiveModel::Serializer::Adapter.create(@serializer)
+        assert_equal ActiveModel::Serializer::Adapter::FlattenJson, adapter.class
+      end
+
+      def test_create_adapter_with_override
+        adapter = ActiveModel::Serializer::Adapter.create(@serializer, { adapter: :json_api})
+        assert_equal ActiveModel::Serializer::Adapter::JsonApi, adapter.class
+      end
+    end
+  end
+end

data/test/array_serializer_test.rb

@@ -1,75 +1,43 @@
-require "test_helper"
-require "test_fakes"
+require 'test_helper'
 
-class ArraySerializerTest < ActiveModel::TestCase
+module ActiveModel
+  class Serializer
+    class ArraySerializerTest < Minitest::Test
+      def setup
+        @comment = Comment.new
+        @post = Post.new
+        @serializer = ArraySerializer.new([@comment, @post], {some: :options})
+      end
 
-  def test_array_items_do_not_have_root
-    array = [
-        BasicActiveModel.new(:name => "First model"),
-        BasicActiveModel.new(:name => "Second model")
-    ]
-    expected = { "root" => [
-        { :name => "First model" },
-        { :name => "Second model" }
-    ] }
+      def test_respond_to_each
+        assert_respond_to @serializer, :each
+      end
 
-    default_serializer = array.active_model_serializer.new(array, :root => "root")
-    each_serializer = array.active_model_serializer.new(array, :root => "root", :each_serializer => BasicSerializer)
+      def test_each_object_should_be_serialized_with_appropriate_serializer
+        serializers =  @serializer.to_a
 
-    default_json = default_serializer.as_json
-    each_json = each_serializer.as_json
+        assert_kind_of CommentSerializer, serializers.first
+        assert_kind_of Comment, serializers.first.object
 
-    assert_equal(expected, default_json)
-    assert_equal(expected, each_json)
-  end
-
-  # serialize different typed objects
-  def test_array_serializer
-    model    = Model.new
-    user     = User.new
-    comments = Comment.new(:title => "Comment1", :id => 1)
-
-    array = [model, user, comments]
-    serializer = array.active_model_serializer.new(array, :scope => {:scope => true})
-    assert_equal([
-      { :model => "Model" },
-      { :last_name => "Valim", :ok => true, :first_name => "Jose", :scope => true },
-      { :title => "Comment1" }
-    ], serializer.as_json)
-  end
-
-  def test_array_serializer_with_root
-    comment1 = Comment.new(:title => "Comment1", :id => 1)
-    comment2 = Comment.new(:title => "Comment2", :id => 2)
+        assert_kind_of PostSerializer, serializers.last
+        assert_kind_of Post, serializers.last.object
 
-    array = [ comment1, comment2 ]
-
-    serializer = array.active_model_serializer.new(array, :root => :comments)
-
-    assert_equal({ :comments => [
-      { :title => "Comment1" },
-      { :title => "Comment2" }
-    ]}, serializer.as_json)
-  end
-
-  def test_array_serializer_with_hash
-    hash = {:value => "something"}
-    array = [hash]
-    serializer = array.active_model_serializer.new(array, :root => :items)
-    assert_equal({ :items => [ hash.as_json ]}, serializer.as_json)
-  end
+        assert_equal serializers.last.custom_options[:some], :options
+      end
 
-  def test_array_serializer_with_specified_seriailizer
-    post1 = Post.new(:title => "Post1", :author => "Author1", :id => 1)
-    post2 = Post.new(:title => "Post2", :author => "Author2", :id => 2)
+      def test_serializer_option_not_passed_to_each_serializer
+        serializers = ArraySerializer.new([@post], {serializer: PostSerializer}).to_a
 
-    array = [ post1, post2 ]
+        refute serializers.first.custom_options.key?(:serializer)
+      end
 
-    serializer = array.active_model_serializer.new array, :each_serializer => CustomPostSerializer
+      def test_meta_and_meta_key_attr_readers
+        meta_content = {meta: "the meta", meta_key: "the meta key"}
+        @serializer = ArraySerializer.new([@comment, @post], meta_content)
 
-    assert_equal([
-      { :title => "Post1" },
-      { :title => "Post2" }
-    ], serializer.as_json)
+        assert_equal @serializer.meta, "the meta"
+        assert_equal @serializer.meta_key, "the meta key"
+      end
+    end
   end
 end