Add symbol support for Serializer.type method #1515
Conversation
groyoh
force-pushed
the
symbol_type
branch
3 times, most recently
from
d3d6656
to
ce9d119
Compare
| @@ -17,7 +17,7 @@ module ClassMethods | |||
| # class AdminAuthorSerializer < ActiveModel::Serializer | |||
| # type 'authors' | |||
| def type(type) | |||
| self._type = type | |||
| self._type = type ? type.to_s : nil | |||
There was a problem hiding this comment.
Because of this, we might call serializer.type(nil) and then nil.to_s results in "". I tried self._type = type if type at first but then two specs were failling out of nowhere. It looked like something related to the cache but I could not really figure it out.
There was a problem hiding this comment.
type && type.to_s
B mobile phone
On Feb 15, 2016, at 1:53 AM, Yohan Robert notifications@github.com wrote:
In lib/active_model/serializer/type.rb:
@@ -17,7 +17,7 @@ module ClassMethods
# class AdminAuthorSerializer < ActiveModel::Serializer
# type 'authors'
def type(type)
self._type = typeself._type = type ? type.to_s : nil—
Reply to this email directly or view it on GitHub.
There was a problem hiding this comment.
Ah right, it didn't come to my mind.
groyoh
force-pushed
the
symbol_type
branch
2 times, most recently
from
a0583f1
to
9cdba4a
Compare
groyoh
force-pushed
the
symbol_type
branch
3 times, most recently
from
067d00f
to
e1bdbbf
Compare
|
@joaomdmoura could you check if the doc I added sounds good to you? |
| The `::type` method defines the JSONAPI [type](http://jsonapi.org/format/#document-resource-object-identification) that will be rendered for this serializer. | ||
| It either takes a `String` or `Symbol` as parameter. | ||
|
|
||
| Note: This method is useful only when using the `:json_api` adapter. |
There was a problem hiding this comment.
though, TODO: it should replace the json_key method and root option..
There was a problem hiding this comment.
Is there an open PR for this?
|
👍 |
The ActiveModel::Serializer.type method now accepts symbol as paremeter: class AuthorSerializer < ActiveModel::Serializer type :profile end The test file for the type was also refactored.
|
LGTM 👍 |
[FEATURE] Add symbol support for Serializer.type method
The
Serializer.typemethod now accepts symbol as paremeter:I don't know what you guys think about this but I usually prefer to use symbol as much as possible and thus prefer to write
type :profilethantype 'profile'. Furthermore this change should not have any runtime impact.I also refactored the tests to make it more DRY.