active_model_serializers 0.10.0.rc3 → 0.10.0.rc4

data/test/active_model_serializers/serialization_context_test.rb

@@ -0,0 +1,18 @@
+require 'test_helper'
+
+class ActiveModelSerializers::SerializationContextTest < ActiveSupport::TestCase
+  def create_context
+    request = Minitest::Mock.new
+    request.expect(:original_url, 'original_url')
+    request.expect(:query_parameters, 'query_parameters')
+
+    ActiveModelSerializers::SerializationContext.new(request)
+  end
+
+  def test_create_context_with_request_url_and_query_parameters
+    context = create_context
+
+    assert_equal context.request_url, 'original_url'
+    assert_equal context.query_parameters, 'query_parameters'
+  end
+end

data/test/active_model_serializers/test/schema_test.rb

@@ -0,0 +1,128 @@
+require 'test_helper'
+
+module ActiveModelSerializers
+  module Test
+    class SchemaTest < ActionController::TestCase
+      include ActiveModelSerializers::Test::Schema
+
+      class MyController < ActionController::Base
+        def index
+          render json: profile
+        end
+
+        def show
+          index
+        end
+
+        def name_as_a_integer
+          profile.name = 1
+          index
+        end
+
+        def render_using_json_api
+          render json: profile, adapter: :json_api
+        end
+
+        def invalid_json_body
+          render json: ''
+        end
+
+        private
+
+        def profile
+          @profile ||= Profile.new(name: 'Name 1', description: 'Description 1', comments: 'Comments 1')
+        end
+      end
+
+      tests MyController
+
+      def test_that_assert_with_a_valid_schema
+        get :index
+        assert_response_schema
+      end
+
+      def test_that_raises_a_minitest_error_with_a_invalid_schema
+        message = "#/name: failed schema #/properties/name: For 'properties/name', \"Name 1\" is not an integer. and #/description: failed schema #/properties/description: For 'properties/description', \"Description 1\" is not a boolean."
+
+        get :show
+
+        error = assert_raises Minitest::Assertion do
+          assert_response_schema
+        end
+        assert_equal(message, error.message)
+      end
+
+      def test_that_raises_error_with_a_custom_message_with_a_invalid_schema
+        message = 'oh boy the show is broken'
+
+        get :show
+
+        error = assert_raises Minitest::Assertion do
+          assert_response_schema(nil, message)
+        end
+        assert_equal(message, error.message)
+      end
+
+      def test_that_assert_with_a_custom_schema
+        get :show
+        assert_response_schema('custom/show.json')
+      end
+
+      def test_that_assert_with_a_hyper_schema
+        get :show
+        assert_response_schema('hyper_schema.json')
+      end
+
+      def test_simple_json_pointers
+        get :show
+        assert_response_schema('simple_json_pointers.json')
+      end
+
+      def test_simple_json_pointers_that_doesnt_match
+        get :name_as_a_integer
+
+        assert_raises Minitest::Assertion do
+          assert_response_schema('simple_json_pointers.json')
+        end
+      end
+
+      def test_json_api_schema
+        get :render_using_json_api
+        assert_response_schema('render_using_json_api.json')
+      end
+
+      def test_that_assert_with_a_custom_schema_directory
+        original_schema_path = ActiveModelSerializers.config.schema_path
+        ActiveModelSerializers.config.schema_path = 'test/support/custom_schemas'
+
+        get :index
+        assert_response_schema
+
+        ActiveModelSerializers.config.schema_path = original_schema_path
+      end
+
+      def test_with_a_non_existent_file
+        message = %r{.* - No Schema file at test/support/schemas/non-existent.json}
+
+        get :show
+
+        error = assert_raises ActiveModelSerializers::Test::Schema::MissingSchema do
+          assert_response_schema('non-existent.json')
+        end
+        assert_match(message, error.message)
+      end
+
+      def test_that_raises_with_a_invalid_json_body
+        message = 'A JSON text must at least contain two octets!'
+
+        get :invalid_json_body
+
+        error = assert_raises ActiveModelSerializers::Test::Schema::InvalidSchemaError do
+          assert_response_schema('custom/show.json')
+        end
+
+        assert_equal(message, error.message)
+      end
+    end
+  end
+end

data/test/active_model_serializers/test/serializer_test.rb

