agi_active_model_serializers 0.10.7

data/test/active_model_serializers/adapter_for_test.rb

@@ -0,0 +1,208 @@
+require 'test_helper'
+
+module ActiveModelSerializers
+  class AdapterForTest < ::ActiveSupport::TestCase
+    UnknownAdapterError = ::ActiveModelSerializers::Adapter::UnknownAdapterError
+
+    def test_serializer_adapter_returns_configured_adapter
+      assert_output(nil, /ActiveModelSerializers::Adapter.configured_adapter/) do
+        assert_equal ActiveModelSerializers::Adapter.configured_adapter, ActiveModel::Serializer.adapter
+      end
+    end
+
+    def test_returns_default_adapter
+      with_adapter_config_setup do
+        adapter = ActiveModelSerializers::Adapter.configured_adapter
+        assert_equal ActiveModelSerializers::Adapter::Attributes, adapter
+      end
+    end
+
+    def test_overwrite_adapter_with_symbol
+      with_adapter_config_setup do
+        ActiveModelSerializers.config.adapter = :null
+
+        adapter = ActiveModelSerializers::Adapter.configured_adapter
+        assert_equal ActiveModelSerializers::Adapter::Null, adapter
+      end
+    end
+
+    def test_overwrite_adapter_with_camelcased_symbol
+      with_adapter_config_setup do
+        ActiveModelSerializers.config.adapter = :JsonApi
+
+        adapter = ActiveModelSerializers::Adapter.configured_adapter
+        assert_equal ActiveModelSerializers::Adapter::JsonApi, adapter
+      end
+    end
+
+    def test_overwrite_adapter_with_string
+      with_adapter_config_setup do
+        ActiveModelSerializers.config.adapter = 'json_api'
+
+        adapter = ActiveModelSerializers::Adapter.configured_adapter
+        assert_equal ActiveModelSerializers::Adapter::JsonApi, adapter
+      end
+    end
+
+    def test_overwrite_adapter_with_a_camelcased_string
+      with_adapter_config_setup do
+        ActiveModelSerializers.config.adapter = 'JsonApi'
+
+        adapter = ActiveModelSerializers::Adapter.configured_adapter
+        assert_equal ActiveModelSerializers::Adapter::JsonApi, adapter
+      end
+    end
+
+    def test_overwrite_adapter_with_class
+      with_adapter_config_setup do
+        ActiveModelSerializers.config.adapter = ActiveModelSerializers::Adapter::Null
+
+        adapter = ActiveModelSerializers::Adapter.configured_adapter
+        assert_equal ActiveModelSerializers::Adapter::Null, adapter
+      end
+    end
+
+    def test_raises_exception_if_invalid_symbol_given
+      with_adapter_config_setup do
+        ActiveModelSerializers.config.adapter = :unknown
+
+        assert_raises UnknownAdapterError do
+          ActiveModelSerializers::Adapter.configured_adapter
+        end
+      end
+    end
+
+    def test_raises_exception_if_it_does_not_know_hot_to_infer_adapter
+      with_adapter_config_setup do
+        ActiveModelSerializers.config.adapter = 42
+
+        assert_raises UnknownAdapterError do
+          ActiveModelSerializers::Adapter.configured_adapter
+        end
+      end
+    end
+
+    def test_adapter_class_for_known_adapter
+      klass = ActiveModelSerializers::Adapter.adapter_class(:json_api)
+      assert_equal ActiveModelSerializers::Adapter::JsonApi, klass
+    end
+
+    def test_adapter_class_for_unknown_adapter
+      assert_raises UnknownAdapterError do
+        ActiveModelSerializers::Adapter.adapter_class(:json_simple)
+      end
+    end
+
+    def test_adapter_map
+      expected_adapter_map = {
+        'null'.freeze              => ActiveModelSerializers::Adapter::Null,
+        'json'.freeze              => ActiveModelSerializers::Adapter::Json,
+        'attributes'.freeze => ActiveModelSerializers::Adapter::Attributes,
+        'json_api'.freeze => ActiveModelSerializers::Adapter::JsonApi
+      }
+      actual = ActiveModelSerializers::Adapter.adapter_map
+      assert_equal actual, expected_adapter_map
+    end
+
+    def test_adapters
+      assert_equal ActiveModelSerializers::Adapter.adapters.sort, [
+        'attributes'.freeze,
+        'json'.freeze,
+        'json_api'.freeze,
+        'null'.freeze
+      ]
+    end
+
+    def test_lookup_adapter_by_string_name
+      assert_equal ActiveModelSerializers::Adapter.lookup('json'.freeze), ActiveModelSerializers::Adapter::Json
+    end
+
+    def test_lookup_adapter_by_symbol_name
+      assert_equal ActiveModelSerializers::Adapter.lookup(:json), ActiveModelSerializers::Adapter::Json
+    end
+
+    def test_lookup_adapter_by_class
+      klass = ActiveModelSerializers::Adapter::Json
+      assert_equal ActiveModelSerializers::Adapter.lookup(klass), klass
+    end
+
+    def test_lookup_adapter_from_environment_registers_adapter
+      ActiveModelSerializers::Adapter.const_set(:AdapterFromEnvironment, Class.new)
+      klass = ::ActiveModelSerializers::Adapter::AdapterFromEnvironment
+      name = 'adapter_from_environment'.freeze
+      assert_equal ActiveModelSerializers::Adapter.lookup(name), klass
+      assert ActiveModelSerializers::Adapter.adapters.include?(name)
+    ensure
+      ActiveModelSerializers::Adapter.adapter_map.delete(name)
+      ActiveModelSerializers::Adapter.send(:remove_const, :AdapterFromEnvironment)
+    end
+
+    def test_lookup_adapter_for_unknown_name
+      assert_raises UnknownAdapterError do
+        ActiveModelSerializers::Adapter.lookup(:json_simple)
+      end
+    end
+
+    def test_adapter
+      assert_equal ActiveModelSerializers.config.adapter, :attributes
+      assert_equal ActiveModelSerializers::Adapter.configured_adapter, ActiveModelSerializers::Adapter::Attributes
+    end
+
+    def test_register_adapter
+      new_adapter_name  = :foo
+      new_adapter_klass = Class.new
+      ActiveModelSerializers::Adapter.register(new_adapter_name, new_adapter_klass)
+      assert ActiveModelSerializers::Adapter.adapters.include?('foo'.freeze)
+      assert ActiveModelSerializers::Adapter.lookup(:foo), new_adapter_klass
+    ensure
+      ActiveModelSerializers::Adapter.adapter_map.delete(new_adapter_name.to_s)
+    end
+
+    def test_inherited_adapter_hooks_register_adapter
+      Object.const_set(:MyAdapter, Class.new)
+      my_adapter = MyAdapter
+      ActiveModelSerializers::Adapter::Base.inherited(my_adapter)
+      assert_equal ActiveModelSerializers::Adapter.lookup(:my_adapter), my_adapter
+    ensure
+      ActiveModelSerializers::Adapter.adapter_map.delete('my_adapter'.freeze)
+      Object.send(:remove_const, :MyAdapter)
+    end
+
+    def test_inherited_adapter_hooks_register_namespaced_adapter
+      Object.const_set(:MyNamespace, Module.new)
+      MyNamespace.const_set(:MyAdapter, Class.new)
+      my_adapter = MyNamespace::MyAdapter
+      ActiveModelSerializers::Adapter::Base.inherited(my_adapter)
+      assert_equal ActiveModelSerializers::Adapter.lookup(:'my_namespace/my_adapter'), my_adapter
+    ensure
+      ActiveModelSerializers::Adapter.adapter_map.delete('my_namespace/my_adapter'.freeze)
+      MyNamespace.send(:remove_const, :MyAdapter)
+      Object.send(:remove_const, :MyNamespace)
+    end
+
+    def test_inherited_adapter_hooks_register_subclass_of_registered_adapter
+      Object.const_set(:MyAdapter, Class.new)
+      my_adapter = MyAdapter
+      Object.const_set(:MySubclassedAdapter, Class.new(MyAdapter))
+      my_subclassed_adapter = MySubclassedAdapter
+      ActiveModelSerializers::Adapter::Base.inherited(my_adapter)
+      ActiveModelSerializers::Adapter::Base.inherited(my_subclassed_adapter)
+      assert_equal ActiveModelSerializers::Adapter.lookup(:my_adapter), my_adapter
+      assert_equal ActiveModelSerializers::Adapter.lookup(:my_subclassed_adapter), my_subclassed_adapter
+    ensure
+      ActiveModelSerializers::Adapter.adapter_map.delete('my_adapter'.freeze)
+      ActiveModelSerializers::Adapter.adapter_map.delete('my_subclassed_adapter'.freeze)
+      Object.send(:remove_const, :MyAdapter)
+      Object.send(:remove_const, :MySubclassedAdapter)
+    end
+
+    private
+
+    def with_adapter_config_setup
+      previous_adapter = ActiveModelSerializers.config.adapter
+      yield
+    ensure
+      ActiveModelSerializers.config.adapter = previous_adapter
+    end
+  end
+end

