bson 5.0.1 → 5.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 044d0b78ceb338edd0398edc8954cb631353007ab4bf9d1fa6f94f6fd31aa24e
-  data.tar.gz: 1ee99d59e6a730188b3a73ca79a1bc8cfbe82a5e405c66e8dee8ffd890fd096c
+  metadata.gz: 41a002d14b035c9cf01534ee489ca61c012202aac1e2729fa850960c359ba5cd
+  data.tar.gz: f63478ad673c6dfbed91eaed8477b45287a264fa6c06e29d2273c41a0951e4e1
 SHA512:
-  metadata.gz: 326b80a11916faaadf8c576b4f79adc2708dc12ec8de4e0793da7d4f2cf998d207ce67c330bc4a2dedcd0d369601e5ed9de6234a81988b5787c41705084e36f3
-  data.tar.gz: 28083aa41b8f22f34e1220b3a90fb90b590c961eefc44b5db720961118fa473ccbe0e566c8a39f343199a1881ce57c4930b3806ef01fd25fa582c26501b254e5
+  metadata.gz: 67721ba06f0154a5dc37bc460602f878843243706e0194375c0350a095774beb06ba7a5b861b137d95bd0e753ed74b35d3b541283864aaec02b61dd94952d9ed
+  data.tar.gz: 525cc2a1da23ceaec40243cf7cc9ab504e81c11b56bf22e9f51f156c24294231fcd300874ae3b22c80fa473be568d84d43c627eabd4434c3895458c332364f6a

data/ext/bson/util.c

@@ -43,7 +43,7 @@ void rb_bson_generate_machine_id(VALUE rb_md5_class, char *rb_bson_machine_id)
  * Generate the next object id.
  *
  * Specification:
- * https://github.com/mongodb/specifications/blob/master/source/objectid.rst
+ * https://github.com/mongodb/specifications/blob/master/source/bson-objectid/objectid.md
  *
  * The ObjectID BSON type is a 12-byte value consisting of three different portions (fields):
  *   * a 4-byte value representing the seconds since the Unix epoch in the highest order bytes,
@@ -170,6 +170,9 @@ VALUE pvt_load_secure_random(VALUE _arg) {
   pvt_SecureRandom = rb_const_get(rb_cObject, rb_intern("SecureRandom"));
   pvt_has_random_number = rb_respond_to(pvt_SecureRandom, rb_intern("random_number"));
 
+  // mark SecureRandom so it does not get moved
+  rb_global_variable(&pvt_SecureRandom);
+
   return Qnil;
 }
 

data/lib/bson/array.rb

@@ -92,7 +92,7 @@ module BSON
     end
 
     # Converts this object to a representation directly serializable to
-    # Extended JSON (https://github.com/mongodb/specifications/blob/master/source/extended-json.rst).
+    # Extended JSON (https://github.com/mongodb/specifications/blob/master/source/extended-json/extended-json.md).
     #
     # This method recursively invokes +as_extended_json+ with the provided
     # options on each array element.

data/lib/bson/binary.rb

@@ -24,6 +24,7 @@ module BSON
   # @since 2.0.0
   class Binary
     include JSON
+    include Comparable
 
     # A binary is type 0x05 in the BSON spec.
     #
@@ -90,6 +91,20 @@ module BSON
     end
     alias eql? ==
 
+    # Compare this binary object to another object. The two objects must have
+    # the same type for any meaningful comparison.
+    #
+    # @param [ Object ] other The object to compare against.
+    # 
+    # @return [ Integer | nil ] If the objects have the same type, the result
+    #   is -1 if self < other, 0 if self == other, and 1 if self > other. If
+    #   other is not a Binary, or is a Binary of a different type, returns nil.
+    def <=>(other)
+      return nil unless other.is_a?(Binary) && type == other.type
+
+      data <=> other.data
+    end
+
     # Generates a Fixnum hash value for this object.
     #
     # Allows using Binary as hash keys.
@@ -112,7 +127,7 @@ module BSON
     end
 
     # Converts this object to a representation directly serializable to
