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

Merge pull request #1503 from feministy/0-8-stable-poro-documentation

Browse Source 
[0.8-stable] additional documentation for POROs
This commit is contained in:
Benjamin Fleischer 2016-02-12 09:02:38 -06:00
commit 1a684927c4
2 changed files with 26 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
CHANGELOG.md
View File

@ -1,5 +1,7 @@
# UNRELEASED # UNRELEASED
* Add documentation with example to `README` for POROs and alternative ORMs
# VERSION 0.8.1 # VERSION 0.8.1
* Fix bug whereby a serializer using 'options' would blow up. * Fix bug whereby a serializer using 'options' would blow up.

31
README.md
View File

@ -45,18 +45,35 @@ the serializer generator:
$ rails g serializer post $ rails g serializer post
``` ```
### Support for PORO's and other ORM's. ### Support for POROs and other ORMs.
Currently `ActiveModel::Serializers` adds serialization support to all models Currently `ActiveModel::Serializers` adds serialization support to all models
that descend from `ActiveRecord` or include `Mongoid::Document`. If you are that descend from `ActiveRecord` or include `Mongoid::Document`. If you are:
using another ORM, or if you are using objects that are `ActiveModel`
compliant but do not descend from `ActiveRecord` or include - using another ORM, or
`Mongoid::Document`, you must add an include statement for - using objects that are `ActiveModel` compliant but do not descend from
`ActiveModel::SerializerSupport` to make models serializable. If you `ActiveRecord` *or* include `Mongoid::Document`
also want to make collections serializable, you should include
You must add an include statement for `ActiveModel::SerializerSupport` to
make models serializable.
If you also want to make collections serializable, you should include
`ActiveModel::ArraySerializerSupport` into your ORM's `ActiveModel::ArraySerializerSupport` into your ORM's
relation/criteria class. relation/criteria class.
Example model (`app/models/avatar.rb`):
```ruby
class Avatar
include ActiveModel::SerializerSupport
# etc, etc
end
```
If your classes follow the naming conventions prescribed by `ActiveModel`,
you don't need to do anything different in your controller to render the
serialized json.
# ActiveModel::Serializer # ActiveModel::Serializer
All new serializers descend from ActiveModel::Serializer All new serializers descend from ActiveModel::Serializer