bson 4.2.2 → 4.12.1

data/spec/bson/time_with_zone_spec.rb

@@ -0,0 +1,68 @@
+# Copyright (C) 2018-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 "spec_helper"
+
+context 'when ActiveSupport support is enabled' do
+  before do
+    unless SpecConfig.instance.active_support?
+      skip "ActiveSupport support is not enabled"
+    end
+  end
+
+  describe 'ActiveSupport::TimeWithZone' do
+    let(:cls) { ActiveSupport::TimeWithZone }
+
+    it "shares BSON type with Time" do
+      # ActiveSupport::TimeWithZone#new has no 0-argument version
+      obj = Time.now.in_time_zone("UTC")
+      expect(obj.bson_type).to eq(Time::BSON_TYPE)
+    end
+
+    shared_examples_for 'deserializes as expected' do
+      it 'deserializes to UTC' do
+        # Time zone information is lost during serialization - the time
+        # is always serialized in UTC.
+        rt_obj = Time.from_bson(obj.to_bson)
+        expect(rt_obj.zone).to eq('UTC')
+      end
+
+      it 'deserializes to an equal object' do
+        rt_obj = Time.from_bson(obj.to_bson)
+        expect(rt_obj).to eq(obj)
+      end
+    end
+
+    describe "#to_bson" do
+
+      context "when the TimeWithZone is not in UTC" do
+
+        let(:obj)  { Time.utc(2012, 12, 12, 0, 0, 0).in_time_zone("Pacific Time (US & Canada)") }
+        let(:bson) { [ (obj.utc.to_f * 1000).to_i ].pack(BSON::Int64::PACK) }
+
+        it_behaves_like "a serializable bson element"
+        it_behaves_like 'deserializes as expected'
+      end
+
+      context "when the TimeWithZone is in UTC" do
+
+        let(:obj)  { Time.utc(2012, 1, 1, 0, 0, 0).in_time_zone("UTC") }
+        let(:bson) { [ (obj.utc.to_f * 1000).to_i ].pack(BSON::Int64::PACK) }
+
+        it_behaves_like "a serializable bson element"
+        it_behaves_like 'deserializes as expected'
+      end
+    end
+  end
+end

data/spec/bson/timestamp_spec.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2009-2014 MongoDB Inc.
+# 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.
@@ -48,6 +48,61 @@ describe BSON::Timestamp do
     end
   end
 
+  describe "#<=>" do
+
+    let(:timestamp) do
+      described_class.new(1, 10)
+    end
+
+    context "when the objects are equal" do
+
+      let(:other) { described_class.new(1, 10) }
+
+      it "returns 0" do
+        expect(timestamp).to eq(other)
+        expect(timestamp < other).to be(false)
+        expect(timestamp > other).to be(false)
+        expect(timestamp >= other).to be(true)
+        expect(timestamp <= other).to be(true)
+      end
+    end
+
+    context "when the first object is less than the second" do
+
+      let(:other) { described_class.new(1, 15) }
+
+      it "returns -1" do
+        expect(timestamp <=> other).to be(-1)
+        expect(timestamp < other).to be(true)
+        expect(timestamp > other).to be(false)
+        expect(timestamp >= other).to be(false)
+        expect(timestamp <= other).to be(true)
+      end
+    end
+
+    context "when the first object is greater than the second" do
+
+      let(:other) { described_class.new(1, 5) }
+
+      it "returns 1" do
+        expect(timestamp <=> other).to be(1)
+        expect(timestamp < other).to be(false)
+        expect(timestamp > other).to be(true)
+        expect(timestamp >= other).to be(true)
+        expect(timestamp <= other).to be(false)
+      end
+    end
+
+    context "when the other object is not a timestamp" do
+
+      it "raises an ArgumentError" do
+        expect {
+          timestamp < 1
+        }.to raise_exception(ArgumentError)
+      end
+    end
+  end
+
   describe "#as_json" do
 
     let(:object) do

