active_model_serializers 0.8.3 → 0.9.0

data/test/unit/active_model/array_serializer/serialization_test.rb

@@ -0,0 +1,199 @@
+require 'test_helper'
+
+module ActiveModel
+  class ArraySerializer
+    class BasicObjectsSerializationTest < Minitest::Test
+      def setup
+        array = [1, 2, 3]
+        @serializer = Serializer.serializer_for(array).new(array)
+      end
+
+      def test_serializer_for_array_returns_appropriate_type
+        assert_kind_of ActiveModel::ArraySerializer, @serializer
+      end
+
+      def test_array_serializer_serializes_simple_objects
+        assert_equal [1, 2, 3], @serializer.serializable_array
+        assert_equal [1, 2, 3], @serializer.as_json
+      end
+    end
+
+    class CustomArraySerializerSupport < Minitest::Test
+      def setup
+        Object.const_set(:ArraySerializer, Class.new)
+
+        array = [1, 2, 3]
+        @serializer_class = Serializer.serializer_for(array)
+      end
+
+      def teardown
+        Object.send(:remove_const, :ArraySerializer)
+      end
+
+      def test_serializer_for_array_returns_appropriate_type
+        assert_equal ::ArraySerializer, @serializer_class
+      end
+    end
+
+    class ModelSerializationTest < Minitest::Test
+      def test_array_serializer_serializes_models
+        array = [Profile.new({ name: 'Name 1', description: 'Description 1', comments: 'Comments 1' }),
+                 Profile.new({ name: 'Name 2', description: 'Description 2', comments: 'Comments 2' })]
+        serializer = ArraySerializer.new(array)
+
+        expected = [{ name: 'Name 1', description: 'Description 1' },
+                    { name: 'Name 2', description: 'Description 2' }]
+
+        assert_equal expected, serializer.serializable_array
+        assert_equal expected, serializer.as_json
+      end
+
+      def test_array_serializers_each_serializer
+        array = [::Model.new({ name: 'Name 1', description: 'Description 1', comments: 'Comments 1' }),
+                 ::Model.new({ name: 'Name 2', description: 'Description 2', comments: 'Comments 2' })]
+        serializer = ArraySerializer.new(array, each_serializer: ProfileSerializer)
+
+        expected = [{ name: 'Name 1', description: 'Description 1' },
+                    { name: 'Name 2', description: 'Description 2' }]
+
+        assert_equal expected, serializer.serializable_array
+        assert_equal expected, serializer.as_json
+      end
+
+      def test_associated_objects_of_multiple_instances_embedded_in_root
+        @association = PostSerializer._associations[:comments]
+        @old_association = @association.dup
+
+        @association.embed = :ids
+        @association.embed_in_root = true
+
+        @post1 = Post.new({ title: 'Title 1', body: 'Body 1', date: '1/1/2000' })
+        @post2 = Post.new({ title: 'Title 2', body: 'Body 2', date: '1/1/2000' })
+
+        class << @post2
+          attr_writer :comments
+        end
+
+        @post2.comments = [
+          Comment.new(content: 'C3'),
+          Comment.new(content: 'C4')
+        ]
+
+        @serializer = ArraySerializer.new([@post1, @post2], root: :posts)
+        assert_equal({
+            posts: [
+              {title: "Title 1", body: "Body 1", "comment_ids" => @post1.comments.map(&:object_id) },
+              {title: "Title 2", body: "Body 2", "comment_ids" => @post2.comments.map(&:object_id) }
+            ],
+            comments: [
+              {content: "C1"},
+              {content: "C2"},
+              {content: "C3"},
+              {content: "C4"}
+            ]
+          }, @serializer.as_json)
+      ensure
+        PostSerializer._associations[:comments] = @old_association
+      end
+
+      def test_embed_object_for_has_one_association_with_nil_value
+        @association = UserSerializer._associations[:profile]
+        @old_association = @association.dup
+
+        @association.embed = :objects
+
+        @user1 = User.new({ name: 'User 1', email: 'email1@server.com' })
+        @user2 = User.new({ name: 'User 2', email: 'email2@server.com' })
+
+        class << @user1
+          def profile
+            nil
+          end
+        end
+
+        class << @user2
+          def profile
+            @profile ||= Profile.new(name: 'Name 1', description: 'Desc 1')
+          end
+        end
+
+        @serializer = ArraySerializer.new([@user1, @user2]) #, root: :posts)
+        assert_equal([
+          { name: "User 1", email: "email1@server.com", profile: nil },
+          { name: "User 2", email: "email2@server.com", profile: { name: 'Name 1', description: 'Desc 1' } }
+        ], @serializer.as_json)
+      ensure
+        UserSerializer._associations[:profile] = @old_association
+      end
+
+      def test_embed_object_in_root_for_has_one_association_with_nil_value
+        @association = UserSerializer._associations[:profile]
+        @old_association = @association.dup
+
+        @association.embed = :ids
+        @association.embed_in_root = true
+
+        @user1 = User.new({ name: 'User 1', email: 'email1@server.com' })
+        @user2 = User.new({ name: 'User 2', email: 'email2@server.com' })
+
+        class << @user1
+          def profile
+            nil
+          end
+        end
+
+        class << @user2
+          def profile
+            @profile ||= Profile.new(name: 'Name 1', description: 'Desc 1')
+          end
+        end
+
+        @serializer = ArraySerializer.new([@user1, @user2], root: :users)
+        assert_equal({
+            users: [
+              { name: "User 1", email: "email1@server.com", 'profile_id' => nil },
+              { name: "User 2", email: "email2@server.com", 'profile_id' => @user2.profile.object_id }
+            ],
+            'profiles' => [
+              { name: 'Name 1', description: 'Desc 1' }
+            ]
+          }, @serializer.as_json)
+      ensure
+        UserSerializer._associations[:profile] = @old_association
+      end
+
+      def test_embed_object_in_root_for_has_one_association_with_all_nil_values
+        @association = UserSerializer._associations[:profile]
+        @old_association = @association.dup
+
+        @association.embed = :ids
+        @association.embed_in_root = true
+
+        @user1 = User.new({ name: 'User 1', email: 'email1@server.com' })
+        @user2 = User.new({ name: 'User 2', email: 'email2@server.com' })
+
+        class << @user1
+          def profile
+            nil
+          end
+        end
+
+        class << @user2
+          def profile
+            nil
+          end
+        end
+
+        @serializer = ArraySerializer.new([@user1, @user2], root: :users)
+        assert_equal({
+            users: [
+              { name: "User 1", email: "email1@server.com", 'profile_id' => nil },
+              { name: "User 2", email: "email2@server.com", 'profile_id' => nil }
+            ]
+          }, @serializer.as_json)
+      ensure
+        UserSerializer._associations[:profile] = @old_association
+      end
+    end
+  end
+end

