[DOCS] Refactor, update, create documentation [ci skip]

This commit is contained in:
Benjamin Fleischer
2015-12-10 15:12:06 -06:00
parent 1301b52696
commit ce17a1b305
26 changed files with 740 additions and 485 deletions

View File

@@ -4,11 +4,11 @@ module ActiveModel
UnknownAdapterError = ::ActiveModel::Serializer::Adapter::UnknownAdapterError
def setup
@previous_adapter = ActiveModel::Serializer.config.adapter
@previous_adapter = ActiveModelSerializers.config.adapter
end
def teardown
ActiveModel::Serializer.config.adapter = @previous_adapter
ActiveModelSerializers.config.adapter = @previous_adapter
end
def test_returns_default_adapter
@@ -17,23 +17,23 @@ module ActiveModel
end
def test_overwrite_adapter_with_symbol
ActiveModel::Serializer.config.adapter = :null
ActiveModelSerializers.config.adapter = :null
adapter = ActiveModel::Serializer.adapter
assert_equal ActiveModel::Serializer::Adapter::Null, adapter
ensure
ActiveModel::Serializer.config.adapter = @previous_adapter
ActiveModelSerializers.config.adapter = @previous_adapter
end
def test_overwrite_adapter_with_class
ActiveModel::Serializer.config.adapter = ActiveModel::Serializer::Adapter::Null
ActiveModelSerializers.config.adapter = ActiveModel::Serializer::Adapter::Null
adapter = ActiveModel::Serializer.adapter
assert_equal ActiveModel::Serializer::Adapter::Null, adapter
end
def test_raises_exception_if_invalid_symbol_given
ActiveModel::Serializer.config.adapter = :unknown
ActiveModelSerializers.config.adapter = :unknown
assert_raises UnknownAdapterError do
ActiveModel::Serializer.adapter
@@ -41,7 +41,7 @@ module ActiveModel
end
def test_raises_exception_if_it_does_not_know_hot_to_infer_adapter
ActiveModel::Serializer.config.adapter = 42
ActiveModelSerializers.config.adapter = 42
assert_raises UnknownAdapterError do
ActiveModel::Serializer.adapter
@@ -110,7 +110,7 @@ module ActiveModel
end
def test_adapter
assert_equal ActiveModel::Serializer.config.adapter, :attributes
assert_equal ActiveModelSerializers.config.adapter, :attributes
assert_equal ActiveModel::Serializer.adapter, ActiveModel::Serializer::Adapter::Attributes
end

View File

@@ -33,13 +33,13 @@ module ActiveModel
case key
when :posts
assert_equal({}, options)
assert_kind_of(ActiveModel::Serializer.config.collection_serializer, serializer)
assert_kind_of(ActiveModelSerializers.config.collection_serializer, serializer)
when :bio
assert_equal({}, options)
assert_nil serializer
when :roles
assert_equal({}, options)
assert_kind_of(ActiveModel::Serializer.config.collection_serializer, serializer)
assert_kind_of(ActiveModelSerializers.config.collection_serializer, serializer)
else
flunk "Unknown association: #{key}"
end

View File

@@ -4,15 +4,15 @@ module ActiveModel
class Serializer
class ConfigurationTest < Minitest::Test
def test_collection_serializer
assert_equal ActiveModel::Serializer::CollectionSerializer, ActiveModel::Serializer.config.collection_serializer
assert_equal ActiveModel::Serializer::CollectionSerializer, ActiveModelSerializers.config.collection_serializer
end
def test_array_serializer
assert_equal ActiveModel::Serializer::CollectionSerializer, ActiveModel::Serializer.config.array_serializer
assert_equal ActiveModel::Serializer::CollectionSerializer, ActiveModelSerializers.config.array_serializer
end
def test_setting_array_serializer_sets_collection_serializer
config = ActiveModel::Serializer.config
config = ActiveModelSerializers.config
old_config = config.dup
begin
assert_equal ActiveModel::Serializer::CollectionSerializer, config.collection_serializer
@@ -20,12 +20,12 @@ module ActiveModel
assert_equal config.array_serializer, :foo
assert_equal config.collection_serializer, :foo
ensure
ActiveModel::Serializer.config.replace(old_config)
ActiveModelSerializers.config.replace(old_config)
end
end
def test_default_adapter
assert_equal :attributes, ActiveModel::Serializer.config.adapter
assert_equal :attributes, ActiveModelSerializers.config.adapter
end
end
end

View File

@@ -6,21 +6,21 @@ module ActiveModel
class CollectionSerializerTest < Minitest::Test
def setup
@array = [1, 2, 3]
@previous_collection_serializer = ActiveModel::Serializer.config.collection_serializer
@previous_collection_serializer = ActiveModelSerializers.config.collection_serializer
end
def teardown
ActiveModel::Serializer.config.collection_serializer = @previous_collection_serializer
ActiveModelSerializers.config.collection_serializer = @previous_collection_serializer
end
def test_serializer_for_array
serializer = ActiveModel::Serializer.serializer_for(@array)
assert_equal ActiveModel::Serializer.config.collection_serializer, serializer
assert_equal ActiveModelSerializers.config.collection_serializer, serializer
end
def test_overwritten_serializer_for_array
new_collection_serializer = Class.new
ActiveModel::Serializer.config.collection_serializer = new_collection_serializer
ActiveModelSerializers.config.collection_serializer = new_collection_serializer
serializer = ActiveModel::Serializer.serializer_for(@array)
assert_equal new_collection_serializer, serializer
end