active_model_serializers 0.9.0.alpha1 → 0.9.0

data/lib/active_model/serializer/associations.rb

@@ -1,5 +1,4 @@
 require 'active_model/default_serializer'
-require 'active_model/serializer'
 
 module ActiveModel
   class Serializer
@@ -15,27 +14,40 @@ module ActiveModel
         @options       = options
         self.embed     = options.fetch(:embed) { CONFIG.embed }
         @embed_in_root = options.fetch(:embed_in_root) { options.fetch(:include) { CONFIG.embed_in_root } }
+        @key_format    = options.fetch(:key_format) { CONFIG.key_format }
         @embed_key     = options[:embed_key] || :id
         @key           = options[:key]
         @embedded_key  = options[:root] || name
+        @embed_in_root_key = options.fetch(:embed_in_root_key) { CONFIG.embed_in_root_key }
+        @embed_namespace = options.fetch(:embed_namespace) { CONFIG.embed_namespace }
 
         serializer = @options[:serializer]
-        @serializer_class = serializer.is_a?(String) ? serializer.constantize : serializer
+        @serializer_from_options = serializer.is_a?(String) ? serializer.constantize : serializer
       end
 
       attr_reader :name, :embed_ids, :embed_objects
-      attr_accessor :embed_in_root, :embed_key, :key, :embedded_key, :root_key, :serializer_class, :options
+      attr_accessor :embed_in_root, :embed_key, :key, :embedded_key, :root_key, :serializer_from_options, :options, :key_format, :embed_in_root_key, :embed_namespace
       alias embed_ids? embed_ids
       alias embed_objects? embed_objects
       alias embed_in_root? embed_in_root
+      alias embed_in_root_key? embed_in_root_key
+      alias embed_namespace? embed_namespace
 
       def embed=(embed)
         @embed_ids     = embed == :id || embed == :ids
         @embed_objects = embed == :object || embed == :objects
       end
 
+      def serializer_from_object(object)
+        Serializer.serializer_for(object)
+      end
+
+      def default_serializer
+        DefaultSerializer
+      end
+
       def build_serializer(object, options = {})
-        @serializer_class.new(object, options.merge(@options))
+        serializer_class(object).new(object, options.merge(self.options))
       end
 
       class HasOne < Association
@@ -45,8 +57,11 @@ module ActiveModel
           @key ||= "#{name}_id"
         end
 
+        def serializer_class(object)
+          serializer_from_options || serializer_from_object(object) || default_serializer
+        end
+
         def build_serializer(object, options = {})
-          @serializer_class ||= Serializer.serializer_for(object) || DefaultSerializer
           options[:_wrap_in_array] = embed_in_root?
           super
         end
@@ -59,15 +74,27 @@ module ActiveModel
           @key ||= "#{name.to_s.singularize}_ids"
         end
 
-        def build_serializer(object, options = {})
-          if @serializer_class && !(@serializer_class <= ArraySerializer)
-            @options[:each_serializer] = @serializer_class
-            @serializer_class = ArraySerializer
+        def serializer_class(object)
+          if use_array_serializer?
+            ArraySerializer
           else
-            @serializer_class ||= ArraySerializer
+            serializer_from_options
           end
+        end
 
-          super
+        def options
+          if use_array_serializer?
+            { each_serializer: serializer_from_options }.merge! super
+          else
+            super
+          end
+        end
+
+        private
+
+        def use_array_serializer?
+          !serializer_from_options ||
+            serializer_from_options && !(serializer_from_options <= ArraySerializer)
         end
       end
     end

data/lib/active_model/serializer/generators/serializer/serializer_generator.rb

@@ -26,7 +26,7 @@ module Rails
         if options[:parent]
           options[:parent]
         elsif (ns = Rails::Generators.namespace) && ns.const_defined?(:ApplicationSerializer) ||
-               defined?(::ApplicationSerializer)
+               (Object.const_get(:ApplicationSerializer) rescue nil)
           'ApplicationSerializer'
         else
           'ActiveModel::Serializer'

data/lib/active_model/serializer/version.rb

@@ -1,5 +1,5 @@
 module ActiveModel
   class Serializer
-    VERSION = '0.9.0.alpha1'
+    VERSION = '0.9.0'
   end
 end

data/lib/active_model_serializers.rb

@@ -7,9 +7,13 @@ require 'active_model/serializer/railtie' if defined?(Rails)
 begin
   require 'action_controller'
   require 'action_controller/serialization'
+  require 'action_controller/serialization_test_case'
 
-  ActiveSupport.on_load(:action_controller) do
-    include ::ActionController::Serialization
+  ActiveSupport.on_load(:after_initialize) do
+    if ::ActionController::Serialization.enabled
+      ActionController::Base.send(:include, ::ActionController::Serialization)
+      ActionController::TestCase.send(:include, ::ActionController::SerializationAssertions)
+    end
   end
 rescue LoadError
   # rails not installed, continuing

data/test/fixtures/poro.rb

@@ -35,6 +35,9 @@ end
 class Comment < Model
 end
 
