diff --git a/docs/general/adapters.md b/docs/general/adapters.md index d7363a9f..b505a7f5 100644 --- a/docs/general/adapters.md +++ b/docs/general/adapters.md @@ -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.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.adapter_class(adapter)` | delegates to `ActiveModel::Serializer::Adapter.get(adapter)` | -| `ActiveModel::Serializer.adapter` | a convenience method for `ActiveModel::Serializer::Adapter.get(config.adapter)` | +| `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.lookup(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. Helpfully, the Symbol or String is underscored, so that `get(:my_adapter)` and `get("MyAdapter")` diff --git a/lib/active_model/serializer.rb b/lib/active_model/serializer.rb index f6bef4a1..29acbabf 100644 --- a/lib/active_model/serializer.rb +++ b/lib/active_model/serializer.rb @@ -94,9 +94,9 @@ module ActiveModel end end - # @see ActiveModel::Serializer::Adapter.get + # @see ActiveModel::Serializer::Adapter.lookup def self.adapter - ActiveModel::Serializer::Adapter.get(config.adapter) + ActiveModel::Serializer::Adapter.lookup(config.adapter) end def self.root_name diff --git a/lib/active_model/serializer/adapter.rb b/lib/active_model/serializer/adapter.rb index 3797c39e..093dc3f8 100644 --- a/lib/active_model/serializer/adapter.rb +++ b/lib/active_model/serializer/adapter.rb @@ -17,9 +17,9 @@ module ActiveModel klass.new(resource, options) end - # @see ActiveModel::Serializer::Adapter.get + # @see ActiveModel::Serializer::Adapter.lookup def self.adapter_class(adapter) - ActiveModel::Serializer::Adapter.get(adapter) + ActiveModel::Serializer::Adapter.lookup(adapter) end # Only the Adapter class has these methods. @@ -49,7 +49,7 @@ module ActiveModel # @param adapter [String, Symbol, Class] name to fetch adapter by # @return [ActiveModel::Serializer::Adapter] subclass of Adapter # @raise [UnknownAdapterError] - def get(adapter) + def lookup(adapter) # 1. return if is a class return adapter if adapter.is_a?(Class) adapter_name = adapter.to_s.underscore diff --git a/test/serializers/adapter_for_test.rb b/test/serializers/adapter_for_test.rb index b246b404..5bab05ae 100644 --- a/test/serializers/adapter_for_test.rb +++ b/test/serializers/adapter_for_test.rb @@ -83,33 +83,33 @@ module ActiveModel ] end - def test_get_adapter_by_string_name - assert_equal ActiveModel::Serializer::Adapter.get('json'.freeze), ActiveModel::Serializer::Adapter::Json + def test_lookup_adapter_by_string_name + assert_equal ActiveModel::Serializer::Adapter.lookup('json'.freeze), ActiveModel::Serializer::Adapter::Json end - def test_get_adapter_by_symbol_name - assert_equal ActiveModel::Serializer::Adapter.get(:json), ActiveModel::Serializer::Adapter::Json + def test_lookup_adapter_by_symbol_name + assert_equal ActiveModel::Serializer::Adapter.lookup(:json), ActiveModel::Serializer::Adapter::Json end - def test_get_adapter_by_class + def test_lookup_adapter_by_class klass = ActiveModel::Serializer::Adapter::Json - assert_equal ActiveModel::Serializer::Adapter.get(klass), klass + assert_equal ActiveModel::Serializer::Adapter.lookup(klass), klass 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) klass = ::ActiveModel::Serializer::Adapter::AdapterFromEnvironment 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) ensure ActiveModel::Serializer::Adapter.adapter_map.delete(name) ActiveModel::Serializer::Adapter.send(:remove_const, :AdapterFromEnvironment) end - def test_get_adapter_for_unknown_name + def test_lookup_adapter_for_unknown_name assert_raises UnknownAdapterError do - ActiveModel::Serializer::Adapter.get(:json_simple) + ActiveModel::Serializer::Adapter.lookup(:json_simple) end end @@ -123,7 +123,7 @@ module ActiveModel new_adapter_klass = Class.new ActiveModel::Serializer::Adapter.register(new_adapter_name, new_adapter_klass) 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 ActiveModel::Serializer::Adapter.adapter_map.delete(new_adapter_name.to_s) end @@ -132,7 +132,7 @@ module ActiveModel Object.const_set(:MyAdapter, Class.new) my_adapter = MyAdapter 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 ActiveModel::Serializer::Adapter.adapter_map.delete('my_adapter'.freeze) Object.send(:remove_const, :MyAdapter) @@ -143,7 +143,7 @@ module ActiveModel MyNamespace.const_set(:MyAdapter, Class.new) my_adapter = MyNamespace::MyAdapter 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 ActiveModel::Serializer::Adapter.adapter_map.delete('my_adapter'.freeze) MyNamespace.send(:remove_const, :MyAdapter) @@ -157,8 +157,8 @@ module ActiveModel my_subclassed_adapter = MySubclassedAdapter ActiveModel::Serializer::Adapter.inherited(my_adapter) ActiveModel::Serializer::Adapter.inherited(my_subclassed_adapter) - assert_equal ActiveModel::Serializer::Adapter.get(:my_adapter), my_adapter - assert_equal ActiveModel::Serializer::Adapter.get(:my_subclassed_adapter), 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 ActiveModel::Serializer::Adapter.adapter_map.delete('my_adapter'.freeze) ActiveModel::Serializer::Adapter.adapter_map.delete('my_subclassed_adapter'.freeze)