bson 4.14.1 → 5.0.0

data/spec/bson/hash_spec.rb

@@ -1,3 +1,4 @@
+# rubocop:todo all
 # Copyright (C) 2009-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -52,93 +53,36 @@ describe Hash do
       end
     end
 
-    context "when the hash has invalid keys" do
+    context "when the hash has dollar keys" do
 
       let(:obj) do
         { "$testing" => "value" }
       end
 
-      context "when validating keys" do
 
-        context "when validating globally" do
-
-          before do
-            BSON::Config.validating_keys = true
-          end
-
-          after do
-            BSON::Config.validating_keys = false
-          end
-
-          it "raises an error" do
-            expect {
-              obj.to_bson
-            }.to raise_error(BSON::String::IllegalKey)
-          end
-
-          context "when the hash contains an array of documents containing invalid keys" do
-
-            let(:obj) do
-              { "array" =>  [{ "$testing" => "value" }] }
-            end
-
-            it "raises an error" do
-              expect {
-                obj.to_bson
-              }.to raise_error(BSON::String::IllegalKey)
-            end
-          end
-        end
-
-        context "when validating locally" do
-
-          it "raises an error" do
-            expect {
-              obj.to_bson(BSON::ByteBuffer.new, true)
-            }.to raise_error(BSON::String::IllegalKey)
-          end
+      let(:bson) do
+        "#{25.to_bson.to_s}#{String::BSON_TYPE}$testing#{BSON::NULL_BYTE}" +
+        "#{6.to_bson.to_s}value#{BSON::NULL_BYTE}#{BSON::NULL_BYTE}"
+      end
 
-          context "when the hash contains an array of documents containing invalid keys" do
+      it "serializes the hash" do
+        expect(obj.to_bson.to_s).to eq(bson)
+      end
 
-            let(:obj) do
-              { "array" =>  [{ "$testing" => "value" }] }
-            end
+      context "when the hash contains an array of documents containing invalid keys" do
 
-            it "raises an error" do
-              expect {
-                obj.to_bson(BSON::ByteBuffer.new, true)
-              }.to raise_error(BSON::String::IllegalKey)
-            end
-          end
+        let(:obj) do
+          { "array" =>  [{ "$testing" => "value" }] }
         end
-      end
-
-      context "when not validating keys" do
 
         let(:bson) do
-          "#{25.to_bson.to_s}#{String::BSON_TYPE}$testing#{BSON::NULL_BYTE}" +
-          "#{6.to_bson.to_s}value#{BSON::NULL_BYTE}#{BSON::NULL_BYTE}"
+          "#{45.to_bson.to_s}#{Array::BSON_TYPE}array#{BSON::NULL_BYTE}" +
+          "#{[{ "$testing" => "value" }].to_bson.to_s}#{BSON::NULL_BYTE}"
         end
 
         it "serializes the hash" do
           expect(obj.to_bson.to_s).to eq(bson)
         end
-
-        context "when the hash contains an array of documents containing invalid keys" do
-
-          let(:obj) do
-            { "array" =>  [{ "$testing" => "value" }] }
-          end
-
-          let(:bson) do
-            "#{45.to_bson.to_s}#{Array::BSON_TYPE}array#{BSON::NULL_BYTE}" +
-              "#{[{ "$testing" => "value" }].to_bson.to_s}#{BSON::NULL_BYTE}"
-          end
-
-          it "serializes the hash" do
-            expect(obj.to_bson.to_s).to eq(bson)
-          end
-        end
       end
     end
 
@@ -270,8 +214,28 @@ describe Hash do
         end.to_not raise_error
       end
 
