active_model_serializers 0.8.3 → 0.10.0.rc5

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/serialization_context_test_isolated.rb

@@ -0,0 +1,58 @@
+# Execute this test in isolation
+require 'support/isolated_unit'
+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
+    setup do
+      require 'rails'
+      require 'active_model_serializers'
+      make_basic_app
+      @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'
+    end
+
+    test 'url_helpers is set up for Rails url_helpers' do
+      assert_equal Module, ActiveModelSerializers::SerializationContext.url_helpers.class
+      assert ActiveModelSerializers::SerializationContext.url_helpers.respond_to? :url_for
+    end
+
+    test 'default_url_options returns Rails.application.routes.default_url_options' do
+      assert_equal Rails.application.routes.default_url_options,
+        ActiveModelSerializers::SerializationContext.default_url_options
+    end
+  end
+
+  class WithoutRails < SerializationContextTest
+    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'
+    end
+
+    test 'url_helpers is a module when Rails is not present' do
+      assert_equal Module, ActiveModelSerializers::SerializationContext.url_helpers.class
+      refute ActiveModelSerializers::SerializationContext.url_helpers.respond_to? :url_for
+    end
+
+    test 'default_url_options return a Hash' do
+      assert Hash, ActiveModelSerializers::SerializationContext.default_url_options.class
+    end
+  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

@@ -0,0 +1,9 @@
+require 'test_helper'
+
+class ActiveRecordTest < ActiveSupport::TestCase
+  include ActiveModel::Serializer::Lint::Tests
+
+  def setup
+    @resource = ARModels::Post.new
+  end
+end

data/test/adapter/deprecation_test.rb

@@ -0,0 +1,100 @@
+require 'test_helper'
+module ActiveModel
+  class Serializer
+    module Adapter
+      class DeprecationTest < ActiveSupport::TestCase
+        class PostSerializer < ActiveModel::Serializer
+          attribute :body
+        end
+        setup do
+          post = Post.new(id: 1, body: 'Hello')
+          @serializer = PostSerializer.new(post)
+        end
+
+        def test_null_adapter_serialization_deprecation
+          expected = {}
+          assert_deprecated do
+            assert_equal(expected, Null.new(@serializer).as_json)
+          end
+        end
+
+        def test_json_adapter_serialization_deprecation
+          expected = { post: { body: 'Hello' } }
+          assert_deprecated do
+            assert_equal(expected, Json.new(@serializer).as_json)
+          end
+        end
+
+        def test_jsonapi_adapter_serialization_deprecation
+          expected = {
+            data: {
+              id: '1',
+              type: 'posts',
+              attributes: {
+                body: 'Hello'
+              }
+            }
+          }
+          assert_deprecated do
+            assert_equal(expected, JsonApi.new(@serializer).as_json)
+          end
+        end
+
+        def test_attributes_adapter_serialization_deprecation
+          expected = { body: 'Hello' }
+          assert_deprecated do
+            assert_equal(expected, Attributes.new(@serializer).as_json)
+          end
+        end
+
+        def test_adapter_create_deprecation
+          assert_deprecated do
+            Adapter.create(@serializer)
+          end
+        end
+
+        def test_adapter_adapter_map_deprecation
+          assert_deprecated do
+            Adapter.adapter_map
+          end
+        end
+
+        def test_adapter_adapters_deprecation
+          assert_deprecated do
+            Adapter.adapters
+          end
+        end
+
+        def test_adapter_adapter_class_deprecation
+          assert_deprecated do
+            Adapter.adapter_class(:json_api)
+          end
+        end
+
+        def test_adapter_register_deprecation
+          assert_deprecated do
+            begin
+              Adapter.register(:test, Class.new)
+            ensure
+              Adapter.adapter_map.delete('test')
+            end
+          end
+        end
+
+        def test_adapter_lookup_deprecation
+          assert_deprecated do
+            Adapter.lookup(:json_api)
+          end
+        end
+
+        private
+
+        def assert_deprecated
+          assert_output(nil, /deprecated/) do
+            yield
+          end
+        end
+      end
+    end
+  end
+end

data/test/adapter/json/belongs_to_test.rb

