bson 4.15.0-java → 5.0.0-java

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bc99b74544db3686a580a0f25c2ef2a36e5d4c95dc17924d36285cc1e23b4f70
-  data.tar.gz: 387a4a3a3af6a56e980e93648d44d2b8196e76cc7f65ba494b8d6613d5580660
+  metadata.gz: 4a402a1cf7ac93f6d12ed5acaad7ae5aa04fe0dacdfb7571392d09d35f6eaf9b
+  data.tar.gz: e3afd667f703c5cd401ef6231a4cf055fd835908546ba4b6503e7418beafc57c
 SHA512:
-  metadata.gz: e495d9ae63176d4d594d715f983cc1cf01d23761f383f079397ed2b24927c868c2c45a50d1943eb8bfccab4c8bfbd9a839830a8f6473b31a590a6408f531637c
-  data.tar.gz: f1750558d5e912736870d1d4e82c0ae5ca48eec13521efc8d504cb7483bdc2c2ec20912f47fc7ae30efd3d7e7111f9992e8b4c28e18280dc21b00848ac314979
+  metadata.gz: 78a555961d750296ea66c0808edef55c1e2a5dcd24ff8761e0497ab671c8fe9dbc2d44f4e8ada2b2b0ec642ae347d62abe3358dc0f55cc5c81563900cd5cfb6b
+  data.tar.gz: '049eed7dbb37c42142a468566d44ee531f0a4ac0ac585d4e3a67b9e0ddcd3ba26c90e4f50650ec3544b5a51cb73a55c9882409c58ea6cebfb937cebe2f3b10af'

data/README.md

@@ -10,19 +10,19 @@ An implementation of the BSON specification in Ruby.
 Compatibility
 -------------
 
-BSON is tested against MRI (2.5) and JRuby (9.2+).
+BSON is tested against MRI (2.6) and JRuby (9.2+).
 
 Documentation
 -------------
 
 Current documentation can be found
