active_model_serializers 0.8.3 → 0.10.0

data/test/serializers/serializer_for_test.rb

@@ -0,0 +1,134 @@
+require 'test_helper'
+
+module ActiveModel
+  class Serializer
+    class SerializerForTest < ActiveSupport::TestCase
+      class CollectionSerializerTest < ActiveSupport::TestCase
+        def setup
+          @array = [1, 2, 3]
+          @previous_collection_serializer = ActiveModelSerializers.config.collection_serializer
+        end
+
+        def teardown
+          ActiveModelSerializers.config.collection_serializer = @previous_collection_serializer
+        end
+
+        def test_serializer_for_array
+          serializer = ActiveModel::Serializer.serializer_for(@array)
+          assert_equal ActiveModelSerializers.config.collection_serializer, serializer
+        end
+
+        def test_overwritten_serializer_for_array
+          new_collection_serializer = Class.new
+          ActiveModelSerializers.config.collection_serializer = new_collection_serializer
+          serializer = ActiveModel::Serializer.serializer_for(@array)
+          assert_equal new_collection_serializer, serializer
+        end
+      end
+
+      class SerializerTest < ActiveSupport::TestCase
+        module ResourceNamespace
+          Post    = Class.new(::Model)
+          Comment = Class.new(::Model)
+
+          class PostSerializer < ActiveModel::Serializer
+            class CommentSerializer < ActiveModel::Serializer
+            end
+          end
+        end
+
+        class MyProfile < Profile
+        end
+
+        class CustomProfile
+          def serializer_class; ProfileSerializer; end
+        end
+
+        Tweet = Class.new(::Model)
+        TweetSerializer = Class.new
+
+        def setup
+          @profile = Profile.new
+          @my_profile = MyProfile.new
+          @custom_profile = CustomProfile.new
+          @model = ::Model.new
+          @tweet = Tweet.new
+        end
+
+        def test_serializer_for_non_ams_serializer
+          serializer = ActiveModel::Serializer.serializer_for(@tweet)
+          assert_equal nil, serializer
+        end
+
+        def test_serializer_for_existing_serializer
+          serializer = ActiveModel::Serializer.serializer_for(@profile)
+          assert_equal ProfileSerializer, serializer
+        end
+
+        def test_serializer_for_existing_serializer_with_lookup_disabled
+          serializer = with_serializer_lookup_disabled do
+            ActiveModel::Serializer.serializer_for(@profile)
+          end
+          assert_equal nil, serializer
+        end
+
+        def test_serializer_for_not_existing_serializer
+          serializer = ActiveModel::Serializer.serializer_for(@model)
+          assert_equal nil, serializer
+        end
+
+        def test_serializer_inherited_serializer
+          serializer = ActiveModel::Serializer.serializer_for(@my_profile)
+          assert_equal ProfileSerializer, serializer
+        end
+
+        def test_serializer_inherited_serializer_with_lookup_disabled
+          serializer = with_serializer_lookup_disabled do
+            ActiveModel::Serializer.serializer_for(@my_profile)
+          end
+          assert_equal nil, serializer
+        end
+
+        def test_serializer_custom_serializer
+          serializer = ActiveModel::Serializer.serializer_for(@custom_profile)
+          assert_equal ProfileSerializer, serializer
+        end
+
+        def test_serializer_custom_serializer_with_lookup_disabled
+          serializer = with_serializer_lookup_disabled do
+            ActiveModel::Serializer.serializer_for(@custom_profile)
+          end
+          assert_equal ProfileSerializer, serializer
+        end
+
+        def test_serializer_for_namespaced_resource
+          post = ResourceNamespace::Post.new
+          serializer = ActiveModel::Serializer.serializer_for(post)
+          assert_equal ResourceNamespace::PostSerializer, serializer
+        end
+
+        def test_serializer_for_namespaced_resource_with_lookup_disabled
+          post = ResourceNamespace::Post.new
+          serializer = with_serializer_lookup_disabled do
+            ActiveModel::Serializer.serializer_for(post)
+          end
+          assert_equal nil, serializer
+        end
+
+        def test_serializer_for_nested_resource
+          comment = ResourceNamespace::Comment.new
+          serializer = ResourceNamespace::PostSerializer.serializer_for(comment)
+          assert_equal ResourceNamespace::PostSerializer::CommentSerializer, serializer
+        end
+
+        def test_serializer_for_nested_resource_with_lookup_disabled
+          comment = ResourceNamespace::Comment.new
+          serializer = with_serializer_lookup_disabled do
+            ResourceNamespace::PostSerializer.serializer_for(comment)
+          end
+          assert_equal nil, serializer
+        end
+      end
+    end
+  end
+end