-      it 'deserializes as a BSON::Decimal128' do
-        expect(from_bson).to eq({"x" => BSON::Decimal128.new('1')})
+      it 'deserializes as a BigDecimal' do
+        expect(from_bson).to eq({"x" => BigDecimal(1)})
+      end
+    end
+
+    context 'when deserializing round-tripping a Decimal128' do
+      let(:to_bson) do
+        {x:BSON::Decimal128.new('1')}.to_bson
+      end
+
+      let(:from_bson) do
+        Hash.from_bson(to_bson)
+      end
+
+      it 'doesn\'t raise on serialization' do
+        expect do
+          to_bson
+        end.to_not raise_error
+      end
+
+      it 'deserializes as a BigDecimal' do
+        expect(from_bson).to eq({"x" => BigDecimal(1)})
       end
     end
   end
@@ -348,7 +312,7 @@ describe Hash do
       it 'works' do
         expect do
           hash.to_bson
-        end.not_to raise_error
+        end.to_not raise_error
       end
     end
   end
@@ -372,7 +336,7 @@ describe Hash do
       let(:doc) { Hash.from_bson(buf) }
 
       it 'overwrites first value with second value' do
-        doc.should == {'foo' => 'overwrite'}
+        expect(doc).to eq({ 'foo' => 'overwrite' })
       end
     end
 
@@ -394,8 +358,56 @@ describe Hash do
       let(:doc) { Hash.from_bson(buf) }
 
       it 'overwrites first value with second value' do
-        doc.should == {'foo' => :bar}
+        expect(doc).to eq({ 'foo' => :bar })
       end
     end
+
+    context 'when deserializing a hash with a BigDecimal' do
+      let(:to_bson) do
+        {x: BigDecimal('1')}.to_bson
+      end
+
+      context 'when it has mode: :bson' do
+
+        let(:from_bson) do
+          Hash.from_bson(to_bson, mode: :bson)
+        end
+
+        it 'deserializes as a BigDecimal' do
+          expect(from_bson).to eq({"x" => BSON::Decimal128.new('1')})
+        end
+      end
+
+      context 'when it doesn\'t have mode: :bson' do
+
+        let(:from_bson) do
+          Hash.from_bson(to_bson)
+        end
+
+        it 'deserializes as a BigDecimal' do
+          expect(from_bson).to eq({"x" => BigDecimal(1)})
+        end
+      end
+    end
+  end
+
+  describe '#as_extended_json' do
+    let(:object) do
+      { 'foo' => :bar, 'baz' => ['qux', 1, 2.0, { 'lorem' => 1 }] }
+    end
+
+    let(:expected) do
+      { "foo" => { "$symbol" => "bar" },
+        "baz" => [ "qux",
+                   { "$numberInt" => "1" },
+                   { "$numberDouble" => "2.0" },
+                   { "lorem" => { "$numberInt" => "1" } } ] }
+    end
+
+    it "returns the binary data plus type" do
+      expect(object.as_extended_json).to eq(expected)
+    end
+
+    it_behaves_like 'an Extended JSON serializable object'
   end
 end

data/spec/bson/int32_spec.rb

@@ -1,3 +1,4 @@
+# rubocop:todo all
 # Copyright (C) 2009-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -254,23 +255,37 @@ describe BSON::Int32 do
     end
   end
 
+  describe '#as_json' do
+    let(:object) { described_class.new(42) }
+
+    it 'returns an Integer' do
+      expect(object.as_json).to eq 42
+    end
+
+    it_behaves_like "a JSON serializable object"
+  end
+
   describe '#as_extended_json' do
+    let(:object) { described_class.new(42) }
+
     context 'canonical mode' do
-      it 'returns $numberInt' do
-        described_class.new(42).as_extended_json.should == {'$numberInt' => '42'}
+      it 'returns a Hash with key $numberInt' do
+        expect(object.as_extended_json).to eq({ '$numberInt' => '42' })
       end
     end
 
     context 'relaxed mode' do
-      it 'returns integer' do
-        described_class.new(42).as_extended_json(mode: :relaxed).should == 42
+      it 'returns an Integer' do
+        expect(object.as_extended_json(mode: :relaxed)).to eq 42
       end
     end
 
     context 'legacy mode' do
