bson 5.0.1-java → 5.1.1-java

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8abd0210ffaac5ff6d506ec5a872ad8230f9a4253be7bb26d7b5726ff5f4f0e1
-  data.tar.gz: 2abc7512e12d5ebd109038a22e1a71d1174df6e86d82a43bd52dc5f2ae368c4b
+  metadata.gz: 8a03675c43010414728b7b3f7467cd61e62d005698eefd9ef7006ac3a537cb7f
+  data.tar.gz: 95c1ff2578dd11e54aeae596ad7c96610fa91580608ff27d6d1c83c6777e7fed
 SHA512:
-  metadata.gz: bb55a15f35cb6700df2a3f45f13dae8525714adb796037db59cab549d21ae299c1999321e33c1e74b4f6eb1731e84972fd77e1814392f38e62ab7398ea35b7af
-  data.tar.gz: 52af2ff9e32b7f935b3abbfc482044eb5f62b2b4b1e70a85154ea32b7f36913dabbc183831864589d56b4293458d7b9290eeed15b2e535ac5f1301b8ecd2104c
+  metadata.gz: a29fa72227a6ea6da104d6153d9a1e77cce2844399e22a96233562b25b722c673a8517ca2ff31ef4a237415687f808768b9870612dc7f225274c9b7f3a83070e
+  data.tar.gz: 6b343f9a87f89165e1acefac5f698dbe748c8d3dc853553606ccf1f116af8fb4a7ff2ab03f52df1dab351649cfee98bbf5ce8387257f4df050e091ec7b9c2adb

data/Rakefile

@@ -25,6 +25,8 @@ require "rake/extensiontask"
 require "rspec/core/rake_task"
 require 'fileutils'
 
+load 'spec/shared/lib/tasks/candidate.rake'
+
 def jruby?
   defined?(JRUBY_VERSION)
 end
@@ -51,8 +53,10 @@ RSpec::Core::RakeTask.new(:rspec)
 
 desc 'Build the bson gem'
 task :build => [ :clean_all, *(jruby? ? :compile : nil) ] do
-  output = "--output=#{ENV['GEM_FILE_NAME']}" if ENV['GEM_FILE_NAME']
-  system "gem build #{output} bson.gemspec"
+  command = [ 'gem', 'build' ]
+  command << "--output=#{ENV['GEM_FILE_NAME']}" if ENV['GEM_FILE_NAME']
+  command << ENV['GEMSPEC'] || 'bson.gemspec'
+  system(*command)
 end
 
 # `rake version` is used by the deployment system so get the release version
@@ -64,22 +68,10 @@ task :version do
   puts BSON::VERSION
 end
 
-# `rake gem_file_name` is used by the deployment system so get the name of
-# the gem file to be generated. It must do nothing more than just print the
-# name of the gem file to generate.
-desc 'Print the name of the gem file to generate.'
-task :gem_file_name do
-  require 'bson/version'
-  base = "bson-#{BSON::VERSION}"
-  base << '-java' if jruby?
-  puts "#{base}.gem"
-end
-
 task :clean_all => :clean do
-  FileUtils.rm_f(File.join(File.dirname(__FILE__), 'lib', "bson_native.bundle"))
-  FileUtils.rm_f(File.join(File.dirname(__FILE__), 'lib', "bson_native.so"))
-  FileUtils.rm_f(File.join(File.dirname(__FILE__), 'lib', "bson_native.o"))
-  FileUtils.rm_f(File.join(File.dirname(__FILE__), 'lib', "bson-ruby.jar"))
+  %w[ bson-ruby.jar bson_native.bundle bson_native.so bson_native.o ].each do |file|
+    FileUtils.rm_f(File.join(File.dirname(__FILE__), 'lib', file))
+  end
 end
 
 task :spec => :compile do
@@ -91,15 +83,6 @@ end
 # been built (and signed via GPG), so we just need `rake release` to
 # push the gem to rubygems.
 task :release do