-    # Extended JSON (https://github.com/mongodb/specifications/blob/master/source/extended-json.rst).
+    # Extended JSON (https://github.com/mongodb/specifications/blob/master/source/extended-json/extended-json.md).
     #
     # @option opts [ nil | :relaxed | :legacy ] :mode Serialization mode
     #   (default is canonical extended JSON)

data/lib/bson/code.rb

@@ -60,7 +60,7 @@ module BSON
     end
 
     # Converts this object to a representation directly serializable to
-    # Extended JSON (https://github.com/mongodb/specifications/blob/master/source/extended-json.rst).
+    # Extended JSON (https://github.com/mongodb/specifications/blob/master/source/extended-json/extended-json.md).
     #
     # @option opts [ nil | :relaxed | :legacy ] :mode Serialization mode
     #   (default is canonical extended JSON)

data/lib/bson/code_with_scope.rb

@@ -64,7 +64,7 @@ module BSON
     end
 
     # Converts this object to a representation directly serializable to
-    # Extended JSON (https://github.com/mongodb/specifications/blob/master/source/extended-json.rst).
+    # Extended JSON (https://github.com/mongodb/specifications/blob/master/source/extended-json/extended-json.md).
     #
     # @option opts [ nil | :relaxed | :legacy ] :mode Serialization mode
     #   (default is canonical extended JSON)

data/lib/bson/db_pointer.rb

@@ -66,7 +66,7 @@ module BSON
     end
 
     # Converts this object to a representation directly serializable to
-    # Extended JSON (https://github.com/mongodb/specifications/blob/master/source/extended-json.rst).
+    # Extended JSON (https://github.com/mongodb/specifications/blob/master/source/extended-json/extended-json.md).
     #
     # @return [ Hash ] The extended json representation.
     def as_extended_json(**_options)

data/lib/bson/decimal128.rb

@@ -73,7 +73,7 @@ module BSON
     end
 
     # Converts this object to a representation directly serializable to
-    # Extended JSON (https://github.com/mongodb/specifications/blob/master/source/extended-json.rst).
+    # Extended JSON (https://github.com/mongodb/specifications/blob/master/source/extended-json/extended-json.md).
     #
     # @option opts [ nil | :relaxed | :legacy ] :mode Serialization mode
     #   (default is canonical extended JSON)

data/lib/bson/ext_json.rb

@@ -19,7 +19,7 @@ require 'json'
 module BSON
 
   # This module contains methods for parsing Extended JSON 2.0.
-  # https://github.com/mongodb/specifications/blob/master/source/extended-json.rst
+  # https://github.com/mongodb/specifications/blob/master/source/extended-json/extended-json.md
   module ExtJSON
 
     # Parses JSON in a string into a Ruby object tree.

data/lib/bson/float.rb

@@ -49,7 +49,7 @@ module BSON
     end
 
     # Converts this object to a representation directly serializable to
-    # Extended JSON (https://github.com/mongodb/specifications/blob/master/source/extended-json.rst).
+    # Extended JSON (https://github.com/mongodb/specifications/blob/master/source/extended-json/extended-json.md).
     #
     # This method returns the float itself if relaxed representation is
     # requested and the value is finite, otherwise a $numberDouble hash.

data/lib/bson/hash.rb

@@ -53,7 +53,7 @@ module BSON
     end
 
     # Converts this object to a representation directly serializable to
-    # Extended JSON (https://github.com/mongodb/specifications/blob/master/source/extended-json.rst).
+    # Extended JSON (https://github.com/mongodb/specifications/blob/master/source/extended-json/extended-json.md).
     #
     # This method recursively invokes +as_extended_json+ with the provided
     # options on each hash value.

data/lib/bson/int32.rb

@@ -131,7 +131,7 @@ module BSON
     end
 
     # Converts this object to a representation directly serializable to
-    # Extended JSON (https://github.com/mongodb/specifications/blob/master/source/extended-json.rst).
+    # Extended JSON (https://github.com/mongodb/specifications/blob/master/source/extended-json/extended-json.md).
     #
     # This method returns the integer value if relaxed representation is
     # requested, otherwise a $numberInt hash.

data/lib/bson/int64.rb

@@ -131,7 +131,7 @@ module BSON
     end
 
     # Converts this object to a representation directly serializable to
