active_model_serializers 0.10.0 → 0.10.5

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 :id, :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

data/test/active_model_serializers/serialization_context_test_isolated.rb

@@ -5,13 +5,19 @@ require 'minitest/mock'
 class SerializationContextTest < ActiveSupport::TestCase
   include ActiveSupport::Testing::Isolation
 
-  def create_request
-    request = Minitest::Mock.new
-    request.expect(:original_url, 'original_url')
-    request.expect(:query_parameters, 'query_parameters')
-  end
-
   class WithRails < SerializationContextTest
+    def create_request
+      request = ActionDispatch::Request.new({})
+      def request.original_url
+        'http://example.com/articles?page=2'
+      end
+
+      def request.query_parameters
+        { 'page' => 2 }
+      end
+      request
+    end
+
     setup do
       require 'rails'
       require 'active_model_serializers'
@@ -20,8 +26,8 @@ class SerializationContextTest < ActiveSupport::TestCase
     end
 
     test 'create context with request url and query parameters' do
-      assert_equal @context.request_url, 'original_url'
-      assert_equal @context.query_parameters, 'query_parameters'
+      assert_equal @context.request_url, 'http://example.com/articles'
+      assert_equal @context.query_parameters, 'page' => 2
     end
 
     test 'url_helpers is set up for Rails url_helpers' do
@@ -36,14 +42,21 @@ class SerializationContextTest < ActiveSupport::TestCase
   end
 
   class WithoutRails < SerializationContextTest
+    def create_request
+      {
+        request_url: 'http://example.com/articles',
+        query_parameters: { 'page' => 2 }
+      }
+    end
+
     setup do
       require 'active_model_serializers/serialization_context'
       @context = ActiveModelSerializers::SerializationContext.new(create_request)
     end
 
     test 'create context with request url and query parameters' do
-      assert_equal @context.request_url, 'original_url'
-      assert_equal @context.query_parameters, 'query_parameters'
+      assert_equal @context.request_url, 'http://example.com/articles'
+      assert_equal @context.query_parameters, 'page' => 2
     end
 
     test 'url_helpers is a module when Rails is not present' do

data/test/active_model_serializers/test/schema_test.rb

@@ -115,7 +115,8 @@ module ActiveModelSerializers
       end
 
       def test_that_raises_with_a_invalid_json_body
-        message = 'A JSON text must at least contain two octets!'
+        # message changes from JSON gem 2.0.2 to 2.2.0
+        message = /A JSON text must at least contain two octets!|unexpected token at ''/
 
         get :invalid_json_body
 
@@ -123,7 +124,7 @@ module ActiveModelSerializers
           assert_response_schema('custom/show.json')
         end
 
-        assert_equal(message, error.message)
+        assert_match(message, error.message)
       end
     end
   end

data/test/adapter/attributes_test.rb

@@ -0,0 +1,40 @@
+require 'test_helper'
+
+module ActiveModelSerializers
+  module Adapter
+    class AttributesTest < ActiveSupport::TestCase
+      class Person < ActiveModelSerializers::Model
+        attributes :first_name, :last_name
+      end
+
+      class PersonSerializer < ActiveModel::Serializer
+        attributes :first_name, :last_name
+      end
+
+      def setup
+        ActionController::Base.cache_store.clear
+      end
+
+      def test_serializable_hash
+        person = Person.new(first_name: 'Arthur', last_name: 'Dent')
+        serializer = PersonSerializer.new(person)
+        adapter = ActiveModelSerializers::Adapter::Attributes.new(serializer)
+
+        assert_equal({ first_name: 'Arthur', last_name: 'Dent' },
+          adapter.serializable_hash)
+      end
+
+      def test_serializable_hash_with_transform_key_casing
+        person = Person.new(first_name: 'Arthur', last_name: 'Dent')
+        serializer = PersonSerializer.new(person)
+        adapter = ActiveModelSerializers::Adapter::Attributes.new(
+          serializer,
+          key_transform: :camel_lower
+        )
+
+        assert_equal({ firstName: 'Arthur', lastName: 'Dent' },
+          adapter.serializable_hash)
+      end
+    end
+  end
+end