data/test/support/custom_schemas/active_model_serializers/test/schema_test/my/index.json

@@ -0,0 +1,6 @@
+{
+  "properties": {
+    "name" : { "type" : "string" },
+    "description" : { "type" : "string" }
+  }
+}

data/test/support/isolated_unit.rb

@@ -0,0 +1,79 @@
+# https://github.com/rails/rails/blob/v5.0.0.beta1/railties/test/isolation/abstract_unit.rb
+
+# Usage Example:
+#
+# require 'support/isolated_unit'
+#
+# class RailtieTest < ActiveSupport::TestCase
+#   include ActiveSupport::Testing::Isolation
+#
+#   class WithRailsDefinedOnLoad < RailtieTest
+#     setup do
+#       require 'rails'
+#       require 'active_model_serializers'
+#       make_basic_app
+#     end
+#
+#     # some tests
+#   end
+#
+#   class WithoutRailsDefinedOnLoad < RailtieTest
+#     setup do
+#       require 'active_model_serializers'
+#       make_basic_app
+#     end
+#
+#     # some tests
+#   end
+# end
+#
+# Note:
+# It is important to keep this file as light as possible
+# the goal for tests that require this is to test booting up
+# rails from an empty state, so anything added here could
+# hide potential failures
+#
+# It is also good to know what is the bare minimum to get
+# Rails booted up.
+require 'bundler/setup' unless defined?(Bundler)
+require 'active_support'
+require 'active_support/core_ext/string/access'
+
+# These files do not require any others and are needed
+# to run the tests
+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
+      require 'rails'
+      require 'action_controller/railtie'
+
+      @app = Class.new(Rails::Application) do
+        config.eager_load = false
+        config.session_store :cookie_store, key: '_myapp_session'
+        config.active_support.deprecation = :log
+        config.active_support.test_order = :parallel
+        ActiveSupport::TestCase.respond_to?(:test_order=) && ActiveSupport::TestCase.test_order = :parallel
+        config.root = File.dirname(__FILE__)
+        config.log_level = :info
+        # 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'
+
+      yield @app if block_given?
+      @app.initialize!
+    end
+  end
+end
+
+class ActiveSupport::TestCase
+  include TestHelpers::Generation
+end

data/test/support/rails5_shims.rb

@@ -0,0 +1,47 @@
+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].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 fold_kwargs!(args)
+      hash = args && args[0]
+      return unless hash.respond_to?(:key)
+      Rails5Shims::ControllerTests::REQUEST_KWARGS.each do |kwarg|
+        next unless hash.key?(kwarg)
+        hash.merge! hash.delete(kwarg)
+      end
+    end
+
+    # Uncomment for debugging where the kwargs warnings come from
+    # def non_kwarg_request_warning
+    #   super.tap do
+    #     STDOUT.puts caller[2..3]
+    #   end
+    # end
+  end
+end
+if Rails::VERSION::MAJOR < 5
+  ActionController::TestCase.send :include, Rails5Shims::ControllerTests
+end

data/test/support/rails_app.rb

@@ -0,0 +1,45 @@
+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
+
+    app.routes.default_url_options = { host: 'example.com' }
+  end
+end
+
+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
+
+  # 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/schemas/active_model_serializers/test/schema_test/my/index.json

@@ -0,0 +1,6 @@
+{
+  "properties": {
+    "name" : { "type" : "string" },
+    "description" : { "type" : "string" }
+  }
+}