-    # Extended JSON (https://github.com/mongodb/specifications/blob/master/source/extended-json.rst).
+    # Extended JSON (https://github.com/mongodb/specifications/blob/master/source/extended-json/extended-json.md).
     #
     # This method returns the integer value if relaxed representation is
     # requested, otherwise a $numberLong hash.

data/lib/bson/integer.rb

@@ -160,7 +160,7 @@ module BSON
     end
 
     # Converts this object to a representation directly serializable to
-    # Extended JSON (https://github.com/mongodb/specifications/blob/master/source/extended-json.rst).
+    # Extended JSON (https://github.com/mongodb/specifications/blob/master/source/extended-json/extended-json.md).
     #
     # This method returns the integer itself if relaxed representation is
     # requested, otherwise a $numberInt hash if the value fits in 32 bits

data/lib/bson/max_key.rb

@@ -63,7 +63,7 @@ module BSON
     end
 
     # Converts this object to a representation directly serializable to
-    # Extended JSON (https://github.com/mongodb/specifications/blob/master/source/extended-json.rst).
+    # Extended JSON (https://github.com/mongodb/specifications/blob/master/source/extended-json/extended-json.md).
     #
     # @option opts [ nil | :relaxed | :legacy ] :mode Serialization mode
     #   (default is canonical extended JSON)

data/lib/bson/min_key.rb

@@ -63,7 +63,7 @@ module BSON
     end
 
     # Converts this object to a representation directly serializable to
-    # Extended JSON (https://github.com/mongodb/specifications/blob/master/source/extended-json.rst).
+    # Extended JSON (https://github.com/mongodb/specifications/blob/master/source/extended-json/extended-json.md).
     #
     # @option opts [ nil | :relaxed | :legacy ] :mode Serialization mode
     #   (default is canonical extended JSON)

data/lib/bson/object.rb

@@ -62,7 +62,7 @@ module BSON
     end
 
     # Serializes this object to Extended JSON
-    # (https://github.com/mongodb/specifications/blob/master/source/extended-json.rst).
+    # (https://github.com/mongodb/specifications/blob/master/source/extended-json/extended-json.md).
     #
     # Subclasses should override +as_extended_json+ rather than this method.
     #
@@ -75,7 +75,7 @@ module BSON
     end
 
     # Converts this object to a representation directly serializable to
-    # Extended JSON (https://github.com/mongodb/specifications/blob/master/source/extended-json.rst).
+    # Extended JSON (https://github.com/mongodb/specifications/blob/master/source/extended-json/extended-json.md).
     #
     # Subclasses should override this method to provide custom serialization
     # to Extended JSON.

data/lib/bson/object_id.rb

@@ -75,7 +75,7 @@ module BSON
     end
 
     # Converts this object to a representation directly serializable to
-    # Extended JSON (https://github.com/mongodb/specifications/blob/master/source/extended-json.rst).
+    # Extended JSON (https://github.com/mongodb/specifications/blob/master/source/extended-json/extended-json.md).
     #
     # @return [ Hash ] The extended json representation.
     def as_extended_json(**_)

data/lib/bson/regexp.rb

@@ -200,7 +200,7 @@ module BSON
       end
 
       # Converts this object to a representation directly serializable to
-      # Extended JSON (https://github.com/mongodb/specifications/blob/master/source/extended-json.rst).
+      # Extended JSON (https://github.com/mongodb/specifications/blob/master/source/extended-json/extended-json.md).
       #
       # @option opts [ nil | :relaxed | :legacy ] :mode Serialization mode
       #   (default is canonical extended JSON)

data/lib/bson/symbol.rb

@@ -89,7 +89,7 @@ module BSON
     end
 
     # Converts this object to a representation directly serializable to
-    # Extended JSON (https://github.com/mongodb/specifications/blob/master/source/extended-json.rst).
+    # Extended JSON (https://github.com/mongodb/specifications/blob/master/source/extended-json/extended-json.md).
     #
     # @return [ Hash ] The extended json representation.
     def as_extended_json(**_options)
@@ -166,7 +166,7 @@ module BSON
       end
 
       # Converts this object to a representation directly serializable to
