Enable use of an object key in serilaized forms
#1354
Closed
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Because all serializers already implement an `object` method (part of the API expected when customizing a serializer), attempting to add a key to the serialized object with the name `object` would not output the expected value, and would instead dump a serialized version of the object under serialization. Instead of having attributes directly map to methods on the serializer, we introduce one layer of abstraction: the `_attributes_map`. This hash maps the key names expected in the output to the names of the implementing methods. This simplifies some things (removing the need to maintain both `_attributes` and `_attribute_keys`), but does add some complexity.
|
@noahsilas Thanks for this. I believe this will be resolved by a PR such as @beauby 's #1262 |
|
@bf4 I tried checking that out locally and adding my test case, but it still fails: I'll start looking into #1262 and see how I can resolve my commit against it. |
|
@noahsilas I'll have a PR soon, just some finishing touches |
11 tasks
| adapter = ActiveModel::Serializer::Adapter::Json.new(serializer.new(@blog)) | ||
| assert_equal({ blog: { object: 'AMS Hints' } }, adapter.serializable_hash) | ||
| end | ||
|
|
|
Just requires a little more inline documentation, but otherwise LGTM! :-) |
|
@NullVoxPopuli: This ended up getting merged via #1356 as 7bde7bf. I'm going to close this PR, but I'll come back later with another to improve those docs. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Because all serializers already implement an
objectmethod (part of the API expected when customizing a serializer), attempting to add a key to the serialized object with the nameobjectwould not output the expected value, and would instead dump a serialized version of the object under serialization.This prevents a commonly used identifier from appearing in serialized output. As one real world example, the Stripe API includes an
objectkey in each serialized object describing its type.I introduced a change in the storage for the serializer configuration, and added methods to access it in the same way as before. Open question: I stored the key/attribute mapping in a Hash<Symbol => Symbol>; would the project be better served mapping to a nested hash to support additional configuration options in the future without changing the storage again?
This may have introduced a breaking change; before, methods were defined on the serializer based on the name of the key; now they will be defined based on the name of the underlying attribute. This behavior doesn't seem to be explicitly mentioned in docs or tested anywhere, though, so it may be a non-issue.