active_model_serializers 0.8.3 → 0.9.0.alpha1

data/test/unit/active_model/serializer/has_many_test.rb

@@ -0,0 +1,173 @@
+require 'test_helper'
+
+module ActiveModel
+  class Serializer
+    class HasManyTest < ActiveModel::TestCase
+      def setup
+        @association = PostSerializer._associations[:comments]
+        @old_association = @association.dup
+
+        @post = Post.new({ title: 'Title 1', body: 'Body 1', date: '1/1/2000' })
+        @post_serializer = PostSerializer.new(@post)
+      end
+
+      def teardown
+        PostSerializer._associations[:comments] = @old_association
+      end
+
+      def test_associations_definition
+        assert_equal 1, PostSerializer._associations.length
+        assert_kind_of Association::HasMany, @association
+        assert_equal 'comments', @association.name
+      end
+
+      def test_associations_inheritance
+        inherited_serializer_klass = Class.new(PostSerializer) do
+          has_many :some_associations
+        end
+        another_inherited_serializer_klass = Class.new(PostSerializer)
+
+        assert_equal(PostSerializer._associations.length + 1,
+          inherited_serializer_klass._associations.length)
+        assert_equal(PostSerializer._associations.length,
+          another_inherited_serializer_klass._associations.length)
+      end
+
+      def test_associations_embedding_ids_serialization_using_serializable_hash
+        @association.embed = :ids
+
+        assert_equal({
+          title: 'Title 1', body: 'Body 1', 'comment_ids' => @post.comments.map { |c| c.object_id }
+        }, @post_serializer.serializable_hash)
+      end
+
+      def test_associations_embedding_ids_serialization_using_as_json
+        @association.embed = :ids
+
+        assert_equal({
+          'post' => { title: 'Title 1', body: 'Body 1', 'comment_ids' => @post.comments.map { |c| c.object_id } }
+        }, @post_serializer.as_json)
+      end
+
+      def test_associations_embedding_ids_serialization_using_serializable_hash_and_key_from_options
+        @association.embed = :ids
+        @association.key = 'key'
+
+        assert_equal({
+          title: 'Title 1', body: 'Body 1', 'key' => @post.comments.map { |c| c.object_id }
+        }, @post_serializer.serializable_hash)
+      end
+
+      def test_associations_embedding_objects_serialization_using_serializable_hash
+        @association.embed = :objects
+
+        assert_equal({
+          title: 'Title 1', body: 'Body 1', comments: [{ content: 'C1' }, { content: 'C2' }]
+        }, @post_serializer.serializable_hash)
+      end
+
+      def test_associations_embedding_objects_serialization_using_as_json
+        @association.embed = :objects
+
+        assert_equal({
+          'post' => { title: 'Title 1', body: 'Body 1', comments: [{ content: 'C1' }, { content: 'C2' }] }
+        }, @post_serializer.as_json)
+      end
+
+      def test_associations_embedding_nil_objects_serialization_using_as_json
+        @association.embed = :objects
+        @post.instance_eval do
+          def comments
+            [nil]
+          end
+        end
+
+        assert_equal({
+          'post' => { title: 'Title 1', body: 'Body 1', comments: [nil] }
+        }, @post_serializer.as_json)
+      end
+
+      def test_associations_embedding_objects_serialization_using_serializable_hash_and_root_from_options
+        @association.embed = :objects
+        @association.embedded_key = 'root'
+
+        assert_equal({
+          title: 'Title 1', body: 'Body 1', 'root' => [{ content: 'C1' }, { content: 'C2' }]
+        }, @post_serializer.serializable_hash)
+      end
+
+      def test_associations_embedding_ids_including_objects_serialization_using_serializable_hash
+        @association.embed = :ids
+        @association.embed_in_root = true
+
+        assert_equal({
+          title: 'Title 1', body: 'Body 1', 'comment_ids' => @post.comments.map { |c| c.object_id }
+        }, @post_serializer.serializable_hash)
+      end
+
+      def test_associations_embedding_ids_including_objects_serialization_using_as_json
+        @association.embed = :ids
+        @association.embed_in_root = true
+
+        assert_equal({
+          'post' => { title: 'Title 1', body: 'Body 1', 'comment_ids' => @post.comments.map { |c| c.object_id } },
+          comments: [{ content: 'C1' }, { content: 'C2' }]
+        }, @post_serializer.as_json)
+      end
+
+      def test_associations_embedding_nothing_including_objects_serialization_using_as_json
+        @association.embed = nil
+        @association.embed_in_root = true
+
+        assert_equal({
+          'post' => { title: 'Title 1', body: 'Body 1' },
+          comments: [{ content: 'C1' }, { content: 'C2' }]
+        }, @post_serializer.as_json)
+      end
+
+      def test_associations_using_a_given_serializer
+        @association.embed = :ids
+        @association.embed_in_root = true
+        @association.serializer_class = Class.new(ActiveModel::Serializer) do
+          def content
+            object.read_attribute_for_serialization(:content) + '!'
+          end
+
+          attributes :content
+        end
+
+        assert_equal({
+          'post' => { title: 'Title 1', body: 'Body 1', 'comment_ids' => @post.comments.map { |c| c.object_id } },
+          comments: [{ content: 'C1!' }, { content: 'C2!' }]
+        }, @post_serializer.as_json)
+      end
+
+      def test_associations_embedding_ids_using_a_given_array_serializer
+        @association.embed = :ids
+        @association.embed_in_root = true
+        @association.serializer_class = Class.new(ActiveModel::ArraySerializer) do
+          def serializable_object
+            { my_content: ['fake'] }
+          end
+        end
+
+        assert_equal({
+          'post' => { title: 'Title 1', body: 'Body 1', 'comment_ids' => @post.comments.map { |c| c.object_id } },
+          comments: { my_content: ['fake'] }
+        }, @post_serializer.as_json)
+      end
+
+      def test_associations_embedding_objects_using_a_given_array_serializer
+        @association.serializer_class = Class.new(ActiveModel::ArraySerializer) do
+          def serializable_object
+            { my_content: ['fake'] }
+          end
+        end
+
+        assert_equal({
+          'post' => { title: 'Title 1', body: 'Body 1', comments: { my_content: ['fake'] } }
+        }, @post_serializer.as_json)
+      end
+    end
+  end
+end