data/test/active_model_serializers/json_pointer_test.rb

@@ -0,0 +1,22 @@
+require 'test_helper'
+
+module ActiveModelSerializers
+  class JsonPointerTest < ActiveSupport::TestCase
+    def test_attribute_pointer
+      attribute_name = 'title'
+      pointer = ActiveModelSerializers::JsonPointer.new(:attribute, attribute_name)
+      assert_equal '/data/attributes/title', pointer
+    end
+
+    def test_primary_data_pointer
+      pointer = ActiveModelSerializers::JsonPointer.new(:primary_data)
+      assert_equal '/data', pointer
+    end
+
+    def test_unknown_data_pointer
+      assert_raises(TypeError) do
+        ActiveModelSerializers::JsonPointer.new(:unknown)
+      end
+    end
+  end
+end

data/test/active_model_serializers/logging_test.rb

@@ -0,0 +1,77 @@
+require 'test_helper'
+
+module ActiveModel
+  class Serializer
+    class LoggingTest < ActiveSupport::TestCase
+      class TestLogger < ActiveSupport::Logger
+        def initialize
+          @file = StringIO.new
+          super(@file)
+        end
+
+        def messages
+          @file.rewind
+          @file.read
+        end
+      end
+
+      def setup
+        @author = Author.new(name: 'Steve K.')
+        @post = Post.new(title: 'New Post', body: 'Body')
+        @comment = Comment.new(id: 1, body: 'ZOMG A COMMENT')
+        @post.comments = [@comment]
+        @comment.post = @post
+        @post.author = @author
+        @author.posts = [@post]
+        @post_serializer = PostSerializer.new(@post, custom_options: true)
+
+        @old_logger = ActiveModelSerializers.logger
+        @logger = ActiveSupport::TaggedLogging.new(TestLogger.new)
+        logger @logger
+      end
+
+      def teardown
+        logger @old_logger
+      end
+
+      def logger(logger)
+        ActiveModelSerializers.logger = logger
+      end
+
+      def test_uses_ams_as_tag
+        ActiveModelSerializers::SerializableResource.new(@post).serializable_hash
+        assert_match(/\[active_model_serializers\]/, @logger.messages)
+      end
+
+      def test_logs_when_call_serializable_hash
+        ActiveModelSerializers::SerializableResource.new(@post).serializable_hash
+        assert_match(/Rendered/, @logger.messages)
+      end
+
+      def test_logs_when_call_as_json
+        ActiveModelSerializers::SerializableResource.new(@post).as_json
+        assert_match(/Rendered/, @logger.messages)
+      end
+
+      def test_logs_when_call_to_json
+        ActiveModelSerializers::SerializableResource.new(@post).to_json
+        assert_match(/Rendered/, @logger.messages)
+      end
+
+      def test_logs_correct_serializer
+        ActiveModelSerializers::SerializableResource.new(@post).serializable_hash
+        assert_match(/PostSerializer/, @logger.messages)
+      end
+
+      def test_logs_correct_adapter
+        ActiveModelSerializers::SerializableResource.new(@post).serializable_hash
+        assert_match(/ActiveModelSerializers::Adapter::Attributes/, @logger.messages)
+      end
+
+      def test_logs_the_duration
+        ActiveModelSerializers::SerializableResource.new(@post).serializable_hash
+        assert_match(/\(\d+\.\d+ms\)/, @logger.messages)
+      end
+    end
+  end
+end