data/test/support/schemas/active_model_serializers/test/schema_test/my/show.json

@@ -0,0 +1,6 @@
+{
+  "properties": {
+    "name" : { "type" : "integer" },
+    "description" : { "type" : "boolean" }
+  }
+}

data/test/support/schemas/custom/show.json

@@ -0,0 +1,7 @@
+{
+  "id": "file://custom/show.json#",
+  "properties": {
+    "name" : { "type" : "string" },
+    "description" : { "type" : "string" }
+  }
+}

data/test/support/schemas/hyper_schema.json

@@ -0,0 +1,93 @@
+{
+  "$schema": "http://json-schema.org/draft-04/hyper-schema",
+  "title": "Profile",
+  "description": "Profile schema",
+  "stability": "prototype",
+  "strictProperties": true,
+  "type": [
+    "object"
+  ],
+  "definitions": {
+    "name": {
+      "description": "unique name of profile",
+      "readOnly": true,
+      "type": [
+        "string"
+      ]
+    },
+    "description": {
+      "description": "description of profile",
+      "readOnly": true,
+      "type": [
+        "string"
+      ]
+    },
+    "identity": {
+      "anyOf": [
+        {
+          "$ref": "/schemata/profile#/definitions/name"
+        }
+      ]
+    }
+  },
+  "links": [
+    {
+      "description": "Create a new profile.",
+      "href": "/profiles",
+      "method": "POST",
+      "rel": "create",
+      "schema": {
+        "properties": {
+        },
+        "type": [
+          "object"
+        ]
+      },
+      "title": "Create"
+    },
+    {
+      "description": "Delete an existing profile.",
+      "href": "/profiles/{(%2Fschemata%2Fprofile%23%2Fdefinitions%2Fidentity)}",
+      "method": "DELETE",
+      "rel": "destroy",
+      "title": "Delete"
+    },
+    {
+      "description": "Info for existing profile.",
+      "href": "/profiles/{(%2Fschemata%2Fprofile%23%2Fdefinitions%2Fidentity)}",
+      "method": "GET",
+      "rel": "self",
+      "title": "Info"
+    },
+    {
+      "description": "List existing profiles.",
+      "href": "/profiles",
+      "method": "GET",
+      "rel": "instances",
+      "title": "List"
+    },
+    {
+      "description": "Update an existing profile.",
+      "href": "/profiles/{(%2Fschemata%2Fprofile%23%2Fdefinitions%2Fidentity)}",
+      "method": "PATCH",
+      "rel": "update",
+      "schema": {
+        "properties": {
+        },
+        "type": [
+          "object"
+        ]
+      },
+      "title": "Update"
+    }
+  ],
+  "properties": {
+    "name": {
+      "$ref": "/schemata/profile#/definitions/name"
+    },
+    "description": {
+      "$ref": "/schemata/profile#/definitions/description"
+    }
+  },
+  "id": "/schemata/profile"
+}

data/test/support/schemas/render_using_json_api.json

@@ -0,0 +1,43 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "id": "",
+  "type": "object",
+  "properties": {
+    "data": {
+      "id": "/data",
+      "type": "object",
+      "properties": {
+        "id": {
+          "id": "/data/id",
+          "type": "string"
+        },
+        "type": {
+          "id": "/data/type",
+          "type": "string"
+        },
+        "attributes": {
+          "id": "/data/attributes",
+          "type": "object",
+          "properties": {
+            "name": {
+              "id": "/data/attributes/name",
+              "type": "string"
+            },
+            "description": {
+              "id": "/data/attributes/description",
+              "type": "string"
+            }
+          }
+        }
+      },
+      "required": [
+        "id",
+        "type",
+        "attributes"
+      ]
+    }
+  },
+  "required": [
+    "data"
+  ]
+}

data/test/support/schemas/simple_json_pointers.json