data/test/unit/active_model/serializer/has_one_test.rb

@@ -0,0 +1,151 @@
+require 'test_helper'
+
+module ActiveModel
+  class Serializer
+    class HasOneTest < ActiveModel::TestCase
+      def setup
+        @association = UserSerializer._associations[:profile]
+        @old_association = @association.dup
+
+        @user = User.new({ name: 'Name 1', email: 'mail@server.com', gender: 'M' })
+        @user_serializer = UserSerializer.new(@user)
+      end
+
+      def teardown
+        UserSerializer._associations[:profile] = @old_association
+      end
+
+      def test_associations_definition
+        assert_equal 1, UserSerializer._associations.length
+        assert_kind_of Association::HasOne, @association
+        assert_equal 'profile', @association.name
+      end
+
+      def test_associations_embedding_ids_serialization_using_serializable_hash
+        @association.embed = :ids
+
+        assert_equal({
+          name: 'Name 1', email: 'mail@server.com', 'profile_id' => @user.profile.object_id
+        }, @user_serializer.serializable_hash)
+      end
+
+      def test_associations_embedding_ids_serialization_using_as_json
+        @association.embed = :ids
+
+        assert_equal({
+          'user' => { name: 'Name 1', email: 'mail@server.com', 'profile_id' => @user.profile.object_id }
+        }, @user_serializer.as_json)
+      end
+
+      def test_associations_embedding_ids_serialization_using_serializable_hash_and_key_from_options
+        @association.embed = :ids
+        @association.key = 'key'
+
+        assert_equal({
+          name: 'Name 1', email: 'mail@server.com', 'key' => @user.profile.object_id
+        }, @user_serializer.serializable_hash)
+      end
+
+      def test_associations_embedding_objects_serialization_using_serializable_hash
+        @association.embed = :objects
+
+        assert_equal({
+          name: 'Name 1', email: 'mail@server.com', profile: { name: 'N1', description: 'D1' }
+        }, @user_serializer.serializable_hash)
+      end
+
+      def test_associations_embedding_objects_serialization_using_as_json
+        @association.embed = :objects
+
+        assert_equal({
+          'user' => { name: 'Name 1', email: 'mail@server.com', profile: { name: 'N1', description: 'D1' } }
+        }, @user_serializer.as_json)
+      end
+
+      def test_associations_embedding_nil_ids_serialization_using_as_json
+        @association.embed = :ids
+        @user.instance_eval do
+          def profile
+            nil
+          end
+        end
+
+        assert_equal({
+          'user' => { name: 'Name 1', email: 'mail@server.com', 'profile_id' => nil }
+        }, @user_serializer.as_json)
+      end
+
+      def test_associations_embedding_nil_objects_serialization_using_as_json
+        @association.embed = :objects
+        @user.instance_eval do
+          def profile
+            nil
+          end
+        end
+
+        assert_equal({
+          'user' => { name: 'Name 1', email: 'mail@server.com', profile: nil }
+        }, @user_serializer.as_json)
+      end
+
+      def test_associations_embedding_objects_serialization_using_serializable_hash_and_root_from_options
+        @association.embed = :objects
+        @association.embedded_key = 'root'
+
+        assert_equal({
+          name: 'Name 1', email: 'mail@server.com', 'root' => { name: 'N1', description: 'D1' }
+        }, @user_serializer.serializable_hash)
+      end
+
+      def test_associations_embedding_ids_including_objects_serialization_using_serializable_hash
+        @association.embed = :ids
+        @association.embed_in_root = true
+
+        assert_equal({
+          name: 'Name 1', email: 'mail@server.com', 'profile_id' => @user.profile.object_id
+        }, @user_serializer.serializable_hash)
+      end
+
+      def test_associations_embedding_ids_including_objects_serialization_using_as_json
+        @association.embed = :ids
+        @association.embed_in_root = true
+
+        assert_equal({
+          'user' => { name: 'Name 1', email: 'mail@server.com', 'profile_id' => @user.profile.object_id },
+          'profiles' => [{ name: 'N1', description: 'D1' }]
+        }, @user_serializer.as_json)
+      end
+
+      def test_associations_embedding_ids_using_a_given_serializer
+        @association.embed = :ids
+        @association.embed_in_root = true
+        @association.serializer_class = Class.new(ActiveModel::Serializer) do
+          def name
+            'fake'
+          end
+
+          attributes :name
+        end
+
+        assert_equal({
+          'user' => { name: 'Name 1', email: 'mail@server.com', 'profile_id' => @user.profile.object_id },
+          'profiles' => [{ name: 'fake' }]
+        }, @user_serializer.as_json)
+      end
+
+      def test_associations_embedding_objects_using_a_given_serializer
+        @association.serializer_class = Class.new(ActiveModel::Serializer) do
+          def name
+            'fake'
+          end
+
+          attributes :name
+        end
+
+        assert_equal({
+          'user' => { name: 'Name 1', email: 'mail@server.com', profile: { name: 'fake' } }
+        }, @user_serializer.as_json)
+      end
+    end
+  end
+end