data/test/adapter/json/collection_test.rb

@@ -84,6 +84,20 @@ module ActiveModelSerializers
 
           assert_equal(expected, actual)
         end
+
+        def test_fields_with_no_associations_include_option
+          actual = ActiveModelSerializers::SerializableResource.new(
+            [@first_post, @second_post], adapter: :json, fields: [:id], include: []
+          ).as_json
+
+          expected = { posts: [{
+            id: 1
+          }, {
+            id: 2
+          }] }
+
+          assert_equal(expected, actual)
+        end
       end
     end
   end

data/test/adapter/json/has_many_test.rb

@@ -4,6 +4,10 @@ module ActiveModelSerializers
   module Adapter
     class Json
       class HasManyTestTest < ActiveSupport::TestCase
+        class ModelWithoutSerializer < ::Model
+          attributes :id, :name
+        end
+
         def setup
           ActionController::Base.cache_store.clear
           @author = Author.new(id: 1, name: 'Steve K.')
@@ -16,7 +20,7 @@ module ActiveModelSerializers
           @second_comment.post = @post
           @blog = Blog.new(id: 1, name: 'My Blog!!')
           @post.blog = @blog
-          @tag = Tag.new(id: 1, name: '#hash_tag')
+          @tag = ModelWithoutSerializer.new(id: 1, name: '#hash_tag')
           @post.tags = [@tag]
         end
 
@@ -30,7 +34,11 @@ module ActiveModelSerializers
         end
 
         def test_has_many_with_no_serializer
-          serializer = PostWithTagsSerializer.new(@post)
+          post_serializer_class = Class.new(ActiveModel::Serializer) do
+            attributes :id
+            has_many :tags
+          end
+          serializer = post_serializer_class.new(@post)
           adapter = ActiveModelSerializers::Adapter::Json.new(serializer)
           assert_equal({
             id: 42,

data/test/adapter/json/transform_test.rb

@@ -15,7 +15,7 @@ module ActiveModelSerializers
           @adapter = ActiveModelSerializers::Adapter::Json.new(serializer, options)
         end
 
-        Post = Class.new(::Model)
+        class Post < ::Model; end
         class PostSerializer < ActiveModel::Serializer
           attributes :id, :title, :body, :publish_at
         end
@@ -28,8 +28,8 @@ module ActiveModelSerializers
         def test_transform_default
           mock_request
           assert_equal({
-            blog: { id: 1, special_attribute: 'neat', articles: nil }
-          }, @adapter.serializable_hash)
+                         blog: { id: 1, special_attribute: 'neat', articles: nil }
+                       }, @adapter.serializable_hash)
         end
 
         def test_transform_global_config
@@ -38,8 +38,8 @@ module ActiveModelSerializers
             @adapter.serializable_hash
           end
           assert_equal({
-            blog: { id: 1, specialAttribute: 'neat', articles: nil }
-          }, result)
+                         blog: { id: 1, specialAttribute: 'neat', articles: nil }
+                       }, result)
         end
 
         def test_transform_serialization_ctx_overrides_global_config
@@ -48,8 +48,8 @@ module ActiveModelSerializers
             @adapter.serializable_hash
           end
           assert_equal({
-            Blog: { Id: 1, SpecialAttribute: 'neat', Articles: nil }
-          }, result)
+                         Blog: { Id: 1, SpecialAttribute: 'neat', Articles: nil }
+                       }, result)
         end
 
         def test_transform_undefined
