bson 4.1.1 → 5.2.0

data/spec/bson/undefined_spec.rb

@@ -1,4 +1,5 @@
-# Copyright (C) 2009-2014 MongoDB Inc.
+# 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.
@@ -26,4 +27,30 @@ describe BSON::Undefined do
     it_behaves_like "a serializable bson element"
     it_behaves_like "a deserializable bson element"
   end
+
+  describe "#as_json" do
+
+    let(:object) do
+      described_class.new
+    end
+
+    it "returns nil" do
+      expect(object.as_json).to eq(nil)
+    end
+
+    it_behaves_like 'a JSON serializable object'
+  end
+
+  describe "#as_extended_json" do
+
+    let(:object) do
+      described_class.new
+    end
+
+    it "returns the binary data plus type" do
+      expect(object.as_extended_json).to eq({ "$undefined" => true })
+    end
+
+    it_behaves_like 'an Extended JSON serializable object'
+  end
 end

data/spec/bson/vector_spec.rb

@@ -0,0 +1,33 @@
+# 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.
+
+require 'spec_helper'
+
+describe BSON::Vector do
+  it 'behaves like an Array' do
+    expect(described_class.new([ 1, 2, 3 ], :int8)).to be_a(Array)
+  end
+
+  describe '#initialize' do
+    context 'when padding is not provided' do
+      let(:vector) { described_class.new([ 1, 2, 3 ], :int8) }
+
+      it 'sets the padding to 0' do
+        expect(vector.padding).to eq(0)
+      end
+    end
+  end
+end

data/spec/bson_spec.rb

@@ -1,4 +1,5 @@
-# Copyright (C) 2009-2014 MongoDB Inc.
+# 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.

data/spec/runners/binary_vector.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+require 'runners/common_driver'
+
+module BSON
+  module BinaryVector
+    class Spec < CommonDriver::Spec
+      def initialize(file)
+        super
+        @valid = @invalid = nil
+      end
+
+      def tests
+        @spec['tests'].collect do |test|
+          BSON::BinaryVector::Test.new(self, test)
+        end
+      end
+
+      def valid_tests
+        tests.select(&:valid?)
+      end
+
+      def invalid_tests
+        tests.reject(&:valid?)
+      end
+    end
+
+    class Test
+      attr_reader :canonical_bson, :description, :dtype, :padding, :vector
+
+      def initialize(spec, test)
+        @spec = spec
+        @description = test['description']
+        @valid = test['valid']
+        @vector = ExtJSON.parse_obj(test['vector'])
+        @dtype_hex = test['dtype_hex']
+        @dtype_alias = test['dtype_alias']
+        @dtype = @dtype_alias.downcase.to_sym
+        @padding = test['padding']
+        @canonical_bson = test['canonical_bson']
+      end
+
+      def valid?
+        @valid
+      end
+
+      def document_from_canonical_bson
+        bson_bytes = decode_hex(@canonical_bson)
+        buffer = BSON::ByteBuffer.new(bson_bytes)
+        BSON::Document.from_bson(buffer)
+      end
+
+      def canonical_bson_from_document(use_vector_type: false, validate_vector_data: false)
+        args = if use_vector_type
+                 [ BSON::Vector.new(@vector, @dtype, @padding) ]
+               else
+                 [ @vector, @dtype, @padding ]
+               end
+        {
+          @spec.test_key => BSON::Binary.from_vector(
+            *args,
+            validate_vector_data: validate_vector_data
+          ),
+        }.to_bson.to_s
+      end
+
+      def bson
+        decode_hex(@canonical_bson)
+      end
+
+      private
+
+      def decode_hex(obj)
+        [ obj ].pack('H*')
+      end
+    end
+  end
+end

data/spec/runners/common_driver.rb