@@ -0,0 +1,45 @@
+require 'test_helper'
+
+module ActiveModelSerializers
+  module Adapter
+    class Json
+      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!!')
+          @comment = Comment.new(id: 1, body: 'ZOMG A COMMENT')
+          @post.comments = [@comment]
+          @anonymous_post.comments = []
+          @comment.post = @post
+          @comment.author = nil
+          @anonymous_post.author = nil
+          @blog = Blog.new(id: 1, name: 'My Blog!!')
+          @post.blog = @blog
+          @anonymous_post.blog = nil
+
+          @serializer = CommentSerializer.new(@comment)
+          @adapter = ActiveModelSerializers::Adapter::Json.new(@serializer)
+          ActionController::Base.cache_store.clear
+        end
+
+        def test_includes_post
+          assert_equal({ id: 42, title: 'New Post', body: 'Body' }, @adapter.serializable_hash[:comment][:post])
+        end
+
+        def test_include_nil_author
+          serializer = PostSerializer.new(@anonymous_post)
+          adapter = ActiveModelSerializers::Adapter::Json.new(serializer)
+
+          assert_equal({ post: { title: 'Hello!!', body: 'Hello, world!!', id: 43, comments: [], blog: { id: 999, name: 'Custom blog' }, author: nil } }, adapter.serializable_hash)
+        end
+
+        def test_include_nil_author_with_specified_serializer
+          serializer = PostPreviewSerializer.new(@anonymous_post)
+          adapter = ActiveModelSerializers::Adapter::Json.new(serializer)
+
+          assert_equal({ post: { title: 'Hello!!', body: 'Hello, world!!', id: 43, comments: [], author: nil } }, adapter.serializable_hash)
+        end
+      end
+    end
+  end
+end

data/test/adapter/json/collection_test.rb

@@ -0,0 +1,90 @@
+require 'test_helper'
+
+module ActiveModelSerializers
+  module Adapter
+    class Json
+      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!!')
+          @second_post = Post.new(id: 2, title: 'New Post', body: 'Body')
+          @first_post.comments = []
+          @second_post.comments = []
+          @first_post.author = @author
+          @second_post.author = @author
+          @blog = Blog.new(id: 1, name: 'My Blog!!')
+          @first_post.blog = @blog
+          @second_post.blog = nil
+
+          ActionController::Base.cache_store.clear
+        end
+
+        def test_with_serializer_option
+          @blog.special_attribute = 'Special'
+          @blog.articles = [@first_post, @second_post]
+          serializer = ActiveModel::Serializer::CollectionSerializer.new([@blog], serializer: CustomBlogSerializer)
+          adapter = ActiveModelSerializers::Adapter::Json.new(serializer)
+
+          expected = { blogs: [{
+            id: 1,
+            special_attribute: 'Special',
+            articles: [{ id: 1, title: 'Hello!!', body: 'Hello, world!!' }, { id: 2, title: 'New Post', body: 'Body' }]
+          }] }
+          assert_equal expected, adapter.serializable_hash
+        end
+
+        def test_include_multiple_posts
+          serializer = ActiveModel::Serializer::CollectionSerializer.new([@first_post, @second_post])
+          adapter = ActiveModelSerializers::Adapter::Json.new(serializer)
+
+          expected = { posts: [{
+            title: 'Hello!!',
+            body: 'Hello, world!!',
+            id: 1,
+            comments: [],
+            author: {
+              id: 1,
+              name: 'Steve K.'
+            },
+            blog: {
+              id: 999,
+              name: 'Custom blog'
+            }
+          }, {
+            title: 'New Post',
+            body: 'Body',
+            id: 2,
+            comments: [],
+            author: {
+              id: 1,
+              name: 'Steve K.'
+            },
+            blog: {
+              id: 999,
+              name: 'Custom blog'
+            }
+          }] }
+          assert_equal expected, adapter.serializable_hash
+        end
+
+        def test_root_is_underscored
+          virtual_value = VirtualValue.new(id: 1)
+          serializer = ActiveModel::Serializer::CollectionSerializer.new([virtual_value])
+          adapter = ActiveModelSerializers::Adapter::Json.new(serializer)
+
+          assert_equal 1, adapter.serializable_hash[:virtual_values].length
+        end
+
+        def test_include_option
+          serializer = ActiveModel::Serializer::CollectionSerializer.new([@first_post, @second_post])
+          adapter = ActiveModelSerializers::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
+end

data/test/adapter/json/has_many_test.rb