data/test/active_model_serializers/model_test.rb

@@ -0,0 +1,69 @@
+require 'test_helper'
+
+module ActiveModelSerializers
+  class ModelTest < ActiveSupport::TestCase
+    include ActiveModel::Serializer::Lint::Tests
+
+    setup do
+      @resource = ActiveModelSerializers::Model.new
+    end
+
+    def test_initialization_with_string_keys
+      klass = Class.new(ActiveModelSerializers::Model) do
+        attributes :key
+      end
+      value = 'value'
+
+      model_instance = klass.new('key' => value)
+
+      assert_equal model_instance.read_attribute_for_serialization(:key), value
+    end
+
+    def test_attributes_can_be_read_for_serialization
+      klass = Class.new(ActiveModelSerializers::Model) do
+        attributes :one, :two, :three
+      end
+      original_attributes = { one: 1, two: 2, three: 3 }
+      instance = klass.new(original_attributes)
+
+      # Initial value
+      expected_attributes = { id: nil, one: 1, two: 2, three: 3 }.with_indifferent_access
+      assert_equal expected_attributes, instance.attributes
+      assert_equal 1, instance.one
+      assert_equal 1, instance.read_attribute_for_serialization(:one)
+
+      # Change via accessor
+      instance.one = :not_one
+
+      expected_attributes = { id: nil, one: :not_one, two: 2, three: 3 }.with_indifferent_access
+      assert_equal expected_attributes, instance.attributes
+      assert_equal :not_one, instance.one
+      assert_equal :not_one, instance.read_attribute_for_serialization(:one)
+    end
+
+    def test_id_attribute_can_be_read_for_serialization
+      klass = Class.new(ActiveModelSerializers::Model) do
+        attributes :id, :one, :two, :three
+      end
+      self.class.const_set(:SomeTestModel, klass)
+      original_attributes = { id: :ego, one: 1, two: 2, three: 3 }
+      instance = klass.new(original_attributes)
+
+      # Initial value
+      expected_attributes = { id: :ego, one: 1, two: 2, three: 3 }.with_indifferent_access
+      assert_equal expected_attributes, instance.attributes
+      assert_equal 1, instance.one
+      assert_equal 1, instance.read_attribute_for_serialization(:one)
+
+      # Change via accessor
+      instance.id = :superego
+
+      expected_attributes = { id: :superego, one: 1, two: 2, three: 3 }.with_indifferent_access
+      assert_equal expected_attributes, instance.attributes
+      assert_equal :superego, instance.id
+      assert_equal :superego, instance.read_attribute_for_serialization(:id)
+    ensure
+      self.class.send(:remove_const, :SomeTestModel)
+    end
+  end
+end