data/test/unit/active_model/serializer/meta_test.rb

@@ -0,0 +1,39 @@
+require 'test_helper'
+
+module ActiveModel
+  class Serializer
+    class MetaTest < ActiveModel::TestCase
+      def setup
+        @profile = Profile.new({ name: 'Name 1', description: 'Description 1', comments: 'Comments 1' })
+      end
+
+      def test_meta
+        profile_serializer = ProfileSerializer.new(@profile, root: 'profile', meta: { total: 10 })
+
+        assert_equal({
+          'profile' => {
+            name: 'Name 1',
+            description: 'Description 1'
+          },
+          meta: {
+            total: 10
+          }
+        }, profile_serializer.as_json)
+      end
+
+      def test_meta_using_meta_key
+        profile_serializer = ProfileSerializer.new(@profile, root: 'profile', meta_key: :my_meta, my_meta: { total: 10 })
+
+        assert_equal({
+          'profile' => {
+            name: 'Name 1',
+            description: 'Description 1'
+          },
+          my_meta: {
+            total: 10
+          }
+        }, profile_serializer.as_json)
+      end
+    end
+  end
+end

data/test/unit/active_model/serializer/root_test.rb

@@ -0,0 +1,117 @@
+require 'test_helper'
+
+module ActiveModel
+  class Serializer
+    class RootAsOptionTest < ActiveModel::TestCase
+      def setup
+        @old_root = ProfileSerializer._root
+        @profile = Profile.new({ name: 'Name 1', description: 'Description 1', comments: 'Comments 1' })
+        @serializer = ProfileSerializer.new(@profile, root: :initialize)
+        ProfileSerializer._root = true
+      end
+
+      def teardown
+        ProfileSerializer._root = @old_root
+      end
+
+      def test_root_is_not_displayed_using_serializable_hash
+        assert_equal({
+          name: 'Name 1', description: 'Description 1'
+        }, @serializer.serializable_hash)
+      end
+
+      def test_root_using_as_json
+        assert_equal({
+          initialize: {
+            name: 'Name 1', description: 'Description 1'
+          }
+        }, @serializer.as_json)
+      end
+
+      def test_root_from_serializer_name
+        @serializer = ProfileSerializer.new(@profile)
+
+        assert_equal({
+          'profile' => {
+            name: 'Name 1', description: 'Description 1'
+          }
+        }, @serializer.as_json)
+      end
+
+      def test_root_as_argument_takes_precedence
+        assert_equal({
+          argument: {
+            name: 'Name 1', description: 'Description 1'
+          }
+        }, @serializer.as_json(root: :argument))
+      end
+
+      def test_using_false_root_in_initializer_takes_precedence
+        ProfileSerializer._root = 'root'
+        @serializer = ProfileSerializer.new(@profile, root: false)
+
+        assert_equal({
+          name: 'Name 1', description: 'Description 1'
+        }, @serializer.as_json)
+      end
+
+      def test_root_inheritance
+        ProfileSerializer._root = 'profile'
+
+        inherited_serializer_klass = Class.new(ProfileSerializer)
+        inherited_serializer_klass._root = 'inherited_profile'
+
+        another_inherited_serializer_klass = Class.new(ProfileSerializer)
+
+        assert_equal('inherited_profile',
+                     inherited_serializer_klass._root)
+        assert_equal('profile',
+                     another_inherited_serializer_klass._root)
+      end
+    end
+
+    class RootInSerializerTest < ActiveModel::TestCase
+      def setup
+        @old_root = ProfileSerializer._root
+        ProfileSerializer._root = :in_serializer
+        profile = Profile.new({ name: 'Name 1', description: 'Description 1', comments: 'Comments 1' })
+        @serializer = ProfileSerializer.new(profile)
+        @rooted_serializer = ProfileSerializer.new(profile, root: :initialize)
+      end
+
+      def teardown
+        ProfileSerializer._root = @old_root
+      end
+
+      def test_root_is_not_displayed_using_serializable_hash
+        assert_equal({
+          name: 'Name 1', description: 'Description 1'
+        }, @serializer.serializable_hash)
+      end
+
+      def test_root_using_as_json
+        assert_equal({
+          in_serializer: {
+            name: 'Name 1', description: 'Description 1'
+          }
+        }, @serializer.as_json)
+      end
+
+      def test_root_in_initializer_takes_precedence
+        assert_equal({
+          initialize: {
+            name: 'Name 1', description: 'Description 1'
+          }
+        }, @rooted_serializer.as_json)
+      end
+
+      def test_root_as_argument_takes_precedence
+        assert_equal({
+          argument: {
+            name: 'Name 1', description: 'Description 1'
+          }
+        }, @rooted_serializer.as_json(root: :argument))
+      end
+    end
+  end
+end

