active_model_serializers 0.10.0.rc5 → 0.10.0

data/test/adapter/json_api/transform_test.rb

@@ -67,8 +67,8 @@ module ActiveModelSerializers
         def test_success_document_transform_default
           mock_request
           serializer = PostSerializer.new(@post)
-          adapter = ActiveModelSerializers::Adapter::JsonApi.new(serializer)
-          result = adapter.serializable_hash(@options)
+          adapter = ActiveModelSerializers::Adapter::JsonApi.new(serializer, @options)
+          result = adapter.serializable_hash
           assert_equal({
             data: {
               id: '1337',
@@ -102,8 +102,8 @@ module ActiveModelSerializers
           mock_request
           result = with_config(key_transform: :camel_lower) do
             serializer = PostSerializer.new(@post)
-            adapter = ActiveModelSerializers::Adapter::JsonApi.new(serializer)
-            adapter.serializable_hash(@options)
+            adapter = ActiveModelSerializers::Adapter::JsonApi.new(serializer, @options)
+            adapter.serializable_hash
           end
           assert_equal({
             data: {
@@ -138,8 +138,8 @@ module ActiveModelSerializers
           mock_request(:camel)
           result = with_config(key_transform: :camel_lower) do
             serializer = PostSerializer.new(@post)
-            adapter = ActiveModelSerializers::Adapter::JsonApi.new(serializer)
-            adapter.serializable_hash(@options)
+            adapter = ActiveModelSerializers::Adapter::JsonApi.new(serializer, @options)
+            adapter.serializable_hash
           end
           assert_equal({
             Data: {
@@ -173,8 +173,8 @@ module ActiveModelSerializers
         def test_success_document_transform_dash
           mock_request(:dash)
           serializer = PostSerializer.new(@post)
-          adapter = ActiveModelSerializers::Adapter::JsonApi.new(serializer)
-          result = adapter.serializable_hash(@options)
+          adapter = ActiveModelSerializers::Adapter::JsonApi.new(serializer, @options)
+          result = adapter.serializable_hash
           assert_equal({
             data: {
               id: '1337',
@@ -207,8 +207,8 @@ module ActiveModelSerializers
         def test_success_document_transform_unaltered
           mock_request(:unaltered)
           serializer = PostSerializer.new(@post)
-          adapter = ActiveModelSerializers::Adapter::JsonApi.new(serializer)
-          result = adapter.serializable_hash(@options)
+          adapter = ActiveModelSerializers::Adapter::JsonApi.new(serializer, @options)
+          result = adapter.serializable_hash
           assert_equal({
             data: {
               id: '1337',
@@ -241,17 +241,18 @@ module ActiveModelSerializers
         def test_success_document_transform_undefined
           mock_request(:zoot)
           serializer = PostSerializer.new(@post)
-          adapter = ActiveModelSerializers::Adapter::JsonApi.new(serializer)
-          assert_raises NoMethodError do
-            adapter.serializable_hash(@options)
+          adapter = ActiveModelSerializers::Adapter::JsonApi.new(serializer, @options)
+          exception = assert_raises NoMethodError do
+            adapter.serializable_hash
           end
+          assert_match(/undefined method.*zoot/, exception.message)
         end
 
         def test_success_document_transform_camel
           mock_request(:camel)
           serializer = PostSerializer.new(@post)
-          adapter = ActiveModelSerializers::Adapter::JsonApi.new(serializer)
-          result = adapter.serializable_hash(@options)
+          adapter = ActiveModelSerializers::Adapter::JsonApi.new(serializer, @options)
+          result = adapter.serializable_hash
           assert_equal({
             Data: {
               Id: '1337',
@@ -284,8 +285,8 @@ module ActiveModelSerializers
         def test_success_document_transform_camel_lower
           mock_request(:camel_lower)
           serializer = PostSerializer.new(@post)
-          adapter = ActiveModelSerializers::Adapter::JsonApi.new(serializer)
-          result = adapter.serializable_hash(@options)
+          adapter = ActiveModelSerializers::Adapter::JsonApi.new(serializer, @options)
+          result = adapter.serializable_hash
           assert_equal({
             data: {
               id: '1337',
@@ -321,8 +322,8 @@ module ActiveModelSerializers
           resource.errors.add(:published_at, 'must be in the future')
           resource.errors.add(:title, 'must be longer')
           serializer = ActiveModel::Serializer::ErrorSerializer.new(resource)
-          adapter = ActiveModelSerializers::Adapter::JsonApi.new(serializer)
-          result = adapter.serializable_hash(@options)
+          adapter = ActiveModelSerializers::Adapter::JsonApi.new(serializer, @options)
+          result = adapter.serializable_hash
           expected_errors_object =
             { :errors =>
               [
@@ -345,8 +346,8 @@ module ActiveModelSerializers
             resource.errors.add(:published_at, 'must be in the future')
             resource.errors.add(:title, 'must be longer')
             serializer = ActiveModel::Serializer::ErrorSerializer.new(resource)
-            adapter = ActiveModelSerializers::Adapter::JsonApi.new(serializer)
-            adapter.serializable_hash(@options)
+            adapter = ActiveModelSerializers::Adapter::JsonApi.new(serializer, @options)
+            adapter.serializable_hash
           end
           expected_errors_object =
             { :Errors =>
@@ -371,8 +372,8 @@ module ActiveModelSerializers
             resource.errors.add(:published_at, 'must be in the future')
             resource.errors.add(:title, 'must be longer')
             serializer = ActiveModel::Serializer::ErrorSerializer.new(resource)
-            adapter = ActiveModelSerializers::Adapter::JsonApi.new(serializer)
-            adapter.serializable_hash(@options)
+            adapter = ActiveModelSerializers::Adapter::JsonApi.new(serializer, @options)
+            adapter.serializable_hash
           end
           expected_errors_object =
             { :Errors =>
@@ -398,8 +399,8 @@ module ActiveModelSerializers
           resource.errors.add(:title, 'must be longer')
 
           serializer = ActiveModel::Serializer::ErrorSerializer.new(resource)
-          adapter = ActiveModelSerializers::Adapter::JsonApi.new(serializer)
-          result = adapter.serializable_hash(@options)
+          adapter = ActiveModelSerializers::Adapter::JsonApi.new(serializer, @options)
+          result = adapter.serializable_hash
 
           expected_errors_object =
             { :errors =>
@@ -425,8 +426,8 @@ module ActiveModelSerializers
           resource.errors.add(:title, 'must be longer')
 
           serializer = ActiveModel::Serializer::ErrorSerializer.new(resource)
-          adapter = ActiveModelSerializers::Adapter::JsonApi.new(serializer)
-          result = adapter.serializable_hash(@options)
+          adapter = ActiveModelSerializers::Adapter::JsonApi.new(serializer, @options)
+          result = adapter.serializable_hash
 
           expected_errors_object =
             { :errors =>
@@ -446,11 +447,12 @@ module ActiveModelSerializers
           resource.errors.add(:title, 'must be longer')
 
           serializer = ActiveModel::Serializer::ErrorSerializer.new(resource)
-          adapter = ActiveModelSerializers::Adapter::JsonApi.new(serializer)
+          adapter = ActiveModelSerializers::Adapter::JsonApi.new(serializer, @options)
 
-          assert_raises NoMethodError do
-            adapter.serializable_hash(@options)
+          exception = assert_raises NoMethodError do
+            adapter.serializable_hash
           end
+          assert_match(/undefined method.*krazy/, exception.message)
         end
 
         def test_error_document_transform_camel
@@ -461,8 +463,8 @@ module ActiveModelSerializers
           resource.errors.add(:title, 'must be longer')
 
           serializer = ActiveModel::Serializer::ErrorSerializer.new(resource)
-          adapter = ActiveModelSerializers::Adapter::JsonApi.new(serializer)
-          result = adapter.serializable_hash(@options)
+          adapter = ActiveModelSerializers::Adapter::JsonApi.new(serializer, @options)
+          result = adapter.serializable_hash
 
           expected_errors_object =
             { :Errors =>
@@ -482,8 +484,8 @@ module ActiveModelSerializers
           resource.errors.add(:title, 'must be longer')
 
           serializer = ActiveModel::Serializer::ErrorSerializer.new(resource)
-          adapter = ActiveModelSerializers::Adapter::JsonApi.new(serializer)
-          result = adapter.serializable_hash(@options)
+          adapter = ActiveModelSerializers::Adapter::JsonApi.new(serializer, @options)
+          result = adapter.serializable_hash
 
           expected_errors_object =
             { :errors =>

data/test/adapter/polymorphic_test.rb

@@ -8,10 +8,17 @@ module ActiveModel
           @employee = Employee.new(id: 42, name: 'Zoop Zoopler', email: 'zoop@example.com')
           @picture = @employee.pictures.new(id: 1, title: 'headshot-1.jpg')
           @picture.imageable = @employee
+        end
+
+        def serialization(resource, adapter = :attributes)
+          serializable(resource, adapter: adapter, serializer: PolymorphicBelongsToSerializer).as_json
+        end
 
-          @attributes_serialization = serializable(@picture, serializer: PolymorphicBelongsToSerializer) # uses default adapter: attributes
-          @json_serialization = serializable(@picture, adapter: :json, serializer: PolymorphicBelongsToSerializer)
-          @json_api_serialization = serializable(@picture, adapter: :json_api, serializer: PolymorphicBelongsToSerializer)
+        def tag_serialization(adapter = :attributes)
+          tag = PolyTag.new(id: 1, phrase: 'foo')
+          tag.object_tags << ObjectTag.new(id: 1, poly_tag_id: 1, taggable: @employee)
+          tag.object_tags << ObjectTag.new(id: 5, poly_tag_id: 1, taggable: @picture)
+          serializable(tag, adapter: adapter, serializer: PolymorphicTagSerializer, include: '*.*').as_json
         end
 
         def test_attributes_serialization
@@ -20,31 +27,123 @@ module ActiveModel
               id: 1,
               title: 'headshot-1.jpg',
               imageable: {
-                id: 42,
-                name: 'Zoop Zoopler'
+                  type: 'employee',
+                  employee: {
+                    id: 42,
+                    name: 'Zoop Zoopler'
+                  }
               }
             }
 
-          assert_equal(expected, @attributes_serialization.as_json)
+          assert_equal(expected, serialization(@picture))
         end
 
-        def test_json_serializer
+        def test_attributes_serialization_without_polymorphic_association
+          expected =
+            {
+              id: 2,
+              title: 'headshot-2.jpg',
+              imageable: nil
+            }
+
+          simple_picture = Picture.new(id: 2, title: 'headshot-2.jpg')
+          assert_equal(expected, serialization(simple_picture))
+        end
+
+        def test_attributes_serialization_with_polymorphic_has_many
+          expected =
+            {
+              id: 1,
+              phrase: 'foo',
+              object_tags: [
+                {
+                  id: 1,
+                  taggable: {
+                    type: 'employee',
+                    employee: {
+                      id: 42
+                    }
+                  }
+                },
+                {
+                  id: 5,
+                  taggable: {
+                    type: 'picture',
+                    picture: {
+                      id: 1
+                    }
+                  }
+                }
+              ]
+            }
+          assert_equal(expected, tag_serialization)
+        end
+
+        def test_json_serialization
           expected =
             {
               picture: {
                 id: 1,
                 title: 'headshot-1.jpg',
                 imageable: {
-                  id: 42,
-                  name: 'Zoop Zoopler'
+                  type: 'employee',
+                  employee: {
+                    id: 42,
+                    name: 'Zoop Zoopler'
+                  }
                 }
               }
             }
 
-          assert_equal(expected, @json_serialization.as_json)
+          assert_equal(expected, serialization(@picture, :json))
+        end
+
+        def test_json_serialization_without_polymorphic_association
+          expected =
+            {
+              picture: {
+                id: 2,
+                title: 'headshot-2.jpg',
+                imageable: nil
+              }
+            }
+
+          simple_picture = Picture.new(id: 2, title: 'headshot-2.jpg')
+          assert_equal(expected, serialization(simple_picture, :json))
+        end
+
+        def test_json_serialization_with_polymorphic_has_many
+          expected =
+            {
+              poly_tag: {
+                id: 1,
+                phrase: 'foo',
+                object_tags: [
+                  {
+                    id: 1,
+                    taggable: {
+                      type: 'employee',
+                      employee: {
+                        id: 42
+                      }
+                    }
+                  },
+                  {
+                    id: 5,
+                    taggable: {
+                      type: 'picture',
+                      picture: {
+                        id: 1
+                      }
+                    }
+                  }
+                ]
+              }
+            }
+          assert_equal(expected, tag_serialization(:json))
         end
 
-        def test_json_api_serializer
+        def test_json_api_serialization
           expected =
             {
               data: {
@@ -64,7 +163,7 @@ module ActiveModel
               }
             }
 
-          assert_equal(expected, @json_api_serialization.as_json)
+          assert_equal(expected, serialization(@picture, :json_api))
         end
       end
     end

data/test/adapter_test.rb

@@ -14,6 +14,33 @@ module ActiveModelSerializers
       end
     end
 
+    def test_serialization_options_ensures_option_is_a_hash
+      adapter = Class.new(ActiveModelSerializers::Adapter::Base) do
+        def serializable_hash(options = nil)
+          serialization_options(options)
+        end
+      end.new(@serializer)
+      assert_equal({}, adapter.serializable_hash(nil))
+      assert_equal({}, adapter.serializable_hash({}))
+    ensure
+      ActiveModelSerializers::Adapter.adapter_map.delete_if { |k, _| k =~ /class/ }
+    end
+
+    def test_serialization_options_ensures_option_is_one_of_valid_options
+      adapter = Class.new(ActiveModelSerializers::Adapter::Base) do
+        def serializable_hash(options = nil)
+          serialization_options(options)
+        end
+      end.new(@serializer)
+      filtered_options = { now: :see_me, then: :not }
+      valid_options = ActiveModel::Serializer::SERIALIZABLE_HASH_VALID_KEYS.each_with_object({}) do |option, result|
+        result[option] = option
+      end
+      assert_equal(valid_options, adapter.serializable_hash(filtered_options.merge(valid_options)))
+    ensure
+      ActiveModelSerializers::Adapter.adapter_map.delete_if { |k, _| k =~ /class/ }
+    end
+
     def test_serializer
       assert_equal @serializer, @adapter.serializer
     end

data/test/array_serializer_test.rb

@@ -3,34 +3,19 @@ require_relative 'collection_serializer_test'
 
 module ActiveModel
   class Serializer
-    # Minitest.run_one_method isn't present in minitest 4
-    if $minitest_version > 4 # rubocop:disable Style/GlobalVars
-      class ArraySerializerTest < CollectionSerializerTest
-        extend Minitest::Assertions
-        def self.run_one_method(*)
-          _, stderr = capture_io do
-            super
-          end
-          if stderr !~ /NOTE: ActiveModel::Serializer::ArraySerializer.new is deprecated/
-            fail Minitest::Assertion, stderr
-          end
+    class ArraySerializerTest < CollectionSerializerTest
+      extend Minitest::Assertions
+      def self.run_one_method(*)
+        _, stderr = capture_io do
+          super
         end
-
-        def collection_serializer
-          ArraySerializer
+        if stderr !~ /NOTE: ActiveModel::Serializer::ArraySerializer.new is deprecated/
+          fail Minitest::Assertion, stderr
         end
       end
-    else
-      class ArraySerializerTest < ActiveSupport::TestCase
-        def test_json_key_with_root_warns_when_using_array_serializer
-          _, stderr = capture_io do
-            comment = Comment.new
-            post = Post.new
-            serializer = ArraySerializer.new([comment, post])
-            assert_equal 'comments', serializer.json_key
-          end
-          assert_match(/NOTE: ActiveModel::Serializer::ArraySerializer.new is deprecated/, stderr)
-        end
+
+      def collection_serializer
+        ArraySerializer
       end
     end
   end

data/test/benchmark/bm_caching.rb

@@ -31,10 +31,22 @@ class ApiAssertion
     get("/caching/#{on_off}")
   end
 
+  def get_fragment_caching(on_off = 'on'.freeze)
+    get("/fragment_caching/#{on_off}")
+  end
+
   def get_non_caching(on_off = 'on'.freeze)
     get("/non_caching/#{on_off}")
   end
 
+  def debug(msg = '')
+    if block_given? && ENV['DEBUG'] =~ /\Atrue|on|0\z/i
+      STDERR.puts yield
+    else
+      STDERR.puts msg
+    end
+  end
+
   private
 
   def assert_responses(caching, non_caching)
@@ -85,33 +97,23 @@ class ApiAssertion
       STDERR.puts message unless ENV['SUMMARIZE']
     end
   end
-
-  def debug(msg = '')
-    if block_given? && ENV['DEBUG'] =~ /\Atrue|on|0\z/i
-      STDERR.puts yield
-    else
-      STDERR.puts msg
-    end
-  end
 end
 assertion = ApiAssertion.new
 assertion.valid?
-# STDERR.puts assertion.get_status
+assertion.debug { assertion.get_status }
 
 time = 10
 {
   'caching on: caching serializers: gc off' => { disable_gc: true, send: [:get_caching, 'on'] },
-  # 'caching on: caching serializers: gc on' => { disable_gc: false, send: [:get_caching, 'on'] },
-  'caching off: caching serializers: gc off' => { disable_gc: true, send: [:get_caching, 'off'] },
-  # 'caching off: caching serializers: gc on' => { disable_gc: false, send: [:get_caching, 'off'] },
+  'caching on: fragment caching serializers: gc off' => { disable_gc: true, send: [:get_fragment_caching, 'on'] },
   'caching on: non-caching serializers: gc off' => { disable_gc: true, send: [:get_non_caching, 'on'] },
-  # 'caching on: non-caching serializers: gc on' => { disable_gc: false, send: [:get_non_caching, 'on'] },
+  'caching off: caching serializers: gc off' => { disable_gc: true, send: [:get_caching, 'off'] },
+  'caching off: fragment caching serializers: gc off' => { disable_gc: true, send: [:get_fragment_caching, 'off'] },
   'caching off: non-caching serializers: gc off' => { disable_gc: true, send: [:get_non_caching, 'off'] }
-  # 'caching off: non-caching serializers: gc on' => { disable_gc: false, send: [:get_non_caching, 'off'] }
 }.each do |label, options|
   assertion.clear
   Benchmark.ams(label, time: time, disable_gc: options[:disable_gc]) do
     assertion.send(*options[:send])
   end
-  # STDERR.puts assertion.get_status(options[:send][-1])
+  assertion.debug { assertion.get_status(options[:send][-1]) }
 end