active_model_serializers 0.10.0.rc4 → 0.10.0.rc5

data/test/adapter/json_api/type_test.rb

@@ -0,0 +1,61 @@
+require 'test_helper'
+
+module ActiveModel
+  class Serializer
+    module Adapter
+      class JsonApi
+        class TypeTest < ActiveSupport::TestCase
+          class StringTypeSerializer < ActiveModel::Serializer
+            attribute :name
+            type 'profile'
+          end
+
+          class SymbolTypeSerializer < ActiveModel::Serializer
+            attribute :name
+            type :profile
+          end
+
+          setup do
+            @author = Author.new(id: 1, name: 'Steve K.')
+          end
+
+          def test_config_plural
+            with_jsonapi_resource_type :plural do
+              assert_type(@author, 'authors')
+            end
+          end
+
+          def test_config_singular
+            with_jsonapi_resource_type :singular do
+              assert_type(@author, 'author')
+            end
+          end
+
+          def test_explicit_string_type_value
+            assert_type(@author, 'profile', serializer: StringTypeSerializer)
+          end
+
+          def test_explicit_symbol_type_value
+            assert_type(@author, 'profile', serializer: SymbolTypeSerializer)
+          end
+
+          private
+
+          def assert_type(resource, expected_type, opts = {})
+            opts = opts.reverse_merge(adapter: :json_api)
+            hash = serializable(resource, opts).serializable_hash
+            assert_equal(expected_type, hash.fetch(:data).fetch(:type))
+          end
+
+          def with_jsonapi_resource_type inflection
+            old_inflection = ActiveModelSerializers.config.jsonapi_resource_type
+            ActiveModelSerializers.config.jsonapi_resource_type = inflection
+            yield
+          ensure
+            ActiveModelSerializers.config.jsonapi_resource_type = old_inflection
+          end
+        end
+      end
+    end
+  end
+end

data/test/adapter/json_test.rb

@@ -1,46 +1,44 @@
 require 'test_helper'
 
-module ActiveModel
-  class Serializer
-    module Adapter
-      class JsonTest < ActiveSupport::TestCase
-        def setup
-          ActionController::Base.cache_store.clear
-          @author = Author.new(id: 1, name: 'Steve K.')
-          @post = Post.new(id: 1, title: 'New Post', body: 'Body')
-          @first_comment = Comment.new(id: 1, body: 'ZOMG A COMMENT')
-          @second_comment = Comment.new(id: 2, body: 'ZOMG ANOTHER COMMENT')
-          @post.comments = [@first_comment, @second_comment]
-          @first_comment.post = @post
-          @second_comment.post = @post
-          @post.author = @author
-          @blog = Blog.new(id: 1, name: 'My Blog!!')
-          @post.blog = @blog
+module ActiveModelSerializers
+  module Adapter
+    class JsonTest < ActiveSupport::TestCase
+      def setup
+        ActionController::Base.cache_store.clear
+        @author = Author.new(id: 1, name: 'Steve K.')
+        @post = Post.new(id: 1, title: 'New Post', body: 'Body')
+        @first_comment = Comment.new(id: 1, body: 'ZOMG A COMMENT')
+        @second_comment = Comment.new(id: 2, body: 'ZOMG ANOTHER COMMENT')
+        @post.comments = [@first_comment, @second_comment]
+        @first_comment.post = @post
+        @second_comment.post = @post
+        @post.author = @author
+        @blog = Blog.new(id: 1, name: 'My Blog!!')
+        @post.blog = @blog
 
-          @serializer = PostSerializer.new(@post)
-          @adapter = ActiveModel::Serializer::Adapter::Json.new(@serializer)
-        end
+        @serializer = PostSerializer.new(@post)
+        @adapter = ActiveModelSerializers::Adapter::Json.new(@serializer)
+      end
 
-        def test_has_many
-          assert_equal([
-                         { id: 1, body: 'ZOMG A COMMENT' },
-                         { id: 2, body: 'ZOMG ANOTHER COMMENT' }
-                       ], @adapter.serializable_hash[:post][:comments])
-        end
+      def test_has_many
+        assert_equal([
+                       { id: 1, body: 'ZOMG A COMMENT' },
+                       { id: 2, body: 'ZOMG ANOTHER COMMENT' }
+                     ], @adapter.serializable_hash[:post][:comments])
+      end
 
-        def test_custom_keys
-          serializer = PostWithCustomKeysSerializer.new(@post)
-          adapter = ActiveModel::Serializer::Adapter::Json.new(serializer)
+      def test_custom_keys
+        serializer = PostWithCustomKeysSerializer.new(@post)
+        adapter = ActiveModelSerializers::Adapter::Json.new(serializer)
 
