bson 4.2.2 → 4.12.1

data/spec/bson/integer_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.
@@ -62,10 +62,36 @@ describe Integer do
   describe "#to_bson_key" do
 
     let(:obj)  { Integer::MAX_32BIT - 1 }
-    let(:encoded) { obj.to_s }
+    let(:encoded) { obj }
 
-    it "returns the key as a string" do
+    it "returns the key as an integer" do
       expect(obj.to_bson_key).to eq(encoded)
     end
   end
+
+  describe '#to_json' do
+    it 'returns integer' do
+      42.to_json.should == '42'
+    end
+  end
+
+  describe '#as_extended_json' do
+    context 'canonical mode' do
+      it 'returns $numberInt' do
+        42.as_extended_json.should == {'$numberInt' => '42'}
+      end
+    end
+
+    context 'relaxed mode' do
+      it 'returns integer' do
+        42.as_extended_json(mode: :relaxed).should be 42
+      end
+    end
+
+    context 'legacy mode' do
+      it 'returns integer' do
+        42.as_extended_json(mode: :legacy).should be 42
+      end
+    end
+  end
 end

data/spec/bson/json_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/max_key_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/min_key_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/nil_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/object_id_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/object_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/open_struct_spec.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/bson/raw_spec.rb

@@ -12,13 +12,34 @@ describe Regexp::Raw do
       described_class.new(pattern, 'im')
     end
 
-    it "returns the regex pattern and options" do
+    it "returns the legacy serialization including regex pattern and options" do
       expect(object.as_json).to eq({ "$regex" => "\\W+", "$options" => "im" })
     end
 
     it_behaves_like "a JSON serializable object"
   end
 
+  describe '#as_extended_json' do
+
+    let(:object) do
+      described_class.new(pattern, 'im')
+    end
+
+    context 'legacy mode' do
+      it "returns the legacy serialization including regex pattern and options" do
+        expect(object.as_extended_json(mode: :legacy)).to eq({ "$regex" => "\\W+", "$options" => "im" })
+      end
+    end
+
+    context 'canonical/relaxed mode' do
+      it "returns the extended json 2.0 serialization" do
+        expect(object.as_extended_json).to eq(
+          "$regularExpression" => {'pattern' => "\\W+", "options" => "im"}
+        )
+      end
+    end
+  end
+
   describe "#to_bson/#from_bson" do
 
     let(:options) { 'ilmsux' }
@@ -559,4 +580,15 @@ describe Regexp::Raw do
       end
     end
   end
-end
+
+  describe 'yaml loading' do
+    let(:regexp) { described_class.new('hello.world', 's') }
+
+    it 'round-trips' do
+      actual = YAML.load(regexp.to_yaml)
+      actual.pattern.should == 'hello.world'
+      actual.options.should == 's'
+      actual.compile.should =~ "hello\nworld"
+    end
+  end
+end

data/spec/bson/regexp_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/registry_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/string_spec.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 
-# 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.
@@ -130,4 +130,22 @@ describe String do
       end
     end
   end
+
+  describe '#to_bson' do
+    context 'when string is not valid utf-8' do
+      let(:string) do
+        "\xfe\x00\xff".force_encoding('BINARY')
+      end
+
+      let(:expected_message) do
+        /from ASCII-8BIT to UTF-8/
+      end
+
+      it 'raises EncodingError' do
+        expect do
+          string.to_bson
+        end.to raise_error(EncodingError, expected_message)
+      end
+    end
+  end
 end

data/spec/bson/symbol_raw_spec.rb

@@ -0,0 +1,45 @@
+# Copyright (C) 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"
+
+describe BSON::Symbol::Raw do
+  describe '#==' do
+    let(:one) { described_class.new('foo') }
+    let(:two) { described_class.new('foo') }
+    let(:three) { described_class.new('bar') }
+
+    it 'compares equal' do
+      one.should == two
+    end
+
+    it 'compares not equal' do
+      one.should_not == three
+    end
+  end
+
+  describe '#eql?' do
+    let(:one) { described_class.new('foo') }
+    let(:two) { described_class.new('foo') }
+    let(:three) { described_class.new('bar') }
+
+    it 'compares equal' do
+      one.should be_eql(two)
+    end
+
+    it 'compares not equal' do
+      one.should_not be_eql(three)
+    end
+  end
+end

data/spec/bson/symbol_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.
@@ -32,12 +32,72 @@ describe Symbol do
     it_behaves_like "a bson element"
     it_behaves_like "a serializable bson element"
     it_behaves_like "a deserializable bson element"
