active_model_serializers 0.8.3 → 0.9.1

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

@@ -0,0 +1,239 @@
+require 'test_helper'
+
+module ActiveModel
+  class Serializer
+    class HasOneTest < Minitest::Test
+      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_nil_ids_including_objects_serialization_using_as_json
+        @association.embed = :ids
+        @association.embed_in_root = true
+        @user.instance_eval do
+          def profile
+            nil
+          end
+        end
+
+        assert_equal({
+          'user' => { name: 'Name 1', email: 'mail@server.com', 'profile_id' => nil },
+          'profiles' => []
+        }, @user_serializer.as_json)
+      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_including_objects_serialization_when_invoked_from_parent_serializer
+        @association.embed = :ids
+        @association.embed_in_root = true
+
+        user_info = UserInfo.new
+        user_info.instance_variable_set(:@user, @user)
+        user_info_serializer = UserInfoSerializer.new(user_info)
+
+        assert_equal({
+          'user_info' => { user: { name: 'Name 1', email: 'mail@server.com', 'profile_id' => @user.profile.object_id } },
+          'profiles' => [{ name: 'N1', description: 'D1' }]
+        }, user_info_serializer.as_json)
+      end
+
+      def test_associations_embedding_ids_using_a_given_serializer
+        @association.embed = :ids
+        @association.embed_in_root = true
+        @association.serializer_from_options = Class.new(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_from_options = Class.new(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
+
+      def test_associations_embedding_ids_using_embed_namespace
+        @association.embed_namespace = :links
+        @association.embed = :ids
+        @association.key = :profile
+        assert_equal({
+          'user' => {
+            name: 'Name 1', email: 'mail@server.com',
+            links: {
+              profile: @user.profile.object_id
+            }
+          }
+        }, @user_serializer.as_json)
+      end
+
+      def test_asociations_embedding_objects_using_embed_namespace
+        @association.embed_namespace = :links
+        @association.embed = :objects
+        assert_equal({
+          'user' => {
+            name: 'Name 1', email: 'mail@server.com',
+            links: {
+              profile: { name: 'N1', description: 'D1' }
+            }
+          }
+        }, @user_serializer.as_json)
+      end
+
+      def test_associations_embedding_ids_using_embed_namespace_and_embed_in_root_key
+        @association.embed_in_root = true
+        @association.embed_in_root_key = :linked
+        @association.embed = :ids
+        assert_equal({
+          'user' => {
+            name: 'Name 1', email: 'mail@server.com', 'profile_id' => @user.profile.object_id
+          },
+          linked: {
+            'profiles' => [ { name: 'N1', description: 'D1' } ]
+          }
+        }, @user_serializer.as_json)
+      end
+
+      def test_associations_name_key_embedding_ids_serialization_using_serializable_hash
+        @association = NameKeyUserSerializer._associations[:profile]
+        @association.embed = :ids
+
+        assert_equal({
+          name: 'Name 1', email: 'mail@server.com', 'profile' => @user.profile.object_id
+        }, NameKeyUserSerializer.new(@user).serializable_hash)
+      end
+
+      def test_associations_name_key_embedding_ids_serialization_using_as_json
+        @association = NameKeyUserSerializer._associations[:profile]
+        @association.embed = :ids
+
+        assert_equal({
+          'name_key_user' => { name: 'Name 1', email: 'mail@server.com', 'profile' => @user.profile.object_id }
+        }, NameKeyUserSerializer.new(@user).as_json)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+require 'test_helper'
+
+module ActiveModel
+  class Serializer
+    class KeyFormatTest < Minitest::Test
+      def test_lower_camel_format_option
+        object     = WebLog.new({ name: 'Name 1', display_name: 'Display Name 1'})
+        serializer = WebLogSerializer.new(object, key_format: :lower_camel)
+
+        expected = { name: 'Name 1', displayName: 'Display Name 1' }
+
+        assert_equal expected, serializer.serializable_object
+      end
+
+      def test_lower_camel_format_serializer
+        object     = WebLog.new({ name: 'Name 1', display_name: 'Display Name 1'})
+        serializer = WebLogLowerCamelSerializer.new(object)
+
+        expected = { name: 'Name 1', displayName: 'Display Name 1' }
+
+        assert_equal expected, serializer.serializable_object
+      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 < Minitest::Test
+      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/options_test.rb

@@ -0,0 +1,34 @@
+require 'test_helper'
+
+module ActiveModel
+  class Serializer
+    class OptionsTest < Minitest::Test
+      def setup
+        @serializer = ProfileSerializer.new(nil, context: {foo: :bar})
+      end
+
+      def test_custom_options_are_accessible_from_serializer
+        assert_equal({foo: :bar}, @serializer.context)
+      end
+    end
+
+    class SerializationOptionsTest < 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 description
+            serialization_options[:force_the_description]
+          end
+        end
+      end
+
+      def test_filtered_attributes_serialization
+        forced_description = "This is a test"
+        assert_equal({
+          'profile' => { name: 'Name 1', description: forced_description }
+        }, @profile_serializer.as_json(force_the_description: forced_description))
+      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 < Minitest::Test
+      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 < Minitest::Test
+      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 < Minitest::Test
+      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 < Minitest::Test
+      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_from_options = Class.new(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

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

@@ -0,0 +1,35 @@
+require 'test_helper'
+
+module ActiveModel
+  class Serializer
+    class UrlHelpersTest < Minitest::Test
+      include Rails.application.routes.url_helpers
+
+      def setup
+        Object.const_set 'UserController', Class.new(ActionController::Base) do
+          def show
+            render text: 'profile'
+          end
+        end
+
+        Rails.application.routes.draw do
+          get '/profile/:id', as: :profile, controller: :user, action: :show
+        end
+      end
+
+      def test_url_helpers_are_available
+        serializer = Class.new(ActiveModel::Serializer) do
+          attributes :url
+
+          def url
+            profile_url(id: object.object_id)
+          end
+        end
+        profile = Profile.new
+
+        assert_equal({ url: profile_url(id: profile.object_id) },
+                     serializer.new(profile).as_json)
+      end
+    end
+  end
+end