@@ -0,0 +1,45 @@
+require 'test_helper'
+
+module ActiveModelSerializers
+  module Adapter
+    class Json
+      class HasManyTestTest < ActiveSupport::TestCase
+        def setup
+          ActionController::Base.cache_store.clear
+          @author = Author.new(id: 1, name: 'Steve K.')
+          @post = Post.new(id: 42, title: 'New Post', body: 'Body')
+          @first_comment = Comment.new(id: 1, body: 'ZOMG A COMMENT')
+          @second_comment = Comment.new(id: 2, body: 'ZOMG ANOTHER COMMENT')
+          @post.comments = [@first_comment, @second_comment]
+          @post.author = @author
+          @first_comment.post = @post
+          @second_comment.post = @post
+          @blog = Blog.new(id: 1, name: 'My Blog!!')
+          @post.blog = @blog
+          @tag = Tag.new(id: 1, name: '#hash_tag')
+          @post.tags = [@tag]
+        end
+
+        def test_has_many
+          serializer = PostSerializer.new(@post)
+          adapter = ActiveModelSerializers::Adapter::Json.new(serializer)
+          assert_equal([
+                         { id: 1, body: 'ZOMG A COMMENT' },
+                         { id: 2, body: 'ZOMG ANOTHER COMMENT' }
+                       ], adapter.serializable_hash[:post][:comments])
+        end
+
+        def test_has_many_with_no_serializer
+          serializer = PostWithTagsSerializer.new(@post)
+          adapter = ActiveModelSerializers::Adapter::Json.new(serializer)
+          assert_equal({
+            id: 42,
+            tags: [
+              { 'id' => 1, 'name' => '#hash_tag' }
+            ]
+          }.to_json, adapter.serializable_hash[:post].to_json)
+        end
+      end
+    end
+  end
+end

data/test/adapter/json/transform_test.rb

@@ -0,0 +1,93 @@
+require 'test_helper'
+
+module ActiveModelSerializers
+  module Adapter
+    class Json
+      class KeyCaseTest < ActiveSupport::TestCase
+        def mock_request(key_transform = nil)
+          context = Minitest::Mock.new
+          context.expect(:request_url, URI)
+          context.expect(:query_parameters, {})
+          @options = {}
+          @options[:key_transform] = key_transform if key_transform
+          @options[:serialization_context] = context
+        end
+
+        Post = Class.new(::Model)
+        class PostSerializer < ActiveModel::Serializer
+          attributes :id, :title, :body, :publish_at
+        end
+
+        def setup
+          ActionController::Base.cache_store.clear
+          @blog = Blog.new(id: 1, name: 'My Blog!!', special_attribute: 'neat')
+          serializer = CustomBlogSerializer.new(@blog)
+          @adapter = ActiveModelSerializers::Adapter::Json.new(serializer)
+        end
+
+        def test_transform_default
+          mock_request
+          assert_equal({
+            blog: { id: 1, special_attribute: 'neat', articles: nil }
+          }, @adapter.serializable_hash(@options))
+        end
+
+        def test_transform_global_config
+          mock_request
+          result = with_config(key_transform: :camel_lower) do
+            @adapter.serializable_hash(@options)
+          end
+          assert_equal({
+            blog: { id: 1, specialAttribute: 'neat', articles: nil }
+          }, result)
+        end
+
+        def test_transform_serialization_ctx_overrides_global_config
+          mock_request(:camel)
+          result = with_config(key_transform: :camel_lower) do
+            @adapter.serializable_hash(@options)
+          end
+          assert_equal({
+            Blog: { Id: 1, SpecialAttribute: 'neat', Articles: nil }
+          }, result)
+        end
+
+        def test_transform_undefined
+          mock_request(:blam)
+          result = nil
+          assert_raises NoMethodError do
+            result = @adapter.serializable_hash(@options)
+          end
+        end
+
+        def test_transform_dash
+          mock_request(:dash)
+          assert_equal({
+            blog: { id: 1, :"special-attribute" => 'neat', articles: nil }
+          }, @adapter.serializable_hash(@options))
+        end
+
+        def test_transform_unaltered
+          mock_request(:unaltered)
+          assert_equal({
+            blog: { id: 1, special_attribute: 'neat', articles: nil }
+          }, @adapter.serializable_hash(@options))
+        end
+
+        def test_transform_camel
+          mock_request(:camel)
+          assert_equal({
+            Blog: { Id: 1, SpecialAttribute: 'neat', Articles: nil }
+          }, @adapter.serializable_hash(@options))
+        end
+
+        def test_transform_camel_lower
+          mock_request(:camel_lower)
+          assert_equal({
+            blog: { id: 1, specialAttribute: 'neat', articles: nil }
+          }, @adapter.serializable_hash(@options))
+        end
+      end
+    end
+  end
+end