[Ruby] Extended JSON #168
Merged
[Ruby] Extended JSON #168
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
✅ Deploy Preview for docs-ruby ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
🔄 Deploy Preview for docs-ruby processing
|
norareidy
requested changes
Jul 23, 2025
Comment on lines
70
to
73
| You can write an Extended JSON string from a hash by using the | ||
| ``as_extended_json()`` method. Using the Ruby ``map{}`` method, you can create | ||
| an Extended JSON string from an array of hashes. By default, this method returns | ||
| the Extended JSON string in canonical format, but you can specify relaxed or |
There was a problem hiding this comment.
S: I was a little confused by this description of both the as_extended_json() method and map{}, and which one "this method" refers to. I think you can just describe as_extended_json() in this intro section, then talk about map further down:
Suggested change
| You can write an Extended JSON string from a hash by using the | |
| ``as_extended_json()`` method. Using the Ruby ``map{}`` method, you can create | |
| an Extended JSON string from an array of hashes. By default, this method returns | |
| the Extended JSON string in canonical format, but you can specify relaxed or | |
| You can write an Extended JSON string from a hash by using the | |
| ``as_extended_json()`` method. By default, this method returns | |
| the Extended JSON string in canonical format, but you can specify relaxed or |
There was a problem hiding this comment.
Good call out. I moved the map description to the example intro below.
rachel-mack
requested review from
a team and
jamis
and removed request for
a team
norareidy
approved these changes
Jul 25, 2025
jamis
approved these changes
Jul 28, 2025
Comment on lines
32
to
34
| json_array_canonical = hash_array.map(&:as_extended_json) | ||
| json_array_relaxed = hash_array.map{ |hash| hash.as_extended_json(mode: :relaxed) } | ||
| json_array_legacy = hash_array.map{ |hash| hash.as_extended_json(mode: :legacy) } |
There was a problem hiding this comment.
Note that the bson library also defines Array#as_extended_json, which does pretty much what you have (mapping the array so each element has the method invoked on it as well).
(See https://github.com/mongodb/bson-ruby/blob/master/lib/bson/array.rb#L104-L108)
Suggested change
| json_array_canonical = hash_array.map(&:as_extended_json) | |
| json_array_relaxed = hash_array.map{ |hash| hash.as_extended_json(mode: :relaxed) } | |
| json_array_legacy = hash_array.map{ |hash| hash.as_extended_json(mode: :legacy) } | |
| json_array_canonical = hash_array.as_extended_json | |
| json_array_relaxed = hash_array.as_extended_json(mode: :relaxed) | |
| json_array_legacy = hash_array.as_extended_json(mode: :legacy) |
Comment on lines
69
to
70
| and legacy formats. It calls the ``as_extended_json()`` method from inside a | ||
| Ruby ``map{}`` block to create the Extended JSON string from an array of hashes: |
There was a problem hiding this comment.
As noted in a later comment, you can invoke #as_extended_json directly on an array instance.
Suggested change
| and legacy formats. It calls the ``as_extended_json()`` method from inside a | |
| Ruby ``map{}`` block to create the Extended JSON string from an array of hashes: | |
| and legacy formats. It calls the ``#as_extended_json`` method on an array to create the | |
| Extended JSON string from an array of hashes: |
Also, Ruby convention refers to instance methods as #method_name, rather than method_name().
rachel-mack
force-pushed
the
DOCSP-51421-json
branch
from
5a4773f to
5233654
Compare
rachel-mack
added a commit
to rachel-mack/docs-ruby
that referenced
this pull request
Jul 30, 2025
* DOCSP-51932: v2.21.2 patch release (mongodb#163) * shared content * write * link formatting * link formatting * NR feedback * NR feedback * JB feedback * rephrase * remove extra change --------- Co-authored-by: Nora Reidy <nora.reidy@mongodb.com>
rachel-mack
added a commit
that referenced
this pull request
Jul 30, 2025
* DOCSP-51932: v2.21.2 patch release (#163) * change TOC name (#165) * add a redirect (#169) * [Ruby] TOC Reorg (#160) * toc reorg * tweaks * DOCSP-51415 Add causal consistency section (#161) * [Ruby] CRUD - Upsert (#164) * DOCSP-51932: v2.21.2 patch release (#163) * add upsert section * reference * LM feedback * checkout snooty --------- Co-authored-by: Nora Reidy <nora.reidy@mongodb.com> * DOCSP-51416 Network Compression (#162) * [Ruby] Load Balancers (#166) * DOCSP-51932: v2.21.2 patch release (#163) * client option * undo snooty change * formatting * formatting * DR feedback --------- Co-authored-by: Nora Reidy <nora.reidy@mongodb.com> * [Ruby] Extended JSON (#168) * DOCSP-51932: v2.21.2 patch release (#163) * shared content * write * link formatting * link formatting * NR feedback * NR feedback * JB feedback * rephrase * remove extra change --------- Co-authored-by: Nora Reidy <nora.reidy@mongodb.com> --------- Co-authored-by: Nora Reidy <nora.reidy@mongodb.com> Co-authored-by: shuangela <angela.shu@mongodb.com> Co-authored-by: Jordan Smith <45415425+jordan-smith721@users.noreply.github.com>
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.
Pull Request Info
PR Reviewing Guidelines
JIRA - https://jira.mongodb.org/browse/DOCSP-51421
Staging Links
Self-Review Checklist