data/spec/bson/true_class_spec.rb

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

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

@@ -1,4 +1,4 @@
-# Copyright (C) 2009-2014 MongoDB Inc.
+# 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/{support → runners}/common_driver.rb

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

data/spec/runners/corpus.rb

@@ -0,0 +1,185 @@
+# 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 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 :description, :string
+    end
+  end
+end

data/spec/{support/corpus.rb → runners/corpus_legacy.rb}

@@ -1,4 +1,4 @@
-# Copyright (C) 2016 MongoDB, Inc.
+# 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.
@@ -15,25 +15,19 @@
 require 'json'
 
 module BSON
-  module Corpus
+  module CorpusLegacy
 
     # 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.
@@ -42,8 +36,6 @@ module BSON
       #   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))
         @valid = @spec['valid'] || []
@@ -57,13 +49,11 @@ module BSON
       # @example Get the list of valid tests.
       #   spec.valid_tests
       #
-      # @return [ Array<BSON::Corpus::Test> ] The list of valid Tests.
-      #
-      # @since 4.2.0
+      # @return [ Array<BSON::CorpusLegacy::Test> ] The list of valid Tests.
       def valid_tests
         @valid_tests ||=
           @valid.collect do |test|
-            BSON::Corpus::Test.new(self, test)
+            BSON::CorpusLegacy::Test.new(self, test)
           end
       end
 
@@ -72,13 +62,11 @@ module BSON
       # @example Get the list of invalid tests.
       #   spec.invalid_tests
       #
-      # @return [ Array<BSON::Corpus::Test> ] The list of invalid Tests.
-      #
-      # @since 4.2.0
+      # @return [ Array<BSON::CorpusLegacy::Test> ] The list of invalid Tests.
       def invalid_tests
         @invalid_tests ||=
           @invalid.collect do |test|
-            BSON::Corpus::Test.new(self, test)
+            BSON::CorpusLegacy::Test.new(self, test)
           end
       end
 
@@ -88,31 +76,23 @@ module BSON
       #   spec.klass
       #
       # @return [ Class ] The object class.
-      #
-      # @since 4.2.0
       def klass
         @klass ||= BSON.const_get(description)
       end
     end
 
     # Represents a single BSON Corpus test.
-    #
-    # @since 4.2.0
     class Test
 
       # The test description.
       #
       # @return [ String ] The test description.
-      #
-      # @since 4.2.0
       attr_reader :description
 
       # Name of a field in a valid test case extjson document that should be
       #   checked against the case's string field.
       #
       # @return [ String ] The json representation of the object.
-      #
-      # @since 4.2.0
       attr_reader :test_key
 
       # Instantiate the new Test.
@@ -122,8 +102,6 @@ module BSON
       #
       # @param [ Corpus::Spec ] spec The test specification.
       # @param [ Hash ] test The test specification.
-      #
-      # @since 4.2.0
       def initialize(spec, test)
         @spec = spec
         @description = test['description']
@@ -139,12 +117,29 @@ module BSON
       #   test.correct_bson
       #
       # @return [ String ] The correct bson bytes.
-      #
-      # @since 4.2.0
       def correct_bson
         @correct_bson ||= decode_hex(@canonical_bson || @bson)
       end
 
+      # Create a BSON::Document object from the test's bson representation
+      #
+      # @return [ BSON::Document ] The BSON::Document object
+      def document_from_bson
+        bson_bytes = decode_hex(@bson)
+        buffer = BSON::ByteBuffer.new(bson_bytes)
+        BSON::Document.from_bson(buffer)
+      end
+
+      # Create a BSON::Document object from the test's canonical bson
+      # representation
+      #
+      # @return [ BSON::Document ] The BSON::Document object
+      def document_from_canonical_bson
+        bson_bytes = decode_hex(@canonical_bson)
+        buffer = BSON::ByteBuffer.new(bson_bytes)
+        BSON::Document.from_bson(buffer)
+      end
+
       # Given the hex representation of bson, decode it into a Document,
       #   then reencoded it to bson.
       #