+class WebLog < Model
+end
+
 ###
 ## Serializers
 ###
@@ -62,3 +65,11 @@ end
 class CommentSerializer < ActiveModel::Serializer
   attributes :content
 end
+
+class WebLogSerializer < ActiveModel::Serializer
+  attributes :name, :display_name
+end
+
+class WebLogLowerCamelSerializer < WebLogSerializer
+  format_keys :lower_camel
+end

data/test/integration/action_controller/serialization_test.rb

@@ -194,6 +194,59 @@ module ActionController
       end
     end
 
+    class LowerCamelArraySerializerTest < ActionController::TestCase
+      class WebLogController < ActionController::Base
+        def render_array
+          render json: [WebLog.new({name: 'Name 1', display_name: 'Display Name 1'}), WebLog.new({name: 'Name 2', display_name: 'Display Name 2'})], each_serializer: WebLogLowerCamelSerializer
+        end
+      end
+
+      tests WebLogController
+
+      def test_render_array
+        get :render_array
+        assert_equal 'application/json', @response.content_type
+        assert_equal '{"webLog":[{"name":"Name 1","displayName":"Display Name 1"},{"name":"Name 2","displayName":"Display Name 2"}]}', @response.body
+      end
+    end
+
+    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, 
+                 serializer: WebLogLowerCamelSerializer
+        end
+      end
+
+      tests WebLogController
+
+      def test_render_without_root
+        get :render_without_root
+        assert_equal 'application/json', @response.content_type
+        assert_equal '{"name":"Name 1","displayName":"Display Name 1"}', @response.body
+      end
+    end
+
+    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, 
+                 each_serializer: WebLogLowerCamelSerializer
+        end
+      end
+
+      tests WebLogController
+
+      def test_render_array_without_root
+        get :render_array_without_root
+        assert_equal 'application/json', @response.content_type
+        assert_equal '[{"name":"Name 1","displayName":"Display Name 1"},{"name":"Name 2","displayName":"Display Name 2"}]', @response.body
+      end
+    end
+
     class ArrayEmbedingSerializerTest < ActionController::TestCase
       def setup
         super

data/test/integration/action_controller/serialization_test_case_test.rb

@@ -0,0 +1,61 @@
+require 'test_helper'
+
+module ActionController
+  module SerializationsAssertions
+    class RenderSerializerTest < ActionController::TestCase
+      class MyController < ActionController::Base
+        def render_using_serializer
+          render json: Profile.new({ name: 'Name 1', description: 'Description 1', comments: 'Comments 1' })
+        end
+
+        def render_text
+          render text: 'ok'
+        end
+      end
+
+      tests MyController
+
+      def test_supports_specifying_serializers_with_a_serializer_class
+        get :render_using_serializer
+        assert_serializer ProfileSerializer
+      end
+
+      def test_supports_specifying_serializers_with_a_regexp
+        get :render_using_serializer
+        assert_serializer %r{\AProfile.+\Z}
+      end
+
+      def test_supports_specifying_serializers_with_a_string
+        get :render_using_serializer
+        assert_serializer 'ProfileSerializer'
+      end
+
+      def test_supports_specifying_serializers_with_a_symbol
+        get :render_using_serializer
+        assert_serializer :profile_serializer
+      end
+
+      def test_supports_specifying_serializers_with_a_nil
+        get :render_text
+        assert_serializer nil
+      end
+
+      def test_raises_descriptive_error_message_when_serializer_was_not_rendered
+        get :render_using_serializer
+        e = assert_raise ActiveSupport::TestCase::Assertion do
+          assert_serializer 'PostSerializer'
+        end
+        assert_match 'expecting <"PostSerializer"> but rendering with <["ProfileSerializer"]>', e.message
+      end
+
+
+      def test_raises_argument_error_when_asserting_with_invalid_object
+        get :render_using_serializer
+        e = assert_raise ArgumentError do
+          assert_serializer Hash
+        end
+        assert_match 'assert_serializer only accepts a String, Symbol, Regexp, ActiveModel::Serializer, or nil', e.message
+      end
+    end
+  end
+end

data/test/integration/active_record/active_record_test.rb

@@ -3,7 +3,7 @@ require 'fixtures/active_record'
 
 module ActiveModel
   class Serializer
-    class ActiveRecordTest < ActiveModel::TestCase
+    class ActiveRecordTest < Minitest::Test
       def setup
         @post = ARPost.first
       end

data/test/integration/generators/scaffold_controller_generator_test.rb

@@ -16,7 +16,6 @@ class ScaffoldControllerGeneratorTest < Rails::Generators::TestCase
     run_generator
 
     assert_file 'app/controllers/accounts_controller.rb' do |content|
-      
       assert_instance_method :index, content do |m|
         assert_match /@accounts = Account\.all/, m
         assert_match /format.html/, m
@@ -60,8 +59,6 @@ class ScaffoldControllerGeneratorTest < Rails::Generators::TestCase
 
       assert_match(/def account_params/, content)
       assert_match(/params\.require\(:account\)\.permit\(:name, :description, :business_id\)/, content)
