From c14660560a3d819dcb4e2cefbe4854d6bbd97a93 Mon Sep 17 00:00:00 2001 From: rustagir Date: Tue, 1 Jul 2025 11:36:34 -0400 Subject: [PATCH 1/4] DOCSP-50809: bson 5.1 release --- .../compatibility-table-legend-ruby.rst | 4 +- .../language-compatibility-table-ruby.rst | 134 ++++-------------- source/reference/release-notes.txt | 30 +++- 3 files changed, 53 insertions(+), 115 deletions(-) diff --git a/source/includes/compatibility-table-legend-ruby.rst b/source/includes/compatibility-table-legend-ruby.rst index e1148189..953abc25 100644 --- a/source/includes/compatibility-table-legend-ruby.rst +++ b/source/includes/compatibility-table-legend-ruby.rst @@ -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. \ No newline at end of file + - The driver version is not tested with the MongoDB or language version. diff --git a/source/includes/language-compatibility-table-ruby.rst b/source/includes/language-compatibility-table-ruby.rst index 10a303b2..c65d1f03 100644 --- a/source/includes/language-compatibility-table-ruby.rst +++ b/source/includes/language-compatibility-table-ruby.rst @@ -4,6 +4,7 @@ :class: compatibility-large no-padding * - Ruby Driver + - Ruby 3.3 - Ruby 3.2 - Ruby 3.1 - Ruby 3.0 @@ -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 \ No newline at end of file diff --git a/source/reference/release-notes.txt b/source/reference/release-notes.txt index 652ce3f5..dde5e682 100644 --- a/source/reference/release-notes.txt +++ b/source/reference/release-notes.txt @@ -20,9 +20,9 @@ Release Notes Learn what's new in: -* :ref:`2.22 ` -* :ref:`2.21 ` -* :ref:`2.20 ` +* :ref:`Version 2.22 ` +* :ref:`Version 2.21 ` +* :ref:`Version 2.20 ` .. _upcoming-breaking-changes: @@ -42,6 +42,30 @@ 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. + +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. + +- The ``#deep_symbolize_keys!`` and ``#symbolize_keys!`` methods are not + supported on ``BSON::Document`` objects. In previous versions, + ``#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 From b324325c41ae6054b10dafe538f1f86eac6e825b Mon Sep 17 00:00:00 2001 From: rustagir Date: Tue, 1 Jul 2025 13:06:24 -0400 Subject: [PATCH 2/4] MM small PR fixes --- .../mongodb-compatibility-table-ruby.rst | 54 +++---------------- source/includes/unicode-checkmark.rst | 1 - source/includes/unicode-nbsp.rst | 2 - source/reference/release-notes.txt | 11 ++-- 4 files changed, 12 insertions(+), 56 deletions(-) delete mode 100644 source/includes/unicode-checkmark.rst delete mode 100644 source/includes/unicode-nbsp.rst diff --git a/source/includes/mongodb-compatibility-table-ruby.rst b/source/includes/mongodb-compatibility-table-ruby.rst index 96e63a73..a01c25c2 100644 --- a/source/includes/mongodb-compatibility-table-ruby.rst +++ b/source/includes/mongodb-compatibility-table-ruby.rst @@ -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 \ No newline at end of file + - ✓ diff --git a/source/includes/unicode-checkmark.rst b/source/includes/unicode-checkmark.rst deleted file mode 100644 index 16f4e947..00000000 --- a/source/includes/unicode-checkmark.rst +++ /dev/null @@ -1 +0,0 @@ -.. |checkmark| unicode:: U+2713 diff --git a/source/includes/unicode-nbsp.rst b/source/includes/unicode-nbsp.rst deleted file mode 100644 index aa0e52ea..00000000 --- a/source/includes/unicode-nbsp.rst +++ /dev/null @@ -1,2 +0,0 @@ -.. |nbsp| unicode:: 0xA0 - :trim: diff --git a/source/reference/release-notes.txt b/source/reference/release-notes.txt index dde5e682..fbdb523f 100644 --- a/source/reference/release-notes.txt +++ b/source/reference/release-notes.txt @@ -56,11 +56,12 @@ and improvements: To learn more, see the :ref:`ruby-bson-vector` section of the BSON guide. -- The ``#deep_symbolize_keys!`` and ``#symbolize_keys!`` methods are not - supported on ``BSON::Document`` objects. In previous versions, - ``#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``. +- ``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 From 3ecfcc8db22a2455f8e9f5ff93fc462df1323734 Mon Sep 17 00:00:00 2001 From: rustagir Date: Tue, 1 Jul 2025 15:43:30 -0400 Subject: [PATCH 3/4] JB tech review --- snooty.toml | 2 +- source/reference/release-notes.txt | 16 +++++++++------- 2 files changed, 10 insertions(+), 8 deletions(-) diff --git a/snooty.toml b/snooty.toml index d3559b83..1d847082 100644 --- a/snooty.toml +++ b/snooty.toml @@ -23,7 +23,7 @@ mongo-enterprise = "MongoDB Enterprise Edition" docs-branch = "master" # always set this to the driver branch (i.e. 1.7 1.8, etc.) version-number = "2.21" -patch-version-number = "{+version-number+}.0" +patch-version-number = "{+version-number+}.1" version = "v{+version-number+}" stable-api = "Stable API" api-root = "https://www.mongodb.com/docs/ruby-driver/current/api/" diff --git a/source/reference/release-notes.txt b/source/reference/release-notes.txt index fbdb523f..459c8426 100644 --- a/source/reference/release-notes.txt +++ b/source/reference/release-notes.txt @@ -20,18 +20,19 @@ Release Notes Learn what's new in: -* :ref:`Version 2.22 ` +* :ref:`Version 2.21.1 ` * :ref:`Version 2.21 ` * :ref:`Version 2.20 ` .. _upcoming-breaking-changes: -.. _ruby-version-2.22: +.. _ruby-version-2.21.1: -What's New in 2.22 ------------------- +What's New in 2.21.1 +-------------------- -The {+driver-short+} 2.22 release includes the following new features: +The {+driver-short+} 2.21.1 release includes the following new features, +changes, and improvements: - Adds the ``type`` parameter to the ``Mongo::SearchIndex::View#create_one`` and @@ -40,13 +41,14 @@ The {+driver-short+} 2.22 release includes the following new features: indexes programmatically. To learn more and view examples, see the :ref:`ruby-atlas-search-index` guide. -- Adds compatibility with {+language+} 3.3. +- Adds compatibility with {+language+} 3.3. To learn more, see + :ref:`ruby-compatibility`. BSON v5.1 ~~~~~~~~~ The ``bson`` gem is the implementation of the BSON specification in -{+language+}. ``bson`` v5.1 accompanies the {+driver-short+} v2.22 +{+language+}. ``bson`` v5.1 accompanies the {+driver-short+} v2.21.1 release. The ``bson`` 5.1 release includes the following new features, changes, From b2cae47c53e22a5dabd27d5550edeeab4989639f Mon Sep 17 00:00:00 2001 From: rustagir Date: Tue, 1 Jul 2025 15:44:21 -0400 Subject: [PATCH 4/4] compat fix --- source/includes/language-compatibility-table-ruby.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/includes/language-compatibility-table-ruby.rst b/source/includes/language-compatibility-table-ruby.rst index c65d1f03..7cee63c7 100644 --- a/source/includes/language-compatibility-table-ruby.rst +++ b/source/includes/language-compatibility-table-ruby.rst @@ -15,7 +15,7 @@ - JRuby 9.2 - JRuby 9.1 - * - 2.22 + * - 2.21.1 - ✓ - ✓ - ✓ @@ -27,7 +27,7 @@ - D - - * - 2.20 to 2.21 + * - 2.20 to 2.21.0 - - ✓ - ✓