@@ -0,0 +1,348 @@
+# rubocop:todo all
+# Copyright (C) 2016-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.
+
+require 'json'
+require 'bigdecimal'
+
+module BSON
+  module CommonDriver
+
+    # Represents a Common Driver specification test.
+    #
+    # @since 4.2.0
+    class Spec
+
+      # The spec description.
+      #
+      # @return [ String ] The spec description.
+      #
+      # @since 4.2.0
+      attr_reader :description
+
+      # The document key of the object to test.
+      #
+      # @return [ String ] The document key.
+      #
+      # @since 4.2.0
+      attr_reader :test_key
+
+      # Instantiate the new spec.
+      #
+      # @example Create the spec.
+      #   Spec.new(file)
+      #
+      # @param [ String ] file The name of the yaml file.
+      #
+      # @since 4.2.0
+      def initialize(file)
+        @spec = ::JSON.parse(File.read(file))
+        @valid = @spec['valid'] || []
+        @invalid = @spec['parseErrors'] || []
+        @description = @spec['description']
+        @test_key = @spec['test_key']
+      end
+
+      # Get a list of tests that don't raise exceptions.
+      #
+      # @example Get the list of valid tests.
+      #   spec.valid_tests
+      #
+      # @return [ Array<BSON::CommonDriver::Test> ] The list of valid Tests.
+      #
+      # @since 4.2.0
+      def valid_tests
+        @valid_tests ||=
+          @valid.collect do |test|
+            BSON::CommonDriver::Test.new(self, test)
+          end
+      end
+
+      # Get a list of tests that raise exceptions.
+      #
+      # @example Get the list of invalid tests.
+      #   spec.invalid_tests
+      #
+      # @return [ Array<BSON::CommonDriver::Test> ] The list of invalid Tests.
+      #
+      # @since 4.2.0
+      def invalid_tests
+        @invalid_tests ||=
+          @invalid.collect do |test|
+            BSON::CommonDriver::Test.new(self, test)
+          end
+      end
+
+      # The class of the bson object to test.
+      #
+      # @example Get the class of the object to test.
+      #   spec.klass
+      #
+      # @return [ Class ] The object class.
+      #
+      # @since 4.2.0
+      def klass
+        @klass ||= BSON.const_get(description)
+      end
+    end
+
+    # Represents a single CommonDriver test.
+    #
+    # @since 4.2.0
+    class Test
+
+      # The test description.
+      #
+      # @return [ String ] The test description.
+      #
+      # @since 4.2.0
+      attr_reader :description
+
+      # The test subject.
+      #
+      # @return [ String ] The test subject.
+      #
+      # @since 4.2.0
+      attr_reader :subject
+
+      # The string to use to create a Decimal128.
+      #
+      # @return [ String ] The string to use in creating a Decimal128 object.
+      #
+      # @since 4.2.0
+      attr_reader :string
+
+      # The expected string representation of the Decimal128 object.
+      #
+      # @return [ String ] The object as a string.
+      #
+      # @since 4.2.0
+      attr_reader :match_string
+
+      # The json representation of the object.
+      #
+      # @return [ Hash ] The json representation of the object.
+      #
+      # @since 4.2.0
+      attr_reader :ext_json
+
+      # Instantiate the new Test.
+      #
+      # @example Create the test.
+      #   Test.new(test)
+      #
+      # @param [ CommonDriver::Spec ] spec The test specification.
+      # @param [ Hash ] test The test specification.
+      #
+      # @since 4.2.0
+      def initialize(spec, test)
+        @spec = spec
+        @description = test['description']
+        @string = test['string']
+        @match_string = test['match_string']
+        @ext_json = ::JSON.parse(test['extjson']) if test['extjson']
+        @from_ext_json = test['from_extjson'].nil? ? true : test['from_extjson']
+        @to_ext_json = test['to_extjson'].nil? ? true : test['to_extjson']
+        @subject = test['subject']
+        @test_key = spec.test_key
+      end
+
+      # Get the reencoded document in hex format.
+      #
+      # @example Get the reencoded document as hex.
+      #   test.reencoded_hex
+      #
+      # @return [ String ] The reencoded document in hex format.
+      #
+      # @since 4.2.0
+      def reencoded_hex
+        decoded_document.to_bson.to_s.unpack1("H*").upcase
+      end
+
+      # The object tested.
+      #
+      # @example Get the object for this test.
+      #   test.object
+      #
+      # @return [ BSON::Object ] The object.
+      #
+      # @since 4.2.0
+      def object
+        @object ||= decoded_document[@test_key]
+      end
+
+      # The object as json, in a document with the test key.
+      #
+      # @example Get a document with the object at the test key.
+      #   test.document_as_extended_json
+      #
+      # @return [ Hash ] The extended_json representation of document.
+      #
+      # @since 4.2.0
+      def document_as_extended_json
+        { @test_key => object.as_extended_json }
+      end
+
+      # Use the string in the extended json to instantiate the bson object.
+      #
+      # @example Get a bson object from the string in the extended json.
+      #   test.from_json
+      #
+      # @return [ BSON::Object ] The BSON object.
+      #
+      # @since 4.2.0
+      def from_json_string
+        klass.from_string(@ext_json[@test_key][klass::EXTENDED_JSON_KEY])
+      end
+
+      # Create an object from the given test string.
+      #
+      # @example
+      #   test.parse_string
+      #
+      # @return [ BSON::Object ] The object.
+      #
+      # @since 4.2.0
+      def parse_string
+        klass.from_string(string)
+      end
+
+      # Attempt to create an object from an invalid string.
+      #
+      # @example
+      #   test.parse_invalid_string
+      #
+      # @raise [ Error ] Parsing an invalid string will raise an error.
+      #
+      # @since 4.2.0
+      def parse_invalid_string
+        klass.from_string(subject)
+      end
+
+      # The class of the object being tested.
+      #
+      # @example
+      #   test.klass
+      #
+      # @return [ Class ] The object class.
+      #
+      # @since 4.2.0
+      def klass
+        @spec.klass
+      end
+
+      # The error class of a parse error.
+      #
+      # @example
+      #   test.parse_error
+      #
+      # @return [ Class ] The parse error class.
+      #
+      # @since 4.2.0
+      def parse_error
+        klass::InvalidRange
+      end
+
+      # Whether the object can be instantiated from extended json.
+      #
+      # @example Check if an object can be instantiated from the extended json.
+      #  test.from_ex_json?
+      #
+      # @return [ true, false ] If the object can be instantiated from
+      #   the provided extended json.
+      #
+      # @since 4.2.0
+      def from_ext_json?
+        @ext_json && @from_ext_json
+      end
+
+      # Whether the object can be represented as extended json.
+      #
+      # @example Check if an object can be represented as extended json.
+      #  test.to_ext_json?
+      #
+      # @return [ true, false ] If the object can be represented as
+      #   extended json.
+      #
+      # @since 4.2.0
+      def to_ext_json?
+        @ext_json && @to_ext_json
+      end
+
+      # Whether the object can be instantiated from a string.
+      #
+      # @example Check if an object can be instantiated from a string.
+      #  test.from_string?
+      #
+      # @return [ true, false ] If the object can be instantiated from a string.
+      #
+      # @since 4.2.0
+      def from_string?
+        @string && @from_ext_json
+      end
+
+      # The expected string representation of the test object.
+      #
+      # @example Get the expected String representation of the test object.
+      #  test.expected_to_string
+      #
+      # @return [ String ] The expected string representation.
+      #
+      # @since 4.2.0
+      def expected_to_string
+        match_string || string
+      end
+
+      # The Ruby class to which this bson object can be converted via a helper.
+      #
+      # @example Get the native type to which this object can be converted.
+      #  test.native_type
+      #
+      # @return [ Class ] The Ruby native type.
+      #
+      # @since 4.2.0
+      def native_type
+        klass::NATIVE_TYPE
+      end
+
+      # Get the object converted to an instance of the native Ruby type.
+      #
+      # @example Get a native Ruby instance.
+      #  test.native_type_conversion
+      #
+      # @return [ Object ] An instance of the Ruby native type.
+      #
+      # @since 4.2.0
+      def native_type_conversion
+        object.send("to_#{to_snake_case(native_type)}")
+      end
+
+      private
+
+      def to_snake_case(string)
+        string.to_s.gsub(/::/, '/').
+            gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+            gsub(/([a-z\d])([A-Z])/,'\1_\2').
+            tr("-", "_").
+            downcase
+      end
+
+      def decoded_document
+        @document ||= (data = [ @subject ].pack('H*')
+          buffer = BSON::ByteBuffer.new(data)
+          BSON::Document.from_bson(buffer, mode: :bson))
+      end
+    end
+  end
+end