@@ -0,0 +1,10 @@
+{
+  "properties": {
+    "name": {
+      "$ref": "file://custom/show.json#/properties/name"
+    },
+    "description": {
+      "$ref": "file://custom/show.json#/properties/description"
+    }
+  }
+}

data/test/support/serialization_testing.rb

@@ -0,0 +1,53 @@
+module SerializationTesting
+  def config
+    ActiveModelSerializers.config
+  end
+
+  private
+
+  def generate_cached_serializer(obj)
+    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>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
+    yield
+  ensure
+    ActiveModelSerializers.config.adapter = old_adapter
+  end
+  alias with_configured_adapter with_adapter
+
+  def with_config(hash)
+    old_config = config.dup
+    ActiveModelSerializers.config.update(hash)
+    yield
+  ensure
+    ActiveModelSerializers.config.replace(old_config)
+  end
+
+  def with_serializer_lookup_disabled
+    original_serializer_lookup = ActiveModelSerializers.config.serializer_lookup_enabled
+    ActiveModelSerializers.config.serializer_lookup_enabled = false
+    yield
+  ensure
+    ActiveModelSerializers.config.serializer_lookup_enabled = original_serializer_lookup
+  end
+
+  def serializable(resource, options = {})
+    ActiveModelSerializers::SerializableResource.new(resource, options)
+  end
+end
+
+class Minitest::Test
+  def before_setup
+    ActionController::Base.cache_store.clear
+  end
+
+  include SerializationTesting
+end

data/test/test_helper.rb

@@ -1,32 +1,57 @@
-require "rubygems"
-require "bundler/setup"
+# Configure Rails Environment
+ENV['RAILS_ENV'] = 'test'
+require 'bundler/setup'
 
-require "pry"
-
-require "active_model_serializers"
-require "active_support/json"
-require "minitest/autorun"
+begin
+  require 'simplecov'
+  AppCoverage.start
+rescue LoadError
+  STDERR.puts 'Running without SimpleCov'
+end
 
+require 'timecop'
 require 'rails'
+require 'action_controller'
+require 'action_controller/test_case'
+require 'action_controller/railtie'
+require 'active_model_serializers'
+# For now, we only restrict the options to serializable_hash/as_json/to_json
+# in tests, to ensure developers don't add any unsupported options.
+# There's no known benefit, at this time, to having the filtering run in
+# production when the excluded options would simply not be used.
+#
+# However, for documentation purposes, the constant
+# ActiveModel::Serializer::SERIALIZABLE_HASH_VALID_KEYS is defined
+# in the Serializer.
+ActiveModelSerializers::Adapter::Base.class_eval do
+  alias_method :original_serialization_options, :serialization_options
 
-module TestHelper
-  Routes = ActionDispatch::Routing::RouteSet.new
-  Routes.draw do
-    resource :hypermedia
-    get ':controller(/:action(/:id))'
-    get ':controller(/:action)'
+  def serialization_options(options)
+    original_serialization_options(options)
+      .slice(*ActiveModel::Serializer::SERIALIZABLE_HASH_VALID_KEYS)
   end
-
-  ActionController::Base.send :include, Routes.url_helpers
-  ActiveModel::Serializer.send :include, Routes.url_helpers
 end
+require 'fileutils'
+FileUtils.mkdir_p(File.expand_path('../../tmp/cache', __FILE__))
 
-ActiveSupport::TestCase.class_eval do
-  setup do
-    @routes = ::TestHelper::Routes
-  end
-end
+gem 'minitest'
+require 'minitest'
+require 'minitest/autorun'
+Minitest.backtrace_filter = Minitest::BacktraceFilter.new
+
+require 'support/rails_app'
+
+# require "rails/test_help"
+
+require 'support/serialization_testing'
+
+require 'support/rails5_shims'
+
+require 'fixtures/active_record'
+
+require 'fixtures/poro'
 
-class Object
-  undef_method :id if respond_to?(:id)
+ActiveSupport.on_load(:action_controller) do
+  $action_controller_logger = ActiveModelSerializers.logger
+  ActiveModelSerializers.logger = Logger.new(IO::NULL)
 end