active_model_serializers 0.9.0 → 0.9.8

data/test/fixtures/template.html.erb

@@ -0,0 +1 @@
+<p>Hello.</p>

data/test/integration/action_controller/namespaced_serialization_test.rb

@@ -0,0 +1,105 @@
+require 'test_helper'
+
+module ActionController
+  module Serialization
+    class NamespacedSerializationTest < ActionController::TestCase
+      class TestNamespace::MyController < ActionController::Base
+        def render_profile_with_namespace
+          render json: Profile.new({ name: 'Name 1', description: 'Description 1'})
+        end
+
+        def render_profiles_with_namespace
+          render json: [Profile.new({ name: 'Name 1', description: 'Description 1'})]
+        end
+
+        def render_comment
+          render json: Comment.new(content: 'Comment 1')
+        end
+
+        def render_comments
+          render json: [Comment.new(content: 'Comment 1')]
+        end
+
+        def render_hash
+          render json: {message: 'not found'}, status: 404
+        end
+      end
+
+      tests TestNamespace::MyController
+
+      def test_render_profile_with_namespace
+        get :render_profile_with_namespace
+        assert_serializer TestNamespace::ProfileSerializer
+      end
+
+      def test_render_profiles_with_namespace
+        get :render_profiles_with_namespace
+        assert_serializer TestNamespace::ProfileSerializer
+      end
+
+      def test_fallback_to_a_version_without_namespace
+        get :render_comment
+        assert_serializer CommentSerializer
+      end
+
+      def test_array_fallback_to_a_version_without_namespace
+        get :render_comments
+        assert_serializer CommentSerializer
+      end
+
+      def test_render_hash_regression
+        get :render_hash
+        assert_equal JSON.parse(response.body), {'message' => 'not found'}
+      end
+    end
+
+    class OptionNamespacedSerializationTest < ActionController::TestCase
+      class MyController < ActionController::Base
+        def default_serializer_options
+          {
+            namespace: TestNamespace
+          }
+        end
+
+        def render_profile_with_namespace_option
+          render json: Profile.new({ name: 'Name 1', description: 'Description 1'})
+        end
+
+        def render_profiles_with_namespace_option
+          render json: [Profile.new({ name: 'Name 1', description: 'Description 1'})]
+        end
+
+        def render_comment
+          render json: Comment.new(content: 'Comment 1')
+        end
+
+        def render_comments
+          render json: [Comment.new(content: 'Comment 1')]
+        end
+      end
+
+      tests MyController
+
+      def test_render_profile_with_namespace_option
+        get :render_profile_with_namespace_option
+        assert_serializer TestNamespace::ProfileSerializer
+      end
+
+      def test_render_profiles_with_namespace_option
+        get :render_profiles_with_namespace_option
+        assert_serializer TestNamespace::ProfileSerializer
+      end
+
+      def test_fallback_to_a_version_without_namespace
+        get :render_comment
+        assert_serializer CommentSerializer
+      end
+
+      def test_array_fallback_to_a_version_without_namespace
+        get :render_comments
+        assert_serializer CommentSerializer
+      end
+    end
+
+  end
+end

data/test/integration/action_controller/serialization_test.rb

@@ -213,8 +213,8 @@ module ActionController
     class LowerCamelWoRootSerializerTest < ActionController::TestCase
       class WebLogController < ActionController::Base
         def render_without_root
-          render json: WebLog.new({name: 'Name 1', display_name: 'Display Name 1'}), 
-                 root: false, 
+          render json: WebLog.new({name: 'Name 1', display_name: 'Display Name 1'}),
+                 root: false,
                  serializer: WebLogLowerCamelSerializer
         end
       end
@@ -231,9 +231,9 @@ module ActionController
     class LowerCamelArrayWoRootSerializerTest < ActionController::TestCase
       class WebLogController < ActionController::Base
         def render_array_without_root
-          render json: [WebLog.new({name: 'Name 1', display_name: 'Display Name 1'}), 
-                        WebLog.new({name: 'Name 2', display_name: 'Display Name 2'})], 
-                 root: false, 
+          render json: [WebLog.new({name: 'Name 1', display_name: 'Display Name 1'}),
+                        WebLog.new({name: 'Name 2', display_name: 'Display Name 2'})],
+                 root: false,
                  each_serializer: WebLogLowerCamelSerializer
         end
       end