-[here](http://docs.mongodb.org/ecosystem/tutorial/ruby-bson-tutorial/#ruby-bson-tutorial).
+[here](https://www.mongodb.com/docs/ruby-driver/current/bson-tutorials/).
 
 API Documentation
 -----------------
 
-The [API Documentation](https://api.mongodb.com/bson-ruby/current/) is
-located at api.mongodb.com.
+The [API Documentation](https://www.mongodb.com/docs/ruby-driver/master/api/) is
+located at mongodb.com/docs.
 
 BSON Specification
 ------------------

data/Rakefile

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# rubocop:todo all
+
 # Copyright (C) 2009-2013 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -32,6 +35,8 @@ if jruby?
     ext.name = "bson-ruby"
     ext.ext_dir = "src"
     ext.lib_dir = "lib"
+    ext.target_version = ENV['TARGET_VERSION'] if ENV['TARGET_VERSION']
+    ext.source_version = ENV['SOURCE_VERSION'] if ENV['SOURCE_VERSION']
   end
 else
   require "rake/extensiontask"

data/lib/bson/active_support.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# rubocop:todo all
 # Copyright (C) 2018-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/bson/array.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # Copyright (C) 2009-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -13,8 +14,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+# The top-level BSON module.
 module BSON
-
   # Injects behaviour for encoding and decoding arrays to
   # and from raw bytes as specified by the BSON spec.
   #
@@ -22,7 +23,6 @@ module BSON
   #
   # @since 2.0.0
   module Array
-
     # An array is type 0x04 in the BSON spec.
     #
     # @since 2.0.0
@@ -41,19 +41,21 @@ module BSON
     # @see http://bsonspec.org/#/specification
     #
     # @since 2.0.0
-    def to_bson(buffer = ByteBuffer.new, validating_keys = Config.validating_keys?)
+    def to_bson(buffer = ByteBuffer.new)
       if buffer.respond_to?(:put_array)
-        buffer.put_array(self, validating_keys)
+        buffer.put_array(self)
       else
         position = buffer.length
         buffer.put_int32(0)
         each_with_index do |value, index|
           unless value.respond_to?(:bson_type)
-            raise Error::UnserializableClass, "Array element at position #{index} does not define its BSON serialized type: #{value}"
+            raise Error::UnserializableClass,
+                  "Array element at position #{index} does not define its BSON serialized type: #{value}"
           end
+
           buffer.put_byte(value.bson_type)
           buffer.put_cstring(index.to_s)
-          value.to_bson(buffer, validating_keys)
+          value.to_bson(buffer)
         end
         buffer.put_byte(NULL_BYTE)
         buffer.replace_int32(position, buffer.length - position)
@@ -68,13 +70,13 @@ module BSON
     #
     # @note This is used for repairing legacy bson data.
     #
-    # @raise [ BSON::ObjectId::Invalid ] If the array is not 12 elements.
+    # @raise [ BSON::Error::InvalidObjectId ] If the array is not 12 elements.
     #
     # @return [ String ] The raw object id bytes.
     #
     # @since 2.0.0
     def to_bson_object_id
-      ObjectId.repair(self) { pack("C*") }
+      ObjectId.repair(self) { pack('C*') }
     end
 
     # Converts the array to a normalized value in a BSON document.
@@ -86,7 +88,7 @@ module BSON
     #
     # @since 3.0.0
     def to_bson_normalized_value
-      map { |value| value.to_bson_normalized_value }
+      map(&:to_bson_normalized_value)
     end
 
     # Converts this object to a representation directly serializable to
@@ -105,10 +107,15 @@ module BSON
       end
     end
 
+    # Class-level methods to be added to the Array class.
     module ClassMethods
-
       # Deserialize the array from BSON.
       #
+      # @note If the argument cannot be parsed, an exception will be raised
+      #   and the argument will be left in an undefined state. The caller
+      #   must explicitly call `rewind` on the buffer before trying to parse
+      #   it again.
+      #
       # @param [ ByteBuffer ] buffer The byte buffer.
       #
       # @option options [ nil | :bson ] :mode Decoding mode to use.
@@ -116,43 +123,62 @@ module BSON
       # @return [ Array ] The decoded array.
       #
       # @see http://bsonspec.org/#/specification
-      #
-      # @since 2.0.0
       def from_bson(buffer, **options)
         if buffer.respond_to?(:get_array)
           buffer.get_array(**options)
         else
-          array = new
+          parse_array_from_buffer(buffer, **options)
+        end
+      end
+
+      private
+
+      # Parse an array from the buffer.
+      #
+      # @param [ ByteBuf ] buffer the buffer to read from
+      # @param [ Hash ] options the optional keyword arguments
+      #
+      # @return [ Array ] the array that was parsed
+      #
+      # @raise [ BSON::Error::BSONDecodeError ] if the expected number of
+      #   bytes were not read from the buffer
+      def parse_array_from_buffer(buffer, **options)
+        new.tap do |array|
           start_position = buffer.read_position
           expected_byte_size = buffer.get_int32
-          while (type = buffer.get_byte) != NULL_BYTE
-            buffer.get_cstring
-            cls = BSON::Registry.get(type)
-            value = if options.empty?
-              cls.from_bson(buffer)
-            else
-              cls.from_bson(buffer, **options)
-            end
-            array << value
-          end
+          parse_array_elements_from_buffer(array, buffer, **options)
           actual_byte_size = buffer.read_position - start_position
           if actual_byte_size != expected_byte_size
-            raise Error::BSONDecodeError, "Expected array to take #{expected_byte_size} bytes but it took #{actual_byte_size} bytes"
+            raise Error::BSONDecodeError,
+                  "Expected array to take #{expected_byte_size} bytes but it took #{actual_byte_size} bytes"
           end
-          array
+        end
+      end
+
+      # Parse a sequence of array elements from the buffer.
+      #
+      # @param [ Array ] array the array to populate
+      # @param [ ByteBuf ] buffer the buffer to read from
+      # @param [ Hash ] options the optional keyword arguments
+      def parse_array_elements_from_buffer(array, buffer, **options)
+        while (type = buffer.get_byte) != NULL_BYTE
+          buffer.get_cstring
+          cls = BSON::Registry.get(type)
+          value = if options.empty?
+                    cls.from_bson(buffer)
+                  else
+                    cls.from_bson(buffer, **options)
+                  end
+          array << value
         end
       end
     end
 
     # Register this type when the module is loaded.
-    #
-    # @since 2.0.0
     Registry.register(BSON_TYPE, ::Array)
   end
 
   # Enrich the core Array class with this module.
-  #
-  # @since 2.0.0
-  ::Array.send(:include, Array)
-  ::Array.send(:extend, Array::ClassMethods)
+  ::Array.include Array
+  ::Array.extend Array::ClassMethods
 end

data/lib/bson/big_decimal.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# rubocop:todo all
 # Copyright (C) 2009-2021 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -21,7 +22,7 @@ module BSON
   # @see http://bsonspec.org/#/specification
   module BigDecimal
 
-    # BigDecimals are serialized as Decimal128s under the hood. A Decimal128 
+    # BigDecimals are serialized as Decimal128s under the hood. A Decimal128
     # is type 0x13 in the BSON spec.
     BSON_TYPE = ::String.new(19.chr, encoding: BINARY).freeze
 
@@ -33,8 +34,8 @@ module BSON
     # @return [ BSON::ByteBuffer ] The buffer with the encoded object.
     #
     # @see http://bsonspec.org/#/specification
-    def to_bson(buffer = ByteBuffer.new, validating_keys = Config.validating_keys?)
-      BSON::Decimal128.new(to_s).to_bson(buffer, validating_keys)
+    def to_bson(buffer = ByteBuffer.new)
+      BSON::Decimal128.new(to_s).to_bson(buffer)
     end
 
     # Get the BSON type for BigDecimal. This is the same BSON type as
@@ -45,7 +46,8 @@ module BSON
 
     module ClassMethods
 
-      # Deserialize the BigDecimal from raw BSON bytes.
+      # Deserialize the BigDecimal from raw BSON bytes. If the :mode option
+      # is set to BSON, this will return a BSON::Decimal128
       #
       # @example Get the BigDecimal from BSON.
       #   BigDecimal.from_bson(bson)
@@ -54,11 +56,19 @@ module BSON
       #
       # @option options [ nil | :bson ] :mode Decoding mode to use.
       #
-      # @return [ BigDecimal ] The decimal object.
+      # @return [ BigDecimal | BSON::Decimal128 ] The decimal object.
       def from_bson(buffer, **options)
-        Decimal128.from_bson(buffer, **options).to_big_decimal
+        dec128 = Decimal128.from_bson(buffer, **options)
+        if options[:mode] == :bson
+          dec128
+        else
+          dec128.to_d
+        end
       end
     end
+
+    # Register this type when the module is loaded.
+    Registry.register(BSON_TYPE, ::BigDecimal)
   end
 
   # Enrich the core BigDecimal class with this module.