data/test/active_model_serializers/railtie_test_isolated.rb

@@ -0,0 +1,63 @@
+# Execute this test in isolation
+require 'support/isolated_unit'
+
+class RailtieTest < ActiveSupport::TestCase
+  include ActiveSupport::Testing::Isolation
+
+  class WithRails < RailtieTest
+    setup do
+      require 'rails'
+      require 'active_model_serializers'
+      make_basic_app
+    end
+
+    test 'mixes ActionController::Serialization into ActionController::Base' do
+      assert ActionController.const_defined?(:Serialization),
+        "ActionController::Serialization should be defined, but isn't"
+      assert ::ActionController::Base.included_modules.include?(::ActionController::Serialization),
+        "ActionController::Serialization should be included in ActionController::Base, but isn't"
+    end
+
+    test 'prepares url_helpers for SerializationContext' do
+      assert ActiveModelSerializers::SerializationContext.url_helpers.respond_to? :url_for
+      assert_equal Rails.application.routes.default_url_options,
+        ActiveModelSerializers::SerializationContext.default_url_options
+    end
+
+    test 'sets the ActiveModelSerializers.logger to Rails.logger' do
+      refute_nil Rails.logger
+      refute_nil ActiveModelSerializers.logger
+      assert_equal Rails.logger, ActiveModelSerializers.logger
+    end
+
+    test 'it is configured for caching' do
+      assert_equal ActionController::Base.cache_store, ActiveModelSerializers.config.cache_store
+      assert_equal Rails.configuration.action_controller.perform_caching, ActiveModelSerializers.config.perform_caching
+    end
+  end
+
+  class WithoutRails < RailtieTest
+    setup do
+      require 'active_model_serializers'
+      make_basic_app
+    end
+
+    test 'does not mix ActionController::Serialization into ActionController::Base' do
+      refute ActionController.const_defined?(:Serialization),
+        'ActionController::Serialization should not be defined, but is'
+    end
+
+    test 'has its own logger at ActiveModelSerializers.logger' do
+      refute_nil Rails.logger
+      refute_nil ActiveModelSerializers.logger
+      refute_equal Rails.logger, ActiveModelSerializers.logger
+    end
+
+    test 'it is not configured for caching' do
+      refute_nil ActionController::Base.cache_store
+      assert_nil ActiveModelSerializers.config.cache_store
+      refute Rails.configuration.action_controller.perform_caching
+      refute ActiveModelSerializers.config.perform_caching
+    end
+  end
+end