data/test/integration/action_controller/serialization_test_case_test.rb

@@ -11,6 +11,11 @@ module ActionController
         def render_text
           render text: 'ok'
         end
+
+        def render_template
+          prepend_view_path "./test/fixtures"
+          render template: "template"
+        end
       end
 
       tests MyController
@@ -56,6 +61,11 @@ module ActionController
         end
         assert_match 'assert_serializer only accepts a String, Symbol, Regexp, ActiveModel::Serializer, or nil', e.message
       end
+
+      def test_does_not_overwrite_notification_subscriptions
+        get :render_template
+        assert_template "template"
+      end
     end
   end
 end

data/test/integration/active_record/active_record_test.rb

@@ -49,15 +49,31 @@ module ActiveModel
                 'ar_tag_ids' => [1, 2],
                 'ar_section_id' => 1
               },
-              ar_comments: [{ body: 'what a dumb post', 'ar_tag_ids' => [3, 2] },
+              'ar_comments' => [{ body: 'what a dumb post', 'ar_tag_ids' => [3, 2] },
                             { body: 'i liked it', 'ar_tag_ids' => [3, 1] }],
-              ar_tags: [{ name: 'happy' }, { name: 'whiny' }, { name: 'short' }],
+              'ar_tags' => [{ name: 'happy' }, { name: 'whiny' }, { name: 'short' }],
               'ar_sections' => [{ 'name' => 'ruby' }]
             }, post_serializer.as_json)
           end
         end
       end
 
+      def test_serialization_embedding_ids_in_common_root_key
+        post_serializer = AREmbeddedSerializer.new(@post)
+
+        embed(AREmbeddedSerializer, embed: :ids, embed_in_root: true, embed_in_root_key: :linked) do
+          embed(ARCommentSerializer, embed: :ids, embed_in_root: true, embed_in_root_key: :linked) do
+            assert_equal({
+              'ar_tags' => [{ name: 'short' },
+                            { name: 'whiny' },
+                            { name: 'happy' }],
+              'ar_comments' => [{ body: 'what a dumb post', 'ar_tag_ids' => [3, 2] },
+                                { body: 'i liked it', 'ar_tag_ids' => [3, 1] }]
+            }, post_serializer.as_json[:linked])
+          end
+        end
+      end
+
       private
 
       def embed(serializer_class, options = {})
@@ -66,6 +82,7 @@ module ActiveModel
         serializer_class._associations.each_value do |association|
           association.embed = options[:embed]
           association.embed_in_root = options[:embed_in_root]
+          association.embed_in_root_key = options[:embed_in_root_key]
         end
 
         yield

data/test/test_app.rb

@@ -3,6 +3,9 @@ class TestApp < Rails::Application
     config.eager_load = false
     config.secret_key_base = 'abc123'
   end
+  config.after_initialize do
+    Rails.application.routes.default_url_options = { host: 'http://example.com' }
+  end
 
   # Set up a logger to avoid creating a log directory on every run.
   config.logger = Logger.new(nil)

data/test/tmp/app/assets/javascripts/accounts.js

@@ -0,0 +1,2 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.

data/test/tmp/app/assets/stylesheets/accounts.css

@@ -0,0 +1,4 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/

data/test/tmp/app/controllers/accounts_controller.rb

@@ -0,0 +1,2 @@
+class AccountsController < ApplicationController
+end

data/test/tmp/app/helpers/accounts_helper.rb

@@ -0,0 +1,2 @@
+module AccountsHelper
+end

data/test/tmp/app/serializers/account_serializer.rb

@@ -0,0 +1,3 @@
+class AccountSerializer < ActiveModel::Serializer
+  attributes :id
+end

data/test/tmp/config/routes.rb

@@ -0,0 +1 @@
+Rails.application.routes.draw { }

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

@@ -0,0 +1,16 @@
+require 'test_helper'
+
+module ActiveModel
+  class ArraySerializer
+    class OptionsTest < Minitest::Test
+      def test_custom_options_are_accessible_from_serializer
+
+        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, only: [:name], context: {foo: :bar})
+
+        assert_equal({foo: :bar}, serializer.context)
+      end
+    end
+  end
+end

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