+
+    context 'canonical deserialization' do
+      let(:bson) do
+        BSON::ByteBuffer.new(BSON::Symbol::Raw.new(obj).to_bson.to_s)
+      end
+
+      let(:deserialized) do
+        described_class.from_bson(bson, mode: :bson)
+      end
+
+      it 'deserializes to BSON::Symbol::Raw' do
+        deserialized.class.should be BSON::Symbol::Raw
+      end
+
+      it 'has the correct value' do
+        deserialized.to_sym.should be obj
+      end
+    end
+
+    context 'when changing bson_type' do
+      def perform_test(bson_type_to_use)
+        Symbol.class_eval do
+          alias_method :bson_type_orig, :bson_type
+          define_method(:bson_type) do
+            bson_type_to_use
+          end
+        end
+
+        begin
+          yield
+        ensure
+          Symbol.class_eval do
+            alias_method :bson_type, :bson_type_orig
+            remove_method :bson_type_orig
+          end
+        end
+      end
+
+      let(:value) { :foo }
+
+      let(:serialized) do
+        value.to_bson.to_s
+      end
+
+      context 'when bson_type is set to symbol' do
+        it 'serializes to BSON string' do
+          perform_test(BSON::Symbol::BSON_TYPE) do
+            serialized
+          end.should == "\x04\x00\x00\x00foo\x00".force_encoding('binary')
+        end
+      end
+
+      context 'when bson_type is set to string' do
+        it 'serializes to BSON string' do
+          perform_test(BSON::String::BSON_TYPE) do
+            serialized
+          end.should == "\x04\x00\x00\x00foo\x00".force_encoding('binary')
+        end
+      end
+    end
   end
 
   describe "#to_bson_key" do
 
     let(:symbol) { :test }
-    let(:encoded) { symbol.to_s }
+    let(:encoded) { symbol }
 
     it "returns the encoded string" do
       expect(symbol.to_bson_key).to eq(encoded)
@@ -66,7 +126,7 @@ describe Symbol do
       end
 
       it "allows invalid keys" do
-        expect(symbol.to_bson_key).to eq(symbol.to_s)
+        expect(symbol.to_bson_key).to eq(symbol)
       end
     end
   end

data/spec/bson/time_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.
@@ -43,7 +43,7 @@ describe Time do
       end
     end
 
-    context "when the time is pre epoch" do
+    context "when the time precedes epoch" do
 
       let(:obj)  { Time.utc(1969, 1, 1, 0, 0, 0) }
       let(:bson) { [ (obj.to_f * 1000).to_i ].pack(BSON::Int64::PACK) }
@@ -51,5 +51,208 @@ describe Time do
       it_behaves_like "a serializable bson element"
       it_behaves_like "a deserializable bson element"
     end