-          assert_equal({
-            id: 1,
-            reviews: [{ id: 1, body: 'ZOMG A COMMENT' },
-                      { id: 2, body: 'ZOMG ANOTHER COMMENT' }
-                    ],
-            writer: { id: 1, name: 'Steve K.' },
-            site: { id: 1, name: 'My Blog!!' }
-            }, adapter.serializable_hash[:post])
-        end
+        assert_equal({
+          id: 1,
+          reviews: [{ id: 1, body: 'ZOMG A COMMENT' },
+                    { id: 2, body: 'ZOMG ANOTHER COMMENT' }
+                  ],
+          writer: { id: 1, name: 'Steve K.' },
+          site: { id: 1, name: 'My Blog!!' }
+          }, adapter.serializable_hash[:post])
       end
     end
   end

data/test/adapter/null_test.rb

@@ -1,23 +1,21 @@
 require 'test_helper'
 
-module ActiveModel
-  class Serializer
-    module Adapter
-      class NullTest < ActiveSupport::TestCase
-        def setup
-          profile = Profile.new({ name: 'Name 1', description: 'Description 1', comments: 'Comments 1' })
-          serializer = ProfileSerializer.new(profile)
+module ActiveModelSerializers
+  module Adapter
+    class NullTest < ActiveSupport::TestCase
+      def setup
+        profile = Profile.new({ name: 'Name 1', description: 'Description 1', comments: 'Comments 1' })
+        serializer = ProfileSerializer.new(profile)
 
-          @adapter = Null.new(serializer)
-        end
+        @adapter = Null.new(serializer)
+      end
 
-        def test_serializable_hash
-          assert_equal({}, @adapter.serializable_hash)
-        end
+      def test_serializable_hash
+        assert_equal({}, @adapter.serializable_hash)
+      end
 
-        def test_it_returns_empty_json
-          assert_equal('{}', @adapter.to_json)
-        end
+      def test_it_returns_empty_json
+        assert_equal('{}', @adapter.to_json)
       end
     end
   end

data/test/adapter/polymorphic_test.rb

@@ -0,0 +1,72 @@
+require 'test_helper'
+
+module ActiveModel
+  class Serializer
+    module Adapter
+      class PolymorphicTest < ActiveSupport::TestCase
+        setup do
+          @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
+
+          @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)
+        end
+
+        def test_attributes_serialization
+          expected =
+            {
+              id: 1,
+              title: 'headshot-1.jpg',
+              imageable: {
+                id: 42,
+                name: 'Zoop Zoopler'
+              }
+            }
+
+          assert_equal(expected, @attributes_serialization.as_json)
+        end
+
+        def test_json_serializer
+          expected =
+            {
+              picture: {
+                id: 1,
+                title: 'headshot-1.jpg',
+                imageable: {
+                  id: 42,
+                  name: 'Zoop Zoopler'
+                }
+              }
+            }
+
+          assert_equal(expected, @json_serialization.as_json)
+        end
+
+        def test_json_api_serializer
+          expected =
+            {
+              data: {
+                id: '1',
+                type: 'pictures',
+                attributes: {
+                  title: 'headshot-1.jpg'
+                },
+                relationships: {
+                  imageable: {
+                    data: {
+                      id: '42',
+                      type: 'employees'
+                    }
+                  }
+                }
+              }
+            }
+
+          assert_equal(expected, @json_api_serialization.as_json)
+        end
+      end
+    end
+  end
+end

data/test/adapter_test.rb

@@ -1,42 +1,40 @@
 require 'test_helper'
 
-module ActiveModel
-  class Serializer
-    class AdapterTest < ActiveSupport::TestCase
-      def setup
-        profile = Profile.new
-        @serializer = ProfileSerializer.new(profile)
-        @adapter = ActiveModel::Serializer::Adapter::Base.new(@serializer)
-      end
+module ActiveModelSerializers
+  class AdapterTest < ActiveSupport::TestCase
+    def setup
+      profile = Profile.new
+      @serializer = ProfileSerializer.new(profile)
+      @adapter = ActiveModelSerializers::Adapter::Base.new(@serializer)
+    end
 
-      def test_serializable_hash_is_abstract_method
-        assert_raises(NotImplementedError) do
-          @adapter.serializable_hash(only: [:name])
-        end
+    def test_serializable_hash_is_abstract_method
+      assert_raises(NotImplementedError) do
+        @adapter.serializable_hash(only: [:name])
       end
+    end
 
-      def test_serializer
-        assert_equal @serializer, @adapter.serializer
-      end
+    def test_serializer
+      assert_equal @serializer, @adapter.serializer
+    end
 
-      def test_create_adapter
-        adapter = ActiveModel::Serializer::Adapter.create(@serializer)
-        assert_equal ActiveModel::Serializer::Adapter::Attributes, adapter.class
-      end
+    def test_create_adapter
+      adapter = ActiveModelSerializers::Adapter.create(@serializer)
+      assert_equal ActiveModelSerializers::Adapter::Attributes, adapter.class
+    end
 
-      def test_create_adapter_with_override
-        adapter = ActiveModel::Serializer::Adapter.create(@serializer, { adapter: :json_api })
-        assert_equal ActiveModel::Serializer::Adapter::JsonApi, adapter.class
-      end
+    def test_create_adapter_with_override
+      adapter = ActiveModelSerializers::Adapter.create(@serializer, { adapter: :json_api })
+      assert_equal ActiveModelSerializers::Adapter::JsonApi, adapter.class
+    end
 