-      it 'returns integer' do
-        described_class.new(42).as_extended_json(mode: :legacy).should be 42
+      it 'returns an Integer' do
+        expect(object.as_extended_json(mode: :legacy)).to eq 42
       end
     end
+
+    it_behaves_like "an Extended JSON serializable object"
   end
 end

data/spec/bson/int64_spec.rb

@@ -1,3 +1,4 @@
+# rubocop:todo all
 # Copyright (C) 2009-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -298,23 +299,37 @@ describe BSON::Int64 do
     end
   end
 
+  describe '#as_json' do
+    let(:object) { described_class.new(42) }
+
+    it 'returns an Integer' do
+      expect(object.as_json).to eq 42
+    end
+
+    it_behaves_like "a JSON serializable object"
+  end
+
   describe '#as_extended_json' do
+    let(:object) { described_class.new(42) }
+
     context 'canonical mode' do
-      it 'returns $numberLong' do
-        described_class.new(42).as_extended_json.should == {'$numberLong' => '42'}
+      it 'returns a Hash with key $numberLong' do
+        expect(object.as_extended_json).to eq({ '$numberLong' => '42' })
       end
     end
 
     context 'relaxed mode' do
-      it 'returns integer' do
-        described_class.new(42).as_extended_json(mode: :relaxed).should == 42
+      it 'returns an Integer' do
+        expect(object.as_extended_json(mode: :relaxed)).to eq 42
       end
     end
 
     context 'legacy mode' do
-      it 'returns integer' do
-        described_class.new(42).as_extended_json(mode: :legacy).should be 42
+      it 'returns an Integer' do
+        expect(object.as_extended_json(mode: :legacy)).to eq 42
       end
     end
+
+    it_behaves_like "an Extended JSON serializable object"
   end
 end

data/spec/bson/integer_spec.rb

@@ -1,3 +1,4 @@
+# rubocop:todo all
 # Copyright (C) 2009-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -69,29 +70,60 @@ describe Integer do
     end
   end
 
-  describe '#to_json' do
-    it 'returns integer' do
-      42.to_json.should == '42'
+  describe '#as_json' do
+    it 'returns an integer string' do
+      expect(42.to_json).to eq '42'
     end
   end
 
   describe '#as_extended_json' do
-    context 'canonical mode' do
-      it 'returns $numberInt' do
-        42.as_extended_json.should == {'$numberInt' => '42'}
+
+    context 'when 32-bit representable' do
+      let(:object) { 42 }
+
+      context 'canonical mode' do
+        it 'returns $numberInt when small' do
+          expect(object.as_extended_json).to eq({ '$numberInt' => '42' })
+        end
       end
-    end
 
-    context 'relaxed mode' do
-      it 'returns integer' do
-        42.as_extended_json(mode: :relaxed).should be 42
+      context 'relaxed mode' do
+        it 'returns integer' do
+          expect(object.as_extended_json(mode: :relaxed)).to eq 42
+        end
       end
+
+      context 'legacy mode' do
+        it 'returns integer' do
+          expect(object.as_extended_json(mode: :legacy)).to eq 42
+        end
+      end
+
+      it_behaves_like "an Extended JSON serializable object"
     end
 
-    context 'legacy mode' do
-      it 'returns integer' do
-        42.as_extended_json(mode: :legacy).should be 42
+    context 'when not 32-bit representable' do
+      let(:object) { 18014398241046527 }
+
+      context 'canonical mode' do
+        it 'returns $numberInt when small' do
+          expect(object.as_extended_json).to eq({ '$numberLong' => '18014398241046527' })
+        end
+      end
+
+      context 'relaxed mode' do
+        it 'returns integer' do
+          expect(object.as_extended_json(mode: :relaxed)).to eq 18014398241046527
+        end
       end
+
+      context 'legacy mode' do
+        it 'returns integer' do
+          expect(object.as_extended_json(mode: :legacy)).to eq 18014398241046527
+        end
+      end
+
+      it_behaves_like "an Extended JSON serializable object"
     end
   end
 end

data/spec/bson/json_spec.rb

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