data/spec/runners/corpus.rb

@@ -0,0 +1,191 @@
+# rubocop:todo all
+# Copyright (C) 2016-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.
+
+require 'json'
+require 'forwardable'
+
+module BSON
+  module Corpus
+
+    # Represents a test from the driver BSON Corpus.
+    #
+    # @since 4.2.0
+    class Spec
+
+      # The spec description.
+      #
+      # @return [ String ] The spec description.
+      #
+      # @since 4.2.0
+      attr_reader :description
+
+      # The document key of the object to test.
+      #
+      # @return [ String ] The document key.
+      #
+      # @since 4.2.0
+      attr_reader :test_key
+
+      # Instantiate the new spec.
+      #
+      # @example Create the spec.
+      #   Spec.new(file)
+      #
+      # @param [ String ] file The name of the json file.
+      #
+      # @since 4.2.0
+      def initialize(file)
+        @spec = ::JSON.parse(File.read(file).force_encoding('utf-8'))
+      end
+
+      def description
+        @spec['description']
+      end
+
+      def test_key
+        @spec['test_key']
+      end
+
+      def bson_type
+        @bson_type ||= @spec['bson_type'].to_i(16).chr
+      end
+
+      def valid_tests
+        @valid_tests ||=
+          @spec['valid']&.map do |test_spec|
+            ValidTest.new(self, test_spec)
+          end
+      end
+
+      def decode_error_tests
+        @decode_error_tests ||=
+          @spec['decodeErrors']&.map do |test_spec|
+            DecodeErrorTest.new(self, test_spec)
+          end
+      end
+
+      def parse_error_tests
+        @parse_error_tests ||=
+          @spec['parseErrors']&.map do |test_spec|
+            ParseErrorTest.new(self, test_spec)
+          end
+      end
+
+      # The class of the bson object to test.
+      #
+      # @example Get the class of the object to test.
+      #   spec.klass
+      #
+      # @return [ Class ] The object class.
+      #
+      # @since 4.2.0
+      def klass
+        @klass ||= BSON.const_get(description)
+      end
+    end
+
+    class TestBase
+
+      private
+
+      def decode_hex(obj)
+        [ obj ].pack('H*')
+      end
+    end
+
+    # Represents a single BSON Corpus test.
+    #
+    # @since 4.2.0
+    class ValidTest < TestBase
+      extend Forwardable
+
+      # Instantiate the new Test.
+      #
+      # @example Create the test.
+      #   Test.new(test)
+      #
+      # @param [ Corpus::Spec ] spec The test specification.
+      # @param [ Hash ] test The test specification.
+      #
+      # @since 4.2.0
+      def initialize(spec, test_params)
+        @spec = spec
+        test_params = test_params.dup
+        %w(
+          description canonical_extjson relaxed_extjson
+          degenerate_extjson converted_extjson
+          lossy
+        ).each do |key|
+          instance_variable_set("@#{key}", test_params.delete(key))
+        end
+        %w(
+          canonical_bson degenerate_bson converted_bson
+          lossy
+        ).each do |key|
+          if test_params.key?(key)
+            instance_variable_set("@#{key}", decode_hex(test_params.delete(key)))
+          end
+        end
+        unless test_params.empty?
+          raise "Test params has unprocessed keys: #{test_params}"
+        end
+      end
+
+      def_delegators :@spec, :test_key
+
+      attr_reader :description,
+        :canonical_bson,
+        :degenerate_bson,
+        :converted_bson,
+        :canonical_extjson,
+        :relaxed_extjson,
+        :degenerate_extjson,
+        :converted_extjson
+
+      def lossy?
+        !!@lossy
+      end
+
+      def canonical_extjson_doc
+        ::JSON.parse(canonical_extjson)
+      end
+
+      def relaxed_extjson_doc
+        relaxed_extjson && ::JSON.parse(relaxed_extjson)
+      end
+    end
+
+    class DecodeErrorTest < TestBase
+      def initialize(spec, test_params)
+        @spec = spec
+        @description = test_params['description']
+        @bson = decode_hex(test_params['bson'])
+      end
+
+      attr_reader :description, :bson
+    end
+
+    class ParseErrorTest
+      def initialize(spec, test_params)
+        @spec = spec
+        @description = test_params['description']
+        @string = test_params['string']
+      end
+
+      attr_reader :spec
+      attr_reader :description, :string
+    end
+  end
+end