Introduce Adapter::Base

Breaking change:
- Adapters now inherit Adapter::Base
- 'Adapter' is now a module, no longer a class
Why?

- using a class as a namespace that you also inherit from is complicated and circular at time i.e.
  buggy (see https://github.com/rails-api/active_model_serializers/pull/1177)
- The class methods on Adapter aren't necessarily related to the instance methods, they're more
    Adapter functions
- named `Base` because it's a Rails-ism
- It helps to isolate and highlight what the Adapter interface actually is
This commit is contained in:
Benjamin Fleischer
2015-09-11 12:36:09 -05:00
parent 7cf0e93d03
commit 19de5f7722
30 changed files with 125 additions and 99 deletions

View File

@@ -1,7 +1,7 @@
require 'test_helper'
module ActiveModel
class Serializer
class Adapter
module Adapter
class FragmentCacheTest < Minitest::Test
def setup
@spam = Spam::UnrelatedLink.new(id: 'spam-id-1')

View File

@@ -2,7 +2,7 @@ require 'test_helper'
module ActiveModel
class Serializer
class Adapter
module Adapter
class Json
class BelongsToTest < Minitest::Test
def setup

View File

@@ -2,7 +2,7 @@ require 'test_helper'
module ActiveModel
class Serializer
class Adapter
module Adapter
class Json
class Collection < Minitest::Test
def setup

View File

@@ -2,7 +2,7 @@ require 'test_helper'
module ActiveModel
class Serializer
class Adapter
module Adapter
class Json
class HasManyTestTest < Minitest::Test
def setup

View File

@@ -2,7 +2,7 @@ require 'test_helper'
module ActiveModel
class Serializer
class Adapter
module Adapter
class JsonApi
class BelongsToTest < Minitest::Test
def setup

View File

@@ -2,7 +2,7 @@ require 'test_helper'
module ActiveModel
class Serializer
class Adapter
module Adapter
class JsonApi
class CollectionTest < Minitest::Test
def setup

View File

@@ -2,7 +2,7 @@ require 'test_helper'
module ActiveModel
class Serializer
class Adapter
module Adapter
class JsonApi
class HasManyEmbedIdsTest < Minitest::Test
def setup

View File

@@ -2,7 +2,7 @@ require 'test_helper'
module ActiveModel
class Serializer
class Adapter
module Adapter
class JsonApi
# Test 'has_many :assocs, serializer: AssocXSerializer'
class HasManyExplicitSerializerTest < Minitest::Test

View File

@@ -2,7 +2,7 @@ require 'test_helper'
module ActiveModel
class Serializer
class Adapter
module Adapter
class JsonApi
class HasManyTest < Minitest::Test
def setup

View File

@@ -2,7 +2,7 @@ require 'test_helper'
module ActiveModel
class Serializer
class Adapter
module Adapter
class JsonApi
class HasOneTest < Minitest::Test
def setup

View File

@@ -2,7 +2,7 @@ require 'test_helper'
module ActiveModel
class Serializer
class Adapter
module Adapter
class JsonApiTest < Minitest::Test
def setup
ActionController::Base.cache_store.clear

View File

@@ -1,7 +1,7 @@
require 'test_helper'
module ActiveModel
class Serializer
class Adapter
module Adapter
class JsonApi
class LinkedTest < Minitest::Test
def setup

View File

@@ -6,7 +6,7 @@ require 'kaminari/hooks'
module ActiveModel
class Serializer
class Adapter
module Adapter
class JsonApi
class PaginationLinksTest < Minitest::Test
URI = 'http://example.com'

View File

@@ -2,7 +2,7 @@ require 'test_helper'
module ActiveModel
class Serializer
class Adapter
module Adapter
class JsonApi
class ResourceTypeConfigTest < Minitest::Test
def setup

View File

@@ -2,7 +2,7 @@ require 'test_helper'
module ActiveModel
class Serializer
class Adapter
module Adapter
class JsonTest < Minitest::Test
def setup
ActionController::Base.cache_store.clear

View File

@@ -2,7 +2,7 @@ require 'test_helper'
module ActiveModel
class Serializer
class Adapter
module Adapter
class NullTest < Minitest::Test
def setup
profile = Profile.new({ name: 'Name 1', description: 'Description 1', comments: 'Comments 1' })

View File

@@ -6,7 +6,7 @@ module ActiveModel
def setup
profile = Profile.new
@serializer = ProfileSerializer.new(profile)
@adapter = ActiveModel::Serializer::Adapter.new(@serializer)
@adapter = ActiveModel::Serializer::Adapter::Base.new(@serializer)
end
def test_serializable_hash_is_abstract_method

View File

@@ -127,7 +127,7 @@ module ActiveModel
def test_inherited_adapter_hooks_register_adapter
Object.const_set(:MyAdapter, Class.new)
my_adapter = MyAdapter
ActiveModel::Serializer::Adapter.inherited(my_adapter)
ActiveModel::Serializer::Adapter::Base.inherited(my_adapter)
assert_equal ActiveModel::Serializer::Adapter.lookup(:my_adapter), my_adapter
ensure
ActiveModel::Serializer::Adapter.adapter_map.delete('my_adapter'.freeze)
@@ -138,7 +138,7 @@ module ActiveModel
Object.const_set(:MyNamespace, Module.new)
MyNamespace.const_set(:MyAdapter, Class.new)
my_adapter = MyNamespace::MyAdapter
ActiveModel::Serializer::Adapter.inherited(my_adapter)
ActiveModel::Serializer::Adapter::Base.inherited(my_adapter)
assert_equal ActiveModel::Serializer::Adapter.lookup(:'my_namespace/my_adapter'), my_adapter
ensure
ActiveModel::Serializer::Adapter.adapter_map.delete('my_namespace/my_adapter'.freeze)
@@ -151,8 +151,8 @@ module ActiveModel
my_adapter = MyAdapter
Object.const_set(:MySubclassedAdapter, Class.new(MyAdapter))
my_subclassed_adapter = MySubclassedAdapter
ActiveModel::Serializer::Adapter.inherited(my_adapter)
ActiveModel::Serializer::Adapter.inherited(my_subclassed_adapter)
ActiveModel::Serializer::Adapter::Base.inherited(my_adapter)
ActiveModel::Serializer::Adapter::Base.inherited(my_subclassed_adapter)
assert_equal ActiveModel::Serializer::Adapter.lookup(:my_adapter), my_adapter
assert_equal ActiveModel::Serializer::Adapter.lookup(:my_subclassed_adapter), my_subclassed_adapter
ensure