active_model_serializers 0.8.3 → 0.10.0

data/test/active_model_serializers/key_transform_test.rb

@@ -0,0 +1,263 @@
+require 'test_helper'
+
+class ActiveModelSerializers::KeyTransformTest < ActiveSupport::TestCase
+  def test_camel
+    obj = Object.new
+    scenarios = [
+      {
+        value: { :"some-key" => 'value' },
+        expected: { :SomeKey => 'value' }
+      },
+      {
+        value: { :someKey => 'value' },
+        expected: { :SomeKey => 'value' }
+      },
+      {
+        value: { :some_key => 'value' },
+        expected: { :SomeKey => 'value' }
+      },
+      {
+        value: { 'some-key' => 'value' },
+        expected: { 'SomeKey' => 'value' }
+      },
+      {
+        value: { 'someKey' => 'value' },
+        expected: { 'SomeKey' => 'value' }
+      },
+      {
+        value: { 'some_key' => 'value' },
+        expected: { 'SomeKey' => 'value' }
+      },
+      {
+        value: :"some-value",
+        expected: :SomeValue
+      },
+      {
+        value: :some_value,
+        expected: :SomeValue
+      },
+      {
+        value: :someValue,
+        expected: :SomeValue
+      },
+      {
+        value: 'some-value',
+        expected: 'SomeValue'
+      },
+      {
+        value: 'someValue',
+        expected: 'SomeValue'
+      },
+      {
+        value: 'some_value',
+        expected: 'SomeValue'
+      },
+      {
+        value: obj,
+        expected: obj
+      },
+      {
+        value: nil,
+        expected: nil
+      }
+    ]
+    scenarios.each do |s|
+      result = ActiveModelSerializers::KeyTransform.camel(s[:value])
+      assert_equal s[:expected], result
+    end
+  end
+
+  def test_camel_lower
+    obj = Object.new
+    scenarios = [
+      {
+        value: { :"some-key" => 'value' },
+        expected: { :someKey => 'value' }
+      },
+      {
+        value: { :SomeKey => 'value' },
+        expected: { :someKey => 'value' }
+      },
+      {
+        value: { :some_key => 'value' },
+        expected: { :someKey => 'value' }
+      },
+      {
+        value: { 'some-key' => 'value' },
+        expected: { 'someKey' => 'value' }
+      },
+      {
+        value: { 'SomeKey' => 'value' },
+        expected: { 'someKey' => 'value' }
+      },
+      {
+        value: { 'some_key' => 'value' },
+        expected: { 'someKey' => 'value' }
+      },
+      {
+        value: :"some-value",
+        expected: :someValue
+      },
+      {
+        value: :SomeValue,
+        expected: :someValue
+      },
+      {
+        value: :some_value,
+        expected: :someValue
+      },
+      {
+        value: 'some-value',
+        expected: 'someValue'
+      },
+      {
+        value: 'SomeValue',
+        expected: 'someValue'
+      },
+      {
+        value: 'some_value',
+        expected: 'someValue'
+      },
+      {
+        value: obj,
+        expected: obj
+      },
+      {
+        value: nil,
+        expected: nil
+      }
+    ]
+    scenarios.each do |s|
+      result = ActiveModelSerializers::KeyTransform.camel_lower(s[:value])
+      assert_equal s[:expected], result
+    end
+  end
+
+  def test_dash
+    obj = Object.new
+    scenarios = [
+      {
+        value: { :some_key => 'value' },
+        expected: { :"some-key" => 'value' }
+      },
+      {
+        value: { 'some_key' => 'value' },
+        expected: { 'some-key' => 'value' }
+      },
+      {
+        value: { :SomeKey => 'value' },
+        expected: { :"some-key" => 'value' }
+      },
+      {
+        value: { 'SomeKey' => 'value' },
+        expected: { 'some-key' => 'value' }
+      },
+      {
+        value: { :someKey => 'value' },
+        expected: { :"some-key" => 'value' }
+      },
+      {
+        value: { 'someKey' => 'value' },
+        expected: { 'some-key' => 'value' }
+      },
+      {
+        value: :some_value,
+        expected: :"some-value"
+      },
+      {
+        value: :SomeValue,
+        expected: :"some-value"
+      },
+      {
+        value: 'SomeValue',
+        expected: 'some-value'
+      },
+      {
+        value: :someValue,
+        expected: :"some-value"
+      },
+      {
+        value: 'someValue',
+        expected: 'some-value'
+      },
+      {
+        value: obj,
+        expected: obj
+      },
+      {
+        value: nil,
+        expected: nil
+      }
+    ]
+    scenarios.each do |s|
+      result = ActiveModelSerializers::KeyTransform.dash(s[:value])
+      assert_equal s[:expected], result
+    end
+  end
+
+  def test_underscore
+    obj = Object.new
+    scenarios = [
+      {
+        value: { :"some-key" => 'value' },
+        expected: { :some_key => 'value' }
+      },
+      {
+        value: { 'some-key' => 'value' },
+        expected: { 'some_key' => 'value' }
+      },
+      {
+        value: { :SomeKey => 'value' },
+        expected: { :some_key => 'value' }
+      },
+      {
+        value: { 'SomeKey' => 'value' },
+        expected: { 'some_key' => 'value' }
+      },
+      {
+        value: { :someKey => 'value' },
+        expected: { :some_key => 'value' }
+      },
+      {
+        value: { 'someKey' => 'value' },
+        expected: { 'some_key' => 'value' }
+      },
+      {
+        value: :"some-value",
+        expected: :some_value
+      },
+      {
+        value: :SomeValue,
+        expected: :some_value
+      },
+      {
+        value: :someValue,
+        expected: :some_value
+      },
+      {
+        value: 'some-value',
+        expected: 'some_value'
+      },
+      {
+        value: 'SomeValue',
+        expected: 'some_value'
+      },
+      {
+        value: 'someValue',
+        expected: 'some_value'
+      },
+      {
+        value: obj,
+        expected: obj
+      },
+      {
+        value: nil,
+        expected: nil
+      }
+    ]
+    scenarios.each do |s|
+      result = ActiveModelSerializers::KeyTransform.underscore(s[:value])
+      assert_equal s[:expected], result
+    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,9 @@
+require 'test_helper'
+
+class ActiveModelSerializers::ModelTest < ActiveSupport::TestCase
+  include ActiveModel::Serializer::Lint::Tests
+
+  def setup
+    @resource = ActiveModelSerializers::Model.new
+  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/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,130 @@
+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'
+        exception_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."
+        expected_message = "#{message}: #{exception_message}"
+
+        get :show
+
+        error = assert_raises Minitest::Assertion do
+          assert_response_schema(nil, message)
+        end
+        assert_equal(expected_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 = '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_equal(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,62 @@
+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
+
+        def render_some_text
+          render(plain: '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