@@ -0,0 +1,63 @@
+require 'test_helper'
+
+module ActiveModelSerializers
+  module Test
+    class SerializerTest < ActionController::TestCase
+      include ActiveModelSerializers::Test::Serializer
+
+      class MyController < ActionController::Base
+        def render_using_serializer
+          render json: Profile.new(name: 'Name 1', description: 'Description 1', comments: 'Comments 1')
+        end
+
+        # For Rails4.0
+        def render_some_text
+          Rails.version > '4.1' ? render(plain: 'ok') : render(text: 'ok')
+        end
+      end
+
+      tests MyController
+
+      def test_supports_specifying_serializers_with_a_serializer_class
+        get :render_using_serializer
+        assert_serializer ProfileSerializer
+      end
+
+      def test_supports_specifying_serializers_with_a_regexp
+        get :render_using_serializer
+        assert_serializer(/\AProfile.+\Z/)
+      end
+
+      def test_supports_specifying_serializers_with_a_string
+        get :render_using_serializer
+        assert_serializer 'ProfileSerializer'
+      end
+
+      def test_supports_specifying_serializers_with_a_symbol
+        get :render_using_serializer
+        assert_serializer :profile_serializer
+      end
+
+      def test_supports_specifying_serializers_with_a_nil
+        get :render_some_text
+        assert_serializer nil
+      end
+
+      def test_raises_descriptive_error_message_when_serializer_was_not_rendered
+        get :render_using_serializer
+        e = assert_raise ActiveSupport::TestCase::Assertion do
+          assert_serializer 'PostSerializer'
+        end
+        assert_match 'expecting <"PostSerializer"> but rendering with <["ProfileSerializer"]>', e.message
+      end
+
+      def test_raises_argument_error_when_asserting_with_invalid_object
+        get :render_using_serializer
+        e = assert_raise ArgumentError do
+          assert_serializer Hash
+        end
+        assert_match 'assert_serializer only accepts a String, Symbol, Regexp, ActiveModel::Serializer, or nil', e.message
+      end
+    end
+  end
+end

data/test/active_record_test.rb

@@ -1,6 +1,6 @@
 require 'test_helper'
 
-class ActiveRecordTest < Minitest::Test
+class ActiveRecordTest < ActiveSupport::TestCase
   include ActiveModel::Serializer::Lint::Tests
 
   def setup

data/test/adapter/fragment_cache_test.rb

@@ -1,9 +1,10 @@
 require 'test_helper'
 module ActiveModel
   class Serializer
-    class Adapter
-      class FragmentCacheTest < Minitest::Test
+    module Adapter
+      class FragmentCacheTest < ActiveSupport::TestCase
         def setup
+          super
           @spam            = Spam::UnrelatedLink.new(id: 'spam-id-1')
           @author          = Author.new(name: 'Joao M. D. Moura')
           @role            = Role.new(name: 'Great Author', description: nil)

data/test/adapter/json/belongs_to_test.rb

@@ -2,9 +2,9 @@ require 'test_helper'
 
 module ActiveModel
   class Serializer
-    class Adapter
+    module Adapter
       class Json
-        class BelongsToTest < Minitest::Test
+        class BelongsToTest < ActiveSupport::TestCase
           def setup
             @post = Post.new(id: 42, title: 'New Post', body: 'Body')
             @anonymous_post = Post.new(id: 43, title: 'Hello!!', body: 'Hello, world!!')

data/test/adapter/json/collection_test.rb

@@ -2,9 +2,9 @@ require 'test_helper'
 
 module ActiveModel
   class Serializer
-    class Adapter
+    module Adapter
       class Json
-        class Collection < Minitest::Test
+        class Collection < ActiveSupport::TestCase
           def setup
             @author = Author.new(id: 1, name: 'Steve K.')
             @first_post = Post.new(id: 1, title: 'Hello!!', body: 'Hello, world!!')
@@ -23,7 +23,7 @@ module ActiveModel
           def test_with_serializer_option
             @blog.special_attribute = 'Special'
             @blog.articles = [@first_post, @second_post]