-  require 'bson/version'
-
-  # confirm: there ought to be two gems, one for MRI, and one for Java. These
-  # will have been previously generated by the 'BSON Release' GitHub action.
-  gems = Dir['*.gem']
-  if gems.length != 2
-    abort "Expected two gem files to be ready to release; got #{gems.length}"
-  end
-
   if ENV['GITHUB_ACTION'].nil?
     abort <<~WARNING
       `rake release` must be invoked from the `BSON Release` GitHub action,
@@ -114,6 +97,13 @@ task :release do
     WARNING
   end
 
+  # confirm: there ought to be two gems, one for MRI, and one for Java. These
+  # will have been previously generated by the 'build' job.
+  gems = Dir['*.gem']
+  if gems.length != 2
+    abort "Expected two gem files to be ready to release; got #{gems.inspect}"
+  end
+
   gems.each do |gem|
     system 'gem', 'push', gem
   end

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

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-
+# rubocop:todo all
 # Copyright (C) 2009-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -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.
     #
@@ -49,6 +50,7 @@ module BSON
       ciphertext: 6.chr,
       column: 7.chr,
       sensitive: 8.chr,
+      vector: 9.chr,
       user: 128.chr,
     }.freeze
 
@@ -60,6 +62,16 @@ module BSON
     # @since 2.0.0
     TYPES = SUBTYPES.invert.freeze
 
+    # Types of vector data.
+    VECTOR_DATA_TYPES = {
+      int8: '0x03'.hex,
+      float32: '0x27'.hex,
+      packed_bit: '0x10'.hex
+    }.freeze
+
+    # @api private
+    VECTOR_DATA_TYPES_INVERSE = VECTOR_DATA_TYPES.invert.freeze
+
     # @return [ String ] The raw binary data.
     #
     # The string is always stored in BINARY encoding.
@@ -88,8 +100,23 @@ module BSON
 
       type == other.type && data == other.data
     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.
@@ -98,7 +125,7 @@ module BSON
     #
     # @since 2.3.1
     def hash
-      [ data, type ].hash
+      [data, type].hash
     end
 
     # Return a representation of the object for use in
@@ -112,7 +139,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)
@@ -131,6 +158,26 @@ module BSON
       end
     end
 
+    # Decode the binary data as a vector data type.
+    #
+    # @return [ BSON::Vector ] The decoded vector data.
+    def as_vector
+      raise BSON::Error, "Cannot decode subtype #{type} as vector" unless type == :vector
+
+      dtype_value, padding, = data[0..1].unpack('CC')
+      dtype = VECTOR_DATA_TYPES_INVERSE[dtype_value]
+      raise ArgumentError, "Unsupported vector type: #{dtype_value}" unless dtype
+
+      format = case dtype
+               when :int8 then 'c*'
+               when :float32 then 'f*'
+               when :packed_bit then 'C*'
+               else
+                 raise ArgumentError, "Unsupported type: #{dtype}"
+               end
+      BSON::Vector.new(data[2..-1].unpack(format), dtype, padding)
+    end
+
     # Instantiate the new binary object.
     #
     # This method accepts a string in any encoding; however, if a string is
@@ -353,8 +400,97 @@ module BSON
       new(uuid_binary, :uuid_old)
     end
 