data/test/active_model_serializers/register_jsonapi_renderer_test_isolated.rb

@@ -0,0 +1,161 @@
+require 'support/isolated_unit'
+require 'minitest/mock'
+require 'action_dispatch'
+require 'action_controller'
+
+class JsonApiRendererTest < ActionDispatch::IntegrationTest
+  include ActiveSupport::Testing::Isolation
+
+  class TestController < ActionController::Base
+    class << self
+      attr_accessor :last_request_parameters
+    end
+
+    def render_with_jsonapi_renderer
+      permitted_params = params.permit(data: [:id, :type, attributes: [:name]])
+      permitted_params = permitted_params.to_h.with_indifferent_access
+      attributes =
+        if permitted_params[:data]
+          permitted_params[:data][:attributes].merge(id: permitted_params[:data][:id])
+        else
+          # Rails returns empty params when no mime type can be negotiated.
+          # (Until https://github.com/rails/rails/pull/26632 is reviewed.)
+          permitted_params
+        end
+      author = Author.new(attributes)
+      render jsonapi: author
+    end
+
+    def parse
+      self.class.last_request_parameters = request.request_parameters
+      head :ok
+    end
+  end
+
+  def teardown
+    TestController.last_request_parameters = nil
+  end
+
+  def assert_parses(expected, actual, headers = {})
+    post '/parse', params: actual, headers: headers
+    assert_response :ok
+    assert_equal(expected, TestController.last_request_parameters)
+  end
+
+  def define_author_model_and_serializer
+    TestController.const_set(:Author, Class.new(ActiveModelSerializers::Model) do
+      attributes :name
+    end)
+    TestController.const_set(:AuthorSerializer, Class.new(ActiveModel::Serializer) do
+      type 'users'
+      attribute :id
+      attribute :name
+    end)
+  end
+
+  class WithoutRenderer < JsonApiRendererTest
+    setup do
+      require 'rails'
+      require 'active_record'
+      require 'support/rails5_shims'
+      require 'active_model_serializers'
+      require 'fixtures/poro'
+
+      make_basic_app
+
+      Rails.application.routes.draw do
+        ActiveSupport::Deprecation.silence do
+          match ':action', to: TestController, via: [:get, :post]
+        end
+      end
+      define_author_model_and_serializer
+    end
+
+    def test_jsonapi_parser_not_registered
+      parsers = if Rails::VERSION::MAJOR >= 5
+                  ActionDispatch::Request.parameter_parsers
+                else
+                  ActionDispatch::ParamsParser::DEFAULT_PARSERS
+                end
+      assert_nil parsers[Mime[:jsonapi]]
+    end
+
+    def test_jsonapi_renderer_not_registered
+      payload = '{"data": {"attributes": {"name": "Johnny Rico"}, "type": "users", "id": "36c9c04e-86b1-4636-a5b0-8616672d1765"}}'
+      headers = { 'CONTENT_TYPE' => 'application/vnd.api+json' }
+      post '/render_with_jsonapi_renderer', params: payload, headers: headers
+      assert_equal '', response.body
+      assert_equal 500, response.status
+      assert_equal ActionView::MissingTemplate, request.env['action_dispatch.exception'].class
+    end
+
+    def test_jsonapi_parser
+      assert_parses(
+        {},
+        '',
+        'CONTENT_TYPE' => 'application/vnd.api+json'
+      )
+    end
+  end
+
+  class WithRenderer < JsonApiRendererTest
+    setup do
+      require 'rails'
+      require 'active_record'
+      require 'support/rails5_shims'
+      require 'active_model_serializers'
+      require 'fixtures/poro'
+      require 'active_model_serializers/register_jsonapi_renderer'
+
+      make_basic_app
+
+      Rails.application.routes.draw do
+        ActiveSupport::Deprecation.silence do
+          match ':action', to: TestController, via: [:get, :post]
+        end
+      end
+      define_author_model_and_serializer
+    end
+
+    def test_jsonapi_parser_registered
+      if Rails::VERSION::MAJOR >= 5
+        parsers = ActionDispatch::Request.parameter_parsers
+        assert_equal Proc, parsers[:jsonapi].class
+      else
+        parsers = ActionDispatch::ParamsParser::DEFAULT_PARSERS
+        assert_equal Proc, parsers[Mime[:jsonapi]].class
+      end
+    end
+
+    def test_jsonapi_renderer_registered
+      expected = {
+        'data' => {
+          'id' => '36c9c04e-86b1-4636-a5b0-8616672d1765',
+          'type' => 'users',
+          'attributes' => { 'name' => 'Johnny Rico' }
+        }
+      }
+
+      payload = '{"data": {"attributes": {"name": "Johnny Rico"}, "type": "users", "id": "36c9c04e-86b1-4636-a5b0-8616672d1765"}}'
+      headers = { 'CONTENT_TYPE' => 'application/vnd.api+json' }
+      post '/render_with_jsonapi_renderer', params: payload, headers: headers
+      assert_equal expected.to_json, response.body
+    end
+
+    def test_jsonapi_parser
+      assert_parses(
+        {
+          'data' => {
+            'attributes' => {
+              'name' => 'John Doe'
+            },
+            'type' => 'users',
+            'id' => '36c9c04e-86b1-4636-a5b0-8616672d1765'
+          }
+        },
+        '{"data": {"attributes": {"name": "John Doe"}, "type": "users", "id": "36c9c04e-86b1-4636-a5b0-8616672d1765"}}',
+        'CONTENT_TYPE' => 'application/vnd.api+json'
+      )
+    end
+  end
+end