data/spec/bson/max_key_spec.rb

@@ -1,3 +1,4 @@
+# rubocop:todo all
 # Copyright (C) 2009-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -49,17 +50,18 @@ describe BSON::MaxKey do
     end
   end
 
-  describe "#as_json" do
+  describe "#as_extended_json" do
 
     let(:object) do
       described_class.new
     end
 
     it "returns the binary data plus type" do
-      expect(object.as_json).to eq({ "$maxKey" => 1 })
+      expect(object.as_extended_json).to eq({ "$maxKey" => 1 })
     end
 
-    it_behaves_like "a JSON serializable object"
+    it_behaves_like 'an Extended JSON serializable object'
+    it_behaves_like '#as_json calls #as_extended_json'
   end
 
   describe "#to_bson/#from_bson" do

data/spec/bson/min_key_spec.rb

@@ -1,3 +1,4 @@
+# rubocop:todo all
 # Copyright (C) 2009-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -16,17 +17,18 @@ require "spec_helper"
 
 describe BSON::MinKey do
 
-  describe "#as_json" do
+  describe "#as_extended_json" do
 
     let(:object) do
       described_class.new
     end
 
     it "returns the binary data plus type" do
-      expect(object.as_json).to eq({ "$minKey" => 1 })
+      expect(object.as_extended_json).to eq({ "$minKey" => 1 })
     end
 
-    it_behaves_like "a JSON serializable object"
+    it_behaves_like 'an Extended JSON serializable object'
+    it_behaves_like '#as_json calls #as_extended_json'
   end
 
   describe "#==" do

data/spec/bson/nil_class_spec.rb

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

data/spec/bson/object_id_spec.rb

@@ -1,3 +1,4 @@
+# rubocop:todo all
 # Copyright (C) 2009-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -220,13 +221,24 @@ describe BSON::ObjectId do
       described_class.new
     end
 
-    it "returns the object id with $oid key" do
-      expect(object.as_json).to eq({ "$oid" => object.to_s })
+    it "returns the object id as a string" do
+      expect(object.as_json).to eq(object.to_s)
     end
 
     it_behaves_like "a JSON serializable object"
   end
 
+  describe "#as_extended_json" do
+
+    let(:object) do
+      described_class.new
+    end
+
+    it "returns the object id with $oid key" do
+      expect(object.as_extended_json).to eq({ "$oid" => object.to_s })
+    end
+  end
+
   describe "::BSON_TYPE" do
 
     it "returns 0x07" do
@@ -311,7 +323,7 @@ describe BSON::ObjectId do
       it "raises an error" do
         expect {
           described_class.from_string("asadsf")
-        }.to raise_error(BSON::ObjectId::Invalid)
+        }.to raise_error(BSON::Error::InvalidObjectId)
       end
     end
   end
@@ -592,7 +604,34 @@ describe BSON::ObjectId do
     it "raises an exception on serialization" do
       expect {
         hash.to_bson
-      }.to raise_error(BSON::InvalidKey)
+      }.to raise_error(BSON::Error::InvalidKey)
+    end
+  end
+
+  context 'when the counter wraps' do
+    before do
+      BSON::ObjectId._generator.reset_counter(0xFFFFFF)
+    end
+
+    let(:before) { BSON::ObjectId.new }
+    let(:after) { BSON::ObjectId.new }
+
+    it 'resets the counter portion to 0' do
+      expect(before._counter_part).to be == "ffffff"
+      expect(after._counter_part).to be == "000000"
+    end
+  end
+
+  context 'when fork changes the pid' do
+    before do
+      skip 'requires Process.fork' unless Process.respond_to?(:fork)
+    end
+
+    let(:parent_id) { BSON::ObjectId.new }
+    let(:child_id) { Utils.perform_in_child { BSON::ObjectId.new } }
+
+    it 'changes the process portion of the object-id' do
+      expect(child_id._process_part).not_to be == parent_id._process_part
     end
   end
 end