+    # Constructs a new binary object from a binary vector.
+
+    # @param [ BSON::Vector | Array ] vector The vector data.
+    # @param [ Symbol | nil ] dtype The vector data type, must be nil if vector is a BSON::Vector.
+    # @param [ Integer ] padding The number of bits in the final byte that are to
+    # be ignored when a vector element's size is less than a byte. Must be 0 if vector is a BSON::Vector.
+    # @param [ Boolean ] validate_vector_data Whether to validate the vector data.
+    #
+    # @return [ BSON::Binary ] The binary object.
+    def self.from_vector(vector, dtype = nil, padding = 0, validate_vector_data: false)
+      data, dtype, padding = extract_args_for_vector(vector, dtype, padding)
+      validate_args_for_vector!(data, dtype, padding)
+
+      format = case dtype
+               when :int8 then 'c*'
+               when :float32 then 'f*'
+               when :packed_bit then 'C*'
+               else raise ArgumentError, "Unsupported type: #{dtype}"
+               end
+      if validate_vector_data
+        validate_vector_data!(data, dtype)
+      end
+      metadata = [ VECTOR_DATA_TYPES[dtype], padding ].pack('CC')
+      data = data.pack(format)
+      new(metadata.concat(data), :vector)
+    end
+
     private
 
+    # Extracts the arguments for a binary vector.
+    #
+    # @param [ BSON::Vector | Array ] vector The vector data.
+    # @param [ ::Symbol | nil ] dtype The vector data type, must be nil if vector is a BSON::Vector.
+    # @param [ Integer ] padding The padding. Must be 0 if vector is a BSON::Vector.
+    #
+    # @return [ Array ] The extracted data, dtype, and padding.
+    def self.extract_args_for_vector(vector, dtype, padding)
+      if vector.is_a?(BSON::Vector)
+        if dtype || padding != 0
+          raise ArgumentError, 'Do not specify dtype and padding if the first argument is BSON::Vector'
+        end
+
+        data = vector.data
+        dtype = vector.dtype
+        padding = vector.padding
+      else
+        data = vector
+      end
+      [ data, dtype, padding ]
+    end
+    private_class_method :extract_args_for_vector
+
+    # Validate the arguments for a binary vector.
+    # @param [ Array ] data The vector data.
+    # @param [ ::Symbol ] dtype The vector data type.
+    # @param [ Integer ] padding The padding. Must be 0 if vector is a BSON::Vector.
+    # @raise [ ArgumentError ] If the arguments are invalid.
+    def self.validate_args_for_vector!(data, dtype, padding)
+      raise ArgumentError, "Unknown dtype #{dtype}" unless VECTOR_DATA_TYPES.key?(dtype)
+
+      if %i[int8 float32].include?(dtype)
+        raise ArgumentError, 'Padding applies only to packed_bit' if padding != 0
+      elsif padding.positive? && data.empty?
+        raise ArgumentError, 'Padding must be zero when the vector is empty for PACKED_BIT'
+      elsif padding.negative? || padding > 7
+        raise ArgumentError, "Padding must be between 0 and 7, got #{padding}"
+      end
+    end
+    private_class_method :validate_args_for_vector!
+
+    # Validate that all the values in the vector data are valid for the given dtype.
+    #
+    # @param [ Array ] data The vector data.
+    # @param [ ::Symbol ] dtype The vector data type.
+    def self.validate_vector_data!(data, dtype)
+      validator = case dtype
+                  when :int8
+                    ->(v) { v.is_a?(Integer) && v.between?(-128, 127) }
+                  when :float32
+                    ->(v) { v.is_a?(Float) }
+                  when :packed_bit
+                    ->(v) { v.is_a?(Integer) && v.between?(0, 255) }
+                  else
+                    raise ArgumentError, "Unsupported type: #{dtype}"
+                  end
+      data.each do |v|
+        raise ArgumentError, "Invalid value #{v} for type #{dtype}" unless validator.call(v)
+      end
+    end
+    private_class_method :validate_vector_data!
+
     # initializes an instance of BSON::Binary.
     #
     # @param [ String ] data the data to initialize the object with
@@ -383,7 +519,7 @@ module BSON
       if representation != :standard
         raise ArgumentError,
               'Binary of type :uuid can only be stringified to :standard representation, ' \
-              "requested: #{representation.inspect}"
+                "requested: #{representation.inspect}"
       end
 
       data
@@ -475,7 +611,8 @@ module BSON
           validate_integer_type!(type.bytes.first)
         end
       when Symbol then validate_symbol_type!(type)
