Skip to content

DOCSP-50809: bson 5.1 release #159

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jul 1, 2025
Merged

DOCSP-50809: bson 5.1 release #159

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c146605
DOCSP-50809: bson 5.1 release
rustagir Jul 1, 2025
b324325
MM small PR fixes
rustagir Jul 1, 2025
3ecfcc8
JB tech review
rustagir Jul 1, 2025
b2cae47
compat fix
rustagir Jul 1, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions source/includes/compatibility-table-legend-ruby.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,6 @@ Compatibility Table Legend
* - ✓
- All features are supported.
* - D
- Support for the Driver version is deprecated.
- Support for the MongoDB or language version is deprecated.
* - No mark
- The Driver version is not tested with the MongoDB version.
- The driver version is not tested with the MongoDB or language version.
134 changes: 24 additions & 110 deletions source/includes/language-compatibility-table-ruby.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
:class: compatibility-large no-padding

* - Ruby Driver
- Ruby 3.3
- Ruby 3.2
- Ruby 3.1
- Ruby 3.0
Expand All @@ -14,125 +15,38 @@
- JRuby 9.2
- JRuby 9.1

* - 2.20 to 2.21
- |checkmark|
- |checkmark|
- |checkmark|
- D
-
- |checkmark|
- |checkmark|
* - 2.22
- ✓
- ✓
- ✓
- ✓
- D
-

* - 2.19
- |checkmark|
- |checkmark|
- |checkmark|
- |checkmark|
- ✓
- ✓
- D
-
- |checkmark|
- |checkmark|
-

* - 2.18
- |checkmark|
- |checkmark|
- |checkmark|
- |checkmark|
- |checkmark|
-
- |checkmark|
- |checkmark|
-

* - 2.17
-
- |checkmark|
- |checkmark|
- |checkmark|
- |checkmark|
-
-
- |checkmark|
-

* - 2.16
-
-
- |checkmark|
- |checkmark|
- |checkmark|
-
-
- |checkmark|
-

* - 2.15
-
-
- |checkmark|
- |checkmark|
- |checkmark|
-
-
- |checkmark|
-

* - 2.14
-
-
-
- |checkmark|
- |checkmark|
-
-
- |checkmark|
-

* - 2.11 to 2.13
-
-
-
- |checkmark|
- |checkmark|
-
-
- |checkmark|
-

* - 2.10
-
-
-
- |checkmark|
- |checkmark|
-
-
- |checkmark|
- |checkmark|

* - 2.9
-
-
-
* - 2.20 to 2.21
-
- |checkmark|
- ✓
- ✓
- ✓
- D
-
- ✓
- ✓
- D
-
- |checkmark|
- |checkmark|

* - 2.6 to 2.8
-
-
-
* - 2.19
-
- |checkmark|
- ✓
- ✓
- ✓
- ✓
- D
-
- ✓
- ✓
-
- |checkmark|
- |checkmark|

.. include:: /includes/unicode-checkmark.rst
54 changes: 6 additions & 48 deletions source/includes/mongodb-compatibility-table-ruby.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,58 +9,16 @@
- MongoDB 6.0

* - 2.21
- |checkmark|
- |checkmark|
- |checkmark|
- ✓
- ✓
- ✓

* - 2.19 to 2.20
-
- |checkmark|
- |checkmark|
- ✓
- ✓

* - 2.18
-
-
- |checkmark|

* - 2.17
-
-
-

* - 2.16
-
-
-

* - 2.14 to 2.15
-
-
-

* - 2.13
-
-
-

* - 2.12
-
-
-

* - 2.11
-
-
-

* - 2.10
-
-
-

* - 2.6 to 2.9
-
-
-

.. include:: /includes/unicode-checkmark.rst
- ✓
1 change: 0 additions & 1 deletion source/includes/unicode-checkmark.rst
View file
Open in desktop

This file was deleted.

2 changes: 0 additions & 2 deletions source/includes/unicode-nbsp.rst
View file
Open in desktop

This file was deleted.

31 changes: 28 additions & 3 deletions source/reference/release-notes.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,9 @@ Release Notes

Learn what's new in:

* :ref:`2.22 <ruby-version-2.22>`
* :ref:`2.21 <version-2.21>`
* :ref:`2.20 <version-2.20>`
* :ref:`Version 2.22 <ruby-version-2.22>`
* :ref:`Version 2.21 <version-2.21>`
* :ref:`Version 2.20 <version-2.20>`

.. _upcoming-breaking-changes:

Expand All @@ -42,6 +42,31 @@ The {+driver-short+} 2.22 release includes the following new features:

- Adds compatibility with {+language+} 3.3.

BSON v5.1
~~~~~~~~~

The ``bson`` gem is the implementation of the BSON specification in
{+language+}. ``bson`` v5.1 accompanies the {+driver-short+} v2.22
release.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We actually discovered that all the changes we meant to release in driver v2.22 somehow got released in 2.21.1. This includes the vector search support in the driver, though it wouldn't have worked until bson 5.1.0.

So, bson 5.1.0 supports ruby driver 2.21.1. There will be a driver 2.22 eventually, but probably not imminently.


The ``bson`` 5.1 release includes the following new features, changes,
and improvements:

- Adds the ``BSON::Vector`` type to represent vectors of numeric values.
To learn more, see the :ref:`ruby-bson-vector` section of the BSON
guide.

- ``BSON::Document`` objects do not support use of the
``#deep_symbolize_keys!`` and ``#symbolize_keys!`` methods. In
previous versions, the ``#symbolize_keys!`` method raises an
``ArgumentError`` when used on a ``BSON::Document``, but
``#deep_symbolize_keys!`` does not, and only returns a ``Hash``
rather than a ``BSON::Document``.

This release adds a warning when you use ``#deep_symbolize_keys!`` on a
``BSON::Document`` instance. In ``bson`` v6.0, this action will raise
an error.

.. _version-2.21:

What's New in 2.21
Expand Down
Loading