data/spec/bson/object_spec.rb

@@ -1,3 +1,4 @@
+# rubocop:todo all
 # Copyright (C) 2009-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -25,7 +26,7 @@ describe BSON::Object do
     it "raises an exception" do
       expect {
         object.to_bson_key
-      }.to raise_error(BSON::InvalidKey)
+      }.to raise_error(BSON::Error::InvalidKey)
     end
   end
 end

data/spec/bson/open_struct_spec.rb

@@ -1,3 +1,4 @@
+# rubocop:todo all
 # Copyright (C) 2016-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -36,93 +37,35 @@ describe OpenStruct do
       it_behaves_like "a serializable bson element"
     end
 
-    context "when the struct has invalid keys" do
+    context "when the struct has dollar keys" do
 
       let(:obj) do
         described_class.new({ "$testing" => "value" })
       end
 
-      context "when validating keys" do
-
-        context "when validating globally" do
-
-          before do
-            BSON::Config.validating_keys = true
-          end
-
-          after do
-            BSON::Config.validating_keys = false
-          end
-
-          it "raises an error" do
-            expect {
-              obj.to_bson
-            }.to raise_error(BSON::String::IllegalKey)
-          end
-
-          context "when the struct contains an array of documents containing invalid keys" do
-
-            let(:obj) do
-              described_class.new({ "array" =>  [{ "$testing" => "value" }] })
-            end
-
-            it "raises an error" do
-              expect {
-                obj.to_bson
-              }.to raise_error(BSON::String::IllegalKey)
-            end
-          end
-        end
-
-        context "when validating locally" do
-
-          it "raises an error" do
-            expect {
-              obj.to_bson(BSON::ByteBuffer.new, true)
-            }.to raise_error(BSON::String::IllegalKey)
-          end
+      let(:bson) do
+        "#{25.to_bson.to_s}#{String::BSON_TYPE}$testing#{BSON::NULL_BYTE}" +
+        "#{6.to_bson.to_s}value#{BSON::NULL_BYTE}#{BSON::NULL_BYTE}"
+      end
 
-          context "when the struct contains an array of documents containing invalid keys" do
+      it "serializes the struct" do
+        expect(obj.to_bson.to_s).to eq(bson)
+      end
 
-            let(:obj) do
-              described_class.new({ "array" =>  [{ "$testing" => "value" }] })
-            end
+      context "when the struct contains an array of documents containing invalid keys" do
 
-            it "raises an error" do
-              expect {
-                obj.to_bson(BSON::ByteBuffer.new, true)
-              }.to raise_error(BSON::String::IllegalKey)
-            end
-          end
+        let(:obj) do
+          described_class.new({ "array" =>  [{ "$testing" => "value" }] })
         end
-      end
-
-      context "when not validating keys" do
 
         let(:bson) do
-          "#{25.to_bson.to_s}#{String::BSON_TYPE}$testing#{BSON::NULL_BYTE}" +
-          "#{6.to_bson.to_s}value#{BSON::NULL_BYTE}#{BSON::NULL_BYTE}"
+          "#{45.to_bson.to_s}#{Array::BSON_TYPE}array#{BSON::NULL_BYTE}" +
+          "#{[{ "$testing" => "value" }].to_bson.to_s}#{BSON::NULL_BYTE}"
         end
 
         it "serializes the struct" do
           expect(obj.to_bson.to_s).to eq(bson)
         end
-
-        context "when the struct contains an array of documents containing invalid keys" do
-
-          let(:obj) do
-            described_class.new({ "array" =>  [{ "$testing" => "value" }] })
-          end
-
-          let(:bson) do
-            "#{45.to_bson.to_s}#{Array::BSON_TYPE}array#{BSON::NULL_BYTE}" +
-              "#{[{ "$testing" => "value" }].to_bson.to_s}#{BSON::NULL_BYTE}"
-          end
-
-          it "serializes the struct" do
-            expect(obj.to_bson.to_s).to eq(bson)
-          end
-        end
       end
     end