Adds a configuration option belongs_to_uses_id_on_self #2140
Conversation
- adding documentation and changelog - setting belongs_to_uses_id_on_self to false by default
cassiascheffer
changed the title
| @@ -28,6 +28,31 @@ Possible values: | |||
|
|
|||
| When `false`, serializers must be explicitly specified. | |||
|
|
|||
| ##### belongs_to_uses_id_on_self | |||
|
|
|||
| Enable automatic serializer lookup when using a `belongs_to` without `has_many`. | |||
There was a problem hiding this comment.
Tells the JSON:API adapter to build
belongs_torelationship id and type using the foreign key on self, rather than loading the association.
For example, a Comment that belongs to a user will have auser_idattribute.
This means the relationship will the callobject.user_idinstead ofobject.user.id, which can prevent unneeded queries.
IMPORTANT: Because the association is no longer be loaded, anytypemust come from thebelongs_tooptions astype: :comment_usersorserializer: CommentUserSerializer(which would call CommentUserSerializer._type, i.e. no instance methods)
or something to that effect. Examples below are good.
|
|
||
| ```ruby | ||
| class PostSerializer < ActiveModel::Serializer | ||
| belongs_to :foo, serializer: FooSerializer |
There was a problem hiding this comment.
examples should both be belongs to :blog, but one uses the type option and one uses the serializer option, and then show how they differ in their serialized relationship given a Post with blog_id = 1 and different BlogSerializer configurations, and what happens when both are given, or if the relationship is included...
| end | ||
| class BelongsToBlogWithCustomTypeModelSerializer < ActiveModel::Serializer | ||
| type :posts | ||
| belongs_to :blog_with_custom_type |
There was a problem hiding this comment.
also good to include an instance method json_key to show it's not used
| belongs_to :blog_with_custom_type | ||
| end | ||
|
|
||
| def test_belongs_to_allows_type_overwriting |
There was a problem hiding this comment.
test_belongs_to_doesnt_load_record should also change, no, since it requires belongs_to_uses_id_on_self to be true, no?
| @@ -43,7 +43,8 @@ def data_for(association) | |||
| end | |||
|
|
|||
| def data_for_one(association) | |||
| if association.belongs_to? && | |||
| if !ActiveModelSerializers.config.belongs_to_uses_id_on_self && | |||
There was a problem hiding this comment.
should be
- if !ActiveModelSerializers.config.belongs_to_uses_id_on_self &&
+ if ActiveModelSerializers.config.belongs_to_uses_id_on_self &&
|
@bf4 Just to clarify, do we want |
Purpose
Adds a configuration option
belongs_to_uses_id_on_selfto allow for automatic serializer lookup. This solves an issue where the customtypeattribute was not being used as the type was inferred from the associated object.Changes
ActiveModelSerializers.config.belongs_to_uses_id_on_selfCaveats
belongs_to_uses_id_on_selfto true will result in a lookup on the associated object,Related GitHub issues
Closes #2125
Additional helpful information