Outside Controller Documentation Use #1083
Conversation
|
Do we want to add a step of saying |
| # Optional options parameters | ||
| options = {} | ||
|
|
||
| # Create the serializer! |
There was a problem hiding this comment.
Maybe it's better to avoid punctuation here.
|
Fixed. |
| serializer = ActiveModel::SerializableResource.serialize(post, options) | ||
| ``` | ||
|
|
||
| This will return an instance of the SerialzableResource class that will allow you to serialze your model. |
There was a problem hiding this comment.
As a reader, I'm left with an ActiveModel::SerializableResource although I was expecting information to make an actual json string.
Edit: You mentioned that before. I think it is definitely worth adding the final step here.
|
Definitely. The initial issue referenced that step as well. |
| model_json = serializer.as_json | ||
| ``` | ||
|
|
||
| This will return an instance of the SerialzableResource class that will allow you to serialze your model. |
There was a problem hiding this comment.
This comment is a bit awkward here now that you added the final step 😄
|
True that. Deleted the redundant lines. |
| @@ -13,6 +13,8 @@ This is the documentation of AMS, it's focused on the **0.10.x version.** | |||
|
|
|||
| - [How to add root key](howto/add_root_key.md) | |||
|
|
|||
| - [Filtering Assocations](howto/filter_associations.md) | |||
There was a problem hiding this comment.
Is this related to the current PR?
There was a problem hiding this comment.
It is not! Good catch there!
|
Updated a few things. Let me know if I missed something! |
| You could also retrieve the serializer via: | ||
|
|
||
| ```ruby | ||
| ActiveModel::SerializableResource.serialize(post, options).serializer |
There was a problem hiding this comment.
Due to likely changes, I think we'll want ActiveModel::SerializableResource.new(post, options).serializer
There was a problem hiding this comment.
@CodedBeardedSignedTaylor indeed if you are not passing a block you also don't need to use .serialize and can go straight with ActiveModel::SerializableResource.new(post, options).serializer
There was a problem hiding this comment.
I think we're going to soon be removing the .serialize method, since it turns out it is more confusing than useful.
so, like @joaomdmoura wrote serializable_resource = ActiveModel::SerializableResource.new(post, options).serializer
(when I wrote the method, I thought the class would be re-used for deserialization..)
|
👍 |
|
(You might want to rebase and force push...) |
|
True that. |
|
Did somewhat of a clumsy rebase, but I believe it should be up to date now! |
|
Hmmmm. Build is failing for whatever reason. Looking into it now. |
|
This is nice, something we're really looking forward to have, can you check the last comment @CodedBeardedSignedTaylor and squash the commits so I can merge it 😄 ? |
|
|
||
| ### Retrieving a Resource's Active Model Serializer | ||
|
|
||
| If you want to retrieve a serializer for a specific resource, you can do the following: |
There was a problem hiding this comment.
I'm not sure what the use case is, right now, for getting a serializer class or instance. The only thing I can think of is to test that the serializer works as expected, which still requires and adapter...
If you can think of one, I think it would be good to add
There was a problem hiding this comment.
I'm not really sure. I mainly added this because it was one of the requests of the initial issue. Still might be worth having for the moment.
|
@CodedBeardedSignedTaylor Lemme know if you'd like to pair on bringing this to completion, e.g. rebasing. I'm at http://benjaminfleischer.com/pair |
|
TODOs in future PRs: Serializing a resource section 2
|
|
Thanks for the offer @bf4! I think I did it correctly this time. Might need to work with you on future stuff though. |
|
Also, agreed to the To-Do stuff! |
|
@CodedBeardedSignedTaylor are you in the AMS slack? https://amserializers.herokuapp.com/ |
|
@bf4 Yep! Haven't been on in like a week or so though. |
|
Can you squash it into a single commit please? 😁 @CodedBeardedSignedTaylor |
|
Did that work? I still have merges of the master's repo in my master (thus, they show up as commits). Sorry, I'm kind of bad at squashing commits :( |
Fixed indentation in readme under 'using without render' Get rid of unnecessary instance variables, and implied dependencies. Fix typo in fieldset exception Updating wording on cache expiry in README Extended format for JSONAPI `include` option. Add lint tests for AR models.
punctuation fixes as json addition eliminated redundancy minor tweaks README fix modifications to tutorial punctuation fixes as json addition minor tweaks modifications to tutorial punctuation fixes as json addition eliminated redundancy minor tweaks modifications to tutorial as json addition eliminated redundancy minor tweaks final edits final final changes
|
hey @CodedBeardedSignedTaylor if you could squash this PR, or re-submit a new PR with a single commit, that would be fantastic. we'll give ya a couple days -- but after that, we'll do it for ya. But we'll be sure to set the commit author to you. |
|
#1155 is now the current pull request. Sorry for all the messiness! |
Fulfilling #1036.