@@ -152,12 +147,8 @@ module BSON
       #   test.reencoded_bson
       #
       # @return [ String ] The reencoded bson bytes.
-      #
-      # @since 4.2.0
       def reencoded_bson
-        bson_bytes = decode_hex(@bson)
-        buffer = BSON::ByteBuffer.new(bson_bytes)
-        BSON::Document.from_bson(buffer).to_bson.to_s
+        document_from_bson.to_bson.to_s
       end
 
       # Given the hex representation of the canonical bson, decode it into a Document,
@@ -167,12 +158,8 @@ module BSON
       #   test.reencoded_canonical_bson
       #
       # @return [ String ] The reencoded canonical bson bytes.
-      #
-      # @since 4.2.0
       def reencoded_canonical_bson
-        bson_bytes = decode_hex(@canonical_bson)
-        buffer = BSON::ByteBuffer.new(bson_bytes)
-        BSON::Document.from_bson(buffer).to_bson.to_s
+        document_from_canonical_bson.to_bson.to_s
       end
 
       # Whether the canonical bson should be tested.
@@ -181,8 +168,6 @@ module BSON
       #   test.test_canonical_bson?
       #
       # @return [ true, false ] Whether the canonical bson should be tested.
-      #
-      # @since 4.2.0
       def test_canonical_bson?
         @canonical_bson && (@bson != @canonical_bson)
       end
@@ -193,8 +178,6 @@ module BSON
       #   test.correct_extjson
       #
       # @return [ String ] The correct extended json representation.
-      #
-      # @since 4.2.0
       def correct_extjson
         @canonical_extjson || @extjson
       end
@@ -205,8 +188,6 @@ module BSON
       #   test.test_extjson?
       #
       # @return [ true, false ] Whether the extended json should be tested.
-      #
-      # @since 4.2.0
       def test_extjson?
         !!@extjson
       end
@@ -218,12 +199,8 @@ module BSON
       #   test.extjson_from_encoded_bson
       #
       # @return [ Hash ] The extended json representation.
-      #
-      # @since 4.2.0
       def extjson_from_bson
-        subject = decode_hex(@bson)
-        buffer = BSON::ByteBuffer.new(subject)
-        ::JSON.parse(BSON::Document.from_bson(buffer).to_json)
+        as_legacy_extended_json(document_from_bson)
       end
 
       # Get the extended json representation of the decoded doc from the provided
@@ -233,12 +210,8 @@ module BSON
       #   test.extjson_from_canonical_bson
       #
       # @return [ Hash ] The extended json representation.
-      #
-      # @since 4.2.0
       def extjson_from_canonical_bson
-        subject = decode_hex(@canonical_bson)
-        buffer = BSON::ByteBuffer.new(subject)
-        ::JSON.parse(BSON::Document.from_bson(buffer).to_json)
+        as_legacy_extended_json(document_from_canonical_bson)
       end
 
       # Get the extended json representation of the decoded doc from the provided
@@ -248,15 +221,24 @@ module BSON
       #   test.extjson_from_encoded_extjson
       #
       # @return [ Hash ] The extended json representation.
-      #
-      # @since 4.2.0
       def extjson_from_encoded_extjson
         doc = BSON::Document.new(@extjson)
-        ::JSON.parse(doc.to_json)
+        as_legacy_extended_json(doc)
       end
 
       private
 
+      def as_legacy_extended_json(object)
+        result = object.as_extended_json(mode: :legacy)
+        if object.respond_to?(:as_json)
+          old_result = object.as_json
+          unless result == old_result
+            raise "Serializing #{object} to legacy extended json did not match between new and old APIs"
+          end
+        end
+        result
+      end
+
       def decode_hex(obj)
         [ obj ].pack('H*')
       end