ditkrg/active_model_serializers
4
0
Fork 0
mirror of https://github.com/ditkrg/active_model_serializers.git synced 2026-01-23 06:16:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

Namespace is included in auto-registered adapters [ci skip]

Browse Source
This commit is contained in:
Peter Wagenet 2016-01-28 14:43:22 -08:00
parent 592a5db96e
commit efdd466147
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/general/adapters.md
View File

@ -122,7 +122,7 @@ If a symbol, then the adapter must be, e.g. `:great_example`,
There are two ways to register an adapter: There are two ways to register an adapter:
1) The simplest, is to subclass `ActiveModel::Serializer::Adapter::Base`, e.g. the below will 1) The simplest, is to subclass `ActiveModel::Serializer::Adapter::Base`, e.g. the below will
register the `Example::UsefulAdapter` as `:useful_adapter`. register the `Example::UsefulAdapter` as `"example/useful_adapter"`.
```ruby ```ruby
module Example module Example
@ -131,10 +131,10 @@ module Example
end end
``` ```
You'll notice that the name it registers is the class name underscored, not the full namespace. You'll notice that the name it registers is the underscored namespace and class.
Under the covers, when the `ActiveModel::Serializer::Adapter::Base` is subclassed, it registers Under the covers, when the `ActiveModel::Serializer::Adapter::Base` is subclassed, it registers
the subclass as `register(:useful_adapter, Example::UsefulAdapter)` the subclass as `register("example/useful_adapter", Example::UsefulAdapter)`
2) Any class can be registered as an adapter by calling `register` directly on the 2) Any class can be registered as an adapter by calling `register` directly on the
`ActiveModel::Serializer::Adapter` class. e.g., the below registers `MyAdapter` as `ActiveModel::Serializer::Adapter` class. e.g., the below registers `MyAdapter` as