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

Merge pull request #1479 from wagenet/patch-1

Browse Source 
Adapters inherit from Adapter::Base
This commit is contained in:
Benjamin Fleischer 2016-01-28 16:53:19 -06:00
commit 592a5db96e
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

@ -121,19 +121,19 @@ 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`, 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 `:useful_adapter`.
```ruby ```ruby
module Example module Example
class UsefulAdapter < ActiveModel::Serializer::Adapter class UsefulAdapter < ActiveModel::Serializer::Adapter::Base
end end
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 class name underscored, not the full namespace.
Under the covers, when the `ActiveModel::Serializer::Adapter` 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(: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