@@ -63,29 +63,29 @@ module ActiveModelSerializers
         def test_transform_dash
           mock_request(:dash)
           assert_equal({
-            blog: { id: 1, :"special-attribute" => 'neat', articles: nil }
-          }, @adapter.serializable_hash)
+                         blog: { id: 1, :"special-attribute" => 'neat', articles: nil }
+                       }, @adapter.serializable_hash)
         end
 
         def test_transform_unaltered
           mock_request(:unaltered)
           assert_equal({
-            blog: { id: 1, special_attribute: 'neat', articles: nil }
-          }, @adapter.serializable_hash)
+                         blog: { id: 1, special_attribute: 'neat', articles: nil }
+                       }, @adapter.serializable_hash)
         end
 
         def test_transform_camel
           mock_request(:camel)
           assert_equal({
-            Blog: { Id: 1, SpecialAttribute: 'neat', Articles: nil }
-          }, @adapter.serializable_hash)
+                         Blog: { Id: 1, SpecialAttribute: 'neat', Articles: nil }
+                       }, @adapter.serializable_hash)
         end
 
         def test_transform_camel_lower
           mock_request(:camel_lower)
           assert_equal({
-            blog: { id: 1, specialAttribute: 'neat', articles: nil }
-          }, @adapter.serializable_hash)
+                         blog: { id: 1, specialAttribute: 'neat', articles: nil }
+                       }, @adapter.serializable_hash)
         end
       end
     end

data/test/adapter/json_api/collection_test.rb

