[Ruby] Extended JSON by rachel-mack · Pull Request #168 · mongodb/docs-ruby

rachel-mack · 2025-07-23T16:18:41Z

Pull Request Info

PR Reviewing Guidelines

JIRA - https://jira.mongodb.org/browse/DOCSP-51421

Staging Links

data-formats/extended-json

data-formats

Self-Review Checklist

Is this free of any warnings or errors in the RST?
Did you run a spell-check?
Did you run a grammar-check?
Are all the links working?
Are the facets and meta keywords accurate?
Are the page titles greater than 20 characters long and SEO relevant?

netlify · 2025-07-23T16:18:46Z

✅ Deploy Preview for docs-ruby ready!

Name	Link
🔨 Latest commit	`5233654`
🔍 Latest deploy log	https://app.netlify.com/projects/docs-ruby/deploys/6887ae1091d8c800088ff8ef
😎 Deploy Preview	https://deploy-preview-168--docs-ruby.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

docs-builder-bot · 2025-07-23T16:19:52Z

🔄 Deploy Preview for docs-ruby processing

Item	Details
🔨 Latest Commit	d8fdf3bb7d290cdf30e3aa735c998c283e8e8814
😎 Deploy Preview	https://deploy-preview-168--docs-ruby.netlify.app
🔍 Build Logs	View Logs

norareidy

Looks good so far! I left some minor comments

norareidy · 2025-07-23T20:31:11Z

+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


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

Good call out. I moved the map description to the example intro below.

norareidy

LGTM with a couple nits!

jamis · 2025-07-28T14:14:52Z

+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) }


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)

jamis · 2025-07-28T14:17:02Z

+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:


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().

* 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>

* 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>

rachel-mack changed the title ~~shared content~~[Ruby] Extended JSONJul 23, 2025

norareidy requested changes Jul 23, 2025
View reviewed changes

rachel-mack requested review from a team and jamis and removed request for a teamJuly 25, 2025 16:23

norareidy approved these changes Jul 25, 2025
View reviewed changes

Comment threadsource/data-formats/extended-json.txt Outdated
Comment threadsource/data-formats/extended-json.txt Outdated

jamis approved these changes Jul 28, 2025
View reviewed changes

rachel-mack changed the base branch from master to comp-covJuly 28, 2025 17:02

norareidyand others added 10 commits July 28, 2025 13:05

DOCSP-51932: v2.21.2 patch release (mongodb#163)
340648e

shared content
2f6de14

write
55e93e3

link formatting
0ae7c75

link formatting
c6045a9

NR feedback
cbcec5e

NR feedback
aaba8e1

JB feedback
eab9228

rephrase
c8da82d

remove extra change
5233654

rachel-mack force-pushed the DOCSP-51421-json branch from 5a4773f to 5233654Compare July 28, 2025 17:06

rachel-mack merged commit 52cf4c1 into mongodb:comp-covJul 28, 2025
5 checks passed

-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)

		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:

Uh oh!

Conversation

rachel-mack commented Jul 23, 2025• edited by github-actions BotLoading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pull Request Info

Staging Links

Self-Review Checklist

Uh oh!

netlifyBot commented Jul 23, 2025• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for docs-ruby ready!

Uh oh!

docs-builder-bot commented Jul 23, 2025• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🔄 Deploy Preview for docs-ruby processing

Uh oh!

norareidy left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

norareidyJul 23, 2025

Choose a reason for hiding this comment

Uh oh!

rachel-mackJul 25, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

norareidy left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

jamisJul 28, 2025

Choose a reason for hiding this comment

Uh oh!

jamisJul 28, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

rachel-mack commented Jul 23, 2025•
edited by github-actions Bot
Loading

netlifyBot commented Jul 23, 2025•
edited
Loading

docs-builder-bot commented Jul 23, 2025•
edited
Loading