active_model_serializers 0.8.3 → 0.10.0.rc5

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

@@ -0,0 +1,80 @@
+require 'test_helper'
+module ActiveModelSerializers
+  module Adapter
+    class CachedSerializerTest < ActiveSupport::TestCase
+      def test_cached_false_without_cache_store
+        cached_serializer = build do |serializer|
+          serializer._cache = nil
+        end
+        refute cached_serializer.cached?
+      end
+
+      def test_cached_true_with_cache_store_and_without_cache_only_and_cache_except
+        cached_serializer = build do |serializer|
+          serializer._cache = Object
+        end
+        assert cached_serializer.cached?
+      end
+
+      def test_cached_false_with_cache_store_and_with_cache_only
+        cached_serializer = build do |serializer|
+          serializer._cache = Object
+          serializer._cache_only = [:name]
+        end
+        refute cached_serializer.cached?
+      end
+
+      def test_cached_false_with_cache_store_and_with_cache_except
+        cached_serializer = build do |serializer|
+          serializer._cache = Object
+          serializer._cache_except = [:content]
+        end
+        refute cached_serializer.cached?
+      end
+
+      def test_fragment_cached_false_without_cache_store
+        cached_serializer = build do |serializer|
+          serializer._cache = nil
+          serializer._cache_only = [:name]
+        end
+        refute cached_serializer.fragment_cached?
+      end
+
+      def test_fragment_cached_true_with_cache_store_and_cache_only
+        cached_serializer = build do |serializer|
+          serializer._cache = Object
+          serializer._cache_only = [:name]
+        end
+        assert cached_serializer.fragment_cached?
+      end
+
+      def test_fragment_cached_true_with_cache_store_and_cache_except
+        cached_serializer = build do |serializer|
+          serializer._cache = Object
+          serializer._cache_except = [:content]
+        end
+        assert cached_serializer.fragment_cached?
+      end
+
+      def test_fragment_cached_false_with_cache_store_and_cache_except_and_cache_only
+        cached_serializer = build do |serializer|
+          serializer._cache = Object
+          serializer._cache_except = [:content]
+          serializer._cache_only = [:name]
+        end
+        refute cached_serializer.fragment_cached?
+      end
+
+      private
+
+      def build
+        serializer = Class.new(ActiveModel::Serializer)
+        serializer._cache_key = nil
+        serializer._cache_options = nil
+        yield serializer if block_given?
+        serializer_instance = serializer.new(Object)
+        CachedSerializer.new(serializer_instance)
+      end
+    end
+  end
+end

data/test/active_model_serializers/fragment_cache_test.rb

@@ -0,0 +1,34 @@
+require 'test_helper'
+module ActiveModelSerializers
+  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)
+      @role.author     = [@author]
+      @role_serializer = RoleSerializer.new(@role)
+      @spam_serializer = Spam::UnrelatedLinkSerializer.new(@spam)
+      adapter          = ActiveModelSerializers::Adapter.configured_adapter
+      @role_hash       = FragmentCache.new(adapter.new(@role_serializer), @role_serializer, {})
+      @spam_hash       = FragmentCache.new(adapter.new(@spam_serializer), @spam_serializer, {})
+    end
+
+    def test_fragment_fetch_with_virtual_attributes
+      expected_result = {
+        id: @role.id,
+        description: @role.description,
+        slug: "#{@role.name}-#{@role.id}",
+        name: @role.name
+      }
+      assert_equal(@role_hash.fetch, expected_result)
+    end
+
+    def test_fragment_fetch_with_namespaced_object
+      expected_result = {
+        id: @spam.id
+      }
+      assert_equal(@spam_hash.fetch, expected_result)
+    end
+  end
+end

data/test/active_model_serializers/json_pointer_test.rb

@@ -0,0 +1,20 @@
+require 'test_helper'
+
+class ActiveModelSerializers::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_unkown_data_pointer
+    assert_raises(TypeError) do
+      ActiveModelSerializers::JsonPointer.new(:unknown)
+    end
+  end
+end

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