@@ -58,9 +58,10 @@ module ActiveModelSerializers
 
         def test_limiting_fields
           actual = ActiveModelSerializers::SerializableResource.new(
-            [@first_post, @second_post], adapter: :json_api,
-                                         fields: { posts: %w(title comments blog author) })
-                                                               .serializable_hash
+            [@first_post, @second_post],
+            adapter: :json_api,
+            fields: { posts: %w(title comments blog author) }
+          ).serializable_hash
           expected = [
             {
               id: '1',

data/test/adapter/json_api/errors_test.rb

@@ -12,8 +12,8 @@ module ActiveModelSerializers
 
         def test_active_model_with_error
           options = {
-              serializer: ActiveModel::Serializer::ErrorSerializer,
-              adapter: :json_api
+            serializer: ActiveModel::Serializer::ErrorSerializer,
+            adapter: :json_api
           }
 
           @resource.errors.add(:name, 'cannot be nil')
@@ -22,22 +22,21 @@ module ActiveModelSerializers
           assert_equal serializable_resource.serializer_instance.attributes, {}
           assert_equal serializable_resource.serializer_instance.object, @resource
 
-          expected_errors_object =
-            { :errors =>
-              [
-                {
-                  source: { pointer: '/data/attributes/name' },
-                  detail: 'cannot be nil'
-                }
-              ]
+          expected_errors_object = {
+            errors: [
+              {
+                source: { pointer: '/data/attributes/name' },
+                detail: 'cannot be nil'
+              }
+            ]
           }
           assert_equal serializable_resource.as_json, expected_errors_object
         end
 
         def test_active_model_with_multiple_errors
           options = {
-              serializer: ActiveModel::Serializer::ErrorSerializer,
-              adapter: :json_api
+            serializer: ActiveModel::Serializer::ErrorSerializer,
+            adapter: :json_api
           }
 
           @resource.errors.add(:name, 'cannot be nil')
@@ -48,13 +47,12 @@ module ActiveModelSerializers
           assert_equal serializable_resource.serializer_instance.attributes, {}
           assert_equal serializable_resource.serializer_instance.object, @resource
 
-          expected_errors_object =
-            { :errors =>
-              [
-                { :source => { :pointer => '/data/attributes/name' }, :detail => 'cannot be nil' },
-                { :source => { :pointer => '/data/attributes/name' }, :detail => 'must be longer' },
-                { :source => { :pointer => '/data/attributes/id' }, :detail => 'must be a uuid' }
-              ]
+          expected_errors_object = {
+            errors: [
+              { source: { pointer: '/data/attributes/name' }, detail: 'cannot be nil' },
+              { source: { pointer: '/data/attributes/name' }, detail: 'must be longer' },
+              { source: { pointer: '/data/attributes/id' }, detail: 'must be a uuid' }
+            ]
           }
           assert_equal serializable_resource.as_json, expected_errors_object
         end

data/test/adapter/json_api/fields_test.rb

@@ -4,7 +4,18 @@ module ActiveModelSerializers
   module Adapter
     class JsonApi
       class FieldsTest < ActiveSupport::TestCase
-        Post = Class.new(::Model)
+        class Post < ::Model
+          attributes :title, :body
+          associations :author, :comments
+        end
+        class Author < ::Model
+          attributes :name, :birthday
+        end
+        class Comment < ::Model
+          attributes :body
+          associations :author, :post
+        end
+
         class PostSerializer < ActiveModel::Serializer
           type 'posts'
           attributes :title, :body
@@ -12,13 +23,11 @@ module ActiveModelSerializers
           has_many :comments
         end
 
-        Author = Class.new(::Model)
         class AuthorSerializer < ActiveModel::Serializer
           type 'authors'
           attributes :name, :birthday
         end
 
-        Comment = Class.new(::Model)
         class CommentSerializer < ActiveModel::Serializer
           type 'comments'
           attributes :body

data/test/adapter/json_api/has_many_test.rb

@@ -4,6 +4,10 @@ module ActiveModelSerializers
   module Adapter
     class JsonApi
       class HasManyTest < ActiveSupport::TestCase
+        class ModelWithoutSerializer < ::Model
+          attributes :id, :name
+        end
+
         def setup
           ActionController::Base.cache_store.clear
           @author = Author.new(id: 1, name: 'Steve K.')
@@ -26,7 +30,7 @@ module ActiveModelSerializers
           @blog.articles = [@post]
           @post.blog = @blog
           @post_without_comments.blog = nil
-          @tag = Tag.new(id: 1, name: '#hash_tag')
+          @tag = ModelWithoutSerializer.new(id: 1, name: '#hash_tag')
           @post.tags = [@tag]
           @serializer = PostSerializer.new(@post)
           @adapter = ActiveModelSerializers::Adapter::JsonApi.new(@serializer)
@@ -40,6 +44,27 @@ module ActiveModelSerializers
           assert_equal(expected, @adapter.serializable_hash[:data][:relationships][:comments])
         end
 
+        test 'relationships can be whitelisted via fields' do
+          @adapter = ActiveModelSerializers::Adapter::JsonApi.new(@serializer, fields: { posts: [:author] })
+          result = @adapter.serializable_hash
+          expected = {
+            data: {
+              id: '1',
+              type: 'posts',
+              relationships: {
+                author: {
+                  data: {
+                    id: '1',
+                    type: 'authors'
+                  }
+                }
+              }
+            }
+          }
+
+          assert_equal expected, result
+        end
+
         def test_includes_linked_comments
           @adapter = ActiveModelSerializers::Adapter::JsonApi.new(@serializer, include: [:comments])
           expected = [{
@@ -108,18 +133,22 @@ module ActiveModelSerializers
         end
 
         def test_has_many_with_no_serializer
-          serializer = PostWithTagsSerializer.new(@post)
+          post_serializer_class = Class.new(ActiveModel::Serializer) do
+            attributes :id
+            has_many :tags
+          end
+          serializer = post_serializer_class.new(@post)
           adapter = ActiveModelSerializers::Adapter::JsonApi.new(serializer)
 
           assert_equal({
-            data: {
-              id: '1',
-              type: 'posts',
-              relationships: {
-                tags: { data: [@tag.as_json] }
-              }
-            }
-          }, adapter.serializable_hash)
+                         data: {
+                           id: '1',
+                           type: 'posts',
+                           relationships: {
+                             tags: { data: [@tag.as_json] }
+                           }
+                         }
+                       }, adapter.serializable_hash)
         end
 
         def test_has_many_with_virtual_value
@@ -127,16 +156,16 @@ module ActiveModelSerializers
           adapter = ActiveModelSerializers::Adapter::JsonApi.new(serializer)
 
           assert_equal({
-            data: {
-              id: '1',
-              type: 'virtual-values',
-              relationships: {
-                maker: { data: { type: 'makers', id: '1' } },
-                reviews: { data: [{ type: 'reviews', id: '1' },
-                                  { type: 'reviews', id: '2' }] }
-              }
-            }
-          }, adapter.serializable_hash)
+                         data: {
+                           id: '1',
+                           type: 'virtual-values',
+                           relationships: {
+                             maker: { data: { type: 'makers', id: '1' } },
+                             reviews: { data: [{ type: 'reviews', id: '1' },
+                                               { type: 'reviews', id: '2' }] }
+                           }
+                         }
+                       }, adapter.serializable_hash)
         end
       end
     end