-      else raise BSON::Error::InvalidBinaryType, type
+      else
+        raise BSON::Error::InvalidBinaryType, type
       end
     end
 

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/document.rb

@@ -321,6 +321,14 @@ module BSON
       raise ArgumentError, 'symbolize_keys! is not supported on BSON::Document instances. Please convert the document to hash first (using #to_h), then call #symbolize_keys! on the Hash instance'
     end
 
+    def deep_symbolize_keys!
+      warn <<~WARN
+        [DEPRECATION] `deep_symbolize_keys!` is not supported on BSON::Document instances.
+        Please convert the document to a Hash first (using `#to_h`), then call `#deep_symbolize_keys!` on the Hash.
+        This will raise an error starting with the v6.0.0 release.
+      WARN
+    end
+
     # Override the Hash implementation of to_bson_normalized_value.
     #
     # BSON::Document is already of the correct type and already provides

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(**_)
@@ -360,7 +360,7 @@ module BSON
       # NUM2UINT. Further, the spec dictates that the time component of an
       # ObjectID must be no more than 4 bytes long, so the spec itself is
       # constrained in this regard.
-      MAX_INTEGER = 2 ** 32
+      MAX_INTEGER = 2**32
 
       # Returns an integer timestamp (seconds since the Epoch). Primarily used
       # by the generator to produce object ids.

data/lib/bson/regexp.rb

@@ -99,16 +99,16 @@ module BSON
     end
 
     def bson_extended
-      (options & ::Regexp::EXTENDED).zero? ? NO_VALUE : EXTENDED_VALUE
+      options.nobits?(::Regexp::EXTENDED) ? NO_VALUE : EXTENDED_VALUE
     end
 
     def bson_ignorecase
-      (options & ::Regexp::IGNORECASE).zero? ? NO_VALUE : IGNORECASE_VALUE
+      options.nobits?(::Regexp::IGNORECASE) ? NO_VALUE : IGNORECASE_VALUE
     end
 
     def bson_dotall
       # Ruby Regexp's MULTILINE is equivalent to BSON's dotall value
-      (options & ::Regexp::MULTILINE).zero? ? NO_VALUE : NEWLINE_VALUE
+      options.nobits?(::Regexp::MULTILINE) ? NO_VALUE : NEWLINE_VALUE
     end
 
     # Represents the raw values for the regular expression.
@@ -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/vector.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+# Copyright (C) 2025-present MongoDB Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module BSON
+  # Vector of numbers along with metadata for binary interoperability.
+  class Vector < ::Array
+    # @return [ Integer ] The data type stored in the vector.
+    attr_reader :dtype
+
+    # @return [ Integer ]  The number of bits in the final byte that are to
+    # be ignored when a vector element's size is less than a byte
+    # and the length of the vector is not a multiple of 8.
+    attr_reader :padding
+
+    # @return [ BSON::ByteBuffer ] The data in the vector.
+    def data
+      self
+    end
+
+    # @param [ ::Array ] data The data to initialize the vector with.
+    # @param [ Integer ] dtype The data type of the vector.
+    # @param [ Integer ] padding The number of bits in the final byte that are to
+    # be ignored when a vector element's size is less than a byte
+    # and the length of the vector is not a multiple of 8.
+    def initialize(data, dtype, padding = 0)
+      @dtype = dtype
+      @padding = padding
+      super(data.dup)
+    end
+  end
+end

data/lib/bson/version.rb

@@ -1,20 +1,9 @@
 # frozen_string_literal: true
-# rubocop:todo all
-
-# Copyright (C) 2009-2020 MongoDB Inc.
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#   http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
 
 module BSON
-  VERSION = "5.0.1"
+  # The current version of the library.
+  #
+  # NOTE: this file is automatically updated via `rake candidate:create`.
+  # Manual changes to this file may be overwritten by that rake task.
+  VERSION = '5.1.1'
 end