data/test/unit/active_model/serializer/scope_test.rb

@@ -0,0 +1,49 @@
+require 'test_helper'
+
+module ActiveModel
+  class Serializer
+    class ScopeTest < ActiveModel::TestCase
+      def setup
+        @serializer = ProfileSerializer.new(nil, scope: current_user)
+      end
+
+      def test_scope
+        assert_equal('user', @serializer.scope)
+      end
+
+      private
+
+      def current_user
+        'user'
+      end
+    end
+
+    class NestedScopeTest < ActiveModel::TestCase
+      def setup
+        @association = UserSerializer._associations[:profile]
+        @old_association = @association.dup
+        @user = User.new({ name: 'Name 1', email: 'mail@server.com', gender: 'M' })
+        @user_serializer = UserSerializer.new(@user, scope: 'user')
+      end
+
+      def teardown
+        UserSerializer._associations[:profile] = @old_association
+      end
+
+      def test_scope_passed_through
+        @association.serializer_class = Class.new(ActiveModel::Serializer) do
+          def name
+            scope
+          end
+
+          attributes :name
+        end
+
+        assert_equal({
+          name: 'Name 1', email: 'mail@server.com', profile: { name: 'user' }
+        }, @user_serializer.serializable_hash)
+      end
+    end
+
+  end
+end