mirror of
https://github.com/ditkrg/active_model_serializers.git
synced 2026-01-22 22:06:50 +00:00
Rename Adapter.get to Adapter.lookup
Per https://github.com/rails-api/active_model_serializers/pull/1017#discussion_r39003855
comment by sandstrom in discussion of the inherited hook
> I'm thinking that it would be better to register adapters manually, without using the hook, i.e.
> have people call ActiveModel::Serializer::Adapter.register directly (perhaps in an initializer).
> Possibly, some inspiration can be taken from how ActiveJob adapters are wired[1].
> [1] a11571cec3/activejob/lib/active_job/queue_adapter.rb (L52-L56)
This commit is contained in:
parent
af99c0d9e6
commit
363345b8dd
@ -91,9 +91,9 @@ ActiveModel::Serializer::Adapter.register(:special_adapter, MyAdapter)
|
|||||||
|
|
||||||
| `ActiveModel::Serializer::Adapter.adapter_map` | A Hash of all known adapters { adapter_name => adapter_class } |
|
| `ActiveModel::Serializer::Adapter.adapter_map` | A Hash of all known adapters { adapter_name => adapter_class } |
|
||||||
| `ActiveModel::Serializer::Adapter.adapters` | A (sorted) Array of all known adapter_names |
|
| `ActiveModel::Serializer::Adapter.adapters` | A (sorted) Array of all known adapter_names |
|
||||||
| `ActiveModel::Serializer::Adapter.get(name_or_klass)` | The adapter_class, else raises an `ActiveModel::Serializer::Adapter::UnknownAdapter` error |
|
| `ActiveModel::Serializer::Adapter.lookup(name_or_klass)` | The adapter_class, else raises an `ActiveModel::Serializer::Adapter::UnknownAdapter` error |
|
||||||
| `ActiveModel::Serializer::Adapter.adapter_class(adapter)` | delegates to `ActiveModel::Serializer::Adapter.get(adapter)` |
|
| `ActiveModel::Serializer::Adapter.adapter_class(adapter)` | delegates to `ActiveModel::Serializer::Adapter.lookup(adapter)` |
|
||||||
| `ActiveModel::Serializer.adapter` | a convenience method for `ActiveModel::Serializer::Adapter.get(config.adapter)` |
|
| `ActiveModel::Serializer.adapter` | a convenience method for `ActiveModel::Serializer::Adapter.lookup(config.adapter)` |
|
||||||
|
|
||||||
The registered adapter name is always a String, but may be looked up as a Symbol or String.
|
The registered adapter name is always a String, but may be looked up as a Symbol or String.
|
||||||
Helpfully, the Symbol or String is underscored, so that `get(:my_adapter)` and `get("MyAdapter")`
|
Helpfully, the Symbol or String is underscored, so that `get(:my_adapter)` and `get("MyAdapter")`
|
||||||
|
|||||||
@ -94,9 +94,9 @@ module ActiveModel
|
|||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
# @see ActiveModel::Serializer::Adapter.get
|
# @see ActiveModel::Serializer::Adapter.lookup
|
||||||
def self.adapter
|
def self.adapter
|
||||||
ActiveModel::Serializer::Adapter.get(config.adapter)
|
ActiveModel::Serializer::Adapter.lookup(config.adapter)
|
||||||
end
|
end
|
||||||
|
|
||||||
def self.root_name
|
def self.root_name
|
||||||
|
|||||||
@ -17,9 +17,9 @@ module ActiveModel
|
|||||||
klass.new(resource, options)
|
klass.new(resource, options)
|
||||||
end
|
end
|
||||||
|
|
||||||
# @see ActiveModel::Serializer::Adapter.get
|
# @see ActiveModel::Serializer::Adapter.lookup
|
||||||
def self.adapter_class(adapter)
|
def self.adapter_class(adapter)
|
||||||
ActiveModel::Serializer::Adapter.get(adapter)
|
ActiveModel::Serializer::Adapter.lookup(adapter)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Only the Adapter class has these methods.
|
# Only the Adapter class has these methods.
|
||||||
@ -49,7 +49,7 @@ module ActiveModel
|
|||||||
# @param adapter [String, Symbol, Class] name to fetch adapter by
|
# @param adapter [String, Symbol, Class] name to fetch adapter by
|
||||||
# @return [ActiveModel::Serializer::Adapter] subclass of Adapter
|
# @return [ActiveModel::Serializer::Adapter] subclass of Adapter
|
||||||
# @raise [UnknownAdapterError]
|
# @raise [UnknownAdapterError]
|
||||||
def get(adapter)
|
def lookup(adapter)
|
||||||
# 1. return if is a class
|
# 1. return if is a class
|
||||||
return adapter if adapter.is_a?(Class)
|
return adapter if adapter.is_a?(Class)
|
||||||
adapter_name = adapter.to_s.underscore
|
adapter_name = adapter.to_s.underscore
|
||||||
|
|||||||
@ -83,33 +83,33 @@ module ActiveModel
|
|||||||
]
|
]
|
||||||
end
|
end
|
||||||
|
|
||||||
def test_get_adapter_by_string_name
|
def test_lookup_adapter_by_string_name
|
||||||
assert_equal ActiveModel::Serializer::Adapter.get('json'.freeze), ActiveModel::Serializer::Adapter::Json
|
assert_equal ActiveModel::Serializer::Adapter.lookup('json'.freeze), ActiveModel::Serializer::Adapter::Json
|
||||||
end
|
end
|
||||||
|
|
||||||
def test_get_adapter_by_symbol_name
|
def test_lookup_adapter_by_symbol_name
|
||||||
assert_equal ActiveModel::Serializer::Adapter.get(:json), ActiveModel::Serializer::Adapter::Json
|
assert_equal ActiveModel::Serializer::Adapter.lookup(:json), ActiveModel::Serializer::Adapter::Json
|
||||||
end
|
end
|
||||||
|
|
||||||
def test_get_adapter_by_class
|
def test_lookup_adapter_by_class
|
||||||
klass = ActiveModel::Serializer::Adapter::Json
|
klass = ActiveModel::Serializer::Adapter::Json
|
||||||
assert_equal ActiveModel::Serializer::Adapter.get(klass), klass
|
assert_equal ActiveModel::Serializer::Adapter.lookup(klass), klass
|
||||||
end
|
end
|
||||||
|
|
||||||
def test_get_adapter_from_environment_registers_adapter
|
def test_lookup_adapter_from_environment_registers_adapter
|
||||||
ActiveModel::Serializer::Adapter.const_set(:AdapterFromEnvironment, Class.new)
|
ActiveModel::Serializer::Adapter.const_set(:AdapterFromEnvironment, Class.new)
|
||||||
klass = ::ActiveModel::Serializer::Adapter::AdapterFromEnvironment
|
klass = ::ActiveModel::Serializer::Adapter::AdapterFromEnvironment
|
||||||
name = 'adapter_from_environment'.freeze
|
name = 'adapter_from_environment'.freeze
|
||||||
assert_equal ActiveModel::Serializer::Adapter.get(name), klass
|
assert_equal ActiveModel::Serializer::Adapter.lookup(name), klass
|
||||||
assert ActiveModel::Serializer::Adapter.adapters.include?(name)
|
assert ActiveModel::Serializer::Adapter.adapters.include?(name)
|
||||||
ensure
|
ensure
|
||||||
ActiveModel::Serializer::Adapter.adapter_map.delete(name)
|
ActiveModel::Serializer::Adapter.adapter_map.delete(name)
|
||||||
ActiveModel::Serializer::Adapter.send(:remove_const, :AdapterFromEnvironment)
|
ActiveModel::Serializer::Adapter.send(:remove_const, :AdapterFromEnvironment)
|
||||||
end
|
end
|
||||||
|
|
||||||
def test_get_adapter_for_unknown_name
|
def test_lookup_adapter_for_unknown_name
|
||||||
assert_raises UnknownAdapterError do
|
assert_raises UnknownAdapterError do
|
||||||
ActiveModel::Serializer::Adapter.get(:json_simple)
|
ActiveModel::Serializer::Adapter.lookup(:json_simple)
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
@ -123,7 +123,7 @@ module ActiveModel
|
|||||||
new_adapter_klass = Class.new
|
new_adapter_klass = Class.new
|
||||||
ActiveModel::Serializer::Adapter.register(new_adapter_name, new_adapter_klass)
|
ActiveModel::Serializer::Adapter.register(new_adapter_name, new_adapter_klass)
|
||||||
assert ActiveModel::Serializer::Adapter.adapters.include?('foo'.freeze)
|
assert ActiveModel::Serializer::Adapter.adapters.include?('foo'.freeze)
|
||||||
assert ActiveModel::Serializer::Adapter.get(:foo), new_adapter_klass
|
assert ActiveModel::Serializer::Adapter.lookup(:foo), new_adapter_klass
|
||||||
ensure
|
ensure
|
||||||
ActiveModel::Serializer::Adapter.adapter_map.delete(new_adapter_name.to_s)
|
ActiveModel::Serializer::Adapter.adapter_map.delete(new_adapter_name.to_s)
|
||||||
end
|
end
|
||||||
@ -132,7 +132,7 @@ module ActiveModel
|
|||||||
Object.const_set(:MyAdapter, Class.new)
|
Object.const_set(:MyAdapter, Class.new)
|
||||||
my_adapter = MyAdapter
|
my_adapter = MyAdapter
|
||||||
ActiveModel::Serializer::Adapter.inherited(my_adapter)
|
ActiveModel::Serializer::Adapter.inherited(my_adapter)
|
||||||
assert_equal ActiveModel::Serializer::Adapter.get(:my_adapter), my_adapter
|
assert_equal ActiveModel::Serializer::Adapter.lookup(:my_adapter), my_adapter
|
||||||
ensure
|
ensure
|
||||||
ActiveModel::Serializer::Adapter.adapter_map.delete('my_adapter'.freeze)
|
ActiveModel::Serializer::Adapter.adapter_map.delete('my_adapter'.freeze)
|
||||||
Object.send(:remove_const, :MyAdapter)
|
Object.send(:remove_const, :MyAdapter)
|
||||||
@ -143,7 +143,7 @@ module ActiveModel
|
|||||||
MyNamespace.const_set(:MyAdapter, Class.new)
|
MyNamespace.const_set(:MyAdapter, Class.new)
|
||||||
my_adapter = MyNamespace::MyAdapter
|
my_adapter = MyNamespace::MyAdapter
|
||||||
ActiveModel::Serializer::Adapter.inherited(my_adapter)
|
ActiveModel::Serializer::Adapter.inherited(my_adapter)
|
||||||
assert_equal ActiveModel::Serializer::Adapter.get(:my_adapter), my_adapter
|
assert_equal ActiveModel::Serializer::Adapter.lookup(:my_adapter), my_adapter
|
||||||
ensure
|
ensure
|
||||||
ActiveModel::Serializer::Adapter.adapter_map.delete('my_adapter'.freeze)
|
ActiveModel::Serializer::Adapter.adapter_map.delete('my_adapter'.freeze)
|
||||||
MyNamespace.send(:remove_const, :MyAdapter)
|
MyNamespace.send(:remove_const, :MyAdapter)
|
||||||
@ -157,8 +157,8 @@ module ActiveModel
|
|||||||
my_subclassed_adapter = MySubclassedAdapter
|
my_subclassed_adapter = MySubclassedAdapter
|
||||||
ActiveModel::Serializer::Adapter.inherited(my_adapter)
|
ActiveModel::Serializer::Adapter.inherited(my_adapter)
|
||||||
ActiveModel::Serializer::Adapter.inherited(my_subclassed_adapter)
|
ActiveModel::Serializer::Adapter.inherited(my_subclassed_adapter)
|
||||||
assert_equal ActiveModel::Serializer::Adapter.get(:my_adapter), my_adapter
|
assert_equal ActiveModel::Serializer::Adapter.lookup(:my_adapter), my_adapter
|
||||||
assert_equal ActiveModel::Serializer::Adapter.get(:my_subclassed_adapter), my_subclassed_adapter
|
assert_equal ActiveModel::Serializer::Adapter.lookup(:my_subclassed_adapter), my_subclassed_adapter
|
||||||
ensure
|
ensure
|
||||||
ActiveModel::Serializer::Adapter.adapter_map.delete('my_adapter'.freeze)
|
ActiveModel::Serializer::Adapter.adapter_map.delete('my_adapter'.freeze)
|
||||||
ActiveModel::Serializer::Adapter.adapter_map.delete('my_subclassed_adapter'.freeze)
|
ActiveModel::Serializer::Adapter.adapter_map.delete('my_subclassed_adapter'.freeze)
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user