data/test/unit/active_model/default_serializer_test.rb

@@ -0,0 +1,13 @@
+require 'test_helper'
+
+module ActiveModel
+  class DefaultSerializer
+    class Test < Minitest::Test
+      def test_serialize_objects
+        assert_equal(nil, DefaultSerializer.new(nil).serializable_object)
+        assert_equal(1, DefaultSerializer.new(1).serializable_object)
+        assert_equal('hi', DefaultSerializer.new('hi').serializable_object)
+      end
+    end
+  end
+end

data/test/unit/active_model/serializer/associations/build_serializer_test.rb

@@ -0,0 +1,21 @@
+require 'test_helper'
+
+module ActiveModel
+  class Serializer
+    class Association
+      class BuildSerializerTest < Minitest::Test
+        def setup
+          @association = Association::HasOne.new('post', serializer: PostSerializer)
+          @post = Post.new({ title: 'Title 1', body: 'Body 1', date: '1/1/2000' })
+        end
+
+        def test_build_serializer_for_array_called_twice
+          2.times do
+            serializer = @association.build_serializer(@post)
+            assert_instance_of(PostSerializer, serializer)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+require 'test_helper'
+
+module ActiveModel
+  class Serializer
+    class AssociationsTest < Minitest::Test
+      def test_associations_inheritance
+        inherited_serializer_klass = Class.new(PostSerializer) do
+          has_many :users
+        end
+        another_inherited_serializer_klass = Class.new(PostSerializer)
+
+        assert_equal([:comments, :users],
+                     inherited_serializer_klass._associations.keys)
+        assert_equal([:comments],
+                     another_inherited_serializer_klass._associations.keys)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,41 @@
+require 'test_helper'
+
+module ActiveModel
+  class Serializer
+    class AttributesTest < Minitest::Test
+      def setup
+        @profile = Profile.new({ name: 'Name 1', description: 'Description 1', comments: 'Comments 1' })
+        @profile_serializer = ProfileSerializer.new(@profile)
+      end
+
+      def test_attributes_definition
+        assert_equal([:name, :description],
+                     @profile_serializer.class._attributes)
+      end
+
+      def test_attributes_serialization_using_serializable_hash
+        assert_equal({
+          name: 'Name 1', description: 'Description 1'
+        }, @profile_serializer.serializable_hash)
+      end
+
+      def test_attributes_serialization_using_as_json
+        assert_equal({
+          'profile' => { name: 'Name 1', description: 'Description 1' }
+        }, @profile_serializer.as_json)
+      end
+
+      def test_attributes_inheritance
+        inherited_serializer_klass = Class.new(ProfileSerializer) do
+          attributes :comments
+        end
+        another_inherited_serializer_klass = Class.new(ProfileSerializer)
+
+        assert_equal([:name, :description, :comments],
+                     inherited_serializer_klass._attributes)
+        assert_equal([:name, :description],
+                     another_inherited_serializer_klass._attributes)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,88 @@
+require 'test_helper'
+
+module ActiveModel
+  class Serializer
+    class Config
+      class Test < Minitest::Test
+        def test_config_const_is_an_instance_of_config
+          assert_kind_of Config, CONFIG
+        end
+
+        def test_config_instance
+          config = Config.new
+          config.setting1 = 'value1'
+
+          assert_equal 'value1', config.setting1
+        end
+
+        def test_each_config
+          config = Config.new
+          config.setting1 = 'value1'
+          config.setting2 = 'value2'
+
+          actual = {}
+
+          config.each do |k, v|
+            actual[k] = v
+          end
+
+          assert_equal({ 'setting1' => 'value1', 'setting2' => 'value2' }, actual)
+        end
+      end
+
+      class ConfigTest < Minitest::Test
+        def test_setup
+          Serializer.setup do |config|
+            config.a = 'v1'
+            config.b = 'v2'
+          end
+
+          assert_equal 'v1', CONFIG.a
+          assert_equal 'v2', CONFIG.b
+        ensure
+          CONFIG.clear
+        end
+
+        def test_config_accessors
+          Serializer.setup do |config|
+            config.foo = 'v1'
+            config.bar = 'v2'
+          end
+
+          assert_equal 'v1', CONFIG.foo
+          assert_equal 'v2', CONFIG.bar
+        ensure
+          CONFIG.clear
+        end
+
+        def test_acessor_when_nil
+          assert_nil CONFIG.foo
+          CONFIG.foo = 1
+          assert_equal 1, CONFIG.foo
+          assert_nil CONFIG.bar
+        end
+      end
+
+      class ApplyConfigTest < Minitest::Test
+        def test_apply_config_to_associations
+          CONFIG.embed     = :ids
+          CONFIG.embed_in_root = true
+          CONFIG.key_format = :lower_camel
+
+          association = PostSerializer._associations[:comments]
+          old_association = association.dup
+
+          association.send :initialize, association.name, association.options
+
+          assert association.embed_ids?
+          assert !association.embed_objects?
+          assert association.embed_in_root
+          assert_equal :lower_camel, association.key_format
+        ensure
+          PostSerializer._associations[:comments] = old_association
+          CONFIG.clear
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,69 @@
+require 'test_helper'
+
+module ActiveModel
+  class Serializer
+    class FilterOptionsTest < Minitest::Test
+      def setup
+        @profile = Profile.new({ name: 'Name 1', description: 'Description 1', comments: 'Comments 1' })
+      end
+
+      def test_only_option
+        @profile_serializer = ProfileSerializer.new(@profile, only: :name)
+        assert_equal({
+          'profile' => { name: 'Name 1' }
+        }, @profile_serializer.as_json)
+      end
+
+      def test_except_option
+        @profile_serializer = ProfileSerializer.new(@profile, except: :comments)
+        assert_equal({
+          'profile' => { name: 'Name 1', description: 'Description 1' }
+        }, @profile_serializer.as_json)
+      end
+    end
+
+    class FilterAttributesTest < Minitest::Test
+      def setup
+        @profile = Profile.new({ name: 'Name 1', description: 'Description 1', comments: 'Comments 1' })
+        @profile_serializer = ProfileSerializer.new(@profile)
+        @profile_serializer.instance_eval do
+          def filter(keys)
+            keys - [:description]
+          end
+        end
+      end
+
+      def test_filtered_attributes_serialization
+        assert_equal({
+          'profile' => { name: 'Name 1' }
+        }, @profile_serializer.as_json)
+      end
+    end
+
+    class FilterAssociationsTest < Minitest::Test
+      def setup
+        @association = PostSerializer._associations[:comments]
+        @old_association = @association.dup
+        @association.embed = :ids
+        @association.embed_in_root = true
+        @post = Post.new({ title: 'Title 1', body: 'Body 1', date: '1/1/2000' })
+        @post_serializer = PostSerializer.new(@post)
+        @post_serializer.instance_eval do
+          def filter(keys)
+            keys - [:body, :comments]
+          end
+        end
+      end
+
+      def teardown
+        PostSerializer._associations[:comments] = @old_association
+      end
+
+      def test_filtered_associations_serialization
+        assert_equal({
+          'post' => { title: 'Title 1' }
+        }, @post_serializer.as_json)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,230 @@
+require 'test_helper'
+
+module ActiveModel
+  class Serializer
+    class HasManyTest < Minitest::Test
+      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_from_options = Class.new(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_from_options = Class.new(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_from_options = Class.new(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
+
+      def test_associations_embedding_ids_including_objects_serialization_with_embed_in_root_key
+        @association.embed_in_root = true
+        @association.embed_in_root_key = :linked
+        @association.embed = :ids
+        assert_equal({
+          linked: {
+            comments: [
+              { content: 'C1' },
+              { content: 'C2' }
+            ]
+          },
+          'post' => {
+            title: 'Title 1', body: 'Body 1',
+            'comment_ids' => @post.comments.map(&:object_id)
+          }
+        }, @post_serializer.as_json)
+      end
+
+      def test_associations_embedding_ids_using_embed_namespace_including_object_serialization_with_embed_in_root_key
+        @association.embed_in_root = true
+        @association.embed_in_root_key = :linked
+        @association.embed = :ids
+        @association.embed_namespace = :links
+        @association.key = :comments
+        assert_equal({
+          linked: {
+            comments: [
+              { content: 'C1' },
+              { content: 'C2' }
+            ]
+          },
+          'post' => {
+            title: 'Title 1', body: 'Body 1',
+            links: {
+              comments: @post.comments.map(&:object_id)
+            }
+          }
+        }, @post_serializer.as_json)
+      end
+
+      def test_associations_embedding_objects_using_embed_namespace
+        @association.embed = :objects
+        @association.embed_namespace = :links
+
+        assert_equal({
+          'post' => {
+            title: 'Title 1', body: 'Body 1',
+            links: {
+              comments: [
+                { content: 'C1' },
+                { content: 'C2' }
+              ]
+            }
+          }
+        }, @post_serializer.as_json)
+      end
+    end
+  end
+end