-      def test_inflected_adapter_class_for_known_adapter
-        ActiveSupport::Inflector.inflections(:en) { |inflect| inflect.acronym 'API' }
-        klass = ActiveModel::Serializer::Adapter.adapter_class(:json_api)
+    def test_inflected_adapter_class_for_known_adapter
+      ActiveSupport::Inflector.inflections(:en) { |inflect| inflect.acronym 'API' }
+      klass = ActiveModelSerializers::Adapter.adapter_class(:json_api)
 
-        ActiveSupport::Inflector.inflections.acronyms.clear
+      ActiveSupport::Inflector.inflections.acronyms.clear
 
-        assert_equal ActiveModel::Serializer::Adapter::JsonApi, klass
-      end
+      assert_equal ActiveModelSerializers::Adapter::JsonApi, klass
     end
   end
 end

data/test/array_serializer_test.rb

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

data/test/benchmark/app.rb

@@ -0,0 +1,65 @@
+# https://github.com/rails-api/active_model_serializers/pull/872
+# approx ref 792fb8a9053f8db3c562dae4f40907a582dd1720 to test against
+require 'bundler/setup'
+
+require 'rails'
+require 'active_model'
+require 'active_support'
+require 'active_support/json'
+require 'action_controller'
+require 'action_controller/test_case'
+require 'action_controller/railtie'
+abort "Rails application already defined: #{Rails.application.class}" if Rails.application
+
+class NullLogger < Logger
+  def initialize(*_args)
+  end
+
+  def add(*_args, &_block)
+  end
+end
+class BenchmarkLogger < ActiveSupport::Logger
+  def initialize
+    @file = StringIO.new
+    super(@file)
+  end
+
+  def messages
+    @file.rewind
+    @file.read
+  end
+end
+# ref: https://gist.github.com/bf4/8744473
+class BenchmarkApp < Rails::Application
+  # Set up production configuration
+  config.eager_load = true
+  config.cache_classes = true
+  # CONFIG: CACHE_ON={on,off}
+  config.action_controller.perform_caching = ENV['CACHE_ON'] != 'off'
+  config.action_controller.cache_store = ActiveSupport::Cache.lookup_store(:memory_store)
+
+  config.active_support.test_order = :random
+  config.secret_token = 'S' * 30
+  config.secret_key_base = 'abc123'
+  config.consider_all_requests_local = false
+
+  # otherwise deadlock occured
+  config.middleware.delete 'Rack::Lock'
+
+  # to disable log files
+  config.logger = NullLogger.new
+  config.active_support.deprecation = :log
+  config.log_level = :info
+end
+
+require 'active_model_serializers'
+
+# Initialize app before any serializers are defined, for running across revisions.
+# ref: https://github.com/rails-api/active_model_serializers/pull/1478
+Rails.application.initialize!
+# HACK: Serializer::cache depends on the ActionController-dependent configs being set.
+ActiveSupport.on_load(:action_controller) do
+  require_relative 'fixtures'
+end
+
+require_relative 'controllers'

data/test/benchmark/benchmarking_support.rb

@@ -0,0 +1,67 @@
+require 'benchmark/ips'
+require 'json'
+
+# Add benchmarking runner from ruby-bench-suite
+# https://github.com/ruby-bench/ruby-bench-suite/blob/master/rails/benchmarks/support/benchmark_rails.rb
+module Benchmark
+  module ActiveModelSerializers
+    module TestMethods
+      def request(method, path)
+        response = Rack::MockRequest.new(BenchmarkApp).send(method, path)
+        if response.status.in?([404, 500])
+          fail "omg, #{method}, #{path}, '#{response.status}', '#{response.body}'"
+        end
+        response
+      end
+    end
+
+    # extend Benchmark with an `ams` method
+    def ams(label = nil, time:, disable_gc: true, warmup: 3, &block)
+      fail ArgumentError.new, 'block should be passed' unless block_given?
+
+      if disable_gc
+        GC.disable
+      else
+        GC.enable
+      end
+
+      report = Benchmark.ips(time, warmup, true) do |x|
+        x.report(label) { yield }
+      end
+
+      entry = report.entries.first
+
+      output = {
+        label: label,
+        version: ::ActiveModel::Serializer::VERSION.to_s,
+        rails_version: ::Rails.version.to_s,
+        iterations_per_second: entry.ips,
+        iterations_per_second_standard_deviation: entry.stddev_percentage,
+        total_allocated_objects_per_iteration: count_total_allocated_objects(&block)
+      }.to_json
+
+      puts output
+      output
+    end
+
+    def count_total_allocated_objects
+      if block_given?
+        key =
+          if RUBY_VERSION < '2.2'
+            :total_allocated_object
+          else
+            :total_allocated_objects
+          end
+
+        before = GC.stat[key]
+        yield
+        after = GC.stat[key]
+        after - before
+      else
+        -1
+      end
+    end
+  end
+
+  extend Benchmark::ActiveModelSerializers
+end