active_model_serializers 0.10.0.rc4 → 0.10.0.rc5

data/test/serializers/meta_test.rb

@@ -11,7 +11,7 @@ module ActiveModel
       end
 
       def test_meta_is_present_with_root
-        actual = ActiveModel::SerializableResource.new(
+        actual = ActiveModelSerializers::SerializableResource.new(
           @blog,
           adapter: :json,
           serializer: AlternateBlogSerializer,
@@ -28,8 +28,40 @@ module ActiveModel
         assert_equal(expected, actual)
       end
 
+      def test_meta_is_not_included_when_blank
+        actual = ActiveModelSerializers::SerializableResource.new(
+          @blog,
+          adapter: :json,
+          serializer: AlternateBlogSerializer,
+          meta: {}
+        ).as_json
+        expected = {
+          blog: {
+            id: 1,
+            title: 'AMS Hints'
+          }
+        }
+        assert_equal(expected, actual)
+      end
+
+      def test_meta_is_not_included_when_empty_string
+        actual = ActiveModelSerializers::SerializableResource.new(
+          @blog,
+          adapter: :json,
+          serializer: AlternateBlogSerializer,
+          meta: ''
+        ).as_json
+        expected = {
+          blog: {
+            id: 1,
+            title: 'AMS Hints'
+          }
+        }
+        assert_equal(expected, actual)
+      end
+
       def test_meta_is_not_included_when_root_is_missing
-        actual = ActiveModel::SerializableResource.new(
+        actual = ActiveModelSerializers::SerializableResource.new(
           @blog,
           adapter: :attributes,
           serializer: AlternateBlogSerializer,
@@ -42,7 +74,7 @@ module ActiveModel
       end
 
       def test_meta_key_is_used
-        actual = ActiveModel::SerializableResource.new(
+        actual = ActiveModelSerializers::SerializableResource.new(
           @blog,
           adapter: :json,
           serializer: AlternateBlogSerializer,
@@ -61,7 +93,7 @@ module ActiveModel
       end
 
       def test_meta_key_is_used_with_json_api
-        actual = ActiveModel::SerializableResource.new(
+        actual = ActiveModelSerializers::SerializableResource.new(
           @blog,
           adapter: :json_api,
           serializer: AlternateBlogSerializer,
@@ -78,8 +110,44 @@ module ActiveModel
         assert_equal(expected, actual)
       end
 
+      def test_meta_key_is_not_present_when_blank_object_with_json_api
+        actual = ActiveModelSerializers::SerializableResource.new(
+          @blog,
+          adapter: :json_api,
+          serializer: AlternateBlogSerializer,
+          meta: {},
+          meta_key: 'haha_meta'
+        ).as_json
+        expected = {
+          data: {
+            id: '1',
+            type: 'blogs',
+            attributes: { title: 'AMS Hints' }
+          }
+        }
+        assert_equal(expected, actual)
+      end
+
+      def test_meta_key_is_not_present_when_empty_string_with_json_api
+        actual = ActiveModelSerializers::SerializableResource.new(
+          @blog,
+          adapter: :json_api,
+          serializer: AlternateBlogSerializer,
+          meta: '',
+          meta_key: 'haha_meta'
+        ).as_json
+        expected = {
+          data: {
+            id: '1',
+            type: 'blogs',
+            attributes: { title: 'AMS Hints' }
+          }
+        }
+        assert_equal(expected, actual)
+      end
+
       def test_meta_is_not_present_on_arrays_without_root
-        actual = ActiveModel::SerializableResource.new(
+        actual = ActiveModelSerializers::SerializableResource.new(
           [@blog],
           adapter: :attributes,
           meta: { total: 10 }).as_json
@@ -100,7 +168,7 @@ module ActiveModel
       end
 
       def test_meta_is_present_on_arrays_with_root
-        actual = ActiveModel::SerializableResource.new(
+        actual = ActiveModelSerializers::SerializableResource.new(
           [@blog],
           adapter: :json,
           meta: { total: 10 },

data/test/serializers/read_attribute_for_serialization_test.rb

@@ -0,0 +1,79 @@
+require 'test_helper'
+
+module ActiveModel
+  class Serializer
+    class ReadAttributeForSerializationTest < ActiveSupport::TestCase
+      # https://github.com/rails-api/active_model_serializers/issues/1653
+      class Parent < ActiveModelSerializers::Model
+        attr_accessor :id
+      end
+      class Child < Parent
+        attr_accessor :name
+      end
+      class ParentSerializer < ActiveModel::Serializer
+        attributes :$id
+
+        define_method(:$id) do
+          object.id
+        end
+      end
+      class ChildSerializer < ParentSerializer
+        attributes :name
+      end
+
+      def test_child_serializer_calls_dynamic_method_in_parent_serializer
+        parent = ParentSerializer.new(Parent.new(id: 5))
+        child  = ChildSerializer.new(Child.new(id: 6, name: 'Child'))
+        assert_equal 5, parent.read_attribute_for_serialization(:$id)
+        assert_equal 6, child.read_attribute_for_serialization(:$id)
+      end
+
+      # https://github.com/rails-api/active_model_serializers/issues/1658
+      class ErrorResponse < ActiveModelSerializers::Model
+        attr_accessor :error
+      end
+      class ApplicationSerializer < ActiveModel::Serializer
+        attributes :status
+
+        def status
+          object.try(:errors).blank? && object.try(:error).blank?
+        end
+      end
+      class ErrorResponseSerializer < ApplicationSerializer
+        attributes :error
+      end
+      class ErrorResponseWithSuperSerializer < ApplicationSerializer
+        attributes :error
+
+        def success
+          super
+        end
+      end
+
+      def test_child_serializer_with_error_attribute
+        error = ErrorResponse.new(error: 'i have an error')
+        serializer = ErrorResponseSerializer.new(error)
+        serializer_with_super = ErrorResponseWithSuperSerializer.new(error)
+        assert_equal false, serializer.read_attribute_for_serialization(:status)
+        assert_equal false, serializer_with_super.read_attribute_for_serialization(:status)
+      end
+
+      def test_child_serializer_with_errors
+        error = ErrorResponse.new
+        error.errors.add(:invalid, 'i am not valid')
+        serializer = ErrorResponseSerializer.new(error)
+        serializer_with_super = ErrorResponseWithSuperSerializer.new(error)
+        assert_equal false, serializer.read_attribute_for_serialization(:status)
+        assert_equal false, serializer_with_super.read_attribute_for_serialization(:status)
+      end
+
+      def test_child_serializer_no_error_attribute_or_errors
+        error = ErrorResponse.new
+        serializer = ErrorResponseSerializer.new(error)
+        serializer_with_super = ErrorResponseWithSuperSerializer.new(error)
+        assert_equal true, serializer.read_attribute_for_serialization(:status)
+        assert_equal true, serializer_with_super.read_attribute_for_serialization(:status)
+      end
+    end
+  end
+end

data/test/serializers/serialization_test.rb

@@ -0,0 +1,55 @@
+module ActiveModel
+  class Serializer
+    class SerializationTest < ActiveSupport::TestCase
+      class Blog < ActiveModelSerializers::Model
+        attr_accessor :id, :name, :authors
+      end
+      class Author < ActiveModelSerializers::Model
+        attr_accessor :id, :name
+      end
+      class BlogSerializer < ActiveModel::Serializer
+        attributes :id
+        attribute :name, key: :title
+
+        has_many :authors
+      end
+      class AuthorSerializer < ActiveModel::Serializer
+        attributes :id, :name
+      end
+
+      setup do
+        @authors = [Author.new(id: 1, name: 'Blog Author')]
+        @blog = Blog.new(id: 2, name: 'The Blog', authors: @authors)
+        @serializer_instance = BlogSerializer.new(@blog)
+        @serializable = ActiveModelSerializers::SerializableResource.new(@blog, serializer: BlogSerializer, adapter: :attributes)
+        @expected_hash = { id: 2, title: 'The Blog', authors: [{ id: 1, name: 'Blog Author' }] }
+        @expected_json = '{"id":2,"title":"The Blog","authors":[{"id":1,"name":"Blog Author"}]}'
+      end
+
+      test '#serializable_hash is the same as generated by the attributes adapter' do
+        assert_equal @serializable.serializable_hash, @serializer_instance.serializable_hash
+        assert_equal @expected_hash, @serializer_instance.serializable_hash
+      end
+
+      test '#as_json is the same as generated by the attributes adapter' do
+        assert_equal @serializable.as_json, @serializer_instance.as_json
+        assert_equal @expected_hash, @serializer_instance.as_json
+      end
+
+      test '#to_json is the same as generated by the attributes adapter' do
+        assert_equal @serializable.to_json, @serializer_instance.to_json
+        assert_equal @expected_json, @serializer_instance.to_json
+      end
+
+      test '#to_h is an alias for #serializable_hash' do
+        assert_equal @serializable.serializable_hash, @serializer_instance.to_h
+        assert_equal @expected_hash, @serializer_instance.to_h
+      end
+
+      test '#to_hash is an alias for #serializable_hash' do
+        assert_equal @serializable.serializable_hash, @serializer_instance.to_hash
+        assert_equal @expected_hash, @serializer_instance.to_hash
+      end
+    end
+  end
+end

data/test/support/isolated_unit.rb

@@ -46,6 +46,8 @@ require 'active_support/testing/isolation'
 
 module TestHelpers
   module Generation
+    module_function
+
     # Make a very basic app, without creating the whole directory structure.
     # Is faster and simpler than generating a Rails app in a temp directory
     def make_basic_app
@@ -63,6 +65,7 @@ module TestHelpers
         # Set a fake logger to avoid creating the log directory automatically
         fake_logger = Logger.new(nil)
         config.logger = fake_logger
+        Rails.application.routes.default_url_options = { host: 'example.com' }
       end
       @app.respond_to?(:secrets) && @app.secrets.secret_key_base = '3b7cd727ee24e8444053437c36cc66c4'
 

data/test/support/rails5_shims.rb

@@ -1,19 +1,37 @@
 module Rails5Shims
   module ControllerTests
     # https://github.com/rails/rails/blob/b217354/actionpack/lib/action_controller/test_case.rb
-    REQUEST_KWARGS = [:params, :session, :flash, :method, :body, :xhr]
+    REQUEST_KWARGS = [:params, :session, :flash, :method, :body, :xhr].freeze
+
+    def get(path, *args)
+      fold_kwargs!(args)
+      super
+    end
+
+    def post(path, *args)
+      fold_kwargs!(args)
+      super
+    end
+
+    def patch(path, *args)
+      fold_kwargs!(args)
+      super
+    end
+
+    def put(path, *args)
+      fold_kwargs!(args)
+      super
+    end
 
     # Fold kwargs from test request into args
     # Band-aid for DEPRECATION WARNING
-    def get(path, *args)
+    def fold_kwargs!(args)
       hash = args && args[0]
-      if hash.respond_to?(:key)
-        Rails5Shims::ControllerTests::REQUEST_KWARGS.each do |kwarg|
-          next unless hash.key?(kwarg)
-          hash.merge! hash.delete(kwarg)
-        end
+      return unless hash.respond_to?(:key)
+      Rails5Shims::ControllerTests::REQUEST_KWARGS.each do |kwarg|
+        next unless hash.key?(kwarg)
+        hash.merge! hash.delete(kwarg)
       end
-      super
     end
 
     # Uncomment for debugging where the kwargs warnings come from

data/test/support/rails_app.rb

@@ -1,25 +1,45 @@
-class ActiveModelSerializers::RailsApplication < Rails::Application
-  if Rails::VERSION::MAJOR >= 4
-    config.eager_load = false
+require 'support/isolated_unit'
+module ActiveModelSerializers
+  RailsApplication = TestHelpers::Generation.make_basic_app do |app|
+    app.configure do
+      config.secret_key_base = 'abc123'
+      config.active_support.test_order = :random
+      config.action_controller.perform_caching = true
+      config.action_controller.cache_store = :memory_store
+    end
 
-    config.secret_key_base = 'abc123'
-
-    config.active_support.test_order = :random
-
-    config.logger = Logger.new(nil)
-
-    config.action_controller.perform_caching = true
-    ActionController::Base.cache_store = :memory_store
+    app.routes.default_url_options = { host: 'example.com' }
   end
 end
-ActiveModelSerializers::RailsApplication.initialize!
 
-module TestHelper
-  Routes = ActionDispatch::Routing::RouteSet.new
-  Routes.draw do
-    get ':controller(/:action(/:id))'
-    get ':controller(/:action)'
+Routes = ActionDispatch::Routing::RouteSet.new
+Routes.draw do
+  get ':controller(/:action(/:id))'
+  get ':controller(/:action)'
+end
+ActionController::Base.send :include, Routes.url_helpers
+ActionController::TestCase.class_eval do
+  def setup
+    @routes = Routes
   end
 
-  ActionController::Base.send :include, Routes.url_helpers
+  # For Rails5
+  # https://github.com/rails/rails/commit/ca83436d1b3b6cedd1eca2259f65661e69b01909#diff-b9bbf56e85d3fe1999f16317f2751e76L17
+  def assigns(key = nil)
+    warn "DEPRECATION: Calling 'assigns(#{key})' from #{caller[0]}"
+    assigns = {}.with_indifferent_access
+    @controller.view_assigns.each { |k, v| assigns.regular_writer(k, v) }
+    key.nil? ? assigns : assigns[key]
+  end
 end
+
+# ActiveRecord::Migrator.migrations_paths = [File.expand_path("../../test/dummy/db/migrate", __FILE__)]
+# ActiveRecord::Migrator.migrations_paths << File.expand_path('../../db/migrate', __FILE__)
+#
+# Load fixtures from the engine
+# if ActiveSupport::TestCase.respond_to?(:fixture_path=)
+#   ActiveSupport::TestCase.fixture_path = File.expand_path("../fixtures", __FILE__)
+#   ActionDispatch::IntegrationTest.fixture_path = ActiveSupport::TestCase.fixture_path
+#   ActiveSupport::TestCase.file_fixture_path = ActiveSupport::TestCase.fixture_path + "/files"
+#   ActiveSupport::TestCase.fixtures :all
+# end

data/test/support/serialization_testing.rb

@@ -6,14 +6,14 @@ module SerializationTesting
   private
 
   def generate_cached_serializer(obj)
-    ActiveModel::SerializableResource.new(obj).to_json
+    ActiveModelSerializers::SerializableResource.new(obj).to_json
   end
 
   # Aliased as :with_configured_adapter to clarify that
   # this method tests the configured adapter.
   # When not testing configuration, it may be preferable
-  # to pass in the +adapter+ option to <tt>ActiveModel::SerializableResource</tt>.
-  # e.g ActiveModel::SerializableResource.new(resource, adapter: :json_api)
+  # to pass in the +adapter+ option to <tt>ActiveModelSerializers::SerializableResource</tt>.
+  # e.g ActiveModelSerializers::SerializableResource.new(resource, adapter: :json_api)
   def with_adapter(adapter)
     old_adapter = ActiveModelSerializers.config.adapter
     ActiveModelSerializers.config.adapter = adapter
@@ -21,7 +21,7 @@ module SerializationTesting
   ensure
     ActiveModelSerializers.config.adapter = old_adapter
   end
-  alias_method :with_configured_adapter, :with_adapter
+  alias with_configured_adapter with_adapter
 
   def with_config(hash)
     old_config = config.dup
@@ -40,7 +40,7 @@ module SerializationTesting
   end
 
   def serializable(resource, options = {})
-    ActiveModel::SerializableResource.new(resource, options)
+    ActiveModelSerializers::SerializableResource.new(resource, options)
   end
 end
 

data/test/test_helper.rb

@@ -1,11 +1,9 @@
+# Configure Rails Environment
+ENV['RAILS_ENV'] = 'test'
 require 'bundler/setup'
 
 begin
   require 'simplecov'
-  # HACK: till https://github.com/colszowka/simplecov/pull/400 is merged and released.
-  # Otherwise you may get:
-  # simplecov-0.10.0/lib/simplecov/defaults.rb:50: warning: global variable `$ERROR_INFO' not initialized
-  require 'support/simplecov'
   AppCoverage.start
 rescue LoadError
   STDERR.puts 'Running without SimpleCov'
@@ -16,7 +14,6 @@ require 'rails'
 require 'action_controller'
 require 'action_controller/test_case'
 require 'action_controller/railtie'
-require 'active_support/json'
 require 'active_model_serializers'
 require 'fileutils'
 FileUtils.mkdir_p(File.expand_path('../../tmp/cache', __FILE__))
@@ -39,15 +36,14 @@ else
   $minitest_version = 5
   # https://github.com/seattlerb/minitest/blob/e21fdda9d/lib/minitest/autorun.rb
   # https://github.com/seattlerb/minitest/blob/e21fdda9d/lib/minitest.rb#L45-L59
+  # Filter out Minitest backtrace while allowing backtrace from other libraries
+  # to be shown.
+  Minitest.backtrace_filter = Minitest::BacktraceFilter.new
 end
-require 'minitest/reporters'
-Minitest::Reporters.use!
-
-require 'support/stream_capture'
 
 require 'support/rails_app'
 
-require 'support/test_case'
+# require "rails/test_help"
 
 require 'support/serialization_testing'