+
+    context 'when value has sub-millisecond precision' do
+      let(:obj)  { Time.utc(2012, 1, 1, 0, 0, 0, 999_999) }
+
+      let(:expected_round_tripped_obj) do
+        Time.utc(2012, 1, 1, 0, 0, 0, 999_000)
+      end
+
+      let(:round_tripped_obj) do
+        Time.from_bson(obj.to_bson)
+      end
+
+      it 'truncates to milliseconds when round-tripping' do
+        round_tripped_obj.should == expected_round_tripped_obj
+      end
+    end
+  end
+
+  describe '#as_extended_json' do
+
+    context 'canonical mode' do
+      context 'when value has sub-millisecond precision' do
+        let(:obj)  { Time.utc(2012, 1, 1, 0, 0, 0, 999_999) }
+
+        let(:expected_serialization) do
+          {'$date' => {'$numberLong' => '1325376000999'}}
+        end
+
+        let(:serialization) do
+          obj.as_extended_json
+        end
+
+        shared_examples_for 'truncates to milliseconds when serializing' do
+          it 'truncates to milliseconds when serializing' do
+            serialization.should == expected_serialization
+          end
+        end
+
+        it_behaves_like 'truncates to milliseconds when serializing'
+
+        context 'when value has sub-microsecond precision' do
+          let(:obj)  { Time.utc(2012, 1, 1, 0, 0, 0, 999_999_999/1000r) }
+
+          it_behaves_like 'truncates to milliseconds when serializing'
+        end
+
+        context "when the time precedes epoch" do
+          let(:obj)  { Time.utc(1960, 1, 1, 0, 0, 0, 999_999) }
+
+          let(:expected_serialization) do
+            {'$date' => {'$numberLong' => '-315619199001'}}
+          end
+
+          it_behaves_like 'truncates to milliseconds when serializing'
+        end
+      end
+    end
+
+    context 'relaxed mode' do
+      context 'when value has sub-millisecond precision' do
+        let(:obj)  { Time.utc(2012, 1, 1, 0, 0, 0, 999_999) }
+
+        let(:expected_serialization) do
+          {'$date' => '2012-01-01T00:00:00.999Z'}
+        end
+
+        let(:serialization) do
+          obj.as_extended_json(mode: :relaxed)
+        end
+
+        shared_examples_for 'truncates to milliseconds when serializing' do
+          it 'truncates to milliseconds when serializing' do
+            serialization.should == expected_serialization
+          end
+        end
+
+        it_behaves_like 'truncates to milliseconds when serializing'
+
+        context 'when value has sub-microsecond precision' do
+          let(:obj)  { Time.utc(2012, 1, 1, 0, 0, 0, 999_999_999/1000r) }
+
+          it_behaves_like 'truncates to milliseconds when serializing'
+        end
+
+        context "when the time precedes epoch" do
+          let(:obj)  { Time.utc(1960, 1, 1, 0, 0, 0, 999_999) }
+
+          let(:expected_serialization) do
+            {'$date' => {'$numberLong' => '-315619199001'}}
+          end
+
+          it_behaves_like 'truncates to milliseconds when serializing'
+        end
+      end
+    end
+  end
+
+  describe '#to_extended_json' do
+
+    context 'canonical mode' do
+      context 'when value has sub-millisecond precision' do
+        let(:obj)  { Time.utc(2012, 1, 1, 0, 0, 0, 999_999) }
+
+        let(:expected_serialization) do
+          %q`{"$date":{"$numberLong":"1325376000999"}}`
+        end
+
+        let(:serialization) do
+          obj.to_extended_json
+        end
+
+        shared_examples_for 'truncates to milliseconds when serializing' do
+          it 'truncates to milliseconds when serializing' do
+            serialization.should == expected_serialization
+          end
+        end
+
+        it_behaves_like 'truncates to milliseconds when serializing'
+
+        context 'when value has sub-microsecond precision' do
+          let(:obj)  { Time.utc(2012, 1, 1, 0, 0, 0, 999_999_999/1000r) }
+
+          it_behaves_like 'truncates to milliseconds when serializing'
+        end
+
+        context "when the time precedes epoch" do
+          let(:obj)  { Time.utc(1960, 1, 1, 0, 0, 0, 999_999) }
+
+          let(:expected_serialization) do
+            %q`{"$date":{"$numberLong":"-315619199001"}}`
+          end
+
+          it_behaves_like 'truncates to milliseconds when serializing'
+        end
+      end
+    end
+
+    context 'relaxed mode' do
+      context 'when value has sub-millisecond precision' do
+        let(:obj)  { Time.utc(2012, 1, 1, 0, 0, 0, 999_999) }
+
+        let(:expected_serialization) do
+          %q`{"$date":"2012-01-01T00:00:00.999Z"}`
+        end
+
+        let(:serialization) do
+          obj.to_extended_json(mode: :relaxed)
+        end
+
+        shared_examples_for 'truncates to milliseconds when serializing' do
+          it 'truncates to milliseconds when serializing' do
+            serialization.should == expected_serialization
+          end
+        end
+
+        it_behaves_like 'truncates to milliseconds when serializing'
+
+        context 'when value has sub-microsecond precision' do
+          let(:obj)  { Time.utc(2012, 1, 1, 0, 0, 0, 999_999_999/1000r) }
+
+          it_behaves_like 'truncates to milliseconds when serializing'
+        end
+      end
+    end
+  end
+
+  describe '#to_json' do
+
+    context 'when value has sub-millisecond precision' do
+      let(:obj)  { Time.utc(2012, 1, 1, 0, 0, 0, 999_999) }
+
+      let(:expected_serialization) do
+        %q`"2012-01-01 00:00:00 UTC"`
+      end
+
+      let(:serialization) do
+        obj.to_json
+      end
+
+      shared_examples_for 'truncates to milliseconds when serializing' do
+        it 'truncates to milliseconds when serializing' do
+          serialization.should == expected_serialization
+        end
+      end
+
+      it_behaves_like 'truncates to milliseconds when serializing'
+
+      context 'when value has sub-microsecond precision' do
+        let(:obj)  { Time.utc(2012, 1, 1, 0, 0, 0, 999_999_999/1000r) }
+
+        it_behaves_like 'truncates to milliseconds when serializing'
+      end
+
+      context "when the time precedes epoch" do
+        let(:obj)  { Time.utc(1960, 1, 1, 0, 0, 0, 999_999) }
+
+        let(:expected_serialization) do
+          %q`"1960-01-01 00:00:00 UTC"`
+        end
+
+        it_behaves_like 'truncates to milliseconds when serializing'
+      end
+    end
   end
 end