@@ -35,6 +35,23 @@ module ActiveModel
       end
     end
 
+    class CustomSerializerClassTest < Minitest::Test
+      def setup
+        Object.const_set(:CustomSerializer, Class.new)
+      end
+
+      def teardown
+        Object.send(:remove_const, :CustomSerializer)
+      end
+
+      def test_serializer_for_array_returns_appropriate_type
+        object = {}
+        def object.serializer_class; CustomSerializer; end
+
+        assert_equal CustomSerializer, Serializer.serializer_for(object)
+      end
+    end
+
     class ModelSerializationTest < Minitest::Test
       def test_array_serializer_serializes_models
         array = [Profile.new({ name: 'Name 1', description: 'Description 1', comments: 'Comments 1' }),
@@ -85,7 +102,7 @@ module ActiveModel
               {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: [
+            'comments' => [
               {content: "C1"},
               {content: "C2"},
               {content: "C3"},

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

@@ -7,6 +7,7 @@ module ActiveModel
         def setup
           @association = Association::HasOne.new('post', serializer: PostSerializer)
           @post = Post.new({ title: 'Title 1', body: 'Body 1', date: '1/1/2000' })
+          @user = User.new
         end
 
         def test_build_serializer_for_array_called_twice
@@ -15,6 +16,20 @@ module ActiveModel
             assert_instance_of(PostSerializer, serializer)
           end
         end
+
+        def test_build_serializer_from_in_a_namespace
+          assoc      = Association::HasOne.new('profile')
+          serializer = TestNamespace::UserSerializer.new(@user).build_serializer(assoc)
+
+          assert_instance_of(TestNamespace::ProfileSerializer, serializer)
+        end
+
+        def test_build_serializer_with_prefix
+          assoc      = Association::HasOne.new('profile', prefix: :short)
+          serializer = UserSerializer.new(@user).build_serializer(assoc)
+
+          assert_instance_of(ShortProfileSerializer, serializer)
+        end
       end
     end
   end

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

@@ -14,6 +14,36 @@ module ActiveModel
         assert_equal([:comments],
                      another_inherited_serializer_klass._associations.keys)
       end
+      def test_multiple_nested_associations
+        parent = SelfReferencingUserParent.new(name: "The Parent")
+        child = SelfReferencingUser.new(name: "The child", parent: parent)
+        self_referencing_user_serializer = SelfReferencingUserSerializer.new(child)
+        result = self_referencing_user_serializer.as_json
+        expected_result = {
+          "self_referencing_user"=>{
+            :name=>"The child",
+            "type_id"=>child.type.object_id,
+            "parent_id"=>child.parent.object_id
+
+          },
+          "types"=>[
+            {
+              :name=>"N1",
+            },
+            {
+              :name=>"N2",
+            }
+          ],
+          "parents"=>[
+            {
+              :name=>"N1",
+              "type_id"=>child.parent.type.object_id,
+              "parent_id"=>nil
+            }
+          ]
+        }
+        assert_equal(expected_result, result)
+      end
     end
   end
 end

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

@@ -36,6 +36,22 @@ module ActiveModel
         assert_equal([:name, :description],
                      another_inherited_serializer_klass._attributes)
       end
+
+      def tests_query_attributes_strip_question_mark
+        model = Class.new(::Model) do
+          def strip?
+            true
+          end
+        end
+
+        serializer = Class.new(ActiveModel::Serializer) do
+          attributes :strip?
+        end
+
+        actual = serializer.new(model.new).as_json
+
+        assert_equal({ strip: true }, actual)
+      end
     end
   end
 end

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

@@ -78,6 +78,9 @@ module ActiveModel
           assert !association.embed_objects?
           assert association.embed_in_root
           assert_equal :lower_camel, association.key_format
+          assert_equal 'post', PostSerializer.root_name
+          CONFIG.plural_default_root = true
+          assert_equal 'posts', PostSerializer.root_name
         ensure
           PostSerializer._associations[:comments] = old_association
           CONFIG.clear

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

@@ -0,0 +1,189 @@
+require 'test_helper'
+
+module ActiveModel
+  class Serializer
+    class HasManyPolymorphicTest < ActiveModel::TestCase
+      def setup
+        @association = MailSerializer._associations[:attachments]
+        @old_association = @association.dup
+
+        @mail = Mail.new({ body: 'Body 1' })
+        @mail_serializer = MailSerializer.new(@mail)
+      end
+
+      def teardown
+        MailSerializer._associations[:attachments] = @old_association
+      end
+
+      def model_name(object)
+        object.class.to_s.demodulize.underscore.to_sym
+      end
+
+      def test_associations_definition
+        assert_equal 1, MailSerializer._associations.length
+        assert_kind_of Association::HasMany, @association
+        assert_equal true, @association.polymorphic
+        assert_equal 'attachments', @association.name
+      end
+
+      def test_associations_embedding_ids_serialization_using_serializable_hash
+        @association.embed = :ids
+
+        assert_equal({
+          body: 'Body 1',
+          'attachment_ids' => @mail.attachments.map do |c|
+            { id: c.object_id, type: model_name(c) }
+          end
+        }, @mail_serializer.serializable_hash)
+      end
+
+      def test_associations_embedding_ids_serialization_using_as_json
+        @association.embed = :ids
+
+        assert_equal({
+          'mail' => {
+            :body => 'Body 1',
+            'attachment_ids' => @mail.attachments.map do |c|
+              { id: c.object_id, type: model_name(c) }
+            end
+          }
+        }, @mail_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({
+          body: 'Body 1',
+          'key' => @mail.attachments.map do |c|
+            { id: c.object_id, type: model_name(c) }
+          end
+        }, @mail_serializer.serializable_hash)
+      end
+
+      def test_associations_embedding_objects_serialization_using_serializable_hash
+        @association.embed = :objects
+
+        assert_equal({
+          body: 'Body 1',
+          :attachments => [
+            { type: :image, image: { url: 'U1' }},
+            { type: :video, video: { html: 'H1' }}
+          ]
+        }, @mail_serializer.serializable_hash)
+      end
+
+      def test_associations_embedding_objects_serialization_using_as_json
+        @association.embed = :objects
+
+        assert_equal({
+          'mail' => {
+            body: 'Body 1',
+            attachments: [
+              { type: :image, image: { url: 'U1' }},
+              { type: :video, video: { html: 'H1' }}
+            ]
+          }
+        }, @mail_serializer.as_json)
+      end
+
+      def test_associations_embedding_nil_objects_serialization_using_as_json
+        @association.embed = :objects
+        @mail.instance_eval do
+          def attachments
+            [nil]
+          end
+        end
+
+        assert_equal({
+          'mail' => {
+            :body => 'Body 1',
+            :attachments => [nil]
+          }
+        }, @mail_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({
+          body: 'Body 1',
+          'root' => [
+            { type: :image, image: { url: 'U1' }},
+            { type: :video, video: { html: 'H1' }}
+          ]
+        }, @mail_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({
+          body: 'Body 1',
+          'attachment_ids' => @mail.attachments.map do |c|
+            { id: c.object_id, type: model_name(c) }
+          end
+        }, @mail_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({
+          'mail' => {
+            body: 'Body 1',
+            'attachment_ids' => @mail.attachments.map do |c|
+              { id: c.object_id, type: model_name(c) }
+            end,
+          },
+          'attachments' => [
+            { type: :image, image: { url: 'U1' }},
+            { type: :video, video: { html: 'H1' }}
+          ]
+        }, @mail_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({
+          'mail' => { body: 'Body 1' },
+          'attachments' => [
+            { type: :image, image: { url: 'U1' }},
+            { type: :video, video: { html: 'H1' }}
+          ]
+        }, @mail_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(ActiveModel::Serializer) do
+          def fake
+            'fake'
+          end
+
+          attributes :fake
+        end
+
+        assert_equal({
+          'mail' => {
+            body: 'Body 1',
+            'attachment_ids' => @mail.attachments.map do |c|
+              { id: c.object_id, type: model_name(c) }
+            end
+          },
+          'attachments' => [
+            { type: :image, image: { fake: 'fake' }},
+            { type: :video, video: { fake: 'fake' }}
+          ]
+        }, @mail_serializer.as_json)
+      end
+    end
+  end
+end