-
     end
-
   end
 end

data/test/test_helper.rb

@@ -1,9 +1,11 @@
 require 'bundler/setup'
-require 'coverage_setup'
 require 'minitest/autorun'
 require 'active_model_serializers'
 require 'fixtures/poro'
 
+# Ensure backward compatibility with Minitest 4
+Minitest::Test = MiniTest::Unit::TestCase unless defined?(Minitest::Test)
+
 module TestHelper
   Routes = ActionDispatch::Routing::RouteSet.new
   Routes.draw do
@@ -12,6 +14,7 @@ module TestHelper
   end
 
   ActionController::Base.send :include, Routes.url_helpers
+  ActionController::Base.send :include, ActionController::Serialization
 end
 
 ActionController::TestCase.class_eval do

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

@@ -0,0 +1,18 @@
+require 'test_helper'
+
+module ActiveModel
+  class ArraySerializer
+    class ExceptTest < Minitest::Test
+      def test_array_serializer_pass_except_to_items_serializers
+        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, except: [:description])
+
+        expected = [{ name: 'Name 1' },
+                    { name: 'Name 2' }]
+
+        assert_equal expected, serializer.serializable_array
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+require 'test_helper'
+
+module ActiveModel
+  class ArraySerializer
+    class KeyFormatTest < Minitest::Test
+      def test_array_serializer_pass_options_to_items_serializers
+        array = [WebLog.new({ name: 'Name 1', display_name: 'Display Name 1'}),
+                 WebLog.new({ name: 'Name 2', display_name: 'Display Name 2'})]
+        serializer = ArraySerializer.new(array, key_format: :lower_camel)
+
+        expected = [{ name: 'Name 1', displayName: 'Display Name 1' },
+                    { name: 'Name 2', displayName: 'Display Name 2' }]
+
+        assert_equal expected, serializer.serializable_array
+      end
+    end
+  end
+end

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

@@ -3,7 +3,7 @@ require 'active_model/serializer'
 
 module ActiveModel
   class ArraySerializer
-    class MetaTest < ActiveModel::TestCase
+    class MetaTest < Minitest::Test
       def setup
         @profile1 = Profile.new({ name: 'Name 1', description: 'Description 1', comments: 'Comments 1' })
         @profile2 = Profile.new({ name: 'Name 2', description: 'Description 2', comments: 'Comments 2' })

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

@@ -0,0 +1,18 @@
+require 'test_helper'
+
+module ActiveModel
+  class ArraySerializer
+    class OnlyTest < Minitest::Test
+      def test_array_serializer_pass_only_to_items_serializers
+        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])
+
+        expected = [{ name: 'Name 1' },
+                    { name: 'Name 2' }]
+
+        assert_equal expected, serializer.serializable_array
+      end
+    end
+  end
+end

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

@@ -2,7 +2,7 @@ require 'test_helper'
 
 module ActiveModel
   class ArraySerializer
-    class RootAsOptionTest < ActiveModel::TestCase
+    class RootAsOptionTest < Minitest::Test
       def setup
         @old_root = ArraySerializer._root
         @profile1 = Profile.new({ name: 'Name 1', description: 'Description 1', comments: 'Comments 1' })
@@ -50,7 +50,7 @@ module ActiveModel
       end
     end
 
-    class RootInSerializerTest < ActiveModel::TestCase
+    class RootInSerializerTest < Minitest::Test
       def setup
         @old_root = ArraySerializer._root
         ArraySerializer._root = :in_serializer

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

@@ -2,7 +2,7 @@ require 'test_helper'
 
 module ActiveModel
   class ArraySerializer
-    class ScopeTest < ActiveModel::TestCase
+    class ScopeTest < Minitest::Test
       def test_array_serializer_pass_options_to_items_serializers
         array = [Profile.new({ name: 'Name 1', description: 'Description 1', comments: 'Comments 1' }),
                  Profile.new({ name: 'Name 2', description: 'Description 2', comments: 'Comments 2' })]

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

@@ -2,14 +2,14 @@ require 'test_helper'
 
 module ActiveModel
   class ArraySerializer
-    class BasicObjectsSerializationTest < ActiveModel::TestCase
+    class BasicObjectsSerializationTest < Minitest::Test
       def setup
         array = [1, 2, 3]
-        @serializer = ActiveModel::Serializer.serializer_for(array).new(array)
+        @serializer = Serializer.serializer_for(array).new(array)
       end
 
       def test_serializer_for_array_returns_appropriate_type
-        assert_kind_of ArraySerializer, @serializer
+        assert_kind_of ActiveModel::ArraySerializer, @serializer
       end
 
       def test_array_serializer_serializes_simple_objects
@@ -18,7 +18,24 @@ module ActiveModel
       end
     end
 
-    class ModelSerializationTest < ActiveModel::TestCase
+    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' })]
@@ -78,6 +95,105 @@ module ActiveModel
       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