-            serializer = ArraySerializer.new([@blog], serializer: CustomBlogSerializer)
+            serializer = CollectionSerializer.new([@blog], serializer: CustomBlogSerializer)
             adapter = ActiveModel::Serializer::Adapter::Json.new(serializer)
 
             expected = { blogs: [{
@@ -35,7 +35,7 @@ module ActiveModel
           end
 
           def test_include_multiple_posts
-            serializer = ArraySerializer.new([@first_post, @second_post])
+            serializer = CollectionSerializer.new([@first_post, @second_post])
             adapter = ActiveModel::Serializer::Adapter::Json.new(serializer)
 
             expected = { posts: [{
@@ -70,11 +70,21 @@ module ActiveModel
 
           def test_root_is_underscored
             virtual_value = VirtualValue.new(id: 1)
-            serializer = ArraySerializer.new([virtual_value])
+            serializer = CollectionSerializer.new([virtual_value])
             adapter = ActiveModel::Serializer::Adapter::Json.new(serializer)
 
             assert_equal 1, adapter.serializable_hash[:virtual_values].length
           end
+
+          def test_include_option
+            serializer = CollectionSerializer.new([@first_post, @second_post])
+            adapter = ActiveModel::Serializer::Adapter::Json.new(serializer, include: '')
+            actual = adapter.serializable_hash
+            expected = { posts: [{ id: 1, title: 'Hello!!', body: 'Hello, world!!' },
+                                 { id: 2, title: 'New Post', body: 'Body' }] }
+
+            assert_equal(expected, actual)
+          end
         end
       end
     end

data/test/adapter/json/has_many_test.rb

@@ -2,9 +2,9 @@ require 'test_helper'
 
 module ActiveModel
   class Serializer
-    class Adapter
+    module Adapter
       class Json
-        class HasManyTestTest < Minitest::Test
+        class HasManyTestTest < ActiveSupport::TestCase
           def setup
             ActionController::Base.cache_store.clear
             @author = Author.new(id: 1, name: 'Steve K.')
@@ -36,7 +36,7 @@ module ActiveModel
             assert_equal({
               id: 42,
               tags: [
-                { 'attributes' => { 'id' => 1, 'name' => '#hash_tag' } }
+                { 'id' => 1, 'name' => '#hash_tag' }
               ]
             }.to_json, adapter.serializable_hash[:post].to_json)
           end

data/test/adapter/json_api/belongs_to_test.rb

@@ -2,9 +2,9 @@ require 'test_helper'
 
 module ActiveModel
   class Serializer
-    class Adapter
+    module Adapter
       class JsonApi
-        class BelongsToTest < Minitest::Test
+        class BelongsToTest < ActiveSupport::TestCase
           def setup
             @author = Author.new(id: 1, name: 'Steve K.')
             @author.bio = nil
@@ -56,7 +56,7 @@ module ActiveModel
           end
 
           def test_limiting_linked_post_fields
-            @adapter = ActiveModel::Serializer::Adapter::JsonApi.new(@serializer, include: [:post], fields: { post: [:title] })
+            @adapter = ActiveModel::Serializer::Adapter::JsonApi.new(@serializer, include: [:post], fields: { post: [:title, :comments, :blog, :author] })
             expected = [{
               id: '42',
               type: 'posts',

data/test/adapter/json_api/collection_test.rb

@@ -2,9 +2,9 @@ require 'test_helper'
 
 module ActiveModel
   class Serializer
-    class Adapter
+    module Adapter
       class JsonApi
-        class CollectionTest < Minitest::Test
+        class CollectionTest < ActiveSupport::TestCase
           def setup
             @author = Author.new(id: 1, name: 'Steve K.')
             @author.bio = nil
@@ -19,7 +19,7 @@ module ActiveModel
             @second_post.author = @author
             @author.posts = [@first_post, @second_post]
 
-            @serializer = ArraySerializer.new([@first_post, @second_post])
+            @serializer = CollectionSerializer.new([@first_post, @second_post])
             @adapter = ActiveModel::Serializer::Adapter::JsonApi.new(@serializer)
             ActionController::Base.cache_store.clear
           end
@@ -58,8 +58,10 @@ module ActiveModel
           end
 
           def test_limiting_fields
-            @adapter = ActiveModel::Serializer::Adapter::JsonApi.new(@serializer, fields: ['title'])
-
+            actual = ActiveModel::SerializableResource.new(
+              [@first_post, @second_post], adapter: :json_api,
+                                           fields: { posts: %w(title comments blog author) })
+                     .serializable_hash
             expected = [
               {
                 id: '1',
@@ -86,7 +88,7 @@ module ActiveModel
                 }
               }
             ]
-            assert_equal(expected, @adapter.serializable_hash[:data])
+            assert_equal(expected, actual[:data])
           end
         end
       end

data/test/adapter/json_api/fields_test.rb

@@ -0,0 +1,89 @@
+require 'test_helper'
+
+module ActiveModel
+  class Serializer
+    module Adapter
+      class JsonApi
+        class FieldsTest < ActiveSupport::TestCase
+          Post = Class.new(::Model)
+          class PostSerializer < ActiveModel::Serializer
+            type 'posts'
+            attributes :title, :body
+            belongs_to :author
+            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
+            belongs_to :author
+          end
+
+          def setup
+            @author = Author.new(id: 1, name: 'Lucas', birthday: '10.01.1990')
+            @comment1 = Comment.new(id: 7, body: 'cool', author: @author)
+            @comment2 = Comment.new(id: 12, body: 'awesome', author: @author)
+            @post = Post.new(id: 1337, title: 'Title 1', body: 'Body 1',
+                             author: @author, comments: [@comment1, @comment2])
+            @comment1.post = @post
+            @comment2.post = @post
+          end
+
+          def test_fields_attributes
+            fields = { posts: [:title] }
+            hash = serializable(@post, adapter: :json_api, fields: fields).serializable_hash
+            expected = {
+              title: 'Title 1'
+            }
+
+            assert_equal(expected, hash[:data][:attributes])
+          end
+
+          def test_fields_relationships
+            fields = { posts: [:author] }
+            hash = serializable(@post, adapter: :json_api, fields: fields).serializable_hash
+            expected = {
+              author: {
+                data: {
+                  type: 'authors',
+                  id: '1'
+                }
+              }
+            }
+
+            assert_equal(expected, hash[:data][:relationships])
+          end
+
+          def test_fields_included
+            fields = { posts: [:author], comments: [:body] }
+            hash = serializable(@post, adapter: :json_api, fields: fields, include: 'comments').serializable_hash
+            expected = [
+              {
+                type: 'comments',
+                id: '7',
+                attributes: {
+                  body: 'cool'
+                }
+              }, {
+                type: 'comments',
+                id: '12',
+                attributes: {
+                  body: 'awesome'
+                }
+              }
+            ]
+
+            assert_equal(expected, hash[:included])
+          end
+        end
+      end
+    end
+  end
+end