-      # Extended JSON (https://github.com/mongodb/specifications/blob/master/source/extended-json.rst).
+      # Extended JSON (https://github.com/mongodb/specifications/blob/master/source/extended-json/extended-json.md).
       #
       # @return [ Hash ] The extended json representation.
       def as_extended_json(**_options)

data/lib/bson/time.rb

@@ -61,7 +61,7 @@ module BSON
     end
 
     # Converts this object to a representation directly serializable to
-    # Extended JSON (https://github.com/mongodb/specifications/blob/master/source/extended-json.rst).
+    # Extended JSON (https://github.com/mongodb/specifications/blob/master/source/extended-json/extended-json.md).
     #
     # @note The time is floored to the nearest millisecond.
     #

data/lib/bson/timestamp.rb

@@ -92,7 +92,7 @@ module BSON
     end
 
     # Converts this object to a representation directly serializable to
-    # Extended JSON (https://github.com/mongodb/specifications/blob/master/source/extended-json.rst).
+    # Extended JSON (https://github.com/mongodb/specifications/blob/master/source/extended-json/extended-json.md).
     #
     # @option opts [ nil | :relaxed | :legacy ] :mode Serialization mode
     #   (default is canonical extended JSON)

data/lib/bson/undefined.rb

@@ -57,7 +57,7 @@ module BSON
     end
 
     # Converts this object to a representation directly serializable to
-    # Extended JSON (https://github.com/mongodb/specifications/blob/master/source/extended-json.rst).
+    # Extended JSON (https://github.com/mongodb/specifications/blob/master/source/extended-json/extended-json.md).
     #
     # @option opts [ nil | :relaxed | :legacy ] :mode Serialization mode
     #   (default is canonical extended JSON)

data/lib/bson/version.rb

@@ -16,5 +16,5 @@
 # limitations under the License.
 
 module BSON
-  VERSION = "5.0.1"
+  VERSION = "5.0.2"
 end

data/spec/bson/binary_spec.rb

@@ -20,17 +20,56 @@ describe BSON::Binary do
   let(:testing1)  { described_class.new("testing") }
   let(:testing2)  { described_class.new("testing") }
   let(:not_testing) { described_class.new("not testing") }
+  let(:testing3) { described_class.new("testing", :user) }
 
-  describe "#eql?" do
-    context "for two equal objects" do
-      it "returns true" do
-        expect(testing1).to eql(testing2)
+  describe "Comparable" do
+    describe "#eql?" do
+      context "for two equal objects" do
+        it "returns true" do
+          expect(testing1).to eql(testing2)
+        end
+      end
+
+      context "for two different objects" do
+        it "returns false" do
+          expect(testing1).not_to eql(not_testing)
+        end
+      end
+
+      context 'for objects with identical data but different types' do
+        it 'returns false' do
+          expect(testing1).not_to eql(testing3)
+        end
       end
     end
 
-    context "for two different objects" do
-      it "returns false" do
-        expect(testing1).not_to eql(not_testing)
+    describe '#<=>' do
+      context 'with a non-Binary object' do
+        it 'returns nil' do
+          expect(testing1 <=> 'bogus').to be_nil
+        end
+      end
+
+      context 'with identical type and data' do
+        it 'returns 0' do
+          expect(testing1 <=> testing2).to be == 0
+        end
+      end
+
+      context 'with mismatched type' do
+        it 'returns nil' do
+          expect(testing1 <=> testing3).to be_nil
+        end
+      end
+
+      context 'with identical type but mismatched data' do
+        it 'returns -1 when a < b' do
+          expect(not_testing <=> testing1).to be == -1
+        end
+
+        it 'returns 1 when a > b' do
+          expect(testing1 <=> not_testing).to be == 1
+        end
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bson
 version: !ruby/object:Gem::Version
-  version: 5.0.1
+  version: 5.0.2
 platform: ruby
 authors:
 - The MongoDB Ruby Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-07-23 00:00:00.000000000 Z
+date: 2024-11-19 00:00:00.000000000 Z
 dependencies: []
 description: A fully featured BSON specification implementation in Ruby
 email: dbx-ruby@mongodb.com